Use DescribeDBInstanceSSL to query SSL configurations - ApsaraDB RDS - Alibaba Cloud - ApsaraDB RDS

Queries the SSL configuration of an ApsaraDB RDS instance.

Operation description

Applicable engines

RDS MySQL
RDS PostgreSQL
RDS SQL Server

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

rds:DescribeDBInstanceSSL

get

*DBInstance

acs:rds:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}

rds:ResourceTag
rds:ResourceTag
rds:ResourceTag
rds:ResourceTag

None

Request parameters

Parameter	Type	Required	Description	Example
DBInstanceId	string	Yes	The instance ID. You can call DescribeDBInstances to obtain the instance ID.	rm-bp162dfr55g47****

Response elements

Element	Type	Description	Example
	object	The response parameters.
ACL	string	The authentication method of the ApsaraDB RDS for PostgreSQL instance with cloud disks. Valid values: cert prefer verify-ca verify-full (supported for RDS PostgreSQL 12 and later)	cert
CAType	string	The server certificate type of the ApsaraDB RDS for PostgreSQL instance with cloud disks. Valid values: aliyun: Uses a cloud certificate. custom: Uses a custom certificate.	aliyun
ClientCACert	string	The public key of the client certificate authority (CA) for the ApsaraDB RDS for PostgreSQL instance with cloud disks.	-----BEGIN CERTIFICATE-----MIID*****viXk=-----END CERTIFICATE-----
ClientCACertExpireTime	string	The expiration time of the client certificate authorization public key for the ApsaraDB RDS for PostgreSQL instance with cloud disks. The time follows the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time is displayed in UTC.	-
ClientCertRevocationList	string	The client revocation certificate file for the ApsaraDB RDS for PostgreSQL instance with cloud disks.	-----BEGIN X509 CRL-----MIIB****19mg==-----END X509 CRL-----
ConnectionString	string	The endpoint protected by SSL.	rm-bp162dfr55g47****.mysql.rds.aliyuncs.com
ForceEncryption	string	Indicates whether the forced Secure Sockets Layer (SSL) encryption feature is enabled for the ApsaraDB RDS for SQL Server instance. Valid values:	1
LastModifyStatus	string	The current SSL link configuration status of the ApsaraDB RDS for PostgreSQL instance with cloud disks. Valid values: success: The configuration is successful. setting: The configuration is in progress. failed: The configuration failed.	setting
ModifyStatusReason	string	The reason for the current SSL link configuration status of the ApsaraDB RDS for PostgreSQL instance with cloud disks.	Modify DB Instance SSL Config.
ReplicationACL	string	The authentication method for replication permissions of an ApsaraDB RDS for PostgreSQL instance with cloud disks. Valid values: cert prefer verify-ca verify-full (supported by RDS PostgreSQL 12 and later)	cert
RequestId	string	The request ID.	7705151C-E242-55AF-9929-2A3C39D979D2
RequireUpdate	string	Indicates whether the SSL certificate needs to be updated. Valid values: Note An SSL certificate is valid for one year. If the certificate is not updated after it expires, client programs that use encrypted connections cannot connect to the instance. MySQL, SQL Server No: No update is required. Yes: An update is required. PostgreSQL 0: No update is required. 1: An update is required.	Yes
RequireUpdateItem	string	The list of server certificates that need to be updated for the ApsaraDB RDS for PostgreSQL instance with cloud disks.	-
RequireUpdateReason	string	The reason why the certificates need to be updated for the ApsaraDB RDS for PostgreSQL instance with cloud disks.	-
SSLCreateTime	string	The creation time of the server certificate for the ApsaraDB RDS for PostgreSQL instance with cloud disks. This parameter is valid only when CAType is set to aliyun.	-
SSLEnabled	string	The SSL encryption status. Valid values: MySQL and SQL Server Yes: SSL encryption is enabled. No: SSL encryption is disabled. PostgreSQL on: SSL encryption is enabled. off: SSL encryption is disabled.	Yes
SSLExpireTime	string	The expiration time of the SSL certificate. The time follows the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time is displayed in UTC.	2025-06-16T08:16:43Z
ServerCAUrl	string	The URL of the CA certificate that is used to issue the server certificate for the ApsaraDB RDS for PostgreSQL instance with cloud disks.	-
ServerCert	string	The content of the server certificate for the ApsaraDB RDS for PostgreSQL instance with cloud disks.	-----BEGIN CERTIFICATE-----MIID*****QqEP-----END CERTIFICATE-----
ServerKey	string	The private key of the server certificate for the ApsaraDB RDS for PostgreSQL instance with cloud disks.	-----BEGIN PRIVATE KEY-----MIIE****ihfg==-----END PRIVATE KEY-----
TlsVersion	string	The specified minimum TLS version for the ApsaraDB RDS for SQL Server instance. Valid values: 1.0, 1.1, and 1.2.	1.1

Examples

Success response

JSON format

{
  "ACL": "cert",
  "CAType": "aliyun",
  "ClientCACert": "-----BEGIN CERTIFICATE-----MIID*****viXk=-----END CERTIFICATE-----",
  "ClientCACertExpireTime": "-",
  "ClientCertRevocationList": "-----BEGIN X509 CRL-----MIIB****19mg==-----END X509 CRL-----",
  "ConnectionString": "rm-bp162dfr55g47****.mysql.rds.aliyuncs.com",
  "ForceEncryption": "1",
  "LastModifyStatus": "setting",
  "ModifyStatusReason": "Modify DB Instance SSL Config.",
  "ReplicationACL": "cert",
  "RequestId": "7705151C-E242-55AF-9929-2A3C39D979D2",
  "RequireUpdate": "Yes",
  "RequireUpdateItem": "-",
  "RequireUpdateReason": "-",
  "SSLCreateTime": "-",
  "SSLEnabled": "Yes",
  "SSLExpireTime": "2025-06-16T08:16:43Z",
  "ServerCAUrl": "-",
  "ServerCert": "-----BEGIN CERTIFICATE-----MIID*****QqEP-----END CERTIFICATE-----",
  "ServerKey": "-----BEGIN PRIVATE KEY-----MIIE****ihfg==-----END PRIVATE KEY-----",
  "TlsVersion": "1.1"
}

Error codes

HTTP status code	Error code	Error message	Description
400	InvaildEngineInRegion.ValueNotSupported	The engine is not supported in the region.	The database engine version is invalid.
400	InvalideStatus.Format	Specified Status is not valid.
400	ConcurrentLimit	The request processing has been concurrent limit.	Request processing has reached the concurrency limit.
400	Order.ComboInstanceNotAllowOperate	A package instance is not allowed to operate independently.	A package instance is not allowed to operate independently.
400	Price.PricingPlanResultNotFound	Pricing plan price result not found.	Pricing plan price result not found.
400	Order.NoRealNameAuthentication	You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication.	You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the cost and cost for real-name authentication.
400	InsufficientAvailableQuota	Your account quota limit is less than 0, please recharge before trying to purchase.	Your account available limit is less than 0, please recharge before trying to purchase.
400	CommodityServiceCalling.Exception	Failed to call commodity service.	Failed to call commodity service return.
400	RegionDissolvedEOM	Dear customer, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will cease operations. You are currently unable to operate new purchase orders. Thank you for your understanding and support.	Hello, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will stop operating. In order to ensure your business continuity and smooth transition of data migration, you are currently unable to operate new purchase orders. Thank you for your understanding and support.
400	Commodity.InvalidComponent	The module you purchased is not legal, please buy it again.	The module you purchased is not legal, please buy it again.
400	RegionEndTimeDissolvedAustralia	Cloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024.	Hello customer, this area has been abolished.
400	Price.CommoditySys	Commodity system call exception.	Commodity system call exception.
400	Pay.InsufficientBalance	Insufficient available balance.	Insufficient available balance.
400	Order.PeriodInvalid	There is a problem with the period you selected, please choose again.	There is a problem with the period you selected, please choose again.
400	pay.noCreditCard	Account not bound to credit card.	No credit card is available.
400	Order.InstHasUnpaidOrder	There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.	There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.
400	noAvailablePaymentMethod	No payment method is specified for your account. We recommend that you add a payment method.	No payment method has been specified for your account. We recommend that you add a payment method.
400	BasicInfoUncompleted	Your information is incomplete. Complete your information before the operation.	Your basic information is not complete, please complete your basic information before operation.
400	Risk.RiskControlRejection	Your account is abnormal, please contact customer service for details.	Your account is abnormal, please contact customer service for details.
400	Api.NotSupport	Specified api is not supported.	The current interface does not support.
400	ContainForbiddenLabelError	There is a label that prohibits placing orders. Please contact your distributor for assistance.	You cannot place the order because a tag indicates that order placement is prohibited. Contact your distributor.
400	InvalidDBInstanceId.NotFound	The DBInstanceId provided does not exist in records.	The DBInstanceId provided does not exist.
400	InvalidInstanceLevel.DiskType	Specified instance level not support request disk type	The current instance type does not support the specified storage type.
400	InvalidParam	Sepcified wal level Parameter is invalid. There are still logical slots in instance, so it can not be set as replica.	The specified wal_level parameter is invalid. There is still a copy slot in the instance, so it cannot be set to replica.
400	KmsApiError	User secret key invalid.	The user key is invalid.
400	System.SaleValidateFailed	Sales expression validation system error.	A system error occurs when the sales expression is verified.
400	Abs.InvalidAccount.NotFound	account is not found.	The account does not exist.
400	SqlExecuteFailedOrTimeout	sql command execution failed or timed out:%s.	SQL command execution failed or timed out
400	ColdData.EngineVersionNotSupport	The current instance engine version not support coldDataEnabled.	The current instance engine version not support coldDataEnabled.
400	ColdData.MinorVersionNotSupport	The current instance minor version not support coldDataEnabled.	The current instance minor version not support coldDataEnabled.
400	IncorrectTargetClasscode	The current instance type does not support this operation.	This operation is not supported by the instance type.
400	InvalidConnectionString.Duplicate	Specified connection string already exists in the RDS.	The link address name is duplicate. Please reset the connection string.
400	RequiredParam.NotFound	Required input param is not found.	Required parameters are missing.
400	Parameters.Invalid	Parameter error, please check the parameters.	Parameter error, please check the parameters.
400	BackupPolicyNotSupport	Cold Data won't open with CrossBackup or Flash Backup, please check Backup Policy.	Cold Data won't open with CrossBackup or Flash Backup, please check Backup Policy.
400	InvalidReleasedKeepPolicy.Format	Specified Released Keep Policy is not valid.	Specified Released Keep Policy is not valid.
400	InvalidDBInstanceEngineType.Format	the DB instance engine type does not support this operation.	This operation is not supported for the database engine of the instance.
400	Pay.NoCreditCard	No credit cards.	No credit cards.
400	VpcNetworkTypeNotSupport	The vpc network type instance does not support this operation.	The vpc network type instance does not support this operation.
400	MirrorInsExists	Specified DB instance mirror ins already existed.	Specified DB instance mirror ins already existed.
400	UnsupportedClassCode	The specified DB instance class stops selling.	The specified DB instance class stops selling.
400	InvalidBackupSet	The specified database does not exist in the backup set.	The specified database does not exist in the backup set.
400	OrdTCommodityQueryError	Failed to query for product.	Failed to query product.
400	ProductInstanceReleased	The instance has been released. Please check before placing the order.	The instance has been released, please verify and place an order.
400	RegionEndTimeDissolvedIndia	The region is no longer supported.	The region is no longer supported.
500	ExternalFailure	The request processing has failed due to external service failure.	The request processing has failed due to external service failure.
500	RequestMetaDataFailed	The service request failed. Please try again later or contact service personnel.	The service request failed. Please try again later or contact service personnel.
500	InvokeProxyFailure	The request processing has failed due to service failure of rds api.	The request failed to be processed due to an RDS API failure.
403	OperationDenied.DBInstanceType	The operation is not permitted due to type of the instance.	The current instance type does not support this operation.
403	InstanceEngineType.NotSupport	The instance engine and type does not support operations	The operation failed. The operation is not supported for the database engine that is run on the RDS instance.
403	IncorrectEngineVersion	Current engine version does not support operations.
403	IncorrectDBInstanceState	Current DB instance state does not support this operation.	The current instance status does not support this operation.
403	IncorrectDBInstanceType	Current DB instance type does not support this operation.	The operation failed. The RDS instance is not in a ready state.
403	IncorrectDBInstanceLockMode	Current DB instance lock mode does not support this operation.
403	ConnectionStringLengthExceeded	Connection String is too long.	The endpoint is exceedingly long. Modify the endpoint and try again.
403	ResourceConfigError	The request processing has failed due to resource config error.	The request failed due to a resource configuration error.
403	OrderStatus.UnPaid	The specified db instance has unpaid order.	The instance has an unpaid order. Please pay first and try again.
403	InvalidReduceDiskSize	The storage capacity after the scale-down must be larger than the used amount.	The scale-in target capacity cannot be less than the current storage space usage
403	CloudSSDNotSupport	Cloud ssd does not support this operation, please upgrade to essd.	SSD disks do not support this operation. Upgrade to ESSD.
403	InvalidUserOperatorPermission	The user permission does not support this operation.	The user is not authorized to perform this operation.
403	InvalidVswitchId	Specified conn vswitch id is not valid.	The specified VSwitchId is in an incorrect format or is empty.
403	IncorrectMinorVersion	Current engine minor version does not support operations.	This operation is not supported for the current minor engine version.
403	OperationDenied.ZoneResource	There is no available zone for inventory.	There is no available zone for inventory.
403	NotInFlowController	Sorry,no permission.	Sorry,no permission.
403	InvalidKmsKey	Kms key is disabled.	The KMS key is disabled.
403	InvalidInstanceLevel.Malformed	Current DB instance level does not support this operation.	The specified database instance type does not support this operation.
403	GuardDBInstanceNotSupport	Guard instance does not support this operation.	This operation is not supported for disaster recovery instances.
404	InvalidDBInstanceId.NotFound	The specified instance is not found.	The RDS instance cannot be found. Check whether the RDS instance is created within the logged-on account.
404	EnabledSSLNotSupport	Specified region does not support enable ssl.	SSL encryption is not supported in the region.
404	InvalidConnectionString.NotFound	Specified connection string or net type is not found.	The endpoint cannot be found. Check the endpoint.
404	InvalidClusterKms	The current instance does not authorized to access the Key Management Service.	The instance does not have permissions to access Key Management Service (KMS).
404	Request.NotFound	The requested resource is not available.	The requested resources are unavailable.
404	HostInfo.NotFound	The specified host info is not found.	The specified host information does not exist.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.

ApsaraDB RDS:DescribeDBInstanceSSL