# Get Replica Set/Shard Cluster List - ListUMongoDBInstances

## Overview

Get Replica Set/Shard Cluster List






## Definition

### Public Parameters

| Parameter Name | Type | Description Information | Required |
|:---|:---|:---|:---|
| **Action**     | string  | Corresponding API command name, the current API is `ListUMongoDBInstances`.                      | **Yes** |
| **PublicKey**  | string  | The user's public key can be obtained from [Console](https://console.dezai.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|
| **ClusterId** | string | Cluster ID |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[[*MongodbInstance*](#mongodbinstance)] | Replica Set ID |No|

#### Data Model


#### MongodbInstance

| Field Name | Type | Description Information | Required |
|:---|:---|:---|:---|
| **Zone** | string | Availability Zone |**Yes**|
| **ClusterId** | string | Replica Set/Shard Cluster ID |**Yes**|
| **Name** | string | Replica Set/Sharded Cluster Instance Name |**Yes**|
| **DBVersion** | string | Versions of Mongodb for Replica Set/Sharded Cluster, including MongoDB-3.6, MongoDB-4.2 |**Yes**|
| **ConnectURL** | string | Access address of the replica set/sharded cluster |**Yes**|
| **CreateTime** | int | Creation time of replica set/sharded cluster |**Yes**|
| **ClusterType** | string | Cluster Type, ReplicaSet: Replica Set, SharedCluster: Sharded Cluster |**Yes**|
| **State** | string | Replica Set/Sharded Cluster Status Markers Initing: Initializing, InitFailed: Installation Failed, Starting: Starting Up, StartFailed: Startup Failed, Running: Running, Stopping: Shutting Down, Stopped: Shut Down, StopFailed: Shutdown Failed, Deleting: Deleting, Deleted: Deleted, DeleteFailed: Deletion Failed, Restarting: Restarting, RestartFailed: Restart Failed, Upgrading: Upgrading/Downgrading, UpgradeFailed: Upgrade/Downgrade Failed, Switching: Master-Slave Switching |**Yes**|
| **IPv6ConnectURL** | string | Replica Set/Shard Set IPv6 Access Address |No|
| **ExpiredTime** | int | Expiration time of the DB instance, using UTC timestamp |No|
| **DataComputeType** | [*MongodbMachineType*](#mongodbmachinetype) | Data Node Calculation Specifications |No|
| **VPCId** | string | ID of VPC |No|
| **SubnetId** | string | Subnet ID |No|
| **DiskSpace** | int | Data Node Disk Space (GB) |No|
| **Tag** | string | Business Group |No|
| **CrossZones** | array[string] | Cross Zone List |No|

#### MongodbMachineType

| Field Name | Type | Description Information | Required |
|:---|:---|:---|:---|
| **MachineTypeId** | string | Machine type ID o.mongo2m.medium, o.mongo2m.xlarge |**Yes**|
| **Description** | string | Configuration Abbreviation 2C4G |**Yes**|
| **Cpu** | int | CPU Cores |**Yes**|
| **Memory** | int | Memory Usage (GB) |**Yes**|
| **UHhostMachineType** | string | Machine Type, N/O |No|
| **Group** | string | Configuration Group, 2m, 4m |No|

## Example

### Request Example
    
```
https://api.dezai.com/?Action=ListUMongoDBInstances
&Region=cn-zj
&ProjectId=OEEeTdSt
&ClusterId=PYMePPwV
&ClusterId=RlOyJXoF
```

### Response Example
    
```json
{
  "Action": "ListUMongoDBInstancesResponse",
  "ClusterId": "wWvPiKMh",
  "Message": "IToGkbMD",
  "RetCode": 0
}
```