Cloud DB for MongoDB
- Print
- PDF
Cloud DB for MongoDB
- Print
- PDF
Article summary
Did you find this summary helpful?
Thank you for your feedback
Available in Classic and VPC
Get the list of Cloud DB for MongoDB server instances (VMs) in the VPC environment.
Request
This section describes the request format. The method and URI are as follows:
| Method | URI |
|---|---|
| GET | /api/{regionCode}-v1/vpc/servers/mongodb |
Request headers
For information about the headers common to all Cloud Log Analytics APIs, see Cloud Log Analytics request headers.
Request path parameters
You can use the following path parameters with your request:
| Field | Type | Required | Description |
|---|---|---|---|
regionCode | String | Required | Region code
|
Request query parameters
You can use the following path parameters with your request:
| Field | Type | Required | Description |
|---|---|---|---|
pageNo | Integer | Optional | Page number
|
pageSize | Integer | Optional | Number of items per page
|
Request example
The request example is as follows:
curl --location --request GET 'https://cloudloganalytics.apigw.ntruss.com/api/{regionCode}-v1/vpc/servers/mongodb' \
--header 'x-ncp-apigw-timestamp: {Timestamp}' \
--header 'x-ncp-iam-access-key: {Access Key}' \
--header 'x-ncp-apigw-signature-v2: {API Gateway Signature}' \
--header 'Content-Type: application/json' \
Response
This section describes the response format.
Response body
The response body includes the following data:
| Field | Type | Required | Description |
|---|---|---|---|
code | Integer | - | Response status codes |
message | String | - | Response status message |
result | Object | - | Response result |
result.pageSize | Integer | - | Number of items per page |
result.currentPage | Integer | - | Current page number |
result.totalPage | Integer | - | Total number of pages |
result.totalCount | Integer | - | Total item count |
result.isPaged | Boolean | - | Whether to page
|
result.dbServers | Array | - | Server list
|
Note
For more information about the fields related to server information (dbServers), see the Cloud DB for MongoDB API Guide and Cloud DB for MongoDB User Guide.
Response status codes
For response status codes common to all Cloud Log Analytics APIs, see Cloud Log Analytics response status codes.
Response example
The response example is as follows:
{
"code": 0,
"message": "The request has been successfully processed.",
"result": {
"pageSize": 10,
"currentPage": 1,
"totalPage": 1,
"totalCount": 4,
"isPaged": true,
"dbServers": [
{
"standbyMasterServerName": null,
"dbServerName": "mg-testmong-ab001-62v9",
"databaseProductCode": null,
"db_svr_rank": 0,
"cloudDbServiceName": "testmong",
"dataStorageTypeCode": null,
"dataStorageSize": 10,
"dataStorageSizeStr": "10GB",
"dbInstanceNo": 0,
"memorySize": "4GB",
"dbStatusName": null,
"clusterStatusName": null,
"serverInstanceNo": 0,
"dbServerIpAddress": null,
"cpuCount": 2,
"roleCode": null,
"dbServerRoleCode": null,
"dbServerType": "[High CPU] 2vCPU, 4GB Mem",
"usedDataStorageSize": 0,
"uuid": "*-**-********-*****-****",
"dbStatusNameValue": "creating",
"dbStatusNameColor": "yellow",
"dbServerRoleValue": "arbiter",
"zoneNo": null,
"zoneName": null
},
{
"standbyMasterServerName": null,
"dbServerName": "mg-testmong-mb001-62v6",
"databaseProductCode": null,
"db_svr_rank": 0,
"cloudDbServiceName": "testmong",
"dataStorageTypeCode": null,
"dataStorageSize": 10,
"dataStorageSizeStr": "10GB",
"dbInstanceNo": 0,
"memorySize": "8GB",
"dbStatusName": null,
"clusterStatusName": null,
"serverInstanceNo": 0,
"dbServerIpAddress": null,
"cpuCount": 2,
"roleCode": null,
"dbServerRoleCode": null,
"dbServerType": "[Standard] 2vCPU, 8GB Mem",
"usedDataStorageSize": 0,
"uuid": "*-**-********-*****-****",
"dbStatusNameValue": "creating",
"dbStatusNameColor": "yellow",
"dbServerRoleValue": "member",
"zoneNo": null,
"zoneName": null
},
{
"standbyMasterServerName": null,
"dbServerName": "mg-testmong-mb001-62v7",
"databaseProductCode": null,
"db_svr_rank": 0,
"cloudDbServiceName": "testmong",
"dataStorageTypeCode": null,
"dataStorageSize": 10,
"dataStorageSizeStr": "10GB",
"dbInstanceNo": 0,
"memorySize": "8GB",
"dbStatusName": null,
"clusterStatusName": null,
"serverInstanceNo": 0,
"dbServerIpAddress": null,
"cpuCount": 2,
"roleCode": null,
"dbServerRoleCode": null,
"dbServerType": "[Standard] 2vCPU, 8GB Mem",
"usedDataStorageSize": 0,
"uuid": "*-**-********-*****-****",
"dbStatusNameValue": "creating",
"dbStatusNameColor": "yellow",
"dbServerRoleValue": "member",
"zoneNo": null,
"zoneName": null
},
{
"standbyMasterServerName": null,
"dbServerName": "mg-testmong-mb001-62v8",
"databaseProductCode": null,
"db_svr_rank": 0,
"cloudDbServiceName": "testmong",
"dataStorageTypeCode": null,
"dataStorageSize": 10,
"dataStorageSizeStr": "10GB",
"dbInstanceNo": 0,
"memorySize": "8GB",
"dbStatusName": null,
"clusterStatusName": null,
"serverInstanceNo": 0,
"dbServerIpAddress": null,
"cpuCount": 2,
"roleCode": null,
"dbServerRoleCode": null,
"dbServerType": "[Standard] 2vCPU, 8GB Mem",
"usedDataStorageSize": 0,
"uuid": "*-**-********-*****-****",
"dbStatusNameValue": "creating",
"dbStatusNameColor": "yellow",
"dbServerRoleValue": "member",
"zoneNo": null,
"zoneName": null
}
]
}
}
Was this article helpful?