Help Center> ROMA Connect> API Reference> Out-of-Date APIs> Device Integration APIs (V1)> Device Management> Querying Instance Information
View PDF

Querying Instance Information

Function

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

URI

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

Table 1 Parameter description

Parameter

Type

Mandatory

Description

project_id

string

Yes

Project ID of each region of a tenant.

instance_id

string

Yes

ID of the ROMA Connect instance used by the tenant.

Request

Request parameters

None

Example request

https://example.cloud.com/v1/80e2b******f4a398d6409a50932d917/link/instances/fb3b24ab-5d87-473d-9c57-fc6******6a1

Response

Response parameters

Table 2 Response parameter description

Parameter

Type

Description

app_key

string

App ID.

app_secret

string

App secret.

connect_address

string

IP address for connecting to the instance in a VPC.

instance_id

string

Instance ID.

project_id

string

Project ID.

public_ip

string

EIP bound to the instance.

status

string

Instance status.

Example response

{
    "app_key": "******",
    "app_secret": "******",
    "connect_address": "192.168.0.246",
    "instance_id": "fb3b24ab-5d87-473d-9c57-fc6******6a1",
    "project_id": "80e2b******f4a398d6409a50932d917",
    "public_ip": null,
    "status": "RUNNING"
}
Parent topic: Device Management