Querying Analytics Configurations
Function
This API is used to query popular content statistics and Cloud Eye reporting configurations.
Calling Method
For details, see Calling APIs.
URI
GET /v1/cdn/statistics/stats-configs
| Parameter | Mandatory | Type | Description |
|---|---|---|---|
| config_type | Yes | Integer | Definition Configuration type. Constraints N/A Range Default Value N/A |
| limit | No | Integer | Definition Number of records on each page in a pagination query. Constraints N/A Value Range 1–1000 Default Value 10 |
| offset | No | Integer | Definition Query offset. NOTE: Number of data records to skip for a query. Constraints N/A Range 0–65535 Default Value 0 |
Request Parameters
None
Response Parameters
Status code: 200
| Parameter | Type | Description |
|---|---|---|
| total | Integer | Definition Number of Analytics configurations. Range N/A |
| data | Array of StatsConfigDetails objects | Configuration details. |
| Parameter | Type | Description |
|---|---|---|
| config_type | Integer | Definition Configuration type. Range |
| resource_type | String | Definition Resource type. Range |
| resource_name | String | Definition Resource name. NOTE: Account or domain name Range Separate domain names with commas (,). |
| config_info | ConfigInfo object | Configuration information. |
| Parameter | Type | Description |
|---|---|---|
| url | TopUrl object | top_url configuration. |
| ua | TopUa object | top_ua configuration. |
| Parameter | Type | Description |
|---|---|---|
| enable | Boolean | Definition Configuration status. Range |
| limit | Integer | Definition Number of top entries for the specified metric to report in the popular content statistics. NOTE: For example, top_url 100 or top_url 1000. Range 0-2000 |
| sort_by_code | Boolean | Definition Whether popular content statistics metrics can be reported broken down by status code. Range |
Status code: default
| Parameter | Type | Description |
|---|---|---|
| error | ErrMsg object | Error code and error message. |
Example Requests
Querying Analytics configurations
GET https://cdn.myhuaweicloud.com/v1/cdn/statistics/stats-configs?config_type=0
Example Responses
Status code: 200
Success response.
{
"total" : 1,
"data" : [ {
"config_type" : 0,
"resource_type" : "domain",
"resource_name" : "all",
"config_info" : {
"url" : {
"enable" : true,
"limit" : 1000,
"sort_by_code" : true
},
"ua" : {
"enable" : true
}
}
} ]
} 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 ShowStatsConfigsSolution { 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(); ShowStatsConfigsRequest request = new ShowStatsConfigsRequest(); try { ShowStatsConfigsResponse response = client.showStatsConfigs(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 = ShowStatsConfigsRequest() response = client.show_stats_configs(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 36 37 38 39 40 41 42 43 44 45 46 47 | 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, err := global.NewCredentialsBuilder(). WithAk(ak). WithSk(sk). SafeBuild() if err != nil { fmt.Println(err) return } hcClient, err := cdn.CdnClientBuilder(). WithRegion(region.ValueOf("<YOUR REGION>")). WithCredential(auth). SafeBuild() if err != nil { fmt.Println(err) return } client := cdn.NewCdnClient(hcClient) request := &model.ShowStatsConfigsRequest{} response, err := client.ShowStatsConfigs(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 | Error response. |
Error Codes
See Error Codes.
What is your overall rating for this page?
Thank 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