调用DescribeDBInstanceSSL接口查询实例SSL设置。
说明 该接口支持MySQL 5.6、MySQL 5.7高可用本地盘、MySQL 8.0高可用本地盘、SQL Server所有版本和PostgreSQL云盘版本。
调试
您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。
请求参数
| 名称 | 类型 | 是否必选 | 示例值 | 描述 |
|---|---|---|---|---|
| Action | String | 是 | DescribeDBInstanceSSL | 系统规定参数，取值：DescribeDBInstanceSSL。 |
| DBInstanceId | String | 是 | rm-uf6wjk5xxxxxxx | 实例ID。 |
返回数据
| 名称 | 类型 | 示例值 | 描述 |
|---|---|---|---|
| ConnectionString | String | rm-uf6wjk5xxxxxx.mysql.rds.aliyuncs.com | 受SSL保护的连接地址。 |
| SSLExpireTime | String | 2022-05-08T08:14:16Z | SSL证书有效期。格式：yyyy-MM-ddTHH:mm:ssZ（UTC时间）。 |
| RequireUpdate | String | Yes | 是否需要更新。
|
| ACL | String | cert | 该参数仅RDS PostgreSQL云盘版支持，表示认证方法，取值包括：
|
| CAType | String | aliyun | 该参数仅RDS PostgreSQL云盘版支持，表示服务器证书类型，取值包括：
|
| ClientCACert | String | -----BEGIN CERTIFICATE-----MIID*****viXk=-----END CERTIFICATE----- | 该参数仅RDS PostgreSQL云盘版支持，表示客户端证书授权机构公钥。 |
| ClientCACertExpireTime | String | - | 该参数仅RDS PostgreSQL云盘版支持，表示客户端证书授权机构公钥有效期。格式：yyyy-MM-ddTHH:mm:ssZ（UTC时间），暂不支持。 |
| ClientCertRevocationList | String | -----BEGIN X509 CRL-----MIIB****19mg==-----END X509 CRL----- | 该参数仅RDS PostgreSQL云盘版支持，表示客户端吊销证书文件。 |
| LastModifyStatus | String | setting | 该参数仅RDS PostgreSQL云盘版支持，表示当前SSL链路配置状态。取值：
|
| ModifyStatusReason | String | Modify DB Instance SSL Config. | 该参数仅RDS PostgreSQL云盘版支持，表示当前SSL链路配置状态对应的原因。 |
| ReplicationACL | String | cert | 该参数仅RDS PostgreSQL云盘版支持，表示replication权限的认证方法。取值包括：
|
| RequestId | String | 1AD222E9-E606-4A42-BF6D-8A4442913CEF | 请求ID。 |
| RequireUpdateItem | String | - | 该参数仅RDS PostgreSQL云盘版支持，表示需要更新的服务器证书列表。 |
| RequireUpdateReason | String | - | 该参数仅RDS PostgreSQL云盘版支持，表示需要更新证书的原因。 |
| SSLCreateTime | String | - | 该参数仅RDS PostgreSQL云盘版支持，表示服务器证书创建时间，当配置为使用云证书时有效。 |
| SSLEnabled | String | on | 开启或关闭SSL，取值：
|
| ServerCAUrl | String | - | 该参数仅RDS PostgreSQL云盘版支持，表示签发服务器证书的CA证书URL。 |
| ServerCert | String | -----BEGIN CERTIFICATE-----MIID*****QqEP-----END CERTIFICATE----- | 该参数仅RDS PostgreSQL云盘版支持，表示服务器证书内容。 |
| ServerKey | String | -----BEGIN PRIVATE KEY-----MIIE****ihfg==-----END PRIVATE KEY----- | 该参数仅RDS PostgreSQL云盘版支持，表示服务器证书私钥。 |
示例
请求示例
http(s)://rds.aliyuncs.com/?Action=DescribeDBInstanceSSL &DBInstanceId=rm-uf6wjk5xxxxxxx &<公共请求参数>
正常返回示例
XML格式
<ClientCertRevocationList>-----BEGIN X509 CRL-----MIIB****19mg==-----END X509 CRL-----</ClientCertRevocationList> <RequestId>1AD222E9-E606-4A42-BF6D-8A4442913CEF</RequestId> <RequireUpdateItem>-</RequireUpdateItem> <CAType>aliyun</CAType> <LastModifyStatus>setting</LastModifyStatus> <ACL>cert</ACL> <RequireUpdate>Yes</RequireUpdate> <ModifyStatusReason>Modify DB Instance SSL Config.</ModifyStatusReason> <ClientCACertExpireTime>-</ClientCACertExpireTime> <ServerKey>-----BEGIN PRIVATE KEY-----MIIE****ihfg==-----END PRIVATE KEY-----</ServerKey> <SSLExpireTime>2022-05-08T08:14:16Z</SSLExpireTime> <SSLCreateTime>-</SSLCreateTime> <ServerCert>-----BEGIN CERTIFICATE-----MIID*****QqEP-----END CERTIFICATE-----</ServerCert> <SSLEnabled>on</SSLEnabled> <ClientCACert>-----BEGIN CERTIFICATE-----MIID*****viXk=-----END CERTIFICATE-----</ClientCACert> <ReplicationACL>cert</ReplicationACL> <RequireUpdateReason>-</RequireUpdateReason> <ConnectionString>rm-uf6wjk5xxxxxx.mysql.rds.aliyuncs.com</ConnectionString> <ServerCAUrl>-</ServerCAUrl>
JSON格式
{
"ClientCertRevocationList": "-----BEGIN X509 CRL-----MIIB****19mg==-----END X509 CRL-----",
"RequestId": "1AD222E9-E606-4A42-BF6D-8A4442913CEF",
"RequireUpdateItem": "-",
"CAType": "aliyun",
"LastModifyStatus": "setting",
"ACL": "cert",
"RequireUpdate": "Yes",
"ModifyStatusReason": "Modify DB Instance SSL Config.",
"ClientCACertExpireTime": "-",
"ServerKey": "-----BEGIN PRIVATE KEY-----MIIE****ihfg==-----END PRIVATE KEY-----",
"SSLExpireTime": "2022-05-08T08:14:16Z",
"SSLCreateTime": "-",
"ServerCert": "-----BEGIN CERTIFICATE-----MIID*****QqEP-----END CERTIFICATE-----",
"SSLEnabled": "on",
"ClientCACert": "-----BEGIN CERTIFICATE-----MIID*****viXk=-----END CERTIFICATE-----",
"ReplicationACL": "cert",
"RequireUpdateReason": "-",
"ConnectionString": "rm-uf6wjk5xxxxxx.mysql.rds.aliyuncs.com",
"ServerCAUrl": "-"
}
错误码
| HttpCode | 错误码 | 错误信息 | 描述 |
|---|---|---|---|
| 403 | OperationDenied.DBInstanceType | The operation is not permitted due to type of the instance. | 数据库实例类型不支持该操作。请您检查数据库实例是否为只读实例，若是只读实例不能克隆实例。 |
| 404 | InvalidDBInstanceId.NotFound | The specified instance is not found. | 实例不存在。确认该实例是在当前账号下面，确定未被删除。 |
| 400 | InvaildEngineInRegion.ValueNotSupported | The engine is not supported in the region. | 该区域不支持此引擎。 |
| 403 | IncorrectDBInstanceLockMode | Current DB instance lock mode does not support this operation. | 当前DB实例锁模式不支持此操作。 |
访问错误中心查看更多错误码。
