更新时间:2023-10-23 GMT+08:00

查询资源类型列表

功能介绍

伙伴在伙伴销售平台查询资源类型的列表。

接口约束

该接口可以使用合作伙伴AK/SK或者Token调用。

调试

您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。

URI

GET /v2/products/resource-types

表1 Header参数

参数

是否必选

取值范围

描述

X-Language

最大长度:8

语言。

  • zh_CN:中文
  • en_US:英文

缺省为zh_CN。

表2 查询参数

参数

是否必选

参数类型

取值范围

描述

offset

Integer

[0-1000000000]

偏移量,从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-1000]

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

请求消息

请求参数

请求示例

GET https://bss-intl.myhuaweicloud.com/v2/products/resource-types?offset=0&limit=10 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

-

总数。

resource_types

List<ResourceTypes>

-

资源类型信息列表,具体请参见表3

表3 ResourceTypes

参数

参数类型

取值范围

描述

resource_type_code

String

最大长度:64

资源类型的编码。例如ECS的VM为“hws.resource.type.vm”。

resource_type_name

String

最大长度:200

资源类型的名称。

resource_type_desc

String

最大长度:200

资源类型的描述。

service_type_code

String

最大长度:64

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

响应示例

HTTP/1.1 200 OK
Content-Type: application/json;charset=UTF-8
Content-Length: length
Date: response time  
{
    "total_count": 1,
    "resource_types": [
        {
            "resource_type_code": "hws.resource.type.workspacehost.desktop",
            "resource_type_name": "云桌面",
            "resource_type_desc": "云桌面",
            "service_type_code": "hws.service.type.workspacehost"
         }
    ]
}

状态码

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

HTTP状态码

错误码

错误描述

400

CBC.0100

输入参数校验失败。

403

CBC.0151

访问拒绝。

500

CBC.0999

其他错误。