Unlock the Power of AI

1 million free tokens

88% Price Reduction

Activate Now

DescribeInstanceSSL

Updated at: 2025-03-19 03:26

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.

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.
OperationAccess levelResource typeCondition keyAssociated operation
OperationAccess levelResource typeCondition keyAssociated operation
oceanbase:DescribeInstanceSSLnone
*All Resources
*
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
ParameterTypeRequiredDescriptionExample
InstanceIdstringYes

The ID of the OceanBase cluster.

ob317v4uif****

Response parameters

ParameterTypeDescriptionExample
ParameterTypeDescriptionExample
object

The return result of the request.

RequestIdstring

The ID of the request.

EE205C00-30E4-xxxx-xxxx-87E3A8A2AA0C
InstanceSSLobject

The SSL setting of the OceanBase cluster instance.

InstanceIdstring

The ID of the OceanBase cluster.

ob317v4uif****
EnableSSLstring

The operation to modify the SSL status. Valid values:

  • open: Enable SSL encryption.

  • update: Update the CA certificate.

  • close: Disable SSL encryption.

OPEN
ValidPeriodstring

The validity period of the SSL certificate.

2024-09-20 07:55:03.0
CaUrlstring

The URL of the certificate authority (CA) node.

https://xxxx
Statusstring

The SSL status of the cluster.

RUNNING
ForceSSLSupportboolean

Indicates whether SSL can be forcibly enabled.

false
ForceSSLstring

The forced enabling status of SSL.

CLOSE
AutoUpdatestring

The status of automatic update of SSL certificates. Valid values:

  • CLOSE: The automatic update of SSL certificates is disabled.
  • OPEN: The automatic update of SSL certificates is enabled.
OPEN

Examples

Sample success responses

JSONformat

{
  "RequestId": "EE205C00-30E4-xxxx-xxxx-87E3A8A2AA0C",
  "InstanceSSL": {
    "InstanceId": "ob317v4uif****",
    "EnableSSL": "OPEN",
    "ValidPeriod": "2024-09-20 07:55:03.0",
    "CaUrl": "https://xxxx",
    "Status": "RUNNING",
    "ForceSSLSupport": false,
    "ForceSSL": "CLOSE",
    "AutoUpdate": "OPEN"
  }
}

Error codes

HTTP status codeError codeError message
HTTP status codeError codeError message
500InternalErrorThe request processing has failed due to some unknown error.

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

Change history

Change timeSummary of changesOperation
Change timeSummary of changesOperation
2025-02-13The Error code has changed. The request parameters of the API has changed. The response structure of the API has changedView Change Details
2024-10-29The Error code has changed. The response structure of the API has changedView Change Details
  • On this page (0)
  • Debugging
  • Authorization information
  • Request parameters
  • Response parameters
  • Examples
  • Error codes
  • Change history
Feedback
phone Contact Us

Chat now with Alibaba Cloud Customer Service to assist you in finding the right products and services to meet your needs.

alicare alicarealicarealicare