更新时间:2024-11-05 GMT+08:00
分享

查询资源实例数量

功能介绍

根据标签查询资源实例数量。

URI

  • POST /v3/sfs/tms/{project_id}/file-systems/resource-instances/count
  • 参数说明

    参数

    是否必选

    参数类型

    描述

    project_id

    String

    操作用户的项目ID,获取方法请参见获取项目ID

请求参数

表1 请求Header参数

参数

是否必选

参数类型

描述

Content-type

String

发送的实体的MIME类型。

示例:application/json

X-Auth-Token

String

用户Token。

表2 请求Body参数

参数

是否必选

参数类型

描述

without_any_tag

boolean

不包含任意一个标签,该字段为true时查询所有不带标签的资源,此时忽略 “tags”字段。该字段为false或者未提供该参数时,该条件不生效,即返回所有资源或按"tags","matches"等条件过滤。

tags

List<tag>

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

详细说明参见表3

sys_tags

List<tag>

包含系统标签。仅op_service权限可以使用此字段。

sys_tags和过滤条件without_any_tag 、tags不能同时使用。

目前此字段只包含一个tag结构体:

key:_sys_enterprise_project_id

value:企业项目id列表

目前key下面只包含一个value。0表示默认企业项目。

详细说明参见表3

matches

List<match>

搜索字段。match中key为固定字典值,当前key固定为resource_name,表示根据key对应的value值实现前缀搜索,后续再扩展。

详细说明参见表4

响应参数

表3 响应body参数

参数

是否必选

参数类型

描述

total_count

Integer

总记录数

请求示例

projectId为“c80a2157ba1d46c0825265947342077c”,查询资源实例数量示例:

POST https://{endpoint}/v3/sfs/tms/c80a2157ba1d46c0825265947342077c/file-systems/resource-instances/count

请求体示例:

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

响应示例

{
    "total_count":1
}

状态码

  • 正常

状态码

描述

200

查询资源实例数量成功。

  • 异常

状态码

描述

400

标签等参数非法

401

认证失败

403

鉴权失败

404

资源未找到

500

系统异常

相关文档