自動プロビジョニンググループを作成します。
操作説明
自動プロビジョニングは、スポットインスタンスと従量課金インスタンスを使用してインスタンスクラスターを迅速にデプロイするソリューションです。支払い方法、ゾーン、インスタンスファミリーをまたいだインスタンスクラスターのワンクリックデプロイをサポートします。詳細については、自動プロビジョニンググループ API を使用して ECS インスタンスをバッチ作成するを参照してください。
自動プロビジョニングは、プロビジョニンググループを使用してコンピューティングリソースをスケジュールおよび維持します。自動プロビジョニンググループを使用して、安定的にコンピューティング能力を提供し、スポットインスタンスの回収メカニズムによる不安定性を軽減できます。
自動プロビジョニングは無料の特徴ですが、自動プロビジョニンググループによって作成されたインスタンスリソースには課金されます。詳細については、スポットインスタンスの課金および従量課金を参照してください。
起動テンプレート (
LaunchTemplateId) と起動構成情報 (LaunchConfiguration.*) の両方を指定した場合、起動テンプレートが優先されます。
今すぐお試しください
テスト
RAM 認証
|
アクション |
アクセスレベル |
リソースタイプ |
条件キー |
依存アクション |
|
ecs:CreateAutoProvisioningGroup |
create |
*All Resource
|
なし |
|
リクエストパラメーター
|
パラメーター |
型 |
必須 / 任意 |
説明 |
例 |
| RegionId |
string |
必須 |
自動プロビジョニンググループが存在するリージョンの ID。 DescribeRegions を呼び出して最新のリージョンリストをクエリできます。 |
cn-hangzhou |
| ResourceGroupId |
string |
任意 |
自動プロビジョニンググループが属するリソースグループの ID。 |
rg-bp67acfmxazb4p**** |
| AutoProvisioningGroupName |
string |
任意 |
自動プロビジョニンググループの名前。名前は 2~128 文字で、英字または中国語文字で始まる必要があり、 |
apg-test |
| AutoProvisioningGroupType |
string |
任意 |
自動プロビジョニンググループの配信タイプ。有効な値:
デフォルト値: maintain。 |
maintain |
| SpotAllocationStrategy |
string |
任意 |
スポットインスタンスの作成ポリシー。有効な値:
デフォルト値: lowest-price。 |
diversified |
| SpotInstanceInterruptionBehavior |
string |
任意 |
スポットインスタンスが中断された場合に実行する操作。有効な値:
デフォルト値: terminate。 |
terminate |
| SpotInstancePoolsToUseCount |
integer |
任意 |
有効な値: |
2 |
| PayAsYouGoAllocationStrategy |
string |
任意 |
従量課金インスタンスの作成ポリシー。有効な値:
デフォルト値: lowest-price。 |
prioritized |
| ExcessCapacityTerminationPolicy |
string |
任意 |
自動プロビジョニンググループのリアルタイム容量がターゲット容量を超え、スケールインイベントがトリガーされた場合にインスタンスをリリースするかどうかを指定します。有効な値:
デフォルト値: no-termination。 |
termination |
| ValidFrom |
string |
任意 |
自動プロビジョニンググループが開始される時間。 ISO 8601 標準の yyyy-MM-ddTHH:mm:ssZ 初期化で時間を指定します。時間は協定世界時 (UTC) である必要があります。 デフォルト値: リクエストが即座に有効になる UNIX タイムスタンプ。 |
2019-04-01T15:10:20Z |
| ValidUntil |
string |
任意 |
自動プロビジョニンググループが期限切れになる時間。 ISO 8601 標準の yyyy-MM-ddTHH:mm:ssZ 初期化で時間を指定します。時間は協定世界時 (UTC) である必要があります。 デフォルト値: 2099-12-31T23:59:59Z。 |
2019-06-01T15:10:20Z |
| TerminateInstancesWithExpiration |
boolean |
任意 |
自動プロビジョニンググループの期限切れ時にインスタンスをリリースするかどうかを指定します。有効な値:
デフォルト値: false。 |
true |
| TerminateInstances |
boolean |
任意 |
自動プロビジョニンググループの削除時にインスタンスをリリースするかどうかを指定します。有効な値:
デフォルト値: false。 |
true |
| MaxSpotPrice |
number |
任意 |
自動プロビジョニンググループにおけるスポットインスタンスの最大価格。 説明
|
2 |
| TotalTargetCapacity |
string |
必須 |
自動プロビジョニンググループの合計ターゲット容量。有効な値: 正の整数。 合計容量は、 |
60 |
| PayAsYouGoTargetCapacity |
string |
任意 |
自動プロビジョニンググループにおける従量課金インスタンスのターゲット容量。有効な値: |
30 |
| SpotTargetCapacity |
string |
任意 |
自動プロビジョニンググループにおけるスポットインスタンスのターゲット容量。有効な値: |
20 |
| DefaultTargetCapacityType |
string |
任意 |
デフォルト値: Spot。 |
Spot |
| LaunchTemplateId |
string |
任意 |
自動プロビジョニンググループに関連付けられたインスタンス起動テンプレートの ID。 DescribeLaunchTemplates を呼び出してアクティブなインスタンス起動テンプレートをクエリできます。起動テンプレートと起動構成情報 ( |
lt-bp1fgzds4bdogu03**** |
| LaunchTemplateVersion |
string |
任意 |
自動プロビジョニンググループに関連付けられたインスタンス起動テンプレートのバージョン。 DescribeLaunchTemplateVersions を呼び出してアクティブなインスタンス起動テンプレートバージョンをクエリできます。 デフォルト値: 起動テンプレートのデフォルトバージョン。 |
1 |
| Description |
string |
任意 |
自動プロビジョニンググループの説明。 |
testDescription |
| ClientToken |
string |
任意 |
リクエストのべき等性を確保するために使用されるクライアントトークン。クライアントを使用してトークンを生成できますが、異なるリクエスト間でトークンが一意であることを確認してください。トークンには ASCII 文字のみを含めることができ、64 文字を超えることはできません。詳細については、べき等性を確保する方法を参照してください。 |
0c593ea1-3bea-11e9-b96b-88e9fe637760 |
| LaunchConfiguration.ImageId |
string |
任意 |
インスタンスの起動に使用されるイメージの ID。 DescribeImages を呼び出して利用可能なイメージリソースをクエリできます。起動テンプレートと起動構成情報の両方を指定した場合、起動テンプレートが優先されます。 |
m-bp1g7004ksh0oeuc**** |
| LaunchConfiguration.SecurityGroupId |
string |
任意 |
インスタンスが属するセキュリティグループの ID。起動テンプレートと起動構成情報の両方を指定した場合、起動テンプレートが優先されます。 |
sg-bp15ed6xe1yxeycg**** |
| LaunchConfiguration.IoOptimized |
string |
任意 |
インスタンスが I/O 最適化インスタンスかどうかを指定します。有効な値:
廃止されたインスタンスタイプの場合、デフォルト値は none です。その他のインスタンスタイプの場合、デフォルト値は optimized です。 起動テンプレートと起動構成情報の両方を指定した場合、起動テンプレートが優先されます。 |
optimized |
| LaunchConfiguration.InternetChargeType |
string |
任意 |
ネットワーク使用量の課金方法。有効な値:
説明
トラフィック課金モードでは、ピークインバウンドおよびアウトバウンド帯域幅は、保証されたパフォーマンスメトリクスではなく帯域幅の上限として使用されます。リソースが競合する場合、ピーク帯域幅が制限される可能性があります。保証された帯域幅が必要な場合は、帯域幅課金を使用してください。 起動テンプレートと起動構成情報の両方を指定した場合、起動テンプレートが優先されます。 |
PayByTraffic |
| LaunchConfiguration.InternetMaxBandwidthIn |
integer |
任意 |
最大インバウンドパブリック帯域幅。単位: Mbit/s。有効な値:
起動テンプレートと起動構成情報の両方を指定した場合、起動テンプレートが優先されます。 |
10 |
| LaunchConfiguration.InternetMaxBandwidthOut |
integer |
任意 |
最大アウトバウンドパブリック帯域幅。単位: Mbit/s。有効な値: 0~100。 デフォルト値: 0。 起動テンプレートと起動構成情報の両方を指定した場合、起動テンプレートが優先されます。 |
10 |
| LaunchConfiguration.InstanceName |
string |
任意 |
インスタンスの名前。名前は 2~128 文字で、英字または中国語文字で始まる必要があり、 デフォルト値: インスタンスの 複数の ECS インスタンスを作成する場合、連番のインスタンス名をバッチ構成できます。詳細については、複数インスタンスの連番名またはホスト名をバッチ構成するを参照してください。 起動テンプレートと起動構成情報の両方を指定した場合、起動テンプレートが優先されます。 |
k8s-node-[1,4]-alibabacloud |
| LaunchConfiguration.HostName |
string |
任意 |
インスタンスのホスト名。以下の制限が適用されます:
|
k8s-node-[1,4]-ecshost |
| LaunchConfiguration.InstanceDescription |
string |
任意 |
インスタンスの説明。説明は 2~256 文字で、 |
Instance_Description |
| LaunchConfiguration.KeyPairName |
string |
任意 |
キーペアの名前。
起動テンプレートと起動構成情報の両方を指定した場合、起動テンプレートが優先されます。 |
KeyPair_Name |
| LaunchConfiguration.RamRoleName |
string |
任意 |
インスタンス RAM ロールの名前。RAM API ListRoles を呼び出して、作成済みのインスタンス RAM ロールをクエリできます。起動テンプレートと起動構成情報の両方を指定した場合、起動テンプレートが優先されます。 |
RAM_Name |
| LaunchConfiguration.SecurityEnhancementStrategy |
string |
任意 |
セキュリティ強化を有効にするかどうかを指定します。有効な値:
起動テンプレートと起動構成情報の両方を指定した場合、起動テンプレートが優先されます。 |
Active |
| LaunchConfiguration.UserData |
string |
任意 |
インスタンスのユーザーデータ。インスタンスユーザーデータは Base64 エンコードされている必要があります。生データの最大サイズは 32 KB です。起動テンプレートと起動構成情報の両方を指定した場合、起動テンプレートが優先されます。 |
ZWNobyBoZWxsbyBlY3Mh |
| LaunchConfiguration.SystemDiskCategory |
string |
任意 |
システムディスクのカテゴリ。有効な値:
I/O 最適化なしの廃止されたインスタンスタイプの場合、デフォルト値は cloud です。その他のインスタンスタイプの場合、デフォルト値は cloud_efficiency です。 起動テンプレートと起動構成情報の両方を指定した場合、起動テンプレートが優先されます。 |
cloud_ssd |
| LaunchConfiguration.SystemDiskSize |
integer |
任意 |
システムディスクのサイズ。単位: GiB。有効な値: 20~500。このパラメーターの値は max{20, LaunchConfiguration.ImageId で指定されたイメージのサイズ} 以上である必要があります。 デフォルト値: max{40, LaunchConfiguration.ImageId で指定されたイメージのサイズ}。 起動テンプレートと起動構成情報の両方を指定した場合、起動テンプレートが優先されます。 |
40 |
| LaunchConfiguration.SystemDiskName |
string |
任意 |
システムディスクの名前。名前は 2~128 文字で、英字または中国語文字で始まる必要があり、 デフォルト値: 空。 起動テンプレートと起動構成情報の両方を指定した場合、起動テンプレートが優先されます。 |
cloud_ssdSystem |
| LaunchConfiguration.SystemDiskDescription |
string |
任意 |
システムディスクの説明。説明は 2~256 文字で、 起動テンプレートと起動構成情報の両方を指定した場合、起動テンプレートが優先されます。 |
SystemDisk_Description |
| LaunchConfiguration.SystemDiskPerformanceLevel |
string |
任意 |
システムディスクとして使用される ESSD (エンタープライズ SSD) のパフォーマンスレベル (PL)。有効な値:
ESSD パフォーマンスレベルの選択方法については、 ESSD を参照してください。 起動テンプレートと起動構成情報の両方を指定した場合、起動テンプレートが優先されます。 |
PL0 |
| LaunchConfiguration.PasswordInherit |
boolean |
任意 |
イメージにプリセットされたパスワードを使用するかどうかを指定します。有効な値:
起動テンプレートと起動構成情報の両方を指定した場合、起動テンプレートが優先されます。 |
true |
| LaunchConfiguration.ResourceGroupId |
string |
任意 |
インスタンスが属するリソースグループの ID。起動テンプレートと起動構成情報の両方を指定した場合、起動テンプレートが優先されます。 |
rg-bp67acfmxazb4p**** |
| LaunchConfiguration.CreditSpecification |
string |
任意 |
バースト可能インスタンスの実行モード。有効な値:
デフォルト値: なし。 起動テンプレートと起動構成情報の両方を指定した場合、起動テンプレートが優先されます。 |
Standard |
| LaunchConfiguration.Password |
string |
任意 |
インスタンスのパスワード。パスワードは 8~30 文字で、大文字、小文字、数字、特殊文字のうち少なくとも 3 種類を含む必要があります。以下の特殊文字がサポートされています:
Windows インスタンスの場合、パスワードは転送スラッシュ (/) で始めることはできません。 起動テンプレートと起動構成情報の両方を指定した場合、起動テンプレートが優先されます。 |
EcsV587! |
| LaunchConfiguration.DeploymentSetId |
string |
任意 |
デプロイメントセットの ID。 |
ds-bp1frxuzdg87zh4p**** |
| LaunchTemplateConfig |
array<object> |
任意 |
拡張起動テンプレートのリスト。 |
|
|
object |
任意 |
拡張起動テンプレートの情報。 |
||
| VSwitchId |
string |
任意 |
拡張起動テンプレートの ECS インスタンスが接続される vSwitch の ID。拡張テンプレートから作成される ECS インスタンスのゾーンは vSwitch によって決定されます。 説明
LaunchTemplateConfig を指定する場合、LaunchTemplateConfig.N.VSwitchId は必須です。 |
vsw-sn5bsitu4lfzgc5o7**** |
| MaxPrice |
number |
任意 |
拡張起動テンプレートにおけるスポットインスタンスの最大価格。 説明
|
3 |
| Priority |
integer |
任意 |
拡張起動テンプレートの優先度。値 0 は最高の優先度を示します。有効な値: 0~+∞。 |
1 |
| InstanceType |
string |
任意 |
拡張起動テンプレートのインスタンスタイプ。N の有効な値: 1~20。有効な値については、インスタンスファミリーを参照してください。 |
ecs.g5.large |
| WeightedCapacity |
number |
任意 |
拡張起動テンプレートにおけるインスタンスタイプの重み。値が大きいほど、単一のインスタンスがより多くのコンピューティング能力要件を満たすことができ、必要なインスタンス数が減少します。有効な値: 0 より大きい値。 指定されたインスタンスタイプのコンピューティング能力とクラスター内のシングルノードの最小コンピューティング能力に基づいて重みを計算できます。たとえば、シングルノードの最小コンピューティング能力が 8 vCPU および 60 GiB の場合:
|
2 |
| MaxQuantity |
integer |
任意 |
説明
このパラメーターは招待プレビュー中であり、使用できません。 |
false |
| Cores |
array |
任意 |
インスタンスタイプの vCPU コア数のリスト。 |
|
|
integer |
任意 |
インスタンスタイプの vCPU コア数。要件を満たすインスタンスタイプをフィルターするために使用されます。詳細については、インスタンスファミリーを参照してください。N の有効な値: 1~10。 |
2 |
|
| Memories |
array |
任意 |
インスタンスタイプのメモリサイズのリスト。 |
|
|
number |
任意 |
インスタンスタイプのメモリサイズ。単位: GiB。要件を満たすインスタンスタイプをフィルターするために使用されます。詳細については、インスタンスファミリーを参照してください。N の有効な値: 1~10。 |
4 |
|
| InstanceFamilyLevel |
string |
任意 |
インスタンスファミリーのレベル。要件を満たすインスタンスタイプをフィルターするために使用されます。有効な値:
N の有効な値: 1~10。 [_single.params.LaunchTemplate |
EnterpriseLevel |
| ExcludedInstanceTypes |
array |
任意 |
除外するインスタンスタイプのリスト。 [ |
|
|
string |
任意 |
除外するインスタンスタイプ。ワイルドカード (*) を使用して、単一のインスタンスタイプまたはインスタンスファミリー全体を除外できます。例:
|
ecs.n1.small/ecs.n1.*/*7* |
|
| Architectures |
array |
任意 |
インスタンスタイプのアーキテクチャタイプのリスト。 |
|
|
string |
任意 |
インスタンスタイプのアーキテクチャタイプ。有効な値:
デフォルト値: すべてのアーキテクチャタイプを含みます。 |
X86 |
|
| BurstablePerformance |
string |
任意 |
バースト可能インスタンスタイプを含めるかどうかを指定します。有効な値:
デフォルト値: Include。 |
Include |
| ImageId |
string |
任意 |
イメージ ID。このパラメーターを使用して、現在のリソースプールのイメージをセットできます。セットしない場合、 |
aliyun_3_x64_20G_alibase_20210425.vhd |
| LaunchConfiguration.DataDisk |
array<object> |
任意 |
起動構成のデータディスク構成のリスト。 |
|
|
object |
任意 |
起動構成のデータディスク構成情報。 |
||
| PerformanceLevel |
string |
任意 |
データディスクとして使用される ESSD (エンタープライズ SSD) のパフォーマンスレベル。N の値は
|
PL1 |
| KmsKeyId |
string |
任意 |
The ID of the KMS key for the data disk. If both a launch template and launch configuration are specified, the launch template takes precedence. |
0e478b7a-4262-4802-b8cb-00d3fb40**** |
| Description |
string |
任意 |
The description of the data disk. The description must be 2 to 256 characters in length and cannot start with |
DataDisk_Description |
| SnapshotId |
string |
任意 |
The ID of the snapshot used to create data disk N. Valid values of N: 1 to 16. After you specify this parameter, the If you specify both a launch template and launch configuration information, the launch template takes precedence. |
s-bp17441ohwka0yuh**** |
| Size |
integer |
任意 |
The size of data disk N. Valid values of N: 1 to 16. Unit: GiB. Valid values:
説明
The value of this parameter must be greater than or equal to the size of the snapshot specified by If you specify both a launch template and launch configuration information, the launch template takes precedence. |
20 |
| Device |
string |
任意 |
The mount point of the data disk. If you specify both a launch template and launch configuration information, the launch template takes precedence. |
/dev/vd1 |
| DiskName |
string |
任意 |
The name of the data disk. The name must be 2 to 128 characters in length. It must start with a letter or a Chinese character and cannot start with Default value: empty. If you specify both a launch template and launch configuration information, the launch template takes precedence. |
cloud_ssdData |
| Category |
string |
任意 |
The category of data disk N. Valid values of N: 1 to 16. Valid values:
For I/O optimized instances, the default value is cloud_efficiency. For non-I/O optimized instances, the default value is cloud. If you specify both a launch template and launch configuration information, the launch template takes precedence. |
cloud_ssd |
| DeleteWithInstance |
boolean |
任意 |
Specifies whether the data disk is released when the instance is released. Valid values:
Default value: true. If you specify both a launch template and launch configuration information, the launch template takes precedence. |
true |
| Encrypted |
boolean |
任意 |
Specifies whether data disk N is encrypted. Valid values:
Default value: false. If you specify both a launch template and launch configuration information, the launch template takes precedence. |
false |
| EncryptAlgorithm |
string |
任意 |
説明
This parameter is not publicly available. |
null |
| ProvisionedIops |
integer |
任意 |
The provisioned read/write IOPS of the ESSD AutoPL disk. Valid values: 0 to min{50,000, 1000 × capacity - baseline performance}. Baseline performance = min{1,800 + 50 × capacity, 50,000}. 説明
This parameter is supported only when DiskCategory is set to cloud_auto. For more information, see ESSD AutoPL disks. |
40000 |
| BurstingEnabled |
boolean |
任意 |
Specifies whether to enable the performance burst feature. Valid values:
説明
This parameter is supported only when DiskCategory is set to cloud_auto. For more information, see ESSD AutoPL disks. |
false |
| AutoSnapshotPolicyId |
string |
任意 |
The ID of the automatic snapshot policy applied to the data disk. Note:
|
sp-bp67acfmxazb4p**** |
| LaunchConfiguration.Tag |
array<object> |
任意 |
The list of tags in the launch configuration. |
|
|
object |
任意 |
The tag information in the launch configuration. |
||
| Key |
string |
任意 |
The tag key of the instance. Valid values of N: 1 to 20. The tag key cannot be an empty string. It can be up to 128 characters in length and cannot start with aliyun or acs:. It cannot contain |
TestKey |
| Value |
string |
任意 |
The tag value of the instance. Valid values of N: 1 to 20. The tag value can be an empty string. It can be up to 128 characters in length and cannot start with acs:. It cannot contain |
TestValue |
| SystemDiskConfig |
array<object> |
任意 |
The list of system disk configurations. |
|
|
object |
任意 |
The system disk configuration information. |
||
| DiskCategory |
string |
任意 |
The category of the system disk. You can specify multiple candidate disk categories. The specified order determines the priority of each disk category. When a disk category is unavailable, the system automatically switches to the next category. Valid values:
|
cloud_ssd |
| DataDiskConfig |
array<object> |
任意 |
The list of data disk configurations. |
|
|
object |
任意 |
The data disk configuration information. |
||
| DiskCategory |
string |
任意 |
The category of the data disk. You can specify multiple candidate disk categories. The specified order determines the priority of each disk category. When a disk category is unavailable, the system automatically switches to the next category. Valid values:
|
cloud_efficiency |
| LaunchConfiguration.HostNames |
array |
任意 |
The list of hostnames for one or more instances. The following limits apply:
|
ecs-host-01 |
|
string |
任意 |
The hostname. The following limits apply:
|
ecs-host-01 |
|
| MinTargetCapacity |
string |
任意 |
The minimum target capacity of the auto provisioning group. Valid values |
20 |
| LaunchConfiguration.SecurityGroupIds |
array |
任意 |
The list of security groups to which the instance belongs. |
|
|
string |
任意 |
The ID of the security group to which the instance belongs. If both a launch template and launch configuration information are specified, the launch template takes precedence. |
sg-bp15ed6xe1yxeycg**** |
|
| LaunchConfiguration.SystemDisk |
object |
任意 |
The system disk information of the instance. If you specify both a launch template and launch configuration information, the launch template takes precedence. |
|
| Encrypted |
string |
任意 |
Specifies whether the system disk is encrypted. Valid values:
Default value: false. If you specify both. |
false |
| KMSKeyId |
string |
任意 |
The KMS key ID of the system disk. When both a launch template and launch configuration information are specified, the launch template takes precedence. |
0e478b7a-4262-4802-b8cb-00d3fb40**** |
| EncryptAlgorithm |
string |
任意 |
The encryption algorithm for the system disk. Valid values:
Default value: aes-256. If you specify both a launch template and launch configuration information, the launch template takes precedence. 説明
This parameter is not publicly available. |
aes-256 |
| ProvisionedIops |
integer |
任意 |
The provisioned read/write IOPS of the ESSD AutoPL disk. Valid values: 0 to min{50,000, 1000 × Capacity - Baseline performance}. Baseline performance = min{1,800 + 50 × Capacity, 50,000}. 説明
This parameter is supported only when SystemDisk.Category is set to cloud_auto. For more information, see ESSD AutoPL disk. |
40000 |
| BurstingEnabled |
boolean |
任意 |
Specifies whether to enable the performance burst feature. Valid values:
説明
This parameter is supported only when |
false |
| AutoSnapshotPolicyId |
string |
任意 |
The ID of the automatic snapshot policy to apply to the system disk. After you set this parameter, note the following items:
|
sp-bp67acfmxazb4p**** |
| LaunchConfiguration.Arn |
array<object> |
任意 |
説明
このパラメーターは招待プレビュー中であり、使用できません。 |
|
|
object |
任意 |
説明
このパラメーターは招待プレビュー中であり、使用できません。 |
||
| Rolearn |
string |
任意 |
説明
このパラメーターは招待プレビュー中であり、使用できません。 |
acs:ram::123456789012****:role/adminrole |
| RoleType |
string |
任意 |
説明
このパラメーターは招待プレビュー中であり、使用できません。 |
34458433936495****:alice |
| AssumeRoleFor |
integer |
任意 |
説明
このパラメーターは招待プレビュー中であり、使用できません。 |
123456789012**** |
| HibernationOptionsConfigured |
boolean |
任意 |
説明
This parameter is in invitational preview and is not publicly available. |
false |
| LaunchConfiguration.AutoReleaseTime |
string |
任意 |
The automatic release time of the pay-as-you-go instance. Specify the time in the ISO 8601 standard in the
|
2018-01-01T12:05:00Z |
| LaunchConfiguration.ImageFamily |
string |
任意 |
The name of the image family. The name must be 2 to 128 characters in length. The name must start with a letter and cannot start with |
hangzhou-daily-update |
| Tag |
array<object> |
任意 |
The tags to attach to the auto provisioning group. |
|
|
object |
任意 |
The tag to attach to the auto provisioning group. |
||
| Key |
string |
任意 |
The tag key of the auto provisioning group. Valid values of N: 1 to 20. The tag key cannot be an empty string. The tag key can be up to 128 characters in length and cannot start with aliyun or acs:. The tag key cannot contain http:// or https://. |
TestKey |
| Value |
string |
任意 |
The tag value of the auto provisioning group. Valid values of N: 1 to 20. The tag value can be an empty string. The tag value can be up to 128 characters in length and cannot contain http:// or https://. |
TestValue |
| ResourcePoolOptions |
object |
任意 |
The resource pool policy used to create instances. After you set this parameter, note the following items:
|
|
| Strategy |
string |
任意 |
Resource pools include private pools generated after Elasticity Assurance or Capacity Reservation takes effect, and public pools for instance startup. Valid values:
Default value: PublicPoolOnly. |
PrivatePoolFirst |
| PrivatePoolIds |
array |
任意 |
The list of private pool IDs. Valid values: 1 to 20. |
|
|
string |
任意 |
The private pool ID, which is the Elasticity Assurance ID or Capacity Reservation ID. Only Target-mode private pool IDs can be specified. |
eap-bp67acfmxazb4**** |
|
| LaunchConfiguration |
object |
任意 |
The launch configuration parameters. |
|
| Period |
integer |
任意 |
The subscription duration of the resource. Unit: specified by If PeriodUnit is set to Month, valid values of Period: 1, 2, 3, 6, and 12. |
1 |
| PeriodUnit |
string |
任意 |
The unit of the subscription billable methods duration. Valid values: Month (default). |
Month |
| AutoRenew |
boolean |
任意 |
Specifies whether to enable auto-renewal. This parameter takes effect when you create subscription instances. Valid values:
|
true |
| AutoRenewPeriod |
integer |
任意 |
The auto-renewal period. Valid values: If PeriodUnit is set to Month: 1, 2, 3, 6, 12, 24, 36, 48, and 60. Default value: 1. |
1 |
| SpotDuration |
integer |
任意 |
The protection period of the spot instance. Unit: hours. Default value: 1. Valid values:
Alibaba Cloud sends an ECS system event notification 5 minutes before the instance is released. Spot instances are billed by second. Select an appropriate protection period based on the expected task execution duration. After you set this parameter, note the following items:
|
1 |
| SpotInterruptionBehavior |
string |
任意 |
The spot instance break mode. Valid values:
For more information about economical mode, see Economical mode. Default value: Terminate. After you set this parameter, note the following items:
|
Terminate |
| ImageOptions |
object |
任意 |
The image-related property information. After you set this parameter, note the following items:
|
|
| LoginAsNonRoot |
boolean |
任意 |
Specifies whether the instance that uses this image supports logon as the ecs-user user. Valid values:
|
false |
| SchedulerOptions |
object |
任意 |
||
| DedicatedHostId |
string |
任意 |
||
| DedicatedHostClusterId |
string |
任意 |
||
| SecurityOptions |
object |
任意 |
||
| TrustedSystemMode |
string |
任意 |
||
| CpuOptions |
object |
任意 |
The CPU-related configurations. |
|
| Core |
integer |
任意 |
The number of CPU cores. Default value: see Specify and view CPU options. |
2 |
| ThreadsPerCore |
integer |
任意 |
The number of threads per CPU core. The number of vCPUs of the ECS instance = CpuOptions.Core value × CpuOptions.ThreadsPerCore value. If CpuOptions.ThreadsPerCore is set to 1, CPU hyper-threading is disabled. Only specific instance types support custom CPU thread counts. For valid values and default values, see Specify and view CPU options. |
2 |
| PrePaidOptions |
object |
任意 |
The detailed capacity configuration for subscription instances. |
|
| SpecifyCapacityDistribution |
array<object> |
任意 |
The minimum capacity set for different instance types. This parameter is supported only when |
|
|
object |
任意 |
The minimum capacity for an instance type. |
||
| InstanceTypes |
array |
任意 |
The set of instance types. Duplicate values are not allowed, and the instance types must be within the range of LaunchTemplateConfig.InstanceType. |
|
|
string |
任意 |
インスタンスタイプ |
ecs.c6.large |
|
| MinTargetCapacity |
integer |
任意 |
The minimum number of instances to deliver within the 説明
The sum of all MinTargetCapacity values ( |
5 |
| ExecutionMode |
string |
任意 |
||
| CandidateOptions |
object |
任意 |
||
| TimeoutMinutes |
integer |
任意 |
60 |
|
| Evaluate |
boolean |
任意 |
レスポンスフィールド
|
フィールド |
型 |
説明 |
例 |
|
object |
|||
| AutoProvisioningGroupId |
string |
自動プロビジョニンググループの ID |
apg-sn54avj8htgvtyh8**** |
| RequestId |
string |
リクエスト ID |
745CEC9F-0DD7-4451-9FE7-8B752F39**** |
| LaunchResults |
object |
||
| LaunchResult |
array<object> |
The set of instances created by the auto provisioning group. This value is returned only when the delivery type of the auto provisioning group is one-time synchronization delivery ( |
|
|
array<object> |
The information about the instances created by the auto provisioning group. |
||
| ZoneId |
string |
インスタンスのゾーン ID です。 |
cn-hangzhou-g |
| ErrorMsg |
string |
インスタンスの作成が失敗した場合に返されるエラーメッセージです。 |
Specific parameter is not valid. |
| InstanceType |
string |
インスタンスタイプです。 |
ecs.g5.large |
| ErrorCode |
string |
インスタンスの作成が失敗した場合に返されるエラーコードです。 |
InvalidParameter |
| SpotStrategy |
string |
従量課金インスタンスのスポット戦略です。有効値:
|
NoSpot |
| Amount |
integer |
正常に作成されたインスタンス ID リスト内のインスタンス数です。 |
1 |
| InstanceIds |
object |
||
| InstanceId |
array |
正常に作成されたインスタンス ID の一覧です。 |
|
|
string |
正常に作成されたインスタンス ID の一覧です。 |
["i-bp67acfmxazb4p****"] |
|
| CandidateEvaluateLevel |
string |
Low |
例
成功レスポンス
JSONJSON
{
"AutoProvisioningGroupId": "apg-sn54avj8htgvtyh8****",
"RequestId": "745CEC9F-0DD7-4451-9FE7-8B752F39****",
"LaunchResults": {
"LaunchResult": [
{
"ZoneId": "cn-hangzhou-g",
"ErrorMsg": "Specific parameter is not valid.",
"InstanceType": "ecs.g5.large",
"ErrorCode": "InvalidParameter",
"SpotStrategy": "NoSpot",
"Amount": 1,
"InstanceIds": {
"InstanceId": [
"[\"i-bp67acfmxazb4p****\"]"
]
},
"CandidateEvaluateLevel": "Low"
}
]
}
}
エラーコード
|
HTTP ステータスコード |
エラーコード |
エラーメッセージ |
説明 |
|---|---|---|---|
| 400 | InvalidParameter | %s | |
| 400 | InvalidAutoProvisioningGroupName.Malformed | The specified parameter "AutoProvisioningGroupName" is not valid. | |
| 400 | InvalidAutoProvisioningGroupType.ValueNotSupported | The specified parameter "AutoProvisioningGroupType" is not supported. | |
| 400 | InvalidFleetExcessCapacityTerminationPolicy.ValueNotSupported | The specified parameter "ExcessCapacityTerminationPolicy" is not supported. | |
| 400 | InvalidDefaultTargetCapacityType.ValueNotSupported | The specified parameter "DefaultTargetCapacityType" is not supported. | |
| 400 | InvalidSpotAllocationStrategy.ValueNotSupported | The specified parameter "SpotAllocationStrategy" is not supported. | |
| 400 | InvalidSpotInstanceInterruptionBehavior.ValueNotSupported | The specified parameter "SpotInstanceInterruptionBehavior" is not supported. | |
| 400 | InvalidPayAsYouGoAllocationStrategy.ValueNotSupported | The specified parameter "PayAsYouGoAllocationStrategy" is not supported. | |
| 400 | MissingParameter.SpotAllocationStrategy | The specified parameter "SpotAllocationStrategy" is empty. | |
| 400 | MissingParameter.LaunchTemplateConfigs | The specified parameter "LaunchTemplateConfigs" is empty. | |
| 400 | InvalidValidTime.MalFormed | The specified parameter "ValidTime" is not supported. | |
| 400 | InvalidLaunchTemplateVersion.ValueNotSupported | The specified parameter "LaunchTemplateVersion" is not valid. | |
| 400 | MissingParameter | The specified parameter "AutoProvisioningGroup" should not be null. | |
| 400 | InvalidRegion.ValueNotSupported | The specified Region does not exist. | |
| 400 | InvalidDescription.ValueNotSupported | The specified description is illegal. | |
| 400 | InvalidLaunchTemplate.ValueNotSupported | The SecurityGroupId or imageId in LaunchTemplate is not exists. | |
| 400 | InvalidCapacity.ValueNotSupported | The Capacity is illegal, or the TargetCapacity is large than SpotCapacity + PayAsYouGoCapacity. | |
| 400 | InvalidInstanceType.ValueNotSupported | The instanceType is illegal. | |
| 400 | InternalError | The request processing has failed due to some unknown error. | |
| 400 | InvalidLaunchTemplateConfigs.SizeExceed | The size of LaunchTemplateConfigs exceeds limit. | |
| 400 | InvalidParameter.SpotInstancePoolsToUseCount | The specified parameter "SpotInstancePoolsToUseCount" is not valid. | |
| 400 | InvalidParameter.ResourceGroupId | The specified parameter "ResourceGroupId" is not valid. | |
| 400 | InvalidParameter.TargetCapacity | The Capacity is illegal, TotalTargetCapacity, PayAsYouGoTargetCapacity, SpotTargetCapacity must be specified, meanwhile, the TargetCapacity must be larger than or equal to the sum of SpotCapacity and OnDemandCapacity. | |
| 400 | MissingParameter.WeightedCapacity | The WeightedCapacity of LaunchTemplateConfig should not be empty. | |
| 400 | InvalidParameter.WeightedCapacityBeyondRange | The WeightedCaTpacity of LaunchTemplateConfig beyond permitted range. | |
| 400 | InvalidParameter.MaxPrice | The specified parameter "MaxSpotPrice" or "MaxPrice" of LaunchTemplateConfig is not valid. | |
| 400 | NoPermission | %s | |
| 400 | Duplicate.DiskCategory | The specified disk configs contains duplicate DiskCategory. | |
| 400 | InvalidImageFamily.Confict | The specified parameter ImageFamily should be empty when the parameter ImageId is specified. | |
| 400 | Invalid.ResourcePoolOptions.PrivatePoolIds | The zone or instancetype of the ResourcePoolOptions.PrivatePoolIds does not match the LaunchTemplateConfig. | |
| 400 | Invalid.ResourcePoolOptions.Strategy | The specified ResourcePoolOptions.Strategy is invalid. | |
| 400 | Invalid.ResourcePoolOptionsPrivatePoolIds.SizeExceed | The size of ResourcePoolOptions.PrivatePoolIds exceeds limit. | |
| 400 | MissingParameter.ResourcePoolOptions.PrivatePoolIds | The specified ResourcePoolOptions.PrivatePoolIds should not be null when ResourcePoolOptions.Strategy is PrivatePoolOnly. | |
| 400 | InvalidSpotDuration | The specified SpotDuration is not valid. | |
| 400 | InvalidSpotInterruptionBehavior | %s | |
| 400 | InvalidParameter.SecurityGroupIdRepeated | The SecurityGroupId is repeated. | |
| 400 | VpcMismatch.SecurityGroupAndVSwitch | Specified security group and virtual switch are not in the same VPC. | |
| 400 | InvalidMinTargetCapacity.NotSatisfied | The inventory of specified InstanceType does not meet the MinTargetCapacity. | |
| 400 | InvalidParameterRange.MinTargetCapacity | The MinTargetCapacity exceeds the limit[0-TotalTargetCapacity]. | |
| 400 | InvalidUserData.Base64FormatInvalid | The specified parameter UserData must be base64 encoded. | |
| 400 | InvalidUserData.SizeExceeded | The specified parameter UserData exceeds the size. | |
| 400 | InvalidAutoReleaseTime.Malformed | The specified parameter AutoReleaseTime is not valid. | |
| 400 | QuotaExceeded.AutoProvisioningGroup | The count of AutoProvisioningGroup exceeds the limit. | |
| 400 | Invalid.PrivatePoolOptions.status | The PrivatePool status is not valid. | |
| 500 | InternalError | The request processing has failed due to some unknown error. | |
| 403 | TotalTargetCapacityLimitExceed | The TotalTargetCapacity exceeds the limit[0-2000]. | |
| 403 | SpotTargetCapacityLimitExceed | The SpotTargetCapacity exceeds the limit[0-2000]. | |
| 403 | PayAsYouGoTargetCapacityLimitExceed | The PayAsYouGoTargetCapacity exceeds the limit[0-2000]. | |
| 403 | OperationDenied.NoStock | The resource is out of stock in the specified zone. Please try other types, or choose other regions and zones. | |
| 403 | CandidateDenied.NoStock | The resource is out of stock and there are no candidate resources in the specified zone. Please try other types, or choose other regions and zones. | |
| 404 | InvalidResourcePoolOptionsPrivatePoolIds.NotFound | The ResourcePoolOptions.PrivatePoolIds do not exist. | |
| 404 | InvalidSecurityGroupId.NotFound | The SecurityGroupId %s provided does not exist in our records. | |
| 404 | InvalidVSwitchId.NotFound | The specified virtual switch %s does not exist. |
完全なリストについては、「エラーコード」をご参照ください。
変更履歴
完全なリストについては、「変更履歴」をご参照ください。