查询RDS实例透明数据加密TDE状态
更新时间 2025-09-23 17:50:50
最近更新时间: 2025-09-23 17:50:50
接口功能介绍
查询RDS实例透明数据加密TDE状态
接口约束
无
URI
GET /RDS2/v1/open-api/kmsproxy/status
路径参数 无
Query参数
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
outerProdInstId | 是 | String | 实例id | eddf4d2c6d67407ba39e3453ee0776ca |
请求参数
请求头header参数
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
project-id | 否 | String | 项目id | b829cb71308746a094853c21d5aac0a1 | |
inst-id | 否 | String | 实例id (和参数outerProdInstId保持一致) | 264729201196525109 | |
regionId | 是 | String | 资源池regionId,比如实例在资源池A,则需要填写A资源池的regionId。 | 81f7728662dd11ec810800155d307d5b |
请求体body参数 无
响应参数
参数 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|
statusCode | Integer | 返回码 取值范围:0 成功; 2001 参数异常;3001 业务异常;5001 请求响应失败 | 0 | |
message | String | 返回信息 | success | |
error | String | 错误码。当接口失败时才返回具体错误编码,成功不返回或者为空 | MYSQL_10001 | |
returnObj | Object | returnObj | returnObj | |
表 returnObj |
参数 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|
tdeStatus | Integer | 0-开启透明加密,2-关闭透明加密 | ||
uuid | String | 密钥uuid |
枚举参数
无
请求示例
请求url
/RDS2/v1/open-api/kmsproxy/status?outerProdInstId=b829cb71308746a094853c21d5aac0a1
请求头header
无
请求体body
无
响应示例
{
"statusCode": 0,
"message": "success",
"returnObj": {
"tdeStatus": "0",
"uuid": "b829cb71308746a094853c21d5aac0a1"
}
}
状态码
请参考 状态码
错误码
请参考 错误码