API Introduction
Call describeAllParameterGroup to query all parameter group information.
API Restrictions
None
URI
GET /v1/parameterGroupOpenApi/describeAllParameterGroup
Path Parameter
None
Query Parameter
None
Request Parameters
Request Header Parameter
None
Response Parameter
Parameter | Required or Not | Parameter Type | Description | Lower-level Object | |
statusCode | Yes | Integer | Response Code Value range: 800 indicates success, 900 indicates failure | 800 | |
message | Yes | String | Response information | The host alarm rules of the MongoDB instance are queried successfully | |
returnObj | Yes | Object[] | Return object array | returnObj |
Table returnObj
Parameter | Required or Not | Parameter Type | Description | Example | Lower-level Object |
id | Yes | Integer | Flag value | ||
userId | Yes | Long | User id | ||
groupId | Yes | Short | Group id | ||
parameterGroupName | Yes | String | Parameter group name | ||
mongoEngine | Yes | String | Engine Version | ||
description | Yes | String | Parameter group description | ||
origindescription | Yes | String | Original description of the parameter group | ||
isdefault | Yes | String | Whether it is the default parameter group | ||
createTime | Yes | Date | Creation time of the parameter group | ||
edit | Yes | Byte | Whether it is editable |
Sample Request
Request Header
None
Request parameter query
/v1/parameterGroupOpenApi/describeAllParameterGroup
Response Example
{
"statusCode": 800,
"message": "the parameter group information is queried successfully",
"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"
}
]
}Status Code
Status Code | Description |
800 | Indicate that the request succeeded |
900 | Indicates that the request failed |
Error Codes
None