文档首页 > > API参考> API> 标签管理> 查询资源实例

查询资源实例

分享
更新时间: 2020/01/16 GMT+08:00

功能介绍

使用标签过滤实例

URI

POST /{version}/{project_id}/{resource_type}/resource_instances/action

表1 Path参数

名称

参数类型

说明

version

String

API版本,取值必须为v2

project_id

String

项目ID

resource_type

String

资源类型

  • ief-edge_node
  • ief-deployment
  • ief-application
  • ief-app_version
  • ief-device
  • ief-configmap
  • ief-secret

请求消息

表2 Body参数

名称

是否必选

参数类型

说明

tags

Array of tag objects

包含标签,最多包含10个key,每个key下面的value最多10个,每个key对应的value可以为空数组但结构体不能缺失。Key不能重复,同一个key中values不能重复。结果返回包含所有标签的资源列表,key之间是与的关系,key-value结构中value是或的关系。无tag过滤条件时返回全量数据。

tags_any

Array of tag objects

包含任意标签,最多包含10个key,每个key下面的value最多10个, 每个key对应的value可以为空数组但结构体不能缺失。Key不能重复,同一个key中values不能重复。结果返回包含标签的资源列表,key之间是或的关系,key-value结构中value是或的关系。无过滤条件时返回全量数据。

not_tags

Array of tag objects

不包含标签,最多包含10个key,每个key下面的value最多10个, 每个key对应的value可以为空数组但结构体不能缺失。Key不能重复,同一个key中values不能重复。结果返回不包含标签的资源列表,key之间是与的关系,key-value结构中value是或的关系。无过滤条件时返回全量数据。

not_tags_any

Array of tag objects

不包含任意标签,最多包含10个key,每个key下面的value最多10个, 每个key对应的value可以为空数组但结构体不能缺失。Key不能重复,同一个key中values不能重复。结果返回不包含标签的资源列表,key之间是的关系,key-value结构中value是或的关系。无过滤条件时返回全量数据。

limit

String

查询记录数(action为count时无此参数)如果action为filter默认为1000,limit最多为1000,不能为负数,最小值为1

offset

String

索引位置,偏移量(action为count时无此参数)从第一条数据偏移offset条数据后开始查询,如果action为filter默认为0(偏移0条数据,表示从第一条数据开始查询),必须为数字,不能为负数

action

String

操作标识(仅限于filter,count):filter(过滤),count(查询总条数)

如果是filter就按照过滤条件查询,如果是count,只需要返回总条数,禁止返回其他字段。

matches

Array of match objects

搜索字段,key为要匹配的字段,如resource_name等。value为匹配的值。key为固定字典值,不能包含重复的key或不支持的key。

根据key的值确认是否需要模糊匹配,如resource_name默认为模糊搜索(不区分大小写),如果value为空字符串精确匹配(IEF服务不存在资源名称为空的情况,因此此类情况返回空列表)。resource_id为精确匹配。

console

Boolean

确认是否请求源是否为console

sorted

表32 object

按标签过滤资源后返回结果的排序方式

表3 tag

名称

是否必选

参数类型

说明

key

String

键。最大长度127个unicode字符。 key不能为空。(搜索时不对此参数做字符集校验),key不能为空或者空字符串,不能为空格,校验和使用之前先trim 前后半角空格。

values

Array of strings

值列表。每个值最大长度255个unicode字符,校验和使用之前先trim 前后半角空格。

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

*为系统保留字符,如果value是以*开头表示按照*后面的值全模糊匹配。不能只传入“*”。

如果values为空列表,则表示any_value(查询任意value)。value之间为或的关系。

表4 match

名称

是否必选

参数类型

说明

key

String

键。限定为resource_name,后续扩展。

value

String

值。每个值最大长度255个unicode字符 。不校验字符集范。

请求样例

action为filter时请求体

{
    "action": "filter",
    "limit": "10",
    "offset": "0",
    "matches":[{"key":"resource_name","value":"q"}],
    "tags":[
        {
            "key":"test",
            "values": ["value1","value2"]
        }
        ]
}

响应消息

表5 Body参数

名称

是否必选

参数类型

说明

resources

Array of resource objects

资源实例

total_count

Integer

总记录数

表6 resource

名称

是否必选

参数类型

说明

resource_id

String

资源ID

tags

Array of resource_tag objects

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

resource_name

String

资源名称,资源没有名称时默认为空字符串。

表7 resource_tag

名称

是否必选

参数类型

说明

key

String

键。

value

String

值。

响应样例

action为filter时响应体:

{
    "total_count": 2,
    "resources": [
        {
            "tags": [
                {
                    "value": "",
                    "key": "testtest"
                },
                {
                    "value": "value2",
                    "key": "test"
                }
            ],
            "resource_name": "node_test_0108_1",
            "resource_id": "e25307d4-bd25-4c29-ba7f-176376ed2f99"
        },
        {
            "tags": [
                {
                    "value": "value1",
                    "key": "key1"
                },
                {
                    "value": "",
                    "key": "test"
                }
            ],
            "resource_name": "node_test-0109_1",
            "resource_id": "fc3aeee8-24e1-4912-bf7a-54854251d0e5"
        }
    ]
}

action为count时响应体:

{
"total_count": 2
}

状态码

状态码请参见状态码

分享:

    相关文档

    相关产品

文档是否有解决您的问题?

提交成功!

非常感谢您的反馈,我们会继续努力做到更好!

反馈提交失败,请稍后再试!

*必选

请至少选择或填写一项反馈信息

字符长度不能超过200

提交反馈 取消

如您有其它疑问,您也可以通过华为云社区问答频道来与我们联系探讨

跳转到云社区