Querying Top 100 URLs
Function
-
This API is used to query top 100 URLs.
-
You can query data within the past 90 days.
-
The query time span cannot exceed 31 days.
-
The start time and end time must be both specified. For example, if the start time is 2021-10-24 00:00:00 and end time is 2021-10-25 00:00:00, the statistics in [2021-10-24 00:00:00, 2021-10-25 00:00:00) are queried.
-
The start time and end time must be timestamps in milliseconds. They must be 00:00:00. Otherwise, the returned data may not be the expected data.
-
Traffic metrics are measured by byte, and request metrics are measured by number of times. You can query statistics about specific domain names by specific metrics.
-
A single tenant can call this API five times per second.
Calling Method
For details, see Calling APIs.
URI
GET /v1.0/cdn/statistics/top-url
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
start_time |
Yes |
Long |
Start timestamp of the query. Only the timestamp of 00:00:00 is allowed. |
end_time |
Yes |
Long |
End timestamp of the query. Only the timestamp of 00:00:00 is allowed. |
domain_name |
Yes |
String |
Domain name list. Use commas (,) to separate multiple domain names, for example, www.test1.com,www.test2.com. all indicates that all domain names are queried. If no data is available for a domain name within the query period, no information about the domain name is returned. |
stat_type |
Yes |
String |
|
service_area |
No |
String |
Service area. Possible values: mainland_china (Chinese mainland), outside_mainland_china (outside Chinese mainland), and global (default value). |
enterprise_project_id |
No |
String |
ID of the enterprise project to which the resource belongs. This parameter is valid only when the enterprise project function is enabled. The value all indicates all projects. This parameter is mandatory when you use an IAM user to call this API. |
Request Parameters
None
Response Parameters
Status code: 200
Parameter |
Type |
Description |
---|---|---|
service_area |
String |
Service area. |
top_url_summary |
Array of TopUrlSummary objects |
Detailed data. |
Parameter |
Type |
Description |
---|---|---|
url |
String |
URL name. |
value |
Long |
Return value of a query. Traffic unit: byte. |
start_time |
Long |
Start timestamp of the query. |
end_time |
Long |
End timestamp of the query. |
stat_type |
String |
Statistics types. Possible values: flux (traffic) and req_num (total requests). |
Status code: default
Parameter |
Type |
Description |
---|---|---|
error |
ErrMsg object |
Error code and error message. |
Example Requests
-
Querying the number of access requests to top 100 URLs
GET https://cdn.myhuaweicloud.com/v1.0/cdn/statistics/top-url?&start_time=1667030400000&end_time=1667116800000&domain_name=www.test1.com&stat_type=req_num&service_area=mainland_china&enterprise_project_id=all
-
Querying the traffic details of top 100 URLs
GET https://cdn.myhuaweicloud.com/v1.0/cdn/statistics/top-url?&start_time=1667030400000&end_time=1667116800000&domain_name=www.test1.com&stat_type=flux&service_area=mainland_china&enterprise_project_id=all
Example Responses
Status code: 200
Success response
-
Querying the number of access requests to top 100 URLs
{ "top_url_summary" : [ { "url" : "www.test1.com", "value" : 888, "start_time" : 1667030400000, "end_time" : 1667116800000, "stat_type" : "req_num" }, { "url" : "www.test2.com", "value" : 666, "start_time" : 1667030400000, "end_time" : 1667116800000, "stat_type" : "req_num" } ], "service_area" : "mainland" }
-
Querying the traffic details of top 100 URLs
{ "top_url_summary" : [ { "url" : "www.test1.com", "value" : 1024, "start_time" : 1667030400000, "end_time" : 1667116800000, "stat_type" : "flux" }, { "url" : "www.test2.com", "value" : 1024, "start_time" : 1667030400000, "end_time" : 1667116800000, "stat_type" : "flux" } ], "service_area" : "mainland" }
SDK Sample Code
The SDK sample code is as follows.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 |
package com.huaweicloud.sdk.test; import com.huaweicloud.sdk.core.auth.ICredential; import com.huaweicloud.sdk.core.auth.GlobalCredentials; import com.huaweicloud.sdk.core.exception.ConnectionException; import com.huaweicloud.sdk.core.exception.RequestTimeoutException; import com.huaweicloud.sdk.core.exception.ServiceResponseException; import com.huaweicloud.sdk.cdn.v2.region.CdnRegion; import com.huaweicloud.sdk.cdn.v2.*; import com.huaweicloud.sdk.cdn.v2.model.*; public class ShowTopUrlSolution { public static void main(String[] args) { // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security. // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment String ak = System.getenv("CLOUD_SDK_AK"); String sk = System.getenv("CLOUD_SDK_SK"); ICredential auth = new GlobalCredentials() .withAk(ak) .withSk(sk); CdnClient client = CdnClient.newBuilder() .withCredential(auth) .withRegion(CdnRegion.valueOf("<YOUR REGION>")) .build(); ShowTopUrlRequest request = new ShowTopUrlRequest(); try { ShowTopUrlResponse response = client.showTopUrl(request); System.out.println(response.toString()); } catch (ConnectionException e) { e.printStackTrace(); } catch (RequestTimeoutException e) { e.printStackTrace(); } catch (ServiceResponseException e) { e.printStackTrace(); System.out.println(e.getHttpStatusCode()); System.out.println(e.getRequestId()); System.out.println(e.getErrorCode()); System.out.println(e.getErrorMsg()); } } } |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 |
# coding: utf-8 import os from huaweicloudsdkcore.auth.credentials import GlobalCredentials from huaweicloudsdkcdn.v2.region.cdn_region import CdnRegion from huaweicloudsdkcore.exceptions import exceptions from huaweicloudsdkcdn.v2 import * if __name__ == "__main__": # The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security. # In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment ak = os.environ["CLOUD_SDK_AK"] sk = os.environ["CLOUD_SDK_SK"] credentials = GlobalCredentials(ak, sk) client = CdnClient.new_builder() \ .with_credentials(credentials) \ .with_region(CdnRegion.value_of("<YOUR REGION>")) \ .build() try: request = ShowTopUrlRequest() response = client.show_top_url(request) print(response) except exceptions.ClientRequestException as e: print(e.status_code) print(e.request_id) print(e.error_code) print(e.error_msg) |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 |
package main import ( "fmt" "github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/global" cdn "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/cdn/v2" "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/cdn/v2/model" region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/cdn/v2/region" ) func main() { // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security. // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment ak := os.Getenv("CLOUD_SDK_AK") sk := os.Getenv("CLOUD_SDK_SK") auth := global.NewCredentialsBuilder(). WithAk(ak). WithSk(sk). Build() client := cdn.NewCdnClient( cdn.CdnClientBuilder(). WithRegion(region.ValueOf("<YOUR REGION>")). WithCredential(auth). Build()) request := &model.ShowTopUrlRequest{} response, err := client.ShowTopUrl(request) if err == nil { fmt.Printf("%+v\n", response) } else { fmt.Println(err) } } |
For SDK sample code of more programming languages, see the Sample Code tab in API Explorer. SDK sample code can be automatically generated.
Status Codes
Status Code |
Description |
---|---|
200 |
Success response |
default |
Abnormal response |
Error Codes
See Error Codes.
Feedback
Was this page helpful?
Provide feedbackThank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.
For any further questions, feel free to contact us through the chatbot.
Chatbot