調用QueryTaskByParam介面按參數查詢郵件發送任務-Direct Mail-阿里雲

查詢任務。

調試

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

調試

授權資訊

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

操作：是指具體的許可權點。
存取層級：是指每個操作的存取層級，取值為寫入（Write）、讀取（Read）或列出（List）。
資源類型：是指操作中支援授權的資源類型。具體說明如下：
- 對於必選的資源類型，用前面加 * 表示。
- 對於不支援資源級授權的操作，用全部資源表示。
條件關鍵字：是指雲產品自身定義的條件關鍵字。
關聯操作：是指成功執行操作所需要的其他許可權。操作者必須同時具備關聯操作的許可權，操作才能成功。

操作

存取層級

資源類型

條件關鍵字

關聯操作

dm:QueryTaskByParam

get

*全部資源

*

無

請求參數

名稱	類型	必填	描述	樣本值
PageNo	integer	否	當前頁碼，預設為 1	1
PageSize	integer	否	每頁大小，預設為 10	10
KeyWord	string	否	關鍵詞，預設所有資訊	mesh-notification-788717
Status	integer	否	狀態，預設所有狀態	0

返回參數

名稱	類型	描述	樣本值
	object
PageSize	integer	每頁大小	10
RequestId	string	請求 ID	10A1AD70-E48E-476D-98D9-39BD92193837
PageNumber	integer	當前頁碼	3
TotalCount	integer	總數量	15
data	object
task	array<object>	返回的結果
	object
ReceiversName	string	收件者名稱	TKP000442-333
TagName	string	標籤	202201
TaskStatus	string	任務狀態，發送成功：1	1
CreateTime	string	建立時間	2022-04-18T10:36Z
RequestCount	string	請求數	1
AddressType	string	地址類型，發信地址：1；隨機地址：0；	0
UtcCreateTime	integer	建立時間的 UTC 格式	1569734892
TemplateName	string	模板名稱	Short Simple
TaskId	string	任務 ID	1054296
IpPoolId	string	獨立 IP 位址集區 ID。	xxx
IpPoolName	string	獨立 IP 位址集區名稱。	測試專屬IP位址集區1
ConfigSetId	string	配置集 ID。	xxx
ConfigSetName	string	配置集名稱。	xxx

樣本

正常返回樣本

JSON格式

{
  "PageSize": 10,
  "RequestId": "10A1AD70-E48E-476D-98D9-39BD92193837",
  "PageNumber": 3,
  "TotalCount": 15,
  "data": {
    "task": [
      {
        "ReceiversName": "TKP000442-333",
        "TagName": "202201",
        "TaskStatus": "1",
        "CreateTime": "2022-04-18T10:36Z",
        "RequestCount": "1",
        "AddressType": "0",
        "UtcCreateTime": 1569734892,
        "TemplateName": "Short Simple",
        "TaskId": "1054296",
        "IpPoolId": "xxx",
        "IpPoolName": "測試專屬IP位址集區1",
        "ConfigSetId": "xxx",
        "ConfigSetName": "xxx"
      }
    ]
  }
}

錯誤碼

HTTP status code	錯誤碼	錯誤資訊
400	InvalidKeyword.Malformed	The specified keyword is wrongly formed.
400	InvalidStatus.Malformed	The specified status is wrongly formed.
500	InternalError	The request processing has failed due to some unknown error.

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

變更歷史

更多資訊，參考變更詳情。