查询资源包列表
接口约束
该接口只允许客户的AK/SK或者Token调用。
资源包失效时间超过18个月则无法查询其信息。
调试
您可以在API Explorer中调试该接口。
URI
POST /v3/payments/free-resources/query
|
参数 |
是否必选 |
取值范围 |
描述 |
|---|---|---|---|
|
X-Language |
否 |
最大长度：8 |
语言。
缺省为zh_CN。 |
请求消息
请求参数
|
参数 |
是否必选 |
参数类型 |
取值范围 |
描述 |
|---|---|---|---|---|
|
region_code |
否 |
String |
最大长度：64 |
云服务区编码，例如：“cn-north-1”。具体请参见地区和终端节点对应云服务的“区域”列的值。 此参数不携带或携带值为空串或携带值为null时，不作为筛选条件。 |
|
order_id |
否 |
String |
最大长度：64 |
订单ID。 此参数不携带或携带值为空串或携带值为null时，不作为筛选条件。 |
|
product_id |
否 |
String |
最大长度：64 |
产品ID，即资源包ID。 此参数不携带或携带值为空串或携带值为null时，不作为筛选条件。 |
|
product_name |
否 |
String |
最大长度：256 |
产品名称，即资源包名称。 此参数不携带或携带值为空串或携带值为null时，不作为筛选条件。 |
|
enterprise_project_id |
否 |
String |
最大长度：64 |
企业项目ID。 如需查询企业项目下的资源列表，必须携带该参数； 若参数不携带或携带值为空串或携带值为null时，查询除企业项目外的其他所有资源列表。 |
|
status |
否 |
Integer |
[0-4] |
状态：
此参数不携带或携带值为空串或携带值为null时，不作为筛选条件。 |
|
offset |
否 |
Integer |
[0-999999] |
偏移量，从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-1000] |
每次查询的记录数，默认为10。 |
|
service_type_code_list |
否 |
List<String> |
[0-10] |
云服务类型编码列表，大小写不敏感。 例如OBS的云服务类型编码为“hws.service.type.obs”。您可以调用查询云服务类型列表接口获取。 此参数不携带或携带值为空列表或携带值为null时，不作为筛选条件，返回其他条件匹配的记录。 |
请求示例
POST https://bss.myhuaweicloud.com/v3/payments/free-resources/query HTTP/1.1 Content-Type: application/json X-Auth-Token：MIIPAgYJKoZIhvcNAQcCo...ggg1BBIINPXsidG9rZ { "region_code": "cn-north-7", "order_id": "CS21043011259RWXXTA", "product_id": "90301-296014-0--0", "product_name": "华为云WeLink", "enterprise_project_id": null, "status": 1, "offset": 0, "limit": 10, "service_type_code_list": [ "hws.service.type.obs", "hws.service.type.vpc" ] }
响应消息
响应参数
|
参数 |
参数类型 |
取值范围 |
描述 |
|---|---|---|---|
|
error_code |
String |
20 |
状态码。 具体请参考状态码。只有失败才返回该字段。 |
|
error_msg |
String |
1000 |
错误描述信息。只有失败才返回该字段。 |
|
free_resource_packages |
List<FreeResourcePackage> |
- |
资源包信息列表，具体参见表2。 |
|
total_count |
Integer |
- |
总条数。 |
|
参数 |
参数类型 |
取值范围 |
描述 |
|---|---|---|---|
|
order_instance_id |
String |
最大长度：64 |
订购资源包产品后，系统生成的ID，是这个资源包列表的标识字段。 |
|
order_id |
String |
最大长度：64 |
订单ID，如果source_type为“1：软开云赠送”，该字段为空。 |
|
product_id |
String |
最大长度：64 |
产品ID，即资源包ID。 |
|
product_name |
String |
最大长度：256 |
产品名称，即资源包名称。 |
|
enterprise_project_id |
String |
最大长度：64 |
企业项目ID。 |
|
enterprise_project_scope |
Integer |
[0-1] |
企业项目应用范围：
|
|
effective_time |
String |
最大长度：20 |
生效时间，购买资源包的时间，格式UTC。 |
|
expire_time |
String |
最大长度：20 |
失效时间，资源包到期时间，格式UTC。 |
|
status |
Integer |
[0-4] |
状态：
|
|
service_type_code |
String |
最大长度：64 |
云服务类型编码，例如OBS的云服务类型编码为“hws.service.type.obs”。 |
|
service_type_name |
String |
最大长度：200 |
云服务类型名称。例如ECS的云服务类型名称为“弹性云服务器”。 |
|
region_code |
String |
最大长度：64 |
云服务区编码，例如：“cn-north-1”。具体请参见地区和终端节点对应云服务的“区域”列的值。 |
|
source_type |
Integer |
[0-1] |
资源包的来源类型：
|
|
bundle_type |
String |
[ATOMIC_PKG|BUNDLE_PKG] |
套餐绑定类型：
|
|
quota_reuse_mode |
Integer |
[1-2] |
使用模式。 |
|
free_resources |
List<FreeResource> |
- |
资源套餐内的资源项信息（资源项ID级的详情），具体参见表3。 |
|
参数 |
参数类型 |
取值范围 |
描述 |
|---|---|---|---|
|
free_resource_id |
String |
最大长度：64 |
资源项ID，一个资源包中会含有多个资源项，一个使用量类型对应一个资源项。 |
|
usage_type_name |
String |
最大长度：1024 |
使用量类型名称。 |
|
amount |
String |
最大长度：32 |
资源剩余额度，针对可重置资源包，是指当前重置周期内的剩余量。 |
|
original_amount |
String |
最大长度：32 |
资源原始额度，针对可重置资源包，是指每个重置周期内的总量。 |
|
measure_id |
Integer |
- |
度量单位，免费资源套餐额度度量单位。您可以调用查询度量单位列表接口获取。 |
响应示例
HTTP/1.1 200 OK
Content-Type: application/json;charset=UTF-8
Content-Length: length
Date: response time
{
"total_count": 1,
"free_resource_packages": [
{
"order_instance_id": "01154-228300268-0",
"order_id": "CS21043011259RWXXTA",
"product_id": "90301-296014-0--0",
"product_name": "华为云WeLink",
"enterprise_project_id": null,
"enterprise_project_scope": 0,
"effective_time": "2021-04-30T03:30:56Z",
"expire_time": "2021-05-31T15:59:59Z",
"status": 1,
"service_type_code": "hws.service.type.cpts",
"region_code": "cn-north-7",
"source_type": 0,
"bundle_type": "ATOMIC_PKG",
"quota_reuse_mode": 2,
"free_resources": [
{
"free_resource_id": "d4463497-991b-439d-9ab6-23f9ed197fe9",
"usage_type_name": "时长",
"amount": 100,
"original_amount": 100,
"measure_id": 34
}
]
}
]
}
