Call QueryPreCheckDatabase to get the result of a database precheck task - Security Center - Alibaba Cloud - Security Center

Queries the task result of a database dry run 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

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.	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.	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 pre-check progress. Valid values: 0 to 100.	100
Result	string	The task result of the dry run node. The value is a JSON string. The KEY valid values are: instanceId: the instance ID of the server where the database resides. checkTime: the dry run time. sourceType: the database type. results: the dry run items and task results. item: the dry run item. result: the dry run task result. Note Dry run 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.	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.	1671084106
CreatedTime	integer	The time when the pre-check started.	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

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.