DescribeInfrastructures

Updated at:

Queries the site infrastructure information. Hybrid Disaster Recovery supports IDC-to-cloud disaster recovery, cross-region disaster recovery, and cross-zone disaster recovery. The infrastructure used by sites varies across scenarios. For example, the source site for IDC-to-cloud disaster recovery may use physical servers or vCenter as the infrastructure, whereas cross-region and cross-zone disaster recovery primarily use Alibaba Cloud as the infrastructure.

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:DescribeInfrastructures

list

*All Resource

*

None None

Request parameters

Parameter

Type

Required

Description

Example

SiteId

string

No

The site ID.

si-0005btelnqjwguycypba

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.

32AC7E7F-5484-548D-8D3F-905238B75080

Success

boolean

Indicates whether the request is successful.

True

Code

string

The status code.

200

Message

string

The error message.

successful

PageSize

integer

The number of entries per page.

10

PageNumber

integer

The page number.

2

TotalCount

integer

The total number of entries.

1

Infrastructures

object

infrastructure

array<object>

The list of infrastructure information.

object

The infrastructure information.

Type

string

The infrastructure type.

aliyun

Status

string

The status.

connected

IpAddress

string

The IP address.

172.18.122.66

InfrastructureId

string

The infrastructure ID.

is-0005qxusucbig0c42dlo

Errno

string

The cause of the abnormal status.

cdr.console.plugin.failed_to_connect

Name

string

The infrastructure name.

si-0006w0mxd3w8jiifu77l-infrastructure1

Examples

Success response

JSON format

{
  "RequestId": "32AC7E7F-5484-548D-8D3F-905238B75080",
  "Success": true,
  "Code": "200",
  "Message": "successful",
  "PageSize": 10,
  "PageNumber": 2,
  "TotalCount": 1,
  "Infrastructures": {
    "infrastructure": [
      {
        "Type": "aliyun",
        "Status": "connected",
        "IpAddress": "172.18.122.66",
        "InfrastructureId": "is-0005qxusucbig0c42dlo",
        "Errno": "cdr.console.plugin.failed_to_connect",
        "Name": "si-0006w0mxd3w8jiifu77l-infrastructure1"
      }
    ]
  }
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.