Track Email Task Status via GetMailTaskStatus API - Quick BI - Alibaba Cloud - Quick BI

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

quickbi-public:GetMailTaskStatus

get

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
MailId	string	Yes	Mail ID	d5a59a898b634d75be5584f8dc159c62
TaskId	integer	No	Task ID Note If you do not specify a task ID, the status of the latest task is returned. If you specify a task ID, the status of the specified task is returned.	7218865303929605212

Response elements

Element	Type	Description	Example
	object	Response parameters.
RequestId	string	Request ID.	38C0FEC8-1510-415C-A9F1-9AE9422BDB65
Result	array<object>	The query results.
	object	The query result object.
execTime	string	The execution time in the yyyy-MM-dd HH:mm:ss format.	2024-10-09 17:34:11
mailId	string	The mail ID.	c38f73f4c5xxxxxc808c41b3f4d23b7852
status	string	The mail status. Valid values: Success: SENT Failure: FAILED In Progress: PROCESSING	SENT
taskId	integer	The task ID.	1282xxx610816
Success	boolean	Indicates whether the request is successful. Valid values: true: The request is successful. false: The request failed.	true

Examples

Success response

JSON format

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

Error codes

HTTP status code	Error code	Error message
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.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.