インスタンスのライフサイクルを取得します。
操作説明
インスタンスのライフサイクルトランジション情報を取得します。 特定の時点におけるインスタンスの状態の詳細を取得できます。
今すぐお試しください
テスト
RAM 認証
|
アクション |
アクセスレベル |
リソースタイプ |
条件キー |
依存アクション |
|
paidsw:GetLifecycle |
get |
*All Resource
|
なし | なし |
リクエスト構文
GET /api/v2/instances/{InstanceId}/lifecycle HTTP/1.1
パスパラメーター
|
パラメーター |
型 |
必須 / 任意 |
説明 |
例 |
| InstanceId |
string |
必須 |
インスタンス ID。 インスタンス ID の取得方法の詳細については、「ListInstances」をご参照ください。 |
dsw-9698d842b6*** |
リクエストパラメーター
|
パラメーター |
型 |
必須 / 任意 |
説明 |
例 |
| SessionNumber |
integer |
任意 |
セッションとは、インスタンスが起動してから失敗または停止するまでの期間です。 sessionNumber は、セッションの序数オフセットを指定します。 |
1 |
| StartTime |
string |
任意 |
クエリの開始時刻。 |
2020-11-08T15:00:00Z |
| EndTime |
string |
任意 |
クエリの終了時刻。 |
2020-11-08T15:00:00Z |
| Limit |
integer |
任意 |
クエリで返すセッションの最大数。 |
1 |
| Order |
string |
任意 |
結果をソートする順序。 有効な値:
|
DESC |
| Token |
string |
任意 |
URL を共有するために使用されるトークン。 |
レスポンスフィールド
|
フィールド |
型 |
説明 |
例 |
|
object |
ライフサイクルクエリの結果。 |
||
| RequestId |
string |
リクエスト ID。 |
E7D55162-4489-1619-AAF5-3F97D5FC**** |
| Success |
boolean |
リクエストが成功したかどうかを示します。 有効な値:
|
true |
| Message |
string |
操作に対して返されたメッセージ。 |
"XXX" |
| Code |
string |
状態コード。 有効な値:
|
null |
| Lifecycle |
array<object> |
セッションごとに整理されたインスタンスのライフサイクルの詳細。 |
[[{"Status":"Creating","GmtCreateTime":"2022-09-19T22:38:00Z","Reason":"","ReasonCode":""}]] |
|
array<object> |
ライフサイクルのリスト。各サブキーはセッションのライフサイクルを表します。 |
||
|
object |
単一のライフサイクルイベント。 |
||
| Status |
string |
インスタンスのステータス。 指定可能な値:
列挙値:
|
Starting |
| ReasonCode |
string |
イベントが発生した理由のコード。 |
“” |
| ReasonMessage |
string |
イベントが発生した理由の説明。 |
“” |
| GmtCreateTime |
string |
インスタンスがこの状態に移行した時刻。 時刻は GMT です。 |
2022-10-21T07:27:44Z |
| GmtEndTime |
string |
||
| LifecycleId |
string |
||
| TotalCount |
integer |
返されたセッションの総数。 |
35 |
例
成功レスポンス
JSONJSON
{
"RequestId": "E7D55162-4489-1619-AAF5-3F97D5FC****",
"Success": true,
"Message": "\"XXX\"",
"Code": "null",
"Lifecycle": [
[
{
"Status": "Starting",
"ReasonCode": "“”",
"ReasonMessage": "“”",
"GmtCreateTime": "2022-10-21T07:27:44Z",
"GmtEndTime": "",
"LifecycleId": ""
}
]
],
"TotalCount": 35
}
エラーコード
完全なリストについては、「エラーコード」をご参照ください。
変更履歴
完全なリストについては、「変更履歴」をご参照ください。