All Products
Search
Document Center

Dynamic Content Delivery Network:DescribeDcdnDomainRealTimeDetailData

Last Updated:Mar 01, 2024

Queries traffic usage through each Internet service provider (ISP) and the number of visits in each region. The resolution of the data is one minute. The maximum time range to query for this operation is 10 minutes.

Operation description

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

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

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.
OperationAccess levelResource typeCondition keyAssociated operation
dcdn:DescribeDcdnDomainRealTimeDetailDataRead
  • Domain
    acs:dcdn:*:{#accountId}:domain/{#domainName}
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
DomainNamestringYes

The accelerated domain name. Separate multiple accelerated domain names with commas (,).

example.com
StartTimestringYes

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.

2019-11-30T05:33:00Z
EndTimestringYes

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.

Note The end time must be later than the start time, and the maximum time range to query is 10 minutes.
2019-11-30T05:40:00Z
FieldstringYes

The type of information that you want to query. Separate multiple types with commas (,). Valid values:

  • qps: queries per second (QPS)
  • bps: bandwidth
  • http_code: HTTP status code
bps
LocationNameEnstringNo

The name of the region. You can call the DescribeDcdnRegionAndIsp operation to query the region name.

If you leave this parameter empty, all regions are queried.

beijing
IspNameEnstringNo

The name of the ISP. You can call the DescribeDcdnRegionAndIsp operation to query the ISP name.

If you leave this parameter empty, all ISPs are queried.

unicom
MergestringNo

Specifies whether to return a summary value. Valid values:

  • true
  • false

Default value: false.

true
MergeLocIspstringNo

Specifies whether to return a summary value of LocationNameEn and IspNameEn. Valid values:

  • true
  • false

Default value: false.

true

Response parameters

ParameterTypeDescriptionExample
object
Datastring

The information returned.

Note The value of this parameter is a JSON string. The following table describes the fields in Data.
[ { "time_stp": "2018-06-05T20:00:00Z", "domain_name": "example.com", "location": "Guangdong", "isp": "telecom", "qps": 10.0 }, { "time_stp": "2018-06-05T20:00:00Z", "domain_name": "example.com", "location": "Jiangsu", "isp": "unicom", "qps": 11.1 } ]
RequestIdstring

The ID of the request.

A603F324-7A05-4FB3-ADF3-2563233D26CC

Fields in Data

FieldTypeDescriptionExample
domain_nameStringThe domain name that was queried.example.com
ispStringThe name of the ISP.unicom
locationStringThe name of the region.qingdao
qpsLongThe QPS.40
bpsLongThe bandwidth value.100
http_codeMapThe HTTP status codes returned. The key indicates the HTTP status code and the value indicates the number of the HTTP status codes.{"200": 1, "304": 2, "403": 3}
time_stpStringThe 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

JSONformat

{
  "Data": "[\n    {\n      \"time_stp\": \"2018-06-05T20:00:00Z\",\n      \"domain_name\": \"example.com\",\n      \"location\": \"Guangdong\",\n      \"isp\": \"telecom\",\n      \"qps\": 10.0\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": "A603F324-7A05-4FB3-ADF3-2563233D26CC"
}

Error codes

HTTP status codeError codeError messageDescription
400MissingTimeParameterThe StartTime and EndTime must be both specified.You must set both the start time and the end time.
400InvalidStartTime.MalformedThe specified StartTime parameter is invalid.The format of the specified start time is invalid. Specify the time in the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time must be in UTC.
400InvalidEndTime.MalformedThe specified EndTime is invalid.The format of the specified end time is invalid. Specify the time in the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time must be in UTC.
400InvalidParameterThe specified parameter is invalid.A parameter is set to an invalid value.
400InvalidTime.MalformedSpecified StartTime or EndTime is malformed.The format of the specified start time or end time is invalid. Specify the time in the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time must be in UTC.
400InvalidDomainName.MalformedThe specific DomainName is invalid.The specified domain name is invalid.
400InvalidStartTime.ValueNotSupportedThe specified StartTime is invalid.The specified start time is invalid.

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

Change history

Change timeSummary of changesOperation
2023-07-04The Error code has changedsee changesets
Change itemChange content
Error CodesThe Error code has changed.
    delete Error Codes: 400