接口功能介绍
调用describeAllParameterGroup查询所有的参数组信息。
接口约束
无
URI
GET /v1/parameterGroupOpenApi/describeAllParameterGroup
路径参数
无
Query参数
无
请求参数
请求头header参数
无
响应参数
参数 | 是否必填 | 参数类型 | 说明 | 下级对象 | |
statusCode | 是 | Integer | 响应码 | 800 | |
message | 是 | String | 响应信息 | 查询MongoDB实例的主机告警规则成功 | |
returnObj | 是 | Object[] | 返回对象数组 | returnObj |
表returnObj
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
id | 是 | Integer | 标志值 | ||
userId | 是 | Long | 用户id | ||
groupId | 是 | Short | 组id | ||
parameterGroupName | 是 | String | 参数组名称 | ||
mongoEngine | 是 | String | 引擎版本 | ||
description | 是 | String | 参数组描述 | ||
origindescription | 是 | String | 参数组原始描述 | ||
isdefault | 是 | String | 是否为默认参数组 | ||
createTime | 是 | Date | 参数组创建时间 | ||
edit | 是 | Byte | 是否可编辑 |
请求示例
请求头header
无
请求参数query
/v1/parameterGroupOpenApi/describeAllParameterGroup
响应示例
{
"statusCode": 800,
"message": "查询所有的参数组信息成功",
"returnObj": [
{
"parameterGroupName": "Default-Mongo-3.4",
"createTime": 1584924591000,
"edit": 1,
"groupId": 0,
"description": "Default parameter group for Mongo 3.4",
"origindescription": "Default parameter group for Mongo 3.4",
"id": 0,
"isdefault": "1",
"userId": 0,
"mongoEngine": "3.4"
},
{
"parameterGroupName": "Default-Mongo-4.0",
"createTime": 1584924589000,
"edit": 1,
"groupId": 3,
"description": "Default parameter group for Mongo 4.0",
"origindescription": "Default parameter group for Mongo 4.0",
"id": 3,
"isdefault": "1",
"userId": 0,
"mongoEngine": "4.0"
},
{
"parameterGroupName": "paramsGroup-TBMB",
"createTime": 1645773195000,
"edit": 1,
"groupId": 1,
"description": "ceshi",
"origindescription": "ceshi",
"id": 37,
"isdefault": "0",
"userId": 1012,
"mongoEngine": "3.4"
}
]
}状态码
状态码 | 描述 |
800 | 表示请求成功 |
900 | 表示请求失败 |
错误码
无