すべてのプロダクト
Search
ドキュメントセンター

Elastic Compute Service:DescribeAutoSnapshotPolicyEx

最終更新日:Jun 19, 2026

特定のリージョンにおける自動スナップショットポリシーの一覧を照会します。

今すぐお試しください

この API を OpenAPI Explorer でお試しください。手作業による署名は必要ありません。呼び出しに成功すると、入力したパラメーターに基づき、資格情報が組み込まれた SDK コードが自動的に生成されます。このコードをダウンロードしてローカルで使用できます。

テスト

RAM 認証

下表に、この API を呼び出すために必要な認証情報を示します。認証情報は、RAM (Resource Access Management) ポリシーを使用して定義できます。以下で各列名について説明します。

  • アクション:特定のリソースに対して実行可能な操作。ポリシー構文ではAction要素として指定します。

  • API:アクションを具体的に実行するための API。

  • アクセスレベル:各 API に対して事前定義されているアクセスの種類。有効な値:create、list、get、update、delete。

  • リソースタイプ:アクションが作用するリソースの種類。リソースレベルでの権限をサポートするかどうかを示すことができます。ポリシーの有効性を確保するため、アクションの対象として適切なリソースを指定してください。

    • リソースレベルの権限を持つ API の場合、必要なリソースタイプはアスタリスク (*) でマークされます。ポリシーのResource要素で対応する ARN を指定してください。

    • リソースレベルの権限を持たない API の場合、「すべてのリソース」と表示され、ポリシーのResource要素でアスタリスク (*) でマークされます。

  • 条件キー:サービスによって定義された条件のキー。このキーにより、きめ細やかなアクセス制御が可能になります。この制御は、アクション単体に適用することも、特定のリソースに対するアクションに適用することもできます。Alibaba Cloud は、サービス固有の条件キーに加えて、すべての RAM 統合サービスに適用可能な一連の共通条件キーを提供しています。

  • 依存アクション:ある特定のアクションを実行するために、前提として実行が必要となる他のアクション。依存アクションの権限も RAM ユーザーまたは RAM ロールに付与する必要があります。

アクション

アクセスレベル

リソースタイプ

条件キー

依存アクション

ecs:DescribeAutoSnapshotPolicyEx

get

AutoSnapshotPolicy

acs:ecs:{#regionId}:{#accountId}:snapshotpolicy/*

AutoSnapshotPolicy

acs:ecs:{#regionId}:{#accountId}:snapshotpolicy/{#snapshotpolicyId}

なし なし

リクエストパラメーター

パラメーター

必須 / 任意

説明

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 配列です。例:["0", "1", ... "23"]

["1"]

CreationTime

string

自動スナップショットポリシーが作成された時刻です。時刻は、yyyy-MM-ddThh:mm:ssZ フォーマットの ISO 8601 標準に準拠します。時刻は UTC で表示されます。

2019-12-10T16:00Z

Status

string

自動スナップショットポリシーのステータスです。有効な値:

  • Normal:自動スナップショットポリシーは正常です。

  • Expire:アカウントで料金滞納が発生しているため、自動スナップショットポリシーを使用できません。

Normal

AutoSnapshotPolicyName

string

自動スナップショットポリシーの名前です。

testAutoSnapshotPolicyName

TargetCopyRegions

string

説明

このパラメーターは招待プレビュー段階であり、一般公開されていません。

test

CopiedSnapshotsRetentionDays

integer

説明

このパラメーターは招待プレビュー段階であり、一般公開されていません。

0

AutoSnapshotPolicyId

string

自動スナップショットポリシーの ID です。

sp-bp67acfmxazb4ph****

RetentionDays

integer

自動スナップショットの保持期間です。単位:日。有効な値:

  • -1:自動スナップショットは、削除されるまで保持されます。

  • 1 ~ 65536:自動スナップショットは、指定した日数保持されます。自動スナップショットの保持期間が終了すると、自動スナップショットは自動的に削除されます。

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

クロスリージョンのスナップショットレプリケーションで暗号化が有効になっているかどうかを示します。有効な値:

  • true

  • false

デフォルト値:false。

false

KMSKeyId

string

クロスリージョンのスナップショットレプリケーションでスナップショットの暗号化に使用する Key Management Service (KMS) キーの ID です。

0e478b7a-4262-4802-b8cb-00d3fb40****

Type

string

自動スナップショットポリシーのタイプです。有効な値:

  • Custom:ユーザー定義のスナップショットポリシーです。

  • System:システム定義のスナップショットポリシーです。

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.

完全なリストについては、「エラーコード」をご参照ください。

変更履歴

完全なリストについては、「変更履歴」をご参照ください。