All Products
Search

This Product

    PolarDB:GenerateUpgradeReportForSyncClone

    Document Center

    PolarDB:GenerateUpgradeReportForSyncClone

    Last Updated:Sep 24, 2026

    Generates a check report.

    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

    polardb:GenerateUpgradeReportForSyncClone

    create

    *All Resource

    *

    		 None None

    Request parameters

    Parameter

    Type

    Required

    Description

    Example
    DBType

    string

    No

    The type of the database engine. Valid values:

    • MySQL

    • Oracle

    PostgreSQL
    DBName

    string

    No

    The name of the database. You can specify only one database name.

    Note

    Only PolarDB for PostgreSQL (Compatible with Oracle) clusters support this parameter.

    testDB
    RegionId

    string

    No

    The region ID.

    cn-hangzhou
    SourceDBClusterId

    string

    Yes

    The source instance ID.

    pc-k2j96w169uhu868l8

    DBVersion

    string

    Yes

    The version number of the destination database DPI engine.

    • Valid values for MySQL:

      • 5.6

      • 5.7

      • 8.0

    • Valid value for Oracle: 14.

    5.6
    CreationOption

    string

    Yes

    The creation pattern. Valid values:

    Valid values:

    • MigrationFromRDS :

      Migrate from RDS.

    • UpgradeFromPolarDB :

      Upgrade and migrate from PolarDB.

    MigrationFromRDS
    CreationCategory

    string

    Yes

    The edition of the cluster. Valid values:

    • Normal: Cluster Edition (default)

    • SENormal: Standard Edition

    For more information about cluster editions, see Product editions.

    Normal
    Reserve

    string

    No

    The reserved parameter. The value is a JSON string.

    {\"targetTableMode\":2}

    Response elements

    Element

    Type

    Description

    Example

    object

    Schema of Response

    RequestId

    string

    Id of the request

    CDB3258F-B5DE-43C4-8935-CBA0CA******
    SourceDBClusterId

    string

    The source instance ID.

    pc-k2j96w169uhu868l8

    TaskId

    integer

    The ID of the asynchronous task.

    2312111

    Examples

    Success response

    JSON format

    {
  "RequestId": "CDB3258F-B5DE-43C4-8935-CBA0CA******",
  "SourceDBClusterId": "pc-k2j96w169uhu868l8\n",
  "TaskId": 2312111
}

    Error codes

    See Error Codes for a complete list.

    Release notes

    See Release Notes for a complete list.