All Products
Search
Document Center

Microservices Engine:ListSecurityGroup

Last Updated:Apr 11, 2024

Obtains the information about security groups.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

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.
OperationAccess levelResource typeCondition keyAssociated operation
mse:ListSecurityGroupRead
  • Gateway
    acs:mse:{#regionId}:{#accountId}:instance/{#GatewayUniqueId}
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
GatewayUniqueIdstringYes

The ID of the gateway.

gw-e98e40675aaf49bda082137d158e1585
AcceptLanguagestringNo

The language of the response. Valid values:

  • zh: Chinese
  • en: English
zh

Response parameters

ParameterTypeDescriptionExample
object

The schema of the response.

RequestIdstring

The ID of the request.

316F5F64-F73D-42DC-8632-01E308B6****
HttpStatusCodeinteger

The HTTP status code returned.

200
Messagestring

The message returned.

success
Codeinteger

The status code returned.

200
Successboolean

Indicates whether the request was successful. Valid values:

  • true: The request was successful.
  • false: The request failed.
true
Dataobject []

The data structure.

SecurityGroupIdstring

The ID of the security group.

sg-8vb8gsmrqyc35k645rk6
SecurityGroupNamestring

The name of the security group.

sg2
VpcIdstring

The ID of the virtual private cloud (VPC).

vpc-bp1b
SecurityGroupTypestring

The type of the security group. Valid values:

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 codeError codeError messageDescription
400IllegalRequestInvalid request:%sInvalid request: %s
400InvalidParameterParameter error:%sRequest parameter error: %s
403NoPermissionYou are not authorized to perform this operation:%sYou do not have the permission to use this interface:%s
404NotFoundNot found:%sThe resource does not exist:%s
500InternalErrorConsole error. Try again later:%sConsole error. Try again later: %s

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

Change history

Change timeSummary of changesOperation
2023-12-11The internal configuration of the API is changed, but the call is not affectedsee changesets
Change itemChange content
The internal configuration of the API is changed, but the call is not affected.