文档

SearchTraceAppByName - 按应用名称查询应用监控任务

更新时间:

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

调试

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

授权信息

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

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

请求参数

名称类型必填描述示例值
TraceAppNamestring

应用名称。

test-app
RegionIdstring

地域 ID。

cn-hangzhou
Tagsobject []

标签列表。

Keystring

精确查找弹性伸缩资源时使用的标签键。标签键长度的取值范围:1~128。

Tags用于精确查找绑定了指定标签的弹性伸缩资源,由一个键值对组成。

  • 仅指定Tags.Key时,则返回关联该标签键的所有资源。
  • 仅指定Tags.Value时,则出现MissingParameter.TagKey的报错提示。
  • 同时指定多个标签键值对时,仅同时满足所有标签键值对的弹性伸缩资源会被查找到。
TestKey
Valuestring

标签值。非必填,可以为空字符串。最多支持 128 个字符,不能以acs:开头,不能包含http://或者https://

TestValue

返回参数

名称类型描述示例值
object
RequestIdstring

请求 ID。

F7781D4A-2818-41E7-B7BB-79D809E9****
TraceAppsobject []

应用监控信息。

Typestring

监控任务类型:

  • TRACE:应用监控。
  • RETCODE:前端监控。
TRACE
AppNamestring

应用名称。

test-app
UpdateTimelong

更新时间的时间戳。

1593486786000
Showboolean

ARMS 控制台中是否显示该应用:

  • true:显示。
  • false:不显示。
true
CreateTimelong

创建时间的时间戳

1593486786000
Pidstring

PID。具体请参考 PID

说明 使用 V1.1.0 及以上版本的 SDK 可用该字段。
a5f9bdeb-2627-4dbe-9247-****
AppIdlong

应用 ID。

123
UserIdstring

用户 ID。

113197164949****
RegionIdstring

地域 ID。

cn-hangzhou
Labelsarray

应用别名。

string

应用别名。

prod
Tagsobject []

标签。

Keystring

标签的键(key)。

TestKey
Valuestring

标签的值(value)。

TestValue
ResourceGroupIdstring

资源组 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-25OpenAPI 入参发生变更看变更集
变更项变更内容
入参OpenAPI 入参发生变更
    新增入参:Tags
  • 本页导读 (1)
文档反馈