文档首页/ 合作伙伴中心/ API参考/ 管理交易/ 管理按需资源/ 查询客户按需资源列表
更新时间：2024-05-30 GMT+08:00
查看PDF
分享

查询客户按需资源列表

功能介绍

合作伙伴可以查询关联的代售类客户已开通的按需资源。

接口约束

  • 该接口只允许使用合作伙伴AK/SK或者Token调用。
  • 按需资源列表存在延时，各云服务延时时长不同，此接口数据仅供参考。

调试

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

URI

POST /v2/partners/sub-customers/on-demand-resources/query

表1 Header参数

参数

是否必选

取值范围

描述

X-Language

否

最大长度：8

语言。

  • 中文：zh_CN
  • 英文：en_US

缺省为zh_CN。

请求消息

请求参数

参数

是否必选

参数类型

取值范围

描述

customer_id

是

String

最大长度：64

客户账号ID。

您可以调用查询客户列表接口获取代售类customer_id。

region_code

否

String

最大长度：64

云服务区编码，例如：“cn-north-1”。具体请参见地区和终端节点对应云服务的“区域”列的值。

此参数不携带或携带值为空串或携带值为null时，不作为筛选条件。

service_type_code

否

String

最大长度：64

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

此参数不携带或携带值为空串或携带值为null时，不作为筛选条件。

resource_ids

否

List<Stirng>

列表最大长度：50

资源ID批量查询。

用于查询指定资源ID对应的资源，最多支持同时传递50个ID的列表。

此参数不携带或携带值为空列表或携带值为null时，不作为筛选条件。

effective_time_begin

否

String

最大长度：20

生效时间的开始时间。

UTC时间，格式：yyyy-MM-dd'T'HH:mm:ss'Z'，如“2019-05-06T08:05:01Z”。

其中，HH范围是0～23，mm和ss范围是0～59。

此参数不携带或携带值为空串或携带值为null时，不作为筛选条件。

effective_time_end

否

String

最大长度：20

生效时间的结束时间

UTC时间，格式：yyyy-MM-dd'T'HH:mm:ss'Z'，如“2019-05-06T08:05:01Z”。

其中，HH范围是0～23，mm和ss范围是0～59。

此参数不携带或携带值为空串或携带值为null时，不作为筛选条件。

offset

否

Integer

[0-最大整数]

偏移量，从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。

status

否

Integer

[1-6]

资源状态。

  • 1：正常（已开通）
  • 2：宽限期
  • 3：冻结中
  • 4：变更中
  • 5：正在关闭

此参数不携带或携带值为null时，不作为筛选条件。

indirect_partner_id

否

String

最大长度：64

云经销商ID。获取方法请参见查询云经销商列表。如果需要查询云经销商子客户的按需资源列表，必须携带该字段，除此之外，此参数不做处理。否则只能查询自己的子客户按需资源。

请求示例

POST https://bss.myhuaweicloud.com/v2/partners/sub-customers/on-demand-resources/query HTTP/1.1
Content-Type: application/json
X-Auth-Token：MIIPAgYJKoZIhvcNAQcCo...ggg1BBIINPXsidG9rZ
X-Language: zh_CN
{
    "indirect_partner_id": "051a8a834180d3fb0f25c006b1998800",
    "offset": 0,
    "limit": 10,
    "effective_time_begin": "2020-04-02T08:56:26Z",
    "effective_time_end": "2020-05-02T08:56:26Z",
    "customer_id": "0846606cf580d45f0fd6c01e10c07540",
    "service_type_code": "hws.service.type.ebs",
    "resource_ids": [
    "batch-volume-16380-00024604"
    ],
    "region_code": "cn-east-2",
    "status": 1
}

响应消息

响应参数

参数

参数类型

描述

error_code

String

状态码。具体请参见状态码。

error_msg

String

错误描述信息。

resources

List<CustomerResourceV2>

客户资源列表。

具体参见表2。

total_count

Integer

查询总数。
表2 CustomerResourceV2

参数

参数类型

描述

customer_id

String

客户账号ID。

region_code

String

云服务区编码，例如：“cn-north-1”。具体请参见地区和终端节点对应云服务的“区域”列的值。

availability_zone_code

String

所属可用区的编码。

service_type_code

String

云服务类型编码，例如OBS的云服务类型编码为“hws.service.type.obs”。

resource_type_code

String

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

service_type_name

String

云服务类型名称。例如ECS的云服务类型名称为“弹性云服务器”。

resource_type_name

String

资源类型名称。例如ECS的资源类型名称为“云主机”。

resource_id

String

资源ID。

resource_name

String

资源实例名称。

effective_time

String

生效时间。

UTC时间，格式：yyyy-MM-dd'T'HH:mm:ss'Z'，如“2019-05-06T08:05:01Z”。

其中，HH范围是0～23，mm和ss范围是0～59。

expire_time

String

失效时间。

UTC时间，格式：yyyy-MM-dd'T'HH:mm:ss'Z'，如“2019-05-06T08:05:01Z”。

其中，HH范围是0～23，mm和ss范围是0～59。

status

Integer

资源状态：

  • 1：正常（已开通）
  • 2：宽限期
  • 3：冻结中
  • 4：变更中
  • 5：正在关闭
  • 6：已关闭

resource_spec_code

String

云服务产品的资源规格。如果是VM的资源规格，则需要在规格后面添加“.win”或“.linux”，例如“s2.small.1.linux”。

resource_info

String

按需资源的容量大小。

格式如："resourceInfo": "{\"specSize\":40.0}"

product_spec_desc

String

产品规格描述。例如：

  • 虚拟机：“通用计算增强型|c6.2xlarge.4|8vCPUs|32GB|linux”
  • 硬盘：“云硬盘_SATA_LXH01|40.0GB”

响应示例

HTTP/1.1 200 OK
Content-Type: application/json;charset=UTF-8
Content-Length: length
Date: response time 
{
     "resources": [
     {
      "customer_id": "0846606cf580d45f0fd6c01e10c07540",
      "region_code": "cn-east-2",
      "availability_zone_code": "cn-east-2-a",
      "service_type_code": "hws.service.type.ebs",
      "resource_type_code": "hws.resource.type.volume",
      "resource_id": "batch-volume-16380-00024604",
      "resource_name": "batch-volume",
      "effective_time": "2020-04-02T08:56:26Z",
      "expire_time": "2020-05-02T08:56:26Z",
      "status": 1,
      "resource_spec_code": "SATA",
      "resource_info": "{\"specSize\":2235.0}",
      "product_spec_desc": "High IO|40.0GB"
      }
    ],
    "total_count": 1
}

状态码

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

HTTP状态码

错误码

描述

400

CBC.0100

参数错误

400

CBC.99000000

无对该客户的操作权限。

400

CBC.99000035

非合作伙伴子客户。

400

CBC.99000037

您没有操作该云经销商的权限。

403

CBC.0151

访问拒绝。

500

CBC.0999

其他错误。
父主题： 管理按需资源

相关文档