接口介绍
查询桶统计信息
-
传bucket参数,表示查询该桶的统计信息
-
不传bucket参数,表示查询所有桶的统计信息,即该用户所有桶的统计信息
统计项:
1). 每个小时累计的请求次数,为公网请求数加内网请求数的总值
2). 每个小时累计的公网流出流量,通过公网从ZOS访问下载数据所产生的流出流量
3). 每个小时累计的数据取回流量,仅在归档、低频存储类型时有此指标,归档的取回指归档对象解冻,低频的取回指低频对象的下载
4). 每个小时累计的数据取回次数,仅在归档、低频存储类型时有此指标,归档的取回指归档对象解冻,低频的取回指低频对象的下载
5). 存储容量为每个整点的值
接口约束
支持的线上资源池 :上海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之间时间间隔不能大于7天
URI
GET /v4/oss/get-bucket-statistics
请求参数
请求 Query 参数
参数 | 是否必填 | 参数类型 | 说明 | 示例 |
---|---|---|---|---|
bucket | 否 | String | 存储桶名 | bucket1 |
regionID | 是 | String | 区域ID | 332232eb-63aa-465e-9028-52e5123866f0 |
startTime | 是 | String | 日期-小时 格式的时间字符串,时区为 UTC 时区 | 20220319-05 |
endTime | 是 | String | 日期-小时 格式的时间字符串,时区为 UTC 时区 | 20220319-07 |
响应参数
参数 | 参数类型 | 说明 | 示例 |
---|---|---|---|
statusCode | Integer | 返回码 取值范围:800 成功 |
800 |
message | String | 状态描述 | SUCCESS |
description | String | 状态描述,一般为中文 | 成功 |
returnObj | Object | 响应对象 | 见下级对象 |
errorCode | String | 业务细分码(仅失败时具有此参数),为product.module.code三段式码 | openapi.userPermission.accessFailed |
表 returnObj
参数 | 参数类型 | 说明 | 示例 |
---|---|---|---|
storageTypeGlacier | Object | 归档存储类型数据,若不存在此存储类型则值为空对象 {} | 见下级对象 |
storageTypeIa | Object | 低频存储类型数据,若不存在此存储类型则值为空对象 {} | 见下级对象 |
storageTypeStandard | Object | 标准存储类型数据,若不存在此存储类型则值为空对象 {} | 见下级对象 |
表 storageTypeGlacier, storageTypeStandard, storageTypeIa
参数 | 参数类型 | 说明 | 示例 |
---|---|---|---|
size | Array of Objects | 指定时间范围内,存储容量在每个整点的值 比如20230322-05表示在20230213-05这个时刻的值 |
见下级对象 |
opsRequest | Array of Objects | 指定时间范围内,每个小时累计的请求次数 比如20230322-05表示在20230213-05到20230213-06这个时段的值 |
见下级对象 |
bytesSend | Array of Objects | 指定时间范围内,每个小时累计的公网流出流量 比如20230322-05表示在20230213-05到20230213-06这个时段的值 |
见下级对象 |
bytesRetrive | Array of Objects | 指定时间范围内,每个小时累计的数据取回流量 比如20230322-05表示在20230213-05到20230213-06这个时段的值 仅在归档、低频存储类型有此指标 归档的取回指归档对象解冻,低频的取回指低频对象的下载 |
见下级对象 |
opsRetrive | Array of Objects | 指定时间范围内,每个小时累计的数据取回次数 比如20230322-05表示在20230213-05到20230213-06这个时段的值 仅在归档、低频存储类型有此指标 归档的取回指归档对象解冻,低频的取回指低频对象的下载 |
见下级对象 |
表 size, opsRequest, bytesSend, bytesRetrive, opsRetrive
参数 | 参数类型 | 说明 | 示例 |
---|---|---|---|
value | Integer | 值 | 22 |
time | String | 日期-小时 格式的时间字符串,时区为 UTC 时区 | 20220319-06 |
请求示例
GET https://zos-global.ctapi.ctyun.cn/v4/oss/get-bucket-statistics?bucket=bucket1®ionID=332232eb-63aa-465e-9028-52e5123866f0&startTime=20220319-05&endTime=20220319-07
响应示例
{
"returnObj": {
"storageTypeGlacier": {},
"storageTypeIa": {},
"storageTypeStandard": {
"opsRequest": [
{
"value": 5,
"time": "20230213-05"
},
{
"value": 3,
"time": "20230213-06"
}
],
"bytesSend": [
{
"value": 693,
"time": "20230213-05"
},
{
"value": 693,
"time": "20230213-06"
}
],
"size": [
{
"value": 38102,
"time": "20230213-05"
},
{
"value": 38102,
"time": "20230213-06"
},
{
"value": 38102,
"time": "20230213-07"
}
]
}
},
"message": "SUCCESS",
"description": "成功",
"statusCode": 800
}
状态码
状态码 | 描述 |
---|---|
800 | 表示请求成功。 |
900 | 表示请求失败。 |
错误码
errorCode 枚举值,见错误码总表