View the DBS backup gateway list.
Debugging
Request parameters
Parameter | Type | Required | Example | Description |
---|---|---|---|---|
Action | String | Required | DescribeBackupGatewayList |
The parameter specified by the system. Value: DescribeBackupGatewayList. |
Region | String | Required | cn-hangzhou |
The DBS region. Valid values:
|
Identifier | String | No | 7213527653217 |
The unique ID of the backup gateway. Separate multiple backup gateways with commas (,). |
PageSize | Integer | Optional | 30 |
The number of records on each page. Valid values:
Note Default value: 30.
|
PageNum | Integer | Optional | 1 |
The number of the page to return. Valid values: any non-zero positive Integer. Default value: 0. |
RegionId | String | No | cn-hangzhou |
The region ID, which you can call DescribeRegions query. |
ClientToken | String | No | ETnLKlblzczshOTUbOCzxxxxxxx |
The client token that is used to ensure the idempotence of the request. |
Response parameters
Parameter | Type | Example | Description |
---|---|---|---|
ErrCode | String | Param.NotFound |
The error code. |
ErrMessage | String | The specified parameter %s value is not valid. |
The error message. |
HttpStatusCode | Integer | 200 |
The HTTP status code. |
Items | Array of BackupGateway |
The details of the backup gateway. |
|
BackupGateway | |||
BackupGatewayCreateTime | Long | 1554560477000 |
The time when the backup gateway was created. Valid values: 1554560477000. |
BackupGatewayId | String | 2321313123 |
The ID of the backup gateway. |
BackupGatewayStatus | String | ONLINE |
The status of the backup gateway. Valid values:
|
DisplayName | String | test |
The name of the backup gateway. |
Identifier | String | sgdsajhdgu |
The unique ID of the backup gateway. |
LastHeartbeatTime | Long | 1554560477000 |
The last heartbeat report time. Valid value: 1554560477000. |
Region | String | cn-hangzhou |
The ID of the region where the ingest domain resides. |
SourceEndpointHostname | String | test |
Install the hostname for the backup gateway. |
SourceEndpointInternetIP | String | XX.XX.XX.XX |
The public IP address of the backup gateway user. |
SourceEndpointIntranetIP | String | XX.XX.XX.XX |
The private IP address of the host on which the backup gateway is installed. |
PageNum | Integer | 1 |
The page number of the page to be returned. |
PageSize | Integer | 30 |
The number of records per page. |
RequestId | String | 46361705-8531-492F-807E-A97E482DD4A1 |
The ID of the request. |
Success | Boolean | true |
Indicates whether the request succeeded. |
TotalElements | Integer | 0 |
The total number of backup gateways. |
TotalPages | Integer | 1 |
The total number of returned pages. |
Examples
Sample requests
http(s)://dbs-api.cn-hangzhou.aliyuncs.com/? Action=DescribeBackupGatewayList
&Region=cn-hangzhou
&<Common request parameters>
Sample success responses
XML
format
<PageSize>30</PageSize>
<RequestId>46361705-8531-492F-807E-A97E482DD4A1</RequestId>
<PageNum>0</PageNum>
<HttpStatusCode>200</HttpStatusCode>
<TotalElements>0</TotalElements>
<Items/>
<TotalPages>0</TotalPages>
<Success>true</Success>
JSON
format
{
"PageSize": 30,
"RequestId": "46361705-8531-492F-807E-A97E482DD4A1",
"PageNum": 0,
"HttpStatusCode": 200,
"TotalElements": 0,
"Items": "",
"TotalPages": 0,
"Success": true
}
Error codes
For a list of error codes, visit the API Error Center.