文档首页/ 云日志服务 LTS/ API参考/ API说明/ 日志转储/ 查询日志转储
更新时间：2025-08-07 GMT+08:00
在线调试
CLI示例
查看PDF
分享

查询日志转储

功能介绍

查询日志转储，包括OBS转储、DIS转储和DMS转储。

调用方法

请参见如何调用API。

URI

GET /v2/{project_id}/transfers

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

参数解释：

项目ID，可以从调用API处获取，也可以从控制台获取。获取方式请参见：获取项目ID。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。
表2 Query参数

参数

是否必选

参数类型

描述

log_transfer_type

否

String

参数解释：

日志转储类型。

约束限制：

不涉及。

取值范围：

  • OBS：OBS日志转储。

  • DIS：DIS日志转储。

  • DMS：DMS日志转储。

默认取值：

不涉及。

log_group_name

否

String

参数解释：

已创建的日志组名称。

约束限制：

仅支持填写/选择已创建的日志组。

取值范围：

不涉及。

默认取值：

不涉及。

log_stream_name

否

String

参数解释：

已创建的日志流名称。

约束限制：

  • 仅支持填写已选日志组下的日志流。

  • 已配置过转储的日志流不能重复配置。

取值范围：

不涉及。

默认取值：

不涉及。

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

参数解释：

从IAM服务获取的用户Token，获取方式请参见： 获取用户Token。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

Content-Type

是

String

参数解释：

用于定义消息体的格式，该字段填为：application/json;charset=utf8。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

响应参数

状态码：200

表4 响应Body参数

参数

参数类型

描述

log_transfers

Array of CreateTransferResponseBody objects

参数解释：

查询日志转储的详细信息。
表5 CreateTransferResponseBody

参数

参数类型

描述

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

参数解释：

日志转储信息。
表6 log_streams

参数

参数类型

描述

log_stream_id

String

参数解释：

日志流ID。

取值范围：

不涉及。

log_stream_name

String

参数解释：

日志流名称。

取值范围：

不涉及。
表7 log_transfer_info_RespBody

参数

参数类型

描述

log_agency_transfer

log_agency_transfer object

参数解释：

转储委托的相关信息。

当转储的日志源为其他账号时，对委托人账号下所产生的日志进行转储，如需转储其他账号日志，需该账号使用者在IAM中创建委托。

log_create_time

Integer

参数解释：

日志转储的创建时间。

取值范围：

0-2147483647

log_storage_format

String

参数解释：

日志转储格式。有RAW（原始日志格式）和JSON。

不同转储对象，转储格式不同。 当转储对象为OBS或DIS时，支持JSON和RAM；当转储对象为DMS时，支持RAW。

取值范围：

  • RAW

  • JSON

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：日志转储异常状态。

log_transfer_type

String

参数解释：

日志转储类型。

取值范围：

  • OBS：日志转储至OBS。

  • DIS：日志转储至DIS。

  • DMS：日志转储至DMS。
表8 log_agency_transfer

参数

参数类型

描述

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。

取值范围：

不涉及。
表9 TransferDetail

参数

参数类型

描述

obs_period

Integer

参数解释：

转储至OBS的时间。当转储对象为OBS时，返回该参数。

取值范围：

1、2、3、5、6、2、30

obs_period_unit

String

参数解释：

转储至OBS的时间单位。当转储对象为OBS时，返回该参数。

取值范围：

  • min

  • hour

obs_bucket_name

String

参数解释：

转储至OBS的日志桶名称。当转储对象为OBS时，返回该参数。

取值范围：

不涉及。

obs_encrypted_id

String

参数解释：

转储至OBS的KMS密钥ID。当转储对象为OBS且日志桶加密时，返回该参数。

取值范围：

不涉及。

obs_dir_pre_fix_name

String

参数解释：

转储至OBS的自定义转储路径。当转储对象为OBS时，返回该参数。将日志转储至自定义路径中，用于区分不同日志流之间的转储日志文件。

取值范围：

不涉及。

obs_prefix_name

String

参数解释：

转储至OBS桶中的日志文件前缀。当转储对象为OBS时，返回该参数。

取值范围：

不涉及。

obs_time_zone

String

参数解释：

OBS转储时区，请参考OBS转储时区表。。

取值范围：

不涉及。

obs_time_zone_id

String

参数解释：

OBS转储时区ID，请参考OBS转储时区表。

取值范围：

不涉及。

dis_id

String

参数解释：

日志转储至DIS转储通道ID。当转储至DIS时，返回该参数。

取值范围：

不涉及。

dis_name

String

参数解释：

日志转储至DIS转储通道名称。当转储至DIS时，返回该参数。

取值范围：

不涉及。

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_encrypted_enable

Boolean

参数解释：

OBS是否开启加密。

取值范围：

  • true

  • false

tags

Array of strings

参数解释：

开启tag投递。

取值范围：

不涉及。

状态码：400

表10 响应Body参数

参数

参数类型

描述

error_code

String

参数解释：

错误码，请参见：错误码。

取值范围：

不涉及。

error_msg

String

参数解释：

调用失败响应信息描述。

取值范围：

不涉及。

状态码：500

表11 响应Body参数

参数

参数类型

描述

error_code

String

参数解释：

错误码，请参见：错误码。

取值范围：

不涉及。

error_msg

String

参数解释：

调用失败响应信息描述。

取值范围：

不涉及。

请求示例

若不传参数则查询所有日志转储信息。若根据log_transfer_type，log_group_name，log_stream_name这3中不同的参数，则查询对应的日志转储。

GET https://{endpoint}/v2/{project_id}/transfers

/v2/{project_id}/transfers /v2/{project_id}/transfers?log_group_name=lts-group-txxx /v2/{project_id}/transfers?log_transfer_type=OBS /v2/{project_id}/transfers?log_stream_name=lts-topic-testRexxx /v2/{project_id}/transfers?log_group_name=lts-group-txxx&log_transfer_type=OBS /v2/{project_id}/transfers?log_group_name=lts-group-txxx&log_stream_name=lts-topic-testRxxx /v2/{project_id}/transfers?log_transfer_type=OBS&log_stream_name=lts-topic-testRxxx /v2/{project_id}/transfers?log_group_name=lts-group-txxx&log_transfer_type=OBS&log_stream_name=lts-topic-testRexxx

响应示例

状态码：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

非法请求，建议根据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"
}

状态码

状态码

描述

200

查询转储请求响应成功。

400

非法请求，建议根据error_msg直接修改该请求。

500

表明服务端能被请求访问到，但是服务内部出错。

错误码

请参见错误码。

父主题： 日志转储

相关文档