Content is empty
If you don't find the content you expect, please try another search term
Last updated:2021-07-20 11:46:11
The API request contains the specified directory /2020-06-30/statistics/GetClientRequestData, common request headers, and operation-specific request parameters. For more information, see the sample request.
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. |
Metric | No | String | The metrics to query. Valid values: flow (traffic in bytes), bandwidth (bandwidth in bit/s), request (number of requests), and qps (average number of requests per second). Separate multiple metrics with commas (,). By default, all metrics are queried. |
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 peak bandwidth 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. You can expand the data by province. |
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. You can expand the data by ISP. |
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. |
ResultType | No | String | Specifies whether to expand the statistics data and, if yes, in which dimensions. Valid values: unexpand, expand (expand in all dimensions), domain (expand by domain name), province (expand by province), isp (expand by ISP), IP (expand by IP address type), and schema (expand by protocol type). Default value: unexpand. Separate multiple dimensions with commas (,). A total of 31 combinations are supported. The containment relationships are as follows: domain name > province > ISP > IP address type > protocol type. |
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. |
Metric | String | The metrics that are 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. Multiple dimensions are separated with commas (,). |
Datas | Datas[] | The statistics data. |
RequestId | String | The ID of the request. A unique request ID is returned for each request. The request ID is required for troubleshooting. |
Parameter | Type | Description |
---|---|---|
Condition | Condition[] | The query conditions. |
Data | Data[] | The queried data. |
Parameter | Type | Description |
---|---|---|
Domains | String | The domain names, separated with commas (,). |
Areas | String | The areas, separated with commas (,). |
Provinces | String | The provinces. The value is not displayed if this condition was not specified. |
Isps | String | The ISPs. The value is not displayed if this condition was not specified. |
IpType | String | The type of the IP address. The value is not displayed if this condition was not specified. |
Schema | String | The protocol type. The value is not displayed if this condition was not specified. |
Parameter | Type | Description |
---|---|---|
Time | String | The time point. |
Bandwidth | Long | The peak bandwidth at the specified time point. The value is not displayed if this condition was not specified. |
Flow | Long | The traffic at the specified time point. The value is not displayed if this condition was not specified. |
Request | Long | The number of requests at the specified time point. The value is not displayed if this condition was not specified. |
Qps | Double | The QPS at the specified time point. The value is not displayed if this condition was not specified. |
Sample request
GET method:
GET /2020-06-30/statistics/GetClientRequestData?StartTime=2020-09-01T08%3a00%2b0800&EndTime=2020-09-01T08%3a05%2b0800&Metric=flow&Interval=5&CdnType=video&Areas=CN&Provinces=beijing&Isps=&IpType=&Schema=&ResultType=
Host: cdn.api.ksyun.com
X-Amz-Date: date
Authorization:authorization string
x-action: GetClientRequestData
x-version: 2020-06-30
POST method:
POST /2020-06-30/statistics/GetClientRequestData
Host: cdn.api.ksyun.com
X-Amz-Date: date
Authorization:authorization string
x-action: GetClientRequestData
x-version: 2020-06-30
Content-Type: application/json
{
"StartTime": "2020-09-01T08:00+0800",
"EndTime": "2020-09-01T08:05+0800",
"Metric":"flow",
"Interval":"5",
"CdnType":"video",
"Areas": "CN",
"Provinces": "beijing",
"Isps": "",
"IpType": "",
"Schema": "",
"ResultType": ""
}
Sample response
{
"StartTime": "2020-09-01T08:00+0800",
"EndTime": "2020-09-01T08:05+0800",
"Metric": "flow",
"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",
"ResultType": "unexpand",
"Datas": [
{
"Condition": {},
"Data": [
{
"Time": "2020-09-01T08:00+0800",
"Flow": 0.0
}
]
}
],
"RequestId": "7f9c419a-3f57-433b-8399-a9fcb68c8d8e"
}
Pure Mode