合作伙伴中心

本文导读

功能介绍
URI
请求消息
响应消息
状态码

展开导读

文档首页/ 合作伙伴中心/ API参考/

查询客户按需资源列表

更新时间：2024-01-02 GMT+08:00

查看PDF

功能介绍

客户在伙伴销售平台查询已开通的按需资源。（注：按需资源列表存在延时，各云服务延时时长不同，此接口数据仅供参考）

注意事项：

该接口只允许使用合作伙伴AK/SK或者Token调用。

说明：

该接口即将下线，“查询客户按需资源列表”接口请参考查询客户按需资源列表。

URI

POST /v1.0/{partner_id}/partner/customer-mgr/customer-resource/query-resources

参数说明请参见表1。

表1 URI参数说明
参数	是否必选	取值范围	描述
partner_id	是	最大长度：64	合作伙伴ID（华为分配）。获取方法请参见如何获取合作伙伴ID（partner_id）。

请求消息

请求参数

参数	是否必选	参数类型	取值范围	描述
customerResourceId	否	String	[1-64]	客户资源标识。用于查询指定资源的信息。此参数不携带或携带值为null时，不作为筛选条件；不支持携带值为空串。
customerId	是	String	[1-64]	客户账号ID。获取方法请参见如何获取客户的customer_id/domain_id。
regionCode	否	String	[1-64]	云服务区编码，例如：“ap-southeast-1”。具体请参见地区和终端节点对应云服务的“区域”列的值。此参数不携带或携带值为null时，不作为筛选条件；不支持携带值为空串。
cloudServiceTypeCode	否	String	[1-64]	云服务类型编码，例如OBS的云服务类型编码为“hws.service.type.obs”。您可以调用查询云服务类型列表接口获取。此参数不携带或携带值为null时，不作为筛选条件；不支持携带值为空串。
resourceTypeCode	否	String	[1-64]	资源类型编码，例如ECS的VM为“hws.resource.type.vm”。您可以调用查询资源类型列表接口获取。此参数不携带或携带值为null时，不作为筛选条件；不支持携带值为空串。
resourceIds	否	List<Stirng>	[0-50]	资源ID批量查询。用于查询指定资源ID对应的资源。最多支持同时传递50个Id的列表。此参数不携带或携带为空数组或携带值为null时，不作为筛选条件。
resourceName	否	String	[1-64]	资源实例名称。此参数不携带或携带值为null时，不作为筛选条件；不支持携带值为空串。
startTimeBegin	否	String	[1-64]	生效时间的开始时间。 UTC时间，格式：yyyy-MM-dd'T'HH:mm:ss'Z'，如“2019-05-06T08:05:01Z”。其中，HH范围是0～23，mm和ss范围是0～59。此参数不携带或携带值为null时，不作为筛选条件；不支持携带值为空串。
startTimeEnd	否	String	[1-64]	生效时间的结束时间 UTC时间，格式：yyyy-MM-dd'T'HH:mm:ss'Z'，如“2019-05-06T08:05:01Z”。其中，HH范围是0～23，mm和ss范围是0～59。此参数不携带或携带值为null时，不作为筛选条件；不支持携带值为空串。
pageNo	否	Integer	大于等于1的整数	当前页码。默认值：1 此参数不携带或携带值为空串或携带值为null时，取值为1。
pageSize	否	Integer	[1-100]	当页展示多少条，默认10条。此参数不携带或携带值为空串或携带值为null时，取值为10。

请求示例

POST https://bss-intl.myhuaweicloud.com/v1.0/{partner_id}/partner/customer-mgr/customer-resource/query-resources HTTP/1.1
Content-Type: application/json
X-Auth-Token：MIIPAgYJKoZIhvcNAQcCo...ggg1BBIINPXsidG9rZ

{
    "customerId": "3d2c6b3ab1fd4e26846b0f2c46e67bda",
    "regionCode": "cn-north-1",
    "cloudServiceTypeCode": "hws.service.type.ebs",
    "resourceTypeCode": "hws.resource.type.volume",
    "resourceIds":["71e3eeb5-4b77-44ae-9c42-119ee7976cf7","39d90d01-4774-4af6-8136-83ba5732bccf"],
    "startTimeBegin": "2018-06-01T11:00:00Z",
    "startTimeEnd":"2018-06-30T11:00:00Z"
}

响应消息

响应参数

参数	参数类型	描述
error_code	String	状态码。具体请参见状态码。
error_msg	String	错误描述信息。
customerResources	List<CustomerResource>	客户资源列表，具体参见表2。
totalCount	Integer	查询总数。

表2 CustomerResource
参数	参数类型	描述
customerResourceId	String	客户资源标识。
customerId	String	所属的客户ID。
regionCode	String	云服务区编码，例如：“ap-southeast-1”。具体请参见地区和终端节点对应云服务的“区域”列的值。
azCode	String	所属的AZ的编码。
cloudServiceTypeCode	String	云服务类型编码，例如OBS的云服务类型编码为“hws.service.type.obs”。您可以调用查询云服务类型列表接口获取。
resourceTypeCode	String	资源类型编码，例如ECS的VM为“hws.resource.type.vm”。您可以调用查询资源类型列表接口获取。
resourceId	String	具体资源的ID。
resourceName	String	资源实例的名称。
startTime	String	生效时间。 UTC时间，格式：yyyy-MM-dd'T'HH:mm:ss'Z'，如“2019-05-06T08:05:01Z”。其中，HH范围是0～23，mm和ss范围是0～59。
endTime	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：正在关闭。
resourceSpecCode	String	按需资源规格编码。
resourceInfo	String	资源容量大小。格式如："resourceInfo": "{\"specSize\":40.0}"
chargingModeChangeFlag	String	是否可以从按需计费转为包年/包月计费。 0：不能从按需到包年/包月转换； 1：可以从按需到包年/包月转换。说明：该字段已废弃不使用。
lastDeductType	String	资源的最后一次扣费账户类型： 0：华为云账户扣费（客户直接向华为充值）； 1：客户接受合作伙伴设置预算的账户扣费；为空时表示该资源没有扣费（记录）。

响应示例

HTTP/1.1 200 OK
Content-Type: application/json;charset=UTF-8
Content-Length: length
Date: response time 

{
  "totalCount": 2,
  "customerResources": [
    {
      "customerResourceId": "745b8963bb75409bb35f10d0e9c5cdf0",
      "customerId": "3d2c6b3ab1fd4e26846b0f2c46e67bda",
      "regionCode": "cn-north-1",
      "azCode": null,
      "cloudServiceTypeCode": "hws.service.type.ebs",
      "resourceTypeCode": "hws.resource.type.volume",
      "resourceId": "39d90d01-4774-4af6-8136-83ba5732bccf",
      "resourceName": null,
      "startTime": "2018-06-11T20:00:00Z",
      "endTime": null,
      "status": 3,
      "resourceSpecCode": "SAS",
      "resourceInfo": "{\"specSize\":50.0}",
      "chargingModeChangeFlag": "0",
      "lastDeductType": "1"
    },
    {
      "customerResourceId": "4d46e052379941d3b0d6cf34697b8ce7",
      "customerId": "3d2c6b3ab1fd4e26846b0f2c46e67bda",
      "regionCode": "cn-north-1",
      "azCode": null,
      "cloudServiceTypeCode": "hws.service.type.ebs",
      "resourceTypeCode": "hws.resource.type.volume",
      "resourceId": "71e3eeb5-4b77-44ae-9c42-119ee7976cf7",
      "resourceName": null,
      "startTime": "2018-06-11T20:00:00Z",
      "endTime": null,
      "status": 3,
      "resourceSpecCode": "SATA",
      "resourceInfo": "{\"specSize\":50.0}",
      "chargingModeChangeFlag": "0",
      "lastDeductType": "1"
    }
  ],
  "error_code": "CBC.0000",
  "error_msg": "success"
}

状态码

说明：

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

HTTP状态码	错误码	描述
200	CBC.0000	成功。
500	CBC.0999	其他错误。
400	CBC.0100	参数错误。
403	CBC.0151	访问拒绝。
200	CBC.5004	无对该客户的操作权限。

意见反馈

文档内容是否对您有帮助？

有帮助没帮助

提供反馈

提交成功！非常感谢您的反馈，我们会继续努力做到更好！

系统繁忙，请稍后重试

在使用文档中是否遇到以下问题

内容与产品页面不一致

内容不易理解

缺失示例代码

步骤不可操作

搜不到想要的内容

缺少最佳实践

意见反馈（选填）

0/500

请至少选择一项反馈信息并填写问题反馈

字符长度不能超过500

直接提交取消