Help Center> Distributed Database Middleware> API Reference> APIs for Managing DDM Instances> Querying Details of a DDM Instance
View PDF

Querying Details of a DDM Instance

Function

This API is used to query the details about a DDM instance.

URI

GET /v1/{project_id}/instances/{instance_id}

Table 1 Parameter description

Parameter

Mandatory

Description

project_id

Yes

Project ID of a tenant in a region

instance_id

Yes

DDM instance ID

Request

Request parameters

None

Response

Response parameters

Table 2 Parameter description

Parameter

Type

Mandatory

Description

id

String

true

DDM instance ID

status

String

true

DDM instance status

name

String

true

Name of the DDM instance

created

String

true

Time when the DDM instance is created

updated

String

true

Time when the DDM instance is last updated

available_zone

String

true

Name of the AZ where the DDM instance resides

vpc_id

String

true

VPC ID

subnet_id

String

true

Subnet ID

security_group_id

String

true

Security group ID

node_count

Integer

true

Number of nodes

access_ip

String

true

Address for accessing the DDM instance

access_port

String

true

Port for accessing the DDM instance

node_status

String

true

Status of the DDM instance node

core_count

String

true

Number of CPUs

ram_capacity

String

true

Memory size in GB

error_msg

String

false

Response message. This parameter is not returned if no error occurs.

project_id

String

true

Project ID

order_id

String

false

Order ID of the yearly/monthly instance. No value is returned when a pay-per-use instance is created.

enterprise_project_id

String

true

Enterprise project ID

nodes

Array

false

Node information

engine_version

String

true

Engine version (core version)
Table 3 Description of parameter nodes

Parameter

Type

Description

status

String

Status of the DDM instance node

port

String

Port of the DDM instance node

ip

String

IP address of the DDM instance node

Example

Example request

None

Example response 
{
    "id":"d0b008c1ee95479d8799710d9f3a4097in09",
    "status":"RUNNING",
    "name":"ddm-test-001",
    "created":"2020-05-29T03:20:55+0000",
    "updated":"2020-06-04T02:02:15+0000",
    "available_zone":"az1xahz",
    "vpc_id":"1d9441c5-1a4b-431d-9edb-bf3564a83e74",
    "subnet_id":"c9e16b87-d2ab-4c9e-b9a6-485a3ce795cd",
    "security_group_id":"935929bd-dccd-4183-a21c-cf53ecf9cdcc",
    "node_count":3,
    "access_ip":"192.168.0.145:5066,192.168.0.149:5066,192.168.0.53",
    "access_port":"5066",
    "core_count":"2",
    "ram_capacity":"4",
    "node_status":"RUNNING,RUNNING,RUNNING",
    "enterprise_project_id":"0",
    "project_id":"055d9f4ee780d4d42f96c01c1bc3c50c",
    "engine_version":"2.3.2.2",
    "nodes":
     [
        {
            "status":"RUNNING",
            "port":"5066",
            "ip":"192.168.0.53"
        },
        {
            "status":"RUNNING",
            "port":"5066",
            "ip":"192.168.0.145"
        },
        {
            "status":"RUNNING",
            "port":"5066",
            "ip":"192.168.0.149"
        }
     ]
}

For failure responses, see Abnormal Request Results.

Status Code

For details, see Status Codes.