All Products
Search
Document Center

Simple Log Service:ListSavedSearch

Last Updated:Oct 26, 2023

Queries a list of saved searches.

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.

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:ListSavedSearchacs:log:{#regionId}:{#accountId}:project/{#ProjectName}/savedsearch/*

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.

Request headers

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

Request syntax

GET /savedsearches HTTP/1.1

Request parameters

ParameterTypePositionRequiredExampleDescription
projectStringHostYesaliyun-test-project

The name of the project.

offsetIntegerQueryNo0

The line from which the query starts. Default value: 0.

sizeIntegerQueryNo10

The number of entries per page. Maximum value: 500.

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.

totalInteger4

The total number of saved searches that meet the query conditions.

countInteger4

The number of saved searches returned on the current page.

savedsearchItemsArray of SavedSearch

The saved searches.

Examples

Sample requests

GET /savedsearches?offset=0&size=10 HTTP/1.1
Host:aliyun-test-project.cn-hangzhou.log.aliyuncs.com
Content-Type:application/json

Sample success responses

JSON format

HTTP/1.1 200 OK
Content-Type:application/json

{
  "total" : 4,
  "count" : 4,
  "savedsearchItems" : [ {
    "savedsearchName" : "savedsearchtest9",
    "displayName" : "savedsearchtest9"
  }, {
    "savedsearchName" : "savedsearchtest10",
    "displayName" : "savedsearchtest10"
  }, {
    "savedsearchName" : "savedsearchtest11",
    "displayName" : "savedsearchtest11"
  }, {
    "savedsearchName" : "savedsearchtest12",
    "displayName" : "savedsearchtest12"
  } ]
}

Error codes

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