SearchTraceAppByName - 按应用名称查询应用监控任务_应用实时监控服务(ARMS)-阿里云帮助中心

按应用名称查询应用监控任务。

调试

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

授权信息

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

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

操作	访问级别	资源类型	条件关键字	关联操作
arms:SearchTraceAppByName	get	TraceApp acs:arms:{#regionId}:{#AccountId}:traceapp/{#Pid}	无	无

请求参数

名称	类型	必填	描述	示例值
TraceAppName	string	是	应用名称。	test-app
RegionId	string	否	地域 ID。	cn-hangzhou
Tags	array<object>	否	标签列表。
	object	否
Key	string	否	精确查找弹性伸缩资源时使用的标签键。标签键长度的取值范围：1~128。 `Tags`用于精确查找绑定了指定标签的弹性伸缩资源，由一个键值对组成。仅指定`Tags.Key`时，则返回关联该标签键的所有资源。仅指定`Tags.Value`时，则出现`MissingParameter.TagKey`的报错提示。同时指定多个标签键值对时，仅同时满足所有标签键值对的弹性伸缩资源会被查找到。	TestKey
Value	string	否	标签值。非必填，可以为空字符串。最多支持 128 个字符，不能以`acs:`开头，不能包含`http://`或者`https://`。	TestValue

返回参数

名称	类型	描述	示例值
	object
RequestId	string	请求 ID。	F7781D4A-2818-41E7-B7BB-79D809E9****
TraceApps	array<object>	应用监控信息。
TraceApp	object
Type	string	监控任务类型： `TRACE`：应用监控。 `RETCODE`：前端监控。	TRACE
AppName	string	应用名称。	test-app
UpdateTime	long	更新时间的时间戳。	1593486786000
Show	boolean	ARMS 控制台中是否显示该应用： `true`：显示。 `false`：不显示。	true
CreateTime	long	创建时间的时间戳	1593486786000
Pid	string	PID。具体请参考 PID 。说明使用 V1.1.0 及以上版本的 SDK 可用该字段。	a5f9bdeb-2627-4dbe-9247-****
AppId	long	应用 ID。	123
UserId	string	用户 ID。	113197164949****
RegionId	string	地域 ID。	cn-hangzhou
Labels	array	应用别名。
Labels	string	应用别名。	prod
Tags	array<object>	标签。
Tags	object
Key	string	标签的键(key)。	TestKey
Value	string	标签的值(value)。	TestValue
ResourceGroupId	string	资源组 ID。	rg-acfmxyexli2****

示例

正常返回示例

JSON格式

{
  "RequestId": "F7781D4A-2818-41E7-B7BB-79D809E9****",
  "TraceApps": [
    {
      "Type": "TRACE",
      "AppName": "test-app",
      "UpdateTime": 1593486786000,
      "Show": true,
      "CreateTime": 1593486786000,
      "Pid": "a5f9bdeb-2627-4dbe-9247-****",
      "AppId": 123,
      "UserId": "113197164949****",
      "RegionId": "cn-hangzhou",
      "Labels": [
        "prod"
      ],
      "Tags": [
        {
          "Key": "TestKey",
          "Value": "TestValue"
        }
      ],
      "ResourceGroupId": "rg-acfmxyexli2****"
    }
  ]
}

错误码

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

变更历史

变更时间	变更内容概要	操作
2023-06-25	OpenAPI 入参发生变更	查看变更详情