List Database Nodes

GET

/dbaas/{managed_db_id}/instances/

curl --request GET \
  --url 'https://api.e2enetworks.com/myaccount/api/v1/gpu/dbaas/{managed_db_id}/instances/?project_id=<PROJECT_ID>&location=<LOCATION>&apikey=<API_KEY>' \
  --header 'Authorization: Bearer <API_TOKEN>'

Returns the database’s nodes with their addresses. A database has one node, the primary. The list is empty when the nodes cannot be read. The database must be Running. Needs the Read permission on DBaaS.

Parameters

Path Parameters

managed_db_id

required

integer

Database ID

Query Parameters

project_id

required

integer

Project ID

active_iam

integer

Active IAM ID (To access contact person account) Find your Active IAM ID here

location

required

string

Allowed values: Delhi Chennai

Location

Responses

200

The nodes

Media typeapplication/json

object

code

integer

message

string

data

The node list, under its own data.

object

status

integer

data

Array<object>

object

name

The node’s name: pg- and the database ID.

string

role

string

private_ip

string

public_ip

Empty when the node has no public address.

string

status

string

vpc_ip

The node’s VPC address. Present only when a VPC is attached.

string

nullable

errors

object

log

string

success

boolean

errors

object

Example

{
  "code": 200,
  "message": "Success",
  "data": {
    "status": 200,
    "data": [
      {
        "name": "pg-123",
        "role": "primary",
        "private_ip": "10.0.4.17",
        "public_ip": "203.0.113.25",
        "status": "running",
        "vpc_ip": "10.10.0.12"
      }
    ],
    "errors": {},
    "log": "Success",
    "success": true
  },
  "errors": {}
}

400

The project ID is missing or is not a number.

Media typeapplication/json

object

code

integer

message

string

data

object

errors

string

Example

{
  "code": 400,
  "message": "Bad Request",
  "data": {},
  "errors": "Project ID is missing or invalid"
}

403

The caller lacks the permission the call needs on the project, or the region is not allowed.

Media typeapplication/json

object

code

integer

message

string

data

object

errors

string

Example

{
  "code": 403,
  "message": "Forbidden",
  "data": {},
  "errors": "You don't have permission to access this service. Please verify your policy or project."
}

404

No database with that ID in the project and region.

Media typeapplication/json

object

code

integer

message

string

data

object

errors

string

Example

{
  "code": 404,
  "message": "Bad Request",
  "data": {},
  "errors": "Invalid request! Database Not Found"
}

412

The database is not Running (“Database NOT in RUNNING state. Please try again later.”), or the nodes could not be read (“Error occurred at backend! Please try after sometime.”).

Media typeapplication/json

object

code

integer

message

string

data

object

errors

string

Example

{
  "code": 412,
  "message": "Precondition Failed",
  "data": {},
  "errors": "Database NOT in RUNNING state. Please try again later."
}