Compute
Elastic Cloud Server
Huawei Cloud Flexus
Bare Metal Server
Auto Scaling
Image Management Service
Dedicated Host
FunctionGraph
Cloud Phone Host
Huawei Cloud EulerOS
Networking
Virtual Private Cloud
Elastic IP
Elastic Load Balance
NAT Gateway
Direct Connect
Virtual Private Network
VPC Endpoint
Cloud Connect
Enterprise Router
Enterprise Switch
Global Accelerator
Management & Governance
Cloud Eye
Identity and Access Management
Cloud Trace Service
Resource Formation Service
Tag Management Service
Log Tank Service
Config
OneAccess
Resource Access Manager
Simple Message Notification
Application Performance Management
Application Operations Management
Organizations
Optimization Advisor
IAM Identity Center
Cloud Operations Center
Resource Governance Center
Migration
Server Migration Service
Object Storage Migration Service
Cloud Data Migration
Migration Center
Cloud Ecosystem
KooGallery
Partner Center
User Support
My Account
Billing Center
Cost Center
Resource Center
Enterprise Management
Service Tickets
HUAWEI CLOUD (International) FAQs
ICP Filing
Support Plans
My Credentials
Customer Operation Capabilities
Partner Support Plans
Professional Services
Analytics
MapReduce Service
Data Lake Insight
CloudTable Service
Cloud Search Service
Data Lake Visualization
Data Ingestion Service
GaussDB(DWS)
DataArts Studio
Data Lake Factory
DataArts Lake Formation
IoT
IoT Device Access
Others
Product Pricing Details
System Permissions
Console Quick Start
Common FAQs
Instructions for Associating with a HUAWEI CLOUD Partner
Message Center
Security & Compliance
Security Technologies and Applications
Web Application Firewall
Host Security Service
Cloud Firewall
SecMaster
Anti-DDoS Service
Data Encryption Workshop
Database Security Service
Cloud Bastion Host
Data Security Center
Cloud Certificate Manager
Edge Security
Managed Threat Detection
Blockchain
Blockchain Service
Web3 Node Engine Service
Media Services
Media Processing Center
Video On Demand
Live
SparkRTC
MetaStudio
Storage
Object Storage Service
Elastic Volume Service
Cloud Backup and Recovery
Storage Disaster Recovery Service
Scalable File Service Turbo
Scalable File Service
Volume Backup Service
Cloud Server Backup Service
Data Express Service
Dedicated Distributed Storage Service
Containers
Cloud Container Engine
SoftWare Repository for Container
Application Service Mesh
Ubiquitous Cloud Native Service
Cloud Container Instance
Databases
Relational Database Service
Document Database Service
Data Admin Service
Data Replication Service
GeminiDB
GaussDB
Distributed Database Middleware
Database and Application Migration UGO
TaurusDB
Middleware
Distributed Cache Service
API Gateway
Distributed Message Service for Kafka
Distributed Message Service for RabbitMQ
Distributed Message Service for RocketMQ
Cloud Service Engine
Multi-Site High Availability Service
EventGrid
Dedicated Cloud
Dedicated Computing Cluster
Business Applications
Workspace
ROMA Connect
Message & SMS
Domain Name Service
Edge Data Center Management
Meeting
AI
Face Recognition Service
Graph Engine Service
Content Moderation
Image Recognition
Optical Character Recognition
ModelArts
ImageSearch
Conversational Bot Service
Speech Interaction Service
Huawei HiLens
Video Intelligent Analysis Service
Developer Tools
SDK Developer Guide
API Request Signing Guide
Terraform
Koo Command Line Interface
Content Delivery & Edge Computing
Content Delivery Network
Intelligent EdgeFabric
CloudPond
Intelligent EdgeCloud
Solutions
SAP Cloud
High Performance Computing
Developer Services
ServiceStage
CodeArts
CodeArts PerfTest
CodeArts Req
CodeArts Pipeline
CodeArts Build
CodeArts Deploy
CodeArts Artifact
CodeArts TestPlan
CodeArts Check
CodeArts Repo
Cloud Application Engine
MacroVerse aPaaS
KooMessage
KooPhone
KooDrive

Querying Traces (v1.0)

Updated on 2025-02-07 GMT+08:00

Function

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

URI

GET /v1.0/{project_id}/{tracker_name}/trace

Table 1 Path parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Identifies a project. For details, see section "Obtaining the Account ID and Project ID" in Cloud Trace Service API Reference.

tracker_name

Yes

String

Indicates the tracker name. Currently, only one management tracker is available for one account and the tracker name is system.

Table 2 Query parameters

Parameter

Mandatory

Type

Description

service_type

No

String

Indicates the cloud service on which the recorded operation was performed. The value must be the abbreviation of a cloud service that has been interconnected with CTS. It is a word composed of uppercase letters. For cloud services that have been interconnected with CTS, see section "Supported Services and Operations" in the Cloud Trace Service User Guide.

user

No

String

Indicates the name of a user whose traces are to be queried.

from

No

Long

Indicates the UTC millisecond timestamp of the start time of the query. The value contains 13 numbers 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.

limit

No

Integer

Indicates the number of traces to query. The default value is 10 and the maximum value is 200.

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.

resource_id

No

String

Identifies a cloud resource whose traces are to be queried.

resource_name

No

String

Indicates the name of the resource whose traces are to be queried. The value can contain uppercase letters.

resource_type

No

String

Indicates the type of the resource whose traces are to be queried.

to

No

Long

Indicates the UTC millisecond timestamp of the end time of the query. The value contains 13 numbers 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.

trace_id

No

String

Identifies a trace. If this parameter is specified, other query criteria will not take effect.

trace_name

No

String

Indicates the trace name. The value can contain uppercase letters.

trace_rating

No

String

Indicates the trace status. The value can be normal, warning, or incident.

Request Parameters

None

Response Parameters

Status code: 200

Table 3 Response body parameters

Parameter

Type

Description

traces

Array of Traces objects

Indicates the list of returned traces.

meta_data

MetaData object

Indicates the number of returned traces and the marker.

Table 4 Traces

Parameter

Type

Description

resource_id

String

Identifies a cloud resource on which the recorded operation was performed.

trace_name

String

Indicates the trace name. A trace name contains 1 to 64 characters and must start with a letter. Only letters, numbers, hyphens (-), underscores (_), and periods (.) are allowed.

trace_rating

String

Indicates the trace status. The value can be normal, warning, or incident.

Enumeration values:

  • normal

  • warning

  • incident

trace_type

String

Indicates the trace source. The value can be ApiCall, ConsoleAction, or SystemAction.

request

String

Indicates the request body of the recorded operation.

response

String

Indicates the response body of the recorded operation.

code

String

Indicates the returned HTTP status code of the recorded operation.

api_version

String

Indicates the version of the API called in the trace.

message

String

Indicates the remarks added by other cloud services to the trace.

record_time

Long

Indicates the timestamp when a trace was recorded by CTS.

trace_id

String

Identifies a trace. The value is the UUID generated by the system.

time

Long

Indicates the timestamp when a trace was generated.

user

UserInfo object

Indicates the information of the user who performed the recorded operation.

service_type

String

Indicates the cloud service on which the recorded operation was performed. The value must be the abbreviation of a cloud service that has been interconnected with CTS. It is a word composed of uppercase letters.

resource_type

String

Indicates the type of the resource on which the recorded operation was performed.

source_ip

String

Indicates the IP address of the user who performed the operation that triggered the trace.

resource_name

String

Indicates the name of the resource on which the recorded operation was performed.

request_id

String

Identifies the request of the recorded operation.

location_info

String

Indicates the information required for fault locating after a request error occurred.

endpoint

String

Indicates the endpoint in the detail page URL of the cloud resource on which the recorded operation was performed.

resource_url

String

Indicates the detail page URL (excluding the endpoint) of the cloud resource on which the recorded operation was performed.

Table 5 UserInfo

Parameter

Type

Description

id

String

Identifies an account. For details, see section "Obtaining the Account ID and Project ID" in Cloud Trace Service API Reference.

name

String

Indicates the account name.

domain

BaseUser object

Indicates the domain information of the user who performed the operation that triggered the trace.

Table 6 BaseUser

Parameter

Type

Description

id

String

Identifies an account. For details, see section "Obtaining the Account ID and Project ID" in Cloud Trace Service API Reference.

name

String

Indicates the account name.

Table 7 MetaData

Parameter

Type

Description

count

Integer

Indicates the number of returned traces.

marker

String

Identifies the last trace returned. The value of this parameter can be used as the value of next. If the value of marker is null, all traces have been returned under the specified query criteria.

Example Requests

GET https://{endpoint}/v1.0/{project_id}/{tracker_name}/trace?limit=11&to=1479095278000&from=1478490478000&trace_name=createTracker&resource_type=tracker&service_type=CTS

Example Responses

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"
  }, {
    "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"
  } ]
}

Status Codes

Status Code

Description

200

The request is successful.

400

The query parameters are abnormal.

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

The server has received the request but encountered an internal error.

503

The requested service is invalid. The client should not repeat the request without modifications.

Error Codes

See Error Codes.

We use cookies to improve our site and your experience. By continuing to browse our site you accept our cookie policy. Find out more

Feedback

Feedback

Feedback

0/500

Selected Content

Submit selected content with the feedback