Queries the parameter settings of an ApsaraDB for MongoDB instance.
Debugging
Authorization information
The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action
policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:
- Operation: the value that you can use in the Action element to specify the operation on a resource.
- Access level: the access level of each operation. The levels are read, write, and list.
- Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
- The required resource types are displayed in bold characters.
- If the permissions cannot be granted at the resource level,
All Resources
is used in the Resource type column of the operation.
- Condition Key: the condition key that is defined by the cloud service.
- Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
Operation | Access level | Resource type | Condition key | Associated operation |
---|---|---|---|---|
dds:DescribeParameters | get |
|
| none |
Request parameters
Parameter | Type | Required | Description | Example |
---|---|---|---|---|
DBInstanceId | string | Yes | The instance ID. Note
If you set this parameter to the ID of a sharded cluster instance, you must also specify the NodeId parameter.
| dds-bpxxxxxxxx |
NodeId | string | No | The ID of the mongos or shard node in the specified sharded cluster instance. Note
This parameter is valid when the DBInstanceId parameter is set to the ID of a sharded cluster instance.
| d-bpxxxxxxxx |
CharacterType | string | No | The role of the instance. Valid values:
| mongos |
ExtraParam | string | No | The parameter that is available in the future. | terrform |
Response parameters
Examples
Sample success responses
JSON
format
{
"RunningParameters": {
"Parameter": [
{
"CheckingCode": "[33554432-268435456]",
"ParameterName": "setParameter.internalQueryExecMaxBlockingSortBytes",
"ParameterValue": "33554432",
"ForceRestart": "false",
"ParameterDescription": "The maximum memory bytes that sort stage may use, default is 33554432(i.e. 32MB)",
"ModifiableStatus": "true",
"CharacterType": "db"
}
]
},
"EngineVersion": "4.0",
"RequestId": "3ADD0C7D-2D2A-4F15-88FF-E7AC9B9FDCC8",
"ConfigParameters": {
"Parameter": [
{
"CheckingCode": "[0-65536]",
"ParameterName": "operationProfiling.slowOpThresholdMs",
"ParameterValue": "200",
"ForceRestart": true,
"ParameterDescription": "The threshold in milliseconds at which the database profiler considers a query slow, default is 100.",
"ModifiableStatus": true
}
]
},
"Engine": "mongodb"
}
Error codes
HTTP status code | Error code | Error message | Description |
---|---|---|---|
403 | IncorrectDBInstanceType | Current DB instance type does not support this operation. | This operation is not supported for the specified instance type. |
404 | InvalidDBInstanceClass.NotFound | The specified DB instance type is not found. | Invalid instance type. Specify another instance type. |
For a list of error codes, visit the Service error codes.
Change history
Change time | Summary of changes | Operation |
---|---|---|
2023-03-15 | The Error code has changed. The request parameters of the API has changed | View Change Details |