文档首页/ 密码安全中心 DEW/ API参考/ API说明/ 凭据管理服务/ 凭据轮转管理/ 获取凭据轮转函数模板 - ShowSecretFunctionTemplates
更新时间:2025-10-16 GMT+08:00

获取凭据轮转函数模板 - ShowSecretFunctionTemplates

功能介绍

获取凭据轮转函数模板。

调用方法

请参见如何调用API

授权信息

账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限。

  • 如果使用角色与策略授权,具体权限要求请参见权限和授权项
  • 如果使用身份策略授权,当前API调用无需身份策略权限。

URI

GET /v1/csms/function-templates

表1 Query参数

参数

是否必选

参数类型

描述

secret_type

String

凭据类型。

secret_sub_type

String

凭据轮转账号类型。

  • SingleUser:单用户模式轮转

  • MultiUser:双用户模式轮转

engine

String

数据库类型。凭据类型为RDS-FG时为必填参数,可传入mysql、postgresql、sqlserver。其余凭据类型不支持。

请求参数

响应参数

状态码:200

表2 响应Body参数

参数

参数类型

描述

function_templates

String

凭据轮转函数模板。

状态码:400

表3 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误描述

状态码:401

表4 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误描述

状态码:403

表5 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误描述

状态码:404

表6 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误描述

状态码:500

表7 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误描述

状态码:502

表8 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误描述

状态码:504

表9 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误描述

请求示例

获取凭据轮转模板,获取凭据类型为RDS-FG,凭据轮转账号类型为SingleUser和数据库类型为mysql的凭据轮转模板。

/v1/csms/function-templates?secret_type=RDS-FG&secret_sub_type=SingleUser&engine=mysql

响应示例

状态码:200

请求已成功。

{
  "function_templates" : "xxxxxx"
}

状态码

状态码

描述

200

请求已成功。

400

请求参数有误

401

被请求的页面需要用户名和密码

403

认证失败

404

资源不存在,资源未找到

500

服务内部错误

502

请求未完成。服务器从上游服务器收到一个无效的响应

504

网关超时

错误码

请参见错误码