配信グループ内の永続会話アプリケーションインスタンスのリストを照会します。
今すぐお試しください
テスト
RAM 認証
|
アクション |
アクセスレベル |
リソースタイプ |
条件キー |
依存アクション |
|
appstreaming:ListPersistentAppInstances |
get |
*All Resource
|
なし | なし |
リクエストパラメーター
|
パラメーター |
型 |
必須 / 任意 |
説明 |
例 |
| ProductType |
string |
必須 |
プロダクトタイプ。 列挙値:
|
CloudApp。 |
| AppInstanceGroupId |
string |
必須 |
配信グループの ID。 |
aig-0bxls9m9arax6**** |
| AppInstancePersistentIds |
array |
任意 |
永続会話 ID のリスト。 |
|
|
string |
必須 |
永続会話 ID。 |
p-0cc7s3mw2fg4j**** |
|
| PageSize |
integer |
任意 |
1 ページあたりのクエリ結果の数。最大値は 100 です。デフォルト値: 20。 |
20 |
| PageNumber |
integer |
任意 |
表示するクエリ結果のページ番号。値は 1 から始まります。デフォルト値: 1。 |
1 |
レスポンスフィールド
|
フィールド |
型 |
説明 |
例 |
|
object |
レスポンスボディ。 |
||
| RequestId |
string |
リクエスト ID。 |
1CBAFFAB-B697-4049-A9B1-67E1FC5F**** |
| TotalCount |
integer |
クエリ結果の総数。 |
15 |
| PageSize |
integer |
1 ページあたりのクエリ結果の数。 |
20 |
| PageNumber |
integer |
クエリ結果の現在のページ番号。 |
1 |
| PersistentAppInstanceModels |
array<object> |
永続会話アプリケーションインスタンスのリスト。 |
|
|
object |
永続会話アプリケーションインスタンス情報。 |
||
| AppInstancePersistentId |
string |
永続会話 ID。 |
p-0cc7s3mw2fg4j**** |
| AppInstancePersistentName |
string |
永続会話アプリケーションインスタンスの名前。 |
test-persistent-name。 |
| AppInstancePersistentStatus |
string |
永続会話アプリケーションのインスタンスステータス。 列挙値:
|
RUNNING。 |
| AppInstanceGroupId |
string |
配信グループの ID。 |
aig-0bxls9m9arax6**** |
| AppInstanceId |
string |
アプリケーションインスタンスの ID。 |
ai-azn3kmwruh1vl**** |
| AppInstanceStatus |
string |
アプリケーションインスタンスのインスタンスステータス。 列挙値:
|
RUNNING。 |
| GmtCreate |
string |
作成時間。 |
2025-03-13T03:22:18.000+00:00 |
| AuthorizedUsers |
array |
認可されたユーザー名のリスト。 |
|
|
string |
認可されたユーザー名。 |
user-001 |
例
成功レスポンス
JSONJSON
{
"RequestId": "1CBAFFAB-B697-4049-A9B1-67E1FC5F****",
"TotalCount": 15,
"PageSize": 20,
"PageNumber": 1,
"PersistentAppInstanceModels": [
{
"AppInstancePersistentId": "p-0cc7s3mw2fg4j****",
"AppInstancePersistentName": "test-persistent-name",
"AppInstancePersistentStatus": "RUNNING",
"AppInstanceGroupId": "aig-0bxls9m9arax6****",
"AppInstanceId": "ai-azn3kmwruh1vl****",
"AppInstanceStatus": "RUNNING",
"GmtCreate": "2025-03-13T03:22:18.000+00:00",
"AuthorizedUsers": [
"user-001"
]
}
]
}
エラーコード
完全なリストについては、「エラーコード」をご参照ください。
変更履歴
完全なリストについては、「変更履歴」をご参照ください。