DescribePreCheckResult - PolarDB - Alibaba Cloud Documentation Center

Calls the DescribePreCheckResult operation to view the pre-check result.

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

drds:DescribePreCheckResult

get

*instance

acs:drds:{#regionId}:{#accountId}:instance/{#instanceId}/db/*

None

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	No	The region ID.	cn-hangzhou
DrdsInstanceId	string	Yes	The instance ID.	drdshbga76p6****
TaskId	string	Yes	The task ID.	4561

Response elements

Element	Type	Description	Example
	object
Success	boolean	Indicates whether the request was successful.	true
RequestId	string	The request ID.	DescribePreCheckResult
PreCheckResult	object	The pre-check result.
PreCheckName	string	The name of the pre-check.	是否有唯一键
State	string	The status.	FAIL
SubCheckItems	array<object>	The details of sub pre-check tasks.
	object
ErrorMsgCode	string	Indicates the error code that is returned by a subtask.	1004
PreCheckItemName	string	Indicates the name of the subtask.	唯一键
State	string	Indicates the state of the subtask.	成功
ErrorMsgParams	array	Indicates an error message.
	string		table1

Examples

Success response

JSON format

{
  "Success": true,
  "RequestId": "DescribePreCheckResult",
  "PreCheckResult": {
    "PreCheckName": "是否有唯一键",
    "State": "FAIL",
    "SubCheckItems": [
      {
        "ErrorMsgCode": "1004",
        "PreCheckItemName": "唯一键",
        "State": "成功",
        "ErrorMsgParams": [
          "table1"
        ]
      }
    ]
  }
}

Error codes

HTTP status code	Error code	Error message	Description
400	%s	%s
500	InternalError	The request processing has failed due to some unknown error.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.