ManualRunMailTask - 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.

Manually Execute Email Task

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:ManualRunMailTask	update	All Resources ``	none	none

Request parameters

Parameter	Type	Required	Description	Example
MailId	string	Yes	The ID of the email task in the subscription management interface.	3423423sdfa****sdadw

Response parameters

Parameter	Type	Description	Example
	object	Schema of Response
RequestId	string	Request ID.	a4d1a221d-41za1-****
Result	boolean	Indicates whether the execution was successful.	true
Success	boolean	Indicates whether the request was successful. Value range: true: The request succeeded false: The request failed	true

Examples

Sample success responses

JSONformat

{
  "RequestId": "a4d1a221d-41za1-****",
  "Result": true,
  "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	The Subscription Task Does Not Exist.	The subscription task does not exist.
400	MailId.Is.Null	The Mail Id Is Null.	The parameter mailId is empty.
400	MailTask.Already.Running	The Mail Task Is Already Running.	The mail task is currently running.
400	MailApi.Beyond.ScheduleLimit	Mail Subscription Openapi Requests Are Frequent. Please Try Again In %s Minutes.	Mail subscription openApi requests are frequent, please try again in % s minutes.
400	Timer.Schedule.Task	An error occurred during timer task scheduling.	Timer scheduling task failed.

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