该接口用于查询RDS实例的SSL配置情况。
接口说明
适用引擎
- RDS MySQL
- RDS PostgreSQL
- RDS SQL Server
调试
您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI
Explorer可以自动生成SDK代码示例。
调试
调试
授权信息
下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：
- 操作：是指具体的权限点。
- 访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
- 资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用背景高亮的方式表示。
- 对于不支持资源级授权的操作，用
全部资源表示。
- 条件关键字：是指云产品自身定义的条件关键字。
- 关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。
| 操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
|---|---|---|---|---|
| rds:DescribeDBInstanceSSL | READ |
|
|
无 |
请求参数
| 名称 | 类型 | 必填 | 描述 | 示例值 |
|---|---|---|---|---|
| DBInstanceId | string | 是 |
实例ID。可调用DescribeDBInstances获取。 |
rm-bp162dfr55g47**** |
返回参数
| 名称 | 类型 | 描述 | 示例值 |
|---|---|---|---|
| object |
返回参数详情。 |
||
| ServerCert | string |
该参数仅适用于RDS PostgreSQL云盘版实例，表示服务器证书内容。 |
—–BEGIN CERTIFICATE—–MIID*****QqEP—–END CERTIFICATE—– |
| ClientCACertExpireTime | string |
该参数仅适用于RDS PostgreSQL云盘版实例，表示客户端证书授权机构公钥有效期。格式：yyyy-MM-ddTHH:mm:ssZ（UTC时间），暂不支持。 |
– |
| RequireUpdateItem | string |
该参数仅适用于RDS PostgreSQL云盘版实例，表示需要更新的服务器证书列表。 |
– |
| ServerCAUrl | string |
该参数仅适用于RDS PostgreSQL云盘版实例，表示签发服务器证书的CA证书URL。 |
– |
| RequireUpdate | string |
是否需要更新。
|
Yes |
| ClientCertRevocationList | string |
该参数仅适用于RDS PostgreSQL云盘版实例，表示客户端吊销证书文件。 |
—–BEGIN X509 CRL—–MIIB****19mg==—–END X509 CRL—– |
| SSLExpireTime | string |
SSL证书有效期。格式：yyyy-MM-ddTHH:mm:ssZ（UTC时间）。 |
2022-10-11T08:16:43Z |
| CAType | string |
该参数仅适用于RDS PostgreSQL云盘版实例，表示服务器证书类型，取值：
|
aliyun |
| SSLCreateTime | string |
该参数仅适用于RDS PostgreSQL云盘版实例，表示服务器证书创建时间，当配置为使用云证书时有效。 |
– |
| ReplicationACL | string |
该参数仅适用于RDS PostgreSQL云盘版实例，表示replication权限的认证方法。取值：
|
cert |
| ACL | string |
该参数仅适用于RDS PostgreSQL云盘版实例，表示认证方法，取值：
|
cert |
| RequestId | string |
请求ID。 |
7705151C-E242-55AF-9929-2A3C39D979D2 |
| LastModifyStatus | string |
该参数仅适用于RDS PostgreSQL云盘版实例，表示当前SSL链路配置状态。取值：
|
setting |
| SSLEnabled | string |
SSL状态。
|
Yes |
| ConnectionString | string |
受SSL保护的连接地址。 |
rm-bp162dfr55g47****.mysql.rds.aliyuncs.com |
| RequireUpdateReason | string |
该参数仅适用于RDS PostgreSQL云盘版实例，表示需要更新证书的原因。 |
– |
| ClientCACert | string |
该参数仅适用于RDS PostgreSQL云盘版实例，表示客户端证书授权机构公钥。 |
—–BEGIN CERTIFICATE—–MIID*****viXk=—–END CERTIFICATE—– |
| ServerKey | string |
该参数仅适用于RDS PostgreSQL云盘版实例，表示服务器证书私钥。 |
—–BEGIN PRIVATE KEY—–MIIE****ihfg==—–END PRIVATE KEY—– |
| ModifyStatusReason | string |
该参数仅适用于RDS PostgreSQL云盘版实例，表示当前SSL链路配置状态对应的原因。 |
Modify DB Instance SSL Config. |
示例
正常返回示例
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."
}错误码
| HTTP status code | 错误码 | 错误信息 | 描述 |
|---|---|---|---|
| 400 | InvaildEngineInRegion.ValueNotSupported | The engine is not supported in the region. | 数据库版本不正确。 |
| 400 | InvalideStatus.Format | Specified Status is not valid. | – |
| 403 | OperationDenied.DBInstanceType | The operation is not permitted due to type of the instance. | 操作失败，只读实例不支持克隆。请检查实例类型。 |
| 403 | InstanceEngineType.NotSupport | The instance engine and type does not support operations | 操作失败，实例引擎和类型不支持该操作。 |
| 403 | IncorrectEngineVersion | Current engine version does not support operations. | 操作失败，当前数据库版本不支持此操作。 |
| 403 | IncorrectDBInstanceState | Current DB instance state does not support this operation. | 当前实例状态不支持此操作。 |
| 403 | IncorrectDBInstanceType | Current DB instance type does not support this operation. | 操作失败，该实例状态下不支持此操作。 |
| 403 | IncorrectDBInstanceLockMode | Current DB instance lock mode does not support this operation. | 操作失败，实例处于锁定状态。 |
| 403 | ConnectionStringLengthExceeded | Connection String is too long. | 连接字符串太长，请修改后重试。 |
| 404 | InvalidDBInstanceId.NotFound | The specified instance is not found. | 实例不存在。请确认该实例是否在当前账号下。 |
| 404 | EnabledSSLNotSupport | Specified region does not support enable ssl. | 指定的区域不支持启用SSL服务。 |
| 404 | InvalidConnectionString.NotFound | Specified connection string or net type is not found. | 连接串不存在。请检查连接串是否正确。 |
访问错误中心查看更多错误码。
变更历史
| 变更时间 | 变更内容概要 | 操作 | ||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|
| 2022-06-23 | OpenAPI 描述信息更新，OpenAPI 错误码发生变更 | 看变更集 | ||||||||||
|
内容没看懂？ 不太想学习？想快速解决？ 有偿解决： 联系专家
阿里云企业补贴进行中： 马上申请
腾讯云限时活动1折起，即将结束： 马上收藏
同尘科技为腾讯云授权服务中心。
购买腾讯云产品享受折上折，更有现金返利:同意关联，立享优惠
转转请注明出处：https://www.yunxiaoer.com/154146.html