Updated on 2023-08-22 GMT+08:00

Obtaining API Parameters

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.

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.