すべてのプロダクト
Search

このプロダクト

    Elastic Compute Service:DescribeSnapshotGroups

    ドキュメントセンター

    Elastic Compute Service:DescribeSnapshotGroups

    最終更新日:Apr 04, 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

    任意

    次のクエリの開始点を決定するトークン。 値を、最後の呼び出しから返された NextToken 値に設定します。

    caeba0bbb2be03f84eb48b699f0a4883
    MaxResults

    integer

    任意

    ページあたりの最大エントリ数。

    有効な値: 1～100。

    デフォルト値: 10。

    10
    SnapshotGroupId

    array

    任意

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

    ssg-j6ciyh3k52qp7ovm****

    string

    任意

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

    ssg-j6ciyh3k52qp7ovm****
    Status

    array

    任意

    スナップショット整合性グループ N の状態。 2 番目の N の有効な値: 1、2、3。 有効な値:

    • progressing: スナップショット整合性グループは作成中です。

    • accomplished: スナップショット整合性グループは作成済みです。

    • failed: スナップショット整合性グループの作成に失敗しました。

    accomplished

    string

    任意

    スナップショット整合性グループ N の状態。 2 番目の N の有効な値: 1、2、3。 有効な値:

    • progressing: スナップショット整合性グループは作成中です。

    • accomplished: スナップショット整合性グループは作成済みです。

    • failed: スナップショット整合性グループの作成に失敗しました。

    accomplished
    AdditionalAttributes

    array

    任意

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

    hide

    string

    任意

    説明

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

    null
    Tag

    array<object>

    任意

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

    object

    任意

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

    Key

    string

    任意

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

    TestKey
    Value

    string

    任意

    スナップショット整合性グループのタグ N の値。 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>

    Status

    string

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

    • progressing: スナップショット整合性グループは作成中です。

    • accomplished: スナップショット整合性グループは作成済みです。

    • failed: スナップショット整合性グループの作成に失敗しました。

    accomplished
    CreationTime

    string

    作成時刻。 時刻は、yyyy-MM-ddTHH:mm:ssZ 形式の ISO 8601 標準に準拠しています。 時刻は協定世界時 (UTC) で表示されます。

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

    string

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

    This is description.
    ProgressStatus

    string
    説明

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

    null
    SnapshotGroupId

    string

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

    ssg-j6ciyh3k52qp7ovm****
    InstanceId

    string

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

    i-j6ca469urv8ei629****
    Name

    string

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

    testName
    ResourceGroupId

    string

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

    rg-bp67acfmxazb4p****
    Tags

    object

    Tag

    array<object>

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

    object

    Key

    string

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

    TestKey
    Value

    string

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

    TestValue
    Snapshots

    object

    Snapshot

    array<object>

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

    array<object>

    SourceDiskId

    string

    ソースディスクの ID。 このパラメーターは、スナップショットのソースディスクがリリースされた後も保持されます。

    d-j6c3ogynmvpi6wy7****
    Progress

    string

    スナップショット作成タスクの進捗。 単位: パーセント (%)。

    100%
    Available

    boolean

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

    • true

    • false

    false
    InstantAccessRetentionDays

    integer

    高速スナップショット機能の有効期間。 有効期間が終了すると、高速スナップショットは自動的にリリースされます。

    説明

    このパラメーターは現在使用されていません。 デフォルトでは、ESSD の標準スナップショットは、追加の構成を必要とせずに無料で高速スナップショットにアップグレードされます。 詳細については、「高速スナップショット機能の使用」をご参照ください。

    3
    SnapshotId

    string

    スナップショットの ID。

    s-j6cbzmrlbf09w72q****
    InstantAccess

    boolean

    高速スナップショット機能が有効になっているかどうかを示します。 有効な値:

    • true: 高速スナップショット機能が有効になっています。 デフォルトでは、ESSD に対して高速スナップショット機能が有効になっています。

    • false: 高速スナップショット機能が無効になっています。 スナップショットは、高速スナップショット機能が無効になっている標準スナップショットです。

    説明

    このパラメーターは現在使用されていません。 デフォルトでは、ESSD の標準スナップショットは、追加の構成を必要とせずに無料で高速スナップショットにアップグレードされます。 詳細については、「高速スナップショット機能の使用」をご参照ください。

    true
    SourceDiskType

    string

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

    • system: システムディスク

    • data: データディスク

    system
    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": [
      {
        "Status": "accomplished",
        "CreationTime": "2021-03-23T10:58:48Z",
        "Description": "This is description.",
        "ProgressStatus": "null",
        "SnapshotGroupId": "ssg-j6ciyh3k52qp7ovm****",
        "InstanceId": "i-j6ca469urv8ei629****",
        "Name": "testName",
        "ResourceGroupId": "rg-bp67acfmxazb4p****",
        "Tags": {
          "Tag": [
            {
              "Key": "TestKey",
              "Value": "TestValue"
            }
          ]
        },
        "Snapshots": {
          "Snapshot": [
            {
              "SourceDiskId": "d-j6c3ogynmvpi6wy7****",
              "Progress": "100%",
              "Available": false,
              "InstantAccessRetentionDays": 3,
              "SnapshotId": "s-j6cbzmrlbf09w72q****",
              "InstantAccess": true,
              "SourceDiskType": "system",
              "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.

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

    変更履歴

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