機能の概要
指定されたOceanBase Cloudインスタンスのバックアップセットダウンロードタスクの詳細を照会し、ダウンロードリンク、タスク状態、バックアップセットサイズ、リンクの有効期限などの情報を取得します。このAPIは、ユーザーがバックアップファイルをダウンロードできるように、作成済みのバックアップセットダウンロードタスクの詳細情報を取得するために使用されます。
呼び出しの説明
インターフェース制約
呼び出し元はマルチクラウドAPIにアクセスするためのキーを保有している必要があります。AccessKey IDとAccessKey Secretの取得方法の詳細については、アクセスキーの管理を参照してください。
リクエストパス
GET /api/v2/instances/{instanceId}/backup/link/{downloadTaskId}
リクエストパラメータ
Path
パラメータ |
タイプ |
必須 |
説明 |
例 |
|---|---|---|---|---|
| instanceId | String | はい | OceanBaseクラスタID | obcluster-***** |
| downloadTaskId | Integer | はい | ダウンロードタスクID | 1 |
Query
パラメータ |
タイプ |
必須 |
説明 |
例 |
|---|---|---|---|---|
| requestId | String | はい | リクエストID、追跡に使用されます | d04eabba**** |
戻り値
フィールド |
タイプ |
説明 |
例 |
|---|---|---|---|
| success | Boolean | 成功したかどうか | true |
| errorCode | String | エラーコード | INVALID_PARAMETER |
| errorMessage | String | エラーメッセージ | Invalid parameter |
| data | Object | 業務データ(object) | N/A |
| cost | Number | 所要時間 | 1.0 |
| server | String | サーバーアドレス、通常はOBServerノードのIP | 10.0.0.10 |
| requestId | String | リクエストID | d04eabba**** |
| totalCount | Number | 総レコード数。 | 100.0 |
| extra | Object | 拡張情報。 | {} |
data オブジェクトのフィールド
フィールド |
タイプ |
説明 |
サンプル値 |
|---|---|---|---|
| downloadTaskId | Integer | ダウンロードタスクID | 1 |
| downloadTaskStatus | String | ダウンロードタスクの状態。 | ONLINE |
| downloadTaskCreateTime | String | ダウンロードタスクの作成時間。 | 2026-02-25 15:40:43+00:00 |
| backupRestorableTime | String | バックアップセットを使用して復元できる時点。 | 2026-02-25 15:40:43+00:00 |
| backupSetId | String | バックアップセットID | backup_1**** |
| compressedBackupSetSize | Number | 圧縮後のバックアップセットサイズ。 | 200.0 |
| internalUrl | String | 内部ダウンロードURL。 | https://internal.example.com/backup/link |
| urlExpiredTime | String | ダウンロードURLの有効期限。 | 2026-02-25 15:40:43+00:00 |
| urlAliveTime | Integer | ダウンロードURLの有効期間。 | 1 |
例
リクエスト例
curl --digest -u '<Your AccessKey ID:AccessKey Secret>' \
-X GET \
'https://api-cloud.oceanbase.com/api/v2/instances/{instanceId}/backup/link/{downloadTaskId}?requestId=d04eabba****'
レスポンス例
JSON形式
{
"success": true,
"errorCode": "INVALID_PARAMETER",
"errorMessage": "Invalid parameter",
"data": {
"downloadTaskId": 1,
"downloadTaskStatus": "ONLINE",
"downloadTaskCreateTime": "2026-02-25 15:40:43+00:00",
"backupRestorableTime": "2026-02-25 15:40:43+00:00",
"backupSetId": "backup_1****",
"compressedBackupSetSize": 200.0,
"internalUrl": "https://internal.example.com/backup/link",
"urlExpiredTime": "2026-02-25 15:40:43+00:00",
"urlAliveTime": 1
},
"cost": 1.0,
"server": "xxx.xxx.x.xxx:xxx",
"requestId": "d04eabba****",
"totalCount": 100.0,
"extra": "{}"
}