Queries the content of an operations report.
Description
Authorization information
The following table is the authorization information corresponding to the API, which can be found in the RAM permission policy statement.Action
Used in the element to grant the RAM user or RAM role permission to call this API. The specific instructions are as follows:
- 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:
- The required resource types are displayed in bold characters.
- If the permissions cannot be granted at the resource level,
All resources
is used in the Resource type column of the operation.
- Condition keyword: refers to the condition keyword defined by the cloud product itself.
- 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.
Operate | Access level | Resource type | Condition keyword | Association operation |
---|---|---|---|---|
cdn:DescribeCdnReport | Read |
|
| 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.example1.com,example2.com |
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 DescribeCdnSubList operation to query the report ID. | 1 |
Area | string | No | The region. You can call the DescribeCdnRegionAndIsp operation to query the most recent region list.
| 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, all HTTP status codes are 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. | 2020-09-17T00: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. | 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 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. |
Visit Distribution 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 Referer by Traffic | Action, ReportId, DomainName, StartTime, and EndTime | Other parameters are not supported. |
Popular Referer 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
Example
Normal return example
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 API error center.