GetInstanceSnapshot API の呼び出し - PAI

GetInstanceSnapshot 操作を呼び出して、インスタンススナップショットを取得します。

今すぐお試しください

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

get

*All Resource

*

なし

リクエスト構文

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

パスパラメーター

パラメーター	型	必須 / 任意	説明	例
InstanceId	string	必須	インスタンス ID。詳細については、「ListInstances」をご参照ください。	dsw-730xxxxxxxxxx
SnapshotId	string	必須	インスタンススナップショット ID。詳細については、「ListInstanceSnapshot」をご参照ください。	snp-05cexxxxxxxxx

リクエストパラメーター

パラメーター

型

必須 / 任意

説明

例

リクエストパラメーターは必要ありません。

レスポンスフィールド

フィールド	型	説明	例
	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
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 インスタンスでのみサポートされており、イメージが作成されるときに指定されたフォルダまたはファイルを無視するために使用されます。
	string

例

成功レスポンス

JSONJSON

{
  "RequestId": "E7D55162-4489-1619-AAF5-3F97D5FCA948",
  "Success": true,
  "Message": "\"XXX\"",
  "Code": "null",
  "HttpStatusCode": 0,
  "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": [
    ""
  ]
}

エラーコード

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

変更履歴

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