接口功能介绍
根据指定区域及指定桶查询桶流量。
接口约束
无
URI
GET /v1/bucket/flow
路径参数
无
Query参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| regionCode | 是 | String | 区域编码。 | 0001 | |
| buckets | 否 | String | 存储桶名。1. 支持同时查询多个桶，如果请求中指定桶名查询，则返回具体存储桶的流量数据。2. 不指定则返回该存储区域的流量总数。 | buckets=bt1，bt2 | |
| startTime | 是 | Long | 查询起始时间，时间戳，ms单位。 | 1683684845051 | |
| endTime | 是 | Long | 查询结束时间，时间戳，ms单位。 | 1683684845051 |
请求参数
请求头header参数
无
请求body参数
无
响应参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| statusCode | 是 | Integer | 本次请求的结果码。 | 0 | |
| error | 是 | String | 错误码，创建成功时，不返回该字段。 | ||
| message | 是 | String | 错误文本信息，创建成功时，为空字符串。 | ||
| returnObj | 是 | String | 返回结果。 | -- | returnObj |
表 returnObj
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| code | 是 | String | 返回码。 | 0 | |
| data | 是 | Object | 返回数据。 | storageClass | |
| message | 是 | String | 返回消息。 | OK |
表 storageClass
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| standard | 是 | Array of Objects | 标准存储分类流量统计值。 | item | |
| standardIA | 是 | Array of Objects | 低频存储分类流量统计值。 | item | |
| glacier | 是 | Array of Objects | 归档存储分类流量统计值。 | item |
表 item
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| timestamp | 是 | Long | 分级分类流量统计值时间戳。 | 1586430000000 | |
| value | 是 | Object | 分类流量统计值。 | component |
表 component
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| publicUpStream | 是 | Integer | 公网上行流量统计值，单位byte。 | 82739727 | |
| privateDownStream | 是 | Integer | 内网下行流量统计值，单位byte。 | 82739727 | |
| privateUpStream | 是 | Integer | 内网上行流量统计值，单位byte。 | 82739727 | |
| publicDownStream | 是 | Integer | 公网下行流量统计值，单位byte。 | 82739727 | |
| cdnsourceUpStream | 是 | Integer | cdn上行流量统计值，单位byte。 | 0 | |
| cdnsourceDownStream | 是 | Integer | cdn下行流量统计值，单位byte。 | 0 |
请求示例
GET /v1/bucket/flow?regionCode=0001&buckets=bt1,bt2&startTime=1683684845051&endTime=1683684845051
请求头header
无
请求体body
无
响应示例
{
"statusCode": "0",
"message": "",
"returnObj": {
"code": "0",
"message": "",
"data": {
"standard": [
{
"timestamp": 1586430000000,
"value": {
"publicUpStream": 82739727,
"privateDownStream": 87328729,
"privateUpStream": 0,
"publicDownStream": 0,
"cdnsourceUpStream": 0,
"cdnsourceDownStream": 0
}
}
],
"standardIA": [
{
"timestamp": 1586430000000,
"value": {
"publicUpStream": 0,
"privateDownStream": 0,
"privateUpStream": 0,
"publicDownStream": 0,
"cdnsourceUpStream": 82739727,
"cdnsourceDownStream": 87328729
}
}
],
"glacier": [
{
"timestamp": 1586430000000,
"value": {
"publicUpStream": 0,
"privateDownStream": 0,
"privateUpStream": 0,
"publicDownStream": 0,
"cdnsourceUpStream": 82739727,
"cdnsourceDownStream": 87328729
}
}
]
}
}
}
状态码
| 状态码 | 描述 |
|---|---|
| 0 | 表示业务成功。 |
| 400 | 请求参数有误。 |
| 403 | 用户鉴权失败，用户无操作权限。 |
| 404 | 请求的资源不存在，输入作物的URL。 |
| 500 | 业务执行异常。 |
