客户运营能力客户运营能力

更新时间:2021/09/08 GMT+08:00
分享

查询客户包年/包月资源列表

功能介绍

客户在自建平台查询某个或所有的包年/包月资源。

成功调用本接口后,如果您需要对已生效状态的资源进行续订,您可以调用“查询包年/包月产品价格”接口对查询到的包年/包月资源进行续订询价,然后再调用“续订包年/包月资源”接口进行续订。

接口约束

  • 该接口只允许客户的AK/SK或者Token调用。
  • 该接口只能查询开通成功的资源。

调试

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

URI

POST /v2/orders/suscriptions/resources/query

请求消息

请求参数

表1 请求参数

参数

是否必选

参数类型

取值范围

描述

resource_ids

list<String>

最大个数:50

资源ID列表。

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

说明:

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

order_id

String

最大长度:64

订单号。查询指定订单下的资源。

说明:

使用特殊字符进行查询的时候,请注意进行URL编码转换,如“%”的转码应为“%25”。

only_main_resource

Integer

[0|1]

是否只查询主资源,该参数对于请求参数是子资源ID的时候无效,如果resource_ids是子资源ID,只能查询自己。

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

默认值为0。

说明:

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

  • 对于ECS而言,虚拟机VM是主资源,磁盘EVS是辅资源。
  • 对于VPC而言,共享带宽的情况下,带宽为主资源,对应的从资源为弹性IP(可能包含多个IP);独享带宽的情况下,弹性IP为主资源,对应的从资源为带宽。

status_list

list<Integer>

最大个数:10

资源状态。

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

  • 2:使用中
  • 4:已冻结
  • 5:已过期

offset

Integer

[0-最大整数]

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

说明:

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

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

limit

Integer

[1-500]

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

请求示例

POST https://bss.myhuaweicloud.com/v2/orders/suscriptions/resources/query HTTP/1.1
Content-Type: application/json
X-Auth-TokenMIIPAgYJKoZIhvcNAQcCo...ggg1BBIINPXsidG9rZ
{
   "only_main_resource": 1,
   "offset": 0,
   "status_list": [
     2
     ],
   "limit": 10,
   "resource_ids": [
     "0A063A11905F42BC8548E65D0089A905"
     ],
   "order_id": "CS1905251035OA1AF"
}

响应消息

响应参数

参数

参数类型

描述

error_code

String

状态码。

具体请参见状态码

error_msg

String

错误描述信息。

data

List<OrderInstanceV2>

资源列表。

具体请参见表2

total_count

Integer

总记录数。

表2 OrderInstanceV2

参数

参数类型

描述

id

String

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

resource_id

String

资源ID。

resource_name

String

资源实例名。

region_code

String

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

service_type_code

String

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

resource_type_code

String

资源类型编码,例如ECS的VM为“hws.resource.type.vm”。您可以调用查询资源类型列表接口获取。

resource_spec_code

String

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

project_id

String

资源项目ID。

product_id

String

产品ID。

parent_resource_id

String

父资源ID。

is_main_resource

Integer

是否是主资源。

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

status

Integer

资源状态。状态说明请参见资源状态说明

  • 2:使用中
  • 3:已关闭(页面不展示这个状态)
  • 4:已冻结
  • 5:已过期

effective_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”。

expire_policy

Integer

资源到期后的扣费策略:

  • 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-54600027-0",
     "resource_id": "0A063A11905F42BC8548E65D0089A905",
     "resource_name": "0A063A11905F42BC8548E65D0089A905name",
     "region_code": "cn-south-1",
     "service_type_code": "hws.service.type.ebs",
     "resource_type_code": "hws.resource.type.volume",
     "resource_spec_code": "SSD",
     "project_id": "1dd89a5fe99e4cca80edca61e737477a",
     "product_id": "2fd338aca5ae4a01aac81deaa900e441",
     "parent_resource_id": "9ad02e1ad3394d1bb3da48890fbc4c06",
     "is_main_resource": 1,
     "status": 2,
     "effective_time": "2020-05-03T09:11:10Z",
     "expire_time": "2020-06-03T09:11:10Z",
     "expire_policy": 0
    }
   ],
  "total_count": 1
}

状态码

HTTP状态码

错误码

描述

400

CBC.0100

参数错误。

403

CBC.0151

访问拒绝。

500

CBC.0999

其他错误。

分享:

    相关文档

    相关产品