DescribeDcdnDomainHitRateData - API Reference| Alibaba Cloud Documentation Center

When you call this operation, follow these rules:

If you do not specify the StartTime and EndTime parameters, the data within the last 24 hours is queried. If you specify the StartTime and EndTime parameters, the data within the specified time range is queried.
You can specify multiple domain names and separate them with commas (,).

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.

Request parameters


Parameter	Type	Required	Example	Description
Action	String	No	DescribeDcdnDomainHitRateData	The operation that you want to perform. Set the value to DescribeDcdnDomainHitRateData.
DomainName	String	No	example.com	The name of the accelerated domain. You can specify only one domain name. If you do not specify this parameter, all accelerated domains under your account are queried.
EndTime	String	No	2018-03-02T15:00:00Z	The end of the time range to query. The end time must be later than the start time. Specify the time in the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time must be in UTC.
Interval	String	No	300	The data sampling interval. Unit: seconds. The value varies based on the values specified in the StartTime and EndTime parameters. If you do not specify this parameter or the specified value is invalid, the default value is used. Valid values: Less than 3 days: 300, 3600, and 86400. Default value: 300. 3 to 31 days (excluding 31 days): 3600 and 86400. Default value: 3600. No less than 31 days: 86400. Default value: 86400.
StartTime	String	No	2018-03-02T12:00:00Z	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 data granularity is five minutes. If you do not specify this parameter, the data within the last 24 hours is queried.

Response parameters


Parameter	Type	Example	Description
DataInterval	String	3600	The data sampling interval. Unit: seconds.
DomainName	String	example.com	The name of the accelerated domain returned.
EndTime	String	2018-03-02T15:00:00Z	The end of the time range during which the data was queried.
HitRatePerInterval	Array		The hit ratio at each specified interval.
DataModule			The hit ratio at each specified interval.
ByteHitRate	Float	0	The ratio of bytes served by the cache over the total number of bytes requested by the clients.
ReqHitRate	Float	0	The request hit ratio.
TimeStamp	String	2018-03-02T13:00:00Z	The timestamp of the data returned.
RequestId	String	4D07ABFE-4737-4834-B1B9-A661308C47B4	The ID of the request.
StartTime	String	2018-03-02T12:00:00Z	The beginning of the time range during which the data was queried.

Examples

Sample requests

http://scdn.aliyuncs.com?Action=DescribeDcdnDomainHitRateData
&DomainName=example.com
&StartTime=2018-03-02T12:00:00Z
&EndTime=2018-03-02T15:00:00Z
&<Common request parameters>

Sample success responses

XML format

<DescribeDcdnDomainHitRateDataResponse>
	  <DomainName>test.com</DomainName>
	  <DataInterval>3600</DataInterval>
	  <HitRatePerInterval>
		    <DataModule>
			      <ByteHitRate>0</ByteHitRate>
			      <TimeStamp>2018-03-02T15:00:00Z</TimeStamp>
			      <ReqHitRate>0</ReqHitRate>
		    </DataModule>
		    <DataModule>
			      <ByteHitRate>0</ByteHitRate>
			      <TimeStamp>2018-03-02T14:00:00Z</TimeStamp>
			      <ReqHitRate>0</ReqHitRate>
		    </DataModule>
		    <DataModule>
			      <ByteHitRate>0</ByteHitRate>
			      <TimeStamp>2018-03-02T13:00:00Z</TimeStamp>
			      <ReqHitRate>0</ReqHitRate>
		    </DataModule>
		    <DataModule>
			      <ByteHitRate>0</ByteHitRate>
			      <TimeStamp>2018-03-02T12:00:00Z</TimeStamp>
			      <ReqHitRate>0</ReqHitRate>
		    </DataModule>
	  </HitRatePerInterval>
	  <RequestId>4D07ABFE-4737-4834-B1B9-A661308C47B4</RequestId>
	  <EndTime>2018-03-02T15:00:00Z</EndTime>
	  <StartTime>2018-03-02T12:00:00Z</StartTime>
</DescribeDcdnDomainHitRateDataResponse>

JSON format

{
	"DataInterval":3600,
	"HitRatePerInterval":{
		"DataModule":[
			{
				"TimeStamp":"2018-03-02T15:00:00Z",
				"ByteHitRate":0,
				"ReqHitRate":0
			},
			{
				"TimeStamp":"2018-03-02T14:00:00Z",
				"ByteHitRate":0,
				"ReqHitRate":0
			},
			{
				"TimeStamp":"2018-03-02T13:00:00Z",
				"ByteHitRate":0,
				"ReqHitRate":0
			},
			{
				"TimeStamp":"2018-03-02T12:00:00Z",
				"ByteHitRate":0,
				"ReqHitRate":0
			}
		]
	},
	"RequestId":"4D07ABFE-4737-4834-B1B9-A661308C47B4",
	"DomainName":"test.com",
	"EndTime":"2018-03-02T15:00:00Z",
	"StartTime":"2018-03-02T12:00:00Z"
}

Error codes


HTTP status code	Error code	Error message	Description
400	MissingTimeParameter	The StartTime and EndTime must be both specified.	The error message returned because the StartTime and EndTime parameters must be specified together.
400	InvalidStartTime.Malformed	The specified StartTime is invalid.	The error message returned because the specified StartTime parameter 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 error message returned because the specified EndTime parameter 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 error message returned because the specified EndTime parameter is earlier than the specified StartTime parameter.
400	InvalidStartTime.ValueNotSupported	The specified StartTime is invalid.	The error message returned because the specified start time is not supported.

For a list of error codes, visit the API Error Center.