Querying the Details of a Security Group

Function

After a security group is created, you can call this API to query all information about the security group, including the name, ID, and description.

Calling Method

For details, see Calling APIs.

URI

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

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	Definition: ID of the project that a security group belongs to. For details about how to obtain a project ID, see Obtaining a Project ID. Range: None
security_group_id	Yes	String	Definition: ID of a security group. Range: None

Request Parameters

None

Response Parameters

Status code: 200

**Table 2** Response body parameters
Parameter	Type	Description
request_id	String	Definition: Request ID. Range: None
security_group	SecurityGroupInfo object	Definition: Response body for querying details about a security group. Range: None

**Table 3** SecurityGroupInfo
Parameter	Type	Description
id	String	Definition: ID of a security group. After a security group is created, a security group ID is generated, which uniquely identifies the security group. Range: The value is in UUID format with hyphens (-).
name	String	Definition: Name of a security group. Range: The value can contain 1 to 64 characters, including letters, digits, underscores (_), hyphens (-), and periods (.).
description	String	Definition: Description of a security group. Range: The value can contain no more than 255 characters and cannot contain angle brackets (< or >).
project_id	String	Definition: ID of the project that a security group belongs to. Range: None
created_at	String	Definition: Time when a security group was created. Range: UTC time in the format of yyyy-MM-ddTHH:mm:ssZ
updated_at	String	Definition: Time when a security group was updated. Range: UTC time in the format of yyyy-MM-ddTHH:mm:ssZ
tags	Array of ResponseTag objects	Definition: Tags of a security group, including tag keys and tag values, which can be used to classify and identify resources. For details, see the tag objects. Range: None
security_group_rules	Array of SecurityGroupRule objects	Definition: Security group rule list. Range: None

**Table 4** ResponseTag
Parameter	Type	Description
key	String	Definition: Tag key. Range: A tag key can contain a maximum of 128 Unicode characters and cannot be left blank. Each tag key of a resource must be unique. The value can contain: Letters Digits Special characters: underscores (_), periods (.), colons (:), plus signs (+), hyphens (-), and equal signs (=) Chinese characters
value	String	Definition: Tag value. Range: Each value can contain a maximum of 255 Unicode characters and can be left blank. The value can contain: Letters Digits Special characters: underscores (_), periods (.), colons (:), plus signs (+), hyphens (-), and equal signs (=) Chinese characters

**Table 5** SecurityGroupRule
Parameter	Type	Description
id	String	Definition: ID of a security group rule. After a security group rule is created, a security group rule ID is generated, which uniquely identifies the security group rule. Range: The value is in UUID format with hyphens (-).
description	String	Definition: Description of a security group rule. Range: The value can contain no more than 255 characters and cannot contain angle brackets (< or >).
security_group_id	String	Definition: ID of the security group that a security group rule belongs to. Range: None
direction	String	Definition: Inbound or outbound direction of a security group rule. Range: ingress: inbound direction egress: outbound direction
protocol	String	Definition: Communication protocol of a security group rule. Range: icmp tcp udp icmpv6 IP protocol number
ethertype	String	Definition: IP address version of a security group rule. Range: IPv4 IPv6
multiport	String	Definition: Port range of a security group rule. 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	Definition: Action of a security group rule. Range: allow deny
priority	Integer	Definition: Priority of a security group rule. Range: The value is from 1 to 100. The value 1 indicates the highest priority.
remote_group_id	String	Definition: ID of the remote security group of a security group rule. If the action of the rule is allow, the traffic from the remote security group is allowed. If the action of the rule is deny, the traffic from the remote security group is denied. Range: ID of an existing security group.
remote_ip_prefix	String	Definition: Remote IP address of a security group rule. If direction is set to egress, the IP address is the outbound destination and will be accessed by instances in the security group. If direction is set to ingress, the IP address is the inbound source and will access the instances in the security group. Range: CIDR notation format. If an IP address is transferred in the request, the IP address is automatically formatted with /32 as the subnet mask, for example, 192.168.21.45/32.
remote_address_group_id	String	Definition: ID of the remote IP address group of a security group rule. Range: ID of an existing IP address group.
created_at	String	Definition: Time when a security group rule was created. Range: UTC time in the format of yyyy-MM-ddTHH:mm:ssZ
updated_at	String	Definition: Time when a security group rule was updated. Range: UTC time in the format of yyyy-MM-ddTHH:mm:ssZ
project_id	String	Definition: ID of the project that a security group rule belongs to. Range: None

Example Requests

Querying the details of a security group

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

Example Responses

Status code: 200

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

{
  "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
    }, {
      "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
    }, {
      "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
    }, {
      "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
    } ],
    "created_at" : "2020-07-09T05:56:27.000+00:00",
    "updated_at" : "2020-07-09T05:56:27.000+00:00"
  },
  "request_id" : "a8cf4f79ca3c22ca685e7e8872e8c20b"
}