查询DDM引擎信息
功能介绍
查询DDM引擎信息详情。
接口约束
无
调试
您可以在API Explorer中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。
URI
GET /v2/{project_id}/engines?offset={offset}&limit={limit}
参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
project_id | 是 | String | 租户在某一region下的project ID。 获取方法请参见获取项目ID。 |
参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
offset | 否 | Integer | 索引位置，偏移量。 从第一条数据偏移offset条数据后开始查询，默认为0。 取值必须为数字，且不能为负数。 |
limit | 否 | Integer | 查询个数上限值。 取值范围：1~128。 不传该参数时，默认值为128。 |
请求参数
参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
X-Auth-Token | 是 | String | 用户Token。 通过调用IAM服务的“获取用户Token”接口来获取。 |
响应参数
状态码： 200
参数 | 参数类型 | 描述 |
|---|---|---|
engineGroups | Array of EngineGroupsInfo objects | 引擎信息列表。 |
offset | Integer | 分页参数: 起始值。 |
limit | Integer | 分页参数：每页多少条。 |
total | Integer | 引擎信息总数。 |
参数 | 参数类型 | 描述 |
|---|---|---|
id | String | 引擎ID。 |
name | String | 引擎名称。 |
version | String | 引擎版本。 |
supportAzs | Array of SupportAzsInfo objects | 可用区列表。 |
状态码： 400
参数 | 参数类型 | 描述 |
|---|---|---|
errCode | String | 业务错误码。 |
externalMessage | String | 错误信息。 |
状态码： 500
参数 | 参数类型 | 描述 |
|---|---|---|
errCode | String | 业务错误码。 |
externalMessage | String | 错误信息。 |
请求示例
查询引擎信息。
GET https://{endpoint}/v2/{project_id}/engines?offset={offset}&limit={limit} 响应示例
状态码： 200
OK
{
"engineGroups" : [ {
"id" : "b6907aa2-aacb-3ac9-9782-b90b152d456c",
"name" : "ddm",
"version" : "3.0.8",
"supportAzs" : [ {
"code" : "az1",
"name" : "az1",
"favored" : false
}, {
"code" : "az2",
"name" : "az2",
"favored" : true
} ]
} ],
"offset" : 0,
"limit" : 128,
"total" : 1
} 状态码： 400
bad request
{
"externalMessage" : "Parameter error.",
"errCode" : "DBS.280001"
} 状态码： 500
server error
{
"externalMessage" : "Server failure.",
"errCode" : "DBS.200412"
} 状态码
状态码 | 描述 |
|---|---|
200 | OK |
400 | bad request |
500 | server error |
错误码
请参见错误码。
