DescribeGtmRecoveryPlan - Alibaba Cloud DNS - Alibaba Cloud Documentation Center

Queries the details of a disaster recovery plan.

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:
- 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	get	All Resources *	none	none

Request parameters

Parameter	Type	Required	Description	Example
Lang	string	No	The language of the response. Valid values: zh: Chinese en: English Default value: en.	en
RecoveryPlanId	long	Yes	The ID of the disaster recovery plan.	100

Response parameters

Parameter	Type	Description	Example
	object
Status	string	The status of the disaster recovery plan.	UNEXECUTED
LastRollbackTime	string	The time when the disaster recovery plan was last rolled back. This value is a UNIX timestamp representing the number of milliseconds that have elapsed since January 1, 1970, 00:00:00 UTC.	2019-08-11T06:45Z
FaultAddrPoolNum	integer	The number of faulty address pools.	2
FaultAddrPools	array<object>	The faulty address pools.
FaultAddrPool	object
Addrs	array<object>
Addr	object
Value	string	The address.	1.1.1.1
Mode	string	The address mode.	OFFLINE
Id	long	The address ID.	739
AddrPoolId	string	The address pool ID.	hra0oq
InstanceId	string	The instance ID.	instance-zwy-38
AddrPoolName	string	The address pool name.
LastExecuteTime	string	The time when the disaster recovery plan was last executed. The time follows the ISO 8601 standard in the YYYY-MM-DDThh:mm:ssZ format. The time is displayed in UTC.	2019-08-11T05:04Z
RequestId	string	The request ID.	0A5F4315-D6E8-435E-82DF-24F4C97D6999
CreateTime	string	The time when the disaster recovery plan was created. The time follows the ISO 8601 standard in the YYYY-MM-DDThh:mm:ssZ format. The time is displayed in UTC.	2019-08-11T05:04Z
LastExecuteTimestamp	long	The time when the disaster recovery plan was last executed. This value is a UNIX timestamp representing the number of milliseconds that have elapsed since January 1, 1970, 00:00:00 UTC.	1565505898000
Remark	string	The description of the disaster recovery plan.	remark-example
Name	string	The name of the disaster recovery plan.	name-example
RecoveryPlanId	long	The ID of the disaster recovery plan.	55
UpdateTime	string	The time when the disaster recovery plan was last modified. The time follows the ISO 8601 standard in the YYYY-MM-DDThh:mm:ssZ format. The time is displayed in UTC.	2019-08-11T06:45Z
UpdateTimestamp	long	The time when the disaster recovery plan was last modified. This value is a UNIX timestamp representing the number of milliseconds that have elapsed since January 1, 1970, 00:00:00 UTC.	1565499867000
LastRollbackTimestamp	long	The time when the disaster recovery plan was last rolled back. This value is a UNIX timestamp representing the number of milliseconds that have elapsed since January 1, 1970, 00:00:00 UTC.	1565505919000
CreateTimestamp	long	The time when the disaster recovery plan was created. This value is a UNIX timestamp representing the number of milliseconds that have elapsed since January 1, 1970, 00:00:00 UTC.	1565499867000

Examples

Sample success responses

JSONformat

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

Error codes

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