# Alibaba Cloud Cloud Migration Hub API

> Alibaba Cloud Cloud Migration Hub API on Apizie: 34 endpoints (保存集群接口, Writes synchronization tasks, Receives Nantianmen order notifications, Unsubscribes from a service, …) returned as clean JSON through one API key. Send your own provider key in the x-upstream-key header. Call it over REST at https://apizie.tech/v1/cloud:aliyun-apds/{endpoint} or from Claude, ChatGPT and Cursor through the Apizie MCP server. Free plan: 1,000 requests a month.

- Project key: `cloud:aliyun-apds`
- Category: Cloud
- Status: byok
- Source: https://api.alibabacloud.com/product/apds
- Page: https://apizie.tech/api/cloud/aliyun-apds
- OpenAPI: https://apizie.tech/api/cloud/aliyun-apds/openapi.json

Alibaba Cloud OpenAPI for Cloud Migration Hub (apds, version 2022-03-31). Calls are signed with ACS3-HMAC-SHA256 using your AccessKey ID and secret.

## Endpoints

### 保存集群接口
`POST https://apizie.tech/v1/cloud:aliyun-apds/create-migration-group` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| description | string | no | 详细描述 |
| extra | string | no | 扩充字段（json结构） |
| id | integer | no | The id |
| name | string | no | 名称 |
| regionId | string | no | The regionId |

### Writes synchronization tasks
`POST https://apizie.tech/v1/cloud:aliyun-apds/create-migration-job` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| migrationJobList | array | no | The list of migration tasks for batch write. An error is returned if the list is empty |
| type | string | yes | The task type that identifies the source system of the migration task. This parameter is required. Valid values: DTS: Alibaba Cloud Data… |

### Receives Nantianmen order notifications
`POST https://apizie.tech/v1/cloud:aliyun-apds/create-pay-order-callback` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| data | string | no | The callback URL |

### Unsubscribes from a service
`POST https://apizie.tech/v1/cloud:aliyun-apds/create-refund` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| data | string | no | The operation result. A value of success indicates that the operation is successful. Otherwise, an error is returned |

### 新增扫描任务
`POST https://apizie.tech/v1/cloud:aliyun-apds/create-survey-job-offline` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| autoConfirm | string | no | The autoConfirm |
| channel | string | no | 调研渠道 |
| cloudType | string | no | The cloudType |
| fileName | string | no | The fileName |
| name | string | no | The name |
| objectName | string | no | The objectName |
| regionId | string | no | The regionId |

### 删除任务
`POST https://apizie.tech/v1/cloud:aliyun-apds/delete-migration-job` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | integer | no | The id |

### 根据key删除oss文件
`POST https://apizie.tech/v1/cloud:aliyun-apds/delete-oss-file` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| objectName | string | no | The objectName |
| regionId | string | no | The regionId |

### 根据id删除扫描任务
`POST https://apizie.tech/v1/cloud:aliyun-apds/delete-survey-job` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | integer | no | The id |

### 发现-批量删除资源接口
`POST https://apizie.tech/v1/cloud:aliyun-apds/delete-survey-resources` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| ids | string | yes | The ids |

### 查询用户维度同步任务的设置状态
`POST https://apizie.tech/v1/cloud:aliyun-apds/describe-migration-job-config` (byok)

### 查询同步任务数量
`POST https://apizie.tech/v1/cloud:aliyun-apds/describe-migration-job-count` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| batchTaskGroupId | integer | no | The batchTaskGroupId |
| cutoverPlanId | string | no | The cutoverPlanId |
| name | string | no | 任务名称 |
| outSideId | string | no | The outSideId |
| source | string | no | 源 |
| surveyResourceId | integer | no | The surveyResourceId |
| tagList | array | no | The tagList |
| type | string | no | 来源系统,MigrationJobTypeEnum[DTS,SMC,OSS,value,desc] |
| typeList | array | no | The typeList |
| usedType | string | no | The usedType |

### 获取临时授权
`POST https://apizie.tech/v1/cloud:aliyun-apds/describe-oss-sts` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| ak | string | no | The ak |
| sk | string | no | The sk |
| cloudType | string | no | The cloudType |
| region | string | no | The region |
| tenantId | string | no | The tenantId |
| regionId | string | no | The regionId |

### 根据状态进行汇总
`POST https://apizie.tech/v1/cloud:aliyun-apds/describe-summary-by-status` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| regionId | string | no | The regionId |

### 根据状态和集群进行汇总
`POST https://apizie.tech/v1/cloud:aliyun-apds/describe-summary-by-status-and-group` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| regionId | string | no | The regionId |

### 查询扫描任务
`POST https://apizie.tech/v1/cloud:aliyun-apds/describe-survey-job` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | integer | no | The id |
| regionId | string | no | The regionId |

### 查询扫描任务
`POST https://apizie.tech/v1/cloud:aliyun-apds/describe-survey-job-count` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| channelList | array | no | The channelList |
| cloudTypeList | array | no | The cloudTypeList |
| name | string | no | The name |
| regionId | string | no | The regionId |

### 获取资源标签信息
`POST https://apizie.tech/v1/cloud:aliyun-apds/describe-survey-resource-tag` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| scene | string | no | The scene |
| sourceUserIdList | array | no | The sourceUserIdList |

### 查询资源调研参数模板列表type
`POST https://apizie.tech/v1/cloud:aliyun-apds/describe-survey-template` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| resourceType | string | no | The resourceType |

### 回显任务详情
`GET https://apizie.tech/v1/cloud:aliyun-apds/get-task-detail` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| taskId | integer | yes | The taskId |

### 查询同步任务
`POST https://apizie.tech/v1/cloud:aliyun-apds/list-migration-jobs` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| batchTaskGroupId | integer | no | The batchTaskGroupId |
| cutoverPlanId | string | no | The cutoverPlanId |
| name | string | no | 任务名称 |
| outSideId | string | no | The outSideId |
| pageNum | integer | no | The pageNum |
| pageSize | integer | no | The pageSize |
| sortCol | string | no | The sortCol |
| sortType | string | no | The sortType |
| source | string | no | 源 |
| surveyResourceId | integer | no | The surveyResourceId |
| tagList | array | no | The tagList |
| type | string | no | 来源系统,MigrationJobTypeEnum[DTS,SMC,OSS,value,desc] |
| typeList | array | no | The typeList |
| usedType | string | no | The usedType |

### 获取调研任务下载列表
`POST https://apizie.tech/v1/cloud:aliyun-apds/list-survey-job-down-load-jobs` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| pageNum | integer | no | The pageNum |
| pageSize | integer | no | The pageSize |
| sortCol | string | no | The sortCol |
| sortType | string | no | The sortType |
| regionId | string | no | The regionId |

### 查看调研任务列表
`POST https://apizie.tech/v1/cloud:aliyun-apds/list-survey-jobs` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| channelList | array | no | The channelList |
| cloudTypeList | array | no | The cloudTypeList |
| name | string | no | The name |
| pageNum | integer | no | The pageNum |
| pageSize | integer | no | The pageSize |
| region | array | no | The region |
| surveyRange | string | no | The surveyRange |
| regionId | string | no | The regionId |

### 通过集群ids获取下属资源
`POST https://apizie.tech/v1/cloud:aliyun-apds/list-survey-resource-by-migration-groups` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | string | no | The body (JSON-encoded) |

### 查询资源网络拓扑
`POST https://apizie.tech/v1/cloud:aliyun-apds/list-survey-resource-connections` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| ids | array | no | The ids |
| regionId | string | no | The regionId |

### 获取资源类型列表
`POST https://apizie.tech/v1/cloud:aliyun-apds/list-survey-resource-types` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| ak | string | no | The ak |
| sk | string | no | The sk |
| cloudType | string | no | The cloudType |
| region | string | no | The region |
| regionId | string | no | The regionId |

### 查询任务下属资源列表详情
`POST https://apizie.tech/v1/cloud:aliyun-apds/list-survey-resources-detail` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| ip | string | no | ip |
| jobId | integer | no | 调研任务Id |
| projectId | integer | no | The projectId |
| resourceType | string | no | 类型 |
| subProjectId | integer | no | The subProjectId |
| regionId | string | no | The regionId |

### 新增sql转换任务
`POST https://apizie.tech/v1/cloud:aliyun-apds/pop-create-task` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| dataTypeMappingFile | string | no | 数据类型映射JSON文件 |
| dataTypeOssFileName | string | no | The dataTypeOssFileName |
| dataTypeOssObjectName | string | no | 数据类型映射oss文件路径 |
| dataTypeRealFileName | string | no | The dataTypeRealFileName |
| dqlAssociationDDLTaskList | string | no | DQL关联的DDL任务id列表，支持关联多个DDL任务id |
| dqlRelateTargetDatasourceId | string | no | 关联DDL下的转换目的数据源id |
| dqlTestDatasourceId | string | no | DQL关联的测试数据源id |
| dqlTestProject | string | no | DQL测试段project |
| fileName | string | no | 文件名称 |
| globalParams | string | no | 全局参数 |
| identifier | string | no | 脚本文件的唯一标识符，分片上传时使用 |
| ossObjectName | string | no | oss object 绝对路径 |
| realFileName | string | no | 真实文件名称 |
| relatedDdlContentOssFileName | string | no | The relatedDdlContentOssFileName |
| relatedDdlContentOssObjectName | string | no | 关联DDL的路径 |
| relatedDdlContentRealFileName | string | no | The relatedDdlContentRealFileName |
| sourceDatasourceId | string | no | 源端数据源id |
| sourceDialect | string | yes | 源端方言 |
| sourceProject | string | no | 源端project |
| tableNameMappingFile | string | no | 表名映射Excel文件 |
| tableNameOssFileName | string | no | The tableNameOssFileName |
| tableNameOssObjectName | string | no | 表名映射oss文件路径 |
| tableNameRealFileName | string | no | The tableNameRealFileName |
| targetDatasourceId | string | no | 目标端数据源id |
| targetDialect | string | yes | 目标端方言 |
| targetProject | string | no | 目标端project |
| taskDescription | string | no | 任务描述 |
| taskName | string | yes | 任务名称 |
| taskType | integer | yes | 任务类型 1 DDL 2 DQL |
| tenantId | string | no | 租户ID |
| transformSchema | string | no | schema，多个schema之间用英文逗号隔开 |
| uid | string | no | 用户id |

### 下载表名映射模板
`GET https://apizie.tech/v1/cloud:aliyun-apds/pop-download-template` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| targetDialect | string | no | The targetDialect |
| taskId | integer | no | The taskId |

### 编辑sql转换任务
`POST https://apizie.tech/v1/cloud:aliyun-apds/pop-edit-task` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| configuration | object | no | 转换配置 |
| dataTypeMappingFile | string | no | 数据类型映射JSON文件 |
| dataTypeOssFileName | string | no | The dataTypeOssFileName |
| dataTypeOssObjectName | string | no | 数据类型映射oss文件路径 |
| dataTypeRealFileName | string | no | The dataTypeRealFileName |
| dqlAssociationDDLTaskList | string | no | DQL关联的DDL任务列表，支持关联多个DDL任务id |
| dqlRelateTargetDatasourceId | string | no | 关联DDL下的转换目的数据源id |
| dqlTestDatasourceId | string | no | DQL关联的测试数据源id |
| dqlTestProject | string | no | DQL测试段project |
| fileName | string | no | 文件名称 |
| globalParams | string | no | 全局参数 |
| identifier | string | no | 脚本文件的唯一标识符，分片上传使用 |
| ossObjectName | string | no | oss 绝对路径 |
| realFileName | string | no | 真实文件名称 |
| relatedDdlContentOssFileName | string | no | The relatedDdlContentOssFileName |
| relatedDdlContentOssObjectName | string | no | The relatedDdlContentOssObjectName |
| relatedDdlContentRealFileName | string | no | The relatedDdlContentRealFileName |
| sourceDatasourceId | string | no | 源端数据源id |
| sourceDialect | string | yes | 源端方言 |
| sourceProject | string | no | 源端project |
| tableNameMappingFile | string | no | 表名映射Excel文件 |
| tableNameOssFileName | string | no | The tableNameOssFileName |
| tableNameOssObjectName | string | no | 表名映射oss文件路径 |
| tableNameRealFileName | string | no | The tableNameRealFileName |
| targetDatasourceId | string | no | 目标端数据源id |
| targetDialect | string | yes | 目标端方言 |
| targetProject | string | no | 目标端project |
| taskDescription | string | no | 任务描述 |
| taskId | integer | no | 任务id |
| taskName | string | yes | 任务名称 |
| taskType | integer | yes | 任务类型 1 DDL 2 DQL |
| tenantId | string | no | 租户ID |
| transformSchema | string | no | schema，多个schema之间用英文逗号隔开 |
| uid | string | no | 用户id |

### 恢复删除任务
`POST https://apizie.tech/v1/cloud:aliyun-apds/recover-migration-job` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | integer | no | The id |

### 断开同步任务
`POST https://apizie.tech/v1/cloud:aliyun-apds/stop-sync-migration-job` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| jobType | string | no | The jobType |
| regionId | string | no | The regionId |

### 同步迁移任务信息
`POST https://apizie.tech/v1/cloud:aliyun-apds/sync-migration-job` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| jobType | string | no | The jobType |
| regions | string | no | The regions |
| operationType | string | no | The operationType |
| regionId | string | no | The regionId |

### Updates the information of a push application
`POST https://apizie.tech/v1/cloud:aliyun-apds/update-push-app` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| AppId | integer | no | The application ID. You can call the https://help.aliyun.com/document_detail/149390.html operation to obtain the application ID |
| DownloadLink | string | no | The download URL. If the application is currently unavailable for download, this parameter is an empty string |
| tenant-proxy-uid | string | no | The ID of the proxy endpoint |

### version
`POST https://apizie.tech/v1/cloud:aliyun-apds/version` (byok)

## Example
```
curl "https://apizie.tech/v1/cloud:aliyun-apds/create-migration-group" \
  -H "x-api-key: $APIZIE_KEY" \
  -H "x-upstream-key: $PROVIDER_KEY"
```

## FAQ

### How do I call the Alibaba Cloud Cloud Migration Hub API?
Create a free Apizie key, then send POST https://apizie.tech/v1/cloud:aliyun-apds/create-migration-group with the header x-api-key. Every endpoint returns { project, data, timestamp }.

### Is the Alibaba Cloud Cloud Migration Hub API free on Apizie?
Yes. The Free plan includes 1,000 requests a month at 100 requests a minute, no credit card. Alibaba Cloud Cloud Migration Hub itself also needs your own key from aliyuncs.com.

### Can AI agents use the Alibaba Cloud Cloud Migration Hub API?
Yes. Add the Apizie MCP server (https://apizie.tech/mcp) to Claude, ChatGPT, Cursor or VS Code, then ask in plain language. The agent calls run_scraper with project key cloud:aliyun-apds.

### What is the status of the Alibaba Cloud Cloud Migration Hub API?
Needs your own provider key (bring your own key)