すべてのプロダクト
Search

このプロダクト

    :DescribeBackupStorage

    ドキュメントセンター

    :DescribeBackupStorage

    最終更新日:Jan 26, 2026

    クラウドディスクを使用する MongoDB レプリカセットまたはシャードクラスターインスタンスのバックアップ使用量を照会します。

    操作説明

    シャードクラスターのバックアップ使用量は、シャードごとに課金されます。この操作を使用して、単一シャードのバックアップ使用量を照会できます。

    今すぐお試しください

    この 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 ロールに付与する必要があります。

    アクション

    アクセスレベル

    リソースタイプ

    条件キー

    依存アクション

    dds:DescribeBackupStorage

    get

    *Instance

    acs:dds:{#regionId}:{#accountId}:dbinstance/{#dbInstanceId}

    		 なし なし

    リクエストパラメーター

    パラメーター

    型

    必須 / 任意

    説明

    例
    RegionId

    string

    任意

    インスタンスが配置されているリージョンの ID。 DescribeDBInstanceAttribute 操作を呼び出して、リージョン ID を照会します。

    cn-bejing
    DBInstanceId

    string

    必須

    インスタンス ID。

    dds-2zeb2d64cb46xxxx
    NodeId

    string

    任意

    シャードクラスターインスタンス内のシャードノードの ID。

    説明

    DBInstanceId パラメーターでシャードクラスターインスタンスの ID を指定した場合、このパラメーターは必須です。

    d-2zee48956b4axxxx

    レスポンスフィールド

    フィールド

    型

    説明

    例

    object

    RequestId

    string

    リクエスト ID。

    D648B367-15B6-1B42-BD4B-4XXXXXXXXX
    FullStorageSize

    integer

    完全バックアップが使用するストレージ容量。単位：バイト。

    説明

    クラウドディスクを使用するインスタンスは、スナップショットを使用してバックアップされます。完全バックアップのサイズは、スナップショットチェーンの合計サイズです。

    789221621
    LogStorageSize

    integer

    ログバックアップが使用するストレージ容量。単位：バイト。

    7892216
    FreeSize

    integer

    インスタンスの無料バックアップクォータ。単位：バイト。

    42949672960

    例

    成功レスポンス

    JSONJSON

    {
  "RequestId": "D648B367-15B6-1B42-BD4B-4XXXXXXXXX",
  "FullStorageSize": 789221621,
  "LogStorageSize": 7892216,
  "FreeSize": 42949672960
}

    エラーコード

    HTTP ステータスコード

    エラーコード

    エラーメッセージ

    説明
    400 InvalidDBInstance.Malformed Too many instance ids or instance id format is invalid.

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

    変更履歴

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