DescribeClusterRecoverTime - ApsaraDB for MongoDB - Alibaba Cloud Documentation Center

Operation description

This operation applies only to sharded cluster instances that run MongoDB 4.4 or later and use Enhanced SSDs (ESSDs).
If an instance was created before October 19, 2023, you must call the TransferClusterBackup operation to switch it to the cluster backup mode. You can call this operation directly for instances that were created on or after October 19, 2023, or have already been switched to the cluster backup mode.

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:DescribeClusterRecoverTime

get

*Instance

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

None

Request parameters

Parameter	Type	Required	Description	Example
DBInstanceId	string	Yes	The instance ID.	dds-bp18f7d6b6a7****
SrcRegion	string	No	The region of the source instance for geo-redundancy. Note This parameter is required when you query a geo-redundant backup.	cn-beijing
DestRegion	string	No	The region where the geo-redundant backup set is located. Note This parameter is required when you query a geo-redundant backup.	cn-hangzhou
ResourceGroupId	string	No	The ID of the resource group.	rg-xxxx

Response elements

Element	Type	Description	Example
	object	The schema of the response.
RequestId	string	The request ID.	60EEBD77-227C-5B39-86EA-D89163C5****
RestoreRanges	array<object>	A list of cluster backups. Each backup includes the backup set for every node.
	object
RestoreBeginTime	string	The beginning of the restorable time range.	2023-10-16T19:33:20Z
RestoreEndTime	string	The end of the restorable time range.	2023-10-16T19:43:20Z
RestoreType	string	The restoration method. Valid value: PointInTime (default): point-in-time recovery.	PointInTime

Examples

Success response

JSON format

{
  "RequestId": "60EEBD77-227C-5B39-86EA-D89163C5****",
  "RestoreRanges": [
    {
      "RestoreBeginTime": "2023-10-16T19:33:20Z",
      "RestoreEndTime": "2023-10-16T19:43:20Z",
      "RestoreType": "PointInTime"
    }
  ]
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.