创建备份计划。
调试
您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：
- 操作：是指具体的权限点。
- 访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
- 资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用前面加 * 表示。
- 对于不支持资源级授权的操作，用
全部资源表示。
- 条件关键字：是指云产品自身定义的条件关键字。
- 关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。
| 操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
|---|---|---|---|---|
| rocketmq:CreateDisasterRecoveryPlan | update | *Instance acs:rocketmq:{#regionId}:{#accountId}:instance/{#InstanceId} |
| 无 |
请求语法
POST /disaster_recovery HTTP/1.1
请求参数
| 名称 | 类型 | 必填 | 描述 | 示例值 |
|---|---|---|---|---|
| body | object | 否 | 请求体结构。 | |
| planName | string | 否 | 计划名称，必填 | xxx |
| planDesc | string | 否 | 计划描述 | xxx |
| planType | string | 否 | 备份计划类型，必填。请参见Global Replicator。 参数取值如下：
| ACTIVE_ACTIVE |
| instances | array<object> | 否 | 备份计划参与实例。必填 | |
| instance | object | 否 | 备份计划参与实例 | |
| instanceType | string | 否 | 实例类型
枚举值：
| ALIYUN_ROCKETMQ |
| regionId | string | 否 | 实例所在区域 | cn-hangzhou |
| instanceId | string | 否 | 实例 ID，instanceType 实例类型为 EXTERNAL_ROCKETMQ 无须填写，ALIYUN_ROCKETMQ 必填 | rmq-cn-****** |
| instanceRole | string | 否 | 实例角色，主或者备
| PASSIVE |
| authType | string | 否 | 认证方式。instanceType 实例类型为 ALIYUN_ROCKETMQ，实例版本为 4.0 无须填写
枚举值：
| ACL_AUTH |
| username | string | 否 | 认证用户名，authType 为 ACL_AUTH 时必填 | xxx |
| password | string | 否 | 认证密码，authType 为 ACL_AUTH 时必填。instanceType 实例类型为 ALIYUN_ROCKETMQ 无须填写 | xxx |
| endpointUrl | string | 否 | 接入点地址，instanceType 实例类型为 ALIYUN_ROCKETMQ 无须填写，EXTERNAL_ROCKETMQ 需要填写 | xxx |
| networkType | string | 否 | 网络类型，instanceType 实例类型为 ALIYUN_ROCKETMQ 无须填写，EXTERNAL_ROCKETMQ 需要填写 参数取值如下：
| TCP_INTERNET |
| vpcId | string | 否 | 创建实例所关联的专有网络的 ID，instanceType 实例类型仅为 EXTERNAL_ROCKETMQ，networkType 为 TCP_VPC 时需要填写 | vpc-wz9qt50xhtj9krb****** |
| vSwitchId | string | 否 | 实例所关联的交换机 ID，instanceType 实例类型仅为 EXTERNAL_ROCKETMQ，networkType 为 TCP_VPC 时需要填写 | vsw-uf6gwtbn6etadpv****** |
| messageProperty | object | 否 | 消息过滤属性，消息同步到目标集群时，会自动添加上该属性，用于消息消费时进行 SQL 过滤。 | |
| propertyKey | string | 否 | 属性 key | aaa |
| propertyValue | string | 否 | 属性 value | bbb |
| securityGroupId | string | 否 | 安全组 id，instanceType 实例类型仅为 EXTERNAL_ROCKETMQ，networkType 为 TCP_VPC 时需要填写 | sg-bp17hpmgz9****** |
| consumerGroupId | string | 否 | 消费者组 ID，用于从源实例拉取消息。 注意 自建实例必须填写，阿里云实例会自动生成。 | GID_DS_XXX_YYY |
| autoSyncCheckpoint | boolean | 否 | 是否开启消费进度自动同步。 说明
只有在开启消费进度同步时有效。即 syncCheckpointEnabled字段值为 true。
枚举值：
| true |
| syncCheckpointEnabled | boolean | 否 | 同步消费进度开关 枚举值：
| true |
返回参数
示例
正常返回示例
JSON格式
{
"requestId": "C7E8AE3A-219B-52EE-BE32-4036F5xxxx",
"success": true,
"data": 1234,
"code": 200,
"message": "xxx",
"httpStatusCode": 200,
"dynamicCode": "InstanceId",
"dynamicMessage": "instanceId",
"accessDeniedDetail": "xxx"
}错误码
访问错误中心查看更多错误码。