查询所有实例列表
功能介绍
查询租户的实例列表，支持按照条件查询。
URI
GET /v1.0/{project_id}/instances?engine={engine}&name={name}&status={status}&id={id}&includeFailure={includeFailure}&exactMatchName={exactMatchName}&enterprise_project_id={enterprise_project_id}
参数说明见表1。
|
参数 |
类型 |
必选 |
说明 |
|---|---|---|---|
|
project_id |
String |
是 |
项目ID。 |
|
engine |
String |
否 |
rabbitmq，参数缺失查询所有实例。 |
|
name |
String |
否 |
实例名称。 |
|
id |
String |
否 |
实例ID。 |
|
status |
String |
否 |
实例状态。详细状态说明见实例状态说明。 |
|
includeFailure |
String |
否 |
是否返回创建失败的实例数。 当参数值为“true”时，返回创建失败的实例数。参数值为“false”或者其他值，不返回创建失败的实例数。 |
|
exactMatchName |
String |
否 |
是否按照实例名称进行精确匹配查询。 默认为“false”，表示模糊匹配实例名称查询。若参数值为“true”表示按照实例名称进行精确匹配查询。 |
|
enterprise_project_id |
String |
否 |
企业项目ID。 |
示例
GET /v1.0/bd6b78e2ff9e4e47bc260803ddcc7a21/instances?start=1&limit=10&name=&status=&id=&includeFailure=true&exactMatchName=false
请求消息
请求参数
无。
请求示例
无。
响应消息
响应参数
参数说明见表2。
|
参数 |
类型 |
说明 |
|---|---|---|
|
name |
String |
实例名称。 |
|
engine |
String |
引擎。 |
|
engine_version |
String |
版本。 |
|
specification |
String |
实例规格。
|
|
storage_space |
Integer |
消息存储空间，单位：GB。 |
|
used_storage_space |
Integer |
已使用的消息存储空间，单位：GB。 |
|
connect_address |
String |
实例连接IP地址。 |
|
port |
Integer |
实例连接端口。 |
|
status |
String |
实例的状态。详细状态说明见实例状态说明。 |
|
description |
String |
实例描述。 |
|
instance_id |
String |
实例ID。 |
|
resource_spec_code |
String |
资源规格标识。
|
|
charging_mode |
Integer |
付费模式，1表示按需计费。 |
|
vpc_id |
String |
VPC ID。 |
|
vpc_name |
String |
VPC的名称。 |
|
created_at |
String |
完成创建时间。 格式为时间戳，指从格林威治时间 1970年01月01日00时00分00秒起至指定时间的偏差总毫秒数。 |
|
error_code |
String |
实例创建失败或状态异常时的错误码，错误码说明见表3。 |
|
user_id |
String |
用户id。 |
|
user_name |
String |
用户名。 |
|
order_id |
String |
订单ID。 |
|
maintain_begin |
String |
维护时间窗开始时间，格式为HH:mm。 |
|
maintain_end |
String |
维护时间窗结束时间，格式为HH:mm。 |
|
enable_publicip |
Boolean |
RabbitMQ实例是否开启公网访问功能。
|
|
publicip_address |
String |
RabbitMQ实例绑定的弹性IP地址。 如果未开启公网访问功能，该字段值为null。 |
|
publicip_id |
String |
RabbitMQ实例绑定的弹性IP地址的ID。 如果未开启公网访问功能，该字段值为null。 |
|
management_connect_address |
String |
RabbitMQ实例的管理地址。 |
|
ssl_enable |
Boolean |
是否开启安全认证。
|
|
enterprise_project_id |
String |
企业项目ID。 |
|
is_logical_volume |
Boolean |
实例扩容时用于区分老实例与新实例。
|
|
extend_times |
String |
实例扩容磁盘次数，如果超过20次则无法扩容磁盘。 |
响应示例
{
"instances": [
{
"name": "rabbitmq-lxy001",
"engine": "rabbitmq",
"port": 5672,
"status": "RUNNING",
"type": "single",
"specification": "2vCPUs 4GB",
"engine_version": "3.7.17",
"connect_address": "192.168.255.237",
"instance_id": "595926bf-a648-47d8-91bc-461956794c2b",
"resource_spec_code": "dms.instance.rabbitmq.single.c3.2u4g",
"charging_mode": 1,
"vpc_id": "1a28dcc5-c90d-421c-82bb-783f30f5b40a",
"vpc_name": "vpc-y00292973",
"created_at": "1562583302800",
"product_id": "00300-30109-0--0",
"security_group_id": "0cc8fdb7-872a-49da-a062-88ccc39463b5",
"security_group_name": "sg-65eb-nw-test",
"subnet_id": "ebba7994-260d-42ab-bce1-39a08b365dc8",
"available_zones": [
"d573142f24894ef3bd3664de068b44b0"
],
"user_id": "50a4156d334a4a82b8745dc730dc1e00",
"user_name": "test",
"access_user": "test-Info",
"maintain_begin": "02:00:00",
"maintain_end": "06:00:00",
"storage_space": 88,
"total_storage_space": 100,
"used_storage_space": 4,
"enable_publicip": false,
"ssl_enable": false,
"management_connect_address": "http://192.168.255.237:15672",
"storage_resource_id": "34825335-61cb-4ee0-949e-24b08170edb2",
"storage_spec_code": "dms.physical.storage.ultra",
"service_type": "advanced",
"storage_type": "hec",
"enterprise_project_id": "0",
"is_logical_volume": false,
"extend_times": 0,
"ipv6_enable": false,
"ipv6_connect_addresses": [],
"connector_enable": false,
"connector_id": "",
"rest_enable": false,
"rest_connect_address": "",
"public_boundwidth": 0,
"message_query_inst_enable": true,
"vpc_client_plain": false,
"support_features": "feature.physerver.kafka.topic.accesspolicy,message_trace_enable,feature.physerver.kafka.pulbic.dynamic,feature.physerver.kafka.user.manager",
"trace_enable": false
}
],
"instance_num": 1
}
