错误码
4.5 安全组
4.5.3 查询安全组列表
功能介绍
查询安全组列表。
调试
您可以在API Explorer中调试该接口。
URI
GET /v1/{project_id}/security-groups
样例:GET https://{Endpoint}/v1/{project_id}/security-groups?limit=10&marker=4779ab1c-7c1a-44b1-a02e-93dfc361b32d&vpc_id=3ec3b33f-ac1c-4630-ad1c-7dba1ed79d85
参数说明请参见表4-71。
表4-71 参数说明
名称 是否必选 参数类型 说明
project_id 是 String 项目ID,获取项目ID请参见A.5 获取项 目ID。
marker 否 String 分页查询的起始资源ID,表示从指定资 源的下一条记录开始查询。
marker需要和limit配合使用:
● 若不传入marker和limit参数,查询 结果返回全部资源记录。
● 若不传入marker参数,limit为10,
查询结果返回第1~10条资源记录。
● 若marker为第10条记录的资源ID,
limit为10,查询结果返回第11~20 条资源记录。
● 若marker为第10条记录的资源ID,
不传入limit参数,查询结果返回第 11条及之后的所有资源记录。
limit 否 Integer 分页查询每页返回的记录个数,取值范 围为0~intmax。
limit需要和marker配合使用,详细规 则请见marker的参数说明。
vpc_id 否 String 按照vpc_id过滤查询
名称 是否必选 参数类型 说明 enterprise_
project_id 否 String ● 功能说明:企业项目ID。可以使用 该字段过滤某个企业项目下的安全 组。
● 取值范围:最大长度36字节,带
“-”连字符的UUID格式,或者是 字符串“0”。“0”表示默认企业 项目。若需要查询当前用户所有企 业项目绑定的安全组,或者企业项 目子帐号需要进行安全组列表展 示,请传参all_granted_eps。
说明关于企业项目ID的获取及企业项目特性的详 细信息,请参见《企业管理用户指南》。
请求消息
● 请求参数 无
● 请求样例
GET https://{Endpoint}/v1/{project_id}/security-groups
响应消息
● 响应参数
表4-72 响应参数
名称 参数类型 说明
security_groups Array of security_grou p objects
安全组列表对象,请参见表4-73。
表4-73 security_group 字段说明
名称 参数类型 说明
name String 安全组名称
description String 安全组描述
id String 安全组唯一标识
vpc_id String 安全组所在的vpc的资源标识
说明
该参数已废弃,不建议继续使用。
名称 参数类型 说明 security_group_rules Array of
security_grou p_rule objects
默认安全组规则列表,保证安全 组内互通。
enterprise_project_id String ● 功能说明:企业项目ID。创建 安全组时,给安全组绑定企业 项目ID。
● 取值范围:最大长度36字节,
带“-”连字符的UUID格式,
或者是字符串“0”。“0”表 示默认企业项目。
说明关于企业项目ID的获取及企业项目特 性的详细信息,请参见《企业管理用 户指南》。
表4-74 security_group_rule 对象
名称 参数类型 说明
id String 安全组规则标识
description String ● 功能说明:安全组规则描述
● 取值范围:0-255个字符,支持 数字、字母、中文字符
security_group_id String 安全组标识
direction String ● 功能说明:出入控制方向
● 取值范围:
– egress:出方向 – ingress:入方向 ethertype String ● 功能说明:IP协议类型
● 取值范围:IPv4,IPv6 protocol String ● 功能说明:协议类型
● 取值范围:icmp、tcp、udp、
icmpv6等
● 约束:为空表示支持所有协议
名称 参数类型 说明
port_range_min Integer ● 功能说明:起始端口值
● 取值范围:1~65535
port_range_max Integer ● 功能说明:结束端口值
● 取值范围:1~65535
remote_ip_prefix String ● 功能说明:远端IP地址,当 direction是egress时为虚拟机 remote_group_id String ● 功能说明:对端安全组id
● 约束:和remote_ip_prefix互斥 tenant_id String ● 功能说明:安全组规则所属项
目ID
"vpc_id": "3ec3b33f-ac1c-4630-ad1c-7dba1ed79d85",
"enterprise_project_id ": "0aad99bc-f5f6-4f78-8404-c598d76b0ed2", "security_group_rules": [
"description": "",
"vpc_id": "13551d6b-755d-4757-b956-536f674975c0", "enterprise_project_id ": "0",