查询云服务类型资源规格定价-ListResourceSpecsPrice
功能介绍
客户在伙伴销售平台查询云服务类型资源规格与定价。
- 该接口仅返回华为云在售商品的云服务类型资源规格与定价。
- 分页查询使用的参数为marker、limit。marker和limit一起使用时才会生效,单独使用无效。
接口约束
该接口只允许使用解决方案提供商或华为云总经销商(一级经销商)的AK/SK或者Token调用。
调试
您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。
授权信息
伙伴操作员账号调用当前API无需授权。
URI
POST /v2/products/resource-specs-price/query
| 参数 | 是否必选 | 描述 |
|---|---|---|
| X-Language | 否 | 参数解释: 语言。 约束限制: 不涉及 取值范围:
默认取值: zh_CN。 |
请求消息
请求参数
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| cloud_service_type | 否 | String | 参数解释: 云服务类型编码,例如OBS的云服务类型编码为“hws.service.type.obs”。您可以调用查询云服务类型列表-ListServiceTypes接口获取。 约束限制: 此参数不携带或携带值为null时,不作为筛选条件。 取值范围: [1-64] 默认取值: 不涉及 |
| resource_type | 否 | String | 参数解释: 资源类型编码,例如ECS的VM为“hws.resource.type.vm”。您可以调用查询资源类型列表-ListResourceTypes接口获取。 约束限制: 此参数不携带或携带值为null时,不作为筛选条件。 取值范围: [1-64] 默认取值: 不涉及 |
| region_code | 是 | String | 参数解释: 云服务区编码,例如:“ap-southeast-1”。具体请参见地区和终端节点对应云服务的“区域”列的值。 约束限制: 不涉及 取值范围: [1-64] 默认取值: 不涉及 |
| filters | 否 | List<Filter> | 参数解释: 过滤条件,具体请参见表2 Filter。 约束限制: 此参数不携带或携带值为空列表或携带值为null时,不作为筛选条件。 取值范围: [0-1] 默认取值: 不涉及 |
| need_attributes | 否 | boolean | 参数解释: 是否返回资源规格属性信息。 约束限制: 不涉及 取值范围:
默认取值: false。 |
| need_price | 否 | boolean | 参数解释: 是否返回资源规格官网定价信息。 约束限制: 不涉及 取值范围:
默认取值: false。 |
| marker | 否 | String | 参数解释: 翻页信息,从上次API调用返回的分页查询页的信息中获取。 约束限制:
取值范围: [1-256] 默认取值: 不涉及 |
| limit | 否 | Integer | 参数解释: 每页返回的个数,用于控制分页查询返回的记录数量。 约束限制: 不涉及 取值范围: [1-50] 默认取值: 50 |
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| key | 是 | String | 参数解释: 过滤条件的key值。 约束限制: 不涉及 取值范围:
默认取值: 不涉及 |
| value | 是 | String | 参数解释: 过滤条件的value值。不支持模糊查询。 约束限制: 不涉及 取值范围: [1-256] 如果key为CHARGING_MODE,此处取值如下:
默认取值: 不涉及 |
请求示例
POST https://bss-intl.myhuaweicloud.com/v2/products/resource-specs-price/query HTTP/1.1 Content-Type: application/json X-Auth-Token: MIIPAgYJKoZIhvcNAQcCo...ggg1BBIINPXsidG9rZ X-Language: zh_CN { "cloud_service_type": "hws.service.type.ec2", "resource_type": "hws.resource.type.vm", "filters": [ { "key": "RESOURCE_SPEC", "value": "ac3.2xlarge.4.linux" } ], "region_code": "ap-southeast-1", "need_attributes": true, "need_price": true, "marker": null, "limit": 50 }
响应消息
响应参数
| 参数 | 参数类型 | 描述 |
|---|---|---|
| error_code | String | 参数解释: 状态码。 具体请参考状态码。只有失败才返回该字段。 取值范围: 最大长度:20 |
| error_msg | String | 参数解释: 错误描述信息。只有失败才返回该字段。 取值范围: 最大长度:1000 |
| page_info | PageInfo Object | 参数解释: 分页查询页的信息。具体参见表3 PageInfo。 取值范围: 不涉及 |
| region_code | String | 参数解释: 云服务区编码。例如:“ap-southeast-1”。 取值范围: 最大长度:64 |
| resource_spec_infos | List<ResourceSpecInfo> | 参数解释: 云服务类型资源规格列表,具体参见表4 ResourceSpecInfo。 取值范围: 不涉及 |
| 参数 | 参数类型 | 描述 |
|---|---|---|
| next_marker | String | 参数解释: 向后分页标识符。下一页数据的起始marker,有值代表有下一页,为null代表无下一页。 取值范围: 最大长度:256 |
| 参数 | 参数类型 | 描述 |
|---|---|---|
| cloud_service_type | String | 参数解释: 云服务类型的编码。 取值范围: 最大长度:64 |
| cloud_service_type_name | String | 参数解释: 云服务类型的名称。 取值范围: 最大长度:200 |
| resource_type | String | 参数解释: 资源类型的编码。例如ECS的VM为“hws.resource.type.vm”。 取值范围: 最大长度:64 |
| resource_type_name | String | 参数解释: 资源类型的名称。 取值范围: 最大长度:200 |
| resource_spec | String | 参数解释: 云服务类型的资源规格编码。 取值范围: 最大长度:200 |
| resource_spec_name | String | 参数解释: 云服务类型的资源规格名称。 取值范围: 最大长度:256 |
| attributes | List<Attribute> | 参数解释: 云服务类型资源规格属性信息列表。need_attributes为true时,返回属性信息。具体参见表5 Attribute 取值范围: 不涉及 |
| price_lists | List<PriceItem> | 参数解释: 云服务类型资源规格定价信息列表。need_price为true时,返回定价信息。具体参见表7 PriceItem 取值范围: 不涉及 |
| 参数 | 参数类型 | 描述 |
|---|---|---|
| code | String | 参数解释: 属性编码。 取值范围: 最大长度:128 |
| name | String | 参数解释: 属性名称。 取值范围: 最大长度:1024 |
| value | String | 参数解释: 属性取值。 取值范围: 最大长度:200 |
| unit | String | 参数解释: 属性单位。 取值范围: 最大长度:64 |
| linear_range | Object LinearRange | 参数解释: 线性属性范围。具体参见表6 LinearRange 取值范围: 不涉及 |
| 参数 | 参数类型 | 描述 |
|---|---|---|
| min | Integer | 参数解释: 线性属性最小值。 取值范围: 不涉及 |
| max | Integer | 参数解释: 线性属性最大值。 取值范围: 不涉及 |
| step | Integer | 参数解释: 线性属性步长。 取值范围: 不涉及 |
| 参数 | 参数类型 | 描述 |
|---|---|---|
| offering_id | String | 参数解释: 商品Id。 取值范围: 最大长度:64 |
| currency | String | 参数解释: 币种。 取值范围: USD:美元。 值为空代表美元。 |
| official_price | String | 参数解释: 查询时间生效的官网价。 取值范围: 最大长度:64 |
| charging_mode | String | 参数解释: 计费模式。 取值范围:
|
| period_type | Integer | 参数解释: 销售周期类型。 取值范围:
|
| period_nums | List<Integer> | 参数解释: 销售周期数。 取值范围: 不涉及 |
| billing_usage_factor | String | 参数解释: 计费因子。 取值范围: 最大长度:64 |
HTTP/1.1 200 OK
Content-Type: application/json;charset=UTF-8
Content-Length: length
Date: response time
{
"page_info": {
"next_marker": "c3ne.xlarge.2.linux"
},
"region_code": "ap-southeast-1",
"resource_spec_infos": [
{
"cloud_service_type": "hws.service.type.ec2",
"cloud_service_type_name": "Elastic Cloud Server",
"resource_type": "hws.resource.type.vm",
"resource_type_name": "Cloud Host",
"resource_spec": "ac3.2xlarge.4.linux",
"resource_spec_name": "ARM Enhaced General Computing|ac3.2xlarge.4|8vCPUs|29GB|linux",
"attributes": [
{
"code": "etryy",
"name": "内存",
"value": "8",
"unit": "GB",
"linear_range": {
"min": 1,
"max": 5,
"step": 1
}
}
],
"price_lists": [
{
"offering_id": "OFF-003",
"currency": "USD",
"official_price": "300.00",
"charging_mode": "PERIOD",
"period_type": 3,
"period_nums": [1,2,3],
"billing_usage_factor": "TRAFFIC_GB"
}
]
}
]
}