ListSecurityGroupRule - Microservices Engine - Alibaba Cloud Documentation Center

Queries the security group rules for a gateway.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

mse:ListSecurityGroupRule

list

*All Resource

*

None

Request parameters

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

Response elements

Element	Type	Description	Example
	object	Schema of Response
RequestId	string	Id of the request	9EC7BDBF-3C38-5C9C-95DD-61E298CD43E8
HttpStatusCode	integer	The HTTP status code.	200
Message	string	The response message.	success
Code	integer	The response code.	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 returned data.
	object	The returned data.
Id	string	The ID of the security group authorization record.	21
SecurityGroupId	string	The ID of the security group.	sg-bp1cg6qlyjepj0y6cf2c
PortRange	string	The port range.	8000/8000
IpProtocol	string	The protocol type.	tcp
AuthCidrs	array
	string
GatewayId	integer	The ID of the gateway.	81
GatewayUniqueId	string	The unique ID of the gateway.	gw-12a432a1f5da423997d8880bd32c304d
GmtCreate	string	The time when the rule was created.	2022-01-07T10:07:57.000+0000
GmtModified	string	The time when the rule was last modified.	2022-01-07T10:07:57.000+0000
Description	string	The description of the rule.	Test

Examples

Success response

JSON format

{
  "RequestId": "9EC7BDBF-3C38-5C9C-95DD-61E298CD43E8",
  "HttpStatusCode": 200,
  "Message": "success",
  "Code": 200,
  "Success": true,
  "Data": [
    {
      "Id": "21",
      "SecurityGroupId": "sg-bp1cg6qlyjepj0y6cf2c",
      "PortRange": "8000/8000",
      "IpProtocol": "tcp",
      "AuthCidrs": [
        ""
      ],
      "GatewayId": 81,
      "GatewayUniqueId": "gw-12a432a1f5da423997d8880bd32c304d",
      "GmtCreate": "2022-01-07T10:07:57.000+0000",
      "GmtModified": "2022-01-07T10:07:57.000+0000",
      "Description": "Test\n"
    }
  ]
}

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
500	InternalError	Console error. Try again later:%s	Console error. Try again later: %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

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.