Queries the real-time monitoring data for a domain name.
Operation Description
- You can query data in the last seven days. Data is collected every minute.
- You can call this operation up to 10 times per second per account.
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:
- 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 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 |
---|---|---|---|---|
cdn:DescribeDomainRealTimeDetailData | READ |
|
| none |
Request parameters
Parameter | Type | Required | Description | Example |
---|---|---|---|---|
DomainName | string | Yes | The accelerated domain name that you want to query. | example.com |
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. Example: 2019-11-30T05:33:00Z. | 2019-11-30T05:33: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. Example: 2019-11-30T05:40:00Z. NoteThe end time must be later than the start time. The difference between the end time and the start time cannot exceed 10 minutes. | 2019-11-30T05:40:00Z |
Field | string | Yes | The type of data that you want to query. You can specify multiple data types and separate them with commas (,). Valid values:
| qps |
LocationNameEn | string | No | The name of the region. If you do not specify a region, data in all regions is queried. You can call the DescribeCdnRegionAndIsp operation to query regions. | Guangdong |
IspNameEn | string | No | The name of the Internet service provider (ISP). You can call the DescribeCdnRegionAndIsp operation to query ISPs. If you do not specify an ISP, data of all ISPs is queried. | telecom |
Merge | string | No | Specifies whether to return a summary value based on ISPs and regions. Valid values:
Default value: false. | false |
MergeLocIsp | string | No | Specifies whether to return a summary value based on ISPs and regions. Valid values:
Default value: false. | false |
Response parameters
The following table describes the fields in the Data parameter. If a field is empty, the field is not returned.
Parameter | Type | Description | Example |
---|---|---|---|
domain_name | String | The domain name that was queried. | example.com |
isp | String | The ISP name. | unicom |
location | String | The region name. | qingdao |
qps | Long | The QPS. | 40 |
bps | Long | The bandwidth. Unit: bit/s. | 100 |
http_code | Map | The information about HTTP status codes. The key is the HTTP status code and the value is the number of occurrences of the HTTP status code. | {"200": 1, "304": 2, "403": 3} |
time_stp | String | The beginning of the time range that was queried. The time follows the ISO 8601 standard in the yyyy-MM-ddThh:mm:ssZ format. The time is displayed in UTC. | 2022-10-20T04:00:00Z |
Examples
Sample success responses
JSON
format
{
"Data": "[\n {\n \"time_stp\": \"2018-06-05T20:00:00Z\",\n \"domain_name\": \"example.com\",\n \"location\": \"Guangdong\",\n \"isp\": \"telecom\",\n \"qps\": 10\n },\n {\n \"time_stp\": \"2018-06-05T20:00:00Z\",\n \"domain_name\": \"example.com\",\n \"location\": \"Jiangsu\",\n \"isp\": \"unicom\",\n \"qps\": 11.1\n }\n]",
"RequestId": "B49E6DDA-F413-422B-B58E-2FA23F286726"
}
Error codes
HTTP status code | Error code | Error message | Description |
---|---|---|---|
400 | InvalidTime.Malformed | Specified StartTime or EndTime is malformed. | The specified start or end time is invalid. |
400 | InvalidDomainName.Malformed | Specified domain name is malformed. | - |
For a list of error codes, visit the Service error codes.