All Products
Search
Document Center

CDN:DescribeDomainRealTimeReqHitRateData

Last Updated:Jan 18, 2024

Queries the request hit ratios for one or more accelerated domain names.

Operation description

  • You can call this operation up to 10 times per second per account.
  • If you do not set the StartTime or EndTime parameter, the request returns the data collected in the last hour. If you set both the StartTime and EndTime parameters, the request returns the data collected within the specified time range.
  • By default, requests in the Go programming language use the POST request method. You must manually change the request method to GET by declaring: request.Method="GET".
  • The network traffic destined for different domain names may be redirected to the same origin server. Therefore, the request hit ratios may be inaccurate. The accuracy of query results is based on the actual configurations.

Time granularity

The time granularity varies with the time range specified by the StartTime and EndTime parameters. The following table describes the time period within which historical data is available and the data delay.

Time granularityMaximum time range per queryHistorical data availableData delay
1 minute1 hour7 days5 minutes
5 minutes3 days93 days15 minutes
1 hour31 days186 days4 hours

Debugging

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

Debug

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
cdn:DescribeDomainRealTimeReqHitRateDataREAD
  • Domain
    acs:cdn:*:{#accountId}:domain/{#DomainName}
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
DomainNamestringYes

The accelerated domain name. You can specify up to 100 domain names in each call. Separate multiple domain names with commas (,).

example.com
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-01-02T11:23: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-01-02T11:26:00Z

Response parameters

ParameterTypeDescriptionExample
object
RequestIdstring

The ID of the request.

70A26B11-3673-479C-AEA8-E03FC5D3496D
Dataobject []

The data returned.

ReqHitRatefloat

The request hit ratio.

0.8956940476262277
TimeStampstring

The timestamp of the data returned. The time follows the ISO 8601 standard in the yyyy-MM-ddThh:mm:ssZ format. The time is displayed in UTC.

2018-01-02T11:26:00Z

Examples

Sample success responses

JSONformat

{
  "RequestId": "70A26B11-3673-479C-AEA8-E03FC5D3496D",
  "Data": {
    "ReqHitRateDataModel": [
      {
        "ReqHitRate": 0.8956940476262277,
        "TimeStamp": "2018-01-02T11:26:00Z"
      }
    ]
  }
}

Error codes

HTTP status codeError codeError messageDescription
400InvalidTime.MalformedSpecified StartTime or EndTime is malformed.The specified start or end time is invalid.
400InvalidDomainName.MalformedSpecified domain name is malformed.-

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

Change history

Change timeSummary of changesOperation
2023-06-13The Error code has changedsee changesets
Change itemChange content
Error CodesThe Error code has changed.
    Error Codes 400 change