Obtaining the Secret Rotation Function Template

Obtain the secret rotation function template.

For details, see Calling APIs.

GET /v1/csms/function-templates

**Table 1** Query Parameters
Parameter	Mandatory	Type	Description
secret_type	Yes	String	Secret type
secret_sub_type	Yes	String	Secret rotation account type SingleUser: single-user rotation MultiUser: dual-user rotation
engine	No	String	Database type. This parameter is mandatory if the secret type is RDS-FG. The value can be mysql, postgresql, or sqlserver. Other secret types are not supported.

None

Status code: 200

**Table 2** Response body parameters
Parameter	Type	Description
function_templates	String	Secret rotation function template

Status code: 400

**Table 3** Response body parameters
Parameter	Type	Description
error_code	String	Error codes
error_msg	String	Error description

Status code: 401

**Table 4** Response body parameters
Parameter	Type	Description
error_code	String	Error codes
error_msg	String	Error description

Status code: 403

**Table 5** Response body parameters
Parameter	Type	Description
error_code	String	Error codes
error_msg	String	Error description

Status code: 404

**Table 6** Response body parameters
Parameter	Type	Description
error_code	String	Error codes
error_msg	String	Error description

Status code: 500

**Table 7** Response body parameters
Parameter	Type	Description
error_code	String	Error codes
error_msg	String	Error description

Status code: 502

**Table 8** Response body parameters
Parameter	Type	Description
error_code	String	Error codes
error_msg	String	Error description

Status code: 504

**Table 9** Response body parameters
Parameter	Type	Description
error_code	String	Error codes
error_msg	String	Error description

Obtain the rotation template of RDS-FG secrets. The account type is SingleUser and the database type is mysql.

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

Status code: 200

Request succeeded.

{
  "function_templates" : "xxxxxx"
}

Status Code	Description
200	Request succeeded.
400	Invalid request parameter.
401	Username and password are required for the requested page.
403	Authentication failed.
404	The resource does not exist.
500	Internal service error.
502	Request failed. The server has received an invalid response.
504	Gateway timed out.

Thank you very much for your feedback. We will continue working to improve the documentation.

The system is busy. Please try again later.