全部产品
Search

搜索本产品

    云数据库 OceanBase：DescribeInstanceSSL - 查询集群 SSL

    文档中心

    云数据库 OceanBase：DescribeInstanceSSL - 查询集群 SSL

    更新时间：Nov 22, 2024

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

    调试

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

    授权信息

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

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

    请求参数

    名称类型必填描述示例值
    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
    AutoUpdatestring

    是否开启 SSL 证书自动更新。

    枚举值：
    • CLOSE：CLOSE。
    • OPEN：OPEN。
    		OPEN

    示例

    正常返回示例

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

    错误码

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

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

    变更历史

    变更时间变更内容概要操作
    2024-10-29OpenAPI 错误码发生变更、OpenAPI 返回结构发生变更查看变更详情