ListStreams - Amazon Kinesis Video Streams

本文為英文版的機器翻譯版本,如內容有任何歧義或不一致之處,概以英文版為準。

ListStreams

返回對StreamInfo象的數組。每個對象描述了一個流。若只要擷取滿足特定條件的串流,您可以指定StreamNameCondition.

請求語法

POST /listStreams HTTP/1.1 Content-type: application/json { "MaxResults": number, "NextToken": "string", "StreamNameCondition": { "ComparisonOperator": "string", "ComparisonValue": "string" } }

URI 請求參數

請求不會使用任何 URI 參數。

請求主體

請求接受採用 JSON 格式的下列資料。

MaxResults

要在回應中傳回的串流數目上限。預設值為 10,000。

類型:整數

有效範圍:最小值為 1。最大值為 10000。

必要:否

NextToken

如果您指定此參數,當截斷ListStreams作業的結果時,呼叫會在回應NextToken中傳回。要獲取另一批流,請在下一個請求中提供此令牌。

類型:字串

長度限制:長度下限為 0。長度上限為 512。

模式:[a-zA-Z0-9+/=]*

必要:否

StreamNameCondition

選用性:僅傳回滿足特定條件的串流。目前,您只能指定串流名稱的前置詞做為條件。

類型:StreamNameCondition 物件

必要:否

回應語法

HTTP/1.1 200 Content-type: application/json { "NextToken": "string", "StreamInfoList": [ { "CreationTime": number, "DataRetentionInHours": number, "DeviceName": "string", "KmsKeyId": "string", "MediaType": "string", "Status": "string", "StreamARN": "string", "StreamName": "string", "Version": "string" } ] }

回應元素

如果動作成功,則服務傳回 HTTP 200 回應。

服務會傳回下列 JSON 格式的資料。

NextToken

如果響應被截斷,調用返回帶有令牌的元素。要獲取下一批流,請在下一個請求中使用此令牌。

類型:字串

長度限制:長度下限為 0。長度上限為 512。

模式:[a-zA-Z0-9+/=]*

StreamInfoList

StreamInfo 物件的陣列。

類型:StreamInfo 物件陣列

錯誤

如需所有動作常見錯誤的資訊,請參閱常見錯誤

ClientLimitExceededException

Kinesis Video Streams 已限制要求,因為您已經超過允許的用戶端呼叫限制。稍後再嘗試撥打電話。

HTTP 狀態碼:400

InvalidArgumentException

此輸入參數的值無效。

HTTP 狀態碼:400

另請參閱

如需在其中一個特定語言 AWS SDK 中使用此 API 的詳細資訊,請參閱下列內容: