You can call this operation to query the detailed information of a disaster recovery plan for 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 DescribeGtmRecoveryPlan

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

RecoveryPlanId Long Yes 100

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

Lang String No en

The language used by the user.

Response parameters

Parameter Type Example Description
CreateTime String 2019-08-11T05:04Z

The time when the disaster recovery plan was created.

CreateTimeStamp Long 1565499867000

A timestamp that indicates the time when the disaster recovery plan was created.

FaultAddrPoolNum Integer 2

The number of faulty address pools.

FaultAddrPools Array

The list of faulty address pools.

FaultAddrPool

The details about a faulty address pool.

AddrPoolId String hra0oq

The ID of the address pool.

AddrPoolName String Stress testing-Failover-1

The name of the address pool.

Addrs Array

The list of addresses in the address pool.

Addr

The details about an address.

Id Long 739

The ID of the address.

Mode String OFFLINE

The address work mode. It is the mode that was set for the IP address to work.

Value String 1.1.1.1

The address value.

InstanceId String instance-zwy-38

The ID of the GTM instance.

LastExecuteTime String 2019-08-11T05:04Z

The last time when the recovery plan was executed.

LastExecuteTimestamp Long 1565505898000

A timestamp that indicates the last time when the recovery plan was executed.

LastRollbackTime String 2019-08-11T06:45Z

The last time when the disaster recovery plan was rolled back.

LastRollbackTimestamp Long 1565505919000

A timestamp that indicates the last time when the disaster recovery plan was rolled back.

Name String name-example

The name of the disaster recovery plan queried.

RecoveryPlanId Long 55

The ID of the disaster recovery plan queried.

Remark String remark-example

The remarks on the disaster recovery plan.

RequestId String 0A5F4315-D6E8-435E-82DF-24F4C97D6999

The ID of the request.

Status String UNEXECUTED

The status of the disaster recovery plan queried.

UpdateTime String 2019-08-11T06:45Z

The last time when the disaster recovery plan was updated.

UpdateTimestamp Long 1565499867000

A timestamp that indicates the last time when the disaster recovery plan was updated.

Examples

Sample requests


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

Sample success responses

XML format

<DescribeGtmRecoveryPlanResponse>
	  <CreateTimestamp>1565499867000</CreateTimestamp>
	  <UpdateTimestamp>1565505919000</UpdateTimestamp>
	  <LastRollbackTime>2019-08-11T06:45Z</LastRollbackTime>
	  <UpdateTime>2019-08-11T06:45Z</UpdateTime>
	  <RecoveryPlanId>55</RecoveryPlanId>
	  <Name>name-example</Name>
	  <Status>ROLLED_BACK</Status>
	  <LastRollbackTimestamp>1565505919000</LastRollbackTimestamp>
	  <LastExecuteTimestamp>1565505898000</LastExecuteTimestamp>
	  <RequestId>0A5F4315-D6E8-435E-82DF-24F4C97D6999</RequestId>
	  <CreateTime>2019-08-11T05:04Z</CreateTime>
	  <LastExecuteTime>2019-08-11T06:44Z</LastExecuteTime>
	  <FaultAddrPoolNum>2</FaultAddrPoolNum>
	  <FaultAddrPools>
		    <FaultAddrPool>
			      <AddrPoolName>Stress testing-Failover-1</AddrPoolName>
			      <Addrs>
				        <Addr>
					          <Value>1.1.1.1</Value>
					          <Id>739</Id>
					          <Mode>OFFLINE</Mode>
				        </Addr>
				        <Addr>
					          <Value>2.2.2.2</Value>
					          <Id>740</Id>
					          <Mode>OFFLINE</Mode>
				        </Addr>
			      </Addrs>
			      <InstanceId>instance-zwy-38</InstanceId>
			      <AddrPoolId>hra0oq</AddrPoolId>
		    </FaultAddrPool>
	  </FaultAddrPools>
	  <Remark>remark-example</Remark>
</DescribeGtmRecoveryPlanResponse>

JSON format

{
	"CreateTimestamp":1565499867000,
	"UpdateTimestamp":1565505919000,
	"LastRollbackTime":"2019-08-11T06:45Z",
	"UpdateTime":"2019-08-11T06:45Z",
	"RecoveryPlanId":55,
	"Name":"name-example",
	"Status":"ROLLED_BACK",
	"LastRollbackTimestamp":1565505919000,
	"LastExecuteTimestamp":1565505898000,
	"RequestId":"0A5F4315-D6E8-435E-82DF-24F4C97D6999",
	"CreateTime":"2019-08-11T05:04Z",
	"LastExecuteTime":"2019-08-11T06:44Z",
	"FaultAddrPoolNum":2,
	"FaultAddrPools":{
		"FaultAddrPool":[
			{
				"AddrPoolName":"Stress testing-Failover-1",
				"Addrs":{
					"Addr":[
						{
							"Value":"1.1.1.1",
							"Id":739,
							"Mode":"OFFLINE"
						},
						{
							"Value":"2.2.2.2",
							"Id":740,
							"Mode":"OFFLINE"
						}
					]
				},
				"InstanceId":"instance-zwy-38",
				"AddrPoolId":"hra0oq"
			}
		]
	},
	"Remark":"remark-example"
}

Error codes

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