All Products
Search
Document Center

Database Backup:DescribeBackupGatewayList

Last Updated:Nov 09, 2022

Queries backup gateways.

Authorization information

The following table is the authorization information corresponding to the API, which can be found in the RAM permission policy statement.Action Used in the element to grant the RAM user or RAM role permission to call this API. The specific instructions are as follows:

  • Operation: the value that you can use in the Action element to specify the operation on a resource.
  • Access level: the access level of each operation. The levels are read, write, and list.
  • Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
    • The required resource types are displayed in bold characters.
    • If the permissions cannot be granted at the resource level, All resources is used in the Resource type column of the operation.
  • Condition keyword: refers to the condition keyword defined by the cloud product itself.
  • Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
Operateaccess levelResource typeconditional keywordAssociation operation
dbs:DescribeBackupGatewayListRead
    All resources
    without
without

Request parameters

ParameterTypeRequiredDescriptionExample
RegionstringYes

The region in which Database Backup (DBS) is activated. 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-southeat-1: Singapore (Singapore)
  • cn-hangzhou-finance: China East 1 Finance
  • cn-shanghai-finance: China East 2 Finance
  • cn-shenzhen-finance: China South 1 Finance
cn-hangzhou
IdentifierstringNo

The unique identifier of the backup gateway. You can query multiple backup gateways. Separate multiple identifiers with commas (,).

7213527653217
PageSizeintegerNo

The number of entries to return on each page. Valid values:

  • 30
  • 50
  • 100
NoteDefault value: 30.
30
PageNumintegerNo

The number of the page to return. The value must be a positive integer. Default value: 0.

1
ClientTokenstringNo

The client token that is used to ensure the idempotence of the request.

ETnLKlblzczshOTUbOCzxxxxxxx

Response parameters

ParameterTypeDescriptionExample
object
HttpStatusCodeinteger

The HTTP status code.

200
PageNuminteger

The page number of the returned page.

1
RequestIdstring

The ID of the request.

46361705-8531-492F-807E-A97E482DD4A1
ErrCodestring

The error code.

Param.NotFound
Successboolean

Indicates whether the request is successful.

true
ErrMessagestring

The error message.

The specified parameter %s value is not valid.
TotalPagesinteger

The total number of returned pages.

1
TotalElementsinteger

The total number of backup gateways.

0
PageSizeinteger

The number of entries returned on each page.

30
Itemsarray

The details of backup gateways.

object
DisplayNamestring

The display name of the backup gateway.

test
BackupGatewayCreateTimelong

The time when the backup gateway was created, such as 1554560477000.

1554560477000
BackupGatewayIdstring

The ID of the backup gateway.

2321313123
Regionstring

The ID of the region.

cn-hangzhou
Identifierstring

The unique identifier of the backup gateway.

sgdsajhdgu
SourceEndpointInternetIPstring

The public IP address of the host on which the backup gateway is installed.

XX.XX.XX.XX
BackupGatewayStatusstring

The status of the backup gateway. Valid values:

  • ONLINE: The backup gateway is online.
  • OFFLINE: The backup gateway is offline.
  • STOPPED: The backup gateway is stopped.
  • UPGRADING: The backup gateway is being upgraded.
ONLINE
SourceEndpointIntranetIPstring

The private IP address of the host on which the backup gateway is installed.

XX.XX.XX.XX
LastHeartbeatTimelong

The last time when a heartbeat message was sent, such as 1554560477000.

1554560477000
SourceEndpointHostnamestring

The name of the host on which the backup gateway is installed.

test

Example

Normal return example

JSONFormat

{
  "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": [
    {
      "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

For a list of error codes, visit the API error center.