文档首页/ 数据库安全服务 DBSS/ API参考/ API说明/ 审计数据库/ 上传/更新数据库私钥 - AddDatabaseSSLKey
更新时间:2026-07-10 GMT+08:00

上传/更新数据库私钥 - AddDatabaseSSLKey

功能介绍

上传/更新数据库私钥

授权信息

账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限,具体权限要求请参见权限和授权项

URI

POST /v2/{project_id}/audit/{instance_id}/databases/{db_id}/sslkey

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

参数解释

项目ID。可通过IAM服务[查询指定IAM用户的项目列表]接口获取。

约束限制

不涉及

取值范围

以IAM服务接口返回值为准,字符长度32-64。

默认取值

不涉及

instance_id

String

参数解释

实例ID。可通过查询实例列表接口ID字段获取

约束限制

不涉及

取值范围

以查询实例列表接口值为准,字符长度32-64。

默认取值

不涉及

db_id

String

参数解释

数据库ID。可通过查询实例数据库列表接口ID字段获取

约束限制

不涉及

取值范围

以查询数据库接口值为准,字符长度16-64。

默认取值

不涉及

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

参数解释

用户Token。 通过调用IAM服务查询用户Token接口获取(响应消息头中X-Subject-Token的值)。

约束限制

不涉及

取值范围

IAM服务查询用户Token接口为准

默认取值

不涉及

表3 请求Body参数

参数

是否必选

参数类型

描述

pem_key_txt

String

私钥文本内容

响应参数

状态码:200

表4 响应Body参数

参数

参数类型

描述

result

String

操作结果

状态码:400

表5 响应Body参数

参数

参数类型

描述

details

Array of DbssErrorDetail objects

PDP5鉴权异常信息

encoded_authorization_message

String

PDP5鉴权异常信息

error_code

String

错误码

error_msg

String

错误信息

表6 DbssErrorDetail

参数

参数类型

描述

error_code

String

错误码

error_msg

String

PDP5错误信息

状态码:401

表7 响应Body参数

参数

参数类型

描述

details

Array of DbssErrorDetail objects

PDP5鉴权异常信息

encoded_authorization_message

String

PDP5鉴权异常信息

error_code

String

错误码

error_msg

String

错误信息

表8 DbssErrorDetail

参数

参数类型

描述

error_code

String

错误码

error_msg

String

PDP5错误信息

状态码:403

表9 响应Body参数

参数

参数类型

描述

details

Array of DbssErrorDetail objects

PDP5鉴权异常信息

encoded_authorization_message

String

PDP5鉴权异常信息

error_code

String

错误码

error_msg

String

错误信息

表10 DbssErrorDetail

参数

参数类型

描述

error_code

String

错误码

error_msg

String

PDP5错误信息

状态码:500

表11 响应Body参数

参数

参数类型

描述

details

Array of DbssErrorDetail objects

PDP5鉴权异常信息

encoded_authorization_message

String

PDP5鉴权异常信息

error_code

String

错误码

error_msg

String

错误信息

表12 DbssErrorDetail

参数

参数类型

描述

error_code

String

错误码

error_msg

String

PDP5错误信息

请求示例

/v2/{project_id}/audit/{instance_id}/databases/{db_id}/sslkey

{
  "pem_key_txt" : "-----BEGIN PRIVATE KEY----- XXXX -----END PRIVATE KEY-----"
}

响应示例

状态码:200

成功

{
  "result" : "success"
}

状态码

状态码

描述

200

成功

400

请求参数有误。

401

认证失败

403

未授权

500

服务端错误

错误码

请参见错误码