DescribeCdnReport-阿里云帮助中心

Call DescribeCdnReport to query customized reports.

Operation description

Note

A single user is limited to 3 calls per second.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

cdn:DescribeCdnReport

get

*Domain

acs:cdn:*:{#accountId}:domain/{#DomainName}

None

Request parameters

Parameter	Type	Required	Description	Example
DomainName	string	No	The domain names to query. Separate multiple domain names with commas.	www.example1.com,example2.com
ReportId	integer	Yes	The ID of the report to query. You can specify only one report ID per call. To query report IDs, call the DescribeCdnSubList operation.	1
Area	string	No	The name of the region. To get a list of supported regions, call the DescribeCdnRegionAndIsp operation. If you omit this parameter, data for all regions is returned. You can specify one or more regions, separated by commas.	shanghai
IsOverseas	string	No	Specifies whether the region is outside the Chinese mainland. Valid values: 1: A region outside the Chinese mainland. 0: The Chinese mainland.	0
HttpCode	string	No	The HTTP status code. Valid values: 2xx: 2xx status codes. 3xx: 3xx status codes. 4xx: 4xx status codes. 5xx: 5xx status codes. If you do not specify this parameter, data for all supported HTTP status codes is returned.	2xx
StartTime	string	Yes	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.	2020-09-17T00:00:00Z
EndTime	string	Yes	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.	2020-09-17T01:00:00Z

Required parameters for each report

Report name	Required parameters	Description
PV and UV	Action, ReportId, DomainName, StartTime, and EndTime.	No other parameters are supported.
Top client IPs by traffic	Action, ReportId, DomainName, Area, StartTime, and EndTime.	No other parameters are supported.
Top client IPs by request count	Action, ReportId, DomainName, Area, StartTime, and EndTime.	No other parameters are supported.
Access distribution by region	Action, ReportId, DomainName, IsOverseas, StartTime, and EndTime.	No other parameters are supported.
ISP distribution	Action, ReportId, DomainName, IsOverseas, StartTime, and EndTime.	No other parameters are supported.
Top Referer by traffic	Action, ReportId, DomainName, StartTime, and EndTime.	No other parameters are supported.
Top Referer by request count	Action, ReportId, DomainName, StartTime, and EndTime.	No other parameters are supported.
Top URLs by traffic	Action, ReportId, DomainName, HttpCode, StartTime, and EndTime.	No other parameters are supported.
Top URLs by request count	Action, ReportId, DomainName, HttpCode, StartTime, and EndTime.	No other parameters are supported.
Top back-to-origin URLs by traffic	Action, ReportId, DomainName, HttpCode, StartTime, and EndTime.	No other parameters are supported.
Top back-to-origin URLs by request count	Action, ReportId, DomainName, HttpCode, StartTime, and EndTime.	No other parameters are supported.
Domain name ranking by traffic	Action, ReportId, StartTime, and EndTime.	No other parameters are supported.

Response elements

Element	Type	Description	Example
	object
Content	object	The report data returned by the query.	{ "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%" } ] } ] }
data	array<object>
	array<object>
data	array<object>
	object
	string
deliver	object
report	object
format	string		table
header	array
	string		acc
outLine	integer		0
outSize	integer		0
shape	string		line
title	string		test
RequestId	string	The ID of the request.	04F0F334-1335-436C-A1D7-6C044FE73368

The data object

Parameter	Type	Description
deliver	report	The report definition.
data	String[]	An array of objects containing the report data. For example: `[{"header 1":"value1","header 2":"value2"}, {"header 1":"value3","header 2":"value4"}]`.

The report object

Parameter	Type	Description
title	String	The report title.
format	String	The report type. Possible values: `chart`: Displays the data as a chart. `table`: Displays the data as a table.
shape	String	The chart type. This parameter applies only when `format` is `chart`. Possible values: `line`: A line chart. `pie`: A pie chart. `bar`: A bar chart.
header	String[]	An array of strings for the report headers.
legend	String	The data field for the chart's legend.
xAxis	String	The data field for the chart's x-axis. Can be empty.
yAxis	String	The data field for the chart's y-axis. Can be empty.

Examples

Success response

JSON format

{
  "Content": {
    "data": [
      {
        "data": [
          {
            "key": ""
          }
        ],
        "deliver": {
          "report": {
            "format": "table",
            "header": [
              "acc"
            ],
            "outLine": 0,
            "outSize": 0,
            "shape": "line",
            "title": "test"
          }
        }
      }
    ]
  },
  "RequestId": "04F0F334-1335-436C-A1D7-6C044FE73368"
}

Error codes

HTTP status code	Error code	Error message	Description
400	InvalidParameter	The specified parameter is invalid.
400	TimeParseFailed	Failed to parse the time parameter.	Failed to parse the time parameter.
400	SubscriptionAlreadyExists	The subscription already exists.	The subscription already exists.
400	SubscriptionNotFound	The subscription is not found.	The subscription is not found.
400	NameAlreadyExists	The name already exists.	The specified name already exists.
400	DeliverExceedLimit	The maximum number of subscribed tasks is exceeded.	The number of tracking tasks has reached the upper limit.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.