Updated on 2024-07-05 GMT+08:00

Querying Logs

Function

This API is used to query the link of downloading logs. Logs generated within 30 days can be queried.

Calling Method

For details, see Calling APIs.

URI

GET /v1.0/cdn/logs

Table 1 Query Parameters

Parameter

Mandatory

Type

Description

domain_name

Yes

String

Domain name to be queried, for example, www.test1.com.

start_time

No

Long

Query start time. The value is a timestamp in milliseconds at the top of an hour. If this parameter is left empty, 00:00 of the current day is used by default.

end_time

No

Long

Query end time (excluding the end time point). The value is a timestamp in milliseconds at the top of an hour. The maximum time span between the start time and end time is 30 days. If this parameter is left empty, the start time plus one day is used by default.

page_size

No

Integer

Maximum number of records on a page. The value ranges from 1 to 10,000. The default value is 10.

page_number

No

Integer

Number of the page to be queried. The value ranges from 1 to 65,535. The default value is 1.

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.

Obtain the enterprise project ID by calling the ListEnterpriseProject API of Enterprise Project Management Service (EPS).

Request Parameters

Table 2 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

User token.

It can be obtained by calling the IAM API used to obtain a user token. The value of X-Subject-Token in the response header is the user token.

Response Parameters

Status code: 200

Table 3 Response body parameters

Parameter

Type

Description

total

Integer

Total number of records.

logs

Array of LogObject objects

Log list.

Table 4 LogObject

Parameter

Type

Description

domain_name

String

Domain name.

start_time

Long

Query start time. The value is the number of milliseconds since the UNIX epoch (Jan 1, 1970).

end_time

Long

Query end time. The value is the number of milliseconds since the UNIX epoch (Jan 1, 1970).

name

String

Log file name.

size

Long

File size, in bytes.

link

String

Download link.

Example Requests

GET https://cdn.myhuaweicloud.com/v1.0/cdn/logs?start_time=1502380500000&end_time=1502384100000&domain_name=www.example.com&page_size=10&page_number=1&enterprise_project_id=0

Example Responses

Status code: 200

OK

{
  "logs" : [ {
    "domain_name" : "www.example.com",
    "start_time" : 1498838400000,
    "end_time" : 1502380500000,
    "name" : "www.xxxx.com-2017080315",
    "link" : "www.xxxx.web",
    "size" : 4096
  } ],
  "total" : 1
}

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
46
47
48
49
50
51
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 ShowLogsSolution {

    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();
        ShowLogsRequest request = new ShowLogsRequest();
        request.withDomainName("<domain_name>");
        request.withStartTime(<start_time>L);
        request.withEndTime(<end_time>L);
        request.withPageSize(<page_size>);
        request.withPageNumber(<page_number>);
        request.withEnterpriseProjectId("<enterprise_project_id>");
        try {
            ShowLogsResponse response = client.showLogs(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
31
32
33
34
35
36
# 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 = ShowLogsRequest()
        request.domain_name = "<domain_name>"
        request.start_time = <start_time>
        request.end_time = <end_time>
        request.page_size = <page_size>
        request.page_number = <page_number>
        request.enterprise_project_id = "<enterprise_project_id>"
        response = client.show_logs(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
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.ShowLogsRequest{}
	request.DomainName = "<domain_name>"
	startTimeRequest:= int64(<start_time>)
	request.StartTime = &startTimeRequest
	endTimeRequest:= int64(<end_time>)
	request.EndTime = &endTimeRequest
	pageSizeRequest:= int32(<page_size>)
	request.PageSize = &pageSizeRequest
	pageNumberRequest:= int32(<page_number>)
	request.PageNumber = &pageNumberRequest
	enterpriseProjectIdRequest:= "<enterprise_project_id>"
	request.EnterpriseProjectId = &enterpriseProjectIdRequest
	response, err := client.ShowLogs(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

OK

Error Codes

See Error Codes.