Creates a backup for a PolarDB-X instance.
Debugging
Request parameters
Parameter | Type | Required | Example | Description |
---|---|---|---|---|
Action | String | Yes | CreateBackup |
The operation that you want to perform. Set the value to CreateBackup. |
RegionId | String | Yes | cn-hangzhou |
The ID of the region where the PolarDB-X instance is deployed. |
DBInstanceName | String | Yes | pxc-************** |
The name of the PolarDB-X instance. |
BackupType | String | No | 0 |
The type of the backup. Valid values: 0. The value 0 specifies fast backup. |
Response parameters
Parameter | Type | Example | Description |
---|---|---|---|
Message | String | ***** |
The message that is returned. If the request is successful, "success" is returned. If the request fails, an error code is returned. |
RequestId | String | 9B2F3840-5C98-475C-B269-2D5C3A31797C |
The ID of the request. |
Success | Boolean | true |
Indicates whether the request is successful. |
Data | Array of Account | ||
BackupSetId | Long | 627833 |
The ID of the backup set. |
Examples
Sample requests
http(s)://[Endpoint]/?Action=CreateBackup
&RegionId=cn-hangzhou
&DBInstanceName=pxc-**************
&BackupType=0
&<Common request parameters>
Sample success responses
XML
format
HTTP/1.1 200 OK
Content-Type:application/xml
<CreateBackupResponse>
<Message>*****</Message>
<RequestId>9B2F3840-5C98-475C-B269-2D5C3A31797C</RequestId>
<Success>true</Success>
<Data>
<BackupSetId>627833</BackupSetId>
</Data>
</CreateBackupResponse>
JSON
format
HTTP/1.1 200 OK
Content-Type:application/json
{
"Message" : "*****",
"RequestId" : "9B2F3840-5C98-475C-B269-2D5C3A31797C",
"Success" : true,
"Data" : [ {
"BackupSetId" : 627833
} ]
}
Error codes
For a list of error codes, visit the API Error Center.