Help Center> ROMA Connect> API Reference (ME-Abu Dhabi Region)> APIC APIs> Instance Management> Querying Details of a ROMA Connect Instance
Updated on 2022-12-05 GMT+08:00
View PDF

Querying Details of a ROMA Connect Instance

Function

Querying Details of a ROMA Connect Instance

URI

GET /v2/{project_id}/apic/instances/{instance_id}

Table 1 Path parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Project ID. For details about how to obtain the project ID, see Appendix > Obtaining a Project ID in the ROMA Connect API Reference.

instance_id

Yes

String

Instance ID.

Request Parameters

Table 2 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

User token, which can be obtained by calling the IAM API (value of X-Subject-Token in the response header).

Response Parameters

Status code: 200

Table 3 Response body parameters

Parameter

Type

Description

id

String

Instance ID.

project_id

String

Project ID to which the instance belongs.

instance_name

String

Instance name.

status

String

Status of the instance:

  • Creating
  • CreateSuccess
  • CreateFail
  • Initing
  • Registering
  • Running
  • InitingFailed
  • RegisterFailed
  • Installing
  • InstallFailed
  • Updating
  • UpdateFailed
  • Rollbacking
  • RollbackSuccess
  • RollbackFailed
  • Deleting
  • DeleteFailed
  • Unregistering
  • UnRegisterFailed
  • CreateTimeout
  • InitTimeout
  • RegisterTimeout
  • InstallTimeout
  • UpdateTimeout
  • RollbackTimeout
  • DeleteTimeout
  • UnregisterTimeout
  • Starting
  • Freezing
  • Frozen
  • Restarting
  • RestartFail
  • Unhealthy
  • RestartTimeout

instance_status

Integer

Instance status value, expressed by a number.

  • 1: Creating
  • 2: Created successfully
  • 3: Creation failed
  • 4: Initializing
  • 5: Registering
  • 6: Running
  • 7: Initialization failed
  • 8: Registration failed
  • 10: Installing
  • 11: Installation failed
  • 12: Upgrading
  • 13: Upgrade failed
  • 20: Rolling back
  • 21: Rollback success
  • 22: Rollback failed
  • 23: Deleting
  • 24: Deletion failed
  • 25: Deregistering
  • 26: Deregistration failed
  • 27: Creation timeout
  • 28: Initialization timeout
  • 29: Registration timeout
  • 30: Installation timeout
  • 31: Upgrade timeout
  • 32: Rollback timeout
  • 33: Deletion timeout
  • 34: Deregistration timeout
  • 35: Starting
  • 36: Freezing
  • 37: Frozen
  • 38: Restarting
  • 39: Restart failed
  • 40: Instance exception
  • 41: Restart timeout

type

String

Instance type.

This parameter is currently not supported.

spec

String

Instance edition.

  • ROMA_BASIC
  • ROMA_PROFESSIONAL
  • ROMA_ENTERPRISE
  • ROMA_PLATINUM
  • ROMA_BASIC_IPV6
  • ROMA_PROFESSIONAL_IPV6
  • ROMA_ENTERPRISE_IPV6
  • ROMA_PLATINUM_IPV6

create_time

Long

Time when the instance is created. The time is in the Unix timestamp format.

enterprise_project_id

String

Enterprise project ID. This parameter is required for an enterprise account.

eip_address

String

EIP bound to the instance.

charging_mode

Integer

Billing mode of the instance.

cbc_metadata

String

Order ID.

description

String

Description about the instance.

vpc_id

String

VPC ID.

subnet_id

String

Subnet network ID.

security_group_id

String

Security group to which the instance belongs.

maintain_begin

String

Start time of the maintenance time window, in the format "xx:00:00". The value of xx can be 02, 06, 10, 14, 18, or 22. '

During the maintenance time period, O&M personnel can perform maintenance operations on the gateway. During maintenance, services can still be used, but occasionally there may be temporary service interruptions. Scheduled maintenance occurs infrequently (typically once every several months). '

maintain_end

String

End time of the maintenance time window, in the format "xx:00:00". There is a 4-hour difference between the start time and end time.

During the maintenance time period, O&M personnel can perform maintenance operations on the instance. During maintenance, services can still be used, but occasionally there may be temporary service interruptions. Scheduled maintenance occurs infrequently (typically once every several months).

ingress_ip

String

VPC ingress address.

user_id

String

ID of the account to which the instance belongs.

nat_eip_ipv6_cidr

String

Public egress address (IPv6).

Currently, IPv6 addresses are supported only in certain regions.

eip_ipv6_address

String

EIP (IPv6).

Currently, IPv6 addresses are supported only in certain regions.

nat_eip_address

String

IP address for public outbound access.

bandwidth_size

Integer

Outbound access bandwidth.

available_zone_ids

String

AZ.

instance_version

String

Instance version.

virsubnet_id

String

Subnet network ID.

This parameter is currently not supported.

roma_eip_address

String

ROMA EIP.

This parameter is currently not supported.

listeners

Array of Listener objects

Listening information.

[This parameter is currently not supported.] (tag:public)

supported_features

Array of strings

Supported features.

ingress_ip_v6

String

Instance entry (IPv6).

Currently, only some AZs in some regions support IPv6.
Table 4 Listener

Parameter

Type

Description

name

String

Listener name.

port

Integer

Port for the listener to provide services externally.

backend

Backend object

Backend service definition.

ip_version

Integer

IP protocol type for creating a load balancer.
Table 5 Backend

Parameter

Type

Description

ip

Array of strings

Backend host address list.

port

Integer

Backend service port. If the port does not exist, use the listener port.

health_check

HealthCheck object

Health check settings.
Table 6 HealthCheck

Parameter

Type

Description

protocol

String

Currently, LVS supports only TCP_CHECK.

port

Integer

Health check port.

unhealthy

Integer

The threshold for determining whether the backend is unhealthy. The number of consecutive detection failures is used as the threshold.

timeout

Integer

Timeout interval for detecting the backend, in seconds.

interval

Integer

Interval for detecting the backend, in seconds.

Status code: 401

Table 7 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error description.

Status code: 403

Table 8 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error description.

Status code: 404

Table 9 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error description.

Status code: 500

Table 10 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error description.

Example Requests

None

Example Responses

Status code: 200

OK

{
  "available_zone_ids" : "[region01, region02]",
  "bandwidth_size" : 5,
  "description" : "test create instance",
  "eip_id" : "41f961ab-2bdd-4ca7-9b59-cfc4fcef10c9",
  "enterprise_project_id" : "0",
  "instance_name" : "apig-demo",
  "maintain_begin" : "22:00:00",
  "maintain_end" : "02:00:00",
  "security_group_id" : "36d0ec18-bd10-4da7-86f3-ad7a5ddc55d7",
  "spec_id" : "PROFESSIONAL",
  "subnet_id" : "a938121c-11c4-4c91-b983-bc9acd347bb5",
  "vpc_id" : "0957108c-257c-4ce0-9e93-527d279ce763"
}

Status code: 401

Unauthorized

{
  "error_code" : "APIC.7102",
  "error_msg" : "Incorrect token or token resolution failed"
}

Status code: 403

Forbidden

{
  "error_code" : "APIC.7106",
  "error_msg" : "No permissions to request for the method"
}

Status code: 404

Not Found

{
  "error_code" : "APIC.7302",
  "error_msg" : "Instance not found"
}

Status code: 500

Internal Server Error

{
  "error_code" : "APIC.9000",
  "error_msg" : "Failed to request internal service"
}

Status Codes

Status Code

Description

200

OK

401

Unauthorized

403

Forbidden

404

Not Found

500

Internal Server Error

Error Codes

See Error Codes.

Parent topic: Instance Management