查询所有实例列表 - ListRomaInstancesV3
功能介绍
获取实例列表。
调试
您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。
授权信息
账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限,具体权限要求请参见权限和授权项。
URI
GET /v3/{project_id}/roma/instances
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
project_id |
是 |
String |
实例所属租户。 |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
category |
否 |
String |
实例类别。 |
status |
否 |
String |
实例状态。 |
请求参数
无
响应参数
状态码:200
参数 |
参数类型 |
描述 |
---|---|---|
total |
Integer |
总数。 |
size |
Integer |
本页数量。 |
instances |
Array of instances objects |
实例数组对象。 |
参数 |
参数类型 |
描述 |
---|---|---|
id |
String |
实例ID。 |
name |
String |
名称。 |
description |
String |
实例描述。 |
status |
String |
实例状态。 |
category |
String |
实例类别。 |
charge_type |
String |
指定实例计费模式。取值如下: - prePaid: 预付费模式,也称作包周期计费模式。 - postPaid: 后付费模式,也称作按需计费模式。 |
available_zone_ids |
Array of strings |
可用区列表,是否有存在的必要,暂时也可能只考虑ECS、ELB不考虑中间件。 |
cpu_arch |
String |
架构类型。 |
enterprise_project_id |
String |
企业项目ID,需要与企业项目开关配合使用,开启企业项目后必填。 |
vpc_id |
String |
用户选择虚拟私有云ID。 |
subnet_id |
String |
用户选择的子网网络ID。 |
security_group_id |
String |
兼容字段,用户选择的安全组ID实例类别为roma时有值。 |
publicip_enable |
Boolean |
公网入口是否开启。 |
publicip_id |
String |
兼容字段,用户选择的公网IP的ID,公网入口开启且实例类别为roma时有值。 |
publicip_address |
String |
公网入口IPv4地址,公网入口开启有值。 |
connect_address |
String |
私网入口IPv4地址。 |
flavor_id |
String |
兼容字段,实例规格ID,实例类别为roma时有值。 |
flavor_type |
String |
兼容字段,实例规格ID,实例类别为roma时有值。 |
project_id |
String |
用户的项目ID。 |
maintain_begin |
String |
兼容字段,维护时间窗起始时间,实例类别为roma时有值。 |
maintain_end |
String |
兼容字段,维护时间窗结束时间,实例类别为roma时有值。 |
site_id |
String |
站点ID,实例类别为site时有值。 |
create_time |
String |
创建UTC时间。 |
update_time |
String |
更新UTC时间。 |
rcu |
rcu object |
实例类别为RCU时有值。 |
bandwidths |
Integer |
兼容字段,实例公网出口带宽,单位Mbit/s,实例类别为roma时有值。 |
ingress_bandwidth_size |
Integer |
RCU类别实例时,公网入口带宽,单位Mbit/s。 |
ipv6_enable |
Boolean |
HCS专属字段,IPV6实例。 |
ipv6_connect_address |
String |
HCS专属字段,IPV6实例入口地址。 |
rocketmq_enable |
Boolean |
HCS专属字段,MQS引擎部署为RocketMQ。 |
order_id |
String |
兼容字段,包周期订单ID,实例类别为roma时有值。 |
error_code |
String |
实例状态异常时,错误码信息。 |
error_msg |
String |
实例状态异常时,错误信息。 |
created_user |
created_user object |
创建用户信息。 |
last_updated_user |
last_updated_user object |
最后更新用户信息。 |
状态码:default
参数 |
参数类型 |
描述 |
---|---|---|
error_code |
String |
错误码。 |
error_msg |
String |
错误描述。 |
请求示例
无
响应示例
无
状态码
状态码 |
描述 |
---|---|
200 |
Instance List |
default |
response for errors |
错误码
请参见错误码。