云数据库 KeeWiDB
有奖捉虫：办公协同&微信生态&物联网文档专题 HOT
文档中心 > 云数据库 KeeWiDB > API 文档 > 实例相关接口 > 修改实例相关信息

修改实例相关信息

最近更新时间：2024-03-12 01:36:54

我的收藏

本页目录：

1. 接口描述

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

本接口（ModifyInstance）用于修改实例相关信息。

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

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

2. 输入参数

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

参数名称 必选 类型 描述
Action 是 String 公共参数，本接口取值：ModifyInstance。
Version 是 String 公共参数，本接口取值：2022-03-08。
Region 是 String 公共参数，详见产品支持的 地域列表。
Operation 是 String 修改实例操作。
  • rename：表示实例重命名。
  • modifyProject：修改实例所属项目。
  • modifyAutoRenew：修改实例续费模式。

示例值：rename
InstanceIds.N 否 Array of String 实例 ID 数组。
示例值：["kee-r3nqjq3n","kee-9bvd9b8v"]
InstanceNames.N 否 Array of String 实例的新名称。
示例值：["newname1","newname2"]
ProjectId 否 Integer 实例新的项目 ID。
示例值：10035
AutoRenews.N 否 Array of Integer 包年包月计费的续费模式。InstanceIds数组和AutoRenews数组中的修改值对应。
  • 0：默认状态，指手动续费。
  • 1：自动续费。
  • 2：到期不再续费。

示例值：[1,0]

3. 输出参数

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

4. 示例

示例1 示例1

输入示例

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

{
    "Operation": "rename",
    "InstanceIds": [
        "kee-4nmv****",
        "kee-9clkb977"
    ],
    "InstanceNames": [
        "重命名1",
        "重命名2"
    ]
}

输出示例

{
    "Response": {
        "RequestId": "f62b5c24-8d4a-4c00-97f5-3810fa5f76c6"
    }
}

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 未授权操作。
UnsupportedOperation.IsAutoRenewError 自动续费标识错误。
中国站