ListSecurityGroup - Microservices Engine - Alibaba Cloud Documentation Center

Obtains the information about security groups.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Debug

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

Operation: the value that you can use in the Action element to specify the operation on a resource.
Access level: the access level of each operation. The levels are read, write, and list.
Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
- The required resource types are displayed in bold characters.
- If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
Condition Key: the condition key that is defined by the cloud service.
Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.

Operation	Access level	Resource type	Condition key	Associated operation
mse:ListSecurityGroup	list	Gateway acs:mse:{#regionId}:{#accountId}:instance/{#GatewayUniqueId}	none	none

Request parameters

Parameter	Type	Required	Description	Example
GatewayUniqueId	string	Yes	The ID of the gateway.	gw-e98e40675aaf49bda082137d158e1585
AcceptLanguage	string	No	The language of the response. Valid values: zh: Chinese en: English	zh

Response parameters

Parameter	Type	Description	Example
	object	The schema of the response.
RequestId	string	The ID of the request.	316F5F64-F73D-42DC-8632-01E308B6****
HttpStatusCode	integer	The HTTP status code returned.	200
Message	string	The message returned.	success
Code	integer	The status code returned.	200
Success	boolean	Indicates whether the request was successful. Valid values: `true`: The request was successful. `false`: The request failed.	true
Data	array<object>	The data structure.
Sgs	object	The data of the node.
SecurityGroupId	string	The ID of the security group.	sg-8vb8gsmrqyc35k645rk6
SecurityGroupName	string	The name of the security group.	sg2
VpcId	string	The ID of the virtual private cloud (VPC).	vpc-bp1b
SecurityGroupType	string	The type of the security group. Valid values: normal: basic security group enterprise: advanced security group For more information, see Advanced security groups.	enterprise

Examples

Sample success responses

JSONformat

{
  "RequestId": "316F5F64-F73D-42DC-8632-01E308B6****",
  "HttpStatusCode": 200,
  "Message": "success",
  "Code": 200,
  "Success": true,
  "Data": [
    {
      "SecurityGroupId": "sg-8vb8gsmrqyc35k645rk6",
      "SecurityGroupName": "sg2",
      "VpcId": "vpc-bp1b",
      "SecurityGroupType": "enterprise"
    }
  ]
}

Error codes

HTTP status code	Error code	Error message	Description
400	IllegalRequest	Invalid request:%s	Invalid request: %s
400	InvalidParameter	Parameter error:%s	Request parameter error: %s
403	NoPermission	You are not authorized to perform this operation:%s	You do not have the permission to use this interface:%s
404	NotFound	Not found:%s	The resource does not exist:%s
500	InternalError	Console error. Try again later:%s	Console error. Try again later: %s

For a list of error codes, visit the Service error codes.

Change history

Change time	Summary of changes	Operation
2023-12-11	The internal configuration of the API is changed, but the call is not affected	View Change Details