Querying a Security Group Rule

project_id

Yes

String

Project ID.

security_group_rule_id

Yes

String

Security group rule ID.

request_id

String

Request ID.

security_group_rule

SecurityGroupRule object

Response body for querying details about a security group rule.

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.

200

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