文档首页/ 数据湖探索 DLI/ API参考/ 资源标签相关API/ 查询指定资源实例的标签信息
更新时间:2024-10-26 GMT+08:00
分享

查询指定资源实例的标签信息

功能介绍

查询指定资源实例的标签信息。

调试

您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。

URI

GET /v3/{project_id}/{resource_type}/{resource_id}/tags

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

项目编号,用于资源隔离。获取方式请参考获取项目ID

resource_type

String

资源类型。

  • dli_queue:队列
  • dli_elastic_resource_pool:弹性资源池
  • dli_enhanced_datasource:增强型跨源连接
  • dli_database:数据库
  • dli_package_resource:资源包(不支持指定有Module ID的内置资源包)
  • dli_flink_job:Flink作业

resource_id

String

资源ID。

最小长度:1

最大长度:1000

获取方式:

  • 队列ID:通过调用查询所有队列获队列ID。响应中的queue_id为队列ID。
  • 弹性资源池ID:通过调用查询所有弹性资源池获弹性资源池ID。响应中的resource_id为弹性资源池ID。
  • 增强型跨源连接ID:在DLI管理控制台的“增强型跨源连接”列表页获取“连接ID”即为增强型跨源连接ID。
  • 数据库ID:添加标签时候传入的数据库ID即数据库名。您可以在DLI控制台的“库表管理”页面查看数据库名称。
  • Flink作业ID:在DLI管理控制台的“Flink作业”列表页面单击Flink作业名称,在Flink作业的详情页面即可获取Flink作业ID。
表2 Query参数

参数

是否必选

参数类型

描述

limit

Integer

每页显示条数,默认为1000。

offset

Integer

查询结果偏移量,默认为0。

请求参数

响应参数

表3 响应参数

参数

参数类型

描述

count

Integer

标签数量。

tags

Array of objects

资源标签列表。请参考表4

表4 tags字段数据结构说明

参数

参数类型

描述

key

String

资源标签键。

values

Array of strings

资源标签值列表。

请求示例

响应示例

{
       "count": 2,
       "tags": [
        {
            "key": "key1",
            "value": "value1"
        },
        {
            "key": "key2",
            "value": "value3"
        }
]
}

状态码

状态码

描述

200

修改成功。

400

请求错误。

500

内部服务器错误。

错误码

请参见错误码

相关文档