DescribeGtmRecoveryPlan - Alibaba Cloud DNS - Alibaba Cloud Documentation Center

You can call this operation to query the detailed information of a disaster recovery plan for a Global Traffic Manager (GTM) instance.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

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:
- The required resource types are displayed in bold characters.
- 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
alidns:DescribeGtmRecoveryPlan	READ	gtmInstance acs:alidns::{#accountId}:gtmInstance/*	none	none

Request parameters

Parameter	Type	Required	Description	Example
Lang	string	No	The language used by the user.	en
RecoveryPlanId	long	Yes	The ID of the disaster recovery plan that you want to query.	100

Response parameters

Parameter	Type	Description	Example
	object
Status	string	The status of the disaster recovery plan queried.	UNEXECUTED
LastRollbackTimestamp	long	A timestamp that indicates the last time when the disaster recovery plan was rolled back.	1565505919000
UpdateTime	string	The last time when the disaster recovery plan was updated.	2019-08-11T06:45Z
Remark	string	The remarks on the disaster recovery plan.	remark-example
CreateTime	string	The time when the disaster recovery plan was created.	2019-08-11T05:04Z
RecoveryPlanId	long	The ID of the disaster recovery plan queried.	55
UpdateTimestamp	long	A timestamp that indicates the last time when the disaster recovery plan was updated.	1565499867000
RequestId	string	The ID of the request.	0A5F4315-D6E8-435E-82DF-24F4C97D6999
LastExecuteTimestamp	long	A timestamp that indicates the last time when the recovery plan was executed.	1565505898000
LastExecuteTime	string	The last time when the recovery plan was executed.	2019-08-11T05:04Z
LastRollbackTime	string	The last time when the disaster recovery plan was rolled back.	2019-08-11T06:45Z
Name	string	The name of the disaster recovery plan queried.	name-example
FaultAddrPoolNum	integer	The number of faulty address pools.	2
FaultAddrPools	object []	The list of faulty address pools.
AddrPoolId	string	The ID of the address pool.	hra0oq
InstanceId	string	The ID of the GTM instance.	instance-zwy-38
AddrPoolName	string	The name of the address pool.
Addrs	object []	The list of addresses in the address pool.
Value	string	The address value.	1.1.1.1
Mode	string	The address work mode. It is the mode that was set for the IP address to work.	OFFLINE
Id	long	The ID of the address.	739

Examples

Sample success responses

JSONformat

{
  "Status": "UNEXECUTED",
  "LastRollbackTimestamp": 1565505919000,
  "UpdateTime": "2019-08-11T06:45Z",
  "Remark": "remark-example",
  "CreateTime": "2019-08-11T05:04Z",
  "RecoveryPlanId": 55,
  "UpdateTimestamp": 1565499867000,
  "RequestId": "0A5F4315-D6E8-435E-82DF-24F4C97D6999",
  "LastExecuteTimestamp": 1565505898000,
  "LastExecuteTime": "2019-08-11T05:04Z",
  "LastRollbackTime": "2019-08-11T06:45Z",
  "Name": "name-example",
  "FaultAddrPoolNum": 2,
  "CreateTimestamp": 1565499867000,
  "FaultAddrPools": {
    "FaultAddrPool": [
      {
        "AddrPoolId": "hra0oq",
        "InstanceId": "instance-zwy-38",
        "AddrPoolName": "",
        "Addrs": {
          "Addr": [
            {
              "Value": "1.1.1.1",
              "Mode": "OFFLINE",
              "Id": 739
            }
          ]
        }
      }
    ]
  }
}

Error codes

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