Help Center/ Workspace/ API Reference/ Workspace APIs/ Network/ Listing Security Groups

Updated on 2026-02-10 GMT+08:00

View PDF

Listing Security Groups

Function

Lists security groups.

Debugging

You can debug this API through automatic authentication in API Explorer or use the SDK sample code generated by API Explorer.

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, the following identity policy-based permissions are required.

Action	Access Level	Resource Type (*: required)	Condition Key	Alias	Dependencies
workspace:networks:listSecurityGroups	List	-	-	-	-

URI

GET /v2/{project_id}/security-groups

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	Project ID.

Request Parameters

None

Response Parameters

Status code: 200

**Table 2** Response body parameters
Parameter	Type	Description
security_groups	Array of SimpleSecurityGroupsInfo objects	Security group list.

**Table 3** SimpleSecurityGroupsInfo
Parameter	Type	Description
description	String	Security group description.
name	String	Security group name.
id	String	Primary key of the security group.
security_group_rules	String	External gateway information.
tenant_id	String	Primary key of a tenant.
project_id	String	Primary key of the resource tenant.
created_at	String	Resource creation time.
updated_at	String	Resource update time.

Status code: 400

**Table 4** Response body parameters
Parameter	Type	Description
error_code	String	Error code.
error_msg	String	Error message.
encoded_authorization_message	String	Encrypted detailed reason for rejection. You can call the API decode-authorization-message of STS to decrypt the reason.

Status code: 401

**Table 5** Response body parameters
Parameter	Type	Description
error_code	String	Error code.
error_msg	String	Error message.
encoded_authorization_message	String	Encrypted detailed reason for rejection. You can call the API decode-authorization-message of STS to decrypt the reason.

Status code: 403

**Table 6** Response body parameters
Parameter	Type	Description
error_code	String	Error code.
error_msg	String	Error message.
encoded_authorization_message	String	Encrypted detailed reason for rejection. You can call the API decode-authorization-message of STS to decrypt the reason.

Status code: 404

**Table 7** Response body parameters
Parameter	Type	Description
error_code	String	Error code.
error_msg	String	Error message.
encoded_authorization_message	String	Encrypted detailed reason for rejection. You can call the API decode-authorization-message of STS to decrypt the reason.

Status code: 405

**Table 8** Response body parameters
Parameter	Type	Description
error_code	String	Error code.
error_msg	String	Error message.
encoded_authorization_message	String	Encrypted detailed reason for rejection. You can call the API decode-authorization-message of STS to decrypt the reason.

Status code: 500

**Table 9** Response body parameters
Parameter	Type	Description
error_code	String	Error code.
error_msg	String	Error message.
encoded_authorization_message	String	Encrypted detailed reason for rejection. You can call the API decode-authorization-message of STS to decrypt the reason.

Status code: 503

**Table 10** Response body parameters
Parameter	Type	Description
error_code	String	Error code.
error_msg	String	Error message.
encoded_authorization_message	String	Encrypted detailed reason for rejection. You can call the API decode-authorization-message of STS to decrypt the reason.

Example Requests

/v2/0e3f393ae380f5d12facc005678bcd4b/security-groups

Example Responses

Status code: 200

Response to the request for listing security groups.

{
  "security_groups" : [ {
    "name" : "WorkspaceUserSecurityGroup",
    "id" : "0822226d-cfc3-4794-957d-e22ccf9d83c6"
  }, {
    "name" : "WorkspaceManagerSecurityGroup",
    "id" : "11b56ad7-3e13-499f-8abe-92b6b68fa613"
  }, {
    "name" : "default",
    "id" : "25f74f8a-e0e6-42a3-b192-a36a2da98c92"
  } ]
}

Status Codes

Status Code	Description
200	Response to the request for listing security groups.
400	The request cannot be understood by the server due to malformed syntax.
401	Authentication failed.
403	No operation permissions.
404	No resources found.
405	The method specified in the request is not allowed.
500	An internal service error occurred. For details about the error code, see the error code description.
503	Service unavailable.