DescribeDomainAverageResponseTime - - Alibaba Cloud Documentation Center

The statistical analytics feature of Alibaba Cloud CDN is discontinued. The API operations related to the statistical analytics feature are no longer maintained. We recommend that you do not use the API operations because data may be missing or inaccurate. You can use the operations report feature to for data analysis.

Note

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.
You can call this operation up to 100 times per second per account.
You can specify multiple domain names and separate them with commas (,). You can specify at most 50 domain names in each call.

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	Yes	DescribeDomainAverageResponseTime	The operation that you want to perform. Set the value to DescribeDomainAverageResponseTime.
TimeMerge	String	No	1	Specifies whether to automatically set the interval. If you set the value to 1, the value of the Interval parameter is automatically assigned based on the StartTime and EndTime parameters. You can set this parameter or the Interval parameter.
DomainType	String	No	domaintype	The type of the query condition. Valid values: When you set the value to dynamic, this operation queries the average response time of dynamic resources and static resources. If you do not set this parameter, this operation queries the average response time of only static resources. By default, this parameter is not set.
DomainName	String	No	example.com	The accelerated domain name. Separate multiple accelerated domain names with commas (,). By default, this operation queries the bandwidth values during back-to-origin routing for all accelerated domain names that belong to your Alibaba Cloud account.
StartTime	String	No	2019-11-30T05:33: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.
EndTime	String	No	2019-11-30T05:40:00Z	The end of the time range queried. Specify the time in the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time must be in UTC. The end time must be later than the start time.
Interval	String	No	300	The time interval between the data entries. Unit: seconds. The value varies based on the values of the StartTime and EndTime parameters. Valid values: If the time span between StartTime and EndTime is less than 3 days (3 days excluded), valid values are 300, 3600, and 86400. Default value: 300. If the time span between StartTime and EndTime is from 3 to 31 days (31 days excluded), valid values are 3600 and 86400. Default value: 3600. If the time range between StartTime and EndTime is 31 days or longer, the valid value is 86400. Default value: 86400.
IspNameEn	String	No	unicom	The name of the Internet service provider (ISP) for your Alibaba Cloud CDN service. You can call the DescribeCdnRegionAndIsp operation to query ISPs. If you do not set this parameter, all ISPs are queried.
LocationNameEn	String	No	beijing	The name of the region. You can call the DescribeCdnRegionAndIsp operation to query the most recent region list. If you do not set this parameter, all regions are queried.

Response parameters


Parameter	Type	Example	Description
EndTime	String	2019-11-30T05:40:00Z	The end of the time range during which data was queried.
StartTime	String	2019-11-30T05:33:00Z	The beginning of the time range during which data was queried.
RequestId	String	3C6CCEC4-6B88-4D4A-93E4-D47B3D92CF8F	The ID of the request.
DomainName	String	example.com	The accelerated domain name.
DataInterval	String	300	The time interval between the data entries returned.
AvgRTPerInterval	Array of DataModule		The average response time collected at each time interval.
DataModule
Value	String	3	The average response time.
TimeStamp	String	2015-12-10T20:00:00Z	The timestamp of the returned data.

Examples

Sample request

http://cdn.aliyuncs.com/?Action=DescribeDomainAverageResponseTime
&DomainName=example.com
&StartTime=2019-11-30T05:33:00Z
&EndTime=2019-11-30T05:40:00Z
&<Common request parameters>

Sample success responses

XML format

HTTP/1.1 200 OK
Content-Type:application/xml

<DescribeDomainAverageResponseTimeResponse>
	<DomainName>example.com</DomainName>
	<RequestId>3C6CCEC4-6B88-4D4A-93E4-D47B3D92CF8F</RequestId>
	<StartTime>2019-11-30T05:33:00Z</StartTime>
	<EndTime>2019-11-30T05:40:00Z</EndTime>
	<DataInterval>300</DataInterval>
	<AvgRTPerInterval>
		<DataModule>
			<TimeStamp>2019-11-30T05:33:00Z</TimeStamp>
			<Value>3</Value>
		</DataModule>
		<DataModule>
			<TimeStamp>2019-11-30T05:38:00Z</TimeStamp>
			<Value>3</Value>
		</DataModule>
	</AvgRTPerInterval>
</DescribeDomainAverageResponseTimeResponse>

JSON format

HTTP/1.1 200 OK
Content-Type:application/json

{
  "DomainName" : "example.com",
  "RequestId" : "3C6CCEC4-6B88-4D4A-93E4-D47B3D92CF8F",
  "StartTime" : "2019-11-30T05:40:00Z",
  "EndTime" : "2019-11-30T05:33:00Z",
  "DataInterval" : "300",
  "AvgRTPerInterval" : {
    "DataModule" : [ {
      "TimeStamp" : "2019-11-30T05:33:00Z",
      "Value" : "3"
    }, {
      "TimeStamp" : "2019-11-30T05:38:00Z",
      "Value" : "3"
    } ]
  }
}

Error codes


HttpCode	Error code	Error message	Description
400	InvalidStartTime.Malformed	Specified StartTime is malformed.	The error message returned because the format of the specified start time is invalid. For more information about the time format, see the Request parameters section.
400	InvalidEndTime.Malformed	Specified EndTime is malformed.	The error message returned because the format of the specified end time is invalid. For more information about the time format, see the Request parameters section.
400	InvalidStartTime.ValueNotSupported	The specified value of parameter StartTime is not supported.	The error message returned because the specified start time is invalid. Rectify the start time and try again.

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