Enabling Log Dump to LTS for a DataArts DataService Cluster

Function

This API is used to enable the logs of a DataArts DataService cluster to be dumped to LTS.

Calling Method

For details, see Calling APIs.

URI

PUT /v1/{project_id}/service/instances/{instance_id}/lts-log-dump

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

Request Parameters

**Table 2** Request header parameters
Parameter	Mandatory	Type	Description
X-Auth-Token	Yes	String	User token. This parameter is mandatory when token authentication is used. You can obtain it from the value of X-Subject-Token in the response message header returned by the "Obtaining a User Token" API of the IAM service.
workspace	Yes	String	Workspace ID. For details about how to obtain it, see Instance ID and Workspace ID.
Dlm-Type	No	String	Edition of the DataArts DataService. The value can be SHARED or EXCLUSIVE.
Content-Type	No	String	Type (format) of the message body. This parameter is mandatory when there is a body. If the request body contains Chinese characters, use charset=utf8 to specify the Chinese character set, for example, application/json;charset=utf8.

**Table 3** Request body parameters
Parameter	Mandatory	Type	Description
log_dump	No	Boolean	Whether to enable log dump to LTS. Value true indicates that it is enabled, and value false indicates that it is disabled.
log_group_id	No	String	Log group ID
log_group_name	No	String	Log group name
log_stream_id	No	String	Log stream ID
log_stream_name	No	String	Log stream name

Response Parameters

Status code: 400

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

Example Requests

Enable the logs of the cluster whose ID is 4f9366ce3e87860934c36d0ac027ad6a to be dumped to LTS.

/v1/0833a5737480d53b2f250010d01a7b88/service/instances/4f9366ce3e87860934c36d0ac027ad6a/lts-log-dump

{
  "log_dump" : true,
  "log_group_id" : "086d4d0b-89dc-468b-b0ff-37775d230eb6",
  "log_group_name" : "lts-group-mchuang",
  "log_stream_id" : "c4422c49-80d6-4825-bdf3-0bdf07ac564f",
  "log_stream_name" : "lts-topic-nc"
}