{ "name": "mongodb", "display_name": "云数据库 MongoDB", "description": "介绍如何使用 API 对云数据库 MongoDB 进行操作，包括创建实例询价、创建云数据库实例、续费云数据库实例等。", "domain": "database", "api_version": "2019-07-25", "endpoint": "mongodb.tencentcloudapi.com", "actions": [ { "name": "AssignProject", "description": "本接口(AssignProject)用于指定云数据库实例的所属项目。", "status": "online", "parameters": [ { "name": "InstanceIds", "type": "array", "required": true, "description": "实例 ID 列表，请登录[MongoDB 控制台](https://console.cloud.tencent.com/mongodb)在实例列表复制实例 ID。", "example": "[\"cmgo-eqmo****\"]", "item_type": "string" }, { "name": "ProjectId", "type": "integer", "required": true, "description": "项目ID，用户已创建项目的唯一ID。请在控制台账号中心的[项目管理](https://console.cloud.tencent.com/project)中复制项目 ID。", "example": "12" } ], "required": [ "InstanceIds", "ProjectId" ] }, { "name": "CloseAuditService", "description": "本接口（CloseAuditService）用于关闭审计服务", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "实例ID，格式如：cmgo-test1234，与云数据库控制台页面中显示的实例 ID 相同。", "example": "cmgo-l0w4****" } ], "required": [ "InstanceId" ] }, { "name": "CreateAccountUser", "description": "本接口（CreateAccountUser）用于自定义实例访问账号。", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "实例 ID。例如：cmgo-p8vn****。请登录 [MongoDB 控制台](https://console.cloud.tencent.com/mongodb)在实例列表复制实例 ID。", "example": "cmgo-7pjedvz7" }, { "name": "UserName", "type": "string", "required": true, "description": "新账号名称。其格式要求如下： - 字符范围[1,64]。 - 可输入[A,Z]、[a,z]、[1,9]范围的字符以及下划线“\\_”与短划线“-”。", "example": "mong_test" }, { "name": "Password", "type": "string", "required": true, "description": "新账号密码。密码复杂度要求如下： - 字符长度范围[8,32]。 - 至少包含字母、数字和特殊字符（叹号“!”、at\"@\"、井号“#”、百分号“%”、插入符“^”、星号“\\*”、小括号“()”、下划线“\\_”）中的两种。", "example": "password" }, { "name": "MongoUserPassword", "type": "string", "required": false, "description": "mongouser 账号对应的密码。mongouser 为系统默认账号，即为创建实例时，设置的密码。", "example": "password..." }, { "name": "UserDesc", "type": "string", "required": false, "description": "账号备注信息。", "example": "测试账号" }, { "name": "AuthRole", "type": "array", "required": false, "description": "账号的读写权限信息。", "example": "无", "item_type": "object", "children": [ { "name": "Mask", "type": "integer", "required": true, "description": "当前账号具有的权限信息。 - 0：无权限。 - 1：只读。 - 3：读写。 注意：此字段可能返回 null，表示取不到有效值。", "example": "1" }, { "name": "NameSpace", "type": "string", "required": true, "description": "指具有当前账号权限的数据库名。 - \\* ：表示所有数据库。 - db.name：表示特定 name 的数据库。 注意：此字段可能返回 null，表示取不到有效值。", "example": "\"db_test\"" } ] } ], "required": [ "InstanceId", "UserName", "Password" ] }, { "name": "CreateAuditLogFile", "description": "本接口(CreateAuditLogFile)用于创建云数据库实例的审计日志文件。", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "实例 ID，格式如：cmgo-xfts****，与云数据库控制台页面中显示的实例 ID 相同。", "example": "cmgo-c1nl****" }, { "name": "StartTime", "type": "string", "required": true, "description": "开始时间，格式为：\"2021-07-12 10:29:20\"。", "example": "2021-07-12 10:29:20" }, { "name": "EndTime", "type": "string", "required": true, "description": "结束时间，格式为：\"2021-07-12 10:39:20\"。", "example": "2017-07-12 10:39:20" }, { "name": "Order", "type": "string", "required": false, "description": "审计日志文件的排序方式。 ASC：升序。DESC：降序。", "example": "ASC" }, { "name": "OrderBy", "type": "string", "required": false, "description": "审计日志文件的排序字段。当前支持的取值包括： timestamp：时间戳。affectRows：影响行数。execTime：执行时间。", "example": "timestamp" }, { "name": "Filter", "type": "object", "required": false, "description": "过滤条件。可按设置的过滤条件过滤审计日志。", "example": "无", "children": [ { "name": "Host", "type": "array", "required": false, "description": "客户端地址。", "example": "[\"10.1.11.12\"]", "item_type": "string" }, { "name": "User", "type": "array", "required": false, "description": "用户名。", "example": "[\"mongouser\"]", "item_type": "string" }, { "name": "ExecTime", "type": "integer", "required": false, "description": "执行时间。单位为：ms。表示筛选执行时间大于该值的审计日志。", "example": "10" }, { "name": "AffectRows", "type": "integer", "required": false, "description": "影响行数。表示筛选影响行数大于该值的审计日志。", "example": "1" }, { "name": "Atype", "type": "array", "required": false, "description": "操作类型。", "example": "[\"insert\"]", "item_type": "string" }, { "name": "Result", "type": "array", "required": false, "description": "执行结果。", "example": "[\"0\"]", "item_type": "string" }, { "name": "Param", "type": "array", "required": false, "description": "根据此关键字过滤日志", "example": "[\"insert\"]", "item_type": "string" } ] } ], "required": [ "InstanceId", "StartTime", "EndTime" ] }, { "name": "CreateBackupDBInstance", "description": "本接口（CreateBackupDBInstance）用于备份实例。", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "实例 ID。例如：cmgo-p8vn****。请登录 [MongoDB 控制台](https://console.cloud.tencent.com/mongodb)在实例列表复制实例 ID。", "example": "cmgo-ayxpky6l" }, { "name": "BackupMethod", "type": "integer", "required": true, "description": "设置备份方式。 - 0：逻辑备份。 - 1：物理备份。 - 3：快照备份。 **说明**: 1. 通用版实例支持逻辑备份与物理备份。云盘版实例支持物理备份与快照备份，暂不支持逻辑备份。 2. 实例开通存储加密，则备份方式不能为物理备份。", "example": "0" }, { "name": "BackupRemark", "type": "string", "required": false, "description": "备份备注信息。", "example": "remarkInfo" } ], "required": [ "InstanceId", "BackupMethod" ] }, { "name": "CreateBackupDownloadTask", "description": "本接口用来创建某个备份文件的下载任务", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "实例ID。请登录 [MongoDB 控制台](https://console.cloud.tencent.com/mongodb)在实例列表复制实例 ID。", "example": "cmgo-f555zzzz" }, { "name": "BackupName", "type": "string", "required": true, "description": "要下载的备份文件名。请通过 [DescribeDBBackups](https://cloud.tencent.com/document/product/240/38574) 接口获取。", "example": "cmgo-74sjf5mt_2021-03-24 15:40" }, { "name": "BackupSets", "type": "array", "required": true, "description": "指定要下载的副本集节点 ID 或分片集群的分片节点 ID 列表。 - 如副本集实例 ID 为 cmgo-p8vnipr5，示例：BackupSets.0=cmgo-p8vnipr5_0，可下载全量数据。 - 如分片集群实例 ID 为 cmgo-p8vnipr5，示例：BackupSets.0=cmgo-p8vnipr5_0\u0026BackupSets.1=cmgo-p8vnipr5_1，即下载分片0和分片1的数据。分片集群如需全量下载，请按示例方式传入全部分片名称。", "example": "无", "item_type": "object", "children": [ { "name": "ReplicaSetId", "type": "string", "required": true, "description": "副本集 ID。", "example": "cmgo_ih8uido9_0" } ] } ], "required": [ "InstanceId", "BackupName", "BackupSets" ] }, { "name": "CreateDBInstance", "description": "本接口(CreateDBInstance)用于创建包年包月的MongoDB云数据库实例。接口支持的售卖规格，可通过接口查询 [DescribeSpecInfo](https://cloud.tencent.com/document/product/240/35767) 获取。", "status": "online", "parameters": [ { "name": "NodeNum", "type": "integer", "required": true, "description": "- 创建副本集实例，指每个副本集内主从节点数量。每个副本集所支持的最大节点数与最小节点数，请通过接口 [DescribeSpecInfo](https://cloud.tencent.com/document/product/240/38567) 获取。 - 创建分片集群实例，指每个分片的主从节点数量。每个分片所支持的最大节点数与最小节点数，请通过接口 [DescribeSpecInfo](https://cloud.tencent.com/document/product/240/38567) 获取。", "example": "3" }, { "name": "Memory", "type": "integer", "required": true, "description": "实例内存大小，单位：GB。具体售卖的内存规格，请通过接口 [DescribeSpecInfo](https://cloud.tencent.com/document/product/240/38567) 获取。", "example": "4" }, { "name": "Volume", "type": "integer", "required": true, "description": "实例硬盘大小，单位：GB。每一个 CPU 规格对应的最大磁盘与最小磁盘范围，请通过接口 [DescribeSpecInfo](https://cloud.tencent.com/document/product/240/38567) 获取。", "example": "100" }, { "name": "MongoVersion", "type": "string", "required": true, "description": "指版本信息。具体支持的版本信息 ，请通过接口 [DescribeSpecInfo](https://cloud.tencent.com/document/product/240/38567) 获取。 - MONGO_40_WT：MongoDB 4.0 WiredTiger存储引擎版本。 - MONGO_42_WT：MongoDB 4.2 WiredTiger存储引擎版本。 - MONGO_44_WT：MongoDB 4.4 WiredTiger存储引擎版本。 - MONGO_50_WT：MongoDB 5.0 WiredTiger存储引擎版本。 - MONGO_60_WT：MongoDB 6.0 WiredTiger存储引擎版本。 - MONGO_70_WT：MongoDB 7.0 WiredTiger存储引擎\ufffd\ufffd...", "example": "MONGO_44_WT" }, { "name": "GoodsNum", "type": "integer", "required": true, "description": "实例数量, 最小值1，最大值为30。", "example": "1" }, { "name": "Zone", "type": "string", "required": true, "description": "可用区信息，输入格式如：ap-guangzhou-2。 - 具体信息，请通过接口 [DescribeSpecInfo](https://cloud.tencent.com/document/product/240/38567) 获取。 - 该参数为主可用区，如果多可用区部署，Zone必须是AvailabilityZoneList中的一个。", "example": "ap-guangzhou-2" }, { "name": "Period", "type": "integer", "required": true, "description": "指定购买实例的购买时长。取值可选：[1,2,3,4,5,6,7,8,9,10,11,12,24,36]；单位：月。", "example": "1" }, { "name": "MachineCode", "type": "string", "required": true, "description": "产品规格类型。 - HIO10G：通用高HIO万兆型。 - HCD：云盘版类型。", "example": "HIO10G" }, { "name": "ClusterType", "type": "string", "required": true, "description": "实例架构类型。 - REPLSET：副本集。 - SHARD：分片集群。", "example": "REPLSET" }, { "name": "ReplicateSetNum", "type": "integer", "required": true, "description": "- 创建副本集实例，指副本集数量，该参数只能为1。 - 创建分片集群实例，指分片的数量。请通过接口[DescribeSpecInfo](https://cloud.tencent.com/document/product/240/38567)查询分片数量的取值范围，其返回的数据结构SpecItems中的参数MinReplicateSetNum与MaxReplicateSetNum分别对应其最小值与最大值。", "example": "1" }, { "name": "ProjectId", "type": "integer", "required": false, "description": "项目ID。 - 若不设置该参数，则为默认项目。 - 在 [MongoDB 控制台项目管理](https://console.cloud.tencent.com/project)页面，可获取项目ID。", "example": "0" }, { "name": "VpcId", "type": "string", "required": false, "description": "私有网络 ID。 - 仅支持配置私有网络，必须选择一个与实例同一地域的私有网络。请登录[私有网络控制台](https://console.cloud.tencent.com/vpc)获取可使用的私有网络 ID。 - 实例创建成功之后，支持更换私有网络。具体操作，请参见[更换网络](https://cloud.tencent.com/document/product/239/30910)。", "example": "vpc-0akb****" }, { "name": "SubnetId", "type": "string", "required": false, "description": "私有网络 VPC 的子网 ID。 - 必须在已选的私有网络内指定一个子网。请登录[私有网络控制台](https://console.cloud.tencent.com/vpc)获取可使用的子网 ID。 - 实例创建成功之后，支持更换私有网络及子网。具体操作，请参见[更换网络](https://cloud.tencent.com/document/product/239/30910)。", "example": "subnet-fyrt****" }, { "name": "Password", "type": "string", "required": false, "description": "实例密码。设置要求如下： - 字符个数为[8,32]。 - 可输入[A,Z]、[a,z]、[0,9]范围内的字符。 - 可输入的特殊字符包括：感叹号“!”，at“@”，警号“#”、百分号“%”、插入号“^”、星号“\\*”、括号“()”、下划线“\\_”。 - 不能设置单一的字母或者数字。", "example": "********" }, { "name": "Tags", "type": "array", "required": false, "description": "实例标签信息。", "example": "无", "item_type": "object", "children": [ { "name": "TagKey", "type": "string", "required": true, "description": "标签键", "example": "myTag" }, { "name": "TagValue", "type": "string", "required": true, "description": "标签值", "example": "myTagValue" } ] }, { "name": "AutoRenewFlag", "type": "integer", "required": false, "description": "自动续费标记。 - 0：不自动续费。 - 1：自动续费。", "example": "1" }, { "name": "AutoVoucher", "type": "integer", "required": false, "description": "是否自动选择代金券。 - 1：是。 - 0：否。默认为0。", "example": "1" }, { "name": "Clone", "type": "integer", "required": false, "description": "实例类型。 - 1：正式实例。 - 3：只读实例。 - 4：灾备实例。 - 5：克隆实例。注意：克隆实例 RestoreTime 为必填项。", "example": "1" }, { "name": "Father", "type": "string", "required": false, "description": "父实例 ID。 - 当参数**Clone**为3或者4时，即实例为只读或灾备实例时，该参数必须配置。 - 请登录 [MongoDB 控制台](https://console.cloud.tencent.com/mongodb)在实例列表复制父实例 ID。", "example": "cmgo-nh1o****" }, { "name": "SecurityGroup", "type": "array", "required": false, "description": "安全组 ID。 请登录[安全组控制台](https://console.cloud.tencent.com/vpc/security-group)页面获取与数据库实例同地域的安全组 ID。", "example": "[\"sg-di48****\"]", "item_type": "string" }, { "name": "RestoreTime", "type": "string", "required": false, "description": "克隆实例回档时间，当Clone取值为5或6时为必填。- 若为克隆实例，则必须配置该参数。输入格式示例：2021-08-13 16:30:00。- 回档时间范围：仅能回档7天内时间点的数据。", "example": "2022-09-15 15:04:05" }, { "name": "InstanceName", "type": "string", "required": false, "description": "实例名称。仅支持长度为128个字符的中文、英文、数字、下划线\\_、分隔符\\-。批量购买数据库实例时，支持通过自定义命名模式串与数字后缀自动升序功能，高效设置实例名称。 - 基础模式：前缀＋自动升序编号（默认从1开始），**lnstanceName**仅需自定义实例名称前缀，例如设置为：cmgo，设置购买数量为5，则购买后，实例名称依次分别为cmgo1、cmgo2、cmgo3、cmgo4、cmgo5。 - 自定\ufffd\ufffd...", "example": "myInstance_{R:3}" }, { "name": "AvailabilityZoneList", "type": "array", "required": false, "description": "若多可用区部署云数据库实例，指定多可用区列表。 - 多可用区部署实例，参数 **Zone** 指定实例主可用区信息；**AvailabilityZoneList** 指定所有可用区信息，包含主可用区。输入格式如：[ap-guangzhou-2,ap-guangzhou-3,ap-guangzhou-4]。 - 通过接口 [DescribeSpecInfo](https://cloud.tencent.com/document/product/240/38567) 可获取云数据库不同地域规划的可用区信息，以便指定有效的可用区。 - 多可用区部署节点...", "example": "[\"ap-guangzhou-2\",\"ap-guangzhou-3\",\"ap-guangzhou-4\"]", "item_type": "string" }, { "name": "MongosCpu", "type": "integer", "required": false, "description": "Mongos CPU 核数，支持1、2、4、8、16。购买分片集群时，必须填写。", "example": "1" }, { "name": "MongosMemory", "type": "integer", "required": false, "description": "Mongos 内存大小。 - 购买分片集群时，必须填写。 - 单位：GB，支持1核2GB、2核4GB、4核8GB、8核16GB、16核32GB。", "example": "2" }, { "name": "MongosNodeNum", "type": "integer", "required": false, "description": "Mongos 数量。购买分片集群时，必须填写。 - 单可用区部署实例，其数量范围为[3,32]。 - 多可用区部署实例，其数量范围为[6,32]。", "example": "3" }, { "name": "ReadonlyNodeNum", "type": "integer", "required": false, "description": "只读节点数量，取值范围[0,5]。", "example": "0" }, { "name": "ReadonlyNodeAvailabilityZoneList", "type": "array", "required": false, "description": "指只读节点所属可用区数组。跨可用区部署实例，参数**ReadonlyNodeNum**不为**0**时，必须配置该参数。", "example": "[\"ap-guangzhou-2\"]", "item_type": "string" }, { "name": "HiddenZone", "type": "string", "required": false, "description": "Hidden节点所属可用区。跨可用区部署实例，必须配置该参数。", "example": "ap-guangzhou-2" }, { "name": "ParamTemplateId", "type": "string", "required": false, "description": "参数模板 ID。 - 参数模板是预置了特定参数值的集合，可用于快速配置新的 MongoDB 实例。合理使用参数模板，能有效提升数据库的部署效率与运行性能。 - 参数模板 ID 可通过 [DescribeDBInstanceParamTpl ](https://cloud.tencent.com/document/product/240/109155)接口获取。请选择与实例版本与架构所对应的参数模板 ID。", "example": "tpl-0vswu****" } ], "required": [ "NodeNum", "Memory", "Volume", "MongoVersion", "GoodsNum", "Zone", "Period", "MachineCode", "ClusterType", "ReplicateSetNum" ] }, { "name": "CreateDBInstanceHour", "description": "本接口（CreateDBInstanceHour）用于创建按量计费的MongoDB云数据库实例。", "status": "online", "parameters": [ { "name": "Memory", "type": "integer", "required": true, "description": "实例内存大小，单位：GB。具体售卖的内存规格，请通过接口 [DescribeSpecInfo](https://cloud.tencent.com/document/product/240/38567) 获取。", "example": "4" }, { "name": "Volume", "type": "integer", "required": true, "description": "实例硬盘大小，单位：GB。每一个 CPU 规格对应的最大磁盘与最小磁盘范围，请通过接口 [DescribeSpecInfo](https://cloud.tencent.com/document/product/240/38567) 获取。", "example": "100" }, { "name": "ReplicateSetNum", "type": "integer", "required": true, "description": "- 创建副本集实例，指副本集数量，该参数只能为1。 - 创建分片集群实例，指分片的数量。请通过接口[DescribeSpecInfo](https://cloud.tencent.com/document/product/240/38567)查询分片数量的取值范围，其返回的数据结构SpecItems中的参数MinReplicateSetNum与MaxReplicateSetNum分别对应其最小值与最大值。", "example": "1" }, { "name": "NodeNum", "type": "integer", "required": true, "description": "- 创建副本集实例，指每个副本集内主从节点数量。每个副本集所支持的最大节点数与最小节点数，请通过接口 [DescribeSpecInfo](https://cloud.tencent.com/document/product/240/38567) 获取。 - 创建分片集群实例，指每个分片的主从节点数量。每个分片所支持的最大节点数与最小节点数，请通过接口 [DescribeSpecInfo](https://cloud.tencent.com/document/product/240/38567) 获取。", "example": "2" }, { "name": "MongoVersion", "type": "string", "required": true, "description": "指版本信息。具体支持的版本信息 ，请通过接口 [DescribeSpecInfo](https://cloud.tencent.com/document/product/240/38567) 获取。 - MONGO_40_WT：MongoDB 4.0 WiredTiger存储引擎版本。 - MONGO_42_WT：MongoDB 4.2 WiredTiger存储引擎版本。 - MONGO_44_WT：MongoDB 4.4 WiredTiger存储引擎版本。 - MONGO_50_WT：MongoDB 5.0 WiredTiger存储引擎版本。 - MONGO_60_WT：MongoDB 6.0 WiredTiger存储引擎版本。 - MONGO_70_WT：MongoDB 7.0 WiredTiger存储引擎\ufffd\ufffd...", "example": "MONGO_44_WT" }, { "name": "MachineCode", "type": "string", "required": true, "description": "产品规格类型。 - HIO10G：通用高HIO万兆型。 - HCD：云盘版类型。", "example": "HIO10G" }, { "name": "GoodsNum", "type": "integer", "required": true, "description": "实例数量，最小值1，最大值为30。", "example": "1" }, { "name": "Zone", "type": "string", "required": true, "description": "可用区信息，输入格式如：ap-guangzhou-2。 - 具体信息，请通过接口 [DescribeSpecInfo](https://cloud.tencent.com/document/product/240/38567) 获取。 - 该参数为主可用区，如果多可用区部署，Zone必须是AvailabilityZoneList中的一个。", "example": "ap-guangzhou-3" }, { "name": "ClusterType", "type": "string", "required": true, "description": "实例架构类型。 - REPLSET：副本集。 - SHARD：分片集群。", "example": "REPLSET" }, { "name": "VpcId", "type": "string", "required": false, "description": "私有网络ID。 - 仅支持配置私有网络，必须选择一个与实例同一地域的私有网络。请登录[私有网络控制台](https://console.cloud.tencent.com/vpc)获取可使用的私有网络 ID。 - 实例创建成功之后，支持更换私有网络。具体操作，请参见[更换网络](https://cloud.tencent.com/document/product/239/30910)。", "example": "vpc-k515****" }, { "name": "SubnetId", "type": "string", "required": false, "description": "私有网络 VPC 的子网 ID。 - 必须在已选的私有网络内指定一个子网。请登录[私有网络控制台](https://console.cloud.tencent.com/vpc)获取可使用的子网 ID。 - 实例创建成功之后，支持更换私有网络及子网。具体操作，请参见[更换网络](https://cloud.tencent.com/document/product/239/30910)。", "example": "subnet-60dr****" }, { "name": "Password", "type": "string", "required": false, "description": "实例密码。设置要求如下： - 字符个数为[8,32]。 - 可输入[A,Z]、[a,z]、[0,9]范围内的字符。 - 可输入的特殊字符包括：感叹号“!”，at“@”，警号“#”、百分号“%”、插入号“^”、星号“\\*”、括号“()”、下划线“_”。 - 不能设置单一的字母或者数字。", "example": "************" }, { "name": "ProjectId", "type": "integer", "required": false, "description": "项目ID。 - 若不设置该参数，则为默认项目。 - 在 [MongoDB 控制台项目管理](https://console.cloud.tencent.com/project)页面，可获取项目ID。", "example": "1" }, { "name": "Tags", "type": "array", "required": false, "description": "实例标签信息。", "example": "无", "item_type": "object", "children": [ { "name": "TagKey", "type": "string", "required": true, "description": "标签键", "example": "myTag" }, { "name": "TagValue", "type": "string", "required": true, "description": "标签值", "example": "myTagValue" } ] }, { "name": "Clone", "type": "integer", "required": false, "description": "实例类型。 - 1：正式实例。 - 3：只读实例。 - 4：灾备实例。 - 5：克隆实例。注意：克隆实例 RestoreTime 为必填项。", "example": "1" }, { "name": "Father", "type": "string", "required": false, "description": "父实例 ID。 - 当参数**Clone**为3或者4时，即实例为只读或灾备实例时，该参数必须配置。 - 请登录 [MongoDB 控制台](https://console.cloud.tencent.com/mongodb)在实例列表复制父实例 ID。", "example": "cmgo-nh1o****" }, { "name": "SecurityGroup", "type": "array", "required": false, "description": "安全组 ID。 请登录[安全组控制台](https://console.cloud.tencent.com/vpc/security-group)页面获取与数据库实例同地域的安全组 ID。", "example": "[\"sg-1s3c****\"]", "item_type": "string" }, { "name": "RestoreTime", "type": "string", "required": false, "description": "克隆实例回档时间。 - 若为克隆实例，则必须配置该参数。输入格式示例：2021-08-13 16:30:00。 - 回档时间范围：仅能回档7天内时间点的数据。", "example": "2022-09-10 15:04:05" }, { "name": "InstanceName", "type": "string", "required": false, "description": "实例名称。仅支持长度为128个字符的中文、英文、数字、下划线\\_、分隔符\\-。批量购买数据库实例时，支持通过自定义命名模式串与数字后缀自动升序功能，高效设置实例名称。 - 基础模式：前缀＋自动升序编号（默认从1开始），**lnstanceName**仅需自定义实例名称前缀，例如设置为：cmgo，设置购买数量为5，则购买后，实例名称依次分别为cmgo1、cmgo2、cmgo3、cmgo4、cmgo5。 - 自定\ufffd\ufffd...", "example": "testInstance_{R:3}" }, { "name": "AvailabilityZoneList", "type": "array", "required": false, "description": "若多可用区部署云数据库实例，指定多可用区列表。 - 多可用区部署实例，参数 **Zone** 指定实例主可用区信息；**AvailabilityZoneList** 指定所有可用区信息，包含主可用区。输入格式如：[ap-guangzhou-2,ap-guangzhou-3,ap-guangzhou-4]。 - 通过接口 [DescribeSpecInfo](https://cloud.tencent.com/document/product/240/38567) 可获取云数据库不同地域规划的可用区信息，以便指定有效的可用区。 - 多可用区部署节点...", "example": "[\"ap-guangzhou-2\",\"ap-guangzhou-3\",\"ap-guangzhou-4\"]", "item_type": "string" }, { "name": "MongosCpu", "type": "integer", "required": false, "description": "Mongos CPU 核数，支持1、2、4、8、16。购买分片集群时，必须填写。", "example": "1" }, { "name": "MongosMemory", "type": "integer", "required": false, "description": "Mongos 内存大小。 - 购买分片集群时，必须填写。 - 单位：GB，支持1核2GB、2核4GB、4核8GB、8核16GB、16核32GB。", "example": "2" }, { "name": "MongosNodeNum", "type": "integer", "required": false, "description": "Mongos 数量。购买分片集群时，必须填写。 - 单可用区部署实例，其数量范围为[3,32]。 - 多可用区部署实例，其数量范围为[6,32]。", "example": "3" }, { "name": "ReadonlyNodeNum", "type": "integer", "required": false, "description": "只读节点数量，取值范围[0,5]。", "example": "0" }, { "name": "ReadonlyNodeAvailabilityZoneList", "type": "array", "required": false, "description": "指只读节点所属可用区数组。跨可用区部署实例，参数**ReadonlyNodeNum**不为**0**时，必须配置该参数。", "example": "[\"ap-guangzhou-2\"]", "item_type": "string" }, { "name": "HiddenZone", "type": "string", "required": false, "description": "Hidden节点所属可用区。跨可用区部署实例，必须配置该参数。", "example": "ap-guangzhou-2" }, { "name": "ParamTemplateId", "type": "string", "required": false, "description": "参数模板 ID。 - 参数模板是预置了特定参数值的集合，可用于快速配置新的 MongoDB 实例。合理使用参数模板，能有效提升数据库的部署效率与运行性能。 - 参数模板 ID 可通过 [DescribeDBInstanceParamTpl ](https://cloud.tencent.com/document/product/240/109155)接口获取。请选择与实例版本与架构所对应的参数模板 ID。", "example": "tpl-0vswu****" } ], "required": [ "Memory", "Volume", "ReplicateSetNum", "NodeNum", "MongoVersion", "MachineCode", "GoodsNum", "Zone", "ClusterType" ] }, { "name": "CreateDBInstanceParamTpl", "description": "本接口(CreateDBInstanceParamTpl)用于创建云数据库MongoDB实例的参数模板 **说明：CreateDBInstanceParamTpl API正在公测中，在此期间，该接口仅对公测用户开放**", "status": "online", "parameters": [ { "name": "TplName", "type": "string", "required": true, "description": "参数模板名称。", "example": "高性能模板" }, { "name": "MongoVersion", "type": "string", "required": false, "description": "参数模板版本号。当**MirrorTplId**为空时，该字段必填。参数模板支持的售卖版本，请通过接口 [DescribeSpecInfo](https://cloud.tencent.com/document/product/240/35767) 获取。 - MONGO_36_WT：MongoDB 3.6 WiredTiger存储引擎版本， - MONGO_40_WT：MongoDB 4.0 WiredTiger存储引擎版本， - MONGO_42_WT：MongoDB 4.2 WiredTiger存储引擎版本。 - MONGO_44_WT：MongoDB 4.4 WiredTiger存储引擎版本。 - MONGO_50_WT：MongoDB 5.0 WiredTiger存储引擎版...", "example": "MONGO_42_WT" }, { "name": "ClusterType", "type": "string", "required": false, "description": "实例类型。当 MirrorTplId 为空值时，该参数必填。 - REPLSET：副本集实例。 - SHARD：分片实例。 - STANDALONE：单节点实例。", "example": "SHARD" }, { "name": "TplDesc", "type": "string", "required": false, "description": "模板描述信息。", "example": "用于压测场景" }, { "name": "Params", "type": "array", "required": false, "description": "模板参数，若不配置该参数，则以系统默认模板作为新版本参数。", "example": "无", "item_type": "object", "children": [ { "name": "Key", "type": "string", "required": true, "description": "参数", "example": "balance.window" }, { "name": "Value", "type": "string", "required": true, "description": "参数值", "example": "1|2" } ] }, { "name": "MirrorTplId", "type": "string", "required": false, "description": "镜像模板 ID。若指定镜像模板，则以该模板为镜像，克隆出一个新的模板。 **注意**：MirrorTplId 不为空值时，MongoVersion 及 ClusterType 将以 MirrorTpl 模板的版本及实例类型为准。", "example": "tpl-sdah1****" } ], "required": [ "TplName" ] }, { "name": "CreateLogDownloadTask", "description": "创建日志下载任务", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "实例ID", "example": "cmgo-b6nit818p" }, { "name": "StartTime", "type": "string", "required": true, "description": "开始时间", "example": "2023-03-02 10:51:21" }, { "name": "EndTime", "type": "string", "required": true, "description": "结束时间", "example": "2023-03-0310:51:21" }, { "name": "NodeNames", "type": "array", "required": false, "description": "节点名称", "example": "[\"cmgo-xxx_0-node-primary\"]", "item_type": "string" }, { "name": "LogComponents", "type": "array", "required": false, "description": "日志类别", "example": "[\"COMMAND\"]", "item_type": "string" }, { "name": "LogLevels", "type": "array", "required": false, "description": "日志等级", "example": "[\"WARNING\"]", "item_type": "string" }, { "name": "LogIds", "type": "array", "required": false, "description": "日志ID", "example": "[\"5626700\"]", "item_type": "string" }, { "name": "LogConnections", "type": "array", "required": false, "description": "日志连接信息", "example": "[\"conn268164\"]", "item_type": "string" }, { "name": "LogDetailParams", "type": "array", "required": false, "description": "日志详情过滤字段", "example": "[\"*\"]", "item_type": "string" } ], "required": [ "InstanceId", "StartTime", "EndTime" ] }, { "name": "DeleteAccountUser", "description": "本接口（DeleteAccountUser）用于删除实例的自定义账号。", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "指定待删除账号的实例 ID。例如：cmgo-p8vn****。请登录 [MongoDB 控制台](https://console.cloud.tencent.com/mongodb)在实例列表复制实例 ID。", "example": "cmgo-7pjedvz7" }, { "name": "UserName", "type": "string", "required": true, "description": "配置待删除的账号名。", "example": "mong_test" }, { "name": "MongoUserPassword", "type": "string", "required": true, "description": "配置 mongouser 对应的密码。mongouser为系统默认账号，输入其对应的密码。", "example": "Abc123..." } ], "required": [ "InstanceId", "UserName", "MongoUserPassword" ] }, { "name": "DeleteAuditLogFile", "description": "本接口(DeleteAuditLogFile)用于删除云数据库实例的审计日志文件。", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "实例ID，格式如：cmgo-test1234，与云数据库控制台页面中显示的实例 ID 相同。", "example": "cmgo-test1234" }, { "name": "FileName", "type": "string", "required": true, "description": "审计日志文件名称，须保证文件名的准确性。", "example": "test.csv" } ], "required": [ "InstanceId", "FileName" ] }, { "name": "DeleteLogDownloadTask", "description": "删除日志下载任务", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "实例 ID", "example": "cmgo-b6nit818p" }, { "name": "TaskId", "type": "string", "required": true, "description": "任务ID", "example": "1373039ed2ee07bcd6ae1d5e" } ], "required": [ "InstanceId", "TaskId" ] }, { "name": "DescribeAccountUsers", "description": "本接口（DescribeAccountUsers）用于获取当前实例的全部账号。", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "指定待获取账号的实例ID。例如：cmgo-p8vn****。请登录 [MongoDB 控制台](https://console.cloud.tencent.com/mongodb)在实例列表复制实例 ID。", "example": "cmgo-******" } ], "required": [ "InstanceId" ] }, { "name": "DescribeAsyncRequestInfo", "description": "本接口（DescribeAsyncRequestInfo）用于查询异步任务状态接口。", "status": "online", "parameters": [ { "name": "AsyncRequestId", "type": "string", "required": true, "description": "指定需查询的异步请求 ID。当接口操作涉及异步流程时（如 [CreateBackupDBInstance](https://cloud.tencent.com/document/product/240/46599)），其返回值中的 AsyncRequestId 即为本参数所需填入的 ID。", "example": "4762" } ], "required": [ "AsyncRequestId" ] }, { "name": "DescribeAuditConfig", "description": "本接口(DescribeAuditConfig)用于查询云数据库审计策略的服务配置，包括审计日志保存时长等。", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "实例 ID，格式如：cmgo-xftsghuy，与云数据库控制台页面中显示的实例 ID 相同。", "example": "cmgo-c1nl****" } ], "required": [ "InstanceId" ] }, { "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": "无", "item_type": "object", "children": [ { "name": "Name", "type": "string", "required": true, "description": "搜索字段，目前支持： \"InstanceId\"：实例Id，例如：cmgo-**** \"InstanceName\"：实例名称 \"ClusterId\"：实例组Id，例如：cmgo-****", "example": "InstanceId" }, { "name": "Values", "type": "array", "required": true, "description": "筛选值", "example": "[\"cmongo-test1234\"]", "item_type": "string" } ] }, { "name": "AuditMode", "type": "integer", "required": false, "description": "审计类型，不传 默认全部，0 全审计，1 规则审计", "example": "0" }, { "name": "Limit", "type": "integer", "required": false, "description": "每页显示数量。", "example": "10" }, { "name": "Offset", "type": "integer", "required": false, "description": "分页偏移量。", "example": "100" } ], "required": [] }, { "name": "DescribeAuditLogFiles", "description": "本接口(DescribeAuditLogFiles)用于查询云数据库实例的审计日志文件。", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "实例 ID，格式如：cmgo-xfts****，与云数据库控制台页面中显示的实例 ID 相同。", "example": "cmgo-xfts****" }, { "name": "Limit", "type": "integer", "required": false, "description": "分页大小参数。默认值为 20，取值范围[1,100]。", "example": "10" }, { "name": "Offset", "type": "integer", "required": false, "description": "分页偏移量。", "example": "2" }, { "name": "FileName", "type": "string", "required": false, "description": "审计日志文件名。该接口将根据此参数过滤相关的审计日志文件。", "example": "test.txt" } ], "required": [ "InstanceId" ] }, { "name": "DescribeAuditLogs", "description": "本接口(DescribeAuditLogs)用于查询数据库审计日志。", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "实例ID，格式如：cmgo-xftsghuy，与云数据库控制台页面中显示的实例 ID 相同。", "example": "cmgo-7pje****" }, { "name": "StartTime", "type": "string", "required": true, "description": "开始时间，格式为：\"2017-07-12 10:29:20\"。", "example": "2022-09-28 14:25:38" }, { "name": "EndTime", "type": "string", "required": true, "description": "结束时间，格式为：\"2017-07-12 10:29:20\"。", "example": "2022-09-28 15:25:38" }, { "name": "Filter", "type": "object", "required": false, "description": "过滤条件，可按设置的过滤条件过滤日志。", "example": "无", "children": [ { "name": "Host", "type": "array", "required": false, "description": "客户端地址。", "example": "[\"10.1.11.12\"]", "item_type": "string" }, { "name": "User", "type": "array", "required": false, "description": "用户名。", "example": "[\"mongouser\"]", "item_type": "string" }, { "name": "ExecTime", "type": "integer", "required": false, "description": "执行时间。单位为：ms。表示筛选执行时间大于该值的审计日志。", "example": "10" }, { "name": "AffectRows", "type": "integer", "required": false, "description": "影响行数。表示筛选影响行数大于该值的审计日志。", "example": "1" }, { "name": "Atype", "type": "array", "required": false, "description": "操作类型。", "example": "[\"insert\"]", "item_type": "string" }, { "name": "Result", "type": "array", "required": false, "description": "执行结果。", "example": "[\"0\"]", "item_type": "string" }, { "name": "Param", "type": "array", "required": false, "description": "根据此关键字过滤日志", "example": "[\"insert\"]", "item_type": "string" } ] }, { "name": "Limit", "type": "integer", "required": false, "description": "分页参数，指单次返回的数据条数。默认值为100，最大值为100。", "example": "10" }, { "name": "Offset", "type": "integer", "required": false, "description": "分页偏移量。", "example": "10" }, { "name": "Order", "type": "string", "required": false, "description": "审计日志的排序方式。 ASC：升序。DESC：降序。", "example": "ASC" }, { "name": "OrderBy", "type": "string", "required": false, "description": "审计日志的排序字段，包括： timestamp：时间戳。 affectRows：影响行数。 execTime：执行时间。", "example": "timestamp" } ], "required": [ "InstanceId", "StartTime", "EndTime" ] }, { "name": "DescribeBackupDownloadTask", "description": "本接口（DescribeBackupDownloadTask）用于查询备份下载任务信息。", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "实例ID。请登录 [MongoDB 控制台](https://console.cloud.tencent.com/mongodb)在实例列表复制实例 ID。", "example": "cmgo-74sjf5mt" }, { "name": "BackupName", "type": "string", "required": false, "description": "指定备份文件名，用于过滤指定文件的下载任务。请通过接口 [DescribeDBBackups](https://cloud.tencent.com/document/product/240/38574) 获取备份文件名。", "example": "cmgo-74sjf5mt_2021-03-24 15:40" }, { "name": "StartTime", "type": "string", "required": false, "description": "指定查询时间范围内的任务，StartTime 指定开始时间。若不指定开始时间，则默认不限制开始时间。", "example": "2021-01-02 15:04:05" }, { "name": "EndTime", "type": "string", "required": false, "description": "指定查询时间范围内的任务，EndTime 指定截止时间。若不指定截止时间，则默认不限制截止时间。", "example": "2021-01-02 15:04:05" }, { "name": "Limit", "type": "integer", "required": false, "description": "此次查询返回的条数，取值范围为1-100，默认为20。", "example": "10" }, { "name": "Offset", "type": "integer", "required": false, "description": "指定此次查询返回的页数，默认为0。", "example": "0" }, { "name": "OrderBy", "type": "string", "required": false, "description": "排序字段。 - createTime：按照备份下载任务的创建时间排序。默认为 createTime。 - finishTime：按照备份下载任务的完成时间排序。", "example": "finishTime" }, { "name": "OrderByType", "type": "string", "required": false, "description": "排序方式。 - asc：升序排列。 - desc：降序排列。默认为 desc。", "example": "desc" }, { "name": "Status", "type": "array", "required": false, "description": "指定任务状态，用于过滤下载任务。若不配置该参数，则返回所有状态类型的任务。 - 0：等待执行。 - 1：正在下载。 - 2：下载完成。 - 3：下载失败。 - 4：等待重试。", "example": "[2]", "item_type": "integer" } ], "required": [ "InstanceId" ] }, { "name": "DescribeBackupRules", "description": "本接口（DescribeBackupRules）用于获取实例自动备份配置信息。", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "指定实例ID。例如：cmgo-p8vn****。请登录 [MongoDB 控制台](https://console.cloud.tencent.com/mongodb)在实例列表复制实例 ID。", "example": "cmgo-7pjedvz7" } ], "required": [ "InstanceId" ] }, { "name": "DescribeClientConnections", "description": "本接口（DescribeClientConnections）用于查询实例客户端连接信息，包括连接 IP 和连接数量。", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "指定待查询的实例ID，例如：cmgo-p8vn****。请登录 [MongoDB 控制台](https://console.cloud.tencent.com/mongodb)在实例列表复制实例 ID。", "example": "cmgo-eqmoaxxx" }, { "name": "Limit", "type": "integer", "required": false, "description": "单次请求返回的数量。最小值为1，最大值为1000，默认值为1000。", "example": "1" }, { "name": "Offset", "type": "integer", "required": false, "description": "偏移量，默认值为0。Offset=Limit*(页码-1)。", "example": "1" } ], "required": [ "InstanceId" ] }, { "name": "DescribeCurrentOp", "description": "本接口（DescribeCurrentOp）用于查询云数据库实例的当前正在执行的操作。", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "指定要查询的实例 ID。请登录 [MongoDB 控制台](https://console.cloud.tencent.com/mongodb)在实例列表复制实例 ID。", "example": "cmgo-p8vn****" }, { "name": "Ns", "type": "string", "required": false, "description": "操作所属的命名空间 namespace，格式为 db.collection。", "example": "data.user" }, { "name": "MillisecondRunning", "type": "integer", "required": false, "description": "设置查询筛选条件为操作任务已经执行的时间。 - 默认值为0，取值范围为[0, 3600000]，单位：毫秒。 - 结果将返回超过设置时间的操作。", "example": "20" }, { "name": "Op", "type": "string", "required": false, "description": "设置查询筛选条件为操作任务类型。取值包括： - none：特殊状态，空闲连接或内部任务等。 - update：更新数据。 - insert：插入操作。 - query：查询操作。 - command：命令操作。 - getmore：获取更多数据。 - remove：删除操作。 - killcursors：释放查询游标的操作。", "example": "update" }, { "name": "ReplicaSetName", "type": "string", "required": false, "description": "筛选条件，分片名称。", "example": "cmgo-nh1o****_0" }, { "name": "State", "type": "string", "required": false, "description": "设置查询筛选条件为节点角色。 - primary：主节点。 - secondary：从节点。", "example": "primary" }, { "name": "Limit", "type": "integer", "required": false, "description": "单次请求返回的数量，默认值为100，取值范围为[0,100]。", "example": "10" }, { "name": "Offset", "type": "integer", "required": false, "description": "偏移量，默认值为0，取值范围为[0,10000]。", "example": "1" }, { "name": "OrderBy", "type": "string", "required": false, "description": "返回结果集排序的字段，目前支持按照 MicrosecsRunning（操作任务已执行的时间）排序。", "example": "MicrosecsRunning" }, { "name": "OrderByType", "type": "string", "required": false, "description": "返回结果集排序方式。 - ASC：升序。默认为 ASC，按照升序排序。 - DESC：降序。", "example": "ASC" } ], "required": [ "InstanceId" ] }, { "name": "DescribeDBBackups", "description": "本接口（DescribeDBBackups）用于查询实例备份列表，目前只支持查询7天内的备份记录。", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "实例 ID。请登录 [MongoDB 控制台](https://console.cloud.tencent.com/mongodb)在实例列表复制实例 ID。", "example": "cmgo-f555zzzz" }, { "name": "BackupMethod", "type": "integer", "required": false, "description": "备份方式。 - 0：逻辑备份。 - 1：物理备份。 - 3：快照备份。 **说明**: 1. 通用版实例支持逻辑备份与物理备份。云盘版实例支持物理备份与快照备份，暂不支持逻辑备份。 2. 实例开通存储加密，则备份方式不能为物理备份。", "example": "1" }, { "name": "Limit", "type": "integer", "required": false, "description": "分页大小，最大值为100，不设置默认查询所有。", "example": "10" }, { "name": "Offset", "type": "integer", "required": false, "description": "分页偏移量，最小值为0，默认值为0。", "example": "1" } ], "required": [ "InstanceId" ] }, { "name": "DescribeDBInstanceDeal", "description": "本接口（DescribeDBInstanceDeal）用于获取MongoDB购买、续费及变配订单详细。", "status": "online", "parameters": [ { "name": "DealId", "type": "string", "required": true, "description": "订单 ID。 - 按量计费实例，请通过 [CreateDBInstanceHour](https://cloud.tencent.com/document/product/240/38570) 接口输出的参数**DealId**获取。。 - 包年包月计费实例，请通过 [CreateDBInstance](https://cloud.tencent.com/document/product/240/38571) 接口输出的参数**DealId**获取。", "example": "20200420111635" } ], "required": [ "DealId" ] }, { "name": "DescribeDBInstanceNamespace", "description": "本接口（DescribeDBInstanceNamespace）用于查询数据库的表信息。", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "指定查询数据库所属的实例 ID，支持批量查询。请登录 [MongoDB 控制台](https://console.cloud.tencent.com/mongodb)在实例列表复制实例 ID。", "example": "\"cmgo-j0i*****\"" }, { "name": "DbName", "type": "string", "required": false, "description": "指定查询的数据库名。为空时，返回当前实例的全部数据库列表。", "example": "dba" } ], "required": [ "InstanceId" ] }, { "name": "DescribeDBInstanceNodeProperty", "description": "本接口用于查询节点的属性，包括节点所在可用区、节点名称、地址、角色、状态、主从延迟、优先级、投票权、标签等属性。", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "实例 ID。请登录 [MongoDB 控制台](https://console.cloud.tencent.com/mongodb)在实例列表复制实例 ID。", "example": "cmgo-p8vnipr5" }, { "name": "NodeIds", "type": "array", "required": false, "description": "节点 ID。请登录 [MongoDB 控制台的节点管理](https://console.cloud.tencent.com/mongodb)复制节点 ID。", "example": "[\"cmgo-6heje4jp_0-node-slave0\",\"cmgo-6heje4jp_1-node-slave0\"]", "item_type": "string" }, { "name": "Roles", "type": "array", "required": false, "description": "节点角色。可选值包括： - PRIMARY：主节点。 - SECONDARY：从节点。 - READONLY：只读节点。 - ARBITER：仲裁节点。", "example": "[\"PRIMARY\"]", "item_type": "string" }, { "name": "OnlyHidden", "type": "boolean", "required": false, "description": "该参数指定节点是否为 Hidden 节点，默认为 false。", "example": "false" }, { "name": "Priority", "type": "integer", "required": false, "description": "该参数指定选举新主节点的优先级。其取值范围为[0,100]，数值越高，优先级越高。", "example": "10" }, { "name": "Votes", "type": "integer", "required": false, "description": "该参数指定节点投票权。 - 1：具有投票权。 - 0：无投票权。", "example": "1" }, { "name": "Tags", "type": "array", "required": false, "description": "节点标签。", "example": "无", "item_type": "object", "children": [ { "name": "TagKey", "type": "string", "required": false, "description": "节点Tag key", "example": "testKey" }, { "name": "TagValue", "type": "string", "required": false, "description": "节点Tag Value", "example": "testValue" } ] } ], "required": [ "InstanceId" ] }, { "name": "DescribeDBInstanceParamTpl", "description": "本接口(DescribeDBInstanceParamTpl )用于查询当前账号下所有MongoDB数据库参数模板 **说明：DescribeDBInstanceParamTpl API正在公测中，在此期间，该接口仅对公测用户开放**", "status": "online", "parameters": [ { "name": "TplIds", "type": "array", "required": false, "description": "参数模板 ID。请通过接口 [DescribeDBInstanceParamTpl](https://cloud.tencent.com/document/product/240/109155) 获取模板 ID。", "example": "[\"tpl-sdjf1****\"]", "item_type": "string" }, { "name": "TplNames", "type": "array", "required": false, "description": "指定查询的模板名称。", "example": "[\"tpl-test\"]", "item_type": "string" }, { "name": "MongoVersion", "type": "array", "required": false, "description": "指定所需查询的参数模板的数据库版本号。具体支持的版本信息，请通过接口 [DescribeSpecInfo](https://cloud.tencent.com/document/product/240/38567) 获取。 - MONGO_36_WT：MongoDB 3.6 WiredTiger存储引擎版本， - MONGO_40_WT：MongoDB 4.0 WiredTiger存储引擎版本， - MONGO_42_WT：MongoDB 4.2 WiredTiger存储引擎版本。 - MONGO_44_WT：MongoDB 4.4 WiredTiger存储引擎版本。 - MONGO_50_WT：MongoDB 5.0 WiredTiger存储引擎版本。 - MONGO_60_WT\ufffd...", "example": "[\"MONGO_42_WT\"]", "item_type": "string" }, { "name": "TplType", "type": "string", "required": false, "description": "指定查询的模板类型。 - DEFAULT：系统默认模板。 - CUSTOMIZE：自定义模板。", "example": "CUSTOMIZE" } ], "required": [] }, { "name": "DescribeDBInstanceParamTplDetail", "description": "本接口(DescribeDBInstanceParamTplDetail )用于查询MongoDB云数据库实例的参数模板详情。 **说明：DescribeDBInstanceParamTplDetail API正在公测中，在此期间，该接口仅对公测用户开放**", "status": "online", "parameters": [ { "name": "TplId", "type": "string", "required": true, "description": "参数模板 ID。请通过接口 [DescribeDBInstanceParamTpl](https://cloud.tencent.com/document/product/240/109155) 获取模板 ID。", "example": "tpl-sdvj2jh4k" }, { "name": "ParamName", "type": "string", "required": false, "description": "参数名称，传入该值，则只会获取该字段的参数详情。为空时，返回全部参数。", "example": "operationProfiling.mode" } ], "required": [ "TplId" ] }, { "name": "DescribeDBInstanceURL", "description": "本接口（DescribeDBInstanceURL）用于获取指定实例的 URI 形式的连接串访问地址示例。", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "实例 ID。请登录 [MongoDB 控制台](https://console.cloud.tencent.com/mongodb#/)在实例列表复制实例 ID。", "example": "cmgo-p8vn********" } ], "required": [ "InstanceId" ] }, { "name": "DescribeDBInstances", "description": "本接口（DescribeDBInstances）用于查询云数据库实例列表，支持通过项目ID、实例ID、实例状态等过滤条件来筛选主实例、灾备实例和只读实例信息列表。", "status": "online", "parameters": [ { "name": "InstanceIds", "type": "array", "required": false, "description": "实例 ID 列表。请登录 [MongoDB 控制台](https://console.cloud.tencent.com/mongodb)在实例列表复制实例 ID。", "example": "[\"cmgo-hcscymcl\"]", "item_type": "string" }, { "name": "InstanceType", "type": "integer", "required": false, "description": "指定查询的实例类型。取值范围如下： - 0：所有实例。 - 1：正式实例。 - 2：临时实例 - 3：只读实例。 - -1：查询同时包括正式实例、只读实例与灾备实例。", "example": "0" }, { "name": "ClusterType", "type": "integer", "required": false, "description": "指定所查询实例的集群类型，取值范围如下： - 0：副本集实例。 - 1：分片实例。 - -1：副本集与分片实例。", "example": "0" }, { "name": "Status", "type": "array", "required": false, "description": "指定所查询实例的当前状态，取值范围如下所示： - 0：待初始化。 - 1：流程处理中，例如：变更规格、参数修改等。 - 2：实例正常运行中。 - -2：已隔离（包年包月）。 - -3：已隔离（按量计费）。", "example": "[2]", "item_type": "integer" }, { "name": "VpcId", "type": "string", "required": false, "description": "私有网络的 ID。 - 基础网络则无需配置该参数。 - 请登录 [MongoDB 控制台](https://console.cloud.tencent.com/mongodb)在实例列表中，单击私有网络名称，在**私有网络**页面获取其 ID。", "example": "1" }, { "name": "SubnetId", "type": "string", "required": false, "description": "私有网络的子网ID。 - 基础网络则无需配置该参数。 - 请登录 [MongoDB 控制台](https://console.cloud.tencent.com/mongodb)在实例列表中，单击私有网络名称，在**私有网络**页面获取其子网 ID。", "example": "1" }, { "name": "PayMode", "type": "integer", "required": false, "description": "指定所查询实例的付费类型。 - 0：查询按量计费实例。 - 1：查询包年包月实例。 - -1：查询按量计费与包年包月实例。", "example": "1" }, { "name": "Limit", "type": "integer", "required": false, "description": "单次请求返回的数量。默认值为20，取值范围为(1,100]。", "example": "10" }, { "name": "Offset", "type": "integer", "required": false, "description": "偏移量，默认值为0。", "example": "1" }, { "name": "OrderBy", "type": "string", "required": false, "description": "配置返回结果排序依据的字段。目前支持依据\"ProjectId\"、\"InstanceName\"、\"CreateTime\"排序。", "example": "ProjectId" }, { "name": "OrderByType", "type": "string", "required": false, "description": "配置返回结果的排序方式。 - ASC：升序。 - DESC：降序。", "example": "ASC" }, { "name": "ProjectIds", "type": "array", "required": false, "description": "项目 ID。请登录 [MongoDB 控制台](https://console.cloud.tencent.com/mongodb)，在右上角的账户信息下拉菜单中，选择项目管理查询项目。", "example": "[1,2]", "item_type": "integer" }, { "name": "SearchKey", "type": "string", "required": false, "description": "指定查询搜索的关键词。支持设置为具体的实例ID、实例名称或者内网 IP 地址。", "example": "cmgo-glh5****" }, { "name": "Tags", "type": "array", "required": false, "description": "标签信息，包含标签键与标签值。", "example": "无", "item_type": "object", "children": [ { "name": "TagKey", "type": "string", "required": true, "description": "标签键", "example": "myTag" }, { "name": "TagValue", "type": "string", "required": true, "description": "标签值", "example": "myTagValue" } ] } ], "required": [] }, { "name": "DescribeDetailedSlowLogs", "description": "本接口（DescribeDetailedSlowLogs）用于查询实例慢日志详情。", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "实例 ID。请登录 [MongoDB 控制台](https://console.cloud.tencent.com/mongodb)在实例列表复制实例 ID。", "example": "cmgo-r3p8****" }, { "name": "StartTime", "type": "string", "required": true, "description": "指定查询慢日志的开始时间。- 格式：yyyy-mm-dd hh:mm:ss，如：2019-06-01 10:00:00。- 查询起止时间间隔不能超过24小时，只允许查询最近7天内慢日志。", "example": "2025-01-02 13:14:15" }, { "name": "EndTime", "type": "string", "required": true, "description": "指定查询慢日志的结束时间。 - 格式：yyyy-mm-dd hh:mm:ss，如：2019-06-02 12:00:00。 - 查询起止时间间隔不能超过24小时，只允许查询最近7天内慢日志。", "example": "2025-01-02 13:14:15" }, { "name": "ExecTime", "type": "integer", "required": false, "description": "指定慢日志查询阈值，即查询执行时间大于此值的慢日志。单位：ms，默认值：100。", "example": "100" }, { "name": "Commands", "type": "array", "required": false, "description": "指定查询慢日志的命令类型。", "example": "[\"find\"]", "item_type": "string" }, { "name": "Texts", "type": "array", "required": false, "description": "全文搜索关键字，多个关键字间为或关系。", "example": "[\"command\",\"primary\"]", "item_type": "string" }, { "name": "NodeNames", "type": "array", "required": false, "description": "指定查询慢日志的节点名称。请通过接口 [DescribeDBInstanceNodeProperty](https://cloud.tencent.com/document/product/240/82022) 查询节点名称。", "example": "[\"cmgo-r3p8****_0-node-primary\"]", "item_type": "string" }, { "name": "QueryHash", "type": "array", "required": false, "description": "指定查询 queryHash 值。", "example": "[\"admin..****Continue\"]", "item_type": "string" }, { "name": "Offset", "type": "integer", "required": false, "description": "分页偏移量。默认值：0。取值范围：[0,100]。", "example": "1" }, { "name": "Limit", "type": "integer", "required": false, "description": "返回条数。默认值：20。取值范围：[0,10000]", "example": "10" }, { "name": "OrderBy", "type": "string", "required": false, "description": "指定慢日志排序条件。 - StartTime：按照慢日志生成时间排序。 - ExecTime：按照慢日志执行时间排序。", "example": "ExecTime" }, { "name": "OrderByType", "type": "string", "required": false, "description": "指定排序方式。 - desc：倒序。 - asc：顺序。", "example": "desc" } ], "required": [ "InstanceId", "StartTime", "EndTime" ] }, { "name": "DescribeInstanceParams", "description": "本接口（DescribeInstanceParams）用于查询当前实例可修改的参数列表。", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "指定待查询参数列表的实例 ID。例如：cmgo-p8vn****。请登录 [MongoDB 控制台](https://console.cloud.tencent.com/mongodb)在实例列表复制实例 ID。", "example": "cmgo-p8vn****" } ], "required": [ "InstanceId" ] }, { "name": "DescribeInstanceSSL", "description": "查看实例SSL开启状态", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "实例ID，格式如：cmgo-p8vnipr5。与云数据库控制台页面中显示的实例ID相同", "example": "cmgo-p8vnipr5" } ], "required": [ "InstanceId" ] }, { "name": "DescribeLogDownloadTasks", "description": "日志下载任务查询", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "实例 ID", "example": "cmgo-b6nit818p" }, { "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": "2024-03-07 9:22:15" }, { "name": "EndTime", "type": "string", "required": false, "description": "下载任务的结束时间", "example": "2024-03-07 11:22:15" } ], "required": [ "InstanceId" ] }, { "name": "DescribeMongodbLogs", "description": "该接口（DescribeMongodbLogs）用于查询运行日志。", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "实例 ID。请登录 [MongoDB 控制台](https://console.cloud.tencent.com/mongodb#/)在实例列表复制实例 ID。", "example": "cmgo-k2p5su09" }, { "name": "StartTime", "type": "string", "required": true, "description": "查询日志的开启时间。 - 格式：yyyy-mm-dd hh:mm:ss，如：2019-06-01 10:00:00。 - 查询时间范围：仅支持查询最近 7 天内的日志数据。", "example": "2020-04-20 00:00:00" }, { "name": "EndTime", "type": "string", "required": true, "description": "查询日志的结束时间。 - 格式：yyyy-mm-dd hh:mm:ss，如：2019-06-01 10:00:00。 - 查询时间范围：仅支持查询最近 7 天内的日志数据。", "example": "2020-04-20 00:00:00" }, { "name": "NodeNames", "type": "array", "required": false, "description": "节点 ID。请登录 [MongoDB 控制台](https://console.cloud.tencent.com/mongodb)的**节点管理**页面获取查询的节点 ID。", "example": "[\"cmgo-xxx_0-node-primary\"]", "item_type": "string" }, { "name": "LogComponents", "type": "array", "required": false, "description": "日志类别。 - 日志类别包括但不限于 COMMAND、ACCESS、CONTROL、FTDC、INDEX、NETWORK、QUERY、REPL、SHARDING、STORAGE、RECOVERY、JOURNAL 和 WRITE 等。具体支持的类别可能会因 MongoDB 的版本而存在差异。具体信息，请参见[日志消息](https://www.mongodb.com/zh-cn/docs/v5.0/reference/log-messages/#log-message-examples)。 - 登录 [MongoDB 控制台](https://console.cloud.tencent.com/mongodb)，在**日志管理**页面的**错误日志**页签，\ufffd\ufffd...", "example": "[\"COMMAND\"]", "item_type": "string" }, { "name": "LogLevels", "type": "array", "required": false, "description": "日志级别。 - 日志级别按严重性从高到低依次为：FATAL、ERROR、WARNING。 - 登录 [MongoDB 控制台](https://console.cloud.tencent.com/mongodb)，在**日志管理**页面的**错误日志**页签，可查看**日志级别**。", "example": "[\"WARNING\"]", "item_type": "string" }, { "name": "LogIds", "type": "array", "required": false, "description": "日志 ID。登录 [MongoDB 控制台](https://console.cloud.tencent.com/mongodb)，在**日志管理**页面的**错误日志**页签，可查看**日志 ID**。", "example": "[\"1245\"]", "item_type": "string" }, { "name": "LogConnections", "type": "array", "required": false, "description": "日志连接信息。登录 [MongoDB 控制台](https://console.cloud.tencent.com/mongodb)，在**日志管理**页面的**错误日志**页签，可查看**日志连接信息**。", "example": "[\"conn268164\"]", "item_type": "string" }, { "name": "LogDetailParams", "type": "array", "required": false, "description": "指定日志筛选的字段。", "example": "[\"*\"]", "item_type": "string" }, { "name": "Offset", "type": "integer", "required": false, "description": "偏移量，最小值为0，最大值为10000，默认值为0。", "example": "0" }, { "name": "Limit", "type": "integer", "required": false, "description": "分页大小，最小值为1，最大值为100，默认值为20。", "example": "100" } ], "required": [ "InstanceId", "StartTime", "EndTime" ] }, { "name": "DescribeSRVConnectionDomain", "description": "本接口（DescribeSRVConnectionDomain）用于查询MongoDB数据库当前的域名信息。", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "实例 ID，例如：cmgo-p8vn****。请登录 [MongoDB 控制台](https://console.cloud.tencent.com/mongodb)在实例列表复制实例 ID。", "example": "cmgo-p8vnipr5" } ], "required": [ "InstanceId" ] }, { "name": "DescribeSecurityGroup", "description": "本接口（DescribeSecurityGroup）用于查询实例绑定的安全组。", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "实例 ID。请登录 [MongoDB 控制台](https://console.cloud.tencent.com/mongodb)在实例列表复制实例 ID。", "example": "cmgo-p8vn****" } ], "required": [ "InstanceId" ] }, { "name": "DescribeSlowLogPatterns", "description": "本接口（DescribeSlowLogPatterns）用于获取数据库实例慢日志的统计信息。", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "实例 ID。请登录 [MongoDB 控制台](https://console.cloud.tencent.com/mongodb)在实例列表复制实例 ID。", "example": "cmgo-a3bm93hf" }, { "name": "StartTime", "type": "string", "required": true, "description": "慢日志起始时间。 - 格式：yyyy-mm-dd hh:mm:ss，如：2019-06-01 10:00:00。 - 查询起止时间间隔不能超过24小时，只允许查询最近7天内慢日志。", "example": "2020-04-20 00:00:00" }, { "name": "EndTime", "type": "string", "required": true, "description": "慢日志终止时间。 - 格式：yyyy-mm-dd hh:mm:ss，如：2019-06-02 12:00:00。 - 查询起止时间间隔不能超过24小时，只允许查询最近7天内慢日志。", "example": "2020-04-20 22:00:00" }, { "name": "SlowMS", "type": "integer", "required": true, "description": "慢日志执行时间阈值，返回执行时间超过该阈值的慢日志，单位为毫秒(ms)，最小为100毫秒。", "example": "100" }, { "name": "Offset", "type": "integer", "required": false, "description": "偏移量，最小值为0，最大值为10000，默认值为0。", "example": "0" }, { "name": "Limit", "type": "integer", "required": false, "description": "分页大小，最小值为1，最大值为100，默认值为20。", "example": "100" }, { "name": "Format", "type": "string", "required": false, "description": "慢日志返回格式，可设置为json，不传默认返回原生慢日志格式。", "example": "json" } ], "required": [ "InstanceId", "StartTime", "EndTime", "SlowMS" ] }, { "name": "DescribeSlowLogs", "description": "本接口（DescribeSlowLogs）用于获取云数据库慢日志信息。接口只支持查询最近7天内慢日志。", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "实例ID。请登录 [MongoDB 控制台](https://console.cloud.tencent.com/mongodb)在实例列表复制实例 ID。", "example": "cmgo-a3bm93hf" }, { "name": "StartTime", "type": "string", "required": true, "description": "慢日志起始时间。 - 格式：yyyy-mm-dd hh:mm:ss，如：2019-06-01 10:00:00。 - 查询起止时间间隔不能超过24小时，只允许查询最近7天内慢日志。", "example": "2020-04-20 00:00:00" }, { "name": "EndTime", "type": "string", "required": true, "description": "慢日志终止时间。 - 格式：yyyy-mm-dd hh:mm:ss，如：2019-06-02 12:00:00。 - 查询起止时间间隔不能超过24小时，只允许查询最近7天内慢日志。", "example": "2020-04-20 22:00:00" }, { "name": "SlowMS", "type": "integer", "required": true, "description": "慢日志执行时间阈值，返回执行时间超过该阈值的慢日志，单位为毫秒(ms)，最小为100毫秒。", "example": "100" }, { "name": "Offset", "type": "integer", "required": false, "description": "偏移量，最小值为0，最大值为10000，默认值为0。", "example": "0" }, { "name": "Limit", "type": "integer", "required": false, "description": "分页大小，最小值为1，最大值为100，默认值为20。", "example": "100" }, { "name": "Format", "type": "string", "required": false, "description": "慢日志返回格式。默认返回原生慢日志格式，4.4及以上版本可设置为json。", "example": "json" } ], "required": [ "InstanceId", "StartTime", "EndTime", "SlowMS" ] }, { "name": "DescribeSpecInfo", "description": "本接口（DescribeSpecInfo）用于查询实例的售卖规格。", "status": "online", "parameters": [ { "name": "Zone", "type": "string", "required": false, "description": "待查询可用区。当前支持的可用区，请参见[地域与可用区](https://cloud.tencent.com/document/product/240/3637)。", "example": "ap-guangzhou-3" } ], "required": [] }, { "name": "DescribeTransparentDataEncryptionStatus", "description": "获取实例透明加密的开启状态", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "指定实例 ID。请登录 [MongoDB 控制台](https://console.cloud.tencent.com/mongodb)在实例列表复制实例 ID。", "example": "\"cmgo-jyjcw8yv\"" } ], "required": [ "InstanceId" ] }, { "name": "DisableSRVConnectionUrl", "description": "本接口（DisableSRVConnectionUrl）用于关闭MongoDB数据库的SRV访问地址。", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "实例 ID，例如：cmgo-p8vn****。请登录 [MongoDB 控制台](https://console.cloud.tencent.com/mongodb)在实例列表复制实例 ID。", "example": "cmgo-p8vnipr5" } ], "required": [ "InstanceId" ] }, { "name": "DropDBInstanceParamTpl", "description": "本接口(DropDBInstanceParamTpl )用于删除云数据库MongoDB实例的参数模板 **说明：DropDBInstanceParamTpl API正在公测中，在此期间，该接口仅对公测用户开放**", "status": "online", "parameters": [ { "name": "TplId", "type": "string", "required": true, "description": "参数模板 ID。请通过接口 [DescribeDBInstanceParamTpl](https://cloud.tencent.com/document/product/240/109155) 获取模板 ID。", "example": "tpl-djtu****" } ], "required": [ "TplId" ] }, { "name": "EnableSRVConnectionUrl", "description": "本接口（EnableSRVConnectionUrl）用于开启MongoDB数据库的SRV访问地址。", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "实例 ID，例如：cmgo-p8vn****。请登录 [MongoDB 控制台](https://console.cloud.tencent.com/mongodb)在实例列表复制实例 ID。", "example": "cmgo-p8v****" } ], "required": [ "InstanceId" ] }, { "name": "EnableTransparentDataEncryption", "description": "本接口（EnableTransparentDataEncryption）用于开启云数据库 MongoDB 的透明加密能力。", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "实例 ID，例如：cmgo-p8vn****。请登录 [MongoDB 控制台](https://console.cloud.tencent.com/mongodb)在实例列表复制实例 ID。目前支持通用版本包含：4.4、5.0，云盘版暂不支持。", "example": "cmgo-p8vnipr5" }, { "name": "KmsRegion", "type": "string", "required": true, "description": "[密钥管理系统（Key Management Service，KMS）](https://cloud.tencent.com/document/product/573/18809)服务所在地域，例如 ap-shanghai。", "example": "ap-shanghai" }, { "name": "KeyId", "type": "string", "required": false, "description": "密钥 ID。若不设置该参数，不指定具体的密钥 ID，由腾讯云自动生成密钥。", "example": "AKID********************************" } ], "required": [ "InstanceId", "KmsRegion" ] }, { "name": "FlashBackDBInstance", "description": "该接口用于发起按 Key 闪回任务，依据数据的闪回 Key（默认为 id）对数据进行极速回档，快速恢复业务。 **说明：按 Key 闪回于2023年09月11日正式进行公测，在此期间，该接口仅对公测用户开放。**", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "开启按 Key 回档的实例 ID。请登录 [MongoDB 控制台](https://console.cloud.tencent.com/mongodb)在实例列表复制需开启按 Key 回档的实例 ID。", "example": "cmgo-iga0****" }, { "name": "TargetFlashbackTime", "type": "string", "required": true, "description": "指定数据回档的具体时间点，即将数据恢复到指定时间点的状态。", "example": "2023-08-04 14:00:00" }, { "name": "TargetDatabases", "type": "array", "required": true, "description": "指定回档数据的目标库表。", "example": "无", "item_type": "object", "children": [ { "name": "DBName", "type": "string", "required": true, "description": "按 Key 闪回目标数据所在库。", "example": "my-db" }, { "name": "Collections", "type": "array", "required": true, "description": "按 Key 闪回的数据库集合。", "example": "my-collection", "item_type": "object", "children": [ { "name": "CollectionName", "type": "string", "required": true, "description": "指定按 Key 闪回源数据库集合名。", "example": "my_collection" }, { "name": "TargetResultCollectionName", "type": "string", "required": true, "description": "指定按 Key 闪回目标数据库集合名。", "example": "my_collection_re" }, { "name": "FilterKey", "type": "string", "required": true, "description": "指定用于过滤按 Key 闪回的 Key（键）。", "example": "fKey" }, { "name": "KeyValues", "type": "array", "required": false, "description": "指定用于按 Key 闪回的键值对。数组元素最大限制为 50000。", "example": "fValue", "item_type": "object", "children": [ { "name": "Key", "type": "string", "required": false, "description": "指定按 Key 闪回的目标 Key （键） 。", "example": "fbKey" }, { "name": "Value", "type": "string", "required": false, "description": "指定按 Key 闪回的目标 Key 所对应的 Value（值）。", "example": "fbValue" } ] } ] } ] }, { "name": "TargetInstanceId", "type": "string", "required": false, "description": "数据回档的目标实例 ID。请登录 [MongoDB 控制台](https://console.cloud.tencent.com/mongodb)在实例列表复制目标实例 ID。", "example": "cmgo-iga0****" } ], "required": [ "InstanceId", "TargetFlashbackTime", "TargetDatabases" ] }, { "name": "FlushInstanceRouterConfig", "description": "在所有mongos上执行FlushRouterConfig命令", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "实例ID", "example": "cmgo-a3bm9xxx" } ], "required": [ "InstanceId" ] }, { "name": "InquirePriceCreateDBInstances", "description": "本接口（InquirePriceCreateDBInstances）用于创建数据库实例询价。本接口参数中必须传入region参数，否则无法通过校验。本接口仅允许针对购买限制范围内的实例配置进行询价。", "status": "online", "parameters": [ { "name": "Zone", "type": "string", "required": true, "description": "实例所属区域及可用区信息。具体信息，请参见[地域和可用区](https://cloud.tencent.com/document/product/240/3637)。", "example": "ap-guangzhou-4" }, { "name": "NodeNum", "type": "integer", "required": true, "description": "- 创建副本集实例，指每个副本集内主从节点数量。每个副本集所支持的最大节点数与最小节点数，请通过接口 [DescribeSpecInfo](https://cloud.tencent.com/document/product/240/38567) 获取。 - 创建分片集群实例，指每个分片的主从节点数量。每个分片所支持的最大节点数与最小节点数，请通过接口 [DescribeSpecInfo](https://cloud.tencent.com/document/product/240/38567) 获取。", "example": "3" }, { "name": "Memory", "type": "integer", "required": true, "description": "实例内存大小。 - 单位：GB。 - 取值范围：请通过接口[DescribeSpecInfo](https://cloud.tencent.com/document/product/240/38567)查询，其返回的数据结构SpecItems中的参数CPU与Memory分别对应CPU核数与内存规格。", "example": "4" }, { "name": "Volume", "type": "integer", "required": true, "description": "实例硬盘大小。 - 单位：GB。 - 取值范围：请通过接口[DescribeSpecInfo](https://cloud.tencent.com/document/product/240/38567)查询，其返回的数据结构SpecItems中的参数MinStorage与MaxStorage分别对应其最小磁盘规格与最大磁盘规格。", "example": "100" }, { "name": "MongoVersion", "type": "string", "required": true, "description": "实例版本信息。具体支持的版本，请通过接口[DescribeSpecInfo](https://cloud.tencent.com/document/product/240/38567)查询，其返回的数据结构SpecItems中的参数MongoVersionCode为实例所支持的版本信息。版本信息与版本号对应关系如下： - MONGO_40_WT：MongoDB 4.0 WiredTiger存储引擎版本。 - MONGO_42_WT：MongoDB 4.2 WiredTiger存储引擎版本。 - MONGO_44_WT：MongoDB 4.4 WiredTiger存储引擎版本。 - MONGO_50_WT：MongoDB 5.0 WiredTig...", "example": "MONGO_50_WT" }, { "name": "MachineCode", "type": "string", "required": true, "description": "产品规格类型。 - HIO10G：通用高HIO万兆型。 - HCD：云盘版。", "example": "HIO10G" }, { "name": "GoodsNum", "type": "integer", "required": true, "description": "实例数量，取值范围为[1,10]。", "example": "2" }, { "name": "ClusterType", "type": "string", "required": true, "description": "实例类型。 - REPLSET：副本集。 - SHARD：分片集群。", "example": "REPLSET" }, { "name": "ReplicateSetNum", "type": "integer", "required": true, "description": "- 创建副本集实例，指副本集数量，该参数只能为1。 - 创建分片集群实例，指分片的数量。请通过接口[DescribeSpecInfo](https://cloud.tencent.com/document/product/240/38567)查询分片数量的取值范围，其返回的数据结构SpecItems中的参数MinReplicateSetNum与MaxReplicateSetNum分别对应其最小值与最大值。", "example": "1" }, { "name": "Period", "type": "integer", "required": false, "description": "- 选择包年包月计费模式，即 InstanceChargeType 设定为PREPAID时，必须设置该参数，指定购买实例的购买时长。取值可选：[1,2,3,4,5,6,7,8,9,10,11,12,24,36]；单位：月。 -选择按量计费，即 InstanceChargeType 设定为 **POSTPAID_BY_HOUR** 时，该参数仅可配置为 1。", "example": "1" }, { "name": "InstanceChargeType", "type": "string", "required": false, "description": "实例付费方式。 - PREPAID：包年包月计费。 - POSTPAID_BY_HOUR：按量计费。", "example": "PREPAID" }, { "name": "MongosCpu", "type": "integer", "required": false, "description": "Mongos CPU 核数，支持1、2、4、8、16。购买分片集群时，必须填写。注意为空时取默认取值为2C。", "example": "2" }, { "name": "MongosMemory", "type": "integer", "required": false, "description": "Mongos 内存大小。- 购买分片集群时，必须填写。- 单位：GB，支持1核2GB、2核4GB、4核8GB、8核16GB、16核32GB。注意为空时取默认取值为4G。", "example": "4" }, { "name": "MongosNum", "type": "integer", "required": false, "description": "指 Mongos 个数，取值范围为[3,32]。若为分片集群实例询价，则该参数必须设置。注意为空时取默认取值为3个节点。", "example": "3" }, { "name": "ConfigServerCpu", "type": "integer", "required": false, "description": "指 ConfigServer CPU核数，固定取值为 1，单位：GB，可不配置该参数。", "example": "1" }, { "name": "ConfigServerMemory", "type": "integer", "required": false, "description": "指 ConfigServer 内存大小，固定取值为 2，单位：GB，可不配置该参数。", "example": "2" }, { "name": "ConfigServerVolume", "type": "integer", "required": false, "description": "指 ConfigServer 磁盘大小，固定取值为 20，单位：GB，可不配置该参数。", "example": "20" } ], "required": [ "Zone", "NodeNum", "Memory", "Volume", "MongoVersion", "MachineCode", "GoodsNum", "ClusterType", "ReplicateSetNum" ] }, { "name": "InquirePriceModifyDBInstanceSpec", "description": "本接口 (InquirePriceModifyDBInstanceSpec) 用于查询实例配置变更后的价格。", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "实例 ID，例如：cmgo-p8vn****。请登录 [MongoDB 控制台](https://console.cloud.tencent.com/mongodb)在实例列表复制实例 ID。", "example": "cmgo-8oij5631" }, { "name": "Memory", "type": "integer", "required": true, "description": "变更配置后实例内存大小，单位：GB。具体售卖的内存规格，请通过接口 [DescribeSpecInfo](https://cloud.tencent.com/document/product/240/38567) 获取。", "example": "8" }, { "name": "Volume", "type": "integer", "required": true, "description": "变更配置后实例磁盘大小，单位：GB。每一个 CPU 规格对应的最大磁盘与最小磁盘范围，请通过接口 [DescribeSpecInfo](https://cloud.tencent.com/document/product/240/38567) 获取。", "example": "200" }, { "name": "NodeNum", "type": "integer", "required": false, "description": "实例节点数量。请通过接口 [DescribeSpecInfo](https://cloud.tencent.com/document/product/240/38567) 获取。 - 副本集实例，指变更配置后实例的主从节点数量。 - 分片集群实例，指变更配置后实例每一个分片的主从节点数。 **说明**：切勿同时发起调整节点数、调整分片数、调整节点规格的任务。", "example": "3" }, { "name": "ReplicateSetNum", "type": "integer", "required": false, "description": "分片集群实例，指变更配置后实例的分片数量。取值范围：[2,36] 。 **说明**：变更后的分片数量不能小于当前现有的数量。切勿同时发起调整节点数、调整分片数与调整节点规格的任务。", "example": "2" } ], "required": [ "InstanceId", "Memory", "Volume" ] }, { "name": "InquirePriceRenewDBInstances", "description": "本接口 (InquiryPriceRenewDBInstances) 用于续费包年包月实例询价。", "status": "online", "parameters": [ { "name": "InstanceIds", "type": "array", "required": true, "description": "实例ID。请登录[MongoDB 控制台](https://console.cloud.tencent.com/mongodb)在实例列表复制实例 ID，且单次最多同时查询5个实例。", "example": "[\"cmgo-8oij****\"]", "item_type": "string" }, { "name": "InstanceChargePrepaid", "type": "object", "required": true, "description": "预付费模式（即包年包月）相关参数设置。通过该参数可以指定包年包月实例的续费时长、是否设置自动续费等属性。", "example": "无", "children": [ { "name": "Period", "type": "integer", "required": false, "description": "购买实例的时长，单位：月。取值范围：1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 24, 36。默认为1。", "example": "1" }, { "name": "RenewFlag", "type": "string", "required": false, "description": "自动续费标识。取值范围： - NOTIFY_AND_AUTO_RENEW：通知过期且自动续费。在账户余额充足的情况下，实例到期后将按月自动续费。 - NOTIFY_AND_MANUAL_RENEW：通知过期不自动续费。默认为NOTIFY_AND_MANUAL_RENEW。 - DISABLE_NOTIFY_AND_MANUAL_RENEW：不通知过期不自动续费。", "example": "NOTIFY_AND_AUTO_RENEW" } ] } ], "required": [ "InstanceIds", "InstanceChargePrepaid" ] }, { "name": "InstanceEnableSSL", "description": "本接口（InstanceEnableSSL）用于设置实例SSL状态。", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "实例ID", "example": "cmgo-eqmoaxxx" }, { "name": "Enable", "type": "boolean", "required": true, "description": "配置是否要开启SSL访问。 - true：开启。 - false：关闭。", "example": "true" } ], "required": [ "InstanceId", "Enable" ] }, { "name": "IsolateDBInstance", "description": "本接口（IsolateDBInstance）用于隔离 MongoDB 云数据库按量计费实例。隔离后实例保留在回收站中，不能再写入数据。隔离一定时间后，实例会彻底删除，回收站保存时间请参考按量计费的服务条款。已删除的按量计费实例无法恢复，请谨慎操作。", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "实例 ID。请登录 [MongoDB 控制台](https://console.cloud.tencent.com/mongodb)在实例列表复制需隔离的实例 ID。", "example": "cmgo-f555zzzz" } ], "required": [ "InstanceId" ] }, { "name": "KillOps", "description": "本接口（KillOps）用于终止 MongoDB 云数据库实例上执行的特定操作。", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "实例 ID。请登录 [MongoDB 控制台](https://console.cloud.tencent.com/mongodb)在实例列表复制实例 ID。", "example": "cmgo-p8vnipr5" }, { "name": "Operations", "type": "array", "required": true, "description": "待终止的操作。", "example": "无", "item_type": "object", "children": [ { "name": "ReplicaSetName", "type": "string", "required": true, "description": "操作所在的分片名称。请通过接口 [DescribeCurrentOp](https://cloud.tencent.com/document/product/240/48120) 查询分片名称。", "example": "cmgo-bbzl****_0" }, { "name": "NodeName", "type": "string", "required": true, "description": "操作所在的节点名。请通过接口 [DescribeCurrentOp](https://cloud.tencent.com/document/product/240/48120) 查询节点名称。", "example": "30.99.***.*:7005:244****" }, { "name": "OpId", "type": "integer", "required": true, "description": "操作序号。请通过接口 [DescribeCurrentOp](https://cloud.tencent.com/document/product/240/48120) 查询操作序号。", "example": "918759117" } ] } ], "required": [ "InstanceId", "Operations" ] }, { "name": "ModifyAuditService", "description": "本接口(ModifyAuditService)用于修改云数据库审计策略的服务配置，包括审计日志保存时长等。", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "实例ID，格式如：cmgo-xfts****，与云数据库控制台页面中显示的实例 ID 相同。", "example": "cmgo-xfts****" }, { "name": "LogExpireDay", "type": "integer", "required": false, "description": "审计日志保存时长。单位为：天。当前支持的取值包括： 7： 一周。 30： 一个月。 90： 三个月。 180 ： 六个月。 365 ： 一年。 1095 ： 三年。 1825 ： 五年。", "example": "30" }, { "name": "AuditAll", "type": "boolean", "required": false, "description": "true-全审计，false-规则审计，注意：AuditAll=true 时，RuleFilters 无需填参", "example": "false" }, { "name": "RuleFilters", "type": "array", "required": false, "description": "审计过滤规则，Type的范围【SrcIp、DB、Collection、User、SqlType】，注意：Type=SqlType时，Value必须在这个范围 [\"query\", \"insert\", \"update\", \"delete\", \"command\"]", "example": "无", "item_type": "object", "children": [ { "name": "Type", "type": "string", "required": true, "description": "过滤条件名称", "example": "SqlType" }, { "name": "Compare", "type": "string", "required": true, "description": "过滤条件匹配类型，注意：此参数取值只能等于EQ", "example": "EQ" }, { "name": "Value", "type": "array", "required": true, "description": "过滤条件匹配值", "example": "[\"1-100\",\"200-300\"]", "item_type": "string" } ] } ], "required": [ "InstanceId" ] }, { "name": "ModifyDBInstanceNetworkAddress", "description": "本接口（ModifyDBInstanceNetworkAddress）用于修改云数据库实例的网络信息，支持基础网络切换为私有网络、私有网络切换私有网络。", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "指定需修改网络的实例 ID。例如：cmgo-p8vn****。请登录 [MongoDB 控制台](https://console.cloud.tencent.com/mongodb)在实例列表复制实例 ID。", "example": "cmgo-7pjedvz7" }, { "name": "OldIpExpiredTime", "type": "integer", "required": true, "description": "原 IP 地址保留时长。 - 单位为分钟，0表示立即回收原 IP 地址。 - 原 IP 将在约定时间后释放，在释放前原 IP和新 IP均可访问。", "example": "1" }, { "name": "NewUniqVpcId", "type": "string", "required": true, "description": "切换后的私有网络 ID，若实例当前为基础网络，该字段无需配置。请通过接口 [DescribeDBInstances](https://cloud.tencent.com/document/product/240/38568) 获取私有网络 ID。", "example": "vpc-****" }, { "name": "NewUniqSubnetId", "type": "string", "required": true, "description": "切换后私有网络的子网 ID。若实例当前为基础网络，该字段无需配置。请通过接口 [DescribeDBInstances](https://cloud.tencent.com/document/product/240/38568) 获取私有网络的子网 ID。", "example": "subnet-****" }, { "name": "NetworkAddresses", "type": "array", "required": false, "description": "IP 地址信息，包含新 IP 地址与 原 IP 地址。", "example": "无", "item_type": "object", "children": [ { "name": "NewIPAddress", "type": "string", "required": true, "description": "新IP地址。", "example": "172.16.0.**" }, { "name": "OldIpAddress", "type": "string", "required": true, "description": "原IP地址。", "example": "172.16.1.**" } ] } ], "required": [ "InstanceId", "OldIpExpiredTime", "NewUniqVpcId", "NewUniqSubnetId" ] }, { "name": "ModifyDBInstanceParamTpl", "description": "本接口(ModifyDBInstanceParamTpl )用于修改MongoDB云数据库实例的参数模板。 **说明：ModifyDBInstanceParamTpl API正在公测中，在此期间，该接口仅对公测用户开放**", "status": "online", "parameters": [ { "name": "TplId", "type": "string", "required": true, "description": "待修改的参数模板 ID。请通过接口 [DescribeDBInstanceParamTpl](https://cloud.tencent.com/document/product/240/109155) 获取模板 ID。", "example": "tpl-sdh134udi" }, { "name": "TplName", "type": "string", "required": false, "description": "待修改参数模板名称，为空时，保持原有名称。", "example": "压测模板" }, { "name": "TplDesc", "type": "string", "required": false, "description": "待修改参数模板描述，为空时，保持原有描述。", "example": "用于压测" }, { "name": "Params", "type": "array", "required": false, "description": "待修改参数名及参数值，为空时，各参数保持原有值，支持单条或批量修改。", "example": "无", "item_type": "object", "children": [ { "name": "Key", "type": "string", "required": true, "description": "参数", "example": "balance.window" }, { "name": "Value", "type": "string", "required": true, "description": "参数值", "example": "1|2" } ] } ], "required": [ "TplId" ] }, { "name": "ModifyDBInstanceSecurityGroup", "description": "本接口（ModifyDBInstanceSecurityGroup）用于修改实例绑定的安全组", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "实例 ID。请登录 [MongoDB 控制台](https://console.cloud.tencent.com/mongodb)在实例列表复制实例 ID。", "example": "cmgo-7pjedvz7" }, { "name": "SecurityGroupIds", "type": "array", "required": true, "description": "目标安全组 ID。请登录[安全组控制台页面](https://console.cloud.tencent.com/vpc/security-group)复制目标安全组 ID。 **注意**：该入参会全量替换存量已有集合，非增量更新。修改需传入预期的全量集合。", "example": "[\"sg-a\", \"sg-b\"]", "item_type": "string" } ], "required": [ "InstanceId", "SecurityGroupIds" ] }, { "name": "ModifyDBInstanceSpec", "description": "本接口（ModifyDBInstanceSpec）用于调整MongoDB云数据库实例配置。接口支持的售卖规格，可从查询云数据库的售卖规格（[DescribeSpecInfo](https://cloud.tencent.com/document/product/240/38567)）获取。", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "实例 ID。请登录 [MongoDB 控制台](https://console.cloud.tencent.com/mongodb)在实例列表复制实例 ID。", "example": "cmgo-p8vn****" }, { "name": "Memory", "type": "integer", "required": false, "description": "实例配置变更后的内存大小。单位：GB。该参数为空值时，默认取实例当前的内存大小。当前所支持的内存规格，请参见[产品规格](https://cloud.tencent.com/document/product/240/64125)。 **注意**：内存和磁盘必须同时升配或同时降配，即 Memory 与 Volume 需同时配置变更。", "example": "4" }, { "name": "Volume", "type": "integer", "required": false, "description": "实例配置变更后的硬盘大小，单位：GB。该参数为空值时，默认取当前实例的磁盘大小。当前所支持的磁盘容量，请参见[产品规格](https://cloud.tencent.com/document/product/240/64125)。 - 内存和磁盘必须同时升配或同时降配，即 Memory 与 Volume 需同时配置变更。 - 降配时，变更后的磁盘容量必须大于已用磁盘容量的1.2倍。", "example": "250" }, { "name": "NodeNum", "type": "integer", "required": false, "description": "实例变更后 mongod 的节点数（不包含 readonly 只读节点数）。 - 副本集节点数：请通过 [DescribeSpecInfo ](https://cloud.tencent.com/document/product/240/38567)接口返回的参数 MinNodeNum 与 MaxNodeNum 获取节点数量取值范围。 - 分片集群每个分片节点数：请通过 [DescribeSpecInfo ](https://cloud.tencent.com/document/product/240/38567)接口返回的参数 MinReplicateSetNodeNum 与 MaxReplicateSetNodeNum 获取节点数量取值范围。 **说\ufffd...", "example": "3" }, { "name": "ReplicateSetNum", "type": "integer", "required": false, "description": "实例变更后的分片数。 - 请通过 [DescribeSpecInfo](https://cloud.tencent.com/document/product/240/38567) 接口返回的参数**MinReplicateSetNum**与**MaxReplicateSetNum**获取实例分片数取值范围。 - 实例分片数量只允许增加不允许减少。", "example": "3" }, { "name": "InMaintenance", "type": "integer", "required": false, "description": "实例配置变更的切换时间。 - 0：调整完成时，立即执行变配任务。默认为0。 - 1：在维护时间窗内，执行变配任务。 **说明**：调整节点数和分片数不支持在维护时间窗内变更。", "example": "0" }, { "name": "MongosMemory", "type": "string", "required": false, "description": "分片实例配置变更后的 mongos 内存大小。单位：GB。实例支持的规格，请参见[产品规格](https://cloud.tencent.com/document/product/240/64125)。", "example": "2" }, { "name": "AddNodeList", "type": "array", "required": false, "description": "新增节点列表，节点类型及可用区信息。", "example": "无", "item_type": "object", "children": [ { "name": "Role", "type": "string", "required": true, "description": "需要新增的节点角色。 - SECONDARY：Mongod 节点。 - READONLY：只读节点。 - MONGOS：Mongos 节点。", "example": "SECONDARY" }, { "name": "Zone", "type": "string", "required": true, "description": "节点所对应的可用区。当前支持的可用区，请参见[地域和可用区](https://cloud.tencent.com/document/product/240/3637)。 - 单可用区，所有节点在同一可用区。 - 多可用区：当前标准规格是三可用区分布，主从节点不在同一可用区，需注意配置新增节点对应的可用区，且新增后必须满足任意2个可用区节点数大于第3个可用区原则。", "example": "ap-guangzhou-2" } ] }, { "name": "RemoveNodeList", "type": "array", "required": false, "description": "删除节点列表。 **注意**：基于分片实例各片节点的一致性原则，删除分片实例节点时，只需指定0分片对应的节点即可，如：cmgo-9nl1czif_0-node-readonly0 将删除每个分片的第1个只读节点。", "example": "无", "item_type": "object", "children": [ { "name": "Role", "type": "string", "required": true, "description": "需要删除的节点角色。 - SECONDARY：Mongod 从节点。 - READONLY：只读节点。 - MONGOS：Mongos 节点。", "example": "SECONDARY" }, { "name": "NodeName", "type": "string", "required": true, "description": "要删除的节点 ID。分片集群须指定一组分片要删除的节点名称即可，其余分片对该组对齐。 - 获取方式：登录 [MongoDB控制台](https://console.cloud.tencent.com/mongodb)，在**节点管理**页签，可获取**节点 ID**。 - 特别说明：分片集群同一节点上的分片，仅需指定0分片节点 ID 即可。例如：cmgo-6hfk\\*\\*\\*\\*\\_0-node-primary。", "example": "cmgo-3iecwbfx_0-node-readonly0" }, { "name": "Zone", "type": "string", "required": true, "description": "节点所对应的可用区。当前支持可用区信息，请参见[地域和可用区](https://cloud.tencent.com/document/product/240/3637)。 - 单可用区，所有节点在同一可用区。 - 多可用区：当前标准规格是三可用区分布，主从节点不在同一可用区，需注意配置所删除节点对应的可用区，且删除后必须满足任意2个可用区节点数大于第3个可用区原则。", "example": "ap-guangzhou-2" } ] } ], "required": [ "InstanceId" ] }, { "name": "ModifyInstanceParams", "description": "本接口（ModifyInstanceParams）用于修改mongoDB实例的参数配置。", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "指定实例 ID。例如：cmgo-p8vn****。请登录 [MongoDB 控制台](https://console.cloud.tencent.com/mongodb)在实例列表复制实例 ID。", "example": "\"cmgo-jyjcw8yv\"" }, { "name": "InstanceParams", "type": "array", "required": true, "description": "指定需修改的参数名及值。当前所支持的参数名及对应取值范围，请通过 [DescribeInstanceParams ](https://cloud.tencent.com/document/product/240/65903)获取。", "example": "无", "item_type": "object", "children": [ { "name": "Key", "type": "string", "required": true, "description": "需要修改的参数名称，请严格参考通过 DescribeInstanceParams 获取的当前实例支持的参数名。", "example": "\"operationProfiling.****\"" }, { "name": "Value", "type": "string", "required": true, "description": "需要修改的参数名称对应的值，请严格参考通过 DescribeInstanceParams 获取的参数对应的值的范围。", "example": "off" } ] }, { "name": "ModifyType", "type": "string", "required": false, "description": "操作类型，包括： - IMMEDIATELY：立即调整。 - DELAY：延迟调整。可选字段，不配置该参数则默认为立即调整。", "example": "IMMEDIATELY" } ], "required": [ "InstanceId", "InstanceParams" ] }, { "name": "ModifySRVConnectionUrl", "description": "本接口（DisableSRVConnectionUrl）用于修改MongoDB数据库的SRV访问地址的TTL时长。", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "实例 ID。请登录 [MongoDB 控制台](https://console.cloud.tencent.com/mongodb)在实例列表复制实例 ID。", "example": "cmgo-p8vn****" }, { "name": "CustomDomain", "type": "string", "required": true, "description": "自定义的实例的访问域名。", "example": "mydomain001" } ], "required": [ "InstanceId", "CustomDomain" ] }, { "name": "OfflineIsolatedDBInstance", "description": "本接口(OfflineIsolatedDBInstance)用于立即下线隔离状态的云数据库实例。进行操作的实例状态必须为隔离状态。", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "实例ID。请登录 [MongoDB 控制台回收站](https://console.cloud.tencent.com/mongodb/recycle)在实例列表复制需下线的实例 ID。", "example": "cmgo-f555zzzz" } ], "required": [ "InstanceId" ] }, { "name": "OpenAuditService", "description": "本接口(OpenAuditService)用于开通云数据库实例的审计。", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "实例 ID，格式如：cmgo-xfts****，与云数据库控制台页面中显示的实例 ID 相同。", "example": "cmgo-xfts****" }, { "name": "LogExpireDay", "type": "integer", "required": true, "description": "审计日志保存时长。单位为：天。当前支持的取值包括： 7： 一周。 30： 一个月。 90： 三个月。 180 ： 六个月。 365 ： 一年。 1095 ： 三年。 1825 ： 五年。", "example": "30" }, { "name": "AuditAll", "type": "boolean", "required": false, "description": "true-全审计，false-规则审计，注意：AuditAll=true 时，RuleFilters 无需填参", "example": "false" }, { "name": "RuleFilters", "type": "array", "required": false, "description": "审计过滤规则，Type的范围【SrcIp、DB、Collection、User、SqlType】，注意：Type=SqlType时，Value必须在这个范围 [\"query\", \"insert\", \"update\", \"delete\", \"command\"]", "example": "无", "item_type": "object", "children": [ { "name": "Type", "type": "string", "required": true, "description": "过滤条件名称", "example": "SqlType" }, { "name": "Compare", "type": "string", "required": true, "description": "过滤条件匹配类型，注意：此参数取值只能等于EQ", "example": "EQ" }, { "name": "Value", "type": "array", "required": true, "description": "过滤条件匹配值", "example": "[\"1-100\",\"200-300\"]", "item_type": "string" } ] } ], "required": [ "InstanceId", "LogExpireDay" ] }, { "name": "RenameInstance", "description": "本接口(RenameInstance)用于修改云数据库实例的名称。", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "实例ID，格式如：cmgo-p8vnipr5。请登录[MongoDB 控制台](https://console.cloud.tencent.com/mongodb#/)在实例列表复制实例 ID。", "example": "cmgo-eqmoa5sf" }, { "name": "NewName", "type": "string", "required": true, "description": "自定义实例名称，要求为1～128 长度的任意字符。", "example": "test_name" } ], "required": [ "InstanceId", "NewName" ] }, { "name": "RenewDBInstances", "description": "本接口(RenewDBInstance)用于续费云数据库实例，仅支持付费模式为包年包月的实例。按量计费实例不需要续费。", "status": "online", "parameters": [ { "name": "InstanceIds", "type": "array", "required": true, "description": "指定续费的一个或多个待操作的实例ID。 - 可通过[DescribeDBInstances](https://cloud.tencent.com/document/product/240/38568)接口返回值中的**InstanceId**获取。 - 每次续费请求的实例数量上限为100。", "example": "[\"cmgo-gzo0****\"]", "item_type": "string" }, { "name": "InstanceChargePrepaid", "type": "object", "required": true, "description": "预付费模式，即包年包月相关参数设置。通过该参数可以指定包年包月实例的续费时长、是否设置自动续费等属性。包年包月实例该参数为必传参数。", "example": "无", "children": [ { "name": "Period", "type": "integer", "required": false, "description": "购买实例的时长，单位：月。取值范围：1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 24, 36。默认为1。", "example": "1" }, { "name": "RenewFlag", "type": "string", "required": false, "description": "自动续费标识。取值范围： - NOTIFY_AND_AUTO_RENEW：通知过期且自动续费。在账户余额充足的情况下，实例到期后将按月自动续费。 - NOTIFY_AND_MANUAL_RENEW：通知过期不自动续费。默认为NOTIFY_AND_MANUAL_RENEW。 - DISABLE_NOTIFY_AND_MANUAL_RENEW：不通知过期不自动续费。", "example": "NOTIFY_AND_AUTO_RENEW" } ] } ], "required": [ "InstanceIds", "InstanceChargePrepaid" ] }, { "name": "ResetDBInstancePassword", "description": "本接口（ResetDBInstancePassword）用于重置实例访问密码。", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "指定实例 ID。请登录 [MongoDB 控制台](https://console.cloud.tencent.com/mongodb)在实例列表复制实例 ID。", "example": "cmgo-7pjedvz7" }, { "name": "UserName", "type": "string", "required": true, "description": "指定需修改密码的账号名称。可通过接口 [DescribeAccountUsers](https://cloud.tencent.com/document/product/240/80800) 获取账号列表，复制需修改密码的账号。", "example": "rwuser" }, { "name": "Password", "type": "string", "required": true, "description": "指定账户的新密码。密码复杂度要求： - 8-32个字符长度。 - 至少包含字母、数字和字符（!@#%^\\*()\\_）中的两种。", "example": "test_123***" } ], "required": [ "InstanceId", "UserName", "Password" ] }, { "name": "RestartNodes", "description": "本接口（RestartNodes）用于批量重启数据库节点。", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "实例 ID。请登录 [MongoDB 控制台](https://console.cloud.tencent.com/mongodb)在实例列表复制实例 ID。", "example": "cmgo-p8vn****" }, { "name": "NodeIds", "type": "array", "required": true, "description": "需要重启的节点 ID 列表。 - 支持重启的节点类型包含：mongod节点、只读节点、mongos节点。 - 节点 ID，请登录 [MongoDB 控制台](https://console.cloud.tencent.com/mongodb)在**节点管理**页面复制，或者通过 [DescribeDBInstanceNodeProperty ](https://cloud.tencent.com/document/product/240/82022)接口获取。", "example": "[\"cmgo-6heje4jp_0-node-slave0\",\"cmgo-6heje4jp_1-node-slave0\"]", "item_type": "string" } ], "required": [ "InstanceId", "NodeIds" ] }, { "name": "SetAccountUserPrivilege", "description": "本接口（SetAccountUserPrivilege）用于设置实例的账号权限。", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "指定待设置账号的实例ID。例如：cmgo-p8vn****。请登录 [MongoDB 控制台](https://console.cloud.tencent.com/mongodb)在实例列表复制实例 ID。", "example": "cmgo-kbcfl64r" }, { "name": "UserName", "type": "string", "required": true, "description": "设置访问实例的账号名称。设置要求为：字母开头的1-64个字符，只可输入[A,Z]、[a,z]、[1,9]范围的字符以及下划线“_”与短划线“-”。", "example": "test_123" }, { "name": "AuthRole", "type": "array", "required": true, "description": "设置权限信息。", "example": "无", "item_type": "object", "children": [ { "name": "Mask", "type": "integer", "required": true, "description": "当前账号具有的权限信息。 - 0：无权限。 - 1：只读。 - 3：读写。 注意：此字段可能返回 null，表示取不到有效值。", "example": "1" }, { "name": "NameSpace", "type": "string", "required": true, "description": "指具有当前账号权限的数据库名。 - \\* ：表示所有数据库。 - db.name：表示特定 name 的数据库。 注意：此字段可能返回 null，表示取不到有效值。", "example": "\"db_test\"" } ] } ], "required": [ "InstanceId", "UserName", "AuthRole" ] }, { "name": "SetBackupRules", "description": "本接口（SetBackupRules）用于设置 MongoDB 云数据库的自动备份规则。", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "实例 ID。请登录 [MongoDB 控制台](https://console.cloud.tencent.com/mongodb)在实例列表复制实例 ID。", "example": "cmgo-p8vn****" }, { "name": "BackupMethod", "type": "integer", "required": false, "description": "备份方式。 - 0：逻辑备份。 - 1：物理备份。 - 3：快照备份。 **说明**: 1. 通用版实例支持逻辑备份与物理备份。云盘版实例支持物理备份与快照备份，暂不支持逻辑备份。 2. 实例开通存储加密，则备份方式不能为物理备份。", "example": "1" }, { "name": "BackupTime", "type": "integer", "required": false, "description": "设置自动备份开始时间。取值范围为：[0,23]，例如：该参数设置为2，表示02:00开始备份。", "example": "2" }, { "name": "BackupFrequency", "type": "integer", "required": false, "description": "指定每日自动备份频率。 - 12: 每日备份2次，间隔约12小时。 - 24: 每日备份1次（默认），间隔约24小时。", "example": "2" }, { "name": "Notify", "type": "boolean", "required": false, "description": "设置自动备份发生错误时，是否发送失败告警。 - true：发送。 - false：不发送。", "example": "true" }, { "name": "BackupRetentionPeriod", "type": "integer", "required": false, "description": "指定备份数据保留时长。 - 单位：天，默认为 7 天。 - 取值范围：[7,365]。", "example": "7" }, { "name": "ActiveWeekdays", "type": "string", "required": false, "description": "指定每周内执行自动备份的具体日期。 - 格式：请输入 0-6 之间的数字代表周日至周六（例如：1 代表周一），多个日期请用英文逗号 , 分隔。 - 示例：输入 1,3,5 表示系统将在每周的周一、周三、周五执行备份。 - 默认值：不设置，则默认为全周期 (0,1,2,3,4,5,6)，即每日执行备份。", "example": "0,1,2,3,4,5,6" }, { "name": "LongTermUnit", "type": "string", "required": false, "description": "长期保留周期。支持按周或按月选择特定日期的备份（例如，每月1日、15日的备份数据），将其保留更长周期。- 不开启（默认）：不启用长期保留功能。- 按周保留： 指定为 weekly。- 按月保留： 指定为 monthly。待废弃，使用LongTermInterval", "example": "monthly" }, { "name": "LongTermActiveDays", "type": "string", "required": false, "description": "指定用于长期保留的具体备份日期。此设置仅在 **LongTermUnit** 被设为**weekly** 或 **monthly** 时生效。 - 按周（weekly）保留：请输入 0-6 之间的数字来代表周日至周六。多个日期请用英文逗号分隔。 - 按月（monthly）保留：请输入 1-31 之间的数字来代表月份中的具体日期。多个日期请用英文逗号分隔。", "example": "1,2" }, { "name": "LongTermExpiredDays", "type": "integer", "required": false, "description": "长期备份保留时长。取值范围[30,1075]。", "example": "30" }, { "name": "OplogExpiredDays", "type": "integer", "required": false, "description": "增量备份保留时长。 - 单位：天。 - 默认值：7天。 - 取值范围：[7,365]。", "example": "7" }, { "name": "BackupVersion", "type": "integer", "required": false, "description": "指定备份版本。 - 旧版本备份：0。 - 开启高级备份：1。", "example": "1" }, { "name": "AlarmWaterLevel", "type": "integer", "required": false, "description": "设置备份数据集存储空间使用率的告警阈值。- 单位：%。- 默认值：100。- 取值范围：[50,300]。待废弃,使用AlertThreshold", "example": "100" }, { "name": "LongTermInterval", "type": "string", "required": false, "description": "长期保留周期。支持按周或按月选择特定日期的备份（例如，每月1日、15日的备份数据），将其保留更长周期。- 不开启（默认）：不启用长期保留功能。- 按周保留： 指定为 weekly。- 按月保留： 指定为 monthly。", "example": "monthly" }, { "name": "AlertThreshold", "type": "integer", "required": false, "description": "设置备份数据集存储空间使用率的告警阈值。- 单位：%。- 默认值：100。- 取值范围：[50,300]。", "example": "100" } ], "required": [ "InstanceId" ] }, { "name": "SetDBInstanceDeletionProtection", "description": "本接口（SetDBInstanceDeletionProtection）用于设置实例销毁保护", "status": "online", "parameters": [ { "name": "InstanceIds", "type": "array", "required": true, "description": "实例ID列表，格式如：cmgo-p8vnipr5。与云数据库控制台页面中显示的实例ID相同", "example": "[\"cmgo-8oij****\"]", "item_type": "string" }, { "name": "EnableDeletionProtection", "type": "integer", "required": true, "description": "实例销毁保护选项，取值范围：0-关闭销毁保护，1-开启销毁保护", "example": "1" } ], "required": [ "InstanceIds", "EnableDeletionProtection" ] }, { "name": "SetInstanceMaintenance", "description": "本接口（SetInstanceMaintenance ） 用于设置实例维护时间窗。", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "指定实例ID。例如：cmgo-p8vn****。请登录 [MongoDB 控制台](https://console.cloud.tencent.com/mongodb)在实例列表复制实例 ID。", "example": "cmgo-7pjedvz7" }, { "name": "MaintenanceStart", "type": "string", "required": true, "description": "维护时间窗开始时间。取值范围为\"00:00-23:00\"的任意整点或半点，如00:00或00:30。", "example": "\"04:00\"" }, { "name": "MaintenanceEnd", "type": "string", "required": true, "description": "维护时间窗结束时间。 - 取值范围为\"00:00-23:00\"的任意整点或半点，维护时间持续时长最小为30分钟，最大为3小时。 - 结束时间务必是基于开始时间向后的时间。", "example": "\"05:00\"" } ], "required": [ "InstanceId", "MaintenanceStart", "MaintenanceEnd" ] }, { "name": "TerminateDBInstances", "description": "本接口（TerminateDBInstances）用于退还包年包月计费实例。", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "指定预隔离实例 ID。请登录 [MongoDB 控制台](https://console.cloud.tencent.com/mongodb)在实例列表复制预隔离实例 ID。", "example": "cmgo-7pje****" } ], "required": [ "InstanceId" ] }, { "name": "UpgradeDBInstanceKernelVersion", "description": "本接口(UpgradeDBInstanceKernelVersion)用于升级数据库实例内核版本。", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "实例ID列表，格式如：cmgo-p8vnipr5。与云数据库控制台页面中显示的实例ID相同", "example": "cmgo-p8vnipr5" }, { "name": "InMaintenance", "type": "integer", "required": false, "description": "是否维护时间内升级。0-否，1-是", "example": "无" } ], "required": [ "InstanceId" ] }, { "name": "UpgradeDbInstanceVersion", "description": "本接口（UpgradeDbInstanceVersion）用于升级数据库版本。 **说明**：支持3.6及以上版本升级，仅支持从低版本向高版本逐级升级，不支持跨版本升级或版本降级。", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "实例ID列表，格式如：cmgo-p8vnipr5。与云数据库控制台页面中显示的实例ID相同。", "example": "cmgo-p8vnipr5" }, { "name": "MongoVersion", "type": "string", "required": true, "description": "新升级的数据库版本。当前支持版本如下所示，支持旧版本向高版本升级，不支持跨版本升级。 - MONGO_40_WT：4.0 版本。 - MONGO_42_WT：4.2 版本。 - MONGO_44_WT：4.4 版本 - MONGO_50_WT：5.0 版本 - MONGO_60_WT：6.0 版本。 - MONGO_70_WT：7.0 版本。 - MONGO_80_WT：8.0 版本。", "example": "MONGO_42_WT" }, { "name": "InMaintenance", "type": "integer", "required": false, "description": "指定升级操作是否在维护时间内进行。 - 0：立即升级。 - 1：维护时间窗升级。", "example": "0" } ], "required": [ "InstanceId", "MongoVersion" ] } ] }