DescribeTransferHistory - ApsaraDB for ClickHouse - Alibaba Cloud Documentation Center

Queries the migration history.

Operation description

Note

This operation queries information about data migration from an earlier version to a later version between ApsaraDB for ClickHouse clusters.

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

clickhouse:DescribeTransferHistory

get

*DBCluster

acs:clickhouse:{#regionId}:{#accountId}:dbcluster/{#DBClusterId}

None

Request parameters

Parameter	Type	Required	Description	Example
DBClusterId	string	Yes	The cluster ID.	cc-bp108z124a8o7****

Response elements

Element	Type	Description	Example
	object
HistoryDetails	object
HistoryDetail	array<object>	The migration information.
	object
SourceDBCluster	string	The source cluster ID.	cc-bp108z124a8o7****
SourceControlVersion	string	The management version of the source cluster.	v1
TargetDBCluster	string	The target cluster ID.	cc-bp13zkh9uw523****
TargetControlVersion	string	The management version of the target cluster.	v2
Status	string	The status of the data migration. Valid values: Finished: The migration is complete. Processing: The migration is in progress.	Finished
Progress	string	The progress of the data migration.	100%
DisableWriteWindows	string	The time window during which writes are disabled.	2025-02-08T00:00:00+08:00,2025-02-12T00:00:00+08:00
UnsyncedBytes	integer	The volume of unsynchronized data.	102400
UnsyncedParts	integer	The number of unsynchronized parts.	1000
PartsPerMinute	number	The number of parts migrated per minute.	1.24
BytesPerMinute	integer	The volume of data migrated per minute.	10240
SubJob	string	The sub-task that is running.	SubJob
SubJobStatus	string	The status of the sub-task.	running
SubJobMessage	string
RequestId	string	The request ID.	05321590-BB65-4720-8CB6-8218E041CDD0

Examples

Success response

JSON format

{
  "HistoryDetails": {
    "HistoryDetail": [
      {
        "SourceDBCluster": "cc-bp108z124a8o7****",
        "SourceControlVersion": "v1",
        "TargetDBCluster": "cc-bp13zkh9uw523****",
        "TargetControlVersion": "v2",
        "Status": "Finished",
        "Progress": "100%",
        "DisableWriteWindows": "2025-02-08T00:00:00+08:00,2025-02-12T00:00:00+08:00",
        "UnsyncedBytes": 102400,
        "UnsyncedParts": 1000,
        "PartsPerMinute": 1.24,
        "BytesPerMinute": 10240,
        "SubJob": "SubJob",
        "SubJobStatus": "running",
        "SubJobMessage": ""
      }
    ]
  },
  "RequestId": "05321590-BB65-4720-8CB6-8218E041CDD0"
}

Error codes

HTTP status code	Error code	Error message	Description
500	InternalError	An error occurred while processing your request.	An error occurred while processing your request.
503	ServiceUnavailable	An error occurred while processing your request.	An error occurred while processing your request.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.