调用PreviewGtmRecoveryPlan预览容灾预案_云解析DNS(DNS)-阿里云帮助中心

预览容灾预案。

调试

您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：

操作：是指具体的权限点。
访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用背景高亮的方式表示。
- 对于不支持资源级授权的操作，用全部资源表示。
条件关键字：是指云产品自身定义的条件关键字。
关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

操作	访问级别	资源类型	条件关键字	关联操作
alidns:PreviewGtmRecoveryPlan	get	全部资源 *	无	无

请求参数

名称	类型	必填	描述	示例值
Lang	string	否	用户语言。	en
RecoveryPlanId	long	是	容灾预案 ID。	100
PageNumber	integer	是	当前页数，起始值为 1，默认为 1。	1
PageSize	integer	否	分页查询时设置的每页行数，最大值 20，默认为 5。	5

返回参数

名称	类型	描述	示例值
	object
PageSize	integer	分页查询时设置的每页行数，最大值 100，默认为 20。	5
RequestId	string	唯一请求识别码。	853805EA-3D47-47D5-9A1A-A45C24313ABD
PageNumber	integer	当前页数，起始值为 1，默认为 1。	1
Previews	array<object>	容灾预案执行预览。
Preview	object
InstanceId	string	实例 ID。	gtm-cn-wwo3a3hbz**
SwitchInfos	array<object>	切换信息。
SwitchInfo	object
StrategyName	string	策略名称。	hrb5ju
Content	string	格式化的消息内容。	默认地址池（默认地址池1）切换备用地址池（备用地址池1）
Name	string	实例名称。	name-example
UserDomainName	string	用户域名（列表）。	30.yyy.com
TotalPages	integer	总页数。	3
TotalItems	integer	总个数。	15

示例

正常返回示例

JSON格式

{
  "PageSize": 5,
  "RequestId": "853805EA-3D47-47D5-9A1A-A45C24313ABD",
  "PageNumber": 1,
  "Previews": {
    "Preview": [
      {
        "InstanceId": "gtm-cn-wwo3a3hbz**",
        "SwitchInfos": {
          "SwitchInfo": [
            {
              "StrategyName": "hrb5ju",
              "Content": "默认地址池（默认地址池1）切换备用地址池（备用地址池1）"
            }
          ]
        },
        "Name": "name-example",
        "UserDomainName": "30.yyy.com"
      }
    ]
  },
  "TotalPages": 3,
  "TotalItems": 15
}

错误码

访问错误中心查看更多错误码。