All Products
Search

This Product

    Security Center:QueryPreCheckDatabase

    Document Center

    Security Center:QueryPreCheckDatabase

    Last Updated:Sep 18, 2026

    Queries the result of a database pre-check node.

    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:QueryPreCheckDatabase

    get

    *All Resource

    *

    		 None None

    Request parameters

    Parameter

    Type

    Required

    Description

    Example
    TaskId

    string

    No

    The ID of the database pre-check task.

    Note

    You can call the StartPreCheckDatabase operation to obtain this parameter.

    You must specify at least one of TaskId and InstanceUuid. If neither is specified, the API returns HTTP 400 with error code -106.

    Call DescribeUniBackupDatabase to obtain the InstanceUuid, and then pass it to StartPreCheckDatabase. The CreateMark returned by StartPreCheckDatabase is the TaskId required by this operation.

    t-000bc9nqwxsbyvod****
    InstanceUuid

    string

    No

    The unique identifier of the server database backup client.

    Note

    You can call the DescribeUniBackupDatabase operation to obtain this parameter.

    You must specify at least one of TaskId and InstanceUuid. If neither is specified, the API returns HTTP 400 with error code -106.

    ebc895506c6911ed800000163e0e****
    UniRegionId

    string

    Yes

    The region ID of the database server.

    cn-hangzhou

    Response elements

    Element

    Type

    Description

    Example

    object

    The response parameters.

    RequestId

    string

    The request ID. Alibaba Cloud generates a unique identifier for each API request. You can use this ID to troubleshoot issues.

    CE500770-42D3-442E-9DDD-156E0F9F****
    Progress

    integer

    The progress of the pre-check task. Valid values: 0 to 100.

    100
    Result

    string

    The result of the pre-check node. The value is in JSON format. The character string contains the following KEY values:

    • instanceId: The instance ID of the server where the database resides.

    • checkTime: The pre-check time.

    • sourceType: The database type.

    • results: The pre-check items and results.

      • item: The pre-check item.

      • result: The pre-check result.

    Note

    Pre-check item description

    • MSSQL

      • OSS_INTERNAL_ENDPOINT_CONNECTIVITY: OSS connectivity check.

      • SERVICE_CONNECTIVITY: Control network connectivity check.

      • SQL_SERVER_DB_IN_SIMPLE_RECOVERY_MODE: Recovery mode check.

      • SQL_SERVER_DB_NOT_ONLINE: SQL Server database status check.

    • ORACLE

      • OSS_INTERNAL_ENDPOINT_CONNECTIVITY: OSS connectivity check.

      • SERVICE_CONNECTIVITY: Control network connectivity check.

      • ORACLE_INSTANCE_STATUS: Oracle instance status check.

      • ORACLE_DB_STATUS: Oracle database status check.

      • ARCHIVELOG: Archive mode check.

    • MYSQL

      • OSS_INTERNAL_ENDPOINT_CONNECTIVITY: OSS connectivity check.

      • SERVICE_CONNECTIVITY: Control network connectivity check.

      • MYSQL_VERSION: Version check for full backup support.

      • MYSQL_BINLOG: BINLOG check.

    [ { "instanceId": "i-wz91if83t97xgtn2****", "checkTime": 1671245753, "sourceType": "MSSQL", "results": [ { "item": "OSS_INTERNAL_ENDPOINT_CONNECTIVITY", "result": "PASSED" }, { "item": "SERVICE_CONNECTIVITY", "result": "PASSED" }, { "item": "SQL_SERVER_DB_IN_SIMPLE_RECOVERY_MODE", "result": "WARNING" }, { "item": "SQL_SERVER_DB_NOT_ONLINE", "result": "PASSED" } ] } ]
    CompletedTime

    integer

    The time when the pre-check was completed. The value is a UNIX timestamp. Unit: seconds.

    1657524396
    Description

    string

    The status description of the pre-check task. Valid values:

    • completed: Completed.

    • created: Started.

    • error: Pre-check failed.

    completed
    UpdatedTime

    integer

    The time when the pre-check was last updated. The value is a UNIX timestamp. Unit: seconds.

    1671084106
    CreatedTime

    integer

    The time when the pre-check started. The value is a UNIX timestamp. Unit: seconds.

    1660448660

    Examples

    Success response

    JSON format

    {
  "RequestId": "CE500770-42D3-442E-9DDD-156E0F9F****",
  "Progress": 100,
  "Result": "[\n    {\n        \"instanceId\": \"i-wz91if83t97xgtn2****\",\n        \"checkTime\": 1671245753,\n        \"sourceType\": \"MSSQL\",\n        \"results\":\n        [\n            {\n                \"item\": \"OSS_INTERNAL_ENDPOINT_CONNECTIVITY\",\n                \"result\": \"PASSED\"\n            },\n            {\n                \"item\": \"SERVICE_CONNECTIVITY\",\n                \"result\": \"PASSED\"\n            },\n            {\n                \"item\": \"SQL_SERVER_DB_IN_SIMPLE_RECOVERY_MODE\",\n                \"result\": \"WARNING\"\n            },\n            {\n                \"item\": \"SQL_SERVER_DB_NOT_ONLINE\",\n                \"result\": \"PASSED\"\n            }\n        ]\n    }\n]",
  "CompletedTime": 1657524396,
  "Description": "completed",
  "UpdatedTime": 1671084106,
  "CreatedTime": 1660448660
}

    Error codes

    HTTP status code

    Error code

    Error message

    Description
    500 ServerError ServerError
    403 NoPermission caller has no permission You are not authorized to do this operation.

    See Error Codes for a complete list.

    Release notes

    See Release Notes for a complete list.