API Introduction
Call the DescribeParameterTemplates API to query the MongoDB default parameter template list.
API Restrictions
None
URI
GET /v1/openApi/describeParameterTemplates
Request Parameters
Request Header Parameter
None
Request body query parameter
Parameter | Required or Not | Parameter Type | Description | Example | Lower-level Object |
prodInstId | Yes | String | Instance ID. | 555b89493b1a40e1b97ea05e50dd8170 | |
parameterGroupUsed | Yes | String | Parameter group name, indicating the parameter group version | ||
pageNow | No | Integer | Current page | 1 | |
pageSize | No | Integer | Number per page | 10 | |
parameterName | No | String | Parameter name |
Response Parameter
Parameter | Required or Not | Parameter Type | Description | Example | Lower-level Object |
statusCode | Yes | String | Return code Value range: 800 indicates success | 800 | |
message | Yes | String | Return to Messages | ||
returnObj | Yes | Object[] | Return object array | returnObj |
returnObj
Parameter | Required or Not | Parameter Type | Description | Example | Lower-level Object |
parameterGroupName | Yes | String | Parameter group name | ||
valuetype | Yes | String | Parameter data type | ||
restart | Yes | String | Whether the parameter is restarted to take effect | ||
defaultValue | Yes | String | Default Value | ||
groupId | Yes | String | Whether the parameter is allowed to be modified by users, 0 means allowed. | ||
description | Yes | String | Description of the parameters | ||
parameterName | Yes | String | Parameter name | ||
parameterValue | Yes | String | Parameter Value | ||
userId | Yes | Integer | User id | ||
prodInstId | Yes | String | Instance ID. | ||
id | Yes | Integer | Primary key | ||
isdefault | Yes | String | Whether the parameter is allowed to be modified by users, 0 means allowed. | ||
permitValue | Yes | String | Allowable range of parameter values |
Sample Request
Request Header
None
Request parameter query
/v1/openApi/describeParameterTemplates?prodInstId=a649077e15f349cb8b4cde6f7285a568
Response Example
{
"statusCode": 800,
"message": "the MongoDB default parameter template list is queried successfully",
"returnObj": {
"lastPage": 2,
"navigatepageNums": [
1,
2
],
"startRow": 1,
"hasNextPage": true,
"prePage": 0,
"nextPage": 2,
"endRow": 10,
"pageSize": 10,
"list": [
{
"parameterGroupName": "Default-Mongo-4.0",
"valuetype": "string",
"restart": "1",
"defaultValue": "true",
"groupId": null,
"description": "????????????????????????????????",
"parameterName": "storage.directoryPerDB",
"parameterValue": "true",
"userId": 149,
"prodInstId": null,
"id": 62238,
"isdefault": "1",
"permitValue": "true,false"
}
],
"pageNum": 1,
"navigatePages": 8,
"total": 17,
"pages": 2,
"firstPage": 1,
"size": 10,
"isLastPage": false,
"hasPreviousPage": false,
"isFirstPage": true
}
}Status Code
Status Code | Description |
800 | Indicate that the request succeeded |
900 | Request response failed, see message for reason of failure |
Error Codes
None