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. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.

Request parameters

Parameter Type Required Example Description
Action String Yes PreviewGtmRecoveryPlan

The operation that you want to perform. Set the value to PreviewGtmRecoveryPlan.

PageNumber Integer Yes 1

The number of the page to return. Pages start from page 1. Default value: 1.

RecoveryPlanId Long Yes 100

The ID of the disaster recovery plan that you want to preview.

Lang String No en

The language used by the user.

PageSize Integer No 5

The number of entries to return on per page. Maximum value: 20. Default value: 5.

Response parameters

Parameter Type Example Description
PageNumber Integer 1

The page number of the returned page.

PageSize Integer 5

The number of entries returned per page.

Previews Array

The returned preview information of the disaster recovery plan.

Preview

The returned preview details about the disaster recovery plan.

InstanceId String instance-example

The ID of the GTM instance to which the previewed disaster recovery plan belongs.

Name String name-example

The name of the GTM instance to which the previewed disaster recovery plan belongs.

SwitchInfos Array

The returned information of the switching policies for address pools.

SwitchInfo

The details about the switching policy for address pools.

Content String Default address pool (default address pool 1) switches to failover address pool (failover address pool 1).

The formatted message content.

StrategyName String strategy-name-example-1

The name of the switching policy for address pools.

UserDomainName String 30.yyy.com

The user's domain name or domain name list.

RequestId String 853805EA-3D47-47D5-9A1A-A45C24313ABD

The ID of the request.

TotalItems Integer 15

The total number of entries returned on all pages.

TotalPages Integer 3

The total number of pages returned.

Examples

Sample requests


http(s)://alidns.aliyuncs.com/? Action=PreviewGtmRecoveryPlan
&PageNumber=1
&RecoveryPlanId=100
&<Common request parameters>

Sample success responses

XML format

<PreviewGtmRecoveryPlanResponse>
	  <PageNumber>1</PageNumber>
	  <Previews>
		    <Preview>
			      <Name>name-example</Name>
			      <SwitchInfos>
				        <SwitchInfo>
					          <StrategyName>strategy-name-example-1</StrategyName>
					          <Content>Default address pool (default address pool 1) switches to failover address pool (failover address pool 1)</Content>
				        </SwitchInfo>
				        <SwitchInfo>
					          <StrategyName>strategy-name-examle-2</StrategyName>
					          <Content>Default address pool (default address pool 2) switches to failover address pool (failover address pool 2)</Content>
				        </SwitchInfo>
			      </SwitchInfos>
			      <InstanceId>instance-example</InstanceId>
			      <UserDomainName>30.yyy.com</UserDomainName>
		    </Preview>
	  </Previews>
	  <PageSize>5</PageSize>
	  <RequestId>853805EA-3D47-47D5-9A1A-A45C24313ABD</RequestId>
	  <TotalItems>15</TotalItems>
	  <TotalPages>3</TotalPages>
</PreviewGtmRecoveryPlanResponse>

JSON format

{
	"PageNumber":1,
	"Previews":{
		"Preview":[
			{
				"Name":"name-example",
				"InstanceId":"instance-example",
				"SwitchInfos":{
					"SwitchInfo":[
						{
							"StrategyName":"strategy-name-example-1",
							"Content":"Default address pool (default address pool 1) switches to failover address pool (failover address pool 1)"
						},
						{
							"StrategyName":"strategy-name-examle-2",
							"Content":"Default address pool (default address pool 2) switches to failover address pool (failover address pool 2)"
						}
					]
				},
				"UserDomainName":"30.yyy.com"
			}
		]
	},
	"PageSize":5,
	"RequestId":"853805EA-3D47-47D5-9A1A-A45C24313ABD",
	"TotalItems":15,
	"TotalPages":3
}

Error codes

For a list of error codes, visit the API Error Center.