DescribeBackupGatewayList - Data Management - Alibaba Cloud Documentation Center

This operation queries a list of DBS backup gateways.

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

dbs:DescribeBackupGatewayList

get

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
Region	string	Yes	The DBS region. Valid values: cn-hangzhou: China (Hangzhou) cn-shanghai: China (Shanghai) cn-qingdao: China (Qingdao) cn-beijing: China (Beijing) cn-shenzhen: China (Shenzhen) cn-hongkong: China (Hong Kong) ap-southeast-1: Singapore cn-hangzhou-finance: China (Hangzhou) Finance cn-shanghai-finance: China (Shanghai) Finance cn-shenzhen-finance: China (Shenzhen) Finance	cn-hangzhou
Identifier	string	No	The unique identifier of the backup gateway. To query multiple gateways, separate the identifiers with commas (,).	7213527653217
PageSize	integer	No	The number of records on each page. Valid values: 30 50 100 Note The default value is 30.	30
PageNum	integer	No	The page number. The value must be greater than or equal to 0 and cannot exceed the maximum value of an integer. The default value is 0.	1
ClientToken	string	No	A client token used to ensure the idempotence of the request.	ETnLKlblzczshOTUbOCzxxxxxxx

Response elements

Element	Type	Description	Example
	object
HttpStatusCode	integer	The HTTP status code.	200
PageNum	integer	The page number.	1
RequestId	string	The request ID.	46361705-8531-492F-807E-A97E482DD4A1
ErrCode	string	The error code.	Param.NotFound
Success	boolean	Indicates whether the request was successful.	true
ErrMessage	string	The error message.	The specified parameter %s value is not valid.
TotalPages	integer	The total number of pages.	1
TotalElements	integer	The total number of backup gateways.	0
PageSize	integer	The number of records on each page.	30
Items	object
BackupGateway	array<object>	The details of the backup gateway.
	object
DisplayName	string	The display name of the backup gateway.	test
BackupGatewayCreateTime	integer	The time when the backup gateway was created. The value is a UNIX timestamp. Unit: milliseconds.	1554560477000
BackupGatewayId	string	The ID of the backup gateway.	2321313123
Region	string	The region.	cn-hangzhou
Identifier	string	The unique identifier of the backup gateway.	sgdsajhdgu
SourceEndpointInternetIP	string	The public IP address of the host where the backup gateway is installed.	XX.XX.XX.XX
BackupGatewayStatus	string	The status of the backup gateway. Valid values: ONLINE: The gateway is online. OFFLINE: The gateway is offline. STOPPED: The gateway is stopped. UPGRADING: The gateway is being upgraded.	ONLINE
SourceEndpointIntranetIP	string	The private IP address of the host where the backup gateway is installed.	XX.XX.XX.XX
LastHeartbeatTime	integer	The time of the last heartbeat. The value is a UNIX timestamp. Unit: milliseconds.	1554560477000
SourceEndpointHostname	string	The hostname of the host where the backup gateway is installed.	test

Examples

Success response

JSON format

{
  "HttpStatusCode": 200,
  "PageNum": 1,
  "RequestId": "46361705-8531-492F-807E-A97E482DD4A1",
  "ErrCode": "Param.NotFound",
  "Success": true,
  "ErrMessage": "The specified parameter %s value is not valid.  ",
  "TotalPages": 1,
  "TotalElements": 0,
  "PageSize": 30,
  "Items": {
    "BackupGateway": [
      {
        "DisplayName": "test",
        "BackupGatewayCreateTime": 1554560477000,
        "BackupGatewayId": "2321313123",
        "Region": "cn-hangzhou",
        "Identifier": "sgdsajhdgu",
        "SourceEndpointInternetIP": "XX.XX.XX.XX",
        "BackupGatewayStatus": "ONLINE",
        "SourceEndpointIntranetIP": "XX.XX.XX.XX",
        "LastHeartbeatTime": 1554560477000,
        "SourceEndpointHostname": "test"
      }
    ]
  }
}

Error codes

HTTP status code	Error code	Error message	Description
403	Request.Forbidden	Have no Permissions

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.