接続チケットをバッチで取得します。この操作は、チケットを非同期で生成します。ほとんどの場合、応答から直接チケットを取得できます。場合によっては、応答から `TaskId` を使用して操作を再度呼び出し、チケット生成ステータスをポーリングする必要があります。
操作説明
今すぐお試しください
テスト
RAM 認証
リクエストパラメーター
|
パラメーター |
型 |
必須 / 任意 |
説明 |
例 |
| InstanceGroupId |
string |
任意 |
インスタンスグループ ID。 |
ag-25nt4kk9whjh**** |
| InstanceIds |
array |
任意 |
クラウドフォンインスタンス ID のリスト。1～100 個の ID を設定できます。 |
|
|
string |
任意 |
インスタンス ID。 |
acp-bj9t2gmys**** |
|
| EndUserId |
string |
任意 |
割り当てられたユーザーの ID。このパラメーターを渡さない場合、バックエンドによって割り当てられたシステムユーザーがチケットの取得に使用されます。 |
user |
| 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**** |
例
成功レスポンス
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****"
}
]
}エラーコード
完全なリストについては、「エラーコード」をご参照ください。
変更履歴
完全なリストについては、「変更履歴」をご参照ください。