更新时间:2025-08-19 GMT+08:00

查询安全组

功能介绍

当您的安全组创建成功后,您可以通过调用该接口查询单个安全组的详细信息,包括安全组名称、ID、描述等。

调用方法

请参见如何调用API

URI

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

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

  • 参数解释:安全组所属的项目ID。获取方式请参见获取项目ID

  • 取值范围:无

security_group_id

String

  • 参数解释:安全组资源ID。

  • 取值范围:无

请求参数

响应参数

状态码:200

表2 响应Body参数

参数

参数类型

描述

request_id

String

  • 参数解释:请求ID。

  • 取值范围:无

security_group

SecurityGroupInfo object

  • 参数解释:查询安全组详情响应体。

  • 取值范围:无

表3 SecurityGroupInfo

参数

参数类型

描述

id

String

  • 参数解释:安全组资源ID。安全组创建成功后,会生成一个安全组 ID,是安全组对应的唯一标识。

  • 取值范围:带“-”的标准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”表示默认企业项目。

tags

Array of ResponseTag objects

  • 参数解释:安全组的标签信息,包括标签键和标签值,可用来分类和标识资源。详情请参见Tag对象。

  • 取值范围:无

security_group_rules

Array of SecurityGroupRule objects

  • 参数解释:安全组规则列表。

  • 取值范围:无

表4 ResponseTag

参数

参数类型

描述

key

String

参数解释

标签键。

取值范围

  • 最大长度128个unicode字符, key不能为空。

  • 同一资源的key不能重复。

  • 可以包含的字符范围:

    • 英文字母

    • 数字

    • 特殊字符:下划线(_)、中划线(-)

    • 中文字符

value

String

参数解释

标签值。

取值范围

  • 每个值最大长度255个unicode字符,value可以为空。

  • 可以包含的字符范围:

    • 英文字母

    • 数字

    • 特殊字符:下划线(_)、中划线(-)、点(.)

    • 中文字符

表5 SecurityGroupRule

参数

参数类型

描述

id

String

  • 参数解释:安全组规则的资源ID。安全组规则创建成功后,会生成一个安全组规则ID,是安全组规则对应的唯一标识。

  • 取值范围:带“-”的标准UUID格式。

description

String

  • 参数解释:安全组规则的描述信息。

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

security_group_id

String

  • 参数解释:安全组规则所属的安全组ID。

  • 取值范围:无

direction

String

  • 参数解释:安全组规则的出入控制方向。

  • 取值范围:

    • ingress:表示入方向。

    • egress:表示出方向。

protocol

String

  • 参数解释:安全组规则的通信协议类型。

  • 取值范围:

    • icmp

    • tcp

    • udp

    • icmpv6

    • IP协议号

ethertype

String

  • 参数解释:安全组规则的IP地址协议类型。

  • 取值范围:

    • IPv4

    • IPv6

multiport

String

  • 参数解释:安全组规则的端口取值范围。

  • 取值范围:支持单端口(80),连续端口(1-30)以及不连续端口(22,3389,80)。

action

String

  • 参数解释:安全组规则的生效策略。

  • 取值范围:

    • allow:表示允许。

    • deny:表示拒绝。

priority

Integer

  • 参数解释:安全组规则的生效优先级。

  • 取值范围:1~100,1代表最高优先级。

remote_group_id

String

  • 参数解释:安全组规则的远端安全组ID,如果规则的action是allow,表示允许该安全组内的流量;如果规则的action是deny,表示拒绝该安全组内的流量。

  • 取值范围:租户下存在的安全组ID。

remote_ip_prefix

String

  • 参数解释:安全组规则的远端IP地址。

    • 当direction是egress时,该地址表示出方向的目的地址,为安全组内实例访问的远端地址。

    • 当direction是ingress时,该地址表示入方向的源地址,为访问安全组内实例的远端地址。

  • 取值范围:cidr格式,请求如果传入IP地址,会自动转换为末尾带/32的格式,如192.168.21.45/32。

remote_address_group_id

String

  • 参数解释:安全组规则的远端地址组ID。

  • 取值范围:租户下存在的地址组ID。

created_at

String

  • 参数解释:安全组规则的创建时间。

  • 取值范围:UTC时间格式,yyyy-MM-ddTHH:mm:ssZ。

updated_at

String

  • 参数解释:安全组规则的更新时间。

  • 取值范围:UTC时间格式,yyyy-MM-ddTHH:mm:ssZ。

project_id

String

  • 参数解释:安全组规则所属项目ID。

  • 取值范围:无

enabled

Boolean

  • 参数解释:是否启用安全组规则。

  • 取值范围:

    • true:表示启用此安全组规则。

    • false:表示停用此安全组规则。

请求示例

查询安全组详情。

GET https://{Endpoint}/v3/{project_id}/vpc/security-groups/69c999ad-d9ef-4d79-94fd-35e6ceb75325

响应示例

状态码:200

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

  • {
      "security_group" : {
        "id" : "69c999ad-d9ef-4d79-94fd-35e6ceb75325",
        "name" : "security_group_1",
        "project_id" : "060576782980d5762f9ec014dd2f1148",
        "description" : "security group description",
        "enterprise_project_id" : 0,
        "tags" : [ {
          "key" : "a",
          "value" : "b"
        } ],
        "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",
          "description" : "",
          "created_at" : "2020-07-09T05:56:27.000+00:00",
          "updated_at" : "2020-07-09T05:56:27.000+00:00",
          "ethertype" : "IPv6",
          "action" : "allow",
          "priority" : 100,
          "protocol" : null,
          "multiport" : null,
          "remote_ip_prefix" : null,
          "remote_address_group_id" : null,
          "enabled" : true
        }, {
          "id" : "3d6480e8-9ea4-46dc-bb1b-8db190cd5677",
          "project_id" : "060576782980d5762f9ec014dd2f1148",
          "security_group_id" : "69c999ad-d9ef-4d79-94fd-35e6ceb75325",
          "direction" : "egress",
          "description" : "",
          "created_at" : "2020-07-09T05:56:27.000+00:00",
          "updated_at" : "2020-07-09T05:56:27.000+00:00",
          "ethertype" : "IPv6",
          "action" : "allow",
          "priority" : 100,
          "protocol" : null,
          "multiport" : null,
          "remote_ip_prefix" : null,
          "remote_group_id" : null,
          "remote_address_group_id" : null,
          "enabled" : true
        }, {
          "id" : "9581f18c-1fdd-43da-ace9-7758a56ef28a",
          "project_id" : "060576782980d5762f9ec014dd2f1148",
          "security_group_id" : "69c999ad-d9ef-4d79-94fd-35e6ceb75325",
          "direction" : "egress",
          "description" : "",
          "created_at" : "2020-07-09T05:56:27.000+00:00",
          "updated_at" : "2020-07-09T05:56:27.000+00:00",
          "ethertype" : "IPv4",
          "action" : "allow",
          "priority" : 100,
          "protocol" : null,
          "multiport" : null,
          "remote_ip_prefix" : null,
          "remote_group_id" : null,
          "remote_address_group_id" : null,
          "enabled" : true
        }, {
          "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",
          "description" : "",
          "created_at" : "2020-07-09T05:56:27.000+00:00",
          "updated_at" : "2020-07-09T05:56:27.000+00:00",
          "ethertype" : "IPv4",
          "action" : "allow",
          "priority" : 100,
          "protocol" : null,
          "multiport" : null,
          "remote_ip_prefix" : null,
          "remote_address_group_id" : null,
          "enabled" : true
        } ],
        "created_at" : "2020-07-09T05:56:27.000+00:00",
        "updated_at" : "2020-07-09T05:56:27.000+00:00"
      },
      "request_id" : "a8cf4f79ca3c22ca685e7e8872e8c20b"
    }

SDK代码示例

SDK代码示例如下。

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
package com.huaweicloud.sdk.test;

import com.huaweicloud.sdk.core.auth.ICredential;
import com.huaweicloud.sdk.core.auth.BasicCredentials;
import com.huaweicloud.sdk.core.exception.ConnectionException;
import com.huaweicloud.sdk.core.exception.RequestTimeoutException;
import com.huaweicloud.sdk.core.exception.ServiceResponseException;
import com.huaweicloud.sdk.vpc.v3.region.VpcRegion;
import com.huaweicloud.sdk.vpc.v3.*;
import com.huaweicloud.sdk.vpc.v3.model.*;


public class ShowSecurityGroupSolution {

    public static void main(String[] args) {
        // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security.
        // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment
        String ak = System.getenv("CLOUD_SDK_AK");
        String sk = System.getenv("CLOUD_SDK_SK");
        String projectId = "{project_id}";

        ICredential auth = new BasicCredentials()
                .withProjectId(projectId)
                .withAk(ak)
                .withSk(sk);

        VpcClient client = VpcClient.newBuilder()
                .withCredential(auth)
                .withRegion(VpcRegion.valueOf("<YOUR REGION>"))
                .build();
        ShowSecurityGroupRequest request = new ShowSecurityGroupRequest();
        request.withSecurityGroupId("{security_group_id}");
        try {
            ShowSecurityGroupResponse response = client.showSecurityGroup(request);
            System.out.println(response.toString());
        } catch (ConnectionException e) {
            e.printStackTrace();
        } catch (RequestTimeoutException e) {
            e.printStackTrace();
        } catch (ServiceResponseException e) {
            e.printStackTrace();
            System.out.println(e.getHttpStatusCode());
            System.out.println(e.getRequestId());
            System.out.println(e.getErrorCode());
            System.out.println(e.getErrorMsg());
        }
    }
}
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
# coding: utf-8

import os
from huaweicloudsdkcore.auth.credentials import BasicCredentials
from huaweicloudsdkvpc.v3.region.vpc_region import VpcRegion
from huaweicloudsdkcore.exceptions import exceptions
from huaweicloudsdkvpc.v3 import *

if __name__ == "__main__":
    # The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security.
    # In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment
    ak = os.environ["CLOUD_SDK_AK"]
    sk = os.environ["CLOUD_SDK_SK"]
    projectId = "{project_id}"

    credentials = BasicCredentials(ak, sk, projectId)

    client = VpcClient.new_builder() \
        .with_credentials(credentials) \
        .with_region(VpcRegion.value_of("<YOUR REGION>")) \
        .build()

    try:
        request = ShowSecurityGroupRequest()
        request.security_group_id = "{security_group_id}"
        response = client.show_security_group(request)
        print(response)
    except exceptions.ClientRequestException as e:
        print(e.status_code)
        print(e.request_id)
        print(e.error_code)
        print(e.error_msg)
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
package main

import (
	"fmt"
	"github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/basic"
    vpc "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/vpc/v3"
	"github.com/huaweicloud/huaweicloud-sdk-go-v3/services/vpc/v3/model"
    region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/vpc/v3/region"
)

func main() {
    // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security.
    // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment
    ak := os.Getenv("CLOUD_SDK_AK")
    sk := os.Getenv("CLOUD_SDK_SK")
    projectId := "{project_id}"

    auth := basic.NewCredentialsBuilder().
        WithAk(ak).
        WithSk(sk).
        WithProjectId(projectId).
        Build()

    client := vpc.NewVpcClient(
        vpc.VpcClientBuilder().
            WithRegion(region.ValueOf("<YOUR REGION>")).
            WithCredential(auth).
            Build())

    request := &model.ShowSecurityGroupRequest{}
	request.SecurityGroupId = "{security_group_id}"
	response, err := client.ShowSecurityGroup(request)
	if err == nil {
        fmt.Printf("%+v\n", response)
    } else {
        fmt.Println(err)
    }
}

更多编程语言的SDK代码示例,请参见API Explorer的代码示例页签,可生成自动对应的SDK代码示例。

状态码

状态码

描述

200

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

错误码

请参见错误码