All Products
Search
Document Center

PolarDB:ModifyDBClusterSSL

Last Updated:Nov 07, 2023

Enables or disables Secure Sockets Layer (SSL) encryption or updates the Certificate Authorities (CA) certificate for a specified PolarDB 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.

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.
OperationAccess levelResource typeCondition keyAssociated operation
polardb:ModifyDBClusterSSLWRITE
  • DBCluster
    acs:polardb:{#regionId}:{#accountId}:dbcluster/{#DbClusterId}
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
DBClusterIdstringYes

The ID of the cluster.

pc-************
SSLEnabledstringNo

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
DBEndpointIdstringNo

The ID of the endpoint.

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.

  • You can call the DescribeDBClusterSSL operation to view the details of the endpoint.

pe-******************
NetTypestringNo

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
SSLAutoRotatestringNo

Specifies whether automatic rotation of SSL certificates is enabled.

  • Enable: The feature is enabled.
  • Disable: The feature is disabled.
Enable

Response parameters

ParameterTypeDescriptionExample
object
RequestIdstring

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 codeError codeError messageDescription
400EngineMigration.ActionDisabledSpecified action is disabled while custins is in engine migration.The specified operation is disabled when custins is being migrated across engines.
404InvalidDBCluster.NotFoundThe 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 timeSummary of changesOperation
2023-09-12The error codes of the API operation change.see changesets
Change itemChange content
Error CodesThe error codes of the API operation change.
    Error Codes 400 change
    Error Codes 404 change
2023-04-24The error codes of the API operation change.see changesets
Change itemChange content
Error CodesThe error codes of the API operation change.
    delete Error Codes: 404
    Added Error Codes: 400