Queries traffic usage of domain names through each Internet service provider (ISP) and the number of visits for domain names in each region.

Description

  • You can call this operation up to 10 times per second per account.
  • If you do not set the StartTime or EndTime parameter, the request returns the data collected in the last hour. If you set both the StartTime and EndTime parameters, the request returns the data collected within the specified time range.
Time granularity

The time granularity varies with the time range specified by the StartTime and EndTime parameters. The following table describes the time period within which historical data is available and the data delay.

Time granularity

Maximum time range per query

Historical data available

Data delay

1 minute

1 hour

7 days

5 minutes

5 minutes

3 days

93 days

15 minutes

1 hour

31 days

186 days

4 hours

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 DescribeDcdnDomainRealTimeDetailData

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

DomainName String Yes example.com

The accelerated domain name. Separate multiple accelerated domain names with commas (,).

StartTime String Yes 2019-11-30T05:33: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 Yes 2019-11-30T05:40: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.

Note The end time must be later than the start time.
Field String Yes bps

The type of the information that you want to query. Separate multiple types with commas (,). Valid values:

  • qps: queries per second
  • bps: bandwidth
  • http_code: HTTP status codes
LocationNameEn String No beijing

The name of the region. You can call the DescribeDcdnRegionAndIsp operation to query the region name.

If you do not specify a value for this parameter, all regions are queried.

IspNameEn String No unicom

The name of the ISP. You can call the DescribeDcdnRegionAndIsp operation to query the ISP name.

If you do not specify a value for this parameter, all ISPs are queried.

Merge String No true

Specifies whether to return a summary value. Valid values:

  • true
  • false

Default value: false.

MergeLocIsp String No true

Specifies whether to return a summary value of LocationNameEn and IspNameEn. Valid values:

  • true
  • false

Default value: false.

Response parameters

Parameter Type Example Description
Data String { "time_stp": "2020-01-06T04:17:00Z", "bps": "297.29333333333335", "domain_name": "example.com" }

The information returned.

RequestId String A603F324-7A05-4FB3-ADF3-2563233D26CC

The ID of the request.

Examples

Sample requests

http(s)://cdn.aliyuncs.com/?Action=DescribeDcdnDomainRealTimeDetailData
&DomainName=example.com
&StartTime=2019-11-30T05:33:00Z
&EndTime=2019-11-30T05:40:00Z
&Field=bps
&MergeLocIsp=true
&<Common request parameters>

Sample success responses

XML format

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

<DescribeDcdnDomainRealTimeDetailDataResponse>
<Data>
    <time_stp>2020-01-06T04:17:00Z</time_stp>
    <bps>297.29333333333335</bps>
    <domain_name>example.com</domain_name>
</Data>
<RequestId>A603F324-7A05-4FB3-ADF3-2563233D26CC</RequestId>
</DescribeDcdnDomainRealTimeDetailDataResponse>

JSON format

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

{
  "Data" : [ {
    "time_stp" : "2020-01-06T04:17:00Z",
    "bps" : "297.29333333333335",
    "domain_name" : "example.com"
  } ],
  "RequestId" : "A603F324-7A05-4FB3-ADF3-2563233D26CC"
}

Error codes

HTTP status code Error code Error message Description
400 MissingTimeParameter The StartTime and EndTime must be both specified. The error message returned because no value is specified for the StartTime or EndTime parameter.
400 InvalidEndTime.Malformed The specified EndTime is invalid. The error message returned because the format of the EndTime parameter 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 error message returned because the end time is earlier than the start time.
400 InvalidStartTime.ValueNotSupported The specified StartTime is invalid. The error message returned because the value specified for the StartTime parameter is invalid. Specify a valid value.

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