QueryDataTrackResultDownloadStatus による DMS データ追跡ダウンロードステータスの確認 - DMS

データ追跡ログのダウンロードおよび解析の進捗状況を照会します。

今すぐお試しください

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

アクション

アクセスレベル

リソースタイプ

条件キー

依存アクション

dms:QueryDataTrackResultDownloadStatus

none

*All Resource

*

なし

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
OrderId	integer	必須	チケットの ID です。チケット ID を照会するには、ListOrders 操作を呼び出します。	11****
DownloadKeyId	string	必須	ダウンロードキーの ID です。データ追跡ログの解析進捗状況を識別するために使用されます。キーの ID を照会するには、DownloadDataTrackResult 操作を呼び出します。	e23dd7ec-a19f-4a69-8eb3-8ffd26e6****
Tid	integer	任意	テナントの ID です。テナント ID を照会するには、GetUserActiveTenant または ListUserTenants 操作を呼び出します。	1***

レスポンスフィールド

フィールド	型	説明	例
	object	応答スキーマです。
RequestId	string	リクエストの ID です。	0C1CB646-1DE4-4AD0-B4A4-7D47DD52E931
Success	boolean	リクエストが成功したかどうかを示します。有効な値は以下のとおりです。 true：リクエストが成功しました。 false：リクエストが失敗しました。	true
ErrorMessage	string	リクエストが失敗した場合に返されるエラーメッセージです。	UnknownError
ErrorCode	string	リクエストが失敗した場合に返されるエラーコードです。	UnknownError
StatusResult	object	ダウンロード進捗状況に関する情報です。
DownloadStatus	string	ダウンロードタスクのステータスです。有効な値は以下のとおりです。 INIT：ダウンロードタスクの初期化中です。 LISTING：初期化中の一時的な中間ステートです。 DOWNLOADING：ダウンロードタスクの処理中です。 DOWNLOAD_SUCCESS：ダウンロードタスクが正常に完了しました。 DOWNLOAD_FAIL：ダウンロードタスクが失敗しました。	DOWNLOAD_SUCCESS
DownloadUrl	string	データ追跡ログをダウンロードするための URL です。DownloadStatus の値が DOWNLOAD_SUCCESS の場合のみこのパラメーターが返されます。	https://idbsaasstore.oss-cn-zhangjiakou.aliyuncs.com/**_REDO_31201_207.zip?Expires=1682239593&OSSAccessKeyId=&Signature=**
StatusDesc	string	ステータスの説明です。	SUCCESS
TotalCount	integer	返されたエントリの合計数です。	69

例

成功レスポンス

JSONJSON

{
  "RequestId": "0C1CB646-1DE4-4AD0-B4A4-7D47DD52E931",
  "Success": true,
  "ErrorMessage": "UnknownError",
  "ErrorCode": "UnknownError",
  "StatusResult": {
    "DownloadStatus": "DOWNLOAD_SUCCESS",
    "DownloadUrl": "https://idbsaasstore.oss-cn-zhangjiakou.aliyuncs.com/****_REDO_31201_207.zip?Expires=1682239593&OSSAccessKeyId=****&Signature=****\n",
    "StatusDesc": "SUCCESS",
    "TotalCount": 69
  }
}

エラーコード

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

変更履歴

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