通过标签查询文件系统列表 - ListSharesByTag

project_id

是

String

参数解释：

项目ID，用于标识资源所属的IAM项目空间，实现项目级资源隔离与权限管控。

获取方法请参见获取项目ID。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

X-Auth-Token

是

String

参数解释：

用户Token，用于鉴权认证。

通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

Content-Type

是

String

参数解释：

请求消息体MIME类型，用于标识请求正文的数据格式。

约束限制：

不涉及。

取值范围：

application/json

默认取值：

application/json

action

是

String

参数解释：

操作类型，用于指定通过标签查询文件系统列表的方式。

约束限制：

不涉及。

取值范围：

• filter：分页查询匹配标签的文件系统列表。

• count：统计匹配标签的文件系统数量。

默认取值：

不涉及。

limit

否

String

参数解释：

设置返回的文件系统数量的最大值。

约束限制：

仅在action取值为filter时有效。

取值范围：

不涉及。

默认取值：

不涉及。

offset

否

String

参数解释：

分页查询的偏移量，用于分页查询时指定起始位置。

约束限制：

仅在action取值为filter时有效。

取值范围：

不涉及。

默认取值：

不涉及。

without_any_tag

否

Boolean

参数解释：

是否查询不包含任意标签的文件系统。

约束限制：

不涉及。

取值范围：

• true：查询所有不带标签的文件系统，此时忽略tags参数，但matches字段仍生效。

• false：该参数不生效，返回按tags、matches等参数过滤的所有文件系统。未提供该参数时同理。

默认取值：

不涉及。

tags

否

Array of TagFilter objects

参数解释：

标签过滤条件，用于查询包含指定标签的文件系统。多个键之间为“与”的关系，同一键下的多个值之间为“或”的关系。不传该参数时返回全量数据。

约束限制：

• 最多包含20个键，每个键下最多对应20个值。

• 每个键对应的值可以为空数组，但键值对结构不能缺失。

• 键不能重复，同一键下的值不能重复。

取值范围：

不涉及。

默认取值：

不涉及。

matches

否

Array of MatchFilter objects

参数解释：

搜索字段，用于按指定字段匹配文件系统。key为匹配字段名，仅支持取值“resource_name”。value为匹配值，以“*”结尾时表示前缀搜索。例如：value值为“sfsturbo*”时，返回名称以“sfsturbo”开头的文件系统列表。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

key

是

String

参数解释：

标签的键。

约束限制：

• 键不能为空。

• 键最大长度为128个字符。

• 只能包含大写字母、小写字母、数字以及特殊字符“-”和“_”，不能包含非打印字符（ASCII 0~31）及“=”,“*”,“<”,“>”,“\”,“,”,“|”,“/”。

取值范围：

不涉及。

默认取值：

不涉及。

values

是

Array of strings

参数解释：

值列表，用于指定标签键下的值范围。如果值为空列表，则表示匹配任意值。多个值之间为“或”的关系。

约束限制：

• 值最大长度为255个字符，可以为空字符串。

• 最多包含20个键，每个键最多对应20个值。

• 只能包含大写字母、小写字母、数字以及特殊字符“-”和“_”，不能包含非打印字符（ASCII 0~31）及“=”,“*”,“<”,“>”,“\”,“,”,“|”,“/”。

取值范围：

不涉及。

默认取值：

不涉及。

key

是

String

参数解释：

搜索字段名，用于指定按哪个字段进行匹配。

约束限制：

不涉及。

取值范围：

resource_name：表示按文件系统名称搜索。

默认取值：

resource_name

value

是

String

参数解释：

文件系统名称的匹配值，用于搜索名称与该值匹配的文件系统。

约束限制：

• 值最大长度为255个字符。

• 仅支持前缀搜索，即以“*”结尾匹配名称前缀，不以“*”结尾时为精确匹配。

取值范围：

不涉及。

默认取值：

不涉及。

X-request-id

String

参数解释：

请求ID，用于唯一标识和追踪本次请求。

取值范围：

不涉及。

resources

Array of ListSharesByTagResource objects

参数解释：

通过标签查询文件系统的资源列表。

取值范围：

不涉及。

total_count

Integer

参数解释：

返回的文件系统的数量。

取值范围：

不涉及。

resource_id

String

参数解释：

资源ID，用于唯一标识文件系统实例。

取值范围：

不涉及。

resource_name

String

参数解释：

资源名称，即文件系统名称。

取值范围：

不涉及。

resource_detail

String

参数解释：

资源详情，即文件系统的描述信息。

取值范围：

不涉及。

tags

Array of ResourceTag objects

参数解释：

资源的标签列表。

取值范围：

不涉及。

key

String

参数解释：

标签的键。

取值范围：

不涉及。

value

String

参数解释：

标签的值。

取值范围：

不涉及。

X-request-id

String

参数解释：

请求ID，用于唯一标识和追踪本次请求。

取值范围：

不涉及。

errCode

String

参数解释：

错误码，用于标识请求失败的原因。详细错误码请参见错误码。

取值范围：

不涉及。

errMsg

String

参数解释：

错误描述，用于描述请求失败的具体原因，便于排查问题。请参见错误码。

取值范围：

不涉及。

X-request-id

String

参数解释：

请求ID，用于唯一标识和追踪本次请求。

取值范围：

不涉及。

errCode

String

参数解释：

错误码，用于标识请求失败的原因。详细错误码请参见错误码。

取值范围：

不涉及。

errMsg

String

参数解释：

错误描述，用于描述请求失败的具体原因，便于排查问题。请参见错误码。

取值范围：

不涉及。

200

成功

400

错误响应

500

错误响应