All Products
Search
Document Center

Simple Log Service:UpdateSavedSearch

Last Updated:Oct 26, 2023

Updates a saved search.

Usage notes

  • Host consists of a project name and a Log Service endpoint. You must specify a project in Host.
  • An AccessKey pair is created and obtained. For more information, see AccessKey pairs.

    The AccessKey pair of an Alibaba Cloud account has permissions on all API operations. Using these credentials to perform operations in Log Service is a high-risk operation. We recommend that you use a RAM user to call API operations or perform routine O&M. To create a RAM user, log on to the RAM console. Make sure that the RAM user has the management permissions on Log Service resources. For more information, see Create a RAM user and authorize the RAM user to access Log Service.

  • The information that is required to query logs is obtained. The information includes the name of the project to which the logs belong, the region of the project, and the name of the Logstore to which the logs belong. For more information, see Manage a project and Manage a Logstore.
  • Limits are imposed when you use Log Service to query logs. We recommend that you specify query statements and query time ranges based on the limits. For more information, see Log search overview and Log analysis overview.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.

Authentication resources

The following table describes the authorization information that is required for this operation. You can add the information to the Action element of a RAM policy statement to grant a RAM user or a RAM role the permissions to call this operation.

Action

Resource

log:UpdateSavedSearchacs:log:{#regionId}:{#accountId}:project/{#ProjectName}/savedsearch/{#SavedSearchName}

Request headers

This operation does not have operation-specific request headers and uses only common request headers. For more information, see the "Common request headers" topic.

Request syntax

PUT /savedsearches/{savedsearchName} HTTP/1.1

Request parameters

ParameterTypePositionRequiredExampleDescription
projectStringHostYesmy-project

The name of the project.

savedsearchNameStringPathYessavedsearch-name

The name of the saved search that you want to update.

ObjectBodyNo

The details of the saved search.

savedsearchNameStringBodyYessavedsearch-name

The name of the saved search. The name must be 3 to 63 characters in length.

searchQueryStringBodyYes*|select date_format(__time__-__time__%60, '%H:%i:%s') as time, COUNT(*) as pv group by time

The query statement of the saved search. A query statement consists of a search statement and an analytic statement in the Search statement|Analytic statement format. For more information, see Log search overview and Log analysis overview.

logstoreStringBodyYesaliyun-test-logstore

The name of the Logstore to which the saved search belongs.

topicStringBodyNotheme

The topic of the logs.

displayNameStringBodyYesdisplayname

The display name.

Response parameters

ParameterTypeExampleDescription
ServerStringnginx

The name of the server.

Content-TypeStringapplication/json

The format of the response body.

Content-LengthString0

The length of the response body.

ConnectionStringclose

Indicates whether the connection is persistent. Valid values:

  • close: The connection is non-persistent. A new TCP connection is established for each HTTP request.
  • keep-alive: The connection is persistent. After a TCP connection is established, the connection remains open, and no more time or bandwidth is consumed to establish new connections.
DateStringSun, 27 May 2018 08:25:04 GMT

The time when the response was returned.

x-log-requestidString5B0A6B60BB6EE39764D458B5

The request ID.

Examples

Sample requests

PUT /savedsearches/savedsearch-name HTTP/1.1
Host:aliyun-test-project.cn-hangzhou.log.aliyuncs.com
Content-Type:application/json

{
  "savedsearchName" : "savedsearch-name",
  "searchQuery" : "*|select date_format(__time__-__time__%60, '%H:%i:%s') as time, COUNT(*) as pv group by time",
  "logstore" : "aliyun-test-logstore",
  "topic" : "theme",
  "displayName" : "displayname"
}

Sample success responses

JSON format

HTTP/1.1 200 OK

Error codes

For a list of error codes, see Service error codes.