すべてのプロダクト
Search
ドキュメントセンター

ApsaraDB for MongoDB:DescribeBinlogFiles

最終更新日:Mar 25, 2026

ApsaraDB for MongoDB インスタンスのログバックアップファイルをクエリします。

今すぐお試しください

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

テスト

RAM 認証

この操作の認証情報はありません。問題が発生した場合は、アカウントマネージャーにご連絡ください。

リクエストパラメーター

パラメーター

必須 / 任意

説明

RegionId

string

任意

リージョン ID です。

cn-zhangjiakou

DBInstanceId

string

必須

インスタンス ID です。インスタンスがシャードクラスターの場合、NodeId パラメーターも指定する必要があります。

dds-wz9ca592fc637a54

NodeId

string

任意

シャードクラスターインスタンス内の Mongos ノードまたはシャードノードの ID です。

説明

このパラメーターは、シャードクラスターインスタンスにのみ適用されます。

d-uf696817a1b5d9f4

StartTime

string

必須

クエリの開始時刻です。形式は yyyy-MM-ddTHH:mm:ss.xxxZ で、協定世界時 (UTC) で表示されます。

2021-03-23T06:24:21.425Z

EndTime

string

必須

クエリの終了時刻です。終了時刻は開始時刻より後である必要があります。形式は yyyy-MM-ddTHH:mm:ss.xxxZ で、協定世界時 (UTC) で表示されます。

2023-04-17T05:50:28.914Z

PageSize

integer

任意

1 ページあたりの返却エントリ数です。

10

PageNumber

integer

任意

ページ番号です。

1

SrcRegion

string

任意

リージョン間バックアップのソースインスタンスがあるリージョンです。

説明
  • このパラメーターは、リージョン間バックアップをクエリする場合に必須です。

ap-southeast-1

DestRegion

string

任意

リージョン間バックアップが保存されているリージョンです。

説明

このパラメーターは、リージョン間バックアップをクエリする場合に必須です。

cn-beijing

BinlogId

string

任意

binlog ID です。このパラメーターは現在サポートされていません。

null

ResourceGroupId

string

任意

リソースグループ ID です。

rg-xxxx

レスポンスフィールド

フィールド

説明

object

RequestId

string

リクエスト ID です。

F8CA8312-530A-413A-9129-F2BB32A8D404

PageNumber

integer

返却結果のページ番号です。

3

MaxRecordsPerPage

integer

1 ページあたりの返却エントリ数です。

30

TotalRecordCount

integer

見つかった binlog ファイルの総数です。

240

Items

object

LogFile

array<object>

binlog ファイルの詳細です。

object

binlog ファイルの詳細です。

LogFileName

string

binlog ファイル名です。

1709846151

DumpDownloadURL

string

binlog ファイルの OSS ダウンロードリンクです。(現在はサポートされていません。)

null

LogBeginTime

string

binlog ファイル内のデータの開始時刻です。

形式:yyyy-MM-ddTHH:mm:ssZ (UTC)

2024-03-08T09:31:29Z

DumpBucket

string

binlog ファイルのストレージ場所です。(現在はサポートされていません。)

null

LinkExpiredTime

string

URL の有効期限です。(現在はサポートされていません。)

null

OSSEndpoint

string

binlog ファイルが保存されている OSS エンドポイントです。(現在はサポートされていません。)

null

LogEndTime

string

binlog ファイル内のデータの終了時刻です。形式:yyyy-MM-ddTHH:mm:ssZ (UTC)。

2024-03-09T02:55:00Z

DumpState

integer

ダンプステータスです。(現在はサポートされていません。)

null

FileSize

string

binlog ファイルのサイズ (バイト単位) です。

603127135

FileId

string

binlog ファイルの一意な識別子です。

5098

BinLogId

string

binlog ID です。(現在はサポートされていません。)

null

LogStatus

string

ログバックアップステータスです。

有効値:

  • Uploading:ファイルをアップロード中です。

  • Completed:ファイルのアップロードが正常に完了しました。

列挙値:

  • Completed :

  • Uploading :

Completed

成功レスポンス

JSONJSON

{
  "RequestId": "F8CA8312-530A-413A-9129-F2BB32A8D404",
  "PageNumber": 3,
  "MaxRecordsPerPage": 30,
  "TotalRecordCount": 240,
  "Items": {
    "LogFile": [
      {
        "LogFileName": "1709846151",
        "DumpDownloadURL": "null",
        "LogBeginTime": "2024-03-08T09:31:29Z",
        "DumpBucket": "null",
        "LinkExpiredTime": "null",
        "DownloadLink": "https://rdslog-shanghai.xxxxxxxxx",
        "OSSEndpoint": "null",
        "LogEndTime": "2024-03-09T02:55:00Z",
        "DumpState": 0,
        "FileSize": "603127135",
        "FileId": "5098",
        "BinLogId": "null",
        "LogStatus": "Completed"
      }
    ]
  }
}

エラーコード

HTTP ステータスコード

エラーコード

エラーメッセージ

説明

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

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

変更履歴

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