查询客户包年/包月资源列表
功能介绍
客户在自建平台查询某个或所有的包年/包月资源。
接口约束
- 该接口只允许客户的AK/SK或者Token调用。
- 该接口只能查询开通成功的资源。
- 如果参数为空，包括未传参、传值为null、传值为空json数组、传值为空串，则返回当前用户一定数量（limit所指定的数量，默认为10）的资源列表。
调试
您可以在API Explorer中调试该接口。
URI
POST /v2/orders/suscriptions/resources/query
请求消息
请求参数
|
参数 |
是否必选 |
参数类型 |
取值范围 |
描述 |
|---|---|---|---|---|
|
resource_ids |
否 |
list<String> |
[0-50] |
资源ID列表。 查询指定资源ID的资源（当only_main_resource=0时，查询指定资源及其附属资源）。最大支持50个ID同时作为条件查询。 此参数不携带或携带值为空列表或携带值为null时，不作为筛选条件，返回其他条件匹配的记录。
说明：
资源ID是指开通资源以后，云服务针对该资源分配的标志，譬如云主机ECS的资源ID是server_id。 |
|
order_id |
否 |
String |
最大长度：64 |
订单号。查询指定订单下的资源。 此参数不携带或携带值为空串或携带值为null时，不作为筛选条件，返回其他条件匹配的记录。
说明：
使用特殊字符进行查询的时候，请注意进行URL编码转换，如“%”的转码应为“%25”。 |
|
only_main_resource |
否 |
Integer |
[0|1] |
是否只查询主资源，该参数对于请求参数是子资源ID的时候无效，如果resource_ids是子资源ID，只能查询自己。
默认值为0。 此参数不携带或携带值为null时，取默认值0。
说明：
主资源是指有关联的几个资源中，处于主导位置的资源。
|
|
status_list |
否 |
list<Integer> |
[0-10] |
资源状态。 查询指定状态的资源。多个状态以英文逗号分隔。
此参数不携带或携带值为空列表或携带值为null时，不作为筛选条件，返回所有状态的资源列表。 |
|
offset |
否 |
Integer |
[0-2147483646] |
偏移量，从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-500] |
每次查询的条数。默认值为10。 |
|
expire_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时，不作为筛选条件，返回其他条件匹配的记录。 |
|
expire_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时，不作为筛选条件，返回其他条件匹配的记录。 |
|
service_type_code |
否 |
String |
最大长度：64 |
云服务类型编码，例如OBS的云服务类型编码为“hws.service.type.obs”。您可以调用查询云服务类型列表接口获取。 此参数不携带、携带值为null，不作为筛选条件。此参数不允许为空串，有参数校验。 |
请求示例
POST https://bss.myhuaweicloud.com/v2/orders/suscriptions/resources/query HTTP/1.1 Content-Type: application/json X-Auth-Token：MIIPAgYJKoZIhvcNAQcCo...ggg1BBIINPXsidG9rZ { "resource_ids":[ "0A063A********BC8548E65D0089A905" ], "order_id":"CS1905251035OA***", "only_main_resource":1, "status_list":[ 2 ], "offset":0, "limit":10, "expire_time_begin":"2021-09-01T08:05:01Z", "expire_time_end":"2021-09-03T08:05:01Z", "service_type_code": "hws.service.type.obs" }
响应消息
响应参数
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
error_code |
String |
状态码。 具体请参见状态码。 |
|
error_msg |
String |
错误描述信息。 |
|
data |
List<OrderInstanceV2> |
资源列表。 具体请参见表2。 |
|
total_count |
Integer |
总记录数。 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
id |
String |
标识要开通资源的内部ID，资源开通以后生成的ID为resource_id。 |
|
resource_id |
String |
资源ID。 |
|
resource_name |
String |
资源实例名。 |
|
region_code |
String |
云服务区编码，例如：“cn-north-1”。具体请参见地区和终端节点对应云服务的“区域”列的值。 |
|
service_type_code |
String |
云服务类型编码，例如OBS的云服务类型编码为“hws.service.type.obs”。 |
|
resource_type_code |
String |
资源类型编码，例如ECS的VM为“hws.resource.type.vm”。 |
|
resource_spec_code |
String |
云服务产品的资源规格。如果是VM的资源规格，则需要在规格后面添加“.win”或“.linux”，例如“s2.small.1.linux”。 |
|
service_type_name |
String |
云服务类型名称。例如ECS的云服务类型名称为“弹性云服务器”。 |
|
resource_type_name |
String |
资源类型名称。例如ECS的资源类型名称为“云主机”。 |
|
project_id |
String |
资源项目ID。 |
|
product_id |
String |
产品ID。 |
|
parent_resource_id |
String |
父资源ID。 |
|
is_main_resource |
Integer |
是否是主资源。
|
|
status |
Integer |
资源状态。状态说明请参见资源状态说明。
|
|
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 |
资源到期后的扣费策略：
说明：
只有“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-north-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
}
