文档首页/ 弹性公网IP EIP/ API参考/ API/ 弹性公网IP标签管理/ 查询弹性公网IP资源实例 - ListPublicipsByTags
更新时间：2025-10-24 GMT+08:00
在线调试
CLI示例
查看PDF
分享

查询弹性公网IP资源实例 - ListPublicipsByTags

功能介绍

使用标签过滤实例。

调试

您可以在API Explorer中调试该接口，支持自动认证鉴权。

授权信息

账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。

  • 如果使用角色与策略授权，具体权限要求请参见权限和授权项。
  • 如果使用身份策略授权，需具备如下身份策略权限。

    授权项

    访问级别

    资源类型（*为必须）

    条件键

    别名

    依赖的授权项

    eip:publicIps:listTags

    List

    publicip *

    -
    • vpc:publicipTags:get

    -

URI

POST /v2.0/{project_id}/publicips/resource_instances/action

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

项目ID，获取项目ID请参见获取项目ID

请求参数

表2 请求Body参数

参数

是否必选

参数类型

描述

tags

否

Array of TagReq objects

  • 功能说明：标签对象，最多包含10个key。

  • 约束：

    • 每个key下面的value最多10个，结构体不能缺失，key不能为空或者空字符串。

    • Key不能重复，同一个key中values不能重复。

limit

否

Integer

  • 功能说明：查询记录数（action为count时无此参数）如果action为filter默认为1000，limit最多为1000，不能为负数，最小值为1

最小值：1

最大值：1000

offset

否

Integer

  • 功能说明：索引位置，从offset指定的下一条数据开始查询。查询第一页数据时，不需要传入此参数，查询后续页码数据时，将查询前一页数据时响应体中的值带入此参数（action为count时无此参数）如果action为filter默认为0，必须为数字，不能为负数

最小值：0

action

是

String

  • 功能说明：操作标识（仅限于filter，count）：filter（过滤），count（查询总条数）

如果是filter就是分页查询，如果是count只需按照条件将总条数返回即可。

matches

否

Array of MatchReq objects

搜索字段，key为要匹配的字段，当前仅支持resource_name。value为匹配的值。此字段为固定字典值。
表3 TagReq

参数

是否必选

参数类型

描述

key

是

String

  • 功能说明：键。最大长度128个unicode字符。 key不能为空。（搜索时不对此参数做校验）

最大长度：128

values

是

Array of strings

  • 功能说明：值列表。每个值最大长度255个unicode字符，如果values为空列表，则表示any_value。value之间为或的关系。

最大长度：255
表4 MatchReq

参数

是否必选

参数类型

描述

key

是

String

  • 功能说明：键。当前仅限定为resource_name

value

是

String

  • 功能说明：值。当前仅限定为EIP地址

最大长度：255

响应参数

状态码：200

表5 响应Body参数

参数

参数类型

描述

resources

Array of ListResourceResp objects

resource对象列表

total_count

Integer

总记录数
表6 ListResourceResp

参数

参数类型

描述

resource_detail

Object

  • 功能说明：资源详情。 资源对象，用于扩展。默认为空

resource_id

String

  • 功能说明：资源ID

最小长度：0

最大长度：36

resource_name

String

  • 功能说明：资源名称，没有默认为空字符串

最小长度：0

最大长度：256

tags

Array of ListResourceTagResp objects

  • 功能说明：标签列表，没有标签默认为空数组
表7 ListResourceTagResp

参数

参数类型

描述

key

String

  • 功能说明：键。最大长度128个unicode字符。 key不能为空。(搜索时不对此参数做校验)

最小长度：1

最大长度：128

value

String

  • 功能说明：值列表。每个值最大长度255个unicode字符，如果values为空列表，则表示any_value。value之间为或的关系。

最小长度：0

最大长度：255

请求示例

  • 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操作正常返回

{
  "total_count" : 1000,
  "resources" : [ {
    "resource_detail" : null,
    "resource_id" : "cdfs_cefs_wesas_12_dsad",
    "resource_name" : "resouece1",
    "tags" : [ {
      "value" : "value1",
      "key" : "key1"
    }, {
      "value" : "value1",
      "key" : "key2"
    } ]
  } ]
}

状态码

状态码

描述

200

GET操作正常返回

错误码

请参见错误码。

父主题： 弹性公网IP标签管理

相关文档