文档首页> 虚拟私有云 VPC> API参考> API V3> 安全组> 查询安全组

更新时间：2024-04-29 GMT+08:00

查询安全组

功能介绍

查询单个安全组详情。

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

调试

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

URI

GET /v3/{project_id}/vpc/security-groups/{security_group_id}

表1 参数说明
参数	是否必选	参数类型	描述
project_id	是	String	项目ID。获取方法请参见获取项目ID。
security_group_id	是	String	安全组资源ID

请求参数

无

请求示例

查询安全组详情

"GET https://{Endpoint}/v3/{project_id}/vpc/security-groups/1d8b19c7-7c56-48f7-a99b-4b40eb390967"

响应参数

状态码为 200 时:

表2 响应Body参数
参数	参数类型	描述
request_id	String	请求ID
security_group	SecurityGroupInfo object	查询安全组详情响应体

表3 SecurityGroupInfo
参数	参数类型	描述
id	String	功能描述：安全组对应的唯一标识取值范围：带“-”的标准UUID格式
name	String	功能说明：安全组名称取值范围：1-64个字符，支持数字、字母、中文、_(下划线)、-（中划线）、.（点）
description	String	功能说明：安全组的描述信息取值范围：0-255个字符，不能包含“<”和“>”
project_id	String	功能说明：安全组所属的项目ID
created_at	String	功能说明：安全组创建时间取值范围：UTC时间格式，yyyy-MM-ddTHH:mm:ssZ
updated_at	String	功能说明：安全组更新时间取值范围：UTC时间格式，yyyy-MM-ddTHH:mm:ssZ
enterprise_project_id	String	功能说明：安全组所属的企业项目ID。取值范围：最大长度36字节，带“-”连字符的UUID格式，或者是字符串“0”。“0”表示默认企业项目。
security_group_rules	Array of SecurityGroupRule objects	安全组规则

表4 SecurityGroupRule
参数	参数类型	描述
id	String	功能描述：安全组规则对应的唯一标识取值范围：带“-”的标准UUID格式
description	String	功能说明：安全组规则的描述信息取值范围：0-255个字符，不能包含“<”和“>”
security_group_id	String	功能说明：安全组规则所属的安全组ID
direction	String	功能说明：安全组规则的出入控制方向取值范围： ingress 表示入方向 egress 表示出方向
protocol	String	功能说明：协议类型取值范围：icmp、tcp、udp、icmpv6或IP协议号约束：为空表示支持所有协议。协议为icmpv6时，网络类型应该为IPv6；协议为icmp时，网络类型应该为IPv4
ethertype	String	功能说明：IP地址协议类型取值范围：IPv4，IPv6 约束：不填默认值为IPv4
multiport	String	功能说明：端口取值范围取值范围：支持和单端口(80)，连续端口(1-30)以及不连续端口(22,3389,80)
action	String	功能说明：安全组规则生效策略取值范围： allow表示允许 deny表示拒绝约束：默认值为deny
priority	Integer	功能说明：优先级取值范围：1~100，1代表最高优先级
remote_group_id	String	功能说明：远端安全组ID，表示该安全组内的流量允许或拒绝取值范围：租户下存在的安全组ID 约束：与remote_ip_prefix，remote_address_group_id功能互斥
remote_ip_prefix	String	功能说明：远端IP地址，当direction是egress时，为虚拟机访问端的地址当direction是ingress时，为访问虚拟机的地址取值范围：IP地址，或者cidr格式约束：与remote_group_id、remote_address_group_id互斥
remote_address_group_id	String	功能说明：远端地址组ID 取值范围：租户下存在的地址组ID 约束：与remote_ip_prefix，remote_group_id功能互斥
created_at	String	功能说明：安全组规则创建时间取值范围：UTC时间格式，yyyy-MM-ddTHH:mm:ssZ
updated_at	String	功能说明：安全组规则更新时间取值范围：UTC时间格式，yyyy-MM-ddTHH:mm:ssZ
project_id	String	功能说明：安全组规则所属项目ID

状态码为 401 时:

表5 响应Body参数
参数	参数类型	描述
request_id	String	请求ID
error_msg	String	错误消息
error_code	String	错误码

状态码为 403 时:

表6 响应Body参数
参数	参数类型	描述
request_id	String	请求ID
error_msg	String	错误消息
error_code	String	错误码

状态码为 404 时:

表7 响应Body参数
参数	参数类型	描述
request_id	String	请求ID
error_msg	String	错误消息
error_code	String	错误码

状态码为 500 时:

表8 响应Body参数
参数	参数类型	描述
request_id	String	请求ID
error_msg	String	错误消息
error_code	String	错误码

响应示例

状态码为 200 时:

{
    "security_group": {
        "id": "69c999ad-d9ef-4d79-94fd-35e6ceb75325", 
        "name": "security_group_1", 
        "project_id": "060576782980d5762f9ec014dd2f1148", 
        "description": "security group description", 
        "enterprise_project_id": "0", 
        "security_group_rules": [
            {
                "id": "f11a3824-ac19-4fad-b4f1-c5f4a6dd0a80", 
                "project_id": "060576782980d5762f9ec014dd2f1148", 
                "security_group_id": "69c999ad-d9ef-4d79-94fd-35e6ceb75325", 
                "remote_group_id": "69c999ad-d9ef-4d79-94fd-35e6ceb75325", 
                "direction": "ingress", 
                "protocol": null, 
                "description": "", 
                "created_at": "2020-07-09T05:56:27Z", 
                "updated_at": "2020-07-09T05:56:27Z", 
                "ethertype": "IPv6", 
                "remote_ip_prefix": null, 
                "multiport": null, 
                "remote_address_group_id": null, 
                "action": "allow", 
                "priority": 100
            }, 
            {
                "id": "3d6480e8-9ea4-46dc-bb1b-8db190cd5677", 
                "project_id": "060576782980d5762f9ec014dd2f1148", 
                "security_group_id": "69c999ad-d9ef-4d79-94fd-35e6ceb75325", 
                "remote_group_id": null, 
                "direction": "egress", 
                "protocol": null, 
                "description": "", 
                "created_at": "2020-07-09T05:56:27Z", 
                "updated_at": "2020-07-09T05:56:27Z", 
                "ethertype": "IPv6", 
                "remote_ip_prefix": null,  
                "multiport": null, 
                "remote_address_group_id": null, 
                "action": "allow", 
                "priority": 100
            }, 
            {
                "id": "9581f18c-1fdd-43da-ace9-7758a56ef28a", 
                "project_id": "060576782980d5762f9ec014dd2f1148", 
                "security_group_id": "69c999ad-d9ef-4d79-94fd-35e6ceb75325", 
                "remote_group_id": null, 
                "direction": "egress", 
                "protocol": null, 
                "description": "", 
                "created_at": "2020-07-09T05:56:27Z", 
                "updated_at": "2020-07-09T05:56:27Z", 
                "ethertype": "IPv4", 
                "remote_ip_prefix": null, 
                "multiport": null, 
                "remote_address_group_id": null, 
                "action": "allow", 
                "priority": 100
            }, 
            {
                "id": "a3ba270e-e58b-432d-a912-aeb7eace9fb8", 
                "project_id": "060576782980d5762f9ec014dd2f1148", 
                "security_group_id": "69c999ad-d9ef-4d79-94fd-35e6ceb75325", 
                "remote_group_id": "69c999ad-d9ef-4d79-94fd-35e6ceb75325", 
                "direction": "ingress", 
                "protocol": null, 
                "description": "", 
                "created_at": "2020-07-09T05:56:27Z", 
                "updated_at": "2020-07-09T05:56:27Z", 
                "ethertype": "IPv4", 
                "remote_ip_prefix": null,  
                "multiport": null, 
                "remote_address_group_id": null, 
                "action": "allow", 
                "priority": 100
            }
        ], 
        "created_at": "2020-07-09T05:56:27Z", 
        "updated_at": "2020-07-09T05:56:27Z"
    }, 
    "request_id": "a8cf4f79ca3c22ca685e7e8872e8c20b"
}

状态码

请参见状态码。

错误码

请参见错误码。

父主题： 安全组

上一篇：查询安全组列表

下一篇：更新安全组

意见反馈

文档内容是否对您有帮助？

有帮助没帮助

提供反馈

提交成功！非常感谢您的反馈，我们会继续努力做到更好！您可在我的云声建议查看反馈及问题处理状态。

系统繁忙，请稍后重试

在使用文档中是否遇到以下问题

内容与产品页面不一致

内容不易理解

缺失示例代码

步骤不可操作

搜不到想要的内容

缺少最佳实践

意见反馈（选填）

0/500

请至少选择一项反馈信息并填写问题反馈

字符长度不能超过500

直接提交取消

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

智能客服提问云社区提问

查询安全组

功能介绍

调试

URI

请求参数

请求示例

响应参数

响应示例

状态码

错误码

相关文档

相关产品

意见反馈

文档内容是否对您有帮助？

7*24

备案

专业服务

退订

建议反馈

售前咨询热线