All Products
Search

This Product

    CDN:DescribeDomainRealTimeDetailData

    Document Center

    CDN:DescribeDomainRealTimeDetailData

    Last Updated:May 30, 2023

    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.
    OperationAccess levelResource typeCondition keyAssociated operation
    cdn:DescribeDomainRealTimeDetailDataREAD
    • CDN
      acs:cdn:*:{#accountId}:domain/{#DomainName}
      none
    		none

    Request parameters

    ParameterTypeRequiredDescriptionExample
    DomainNamestringYes

    The accelerated domain name that you want to query.

    		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. Example: 2019-11-30T05:33:00Z.

    		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. 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
    FieldstringYes

    The type of data that you want to query. You can specify multiple data types and separate them with commas (,). Valid values:

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

    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
    IspNameEnstringNo

    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
    MergestringNo

    Specifies whether to return a summary value based on ISPs and regions. Valid values:

    • true
    • false

    Default value: false.

    		false
    MergeLocIspstringNo

    Specifies whether to return a summary value based on ISPs and regions. Valid values:

    • true
    • false

    Default value: false.

    		false

    Response parameters

    ParameterTypeDescriptionExample
    object
    Datastring

    The monitoring data of each ISP in each region.

    		[ { "time_stp": "2018-06-05T20:00:00Z", "domain_name": "example.com", "location": "Guangdong", "isp": "telecom", "qps": 10 }, { "time_stp": "2018-06-05T20:00:00Z", "domain_name": "example.com", "location": "Jiangsu", "isp": "unicom", "qps": 11.1 } ]
    RequestIdstring

    The request ID.

    		B49E6DDA-F413-422B-B58E-2FA23F286726
    NoteThe value of the Data parameter is a JSON string. The following table describes the structure and fields of the Data parameter.

    The following table describes the fields in the Data parameter. If a field is empty, the field is not returned.

    ParameterTypeDescriptionExample
    domain_nameStringThe domain name that was queried.example.com
    ispStringThe ISP name.unicom
    locationStringThe region name.qingdao
    qpsLongThe QPS.40
    bpsLongThe bandwidth. Unit: bit/s.100
    http_codeMapThe 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_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\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 codeError codeError messageDescription
    400InvalidTime.MalformedSpecified StartTime or EndTime is malformed.The specified start or end time is invalid.
    400InvalidDomainName.MalformedSpecified domain name is malformed.-

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