Get instance backup status - DescribeUDBInstanceBackupState
Overview
Get UDB Instance Backup Status
Definition
Public Parameters
Parameter Name | Type | Description Information | Required |
---|---|---|---|
Action | string | Corresponding API command name, the current API is DescribeUDBInstanceBackupState . | Yes |
PublicKey | string | The user’s public key can be obtained from Console | Yes |
Signature | string | User signature generated based on public key and API command, see Signature Algorithm | Yes |
Request Parameters
Parameter Name | Type | Description Information | Required |
---|---|---|---|
Region | string | Region. See List of Regions and Availability Zones | Yes |
Zone | string | Availability Zone. See Availability Zone List | Yes |
ProjectId | string | Project ID. If not filled in, the default project is used, and the sub-account must be filled in. Please refer to the GetProjectList interface. | No |
BackupId | int | Backup Record ID | Yes |
BackupZone | string | The translation of the given text is: """The availability zone where the high-availability standby database across availability zones is located, see [Availability Zone List] | No |
Response Field
Field Name | Type | Description Information | Required |
---|---|---|---|
RetCode | int | Return status code. If it is 0, it means successful return. If it is not 0, it means failure. | Yes |
Action | string | Operation command name. | Yes |
Message | string | Returns an error message, providing detailed description when RetCode is non-zero. | No |
State | string | Backup Status 0 Backuping // In Backup 1 Success // Backup Successful 2 Failed // Backup Failed 3 Expired // Backup Expired | No |
Example
Request Example
https://api.dezai.com/?Action=DescribeUDBInstanceBackupState
&Region=cn-bj2
&BackupId=8880
Response Example
{
"Action": "DescribeUDBInstanceBackupStateResponse",
"RetCode": 0,
"State": "2"
}