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

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

Debug

Authorization information

There is currently no authorization information disclosed in the API.

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	object []	The returned preview information of the disaster recovery plan.
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	object []	The returned information of the switching policies for address pools.
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.