Querying All Security Groups in an Enterprise Project

Function

This API is used to query all security groups in an enterprise project.

Authorization Information

Each account has all the permissions required to call all APIs, but IAM users must be assigned the required permissions.

If you are using role/policy-based authorization, see Permissions Policies and Supported Actions for details on the required permissions.
If you are using identity policy-based authorization, no identity policy-based permission required for calling this API.

URI

GET /v5/{project_id}/container-network/security-groups

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	Definition Project ID, which is used to specify the project that an asset belongs to. After the project ID is configured, you can query assets in the project using the project ID. For details about how to obtain it, see Obtaining a Project ID. Constraints N/A Range The value can contain 1 to 256 characters. Default Value N/A

**Table 2** Query Parameters
Parameter	Mandatory	Type	Description
enterprise_project_id	No	String	Definition Enterprise project ID, which is used to filter assets in different enterprise projects. For details, see Obtaining an Enterprise Project ID. To query assets in all enterprise projects, set this parameter to all_granted_eps. Constraints You need to set this parameter only after the enterprise project function is enabled. Range The value can contain 1 to 256 characters. Default Value 0: default enterprise project.

Request Parameters

**Table 3** Request header parameters
Parameter	Mandatory	Type	Description
X-Auth-Token	Yes	String	Definition User token, which contains user identity and permissions. The token can be used for identity authentication when an API is called. For details about how to obtain the token, see Obtaining a User Token. Constraints N/A Range The value can contain 1 to 32,768 characters. Default Value N/A

Response Parameters

Status code: 200

**Table 4** Response body parameters
Parameter	Type	Description
[items]	Array of SecurityGroup objects	Security group list

**Table 5** SecurityGroup
Parameter	Type	Description
security_group_id	String	Definition Unique ID of a security group in the cloud native network model, which is used to associate a specific security group with a policy. Constraints The security group must be in the same VPC network as the cluster. Otherwise, the association fails. Range The value can contain 1 to 64 characters, including letters, numbers, hyphens (-), and underscores (_). Default Value None
security_group_name	String	Definition Name of a security group. Constraints If this parameter is specified, its value must be the same as the name of the security group corresponding to security_group_id. Otherwise, the display may be abnormal. (Functions are not affected.) Range The value can contain 1 to 64 characters, including letters, numbers, hyphens (-), and underscores (_). Default Value None. By default, the system name corresponding to the security group ID is used.
security_group_description	String	Definition Description of the security group, which is used to record the purpose and permission scope of the security group. Constraints The description cannot contain special characters such as HTML tags. Range The value can contain 0 to 256 characters, including Chinese characters, letters, numbers, common punctuations, and spaces. Default Value None. Do not modify the security group description. (If the original description is empty, keep it empty).

Example Requests

This API is used to query the security group list of a namespace in a cluster.

GET https://{endpoint}/v5/{project_id}/container-network/security-groups?enterprise_project_id=all_granted_eps

Example Responses

Status code: 200

Request succeeded.

[ {
  "security_group_id" : "03b46bce-b0b7-42d3-992d-ddfb567106f0",
  "security_group_name" : "sg-4a7d",
  "security_group_description" : "General-purpose web server. It allows ICMP traffic over ports 22, 3389, 80, and 443. It applies to cloud servers for remote login, public network ping, and website services."
}, {
  "security_group_id" : "090cef69-1b90-4f86-9e10-ba593811fcf4",
  "security_group_name" : "sg-df44",
  "security_group_description" : "General-purpose web server. It allows ICMP traffic over ports 22, 3389, 80, and 443. It applies to cloud servers for remote login, public network ping, and website services."
}, {
  "security_group_id" : "110a7b73-7fae-4c28-bae8-535f6a853613",
  "security_group_name" : "hss-test-block",
  "security_group_description" : "Inbound ICMP and other traffic are allowed over ports 22, 80, 443, and 3389. It applies to cloud servers for remote login, public network ping, and website services."
}, {
  "security_group_id" : "11e58259-ee22-4cc7-9f67-73e49d670d43",
  "security_group_name" : "test111-cce-node-5i32n",
  "security_group_description" : "The security group is created by CCE cluster c0276ccf-aaf4-11ee-9d4a-0255ac100b0f for the node"
} ]