Queries the content of an operations report.
Operation description
Debugging
Authorization information
The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action
policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:
- Operation: the value that you can use in the Action element to specify the operation on a resource.
- Access level: the access level of each operation. The levels are read, write, and list.
- Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
- For mandatory resource types, indicate with a prefix of * .
- If the permissions cannot be granted at the resource level,
All Resources
is used in the Resource type column of the operation.
- Condition Key: the condition key that is defined by the cloud service.
- Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
Operation | Access level | Resource type | Condition key | Associated operation |
---|---|---|---|---|
dcdn:DescribeDcdnReport | get | *Domain acs:dcdn:*:{#accountId}:domain/{#DomainName} |
| none |
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.
| shanghai |
IsOverseas | string | No | Specify 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 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
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
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. | 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.