DescribeKvRealTimeQpsData - 查询KV存储实时QPS数据

查询KV存储实时QPS数据。

接口说明

说明 单用户调用频率:10 次/秒

支持查询的时间粒度

根据单次查询的最大时间跨度不同,请求参数 Interval 支持不同的查询数据时间粒度,对应的可查询历史数据时间范围和数据延迟如下:

时间粒度单次查询的最大时间跨度可查询历史数据时间范围
1 分钟1 天60 天
5 分钟3 天60 天

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用前面加 * 表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
dcdn:DescribeKvRealTimeQpsDataget
*全部资源
*

请求参数

名称类型必填描述示例值
NamespaceIdstring

命名空间 ID,若参数为空,默认返回所有命名空间聚合的数据。

支持多个命名空间查询,多个命名空间用半角逗号(,)分隔, 最多支持查询 30 个命名空间。

534167033424646***
StartTimestring

获取数据起始时间。日期格式按照 ISO8601 表示法,并使用 UTC+0 时间,格式为:yyyy-MM-ddTHH:mm:ssZ。

最小数据粒度为 5 分钟。不填默认读取过去 24 小时数据。

2022-08-10T16:00:00Z
EndTimestring

获取数据结束时间。日期格式按照 ISO8601 表示法,并使用 UTC 时间,格式为 yyyy-MM-ddTHH:mm:ssZ。

2022-08-10T15:59:59Z
AccessTypestring

访问类型,若参数为空,则默认返回所有类型聚合的结果。可以指定为:

  • get:GET 请求。
  • put:PUT 请求。
  • list:LIST 请求。
  • delete:DELETE 请求。
get
SplitBystring

分组键,可以指定为 typenamespace

  • type:指定后数据将会按时序被分组输出,且仅返回 5 分钟粒度数据。
  • namespace:指定后数据将按照 namespace 分组输出,不会对数据进行补零。
  • 为空时:所有数据将根据筛选条件聚合输出,不论数据粒度如何,都将对没值的点进行补零。
type
Intervalstring

时间粒度,取值:

  • 60:1 分钟粒度数据
  • 300:5 分钟粒度数据

默认 60s。

60

返回参数

名称类型描述示例值
object

Schema of Response

RequestIdstring

请求 ID。

3C6CCEC4-6B88-4D4A-93E4-D47B3D92C***
StartTimestring

开始时间。

2023-01-10T16:00:00Z
EndTimestring

结束时间。

2023-01-18T15:59:59Z
KvQpsDataarray<object>

QPS 明细数据。

KvQpsDataItemobject
TimeStampstring

时间片起始时刻。

2023-01-10T16:00:00Z
NamespaceIdstring

Namespace ID。仅当 SplitBy 指定 namespace 时返回该字段。

534167033424646***
AccessTypestring

请求类型。仅当 SplitBy 指定 type 时返回该字段。

get
Qpslong

平均每秒请求次数。

5236
KeyQpslong

平均每秒操作键值对次数。

1234
KeySuccQpslong

平均每秒操作键值对成功次数。

1233
AggregateDataarray<object>

聚合数据。

KvAggDataItemobject

聚合数据。

AccessTypestring

请求类型。仅当 SplitBy 指定 type 时返回该字段。

get
Acclong

请求次数。

123
KeyAcclong

操作键值对次数。

1234
KeySuccAcclong

操作键值对成功次数。

1233

示例

正常返回示例

JSON格式

{
  "RequestId": "3C6CCEC4-6B88-4D4A-93E4-D47B3D92C***",
  "StartTime": "2023-01-10T16:00:00Z",
  "EndTime": "2023-01-18T15:59:59Z",
  "KvQpsData": [
    {
      "TimeStamp": "2023-01-10T16:00:00Z",
      "NamespaceId": "534167033424646***",
      "AccessType": "get",
      "Qps": 5236,
      "KeyQps": 1234,
      "KeySuccQps": 1233
    }
  ],
  "AggregateData": [
    {
      "AccessType": "get",
      "Acc": 123,
      "KeyAcc": 1234,
      "KeySuccAcc": 1233
    }
  ]
}

错误码

HTTP status code错误码错误信息描述
400InvalidStartTime.MalformedThe specified StartTime parameter is invalid.请提供正确的开始时间格式。日期格式按照ISO8601表示法,并使用UTC时间,格式为:yyyy-MM-ddTHH:mm:ssZ。
400InvalidEndTime.MalformedThe specified EndTime is invalid.请提供正确的结束时间格式。日期格式按照ISO8601表示法,并使用UTC时间。 格式为:yyyy-MM-ddTHH:mm:ssZ。
400InvalidEndTime.MismatchThe specified EndTime is earlier than the StartTime.结束时间早于开始时间,请检查。
400InvalidTimeSpanThe time span exceeds the limit.时间跨度超过限制,请参照接口文档,配置合理查询跨度。
400InvalidStartTime.ValueNotSupportedThe specified StartTime is invalid.不支持该开始时间,请重新填写。

访问错误中心查看更多错误码。