All Products
Search
Document Center

ApsaraDB for ClickHouse:DescribeTransferHistory

Last Updated:Mar 07, 2025

Queries information about data migration from an ApsaraDB for ClickHouse cluster of an earlier version to an ApsaraDB for ClickHouse cluster of a later version

Operation description

Note You can call this operation to query information about only data migration from an ApsaraDB for ClickHouse cluster of an earlier version to an ApsaraDB for ClickHouse cluster of a later version.

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
clickhouse:DescribeTransferHistoryget
*DBCluster
acs:clickhouse:{#regionId}:{#accountId}:dbcluster/{#DBClusterId}
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
DBClusterIdstringYes

The cluster ID.

cc-bp108z124a8o7****

Response parameters

ParameterTypeDescriptionExample
object
HistoryDetailsarray<object>

The migration information.

HistoryDetailobject
SourceDBClusterstring

The ID of the source cluster.

cc-bp108z124a8o7****
SourceControlVersionstring

The control version of the source cluster.

v1
TargetDBClusterstring

The ID of the destination cluster.

cc-bp13zkh9uw523****
TargetControlVersionstring

The control version of the destination cluster.

v2
Statusstring

The status of the data migration task. Valid values:

  • Finished: The data migration task is complete.
  • Processing: The data migration task is in progress.
Finished
Progressstring

The progress of the data migration.

100%
DisableWriteWindowsstring

The time window during which write operations are stopped.

2025-02-08T00:00:00+08:00,2025-02-12T00:00:00+08:00
UnsyncedByteslong

The amount of data that is not migrated.

102400
UnsyncedPartslong

The number of parts that are not migrated.

1000
PartsPerMinutedouble

The number of parts that are migrated per minute.

1.24
BytesPerMinutelong

The amount of data that is migrated per minute.

10240
SubJobstring

The running subtask.

SubJob
SubJobStatusstring

The subtask status.

running
RequestIdstring

The request ID.

05321590-BB65-4720-8CB6-8218E041CDD0

Examples

Sample success responses

JSONformat

{
  "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"
      }
    ]
  },
  "RequestId": "05321590-BB65-4720-8CB6-8218E041CDD0"
}

Error codes

HTTP status codeError codeError messageDescription
500InternalErrorAn error occurred while processing your request.An error occurred while processing your request.
503ServiceUnavailableAn error occurred while processing your request.An error occurred while processing your request.

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

Change history

Change timeSummary of changesOperation
2024-09-25API Description Update. The Error code has changedView Change Details
2024-08-12The Error code has changed. The response structure of the API has changedView Change Details