DescribeInstanceSSL - 查询集群 SSL - 云数据库 OceanBase （文档停止维护）

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

调试

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

调试

授权信息

下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：

操作：是指具体的权限点。
访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用前面加 * 表示。
- 对于不支持资源级授权的操作，用全部资源表示。
条件关键字：是指云产品自身定义的条件关键字。
关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

操作

访问级别

资源类型

条件关键字

关联操作

oceanbase:DescribeInstanceSSL

none

*全部资源

*

无

请求参数

名称	类型	必填	描述	示例值
InstanceId	string	是	OceanBase 集群 ID。	ob317v4uif****
TenantId	string	否	OceanBase 租户 ID

返回参数

名称	类型	描述	示例值
	object	请求的返回结果。
RequestId	string	请求 ID。	EE205C00-30E4-xxxx-xxxx-87E3A8A2AA0C
InstanceSSL	object	云监控实例详情。
InstanceId	string	OceanBase 集群 ID。	ob317v4uif****
EnableSSL	string	是否开启 SSL 链路加密功能。	OPEN
ValidPeriod	string	有效期。	2024-09-20 07:55:03.0
CaUrl	string	ca 节点地址。	https://xxxx
Status	string	开启 SSL 状态。	RUNNING
ForceSSLSupport	boolean	是否支持强制开启 SSL。	false
ForceSSL	string	强制开启状态。	CLOSE
AutoUpdate	string	是否开启 SSL 证书自动更新。枚举值： CLOSE : CLOSE OPEN : OPEN	OPEN
TenantId	string
CertValid	boolean

示例

正常返回示例

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",
    "AutoUpdate": "OPEN",
    "TenantId": "",
    "CertValid": true
  }
}

错误码

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

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

变更历史

更多信息，参考变更详情。