云数据库 Redis 修改实例日志投递配置-API 文档-文档中心-腾讯云

1. 接口描述

接口请求域名： redis.tencentcloudapi.com 。

本接口（ModifyInstanceLogDelivery）用于开启或关闭投递实例日志到CLS。

默认接口请求频率限制：20次/秒。

推荐使用 API Explorer

点击调试

API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。

2. 输入参数

以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见公共请求参数。

参数名称	必选	类型	描述
Action	是	String	公共参数，本接口取值：ModifyInstanceLogDelivery。
Version	是	String	公共参数，本接口取值：2018-04-12。
Region	是	String	公共参数，详见产品支持的地域列表。
InstanceId	是	String	实例ID。示例值：crs-d8ej0xn2
LogType	是	String	日志类型。当前仅支持设置为slowlog，指慢查询日志。示例值：slowlog
Enabled	是	Boolean	日志投递开启状态。 - true：开启。 - false：关闭。示例值：true
LogsetId	否	String	投递的日志集ID。示例值：4ae3d686-0dcf-4db3-9867-482def442c9a
TopicId	否	String	投递的日志主题ID。示例值：27197b72-e1cb-4fc1-ab21-3865f589136f
LogsetName	否	String	日志集名称。若LogsetId未指定具体的日志集ID，请配置该参数，设置日志集名称，系统会以设置的日志集名称自动创建新的日志集。示例值：test-set-name
TopicName	否	String	日志主题名称，TopicId为空时必传，会自动创建新的日志主题。示例值：test-topic-name
LogRegion	否	String	日志集所在地域，不传默认使用实例所在地域。
Period	否	Integer	日志存储时间，默认为30天，可选范围1-3600天。示例值：30
CreateIndex	否	Boolean	创建日志主题时，是否创建索引。示例值：true

3. 输出参数

参数名称	类型	描述
RequestId	String	唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 示例1

开启实例日志投递，并使用新创建的日志集和日志主题

输入示例

POST / HTTP/1.1
Host: redis.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: ModifyInstanceLogDelivery
<公共请求参数>

{
    "InstanceId": "crs-ib4uuh7x",
    "LogType": "slowlog",
    "Enabled": true,
    "LogsetName": "test-logset-name",
    "TopicName": "test-topic-name",
    "CreateIndex": true
}

输出示例

{
    "Response": {
        "RequestId": "ac46037a-57a0-4fe2-a99d-93c10ef20883"
    }
}

5. 开发者资源

腾讯云 API 平台

腾讯云 API 平台是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台，方便您从同一入口查询及使用腾讯云提供的所有 API 服务。

API Inspector

用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况，并自动生成各语言版本的 API 代码，也可前往 API Explorer 进行在线调试。

SDK

云 API 3.0 提供了配套的开发工具集（SDK），支持多种编程语言，能更方便的调用 API。

Tencent Cloud SDK 3.0 for Python: GitHub Gitee
Tencent Cloud SDK 3.0 for Java: GitHub Gitee
Tencent Cloud SDK 3.0 for PHP: GitHub Gitee
Tencent Cloud SDK 3.0 for Go: GitHub Gitee
Tencent Cloud SDK 3.0 for Node.js: GitHub Gitee
Tencent Cloud SDK 3.0 for .NET: GitHub Gitee
Tencent Cloud SDK 3.0 for C++: GitHub Gitee
Tencent Cloud SDK 3.0 for Ruby: GitHub Gitee

命令行工具

Tencent Cloud CLI 3.0

6. 错误码

以下仅列出了接口业务逻辑相关的错误码，其他错误码详见公共错误码。

错误码	描述
InternalError.InternalError	内部错误。
InvalidParameter.InvalidParameter	业务参数错误。
InvalidParameter.NotSupported	参数错误，不支持操作。
ResourceNotFound.InstanceNotExists	根据 serialId 没有找到对应 redis。

修改实例日志投递配置

本页目录：