Enables or disables the SSL encryption feature for a PolarDB cluster, or updates the CA certificate of the cluster.
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 |
---|---|---|---|---|
polardb:ModifyDBClusterSSL | Write |
|
| 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:
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
| pe-****************** |
NetType | string | No | The network type supported by the endpoint that is specified by DBEndpointId. Valid values:
Note
| Public |
SSLAutoRotate | string | No | Specifies whether automatic rotation of SSL certificates is enabled.
| Enable |
Response parameters
Examples
Sample success responses
JSON
format
{
"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. |
404 | InvalidDBCluster.NotFound | The DBClusterId provided does not exist in our records. | The specified DBClusterId parameter does not exist in the current record. |
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 | see changesets | ||||||
| ||||||||
2023-04-24 | The Error code has changed | see changesets | ||||||
|