Queries the content of a specified operations report.

Note
  • The maximum number of times that each user can call this operation per second is 3.
  • You can specify multiple domain names (no more than 500) and separate them with commas (,).

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 DescribeCdnReport

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

EndTime String Yes 2021-07-02T01: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+0.

ReportId Long Yes 1

The ID of the operations report that you want to query. You can enter only one ID in each call. You can call the DescribeCdnSubList operations to query report IDs.

StartTime String Yes 2021-07-02T00:00:00Z

The start 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+0.

DomainName String No example.com,aliyundoc.com

The domain names that you want to query. Separate domain names with commas (,).

Area String No shanghai

The region. You can call the DescribeCdnRegionAndIsp operation to query the most recent region list.

  • If you do not specify a region, all regions are queried.
  • If you specify a region, data in the specified region is returned. You can specify one or more regions. Separate regions with commas (,).
IsOverseas String No 0

Specify whether the region is outside mainland China. Valid values:

  • 1: outside mainland China
  • 0: inside mainland China
HttpCode String No 2xx

The HTTP status codes. Valid values:

  • 2xx: HTTP 2xx status codes
  • 3xx: HTTP 3xx status codes
  • 4xx: HTTP 4xx status codes
  • 5xx: HTTP 5xx status codes

If you do not specify an HTTP status code, all HTTP status codes are queried.

Parameters required by each report metric

Report metric

Required parameter

Description

PV and UV

Action, ReportId, DomainName, StartTime, and EndTime

Other parameters are not supported.

Top client IP addresses (ranked by the amount of network traffic)

Action, ReportId, DomainName, Area, StartTime, and EndTime

Other parameters are not supported.

Top client IP addresses (ranked by the number of requests)

Action, ReportId, DomainName, Area, StartTime, and EndTime

Other parameters are not supported.

Distribution of requests by region

Action, ReportId, DomainName, IsOverseas, StartTime, and EndTime

Other parameters are not supported.

Distribution of ISPs

Action, ReportId, DomainName, IsOverseas, StartTime, and EndTime

Other parameters are not supported.

Frequently used referer headers (ranked by the amount of network traffic)

Action, ReportId, DomainName, StartTime, and EndTime

Other parameters are not supported.

Frequently used referer headers (ranked by the number of requests)

Action, ReportId, DomainName, StartTime, and EndTime

Other parameters are not supported.

Frequently requested URLs (ranked by the amount of network traffic)

Action, ReportId, DomainName, HttpCode, StartTime, and EndTime

Other parameters are not supported.

Frequently requested URLs (ranked by the number of requests)

Action, ReportId, DomainName, HttpCode, StartTime, and EndTime

Other parameters are not supported.

Frequently requested back-to-origin URLs (ranked by the amount of network traffic)

Action, ReportId, DomainName, HttpCode, StartTime, and EndTime

Other parameters are not supported.

Frequently requested back-to-origin URLs (ranked by the number of requests)

Action, ReportId, DomainName, HttpCode, StartTime, and EndTime

Other parameters are not supported.

Domain names ranked by the amount of network traffic

Action, ReportId, StartTime, and EndTime

Other parameters are not supported.

Response parameters

Parameter Type Example Description
Content String "data":[{"deliver":{"report":{"title":"TopUrlByAcc","format":"table","shape":"","header":["url","traf","traf_rate","acc","acc_rate"]}}

The content of the operations report.

RequestId String 04F0F334-1335-436C-A1D7-6C044FE73368

The ID of the request.

Fields of the Content parameter

Filed

Type

Description

deliver

report

The type of the report.

data

String[]

The content in the operations report, for example, [{"Header Field 1":"value1","Header Field 2":"value2"}, {"Header Field 1":"value3","Header Field 2":"value4"}].

Fields of the report parameter

Filed

Type

Description

title

String

The title of the report.

format

String

The type of the operations report. Valid values:

chart: chart

table: table

shape

String

The type of the chart. When format is set to table, ignore this field. Valid values:

line: line chart

pie: pie chart

bar: bar chart

header

String[]

The fields that are used as the table headers.

legend

String

The fields that are used as the legends.

xAxis

String

The x-axis of the chart. If you do not specify a value, the chart does not have an x-axis.

yAxis

String

The y-axis of the chart. If you do not specify a value, the chart does not have a y-axis.

Examples

Sample requests

http(s)://cdn.aliyuncs.com/?Action=DescribeCdnReport
&DomainName=example.com,aliyundoc.com
&ReportId=1
&StartTime=2021-07-02T00:00:00Z
&EndTime=2021-07-02T01:00:00Z
&<Common request parameters>

Sample success responses

XML format 

<DescribeCdnReportResponse>
  <RequestId>04F0F334-1335-436C-A1D7-6C044FE73368</RequestId>
  <Content>
        <data>
              <deliver>
                    <report>
                          <title>TopUrlByAcc</title>
                          <format>table</format>
                          <shape></shape>
                          <header>url</header>
                          <header>traf</header>
                          <header>traf_rate</header>
                          <header>acc</header>
                          <header>acc_rate</header>
                    </report>
              </deliver>
              <data>
                    <acc>440</acc>
                    <acc_rate>0.200%</acc_rate>
                    <traf>22</traf>
                    <url>http://example.com</url>
                    <traf_rate>0.100%</traf_rate>
              </data>
              <data>
                    <acc>440</acc>
                    <acc_rate>0.200%</acc_rate>
                    <traf>22</traf>
                    <url>http://aliyundoc.com</url>
                    <traf_rate>0.100%</traf_rate>
              </data>
        </data>
  </Content>
</DescribeCdnReportResponse>

JSON format 

{
    "RequestId":"04F0F334-1335-436C-A1D7-6C044FE73368",
    "Content":{
        "data":[
            {
                "deliver":{
                    "report":{
                        "title":"TopUrlByAcc",
                        "format":"table",
                        "shape":"",
                        "header":[
                            "url",
                            "traf",
                            "traf_rate",
                            "acc",
                            "acc_rate"
                        ]
                    }
                },
                "data":[
                        {
                            "acc":440,
                            "acc_rate":"0.200%",
                            "traf":22,
                            "url":"http://example.com",
                            "traf_rate":"0.100%"
                        },
                        {
                            "acc":440,
                            "acc_rate":"0.200%",
                            "traf":22,
                            "url":"http://aliyundoc.com",
                            "traf_rate":"0.100%"
                        }                                          
                ]
            }
        ]
    }
}

Error codes

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