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

查询资源实例

分享
更新时间: 2019/09/16 GMT+08:00

功能介绍

  • 接口名称

    GetResourceInstances

  • 功能描述

    使用标签过滤实例。

URI

  • URI格式

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

  • 参数说明

    名称

    是否必选

    参数类型

    说明

    project_id

    String

    项目ID

    获取项目ID请参考获取项目ID

    resource_type

    String

    资源类型

    目前有:

    smn_topic,主题

    smn_sms,短信

    smn_application,移动推送

请求消息

  • 参数说明

    名称

    是否必选

    参数类型

    说明

    tags

    Tags结构体数组

    包含标签,结构体说明请参见表1

    说明:

    最多包含10个key,每个key最多包含10个value,结构体不能缺失。key不能为空或者空字符串。key不能重复,同一个key中value不能重复,不同key对应的资源之间为与的关系。

    tags_any

    Tags结构体数组

    包含任意标签,结构体说明请参见表1

    说明:

    最多包含10个key,每个key最多包含10个value,结构体不能缺失。key不能为空或者空字符串。key不能重复,同一个key中value不能重复,不同key对应的资源之间为或的关系。

    not_tags

    Tags结构体数组

    不包含标签,结构体说明请参见表1

    说明:

    最多包含10个key,每个key最多包含10个value,结构体不能缺失。key不能为空或者空字符串。key不能重复,同一个key中value不能重复,不同key对应的资源之间为与非的关系。

    not_tags_any

    Tags结构体数组

    不包含任意标签,结构体说明请参见表1

    说明:

    最多包含10个key,每个key最多包含10个value,结构体不能缺失。key不能为空或者空字符串。key不能重复,同一个key中value不能重复,不同key对应的资源之间为或非的关系。

    limit

    String

    查询记录数

    • action为count时无此参数。
    • action为filter时,默认为1000。limit最多为1000,不能为负数,最小值为1。

    offset

    String

    索引位置, 从offset指定的下一条数据开始查询。 查询第一页数据时,不需要传入此参数,查询后续页码数据时,将查询前一页数据时响应体中的值带入此参数.

    • action为count时无此参数。
    • action为filter时,默认为0,必须为数字,且不能为负数。

    action

    String

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

    为filter时表示分页查询,为count只需按照条件将总条数返回即可。

    matches

    Match结构体数组

    搜索字段。

    key为要匹配的字段,当前只支持resource_name。

    value为匹配的值,当前为精确匹配。

    表1 Tags结构体

    名称

    是否必选

    参数类型

    说明

    约束

    key

    String

    最大长度127个unicode字符。 key不能为空。

    values

    String列表

    值列表

    每个值最大长度255个unicode字符, *为系统保留字符,如果里面的value是以*开头,表示按照*后面的值全模糊匹配。values字段不能缺失,但是可以为空列表,空列表情况下,表示任何值。value之间为或的关系。

  • 请求样例
    POST https://{SMN_Endpoint}/v2/{project_id}/{resource_type}/resource_instances/action
    • action为filter时请求体
      {
        "offset": "100", 
        "limit": "100", 
        "action": "filter", 
        "matches":[
             {
              "key": "resource_name", 
              "value": "resource1"
             }
         ], 
         "not_tags": [
             {
              "key": "key1", 
              "values": ["*value1","value2"]
             },
             {
              "key": "key2", 
              "values": ["*value21","value22"]
             }
         ], 
         "tags": [
          {
            "key": "key1", 
            "values": ["*value1","value2"]
            }
           ], 
         "tags_any": [
          {
            "key": "key1", 
            "values": ["value1", "value2"]
          }
        ],
         "not_tags_any": [
          {
            "key": "key1", 
            "values": ["value1", "value2"]
          }
        ]
      }
    • action为count时请求体
      {
        "action": "count", 
        "not_tags": [
          {
            "key": "key1", 
            "values": ["value1", "*value2"]
          }
        ], 
        "tags": [
          {
            "key": "key1", 
            "values": ["value1", "value2"]
          }
        ], 
        "tags_any": [
          {
            "key": "key1", 
            "values": [ "value1", "value2"]
          }
        ],
        "not_tags_any": [
          {
            "key": "key1", 
            "values": ["value1", "value2"]
          }
         ],
         "matches":[
         {
              "key": "resource_name", 
              "value": "resouurce"
         }
        ]
      }

响应消息

  • 要素说明

    名称

    是否必选

    参数类型

    说明

    resources

    Resource结构体数组

    结构体说明请参见表2

    total_count

    Integer

    总记录数

    表2 Resource结构体

    名称

    是否必选

    参数类型

    说明

    resource_id

    String

    资源ID

    resource_detail

    Object

    资源详情。 资源对象,用于扩展。默认为空。

    对于topic资源类型,该字段内容为{"topic_urn":"${TopicUrn}","display_name":"display name"};

    对于其它资源类型为null。

    tags

    Resource_tag结构体数组

    标签列表,没有标签默认为空数组。结构体说明请参见表3

    resource_name

    String

    资源名称

    表3 Resource_tag结构体

    名称

    是否必选

    参数类型

    说明

    约束

    key

    String

    最大长度36个unicode字符, 不能为空或空字符串。只能包含大写字母、小写字母、数字和特殊字符(-_),且首尾不能为空格。

    value

    String

    每个值最大长度43个unicode字符,可以为空字符串。 只能包含大写字母、小写字母、数字和特殊字符(-_),且首尾不能为空格。

  • 响应样例

    action为filter时响应体

    { 
          "resources": [
             {
                "resource_detail": {
                     "topic_urn":"urn:smn:regionId:f96188c7ccaf4ffba0c9aa149ab2bd57:resouece1",
                     "display_name":"testtest"
                 },
                "resource_id": "cffe4fc4c9a54219b60dbaf7b586e132", 
                "resource_name": "resouece1", 
                "tags": [
                    {
                       "key": "key1",
                       "value": "value1"
                    }
                 ]
             }
           ], 
          "total_count": 1000
    }

    action为count时响应体

    {
           "total_count": 1000
    }

返回值

请参考返回值

错误码

请参考错误码说明

分享:

    相关文档

    相关产品

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

提交成功!

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

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

*必选

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

字符长度不能超过200

提交反馈 取消

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

跳转到云社区