文档首页> 弹性公网IP EIP> API参考> GEIP API> 全域弹性公网IP标签> 查询资源实例列表
更新时间：2024-04-26 GMT+08:00
查看PDF
分享

查询资源实例列表

功能介绍

查询资源实例列表

调试

您可以在API Explorer中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。

URI

POST /v3/global-eip/resource-instances/filter

表1 Query参数

参数

是否必选

参数类型

描述

limit

否

Array

每页条数

offset

否

Array

分页查询起始的资源序号

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

用户的Token，如何获取用户Token请参见获取用户Token
表3 请求Body参数

参数

是否必选

参数类型

描述

tags

是

Array of Tag objects

包含标签。

数组长度：1 - 20
表4 Tag

参数

是否必选

参数类型

描述

key

是

String

  • 功能说明：标签名称

  • 约束：

    • 同一资源的key值不能重复，创建的预定义标签如果与已有的预定义标签完全相同，则会覆盖已有的预定义标签。

    • 键的长度最大36字符，由英文字母、数字、下划线、中划线、中文字符组成。

    • 单个资源最多可以添加20个标签。

最小长度：1

最大长度：36

value

否

String

  • 功能说明：标签值

  • 约束：

    • 值的长度最大43字符，由英文字母、数字、下划线、点、中划线、中文字符组成。

最小长度：0

最大长度：43

响应参数

状态码： 200

表5 响应Header参数

参数

参数类型

描述

X-Request-Id

-

本次请求编号
表6 响应Body参数

参数

参数类型

描述

resources

Array of GeipResource objects

资源列表

数组长度：0 - 2000

total_count

Integer

当前列表中资源数量。

最小值：0

最大值：2000

request_id

String

本次请求的编号
表7 GeipResource

参数

参数类型

描述

resource_id

String

资源ID标识符。

resource_detail

Object

资源详情。

tags

Array of Tag objects

包含标签。

数组长度：1 - 2000

resource_name

String

实例名字。

最小长度：1

最大长度：64
表8 Tag

参数

参数类型

描述

key

String

  • 功能说明：标签名称

  • 约束：

    • 同一资源的key值不能重复，创建的预定义标签如果与已有的预定义标签完全相同，则会覆盖已有的预定义标签。

    • 键的长度最大36字符，由英文字母、数字、下划线、中划线、中文字符组成。

    • 单个资源最多可以添加20个标签。

最小长度：1

最大长度：36

value

String

  • 功能说明：标签值

  • 约束：

    • 值的长度最大43字符，由英文字母、数字、下划线、点、中划线、中文字符组成。

最小长度：0

最大长度：43

请求示例

查询资源实例列表

POST https://{Endpoint}/v3/global-eip/resource-instances/filter

{
  "tags" : [ {
    "key" : "tag1",
    "value" : "tom"
  } ]
}

响应示例

状态码： 200

OK

{
  "resources" : [ {
    "resource_id" : "393f69a0-e007-45ee-89f0-872d11620f31",
    "resource_detail" : "",
    "resource_name" : "geip-f833",
    "tags" : [ {
      "key" : "tag1",
      "value" : "tom"
    } ]
  } ],
  "request_id" : "43ded943dbd213979b13e5cdfb2d49f0",
  "total_count" : 1
}

状态码

状态码

描述

200

OK

错误码

请参见错误码。

父主题： 全域弹性公网IP标签
分享：

    相关文档

    相关产品