Queries operations reports.

Note This operation queries the metadata of all operations reports. The statistics in the reports are not returned.

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 parameter

Parameter Type Required Example Description
Action String Yes DescribeDcdnReportList

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

ReportId Long No 2

The ID of the operations report that you want to query. If you do not specify an ID, all operations reports are queried.

Status String No enable

The status of the operations report. Valid values:

  • enable: enabled
  • disable: disabled
Note The Status parameter is reserved. You do not need to set it.
Permission String No public

The permissions on the operations report. Valid values:

  • public: public report
  • private: private report
Note The type of report returned is based on the specified permissions. If you do not specify permissions, both public and private reports are queried.

Response parameters

Parameter Type Example Description
Content String "data": [{"reportId":2,"deliver":{"report":{"title":"DomainPvUv","format":"chart","shape":"line","xAxis":"ds","yAxis":"cnt","legend":"cnt_type","header":["ds","cnt_type","cnt"]}}}

The information about the report that is queried.

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

The ID of the request.

Fields of the Content parameter

Field

Type

Description

reportId

Long

The ID of the request.

deliver

report

The type of the report.

Fields of the report parameter

Field

Type

Description

title

String

The title of the operations 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)://dcdn.aliyuncs.com/?Action=DescribeDcdnReportList
&ReportId=2
&Permission=public
&<Common request parameters>

Sample success responses

XML format

<DescribeDcdnReportListResponse>
  <RequestId>04F0F334-1335-436C-A1D7-6C044FE73368</RequestId>
  <Content>
        <data>
              <reportId>2</reportId>
              <deliver>
                    <report>
                          <title>DomainPvUv</title>
                          <format>chart</format>
                          <shape>line</shape>
                          <xAxis>ds</xAxis>
                          <yAxis>cnt</yAxis>
                          <legend>cnt_type</legend>
                          <header>ds</header>
                          <header>cnt_type</header>
                          <header>cnt</header>
                    </report>
              </deliver>
        </data>
        <data>
              <reportId>4</reportId>
              <deliver>
                    <report>
                          <format>table</format>
                          <shape>line</shape>
                          <header>url</header>
                          <header>traf</header>
                          <header>traf_rate</header>
                          <header>acc</header>
                          <header>acc_rate</header>
                          <title>TopUrlByAcc</title>
                    </report>
              </deliver>
        </data>
  </Content>
</DescribeDcdnReportListResponse>

JSON format

{
    "RequestId": "04F0F334-1335-436C-A1D7-6C044FE73368",
    "Content": {
        "data": [
            {
                  "reportId":2,
                  "deliver":{
                      "report":{
                          "title":"DomainPvUv",
                          "format":"chart",
                          "shape":"line",
                          "xAxis":"ds",
                          "yAxis":"cnt",
                          "legend":"cnt_type",
                          "header":[
                              "ds",
                              "cnt_type",
                              "cnt"
                          ]
                      }
                  }
            },
            {
                 "reportId":4,
                 "deliver":{
                     "report":{
                         "format":"table",
                         "shape":"line",
                         "header":[
                             "url",
                             "traf",
                             "traf_rate",
                             "acc",
                             "acc_rate"
                         ],
                         "title":"TopUrlByAcc"
                     }
                 }
            }
        ]
    }
}

Error codes

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