# 查询客户包年/包月资源列表-ListPayPerUseCustomerResources #### 功能介绍 客户在自建平台查询某个或所有的包年/包月资源。 ![](https://support.huaweicloud.com/api-oce/public_sys-resources/note_3.0-zh-cn.png) 成功调用本接口后，如果您需要对已生效状态的资源进行续订，您可以调用"[查询包年/包月产品价格-ListRateOnPeriodDetail](https://support.huaweicloud.com/api-oce/bcloud_01002.html)"接口对查询到的包年/包月资源进行续订询价，然后再调用"[续订包年/包月资源-RenewalResources](https://support.huaweicloud.com/api-oce/api_order_00018.html)"接口进行续订。 #### 接口约束 - 该接口只允许客户的AK/SK或者Token调用。 - 该接口只能查询开通成功的资源。 - 如果参数为空，包括未传参、传值为null、传值为空json数组、传值为空串，则返回当前用户一定数量（limit所指定的数量，默认为10）的资源列表。 #### 调试 您可以在[API Explorer](https://apiexplorer.developer.huaweicloud.com/apiexplorer/doc?product=BSS&api=ListPayPerUseCustomerResources)中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。 #### 授权信息 账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。 - 如果使用角色与策略授权，具体权限要求请参见[策略授权参考](https://support.huaweicloud.com/api-oce/jac_000053.html)。 - 如果使用身份策略授权，需具备如下身份策略权限。 | 授权项 | 描述 | 访问级别 | 资源类型（\*为必须） | 条件键 | 别名 | |:---|:---|:---|:---|:---|:---| | billing:subscription:view | 授予查看续费管理信息，查询可按需转包年/包月资源列表的权限。 | read | - | - | - | #### URI POST /v2/orders/suscriptions/resources/query #### 请求消息 **请求参数** 表1请求参数 | 参数 | 是否必选 | 参数类型 | 取值范围 | 描述 | |:---|:---|:---|:---|:---| | resource_ids | 否 | list\ | \[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：查询主资源及附属资源。 - 1：只查询主资源。 默认值为0。 此参数不携带或携带值为null时，取默认值0。 说明： 主资源是指有关联的几个资源中，处于主导位置的资源。 - 对于ECS而言，虚拟机VM是主资源，磁盘EVS是辅资源。 - 对于VPC而言，共享带宽的情况下，带宽为主资源，对应的从资源为弹性IP（可能包含多个IP）；独享带宽的情况下，弹性IP为主资源，对应的从资源为带宽。 | | status_list | 否 | list\ | \[0-10\] | 资源状态。 查询指定状态的资源。多个状态以英文逗号分隔。 - 2：使用中 - 3：已关闭 - 4：已冻结 - 5：已过期 此参数不携带或携带值为空列表或携带值为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"。您可以调用[查询云服务类型列表](https://support.huaweicloud.com/api-oce/zh-cn_topic_0000001256679455.html)接口获取。 此参数不携带、携带值为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\ | 资源列表。 具体请参见[表2]。 | | total_count | Integer | 总记录数。 | 表2OrderInstanceV2 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | id | String | 标识要开通资源的内部ID，资源开通以后生成的ID为resource_id。 | | resource_id | String | 资源ID。 | | resource_name | String | 资源实例名。 | | region_code | String | 云服务区编码，例如："cn-north-1"。具体请参见[地区和终端节点](https://developer.huaweicloud.com/endpoint)对应云服务的"区域"列的值。 | | 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 | 是否是主资源。 - 0：非主资源 - 1：主资源 | | status | Integer | 资源状态。状态说明请参见[资源状态说明](https://support.huaweicloud.com/usermanual-billing/renewals_topic_90000001.html)。 - 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 | 资源到期后的扣费策略： - 0：到期进入宽限期 - 1：到期转按需 - 2：到期后自动删除（从生效中直接删除） - 3：到期后自动续费 - 4：到期后冻结 - 5：到期后删除（从保留期删除） 说明： 只有"3"表示该资源是自动续订，其他情况下，都是非自动续订下的到期策略。 | | product_spec_desc | String | 最大长度：512 产品的规格描述。 | | spec_size | BigDecimal | 产品的实例大小，仅线性产品有效。 说明： 线性产品是指订购时需要指定大小的产品。例如硬盘在订购时需选择10G、20G等不同大小规格。 | | spec_size_measure_id | Integer | 产品实例大小的单位，仅线性产品有该字段。 您可以调用[查询度量单位列表-ListMeasureUnits](https://support.huaweicloud.com/api-oce/qct_00006.html)接口获取。 | | update_time | String | 资源更新时间。 UTC时间，格式：yyyy-MM-dd'T'HH:mm:ss'Z'，如"2019-05-06T08:05:01Z"。 说明： 交易场景资源会更新，更新时间会发生变化，如：开通、退订、变更等。其他非交易的场景，如启停机器等，更新时间不会变化。 | | enterprise_project | EnterpriseProject Object | 客户资源企业项目详情信息。 具体请参见[表 EnterpriseProject]。 | 表3EnterpriseProject | 参数 | 参数类型 | 取值范围 | 描述 | |:---|:---|:---|:---| | id | String | 最大长度：256 | 企业项目id。 | | name | String | 最大长度：256 | 企业项目名称。 | **响应示例** ``` HTTP/1.1 200 OK Content-Type: application/json;charset=UTF-8 Content-Length: length Date: response time { "data": [ { "id": "01154-674800049-0", "resource_id": "fb8bb160-a8eb-46a7-9a01-82479c4342a8", "resource_name": "bandwidth-48d0", "region_code": "cn-north-7", "service_type_code": "hws.service.type.vpc", "resource_type_code": "hws.resource.type.bandwidth", "resource_type_name": "固定带宽", "service_type_name": "虚拟私有云", "resource_spec_code": "19_share", "project_id": "0bce3f009100d2852fd6c009e942d2ef", "product_id": "OFFI771277187766575104", "parent_resource_id": "fb8bb160-a8eb-46a7-9a01-82479c4342a8", "is_main_resource": 1, "status": 3, "effective_time": "2024-10-10T07:45:56Z", "expire_time": "2024-11-22T09:01:54Z", "expire_policy": 0, "product_spec_desc": "共享带宽|5.0Mbps", "spec_size": 5.0, "spec_size_measure_id": 15, "update_time": "2024-11-22T09:01:55Z", "enterprise_project": { "id": "0", "name": "default" } } ], "total_count": 1 } ``` #### 状态码 ![](https://support.huaweicloud.com/api-oce/public_sys-resources/note_3.0-zh-cn.png) - 状态码4xx：由于明显的客户端错误（例如，格式错误的请求语法、参数错误等），华为云会返回4xx错误码，请及时检查请求消息的正确性，重新发起请求。 - 状态码5xx：由于华为云系统原因，导致无法完成明显有效请求的处理，可及时联系华为云客服处理。 | HTTP状态码 | 错误码 | 描述 | |:---|:---|:---| | 400 | CBC.0100 | 参数错误。 | | 403 | CBC.0151 | 访问拒绝。 | | 500 | CBC.0999 | 其他错误。 |