# Backup UDB binlog list for a specified time period - BackupUDBInstanceBinlog

## Overview

Backup UDB binlog list for a specified time period






## Definition

### Public Parameters

| Parameter Name | Type | Description Information | Required |
|:---|:---|:---|:---|
| **Action**     | string  | Corresponding API command name, the current API is `BackupUDBInstanceBinlog`.                      | **Yes** |
| **PublicKey**  | string  | The user's public key can be obtained from [Console](https://console.scloudsg.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 [List of Regions and Availability Zones](/docs/api/summary/regionlist) |**Yes**|
| **Zone** | string | Availability Zone. See [Availability Zone List](/docs/api/summary/regionlist) |No|
| **ProjectId** | string | Project ID. If not filled in, the default project is used, sub-accounts must be filled in. Please refer to the [GetProjectList interface](/docs/api/summary/get_project_list). |No|
| **DBId** | string | DB Instance Id, this value can be obtained through DescribeUDBInstance |**Yes**|
| **BackupFile** | string | If you need to backup files, you can obtain them through DescribeUDBInstanceBinlog. If you want to input multiple file names, separate them with a space and enclose them in single quotes. |**Yes**|
| **BackupName** | string | DB Backup File Name |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|




## Example

### Request Example
    
```
https://api.scloudsg.com/?Action=BackupUDBInstanceBinlog
&Region=cn-bj2
&DBId=udbha-xxxxxx
&BackupFile: mysql-bin.000001 mysql-bin.000002;
```

### Response Example
    
```json
{
  "Action": "BackupUDBInstanceBinlogResponse",
  "RetCode": 0
}
```