Querying the Details About a URL Tracing View

Function

This API is used to query the details about a URL tracing view.

URI

POST /v1/apm2/openapi/transaction/detail

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
tx_name	Yes	String	Transaction name.
start_time	Yes	String	Start timestamp, in milliseconds.End timestamp, in milliseconds.
end_time	Yes	String	Start timestamp, in milliseconds.End timestamp, in milliseconds.

Response Parameters

Status code: 200

**Table 3** Response body parameters
Parameter	Type	Description
tx_node_list	Array of TxNode objects	List of component nodes.
tx_line_list	Array of TxLine objects	List of lines that indicate invocations between components.

**Table 4** TxNode
Parameter	Type	Description
tx_node_id	String	Node ID.
tx_node_name	String	Node name.
tx_node_type	String	Node type, such as user, HttpClient (network node), env (environment), or Mysql (database node).

**Table 5** TxLine
Parameter	Type	Description
tx_from_node	String	Start node.
tx_to_node	String	End node.
invoke_count	Long	Number of calls.
rt	Double	Inter-component call duration, in milliseconds.
error_count	Long	Number of errors.
type	String	Target node type, such as user, HttpClient (network node), env (environment), or Mysql (database node).
direction	String	Invocation direction.

Example Requests

Query the details about the URL tracing view of transaction 3, with the start timestamp set to 1667456607000 and end timestamp set to 1667457807000.

/v1/apm2/openapi/transaction/detail

{
  "start_time" : 1667456607000,
  "end_time" : 1667457807000,
  "tx_name" : "3"
}

Example Responses

Status code: 200

OK: The request is successful.

{
  "tx_node_list" : [ {
    "tx_node_id" : "48",
    "tx_node_name" : "apm-api:",
    "tx_node_type" : "env",
    "tx_env_id" : 48
  }, {
    "tx_node_id" : "*.*.*.*:3306:apm2_cmdb",
    "tx_node_name" : "*.*.*.*:3306:apm2_cmdb",
    "tx_node_type" : "Mysql",
    "tx_env_id" : null
  }, {
    "tx_node_id" : "user",
    "tx_node_name" : "user",
    "tx_node_type" : "user",
    "tx_env_id" : null
  }, {
    "tx_node_id" : "295",
    "tx_node_name" : "lubanops-api:",
    "tx_node_type" : "env",
    "tx_env_id" : 295
  }, {
    "tx_node_id" : "*.*.*.*:3306:apm2_region",
    "tx_node_name" : "*.*.*.*:3306:apm2_region",
    "tx_node_type" : "Mysql",
    "tx_env_id" : null
  }, {
    "tx_node_id" : "54",
    "tx_node_name" : "apm-front:",
    "tx_node_type" : "env",
    "tx_env_id" : 54
  }, {
    "tx_node_id" : "Elasticsearch:*.*.*.*:9200,*.*.*.*:9200,*.*.*.*:9200",
    "tx_node_name" : "Elasticsearch:*.*.*.*:9200,*.*.*.*:9200,*.*.*.*:9200",
    "tx_node_type" : "EsRestClient",
    "tx_env_id" : null
  } ],
  "tx_line_list" : [ {
    "tx_from_node" : "54",
    "tx_to_node" : "48",
    "invoke_count" : 364,
    "rt" : 28.065934065934066,
    "error_count" : 0,
    "type" : "HttpClient",
    "direction" : "out"
  }, {
    "tx_from_node" : "48",
    "tx_to_node" : "Elasticsearch:*.*.*.*:9200,*.*.*.*:9200,*.*.*.*:9200",
    "invoke_count" : 359,
    "rt" : 18.08635097493036,
    "error_count" : 0,
    "type" : "EsRestClient",
    "direction" : "out"
  }, {
    "tx_from_node" : "295",
    "tx_to_node" : "54",
    "invoke_count" : 365,
    "rt" : 49.87123287671233,
    "error_count" : 0,
    "type" : "HttpClient",
    "direction" : "out"
  }, {
    "tx_from_node" : "54",
    "tx_to_node" : "*.*.*.*:3306:apm2_region",
    "invoke_count" : 48,
    "rt" : 2.3541666666666665,
    "error_count" : 0,
    "type" : "Mysql",
    "direction" : "out"
  }, {
    "tx_from_node" : "54",
    "tx_to_node" : "48",
    "invoke_count" : 359,
    "rt" : 19.220055710306408,
    "error_count" : 0,
    "type" : "Url",
    "direction" : "in"
  }, {
    "tx_from_node" : "user",
    "tx_to_node" : "295",
    "invoke_count" : 365,
    "rt" : 50.92876712328767,
    "error_count" : 0,
    "type" : "Url",
    "direction" : "in"
  }, {
    "tx_from_node" : "295",
    "tx_to_node" : "54",
    "invoke_count" : 364,
    "rt" : 29.354395604395606,
    "error_count" : 0,
    "type" : "Url",
    "direction" : "in"
  }, {
    "tx_from_node" : "295",
    "tx_to_node" : "*.*.*.*:3306:apm2_cmdb",
    "invoke_count" : 58,
    "rt" : 0.5862068965517241,
    "error_count" : 0,
    "type" : "Mysql",
    "direction" : "out"
  } ]
}

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.