使用标签查询资源实例
功能介绍
使用标签查询资源实例
调用方法
请参见如何调用API。
URI
POST /v2/{project_id}/{resource_type}/resource_instances/action
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
project_id |
是 |
String |
项目ID。 |
|
resource_type |
是 |
String |
资源的类型：DNS-public_zone，DNS-private_zone，DNS-public_recordset，DNS-private_recordset，DNS-ptr_record。 |
请求参数
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
X-Auth-Token |
是 |
String |
用户Token。 通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。 |
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
tags |
否 |
Array of tagValues objects |
包含标签。 最多包含10个key，每个key下面的value最多10个，结构体不能缺失，key不能为空或者空字符串。Key不能重复，同一个key中values不能重复。 |
|
tags_any |
否 |
Array of tagValues objects |
最多包含10个key，每个key下面的value最多10个，结构体不能缺失，key不能为空或者空字符串。Key不能重复，同一个key中values不能重复。 |
|
not_tags |
否 |
Array of tagValues objects |
最多包含10个key，每个key下面的value最多10个，结构体不能缺失，key不能为空或者空字符串。Key不能重复，同一个key中values不能重复。 |
|
not_tags_any |
否 |
Array of tagValues objects |
最多包含10个key，每个key下面的value最多10个，结构体不能缺失，key不能为空或者空字符串。Key不能重复，同一个key中values不能重复。 |
|
limit |
否 |
Integer |
每页返回的资源个数。 取值范围：1~1000 参数取值说明： 如果action为filter时，默认为1000。 如果action为count时，无此参数。 |
|
offset |
否 |
Integer |
分页查询起始偏移量，表示从偏移量的下一个资源开始查询。 取值范围：0~2147483647 默认值为0。 参数取值说明： 查询第一页数据时，不需要传入此参数。 查询后续页码数据时，将查询前一页数据时响应体中的值带入此参数。 如果action为filter时，默认为0，必须为数字，不能为负数。 如果action为count时，无此参数。 |
|
action |
是 |
String |
操作标识（区分大小写）。 取值范围： filter：分页过滤查询 count：查询总条数 |
|
matches |
否 |
Array of match objects |
key为要匹配的字段，value为匹配的值。 如果value为空字符串则精确匹配，否则模糊匹配。 |
响应参数
状态码： 200
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
resources |
Array of resourceItem objects |
标签资源信息列表。 |
|
total_count |
Integer |
资源总数。 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
resource_id |
String |
资源ID |
|
resource_detail |
Object |
资源详情。资源对象，用于扩展，默认为空。 |
|
tags |
Array of tag objects |
标签列表，没有标签默认为空数组。 |
|
resource_name |
String |
资源名称，没有默认为空字符串 |
请求示例
使用标签查询资源实例，分页查询起始偏移量为100，每页返回资源个数为100。
POST https://{endpoint}/v2/{project_id}/{resource_type}/resource_instances/action
{
"offset" : "100",
"limit" : "100",
"action" : "filter",
"matches" : [ {
"key" : "resource_name",
"value" : "resource1"
} ],
"not_tags" : [ {
"key" : "key1",
"values" : [ "*value1", "value2" ]
} ],
"tags" : [ {
"key" : "key1",
"values" : [ "*value1", "value2" ]
} ],
"tags_any" : [ {
"key" : "key1",
"values" : [ "value1", "value2" ]
} ],
"not_tags_any" : [ {
"key" : "key1",
"values" : [ "value1", "value2" ]
} ]
}
响应示例
状态码： 200
使用标签查询资源实例响应。
{
"resources" : [ {
"resource_detail" : null,
"resource_id" : "cdfs_cefs_wesas_12_dsad",
"resource_name" : "resouece1",
"tags" : [ {
"key" : "key1",
"value" : "value1"
}, {
"key" : "key2",
"value" : "value1"
} ]
} ],
"total_count" : 1000
}
状态码
|
状态码 |
描述 |
|---|---|
|
200 |
使用标签查询资源实例响应。 |
错误码
请参见错误码。
