すべてのプロダクト
Search

このプロダクト

    Elastic Compute Service:DescribeAutoSnapshotPolicyEx

    ドキュメントセンター

    Elastic Compute Service:DescribeAutoSnapshotPolicyEx

    最終更新日:Sep 10, 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 を呼び出して、最新のリージョンリストをクエリできます。

    cn-hangzhou
    AutoSnapshotPolicyId

    string

    任意

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

    sp-bp67acfmxazb4ph****
    AutoSnapshotPolicyName

    string

    任意

    自動スナップショットポリシーの名前。名前は 2～128 文字で、漢字、英字、数字などの Unicode で文字として分類される文字を含めることができます。また、コロン (:)、アンダースコア (_)、ピリオド (.)、ハイフン (-) を含めることもできます。

    TestName
    PageNumber

    integer

    任意

    自動スナップショットポリシーリストで返されるページのページ番号。

    最小値: 1。

    デフォルト値: 1。

    1
    PageSize

    integer

    任意

    自動スナップショットポリシーリストの 1 ページあたりのエントリ数。

    最大値: 100。

    デフォルト値: 10。

    10
    Tag

    array<object>

    任意

    タグ。

    object

    任意

    タグ情報。

    Key

    string

    任意

    自動スナップショットポリシーのタグキー。N の有効な値: 1～20。タグキーは空文字列にできません。タグキーは最大 128 文字で、aliyun または acs: で始めることはできません。タグキーに http:// または https:// を含めることはできません。

    TestKey
    Value

    string

    任意

    自動スナップショットポリシーのタグ値。N の有効な値: 1～20。タグ値は空文字列にできます。タグ値は最大 128 文字で、http:// または https:// を含めることはできません。

    TestValue
    ResourceGroupId

    string

    任意

    リソースグループの ID。このパラメーターを使用してリソースをフィルター処理する場合、リソース数は 1,000 を超えることはできません。

    説明

    デフォルトのリソースグループによるフィルター処理はサポートされていません。

    rg-aek2kkmhmhs****

    レスポンスフィールド

    フィールド

    型

    説明

    例

    object

    PageSize

    integer

    自動スナップショットポリシーがページングモードで表示される場合の 1 ページあたりのエントリ数。

    10
    RequestId

    string

    リクエスト ID

    473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E
    PageNumber

    integer

    自動スナップショットポリシーリストのページ番号。

    1
    TotalCount

    integer

    自動スナップショットポリシーの総数。

    1
    AutoSnapshotPolicies

    object

    AutoSnapshotPolicy

    array<object>

    自動スナップショットポリシーの詳細。

    array<object>

    自動スナップショットポリシーの詳細。

    AutoSnapshotPolicyId

    string

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

    sp-bp67acfmxazb4ph****
    RegionId

    string

    自動スナップショットポリシーのリージョン ID。

    cn-hangzhou
    RepeatWeekdays

    string

    自動スナップショットが作成される曜日。有効な値: 1～7。1 は月曜日を示します。複数の曜日を指定できます。

    ["6"]
    TimePoints

    string

    自動スナップショットが作成される時刻。

    時刻は協定世界時 (UTC)+8 で表示されます。単位: 時間。有効な値: 0～23。0 は 00:00、1 は 01:00 を示します。複数の時刻を指定できます。

    パラメーター値は ["0", "1", ... "23"] の形式の JSON 配列です。最大 24 個の時刻をカンマ (,) 区切りで指定できます。

    ["1"]
    RetentionDays

    integer

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

    • -1: 自動スナップショットは永続的に保持されます。

    • 1～65536: 自動スナップショットは指定された日数保持されます。

    7
    CreationTime

    string

    自動スナップショットポリシーが作成された時間。時間は ISO 8601 規格に準拠し、yyyy-MM-ddTHH:mm:ssZ の形式です。時間は協定世界時 (UTC) で表示されます。

    2019-12-10T16:00Z
    Status

    string

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

    • Normal: ポリシーは正常です。

    • Expire: アカウントの支払い遅延により、ポリシーは使用できません。

    Normal
    AutoSnapshotPolicyName

    string

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

    testAutoSnapshotPolicyName
    EnableCrossRegionCopy

    boolean
    説明

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

    false
    TargetCopyRegions

    string
    説明

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

    test
    CopiedSnapshotsRetentionDays

    integer
    説明

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

    0
    CopyEncryptionConfiguration

    object

    クロスリージョンスナップショットレプリケーションの暗号化構成。

    Encrypted

    boolean

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

    • true: 暗号化が有効です。

    • false: 暗号化が無効です。

    デフォルト値: false。

    false
    KMSKeyId

    string

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

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

    integer

    このポリシーが有効になっているディスクの数。

    説明

    このパラメーターには、関連付けタイプが AssociatedWithDisk であるディスクの数のみが含まれます。

    1
    VolumeNums

    integer

    このポリシーが有効になっている拡張ボリュームの数。

    2
    ResourceGroupId

    string

    リソースグループの ID。

    rg-aek2kkmhmhs****
    Tags

    object

    Tag

    array<object>

    自動スナップショットポリシーのタグキーとタグ値のペア。

    object

    自動スナップショットポリシーのタグキーとタグ値のペア。

    TagKey

    string

    自動スナップショットポリシーのタグキー。

    TestKey
    TagValue

    string

    自動スナップショットポリシーのタグ値。

    TestValue
    AssociationType

    string

    自動スナップショットポリシーとターゲットリソースの関連付けタイプ。有効な値:

    • AssociatedWithDisk: ディスクに関連付け

    • AssociatedWithInstanceTag: インスタンスのタグに関連付け

    AssociatedWithDisk
    TargetTags

    object

    TargetTag

    array<object>

    ターゲットリソースのタグ。自動スナップショットポリシーは、タグに基づいてターゲットリソースをマッチングします。

    object

    ターゲットリソースのタグ。

    TagKey

    string

    タグキー

    env
    TagValue

    string

    タグ値。

    test
    Type

    string

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

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

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

    Custom

    例

    成功レスポンス

    JSONJSON

    {
  "PageSize": 10,
  "RequestId": "473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E",
  "PageNumber": 1,
  "TotalCount": 1,
  "AutoSnapshotPolicies": {
    "AutoSnapshotPolicy": [
      {
        "AutoSnapshotPolicyId": "sp-bp67acfmxazb4ph****",
        "RegionId": "cn-hangzhou",
        "RepeatWeekdays": "[\"6\"]",
        "TimePoints": "[\"1\"]",
        "RetentionDays": 7,
        "CreationTime": "2019-12-10T16:00Z",
        "Status": "Normal",
        "AutoSnapshotPolicyName": "testAutoSnapshotPolicyName",
        "EnableCrossRegionCopy": false,
        "TargetCopyRegions": "test",
        "CopiedSnapshotsRetentionDays": 0,
        "CopyEncryptionConfiguration": {
          "Encrypted": false,
          "KMSKeyId": "0e478b7a-4262-4802-b8cb-00d3fb40****"
        },
        "DiskNums": 1,
        "VolumeNums": 2,
        "ResourceGroupId": "rg-aek2kkmhmhs****",
        "Tags": {
          "Tag": [
            {
              "TagKey": "TestKey",
              "TagValue": "TestValue"
            }
          ]
        },
        "AssociationType": "AssociatedWithDisk",
        "TargetTags": {
          "TargetTag": [
            {
              "TagKey": "env",
              "TagValue": "test"
            }
          ]
        },
        "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. 指定された Tag.N.Key と Tag.N.Value が一致しません。
    400 InvalidTagCount The specified tags are beyond the permitted range. 指定されたタグが有効値外です。

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

    変更履歴

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