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

:DescribeDownloadSupport

最終更新日:Dec 02, 2025

現在のインスタンスが高度なダウンロード機能をサポートしているかどうかを照会します。

操作説明

対象エンジン

  • RDS MySQL (クラウドディスク)

  • RDS PostgreSQL

  • PolarDB for MySQL

  • MongoDB

関連ドキュメント

特定時点または特定のバックアップセットに対して高度なダウンロードタスクを作成できます。URL をダウンロード先として指定したり、データを Object Storage Service (OSS) バケットに直接書き込んでデータ分析やオフラインアーカイブを行うことができます。

今すぐお試しください

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

get

*BackupPlan

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

なし なし

リクエストパラメーター

パラメーター

必須 / 任意

説明

RegionCode

string

必須

インスタンスのリージョン ID。 DescribeDBInstanceAttribute 操作を呼び出して、リージョン ID を照会できます。

cn-hangzhou

InstanceName

string

必須

インスタンス ID。

rm-bp1a48p922r4b****

ClusterName

string

任意

シャードクラスターの名前。 このパラメーターは、MongoDB シャードクラスターインスタンスの場合にのみ必要です。

dds-example

レスポンスフィールド

フィールド

説明

object

応答。

Data

string

高度なダウンロード機能がサポートされているかどうかを示します。 有効な値:

  • true:機能はサポートされています。

  • false:機能はサポートされていません。

true

RequestId

string

リクエスト ID。

F1A186F7-7B34-5C11-A903-EE23876B****

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

成功レスポンス

JSONJSON

{
  "Data": "true",
  "RequestId": "F1A186F7-7B34-5C11-A903-EE23876B****",
  "ErrCode": "DBS.ParamIsInValid",
  "Success": "true",
  "ErrMessage": "Argument: regionCode Must not be empty",
  "Code": "DBS.ParamIsInValid",
  "Message": "Argument: regionCode Must not be empty"
}

エラーコード

HTTP ステータスコード

エラーコード

エラーメッセージ

説明

403 Request.Forbidden Have no Permissions

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

変更履歴

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