全部产品
Search

搜索本产品

    日志服务：ListTagResources - 列出资源标签

    文档中心

    日志服务：ListTagResources - 列出资源标签

    更新时间：Nov 13, 2024

    列出所查询资源的标签列表，可以一次查询多个同类型的资源，也可以按标签键值过滤查询。

    接口说明

    • 请求语法中 Host 由 Project 名称和日志服务 Endpoint 构成，您需要在 Host 中指定 Project。
    • 已创建并获取 AccessKey。更多信息，请参见访问密钥。

    阿里云账号 AccessKey 拥有所有 API 的访问权限，风险很高。强烈建议您创建并使用 RAM 用户进行 API 访问或日常运维。RAM 用户需具备操作日志服务资源的权限。具体操作，请参见创建 RAM 用户及授权。

    • 已明确您查询日志所属的 Project 名称、所属地域等。如何查询，请参见管理 Project。
    • 鉴权规则，请参见鉴权概览。目前支持的资源包括 project、logstore、dashboard、machineGroup 和 logtailConfig。

    鉴权资源

    下表列出了 API 对应的授权信息。您可以在 RAM 权限策略语句的 Action 元素中添加该信息，用于为 RAM 用户或 RAM 角色授予调用此 API 的权限。

    动作（Action）授权策略中的资源描述方式（Resource）
    log:ListTagResources
    不同类型资源对应不同格式。
    -acs:log:{#regionId}:{#accountId}:project/{#ProjectName}
    -acs:log:${regionName}:${accountId}:project/${projectName}/logstore/${logstoreName}
    -acs:log:${regionName}:${accountId}:project/${projectName}/dashboard/${dashboardName}
    -acs:log:${regionName}:${accountId}:project/${projectName}/machinegroup/${machineGroupName}
    -acs:log:${regionName}:${accountId}:project/${projectName}/logtailconfig/${logtailConfigName}

    调试

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

    授权信息

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

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

    请求语法

    GET /tags HTTP/1.1

    请求参数

    名称类型必填描述示例值
    resourceTypestring是

    资源的类型。

    • project：项目。
    • logstore：日志库。
    • dashboard：仪表盘。
    • machinegroup：机器组。
    • logtailconfig：logtail 配置。
    		project
    resourceIdarray否

    查询的资源 ID 列表。resourceId 与 tags 应至少存在一个。

    string否

    资源 ID。以日志库为例，projectName 代表项目名称，#为拼接字符，logstore 为日志库名称。

    • project：projectName
    • logstore：projectName#logstore
    • dashboard：projectName#dashboard
    • machinegroup：projectName#machinegroup
    • logtailconfig：projectName#logtailconfig
    		ali-test-project
    tagsarray<object>否

    精确查询时，用于过滤的标签键值对。resourceId 与 tags 应至少配置一个。

    最多设置 20 个 tag。

    object否

    用于过滤查询的标签键值对。

    keystring是

    查询时用于过滤标签的键，例如 key 为"test-key"时，只会返回绑定了标签键为"test-key"的资源。

    		key1
    valuestring否

    查询时用于过滤标签的值，当值为 null 时表示只根据 key 过滤。

    		value1

    返回参数

    名称类型描述示例值
    headersobject
    Serverstring

    服务器名称。

    		nginx
    Content-Typestring

    返回的响应体的内容格式。

    		application/json
    Content-Lengthstring

    响应内容长度。

    		0
    Connectionstring

    是否长连接。取值包括：

    • close：不是长连接，则每个 HTTP 请求都会重新建立 TCP 连接。
    • keep-alive：长连接，TCP 连接建立后保持连接状态，节省连接所需时间和带宽。
    		close
    Datestring

    返回响应的时间。

    		Sun, 27 May 2018 08:25:04 GMT
    x-log-requestidstring

    服务端产生的标识，该请求的唯一 ID。

    		5B0A6B60BB6EE39764D458B5
    object

    返回结构体。

    nextTokenstring

    下一个查询开始 Token。

    		caeba0bbb2be03f84eb48b699f0a4883
    tagResourcesarray<object>

    返回的标签列表。

    object

    绑定了标签的资源。

    resourceIdstring

    资源 ID。

    		ali-test-project
    resourceTypestring

    资源类型。

    		project
    tagKeystring

    标签的键。

    		key1
    tagValuestring

    标签的值。

    		value1

    示例

    正常返回示例

    JSON格式

    {
  "nextToken": "caeba0bbb2be03f84eb48b699f0a4883",
  "tagResources": [
    {
      "resourceId": "ali-test-project",
      "resourceType": "project",
      "tagKey": "key1",
      "tagValue": "value1"
    }
  ]
}

    错误码

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