接口约束
4.5.5 查询弹性 IP 资源实例
功能介绍
使用标签过滤实例。
调试
您可以在API Explorer中调试该接口。
URI
POST /v2.0/{project_id}/publicips/resource_instances/action
表4-396 路径参数
参数 是否必选 参数类型 描述
project_id 是 String 项目ID，获取项目ID请参见获取 项目ID
请求参数
表4-397 请求 Header 参数
参数 是否必选 参数类型 描述
X-Auth-Token 是 String 用户Token。通过调用IAM服务 获取用户Token接口获取（响应
limit 否 Integer 查询记录数（action为count时 无此参数）如果action为filter默 认为1000，limit最多为1000，
不能为负数，最小值为1
offset 否 Integer 索引位置， 从offset指定的下一 条数据开始查询。 查询第一页
参数 是否必选 参数类型 描述
action 是 String 操作标识（仅限于filter，
count）：filter（过滤），
count(查询总条数) 如果是filter 就是分页查询，如果是count只 需按照条件将总条数返回即可。
枚举值：
● filter
● count matches 否 Array of
MatchReq
表4-399 TagReq
参数 是否必选 参数类型 描述
key 是 String 键。最大长度127个unicode字 符。 key不能为空。(搜索时不 对此参数做校验)
values 是 Array of
strings 值列表。每个值最大长度255个 unicode字符，如果values为空 列表，则表示any_value。value 之间为或的关系。
表4-400 MatchReq
参数 是否必选 参数类型 描述
key 是 String 键。当前仅限定为
resource_name 枚举值：
● resource_name
value 是 String 值。每个值最大长度255个
unicode字符。
响应参数
状态码： 200
表4-401 响应 Body 参数
参数 参数类型 描述
resources Array of ListResource Resp objects
resource对象列表
total_count Integer 总记录数
表4-402 ListResourceResp
参数 参数类型 描述
resouce_detail Object 资源详情。 资源对象，用于扩展。默认为空 resource_id String 资源ID
resource_nam
e String 资源名称，没有默认为空字符串
tags Array of ListResource TagResp objects
标签列表，没有标签默认为空数组
表4-403 ListResourceTagResp
参数 参数类型 描述
key String 键。最大长度127个unicode字符。 key不能为 空。(搜索时不对此参数做校验)
value String 值列表。每个值最大长度255个unicode字符，如 果values为空列表，则表示any_value。value之 间为或的关系。
状态码： 400
表4-404 响应 Body 参数
参数 参数类型 描述
message String 服务异常错误信息描述 code String 服务异常错误信息编码
状态码： 401
表4-405 响应 Body 参数
参数 参数类型 描述
message String 服务异常错误信息描述 code String 服务异常错误信息编码
状态码： 403
表4-406 响应 Body 参数
参数 参数类型 描述
message String 服务异常错误信息描述 code String 服务异常错误信息编码
状态码： 404
表4-407 响应 Body 参数
参数 参数类型 描述
message String 服务异常错误信息描述 code String 服务异常错误信息编码
状态码： 405
表4-408 响应 Body 参数
参数 参数类型 描述
message String 服务异常错误信息描述 code String 服务异常错误信息编码
状态码： 406
表4-409 响应 Body 参数
参数 参数类型 描述
message String 服务异常错误信息描述 code String 服务异常错误信息编码
状态码： 407
表4-410 响应 Body 参数
参数 参数类型 描述
message String 服务异常错误信息描述 code String 服务异常错误信息编码
状态码： 408
表4-411 响应 Body 参数
参数 参数类型 描述
message String 服务异常错误信息描述 code String 服务异常错误信息编码
状态码： 409
表4-412 响应 Body 参数
参数 参数类型 描述
message String 服务异常错误信息描述 code String 服务异常错误信息编码
状态码： 500
表4-413 响应 Body 参数
参数 参数类型 描述
message String 服务异常错误信息描述 code String 服务异常错误信息编码
状态码： 501
表4-414 响应 Body 参数
参数 参数类型 描述
message String 服务异常错误信息描述
参数 参数类型 描述
code String 服务异常错误信息编码
状态码： 502
表4-415 响应 Body 参数
参数 参数类型 描述
message String 服务异常错误信息描述 code String 服务异常错误信息编码
状态码： 503
表4-416 响应 Body 参数
参数 参数类型 描述
message String 服务异常错误信息描述 code String 服务异常错误信息编码
状态码： 504
表4-417 响应 Body 参数
参数 参数类型 描述
message String 服务异常错误信息描述 code String 服务异常错误信息编码
请求示例
● action为filter时请求体
{ "offset" : 0, "limit" : 100, "action" : "filter", "matches" : [ {
"key" : "resource_name", "value" : "resource1"
} ], "tags" : [ { "key" : "key1",
"values" : [ "value1", "value2" ] } ]
}
● action为count时请求体
{ "action" : "count", "tags" : [ { "key" : "key1",
"values" : [ "value1", "value2" ] }, {
"key" : "key2",
"values" : [ "value1", "value2" ] } ],
"matches" : [ {
"key" : "resource_name", "value" : "resource1"
} ] }
响应示例
状态码： 200 GET操作正常返回
{ "application/json-1" : { "total_count" : 1000, "resources" : [ { "resource_detail" : null,
"resource_id" : "cdfs_cefs_wesas_12_dsad", "resource_name" : "resouece1",
"tags" : [ {
200 GET操作正常返回 400 服务器未能处理请求
状态码 描述
409 由于冲突，请求无法被完成 500 请求未完成。服务异常
501 请求未完成。服务器不支持所请求的功能
502 请求未完成。服务器从上游服务器收到一个无效的响应 503 请求未完成。系统暂时异常
504 网关超时
错误码
请参见错误码。