DescribeServer
Queries protected servers.
Try it now
Test
RAM authorization
|
Action |
Access level |
Resource type |
Condition key |
Dependent action |
|
hdr:DescribeServer |
get |
*All Resource
|
None | None |
Request parameters
|
Parameter |
Type |
Required |
Description |
Example |
| ServerId |
string |
No |
The ID of the protected server. |
sr-0005qxusucbiga738e9s |
Response elements
|
Element |
Type |
Description |
Example |
|
object |
|||
| PrimarySiteId |
string |
The ID of the primary site. |
si-0001jntih0phb0i2w1ya |
| ServerId |
string |
The ID of the protected server. |
sr-0005qxusucbiip0g6t93 |
| RecoveryUseDhcp |
boolean |
Specifies whether DHCP is used to automatically assign an IP address during recovery. |
false |
| RequestId |
string |
The ID of the request. |
BBCC4082-98DF-5804-96C6-0E74C37C5867 |
| RecoveryMemory |
integer |
The memory size of the instance used for failover. |
4294967296 |
| SourceGatewayVersion |
string |
The gateway version of the primary site. |
3.7.3 |
| IncrementalSyncStartTime |
integer |
The start time of incremental replication. |
0 |
| CrashConsistentPointPolicy |
string |
The recovery point policy. |
{\"scheduleType\":\"CRON\",\"expression\":\"0 0 */1 * * 0,1,2,3,4,5,6\",\"initialDelay\":0} |
| Success |
boolean |
Indicates whether the request is successful. |
True |
| RecoveryPostScriptContent |
string |
The content of the script executed after the failover instance is started. |
echo \"127.0.0.1 kubernetes.docker.internal\" >> /etc/hosts |
| TestRecoveredInstanceId |
string |
The ID of the instance used for disaster recovery drills. |
i-bp13zgzv13am2n2z92lb |
| ReplicationNetwork |
string |
The vSwitch ID of the replication network. |
vsw-bp1g0s2u3b2kbn46kiy53 |
| RecoveryUseEssd |
boolean |
Specifies whether ESSDs are used as the cloud disk type for the failover instance. |
false |
| TargetGatewayVersion |
string |
The gateway version of the destination. |
i-bp13zgzv13am2n2z92lb |
| OsType |
string |
The operating system type. |
linux |
| FullSyncStartTime |
integer |
The start time of full replication. |
0 |
| ReplicationUseSsd |
boolean |
Specifies whether standard SSDs are used for the shadow instance. |
false |
| Rpo |
integer |
The recovery point objective, in seconds. |
45 |
| Consistent |
boolean |
Indicates whether the instance is in a consistent state. |
false |
| FullSyncTotalSize |
integer |
The total size of full replication, in bytes. |
365072220160 |
| RecoveredIpAddress |
string |
The IP address of the failover instance. |
192.168.2.2 |
| Alias |
string |
The alias. |
bsdewmpci_rz |
| Status |
string |
The instance status. |
replicating |
| TestFailoverStatus |
string |
The status of disaster recovery drills. |
testFailovered |
| ReplicationUseEssd |
boolean |
Specifies whether ESSDs are used for the shadow instance. |
false |
| OsDetail |
string |
The operating system details. |
CentOS;7.9.2009 |
| Message |
string |
The returned message. |
successful |
| TestRecoveredIpAddress |
string |
The IP address of the instance used for disaster recovery drills. |
192.168.2.2 |
| SecondarySiteId |
string |
The ID of the secondary site. |
si-000imvpcegvbh6i5kd2u |
| FullSyncProgress |
integer |
The progress percentage of full replication. |
17 |
| RecoveryInstanceType |
string |
The instance type used for failover. |
ecs.c5.2xlarge |
| IpAddress |
string |
The IP address of the protected server. |
30.42.105.6 |
| RecoveryInstanceName |
string |
The name of the instance used for failover. |
HDR_Recovery-sr-000bzkmmlwghq3soqry2 |
| OriginalInstanceId |
string |
The source instance ID. |
i-bp19axn91irnsi9204xg |
| RecoveredInstanceId |
string |
The ID of the failover instance. |
i-bp19axn91irnsi9204xg |
| RecoveryReserveIp |
boolean |
Specifies whether the drill instance retains the IP address of the source server. The vSwitch where the drill is performed must contain the corresponding CIDR block. |
false |
| Code |
string |
The status code. |
200 |
| Memory |
integer |
The memory size. |
8589934591 |
| RecoveryIpAddress |
string |
The manually configured IP address of the failover instance. |
192.168.2.2 |
| RecoveryNetwork |
string |
The vSwitch ID of the failover instance. |
vsw-uf61v3bg6r790ir22jqv4 |
| Errno |
string |
The error cause. |
cdr.console.plugin.failed_to_connect |
| ReplicationUseOriginalInstance |
boolean |
Specifies whether the source server is used for reverse replication. |
false |
| Hostname |
string |
The hostname. |
iZ2ze0jazgwtuxettbk1ywZ |
| RecoveryCpu |
integer |
The number of CPU cores of the failover instance. |
4 |
| AgentPort |
integer |
The client agent port. |
9080 |
| ReplicationUseDhcp |
boolean |
Specifies whether DHCP is used for replication. |
false |
| TestRecoveredInstanceName |
string |
The name of the instance used for disaster recovery drills. |
HDR_Recovery-sr-000c2rz7q8tak59pt6sw |
| AgentVersion |
string |
The client version. |
3.7.3 |
| FullSyncCurrentSize |
integer |
The completed size of full replication, in bytes. |
3285276688384 |
| ReplicationInfrastructureType |
string |
The infrastructure type used for replication. |
aliyun |
| Cpu |
integer |
The number of CPU cores. |
4 |
| RecoveryPostScriptType |
string |
The type of the script executed after the drill instance is started. Valid value: SHELL. |
SHELL |
| ReplicationInfrastructureId |
string |
The infrastructure ID of the destination site. |
is-000bzkmmlwgibbduuoff |
| ConnectionStatus |
string |
The connection status. |
connected |
| Operations |
string |
The supported 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 |
string |
The task ID. |
t-0004ka624vrza82g46ne |
| RecoveryUseSsd |
boolean |
Specifies whether standard SSDs are used as the cloud disk type for the failover instance. |
false |
| Disks |
string |
The disk list. |
[{\"id\":\"0\",\"boot\":true,\"size\":500363689984}] |
| RecoveryEssdPerformanceLevel |
string |
The performance level of the ESSD used by the drill or failover instance. |
PL1 |
| LatestRecoveryPointTime |
string |
The time when the latest recovery point was created. |
1661419052 |
Examples
Success response
JSON format
{
"PrimarySiteId": "si-0001jntih0phb0i2w1ya",
"ServerId": "sr-0005qxusucbiip0g6t93",
"RecoveryUseDhcp": false,
"RequestId": "BBCC4082-98DF-5804-96C6-0E74C37C5867",
"RecoveryMemory": 4294967296,
"SourceGatewayVersion": "3.7.3",
"IncrementalSyncStartTime": 0,
"CrashConsistentPointPolicy": "{\\\"scheduleType\\\":\\\"CRON\\\",\\\"expression\\\":\\\"0 0 */1 * * 0,1,2,3,4,5,6\\\",\\\"initialDelay\\\":0}",
"Success": true,
"RecoveryPostScriptContent": "echo \\\"127.0.0.1 kubernetes.docker.internal\\\" >> /etc/hosts",
"TestRecoveredInstanceId": "i-bp13zgzv13am2n2z92lb",
"ReplicationNetwork": "vsw-bp1g0s2u3b2kbn46kiy53",
"RecoveryUseEssd": false,
"TargetGatewayVersion": "i-bp13zgzv13am2n2z92lb",
"OsType": "linux",
"FullSyncStartTime": 0,
"ReplicationUseSsd": false,
"Rpo": 45,
"Consistent": false,
"FullSyncTotalSize": 365072220160,
"RecoveredIpAddress": "192.168.2.2",
"Alias": "bsdewmpci_rz",
"Status": "replicating",
"TestFailoverStatus": "testFailovered",
"ReplicationUseEssd": false,
"OsDetail": "CentOS;7.9.2009",
"Message": "successful",
"TestRecoveredIpAddress": "192.168.2.2",
"SecondarySiteId": "si-000imvpcegvbh6i5kd2u",
"FullSyncProgress": 17,
"RecoveryInstanceType": "ecs.c5.2xlarge",
"IpAddress": "30.42.105.6",
"RecoveryInstanceName": "HDR_Recovery-sr-000bzkmmlwghq3soqry2",
"OriginalInstanceId": "i-bp19axn91irnsi9204xg",
"RecoveredInstanceId": "i-bp19axn91irnsi9204xg",
"RecoveryReserveIp": false,
"Code": "200",
"Memory": 8589934591,
"RecoveryIpAddress": "192.168.2.2",
"RecoveryNetwork": "vsw-uf61v3bg6r790ir22jqv4",
"Errno": "cdr.console.plugin.failed_to_connect",
"ReplicationUseOriginalInstance": false,
"Hostname": "iZ2ze0jazgwtuxettbk1ywZ",
"RecoveryCpu": 4,
"AgentPort": 9080,
"ReplicationUseDhcp": false,
"TestRecoveredInstanceName": "HDR_Recovery-sr-000c2rz7q8tak59pt6sw",
"AgentVersion": "3.7.3",
"FullSyncCurrentSize": 3285276688384,
"ReplicationInfrastructureType": "aliyun",
"Cpu": 4,
"RecoveryPostScriptType": "SHELL",
"ReplicationInfrastructureId": "is-000bzkmmlwgibbduuoff",
"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-0004ka624vrza82g46ne",
"RecoveryUseSsd": false,
"Disks": "[{\\\"id\\\":\\\"0\\\",\\\"boot\\\":true,\\\"size\\\":500363689984}]",
"RecoveryEssdPerformanceLevel": "PL1",
"LatestRecoveryPointTime": "1661419052"
}
Error codes
See Error Codes for a complete list.
Release notes
See Release Notes for a complete list.