Queries the content of an operations report.

Note You can call this operation up to three 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 DescribeCdnReport

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

DomainName String No www.example1.com,example2.com

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

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 operation to query the report ID.

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 the Chinese mainland. Valid values:

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

The HTTP status code. 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.

StartTime String Yes 2020-09-17T00:00:00Z

The beginning of the time range to query. Specify the time in the yyyy-MM-ddTHH:mm:ssZ format. The time must be in UTC.

EndTime String Yes 2020-09-17T01:00:00Z

The end of the time range to query. Specify the time in the yyyy-MM-ddTHH:mm:ssZ format. The time must be in UTC.

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 IPs by Traffic

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

Other parameters are not supported.

Top Client IPs by Request

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

Other parameters are not supported.

Visit Distribution 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.

Popular Referer by Traffic

Action, ReportId, DomainName, StartTime, and EndTime

Other parameters are not supported.

Popular Referer by Request

Action, ReportId, DomainName, StartTime, and EndTime

Other parameters are not supported.

Popular URLs by Traffic

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

Other parameters are not supported.

Popular URLs by Request

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

Other parameters are not supported.

Popular Back-to-origin URLs by Traffic

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

Other parameters are not supported.

Popular Back-to-origin URLs by Request

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

Other parameters are not supported.

Popular Domain Names by 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"]}},"data":[{"acc":440,"acc_rate":"0.200%","traf":22,"url":"http://demo.com","traf_rate":"0.100%"},{"acc":440,"acc_rate":"0.200%","traf":22,"url":"http://demo.com","traf_rate":"0.100%"}]}]}}

The content of the operations report.

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

The ID of the request.

Fields of the data parameter

Field

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

Field

Type

Description

title

String

The title of the report.

format

String

The type of the operations report. Valid values:

chart

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://cdn.aliyuncs.com?Action=DescribeCdnReport
&ReportId=1
&DomainName=www.example1.com,www.example2.com
&StartTime=2020-09-17T00:00:00Z
&EndTime=2020-09-17T01:00:00Z
&<Common request parameters>

Sample success responses

XML format

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

<DescribeCdnReportResponse>
    <RequestId>04F0F334-1335-436C-A1D7-6C044FE73368</RequestId>
    <Description>Successful</Description>
    <Content>
        <data>
            <deliver>
                <report>
                    <title>TopUrlByAcc</title>
                    <format>table</format>
                    <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://demo.com</url>
                <traf_rate>0.100%</traf_rate>
            </data>
            <data>
                <acc>440</acc>
                <acc_rate>0.200%</acc_rate>
                <traf>22</traf>
                <url>http://demo.com</url>
                <traf_rate>0.100%</traf_rate>
            </data>
        </data>
    </Content>
</DescribeCdnReportResponse>

JSON format

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

{
  "RequestId" : "04F0F334-1335-436C-A1D7-6C044FE73368",
  "Description" : "Successful",
  "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://demo.com",
        "traf_rate" : "0.100%"
      }, {
        "acc" : 440,
        "acc_rate" : "0.200%",
        "traf" : 22,
        "url" : "http://demo.com",
        "traf_rate" : "0.100%"
      } ]
    } ]
  }
}

Error codes

HttpCode Error code Error message Description
400 InvalidParameter The specified parameter is invalid. The error message returned because the specified parameter is invalid.
400 TimeParseFailed Failed to parse the time parameter. The error message returned because the time parameter failed to be parsed.
400 SubscriptionAlreadyExists The subscription already exists. The error message returned because the tracking task already exists.
400 SubscriptionNotFound The subscription is not found. The error message returned because the tracking task does not exist.
400 NameAlreadyExists The name already exists. The error message returned because the name of the tracking task already exists.
400 DeliverExceedLimit The maximum number of subscribed tasks is exceeded. The error message returned because the maximum number of tracking tasks has been reached.

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