DescribeUniBackupDatabase API for Anti-Ransomware Protection - Security Center - Alibaba Cloud - Security Center

Queries the details of databases in database protection policies.

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

yundun-sas:DescribeUniBackupDatabase

get

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
InstanceName	string	No	The name of the ECS instance.	test
DatabaseType	string	No	The type of the database. Valid values: MYSQL MSSQL Oracle.	MYSQL
PageSize	integer	No	The maximum number of entries per page in a paging query. Default value: 20. If you leave this parameter empty, 20 entries are returned per page by default. Note Do not leave PageSize empty.	20
CurrentPage	integer	No	The page number of the page to return. Default value: 1, which indicates the first page.	1
QueryType	string	No	The query type for the database. Valid values: create: create restore: restore.	create
UniRegionId	string	No	The region ID of the database server.	cn-hongkong

Response elements

Element	Type	Description	Example
	object
RequestId	string	The request ID. Alibaba Cloud generates a unique identifier for each request. You can use the request ID to troubleshoot issues.	09969D2C-4FAD-429E-BFBF-9A60DEF8****
PageInfo	object	The pagination information.
CurrentPage	integer	The page number of the current page in a paging query.	1
PageSize	integer	The number of databases per page in a paging query.	20
TotalCount	integer	The total number of databases.	25
Count	integer	The number of databases on the current page.	20
DatabaseList	array<object>	The list of database details.
	object	The database details.
Status	string	The instance status of the ECS instance. Valid values: Stopped: stopped. Running: running.	Running
DatabaseType	string	The type of the database. Valid values: MYSQL MSSQL Oracle.	MYSQL
DatabaseVersion	string	The version of the database.	12.0.4100.1
DatabaseName	string	The name of the database.	apns_tt180
InstanceName	string	The name of the instance to which the database belongs.	sql-test-001
InstanceUuid	string	The unique identifier of the database backup client on the server.	85878b284df911ec800000163e19****
CreatedByProduct	string	The method used to create the database. Valid values: HBR: Cloud Backup. AEGIS: Security Center.	AEGIS
InstanceId	string	The instance ID of the server.	i-bp15aho9hhftvmhw****
PolicyId	integer	The ID of the anti-ransomware backup policy for the database.	123
AgentStatus	string	The status of the database client agent. Valid values: UNKNOWN: unknown. INSTALLED: installed. INSTALL_FAILED: installation failed. UNINSTALL_FAILED: uninstallation failed.	INSTALLED

Examples

Success response

JSON format

{
  "RequestId": "09969D2C-4FAD-429E-BFBF-9A60DEF8****",
  "PageInfo": {
    "CurrentPage": 1,
    "PageSize": 20,
    "TotalCount": 25,
    "Count": 20
  },
  "DatabaseList": [
    {
      "Status": "Running",
      "DatabaseType": "MYSQL",
      "DatabaseVersion": "12.0.4100.1",
      "DatabaseName": "apns_tt180",
      "InstanceName": "sql-test-001",
      "InstanceUuid": "85878b284df911ec800000163e19****",
      "CreatedByProduct": "AEGIS",
      "InstanceId": "i-bp15aho9hhftvmhw****",
      "PolicyId": 123,
      "AgentStatus": "INSTALLED"
    }
  ]
}

Error codes

HTTP status code	Error code	Error message	Description
500	ServerError	ServerError
403	NoPermission	caller has no permission

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.