文档首页 > > API参考> 管理交易> 管理包周期订单> 查询客户包周期资源列表

查询客户包周期资源列表

分享
更新时间: 2019/11/15 GMT+08:00

功能介绍

客户在伙伴销售平台查询某个或所有的包周期资源。

注意事项:

  • 该接口只允许使用客户Token调用,不允许使用合作伙伴AK/SK或者Token调用。
  • 该接口只能查询开通成功的资源。
  • 成功调用本接口后,如果您需要对已生效状态的资源进行续订,您可以调用“根据产品规格查询价格”接口对查询到的包周期资源进行续订询价,然后再调用“续订包周期资源”接口进行续订。

URI

GET /v1.0/{domain_id}/common/order-mgr/resources/detail

参数说明请参见下表。

表1 路径参数

参数

是否必选

取值范围

描述

domain_id

最大长度:64

客户账号ID。获取方法请参见如何获取客户的customer_id/domain_id

表2 查询参数

参数

是否必选

参数类型

取值范围

描述

resource_ids

String

最大长度: 4096

资源ID列表。

查询指定资源ID的资源(当only_main_resource=0时,查询指定资源及其附属资源)。最大支持50个ID同时作为条件查询,多个ID以英文逗号分隔。

说明:

资源ID是指开通资源以后,云服务针对该资源分配的标志,譬如云主机ECS的server_id。

order_id

String

最大长度:64

订单号。

查询指定订单下的资源。

only_main_resource

Integer

[0|1]

是否只查询主资源。

  • 0:查询主资源及附属资源。
  • 1:只查询主资源。

默认值为0。

说明:

主资源是指有关联的几个资源中,处于主导位置的资源。

  • 对于ECS而言,虚拟机VM是主资源,磁盘EVS是辅资源。
  • 对于VPC而言,IP是主资源,带宽是辅资源。

status_list

String

[1-8]

资源状态。

查询指定状态的资源。多个状态以英文逗号分隔。

  • 1:初始化
  • 2:已生效
  • 3:已过期
  • 4:已冻结
  • 5:宽限期
  • 6:冻结中
  • 7:冻结恢复中(预留,未启用)
  • 8:正在关闭

page_no

Integer

大于等于1的整数

页码。

默认值是1。

page_size

Integer

[1-500]

每页条数。

默认值是10。最大值是500。

请求消息

请求参数

无。

请求示例

GET https://bss.myhuaweicloud.com/v1.0/3d2c6b3ab1fd4e26846b0f2c46e67bda/common/order-mgr/resources/detail?resource_ids=b38538a7-01ff-4ebc-ba47-ee682279262e,2498f7c4-ac2d-47e3-8729-a683d5755c07&only_main_resource=1&page_no=1&page_size=100 HTTP/1.1
Content-Type: application/json
X-Auth-TokenMIIPAgYJKoZIhvcNAQcCo...ggg1BBIINPXsidG9rZ

响应消息

响应参数

参数

参数类型

描述

error_code

String

状态码。

具体请参见状态码

error_msg

String

错误描述信息。

data

List<ResourceInstance>

资源列表。

具体请参见表3

total_count

Integer

总记录数。

默认是0。

表3 ResourceInstance

参数

参数类型

描述

id

String

标识要开通资源的内部ID,资源开通以后生成的ID为resourceID。

resource_id

String

资源实例ID。

resource_name

String

资源实例名。

region_code

String

云服务资源池区域编码。

cloud_service_type_code

String

云服务类型编码,例如ECS的云服务类型编码为“hws.service.type.ec2”。具体请参见云服务类型

resource_type_code

String

资源类型编码,例如ECS的VM为“hws.resource.type.vm”。具体请参见资源类型

resource_spec_code

String

云服务产品的资源规格,例如VM的资源规格举例为“s2.small.1.linux”。具体请参见订单管理支持的资源规格列表

project_code

String

资源项目ID。

product_id

String

产品ID。

main_resource_id

String

主资源ID。

is_main_resource

Integer

是否是主资源。

  • 0:非主资源
  • 1:主资源

status

Integer

资源状态:

  • 1 初始化
  • 2 已生效
  • 3 已过期
  • 4 已冻结
  • 5 宽限期

valid_time

String

资源生效时间。

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

expire_time

String

资源过期时间。

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

next_operation_policy

Integer

下一次扣费策略:

  • 0:到期进入宽限期
  • 1:到期转按需
  • 2:到期后自动删除(从生效中直接删除)
  • 3:到期后自动续费
  • 4:到期后冻结
  • 5:到期后删除(从保留期删除)
说明:

只有“3”表示该资源是自动续订,其他情况下,都是非自动续订下的到期策略。

响应示例

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

{
  "data": [
    {
      "id": "01154-21800069-0",
      "status": 2,
      "resource_id": "2498f7c4-ac2d-47e3-8729-a683d5755c07",
      "resource_name": "114.115.169.185",
      "region_code": "cn-north-1",
      "cloud_service_type_code": "hws.service.type.vpc",
      "resource_type_code": "hws.resource.type.ip",
      "resource_spec_code": "5_sbgp",
      "project_code": "3f0ba7064edd4a06849eef1c9d71a400",
      "product_id": "c1944e81eb214484992b1d925123a155",
      "main_resource_id": "2498f7c4-ac2d-47e3-8729-a683d5755c07",
      "is_main_resource": 1,
      "valid_time": "2018-04-26T18:03:03Z",
      "expire_time": "2018-06-27T15:59:59Z",
      "next_operation_policy":"3"
    },
    {
      "id": "01154-21800073-0",
      "status": 2,
      "resource_id": "b38538a7-01ff-4ebc-ba47-ee682279262e",
      "resource_name": "ecs-9f88-0001",
      "region_code": "cn-north-1",
      "cloud_service_type_code": "hws.service.type.ec2",
      "resource_type_code": "hws.resource.type.vm",
      "resource_spec_code": "s3.medium.2.linux",
      "project_code": "3f0ba7064edd4a06849eef1c9d71a400",
      "product_id": "00301-62057-0--0",
      "main_resource_id": "b38538a7-01ff-4ebc-ba47-ee682279262e",
      "is_main_resource": 1,
      "valid_time": "2018-04-26T18:02:33Z",
      "expire_time": "2018-06-27T15:59:59Z",
      "next_operation_policy":"3"
    }
  ],
  "error_code": "CBC.0000",
  "error_msg": "success",
  "total_count": 2
}

状态码

状态码

描述

CBC.0000

成功。

CBC.0100

输入参数校验失败。

CBC.0151

访问拒绝。

CBC.0999

其他错误。

分享:

    相关文档

    相关产品

文档是否有解决您的问题?

提交成功!

非常感谢您的反馈,我们会继续努力做到更好!

反馈提交失败,请稍后再试!

*必选

请至少选择或填写一项反馈信息

字符长度不能超过200

提交反馈 取消

如您有其它疑问,您也可以通过华为云社区问答频道来与我们联系探讨

跳转到云社区