DescribeServers - 查询受保护服务器

查询受保护服务器。

调试

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

授权信息

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

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

请求参数

名称类型必填描述示例值
SitePairIdstring

站点对 ID

s-0007rvzart0u501t4e5r
ServerIdsstring

受保护服务器 ID 列表

"[\"sr-0005qxusucbi38lqfc2q\",\"sr-0005qxusucbi38lqfc2r\"]"
PageNumberinteger

分页参数:当前页码。

1
PageSizeinteger

分页参数:每页显示条数。

10

返回参数

名称类型描述示例值
object
RequestIdstring

请求 id。

D2B255D3-9736-5169-B488-C735A8BBCD79
Successboolean

是否成功。

True
Codestring

状态码。

200
Messagestring

返回信息。

successful
PageSizeinteger

分页查询时每页的行数。

10
PageNumberinteger

页码。

2
TotalCountinteger

总条数。

10
Serversarray<object>

受保护服务器信息

serverobject

受保护服务器信息

RecoveredInstanceNamestring
-
PrimarySiteIdstring

主站站点 ID

si-000cm9ax8sgplgye2vc4
ServerIdstring

受保护服务器 ID

sr-000cm9ax8sh2381wa7kv
RecoveryUseDhcpboolean

容灾切换的实例是否使用 DHCP 分配 IP

true
RecoveryMemorylong

容灾切换的实例内存大小

8589934592
SourceGatewayVersionstring

主站网关版本

3.7.3
IncrementalSyncStartTimelong

增量复制开始时间

1646049677
CrashConsistentPointPolicystring

恢复点策略

"{\"scheduleType\":\"CRON\",\"expression\":\"0 0 */1 * * 0,1,2,3,4,5,6\",\"initialDelay\":0}"
RecoveryPostScriptContentstring

容灾演练、容灾切换等机器启动后执行的脚本内容

"echo \"127.0.0.1 kubernetes.docker.internal\" >> /etc/hosts"
TestRecoveredInstanceIdstring

容灾演练的实例 ID

i-bp13zgzv13am2n2z92lb
ReplicationNetworkstring

复影服务器所在的 VSwitch ID

vsw-2zey7xe0m8dbqrks2jb9h
RecoveryUseEssdboolean

容灾演练、容灾切换的实例是否使用 ESSD

false
TargetGatewayVersionstring

目的端网关版本

3.7.3
OsTypestring

操作系统类型

linux
FullSyncStartTimelong

全量复制开始时间

0
ReplicationUseSsdboolean

复影服务器是否使用 SSD

true
Rpointeger

恢复时间目标,单位秒

30
Consistentboolean

是否处于一致性状态

true
FullSyncTotalSizelong

全量复制大小,单位 B

150202220544
RecoveredIpAddressstring

容灾切换的实例 IP

192.168.2.2
Aliasstring

别名

test-ecs
Statusstring

状态

replicating
TestFailoverStatusstring

容灾演练状态

testFailovered
ReplicationUseEssdboolean

复影服务器是否使用 ESSD

false
OsDetailstring

操作系统详情

CentOS;7.9.2009
TestRecoveredIpAddressstring

容灾演练的机器 IP 地址

192.168.2.2
SecondarySiteIdstring

从站站点 ID

si-0007o5em8n6mhm8hee1l
FullSyncProgressinteger

全量复制进度百分比

0
RecoveryInstanceTypestring

容灾切换的实例规格

ecs.r6.3xlarge
IpAddressstring

内网 IP 地址

30.42.105.6
RecoveryInstanceNamestring

容灾切换的实例名称

HDR_Recovery-sr-000c2rz7q8tak59pt6sw
OriginalInstanceIdstring

源端实例 ID

i-bp19axn91irnsi9204xg
InstanceIdstring

ECS 实例 ID

i-bp19axn91irnsi9204xg
RecoveredInstanceIdstring

容灾切换的实例 ID

i-bp19axn91irnsi9204xg
RecoveryReserveIpboolean

容灾切换实例保留源端 IP

true
Memorylong

内存大小

4294967295
RecoveryIpAddressstring

容灾切换设置的手动 IP 地址

192.168.2.2
RecoveryNetworkstring

复影服务器所在的虚拟交换机 ID

vsw-uf63qu8ocjcly44tai570
Errnostring

出错原因

cdr.console.plugin.alicloud.agent_deploy_already_installed
ReplicationUseOriginalInstanceboolean

复影服务器使用源机,仅反向复制时有效

false
Hostnamestring

主机名称

test
RecoveryCpuinteger

容灾切换的实例 CPU 核数

4
AgentPortinteger

客户端代理端口

9080
ReplicationUseDhcpboolean

复影服务器使用 DHCP 分配 IP

false
TestRecoveredInstanceNamestring

容灾演练的实例名称

HDR_Recovery-sr-000c2rz7q8tak59pt6sw
AgentVersionstring

客户端版本

3.7.3
FullSyncCurrentSizelong

全量复制已完成大小,单位 B

1603469836288
ReplicationInfrastructureTypestring

复制使用的基础设施类型

aliyun
Cpuinteger

CPU 核数

4
RecoveryPostScriptTypestring

容灾切换的实例启动后执行的脚本类型

SHELL
ReplicationInfrastructureIdstring

复制使用的基础设施 ID

is-0004ka624vrxd9xsvs4f
ConnectionStatusstring

连接状态

connected
Operationsstring

该实例支持与禁用的操作列表

"{\"Resynchronize\":true,\"TestFailover\":true,\"TestCleanup\":true,\"ChangeRecoveryPoint\":true,\"UnregisterServer\":true,\"ReversedEnableReplication\":true,\"ReversedDisableReplication\":true,\"DisableReplication\":true,\"CommitFailover\":true,\"RestartServer\":true,\"UpgradeServer\":true,\"ForcedFailover\":true,\"RepairReplication\":true,\"EnableReplication\":true,\"TriggerReversedRegister\":true,\"SetupAgent\":true,\"TriggerRegister\":true,\"CollectSupportBundle\":true,\"Failback\":true}"
TaskIdstring

正在执行的任务 ID

t-0007rvzart0v31c0x93q
RecoveryUseSsdboolean

容灾切换的实例是否使用 SSD

true
Disksstring

磁盘信息列表

[{\"id\":\"0\",\"boot\":true,\"size\":500363689984}]
RecoveryEssdPerformanceLevelstring

演练、切换使用 ESSD 时选定的 PL 等级

PL3
LatestRecoveryPointTimelong

最近一次创建恢复点的时间

1661419052

示例

正常返回示例

JSON格式

{
  "RequestId": "D2B255D3-9736-5169-B488-C735A8BBCD79",
  "Success": true,
  "Code": "200",
  "Message": "successful",
  "PageSize": 10,
  "PageNumber": 2,
  "TotalCount": 10,
  "Servers": {
    "server": [
      {
        "RecoveredInstanceName": "-",
        "PrimarySiteId": "si-000cm9ax8sgplgye2vc4",
        "ServerId": "sr-000cm9ax8sh2381wa7kv",
        "RecoveryUseDhcp": true,
        "RecoveryMemory": 8589934592,
        "SourceGatewayVersion": "3.7.3",
        "IncrementalSyncStartTime": 1646049677,
        "CrashConsistentPointPolicy": "\"{\\\"scheduleType\\\":\\\"CRON\\\",\\\"expression\\\":\\\"0 0 */1 * * 0,1,2,3,4,5,6\\\",\\\"initialDelay\\\":0}\"",
        "RecoveryPostScriptContent": "\"echo \\\"127.0.0.1 kubernetes.docker.internal\\\" >> /etc/hosts\"",
        "TestRecoveredInstanceId": "i-bp13zgzv13am2n2z92lb",
        "ReplicationNetwork": "vsw-2zey7xe0m8dbqrks2jb9h",
        "RecoveryUseEssd": false,
        "TargetGatewayVersion": "3.7.3",
        "OsType": "linux",
        "FullSyncStartTime": 0,
        "ReplicationUseSsd": true,
        "Rpo": 30,
        "Consistent": true,
        "FullSyncTotalSize": 150202220544,
        "RecoveredIpAddress": "192.168.2.2",
        "Alias": "test-ecs",
        "Status": "replicating",
        "TestFailoverStatus": "testFailovered",
        "ReplicationUseEssd": false,
        "OsDetail": "CentOS;7.9.2009",
        "TestRecoveredIpAddress": "192.168.2.2",
        "SecondarySiteId": "si-0007o5em8n6mhm8hee1l",
        "FullSyncProgress": 0,
        "RecoveryInstanceType": "ecs.r6.3xlarge",
        "IpAddress": "30.42.105.6",
        "RecoveryInstanceName": "HDR_Recovery-sr-000c2rz7q8tak59pt6sw",
        "OriginalInstanceId": "i-bp19axn91irnsi9204xg",
        "InstanceId": "i-bp19axn91irnsi9204xg",
        "RecoveredInstanceId": "i-bp19axn91irnsi9204xg",
        "RecoveryReserveIp": true,
        "Memory": 4294967295,
        "RecoveryIpAddress": "192.168.2.2",
        "RecoveryNetwork": "vsw-uf63qu8ocjcly44tai570",
        "Errno": "cdr.console.plugin.alicloud.agent_deploy_already_installed",
        "ReplicationUseOriginalInstance": false,
        "Hostname": "test",
        "RecoveryCpu": 4,
        "AgentPort": 9080,
        "ReplicationUseDhcp": false,
        "TestRecoveredInstanceName": "HDR_Recovery-sr-000c2rz7q8tak59pt6sw",
        "AgentVersion": "3.7.3",
        "FullSyncCurrentSize": 1603469836288,
        "ReplicationInfrastructureType": "aliyun",
        "Cpu": 4,
        "RecoveryPostScriptType": "SHELL",
        "ReplicationInfrastructureId": "is-0004ka624vrxd9xsvs4f",
        "ConnectionStatus": "connected",
        "Operations": "\"{\\\"Resynchronize\\\":true,\\\"TestFailover\\\":true,\\\"TestCleanup\\\":true,\\\"ChangeRecoveryPoint\\\":true,\\\"UnregisterServer\\\":true,\\\"ReversedEnableReplication\\\":true,\\\"ReversedDisableReplication\\\":true,\\\"DisableReplication\\\":true,\\\"CommitFailover\\\":true,\\\"RestartServer\\\":true,\\\"UpgradeServer\\\":true,\\\"ForcedFailover\\\":true,\\\"RepairReplication\\\":true,\\\"EnableReplication\\\":true,\\\"TriggerReversedRegister\\\":true,\\\"SetupAgent\\\":true,\\\"TriggerRegister\\\":true,\\\"CollectSupportBundle\\\":true,\\\"Failback\\\":true}\"",
        "TaskId": "t-0007rvzart0v31c0x93q",
        "RecoveryUseSsd": true,
        "Disks": "[{\\\"id\\\":\\\"0\\\",\\\"boot\\\":true,\\\"size\\\":500363689984}]",
        "RecoveryEssdPerformanceLevel": "PL3",
        "LatestRecoveryPointTime": 1661419052
      }
    ]
  }
}

错误码

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

变更历史

变更时间变更内容概要操作
2024-01-09API 内部配置变更,不影响调用查看变更详情