调用QueryPreCheckDatabase查询数据库预检任务结果_云安全中心(Security Center)-阿里云帮助中心

查询数据库预检任务结果。

调试

您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：

操作：是指具体的权限点。
访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用背景高亮的方式表示。
- 对于不支持资源级授权的操作，用全部资源表示。
条件关键字：是指云产品自身定义的条件关键字。
关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

操作	访问级别	资源类型	条件关键字	关联操作
yundun-sas:QueryPreCheckDatabase	Read	全部资源 *	无	无

请求参数

名称	类型	必填	描述	示例值
TaskId	string	否	数据库预检任务 ID。说明您可以调用 StartPreCheckDatabase 接口获取该参数。	t-000bc9nqwxsbyvod****
InstanceUuid	string	否	服务器数据库备份客户端唯一标识。说明调用 DescribeUniBackupDatabase 接口可以获取该参数。	ebc895506c6911ed800000163e0e****
UniRegionId	string	是	数据库服务器所在的地域 ID。	cn-hangzhou

返回参数

名称	类型	描述	示例值
	object	请求返回参数。
RequestId	string	本次调用请求的 ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。	CE500770-42D3-442E-9DDD-156E0F9F****
Progress	integer	预检查进度。取值范围：0~100。	100
Result	string	预检查任务结果。格式为 JSON 字符串，KEY 取值： instanceId：数据库所在服务器实例 ID checkTime：预检时间 sourceType：数据库类型 results：预检项与结果 item：预检项 result：预检结果说明预检项说明 MSSQL OSS_INTERNAL_ENDPOINT_CONNECTIVITY：OSS连接性检查 SERVICE_CONNECTIVITY：管控网络连接性检查 SQL_SERVER_DB_IN_SIMPLE_RECOVERY_MODE：恢复模式检查 SQL_SERVER_DB_NOT_ONLINE：SQL Server 数据库状态检查 ORACLE OSS_INTERNAL_ENDPOINT_CONNECTIVITY：OSS连接性检查 SERVICE_CONNECTIVITY：管控网络连接性检查 ORACLE_INSTANCE_STATUS：Oracle 实例状态检查 ORACLE_DB_STATUS：Oracle 数据库状态检查 ARCHIVELOG：归档模式检查 MYSQL OSS_INTERNAL_ENDPOINT_CONNECTIVITY：OSS连接性检查 SERVICE_CONNECTIVITY：管控网络连接性检查 MYSQL_VERSION：支持全量备份的版本检查 MYSQL_BINLOG：BINLOG 检查	[ { "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	long	预检查完成的时间。	1657524396
Description	string	预检查任务状态描述。取值如下： completed：已完成 created：已开始 error：预检失败	completed
UpdatedTime	long	预检查最后更新的时间。	1671084106
CreatedTime	long	预检查开始的时间。	1660448660

示例

正常返回示例

JSON格式

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

错误码

HTTP status code	错误码	错误信息	描述
403	NoPermission	caller has no permission	当前操作未被授权，请联系主账号在RAM控制台进行授权后再执行操作。
500	ServerError	ServerError	服务故障，请稍后重试！

访问错误中心查看更多错误码。