文档

DescribeInstanceSSL - 查询集群 SSL

更新时间:

该接口用于查询 OceanBase 集群的 SSL 详情。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

当前API暂无授权信息透出。

请求参数

名称类型必填描述示例值
InstanceIdstring

OceanBase 集群 ID。

ob317v4uif****

返回参数

名称类型描述示例值
object

请求的返回结果。

RequestIdstring

请求 ID。

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

云监控实例详情。

InstanceIdstring

OceanBase 集群 ID。

ob317v4uif****
EnableSSLstring

是否开启 SSL 链路加密功能。

OPEN
ValidPeriodstring

有效期。

2024-09-20 07:55:03.0
CaUrlstring

ca 节点地址。

https://xxxx
Statusstring

开启 SSL 状态。

RUNNING
ForceSSLSupportboolean

是否支持强制开启 SSL。

false
ForceSSLstring

强制开启状态。

CLOSE

示例

正常返回示例

JSON格式

{
  "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"
  }
}

错误码

HTTP status code错误码错误信息描述
500InternalErrorThe request processing has failed due to some unknown error.内部错误

访问错误中心查看更多错误码。