nav-img
Advanced

Querying the URL Tracing Configuration List

Function

This API is used to query the URL tracing configuration list.

URI

POST /v1/apm2/openapi/transaction/transaction-config-search

Request Parameters

Table 1 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

User token obtained from IAM.

x-business-id

Yes

Long

Application ID.

Table 2 Request body parameters

Parameter

Mandatory

Type

Description

business_id

Yes

Long

Application ID.

env_id

No

Long

Environment ID.

page_no

Yes

Integer

Page number.

page_size

Yes

Integer

Number of records on each page.

Response Parameters

Status code: 200

Table 3 Response body parameters

Parameter

Type

Description

transaction_config_item_list

Array of TransactionConfigItem objects

URL tracing configuration list.

total_page

Integer

Total number of pages.

total_count

Integer

Total number of configurations.

Table 4 TransactionConfigItem

Parameter

Type

Description

id

Long

Configuration ID.

business_id

Long

Application ID.

env_id

Long

Environment ID.

method

String

Request method.

env_name

String

Environment name.

region

String

Region name.

type

String

Type.

app_name

String

Application name.

url

String

URL.

Example Requests

Query the URL tracing configuration list of application 6.

/v1/apm2/openapi/transaction/transaction-config-search
{
"business_id" : 6,
"page_no" : 1,
"page_size" : 10
}

Example Responses

Status code: 200

OK: The request is successful.

{
"total_page" : 2,
"total_count" : 11,
"transaction_config_item_list" : [ {
"id" : 36,
"business_id" : 6,
"env_id" : 52,
"method" : "GET",
"env_name" : "",
"region" : "",
"type" : "Url",
"app_name" : "lubanops-web",
"url" : "/apm2/web/cmdb/business/v1/get-business-detail/{business_id}"
} ]
}

Status Codes

Status Code

Description

200

OK: The request is successful.

400

Bad Request: Semantic or parameter error.

401

Unauthorized: No permissions.

403

Forbidden: Access forbidden.

404

Not Found: The requested resource is not found.

Error Codes