DescribeGtmRecoveryPlan - Alibaba Cloud DNS - Alibaba Cloud Documentation Center

Retrieves the details of a disaster recovery plan.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

alidns:DescribeGtmRecoveryPlan

get

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
Lang	string	No	The language of the response. Valid values: zh: Chinese en: English Default: en	en
RecoveryPlanId	integer	Yes	The ID of the disaster recovery plan. You can call DescribeGtmRecoveryPlans to obtain the ID.	10*****

Response elements

Element	Type	Description	Example
	object
Status	string	The status of the disaster recovery plan: UNEXECUTED: The disaster recovery plan is not executed. EXECUTED: The disaster recovery plan is being executed. ROLLED_BACK: The disaster recovery plan is being rolled back.	UNEXECUTED
LastRollbackTime	string	The time when the disaster recovery plan was last rolled back. The value is a string that represents a UNIX timestamp.	1565505919000
FaultAddrPoolNum	integer	The number of abnormal address pools.	2
FaultAddrPools	object
FaultAddrPool	array<object>	The list of abnormal address pools.
	object	The list of abnormal address pools.
Addrs	object
Addr	array<object>	The list of addresses.
	object	The list of addresses.
Value	string	The address.	1.1.XX.XX
Mode	string	The address mode: ONLINE: The address is always online. The address is resolvable regardless of its health check status. OFFLINE: The address is always offline. The address is unresolvable regardless of its health check status. SMART: The address is intelligently returned. The address is resolvable based on its health check status.	SMART
Id	integer	The address ID.	73**
AddrPoolId	string	The ID of the address pool.	hra0**
InstanceId	string	The instance ID.	gtm-cn-zz11t58****
AddrPoolName	string	The name of the address pool.	Stress Test-Failover-1
LastExecuteTime	string	The time when the disaster recovery plan was last executed.	2019-08-11T05:04Z
RequestId	string	The request ID.	0A5F4315-D6E8-435E-82DF-24F4C97D6999
CreateTime	string	The time when the disaster recovery plan was created.	2019-08-11T05:04Z
LastExecuteTimestamp	integer	The time when the disaster recovery plan was last executed. This value is a UNIX timestamp.	1565505898000
Remark	string	The remarks.	remark-example
Name	string	The name of the disaster recovery plan.	name-example
RecoveryPlanId	integer	The ID of the disaster recovery plan.	10****
UpdateTime	string	The time when the disaster recovery plan was last updated.	2024-03-29T13:20Z
UpdateTimestamp	integer	The time when the disaster recovery plan was last updated. This value is a UNIX timestamp.	1565505898000
LastRollbackTimestamp	integer	The time when the disaster recovery plan was last rolled back. This value is a UNIX timestamp.	1565505898000
CreateTimestamp	integer	The time when the disaster recovery plan was created. This value is a UNIX timestamp.	1565499867000

Examples

Success response

JSON format

{
  "Status": "UNEXECUTED",
  "LastRollbackTime": "1565505919000",
  "FaultAddrPoolNum": 2,
  "FaultAddrPools": {
    "FaultAddrPool": [
      {
        "Addrs": {
          "Addr": [
            {
              "Value": "1.1.XX.XX",
              "Mode": "SMART",
              "Id": 0
            }
          ]
        },
        "AddrPoolId": "hra0**",
        "InstanceId": "gtm-cn-zz11t58****",
        "AddrPoolName": "压测-Failover-1"
      }
    ]
  },
  "LastExecuteTime": "2019-08-11T05:04Z",
  "RequestId": "0A5F4315-D6E8-435E-82DF-24F4C97D6999",
  "CreateTime": "2019-08-11T05:04Z",
  "LastExecuteTimestamp": 1565505898000,
  "Remark": "remark-example",
  "Name": "name-example",
  "RecoveryPlanId": 0,
  "UpdateTime": "2024-03-29T13:20Z",
  "UpdateTimestamp": 1565505898000,
  "LastRollbackTimestamp": 1565505898000,
  "CreateTimestamp": 1565499867000
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.