Updated on 2026-01-13 GMT+08:00

Obtaining ADG Instance Details

Function

This API is used to obtain details about an ADG instance in a specified project.

Calling Method

For details, see Calling APIs.

URI

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

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

instance_id

Yes

String

Instance ID.

project_id

Yes

String

Project ID.

Request Parameters

None

Response Parameters

Status code: 200

Table 2 Response body parameters

Parameter

Type

Description

availability_zone

String

AZ.

charge_mode

String

Billing mode.

create_time

Long

Creation time.

deploy_mode

String

Deployment mode.

fail_reason

String

Failure cause.

id

String

Instance ID.

mode

String

Mode.

name

String

Instance name.

nodes

Array of InstanceNodeVo objects

Array of node information.

public_ip

String

EIP.

publicip_id

String

EIP ID.

region

String

Region.

security_group_id

String

Security group ID.

specification

String

Specifications.

started_time

Long

Start time.

status

Integer

Status.

subnet_id

String

Subnet ID.

type

String

Type.

update_info

InstanceUpgradeInfo object

Instance upgrade information.

upgrade_process

Integer

Upgrade progress.

version

String

Version.

virtual_ip

String

Virtual IP address.

vpc_id

String

VPC ID

Table 3 InstanceNodeVo

Parameter

Type

Description

availability_zone

String

AZ.

error_reason

String

Error cause.

id

String

Node ID.

name

String

Node name.

private_ip

String

Private IP address.

role

String

Role.

status

String

Status.

vm_id

String

VM ID.

Table 4 InstanceUpgradeInfo

Parameter

Type

Description

current_task_schedule_time

Long

Task scheduling time.

current_task_status

String

Task status.

estimated_time

Integer

Estimated completion time.

last_fail_reason

String

Last failure cause.

last_task_status

String

Last task status.

new_version

String

Upgraded to the latest version.

Example Requests

None

Example Responses

None

Status Codes

Status Code

Description

200

OK

401

Unauthorized.

403

Access denied.

404

Not found.

Error Codes

See Error Codes.