更新时间:2023-08-02 GMT+08:00

查询URL跟踪视图列表

功能介绍

查询当前被调用的URL跟踪视图列表。

URI

POST /v1/apm2/openapi/transaction/search

请求参数

表1 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

从IAM服务获取的用户Token。

x-business-id

Long

应用id。

表2 请求Body参数

参数

是否必选

参数类型

描述

business_id

Long

应用id。

region

String

region英文名称。

start_time

String

开始时间。

end_time

String

结束时间。

env_id

Long

环境id。

request_id

String

上次请求的id。

page_no

Integer

页码。

page_size

Integer

每页数量。

响应参数

状态码: 200

表3 响应Body参数

参数

参数类型

描述

tx_item_list

Array of TxItemVo objects

URL跟踪视图列表。

latest_time

Long

最后响应时间。

total_count

Integer

总数据条数。

result_id

String

请求id。

表4 TxItemVo

参数

参数类型

描述

app_name

String

组件名称。

env_name

String

环境名称。

tx_display_name

String

事务显示名称。

business_id

Long

应用id。

env_id

Long

环境id。

app_id

Long

组件id。

tx_name

String

事务名称。

invoke_count

Integer

调用次数。

total_time

Integer

总耗时。

error_count

Integer

错误次数。

请求示例

分页查询Region ID为ap-southeast-3,应用ID为6的URL跟踪视图列表。

/v1/apm2/openapi/transaction/search

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

响应示例

状态码: 200

OK,请求响应成功。

{
  "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" : "xx-xxxx-xxx",
    "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"
}

状态码

状态码

描述

200

OK,请求响应成功。

401

Unauthorized,没有权限。

403

Forbidden,禁止访问。

404

Not Found,没有找到要请求的资源。

错误码

请参见错误码