GetDisasterRecoveryPlan - 查询备份计划详情 - 云消息队列 RocketMQ 版

查询备份计划详情。

调试

您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。

调试

授权信息

下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：

操作：是指具体的权限点。
访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用前面加 * 表示。
- 对于不支持资源级授权的操作，用全部资源表示。
条件关键字：是指云产品自身定义的条件关键字。
关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

操作

访问级别

资源类型

条件关键字

关联操作

rocketmq:GetDisasterRecoveryPlan

get

*Instance

acs:rocketmq:{#regionId}:{#accountId}:instance/{#InstanceId}

无

请求语法

GET /disaster_recovery/{planId} HTTP/1.1

路径参数

名称	类型	必填	描述	示例值
planId	integer	是	备份计划 id	1234

请求参数

名称

类型

必填

描述

示例值

当前API无需请求参数

返回参数

名称	类型	描述	示例值
	object	Result
requestId	string	请求 ID	7358418D-83BD-507A-8079-611C63E0xxx
success	boolean	是否成功	true
data	object	返回结果
planId	integer	计划 ID	1300000016
planName	string	计划名称	xxx
planDesc	string	计划描述	xxxx
planType	string	计划类型： ACTIVE_PASSIVE(单向备份) ACTIVE_ACTIVE(双向备份)	ACTIVE_PASSIVE
planStatus	string	计划状态： CREATED(已创建) RUNNING(运行中) DELETED(已删除)	RUNNING
extInfo	object	扩展信息
	string	扩展信息	xxxx
instances	array<object>	备份计划参与实例
	array<object>	备份计划参与实例
instanceType	string	实例类型	ALIYUN_ROCKETMQ
regionId	string	实例所在区域	cn-shanghai
instanceId	string	实例 ID	rmq-cn-gpz3qtcdxxx
instanceRole	string	实例角色	ACTIVE
authType	string	认证方式	ACL_AUTH
username	string	认证用户名	xxx
password	string	认证密码	xxx
endpointUrl	string	接入点地址	xxx
networkType	string	网络类型	TCP_INTERNET
vpcId	string	VPC ID	vpc-wz9qt50xhtj9krb******
vSwitchId	string	交换机 ID	vsw-uf6gwtbn6etadpv******
messageProperty	object	消息过滤属性
propertyKey	string	属性 key	xxx
propertyValue	string	属性 value	xxx
securityGroupId	string	安全组 id	sg-bp17hpmgz9******
consumerGroupId	string	消费者组 ID，用于从源实例拉取消息。	GID_DS_XXX_YYY
createTime	string	创建时间	2022-08-01 20:05:50
updateTime	string	修改时间	2022-08-01 20:05:50
autoSyncCheckpoint	boolean	是否开启消费进度自动同步。说明只有在开启消费进度同步时有效。即 `syncCheckpointEnabled`字段值为 true。枚举值： true : 开启 false : 关闭	true
syncCheckpointEnabled	boolean	同步消费进度开关枚举值： true : 开启 false : 关闭	true
code	string	错误码	200
message	string	错误信息	xxx
httpStatusCode	integer	HTTP 状态码	200
dynamicCode	string	动态错误码	InstanceId
dynamicMessage	string	动态错误信息	instanceId
accessDeniedDetail	string	访问拒绝详细信息，有且仅有在因 RAM 无权限拒绝用户访问的场景	xxx

示例

正常返回示例

JSON格式

{
  "requestId": "7358418D-83BD-507A-8079-611C63E0xxx",
  "success": true,
  "data": {
    "planId": 1300000016,
    "planName": "xxx",
    "planDesc": "xxxx",
    "planType": "ACTIVE_PASSIVE",
    "planStatus": "RUNNING",
    "extInfo": {
      "key": "xxxx"
    },
    "instances": [
      {
        "instanceType": "ALIYUN_ROCKETMQ",
        "regionId": "cn-shanghai",
        "instanceId": "rmq-cn-gpz3qtcdxxx",
        "instanceRole": "ACTIVE",
        "authType": "ACL_AUTH",
        "username": "xxx",
        "password": "xxx",
        "endpointUrl": "xxx",
        "networkType": "TCP_INTERNET",
        "vpcId": "vpc-wz9qt50xhtj9krb******\n",
        "vSwitchId": "vsw-uf6gwtbn6etadpv******\n",
        "messageProperty": {
          "propertyKey": "xxx",
          "propertyValue": "xxx"
        },
        "securityGroupId": "sg-bp17hpmgz9******\n",
        "consumerGroupId": "GID_DS_XXX_YYY"
      }
    ],
    "createTime": "2022-08-01 20:05:50",
    "updateTime": "2022-08-01 20:05:50",
    "autoSyncCheckpoint": true,
    "syncCheckpointEnabled": true
  },
  "code": "200",
  "message": "xxx",
  "httpStatusCode": 200,
  "dynamicCode": "InstanceId",
  "dynamicMessage": "instanceId",
  "accessDeniedDetail": "xxx"
}

错误码

访问错误中心查看更多错误码。

变更历史

更多信息，参考变更详情。