文档首页 > > API参考> API> 安全组> 查询安全组列表

查询安全组列表

分享
更新时间: 2019/11/22 GMT+08:00

功能介绍

查询安全组列表。

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
参数说明请参见 表1
表1 参数说明

名称

是否必选

参数类型

说明

project_id

String

项目ID

marker

String

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

limit

Integer

  • 功能说明:每页返回的个数
  • 取值范围:0~intmax

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

响应消息

  • 响应参数
    表2 响应参数

    名称

    参数类型

    说明

    security_groups

    Array of security_group objects

    安全组列表对象,请参见表3

    表3 security_group字段说明

    名称

    参数类型

    说明

    name

    String

    安全组名称

    description

    String

    安全组描述

    id

    String

    安全组唯一标识

    vpc_id

    String

    安全组所在的vpc的资源标识

    security_group_rules

    Array of security_group_rule objects

    默认安全组规则,保证安全组内互通。

    enterprise_project_id

    String

    • 功能说明:企业项目ID。创建安全组时,给安全组绑定企业项目ID。
    • 取值范围:最大长度36字节,带“-”连字符的UUID格式,或者是字符串“0”。“0”表示默认企业项目。
    说明:

    关于企业项目ID的获取及企业项目特性的详细信息,请参见《企业管理用户指南》

    表4 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等
    • 约束:为空表示支持所有协议

    port_range_min

    Integer

    port_range_max

    Integer

    • 功能说明:结束端口值
    • 取值范围:1~65535
    • 约束:协议不为icmp时,取值不能小于port_range_min的值,为空表示所有端口,如果协议是icmp类型,取值范围请参见安全组规则icmp协议名称对应关系表

    remote_ip_prefix

    String

    • 功能说明:远端IP地址,当direction是egress时为虚拟机访问端的地址,当direction是ingress时为访问虚拟机的地址
    • 取值范围:IP地址,或者cidr格式
    • 约束:和remote_group_id互斥

    remote_group_id

    String

    • 功能说明:对端安全组id
    • 约束:和remote_ip_prefix互斥
  • 响应样例
    {
        "security_groups": [
            {
                "id": "16b6e77a-08fa-42c7-aa8b-106c048884e6", 
                "name": "qq", 
                "description": "qq", 
                "vpc_id": "3ec3b33f-ac1c-4630-ad1c-7dba1ed79d85", 
                "enterprise_project_id ": "0aad99bc-f5f6-4f78-8404-c598d76b0ed2",
                "security_group_rules": [
                    {
                        "direction": "egress", 
                        "ethertype": "IPv4", 
                        "id": "369e6499-b2cb-4126-972a-97e589692c62", 
                        "description": "",
                        "security_group_id": "16b6e77a-08fa-42c7-aa8b-106c048884e6"
                    }, 
                    {
                        "direction": "ingress", 
                        "ethertype": "IPv4", 
                        "id": "0222556c-6556-40ad-8aac-9fd5d3c06171", 
                        "description": "",
                        "remote_group_id": "16b6e77a-08fa-42c7-aa8b-106c048884e6", 
                        "security_group_id": "16b6e77a-08fa-42c7-aa8b-106c048884e6"
                    }
                ]
            }, 
            {
                "id": "9c0f56be-a9ac-438c-8c57-fce62de19419", 
                "name": "default", 
                "description": "qq", 
                "vpc_id": "13551d6b-755d-4757-b956-536f674975c0", 
                "enterprise_project_id ": "0",
                "security_group_rules": [
                    {
                        "direction": "egress", 
                        "ethertype": "IPv4", 
                        "id": "95479e0a-e312-4844-b53d-a5e4541b783f", 
                        "description": "",
                        "security_group_id": "9c0f56be-a9ac-438c-8c57-fce62de19419"
                    }, 
                    {
                        "direction": "ingress", 
                        "ethertype": "IPv4", 
                        "id": "0c4a2336-b036-4fa2-bc3c-1a291ed4c431",
                        "description": "", 
                        "remote_group_id": "9c0f56be-a9ac-438c-8c57-fce62de19419", 
                        "security_group_id": "9c0f56be-a9ac-438c-8c57-fce62de19419"
                    }
                ]
            }
        ]
    }

状态码

请参见状态码

错误码

请参考错误码

分享:

    相关文档

    相关产品

文档是否有解决您的问题?

提交成功!

非常感谢您的反馈,我们会继续努力做到更好!

反馈提交失败,请稍后再试!

*必选

请至少选择或填写一项反馈信息

字符长度不能超过200

提交反馈 取消

如您有其它疑问,您也可以通过华为云社区问答频道来与我们联系探讨

跳转到云社区