DescribeGtmRecoveryPlans - - Alibaba Cloud Documentation Center

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	DescribeGtmRecoveryPlans	The operation that you want to perform. Set the value to DescribeGtmRecoveryPlans.
Keyword	String	No	test	The keywords for query. This operation performs fuzzy match by instance ID, instance name, or CNAME record.
Lang	String	No	en	The language used by the user.
PageNumber	Integer	No	1	The number of the page to return. Pages start from page 1. Default value: 1.
PageSize	Integer	No	20	The number of entries to return on per page. Maximum value: 100. Default value: 20.

Response parameters


Parameter	Type	Example	Description
PageNumber	Integer	1	The page number of the returned page.
PageSize	Integer	20	The number of entries returned per page.
RecoveryPlans	Array		The list of disaster recovery plans returned.
RecoveryPlan			The details about a disaster recovery plan.
CreateTime	String	2019-08-11T06:45Z	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	0	The number of faulty address pools.
LastExecuteTime	String	2019-08-11T06:44Z	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.
RecoveryPlanId	Long	55	The ID of the disaster recovery plan.
Remark	String	remark-example	The remarks on the disaster recovery plan.
Status	String	UNEXECUTED	The status of the disaster recovery plan. Valid values: UNEXECUTED: Unexecuted EXECUTED: Executed ROLLED_BACK: Rolled back
UpdateTime	String	2019-08-11T06:45Z	The last time when the disaster recovery plan was updated.
UpdateTimestamp	Long	1565505919000	A timestamp that indicates the last time when the disaster recovery plan was updated.
RequestId	String	2BA072CF-CA21-4A34-B6C2-227BE2C58079	The ID of the request.
TotalItems	Integer	10	The total number of entries returned on all pages.
TotalPages	Integer	1	The total number of pages returned.

Examples

Sample requests


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

Sample success responses

XML format

<DescribeGtmRecoveryPlansResponse>
  <PageNumber>1</PageNumber>
	  <PageSize>20</PageSize>
	  <RequestId>2BA072CF-CA21-4A34-B6C2-227BE2C58079</RequestId>
	  <TotalItems>10</TotalItems>
	  <TotalPages>1</TotalPages>
	  <RecoveryPlans>
		    <RecoveryPlan>
			      <CreateTimestamp>1565499867000</CreateTimestamp>
			      <LastRollbackTime>2019-08-11T06:45Z</LastRollbackTime>
			      <UpdateTimestamp>1565505919000</UpdateTimestamp>
			      <UpdateTime>2019-08-11T06:45Z</UpdateTime>
			      <RecoveryPlanId>55</RecoveryPlanId>
			      <Name>name-example</Name>
			      <LastRollbackTimestamp>1565505919000</LastRollbackTimestamp>
			      <Status>ROLLED_BACK</Status>
			      <LastExecuteTimestamp>1565505898000</LastExecuteTimestamp>
			      <CreateTime>2019-08-11T05:04Z</CreateTime>
			      <LastExecuteTime>2019-08-11T06:44Z</LastExecuteTime>
			      <FaultAddrPoolNum>0</FaultAddrPoolNum>
			      <Remark>remark-example</Remark>
		    </RecoveryPlan>
	  </RecoveryPlans>
</DescribeGtmRecoveryPlansResponse>

JSON format

{
	"PageNumber":1,
	"PageSize":20,
	"RequestId":"2BA072CF-CA21-4A34-B6C2-227BE2C58079",
	"TotalItems":10,
	"RecoveryPlans":{
		"RecoveryPlan":[
			{
				"CreateTimestamp":1565499867000,
				"LastRollbackTime":"2019-08-11T06:45Z",
				"UpdateTimestamp":1565505919000,
				"UpdateTime":"2019-08-11T06:45Z",
				"RecoveryPlanId":55,
				"Name":"name-example",
				"LastRollbackTimestamp":1565505919000,
				"Status":"ROLLED_BACK",
				"LastExecuteTimestamp":1565505898000,
				"CreateTime":"2019-08-11T05:04Z",
				"LastExecuteTime":"2019-08-11T06:44Z",
				"FaultAddrPoolNum":0,
				"Remark":"remark-example"
			}
		]
	},
	"TotalPages":1
}

Error codes

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