接口介绍
查询桶统计信息
- 传bucket参数,表示查询该桶的统计信息
- 不传bucket参数,表示查询所有桶的统计信息,即该用户所有桶的统计信息
统计项:
1). 每个小时累计的请求次数
2). 每个小时累计的公网流出流量
3). 每个小时累计的数据取回流量,仅在归档、低频存储类型时有此指标,归档的取回指归档对象解冻,低频的取回指低频对象的下载
4). 每个小时累计的数据取回次数,仅在归档、低频存储类型时有此指标,归档的取回指归档对象解冻,低频的取回指低频对象的下载
5). 存储容量在每个整点的值
6). 每个小时累计的跨域复制公网流出流量
计算方法:
1). 请求次数、公网流出流量为读API加写API的总值:
读API:'list_buckets', 'list_bucket', 'stat_bucket', 'get_obj', 'get_acls', 'get_cors', 'list_bucket_multiparts', 'list_multipart'
写API:'create_bucket', 'delete_bucket', 'put_obj', 'put_acls', 'put_cors', 'delete_cors', 'delete_obj', 'init_multipart', 'put_obj', 'complete_multipart', 'abort_multipart'
其中,请求次数为公网请求数加内网请求数的总值。
接口约束
支持的线上资源池 :上海7、南京3、南京5、杭州2、合肥2、九江、广州6、武汉4、福州25、厦门3、郴州2、海口2、北京5、雄安2、石家庄20、内蒙6、晋中、辽阳1、西安5、乌鲁木齐4、乌鲁木齐27、中卫5、兰州2、西宁2、拉萨3、昆明2、重庆2、成都4、贵州3、上海33、宁波边缘云、华东1、上海36、南昌5、青岛20、武汉41、长沙42、长沙37、南宁23、北京行业云20、华北2、西南1、上海32。
startTime与endTime之间时间隔建议不超过30天。
接口是否审批
否
URI
GET /v4/oss/get-bucket-statistics
Content-Type
application/json
路径参数
无
Query参数
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
参数 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|
size | Array of Objects | 指定时间范围内,存储容量在每个整点的值(单位:字节) 比如20230213-05表示在20230213-05这个时刻的值 |
size | |
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 |
表 size, opsRequest, bytesSend, bytesRetrive, opsRetrive, bytesCross
参数 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|
value | Long | 值 | 22 | |
time | String | 日期-小时 格式的时间字符串,时区为 UTC 时区 | 20230213-05 |
枚举参数
无
请求头header示例
无
请求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
请求体body示例
无
响应示例
{
"httpstatus":200,
"httpresult":{
"returnObj":{
"storageTypeGlacier":{
"bytesCross":[
{
"value":236,
"time":"20231116-07"
},
{
"value":236,
"time":"20231116-08"
}
],
"size":[
{
"value":646,
"time":"20231116-08"
},
{
"value":646,
"time":"20231116-09"
}
]
},
"storageTypeIa":{
"bytesCross":[
{
"value":2581,
"time":"20231116-07"
},
{
"value":2581,
"time":"20231116-08"
}
],
"size":[
{
"value":646,
"time":"20231116-08"
},
{
"value":646,
"time":"20231116-09"
}
],
"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"
}
],
"size":[
{
"value":646,
"time":"20231116-07"
},
{
"value":646,
"time":"20231116-08"
},
{
"value":646,
"time":"20231116-09"
}
]
}
},
"details":"",
"message":"SUCCESS",
"description":"成功",
"statusCode":800
}
}
状态码
Http 状态码 | 状态码信息 | 状态码描述 |
---|---|---|
200 | OK | OK |
400 | Bad Request | Bad Request |
500 | Internal Server Error | Internal Server Error |
错误码
errorCode 枚举值,见错误码总表