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

インスタンスを作成します。

操作説明

1 つのアカウントで、この操作は 1 秒あたり最大 10 回まで呼び出すことができます。
インスタンスの作成は非同期操作であるため、リクエスト時間を長くすることを推奨します。API オペレーションのリターンコードが 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。有効値：20 および 40。値はイメージのサイズより小さくすることはできず、10 GiB の倍数である必要があります。	40
Quantity	string	必須	インスタンスの数。	1
DataDisk.1.Size	string	任意	最初のデータディスクの容量。単位：GiB。容量は 20 GiB 以上で、10 GiB の倍数である必要があります。	50
InternetChargeType	string	任意	初めてインスタンスを作成する場合、このパラメーターは必須です。すでにインスタンスを作成している場合は、デフォルトで既存の課金方法が使用されます。有効値： BandwidthByDay：日次ピーク帯域幅による支払い。 95BandwidthByMonth：月次 95 パーセンタイル帯域幅による支払い。	95BandwidthByMonth
AutoRenewPeriod	string	任意	インスタンスの自動更新期間。このパラメーターは、AutoRenew パラメーターが True に設定されている場合に必須です。有効値：1～12。単位：月。	12
AutoRenew	string	任意	自動更新機能を有効にするかどうかを指定します。有効値：True および False。デフォルト値：False。	True
IpType	string	任意	IP アドレスのタイプ。有効値： ipv4 (デフォルト) ipv6 ipv4Andipv6	ipv4
KeyPairName	string	任意	キーペアの名前。名前は 1 つだけ指定できます。	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 アドレス。このパラメーターを指定する場合は、vSwitch ID を指定する必要があります。vSwitch は事前に作成しておく必要があります。そうでない場合、エラーが返されます。	10.10.10.10
PaymentType	string	任意	インスタンスの課金方法。値を Subscription に設定します。	Subscription
InstanceName	string	任意	インスタンスの名前。名前は、次の命名規則に準拠する必要があります。長さは 2～128 文字である必要があります。先頭は英字である必要がありますが、http:// または https:// で始めることはできません。名前には、英字、数字、コロン (:)、アンダースコア (_)、ピリオド (.)、ハイフン (-) を使用できます。このパラメーターを指定しない場合、デフォルトでインスタンス ID がインスタンス名として使用されます。	test：Instance_Name.1-2
HostName	string	任意	Elastic Compute Service (ECS) インスタンスのホスト名。一般的な命名規則：ホスト名はピリオド (.) またはハイフン (-) で開始または終了することはできません。連続するピリオド (.) またはハイフン (-) を含めることはできません。特定のインスタンスの命名規則： Windows インスタンスの場合、ホスト名は 2～15 文字で、ピリオド (.) を含めたり、数字のみで構成したりすることはできません。ホスト名はピリオド (.) を含めたり、数字のみで構成したりすることはできません。 Linux などの他のオペレーティングシステムを実行するインスタンスの場合、ホスト名は 2～64 文字である必要があります。ピリオド (.) を使用してホスト名を複数のセグメントに分割できます。各セグメントには、英字、数字、ハイフン (-) を含めることができます。	test-HostName
UniqueSuffix	boolean	任意	HostName パラメーターで指定されたホスト名と InstanceName パラメーターで指定されたインスタンス名に、逐次サフィックスを自動的に追加するかどうかを指定します。逐次サフィックスの範囲は 001～999 です。例：LocalHost001 と LocalHost002、および MyInstance001 と MyInstance002。デフォルト値：false。	false
PublicIpIdentification	boolean	任意	指定されたインスタンスにパブリック IP アドレスを割り当てることができるかどうかを指定します。有効値： true false	true
PasswordInherit	boolean	任意	イメージのプリセットパスワードを使用するかどうかを指定します。有効値： true：イメージにプリセットされたパスワードが使用されます。この場合、Password パラメーターは null である必要があります。安全なアクセスを確保するために、選択したイメージにパスワードが設定されていることを確認してください。 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 を使用してこの操作を呼び出す場合、戻り値は整数型です。一般的なメソッドまたは HTTP リクエストを使用してこの操作を呼び出す場合、戻り値は文字列型です。	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.

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

変更履歴

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