Deleting a Log Group¶
Function¶
This API is used to delete a specified log group. If log transfer is enabled for log streams in a log group, you need to disable the log transfer before the deletion.
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 a project ID, see Obtaining the Project ID, Account ID, Log Group ID, and Log Stream ID. Minimum: 32 Maximum: 32  | 
log_group_id  | Yes  | String  | Log group ID. For details about how to obtain a log group ID, see Obtaining the Project ID, Account ID, Log Group ID, and Log Stream ID. Minimum: 36 Maximum: 36  | 
Request Parameters¶
Parameter  | Mandatory  | Type  | Description  | 
|---|---|---|---|
X-Auth-Token  | Yes  | String  | User token obtained from IAM. For details about how to obtain a user token, see Obtaining a User Token. Minimum: 1000 Maximum: 2000  | 
Content-Type  | Yes  | String  | Set this parameter to application/json;charset=UTF-8. Minimum: 30 Maximum: 30  | 
Response Parameters¶
Status code: 400
Parameter  | Type  | Description  | 
|---|---|---|
error_code  | String  | Error code.  | 
error_msg  | String  | Error message.  | 
Status code: 401
Parameter  | Type  | Description  | 
|---|---|---|
error_code  | String  | Error code.  | 
error_msg  | String  | Error message.  | 
Status code: 403
Parameter  | Type  | Description  | 
|---|---|---|
error_code  | String  | Error code.  | 
error_msg  | String  | Error message.  | 
Status code: 500
Parameter  | Type  | Description  | 
|---|---|---|
error_code  | String  | Error code.  | 
error_msg  | String  | Error message.  | 
Example Requests¶
Deleting a log group
DELETE https://{endpoint}/v2/{project_id}/groups/{log_group_id}
/v2/{project_id}/groups/{log_group_id}
Example Responses¶
Status code: 400
BadRequest. 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
AuthFailed. Authentication failed. Check the token and try again.
{
  "error_code" : "LTS.0003",
  "error_msg" : "Invalid token"
}
Status code: 403
Forbidden.The request has been 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.0103",
  "error_msg" : "Failed to delete log group"
}
Status Codes¶
Status Code  | Description  | 
|---|---|
204  | The request is successful and the log group has been deleted.  | 
400  | BadRequest. The request is invalid. 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 has been 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.  | 
Error Codes¶
See Error Codes.