All Products
Document Center


Last Updated: Mar 18, 2020


You can call this operation to query one or more DBS backup gateways.

Request parameters

Parameter Type Required Description
Action String Yes The operation that you want to perform. Set the value to DescribeBackupGatewayList.
Region String Yes The region of the DBS instance. Valid values:
  • cn-hangzhou: Alibaba Cloud of China (Hangzhou)
  • cn-shanghai: Alibaba Cloud of China (Shanghai)
  • cn-qingdao: Alibaba Cloud of China (Qingdao)
  • cn-beijing: Alibaba Cloud of China (Beijing)
  • cn-shenzhen: Alibaba Cloud of China (Shenzhen)
  • cn-hongkong: Alibaba Cloud of China (Hong Kong)
  • ap-southeat-1: Alibaba Cloud of Singapore
  • cn-hangzhou-finance: Finance Cloud of China (Hangzhou)
  • cn-shanghai-finance: Finance Cloud of China (Shanghai)
  • cn-shenzhen-finance: Finance Cloud of China (Shenzhen)
Identifier String No The unique ID of the backup gateway. Separate multiple IDs with commas (,).
PageSize Integer No The number of entries to return on each page. Valid values: 30, 50, and 100. Default value: 30.
PageNum Integer No The number of the page to return. It must be greater than or equal to 0 and smaller than or equal to the maximum value of the Integer type. Default value: 0.

Response parameters

Parameter Type Description
Items List The details of the backup gateway. For more information, see the description of the BackupGateway parameter.
TotalPages Integer The total number of pages returned.
PageSize Integer The number of entries returned per page.
PageNum Integer The number of the page returned.
TotalElements Long The total number of backup gateways returned.


Parameter Type Description
BackupGatewayId Long The ID of the backup gateway.
SourceEndpointInternetIP String The public IP address of the host where the backup gateway is installed.
SourceEndpointIntranetIP String The private IP address of the host where the backup gateway is installed.
SourceEndpointHostname String The name of the host where the backup gateway is installed.
BackupGatewayStatus String The status of the backup gateway. Valid values:
LastHeartbeatTime Long The last time when a heartbeat message was sent. Example: 1554560477000.
BackupGatewayCreateTime Long The time when the backup gateway was created. Example: 1554560477000.
Region String The region of the backup gateway.
DisplayName String The display name of the backup gateway.
Identifier String The unique ID of the backup gateway.

Error codes

Error code Error message Description
BackupGatewayNotDescribe Backup Gateway not Describe. The error message returned because the backup gateways cannot be queried.