删除日志转储
功能介绍
该接口用于删除OBS转储,DIS转储,DMS转储。
调用方法
请参见如何调用API。
URI
DELETE /v2/{project_id}/transfers
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
project_id |
是 |
String |
项目ID,获取方式请参见:获取项目ID,获取账号ID,日志组ID、日志流ID |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
log_transfer_id |
是 |
String |
日志转储ID。获取ID有3种方式: 1. 调用查询日志转储接口,返回值有日志转储ID 2. 调用新增日志转储接口,返回值有日志转储ID |
请求参数
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
X-Auth-Token |
是 |
String |
从IAM服务获取的用户Token,获取方式请参见:获取用户Token |
Content-Type |
是 |
String |
该字段填为:application/json;charset=UTF-8。 |
响应参数
状态码: 200
参数 |
参数类型 |
描述 |
---|---|---|
log_group_id |
String |
日志组ID |
log_group_name |
String |
日志组名称 |
log_streams |
Array of log_streams objects |
日志流集合 |
log_transfer_id |
String |
日志转储ID |
log_transfer_info |
log_transfer_info_RespBody object |
日志转储信息 |
参数 |
参数类型 |
描述 |
---|---|---|
log_agency_transfer |
log_agency_transfer object |
委托转储信息。若转储为委托转储,则会返回该参数 |
log_create_time |
Integer |
日志转储创建时间 |
log_storage_format |
String |
日志转储格式。只支持"RAW", "JSON"。RAW是指原始日志格式,JSON是指JSON日志格式。OBS转储和DIS转储支持JSON和RAW,DMS转储仅支持RAW |
log_transfer_detail |
TransferDetail object |
日志转储详细信息 |
log_transfer_mode |
String |
日志转储方式。cycle是指周期性转储,realTime是指实时转储。OBS转储只支持"cycle",DIS转储和DMS转储只支持"realTime"。 |
log_transfer_status |
String |
日志转储状态,ENABLE是指日志转储开启状态,DISABLE是指日志转储关闭状态,EXCEPTION是指日志转储异常状态 |
log_transfer_type |
String |
日志转储类型。OBS指OBS日志转储,DIS指DIS日志转储,DMS指DMS日志转储。 |
参数 |
参数类型 |
描述 |
---|---|---|
agency_domain_id |
String |
委托方账号ID |
agency_domain_name |
String |
委托方账号名称 |
agency_name |
String |
委托方配置的委托名称 |
agency_project_id |
String |
委托方项目ID |
be_agency_domain_id |
String |
被委托方账号ID,实际配置转储的账号ID |
be_agency_project_id |
String |
被委托方项目ID,实际配置转储的账号的项目ID |
参数 |
参数类型 |
描述 |
---|---|---|
obs_period |
Integer |
OBS转储时间。当创建OBS转储时,必填此参数。与obs_period_unit组合,即"obs_period"+"obs_period_unit",必须是"2min", "5min", "30min", "1hour", "3hour", "6hour","12hour"。 |
obs_period_unit |
String |
OBS转储单位。当创建OBS转储时,必填此参数。与obs_period_unit组合,即"obs_period"+"obs_period_unit",必须是"2min", "5min", "30min", "1hour", "3hour", "6hour","12hour"。 |
obs_bucket_name |
String |
OBS日志桶名称。当创建OBS转储时,必填此参数。 最小长度:3 最大长度:63 |
obs_encrypted_id |
String |
OBS转储KMS密钥ID。根据OBS转储日志桶是否加密判断,若OBS转储日志桶加密则必须填写该参数,若OBS转储日志桶则不需要此参数。 最小长度:36 最大长度:36 |
obs_dir_pre_fix_name |
String |
OBS转储自定义转储路径。当创建OBS转储时,根据需要选填此参数。 正则约束: ^(/)?([a-zA-Z0-9.-]+)(/[a-zA-Z0-9.-]+)*(/)?$ 最小长度:1 最大长度:64 |
obs_prefix_name |
String |
OBS转储日志文件前缀。当创建OBS转储时,根据需要选填此参数。 正则约束: ^[a-zA-Z0-9._-]*$ 最小长度:1 最大长度:64 |
obs_time_zone |
String |
OBS转储时区,参数选择请参考OBS转储时区表。如果选择该参数,则必须选择obs_time_zone_id。 |
obs_time_zone_id |
String |
OBS转储时区ID,参数选择请参考OBS转储时区表。如果选择该参数,则必须选择obs_time_zone。 |
dis_id |
String |
DIS转储通道ID。当创建DIS转储时,必填此参数。 最小长度:1 最大长度:128 |
dis_name |
String |
DIS转储通道名称。当创建DIS转储时,必填此参数。 最小长度:1 最大长度:128 |
kafka_id |
String |
DMS转储kafka ID。当创建DMS转储时,必填此参数。 创建DMS转储前,需要使用kafka ID以及kafka Topic进行实例注册。详情见接口注册DMSkafka实例 |
kafka_topic |
String |
DMS转储kafka topic。 创建DMS转储前,需要使用kafka ID以及kafka Topic进行实例注册。详情见接口注册DMSkafka实例 |
obs_transfer_path |
String |
OBS转储路径,指OBS日志桶中的路径。 |
obs_eps_id |
String |
OBS企业项目ID。 |
obs_encrypted_enable |
Boolean |
OBS是否开启加密。 |
tags |
Array of strings |
若开启tag投递,该字段必须包含主机信息:hostIP、hostId、hostName、pathFile、collectTime; 公共字段有:logStreamName、regionName、logGroupName、projectId,为可选填; 开启转储标签:streamTag,可选填 |
状态码: 400
参数 |
参数类型 |
描述 |
---|---|---|
error_code |
String |
错误码。 |
error_msg |
String |
调用失败响应信息描述。 |
状态码: 500
参数 |
参数类型 |
描述 |
---|---|---|
error_code |
String |
错误码。 |
error_msg |
String |
调用失败响应信息描述。 |
请求示例
根据日志转储ID,删除日志转储
DELETE https://{endpoint}/v2/{project_id}/transfers /v2/{project_id}/transfers?log_transfer_id=cfc43c45-9edc-4a03-8578-0eb00cxxxxxx
响应示例
状态码: 200
删除转储请求响应成功。
{ "log_group_id" : "9a7e2183-2d6d-4732-9a9b-e897fd4e49e0", "log_group_name" : "lts-group-kafka", "log_streams" : [ { "log_stream_id" : "839dac89-35af-4db2-ab4a-a7dda0d0d3f8", "log_stream_name" : "lts-topic-kafka" } ], "log_transfer_id" : "ddced522-233a-4181-a5fc-7b458c819afc", "log_transfer_info" : { "log_create_time" : 1634802241847, "log_storage_format" : "JSON", "log_agency_transfer" : { "agency_domain_id" : "1d26cc8c86a840e28a4f8d0d078xxxxx", "agency_domain_name" : "paas_apm_z004xxxxx_xx", "agency_name" : "test20210325", "agency_project_id" : "2a473356cca5487f8373be891bfxxxxx", "be_agency_domain_id" : "1d26cc8c86a840e28a4f8d0d078xxxxx", "be_agency_project_id" : "2a473356cca5487f8373be891bfxxxxx" }, "log_transfer_detail" : { "obs_period" : 2, "obs_prefix_name" : "", "obs_period_unit" : "min", "obs_transfer_path" : "/0002/LogTanks/xxx/", "obs_bucket_name" : "0002", "obs_encrypted_enable" : false, "obs_dir_pre_fix_name" : "", "obs_time_zone" : "UTC+01:00", "obs_time_zone_id" : "Africa/Lagos", "dis_id" : "xxxxx", "dis_name" : "xxxxxx", "kafka_id" : "xxxxxx", "kafka_topic" : "xxxxx" }, "log_transfer_mode" : "cycle", "log_transfer_status" : "ENABLE", "log_transfer_type" : "OBS" } }
状态码: 400
BadRequest 非法请求 建议根据error_msg直接修改该请求。
{ "error_code" : "LTS.0405", "error_msg" : "The log transfer does not existed" }
状态码: 500
表明服务端能被请求访问到,但是服务内部出错。
{ "error_code" : "LTS.0010", "error_msg" : "The system encountered an internal error" }
状态码
状态码 |
描述 |
---|---|
200 |
删除转储请求响应成功。 |
400 |
BadRequest 非法请求 建议根据error_msg直接修改该请求。 |
500 |
表明服务端能被请求访问到,但是服务内部出错。 |
错误码
请参见错误码。