文档首页 > > API参考> 实例管理类接口> 查询所有实例列表
查看PDF

查询所有实例列表

分享
更新时间： 2019/11/28 GMT+08:00

功能介绍

查询租户的实例列表，支持按照条件查询。

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。

表1 参数说明

参数

类型

必选

说明

project_id

String

是

项目ID。

engine

String

否

rabbitmq或者kafka，参数缺失查询所有实例。

name

String

否

实例名称。

id

String

否

实例ID。

status

String

否

实例状态。详细状态说明见实例状态说明。

includeFailure

String

否

是否返回创建失败的实例。

当参数为false时，不返回创建失败的实例；当参数为true或者其他值，则返回创建失败的实例。参数缺失时，默认值为true，返回创建失败的实例。

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。

表2 参数说明

参数

类型

说明

instances

Array

实例的详情数组。

instance_num

Integer

实例个数。
表3 instance参数说明

参数

类型

说明

name

String

实例名称。

engine

String

引擎。

port

Integer

实例连接端口。

status

String

实例的状态。详细状态说明见实例状态说明。

type

String

实例类型。

  • 单机：single
  • 集群：cluster

Kafka实例只有集群类型。

specification

String

实例规格。

  • RabbitMQ实例单机返回vm规格。
  • RabbitMQ实例集群返回vm规格和节点数。
  • Kafka实例返回基准带宽值。

engine_version

String

版本。

connect_address

String

实例连接IP地址。

instance_id

String

实例ID。

resource_spec_code

String

资源规格标识。

  • dms.instance.kafka.cluster.c3.mini：Kafka实例的基准带宽为100MB。
  • dms.instance.kafka.cluster.c3.small.2：Kafka实例的基准带宽为300MB。
  • dms.instance.kafka.cluster.c3.middle.2：Kafka实例的基准带宽为600MB。
  • dms.instance.kafka.cluster.c3.high.2：Kafka实例的基准带宽为1200MB。
  • dms.instance.rabbitmq.single.c3.2u4g：RabbitMQ单机，vm规格2u4g
  • dms.instance.rabbitmq.single.c3.4u8g：RabbitMQ单机，vm规格4u8g
  • dms.instance.rabbitmq.single.c3.8u16g：RabbitMQ单机，vm规格8u16g
  • dms.instance.rabbitmq.single.c3.16u32g：RabbitMQ单机，vm规格16u32g
  • dms.instance.rabbitmq.cluster.c3.4u8g.3：RabbitMQ集群，vm规格4u8g，3个节点
  • dms.instance.rabbitmq.cluster.c3.4u8g.5：RabbitMQ集群，vm规格4u8g，5个节点
  • dms.instance.rabbitmq.cluster.c3.4u8g.7：RabbitMQ集群，vm规格4u8g，7个节点
  • dms.instance.rabbitmq.cluster.c3.8u16g.3：RabbitMQ集群，vm规格8u16g，3个节点
  • dms.instance.rabbitmq.cluster.c3.8u16g.5：RabbitMQ集群，vm规格8u16g，5个节点
  • dms.instance.rabbitmq.cluster.c3.8u16g.7：RabbitMQ集群，vm规格8u16g，7个节点
  • dms.instance.rabbitmq.cluster.c3.16u32g.3：RabbitMQ集群，vm规格16u32g，3个节点
  • dms.instance.rabbitmq.cluster.c3.16u32g.5：RabbitMQ集群，vm规格16u32g，5个节点
  • dms.instance.rabbitmq.cluster.c3.16u32g.7：RabbitMQ集群，vm规格16u32g，7个节点

charging_mode

Integer

付费模式，1表示按需计费，0表示包年/包月计费。

vpc_id

String

VPC ID。

vpc_name

String

VPC的名称。

created_at

String

完成创建时间。

格式为时间戳，指从格林威治时间 1970年01月01日00时00分00秒起至指定时间的偏差总毫秒数。

product_id

String

产品标识。

security_group_id

String

安全组ID。

security_group_name

String

租户安全组名称。

subnet_id

String

子网ID。

available_zones

Array

实例节点所在的可用区，返回“可用区ID”。

user_id

String

用户id。

user_name

String

用户名。

kafka_manager_user

String

登录Kafka Manager的用户名。

access_user

String

实例的用户名。

maintain_begin

String

维护时间窗开始时间，格式为HH:mm。

maintain_end

String

维护时间窗结束时间，格式为HH:mm。

storage_space

Integer

消息存储空间，单位：GB。

total_storage_space

Integer

总共消息存储空间，单位：GB。

used_storage_space

Integer

已使用的消息存储空间，单位：GB。

partition_num

Integer

Kafka实例的最大topic数。

enable_publicip

Boolean

实例是否开启公网访问功能。

  • true：开启
  • false：未开启

ssl_enable

Boolean

是否开启安全认证。

  • true：开启
  • false：未开启

management_connect_address

String

RabbitMQ实例的管理地址。

Kafka实例的KafkaManager连接地址。

public_connect_address

String

公网访问地址。

public_management_connect_address

String

Manager访问地址。

storage_resource_id

String

存储资源ID。

storage_spec_code

String

IO规格。

service_type

String

服务类型。

storage_type

String

存储类型。

enterprise_project_id

String

企业项目ID。如果为0，表示为默认企业项目default。

is_logical_volume

Boolean

实例扩容时用于区分老实例与新实例。

  • true：新创建的实例，允许磁盘动态扩容不需要重启。
  • false：老实例。

extend_times

String

实例扩容磁盘次数，如果超过20次则无法扩容磁盘。

retention_policy

String

消息老化策略。

ipv6_enable

Boolean

是否开启ipv6。

ipv6_connect_addresses

String

ipv6的连接地址。

connector_enable

Boolean

是否开启转储。

connector_id

String

转储任务ID。

rest_enable

Boolean

是否开启Kafka rest功能。

rest_connect_address

String

Kafka rest地址。

kafka_public_status

String

Kafka公网开启状态。

public_boundwidth

Integer

公网带宽。

message_query_inst_enable

Boolean

是否开启消息查询功能。

vpc_client_plain

Boolean

是否开启VPC明文访问。

support_features

String

该Kafka实例支持的特性列表。

trace_enable

Boolean

是否开启消息轨迹功能。

disk_encrypted

Boolean

是否开启磁盘加密。

响应示例

{
    "instances": [
        {
            "name": "kafka-132814245",
            "engine": "kafka",
            "port": 9092,
            "status": "RUNNING",
            "type": "cluster",
            "specification": "100MB",
            "engine_version": "1.1.0",
            "connect_address": "192.168.0.103,192.168.0.142,192.168.0.178",
            "instance_id": "50806489-1e97-4255-b52c-002943d79fae",
            "resource_spec_code": "kafka.c3.mini.connector",
            "charging_mode": 1,
            "vpc_id": "29ffb185-9972-44ff-98c5-86bdc455380b",
            "vpc_name": "vpc-bcs-weei",
            "created_at": "1564381653333",
            "product_id": "00300-30316-0--0",
            "security_group_id": "14658857-3af6-4a42-9167-5b6445926270",
            "security_group_name": "Sys-default",
            "subnet_id": "8f417076-b5a9-485f-bc13-bba08fbcdd39",
            "available_zones": [
                "af1687643e8c4ec1b34b688e4e3b8901"
            ],
            "user_id": "f79c83a70bf94e209f3d453bc44374f9",
            "user_name": "dms_enterprise",
            "kafka_manager_user": "root",
            "maintain_begin": "22:00",
            "maintain_end": "02:00",
            "storage_space": 492,
            "total_storage_space": 600,
            "used_storage_space": 25,
            "partition_num": "300",
            "enable_publicip": true,
            "ssl_enable": false,
            "management_connect_address": "https://139.9.90.128:9999",
            "public_connect_address": "139.9.90.128:9094,139.9.201.64:9094,139.9.93.40:9094",
            "public_management_connect_address": "https://139.9.90.128:9999,https://139.9.201.64:9999",
            "storage_resource_id": "46cec838-4b84-4a3b-be66-86d0623e4117",
            "storage_spec_code": "dms.physical.storage.high",
            "service_type": "advanced",
            "storage_type": "hec",
            "enterprise_project_id": "0",
            "is_logical_volume": true,
            "extend_times": 0,
            "retention_policy": "time_base",
            "ipv6_enable": false,
            "ipv6_connect_addresses": [],
            "connector_enable": true,
            "connector_id": "f3e5bda3-a589-4a13-a16b-465e685ea68a",
            "rest_enable": false,
            "rest_connect_address": "",
            "kafka_public_status": "true",
            "public_boundwidth": 102,
            "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,
            "disk_encrypted": false
        }
    ],
    "instance_num": 1
}

状态码

操作成功的状态码如表4所示，其他响应见状态码。

表4 状态码

状态码

描述

200

查询所有实例列表成功。
父主题： 实例管理类接口
分享：

    相关文档

    相关产品

文档是否有解决您的问题？

提交成功！

非常感谢您的反馈，我们会继续努力做到更好！

反馈提交失败，请稍后再试！

*必选

请至少选择或填写一项反馈信息

字符长度不能超过200

提交反馈 取消

如您有其它疑问，您也可以通过华为云社区问答频道来与我们联系探讨

跳转到云社区