調用CreateCdnDeliverTask建立報告訂閱任務,訂閱成功後系統會周期性地以郵件方式向您發送報表統計資料。
介面說明
單使用者調用頻率:3 次/秒。
調試
您可以在OpenAPI Explorer中直接運行該介面,免去您計算簽名的困擾。運行成功後,OpenAPI Explorer可以自動產生SDK程式碼範例。
調試
授權資訊
請求參數
|
名稱 |
類型 |
必填 |
描述 |
樣本值 |
| Name |
string |
是 |
訂閱交付任務名稱。 |
網域名稱訂閱 |
| Reports |
string |
是 |
待訂閱的報表列表,需進行 JSON 轉義。 |
[{\"reportId\":1,\"conditions\":[{\"field\":\"prov\",\"op\":\"in\",\"value\":[\"黑龍江\",\"北京\"]}]}] |
| DomainName |
string |
否 |
待訂閱的網域名稱列表,多個網域名稱用半形逗號(,)分隔,訂閱網域名稱數量上限為 500 個,超過 500 個請提交工單申請。 說明
不傳該參數,預設為帳號下的所有網域名稱訂閱報表交付任務。 |
www.example1.com,www.example2.com |
| Deliver |
string |
是 |
報表發送方式,僅支援郵件發送,需進行 JSON 轉義。 |
{"email":{"subject":"主題名稱","to":["username@example.com","username@example.org"]}} |
| Schedule |
string |
是 |
訂閱周期相關參數,需進行 JSON 轉義。 |
{\"schedName\":\"周期任務名稱\",\"description\":\"描述\",\"crontab\":\"000**?\",\"frequency\":\"d\",\"status\":\"enable\",\"effectiveFrom\":\"2020-09-17T00:00:00Z\",\"effectiveEnd\":\"2020-11-17T00:00:00Z\"} |
ReDatas 資料說明
| 參數 | 類型 | 是否必須 | 描述 |
| reportId | String | 是 | 報表 ID。 |
| conditions | ConDatas[] | 否 | 報表過濾條件。 |
ConDatas 資料說明
| 參數 | 類型 | 是否必須 | 描述 |
| field | String | 否 | 過濾欄位。 |
| op | String | 否 | 過濾操作。 |
| value | String[] | 否 | 欄位值數組。 |
email 資料說明
| 參數 | 類型 | 是否必須 | 描述 |
| subject | String | 是 | 訂閱主題。 |
| to | String[] | 是 | 收件郵箱列表數組。 |
Deliver 資料說明
| 參數 | 類型 | 是否必須 | 描述 |
| subject | String | 否 | 訂閱主題。 |
| to | String[] | 是 | 收件郵箱列表數組。 |
Schedule 資料說明
| 參數 | 類型 | 是否必須 | 描述 |
| schedName | String | 否 | 訂閱任務名稱。 |
| description | String | 否 | 訂閱任務描述。 |
| crontab | String | 是 | 訂閱任務執行循環。 |
| frequency | String | 是 | 執行頻率。取值: h:小時 d:天 w:周 |
| status | String | 否 | 訂閱任務狀態。取值: enable:啟用。 disable:關閉。 |
| effectiveFrom | String | 否 | 訂閱交付任務開始時間。 |
| effectiveEnd | String | 否 | 訂閱交付任務結束時間。 |
返回參數
|
名稱 |
類型 |
描述 |
樣本值 |
|
object |
|||
| DeliverId |
string |
訂閱任務 ID。 |
1025 |
| RequestId |
string |
請求 ID。 |
04F0F334-1335-436C-A1D7-6C044FE73368 |
樣本
正常返回樣本
JSON格式
{
"DeliverId": "1025",
"RequestId": "04F0F334-1335-436C-A1D7-6C044FE73368"
}
錯誤碼
|
HTTP status code |
錯誤碼 |
錯誤資訊 |
描述 |
|---|---|---|---|
| 400 | InvalidParameter | The specified parameter is invalid. | 參數錯誤 |
| 400 | TimeParseFailed | Failed to parse the time parameter. | 解析時間參數失敗 |
| 400 | SubscriptionNotFound | The subscription is not found. | 未開通定製服務 |
| 400 | NameAlreadyExists | The name already exists. | 名稱已存在 |
| 400 | DeliverExceedLimit | The maximum number of subscribed tasks is exceeded. | 訂閱任務個數已達上限 |
訪問錯誤中心查看更多錯誤碼。
變更歷史
更多資訊,參考變更詳情。