Querying a Trace List_Cloud Trace Service

Function

This API is used to query records of operations on resources in the last seven days.

API Calling

For details, see Calling APIs.

URI

GET /v3/{project_id}/traces

**Table 1** Path parameter
Parameter	Mandatory	Type	Description
project_id	Yes	String	Project ID. For details, see Obtaining an Account ID and Project ID.

**Table 2** Query parameters
Parameter	Mandatory	Type	Description
trace_type	Yes	String	Trace type. The value can be system (management trace) or data (data trace) The default value is system. Values: system data
from	No	Long	UTC millisecond timestamp of the query start time. The value contains 13 digits and the default value is the timestamp of the last hour. Traces generated after the specified timestamp will be queried. The parameters from and to should be used together.
next	No	String	This parameter is used to query traces generated earlier than its specified value. The value can be that of marker in the response. next can be used with from and to. Traces generated in the overlap of the two time ranges specified respectively by next and by from and to will be returned.
to	No	Long	UTC millisecond timestamp of the query end time. The value contains 13 digits and the default value is the timestamp of the current time. Traces generated before the specified timestamp will be queried. The parameters to and from should be used together.
tracker_name	No	String	When trace_type is set to system, the default value system is used. When trace_type is set to data, set this parameter to the name of a data tracker to query the traces recorded by this tracker.
service_type	No	String	Type of a cloud service whose traces are to be queried. The value must be the acronym of a cloud service that has been connected with CTS. It is a word composed of uppercase letters. This parameter is valid only when trace_type is set to system. For cloud services that can be connected with CTS, see section "Supported Services and Operations" in Cloud Trace Service User Guide.
user	No	String	Name of the user whose traces are to be queried This parameter is valid only when trace_type is set to system.
resource_name	No	String	Name of a resource whose traces are to be queried. This parameter is valid only when trace_type is set to system. The value can contain uppercase letters.
resource_type	No	String	Type of a resource whose traces are to be queried. This parameter is valid only when trace_type is set to system.
resource_id	No	String	ID of a cloud resource whose traces are to be queried. This parameter is valid only when trace_type is set to system.
limit	No	Integer	Number of traces to query. The default value is 10 and the maximum value is 200.
trace_id	No	String	Trace ID. If this parameter is specified, other query criteria will not take effect. This parameter is valid only when trace_type is set to system.
trace_name	No	String	Trace name. This parameter is valid only when trace_type is set to system. The value can contain uppercase letters.
trace_rating	No	String	Trace status. The value can be normal, warning, or incident. This parameter is valid only when trace_type is set to system. Values: normal warning incident
access_key_id	No	String	ID of the access key used to query traces. It contains temporary access credentials and permanent access keys.
enterprise_project_id	No	String	ID of an enterprise project whose traces are to be queried.

Request Parameters

None

Response Parameters

Status code: 200

**Table 3** Response body parameters
Parameter	Type	Description
traces	Array of Traces objects	List of returned traces.
meta_data	MetaData object	Number of returned traces and the marker.

**Table 4** Traces
Parameter	Type	Description
resource_id	String	ID of a cloud resource on which the recorded operation was performed.
trace_name	String	Trace name. The value can contain 1 to 64 characters, including letters, digits, hyphens (-), underscores (_), and periods (.). It must start with a letter.
trace_rating	String	Trace status. The value can be normal, warning, or incident. Values: normal warning incident
trace_type	String	Trace source. For management traces, the value can be ApiCall, ConsoleAction, or SystemAction. For data traces, the value can be ObsSDK or ObsAPI.
request	String	Request of an operation on resources.
response	String	Response to a user request, that is, the returned information for an operation on resources.
code	String	HTTP status code returned by the associated API.
api_version	String	Version of the API called in a trace.
message	String	Remarks added by other cloud services to a trace.
record_time	Long	Timestamp when a trace was recorded by CTS.
trace_id	String	Trace ID. The value is the UUID generated by the system.
time	Long	Timestamp when a trace was generated.
user	UserInfo object	Information of the user who performed the operation that triggered the trace.
service_type	String	Type of a cloud service whose traces are to be queried. The value must be the acronym of a cloud service that has been connected with CTS. It is a word composed of uppercase letters.
resource_type	String	Type of the resource on which the operation was performed.
source_ip	String	IP address of the tenant who performed the operation that triggered the trace.
resource_name	String	Name of a resource on which the recorded operation was performed.
request_id	String	Request ID.
location_info	String	Additional information required for fault locating after a request error.
endpoint	String	Endpoint in the details page URL of the cloud resource on which the recorded operation was performed.
resource_url	String	Details page URL (excluding the endpoint) of the cloud resource on which the recorded operation was performed.
enterprise_project_id	String	ID of the enterprise project to which the resource belongs.
resource_account_id	String	ID of the account to which the resource belongs. This parameter has a value only when resources are operated across tenants.
read_only	boolean	Whether a user request is read-only.
operation_id	String	Operation ID of the trace.

**Table 5** UserInfo
Parameter	Type	Description
id	String	User ID. For details, see section "Obtaining an Account ID and Project ID" in Cloud Trace Service API Reference.
name	String	Username.
user_name	String	Username.
domain	BaseUser object	Domain information of the user who performed the operation generating the trace.
account_id	String	Account ID. For details, see section "Obtaining an Account ID and Project ID" in Cloud Trace Service API Reference.
access_key_id	String	Access key ID.
principal_urn	String	URN of the operator. For an IAM user, the format is iam::<account-id>:user:<user-name>. For an IAM delegated account, the format is sts::sts::<account-id>:assumed-agency:<agency-name>/<agency-session-name>. For an IAM federated identity, the format is sts::<account-id>:external-user:<idp_id>/<user-session-name>.
principal_id	String	ID of the operator. For an IAM user, the format is <user-id>. For an IAM delegated account, the format is <agency-id>:<agency-session-name>. For an IAM federated identity, the format is <idp_id>:<user-session-name>.
principal_is_root_user	String	Whether the operator is a root user. If the value is true, the operator is a root user. If the value is false, the operator is an IAM delegated account, federated identity, or non-root user. Values: true false
type	String	Operator identity type.
invoked_by	Array of strings	Name of the service that sends the request. For operations on the console, the value is ["service.console"].
session_context	SessionContext object	Temporary security credential attribute.

**Table 6** BaseUser
Parameter	Type	Description
id	String	Account ID. For details, see section "Obtaining an Account ID and Project ID" in Cloud Trace Service API Reference.
name	String	Account name.

**Table 7** SessionContext
Parameter	Type	Description
attributes	Attributes object	Temporary security credential attribute.

**Table 8** Attributes
Parameter	Type	Description
created_at	String	Timestamp when a temporary security credential was issued. The value is a 13-digit UTC time in milliseconds.
mfa_authenticated	String	Whether MFA identity authentication has been passed.

**Table 9** MetaData
Parameter	Type	Description
count	Integer	Number of returned traces.
marker	String	ID of the last trace in the returned trace list. The value of this parameter can be used as the next value. If the value of marker is null, all traces have been returned.

Status code: 400

**Table 10** Response body parameters
Parameter	Type	Description
error_code	String	Error code. Format: CTS.XXX.
error_msg	String	Error message.

Status code: 401

**Table 11** Response body parameters
Parameter	Type	Description
error_code	String	Error code. Format: CTS.XXX.
error_msg	String	Error message.

Status code: 403

**Table 12** Response body parameters
Parameter	Type	Description
error_code	String	Error code. Format: CTS.XXX.
error_msg	String	Error message.

Status code: 404

**Table 13** Response body parameters
Parameter	Type	Description
error_code	String	Error code. Format: CTS.XXX.
error_msg	String	Error message.

Status code: 500

**Table 14** Response body parameters
Parameter	Type	Description
error_code	String	Error code. Format: CTS.XXX.
error_msg	String	Error message.

Status code: 503

**Table 15** Response body parameters
Parameter	Type	Description
error_code	String	Error code. Format: CTS.XXX.
error_msg	String	Error message.

Example Request

Querying management traces

GET https://{endpoint}/v3/{project_id}/traces?limit=11&to=1479095278000&from=1478490478000&trace_name=createTracker&resource_type=tracker&service_type=CTS&trace_type=system

Querying data traces

GET https://{endpoint}/v3/{project_id}/traces?limit=11&to=1479095278000&from=1478490478000&trace_type=data

Example Response

Status code: 200

The request is successful.

{
  "meta_data" : {
    "count" : 2,
    "marker" : "e001ccb8-bc09-11e6-b2cc-2640a43cc6e8"
  },
  "traces" : [ {
    "time" : 1472148708232,
    "user" : {
      "name" : "xxx",
      "domain" : {
        "name" : "xxx",
        "id" : "ded649d814464428ba89d04d7955c93e"
      }
    },
    "response" : {
      "code" : "VPC.0514",
      "message" : "Update port fail."
    },
    "code" : 200,
    "service_type" : "VPC",
    "resource_type" : "eip",
    "resource_name" : "192.144.163.1",
    "resource_id" : "d502809d-0d1d-41ce-9690-784282142ccc",
    "trace_name" : "deleteEip",
    "trace_rating" : "warning",
    "trace_type" : "ConsoleAction",
    "api_version" : "2.0",
    "record_time" : 1481066128032,
    "trace_id" : "e001ccb9-bc09-11e6-b00b-4b2a61338db6",
    "read_only": false,
    "operation_id": "ListSubscriptions"
  }, {
    "time" : 1472148708232,
    "user" : {
      "name" : "xxx",
      "domain" : {
        "name" : "xxx",
        "id" : "ded649d814464428ba89d04d7955c93e"
      }
    },
    "response" : {
      "code" : "VPC.0514",
      "message" : "Update port fail."
    },
    "code" : 200,
    "service_type" : "VPC",
    "resource_type" : "eip",
    "resource_name" : "192.144.163.1",
    "resource_id" : "d502809d-0d1d-41ce-9690-784282142ccc",
    "trace_name" : "deleteEip",
    "trace_rating" : "warning",
    "trace_type" : "ConsoleAction",
    "api_version" : "2.0",
    "record_time" : 1481066128032,
    "trace_id" : "e001ccb8-bc09-11e6-b2cc-2640a43cc6e8",
    "read_only": false,
    "operation_id": "ListSubscriptions"
  } ]
}

Example SDK Code

The example SDK code is as follows.

Java

    
     
       
       
         package com.huaweicloud.sdk.test;

import com.huaweicloud.sdk.core.auth.ICredential;
import com.huaweicloud.sdk.core.auth.BasicCredentials;
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.cts.v3.region.CtsRegion;
import com.huaweicloud.sdk.cts.v3.*;
import com.huaweicloud.sdk.cts.v3.model.*;


public class ListTracesSolution {

    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 BasicCredentials()
                .withAk(ak)
                .withSk(sk);

        CtsClient client = CtsClient.newBuilder()
                .withCredential(auth)
                .withRegion(CtsRegion.valueOf("<YOUR REGION>"))
                .build();
        ListTracesRequest request = new ListTracesRequest();
        request.withTraceType(ListTracesRequest.TraceTypeEnum.fromValue("<trace_type>"));
        request.withLimit(<limit>);
        request.withFrom(<from>L);
        request.withNext("<next>");
        request.withTo(<to>L);
        request.withTrackerName("<tracker_name>");
        request.withServiceType("<service_type>");
        request.withUser("<user>");
        request.withResourceId("<resource_id>");
        request.withResourceName("<resource_name>");
        request.withResourceType("<resource_type>");
        request.withTraceId("<trace_id>");
        request.withTraceName("<trace_name>");
        request.withTraceRating(ListTracesRequest.TraceRatingEnum.fromValue("<trace_rating>"));
        request.withAccessKeyId("<access_key_id>");
        request.withEnterpriseProjectId("<enterprise_project_id>");
        try {
            ListTracesResponse response = client.listTraces(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());
        }
    }
}

        

      

    
   

Python

    
     
       
       
         # coding: utf-8

import os
from huaweicloudsdkcore.auth.credentials import BasicCredentials
from huaweicloudsdkcts.v3.region.cts_region import CtsRegion
from huaweicloudsdkcore.exceptions import exceptions
from huaweicloudsdkcts.v3 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 = BasicCredentials(ak, sk)

    client = CtsClient.new_builder() \
        .with_credentials(credentials) \
        .with_region(CtsRegion.value_of("<YOUR REGION>")) \
        .build()

    try:
        request = ListTracesRequest()
        request.trace_type = "<trace_type>"
        request.limit = <limit>
        request._from = <from>
        request.next = "<next>"
        request.to = <to>
        request.tracker_name = "<tracker_name>"
        request.service_type = "<service_type>"
        request.user = "<user>"
        request.resource_id = "<resource_id>"
        request.resource_name = "<resource_name>"
        request.resource_type = "<resource_type>"
        request.trace_id = "<trace_id>"
        request.trace_name = "<trace_name>"
        request.trace_rating = "<trace_rating>"
        request.access_key_id = "<access_key_id>"
        request.enterprise_project_id = "<enterprise_project_id>"
        response = client.list_traces(request)
        print(response)
    except exceptions.ClientRequestException as e:
        print(e.status_code)
        print(e.request_id)
        print(e.error_code)
        print(e.error_msg)

        

      

    
   

Go

    
     
       
       
         package main

import (
	"fmt"
	"github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/basic"
    cts "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/cts/v3"
	"github.com/huaweicloud/huaweicloud-sdk-go-v3/services/cts/v3/model"
    region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/cts/v3/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 := basic.NewCredentialsBuilder().
        WithAk(ak).
        WithSk(sk).
        Build()

    client := cts.NewCtsClient(
        cts.CtsClientBuilder().
            WithRegion(region.ValueOf("<YOUR REGION>")).
            WithCredential(auth).
            Build())

    request := &model.ListTracesRequest{}
	request.TraceType = model.GetListTracesRequestTraceTypeEnum().<TRACE_TYPE>
	limitRequest:= int32(<limit>)
	request.Limit = &limitRequest
	fromRequest:= int64(<from>)
	request.From = &fromRequest
	nextRequest:= "<next>"
	request.Next = &nextRequest
	toRequest:= int64(<to>)
	request.To = &toRequest
	trackerNameRequest:= "<tracker_name>"
	request.TrackerName = &trackerNameRequest
	serviceTypeRequest:= "<service_type>"
	request.ServiceType = &serviceTypeRequest
	userRequest:= "<user>"
	request.User = &userRequest
	resourceIdRequest:= "<resource_id>"
	request.ResourceId = &resourceIdRequest
	resourceNameRequest:= "<resource_name>"
	request.ResourceName = &resourceNameRequest
	resourceTypeRequest:= "<resource_type>"
	request.ResourceType = &resourceTypeRequest
	traceIdRequest:= "<trace_id>"
	request.TraceId = &traceIdRequest
	traceNameRequest:= "<trace_name>"
	request.TraceName = &traceNameRequest
	traceRatingRequest:= model.GetListTracesRequestTraceRatingEnum().<TRACE_RATING>
	request.TraceRating = &traceRatingRequest
	accessKeyIdRequest:= "<access_key_id>"
	request.AccessKeyId = &accessKeyIdRequest
	enterpriseProjectIdRequest:= "<enterprise_project_id>"
	request.EnterpriseProjectId = &enterpriseProjectIdRequest
	response, err := client.ListTraces(request)
	if err == nil {
        fmt.Printf("%+v\n", response)
    } else {
        fmt.Println(err)
    }
}

        

      

    
   

More

For SDK sample code in other programming languages, see the Sample Code tab in the API Explorer.

Status Codes

Status Codes	Description
200	The request is successful.
400	The request is not completed due to abnormal query parameters.
401	The request is rejected due to authentication failure.
403	The server understood the request but refused to authorize it.
404	The requested trace does not exist.
500	Failed to complete the request because of an internal service error.
503	The requested service is invalid. The client should not repeat the request without modifications.

Error Code

For details, see Error Codes.

Querying a Trace List