華為云計算 云知識 創(chuàng)建智能購買組CreateAutoLaunchGroup
創(chuàng)建智能購買組CreateAutoLaunchGroup

 

接口說明

創(chuàng)建智能購買組

約束說明

1、不支持細粒度授權。 2、不支持包年/包月計費模式。 3、不支持對接QuotaManager,使用默認配置,單個租戶最大支持創(chuàng)建30個智能購買組。 4、不支持創(chuàng)建IPv6實例。 5、不支持創(chuàng)建100ums云盤。 6、不支持網(wǎng)絡driver_mode配置。 7、不支持創(chuàng)建時指定 云服務器 密碼(可通過啟動模板指定)。 8、租戶創(chuàng)建的實例個數(shù)、CPU以及網(wǎng)絡配額同租戶自身配額保持一致。 9、不支持創(chuàng)建BMS實例。

URL
POST  https://cms.myhuaweicloud.com/v2/{domain_id}/auto-launch-groups 
請求參數(shù)
名稱 類型 IN 必選 描述
X-Auth-Token
 
string header

用戶Token。

通過調(diào)用 IAM 服務獲取用戶Token接口獲取(響應消息頭中X-Subject-Token的值)

domain_id
 
string path

租戶域ID

Body參數(shù)
名稱 類型 必選 描述
name
 
string

智能購買組名稱。 取值范圍:1-64個字符,只能包含中文、字母、數(shù)字、下劃線和中劃線。

dry_run
 
boolean

創(chuàng)建智能購買組參數(shù)核查 true:發(fā)送檢查請求,不會創(chuàng)建智能購買組。檢查項包括是否填寫了必需參數(shù)、請求格式等。 如果檢查不通過,則返回對應錯誤。 如果檢查通過,則返回202狀態(tài)碼。 false:發(fā)送正常請求,通過檢查后并且執(zhí)行創(chuàng)建智能購買組請求。

type
 
string

請求類型,枚舉值 request:一次性。僅在啟動時交付實例集群,調(diào)度失敗后不再重試。 maintain:持續(xù)供應。在啟動時嘗試交付實例集群,并監(jiān)控實時容量,未達到目標容量則嘗試繼續(xù)創(chuàng)建ECS實例。 默認值:maintain

guarantee_plan_id
 
string

算力保障計劃ID

target_capacity
 
integer

智能購買組目標容量。 實例數(shù)量或者CPU個數(shù)目標容量大于等于stable_capacity。競價實例的容量為滿配容量減去stable_capacity。

stable_capacity
 
integer

按需實例目標容量。 目標容量指實例數(shù)量或CPU個數(shù),必須小于等于target_capacity,智能購買組中可以沒有按需實例。

excess_fulfilled_capacity_behavior
 
string

超過目標容量或目標容量減少時的實例中斷行為,枚舉值 terminate:釋放 noTermination:不釋放 默認值:terminate

instances_behavior_with_expiration
 
string

請求到期正在的實例中斷行為,枚舉值 terminate:釋放 noTermination:不釋放 默認值:terminate

valid_since
 
string

請求開始時間,和valid_until共同確定有效時段。 按照ISO8601標準表示,并使用UTC +0時間,格式為yyyy-MM-ddTHH:mm:ssZ。 默認值:立即生效

valid_until
 
string

請求結束時間,和valid_since共同確定有效時段。 按照ISO8601標準表示,并使用UTC +0時間,格式為yyyy-MM-ddTHH:mm:ssZ。 默認值:無限期

allocation_strategy
 
string

實例分配策略,枚舉值 lowest_price:價格最低策略,智能購買組購買的所有實例的價格總和最低。 prioritized:優(yōu)先級策略,按照規(guī)格設定的優(yōu)先級創(chuàng)建實例。 capacity_optimized:容量最優(yōu)化策略,智能購買組購買的實例按照大規(guī)格優(yōu)先進行購買。 默認值:lowest_price

region_specs
 
Array of RegionSpec objects

智能購買組內(nèi)各區(qū)域的資源描述

supply_option
 
string

資源供給中規(guī)格選擇策略:枚舉值 singlation:選擇一種規(guī)格供給 multiple:組合多種規(guī)格供給 默認值:multiple

spot_price
 
double

用戶愿意為競價實例每小時支付的最高價格。如果overrides中沒有提供價格,可以使用該價格

參數(shù):
region_specs
名稱 類型 必選 描述
region_id
 
string

區(qū)域ID

expect_target_capacity
 
integer

區(qū)域內(nèi)期望的總算力容量

expect_stable_capacity
 
integer

區(qū)域內(nèi)期望的穩(wěn)定算力容量

launch_template_config
 
LaunchTemplateConfig object

啟動模板配置

參數(shù):
region_specs.launch_template_config
名稱 類型 必選 描述
launch_template
 
LaunchTemplateInfo object

實例的啟動模板

overrides
 
Array of OverrideInfo objects

實例的詳細信息

參數(shù):
region_specs.launch_template_config.launch_template
名稱 類型 必選 描述
launch_template_id
 
string

實例的啟動模板ID,唯一標識一個啟動模板

version
 
string

啟動模板版本號

參數(shù):
region_specs.launch_template_config.overrides
名稱 類型 必選 描述
availability_zone_id
 
string

可用區(qū)ID

flavor_id
 
string

實例規(guī)格ID

spot_price
 
double

用戶愿意為競價實例每小時支付的最高價格

priority
 
integer

優(yōu)先級。數(shù)值越小,優(yōu)先級越高,優(yōu)先購買。 取值范圍:0到Integer.MAX_VALUE 默認值是Integer.MAX_VALUE

weighted_capacity
 
double

實例規(guī)格的權重。取值越高,單臺實例滿足計算力需求的能力越大,所需的實例數(shù)量越小。 取值范圍:大于0 可以根據(jù)指定實例規(guī)格的計算力和集群單節(jié)點最低計算力得出權重值。 假設單節(jié)點最低計算力為8vcpu、60GB,則8vcpu、60GB的實例規(guī)格權重可設置為1,16vcpu、120GB的實例規(guī)格權重可設置為2

返回參數(shù)
返回碼: 200

OK

名稱 類型 必選 描述
auto_launch_group_id
 
string

創(chuàng)建好的智能購買組

error_code
 
integer

錯誤碼。 請求失敗時,響應體中包含錯誤。 請求成功時,不在響應消息體中包含錯誤碼。

error_msg
 
string

錯誤描述 請求失敗時,響應體中包含錯誤 請求成功時,不在響應消息體中包含錯誤描述

請求示例
示例 1

創(chuàng)建智能購買組請求

 
"POST https://{endpoint}/v2/{domain_id}/auto-launch-groups"
 
{ "name": "test", "guarantee_plan_id": "plan_id", "type": "maintain", "target_capacity": 10, "stable_capacity": 5, "excess_fulfilled_capacity_behavior": "terminate", "instances_behavior_with_expiration": "terminate", "valid_since": "2020-04-04T15:58:13Z", "valid_until": "2021-04-06T15:58:13Z", "region_specs": [ { "region_id": "region1", "expect_target_capacity": 10, "expect_stable_capacity": 5, "launch_template_config": { "launch_template": { "launch_template_id": "c516c350-7091-4490-9338-47ddb90360f2", "version": "1.0" }, "overrides": [ { "availability_zone_id": "az1", "flavor_id": "s3.large.2", "spot_price": 2, "priority": 4, "weighted_capacity": 6 }, { "availability_zone_id": "az2", "flavor_id": "s3.large.2", "spot_price": 2, "priority": 4, "weighted_capacity": 12 }, { "availability_zone_id": "az3", "flavor_id": "s3.large.2", "spot_price": 2, "priority": 4, "weighted_capacity": 2 } ] } } ], "allocation_strategy": "lowest_price", "spot_price": 0.5, "supply_option": "multiple", "dry_run": false }
返回示例
返回碼:200

OK

示例 1
 
{
"auto_launch_group_id": "c516c350-7091-4490-9338-47ddb90360f2"
}
SDK
點擊 容量管理服務 (CMS) SDK, 下載SDK或查看SDK文檔。SDK的安裝、認證方式等在SDK文檔中對應語言類型的【使用】目錄下。
錯誤碼
請參考 錯誤碼說明