DescribeSecurityGroupReferences

Queries the list of other security groups that have been authorized by one or more specified security groups.

Operation description

If you cannot delete a security group (DeleteSecurityGroup), you can call this operation to check whether the specified security group has been authorized by other security groups. If the specified security group has been authorized, you can call RevokeSecurityGroup and RevokeSecurityGroupEgress to delete the corresponding security group rules to revoke the authorization.

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

ecs:DescribeSecurityGroupReferences

get

*SecurityGroup

acs:ecs:{#regionId}:{#accountId}:securitygroup/{#securitygroupId}

None

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	Yes	The region ID of the security group. You can call DescribeRegions to query the most recent region list.	cn-hangzhou
SecurityGroupId	array	Yes	The array of security group IDs. Array length: 0 to 10.	sg-bp14vtedjtobkvi****
	string	No	The security group ID.	sg-bp14vtedjtobkvi****

Response elements

Element	Type	Description	Example
	object
RequestId	string	The request ID.	473469C7-AA6F-4DC5-B3DB-A3DC0DE3****
SecurityGroupReferences	object
SecurityGroupReference	array<object>	The collection of security groups and their authorized security group information.
	array<object>	The security group and its authorized security group information.
SecurityGroupId	string	The ID of the specified security group.	sg-bp67acfmxazb4p****
ReferencingSecurityGroups	object
ReferencingSecurityGroup	array<object>	Details about the security groups whose rules reference the specified security group.
	object	Details about the security group whose rules reference the specified security group.
SecurityGroupId	string	The ID of the security group whose rules reference the specified security group.	sg-bp67acfmxazb4j****
AliUid	string	The ID of the Alibaba Cloud account to which the security group whose rules reference the specified security group belongs.	123456****

Examples

Success response

JSON format

{
  "RequestId": "473469C7-AA6F-4DC5-B3DB-A3DC0DE3****",
  "SecurityGroupReferences": {
    "SecurityGroupReference": [
      {
        "SecurityGroupId": "sg-bp67acfmxazb4p****",
        "ReferencingSecurityGroups": {
          "ReferencingSecurityGroup": [
            {
              "SecurityGroupId": "sg-bp67acfmxazb4j****",
              "AliUid": "123456****"
            }
          ]
        }
      }
    ]
  }
}

Error codes

HTTP status code	Error code	Error message	Description
400	InvalidSecurityGroupId.Malformed	The specified parameter SecurityGroupId is essential and size should less than 10	The SecurityGroupId.N parameter is required and the value of N cannot exceed 10.
404	InvalidRegionId.NotFound	The RegionId provided does not exist in our records.	Region information error
404	InvalidSecurityGroupId.NotFound	The SecurityGroupId provided does not exist in our records.	The specified security group does not exist in this account. Check whether the security group ID is correct.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.