文档

update_savedsearch

更新时间:

调用CLI命令更新快速查询。

注意事项

在使用CLI命令之前,您需要注意以下事项:

  • 已安装日志服务CLI,并完成配置。具体操作,请参见安装CLI配置CLI

  • 已创建并获取AccessKey。更多信息,请参见访问密钥

    阿里云账号AccessKey拥有所有API的访问权限,风险很高。强烈建议您创建并使用RAM用户进行API访问或日常运维。RAM用户需具备操作日志服务资源的权限。具体操作,请参见创建RAM用户及授权

  • 已明确您查询日志所属的Project名称、所属地域、Logstore名称等。如何查询,请参见管理Project管理Logstore

  • 日志服务查询日志时存在使用限制。请设计合理查询与分析语句、设置合理查询区间等。更多信息,请参见查询日志使用限制分析日志使用限制

命令格式

aliyunlog log update_savedsearch --project=<value> --detail=<value> [--access-id=<value>] [--access-key=<value>] [--sts-token=<value>] [--region-endpoint=<value>] [--client-name=<value>] [--jmes-filter=<value>] [--format-output=<value>] [--decode-output=<value>] [--profile=<value>]

命令参数

该命令的必选和特有参数描述如下。

参数名称

数值类型

是否必选

示例值

描述

--project

String

ali-test-project

Project名称。

--detail

String

file://./savedsearch_config_update.json

修改后的快速查询的配置文件路径。您需要在执行该命令前,创建该文件,指定快速查询名称、查询和分析语句等信息。

关于该命令的全局参数,请参见全局参数

命令示例

  1. 创建savedsearch_config_update.json文件,用于指定修改后的Logstore名称(logstore)、快速查询名称(savedsearchName)、查询和分析语句(searchQuery)等信息。该快速查询用于查询每小时PV的数量,其内容示例如下:

    {
      "project": "ali-test-project",
      "savedsearchName": "pv_in_minutes",
      "logstore": "nginx-moni",
      "searchQuery": "*|select date_format(__time__-__time__%3600, '%H:%i:%s') as time, COUNT(*) as pv group by time order by time",
      "tokenQuery": "",
      "tokens": [],
      "topic": ""
    }
  2. 修改名称为pv_in_minutes的快速查询。

    • 命令示例

      aliyunlog log update_savedsearch --project="ali-test-project" --detail="file://./savedsearch_config_update.json"
    • 返回示例

      命令执行成功后,无响应消息。您可以执行aliyunlog log get_savedsearch --project="ali-test-project" --entity="pv_in_minutes" --format-output=json,no_escape查询快速查询的详细信息。

      {
        "displayName": "pv_in_minutes",
        "logstore": "nginx-moni",
        "project": "ali-test-project",
        "savedsearchName": "pv_in_minutes",
        "searchQuery": "*|select date_format(__time__-__time__%3600, '%H:%i:%s') as time, COUNT(*) as pv group by time order by time",
        "tokenQuery": "",
        "tokens": [],
        "topic": ""
      }

      修改快速查询后,您可以在日志服务控制台通过资源 > 快速查询查看已修改的快速查询,单击快速查询即可快速进行查询和分析操作。快速查询

相关文档

  • 在调用API接口过程中,若服务端返回结果中包含错误信息,则表示调用API接口失败。您可以参考API错误码对照表查找对应的解决方法。更多信息,请参见API错误处理对照表

  • 阿里云OpenAPI开发者门户提供调试、SDK、示例和配套文档。通过OpenAPI,您无需手动封装请求和签名操作,就可以快速对日志服务API进行调试。更多信息,请参见OpenAPI开发者门户

  • 关于该API接口的详细信息,请参见UpdateSavedSearch - 更新快速查询