# Obtain Database Log - ListUPgSQLLog

## Overview

Obtain Database Log






## Definition

### Public Parameters

| Parameter Name | Type | Description Information | Required |
|:---|:---|:---|:---|
| **Action**     | string  | Corresponding API command name, the current API is `ListUPgSQLLog`.                      | **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) |**Yes**|
| **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|
| **BeginTime** | int | Timestamp of the beginning of the log query |**Yes**|
| **EndTime** | int | End timestamp of log query |**Yes**|
| **InstanceID** | string | Resource ID |**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[[*LogSet*](#logset)] | Database Log Information List |**Yes**|

#### Data Model


#### LogSet

| Field Name | Type | Description Information | Required |
|:---|:---|:---|:---|
| **BeginTime** | int |  |No|
| **EndTime** | int |  |No|
| **Name** | string |  |No|
| **Size** | int |  |No|

## Example

### Request Example
    
```
https://api.scloudsg.com/?Action=ListUPgSQLLog
&Region=cn-zj
&Zone=cn-zj-01
&ProjectId=FkcfKEtL
&BeginTime=4
&EndTime=3
&InstanceID=tcXRoalT
```

### Response Example
    
```json
{
  "Action": "ListUPgSQLLogResponse",
  "DataSet": [
    {
      "BeginTime": 2,
      "EndTime": 5,
      "Name": "jQCYvUEY",
      "Size": 7
    }
  ],
  "Message": "MaECSfSr",
  "RetCode": 0
}
```