GetMailTaskStatus - Quick BI - Alibaba Cloud Documentation Center

This topic is generated by a machine translation engine without any human intervention. ALIBABA CLOUD DOES NOT GUARANTEE THE ACCURACY OF MACHINE TRANSLATED CONTENT. To request a human-translated version of this topic or provide feedback on this translation, please include it in the feedback form.

Check the running status of mail tasks within an organization

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Debug

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

Operation: the value that you can use in the Action element to specify the operation on a resource.
Access level: the access level of each operation. The levels are read, write, and list.
Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
- For mandatory resource types, indicate with a prefix of * .
- If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
Condition Key: the condition key that is defined by the cloud service.
Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.

Operation	Access level	Resource type	Condition key	Associated operation
quickbi-public:GetMailTaskStatus	get	All Resources ``	none	none

Request parameters

Parameter	Type	Required	Description	Example
MailId	string	Yes	Mail ID	d5a5**8b634d**5584f8dc159c62
TaskId	long	No	Task ID Note If the task ID is not provided, the latest task status will be returned by default; If the task ID is provided, the status of the specified task will be returned.	7218**0392**212

Response parameters

Parameter	Type	Description	Example
	object	Schema of Response
RequestId	string	Request ID.	38C0FEC8-**-415C-A9F1-**422BDB65
Result	array<object>	Return result.
DATA	object	Return result.
execTime	string	Execution time, in the format yyyy-MM-dd HH:mm:ss	2024-10-09 17:34:11
mailId	string	Mail ID	c38f73f4c5*****c808c41b3f4d23b7852
status	string	Mail status. Possible values: Success: SENT Failure: FAILED In Progress: PROCESSING	SENT
taskId	long	Task ID	1282xxx610816
Success	boolean	Indicates whether the request was successful. Possible values: true: The request was successful. false: The request failed.	true

Examples

Sample success responses

JSONformat

{
  "RequestId": "38C0FEC8-****-415C-A9F1-****422BDB65",
  "Result": [
    {
      "execTime": "2024-10-09 17:34:11",
      "mailId": "c38f73f4c5*****c808c41b3f4d23b7852",
      "status": "SENT",
      "taskId": 0
    }
  ],
  "Success": true
}

Error codes

HTTP status code	Error code	Error message	Description
400	Mail.Forbidden.Access	Forbidden Access On This Operation.	Access to this operation is prohibited.
400	Mail.Not.Found	Mail not found.	Mail does not exist
400	Mail.Subject.Error	The mail subject is invalid.	Illegal message subject parameter

For a list of error codes, visit the Service error codes.