{ "name": "dbbrain", "display_name": "数据库智能管家 DBbrain", "description": "介绍如何使用API对数据库智能管家 Dbbrain 进行操作，包括慢日志分析、异常检测等。", "domain": "database", "api_version": "2021-05-27", "endpoint": "dbbrain.tencentcloudapi.com", "actions": [ { "name": "AddUserContact", "description": "添加邮件接收联系人的姓名， 邮件地址，返回值为添加成功的联系人id。", "status": "online", "parameters": [ { "name": "Name", "type": "string", "required": true, "description": "联系人姓名，由中英文、数字、空格、!@#$%^\u0026*()_+-=（）组成，不能以下划线开头，长度在20以内。", "example": "张三" }, { "name": "ContactInfo", "type": "string", "required": true, "description": "邮箱地址，支持大小写字母、数字、下划线、连字符及@字符， 只能以数字或字母开头，邮箱地址不可重复。", "example": "test@qq.com" }, { "name": "Product", "type": "string", "required": true, "description": "服务产品类型，固定值：\"mysql\"。", "example": "mysql" } ], "required": [ "Name", "ContactInfo", "Product" ] }, { "name": "CancelDBAutonomyAction", "description": "自治中心-终止自治任务（单次）", "status": "online", "parameters": [ { "name": "ActionId", "type": "integer", "required": true, "description": "自治任务ID。", "example": "12" }, { "name": "InstanceId", "type": "string", "required": true, "description": "实列ID。", "example": "crs-qtmkik3e" }, { "name": "Product", "type": "string", "required": true, "description": "服务产品类型，支持值包括： \"redis\" - 云数据库 Redis。", "example": "redis" } ], "required": [ "ActionId", "InstanceId", "Product" ] }, { "name": "CancelDBAutonomyEvent", "description": "自治中心-终止自治事件", "status": "online", "parameters": [ { "name": "EventId", "type": "integer", "required": true, "description": "自治事件ID。", "example": "12" }, { "name": "InstanceId", "type": "string", "required": true, "description": "实列ID。", "example": "crs-qtmkik3e" }, { "name": "Product", "type": "string", "required": true, "description": "服务产品类型，支持值包括： \"redis\" - 云数据库 Redis。", "example": "redis" } ], "required": [ "EventId", "InstanceId", "Product" ] }, { "name": "CancelKillTask", "description": "终止中断会话任务。", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "实例ID。", "example": "cdb-c1nl9rpv" }, { "name": "Product", "type": "string", "required": false, "description": "服务产品类型，支持值包括： \"mysql\" - 云数据库 MySQL， \"cynosdb\" - 云数据库 CynosDB for MySQL，默认为\"mysql\"。", "example": "mysql" } ], "required": [ "InstanceId" ] }, { "name": "CancelRedisBigKeyAnalysisTasks", "description": "自治中心-终止自治任务（单次）", "status": "online", "parameters": [ { "name": "AsyncRequestIds", "type": "array", "required": true, "description": "自治任务ID。", "example": "[12,18]", "item_type": "integer" }, { "name": "InstanceId", "type": "string", "required": true, "description": "实列ID。", "example": "crs-qtmkik3e" }, { "name": "Product", "type": "string", "required": true, "description": "服务产品类型，支持值包括： \"redis\" - 云数据库 Redis。", "example": "redis" } ], "required": [ "AsyncRequestIds", "InstanceId", "Product" ] }, { "name": "CloseAuditService", "description": "不用审计日志时，关闭数据库审计", "status": "online", "parameters": [ { "name": "Product", "type": "string", "required": true, "description": "服务产品类型，支持值包括： \"dcdb\" - 云数据库 Tdsql， \"mariadb\" - 云数据库 MariaDB。", "example": "dcdb" }, { "name": "NodeRequestType", "type": "string", "required": true, "description": "NodeRequestType主要标识数据库产品类型，与Product保持一致。如：\"dcdb\" ,\"mariadb\"。", "example": "dcdb" }, { "name": "InstanceId", "type": "string", "required": true, "description": "实例 ID。可通过 [DescribeDiagDBInstances](https://cloud.tencent.com/document/api/1130/57798) 接口获取。", "example": "tdsql-shartsdf" } ], "required": [ "Product", "NodeRequestType", "InstanceId" ] }, { "name": "CreateAuditLogFile", "description": "用于创建云数据库实例的审计日志文件，最多下载600w审计日志。", "status": "online", "parameters": [ { "name": "Product", "type": "string", "required": true, "description": "服务产品类型，支持值包括： \"dcdb\" - 云数据库 Tdsql， \"mariadb\" - 云数据库 MariaDB for MariaDB。", "example": "dcdb" }, { "name": "NodeRequestType", "type": "string", "required": true, "description": "与Product保持一致。如：\"dcdb\" ,\"mariadb\"", "example": "dcdb" }, { "name": "InstanceId", "type": "string", "required": true, "description": "实例 ID。可通过 [DescribeDiagDBInstances](https://cloud.tencent.com/document/api/1130/57798) 接口获取。", "example": "tdsqlshard-eg8b01gr" }, { "name": "StartTime", "type": "string", "required": true, "description": "开始时间，如“2025-03-17T00:00:00+00:00”。", "example": "2025-03-17T01:00:00+00:00" }, { "name": "EndTime", "type": "string", "required": true, "description": "结束时间，如“2025-03-17T01:00:00+00:00”。", "example": "2025-03-17T01:00:00+00:00" }, { "name": "Filter", "type": "object", "required": false, "description": "过滤条件。可按设置的过滤条件过滤日志。", "example": "无", "children": [ { "name": "Host", "type": "array", "required": false, "description": "客户端地址。", "example": "127.0.0.1", "item_type": "string" }, { "name": "DBName", "type": "array", "required": false, "description": "数据库名称。", "example": "demo_db", "item_type": "string" }, { "name": "User", "type": "array", "required": false, "description": "用户名。", "example": "root", "item_type": "string" }, { "name": "SentRows", "type": "integer", "required": false, "description": "返回行数。表示筛选返回行数大于该值的审计日志。", "example": "1" }, { "name": "AffectRows", "type": "integer", "required": false, "description": "影响行数。表示筛选影响行数大于该值的审计日志。", "example": "2" }, { "name": "ExecTime", "type": "integer", "required": false, "description": "执行时间。单位为：µs。表示筛选执行时间大于该值的审计日志。", "example": "3" } ] } ], "required": [ "Product", "NodeRequestType", "InstanceId", "StartTime", "EndTime" ] }, { "name": "CreateDBDiagReportTask", "description": "创建健康报告，并可以选择是否发送邮件。", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "实例 ID。可通过 [DescribeDiagDBInstances](https://cloud.tencent.com/document/api/1130/57798) 接口获取。", "example": "cdb-6396zzr5" }, { "name": "StartTime", "type": "string", "required": true, "description": "开始时间，如“2020-11-08T14:00:00+08:00”。", "example": "2019-01-01T00:00:00+08:00" }, { "name": "EndTime", "type": "string", "required": true, "description": "结束时间，如“2020-11-09T14:00:00+08:00”。", "example": "2019-01-02T00:00:00+08:00" }, { "name": "SendMailFlag", "type": "integer", "required": true, "description": "是否发送邮件: 0 - 否，1 - 是。", "example": "1" }, { "name": "ContactPerson", "type": "array", "required": false, "description": "接收邮件的联系人ID数组。", "example": "[1]", "item_type": "integer" }, { "name": "ContactGroup", "type": "array", "required": false, "description": "接收邮件的联系组ID数组。", "example": "[1]", "item_type": "integer" }, { "name": "Product", "type": "string", "required": false, "description": "服务产品类型，支持值：\"mysql\" - 云数据库 MySQL；\"cynosdb\" - 云数据库 TDSQL-C for MySQL，\"redis\" - 云数据库 Redis，\"mongodb\" - 云数据库 MongoDB，\"mariadb\" - 云数据库 MariaDB，\"dcdb\" - 云数据库 TDSQL MySQL，默认为\"mysql\"。", "example": "mysql" } ], "required": [ "InstanceId", "StartTime", "EndTime", "SendMailFlag" ] }, { "name": "CreateDBDiagReportUrl", "description": "创建健康报告的浏览地址。", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "实例 ID。可通过 [DescribeDiagDBInstances](https://cloud.tencent.com/document/api/1130/57798) 接口获取。 示例值：cdb-dctw4edd", "example": "cdb-c1nl9rpv" }, { "name": "AsyncRequestId", "type": "integer", "required": true, "description": "健康报告相应的任务ID，可通过[DescribeDBDiagReportTasks](https://cloud.tencent.com/document/product/1130/54873)查询。", "example": "63452" }, { "name": "Product", "type": "string", "required": false, "description": "服务产品类型，支持值：\"mysql\" - 云数据库 MySQL；\"cynosdb\" - 云数据库 TDSQL-C for MySQL，\"redis\" - 云数据库 Redis，\"mongodb\" - 云数据库 MongoDB，\"mariadb\" - 云数据库 MariaDB，\"dcdb\" - 云数据库 TDSQL MySQL，默认为\"mysql\"。", "example": "mysql" } ], "required": [ "InstanceId", "AsyncRequestId" ] }, { "name": "CreateKillTask", "description": "创建中断会话的任务。", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "kill会话任务的关联实例ID。", "example": "cdb-test1" }, { "name": "Duration", "type": "integer", "required": true, "description": "任务持续时间，单位秒，手动关闭任务传-1。", "example": "10" }, { "name": "Host", "type": "string", "required": false, "description": "任务过滤条件，客户端IP。", "example": "127.0.0.1" }, { "name": "DB", "type": "string", "required": false, "description": "任务过滤条件，数据库库名,多个\",\"隔开。", "example": "test,test1" }, { "name": "Command", "type": "string", "required": false, "description": "任务过滤条件，相关命令，多个\",\"隔开。", "example": "Time,Table Dump" }, { "name": "Info", "type": "string", "required": false, "description": "任务过滤条件，支持单条件前缀匹配。", "example": "select" }, { "name": "Infos", "type": "array", "required": false, "description": "任务过滤条件，支持多个关键字匹配，与Info参数互斥。", "example": "where", "item_type": "string" }, { "name": "User", "type": "string", "required": false, "description": "任务过滤条件，用户类型。", "example": "root" }, { "name": "Time", "type": "integer", "required": false, "description": "任务过滤条件，会话持续时长，单位秒。", "example": "10" }, { "name": "Product", "type": "string", "required": false, "description": "服务产品类型，支持值包括： \"mysql\" - 云数据库 MySQL， \"cynosdb\" - 云数据库 CynosDB for MySQL，默认为\"mysql\"。", "example": "mysql" } ], "required": [ "InstanceId", "Duration" ] }, { "name": "CreateMailProfile", "description": "创建邮件配置。其中入参ProfileType表示所创建配置的类型，ProfileType 取值包括：dbScan_mail_configuration（数据库巡检邮件配置）、scheduler_mail_configuration（定期生成健康报告的邮件发送配置）。Region统一选择广州，和实例所属地域无关。", "status": "online", "parameters": [ { "name": "ProfileInfo", "type": "object", "required": true, "description": "邮件配置内容。", "example": "无", "children": [ { "name": "Language", "type": "string", "required": true, "description": "语言类型, 包含“zh”-中文，“en”-英文。", "example": "zh" }, { "name": "MailConfiguration", "type": "object", "required": true, "description": "邮件模板的内容。", "example": "{\"HealthStatus\":[\"HEALTH\",\"SUB_HEALTH\",\"RISK\",\"HIGH_RISK\"],\"Region\":[\"ap-guangzhou\"],\"ContactGroup\":[],\"SendMail\":0,\"ContactPerson\":[24332]}", "children": [ { "name": "SendMail", "type": "integer", "required": true, "description": "是否开启邮件发送: 0, 否; 1, 是。", "example": "1" }, { "name": "Region", "type": "array", "required": true, "description": "地域配置, 如[\"ap-guangzhou\", \"ap-shanghai\"]。巡检的邮件发送模板，配置需要发送巡检邮件的地域；订阅的邮件发送模板，配置当前订阅实例的所属地域。", "example": "[\"ap-guangzhou\"]", "item_type": "string" }, { "name": "HealthStatus", "type": "array", "required": true, "description": "包含的健康等级，包括值：HEALTH-健康，SUB_HEALTH-亚健康，RISK-风险，HIGH_RISK-高危。", "example": "[\"HEALTH\"]", "item_type": "string" }, { "name": "ContactPerson", "type": "array", "required": false, "description": "联系人id, 联系人/联系组不能都为空。", "example": "[1,2]", "item_type": "integer" }, { "name": "ContactGroup", "type": "array", "required": false, "description": "联系组id, 联系人/联系组不能都为空。", "example": "[1,2]", "item_type": "integer" } ] } ] }, { "name": "ProfileLevel", "type": "string", "required": true, "description": "配置级别，支持值包括：\"User\" - 用户级别，\"Instance\" - 实例级别，其中数据库巡检邮件配置为用户级别，定期生成邮件配置为实例级别。", "example": "Instance" }, { "name": "ProfileName", "type": "string", "required": true, "description": "配置名称，需要保持唯一性，数据库巡检邮件配置名称自拟；定期生成邮件配置命名格式：\"scheduler_\" + {instanceId}，如\"scheduler_cdb-test\"。", "example": "scheduler_cdb-test1234" }, { "name": "ProfileType", "type": "string", "required": true, "description": "配置类型，支持值包括：\"dbScan_mail_configuration\" - 数据库巡检邮件配置，\"scheduler_mail_configuration\" - 定期生成邮件配置。", "example": "scheduler_mail_configuration" }, { "name": "Product", "type": "string", "required": true, "description": "服务产品类型，支持值：\"mysql\" - 云数据库 MySQL；\"cynosdb\" - 云数据库 TDSQL-C for MySQL，\"redis\" - 云数据库 Redis，\"mongodb\" - 云数据库 MongoDB，\"mariadb\" - 云数据库 MariaDB，\"dcdb\" - 云数据库 TDSQL MySQL，默认为\"mysql\"。", "example": "mysql" }, { "name": "BindInstanceIds", "type": "array", "required": false, "description": "配置绑定的实例ID。可通过 [DescribeDiagDBInstances](https://cloud.tencent.com/document/api/1130/57798) 接口获取。当配置级别为\"Instance\"时需要传入且只能为一个实例；当配置级别为“User”时，此参数不填。", "example": "[\"cdb-test\"]", "item_type": "string" } ], "required": [ "ProfileInfo", "ProfileLevel", "ProfileName", "ProfileType", "Product" ] }, { "name": "CreateMongoDBKillTask", "description": "创建中断会话的任务。", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "kill会话任务的关联实例ID。", "example": "cdb-test1" }, { "name": "Duration", "type": "integer", "required": true, "description": "任务持续时间，单位秒，手动关闭任务传-1。", "example": "10" }, { "name": "Product", "type": "string", "required": true, "description": "服务产品类型，支持值包括： \"mysql\" - 云数据库 MySQL， \"cynosdb\" - 云数据库 CynosDB for MySQL，默认为\"mysql\"。", "example": "mongodb" }, { "name": "Host", "type": "string", "required": false, "description": "任务过滤条件，客户端IP。", "example": "127.0.0.1" }, { "name": "DB", "type": "array", "required": false, "description": "命名空间", "example": "db1", "item_type": "string" }, { "name": "Type", "type": "string", "required": false, "description": "update,insert,query,getmore,remove,killcursors,command,compressed,none", "example": "Type" }, { "name": "Time", "type": "integer", "required": false, "description": "kill任务过滤条件，会话持续时长，单位秒。", "example": "10" } ], "required": [ "InstanceId", "Duration", "Product" ] }, { "name": "CreateProxySessionKillTask", "description": "创建中止所有代理节点连接会话的异步任务。当前仅支持 Redis。得到的返回值为异步任务 id，可以作为参数传入接口 DescribeProxySessionKillTasks 查询kill会话任务执行状态。", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "实例 ID。", "example": "crs-test1" }, { "name": "Product", "type": "string", "required": true, "description": "服务产品类型，支持值包括： \"redis\" - 云数据库 Redis。", "example": "redis" }, { "name": "InstanceProxyId", "type": "string", "required": false, "description": "实列代理ID。", "example": "a267221bfa30c571cabbea555121bc1c2c97e518" } ], "required": [ "InstanceId", "Product" ] }, { "name": "CreateRedisBigKeyAnalysisTask", "description": "即时创建redis实例大key分析任务，限制正在运行的即时分析任务数量默认为5。", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "实例 ID。可通过 [DescribeDiagDBInstances](https://cloud.tencent.com/document/api/1130/57798) 接口获取。", "example": "cdb-c1nl9rpv" }, { "name": "Product", "type": "string", "required": true, "description": "服务产品类型，支持值包括 \"redis\" - 云数据库 Redis。", "example": "redis" }, { "name": "ShardIds", "type": "array", "required": false, "description": "分片节点序号列表。当列表为空时，选择所有分片节点。", "example": "[1,2]", "item_type": "integer" }, { "name": "KeyDelimiterList", "type": "array", "required": false, "description": "Top Key前缀的分隔符列表。 目前仅支持以下分割符：[\",\", \";\", \":\", \"_\", \"-\", \"+\", \"@\", \"=\", \"|\", \"#\", \".\"]，当列表为空时，默认选择所有分隔符。", "example": "[ \"+\", \"@\", \"#\", \".\"]", "item_type": "string" } ], "required": [ "InstanceId", "Product" ] }, { "name": "CreateSchedulerMailProfile", "description": "该接口用于创建定期生成健康报告并邮件发送的配置，将健康报告的定期生成时间作为参数传入（周一至周日），用于设置健康报告的定期生成时间，同时保存相应的定期邮件发送的配置。", "status": "online", "parameters": [ { "name": "WeekConfiguration", "type": "array", "required": true, "description": "取值范围1-7，分别代表周一至周日。", "example": "[1,2,3]", "item_type": "integer" }, { "name": "ProfileInfo", "type": "object", "required": true, "description": "邮件配置内容。", "example": "无", "children": [ { "name": "Language", "type": "string", "required": true, "description": "语言类型, 包含“zh”-中文，“en”-英文。", "example": "zh" }, { "name": "MailConfiguration", "type": "object", "required": true, "description": "邮件模板的内容。", "example": "{\"HealthStatus\":[\"HEALTH\",\"SUB_HEALTH\",\"RISK\",\"HIGH_RISK\"],\"Region\":[\"ap-guangzhou\"],\"ContactGroup\":[],\"SendMail\":0,\"ContactPerson\":[24332]}", "children": [ { "name": "SendMail", "type": "integer", "required": true, "description": "是否开启邮件发送: 0, 否; 1, 是。", "example": "1" }, { "name": "Region", "type": "array", "required": true, "description": "地域配置, 如[\"ap-guangzhou\", \"ap-shanghai\"]。巡检的邮件发送模板，配置需要发送巡检邮件的地域；订阅的邮件发送模板，配置当前订阅实例的所属地域。", "example": "[\"ap-guangzhou\"]", "item_type": "string" }, { "name": "HealthStatus", "type": "array", "required": true, "description": "包含的健康等级，包括值：HEALTH-健康，SUB_HEALTH-亚健康，RISK-风险，HIGH_RISK-高危。", "example": "[\"HEALTH\"]", "item_type": "string" }, { "name": "ContactPerson", "type": "array", "required": false, "description": "联系人id, 联系人/联系组不能都为空。", "example": "[1,2]", "item_type": "integer" }, { "name": "ContactGroup", "type": "array", "required": false, "description": "联系组id, 联系人/联系组不能都为空。", "example": "[1,2]", "item_type": "integer" } ] } ] }, { "name": "ProfileName", "type": "string", "required": true, "description": "配置名称，需要保持唯一性，定期生成邮件配置命名格式：\"scheduler_\" + {instanceId}，如\"scheduler_cdb-test\"。", "example": "scheduler_cdb-test" }, { "name": "BindInstanceId", "type": "string", "required": true, "description": "配置订阅的实例ID。可通过 [DescribeDiagDBInstances](https://cloud.tencent.com/document/api/1130/57798) 接口获取。", "example": "cdb-12156" }, { "name": "Product", "type": "string", "required": true, "description": "服务产品类型，支持值：\"mysql\" - 云数据库 MySQL；\"cynosdb\" - 云数据库 TDSQL-C for MySQL，\"redis\" - 云数据库 Redis，\"mongodb\" - 云数据库 MongoDB，\"mariadb\" - 云数据库 MariaDB，\"dcdb\" - 云数据库 TDSQL MySQL，默认为\"mysql\"。", "example": "mysql" } ], "required": [ "WeekConfiguration", "ProfileInfo", "ProfileName", "BindInstanceId", "Product" ] }, { "name": "CreateSecurityAuditLogExportTask", "description": "创建安全审计日志导出任务。", "status": "online", "parameters": [ { "name": "SecAuditGroupId", "type": "string", "required": true, "description": "安全审计组Id。", "example": "sag-01z37k3f" }, { "name": "StartTime", "type": "string", "required": true, "description": "导出日志开始时间，例如2020-12-28 00:00:00。", "example": "2020-12-28 00:00:00" }, { "name": "EndTime", "type": "string", "required": true, "description": "导出日志结束时间，例如2020-12-28 01:00:00。", "example": "2020-12-28 01:00:00" }, { "name": "Product", "type": "string", "required": true, "description": "服务产品类型，支持值：\"mysql\" - 云数据库 MySQL。", "example": "mysql" }, { "name": "DangerLevels", "type": "array", "required": false, "description": "日志风险等级列表，支持值包括：0 无风险；1 低风险；2 中风险；3 高风险。", "example": "[1,2,3]", "item_type": "integer" } ], "required": [ "SecAuditGroupId", "StartTime", "EndTime", "Product" ] }, { "name": "CreateSqlFilter", "description": "创建实例SQL限流任务。", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "实例 ID。可通过 [DescribeDiagDBInstances](https://cloud.tencent.com/document/api/1130/57798) 接口获取。", "example": "cdb-c1nl9rpv" }, { "name": "SqlType", "type": "string", "required": true, "description": "SQL语句的类型，取值包括SELECT, UPDATE, DELETE, INSERT, REPLACE。 其中： SELECT - 查询 UPDATE - 更新 DELETE - 删除 INSERT - 插入 REPLACE - 替换", "example": "SELECT" }, { "name": "FilterKey", "type": "string", "required": true, "description": "关键字，用于筛选SQL语句，多个关键字用英文逗号分隔，逗号不能作为关键词，多个关键词之间的关系为“逻辑与”。", "example": "foo,bar,foobar" }, { "name": "MaxConcurrency", "type": "integer", "required": true, "description": "最大并发度，取值不能小于0，如果该值设为 0，则表示限制所有匹配的SQL执行。", "example": "1" }, { "name": "Duration", "type": "integer", "required": true, "description": "限流时长，单位秒，支持-1和小于2147483647的正整数，-1表示永不过期。", "example": "300" }, { "name": "SessionToken", "type": "string", "required": false, "description": "通过 [VerifyUserAccount](https://cloud.tencent.com/document/product/1130/72828) 获取有效期为5分钟的会话token，使用后会自动延长token有效期至五分钟后。", "example": "cAuth" }, { "name": "Product", "type": "string", "required": false, "description": "服务产品类型，支持值：\"mysql\" - 云数据库 MySQL；\"cynosdb\" - 云数据库 TDSQL-C for MySQL，默认为\"mysql\"。", "example": "mysql" } ], "required": [ "InstanceId", "SqlType", "FilterKey", "MaxConcurrency", "Duration" ] }, { "name": "CreateUserAutonomyProfile", "description": "自治中心-终止自治任务（单次）；注意：接口需要加白名单。", "status": "online", "parameters": [ { "name": "ProfileType", "type": "string", "required": true, "description": "配置类型，为需要配置的功能枚举值，目前包含以下枚举值：AutonomyGlobal（自治功能全局配置）、RedisAutoScaleUp（Redis自治扩容配置）", "example": "RedisAutoScaleUp" }, { "name": "InstanceId", "type": "string", "required": true, "description": "实例 ID。可通过 [DescribeDiagDBInstances](https://cloud.tencent.com/document/api/1130/57798) 接口获取。", "example": "crs-qtmkik3e" }, { "name": "Product", "type": "string", "required": true, "description": "服务产品类型，支持值包括： \"redis\" - 云数据库 Redis。", "example": "redis" }, { "name": "ProfileInfo", "type": "string", "required": false, "description": "自治功能相关配置，标准JSON字符串格式。", "example": "{ \"Strategy\": \"Threshold\", \"Enabled\": true, \"MemoryUpperLimit\": 512, \"ThresholdRule\": { \"Metric\": \"mem_util\", \"Threshold\": 70, \"Duration\": 600 } }" } ], "required": [ "ProfileType", "InstanceId", "Product" ] }, { "name": "DeleteAuditLogFile", "description": "用于删除云数据库实例的审计日志文件。", "status": "online", "parameters": [ { "name": "Product", "type": "string", "required": true, "description": "服务产品类型，支持值包括： \"dcdb\" - 云数据库 Tdsql， \"mariadb\" - 云数据库 MariaDB for MariaDB， \"mysql\" - 云数据库 MySQL， \"cynosdb\" - 云数据库 CynosDB for MySQL， \"postgres\" - 云数据库 PostgreSQL。", "example": "dcdb" }, { "name": "NodeRequestType", "type": "string", "required": true, "description": "NodeRequestType主要标识数据库产品类型，与Product保持一致。该字段规则如下： 当product为\"dcdb\"则输入\"dcdb\"， 当product为\"mariadb\"则输入\"mariadb\"， 当product为\"mysql\"则输入\"mysql\"， 当product为\"cynosdb\"则输入\"mysql\"， 当product为\"postgres\"则输入\"postgres\"。", "example": "dcdb" }, { "name": "InstanceId", "type": "string", "required": true, "description": "实例 ID。可通过 [DescribeDiagDBInstances](https://cloud.tencent.com/document/api/1130/57798) 接口获取。", "example": "tdsqlshard-eg8b01gr" }, { "name": "AsyncRequestId", "type": "integer", "required": true, "description": "审计日志文件生成异步任务ID。可通过[查询审计日志文件](https://cloud.tencent.com/document/product/1130/90371)获得。", "example": "12" } ], "required": [ "Product", "NodeRequestType", "InstanceId", "AsyncRequestId" ] }, { "name": "DeleteDBDiagReportTasks", "description": "根据任务id删除健康报告生成任务", "status": "online", "parameters": [ { "name": "AsyncRequestIds", "type": "array", "required": true, "description": "需要删除的任务id列表。可通过[查询健康报告生成任务列表](https://cloud.tencent.com/document/product/1130/57805)获取", "example": "[123,12]", "item_type": "integer" }, { "name": "InstanceId", "type": "string", "required": true, "description": "实例 ID。可通过 [DescribeDiagDBInstances](https://cloud.tencent.com/document/api/1130/57798) 接口获取。", "example": "crs-hor87q50" }, { "name": "Product", "type": "string", "required": false, "description": "服务产品类型，支持值：\"mysql\" - 云数据库 MySQL；\"cynosdb\" - 云数据库 TDSQL-C for MySQL，\"dbbrain-mysql\" - 自建 MySQL，\"redis\" - 云数据库 Redis，默认为\"mysql\"。", "example": "mysql" } ], "required": [ "AsyncRequestIds", "InstanceId" ] }, { "name": "DeleteRedisBigKeyAnalysisTasks", "description": "删除Redis实例的大key分析任务。", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "实例ID。", "example": "crs-c1nl9rpv" }, { "name": "AsyncRequestIds", "type": "array", "required": true, "description": "待删除的异步任务ID列表。", "example": "[11822974]", "item_type": "integer" }, { "name": "Product", "type": "string", "required": true, "description": "服务产品类型，支持值包括 \"redis\" - 云数据库 Redis。", "example": "redis" } ], "required": [ "InstanceId", "AsyncRequestIds", "Product" ] }, { "name": "DeleteSecurityAuditLogExportTasks", "description": "删除安全审计日志导出任务。", "status": "online", "parameters": [ { "name": "SecAuditGroupId", "type": "string", "required": true, "description": "安全审计组Id。", "example": "sag-01z37k3f" }, { "name": "AsyncRequestIds", "type": "array", "required": true, "description": "日志导出任务Id列表，接口会忽略不存在或已删除的任务Id。", "example": "[1]", "item_type": "integer" }, { "name": "Product", "type": "string", "required": true, "description": "服务产品类型，支持值： \"mysql\" - 云数据库 MySQL。", "example": "mysql" } ], "required": [ "SecAuditGroupId", "AsyncRequestIds", "Product" ] }, { "name": "DeleteSqlFilters", "description": "删除实例SQL限流任务。", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "实例 ID。可通过 [DescribeDiagDBInstances](https://cloud.tencent.com/document/api/1130/57798) 接口获取。", "example": "cdb-c1nl9rpv" }, { "name": "FilterIds", "type": "array", "required": true, "description": "限流任务ID列表。通过接口[创建实例SQL限流任务](https://cloud.tencent.com/document/product/1130/72835)获得。", "example": "[1432970]", "item_type": "integer" }, { "name": "SessionToken", "type": "string", "required": false, "description": "通过 [VerifyUserAccount](https://cloud.tencent.com/document/product/1130/72828) 获取有效期为5分钟的会话token，使用后会自动延长token有效期至五分钟后。", "example": "aOqcrCnPLZgCh41VqZVHda2Y+HI=:26872060" }, { "name": "Product", "type": "string", "required": false, "description": "服务产品类型，支持值：\"mysql\" - 云数据库 MySQL；\"cynosdb\" - 云数据库 TDSQL-C for MySQL，默认为\"mysql\"。", "example": "mysql" } ], "required": [ "InstanceId", "FilterIds" ] }, { "name": "DescribeAlarmTemplate", "description": "通知模板查询", "status": "online", "parameters": [ { "name": "TemplateNameRegexp", "type": "string", "required": true, "description": "搜索字段", "example": "demoAlarmTemplate" }, { "name": "Limit", "type": "integer", "required": true, "description": "返回限制长度，最大值: 50，默认值: 50", "example": "50" }, { "name": "Offset", "type": "integer", "required": true, "description": "偏置，最大值: 无限制，默认值: 0", "example": "0" }, { "name": "Product", "type": "string", "required": false, "description": "服务产品类型，支持值：\"mysql\" - 云数据库 MySQL；\"cynosdb\" - 云数据库 TDSQL-C for MySQL", "example": "mysql" } ], "required": [ "TemplateNameRegexp", "Limit", "Offset" ] }, { "name": "DescribeAllUserContact", "description": "获取邮件发送中联系人的相关信息。", "status": "online", "parameters": [ { "name": "Product", "type": "string", "required": true, "description": "服务产品类型，固定值：mysql。", "example": "mysql" }, { "name": "Names", "type": "array", "required": false, "description": "联系人名数组，支持模糊搜索。", "example": "zhangsan", "item_type": "string" } ], "required": [ "Product" ] }, { "name": "DescribeAllUserGroup", "description": "获取邮件发送联系组的相关信息。", "status": "online", "parameters": [ { "name": "Product", "type": "string", "required": true, "description": "服务产品类型，固定值：mysql。", "example": "mysql" }, { "name": "Names", "type": "array", "required": false, "description": "联系组名称数组，支持模糊搜索。", "example": "group1", "item_type": "string" } ], "required": [ "Product" ] }, { "name": "DescribeAuditInstanceList", "description": "查询实例列表", "status": "online", "parameters": [ { "name": "Product", "type": "string", "required": true, "description": "服务产品类型，支持值包括： \"dcdb\" - 云数据库 Tdsql， \"mariadb\" - 云数据库 MariaDB。", "example": "dcdb" }, { "name": "NodeRequestType", "type": "string", "required": true, "description": "NodeRequestType主要标识数据库产品类型，与Product保持一致。如：\"dcdb\" ,\"mariadb\"。", "example": "dcdb" }, { "name": "AuditSwitch", "type": "integer", "required": false, "description": "审计状态标识，0-未开通审计；1-已开通审计，默认为0。", "example": "1" }, { "name": "Offset", "type": "integer", "required": false, "description": "偏移量，默认为0。", "example": "0" }, { "name": "Limit", "type": "integer", "required": false, "description": "查询数目，默认为20，最大为100。", "example": "20" }, { "name": "Filters", "type": "array", "required": false, "description": "查询实例的搜索条件。Name包括：InstanceId， InstanceName。", "example": "无", "item_type": "object", "children": [ { "name": "Name", "type": "string", "required": true, "description": "搜索条件名称", "example": "InstanceId" }, { "name": "Values", "type": "array", "required": true, "description": "要搜索的条件的值", "example": "tdsql-fk4kasq", "item_type": "string" } ] } ], "required": [ "Product", "NodeRequestType" ] }, { "name": "DescribeAuditLogFiles", "description": "用于创建云数据库实例的审计日志文件", "status": "online", "parameters": [ { "name": "Product", "type": "string", "required": true, "description": "服务产品类型，支持值包括： \"dcdb\" - 云数据库 Tdsql， \"mariadb\" - 云数据库 MariaDB for MariaDB， \"mysql\" - 云数据库 MySQL， \"cynosdb\" - 云数据库 CynosDB for MySQL， \"postgres\" - 云数据库 PostgreSQL", "example": "dcdb" }, { "name": "NodeRequestType", "type": "string", "required": true, "description": "该字段规则如下： 当product为\"dcdb\"则输入\"dcdb\"， 当product为\"mariadb\"则输入\"mariadb\"， 当product为\"mysql\"则输入\"mysql\"， 当product为\"cynosdb\"则输入\"mysql\"， 当product为\"postgres\"则输入\"postgres\"。", "example": "dcdb" }, { "name": "InstanceId", "type": "string", "required": true, "description": "实例 ID。可通过 [DescribeDiagDBInstances](https://cloud.tencent.com/document/api/1130/57798) 接口获取。", "example": "tdsqlshard-eg8b01gr" }, { "name": "Offset", "type": "integer", "required": false, "description": "偏移量，默认为0。", "example": "0" }, { "name": "Limit", "type": "integer", "required": false, "description": "查询数目，默认为20，最大为100。", "example": "20" } ], "required": [ "Product", "NodeRequestType", "InstanceId" ] }, { "name": "DescribeDBAutonomyAction", "description": "自治中心-查询自治事件任务详情。", "status": "online", "parameters": [ { "name": "ActionId", "type": "integer", "required": true, "description": "自治任务ID。可通过 [DescribeDBAutonomyActions](https://cloud.tencent.com/document/product/1130/116974) 接口获取。", "example": "12" }, { "name": "InstanceId", "type": "string", "required": true, "description": "实例 ID。可通过 [DescribeDiagDBInstances](https://cloud.tencent.com/document/api/1130/57798) 接口获取。", "example": "crs-qtmkik3e" }, { "name": "Product", "type": "string", "required": true, "description": "服务产品类型，支持值包括： \"redis\" - 云数据库 Redis。", "example": "redis" } ], "required": [ "ActionId", "InstanceId", "Product" ] }, { "name": "DescribeDBAutonomyActions", "description": "自治中心-终止自治任务（单次）", "status": "online", "parameters": [ { "name": "EventId", "type": "integer", "required": true, "description": "事件ID。可通过 [DescribeDBDiagHistory](https://cloud.tencent.com/document/product/1130/39559) 接口获取。", "example": "12" }, { "name": "InstanceId", "type": "string", "required": true, "description": "实例 ID。可通过 [DescribeDiagDBInstances](https://cloud.tencent.com/document/api/1130/57798) 接口获取。", "example": "crs-qtmkik3e" }, { "name": "Product", "type": "string", "required": true, "description": "服务产品类型，支持值包括： \"redis\" - 云数据库 Redis。", "example": "redis" } ], "required": [ "EventId", "InstanceId", "Product" ] }, { "name": "DescribeDBAutonomyEvents", "description": "自治中心-终止自治任务（单次）", "status": "online", "parameters": [ { "name": "Product", "type": "string", "required": true, "description": "服务产品类型，支持值包括： \"redis\" - 云数据库 Redis。", "example": "redis" }, { "name": "InstanceId", "type": "string", "required": true, "description": "实列ID。", "example": "crs-qtmkik3e" }, { "name": "StartTime", "type": "string", "required": true, "description": "开始时间。", "example": "2015-03-12 00:00:00" }, { "name": "EndTime", "type": "string", "required": true, "description": "结束时间。", "example": "2015-03-12 00:00:00" }, { "name": "Offset", "type": "integer", "required": false, "description": "分页参数，默认值为0。", "example": "0" }, { "name": "Limit", "type": "integer", "required": false, "description": "分页参数，默认值为20。", "example": "20" } ], "required": [ "Product", "InstanceId", "StartTime", "EndTime" ] }, { "name": "DescribeDBDiagEvent", "description": "获取实例异常诊断事件的详情信息。", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "实例 ID。可通过 [DescribeDiagDBInstances](https://cloud.tencent.com/document/api/1130/57798) 接口获取。 查询TDSQL MySQL分布式实例:Instanceld：填写集群ID\u0026Shard实例ID，如：dcdbt-157xxxk\u0026shard-qxxxx", "example": "cdb-test156" }, { "name": "EventId", "type": "integer", "required": false, "description": "事件 ID 。通过“获取实例诊断历史[DescribeDBDiagHistory](https://cloud.tencent.com/document/product/1130/39559) ”获取。", "example": "5" }, { "name": "Product", "type": "string", "required": false, "description": "服务产品类型，支持值：\"mysql\" - 云数据库 MySQL；\"mariadb\"-mariadb;\"cynosdb\"-TDSQL-C for MySQL ;\"dcdb\"-TDSQL MySQL ;\"redis\" - 云数据库 Redis，默认为\"mysql\"。", "example": "mysql" } ], "required": [ "InstanceId" ] }, { "name": "DescribeDBDiagEvents", "description": "获取指定时间段内的诊断事件列表，支持依据风险等级、实例ID等条件过滤。", "status": "online", "parameters": [ { "name": "StartTime", "type": "string", "required": true, "description": "开始时间，如“2021-05-27 00:00:00”，支持的最早查询时间为当前时间的前30天。", "example": "2025-09-03T10:41:59+08:00" }, { "name": "EndTime", "type": "string", "required": true, "description": "结束时间，如“2021-05-27 01:00:00”，支持的最早查询时间为当前时间的前30天。", "example": "2025-09-03T10:41:59+08:00" }, { "name": "Severities", "type": "array", "required": false, "description": "风险等级列表，取值按影响程度从高至低分别为：1 - 致命、2 -严重、3 - 告警、4 - 提示、5 -健康。", "example": "[1, 2, 3, 4]", "item_type": "integer" }, { "name": "InstanceIds", "type": "array", "required": false, "description": "实例ID列表。可通过 [DescribeDiagDBInstances](https://cloud.tencent.com/document/api/1130/57798) 接口获取。 查询TDSQL MySQL分布式实例:Instanceld：填写集群ID\u0026Shard实例ID，如：dcdbt-157xxxk\u0026shard-qxxxx", "example": "[\"cdb-test\"]", "item_type": "string" }, { "name": "Product", "type": "string", "required": false, "description": "服务产品类型，支持值包括：\"mysql\" - 云数据库 MySQL，\"redis\" - 云数据库 Redis，\"mariadb\"-数据库mariadb 默认为\"mysql\"。", "example": "mysql" }, { "name": "Offset", "type": "integer", "required": false, "description": "偏移量，默认0。", "example": "0" }, { "name": "Limit", "type": "integer", "required": false, "description": "返回数量，默认20，最大值为50。", "example": "20" } ], "required": [ "StartTime", "EndTime" ] }, { "name": "DescribeDBDiagHistory", "description": "获取实例诊断事件的列表。", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "实例 ID。可通过 [DescribeDiagDBInstances](https://cloud.tencent.com/document/api/1130/57798) 接口获取。 查询TDSQL MySQL分布式实例:Instanceld：填写集群ID\u0026Shard实例ID，如：dcdbt-157xxxk\u0026shard-qxxxx", "example": "cdb-test" }, { "name": "StartTime", "type": "string", "required": true, "description": "开始时间，如“2019-09-10 12:13:14”。结束时间与开始时间的间隔最大可为2天。", "example": "2019-01-01 00:00:00" }, { "name": "EndTime", "type": "string", "required": true, "description": "结束时间，如“2019-09-11 12:13:14”，结束时间与开始时间的间隔最大可为2天。", "example": "2019-01-01 01:00:00" }, { "name": "Product", "type": "string", "required": false, "description": "服务产品类型，支持值：\"mysql\" - 云数据库 MySQL；\"mariadb\"-mariadb;\"cynosdb\"-TDSQL-C for MySQL ;\"dcdb\"-TDSQL MySQL ;\"redis\" - 云数据库 Redis，默认为\"mysql\"。", "example": "mysql" } ], "required": [ "InstanceId", "StartTime", "EndTime" ] }, { "name": "DescribeDBDiagReportContent", "description": "健康报告内容。", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "实例名", "example": "cdb-c1nl9rpv" }, { "name": "AsyncRequestId", "type": "integer", "required": true, "description": "异步任务ID", "example": "59" }, { "name": "Product", "type": "string", "required": false, "description": "服务产品类型，支持值：\"mysql\" - 云数据库 MySQL，\"redis\" - 云数据库 Redis，\"mongodb\" - 云数据库 MongoDB，默认为\"mysql\"。", "example": "mysql" } ], "required": [ "InstanceId", "AsyncRequestId" ] }, { "name": "DescribeDBDiagReportTasks", "description": "查询健康报告生成任务列表。", "status": "online", "parameters": [ { "name": "StartTime", "type": "string", "required": false, "description": "第一个任务的开始时间，用于范围查询，时间格式如：2019-09-10 12:13:14。", "example": "2019-09-10 12:13:14" }, { "name": "EndTime", "type": "string", "required": false, "description": "最后一个任务的开始时间，用于范围查询，时间格式如：2019-09-10 12:13:14。", "example": "2019-09-10 12:13:14" }, { "name": "InstanceIds", "type": "array", "required": false, "description": "实例ID数组，用于筛选指定实例的任务列表。", "example": "[\"cdb-c1nl9rpv\"]", "item_type": "string" }, { "name": "Sources", "type": "array", "required": false, "description": "任务的触发来源，支持的取值包括：\"DAILY_INSPECTION\" - 实例巡检；\"SCHEDULED\" - 计划任务；\"MANUAL\" - 手动触发。", "example": "[\"DAILY_INSPECTION\"]", "item_type": "string" }, { "name": "HealthLevels", "type": "string", "required": false, "description": "报告的健康等级，支持的取值包括：\"HEALTH\" - 健康；\"SUB_HEALTH\" - 亚健康；\"RISK\" - 危险；\"HIGH_RISK\" - 高危。", "example": "[\"HEALTH\"]" }, { "name": "TaskStatuses", "type": "string", "required": false, "description": "任务的状态，支持的取值包括：\"created\" - 新建；\"chosen\" - 待执行； \"running\" - 执行中；\"failed\" - 失败；\"finished\" - 已完成。", "example": "[\"finished\"]" }, { "name": "Offset", "type": "integer", "required": false, "description": "偏移量，默认0。", "example": "0" }, { "name": "Limit", "type": "integer", "required": false, "description": "返回数量，默认20，最大值为100。", "example": "20" }, { "name": "Product", "type": "string", "required": false, "description": "服务产品类型，支持值：\"mysql\" - 云数据库 MySQL；\"cynosdb\" - 云数据库 TDSQL-C for MySQL，\"redis\" - 云数据库 Redis，默认为\"mysql\"。", "example": "mysql" } ], "required": [] }, { "name": "DescribeDBPerfTimeSeries", "description": "根据实例ID获取指定时间段的性能趋势。", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "需要获取性能趋势的实例ID。", "example": "cdb-test123" }, { "name": "StartTime", "type": "string", "required": true, "description": "开始时间。", "example": "2019-01-01T00:00:00+08:00" }, { "name": "EndTime", "type": "string", "required": true, "description": "结束时间。", "example": "2019-01-01T01:00:00+08:00" }, { "name": "Metric", "type": "string", "required": true, "description": "指标名称，多个指标之间用逗号分隔。", "example": "binlog_disk_available,data_disk_available" }, { "name": "Product", "type": "string", "required": true, "description": "服务产品类型，支持值包括： \"mysql\" - 云数据库 MySQL， \"cynosdb\" - 云数据库 TDSQL-C for MySQL，\"redis\" - 云数据库 Redis，\"mongodb\" - 云数据库 MongoDB", "example": "mysql" }, { "name": "ClusterId", "type": "string", "required": false, "description": "需要获取性能趋势的集群ID。", "example": "tdsqlshard-1eu5znlw" }, { "name": "Period", "type": "integer", "required": false, "description": "性能数据统计粒度。", "example": "60" }, { "name": "InstanceNodeId", "type": "string", "required": false, "description": "实列节点ID。", "example": "95397a1418f36495af7d09433f2f575f3d53d852" }, { "name": "InstanceProxyId", "type": "string", "required": false, "description": "实列代理ID。", "example": "a267221bfa30c571cabbea555121bc1c2c97e518" }, { "name": "ProxyId", "type": "string", "required": false, "description": "代理节点ID。", "example": "a267221bfa30c571cabbea555121bc1c2c97e518" } ], "required": [ "InstanceId", "StartTime", "EndTime", "Metric", "Product" ] }, { "name": "DescribeDBSpaceStatus", "description": "获取指定时间段内的实例空间使用概览，包括磁盘增长量(MB)、磁盘剩余(MB)、磁盘总量(MB)及预计可用天数。", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "实例 ID 。", "example": "cdb-test" }, { "name": "RangeDays", "type": "integer", "required": false, "description": "时间段天数，截止日期为当日，默认为7天。", "example": "5" }, { "name": "Product", "type": "string", "required": false, "description": "服务产品类型，支持值包括： \"mysql\" - 云数据库 MySQL， \"cynosdb\" - 云数据库 CynosDB for MySQL，\"mongodb\" - 云数据库 MongoDB，默认为\"mysql\"。", "example": "mysql" } ], "required": [ "InstanceId" ] }, { "name": "DescribeDiagDBInstances", "description": "获取实例信息列表。Region统一选择广州。", "status": "online", "parameters": [ { "name": "IsSupported", "type": "boolean", "required": true, "description": "是否是DBbrain支持的实例，固定传 true。", "example": "true" }, { "name": "Product", "type": "string", "required": true, "description": "服务产品类型，支持值包括：\"mysql\" - 云数据库 MySQL，\"cynosdb\" - 云数据库 TDSQL-C for MySQL，\"dbbrain-mysql\" - 自建 MySQL，\"redis\" - 云数据库 Redis，默认为\"mysql\"。", "example": "mysql" }, { "name": "Offset", "type": "integer", "required": true, "description": "分页参数，偏移量。", "example": "0" }, { "name": "Limit", "type": "integer", "required": true, "description": "分页参数，分页值，最大值为100。", "example": "50" }, { "name": "InstanceNames", "type": "array", "required": false, "description": "根据实例名称条件查询。", "example": "[\"cdb-测试\"]", "item_type": "string" }, { "name": "InstanceIds", "type": "array", "required": false, "description": "根据实例ID条件查询。", "example": "[\"cdb-test\"]", "item_type": "string" }, { "name": "Regions", "type": "array", "required": false, "description": "根据地域条件查询。", "example": "[\"ap-guangzhou\"]", "item_type": "string" } ], "required": [ "IsSupported", "Product", "Offset", "Limit" ] }, { "name": "DescribeHealthScore", "description": "根据实例ID获取指定时间段（30分钟）的健康得分，以及异常扣分项。", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "需要获取健康得分的实例ID。", "example": "cdb-test123" }, { "name": "Time", "type": "string", "required": true, "description": "获取健康得分的时间，时间格式如：2019-09-10 12:13:14。", "example": "2019-01-01T00:00:00+08:00" }, { "name": "Product", "type": "string", "required": true, "description": "服务产品类型，支持值包括： \"mysql\" - 云数据库 MySQL， \"cynosdb\" - 云数据库 TDSQL-C for MySQL，\"redis\" - 云数据库 Redis，默认为\"mysql\"。", "example": "mysql" } ], "required": [ "InstanceId", "Time", "Product" ] }, { "name": "DescribeHealthScoreTimeSeries", "description": "获取指定时间段内的健康得分趋势", "status": "online", "parameters": [ { "name": "StartTime", "type": "string", "required": true, "description": "开始时间，如“2021-05-27 00:00:00”，支持的最早查询时间为当前时间的前30天。", "example": "2025-09-03T10:41:59+08:00" }, { "name": "EndTime", "type": "string", "required": true, "description": "结束时间，如“2021-05-27 01:00:00”，支持的最早查询时间为当前时间的前30天。", "example": "2025-09-03T10:41:59+08:00" }, { "name": "InstanceId", "type": "string", "required": true, "description": "实例ID列表。可通过 [DescribeDiagDBInstances](https://cloud.tencent.com/document/api/1130/57798) 接口获取。", "example": "cdb-test" }, { "name": "Product", "type": "string", "required": true, "description": "服务产品类型，支持值包括：\"mysql\" - 云数据库 MySQL，\"redis\" - 云数据库 Redis，\"mariadb\"-数据库mariadb 默认为\"mysql\"。", "example": "cdb" } ], "required": [ "StartTime", "EndTime", "InstanceId", "Product" ] }, { "name": "DescribeIndexRecommendAggregationSlowLogs", "description": "查询某张表的慢查模板概览，这个接口是对用户点击对应的推荐索引后，展示慢日志用的", "status": "online", "parameters": [ { "name": "Product", "type": "string", "required": true, "description": "服务产品类型，支持值包括：\"mongodb\" - 云数据库 。", "example": "mongodb" }, { "name": "InstanceId", "type": "string", "required": true, "description": "实例 ID。可通过 [DescribeDiagDBInstances](https://cloud.tencent.com/document/api/1130/57798) 接口获取。", "example": "cmgo-2jrxxlx" }, { "name": "Db", "type": "string", "required": true, "description": "数据库名称。", "example": "demo_db" }, { "name": "Collection", "type": "string", "required": true, "description": "表名。", "example": "demo_collection" }, { "name": "Signs", "type": "array", "required": true, "description": "签名。这个值是 [DescribeIndexRecommendInfo](https://cloud.tencent.com/document/product/1130/98911) 接口返回", "example": "[\"d6e6fe0025c258592dd6f442312f26ww\"]", "item_type": "string" } ], "required": [ "Product", "InstanceId", "Db", "Collection", "Signs" ] }, { "name": "DescribeIndexRecommendInfo", "description": "查询实例的索引推荐信息，包括索引统计相关信息，推荐索引列表，无效索引列表等。", "status": "online", "parameters": [ { "name": "Product", "type": "string", "required": true, "description": "服务产品类型，支持值包括：\"mongodb\" - 云数据库 。", "example": "mongodb" }, { "name": "InstanceId", "type": "string", "required": true, "description": "实例 ID。可通过 [DescribeDiagDBInstances](https://cloud.tencent.com/document/api/1130/57798) 接口获取。", "example": "cmgo-2jrxxlx" } ], "required": [ "Product", "InstanceId" ] }, { "name": "DescribeMailProfile", "description": "获取发送邮件的配置， 包括数据库巡检的邮件配置以及定期生成健康报告的邮件发送配置。", "status": "online", "parameters": [ { "name": "ProfileType", "type": "string", "required": true, "description": "配置类型，支持值包括：\"dbScan_mail_configuration\" - 数据库巡检邮件配置，\"scheduler_mail_configuration\" - 定期生成邮件配置。", "example": "scheduler_mail_configuration" }, { "name": "Product", "type": "string", "required": true, "description": "服务产品类型，支持值包括： \"mysql\" - 云数据库 MySQL， \"cynosdb\" - 云数据库 TDSQL-C for MySQL，默认为\"mysql\"。", "example": "mysql" }, { "name": "Offset", "type": "integer", "required": true, "description": "分页偏移量。", "example": "0" }, { "name": "Limit", "type": "integer", "required": true, "description": "分页单位，最大支持50。", "example": "20" }, { "name": "ProfileName", "type": "string", "required": false, "description": "根据邮件配置名称查询，定期发送的邮件配置名称遵循：\"scheduler_\"+{instanceId}的规则。", "example": "scheduler_cdb-of66x11l" } ], "required": [ "ProfileType", "Product", "Offset", "Limit" ] }, { "name": "DescribeMetricTopProxies", "description": "获取指定时间段内Redis Proxy 指标", "status": "online", "parameters": [ { "name": "StartTime", "type": "string", "required": true, "description": "开始时间，如“2021-05-27 00:00:00”，支持的最早查询时间为当前时间的前30天。", "example": "2025-09-03T10:41:59+08:00" }, { "name": "EndTime", "type": "string", "required": true, "description": "结束时间，如“2021-05-27 01:00:00”，支持的最早查询时间为当前时间的前30天。", "example": "2025-09-03T10:41:59+08:00" }, { "name": "InstanceId", "type": "string", "required": true, "description": "实例ID列表。可通过 [DescribeDiagDBInstances](https://cloud.tencent.com/document/api/1130/57798) 接口获取。", "example": "crs-qjdkzsat" }, { "name": "Product", "type": "string", "required": true, "description": "服务产品类型，支持值包括：\"mysql\" - 云数据库 MySQL，\"redis\" - 云数据库 Redis，\"mariadb\"-数据库mariadb 默认为\"mysql\"。", "example": "redis" }, { "name": "Metric", "type": "string", "required": true, "description": "指标 eg: cpu_util, connections", "example": "connections" }, { "name": "Limit", "type": "integer", "required": false, "description": "默认前20条", "example": "10" } ], "required": [ "StartTime", "EndTime", "InstanceId", "Product", "Metric" ] }, { "name": "DescribeMongoDBProcessList", "description": "查询MongoDB实时会话列表", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "实例 ID。可通过 [DescribeDiagDBInstances](https://cloud.tencent.com/document/api/1130/57798) 接口获取。", "example": "cmgo-ag8kko4r" }, { "name": "Product", "type": "string", "required": true, "description": "服务产品类型，支持值：mongodb", "example": "mongodb" }, { "name": "ID", "type": "integer", "required": false, "description": "线程的ID，用于筛选线程列表。", "example": "123" }, { "name": "Host", "type": "string", "required": false, "description": "线程的操作主机地址，用于筛选线程列表。", "example": "127.0.0.1" }, { "name": "DB", "type": "string", "required": false, "description": "线程的操作数据库，用于筛选线程列表,如果是多个 使用 ',' 分割", "example": "test_db" }, { "name": "Type", "type": "string", "required": false, "description": "命令类型 ,如果是多个 使用 ',' 分割", "example": "update" }, { "name": "Time", "type": "integer", "required": false, "description": "线程的操作时长最小值，单位秒，用于筛选操作时长大于该值的线程列表。", "example": "10" }, { "name": "Limit", "type": "integer", "required": false, "description": "返回数量，默认20。", "example": "20" } ], "required": [ "InstanceId", "Product" ] }, { "name": "DescribeMySqlProcessList", "description": "查询关系型数据库的实时线程列表。", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "实例 ID。可通过 [DescribeDiagDBInstances](https://cloud.tencent.com/document/api/1130/57798) 接口获取。", "example": "cdb-c1nl9rpv" }, { "name": "ID", "type": "integer", "required": false, "description": "线程的ID，用于筛选线程列表。", "example": "20" }, { "name": "User", "type": "string", "required": false, "description": "线程的操作账号名，用于筛选线程列表。", "example": "root" }, { "name": "Host", "type": "string", "required": false, "description": "线程的操作主机地址，用于筛选线程列表。", "example": "127.0.0.1:41528" }, { "name": "DB", "type": "string", "required": false, "description": "线程的操作数据库，用于筛选线程列表。", "example": "demo_db" }, { "name": "State", "type": "string", "required": false, "description": "线程的操作状态。包含以下枚举值：Sending data​-线程正在处理查询结果， ​Sorting result​-线程正在对查询结果进行排序​，Creating tmp table​-线程正在创建临时表，Altering table​-线程正在执行表结构变更，Updating-线程执行更新中。", "example": "Updating" }, { "name": "Command", "type": "string", "required": false, "description": "线程的执行类型。包含以下枚举值：Sleep-线程处于空闲状态，Query-线程正在执行一个查询，Connect-从服务器连接到主服务器，Execute-线程正在执行预处理语句。", "example": "Execute" }, { "name": "Time", "type": "integer", "required": false, "description": "线程的操作时长最小值，单位秒，用于筛选操作时长大于该值的线程列表。", "example": "10" }, { "name": "Info", "type": "string", "required": false, "description": "线程的操作语句，用于筛选线程列表。", "example": "DELETE FROM `test` WHERE time\u003c=1" }, { "name": "Limit", "type": "integer", "required": false, "description": "返回数量，默认20。", "example": "20" }, { "name": "Product", "type": "string", "required": false, "description": "服务产品类型，支持值：\"mysql\" - 云数据库 MySQL；\"mariadb\"-mariadb;\"cynosdb\"-TDSQL-C for MySQL ;\"dcdb\"-TDSQL MySQL 默认为\"mysql\"。", "example": "mysql" }, { "name": "StatDimensions", "type": "array", "required": false, "description": "会话统计的维度信息,可以多个维度。", "example": "无", "item_type": "object", "children": [ { "name": "Dimension", "type": "string", "required": true, "description": "维度名称，目前仅支持：SqlTag。", "example": "SqlTag" }, { "name": "Data", "type": "array", "required": false, "description": "SQL 标签过滤与统计信息 示例： 示例 1：[p=position] 统计包含 p=position 标签的 SQL 会话。 示例 2：[p] 统计包含 p 标签的 SQL 会话。 示例 3：[p=position, c=idCard] 统计同时包含 p=position 标签和 c=idCard 标签的 SQL 会话。", "example": "p=postion1", "item_type": "string" } ] } ], "required": [ "InstanceId" ] }, { "name": "DescribeNoPrimaryKeyTables", "description": "查询实例无主键表。", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "实例 ID。可通过 [DescribeDiagDBInstances](https://cloud.tencent.com/document/api/1130/57798) 接口获取。", "example": "cdb-c1nl9rpv" }, { "name": "Date", "type": "string", "required": true, "description": "查询日期，如2021-05-27，最早为30天前的日期。", "example": "2022-04-14" }, { "name": "Limit", "type": "integer", "required": false, "description": "查询数目，默认为20，最大为100。", "example": "20" }, { "name": "Offset", "type": "integer", "required": false, "description": "偏移量，默认为0。", "example": "0" }, { "name": "Product", "type": "string", "required": false, "description": "服务产品类型，支持值：\"mysql\" - 云数据库 MySQL，默认为\"mysql\"。", "example": "mysql" } ], "required": [ "InstanceId", "Date" ] }, { "name": "DescribeProxyProcessStatistics", "description": "获取当前实例下的单个proxy的会话统计详情信息， 返回数据为单个 proxy 的会话统计信息。【注意】该接口仅限部分环境调用。", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "实例 ID 。", "example": "\"crs-2gtest\"" }, { "name": "InstanceProxyId", "type": "string", "required": true, "description": "该实例下需要查询的某一个 ProxyID 。", "example": "\"b237ff3c5f30b0615276f986cc75c045bc\"" }, { "name": "Limit", "type": "integer", "required": true, "description": "返回数量。", "example": "100" }, { "name": "Product", "type": "string", "required": true, "description": "服务产品类型，支持值包括： \"redis\" - 云数据库 Redis。", "example": "\"redis\"" }, { "name": "Offset", "type": "integer", "required": false, "description": "偏移量，默认0。", "example": "0" }, { "name": "SortBy", "type": "string", "required": false, "description": "按照某字段排序。支持值包括：\"AllConn\"，\"ActiveConn\"，\"Ip\"。", "example": "\"AllConn\"" }, { "name": "OrderDirection", "type": "string", "required": false, "description": "排序方向。支持值包括：\"DESC\"，\"ASC\"。", "example": "\"DESC\"" } ], "required": [ "InstanceId", "InstanceProxyId", "Limit", "Product" ] }, { "name": "DescribeProxySessionKillTasks", "description": "用于查询 redis 执行 kill 会话任务后代理节点的执行结果，入参异步任务 ID 从接口 CreateProxySessionKillTask 调用成功后取得。当前 product 只支持：redis。", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "实例ID。", "example": "crs-test1234" }, { "name": "AsyncRequestIds", "type": "array", "required": true, "description": "kill 会话异步任务 ID, 接口 CreateProxySessionKillTask 调用成功后获取。", "example": "[10474110]", "item_type": "integer" }, { "name": "Product", "type": "string", "required": true, "description": "服务产品类型，支持值包括： \"redis\" - 云数据库 Redis。", "example": "redis" } ], "required": [ "InstanceId", "AsyncRequestIds", "Product" ] }, { "name": "DescribeRedisBigKeyAnalysisTasks", "description": "查询redis大key分析任务列表。", "status": "online", "parameters": [ { "name": "Product", "type": "string", "required": true, "description": "服务产品类型，支持值包括 \"redis\" - 云数据库 Redis。", "example": "redis" }, { "name": "InstanceId", "type": "string", "required": true, "description": "实例ID。", "example": "crs-c1nl9rpv" }, { "name": "Limit", "type": "integer", "required": false, "description": "查询数目，默认为20，最大值为100。", "example": "20" }, { "name": "Offset", "type": "integer", "required": false, "description": "偏移量，默认为0。", "example": "0" } ], "required": [ "Product", "InstanceId" ] }, { "name": "DescribeRedisCmdPerfTimeSeries", "description": "延迟分析-命令字分析-查询命令延迟趋势", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "实例 ID。可通过 [DescribeDiagDBInstances](https://cloud.tencent.com/document/api/1130/57798) 接口获取。", "example": "crs-test1214" }, { "name": "Product", "type": "string", "required": true, "description": "服务产品类型，仅仅支持值 \"redis\" - 云数据库 Redis。", "example": "redis" }, { "name": "StartTime", "type": "string", "required": true, "description": "开始时间，如“2025-03-17T00:00:00+00:00”。0天 \u003c 当前服务器时间 - 开始时间 \u003c= 10天。", "example": "2025-03-17T00:00:00+00:00" }, { "name": "EndTime", "type": "string", "required": true, "description": "结束时间，如“2025-03-17T01:00:00+00:00”，0天 \u003c 结束时间 - 开始时间 \u003c= 10天。", "example": "2025-03-17T00:00:00+00:00" }, { "name": "CommandList", "type": "array", "required": true, "description": "需要分析的redis命令", "example": "[\"auth\",\"eval\",\"select\",\"get\",\"incrby\",\"ping\",\"set\"]", "item_type": "string" }, { "name": "Metric", "type": "string", "required": true, "description": "监控指标，包括：qps,latency_p99,latency_avg,latency_max，以逗号分隔 其中： qps - 每秒查询率 latency_p99 - 99分位延迟 latency_avg - 平均延迟 latency_max - 最大延迟", "example": "\"qps,latency_p99,latency_avg,latency_max\"" }, { "name": "Period", "type": "integer", "required": false, "description": "Period，监控指标时间粒度，单位秒，若不提供则根据开始时间和结束时间取默认值", "example": "60" } ], "required": [ "InstanceId", "Product", "StartTime", "EndTime", "CommandList", "Metric" ] }, { "name": "DescribeRedisCommandCostStatistics", "description": "延迟分析-查询命令延迟分布", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "实例 ID。可通过 [DescribeDiagDBInstances](https://cloud.tencent.com/document/api/1130/57798) 接口获取。", "example": "crs-test1214" }, { "name": "StartTime", "type": "string", "required": true, "description": "开始时间，如“2025-03-17T00:00:00+00:00”。0天 \u003c 当前服务器时间 - 开始时间 \u003c= 10天。", "example": "2025-03-17T00:00:00+00:00" }, { "name": "EndTime", "type": "string", "required": true, "description": "结束时间，如“2025-03-17T01:00:00+00:00”，0天 \u003c 结束时间 - 开始时间 \u003c= 10天。", "example": "2025-03-17T00:00:00+00:00" }, { "name": "Product", "type": "string", "required": true, "description": "服务产品类型，仅仅支持值 \"redis\" - 云数据库 Redis。", "example": "redis" } ], "required": [ "InstanceId", "StartTime", "EndTime", "Product" ] }, { "name": "DescribeRedisCommandOverview", "description": "延迟分析-查询实例访问命令统计", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "实例 ID。可通过 [DescribeDiagDBInstances](https://cloud.tencent.com/document/api/1130/57798) 接口获取。", "example": "crs-test1214" }, { "name": "StartTime", "type": "string", "required": true, "description": "开始时间，如“2025-03-17T00:00:00+00:00”。0天 \u003c 当前服务器时间 - 开始时间 \u003c= 10天。", "example": "2025-03-17T00:00:00+00:00" }, { "name": "EndTime", "type": "string", "required": true, "description": "结束时间，如“2025-03-17T01:00:00+00:00”，0天 \u003c 结束时间 - 开始时间 \u003c= 10天。", "example": "2025-03-17T00:00:00+00:00" }, { "name": "Product", "type": "string", "required": true, "description": "服务产品类型，仅仅支持值 \"redis\" - 云数据库 Redis。", "example": "redis" } ], "required": [ "InstanceId", "StartTime", "EndTime", "Product" ] }, { "name": "DescribeRedisProcessList", "description": "获取 Redis 实例所有 proxy 节点的实时会话详情列表。", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "实例 ID。可通过 [DescribeDiagDBInstances](https://cloud.tencent.com/document/api/1130/57798) 接口获取。", "example": "crs-qylqkl4f" }, { "name": "Product", "type": "string", "required": true, "description": "服务产品类型，支持值包括 \"redis\" - 云数据库 Redis。", "example": "redis" }, { "name": "Limit", "type": "integer", "required": false, "description": "查询的Proxy节点数量上限，默认值为20，最大值为50。", "example": "50" }, { "name": "Offset", "type": "integer", "required": false, "description": "Proxy节点的偏移量，默认值为0。", "example": "50" } ], "required": [ "InstanceId", "Product" ] }, { "name": "DescribeRedisSlowLogTopSqls", "description": "统计排序指定时间段内的top慢sql。", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "实例 ID 。", "example": "cdb-test1234" }, { "name": "StartTime", "type": "string", "required": true, "description": "开始时间，如“2019-09-10 12:13:14”。", "example": "2019-01-01 00:00:00" }, { "name": "EndTime", "type": "string", "required": true, "description": "截止时间，如“2019-09-11 10:13:14”，截止时间与开始时间的间隔小于7天。", "example": "2019-01-01 01:00:00" }, { "name": "Product", "type": "string", "required": true, "description": "服务产品类型，支持值： \"redis\" - 云数据库 Redis。", "example": "redis" }, { "name": "InstanceProxyId", "type": "string", "required": false, "description": "Redis Proxy节点ID。", "example": "c8eacc0b41689524298acea949b15aa5ff42c7b7" }, { "name": "SortBy", "type": "string", "required": false, "description": "排序键，支持ExecTimes,QueryTime,QueryTimeMax,QueryTimeAvg等排序键，默认为QueryTime。", "example": "QueryTime" }, { "name": "OrderBy", "type": "string", "required": false, "description": "排序方式，支持ASC（升序）以及DESC（降序），默认为DESC。", "example": "ASC" }, { "name": "Limit", "type": "integer", "required": false, "description": "返回数量，默认为20，最大值为100。", "example": "10" }, { "name": "Offset", "type": "integer", "required": false, "description": "偏移量，默认为0。", "example": "0" } ], "required": [ "InstanceId", "StartTime", "EndTime", "Product" ] }, { "name": "DescribeRedisTopBigKeys", "description": "查询redis实例大key列表。", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "实例 ID。可通过 [DescribeDiagDBInstances](https://cloud.tencent.com/document/api/1130/57798) 接口获取。", "example": "crs-occia4d6" }, { "name": "Product", "type": "string", "required": true, "description": "服务产品类型，支持值包括 \"redis\" - 云数据库 Redis。", "example": "redis" }, { "name": "Date", "type": "string", "required": false, "description": "查询某个日期最新的任务，如2021-05-27，最早可为前30天的日期。该参数与AsyncRequestId参数不可同时为空。", "example": "2022-04-12" }, { "name": "SortBy", "type": "string", "required": false, "description": "排序字段，取值包括Capacity - 内存，ItemCount - 元素数量，默认为Capacity。", "example": "Capacity" }, { "name": "KeyType", "type": "string", "required": false, "description": "key类型筛选条件，默认为不进行筛选，取值包括string, list, set, hash, sortedset, stream。", "example": "string" }, { "name": "Limit", "type": "integer", "required": false, "description": "查询数目，默认为20，最大值为100。", "example": "20" }, { "name": "AsyncRequestId", "type": "integer", "required": false, "description": "异步任务ID。当为空时，选择最近任务的ID。", "example": "7308832" }, { "name": "ShardIds", "type": "array", "required": false, "description": "分片节点序号列表。当列表为空时，选择所有分片节点。", "example": "[1,2]", "item_type": "integer" }, { "name": "UnExpireKey", "type": "boolean", "required": false, "description": "是否仅查询未设置过期时间的大Key。 当为true时，仅查询未设置过期时间的大Key，默认为false。", "example": "false" } ], "required": [ "InstanceId", "Product" ] }, { "name": "DescribeRedisTopCostCommands", "description": "获取指定时间段内Redis 访问命令 cost top N", "status": "online", "parameters": [ { "name": "StartTime", "type": "string", "required": true, "description": "开始时间，如“2021-05-27 00:00:00”，支持的最早查询时间为当前时间的前30天。", "example": "2025-09-03T10:41:59+08:00" }, { "name": "EndTime", "type": "string", "required": true, "description": "结束时间，如“2021-05-27 01:00:00”，支持的最早查询时间为当前时间的前30天。", "example": "2025-09-03T10:41:59+08:00" }, { "name": "InstanceId", "type": "string", "required": true, "description": "实例ID列表。可通过 [DescribeDiagDBInstances](https://cloud.tencent.com/document/api/1130/57798) 接口获取。", "example": "crs-ml76e662g" }, { "name": "Product", "type": "string", "required": true, "description": "服务产品类型，支持值包括：\"mysql\" - 云数据库 MySQL，\"redis\" - 云数据库 Redis，\"mariadb\"-数据库mariadb 默认为\"mysql\"。", "example": "redis" }, { "name": "Limit", "type": "integer", "required": false, "description": "默认前20条", "example": "20" } ], "required": [ "StartTime", "EndTime", "InstanceId", "Product" ] }, { "name": "DescribeRedisTopHotKeys", "description": "热Key分析", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "实例 ID。可通过 [DescribeDiagDBInstances](https://cloud.tencent.com/document/api/1130/57798) 接口获取。", "example": "crs-test1214" }, { "name": "StartTime", "type": "string", "required": true, "description": "开始时间，如“2024-09-22T00:00:00+00:00”。0天 \u003c 当前服务器时间 - 开始时间 \u003c= 10天。", "example": "2024-09-22T00:00:00+00:00" }, { "name": "EndTime", "type": "string", "required": true, "description": "结束时间，如“2024-09-22T01:00:00+00:00”，0天 \u003c 结束时间 - 开始时间 \u003c= 10天。", "example": "2024-09-22T01:00:00+00:00" }, { "name": "Product", "type": "string", "required": true, "description": "服务产品类型，仅仅支持值 \"redis\" - 云数据库 Redis。", "example": "redis" }, { "name": "InstanceNodeIds", "type": "array", "required": false, "description": "Redis 节点数组。", "example": "[\"fa765e5e2e432806328a3e91d591e47097ecd17r\"]", "item_type": "string" }, { "name": "Limit", "type": "integer", "required": false, "description": "top 数目，默认为20，最大值为100。", "example": "20" }, { "name": "Offset", "type": "integer", "required": false, "description": "偏移量，默认为0。", "example": "0" } ], "required": [ "InstanceId", "StartTime", "EndTime", "Product" ] }, { "name": "DescribeRedisTopKeyPrefixList", "description": "查询redis实例top key前缀列表。", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "实例ID。", "example": "crs-c1nl9rpv" }, { "name": "Date", "type": "string", "required": true, "description": "查询日期，如2021-05-27，最早可为前30天的日期。", "example": "2022-04-12" }, { "name": "Product", "type": "string", "required": true, "description": "服务产品类型，支持值包括 \"redis\" - 云数据库 Redis。", "example": "redis" }, { "name": "Limit", "type": "integer", "required": false, "description": "查询数目，默认为20，最大值为500。", "example": "20" }, { "name": "ShardIds", "type": "array", "required": false, "description": "分片ID数组。", "example": "[1]", "item_type": "integer" } ], "required": [ "InstanceId", "Date", "Product" ] }, { "name": "DescribeRedisUnExpiredKeyStatistics", "description": "查询Redis全量Key的内存分布情况。", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "实例 ID。可通过接口获取。", "example": "crs-br63td53" }, { "name": "Product", "type": "string", "required": true, "description": "服务产品类型，支持值包括 \"redis\" - 云数据库 Redis。", "example": "redis" }, { "name": "Date", "type": "string", "required": false, "description": "查询某个日期最新的任务，如2021-05-27，最早可为前30天的日期。该参数与AsyncRequestId参数不可同时为空。", "example": "2026-01-04" }, { "name": "AsyncRequestId", "type": "integer", "required": false, "description": "异步任务ID。当为空时，选择最近任务的ID。", "example": "7200449" }, { "name": "ShardIds", "type": "array", "required": false, "description": "分片节点序号列表。当列表为空时，选择所有分片节点。", "example": "[1]", "item_type": "integer" } ], "required": [ "InstanceId", "Product" ] }, { "name": "DescribeSecurityAuditLogDownloadUrls", "description": "查询安全审计日志导出文件下载链接。目前日志文件下载仅提供腾讯云内网地址，请通过广州地域的腾讯云服务器进行下载。", "status": "online", "parameters": [ { "name": "SecAuditGroupId", "type": "string", "required": true, "description": "安全审计组Id。", "example": "sag-01z37k3f" }, { "name": "AsyncRequestId", "type": "integer", "required": true, "description": "异步任务Id。", "example": "1" }, { "name": "Product", "type": "string", "required": true, "description": "服务产品类型，支持值：\"mysql\" - 云数据库 MySQL。", "example": "mysql" } ], "required": [ "SecAuditGroupId", "AsyncRequestId", "Product" ] }, { "name": "DescribeSecurityAuditLogExportTasks", "description": "查询安全审计日志导出任务列表。", "status": "online", "parameters": [ { "name": "SecAuditGroupId", "type": "string", "required": true, "description": "安全审计组Id。", "example": "sag-01z37k3f" }, { "name": "Product", "type": "string", "required": true, "description": "服务产品类型，支持值：\"mysql\" - 云数据库 MySQL。", "example": "mysql" }, { "name": "AsyncRequestIds", "type": "array", "required": false, "description": "日志导出任务Id列表。", "example": "[1]", "item_type": "integer" }, { "name": "Offset", "type": "integer", "required": false, "description": "偏移量，默认0。", "example": "0" }, { "name": "Limit", "type": "integer", "required": false, "description": "返回数量，默认20，最大值为100。", "example": "10" } ], "required": [ "SecAuditGroupId", "Product" ] }, { "name": "DescribeSlowLogQueryTimeStats", "description": "统计排序指定时间段内的top慢sql。", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "实例 ID。可通过 [DescribeDiagDBInstances](https://cloud.tencent.com/document/api/1130/57798) 接口获取。", "example": "cdb-test1254" }, { "name": "StartTime", "type": "string", "required": true, "description": "开始时间，如“2019-09-10 12:13:14”，截止时间与开始时间的间隔小于7天。", "example": "2019-01-01 00:00:00" }, { "name": "EndTime", "type": "string", "required": true, "description": "截止时间，如“2019-09-11 10:13:14”，截止时间与开始时间的间隔小于7天。", "example": "2019-01-01 01:00:00" }, { "name": "Product", "type": "string", "required": true, "description": "\"mysql\" - 云数据库 MySQL， \"cynosdb\" - 云数据库 TDSQL-C for MySQL，\"redis\" - 云数据库 Redis，\"mongodb\" - 云数据库 MongoDB，默认为\"mysql\"。", "example": "redis" }, { "name": "InstanceProxyId", "type": "string", "required": false, "description": "Proxy节点ID。", "example": "c8eacc0b41689524298acea949b15aa5ff42c7b7" }, { "name": "InstanceNodeId", "type": "string", "required": false, "description": "实例节点ID。", "example": "cmgo-8d8e5c87_0-node-slave0" }, { "name": "Type", "type": "string", "required": false, "description": "查询类型，目前支持值：mongod，mongos。 其中： mongod - MongoDB的数据存储节点 mongos - MongoDB的路由节点", "example": "mongod" } ], "required": [ "InstanceId", "StartTime", "EndTime", "Product" ] }, { "name": "DescribeSlowLogTimeSeriesStats", "description": "获取慢日志统计柱状图。", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "实例 ID 。", "example": "cdb-test1234" }, { "name": "StartTime", "type": "string", "required": true, "description": "开始时间，如“2019-09-10 12:13:14”。", "example": "2019-01-01 00:00:00" }, { "name": "EndTime", "type": "string", "required": true, "description": "结束时间，如“2019-09-10 12:13:14”，结束时间与开始时间的间隔最大可为7天。", "example": "2019-01-01 01:00:00" }, { "name": "Product", "type": "string", "required": false, "description": "服务产品类型，支持值包括： \"mysql\" - 云数据库 MySQL， \"cynosdb\" - 云数据库 CynosDB for MySQL，\"redis\" - 云数据库 Redis，\"mongodb\" - 云数据库 MongoDB，默认为\"mysql\"。", "example": "mysql" }, { "name": "InstanceProxyId", "type": "string", "required": false, "description": "Proxy节点ID。", "example": "c8eacc0b41689524298acea949b15aa5ff42c7b7" }, { "name": "InstanceNodeId", "type": "string", "required": false, "description": "实列节点ID。", "example": "cmgo-8d8e5c87_0-node-slave0\t" }, { "name": "Type", "type": "string", "required": false, "description": "查询类型，目前支持值：mongod，mongos。", "example": "mongod" } ], "required": [ "InstanceId", "StartTime", "EndTime" ] }, { "name": "DescribeSlowLogTopSqls", "description": "按照Sql模板+schema的聚合方式，统计排序指定时间段内的top慢sql。", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "实例 ID 。", "example": "cdb-test1234" }, { "name": "StartTime", "type": "string", "required": true, "description": "开始时间，如“2019-09-10 12:13:14”。", "example": "2019-01-01 00:00:00" }, { "name": "EndTime", "type": "string", "required": true, "description": "截止时间，如“2019-09-11 10:13:14”，截止时间与开始时间的间隔小于7天。", "example": "2019-01-01 01:00:00" }, { "name": "SortBy", "type": "string", "required": false, "description": "排序键，目前支持 QueryTime,ExecTimes,RowsSent,LockTime以及RowsExamined 等排序键，默认为QueryTime。", "example": "QueryTime" }, { "name": "OrderBy", "type": "string", "required": false, "description": "排序方式，支持ASC（升序）以及DESC（降序），默认为DESC。", "example": "ASC" }, { "name": "Limit", "type": "integer", "required": false, "description": "返回数量，默认为20，最大值为100。", "example": "10" }, { "name": "Offset", "type": "integer", "required": false, "description": "偏移量，默认为0。", "example": "0" }, { "name": "SchemaList", "type": "array", "required": false, "description": "数据库名称数组。", "example": "无", "item_type": "object", "children": [ { "name": "Schema", "type": "string", "required": true, "description": "数据库名称", "example": "dbName" } ] }, { "name": "Product", "type": "string", "required": false, "description": "服务产品类型，支持值包括： \"mysql\" - 云数据库 MySQL， \"cynosdb\" - 云数据库 CynosDB for MySQL，默认为\"mysql\"。", "example": "mysql" } ], "required": [ "InstanceId", "StartTime", "EndTime" ] }, { "name": "DescribeSlowLogUserHostStats", "description": "获取慢日志来源地址统计分布图。", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "实例 ID。可通过 [DescribeDiagDBInstances](https://cloud.tencent.com/document/api/1130/57798) 接口获取。", "example": "cdb-c1nl9rpv" }, { "name": "StartTime", "type": "string", "required": true, "description": "查询范围的开始时间，格式: \"yyyy-MM-dd'T'HH:mm:ssXXX\"。", "example": "2019-09-10T12:13:14+08:00" }, { "name": "EndTime", "type": "string", "required": true, "description": "查询范围的结束时间，格式: \"yyyy-MM-dd'T'HH:mm:ssXXX\"。", "example": "2019-09-10T12:13:14+08:00" }, { "name": "Product", "type": "string", "required": false, "description": "服务产品类型，支持值：\"mysql\" - 云数据库 MySQL；\"cynosdb\" - 云数据库 TDSQL-C for MySQL，默认为\"mysql\"。", "example": "mysql" }, { "name": "Md5", "type": "string", "required": false, "description": "SQL模板的MD5值", "example": "AD7651E51E8C6FBA" }, { "name": "InstanceProxyId", "type": "string", "required": false, "description": "仅Redis产品使用；实例Proxy ID。", "example": "ca7848437614df37a3365afaeb98dcf9baaae983" }, { "name": "Cmd", "type": "string", "required": false, "description": "仅Redis产品使用；命令。", "example": "set" } ], "required": [ "InstanceId", "StartTime", "EndTime" ] }, { "name": "DescribeSlowLogs", "description": "获取指定时间内某个sql模板的慢日志明细", "status": "online", "parameters": [ { "name": "Product", "type": "string", "required": true, "description": "服务产品类型，支持值包括： \"mysql\" - 云数据库 MySQL， \"cynosdb\" - 云数据库 CynosDB for MySQL，默认为\"mysql\"。", "example": "mysql" }, { "name": "InstanceId", "type": "string", "required": true, "description": "实例id。", "example": "cdb-insde12" }, { "name": "Md5", "type": "string", "required": true, "description": "sql模板的md5值", "example": "2693831786114179882" }, { "name": "StartTime", "type": "string", "required": true, "description": "开始时间，如“2019-09-10 12:13:14”。", "example": "2025-09-02T01:14:01+08:00" }, { "name": "EndTime", "type": "string", "required": true, "description": "截止时间，如“2019-09-11 10:13:14”，截止时间与开始时间的间隔小于7天。", "example": "2025-09-02T01:15:01+08:00" }, { "name": "Offset", "type": "integer", "required": true, "description": "偏移量，默认为0。", "example": "0" }, { "name": "Limit", "type": "integer", "required": true, "description": "查询数目，默认为20，最大为100。", "example": "20" }, { "name": "DB", "type": "array", "required": false, "description": "数据库列表", "example": "[\"db\"]", "item_type": "string" }, { "name": "Key", "type": "array", "required": false, "description": "关键字", "example": "[\"select\"]", "item_type": "string" }, { "name": "User", "type": "array", "required": false, "description": "用户", "example": "[\"user1\",\"user2\"]", "item_type": "string" }, { "name": "Ip", "type": "array", "required": false, "description": "IP", "example": "[\"127.0.0.1\"]", "item_type": "string" }, { "name": "Time", "type": "array", "required": false, "description": "耗时区间,耗时区间的左右边界分别对应数组的第0个元素和第一个元素", "example": "[2,4]", "item_type": "integer" } ], "required": [ "Product", "InstanceId", "Md5", "StartTime", "EndTime", "Offset", "Limit" ] }, { "name": "DescribeSqlFilters", "description": "查询实例SQL限流任务列表。", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "实例 ID。可通过 [DescribeDiagDBInstances](https://cloud.tencent.com/document/api/1130/57798) 接口获取。", "example": "cdb-c1nl9rpv" }, { "name": "FilterIds", "type": "array", "required": false, "description": "任务ID列表，用于筛选任务列表。", "example": "[1234]", "item_type": "integer" }, { "name": "Statuses", "type": "array", "required": false, "description": "任务状态列表，用于筛选任务列表，取值包括RUNNING - 运行中, FINISHED - 已完成, TERMINATED - 已终止。", "example": "[\"RUNNING\"]", "item_type": "string" }, { "name": "Offset", "type": "integer", "required": false, "description": "偏移量，默认为0。", "example": "0" }, { "name": "Limit", "type": "integer", "required": false, "description": "返回数量，默认为20，最大值为100。", "example": "20" }, { "name": "Product", "type": "string", "required": false, "description": "服务产品类型，支持值：\"mysql\" - 云数据库 MySQL；\"cynosdb\" - 云数据库 TDSQL-C for MySQL，默认为\"mysql\"。", "example": "mysql" } ], "required": [ "InstanceId" ] }, { "name": "DescribeSqlTemplate", "description": "查询SQL模板。", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "实例 ID。可通过 [DescribeDiagDBInstances](https://cloud.tencent.com/document/api/1130/57798) 接口获取。", "example": "cdb-test1214" }, { "name": "Schema", "type": "string", "required": true, "description": "数据库名。", "example": "demo_db" }, { "name": "SqlText", "type": "string", "required": true, "description": "SQL语句。", "example": "select * from test limit 10" }, { "name": "Product", "type": "string", "required": false, "description": "服务产品类型，支持值包括： \"mysql\" - 云数据库 MySQL， \"cynosdb\" - 云数据库 CynosDB for MySQL，默认为\"mysql\"。", "example": "mysql" } ], "required": [ "InstanceId", "Schema", "SqlText" ] }, { "name": "DescribeTopSpaceSchemaTimeSeries", "description": "获取实例占用空间最大的前几个库在指定时间段内的每日由DBbrain定时采集的空间数据，默认返回按大小排序。", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "实例ID。", "example": "cdb-c1nl9rpv" }, { "name": "Limit", "type": "integer", "required": false, "description": "返回的Top库数量，最大值为100，默认为20。", "example": "100" }, { "name": "SortBy", "type": "string", "required": false, "description": "筛选Top库所用的排序字段，可选字段包含DataLength、IndexLength、TotalLength、DataFree、FragRatio、TableRows、PhysicalFileSize（仅云数据库 MySQL实例支持），云数据库 MySQL实例默认为 PhysicalFileSize，其他产品实例默认为TotalLength。", "example": "TableRows" }, { "name": "StartDate", "type": "string", "required": false, "description": "开始日期，如“2021-01-01”，最早为当日的前第29天，默认为截止日期的前第6天。", "example": "2021-01-01" }, { "name": "EndDate", "type": "string", "required": false, "description": "截止日期，如“2021-01-01”，最早为当日的前第29天，默认为当日。", "example": "2021-01-01" }, { "name": "Product", "type": "string", "required": false, "description": "服务产品类型，支持值包括： \"mysql\" - 云数据库 MySQL， \"cynosdb\" - 云数据库 CynosDB for MySQL，默认为\"mysql\"。", "example": "mysql" } ], "required": [ "InstanceId" ] }, { "name": "DescribeTopSpaceSchemas", "description": "获取实例Top库的实时空间统计信息，默认返回按大小排序。", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "实例 ID。可通过 [DescribeDiagDBInstances](https://cloud.tencent.com/document/api/1130/57798) 接口获取。", "example": "cdb-c1nl9rpv" }, { "name": "Limit", "type": "integer", "required": false, "description": "返回的Top库数量，最大值为100，默认为20。", "example": "100" }, { "name": "SortBy", "type": "string", "required": false, "description": "筛选Top库所用的排序字段，可选字段包含DataLength、IndexLength、TotalLength、DataFree、FragRatio、TableRows、PhysicalFileSize（仅云数据库 MySQL实例支持），云数据库 MySQL实例默认为 PhysicalFileSize，其他产品实例默认为TotalLength。 其中： DataLength - 数据长度 IndexLength - 索引长度 TotalLength - 总长度 DataFree - 空闲空间 FragRatio - 碎片率 TableRows - 表行数 PhysicalFileSize - 物理文件大小", "example": "TableRows" }, { "name": "Product", "type": "string", "required": false, "description": "服务产品类型，支持值包括： \"mysql\" - 云数据库 MySQL， \"cynosdb\" - 云数据库 CynosDB for MySQL，默认为\"mysql\"。", "example": "mysql" } ], "required": [ "InstanceId" ] }, { "name": "DescribeTopSpaceTableTimeSeries", "description": "获取实例占用空间最大的前几张表在指定时间段内的每日由DBbrain定时采集的空间数据，默认返回按大小排序。", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "实例 ID 。", "example": "cdb-test1234" }, { "name": "Limit", "type": "integer", "required": false, "description": "返回的Top表数量，最大值为100，默认为20。", "example": "2" }, { "name": "SortBy", "type": "string", "required": false, "description": "筛选Top表所用的排序字段，可选字段包含DataLength、IndexLength、TotalLength、DataFree、FragRatio、TableRows、PhysicalFileSize，默认为 PhysicalFileSize。", "example": "TableRows" }, { "name": "StartDate", "type": "string", "required": false, "description": "开始日期，如“2021-01-01”，最早为当日的前第29天，默认为截止日期的前第6天。", "example": "2020-01-01" }, { "name": "EndDate", "type": "string", "required": false, "description": "截止日期，如“2021-01-01”，最早为当日的前第29天，默认为当日。", "example": "2020-01-01" }, { "name": "Product", "type": "string", "required": false, "description": "服务产品类型，支持值包括： \"mysql\" - 云数据库 MySQL， \"cynosdb\" - 云数据库 CynosDB for MySQL，默认为\"mysql\"。", "example": "mysql" } ], "required": [ "InstanceId" ] }, { "name": "DescribeTopSpaceTables", "description": "获取实例Top表的实时空间统计信息，默认返回按大小排序。", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "实例 ID。可通过 [DescribeDiagDBInstances](https://cloud.tencent.com/document/api/1130/57798) 接口获取。", "example": "cdb-test1214" }, { "name": "Limit", "type": "integer", "required": false, "description": "返回的Top表数量，最大值为100，默认为20。", "example": "2" }, { "name": "SortBy", "type": "string", "required": false, "description": "筛选Top表所用的排序字段，可选字段包含DataLength、IndexLength、TotalLength、DataFree、FragRatio、TableRows、PhysicalFileSize（仅云数据库 MySQL实例支持），云数据库 MySQL实例默认为 PhysicalFileSize，其他产品实例默认为TotalLength。 其中： DataLength - 数据长度 IndexLength - 索引长度 TotalLength - 总长度 DataFree - 空闲空间 FragRatio - 碎片率 TableRows - 表行数 PhysicalFileSize - 物理文件大小", "example": "TableRows" }, { "name": "Product", "type": "string", "required": false, "description": "服务产品类型，支持值包括： \"mysql\" - 云数据库 MySQL， \"cynosdb\" - 云数据库 CynosDB for MySQL，默认为\"mysql\"。", "example": "mysql" } ], "required": [ "InstanceId" ] }, { "name": "DescribeUserAutonomyProfile", "description": "自治中心-终止自治任务（单次）；注意： 接口调用需要加白名单。", "status": "online", "parameters": [ { "name": "ProfileType", "type": "string", "required": true, "description": "配置类型，为需要配置的功能枚举值，目前包含一下枚举值：AutonomyGlobal（自治功能全局配置）、RedisAutoScaleUp（Redis自治扩容配置）。", "example": "redis_mo" }, { "name": "InstanceId", "type": "string", "required": true, "description": "实列ID。", "example": "crs-qtmkik3e" }, { "name": "Product", "type": "string", "required": true, "description": "服务产品类型，支持值包括： \"redis\" - 云数据库 Redis。", "example": "redis" } ], "required": [ "ProfileType", "InstanceId", "Product" ] }, { "name": "DescribeUserSqlAdvice", "description": "获取SQL优化建议。【产品用户回馈，此接口限免开放，后续将并入dbbrain专业版】", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "实例 ID。可通过 [DescribeDiagDBInstances](https://cloud.tencent.com/document/api/1130/57798) 接口获取。", "example": "cdb-c1nl9rpv" }, { "name": "SqlText", "type": "string", "required": true, "description": "SQL语句。", "example": "select * from t1" }, { "name": "Schema", "type": "string", "required": false, "description": "库名。", "example": "demo_db" }, { "name": "Product", "type": "string", "required": false, "description": "服务产品类型，支持值：\"mysql\" - 云数据库 MySQL；\"cynosdb\" - 云数据库 TDSQL-C for MySQL；\"dbbrain-mysql\" - 自建 MySQL，默认为\"mysql\"。", "example": "mysql" } ], "required": [ "InstanceId", "SqlText" ] }, { "name": "KillMySqlThreads", "description": "根据会话ID中断当前会话，该接口分为两次提交：第一次为预提交阶段，Stage为\"Prepare\"，得到的返回值包含SqlExecId；第二次为确认提交， Stage为\"Commit\"， 将SqlExecId的值作为参数传入，最终终止会话进程。", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "实例 ID。可通过 [DescribeDiagDBInstances](https://cloud.tencent.com/document/api/1130/57798) 接口获取。", "example": "cdb-test1" }, { "name": "Stage", "type": "string", "required": true, "description": "kill会话任务的阶段，取值包括：\"Prepare\"-准备阶段，\"Commit\"-提交阶段。", "example": "Commit" }, { "name": "Threads", "type": "array", "required": false, "description": "需要kill的sql会话ID列表，通过接口[查询实时线程列表](https://cloud.tencent.com/document/product/1130/57824) 此参数用于Prepare阶段。", "example": "[4714056]", "item_type": "integer" }, { "name": "SqlExecId", "type": "string", "required": false, "description": "执行ID，此参数用于Commit阶段。", "example": "ItNrO0i3lvE3" }, { "name": "Product", "type": "string", "required": false, "description": "服务产品类型，支持值包括： \"mysql\" - 云数据库 MySQL， \"cynosdb\" - 云数据库 CynosDB for MySQL，默认为\"mysql\"。", "example": "mysql" }, { "name": "RecordHistory", "type": "boolean", "required": false, "description": "默认是true，会记录下kill的记录；该参数为true, 则在kill操作前校验目标会话是否存在，存在则继续kill，否则取消kill。为了加快kill速度，可设置为false。", "example": "false" } ], "required": [ "InstanceId", "Stage" ] }, { "name": "ModifyAlarmPolicy", "description": "修改告警策略", "status": "online", "parameters": [ { "name": "ApplyType", "type": "string", "required": true, "description": "策略类型，固定值：instance， instance-代表实例类型策略", "example": "instance" }, { "name": "Enable", "type": "integer", "required": true, "description": "策略是否开启，0-代表开启，1-代表关闭", "example": "1" }, { "name": "InstanceIds", "type": "array", "required": true, "description": "实例id列表，可通过 [DescribeDiagDBInstances](https://cloud.tencent.com/document/api/1130/57798) 接口获取。", "example": "无", "item_type": "object", "children": [ { "name": "InstanceId", "type": "string", "required": false, "description": "实例id", "example": "cdb-dxnfjfks" } ] }, { "name": "NewProfileLevel", "type": "string", "required": true, "description": "User-动态关联该用户所有实例 Instance-关联实例列表的实例", "example": "Instance" }, { "name": "NewProfileName", "type": "string", "required": true, "description": "新策略名，包含中文英文数字，长度在60个字符以内，不能以“_”开头。", "example": "demoProfileName" }, { "name": "ProfileName", "type": "string", "required": true, "description": "旧策略名，包含中文英文数字，长度在60个字符以内，不能以“_”开头。", "example": "oldProfileName" }, { "name": "ProfileType", "type": "string", "required": true, "description": "策略类型，固定值：alarm_policy", "example": "alarm_policy" }, { "name": "Remark", "type": "string", "required": true, "description": "备注", "example": "demo profile" }, { "name": "RuleType", "type": "integer", "required": true, "description": "规则类型 0-快速，1-自定义 若值为0，则QuickRule不能为空，若值为1，则Rules 不能为空", "example": "0" }, { "name": "TemplateInfo", "type": "array", "required": true, "description": "接受模板", "example": "无", "item_type": "object", "children": [ { "name": "TemplateId", "type": "string", "required": true, "description": "模板id,通过接口[通知模板查询](https://cloud.tencent.com/document/product/1130/97726)获得。", "example": "23002" }, { "name": "TemplateName", "type": "string", "required": true, "description": "模板名,通过接口[通知模板查询](https://cloud.tencent.com/document/product/1130/97726)获得。", "example": "demoTemplate" } ] }, { "name": "QuickRule", "type": "string", "required": false, "description": "快速规则 支持包括fatal-致命, critical-严重, warning-告警, information-通知，与Rules互斥", "example": "fatal" }, { "name": "Rules", "type": "array", "required": false, "description": "自定义规则，与QuickRule互斥。", "example": "无", "item_type": "object", "children": [ { "name": "Interval", "type": "integer", "required": true, "description": "间隔", "example": "0" }, { "name": "Name", "type": "string", "required": true, "description": "告警名", "example": "磁盘空间利用率" }, { "name": "Metric", "type": "string", "required": true, "description": "指标", "example": "SpaceUsage" }, { "name": "Operator", "type": "string", "required": true, "description": "操作符", "example": "\u003e" }, { "name": "Severity", "type": "string", "required": true, "description": "等级 fatal-致命 critical-严重 warning-告警 information-通知", "example": "warning" }, { "name": "Value", "type": "float", "required": false, "description": "指标值", "example": "80" } ] } ], "required": [ "ApplyType", "Enable", "InstanceIds", "NewProfileLevel", "NewProfileName", "ProfileName", "ProfileType", "Remark", "RuleType", "TemplateInfo" ] }, { "name": "ModifyAuditService", "description": "修改审计配置相关信息，如高频存储时长等", "status": "online", "parameters": [ { "name": "Product", "type": "string", "required": true, "description": "服务产品类型，支持值包括： \"dcdb\" - 云数据库 Tdsql， \"mariadb\" - 云数据库 MariaDB。", "example": "dcdb" }, { "name": "NodeRequestType", "type": "string", "required": true, "description": "与Product保持一致。如：\"dcdb\" ,\"mariadb\"。", "example": "dcdb" }, { "name": "InstanceId", "type": "string", "required": true, "description": "实例ID。", "example": "tdsql-njshdu" }, { "name": "LogExpireDay", "type": "integer", "required": true, "description": "日志保存总时长，只能是7,30,90,180,365,1095,1825。", "example": "30" }, { "name": "HotLogExpireDay", "type": "integer", "required": true, "description": "高频日志保存时长，只能是7,30,90,180,365,1095,1825。", "example": "7" } ], "required": [ "Product", "NodeRequestType", "InstanceId", "LogExpireDay", "HotLogExpireDay" ] }, { "name": "ModifyDiagDBInstanceConf", "description": "修改实例的配置信息。", "status": "online", "parameters": [ { "name": "InstanceConfs", "type": "object", "required": true, "description": "实例配置，包括巡检、概览开关等。", "example": "无", "children": [ { "name": "DailyInspection", "type": "string", "required": false, "description": "数据库巡检开关, Yes/No。", "example": "Yes" }, { "name": "OverviewDisplay", "type": "string", "required": false, "description": "实例概览开关，Yes/No。", "example": "Yes" }, { "name": "KeyDelimiters", "type": "array", "required": false, "description": "redis大key分析的自定义分割符，仅redis使用", "example": "[\",\",\";\",\":\",\"+\",\"@\",\"=\",\"|\",\"#\",\".\"]", "item_type": "string" }, { "name": "ShardNum", "type": "string", "required": false, "description": "分片节点数量。", "example": "3" }, { "name": "AnalysisTopKey", "type": "string", "required": false, "description": "是否开启大key周期性分析，仅redis产品有效。", "example": "Yes" } ] }, { "name": "Regions", "type": "string", "required": true, "description": "生效实例地域，固定为\"All\"，代表全地域。", "example": "All" }, { "name": "Product", "type": "string", "required": true, "description": "服务产品类型，支持值包括： \"mysql\" - 云数据库 MySQL， \"cynosdb\" - 云数据库 CynosDB for MySQL，\"redis\" - 云数据库 Redis。", "example": "mysql" }, { "name": "InstanceIds", "type": "array", "required": false, "description": "指定更改巡检状态的实例ID。 可通过 [DescribeDiagDBInstances](https://cloud.tencent.com/document/api/1130/57798) 接口获取。", "example": "[\"cdb-fyclrp7rn\"]", "item_type": "string" } ], "required": [ "InstanceConfs", "Regions", "Product" ] }, { "name": "ModifySqlFilters", "description": "更改实例限流任务状态，目前仅用于终止限流。", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "实例 ID。可通过 [DescribeDiagDBInstances](https://cloud.tencent.com/document/api/1130/57798) 接口获取。", "example": "cdb-c1nl9rpv" }, { "name": "FilterIds", "type": "array", "required": true, "description": "SQL限流任务ID列表。可通过接口[查询实例SQL限流任务列表 ](https://cloud.tencent.com/document/product/1130/72831)获得。", "example": "[1433288]", "item_type": "integer" }, { "name": "Status", "type": "string", "required": true, "description": "限流任务状态，仅支持传参TERMINATED - 终止。", "example": "TERMINATED" }, { "name": "SessionToken", "type": "string", "required": false, "description": "通过 [VerifyUserAccount](https://cloud.tencent.com/document/product/1130/72828) 获取有效期为5分钟的会话token，使用后会自动延长token有效期至五分钟后。", "example": "cauth" }, { "name": "Product", "type": "string", "required": false, "description": "服务产品类型，支持值：\"mysql\" - 云数据库 MySQL；\"cynosdb\" - 云数据库 TDSQL-C for MySQL，默认为\"mysql\"。", "example": "mysql" } ], "required": [ "InstanceId", "FilterIds", "Status" ] }, { "name": "ModifyUserAutonomyProfile", "description": "自治中心-终止自治任务（单次）；注意：接口需要加白名单。", "status": "online", "parameters": [ { "name": "ProfileType", "type": "string", "required": true, "description": "配置类型，为需要配置的功能枚举值，目前包含一下枚举值：AutonomyGlobal（自治功能全局配置）、RedisAutoScaleUp（Redis自治扩容配置）", "example": "RedisAutoScaleUp" }, { "name": "InstanceId", "type": "string", "required": true, "description": "实例 ID。可通过 [DescribeDiagDBInstances](https://cloud.tencent.com/document/api/1130/57798) 接口获取。", "example": "crs-qtmkik3e" }, { "name": "Product", "type": "string", "required": true, "description": "服务产品类型，支持值包括： \"redis\" - 云数据库 Redis。", "example": "redis" }, { "name": "NewProfileInfo", "type": "string", "required": false, "description": "自治功能相关配置，标准JSON字符串格式。", "example": "{ \"MemoryUpperLimit\": 512, \"Version\": 0, \"Enabled\": true, \"Uin\": \"100013717858\", \"ThresholdRule\": { \"Duration\": 900, \"Metric\": \"mem_util\", \"Threshold\": 50 } }" } ], "required": [ "ProfileType", "InstanceId", "Product" ] }, { "name": "OpenAuditService", "description": "开启数据库审计服务", "status": "online", "parameters": [ { "name": "Product", "type": "string", "required": true, "description": "服务产品类型，支持值包括： \"dcdb\" - 云数据库 Tdsql， \"mariadb\" - 云数据库 MariaDB。", "example": "dcdb" }, { "name": "NodeRequestType", "type": "string", "required": true, "description": "与Product保持一致。如：\"dcdb\" ,\"mariadb\"。", "example": "dcdb" }, { "name": "InstanceId", "type": "string", "required": true, "description": "实例ID。", "example": "tdsql-njshdu" }, { "name": "LogExpireDay", "type": "integer", "required": true, "description": "日志保存总时长，只能是7,30,90,180,365,1095,1825。", "example": "30" }, { "name": "HotLogExpireDay", "type": "integer", "required": true, "description": "高频日志保存时长，只能是7,30,90,180,365,1095,1825。", "example": "7" } ], "required": [ "Product", "NodeRequestType", "InstanceId", "LogExpireDay", "HotLogExpireDay" ] }, { "name": "UpdateAgentSwitch", "description": "更新agent状态（停止或重连Agent）", "status": "online", "parameters": [ { "name": "AgentId", "type": "string", "required": true, "description": "Agent标识。可通过 [DescribeDiagDBInstances](https://cloud.tencent.com/document/api/1130/57798) 接口获取。", "example": "a6a7fccd-3cca-4310-b31e-2a60598d3414" }, { "name": "Switch", "type": "string", "required": true, "description": "停止或重连Agent，支持值包括：\"on\" - 重连Agent， \"off\" - 停止Agent。", "example": "on" }, { "name": "Product", "type": "string", "required": true, "description": "服务产品类型，仅支持 \"dbbrain-mysql\" - 自建MySQL。", "example": "dbbrain-mysql" } ], "required": [ "AgentId", "Switch", "Product" ] }, { "name": "UpdateMonitorSwitch", "description": "更新Agent实例状态（停止或重连实例）", "status": "online", "parameters": [ { "name": "Switch", "type": "string", "required": true, "description": "停止或重连Agent实例，支持值包括：\"on\" - 重连实例， \"off\" - 停止实例。", "example": "on" }, { "name": "InstanceId", "type": "string", "required": true, "description": "实例 ID。可通过 [DescribeDiagDBInstances](https://cloud.tencent.com/document/api/1130/57798) 接口获取。", "example": "mysql-069yc1dda" }, { "name": "Product", "type": "string", "required": true, "description": "服务产品类型，仅支持 \"dbbrain-mysql\" - 自建MySQL。", "example": "dbbrain-mysql" } ], "required": [ "Switch", "InstanceId", "Product" ] }, { "name": "VerifyUserAccount", "description": "验证用户数据库账号权限，获取会话token。", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "实例 ID。可通过 [DescribeDiagDBInstances](https://cloud.tencent.com/document/api/1130/57798) 接口获取。", "example": "cdb-c1nl9rpv" }, { "name": "User", "type": "string", "required": true, "description": "数据库账号名。", "example": "root" }, { "name": "Password", "type": "string", "required": true, "description": "数据库账号密码。", "example": "t121416" }, { "name": "Product", "type": "string", "required": false, "description": "服务产品类型，支持值：\"mysql\" - 云数据库 MySQL；\"cynosdb\" - 云数据库 TDSQL-C for MySQL，默认为\"mysql\"。", "example": "mysql" } ], "required": [ "InstanceId", "User", "Password" ] } ] }