All Products
Search
Document Center

Microservices Engine:ListSecurityGroupRule

Last Updated:Nov 20, 2024

Queries the security group rules of a gateway.

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.

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:ListSecurityGroupRulelist
*All Resources
*
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
GatewayUniqueIdstringYes

The unique ID of the gateway.

gw-83b0ddb569434f82b9fe8e4c60c40f7c
AcceptLanguagestringNo

The language of the response. Valid values:

  • zh: Chinese
  • en: English
zh

Response parameters

ParameterTypeDescriptionExample
object

Schema of Response

RequestIdstring

The ID of the request.

9EC7BDBF-3C38-5C9C-95DD-61E298CD43E8
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
Dataarray<object>

The returned result.

Rulesobject

The returned data.

Idstring

The ID of the security group authorization record.

21
SecurityGroupIdstring

The ID of the security group.

sg-bp1cg6qlyjepj0y6cf2c
PortRangestring

The port range.

8000/8000
IpProtocolstring

The protocol type.

tcp
GatewayIdlong

The gateway ID.

81
GatewayUniqueIdstring

The unique ID of the gateway.

gw-12a432a1f5da423997d8880bd32c304d
GmtCreatestring

The creation time.

2022-01-07T10:07:57.000+0000
GmtModifiedstring

The last modification time.

2022-01-07T10:07:57.000+0000
Descriptionstring

The rule description.

Test

Examples

Sample success responses

JSONformat

{
  "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 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 response structure of the API has changedView Change Details