DescribeParameterModificationHistory - ApsaraDB for MongoDB

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

dds:DescribeParameterModificationHistory

get

*dbinstance

acs:dds:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}

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-bp2235****
NodeId	string	No	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****
StartTime	string	Yes	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:10Z
EndTime	string	Yes	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:10Z
CharacterType	string	No	The role of the instance. Valid values: db: shard cs: Configserver mongos: mongos logic: sharded cluster instance	mongos

Response elements

Element	Type	Description	Example
	object	The returned results.
RequestId	string	The request ID.	B1BB6E0E-B4EF-4145-81FA-A07719860248
HistoricalParameters	object
HistoricalParameter	array<object>	Details about the parameter modification records.
	object
ParameterName	string	The name of the modified parameter.	operationProfiling.slowOpThresholdMs
OldParameterValue	string	The parameter value before modification.	100
NewParameterValue	string	The parameter value after modification.	200
ModifyTime	string	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

Success response

JSON format

{
  "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 code	Error code	Error message	Description
400	InvalidStartTime.Malformed	The Specified parameter StartTime is not valid.
400	InvalidEndTime.Malformed	The Specified parameter EndTime is not valid.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.