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
On this page

Show all

Obtaining API Parameters

Updated on 2025-02-13 GMT+08:00
Table 1 API parameters

Location

Parameter

Mandatory

Type

Description

Querying the Master Address

region_name

Yes

String

Region name, which can be obtained from the region field in Table 3.

Saving a Monitoring Item

monitor_item_id

Yes

Long

Monitoring item ID, which can be obtained from the monitor_item_id field in Table 5.

Obtaining an Application Tree

region_id

No

String

Region ID, which can be obtained from the region field in Table 3.

Obtaining an Application Tree

business_id

Yes

Long

Application ID, which can be obtained from the id field in Table 3.

Obtaining an Application Tree

env_tag_id

No

Long

Environment tag ID, which can be obtained from the id field in Table 4.

Querying Environment Tags

business_id

Yes

Long

Application ID, which can be obtained from the id field in Table 3.

Obtaining the Component List

business_id

Yes

Long

Application ID, which can be obtained from the id field in Table 3.

Obtaining the Environment List of a Component

app_id

Yes

Long

Component ID, which can be obtained from the id field in Table 4.

Querying the Details About an Application

business_id

Yes

Long

Application ID, which can be obtained from the id field in Table 3.

Querying the Details About a Sub-application

sub_business_id

Yes

Long

Sub-application ID, which can be obtained from the real_id of the node whose type is SUB_BUSINESS in Table 5.

Querying Monitoring Item Configurations

env_id

Yes

Long

Environment ID, which can be obtained from real_id of the node whose type is ENVIRONMENT in Table 5.

Querying Monitoring Item Configurations

collector_id

Yes

Long

Collector ID, which can be obtained from the collector_id field in Table 5.

Querying the Trace Topology

trace_id

Yes

String

Trace ID, which can be obtained from the trace_id field in Table 5.

Querying Event Details

trace_id

Yes

String

Trace ID, which can be obtained from the trace_id field in Table 4.

Querying Event Details

span_id

Yes

String

Span ID, which can be obtained from the span_id field in Table 4.

Querying Event Details

event_id

Yes

String

Event ID, which can be obtained from the event_id field in Table 4.

Querying Event Details

env_id

Yes

Long

Environment ID, which can be obtained from the env_id field in Table 4.

Querying Span Data

env_id

No

Long

Environment ID, which can be obtained from the id field in Table 4.

Querying Span Data

instance_id

No

Long

Instance ID, which can be obtained from the instance_id field in Table 4.

Querying Span Data

app_id

No

Long

Component ID, which can be obtained from the id field in Table 4.

Querying Span Data

biz_id

Yes

Long

Application ID, which can be obtained from the id field in Table 3.

Obtaining All Data of a Trace

trace_id

Yes

String

Trace ID, which can be obtained from the trace_id field in Table 5.

Obtaining the Trend Graph

view_config

Yes

TrendView object

View configuration information, which can be obtained from the ViewBase object in Table 5.

Obtaining the Trend Graph

instance_id

No

Long

Instance ID, which can be obtained from the instance_id field in Table 4. If this parameter is left blank, the aggregated data of all instances will be obtained.

Obtaining the Trend Graph

monitor_item_id

Yes

Long

Monitoring item ID, which can be obtained from the monitor_item_id field in Table 5.

Obtaining the Trend Graph

env_id

Yes

Long

Environment ID, which can be obtained from real_id of the node whose type is ENVIRONMENT in Table 5.

Obtaining Summary Table Data

view_config

Yes

SumTableView object

View configuration information, which can be obtained from the ViewBase object in Table 5.

Obtaining Summary Table Data

instance_id

No

Long

Instance ID, which can be obtained from the instance_id field in Table 4. If this parameter is left blank, the aggregated data of all instances will be obtained.

Obtaining Summary Table Data

monitor_item_id

Yes

Long

Monitoring item ID, which can be obtained from the monitor_item_id field in Table 5.

Obtaining Summary Table Data

env_id

Yes

Long

Environment ID, which can be obtained from real_id of the node whose type is ENVIRONMENT in Table 5.

Obtaining the Raw Data Table

view_config

Yes

RawTableView object

Raw data table view, which can be obtained from the ViewBase object in Table 5.

Obtaining the Raw Data Table

instance_id

Yes

Long

Instance ID, which can be obtained from the instance_id field in Table 4. If this parameter is left blank, the aggregated data of all instances will be obtained.

Obtaining the Raw Data Table

monitor_item_id

Yes

Long

Monitoring item ID, which can be obtained from the monitor_item_id field in Table 5.

Obtaining the Raw Data Table

env_id

Yes

Long

Environment ID, which can be obtained from real_id of the node whose type is ENVIRONMENT in Table 5.

Obtaining the Instance Information

env_id

Yes

Long

Environment ID, which can be obtained from real_id of the node whose type is ENVIRONMENT in Table 5.

Obtaining the Monitoring Item Information

env_id

Yes

Long

Environment ID, which can be obtained from real_id of the node whose type is ENVIRONMENT in Table 5.

Querying the Alarm List

region

No

String

Region name, which can be obtained from the region field in Table 3.

Querying the Alarm List

business_id

Yes

Long

Application ID, which can be obtained from the id field in Table 3.

Querying the Alarm List

monitor_item_id

No

Long

Monitoring item ID, which can be obtained from the monitor_item_id field in Table 5.

Querying the Alarm List

collector_id

No

Integer

Collector ID, which can be obtained from the collector_id field in Table 5.

Querying the Alarm Message List

alarm_data_id

Yes

Integer

Alarm/event ID, which can be obtained from the id field in Table 4.

Querying the Alarm Message List

region

Yes

String

Region name, which can be obtained from the region field in Table 3.

Querying the Global Topology of an Application

target_business_id

Yes

Long

Target application ID, which can be obtained from the id field in Table 3.

Querying the Global Topology of an Application

env_tag_list

No

Array of integers

Environment tag list, which can be empty or obtained from the id field in Table 4.

Querying the Topology of a Component Environment

target_env_id

Yes

Long

Environment ID, which can be obtained from real_id of the node whose type is ENVIRONMENT in Table 5.

Querying the URL Tracing Configuration List

business_id

Yes

Long

Application ID, which can be obtained from the id field in Table 3.

Querying the URL Tracing Configuration List

env_id

No

Long

Environment ID, which can be obtained from the id field in Table 4.

Querying a Region's Environments on Which URLs Are Added for Tracing

business_id

Yes

Long

Application ID, which can be obtained from the id field in Table 3.

Querying a Region's Environments on Which URLs Are Added for Tracing

region

Yes

String

Region name, which can be obtained from the region field in Table 3.

Querying the URL Tracing View List

business_id

Yes

Long

Application ID, which can be obtained from the id field in Table 3.

Querying the URL Tracing View List

region

Yes

String

Region name, which can be obtained from the region field in Table 3.

Querying the URL Tracing View List

env_id

No

Long

Environment ID, which can be obtained from the env_id field in Table 4.

Querying the Details About a URL Tracing View

tx_name

Yes

String

Transaction name, which is obtained from the tx_name field in Table 4.

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