DescribeBackupMachineStatus - Security Center - Alibaba Cloud Documentation Center

Queries the backup status of a sever to which an anti-ransomware policy is applied.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

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
yundun-sas:DescribeBackupMachineStatus	get	All Resources *	none	none

Request parameters

Parameter	Type	Required	Description	Example
PolicyId	long	Yes	The ID of the anti-ransomware policy. Note You can call the DescribeBackupPolicies operation to query the IDs of anti-ransomware policies.	123
Uuid	string	Yes	The UUID of the server. Note You can call the DescribeBackupPolicy operation to query the UUIDs of servers.	eb2c782e-64f2-4590-a86c-d90164df****
PolicyVersion	string	No	The version of the anti-ransomware policy. Valid values: 1.0.0 2.0.0	2.0.0

Response parameters

Parameter	Type	Description	Example
	object	The response parameters.
RequestId	string	The ID of the request, which is used to locate and troubleshoot issues.	09969D2C-4FAD-429E-BFBF-9A60DEF8****
BackupMachineStatus	object	The backup status of the server.
Status	string	The status of the anti-ransomware agent. Valid values: NOT_INSTALLED: not installed CLIENT_CONNECTION_ERROR: abnormal ACTIVATED: normal	ACTIVATED
Uuid	string	The UUID of the server.	eb2c782e-64f2-4590-a86c-d90164df****
VaultId	string	The ID of the backup vault in which the backup data is stored.	v-0005i2qh5fcr6seo****
ErrorCode	string	The error code returned.	CLIENT_CONNECTION_ERROR
SavedBackupCount	integer	The number of backup versions.	7
InstanceId	string	The ID of the server.	i-2zeaqkb80vloxjcj****
ClientStatus	string	The status of the anti-ransomware agent. Valid values: ONLINE: normal CLIENT_CONNECTION_ERROR: abnormal UNINSTALLING: being uninstalled UNINSTALL_FAILED: failed to be uninstalled UPGRADING: being upgraded UPGRADE_FAILED: failed to be upgraded	ONLINE
RegionId	string	The ID of the region in which the server resides.	cn-shenzhen
ClientVersion	string	The version of the anti-ransomware agent.	2.11.0
ClientId	string	The ID of the anti-ransomware agent.	c-000dbefaw9f7gnbw****
ErrorList	array<object>	An array that consists of the error information reported by the backup server.
BackupErrorMsg	object	The error information reported by the backup server.
ErrorCode	string	The error code.	TARGET_NOT_EXIST
ErrorStatus	string	The error message.	FAILED
ServiceStatus	string	The status of the anti-ransomware service. Valid values: SERVICE_EXCEPTION: Service exception RESTORING: Restoring BACKING_UP: Backup in process	RESTORING

Examples

Sample success responses

JSONformat

{
  "RequestId": "09969D2C-4FAD-429E-BFBF-9A60DEF8****",
  "BackupMachineStatus": {
    "Status": "ACTIVATED",
    "Uuid": "eb2c782e-64f2-4590-a86c-d90164df****",
    "VaultId": "v-0005i2qh5fcr6seo****",
    "ErrorCode": "CLIENT_CONNECTION_ERROR",
    "SavedBackupCount": 7,
    "InstanceId": "i-2zeaqkb80vloxjcj****",
    "ClientStatus": "ONLINE",
    "RegionId": "cn-shenzhen",
    "ClientVersion": "2.11.0",
    "ClientId": "c-000dbefaw9f7gnbw****",
    "ErrorList": [
      {
        "ErrorCode": "TARGET_NOT_EXIST",
        "ErrorStatus": "FAILED"
      }
    ],
    "ServiceStatus": "RESTORING"
  }
}

Error codes

HTTP status code	Error code	Error message	Description
403	NoPermission	caller has no permission	You are not authorized to do this operation.
500	ServerError	ServerError	-

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

Change history

Change time	Summary of changes	Operation
2023-12-06	The response structure of the API has changed	View Change Details