{ "name": "keewidb", "display_name": "云数据库 KeeWiDB", "description": "介绍如何使用API对云数据库KeeWiDB进行操作，包括创建实例、备份和恢复等。", "domain": "database", "api_version": "2022-03-08", "endpoint": "keewidb.tencentcloudapi.com", "actions": [ { "name": "AssociateSecurityGroups", "description": "本接口 (AssociateSecurityGroups) 用于安全组批量绑定多个指定实例。", "status": "online", "parameters": [ { "name": "Product", "type": "string", "required": true, "description": "数据库引擎名称：keewidb。", "example": "keewidb" }, { "name": "SecurityGroupId", "type": "string", "required": true, "description": "要绑定的安全组 ID，类似sg-efil7***。", "example": "sg-ajr1jzgj" }, { "name": "InstanceIds", "type": "array", "required": true, "description": "实例 ID，格式如：kee-c1nl9***，支持指定多个实例。", "example": "[\"kee-eb2w7dto\"]", "item_type": "string" } ], "required": [ "Product", "SecurityGroupId", "InstanceIds" ] }, { "name": "ChangeInstanceMaster", "description": "本接口（ChangeInstanceMaster）用于将副本节点提升为主节点。", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "实例 ID，如：kee-6ubh****。", "example": "kee-6ubhgouj" }, { "name": "NodeId", "type": "string", "required": true, "description": "副本节点 ID。", "example": "edcfcc21cef97eabbbeeb52067de8eddffc85772" } ], "required": [ "InstanceId", "NodeId" ] }, { "name": "CleanUpInstance", "description": "本接口（CleanUpInstance）用于立即下线回收站已隔离的实例。", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "实例 ID，如：kee-6ubh****。", "example": "kee-6ubhgouj" } ], "required": [ "InstanceId" ] }, { "name": "ClearInstance", "description": "本接口（ClearInstance）用于清空实例数据。 \u003e **说明**：在清空数据流程中，系统将自动进行数据备份，耗时较长，请您耐心等待并提前做好时间规划。", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "实例 ID，如：kee-6ubhg****。", "example": "kee-6ubhgouj" }, { "name": "Password", "type": "string", "required": false, "description": "实例访问密码。 实例为免密访问，则无需设置该参数。", "example": "Mypassword1" } ], "required": [ "InstanceId" ] }, { "name": "CreateBackupManually", "description": "手动发起备份", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "待操作的实例 ID，可通过 DescribeInstance接口返回值中的 InstanceId 获取。", "example": "kee-7iw94215" }, { "name": "Remark", "type": "string", "required": false, "description": "本次备份的备注信息。", "example": "备份test" }, { "name": "StorageDays", "type": "integer", "required": false, "description": "备份文件保存天数。0代表指定默认保留时间", "example": "7" } ], "required": [ "InstanceId" ] }, { "name": "CreateInstances", "description": "创建数据库实例", "status": "online", "parameters": [ { "name": "TypeId", "type": "integer", "required": true, "description": "产品版本。14：极速版。", "example": "14" }, { "name": "UniqVpcId", "type": "string", "required": true, "description": "私有网络唯一ID。请登录控制台在私有网络列表查询，如：vpc-azlk3***。", "example": "vpc-azlk31bs" }, { "name": "UniqSubnetId", "type": "string", "required": true, "description": "私有网络所属子网唯一ID。请登录控制台在私有网络列表查询，如：subnet-8abje***。", "example": "subnet-8abjechk" }, { "name": "BillingMode", "type": "integer", "required": true, "description": "计费模式。0：按量计费。1：包年包月。", "example": "1" }, { "name": "GoodsNum", "type": "integer", "required": true, "description": "实例数量，单次最大购买数量以查询产品售卖规格返回的数量为准。", "example": "1" }, { "name": "Period", "type": "integer", "required": true, "description": "选择包年包月计费模式（BillingMode 设置为1）时，您需要选择购买实例的时长。单位：月，取值范围 [1,2,3,4,5,6,7,8,9,10,11,12,24,36]。按量计费（BillingMode 设置为0）实例该参数设置为1即可。", "example": "1" }, { "name": "ShardNum", "type": "integer", "required": true, "description": "分片数量，支持选择3、5、6、8、9、10、12、15、16、18、20、21、24、25、27、30、32、33、35、36、39、40、42、45、48、50、51、54、55、56、57、60、63、64分片。", "example": "3" }, { "name": "ReplicasNum", "type": "integer", "required": true, "description": "副本数。当前仅支持设置1个副本节点，即每一个分片仅包含1个主节点与1个副本节点，数据主从实时热备。", "example": "1" }, { "name": "MachineMemory", "type": "integer", "required": true, "description": "实例内存容量，单位：GB。KeeWiDB 内存容量MachineMemory与持久内存容量MemSize为固定搭配，即2GB内存，固定分配8GB的持久内存，不可选择。具体信息，请参见产品规格。", "example": "8" }, { "name": "ZoneId", "type": "integer", "required": false, "description": "实例所属的可用区ID。具体取值，请参见地域和可用区获取。参数ZoneId和ZoneName至少配置其中一个。", "example": "100006" }, { "name": "ZoneName", "type": "string", "required": false, "description": "实例所属的可用区名称。具体取值，请参见地域和可用区获取。参数ZoneId和ZoneName至少配置其中一个。", "example": "ap-guangzhou-6" }, { "name": "InstanceName", "type": "string", "required": false, "description": "创建实例的名称。仅支持长度小于60的中文、英文或者数字，短划线\"-\"、下划线\"_\"。", "example": "myInstance" }, { "name": "NoAuth", "type": "boolean", "required": false, "description": "指明创建的实例是否需要支持免密访问。true：免密实例。false：非免密实例，默认为非免密实例。此时，需要设置访问密码。", "example": "false" }, { "name": "Password", "type": "string", "required": false, "description": "实例访问密码。当参数NoAuth为true时，Password为无需设置，否则Password为必填参数。密码复杂度要求：8-30个字符。至少包含小写字母、大写字母、数字和字符 ()`~!@#$%^\u0026amp;*-+=_|{}[]:;\u0026lt;\u0026gt;,.?/ 中的2种。不能以\"/\"开头。", "example": "123456MyP@ssword" }, { "name": "VPort", "type": "integer", "required": false, "description": "自定义端口。默认为6379，范围[1024,65535]。", "example": "6378" }, { "name": "AutoRenew", "type": "integer", "required": false, "description": "包年包月计费的续费模式。0：默认状态，指手动续费。1：自动续费。2：到期不再续费。", "example": "0" }, { "name": "SecurityGroupIdList", "type": "array", "required": false, "description": "给实例设置安全组 ID 数组。", "example": "[\"sg-bmadczm1\"]", "item_type": "string" }, { "name": "ResourceTags", "type": "array", "required": false, "description": "给实例绑定标签。", "example": "无", "item_type": "object", "children": [ { "name": "TagKey", "type": "string", "required": true, "description": "标签 Key。", "example": "key1" }, { "name": "TagValue", "type": "string", "required": true, "description": "标签 Value。", "example": "value1" } ] }, { "name": "MemSize", "type": "integer", "required": false, "description": "极速版，单分片持久化内存容量。KeeWiDB 内存容量MachineMemory与持久内存容量MemSize为固定搭配，即2GB内存，固定分配8GB的持久内存，不可选择。具体信息，请参见产品规格。单位：GB。", "example": "16" }, { "name": "DiskSize", "type": "integer", "required": false, "description": "每个分片硬盘的容量。单位：GB。每一缓存分片容量，对应的磁盘容量范围不同。具体信息，请参见产品规格。", "example": "100" }, { "name": "MachineCpu", "type": "integer", "required": false, "description": "计算 CPU 核数，可忽略不传。CPU 核数与内存为固定搭配，具体信息，请参见产品规格。", "example": "2" }, { "name": "ProjectId", "type": "integer", "required": false, "description": "项目id，取值以用户账户\u0026gt;用户账户相关接口查询\u0026gt;项目列表返回的projectId为准。", "example": "0" }, { "name": "Compression", "type": "string", "required": false, "description": "数据压缩开关。ON：开启，默认开启压缩。OFF：关闭。", "example": "ON" } ], "required": [ "TypeId", "UniqVpcId", "UniqSubnetId", "BillingMode", "GoodsNum", "Period", "ShardNum", "ReplicasNum", "MachineMemory" ] }, { "name": "DescribeAutoBackupConfig", "description": "本接口（DescribeAutoBackupConfig）用于获取自动备份配置。", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "实例 ID。", "example": "kee-rzx9zsz1" } ], "required": [ "InstanceId" ] }, { "name": "DescribeConnectionConfig", "description": "本接口（DescribeConnectionConfig）用于查询实例连接配置，包括出流量和入流量带宽、最大连接数限制。", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "实例 ID，如：kee-6ubh****。", "example": "kee-6ubhgouj" } ], "required": [ "InstanceId" ] }, { "name": "DescribeDBSecurityGroups", "description": "本接口(DescribeDBSecurityGroups)用于查询实例的安全组详情。", "status": "online", "parameters": [ { "name": "Product", "type": "string", "required": true, "description": "数据库引擎名称：keewidb。", "example": "keewidb" }, { "name": "InstanceId", "type": "string", "required": true, "description": "实例ID，格式如：kee-c1nl9***。", "example": "kee-c1nl9rpv" } ], "required": [ "Product", "InstanceId" ] }, { "name": "DescribeInstanceBackups", "description": "本接口（DescribeInstanceBackups）用于查询实例全量备份列表。", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "待操作的实例ID，可通过 DescribeInstance 接口返回值中的 InstanceId 获取。", "example": "kee-7iw94215" }, { "name": "Limit", "type": "integer", "required": false, "description": "每页输出的备份列表大小，即每页输出的备份文件的数量，默认值20，取值范围为[1,100]。", "example": "10" }, { "name": "Offset", "type": "integer", "required": false, "description": "备份列表分页偏移量，取Limit整数倍。 计算公式为offset=limit*(页码-1)。例如 limit=10，第1页offset就为0，第2页offset就为10，依次类推。", "example": "0" }, { "name": "BeginTime", "type": "string", "required": false, "description": "查询备份文件的开始时间，格式如：2017-02-08 16:46:34。查询实例在 [BeginTime, EndTime] 时间段内的备份列表。", "example": "2022-02-08 16:46:34" }, { "name": "EndTime", "type": "string", "required": false, "description": "查询备份文件的结束时间，格式如：2017-02-08 19:09:26。查询实例在 [beginTime, endTime] 时间段内的备份列表。", "example": "2022-02-08 20:46:34" }, { "name": "Status", "type": "array", "required": false, "description": "备份任务状态。1：备份在流程中。2：备份正常。3：备份转RDB文件处理中。4：已完成RDB转换。-1：备份已过期。-2：备份已删除。", "example": "2", "item_type": "integer" } ], "required": [ "InstanceId" ] }, { "name": "DescribeInstanceBinlogs", "description": "本接口（DescribeInstanceBinlogs）用于查询增量备份列表。", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "实例 ID。", "example": "kee-1jg409h5" }, { "name": "Limit", "type": "integer", "required": false, "description": "每页输出备份列表大小，默认大小20。", "example": "100" }, { "name": "Offset", "type": "integer", "required": false, "description": "分页偏移量，取Limit整数倍。", "example": "0" }, { "name": "BeginTime", "type": "string", "required": false, "description": "开始时间，格式如：2017-02-08 16:46:34。查询实例在 [beginTime, endTime] 时间段内开始备份的备份列表。", "example": "2022-02-08 16:46:34" }, { "name": "EndTime", "type": "string", "required": false, "description": "结束时间，格式如：2017-02-08 19:09:26。查询实例在 [beginTime, endTime] 时间段内开始备份的备份列表。", "example": "2022-02-08 20:46:34" } ], "required": [ "InstanceId" ] }, { "name": "DescribeInstanceDealDetail", "description": "本接口（DescribeInstanceDealDetail）用于查询预付费订单信息。", "status": "online", "parameters": [ { "name": "DealName", "type": "string", "required": false, "description": "订单号，订单交易ID数组，即 [CreateInstances](https://cloud.tencent.com/document/api/1520/86207) 的输出参数DealName。", "example": "20250925297021530748195" } ], "required": [] }, { "name": "DescribeInstanceNodeInfo", "description": "本接口（DescribeInstanceNodeInfo）查询实例节点信息。", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "实例 ID，如：kee-6ubh****。", "example": "kee-6ubhgouj" }, { "name": "Limit", "type": "integer", "required": false, "description": "每页输出的节点信息大小。默认为 20。", "example": "100" }, { "name": "Offset", "type": "integer", "required": false, "description": "分页偏移量，取Limit整数倍。计算公式：offset=limit*(页码-1)。", "example": "0" } ], "required": [ "InstanceId" ] }, { "name": "DescribeInstanceParamRecords", "description": "本接口（DescribeInstanceParamRecords）查询参数配置修改历史列表。", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "实例 ID，如：kee-6ubh****。", "example": "kee-6ubhgouj" }, { "name": "Limit", "type": "integer", "required": false, "description": "每页输出的参数列表大小。默认为 20，最多输出100条。", "example": "100" }, { "name": "Offset", "type": "integer", "required": false, "description": "分页偏移量，取Limit整数倍。计算公式：offset=limit*(页码-1)。", "example": "0" } ], "required": [ "InstanceId" ] }, { "name": "DescribeInstanceParams", "description": "本接口（DescribeInstanceParams）用于查询实例的参数列表。", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "实例 ID，如：kee-6ubh****。", "example": "kee-6ubhgouj" } ], "required": [ "InstanceId" ] }, { "name": "DescribeInstanceReplicas", "description": "本接口（DescribeInstanceReplicas）用于获取实例副本节点信息。", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "实例 ID，如：kee-6ubh****。", "example": "kee-6ubhgouj" } ], "required": [ "InstanceId" ] }, { "name": "DescribeInstances", "description": "本接口（DescribeInstances）可以根据地域、网络、实例id、标签、计费方式等条件，搜索查询实例列表。", "status": "online", "parameters": [ { "name": "Limit", "type": "integer", "required": false, "description": "每页输出的实例列表的大小，即每页输出的实例数量，默认值20，取值范围为[1,1000]。", "example": "100" }, { "name": "Offset", "type": "integer", "required": false, "description": "分页偏移量，取Limit整数倍。 计算公式为offset=limit*(页码-1)。例如 limit=10，第1页offset就为0，第2页offset就为10，依次类推。", "example": "0" }, { "name": "InstanceId", "type": "string", "required": false, "description": "实例 ID，如：kee-6ubh****。", "example": "kee-6ubhgouj" }, { "name": "OrderBy", "type": "string", "required": false, "description": "排序依据。枚举范围如下所示。 projectId：实例按照项目ID排序。createtime：实例按照创建时间排序。instancename：实例按照实例名称排序。type：实例按照类型排序。curDeadline：实例按照到期时间排序。", "example": "createtime" }, { "name": "OrderType", "type": "integer", "required": false, "description": "排序方式。1：倒序。默认为倒序。0：顺序。", "example": "1" }, { "name": "VpcIds", "type": "array", "required": false, "description": "私有网络ID数组。数组下标从0开始，如果不传则默认选择基础网络，如：47525", "example": "47525", "item_type": "string" }, { "name": "SubnetIds", "type": "array", "required": false, "description": "子网ID数组，数组下标从0开始，如：56854", "example": "56854", "item_type": "string" }, { "name": "ProjectIds", "type": "array", "required": false, "description": "项目ID 组成的数组，数组下标从0开始", "example": "[1289900]", "item_type": "integer" }, { "name": "SearchKey", "type": "string", "required": false, "description": "查找关键字，可输入实例的ID或者实例名称。", "example": "模糊查询实例名称" }, { "name": "InstanceName", "type": "string", "required": false, "description": "实例名称。", "example": "example_InstanceName" }, { "name": "UniqVpcIds", "type": "array", "required": false, "description": "私有网络ID数组，数组下标从0开始，如果不传则默认选择基础网络，如：vpc-sad23jfdfk", "example": "vpc-b6fsjaxt", "item_type": "string" }, { "name": "UniqSubnetIds", "type": "array", "required": false, "description": "子网ID数组，数组下标从0开始，如：subnet-fdj24n34j2", "example": "subnet-gqj66zh0", "item_type": "string" }, { "name": "Status", "type": "array", "required": false, "description": "实例状态。0：待初始化。1：流程中。2：运行中。-2：已隔离。-3：待删除。", "example": "1", "item_type": "integer" }, { "name": "AutoRenew", "type": "array", "required": false, "description": "续费模式。- 0：手动续费。- 1：自动续费。- 2：到期不再续费。", "example": "1", "item_type": "integer" }, { "name": "BillingMode", "type": "string", "required": false, "description": "计费模式。postpaid：按量计费。prepaid：包年包月。", "example": "1" }, { "name": "Type", "type": "integer", "required": false, "description": "实例类型。13：标准版。14：集群版。", "example": "13" }, { "name": "SearchKeys", "type": "array", "required": false, "description": "搜索关键词：支持实例 ID、实例名称、私有网络IP地址。", "example": "[\"kee-dagpcalj\"]", "item_type": "string" }, { "name": "TypeList", "type": "array", "required": false, "description": "内部参数，用户可忽略。", "example": "1", "item_type": "integer" }, { "name": "MonitorVersion", "type": "string", "required": false, "description": "内部参数，用户可忽略。", "example": "1" }, { "name": "TagKeys", "type": "array", "required": false, "description": "根据标签的 Key 筛选资源，该参数不配置或者数组设置为空值，则不根据标签Key进行过滤。", "example": "keyname", "item_type": "string" }, { "name": "TagList", "type": "array", "required": false, "description": "根据标签的 Key 和 Value 筛选资源。该参数不配置或者数组设置为空值，则不根据标签进行过滤。", "example": "[{\"TagKey\": \"key1\", \"TagValue\": \"value1\"}]", "item_type": "object", "children": [ { "name": "TagKey", "type": "string", "required": false, "description": "标签键", "example": "key1" }, { "name": "TagValue", "type": "string", "required": false, "description": "标签值", "example": "value1" } ] } ], "required": [] }, { "name": "DescribeMaintenanceWindow", "description": "本接口（DescribeMaintenanceWindow）用于查询实例维护时间窗。", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "实例 ID，如：kee-6ubhg***。", "example": "kee-6ubhgouj" } ], "required": [ "InstanceId" ] }, { "name": "DescribeProductInfo", "description": "本接口查询指定可用区和实例类型下keewidb 的售卖规格， 如果用户不在购买白名单中，将不能查询该可用区或该类型的售卖规格详情。申请购买某地域白名单可以提交工单", "status": "online", "parameters": [], "required": [] }, { "name": "DescribeProjectSecurityGroups", "description": "本接口(DescribeProjectSecurityGroups)用于查询项目的安全组详情。", "status": "online", "parameters": [ { "name": "Product", "type": "string", "required": true, "description": "数据库引擎名称。该产品固定为 keewidb。", "example": "keewidb" }, { "name": "ProjectId", "type": "integer", "required": false, "description": "项目 ID。 登录 [账号中心](https://console.cloud.tencent.com/developer)，在项目管理中可获取项目 ID。", "example": "11954" }, { "name": "Offset", "type": "integer", "required": false, "description": "分页偏移量，取Limit整数倍。计算公式：offset=limit*(页码-1)。", "example": "0" }, { "name": "Limit", "type": "integer", "required": false, "description": "每页安全组的数量限制。默认为 20，最多输出100条。", "example": "20" }, { "name": "SearchKey", "type": "string", "required": false, "description": "搜索关键词，支持根据安全组 ID 或者安全组名称搜索。", "example": "sg-0klp2oyp" } ], "required": [ "Product" ] }, { "name": "DescribeProxySlowLog", "description": "本接口（DescribeProxySlowLog）用于查询代理（Proxy）慢日志。", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "实例 ID，如：kee-6ubhgouj", "example": "kee-6ubhgouj" }, { "name": "BeginTime", "type": "string", "required": true, "description": "开始时间。", "example": "2022-02-23 11:06:01" }, { "name": "EndTime", "type": "string", "required": true, "description": "结束时间。", "example": "2022-02-23 11:06:01" }, { "name": "MinQueryTime", "type": "integer", "required": false, "description": "慢查询平均执行时间阈值。单位：毫秒。取值范围：10、20、30、40、50。", "example": "100" }, { "name": "Limit", "type": "integer", "required": false, "description": "每个页面大小，即每个页面输出慢日志的数量。取值范围为：10、20、30、40、50，默认为 20。", "example": "10" }, { "name": "Offset", "type": "integer", "required": false, "description": "页面偏移量，取Limit整数倍，计算公式：offset=limit*(页码-1)。", "example": "0" } ], "required": [ "InstanceId", "BeginTime", "EndTime" ] }, { "name": "DescribeTaskInfo", "description": "本接口（DescribeTaskInfo）用于查询异步任务结果。", "status": "online", "parameters": [ { "name": "TaskId", "type": "integer", "required": true, "description": "任务 ID。", "example": "155684" } ], "required": [ "TaskId" ] }, { "name": "DescribeTaskList", "description": "本接口（DescribeTaskList）用于查询任务列表信息。", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": false, "description": "实例 ID，如：kee-6ubh****。", "example": "kee-6ubhgouj" }, { "name": "InstanceName", "type": "string", "required": false, "description": "实例名称。", "example": "实例1" }, { "name": "Limit", "type": "integer", "required": false, "description": "每页输出的任务列表大小。默认为 20，最多输出100条。", "example": "100" }, { "name": "Offset", "type": "integer", "required": false, "description": "Offset：分页偏移量，取Limit整数倍。计算公式：offset=limit*(页码-1)。", "example": "0" }, { "name": "ProjectIds", "type": "array", "required": false, "description": "项目ID。", "example": "[11322, 11321]", "item_type": "integer" }, { "name": "TaskTypes", "type": "array", "required": false, "description": "任务类型。可设置为：FLOW_CREATE、FLOW_SETPWD、FLOW_CLOSE等。", "example": "[\"032\",\"034\"]", "item_type": "string" }, { "name": "BeginTime", "type": "string", "required": false, "description": "起始时间。", "example": "2021-12-30 00:00:00" }, { "name": "EndTime", "type": "string", "required": false, "description": "终止时间。", "example": "2021-12-30 00:00:00" }, { "name": "TaskStatus", "type": "array", "required": false, "description": "任务状态。", "example": "[0.1.2]", "item_type": "integer" } ], "required": [] }, { "name": "DescribeTendisSlowLog", "description": "本接口（DescribeTendisSlowLog）用于查询实例慢日志。", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "实例 ID，如：kee-6ubh****。", "example": "kee-6ubhgouj" }, { "name": "BeginTime", "type": "string", "required": true, "description": "开始时间。", "example": "2022-02-23 11:06:01" }, { "name": "EndTime", "type": "string", "required": true, "description": "结束时间。", "example": "2022-02-23 11:06:01" }, { "name": "MinQueryTime", "type": "integer", "required": false, "description": "慢查询平均执行时间阈值。单位：毫秒。取值范围：10、20、30、40、50。", "example": "10" }, { "name": "Limit", "type": "integer", "required": false, "description": "每个页面大小，即每个页面输出慢日志的数量。取值范围为：10、20、30、40、50。默认为 20。", "example": "10" }, { "name": "Offset", "type": "integer", "required": false, "description": "页面偏移量，取Limit整数倍，计算公式：offset=limit*(页码-1)。", "example": "0" } ], "required": [ "InstanceId", "BeginTime", "EndTime" ] }, { "name": "DestroyPostpaidInstance", "description": "本接口（DestroyPostpaidInstance）用于退还按量计费实例。", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "实例 ID。", "example": "kee-7djvzcnx" } ], "required": [ "InstanceId" ] }, { "name": "DestroyPrepaidInstance", "description": "本接口（DestroyPrepaidInstance）用于退还包年包月计费实例。", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "实例 ID。", "example": "kee-7djvzcnx" } ], "required": [ "InstanceId" ] }, { "name": "DisassociateSecurityGroups", "description": "本接口(DisassociateSecurityGroups)用于安全组批量解绑实例。", "status": "online", "parameters": [ { "name": "Product", "type": "string", "required": true, "description": "数据库引擎名称：keewidb。", "example": "keewidb" }, { "name": "SecurityGroupId", "type": "string", "required": true, "description": "要绑定的安全组 ID，类似sg-efil****。", "example": "sg-ajr1jzgj" }, { "name": "InstanceIds", "type": "array", "required": true, "description": "实例 ID，格式如：kee-c1nl****，支持指定多个实例。", "example": "[\"kee-eb2w7dto\"]", "item_type": "string" } ], "required": [ "Product", "SecurityGroupId", "InstanceIds" ] }, { "name": "ModifyAutoBackupConfig", "description": "本接口（ModifyAutoBackupConfig）用于修改自动备份配置。", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "实例 ID。", "example": "kee-7iw94215" }, { "name": "WeekDays", "type": "array", "required": true, "description": "备份周期。可设置为 Monday，Tuesday，Wednesday，Thursday，Friday，Saturday，Sunday，该参数暂不支持修改、", "example": "[\"Monday\",\"Tuesday\",\"Wednesday\",\"Thursday\",\"Friday\"]", "item_type": "string" }, { "name": "TimePeriod", "type": "string", "required": true, "description": "备份任务执行时间段。 可设置的格式为一个整点到下一个整点。例如：00:00-01:00、01:00-02:00、21:00-22:00、23:00-00:00等。", "example": "01:00-02:00" } ], "required": [ "InstanceId", "WeekDays", "TimePeriod" ] }, { "name": "ModifyConnectionConfig", "description": "本接口（ModifyConnectionConfig）用于修改实例的连接配置，包括带宽和最大连接数。", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "实例 ID，如：kee-6ubh****。", "example": "kee-6ubhgouj" }, { "name": "Bandwidth", "type": "integer", "required": false, "description": "单分片附加带宽，取值范围[0,512]，单位：MB。 开启副本只读时，实例总带宽 = 单分片附加带宽 * 分片数 + 标准带宽 * 分片数 * Max ([只读副本数量, 1])，标准架构的分片数 = 1。没有开启副本只读时，实例总带宽 = 单分片附加带宽 * 分片数 + 标准带宽 * 分片数，标准架构的分片数 = 1。", "example": "5" }, { "name": "ClientLimit", "type": "integer", "required": false, "description": "单分片的总连接数。 默认为10000，整个实例的最大连接数为单个分片的最大连接数 x 分片数量。标准架构分片数量为1。 关闭副本只读：每个分片的最大连接数的取值范围为[10000,40000]。开启副本只读：每个分片的最大连接数的取值范围为 [10000,10000 x (副本数 + 3)]。", "example": "20000" } ], "required": [ "InstanceId" ] }, { "name": "ModifyDBInstanceSecurityGroups", "description": "本接口(ModifyDBInstanceSecurityGroups)用于修改实例绑定的安全组。", "status": "online", "parameters": [ { "name": "Product", "type": "string", "required": true, "description": "数据库引擎名称：keewidb。", "example": "keewidb" }, { "name": "SecurityGroupIds", "type": "array", "required": true, "description": "要修改的安全组ID列表，一个或者多个安全组 ID 组成的数组。", "example": "[\"sg-ajr1jzgj\\n\"]", "item_type": "string" }, { "name": "InstanceId", "type": "string", "required": true, "description": "实例ID，格式如：kee-c1nl****。", "example": "kee-eb2w7dto" } ], "required": [ "Product", "SecurityGroupIds", "InstanceId" ] }, { "name": "ModifyInstance", "description": "本接口（ModifyInstance）用于修改实例相关信息。", "status": "online", "parameters": [ { "name": "Operation", "type": "string", "required": true, "description": "修改实例操作。rename：表示实例重命名。modifyProject：修改实例所属项目。modifyAutoRenew：修改实例续费模式。", "example": "rename" }, { "name": "InstanceIds", "type": "array", "required": false, "description": "实例 ID 数组。", "example": "[\"kee-r3nqjq3n\",\"kee-9bvd9b8v\"]", "item_type": "string" }, { "name": "InstanceNames", "type": "array", "required": false, "description": "实例的新名称。", "example": "[\"newname1\",\"newname2\"]", "item_type": "string" }, { "name": "ProjectId", "type": "integer", "required": false, "description": "实例新的项目 ID。", "example": "10035" }, { "name": "AutoRenews", "type": "array", "required": false, "description": "包年包月计费的续费模式。InstanceIds数组和AutoRenews数组中的修改值对应。0：默认状态，指手动续费。1：自动续费。2：到期不再续费。", "example": "[1,0]", "item_type": "integer" } ], "required": [ "Operation" ] }, { "name": "ModifyInstanceParams", "description": "本接口（ModifyInstanceParams）用于修改实例参数配置。", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "实例 ID，如：kee-6ubh****。", "example": "kee-6ubhgouj" }, { "name": "InstanceParams", "type": "array", "required": true, "description": "实例修改的参数列表。", "example": "无", "item_type": "object", "children": [ { "name": "Key", "type": "string", "required": true, "description": "设置参数的名字", "example": "cluster-node-timeout" }, { "name": "Value", "type": "string", "required": true, "description": "设置参数的值", "example": "15000" } ] } ], "required": [ "InstanceId", "InstanceParams" ] }, { "name": "ModifyMaintenanceWindow", "description": "本接口（ModifyMaintenanceWindow）修改实例维护时间窗时间。", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "实例 ID，如：kee-6ubh****。", "example": "kee-6ubhgouj" }, { "name": "StartTime", "type": "string", "required": true, "description": "维护时间窗起始时间，如：03:00。", "example": "03:00" }, { "name": "EndTime", "type": "string", "required": true, "description": "维护时间窗结束时间，如：06:00。", "example": "06:00" } ], "required": [ "InstanceId", "StartTime", "EndTime" ] }, { "name": "ModifyNetworkConfig", "description": "本接口（ModifyNetworkConfig）用于修改实例网络配置。", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "实例 ID，如：kee-6ubh****。", "example": "kee-6ubhgouj" }, { "name": "Operation", "type": "string", "required": true, "description": "操作类型。changeVip：修改实例私有网络。changeVpc：修改实例私有网络所属子网。changeBaseToVpc：基础网络转为私有网络。", "example": "changeVip" }, { "name": "Vip", "type": "string", "required": false, "description": "修改后的 VIP 地址。 当参数Operation为changeVip时，需设置实例修改后的 VIP 地址。该参数不配置，则自动分配。", "example": "10.1.1.2" }, { "name": "VpcId", "type": "string", "required": false, "description": "修改后的私有网络 ID。 当参数Operation为changeVip或者为changeBaseToVpc时，务必设置实例修改后的私有网络 ID。", "example": "vpc-hu6khgap" }, { "name": "SubnetId", "type": "string", "required": false, "description": "修改后的所属子网 ID。 当参数Operation为changeVpc或者为changeBaseToVpc时，务必设置实例修改后的子网 ID。", "example": "subnet-6mt7lir6" }, { "name": "Recycle", "type": "integer", "required": false, "description": "原 VIP 保留时长。 单位：天。取值范围：0、1、2、3、7、15。", "example": "7" } ], "required": [ "InstanceId", "Operation" ] }, { "name": "RenewInstance", "description": "本接口（RenewInstance）用于为包年包月计费实例续费。", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "实例 ID。", "example": "kee-7djvzcnx" }, { "name": "Period", "type": "integer", "required": true, "description": "购买时长。单位：月。取值为 [1,2,3,4,5,6,7,8,9,10,11,12,24,36,48,60]。", "example": "1" } ], "required": [ "InstanceId", "Period" ] }, { "name": "ResetPassword", "description": "本接口（ResetPassword）用于重置数据库访问密码。", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "实例 ID。", "example": "kee-5a4py64p" }, { "name": "Password", "type": "string", "required": false, "description": "设置新密码。当参数NoAuth设置为true，切换为免密实例时，可不设置该参数。密码复杂度要求：长度8 - 30位, 推荐使用12位以上的密码。不能以\"/\"开头。 至少包含以下两项：小写字母a - z大写字母A - Z数字0 - 9()~!@#$%^\u0026*-+=_|{}[]:;,.?/", "example": "Mypassword" }, { "name": "NoAuth", "type": "boolean", "required": false, "description": "标识实例是否切换免密认证。false：由免密码认证方式切换为密码认证实例。默认为false。true：由密码认证方式切换为免密码认证的方式。", "example": "true" } ], "required": [ "InstanceId" ] }, { "name": "StartUpInstance", "description": "本接口（StartUpInstance）用于按量计费实例解隔离", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "实例 ID。", "example": "kee-7djvzcnx" } ], "required": [ "InstanceId" ] }, { "name": "UpgradeInstance", "description": "本接口（UpgradeInstance）用于对实例进行配置变更。", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "实例 ID。", "example": "kee-hi6dg0ro" }, { "name": "MemSize", "type": "integer", "required": false, "description": "配置变更后，每个分片持久化内存容量，单位：GB。 KeeWiDB 内存容量MachineMemory与持久内存容量MemSize为固定搭配，即2GB内存，固定分配8GB的持久内存，不可选择。具体信息，请参见[产品规格](https://cloud.tencent.com/document/product/1520/80808)。变更实例内存、持久化内存与磁盘、变更实例的分片数量，每次只能变更一项。", "example": "16" }, { "name": "MachineCpu", "type": "integer", "required": false, "description": "CPU 核数，可忽略不传", "example": "1" }, { "name": "MachineMemory", "type": "integer", "required": false, "description": "实例内存容量，单位：GB。 KeeWiDB 内存容量MachineMemory与持久内存容量MemSize为固定搭配，即2GB内存，固定分配8GB的持久内存，不可选择。具体信息，请参见[产品规格](https://cloud.tencent.com/document/product/1520/80808)。变更实例内存、持久化内存与磁盘、变更实例的分片数量，每次只能变更一项。", "example": "2" }, { "name": "ShardNum", "type": "integer", "required": false, "description": "配置变更后，分片数量。 增加后分片的数量务必为增加之前数量的整数倍。分片数量支持选择3、5、6、8、9、10、12、15、16、18、20、21、24、25、27、30、32、33、35、36、39、40、42、45、48、50、51、54、55、56、57、60、63、64分片。变更实例内存、持久化内存与磁盘、变更实例的分片数量，每次只能变更一项。", "example": "5" }, { "name": "DiskSize", "type": "integer", "required": false, "description": "配置变更后，每个分片硬盘的容量。单位：GB。 每一缓存分片容量，对应的磁盘容量范围不同。具体信息，请参见[产品规格](https://cloud.tencent.com/document/product/1520/80808)。变更实例内存、持久化内存与磁盘、变更实例的分片数量，每次只能变更一项。", "example": "100" } ], "required": [ "InstanceId" ] } ] }