CreateInstanceSnapshot によるインスタンススナップショットの作成 - PAI

インスタンススナップショットを作成します。

今すぐお試しください

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

create

*All Resource

*

なし

リクエスト構文

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

パスパラメーター

パラメーター	型	必須 / 任意	説明	例
InstanceId	string	必須	インスタンス ID。インスタンス ID の取得方法については、「ListInstances」をご参照ください。	dsw-730xxxxxxxxxx

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
body	object	任意	インスタンススナップショットのプロパティ。
SnapshotName	string	必須	インスタンススナップショットの名前。名前には、小文字、数字、ハイフン (-) のみを含めることができます。これは、カスタムイメージの表示名および ACR のイメージバージョン名として使用されます。	snapshot-v1
SnapshotDescription	string	任意	インスタンススナップショットの説明。	snapshot-v1
ImageUrl	string	必須	イメージ URL。イメージ URL の取得方法については、「ListImages」をご参照ください。	registry.cn-shanghai.aliyuncs.com/test/example:snapshot-v1
Labels	array<object>	任意	カスタムタグ。	{'foo': 'bar'}
	object	任意	カスタムタグのキーと値のペア。
Key	string	任意	カスタムタグのキー。	stsTokenOwner
Value	string	任意	カスタムタグの値。	123xxxxxxxx
ExcludePaths	array	任意	除外するファイルパスのリスト。このパラメーターは ECI インスタンスでのみサポートされています。イメージを作成する際に、指定されたフォルダーまたはファイルを無視するために使用されます。
	string	任意
Overwrite	boolean	任意	イメージリポジトリ内の既存のイメージタグを上書きするかどうかを指定します。

レスポンスフィールド

フィールド	型	説明	例
	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

例

成功レスポンス

JSONJSON

{
  "RequestId": "E7D55162-4489-1619-AAF5-3F97D5FCA948",
  "Success": true,
  "Message": "\"XXX\"",
  "Code": "null",
  "HttpStatusCode": 0,
  "InstanceId": "dsw-730xxxxxxxxxx",
  "SnapshotId": "snp-05cexxxxxxxxx"
}

エラーコード

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

変更履歴

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