全部产品
Search

搜索本产品

    数据库备份 DBS：DescribeBackupGatewayList - 查看备份网关列表

    文档中心

    数据库备份 DBS：DescribeBackupGatewayList - 查看备份网关列表

    更新时间：Nov 14, 2024

    该接口用于查看DBS备份网关列表。

    调试

    您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。

    授权信息

    下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：

    • 操作：是指具体的权限点。
    • 访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
    • 资源类型：是指操作中支持授权的资源类型。具体说明如下：
      • 对于必选的资源类型，用背景高亮的方式表示。
      • 对于不支持资源级授权的操作，用全部资源表示。
    • 条件关键字：是指云产品自身定义的条件关键字。
    • 关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。
    操作访问级别资源类型条件关键字关联操作
    dbs:DescribeBackupGatewayListget
    • 全部资源
      *
      无
    		无

    请求参数

    名称类型必填描述示例值
    Regionstring是

    DBS 地域，取值：

    • cn-hangzhou：公有云杭州
    • cn-shanghai：公有云上海
    • cn-qingdao：公有云青岛
    • cn-beijing：公有云北京
    • cn-shenzhen：公有云深圳
    • cn-hongkong：公有云中国香港
    • ap-southeat-1：公有云新加坡
    • cn-hangzhou-finance：金融云杭州
    • cn-shanghai-finance：金融云上海
    • cn-shenzhen-finance：金融云深圳
    		cn-hangzhou
    Identifierstring否

    备份网关唯一标识，支持多个查询，用英文逗号（,）分隔。

    		7213527653217
    PageSizeinteger否

    每页的记录数，取值：

    • 30
    • 50
    • 100
    说明 默认为 30。
    		30
    PageNuminteger否

    页码，大于等于 0 且不超过 Integer 的最大值，默认值为：0。

    		1
    ClientTokenstring否

    用于保证请求的幂等性，防止重复提交请求。

    		ETnLKlblzczshOTUbOCzxxxxxxx

    返回参数

    名称类型描述示例值
    object
    HttpStatusCodeinteger

    HTTP 状态码。

    		200
    PageNuminteger

    页码。

    		1
    RequestIdstring

    请求 ID。

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

    错误码。

    		Param.NotFound
    Successboolean

    是否成功。

    		true
    ErrMessagestring

    错误信息。

    		The specified parameter %s value is not valid.
    TotalPagesinteger

    总页数。

    		1
    TotalElementsinteger

    总备份网关数。

    		0
    PageSizeinteger

    每页的记录数。

    		30
    Itemsarray<object>

    备份网关详情。

    BackupGatewayobject
    DisplayNamestring

    备份网关显示名称。

    		test
    BackupGatewayCreateTimelong

    备份网关创建时间，取值 1554560477000。

    		1554560477000
    BackupGatewayIdstring

    备份网关 ID。

    		2321313123
    Regionstring

    地域。

    		cn-hangzhou
    Identifierstring

    备份网关唯一标识。

    		sgdsajhdgu
    SourceEndpointInternetIPstring

    安装备份网关的主机公网 IP。

    		XX.XX.XX.XX
    BackupGatewayStatusstring

    备份网关状态，取值：

    • ONLINE：在线
    • OFFLINE：离线
    • STOPPED：停止
    • UPGRADING：升级中
    		ONLINE
    SourceEndpointIntranetIPstring

    安装备份网关的主机私网 IP。

    		XX.XX.XX.XX
    LastHeartbeatTimelong

    上次心跳汇报时间，取值：1554560477000。

    		1554560477000
    SourceEndpointHostnamestring

    安装备份网关的主机名称。

    		test

    示例

    正常返回示例

    JSON格式

    {
  "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"
      }
    ]
  }
}

    错误码

    HTTP status code错误码错误信息描述
    403Request.ForbiddenHave no Permissions当前操作未被授权，请联系主账号在RAM控制台进行授权后再执行操作

    访问错误中心查看更多错误码。

    变更历史

    变更时间变更内容概要操作
    暂无变更历史