Deleting a Log Stream

Function

This API is used to delete a specified log stream from a specified log group. If log transfer is enabled for a log stream, you need to disable the log transfer before the deletion.

URI

DELETE /v2/{project_id}/groups/{log_group_id}/streams/{log_stream_id}

**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.
log_group_id	Yes	String	Log group ID. For details about how to obtain it, see Obtaining a Log Group ID.
log_stream_id	Yes	String	Log stream ID. For details about how to obtain it, see Obtaining a Log Stream 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.

Response Parameters

Status code: 204

The request is successful and the log stream has been deleted.

Status code: 400

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

Status code: 401

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

Status code: 403

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

Status code: 500

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

Status code: 503

**Table 7** Response body parameters
Parameter	Type	Description
-	String
_	String	ServiceUnavailable: The requested service is unavailable.

Example Requests

Delete a log stream.

DELETE https://{endpoint}/v2/{project_id}/groups/{log_group_id}/streams/{log_stream_id}

/v2/{project_id}/groups/{log_group_id}/streams/{log_stream_id}

Example Responses

Status code: 400

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

{
  "error_code" : "LTS.0208",
  "error_msg" : "The log stream does not existed"
}

Status code: 401

Authentication failed. Check the token and try again.

{
  "error_code" : "LTS.0003",
  "error_msg" : "Invalid token"
}

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.

{
  "error_code" : "LTS.0203",
  "error_msg" : "Failed to delete Log stream"
}

Status Codes

Status Code	Description
204	The request is successful and the log stream has been deleted.
400	The request is invalid. Modify the request based on the description in error_msg before a retry.
401	Authentication failed. Check the token and try again.
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.