DescribeDcdnDomainRealTimeDetailData - Edge Security Acceleration

Queries traffic usage through each Internet service provider (ISP) and the number of visits in each region. The resolution of the data is one minute. The maximum time range to query for this operation is 10 minutes.

Operation description

Note You can call this operation up to 10 times per second per account.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Debug

Authorization information

There is currently no authorization information disclosed in the API.

Request parameters

Parameter	Type	Required	Description	Example
DomainName	string	Yes	The accelerated domain name. Separate multiple accelerated domain names with commas (,).	example.com
StartTime	string	Yes	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.	2019-11-30T05:33:00Z
EndTime	string	Yes	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, and the maximum time range to query is 10 minutes.	2019-11-30T05:40:00Z
Field	string	Yes	The type of information that you want to query. Separate multiple types with commas (,). Valid values: qps: queries per second (QPS) bps: bandwidth http_code: HTTP status code	bps
LocationNameEn	string	No	The name of the region. You can call the DescribeDcdnRegionAndIsp operation to query the region name. If you leave this parameter empty, all regions are queried.	beijing
IspNameEn	string	No	The name of the ISP. You can call the DescribeDcdnRegionAndIsp operation to query the ISP name. If you leave this parameter empty, all ISPs are queried.	unicom
Merge	string	No	Specifies whether to return a summary value. Valid values: true false Default value: false.	true
MergeLocIsp	string	No	Specifies whether to return a summary value of LocationNameEn and IspNameEn. Valid values: true false Default value: false.	true

Response parameters

Parameter	Type	Description	Example
	object
Data	string	The information returned. Note The value of this parameter is a JSON string. The following table describes the fields in Data.	[ { "time_stp": "2018-06-05T20:00:00Z", "domain_name": "example.com", "location": "Guangdong", "isp": "telecom", "qps": 10.0 }, { "time_stp": "2018-06-05T20:00:00Z", "domain_name": "example.com", "location": "Jiangsu", "isp": "unicom", "qps": 11.1 } ]
RequestId	string	The ID of the request.	A603F324-7A05-4FB3-ADF3-2563233D26CC

Fields in Data

Field	Type	Description	Example
domain_name	String	The domain name that was queried.	example.com
isp	String	The name of the ISP.	unicom
location	String	The name of the region.	qingdao
qps	Long	The QPS.	40
bps	Long	The bandwidth value.	100
http_code	Map	The HTTP status codes returned. The key indicates the HTTP status code and the value indicates the number of the HTTP status codes.	{"200": 1, "304": 2, "403": 3}
time_stp	String	The beginning of the time range that was queried. The time follows the ISO 8601 standard in the yyyy-MM-ddThh:mm:ssZ format. The time is displayed in UTC.	2022-10-20T04:00:00Z

Examples

Sample success responses

JSONformat

{
  "Data": "[\n    {\n      \"time_stp\": \"2018-06-05T20:00:00Z\",\n      \"domain_name\": \"example.com\",\n      \"location\": \"Guangdong\",\n      \"isp\": \"telecom\",\n      \"qps\": 10.0\n    },\n    {\n      \"time_stp\": \"2018-06-05T20:00:00Z\",\n      \"domain_name\": \"example.com\",\n      \"location\": \"Jiangsu\",\n      \"isp\": \"unicom\",\n      \"qps\": 11.1\n    }\n  ]",
  "RequestId": "A603F324-7A05-4FB3-ADF3-2563233D26CC"
}

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 StartTime parameter is invalid.	The format of the specified start time 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 format of the specified end time 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	InvalidParameter	The specified parameter is invalid.	A parameter is set to an invalid value.
400	InvalidTime.Malformed	Specified StartTime or EndTime is malformed.	The format of the specified start time or end time 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	InvalidDomainName.Malformed	The specific DomainName is invalid.	The specified domain name is invalid.
400	InvalidStartTime.ValueNotSupported	The specified StartTime is invalid.	The specified start time is invalid.

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

Change history

Change time	Summary of changes	Operation
2023-07-04	The Error code has changed	View Change Details