DocsICP FilingConsole
Documentation

DescribeKvRealTimeQpsData

Updated at:
Copy as MD
Product
My Favorites

Queries the real-time QPS data of the KV store.

Operation description

Note

Invoke frequency per user: 10 invokes per second.

Supported time granularities:

The request parameter Interval supports different query data timestamp granularities based on the maximum time span of a single query. The corresponding time range of queryable historical data and data delay are as follows:

Time granularityMaximum time span per queryTime range of queryable historical data
1 minute1 day60 days
5 minutes3 days60 days

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

  • Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.

  • API: The API that you can call to perform the action.

  • Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.

  • Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.

    • For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.

    • For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.

  • Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.

  • Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

dcdn:DescribeKvRealTimeQpsData

get

*All Resource

*

 None None

Request parameters

Parameter

Type

Required

Description

Example
NamespaceId

string

No

The namespace ID. If this parameter is left empty, the aggregated data of all namespaces is returned by default.

You can specify multiple namespace IDs. Separate multiple namespace IDs with commas (,). You can specify up to 30 namespace IDs.

534167033424646***
StartTime

string

No

The start time of the data to retrieve. Specify the time in the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time must be in UTC.

The minimum data granularity is 5 minutes. If this parameter is not specified, the data of the last 24 hours is retrieved by default.

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

string

No

The end time of the data to retrieve. Specify the time in the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time must be in UTC.

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

string

No

The access type. If this parameter is left empty, the aggregated results of all types are returned by default. Valid values:

  • get: GET requests.

  • put: PUT requests.

  • list: LIST requests.

  • delete: DELETE requests.

get
SplitBy

string

No

The grouping key. Valid values: type and namespace.

  • type: If you specify this value, the data is grouped and output in chronological order, and only data at a 5-minute granularity is returned.

  • namespace: If you specify this value, the data is grouped and output by namespace, and zero values are not padded for missing data points.

  • Empty: If you leave this parameter empty, all data is aggregated and output based on the filter conditions. Zero values are padded for missing data points regardless of the data granularity.

Valid values:

  • namespace :

    Group by namespace.

  • type :

    Group by type.

type
Interval

string

No

The time granularity. Valid values:

  • 60: 1-minute granularity.

  • 300: 5-minute granularity.

Default value: 60.

Valid values:

  • 60 :

    1-minute granularity.

  • 300 :

    5-minute granularity.

60

Response elements

Element

Type

Description

Example

object

Schema of Response

RequestId

string

The request ID.

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

string

The start time.

The time is in the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format and in UTC.

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

string

The end time.

The time is in the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format and in UTC.

2023-01-18T15:59:59Z
KvQpsData

array<object>

The detailed QPS data.

object

TimeStamp

string

The start time of the time period.

The time is in the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format and in UTC.

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

string

The namespace ID. This field is returned only when SplitBy is set to namespace.

534167033424646***
AccessType

string

The request type. This field is returned only when SplitBy is set to type.

get
Qps

integer

The average number of requests per second.

5236
KeyQps

integer

The average number of key-value pair operations per second.

1234
KeySuccQps

integer

The average number of successful key-value pair operations per second.

1233
AggregateData

array<object>

The aggregate data of the aggregation.

object

The aggregate data of the aggregation.

AccessType

string

The request type. This field is returned only when SplitBy is set to type.

get
Acc

integer

The number of requests.

123
KeyAcc

integer

The number of key-value pair operations.

1234
KeySuccAcc

integer

The number of successful key-value pair operations.

1233

Examples

Success response

JSON format

{
  "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
    }
  ]
}

Error codes

HTTP status code

Error code

Error message

Description
400 InvalidStartTime.Malformed The specified StartTime parameter is invalid. The format of the specified start time is invalid. Specify the time in the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time must be in UTC.
400 InvalidEndTime.Malformed The specified EndTime is invalid. The format of the specified end time is invalid. Specify the time in the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time must be in UTC.
400 InvalidEndTime.Mismatch The specified EndTime is earlier than the StartTime. The end time is earlier than the start time.
400 InvalidTimeSpan The time span exceeds the limit. The time span exceeds the limit. Configure a valid time span as described in API documentation.
400 InvalidStartTime.ValueNotSupported The specified StartTime is invalid. The specified start time is invalid.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.