# ListUDBInstanceFailoverRecord - ListUDBInstanceFailoverRecord

## Overview

Get Instance Disaster Recovery Record List






## Definition

### Public Parameters

| Parameter Name | Type | Description Information | Required |
|:---|:---|:---|:---|
| **Action**     | string  | Corresponding API command name, the current API is `ListUDBInstanceFailoverRecord`.                      | **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 [Region and Zone List](/docs/api/summary/regionlist) |**Yes**|
| **Zone** | string | Zone. See [Region and Zone List](/docs/api/summary/regionlist) |**Yes**|
| **ProjectId** | string | Project ID. Leave it blank for the default project. Sub-accounts must fill in. Please refer to the [GetProjectList API](/docs/api/summary/get_project_list) |No|
| **DBId** | string | instance id |**Yes**|
| **StartTime** | int | start time |**Yes**|
| **EndTime** | int | end time |**Yes**|

### 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[[*FailoverRecord*](#failoverrecord)] | failover record list |**Yes**|

#### Data Model


#### FailoverRecord

| Field Name | Type | Description Information | Required |
|:---|:---|:---|:---|
| **SessionId** | string | SessionId |No|
| **FailoverType** | int | FailoverType |No|
| **StartTime** | int | StartTime |No|
| **EndTime** | int | EndTime |No|
| **FailoverState** | string | FailoverState |No|

## Example

### Request Example
    
```
https://api.scloudsg.com/?Action=ListUDBInstanceFailoverRecord
&Region=cn-zj
&Zone=cn-zj-01
&ProjectId=YGOCONuQ
&DBId=ILWzMXLU
&StartTime=1
&EndTime=1
```

### Response Example
    
```json
{
  "Action": "ListUDBInstanceFailoverRecordResponse",
  "Dataset": [
    {
      "EndTime": 4,
      "FailoverState": "KAZRYsrM",
      "FailoverType": 5,
      "SessionId": "MsctzLfl",
      "StartTime": 6
    }
  ],
  "Message": "gPrdRItY",
  "RetCode": 0
}
```