对象存储(KS3)

查看更多结果

未找到含当前关键字的文档标题

页面目录

全部展开全部收起

产品更新动态

未找到含该关键词的产品

文档中心

对象存储(KS3)

API文档

KS3计量

桶用量详情查询

桶容量详情查询（按小时）

最近更新时间：2026-11-02 17:20:02



描述

用户可以通过KS3提供的计量接口查询KS3的桶容量用量详情数据，包括总量、增量、删除量。

访问方式

计量API访问地址为：ks3bill.api.ksyun.com，支持HTTP和HTTPS访问。
主账号或具有对象存储计量权限的子用户，可以访问计量API，计量API支持GET方法发送请求。

配置权限

使用该接口需要是桶拥有者或具有KS3BillFullAccess权限。子用户配置权限的方法如下：

登录金山云访问控制控制台，为子用户添加策略。点击左侧子用户，选择要授权的子用户，点击添加权限，将系统策略“KS3BillFullAccess“授权给子用户。

请求参数

参数名称	是否必填	格式与说明	取值示例
Action	是	字符串，接口名称	固定为 QueryKs3Capacity
Version	是	字符串，接口版本	固定为 v1
Service	是	字符串，服务标识	固定为 ks3bill
DateType	是	字符串，时间粒度	可选值：Hour（小时级）、Day（天级） 1. 选择按天查询时时间范围不能跨月,仅支持查询昨日及更早的数据，当日数据暂不支持查询 2. 选择小时查询时时间范围支持跨天，但每次查询的时间范围不能超过24小时,且接口存在4小时数据延迟，若结束大于当前时间前4小时，系统将自动调整为当前时间前4小时
SearchType	否	字符串，查询类型	可选值：Bucket（默认）、Account Account表示查询AK对应账号下的所有桶及其汇总信息
BucketName	条件必填，当 SearchType取值为 Bucket时，该参数必填	字符串，存储桶名称	最多支持同时查询5个存储桶，以逗号分隔，例如：test-bkt,test-bucket
StartTime	是	字符串，查询开始时间	格式为 yyyyMMddHHmm，例如：202608070000
EndTime	是	字符串，查询结束时间	格式为 yyyyMMddHHmm，例如：202608072359 1. 选择按天查询时时间范围不能跨月,仅支持查询昨日及更早的数据，当日数据暂不支持查询 2. 选择小时查询时时间范围支持跨天，但每次查询的时间范围不能超过24小时,且接口存在4小时数据延迟，若结束大于当前时间前4小时，系统将自动调整为当前时间前4小时
StorageClass	否	字符串，存储类型	可选值：EXTREME_PL3（极速-PL3）、EXTREME_PL2（极速-PL2）、EXTREME_PL1（极速-PL1）、STANDARD（标准存储）、STANDARD_IA（低频存储）、ARCHIVE（归档存储）、COLD_ARCHIVE（冷归档），多个值以逗号分隔，默认仅查询标准存储
DataRedundancyType	否	字符串，数据冗余类型	可选值：LRS（本地冗余）、ZRS（同城冗余），多个值以逗号分隔，默认查询所有冗余类型

响应参数

参数名称	层级	类型	说明
Code	根层级	字符串	响应状态码，正常返回 OK
Message	根层级	字符串	响应描述，正常返回 OK
RequestId	根层级	字符串	请求唯一标识，用于问题排查
Data	根层级	对象	响应数据容器
Data.Buckets	Data	数组	存储桶用量明细列表，按时间粒度分组返回
Data.Buckets[].Name	Buckets元素	字符串	存储桶名称
Data.Buckets[].StartTime	Buckets元素	字符串	统计周期开始时间，格式为 yyyy-MM-dd HH:mm:ss
Data.Buckets[].EndTime	Buckets元素	字符串	统计周期结束时间，格式为 yyyy-MM-dd HH:mm:ss
Data.Buckets[].{StorageClass}	Buckets元素	对象	对应存储类型的用量数据，取值为存储类型名称：EXTREME_PL3（极速-PL3）、EXTREME_PL2（极速-PL2）、EXTREME_PL1（极速-PL1）、STANDARD（标准存储）、STANDARD_IA（低频存储）、ARCHIVE（归档存储）、COLD_ARCHIVE（冷归档）
{StorageClass}.TotalSize	存储类型对象	字符串	统计周期末的存储总量，单位为字节
{StorageClass}.AddSize	存储类型对象	字符串	统计周期内新增存储量，单位为字节
{StorageClass}.DelSize	存储类型对象	字符串	统计周期内删除存储量，单位为字节

请求示例

按天粒度查询请求示例

GET /?Action=QueryKs3Capacity&StartTime=202610030000&EndTime=202610052359&DateType=Day&BucketName=test1,test2&Version=v1&Service=ks3bill&StorageClass=STANDARD,STANDARD_IA
Host: ks3bill.api.ksyun.com
X-Kss-Date: 20211124T070940Z
Authorization: {SignatureValue}

按小时粒度查询请求示例

GET /?Action=QueryKs3Capacity&StartTime=202610030000&EndTime=202610030159&DateType=Hour&BucketName=test3,test4&Version=v1&Service=ks3bill&StorageClass=STANDARD,STANDARD_IA
Host: ks3bill.api.ksyun.com
X-Kss-Date: 20211124T070940Z
Authorization: {SignatureValue}

响应示例

按天粒度查询响应示例

{
  "Code": "OK",
  "Message": "OK",
  "Data": {
    "Buckets": [
      {
        "Name": "test1",
        "StartTime": "2026-10-03 00:00:00",
        "EndTime": "2026-10-03 23:59:59",
        "STANDARD": {
          "TotalSize": "14512716424905",
          "AddSize": "0",
          "DelSize": "0"
        },
        "STANDARD_IA": {
          "TotalSize": "0",
          "AddSize": "0",
          "DelSize": "0"
        }
      },
      {
        "Name": "test2",
        "StartTime": "2026-10-03 00:00:00",
        "EndTime": "2026-10-03 23:59:59",
        "STANDARD": {
          "TotalSize": "12184785231568",
          "AddSize": "0",
          "DelSize": "0"
        },
        "STANDARD_IA": {
          "TotalSize": "0",
          "AddSize": "0",
          "DelSize": "0"
        }
      },
      {
        "Name": "test1",
        "StartTime": "2026-10-04 00:00:00",
        "EndTime": "2026-10-04 23:59:59",
        "STANDARD": {
          "TotalSize": "14512716424905",
          "AddSize": "0",
          "DelSize": "0"
        },
        "STANDARD_IA": {
          "TotalSize": "0",
          "AddSize": "0",
          "DelSize": "0"
        }
      },
      {
        "Name": "test2",
        "StartTime": "2026-10-04 00:00:00",
        "EndTime": "2026-10-04 23:59:59",
        "STANDARD": {
          "TotalSize": "12184785231568",
          "AddSize": "0",
          "DelSize": "0"
        },
        "STANDARD_IA": {
          "TotalSize": "0",
          "AddSize": "0",
          "DelSize": "0"
        }
      }
    ],
    "Summary": [
      {
        "StartTime": "2026-10-03 00:00:00",
        "EndTime": "2026-10-03 23:59:59",
        "STANDARD": {
          "TotalSize": "26697501656473",
          "AddSize": "0",
          "DelSize": "0"
        },
        "STANDARD_IA": {
          "TotalSize": "0",
          "AddSize": "0",
          "DelSize": "0"
        }
      },
      {
        "StartTime": "2026-10-04 00:00:00",
        "EndTime": "2026-10-04 23:59:59",
        "STANDARD": {
          "TotalSize": "26697501656473",
          "AddSize": "0",
          "DelSize": "0"
        },
        "STANDARD_IA": {
          "TotalSize": "0",
          "AddSize": "0",
          "DelSize": "0"
        }
      }
    ]
  },
  "RequestId": "6831933e-0dfa-4e14-b9ce-5b5884ce738d"
}

按小时粒度查询响应示例

{
  "Code": "OK",
  "Message": "OK",
  "Data": {
    "Buckets": [
      {
        "Name": "test3",
        "StartTime": "2026-10-03 00:00:00",
        "EndTime": "2026-10-03 00:59:59",
        "STANDARD": {
          "TotalSize": "14512716424905",
          "AddSize": "0",
          "DelSize": "0"
        },
        "STANDARD_IA": {
          "TotalSize": "0",
          "AddSize": "0",
          "DelSize": "0"
        }
      },
      {
        "Name": "test4",
        "StartTime": "2026-10-03 00:00:00",
        "EndTime": "2026-10-03 00:59:59",
        "STANDARD": {
          "TotalSize": "12184785231568",
          "AddSize": "0",
          "DelSize": "0"
        },
        "STANDARD_IA": {
          "TotalSize": "0",
          "AddSize": "0",
          "DelSize": "0"
        }
      },
      {
        "Name": "test3",
        "StartTime": "2026-10-03 01:00:00",
        "EndTime": "2026-10-03 01:59:59",
        "STANDARD": {
          "TotalSize": "14512716424905",
          "AddSize": "0",
          "DelSize": "0"
        },
        "STANDARD_IA": {
          "TotalSize": "0",
          "AddSize": "0",
          "DelSize": "0"
        }
      },
      {
        "Name": "test4",
        "StartTime": "2026-10-03 01:00:00",
        "EndTime": "2026-10-03 01:59:59",
        "STANDARD": {
          "TotalSize": "12184785231568",
          "AddSize": "0",
          "DelSize": "0"
        },
        "STANDARD_IA": {
          "TotalSize": "0",
          "AddSize": "0",
          "DelSize": "0"
        }
      }
    ],
    "Summary": [
      {
        "StartTime": "2026-10-03 00:00:00",
        "EndTime": "2026-10-03 00:59:59",
        "STANDARD": {
          "TotalSize": "26697501656473",
          "AddSize": "0",
          "DelSize": "0"
        },
        "STANDARD_IA": {
          "TotalSize": "0",
          "AddSize": "0",
          "DelSize": "0"
        }
      },
      {
        "StartTime": "2026-10-03 01:00:00",
        "EndTime": "2026-10-03 01:59:59",
        "STANDARD": {
          "TotalSize": "26697501656473",
          "AddSize": "0",
          "DelSize": "0"
        },
        "STANDARD_IA": {
          "TotalSize": "0",
          "AddSize": "0",
          "DelSize": "0"
        }
      }
    ]
  },
  "RequestId": "7a49baf7-5de0-43c9-ab0e-7f7b0fc86cad"
}

错误码

HTTP状态码	错误码	描述
400	SignatureDoesNotMatch	签名不匹配
400	InvalidArgument	存在以下场景：日期格式无效 StartTime不合法 EndTime不合法 StartTime和EndTime出现跨月结束时间早于开始时间同时查询的桶数量超过5个参数不合法
400	InvalidAccessKey	无效的AccessKey

文档导读

上一篇：桶用量详情查询（按天）

下一篇：桶用量排序查询

纯净模式常规模式

纯净模式

点击可全屏预览文档内容