调用DescribeDBInstanceSSL接口查询实例SSL设置。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
请求参数
名称 | 类型 | 是否必选 | 示例值 | 描述 |
---|---|---|---|---|
Action | String | 是 | DescribeDBInstanceSSL |
系统规定参数。取值:DescribeDBInstanceSSL。 |
DBInstanceId | String | 是 | rm-bp162dfr55g47**** |
实例ID。 |
返回数据
名称 | 类型 | 示例值 | 描述 |
---|---|---|---|
ServerCert | String | -----BEGIN CERTIFICATE-----MIID*****QqEP-----END CERTIFICATE----- |
该参数仅RDS PostgreSQL云盘版支持,表示服务器证书内容。 |
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 | -----BEGIN X509 CRL-----MIIB****19mg==-----END X509 CRL----- |
该参数仅RDS PostgreSQL云盘版支持,表示客户端吊销证书文件。 |
SSLExpireTime | String | 2022-10-11T08:16:43Z |
SSL证书有效期。格式:yyyy-MM-ddTHH:mm:ssZ(UTC时间)。 |
CAType | String | aliyun |
该参数仅RDS PostgreSQL云盘版支持,表示服务器证书类型,取值包括:
|
SSLCreateTime | String | - |
该参数仅RDS PostgreSQL云盘版支持,表示服务器证书创建时间,当配置为使用云证书时有效。 |
ReplicationACL | String | cert |
该参数仅RDS PostgreSQL云盘版支持,表示replication权限的认证方法。取值包括:
|
ACL | String | cert |
该参数仅RDS PostgreSQL云盘版支持,表示认证方法,取值包括:
|
RequestId | String | 7705151C-E242-55AF-9929-2A3C39D979D2 |
请求ID。 |
LastModifyStatus | String | setting |
该参数仅RDS PostgreSQL云盘版支持,表示当前SSL链路配置状态。取值:
|
SSLEnabled | String | Yes |
SSL状态。
|
ConnectionString | String | rm-bp162dfr55g47****.mysql.rds.aliyuncs.com |
受SSL保护的连接地址。 |
RequireUpdateReason | String | - |
该参数仅RDS PostgreSQL云盘版支持,表示需要更新证书的原因。 |
ClientCACert | String | -----BEGIN CERTIFICATE-----MIID*****viXk=-----END CERTIFICATE----- |
该参数仅RDS PostgreSQL云盘版支持,表示客户端证书授权机构公钥。 |
ServerKey | String | -----BEGIN PRIVATE KEY-----MIIE****ihfg==-----END PRIVATE KEY----- |
该参数仅RDS PostgreSQL云盘版支持,表示服务器证书私钥。 |
ModifyStatusReason | String | Modify DB Instance SSL Config. |
该参数仅RDS PostgreSQL云盘版支持,表示当前SSL链路配置状态对应的原因。 |
示例
请求示例
http(s)://rds.aliyuncs.com/?Action=DescribeDBInstanceSSL
&DBInstanceId=rm-bp162dfr55g47****
&<公共请求参数>
正常返回示例
XML
格式
HTTP/1.1 200 OK
Content-Type:application/xml
<DescribeDBInstanceSSL>
<RequestId>7705151C-E242-55AF-9929-2A3C39D979D2</RequestId>
<RequireUpdate>Yes</RequireUpdate>
<SSLExpireTime>2022-10-11T08:16:43Z</SSLExpireTime>
<SSLEnabled>Yes</SSLEnabled>
<RequireUpdateReason/>
<ConnectionString>rm-bp162dfr55g47****.mysql.rds.aliyuncs.com</ConnectionString>
</DescribeDBInstanceSSL>
JSON
格式
HTTP/1.1 200 OK
Content-Type:application/json
{
"RequestId" : "7705151C-E242-55AF-9929-2A3C39D979D2",
"RequireUpdate" : "Yes",
"SSLExpireTime" : "2022-10-11T08:16:43Z",
"SSLEnabled" : "Yes",
"RequireUpdateReason" : "",
"ConnectionString" : "rm-bp162dfr55g47****.mysql.rds.aliyuncs.com"
}
错误码
HttpCode | 错误码 | 错误信息 | 描述 |
---|---|---|---|
400 | InvaildEngineInRegion.ValueNotSupported | The engine is not supported in the region. | 数据库版本不正确。 |
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. | 连接串不存在。请检查连接串是否正确。 |
访问错误中心查看更多错误码。