GetMailTaskStatus - 查看邮件任务运行状态 - 智能商业分析 Quick BI

调试

您可以在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.

访问错误中心查看更多错误码。

变更历史

更多信息，参考变更详情。