接口描述:调用本接口新增报告订阅。
请求方式:post
请求路径:/report-manage/create-report
使用说明: 单个用户一分钟限制调用10000次,并发不超过100;
请求参数说明:
参数 | 类型 | 是否必传 | 名称 | 描述 |
---|---|---|---|---|
reportName | string | 是 | 报告名称 | 长度不超过200字符 |
thisDate | string | 是 | 本次发送时间 | 格式:yyyy-MM-dd HH:mm:ss |
sendType | number | 是 | 报告发送形式 | 固定值1(以附件pdf发送发送频率) |
sendFrequency | number | 是 | 发送频率 | 1(仅一次), 2(一天), 3(一星期), 4(一个月), 5(三个月), 6(六个月), 7(一年) |
oneTimeStartTime | string | 否 | 报告统计开始时间 | 格式:yyyy-MM-dd HH:mm:ss |
oneTimeEndTime | string | 否 | 报告统计结束时间 | 格式:yyyy-MM-dd HH:mm:ss |
string | 是 | 订阅邮箱 | 多个英文分号;分割 | |
chartData | object | 是 | 报告图表集 | |
chartData.domain | list<object> | 是 | 域名级图表 | |
chartData.domain[*].domainName | string | 是 | 域名 | |
chartData.domain[*].list | list<object> | 是 | 域名级图表 | |
chartData.domain[*].list[*].id | number | 是 | 图表编号 | 1(带宽流量图),2(请求数据统计图),3(TOP10 URL统计图),4(TOP10 IP统计图),5(状态码统计图),6(命中率统计图),7(用户所属运营商统计图),8(用户所属省份统计图) |
返回参数说明:
参数 | 类型 | 是否必传 | 名称及描述 |
---|---|---|---|
code | number | 是 | 状态码 |
message | string | 是 | 状态信息描述 |
data | object | 否 | 响应结果集 |
data.reportTemplateId | number | 否 | 报告订阅ID |
示例:
请求路径:https://cdnapi-global.ctapi.ctyun.cn/report-manage/create-report
请求参数:
{ "reportName": "TestReport9", "thisDate": "2022-11-22 08:22:00", "sendType": 1, "sendFrequency": 1, "oneTimeStartTime": "2022-11-01 17:01:05", "oneTimeEndTime": "2022-11-22 08:01:05", "email": "****@chinatelecom.cn", "chartData": { "domain": [ { "domainName": "aa.bb.ctyun.cn", "list": [ { "id": 3 } ] } ] } }
返回结果:
{ "code": 100000, "message": "success", "data": { "reportTemplateId": 272 } }
错误码请参考:参数code和message含义