DescribeGtmRecoveryPlans - Alibaba Cloud DNS - Alibaba Cloud Documentation Center

Queries a list of disaster recovery plans.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

alidns:DescribeGtmRecoveryPlans

get

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
Lang	string	No	The language of the response. Valid values are `en` for English and `zh` for Chinese. The default value is `zh`. en: English. en: English Default value: zh.	en
Keyword	string	No	The keyword for the query. This parameter supports a fuzzy search by disaster recovery plan name.	test
PageNumber	integer	No	The number of the page to return. Pages start from 1. The default value is 1.	1
PageSize	integer	No	The number of entries to return on each page. The maximum value is 100. The default value is 20.	20

Response elements

Element	Type	Description	Example
	object
RecoveryPlans	object
RecoveryPlan	array<object>	A list of disaster recovery plans.
	object
Status	string	The status of the plan. Valid values: UNEXECUTED: Not executed EXECUTED: Executed ROLLED_BACK: Rolled back	UNEXECUTED
LastRollbackTimestamp	integer	The UNIX timestamp of the last rollback.	1565505919000
UpdateTime	string	The time when the plan was last updated.	2019-08-11T06:45Z
Remark	string	The remarks.	remark-example
CreateTime	string	The time when the plan was created.	2019-08-11T06:45Z
RecoveryPlanId	integer	The ID of the disaster recovery plan.	5****
UpdateTimestamp	integer	The UNIX timestamp of the last update.	1565505919000
LastExecuteTimestamp	integer	The UNIX timestamp of the last execution.	1565505898000
LastExecuteTime	string	The time of the last execution.	2019-08-11T06:44Z
LastRollbackTime	string	The time of the last rollback.	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	integer	The UNIX timestamp of the creation time.	1565499867000
PageSize	integer	The number of entries returned on each page. The maximum value is 100. The default value is 20.	20
RequestId	string	The unique request ID.	2BA072CF-CA21-4A34-B6C2-227BE2C58079
PageNumber	integer	The page number of the returned page. Pages start from 1. The default value is 1.	1
TotalPages	integer	The total number of pages.	1
TotalItems	integer	The total number of entries.	10

Examples

Success response

JSON format

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

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.