翻訳は機械翻訳により提供されています。提供された翻訳内容と英語版の間で齟齬、不一致または矛盾がある場合、英語版が優先します。
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 です。最大値は 10,000 です。
必須: いいえ
- NextToken
-
このパラメータを指定すると、
ListSignalingChannels操作の結果が切り捨てられ、呼び出しはレスポンスでNextTokenを返します。チャネルの別のバッチを取得するには、次のリクエストでこのトークンを指定します。タイプ: 文字列
長さの制約: 最小長は 0 です。最大長は 1,024 です。
パターン:
[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 です。最大長は 1,024 です。
パターン:
[a-zA-Z0-9+/=]*
エラー
すべてのアクションに共通のエラーについては、「共通エラー」を参照してください。
- AccessDeniedException
-
この操作を実行するために必要なアクセス許可がありません。
HTTP ステータスコード: 401
- ClientLimitExceededException
-
Kinesis Video Streams は、許可されたクライアントコールの制限を超えているため、リクエストをスロットリングしました。後で呼び出しを試みてください。
HTTP ステータスコード: 400
- InvalidArgumentException
-
この入力パラメータの値は無効です。
HTTP ステータスコード: 400
以下の資料も参照してください。
言語固有の AWS SDKs のいずれかでこの API を使用する方法の詳細については、以下を参照してください。
