调用CLI命令修改Logstore基本信息。
注意事项
在使用CLI命令之前,您需要注意以下事项:
已开通日志服务。具体操作,请参见如何开始使用日志服务?。
已创建日志服务Project和Logstore。具体操作,请参见create_project和create_logstore。
命令格式
aliyunlog log update_logstore --project_name=<value> --logstore_name=<value> [--ttl=<value>] [--enable_tracking=<value>] [--shard_count=<value>] [--append_meta=<value>] [--auto_split=<value>] [--max_split_shard=<value>] [--preserve_storage=<value>] [--encrypt_conf=<value>] [--hot_ttl=<value>] [--mode=<value>] [--telemetry_type=<value>] [--infrequent_access_ttl=<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>] [--sign-version=<value>] [--region-id=<value>]
命令参数
该命令的必选和特有参数描述如下。
参数名称 | 数值类型 | 是否必选 | 示例值 | 描述 |
参数名称 | 数值类型 | 是否必选 | 示例值 | 描述 |
--project_name | String | 是 | aliyun-test-project | Project名称:项目(Project)是日志服务的资源管理单元,是进行多用户隔离与访问控制的主要边界。更多信息,请参见管理Project。 |
--logstore_name | String | 是 | logstore-a | Logstore名称在Project中全局唯一,且创建后不可修改。 其命名规则如下:
|
--ttl | Integer | 否 | 30 | 数据保存时间,单位为天。取值范围:1~3650,如果配置为3650,表示永久保存。当设置的保存期限到达时,日志将被删除。 数据保存时间(ttl)是以下三部分时间的总和:
如果调整了保存期限,日志服务会在1小时内清除所有超出新期限的数据,但是控制台首页的用量明细会在次日进行更新。例如,若原先的数据保存期限是5天,并将其改为1天,那么系统将在1小时内删除前4天的日志数据。 |
--shard_count | Integer | 否 | 2 | 分区(Shard)数量。更多信息,请参见Shard范围。 不支持通过update_logstore修改分区个数,只能通过SplitShard - 分裂Shard增加分区或MergeShard - 合并shard减少分区。 |
--enable_tracking | Boolean | 否 | true | 是否开启WebTracking。
|
--append_meta | Boolean | 否 | false | 是否开启记录外网IP地址。
|
--auto_split | Boolean | 否 | true | 是否自动分裂Shard。
|
--max_split_shard | Integer | 否 | 64 | 自动分裂Shard时的最大分裂数。取值范围为1~256。当--autoSplit参数为true时必须设置。 |
--encrypt_conf | String | 否 | 无 | 加密配置数据结构。 更多信息,请参见EncryptConf。 |
--telemetry_type | String | 否 | None | 可观测数据类型。取值包括:
|
--hot_ttl | Integer | 否 | 7 | 数据在Logstore热存储层中的存储时间,单位为天。最小为7,最大不能超过ttl的值,取值为 当数据的存储时间超过您所配置的热存储层数据保存时间后,数据将转为低频存储。关于热存储、低频存储、归档存储的概念和转换流程,请参见管理智能存储分层。
|
--mode | String | 否 | standard | 日志服务提供Standard(标准型)和Query(查询型)两种类型的Logstore。
更多信息,请参见Logstore类型对比。 |
| Integer | 否 | 30 | 数据在Logstore低频存储层中的存储时间,单位:天。低频存储数据至少需要保存30天才能转换为归档存储。更多信息,请参见管理智能存储分层。 |
关于该命令的全局参数,请参见全局参数。
命令示例
请求示例
使用默认账号修改logstore-a信息。
aliyunlog log update_logstore --project_name="aliyun-test-project" --logstore_name="logstore-a" --ttl=30 --enable_tracking=true
返回示例
命令执行成功后,无响应消息。您可以执行如下命令查询Logstore详细信息。
aliyunlog log get_logstore --project_name="aliyun-test-project" --logstore_name="logstore-a" --format-output=json
相关文档
在调用API接口过程中,若服务端返回结果中包含错误信息,则表示调用API接口失败。您可以参考API错误码对照表查找对应的解决方法。更多信息,请参见API错误处理对照表。
日志服务除自研的SDK外,还支持公共的阿里云SDK,关于阿里云SDK的使用方式,请参见日志服务_SDK中心-阿里云OpenAPI开发者门户。
关于该API接口的详细信息,请参见UpdateLogStore。
日志服务提供基于Java SDK和Python SDK的管理Logstore示例代码。更多信息,请参见使用Java SDK管理日志库Logstore和使用Python SDK管理日志库Logstore。
- 本页导读 (1)
- 注意事项
- 命令格式
- 命令参数
- 命令示例
- 相关文档