呼叫DescribeCdnDeliverList查詢報表訂閱任務列表,系統將返回該使用者所有的訂閱任務列表。
介面說明
單使用者呼叫頻率:3 次/秒。
調試
您可以在OpenAPI Explorer中直接運行該介面,免去您計算簽名的困擾。運行成功後,OpenAPI Explorer可以自動產生SDK程式碼範例。
調試
授權資訊
|
操作 |
存取層級 |
資源類型 |
條件關鍵字 |
關聯操作 |
|
cdn:DescribeCdnDeliverList |
get |
*All Resource
|
無 | 無 |
請求參數
|
名稱 |
類型 |
必填 |
描述 |
樣本值 |
| DeliverId |
integer |
否 |
待查詢的訂閱任務 ID。如果不傳該引數,預設返回所有的訂閱任務。 |
3 |
返回參數
|
名稱 |
類型 |
描述 |
樣本值 |
|
object |
返回主體 |
||
| RequestId |
string |
請求 ID。 |
12345 |
| Content |
string |
訂閱任務列表資料。 |
"data": [{"deliverId": 1,"status": "enable","createTime": "2020-10-14T11:19:26Z","crontab": "0 0 0 * * ?","frequency": "d","name": "域名订阅","dmList": ["www.example.com"],"reports": [{"reportId": 1,"conditions": [{"op": "in","field": "prov","value": ["黑龙江","北京"]}]},{"reportId": 2}],"deliver": {"email": {"subject": "主题","to": ["example@alibaba-inc.com","example@alibaba-inc.com"]}}}]}} |
data 資料說明
| 引數 | 型別 | 描述 |
| deliverId | Long | 訂閱任務 ID。 |
| status | String | 訂閱任務狀態。取值: enable:啟用。 disable:關閉。 |
| createTime | String | 訂閱任務建立時間。 |
| crontab | String | 訂閱任務執行週期。 |
| frequency | String | 執行頻率。取值: h:小時 d:天 M:月 |
| name | String | 訂閱任務名稱。 |
| dmList | String[] | 訂閱任務的域名過濾列表。 |
| reports | String[] | 訂閱報表列表。包含以下引數: reportId:報表 ID。 conditions:報表過濾條件(包含過濾操作、過濾欄位和過濾值),沒有則為空。op:過濾操作,目前只支援 in;field:過濾欄位;value:過濾值。 |
| deliver | String | 交付模組,包含郵件主題、收件人等資訊。 email:郵件交付。 subject:郵件主題。 to:傳送郵件列表。 copy:抄送郵件列表。 |
reports 資料說明
| 引數 | 型別 | 描述 |
| deliverId | Long | 訂閱任務 ID。 |
| status | String | 訂閱任務狀態。取值: enable:啟用。 disable:關閉。 |
樣本
正常返回樣本
JSON格式
{
"RequestId": "12345",
"Content": "\"data\": [{\"deliverId\": 1,\"status\": \"enable\",\"createTime\": \"2020-10-14T11:19:26Z\",\"crontab\": \"0 0 0 * * ?\",\"frequency\": \"d\",\"name\": \"域名订阅\",\"dmList\": [\"www.example.com\"],\"reports\": [{\"reportId\": 1,\"conditions\": [{\"op\": \"in\",\"field\": \"prov\",\"value\": [\"黑龙江\",\"北京\"]}]},{\"reportId\": 2}],\"deliver\": {\"email\": {\"subject\": \"主题\",\"to\": [\"example@alibaba-inc.com\",\"example@alibaba-inc.com\"]}}}]}}"
}
錯誤碼
|
HTTP status code |
錯誤碼 |
錯誤資訊 |
描述 |
|---|---|---|---|
| 400 | InvalidParameter | The specified parameter is invalid. | |
| 400 | TimeParseFailed | Failed to parse the time parameter. | |
| 400 | SubscriptionAlreadyExists | The subscription already exists. | |
| 400 | SubscriptionNotFound | The subscription is not found. | |
| 400 | NameAlreadyExists | The name already exists. | |
| 400 | DeliverExceedLimit | The maximum number of subscribed tasks is exceeded. |
訪問錯誤中心查看更多錯誤碼。
變更歷史
更多資訊,參考變更詳情。