Queries the visitor data classified by region for one or more accelerated domain names. Data is collected every day.

Before you call this operation, take note of the following rules:
  • 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 specify only one accelerated domain name or all the accelerated domain names that belong to your Alibaba Cloud account.
  • You can query data within the last 90 days.

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 DescribeDomainRegionData

The operation that you want to perform. Set the value to DescribeDomainRegionData.

DomainName String No example.com

The accelerated domain name for which you want to query data. You can specify only one domain name. If you do not set this parameter, the data for all the accelerated domain names that belong to your Alibaba Cloud account is returned.

StartTime String No 2016-03-13

The beginning of the time range that was queried.

  • Specify the time in the YYYY-MM-DD format in UTC+8.
  • If you do not set this parameter, data within the last 24 hours is queried.
EndTime String No 2016-03-14

The end of the time range to query.

  • The end time must be later than the start time.
  • Specify the time in the YYYY-MM-DD format in UTC+8.

Response parameters

Parameter Type Example Description
DataInterval String 86400

The time interval between the data entries.

DomainName String example.com

The accelerated domain name.

EndTime String 2015-12-07T12:00:00Z

The end of the time range that was queried.

RequestId String 2E5AD83F-BD7B-462E-8319-2E30E305519A

The ID of the request.

StartTime String 2015-12-05T12:00:00Z

The beginning of the time range that was queried.

Value Array

The data returned.

RegionProportionData
AvgObjectSize String 800019.0

The average size of returned objects. Unit: bytes.

AvgResponseRate String 154.3345765545624

The average response speed. Unit: byte/s.

AvgResponseTime String 5183.666666666667

The average response time. Unit: milliseconds.

Bps String 380.9614285714286

The bandwidth.

ByteHitRate String 100.0

The byte hit ratio. A value of 90 indicates that the byte hit ratio is 90%.

BytesProportion String 0.003544181046236794

The proportion of bytes transferred from each region. For example, a value of 90 indicates that 90% of the bytes are transferred from the specified area.

Proportion String 0.01155980271270037

The proportion of visits from each region. For example, a value of 90 indicates that 90% of the visits are from the specified area.

Qps String 5.9523809523809524E-5

The number of queries per second.

Region String Japan

The information about the region.

RegionEname String japan

The name of the region.

ReqErrRate String 0.0

The request error rate. A value of 90 indicates that 90% of the requests encountered errors.

ReqHitRate String 100.0

The request cache hit ratio. A value of 0.5 indicates that the cache hit ratio is 0.5%.

TotalBytes String 2400057

The total amount of network traffic.

TotalQuery String 3

The total number of requests.

Examples

Sample requests

http://cdn.aliyuncs.com/?Action=DescribeDomainRegionData
&DomainName=example.com
&StartTime=2016-03-13
&EndTime=2016-03-14
&<Common request parameters>

Sample success responses

XML format

<DescribeDomainRegionDataResponse>
      <Value>
            <RegionProportionData>
                  <Bps>380.9614285714286</Bps>
                  <Proportion>0.01155980271270037</Proportion>
                  <TotalBytes>2400057</TotalBytes>
                  <BytesProportion>0.003544181046236794</BytesProportion>
                  <TotalQuery>3</TotalQuery>
                  <RegionEname></RegionEname>
                  <Region>Japan</Region>
                  <AvgResponseRate>154.3345765545624</AvgResponseRate>
                  <AvgObjectSize>800019.0</AvgObjectSize>
                  <Qps>5.9523809523809524E-5</Qps>
                  <AvgResponseTime>5183.666666666667</AvgResponseTime>
            </RegionProportionData>
            <RegionProportionData>
                  <Bps>25110.431412698414</Bps>
                  <Proportion>0.31211467324291</Proportion>
                  <TotalBytes>158195717</TotalBytes>
                  <BytesProportion>0.23360872886644055</BytesProportion>
                  <TotalQuery>81</TotalQuery>
                  <RegionEname>xizang</RegionEname>
                  <Region>Tibet Autonomous Region</Region>
                  <AvgResponseRate>1397.1430909315718</AvgResponseRate>
                  <AvgObjectSize>1953033.5543209878</AvgObjectSize>
                  <Qps>0.0016071428571428571</Qps>
                  <AvgResponseTime>1397.8765432098764</AvgResponseTime>
            </RegionProportionData>
            <RegionProportionData>
                  <Bps>40343.86242857143</Bps>
                  <Proportion>0.33908754623921084</Proportion>
                  <TotalBytes>254166333</TotalBytes>
                  <BytesProportion>0.37532921137846464</BytesProportion>
                  <TotalQuery>88</TotalQuery>
                  <RegionEname>chongqing</RegionEname>
                  <Region>Chongqing</Region>
                  <AvgResponseRate>787.8073097249128</AvgResponseRate>
                  <AvgObjectSize>2888253.7875</AvgObjectSize>
                  <Qps>0.001746031746031746</Qps>
                  <AvgResponseTime>3666.193181818182</AvgResponseTime>
            </RegionProportionData>
      </Value>
      <DataInterval>86400</DataInterval>
      <RequestId>2E5AD83F-BD7B-462E-8319-2E30E305519A</RequestId>
      <DomainName>example.com</DomainName>
      <EndTime>2016-03-14</EndTime>
      <StartTime>2016-03-13</StartTime>
</DescribeDomainRegionDataResponse>

JSON format

{
  "Value": {
    "RegionProportionData": [
      {
        "Bps": "380.9614285714286",
        "Proportion": "0.01155980271270037",
        "TotalBytes": "2400057",
        "BytesProportion": "0.003544181046236794",
        "TotalQuery": "3",
        "RegionEname": "",
        "Region": "Japan",
        "AvgResponseRate": "154.3345765545624",
        "AvgObjectSize": "800019.0",
        "Qps": "5.9523809523809524E-5",
        "AvgResponseTime": "5183.666666666667"
      },
      {
        "Bps": "25110.431412698414",
        "Proportion": "0.31211467324291",
        "TotalBytes": "158195717",
        "BytesProportion": "0.23360872886644055",
        "TotalQuery": "81",
        "RegionEname": "xizang",
        "Region": "Tibet Autonomous Region",
        "AvgResponseRate": "1397.1430909315718",
        "AvgObjectSize": "1953033.5543209878",
        "Qps": "0.0016071428571428571",
        "AvgResponseTime": "1397.8765432098764"
      },
      {
        "Bps": "40343.86242857143",
        "Proportion": "0.33908754623921084",
        "TotalBytes": "254166333",
        "BytesProportion": "0.37532921137846464",
        "TotalQuery": "88",
        "RegionEname": "chongqing",
        "Region": "Chongqing",
        "AvgResponseRate": "787.8073097249128",
        "AvgObjectSize": "2888253.7875",
        "Qps": "0.001746031746031746",
        "AvgResponseTime": "3666.193181818182"
      }
    ]
  },
  "DataInterval": "86400",
  "RequestId": "2E5AD83F-BD7B-462E-8319-2E30E305519A",
  "DomainName": "example.com",
  "EndTime": "2016-03-14",
  "StartTime": "2016-03-13"
}

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.
404 InvalidDomain.NotFound The domain provided does not exist in our records. The error message returned because the specified domain name does not exist or does not belong to the current account. Check whether the domain name is correctly specified, whether the domain name is under the current Alibaba Cloud account, and whether the domain name has expired.

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