DescribeServers

Updated at:

Queries protected servers.

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

hdr:DescribeServers

list

*All Resource

*

None None

Request parameters

Parameter

Type

Required

Description

Example

SitePairId

string

No

The site pair ID.

s-0007rvzart0u501t4e5r

ServerIds

string

No

The IDs of the protected servers.

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

PageNumber

integer

No

The page number.

1

PageSize

integer

No

The number of entries per page.

10

Response elements

Element

Type

Description

Example

object

RequestId

string

The request ID.

D2B255D3-9736-5169-B488-C735A8BBCD79

Success

boolean

Indicates whether the request is successful.

True

Code

string

The status code.

200

Message

string

The returned message.

successful

PageSize

integer

The number of entries per page in a paging query.

10

PageNumber

integer

The page number.

2

TotalCount

integer

The total number of entries.

10

Servers

object

server

array<object>

The protected server information.

object

The protected server information.

RecoveredInstanceName

string

The name of the failover instance.

recovered_server

PrimarySiteId

string

The ID of the primary site.

si-000cm9ax8sgplgye2vc4

ServerId

string

The ID of the protected server.

sr-000cm9ax8sh2381wa7kv

RecoveryUseDhcp

boolean

Specifies whether the failover instance uses DHCP to allocate an IP address.

true

RecoveryMemory

integer

The memory size of the failover instance.

8589934592

SourceGatewayVersion

string

The gateway version of the primary site.

3.7.3

IncrementalSyncStartTime

integer

The start time of incremental replication.

1646049677

CrashConsistentPointPolicy

string

The recovery point policy.

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

RecoveryPostScriptContent

string

The content of the script executed after the instance is started during disaster recovery drills or switches.

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

TestRecoveredInstanceId

string

The instance ID for disaster recovery drills.

i-bp13zgzv13am2n2z92lb

ReplicationNetwork

string

The ID of the vSwitch where the replication server is located.

vsw-2zey7xe0m8dbqrks2jb9h

RecoveryUseEssd

boolean

Specifies whether the instance used for disaster recovery drills or switches uses ESSDs.

false

TargetGatewayVersion

string

The gateway version of the destination.

3.7.3

OsType

string

The operating system type.

linux

FullSyncStartTime

integer

The start time of full replication.

0

ReplicationUseSsd

boolean

Specifies whether the replication server uses SSDs.

true

Rpo

integer

The recovery point objective (RPO), in seconds.

30

Consistent

boolean

Indicates whether the server is in a consistent state.

true

FullSyncTotalSize

integer

The total size of full replication, in bytes.

150202220544

RecoveredIpAddress

string

The IP address of the failover instance.

192.168.2.2

Alias

string

The alias.

test-ecs

Status

string

The status.

replicating

TestFailoverStatus

string

The status of disaster recovery drills.

testFailovered

ReplicationUseEssd

boolean

Specifies whether the replication server uses ESSDs.

false

OsDetail

string

The operating system details.

CentOS;7.9.2009

TestRecoveredIpAddress

string

The IP address of the machine used for disaster recovery drills.

192.168.2.2

SecondarySiteId

string

The ID of the secondary site.

si-0007o5em8n6mhm8hee1l

FullSyncProgress

integer

The progress percentage of full replication.

0

RecoveryInstanceType

string

The instance type of the failover instance.

ecs.r6.3xlarge

IpAddress

string

The internal IP address.

30.42.105.6

RecoveryInstanceName

string

The name of the failover instance.

HDR_Recovery-sr-000c2rz7q8tak59pt6sw

OriginalInstanceId

string

The source instance ID.

i-bp19axn91irnsi9204xg

InstanceId

string

The ECS instance ID.

i-bp19axn91irnsi9204xg

RecoveredInstanceId

string

The instance ID for the disaster recovery switch.

i-bp19axn91irnsi9204xg

RecoveryReserveIp

boolean

Indicates whether the failover instance retains the source IP address.

true

Memory

integer

The memory size.

4294967295

RecoveryIpAddress

string

The manually configured IP address for failover.

192.168.2.2

RecoveryNetwork

string

The ID of the vSwitch where the replication server is located.

vsw-uf63qu8ocjcly44tai570

Errno

string

The error cause.

cdr.console.plugin.alicloud.agent_deploy_already_installed

ReplicationUseOriginalInstance

boolean

Specifies whether the replication server uses the source instance. This parameter is valid only for reverse replication.

false

Hostname

string

The hostname.

test

RecoveryCpu

integer

The number of CPU cores of the failover instance.

4

AgentPort

integer

The client agent port.

9080

ReplicationUseDhcp

boolean

Specifies whether the replication server uses DHCP to allocate an IP address.

false

TestRecoveredInstanceName

string

The instance name 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.

1603469836288

ReplicationInfrastructureType

string

The type of infrastructure used for replication.

aliyun

Cpu

integer

The number of CPU cores.

4

RecoveryPostScriptType

string

The type of the script executed after the failover instance is started.

SHELL

ReplicationInfrastructureId

string

The ID of the infrastructure used for replication.

is-0004ka624vrxd9xsvs4f

ConnectionStatus

string

The connection status.

connected

Operations

string

The list of supported and disabled operations for the instance.

"{\"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 ID of the running task.

t-0007rvzart0v31c0x93q

RecoveryUseSsd

boolean

Specifies whether the failover instance uses SSDs.

true

Disks

string

The list of disks.

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

RecoveryEssdPerformanceLevel

string

The performance level (PL) selected when ESSDs are used for disaster recovery drills or failovers.

PL3

LatestRecoveryPointTime

integer

The time when the latest recovery point was created.

1661419052

Examples

Success response

JSON format

{
  "RequestId": "D2B255D3-9736-5169-B488-C735A8BBCD79",
  "Success": true,
  "Code": "200",
  "Message": "successful",
  "PageSize": 10,
  "PageNumber": 2,
  "TotalCount": 10,
  "Servers": {
    "server": [
      {
        "RecoveredInstanceName": "recovered_server",
        "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
      }
    ]
  }
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.