Deleting a Log Group
Function
This API is used to delete a specified log group. If the log streams in a log group have been associated with log transfer tasks, you need to delete the tasks first.
URI
DELETE /v2/{project_id}/groups/{log_group_id}
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 |
log_group_id |
Yes |
String |
Log group ID. For details about how to obtain a log group ID, see Obtaining the AccountID, Project ID, Log Group ID, and Log Stream ID. Default value: None Value length: 36 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=utf8. Default value: None Value length: 29 characters |
Response Parameters
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:
|
Example Request
DELETE https://{endpoint}/v2/{project_id}/groups/{log_group_id} /v2/{project_id}/groups/{log_group_id}
Example Response
Status code: 400
The request is invalid. Modify the request based on the description in error_msg before a retry.
{ "error_code" : "LTS.0201", "error_msg" : "The log group is 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 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.0103", "error_msg" : "Failed to delete log group" }
Status Codes
Status Code |
Description |
---|---|
204 |
The request has succeeded and the log group 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 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.