DescribeBackupStorage - ApsaraDB for MongoDB - Alibaba Cloud Documentation Center

Queries the storage used for backup in an ApsaraDB for MongoDB replica set or sharded cluster instance that uses cloud disks. Note that you are charged only for the backup-used storage of each shard in a sharded cluster instance. You can call this operation only to query the storage used by a single shard in the instance for backup.

Debugging

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

Debug

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.

Operation	Access level	Resource type	Condition key	Associated operation
dds:DescribeBackupStorage	get	Instance acs:dds:{#regionId}:{#accountId}:dbinstance/{#dbInstanceId}	none	none

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	No	The region ID of the instance. You can call the DescribeDBInstanceAttribute operation to query the most recent region list.	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 only when the DBInstanceId parameter is set to the ID of a sharded cluster instance.	d-2zee48956b4axxxx

Response parameters

Parameter	Type	Description	Example
	object
RequestId	string	The request ID.	D648B367-15B6-1B42-BD4B-4XXXXXXXXX
FullStorageSize	integer	The storage capacity used for the full backup. Unit: bytes. Note Instances that use cloud disks support snapshot backup. The size of the storage used for the current full backup is the size of the snapshot chain.	789221621
LogStorageSize	integer	The storage capacity used for the log backup. Unit: bytes.	7892216
FreeSize	integer	The free quota for the storage capacity used for backup. Unit: bytes.	42949672960

Examples

Sample success responses

JSONformat

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

Error codes

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

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