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

查询安全组列表

功能介绍

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

接口约束

查询提交请求的租户有权限查看的所有安全组信息,单次查询最多返回2000条数据,超过2000后会返回分页标记。

调用方法

请参见如何调用API

URI

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

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

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

  • 取值范围:无

表2 Query参数

参数

是否必选

参数类型

描述

limit

Integer

  • 参数解释:每页返回的资源个数。

  • 取值范围:0-2000。

marker

String

  • 参数解释:分页查询起始的资源ID,为空时查询第一页。

  • 取值范围:安全组资源ID。

id

Array of strings

  • 参数解释:安全组的资源ID。可以使用该字段精确过滤安全组,支持传入多个ID过滤。

  • 取值范围:无

name

Array of strings

  • 参数解释:安全组的名称。可以使用该字段精确过滤满足条件的安全组,支持传入多个name过滤。

  • 取值范围:无

description

Array of strings

  • 参数解释:安全组的描述。可以使用该字段精确过滤安全组,支持传入多个描述进行过滤。

  • 取值范围:无

enterprise_project_id

String

  • 参数解释:安全组所属的企业项目ID。可以使用该字段过滤企业项目下的安全组。

  • 取值范围:

    • 最大长度36字节,带“-”连字符的UUID格式,或者是字符串“0”。“0”表示默认企业项目。

    • 若需要查询当前用户所有有权限查看企业项目绑定的安全组,请传参all_granted_eps。

请求参数

响应参数

状态码:200

表3 响应Body参数

参数

参数类型

描述

security_groups

Array of SecurityGroup objects

  • 参数解释:查询安全组列表响应体。

  • 取值范围:无

request_id

String

  • 参数解释:请求ID。

  • 取值范围:无

page_info

PageInfo object

  • 参数解释:分页信息。

  • 取值范围:无

表4 SecurityGroup

参数

参数类型

描述

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对象。

  • 取值范围:无

表5 ResponseTag

参数

参数类型

描述

key

String

参数解释

标签键。

取值范围

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

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

  • 可以包含的字符范围:

    • 英文字母

    • 数字

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

    • 中文字符

value

String

参数解释

标签值。

取值范围

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

  • 可以包含的字符范围:

    • 英文字母

    • 数字

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

    • 中文字符

表6 PageInfo

参数

参数类型

描述

previous_marker

String

参数解释

当前页的第一条记录。

取值范围

不涉及。

current_count

Integer

参数解释

当前页的资源总数。

取值范围

不涉及。

next_marker

String

参数解释

当前页的最后一条记录,最后一页时无next_marker字段。

取值范围

不涉及。

请求示例

查询安全组列表。

GET https://{Endpoint}/v3/{project_id}/vpc/security-groups

响应示例

状态码:200

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

{
  "request_id" : "d31cb32ca06f3c1a294fa24e6cbc5a56",
  "security_groups" : [ {
    "id" : "0552091e-b83a-49dd-88a7-4a5c86fd9ec3",
    "name" : "sg-test",
    "project_id" : "060576782980d5762f9ec014dd2f1148",
    "description" : "test",
    "enterprise_project_id" : 0,
    "created_at" : "2019-10-16T11:11:14.000+00:00",
    "updated_at" : "2020-03-25T10:53:46.000+00:00",
    "tags" : [ ]
  }, {
    "id" : "0b8cb773-197c-4c91-94f1-e051f0563e5a",
    "name" : "test-sg",
    "project_id" : "060576782980d5762f9ec014dd2f1148",
    "description" : "通用Web服务器,默认放通22、3389、80、443端口和ICMP协议。适用于需要远程登录、公网ping及用于网站服务的云服务器场景。",
    "enterprise_project_id" : 0,
    "created_at" : "2019-12-03T09:02:11.000+00:00",
    "updated_at" : "2019-12-03T09:02:11.000+00:00",
    "tags" : [ ]
  } ],
  "page_info" : {
    "previous_marker" : "0552091e-b83a-49dd-88a7-4a5c86fd9ec3",
    "current_count" : 2
  }
}

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
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 ListSecurityGroupsSolution {

    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();
        ListSecurityGroupsRequest request = new ListSecurityGroupsRequest();
        try {
            ListSecurityGroupsResponse response = client.listSecurityGroups(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
# 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 = ListSecurityGroupsRequest()
        response = client.list_security_groups(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
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.ListSecurityGroupsRequest{}
	response, err := client.ListSecurityGroups(request)
	if err == nil {
        fmt.Printf("%+v\n", response)
    } else {
        fmt.Println(err)
    }
}

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

状态码

状态码

描述

200

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

错误码

请参见错误码