PreviewGtmRecoveryPlan - Alibaba Cloud DNS - Alibaba Cloud Documentation Center

Previews a disaster recovery plan.

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:PreviewGtmRecoveryPlan

get

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
Lang	string	No	The language of the response. Valid values: zh: Chinese en: English Default: en	en
RecoveryPlanId	integer	Yes	The ID of the disaster recovery plan.You can call the DescribeGtmRecoveryPlans operation to obtain the ID.	10**
PageNumber	integer	No	The page number. The value starts from 1. Default: 1.	1
PageSize	integer	No	The number of entries per page. Maximum value: 20. Default: 5.	5

Response elements

Element	Type	Description	Example
	object
PageSize	integer	The number of entries returned per page. Maximum value: 100. Default: 20.	5
RequestId	string	The unique request ID.	853805EA-3D47-47D5-9A1A-A45C24313ABD
PageNumber	integer	The page number. The value starts from 1. Default: 1.	1
Previews	object
Preview	array<object>	The preview of the disaster recovery plan execution.
	object
InstanceId	string	The instance ID.	gtm-cn-wwo3a3hbz**
SwitchInfos	object
SwitchInfo	array<object>	The switch information.
	object
StrategyName	string	The policy name.	hrb5ju
Content	string	The formatted message.	Fail over from Default Address Pool 1 to Backup Address Pool 1.
Name	string	The instance name.	name-example
UserDomainName	string	The custom domain name.	example.com
TotalPages	integer	The total number of pages.	3
TotalItems	integer	The total number of entries.	15

Examples

Success response

JSON format

{
  "PageSize": 5,
  "RequestId": "853805EA-3D47-47D5-9A1A-A45C24313ABD",
  "PageNumber": 1,
  "Previews": {
    "Preview": [
      {
        "InstanceId": "gtm-cn-wwo3a3hbz**",
        "SwitchInfos": {
          "SwitchInfo": [
            {
              "StrategyName": "hrb5ju",
              "Content": "默认地址池（默认地址池1）切换备用地址池（备用地址池1）"
            }
          ]
        },
        "Name": "name-example",
        "UserDomainName": "example.com"
      }
    ]
  },
  "TotalPages": 3,
  "TotalItems": 15
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.