Deleting a Quick Search¶
Function¶
This API is used to delete a quick search.
URI¶
DELETE /v1.0/{project_id}/groups/{group_id}/topics/{topic_id}/search-criterias
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 |
group_id | Yes | String | ID of the log group whose log streams will be queried. Generally, it contains 36 characters. Minimum: 36 Maximum: 36 |
topic_id | Yes | String | 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 |
Parameter | Mandatory | Type | Description |
---|---|---|---|
epsId | No | String | Enterprise project ID. |
id | Yes | String | Quick search ID. |
Response Parameters¶
Status code: 400
Parameter | Type | Description |
---|---|---|
message | ErrorMessagebody object | Error message body. |
Parameter | Type | Description |
---|---|---|
code | String | Error code. |
details | String | Error message. |
Status code: 500
Parameter | Type | Description |
---|---|---|
message | ErrorMessagebody object | Error message body. |
Parameter | Type | Description |
---|---|---|
code | String | Error code. |
details | String | Error message. |
Example Requests¶
Deleting a quick search
DELETE /v1.0/2a473356cca5487f8373be891bffc1cf/groups/d1f4240d-5ee2-4e0b-9e2c-e25c7978c001/topics/2b899d46-218c-4f0c-8ace-a36a290a83a0/search-criterias
{
"id" : "345d2276-1ae8-4495-a6ee-bf77c2e5ffb9",
"epsId" : "0"
}
Example Responses¶
Status code: 204
Quick search deleted.
none
Status code: 400
Invalid request. Modify the request based on the description in error_msg before a retry.
{
"message" : {
"code" : "LTS.0208",
"details" : "The log stream does not existed"
}
}
Status code: 500
The server has received the request but encountered an internal error.
{
"message" : {
"code" : "LTS.0203",
"details" : "Internal Server Error"
}
}
Status Codes¶
Status Code | Description |
---|---|
204 | Quick search deleted. |
400 | Invalid request. Modify the request based on the description in error_msg before a retry. |
500 | The server has received the request but encountered an internal error. |
Error Codes¶
See Error Codes.