本文為英文版的機器翻譯版本,如內容有任何歧義或不一致之處,概以英文版為準。
ListSignalingChannels
返回對ChannelInfo
象的數組。每個對象描述一個信令通道。若只要擷取滿足特定條件的通道,您可以指定ChannelNameCondition
.
請求語法
POST /listSignalingChannels HTTP/1.1
Content-type: application/json
{
"ChannelNameCondition": {
"ComparisonOperator": "string
",
"ComparisonValue": "string
"
},
"MaxResults": number
,
"NextToken": "string
"
}
URI 請求參數
請求不會使用任何 URI 參數。
請求主體
請求接受採用 JSON 格式的下列資料。
- ChannelNameCondition
-
選用性:僅傳回滿足特定條件的通道。
類型:ChannelNameCondition 物件
必要:否
- MaxResults
-
要在回應中傳回的通道數目上限。預設值為 500。
類型:整數
有效範圍:最小值為 1。最大值為 10000。
必要:否
- NextToken
-
如果您指定此參數,當截斷
ListSignalingChannels
作業的結果時,呼叫會在回應NextToken
中傳回。要獲取另一批渠道,請在下一個請求中提供此令牌。類型:字串
長度限制:長度下限為 0。長度上限為 512。
模式:
[a-zA-Z0-9+/=]*
必要:否
回應語法
HTTP/1.1 200
Content-type: application/json
{
"ChannelInfoList": [
{
"ChannelARN": "string",
"ChannelName": "string",
"ChannelStatus": "string",
"ChannelType": "string",
"CreationTime": number,
"SingleMasterConfiguration": {
"MessageTtlSeconds": number
},
"Version": "string"
}
],
"NextToken": "string"
}
回應元素
如果動作成功,則服務傳回 HTTP 200 回應。
服務會傳回下列 JSON 格式的資料。
- ChannelInfoList
-
ChannelInfo
物件的陣列。類型:ChannelInfo 物件陣列
- NextToken
-
如果響應被截斷,調用返回帶有令牌的元素。要獲取下一批流,請在下一個請求中使用此令牌。
類型:字串
長度限制:長度下限為 0。長度上限為 512。
模式:
[a-zA-Z0-9+/=]*
錯誤
如需所有動作常見錯誤的資訊,請參閱常見錯誤。
- AccessDeniedException
-
您沒有執行此作業所需的權限。
狀態碼:4
- ClientLimitExceededException
-
Kinesis Video Streams 已限制要求,因為您已經超過允許的用戶端呼叫限制。稍後再嘗試撥打電話。
HTTP 狀態碼:400
- InvalidArgumentException
-
此輸入參數的值無效。
HTTP 狀態碼:400
另請參閱
如需在其中一個特定語言 AWS SDK 中使用此 API 的詳細資訊,請參閱下列內容: