API overview
API standard and pre-built SDKs in multi-language
The OpenAPI specification of this product (hcs-mgw/2024-06-26) follows the ROA standard. Alibaba Cloud provides pre-built SDKs for popular programming languages to abstract low-level complexities such as request signing. This enables developers to call APIs using language-specific syntax without dealing with HTTP details directly.
Custom signature
If your specific needs, such as a customized signature, are not supported by the SDK, manually sign requests using the signature mechanism. Note that manual signing requires significant effort (usually about 5 business days). For support, join our DingTalk group (ID: 147535001692).
Before you begin
An Alibaba Cloud account has full administrative privileges. A compromised AccessKey pair exposes all associated resources to unauthorized access, posing a significant security risk. To call APIs securely, create a Resource Access Management (RAM) user with API access only, configure its AccessKey pairs, and implement the principle of least privilege (PoLP) through RAM policies. Use the Alibaba Cloud account only when its permissions are explicitly required for specific scenarios.
Data address
|
API |
Title |
Description |
| VerifyAddress | VerifyAddress | Verifies whether a data address is available. |
Others
|
API |
Title |
Description |
| CreateAddress | CreateAddress | Creates a data address. |
| CreateAgent | CreateAgent | The request boy for creating the agent. |
| CreateJob | CreateJob | Creates a migration task. |
| CreateReport | CreateReport | Creates a migration report. |
| CreateTunnel | CreateTunnel | Creates a tunnel. |
| DeleteAddress | DeleteAddress | Deletes a data address. |
| DeleteAgent | DeleteAgent | Deletes an agent. |
| DeleteJob | DeleteJob | Deletes a migration task. |
| DeleteTunnel | DeleteTunnel | Deletes a tunnel. |
| GetAddress | GetAddress | Obtains the details of a data address. |
| GetAgent | GetAgent | Obtains the details of an agent. |
| GetAgentStatus | GetAgentStatus | Obtains the running status of an agent. |
| GetJob | GetJob | Obtains the details of a migration task. |
| GetJobResult | GetJobResult | Obtains the list of files that fail to be migrated when files fail to be migrated during a migration task. |
| GetReport | GetReport | Obtains the details of a migration report. |
| GetTunnel | GetTunnel | Obtains the details of a tunnel. |
| ListAddress | ListAddress | Lists the data addresses created by a user in the specific region. |
| ListAgent | ListAgent | Lists the agents created by a user in the specific region. |
| ListJob | ListJob | Lists the migration tasks created by a user in the specific region. |
| ListJobHistory | ListJobHistory | Lists the execution history of migration tasks. |
| ListTunnel | ListTunnel | Lists tunnels. |
| UpdateAddress | UpdateAddress | Updates a data address. |
| UpdateJob | UpdateJob | Updates the status or throttling of a task. |
| UpdateTunnel | UpdateTunnel | Updates a tunnel. |