Help Center/ Log Tank Service/ API Reference/ APIs/ Log Transfer/ Creating a Log Transfer Task (Old Version)

Updated on 2025-11-18 GMT+08:00

View PDF

Creating a Log Transfer Task (Old Version)

Function

This API is used to transfer logs of one or more specified log streams to Object Storage Service (OBS).

URI

POST /v2/{project_id}/log-dump/obs

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	Project ID. For details about how to obtain it, see Obtaining a Project ID.

Request Parameters

**Table 2** Request header parameters
Parameter	Mandatory	Type	Description
X-Auth-Token	Yes	String	User token obtained from IAM. For details about how to obtain it, see Obtaining a User Token.
Content-Type	Yes	String	Set this parameter to application/json;charset=UTF-8.

**Table 3** Request body parameters
Parameter	Mandatory	Type	Description
log_group_id	Yes	String	Log group ID.
log_stream_ids	Yes	Array of strings	IDs of log streams whose logs are to be periodically transferred to OBS. You can specify one or more log streams.
obs_bucket_name	Yes	String	OBS bucket name.
type	Yes	String	For scheduled transfer, this parameter must be set to cycle.
storage_format	Yes	String	Whether the logs are stored in raw or JSON format. The default value is RAW. Minimum characters: 3 Maximum characters: 4
switch_on	No	Boolean	Whether log transfer is enabled. The value is true (default) or false.
prefix_name	No	String	File name prefix of the log files transferred to an OBS bucket.
dir_prefix_name	No	String	Custom path to store the log files.
period	Yes	Integer	Length of the log transfer interval.
period_unit	Yes	String	Unit of the log transfer interval.> The log transfer interval is specified by the combination of the values of period and period_unit and must be set to one of the following: 2min, 5min, 30min, 1hour, 3hour, 6hour, or 12hour.

Response Parameters

Status code: 201

**Table 4** Response body parameters
Parameter	Type	Description
log_dump_obs_id	String	Transfer task ID.

Status code: 400

**Table 5** Response body parameters
Parameter	Type	Description
error_code	String	Error code.
error_msg	String	Error message.

Status code: 403

**Table 6** Response body parameters
Parameter	Type	Description
error_code	String	Error code.
error_msg	String	Error message.

Status code: 500

**Table 7** Response body parameters
Parameter	Type	Description
error_code	String	Error code.
error_msg	String	Error message.

Example Requests

Create a log transfer task.

POST https://{endpoint}/v2/{project_id}/log-dump/obs

/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"
}

Example Responses

Status code: 201

The request is successful.

{
  "log_dump_obs_id" : "45fdc36b-xxxx-4567-xxxx-559xxxxdf968"
}

Status code: 400

The request is invalid. Modify the request based on the description in error_msg before a retry.

BadRequest: The request is invalid. Modify the request based on the description in **error_msg** before a retry.
{     
  "error_code": "LTS.0007",     
  "error_msg": "The request body format must be json" 
}

Status code: 403

The request is rejected.The server has received the request and understood it, but refuses to respond to it. The client should not repeat the request without modifications.

{
  "error_code" : "LTS.0001",
  "error_msg" : "Invalid projectId"
}

Status code: 500

The server has received the request but encountered an internal error.

InternalServerError: The server has received the request but encountered an internal error.
{    
  "error_code": "LTS.0010",    
  "error_msg": "Internal Server Error"}

Status Codes

Status Code	Description
201	The request is successful.
400	The request is invalid. Modify the request based on the description in error_msg before a retry.
403	The request is rejected.The server has received the request and understood it, but refuses to respond to it. The client should not repeat the request without modifications.
500	The server has received the request but encountered an internal error.
503	The requested service is unavailable.