Querying a Security Group Rule

Function

This API is used to query details about a security group rule.

URI

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

Table 1 Path Parameters

Parameter	Mandatory	Type	Description
project_id	Yes	String	Project ID.
security_group_rule_id	Yes	String	Security group rule ID.

Request Parameters

None

Response Parameters

Status code: 200

Table 2 Response body parameters

Parameter	Type	Description
request_id	String	Request ID.
security_group_rule	SecurityGroupRule object	Response body for querying details about a security group rule.

Table 3 SecurityGroupRule

Parameter	Type	Description
id	String	Security group rule ID, which uniquely identifies the security group rule. The value is in UUID format with hyphens (-).
description	String	Provides supplementary information about the security group rule. The value can contain no more than 255 characters and cannot contain angle brackets (< or >).
security_group_id	String	ID of the security group to which the security group rule belongs.
direction	String	Inbound or outbound direction of a security group rule. The value can be: ingress: inbound direction. egress: outbound direction.
protocol	String	Protocol type The value can be icmp, tcp, udp, icmpv6, or an IP number. Constraints: If the parameter is left blank, all protocols are supported. When the protocol is icmpv6, IP version should be IPv6. When the protocol is icmp, IP version should be IPv4.
ethertype	String	IP version The value can be IPv4 or IPv6. If you do not set this parameter, IPv4 is used by default.
multiport	String	Port or port range The value can be a single port (80), a port range (1-30), or inconsecutive ports separated by commas (22,3389,80).
action	String	Action of the security group rule. The value can be: allow, deny. The default value is deny.
priority	Integer	Rule priority. The value is from 1 to 100. The value 1 indicates the highest priority.
remote_group_id	String	ID of the remote security group, which allows or denies traffic to and from the security group. Value range: ID of an existing security group. The parameter value is mutually exclusive with parameters remote_ip_prefix and remote_address_group_id.
remote_ip_prefix	String	Remote IP address. If direction is set to egress, the parameter specifies the source IP address. If direction is set to ingress, the parameter specifies the destination IP address. The value is an IP address or a CIDR block. Constraints: The parameter value is mutually exclusive with parameters remote_group_id and remote_address_group_id.
remote_address_group_id	String	ID of the remote IP address group. Value range: ID of an existing IP address group The parameter value is mutually exclusive with parameters remote_ip_prefix and remote_group_id.
created_at	String	Time when the security group rule is created. UTC time in the format of yyyy-MM-ddTHH:mm:ssZ.
updated_at	String	Time when the security group rule is updated. UTC time in the format of yyyy-MM-ddTHH:mm:ssZ.
project_id	String	ID of the project to which the security group rule belongs.

Example Requests

Query details about a security group rule.

GET https://{Endpoint}/v3/{project_id}/vpc/security-group-rules/01a772b2-463e-47e3-a95d-bac85ee8adc6

Example Responses

Status code: 200

Normal response to the GET operation. For more status codes, see Status Codes.

• {
    "security_group_rule" : {
      "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
    },
    "request_id" : "034c4840bde0b1263a4b2e66fbd74d5f"
  }
  

Status Codes

Status Code	Description
200	Normal response to the GET operation. For more status codes, see Status Codes.

Error Codes

See Error Codes.

last updated: 2025-02-13 18:06 UTC - commit: a8530c89648f9da57c9cece0709e214729d5f7ef