All Products
Search
Document Center

Alibaba Cloud CDN:DescribeDomainHitRateData

Last Updated:Jan 30, 2023

Queries byte hit ratios that are measured in percentage.

Operation Description

  • The maximum number of times that each user can call this operation per second is 100.
  • If you do not set StartTime or EndTime, data collected within the last 24 hours is queried. If you set both StartTime and EndTime, data collected within the specified time range is queried.

Time granularity

The time granularity supported by the Interval parameter, the maximum time period within which historical data is available, and the data delay vary with the time range to query, as described in the following table.

Time granularityTime range to queryHistorical data availableData delay
5 minutes3 days93 days15 minutes
1 hour31 days186 days4 hours
1 day366 days366 days04:00 on the next day

Authorization information

The following table is the authorization information corresponding to the API, which can be found in the RAM permission policy statement.Action Used in the element to grant the RAM user or RAM role permission to call this API. The specific instructions are as follows:

  • 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 keyword: refers to the condition keyword defined by the cloud product itself.
  • 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.
Operateaccess levelResource typeconditional keywordAssociation operation
cdn:DescribeDomainHitRateDataREAD
  • CDN
    acs:cdn:*:{#accountId}:domain/{#DomainName}
    without
without

Request parameters

ParameterTypeRequiredDescriptionExample
DomainNamestringNo

You can specify multiple domain names and separate them with commas (,). You can specify at most 500 domain names in each call.

By default, this operation queries the byte hit ratios of all accelerated domain names that belong to your Alibaba Cloud account.

example.com
StartTimestringNo

The start 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.

2019-12-30T08: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.

NoteThe end time must be later than the start time.
2019-12-30T08:10:00Z
IntervalstringNo

The time interval between the data entries. Unit: seconds.

The time granularity varies with the time range to query. Supported values: 300 (5 minutes), 3600 (1 hour), and 86400 (1 day). For more information, see Usage notes.

300

Response parameters

ParameterTypeDescriptionExample
object
EndTimestring

The end of the time range that was queried.

2019-12-30T08:10:00Z
StartTimestring

The beginning of the time range that was queried.

2019-12-30T08:00:00Z
RequestIdstring

The ID of the request.

16A96B9A-F203-4EC5-8E43-CB92E68F4CD8
DomainNamestring

The accelerated domain name.

example.com
DataIntervalstring

The time interval between the data entries returned. Unit: seconds.

300
HitRateIntervalarray

The byte hit ratio at each time interval. The byte hit ratio is measured in percentage.

object
Valuestring

The byte hit ratio.

100.0
TimeStampstring

The timestamp of the data returned.

2019-12-30T08:00:00Z
HttpsValuestring

The byte hit ratio of HTTPS requests.

50.0

Example

Normal return example

JSONFormat

{
  "EndTime": "2019-12-30T08:10:00Z",
  "StartTime": "2019-12-30T08:00:00Z",
  "RequestId": "16A96B9A-F203-4EC5-8E43-CB92E68F4CD8",
  "DomainName": "example.com",
  "DataInterval": "300",
  "HitRateInterval": {
    "DataModule": [
      {
        "Value": "100.0",
        "TimeStamp": "2019-12-30T08:00:00Z",
        "HttpsValue": "50.0"
      }
    ]
  }
}

Error codes

Http codeError codeError messageDescription
400MissingTimeParameterThe StartTime and EndTime must be both specified.You must set both the start time and the end time.
400InvalidStartTime.MalformedThe specified StartTime is invalid.The specified start time is invalid. For more information, see the API references.
400InvalidEndTime.MalformedThe specified EndTime is invalid.The EndTime parameter is set in an invalid format. For more information, see the API references.
400InvalidEndTime.MismatchThe specified EndTime is earlier than the StartTime.-
400InvalidStartTime.ValueNotSupportedThe specified StartTime is invalid.-

For a list of error codes, visit the API error center.