文档首页/ 应用性能管理 APM/ API参考(2.0)/ API/ 事务查询/ 查询URL跟踪配置列表- SearchTransactionConfig
更新时间:2025-11-11 GMT+08:00
分享

查询URL跟踪配置列表- SearchTransactionConfig

功能介绍

查询已配置好的URL跟踪配置列表。

调用方法

请参见如何调用API

授权信息

账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限。

  • 如果使用角色与策略授权,具体权限要求请参见权限和授权项
  • 如果使用身份策略授权,需具备如下身份策略权限。

    授权项

    访问级别

    资源类型(*为必须)

    条件键

    别名

    依赖的授权项

    apm:application:getTransaction

    Read

    -

    g:EnterpriseProjectId

    apm:apm2BusinessBusiness:get

    -

URI

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

请求参数

表1 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

从IAM服务获取的用户Token。

x-business-id

Long

应用id。

表2 请求Body参数

参数

是否必选

参数类型

描述

business_id

Long

应用id。

env_id

Long

环境id。

page_no

Integer

页码。

page_size

Integer

每页数量。

响应参数

状态码: 200

表3 响应Body参数

参数

参数类型

描述

transaction_config_item_list

Array of TransactionConfigItem objects

URL跟踪视图配置列表。

total_page

Integer

总页数。

total_count

Integer

总配置数。

表4 TransactionConfigItem

参数

参数类型

描述

id

Long

配置id。

business_id

Long

应用id。

env_id

Long

环境id。

method

String

请求方式。

env_name

String

环境名称。

region

String

region显示英文名称。

type

String

类型。

app_name

String

应用名称。

url

String

url地址。

请求示例

分页查询应用ID为6的URL跟踪配置列表。

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

{
  "business_id" : 6,
  "page_no" : 1,
  "page_size" : 10
}

响应示例

状态码: 200

OK,请求响应成功。

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

状态码

状态码

描述

200

OK,请求响应成功。

400

Bad Request,语义或参数有误。

401

Unauthorized,没有权限。

403

Forbidden,禁止访问。

404

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

错误码

请参见错误码

相关文档