调用DescribeKvUsageData查询KV存储的用量数据。
接口说明
- 单用户调用频率:5 次/秒
- 用量数据为请求次数。
支持查询的时间粒度: 本 API 仅支持 1 小时粒度的数据查询。
时间粒度 | 单次查询的最大时间跨度 | 可查询历史数据时间范围 | 数据延迟 |
---|---|---|---|
1 小时 | 31 天 | 90 天 | 一般延迟 3-4 小时 |
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
下表是API对应的授权信息,可以在RAM权限策略语句的Action
元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:
- 操作:是指具体的权限点。
- 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
- 资源类型:是指操作中支持授权的资源类型。具体说明如下:
- 对于必选的资源类型,用背景高亮的方式表示。
- 对于不支持资源级授权的操作,用
全部资源
表示。
- 条件关键字:是指云产品自身定义的条件关键字。
- 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
---|---|---|---|---|
dcdn:DescribeKvUsageData | Read |
|
| 无 |
请求参数
名称 | 类型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
NamespaceId | string | 否 | 命名空间 ID,若参数为空,默认返回所有命名空间聚合的数据。 支持多个命名空间查询,多个命名空间用半角逗号(,)分隔, 最多支持查询 30 个命名空间。 | 12423131231**** |
StartTime | string | 否 | 获取数据起始时间。日期格式按照 ISO8601 表示法,并使用 UTC+0 时间,格式为:yyyy-MM-ddTHH:mm:ssZ。 最小数据粒度为 1 小时。不填默认读取过去 7 天的数据。 | 2022-08-10T00:00:00Z |
EndTime | string | 否 | 获取数据结束时间。日期格式按照 ISO8601 表示法,并使用 UTC 时间,格式为 yyyy-MM-ddTHH:mm:ssZ。 | 2022-08-10T23:59:59Z |
Field | string | 是 | 请求数据类型,可以指定为:acc。 | acc |
AccessType | string | 否 | 访问类型,若参数为空,则默认返回所有类型聚合的结果。可以指定为:
| get |
ResponseType | string | 否 | 响应数据类型,取值:
默认为 detail。 | detail |
SplitBy | string | 否 | 分组键,可以指定为 type、namespace。
ResponseType 为 total 时,不支持分组返回 namespace,将继续按照 type 分组返回。 | type |
返回参数
示例
正常返回示例
JSON
格式
{
"RequestId": "9732E117-8A37-49FD-A36F-ABBB87556CA7",
"StartTime": "2022-11-06T16:00:00Z",
"EndTime": "2022-11-18T15:59:59Z",
"KvUsageData": [
{
"TimeStamp": "2022-11-14T15:00:03Z",
"NamespaceId": "534167033424646144",
"AccessType": "get",
"Acc": 1340000
}
]
}
错误码
HTTP status code | 错误码 | 错误信息 | 描述 |
---|---|---|---|
400 | InvalidStartTime.Malformed | The specified StartTime parameter is invalid. | 请提供正确的开始时间格式。日期格式按照ISO8601表示法,并使用UTC时间,格式为:yyyy-MM-ddTHH:mm:ssZ。 |
400 | InvalidEndTime.Malformed | The specified EndTime is invalid. | 请提供正确的结束时间格式。日期格式按照ISO8601表示法,并使用UTC时间。 格式为:yyyy-MM-ddTHH:mm:ssZ。 |
400 | InvalidEndTime.Mismatch | The specified EndTime is earlier than the StartTime. | 结束时间早于开始时间,请检查。 |
400 | InvalidTimeSpan | The time span exceeds the limit. | 时间跨度超过限制,请参照接口文档,配置合理查询跨度。 |
400 | InvalidStartTime.ValueNotSupported | The specified StartTime is invalid. | 不支持该开始时间,请重新填写。 |
400 | InvalidParameterField | The specified Field is invalid. | Field参数错误 |
访问错误中心查看更多错误码。