接続チケットをバッチで取得します。この操作はチケットを非同期で生成します。ほとんどの場合、チケットは最初の応答で直接返されます。場合によっては、最初の応答に TaskId が含まれています。チケットが生成されるまで、その TaskId を使用してこの操作をポーリングします。
操作説明
今すぐお試しください
テスト
RAM 認証
リクエストパラメーター
|
パラメーター |
型 |
必須 / 任意 |
説明 |
例 |
| InstanceGroupId |
string |
任意 |
インスタンスグループの ID。 |
ag-25nt4kk9whjh**** |
| InstanceIds |
array |
任意 |
クラウドフォンインスタンスの ID。1～100個の ID を指定します。 |
|
|
string |
任意 |
クラウドフォンインスタンスの ID。 |
acp-bj9t2gmys**** |
|
| EndUserId |
string |
任意 |
割り当てられたユーザーの ID。このパラメーターを省略すると、システムはシステム割り当てユーザーを使用してチケットを取得します。 |
user |
| ConnectionMode |
string |
任意 |
接続モード。 |
custom |
| InstanceTasks |
array<object> |
任意 |
インスタンス接続タスク。チケット取得タスクが完了したかどうかを確認するために使用します。 |
|
|
object |
任意 |
インスタンス接続タスク。 |
||
| InstanceId |
string |
任意 |
クラウドフォンインスタンスの ID。 |
acp-fkuit0cmyfvzz**** |
| TaskId |
string |
任意 |
タスクの ID。 |
cn-hangzhou@c9f5c2e8-f5c4-4b01-8602-000cae94**** |
レスポンスフィールド
|
フィールド |
型 |
説明 |
例 |
|
object |
応答スキーマ |
||
| RequestId |
string |
リクエストの ID。 |
7B9EFA4F-4305-5968-BAEE-BD8B8DE5**** |
| InstanceConnectionModels |
array<object> |
インスタンス接続タスクの結果。 |
|
|
object |
インスタンス接続タスクの結果。 |
||
| AppInstanceGroupId |
string |
配信グループの ID。 |
aig-1uzb6heg797z3**** |
| InstanceId |
string |
クラウドフォンインスタンスの ID。 |
acp-ajxvwo1u0hqvd**** |
| TaskStatus |
string |
タスクのステータス。値が FINISHED の場合、Ticket フィールドからチケットを取得します。それ以外の場合は、TaskId を使用してこの操作をポーリングし、チケット生成ステータスを確認します。 |
FINISHED |
| TaskId |
string |
タスクの ID。 |
cn-hangzhou@c9f5c2e8-f5c4-4b01-8602-000cae94**** |
| Ticket |
string |
クラウドフォンインスタンスへの接続に使用されるチケット。 |
piVE58_AdmVSVW7SEW3*AE5*p8mmO5gvItsNOmv4S_f_cNpoU_BOTwChTBoNM1ZJeedfK9zxYnbN5hossqIZCr6t7SGxRigm2Cb4fGaCdBZWIzmgdHq6sXXZQg4KFWufyvpeV*0*Cm58slMT1tJw3**** |
| ErrorCode |
string |
エラーの原因。 |
InvalidResourceId.NotFound |
| PersistentAppInstanceId |
string |
永続セッション ID。 |
p-abdywvcksdb**** |
| AppInstanceId |
string |
物理インスタンス ID。 |
ai-0caoetkqi8kj**** |
| Port |
integer |
接続を確立するために使用されるポート。 |
10000 |
例
成功レスポンス
JSONJSON
{
"RequestId": "7B9EFA4F-4305-5968-BAEE-BD8B8DE5****",
"InstanceConnectionModels": [
{
"AppInstanceGroupId": "aig-1uzb6heg797z3****",
"InstanceId": "acp-ajxvwo1u0hqvd****",
"TaskStatus": "FINISHED",
"TaskId": "cn-hangzhou@c9f5c2e8-f5c4-4b01-8602-000cae94****",
"Ticket": "piVE58_AdmVSVW7SEW3*AE5*p8mmO5gvItsNOmv4S_f_cNpoU_BOTwChTBoNM1ZJeedfK9zxYnbN5hossqIZCr6t7SGxRigm2Cb4fGaCdBZWIzmgdHq6sXXZQg4KFWufyvpeV*0*Cm58slMT1tJw3****",
"ErrorCode": "InvalidResourceId.NotFound",
"PersistentAppInstanceId": "p-abdywvcksdb****",
"AppInstanceId": "ai-0caoetkqi8kj****",
"Port": 10000
}
]
}エラーコード
完全なリストについては、「エラーコード」をご参照ください。
変更履歴
完全なリストについては、「変更履歴」をご参照ください。