DescribeSecurityGroupReferences - Elastic Compute Service

Queries the security groups that are referencing specific security groups. When you call this operation, you can specify SecurityGroupId.

Operation description

When you call this operation, take note of the following items:

A security group can be referenced by the inbound or outbound rules of other security groups.
Up to 100 entries can be returned each time.
If a security group cannot be deleted by calling the DeleteSecurityGroup operation, you can call the DescribeSecurityGroupReferences operation to check whether the security group is referenced by the rules of other security groups. If the security group is referenced by the rules of other security groups, you must remove the reference before you can delete the security group.

Debugging

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

Debug

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.

Operation	Access level	Resource type	Condition key	Associated operation
ecs:DescribeSecurityGroupReferences	get	SecurityGroup acs:ecs:{#regionId}:{#accountId}:securitygroup/{#securitygroupId}	none	none

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	Yes	The region ID of the security group.	cn-hangzhou
SecurityGroupId	array	Yes	The IDs of N security groups that you want to query. Valid values of N: 1 to 10.
	string	Yes	The ID of security group N that you want to query. Valid values of N: 1 to 10.	sg-bp14vtedjtobkvi****

Response parameters

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

Examples

Sample success responses

JSONformat

{
  "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.	The RegionId provided does not exist
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.

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

Change history

Change time	Summary of changes	Operation

No change history