1つ以上のスナップショット整合性グループの詳細を照会します。

説明

クエリするInstanceIdSnapshotGroupId.NStatus.Nなど、複数のリクエストパラメーターを指定できます。 指定されたパラメーター間には、論理 AND 関係が存在します。 指定されたパラメーターのみがフィルター条件に含まれます。

デバッグ

OpenAPI Explorer は署名値を自動的に計算します。 この操作は、OpenAPI Explorer で呼び出すことを推奨します。 OpenAPI Explorer は、さまざまな SDK に対して操作のサンプルコードを動的に生成します。

リクエストパラメーター

パラメーター データ型 必須/任意 説明
操作 String 必須 DescribeSnapshotGroups

実行する操作です。 値をDescribeSnapshotGroupsに設定します。

RegionId String 必須 cn-hangzhou

スナップショット整合性グループのリージョンID。 DescribeRegions を呼び出して、最新のリージョンリストをクエリできます。

InstanceId String 任意 i-j6ca469urv8ei629 ****

インスタンスの ID。

パラメーター名 String 任意 testName

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

NextToken String 任意 caeba0bbb2be03f84eb48b699f0a4883

クエリトークン。 DescribeSnapshotGroups操作の最後の呼び出しで返されるNextToken値に値を設定します。

MaxResults Integer 任意 10

各ページで返されるエントリ数。

最大値:100。

Default value: 10.

ResourceGroupId String 任意 rg-bp67acfmxazb4p****

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

SnapshotGroupId.N String 任意 ssg-j6ciyh3k52qp7ovm ****

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

Status.N String 任意 accomplished

スナップショット整合グループNの状態。Nの有効値: 1〜3。 設定可能な値は以下のとおりです。

  • progressing: スナップショット一貫性のあるグループが作成中です。
  • 達成済み: スナップショット一貫性のあるグループが作成されます。
  • failed: スナップショット整合性グループの作成に失敗しました。
Tag.N.Key String 任意 TestKey

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

Tag.N.Value String 任意 TestValue

snapshot-consistentグループのタグNの値。 N の有効値:1 ~ 20。

レスポンスパラメーター

パラメーター データ型 説明
NextToken String caeba0bbb2be03f84eb48b699f0a4883

次のクエリの開始に使用されるトークン。

このパラメーターが空の場合、データは返されません。
RequestId String 3F9A4CC4-362F-469A-B9EF-B3204EF8AA3A

リクエストの ID です。

SnapshotGroups Array of SnapshotGroup

Details of the snapshot-consistent groups.

SnapshotGroup
ステータス String accomplished

スナップショット整合性グループの状態。 設定可能な値は以下のとおりです。

  • progressing: スナップショット一貫性のあるグループが作成中です。
  • 達成済み: スナップショット一貫性のあるグループが作成されます。
  • failed: スナップショット整合性グループの作成に失敗しました。
CreationTime String 2021-03-23T10:58:48Z

スナップショット整合性グループが作成された時刻。

説明 String これは説明です。

The description of the snapshot-consistent group.

進行状況 String null
このパラメーターは使用できません。
SnapshotGroupId String ssg-j6ciyh3k52qp7ovm****

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

InstanceId String i-j6ca469urv8ei629 ****

スナップショット整合性グループが属するインスタンスのID。 このパラメーターの値は、スナップショット整合グループ内のすべてのディスクスナップショットが同じインスタンスに属している場合にのみ設定されます。 スナップショット一貫性グループのディスクスナップショットが異なるインスタンスに属している場合、snapshots. snapshot. Tagsから始まるパラメーターを使用できます。 スナップショット整合性グループ内の各スナップショットが属するインスタンスのIDを表示します。

パラメーター名 String testName

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

ResourceGroupId String rg-bp67acfmxazb4p****

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

タグ タグの配列

The tags of the snapshot-consistent group.

タグ
Key String TestKey

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

利点 String TestValue

snapshot-consistentグループのタグ値。

スナップショット スナップショットの配列

snapshot-consistentグループ内のスナップショットの詳細。

スナップショット
SourceDiskId String d-j6c3ogynmvpi6wy7 ****

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

進捗 String 100%

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

InstantAccessRetentionDays Integer 3

インスタントアクセス機能の保持期間。 保存期間が終了すると、スナップショットは自動的にリリースされます。

SnapshotId String s-j6cbzmrlbf09w72q ****

スナップショットチェーンの ID 。

InstantAccess Boolean true

インスタントアクセス機能が有効かどうかを示します。 設定可能な値は以下のとおりです。

  • true: インスタントアクセス機能が有効になっています。 この機能は、拡張SSD (ESSD) に対してのみ有効にできます。
  • false: インスタントアクセス機能は無効です。 スナップショットは、インスタントアクセス機能が無効になっている通常のスナップショットです。
SourceDiskType String system

ソースディスクのタイプ。 設定可能な値は以下のとおりです。

  • システム: システムディスク
  • data: データディスク
タグ タグの配列

snapshot-consistentグループ内のスナップショットのタグ。 デフォルト値には、スナップショット整合性グループが属するインスタンスの詳細が含まれます。

タグ
Key String acs:ecs:createFrom

snapshot-consistentグループ内の各スナップショットのタグキー。 KeyとValueのデフォルト値には、スナップショット整合性グループが属するインスタンスの詳細が含まれています。

利点 String i-bp11qm0o3dk4iuc ****

snapshot- consistentグループ内の各スナップショットのタグ値。 KeyとValueのデフォルト値には、スナップショット整合性グループが属するインスタンスの詳細が含まれています。

リクエストの例

https://ecs.aliyuncs.com/?Action=DescribeSnapshotGroups
&RegionId=cn-hangzhou
&SnapshotGroupId.1=ssg-j6ciyh3k52qp7ovm ****
&<共通リクエストパラメーター>

正常に処理された場合のレスポンス例

XML 形式

HTTP/1.1 200 OK
Content-Type:application/xml

<DescribeSnapshotGroupsResponse>
    <NextToken>caeba0bbb2be03f84eb48b699f0a4883</NextToken>
    <RequestId>3F9A4CC4-362F-469A-B9EF-B3204EF8AA3A</RequestId>
    <SnapshotGroups>
        <SnapshotGroup>
            <ステータス> 達成 </ステータス>
            <説明> これは説明です。</Description>
            <InstanceId/>
            <CreationTime>2021-03-23T10:58:48Z</CreationTime>
            <SnapshotGroupId>ssg-j6ciyh3k52qp7ovm ****</SnapshotGroupId>
            <ResourceGroupId>rg-bp67acfmxazb4p ****</ResourceGroupId>
            <Name>testName</Name>
            <Tags>
                <Tag>
                    <Value> テスト値 </Value>
                    <キー> TestKey</キー>
                </Tag>
            </Tags>
            <スナップショット>
                <スナップショット>
                    <SnapshotId>s-j6cbzmrlbf09w72q ****</SnapshotId>
                    <Progress>100%</Progress>
                    <InstantAccessRetentionDays>3</InstantAccessRetentionDays>
                    <SourceDiskType> system </SourceDiskType>
                    <SourceDiskId>d-j6c3ogynmvpi6wy7 ****</SourceDiskId>
                    <Tags>
                        <Tag>
                            <値> i-bp11qm0o3dk4iuc ****</値>
                            <キー> acs:ecs:createFrom</Key>
                        </Tag>
                    </Tags>
                </スナップショット>
                <スナップショット>
                    <SnapshotId>s-bp1fgrjucs8wr31 ****</SnapshotId>
                    <Progress>100%</Progress>
                    <SourceDiskType> system </SourceDiskType>
                    <SourceDiskId>d-bp1bcsu5leotddp ****</SourceDiskId>
                    <Tags>
                        <Tag>
                            <値> i-bp1emqgxsg88zdl ****</値>
                            <キー> acs:ecs:createFrom</Key>
                        </Tag>
                    </Tags>
                </スナップショット>
            </スナップショット>
        </SnapshotGroup>
    </SnapshotGroups>
</DescribeSnapshotGroupsResponse>

JSON 形式

HTTP/1.1 200 OK
Content-Type:application/json

{
  "NextToken" : "caeba0bbb2be03f84eb48b699f0a4883" 、
  "RequestId" : "3F9A4CC4-362F-469A-B9EF-B3204EF8AA3A" 、
  "SnapshotGroups" : {
    "SnapshotGroup" : [ {
      "ステータス" : "達成" 、
      "Description" : "これは説明です。
      "InstanceId" : "" 、
      "CreationTime" : "2021-03-23T10:58:48Z" 、
      "SnapshotGroupId" : "ssg-j6ciyh3k52qp7ovm ****" 、
      "ResourceGroupId" : "rg-bp67acfmxazb4p ****" 、
      "Name" : "testName" 、
      "タグ" : {
        "タグ" : [ {
          "Value" : "TestValue" 、
          "キー" : "TestKey"
        } ]
      },
      "スナップショット" : {
        "スナップショット" : [ {
          "SnapshotId" : "s-j6cbzmrlbf09w72q ****" 、
          "進歩" : "100%" 、
          "InstantAccessRetentionDays" : 3、
          "SourceDiskType" : "システム" 、
          "SourceDiskId" : "d-j6c3ogynmvpi6wy7 ****" 、
          "タグ" : {
            "タグ" : [ {
              "Value" : "i-bp11qm0o3dk4iuc****",
              "キー" : "acs:ecs:createFrom"
            } ]
          }
        }, {
          "SnapshotId" : "s-bp1fgrjucs8wr31****",
          "進歩" : "100%" 、
          "SourceDiskType" : "システム" 、
          "SourceDiskId" : "d-bp1bcsu5leotddp****",
          "タグ" : {
            "タグ" : [ {
              "値" : "i-bp1emqgxsg88zdl ****" 、
              "Key" : "acs:ecs:createFrom"
            } ]
          }
        } ]
      }
    } ]
  }
}

エラーコード

HTTP ステータスコード エラーコード エラーメッセージ 説明
403 InvalidStatus.ValueNotSupported %s リソースの現在のステータスで該当の操作がサポートされていない場合に返されるエラーメッセージ。

エラーコードリストについては、「API エラーセンター」をご参照ください。