用户可以通过KS3提供的计量接口查询以下内容:
计量API访问地址为:ks3bill.api.ksyun.com,支持HTTP和HTTPS访问。
主账号和具有对象存储计量权限的子用户,可以访问计量API。计量API支持GET方法发送请求。
参数名称 | 类型 | 必填 | 描述 |
---|---|---|---|
Service | String | 是 | 服务名称,固定值:ks3bill |
Action | String | 是 | 操作接口名,固定值:QueryKs3Data |
Version | String | 是 | 接口版本号,固定值:v1 |
Signature | String | 是 | 计量API使用V4签名方式,具体参见签名机制 |
参数名称 | 类型 | 必填 | 描述 |
---|---|---|---|
StartTime | String | 是 | 查询用量开始时间:yyyyMMddHHmm 例如:202111230000 |
EndTime | String | 是 | 查询用量结束时间(与开始时间同月,不支持跨月查询):yyyyMMddHHmm 例如:202111240000 |
DateType | String | 是 | 支持按天粒度查询,固定值:Day |
Bucketname | String | 是 | 存储空间名称,最多支持同时查询5个存储桶的用量明细,以逗号分隔 |
Ks3Product | String | 否 | 可以查询单个或多个计费项,以逗号分隔,如果不填,则查询除带宽外的所有计费项 存储量:DataSize 外网下行流量:NetworkFlow CDN回源流量:CDNFlow 跨区域复制流量:ReplicationFlow GET类请求次数:RequestsGet PUT类请求次数:RequestsPut 数据取回量:RestoreSize 对象标签梳理:TagNum 下行带宽(不区分外网和CDN):BandwidthDown 外网下行带宽:NetBandwidthDown CDN下行带宽:CDNBandwidthDown |
Transfer | String | 否 | 可以查询单个或多个统计项的流量情况,以逗号分隔。可填参数:Object、Referer、IP、UA,返回TOP200数据 |
Request | String | 否 | 可以查询单个或多个统计项的请求次数情况,以逗号分隔。可填参数:Object、Referer、IP、UA,返回TOP200数据 |
参数名称 | 描述 | 类型 |
---|---|---|
Data | 包含一个或多个Bucket的容器 子节点:Buckets |
container |
Buckets | 包含Bucket信息的容器 子节点:Name,Type,DataSize,PutRequest,GetRequest,NetworkFlow,CDNFlow,ReplicationFlow,StandardIAData,ArchiveData,TagNum,Transfer,Request 父节点:Data |
container |
Name | Bucket的名称 父节点:Data.Buckets |
String |
StartTime | 数据开始时间 父节点:Data.Buckets |
String |
EndTime | 数据结束时间 父节点:Data.Buckets |
String |
StandardDataSize | Bucket的标准存储量,单位是Bytes 父节点:Data.Buckets |
String |
StandardIADataSize | Bucket的低频存储量,单位是Bytes 父节点:Data.Buckets |
String |
ArchiveDataSize | Bucket的归档存储量,单位是Bytes 父节点:Data.Buckets |
String |
StandardPutRequest | 标准存储的PUT请求次数 父节点:Data.Buckets |
String |
StandardIAPutRequest | 低频存储的PUT请求次数 父节点:Data.Buckets |
String |
ArchivePutRequest | 归档存储的PUT请求次数 父节点:Data.Buckets |
String |
StandardGetRequest | 标准存储的GET请求次数 父节点:Data.Buckets |
String |
StandardIAGetRequest | 低频存储的GET请求次数 父节点:Data.Buckets |
String |
ArchiveGetRequest | 归档存储的GET请求次数 父节点:Data.Buckets |
String |
NetworkFlow | 外网下行流量,单位是Bytes 父节点:Data.Buckets |
String |
CDNFlow | CDN回源流量,单位是Bytes 父节点:Data.Buckets |
String |
ReplicationFlow | 跨区域复制流量,单位是Bytes 父节点:Data.Buckets |
String |
BandwidthDown | 外网下行带宽,不区分外网下行和CDN下行,单位是bps 父节点:Data.Buckets |
String |
OuterBandwidthDown | 外网下行带宽,单位是bps 父节点:Data.Buckets |
String |
CDNBandwidthDown | CDN下行带宽,单位是bps 父节点:Data.Buckets |
String |
StandardIAData | 低频存储数据取回量,单位是Bytes 父节点:Data.Buckets |
String |
ArchiveData | 归档存储解冻数据量,单位是Bytes 父节点:Data.Buckets |
String |
TagNum | 对象标签的数量 父节点:Data.Buckets |
String |
Transfer | Object、Referer、IP、UA产生的流量 父节点:Data.Buckets |
数组 |
Request | Object、Referer、IP、UA产生的请求次数 父节点:Data.Buckets |
数组 |
RequestId | 由KS3指定的唯一值,可用于解决KS3出现的问题 | String |
GET /?Action=QueryKs3Data&StartTime=202111220000&EndTime=202111222300&DateType=Day&Bucketname=sh-cm5&Ks3Product=DataSize,NetworkFlow,CDNFlow,ReplicationFlow,RequestsGet,RequestsPut,RestoreSize,TagNum,BandwidthDown,NetBandwidthDown,CDNBandwidthDown&Transfer=Referer,IP,UA&Request=IP&Service=ks3bill&Version=v1 HTTP/1.1
Host: ks3bill.api.ksyun.com
X-Amz-Date: 20211124T070940Z
Authorization: {SignatureValue}
{
"Code": "OK",
"Message": "OK",
"Data": {
"Buckets": [
{
"Name": "sh-cm5",
"StartTime": "2021-11-22 00:00:00",
"EndTime": "2021-11-22 23:59:59",
"StandardDataSize": "1000",
"StandardIADataSize": "2000",
"ArchiveDataSize": "3000",
"StandardPutRequest": "10",
"StandardIAPutRequest": "20",
"ArchivePutRequest": "30",
"StandardGetRequest": "40",
"StandardIAGetRequest": "50",
"ArchiveGetRequest": "60",
"NetworkFlow": "7000",
"CDNFlow": "8000",
"BandwidthDown": [
{
"2021-11-22 08:00:00": "500"
}
],
"CDNBandwidthDown": [
{
"2021-11-22 08:00:00": "200"
}
],
"OuterBandwidthDown": [
{
"2021-11-22 08:00:00": "300"
}
],
"ReplicationFlow": "9000",
"StandardIAData": "1000",
"ArchiveData": "2000",
"TagNum": "10",
"Transfer": {
"Referer": [
{
"referer": "-",
"traffic": "2.0"
}
],
"Ip": [
{
"ip": "15.1.1.1",
"traffic": "2024.2"
}
],
"Ua": [
{
"ua": "UAname",
"traffic": "97.55"
}
]
}
}
]
},
"RequestId": "5d52bb03-e25c-4c8f-baa8-2b1c569058b4"
}
主账号或者具有权限的子用户可以调用计量API,查询计量相关信息。
子用户配置权限的方法如下:
错误码 | 错误信息 | 状态码 | 描述 |
---|---|---|---|
SignatureDoesNotMatch | The Signature is not matched. | 400 | 签名不匹配 |
InvalidArgument | Invalid length of StartTime or EndTime. | 400 | 无效的日期格式 |
InvalidArgument | Invalid StartTime. | 400 | StartTime不合法 |
InvalidArgument | Invalid EndTime. | 400 | EndTime不合法 |
InvalidArgument | StartTime and EndTime should be in the same month. | 400 | StartTime和EndTime应在同一个月 |
InvalidArgument | The EndTime should be later than the StartTime. | 400 | 结束时间应晚于开始时间 |
InvalidArgument | The number of specified buckets can not exceed 5. | 400 | 最多支持查询5个桶的用量明细 |
InvalidArgument | Invalid DateType. | 400 | DateType不合法 |
InvalidArgument | Invalid Ks3Product:< Ks3Product >. | 400 | Ks3Product不合法 |
InvalidAccessKey | Invalid Accesskey. | 400 | 无效的AccessKey |
文档内容是否对您有帮助?
评价建议不能为空
非常感谢您的反馈,我们会继续努力做到更好!