# DescribeUDBBinlogBackup - DescribeUDBBinlogBackup

## Overview

List UDB Instance Binlog Automatic Backup Information

 > 💡 The new version (NVMe type) MongoDB/PostgreSQL is not supported. For the new version (NVMe type) MongoDB/PostgreSQL, please use the API of the corresponding product.




## Definition

### Public Parameters

| Parameter Name | Type | Description Information | Required |
|:---|:---|:---|:---|
| **Action**     | string  | Corresponding API command name, the current API is `DescribeUDBBinlogBackup`.                      | **Yes** |
| **PublicKey**  | string  | The user's public key can be obtained from [Console](https://console.genesissai.com/uaccount/api_manage)                                             | **Yes** |
| **Signature**  | string  | User signature generated based on public key and API command, see [Signature Algorithm](/docs/api/summary/signature.md)  | **Yes** |

### Request Parameters

| Parameter Name | Type | Description Information | Required |
|:---|:---|:---|:---|
| **Region** | string | Region. See [Region and Availability Zone List](/docs/api/summary/regionlist) |**Yes**|
| **Zone** | string | Available Zones. See the list of available zones.(/docs/api/summary/regionlist) |No|
| **ProjectId** | string | Project ID. If not filled in, the default project will be used. Sub-accounts must fill this in. Please refer to the <br />(/docs/api/summary/get_project_list) |No|
| **Offset** | int | Starting offset for paginated display, specify for list operations |**Yes**|
| **Limit** | int | Number of items displayed per page, list operations specify |**Yes**|
| **DBId** | string | DB Instance ID, if specified, only retrieves the backup information for that DB; Required when Type is 2 |No|
| **BeginTime** | int | Filter Condition: Start Time (Timestamp) |No|
| **EndTime** | int | Filter Condition: End Time (Timestamp) |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|
| **DataSet** | array[[*BinlogBackupSet*](#binlogbackupset)] | Binlog backup information. See BinlogBackupSet. |No|
| **TotalCount** | int | Total number of backups. If dbid is specified, it refers to the total number of backups for that db. |No|

#### Data Model


#### BinlogBackupSet

| Field Name | Type | Description Information | Required |
|:---|:---|:---|:---|
| **BackupId** | int | Backup ID |No|
| **BackupName** | string | Backup Name |No|
| **BackupTime** | int | Backup Time |No|
| **BackupSize** | int | Backup File Size |No|
| **State** | string | Backup Status Backuping // Backing up Success // Backup Successful Failed // Backup Failed Expired // Backup Expired |No|
| **BinlogType** | string | binlog backup type Manual: Manual backup, Auto: Automatic backup |No|
| **DBId** | string | dbid |No|
| **ServerId** | string | Node Identification ID |No|
| **LogStartTime** | int | Log Start Time |No|
| **LogEndTime** | int | Log End Time |No|

## Example

### Request Example
    
```
https://api.genesissai.com/?Action=DescribeUDBBinlogBackup
&Region=gNAvFCyO
&Zone=KDHzwwya
&ProjectId=WkNtMEyG
&Offset=8
&Limit=7
&Type=12
&Types.N=4
&DBId=RFMjcVCt
&BeginTime=4
&EndTime=7
```

### Response Example
    
```json
{
  "Action": "DescribeUDBBinlogBackupResponse",
  "DataSet": [
    {
      "BackupId": 3,
      "BackupName": "DwxKzVqP",
      "BackupSize": 3,
      "BackupTime": 5,
      "BackupType": 4,
      "BackupZone": "WpMTrrKC",
      "BinlogType": "OlcVXUHe",
      "DBId": "ARAqnTdp",
      "DBName": "fWTAzrvH",
      "State": "BjNSkrQf",
      "Zone": "mComZFLQ"
    }
  ],
  "RetCode": 0,
  "TotalCount": 8
}
```