查詢所有參數組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"
}
]
}
狀態碼
請參考
錯誤碼
請參考
