PreviewGtmRecoveryPlan - Alibaba Cloud DNS - Alibaba Cloud Documentation Center

You can call this operation to preview a disaster recovery plan of 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:PreviewGtmRecoveryPlan	get	All Resources *	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 preview.	100
PageNumber	integer	No	The number of the page to return. Pages start from page 1. Default value: 1.	1
PageSize	integer	No	The number of entries to return on per page. Maximum value: 20. Default value: 5.	5

Response parameters

Parameter	Type	Description	Example
	object
TotalPages	integer	The total number of pages returned.	3
TotalItems	integer	The total number of entries returned on all pages.	15
PageNumber	integer	The page number of the returned page.	1
PageSize	integer	The number of entries returned per page.	5
RequestId	string	The ID of the request.	853805EA-3D47-47D5-9A1A-A45C24313ABD
Previews	array<object>	The returned preview information of the disaster recovery plan.
Preview	object
InstanceId	string	The ID of the GTM instance to which the previewed disaster recovery plan belongs.	instance-example
Name	string	The name of the GTM instance to which the previewed disaster recovery plan belongs.	name-example
UserDomainName	string	The user's domain name or domain name list.	30.yyy.com
SwitchInfos	array<object>	The returned information of the switching policies for address pools.
SwitchInfo	object
Content	string	The formatted message content.
StrategyName	string	The name of the switching policy for address pools.	strategy-name-example-1

Examples

Sample success responses

JSONformat

{
  "TotalPages": 3,
  "TotalItems": 15,
  "PageNumber": 1,
  "PageSize": 5,
  "RequestId": "853805EA-3D47-47D5-9A1A-A45C24313ABD",
  "Previews": {
    "Preview": [
      {
        "InstanceId": "instance-example",
        "Name": "name-example",
        "UserDomainName": "30.yyy.com",
        "SwitchInfos": {
          "SwitchInfo": [
            {
              "Content": "",
              "StrategyName": "strategy-name-example-1"
            }
          ]
        }
      }
    ]
  }
}

Error codes

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