Querying the URL Tracing View List

Function

This API is used to query the list of URL tracing views.

URI

POST /v1/apm2/openapi/transaction/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.
region	Yes	String	Region name.
start_time	Yes	String	Start timestamp in milliseconds, for example, 1715916233000.
end_time	Yes	String	End timestamp in milliseconds, for example, 1715916233000.
env_id	No	Long	Environment ID.
request_id	No	String	Request ID. Leave this parameter empty for the first query. For pagination query, set this parameter to the value of result_id returned in last API calling.
page_no	Yes	Integer	Page number.
page_size	No	Integer	Number of records on each page.

Response Parameters

Status code: 200

**Table 3** Response body parameters
Parameter	Type	Description
tx_item_list	Array of TxItemVo objects	URL tracing view list.
latest_time	Long	Timestamp of the last response.
total_count	Integer	Total number of records.
result_id	String	Request ID.

**Table 4** TxItemVo
Parameter	Type	Description
app_name	String	Component name.
env_name	String	Environment name.
tx_display_name	String	Display name of a transaction. It is in the format of "URL : request mode".
business_id	Long	Application ID.
env_id	Long	Environment ID.
app_id	Long	Component ID.
tx_name	String	Transaction name, which must be unique under an application. Set tx_name to the value of this parameter when you call the API for querying the details about a URL tracing view.
invoke_count	Integer	Number of calls.
total_time	Integer	Total call duration of this API, in milliseconds.
error_count	Integer	Number of errors.

Example Requests

Query the URL tracing view list of application 6 in region

/v1/apm2/openapi/transaction/search

{
  "region" : "",
  "business_id" : 6,
  "start_time" : 1667454320000,
  "end_time" : 1667455520000,
  "page_no" : 1,
  "page_size" : 10,
  "request_id" : ""
}

Example Responses

Status code: 200

OK: The request is successful.

{
  "latest_time" : 1667455260000,
  "tx_item_list" : [ {
    "business_id" : 6,
    "env_id" : 295,
    "app_id" : 175,
    "tx_name" : "3",
    "invoke_count" : 369,
    "total_time" : 19025,
    "error_count" : 0,
    "env_name" : "",
    "app_name" : "lubanops-api",
    "tx_display_name" : "/apm2/api/view/trace/v1/span-search : POST"
  } ],
  "total_count" : 1,
  "result_id" : "7776f9f2-0294-4305-a291-fc359802bf19"
}

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.