合作伙伴中心-查询资源包列表:请求消息

时间:2024-05-23 13:59:17

请求消息

请求参数

参数

是否必选

参数类型

取值范围

描述

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]

状态:

  • 0:未生效
  • 1:生效中
  • 2:已用完
  • 3:已失效
  • 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。

请求示例

POST https://bss.myhuaweicloud.com/v3/payments/free-resources/query HTTP/1.1
Content-Type: application/json
X-Auth-TokenMIIPAgYJKoZIhvcNAQcCo...ggg1BBIINPXsidG9rZ
{
	"region_code": "cn-north-7",
	"order_id": " CS 21043011259RWXXTA",
	"product_id": "90301-296014-0--0",
	"product_name": "华为云 WeLink ",
	"enterprise_project_id": null,
	"status": 1,
	"offset": 0,
	"limit": 10
}

support.huaweicloud.com/api-bpconsole/api_order_00027.html