手动执行订阅的邮件任务。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
下表是API对应的授权信息,可以在RAM权限策略语句的Action
元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:
- 操作:是指具体的权限点。
- 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
- 资源类型:是指操作中支持授权的资源类型。具体说明如下:
- 对于必选的资源类型,用前面加 * 表示。
- 对于不支持资源级授权的操作,用
全部资源
表示。
- 条件关键字:是指云产品自身定义的条件关键字。
- 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
---|---|---|---|---|
quickbi-public:ManualRunMailTask | update | *全部资源 * |
| 无 |
请求参数
名称 | 类型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
MailId | string | 是 | 订阅管理界面的邮件 id。 | 3423423sdfa****sdadw |
返回参数
示例
正常返回示例
JSON
格式
{
"RequestId": "a4d1a221d-41za1-****",
"Result": true,
"Success": true
}
错误码
HTTP status code | 错误码 | 错误信息 | 描述 |
---|---|---|---|
400 | Mail.Forbidden.Access | Forbidden Access On This Operation. | 禁止访问此操作。 |
400 | Mail.Not.Found | The Subscription Task Does Not Exist. | 订阅任务不存在。 |
400 | MailId.Is.Null | The Mail Id Is Null. | 参数mailId为空。 |
400 | MailTask.Already.Running | The Mail Task Is Already Running. | 邮件任务当前已在运行中。 |
400 | MailApi.Beyond.ScheduleLimit | Mail Subscription Openapi Requests Are Frequent. Please Try Again In %s Minutes. | 邮件订阅openApi请求频繁,请%s分钟后重试。 |
400 | Timer.Schedule.Task | An error occurred during timer task scheduling. | 定时器调度任务失败。 |
访问错误中心查看更多错误码。