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. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.

Request parameters

Parameter Type Required Example Description
Action String Yes DescribeParameterModificationHistory

The operation that you want to perform. Set the value to DescribeParameterModificationHistory.

RegionId String No cn-hangzhou

The region ID the instance. You can call the DescribeDBInstanceAttribute operation to query the region ID of the instance.

DBInstanceId String Yes dds-bp2235****

The ID of the instance.

Note If you set this parameter to the ID of a sharded cluster instance, you must also specify the NodeId parameter.
NodeId String No d-bp1158****

The ID of the mongos node or shard node whose parameter modification records you want to query in the instance. If the instance is a sharded cluster instance, you must specify this parameter.

Note This parameter is valid only when DBInstanceId is set to the ID of a sharded cluster instance.
StartTime String Yes 2019-01-01T12:10:10Z

The beginning of the time range to query. The time follows the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time is displayed in UTC.

EndTime String Yes 2019-01-02T12:10:10Z

The end of the time range to query. The end time must be later than the start time. Specify the time in the yyyy-MM-ddTHH:mm:ssZ format. The time must be in UTC.

CharacterType String No mongos

The role of the instance. Valid values:

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

Response parameters

Parameter Type Example Description
RequestId String B1BB6E0E-B4EF-4145-81FA-A07719860248

The ID of the request.

HistoricalParameters Array of HistoricalParameter

Details about the parameter modification records.

HistoricalParameter
ParameterName String operationProfiling.slowOpThresholdMs

The name of the modified parameter.

OldParameterValue String 100

The parameter value before modification.

NewParameterValue String 200

The parameter value after modification.

ModifyTime String 2019-03-12T07:58:24Z

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.

Examples

Sample requests

http(s)://mongodb.aliyuncs.com/?Action=DescribeParameterModificationHistory
&DBInstanceId=dds-bp2235****
&NodeId=d-bp1158****
&StartTime=2019-01-01T12:10:10Z
&EndTime=2019-01-02T12:10:10Z
&CharacterType=mongos
&Common request parameters

Sample success responses

XML format 

HTTP/1.1 200 OK
Content-Type:application/xml

<DescribeParameterModificationHistoryResponse>
    <RequestId>B1BB6E0E-B4EF-4145-81FA-A07719860248</RequestId>
    <HistoricalParameters>
        <ParameterName>operationProfiling.slowOpThresholdMs</ParameterName>
        <OldParameterValue>100</OldParameterValue>
        <NewParameterValue>200</NewParameterValue>
        <ModifyTime>2019-03-12T07:58:24Z</ModifyTime>
    </HistoricalParameters>
</DescribeParameterModificationHistoryResponse>

JSON format 

HTTP/1.1 200 OK
Content-Type:application/json

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

Error codes

For a list of error codes, visit the API Error Center.