文档首页> 虚拟私有云 VPC> API参考> API V3> IP地址组> 查询地址组列表
更新时间：2024-03-28 GMT+08:00
前往Github编辑
查看PDF
分享

查询地址组列表

功能介绍

查询地址组列表，根据过滤条件进行过滤。

该接口在华北-北京一，华北-北京二，华北-北京四，华北-乌兰察布一，华东-上海一，华东-上海二，华南-广州，华南-深圳，西南-贵阳一，中国-香港，亚太-曼谷，亚太-新加坡，亚太-雅加达，土耳其-伊斯坦布尔，非洲-约翰内斯堡，拉美-墨西哥城一，拉美-墨西哥城二，拉美-圣保罗一，拉美-圣地亚哥区域上线。

调试

您可以在API Explorer中调试该接口。

URI

GET /v3/{project_id}/vpc/address-groups

表1 参数说明

名称

是否必选

参数类型

说明

project_id

是

String

项目ID。

获取方法请参见获取项目ID。
表2 Query参数

参数

是否必选

参数类型

描述

limit

否

Integer

功能说明：每页返回的个数

取值范围：0-2000

enterprise_project_id

否

String

功能说明：企业项目ID。可以使用该字段过滤某个企业项目下的IP地址组。

取值范围：最大长度36字节，带“-”连字符的UUID格式，或者是字符串“0”。“0”表示默认企业项目。若需要查询当前用户所有企业项目绑定的IP地址组，请传参all_granted_eps。

最大长度：36

备注：该参数在华南-深圳、西南-贵阳一、华南-广州、亚太-新加坡区域上线。

marker

否

String

分页查询起始的资源ID，为空时查询第一页

id

否

Array of strings

地址组唯一标识，填写后接口按照id进行过滤，支持多ID同时过滤

name

否

Array of strings

地址组名称，填写后按照名称进行过滤，支持多名称同时过滤

ip_version

否

Integer

IP地址组ip版本，取值范围：4、6

description

否

Array of strings

地址组描述信息，填写后按照地址组描述信息过滤，支持多描述同时过滤

请求参数

无

请求示例

  • 组合过滤条件查询地址组列表
    "GET https://{{endpoint}}/v3/b2782e6708b8475c993e6064bc456bf8/vpc/address-groups?name=vkvgykvsvhjaaaa1&description=xxxxxxxxxx&ip_version=4"

响应参数

状态码为 200 时:

表3 响应Body参数

参数

参数类型

描述

request_id

String

请求ID

address_groups

Array of AddressGroup objects

地址组列表响应体

page_info

PageInfo object

分页信息
表4 AddressGroup

参数

参数类型

描述

id

String
  • 功能说明：地址组唯一标识。
  • 取值范围：合法UUID的字符串。

name

String
  • 功能说明：地址组名称。
  • 取值范围：0-64个字符，支持数字、字母、中文、_(下划线)、-（中划线）、.（点）。

description

String
  • 功能说明：地址组描述信息。
  • 取值范围：0-255个字符。
  • 约束：不能包含“<”和“>”。

ip_set

Array of strings
  • 功能说明：地址组可包含地址集。
  • 取值范围：可以是单个ip地址，ip地址范围，ip地址cidr。
  • 约束：当前一个地址组ip_set数量限制默认值为20，即配置的ip地址、ip地址范围或ip地址cidr的总数默认限制20。

ip_version

Integer
  • 功能说明：IP地址组ip版本。
  • 取值范围：
    • 4：表示ipv4地址组。
    • 6：表示ipv6地址组。

created_at

String
  • 功能说明：地址组创建时间，UTC时间。
  • 取值范围：UTC时间格式，yyyy-MM-ddTHH:mm:ss。

updated_at

String
  • 功能描述：地址组最近一次更新资源的时间，UTC时间。
  • 取值范围：UTC时间格式，yyyy-MM-ddTHH:mm:ss。

tenant_id

String
  • 功能说明：资源所属项目ID。

max_capacity

Integer
  • 功能说明：地址组最大条目数，限制地址组可以包含的地址数量 。
  • 取值范围：0-20
  • 默认值：20

enterprise_project_id

String
  • 功能说明：企业项目ID。
  • 取值范围：最大长度36字节，带“-”连字符的UUID格式，或者是字符串“0”。“0”表示默认企业项目。
  • 最大长度：36
  • 备注：该参数在华南-深圳、西南-贵阳一、华南-广州、亚太-新加坡、华东-上海一、华北-北京四区域上线。

tags

Array of ResourceTag objects

IP地址组资源标签。

status

String
  • 功能说明：地址组状态。
  • 取值范围（默认值：NORMAL ）：
    • NORMAL：正常
    • UPDATING：更新中
    • UPDATE_FAILED：更新失败
  • 约束：当地址组处于UPDATING（更新中）状态时，不允许再次更新

status_message

String
  • 功能说明：地址组状态详情信息。

ip_extra_set

Array of IpExtraSetRespOption objects
  • 功能说明：地址组包含的地址集及其备注信息。
表5 PageInfo

参数

参数类型

描述

previous_marker

String

当前页第一条记录

current_count

Integer

当前页总数

next_marker

String

当前页最后一条记录，最后一页时无next_marker字段
表6 ResourceTag

参数

参数类型

描述

key

String

功能说明：标签键 约束：同一资源的key值不能重复。

最小长度：1

最大长度：128

value

String

功能说明：标签值

最大长度：255
表7 IpExtraSetRespOption

参数

参数类型

描述

ip

String

功能说明：单个IP地址、IP地址范围或IP地址网段，支持IPv4、IPv6

remarks

String

功能说明：IP的备注信息

取值范围：0-255个字符，不能包含“<”和“>”。

响应示例

状态码为 200 时:

地址组创建API的GET查列表操作正常返回 
{
    "address_groups": [
        {
            "id": "dd18a501-fcd5-4adc-acfe-b0e2384baf08", 
            "name": "AutoTester746010.580123789", 
            "tenant_id": "b2782e6708b8475c993e6064bc456bf8", 
            "ip_version": 4, 
            "ip_set": [
                "192.168.5.0/24", 
                "192.168.3.20-192.168.3.100",  
                "192.168.3.40", 
                "192.168.3.2"
            ], 
            "ip_extra_set": [{
	        "ip": "192.168.5.0/24",
	        "remarks": null
	    },
	    {
                "ip": "192.168.3.20-192.168.3.100",
	        "remarks": null
	    },
	    {
	        "ip": "192.168.3.40",
	        "remarks": null
	    },
	    {
	        "ip": "192.168.3.2",
	        "remarks": null
	    }],
            "created_at": "2019-06-28T02:06:38", 
            "updated_at": "2019-06-28T02:06:38", 
            "description": "test",
            "enterprise_project_id": "0aad99bc-f5f6-4f78-8404-c598d76b0ed2",
            "tags": [],
            "max_capacity": 20,
            "status": "NORMAL",
            "status_message": ""
        }
    ], 
    "page_info": {
        "previous_marker": "dd18a501-fcd5-4adc-acfe-b0e2384baf08", 
        "current_count": 1
    }, 
    "request_id": "e51fa17c-3259-4122-afb1-9c03d4ef5408"
}

状态码

请参见状态码。

错误码

请参见错误码。

父主题： IP地址组
分享：

    相关文档

    相关产品