DescribeDcdnDomainRegionData-阿里云帮助中心

Retrieves the daily user region distribution statistics for an accelerated domain name. Data for up to 90 days is supported.

Operation description

Note

If you do not specify StartTime and EndTime, the data for the last 24 hours is retrieved by default. If you specify StartTime and EndTime, the data within the specified time range is queried.
Rate limit per user: 100 calls per second.

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

dcdn:DescribeDcdnDomainRegionData

get

*Domain

acs:dcdn:*:{#accountId}:domain/{#domainName}

None

Request parameters

Parameter	Type	Required	Description	Example
DomainName	string	No	The accelerated domain name. Only one domain name is supported. By default, all domain names under the current user are queried.	example.com
StartTime	string	No	The start time of the data to retrieve. The time is in UTC+8 and follows the YYYY-MM-DDThh:mm:ssZ format.	2015-12-05T12:00:00Z
EndTime	string	No	The end time of the data to retrieve. The end time must be later than the start time. The time is in UTC+8 and follows the YYYY-MM-DDThh:mm:ssZ format.	2015-12-07T12:00:00Z

Response elements

Element	Type	Description	Example
	object
EndTime	string	The end time. The time is displayed in UTC and follows the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format.	2015-12-07T12:00:00Z
StartTime	string	The start time. The time is displayed in UTC and follows the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format.	2015-12-05T12:00:00Z
RequestId	string	The request ID.	2E5AD83F-BD7B-462E-8319-2E30E305519A
DomainName	string	The accelerated domain name.	example.com
DataInterval	string	The time interval between each record. Unit: seconds.	86400
Value	object
RegionProportionData	array<object>	The list of access proportion data by region.
	object
Qps	string	The queries per second (QPS).	0
TotalQuery	string	The total number of requests.	0
TotalBytes	string	The total traffic.	0
RegionEname	string	The English name of the region.	chongqing
Region	string	The region information.	Chongqing
AvgResponseRate	string	The average response speed. Unit: bytes per second.	0
AvgResponseTime	string	The average response time. Unit: milliseconds.	0
Proportion	string	The access proportion. For example, a value of 90 indicates 90%.	0
AvgObjectSize	string	The average response size. Unit: bytes.	0
Bps	string	The bandwidth.	0
BytesProportion	string	The total traffic proportion. For example, a value of 90 indicates 90%.	0.003544181046236794

Examples

Success response

JSON format

{
  "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": "重庆市",
        "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.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.