华为云用户手册

请求参数 表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，可选填

请求消息体（可选） 该部分可选。请求消息体通常以结构化格式（如JSON或XML）发出，与请求消息头中Content-Type对应，传递除请求消息头之外的内容。若请求消息体中的参数支持中文，则中文字符必须为UTF-8编码。 每个接口的请求消息体内容不同，也并不是每个接口都需要有请求消息体（或者说消息体为空），GET、DELETE操作类型的接口就不需要消息体，消息体具体内容需要根据具体接口而定。 对于获取用户Token接口，您可以从接口的请求部分看到所需的请求参数及参数说明。将消息体加入后的请求如下所示，加粗的斜体字段需要根据实际值填写，其中username为用户名，domainname为用户所属的账号名称，********为用户登录密码，xxxxxxxxxxxxxxxxxx为project的名称，如“cn-north-1”“eu-west-0”，您可以从地区和终端节点获取。 scope参数定义了Token的作用域，下面示例中获取的Token仅能访问project下的资源。您还可以设置Token的作用域为某个账号下所有资源或账号的某个project下的资源，详细定义请参见获取用户Token。 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 POST https://iam.cn-north-1.myhuaweicloud.com/v3/auth/tokens Content-Type: application/json { "auth": { "identity": { "methods": [ "password" ], "password": { "user": { "name": "username", "password": "********", "domain": { "name": "domainname" } } } }, "scope": { "project": { "name": "xxxxxxxxxxxxxxxxxx" } } } } 到这里为止这个请求需要的内容就具备齐全了，您可以使用curl、Postman或直接编写代码等方式发送请求调用API。对于获取用户Token接口，返回的响应消息头中“x-subject-token”就是需要获取的用户Token。有了Token之后，您就可以使用Token认证调用其他API。

请求消息头 附加请求头字段，如指定的URI和HTTP方法所要求的字段。例如定义消息体类型的请求头“Content-Type”，请求鉴权信息等。 详细的公共请求消息头字段请参见表1。 表1 公共请求消息头 名称 描述 是否必选 示例 Host 请求的服务器信息，从服务API的URL中获取。值为hostname[:port]。端口缺省时使用默认的端口，https的默认端口为443。 否 使用AK/SK认证时该字段必选。 code.test.com or code.test.com:443 Content-Type 消息体的类型（格式）。推荐用户使用默认值application/json，有其他取值时会在具体接口中专门说明。 是 application/json Content-Length 请求body长度，单位为Byte。 否 3495 X-Project-Id project id，项目编号。请参考获取账号ID、项目ID、日志组ID、日志流ID章节获取项目编号。 否 如果是专属云场景采用AK/SK认证方式的接口请求或者多project场景采用AK/SK认证的接口请求，则该字段必选。 e9993fc787d94b6c886cbaa340f9c0f4 X-Auth-Token 用户Token。 用户Token也就是调用获取用户Token接口的响应值，该接口是唯一不需要认证的接口。 请求响应成功后在响应消息头（Headers）中包含的“X-Subject-Token”的值即为Token值。 否 使用Token认证时该字段必选。 注：以下仅为Token示例片段 MIIPAgYJKoZIhvcNAQcCo...ggg1BBIINPXsidG9rZ API同时支持使用AK/SK认证，AK/SK认证是使用SDK对请求进行签名，签名过程会自动往请求中添加Authorization（签名认证信息）和X-Sdk-Date（请求发送的时间）请求头。 AK/SK认证的详细说明请参见认证鉴权的“AK/SK认证”。 对于获取用户Token接口，由于不需要认证，所以只添加“Content-Type”即可，添加消息头后的请求如下所示。 1 2 POST https://iam.cn-north-1.myhuaweicloud.com/v3/auth/tokens Content-Type: application/json

请求URI 请求URI由如下部分组成。 {URI-scheme} :// {Endpoint} / {resource-path} ? {query-string} 尽管请求URI包含在请求消息头中，但大多数语言或框架都要求您从请求消息中单独传递它，所以在此单独强调。 URI-scheme： 表示用于传输请求的协议，当前所有API均采用HTTPS协议。 Endpoint： 指定承载REST服务端点的服务器域名或IP，不同服务不同区域的Endpoint不同，您可以从地区和终端节点获取。 例如IAM服务在“华北-北京一”区域的Endpoint为“iam.cn-north-1.myhuaweicloud.com”。 resource-path： 资源路径，也即API访问路径。从具体API的URI模块获取，例如“获取用户Token”API的resource-path为“/v3/auth/tokens”。 query-string： 查询参数，是可选部分，并不是每个API都有查询参数。查询参数前面需要带一个“？”，形式为“参数名=参数取值”，例如“limit=10”，表示查询不超过10条数据。 例如您需要获取IAM在“华北-北京一”区域的Token，则需使用“华北-北京一”区域的Endpoint（iam.cn-north-1.myhuaweicloud.com），并在“获取用户Token”的URI部分找到resource-path（/v3/auth/tokens），拼接起来如下所示。 https://iam.cn-north-1.myhuaweicloud.com/v3/auth/tokens 图1 URI示意图 为查看方便，在每个具体API的URI部分，只给出resource-path部分，并将请求方法写在一起。这是因为URI-scheme都是HTTPS，同一个服务的Endpoint在同一个区域也相同，所以简洁起见将这两部分省略。

请求方法 HTTP请求方法（也称为操作或动词），它告诉服务你正在请求什么类型的操作。 GET：请求服务器返回指定资源。 PUT：请求服务器更新指定资源。 POST：请求服务器新增资源或执行特殊操作。 DELETE：请求服务器删除指定资源，如删除对象等。 HEAD：请求服务器资源头部。 PATCH：请求服务器更新资源的部分内容。当资源不存在的时候，PATCH可能会去创建一个新的资源。 在“获取用户Token”的URI部分，您可以看到其请求方法为“POST”，则其请求为： 1 POST https://iam.cn-north-1.myhuaweicloud.com/v3/auth/tokens

URI POST /v2/{project_id}/{domain_id}/lts/events/notification/templates/view 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID，账号ID，日志组ID、日志流ID，获取方式请参见：获取项目ID，获取账号ID，日志组ID、日志流ID 最小长度：32 最大长度：32 domain_id 是 String 项目ID，账号ID，日志组ID、日志流ID，获取方式请参见：获取项目ID，获取账号ID，日志组ID、日志流ID 最小长度：32 最大长度：32

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 从IAM服务获取的用户Token，获取方式请参见：获取用户Token 最小长度：1000 最大长度：2000 Content-Type 是 String 该字段填为：application/json;charset=UTF-8。 最小长度：30 最大长度：30 表3 请求Body参数 参数 是否必选 参数类型 描述 templates 是 String 邮件模板内容 最小长度：2 最大长度：1024 language 是 String 语言 zh-cn中文，en-us英文 枚举值： zh-cn en-us source 是 String 来源，只能填LTS 最小长度：3 最大长度：3

请求示例 预览消息模板邮件格式 POST https://{endpoint}/v2/{project_id}/{domain_id}/lts/events/notification/templates/view { "templates" : "告警级别：${event_severity};\n发生时间：${starts_at};\n告警源：$event.metadata.resource_provider;\n资源类型：$event.metadata.resource_type;\n资源标识：${resources};\n统计类型：关键词统计;\n表达式：$event.annotations.condition_expression;\n当前值: $event.annotations.current_value;\n统计周期：$event.annotations.frequency;\n查询时间：$event.annotations.results[0].time;\n查询日志：$event.annotations.results[0].raw_results;", "language" : "zh-cn", "source" : "LTS" }

响应参数 状态码： 201 表4 响应Body参数 参数 参数类型 描述 id String 快速查询id 状态码： 400 表5 响应Body参数 参数 参数类型 描述 message ErrorMessagebody object 错误信息body体 表6 ErrorMessagebody 参数 参数类型 描述 code String 错误码 最小长度：8 最大长度：36 details String 错误描述 最小长度：2 最大长度：512 状态码： 500 表7 响应Body参数 参数 参数类型 描述 message ErrorMessagebody object 错误信息body体 表8 ErrorMessagebody 参数 参数类型 描述 code String 错误码 最小长度：8 最大长度：36 details String 错误描述 最小长度：2 最大长度：512

请求示例 添加快速查询 /v1.0/2a473356cca5487f8373be891bffc1cf/groups/d1f4240d-5ee2-4e0b-9e2c-e25c7978c001/topics/2b899d46-218c-4f0c-8ace-a36a290a83a0/search-criterias { "name" : "创建数字", "criteria" : "content : 1234567891234567891234567891234567891234567891234567891234567894", "eps_id" : "0", "search_type" : "ORIGINALLOG" }

响应示例 状态码： 201 添加快速查询成功 { "id" : "0eb379f5-f847-4d25-ba89-05967bf1bae3" } 状态码： 400 BadRequest 非法请求建议根据error_msg直接修改该请求 { "message" : { "code" : "LTS.0208", "details" : "The log stream does not existed" } } 状态码： 500 表明服务端能被请求访问到，但是服务内部出错 { "message" : { "code" : "LTS.0203", "details" : "Internal Server Error" } }

URI POST /v1.0/{project_id}/groups/{group_id}/topics/{topic_id}/search-criterias 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String '项目ID，账号ID，日志组ID、日志流ID，获取方式请参见：获取项目ID，获取账号ID，日志组ID、日志流ID' 缺省值：None 最小长度：32 最大长度：32 group_id 是 String 租户想查询的日志流所在的日志组的groupid，一般为36位字符串。 缺省值：None 最小长度：36 最大长度：36 topic_id 是 String 日志流id

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 从IAM服务获取的用户Token，获取方式请参见：获取用户Token 最小长度：1000 最大长度：2000 Content-Type 是 String 该字段填为：application/json;charset=UTF-8。 缺省值：None 最小长度：30 最大长度：30 表3 请求Body参数 参数 是否必选 参数类型 描述 criteria 是 String 快速查询字段 eps_id 否 String 企业项目id name 是 String 创建快速查询名称 search_type 是 String 查询类型原始日志：ORIGINALLOG 可视化日志: VISUALIZATION

响应示例 状态码： 200 请求响应成功，成功修改日志流。 { "creation_time" : "number", "log_topic_name" : "string", "log_topic_id" : "string", "ttl_in_days" : 8 } 状态码： 400 BadRequest。非法请求。 建议根据error_msg直接修改该请求，不要重试该请求。 { "error_code" : "LTS.0009", "error_msg" : "Failed to validate the request body" } 状态码： 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.0204", "error_msg" : "Failed to update log stream" }

状态码 状态码 描述 200 请求响应成功，成功修改日志流。 400 BadRequest。非法请求。 建议根据error_msg直接修改该请求，不要重试该请求。 401 AuthFailed。鉴权失败, 请确认token后再次请求 。 403 Forbidden。 请求被拒绝访问。 返回该状态码，表明请求能够到达服务端，且服务端能够理解用户请求，但是拒绝做更多的事情，因为该请求被设置为拒绝访问，建议直接修改该请求，不要重试该请求。 500 InternalServerError。 表明服务端能被请求访问到，但是服务内部出错。 503 ServiceUnavailable。 被请求的服务无效，服务不可用。

响应参数 状态码： 200 表5 响应Body参数 参数 参数类型 描述 creation_time Long 创建该日志流的时间 log_topic_name String 日志流的名称。 最小长度：1 最大长度：64 log_topic_id String 日志流ID。 最小长度：36 最大长度：36 ttl_in_days Integer 日志存储时间（天）。 最小值：1 最大值：365 枚举值： 7 状态码： 400 表6 响应Body参数 参数 参数类型 描述 error_code String 错误码。 枚举值： LTS.0403 error_msg String 调用失败响应信息描述。 枚举值： Invalid projectId 状态码： 401 表7 响应Body参数 参数 参数类型 描述 error_code String 错误码。 枚举值： LTS.0403 error_msg String 调用失败响应信息描述。 枚举值： Invalid projectId 状态码： 403 表8 响应Body参数 参数 参数类型 描述 error_code String 错误码。 枚举值： LTS.0403 error_msg String 调用失败响应信息描述。 枚举值： Invalid projectId 状态码： 500 表9 响应Body参数 参数 参数类型 描述 error_code String 错误码。 枚举值： LTS.0403 error_msg String 调用失败响应信息描述。 枚举值： Invalid projectId

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 从IAM服务获取的用户Token，获取方式请参见：获取用户Token 最小长度：1000 最大长度：2000 Content-Type 是 String 该字段填为：application/json;charset=UTF-8。 缺省值：None 最小长度：30 最大长度：30 表3 请求Body参数 参数 是否必选 参数类型 描述 ttl_in_days 是 Integer 日志存储时间（天）。 该参数仅对华东-上海一、华北-北京四、华南-广州用户开放。 最小值：1 最大值：365 枚举值： 7 tags 否 Array of tagsBody objects 标签字段信息 表4 tagsBody 参数 是否必选 参数类型 描述 key 否 String 标签键 value 否 String 标签值

URI PUT /v2/{project_id}/groups/{log_group_id}/streams-ttl/{log_stream_id} 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String '项目ID，账号ID，日志组ID、日志流ID，获取方式请参见：获取项目ID，获取账号ID，日志组ID、日志流ID' 缺省值：None 最小长度：36 最大长度：36 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

响应参数 状态码： 200 表4 响应Body参数 参数 参数类型 描述 [数组元素] Array of CreateAomMappingRuleResp objects 请求响应成功, 成功获取所有接入配置。 表5 CreateAomMappingRuleResp 参数 参数类型 描述 project_id String 项目id rule_name String 接入规则名称 rule_id String 接入规则id rule_info AomMappingRuleInfoRespBody object 接入规则详情 表6 AomMappingRuleInfoRespBody 参数 参数类型 描述 cluster_id String 集群id cluster_name String 集群名称 deployments_prefix String 日志流前缀 deployments Array of strings 工作负载 namespace String 命名空间 container_name String 容器名称 files Array of AomMappingfilesInfos objects 接入规则详情 表7 AomMappingfilesInfos 参数 参数类型 描述 file_name String 路径名 log_stream_info AomMappingLogStreamInfos object 接入规则详情。 表8 AomMappingLogStreamInfos 参数 参数类型 描述 target_log_group_id String 日志组id target_log_group_name String 目标日志组名称 target_log_stream_id String 日志流id target_log_stream_name String 目标日志流名称 状态码： 400 表9 响应Body参数 参数 参数类型 描述 code String 错误码。 枚举值： LTS.0014 details String 调用失败响应信息描述。 枚举值： Operation DB failed 状态码： 401 表10 响应Body参数 参数 参数类型 描述 massage Massage401 object 接口调用信息。 表11 Massage401 参数 参数类型 描述 code String 错误码。 枚举值： LTS.0001 details String 调用失败响应信息描述。 枚举值： project verify error 状态码： 403 表12 响应Body参数 参数 参数类型 描述 error_code String 错误码。 枚举值： LTS.0403 error_msg String 调用失败响应信息描述。 枚举值： Invalid projectId 状态码： 500 表13 响应Body参数 参数 参数类型 描述 error_code String 错误码。 枚举值： LTS.0403 error_msg String 调用失败响应信息描述。

响应示例 状态码： 200 请求响应成功, 成功获取所有接入配置。 [ { "project_id" : "", "rule_id" : "", "rule_info" : { "cluster_id" : "", "cluster_name" : "", "container_name" : "", "deployments" : [ "" ], "files" : [ { "file_name" : "", "log_stream_info" : { "target_log_group_id" : "", "target_log_group_name" : "", "target_log_stream_id" : "", "target_log_stream_name" : "" } } ], "namespace" : "" }, "rule_name" : "" }, { "project_id" : "", "rule_id" : "", "rule_info" : { "cluster_id" : "", "cluster_name" : "", "container_name" : "", "deployments" : [ "" ], "files" : [ { "file_name" : "", "log_stream_info" : { "target_log_group_id" : "", "target_log_group_name" : "", "target_log_stream_id" : "", "target_log_stream_name" : "" } } ], "namespace" : "" }, "rule_name" : "" } ] 状态码： 400 BadRequest。非法请求。 建议根据error_msg直接修改该请求，不要重试该请求。 { "errorCode" : "LTS.0014", "errorMessage" : "Operation DB failed" } 状态码： 401 AuthFailed。鉴权失败, 请确认token后再次请求 。 { "error_code" : "LTS.0414", "error_msg" : "Invalid token" } 状态码： 403 Forbidden。请求被拒绝访问。返回该状态码，表明请求能够到达服务端，且服务端能够理解用户请求，但是拒绝做更多的事情，因为该请求被设置为拒绝访问，建议直接修改该请求，不要重试该请求。 { "error_code" : "LTS.0003", "error_msg" : "parse_token_failed" } 状态码： 500 InternalServerError。 表明服务端能被请求访问到，但是服务内部出错。 { "error_code" : "LTS.0102", "error_msg" : "ServiceUnavailable." }

状态码 状态码 描述 200 请求响应成功, 成功获取所有接入配置。 400 BadRequest。非法请求。 建议根据error_msg直接修改该请求，不要重试该请求。 401 AuthFailed。鉴权失败, 请确认token后再次请求 。 403 Forbidden。请求被拒绝访问。返回该状态码，表明请求能够到达服务端，且服务端能够理解用户请求，但是拒绝做更多的事情，因为该请求被设置为拒绝访问，建议直接修改该请求，不要重试该请求。 500 InternalServerError。 表明服务端能被请求访问到，但是服务内部出错。 503 ServiceUnavailable。 被请求的服务无效, 服务不可用。

URI GET /v2/{project_id}/lts/aom-mapping 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID，账号ID，日志组ID、日志流ID，获取方式请参见：获取项目ID，获取账号ID，日志组ID、日志流ID 缺省值：None 最小长度：32 最大长度：32 表2 Query参数 参数 是否必选 参数类型 描述 log_group_name 否 String 日志组名称 最小长度：1 最大长度：64 log_stream_name 否 String 日志流名称 最小长度：1 最大长度：64

请求参数 表3 请求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 最小长度：1000 最大长度：2000 Content-Type 是 String 该字段填为：application/json;charset=UTF-8。 缺省值：None 最小长度：30 最大长度：30 表4 请求Body参数 参数 是否必选 参数类型 描述 start_time 是 Long 开始时间时间戳，毫秒时间，最多支持30天范围内的查询 end_time 是 Long 结束时间时间戳，毫秒时间 period 是 Integer 查询时间间隔，单位为小时，范围为1-24 resource_type 是 String 资源类型，log_group / log_stream / tenant search_type 是 String 查询流量类型值为：write，index，storage，basicTransfer，seniorTransfer，coldStorage resource_id 否 String 资源ID。 当资源类型为log_group时 ，resource_id是日志组id； 当资源类型为log_stream时，resource_id是日志流id。