特定のリージョンにおける自動スナップショットポリシーの一覧を照会します。
今すぐお試しください
テスト
RAM 認証
|
アクション |
アクセスレベル |
リソースタイプ |
条件キー |
依存アクション |
|
ecs:DescribeAutoSnapshotPolicyEx |
get |
AutoSnapshotPolicy
AutoSnapshotPolicy
|
なし | なし |
リクエストパラメーター
|
パラメーター |
型 |
必須 / 任意 |
説明 |
例 |
| RegionId |
string |
必須 |
自動スナップショットポリシーが属するリージョン ID です。DescribeRegions API を呼び出して、最新のリージョン リストを取得できます。 |
cn-hangzhou |
| AutoSnapshotPolicyId |
string |
任意 |
自動スナップショットポリシーの ID です。 |
sp-bp67acfmxazb4ph**** |
| AutoSnapshotPolicyName |
string |
任意 |
自動スナップショットポリシーの名前です。 |
TestName |
| PageNumber |
integer |
任意 |
ページ番号です。 ページは 1 から始まります。 デフォルト値: 1。 |
1 |
| PageSize |
integer |
任意 |
ページあたりのエントリ数です。 有効な値: 1~100。 デフォルト値: 10。 |
10 |
| Tag |
array<object> |
任意 |
自動スナップショットポリシーのタグです。 |
|
|
object |
任意 |
|||
| Key |
string |
任意 |
自動スナップショットポリシーの N 番目のタグキーです。N の有効な値は 1~20 です。タグキーは空の文字列にすることはできません。長さは最大 128 文字で、http:// または https:// を含めることはできません。acs: または aliyun で始めることはできません。 |
TestKey |
| Value |
string |
任意 |
自動スナップショットポリシーの N 番目のタグ値です。N の有効な値は 1~20 です。タグ値は空の文字列にすることができます。長さは最大 128 文字で、http:// または https:// を含めることはできません。acs: で始めることはできません。 |
TestValue |
| ResourceGroupId |
string |
任意 |
リソースグループの ID です。このパラメーターを指定してリソースをクエリする場合、指定したリソースグループに属する最大 1,000 個のリソースがレスポンスで返されます。 説明
このパラメーターの設定に関係なく、デフォルトリソースグループ内のリソースはレスポンスに含まれます。 |
rg-aek2kkmhmhs**** |
レスポンスフィールド
|
フィールド |
型 |
説明 |
例 |
|
object |
|||
| PageSize |
integer |
ページあたりのエントリ数です。 |
10 |
| RequestId |
string |
リクエスト ID です。 |
473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E |
| PageNumber |
integer |
ページ番号です。 |
1 |
| TotalCount |
integer |
自動スナップショットポリシーの合計数です。 |
1 |
| AutoSnapshotPolicies |
object |
||
| AutoSnapshotPolicy |
array<object> |
自動スナップショットポリシーの詳細です。 |
|
|
array<object> |
|||
| TimePoints |
string |
自動スナップショットを作成する時刻です。 時刻は UTC+8 で表示されます。単位:時間。有効な値:0 ~ 23。00:00:00 ~ 23:00:00 の正時に対応する 24 個の時刻を表します。たとえば、1 は 01:00:00 を表します。複数の時刻を指定できます。 パラメーター値は、最大 24 個の時刻をコンマ (,) で区切った JSON 配列です。例: |
["1"] |
| CreationTime |
string |
自動スナップショットポリシーが作成された時刻です。時刻は、yyyy-MM-ddThh:mm:ssZ フォーマットの ISO 8601 標準に準拠します。時刻は UTC で表示されます。 |
2019-12-10T16:00Z |
| Status |
string |
自動スナップショットポリシーのステータスです。有効な値:
|
Normal |
| AutoSnapshotPolicyName |
string |
自動スナップショットポリシーの名前です。 |
testAutoSnapshotPolicyName |
| TargetCopyRegions |
string |
説明
このパラメーターは招待プレビュー段階であり、一般公開されていません。 |
test |
| CopiedSnapshotsRetentionDays |
integer |
説明
このパラメーターは招待プレビュー段階であり、一般公開されていません。 |
0 |
| AutoSnapshotPolicyId |
string |
自動スナップショットポリシーの ID です。 |
sp-bp67acfmxazb4ph**** |
| RetentionDays |
integer |
自動スナップショットの保持期間です。単位:日。有効な値:
|
7 |
| RegionId |
string |
自動スナップショットポリシーのリージョン ID です。 |
cn-hangzhou |
| DiskNums |
integer |
自動スナップショットポリシーが適用されているディスク数です。 |
1 |
| EnableCrossRegionCopy |
boolean |
説明
このパラメーターは招待プレビュー段階であり、一般公開されていません。 |
false |
| RepeatWeekdays |
string |
自動スナップショットを作成する曜日です。有効な値は 1~7 で、曜日に対応します。たとえば、1 は月曜日を表します。1 つ以上の曜日を指定できます。 |
["6"] |
| VolumeNums |
integer |
自動スナップショットポリシーが適用されている拡張ボリューム数です。 |
2 |
| ResourceGroupId |
string |
リソースグループの ID です。 |
rg-aek2kkmhmhs**** |
| Tags |
object |
||
| Tag |
array<object> |
自動スナップショットポリシーのタグです。 |
|
|
object |
|||
| TagValue |
string |
自動スナップショットポリシーのタグ値です。 |
TestValue |
| TagKey |
string |
自動スナップショットポリシーのタグキーです。 |
TestKey |
| CopyEncryptionConfiguration |
object |
クロスリージョンのスナップショットレプリケーションの暗号化設定です。 |
|
| Encrypted |
boolean |
クロスリージョンのスナップショットレプリケーションで暗号化が有効になっているかどうかを示します。有効な値:
デフォルト値:false。 |
false |
| KMSKeyId |
string |
クロスリージョンのスナップショットレプリケーションでスナップショットの暗号化に使用する Key Management Service (KMS) キーの ID です。 |
0e478b7a-4262-4802-b8cb-00d3fb40**** |
| Type |
string |
自動スナップショットポリシーのタイプです。有効な値:
|
Custom |
例
成功レスポンス
JSONJSON
{
"PageSize": 10,
"RequestId": "473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E",
"PageNumber": 1,
"TotalCount": 1,
"AutoSnapshotPolicies": {
"AutoSnapshotPolicy": [
{
"TimePoints": "[\"1\"]",
"CreationTime": "2019-12-10T16:00Z",
"Status": "Normal",
"AutoSnapshotPolicyName": "testAutoSnapshotPolicyName",
"TargetCopyRegions": "test",
"CopiedSnapshotsRetentionDays": 0,
"AutoSnapshotPolicyId": "sp-bp67acfmxazb4ph****",
"RetentionDays": 7,
"RegionId": "cn-hangzhou",
"DiskNums": 1,
"EnableCrossRegionCopy": false,
"RepeatWeekdays": "[\"6\"]",
"VolumeNums": 2,
"ResourceGroupId": "rg-aek2kkmhmhs****",
"Tags": {
"Tag": [
{
"TagValue": "TestValue",
"TagKey": "TestKey"
}
]
},
"CopyEncryptionConfiguration": {
"Encrypted": false,
"KMSKeyId": "0e478b7a-4262-4802-b8cb-00d3fb40****"
},
"Type": "Custom"
}
]
}
}
エラーコード
|
HTTP ステータスコード |
エラーコード |
エラーメッセージ |
説明 |
|---|---|---|---|
| 400 | InvalidRegionId.NotFound | The specified RegionId does not exist. | |
| 400 | InvalidTag.Mismatch | The specified Tag.n.Key and Tag.n.Value are not match. | |
| 400 | InvalidTagCount | The specified tags are beyond the permitted range. |
完全なリストについては、「エラーコード」をご参照ください。
変更履歴
完全なリストについては、「変更履歴」をご参照ください。