1. 接口描述
接口请求域名: redis.tencentcloudapi.com 。
本接口(ModifyModule)用于修改实例扩展模块的启用状态。
默认接口请求频率限制:20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数,本接口取值:ModifyModule。 |
| Version | 是 | String | 公共参数,本接口取值:2018-04-12。 |
| Region | 是 | String | 公共参数,详见产品支持的 地域列表。 |
| InstanceId | 是 | String | 指定实例 ID。例如:crs-xjhsdj****。请登录Redis控制台在实例列表复制实例 ID。 示例值:crs-4y9t57vt |
| Name | 是 | String | 指定待修改的扩展模块。Redis 支持修改如下扩展模块的状态。 - Bloom:指 RedisBloom 模块,可以高效地判断一个元素是否存在于集合中。 - JSON:指 RedisJSON 模块,允许 Redis 原生支持 JSON 数据格式,方便存储和操作 JSON 对象。 - Search:指 RediSearch 模块,提供全文搜索功能,可以对存储在 Redis 中的数据进行高效的搜索操作。 - TimeSeries:指 RedisTimeSeries 模块,专门用于处理时间序列数据,适合存储和查询时间相关的数据。 示例值:JSON |
| Status | 是 | String | 设置扩展模块的启用状态。仅支持设置为 ON,启用扩展模块。 示例值:ON |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| TaskId | Integer | 任务ID。 示例值:486489 |
| RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 修改实例扩展模块
修改实例扩展模块
输入示例
POST / HTTP/1.1
Host: redis.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: ModifyModule
<公共请求参数>
{
"InstanceId": "crs-asda****",
"Name": "JSON",
"Status": "ON"
}
输出示例
{
"Response": {
"RequestId": "fa6ec05f-d469-41cd-862f-da6771c4554d",
"TaskId": 1719562435
}
}
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: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for Java: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for PHP: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for Go: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for Node.js: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for .NET: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for C++: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for Ruby: CNB, GitHub, Gitee
命令行工具
6. 错误码
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码。
| 错误码 | 描述 |
|---|---|
| FailedOperation.SystemError | 内部系统错误,和业务无关。 |
| FailedOperation.UnSupportError | 实例不支持该接口。 |
| InternalError | 内部错误。 |
| InvalidParameter | 参数错误。 |
| InvalidParameter.PermissionDenied | 接口没有cam权限。 |
| InvalidParameterValue | 参数取值错误。 |
| ResourceNotFound.InstanceNotExists | 根据 serialId 没有找到对应 redis。 |