Call the CloneDatabase API to clone an existing database.

Request type

Asynchronous request.

Precautions

A maximum of 2,000 databases can be created under one instance. When the number of database instances has reached 2,000, the database cannot be cloned.

During the process of cloning a database, you cannot perform DDL operations on the database.

Debug

API Explorer

You can initiate calls online through API Explorer without paying attention to the signature generation process and quickly obtain the call results.

Request parameters

Parameter	Type	Required?	Example	Description
InstanceId	String	Yes	postgres-a3e7eb2f****	Instance ID.
SourceDBName	String	Yes	database	Source database name.
NewDBName	String	No	database_clone	Set the name of the new database. The Database name must follow these rules: The name is unique within the instance. The name length is limited to 2–63 characters. The name must start with a letter and end with a letter or a digit. It consists of letters, digits, underscores (_), or hyphens (-). Some reserved words or keywords cannot be used in the database name. Refer to Reserved keywords for all reserved keywords. tip If not set, the new database is named by default with the source database name + _clone_ + timestamp.
DataOption	String	No	Metadata	Currently, only cloning the database structure is supported, and the value must be set to Metadata.
PLPGSQLOption	String	No	View,Procedure	PL/pgSQL options for cloning a database. Multiple values are allowed, separated by commas (,). Views: views. Stored procedures: stored procedures. Functions: functions. Triggers: triggers.

Response parameter

null

Sample

Sample request

Sample response