查询资源实例列表
功能介绍
通过标签查询工作空间。输入without_any_tag=true查询无标签资源，忽略tags字段；without_any_tag=false或未提供时，按tags、matches等条件过滤。tags最多含20个键，每键最多20个值，键不可重复，值可为空但结构不可缺失。matches支持特定字段的精确或模糊搜索。返回符合过滤条件的工作空间信息。
调试
您可以在API Explorer中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。
URI
POST /v1/{project_id}/fabric-workspace/resource-instances/filter
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
project_id |
是 |
String |
参数解释：项目ID。获取方法，请参见获取项目ID。 约束限制：不涉及。 取值范围：长度为[1,36]的英文字符、数字和中划线(-)的组合。 默认取值：不涉及。 |
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
offset |
否 |
Integer |
参数解释：偏移量，表示从此偏移量开始查询。 约束限制：不涉及。 取值范围：[0,1000000000]。 默认取值：0。 |
|
limit |
否 |
Integer |
参数解释：指定每一页返回的最大条目数。 约束限制：不涉及。 取值范围：[1,100]。 默认取值：10。 |
请求参数
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
X-Auth-Token |
否 |
String |
参数解释：租户Token。用于调用接口的认证。获取方法，请参见认证鉴权。 约束限制：不涉及。 取值范围：长度不超过65534个字符。 默认取值：不涉及。 |
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
without_any_tag |
否 |
Boolean |
参数解释：不包含任意一个标签，该字段为true时查询所有不带标签的资源，此时忽略 “tags”、“tags_any”、“not_tags”、“not_tags_any”字段。 约束限制：不涉及。 取值范围：true，false。 默认取值：不涉及。 |
|
tags |
否 |
Array of ResourceTagParam objects |
参数解释：包含标签，最多包含50个key，每个key下面的value最多10个，每个key对应的value可以为空数组但结构体不能缺失。 约束限制：[1,20]。 |
|
matches |
否 |
Array of TagMatch objects |
参数解释：搜索字段，key为要匹配的字段，如resource_name等。value为匹配的值。 约束限制：[1,10]。 |
|
sys_tags |
否 |
Array of SystemTagParam objects |
参数解释：系统标签列表，目前只包含一个tag结构体。key下面只包含一个value。 约束限制：1。 |
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
key |
是 |
String |
参数解释：资源标签的键。 约束限制：不涉及。 取值范围：见查询标签键列表。 默认取值：不涉及。 |
|
values |
否 |
Array of strings |
参数解释：资源标签的值列表。 约束限制：不涉及。 |
响应参数
状态码：200
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
X-request-id |
String |
参数解释：请求ID。 约束限制：不可修改。 取值范围：不涉及。 默认取值：不涉及。 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
resources |
Array of TagFabricWorkspace objects |
参数解释：资源列表。 约束限制：[0,1000]。 |
|
total_count |
Integer |
参数解释：资源总数。 约束限制：不涉及。 取值范围：[0,1000]。 默认取值：不涉及。 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
resource_id |
String |
参数解释：工作空间的ID。 约束限制：不涉及。 取值范围：不涉及。 默认取值：不涉及。 |
|
resource_detail |
Object |
参数解释：资源详情。 资源对象，用于扩展。默认为空。 约束限制：不涉及。 |
|
resource_name |
String |
参数解释：工作空间名称。 约束限制：不涉及。 取值范围：不涉及。 默认取值：不涉及。 |
|
tags |
Array of ResourceTag objects |
参数解释：标签列表，没有标签默认为空数组。 约束限制：[0,100000]。 |
|
sys_tags |
Array of SystemTag objects |
参数解释：系统标签。 约束限制：不涉及。 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
key |
String |
参数解释：资源标签的键。 约束限制：不涉及。 取值范围：长度1到128的多语言字母、空格、制表符、数字、下划线(_)、点(.)、冒号(:)、斜杠()、等号(=)、加号(+)、减号(-)、@符号(@)组合，见查询标签键列表。 默认取值：不涉及。 |
|
value |
String |
参数解释：资源标签的值。 约束限制：不涉及。 取值范围：长度0到255的多语言字母、空格、制表符、数字、下划线(_)、点(.)、冒号(:)、斜杠()、等号(=)、加号(+)、减号(-)、@符号(@)组合。 默认取值：不涉及。 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
key |
String |
参数解释：键。 约束限制：固定值。 取值范围：固定值：_sys_enterprise_project_id。 默认取值：不涉及。 |
|
value |
String |
参数解释：企业项目ID。获取方法，请参见获取企业项目ID。 约束限制：不涉及。 取值范围：不涉及。 默认取值：不涉及。 |
状态码：400
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
error_code |
String |
参数解释：错误码。 约束限制：不涉及。 取值范围：长度为[8,36]个字符。 默认取值：不涉及。 |
|
error_msg |
String |
参数解释：错误描述。 约束限制：不涉及。 取值范围：长度为[2,512]个字符。 默认取值：不涉及。 |
|
solution_msg |
String |
参数解释：解决方案描述。 约束限制：不涉及。 取值范围：长度为[0,4096]个字符。 默认取值：不涉及。 |
状态码：401
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
error_code |
String |
参数解释：错误码。 约束限制：不涉及。 取值范围：长度为[8,36]个字符。 默认取值：不涉及。 |
|
error_msg |
String |
参数解释：错误描述。 约束限制：不涉及。 取值范围：长度为[2,512]个字符。 默认取值：不涉及。 |
|
solution_msg |
String |
参数解释：解决方案描述。 约束限制：不涉及。 取值范围：长度为[0,4096]个字符。 默认取值：不涉及。 |
状态码：408
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
error_code |
String |
参数解释：错误码。 约束限制：不涉及。 取值范围：长度为[8,36]个字符。 默认取值：不涉及。 |
|
error_msg |
String |
参数解释：错误描述。 约束限制：不涉及。 取值范围：长度为[2,512]个字符。 默认取值：不涉及。 |
|
solution_msg |
String |
参数解释：解决方案描述。 约束限制：不涉及。 取值范围：长度为[0,4096]个字符。 默认取值：不涉及。 |
状态码：500
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
error_code |
String |
参数解释：错误码。 约束限制：不涉及。 取值范围：长度为[8,36]个字符。 默认取值：不涉及。 |
|
error_msg |
String |
参数解释：错误描述。 约束限制：不涉及。 取值范围：长度为[2,512]个字符。 默认取值：不涉及。 |
|
solution_msg |
String |
参数解释：解决方案描述。 约束限制：不涉及。 取值范围：长度为[0,4096]个字符。 默认取值：不涉及。 |
请求示例
请求过滤tag_key的标签的资源，具体请求实例如下。
POST https://{endpoint}/v1/{project_id}/fabric-workspace/resource-instances/filter
{
"without_any_tag" : false,
"tags" : [ {
"key" : "tag_key",
"values" : [ "tag_value" ]
} ],
"matches" : [ {
"key" : "resource_name",
"value" : "tag_value"
} ],
"sys_tags" : ""
}响应示例
状态码：200
OK
{
"resources" : [ {
"resource_id" : "01049549-82cd-4b2b-9733-ddb94350c125",
"resource_detail" : { },
"resource_name" : "resource_name",
"tags" : [ {
"key" : "key1",
"value" : "value1"
} ],
"sys_tags" : [ {
"key" : "_sys_enterprise_project_id",
"value" : "01049549-82cd-4b2b-9733-ddb94350c125"
} ]
} ],
"total_count" : 1
}状态码：400
BadRequest
{
"error_code" : "common.01000001",
"error_msg" : "failed to read http request, please check your input, code: 400, reason: Type mismatch., cause: TypeMismatchException"
}状态码：401
Unauthorized
{
"error_code" : "APIG.1002",
"error_msg" : "Incorrect token or token resolution failed"
}状态码：403
Forbidden
{
"error" : {
"code" : "403",
"message" : "X-Auth-Token is invalid in the request",
"title" : "Forbidden"
},
"error_code" : 403,
"error_msg" : "X-Auth-Token is invalid in the request",
"title" : "Forbidden"
}状态码：408
Request Time-out
{
"error_code" : "common.00000408",
"error_msg" : "timeout exception occurred"
}状态码：500
InternalServerError
{
"error_code" : "common.00000500",
"error_msg" : "internal error"
}状态码
|
状态码 |
描述 |
|---|---|
|
200 |
OK |
|
400 |
BadRequest |
|
401 |
Unauthorized |
|
403 |
Forbidden |
|
408 |
Request Time-out |
|
500 |
InternalServerError |
错误码
请参见错误码。
