DescribeSecurityGroupConfiguration - ApsaraDB RDS - Alibaba Cloud Documentation Center

Queries ECS security groups to which an ApsaraDB for RDS instance is added.

Operation Description

After an RDS instance is added to an ECS security group, all ECS instances in the security group can access the RDS instance. For more information, see Configure a whitelist for an RDS instance.

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.

debugging

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
rds:DescribeSecurityGroupConfiguration	Read	DBInstance acs:rds:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}	rds:ResourceTag	none

Request parameters

Parameter	Type	Required	Description	Example
DBInstanceId	string	Yes	The ID of the instance.	rm-uf6wjk5xxxxxx

Response parameters

Parameter	Type	Description	Example
	object
DBInstanceName	string	The ID of the instance.	rm-uf6wjk5xxxxxx
RequestId	string	The ID of the request.	87BDAE8C-ACB0-4A26-BBCC-7D1DD31D630D
Items	object []	An array that consists of ECS security groups.
NetworkType	string	The network type of the ECS security group. Valid values: Classic VPC	VPC
SecurityGroupId	string	The ID of the ECS security group.	sg-xxxxxxx
RegionId	string	The ID of the region.	cn-hangzhou
SecurityGroupName	string	The name of the security group.	security-group-emraccess

Examples

Sample success responses

JSONformat

{
  "DBInstanceName": "rm-uf6wjk5xxxxxx",
  "RequestId": "87BDAE8C-ACB0-4A26-BBCC-7D1DD31D630D",
  "Items": {
    "EcsSecurityGroupRelation": [
      {
        "NetworkType": "VPC",
        "SecurityGroupId": "sg-xxxxxxx",
        "RegionId": "cn-hangzhou",
        "SecurityGroupName": "security-group-emraccess"
      }
    ]
  }
}

Error codes

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