查询资源实例列表
功能介绍
查询资源实例列表。
URI
POST /v5/{project_id}/{resource_type}/resource-instances/filter
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
project_id |
是 |
String |
租户在某一Region下的Project ID。 获取方法请参见获取项目ID。 |
resource_type |
是 |
String |
资源类型。
枚举值：
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
limit |
否 |
Integer |
查询记录数，默认为1000，limit最多为1000,不能为负数，最小值为1。 |
offset |
否 |
Integer |
索引位置，偏移量从第一条数据偏移offset条数据后开始查询，默认为0（偏移0条数据，表示从第一条数据开始查询）,必须为数字，不能为负数。 |
请求参数
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
Content-Type |
是 |
String |
发送的实体的MIME类型。推荐用户默认使用application/json，如果API是对象、镜像上传等接口，媒体类型可按照流类型的不同进行确定。 缺省值：application/json |
X-Auth-Token |
是 |
String |
从IAM服务获取的用户Token。用户Token也就是调用IAM获取用户Token接口的响应值，请求响应成功后在响应消息头中包含的“X-Subject-Token”的值即为Token值。 |
X-Language |
否 |
String |
请求语言类型。 缺省值：en-us 枚举值：
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
without_any_tag |
否 |
Boolean |
不包含任意一个标签，该字段为true时查询所有不带标签的资源，此时忽略 “tags”字段。该字段为false或者未提供该参数时，该条件不生效，即返回所有资源或按"tags"，"matches"等条件过滤。 |
tags |
否 |
Array of objects |
包含标签，最多包含20个key，每个key下面的value最多20个。 详情请参见表5。 |
matches |
否 |
Array of objects |
搜索字段,key为要匹配的字段，如resource_name等。value为匹配的值。 详情请参见表6。 |
响应参数
状态码： 200
参数 |
参数类型 |
描述 |
|---|---|---|
total_count |
Integer |
总数。 |
resources |
Array of objects |
资源列表。 详情请参见表8。 |
参数 |
参数类型 |
描述 |
|---|---|---|
resource_id |
String |
资源ID。 |
resource_detail |
String |
资源详情。 资源对象，用于扩展。默认为空。 |
resource_name |
String |
资源名称。 |
tags |
Array of objects |
标签列表。 详情请参见表9。 |
请求示例
查询同步任务实例列表。
https://{endpoint}/v5/5237e10fe9aa4ad5b16b6a5245248314/sync/resource-instances/filter?limit=1000&offset=0
{
"tags" : [ {
"key" : "key1",
"values" : [ "value1", "value2" ]
}, {
"key" : "key2",
"values" : [ "value1", "value2" ]
} ],
"matches" : [ {
"key" : "resource_name",
"value" : "resource1"
} ],
"without_any_tag" : false
}
响应示例
状态码： 200
OK
{
"resources" : [ {
"tags" : [ {
"key" : "aaaaa",
"value" : "bbbbb"
}, {
"key" : "zzzz",
"value" : ""
} ],
"resource_id" : "2f4af282-d13e-4b10-a1eb-609b47fjb201",
"resource_detail" : "",
"resource_name" : "DRS-5634"
} ],
"total_count" : 1
}
状态码
状态码 |
描述 |
|---|---|
200 |
OK |
错误码
请参见错误码。
