All Products
Search
Document Center

Security Center:DescribeUniBackupPolicies

Last Updated:Jan 28, 2023

Queries the anti-ransomware policies that are created for databases.

Authorization information

There is currently no authorization information disclosed in the API.

Request parameters

ParameterTypeRequiredDescriptionExample
PolicyNamestringNo

The name of the anti-ransomware policy.

auto_oracle_Hpm
PageSizeintegerNo

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.

NoteWe recommend that you do not leave this parameter empty.
20
CurrentPageintegerNo

The number of the page to return. Default value: 1.

1

Response parameters

ParameterTypeDescriptionExample
object

The data returned.

RequestIdstring

The ID of the request, which is used to locate and troubleshoot issues.

ACF97412-FD09-4D1F-994F-34DF12BR****
PageInfoobject

The pagination information.

CurrentPageinteger

The page number of the returned page.

1
PageSizeinteger

The number of entries returned per page.

20
TotalCountinteger

The total number of entries returned.

100
Countinteger

The number of entries returned on the current page.

20
UniBackupPoliciesarray

An array that consists of the anti-ransomware policies.

object

The information about the anti-ransomware policy.

PolicyStatusstring

The status of the anti-ransomware policy. Valid values:

  • initiating: initializing
  • opening: enabled
  • closing: disabled
  • deleting: deleting
opening
ErrorMessagestring

The error message for the anti-ransomware policy.

AttachRamRoleError
LatestBackResultstring

The execution result of the last backup task.

completed
UniRegionIdstring

The region ID of the server that hosts the database.

cn-hangzhou
PlanStatusstring

The status of the backup task. Valid values:

  • init: initializing
  • running: running
  • completed: complete
  • restoring: restoring
  • creating: creating
  • created: created
creating
InstanceUuidstring

The UUID of the Hybrid Backup Recovery (HBR) agent that is used to back up the data of the database.

cf1bcad4063f11ed800000163e0e****
PolicyNamestring

The name of the anti-ransomware policy.

auto_oracle_37f
AgentErrorMessagestring

The error message for the anti-ransomware agent.

INSTALL_TIMEOUT
InstanceIdstring

The ID of the server.

i-9dp7mubt5wit6g0h****
AgentStatusstring

The status of the anti-ransomware agent. Valid values:

  • UNKNOWN: unknown
  • INSTALLED: installed
  • INSTALL_FAILED: installation failed
  • UNINSTALL_FAILED: uninstallation failed
INSTALLED
DatabaseTypestring

The type of the database. Valid values:

  • MYSQL
  • MSSQL
  • Oracle
MYSQL
ErrorCodestring

The error code returned when the backup task fails.

EXPIRED
DatabaseNamestring

The name of the database.

abc123
InstanceNamestring

The name of the server.

sql-test-001
LatestBackupTimestring

The time when the last backup task was executed.

2022-01-01 00:00:11
InstanceStatusstring

The status of the Elastic Compute Service (ECS) instance. Valid values:

  • Stopped
  • Running
Running
PolicyIdlong

The ID of the anti-ransomware policy.

123

Example

Normal return example

JSONFormat

{
  "RequestId": "ACF97412-FD09-4D1F-994F-34DF12BR****",
  "PageInfo": {
    "CurrentPage": 1,
    "PageSize": 20,
    "TotalCount": 100,
    "Count": 20
  },
  "UniBackupPolicies": [
    {
      "PolicyStatus": "opening",
      "ErrorMessage": "AttachRamRoleError",
      "LatestBackResult": "completed",
      "UniRegionId": "cn-hangzhou",
      "PlanStatus": "creating",
      "InstanceUuid": "cf1bcad4063f11ed800000163e0e****",
      "PolicyName": "auto_oracle_37f",
      "AgentErrorMessage": "INSTALL_TIMEOUT",
      "InstanceId": "i-9dp7mubt5wit6g0h****",
      "AgentStatus": "INSTALLED",
      "DatabaseType": "MYSQL",
      "ErrorCode": "EXPIRED",
      "DatabaseName": "abc123",
      "InstanceName": "sql-test-001",
      "LatestBackupTime": "2022-01-01 00:00:11",
      "InstanceStatus": "Running",
      "PolicyId": 123
    }
  ]
}

Error codes

Http codeError codeError messageDescription
403NoPermissioncaller has no permissionYou are not authorized to do this operation.
500ServerErrorServerError-

For a list of error codes, visit the API error center.