Queries the security groups that are included in the whitelist of an ApsaraDB for Redis instance.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.

Request parameters

Parameter Type Required Example Description
Action String Yes DescribeSecurityGroupConfiguration

The operation that you want to perform. Set the value to DescribeSecurityGroupConfiguration.

InstanceId String Yes r-bp1zxszhcgatnx****

The ID of the instance.
RegionId String No cn-hangzhou

The ID of the region where the instance is deployed.

Response parameters

Parameter Type Example Description
Items Array of EcsSecurityGroupRelation

The list of security groups.
EcsSecurityGroupRelation
NetType String vpc

The network type of the security group. Valid values:

  • classic: the classic network.
  • vpc: the virtual private cloud (VPC).
RegionId String cn-hangzhou

The ID of the region where the instance is deployed.
SecurityGroupId String sg-bp14p9y07ns3gwq****

The ID of the security group.
RequestId String 981C0D6A-D9DD-466C-92DA-F29DF755****

The ID of the request.

Examples

Sample requests

https://r-kvstore.aliyuncs.com/?Action=DescribeSecurityGroupConfiguration
? InstanceId=r-bp1zxszhcgatnx****
&<Common request parameters>

Sample success responses

XML format 

<DescribeSecurityGroupConfigurationResponse>
      <RequestId>981C0D6A-D9DD-466C-92DA-F29DF755****</RequestId>
      <Items>
            <EcsSecurityGroupRelation>
                  <SecurityGroupId>sg-bp14p9y07ns3gwq****</SecurityGroupId>
                  <RegionId>cn-hangzhou</RegionId>
                  <NetType>vpc</NetType>
            </EcsSecurityGroupRelation>
      </Items>
</DescribeSecurityGroupConfigurationResponse>

JSON format 

{
	"RequestId": "981C0D6A-D9DD-466C-92DA-F29DF755****",
	"Items": {
		"EcsSecurityGroupRelation": [
			{
				"SecurityGroupId": "sg-bp14p9y07ns3gwq****",
				"RegionId": "cn-hangzhou",
				"NetType": "vpc"
			}
		]
	}
}

Error codes

For a list of error codes, visit the API Error Center.