调试
您可以在API Explorer中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。
授权信息
账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限，具体权限要求请参见权限和授权项。
URI
POST /v1/{project_id}/sfs-turbo/resource_instances/action
表1 路径参数
|
参数 |
是否必选 |
参数类型 |
描述 |
|
project_id |
是 |
String |
项目ID |
请求参数
表3 请求Body参数
|
参数 |
是否必选 |
参数类型 |
描述 |
|
action |
是 |
String |
通过标签查询文件系统列表的操作类型。仅支持取值为"filter" 或 "count"。
枚举值：
|
|
limit |
否 |
String |
设置返回的文件系统个数的最大值。 |
|
offset |
否 |
String |
设置返回的文件系统的偏移量 |
|
without_any_tag |
否 |
Boolean |
不包含任意一个标签，该字段为true时查询所有不带标签的资源，此时忽略 “tags”字段。该字段为false或者未提供该参数时，该条件不生效，即返回所有资源或按"tags"，"matches"等条件过滤。 |
|
tags |
否 |
Array of Tag objects |
包含标签，最多包含20个key，每个key下面的value最多20个，每个key对应的value可以为空数组但结构体不能缺失。key不能重复，同一个key中values不能重复。结果返回包含所有标签的资源列表，key之间是与的关系，key-value结构中value是或的关系。无tag过滤条件时返回全量数据。 |
|
matches |
否 |
Array of ResourceTag objects |
搜索字段，key为要匹配的字段，仅支持取值“resource_name”。value为匹配的值，当value以“*”结尾时，为前缀搜索。例如：value值为“sfsturbo*”时，返回名称为“sfsturbo”开头的所有资源列表。 |
表4 Tag
|
参数 |
是否必选 |
参数类型 |
描述 |
|
key |
是 |
String |
标签的键。
最大长度128个字符。 key不能为空。 |
|
values |
是 |
Array of strings |
值列表。每个值最大长度255个字符，如果values为空列表，则表示匹配任意值value。value之间为或的关系。 |
表5 ResourceTag
|
参数 |
是否必选 |
参数类型 |
描述 |
|
key |
是 |
String |
标签的键。
最大长度128个字符。
key不能为空，不能包含非打印字符ASCII(0-31)，“=”,“*”,“<”,“>”,“\”,“,”,“|”,“/”。只能包含大写字母、小写字母、数字，特殊字符"-"和"_"。 |
|
value |
是 |
String |
标签的值。
每个值最大长度255个字符，可以为空字符串。
不能包含非打印字符ASCII(0-31)，“=”,“*”,“<”,“>”,“\”,“,”,“|”,“/”。只能包含大写字母、小写字母、数字，特殊字符"-"和"_"。 |
响应参数
状态码：200
表7 响应Body参数
|
参数 |
参数类型 |
描述 |
|
resources |
Array of ListSharesByTagResource objects |
通过标签查询文件系统的资源列表 |
|
total_count |
Integer |
返回的文件系统的总量 |
表8 ListSharesByTagResource
|
参数 |
参数类型 |
描述 |
|
resource_id |
String |
资源ID |
|
resource_name |
String |
资源名称 |
|
resource_detail |
String |
资源详情 |
|
tags |
Array of ResourceTag objects |
资源的标签列表 |
表9 ResourceTag
|
参数 |
参数类型 |
描述 |
|
key |
String |
标签的键。
最大长度128个字符。
key不能为空，不能包含非打印字符ASCII(0-31)，“=”,“*”,“<”,“>”,“\”,“,”,“|”,“/”。只能包含大写字母、小写字母、数字，特殊字符"-"和"_"。 |
|
value |
String |
标签的值。
每个值最大长度255个字符，可以为空字符串。
不能包含非打印字符ASCII(0-31)，“=”,“*”,“<”,“>”,“\”,“,”,“|”,“/”。只能包含大写字母、小写字母、数字，特殊字符"-"和"_"。 |
状态码：400
表11 响应Body参数
|
参数 |
参数类型 |
描述 |
|
errCode |
String |
错误码 |
|
errMsg |
String |
错误描述 |
状态码：500
表13 响应Body参数
|
参数 |
参数类型 |
描述 |
|
errCode |
String |
错误码 |
|
errMsg |
String |
错误描述 |
请求示例
-
通过文件系统标签筛选文件系统列表。
{
"action" : "filter",
"limit" : 10,
"offset" : 10,
"tags" : [ {
"key" : "key1",
"values" : [ "value1", "value2" ]
}, {
"key" : "key2",
"values" : [ "value1", "value2" ]
} ]
}
-
通过文件系统名称筛选文件系统列表。
{
"action" : "filter",
"matches" : [ {
"key" : "resource_name",
"value" : "sfsturbo*"
} ]
}
响应示例
状态码：400
错误响应
{
"errCode" : "SFS.TURBO.0001",
"errMsg" : "parameter error"
}
状态码：500
错误响应
{
"errCode" : "SFS.TURBO.0005",
"errMsg" : "internal server error"
}
状态码
|
状态码 |
描述 |
|
200 |
成功 |
|
400 |
错误响应 |
|
500 |
错误响应 |
