作成済みの 1 つ以上のスナップショットの情報を照会します。
操作説明
InstanceId、DiskId、SnapshotIds、および ResourceGroupId は必須のリクエストパラメーターではありませんが、フィルターロジックを構築するために使用できます。これらのパラメーターは論理 AND の関係にあります。
今すぐお試しください
テスト
RAM 認証
|
アクション |
アクセスレベル |
リソースタイプ |
条件キー |
依存アクション |
|
swas-open:ListSnapshots |
get |
*Snapshot。
*Snapshot。
|
なし | なし |
リクエストパラメーター
|
パラメーター |
型 |
必須 / 任意 |
説明 |
例 |
| RegionId |
string |
必須 |
スナップショットが属するシンプルアプリケーションサーバーのリージョン ID。 |
cn-hangzhou |
| InstanceId |
string |
任意 |
シンプルアプリケーションサーバーのインスタンス ID。 |
2ad1ae67295445f598017499dc**** |
| DiskId |
string |
任意 |
ディスクの ID。 |
d-bp14wq0149cpp2xy**** |
| SnapshotIds |
string |
任意 |
スナップショットの ID。値は、最大 100 個のスナップショット ID で構成される JSON 配列にできます。複数の ID はコンマ (,) で区切ります。 |
["s-bp16oazlsold4dks****", "s-bp16oazlsold4abc****"] |
| PageSize |
integer |
任意 |
ページングクエリの 1 ページあたりのエントリ数。最大値: 100。 デフォルト値: 10。 |
10 |
| PageNumber |
integer |
任意 |
スナップショットリストのページ番号。 デフォルト値: 1。 |
1 |
| SourceDiskType |
string |
任意 |
スナップショットのソースクラウドディスクのタイプ。有効な値:
|
Data |
| Tag |
array<object> |
任意 |
スナップショットのタグ。 |
|
|
object |
任意 |
タグ。 |
||
| Key |
string |
任意 |
スナップショットのタグキー。タグキーの長さは 1~64 文字である必要があります。N の有効な値: 1~20。 |
TestKey |
| Value |
string |
任意 |
スナップショットのタグ値。タグ値の長さは 1~64 文字である必要があります。N の有効な値: 1~20。 |
TestValue |
| ResourceGroupId |
string |
任意 |
リソースグループの ID。 |
rg-aek2bti7cf7**** |
レスポンスフィールド
|
フィールド |
型 |
説明 |
例 |
|
object |
|||
| TotalCount |
integer |
スナップショットの総数。 |
1 |
| RequestId |
string |
リクエスト ID。 |
20758A-585D-4A41-A9B2-28DA8F4F534F |
| PageSize |
integer |
ページングクエリの 1 ページあたりのエントリ数。 |
10 |
| PageNumber |
integer |
スナップショットリストのページ番号。 |
1 |
| Snapshots |
array<object> |
スナップショット情報。 |
|
|
array<object> |
|||
| Status |
string |
スナップショットのステータス。有効な値:
|
Accomplished |
| CreationTime |
string |
スナップショットが作成された時間。時間は ISO 8601 標準に準拠し、yyyy-MM-ddTHH:mm:ssZ フォーマットで表されます。時間は協定世界時 (UTC) で表示されます。 |
2021-03-09T07:12:49Z |
| SourceDiskId |
string |
ソースディスクの ID。この値は、スナップショットのソースディスクがリリースされた場合でも保持されます。 |
d-bp14wq0149cpp2xy**** |
| SnapshotName |
string |
スナップショット名。 |
test-SnapshotName |
| Progress |
string |
スナップショット作成の進捗状況。 |
100% |
| Remark |
string |
スナップショットの備考。 |
test-Remark |
| SnapshotId |
string |
スナップショット ID。 |
s-bp16oazlsold4dks**** |
| SourceDiskType |
string |
スナップショットのソースディスクのタイプ。有効な値:
|
System |
| RegionId |
string |
リージョン ID。 |
cn-hangzhou |
| InstanceId |
string |
シンプルアプリケーションサーバーのインスタンス ID。 注意: このフィールドは、システムクラウドディスクのスナップショットの場合は値を持ち、データクラウドディスクのスナップショットの場合は空になります。 |
2ad1ae67295445f598017499dc**** |
| Tags |
array<object> |
スナップショットのタグ。 |
|
|
object |
タグ。 |
||
| Key |
string |
スナップショットのタグキー。 |
TestKey |
| Value |
string |
スナップショットのタグ値。 |
TestValue |
| RollbackTime |
string |
直近のロールバックの時間。時間は協定世界時 (UTC) (Z) タイムゾーンで、YYYY-MM-DDThh:mm:ssZ フォーマットです。 |
2021-03-09T07:12:49Z |
| ResourceGroupId |
string |
スナップショットが属するリソースグループの ID。 |
rg-aek2bti7cf7**** |
例
成功レスポンス
JSONJSON
{
"TotalCount": 1,
"RequestId": "20758A-585D-4A41-A9B2-28DA8F4F534F",
"PageSize": 10,
"PageNumber": 1,
"Snapshots": [
{
"Status": "Accomplished",
"CreationTime": "2021-03-09T07:12:49Z",
"SourceDiskId": "d-bp14wq0149cpp2xy****",
"SnapshotName": "test-SnapshotName",
"Progress": "100%",
"Remark": "test-Remark",
"SnapshotId": "s-bp16oazlsold4dks****",
"SourceDiskType": "System",
"RegionId": "cn-hangzhou",
"InstanceId": "2ad1ae67295445f598017499dc****",
"Tags": [
{
"Key": "TestKey",
"Value": "TestValue"
}
],
"RollbackTime": "2021-03-09T07:12:49Z",
"ResourceGroupId": "rg-aek2bti7cf7****"
}
]
}
エラーコード
|
HTTP ステータスコード |
エラーコード |
エラーメッセージ |
説明 |
|---|---|---|---|
| 400 | RegionIdNotMatchHost | The parameter regionId does not match the endpoint host. | |
| 400 | InvalidSnapshotIds | The specified SnapshotIds is not valid. | |
| 500 | InternalError | An error occurred while processing your request. | |
| 403 | InvalidParam | The specified parameter value is invalid. | |
| 404 | InvalidInstanceId.NotFound | The specified InstanceId does not exist. | |
| 404 | InvalidDiskId.NotFound | The specified DiskId does not exist. |
完全なリストについては、「エラーコード」をご参照ください。
変更履歴
完全なリストについては、「変更履歴」をご参照ください。