API 文档

修改实例相关信息

最近更新时间:2020-11-30 08:27:51

1. 接口描述

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

修改实例相关信息

默认接口请求频率限制:50次/秒。

注意:本接口支持金融区地域。由于金融区和非金融区是隔离不互通的,因此当公共参数 Region 为金融区地域(例如 ap-shanghai-fsi)时,需要同时指定带金融区地域的域名,最好和 Region 的地域保持一致,例如:redis.ap-shanghai-fsi.tencentcloudapi.com。

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

2. 输入参数

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

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:ModifyInstance。
Version String 公共参数,本接口取值:2018-04-12。
Region String 公共参数,详见产品支持的 地域列表
Operation String 修改实例操作,如填写:rename-表示实例重命名;modifyProject-修改实例所属项目;modifyAutoRenew-修改实例续费标记
InstanceIds.N Array of String 实例Id
InstanceNames.N Array of String 实例的新名称
ProjectId Integer 项目Id
AutoRenews.N Array of Integer 自动续费标识。0 - 默认状态(手动续费);1 - 自动续费;2 - 明确不自动续费
InstanceId String 已经废弃
InstanceName String 已经废弃
AutoRenew Integer 已经废弃

3. 输出参数

参数名称 类型 描述
RequestId String 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 请求示例

输入示例

https://redis.tencentcloudapi.com/?Action=ModifyInstance
&Operation=rename&InstanceIds.0=crs-r3nqjq3n&InstanceNames.0=newname1&InstanceIds.1=crs-9bvd9b8v&InstanceNames.1=newname2
&<公共请求参数>

输出示例

{
  "Response": {
    "RequestId": "6d1e8909-496a-4f27-ad0d-2e4a069b52c0"
  }
}

5. 开发者资源

腾讯云 API 平台

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

API Inspector

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

SDK

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

命令行工具

6. 错误码

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

错误码 描述
FailedOperation.SystemError 内部系统错误,和业务无关。
InvalidParameter.PermissionDenied 接口没有cam权限。
UnauthorizedOperation 未授权操作。
UnauthorizedOperation.NoCAMAuthed 无cam 权限。
UnauthorizedOperation.UserNotInWhiteList 用户不在白名单中。
UnsupportedOperation.ClusterInstanceAccessedDeny redis 集群版不允许接入安全组。
UnsupportedOperation.IsAutoRenewError 自动续费标识错误。
UnsupportedOperation.OnlyClusterInstanceCanExportBackup 只有集群版实例支持导出备份。
目录