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

:DescribeDownloadBackupSetStorageInfo

最終更新日:Dec 02, 2025

バックアップセットをダウンロードするためのストレージ情報を照会します。

操作説明

今すぐお試しください

この 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:DescribeDownloadBackupSetStorageInfo

get

*BackupPlan

acs:dbs:{#regionId}:{#accountId}:backupplan/{#BackupPlanId}

なし なし

リクエストパラメーター

パラメーター

必須 / 任意

説明

RegionCode

string

必須

インスタンスが存在するリージョンの ID。

cn-hangzhou

Duration

string

必須

ダウンロード先が URL の場合、このパラメーターはリンクの有効期間を指定します。

  • URL のデフォルトの有効期間は 2 時間 (7,200 秒) です。

  • 有効期間は 5 分 (300 秒) から 1 日 (86,400 秒) までの値に設定できます。

  • 値を渡す前に秒に変換してください。たとえば、有効期間を 5 分に設定するには、300 を渡します。

300

InstanceName

string

任意

インスタンス ID。

説明

InstanceName を指定する場合は、BackupSetId も指定する必要があります。

rm-uf6qqf569n435****

TaskId

string

任意

ダウンロードタスクの ID。

  • TaskId を指定しない場合は、BackupSetIdInstanceName を指定する必要があります。

  • タスク ID を表示するには、対象インスタンスの [バックアップと復元] をクリックし、[バックアップのダウンロード] タブに移動します。

dt-s0ugzak9****

BackupSetId

string

任意

バックアップセットの ID。

30****

ClusterName

string

任意

このパラメーターは MongoDB インスタンスでのみ必須です。シャードクラスターの名前を指定します。

dds-example

レスポンスフィールド

フィールド

説明

object

返されたデータ。

RequestId

string

リクエスト ID。

44B8C2F5-919D-5D29-BCD5-DEB03467****

ErrCode

string

エラーコード。

DBS.ParamIsInValid

Success

string

リクエストが成功したかどうかを示します。有効な値:

  • true:リクエストは成功しました。

  • false:リクエストは失敗しました。

true

ErrMessage

string

エラーメッセージ。

Argument: regionCode Must not be empty

Code

string

エラーコード。

DBS.ParamIsInValid

Message

string

エラーメッセージ。

Argument: regionCode Must not be empty

Data

object

返されたデータ。

PublicUrl

string

バックアップセットをダウンロードするためのパブリック URL。

http://dbs-137383785969****-cn-hangzhou-1iv12nblw****.oss-cn-hangzhou.aliyuncs.com/dt-u7u4bufa****/dbs_target_file_path/test_456

PrivateUrl

string

バックアップセットをダウンロードするためのプライベート URL。

http://dbs-137383785969****-cn-hangzhou-1iv12nblw****.oss-cn-hangzhou-internal.aliyuncs.com/dt-u7u4bufa****/dbs_target_file_path/test_123

ExpirationTime

integer

リンクの有効期間。

説明

値は UNIX タイムスタンプです。

1661329050

成功レスポンス

JSONJSON

{
  "RequestId": "44B8C2F5-919D-5D29-BCD5-DEB03467****",
  "ErrCode": "DBS.ParamIsInValid",
  "Success": "true",
  "ErrMessage": "Argument: regionCode Must not be empty",
  "Code": "DBS.ParamIsInValid",
  "Message": "Argument: regionCode Must not be empty",
  "Data": {
    "PublicUrl": "http://dbs-137383785969****-cn-hangzhou-1iv12nblw****.oss-cn-hangzhou.aliyuncs.com/dt-u7u4bufa****/dbs_target_file_path/test_456",
    "PrivateUrl": "http://dbs-137383785969****-cn-hangzhou-1iv12nblw****.oss-cn-hangzhou-internal.aliyuncs.com/dt-u7u4bufa****/dbs_target_file_path/test_123",
    "ExpirationTime": 1661329050
  }
}

エラーコード

HTTP ステータスコード

エラーコード

エラーメッセージ

説明

403 Request.Forbidden Have no Permissions

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

変更履歴

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