翻訳は機械翻訳により提供されています。提供された翻訳内容と英語版の間で齟齬、不一致または矛盾がある場合、英語版が優先します。
GetSignalingChannelEndpoint
指定されたシグナリングチャネルがメッセージを送受信するためのエンドポイントを提供します。このAPIは、Protocols と Role のプロパティで構成される SingleMasterChannelEndpointConfiguration 入力パラメーターを使用します。
Protocols は、通信メカニズムを決定するために使用されます。例えば、プロトコルとして WSS を指定すると、この API は安全な WebSocket エンドポイントを生成します。プロトコルとして HTTPS を指定すると、この API が HTTPS エンドポイントを生成します。プロトコルWEBRTCとして を指定しても、シグナリングチャネルが取り込み用に設定されていない場合は、エラー が表示されますInvalidArgumentException。
Role はメッセージングのアクセス許可を決定します。MASTER ロールにより、この API はエンドポイントを生成します。このエンドポイントは、クライアントがチャネル上の任意の閲覧者と通信するために使用できます。VIEWER ロールにより、このAPI はエンドポイントを生成します。このエンドポイントは、クライアントが MASTER とだけ通信するために使用できます。
リクエストの構文
POST /getSignalingChannelEndpoint HTTP/1.1
Content-type: application/json
{
"ChannelARN": "string",
"SingleMasterChannelEndpointConfiguration": {
"Protocols": [ "string" ],
"Role": "string"
}
}URI リクエストパラメータ
リクエストでは URI パラメータを使用しません。
リクエストボディ
リクエストは以下の JSON 形式のデータを受け入れます。
- ChannelARN
-
エンドポイントを取得するシグナリングチャネルの Amazon リソースネーム (ARN)。
タイプ: 文字列
長さの制限: 最小長は 1 です。最大長は 1,024 です。
Pattern:
arn:[a-z\d-]+:kinesisvideo:[a-z0-9-]+:[0-9]+:[a-z]+/[a-zA-Z0-9_.-]+/[0-9]+必須: はい
- SingleMasterChannelEndpointConfiguration
-
SINGLE_MASTERチャネルタイプのエンドポイント設定を含む構造。型: SingleMasterChannelEndpointConfiguration オブジェクト
必須: いいえ
レスポンスの構文
HTTP/1.1 200
Content-type: application/json
{
"ResourceEndpointList": [
{
"Protocol": "string",
"ResourceEndpoint": "string"
}
]
}レスポンス要素
アクションが成功すると、サービスは HTTP 200 レスポンスを返します。
サービスから以下のデータが JSON 形式で返されます。
- ResourceEndpointList
-
指定されたシグナリングチャネルのエンドポイントのリスト。
型: ResourceEndpointListItem オブジェクトの配列
エラー
すべてのアクションに共通のエラーについては、「共通エラー」を参照してください。
- AccessDeniedException
-
この操作を実行するために必要なアクセス許可がありません。
HTTP ステータスコード: 401
- ClientLimitExceededException
-
Kinesis Video Streams は、許可されたクライアントコールの制限を超えているため、リクエストをスロットリングしました。後で呼び出しを試みてください。
HTTP ステータスコード: 400
- InvalidArgumentException
-
この入力パラメータの値は無効です。
HTTP ステータスコード: 400
- ResourceInUseException
-
の入力
StreamARNまたはChannelARNCLOUD_STORAGE_MODEが別の Kinesis Video Streams リソースに既にマッピングされている場合、または提供された入力StreamARNまたはChannelARNがアクティブステータスでない場合は、次のいずれかの を試してください。-
指定されたチャネルがマッピングされるストリームを決定する
DescribeMediaStorageConfigurationAPI。 -
特定のストリームがマッピングされるチャネルを決定する
DescribeMappedResourceConfigurationAPI。 -
リソースのステータスを決定する
DescribeStreamまたはDescribeSignalingChannelAPI。
HTTP ステータスコード: 400
-
- ResourceNotFoundException
-
Amazon Kinesis Video Streams は、指定したストリームを見つけることができません。
HTTP ステータスコード: 404
以下の資料も参照してください。
言語固有の AWS SDKs のいずれかでこの API を使用する方法の詳細については、以下を参照してください。
