GetDisasterRecoveryItem - ApsaraMQ for RocketMQ - Alibaba Cloud Documentation Center

Queries the details of a topic mapping in a Global Replicator task.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Debug

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

Operation: the value that you can use in the Action element to specify the operation on a resource.
Access level: the access level of each operation. The levels are read, write, and list.
Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
- For mandatory resource types, indicate with a prefix of * .
- If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
Condition Key: the condition key that is defined by the cloud service.
Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.

Operation	Access level	Resource type	Condition key	Associated operation
rocketmq:GetDisasterRecoveryItem	get	*Topic `acs:rocketmq:{#regionId}:{#accountId}:instance/{#InstanceId}/topic/{#TopicName}`	none	none

Request syntax

GET /disaster_recovery/{planId}/items/{itemId} HTTP/1.1

Request parameters

Parameter	Type	Required	Description	Example
planId	long	Yes	The ID of the global message backup plan.	1300000016
itemId	long	Yes	The ID of the topic mapping.	100070284

Response parameters

Parameter	Type	Description	Example
	object	Result
requestId	string	Request ID	AF9A8B10-C426-530F-A0DD-96320B39****
success	boolean	Indicates whether the request was successful.	true
data	object	The data returned.
itemId	long	The ID of the topic mapping	100070284
planId	long	The ID of the global message backup plan.	1300000016
itemStatus	string	The topic mapping task status.	RUNNING
topics	array<object>	Topics included in the backup mapping
topic	object	Topics included in the backup mapping
regionId	string	regionId	cn-hangzhou
instanceType	string	Instance type ALIYUN_ROCKETMQ: Alibaba Cloud instance EXTERNAL_ROCKETMQ: External instance, open-source instance, open-source cluster	ALIYUN_ROCKETMQ
instanceId	string	The instance ID.	rmq-cn-wwo3xxx
topicName	string	The topic name.	order_push_xxx
consumerGroupId	string	The consumer group ID.	xxx_reserve_group
deliveryOrderType	string	The order in which messages are delivered to the target instance. The parameter values are as follows: Concurrently: concurrent delivery Orderly: sequential delivery	Concurrently
extInfo	object	Additional Information
	string	Additional Information	{}
createTime	string	The time when the topic mapping task was created.	2024-06-24 02:57:31
updateTime	string	The time when the topic mapping task was last updated.	2024-09-26 02:13:10
code	string	The error code.	200
message	string	The error message.	xxx
httpStatusCode	integer	The HTTP status code.	200
dynamicCode	string	The dynamic error code.	InstanceId
dynamicMessage	string	The dynamic error message.	instanceId
accessDeniedDetail	string	The details about the access denial. This parameter is returned only if the access is denied because the Resource Access Management (RAM) user does not have the required permissions.	xxx

Examples

Sample success responses

JSONformat

{
  "requestId": "AF9A8B10-C426-530F-A0DD-96320B39****",
  "success": true,
  "data": {
    "itemId": 100070284,
    "planId": 1300000016,
    "itemStatus": "RUNNING",
    "topics": [
      {
        "regionId": "cn-hangzhou",
        "instanceType": "ALIYUN_ROCKETMQ",
        "instanceId": "rmq-cn-wwo3xxx",
        "topicName": "order_push_xxx",
        "consumerGroupId": "xxx_reserve_group",
        "deliveryOrderType": "Concurrently"
      }
    ],
    "extInfo": {
      "key": {}
    },
    "createTime": "2024-06-24 02:57:31",
    "updateTime": "2024-09-26 02:13:10"
  },
  "code": 200,
  "message": "xxx",
  "httpStatusCode": 200,
  "dynamicCode": "InstanceId",
  "dynamicMessage": "instanceId",
  "accessDeniedDetail": "xxx"
}

Error codes

For a list of error codes, visit the Service error codes.