ModifyDBClusterSSL - PolarDB - Alibaba Cloud Documentation Center

Enables or disables the SSL encryption feature for a PolarDB cluster, or updates the CA certificate of the cluster.

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.

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:
- For mandatory resource types, indicate with a prefix of * .
- 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
polardb:ModifyDBClusterSSL	update	*DBCluster `acs:polardb:{#regionId}:{#accountId}:dbcluster/{#DbClusterId}`	none	none

Request parameters

Parameter	Type	Required	Description	Example
DBClusterId	string	Yes	The ID of the cluster.	pc-************
SSLEnabled	string	No	The SSL encryption status. Valid values: Disable: SSL encryption is disabled. Enable: SSL encryption is enabled. Update: The SSL certificate is updated. Note After you enable SSL encryption or update the SSL certificate, you must download and configure the certificate. For more information, see Configure SSL encryption.	Enable
DBEndpointId	string	No	The ID of the endpoint. Note This parameter is required for PolarDB for MySQL clusters. This parameter is not required for PolarDB for PostgreSQL or PolarDB for PostgreSQL (Compatible with Oracle) clusters. By default, SSL encryption is enabled for all endpoints of the clusters. You can call the DescribeDBClusterSSL operation to view the details of the endpoint.	pe-******************
NetType	string	No	The network type supported by the endpoint that is specified by DBEndpointId. Valid values: Public Private Inner Note This parameter is required for a PolarDB for MySQL cluster. This parameter is not required for a PolarDB for Oracle or PolarDB for PostgreSQL cluster. By default, SSL encryption is enabled for all endpoints.	Public
SSLAutoRotate	string	No	Specifies whether automatic rotation of SSL certificates is enabled. Enable: The feature is enabled. Disable: The feature is disabled.	Enable

Response parameters

Parameter	Type	Description	Example
	object
RequestId	string	The ID of the request.	A94B1755-6D8B-4E27-BF3C-8562BC******

Examples

Sample success responses

JSONformat

{
  "RequestId": "A94B1755-6D8B-4E27-BF3C-8562BC******"
}

Error codes

HTTP status code	Error code	Error message	Description
400	EngineMigration.ActionDisabled	Specified action is disabled while custins is in engine migration.	The specified operation is disabled when custins is being migrated across engines.
400	InvalidDBEndpointId.Malformed	The specified parameter DBEndpointId is not valid.	The specified DBEndpointId parameter is invalid.
400	InvalidSSLAutoRotate.Malformed	The specified SSLAutoRotate is not valid.	The specified SSLAutoRotate parameter is invalid.
400	InvalidNetType.Malformed	The specified parameter NetType is not valid.	The specified NetType parameter is invalid.
400	InvalidConnectionString.Malformed	The specified parameter ConnectionString is not valid.	The specified ConnectionString parameter is invalid.
404	InvalidDBCluster.NotFound	The DBClusterId provided does not exist in our records.	The specified DBClusterId parameter does not exist in the current record.
404	InvalidDBClusterId.Malformed	The specified parameter DBClusterId is not valid.	The specified DBClusterId parameter is invalid.

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

Change history

Change time	Summary of changes	Operation
2023-09-12	The Error code has changed	View Change Details
2023-04-24	The Error code has changed	View Change Details