DescribeGtmRecoveryPlans - Alibaba Cloud DNS - Alibaba Cloud Documentation Center

Queries the disaster recovery plans for a Global Traffic Manager (GTM) instance.

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

Request parameters

Parameter	Type	Required	Description	Example
Lang	string	No	The language in which you want the values of some response parameters to be returned. These response parameters support multiple languages.	en
Keyword	string	No	The keyword for the query. Fuzzy match is supported by disaster recovery plan name.	test
PageNumber	integer	No	The page number to return. The page number starts from 1. Default value: 1.	1
PageSize	integer	No	The number of entries to return per page. Maximum value: 100. Default value: 20.	20

Response parameters

Parameter	Type	Description	Example
	object
TotalPages	integer	The total number of pages returned.	1
TotalItems	integer	The total number of entries returned.	10
PageSize	integer	The number of entries returned per page.	20
PageNumber	integer	The page number of the returned page.	1
RequestId	string	The ID of the request.	2BA072CF-CA21-4A34-B6C2-227BE2C58079
RecoveryPlans	array<object>	The details about the queried disaster recovery plans.
RecoveryPlan	object
Status	string	The status of the disaster recovery plan. Valid values: UNEXECUTED: The plan is not executed. EXECUTED: The plan is executed. ROLLED_BACK: The plan is rolled back.	UNEXECUTED
LastRollbackTimestamp	long	The UNIX 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 about the disaster recovery plan.	remark-example
CreateTime	string	The time when the disaster recovery plan was created.	2019-08-11T06:45Z
RecoveryPlanId	long	The ID of the disaster recovery plan.	55
UpdateTimestamp	long	The UNIX timestamp that indicates the last time when the disaster recovery plan was updated.	1565505919000
LastExecuteTimestamp	long	The UNIX timestamp that indicates the last time when the disaster recovery plan was executed.	1565505898000
LastExecuteTime	string	The last time when the disaster recovery plan was executed.	2019-08-11T06:44Z
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.	name-example
FaultAddrPoolNum	integer	The number of faulty address pools.	0
CreateTimestamp	long	The UNIX timestamp that indicates when the disaster recovery plan was created.	1565499867000

Examples

Sample success responses

JSONformat

{
  "TotalPages": 1,
  "TotalItems": 10,
  "PageSize": 20,
  "PageNumber": 1,
  "RequestId": "2BA072CF-CA21-4A34-B6C2-227BE2C58079",
  "RecoveryPlans": {
    "RecoveryPlan": [
      {
        "Status": "UNEXECUTED",
        "LastRollbackTimestamp": 1565505919000,
        "UpdateTime": "2019-08-11T06:45Z",
        "Remark": "remark-example",
        "CreateTime": "2019-08-11T06:45Z",
        "RecoveryPlanId": 55,
        "UpdateTimestamp": 1565505919000,
        "LastExecuteTimestamp": 1565505898000,
        "LastExecuteTime": "2019-08-11T06:44Z",
        "LastRollbackTime": "2019-08-11T06:45Z",
        "Name": "name-example",
        "FaultAddrPoolNum": 0,
        "CreateTimestamp": 1565499867000
      }
    ]
  }
}

Error codes

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