ListTraceApps - 获取指定地域下全部应用监控任务的列表_应用实时监控服务(ARMS)-阿里云帮助中心

获取指定地域下全部应用监控任务的列表。

调试

您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：

操作：是指具体的权限点。
访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用背景高亮的方式表示。
- 对于不支持资源级授权的操作，用全部资源表示。
条件关键字：是指云产品自身定义的条件关键字。
关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

操作	访问级别	资源类型	条件关键字	关联操作
arms:ListTraceApps	Write	全部资源 *	无	无

请求参数

名称	类型	必填	描述	示例值
RegionId	string	是	地域 ID。	cn-hangzhou
ResourceGroupId	string	否	资源组 ID，您可以通过资源管理控制台获取。	rg-acfmxyexli2****
Tags	object []	否	标签。
Key	string	否	标签的键（key）。	TestKey
Value	string	否	标签的值（value）。	TestValue
Region	string	否	地域。	cn-shenzhen
AppType	string	否	报警规则关联应用的类型： `TRACE`：应用监控。 `EBPF`：eBPF 监控。	TRACE

返回参数

名称	类型	描述	示例值
	object
Code	integer	接口状态码： `2XX`：成功 `3XX`：重定向 `4XX`：请求错误 `5XX`：服务器错误	200
Message	string	请求参数错误时返回的信息。	Internal error. Please try again. Contact the DingTalk service account if the issue persists after multiple retries.
RequestId	string	请求 ID。	40B10E04-81E8-4643-970D-F1B38F2E****
Success	boolean	操作是否成功： `true`：操作成功 `false`：操作失败	true
TraceApps	object []	返回的应用监控列表信息。
Type	string	监控任务类型： `TRACE`：应用监控 `RETCODE`：前端监控	TRACE
AppName	string	应用名称。	test-app
UpdateTime	long	更新时间的时间戳，单位为毫秒。	1529667762000
Show	boolean	ARMS 控制台是否显示该应用： `true`：显示 `false`：不显示	true
CreateTime	long	创建时间的时间戳，单位为毫秒。	1529667762000
Pid	string	应用的 ID 标识串。	a5f9bdeb-2627-4dbe-9247-****
AppId	long	应用 ID。	123
UserId	string	用户 ID。	113197164949****
RegionId	string	地域 ID。	cn-hangzhou
Labels	array	应用标签。
	string	应用标签值。	prod
Tags	object []	标签。
Key	string	标签的键（key）。	TestKey
Value	string	标签的值（value）。	TestValue
ResourceGroupId	string	资源组 ID。	rg-acfmxyexli2****
Source	string	应用来源。	ACK
WorkloadName	string	工作负载名。	nginx-deployment
WorkloadKind	string	工作负载类型。	Deployment
Namespace	string	命名空间。	default
ClusterId	string	集群 ID。	cc7a37ee31aea4ed1a059eff8034b****
Language	string	语言。	PHP

示例

正常返回示例

JSON格式

{
  "Code": 200,
  "Message": "Internal error. Please try again. Contact the DingTalk service account if the issue persists after multiple retries.",
  "RequestId": "40B10E04-81E8-4643-970D-F1B38F2E****",
  "Success": true,
  "TraceApps": [
    {
      "Type": "TRACE",
      "AppName": "test-app",
      "UpdateTime": 1529667762000,
      "Show": true,
      "CreateTime": 1529667762000,
      "Pid": "a5f9bdeb-2627-4dbe-9247-****",
      "AppId": 123,
      "UserId": "113197164949****",
      "RegionId": "cn-hangzhou",
      "Labels": [
        "prod"
      ],
      "Tags": [
        {
          "Key": "TestKey",
          "Value": "TestValue"
        }
      ],
      "ResourceGroupId": "rg-acfmxyexli2****",
      "Source": "ACK",
      "WorkloadName": "nginx-deployment ",
      "WorkloadKind": "Deployment",
      "Namespace": "default",
      "ClusterId": "cc7a37ee31aea4ed1a059eff8034b****",
      "Language": "PHP"
    }
  ]
}

错误码

HTTP status code	错误码	错误信息
500	InternalError	必选参数不能为空
500	InternalError	系统内部错误,请联系管理员
500	InternalError	查询失败，未知用户，用户未开通ARMS

访问错误中心查看更多错误码。

变更历史

变更时间

变更内容概要

操作

2023-10-13

OpenAPI 错误码发生变更、OpenAPI 返回结构发生变更

看变更集

变更项	变更内容
错误码	OpenAPI 错误码发生变更。
	删除错误码：500
出参	OpenAPI 返回结构发生变更。

2023-09-11

OpenAPI 错误码发生变更、OpenAPI 入参发生变更、OpenAPI 返回结构发生变更

看变更集

变更项	变更内容
错误码	OpenAPI 错误码发生变更。
	删除错误码：500
入参	OpenAPI 入参发生变更。
	新增入参：AppType
出参	OpenAPI 返回结构发生变更。

2023-08-09

OpenAPI 错误码发生变更、OpenAPI 入参发生变更

看变更集

变更项	变更内容
错误码	OpenAPI 错误码发生变更。
	删除错误码：500
入参	OpenAPI 入参发生变更。
	新增入参：Region