DescribeKvUsageData - Edge Security Acceleration - Alibaba Cloud Documentation Center

Operation description

Note

The maximum call frequency for a single user is 5 calls per second.
The usage data is measured by the number of requests.

Supported time granularity: This operation supports queries at a 1-hour time granularity.

Time granularity	Maximum time span per query	Queryable time range for historical data	Data latency
1 hour	31 days	90 days	Typically 3 to 4 hours

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:DescribeKvUsageData

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, aggregated data for all namespaces is returned. To query multiple namespaces, separate the IDs with commas (,). You can specify up to 30 namespace IDs.	12423131231****
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 1 hour. If you do not specify this parameter, data from the last 7 days is queried by default.	2022-08-10T00: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-10T23:59:59Z
Field	string	Yes	The type of data to request. Set the value to acc.	acc
AccessType	string	No	The access type. If you leave this parameter empty, aggregated results for all types are returned. Valid values: get: GET request. put: PUT request. list: LIST request. delete: DELETE request.	get
ResponseType	string	No	The type of data to return in the response. Valid values: detail: detailed data total: summary data The default value is detail.	detail
SplitBy	string	No	The key to group data by. Valid values: type: Data is grouped by time and returned at a 5-minute granularity. namespace: Data is grouped by namespace. Data points with a value of 0 are not returned. If empty, the default is type. If you leave this parameter empty, the default value is type.	type

Response parameters

Parameter	Type	Description	Example
	object	Schema of Response
RequestId	string	The request ID.	9732E117-8A37-49FD-A36F-ABBB87556CA7
StartTime	string	The start time.	2022-11-06T16:00:00Z
EndTime	string	The end time.	2022-11-18T15:59:59Z
KvUsageData	array<object>	The usage details.
	object
TimeStamp	string	The timestamp of the data point.	2022-11-14T15:00:03Z
NamespaceId	string	The namespace ID. This parameter is returned only when SplitBy is set to namespace.	534167033424646144
AccessType	string	The request type. This parameter is returned only when SplitBy is set to type.	get
Acc	integer	The number of requests.	1340000

Examples

Success response

JSON format

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

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.
400	InvalidParameterField	The specified Field is invalid.	The Field parameter is set to an invalid value.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.