すべてのプロダクト
Search

このプロダクト

    Elastic Compute Service:DescribeSnapshotGroups

    ドキュメントセンター

    Elastic Compute Service:DescribeSnapshotGroups

    最終更新日:Aug 10, 2026

    1 つ以上のスナップショット整合性グループの情報を照会します。ステータス、インスタンス ID、スナップショット作成の進行状況などが含まれます。

    操作説明

    InstanceId、SnapshotGroupId.N、Status.N は必須のリクエストパラメーターではありませんが、フィルターロジックを構築するために使用できます。これらのパラメーターは論理 AND 関係にあります。

    今すぐお試しください

    この 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:DescribeSnapshotGroups

    get

    SnapshotGroup。

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

    SnapshotGroup。

    acs:ecs:{#regionId}:{#accountId}:snapshotgroup/{#snapshotgroupId}

    		 なし なし

    リクエストパラメーター

    パラメーター

    型

    必須 / 任意

    説明

    例
    RegionId

    string

    必須

    リージョン ID。 DescribeRegions を呼び出して最新のリージョンリストをクエリできます。

    cn-hangzhou
    InstanceId

    string

    任意

    インスタンス ID

    i-j6ca469urv8ei629****
    Name

    string

    任意

    スナップショット整合性グループの名前。

    testName
    NextToken

    string

    任意

    ページネーショントークン。このパラメーターには、前の API 呼び出しで返された NextToken の値を設定します。

    caeba0bbb2be03f84eb48b699f0a4883
    MaxResults

    integer

    任意

    ページングクエリにおける 1 ページあたりの最大エントリ数。

    10
    SnapshotGroupId

    array

    任意

    スナップショット整合性グループの ID。N の有効な値: 1～10。

    ssg-j6ciyh3k52qp7ovm****

    string

    任意

    スナップショット整合性グループの ID。N の有効な値: 1～10。

    ssg-j6ciyh3k52qp7ovm****
    Status

    array

    任意

    スナップショット整合性グループのステータス。N の有効な値: 1～3。有効な値:

    accomplished

    string

    任意

    スナップショット整合性グループのステータス。N の有効な値: 1～3。有効な値:

    accomplished
    AdditionalAttributes

    array

    任意

    このパラメーターは公開されていません。

    hide

    string

    任意

    説明

    このパラメーターは公開されていません。

    null
    Tag

    array<object>

    任意

    スナップショット整合性グループのタグキーとタグ値のペア。

    object

    任意

    スナップショット整合性グループのタグキーとタグ値のペア。

    Key

    string

    任意

    スナップショット整合性グループのタグキー。N の有効な値: 1～20。

    TestKey
    Value

    string

    任意

    スナップショット整合性グループのタグ値。N の有効な値: 1～20。

    TestValue
    ResourceGroupId

    string

    任意

    スナップショット整合性グループが属するリソースグループの ID。

    rg-bp67acfmxazb4p****

    レスポンスフィールド

    フィールド

    型

    説明

    例

    object

    NextToken

    string

    次のクエリのページネーショントークン。

    caeba0bbb2be03f84eb48b699f0a4883
    RequestId

    string

    リクエスト ID

    3F9A4CC4-362F-469A-B9EF-B3204EF8AA3A
    SnapshotGroups

    object

    SnapshotGroup

    array<object>

    スナップショット整合性グループの情報。

    array<object>

    スナップショット整合性グループの詳細。

    SnapshotGroupId

    string

    スナップショット整合性グループの ID。

    ssg-j6ciyh3k52qp7ovm****
    InstanceId

    string

    スナップショット整合性グループが属するインスタンスの ID。このパラメーターは、スナップショット整合性グループ内のすべてのディスクスナップショットが同じインスタンスに属している場合にのみ返されます。スナップショット整合性グループ内のディスクスナップショットが異なる ECS インスタンスに属している場合は、応答内の Snapshots.Snapshot.Tags.* パラメーターを確認して、グループ内の各スナップショットのインスタンス ID をビューできます。

    i-j6ca469urv8ei629****
    Status

    string

    スナップショット整合性グループのステータス。有効な値:

    accomplished
    ProgressStatus

    string
    説明

    このパラメーターは一般公開されていません。

    null
    Name

    string

    スナップショット整合性グループの名前。

    testName
    Description

    string

    説明。

    This is description
    CreationTime

    string

    作成時間。時間は ISO 8601 標準に従い、yyyy-MM-ddTHH:mm:ssZ 形式で初期化されます。時間は協定世界時 (UTC) で表示されます。

    2021-03-23T10:58:48Z
    ResourceGroupId

    string

    スナップショット整合性グループが属するリソースグループの ID。

    rg-bp67acfmxazb4p****
    Tags

    object

    Tag

    array<object>

    スナップショット整合性グループのタグキーと値のペア。

    object

    Key

    string

    スナップショット整合性グループのタグキー。

    TestKey
    Value

    string

    スナップショット整合性グループのタグ値。

    TestValue
    Snapshots

    object

    Snapshot

    array<object>

    スナップショット整合性グループ内のスナップショットに関する情報。

    array<object>

    SnapshotId

    string

    スナップショットの ID。

    s-j6cbzmrlbf09w72q****
    SourceDiskId

    string

    ソースディスクの ID。このフィールドは、ソースディスクがリリースされた場合でも保持されます。

    d-j6c3ogynmvpi6wy7****
    SourceDiskType

    string

    ソースディスクのタイプ。有効な値:

    system
    Available

    boolean

    スナップショットを使用してディスクの作成、ディスクのロールバック、またはスナップショットの共有を実行できるかどうかを示します。有効な値:

    false
    Progress

    string

    スナップショット作成の進行状況 (パーセンテージ)。

    100%
    InstantAccess

    boolean

    スナップショットの即時アクセスが有効かどうかを示します。有効な値:

    true
    InstantAccessRetentionDays

    integer

    スナップショット即時アクセス特徴の保持期間。保持期間が終了すると、スナップショットは自動的にリリースされます。

    3
    Tags

    object

    Tag

    array<object>

    スナップショット整合性グループ内の各スナップショットのタグキーと値のペア。デフォルトでは、スナップショットのソース情報が含まれます。

    object

    Key

    string

    スナップショット整合性グループ内の各スナップショットのタグキー。Key および Value のデフォルト値には、スナップショットのソース情報が含まれます。

    acs:ecs:createFrom
    Value

    string

    スナップショット整合性グループ内の各スナップショットのタグ値。Key および Value のデフォルト値には、スナップショットのソース情報が含まれます。

    i-bp11qm0o3dk4iuc****

    例

    成功レスポンス

    JSONJSON

    {
  "NextToken": "caeba0bbb2be03f84eb48b699f0a4883",
  "RequestId": "3F9A4CC4-362F-469A-B9EF-B3204EF8AA3A",
  "SnapshotGroups": {
    "SnapshotGroup": [
      {
        "SnapshotGroupId": "ssg-j6ciyh3k52qp7ovm****",
        "InstanceId": "i-j6ca469urv8ei629****",
        "Status": "accomplished",
        "ProgressStatus": "null",
        "Name": "testName",
        "Description": "This is description",
        "CreationTime": "2021-03-23T10:58:48Z",
        "ResourceGroupId": "rg-bp67acfmxazb4p****",
        "Tags": {
          "Tag": [
            {
              "Key": "TestKey",
              "Value": "TestValue"
            }
          ]
        },
        "Snapshots": {
          "Snapshot": [
            {
              "SnapshotId": "s-j6cbzmrlbf09w72q****",
              "SourceDiskId": "d-j6c3ogynmvpi6wy7****",
              "SourceDiskType": "system",
              "Available": false,
              "Progress": "100%",
              "InstantAccess": true,
              "InstantAccessRetentionDays": 3,
              "Tags": {
                "Tag": [
                  {
                    "Key": "acs:ecs:createFrom",
                    "Value": "i-bp11qm0o3dk4iuc****"
                  }
                ]
              }
            }
          ]
        }
      }
    ]
  }
}

    エラーコード

    HTTP ステータスコード

    エラーコード

    エラーメッセージ

    説明
    400 Duplicate.TagKey The Tag.N.Key contain duplicate key. タグに重複するキーが存在します。キーを一意にしてください。
    403 InvalidSnapshotGroupId.MustBeOne The size of SnapshotGroupIds must be one when AdditionalAttributes has SNAPSHOT_GROUP_PROGRESS_STATUS.
    403 InvalidStatus.ValueNotSupported The specified parameter status is not valid. The expected status is progressing; accomplished or failed.
    404 InvalidRegionId.NotFound The RegionId provided does not exist in our records. リージョン情報が無効です。
    404 InvalidInstanceId.NotFound The InstanceId provided does not exist in our records.

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

    変更履歴

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