JVS インスタンスの詳細を取得します。
今すぐお試しください
テスト
RAM 認証
リクエスト構文
POST /anonymous/jvs/instance/describe HTTP/1.1
リクエストパラメーター
|
パラメーター |
型 |
必須 / 任意 |
説明 |
例 |
| InstanceIds |
array |
任意 |
インスタンス ID のリストです。 |
|
|
string |
任意 |
インスタンス ID です。 |
acp-5hh431emkt6u***** |
|
| MaxResults |
integer |
任意 |
1 ページあたりに返されるエントリ数です。 |
10 |
| NextToken |
string |
任意 |
前回のリクエストから取得したページネーショントークンで、次のページの結果を取得するために使用します。最初のリクエストでは、このパラメーターを省略してください。 |
AAAAAV3MpHK1AP0pfERHZN5pu6kU+SQXzm0H9mu/FiSc**** |
レスポンスフィールド
|
フィールド |
型 |
説明 |
例 |
|
object |
応答オブジェクトです。 |
||
| RequestId |
string |
リクエスト ID です。 |
425F351C-3F8E-5218-A520-B6311D0D**** |
| MaxResults |
integer |
現在のページで返されたエントリ数です。 |
10 |
| NextToken |
string |
次のページの結果を取得するためのトークンです。このフィールドが空の場合、これ以上結果はありません。 |
AAAAAV3MpHK1AP0pfERHZN5pu6kU+SQXzm0H9mu/FiSc**** |
| TotalCount |
integer |
エントリの総数です。 |
30 |
| Data |
array<object> |
JVS インスタンスのリストです。 |
|
|
array<object> |
JVS インスタンスの詳細です。 |
||
| InstanceId |
string |
インスタンス ID です。 |
acp-uto81vfd8t8z**** |
| CreditConfig |
array<object> |
クレジット上限の構成です。複数の構成を適用する場合、最新のものが他のものを上書きします。 |
|
|
object |
クレジット上限の構成オブジェクトです。 |
||
| CreditLimit |
integer |
クレジット上限です。 列挙値:
|
-1 |
| LimitPeriod |
string |
上限期間です。 列挙値:
|
day |
| UsedCredit |
array<object> |
使用済みクレジットの量です。 |
|
|
object |
|||
| Credit |
integer |
クレジットの量です。 |
5 |
| LimitPeriod |
string |
使用済みクレジットの計算期間です。 列挙値:
|
day |
| JvsPackageId |
string |
このパラメーターはサポートされていません。 |
null |
| Status |
string |
インスタンスステータスです。 |
RUNNNING |
| CreateTime |
string |
インスタンスの作成時刻です。 |
2026-04-10T01:31:32Z |
| ModifyTime |
string |
インスタンスが最後に変更された時刻です。 |
2026-04-10T01:31:32Z |
| ExpireTime |
string |
有効期限です。 |
2026-04-10T01:31:32Z |
例
成功レスポンス
JSONJSON
{
"RequestId": "425F351C-3F8E-5218-A520-B6311D0D****",
"MaxResults": 10,
"NextToken": "AAAAAV3MpHK1AP0pfERHZN5pu6kU+SQXzm0H9mu/FiSc****",
"TotalCount": 30,
"Data": [
{
"InstanceId": "acp-uto81vfd8t8z****",
"CreditConfig": [
{
"CreditLimit": -1,
"LimitPeriod": "day"
}
],
"UsedCredit": [
{
"Credit": 5,
"LimitPeriod": "day"
}
],
"JvsPackageId": "null",
"Status": "RUNNNING",
"CreateTime": "2026-04-10T01:31:32Z",
"ModifyTime": "2026-04-10T01:31:32Z",
"ExpireTime": "2026-04-10T01:31:32Z"
}
]
}
エラーコード
完全なリストについては、「エラーコード」をご参照ください。
変更履歴
完全なリストについては、「変更履歴」をご参照ください。