API概览

更新时间:
复制 MD 格式

API标准及多语言预置SDK

本产品(hdr/2017-09-25)的OpenAPI采用RPC签名风格。我们已经为开发者封装了常见编程语言的SDK,开发者可通过下载SDK直接调用本产品OpenAPI而无需关心技术细节。如果现有SDK不能满足使用需求,可通过签名机制进行自签名对接。由于自签名细节非常复杂,需花费 5个工作日左右。因此建议加入我们的服务钉钉群(147535001692),在专家指导下进行签名对接。

在使用API前,您需要准备好身份账号及访问密钥(AccessKey),才能有效通过客户端工具(SDK、CLI等)访问API。细节请参见获取AccessKey

自定义签名场景

若您的业务场景有特殊需求,需通过自签名方式对接 API,建议优先咨询我们的技术支持团队(服务钉钉群:147535001692),获取专业指导以确保高效接入。

账号与安全准备

阿里云账号具备对所有资源的完全管理权限。一旦 AccessKey 泄露,所有相关资源都将面临未经授权访问的风险。为确保安全,建议创建一个仅具备 API 访问权限的RAM用户并配置其 AccessKey,同时基于最小权限原则 (PoLP) 配置 RAM 策略。仅在明确需要阿里云账号权限的特定场景下,才使用阿里云账号。

服务器管理

API

标题

API概述

RegisterServers 添加受保护服务器 添加受保护服务器。
UnregisterServer 注销受保护服务器 注销受保护服务器。
DescribeServer 查询受保护服务器 查询受保护服务器。
DescribeServers 查询受保护服务器 查询受保护服务器。

站点对管理

API

标题

API概述

DescribeSitePairs 查询站点对信息 查询站点对信息。
DescribeSite 查询站点信息 查询站点信息。
DeleteSitePair 删除站点对 删除站点对。
CreateSitePair 创建站点对 创建容灾站点对。
DescribeSitePair 查询站点对信息 查询站点对信息。

故障切换

API

标题

API概述

EnableReplication 启动复制 启动复制。
DisableReplication 停止复制 停止复制。
TestFailover 容灾演练 容灾演练。
TestCleanup 清理容灾演练环境 清理容灾演练环境。
DescribeRecoveryPoints 查询可用恢复点 查询可用恢复点。
ChangeRecoveryPoint 更换恢复点 更换恢复点。
CommitFailover 确认故障切换 确认故障切换。
ForcedFailover 故障切换 故障切换。

故障恢复

API

标题

API概述

TriggerReversedRegister 反向注册 反向注册,将完成故障切换的实例从目的端站点反向注册到源端站点,为后续启动反向复制实现故障恢复做准备。
DescribeInfrastructures 查询站点基础设施 查询站点基础设施信息,混合云容灾服务支持IDC上云容灾、跨区域容灾、跨可用区容灾,不同场景下站点使用的基础设施不同,例如IDC上云容灾的源端站点可能使用物理机、VCenter作为基础设施;跨区域容灾与跨可用区容灾目前主要使用阿里云作为基础设施。
ReversedEnableReplication 启动反向复制 启动反向复制。
ReversedDisableReplication 停止反向复制 停止反向复制。
Failback 故障恢复 故障恢复。

恢复计划

API

标题

API概述

CreateRecoveryPlan 创建恢复计划 创建恢复计划。
DeleteRecoveryPlan 删除恢复计划 根据恢复计划ID删除指定的恢复计划。
DescribeRecoveryPlan 查询恢复计划详情 查询恢复计划详情。
DescribeRecoveryPlans 查询恢复计划列表 查询站点对中的恢复计划列表。
UpdateRecoveryPlan 编辑恢复计划 编辑恢复计划内容。

其它

API

标题

API概述

DescribeAvailableInstanceTypes 查询可用规格 查询(演练、故障切换、故障恢复等场景的)可用规格。
DescribeTask 查询任务 查询任务。

其他

API

标题

API概述

DescribeSitePairStatistics 查询站点对统计信息 查询站点对统计信息。
DescribeSummary 查询概览信息 查询概览信息。
DescribeTasks 查询任务列表 查询任务列表。