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

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

功能介绍

获取凭据轮转函数模板

调用方法

请参见如何调用API

授权信息

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

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

URI

GET /v1/csms/function-templates

表1 Query参数

参数

是否必选

参数类型

描述

secret_type

String

参数解释:

凭据类型

约束限制:

不涉及

取值范围:

  • RDS-FG: RDS数据库凭据类型

  • GaussDB-FG:Gauss数据库凭据类型

默认取值:

不涉及

secret_sub_type

String

参数解释:

凭据轮转账号类型

约束限制:

  • SingleUser:单用户模式轮转

  • MultiUser:双用户模式轮转

取值范围:

不涉及

默认取值:

不涉及

engine

String

参数解释:

数据库类型

约束限制:

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

取值范围:

不涉及

默认取值:

不涉及

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

参数解释:

用户Token。 通过调用IAM服务查询用户Token接口获取(响应消息头中X-Subject-Token的值)。使用AK、SK等认证方式,此处非必选

约束限制:

不涉及

取值范围:

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

默认取值:

不涉及

响应参数

状态码:200

表3 响应Body参数

参数

参数类型

描述

function_templates

String

参数解释:

凭据轮转函数模板

取值范围:

不涉及

请求示例

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

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

响应示例

状态码:200

请求已成功

{
  "function_templates" : "xxxxxx"
}

状态码

状态码

描述

200

请求已成功

错误码

请参见错误码

相关文档