使用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"
}

錯誤碼

訪問錯誤中心查看更多錯誤碼。

變更歷史

更多資訊，參考變更詳情。