Creating a Log Stream

Function

This API is used to create a log stream in a specified log group.

URI

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

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	[Project ]ID. For details about how to obtain a project ID, see Obtaining the Account Tenant ID, Log Group ID, and Log Stream ID. Default: None Minimum: 32 Maximum: 32
log_group_id	Yes	String	ID of the log group to which the log stream to be created belongs. Default: None Minimum: 36 Maximum: 36

Request Parameters

**Table 2** Request header parameters
Parameter	Mandatory	Type	Description
X-Auth-Token	Yes	String	User token obtained from IAM. Default: None Minimum: 1000 Maximum: 2000
Content-Type	Yes	String	Set this parameter to application/json;charset=UTF-8. Default: None Minimum: 30 Maximum: 30

**Table 3** Request body parameters
Parameter	Mandatory	Type	Description
log_stream_name	Yes	String	Name of the log stream to be created. Minimum: 1 Maximum: 64

Response Parameters

Status code: 201

**Table 4** Response body parameters
Parameter	Type	Description
log_stream_id	String	ID of the created log stream. Minimum: 36 Maximum: 36

Status code: 400

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

Status code: 401

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

Status code: 403

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

Status code: 500

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

Status code: 503

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

Example Requests

POST https://{endpoint}/v2/{project_id}/groups/{log_group_id}/streams

{
  "log_stream_name" : "lts-stream-02kh",
  "ttl_in_days" : 7,
  "enterprise_project_name" : "h2"
}

Example Responses

Status code: 201

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

{
  "log_stream_id" : "c54dbc58-0fd8-48ed-b007-6d54981427a7"
}

Status code: 400

BadRequest. Invalid request. Modify the request based on the description in error_msg before a retry.

{
  "error_code" : "LTS.0009",
  "error_msg" : "Failed to validate the request body"
}

Status code: 401

AuthFailed. Authentication failed. Check the token and try again.

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

Status code: 403

Forbidden.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

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

{
  "error_code" : "LTS.0202",
  "error_msg" : "Failed to create Log stream"
}

Status code: 503

ServiceUnavailable. The requested service is unavailable.

{
  "error_code" : "LTS.0403",
  "error_msg" : "ServiceUnavailable"
}

Status Codes

Status Code	Description
201	The request is successful and the log stream has been created.
400	BadRequest. Invalid request. Modify the request based on the description in error_msg before a retry.
401	AuthFailed. Authentication failed. Check the token and try again.
403	Forbidden.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	InternalServerError. The server has received the request but encountered an internal error.
503	ServiceUnavailable. The requested service is unavailable.