DescribeKvRealTimeQpsData - Edge Security Acceleration - Alibaba Cloud Documentation Center

Queries the real-time queries per second (QPS) data of a key-value (KV) store.

Operation description

Note

The call frequency for a single user is limited to 10 calls per second.

Supported time granularities for queries:

The Interval parameter supports different time granularities. The selected time granularity determines the maximum time span for a single query and the time range of historical data that you can query.

Time granularity	Maximum time span for a single query	Queryable historical data time range
1 minute	1 day	60 days
5 minutes	3 days	60 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

Request parameters

Parameter	Type	Required	Description	Example
NamespaceId	string	No	The ID of the namespace. If you leave this parameter empty, the aggregate data of all namespaces is returned. You can specify multiple namespace IDs separated by commas (,). You can query a maximum of 30 namespaces.	namespaceName
StartTime	string	No	The beginning of the time range to query. Specify the time in the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time must be in UTC. The minimum time granularity is 5 minutes. If you do not specify this parameter, data in the last 24 hours is queried by default.	2022-08-10T16:00:00Z
EndTime	string	No	The end of the time range to query. 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 you leave this parameter empty, the aggregate data of all access types is returned. You can set this parameter to one of the following values: get: GET requests. put: PUT requests. list: LIST requests. delete: DELETE requests.	get
SplitBy	string	No	The key to group data by. You can set this parameter to type or namespace. type: If you set this parameter to type, data is grouped by time and returned at a 5-minute granularity. namespace: If you set this parameter to namespace, data is grouped by namespace. Data points with a value of 0 are not returned. If you leave this parameter empty, all data that meets the filter conditions is aggregated. Data points with a value of 0 are returned regardless of the time granularity.	type
Interval	string	No	The time granularity. Valid values: 60: 1-minute granularity 300: 5-minute granularity The default value is 60.	60

Response parameters

Parameter	Type	Description	Example
	object	The response schema.
RequestId	string	The request ID.	3C6CCEC4-6B88-4D4A-93E4-D47B3D92C***
StartTime	string	The start time.	2023-01-10T16:00:00Z
EndTime	string	The end time.	2023-01-18T15:59:59Z
KvQpsData	array<object>	The detailed QPS data.
	object
TimeStamp	string	The beginning of the time slice.	2023-01-10T16:00:00Z
NamespaceId	string	The namespace ID. This field is returned only when you set SplitBy to namespace.	534167033424646***
AccessType	string	The request type. This field is returned only when you set SplitBy to type.	get
Qps	integer	The average number of requests per second.	5236
KeyQps	integer	The average number of operations on key-value pairs per second.	1234
KeySuccQps	integer	The average number of successful operations on key-value pairs per second.	1233
AggregateData	array<object>	The aggregate data.
	object	The aggregate data.
AccessType	string	The request type. This field is returned only when you set SplitBy to type.	get
Acc	integer	The number of requests.	123
KeyAcc	integer	The number of operations on key-value pairs.	1234
KeySuccAcc	integer	The number of successful operations on key-value pairs.	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.