地域推荐ListSupplyRecommendation
接口说明
对ECS的资源供给的地域和规格进行推荐,推荐结果以打分的形式呈现,分数越高推荐程度越高
URL
POST https://cms.myhuaweicloud.com/v1/{domain_id}/recommendations/ecs-supply
请求参数
| 名称 | 类型 | IN | 必选 | 描述 |
|---|---|---|---|---|
|
X-Auth-Token
|
string | header | 是 |
用户Token。 通过调用 IAM 服务获取用户Token接口获取(响应消息头中X-Subject-Token的值) |
|
domain_id
|
string | path | 是 |
租户域ID |
Body参数
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
|
flavor_constraint
|
FlavorConstraint object | 否 |
资源供给规格的约束,给出规格列表时优先使用规格列表 |
|
flavor_ids
|
Array of strings | 否 |
接受推荐的规格列表 |
|
locations
|
Array of DistinctLocation objects | 否 |
接受推荐的地域列表,默认接受所有区域 |
|
option
|
SupplyOption object | 否 |
供给推荐的选项 |
|
strategy
|
string | 否 |
推荐的策略。 CAPACITY:容量策略 COST:成本策略 |
|
limit
|
integer | 否 |
查询返回的数量限制 |
|
marker
|
string | 否 |
取值为上一页数据的最后一条记录的唯一标记 |
参数：
flavor_constraint
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
|
architecture_type
|
Array of strings | 否 |
接受的体系结构描述 |
|
flavor_requirements
|
Array of FlavorRequirement objects | 否 |
资源的需求约束 |
参数：
flavor_constraint.flavor_requirements
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
|
vcpu_count
|
IntegerRange object | 否 |
规格的vcpu数量范围,不填表示接受所有 |
|
memory_mb
|
IntegerRange object | 否 |
规格的内存大小范围,单位是MiB,不填表示接受所有 |
|
cpu_manufacturers
|
Array of strings | 否 |
可选CPU制造商,不填表示接受所有 |
|
memory_gb_per_vcpu
|
DoubleRange object | 否 |
Flavor的单vcpu对应内存容量范围,内存单位GiB,不填表示接受所有 |
|
instance_generations
|
Array of strings | 否 |
接受的资源代系,不填表示接受所有 |
参数：
flavor_constraint.flavor_requirements.vcpu_count
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
|
max
|
integer | 否 |
最大值,-1表示无限制 |
|
min
|
integer | 否 |
最小值,-1表示无限制 |
参数：
flavor_constraint.flavor_requirements.memory_mb
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
|
max
|
integer | 否 |
最大值,-1表示无限制 |
|
min
|
integer | 否 |
最小值,-1表示无限制 |
参数：
flavor_constraint.flavor_requirements.memory_gb_per_vcpu
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
|
max
|
double | 否 |
最大值,-1表示无限制 |
|
min
|
double | 否 |
最小值,-1表示无限制 |
参数：
locations
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
|
region_id
|
string | 是 |
区域ID |
|
availability_zone_id
|
string | 否 |
可用区ID |
参数：
option
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
|
result_granularity
|
string | 否 |
推荐结果的粒度 BY_REGION:对每个区域打分,可使用多种规格满足需求 BY_AZ:对每个可用区打分 BY_FLAVOR:对每个规格打分,可使用多地域满足需求 BY_FLAVOR_AND_REGION:对每个区域下的每个规格打分 BY_FLAVOR_AND_AZ:对每个可用区下的每个规格打分 |
|
enable_spot
|
boolean | 否 |
是否推荐竞价实例 |
返回参数
返回码: 200
OK
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
|
supply_recommendations
|
Array of SupplyRecommendation objects | 是 |
资源供给推荐结果 |
200 supply_recommendations
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
|
flavor_id
|
string | 否 |
实例规格ID |
|
region_id
|
string | 否 |
区域ID |
|
availability_zone_id
|
string | 否 |
可用区ID |
|
score
|
integer | 否 |
推荐分数 |
返回码: 400
Bad Request
返回码: 401
Unauthorized
返回码: 403
Forbidden
返回码: 500
Internal Server Error
返回码: 502
Bad Gateway
请求示例
示例 1
地域推荐请求示例
"POST https://{endpoint}/v1/{domain_id}/recommendations/ecs-supply"
{ "flavor_constraint": { "flavor_requirements": [ { "vcpu_count": { "max": 8, "min": 2 }, "memory_mb": { "max": 8192, "min": 4096 } } ], "option": { "result_granularity": "BY_FLAVOR_AND_AZ" }, "strategy": "COST", "locations": [ { "region_id": "region1" } ] } }
返回示例
返回码：200
OK
示例 1
{
"supply_recommendations": [
{
"flavor_id": "c6.large.2",
"region_id": "region1",
"availability_zone_id": "az1",
"score": 8
}
]
}
"supply_recommendations": [
{
"flavor_id": "c6.large.2",
"region_id": "region1",
"availability_zone_id": "az1",
"score": 8
}
]
}
SDK
点击 容量管理服务 (CMS) SDK, 下载SDK或查看SDK文档。SDK的安装、认证方式等在SDK文档中对应语言类型的【使用】目录下。
错误码
请参考 错误码说明。
