查询实例信息 接口说明 按次或包周期商品非必选调测接口，按需和按需套餐包商品必选。 用户在购买了商品后需要查询所购买的商品实例信息，对于按需商品，还需要实时返回当前用户的按需用量信息 。 用户如果购买了按需套餐包，还需要通过这个接口返回套餐包的用量信息。 查询实例信息流程如下图所示：

查看更多 →

查询单个实例 功能介绍 该接口用于查询单个实例。 调用方法 请参见如何调用API。 URI GET /v2/{project_id}/instances/{instance_id} 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID。获取方法，请参见获取项目ID。

查看更多 →

cache_mode String 参数解释： 缓存实例类型。 取值范围： single：表示单机实例。 ha：表示主备实例。 cluster：表示cluster集群实例。 proxy：表示Proxy集群实例。 ha_rw_split：表示读写分离实例。 support_slow_log_flag

查看更多 →

查询实例状态 功能介绍 查询该租户在当前区域下不同状态的实例数。 调用方法 请参见如何调用API。 URI GET /v2/{project_id}/instances/status 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 参数解释：

查看更多 →

查询当前霸屏应用包名 应用场景 该接口可查询当前投屏显示的应用的包名 前提条件 已完成登录认证，参考登录认证。 接口概述 本接口可以查询当前投屏显示的应用的包名，接口详情请参考查询当前霸屏应用包名 请求URL /action.cgi?ActionID=WEB_GetSingleAppAPI

查看更多 →

查询当前霸屏应用包名 表1 查询当前霸屏应用 REST URL格式 访问方法 URI POST https://ip/action.cgi?ActionID=WEB_GetSingleAppAPI 接口功能 本接口用于获取当前霸屏应用包名 接口说明 查询当前屏上运行的应用名称 响应数据

查看更多 →

Boolean 是否为默认实例。 create_time String 实例创建时间戳。 update_time String 实例更新时间戳。 status String 实例状态：RESOURCE_PREPARATION-实例资源准备中、RUNNING-实例运行中、RESOURC

查看更多 →

查询实例信息 功能介绍 查询对应实例ID的详细信息。 URI GET /v1/{project_id}/link/instances/{instance_id} 表1 参数说明 参数 类型 是否必填 说明 project_id string 是 租户每个区域对应的项目ID。 instance_id

查看更多 →

区块容量（单位：MB），默认2MB 表6 ChannelInfo 参数 参数类型 描述 name String 通道名 org_names Array of strings 通道中组织名 org_name_hash Array of strings 通道中组织名的哈希值 peers Map<String,Array<String>>

查看更多 →

CompletedOkWait 默认取值： 不涉及。 请求参数 表2 请求参数 参数 是否必选 参数类型 描述 fields 否 String 参数解释： 指明要查询的字段，多个字段名之间以逗号分隔。如果不指明字段，则返回缺省的字段。 约束限制： 不涉及。 取值范围： 不涉及。 默认取值：

查看更多 →

name String 实例名称。 engine String 消息引擎。 engine_version String 消息引擎版本。 specification String 实例规格。 RabbitMQ实例单机返回vm规格。 RabbitMQ实例集群返回vm规格和节点数。 storage_space

查看更多 →

企业项目ID。 is_logical_volume Boolean 实例扩容时用于区分老实例与新实例。 true：新创建的实例，允许磁盘动态扩容不需要重启。 false：老实例 extend_times Integer 实例扩容磁盘次数，如果超过20次则无法扩容磁盘。 enable_auto_topic

查看更多 →

查询实例标签 功能介绍 查询实例标签。 调用方法 请参见如何调用API。 URI GET /v2/{project_id}/kafka/{instance_id}/tags 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID，获取方式请参见获取项目ID。

查看更多 →

查询指定实例 当前页面API为历史版本API，未来可能停止维护。请使用查询指定实例。 功能介绍 查询指定实例的详细信息。 URI GET /v1.0/{project_id}/instances/{instance_id} 参数说明见表1。 表1 参数说明 参数 类型 必选 说明

查看更多 →

name String 实例名称。 engine String 消息引擎。 engine_version String 消息引擎版本。 specification String 实例规格。 RabbitMQ实例单机返回vm规格。 RabbitMQ实例集群返回vm规格和节点数。 storage_space

查看更多 →

参数说明见表2。 表2 参数说明 参数 类型 说明 name String 实例名称。 engine String 缓存实例的引擎类型。 capacity Integer 缓存实例的容量（G Byte）。 ip String 连接缓存实例的IP地址。如果是集群实例，返回多个IP地址，使用逗号分隔。如：192

查看更多 →

正常响应要素说明 表2 要素说明 名称 参数类型 说明 instance_id String 实例ID。 dns_name String 实例 域名 。 dns_type String 实例域名类型：private ipv4_address String 实例域名绑定的vIP。 status String

查看更多 →

查询指定实例 功能介绍 查询指定实例的详细信息。 调用方法 请参见如何调用API。 URI GET /v2/{engine}/{project_id}/instances/{instance_id} 表1 路径参数 参数 是否必选 参数类型 描述 engine 是 String 引擎。

查看更多 →

String 分组名。 group_type_name String 实例分组类型名，现在只支持clickhouse。 nodes Array of ClickHouseNodeInfo objects 实例节点信息。 表8 ClickHouseNodeInfo 参数 参数类型 描述 id

查看更多 →

group_type_name String 实例分组类型名。 group_node_type String 实例分组节点类型。 表6 nodes 参数 参数类型 描述 id String 实例节点ID。 name String 实例节点名。 type String 实例节点类型。 status String

查看更多 →

查询实例数 功能介绍 功能介绍：查询实例数，获取用户已经创建的用户主密钥数量。 调用方法 请参见如何调用API。 URI GET /v1.0/{project_id}/kms/user-instances 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String

查看更多 →