全部产品
Search
文档中心

云数据库 RDS:DescribeDBInstanceSSL - 查询RDS实例的SSL配置

更新时间:Jan 23, 2024

该接口用于查询RDS实例的SSL配置情况。

接口说明

适用引擎

  • RDS MySQL
  • RDS PostgreSQL
  • RDS SQL Server

调试

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

调试

授权信息

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

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
rds:DescribeDBInstanceSSLRead
  • DBInstance
    acs:rds:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}
  • rds:ResourceTag

请求参数

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

实例 ID。可调用 DescribeDBInstances 获取。

rm-bp162dfr55g47****

返回参数

名称类型描述示例值
object

返回参数详情。

ServerCertstring

该参数仅适用于 RDS PostgreSQL 云盘版实例,表示服务器证书内容。

-----BEGIN CERTIFICATE-----MIID*****QqEP-----END CERTIFICATE-----
ClientCACertExpireTimestring

该参数仅适用于 RDS PostgreSQL 云盘版实例,表示客户端证书授权机构公钥有效期。格式:yyyy-MM-ddTHH:mm:ssZ(UTC 时间),暂不支持。

-
RequireUpdateItemstring

该参数仅适用于 RDS PostgreSQL 云盘版实例,表示需要更新的服务器证书列表。

-
ServerCAUrlstring

该参数仅适用于 RDS PostgreSQL 云盘版实例,表示签发服务器证书的 CA 证书 URL。

-
RequireUpdatestring

是否需要更新。

  • MySQL 或 SQL Server 时取值:
    • No:不需要更新
    • Yes:需要更新
  • PostgreSQL 时取值:
    • 0:不需要更新
    • 1:需要更新
Yes
ClientCertRevocationListstring

该参数仅适用于 RDS PostgreSQL 云盘版实例,表示客户端吊销证书文件。

-----BEGIN X509 CRL-----MIIB****19mg==-----END X509 CRL-----
SSLExpireTimestring

SSL 证书有效期。格式:yyyy-MM-ddTHH:mm:ssZ(UTC 时间)。

2022-10-11T08:16:43Z
CATypestring

该参数仅适用于 RDS PostgreSQL 云盘版实例,表示服务器证书类型,取值:

  • aliyun:使用云证书
  • custom:使用自定义证书
aliyun
SSLCreateTimestring

该参数仅适用于 RDS PostgreSQL 云盘版实例,表示服务器证书创建时间,当配置为使用云证书时有效。

-
ReplicationACLstring

该参数仅适用于 RDS PostgreSQL 云盘版实例,表示 replication 权限的认证方法。取值:

  • cert
  • prefer
  • verify-ca
  • verify-full(RDS PostgreSQL 12 以上支持)
cert
ACLstring

该参数仅适用于 RDS PostgreSQL 云盘版实例,表示认证方法,取值:

  • cert
  • prefer
  • verify-ca
  • verify-full(RDS PostgreSQL 12 以上支持)
cert
RequestIdstring

请求 ID。

7705151C-E242-55AF-9929-2A3C39D979D2
LastModifyStatusstring

该参数仅适用于 RDS PostgreSQL 云盘版实例,表示当前 SSL 链路配置状态。取值:

  • success:成功
  • setting:设置中
  • failed:失败
setting
SSLEnabledstring

SSL 状态。

  • MySQL 或 SQL Server 时取值:
    • Yes:已开启
    • No:未开启
  • PostgreSQL 时取值:
    • on:已开启
    • off:未开启
Yes
ConnectionStringstring

受 SSL 保护的连接地址。

rm-bp162dfr55g47****.mysql.rds.aliyuncs.com
RequireUpdateReasonstring

该参数仅适用于 RDS PostgreSQL 云盘版实例,表示需要更新证书的原因。

-
ClientCACertstring

该参数仅适用于 RDS PostgreSQL 云盘版实例,表示客户端证书授权机构公钥。

-----BEGIN CERTIFICATE-----MIID*****viXk=-----END CERTIFICATE-----
ServerKeystring

该参数仅适用于 RDS PostgreSQL 云盘版实例,表示服务器证书私钥。

-----BEGIN PRIVATE KEY-----MIIE****ihfg==-----END PRIVATE KEY-----
ModifyStatusReasonstring

该参数仅适用于 RDS PostgreSQL 云盘版实例,表示当前 SSL 链路配置状态对应的原因。

Modify DB Instance SSL Config.
ForceEncryptionstring

该参数仅适用于 RDS SQL Server 实例,表示实例是否已开启强制 SSL 加密。更多详情,请参见设置 SSL 加密

  • 1:开启。
  • 0:未开启。
1
TlsVersionstring

该参数仅适用于 RDS SQL Server 实例,表示实例指定的最低 LTS 版本号,当前支持 1.0、1.1、1.2。更多详情,请参见设置 SSL 加密

1.1

示例

正常返回示例

JSON格式

{
  "ServerCert": "-----BEGIN CERTIFICATE-----MIID*****QqEP-----END CERTIFICATE-----",
  "ClientCACertExpireTime": "-",
  "RequireUpdateItem": "-",
  "ServerCAUrl": "-",
  "RequireUpdate": "Yes",
  "ClientCertRevocationList": "-----BEGIN X509 CRL-----MIIB****19mg==-----END X509 CRL-----",
  "SSLExpireTime": "2022-10-11T08:16:43Z",
  "CAType": "aliyun",
  "SSLCreateTime": "-",
  "ReplicationACL": "cert",
  "ACL": "cert",
  "RequestId": "7705151C-E242-55AF-9929-2A3C39D979D2",
  "LastModifyStatus": "setting",
  "SSLEnabled": "Yes",
  "ConnectionString": "rm-bp162dfr55g47****.mysql.rds.aliyuncs.com",
  "RequireUpdateReason": "-",
  "ClientCACert": "-----BEGIN CERTIFICATE-----MIID*****viXk=-----END CERTIFICATE-----",
  "ServerKey": "-----BEGIN PRIVATE KEY-----MIIE****ihfg==-----END PRIVATE KEY-----",
  "ModifyStatusReason": "Modify DB Instance SSL Config.",
  "ForceEncryption": "1",
  "TlsVersion": "1.1"
}

错误码

HTTP status code错误码错误信息描述
400InvaildEngineInRegion.ValueNotSupportedThe engine is not supported in the region.数据库版本不正确。
400InvalideStatus.FormatSpecified Status is not valid.-
403OperationDenied.DBInstanceTypeThe operation is not permitted due to type of the instance.操作失败,只读实例不支持克隆。请检查实例类型。
403InstanceEngineType.NotSupportThe instance engine and type does not support operations操作失败,实例引擎和类型不支持该操作。
403IncorrectEngineVersionCurrent engine version does not support operations.操作失败,当前数据库版本不支持此操作。
403IncorrectDBInstanceStateCurrent DB instance state does not support this operation.当前实例状态不支持此操作。
403IncorrectDBInstanceTypeCurrent DB instance type does not support this operation.操作失败,该实例状态下不支持此操作。
403IncorrectDBInstanceLockModeCurrent DB instance lock mode does not support this operation.操作失败,实例处于锁定状态。
403ConnectionStringLengthExceededConnection String is too long.连接字符串太长,请修改后重试。
404InvalidDBInstanceId.NotFoundThe specified instance is not found.实例不存在。请确认该实例是否在当前账号下。
404EnabledSSLNotSupportSpecified region does not support enable ssl.指定的区域不支持启用SSL服务。
404InvalidConnectionString.NotFoundSpecified connection string or net type is not found.连接串不存在。请检查连接串是否正确。

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

变更历史

变更时间变更内容概要操作
2023-12-20OpenAPI 错误码发生变更、OpenAPI 返回结构发生变更看变更集
变更项变更内容
错误码OpenAPI 错误码发生变更
    删除错误码:400
    删除错误码:403
    删除错误码:404
出参OpenAPI 返回结构发生变更
2022-06-23OpenAPI 描述信息更新、OpenAPI 错误码发生变更看变更集
变更项变更内容
API 描述OpenAPI 描述信息更新
错误码OpenAPI 错误码发生变更
    删除错误码:400
    删除错误码:403
    删除错误码:404