All Products
Search
Document Center

ApsaraDB RDS:PrecheckDuckDBDependency

Last Updated:Nov 11, 2025

Checks whether DuckDB-based analytical instances can be created for the specified RDS for PostgreSQL primary instance. If DuckDB-based analytical instances cannot be created, this operation returns the failure causes and provides solutions or recommended specification values.

Operation description

Supported database engine

RDS PostgreSQL

References

DuckDB-based analytical instance

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

  • Operation: the value that you can use in the Action element to specify the operation on a resource.
  • Access level: the access level of each operation. The levels are read, write, and list.
  • Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
    • For mandatory resource types, indicate with a prefix of * .
    • If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
  • Condition Key: the condition key that is defined by the cloud service.
  • Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
OperationAccess levelResource typeCondition keyAssociated operation
rds:PrecheckDuckDBDependencyget
*DBInstance
acs:rds:{#regionId}:{#accountId}:dbinstance/{#DbInstanceId}
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
DBInstanceIdstringYes

The primary instance ID.

pgm-2zegy5pdkg58****

Response parameters

ParameterTypeDescriptionExample
object

The response parameters.

FailedCheckItemsarray<object>

The check items that do not meet the requirements for creating DuckDB-based analytical instances.

failedCheckItemsobject
AllowAutoModifyboolean

Indicates whether the item can be changed with one click to meet the requirements.

Note If the major engine version of the primary does not meet the requirements, you must manually upgrade it.
false
CurrentValuestring

The current value of the check item.

15.0
Namestring

The name of the check item.

MajorVersion
RequiredValuestring

The value or value range that meets the requirements.

17.0
Typestring

The check item. Valid values:

  • Parameter: The parameters of the primary instance.
  • MinorVersion: The minor engine version of the primary instance.
  • MajorVersion: The major engine version of the primary instance.
Parameter
Resultboolean

Indicates whether the primary instance meet the requirements for creating DuckDB-based analytical instances. Valid values:

  • true
  • false
false

Examples

Sample success responses

JSONformat

{
  "FailedCheckItems": [
    {
      "AllowAutoModify": true,
      "CurrentValue": 15,
      "Name": "MajorVersion",
      "RequiredValue": 17,
      "Type": "Parameter"
    }
  ],
  "Result": true
}

Error codes

HTTP status codeError codeError messageDescription
400IdempotentParameterMismatchThe request uses the same client token as a previous, but non-identical request. Do not reuse a client token with different requests, unless the requests are identical.-
400ReadonlyInstanceNotSupportThe operation is not permitted due to type of the instance.The specified read-only instance does not support this operation.
400InvalidEngineVersionThe specified EngineVersion is invalid.The specified EngineVersion parameter is invalid.
400MissingParameter.MinorVersionTagYou must specify the parameter MinorVersionTag.The minor engine version cannot be left unspecified.
400Workbench.InternalFailureECS workbench returns an internal failure. Please check password expiration policy and / or other issues.The ECS workbench API returned an internal error, with a high probability that the account password is incorrect. Please check whether the host account password has expired, and other possible circumstances.
403ReadOnlyInstanceNotSupportRead-only instance does not support this operation.This operation is not supported for read-only instances.
403DBInstanceStatusNotActiveThe status of the current instance is not active.The operation failed. Check the status of the RDS instance.
403IncorrectDBInstanceTypeThe database instance type does not support the operation.The operation failed. The operation is not supported for the database engine of the RDS instance.
403GroupReplicationNotSupport.InvalidEngineVersionGroup Replication requires the instance engine version to be 8.0.-
500InternalFailureThe request processing has failed due to some unknown error, exception or failure.An internal error or exception has occurred.

For a list of error codes, visit the Service error codes.