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

查询安全组规则列表

功能介绍

当您的安全组规则创建成功后,您可以通过调用该接口查询所有安全组规则信息,包括安全组规则ID、协议类型等。

调用方法

请参见如何调用API

URI

GET /v3/{project_id}/vpc/security-group-rules

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

  • 参数解释:项目ID。获取方式请参见获取项目ID

  • 取值范围:无

表2 Query参数

参数

是否必选

参数类型

描述

limit

Integer

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

  • 取值范围:0-2000。

marker

String

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

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

id

Array of strings

  • 参数解释:安全组规则的资源ID,支持多个ID过滤。

  • 取值范围:无

security_group_id

Array of strings

  • 参数解释:安全组规则所属安全组的ID,支持多个ID过滤。

  • 取值范围:无

protocol

Array of strings

  • 参数解释:安全组规则的通信协议类型,支持多条过滤。

  • 取值范围:无

description

Array of strings

  • 参数解释:安全组规则的描述信息,支持传入多个描述进行过滤。

  • 取值范围:无

remote_group_id

Array of strings

  • 参数解释:安全组规则的远端安全组ID,支持多ID过滤。

  • 取值范围:无

direction

String

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

  • 取值范围:

    • ingress:表示入方向。

    • egress:表示出方向。

action

String

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

  • 取值范围:

    • allow:表示允许。

    • deny:表示拒绝。

remote_ip_prefix

String

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

  • 取值范围:cidr格式。

enabled

Boolean

  • 参数解释:是否启用安全组规则,不支持多值过滤。

  • 取值范围:

    • true:表示过滤出启用的安全组规则。

    • false:表示过滤出停用的安全组规则。

priority

Array of integers

  • 参数解释:安全组规则的生效优先级,支持多条过滤。

  • 取值范围:无

ethertype

Array of strings

  • 参数解释:安全组规则的IP协议类型,支持多条过滤。

  • 取值范围:IPv4,IPv6,ipv4,ipv6

remote_address_group_id

Array of strings

  • 参数解释:安全组规则的远端IP地址组ID,支持多ID过滤。

  • 取值范围:无

请求参数

响应参数

状态码:200

表3 响应Body参数

参数

参数类型

描述

request_id

String

  • 参数解释:请求ID。

  • 取值范围:无

security_group_rules

Array of SecurityGroupRule objects

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

  • 取值范围:无

page_info

PageInfo object

  • 参数解释:分页信息。

  • 取值范围:无

表4 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:表示停用此安全组规则。

表5 PageInfo

参数

参数类型

描述

previous_marker

String

参数解释

当前页的第一条记录。

取值范围

不涉及。

current_count

Integer

参数解释

当前页的资源总数。

取值范围

不涉及。

next_marker

String

参数解释

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

取值范围

不涉及。

请求示例

查询安全组规则列表。

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

响应示例

状态码:200

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

  • {
      "request_id" : "80747d36e3376c0894ba8f9a9156355d",
      "security_group_rules" : [ {
        "id" : "f626eb24-d8bd-4d26-ae0b-c16bb65730cb",
        "project_id" : "060576782980d5762f9ec014dd2f1148",
        "security_group_id" : "0552091e-b83a-49dd-88a7-4a5c86fd9ec3",
        "direction" : "ingress",
        "protocol" : "tcp",
        "description" : "security group rule description",
        "created_at" : "2020-08-13T07:12:36.000+00:00",
        "updated_at" : "2020-08-13T07:12:36.000+00:00",
        "ethertype" : "IPv4",
        "remote_ip_prefix" : "10.10.0.0/16",
        "multiport" : 333,
        "action" : "allow",
        "priority" : 1,
        "remote_group_id" : null,
        "remote_address_group_id" : null,
        "enabled" : true
      } ]
    }

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

    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();
        ListSecurityGroupRulesRequest request = new ListSecurityGroupRulesRequest();
        try {
            ListSecurityGroupRulesResponse response = client.listSecurityGroupRules(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 = ListSecurityGroupRulesRequest()
        response = client.list_security_group_rules(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.ListSecurityGroupRulesRequest{}
	response, err := client.ListSecurityGroupRules(request)
	if err == nil {
        fmt.Printf("%+v\n", response)
    } else {
        fmt.Println(err)
    }
}

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

状态码

状态码

描述

200

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

错误码

请参见错误码