Enabling Log Dump to OBS for a DataArts DataService Cluster

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

For details, see Calling APIs.

Each account has all the permissions required to call all APIs, but IAM users must be assigned the required permissions.

If you are using role/policy-based authorization, see Permissions Policies and Supported Actions for details on the required permissions.
If you are using identity policy-based authorization, no identity policy-based permission required for calling this API.

PUT /v1/{project_id}/service/instances/{instance_id}/obs-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

**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 OBS. Value true indicates that it is enabled, and value false indicates that it is disabled.

Status code: 204

Success

Status code: 400

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

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

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

{
  "log_dump" : true
}

None

Status Code	Description
204	Success
400	Bad request.

Thank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.

The system is busy. Please try again later.

Which of the following issues have you encountered?

Content is inconsistent with the product UI

Unclear descriptions

Lack of examples or code

Incorrect steps

Can't find what I need

Lack of best practices

Feedback (optional)

0/500

Select at least one type of issue, and enter your comments or suggestions.

Enter a maximum of 500 characters.

Submit Cancel

For any further questions, feel free to contact us through the chatbot.