All Products
Search
Document Center

ENS:DescribeSecurityGroupAttribute

Last Updated:Jul 26, 2024

Queries the rules of a security group.

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
ens:DescribeSecurityGroupAttributeget
  • All Resources
    *
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
SecurityGroupIdstringYes

The ID of the security group.

sg-bp67acfmxazb4ph***

Response parameters

ParameterTypeDescriptionExample
object
RequestIdstring

The request ID.

473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E
Descriptionstring

The description of the security group.

testDescription1
SecurityGroupIdstring

The ID of the destination security group.

sg-bp1gxw6bznjjvhu3****
SecurityGroupNamestring

The name of the destination security group.

testSecurityGroupName2
Permissionsarray<object>

Details about the rules.

object

Schema of Response

CreationTimestring

The time at which the security group rule was created. The time is displayed in UTC.

2018-12-12T07:28:38Z
Directionstring

The direction in which the security group rule is applied.

ingress
Policystring

The policy.

Accept
PortRangestring

The source port range.

80/80
SourceCidrIpstring

The range of source IP addresses for inbound access control.

0.0.0.0/0
IpProtocolstring

The transport layer protocol.

TCP
DestCidrIpstring

The range of destination IP addresses for outbound access control.

0.0.0.0/0
Priorityinteger

The priority of the rule.

1
SourcePortRangestring

The source port number range for the security group.

22/22
Descriptionstring

The description.

testDescription1

Examples

Sample success responses

JSONformat

{
  "RequestId": "473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E",
  "Description": "testDescription1",
  "SecurityGroupId": "sg-bp1gxw6bznjjvhu3****",
  "SecurityGroupName": "testSecurityGroupName2",
  "Permissions": {
    "Permission": [
      {
        "CreationTime": "2018-12-12T07:28:38Z",
        "Direction": "ingress",
        "Policy": "Accept",
        "PortRange": "80/80",
        "SourceCidrIp": "0.0.0.0/0",
        "IpProtocol": "TCP",
        "DestCidrIp": "0.0.0.0/0",
        "Priority": 1,
        "SourcePortRange": "22/22",
        "Description": "testDescription1"
      }
    ]
  }
}

Error codes

HTTP status codeError codeError messageDescription
400MissingParameterThe input parameter that is mandatory for processing this request is not supplied.-
400NoPermissionPermission denied.-
400InvalidParameter.%sThe specified field %s invalid. Please check it again.-
400InvalidParameterThe errorMessage is %s. Please check it again.-
400InvalidSecurityGroupId.NotFoundThe specified SecurityGroupId does not exist.-
400SecurityGroupRuleConflict.DuplicatedThe SecurityGroup rule already exists.-
400AuthorizationLimitExceedThe limit of authorization records in the security group reaches.-
400SecurityGroupRule.NotFoundThe input security group rule does not exist.-
400IncorrectInstanceStatusThe current status of the resource does not support this operation.The current operation is not supported. The disk is being reset.
400InvalidInstanceId.NotFoundThe specified InstanceId does not exist.The specified instance does not exist.
400DependencyViolationThere is still instance(s) in the specified security group.-
400ens.interface.errorAn error occurred while calling the API.-
400CallInterfaceCall Interface Happen Error.An error occurred when you call the operation.

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

Change history

Change timeSummary of changesOperation
2023-12-21The Error code has changedView Change Details