华为云计算 云知识 查询安全组ShowSecurityGroup
查询安全组ShowSecurityGroup

 

功能介绍

查询单个安全组。

调试

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

URI

GET /v1/{project_id}/security-groups/{security_group_id}

参数说明请参见表1。
表1 参数说明

名称

是否必选

说明

project_id

项目ID,获取项目ID请参见获取项目ID

security_group_id

安全组唯一标识

请求参数

请求示例

GET https://{Endpoint}/v1/{project_id}/security-groups/16b6e77a-08fa-42c7-aa8b-106c048884e6

响应参数

表2 响应参数

名称

参数类型

说明

security_group

security_group object

安全组对象

表3 security_group字段说明

名称

参数类型

说明

name

String

安全组名称

description

String

安全组描述

id

String

安全组唯一标识

vpc_id

String

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

说明:

该参数功能已废弃,不建议继续使用。

当前该参数只作提示用,不约束安全组在此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、icmpv6等
  • 约束:为空表示支持所有协议

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_address_group_id互斥

remote_group_id

String

  • 功能说明:对端安全组id
  • 约束:和remote_ip_prefix,remote_address_group_id互斥

remote_address_group_id

String

  • 功能说明:远端IP地址组ID
  • 约束:和remote_ip_prefix,remote_group_id互斥

tenant_id

String

  • 功能说明:安全组规则所属项目ID

响应示例

{
    "security_group": {
        "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",
                "remote_address_group_id": null
            }, 
            {
                "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"
            }
        ]
    }
}

状态码

请参见状态码

错误码

请参考错误码

 

上一篇:获取云硬盘资源的所有标签ListVolumeTags 下一篇:弹性云服务器ECS切换操作系统操作指导与注意事项

虚拟私有云 VPC

虚拟私有云(Virtual Private Cloud)是用户在华为云上申请的隔离的、私密的虚拟网络环境。用户可以自由配置VPC内的IP地址段、子网、安全组等子服务,也可以申请弹性带宽和弹性IP搭建业务系统