文档首页> 客户运营能力> API参考> 管理产品> 查询产品信息> 根据云服务类型查询资源列表
更新时间:2023-09-07 GMT+08:00
分享

根据云服务类型查询资源列表

功能介绍

客户在自建平台根据云服务类型查询关联的资源类型编码和名称,用于查询按需产品的价格或包年/包月产品的价格。

接口约束

该接口可以使用客户AK/SK或者Token调用。

该接口不支持根据云商店服务类型查询资源列表。

调试

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

URI

GET /v2/products/service-resources

表1 Header参数

参数

是否必选

取值范围

描述

X-Language

最大长度:8

语言。

  • 中文:zh_CN
  • 英文:en_US

缺省为zh_CN。

表2 查询参数

参数

是否必选

参数类型

取值范围

描述

service_type_code

String

最大长度:64

云服务类型编码,例如OBS的云服务类型编码为“hws.service.type.obs”。您可以调用查询云服务类型列表接口获取。

offset

Integer

[0-10000000]

偏移量,从0开始。默认值为0。

说明:

offset用于分页处理,如不涉及分页,请使用默认值0。offset表示相对于满足条件的第一个数据的偏移量。如offset = 1,则返回满足条件的第二个数据至最后一个数据。

示例1,满足查询条件的结果共10条数据,limit取值为10,offset取值为1,则返回的数据为2~10,第一条数据不返回。

示例2,查询总数20条,期望每页返回10条数据,则获取第一页数据,入参offset填写0,limit填写10;获取第二页数据,入参offset填写10,limit填写10。

limit

Integer

[1-100]

每次查询的数量,默认值为10。

此参数不支持携带值为空。

请求消息

请求参数

无。

请求示例

GET https://bss.myhuaweicloud.com/v2/products/service-resources?service_type_code=hws.service.type.obs&limit=5&offset=0 HTTP/1.1
Content-Type: application/json
X-Auth-TokenMIIPAgYJKoZIhvcNAQcCo...ggg1BBIINPXsidG9rZ
X-Language: zh_CN

响应消息

响应参数

参数

参数类型

取值范围

描述

error_code

String

最大长度:20

状态码。

具体请参考状态码。只有失败才返回该字段。

error_msg

String

最大长度:1000

错误描述信息。只有失败才返回该字段。

total_count

Integer

-

总数。

infos

List<ServiceResourceInfo>

最大个数:100

资源基本信息列表,具体请参见表3

表3 ServiceResourceInfo

参数

参数类型

取值范围

描述

basic_info

BasicInfo Object

-

资源基本信息。具体请参见表4

表4 ResourceBasicInfo

参数

参数类型

取值范围

描述

resource_type_code

String

最大长度:64

资源类型编码。例如:hws.resource.type.general。

product_owner_service

String

最大长度:64

资源类型归属的服务类型编码。例如:hws.service.type.offline。

name

String

最大长度:1024

资源类型名称。例如:通用规格。

description

String

最大长度:1024

资源类型描述。

响应示例

HTTP/1.1 200 OK
Content-Type: application/json;charset=UTF-8
Content-Length: length
Date: response time  
{
    "total_count": 5,
    "infos": [
        {
            "basic_info": {
                "resource_type_code": "hws.resource.type.general",
                "product_owner_service": "hws.service.type.offline",
                "name": "通用规格",
                "description": "通用规格"
            }
        },
        {
            "basic_info": {
                "resource_type_code": "hws.resource.type.bandwidth",
                "product_owner_service": "hws.service.type.vpc",
                "name": "固定带宽",
                "description": "固定带宽"
            }
        },
        {
            "basic_info": {
                "resource_type_code": "hws.resource.type.ip",
                "product_owner_service": "hws.service.type.vpc",
                "name": "弹性公网IP",
                "description": "弹性公网IP"
            }
        },
        {
            "basic_info": {
                "resource_type_code": "hws.resource.type.vm.image",
                "product_owner_service": "hws.service.type.ec2",
                "name": "云主机镜像",
                "description": "云主机镜像"
            }
        },
        {
            "basic_info": {
                "resource_type_code": "hws.resource.type.vm",
                "product_owner_service": "hws.service.type.ec2",
                "name": "云主机",
                "description": "云主机"
            }
        }
    ]
}

状态码

  • 状态码4xx:由于明显的客户端错误(例如,格式错误的请求语法、参数错误等),华为云会返回4xx错误码,请及时检查请求消息的正确性,重新发起请求。
  • 状态码5xx:由于华为云系统原因,导致无法完成明显有效请求的处理,可及时联系华为云客服处理。

HTTP状态码

错误码

错误描述

400

CBC.0100

输入参数校验失败。

403

CBC.0151

访问拒绝。

500

CBC.0999

其他错误。

分享:

    相关文档

    相关产品