All Products
Search
Document Center

ApsaraDB for MongoDB:DescribeParameterModificationHistory

Last Updated:Mar 15, 2024

Queries the parameter modification records of an ApsaraDB for MongoDB instance.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

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.
OperationAccess levelResource typeCondition keyAssociated operation
dds:DescribeParameterModificationHistoryREAD
  • dbinstance
    acs:dds:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
DBInstanceIdstringYes

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-bp2235****
NodeIdstringNo

The ID of the mongos node or shard node whose parameter modification records you want to query in the instance.

Note This parameter is valid only when DBInstanceId is set to the ID of a sharded cluster instance.
d-bp1158****
StartTimestringYes

The beginning of the time range to query. Specify the time in the ISO 8601 standard in the yyyy-MM-ddTHH:mmZ format. The time must be in UTC.

2019-01-01T12:10:10Z
EndTimestringYes

The end of the time range to query. Specify the time in the ISO 8601 standard in the yyyy-MM-ddTHH:mmZ format. The time must be in UTC. The end time must be later than the start time.

2019-01-02T12:10:10Z
CharacterTypestringNo

The role of the instance. Valid values:

  • db: shard
  • cs: Configserver
  • mongos: mongos
  • logic: sharded cluster instance
mongos

Response parameters

ParameterTypeDescriptionExample
object

The returned results.

RequestIdstring

The request ID.

B1BB6E0E-B4EF-4145-81FA-A07719860248
HistoricalParametersobject []

Details about the parameter modification records.

ParameterNamestring

The name of the modified parameter.

operationProfiling.slowOpThresholdMs
OldParameterValuestring

The parameter value before modification.

100
NewParameterValuestring

The parameter value after modification.

200
ModifyTimestring

The time when the parameter was modified. The time follows the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time is displayed in UTC.

2019-03-12T07:58:24Z

Examples

Sample success responses

JSONformat

{
  "RequestId": "B1BB6E0E-B4EF-4145-81FA-A07719860248",
  "HistoricalParameters": {
    "HistoricalParameter": [
      {
        "ParameterName": "operationProfiling.slowOpThresholdMs",
        "OldParameterValue": "100",
        "NewParameterValue": "200",
        "ModifyTime": "2019-03-12T07:58:24Z"
      }
    ]
  }
}

Error codes

HTTP status codeError codeError message
400InvalidStartTime.MalformedThe Specified parameter StartTime is not valid.
400InvalidEndTime.MalformedThe Specified parameter EndTime is not valid.

For a list of error codes, visit the Service error codes.

Change history

Change timeSummary of changesOperation
No change history