AddImage API によるカスタムイメージ追加とワークロードデプロイ - E-HPC Instant

カスタムイメージを追加します。

今すぐお試しください

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

アクション

アクセスレベル

リソースタイプ

条件キー

依存アクション

ehpc:AddImage

create

*All Resource

*

なし

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
ImageType	string	任意	イメージの種類です。有効な値は以下のとおりです。 VM：仮想マシンイメージ。 Container：コンテナイメージ。	VM
Name	string	必須	カスタムイメージの名前です。	app-image
ImageVersion	string	任意	イメージのバージョンです。	V1.0
Description	string	任意	イメージの説明です。	Test image
ContainerImageSpec	object	任意	コンテナイメージの構成です。
RegistryUrl	string	任意	コンテナイメージのエンドポイントです。	registry-vpc.cn-hangzhou.aliyuncs.com/ehpc_open/nginx:latest
IsACRRegistry	boolean	任意	Alibaba Cloud のイメージリポジトリであるかどうかを示します。 True False	True
IsACREnterprise	boolean	任意	インスタンスが Container Registry Enterprise Edition であるかどうかを示します。 True False	True
RegistryCriId	string	任意	Container Registry Enterprise Edition イメージリポジトリの ID です。	cri-xyz795ygf8k9****
RegistryCredential	object	任意	プライベートイメージリポジトリの認証情報です。
Server	string	任意	イメージリポジトリの登録済みアドレスです。	registry-vpc.cn-hangzhou.aliyuncs.com
UserName	string	任意	ログインユーザーのユーザー名です。	username
Password	string	任意	ログインユーザーのパスワードです。	userpassword
VMImageSpec	object	任意	仮想マシンのイメージ構成です。
ImageId	string	任意	イメージ ID です。	m-bp1akkkr1rkxtb******

レスポンスフィールド

フィールド	型	説明	例
	object	応答のスキーマです。
RequestId	string	リクエスト ID です。	04F0F334-1335-436C-A1D7-6C044FE73368
Success	boolean	リクエストが成功したかどうかを示します。有効な値は以下のとおりです。 true false	True
ImageId	string	イメージ ID です。	m-bp1akkkr1rkxtb******

例

成功レスポンス

JSONJSON

{
  "RequestId": "04F0F334-1335-436C-A1D7-6C044FE73368\n",
  "Success": true,
  "ImageId": "m-bp1akkkr1rkxtb******\n"
}

エラーコード

HTTP ステータスコード	エラーコード	エラーメッセージ
400	InvalidParams	The specified parameter %s is invalid.
400	ImageAlreadyExists	The image id already exists.
400	InDebt	Your account has overdue payments.
400	NotEnabled	You have not enabled this service.
403	ImageInUse	Image is still used by jobs.
404	ImageNotFound	The specified image does not exist.
503	ServiceUnavailable	The request has failed due to a temporary failure of the server.
406	EcsError	An error occurred while calling the ECS API operation.
406	AliyunError	An Alibaba Cloud product error occurred.
406	DbError	A database error occurred.
407	NotAuthorized	No authorization is granted.

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

変更履歴

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