文档首页/ 弹性云服务器 ECS/ API参考/ API/ 规格推荐管理/ 地域推荐
更新时间：2023-07-06 GMT+08:00
查看PDF
分享

地域推荐

功能介绍

对ECS的资源供给的地域和规格进行推荐，推荐结果以打分的形式呈现，分数越高推荐程度越高。

调试

您可以在API Explorer中调试该接口。

URI

POST /v1/{domain_id}/recommendations/ecs-supply

参数说明请参见表1。
表1 参数说明

参数

是否必选

描述

domain_id

是

租户域ID。

请求消息

请求参数如表2所示。

表2 请求参数

参数

是否必选

参数类型

描述

flavor_constraint

否

Object

资源供给规格的约束，给出规格列表时优先使用规格列表，详情请参见表3。

flavor_ids

否

Array of strings

接受推荐的规格列表。

locations

否

Array of objects

接受推荐的地域列表，默认接受所有区域。

option

否

Object

供给推荐的选项。

strategy

否

String

推荐的策略。

  • CAPACITY：容量策略
  • COST：成本策略

limit

否

Integer

查询返回的数量限制。

marker

否

String

取值为上一页数据的最后一条记录的唯一标记。
表3 flavor_constraint参数信息

参数

是否必选

参数类型

描述

architecture_type

否

Array of strings

接受的体系结构描述。

flavor_requirements

否

Array of objects

资源的需求约束，详情请参见表4。
表4 flavor_requirements参数信息

参数

是否必选

参数类型

描述

vcpu_count

否

Object

规格的vCPU数量范围，不填表示接受所有，详情请参见表5。

memory_mb

否

Object

规格的内存大小范围，不填表示接受所有，单位MiB，详情请参见表6。

cpu_manufacturers

否

Array of strings

可选CPU制造商，不填表示接受所有。

memory_gb_per_vcpu

否

Object

规格的单vCPU对应内存容量范围，不填表示接受所有，内存单位GiB，详情请参见表6。

instance_generations

否

Array of strings

接受的资源代系，不填表示接受所有。
表5 vcpu_count参数信息

参数

是否必选

参数类型

描述

max

否

Integer

最大值，-1表示无限制。

min

否

Integer

最小值，-1表示无限制。
表6 memory_mb参数信息

参数

是否必选

参数类型

描述

max

否

Integer

最大值，-1表示无限制。

min

否

Integer

最小值，-1表示无限制。
表7 memory_gb_per_vcpu参数信息

参数

是否必选

参数类型

描述

max

否

Double

最大值，-1表示无限制。

min

否

Double

最小值，-1表示无限制。
表8 locations参数信息

参数

是否必选

参数类型

描述

region_id

是

String

区域ID。

availability_zone_id

否

String

可用区ID。
表9 option参数信息

参数

是否必选

参数类型

描述

result_granularity

否

String

推荐结果的粒度。

  • BY_REGION：对每个区域打分，可使用多种规格满足需求。
  • BY_AZ：对每个可用区打分。
  • BY_FLAVOR：对每个规格打分，可使用多地域满足需求。
  • BY_FLAVOR_AND_REGION：对每个区域下的每个规格打分。
  • BY_FLAVOR_AND_AZ：对每个可用区下的每个规格打分。

enable_spot

否

Boolean

是否推荐竞价实例。

响应消息

响应参数如表10所示。

表10 响应参数

参数

参数类型

描述

supply_recommendations

Object

资源供给推荐结果，详情请参见表11。
表11 supply_recommendations参数信息

参数

参数类型

描述

flavor_id

String

实例规格ID。

region_id

String

区域ID。

availability_zone_id

String

可用区ID。

score

Integer

推荐分数。

请求示例

设置对云服务器资源供给的地域和规格推荐，vCPU范围为2~8，内存范围为4096 MiB~8192 MiB；推荐结果对每个可用区下的每个规格打分，推荐策略为成本策略，接受推荐的区域为“region1”。

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"
    }]
}

响应示例

{
    "supply_recommendations": [{
        "flavor_id": "c6.large.2",
        "region_id": "region1",
        "availability_zone_id": "az1",
        "score": 8
    }]
}

返回值

请参考通用请求返回值。

错误码

请参考错误码。

父主题： 规格推荐管理

相关文档