查询桶统计信息
更新时间 2025-12-18 14:21:36
最近更新时间: 2025-12-18 14:21:36
接口功能介绍
查询桶统计信息
1. 传bucket参数,表示查询该桶的统计信息
2. 不传bucket参数,表示查询所有桶的统计信息,即该用户所有桶的统计信息
统计项:
1). 每个小时累计的请求次数
2). 每个小时累计的公网流出流量
3). 每个小时累计的数据取回流量,仅在归档、低频存储类型时有此指标,归档的取回指归档对象解冻,低频的取回指低频对象的下载
4). 每个小时累计的数据取回次数,仅在归档、低频存储类型时有此指标,归档的取回指归档对象解冻,低频的取回指低频对象的下载
5). 存储容量在每个整点的值
6). 每个小时累计的跨域复制公网流出流量
计算方法:
1). 公网流出流量为通过公网调用GetObject接口访问、下载、预览文件或者进行图片处理操作产生的流量总值。
2). 请求次数为读操作API、写操作API和删除操作API的总值,其中,请求次数为公网请求数加内网请求数的总值。
接口约束
支持所有一类节点资源池。仅支持最近 30 天内的统计信息查询。
URI
GET /v4/oss/get-bucket-statistics
路径参数 无
Query参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| bucket | 否 | String | 存储桶名 | bucket1 | |
| regionID | 是 | String | 区域ID | 332232eb-63aa-465e-9028-52e5123866f0 | |
| startTime | 是 | String | 日期-小时 格式的时间字符串,时区为 UTC 时区 | 20230213-05 | |
| endTime | 是 | String | 日期-小时 格式的时间字符串,时区为 UTC 时区 | 20230213-07 |
请求参数
请求头header参数 无
请求体body参数 无
响应参数
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| statusCode | Long | 返回状态码(800为成功,900为处理中/失败) | 800 | |
| message | String | 状态描述 | SUCCESS | |
| description | String | 状态描述,一般为中文 | 成功 | |
| returnObj | Object | 响应对象 | returnObj | |
| errorCode | String | 业务细分码(仅失败时具有此参数),为 product.module.code 三段式码 | openapi.userPermission.accessFailed | |
| error | String | 业务细分码(大驼峰形式,仅失败时具有此参数),为 Product.Module.Code 三段式码 | Openapi.UserPermission.AccessFailed | |
| 表 returnObj |
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| storageTypeGlacier | Object | 归档存储类型数据,若不存在此存储类型则值为空对象 {} | storageTypeGlacier | |
| storageTypeIa | Object | 低频存储类型数据,若不存在此存储类型则值为空对象 {} | storageTypeIa | |
| storageTypeStandard | Object | 标准存储类型数据,若不存在此存储类型则值为空对象 {} | storageTypeStandard | |
| 表 storageTypeGlacier, storageTypeStandard, storageTypeIa |
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| opsRequest | Array of Objects | 指定时间范围内,每个小时累计的请求次数(单位:次) 比如20230213-05表示在20230213-05到20230213-06这个时段的值 | opsRequest | |
| bytesSend | Array of Objects | 指定时间范围内,每个小时累计的公网流出流量(单位:字节) 比如20230213-05表示在20230213-05到20230213-06这个时段的值 | bytesSend | |
| bytesRetrive | Array of Objects | 指定时间范围内,每个小时累计的数据取回流量(单位:字节) 比如20230213-05表示在20230213-05到20230213-06这个时段的值 仅在归档、低频存储类型有此指标 归档的取回指归档对象解冻,低频的取回指低频对象的下载 | bytesRetrive | |
| opsRetrive | Array of Objects | 指定时间范围内,每个小时累计的数据取回次数(单位:次) 比如20230213-05表示在20230213-05到20230213-06这个时段的值 仅在归档、低频存储类型有此指标 归档的取回指归档对象解冻,低频的取回指低频对象的下载 | opsRetrive | |
| bytesCross | Array of Objects | 指定时间范围内,每个小时累计的跨域复制公网流出流量(单位:字节) 比如20230322-05表示在20230213-05到20230213-06这个时段的值 | bytesCross | |
| 表 opsRequest, bytesSend, bytesRetrive, opsRetrive, bytesCross |
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| value | Long | 值 | 22 | |
| time | String | 日期-小时 格式的时间字符串,时区为 UTC 时区 | 20230213-05 |
枚举参数
无
请求示例
请求url
GET https://zos-global.ctapi.ctyun.cn/v4/oss/get-bucket-statistics?regionID=332232eb-63aa-465e-9028-52e5123866f0&bucket=bucket1&startTime=20231116-07&endTime=20231116-09
请求头header
无
请求体body
无
响应示例
{
"httpstatus": 200,
"httpresult": {
"returnObj": {
"storageTypeGlacier": {
"bytesCross": [
{
"value": 236,
"time": "20231116-07"
},
{
"value": 236,
"time": "20231116-08"
}
]
},
"storageTypeIa": {
"bytesCross": [
{
"value": 2581,
"time": "20231116-07"
},
{
"value": 2581,
"time": "20231116-08"
}
],
"bytesRetrive": [
{
"value": 2581,
"time": "20231116-07"
},
{
"value": 2581,
"time": "20231116-08"
}
],
"opsRetrive": [
{
"value": 1,
"time": "20231116-07"
},
{
"value": 1,
"time": "20231116-08"
}
]
},
"storageTypeStandard": {
"bytesCross": [
{
"value": 2601,
"time": "20231116-07"
},
{
"value": 2561,
"time": "20231116-08"
}
],
"opsRequest": [
{
"value": 39,
"time": "20231116-07"
},
{
"value": 5,
"time": "20231116-08"
}
]
}
},
"details": "",
"message": "SUCCESS",
"description": "成功",
"statusCode": 800
}
}
状态码
请参考 状态码
错误码
请参考 错误码