CreateInstance によるインスタンス作成 - ENS - Alibaba Cloud - ENS

サブスクリプションインスタンスを作成します。この操作は RunInstances に置き換えることができます。CreateInstance に新しい特徴は追加されません。

操作説明

ユーザーごとの呼び出し周波数: 1 秒あたり 10 回。
インスタンスの作成は非同期操作であるため、必要に応じてリクエストのタイムアウトを延長してください。API が Code=0 を返すのは、リクエストが成功したことを示すだけであり、インスタンスが正常に作成されたことを示すものではありません。リクエストが成功すると、インスタンス ID が返されます。その後、その ID でインスタンスをクエリし、インスタンスが作成されたかどうかを確認できます。
InvalidUserData.NotInWhiteList の制限: 購入権限を持つ関連ホワイトリストに追加されたアカウントのみがインスタンスを作成できます。それ以外の場合はエラーが返されます。

今すぐお試しください

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

create

*Instance。

acs:ens:*:{#accountId}:instance/*

なし

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
InstanceType	string	必須	インスタンスタイプ。インスタンスタイプの詳細については、「使用制限」を参照してください。	ens.se1.tiny
EnsRegionId	string	必須	リージョン ID。	cn-hangzhou
Password	string	任意	インスタンスのパスワード。パスワードの長さは 8～30 文字で、大文字、小文字、数字、特殊文字のうち少なくとも 3 種類を含む必要があります。サポートされている特殊文字は以下の通りです: ()`~!@#$%^&*-_+=\|{}[]:;'<>,.?/	yourPassword:1
Period	string	必須	サブスクリプション期間。有効な値: 1～9 および 12。単位: 月。	12
ImageId	string	任意	インスタンスの起動に使用するイメージの ID。	yourImage ID
SystemDisk.Size	string	任意	システムクラウドディスクのサイズ。単位: GiB。値は 10 の倍数である必要があり、イメージサイズより小さくすることはできません。有効値については、DescribeAvailableResourceInfo が返す SystemDiskMinSize および SystemDiskMaxSize の値を参照してください。20 GiB および 40 GiB は一般的な設定であり、これらの 2 つの値のみがサポートされていることを示すものではありません。	40
Quantity	string	必須	インスタンスの数。	1
DataDisk.1.Size	string	任意	最初のデータクラウドディスクのサイズ。単位: GiB。サイズは 20 GiB 以上で、10 の倍数である必要があります。	50
InternetChargeType	string	任意	このパラメーターは、インスタンスを初めて作成する際に必須です。すでにインスタンスリソースがある場合は、デフォルトで既存の課金方法が使用されます。有効な値: BandwidthByDay: 日次ピーク帯域幅。 95BandwidthByMonth: 月間 95 パーセンタイル帯域幅。	95BandwidthByMonth
AutoRenewPeriod	string	任意	自動更新期間。このパラメーターは、AutoRenew が True に設定されている場合に必須です。有効な値: 1～12。単位: 月。	12
AutoRenew	string	任意	自動更新を有効にするかどうかを指定します。有効な値: True \| False (デフォルト)。	True
IpType	string	任意	IP タイプ。有効な値: ipv4 (デフォルト): IPv4。 ipv6: IPv6。 ipv4Andipv6: IPv4 および IPv6。列挙値: ipv4 : IPv4 ipv6 : IPv6 ipv4Andipv6 : IPv4 および IPv6	ipv4
KeyPairName	string	任意	キーペアの名前。単一の名前のみがサポートされています。	TestKeyPairName
UserData	string	任意	カスタムデータ。データは `#!` で始まる必要があります。最大長は 256 文字、最大値は 16 KB です。カスタムデータスクリプトのみがサポートされています。InstanceMetaData のレンダリングはサポートされていません。 Base64 エンコードされたカスタムデータを渡すことができます。API を呼び出してリクエストを開始する際、指定したカスタムデータは暗号化されません。パスワードや非公開キーなどの機密情報をプレーンテキストで渡さないでください。パスワードや非公開キーを渡す必要がある場合は、まずコンテンツを暗号化してから Base64 エンコードして渡してください。インスタンス内でも同様の方法でコンテンツを復号してください。詳細については、「データフォーマット」を参照してください。	#!/bin/sh echo "Hello World. The time is now $(date -R)!" \| tee /home/output.txt
VSwitchId	string	任意	vSwitch の ID。	YourVSwitchId
PrivateIpAddress	string	任意	非公開 IP アドレス。非公開 IP アドレスを指定する場合は、VSwitchId パラメーターも指定する必要があります。vSwitch は事前に作成しておく必要があります。そうでない場合はエラーが返されます。	10.10.10.10
PaymentType	string	任意	支払方法。現在、これは Subscription (サブスクリプションインスタンス) の固定値です。変更はサポートされていません。列挙値: Subscription : サブスクリプション。	Subscription
InstanceName	string	任意	インスタンスの名前。命名規則: 名前の長さは 2～128 文字で、英字および漢字を含めることができます。名前は大文字、小文字、または漢字で始める必要があります。http:// または https:// で始めることはできません。名前には数字、コロン (:)、アンダースコア (_)、ピリオド (.)、ハイフン (-) を含めることができます。このパラメーターが指定されていない場合、デフォルト値はインスタンスの InstanceId です。	test：Instance_Name.1-2
HostName	string	任意	インスタンスのホスト名。一般的な命名規則: ピリオド (.) およびハイフン (-) を最初または最後の文字として使用することはできず、連続して使用することもできません。特定の命名規則: Windows インスタンス: ホスト名の長さは 2～15 文字である必要があります。ピリオド (.) はサポートされていません。ホスト名をすべて数字にすることはできません。大文字、小文字、数字、ハイフン (-) が使用できます。その他のインスタンス (Linux など): ホスト名の長さは 2～64 文字である必要があります。複数のピリオド (.) がサポートされています。ピリオドで区切られた各セグメントには、大文字、小文字、数字、ハイフン (-) を含めることができます。	test-HostName
UniqueSuffix	boolean	任意	HostName および InstanceName に連番のサフィックスを追加するかどうかを指定します。連番のサフィックスは 001 から始まり、999 を超えることはできません。例: LocalHost001、LocalHost002、MyInstance001、MyInstance002。デフォルト値: false。	false
PublicIpIdentification	boolean	任意	指定されたインスタンスにパブリック IP アドレスを割り当てることができるかどうかを指定します。有効な値: true (デフォルト): パブリック IP アドレスを割り当てることができます。 false: パブリック IP アドレスを割り当てることはできません。	true
PasswordInherit	boolean	任意	イメージのプリセットパスワードを使用するかどうかを指定します。有効な値: true: イメージのプリセットパスワードが使用されます。Password パラメーターは空である必要があり、イメージにプリセットパスワードが設定されていることを確認する必要があります。 false: イメージのプリセットパスワードは使用されません。	false

レスポンスフィールド

フィールド	型	説明	例
	object
RequestId	string	リクエスト ID。	4A431388-2D4B-46F4-A96B-D4E6BD0688C1
InstanceIds	object
InstanceId	array	インスタンス ID のリスト。
	string	インスタンス ID のリスト。	[i-7ecpqvkicnchxccozrp**,i-6ecpqvkicnchxccozrp**]
Code	integer	リターンコード。値が 0 の場合は成功を示します。説明 SDK を使用してこの API オペレーションを呼び出す場合、戻り値の型は Integer です。共通メソッドまたは HTTP を使用してこの API オペレーションを呼び出す場合、戻り値の型は String です。	0

例

成功レスポンス

JSONJSON

{
  "RequestId": "4A431388-2D4B-46F4-A96B-D4E6BD0688C1",
  "InstanceIds": {
    "InstanceId": [
      "[i-7ecpqvkicnchxccozrp****,i-6ecpqvkicnchxccozrp****]"
    ]
  },
  "Code": 0
}

エラーコード

HTTP ステータスコード	エラーコード	エラーメッセージ
400	StockNotEnough	The specified instance type has insufficient resource.
400	InvalidUserData.NotInWhiteList	The specified user is not authroized to perform this operation.
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	The input parameter is Invalid.
400	InvalidParameter.%s	The specified field %s invalid. Please check it again.
400	InvalidDiskSize.ValueNotSupported	The specified disk capacity is invalid. Specify another capacity and try again.
400	InvalidParameter.Bandwidth	The specified parameter InternetChargeType is not valid.
400	InvalidParameter.Image	The specified image does not support.
400	InvalidParameter.InstanceType	The specified parameter InstanceType is not valid.
400	InvalidAccountStatus.NotEnoughBalance	Your account does not have enough balance.
400	unsupported_Ipv6Feature	This ensregion does not support creating instance of the IPv6 type. Select another type.
400	Forbidden.CreateInstance	The user is not in the Goods whitelist of creating instance interface.
400	ENS_OperationUnsupported_KeyPairName	The KeyPairNameis not available or image not support ssh key.
400	ENS_DependencyViolation_WindowsInstance	The instance creating is window, only user password to login.
400	ENS_PASSWORDORKEYPAIRNAME_MODULE_NOT_CHOOSEN	The required module pwd or keyPairName is not inputed
400	InvalidPrivateIpAddress	Specified private IP address is not in the CIDR block of virtual switch.
400	InvalidVSwitchId.NotFound	Specified virtual switch does not exist.
400	InvalidPrivateIpAddress.Duplicated	Specified private IP address is duplicated.
400	InvalidPasswordParam.Mismatch	The input password should be null when passwordInherit is true.

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

変更履歴

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