All Products
Search
Document Center

Dynamic Content Delivery Network:DescribeDcdnErUsageData

Last Updated:Apr 11, 2024

Queries the number of times that a routine is executed within a specified period of time.

Operation description

  • You can call this operation up to 10 times per second per account.
  • The minimum time granularity for a query is 1 hour. The maximum time span for a query is 24 hours. The time period within which historical data is available for a query is 366 days.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

  • Operation: the value that you can use in the Action element to specify the operation on a resource.
  • Access level: the access level of each operation. The levels are read, write, and list.
  • Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
    • The required resource types are displayed in bold characters.
    • If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
  • Condition Key: the condition key that is defined by the cloud service.
  • Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
OperationAccess levelResource typeCondition keyAssociated operation
dcdn:DescribeDcdnErUsageDataRead
  • All Resources
    *
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
RoutineIDstringNo

The ID of the routine.

routine1.test
SpecstringNo

The specification of the routine. Valid values:

  • 5ms
  • 50ms
  • 100ms
50ms
StartTimestringNo

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.

2018-10-30T16:00:00Z
EndTimestringNo

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.

Note The end time must be later than the start time.
2018-10-31T16:00:00Z
SplitBystringNo

Specifies how the results are grouped. If you set this parameter to routine, the returned results are grouped based on the routine ID. If you set this parameter to spec, the returned results are grouped based on the routine specification.

Note If you leave this parameter empty, the returned results are not grouped.
routine

Response parameters

ParameterTypeDescriptionExample
object
EndTimestring

The end of the time range during which data was queried.

2018-10-31T16:00:00Z
StartTimestring

The start of the time range during which data was queried.

2018-10-30T16:00:00Z
RequestIdstring

The ID of the request.

C370DAF1-C838-4288-A1A0-9A87633D248E
ErAccDataobject []

The list of the data returned.

ErAcclong

The number of requests.

125
TimeStampstring

The timestamp of the returned data.

2018-10-30T13:00:00Z
Specstring

The specification of the routine. This parameter is returned only when SplitBy is set to spec.

50ms
Routinestring

The ID of the routine. This parameter is returned only when SplitBy is set to routine.

routine1.test

Examples

Sample success responses

JSONformat

{
  "EndTime": "2018-10-31T16:00:00Z",
  "StartTime": "2018-10-30T16:00:00Z",
  "RequestId": "C370DAF1-C838-4288-A1A0-9A87633D248E",
  "ErAccData": {
    "ErAccItem": [
      {
        "ErAcc": 125,
        "TimeStamp": "2018-10-30T13:00:00Z",
        "Spec": "50ms",
        "Routine": "routine1.test"
      }
    ]
  }
}

Error codes

HTTP status codeError codeError messageDescription
400InvalidStartTime.MalformedThe 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.
400InvalidEndTime.MalformedThe 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.
400InvalidStartTime.ValueNotSupportedThe specified StartTime is invalid.The specified start time is invalid.

For a list of error codes, visit the Service error codes.