查询客户包年/包月资源列表(旧)
功能介绍
客户在自建平台查询某个或所有的包年/包月资源。
注意事项:
- 该接口允许客户的AK/SK或者Token调用。
- 该接口只能查询开通成功的资源。
URI
GET /v1.0/{domain_id}/common/order-mgr/resources/detail
参数说明请参见下表。
参数 |
是否必选 |
取值范围 |
描述 |
---|---|---|---|
domain_id |
是 |
最大长度:64 |
客户账号ID。获取方法请参见如何获取客户的customer_id/domain_id。 |
参数 |
是否必选 |
参数类型 |
取值范围 |
描述 |
---|---|---|---|---|
resource_ids |
否 |
String |
最大长度: 4096 |
资源ID列表。 查询指定资源ID的资源(当only_main_resource=0时,查询指定资源及其附属资源)。最大支持50个ID同时作为条件查询,多个ID以英文逗号分隔。 此参数不携带、携带空时不参与过滤;携带值为空串、null参与过滤。
说明:
资源ID是指开通资源以后,云服务针对该资源分配的标志,譬如云主机ECS的server_id。 |
order_id |
否 |
String |
最大长度:64 |
订单号。 查询指定订单下的资源。 此参数不携带、携带为空时不参与过滤;携带值为空串、携带为null参与过滤。 |
only_main_resource |
否 |
Integer |
[0|1] |
是否只查询主资源,该参数对于请求参数是子资源ID的时候无效,如果resource_ids是子资源ID,只能查询自己。
默认值为0。 此参数不携带、携带值为空、携带为null取默认值0;不支持携带为空串。
说明:
主资源是指有关联的几个资源中,处于主导位置的资源。
|
status_list |
否 |
String |
- |
资源状态。 查询指定状态的资源。多个状态以英文逗号分隔。
此参数不携带、携带为空时返回所有状态的资源数据;不支持携带值为空串、携带为null。 |
page_no |
否 |
Integer |
大于等于1的整数 |
页码。 默认值是1。 此参数不携带、携带值为空、携带为null时取默认值1;不支持携带值为空串。 |
page_size |
否 |
Integer |
[1-500] |
每页条数。 默认值是10。最大值是500。 此参数不携带、携带值为空、携带为null时取默认值10;不支持携带值为空串。 |
请求消息
请求参数
无。
请求示例
GET https://bss-intl.myhuaweicloud.com/v1.0/{domain_id}/common/order-mgr/resources/detail?resource_ids=b38*****62e,249*****c07&only_main_resource=1&page_no=1&page_size=100 HTTP/1.1 Content-Type: application/json X-Auth-Token:MIIPAgYJKoZIhvcNAQcCo...ggg1BBIINPXsidG9rZ
响应消息
响应参数
参数 |
参数类型 |
描述 |
---|---|---|
error_code |
String |
状态码。 具体请参见状态码。 |
error_msg |
String |
错误描述信息。 |
data |
List<ResourceInstance> |
资源列表。 具体请参见表3。 |
total_count |
Integer |
总记录数。 默认是0。 |
参数 |
参数类型 |
描述 |
---|---|---|
id |
String |
标识要开通资源的内部ID,资源开通以后生成的ID为resourceID。 |
resource_id |
String |
资源ID。 |
resource_name |
String |
资源实例名。 |
region_code |
String |
云服务资源池区域编码。 |
cloud_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”。 |
project_code |
String |
资源项目ID。 |
product_id |
String |
产品ID。 |
main_resource_id |
String |
主资源ID。 |
is_main_resource |
Integer |
是否是主资源。
|
status |
Integer |
资源状态。
|
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 |
下一次扣费策略:
说明:
只有“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": "249*****c07", "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": "3f*****400", "product_id": "c1*****55", "main_resource_id": "249*****c07", "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": "b3*****62e", "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": "3f*****400", "product_id": "00301-62057-0--0", "main_resource_id": "b38*****62e", "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 }