Creating a Log Group
Function
This API is used to create a log group for log retention and query. You can create a maximum of 100 log groups.
URI
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
project_id |
Yes |
String |
Project ID. For details about how to obtain the ID, see Obtaining the AccountID, Project ID, Log Group ID, and Log Stream ID. Default value: None Value length: 32 characters |
Request Parameters
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
X-Auth-Token |
Yes |
String |
User token obtained from IAM. Default value: None Minimum length: 1000 characters Maximum length: 2000 characters |
Content-Type |
Yes |
String |
Set this parameter to application/json;charset=UTF-8. Default value: None Length: 30 characters |
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
log_group_name |
Yes |
String |
Name of the log group to be created. The configuration rules are as follows:
Minimum length: 1 character Maximum length: 64 characters Enumerated value:
|
ttl_in_days |
Yes |
Integer |
Log retention duration, in days. Maximum value: 7 |
Response Parameters
Status code: 201
Parameter |
Type |
Description |
---|---|---|
log_group_id |
String |
ID of the created log group. Value length: 36 characters |
Status code: 400
Parameter |
Type |
Description |
---|---|---|
error_code |
String |
Error code. Enumerated value:
|
error_msg |
String |
Error message. Enumerated value:
|
Status code: 401
Parameter |
Type |
Description |
---|---|---|
error_code |
String |
Error code. Enumerated value:
|
error_msg |
String |
Error message. Enumerated value:
|
Status code: 403
Parameter |
Type |
Description |
---|---|---|
error_code |
String |
Error code. Enumerated value:
|
error_msg |
String |
Error message. Enumerated value:
|
Status code: 500
Parameter |
Type |
Description |
---|---|---|
error_code |
String |
Error code. Enumerated value:
|
error_msg |
String |
Error message. Enumerated value:
|
Status code: 503
Parameter |
Type |
Description |
---|---|---|
error_code |
String |
Error code. Enumerated value:
|
error_msg |
String |
Error message. Enumerated value:
|
Example Request
POST https://{endpoint}/v2/{project_id}/groups /v2/{project_id}/groups { "log_group_name": "lts-group-01nh", "ttl_in_days": 7 }
Example Response
Status code: 201
{ "log_group_id":"b6b9332b-091f-4b22-b810-264318d2d664" }
Status code: 400
The request is invalid. 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
Authentication failed. Check the token and try again.
{ "error_code" : "LTS.0003", "error_msg" : "Invalid token" }
Status code: 403
The server understood the request but refused to authorize 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.0102", "error_msg" : "Failed to create log group" }
Status Codes
Status Code |
Description |
---|---|
201 |
The request has succeeded and the log group has been created. |
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 server understood the request but refused to authorize 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. |
Error Codes
For details, see Error Codes.
Feedback
Was this page helpful?
Provide feedbackThank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.
For any further questions, feel free to contact us through the chatbot.
Chatbot