文档首页/ 分布式数据库中间件 DDM/ API参考/ API（推荐）/ 实例管理/ 查询DDM引擎信息V3
更新时间：2024-11-04 GMT+08:00
查看PDF
分享

查询DDM引擎信息V3

功能介绍

查询DDM引擎信息详情V3接口。

接口约束

无

调试

您可以在API Explorer中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。

URI

  • URL格式

GET /v3/{project_id}/engines?offset={offset}&limit={limit}

  • 参数说明
表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

租户在某一region下的project ID。

获取方法请参见获取项目ID。
表2 Query参数

参数

是否必选

参数类型

描述

offset

否

Integer

索引位置，偏移量。

从第一条数据偏移offset条数据后开始查询，默认为0。

取值必须为数字，且不能为负数。

limit

否

Integer

查询个数上限值。

取值范围：1~128。

不传该参数时，默认值为10。

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

用户Token。

通过调用IAM服务的“获取用户Token”接口来获取。

请求示例

查询DDM引擎信息。

GET https://{endpoint}/v3/{project_id}/engines?offset=0&limit=10

响应消息

  • 正常响应参数说明
表4 响应Body参数

参数

参数类型

描述

engine_groups

Array of EngineGroupInfo objects

引擎信息列表。

offset

Integer

分页参数: 起始值。

limit

Integer

分页参数：每页多少条。

total

Integer

引擎信息总数。
表5 EngineGroupInfo

参数

参数类型

描述

id

String

引擎ID。

name

String

引擎名称。

version

String

引擎版本。
  • 正常响应示例
{
  "engine_groups": [
    {
      "id": "036dc44a-b560-4316-9e7f-e25a60f2aea2",
      "name": "ddm",
      "version": "3.1.0.8"
    }
  ],
  "offset": 0,
  "limit": 1,
  "total": 3
}

状态码

错误码

请参见错误码。

父主题： 实例管理

相关文档