华为云用户手册

  • 响应示例 状态码: 200 请求响应成功。 { "request_id" : "1", "topic_count" : 100, "topics" : [ { "name" : "huawei", "topic_urn" : "urn:smn:cn-north-7:{projectId}:fyy", "display_name" : "", "push_policy" : 0 } ] }
  • 响应参数 状态码: 200 表4 响应Body参数 参数 参数类型 描述 request_id String request_id 最小长度:1 最大长度:64 topic_count Integer topics数量 最小值:0 最大值:1000 topics Array of Topics objects 主题信息 表5 Topics 参数 参数类型 描述 name String 主题名称。 最小长度:1 最大长度:1024 topic_urn String Topic的唯一的资源标识。 最小长度:1 最大长度:1024 display_name String Topic的显示名,推送邮件消息时,作为邮件发件人显示。 最小长度:1 最大长度:1024 push_policy Integer 消息推送的策略。 最小值:1 最大值:1024
  • URI GET /v2/{project_id}/lts/notifications/topics 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID,账号ID,日志组ID、日志流ID,获取方式请参见:获取项目ID,获取账号ID,日志组ID、日志流ID 缺省值:None 最小长度:32 最大长度:32 表2 Query参数 参数 是否必选 参数类型 描述 offset 是 Integer 查询游标,初始传入0,后续从上一次的返回值中获取。 最小值:0 最大值:1024 limit 是 Integer 每页数据量,最大值为100。 最小值:0 最大值:100 fuzzy_name 否 String 检索的主题名称,模糊匹配,按照startwith模式进行匹配。
  • 请求参数 表3 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 从 IAM 服务获取的用户Token,获取方式请参见:获取用户Token 缺省值:None 最小长度:1000 最大长度:2000 Content-Type 是 String 该字段填为:application/json;charset=UTF-8。 缺省值:None 最小长度:30 最大长度:30
  • 响应示例 状态码: 200 更新主机组请求响应成功 { "host_group_id" : "598c77aa-c69b-42f0-8cb8-983178b38", "host_group_name" : "devspore_app_dzhou1", "host_group_type" : "linux", "host_id_list" : [ "dc1dab7e-b045-4e77-bda4-914d3f7", "xxxxx" ], "host_group_tag" : [ { "key" : "xxx", "value" : "xxx" }, { "key" : "xxx", "value" : "xxx" } ], "create_time" : 16351494332, "update_time" : 16351494332 } 状态码: 400 非法请求 建议根据error_msg直接修改该请求。 { "error_code" : "LTS.1807", "error_msg" : "Invalid host group id" } 状态码: 500 表明服务端能被请求访问到,但是服务内部出错。 { "error_code" : "LTS.0010", "error_msg" : "Internal Server Error" }
  • 响应参数 状态码: 200 表5 响应Body参数 参数 参数类型 描述 host_group_id String 主机组ID 最小长度:36 最大长度:36 host_group_name String 主机组名称 最小长度:1 最大长度:64 host_group_type String 主机组类型。linux:linux类型,windows:windows类型 枚举值: linux windows host_id_list Array of strings 主机ID列表 host_group_tag Array of HostGroupTag objects 标签信息。最多支持20个标签。 create_time Long 创建时间 最小值:0 最大值:9999999999999 update_time Long 更新时间 最小值:0 最大值:9999999999999 表6 HostGroupTag 参数 参数类型 描述 key String 标签Key 最小长度:1 最大长度:128 value String 标签Value 最小长度:0 最大长度:255 状态码: 400 表7 响应Body参数 参数 参数类型 描述 error_code String 错误码 最小长度:8 最大长度:8 error_msg String 错误描述 最小长度:1 最大长度:1000 状态码: 500 表8 响应Body参数 参数 参数类型 描述 error_code String 错误码 最小长度:8 最大长度:8 error_msg String 错误描述 最小长度:1 最大长度:1000
  • 请求示例 更新主机组,host_group_id为必填参数。 PUT https://{endpoint}/v3/{project_id}/lts/host-group { "host_group_id" : "xxxxxx", "host_group_name" : "qweqwe", "host_id_list" : [ "host_id_1", "host_id_2" ], "host_group_tag" : [ { "key" : "xxx", "value" : "xxx" } ] }
  • 请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 从IAM服务获取的用户Token,获取方式请参见:获取用户Token 最小长度:1 最大长度:10000 Content-Type 是 String 该字段填为:application/json;charset=UTF-8。 最小长度:30 最大长度:30 表3 请求Body参数 参数 是否必选 参数类型 描述 host_group_id 是 String 主机组ID 最小长度:36 最大长度:36 host_group_name 否 String 主机组名称 最小长度:1 最大长度:64 host_id_list 否 Array of strings 主机ID列表。主机类型必须与主机组类型一致 最小长度:36 最大长度:36 host_group_tag 否 Array of HostGroupTag objects 主机组标签。KEY不能重复 表4 HostGroupTag 参数 是否必选 参数类型 描述 key 否 String 标签Key 最小长度:1 最大长度:128 value 否 String 标签Value 最小长度:0 最大长度:255
  • 响应示例 状态码: 200 查询直方图数据请求响应成功 { "count" : 1, "histogram" : [ { "num" : 1, "startTime" : 1637821594579, "endTime" : 1637821595000 }, { "num" : 0, "startTime" : 1637821654000, "endTime" : 1637821654579 } ] } 状态码: 400 BadRequest 非法请求建议根据error_msg直接修改该请求。 { "error_code" : "LTS.0601", "error_msg" : "must be less than or equal to 86400000" }
  • 请求示例 查询日志直方图 POST https://{endpoint}/v2/{project_id}/lts/keyword-count { "group_id" : "00330565-5baf-4e0d-bd16-ba0c6b951d9a", "stream_id" : "715cda3b-e17f-492a-a6ca-98a1ba16ad8c", "end_time" : 1637820813605, "start_time" : 1637817213605, "key_word" : "test", "step_interval" : 6000 }
  • 响应参数 状态码: 200 表4 响应Body参数 参数 参数类型 描述 count Long 日志条数 histogram String 直方图结果 isQueryComplete Boolean 是否查询完成 状态码: 400 表5 响应Body参数 参数 参数类型 描述 error_code String 错误码。 最小长度:8 最大长度:8 error_msg String 调用失败响应信息描述。 状态码: 500 表6 响应Body参数 参数 参数类型 描述 error_code String 错误码。 最小长度:8 最大长度:8 error_msg String 调用失败响应信息描述。
  • 请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 从IAM服务获取的用户Token,获取方式请参见:获取用户Token 最小长度:1000 最大长度:2000 Content-Type 是 String 该字段填为:application/json;charset=UTF-8。 最小长度:30 最大长度:30 表3 请求Body参数 参数 是否必选 参数类型 描述 start_time 是 String 开始时间 end_time 是 String 结束时间 step_interval 是 Long 时间步长,单位为毫秒(ms)。 具体请参考如下公式计算: (end_time-start_time) / 1000 * 1000 / 60,其中 / 1000 * 1000 / 表示取整。 说明: 如果计算出的时间步长小于等于1000时,则时间步长为1000。 group_id 是 String 日志组ID 最小长度:36 最大长度:36 stream_id 是 String 日志流ID 最小长度:36 最大长度:36 key_word 是 String 关键词指相邻两个分词符之间的单词。 is_iterative 否 Boolean 日志迭代查询,默认为false(不开启迭代),true为开启迭代。 枚举值: true
  • 创建OBS转储 接口相关信息 URI格式:POST /v2/{project_id}/log-dump/obs 请求示例 POST https://{endpoint}/v2/{project_id}/log-dump/obs {endpoint}信息请从终端节点获取。 Body: { "log_group_id": "d9dba9f3-xxxx-48bd-xxxx-xxxxa24a8053", "log_stream_ids": ["45e7f609-xxxx-4cd3-835b-xxxx4a124718"], "obs_bucket_name": "lts-test", "type": "cycle", "storage_format": "RAW", "switch_on": "true", "prefix_name": "fileprefixname", "dir_prefix_name": "dirprefixname", "period": 5, "period_unit": "min" } 响应示例 { "log_dump_obs_id" : "45fdc36b-xxxx-4567-xxxx-559xxxxdf968" }
  • 状态码 状态码 描述 200 请求响应成功。 201 请求响应成功。 400 BadRequest。非法请求。 建议根据error_msg直接修改该请求,不要重试该请求。 403 Forbidden。请求被拒绝访问。返回该状态码,表明请求能够到达服务端,且服务端能够理解用户请求,但是拒绝做更多的事情,因为该请求被设置为拒绝访问,建议直接修改该请求,不要重试该请求。 500 InternalServerError。 表明服务端能被请求访问到,但是服务内部出错。
  • 响应示例 状态码: 200 请求响应成功。 获取日志组。 { "error_code" : "LTS.0201", "error_msg" : "The log group does not existed" } 获取日志流。 { "error_code" : "LTS.0208", "error_msg" : "Log stream id does not exist: 632b9bdc-5afd-4666-a5de-2579f8b80314-" } 设置转储OBS桶。 { "error_code" : "LTS.0416", "error_msg" : "obs bucket does not exist: zhuanchu" } 日志流ID被关联。 { "error_code" : "LTS.0207", "error_msg" : "Log stream id is associated by transfer: 632b9bdc-5afd-4666-a5de-2579f8b80314" } 设置转储类型。 { "error_code" : "LTS.1901", "error_msg" : "type is not in the list [cycle]" } 设置转储格式。 { "error_code" : "LTS.1901", "error_msg" : "storage_format is not in the list [RAW, JSON]" } 设置转储周期。 { "error_code" : "LTS.1901", "error_msg" : "period+period_unit is not in the list [2min, 5min, 30min, 1hour, 3hour, 6hour, 12hour]" } 设置转储单位。 { "error_code" : "LTS.1901", "error_msg" : "period_unit is not in the list [min, hour]" } 设置转储日志文件前缀。 { "error_code" : "LTS.1902", "error_msg" : "prefix_name is invalid, please verify if it's provided as required" } 设置自定义转储路径。 { "error_code" : "LTS.1902", "error_msg" : "dir_prefix_name is invalid, please verify if it's provided as required" } 状态码: 201 请求响应成功。 { "log_dump_obs_id" : "45fdc36b-xxxx-4567-xxxx-559xxxxdf968" } 状态码: 400 BadRequest。非法请求。 建议根据error_msg直接修改该请求,不要重试该请求。 BadRequest。非法请求。建议根据error_msg直接修改该请求,不要重试该请求。 { "error_code": "LTS.0007", "error_msg": "The request body format must be json" } 状态码: 403 Forbidden。请求被拒绝访问。返回该状态码,表明请求能够到达服务端,且服务端能够理解用户请求,但是拒绝做更多的事情,因为该请求被设置为拒绝访问,建议直接修改该请求,不要重试该请求。 { "error_code" : "LTS.0001", "error_msg" : "Invalid projectId" } 状态码: 500 InternalServerError。 表明服务端能被请求访问到,但是服务内部出错。 InternalServerError。表明服务端能被请求访问到,但是服务内部出错。 { "error_code": "LTS.0010", "error_msg": "Internal Server Error"}
  • 请求示例 创建日志转储 POST https://{endpoint}/v2/{project_id}/log-dump/obs { "log_group_id" : "d9dba9f3-xxxx-48bd-xxxx-xxxxa24a8053", "log_stream_ids" : [ "45e7f609-xxxx-4cd3-835b-xxxx4a124718" ], "obs_bucket_name" : "lts-test", "type" : "cycle", "storage_format" : "RAW", "switch_on" : "true", "prefix_name" : "fileprefixname", "dir_prefix_name" : "dirprefixname", "period" : 5, "period_unit" : "min" }
  • 响应参数 状态码: 201 表4 响应Body参数 参数 参数类型 描述 log_dump_obs_id String 转储id。 缺省值:None 最小长度:36 最大长度:36 状态码: 400 表5 响应Body参数 参数 参数类型 描述 error_code String 错误码。 枚举值: LTS.0007 error_msg String 调用失败响应信息描述。 枚举值: The request body format must be json 状态码: 403 表6 响应Body参数 参数 参数类型 描述 error_code String 错误码。 枚举值: LTS.0403 error_msg String 调用失败响应信息描述。 枚举值: Invalid projectId 状态码: 500 表7 响应Body参数 参数 参数类型 描述 error_code String 错误码。 枚举值: LTS.0403 error_msg String 调用失败响应信息描述。 枚举值: Invalid projectId
  • 响应示例 状态码: 200 删除主机组列表请求响应成功 { "result" : [{ "host_group_id" : "598c77aa-c69b-42f0-8cb8-xxxx5b38", "host_group_name" : "devspoxxxou1", "host_group_type" : "lxxux", "host_id_list" : ["dc1dab7e-b04xxxx", "xxxxx"], "host_group_tag" : [{ "key" : "xxx", "value" : "xxx" }, { "key" : "xxx", "value" : "xxx" } ], "create_time" : 1635xx9410332, "update_time" : 163xx0332 } ], "total" : 1 } 状态码: 400 非法请求 建议根据error_msg直接修改该请求。 { "error_code" : "LTS.1807", "error_msg" : "Invalid host group id" } 状态码: 500 表明服务端能被请求访问到,但是服务内部出错。 { "error_code" : "LTS.0010", "error_msg" : "Internal Server Error" }
  • 请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 从IAM服务获取的用户Token,获取方式请参见:获取用户Token 最小长度:1 最大长度:10000 Content-Type 是 String 该字段填为:application/json;charset=UTF-8。 最小长度:30 最大长度:30 表3 请求Body参数 参数 是否必选 参数类型 描述 host_group_id_list 是 Array of strings 主机组ID列表 最小长度:36 最大长度:36
  • 响应参数 状态码: 200 表4 响应Body参数 参数 参数类型 描述 result Array of GetHostGroupInfo objects 主机组详细信息 total Long 删除主机组数量 最小值:0 最大值:1000 表5 GetHostGroupInfo 参数 参数类型 描述 host_group_id String 主机组ID 最小长度:36 最大长度:36 host_group_name String 主机组名称 最小长度:1 最大长度:64 host_group_type String 主机组类型。linux:linux类型,windows:windows类型 枚举值: linux windows host_id_list Array of strings 主机ID列表 最小长度:36 最大长度:36 host_group_tag Array of HostGroupTagResBody objects 标签信息. create_time Long 创建时间 最小值:0 最大值:9999999999999 update_time Long 更新时间 最小值:0 最大值:9999999999999 表6 HostGroupTagResBody 参数 参数类型 描述 key String 标签Key 最小长度:1 最大长度:36 value String 标签Value 最小长度:1 最大长度:36 状态码: 400 表7 响应Body参数 参数 参数类型 描述 error_code String 错误码 最小长度:8 最大长度:8 error_msg String 错误描述 最小长度:1 最大长度:1000 状态码: 500 表8 响应Body参数 参数 参数类型 描述 error_code String 错误码 最小长度:8 最大长度:8 error_msg String 错误描述 最小长度:1 最大长度:1000
  • 响应示例 状态码: 200 创建转储请求响应成功。 当创建OBS转储时,会返回如下参数 { "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/cn-north-7/", "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", "tags" : [ ] }, "log_transfer_mode" : "cycle", "log_transfer_status" : "ENABLE", "log_transfer_type" : "OBS" } } 当创建DIS转储时,会返回如下参数 { "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" : { "dis_id" : "xxxxx", "dis_name" : "xxxxxx", "tags" : [ ] }, "log_transfer_mode" : "cycle", "log_transfer_status" : "ENABLE", "log_transfer_type" : "OBS" } } 当创建DMS转储时,会返回如下参数 { "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" : { "kafka_id" : "xxxxxx", "kafka_topic" : "xxxxx", "tags" : [ ] }, "log_transfer_mode" : "cycle", "log_transfer_status" : "ENABLE", "log_transfer_type" : "OBS" } } 状态码: 400 BadRequest 非法请求 建议根据error_msg直接修改该请求。 { "error_code" : "LTS.0207", "error_msg" : "The log stream is associated by transfer" } 状态码: 500 InternalServerError。表明服务端能被请求访问到,但是服务内部出错。 { "error_code" : "LTS.0207", "error_msg" : "The log stream is associated by transfer" }
  • 请求示例 创建OBS转储 POST https://{endpoint}/v2/{project_id}/transfers { "log_group_id" : "8ba9e43f-be60-4d8c-9015-xxxxxxxxxxxx", "log_streams" : [ { "log_stream_id" : "c776e1a7-8548-430a-afe5-xxxxxxxxxxxx" } ], "log_transfer_info" : { "log_transfer_type" : "OBS", "log_transfer_mode" : "xxxxx", "log_storage_format" : "XXX", "log_transfer_status" : "XXXXX", "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_period_unit" : "min", "obs_bucket_name" : "xxxxx", "obs_encrypted_id" : "1bd90032-1424-481f-8558-ba49854xxxxx", "obs_dir_pre_fix_name" : "xx", "obs_prefix_name" : "xxxxx", "obs_time_zone" : "UTC+01:00", "obs_time_zone_id" : "Africa/Lagos" } } } 创建DIS转储 POST https://{endpoint}/v2/{project_id}/transfers { "log_group_id" : "8ba9e43f-be60-4d8c-9015-xxxxxxxxxxxx", "log_streams" : [ { "log_stream_id" : "c776e1a7-8548-430a-afe5-xxxxxxxxxxxx" } ], "log_transfer_info" : { "log_transfer_type" : "DIS", "log_transfer_mode" : "xxxxx", "log_storage_format" : "XXX", "log_transfer_status" : "XXXXX", "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" : { "dis_id" : "i1y8vfMTvf4LQzxxxxx", "dis_name" : "xxxxx" } } }
  • 响应参数 状态码: 200 表8 响应Body参数 参数 参数类型 描述 log_group_id String 日志组ID 最小长度:36 最大长度:36 log_group_name String 日志组名称 最小长度:1 最大长度:64 log_streams Array of log_streams objects 日志流集合 log_transfer_id String 日志转储ID 最小长度:36 最大长度:36 log_transfer_info log_transfer_info_RespBody object 日志转储信息 表9 log_streams 参数 参数类型 描述 log_stream_id String 日志流ID 最小长度:36 最大长度:36 log_stream_name String 日志流名称 最小长度:1 最大长度:64 表10 log_transfer_info_RespBody 参数 参数类型 描述 log_agency_transfer log_agency_transfer object 委托转储信息。若转储为委托转储,则会返回该参数 log_create_time Integer 日志转储创建时间 最小值:0 最大值:2147483647 log_storage_format String 日志转储格式。只支持"RAW", "JSON"。RAW是指原始日志格式,JSON是指JSON日志格式。OBS转储和DIS转储支持JSON和RAW,DMS转储仅支持RAW 枚举值: JSON RAW log_transfer_detail TransferDetail object 日志转储详细信息 log_transfer_mode String 日志转储方式。cycle是指周期性转储,realTime是指实时转储。OBS转储只支持"cycle",DIS转储和DMS转储只支持"realTime"。 枚举值: cycle realTime log_transfer_status String 日志转储状态,ENABLE是指日志转储开启状态,DISABLE是指日志转储关闭状态,EXCEPTION是指日志转储异常状态 枚举值: ENABLE DISABLE EXCEPTION log_transfer_type String 日志转储类型。OBS指OBS日志转储,DIS指DIS日志转储,DMS指DMS日志转储。 枚举值: OBS DIS DMS 表11 log_agency_transfer 参数 参数类型 描述 agency_domain_id String 委托方账号ID 最小长度:1 最大长度:128 agency_domain_name String 委托方账号名称 最小长度:1 最大长度:128 agency_name String 委托方配置的委托名称 最小长度:1 最大长度:128 agency_project_id String 委托方项目ID 最小长度:32 最大长度:32 be_agency_domain_id String 被委托方账号ID,实际配置转储的账号ID 最小长度:1 最大长度:128 be_agency_project_id String 被委托方项目ID,实际配置转储的账号的项目ID 最小长度:32 最大长度:32 表12 TransferDetail 参数 参数类型 描述 obs_period Integer OBS转储时间。当创建OBS转储时,必填此参数。与obs_period_unit组合,即"obs_period"+"obs_period_unit",必须是"2min", "5min", "30min", "1hour", "3hour", "6hour","12hour"。 枚举值: 1 2 3 5 6 12 30 obs_period_unit String OBS转储单位。当创建OBS转储时,必填此参数。与obs_period_unit组合,即"obs_period"+"obs_period_unit",必须是"2min", "5min", "30min", "1hour", "3hour", "6hour","12hour"。 枚举值: “min” “hour” obs_bucket_name String OBS日志桶名称。当创建OBS转储时,必填此参数。 最小长度:3 最大长度:63 最小长度:3 最大长度:63 obs_encrypted_id String OBS转储KMS秘钥ID。根据OBS转储日志桶是否加密判断,若OBS转储日志桶加密则必须填写该参数,若OBS转储日志桶则不需要此参数。 最小长度:36 最大长度:36 最小长度:36 最大长度:36 obs_dir_pre_fix_name String OBS转储自定义转储路径。当创建OBS转储时,根据需要选填此参数。 正则约束: ^(/)?([a-zA-Z0-9.-]+)(/[a-zA-Z0-9.-]+)*(/)?$ 最小长度:1 最大长度:64 最小长度:1 最大长度:64 obs_prefix_name String OBS转储日志文件前缀。当创建OBS转储时,根据需要选填此参数。 正则约束: ^[a-zA-Z0-9._-]*$ 最小长度:1 最大长度:64 最小长度:1 最大长度:64 obs_time_zone String OBS转储时区(https://support.huaweicloud.com/api-lts/lts_api_0111.html)。如果选择该参数,则必须选择obs_time_zone_id。 obs_time_zone_id String OBS转储时区ID(https://support.huaweicloud.com/api-lts/lts_api_0111.html)。参数选择参考OBS转储时区表。如果选择该参数,则必须选择obs_time_zone。 dis_id String DIS转储通道ID。当创建DIS转储时,必填此参数。 最小长度:1 最大长度:128 最小长度:1 最大长度:128 dis_name String DIS转储通道名称。当创建DIS转储时,必填此参数。 最小长度:1 最大长度:128 最小长度:1 最大长度:128 kafka_id String DMS转储kafka ID。当创建DMS转储时,必填此参数。 创建DMS转储前,需要使用kafka ID以及kafka Topic进行实例注册。详情见接口注册DMSkafka实例 最小长度:36 最大长度:36 kafka_topic String DMS转储kafka topic。 创建DMS转储前,需要使用kafka ID以及kafka Topic进行实例注册。详情见接口注册DMSkafka实例 最小长度:1 最大长度:128 obs_transfer_path String OBS转储路径,指OBS日志桶中的路径。 最小长度:0 最大长度:256 obs_eps_id String OBS企业项目ID。 最小长度:0 最大长度:128 obs_encrypted_enable Boolean OBS是否开启加密。 枚举值: true false tags Array of strings 若开启tag投递,该字段必须包含主机信息:hostIP、hostId、hostName、pathFile、collectTime; 公共字段有:logStreamName、regionName、logGroupName、projectId,为可选填; 开启转储标签:streamTag,可选填 状态码: 400 表13 响应Body参数 参数 参数类型 描述 error_code String 错误码。 最小长度:8 最大长度:8 error_msg String 调用失败响应信息描述。 状态码: 500 表14 响应Body参数 参数 参数类型 描述 error_code String 错误码。 最小长度:8 最大长度:8 error_msg String 调用失败响应信息描述。
  • 请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 从IAM服务获取的用户Token,获取方式请参见:获取用户Token 最小长度:1000 最大长度:2000 Content-Type 是 String 该字段填为:application/json;charset=UTF-8。 最小长度:30 最大长度:30 表3 请求Body参数 参数 是否必选 参数类型 描述 log_group_id 是 String 日志组ID 最小长度:36 最大长度:36 最小长度:36 最大长度:36 log_streams 是 Array of LogStreams objects 日志流ID集合 log_transfer_info 是 log_transfer_info object 日志转储信息 表4 LogStreams 参数 是否必选 参数类型 描述 log_stream_id 是 String 日志流ID 最小长度:36 最大长度:36 log_stream_name 否 String 日志流名称 表5 log_transfer_info 参数 是否必选 参数类型 描述 log_transfer_type 是 String 日志转储类型。OBS指OBS日志转储,DIS指DIS日志转储,DMS指DMS日志转储。 log_transfer_mode 是 String 日志转储方式。cycle是指周期性转储,realTime是指实时转储。OBS转储只支持"cycle",DIS转储和DMS转储只支持"realTime" 枚举值: cycle realTime log_storage_format 是 String 日志转储格式。只支持"RAW", "JSON"。RAW是指原始日志格式,JSON是指JSON日志格式。OBS转储和DIS转储支持JSON和RAW,DMS转储仅支持RAW。 枚举值: JSON RAW log_transfer_status 是 String 日志转储状态,只支持"ENABLE","DISABLE","EXCEPTION"。ENABLE是指日志转储开启状态,DISABLE是指日志转储关闭状态,EXCEPTION是指日志转储异常状态 枚举值: ENABLE DISABLE EXCEPTION log_agency_transfer 否 log_agency_transfer object 委托转储信息。若配置委托转储,则需要输入该参数 log_transfer_detail 是 log_transfer_detail object 日志转储详细信息 表6 log_agency_transfer 参数 是否必选 参数类型 描述 agency_domain_id 是 String 委托方账号ID 最小长度:1 最大长度:128 agency_domain_name 是 String 委托方账号名称 最小长度:1 最大长度:128 agency_name 是 String 委托方配置的委托名称 最小长度:1 最大长度:128 agency_project_id 是 String 委托方项目ID 最小长度:32 最大长度:32 be_agency_domain_id 是 String 被委托方账号ID,实际配置转储的账号ID 最小长度:1 最大长度:128 be_agency_project_id 是 String 被委托方项目ID,实际配置转储的账号的项目ID 最小长度:32 最大长度:32 表7 log_transfer_detail 参数 是否必选 参数类型 描述 obs_period 是 Integer OBS转储时间。当创建OBS转储时,必填此参数。与obs_period_unit组合,即"obs_period"+"obs_period_unit",必须是"2min", "5min", "30min", "1hour", "3hour", "6hour","12hour"。 枚举值: 1 2 3 5 6 12 30 obs_period_unit 是 String OBS转储单位。当创建OBS转储时,必填此参数。与obs_period组合,即"obs_period"+"obs_period_unit",必须是"2min", "5min", "30min", "1hour", "3hour", "6hour","12hour"。 枚举值: min hour 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转储时,根据需要选填此参数。 最小长度:1 最大长度:64 obs_prefix_name 否 String OBS转储日志文件前缀。当创建OBS转储时,根据需要选填此参数。 最小长度: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 最大长度:64 kafka_id 否 String DMS转储kafka ID。当创建DMS转储时,必填此参数。创建DMS转储前,需要使用kafka ID以及kafka Topic进行实例注册。详情见接口注册DMSkafka实例 kafka_topic 否 String DMS转储kafka topic。当创建DMS转储时,必填此参数。创建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,可选填
  • 基本概念 账号 用户注册时的账号,账号对其所拥有的资源及云服务具有完全的访问权限,可以重置用户密码、分配用户权限等。由于账号是付费主体,为了确保账号安全,建议您不要直接使用账号进行日常管理工作,而是创建用户并使用该用户进行日常管理工作。 用户 由账号在IAM中创建的用户,是云服务的使用人员,具有身份凭证(密码和访问密钥)。 在我的凭证下,您可以查看账号ID和IAM用户ID。通常在调用API的鉴权过程中,您需要用到账号、用户和密码等信息。 区域(Region) 从地理位置和网络时延维度划分,同一个Region内共享弹性计算、块存储、对象存储、VPC网络、弹性公网IP、镜像等公共服务。Region分为通用Region和专属Region,通用Region指面向公共租户提供通用云服务的Region;专属Region指只承载同一类业务或只面向特定租户提供业务服务的专用Region。 详情请参见区域和可用区。 可用区(AZ,Availability Zone) 一个可用区是一个或多个物理数据中心的集合,有独立的风火水电,AZ内逻辑上再将计算、网络、存储等资源划分成多个集群。一个Region中的多个AZ间通过高速光纤相连,以满足用户跨AZ构建高可用性系统的需求。 项目 区域默认对应一个项目,这个项目由系统预置,用来隔离物理区域间的资源(计算资源、存储资源和网络资源),以默认项目为单位进行授权,用户可以访问您账号中该区域的所有资源。如果您希望进行更加精细的权限控制,可以在区域默认的项目中创建子项目,并在子项目中创建资源,然后以子项目为单位进行授权,使得用户仅能访问特定子项目中资源,使得资源的权限控制更加精确。 图1 项目隔离模型 同样在我的凭证下,您可以查看项目ID。 企业项目 企业项目是项目的升级版,针对企业不同项目间资源的分组和管理,是逻辑隔离。企业项目中可以包含多个区域的资源,且项目中的资源可以迁入迁出。 关于企业项目ID的获取及企业项目特性的详细信息,请参见《企业管理用户指南》。 父主题: 使用前必读
  • 请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 从IAM服务获取的用户Token,获取方式请参见:获取用户Token 缺省值:None 最小长度:1000 最大长度:2000 Content-Type 是 String 该字段填为:application/json;charset=UTF-8。 缺省值:None 最小长度:30 最大长度:30
  • 请求示例 更新OBS转储 PUT https://{endpoint}/v2/{project_id}/transfers { "log_transfer_id" : "9f74e101-b969-483c-a610-d3f3064xxxxx", "log_transfer_info" : { "log_storage_format" : "JSON", "log_transfer_status" : "DISABLE", "log_transfer_detail" : { "obs_period" : 3, "obs_period_unit" : "hour", "obs_bucket_name" : "0xxx", "obs_encrypted_id" : "1bd90032-1424-481f-8558-ba49854xxxxx", "obs_dir_pre_fix_name" : "xx", "obs_prefix_name" : "xxxxx", "obs_time_zone" : "UTC+01:00", "obs_time_zone_id" : "Africa/Lagos" } } } 更新DIS转储 PUT https://{endpoint}/v2/{project_id}/transfers { "log_transfer_id" : "9f74e101-b969-483c-a610-d3f3064xxxxx", "log_transfer_info" : { "log_storage_format" : "JSON", "log_transfer_status" : "DISABLE", "log_transfer_detail" : { "dis_id" : "xxxxx", "dis_name" : "xxxxxx" } } } 更新DMS转储 PUT https://{endpoint}/v2/{project_id}/transfers { "log_transfer_id" : "9f74e101-b969-483c-a610-d3f3064xxxxx", "log_transfer_info" : { "log_storage_format" : "JSON", "log_transfer_status" : "DISABLE", "log_transfer_detail" : { "kafka_id" : "xxxxx", "kafka_topic" : "xxxxxx" } } }
  • 响应示例 状态码: 200 更新转储请求响应成功。 当创建OBS转储时,会返回如下参数 { "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/cn-north-7/", "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", "tags" : [ ] }, "log_transfer_mode" : "cycle", "log_transfer_status" : "ENABLE", "log_transfer_type" : "OBS" } } 当创建DIS转储时,会返回如下参数 { "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" : { "dis_id" : "xxxxx", "dis_name" : "xxxxxx", "tags" : [ ] }, "log_transfer_mode" : "cycle", "log_transfer_status" : "ENABLE", "log_transfer_type" : "OBS" } } 当创建DMS转储时,会返回如下参数 { "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" : { "kafka_id" : "xxxxxx", "kafka_topic" : "xxxxx", "tags" : [ ] }, "log_transfer_mode" : "cycle", "log_transfer_status" : "ENABLE", "log_transfer_type" : "OBS" } } 状态码: 400 BadRequest 非法请求 建议根据error_msg直接修改该请求。 { "error_code" : "LTS.0009", "error_msg" : "The Field transfer id is invalid or missing." } 状态码: 500 表明服务端能被请求访问到,但是服务内部出错。 { "error_code" : "LTS.0010", "error_msg" : "The system encountered an internal error" }
  • 响应参数 状态码: 200 表6 响应Body参数 参数 参数类型 描述 log_group_id String 日志组ID 最小长度:36 最大长度:36 log_group_name String 日志组名称 最小长度:1 最大长度:64 log_streams Array of log_streams objects 日志流集合 log_transfer_id String 日志转储ID 最小长度:36 最大长度:36 log_transfer_info log_transfer_info_RespBody object 日志转储信息 表7 log_streams 参数 参数类型 描述 log_stream_id String 日志流ID 最小长度:36 最大长度:36 log_stream_name String 日志流名称 最小长度:1 最大长度:64 表8 log_transfer_info_RespBody 参数 参数类型 描述 log_agency_transfer log_agency_transfer object 委托转储信息。若转储为委托转储,则会返回该参数 log_create_time Integer 日志转储创建时间 最小值:0 最大值:2147483647 log_storage_format String 日志转储格式。只支持"RAW", "JSON"。RAW是指原始日志格式,JSON是指JSON日志格式。OBS转储和DIS转储支持JSON和RAW,DMS转储仅支持RAW 枚举值: JSON RAW log_transfer_detail TransferDetail object 日志转储详细信息 log_transfer_mode String 日志转储方式。cycle是指周期性转储,realTime是指实时转储。OBS转储只支持"cycle",DIS转储和DMS转储只支持"realTime"。 枚举值: cycle realTime log_transfer_status String 日志转储状态,ENABLE是指日志转储开启状态,DISABLE是指日志转储关闭状态,EXCEPTION是指日志转储异常状态 枚举值: ENABLE DISABLE EXCEPTION log_transfer_type String 日志转储类型。OBS指OBS日志转储,DIS指DIS日志转储,DMS指DMS日志转储。 枚举值: OBS DIS DMS 表9 log_agency_transfer 参数 参数类型 描述 agency_domain_id String 委托方账号ID 最小长度:1 最大长度:128 agency_domain_name String 委托方账号名称 最小长度:1 最大长度:128 agency_name String 委托方配置的委托名称 最小长度:1 最大长度:128 agency_project_id String 委托方项目ID 最小长度:32 最大长度:32 be_agency_domain_id String 被委托方账号ID,实际配置转储的账号ID 最小长度:1 最大长度:128 be_agency_project_id String 被委托方项目ID,实际配置转储的账号的项目ID 最小长度:32 最大长度:32 表10 TransferDetail 参数 参数类型 描述 obs_period Integer OBS转储时间。当创建OBS转储时,必填此参数。与obs_period_unit组合,即"obs_period"+"obs_period_unit",必须是"2min", "5min", "30min", "1hour", "3hour", "6hour","12hour"。 枚举值: 1 2 3 5 6 12 30 obs_period_unit String OBS转储单位。当创建OBS转储时,必填此参数。与obs_period_unit组合,即"obs_period"+"obs_period_unit",必须是"2min", "5min", "30min", "1hour", "3hour", "6hour","12hour"。 枚举值: “min” “hour” obs_bucket_name String OBS日志桶名称。当创建OBS转储时,必填此参数。 最小长度:3 最大长度:63 最小长度:3 最大长度:63 obs_encrypted_id String OBS转储KMS秘钥ID。根据OBS转储日志桶是否加密判断,若OBS转储日志桶加密则必须填写该参数,若OBS转储日志桶则不需要此参数。 最小长度:36 最大长度:36 最小长度:36 最大长度:36 obs_dir_pre_fix_name String OBS转储自定义转储路径。当创建OBS转储时,根据需要选填此参数。 正则约束: ^(/)?([a-zA-Z0-9.-]+)(/[a-zA-Z0-9.-]+)*(/)?$ 最小长度:1 最大长度:64 最小长度:1 最大长度:64 obs_prefix_name String OBS转储日志文件前缀。当创建OBS转储时,根据需要选填此参数。 正则约束: ^[a-zA-Z0-9._-]*$ 最小长度:1 最大长度:64 最小长度:1 最大长度:64 obs_time_zone String OBS转储时区(https://support.huaweicloud.com/api-lts/lts_api_0111.html)。如果选择该参数,则必须选择obs_time_zone_id。 obs_time_zone_id String OBS转储时区ID(https://support.huaweicloud.com/api-lts/lts_api_0111.html)。参数选择参考OBS转储时区表。如果选择该参数,则必须选择obs_time_zone。 dis_id String DIS转储通道ID。当创建DIS转储时,必填此参数。 最小长度:1 最大长度:128 最小长度:1 最大长度:128 dis_name String DIS转储通道名称。当创建DIS转储时,必填此参数。 最小长度:1 最大长度:128 最小长度:1 最大长度:128 kafka_id String DMS转储kafka ID。当创建DMS转储时,必填此参数。 创建DMS转储前,需要使用kafka ID以及kafka Topic进行实例注册。详情见接口注册DMSkafka实例 最小长度:36 最大长度:36 kafka_topic String DMS转储kafka topic。 创建DMS转储前,需要使用kafka ID以及kafka Topic进行实例注册。详情见接口注册DMSkafka实例 最小长度:1 最大长度:128 obs_transfer_path String OBS转储路径,指OBS日志桶中的路径。 最小长度:0 最大长度:256 obs_eps_id String OBS企业项目ID。 最小长度:0 最大长度:128 obs_encrypted_enable Boolean OBS是否开启加密。 枚举值: true false tags Array of strings 若开启tag投递,该字段必须包含主机信息:hostIP、hostId、hostName、pathFile、collectTime; 公共字段有:logStreamName、regionName、logGroupName、projectId,为可选填; 开启转储标签:streamTag,可选填 状态码: 400 表11 响应Body参数 参数 参数类型 描述 error_code String 错误码。 最小长度:8 最大长度:8 error_msg String 调用失败响应信息描述。 状态码: 500 表12 响应Body参数 参数 参数类型 描述 error_code String 错误码。 最小长度:8 最大长度:8 error_msg String 调用失败响应信息描述。
  • 请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 从IAM服务获取的用户Token,获取方式请参见:获取用户Token 最小长度:1000 最大长度:2000 Content-Type 是 String 该字段填为:application/json;charset=UTF-8。 最小长度:30 最大长度:30 表3 请求Body参数 参数 是否必选 参数类型 描述 log_transfer_id 是 String 日志转储ID 最小长度:36 最大长度:36 log_transfer_info 是 update_log_transfer_info object 日志转储信息 表4 update_log_transfer_info 参数 是否必选 参数类型 描述 log_storage_format 是 String 日志转储格式。只支持"RAW", "JSON"。RAW是指原始日志格式,JSON是指JSON日志格式。OBS转储和DIS转储支持JSON和RAW,DMS转储仅支持RAW 枚举值: JSON RAW log_transfer_status 是 String 日志转储状态,ENABLE是指日志转储开启状态,DISABLE是指日志转储关闭状态,EXCEPTION是指日志转储异常状态 枚举值: ENABLE DISABLE EXCEPTION log_transfer_detail 是 log_transfer_detail object 日志转储详细信息 表5 log_transfer_detail 参数 是否必选 参数类型 描述 obs_period 是 Integer OBS转储时间。当创建OBS转储时,必填此参数。与obs_period_unit组合,即"obs_period"+"obs_period_unit",必须是"2min", "5min", "30min", "1hour", "3hour", "6hour","12hour"。 枚举值: 1 2 3 5 6 12 30 obs_period_unit 是 String OBS转储单位。当创建OBS转储时,必填此参数。与obs_period组合,即"obs_period"+"obs_period_unit",必须是"2min", "5min", "30min", "1hour", "3hour", "6hour","12hour"。 枚举值: min hour 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转储时,根据需要选填此参数。 最小长度:1 最大长度:64 obs_prefix_name 否 String OBS转储日志文件前缀。当创建OBS转储时,根据需要选填此参数。 最小长度: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 最大长度:64 kafka_id 否 String DMS转储kafka ID。当创建DMS转储时,必填此参数。创建DMS转储前,需要使用kafka ID以及kafka Topic进行实例注册。详情见接口注册DMSkafka实例 kafka_topic 否 String DMS转储kafka topic。当创建DMS转储时,必填此参数。创建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,可选填
共100000条