计算
弹性云服务器 ECS
Flexus云服务
裸金属服务器 BMS
弹性伸缩 AS
镜像服务 IMS
专属主机 DeH
函数工作流 FunctionGraph
云手机服务器 CPH
Huawei Cloud EulerOS
网络
虚拟私有云 VPC
弹性公网IP EIP
虚拟专用网络 VPN
弹性负载均衡 ELB
NAT网关 NAT
云专线 DC
VPC终端节点 VPCEP
云连接 CC
企业路由器 ER
企业交换机 ESW
全球加速 GA
安全与合规
安全技术与应用
Web应用防火墙 WAF
企业主机安全 HSS
云防火墙 CFW
安全云脑 SecMaster
DDoS防护 AAD
数据加密服务 DEW
数据库安全服务 DBSS
云堡垒机 CBH
数据安全中心 DSC
云证书管理服务 CCM
边缘安全 EdgeSec
威胁检测服务 MTD
CDN与智能边缘
内容分发网络 CDN
CloudPond云服务
智能边缘云 IEC
迁移
主机迁移服务 SMS
对象存储迁移服务 OMS
云数据迁移 CDM
迁移中心 MGC
大数据
MapReduce服务 MRS
数据湖探索 DLI
表格存储服务 CloudTable
云搜索服务 CSS
数据接入服务 DIS
数据仓库服务 GaussDB(DWS)
数据治理中心 DataArts Studio
数据可视化 DLV
数据湖工厂 DLF
湖仓构建 LakeFormation
企业应用
云桌面 Workspace
应用与数据集成平台 ROMA Connect
云解析服务 DNS
专属云
专属计算集群 DCC
IoT物联网
IoT物联网
设备接入 IoTDA
智能边缘平台 IEF
用户服务
账号中心
费用中心
成本中心
资源中心
企业管理
工单管理
国际站常见问题
ICP备案
我的凭证
支持计划
客户运营能力
合作伙伴支持计划
专业服务
区块链
区块链服务 BCS
Web3节点引擎服务 NES
解决方案
SAP
高性能计算 HPC
视频
视频直播 Live
视频点播 VOD
媒体处理 MPC
实时音视频 SparkRTC
数字内容生产线 MetaStudio
存储
对象存储服务 OBS
云硬盘 EVS
云备份 CBR
存储容灾服务 SDRS
高性能弹性文件服务 SFS Turbo
弹性文件服务 SFS
云硬盘备份 VBS
云服务器备份 CSBS
数据快递服务 DES
专属分布式存储服务 DSS
容器
云容器引擎 CCE
容器镜像服务 SWR
应用服务网格 ASM
华为云UCS
云容器实例 CCI
管理与监管
云监控服务 CES
统一身份认证服务 IAM
资源编排服务 RFS
云审计服务 CTS
标签管理服务 TMS
云日志服务 LTS
配置审计 Config
资源访问管理 RAM
消息通知服务 SMN
应用运维管理 AOM
应用性能管理 APM
组织 Organizations
优化顾问 OA
IAM 身份中心
云运维中心 COC
资源治理中心 RGC
应用身份管理服务 OneAccess
数据库
云数据库 RDS
文档数据库服务 DDS
数据管理服务 DAS
数据复制服务 DRS
云数据库 GeminiDB
云数据库 GaussDB
分布式数据库中间件 DDM
数据库和应用迁移 UGO
云数据库 TaurusDB
人工智能
人脸识别服务 FRS
图引擎服务 GES
图像识别 Image
内容审核 Moderation
文字识别 OCR
AI开发平台ModelArts
图像搜索 ImageSearch
对话机器人服务 CBS
华为HiLens
视频智能分析服务 VIAS
语音交互服务 SIS
应用中间件
分布式缓存服务 DCS
API网关 APIG
微服务引擎 CSE
分布式消息服务Kafka版
分布式消息服务RabbitMQ版
分布式消息服务RocketMQ版
多活高可用服务 MAS
事件网格 EG
企业协同
华为云会议 Meeting
云通信
消息&短信 MSGSMS
云生态
合作伙伴中心
云商店
开发者工具
SDK开发指南
API签名指南
Terraform
华为云命令行工具服务 KooCLI
其他
产品价格详情
系统权限
管理控制台
客户关联华为云合作伙伴须知
消息中心
公共问题
开发与运维
应用管理与运维平台 ServiceStage
软件开发生产线 CodeArts
需求管理 CodeArts Req
部署 CodeArts Deploy
性能测试 CodeArts PerfTest
编译构建 CodeArts Build
流水线 CodeArts Pipeline
制品仓库 CodeArts Artifact
测试计划 CodeArts TestPlan
代码检查 CodeArts Check
代码托管 CodeArts Repo
云应用引擎 CAE
开天aPaaS
云消息服务 KooMessage
云手机服务 KooPhone
云空间服务 KooDrive

查询地址组列表

更新时间:2025-01-07 GMT+08:00

功能介绍

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

调试

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

URI

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

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

项目ID。

获取方式请参见获取项目ID

表2 Query参数

参数

是否必选

参数类型

描述

limit

Integer

  • 功能说明:每页返回的个数。

  • 取值范围:0~2000。

marker

String

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

id

Array of strings

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

name

Array of strings

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

ip_version

Integer

  • 功能说明:IP地址组ip版本,填写后按照ip版本进行过滤。

  • 取值范围:4、6。

description

Array of strings

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

enterprise_project_id

String

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

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

最大长度:36

请求参数

响应参数

状态码: 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个字符。

  • 约束:不能包含“<”和“>”。

max_capacity

Integer

  • 功能说明:地址组最大条目数,限制地址组可以包含的地址数量。

  • 取值范围:0-20。

  • 默认值:20。

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。

enterprise_project_id

String

  • 功能说明:企业项目ID。

  • 取值范围:最大长度36字节,带“-”连字符的UUID格式,或者是字符串“0”。“0”表示默认企业项目。

最大长度:36

tags

Array of ResourceTag objects

  • 功能说明:IP地址组资源标签。

status

String

  • 功能说明:地址组状态。

  • 取值范围:

    • NORMAL:正常

    • UPDATING:更新中

    • UPDATE_FAILED:更新失败

  • 默认值:NORMAL

  • 约束:当地址组处于UPDATING(更新中)状态时,不允许再次更新。

status_message

String

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

ip_extra_set

Array of IpExtraSetRespOption objects

  • 功能说明:地址组包含的地址集及其备注信息。

表5 ResourceTag

参数

参数类型

描述

key

String

  • 功能说明:标签键。

  • 约束:同一资源的key值不能重复。

最小长度:1

最大长度:128

value

String

  • 功能说明:标签值。

最大长度:255

表6 IpExtraSetRespOption

参数

参数类型

描述

ip

String

  • 功能说明:单个IP地址、IP地址范围或ip地址网段,支持IPv4、IPv6。

remarks

String

  • 功能说明:IP的备注信息。

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

表7 PageInfo

参数

参数类型

描述

previous_marker

String

当前页第一条记录。

current_count

Integer

当前页总数。

next_marker

String

当前页最后一条记录,最后一页时无next_marker字段。

请求示例

组合过滤条件查询地址组列表。

GET https://{{endpoint}}/v3/b2782e6708b8475c993e6064bc456bf8/vpc/address-groups?name=vkvgykvsvhjaaaa1&description=xxxxxxxxxx&ip_version=4

响应示例

状态码: 200

GET操作正常返回,更多状态码请参见状态码

  • {
      "address_groups" : [ {
        "id" : "dd18a501-fcd5-4adc-acfe-b0e2384baf08",
        "name" : "AutoTester746010.580123789",
        "tenant_id" : "b2782e6708b8475c993e6064bc456bf8",
        "ip_version" : 4,
        "max_capacity" : 20,
        "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
        } ],
        "enterprise_project_id" : "0aad99bc-f5f6-4f78-8404-c598d76b0ed2",
        "created_at" : "2019-06-28T02:06:38.000+00:00",
        "updated_at" : "2019-06-28T02:06:38.000+00:00",
        "description" : "test",
        "status" : "NORMAL",
        "status_message" : ""
      } ],
      "page_info" : {
        "previous_marker" : "dd18a501-fcd5-4adc-acfe-b0e2384baf08",
        "current_count" : 1
      },
      "request_id" : "e51fa17c-3259-4122-afb1-9c03d4ef5408"
    }

状态码

状态码

描述

200

GET操作正常返回,更多状态码请参见状态码

错误码

请参见错误码

我们使用cookie来确保您的高速浏览体验。继续浏览本站,即表示您同意我们使用cookie。 详情

文档反馈

文档反馈

意见反馈

0/500

标记内容

同时提交标记内容