DescribeDcdnDomainRegionData - Edge Security Acceleration

Queries regional distribution of users. Data is collected every day. You can query data within the last 90 days.

Operation description

Note

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 call this operation up to 100 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	No	The accelerated domain name. You can specify only one domain name. If you do not specify an accelerated domain name, the data of all accelerated domain names that belong to your account is queried.	example.com
StartTime	string	No	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.	2015-12-05T12:00:00Z
EndTime	string	No	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.	2015-12-07T12:00:00Z

Response parameters

Parameter	Type	Description	Example
	object
EndTime	string	The end of the time range during which data was queried.	2015-12-07T12:00:00Z
StartTime	string	The start of the time range during which data was queried.	2015-12-05T12:00:00Z
RequestId	string	The ID of the request.	2E5AD83F-BD7B-462E-8319-2E30E305519A
DomainName	string	The accelerated domain name.	example.com
DataInterval	string	The time interval between the data entries returned. Unit: seconds.	86400
Value	array<object>	The proportions of requests that were initiated from each region.
RegionProportionData	object
Qps	string	The number of queries per second (QPS).	0
TotalQuery	string	The total number of requests that are destined for your website.	0
TotalBytes	string	The total amount of network traffic.	0
RegionEname	string	The name of the region.	chongqing
Region	string	The information of the regions.	Chongqing
AvgResponseRate	string	The average response speed. Unit: byte/s.	0
AvgResponseTime	string	The average response time. Unit: milliseconds.	0
Proportion	string	The proportion of requests from the specified region based on the total number of requests in percentile. For example, a value of 90 indicates that 90% of the requests were coming from the specified region.	0
AvgObjectSize	string	The average response size. Unit: bytes.	0
Bps	string	The bandwidth.	0
BytesProportion	string	The proportion of network traffic. For example, a value of 90 indicates that 90% of network traffic was coming from the specified ISP.	0.003544181046236794

Examples

Sample success responses

JSONformat

{
  "EndTime": "2015-12-07T12:00:00Z",
  "StartTime": "2015-12-05T12:00:00Z",
  "RequestId": "2E5AD83F-BD7B-462E-8319-2E30E305519A",
  "DomainName": "example.com",
  "DataInterval": "86400",
  "Value": {
    "RegionProportionData": [
      {
        "Qps": "0",
        "TotalQuery": "0",
        "TotalBytes": "0",
        "RegionEname": "chongqing",
        "Region": "Chongqing\n",
        "AvgResponseRate": "0",
        "AvgResponseTime": "0",
        "Proportion": "0",
        "AvgObjectSize": "0",
        "Bps": "0",
        "BytesProportion": "0.003544181046236794"
      }
    ]
  }
}

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	InvalidEndTime.Mismatch	The specified EndTime is earlier than the StartTime.	The end time is earlier than the start time.
400	InvalidStartTime.ValueNotSupported	The specified StartTime is invalid.	The specified start time is invalid.
404	InvalidDomain.NotFound	The specified domain does not exist.	The specified domain name does not exist.

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