DescribeDcdnReport - Edge Security Acceleration - Alibaba Cloud Documentation Center

Queries the content of an operations report.

Operation description

Note You can call this operation up to three times per second per account.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Debug

Authorization information

There is currently no authorization information disclosed in the API.

Request parameters

Parameter	Type	Required	Description	Example
DomainName	string	No	The domain names that you want to query. Separate domain names with commas (,).	www.example.com,www.example.org
ReportId	long	Yes	The ID of the operations report that you want to query. You can enter only one ID in each call. You can call the DescribeDcdnSubList operation to query report IDs.	2
Area	string	No	The region. You can call the DescribeDcdnRegionAndIsp operation to query regions. If you do not specify a region, data in all regions is queried. If you specify a region, data in the specified region is returned. You can specify one or more regions. Separate regions with commas (,).	shanghai
IsOverseas	string	No	Specify whether the region is outside the Chinese mainland. Valid values: 1: outside the Chinese mainland 0: inside the Chinese mainland	0
HttpCode	string	No	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, data for all preceding HTTP status codes is queried.	2xx
StartTime	string	Yes	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.	2021-07-02T00:00:00Z
EndTime	string	Yes	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.	2021-07-02T01:00:00Z

Parameters required for 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. | | Distribution of visits 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 Referers by traffic | Action, ReportId, DomainName, StartTime, and EndTime | Other parameters are not supported. | | Popular Referers by request | Action, ReportId, DomainName, Area, 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	Description	Example
	object
Content	object	The content of the operations report.	"data":[{"deliver":{ "report":{"title":"TopUrlByAcc","format":"table","sape":"","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://example.org","traf_rate":"0.100%"}]}]
RequestId	string	The ID of the request.	04F0F334-1335-436C-A1D7-6C044FE73368

Fields in the Content parameter | Field | Type | Description |--------|------------------| | deliver | report | The type of the report. | | data | String[] | Data of the report: [{"Field 1":"value1","Field 2":"value2"}, {"field 1":"value3","field 2":"value4"}] |

Fields in the report parameter | Field | Type | Description |--------|------------------| | title | String | The title of the report. | | format | String | The format of the report. Valid values:
chart
table | | shape | String | The type of the chart. When the format is table, ignore this field. Valid values:
line
pie
bar | | 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 the chart does not have an x-axis, this field is empty. | | yAxis | String | The y-axis of the graph. If the chart does not have a y-axis, this field is empty. |

Examples

Sample success responses

JSONformat

{
  "Content": {
    "test": "test",
    "test2": 1
  },
  "RequestId": "04F0F334-1335-436C-A1D7-6C044FE73368"
}

Error codes

HTTP status code	Error code	Error message	Description
400	InvalidParameter	The specified parameter is invalid.	A parameter is set to an invalid value.
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 name already exists.
400	DeliverExceedLimit	The maximum number of subscribed tasks is exceeded.	The number of tracking tasks has reached the upper limit.

For a list of error codes, visit the Service error codes.