文档首页/ 数据湖探索 DLI/ API参考/ 资源标签相关API/ 查询资源实例列表
更新时间：2024-11-04 GMT+08:00
在线调试
CLI示例
查看PDF
分享

查询资源实例列表

功能介绍

该接口用于查询资源实例列表。

调试

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

URI

POST /v3/{project_id}/{resource_type}/resource-instances/filter

表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作业
表2 Query参数

参数

是否必选

参数类型

描述

limit

否

Integer

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

offset

否

Integer

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

请求参数

表3 请求Body参数

参数

是否必选

参数类型

描述

without_any_tag

否

Boolean

是否不包含任意一个标签。默认值false。

  • true：不包含任意一个标签。
  • false：指定标签。

tags

否

Array of objects

包含标签。请参考tags。

  • 最多支持20个标签。
  • 每个资源中的键不能重复，同一个键中值不能重复。
  • 无tag过滤条件时返回全量数据。

matches

否

Array of objects

搜索字段。

请参考matches。
表4 tags

参数

是否必选

参数类型

描述

key

是

String

键。

标签的键的最大长度为128个字符，标签的键可以包含任意语种字母、数字、空格和_ . : +-@，但首尾不能含有空格，不能以_sys_开头。

values

是

Array of strings

值列表。

标签值的最大长度为255个字符，标签的值可以包含任意语种字母、数字、空格和_ . : +-@，但首尾不能含有空格。

value可为空数组但不可缺省。

如果values为空列表，则表示any_value（查询任意value）。value之间为或的关系。
表5 matches

参数

是否必选

参数类型

描述

key

是

String

键。当前仅支持resource_name。

resource_name：资源名称。

默认按输入的资源名称前缀模糊搜索。

value

是

String

值。每个值最大长度255。

响应参数

表6 响应参数

名称

是否必选

参数类型

说明

resources

是

List<resource>

资源实例列表。

请参考表7。

total_count

是

Integer

总记录数。
表7 resource字段数据结构说明

名称

是否必选

参数类型

说明

resource_id

是

String

资源ID。

resource_detail

是

Object

资源详情。该字段属于扩展字段，默认为空。

tags

是

List<resource_tag>

标签列表，没有标签默认为空数组。

请参考表8。

resource_name

是

String

资源名称，资源没有名称时默认为空字符串，eip返回ip地址。
表8 tags字段数据结构说明

名称

是否必选

参数类型

说明

key

是

String

资源标签键。

value

是

String

资源标签值。

请求示例

{
    "tags":[
        {
            "key":"key1",
            "values":[
                "value1",
                "value2"
            ]
        },
        {
            "key":"key2",
            "values":[
                "value1",
                "value2"
            ]
        }
    ],
    "matches":[
        {
            "key":"resource_name",
            "value":"resource1"
        }
    ],
    "without_any_tag":"false"
}

响应示例

{ 
      "resources": [
         {
            "resource_detail": null, 
            "resource_id": "test1", 
            "resource_name": "resource1", 
            "tags": [
                {
                   "key": "key1",
                   "value": "value1"
                },
                {
                   "key": "key2",
                   "value": "value1"
                }
             ]
         }
       ], 
      "total_count": 1000
}

状态码

状态码

描述

200

修改成功。

400

请求错误。

500

内部服务器错误。

错误码

请参见错误码。

父主题： 资源标签相关API

相关文档