接口说明
调用addOrUpdate接口创建或者更新日志投递任务。
请求参数taskId若为空,表示创建日志投递任务;请求参数taskId若不为空,表示对该日志投递任务进行更新。
请求参数instanceType代表日志投递的实例,不同的instanceType需要有不同的instanceConfig。
请求头
该接口使用公共请求头,无特殊请求头。请参见公共请求参数文档。
请求语法
POST/paasopenapi/api/cmplogadmin/cmplog/tenant/dataSend/addOrUpdateHTTP/1.1
请求参数
名称 | 类型 | 位置 | 是否必选 | 示例 | 描述 |
---|---|---|---|---|---|
resPoolCode | String | Body | 是 | bbd132b53a11e9b0e40242ac11000 | 资源池编码 |
originProjectId | Long | Body | 是 | 400 | 源日志项目ID |
originProjectName | String | Body | 否 | test-originProjectName | 源日志项目名称 |
originUnitId | Long | Body | 是 | 2600 | 源日志单元ID |
originUnitName | String | Body | 否 | test-originUnitName | 源日志单元名称 |
taskId | String | Body | 否 | 10001 | 任务ID:创建日志投递任务操作为空,修改日志投递任务操作不能为空 |
taskName | String | Body | 是 | test-taskName | 任务名称:用户自定义。支持最大64个字符 |
instanceConfig | Json | Body | 是 | 投递实例配置。根据不同的instanceType,配置会存在不同,详情见下表instanceType-1:{'instance':'','topic':'','username':'','password':''};instanceType-2:{'bucketName':'',endpoint:'',path:'',pattern:'',saveFormat:'',iscompress:'',size:'',timeInterval:''}", required = true) | |
instanceType | Integer | Body | 否 | 1 | 投递实例类型:1-Kafka;2-对象存储 |
processRange | String | Body | 是 | 1 | 投递范围:1-所有;2-某时间开始【默认】;3-特定时间范围 |
startTime | Long | Body | 否 | 1532568598 | 投递开始时间,单位毫秒 |
endTime | Long | Body | 否 | 1532569598 | 投递结束时间,单位毫秒 |
当instanceType=1,投递实例为Kafka时,instanceConfig的结构如下
名称 | 类型 | 位置 | 是否必选 | 示例 | 描述 |
---|---|---|---|---|---|
instance | String | Body | 是 | 1.1.1.1:1001 | Kafka实例 |
topic | String | Body | 是 | jason2023070305 | Topic |
username | String | Body | 是 | root | 用户名 |
password | String | Body | 是 | U2FsdGVkX18JgZKhKY2Yn2A84 | 密码 |
当instanceType=2,投递实例为对象存储(OSS)时,instanceConfig的结构如下
名称 | 类型 | 位置 | 是否必选 | 示例 | 描述 |
---|---|---|---|---|---|
bucketName | String | Body | 是 | bucket-028-1 | 对象存储Bucket |
endpoint | String | Body | 否 | http://10:125:155:1 | Endpoint |
path | String | Body | 否 | "" | 从应用日志服务投递到对象存储的数据将存放到Bucket的该目录下,若未设置,则默认在根目录下 |
pattern | String | Body | 否 | %Y%m%s%H%M | 按照投递任务的创建时间动态生成对象存储Bucket目录,不能以正斜线(/)开头,默认值为%Y%m%s%H%M |
saveFormat | String | Body | 是 | JSON | 存储格式:目前仅支持JSON存储格式 |
isCompressed | Boolean | Body | 是 | True | 是否压缩:True;False |
size | String | Body | 是 | 256 | 投递大小:自动控制投递任务创建间隔并设置对象存储的一个Object大小(以未压缩计算)上线,单位:MB,范围5~256 |
timeInterval | String | Body | 是 | 300 | 最多相隔多长时间投递一次数据,单位:秒,取值范围:300~900 |
返回数据
名称 | 类型 | 示例 | 描述 |
---|---|---|---|
code | Integer | 0 | 返回状态码 |
data | Long | 10001 | 创建或修改日志投递任务taskId |
msg | String | "" | 返回信息 |
示例
请求示例
POST /paasopenapi/api/cmplogadmin/cmplog/tenant/dataSend/addOrUpdate HTTP/1.1{
"dataType": "2",
"endTime": 1532569598,
"instanceConfig": {
"instance": "1.1.1.1:1001",
"topic": "jason2023070305",
"username":"root",
"password":"U2FsdGVkX18JgZKhKY2Yn2A84"
},
"instanceType": 1,
"originProjectId": 400,
"originProjectName": "test-originUnitName",
"originUnitId": 2600,
"originUnitName": "test-originUnitName",
"processRange": "3",
"resPoolCode": "bbd132b53a11e9b0e40242ac11000",
"startTime": 1532568598,
"taskId": "10001",
"taskName": "test-taskName"
}
正常返回示例
{
"code":0,
"data":10001,
"msg":""
}
错误码
HTTP状态码(Status Code) | 错误码(Error Code) | 描述(Description) |
---|---|---|
400 | MissingParameter | 缺少必要的请求参数。 |
400 | InvalidParameterValue | 请求参数取值错误。 |
409 | TaskAlreadyExist | 任务名称已存在 |
409 | TaskOverLimit | 任务数量已达到上限 |
500 | FailedOperation | 操作失败 |