API Introduction
Call the describeParameters API to query the parameter configuration of the instance.
API Restrictions
None
URI
GET /v1/openApi/describeParameters
Path Parameter
None
Query Parameter
Parameter | Required or Not | Parameter Type | Description | Example | Lower-level Object |
prodInstId | Yes | String | Instance ID. | 555b89493b1a40e1b97ea05e50dd8170 | |
pageNow | No | Integer | Current page | 1 | |
pageSize | No | Integer | Number per page | 1 | |
parameterName | No | String | Parameter Name |
Request Parameters
Request Header Parameter
None
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 |
Table retunObj
Parameter | Required or Not | Parameter Type | Description | Example | Lower-level Object |
userId | Yes | String | User id | ||
isdefault | Yes | String | Whether the parameters can be modified | ||
parameterGroupName | Yes | String | Parameter group name | ||
parameterValue | Yes | String | Parameter Value | ||
parameterName | Yes | String | Parameter name | ||
permitValue | Yes | string | Allowable range of the parameter | ||
valuetype | Yes | String | Parameter data type | ||
restart | Yes | String | Whether the parameter is restarted to take effect | ||
description | Yes | String | Parameter Description |
Sample Request
Request Header
None
Request parameter query
/v1/openApi/describeParameters?prodInstId=a649077e15f349cb8b4cde6f7285a568
Response Example
{
"statusCode":800,
"message":"the parameter configuration of MongoDB instance is queried by the API successfully",
"returnObj":{
"startRow":1,
"hasNextPage":false,
"prePage":0,
"nextPage":0,
"endRow":1,
"pageSize":10,
"list":[
{
"id":"52",
"userId":"0",
"groupId":"0",
"isdefault":"0",
"parameterGroupName":"Default-Mongo-3.4",
"parameterValue":"600",
"permitValue":"",
"parameterName":"connPoolMaxConnsPerHost",
"valuetype":"int",
"restart":"1",
"description":"indicates the maximum number of connections in the connection pool that the current instance communicates with other mongod instances"
}
],
"pageNum":1,
"navigatePages":8,
"total":1,
"pages":1,
"firstPage":1,
"size":1,
"isLastPage":true,
"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