华为云用户手册

  • 响应示例 状态码: 200 查询转储请求响应成功。 当查询OBS转储时,会返回如下参数 { "log_transfers" : [ { "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" }, "log_transfer_mode" : "cycle", "log_transfer_status" : "ENABLE", "log_transfer_type" : "OBS" } } ] } 当查询DIS转储时,会返回如下参数 { "log_transfers" : [ { "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" }, "log_transfer_mode" : "cycle", "log_transfer_status" : "ENABLE", "log_transfer_type" : "OBS" } } ] } 当创建DMS转储时,会返回如下参数 { "log_transfers" : [ { "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" }, "log_transfer_mode" : "cycle", "log_transfer_status" : "ENABLE", "log_transfer_type" : "OBS" } } ] } 状态码: 400 BadRequest 非法请求 建议根据error_msg直接修改该请求。 { "error_code" : "LTS.0001", "error_msg" : "Invalid log transfer type" } 状态码: 500 表明服务端能被请求访问到,但是服务内部出错。 { "error_code" : "LTS.0010", "error_msg" : "The system encountered an internal error" }
  • URI GET /v2/{project_id}/transfers 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID,账号ID,日志组ID、日志流ID,获取方式请参见:获取项目ID,获取账号ID,日志组ID、日志流ID 最小长度:32 最大长度:32 表2 Query参数 参数 是否必选 参数类型 描述 log_transfer_type 否 String 日志转储类型。OBS指OBS日志转储,DIS指DIS日志转储,DMS指DMS日志转储 枚举值: OBS DIS DMS log_group_name 否 String 日志组名称 最小长度:1 最大长度:64 log_stream_name 否 String 日志流名称 最小长度:1 最大长度:64 offset 否 Integer 查询游标,初始传入0,后续从上一次的返回值中获取 最小值:0 最大值:1024 limit 否 Integer 每页数据量,最大值为100 最小值:0 最大值:100
  • 响应参数 状态码: 200 表4 响应Body参数 参数 参数类型 描述 log_transfers Array of CreateTransferResponseBody objects 查询日志转储信息数组 表5 CreateTransferResponseBody 参数 参数类型 描述 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 日志转储信息 表6 log_streams 参数 参数类型 描述 log_stream_id String 日志流ID 最小长度:36 最大长度:36 log_stream_name String 日志流名称 最小长度:1 最大长度:64 表7 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 表8 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 表9 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 表10 响应Body参数 参数 参数类型 描述 error_code String 错误码。 最小长度:8 最大长度:8 error_msg String 调用失败响应信息描述。 状态码: 500 表11 响应Body参数 参数 参数类型 描述 error_code String 错误码。 最小长度:8 最大长度:8 error_msg String 调用失败响应信息描述。
  • 响应参数 状态码: 200 表4 响应Body参数 参数 参数类型 描述 demoFields Array of StructFieldInfoReturn objects 结构化字段 tagFields Array of tag_fields_info objects 关键词详细信息 demoLog String 示例日志 demoLabel String 参考日志属性 id String 结构化配置id logGroupId String 日志组ID rule ShowStructTemplateRule object 结构化方式 cluster_info ShowStructTemplateclusterInfo object kafka信息 logStreamId String 日志流ID projectId String 项目ID templateName String 模板名称 regex String 正则表达式 表5 StructFieldInfoReturn 参数 参数类型 描述 fieldName String 字段名称 type String 字段数据类型 content String 字段内容 isAnalysis Boolean 是否解析 index Integer 字段序号 表6 tag_fields_info 参数 参数类型 描述 fieldName String 字段名称 type String 字段类型 content String 内容 isAnalysis Boolean 是否解析 index Integer 字段序号 表7 ShowStructTemplateRule 参数 参数类型 描述 param String 结构化参数 type String 结构化类型 表8 ShowStructTemplateclusterInfo 参数 参数类型 描述 cluster_name String kafka集群名称 kafka_bootstrap_servers String kafka集群的服务器地址 kafka_ssl_enable Boolean kafka是否开启ssl加密认证 状态码: 400 表9 响应Body参数 参数 参数类型 描述 error_code String 错误码。 枚举值: SV CS TG.ALS.200201 LTS.0208 error_msg String 调用失败响应信息描述。 枚举值: Query Param is error The log stream does not existed 状态码: 401 表10 响应Body参数 参数 参数类型 描述 error_code String 错误码。 枚举值: LTS.0403 error_msg String 调用失败响应信息描述。 枚举值: Invalid projectId 状态码: 403 表11 响应Body参数 参数 参数类型 描述 error_code String 错误码。 枚举值: LTS.0403 error_msg String 调用失败响应信息描述。 枚举值: Invalid projectId 状态码: 500 表12 响应Body参数 参数 参数类型 描述 error_code String 错误码。 枚举值: LTS.0202 error_msg String 调用失败响应信息描述。 枚举值: Failed to query lts struct log
  • 状态码 状态码 描述 200 请求响应成功, 成功获取结构化配置。 400 BadRequest。非法请求。 建议根据error_msg直接修改该请求,不要重试该请求。 401 AuthFailed。鉴权失败, 请确认token后再次请求 。 403 Forbidden。请求被拒绝访问。返回该状态码,表明请求能够到达服务端,且服务端能够理解用户请求,但是拒绝做更多的事情,因为该请求被设置为拒绝访问,建议直接修改该请求,不要重试该请求。 500 InternalServerError。 表明服务端能被请求访问到,但是服务内部出错。 503 ServiceUnavailable。 被请求的服务无效, 服务不可用。
  • 响应示例 状态码: 400 BadRequest。非法请求。 建议根据error_msg直接修改该请求,不要重试该请求。 { "errorCode" : "SVCSTG.ALS.200201", "errorMessage" : "Query Param is error." } 状态码: 401 AuthFailed。鉴权失败, 请确认token后再次请求 。 { "error_code" : "LTS.0414", "error_msg" : "Invalid token" } 状态码: 403 Forbidden。请求被拒绝访问。返回该状态码,表明请求能够到达服务端,且服务端能够理解用户请求,但是拒绝做更多的事情,因为该请求被设置为拒绝访问,建议直接修改该请求,不要重试该请求。 { "error_code" : "LTS.0001", "error_msg" : "Invalid projectId" } 状态码: 500 InternalServerError。 表明服务端能被请求访问到,但是服务内部出错。 { "error_code" : "LTS.0102", "error_msg" : "Query empty." }
  • 请求参数 表3 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 从 IAM 服务获取的用户Token,获取方式请参见:获取用户Token 缺省值:None 最小长度:1000 最大长度:2000 Content-Type 是 String 该字段填为:application/json;charset=UTF-8。 缺省值:None 最小长度:30 最大长度:30
  • URI GET /v2/{project_id}/lts/struct/template 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID,账号ID,日志组ID、日志流ID,获取方式请参见:获取项目ID,获取账号ID,日志组ID、日志流ID 缺省值:None 最小长度:32 最大长度:32 表2 Query参数 参数 是否必选 参数类型 描述 log_group_id 是 String 项目ID,账号ID,日志组ID、日志流ID,获取方式请参见:获取项目ID,获取账号ID,日志组ID、日志流ID 缺省值:None 最小长度:36 最大长度:36 log_stream_id 是 String 项目ID,账号ID,日志组ID、日志流ID,获取方式请参见:获取项目ID,获取账号ID,日志组ID、日志流ID 缺省值:None 最小长度:36 最大长度:36
  • URI PUT /v1/{project_id}/lts/log-converge-config/switch 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID,账号ID,日志组ID、日志流ID,获取方式请参见:获取项目ID,获取账号ID,日志组ID、日志流ID 表2 Query参数 参数 是否必选 参数类型 描述 log_converge_switch 是 String 开关参数
  • 具体步骤 Token认证,具体操作请参考构造请求。 发送“POST /v2/{project_id}/groups”。 在Request Header中增加“Content-Type”和“X-Auth-Token”。 在Request Body中传入参数如下: POST /v2/{project_id}/groups { "log_group_name":"test001", //日志组名称(必填,String) "ttl_in_days":"7", // 日志过期时间(默认,int) } 请求响应成功后,返回已创建日志组的信息。 { "log_group_id":"2a0089e4-3001-11e9-9e9d-286ed48xxx", //日志组id(String) } 若请求失败,则会返回错误码及对应的错误信息说明,详情请参考:错误码。
  • 响应示例 状态码: 200 请求响应成功, 成功删除结构化配置。 { "id" : "xxxxxx" } 状态码: 400 BadRequest。非法请求。 建议根据error_msg直接修改该请求,不要重试该请求。 { "errorCode" : "LTS.0612", "errorMessage" : "timee fieldType is error" } 状态码: 401 AuthFailed。鉴权失败, 请确认token后再次请求 。 { "error_code" : "LTS.0414", "error_msg" : "Invalid token" } 状态码: 403 Forbidden。请求被拒绝访问。返回该状态码,表明请求能够到达服务端,且服务端能够理解用户请求,但是拒绝做更多的事情,因为该请求被设置为拒绝访问,建议直接修改该请求,不要重试该请求。 { "error_code" : "LTS.0001", "error_msg" : "Invalid projectId" } 状态码: 500 InternalServerError。 表明服务端能被请求访问到,但是服务内部出错。 { "error_code" : "LTS.0010", "error_msg" : "Internal Server Error" }
  • 响应参数 状态码: 200 表4 响应Body参数 参数 参数类型 描述 error_code String SVCSTG.ALS.200200 error_msg String delete struct config successfully 状态码: 400 表5 响应Body参数 参数 参数类型 描述 error_code String 错误码。 枚举值: SVCSTG.ALS.200201 SVCSTG.ALS.200203 error_msg String 调用失败响应信息描述。 枚举值: structConfigId is error delete redis failed. 状态码: 401 表6 响应Body参数 参数 参数类型 描述 error_code String 错误码。 枚举值: LTS.0403 error_msg String 调用失败响应信息描述。 枚举值: Invalid projectId 状态码: 403 表7 响应Body参数 参数 参数类型 描述 error_code String 错误码。 枚举值: LTS.0403 error_msg String 调用失败响应信息描述。 枚举值: Invalid projectId 状态码: 500 表8 响应Body参数 参数 参数类型 描述 error_code String 错误码。 枚举值: LTS.0202 error_msg String 调用失败响应信息描述。 枚举值: Failed to query lts struct log
  • 请求示例 删除当前ID的结构化配置 DELETE https://{endpoint}/v2/{project_id}/lts/struct/template /v2/{project_id}/lts/struct/template { "id": "2a473356cca5487f8373be891bffc1cf_8a75b77d-7d72-4d7e-8c50-a24562cf8b0b_fd5e1a7c-7412-475d-a013-8891d539574e" }
  • 状态码 状态码 描述 200 请求响应成功, 成功删除结构化配置。 400 BadRequest。非法请求。 建议根据error_msg直接修改该请求,不要重试该请求。 401 AuthFailed。鉴权失败, 请确认token后再次请求 。 403 Forbidden。请求被拒绝访问。返回该状态码,表明请求能够到达服务端,且服务端能够理解用户请求,但是拒绝做更多的事情,因为该请求被设置为拒绝访问,建议直接修改该请求,不要重试该请求。 500 InternalServerError。 表明服务端能被请求访问到,但是服务内部出错。 503 ServiceUnavailable。被请求的服务无效, 服务不可用。
  • 请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 从IAM服务获取的用户Token,获取方式请参见:获取用户Token 缺省值:None 最小长度:1000 最大长度:2000 Content-Type 是 String 该字段填为:application/json;charset=UTF-8。 缺省值:None 最小长度:30 最大长度:30 表3 请求Body参数 参数 是否必选 参数类型 描述 id 是 String 结构化规则ID 缺省值:None 最小长度:106 最大长度:106
  • 响应示例 状态码: 201 注册DmsKafka请求响应成功。 { "instance_id" : "3f4a92ff-7f65-489f-a36a-fadbaaxxxxx6" } 状态码: 400 BadRequest 非法请求 建议根据error_msg直接修改该请求。 { "error_code" : "LTS.1719", "error_msg" : "kafka user or password wrong" } 状态码: 500 表明服务端能被请求访问到,但是服务内部出错。 { "error_code" : "LTS.0010", "error_msg" : "The system encountered an internal error" }
  • 响应参数 状态码: 201 表5 响应Body参数 参数 参数类型 描述 instance_id String kafka ID 状态码: 400 表6 响应Body参数 参数 参数类型 描述 error_code String 错误码。 最小长度:8 最大长度:8 error_msg String 调用失败响应信息描述。 状态码: 500 表7 响应Body参数 参数 参数类型 描述 error_code String 错误码。 最小长度:8 最大长度:8 error_msg String 调用失败响应信息描述。
  • 请求示例 注册DMS kafka实例 POST https://{endpoint}/v2/{project_id}/lts/dms/kafka-instance { "instance_id" : "3f4a92ff-7f65-489f-a36a-fadbaaxxxxx6", "kafka_name" : "kafka-wxxxxxt", "connect_info" : { "user_name" : "111", "pwd" : "2222" } }
  • 请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 从IAM服务获取的用户Token,获取方式请参见:获取用户Token 最小长度:1000 最大长度:2000 Content-Type 是 String 该字段填为:application/json;charset=UTF-8。 最小长度:30 最大长度:30 表3 请求Body参数 参数 是否必选 参数类型 描述 instance_id 是 String kafka ID 最小长度:1 最大长度:36 kafka_name 是 String kafka 名称 最小长度:1 最大长度:256 connect_info 是 connect_info object kafka连接信息。购买kafka时,SASL_SSL是否配置,如果有,则需要填写账号密码 表4 connect_info 参数 是否必选 参数类型 描述 user_name 否 String 账号 最小长度:1 最大长度:256 pwd 否 String 密码 最小长度:1 最大长度:256
  • 状态码 状态码 描述 204 请求响应成功, 成功删除日志流。 400 BadRequest。非法请求。 建议根据error_msg直接修改该请求,不要重试该请求。 401 AuthFailed。鉴权失败, 请确认token后再次请求 。 403 Forbidden。请求被拒绝访问。返回该状态码,表明请求能够到达服务端,且服务端能够理解用户请求,但是拒绝做更多的事情,因为该请求被设置为拒绝访问,建议直接修改该请求,不要重试该请求。 500 InternalServerError。 表明服务端能被请求访问到,但是服务内部出错。
  • 响应示例 状态码: 400 BadRequest。非法请求。 建议根据error_msg直接修改该请求,不要重试该请求。 { "error_code" : "LTS.0208", "error_msg" : "The log stream does not existed" } 状态码: 401 AuthFailed。鉴权失败, 请确认token后再次请求 。 { "error_code" : "LTS.0003", "error_msg" : "Invalid token" } 状态码: 403 Forbidden。请求被拒绝访问。返回该状态码,表明请求能够到达服务端,且服务端能够理解用户请求,但是拒绝做更多的事情,因为该请求被设置为拒绝访问,建议直接修改该请求,不要重试该请求。 { "error_code" : "LTS.0001", "error_msg" : "Invalid projectId" } 状态码: 500 InternalServerError。 表明服务端能被请求访问到,但是服务内部出错。 { "error_code" : "LTS.0203", "error_msg" : "Failed to delete Log stream" }
  • URI DELETE /v2/{project_id}/groups/{log_group_id}/streams/{log_stream_id} 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID,账号ID,日志组ID、日志流ID,获取方式请参见:获取项目ID,获取账号ID,日志组ID、日志流ID 缺省值:None 最小长度:32 最大长度:32 log_group_id 是 String 项目ID,账号ID,日志组ID、日志流ID,获取方式请参见:获取项目ID,获取账号ID,日志组ID、日志流ID 缺省值:None 最小长度:36 最大长度:36 log_stream_id 是 String 项目ID,账号ID,日志组ID、日志流ID,获取方式请参见:获取项目ID,获取账号ID,日志组ID、日志流ID 缺省值:None 最小长度:36 最大长度:36
  • 响应参数 状态码: 400 表3 响应Body参数 参数 参数类型 描述 error_code String 错误码。 枚举值: LTS.0403 error_msg String 调用失败响应信息描述。 枚举值: Invalid projectId 状态码: 401 表4 响应Body参数 参数 参数类型 描述 error_code String 错误码。 枚举值: LTS.0403 error_msg String 调用失败响应信息描述。 枚举值: Invalid projectId 状态码: 403 表5 响应Body参数 参数 参数类型 描述 error_code String 错误码。 枚举值: LTS.0403 error_msg String 调用失败响应信息描述。 枚举值: Invalid projectId 状态码: 500 表6 响应Body参数 参数 参数类型 描述 error_code String 错误码。 枚举值: LTS.0403 error_msg String 调用失败响应信息描述。 枚举值: Invalid projectId
  • 请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 从IAM服务获取的用户Token,获取方式请参见:获取用户Token 缺省值:None 最小长度:1000 最大长度:2000 Content-Type 是 String 该字段填为:application/json;charset=UTF-8。 缺省值:None 最小长度:30 最大长度:30
  • 请求参数 表3 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 从IAM服务获取的用户Token,获取方式请参见:获取用户Token 缺省值:None 最小长度:1000 最大长度:2000 Content-Type 是 String 该字段填为:application/json;charset=UTF-8。 缺省值:None 最小长度:30 最大长度:30
  • 响应示例 状态码: 200 请求响应成功。 { "id" : "string", "sql" : "string", "title" : "string", "type" : "table", "log_group_id" : "string", "log_group_name" : "string", "log_stream_id" : "string", "log_stream_name" : "string", "config" : { "canSort" : true, "canSearch" : true, "pageSize" : 0 } }
  • URI GET /v2/{project_id}/groups/{log_group_id}/streams/{log_stream_id}/charts 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID,账号ID,日志组ID、日志流ID,获取方式请参见:获取项目ID,获取账号ID,日志组ID、日志流ID 缺省值:None 最小长度:32 最大长度:32 log_group_id 是 String 项目ID,账号ID,日志组ID、日志流ID,获取方式请参见:获取项目ID,获取账号ID,日志组ID、日志流ID 缺省值:None 最小长度:36 最大长度:36 log_stream_id 是 String 项目ID,账号ID,日志组ID、日志流ID,获取方式请参见:获取项目ID,获取账号ID,日志组ID、日志流ID 缺省值:None 最小长度:36 最大长度:36 表2 Query参数 参数 是否必选 参数类型 描述 offset 否 Integer 查询游标,初始传入0,后续从上一次的返回值中获取。 最小值:0 最大值:1024 limit 否 Integer 每页数据量,最大值为100。 最小值:0 最大值:100
  • 响应参数 状态码: 200 表4 响应Body参数 参数 参数类型 描述 id String id 最小长度:36 最大长度:36 sql String sql语句 最小长度:1 最大长度:1024 title String 图表名称 最小长度:1 最大长度:64 type String 图表类型 枚举值: table bar line pie number log_group_id String 日志组id 最小长度:36 最大长度:36 log_group_name String 日志组名称 最小长度:1 最大长度:64 log_stream_id String 日志组id 最小长度:32 最大长度:32 log_stream_name String 日志流名称 最小长度:1 最大长度:64 config ChartConfig object 图表配置详情 表5 ChartConfig 参数 参数类型 描述 canSort Boolean 是否开启排序 canSearch Boolean 是否开启搜索 pageSize Integer 每页显示数量 最小值:0 最大值:100
  • 响应示例 状态码: 200 Delete result { "create_time" : 1694423493108, "id" : "f5b6b235-48a2-473c-a1fa-4ddba9ca86d8", "log_mapping_config" : [ { "log_stream_config" : [ { "source_log_stream_id" : "55b33967-1971-4521-bf5a-e53e981f3d08", "target_log_stream_eps_id" : "0", "target_log_stream_id" : "ebaf8e21-dba6-4697-99b2-6811f109d03f", "target_log_stream_name" : "stdout-test_huiju", "target_log_stream_ttl" : 180 } ], "source_log_group_id" : "c59e2705-5bbf-4f55-8861-92d4e7e7d33f", "target_log_group_id" : "5adb3025-e663-4cf4-bcf7-7340e79cdbd3", "target_log_group_name" : "k8s-log-test_paas_apm_z00418070_01" }, { "log_stream_config" : [ { "source_log_stream_id" : "b77c9164-b411-42f4-9d4c-2ca7115496b7", "target_log_stream_eps_id" : "0", "target_log_stream_id" : "7120856a-bf15-4f92-8f08-b64bba8c81b1", "target_log_stream_name" : "stdout-test_huiju", "target_log_stream_ttl" : 180 } ], "source_log_group_id" : "77f7e0fc-0ad0-4af0-b1e9-198007d5f993", "target_log_group_id" : "f8076177-c903-4dcf-85d5-dca9d13e591e", "target_log_group_name" : "k8s-log-stest_paas_apm_z00418070_01" } ], "management_account_id" : "115ba1c5fec44839820795ebefe25f2a", "management_project_id" : "a5baef478e6840dc9f454bbc00c996c6", "member_account_id" : "1d26cc8c86a840e28a4f8d0d07852f1d", "member_project_id" : "2a473356cca5487f8373be891bffc1cf", "organization_id" : "o-fa9h4ghf0hnpfnq4xd02tah2nxmtugrf", "status" : "done" } 状态码: 400 Error response ""
  • URI GET /v1/{project_id}/lts/log-converge-config/{member_account_id} 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID,账号ID,日志组ID、日志流ID,获取方式请参见:获取项目ID,获取账号ID,日志组ID、日志流ID member_account_id 是 String 成员帐户ID
共100000条