# Alibaba Cloud Data Transport API

> Alibaba Cloud Data Transport API on Apizie: 26 endpoints (Creates a data address, The request boy for creating the agent, Creates a migration task, Creates a migration report, …) 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://zieapi.vercel.app/v1/cloud:aliyun-hcs-mgw/{endpoint} or from Claude, ChatGPT and Cursor through the Apizie MCP server. Free plan: 1,000 requests a month.

- Project key: `cloud:aliyun-hcs-mgw`
- Category: Cloud
- Status: byok
- Source: https://api.alibabacloud.com/product/hcs-mgw
- Page: https://zieapi.vercel.app/api/cloud/aliyun-hcs-mgw
- OpenAPI: https://zieapi.vercel.app/api/cloud/aliyun-hcs-mgw/openapi.json

Alibaba Cloud OpenAPI for Data Transport (hcs-mgw, version 2024-06-26). Calls are signed with ACS3-HMAC-SHA256 using your AccessKey ID and secret.

## Endpoints

### Creates a data address
`POST https://zieapi.vercel.app/v1/cloud:aliyun-hcs-mgw/create-address` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://ap-southeast-1.mgw.aliyuncs.com |
| ImportAddress | object | no | The details for creating the data address |

### The request boy for creating the agent
`POST https://zieapi.vercel.app/v1/cloud:aliyun-hcs-mgw/create-agent` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://ap-southeast-1.mgw.aliyuncs.com |
| ImportAgent | string | no | The details for creating the agent |

### Creates a migration task
`POST https://zieapi.vercel.app/v1/cloud:aliyun-hcs-mgw/create-job` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://ap-southeast-1.mgw.aliyuncs.com |
| ImportJob | object | yes | The details for creating the migration task |

### Creates a migration report
`POST https://zieapi.vercel.app/v1/cloud:aliyun-hcs-mgw/create-report` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://ap-southeast-1.mgw.aliyuncs.com |
| CreateReport | string | no | The details for creating the migration report |

### Creates a tunnel
`POST https://zieapi.vercel.app/v1/cloud:aliyun-hcs-mgw/create-tunnel` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://ap-southeast-1.mgw.aliyuncs.com |
| ImportTunnel | string | no | The details for creating the tunnel |

### Deletes a data address
`POST https://zieapi.vercel.app/v1/cloud:aliyun-hcs-mgw/delete-address` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://ap-southeast-1.mgw.aliyuncs.com |
| addressName | string | yes | The name of the data address |

### Deletes an agent
`POST https://zieapi.vercel.app/v1/cloud:aliyun-hcs-mgw/delete-agent` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://ap-southeast-1.mgw.aliyuncs.com |
| agentName | string | yes | The agent name |

### Deletes a migration task
`POST https://zieapi.vercel.app/v1/cloud:aliyun-hcs-mgw/delete-job` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://ap-southeast-1.mgw.aliyuncs.com |
| forceDelete | string | no | Specifies whether to force delete the subtask. If the task has subtasks and you set this parameter to true, the task and its subtasks are… |
| jobName | string | yes | The task name |

### Deletes a tunnel
`POST https://zieapi.vercel.app/v1/cloud:aliyun-hcs-mgw/delete-tunnel` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://ap-southeast-1.mgw.aliyuncs.com |
| tunnelId | string | yes | The tunnel ID |

### Obtains the details of a data address
`GET https://zieapi.vercel.app/v1/cloud:aliyun-hcs-mgw/get-address` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://ap-southeast-1.mgw.aliyuncs.com |
| addressName | string | yes | The name of the data address |

### Obtains the details of an agent
`GET https://zieapi.vercel.app/v1/cloud:aliyun-hcs-mgw/get-agent` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://ap-southeast-1.mgw.aliyuncs.com |
| agentName | string | yes | The agent name |

### Obtains the running status of an agent
`GET https://zieapi.vercel.app/v1/cloud:aliyun-hcs-mgw/get-agent-status` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://ap-southeast-1.mgw.aliyuncs.com |
| agentName | string | yes | The agent name |

### Retrieves the details of a migration task
`GET https://zieapi.vercel.app/v1/cloud:aliyun-hcs-mgw/get-job` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://ap-southeast-1.mgw.aliyuncs.com |
| byVersion | string | no | Specifies whether to use the task ID for retrieval |
| jobName | string | yes | The task name. If byVersion is set to true, this parameter specifies the task ID |

### Obtains the list of files that fail to be migrated when files fail to be migrated during a migration task
`GET https://zieapi.vercel.app/v1/cloud:aliyun-hcs-mgw/get-job-result` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://ap-southeast-1.mgw.aliyuncs.com |
| jobName | string | yes | The task name |
| runtimeId | integer | yes | The execution ID of the task |

### Obtains the details of a migration report
`GET https://zieapi.vercel.app/v1/cloud:aliyun-hcs-mgw/get-report` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://ap-southeast-1.mgw.aliyuncs.com |
| version | string | yes | The ID of the migration task |
| runtimeId | integer | no | The execution ID of the migration task |

### Obtains the details of a tunnel
`GET https://zieapi.vercel.app/v1/cloud:aliyun-hcs-mgw/get-tunnel` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://ap-southeast-1.mgw.aliyuncs.com |
| tunnelId | string | yes | The tunnel ID |

### Lists the data addresses created by a user in the specific region
`GET https://zieapi.vercel.app/v1/cloud:aliyun-hcs-mgw/list-address` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://ap-southeast-1.mgw.aliyuncs.com |
| marker | string | no | The marker after which the migration addresses are listed. By default, this parameter is left empty |
| count | integer | no | Specifies the number of migration addresses to be returned. Valid values: 0 - 1000 (excluding 0). Default value: 1000 |

### Lists the agents created by a user in the specific region
`GET https://zieapi.vercel.app/v1/cloud:aliyun-hcs-mgw/list-agent` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://ap-southeast-1.mgw.aliyuncs.com |
| marker | string | no | The marker after which the agents are listed.\ By default, this parameter is left empty |
| count | integer | no | Specifies the number of agents to be returned.\ Valid values: 0 - 1000.\ Default value: 1000 |

### Lists the migration tasks in the region
`GET https://zieapi.vercel.app/v1/cloud:aliyun-hcs-mgw/list-job` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://ap-southeast-1.mgw.aliyuncs.com |
| marker | string | no | Specifies the marker after which migration tasks are listed. Default value: None |
| count | integer | no | Specifies the number of migration tasks to return. Valid values: 1 to 1000. Default value: 1000 |
| parentName | string | no | The name of the parent task. If you specify this parameter, all subtasks of the parent task are returned |
| all | string | no | Specifies whether to return subtasks. Valid values: true, false |

### Lists the run history of a migration task
`GET https://zieapi.vercel.app/v1/cloud:aliyun-hcs-mgw/list-job-history` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://ap-southeast-1.mgw.aliyuncs.com |
| jobName | string | yes | The name of the migration task whose run history to retrieve |
| runtimeId | integer | no | The execution ID of a specific run. Specify this parameter to retrieve the run history for only that execution |
| marker | string | no | The pagination token. Set this parameter to the marker value returned in the previous response to retrieve the next page of results. If… |
| count | integer | no | The maximum number of history entries to return. Valid values: 1 to 1000. Default value: 1000. |

### Lists tunnels
`GET https://zieapi.vercel.app/v1/cloud:aliyun-hcs-mgw/list-tunnel` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://ap-southeast-1.mgw.aliyuncs.com |
| marker | string | no | The marker after which tunnels are listed.\ By default, this parameter is left empty |
| count | integer | no | Specifies the number of tunnels to be returned.\ Valid values: 0 - 1000.\ Default value: 1000 |

### Updates a data address
`POST https://zieapi.vercel.app/v1/cloud:aliyun-hcs-mgw/update-address` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://ap-southeast-1.mgw.aliyuncs.com |
| addressName | string | yes | The name of the data address |
| ImportAddress | string | no | The details for updating the data address |

### Updates the status or throttling of a task
`POST https://zieapi.vercel.app/v1/cloud:aliyun-hcs-mgw/update-job` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://ap-southeast-1.mgw.aliyuncs.com |
| ImportJob | string | no | The details for updating the task |
| jobName | string | yes | The task name |

### Updates a tunnel
`POST https://zieapi.vercel.app/v1/cloud:aliyun-hcs-mgw/update-tunnel` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://ap-southeast-1.mgw.aliyuncs.com |
| tunnelId | string | yes | The tunnel ID |
| ImportTunnel | object | no | The details for updating the tunnel |

### Verifies whether a data address is available
`GET https://zieapi.vercel.app/v1/cloud:aliyun-hcs-mgw/verify-address` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://ap-southeast-1.mgw.aliyuncs.com |
| addressName | string | yes | The name of the data address |

### version
`POST https://zieapi.vercel.app/v1/cloud:aliyun-hcs-mgw/version` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://ap-southeast-1.mgw.aliyuncs.com |

## Example
```
curl "https://zieapi.vercel.app/v1/cloud:aliyun-hcs-mgw/create-address" \
  -H "x-api-key: $APIZIE_KEY" \
  -H "x-upstream-key: $PROVIDER_KEY"
```

## FAQ

### How do I call the Alibaba Cloud Data Transport API?
Create a free Apizie key, then send POST https://zieapi.vercel.app/v1/cloud:aliyun-hcs-mgw/create-address with the header x-api-key. Every endpoint returns { project, data, timestamp }.

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

### Can AI agents use the Alibaba Cloud Data Transport API?
Yes. Add the Apizie MCP server (https://zieapi.vercel.app/mcp) to Claude, ChatGPT, Cursor or VS Code, then ask in plain language. The agent calls run_scraper with project key cloud:aliyun-hcs-mgw.

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