Queries the content of an operations report.
Operation description
Debugging
Authorization information
Request parameters
Parameter | Type | Required | Description | Example |
---|---|---|---|---|
DomainName | string | No | The domain name that you want to query. Separate domain names with commas (,). | www.example1.com,example2.com |
ReportId | long | Yes | The ID of the operations report that you want to query. You can specify only one ID in each request. You can call the DescribeCdnSubList operation to query report IDs. | 1 |
Area | string | No | The region. You can call the DescribeCdnRegionAndIsp operation to query regions.
| shanghai |
IsOverseas | string | No | Specifies whether the region is outside the Chinese mainland. Valid values:
| 0 |
HttpCode | string | No | The HTTP status code. Valid values:
If you do not specify this parameter, all HTTP status codes are queried. | 2xx |
StartTime | string | Yes | The beginning 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 |
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 IP addresses 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 Internet service providers (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, 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
Fields in the data parameter
Field | Type | Description |
---|---|---|
deliver | report | The type of the report. |
data | String[] | The content in the operations report. Example: [{"Header Field 1":"value1","Header Field 2":"value2"}, {"Header Field 1":"value3","Header 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:charttable |
shape | String | The format of the chart. If format is table, ignore this field. Valid values:linepiebar |
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 success responses
JSON
format
{
"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. | - |
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. |
For a list of error codes, visit the Service error codes.