文档首页/ 应用与数据集成平台 ROMA Connect/ API参考（阿布扎比区域）/ 服务集成API/ 实例管理/ 查看ROMA Connect实例详情
更新时间：2022-12-05 GMT+08:00
查看PDF
分享

查看ROMA Connect实例详情

功能介绍

查看ROMA Connect实例详情

URI

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

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

项目ID，获取方式请参见API参考的“附录 > 获取项目ID”章节。

instance_id

是

String

实例ID

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

用户Token。通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。

响应参数

状态码： 200

表3 响应Body参数

参数

参数类型

描述

id

String

实例编号

project_id

String

实例所属项目编号

instance_name

String

实例名称

status

String

实例状态：

  • 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

实例状态对应编号

  • 1：创建中
  • 2：创建成功
  • 3：创建失败
  • 4：初始化中
  • 5：注册中
  • 6：运行中
  • 7：初始化失败
  • 8：注册失败
  • 10：安装中
  • 11：安装失败
  • 12：升级中
  • 13：升级失败
  • 20：回滚中
  • 21：回滚成功
  • 22：回滚失败
  • 23：删除中
  • 24：删除失败
  • 25：注销中
  • 26：注销失败
  • 27：创建超时
  • 28：初始化超时
  • 29：注册超时
  • 30：安装超时
  • 31：升级超时
  • 32：回滚超时
  • 33：删除超时
  • 34：注销超时
  • 35：启动中
  • 36：冻结中
  • 37：已冻结
  • 38：重启中
  • 39：重启失败
  • 40：实例异常
  • 41：重启超时

type

String

实例类型

暂不支持

spec

String

实例规格：

  • ROMA_BASIC：基础版实例
  • ROMA_PROFESSIONAL：专业版实例
  • ROMA_ENTERPRISE：企业版实例
  • ROMA_PLATINUM：铂金版实例

create_time

Long

实例创建时间。unix时间戳格式。

enterprise_project_id

String

企业项目ID，企业帐号必填

eip_address

String

实例绑定的弹性IP地址

charging_mode

Integer

实例计费方式：

  • 0：按需计费
  • 1：包周期计费

cbc_metadata

String

计费订单编号

description

String

实例描述

vpc_id

String

虚拟私有云ID。

subnet_id

String

子网的网络ID。

security_group_id

String

实例所属的安全组。

maintain_begin

String

'维护时间窗开始时间。时间格式为 xx:00:00，xx取值为02,06,10,14,18,22。'

'在这个时间段内，运维人员可以对该实例的节点进行维护操作。维护期间，业务可以正常使用，可能会发生闪断。维护操作通常几个月一次。'

maintain_end

String

'维护时间窗结束时间。时间格式为 xx:00:00，与维护时间窗开始时间相差4个小时。'

'在这个时间段内，运维人员可以对该实例的节点进行维护操作。维护期间，业务可以正常使用，可能会发生闪断。维护操作通常几个月一次'。

ingress_ip

String

实例入口，虚拟私有云访问地址

user_id

String

实例所属用户ID

nat_eip_ipv6_cidr

String

出公网网段 (IPv6) 。

当前仅部分region部分可用区支持IPv6

eip_ipv6_address

String

弹性IP地址(IPv6)。

当前仅部分region部分可用区支持IPv6

nat_eip_address

String

实例出公网IP

bandwidth_size

Integer

出公网带宽

available_zone_ids

String

可用区

instance_version

String

实例版本编号

virsubnet_id

String

子网的网络ID。

暂不支持

roma_eip_address

String

roma弹性公网IP。

暂不支持

listeners

Object

监听信息

暂不支持

supported_features

Array of strings

实例支持的特性列表

ingress_ip_v6

String

实例入口（IPV6）

当前仅部分region部分可用区支持IPv6

状态码： 401

表4 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误描述

状态码： 403

表5 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误描述

状态码： 404

表6 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误描述

状态码： 500

表7 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误描述

请求示例

无

响应示例

状态码： 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"
}

状态码： 401

Unauthorized

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

状态码： 403

Forbidden

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

状态码： 404

Not Found

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

状态码： 500

Internal Server Error

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

状态码

状态码

描述

200

OK

401

Unauthorized

403

Forbidden

404

Not Found

500

Internal Server Error

错误码

请参见错误码。

父主题： 实例管理