DescribeInstanceSSL-阿里云帮助中心

Queries the SSL details of an OceanBase cluster.

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

oceanbase:DescribeInstanceSSL

none

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
InstanceId	string	Yes	The OceanBase cluster ID.	ob317v4uif****
TenantId	string	No	The OceanBase tenant ID.

Response elements

Element	Type	Description	Example
	object	The returned data.
RequestId	string	The request ID.	EE205C00-30E4-xxxx-xxxx-87E3A8A2AA0C
InstanceSSL	object	The instance SSL details.
InstanceId	string	The OceanBase cluster ID.	ob317v4uif****
EnableSSL	string	Indicates whether SSL link encryption is enabled.	OPEN
ValidPeriod	string	The expiration time.	2024-09-20 07:55:03.0
CaUrl	string	The CA certificate URL.	https://xxxx
Status	string	The SSL status.	RUNNING
ForceSSLSupport	boolean	Indicates whether forced SSL is supported.	false
ForceSSL	string	The forced SSL status.	CLOSE
AutoUpdate	string	Indicates whether automatic SSL certificate updates are enabled. Valid values: CLOSE : Automatic update is disabled. OPEN : Automatic update is enabled.	OPEN
TenantId	string	The OceanBase tenant ID.
CertValid	boolean	Indicates whether the certificate is currently valid.

Examples

Success response

JSON format

{
  "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",
    "TenantId": "",
    "CertValid": false
  }
}

Error codes

HTTP status code	Error code	Error message	Description
500	InternalError	The request processing has failed due to some unknown error.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.