Queries ECS security groups to which an ApsaraDB for RDS instance is added.
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
Request parameters
Parameter | Type | Required | Example | Description |
---|---|---|---|---|
Action | String | Yes | DescribeSecurityGroupConfiguration |
The operation that you want to perform. Set the value to DescribeSecurityGroupConfiguration. |
DBInstanceId | String | Yes | rm-uf6wjk5xxxxxx |
The ID of the instance. |
Response parameters
Parameter | Type | Example | Description |
---|---|---|---|
DBInstanceName | String | rm-uf6wjk5xxxxxx |
The ID of the instance. |
Items | Array |
An array that consists of ECS security groups. |
|
EcsSecurityGroupRelation | |||
NetworkType | String | VPC |
The network type of the ECS security group. Valid values:
|
RegionId | String | cn-hangzhou |
The ID of the region. |
SecurityGroupId | String | sg-xxxxxxx |
The ID of the ECS security group. |
RequestId | String | 87BDAE8C-ACB0-4A26-BBCC-7D1DD31D630D |
The ID of the request. |
Examples
Sample requests
http(s)://rds.aliyuncs.com/? Action=DescribeSecurityGroupConfiguration
&DBInstanceId=rm-uf6wjk5xxxxxx
&<Common request parameters>
Sample success responses
XML
format
<DescribeSecurityGroupConfigurationResponse>
<Items>
<EcsSecurityGroupRelation>
<NetworkType>VPC</NetworkType>
<SecurityGroupId>sg-1xxxxxxx</SecurityGroupId>
<RegionId>cn-hangzhou</RegionId>
</EcsSecurityGroupRelation>
<EcsSecurityGroupRelation>
<NetworkType>VPC</NetworkType>
<SecurityGroupId>sg-2xxxxxxx</SecurityGroupId>
<RegionId>cn-hangzhou</RegionId>
</EcsSecurityGroupRelation>
</Items>
<RequestId>87BDAE8C-ACB0-4A26-BBCC-7D1DD31D630D</RequestId>
<DBInstanceName>rm-uf6wjk5xxxxxx</DBInstanceName>
</DescribeSecurityGroupConfigurationResponse>
JSON
format
{"Items":
{"EcsSecurityGroupRelation":
[{"NetworkType":"VPC",
"SecurityGroupId":"sg-1xxxxxxx",
"RegionId":"cn-hangzhou"},
{"NetworkType":"VPC",
"SecurityGroupId":"sg-2xxxxxxx",
"RegionId":"cn-hangzhou"}]},
"RequestId":"87BDAE8C-ACB0-4A26-BBCC-7D1DD31D630D",
"DBInstanceName":"rm-uf6wjk5xxxxxx"}
Error codes
For a list of error codes, visit the API Error Center.