全部產品
Search
文件中心

Quick BI:GetMailTaskStatus - 查看郵件任務運行狀態

更新時間:Dec 24, 2025

查看組織內郵件任務運行狀態(即時狀態非最終狀態)。

調試

您可以在OpenAPI Explorer中直接運行該介面,免去您計算簽名的困擾。運行成功後,OpenAPI Explorer可以自動產生SDK程式碼範例。

調試

授權資訊

下表是API對應的授權資訊,可以在RAM權限原則語句的Action元素中使用,用來給RAM使用者或RAM角色授予調用此API的許可權。具體說明如下:

  • 操作:是指具體的許可權點。

  • 存取層級:是指每個操作的存取層級,取值為寫入(Write)、讀取(Read)或列出(List)。

  • 資源類型:是指操作中支援授權的資源類型。具體說明如下:

    • 對於必選的資源類型,用前面加 * 表示。

    • 對於不支援資源級授權的操作,用全部資源表示。

  • 條件關鍵字:是指雲產品自身定義的條件關鍵字。

  • 關聯操作:是指成功執行操作所需要的其他許可權。操作者必須同時具備關聯操作的許可權,操作才能成功。

操作

存取層級

資源類型

條件關鍵字

關聯操作

quickbi-public:GetMailTaskStatus

get

*全部資源

*

請求參數

名稱

類型

必填

描述

樣本值

MailId

string

郵件 id

d5a59a898b634d75be5584f8dc159c62

TaskId

integer

任務 id

說明
  • 當任務 id 傳參為空白時,則預設返回最新的一條任務狀態;

  • 當任務 id 傳參不為空白時,則按傳參值返回任務狀態。

7218865303929605212

返回參數

名稱

類型

描述

樣本值

object

Schema of Response

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

樣本

正常返回樣本

JSON格式

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

錯誤碼

HTTP status code

錯誤碼

錯誤資訊

描述

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.

訪問錯誤中心查看更多錯誤碼。

變更歷史

更多資訊,參考變更詳情