Obtaining the Secret Rotation Function Template

This API is used to obtain the secret rotation function template.

For details, see Calling APIs.

Each account has all the permissions required to call all APIs, but IAM users must be assigned the required permissions.

If you are using role/policy-based authorization, see Permissions Policies and Supported Actions for details on the required permissions.
If you are using identity policy-based authorization, no identity policy-based permission required for calling this API.

GET /v1/csms/function-templates

**Table 1** Query Parameters
Parameter	Mandatory	Type	Description
secret_type	Yes	String	Definition Secret type Constraints N/A Range RDS-FG: RDS secret. GaussDB-FG: GaussDB secret. Default Value N/A
secret_sub_type	Yes	String	Definition Secret rotation account type Constraints SingleUser: single-user rotation MultiUser: dual-user rotation Range N/A Default Value N/A
engine	No	String	Definition Database type Constraints 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. Range N/A Default Value N/A

**Table 2** Request header parameters
Parameter	Mandatory	Type	Description
X-Auth-Token	Yes	String	Definition User token. It can be obtained by calling the IAM API. The value of X-Subject-Token in the response header is the user token. This parameter is optional if AK/SK authentication is used. Constraints N/A Range Obtain the value by calling the IAM API for obtaining the user token. Default Value N/A

Status code: 200

**Table 3** Response body parameters
Parameter	Type	Description
function_templates	String	Definition Secret rotation function template Range N/A

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.

Thank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.

The system is busy. Please try again later.

For any further questions, feel free to contact us through the chatbot.