获取凭据轮转函数模板 - ShowSecretFunctionTemplates
功能介绍
获取凭据轮转函数模板。
调用方法
请参见如何调用API。
授权信息
账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。
- 如果使用角色与策略授权，具体权限要求请参见权限和授权项。
- 如果使用身份策略授权，当前API调用无需身份策略权限。
URI
GET /v1/csms/function-templates
参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
secret_type | 是 | String | 凭据类型。 |
secret_sub_type | 是 | String | 凭据轮转账号类型。
|
engine | 否 | String | 数据库类型。凭据类型为RDS-FG时为必填参数，可传入mysql、postgresql、sqlserver。其余凭据类型不支持。 |
请求参数
无
响应参数
状态码：200
参数 | 参数类型 | 描述 |
|---|---|---|
function_templates | String | 凭据轮转函数模板。 |
状态码：400
参数 | 参数类型 | 描述 |
|---|---|---|
error_code | String | 错误码 |
error_msg | String | 错误描述 |
状态码：401
参数 | 参数类型 | 描述 |
|---|---|---|
error_code | String | 错误码 |
error_msg | String | 错误描述 |
状态码：403
参数 | 参数类型 | 描述 |
|---|---|---|
error_code | String | 错误码 |
error_msg | String | 错误描述 |
状态码：404
参数 | 参数类型 | 描述 |
|---|---|---|
error_code | String | 错误码 |
error_msg | String | 错误描述 |
状态码：500
参数 | 参数类型 | 描述 |
|---|---|---|
error_code | String | 错误码 |
error_msg | String | 错误描述 |
状态码：502
参数 | 参数类型 | 描述 |
|---|---|---|
error_code | String | 错误码 |
error_msg | String | 错误描述 |
状态码：504
参数 | 参数类型 | 描述 |
|---|---|---|
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 | 网关超时 |
错误码
请参见错误码。
