All Products
Search
Document Center

Dynamic Content Delivery Network:DescribeDcdnDomainRegionData

Last Updated:Feb 19, 2024

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

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

  • Operation: the value that you can use in the Action element to specify the operation on a resource.
  • Access level: the access level of each operation. The levels are read, write, and list.
  • Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
    • The required resource types are displayed in bold characters.
    • If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
  • Condition Key: the condition key that is defined by the cloud service.
  • Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
OperationAccess levelResource typeCondition keyAssociated operation
dcdn:DescribeDcdnDomainRegionDataRead
  • Domain
    acs:dcdn:*:{#accountId}:domain/{#domainName}
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
DomainNamestringNo

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
StartTimestringNo

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
EndTimestringNo

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

ParameterTypeDescriptionExample
object
EndTimestring

The end of the time range during which data was queried.

2015-12-07T12:00:00Z
StartTimestring

The start of the time range during which data was queried.

2015-12-05T12:00:00Z
RequestIdstring

The ID of the request.

2E5AD83F-BD7B-462E-8319-2E30E305519A
DomainNamestring

The accelerated domain name.

example.com
DataIntervalstring

The time interval between the data entries returned. Unit: seconds.

86400
Valueobject []

The proportions of requests that were initiated from each region.

Qpsstring

The number of queries per second (QPS).

0
TotalQuerystring

The total number of requests that are destined for your website.

0
TotalBytesstring

The total amount of network traffic.

0
RegionEnamestring

The name of the region.

chongqing
Regionstring

The information of the regions.

Chongqing
AvgResponseRatestring

The average response speed. Unit: byte/s.

0
AvgResponseTimestring

The average response time. Unit: milliseconds.

0
Proportionstring

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
AvgObjectSizestring

The average response size. Unit: bytes.

0
Bpsstring

The bandwidth.

0
BytesProportionstring

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 codeError codeError messageDescription
400MissingTimeParameterThe StartTime and EndTime must be both specified.You must set both the start time and the end time.
400InvalidStartTime.MalformedThe 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.
400InvalidEndTime.MalformedThe 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.
400InvalidEndTime.MismatchThe specified EndTime is earlier than the StartTime.The end time is earlier than the start time.
400InvalidStartTime.ValueNotSupportedThe specified StartTime is invalid.The specified start time is invalid.
404InvalidDomain.NotFoundThe specified domain does not exist.The specified domain name does not exist.

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