{ "name": "cynosdb", "display_name": "TDSQL-C MySQL 版", "description": "介绍如何使用 API 对 TDSQL-C MySQL 版进行操作，包括购买新集群、查询集群列表、创建用户账号、续费集群等。", "domain": "database", "api_version": "2019-01-07", "endpoint": "cynosdb.tencentcloudapi.com", "actions": [ { "name": "ActivateInstance", "description": "本接口（ActivateInstance）用于恢复已隔离的实例访问。", "status": "online", "parameters": [ { "name": "ClusterId", "type": "string", "required": true, "description": "集群ID", "example": "cynosdbmysql-bzxxrmtq" }, { "name": "InstanceIdList", "type": "array", "required": true, "description": "实例 ID 列表，单个实例 ID 格式如：cynosdbmysql-ins-n7ocdslw，与TDSQL-C MySQL数据库控制台页面中显示的实例 ID 相同，可使用 查询实例列表 接口获取，其值为输出参数中字段 InstanceId 的值。", "example": "[\"cynosdbmysql-ins-7upukfpw\\r\\n\"]", "item_type": "string" } ], "required": [ "ClusterId", "InstanceIdList" ] }, { "name": "ActivateLibraDBCluster", "description": "解除分析集群隔离状态", "status": "online", "parameters": [ { "name": "ClusterId", "type": "string", "required": true, "description": "分析集群 ID", "example": "libradb-xxx" } ], "required": [ "ClusterId" ] }, { "name": "ActivateLibraDBInstance", "description": "本接口（ActivateLibraDBInstance）用于解除已隔离的只读分析引擎实例。", "status": "online", "parameters": [ { "name": "ClusterId", "type": "string", "required": true, "description": "集群ID", "example": "cynosdbmysql-bzxxrmtq" }, { "name": "InstanceIdList", "type": "array", "required": true, "description": "只读分析引擎实例 ID 列表", "example": "[\"cynosdbmysql-libradb-ins-mhrc48ym\"]", "item_type": "string" } ], "required": [ "ClusterId", "InstanceIdList" ] }, { "name": "AddClusterSlaveZone", "description": "本接口（AddClusterSlaveZone）用于对集群开启多可用区部署。", "status": "online", "parameters": [ { "name": "ClusterId", "type": "string", "required": true, "description": "集群ID", "example": "cynosdbmysql-xxxxxxx" }, { "name": "SlaveZone", "type": "string", "required": true, "description": "从可用区", "example": "ap-guangzhou-4" }, { "name": "BinlogSyncWay", "type": "string", "required": false, "description": "binlog同步方式。默认值：async。可选值：sync、semisync、async", "example": "async" }, { "name": "SemiSyncTimeout", "type": "integer", "required": false, "description": "半同步超时时间，单位ms。为保证业务稳定性，半同步复制存在退化逻辑，当主可用区集群在等待备可用区集群确认事务时若超过该超时时间，复制方式将降为异步复制。最低设置为1000ms，最高支持4294967295ms，默认10000ms。", "example": "10000" } ], "required": [ "ClusterId", "SlaveZone" ] }, { "name": "AddInstances", "description": "本接口（AddInstances）用于集群添加实例。", "status": "online", "parameters": [ { "name": "ClusterId", "type": "string", "required": true, "description": "集群ID", "example": "cynosdbmysql-6gtlgm5l" }, { "name": "Cpu", "type": "integer", "required": true, "description": "Cpu核数", "example": "2" }, { "name": "Memory", "type": "integer", "required": true, "description": "内存，单位为GB", "example": "4" }, { "name": "ReadOnlyCount", "type": "integer", "required": true, "description": "新增只读实例数，取值范围为(0,15]", "example": "1" }, { "name": "DeviceType", "type": "string", "required": false, "description": "实例机器类型，支持值如下： - common：表示通用型 - exclusive：表示独享型", "example": "exclusive" }, { "name": "VpcId", "type": "string", "required": false, "description": "所属VPC网络ID。", "example": "vpc-1ptuei0b" }, { "name": "SubnetId", "type": "string", "required": false, "description": "所属子网ID，如果设置了VpcId，则SubnetId必填。", "example": "subnet-1tmw9t4o" }, { "name": "Port", "type": "integer", "required": false, "description": "新增RO组时使用的Port，取值范围为[0,65535)", "example": "2000" }, { "name": "InstanceName", "type": "string", "required": false, "description": "实例名称，字符串长度范围为[0,64)，取值范围为大小写字母，0-9数字，'_','-','.'", "example": "cynosmysql-xxxxxxxx" }, { "name": "AutoVoucher", "type": "integer", "required": false, "description": "是否自动选择代金券 1是 0否 默认为0", "example": "0" }, { "name": "DbType", "type": "string", "required": false, "description": "数据库类型，取值范围: MYSQL", "example": "MYSQL" }, { "name": "OrderSource", "type": "string", "required": false, "description": "订单来源，字符串长度范围为[0,64)", "example": "api" }, { "name": "DealMode", "type": "integer", "required": false, "description": "交易模式 0-下单并支付 1-下单", "example": "0" }, { "name": "ParamTemplateId", "type": "integer", "required": false, "description": "参数模板ID", "example": "0" }, { "name": "InstanceParams", "type": "array", "required": false, "description": "参数列表，ParamTemplateId 传入时InstanceParams才有效", "example": "无", "item_type": "object", "children": [ { "name": "ParamName", "type": "string", "required": true, "description": "参数名", "example": "auto_increment_increment" }, { "name": "CurrentValue", "type": "string", "required": true, "description": "参数当前值", "example": "2" }, { "name": "OldValue", "type": "string", "required": false, "description": "参数旧值（只在出参时有用）", "example": "1" }, { "name": "Component", "type": "string", "required": false, "description": "libra组件类型", "example": "libracdc" } ] }, { "name": "SecurityGroupIds", "type": "array", "required": false, "description": "安全组ID，新建只读实例时可以指定安全组。", "example": "[\"sg-rgf3qgld\"]", "item_type": "string" }, { "name": "UpgradeProxy", "type": "object", "required": false, "description": "proxy同步升级", "example": "无", "children": [ { "name": "Cpu", "type": "integer", "required": true, "description": "cpu", "example": "2" }, { "name": "Mem", "type": "integer", "required": true, "description": "memory", "example": "4000" }, { "name": "ProxyZones", "type": "array", "required": true, "description": "代理节点信息", "example": "无", "item_type": "object", "children": [ { "name": "ProxyNodeZone", "type": "string", "required": false, "description": "proxy节点可用区", "example": "ap-guangzhou-3" }, { "name": "ProxyNodeCount", "type": "integer", "required": false, "description": "proxy节点数量", "example": "2" } ] }, { "name": "ReloadBalance", "type": "string", "required": false, "description": "重新负载均衡", "example": "auto" } ] } ], "required": [ "ClusterId", "Cpu", "Memory", "ReadOnlyCount" ] }, { "name": "AssociateSecurityGroups", "description": "本接口（AssociateSecurityGroups）用于安全组批量绑定云资源。", "status": "online", "parameters": [ { "name": "InstanceIds", "type": "array", "required": true, "description": "实例组 ID 数组，cynosdbmysql-grp-前缀开头或集群 ID。 说明：要获取集群的实例组 ID，可通过 [查询集群实例组](https://cloud.tencent.com/document/product/1003/103934) 进行。", "example": "cynosdbmysql-grp-beg2j3v0", "item_type": "string" }, { "name": "SecurityGroupIds", "type": "array", "required": true, "description": "要修改的安全组ID列表，一个或者多个安全组Id组成的数组。", "example": "[\"sg-ajr1jzgj\\n\"]", "item_type": "string" }, { "name": "Zone", "type": "string", "required": true, "description": "可用区", "example": "ap-guangzhou-3" } ], "required": [ "InstanceIds", "SecurityGroupIds", "Zone" ] }, { "name": "BindClusterResourcePackages", "description": "本接口（BindClusterResourcePackages）用于为集群绑定资源包。", "status": "online", "parameters": [ { "name": "PackageIds", "type": "array", "required": true, "description": "资源包唯一ID", "example": "package-abcd1234", "item_type": "string" }, { "name": "ClusterId", "type": "string", "required": true, "description": "集群ID", "example": "cynosdb-qwerty" } ], "required": [ "PackageIds", "ClusterId" ] }, { "name": "CheckCreateLibraDBInstance", "description": "本接口（CheckCreateLibraDBInstance）用于校验集群是否可以添加只读分析引擎实例", "status": "online", "parameters": [ { "name": "ClusterId", "type": "string", "required": true, "description": "集群ID", "example": "cynosdbmysql-6gtlgm5l" }, { "name": "InstanceId", "type": "string", "required": false, "description": "实例ID", "example": "libradb-ins-qvni5111" } ], "required": [ "ClusterId" ] }, { "name": "CloseAuditService", "description": "本接口（CloseAuditService）用于关闭 TDSQL-C MySQL 实例的数据库审计服务。", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "实例ID。", "example": "cynosdbmysql-ins-6990cckk" } ], "required": [ "InstanceId" ] }, { "name": "CloseClusterPasswordComplexity", "description": "本接口（CloseClusterPasswordComplexity）用于关闭集群密码复杂度。", "status": "online", "parameters": [ { "name": "ClusterIds", "type": "array", "required": true, "description": "集群ID数组", "example": "cynosdbpg-bzxxrmtq", "item_type": "string" } ], "required": [ "ClusterIds" ] }, { "name": "CloseProxy", "description": "本接口（CloseProxy）用于关闭集群的数据库代理服务。", "status": "online", "parameters": [ { "name": "ClusterId", "type": "string", "required": true, "description": "集群ID", "example": "cynosdbmysql-mwg7212w" }, { "name": "ProxyGroupId", "type": "string", "required": false, "description": "数据库代理组ID", "example": "cynosdbmysql-proxy-aroh7ke1" }, { "name": "OnlyCloseRW", "type": "boolean", "required": false, "description": "是否只关闭读写分离，取值：是 \"true\",\"false\"", "example": "false" } ], "required": [ "ClusterId" ] }, { "name": "CloseProxyEndPoint", "description": "本接口（CloseProxyEndPoint）用于关闭数据库代理连接地址。", "status": "online", "parameters": [ { "name": "ClusterId", "type": "string", "required": true, "description": "集群ID", "example": "cynosdbmysql-j9i41hdd" }, { "name": "ProxyGroupId", "type": "string", "required": true, "description": "数据库代理组ID", "example": "cynosdbmysql-proxy-lti34611" } ], "required": [ "ClusterId", "ProxyGroupId" ] }, { "name": "CloseSSL", "description": "关闭SSL加密", "status": "online", "parameters": [ { "name": "ClusterId", "type": "string", "required": true, "description": "集群ID", "example": "cynosdbmysql-bzxxrmtq" }, { "name": "InstanceId", "type": "string", "required": false, "description": "实例ID", "example": "cynosdbmysql-ins-bzxxrmtq" } ], "required": [ "ClusterId" ] }, { "name": "CloseWan", "description": "本接口（CloseWan）用于关闭外网。", "status": "online", "parameters": [ { "name": "InstanceGroupId", "type": "string", "required": false, "description": "实例组id", "example": "cynosdbmysql-grp-o48ssqs5" }, { "name": "InstanceId", "type": "string", "required": false, "description": "实例id", "example": "cynosdbmysql-ins-qvni5o11" } ], "required": [] }, { "name": "CopyClusterPasswordComplexity", "description": "本接口（CopyClusterPasswordComplexity）用于复制集群密码复杂度。", "status": "online", "parameters": [ { "name": "ClusterIds", "type": "array", "required": true, "description": "复制集群ID数组，例如[\"cynosdbmysql-bzxxrmtq\",\"cynosdbmysql-qwer\"]", "example": "cynosdbpg-bzxxrmtq", "item_type": "string" }, { "name": "SourceClusterId", "type": "string", "required": true, "description": "集群id，例如\"cynosdbmysql-bzxxrmtq\"", "example": "cynosdbpg-bzxxrmtq" } ], "required": [ "ClusterIds", "SourceClusterId" ] }, { "name": "CreateAccounts", "description": "本接口（CreateAccounts）用于创建用户账号。", "status": "online", "parameters": [ { "name": "ClusterId", "type": "string", "required": true, "description": "集群id", "example": "cynosdbmysql-asd45wwe" }, { "name": "Accounts", "type": "array", "required": true, "description": "新账户列表", "example": "无", "item_type": "object", "children": [ { "name": "AccountName", "type": "string", "required": true, "description": "账户名，包含字母数字_,以字母开头，字母或数字结尾，长度1-30", "example": "0" }, { "name": "AccountPassword", "type": "string", "required": true, "description": "密码，密码长度范围为8到64个字符", "example": "0" }, { "name": "Host", "type": "string", "required": true, "description": "主机(%或ipv4地址)", "example": "0" }, { "name": "Description", "type": "string", "required": false, "description": "描述", "example": "0" }, { "name": "MaxUserConnections", "type": "integer", "required": false, "description": "用户最大连接数，不能大于10240", "example": "0" } ] } ], "required": [ "ClusterId", "Accounts" ] }, { "name": "CreateAuditLogFile", "description": "本接口(CreateAuditLogFile)用于创建云数据库实例的审计日志文件。", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "实例ID", "example": "cynosdbmysql-ins-xx" }, { "name": "StartTime", "type": "string", "required": true, "description": "开始时间，格式为：\"2017-07-12 10:29:20\"。", "example": "2017-07-12 10:29:20" }, { "name": "EndTime", "type": "string", "required": true, "description": "结束时间，格式为：\"2017-07-12 10:29:20\"。", "example": "2017-07-12 10:29:20" }, { "name": "Order", "type": "string", "required": false, "description": "排序方式。支持值包括：\"ASC\" - 升序，\"DESC\" - 降序。", "example": "ASC" }, { "name": "OrderBy", "type": "string", "required": false, "description": "排序字段。支持值包括： \"timestamp\" - 时间戳； \"affectRows\" - 影响行数； \"execTime\" - 执行时间。", "example": "timestap" }, { "name": "LogFilter", "type": "array", "required": false, "description": "审计日志过滤条件", "example": "[{\"Type\": \"host\",\"Compare\": \"INC\",\"Value\": \"100.0.\"}]", "item_type": "object", "children": [ { "name": "Type", "type": "string", "required": true, "description": "过滤项。目前支持以下搜索条件： 包含、不包含、包含（分词维度）、不包含（分词维度）: sql - SQL详情；alarmLevel - 告警等级；ruleTemplateId - 规则模板Id 等于、不等于、包含、不包含： host - 客户端地址； user - 用户名； dbName - 数据库名称； 等于、不等于： sqlType - SQL类型； errCode - 错误码； threadId - 线程ID； 范围搜索（时间类型统一为微秒）： execTime - 执行时间； lockWaitTime - ...", "example": "host" }, { "name": "Compare", "type": "string", "required": true, "description": "过滤条件。支持以下条件： WINC-包含（分词维度）， WEXC-不包含（分词维度）, INC - 包含, EXC - 不包含, EQS - 等于, NEQ - 不等于, RA - 范围。", "example": "INC" }, { "name": "Value", "type": "array", "required": true, "description": "过滤的值。反向查询时，多个值之前是且的关系，正向查询多个值是或的关系。", "example": "100.0.", "item_type": "string" } ] }, { "name": "ColumnFilter", "type": "array", "required": false, "description": "审计日志列", "example": "[\"SqlType\",\"TableName\"]", "item_type": "string" } ], "required": [ "InstanceId", "StartTime", "EndTime" ] }, { "name": "CreateAuditRuleTemplate", "description": "本接口（CreateAuditRuleTemplate）用于创建审计规则模板。", "status": "online", "parameters": [ { "name": "RuleFilters", "type": "array", "required": true, "description": "审计规则。", "example": "[{\"Type\": \"sqlType\",\"Compare\": \"INC\",\"Value\": \"UPDATE\"}]", "item_type": "object", "children": [ { "name": "Type", "type": "string", "required": true, "description": "审计规则过滤条件的参数名称。可选值：host – 客户端 IP；user – 数据库账户；dbName – 数据库名称；sqlType-SQL类型；sql-sql语句；affectRows -影响行数；sentRows-返回行数；checkRows-扫描行数；execTime-执行时间。", "example": "sqlType" }, { "name": "Compare", "type": "string", "required": true, "description": "审计规则过滤条件的匹配类型。可选值：INC – 包含；EXC – 不包含；EQS – 等于；NEQ – 不等于；REG-正则；GT-大于；LT-小于。", "example": "INC" }, { "name": "Value", "type": "array", "required": true, "description": "审计规则过滤条件的匹配值。", "example": "UPDATE", "item_type": "string" } ] }, { "name": "RuleTemplateName", "type": "string", "required": true, "description": "规则模板名称。", "example": "andy" }, { "name": "Description", "type": "string", "required": false, "description": "规则模板描述。", "example": "andy模板" }, { "name": "AlarmLevel", "type": "integer", "required": false, "description": "告警等级。1-低风险，2-中风险，3-高风险", "example": "3" }, { "name": "AlarmPolicy", "type": "integer", "required": false, "description": "告警策略。0-不告警，1-告警。", "example": "1" } ], "required": [ "RuleFilters", "RuleTemplateName" ] }, { "name": "CreateBackup", "description": "本接口（CreateBackup）用于为集群创建手动备份。", "status": "online", "parameters": [ { "name": "ClusterId", "type": "string", "required": true, "description": "集群ID", "example": "cynosdbpg-45knmnra" }, { "name": "BackupType", "type": "string", "required": false, "description": "备份类型, 可选值：logic，逻辑备份；snapshot，物理备份", "example": "logic" }, { "name": "BackupDatabases", "type": "array", "required": false, "description": "备份的库, 只在 BackupType 为 logic 时有效", "example": "[\"db1\"]", "item_type": "string" }, { "name": "BackupTables", "type": "array", "required": false, "description": "备份的表, 只在 BackupType 为 logic 时有效", "example": "无", "item_type": "object", "children": [ { "name": "Database", "type": "string", "required": false, "description": "数据库名", "example": "db" }, { "name": "Tables", "type": "array", "required": false, "description": "表名称列表", "example": "[\"table1\", \"table2\"]", "item_type": "string" } ] }, { "name": "BackupName", "type": "string", "required": false, "description": "备注名", "example": "备份备注" } ], "required": [ "ClusterId" ] }, { "name": "CreateCLSDelivery", "description": "本接口（CreateCLSDelivery）用于创建日志投递。", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "实例id", "example": "cynosdbmysql-ins-ifq10f11" }, { "name": "CLSInfoList", "type": "array", "required": true, "description": "日志投递配置", "example": "[{\"TopicId\":\"38b86342-7cb0-4776-9ebd-ff1830035da1\",\"TopicOperation\":\"reuse\",\"GroupId\":\"17de6e2a-efd0-4fc2-ba2e-8845bd4f9895\",\"Region\":\"ap-guangzhou\",\"GroupOperation\":\"reuse\"}]", "item_type": "object", "children": [ { "name": "TopicOperation", "type": "string", "required": true, "description": "日志主题操作：可选create,reuse。 create:新增日志主题，使用TopicName创建日志主题。 reuse:使用已有日志主题，使用TopicId指定日志主题。 不允许使用已有日志主题且新建日志集的组合。", "example": "create" }, { "name": "GroupOperation", "type": "string", "required": true, "description": "日志集操作：可选create,reuse。 create:新增日志集，使用GroupName创建日志集。 reuse:使用已有日志集，使用GroupId指定日志集。 不允许使用已有日志主题且新建日志集的组合。", "example": "create" }, { "name": "Region", "type": "string", "required": true, "description": "日志投递地域", "example": "ap-guangzhou" }, { "name": "TopicId", "type": "string", "required": false, "description": "日志主题id", "example": "8c392615-b4c0-4f70-b07d-1fb5cd688f60" }, { "name": "TopicName", "type": "string", "required": false, "description": "日志主题name", "example": "cloud_lala_topic" }, { "name": "GroupId", "type": "string", "required": false, "description": "日志集id", "example": "95a03fb4-395b-4ce7-802b-4ce10c7431dd" }, { "name": "GroupName", "type": "string", "required": false, "description": "日志集name", "example": "cloud_haha_logset" } ] }, { "name": "LogType", "type": "string", "required": false, "description": "日志类型", "example": "slow" }, { "name": "IsInMaintainPeriod", "type": "string", "required": false, "description": "是否维护时间运行", "example": "no" } ], "required": [ "InstanceId", "CLSInfoList" ] }, { "name": "CreateClusterDatabase", "description": "本接口（CreateClusterDatabase）用于创建数据库。", "status": "online", "parameters": [ { "name": "ClusterId", "type": "string", "required": true, "description": "集群ID", "example": "cynosdbmysql-mwg7121e" }, { "name": "DbName", "type": "string", "required": true, "description": "数据库名", "example": "db1" }, { "name": "CharacterSet", "type": "string", "required": true, "description": "字符集类型", "example": "utf8" }, { "name": "CollateRule", "type": "string", "required": true, "description": "排序规则", "example": " utf8_general_ci " }, { "name": "UserHostPrivileges", "type": "array", "required": false, "description": "授权用户主机权限", "example": "[{\"DbUserName\": \"andy\",\"DbHost\": \"172.1.1.1\",\"DbPrivilege\": \"readonly\"}]", "item_type": "object", "children": [ { "name": "DbUserName", "type": "string", "required": true, "description": "授权用户", "example": "root" }, { "name": "DbHost", "type": "string", "required": true, "description": "客户端ip", "example": "%" }, { "name": "DbPrivilege", "type": "string", "required": true, "description": "用户权限", "example": "readonly" } ] }, { "name": "Description", "type": "string", "required": false, "description": "备注", "example": "负责一区业务" } ], "required": [ "ClusterId", "DbName", "CharacterSet", "CollateRule" ] }, { "name": "CreateClusters", "description": "本接口（CreateClusters）用于新购集群。", "status": "online", "parameters": [ { "name": "Zone", "type": "string", "required": true, "description": "可用区", "example": "ap-guangzhou-3" }, { "name": "VpcId", "type": "string", "required": true, "description": "所属VPC网络ID", "example": "vpc-1ptuei0b" }, { "name": "SubnetId", "type": "string", "required": true, "description": "所属子网ID", "example": "subnet-1tmw9t4o" }, { "name": "DbType", "type": "string", "required": true, "description": "数据库类型，取值范围: MYSQL", "example": "MYSQL" }, { "name": "DbVersion", "type": "string", "required": true, "description": "数据库版本，取值范围: MYSQL可选值：5.7，8.0", "example": "5.7" }, { "name": "ProjectId", "type": "integer", "required": false, "description": "所属项目ID", "example": "0" }, { "name": "Cpu", "type": "integer", "required": false, "description": "当DbMode为NORMAL或不填时必选 普通实例Cpu核数", "example": "1" }, { "name": "Memory", "type": "integer", "required": false, "description": "当DbMode为NORMAL或不填时必选 普通实例内存,单位GB", "example": "4" }, { "name": "InstanceCount", "type": "integer", "required": false, "description": "实例数量，数量范围为(0,16]，默认值为2（即一个rw实例+一个ro实例），传递的n表示1个rw实例+n-1个ro实例（规格相同），如需要更精确的集群组成搭配，请使用InstanceInitInfos", "example": "1" }, { "name": "Storage", "type": "integer", "required": false, "description": "该参数无实际意义，已废弃。 存储大小，单位GB。", "example": "100" }, { "name": "ClusterName", "type": "string", "required": false, "description": "集群名称，长度小于64个字符，每个字符取值范围：大/小写字母，数字，特殊符号（'-','_','.'）", "example": "MyClusterName" }, { "name": "AdminPassword", "type": "string", "required": false, "description": "账号密码(8-64个字符，包含大小写英文字母、数字和符号~!@#$%^\u0026*_-+=`|\\(){}[]:;',.?/中的任意三种)", "example": "passwd@admin" }, { "name": "Port", "type": "integer", "required": false, "description": "端口，默认3306，取值范围[0, 65535)", "example": "3306" }, { "name": "PayMode", "type": "integer", "required": false, "description": "计费模式，支持值为0和1，默认值为0。 取值为0，表示按量计费。 取值为1，表示包年包月。", "example": "0" }, { "name": "Count", "type": "integer", "required": false, "description": "购买集群数，可选值范围[1,50]，默认为1", "example": "1" }, { "name": "RollbackStrategy", "type": "string", "required": false, "description": "回档类型： noneRollback：不回档； snapRollback，快照回档； timeRollback，时间点回档", "example": "noneRollback" }, { "name": "RollbackId", "type": "integer", "required": false, "description": "快照回档，表示snapshotId；时间点回档，表示queryId，为0，表示需要判断时间点是否有效", "example": "0" }, { "name": "OriginalClusterId", "type": "string", "required": false, "description": "回档时，传入源集群ID，用于查找源poolId", "example": "cynosdbmysql-xxxxxxxx" }, { "name": "ExpectTime", "type": "string", "required": false, "description": "时间点回档，指定时间；快照回档，快照时间", "example": "2021-04-26 18:13:10" }, { "name": "ExpectTimeThresh", "type": "integer", "required": false, "description": "该参数无实际意义，已废弃。 时间点回档，指定时间允许范围", "example": "0" }, { "name": "StorageLimit", "type": "integer", "required": false, "description": "普通实例存储上限，单位GB 当DbType为MYSQL，且存储计费模式为预付费时，该参数需不大于cpu与memory对应存储规格上限", "example": "100" }, { "name": "TimeSpan", "type": "integer", "required": false, "description": "包年包月购买时长", "example": "1" }, { "name": "TimeUnit", "type": "string", "required": false, "description": "包年包月购买时长单位，['s','d','m','y']", "example": "m" }, { "name": "AutoRenewFlag", "type": "integer", "required": false, "description": "包年包月购买是否自动续费，默认为0。 0标识默认续费方式，1表示自动续费，2表示不自动续费。", "example": "0" }, { "name": "AutoVoucher", "type": "integer", "required": false, "description": "是否自动选择代金券 1是 0否 默认为0", "example": "0" }, { "name": "HaCount", "type": "integer", "required": false, "description": "实例数量（该参数已不再使用，只做存量兼容处理）", "example": "1" }, { "name": "OrderSource", "type": "string", "required": false, "description": "订单来源", "example": "MyOrderSource" }, { "name": "ResourceTags", "type": "array", "required": false, "description": "集群创建需要绑定的tag数组信息", "example": "无", "item_type": "object", "children": [ { "name": "TagKey", "type": "string", "required": true, "description": "标签键", "example": "name" }, { "name": "TagValue", "type": "string", "required": true, "description": "标签值", "example": "zhang" } ] }, { "name": "DbMode", "type": "string", "required": false, "description": "Db类型 当DbType为MYSQL时可选(默认NORMAL)： NORMAL SERVERLESS", "example": "NORMAL" }, { "name": "MinCpu", "type": "float", "required": false, "description": "当DbMode为SERVERLESS时必填 cpu最小值，可选范围参考DescribeServerlessInstanceSpecs接口返回", "example": "1.0" }, { "name": "MaxCpu", "type": "float", "required": false, "description": "当DbMode为SERVERLESS时必填： cpu最大值，可选范围参考DescribeServerlessInstanceSpecs接口返回", "example": "2.0" }, { "name": "AutoPause", "type": "string", "required": false, "description": "当DbMode为SERVERLESS时，指定集群是否自动暂停，可选范围 yes no 默认值:yes", "example": "yes" }, { "name": "AutoPauseDelay", "type": "integer", "required": false, "description": "当DbMode为SERVERLESS时，指定集群自动暂停的延迟，单位秒，可选范围[600,691200] 默认值:600", "example": "600" }, { "name": "StoragePayMode", "type": "integer", "required": false, "description": "集群存储计费模式，按量计费：0，包年包月：1。默认按量计费 当DbType为MYSQL时，在集群计算计费模式为后付费（包括DbMode为SERVERLESS）时，存储计费模式仅可为按量计费 回档与克隆均不支持包年包月存储", "example": "0" }, { "name": "SecurityGroupIds", "type": "array", "required": false, "description": "安全组id数组", "example": "[\"sg-ajr1jzgj\"]", "item_type": "string" }, { "name": "AlarmPolicyIds", "type": "array", "required": false, "description": "告警策略Id数组", "example": "[\"policy-jylgsf32\"]", "item_type": "string" }, { "name": "ClusterParams", "type": "array", "required": false, "description": "参数数组，暂时支持character_set_server （utf8｜latin1｜gbk｜utf8mb4） ，lower_case_table_names，1-大小写不敏感，0-大小写敏感", "example": "无", "item_type": "object", "children": [ { "name": "ParamName", "type": "string", "required": true, "description": "参数名称", "example": "innodb_txsql_log_store_size" }, { "name": "CurrentValue", "type": "string", "required": true, "description": "当前值", "example": "2048" }, { "name": "OldValue", "type": "string", "required": true, "description": "原有值", "example": "65536" } ] }, { "name": "DealMode", "type": "integer", "required": false, "description": "交易模式，0-下单且支付，1-下单", "example": "0" }, { "name": "ParamTemplateId", "type": "integer", "required": false, "description": "参数模板ID，可以通过查询参数模板信息DescribeParamTemplates获得参数模板ID", "example": "0" }, { "name": "SlaveZone", "type": "string", "required": false, "description": "多可用区地址", "example": "ap-guangzhou-2" }, { "name": "InstanceInitInfos", "type": "array", "required": false, "description": "实例初始化配置信息，主要用于购买集群时选不同规格实例", "example": "无", "item_type": "object", "children": [ { "name": "Cpu", "type": "integer", "required": true, "description": "实例cpu", "example": "1" }, { "name": "Memory", "type": "integer", "required": true, "description": "实例内存", "example": "2" }, { "name": "InstanceType", "type": "string", "required": true, "description": "实例类型 rw/ro", "example": "rw" }, { "name": "InstanceCount", "type": "integer", "required": true, "description": "实例个数,范围[1,15]", "example": "1" }, { "name": "MinRoCount", "type": "integer", "required": false, "description": "Serverless实例个数最小值，范围[1,15]", "example": "1" }, { "name": "MaxRoCount", "type": "integer", "required": false, "description": "Serverless实例个数最大值，范围[1,15]", "example": "1" }, { "name": "MinRoCpu", "type": "float", "required": false, "description": "Serverless实例最小规格", "example": "0.5" }, { "name": "MaxRoCpu", "type": "float", "required": false, "description": "Serverless实例最大规格", "example": "1.0" }, { "name": "DeviceType", "type": "string", "required": false, "description": "实例机器类型 1. common，通用型。 2. exclusive，独享型。", "example": "exclusive" } ] }, { "name": "GdnId", "type": "string", "required": false, "description": "全球数据库唯一标识", "example": "cynosmysql-gdn-dbsgxagb" }, { "name": "ProxyConfig", "type": "object", "required": false, "description": "数据库代理配置", "example": "无", "children": [ { "name": "ProxyCount", "type": "integer", "required": false, "description": "数据库代理组节点个数。该参数不再建议使用,建议使用ProxyZones", "example": "cynosdbmysql-xxxxxxx" }, { "name": "Cpu", "type": "integer", "required": false, "description": "cpu核数", "example": "2" }, { "name": "Mem", "type": "integer", "required": false, "description": "内存", "example": "4000" }, { "name": "ConnectionPoolType", "type": "string", "required": false, "description": "连接池类型:SessionConnectionPool(会话级别连接池 )", "example": "SessionConnectionPool" }, { "name": "OpenConnectionPool", "type": "string", "required": false, "description": "是否开启连接池,yes-开启，no-不开启", "example": "yes" }, { "name": "ConnectionPoolTimeOut", "type": "integer", "required": false, "description": "连接池阈值:单位（秒）", "example": "0" }, { "name": "Description", "type": "string", "required": false, "description": "描述说明", "example": "只读代理" }, { "name": "ProxyZones", "type": "array", "required": false, "description": "数据库节点信息（该参数与ProxyCount需要任选一个输入）", "example": "无", "item_type": "object", "children": [ { "name": "ProxyNodeZone", "type": "string", "required": false, "description": "proxy节点可用区", "example": "ap-guangzhou-3" }, { "name": "ProxyNodeCount", "type": "integer", "required": false, "description": "proxy节点数量", "example": "2" } ] } ] }, { "name": "AutoArchive", "type": "string", "required": false, "description": "是否自动归档", "example": "yes" }, { "name": "AutoArchiveDelayHours", "type": "integer", "required": false, "description": "暂停后的归档处理时间", "example": "12" }, { "name": "CynosVersion", "type": "string", "required": false, "description": "内核小版本号", "example": "3.1.16.002" } ], "required": [ "Zone", "VpcId", "SubnetId", "DbType", "DbVersion" ] }, { "name": "CreateIntegrateCluster", "description": "本接口（CreateClusters）用于新购集群。", "status": "online", "parameters": [ { "name": "Zone", "type": "string", "required": true, "description": "可用区", "example": "ap-guangzhou-2" }, { "name": "VpcId", "type": "string", "required": true, "description": "所属VPC网络ID", "example": "vpc-ba48u0jt" }, { "name": "SubnetId", "type": "string", "required": true, "description": "所属子网ID", "example": "subnet-nw2hec3g" }, { "name": "DbVersion", "type": "string", "required": true, "description": "数据库版本，取值范围: MYSQL可选值：5.7，8.0", "example": "5.7" }, { "name": "ProjectId", "type": "integer", "required": false, "description": "所属项目ID", "example": "0" }, { "name": "ClusterName", "type": "string", "required": false, "description": "集群名称，长度小于64个字符，每个字符取值范围：大/小写字母，数字，特殊符号（'-','_','.'）", "example": "集群-demo" }, { "name": "AdminPassword", "type": "string", "required": false, "description": "账号密码(8-64个字符，包含大小写英文字母、数字和符号~!@#$%^\u0026*_-+=`|\\(){}[]:;',.?/中的任意三种)", "example": "test@km1" }, { "name": "Port", "type": "integer", "required": false, "description": "端口，默认3306，取值范围[0, 65535)", "example": "3306" }, { "name": "PayMode", "type": "integer", "required": false, "description": "计费模式，按量计费：0，包年包月：1。默认按量计费。", "example": "0" }, { "name": "Count", "type": "integer", "required": false, "description": "购买集群数，可选值范围[1,3]，默认为1", "example": "1" }, { "name": "StorageLimit", "type": "integer", "required": false, "description": "普通实例存储上限，单位GB 当DbType为MYSQL，且存储计费模式为预付费时，该参数需不大于cpu与memory对应存储规格上限", "example": "10" }, { "name": "TimeSpan", "type": "integer", "required": false, "description": "包年包月购买时长", "example": "1" }, { "name": "TimeUnit", "type": "string", "required": false, "description": "包年包月购买时长单位，['s','d','m','y']", "example": "m" }, { "name": "AutoRenewFlag", "type": "integer", "required": false, "description": "包年包月购买是否自动续费，默认为0。 0标识默认续费方式，1表示自动续费，2表示不自动续费。", "example": "0" }, { "name": "AutoVoucher", "type": "integer", "required": false, "description": "是否自动选择代金券 1是 0否 默认为0", "example": "0" }, { "name": "ResourceTags", "type": "array", "required": false, "description": "集群创建需要绑定的tag数组信息", "example": "无", "item_type": "object", "children": [ { "name": "TagKey", "type": "string", "required": true, "description": "标签键", "example": "name" }, { "name": "TagValue", "type": "string", "required": true, "description": "标签值", "example": "zhang" } ] }, { "name": "StoragePayMode", "type": "integer", "required": false, "description": "集群存储计费模式，按量计费：0，包年包月：1。默认按量计费 当DbType为MYSQL时，在集群计算计费模式为后付费（包括DbMode为SERVERLESS）时，存储计费模式仅可为按量计费 回档与克隆均不支持包年包月存储", "example": "0" }, { "name": "SecurityGroupIds", "type": "array", "required": false, "description": "安全组id数组", "example": "[\"sg-1kdfm1\"]", "item_type": "string" }, { "name": "AlarmPolicyIds", "type": "array", "required": false, "description": "告警策略Id数组", "example": "[\"p-1kdfm1\"]", "item_type": "string" }, { "name": "ClusterParams", "type": "array", "required": false, "description": "参数数组，暂时支持character_set_server （utf8｜latin1｜gbk｜utf8mb4） ，lower_case_table_names，1-大小写不敏感，0-大小写敏感", "example": "无", "item_type": "object", "children": [ { "name": "ParamName", "type": "string", "required": true, "description": "参数名称", "example": "innodb_txsql_log_store_size" }, { "name": "CurrentValue", "type": "string", "required": true, "description": "当前值", "example": "2048" }, { "name": "OldValue", "type": "string", "required": true, "description": "原有值", "example": "65536" } ] }, { "name": "DealMode", "type": "integer", "required": false, "description": "交易模式，0-下单且支付，1-下单", "example": "0" }, { "name": "ParamTemplateId", "type": "integer", "required": false, "description": "参数模板ID，可以通过查询参数模板信息DescribeParamTemplates获得参数模板ID", "example": "1" }, { "name": "SlaveZone", "type": "string", "required": false, "description": "多可用区地址", "example": "ap-guangzhou-4" }, { "name": "InstanceInitInfos", "type": "array", "required": false, "description": "实例初始化配置信息，主要用于购买集群时选不同规格实例", "example": "无", "item_type": "object", "children": [ { "name": "Cpu", "type": "integer", "required": true, "description": "实例cpu", "example": "1" }, { "name": "Memory", "type": "integer", "required": true, "description": "实例内存", "example": "1" }, { "name": "InstanceType", "type": "string", "required": true, "description": "实例类型 rw/ro", "example": "rw" }, { "name": "InstanceCount", "type": "integer", "required": true, "description": "实例个数,范围[1,15]", "example": "1" }, { "name": "DeviceType", "type": "string", "required": false, "description": "实例机器类型 common-公通用型,exclusive-独享型", "example": "common" } ] }, { "name": "GdnId", "type": "string", "required": false, "description": "全球数据库唯一标识", "example": "cynosmysql-gdn-dbsgxagb" }, { "name": "ProxyConfig", "type": "object", "required": false, "description": "数据库代理配置", "example": "无", "children": [ { "name": "ProxyCount", "type": "integer", "required": false, "description": "数据库代理组节点个数。该参数不再建议使用,建议使用ProxyZones", "example": "1" }, { "name": "Cpu", "type": "integer", "required": false, "description": "cpu核数", "example": "2" }, { "name": "Mem", "type": "integer", "required": false, "description": "内存", "example": "4000" }, { "name": "Description", "type": "string", "required": false, "description": "描述说明", "example": "只读代理" }, { "name": "ProxyZones", "type": "array", "required": false, "description": "数据库节点信息（该参数与ProxyCount需要任选一个输入）", "example": "无", "item_type": "object", "children": [ { "name": "ProxyNodeZone", "type": "string", "required": false, "description": "proxy节点可用区", "example": "ap-guangzhou-3" }, { "name": "ProxyNodeCount", "type": "integer", "required": false, "description": "proxy节点数量", "example": "2" } ] } ] }, { "name": "AutoArchive", "type": "string", "required": false, "description": "是否自动归档", "example": "yes" }, { "name": "AutoArchiveDelayHours", "type": "integer", "required": false, "description": "暂停后的归档处理时间", "example": "12" }, { "name": "EncryptMethod", "type": "string", "required": false, "description": "加密方法（由加密算法和密钥对版本组成）", "example": "RSA-2048-v1" }, { "name": "IntegrateCreateClusterConfig", "type": "object", "required": false, "description": "集成集群配置信息", "example": "无", "children": [ { "name": "BinlogSaveDays", "type": "integer", "required": false, "description": "binlog保留天数[7,1830]", "example": "8" }, { "name": "BackupSaveDays", "type": "integer", "required": false, "description": "备份保留天数[7,1830]", "example": "7" }, { "name": "SemiSyncTimeout", "type": "integer", "required": false, "description": "半同步超时时间[1000,4294967295]", "example": "1002" }, { "name": "ProxyEndPointConfigs", "type": "array", "required": false, "description": "proxy连接地址配置信息", "example": "无", "item_type": "object", "children": [ { "name": "UniqueVpcId", "type": "string", "required": false, "description": "所属VPC网络ID", "example": "vpc-1ptuei0b" }, { "name": "UniqueSubnetId", "type": "string", "required": false, "description": "所属子网ID", "example": "subnet-1tmw9t4o" }, { "name": "SecurityGroupIds", "type": "array", "required": false, "description": "安全组id数组", "example": "[\"sg-ajr1jzgj\"]", "item_type": "string" }, { "name": "WeightMode", "type": "string", "required": false, "description": "权重模式： system-系统分配，custom-自定义", "example": "system" }, { "name": "AutoAddRo", "type": "string", "required": false, "description": "是否自动添加只读实例，yes-是，no-不自动添加", "example": "no" }, { "name": "RwType", "type": "string", "required": false, "description": "读写属性： READWRITE,READONLY", "example": "READONLY" }, { "name": "InstanceNameWeights", "type": "array", "required": false, "description": "权重信息", "example": "无", "item_type": "object", "children": [ { "name": "InstanceName", "type": "string", "required": false, "description": "实例名称，创建集群中InstanceInitInfo.InstanceName所指定名称", "example": "ro-1" }, { "name": "Weight", "type": "integer", "required": false, "description": "权重", "example": "1" } ] } ] } ] }, { "name": "StorageVersion", "type": "string", "required": false, "description": "存储架构类型。 枚举值：1.0/2.0 默认值：1.0", "example": "1.0" } ], "required": [ "Zone", "VpcId", "SubnetId", "DbVersion" ] }, { "name": "CreateLibraDBClusterAccounts", "description": "本接口（CreateLibraDBClusterAccounts）用于创建分析集群账号", "status": "online", "parameters": [ { "name": "ClusterId", "type": "string", "required": true, "description": "分析集群id", "example": "libradb-i794jfvg" }, { "name": "Accounts", "type": "array", "required": true, "description": "账户信息", "example": "无", "item_type": "object", "children": [ { "name": "AccountName", "type": "string", "required": true, "description": "账户名，包含字母数字_,以字母开头，字母或数字结尾，长度1-30", "example": "0" }, { "name": "AccountPassword", "type": "string", "required": true, "description": "密码，密码长度范围为8到64个字符", "example": "0" }, { "name": "Host", "type": "string", "required": true, "description": "主机(%或ipv4地址)", "example": "0" }, { "name": "Description", "type": "string", "required": false, "description": "描述", "example": "0" }, { "name": "MaxUserConnections", "type": "integer", "required": false, "description": "用户最大连接数，不能大于10240", "example": "0" } ] }, { "name": "EncryptMethod", "type": "string", "required": false, "description": "加密方式", "example": "hash" } ], "required": [ "ClusterId", "Accounts" ] }, { "name": "CreateLibraDBClusters", "description": "创建 TDSQL-C 分析集群", "status": "online", "parameters": [ { "name": "Count", "type": "integer", "required": true, "description": "数量", "example": "1" }, { "name": "Zone", "type": "string", "required": true, "description": "可用区", "example": "ap-guangzhou-6\"" }, { "name": "InstanceInitInfos", "type": "array", "required": true, "description": "实例初始化信息", "example": "无", "item_type": "object", "children": [ { "name": "Cpu", "type": "integer", "required": false, "description": "cpu", "example": "4" }, { "name": "Memory", "type": "integer", "required": false, "description": "内存", "example": "16" }, { "name": "StorageSize", "type": "integer", "required": false, "description": "硬盘", "example": "100" }, { "name": "StorageType", "type": "string", "required": false, "description": "存储类型", "example": "CLOUD_TCS" }, { "name": "InstanceType", "type": "string", "required": false, "description": "实例类型", "example": "common" }, { "name": "LibraDBVersion", "type": "string", "required": false, "description": "实例版本", "example": "2410" }, { "name": "InstanceCount", "type": "integer", "required": false, "description": "实例数量", "example": "2" }, { "name": "VpcId", "type": "string", "required": false, "description": "vpc id", "example": "vpc-xxx" }, { "name": "SubnetId", "type": "string", "required": false, "description": "subnet id", "example": "subnet-xxx" }, { "name": "Port", "type": "integer", "required": false, "description": "端口", "example": "4000" }, { "name": "ReplicasNum", "type": "integer", "required": false, "description": "购买实例副本数", "example": "1" } ] }, { "name": "AdminPassword", "type": "string", "required": false, "description": "用户密码", "example": "\"autotest1\"" }, { "name": "AutoRenewFlag", "type": "integer", "required": false, "description": "是否自动续费", "example": "0" }, { "name": "AutoVoucher", "type": "integer", "required": false, "description": "是否自动选择代金券", "example": "0" }, { "name": "ClusterName", "type": "string", "required": false, "description": "集群名称", "example": "libradb-xxx" }, { "name": "DealMode", "type": "string", "required": false, "description": "下单模式", "example": "0" }, { "name": "EncryptMethod", "type": "string", "required": false, "description": "加密方法", "example": "hash" }, { "name": "LibraDBVersion", "type": "string", "required": false, "description": "LibraDBVersion 版本，缺省为最新版本", "example": "2410" }, { "name": "OrderSource", "type": "string", "required": false, "description": "订单来源", "example": "\"autotest\"" }, { "name": "PayMode", "type": "integer", "required": false, "description": "付费模式", "example": "0" }, { "name": "ProjectId", "type": "string", "required": false, "description": "项目id", "example": "0" }, { "name": "SecurityGroupIds", "type": "array", "required": false, "description": "安全组", "example": "[\"secrtury-a3df313\"]", "item_type": "string" }, { "name": "TimeSpan", "type": "integer", "required": false, "description": "时长", "example": "60" }, { "name": "TimeUnit", "type": "string", "required": false, "description": "时间单位", "example": "s" }, { "name": "ResourceTags", "type": "array", "required": false, "description": "实例创建绑定Tag数组信息", "example": "无", "item_type": "object", "children": [ { "name": "TagKey", "type": "string", "required": true, "description": "标签键", "example": "name" }, { "name": "TagValue", "type": "string", "required": true, "description": "标签值", "example": "zhang" } ] }, { "name": "VpcId", "type": "string", "required": false, "description": "集群所在vpcId", "example": "vpc-nnakli31" }, { "name": "SubnetId", "type": "string", "required": false, "description": "集群所在SubnetId", "example": "subnet-558rhwt2" }, { "name": "Port", "type": "string", "required": false, "description": "端口", "example": "3306" } ], "required": [ "Count", "Zone", "InstanceInitInfos" ] }, { "name": "CreateParamTemplate", "description": "本接口（CreateParamTemplate）用于创建参数模板。", "status": "online", "parameters": [ { "name": "TemplateName", "type": "string", "required": true, "description": "模板名称", "example": "参数模板5.7" }, { "name": "EngineVersion", "type": "string", "required": true, "description": "mysql版本号", "example": "5.7" }, { "name": "TemplateDescription", "type": "string", "required": false, "description": "模板描述", "example": "常用模板" }, { "name": "TemplateId", "type": "integer", "required": false, "description": "可选参数，需要复制的模板ID", "example": "93" }, { "name": "DbMode", "type": "string", "required": false, "description": "数据库类型，可选值：NORMAL（默认值），SERVERLESS", "example": "NORMAL" }, { "name": "ParamList", "type": "array", "required": false, "description": "参数列表", "example": "无", "item_type": "object", "children": [ { "name": "ParamName", "type": "string", "required": true, "description": "参数名称", "example": "innodb_txsql_log_store_size" }, { "name": "CurrentValue", "type": "string", "required": true, "description": "当前值", "example": "2048" }, { "name": "OldValue", "type": "string", "required": true, "description": "原有值", "example": "65536" } ] } ], "required": [ "TemplateName", "EngineVersion" ] }, { "name": "CreateProxy", "description": "本接口（CreateProxy）用于开启集群的数据库代理。", "status": "online", "parameters": [ { "name": "ClusterId", "type": "string", "required": true, "description": "集群ID", "example": "cynosdbmysql-mwg7212w" }, { "name": "Cpu", "type": "integer", "required": true, "description": "cpu核数", "example": "2" }, { "name": "Mem", "type": "integer", "required": true, "description": "内存", "example": "4000" }, { "name": "UniqueVpcId", "type": "string", "required": false, "description": "私有网络ID，默认与集群私有网络ID保持一致", "example": "vpc-5l7l5q11" }, { "name": "UniqueSubnetId", "type": "string", "required": false, "description": "私有网络子网ID，默认与集群子网ID保持一致", "example": "subnet-b5v6id11" }, { "name": "ProxyCount", "type": "integer", "required": false, "description": "数据库代理组节点个数（该参数不再建议使用，建议使用ProxyZones)", "example": "2" }, { "name": "ConnectionPoolType", "type": "string", "required": false, "description": "连接池类型：SessionConnectionPool(会话级别连接池 )", "example": "SessionConnectionPool" }, { "name": "OpenConnectionPool", "type": "string", "required": false, "description": "是否开启连接池,yes-开启，no-不开启", "example": "yes" }, { "name": "ConnectionPoolTimeOut", "type": "integer", "required": false, "description": "连接池阈值：单位（秒）", "example": "0" }, { "name": "SecurityGroupIds", "type": "array", "required": false, "description": "安全组ID数组", "example": "sg-qwaszx", "item_type": "string" }, { "name": "Description", "type": "string", "required": false, "description": "描述说明", "example": "一区代理" }, { "name": "ProxyZones", "type": "array", "required": false, "description": "数据库节点信息（该参数与ProxyCount需要任选一个输入）", "example": "[{\"ProxyNodeZone\": \"ap-guangzhou-3\",\"ProxyNodeCount\": \"2\"}]", "item_type": "object", "children": [ { "name": "ProxyNodeZone", "type": "string", "required": false, "description": "proxy节点可用区", "example": "ap-guangzhou-3" }, { "name": "ProxyNodeCount", "type": "integer", "required": false, "description": "proxy节点数量", "example": "2" } ] } ], "required": [ "ClusterId", "Cpu", "Mem" ] }, { "name": "CreateProxyEndPoint", "description": "本接口（CreateProxyEndPoint）用于创建数据库代理连接点。", "status": "online", "parameters": [ { "name": "ClusterId", "type": "string", "required": true, "description": "集群 ID。", "example": "cynosdbmysql-xxxxxxx" }, { "name": "UniqueVpcId", "type": "string", "required": true, "description": "私有网络 ID，默认与集群私有网络 ID 保持一致。", "example": "vpc-5l7l5q11" }, { "name": "UniqueSubnetId", "type": "string", "required": true, "description": "私有网络子网 ID，默认与集群子网 ID 保持一致。", "example": "subnet-b5v6id11" }, { "name": "ConnectionPoolType", "type": "string", "required": false, "description": "连接池类型：SessionConnectionPool（会话级别连接池）。", "example": "SessionConnectionPool" }, { "name": "OpenConnectionPool", "type": "string", "required": false, "description": "是否开启连接池。 yes：表示开启。 no：表示不开启。", "example": "yes" }, { "name": "ConnectionPoolTimeOut", "type": "integer", "required": false, "description": "连接池阈值：单位（秒），可选范围：0 - 300秒。", "example": "0" }, { "name": "SecurityGroupIds", "type": "array", "required": false, "description": "绑定的安全组 ID 数组。", "example": "[\"sg-asdqwe\"]", "item_type": "string" }, { "name": "Description", "type": "string", "required": false, "description": "描述说明。", "example": "代理1" }, { "name": "Vip", "type": "string", "required": false, "description": "想要绑定的 vip 信息，需与 UniqueVpcId 对应。", "example": "192.168.0.0" }, { "name": "WeightMode", "type": "string", "required": false, "description": "权重模式： system：系统分配。 custom：自定义。", "example": "system" }, { "name": "AutoAddRo", "type": "string", "required": false, "description": "是否自动添加只读实例。 yes：表示自动添加只读实例。 no：表示不自动添加只读实例。", "example": "yes" }, { "name": "FailOver", "type": "string", "required": false, "description": "是否开启故障转移。 yes：表示开启，开启后，当数据库代理出现故障时，连接地址将会路由到主实例。 no：表示不开启。 说明： 仅当 RwType 参数值为 READWRITE 时，才支持设置此项。", "example": "yes" }, { "name": "ConsistencyType", "type": "string", "required": false, "description": "一致性类型： eventual：最终一致性。 global：全局一致性。 session：会话一致性。 说明： 仅当 RwType 参数值为 READWRITE 时，才支持设置此项。", "example": "session" }, { "name": "RwType", "type": "string", "required": false, "description": "读写属性： READWRITE：表示读写分离。当此参数值为 READWRITE 时，才支持设置 FailOver、ConsistencyType 参数。 READONLY：表示只读。", "example": "READONLY" }, { "name": "ConsistencyTimeOut", "type": "integer", "required": false, "description": "一致性超时时间。取值范围：0 ~ 1000000（微秒）。设置为0时，表示若只读实例出现延迟导致一致性策略不满足时，请求将一直等待。", "example": "1000" }, { "name": "TransSplit", "type": "boolean", "required": false, "description": "是否开启事务拆分。开启后，在一个事务中拆分读和写到不同的实例上去执行。", "example": "true" }, { "name": "AccessMode", "type": "string", "required": false, "description": "接入模式： nearby：就近访问。 balance：均衡分配。", "example": "balance" }, { "name": "InstanceWeights", "type": "array", "required": false, "description": "实例权重。", "example": "无", "item_type": "object", "children": [ { "name": "InstanceId", "type": "string", "required": true, "description": "实例Id", "example": "cynosdbmysql-ins-hs6bgfi7" }, { "name": "Weight", "type": "integer", "required": true, "description": "实例权重", "example": "10" } ] } ], "required": [ "ClusterId", "UniqueVpcId", "UniqueSubnetId" ] }, { "name": "CreateResourcePackage", "description": "本接口（CreateResourcePackage）用于新购资源包。", "status": "online", "parameters": [ { "name": "InstanceType", "type": "string", "required": true, "description": "实例类型，目前固定传cynosdb-serverless", "example": "cynosdb-serverless" }, { "name": "PackageRegion", "type": "string", "required": true, "description": "资源包使用地域chineseMainland-中国内地通用，overseas-港澳台及海外通用", "example": "chineseMainland" }, { "name": "PackageType", "type": "string", "required": true, "description": "资源包类型：CCU-计算资源包，DISK-存储资源包", "example": "CCU" }, { "name": "PackageVersion", "type": "string", "required": true, "description": "资源包版本 base-基础版本，common-通用版本，enterprise-企业版本", "example": "base" }, { "name": "PackageSpec", "type": "float", "required": true, "description": "资源包大小，计算资源单位：个；存储资源：GB", "example": "2000.00" }, { "name": "ExpireDay", "type": "integer", "required": true, "description": "资源包有效期，单位:天", "example": "180" }, { "name": "PackageCount", "type": "integer", "required": true, "description": "购买资源包个数", "example": "1" }, { "name": "PackageName", "type": "string", "required": false, "description": "资源包名称", "example": "资源包_1" } ], "required": [ "InstanceType", "PackageRegion", "PackageType", "PackageVersion", "PackageSpec", "ExpireDay", "PackageCount" ] }, { "name": "DeleteAccounts", "description": "本接口（DeleteAccounts）用于删除用户账号。", "status": "online", "parameters": [ { "name": "ClusterId", "type": "string", "required": true, "description": "集群ID", "example": "cynosdbmysql-ixgbd0di" }, { "name": "Accounts", "type": "array", "required": false, "description": "账号数组，包含account和host", "example": "无", "item_type": "object", "children": [ { "name": "AccountName", "type": "string", "required": true, "description": "账号", "example": "andy" }, { "name": "Host", "type": "string", "required": false, "description": "主机，默认‘%’", "example": "%" } ] } ], "required": [ "ClusterId" ] }, { "name": "DeleteAuditLogFile", "description": "本接口（DeleteAuditLogFile）用于删除云数据库实例的审计日志文件。", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "实例ID", "example": "cynosdbmysql-ins-4vdteidd" }, { "name": "FileName", "type": "string", "required": true, "description": "审计日志文件名称。", "example": "\"andy.csv\"" } ], "required": [ "InstanceId", "FileName" ] }, { "name": "DeleteAuditRuleTemplates", "description": "本接口（DeleteAuditRuleTemplates）用于删除审计规则模板。", "status": "online", "parameters": [ { "name": "RuleTemplateIds", "type": "array", "required": true, "description": "审计规则模板ID。", "example": "cynosdb-art-l1mlbo59", "item_type": "string" } ], "required": [ "RuleTemplateIds" ] }, { "name": "DeleteBackup", "description": "本接口（DeleteBackup）用于为集群删除手动备份，无法删除自动备份。", "status": "online", "parameters": [ { "name": "ClusterId", "type": "string", "required": true, "description": "集群ID", "example": "cynosdbpg-45knmnra" }, { "name": "SnapshotIdList", "type": "array", "required": false, "description": "备份文件ID，旧版本使用的字段，不推荐使用", "example": "[\"4928\\r\\n\"]", "item_type": "integer" }, { "name": "BackupIds", "type": "array", "required": false, "description": "备份文件ID，推荐使用", "example": "[\"1000\\r\\n\"]", "item_type": "integer" } ], "required": [ "ClusterId" ] }, { "name": "DeleteCLSDelivery", "description": "本接口（DeleteCLSDelivery）用于删除日志投递。", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "实例id", "example": "cynosdbmysql-ins-nwc5ao8g" }, { "name": "CLSTopicIds", "type": "array", "required": true, "description": "日志主题id", "example": "[\"83dc6703-f43a-4b95-92ec-267bdf9e48c3\"]", "item_type": "string" }, { "name": "LogType", "type": "string", "required": false, "description": "日志类型", "example": "slow" }, { "name": "IsInMaintainPeriod", "type": "string", "required": false, "description": "是否维护时间运行", "example": "yes" } ], "required": [ "InstanceId", "CLSTopicIds" ] }, { "name": "DeleteClusterDatabase", "description": "本接口（DeleteClusterDatabase）用于删除数据库。", "status": "online", "parameters": [ { "name": "ClusterId", "type": "string", "required": true, "description": "集群ID", "example": "cynosdbmysql-j9i41hfv" }, { "name": "DbNames", "type": "array", "required": true, "description": "数据库名", "example": "[\"db1\"]", "item_type": "string" } ], "required": [ "ClusterId", "DbNames" ] }, { "name": "DeleteClusterSaveBackup", "description": "本接口（DeleteClusterSaveBackup）用于为集群删除遗留备份", "status": "online", "parameters": [ { "name": "ClusterId", "type": "string", "required": true, "description": "集群ID", "example": "cynosdbpg-45knmnra" }, { "name": "SaveBackupId", "type": "integer", "required": false, "description": "保留备份文件ID，推荐使用", "example": "18762" } ], "required": [ "ClusterId" ] }, { "name": "DeleteLibraDBCluster", "description": "删除 TDSQL-C 分析集群", "status": "online", "parameters": [ { "name": "ClusterId", "type": "string", "required": true, "description": "分析集群 ID", "example": "libradb-xxx" } ], "required": [ "ClusterId" ] }, { "name": "DeleteLibraDBClusterAccounts", "description": "本接口（DeleteLibraDBClusterAccounts）用于删除分析集群账号", "status": "online", "parameters": [ { "name": "ClusterId", "type": "string", "required": true, "description": "分析集群id", "example": "libradb-xxx" }, { "name": "Accounts", "type": "array", "required": true, "description": "账号", "example": "无", "item_type": "object", "children": [ { "name": "AccountName", "type": "string", "required": true, "description": "账号", "example": "andy" }, { "name": "Host", "type": "string", "required": false, "description": "主机，默认‘%’", "example": "%" } ] } ], "required": [ "ClusterId", "Accounts" ] }, { "name": "DeleteParamTemplate", "description": "本接口（DeleteParamTemplate）用于删除用户创建的参数模板。", "status": "online", "parameters": [ { "name": "TemplateId", "type": "integer", "required": true, "description": "参数模板ID", "example": "1000" } ], "required": [ "TemplateId" ] }, { "name": "DescribeAccountAllGrantPrivileges", "description": "本接口（DescribeAccountAllGrantPrivileges）用于查询账号所有可授予的权限。", "status": "online", "parameters": [ { "name": "ClusterId", "type": "string", "required": true, "description": "集群id", "example": "cynosdbmysql-asd45qwe" }, { "name": "Account", "type": "object", "required": true, "description": "账号信息", "example": "{\"AccountName\": \"andy\",\"Host\": \"%\"}", "children": [ { "name": "AccountName", "type": "string", "required": true, "description": "账号", "example": "andy" }, { "name": "Host", "type": "string", "required": false, "description": "主机，默认‘%’", "example": "%" } ] } ], "required": [ "ClusterId", "Account" ] }, { "name": "DescribeAccountPrivileges", "description": "本接口（DescribeAccountPrivileges）用于查询账号已有权限。", "status": "online", "parameters": [ { "name": "ClusterId", "type": "string", "required": true, "description": "集群id", "example": "cynosdbmysql-j9i41hfv" }, { "name": "AccountName", "type": "string", "required": true, "description": "账户名", "example": "account1" }, { "name": "Host", "type": "string", "required": true, "description": "主机", "example": "192.0.0.0" }, { "name": "Db", "type": "string", "required": true, "description": "数据库名，为*时，忽略Type/TableName, 表示修改用户全局权限；", "example": "Db1" }, { "name": "Type", "type": "string", "required": true, "description": "指定数据库下的对象类型，可选\"table\"，\"*\"", "example": "table" }, { "name": "TableName", "type": "string", "required": false, "description": "当Type=\"table\"时，用来指定表名", "example": "Table1" } ], "required": [ "ClusterId", "AccountName", "Host", "Db", "Type" ] }, { "name": "DescribeAccounts", "description": "本接口（DescribeAccounts）用于查询数据库账号列表。", "status": "online", "parameters": [ { "name": "ClusterId", "type": "string", "required": true, "description": "集群ID", "example": "cynosdbmysql-on5xw0ni" }, { "name": "AccountNames", "type": "array", "required": false, "description": "需要过滤的账户列表", "example": "[admin]", "item_type": "string" }, { "name": "DbType", "type": "string", "required": false, "description": "数据库类型，取值范围: MYSQL 该参数已废用", "example": "MYSQL" }, { "name": "Hosts", "type": "array", "required": false, "description": "需要过滤的账户列表", "example": "[0.0.0.0]", "item_type": "string" }, { "name": "Limit", "type": "integer", "required": false, "description": "限制量", "example": "10" }, { "name": "Offset", "type": "integer", "required": false, "description": "偏移量", "example": "0" }, { "name": "AccountRegular", "type": "string", "required": false, "description": "模糊匹配关键字(同时匹配AccountName和AccountHost，返回并集结果，支持正则)", "example": "“andy\"" } ], "required": [ "ClusterId" ] }, { "name": "DescribeAuditInstanceList", "description": "本接口（DescribeAuditInstanceList）用于获取数据库审计的实例列表。", "status": "online", "parameters": [ { "name": "AuditSwitch", "type": "integer", "required": false, "description": "实例审计开启的状态。1-已开启审计；0-未开启审计。", "example": "1" }, { "name": "Filters", "type": "array", "required": false, "description": "查询实例列表的过滤条件。", "example": "[{\"Name\": \"InstanceId\",\"ExactMatch\": true,\"Values\": [\"cynosdbmysql-ins-ifq10fec\"]}]", "item_type": "object", "children": [ { "name": "Name", "type": "string", "required": true, "description": "过滤条件值。支持InstanceId-实例ID，InstanceName-实例名称，ProjectId-项目ID，TagKey-标签键，Tag-标签（以竖线分割，例：Tagkey|Tagvalue）。", "example": "InstanceId" }, { "name": "ExactMatch", "type": "boolean", "required": true, "description": "true表示精确查找，false表示模糊匹配。", "example": "true" }, { "name": "Values", "type": "array", "required": true, "description": "筛选值", "example": "cynosdbmysql-ins-3nskq234", "item_type": "string" } ] }, { "name": "AuditMode", "type": "integer", "required": false, "description": "实例的审计规则模式。1-规则审计；0-全审计。", "example": "1" }, { "name": "Limit", "type": "integer", "required": false, "description": "单次请求返回的数量。默认值为30，最大值为 100。", "example": "10" }, { "name": "Offset", "type": "integer", "required": false, "description": "偏移量，默认值为 0。", "example": "1" } ], "required": [] }, { "name": "DescribeAuditLogFiles", "description": "本接口(DescribeAuditLogFiles)用于查询云数据库实例的审计日志文件。", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "实例ID", "example": "cynosdbmysql-ins-xx" }, { "name": "Limit", "type": "integer", "required": false, "description": "分页大小参数。默认值为 20，最小值为 1，最大值为 100。", "example": "100" }, { "name": "Offset", "type": "integer", "required": false, "description": "分页偏移量。", "example": "0" }, { "name": "FileName", "type": "string", "required": false, "description": "审计日志文件名。", "example": "FileName" } ], "required": [ "InstanceId" ] }, { "name": "DescribeAuditLogs", "description": "本接口（DescribeAuditLogs）用于查询数据库审计日志。", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "实例 ID。", "example": "cynosdbmysql-ins-xx" }, { "name": "StartTime", "type": "string", "required": true, "description": "开始时间，格式为：\"2017-07-12 10:29:20\"。", "example": "2017-07-12 10:29:20" }, { "name": "EndTime", "type": "string", "required": true, "description": "结束时间，格式为：\"2017-07-12 10:29:20\"。", "example": "2017-07-12 10:29:20" }, { "name": "Order", "type": "string", "required": false, "description": "排序方式。支持值包括：\"ASC\" - 升序，\"DESC\" - 降序。", "example": "ASC" }, { "name": "OrderBy", "type": "string", "required": false, "description": "排序字段。支持值包括： \"timestamp\" - 时间戳； \"affectRows\" - 影响行数； \"execTime\" - 执行时间。", "example": "timestap" }, { "name": "Limit", "type": "integer", "required": false, "description": "分页参数，单次返回的数据条数。默认值为100，最大值为100。", "example": "1" }, { "name": "Offset", "type": "integer", "required": false, "description": "分页偏移量。 说明：Limit 和 Offset 的取值之和需小于等于65536。", "example": "0" }, { "name": "LogFilter", "type": "array", "required": false, "description": "过滤条件。多个值之前是且的关系。", "example": "无", "item_type": "object", "children": [ { "name": "Type", "type": "string", "required": true, "description": "过滤项。目前支持以下搜索条件： 包含、不包含、包含（分词维度）、不包含（分词维度）: sql - SQL详情；alarmLevel - 告警等级；ruleTemplateId - 规则模板Id 等于、不等于、包含、不包含： host - 客户端地址； user - 用户名； dbName - 数据库名称； 等于、不等于： sqlType - SQL类型； errCode - 错误码； threadId - 线程ID； 范围搜索（时间类型统一为微秒）： execTime - 执行时间； lockWaitTime - ...", "example": "host" }, { "name": "Compare", "type": "string", "required": true, "description": "过滤条件。支持以下条件： WINC-包含（分词维度）， WEXC-不包含（分词维度）, INC - 包含, EXC - 不包含, EQS - 等于, NEQ - 不等于, RA - 范围。", "example": "INC" }, { "name": "Value", "type": "array", "required": true, "description": "过滤的值。反向查询时，多个值之前是且的关系，正向查询多个值是或的关系。", "example": "100.0.", "item_type": "string" } ] } ], "required": [ "InstanceId", "StartTime", "EndTime" ] }, { "name": "DescribeAuditRuleTemplates", "description": "本接口（DescribeAuditRuleTemplates）用于查询审计规则模板信息。", "status": "online", "parameters": [ { "name": "RuleTemplateIds", "type": "array", "required": false, "description": "规则模板ID。", "example": "cynosdb-art-nuzwpha1", "item_type": "string" }, { "name": "RuleTemplateNames", "type": "array", "required": false, "description": "规则模板名称", "example": "测试template", "item_type": "string" }, { "name": "Limit", "type": "integer", "required": false, "description": "单次请求返回的数量。默认值20。", "example": "10" }, { "name": "Offset", "type": "integer", "required": false, "description": "偏移量，默认值为 0。", "example": "0" }, { "name": "AlarmLevel", "type": "integer", "required": false, "description": "告警等级。1-低风险，2-中风险，3-高风险。", "example": "1" }, { "name": "AlarmPolicy", "type": "integer", "required": false, "description": "告警策略。0-不告警，1-告警。", "example": "0" } ], "required": [] }, { "name": "DescribeAuditRuleWithInstanceIds", "description": "本接口（DescribeAuditRuleWithInstanceIds）用于获取实例的审计规则。", "status": "online", "parameters": [ { "name": "InstanceIds", "type": "array", "required": true, "description": "实例ID。目前仅支持单个实例的查询。", "example": "[\"cynosdbmysql-ins-6990cckk\"]", "item_type": "string" } ], "required": [ "InstanceIds" ] }, { "name": "DescribeBackupConfig", "description": "本接口（DescribeBackupConfig）用于获取指定集群的备份配置信息，包括全量备份时间段、备份文件保留时间。", "status": "online", "parameters": [ { "name": "ClusterId", "type": "string", "required": true, "description": "集群ID", "example": "cynosdbmysql-45knmnra" } ], "required": [ "ClusterId" ] }, { "name": "DescribeBackupDownloadRestriction", "description": "该接口用户查询当前地域用户设置的默认备份下载来源限制", "status": "online", "parameters": [ { "name": "ClusterIds", "type": "array", "required": true, "description": "集群ID", "example": "['cynosdbmysql-abk12sf1']", "item_type": "string" } ], "required": [ "ClusterIds" ] }, { "name": "DescribeBackupDownloadUrl", "description": "本接口（DescribeBackupDownloadUrl）用于查询集群备份文件下载地址。", "status": "online", "parameters": [ { "name": "ClusterId", "type": "string", "required": true, "description": "集群ID", "example": "cynosdbmysql-mwg7121e" }, { "name": "BackupId", "type": "integer", "required": true, "description": "备份ID", "example": "1883726" }, { "name": "DownloadRestriction", "type": "object", "required": false, "description": "备份下载来源限制条件", "example": "无", "children": [ { "name": "LimitType", "type": "string", "required": false, "description": "限制类型", "example": "NoLimit" }, { "name": "VpcComparisonSymbol", "type": "string", "required": false, "description": "该参数仅支持 In， 表示 LimitVpc 指定的vpc可以下载。默认为In", "example": "In" }, { "name": "IpComparisonSymbol", "type": "string", "required": false, "description": "In: 指定的ip可以下载； NotIn: 指定的ip不可以下载", "example": "NotIn" }, { "name": "LimitVpcs", "type": "array", "required": false, "description": "限制下载的vpc设置 注意：此字段可能返回 null，表示取不到有效值。", "example": "[{\"Region\": \"ap-guangzhou\", \"VpcList\": [\"vpc-kas1\"] } ]", "item_type": "object", "children": [ { "name": "Region", "type": "string", "required": false, "description": "限制下载来源的地域。目前仅支持当前地域", "example": "ap-guangzhou" }, { "name": "VpcList", "type": "array", "required": false, "description": "限制下载的vpc列表", "example": "[\"vpc-a2wef\"]", "item_type": "string" } ] }, { "name": "LimitIps", "type": "array", "required": false, "description": "限制下载的ip设置 注意：此字段可能返回 null，表示取不到有效值。", "example": "[127.0.0.1,127.0.0.2]", "item_type": "string" } ] } ], "required": [ "ClusterId", "BackupId" ] }, { "name": "DescribeBackupDownloadUserRestriction", "description": "该接口用户查询当前地域用户级别设置的默认备份下载来源限制", "status": "online", "parameters": [ { "name": "Limit", "type": "integer", "required": false, "description": "分页大小", "example": "20" }, { "name": "Offset", "type": "integer", "required": false, "description": "偏移量", "example": "0" }, { "name": "OnlyUserRestriction", "type": "boolean", "required": false, "description": "是否只查询用户级别下载限制，true-是，false-否", "example": "false" } ], "required": [] }, { "name": "DescribeBackupList", "description": "本接口（DescribeBackupList）用于查询集群的备份文件列表。", "status": "online", "parameters": [ { "name": "ClusterId", "type": "string", "required": true, "description": "集群ID", "example": "cynosdbpg-ilgo90hu" }, { "name": "Limit", "type": "integer", "required": false, "description": "返回数量，取值范围(0,100]", "example": "10" }, { "name": "Offset", "type": "integer", "required": false, "description": "记录偏移量，取值范围[0,INF)", "example": "0" }, { "name": "DbType", "type": "string", "required": false, "description": "数据库类型，取值范围: MYSQL", "example": "MYSQL" }, { "name": "BackupIds", "type": "array", "required": false, "description": "备份ID", "example": "[172365]", "item_type": "integer" }, { "name": "BackupType", "type": "string", "required": false, "description": "备份类型，可选值：snapshot，快照备份； logic，逻辑备份", "example": "snapshot" }, { "name": "BackupMethod", "type": "string", "required": false, "description": "备份方式，可选值：auto，自动备份；manual，手动备份", "example": "auto" }, { "name": "SnapShotType", "type": "string", "required": false, "description": "快照类型，可选值：full，全量；increment，增量", "example": "full" }, { "name": "StartTime", "type": "string", "required": false, "description": "备份开始时间", "example": "2022-01-01 12:00:00" }, { "name": "EndTime", "type": "string", "required": false, "description": "备份结束时间", "example": "2022-01-01 14:00:00" }, { "name": "FileNames", "type": "array", "required": false, "description": "备份文件名，模糊查询", "example": "[\"sls_20241028221204\"]", "item_type": "string" }, { "name": "BackupNames", "type": "array", "required": false, "description": "备份备注名，模糊查询", "example": "[\"一区备份\"]", "item_type": "string" }, { "name": "SnapshotIdList", "type": "array", "required": false, "description": "快照备份Id列表", "example": "[1883726,1883728]", "item_type": "integer" }, { "name": "BackupRegion", "type": "string", "required": false, "description": "备份地域", "example": "ap-beijing" }, { "name": "IsCrossRegionsBackup", "type": "string", "required": false, "description": "是否跨地域备份", "example": "yes" } ], "required": [ "ClusterId" ] }, { "name": "DescribeBinlogConfig", "description": "该接口（DescribeBinlogConfig）用于查询binlog配置", "status": "online", "parameters": [ { "name": "ClusterId", "type": "string", "required": true, "description": "集群ID", "example": "cynosdbmysql-ck8fmk11" } ], "required": [ "ClusterId" ] }, { "name": "DescribeBinlogDownloadUrl", "description": "本接口（DescribeBinlogDownloadUrl）用于查询 Binlog 的下载地址。", "status": "online", "parameters": [ { "name": "ClusterId", "type": "string", "required": true, "description": "集群ID", "example": "cynosdbmysql-mwg7121e" }, { "name": "BinlogId", "type": "integer", "required": true, "description": "Binlog文件ID", "example": "100" }, { "name": "DownloadRestriction", "type": "object", "required": false, "description": "备份下载来源限制条件", "example": "无", "children": [ { "name": "LimitType", "type": "string", "required": false, "description": "限制类型", "example": "NoLimit" }, { "name": "VpcComparisonSymbol", "type": "string", "required": false, "description": "该参数仅支持 In， 表示 LimitVpc 指定的vpc可以下载。默认为In", "example": "In" }, { "name": "IpComparisonSymbol", "type": "string", "required": false, "description": "In: 指定的ip可以下载； NotIn: 指定的ip不可以下载", "example": "NotIn" }, { "name": "LimitVpcs", "type": "array", "required": false, "description": "限制下载的vpc设置 注意：此字段可能返回 null，表示取不到有效值。", "example": "[{\"Region\": \"ap-guangzhou\", \"VpcList\": [\"vpc-kas1\"] } ]", "item_type": "object", "children": [ { "name": "Region", "type": "string", "required": false, "description": "限制下载来源的地域。目前仅支持当前地域", "example": "ap-guangzhou" }, { "name": "VpcList", "type": "array", "required": false, "description": "限制下载的vpc列表", "example": "[\"vpc-a2wef\"]", "item_type": "string" } ] }, { "name": "LimitIps", "type": "array", "required": false, "description": "限制下载的ip设置 注意：此字段可能返回 null，表示取不到有效值。", "example": "[127.0.0.1,127.0.0.2]", "item_type": "string" } ] } ], "required": [ "ClusterId", "BinlogId" ] }, { "name": "DescribeBinlogSaveDays", "description": "此接口（DescribeBinlogSaveDays）用于查询集群的Binlog保留天数。", "status": "online", "parameters": [ { "name": "ClusterId", "type": "string", "required": true, "description": "集群ID", "example": "cynosdbmysql-123" } ], "required": [ "ClusterId" ] }, { "name": "DescribeBinlogs", "description": "本接口（DescribeBinlogs）用来查询集群 Binlog 日志列表。", "status": "online", "parameters": [ { "name": "ClusterId", "type": "string", "required": true, "description": "集群ID", "example": "cynosdbmysql-mwg7121e" }, { "name": "StartTime", "type": "string", "required": false, "description": "开始时间", "example": "2022-01-01 12:00:00" }, { "name": "EndTime", "type": "string", "required": false, "description": "结束时间", "example": "2022-01-01 14:00:00" }, { "name": "Offset", "type": "integer", "required": false, "description": "偏移量", "example": "100" }, { "name": "Limit", "type": "integer", "required": false, "description": "限制条数，默认值为20", "example": "100" } ], "required": [ "ClusterId" ] }, { "name": "DescribeChangedParamsAfterUpgrade", "description": "本接口（DescribeChangedParamsAfterUpgrade）用于查询升降配运行参数对比。", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "集群ID", "example": "cynosdbmysql-1xcycbu8" }, { "name": "DstCpu", "type": "integer", "required": true, "description": "变配后的CPU", "example": "1" }, { "name": "DstMem", "type": "integer", "required": true, "description": "变配后的MEM，单位G", "example": "1" } ], "required": [ "InstanceId", "DstCpu", "DstMem" ] }, { "name": "DescribeClusterDatabaseTables", "description": "获取table列表", "status": "online", "parameters": [ { "name": "ClusterId", "type": "string", "required": true, "description": "集群id", "example": "cynosdbmysql-ck8fmk11" }, { "name": "Db", "type": "string", "required": true, "description": "数据库名", "example": "db1" }, { "name": "Offset", "type": "integer", "required": false, "description": "偏移", "example": "0" }, { "name": "Limit", "type": "integer", "required": false, "description": "个数", "example": "10" }, { "name": "TableType", "type": "string", "required": false, "description": "数据表类型。 \"view\"表示只返回 view，\"base_table\" 表示只返回基本表，\"all\" 表示返回 view 和表。默认为 all。", "example": "view" } ], "required": [ "ClusterId", "Db" ] }, { "name": "DescribeClusterDatabases", "description": "本接口（DescribeClusterDatabases）用于获取集群数据库列表。", "status": "online", "parameters": [ { "name": "ClusterId", "type": "string", "required": true, "description": "集群id", "example": "cynosdbmysql-ck8fmk11" }, { "name": "Offset", "type": "integer", "required": false, "description": "分页偏移", "example": "0" }, { "name": "Limit", "type": "integer", "required": false, "description": "分页限制数量", "example": "10" } ], "required": [ "ClusterId" ] }, { "name": "DescribeClusterDetail", "description": "该接口（DescribeClusterDetail）用于显示集群详情。", "status": "online", "parameters": [ { "name": "ClusterId", "type": "string", "required": true, "description": "集群Id", "example": "cynosdbpg-5804k48e" } ], "required": [ "ClusterId" ] }, { "name": "DescribeClusterDetailDatabases", "description": "本接口（DescribeClusterDetailDatabases）用于查询数据库列表。", "status": "online", "parameters": [ { "name": "ClusterId", "type": "string", "required": true, "description": "集群ID", "example": "cynosdbmysql-xxxxxxx" }, { "name": "Offset", "type": "integer", "required": false, "description": "偏移量，默认0", "example": "0" }, { "name": "Limit", "type": "integer", "required": false, "description": "返回数量，默认20,最大100", "example": "20" }, { "name": "DbName", "type": "string", "required": false, "description": "数据库名称", "example": "db1" } ], "required": [ "ClusterId" ] }, { "name": "DescribeClusterInstanceGroups", "description": "本接口（DescribeClusterInstanceGrps）用于查询实例组信息。", "status": "online", "parameters": [ { "name": "ClusterId", "type": "string", "required": true, "description": "集群ID", "example": "cynosdbmysql-oib3wx0i" } ], "required": [ "ClusterId" ] }, { "name": "DescribeClusterInstanceGrps", "description": "本接口（DescribeClusterInstanceGrps）用于查询实例组信息。 该接口已废弃，推荐使用DescribeClusterInstanceGroups", "status": "online", "parameters": [ { "name": "ClusterId", "type": "string", "required": true, "description": "集群ID", "example": "cynosdbmysql-oib3wx0i" } ], "required": [ "ClusterId" ] }, { "name": "DescribeClusterParamLogs", "description": "本接口（DescribeClusterParamLogs）用于查询参数修改记录。", "status": "online", "parameters": [ { "name": "ClusterId", "type": "string", "required": true, "description": "集群ID", "example": "cynosdbmysql-mwg7121e" }, { "name": "InstanceIds", "type": "array", "required": false, "description": "实例ID列表，用来记录具体操作哪些实例", "example": "[\"cynosdbmysql-ins-d6f0hkkx\"]", "item_type": "string" }, { "name": "OrderBy", "type": "string", "required": false, "description": "排序字段，定义在回返结果的基于哪个字段进行排序", "example": "CreateTime" }, { "name": "OrderByType", "type": "string", "required": false, "description": "定义具体的排序规则，限定为desc,asc,DESC,ASC其中之一", "example": "DESC" }, { "name": "Limit", "type": "integer", "required": false, "description": "返回数量，默认为 20，取值范围为(0,100]", "example": "20" }, { "name": "Offset", "type": "integer", "required": false, "description": "记录偏移量，默认值为0，取值范围为[0,INF)", "example": "0" } ], "required": [ "ClusterId" ] }, { "name": "DescribeClusterParams", "description": "本接口（DescribeClusterParams）用于查询集群参数。", "status": "online", "parameters": [ { "name": "ClusterId", "type": "string", "required": true, "description": "集群ID", "example": "cynosdbmysql-1xcycbu8" }, { "name": "ParamName", "type": "string", "required": false, "description": "参数名字", "example": "binlog" }, { "name": "IsGlobal", "type": "string", "required": false, "description": "是否为全局参数", "example": "yes" } ], "required": [ "ClusterId" ] }, { "name": "DescribeClusterPasswordComplexity", "description": "本接口（DescribeClusterPasswordComplexity）用于查看集群密码复杂度详情。", "status": "online", "parameters": [ { "name": "ClusterId", "type": "string", "required": true, "description": "集群ID", "example": "cynosdbpg-bzxxrmtq" } ], "required": [ "ClusterId" ] }, { "name": "DescribeClusterReadOnly", "description": "本接口（DescribeClusterReadOnly）用于查询集群只读开关。", "status": "online", "parameters": [ { "name": "ClusterIds", "type": "array", "required": true, "description": "集群ID列表", "example": "[\"cynosdbmysql-jl17y89v\",\"cynosdbmysql-2d9pq38h\"]", "item_type": "string" } ], "required": [ "ClusterIds" ] }, { "name": "DescribeClusterTransparentEncryptInfo", "description": "查询集群透明加密信息", "status": "online", "parameters": [ { "name": "ClusterId", "type": "string", "required": true, "description": "集群id", "example": "cynosdbmysql-6oo0qjvo" } ], "required": [ "ClusterId" ] }, { "name": "DescribeClusters", "description": "本接口（DescribeClusters）用于查询集群列表。", "status": "online", "parameters": [ { "name": "DbType", "type": "string", "required": false, "description": "引擎类型：目前支持“MYSQL”， “POSTGRESQL”", "example": "MYSQL" }, { "name": "Limit", "type": "integer", "required": false, "description": "返回数量，默认为 20，最大值为 100", "example": "20" }, { "name": "Offset", "type": "integer", "required": false, "description": "记录偏移量，默认值为0", "example": "0" }, { "name": "OrderBy", "type": "string", "required": false, "description": "排序字段，取值范围： CREATETIME：创建时间 PERIODENDTIME：过期时间", "example": "\"CREATETIME\"" }, { "name": "OrderByType", "type": "string", "required": false, "description": "排序类型，取值范围： ASC：升序排序 DESC：降序排序", "example": "\"DESC\"" }, { "name": "Filters", "type": "array", "required": false, "description": "搜索条件，若存在多个Filter时，Filter间的关系为逻辑与（AND）关系。", "example": "无", "item_type": "object", "children": [ { "name": "Values", "type": "array", "required": true, "description": "搜索字符串", "example": "[\"1723\"]", "item_type": "string" }, { "name": "Names", "type": "array", "required": true, "description": "搜索字段，目前支持：\"InstanceId\", \"ProjectId\", \"InstanceName\", \"Vip\"", "example": "[\"projectId\"]", "item_type": "string" }, { "name": "ExactMatch", "type": "boolean", "required": false, "description": "是否精确匹配", "example": "false" }, { "name": "Name", "type": "string", "required": false, "description": "搜索字段", "example": "projectId" } ] } ], "required": [] }, { "name": "DescribeDBSecurityGroups", "description": "本接口（DescribeDBSecurityGroups）用于查询实例安全组信息。", "status": "online", "parameters": [ { "name": "InstanceGroupId", "type": "string", "required": false, "description": "实例组 ID，可通过 [DescribeClusterInstanceGroups](https://cloud.tencent.com/document/product/1003/103934) 接口查询。", "example": "cynosdbmysql-grp-as124sa5" } ], "required": [] }, { "name": "DescribeFlow", "description": "本接口（DescribeFlow）用于查询任务流信息。", "status": "online", "parameters": [ { "name": "FlowId", "type": "integer", "required": true, "description": "任务流ID", "example": "147186" } ], "required": [ "FlowId" ] }, { "name": "DescribeInstanceCLSLogDelivery", "description": "本接口（DescribeInstanceCLSLogDelivery）用于查询实例日志投递信息。", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "实例id", "example": "cynosdbmysql-ins-nwc5ao8g" }, { "name": "LogType", "type": "string", "required": false, "description": "日志类型", "example": "slow" } ], "required": [ "InstanceId" ] }, { "name": "DescribeInstanceDetail", "description": "本接口(DescribeInstanceDetail)用于查询实例详情。", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "实例ID", "example": "cynosdbmysql-ins-bzkxxrmt" } ], "required": [ "InstanceId" ] }, { "name": "DescribeInstanceErrorLogs", "description": "本接口（DescribeInstanceErrorLogs）用于查询实例错误日志列表。", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "实例Id", "example": "cynosdbmysql-ins-4senc2fm" }, { "name": "Limit", "type": "integer", "required": false, "description": "日志条数限制", "example": "20" }, { "name": "Offset", "type": "integer", "required": false, "description": "日志条数偏移量", "example": "0" }, { "name": "StartTime", "type": "string", "required": false, "description": "开始时间", "example": "2022-01-02 15:04:05" }, { "name": "EndTime", "type": "string", "required": false, "description": "结束时间", "example": "2022-02-02 15:04:05" }, { "name": "OrderBy", "type": "string", "required": false, "description": "排序字段，有Timestamp枚举值", "example": "Timestamp" }, { "name": "OrderByType", "type": "string", "required": false, "description": "排序类型，有ASC,DESC枚举值", "example": "ASC" }, { "name": "LogLevels", "type": "array", "required": false, "description": "日志等级，有error、warning、note三种，支持多个等级同时搜索", "example": "note", "item_type": "string" }, { "name": "KeyWords", "type": "array", "required": false, "description": "关键字，支持模糊搜索", "example": "unconnected", "item_type": "string" } ], "required": [ "InstanceId" ] }, { "name": "DescribeInstanceParams", "description": "本接口（DescribeInstanceParams）用于查询实例参数列表。", "status": "online", "parameters": [ { "name": "ClusterId", "type": "string", "required": true, "description": "集群ID", "example": "cynosdbmysql-mywcr111" }, { "name": "InstanceIds", "type": "array", "required": true, "description": "实例ID，支持批量查询", "example": "[\"cynosdbmysql-ins-kzavku11\"]", "item_type": "string" }, { "name": "ParamKeyword", "type": "string", "required": false, "description": "参数名搜索条件，支持模糊匹配", "example": "auto_increment" }, { "name": "IsGlobal", "type": "string", "required": false, "description": "是否为全局参数", "example": "no" } ], "required": [ "ClusterId", "InstanceIds" ] }, { "name": "DescribeInstanceSlowQueries", "description": "此接口（DescribeInstanceSlowQueries）用于查询实例慢日志详情。", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "实例ID", "example": "cynosdbmysql-ins-123" }, { "name": "StartTime", "type": "string", "required": false, "description": "事务开始最早时间", "example": "2022-01-01 12:00:00" }, { "name": "EndTime", "type": "string", "required": false, "description": "事务开始最晚时间", "example": "2022-01-01 14:00:00" }, { "name": "Limit", "type": "integer", "required": false, "description": "限制条数", "example": "20" }, { "name": "Offset", "type": "integer", "required": false, "description": "偏移量", "example": "0" }, { "name": "Username", "type": "string", "required": false, "description": "用户名", "example": "root" }, { "name": "Host", "type": "string", "required": false, "description": "客户端host", "example": "10.10.10.10" }, { "name": "Database", "type": "string", "required": false, "description": "数据库名", "example": "db1" }, { "name": "OrderBy", "type": "string", "required": false, "description": "排序字段，可选值：QueryTime,LockTime,RowsExamined,RowsSent", "example": "QueryTime" }, { "name": "OrderByType", "type": "string", "required": false, "description": "排序类型，可选值：asc,desc", "example": "desc" }, { "name": "SqlText", "type": "string", "required": false, "description": "sql语句", "example": "SELECT" } ], "required": [ "InstanceId" ] }, { "name": "DescribeInstanceSpecs", "description": "本接口（DescribeInstanceSpecs）用于查询购买页可购买的实例规格。", "status": "online", "parameters": [ { "name": "DbType", "type": "string", "required": true, "description": "数据库类型，取值范围: MYSQL", "example": "MYSQL" }, { "name": "IncludeZoneStocks", "type": "boolean", "required": false, "description": "是否需要返回可用区信息", "example": "false" }, { "name": "DeviceType", "type": "string", "required": false, "description": "实例机器类型", "example": "exclusive" } ], "required": [ "DbType" ] }, { "name": "DescribeInstances", "description": "本接口(DescribeInstances)用于查询实例列表。", "status": "online", "parameters": [ { "name": "Limit", "type": "integer", "required": false, "description": "返回数量，默认为 20，取值范围为(0,100]", "example": "10" }, { "name": "Offset", "type": "integer", "required": false, "description": "记录偏移量，默认值为0", "example": "0" }, { "name": "OrderBy", "type": "string", "required": false, "description": "排序字段，取值范围： CREATETIME：创建时间 PERIODENDTIME：过期时间", "example": "CREATETIME" }, { "name": "OrderByType", "type": "string", "required": false, "description": "排序类型，取值范围： ASC：升序排序 DESC：降序排序", "example": "ASC" }, { "name": "Filters", "type": "array", "required": false, "description": "搜索条件，若存在多个Filter时，Filter间的关系为逻辑与（AND）关系。", "example": "[{\"Names\": \"ProjectId\",\"Values\": \"andy\",\"ExactMatch\": \"1\",\"Name\": \"172\",\"Operator\": \"27627162\"}]", "item_type": "object", "children": [ { "name": "Values", "type": "array", "required": true, "description": "搜索字符串", "example": "[\"1723\"]", "item_type": "string" }, { "name": "Names", "type": "array", "required": true, "description": "搜索字段，目前支持：\"InstanceId\", \"ProjectId\", \"InstanceName\", \"Vip\"", "example": "[\"projectId\"]", "item_type": "string" }, { "name": "ExactMatch", "type": "boolean", "required": false, "description": "是否精确匹配", "example": "false" }, { "name": "Name", "type": "string", "required": false, "description": "搜索字段", "example": "projectId" } ] }, { "name": "DbType", "type": "string", "required": false, "description": "引擎类型：目前支持“MYSQL”", "example": "MYSQL" }, { "name": "Status", "type": "string", "required": false, "description": "实例状态, 可选值: creating 创建中 running 运行中 isolating 隔离中 isolated 已隔离 activating 恢复中 offlining 下线中 offlined 已下线", "example": "running" }, { "name": "InstanceIds", "type": "array", "required": false, "description": "实例id列表", "example": "[\"cynosdbmysql-ins-asd45qwe\"]", "item_type": "string" }, { "name": "ClusterType", "type": "string", "required": false, "description": "集群类型，取值范围 CYNOSDB：事务集群 LIBRADB：分析集群 ALL：全部 ，缺省为 ALL", "example": "CYNOSDB" } ], "required": [] }, { "name": "DescribeInstancesWithinSameCluster", "description": "本接口（DescribeInstancesWithinSameCluster）用于查询同一集群下实例列表", "status": "online", "parameters": [ { "name": "UniqVpcId", "type": "string", "required": true, "description": "vpcId", "example": "vpc-5l7l5q11" }, { "name": "Vip", "type": "string", "required": true, "description": "vip", "example": "subnet-b5v6id11" } ], "required": [ "UniqVpcId", "Vip" ] }, { "name": "DescribeIntegrateTask", "description": "本接口（DescribeIntegrateTask）用于查询集群任务。", "status": "online", "parameters": [ { "name": "BigDealId", "type": "string", "required": false, "description": "大订单id，大订单id和子订单id必须二选一", "example": "20250922456021575047851" }, { "name": "DealNames", "type": "array", "required": false, "description": "订单列表", "example": "[\"20250922456021575003931\"]", "item_type": "string" } ], "required": [] }, { "name": "DescribeIsolatedInstances", "description": "本接口（DescribeIsolatedInstances）用于查询回收站实例列表。", "status": "online", "parameters": [ { "name": "Limit", "type": "integer", "required": false, "description": "返回数量，默认为 20，最大值为 100", "example": "20" }, { "name": "Offset", "type": "integer", "required": false, "description": "记录偏移量，默认值为0", "example": "0" }, { "name": "OrderBy", "type": "string", "required": false, "description": "排序字段，取值范围： CREATETIME：创建时间 PERIODENDTIME：过期时间", "example": "CREATETIME" }, { "name": "OrderByType", "type": "string", "required": false, "description": "排序类型，取值范围： ASC：升序排序 DESC：降序排序", "example": "ASC" }, { "name": "Filters", "type": "array", "required": false, "description": "搜索条件，若存在多个Filter时，Filter间的关系为逻辑与（AND）关系。", "example": "[{\"Names\": \"ProjectId\",\"Values\": \"andy\",\"ExactMatch\": \"1\",\"Name\": \"172\",\"Operator\": \"27627162\"}]", "item_type": "object", "children": [ { "name": "Values", "type": "array", "required": true, "description": "搜索字符串", "example": "[\"1723\"]", "item_type": "string" }, { "name": "Names", "type": "array", "required": true, "description": "搜索字段，目前支持：\"InstanceId\", \"ProjectId\", \"InstanceName\", \"Vip\"", "example": "[\"projectId\"]", "item_type": "string" }, { "name": "ExactMatch", "type": "boolean", "required": false, "description": "是否精确匹配", "example": "false" }, { "name": "Name", "type": "string", "required": false, "description": "搜索字段", "example": "projectId" } ] }, { "name": "DbType", "type": "string", "required": false, "description": "引擎类型：目前支持“MYSQL”， “POSTGRESQL”", "example": "MYSQL" } ], "required": [] }, { "name": "DescribeLibraDBClusterAccountAllPrivileges", "description": "本接口（DescribeLibraDBClusterAccountAllPrivileges）用于查询分析集群账号全部权限", "status": "online", "parameters": [ { "name": "ClusterId", "type": "string", "required": true, "description": "分析集群id", "example": "libradb-xxx" }, { "name": "Account", "type": "object", "required": true, "description": "账号", "example": "无", "children": [ { "name": "AccountName", "type": "string", "required": true, "description": "账号", "example": "andy" }, { "name": "Host", "type": "string", "required": false, "description": "主机，默认‘%’", "example": "%" } ] } ], "required": [ "ClusterId", "Account" ] }, { "name": "DescribeLibraDBClusterAccountPrivileges", "description": "本接口（DescribeLibraDBClusterAccountPrivileges）用于查询分析集群账号权限", "status": "online", "parameters": [ { "name": "ClusterId", "type": "string", "required": true, "description": "集群id", "example": "libradb-xxx" }, { "name": "AccountName", "type": "string", "required": true, "description": "账号名", "example": "admin" }, { "name": "Host", "type": "string", "required": true, "description": "主机名", "example": "127.0.0.1" }, { "name": "Db", "type": "string", "required": true, "description": "数据库名", "example": "Db1" }, { "name": "Type", "type": "string", "required": true, "description": "类型", "example": "table" }, { "name": "TableName", "type": "string", "required": false, "description": "表名", "example": "table1" } ], "required": [ "ClusterId", "AccountName", "Host", "Db", "Type" ] }, { "name": "DescribeLibraDBClusterAccounts", "description": "本接口（DescribeLibraDBClusterAccounts）用于查询分析集群账号", "status": "online", "parameters": [ { "name": "ClusterId", "type": "string", "required": true, "description": "分析集群id", "example": "libradb-xxx" }, { "name": "AccountNames", "type": "array", "required": false, "description": "账号名", "example": "[\"admin1\", \"admin2\"]", "item_type": "string" }, { "name": "AccountRegular", "type": "string", "required": false, "description": "模糊匹配关键字", "example": "admin" }, { "name": "Hosts", "type": "array", "required": false, "description": "主机名", "example": "[\"127.0.0.1\"]", "item_type": "string" }, { "name": "Limit", "type": "integer", "required": false, "description": "限制", "example": "1" }, { "name": "Offset", "type": "integer", "required": false, "description": "偏移", "example": "0" } ], "required": [ "ClusterId" ] }, { "name": "DescribeLibraDBClusterAutoMapRule", "description": "本接口（DescribeLibraDBClusterAutoMapRule）用于查看分析集群高级映射规则", "status": "online", "parameters": [ { "name": "ClusterId", "type": "string", "required": true, "description": "分析集群ID", "example": "libradb-a405lyzg" }, { "name": "InstanceId", "type": "string", "required": true, "description": "分析实例ID", "example": "libradb-ins-80lwcxnx" } ], "required": [ "ClusterId", "InstanceId" ] }, { "name": "DescribeLibraDBClusterDetail", "description": "查询 TDSQL-C 分析集群信息", "status": "online", "parameters": [ { "name": "ClusterId", "type": "string", "required": true, "description": "分析集群 ID", "example": "\"libradb-xxx\"" }, { "name": "GetServerInfo", "type": "string", "required": false, "description": "是否获取更多服务器信息，可选值yes no", "example": "yes" } ], "required": [ "ClusterId" ] }, { "name": "DescribeLibraDBClusterTableMapping", "description": "本接口（ModifyLibraDBForwardConfig）用于查看分析集群库表映射关系", "status": "online", "parameters": [ { "name": "ClusterId", "type": "string", "required": true, "description": "分析集群ID", "example": "libradb-d41df31" }, { "name": "InstanceId", "type": "string", "required": true, "description": "分析引擎实例ID", "example": "libradb-ins-fr1af41" }, { "name": "NodeId", "type": "string", "required": false, "description": "节点ID", "example": "libradb-n1" }, { "name": "Offset", "type": "integer", "required": false, "description": "偏移量", "example": "0" }, { "name": "Limit", "type": "integer", "required": false, "description": "页面记录限制", "example": "20" }, { "name": "SrcSchemas", "type": "array", "required": false, "description": "源端schema列表", "example": "[\"s1\", \"s2\"]", "item_type": "string" }, { "name": "SrcTableName", "type": "array", "required": false, "description": "源端表列表", "example": "[\"t1\", \"t2\"]", "item_type": "string" }, { "name": "StatusList", "type": "array", "required": false, "description": "状态列表", "example": "[\"normal\"]", "item_type": "string" }, { "name": "MapSchemas", "type": "array", "required": false, "description": "映射数据库名称", "example": "[\"ms1\", \"ms2\"]", "item_type": "string" }, { "name": "MapTableName", "type": "array", "required": false, "description": "映射表名", "example": "[\"mt1\", \"mt2\"]", "item_type": "string" }, { "name": "MapSchemaNotEmpty", "type": "boolean", "required": false, "description": "是否查询映射数据库名称不为空的记录", "example": "false" }, { "name": "MapTableNameNotEmpty", "type": "boolean", "required": false, "description": "是否查询映射表名不为空的记录", "example": "false" } ], "required": [ "ClusterId", "InstanceId" ] }, { "name": "DescribeLibraDBClusters", "description": "查询分析集群列表", "status": "online", "parameters": [ { "name": "Limit", "type": "integer", "required": false, "description": "限制", "example": "0" }, { "name": "Offset", "type": "integer", "required": false, "description": "偏置", "example": "0" }, { "name": "OrderBy", "type": "string", "required": false, "description": "排序字段", "example": "cluster" }, { "name": "OrderByType", "type": "string", "required": false, "description": "排序方法", "example": "desc" }, { "name": "Filters", "type": "array", "required": false, "description": "过滤条件", "example": "无", "item_type": "object", "children": [ { "name": "Values", "type": "array", "required": true, "description": "搜索字符串", "example": "[\"1723\"]", "item_type": "string" }, { "name": "Names", "type": "array", "required": true, "description": "搜索字段，目前支持：\"InstanceId\", \"ProjectId\", \"InstanceName\", \"Vip\"", "example": "[\"projectId\"]", "item_type": "string" }, { "name": "ExactMatch", "type": "boolean", "required": false, "description": "是否精确匹配", "example": "false" }, { "name": "Name", "type": "string", "required": false, "description": "搜索字段", "example": "projectId" } ] } ], "required": [] }, { "name": "DescribeLibraDBDataSource", "description": "本接口（DescribeLibraDBDataSource）用于查询分析集群的源实例信息", "status": "online", "parameters": [ { "name": "ClusterId", "type": "string", "required": true, "description": "分析集群ID", "example": "libradb-af341d4" }, { "name": "InstanceId", "type": "string", "required": true, "description": "只读分析引擎实例ID", "example": "libradb-ins-fb3d444" } ], "required": [ "ClusterId", "InstanceId" ] }, { "name": "DescribeLibraDBForwardConfig", "description": "本接口（DescribeLibraDBForwardConfig）用于查询分析引擎转发参数", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "只读分析引擎实例id", "example": "libradb-ins-xxx" } ], "required": [ "InstanceId" ] }, { "name": "DescribeLibraDBInstanceDetail", "description": "本接口(DescribeLibraDBInstanceDetail)用于查询只读分析引擎详情", "status": "online", "parameters": [ { "name": "ClusterId", "type": "string", "required": true, "description": "集群ID", "example": "cynosdbmysql-csmr78sn" }, { "name": "InstanceId", "type": "string", "required": true, "description": "只读分析引擎实例 ID", "example": "\"cynosdbmysql-libradb-ins-mhrc48ym\"]" } ], "required": [ "ClusterId", "InstanceId" ] }, { "name": "DescribeLibraDBInstanceSpecs", "description": "本接口(DescribeLibraDBInstanceSpecs)用于查询只读分析引擎在该地域支持的规格列表信息", "status": "online", "parameters": [], "required": [] }, { "name": "DescribeLibraDBSlowLogs", "description": "本接口（DescribeLibraDBSlowLogs）为只读分析引擎的慢 SQL 明细查询接口", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": false, "description": "只读分析引擎实例 ID", "example": "libradb-ins-i4vsg0tw" }, { "name": "StartTime", "type": "integer", "required": false, "description": "开始时间,1753171200。", "example": "1753171200" }, { "name": "EndTime", "type": "integer", "required": false, "description": "结束时间,1753171200。", "example": "1753171200" }, { "name": "Limit", "type": "string", "required": false, "description": "日志单页条数限制:0-200。", "example": "10" }, { "name": "Offset", "type": "string", "required": false, "description": "日志分页，大于0。", "example": "100" }, { "name": "Order", "type": "string", "required": false, "description": "日志排序方式，DESC-降序，ASC-升序。", "example": "DESC" }, { "name": "OrderBy", "type": "string", "required": false, "description": "日志排序条件。", "example": "User" }, { "name": "LogFilter", "type": "array", "required": false, "description": "过滤条件。", "example": "无", "item_type": "object", "children": [ { "name": "Type", "type": "string", "required": false, "description": "过滤项。", "example": "User" }, { "name": "Compare", "type": "string", "required": false, "description": "过滤条件。支持以下条件： WINC-包含（分词维度）， WEXC-不包含（分词维度）, INC - 包含, EXC - 不包含, EQS - 等于, NEQ - 不等于, RA - 范围。", "example": "INC" }, { "name": "Value", "type": "array", "required": false, "description": "过滤的值。反向查询时，多个值之前是且的关系，正向查询多个值是或的关系", "example": "[\"user-name\"]", "item_type": "string" } ] } ], "required": [] }, { "name": "DescribeLibraDBVersion", "description": "查询只读分析引擎支持的版本列表", "status": "online", "parameters": [], "required": [] }, { "name": "DescribeMaintainPeriod", "description": "本接口（DescribeMaintainPeriod）用于查询实例维护时间窗。", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "实例ID", "example": "cynosdbmysql-ins-n7ocdslw" } ], "required": [ "InstanceId" ] }, { "name": "DescribeParamTemplateDetail", "description": "本接口（DescribeParamTemplateDetail）用于查询用户参数模板详情。", "status": "online", "parameters": [ { "name": "TemplateId", "type": "integer", "required": true, "description": "参数模板ID", "example": "15412" } ], "required": [ "TemplateId" ] }, { "name": "DescribeParamTemplates", "description": "本接口（DescribeParamTemplates）用于查询用户指定产品下的所有参数模板信息。", "status": "online", "parameters": [ { "name": "EngineVersions", "type": "array", "required": false, "description": "数据库引擎版本号", "example": "[\"5.7\"]", "item_type": "string" }, { "name": "TemplateNames", "type": "array", "required": false, "description": "模板名称", "example": "[\"高稳定性模板\"]", "item_type": "string" }, { "name": "TemplateIds", "type": "array", "required": false, "description": "模板ID", "example": "[55001]", "item_type": "integer" }, { "name": "DbModes", "type": "array", "required": false, "description": "数据库类型，可选值：NORMAL，SERVERLESS", "example": "[\"NORMAL\"]", "item_type": "string" }, { "name": "Offset", "type": "integer", "required": false, "description": "查询偏移量", "example": "5" }, { "name": "Limit", "type": "integer", "required": false, "description": "查询限制条数", "example": "20" }, { "name": "Products", "type": "array", "required": false, "description": "查询的模板对应的产品类型", "example": "[\"cynosdb\"]", "item_type": "string" }, { "name": "TemplateTypes", "type": "array", "required": false, "description": "模板类型", "example": "[\"NORMAL_HIGH_STABILITY\"]", "item_type": "string" }, { "name": "EngineTypes", "type": "array", "required": false, "description": "版本类型", "example": "[\"InnoDB\"]", "item_type": "string" }, { "name": "OrderBy", "type": "string", "required": false, "description": "返回结果的排序字段", "example": "CREATETIME" }, { "name": "OrderDirection", "type": "string", "required": false, "description": "排序方式（asc、desc）", "example": "asc" } ], "required": [] }, { "name": "DescribeProjectSecurityGroups", "description": "本接口（DescribeProjectSecurityGroups）用于查询项目安全组信息。", "status": "online", "parameters": [ { "name": "ProjectId", "type": "integer", "required": false, "description": "项目ID", "example": "11954" }, { "name": "Limit", "type": "integer", "required": false, "description": "限制量", "example": "1" }, { "name": "Offset", "type": "integer", "required": false, "description": "偏移量", "example": "1" }, { "name": "SearchKey", "type": "string", "required": false, "description": "搜索关键字", "example": "sg-9stjv111" } ], "required": [] }, { "name": "DescribeProxies", "description": "本接口（DescribeProxies）用于查询数据库代理列表。", "status": "online", "parameters": [ { "name": "ClusterId", "type": "string", "required": false, "description": "集群 ID（该参数必传，例如 cynosdbmysql-2u2mh111）。", "example": "cynosdbmysql-2u2mh111" }, { "name": "Limit", "type": "integer", "required": false, "description": "返回数量，默认为 20，最大值为 100", "example": "20" }, { "name": "Offset", "type": "integer", "required": false, "description": "记录偏移量，默认值为0", "example": "0" }, { "name": "OrderBy", "type": "string", "required": false, "description": "排序字段，取值范围： CREATETIME：创建时间 PERIODENDTIME：过期时间", "example": "\"CREATETIME\"" }, { "name": "OrderByType", "type": "string", "required": false, "description": "排序类型，取值范围： ASC：升序排序 DESC：降序排序", "example": "\"DESC\"" }, { "name": "Filters", "type": "array", "required": false, "description": "搜索条件，若存在多个Filter时，Filter间的关系为逻辑与（AND）关系。", "example": "无", "item_type": "object", "children": [ { "name": "Names", "type": "array", "required": true, "description": "搜索字段，目前支持：ProxyGroupId", "example": "[\"ProxyGroupId\"]", "item_type": "string" }, { "name": "Values", "type": "array", "required": true, "description": "搜索字符串", "example": "[\"cynosdbmysql-proxy-jaq***q7\"]", "item_type": "string" }, { "name": "ExactMatch", "type": "boolean", "required": false, "description": "是否精确匹配", "example": "true" } ] } ], "required": [] }, { "name": "DescribeProxyNodes", "description": "本接口（DescribeProxyNodes）用于查询代理节点列表。", "status": "online", "parameters": [ { "name": "Limit", "type": "integer", "required": false, "description": "返回数量，默认为 20，最大值为 100", "example": "100" }, { "name": "Offset", "type": "integer", "required": false, "description": "记录偏移量，默认值为0", "example": "0" }, { "name": "OrderBy", "type": "string", "required": false, "description": "排序字段，取值范围： CREATETIME：创建时间 PERIODENDTIME：过期时间", "example": "\"CREATETIME\"" }, { "name": "OrderByType", "type": "string", "required": false, "description": "排序类型，取值范围： ASC：升序排序 DESC：降序排序", "example": "\"desc\"" }, { "name": "Filters", "type": "array", "required": false, "description": "搜索条件，若存在多个Filter时，Filter间的关系为逻辑与（AND）关系。目前支持的搜索字段：Status、ProxyNodeId、ClusterId、OssProxyNodeName。", "example": "无", "item_type": "object", "children": [ { "name": "Values", "type": "array", "required": true, "description": "搜索字符串", "example": "[\"1723\"]", "item_type": "string" }, { "name": "Names", "type": "array", "required": true, "description": "搜索字段，目前支持：\"InstanceId\", \"ProjectId\", \"InstanceName\", \"Vip\"", "example": "[\"projectId\"]", "item_type": "string" }, { "name": "ExactMatch", "type": "boolean", "required": false, "description": "是否精确匹配", "example": "false" }, { "name": "Name", "type": "string", "required": false, "description": "搜索字段", "example": "projectId" } ] } ], "required": [] }, { "name": "DescribeProxySpecs", "description": "本接口（DescribeProxySpecs）用于查询数据库代理规格。", "status": "online", "parameters": [ { "name": "ClusterId", "type": "string", "required": false, "description": "集群id", "example": "cynosdbmysql-12xx4321" } ], "required": [] }, { "name": "DescribeRedoLogs", "description": "本接口（DescribeRedoLogs）用于查询redo日志列表。", "status": "online", "parameters": [ { "name": "ClusterId", "type": "string", "required": true, "description": "集群id", "example": "cynosdbmysql-23fdf132" }, { "name": "Limit", "type": "integer", "required": false, "description": "每页条数", "example": "10" }, { "name": "Offset", "type": "integer", "required": false, "description": "偏移量", "example": "0" }, { "name": "StartTime", "type": "string", "required": false, "description": "开始时间", "example": "2022-01-01 12:00:00" }, { "name": "EndTime", "type": "string", "required": false, "description": "结束时间", "example": "2022-02-01 12:00:00" }, { "name": "FileNames", "type": "array", "required": false, "description": "redolog文件名", "example": "[\"backup-1\"]", "item_type": "string" } ], "required": [ "ClusterId" ] }, { "name": "DescribeResourcePackageDetail", "description": "本接口（DescribeResourcePackageDetail）用于查询资源包使用详情。", "status": "online", "parameters": [ { "name": "PackageId", "type": "string", "required": true, "description": "资源包唯一ID", "example": "pkg-qwe" }, { "name": "ClusterIds", "type": "array", "required": false, "description": "集群ID", "example": "[cynosdb-test]", "item_type": "string" }, { "name": "StartTime", "type": "string", "required": false, "description": "开始时间", "example": "2023-02-12 23:59:59" }, { "name": "EndTime", "type": "string", "required": false, "description": "结束时间", "example": "2023-3-23 01:01:01" }, { "name": "Offset", "type": "string", "required": false, "description": "偏移量", "example": "10" }, { "name": "Limit", "type": "string", "required": false, "description": "限制", "example": "20" }, { "name": "InstanceIds", "type": "array", "required": false, "description": "实例D", "example": "[cynosdb-ins-test]", "item_type": "string" } ], "required": [ "PackageId" ] }, { "name": "DescribeResourcePackageList", "description": "本接口（DescribeResourcePackageList）用于查询资源包列表。", "status": "online", "parameters": [ { "name": "PackageId", "type": "array", "required": false, "description": "资源包唯一ID", "example": "package-aqmi9111", "item_type": "string" }, { "name": "PackageName", "type": "array", "required": false, "description": "资源包名称", "example": "edison", "item_type": "string" }, { "name": "PackageType", "type": "array", "required": false, "description": "资源包类型 CCU-计算资源包，DISK-存储资源包", "example": "CCU", "item_type": "string" }, { "name": "PackageRegion", "type": "array", "required": false, "description": "资源包使用地域 china-中国内地通用，overseas-港澳台及海外通用", "example": "china", "item_type": "string" }, { "name": "Status", "type": "array", "required": false, "description": "资源包状态 creating-创建中； using-使用中； expired-已过期； normal_finish-使用完； apply_refund-申请退费中； refund-已退费。", "example": "using", "item_type": "string" }, { "name": "OrderBy", "type": "array", "required": false, "description": "排序条件，支持排序条件:startTime-生效时间， expireTime-过期时间，packageUsedSpec-使用容量，packageTotalSpec-总存储量。 按照数组顺序排列；", "example": "packageUsedSpec", "item_type": "string" }, { "name": "OrderDirection", "type": "string", "required": false, "description": "排序方式，DESC-降序，ASC-升序", "example": "ASC" }, { "name": "Offset", "type": "integer", "required": false, "description": "偏移量", "example": "0" }, { "name": "Limit", "type": "integer", "required": false, "description": "限制", "example": "10" } ], "required": [] }, { "name": "DescribeResourcePackageSaleSpec", "description": "本接口（DescribeResourcePackageSaleSpec）用于查询资源包规格。", "status": "online", "parameters": [ { "name": "InstanceType", "type": "string", "required": true, "description": "实例类型", "example": "cynosdb-serverless" }, { "name": "PackageRegion", "type": "string", "required": true, "description": "资源包使用地域 china-中国内地通用，overseas-港澳台及海外通用", "example": "china" }, { "name": "PackageType", "type": "string", "required": true, "description": "资源包类型 CCU-计算资源包 DISK-存储资源包", "example": "CCU" }, { "name": "Offset", "type": "integer", "required": false, "description": "偏移量", "example": "10" }, { "name": "Limit", "type": "integer", "required": false, "description": "限制", "example": "20" } ], "required": [ "InstanceType", "PackageRegion", "PackageType" ] }, { "name": "DescribeResourcesByDealName", "description": "本接口（DescribeResourcesByDealName）用于查询订单关联实例。", "status": "online", "parameters": [ { "name": "DealName", "type": "string", "required": false, "description": "计费订单ID（如果计费还没回调业务发货，可能出现错误码InvalidParameterValue.DealNameNotFound，这种情况需要业务重试DescribeResourcesByDealName接口直到成功）。 DealName与DealNames至少应输入一项，两者都传时以DealName为准。", "example": "1000000001111" }, { "name": "DealNames", "type": "array", "required": false, "description": "计费订单ID列表，可以一次查询若干条订单ID对应资源信息（如果计费还没回调业务发货，可能出现错误码InvalidParameterValue.DealNameNotFound，这种情况需要业务重试DescribeResourcesByDealName接口直到成功）。 DealName与DealNames至少应输入一项，两者都传时以DealName为准。", "example": "[\"1000000001111\",\"1000000001112\"]", "item_type": "string" } ], "required": [] }, { "name": "DescribeRollbackTimeRange", "description": "本接口（DescribeRollbackTimeRange）用于查询回档时间范围。", "status": "online", "parameters": [ { "name": "ClusterId", "type": "string", "required": true, "description": "集群ID", "example": "cynosdbmysql-oib3wx0i" } ], "required": [ "ClusterId" ] }, { "name": "DescribeSSLStatus", "description": "查询实例SSL状态", "status": "online", "parameters": [ { "name": "ClusterId", "type": "string", "required": true, "description": "集群ID", "example": "cynosdbmysql-bzxxrmtq" }, { "name": "InstanceId", "type": "string", "required": false, "description": "实例ID", "example": "cynosdbmysql-ins-bzxxrmtq" } ], "required": [ "ClusterId" ] }, { "name": "DescribeSaveBackupClusters", "description": "本接口（DescribeSaveBackupClusters）用于查询遗留备份集群信息。", "status": "online", "parameters": [ { "name": "Limit", "type": "integer", "required": true, "description": "每页条数", "example": "10" }, { "name": "Offset", "type": "integer", "required": false, "description": "偏移量", "example": "0" }, { "name": "Filters", "type": "array", "required": false, "description": "检索条件", "example": "无", "item_type": "object", "children": [ { "name": "Names", "type": "array", "required": false, "description": "字段名称", "example": "[\"ClusterId\"]", "item_type": "string" }, { "name": "Values", "type": "array", "required": false, "description": "字段值", "example": "[\"cynosdbmysql-sa23fdf1\"]", "item_type": "string" }, { "name": "ExactMatch", "type": "boolean", "required": false, "description": "模糊匹配，true-是，false否", "example": "true" } ] } ], "required": [ "Limit" ] }, { "name": "DescribeServerlessInstanceSpecs", "description": "查询Serverless实例可选规格", "status": "online", "parameters": [ { "name": "Zone", "type": "string", "required": false, "description": "可用区", "example": "ap-guangzhou-3" } ], "required": [] }, { "name": "DescribeServerlessStrategy", "description": "查询serverless策略", "status": "online", "parameters": [ { "name": "ClusterId", "type": "string", "required": true, "description": "serverless集群id", "example": "cynosdbmysql-xxx" } ], "required": [ "ClusterId" ] }, { "name": "DescribeSlaveZones", "description": "查询从可用区", "status": "online", "parameters": [ { "name": "Zone", "type": "string", "required": true, "description": "可用区", "example": "ap-guangzhou-3" }, { "name": "OssClusterId", "type": "integer", "required": false, "description": "云架集群ID", "example": "1" } ], "required": [ "Zone" ] }, { "name": "DescribeSupportProxyVersion", "description": "本接口（DescribeSupportProxyVersion）用于查询支持的数据库代理版本。", "status": "online", "parameters": [ { "name": "ClusterId", "type": "string", "required": true, "description": "集群ID", "example": "cynosdbmysql-mwg7121e" }, { "name": "ProxyGroupId", "type": "string", "required": false, "description": "数据库代理组ID", "example": "cynosdbmysql-proxy-aroh7ka2" } ], "required": [ "ClusterId" ] }, { "name": "DescribeTasks", "description": "本接口（DescribeTasks）用于查询任务列表。", "status": "online", "parameters": [ { "name": "StartTimeBegin", "type": "string", "required": false, "description": "任务开始时间起始值", "example": "2021-06-23 20:31:57" }, { "name": "StartTimeEnd", "type": "string", "required": false, "description": "任务开始时间结束值", "example": "2021-06-23 21:31:57" }, { "name": "Filters", "type": "array", "required": false, "description": "过滤条件，支持的搜索字段：\"ClusterId\"、\"ClusterName\"、\"InstanceId\"、\"InstanceName\"、\"Status\"、\"TaskId\"、\"TaskType\"", "example": "无", "item_type": "object", "children": [ { "name": "Values", "type": "array", "required": true, "description": "搜索字符串", "example": "[\"1723\"]", "item_type": "string" }, { "name": "Names", "type": "array", "required": true, "description": "搜索字段，目前支持：\"InstanceId\", \"ProjectId\", \"InstanceName\", \"Vip\"", "example": "[\"projectId\"]", "item_type": "string" }, { "name": "ExactMatch", "type": "boolean", "required": false, "description": "是否精确匹配", "example": "false" }, { "name": "Name", "type": "string", "required": false, "description": "搜索字段", "example": "projectId" } ] }, { "name": "Limit", "type": "integer", "required": false, "description": "查询列表长度", "example": "10" }, { "name": "Offset", "type": "integer", "required": false, "description": "查询列表偏移量", "example": "0" } ], "required": [] }, { "name": "DescribeZones", "description": "本接口（DescribeZones）用于查询可售卖地域可用区信息。", "status": "online", "parameters": [ { "name": "IncludeVirtualZones", "type": "boolean", "required": false, "description": "是否包含虚拟区", "example": "false" }, { "name": "ShowPermission", "type": "boolean", "required": false, "description": "是否展示地域下所有可用区，并显示用户每个可用区权限", "example": "false" } ], "required": [] }, { "name": "DisassociateSecurityGroups", "description": "本接口（DisassociateSecurityGroups）用于安全组批量解绑云资源。", "status": "online", "parameters": [ { "name": "InstanceIds", "type": "array", "required": true, "description": "实例组 ID 数组，cynosdbmysql-grp-前缀开头或集群 ID。 说明：要获取集群的实例组 ID，可通过 [查询集群实例组](https://cloud.tencent.com/document/product/1003/103934) 进行。", "example": "[\"cynosdbmysql-grp-beg2j3v0\",\"cynosdbmysql-grp-bfayu2ks\"]", "item_type": "string" }, { "name": "SecurityGroupIds", "type": "array", "required": true, "description": "要修改的安全组ID列表，一个或者多个安全组ID组成的数组。", "example": "[\"sg-ajr1jzgj\"]", "item_type": "string" }, { "name": "Zone", "type": "string", "required": true, "description": "可用区。 说明：请正确输入集群所在的主可用区，若输入非集群所在的主可用区可能显示调用成功，但实际执行会失败。", "example": "ap-guangzhou-3" } ], "required": [ "InstanceIds", "SecurityGroupIds", "Zone" ] }, { "name": "DownloadLibraDBClusterList", "description": "下载分析集群列表", "status": "online", "parameters": [ { "name": "Limit", "type": "integer", "required": false, "description": "限制数", "example": "0" }, { "name": "Offset", "type": "integer", "required": false, "description": "偏移值", "example": "0" }, { "name": "OrderBy", "type": "string", "required": false, "description": "排序字段", "example": "cluster" }, { "name": "OrderByType", "type": "string", "required": false, "description": "排序方式，desc,asc,DESC,ASC", "example": "desc" }, { "name": "Filters", "type": "array", "required": false, "description": "过滤条件", "example": "无", "item_type": "object", "children": [ { "name": "Values", "type": "array", "required": true, "description": "搜索字符串", "example": "[\"1723\"]", "item_type": "string" }, { "name": "Names", "type": "array", "required": true, "description": "搜索字段，目前支持：\"InstanceId\", \"ProjectId\", \"InstanceName\", \"Vip\"", "example": "[\"projectId\"]", "item_type": "string" }, { "name": "ExactMatch", "type": "boolean", "required": false, "description": "是否精确匹配", "example": "false" }, { "name": "Name", "type": "string", "required": false, "description": "搜索字段", "example": "projectId" } ] } ], "required": [] }, { "name": "ExportInstanceErrorLogs", "description": "此接口（ExportInstanceErrorLogs）用于导出实例错误日志。", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "实例ID", "example": "cynosdbmysql-ins-123" }, { "name": "StartTime", "type": "string", "required": false, "description": "日志最早时间", "example": "2022-01-01 12:00:00" }, { "name": "EndTime", "type": "string", "required": false, "description": "日志最晚时间", "example": "2022-01-01 14:00:00" }, { "name": "Limit", "type": "integer", "required": false, "description": "限制条数", "example": "100" }, { "name": "Offset", "type": "integer", "required": false, "description": "偏移量", "example": "0" }, { "name": "LogLevels", "type": "array", "required": false, "description": "日志等级", "example": "error", "item_type": "string" }, { "name": "KeyWords", "type": "array", "required": false, "description": "关键字", "example": "reading communication packets", "item_type": "string" }, { "name": "FileType", "type": "string", "required": false, "description": "文件类型，可选值：csv, original", "example": "csv" }, { "name": "OrderBy", "type": "string", "required": false, "description": "可选值Timestamp", "example": "Timestamp" }, { "name": "OrderByType", "type": "string", "required": false, "description": "排序类型，ASC 或 DESC。", "example": "ASC" } ], "required": [ "InstanceId" ] }, { "name": "ExportInstanceSlowQueries", "description": "本接口（ExportInstanceSlowQueries）用于导出实例慢日志。", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "实例ID", "example": "cynosdbmysql-ins-123" }, { "name": "StartTime", "type": "string", "required": false, "description": "事务开始最早时间", "example": "2022-01-01 12:00:00" }, { "name": "EndTime", "type": "string", "required": false, "description": "事务开始最晚时间", "example": "2022-01-01 14:00:00" }, { "name": "Limit", "type": "integer", "required": false, "description": "限制条数", "example": "100" }, { "name": "Offset", "type": "integer", "required": false, "description": "偏移量", "example": "0" }, { "name": "Username", "type": "string", "required": false, "description": "用户名", "example": "root" }, { "name": "Host", "type": "string", "required": false, "description": "客户端host", "example": "10.10.10.10" }, { "name": "Database", "type": "string", "required": false, "description": "数据库名", "example": "db1" }, { "name": "FileType", "type": "string", "required": false, "description": "文件类型，可选值：csv, original", "example": "csv" }, { "name": "OrderBy", "type": "string", "required": false, "description": "排序字段，可选值： QueryTime,LockTime,RowsExamined,RowsSent", "example": "QueryTime" }, { "name": "OrderByType", "type": "string", "required": false, "description": "排序类型，可选值：asc,desc", "example": "desc" } ], "required": [ "InstanceId" ] }, { "name": "ExportResourcePackageDeductDetails", "description": "资源包使用明细导出", "status": "online", "parameters": [ { "name": "PackageId", "type": "string", "required": true, "description": "需要导出的资源包ID", "example": "package-abcd1234" }, { "name": "ClusterIds", "type": "array", "required": false, "description": "使用资源包容量的cynos集群ID", "example": "[\"cynosdbmysql-3whdf111\"]", "item_type": "string" }, { "name": "OrderBy", "type": "string", "required": false, "description": "排序字段，目前支持：createTime（资源包被抵扣时间），successDeductSpec（资源包抵扣量）", "example": "createTime" }, { "name": "OrderByType", "type": "string", "required": false, "description": "排序类型，支持ASC、DESC、asc、desc", "example": "desc" }, { "name": "StartTime", "type": "string", "required": false, "description": "开始时间", "example": "2022-01-01 01:01:01" }, { "name": "EndTime", "type": "string", "required": false, "description": "结束时间", "example": "2022-01-01 01:01:01" }, { "name": "Limit", "type": "string", "required": false, "description": "单次最大导出数据行数，目前最大支持2000行", "example": "100" }, { "name": "Offset", "type": "string", "required": false, "description": "偏移量页数", "example": "10" }, { "name": "FileType", "type": "string", "required": false, "description": "导出数据格式，目前仅支持csv格式，留作扩展", "example": "csv" } ], "required": [ "PackageId" ] }, { "name": "GrantAccountPrivileges", "description": "本接口（GrantAccountPrivileges）用于批量授权账号权限。", "status": "online", "parameters": [ { "name": "ClusterId", "type": "string", "required": true, "description": "集群id", "example": "cynosdbmysql-asd12qwe" }, { "name": "Account", "type": "object", "required": true, "description": "账号信息", "example": "{\"AccountName\": \"andy\",\"Host\": \"%\"}", "children": [ { "name": "AccountName", "type": "string", "required": true, "description": "账号", "example": "andy" }, { "name": "Host", "type": "string", "required": false, "description": "主机，默认‘%’", "example": "%" } ] }, { "name": "DbTablePrivileges", "type": "array", "required": true, "description": "数据库表权限码数组", "example": "['CREATE','DROP']", "item_type": "string" }, { "name": "DbTables", "type": "array", "required": true, "description": "数据库表信息", "example": "[{\"TableName\": \"tb-tb1\",\"Db\": \"db-db1\"}]", "item_type": "object", "children": [ { "name": "Db", "type": "string", "required": true, "description": "数据库名称", "example": "db-xx" }, { "name": "TableName", "type": "string", "required": false, "description": "数据库表名称", "example": "table-xx" } ] } ], "required": [ "ClusterId", "Account", "DbTablePrivileges", "DbTables" ] }, { "name": "InquirePriceCreate", "description": "本接口（InquirePriceCreate）用于新购集群的价格查询。", "status": "online", "parameters": [ { "name": "Zone", "type": "string", "required": true, "description": "可用区,每个地域提供最佳实践", "example": "ap-guangzhou-3" }, { "name": "GoodsNum", "type": "integer", "required": true, "description": "购买计算节点个数", "example": "1" }, { "name": "InstancePayMode", "type": "string", "required": true, "description": "实例购买类型，可选值为：PREPAID, POSTPAID, SERVERLESS", "example": "PREPAID" }, { "name": "StoragePayMode", "type": "string", "required": true, "description": "存储购买类型，可选值为：PREPAID, POSTPAID", "example": "POSTPAID" }, { "name": "DeviceType", "type": "string", "required": false, "description": "实例设备类型，支持值如下： - common：表示通用型 - exclusive：表示独享型", "example": "exclusive" }, { "name": "Cpu", "type": "integer", "required": false, "description": "CPU核数，PREPAID与POSTPAID实例类型必传", "example": "1" }, { "name": "Memory", "type": "integer", "required": false, "description": "内存大小，单位G，PREPAID与POSTPAID实例类型必传", "example": "1" }, { "name": "Ccu", "type": "float", "required": false, "description": "Ccu大小，serverless类型必传", "example": "0.5" }, { "name": "StorageLimit", "type": "integer", "required": false, "description": "存储大小，PREPAID存储类型必传", "example": "10" }, { "name": "TimeSpan", "type": "integer", "required": false, "description": "购买时长，PREPAID购买类型必传", "example": "1" }, { "name": "TimeUnit", "type": "string", "required": false, "description": "时长单位，可选值为：m,d。PREPAID购买类型必传", "example": "m" } ], "required": [ "Zone", "GoodsNum", "InstancePayMode", "StoragePayMode" ] }, { "name": "InquirePriceModify", "description": "变配预付费集群询价", "status": "online", "parameters": [ { "name": "ClusterId", "type": "string", "required": true, "description": "集群ID", "example": "cynosdbmysql-2u2mh111" }, { "name": "Cpu", "type": "integer", "required": false, "description": "CPU核数", "example": "1" }, { "name": "Memory", "type": "integer", "required": false, "description": "内存大小", "example": "1" }, { "name": "StorageLimit", "type": "integer", "required": false, "description": "存储大小，存储资源变配：ClusterId,StorageLimit", "example": "10" }, { "name": "InstanceId", "type": "string", "required": false, "description": "实例ID，计算资源变配必传: ClusterId,InstanceId,Cpu,Memory", "example": "cynosdbmysql-ins-d6l1z111" }, { "name": "DeviceType", "type": "string", "required": false, "description": "实例设备类型", "example": "exclusive" }, { "name": "Ccu", "type": "float", "required": false, "description": "serverless实例ccu大小", "example": "0.5" } ], "required": [ "ClusterId" ] }, { "name": "InquirePriceMultiSpec", "description": "此接口（InquirePriceMultiSpec）用于批量询价", "status": "online", "parameters": [ { "name": "Zone", "type": "string", "required": true, "description": "可用区,每个地域提供最佳实践", "example": "ap-guangzhou-2" }, { "name": "InstancePayMode", "type": "string", "required": true, "description": "实例购买类型，可选值为：PREPAID, POSTPAID, SERVERLESS", "example": "PREPAID" }, { "name": "StoragePayMode", "type": "string", "required": true, "description": "存储购买类型，可选值为：PREPAID, POSTPAID", "example": "POSTPAID" }, { "name": "GoodsSpecs", "type": "array", "required": true, "description": "商品规格", "example": "无", "item_type": "object", "children": [ { "name": "GoodsNum", "type": "integer", "required": false, "description": "商品数量 注意：此字段可能返回 null，表示取不到有效值。", "example": "1" }, { "name": "Cpu", "type": "integer", "required": false, "description": "CPU核数，PREPAID与POSTPAID实例类型必传 注意：此字段可能返回 null，表示取不到有效值。", "example": "1" }, { "name": "Memory", "type": "integer", "required": false, "description": "内存大小，单位G，PREPAID与POSTPAID实例类型必传 注意：此字段可能返回 null，表示取不到有效值。", "example": "2" }, { "name": "Ccu", "type": "float", "required": false, "description": "Ccu大小，serverless类型必传 注意：此字段可能返回 null，表示取不到有效值。", "example": "0.5" }, { "name": "StorageLimit", "type": "integer", "required": false, "description": "存储大小，PREPAID存储类型必传 注意：此字段可能返回 null，表示取不到有效值。", "example": "10" }, { "name": "TimeSpan", "type": "integer", "required": false, "description": "购买时长 注意：此字段可能返回 null，表示取不到有效值。", "example": "1" }, { "name": "TimeUnit", "type": "string", "required": false, "description": "时长单位 注意：此字段可能返回 null，表示取不到有效值。", "example": "m" }, { "name": "DeviceType", "type": "string", "required": false, "description": "实例机器类型 1. common，通用型。 2. exclusive，独享型。", "example": "common" } ] } ], "required": [ "Zone", "InstancePayMode", "StoragePayMode", "GoodsSpecs" ] }, { "name": "InquirePriceRenew", "description": "本接口（InquirePriceRenew）用于查询续费集群价格。", "status": "online", "parameters": [ { "name": "ClusterId", "type": "string", "required": true, "description": "集群ID", "example": "cynosdbmysql-mwg7121e" }, { "name": "TimeSpan", "type": "integer", "required": true, "description": "购买时长,与TimeUnit组合才能生效", "example": "1" }, { "name": "TimeUnit", "type": "string", "required": true, "description": "购买时长单位, 与TimeSpan组合生效，可选:日:d,月:m", "example": "m" } ], "required": [ "ClusterId", "TimeSpan", "TimeUnit" ] }, { "name": "IsolateCluster", "description": "本接口（IsolateCluster）用于隔离集群。", "status": "online", "parameters": [ { "name": "ClusterId", "type": "string", "required": true, "description": "集群ID", "example": "cynosdbpg-bzxxrmtq" }, { "name": "DbType", "type": "string", "required": false, "description": "该参数已废用", "example": "MYSQL" }, { "name": "IsolateReasonTypes", "type": "array", "required": false, "description": "实例退还原因类型", "example": "[1,2,3]", "item_type": "integer" }, { "name": "IsolateReason", "type": "string", "required": false, "description": "实例退还原因补充", "example": "隔离原因" }, { "name": "SaveBackup", "type": "boolean", "required": false, "description": "保留备份,true-保留（会产生费用）", "example": "false" } ], "required": [ "ClusterId" ] }, { "name": "IsolateInstance", "description": "本接口(IsolateInstance)用于隔离实例。", "status": "online", "parameters": [ { "name": "ClusterId", "type": "string", "required": true, "description": "集群ID", "example": "cynosdbmysql-ins-bzkxxrmt" }, { "name": "InstanceIdList", "type": "array", "required": true, "description": "实例ID数组，例如[\"cynosdbbmysql-ins-asd\",\"cynosdbmysql-ins-zxc\"]", "example": "[\"cynosdbmysql-ixgbd0di\\n\"]", "item_type": "string" }, { "name": "DbType", "type": "string", "required": false, "description": "该参数已废弃", "example": "MYSQL" }, { "name": "IsolateReasonTypes", "type": "array", "required": false, "description": "实例退还原因类型", "example": "[1,2,3]", "item_type": "integer" }, { "name": "IsolateReason", "type": "string", "required": false, "description": "实例退还原因补充", "example": "退还原因" }, { "name": "SaveBackup", "type": "boolean", "required": false, "description": "保留备份", "example": "false" } ], "required": [ "ClusterId", "InstanceIdList" ] }, { "name": "IsolateLibraDBCluster", "description": "隔离 TDSQL-C 分析集群", "status": "online", "parameters": [ { "name": "ClusterId", "type": "string", "required": true, "description": "分析集群 ID", "example": "libradb-xxx" }, { "name": "IsolateReasonTypes", "type": "array", "required": false, "description": "隔离原因类型", "example": "[0,1]", "item_type": "integer" }, { "name": "IsolateReason", "type": "string", "required": false, "description": "隔离原因", "example": "\"测试完成，需要隔离\"" } ], "required": [ "ClusterId" ] }, { "name": "IsolateLibraDBInstance", "description": "本接口(IsolateLibraDBInstance)用于隔离的只读分析引擎实例。", "status": "online", "parameters": [ { "name": "ClusterId", "type": "string", "required": true, "description": "集群ID", "example": "cynosdbmysql-bzxxrmtq" }, { "name": "InstanceIdList", "type": "array", "required": true, "description": "只读分析引擎实例 ID 列表", "example": "[\"cynosdbmysql-libradb-ins-mhrc48ym\"]", "item_type": "string" }, { "name": "ForceIsolate", "type": "boolean", "required": false, "description": "是否是强制隔离", "example": "true" }, { "name": "IsolateReasonTypes", "type": "array", "required": false, "description": "隔离原因类型", "example": "[12]", "item_type": "integer" }, { "name": "IsolateReason", "type": "string", "required": false, "description": "隔离原因", "example": "\"test\"" } ], "required": [ "ClusterId", "InstanceIdList" ] }, { "name": "ModifyAccountDescription", "description": "本接口(ModifyAccountDescription)用于修改数据库账号描述信息。", "status": "online", "parameters": [ { "name": "AccountName", "type": "string", "required": true, "description": "数据库账号名", "example": "admin" }, { "name": "Description", "type": "string", "required": true, "description": "数据库账号描述信息", "example": "admin" }, { "name": "ClusterId", "type": "string", "required": true, "description": "集群ID", "example": "cynosdbpg-on5xw0ni" }, { "name": "Host", "type": "string", "required": false, "description": "主机，默认为\"%\"", "example": "%" } ], "required": [ "AccountName", "Description", "ClusterId" ] }, { "name": "ModifyAccountHost", "description": "本接口（ModifyAccountHost）用于修改账号主机。", "status": "online", "parameters": [ { "name": "ClusterId", "type": "string", "required": true, "description": "集群id", "example": "cynosdbmysql-on5xw0ni" }, { "name": "NewHost", "type": "string", "required": true, "description": "新主机", "example": "192.168.12.15" }, { "name": "Account", "type": "object", "required": true, "description": "账号信息", "example": "无", "children": [ { "name": "AccountName", "type": "string", "required": true, "description": "账号", "example": "andy" }, { "name": "Host", "type": "string", "required": false, "description": "主机，默认‘%’", "example": "%" } ] } ], "required": [ "ClusterId", "NewHost", "Account" ] }, { "name": "ModifyAccountParams", "description": "本接口（ModifyAccountParams）用于修改账号配置。", "status": "online", "parameters": [ { "name": "ClusterId", "type": "string", "required": true, "description": "集群id，不超过32个字符", "example": "cynosdbmysql-asd123qw" }, { "name": "Account", "type": "object", "required": true, "description": "账号信息", "example": "{\"AccountName\": \"andy\",\"Host\": \"%\"}", "children": [ { "name": "AccountName", "type": "string", "required": true, "description": "账号", "example": "andy" }, { "name": "Host", "type": "string", "required": false, "description": "主机，默认‘%’", "example": "%" } ] }, { "name": "AccountParams", "type": "array", "required": true, "description": "数据库表权限数组,当前仅支持参数：max_user_connections，max_user_connections不能大于10240", "example": "[{\"ParamName\":\"max_user_connections\",\"ParamValue\":\"400\"}]", "item_type": "object", "children": [ { "name": "ParamName", "type": "string", "required": true, "description": "参数名称，当前仅支持参数：max_user_connections", "example": "max_user_connections" }, { "name": "ParamValue", "type": "string", "required": true, "description": "参数值", "example": "1" } ] } ], "required": [ "ClusterId", "Account", "AccountParams" ] }, { "name": "ModifyAccountPrivileges", "description": "本接口（ModifyAccountPrivileges）用于修改账号库表权限。", "status": "online", "parameters": [ { "name": "ClusterId", "type": "string", "required": true, "description": "集群id", "example": "cynosdbmysql-asd12qwe" }, { "name": "Account", "type": "object", "required": true, "description": "账号信息", "example": "{\"AccountName\": \"andy\",\"Host\": \"%\"}", "children": [ { "name": "AccountName", "type": "string", "required": true, "description": "账号", "example": "andy" }, { "name": "Host", "type": "string", "required": false, "description": "主机，默认‘%’", "example": "%" } ] }, { "name": "GlobalPrivileges", "type": "array", "required": false, "description": "全局权限数组", "example": "[\"CREATE\",\"DELETE\"]", "item_type": "string" }, { "name": "DatabasePrivileges", "type": "array", "required": false, "description": "数据库权限数组", "example": "[\"ALTER\", \"ALTER ROUTINE\"]", "item_type": "object", "children": [ { "name": "Db", "type": "string", "required": true, "description": "数据库", "example": "db1" }, { "name": "Privileges", "type": "array", "required": true, "description": "权限列表", "example": "[\"DROP\",\"EXECUTE\"]", "item_type": "string" } ] }, { "name": "TablePrivileges", "type": "array", "required": false, "description": "表权限数组", "example": "[\"DROP\", \"GRANT OPTION\"]", "item_type": "object", "children": [ { "name": "Db", "type": "string", "required": true, "description": "数据库名", "example": "db1" }, { "name": "TableName", "type": "string", "required": true, "description": "表名", "example": "tb1" }, { "name": "Privileges", "type": "array", "required": true, "description": "权限列表", "example": "[\"CREATE\",\"ALTER\"]", "item_type": "string" } ] } ], "required": [ "ClusterId", "Account" ] }, { "name": "ModifyAuditRuleTemplates", "description": "本接口（ModifyAuditRuleTemplates）用于修改审计规则模板。", "status": "online", "parameters": [ { "name": "RuleTemplateIds", "type": "array", "required": true, "description": "审计规则模板ID。", "example": "cynosdb-art-l1mlbo59", "item_type": "string" }, { "name": "RuleFilters", "type": "array", "required": false, "description": "修改后的审计规则。", "example": "[{\"Type\": \"sqlType\",\"Compare\": \"INC\",\"Value\": \"UPDATE\"}]", "item_type": "object", "children": [ { "name": "Type", "type": "string", "required": true, "description": "审计规则过滤条件的参数名称。可选值：host – 客户端 IP；user – 数据库账户；dbName – 数据库名称；sqlType-SQL类型；sql-sql语句；affectRows -影响行数；sentRows-返回行数；checkRows-扫描行数；execTime-执行时间。", "example": "sqlType" }, { "name": "Compare", "type": "string", "required": true, "description": "审计规则过滤条件的匹配类型。可选值：INC – 包含；EXC – 不包含；EQS – 等于；NEQ – 不等于；REG-正则；GT-大于；LT-小于。", "example": "INC" }, { "name": "Value", "type": "array", "required": true, "description": "审计规则过滤条件的匹配值。", "example": "UPDATE", "item_type": "string" } ] }, { "name": "RuleTemplateName", "type": "string", "required": false, "description": "修改后的规则模板名称。", "example": "新规则模板名称" }, { "name": "Description", "type": "string", "required": false, "description": "修改后的规则模板描述。", "example": "新规则模板描述" }, { "name": "AlarmLevel", "type": "integer", "required": false, "description": "告警等级。1-低风险，2-中风险，3-高风险。", "example": "1" }, { "name": "AlarmPolicy", "type": "integer", "required": false, "description": "告警策略。0-不告警，1-告警。", "example": "0" } ], "required": [ "RuleTemplateIds" ] }, { "name": "ModifyAuditService", "description": "本接口(ModifyAuditService)用于修改云数据库审计日志保存时长、审计规则等服务配置。", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "实例ID。", "example": "cynosdbmysql-ins-6990cckk" }, { "name": "LogExpireDay", "type": "integer", "required": false, "description": "日志保留时长。", "example": "30" }, { "name": "HighLogExpireDay", "type": "integer", "required": false, "description": "高频日志保留时长。", "example": "7" }, { "name": "AuditAll", "type": "boolean", "required": false, "description": "修改实例审计规则为全审计。", "example": "true" }, { "name": "AuditRuleFilters", "type": "array", "required": false, "description": "规则审计。", "example": "[\"RuleFilters\": [{\"Type\": \"sqlType\",\"Compare\": \"INC\",\"Value\": \"UPDATE\"}]]", "item_type": "object", "children": [ { "name": "RuleFilters", "type": "array", "required": true, "description": "单条审计规则。", "example": "[{\"RuleFilters\": [{\"Type\": \"host\",\"Compare\": \"INC\",\"Value\": [\"172.1.1.1\"]}]}]", "item_type": "object", "children": [ { "name": "Type", "type": "string", "required": true, "description": "审计规则过滤条件的参数名称。可选值：host – 客户端 IP；user – 数据库账户；dbName – 数据库名称；sqlType-SQL类型；sql-sql语句；affectRows -影响行数；sentRows-返回行数；checkRows-扫描行数；execTime-执行时间。", "example": "sqlType" }, { "name": "Compare", "type": "string", "required": true, "description": "审计规则过滤条件的匹配类型。可选值：INC – 包含；EXC – 不包含；EQS – 等于；NEQ – 不等于；REG-正则；GT-大于；LT-小于。", "example": "INC" }, { "name": "Value", "type": "array", "required": true, "description": "审计规则过滤条件的匹配值。", "example": "UPDATE", "item_type": "string" } ] } ] }, { "name": "RuleTemplateIds", "type": "array", "required": false, "description": "规则模板ID。", "example": "[\"cynosdb-art-c1jo4111\"]", "item_type": "string" } ], "required": [ "InstanceId" ] }, { "name": "ModifyBackupConfig", "description": "本接口（ModifyBackupConfig）用于修改指定集群的备份配置。", "status": "online", "parameters": [ { "name": "ClusterId", "type": "string", "required": true, "description": "集群ID", "example": "cynosdbmysql-45knmnra" }, { "name": "BackupTimeBeg", "type": "integer", "required": false, "description": "表示全备开始时间，[0-24*3600]， 如0:00, 1:00, 2:00 分别为 0，3600， 7200", "example": "7200" }, { "name": "BackupTimeEnd", "type": "integer", "required": false, "description": "表示全备结束时间，[0-24*3600]， 如0:00, 1:00, 2:00 分别为 0，3600， 7200", "example": "21600" }, { "name": "ReserveDuration", "type": "integer", "required": false, "description": "表示保留备份时长, 单位秒，超过该时间将被清理, 七天表示为3600*24*7=604800，最大为158112000", "example": "604800" }, { "name": "BackupFreq", "type": "array", "required": false, "description": "该参数目前不支持修改，无需填写。备份频率，长度为7的数组，分别对应周一到周日的备份方式，full-全量备份，increment-增量备份", "example": "[\"full\",\"full\",\"full\",\"full\",\"full\",\"full\",\"full\"]", "item_type": "string" }, { "name": "BackupType", "type": "string", "required": false, "description": "该参数目前不支持修改，无需填写。", "example": "logic" }, { "name": "LogicBackupConfig", "type": "object", "required": false, "description": "逻辑备份配置", "example": "无", "children": [ { "name": "LogicBackupEnable", "type": "string", "required": false, "description": "是否开启自动逻辑备份", "example": "OFF" }, { "name": "LogicBackupTimeBeg", "type": "integer", "required": false, "description": "自动逻辑备份开始时间", "example": "2" }, { "name": "LogicBackupTimeEnd", "type": "integer", "required": false, "description": "自动逻辑备份结束时间", "example": "6" }, { "name": "LogicReserveDuration", "type": "integer", "required": false, "description": "自动逻辑备份保留时间 单位：秒", "example": "7" }, { "name": "LogicCrossRegionsEnable", "type": "string", "required": false, "description": "是否开启跨地域逻辑备份 可选值：ON/OFF", "example": "ON" }, { "name": "LogicCrossRegions", "type": "array", "required": false, "description": "逻辑备份所跨地域 注意：此字段可能返回 null，表示取不到有效值。", "example": "[\"ap-guangzhou\"]", "item_type": "string" }, { "name": "AutoCopyVaults", "type": "array", "required": false, "description": "备份投递关系", "example": "无", "item_type": "object", "children": [ { "name": "VaultId", "type": "string", "required": false, "description": "保险箱id 注意：此字段可能返回 null，表示取不到有效值。", "example": "vault-a6ed23f2-f03e-4410-b946-624d1e7d9b5a" }, { "name": "VaultRegion", "type": "string", "required": false, "description": "保险箱地域 注意：此字段可能返回 null，表示取不到有效值。", "example": "ap-guangzhou" } ] } ] }, { "name": "DeleteAutoLogicBackup", "type": "boolean", "required": false, "description": "是否删除自动逻辑备份", "example": "false" }, { "name": "SnapshotSecondaryBackupConfig", "type": "object", "required": false, "description": "二级快照备份参数", "example": "无", "children": [ { "name": "BackupCustomAutoTime", "type": "boolean", "required": false, "description": "系统自动时间", "example": "false" }, { "name": "BackupTimeBeg", "type": "integer", "required": false, "description": "表示全备开始时间，[0-24*3600]， 如0:00, 1:00, 2:00 分别为 0，3600， 7200", "example": "7200" }, { "name": "BackupTimeEnd", "type": "integer", "required": false, "description": "表示全备结束时间，[0-24*3600]， 如0:00, 1:00, 2:00 分别为 0，3600， 7200", "example": "21600" }, { "name": "BackupWeekDays", "type": "array", "required": false, "description": "该参数目前不支持修改，无需填写。备份频率，长度为7的数组，分别对应周日到周六的备份方式，full-全量备份，increment-增量备份", "example": "[\"none\",\"full\",\"none\",\"full\",\"none\",\"full\",\"none\"]", "item_type": "string" }, { "name": "BackupIntervalTime", "type": "integer", "required": false, "description": "间隔时间", "example": "4" }, { "name": "ReserveDuration", "type": "integer", "required": false, "description": "表示保留备份时长, 单位秒，超过该时间将被清理, 七天表示为3600247=604800，最大为158112000", "example": "604800" }, { "name": "BackupTriggerStrategy", "type": "string", "required": false, "description": "自动数据备份触发策略，periodically:自动周期备份,frequent:高频备份", "example": "periodically" }, { "name": "AutoCopyVaults", "type": "array", "required": false, "description": "保险箱信息", "example": "无", "item_type": "object", "children": [ { "name": "VaultId", "type": "string", "required": false, "description": "保险箱id 注意：此字段可能返回 null，表示取不到有效值。", "example": "vault-a6ed23f2-f03e-4410-b946-624d1e7d9b5a" }, { "name": "VaultRegion", "type": "string", "required": false, "description": "保险箱地域 注意：此字段可能返回 null，表示取不到有效值。", "example": "ap-guangzhou" } ] } ] } ], "required": [ "ClusterId" ] }, { "name": "ModifyBackupDownloadRestriction", "description": "该接口用于修改用户当前地域的备份文件限制下载来源，可以设置内外网均可下载、仅内网可下载，或内网指定的vpc、ip可以下载。", "status": "online", "parameters": [ { "name": "ClusterIds", "type": "array", "required": true, "description": "集群ID", "example": "cynosdbmysql-bzxxrmtq", "item_type": "string" }, { "name": "LimitType", "type": "string", "required": true, "description": "下载限制类型，NoLimit-不限制,LimitOnlyIntranet-限制内网 ,Customize-自定义", "example": "MYSQL" }, { "name": "VpcComparisonSymbol", "type": "string", "required": false, "description": "该参数仅支持 In， 表示 LimitVpc 指定的vpc可以下载。默认为In", "example": "In" }, { "name": "IpComparisonSymbol", "type": "string", "required": false, "description": "In: 指定的ip可以下载； NotIn: 指定的ip不可以下载", "example": "In" }, { "name": "LimitVpcs", "type": "array", "required": false, "description": "限制下载的vpc设置", "example": "[{\"Region\": \"ap-guangzhou\", \"VpcList\": [\"vpc-kas1\"] } ]", "item_type": "object", "children": [ { "name": "Region", "type": "string", "required": false, "description": "限制下载来源的地域。目前仅支持当前地域", "example": "ap-guangzhou" }, { "name": "VpcList", "type": "array", "required": false, "description": "限制下载的vpc列表", "example": "[\"vpc-a2wef\"]", "item_type": "string" } ] }, { "name": "LimitIps", "type": "array", "required": false, "description": "限制下载的ip设置", "example": "[127.0.0.1,127.0.0.2]", "item_type": "string" } ], "required": [ "ClusterIds", "LimitType" ] }, { "name": "ModifyBackupDownloadUserRestriction", "description": "该接口用于修改用户当前地域的备份文件限制下载来源，可以设置内外网均可下载、仅内网可下载，或内网指定的vpc、ip可以下载。", "status": "online", "parameters": [ { "name": "LimitType", "type": "string", "required": true, "description": "下载限制类型，NoLimit-不限制,LimitOnlyIntranet-限制内网 ,Customize-自定义", "example": "NoLimit" }, { "name": "VpcComparisonSymbol", "type": "string", "required": false, "description": "该参数仅支持 In， 表示 LimitVpc 指定的vpc可以下载。默认为In", "example": "In" }, { "name": "IpComparisonSymbol", "type": "string", "required": false, "description": "In: 指定的ip可以下载； NotIn: 指定的ip不可以下载", "example": "In" }, { "name": "LimitVpcs", "type": "array", "required": false, "description": "限制下载的vpc设置", "example": "[{\"Region\": \"ap-guangzhou\", \"VpcList\": [\"vpc-kas1\"] } ]", "item_type": "object", "children": [ { "name": "Region", "type": "string", "required": false, "description": "限制下载来源的地域。目前仅支持当前地域", "example": "ap-guangzhou" }, { "name": "VpcList", "type": "array", "required": false, "description": "限制下载的vpc列表", "example": "[\"vpc-a2wef\"]", "item_type": "string" } ] }, { "name": "LimitIps", "type": "array", "required": false, "description": "限制下载的ip设置", "example": "[127.0.0.1,127.0.0.2]", "item_type": "string" } ], "required": [ "LimitType" ] }, { "name": "ModifyBackupName", "description": "此接口（ModifyBackupName）用于修改备份文件备注名。", "status": "online", "parameters": [ { "name": "ClusterId", "type": "string", "required": true, "description": "集群ID", "example": "cynosdbmysql-123" }, { "name": "BackupId", "type": "integer", "required": true, "description": "备份文件ID", "example": "100" }, { "name": "BackupName", "type": "string", "required": true, "description": "备注名，长度不能超过60个字符", "example": "2024-1月备份" } ], "required": [ "ClusterId", "BackupId", "BackupName" ] }, { "name": "ModifyBinlogConfig", "description": "该接口（ModifyBinlogConfig）用于修改Binlog配置", "status": "online", "parameters": [ { "name": "ClusterId", "type": "string", "required": true, "description": "集群ID", "example": "cynosdbmysql-2u2mh111" }, { "name": "BinlogConfig", "type": "object", "required": true, "description": "Binlog配置信息", "example": "{\"BinlogSaveDays\": 7,\"BinlogCrossRegionsEnable\": \"yes\",\"BinlogCrossRegions\": [\"ap-guangzhou\"]}", "children": [ { "name": "BinlogSaveDays", "type": "integer", "required": true, "description": "binlog保留时间", "example": "7" }, { "name": "BinlogCrossRegionsEnable", "type": "string", "required": true, "description": "binlog异地地域备份是否开启", "example": "ON" }, { "name": "BinlogCrossRegions", "type": "array", "required": false, "description": "binlog异地地域 注意：此字段可能返回 null，表示取不到有效值。", "example": "[\"ap-guangzhou\"]", "item_type": "string" }, { "name": "AutoCopyVaults", "type": "array", "required": false, "description": "保险箱信息", "example": "无", "item_type": "object", "children": [ { "name": "VaultId", "type": "string", "required": false, "description": "保险箱id 注意：此字段可能返回 null，表示取不到有效值。", "example": "vault-a6ed23f2-f03e-4410-b946-624d1e7d9b5a" }, { "name": "VaultRegion", "type": "string", "required": false, "description": "保险箱地域 注意：此字段可能返回 null，表示取不到有效值。", "example": "ap-guangzhou" } ] } ] } ], "required": [ "ClusterId", "BinlogConfig" ] }, { "name": "ModifyBinlogSaveDays", "description": "此接口（ModifyBinlogSaveDays）用于修改集群Binlog保留天数。", "status": "online", "parameters": [ { "name": "ClusterId", "type": "string", "required": true, "description": "集群ID", "example": "cynosdb-123" }, { "name": "BinlogSaveDays", "type": "integer", "required": true, "description": "Binlog保留天数", "example": "7" } ], "required": [ "ClusterId", "BinlogSaveDays" ] }, { "name": "ModifyClusterDatabase", "description": "本接口（ModifyClusterDatabase）用于修改数据库的账号授权。", "status": "online", "parameters": [ { "name": "ClusterId", "type": "string", "required": true, "description": "集群ID", "example": "cynosdbmysql-xxxxxxx" }, { "name": "DbName", "type": "string", "required": true, "description": "数据库名", "example": "db_andy" }, { "name": "NewUserHostPrivileges", "type": "array", "required": false, "description": "新授权用户主机权限", "example": "[{\"DbUserName\": \"andy\",\"DbHost\": \"1.1.11.1\",\"DbPrivilege\": \"readonly\"}]", "item_type": "object", "children": [ { "name": "DbUserName", "type": "string", "required": true, "description": "授权用户", "example": "root" }, { "name": "DbHost", "type": "string", "required": true, "description": "客户端ip", "example": "%" }, { "name": "DbPrivilege", "type": "string", "required": true, "description": "用户权限", "example": "readonly" } ] }, { "name": "Description", "type": "string", "required": false, "description": "备注", "example": "andy授权" }, { "name": "OldUserHostPrivileges", "type": "array", "required": false, "description": "历史授权用户主机权限", "example": "[{\"DbUserName\": \"andy\",\"DbHost\": \"%\",\"DbPrivilege\": \"readonly\"}]", "item_type": "object", "children": [ { "name": "DbUserName", "type": "string", "required": true, "description": "授权用户", "example": "root" }, { "name": "DbHost", "type": "string", "required": true, "description": "客户端ip", "example": "%" }, { "name": "DbPrivilege", "type": "string", "required": true, "description": "用户权限", "example": "readonly" } ] } ], "required": [ "ClusterId", "DbName" ] }, { "name": "ModifyClusterGlobalEncryption", "description": "开关全局加密", "status": "online", "parameters": [ { "name": "ClusterId", "type": "string", "required": true, "description": "集群id", "example": "cynosdbmysql-72xtubad" }, { "name": "IsOpenGlobalEncryption", "type": "boolean", "required": false, "description": "开启或关闭全局加密", "example": "true" } ], "required": [ "ClusterId" ] }, { "name": "ModifyClusterName", "description": "本接口（ModifyClusterName）用于修改集群名称。", "status": "online", "parameters": [ { "name": "ClusterId", "type": "string", "required": true, "description": "集群ID", "example": "cynosdbpg-5804k48e" }, { "name": "ClusterName", "type": "string", "required": true, "description": "集群名", "example": "newName" } ], "required": [ "ClusterId", "ClusterName" ] }, { "name": "ModifyClusterParam", "description": "本接口（ModifyClusterParam）用于修改集群参数。", "status": "online", "parameters": [ { "name": "ClusterId", "type": "string", "required": true, "description": "集群ID", "example": "cynosdbmysql-jhi2gdi0" }, { "name": "ParamList", "type": "array", "required": true, "description": "要修改的参数列表。每一个元素是ParamName、CurrentValue和OldValue的组合。ParamName是参数名称，CurrentValue是当前值，OldValue是之前值且不做校验", "example": "无", "item_type": "object", "children": [ { "name": "ParamName", "type": "string", "required": true, "description": "参数名称", "example": "innodb_txsql_log_store_size" }, { "name": "CurrentValue", "type": "string", "required": true, "description": "当前值", "example": "2048" }, { "name": "OldValue", "type": "string", "required": true, "description": "原有值", "example": "65536" } ] }, { "name": "IsInMaintainPeriod", "type": "string", "required": false, "description": "维护期间执行-yes,立即执行-no", "example": "yes" } ], "required": [ "ClusterId", "ParamList" ] }, { "name": "ModifyClusterPasswordComplexity", "description": "本接口（ModifyClusterPasswordComplexity）用于修改/开启集群密码复杂度。", "status": "online", "parameters": [ { "name": "ClusterId", "type": "string", "required": true, "description": "集群id", "example": "cynosdbpg-bzxxrmtq" }, { "name": "ValidatePasswordLength", "type": "integer", "required": true, "description": "密码长度", "example": "8" }, { "name": "ValidatePasswordMixedCaseCount", "type": "integer", "required": true, "description": "大小写字符个数", "example": "1" }, { "name": "ValidatePasswordSpecialCharCount", "type": "integer", "required": true, "description": "特殊字符个数", "example": "1" }, { "name": "ValidatePasswordNumberCount", "type": "integer", "required": true, "description": "数字个数", "example": "1" }, { "name": "ValidatePasswordPolicy", "type": "string", "required": true, "description": "密码强度（\"MEDIUM\", \"STRONG\"）", "example": "MEDIUM" }, { "name": "ValidatePasswordDictionary", "type": "array", "required": false, "description": "数据字典", "example": "[\"admin\"]", "item_type": "string" } ], "required": [ "ClusterId", "ValidatePasswordLength", "ValidatePasswordMixedCaseCount", "ValidatePasswordSpecialCharCount", "ValidatePasswordNumberCount", "ValidatePasswordPolicy" ] }, { "name": "ModifyClusterReadOnly", "description": "本接口（ModifyClusterReadOnly）用于修改集群只读开关。", "status": "online", "parameters": [ { "name": "ClusterIds", "type": "array", "required": true, "description": "集群ID列表", "example": "[\"cynosdbmysql-0lxfuag5\",\"cynosdbmysql-2d9pq38h\"]", "item_type": "string" }, { "name": "ReadOnlyOperation", "type": "string", "required": true, "description": "集群只读开关，可选值：ON，OFF", "example": "ON" }, { "name": "IsInMaintainPeriod", "type": "string", "required": false, "description": "yes：在运维时间窗内修改，no：立即执行（默认值）", "example": "yes" } ], "required": [ "ClusterIds", "ReadOnlyOperation" ] }, { "name": "ModifyClusterSlaveZone", "description": "本接口（ModifyClusterSlaveZone）用于变更集群的备可用区。", "status": "online", "parameters": [ { "name": "ClusterId", "type": "string", "required": true, "description": "集群Id", "example": "cynosdbmysql-xxxxxxx" }, { "name": "OldSlaveZone", "type": "string", "required": true, "description": "旧从可用区", "example": "ap-guangzhou-2" }, { "name": "NewSlaveZone", "type": "string", "required": true, "description": "新从可用区", "example": "ap-guangzhou-3" }, { "name": "BinlogSyncWay", "type": "string", "required": false, "description": "binlog同步方式。默认值：async。可选值：sync、semisync、async", "example": "async" }, { "name": "SemiSyncTimeout", "type": "integer", "required": false, "description": "半同步超时时间，单位ms。为保证业务稳定性，半同步复制存在退化逻辑，当主可用区集群在等待备可用区集群确认事务时若超过该超时时间，复制方式将降为异步复制。最低设置为1000ms，最高支持4294967295ms，默认10000ms。", "example": "10000" } ], "required": [ "ClusterId", "OldSlaveZone", "NewSlaveZone" ] }, { "name": "ModifyClusterStorage", "description": "本接口（ModifyClusterStorage）用于调整包年包月存储容量。", "status": "online", "parameters": [ { "name": "ClusterId", "type": "string", "required": true, "description": "集群ID", "example": "cynosdbmysql-mwg7121e" }, { "name": "NewStorageLimit", "type": "integer", "required": true, "description": "集群新存储大小（单位G）", "example": "20" }, { "name": "OldStorageLimit", "type": "integer", "required": true, "description": "集群原存储大小（单位G）", "example": "10" }, { "name": "DealMode", "type": "integer", "required": false, "description": "交易模式 0-下单并支付 1-下单", "example": "0" } ], "required": [ "ClusterId", "NewStorageLimit", "OldStorageLimit" ] }, { "name": "ModifyDBInstanceSecurityGroups", "description": "本接口（ModifyDBInstanceSecurityGroups）用于修改实例绑定的安全组。", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "网络组id(cynosdbmysql-grp-前缀开头)或集群id（例如 cynosdbmysql-xxxxxxxx前缀）,当通过实例IP地址三元组（UniqVpcId、Vip、Vport）配置安全组时，该字段必须设置为集群ID（例如 cynosdbmysql-xxxxxxxx前缀）。", "example": "cynosdbmysql-grp-4senc2fm" }, { "name": "SecurityGroupIds", "type": "array", "required": true, "description": "要修改的安全组ID列表，一个或者多个安全组ID组成的数组。 注意：该入参会全量替换存量已有集合，非增量更新。修改需传入预期的全量集合。", "example": "[\"sg-ajr1jzgj\\n\"]", "item_type": "string" }, { "name": "Zone", "type": "string", "required": true, "description": "可用区", "example": "ap-guangzhou-3" }, { "name": "UniqVpcId", "type": "string", "required": false, "description": "实例所属VPC网络ID,（UniqVpcId、Vip 和 Vport 三个参数需同时指定，用于唯一标识网络实例）" }, { "name": "Vip", "type": "string", "required": false, "description": "实例IP地址,实例IP地址三元组UniqVpcId、Vip 和 Vport) 三个参数需同时指定，用于唯一标识网络实实例" }, { "name": "Vport", "type": "integer", "required": false, "description": "实例端口,实例IP地址三元组UniqVpcId、Vip 和 Vport) 三个参数需同时指定，用于唯一标识网络实实例" } ], "required": [ "InstanceId", "SecurityGroupIds", "Zone" ] }, { "name": "ModifyInstanceName", "description": "本接口(ModifyInstanceName)用于修改实例名称。", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "实例ID", "example": "cynosdb-ins-dokydbam" }, { "name": "InstanceName", "type": "string", "required": true, "description": "实例名称", "example": "newName" } ], "required": [ "InstanceId", "InstanceName" ] }, { "name": "ModifyInstanceParam", "description": "本接口（ModifyInstanceParam）用于修改实例参数。", "status": "online", "parameters": [ { "name": "ClusterId", "type": "string", "required": true, "description": "集群ID", "example": "cynosdbmysql-j8zw5111" }, { "name": "InstanceIds", "type": "array", "required": false, "description": "实例ID", "example": "cynosdbmysql-ins-1rfvx111", "item_type": "string" }, { "name": "ClusterParamList", "type": "array", "required": false, "description": "集群参数列表，例如 [{ \"CurrentValue\":\"2\", \"ParamName\":\"auto_increment_increment\"}]", "example": "[{\"CurrentValue\":\"2\",\"OldValue\":\"1\",\"ParamName\":\"auto_increment_increment\"}]", "item_type": "object", "children": [ { "name": "ParamName", "type": "string", "required": true, "description": "参数名", "example": "auto_increment_increment" }, { "name": "CurrentValue", "type": "string", "required": true, "description": "参数当前值", "example": "2" }, { "name": "OldValue", "type": "string", "required": false, "description": "参数旧值（只在出参时有用）", "example": "1" }, { "name": "Component", "type": "string", "required": false, "description": "libra组件类型", "example": "libracdc" } ] }, { "name": "InstanceParamList", "type": "array", "required": false, "description": "实例参数列表，例如[{ \"CurrentValue\":\"2\", \"ParamName\":\"innodb_stats_transient_sample_pages\"}]", "example": "[{\"CurrentValue\":\"2\",\"OldValue\":\"1\",\"ParamName\":\"auto_increment_increment\"}]", "item_type": "object", "children": [ { "name": "ParamName", "type": "string", "required": true, "description": "参数名", "example": "auto_increment_increment" }, { "name": "CurrentValue", "type": "string", "required": true, "description": "参数当前值", "example": "2" }, { "name": "OldValue", "type": "string", "required": false, "description": "参数旧值（只在出参时有用）", "example": "1" }, { "name": "Component", "type": "string", "required": false, "description": "libra组件类型", "example": "libracdc" } ] }, { "name": "IsInMaintainPeriod", "type": "string", "required": false, "description": "yes：在运维时间窗内修改，no：立即执行（默认值）", "example": "no" } ], "required": [ "ClusterId" ] }, { "name": "ModifyInstanceUpgradeLimitDays", "description": "本接口（ModifyInstanceUpgradeLimitDays）用于修改实例内核小版本的升级限制时间。", "status": "online", "parameters": [ { "name": "ClusterId", "type": "string", "required": true, "description": "集群ID", "example": "cynosdbmysql-mwg7212w" }, { "name": "InstanceId", "type": "string", "required": true, "description": "实例ID", "example": "cynosdbmysql-ins-m6f0hjkx" }, { "name": "UpgradeLimitDays", "type": "integer", "required": true, "description": "升级限制时间", "example": "30" } ], "required": [ "ClusterId", "InstanceId", "UpgradeLimitDays" ] }, { "name": "ModifyLibraDBClusterAccountDescription", "description": "本接口（ModifyLibraDBClusterAccountDescription）用于修改分析集群账号描述", "status": "online", "parameters": [ { "name": "ClusterId", "type": "string", "required": true, "description": "分析集群id", "example": "libradb-xxx" }, { "name": "AccountName", "type": "string", "required": true, "description": "账号名", "example": "Admin" }, { "name": "Description", "type": "string", "required": true, "description": "描述", "example": "管理员" }, { "name": "Host", "type": "string", "required": false, "description": "主机名", "example": "%" } ], "required": [ "ClusterId", "AccountName", "Description" ] }, { "name": "ModifyLibraDBClusterAccountHost", "description": "本接口（ModifyLibraDBClusterAccountHost）用于修改分析集群账号的可登录主机信息", "status": "online", "parameters": [ { "name": "ClusterId", "type": "string", "required": true, "description": "分析集群id", "example": "libradb-xxx" }, { "name": "Account", "type": "object", "required": true, "description": "账号信息", "example": "无", "children": [ { "name": "AccountName", "type": "string", "required": true, "description": "账号", "example": "andy" }, { "name": "Host", "type": "string", "required": false, "description": "主机，默认‘%’", "example": "%" } ] }, { "name": "NewHost", "type": "string", "required": true, "description": "主机名", "example": "%" } ], "required": [ "ClusterId", "Account", "NewHost" ] }, { "name": "ModifyLibraDBClusterAccountPrivilege", "description": "本接口（ModifyLibraDBClusterAccountPrivilege）用于修改分析集群账号权限", "status": "online", "parameters": [ { "name": "ClusterId", "type": "string", "required": true, "description": "集群id", "example": "libradb-xxx" }, { "name": "Account", "type": "object", "required": true, "description": "账号", "example": "无", "children": [ { "name": "AccountName", "type": "string", "required": true, "description": "账号", "example": "andy" }, { "name": "Host", "type": "string", "required": false, "description": "主机，默认‘%’", "example": "%" } ] }, { "name": "GlobalPrivileges", "type": "array", "required": false, "description": "全局权限", "example": "[\"SELECT\"]", "item_type": "string" }, { "name": "DatabasePrivileges", "type": "array", "required": false, "description": "数据库权限", "example": "无", "item_type": "object", "children": [ { "name": "Db", "type": "string", "required": true, "description": "数据库", "example": "db1" }, { "name": "Privileges", "type": "array", "required": true, "description": "权限列表", "example": "[\"DROP\",\"EXECUTE\"]", "item_type": "string" } ] }, { "name": "TablePrivileges", "type": "array", "required": false, "description": "表权限", "example": "无", "item_type": "object", "children": [ { "name": "Db", "type": "string", "required": true, "description": "数据库名", "example": "db1" }, { "name": "TableName", "type": "string", "required": true, "description": "表名", "example": "tb1" }, { "name": "Privileges", "type": "array", "required": true, "description": "权限列表", "example": "[\"CREATE\",\"ALTER\"]", "item_type": "string" } ] } ], "required": [ "ClusterId", "Account" ] }, { "name": "ModifyLibraDBClusterDataSource", "description": "本接口（ModifyLibraDBClusterDataSource）用于修改 TDSQL-C 分析集群数据源", "status": "online", "parameters": [ { "name": "ClusterId", "type": "string", "required": true, "description": "分析集群ID", "example": "libradb-1" }, { "name": "InstanceId", "type": "string", "required": true, "description": "只读分析引擎实例ID", "example": "libradb-ins-1" }, { "name": "SrcInfo", "type": "array", "required": false, "description": "源端信息", "example": "无", "item_type": "object", "children": [ { "name": "SrcInstanceType", "type": "string", "required": true, "description": "源端类型", "example": "cynos" }, { "name": "AccessType", "type": "string", "required": false, "description": "网络类型", "example": "local" }, { "name": "SrcInstanceId", "type": "string", "required": false, "description": "源端实例ID", "example": "cynosmysql-ins-1" }, { "name": "SrcClusterId", "type": "string", "required": false, "description": "源端集群ID", "example": "cynosmysql-xxx" }, { "name": "IP", "type": "string", "required": false, "description": "地址", "example": "127.0.0.1" }, { "name": "Port", "type": "string", "required": false, "description": "端口", "example": "3306" }, { "name": "User", "type": "string", "required": false, "description": "用户名", "example": "root" }, { "name": "Password", "type": "string", "required": false, "description": "密码", "example": "rootroot" }, { "name": "SqlMode", "type": "string", "required": false, "description": "源端sql_mode", "example": "no_rows" }, { "name": "SrcAppId", "type": "integer", "required": false, "description": "源端应用id", "example": "10008" }, { "name": "SrcUin", "type": "string", "required": false, "description": "源端账号", "example": "10007" }, { "name": "SrcSubAccountUin", "type": "string", "required": false, "description": "源端子账号", "example": "10006" }, { "name": "AccountMode", "type": "string", "required": false, "description": "账号", "example": "other" }, { "name": "Region", "type": "string", "required": false, "description": "源端实例地域", "example": "ap-guangzhou" }, { "name": "Operation", "type": "string", "required": false, "description": "对源端实例的操作", "example": "add" } ] } ], "required": [ "ClusterId", "InstanceId" ] }, { "name": "ModifyLibraDBClusterName", "description": "修改分析集群名称", "status": "online", "parameters": [ { "name": "ClusterId", "type": "string", "required": true, "description": "分析集群 ID", "example": "libradb-xxx" }, { "name": "ClusterName", "type": "string", "required": true, "description": "集群名称", "example": "testcluster" } ], "required": [ "ClusterId", "ClusterName" ] }, { "name": "ModifyLibraDBClusterProject", "description": "修改分析集群项目 ID", "status": "online", "parameters": [ { "name": "ClusterIdSet", "type": "array", "required": false, "description": "分析集群 ID 列表", "example": "[\"libradb-xxx\"]", "item_type": "string" }, { "name": "ProjectId", "type": "integer", "required": false, "description": "项目 ID", "example": "0" } ], "required": [] }, { "name": "ModifyLibraDBClusterReplicationObject", "description": "本接口（ModifyLibraDBClusterReplicationObject）用于修改分析集群同步对象", "status": "online", "parameters": [ { "name": "ClusterId", "type": "string", "required": true, "description": "分析集群ID", "example": "libradb-cluster-1" }, { "name": "InstanceId", "type": "string", "required": true, "description": "只读分析引擎实例 ID", "example": "libradb-ins-1" }, { "name": "ForceDefaultMapRule", "type": "string", "required": false, "description": "映射模式", "example": "NoRule,DefaultRule,CustomRule" }, { "name": "Objects", "type": "array", "required": false, "description": "同步对象", "example": "无", "item_type": "object", "children": [ { "name": "SrcInstanceType", "type": "string", "required": true, "description": "源端实例类型 注意：此字段可能返回 null，表示取不到有效值。", "example": "cynos" }, { "name": "SrcClusterId", "type": "string", "required": false, "description": "源端集群Id 注意：此字段可能返回 null，表示取不到有效值。", "example": "cynosmysql-123" }, { "name": "SrcInstanceId", "type": "string", "required": false, "description": "源端实例ID 注意：此字段可能返回 null，表示取不到有效值。", "example": "cynosmysql-ins-123" }, { "name": "ReplicationJobId", "type": "string", "required": false, "description": "复制任务ID 注意：此字段可能返回 null，表示取不到有效值。", "example": "cdc-1234" }, { "name": "MigrateObjects", "type": "object", "required": false, "description": "同步对象详情 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "children": [ { "name": "DatabaseTables", "type": "object", "required": false, "description": "包含数据库表信息", "example": "无", "children": [ { "name": "MigrateDBMode", "type": "string", "required": false, "description": "数据库迁移模式 注意：此字段可能返回 null，表示取不到有效值。", "example": "无" }, { "name": "Databases", "type": "array", "required": false, "description": "数据库信息 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "item_type": "string" } ] } ] } ] }, { "name": "AutoMapRules", "type": "array", "required": false, "description": "自动映射规则", "example": "无", "item_type": "object", "children": [ { "name": "SrcInstanceId", "type": "string", "required": true, "description": "源端实例Id", "example": "libradb-ins-xxx" }, { "name": "SrcDatabaseRegex", "type": "string", "required": true, "description": "源端数据库正则", "example": "database1" }, { "name": "SrcTableRegex", "type": "string", "required": true, "description": "源端表正则", "example": "table1" }, { "name": "DstDatabaseRegex", "type": "string", "required": true, "description": "目标端数据库正则", "example": "DB1" }, { "name": "DstTableRegex", "type": "string", "required": true, "description": "目标端表正则", "example": "table1" } ] }, { "name": "RefreshMapping", "type": "boolean", "required": false, "description": "是否按照最新映射规则刷新存量映射关系", "example": "false" } ], "required": [ "ClusterId", "InstanceId" ] }, { "name": "ModifyLibraDBForwardConfig", "description": "本接口（ModifyLibraDBForwardConfig）用于修改只读分析实例自动转发参数", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "只读分析引擎实例Id", "example": "libradb-ins-1v4okeuw" }, { "name": "ForwardMode", "type": "string", "required": false, "description": "转发模式", "example": "AUTO;NONE" }, { "name": "ForwardList", "type": "array", "required": false, "description": "转发实例列表", "example": "无", "item_type": "object", "children": [ { "name": "InstanceId", "type": "string", "required": false, "description": "转发实例id 注意：此字段可能返回 null，表示取不到有效值。", "example": "cynosdbmysql-hlu0mqfh" }, { "name": "Region", "type": "string", "required": false, "description": "转发实例地域 注意：此字段可能返回 null，表示取不到有效值。", "example": "ap-guangzhou" } ] } ], "required": [ "InstanceId" ] }, { "name": "ModifyMaintainPeriodConfig", "description": "本接口（ModifyMaintainPeriodConfig）用于修改维护时间配置。", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "实例ID", "example": "cynosdbmysql-ins-n7ocdslw" }, { "name": "MaintainStartTime", "type": "integer", "required": true, "description": "维护开始时间，单位为秒，如3:00为10800", "example": "3600" }, { "name": "MaintainDuration", "type": "integer", "required": true, "description": "维护持续时间，单位为秒，如1小时为3600", "example": "3600" }, { "name": "MaintainWeekDays", "type": "array", "required": true, "description": "每周维护日期，日期取值范围[Mon, Tue, Wed, Thu, Fri, Sat, Sun]", "example": "[Mon]", "item_type": "string" } ], "required": [ "InstanceId", "MaintainStartTime", "MaintainDuration", "MaintainWeekDays" ] }, { "name": "ModifyParamTemplate", "description": "本接口（ModifyParamTemplate）用于修改用户参数模板。", "status": "online", "parameters": [ { "name": "TemplateId", "type": "integer", "required": true, "description": "模板ID", "example": "15412" }, { "name": "TemplateName", "type": "string", "required": false, "description": "模板名", "example": "andy5.7" }, { "name": "TemplateDescription", "type": "string", "required": false, "description": "模板描述", "example": "andyuse" }, { "name": "ParamList", "type": "array", "required": false, "description": "参数列表", "example": "[{\"CurrentValue\":\"2\",\"OldValue\":\"1\",\"ParamName\":\"auto_increment_increment\"}]", "item_type": "object", "children": [ { "name": "ParamName", "type": "string", "required": true, "description": "参数名", "example": "auto_increment_increment" }, { "name": "CurrentValue", "type": "string", "required": true, "description": "参数当前值", "example": "2" }, { "name": "OldValue", "type": "string", "required": false, "description": "参数旧值（只在出参时有用）", "example": "1" }, { "name": "Component", "type": "string", "required": false, "description": "libra组件类型", "example": "libracdc" } ] } ], "required": [ "TemplateId" ] }, { "name": "ModifyProxyDesc", "description": "本接口（ModifyProxyDesc）用于修改数据库代理描述。", "status": "online", "parameters": [ { "name": "ClusterId", "type": "string", "required": true, "description": "集群ID", "example": "cynosdbmysql-qwerasd" }, { "name": "ProxyGroupId", "type": "string", "required": true, "description": "数据库代理组ID", "example": "cynosdbmysql-proxy-5mwohl11" }, { "name": "Description", "type": "string", "required": true, "description": "数据库代理描述", "example": "andy_proxy" } ], "required": [ "ClusterId", "ProxyGroupId", "Description" ] }, { "name": "ModifyProxyRwSplit", "description": "本接口（ModifyProxyRwSplit）用于配置数据库代理读写分离。", "status": "online", "parameters": [ { "name": "ClusterId", "type": "string", "required": true, "description": "集群ID，例如cynosdbmysql-asd123", "example": "cynosdbmysql-j8zw5111" }, { "name": "ProxyGroupId", "type": "string", "required": true, "description": "数据库代理组ID，例如cynosdbmysql-proxy-qwe123", "example": "cynosdbmysql-proxy-5mwoh111" }, { "name": "ConsistencyType", "type": "string", "required": false, "description": "一致性类型；“eventual\"-最终一致性, \"session\"-会话一致性, \"global\"-全局一致性", "example": "session" }, { "name": "ConsistencyTimeOut", "type": "string", "required": false, "description": "一致性超时时间。 取值范围：0~1000000（微秒）,设置0则表示若只读实例出现延迟, 导致一致性策略不满足, 请求将一直等待。", "example": "100" }, { "name": "WeightMode", "type": "string", "required": false, "description": "读写权重分配模式；系统自动分配：\"system\"， 自定义：\"custom\"", "example": "custom" }, { "name": "InstanceWeights", "type": "array", "required": false, "description": "实例只读权重。", "example": "无", "item_type": "object", "children": [ { "name": "InstanceId", "type": "string", "required": true, "description": "实例Id", "example": "cynosdbmysql-ins-hs6bgfi7" }, { "name": "Weight", "type": "integer", "required": true, "description": "实例权重", "example": "10" } ] }, { "name": "FailOver", "type": "string", "required": false, "description": "是否开启故障转移，代理出现故障后，连接地址将路由到主实例，取值：\"yes\" , \"no\"", "example": "yes" }, { "name": "AutoAddRo", "type": "string", "required": false, "description": "是否自动添加只读实例，取值：\"yes\" , \"no\"", "example": "yes" }, { "name": "OpenRw", "type": "string", "required": false, "description": "是否打开读写分离。 该参数已废弃，请通过RwType设置读写属性。", "example": "no" }, { "name": "RwType", "type": "string", "required": false, "description": "读写类型： READWRITE,READONLY", "example": "READONLY" }, { "name": "TransSplit", "type": "boolean", "required": false, "description": "事务拆分。 在一个事务中拆分读和写到不同的实例上去执行。", "example": "true" }, { "name": "AccessMode", "type": "string", "required": false, "description": "连接模式： nearby,balance", "example": "nearby" }, { "name": "OpenConnectionPool", "type": "string", "required": false, "description": "是否打开连接池： yes,no", "example": "yes" }, { "name": "ConnectionPoolType", "type": "string", "required": false, "description": "连接池类型： SessionConnectionPool", "example": "SessionConnectionPool" }, { "name": "ConnectionPoolTimeOut", "type": "integer", "required": false, "description": "连接池时间。 可选范围:0~300（秒）", "example": "100" }, { "name": "ApNodeAsRoNode", "type": "boolean", "required": false, "description": "是否将libra节点当作普通RO节点", "example": "false" }, { "name": "ApQueryToOtherNode", "type": "boolean", "required": false, "description": "libra节点故障，是否转发给其他节点", "example": "false" } ], "required": [ "ClusterId", "ProxyGroupId" ] }, { "name": "ModifyResourcePackageClusters", "description": "本接口（ModifyResourcePackageClusters）用于修改资源包与集群之间的绑定关系。", "status": "online", "parameters": [ { "name": "PackageId", "type": "string", "required": true, "description": "资源包唯一ID", "example": "pkg-test" }, { "name": "BindClusterIds", "type": "array", "required": false, "description": "需要建立绑定关系的集群ID", "example": "[cynosdb-qwerty]", "item_type": "string" }, { "name": "UnbindClusterIds", "type": "array", "required": false, "description": "需要解除绑定关系的集群ID", "example": "[cynosdb-123456]", "item_type": "string" } ], "required": [ "PackageId" ] }, { "name": "ModifyResourcePackageName", "description": "本接口（ModifyResourcePackageName）用于修改资源包名称。", "status": "online", "parameters": [ { "name": "PackageId", "type": "string", "required": true, "description": "资源包唯一ID", "example": "pkg-test" }, { "name": "PackageName", "type": "string", "required": true, "description": "自定义的资源包名称，最长支持120个字符", "example": "资源包_1" } ], "required": [ "PackageId", "PackageName" ] }, { "name": "ModifyResourcePackagesDeductionPriority", "description": "修改已绑定资源包抵扣优先级", "status": "online", "parameters": [ { "name": "PackageType", "type": "string", "required": true, "description": "需要修改优先级的资源包类型，CCU：计算资源包，DISK：存储资源包", "example": "CCU" }, { "name": "ClusterId", "type": "string", "required": true, "description": "修改后的抵扣优先级对于哪个cynos资源生效", "example": "cynosdbmysql-abcd1234" }, { "name": "DeductionPriorities", "type": "array", "required": true, "description": "资源包抵扣优先级", "example": "无", "item_type": "object", "children": [ { "name": "PackageId", "type": "string", "required": false, "description": "需要自定义抵扣优先级的资源包", "example": "package-abcd1234" }, { "name": "DeductionPriority", "type": "integer", "required": false, "description": "自定义的抵扣优先级", "example": "1" } ] } ], "required": [ "PackageType", "ClusterId", "DeductionPriorities" ] }, { "name": "ModifyServerlessStrategy", "description": "修改serverless策略", "status": "online", "parameters": [ { "name": "ClusterId", "type": "string", "required": true, "description": "serverless集群id", "example": "cynosdbmysql-8vcxoq75" }, { "name": "AutoPause", "type": "string", "required": false, "description": "集群是否自动暂停，可选范围 yes no", "example": "no" }, { "name": "AutoPauseDelay", "type": "integer", "required": false, "description": "集群自动暂停的延迟，单位秒，可选范围[600,691200]，默认600", "example": "100" }, { "name": "AutoScaleUpDelay", "type": "integer", "required": false, "description": "该参数暂时无效", "example": "200" }, { "name": "AutoScaleDownDelay", "type": "integer", "required": false, "description": "该参数暂时无效", "example": "300" }, { "name": "MinCpu", "type": "float", "required": false, "description": "cpu最小值，可选范围参考DescribeServerlessInstanceSpecs接口返回", "example": "0.25" }, { "name": "MaxCpu", "type": "float", "required": false, "description": "cpu最大值，可选范围参考DescribeServerlessInstanceSpecs接口返回", "example": "2.0" }, { "name": "MinRoCpu", "type": "float", "required": false, "description": "只读实例cpu最小值，可选范围参考DescribeServerlessInstanceSpecs接口返回", "example": "0.25" }, { "name": "MaxRoCpu", "type": "float", "required": false, "description": "只读cpu最大值，可选范围参考DescribeServerlessInstanceSpecs接口返回", "example": "2.0" }, { "name": "MinRoCount", "type": "integer", "required": false, "description": "只读节点最小个数", "example": "3" }, { "name": "MaxRoCount", "type": "integer", "required": false, "description": "只读节点最大个数", "example": "3" }, { "name": "AutoArchive", "type": "string", "required": false, "description": "是否开启归档，可选范围yesno默认值:yes", "example": "yes" }, { "name": "UpgradeType", "type": "string", "required": false, "description": "升级类型。 默认值：upgradeImmediate。 可选值： upgradeImmediate：立即完成修改 upgradeInMaintain：在维护时间窗口内完成修改", "example": "upgradeImmediate" }, { "name": "SecurityGroupIdsForNewRo", "type": "array", "required": false, "description": "新增的只读实例需要绑定的安全组列表。仅仅针对于在这次调整策略过程中新产生的只读实例绑定安全组，存量的实例不绑定。", "example": "[\"sg-gsbdgrts\"]", "item_type": "string" } ], "required": [ "ClusterId" ] }, { "name": "ModifySnapBackupCrossRegionConfig", "description": "本接口（ModifySnapBackupCrossRegionConfig）用于修改指定集群的快照备份跨地域配置。", "status": "online", "parameters": [ { "name": "ClusterId", "type": "string", "required": true, "description": "集群ID", "example": "cynosdbmysql-45knmnra" }, { "name": "CrossRegionsEnable", "type": "string", "required": false, "description": "是否开启跨地域快照备份ON/OFF", "example": "ON" }, { "name": "CrossRegions", "type": "array", "required": false, "description": "快照备份所跨地域", "example": "[\"ap-guangzhou\"]", "item_type": "string" } ], "required": [ "ClusterId" ] }, { "name": "ModifyVipVport", "description": "本接口（ModifyVipVport）用于修改实例组ip，端口。", "status": "online", "parameters": [ { "name": "ClusterId", "type": "string", "required": true, "description": "集群id", "example": "cynosdbmysql-mwg7121e" }, { "name": "InstanceGroupId", "type": "string", "required": false, "description": "实例组id", "example": "cynosdbmysql-grp-as124sa5" }, { "name": "Vip", "type": "string", "required": false, "description": "需要修改的目的ip", "example": "172.1.1.1" }, { "name": "Vport", "type": "integer", "required": false, "description": "需要修改的目的端口", "example": "5432" }, { "name": "DbType", "type": "string", "required": false, "description": "数据库类型，取值范围: MYSQL", "example": "MYSQL" }, { "name": "OldIpReserveHours", "type": "integer", "required": false, "description": "旧ip回收前的保留时间，单位小时，0表示立即回收", "example": "0" } ], "required": [ "ClusterId" ] }, { "name": "OfflineCluster", "description": "本接口（OfflineCluster）用于销毁集群。", "status": "online", "parameters": [ { "name": "ClusterId", "type": "string", "required": true, "description": "集群ID", "example": "cynosdbmysql-bzxxrmtq" } ], "required": [ "ClusterId" ] }, { "name": "OfflineInstance", "description": "本接口（OfflineInstance）用于销毁实例。", "status": "online", "parameters": [ { "name": "ClusterId", "type": "string", "required": true, "description": "集群ID", "example": "cynosdbmysql-bzxxrmtq" }, { "name": "InstanceIdList", "type": "array", "required": true, "description": "实例ID数组", "example": "[\"cynosdbmysql-ins-7upukfpw\\n\"]", "item_type": "string" } ], "required": [ "ClusterId", "InstanceIdList" ] }, { "name": "OfflineLibraDBCluster", "description": "下线分析集群", "status": "online", "parameters": [ { "name": "ClusterId", "type": "string", "required": true, "description": "分析集群 ID", "example": "libradb-xxx" } ], "required": [ "ClusterId" ] }, { "name": "OfflineLibraDBInstance", "description": "本接口(OfflineLibraDBInstance)用于下线的只读分析引擎实例。", "status": "online", "parameters": [ { "name": "ClusterId", "type": "string", "required": true, "description": "集群ID", "example": "cynosdbmysql-bzxxrmtq" }, { "name": "InstanceIdList", "type": "array", "required": true, "description": "只读分析引擎实例 ID 列表", "example": "[\"cynosdbmysql-libradb-ins-mhrc48ym\"]", "item_type": "string" } ], "required": [ "ClusterId", "InstanceIdList" ] }, { "name": "OpenAuditService", "description": "本接口（OpenAuditService）用于为实例开通数据库审计服务。", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "实例ID。", "example": "cynosdbmysql-ins-6990cckk" }, { "name": "LogExpireDay", "type": "integer", "required": true, "description": "日志保留时长。", "example": "30" }, { "name": "HighLogExpireDay", "type": "integer", "required": false, "description": "高频日志保留时长。", "example": "7" }, { "name": "RuleTemplateIds", "type": "array", "required": false, "description": "规则模板ID。同AuditRuleFilters都不填是全审计。", "example": "[\"cynosdb-art-l1mlbo59\"]", "item_type": "string" }, { "name": "AuditAll", "type": "boolean", "required": false, "description": "审计类型。true-全审计；默认false-规则审计。", "example": "true" } ], "required": [ "InstanceId", "LogExpireDay" ] }, { "name": "OpenClusterPasswordComplexity", "description": "本接口（OpenClusterPasswordComplexity）用于开启自定义密码复杂度功能。", "status": "online", "parameters": [ { "name": "ClusterId", "type": "string", "required": true, "description": "集群id", "example": "cynosdbpg-bzxxrmtq" }, { "name": "ValidatePasswordLength", "type": "integer", "required": true, "description": "密码长度", "example": "8" }, { "name": "ValidatePasswordMixedCaseCount", "type": "integer", "required": true, "description": "大小写字符个数", "example": "1" }, { "name": "ValidatePasswordSpecialCharCount", "type": "integer", "required": true, "description": "特殊字符个数", "example": "1" }, { "name": "ValidatePasswordNumberCount", "type": "integer", "required": true, "description": "数字个数", "example": "1" }, { "name": "ValidatePasswordPolicy", "type": "string", "required": true, "description": "密码强度（\"MEDIUM\", \"STRONG\"）", "example": "MEDIUM" }, { "name": "ValidatePasswordDictionary", "type": "array", "required": false, "description": "数据字典", "example": "[\"admin\"]", "item_type": "string" } ], "required": [ "ClusterId", "ValidatePasswordLength", "ValidatePasswordMixedCaseCount", "ValidatePasswordSpecialCharCount", "ValidatePasswordNumberCount", "ValidatePasswordPolicy" ] }, { "name": "OpenClusterReadOnlyInstanceGroupAccess", "description": "本接口（OpenClusterReadOnlyInstanceGroupAccess）用于开启只读实例组接入。", "status": "online", "parameters": [ { "name": "ClusterId", "type": "string", "required": true, "description": "集群ID", "example": "cynosdbmysql-12345678" }, { "name": "Port", "type": "string", "required": true, "description": "端口", "example": "3306" }, { "name": "SecurityGroupIds", "type": "array", "required": false, "description": "安全组ID", "example": " [\"sg-nm4bjh11\",\"sg-nm4bjh22\"]", "item_type": "string" } ], "required": [ "ClusterId", "Port" ] }, { "name": "OpenClusterTransparentEncrypt", "description": "开通集群透明加密", "status": "online", "parameters": [ { "name": "ClusterId", "type": "string", "required": true, "description": "集群id", "example": "cynosdbmysql-6oo0qjvo" }, { "name": "KeyType", "type": "string", "required": true, "description": "秘钥类型(cloud,custom)", "example": "cloud" }, { "name": "KeyId", "type": "string", "required": false, "description": "秘钥Id", "example": "9d112608-76f7-11ee-a86f-525400368ae8" }, { "name": "KeyRegion", "type": "string", "required": false, "description": "秘钥地域", "example": "ap-guangzhou" }, { "name": "IsOpenGlobalEncryption", "type": "boolean", "required": false, "description": "是否开启全局加密", "example": "true" } ], "required": [ "ClusterId", "KeyType" ] }, { "name": "OpenReadOnlyInstanceExclusiveAccess", "description": "本接口（OpenReadOnlyInstanceExclusiveAccess）用于开通只读实例独有访问接入组。", "status": "online", "parameters": [ { "name": "ClusterId", "type": "string", "required": true, "description": "请使用 [集群信息描述](https://cloud.tencent.com/document/api/1003/48086) 获取 clusterId。", "example": "cynosdbmysql-bdcl1n11" }, { "name": "InstanceId", "type": "string", "required": true, "description": "请使用 [集群信息描述](https://cloud.tencent.com/document/api/1003/48086) 获取 instanceId。", "example": "cynosdbmysql-ins-foddsm11" }, { "name": "VpcId", "type": "string", "required": true, "description": "指定的 vpc ID，请使用 [查询私有网络列表](https://cloud.tencent.com/document/api/215/15778) 获取 vpc ID。", "example": "vpc-74h05211" }, { "name": "SubnetId", "type": "string", "required": true, "description": "指定的子网 ID，如果设置了 vpc ID，则 SubnetId 必填，请使用 [查询子网列表](https://cloud.tencent.com/document/api/215/15784) 获取 SubnetId。", "example": "subnet-d16fxg11" }, { "name": "Port", "type": "integer", "required": true, "description": "用户自定义的端口。", "example": "3306" }, { "name": "SecurityGroupIds", "type": "array", "required": false, "description": "安全组 ID，请使用 [查看安全组](https://cloud.tencent.com/document/api/215/15808) 获取 SecurityGroupId。", "example": "[\"sg-nm4bjh11\",\"sg-nm4bjh22\"]", "item_type": "string" } ], "required": [ "ClusterId", "InstanceId", "VpcId", "SubnetId", "Port" ] }, { "name": "OpenSSL", "description": "开启SSL加密", "status": "online", "parameters": [ { "name": "ClusterId", "type": "string", "required": true, "description": "集群ID", "example": "cynosdbmysql-bzxxrmtq" }, { "name": "InstanceId", "type": "string", "required": false, "description": "实例ID", "example": "cynosdbmysql-ins-bzxxrmtq" } ], "required": [ "ClusterId" ] }, { "name": "OpenWan", "description": "本接口（OpenWan）用于开通外网。", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": false, "description": "实例ID", "example": "cynosdbmysql-ins-ifq10f11" }, { "name": "InstanceGroupId", "type": "string", "required": false, "description": "实例组id", "example": "cynosdbmysql-grp-o48ssqs5" } ], "required": [] }, { "name": "PauseServerless", "description": "本接口（PauseServerless）用于暂停 serverless 集群。", "status": "online", "parameters": [ { "name": "ClusterId", "type": "string", "required": true, "description": "集群ID", "example": "cynosdbmysql-8vcxoq75" }, { "name": "ForcePause", "type": "integer", "required": false, "description": "是否强制暂停，忽略当前的用户链接 0:不强制 1:强制， 默认为1", "example": "1" } ], "required": [ "ClusterId" ] }, { "name": "RefundResourcePackage", "description": "本接口（RefundResourcePackage）用于资源包退款。", "status": "online", "parameters": [ { "name": "PackageId", "type": "string", "required": true, "description": "资源包唯一ID", "example": "pkg-qwerty" } ], "required": [ "PackageId" ] }, { "name": "ReloadBalanceProxyNode", "description": "本接口（ReloadBalanceProxyNode）用于负载均衡数据库代理。", "status": "online", "parameters": [ { "name": "ClusterId", "type": "string", "required": true, "description": "集群ID", "example": "cynosdbmysql-qwerasdf" }, { "name": "ProxyGroupId", "type": "string", "required": true, "description": "数据库代理组ID", "example": "cynosdbmysql-proxy-lti34611" } ], "required": [ "ClusterId", "ProxyGroupId" ] }, { "name": "RemoveClusterSlaveZone", "description": "本接口（RemoveClusterSlaveZone）用于关闭集群多可用区部署。", "status": "online", "parameters": [ { "name": "ClusterId", "type": "string", "required": true, "description": "集群ID", "example": "cynosdbmysql-bdcl1n11" }, { "name": "SlaveZone", "type": "string", "required": true, "description": "从可用区", "example": "ap-guangzhou-4" } ], "required": [ "ClusterId", "SlaveZone" ] }, { "name": "RenewClusters", "description": "续费集群", "status": "online", "parameters": [ { "name": "ClusterId", "type": "string", "required": true, "description": "集群ID", "example": "cynosdbpg-bzxxrmtq" }, { "name": "TimeSpan", "type": "float", "required": true, "description": "续费时长", "example": "1" }, { "name": "TimeUnit", "type": "string", "required": true, "description": "时间单位 y,m,d,h,i,s", "example": "m" }, { "name": "DealMode", "type": "integer", "required": false, "description": "交易模式 0-下单并支付 1-下单", "example": "0" } ], "required": [ "ClusterId", "TimeSpan", "TimeUnit" ] }, { "name": "RenewLibraDBClusters", "description": "续费分析集群", "status": "online", "parameters": [ { "name": "TimeSpan", "type": "integer", "required": true, "description": "时间间隔", "example": "60" }, { "name": "TimeUnit", "type": "string", "required": true, "description": "时间单位", "example": "s" }, { "name": "ClusterId", "type": "string", "required": true, "description": "分析集群 ID", "example": "libradb-xxx" }, { "name": "DealMode", "type": "integer", "required": false, "description": "订单模式", "example": "0" } ], "required": [ "TimeSpan", "TimeUnit", "ClusterId" ] }, { "name": "ReplayInstanceAuditLog", "description": "回放实例审计日志", "status": "online", "parameters": [ { "name": "SourceClusterId", "type": "string", "required": true, "description": "源集群id", "example": "cynosdbmysql-8j1jtwkv" }, { "name": "SourceInstanceId", "type": "string", "required": true, "description": "源实例id", "example": "cynosdbmysql-ins-2fbftt98" }, { "name": "TargetClusterId", "type": "string", "required": true, "description": "目标集群id 目标集群必须为原始集群三天内克隆出的集群。", "example": "cynosdbmysql-kwoft68f" }, { "name": "TargetInstanceId", "type": "string", "required": true, "description": "目标实例id", "example": "cynosdbmysql-ins-431w3zh0" }, { "name": "TargetUserName", "type": "string", "required": true, "description": "用户名.需要host为%的用户名", "example": "root" }, { "name": "TargetPassword", "type": "string", "required": true, "description": "密码", "example": "aws@123" }, { "name": "StartTime", "type": "string", "required": true, "description": "开始时间。时间格式为：yyyy-DD-mm hh:mm:ss", "example": "2025-06-26 14:00:00" }, { "name": "EndTime", "type": "string", "required": true, "description": "结束时间。时间格式为：yyyy-DD-mm hh:mm:ss", "example": "2025-06-26 14:20:00" } ], "required": [ "SourceClusterId", "SourceInstanceId", "TargetClusterId", "TargetInstanceId", "TargetUserName", "TargetPassword", "StartTime", "EndTime" ] }, { "name": "ResetAccountPassword", "description": "本接口（ResetAccountPassword）用于修改数据库账号密码。", "status": "online", "parameters": [ { "name": "AccountName", "type": "string", "required": true, "description": "数据库账号名", "example": "root" }, { "name": "AccountPassword", "type": "string", "required": true, "description": "数据库账号新密码", "example": "abc@2018" }, { "name": "ClusterId", "type": "string", "required": true, "description": "集群ID", "example": "cynosdbpg-on5xw0ni" }, { "name": "Host", "type": "string", "required": false, "description": "主机，不填默认为\"%\"", "example": "%" } ], "required": [ "AccountName", "AccountPassword", "ClusterId" ] }, { "name": "ResetLibraDBClusterAccountPassword", "description": "修改分析集群账号密码", "status": "online", "parameters": [ { "name": "ClusterId", "type": "string", "required": true, "description": "分析集群 ID", "example": "libradb-xxx" }, { "name": "AccountPassword", "type": "string", "required": true, "description": "密码", "example": "“fasdd33fd”" }, { "name": "AccountName", "type": "string", "required": true, "description": "账号", "example": "root" }, { "name": "EncryptMethod", "type": "string", "required": false, "description": "加密方式", "example": "hash" }, { "name": "Host", "type": "string", "required": false, "description": "主机", "example": "127.0.0.1" } ], "required": [ "ClusterId", "AccountPassword", "AccountName" ] }, { "name": "RestartInstance", "description": "本接口（RestartInstance）用于重启实例。", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "实例id", "example": "cynosdbmysql-ins-a45df3g" } ], "required": [ "InstanceId" ] }, { "name": "RestartLibraDBInstance", "description": "重启只读分析引擎", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "只读分析引擎实例 ID", "example": "cynosdbmysql-libradb-ins-mhrc48ym" } ], "required": [ "InstanceId" ] }, { "name": "ResumeServerless", "description": "本接口（ResumeServerless）用于恢复 serverless 集群（启动暂停的集群）。", "status": "online", "parameters": [ { "name": "ClusterId", "type": "string", "required": true, "description": "集群ID", "example": "cynosdbmysql-xxxx" } ], "required": [ "ClusterId" ] }, { "name": "RevokeAccountPrivileges", "description": "本接口（RevokeAccountPrivileges）用于批量回收账号权限。", "status": "online", "parameters": [ { "name": "ClusterId", "type": "string", "required": true, "description": "集群id", "example": "cynosdbmysql-asd123qw" }, { "name": "Account", "type": "object", "required": true, "description": "账号信息", "example": "{\"AccountName\": \"andy\",\"Host\": \"%\"}", "children": [ { "name": "AccountName", "type": "string", "required": true, "description": "账号", "example": "andy" }, { "name": "Host", "type": "string", "required": false, "description": "主机，默认‘%’", "example": "%" } ] }, { "name": "DbTablePrivileges", "type": "array", "required": true, "description": "数据库表权限数组", "example": "[\"ALTER\", \"CREATE\", \"CREATE VIEW\", \"DELETE\", \"DROP\", \"GRANT OPTION\", \"INDEX\", \"INSERT\", \"REFERENCES\", \"SELECT\", \"SHOW VIEW\", \"TRIGGER\", \"UPDATE\"]", "item_type": "string" }, { "name": "DbTables", "type": "array", "required": true, "description": "数据库表信息", "example": "[{\"Db\": \"db1\",\"TableName\": \"tb1\"}]", "item_type": "object", "children": [ { "name": "Db", "type": "string", "required": true, "description": "数据库名称", "example": "db-xx" }, { "name": "TableName", "type": "string", "required": false, "description": "数据库表名称", "example": "table-xx" } ] } ], "required": [ "ClusterId", "Account", "DbTablePrivileges", "DbTables" ] }, { "name": "RollBackCluster", "description": "本接口（RollBackCluster）用于集群回档。", "status": "online", "parameters": [ { "name": "ClusterId", "type": "string", "required": true, "description": "集群ID", "example": "cynosdbpg-bzxxrmtq" }, { "name": "RollbackStrategy", "type": "string", "required": true, "description": "回档策略 timeRollback-按时间点回档 snapRollback-按备份文件回档", "example": "snapRollback" }, { "name": "RollbackId", "type": "integer", "required": true, "description": "备份文件ID。 回档策略为按备份文件回档时必填。", "example": "1" }, { "name": "ExpectTime", "type": "string", "required": false, "description": "期望回档时间。 回档策略为timeRollback按时间点回档时必填。", "example": "2022-01-20 00:00:00" }, { "name": "ExpectTimeThresh", "type": "integer", "required": false, "description": "期望阈值（已废弃）", "example": "1" }, { "name": "RollbackDatabases", "type": "array", "required": false, "description": "回档数据库列表", "example": "无", "item_type": "object", "children": [ { "name": "OldDatabase", "type": "string", "required": true, "description": "旧数据库名称", "example": "db1" }, { "name": "NewDatabase", "type": "string", "required": true, "description": "新数据库名称", "example": "db2" } ] }, { "name": "RollbackTables", "type": "array", "required": false, "description": "回档数据库表列表", "example": "无", "item_type": "object", "children": [ { "name": "Database", "type": "string", "required": true, "description": "数据库名称", "example": "db1" }, { "name": "Tables", "type": "array", "required": true, "description": "数据库表", "example": "[\"OldTable\": \"tb1\", \"NewTable\": \"tb2\"]", "item_type": "object", "children": [ { "name": "OldTable", "type": "string", "required": true, "description": "旧表名称", "example": "tb1" }, { "name": "NewTable", "type": "string", "required": true, "description": "新表名称", "example": "tb2" } ] } ] }, { "name": "RollbackMode", "type": "string", "required": false, "description": "按时间点回档模式，full: 普通; db: 快速; table: 极速 （默认是普通）", "example": "full" } ], "required": [ "ClusterId", "RollbackStrategy", "RollbackId" ] }, { "name": "RollbackToNewCluster", "description": "本接口（RollbackToNewCluster）用于回档到新集群。", "status": "online", "parameters": [ { "name": "Zone", "type": "string", "required": true, "description": "可用区", "example": "ap-guangzhou-3" }, { "name": "OriginalClusterId", "type": "string", "required": true, "description": "回档时，传入源集群ID，用于查找源poolId", "example": "cynosdbmysql-gs629njx" }, { "name": "UniqVpcId", "type": "string", "required": false, "description": "所属VPC网络ID", "example": "vpc-1ptuei0b" }, { "name": "UniqSubnetId", "type": "string", "required": false, "description": "所属子网ID", "example": "subnet-1tmw9t4o" }, { "name": "ClusterName", "type": "string", "required": false, "description": "集群名称，长度小于64个字符，每个字符取值范围：大/小写字母，数字，特殊符号（'-','_','.'）", "example": "MyClusterName" }, { "name": "RollbackId", "type": "integer", "required": false, "description": "快照回档，表示snapshotId；时间点回档，表示queryId，为0，表示需要判断时间点是否有效", "example": "0" }, { "name": "ExpectTime", "type": "string", "required": false, "description": "时间点回档，指定时间；快照回档，快照时间", "example": "2021-04-26 18:13:10" }, { "name": "AutoVoucher", "type": "integer", "required": false, "description": "是否自动选择代金券 1是 0否 默认为0", "example": "0" }, { "name": "ResourceTags", "type": "array", "required": false, "description": "集群创建需要绑定的tag数组信息", "example": "无", "item_type": "object", "children": [ { "name": "TagKey", "type": "string", "required": true, "description": "标签键", "example": "name" }, { "name": "TagValue", "type": "string", "required": true, "description": "标签值", "example": "zhang" } ] }, { "name": "DbMode", "type": "string", "required": false, "description": "Db类型 当DbType为MYSQL时可选(默认NORMAL)： NORMAL SERVERLESS", "example": "NORMAL" }, { "name": "MinCpu", "type": "float", "required": false, "description": "当DbMode为SEVERLESS时必填 cpu最小值，可选范围参考DescribeServerlessInstanceSpecs接口返回", "example": "1.0" }, { "name": "MaxCpu", "type": "float", "required": false, "description": "当DbMode为SEVERLESS时必填： cpu最大值，可选范围参考DescribeServerlessInstanceSpecs接口返回", "example": "2.0" }, { "name": "AutoPause", "type": "string", "required": false, "description": "当DbMode为SEVERLESS时，指定集群是否自动暂停，可选范围 yes no 默认值:yes", "example": "yes" }, { "name": "AutoPauseDelay", "type": "integer", "required": false, "description": "当DbMode为SEVERLESS时，指定集群自动暂停的延迟，单位秒，可选范围[600,691200] 默认值:600", "example": "600" }, { "name": "SecurityGroupIds", "type": "array", "required": false, "description": "安全组id数组", "example": "[\"sg-ikto3761\",\"sg-ikto52u1\"]", "item_type": "string" }, { "name": "AlarmPolicyIds", "type": "array", "required": false, "description": "告警策略Id数组", "example": "[\"policy-8hbxwvxe\",\"policy-3bs6vxe4\"]", "item_type": "string" }, { "name": "ClusterParams", "type": "array", "required": false, "description": "参数数组，暂时支持character_set_server （utf8｜latin1｜gbk｜utf8mb4） ，lower_case_table_names，1-大小写不敏感，0-大小写敏感", "example": "无", "item_type": "object", "children": [ { "name": "ParamName", "type": "string", "required": true, "description": "参数名称", "example": "innodb_txsql_log_store_size" }, { "name": "CurrentValue", "type": "string", "required": true, "description": "当前值", "example": "2048" }, { "name": "OldValue", "type": "string", "required": true, "description": "原有值", "example": "65536" } ] }, { "name": "ParamTemplateId", "type": "integer", "required": false, "description": "参数模板ID，可以通过查询参数模板信息DescribeParamTemplates获得参数模板ID", "example": "0" }, { "name": "InstanceInitInfos", "type": "array", "required": false, "description": "实例初始化配置信息，主要用于购买集群时选不同规格实例", "example": "无", "item_type": "object", "children": [ { "name": "Cpu", "type": "integer", "required": true, "description": "实例cpu", "example": "1" }, { "name": "Memory", "type": "integer", "required": true, "description": "实例内存", "example": "2" }, { "name": "InstanceType", "type": "string", "required": true, "description": "实例类型 rw/ro", "example": "rw" }, { "name": "InstanceCount", "type": "integer", "required": true, "description": "实例个数,范围[1,15]", "example": "1" }, { "name": "MinRoCount", "type": "integer", "required": false, "description": "Serverless实例个数最小值，范围[1,15]", "example": "1" }, { "name": "MaxRoCount", "type": "integer", "required": false, "description": "Serverless实例个数最大值，范围[1,15]", "example": "1" }, { "name": "MinRoCpu", "type": "float", "required": false, "description": "Serverless实例最小规格", "example": "0.5" }, { "name": "MaxRoCpu", "type": "float", "required": false, "description": "Serverless实例最大规格", "example": "1.0" }, { "name": "DeviceType", "type": "string", "required": false, "description": "实例机器类型 1. common，通用型。 2. exclusive，独享型。", "example": "exclusive" } ] }, { "name": "DealMode", "type": "integer", "required": false, "description": "0-下单并支付 1-下单", "example": "0" }, { "name": "PayMode", "type": "integer", "required": false, "description": "计算节点付费模式：0-按量计费，1-预付费", "example": "0" }, { "name": "TimeSpan", "type": "integer", "required": false, "description": "时间", "example": "12" }, { "name": "TimeUnit", "type": "string", "required": false, "description": "单位", "example": "m" }, { "name": "RollbackDatabases", "type": "array", "required": false, "description": "回档库信息", "example": "无", "item_type": "object", "children": [ { "name": "OldDatabase", "type": "string", "required": true, "description": "旧数据库名称", "example": "db1" }, { "name": "NewDatabase", "type": "string", "required": true, "description": "新数据库名称", "example": "db2" } ] }, { "name": "RollbackTables", "type": "array", "required": false, "description": "回档表信息", "example": "无", "item_type": "object", "children": [ { "name": "Database", "type": "string", "required": true, "description": "数据库名称", "example": "db1" }, { "name": "Tables", "type": "array", "required": true, "description": "数据库表", "example": "[\"OldTable\": \"tb1\", \"NewTable\": \"tb2\"]", "item_type": "object", "children": [ { "name": "OldTable", "type": "string", "required": true, "description": "旧表名称", "example": "tb1" }, { "name": "NewTable", "type": "string", "required": true, "description": "新表名称", "example": "tb2" } ] } ] }, { "name": "OriginalROInstanceList", "type": "array", "required": false, "description": "原ro实例信息", "example": "[\"cynosdbmysql-ins-7xbwg29x\"]", "item_type": "string" }, { "name": "ProjectId", "type": "integer", "required": false, "description": "项目id", "example": "10" }, { "name": "AutoArchive", "type": "string", "required": false, "description": "是否开启归档，可选范围yesno默认值:yes", "example": "yes" }, { "name": "FromSaveBackup", "type": "boolean", "required": false, "description": "是否从保存备份中恢复", "example": "false" } ], "required": [ "Zone", "OriginalClusterId" ] }, { "name": "SearchClusterDatabases", "description": "本接口（SearchClusterDatabases）用于搜索集群数据库列表。", "status": "online", "parameters": [ { "name": "ClusterId", "type": "string", "required": true, "description": "集群id", "example": "cynosdbmysql-asf5g5fx" }, { "name": "Database", "type": "string", "required": false, "description": "数据库名", "example": "db1" }, { "name": "MatchType", "type": "integer", "required": false, "description": "是否精确搜索。 0: 模糊搜索 1:精确搜索 默认为0", "example": "1" } ], "required": [ "ClusterId" ] }, { "name": "SearchClusterTables", "description": "本接口（SearchClusterTables）用于搜索集群数据表列表。", "status": "online", "parameters": [ { "name": "ClusterId", "type": "string", "required": true, "description": "集群id", "example": "cynosdbmysql-asd54fgh" }, { "name": "Database", "type": "string", "required": false, "description": "数据库名", "example": "db1" }, { "name": "Table", "type": "string", "required": false, "description": "数据表名", "example": "1" }, { "name": "TableType", "type": "string", "required": false, "description": "数据表类型： view：只返回 view， base_table： 只返回基本表， all：返回 view 和表", "example": "all" } ], "required": [ "ClusterId" ] }, { "name": "SetLibraDBClusterRenewFlag", "description": "设置 TDSQL-C 分析集群是否续费", "status": "online", "parameters": [ { "name": "ResourceIds", "type": "array", "required": false, "description": "分析集群 ID 列表", "example": "[\"libradb-xxx\"]", "item_type": "string" }, { "name": "AutoRenewFlag", "type": "integer", "required": false, "description": "续费标记 0:正常续费 1:自动续费 2:到期不续", "example": "1" } ], "required": [] }, { "name": "SetRenewFlag", "description": "本接口（SetRenewFlag）用于设置实例的自动续费功能。", "status": "online", "parameters": [ { "name": "ResourceIds", "type": "array", "required": true, "description": "需操作的集群ID", "example": "['cynosdbmysql-xxxxxxxx']", "item_type": "string" }, { "name": "AutoRenewFlag", "type": "integer", "required": true, "description": "自动续费标志位，续费标记 0:正常续费 1:自动续费 2:到期不续", "example": "1" } ], "required": [ "ResourceIds", "AutoRenewFlag" ] }, { "name": "StartCLSDelivery", "description": "本接口（StartCLSDelivery）用于开启日志投递功能。", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "实例id", "example": "cynosdbmysql-ins-nwc5ao8g" }, { "name": "CLSTopicIds", "type": "array", "required": true, "description": "开通的日志主题id", "example": "[\"83dc6703-f43a-4b95-92ec-267bdf9e48c3\"]", "item_type": "string" }, { "name": "LogType", "type": "string", "required": false, "description": "日志类型", "example": "slow" }, { "name": "IsInMaintainPeriod", "type": "string", "required": false, "description": "是否维护时间运行", "example": "yes" } ], "required": [ "InstanceId", "CLSTopicIds" ] }, { "name": "StopCLSDelivery", "description": "本接口（StopCLSDelivery）用于停止日志投递功能。", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "实例id", "example": "cynosdbmysql-ins-nwc5ao8g" }, { "name": "CLSTopicIds", "type": "array", "required": true, "description": "日志主题id", "example": "[\"83dc6703-f43a-4b95-92ec-267bdf9e48c3\"]", "item_type": "string" }, { "name": "LogType", "type": "string", "required": false, "description": "日志类型", "example": "slow" }, { "name": "IsInMaintainPeriod", "type": "string", "required": false, "description": "是否维护时间运行", "example": "yes" } ], "required": [ "InstanceId", "CLSTopicIds" ] }, { "name": "SwitchClusterVpc", "description": "本接口（SwitchClusterVpc）用于更换集群vpc。", "status": "online", "parameters": [ { "name": "ClusterId", "type": "string", "required": true, "description": "集群ID", "example": "cynosdbmysql-hr7oi711" }, { "name": "UniqVpcId", "type": "string", "required": true, "description": "字符串vpc id", "example": "vpc-74h05211" }, { "name": "UniqSubnetId", "type": "string", "required": true, "description": "字符串子网id", "example": "subnet-d16fxg11" }, { "name": "OldIpReserveHours", "type": "integer", "required": true, "description": "旧地址回收时间", "example": "24" } ], "required": [ "ClusterId", "UniqVpcId", "UniqSubnetId", "OldIpReserveHours" ] }, { "name": "SwitchClusterZone", "description": "本接口（SwitchClusterZone）用于切换集群的主备可用区。", "status": "online", "parameters": [ { "name": "ClusterId", "type": "string", "required": true, "description": "集群Id", "example": "cynosdbmysql-hr7oi711" }, { "name": "OldZone", "type": "string", "required": true, "description": "当前可用区", "example": "ap-guangzhou-2" }, { "name": "NewZone", "type": "string", "required": true, "description": "要切换到的可用区", "example": "ap-guangzhou-3" }, { "name": "IsInMaintainPeriod", "type": "string", "required": false, "description": "维护期间执行-yes,立即执行-no", "example": "no" } ], "required": [ "ClusterId", "OldZone", "NewZone" ] }, { "name": "SwitchProxyVpc", "description": "本接口（SwitchProxyVpc）用于更换数据库代理vpc。", "status": "online", "parameters": [ { "name": "ClusterId", "type": "string", "required": true, "description": "集群ID", "example": "cynosdbmysql-hr7oi711" }, { "name": "UniqVpcId", "type": "string", "required": true, "description": "字符串vpc id", "example": "vpc-74h05211" }, { "name": "UniqSubnetId", "type": "string", "required": true, "description": "字符串子网id", "example": "subnet-d16fxg11" }, { "name": "OldIpReserveHours", "type": "integer", "required": true, "description": "旧地址回收时间", "example": "24" }, { "name": "ProxyGroupId", "type": "string", "required": true, "description": "数据库代理组Id（该参数为必填项，可以通过DescribeProxies接口获得）", "example": "cynosdbmysql-proxy-lti34611" } ], "required": [ "ClusterId", "UniqVpcId", "UniqSubnetId", "OldIpReserveHours", "ProxyGroupId" ] }, { "name": "UnbindClusterResourcePackages", "description": "本接口（UnbindClusterResourcePackages）用于解除资源包与集群之间的绑定关系。", "status": "online", "parameters": [ { "name": "ClusterId", "type": "string", "required": true, "description": "集群ID", "example": "cynosdb-test" }, { "name": "PackageIds", "type": "array", "required": false, "description": "资源包唯一ID,如果不传，解绑该实例绑定的所有资源包", "example": "[pkg-test]", "item_type": "string" } ], "required": [ "ClusterId" ] }, { "name": "UpgradeClusterVersion", "description": "本接口（UpgradeClusterVersion）用于更新内核小版本。", "status": "online", "parameters": [ { "name": "ClusterId", "type": "string", "required": true, "description": "集群id", "example": "cynosdbmysql-asdf54qw" }, { "name": "CynosVersion", "type": "string", "required": true, "description": "内核版本", "example": "2.1.10" }, { "name": "UpgradeType", "type": "string", "required": true, "description": "升级时间类型，可选：upgradeImmediate,upgradeInMaintain", "example": "upgradeImmediate" } ], "required": [ "ClusterId", "CynosVersion", "UpgradeType" ] }, { "name": "UpgradeInstance", "description": "本接口（UpgradeInstance）用于实例变配。", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "实例ID", "example": "cynosdbpg-ins-n7ocdslw" }, { "name": "Cpu", "type": "integer", "required": true, "description": "数据库CPU", "example": "2" }, { "name": "Memory", "type": "integer", "required": true, "description": "数据库内存，单位GB", "example": "4" }, { "name": "UpgradeType", "type": "string", "required": true, "description": "升级类型：upgradeImmediate，upgradeInMaintain", "example": "upgradeImmediate" }, { "name": "DeviceType", "type": "string", "required": false, "description": "实例机器类型", "example": "exclusive" }, { "name": "StorageLimit", "type": "integer", "required": false, "description": "该参数已废弃", "example": "1000" }, { "name": "AutoVoucher", "type": "integer", "required": false, "description": "是否自动选择代金券 1是 0否 默认为0", "example": "0" }, { "name": "DbType", "type": "string", "required": false, "description": "该参数已废弃", "example": "MYSQL" }, { "name": "DealMode", "type": "integer", "required": false, "description": "交易模式 0-下单并支付 1-下单", "example": "0" }, { "name": "UpgradeMode", "type": "string", "required": false, "description": "NormalUpgrade：普通变配，FastUpgrade：极速变配，若变配过程判断会造成闪断，变配流程会终止。", "example": "NormalUpgrade" }, { "name": "UpgradeProxy", "type": "object", "required": false, "description": "proxy同步升级", "example": "{\"Cpu\": 2,\"Mem\": 4000,\"ReloadBalance\": \"auto\",\"ProxyZones\": [{\"ProxyNodeZone\": \"ap-guangzhou-3\",\"ProxyNodeCount\": 2}]}", "children": [ { "name": "Cpu", "type": "integer", "required": true, "description": "cpu", "example": "2" }, { "name": "Mem", "type": "integer", "required": true, "description": "memory", "example": "4000" }, { "name": "ProxyZones", "type": "array", "required": true, "description": "代理节点信息", "example": "无", "item_type": "object", "children": [ { "name": "ProxyNodeZone", "type": "string", "required": false, "description": "proxy节点可用区", "example": "ap-guangzhou-3" }, { "name": "ProxyNodeCount", "type": "integer", "required": false, "description": "proxy节点数量", "example": "2" } ] }, { "name": "ReloadBalance", "type": "string", "required": false, "description": "重新负载均衡", "example": "auto" } ] } ], "required": [ "InstanceId", "Cpu", "Memory", "UpgradeType" ] }, { "name": "UpgradeProxy", "description": "本接口（UpgradeProxy）用于升级数据库代理配置。", "status": "online", "parameters": [ { "name": "ClusterId", "type": "string", "required": true, "description": "集群ID", "example": "cynosdbmysql-mwg7121e" }, { "name": "Cpu", "type": "integer", "required": true, "description": "cpu核数", "example": "2" }, { "name": "Mem", "type": "integer", "required": true, "description": "内存", "example": "4000" }, { "name": "ProxyCount", "type": "integer", "required": false, "description": "数据库代理组节点个数", "example": "2" }, { "name": "ProxyGroupId", "type": "string", "required": false, "description": "数据库代理组ID（已废弃）", "example": "cynosdbmysql-proxy-mwg7121e" }, { "name": "ReloadBalance", "type": "string", "required": false, "description": "重新负载均衡：auto（自动），manual（手动）", "example": "manual" }, { "name": "IsInMaintainPeriod", "type": "string", "required": false, "description": "升级时间 ：no（升级完成时）yes（实例维护时间）", "example": "no" }, { "name": "ProxyZones", "type": "array", "required": false, "description": "数据库代理节点信息", "example": "无", "item_type": "object", "children": [ { "name": "ProxyNodeZone", "type": "string", "required": false, "description": "proxy节点可用区", "example": "ap-guangzhou-3" }, { "name": "ProxyNodeCount", "type": "integer", "required": false, "description": "proxy节点数量", "example": "2" } ] }, { "name": "IsRollUpgrade", "type": "string", "required": false, "description": "是否滚动升级", "example": "yes" }, { "name": "RollUpgradeWaitingTime", "type": "integer", "required": false, "description": "滚动升级等待时间，单位：秒", "example": "10" } ], "required": [ "ClusterId", "Cpu", "Mem" ] }, { "name": "UpgradeProxyVersion", "description": "本接口（UpgradeProxyVersion）用于升级数据库代理版本。", "status": "online", "parameters": [ { "name": "ClusterId", "type": "string", "required": true, "description": "集群ID", "example": "cynosdbmysql-xxxxxxx" }, { "name": "SrcProxyVersion", "type": "string", "required": true, "description": "数据库代理当前版本", "example": "1.3.13" }, { "name": "DstProxyVersion", "type": "string", "required": true, "description": "数据库代理升级版本", "example": "1.3.14" }, { "name": "ProxyGroupId", "type": "string", "required": false, "description": "数据库代理组ID", "example": "cynosdbmysql-proxy-lti34611" }, { "name": "IsInMaintainPeriod", "type": "string", "required": false, "description": "升级时间 ：no（升级完成时）yes（实例维护时间）", "example": "no" } ], "required": [ "ClusterId", "SrcProxyVersion", "DstProxyVersion" ] } ] }