GetDisasterRecoveryPlan - 查询备份计划详情

查询备份计划详情。

调试

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

授权信息

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

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用前面加 * 表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
rocketmq:GetDisasterRecoveryPlanget
*Instance
acs:rocketmq:{#regionId}:{#accountId}:instance/{#InstanceId}

请求语法

GET /disaster_recovery/{planId} HTTP/1.1

请求参数

名称类型必填描述示例值
planIdlong

备份计划 id

1234

返回参数

名称类型描述示例值
object

Result

requestIdstring

请求 ID

7358418D-83BD-507A-8079-611C63E0xxx
successboolean

是否成功

true
dataobject

返回结果

planIdlong

计划 ID

1300000016
planNamestring

计划名称

xxx
planDescstring

计划描述

xxxx
planTypestring

计划类型:

  • ACTIVE_PASSIVE(单向备份)
  • ACTIVE_ACTIVE(双向备份)
ACTIVE_PASSIVE
planStatusstring

计划状态:

  • CREATED(已创建)
  • RUNNING(运行中)
  • DELETED(已删除)
RUNNING
extInfoobject

扩展信息

string

扩展信息

xxxx
instancesarray<object>

备份计划参与实例

instanceobject

备份计划参与实例

instanceTypestring

实例类型

ALIYUN_ROCKETMQ
regionIdstring

实例所在区域

cn-shanghai
instanceIdstring

实例 ID

rmq-cn-gpz3qtcdxxx
instanceRolestring

实例角色

ACTIVE
authTypestring

认证方式

ACL_AUTH
usernamestring

认证用户名

xxx
passwordstring

认证密码

xxx
endpointUrlstring

接入点地址

xxx
networkTypestring

网络类型

TCP_INTERNET
vpcIdstring

VPC ID

vpc-wz9qt50xhtj9krb******
vSwitchIdstring

交换机 ID

vsw-uf6gwtbn6etadpv******
messagePropertyobject

消息过滤属性

propertyKeystring

属性 key

xxx
propertyValuestring

属性 value

xxx
securityGroupIdstring

安全组 id

sg-bp17hpmgz9******
consumerGroupIdstring

消费者组 ID,用于从源实例拉取消息。

GID_DS_XXX_YYY
createTimestring

创建时间

2022-08-01 20:05:50
updateTimestring

修改时间

2022-08-01 20:05:50
autoSyncCheckpointboolean

是否开启消费进度自动同步。

说明 只有在开启消费进度同步时有效。即 syncCheckpointEnabled字段值为 true。
枚举值:
  • true开启
  • false关闭
true
syncCheckpointEnabledboolean

同步消费进度开关

枚举值:
  • true开启
  • false关闭
true
codestring

错误码

200
messagestring

错误信息

xxx
httpStatusCodeinteger

HTTP 状态码

200
dynamicCodestring

动态错误码

InstanceId
dynamicMessagestring

动态错误信息

instanceId
accessDeniedDetailstring

访问拒绝详细信息,有且仅有在因 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"
}

错误码

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

变更历史

变更时间变更内容概要操作
暂无变更历史