查询所有参数组v2
更新时间 2025-09-11 16:24:43
最近更新时间: 2025-09-11 16:24:43
接口功能介绍
查询所有的参数组
接口约束
无
URI
GET /DDS2/v2/openApi/describeAllParameterGroup
路径参数 无
Query参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| parameterGroupName | 否 | String | 参数模板名称 | ||
| pageNow | 否 | Integer | 当前页，不传默认为1 | 1 | |
| pageSize | 否 | Integer | 每页数量，不传默认为10 | 10 |
请求参数
请求头header参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| project-id | 否 | String | 项目id | 0 | |
| regionId | 是 | String | 资源池id | bb9fdb42056f11eda1610242ac110002 |
请求体body参数 无
响应参数
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| statusCode | Integer | 响应码 取值范围：800为成功，900为失败 | 800 | |
| message | String | 响应信息 | 查询MongoDB实例的主机告警规则成功 | |
| returnObj | Object | 返回对象数组 | returnObj | |
| error | String | 错误码。当接口失败时才返回具体错误编码，成功不返回或者为空。 | ||
| 表 returnObj |
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| id | Integer | 标志值 | ||
| userId | Long | 用户id | 113 | |
| groupId | Integer | 组id | 0 | |
| parameterGroupName | String | 参数组名称 | Default-Mongo-3.4 | |
| mongoEngine | String | 引擎版本 | 3.4 | |
| description | String | 参数组描述 | Default parameter group for Mongo 3.4 | |
| origindescription | String | 参数组原始描述 | Default parameter group for Mongo 3.4 | |
| isdefault | String | 是否为默认参数组 | 1 | |
| createTime | Integer | 参数组创建时间 | 1584924591000 | |
| edit | Byte | 是否可编辑 | 1 |
枚举参数
无
请求示例
请求url
/v1/parameterGroupOpenApi/describeAllParameterGroup
请求头header
project-id = 0
regionId=bb9fdb42056f11eda1610242ac110002
请求体body
无
响应示例
{
"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"
}
]
}
状态码
请参考 状态码
错误码
请参考 错误码
