Queries the unique visitor (UV) data of an accelerated domain name. Data is collected every hour. You can query data collected within the last 90 days.

The statistical analysis feature of Alibaba Cloud CDN is no longer available. The API operations related to the statistical analysis feature are no longer maintained. We recommend that you do not use the API operations because data may be missing or inaccurate. You can use the operations report feature to for data analysis.

Note
  • If you do not set StartTime or EndTime, monitoring data within the last 24 hours is queried. If you set both StartTime and EndTime, monitoring data within the specified time range is queried.
  • You can specify only one accelerated domain name or all accelerated domain names under your Alibaba Cloud account.
  • 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. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.

Request parameters

Parameter Type Required Example Description
Action String Yes DescribeDomainUvData

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

DomainName String Yes example.com

The accelerated domain name. You can specify only one domain name.

StartTime String No 2019-11-29T00:00:00Z

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.

EndTime String No 2019-11-29T04:00:00Z

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.

The end time must be later than the start time.

Response parameters

Parameter Type Example Description
EndTime String 2019-11-29T04:00:00Z

The end of the time range that was queried.

StartTime String 2019-11-29T00:00:00Z

The beginning of the time range that was queried.

RequestId String E9D3257A-1B7C-414C-90C1-8D07AC47BCAC

The ID of the request.

DomainName String example.com

The accelerated domain name.

DataInterval String 3600

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

UvDataInterval Array of UsageData

The number of UVs at each interval.

UsageData
Value String 318

The number of UVs.

TimeStamp String 2019-11-29T00:00:00Z

The timestamp of the returned data.

Examples

Sample requests

http://cdn.aliyuncs.com/?Action=DescribeDomainUvData
&DomainName=example.com
&StartTime=2019-11-29T00:00:00Z
&EndTime=2019-11-29T04:00:00Z
&<Common request parameters>

Sample success responses

XML format

HTTP/1.1 200 OK
Content-Type:application/xml

<DescribeDomainUvDataResponse>
<DataInterval>3600</DataInterval>
<RequestId>17276F0E-66F4-4547-B9C6-42E2547362D4</RequestId>
<DomainName>example.com</DomainName>
<EndTime>2019-11-29T04:00:00Z</EndTime>
<StartTime>2019-11-29T00:00:00Z</StartTime>
<UvDataInterval>
    <UsageData>
        <TimeStamp>2019-11-29T00:00:00Z</TimeStamp>
        <Value>2</Value>
    </UsageData>
    <UsageData>
        <TimeStamp>2019-11-29T01:00:00Z</TimeStamp>
        <Value>12</Value>
    </UsageData>
    <UsageData>
        <TimeStamp>2019-11-29T02:00:00Z</TimeStamp>
        <Value>6</Value>
    </UsageData>
    <UsageData>
        <TimeStamp>2019-11-29T03:00:00Z</TimeStamp>
        <Value>7</Value>
    </UsageData>
    <UsageData>
        <TimeStamp>2019-11-29T04:00:00Z</TimeStamp>
        <Value>5</Value>
    </UsageData>
</UvDataInterval>
</DescribeDomainUvDataResponse>

JSON format

HTTP/1.1 200 OK
Content-Type:application/json

{
  "DataInterval" : "3600",
  "RequestId" : "17276F0E-66F4-4547-B9C6-42E2547362D4",
  "DomainName" : "example.com",
  "EndTime" : "2019-11-29T04:00:00Z",
  "StartTime" : "2019-11-29T00:00:00Z",
  "UvDataInterval" : {
    "UsageData" : [ {
      "TimeStamp" : "2019-11-29T00:00:00Z",
      "Value" : "2"
    }, {
      "TimeStamp" : "2019-11-29T01:00:00Z",
      "Value" : "12"
    }, {
      "TimeStamp" : "2019-11-29T02:00:00Z",
      "Value" : "6"
    }, {
      "TimeStamp" : "2019-11-29T03:00:00Z",
      "Value" : "7"
    }, {
      "TimeStamp" : "2019-11-29T04:00:00Z",
      "Value" : "5"
    } ]
  }
}

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. Set a valid value and try again.
400 InvalidTime.ValueNotSupported StartTime or EndTime is miss match. The error message returned because the time range specified by the StartTime and EndTime parameters is invalid.

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