DescribeDownloadRecords を使用してダウンロードタスクのリストとステータスをクエリする - AnalyticDB

今すぐお試しください

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

アクション

アクセスレベル

リソースタイプ

条件キー

依存アクション

adb:DescribeDownloadRecords

get

DBCluster

acs:adb:{#regionId}:{#accountId}:dbcluster/{#DBClusterId}

なし

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
DBClusterId	string	必須	クラスター ID。説明リージョン内のすべての AnalyticDB for MySQL クラスターの ID を照会するには、DescribeDBClusters 操作を呼び出してください。	am-****************
RegionId	string	必須	クラスターのリージョン ID。説明最新のリージョン一覧を照会するには、DescribeRegions 操作を呼び出してください。	cn-hangzhou
Lang `deprecated`	string	任意	ファイルタイトルおよびエラーメッセージの言語。有効な値は以下のとおりです。 zh（デフォルト）：簡体字中国語。 en：英語。 ja：日本語。 zh-tw：繁体字中国語。	zh

レスポンスフィールド

フィールド	型	説明	例
	object	レスポンスパラメーター。
Records	array<object>	照会されたダウンロードタスク。
	object	照会されたダウンロードタスク。
Status	string	ダウンロードタスクのステータス。有効な値は以下のとおりです。 running finished failed	finished
DownloadId	integer	ダウンロードタスク ID。	69
ExceptionMsg	string	ダウンロードタスクが失敗した場合に返されるエラーメッセージ。	The query result is empty.
Url	string	ファイルのダウンロード URL。	https://perth-download-task.oss-cn-beijing.aliyuncs.com/adbmysql/query-sql-logs/am-************/20210805104301-20210805164302.xlsx?Expires=1943514161&OSSAccessKeyId=*****&Signature=****"
FileName	string	ダウンロードされたファイルの名前。	20210806094635-20210806095135
RequestId	string	リクエスト ID。	987F51BE-C4CB-332A-B159-63CE87******

例

成功レスポンス

JSONJSON

{
  "Records": [
    {
      "Status": "finished",
      "DownloadId": 69,
      "ExceptionMsg": "The query result is empty.",
      "Url": "https://perth-download-task.oss-cn-beijing.aliyuncs.com/adbmysql/query-sql-logs/am-**************/20210805104301-20210805164302.xlsx?Expires=1943514161&OSSAccessKeyId=*********&Signature=******\"",
      "FileName": "20210806094635-20210806095135"
    }
  ],
  "RequestId": "987F51BE-C4CB-332A-B159-63CE87******"
}

エラーコード

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

変更履歴

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