Query byte hit ratio using DescribeDomainHitRateData - CDN - Alibaba Cloud - CDN

Queries the byte hit ratio (percentage of hit bytes).

Operation description

If you do not specify StartTime and EndTime, this operation returns data for the last 24 hours. If you specify StartTime and EndTime, this operation returns data for the specified time range.

Supported time granularities

The request parameter Interval supports different data timestamp granularities based on the maximum time span of a single query. The corresponding time range of historical data that can be queried and the data delay are as follows:

Time granularity	Maximum time span per query	Time range of queryable historical data	Data delay
5 minutes	3 days	93 days	15 minutes
1 hour	31 days	186 days	Typically 3 to 4 hours
1 day	366 days	366 days	Typically 4 hours, up to 24 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

cdn:DescribeDomainHitRateData

none

*Domain

acs:cdn:*:{#accountId}:domain/{#DomainName}

None

Request parameters

Parameter	Type	Required	Description	Example
DomainName	string	No	The accelerated domain name. Separate multiple domain names with commas (,). You can query up to 500 domain names at a time. By default, this operation queries all accelerated domain names.	example.com
StartTime	string	No	The start time of the data to retrieve. 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
EndTime	string	No	The end time of the data to retrieve. 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.	2019-12-30T08:10:00Z
Interval	string	No	The time granularity of the data to query. Unit: seconds. Valid values: 300 (5 minutes), 3600 (1 hour), and 86400 (1 day). The supported values vary based on the maximum time span of a single query. For more information about the supported time granularities, see the Usage notes section.	300

Response elements

Element	Type	Description	Example
	object
EndTime	string	The end time. The time is displayed in the ISO 8601 standard in UTC.	2019-12-30T08:10:00Z
StartTime	string	The start time. The time is displayed in the ISO 8601 standard in UTC.	2019-12-30T08:00:00Z
RequestId	string	The request ID.	16A96B9A-F203-4EC5-8E43-CB92E68F4CD8
DomainName	string	The information about the accelerated domain name.	example.com
DataInterval	string	The time interval of each record. Unit: seconds.	300
HitRateInterval	object
DataModule	array<object>	The list of byte hit ratio data for each time interval.
	object
Value	string	The hit ratio.	100.0
TimeStamp	string	The start time of the time interval. The time is displayed in the ISO 8601 standard in UTC.	2019-12-30T08:00:00Z
HttpsValue	string	The HTTPS byte hit ratio.	50.0

Examples

Success response

JSON format

{
  "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 status code	Error code	Error message	Description
400	MissingTimeParameter	The StartTime and EndTime must be both specified.	You must set both the start time and the end time.
400	InvalidStartTime.Malformed	The specified value of parameter StartTime is malformed.
400	InvalidEndTime.Malformed	The specified value of parameter EndTime is malformed.
400	InvalidEndTime.Mismatch	Specified EndTime does not match the specified StartTime.	StartTime must be earlier than EndTime.
400	InvalidStartTime.ValueNotSupported	The specified value of parameter StartTime is not supported.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.