接口功能介绍
调用本接口查询流量包详情
使用说明
单个用户一分钟限制调用10000次,并发不超过100。
接口详情
请求方式:get
请求路径:/usage-management/query-resource-package-list
请求参数
参数名 | 类型 | 是否必填 | 名称 | 说明 |
---|---|---|---|---|
product_code | string | 否 | 产品类型 | 支持产品类型:“005”(视频直播)。支持传多个,用逗号隔开。 |
start_date | string | 否 | 开通时间 | 日期格式:‘%Y-%m-%d’,例如:“2022-09-30”,不传没有生效时间限制 |
end_date | string | 否 | 到期时间 | 日期格式:‘%Y-%m-%d’,例如:“2022-10-30”,不传没有结束时间限制 |
page | int | 否 | 查询分页编号 | 不传默认为1 |
page_size | int | 否 | 分页大小 | 不传默认为10 |
field_sort | string | 否 | 时间排序方式 | eff_date(按生效时间排序);exp_date(按失效时间排序) |
order_sort | string | 否 | 排序规则 | asc(升序);desc(降序)。不传默认降序。 |
响应参数
参数 | 类型 | 是否必传 | 名称及描述 |
---|---|---|---|
code | int | 是 | 状态码 |
message | string | 是 | 描述信息 |
data | object | 否 | 返回结果 |
data.count | string | 否 | 返回结果的个数 |
data.previous | string | 否 | 分页上页页码数 |
data.next | string | 否 | 分页下页页码数 |
data.result | list< object> | 否 | 返回结果列表 |
data.result[*].product_code | string | 否 | 产品编码 |
data.result[*].start_time | string | 否 | 开通时间 |
data.result[*].end_time | string | 否 | 到期时间 |
data.result[*].packet_id | string | 否 | 资源包编号 |
data.result[*].resource_type | int | 否 | 资源类型,1(流量包) |
data.result[*].packet_size | int | 否 | 资源包大小,资源类型为流量包,单位为GB |
data.result[*].used_num | string | 否 | 已使用量,资源类型为流量包,单位为GB |
data.result[*].resource_name | string | 否 | 资源包名称 |
data.result[*].status | int | 否 | 资源包状态,1(未使用);2(使用中);3(流量用完);4(到期);5(关停);6(退订);7(冻结) |
示例
请求路径:https://cdnapi-global.ctapi.ctyun.cn/usage-management/query-resource-package-list
请求示例
请求:https://cdnapi-global.ctapi.ctyun.cn/usage-management/query-resource-package-list?start_date=2022-04-01&end_date=2022-09-27&product_code=005
正确响应示例
{
"code": 100000,
"message": "success",
"data": {
"result": [
{
"start_time": "2022-05-16 00:00:00",
"packet_id": "39f86576e1c64fbda1bd1a934da47565",
"packet_size": 1000,
"end_time": "2022-06-16 23:59:59",
"resource_type": 1,
"used_num": "1000.00",
"product_code": "005",
"resource_name": "视频直播流量包(中国内地)",
"status": 4
},
{
"start_time": "2022-05-16 00:00:00",
"packet_id": "3a94944f768f4c70b508b0b95bc2aad9",
"packet_size": 1000,
"end_time": "2022-06-16 23:59:59",
"resource_type": 1,
"used_num": "1000.00",
"product_code": "005",
"resource_name": "视频直播流量包(中国内地)",
"status": 4
}
],
"count": "2"
}
}