GetMailTaskStatus API でメールタスクステータスを追跡 - Quick BI

今すぐお試しください

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

アクション

アクセスレベル

リソースタイプ

条件キー

依存アクション

quickbi-public:GetMailTaskStatus

get

*All Resource

*

なし

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
MailId	string	必須	メール ID	d5a59a898b634d75be5584f8dc159c62
TaskId	integer	任意	タスク ID 説明タスク ID が指定されていない場合、デフォルトで最新のタスクステータスが返されます。タスク ID が指定されている場合、指定されたタスクのステータスが返されます。	7218865303929605212

レスポンスフィールド

フィールド	型	説明	例
	object	応答のスキーマ
RequestId	string	リクエスト ID。	38C0FEC8-1510-415C-A9F1-9AE9422BDB65
Result	array<object>	返された結果。
	object	返された結果。
execTime	string	実行時間。フォーマットは yyyy-MM-dd HH:mm:ss です。	2024-10-09 17:34:11
mailId	string	メール ID	c38f73f4c5xxxxxc808c41b3f4d23b7852
status	string	メールステータス。有効な値：成功：SENT 失敗：FAILED 処理中：PROCESSING	SENT
taskId	integer	タスク ID	1282xxx610816
Success	boolean	リクエストが成功したかどうかを示します。有効な値： true：リクエストは成功しました。 false：リクエストは失敗しました。	true

例

成功レスポンス

JSONJSON

{
  "RequestId": "38C0FEC8-1510-415C-A9F1-9AE9422BDB65",
  "Result": [
    {
      "execTime": "2024-10-09 17:34:11",
      "mailId": "c38f73f4c5xxxxxc808c41b3f4d23b7852",
      "status": "SENT",
      "taskId": 0
    }
  ],
  "Success": true
}

エラーコード

HTTP ステータスコード	エラーコード	エラーメッセージ
400	Mail.Forbidden.Access	Forbidden Access On This Operation.
400	Mail.Not.Found	Mail not found.
400	Mail.Subject.Error	The mail subject is invalid.

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

変更履歴

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