DescribeUniBackupDatabase - Security Center - Alibaba Cloud Documentation Center

Queries the information about databases for which anti-ransomware policies are created.

Debugging

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

Debug

Authorization information

There is currently no authorization information disclosed in the API.

Request parameters

Parameter	Type	Required	Description	Example
InstanceName	string	No	The name of the Elastic Compute Service (ECS) instance.	test
DatabaseType	string	No	The type of the database. Valid values: MYSQL MSSQL Oracle	MYSQL
PageSize	integer	No	The number of entries to return on each page. Default value: 20. If you leave this parameter empty, 20 entries are returned on each page. Note We recommend that you do not leave this parameter empty.	20
CurrentPage	integer	No	The number of the page to return. Default value: 1.	1
QueryType	string	No	The condition that is used to query the database. Valid values: create: newly created restore: restored	create
UniRegionId	string	No	The region ID of the server that hosts the database.	cn-hongkong

Response parameters

Parameter	Type	Description	Example
	object
RequestId	string	The ID of the request, which is used to locate and troubleshoot issues.	09969D2C-4FAD-429E-BFBF-9A60DEF8****
PageInfo	object	The pagination information.
CurrentPage	integer	The page number of the returned page.	1
PageSize	integer	The number of entries returned per page.	20
TotalCount	integer	The total number of entries returned.	25
Count	integer	The number of entries returned on the current page.	20
DatabaseList	array<object>	An array that consists of the information about the databases.
	object	The information about the database.
Status	string	The status of the ECS instance. Valid values: Stopped Running	Running
DatabaseType	string	The type of the database. Valid values: MYSQL MSSQL Oracle	MYSQL
DatabaseVersion	string	The version of the database engine.	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 UUID of the Hybrid Backup Recovery (HBR) agent that is used to back up the data of the database.	85878b284df911ec800000163e19****
CreatedByProduct	string	The service from which the database is created. Valid values: HBR: HBR AEGIS: Security Center	AEGIS
InstanceId	string	The ID of the server.	i-bp15aho9hhftvmhw****
PolicyId	long	The ID of the anti-ransomware policy.	123
AgentStatus	string	The status of the anti-ransomware agent. Valid values: UNKNOWN: unknown INSTALLED: installed INSTALL_FAILED: installation failed UNINSTALL_FAILED: uninstallation failed	INSTALLED

Examples

Sample success responses

JSONformat

{
  "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
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.