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

Platform For AI:ListInstanceSnapshot

最終更新日:Mar 13, 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 ロールに付与する必要があります。

アクション

アクセスレベル

リソースタイプ

条件キー

依存アクション

paidsw:ListInstanceSnapshot

get

*All Resource

*

なし なし

リクエスト構文

GET /api/v2/instances/{InstanceId}/snapshots HTTP/1.1

パスパラメータ

パラメーター

必須 / 任意

説明

InstanceId

string

必須

インスタンス ID。詳細については、「ListInstances」をご参照ください。

dsw-730xxxxxxxxxx

リクエストパラメーター

パラメーター

必須 / 任意

説明

PageNumber

integer

任意

ページ番号。値は 1 以上である必要があります。デフォルト値は 1 です。

1

PageSize

integer

任意

各ページで返されるインスタンススナップショットの数。デフォルト値は 10 です。

10

SortBy

string

任意

結果をソートするフィールド。値を gmtCreate に設定します。

gmtCreate

Order

string

任意

ソート順。有効な値:

  • Desc: 結果を降順でソートします。

  • Asc: 結果を昇順でソートします。

DESC

レスポンスフィールド

フィールド

説明

object

インスタンススナップショットのリスト。

RequestId

string

リクエスト ID。

E7D55162-4489-1619-AAF5-3F97D5FCA948

Success

boolean

リクエストが成功したかどうかを示します。有効な値:

  • true

  • false

true

Message

string

応答メッセージ。

"XXX"

Code

string

状態コード。有効な値:

  • InternalError: 内部エラーが発生しました。これには、パラメーター検証エラーを除くすべてのエラーが含まれます。

  • ValidationError: パラメーター検証エラーが発生しました。

null

HttpStatusCode

integer

HTTP ステータスコード。有効な値:

  • 400

  • 404

null

TotalCount

integer

インスタンスの総数。

35

Snapshots

array<object>

現在のページに表示されるインスタンススナップショットのリスト。

array<object>

インスタンススナップショットオブジェクト。

InstanceId

string

インスタンス ID。

dsw-730xxxxxxxxxx

SnapshotId

string

インスタンススナップショット ID。

snp-05cexxxxxxxxx

SnapshotName

string

インスタンススナップショットの名前。

training_data_env

Status

string

インスタンススナップショットのステータスです。

Pushing

ImageId

string

インスタンススナップショットのイメージ ID です。

image-05cefd0be2exxxx

ImageUrl

string

インスタンススナップショット用のイメージの URL です。

registry.cn-shanghai.aliyuncs.com/pai_product/tensorflow:py36_cpu_tf1.12_ubuntu

ReasonCode

string

インスタンススナップショットのエラーコード。

Internal Error

ReasonMessage

string

インスタンススナップショットのエラーメッセージです。

ImagePullBackOff

GmtCreateTime

string

インスタンススナップショットが作成された時間です。

2021-01-12T14:36:01Z

GmtModifiedTime

string

インスタンススナップショットが最後に更新された時刻です。

2021-01-12T14:36:01Z

Labels

array<object>

カスタムタグ。

{'foo': 'bar'}

object

カスタムタグのキーと値のペア。

Key

string

カスタムタグのキーです。

stsTokenOwner

Value

string

カスタムタグの値です。

123xxxxxxxx

ExcludePaths

array

除外するファイルパスのリスト。このパラメーターは ECI インスタンスでのみサポートされています。イメージを作成する際に、指定されたフォルダーまたはファイルを無視するために使用されます。

["/path1","/path2"]

string

成功レスポンス

JSONJSON

{
  "RequestId": "E7D55162-4489-1619-AAF5-3F97D5FCA948",
  "Success": true,
  "Message": "\"XXX\"",
  "Code": "null",
  "HttpStatusCode": 0,
  "TotalCount": 35,
  "Snapshots": [
    {
      "InstanceId": "dsw-730xxxxxxxxxx",
      "SnapshotId": "snp-05cexxxxxxxxx",
      "SnapshotName": "training_data_env",
      "Status": "Pushing",
      "ImageId": "image-05cefd0be2exxxx",
      "ImageUrl": "registry.cn-shanghai.aliyuncs.com/pai_product/tensorflow:py36_cpu_tf1.12_ubuntu",
      "ReasonCode": "Internal Error",
      "ReasonMessage": "ImagePullBackOff",
      "GmtCreateTime": "2021-01-12T14:36:01Z",
      "GmtModifiedTime": "2021-01-12T14:36:01Z",
      "Labels": [
        {
          "Key": "stsTokenOwner",
          "Value": "123xxxxxxxx"
        }
      ],
      "ExcludePaths": [
        ""
      ]
    }
  ]
}

エラーコード

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

変更履歴

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