API概览
更新时间：
复制为 MD 格式
本产品（hcs-mgw/2024-06-26）的OpenAPI采用ROA签名风格，签名细节参见签名机制说明。我们已经为开发者封装了常见编程语言的SDK，开发者可通过下载SDK直接调用本产品OpenAPI而无需关心技术细节。如果现有SDK不能满足使用需求，可通过签名机制进行自签名对接。由于自签名细节非常复杂，需花费 5个工作日左右。因此建议加入我们的服务钉钉群（147535001692），在专家指导下进行签名对接。
在使用API前，您需要准备好身份账号及访问密钥（AccessKey），才能有效通过客户端工具（SDK、CLI等）访问API。细节请参见获取AccessKey。
任务
|
API |
标题 |
API概述 |
| CreateJob | 创建任务 | 创建迁移任务。 |
| GetJob | 获取任务 | 获取迁移任务详情。 |
| ListJob | 列举任务 | 列举用户在该区域下的迁移任务。 |
| UpdateJob | 更新任务 | 创建任务后，您可以通过该方法来启动任务、暂停任务以及关闭任务，也可以通过该方法来调整任务限流信息。 |
| DeleteJob | 删除任务 | 删除迁移任务。 |
| ListJobHistory | 列举任务运行历史 | 列举迁移任务运行历史。 |
| CreateReport | 创建迁移报告 | 创建迁移报告。 |
| GetReport | 获取迁移报告 | 获取迁移报告详情。 |
| GetJobResult | 获取任务重试信息 | 当迁移任务有失败文件时，获取失败文件是否能重试的信息。 |
数据地址
|
API |
标题 |
API概述 |
| CreateAddress | 创建地址 | 创建数据地址。 |
| GetAddress | 获取地址 | 获取数据地址详情。 |
| ListAddress | 列举地址 | 列举用户在该区域下的数据地址。 |
| UpdateAddress | 更新地址 | 更新数据地址。 |
| DeleteAddress | 删除地址 | 删除数据地址。 |
| VerifyAddress | 校验地址 | 校验数据地址是否可用。 |
代理
|
API |
标题 |
API概述 |
| CreateAgent | 创建代理 | 创建代理。 |
| GetAgent | 获取代理 | 获取代理详情。 |
| ListAgent | 列举代理 | 列举用户在该区域下的代理。 |
| GetAgentStatus | 获取代理状态 | 获取代理运行状态。 |
| DeleteAgent | 删除代理 | 删除代理。 |
通道
|
API |
标题 |
API概述 |
| CreateTunnel | 创建通道 | 创建通道。 |
| GetTunnel | 获取通道 | 获取通道详情。 |
| UpdateTunnel | 更新通道 | 更新通道。 |
| ListTunnel | 列举通道 | 列举通道。 |
| DeleteTunnel | 删除通道 | 删除通道。 |
该文章对您有帮助吗？