DescribeBackupStorage - ApsaraDB for MongoDB - Alibaba Cloud Documentation Center

Operation description

Backup usage for a sharded cluster is billed on a per-shard basis. You can use this operation to query the backup usage for a single shard.

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

get

*Instance

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

None

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	No	The ID of the region where the instance is located. Call the DescribeDBInstanceAttribute operation to query the region ID.	cn-bejing
DBInstanceId	string	Yes	The instance ID.	dds-2zeb2d64cb46xxxx
NodeId	string	No	The ID of the shard node in the sharded cluster instance. Note This parameter is required if the DBInstanceId parameter specifies the ID of a sharded cluster instance.	d-2zee48956b4axxxx

Response elements

Element	Type	Description	Example
	object
RequestId	string	The request ID.	D648B367-15B6-1B42-BD4B-4XXXXXXXXX
FullStorageSize	integer	The storage space used by full backups. Unit: bytes. Note Instances that use cloud disks are backed up using snapshots. The size of a full backup is the total size of the snapshot chain.	789221621
LogStorageSize	integer	The storage space used by log backups. Unit: bytes.	7892216
FreeSize	integer	The free backup quota for the instance. Unit: bytes.	42949672960

Examples

Success response

JSON format

{
  "RequestId": "D648B367-15B6-1B42-BD4B-4XXXXXXXXX",
  "FullStorageSize": 789221621,
  "LogStorageSize": 7892216,
  "FreeSize": 42949672960
}

Error codes

HTTP status code	Error code	Error message	Description
400	InvalidDBInstance.Malformed	Too many instance ids or instance id format is invalid.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.