Queries operations reports.

Note
  • This operation queries the metadata of all operations reports. The statistics in the reports are not returned.
  • You can call this API 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 DescribeCdnReportList

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

ReportId Long No 1

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

Response parameters

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

The information about the operations report.

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

The ID of the request.

Fields of the data parameter

Parameter

Type

Description

reportId

Long

The ID of the request.

deliver

report

The type of the report.

Fields of the report parameter

Parameter

Type

Description

title

String

The title of the report.

format

String

The type of the 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://cdn.aliyuncs.com?Action=DescribeCdnReportList
&ReportId=1
&Permission=public
&<Common request parameters>

Sample success responses

XML format

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

<DescribeCdnReportListResponse>
    <RequestId>04F0F334-1335-436C-A1D7-6C044FE73368</RequestId>
    <Description>Successful</Description>
    <Content>
        <data>
            <reportId>1</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>2</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>
</DescribeCdnReportListResponse>

JSON format

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

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

Error codes

HttpCode Error code Error message Description
400 InvalidParameter The specified parameter is invalid. The error message returned because one or more parameters are 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.