Content Delivery Network (CDN)

View more results

Document title with current keyword not found

GetDomainHttpCodeDetailedData

Description

You can call this operation to obtain the real-time number of requests responded with different HTTP status codes for specified domain names and their percentage. You can generate a percentage line chart based on the data. You can specify a time granularity for the statistics data, including 1 minute, 5 minutes, 1 hour, and 1 day. If you specify a granularity of 1 hour or 1 day, the sum of values collected in the five-minute periods contained in the granularity is used.
Timeliness: You can query only data that was generated 5 minutes before.
You can query data within the past year. The start time and the end time cannot be more than 90 days apart.
You can specify the domain names (with the CdnType and Domains parameters), areas, provinces, ISP, protocol type, IP address type, and time granularity to query data. The Provinces and Isps parameters take effect only when the value of the Areas parameter contains only CN. In other cases, all provinces and ISPs are queried.
A single query can include up to 1,000 domain names and return up to 10,000 data points. The time period of a single query must contain at least one time granularity. For example, if you select the time granularity of 5 minutes, the start time and the end time must be at least 5 minutes apart.

Request syntax

The API request contains the specified directory /2020-06-30/statistics/GetDomainHttpCodeDetailedData, common request headers, and operation-specific request parameters. For more information, see the sample request.

Request parameters

Parameter	Required	Type	Description
StartTime	Yes	String	The beginning of the time range to query. Specify the time in the ISO 8601 standard in the YYYY-MM-DDThh:mm+0800 format. The time must be in UTC+8. Example: 2016-08-01T21:10+0800.
EndTime	Yes	String	The end of the time range to query. Specify the time in the ISO 8601 standard in the YYYY-MM-DDThh:mm+0800 format. The time must be in UTC+8. The end time must be later than the start time. Example: 2016-08-01T21:15+0800.
Interval	No	Long	The time granularity of the statistics data. Valid values: 1 (one minute), 5 (five minutes), 60 (one hour), and 1440 (one day). For granularities that are greater than or equal to 5 minutes, the sum of values collected in the five-minute periods contained in the granularity is used. The default granularity is 5 minutes. When the granularity is 1 minute, the start time and the end time cannot be more than 24 hours apart. When the granularity is 5 minutes, the start time and the end time cannot be more than 31 days apart. For other granularities, the start time and the end time cannot be more than 90 days apart.
CdnType	Yes	String	The business type. You can specify only one type at a time. Valid values: file, video, page, and download.
Domains	No	String	The domain names to query. Separate multiple domain names with commas (,). By default, all domain names of the current account that are online in the specified time period are queried.
Areas	No	String	The areas of visitors. For more information, see Usage notes. Separate multiple areas with commas (,). By default, all areas are queried.
Provinces	No	String	The provinces. For more information, see Usage notes. Separate multiple provinces with commas (,). By default, all provinces are queried. This parameter takes effect only when the value of the Areas parameter contains only CN.
Isps	No	String	The name of the ISP. For more information, see Usage notes. You can specify only one ISP at a time. By default, all ISPs are queried. This parameter takes effect only when the value of the Areas parameter contains only CN.
IpType	No	String	The type of the IP address. Valid values: ipv4 and ipv6. You can specify only one type at a time. By default, all types are queried.
Schema	No	String	The protocol type. Valid values: http, http, and quic. You can specify only one type at a time. By default, all types are queried.
CodeType	No	String	The status code types. Valid values: 2xx, 3xx, 4xx, and 5xx. By default, all types are queried.
ResultType	No	String	Specifies whether to expand the statistics data and, if yes, in which dimensions. Valid values: unexpand, domain (expand by domain name), code (expand by status code), and expand. Default value: unexpand.

Response parameters

Parameter	Type	Description
StartTime	String	The beginning of the time range that is queried.
EndTime	String	The end of the time range that is queried.
Interval	Long	The time granularity.
CdnType	String	The business type.
Domains	String	The domain names, separated with commas (,).
Areas	String	The areas, separated with commas (,).
Provinces	String	The provinces.
Isps	String	The ISPs.
IpType	String	The type of the IP address.
Schema	String	The protocol type.
ResultType	String	Indicates whether the statistics data is expanded and, if yes, in which dimensions.
CodeType	String	The status code types. Valid values: 2xx, 3xx, 4xx, and 5xx.
Datas	Datas[]	The HTTP status codes in different time granularities and their percentage.

Datas

Parameter	Type	Description
Condition	Condition	The query conditions.
HttpCodeData	HttpCodeData[]	The HTTP status codes.

Condition

Parameter	Type	Description
Domains	String	The domain names, separated with commas (,)

HttpCodeData

Parameter	Type	Description
Time	String	The time point.
CodeType	CodeType[]	The HTTP status code types and percentage. The types include 2xx, 3xx, 4xx, and 5xx.
CodeDetailDatas	CodeDetailDatas[]	The HTTP status codes, such as 200 or 404, and their percentage.

CodeType

Parameter	Type	Description
CodeType	String	The type of the HTTP status code.
Pv	Long	The number of requests responded with status codes of this type.
Proportion	Double	The percentage of requests responded with status codes of this type.

CodeDetailDatas

Parameter	Type	Description
Code	String	The HTTP status code.
Pv	Long	The number of requests responded with this status code.
Proportion	Double	The percentage of requests responded with this status code.

Examples

Sample request

GET method:

GET /2020-06-30/statistics/GetDomainHttpCodeDetailedData?StartTime=2020-09-01T08%3a00%2b0800&EndTime=2020-09-01T08%3a05%2b0800&Interval=5&CdnType=video&Domains=www.test.com&Areas=CN&Provinces=beijing&Isps=&IpType=&Schema=&CodeType=2xx,4xx&ResultType=
Host: cdn.api.ksyun.com
X-Amz-Date: date
Authorization:authorization string
x-action: GetDomainHttpCodeDetailedData
x-version: 2020-06-30

POST method:

POST /2020-06-30/statistics/GetDomainHttpCodeDetailedData
Host: cdn.api.ksyun.com
X-Amz-Date: date
Authorization:authorization string
x-action: GetDomainHttpCodeDetailedData
x-version: 2020-06-30
Content-Type: application/json
{
    "StartTime":"2020-09-01T08:00+0800",
    "EndTime":"2020-09-01T08:05+0800",
    "Interval":5,
    "CdnType":"video",
    "Domains":"www.test.com",
    "Areas":"CN",
    "Provinces":"beijing",
    "Isps":"",
    "IpType":"",
    "Schema":"",
    "CodeType":"2xx,4xx",
    "ResultType":""
}

Sample response

{
    "StartTime": "2020-09-01T08:00+0800",
    "EndTime": "2020-09-01T08:05+0800",
    "Interval":5,
    "CdnType": "video",
    "Domains": "www.test.com",
    "Areas": "CN",
    "Provinces": "beijing",
    "Isps": "PBS,CT,CTT,CE,UN,CM,Other",
    "IpType": "ipv4,ipv6",
    "Schema": "http,https,quic",
    "CodeType":"2xx,4xx",
    "ResultType": "unexpand",
    "Datas": [
        {
            "Condition":
                {
                    "Domains":"www.test.com"
                },
            "httpcodeData": 
            [
                {
                    "Time":"2020-09-01T08:00+0800",
                    "CodeType":
                    [
                        {
                            "CodeType":"2xx",
                            "PV":300,
                            "Proportion":50
                        },
                        {
                            "CodeType":"4xx",
                            "PV":300,
                            "Proportion":50
                        }
                    ]
                },
                {
                    "Time":"2020-09-01T08:05+0800",
                    "CodeType":
                    [
                        {
                            "CodeType":"2xx",
                            "PV":300,
                            "Proportion":50
                        },
                        {
                            "CodeType":"4xx",
                            "PV":300,
                            "Proportion":50
                        }
                    ]
                },
            ]
        }
    ],
    "RequestId": "7f9c419a-3f57-433b-8399-a6fcb68c8d8e"
}

On this page

Previous:GetDomainHttpCodeData

Next:GetSrcDomainHttpCodeData

Pure ModeNormal Mode

Pure Mode

Click to preview the document content in full screen

Compute

Cloud Monitor

Compliance

Networking

Security

Storage&CDN

Database

Legal

ActionTrail

Video Services

Data Analysis

Account Management