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

ENS:DescribeSnapshots

最終更新日:Jun 11, 2026

DescribeSnapshots を呼び出して、スナップショット情報を取得します。

今すぐお試しください

この 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 ロールに付与する必要があります。

アクション

アクセスレベル

リソースタイプ

条件キー

依存アクション

ens:DescribeSnapshots

list

*All Resource

*

なし なし

リクエストパラメーター

パラメーター

必須 / 任意

説明

EnsRegionId

string

任意

ENS ノードの ID です。DescribeEnsRegions を呼び出して ENS ノード ID をクエリできます。

cn-hangzhou

DiskId

string

任意

クラウドディスクの ID です。

d-bp67acfmxazb4p****

SnapshotId

string

任意

単一のスナップショット ID、または最大 100 個のスナップショット ID を含む JSON 配列です。

sp-bp67acfmxazb4p****

EnsRegionIds

string

任意

1~100 個の ENS ノード ID を含む JSON 配列です。

["cn-suzhou-telecom","cn-chengdu-telecom"]

SnapshotName

string

任意

スナップショットの表示名です。名前の長さは 2~128 文字である必要があります。英字または漢字で始まり、http:// または https:// で始めることはできません。数字、コロン (:)、アンダースコア (_)、ハイフン (-) を含めることができます。

testSnapshotName

InstanceId

string

任意

インスタンスの ID です。

i-bp67acfmxazb4p****

PageNumber

integer

任意

ページ番号です。

1

PageSize

integer

任意

1 ページあたりのエントリ数です。

10

レスポンスフィールド

フィールド

説明

object

レスポンススキーマです。

Snapshots

array<object>

スナップショットの詳細リストです。

object

SnapshotId

string

スナップショット ID です。

s-bp67acfmxazb4p****

CreationTime

string

スナップショットの作成時刻です。時刻は UTC で、yyyy-MM-ddTHH:mm:ssZ フォーマットです。

2020-08-20 14:52:28

Status

string

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

  • creating: スナップショットを作成中です。

  • available: スナップショットを利用できます。

  • deleting: スナップショットを削除中です。

  • error: スナップショットの作成に失敗しました。

available

Size

string

ディスクの容量です。単位: MiB。

40

SourceDiskId

string

ソースディスクの ID です。このパラメーターは、ソースディスクが解放された後も保持されます。

d-bp67acfmxazb4ph****

SourceDiskType

string

ディスクの属性です。有効な値:

  • 1: システムディスク。

  • 2: データディスク。

1

SourceDiskCategory

string

ディスクのカテゴリです。有効な値:

  • cloud_efficiency: ウルトラディスク。

  • cloud_ssd: 標準 SSD。

  • local_hdd: ローカル HDD。

  • local_ssd: ローカル SSD。

cloud_efficiency

SnapshotName

string

スナップショットの名前です。このパラメーターは、スナップショットの作成時に名前が指定された場合にのみ返されます。

testSnapshotName

Description

string

説明です。

testDescription

EnsRegionId

string

Edge Node Service (ENS) ノードの ID です。

cn-beijing-15

SourceSnapshotId

string

ソーススナップショットの ID です。

s-bpdfer893jfkdqe****

SourceEnsRegionId

string

ソース ENS ノードの ID です。

cn-hangzhou-27

SnapshotType

string

PageNumber

integer

返されるページ番号です。

1

PageSize

integer

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

10

TotalCount

integer

スナップショットの総数です。

1

RequestId

string

リクエスト ID です。

9635ED2E-3103-1606-84D4-9F8E816B19F9

成功レスポンス

JSONJSON

{
  "Snapshots": [
    {
      "SnapshotId": "s-bp67acfmxazb4p****",
      "CreationTime": "2020-08-20 14:52:28",
      "Status": "available",
      "Size": "40",
      "SourceDiskId": "d-bp67acfmxazb4ph****",
      "SourceDiskType": "1",
      "SourceDiskCategory": "cloud_efficiency",
      "SnapshotName": "testSnapshotName",
      "Description": "testDescription",
      "EnsRegionId": "cn-beijing-15",
      "SourceSnapshotId": "s-bpdfer893jfkdqe****",
      "SourceEnsRegionId": "cn-hangzhou-27",
      "SnapshotType": ""
    }
  ],
  "PageNumber": 1,
  "PageSize": 10,
  "TotalCount": 1,
  "RequestId": "9635ED2E-3103-1606-84D4-9F8E816B19F9"
}

エラーコード

HTTP ステータスコード

エラーコード

エラーメッセージ

説明

400 MissingParameter The input parameter that is mandatory for processing this request is not supplied.
400 InstanceIdNotFound The input parameter instancdId that is not found.
400 NoPermission Permission denied.
400 CallInterface Call Interface Happen Error.
400 InvalidParameter.%s The specified field %s invalid. Please check it again.

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

変更履歴

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