すべてのプロダクト
Search

このプロダクト

    :DescribeBackupGatewayList

    ドキュメントセンター

    :DescribeBackupGatewayList

    最終更新日:Dec 01, 2025

    この操作は、DBS バックアップゲートウェイのリストを照会します。

    今すぐお試しください

    この API を OpenAPI Explorer でお試しください。手作業による署名は必要ありません。呼び出しに成功すると、入力したパラメーターに基づき、資格情報が組み込まれた SDK コードが自動的に生成されます。このコードをダウンロードしてローカルで使用できます。

    テスト

    RAM 認証

    下表に、この API を呼び出すために必要な認証情報を示します。認証情報は、RAM (Resource Access Management) ポリシーを使用して定義できます。以下で各列名について説明します。

    • アクション：特定のリソースに対して実行可能な操作。ポリシー構文ではAction要素として指定します。

    • API：アクションを具体的に実行するための API。

    • アクセスレベル：各 API に対して事前定義されているアクセスの種類。有効な値：create、list、get、update、delete。

    • リソースタイプ：アクションが作用するリソースの種類。リソースレベルでの権限をサポートするかどうかを示すことができます。ポリシーの有効性を確保するため、アクションの対象として適切なリソースを指定してください。

      • リソースレベルの権限を持つ API の場合、必要なリソースタイプはアスタリスク (*) でマークされます。ポリシーのResource要素で対応する ARN を指定してください。

      • リソースレベルの権限を持たない API の場合、「すべてのリソース」と表示され、ポリシーのResource要素でアスタリスク (*) でマークされます。

    • 条件キー：サービスによって定義された条件のキー。このキーにより、きめ細やかなアクセス制御が可能になります。この制御は、アクション単体に適用することも、特定のリソースに対するアクションに適用することもできます。Alibaba Cloud は、サービス固有の条件キーに加えて、すべての RAM 統合サービスに適用可能な一連の共通条件キーを提供しています。

    • 依存アクション：ある特定のアクションを実行するために、前提として実行が必要となる他のアクション。依存アクションの権限も RAM ユーザーまたは RAM ロールに付与する必要があります。

    アクション

    アクセスレベル

    リソースタイプ

    条件キー

    依存アクション

    dbs:DescribeBackupGatewayList

    get

    *All Resource

    *

    		 なし なし

    リクエストパラメーター

    パラメーター

    型

    必須 / 任意

    説明

    例
    Region

    string

    必須

    DBS のリージョン。有効な値：

    • cn-hangzhou：中国 (杭州)

    • cn-shanghai：中国 (上海)

    • cn-qingdao：中国 (青島)

    • cn-beijing：中国 (北京)

    • cn-shenzhen：中国 (深セン)

    • cn-hongkong：中国 (香港)

    • ap-southeast-1：シンガポール

    • cn-hangzhou-finance：中国 (杭州) 金融

    • cn-shanghai-finance：中国 (上海) 金融

    • cn-shenzhen-finance：中国 (深セン) 金融

    cn-hangzhou
    Identifier

    string

    任意

    バックアップゲートウェイの一意の識別子。複数のゲートウェイを照会するには、識別子をコンマ (,) で区切ります。

    7213527653217
    PageSize

    integer

    任意

    各ページのレコード数。有効な値：

    • 30

    • 50

    • 100

    説明

    デフォルト値は 30 です。

    30
    PageNum

    integer

    任意

    ページ番号。値は 0 以上で、整数の最大値を超えることはできません。デフォルト値は 0 です。

    1
    ClientToken

    string

    任意

    リクエストのべき等性を保証するために使用されるクライアントトークン。

    ETnLKlblzczshOTUbOCzxxxxxxx

    レスポンスフィールド

    フィールド

    型

    説明

    例

    object

    HttpStatusCode

    integer

    HTTP ステータスコード。

    200
    PageNum

    integer

    ページ番号。

    1
    RequestId

    string

    リクエスト ID。

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

    string

    エラーコード。

    Param.NotFound
    Success

    boolean

    リクエストが成功したかどうかを示します。

    true
    ErrMessage

    string

    エラーメッセージ。

    The specified parameter %s value is not valid.

    TotalPages

    integer

    総ページ数。

    1
    TotalElements

    integer

    バックアップゲートウェイの総数。

    0
    PageSize

    integer

    各ページのレコード数。

    30
    Items

    object

    BackupGateway

    array<object>

    バックアップゲートウェイの詳細。

    object

    DisplayName

    string

    バックアップゲートウェイの表示名。

    test
    BackupGatewayCreateTime

    integer

    バックアップゲートウェイが作成された時刻。値は UNIX タイムスタンプです。単位：ミリ秒。

    1554560477000
    BackupGatewayId

    string

    バックアップゲートウェイの ID。

    2321313123
    Region

    string

    リージョン。

    cn-hangzhou
    Identifier

    string

    バックアップゲートウェイの一意の識別子。

    sgdsajhdgu
    SourceEndpointInternetIP

    string

    バックアップゲートウェイがインストールされているホストのパブリック IP アドレス。

    XX.XX.XX.XX
    BackupGatewayStatus

    string

    バックアップゲートウェイのステータス。有効な値：

    • ONLINE：ゲートウェイはオンラインです。

    • OFFLINE：ゲートウェイはオフラインです。

    • STOPPED：ゲートウェイは停止しています。

    • UPGRADING：ゲートウェイはアップグレード中です。

    ONLINE
    SourceEndpointIntranetIP

    string

    バックアップゲートウェイがインストールされているホストのプライベート IP アドレス。

    XX.XX.XX.XX
    LastHeartbeatTime

    integer

    最後のハートビートの時刻。値は UNIX タイムスタンプです。単位：ミリ秒。

    1554560477000
    SourceEndpointHostname

    string

    バックアップゲートウェイがインストールされているホストのホスト名。

    test

    例

    成功レスポンス

    JSONJSON

    {
  "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 ステータスコード

    エラーコード

    エラーメッセージ

    説明
    403 Request.Forbidden Have no Permissions

    完全なリストについては、「エラーコード」をご参照ください。

    変更履歴

    完全なリストについては、「変更履歴」をご参照ください。