{ "name": "tcb", "display_name": "云开发 CloudBase", "description": "介绍如何使用API对云开发 CloudBase进行操作，包括更新环境信息、TCB云API统一入口等。", "domain": "other", "api_version": "2018-06-08", "endpoint": "tcb.tencentcloudapi.com", "actions": [ { "name": "BindCloudBaseAccessDomain", "description": "绑定云开发自定义域名，用于云接入和静态托管", "status": "online", "parameters": [ { "name": "ServiceId", "type": "string", "required": true, "description": "服务Id，目前是指环境Id", "example": "envid-28383" }, { "name": "Domain", "type": "string", "required": true, "description": "自定义域名", "example": "example.com" }, { "name": "CertId", "type": "string", "required": false, "description": "腾讯云证书Id", "example": "certid-2323" }, { "name": "BindFlag", "type": "integer", "required": false, "description": "默认1，1 绑定默认Cdn，2 绑定TcbIngress（不经过cdn），4 绑定自定义cdn", "example": "1" }, { "name": "CustomCname", "type": "string", "required": false, "description": "自定义cdn cname域名", "example": "example.com.dns.com" } ], "required": [ "ServiceId", "Domain" ] }, { "name": "BindCloudBaseGWDomain", "description": "绑定自定义域名", "status": "online", "parameters": [ { "name": "ServiceId", "type": "string", "required": true, "description": "服务ID", "example": "无" }, { "name": "Domain", "type": "string", "required": true, "description": "服务域名", "example": "无" }, { "name": "CertId", "type": "string", "required": false, "description": "证书ID", "example": "无" }, { "name": "EnableRegion", "type": "boolean", "required": false, "description": "是否启用多地域", "example": "无" } ], "required": [ "ServiceId", "Domain" ] }, { "name": "CheckTcbService", "description": "检查是否开通Tcb服务", "status": "online", "parameters": [], "required": [] }, { "name": "CreateAuthDomain", "description": "增加安全域名。 云开发会校验网页应用请求的来源域名，您需要将来源域名加入到WEB安全域名列表中。 可以通过接口 [DescribeAuthDomains](https://cloud.tencent.com/document/product/876/42151) 获取当前已绑定生效的安全域名。 注意⚠️ 安全域名绑定成功之后，需要几分钟时间逐步生效。", "status": "online", "parameters": [ { "name": "EnvId", "type": "string", "required": true, "description": "环境ID", "example": "envid" }, { "name": "Domains", "type": "array", "required": true, "description": "安全域名", "example": "[\"www.qq.com\"]", "item_type": "string" } ], "required": [ "EnvId", "Domains" ] }, { "name": "CreateBillDeal", "description": "创建云开发产品计费订单，用于以下几种场景： 1. 购买云开发环境 2. 续费云开发环境 3. 变更云开发环境套餐 4. 购买云开发资源包 5. 购买云开发大促包 该接口支持下单并支付(CreateAndPay=true时)，此时会自动在腾讯云账户中扣除余额（余额不足会下单失败）。 该接口支持自动扣除代金券（AutoVoucher=true时），符合条件的代金券会被自动扣除。", "status": "online", "parameters": [ { "name": "DealType", "type": "string", "required": true, "description": "当前下单的操作类型，可取[purchase,renew,modify]三种值，分别代表新购，续费，变配。", "example": "purchase" }, { "name": "ProductType", "type": "string", "required": true, "description": "购买的产品类型，可取[tcb-baas,tcb-promotion,tcb-package], 分别代表baas套餐、大促包、资源包", "example": "tcb-baas" }, { "name": "PackageId", "type": "string", "required": true, "description": "目标下单产品/套餐Id。 对于云开发环境套餐，可通过 DescribeBaasPackageList 接口获取，对应其出参的PackageName", "example": "baas_personal" }, { "name": "CreateAndPay", "type": "boolean", "required": false, "description": "默认只下单不支付，为ture则下单并支付。 如果需要下单并支付，请确保账户下有足够的余额，否则会导致下单失败。", "example": "true" }, { "name": "TimeSpan", "type": "integer", "required": false, "description": "购买时长，与TimeUnit字段搭配使用。", "example": "1" }, { "name": "TimeUnit", "type": "string", "required": false, "description": "购买时长单位,按各产品规则可选d(天),m(月),y(年),p(一次性)。 对于 云开发环境的 新购和续费，目前仅支持 按月购买（即 TimeUnit=m）。", "example": "m" }, { "name": "ResourceId", "type": "string", "required": false, "description": "资源唯一标识。 在云开发环境 续费和变配 场景下必传，取值为环境ID。", "example": "cloud-0g6kw62kbda53cb6" }, { "name": "Source", "type": "string", "required": false, "description": "来源可选[qcloud,miniapp]，默认qcloud。 miniapp表示微信云开发，主要适用于[小程序云开发](https://developers.weixin.qq.com/miniprogram/dev/wxcloudservice/wxcloud/billing/price.html)。", "example": "qcloud" }, { "name": "Alias", "type": "string", "required": false, "description": "环境别名，用于新购云开发环境时，给云开发环境起别名。 仅当 新购云开发环境（DealType=purchase 并且 ProductType=tcb-baas ）时有效。 ### 格式要求 - 可选字符： 小写字母(a~z)、数字、减号(-) - 不能以 减号(-) 开头或结尾 - 不能有连个连续的 减号(-) - 长度不超过20位", "example": "cloud" }, { "name": "EnvId", "type": "string", "required": false, "description": "环境id，当购买资源包和大促包时（ProductType取值为tcb-promotion 或 tcb-package）必传，表示资源包在哪个环境下生效。", "example": "cloud-0g6kw62kbda53cb6" }, { "name": "EnableExcess", "type": "boolean", "required": false, "description": "开启超限按量。 开启后，当 套餐内的资源点 和 资源包 都用尽后，会自动按量计费。 详见 [计费说明](https://cloud.tencent.com/document/product/876/127357)。", "example": "true" }, { "name": "ModifyPackageId", "type": "string", "required": false, "description": "变配目标套餐id，对于云开发环境变配场景下必传。 对于云开发环境套餐，可通过 DescribeBaasPackageList 接口获取，对应其出参的PackageName", "example": "baas_team" }, { "name": "Extension", "type": "string", "required": false, "description": "jsonstr附加信息", "example": "\"{}\"" }, { "name": "AutoVoucher", "type": "boolean", "required": false, "description": "是否自动选择代金券支付。", "example": "false" }, { "name": "ResourceTypes", "type": "array", "required": false, "description": "资源类型。 代表新购环境（DealType=purchase 并且 ProductType=tcb-baas ）时需要发货哪些资源。 可取值：flexdb, cos, cdn, scf", "example": "[\"flexdb\"]", "item_type": "string" }, { "name": "EnvTags", "type": "array", "required": false, "description": "环境标签。 代表新购环境（DealType=purchase 并且 ProductType=tcb-baas ）时需要打的标签。", "example": "无", "item_type": "object", "children": [ { "name": "Key", "type": "string", "required": true, "description": "标签键", "example": "key" }, { "name": "Value", "type": "string", "required": true, "description": "标签值", "example": "value" } ] } ], "required": [ "DealType", "ProductType", "PackageId" ] }, { "name": "CreateCloudBaseGWAPI", "description": "创建云开发网关API", "status": "online", "parameters": [ { "name": "ServiceId", "type": "string", "required": true, "description": "Service ID", "example": "env-123" }, { "name": "Path", "type": "string", "required": true, "description": "API Path", "example": "/test" }, { "name": "Type", "type": "integer", "required": true, "description": "API类型（1表示云函数，2表示容器）", "example": "2" }, { "name": "Name", "type": "string", "required": true, "description": "API Name", "example": "servicename" }, { "name": "APIId", "type": "string", "required": false, "description": "APIId，如果非空，表示修改绑定Path", "example": "xxxxx-xxxxx-xxxxx-xxxxx-xxxxx" }, { "name": "Custom", "type": "string", "required": false, "description": "自定义值通用字段（当Type为容器时必填）", "example": "无" }, { "name": "AuthSwitch", "type": "integer", "required": false, "description": "认证开关 1为开启 2为关闭", "example": "2" }, { "name": "EnableRegion", "type": "boolean", "required": false, "description": "是否开启多地域", "example": "true" }, { "name": "EnableUnion", "type": "boolean", "required": false, "description": "是否启用统一域名", "example": "true" }, { "name": "Domain", "type": "string", "required": false, "description": "域名", "example": "*" }, { "name": "AccessTypes", "type": "array", "required": false, "description": "访问类型：\"OA\", \"PUBLIC\", \"MINIAPP\", \"VPC\" （不传默认PUBLIC+MINIAPP+VPC）", "example": "[\"OA\", \"PUBLIC\", \"MINIAPP\", \"VPC\"]", "item_type": "string" }, { "name": "IsShortPath", "type": "boolean", "required": false, "description": "是否开启路径透传，默认true表示短路径，即不开启路径透传(已弃用)", "example": "true" }, { "name": "PathTransmission", "type": "integer", "required": false, "description": "路径透传，默认0关闭，1开启，2关闭", "example": "2" }, { "name": "EnableCheckAcrossDomain", "type": "integer", "required": false, "description": "跨域校验，默认0开启，1开启，2关闭", "example": "1" }, { "name": "StaticFileDirectory", "type": "string", "required": false, "description": "静态托管资源目录", "example": "/TEST" } ], "required": [ "ServiceId", "Path", "Type", "Name" ] }, { "name": "CreateEnv", "description": "本接口用于购买云开发环境。 该接口会自动下单并支付，会在腾讯云账户中扣除余额（余额不足会下单失败）。 该接口支持自动扣除代金券（AutoVoucher=true时），符合条件的代金券会被自动扣除。 环境下单成功之后会返回EnvId。EnvId是全局唯一表示。 环境发货是异步行为，后续可以通过接口 [DescribeEnvs ](https://cloud.tencent.com/document/product/876/34820) 查询环境状态和各项资源信息；通...", "status": "online", "parameters": [ { "name": "Alias", "type": "string", "required": true, "description": "环境别名。 ### 格式要求 - 可选字符： 小写字母(a~z)、数字、减号(-) - 不能以 减号(-) 开头或结尾 - 不能有连个连续的 减号(-) - 长度不超过20位 示例值：cloud", "example": "cloudbase" }, { "name": "PackageId", "type": "string", "required": true, "description": "云开发环境套餐Id。 对于云开发环境套餐，可通过 [DescribeBaasPackageList](https://cloud.tencent.com/document/product/876/78167) 接口获取，对应其出参的PackageName。", "example": "baas_personal" }, { "name": "Resources", "type": "array", "required": true, "description": "资源类型。代表新购环境时需要发货哪些资源。 可取值以及含义： - flexdb : 表示文档型数据库 - storage : 表示云存储 - function : 表示云函数 **该字段不可为空**", "example": "[\"flexdb\"]", "item_type": "string" }, { "name": "Period", "type": "integer", "required": false, "description": "购买实例的时长，单位：月。取值范围：1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 24。 默认值为1，即1个月。", "example": "1" }, { "name": "AutoVoucher", "type": "boolean", "required": false, "description": "是否自动选择代金券支付。", "example": "true" }, { "name": "Tags", "type": "array", "required": false, "description": "环境标签。 可取值通过接口 [tag:DescribeTags](https://cloud.tencent.com/document/product/651/35316) 可获取到。 不传或为空则默认不打任何标签。", "example": "无", "item_type": "object", "children": [ { "name": "Key", "type": "string", "required": true, "description": "标签键", "example": "key" }, { "name": "Value", "type": "string", "required": true, "description": "标签值", "example": "value" } ] }, { "name": "RenewFlag", "type": "string", "required": false, "description": "自动续费标识。取值范围： - NOTIFY_AND_AUTO_RENEW：通知过期且自动续费 - NOTIFY_AND_MANUAL_RENEW：通知过期不自动续费（需要手动续费，可通过接口 [RenewEnv](https://cloud.tencent.com/document/product/876/128590) 来续费） 默认取值：NOTIFY_AND_MANUAL_RENEW。 若该参数指定为NOTIFY_AND_AUTO_RENEW（即：自动续费），在账户余额充足的情况下，实例到期后将按月自动续费；但如果账户余额不足，将无法自动续\ufffd...", "example": "NOTIFY_AND_MANUAL_RENEW" } ], "required": [ "Alias", "PackageId", "Resources" ] }, { "name": "CreateHostingDomain", "description": "创建托管域名", "status": "online", "parameters": [ { "name": "EnvId", "type": "string", "required": true, "description": "环境ID", "example": "env_id" }, { "name": "Domain", "type": "string", "required": true, "description": "域名", "example": "domain" }, { "name": "CertId", "type": "string", "required": true, "description": "证书ID", "example": "cert-id" } ], "required": [ "EnvId", "Domain", "CertId" ] }, { "name": "CreateMySQL", "description": "开通Mysql型数据库 开通后，可通过 [DescribeCreateMySQLResult ](https://cloud.tencent.com/document/api/876/128185) 查询开通结果，Mysql开通成功后，可通过接口设置数据库账号相关功能包括但不限于【创建账号、删除账号、查询可授权权限列表、查询账号已有权限、修改主机、修改配置、修改账号库表权限】、集群操作相关【查询集群参数、修改集群参数】，连接设置相关【关闭外网、开通外网...", "status": "online", "parameters": [ { "name": "EnvId", "type": "string", "required": true, "description": "云开发环境ID", "example": "**s*e*******g1**dbc0df14561" }, { "name": "DbInstanceType", "type": "string", "required": true, "description": "Db类型: MYSQL", "example": "MYSQL" }, { "name": "MysqlVersion", "type": "string", "required": false, "description": "mysql版本", "example": "5.7" }, { "name": "VpcId", "type": "string", "required": false, "description": "vpc Id", "example": "vpc-py******" }, { "name": "SubnetId", "type": "string", "required": false, "description": "子网ID", "example": "subnet-68r*****" }, { "name": "LowerCaseTableNames", "type": "string", "required": false, "description": "0 区分表名大小写；1 不区分表名大小写(默认)", "example": "1" } ], "required": [ "EnvId", "DbInstanceType" ] }, { "name": "CreateStaticStore", "description": "创建静态托管资源，包括COS和CDN，异步任务创建，查看创建结果需要根据DescribeStaticStore接口来查看", "status": "online", "parameters": [ { "name": "EnvId", "type": "string", "required": true, "description": "环境ID", "example": "env-xxyyzza" }, { "name": "EnableUnion", "type": "boolean", "required": false, "description": "是否启用统一域名", "example": "false" } ], "required": [ "EnvId" ] }, { "name": "CreateTable", "description": "本接口(CreateTable)用于创建文档型数据库表，支持创建capped类型集合，暂时不支持分片表", "status": "online", "parameters": [ { "name": "TableName", "type": "string", "required": true, "description": "数据表名；长度不超过96个字符，可以为英文字母、数字、下划线(_)和短横线(-)的组合，且不能以下划线开头", "example": "in" }, { "name": "Tag", "type": "string", "required": false, "description": "FlexDB实例ID，如：tnt-nl7hjzasw", "example": "tnt-nl7hjzasw" }, { "name": "PermissionInfo", "type": "object", "required": false, "description": "FlexDB数据库权限信息", "example": "无", "children": [ { "name": "AclTag", "type": "string", "required": true, "description": "\"READONLY\", //公有读，私有写。所有用户可读，仅创建者及管理员可写 \"PRIVATE\", //私有读写，仅创建者及管理员可读写 \"ADMINWRITE\", //所有用户可读，仅管理员可写 \"ADMINONLY\", //仅管理员可操作 \"CUSTOM\", // 安全规则", "example": "READONLY" }, { "name": "EnvId", "type": "string", "required": true, "description": "云开发环境ID", "example": "test-env-xxx" }, { "name": "Rule", "type": "string", "required": false, "description": "自定义规则", "example": "无" } ] }, { "name": "EnvId", "type": "string", "required": false, "description": "云开发环境ID", "example": "lowcode-abc" }, { "name": "MongoConnector", "type": "object", "required": false, "description": "MongoDB连接器配置", "example": "无", "children": [ { "name": "InstanceId", "type": "string", "required": false, "description": "连接器实例ID", "example": "mongo_conn" }, { "name": "DatabaseName", "type": "string", "required": false, "description": "MongoDB数据库名", "example": "demo_db" } ] } ], "required": [ "TableName" ] }, { "name": "CreateUser", "description": "创建tcb用户", "status": "online", "parameters": [ { "name": "EnvId", "type": "string", "required": true, "description": "环境id", "example": "test-envId" }, { "name": "Name", "type": "string", "required": true, "description": "用户名，用户名规则：1. 长度1-64字符 2. 只能包含大小写英文字母、数字和符号 . _ - 3. 只能以字母或数字开头 4. 不能重复", "example": "zhangsan" }, { "name": "Uid", "type": "string", "required": false, "description": "用户ID，最多64字符，如不传则系统自动生成", "example": "1001" }, { "name": "Type", "type": "string", "required": false, "description": "用户类型：internalUser-内部用户、externalUser-外部用户，默认internalUser（内部用户）", "example": "internalUser" }, { "name": "Password", "type": "string", "required": false, "description": "密码，传入Uid时密码可不传。密码规则：1. 长度8-32字符（推荐12位以上） 2. 不能以特殊字符开头 3. 至少包含以下四项中的三项：小写字母a-z、大写字母A-Z、数字0-9、特殊字符()!@#$%^\u0026*\\|?\u003e\u003c_-", "example": "Abc@123456" }, { "name": "UserStatus", "type": "string", "required": false, "description": "用户状态：ACTIVE（激活）、BLOCKED（冻结），默认激活", "example": "ACTIVE" }, { "name": "NickName", "type": "string", "required": false, "description": "用户昵称，长度2-64字符", "example": "张三" }, { "name": "Phone", "type": "string", "required": false, "description": "手机号，不能重复", "example": "13800138000" }, { "name": "Email", "type": "string", "required": false, "description": "邮箱地址，不能重复", "example": "zhangsan@example.com" }, { "name": "AvatarUrl", "type": "string", "required": false, "description": "头像链接，可访问的公网URL", "example": "https://example.com/avatars/zhangsan.jpg" }, { "name": "Description", "type": "string", "required": false, "description": "用户描述，最多200字符", "example": "用户描述" } ], "required": [ "EnvId", "Name" ] }, { "name": "DeleteAuthDomain", "description": "删除合法域名。 云开发会校验网页应用请求的来源域名，您需要将来源域名加入到WEB安全域名列表中。 可以通过接口 [DescribeAuthDomains](https://cloud.tencent.com/document/product/876/42151) 获取当前已绑定生效的安全域名。 注意⚠️ 安全域名被删除之后，可能会引起跨域问题，请谨慎操作。", "status": "online", "parameters": [ { "name": "EnvId", "type": "string", "required": true, "description": "开发者的环境ID", "example": "yourEnv" }, { "name": "DomainIds", "type": "array", "required": true, "description": "域名ID列表，支持批量", "example": "[\"abc.com\\n\"]", "item_type": "string" } ], "required": [ "EnvId", "DomainIds" ] }, { "name": "DeleteCloudBaseGWAPI", "description": "删除网关API", "status": "online", "parameters": [ { "name": "ServiceId", "type": "string", "required": true, "description": "服务ID" }, { "name": "Path", "type": "string", "required": false, "description": "API Path" }, { "name": "APIId", "type": "string", "required": false, "description": "API ID" }, { "name": "Type", "type": "integer", "required": false, "description": "API类型" }, { "name": "Name", "type": "string", "required": false, "description": "API Name" }, { "name": "Custom", "type": "string", "required": false, "description": "自定义值字段（Type为2时，传递容器服务名表示需要删除JNSGW）" }, { "name": "Domain", "type": "string", "required": false, "description": "域名" } ], "required": [ "ServiceId" ] }, { "name": "DeleteCloudBaseGWDomain", "description": "删除网关域名", "status": "online", "parameters": [ { "name": "ServiceId", "type": "string", "required": true, "description": "服务ID" }, { "name": "Domain", "type": "string", "required": true, "description": "服务域名" } ], "required": [ "ServiceId", "Domain" ] }, { "name": "DeleteTable", "description": "本接口(DeleteTable)用于删除文档型数据库表，删除表后表中数据将会被删除且无法恢复，请谨慎操作 接口入参中的 Tag 为文档型数据库的实例 Id，可以通过 [DescribeEnvs](https://cloud.tencent.com/document/api/876/34820) 接口返回的 EnvList[0].Databases[0].InstanceId 获取", "status": "online", "parameters": [ { "name": "TableName", "type": "string", "required": true, "description": "待删除的表名", "example": "tbl" }, { "name": "Tag", "type": "string", "required": false, "description": "FlexDB实例ID", "example": "tnt-nl7hjzasw" }, { "name": "EnvId", "type": "string", "required": false, "description": "云开发环境ID", "example": "lowcode-abc" }, { "name": "MongoConnector", "type": "object", "required": false, "description": "MongoDB连接器配置", "example": "无", "children": [ { "name": "InstanceId", "type": "string", "required": false, "description": "连接器实例ID", "example": "mongo_conn" }, { "name": "DatabaseName", "type": "string", "required": false, "description": "MongoDB数据库名", "example": "demo_db" } ] } ], "required": [ "TableName" ] }, { "name": "DeleteUsers", "description": "删除tcb用户", "status": "online", "parameters": [ { "name": "EnvId", "type": "string", "required": true, "description": "环境id", "example": "testenv-123" }, { "name": "Uids", "type": "array", "required": true, "description": "tcb用户id列表, 一次最多支持删除100个", "example": "[\"19837204372934434\"]", "item_type": "string" } ], "required": [ "EnvId", "Uids" ] }, { "name": "DescribeAuthDomains", "description": "本接口用于获取当前环境的安全域名列表。 云开发会校验网页应用请求的来源域名，您需要将来源域名加入到WEB安全域名列表中。 可以通过接口 [CreateAuthDomain](https://cloud.tencent.com/document/product/876/42764) 增加安全域名。", "status": "online", "parameters": [ { "name": "EnvId", "type": "string", "required": true, "description": "环境ID", "example": "env-xxyyzzaa" } ], "required": [ "EnvId" ] }, { "name": "DescribeBaasPackageList", "description": "获取新套餐列表，含详情，如果传了PackageId，则只获取指定套餐详情", "status": "online", "parameters": [ { "name": "PackageName", "type": "string", "required": false, "description": "tcb产品套餐ID，不填拉取全量package信息。", "example": "baas_personal" }, { "name": "EnvId", "type": "string", "required": false, "description": "环境ID", "example": "env-xxyyzzaabb" }, { "name": "Source", "type": "string", "required": false, "description": "套餐归属方，填写后只返回对应的套餐 包含miniapp与qcloud两种 默认为miniapp", "example": "miniapp" }, { "name": "EnvChannel", "type": "string", "required": false, "description": "套餐归属环境渠道", "example": "qc_console" }, { "name": "TargetAction", "type": "string", "required": false, "description": "拉取套餐用途： 1）new 新购 2）modify变配 3）renew续费", "example": "new" }, { "name": "GroupName", "type": "string", "required": false, "description": "预留字段，同一商品会对应多个类型套餐，对指标有不同侧重。 计算型calculation 流量型flux 容量型capactiy", "example": "calculation" }, { "name": "PackageTypeList", "type": "array", "required": false, "description": "类型分组过滤。默认为[\"default\"]", "example": "[\"default\",\"vip\"]", "item_type": "string" }, { "name": "PaymentChannel", "type": "string", "required": false, "description": "付费渠道，与回包billTags中的计费参数相关，不填返回默认值。", "example": "miniapp" } ], "required": [] }, { "name": "DescribeCloudBaseBuildService", "description": "获取云托管代码上传url", "status": "online", "parameters": [ { "name": "EnvId", "type": "string", "required": true, "description": "环境id", "example": "env-asdasfa" }, { "name": "ServiceName", "type": "string", "required": true, "description": "服务名", "example": "service-name" }, { "name": "CIBusiness", "type": "string", "required": false, "description": "build类型,枚举值有: cloudbaserun, framework-ci", "example": "cloudbaserun" }, { "name": "ServiceVersion", "type": "string", "required": false, "description": "服务版本", "example": "service-name-0.1" }, { "name": "Suffix", "type": "string", "required": false, "description": "文件后缀", "example": ".zip" } ], "required": [ "EnvId", "ServiceName" ] }, { "name": "DescribeCloudBaseGWAPI", "description": "获取网关API列表", "status": "online", "parameters": [ { "name": "ServiceId", "type": "string", "required": false, "description": "服务ID", "example": "envid" }, { "name": "Domain", "type": "string", "required": false, "description": "API域名", "example": "www.aaa.cn" }, { "name": "Path", "type": "string", "required": false, "description": "API Path", "example": "/" }, { "name": "APIId", "type": "string", "required": false, "description": "API ID", "example": "randstring" }, { "name": "Type", "type": "integer", "required": false, "description": "API类型，1为云函数，2为容器", "example": "1" }, { "name": "Name", "type": "string", "required": false, "description": "API名，Type为1时为云函数名，Type为2时为容器服务名", "example": "apiname" }, { "name": "Offset", "type": "integer", "required": false, "description": "查询的分页参数，用于设置查询的偏移位置，0表示从头开始", "example": "0" }, { "name": "Limit", "type": "integer", "required": false, "description": "查询的分页参数，用于表示每次查询的最大返回数据量", "example": "100" }, { "name": "EnableRegion", "type": "boolean", "required": false, "description": "是否启用多地域", "example": "true" }, { "name": "EnableUnion", "type": "boolean", "required": false, "description": "是否使用统一域名", "example": "true" } ], "required": [] }, { "name": "DescribeCloudBaseGWService", "description": "获取网关服务", "status": "online", "parameters": [ { "name": "ServiceId", "type": "string", "required": false, "description": "服务ID", "example": "envid" }, { "name": "Domain", "type": "string", "required": false, "description": "服务域名", "example": "hell.com" }, { "name": "EnableRegion", "type": "boolean", "required": false, "description": "是否启用多地域", "example": "true" }, { "name": "EnableUnion", "type": "boolean", "required": false, "description": "是否启用统一域名", "example": "true" } ], "required": [] }, { "name": "DescribeCreateMySQLResult", "description": "查询开通Mysql结果，`Response.Data.Status = \"notexist\"` 表示未开通，如果未开通，可以调用 [CreateMySQL](https://cloud.tencent.com/document/api/876/128186) 来开通 `Response.Data. Status = \"success\"` 表示开通成功，Mysql开通成功后，可通过接口设置数据库账号相关功能包括但不限于【创建账号、删除账号、查询可授权权限列表、查询账号已有权限、修改主机、修改配置、修改账号库表权限】、集群操作相关...", "status": "online", "parameters": [ { "name": "EnvId", "type": "string", "required": true, "description": "云开发环境ID", "example": "**s*e*-********2dbc0df14561" }, { "name": "TaskId", "type": "string", "required": false, "description": "OpenMysql 返回任务 Id", "example": "38654" } ], "required": [ "EnvId" ] }, { "name": "DescribeDatabaseACL", "description": "获取文档型数据库权限", "status": "online", "parameters": [ { "name": "EnvId", "type": "string", "required": true, "description": "环境ID", "example": "env-xxxx" }, { "name": "CollectionName", "type": "string", "required": true, "description": "集合名称", "example": "abccccc" } ], "required": [ "EnvId", "CollectionName" ] }, { "name": "DescribeEnvAccountCircle", "description": "查询环境计费周期。 云开发环境的资源点都是按月结算的，每个月都有一定的抵扣额度。 例如： 某个环境在 2026-01-05 购买了3个月个人版(到期时间: 2026-04-05)，则他可以在以下3个周期内，分别享有40000资源点的额度： 1. 2026-01-05 ~ 2026-02-05 23:59:59 2. 2026-02-06 ~ 2026-03-05 23:59:59 3. 2026-03-06 ~ 2026-04-05 23:59:59 本接口，用于获取环境当前属于哪个计费周期内。", "status": "online", "parameters": [ { "name": "EnvId", "type": "string", "required": true, "description": "环境ID", "example": "envid-asdafafa" } ], "required": [ "EnvId" ] }, { "name": "DescribeEnvLimit", "description": "查询环境个数上限", "status": "online", "parameters": [], "required": [] }, { "name": "DescribeEnvs", "description": "获取环境列表，含环境下的各个资源信息。尤其是各资源的唯一标识，是请求各资源的关键参数", "status": "online", "parameters": [ { "name": "EnvId", "type": "string", "required": false, "description": "环境ID，如果传了这个参数则只返回该环境的相关信息", "example": "yourenvid-2fb346" }, { "name": "IsVisible", "type": "boolean", "required": false, "description": "指定Channels字段为可见渠道列表或不可见渠道列表 如只想获取渠道A的环境 就填写IsVisible= true,Channels = [\"A\"], 过滤渠道A拉取其他渠道环境时填写IsVisible= false,Channels = [\"A\"]", "example": "true" }, { "name": "Channels", "type": "array", "required": false, "description": "渠道列表，代表可见或不可见渠道由IsVisible参数指定", "example": "[ide,qc_console]", "item_type": "string" }, { "name": "Limit", "type": "integer", "required": false, "description": "分页参数，单页限制个数", "example": "10" }, { "name": "Offset", "type": "integer", "required": false, "description": "分页参数，偏移量", "example": "0" } ], "required": [] }, { "name": "DescribeHostingDomainTask", "description": "查询静态托管域名任务状态", "status": "online", "parameters": [ { "name": "EnvId", "type": "string", "required": true, "description": "环境ID", "example": "env-xxxxxx" } ], "required": [ "EnvId" ] }, { "name": "DescribeMySQLClusterDetail", "description": "查询Mysql集群信息 调用该接口前需要先查询Mysql是否开通，可通过 [DescribeCreateMySQLResult ](https://cloud.tencent.com/document/api/876/128185) 查询，只有已开通的才能查到集群信息，Mysql开通成功后，可通过接口设置数据库账号相关功能包括但不限于【创建账号、删除账号、查询可授权权限列表、查询账号已有权限、修改主机、修改配置、修改账号库表权限】、集群操作相关【查询集群参数\ufffd...", "status": "online", "parameters": [ { "name": "EnvId", "type": "string", "required": true, "description": "云开发环境ID", "example": "*******p**-8g1j2dbc0df14561" } ], "required": [ "EnvId" ] }, { "name": "DescribeMySQLTaskStatus", "description": "查询Mysql任务状态", "status": "online", "parameters": [ { "name": "EnvId", "type": "string", "required": true, "description": "云开发环境ID", "example": "*******pre-******bc0df14561" }, { "name": "TaskId", "type": "string", "required": false, "description": "任务Id", "example": "16710" }, { "name": "TaskName", "type": "string", "required": false, "description": "任务名", "example": "DeleteDataHub" } ], "required": [ "EnvId" ] }, { "name": "DescribeQuotaData", "description": "查询指定指标的配额使用量", "status": "online", "parameters": [ { "name": "EnvId", "type": "string", "required": true, "description": "环境ID", "example": "test-23" }, { "name": "MetricName", "type": "string", "required": true, "description": "指标名: StorageSizepkg: 当月存储空间容量, 单位MB StorageReadpkg: 当月存储读请求次数 StorageWritepkg: 当月存储写请求次数 StorageCdnOriginFluxpkg: 当月CDN回源流量, 单位字节 StorageCdnOriginFluxpkgDay: 当日CDN回源流量, 单位字节 StorageReadpkgDay: 当日存储读请求次数 StorageWritepkgDay: 当日写请求次数 CDNFluxpkg: 当月CDN流量, 单位为字节 CDNFluxpkgDay: 当日CDN流量, 单位为字节 FunctionInvocationpkg: 当月云函数调\ufffd...", "example": "DbWritepkg" }, { "name": "ResourceID", "type": "string", "required": false, "description": "资源ID, 目前仅对云函数、容器托管相关的指标有意义。云函数(FunctionInvocationpkg, FunctionGBspkg, FunctionFluxpkg)、容器托管（服务名称）。如果想查询某个云函数的指标则在ResourceId中传入函数名; 如果只想查询整个namespace的指标, 则留空或不传。", "example": "\"test-env\"" } ], "required": [ "EnvId", "MetricName" ] }, { "name": "DescribeSafeRule", "description": "查询数据库安全规则。 安全规则，用于控制C端用户的访问权限。详见 [安全规则介绍](https://cloud.tencent.com/document/product/876/123478) 。", "status": "online", "parameters": [ { "name": "EnvId", "type": "string", "required": true, "description": "环境ID", "example": "my-env-c89tjdjdk" }, { "name": "CollectionName", "type": "string", "required": true, "description": "集合名称", "example": "my-table" }, { "name": "WxAppId", "type": "string", "required": false, "description": "微信AppId，微信必传", "example": "wx94gjkuihjldjlkfs" } ], "required": [ "EnvId", "CollectionName" ] }, { "name": "DescribeStaticStore", "description": "查看当前环境下静态托管资源信息，根据返回结果判断静态资源的状态", "status": "online", "parameters": [ { "name": "EnvId", "type": "string", "required": true, "description": "环境ID" } ], "required": [ "EnvId" ] }, { "name": "DescribeTable", "description": "查询文档型数据库表的相关信息，包括索引等信息 接口入参中的 Tag 为文档型数据库的实例 Id，可以通过 [DescribeEnvs](https://cloud.tencent.com/document/api/876/34820) 接口返回的 EnvList[0].Databases[0].InstanceId 获取", "status": "online", "parameters": [ { "name": "TableName", "type": "string", "required": true, "description": "表名", "example": "demo_users" }, { "name": "Tag", "type": "string", "required": false, "description": "FlecDB实例ID", "example": "tnt-xxx" }, { "name": "EnvId", "type": "string", "required": false, "description": "云开发环境ID", "example": "lowcode-abc" }, { "name": "MongoConnector", "type": "object", "required": false, "description": "MongoDB连接器配置", "example": "无", "children": [ { "name": "InstanceId", "type": "string", "required": false, "description": "连接器实例ID", "example": "mongo_conn" }, { "name": "DatabaseName", "type": "string", "required": false, "description": "MongoDB数据库名", "example": "demo_db" } ] } ], "required": [ "TableName" ] }, { "name": "DescribeTables", "description": "本接口(DescribeTables)用于查询文档型数据库所有表信息，包括表名、表中数据条数、表中数据量、索引个数及索引的大小等", "status": "online", "parameters": [ { "name": "MgoLimit", "type": "integer", "required": true, "description": "分页条件", "example": "10" }, { "name": "Tag", "type": "string", "required": false, "description": "实例ID", "example": "tnt-abc" }, { "name": "MgoOffset", "type": "integer", "required": false, "description": "分页条件", "example": "0" }, { "name": "EnvId", "type": "string", "required": false, "description": "环境id", "example": "lowcode-abc" }, { "name": "MongoConnector", "type": "object", "required": false, "description": "MongoConnector", "example": "无", "children": [ { "name": "InstanceId", "type": "string", "required": false, "description": "连接器实例ID", "example": "mongo_conn" }, { "name": "DatabaseName", "type": "string", "required": false, "description": "MongoDB数据库名", "example": "demo_db" } ] }, { "name": "TableNames", "type": "array", "required": false, "description": "指定表名过滤，为空时返回所有表", "example": "[\"table_name\"]", "item_type": "string" } ], "required": [ "MgoLimit" ] }, { "name": "DescribeUserList", "description": "查询tcb用户列表", "status": "online", "parameters": [ { "name": "EnvId", "type": "string", "required": true, "description": "环境id", "example": "test_envId" }, { "name": "PageNo", "type": "integer", "required": false, "description": "页码，从1开始，默认1", "example": "1" }, { "name": "PageSize", "type": "integer", "required": false, "description": "每页数量，默认20，最大100", "example": "10" }, { "name": "Name", "type": "string", "required": false, "description": "用户名，模糊查询", "example": "zhang" }, { "name": "NickName", "type": "string", "required": false, "description": "用户昵称，模糊查询", "example": "张" }, { "name": "Phone", "type": "string", "required": false, "description": "手机号，模糊查询", "example": "13900139000" }, { "name": "Email", "type": "string", "required": false, "description": "邮箱，模糊查询", "example": "zhangsan@example.com" } ], "required": [ "EnvId" ] }, { "name": "DestroyEnv", "description": "本接口用于销毁云开发环境。 云开发环境遵循腾讯云包年包月预付费产品生命周期，因此环境销毁需要分两步： 1. 资源退费。此时会根据当前环境剩余有效期，自动退还相关费用(代金券不退)。退款后，环境进入隔离期。 2. 环境删除。环境在进入隔离期后15天会自动删除。也可以通过本接口，指定 IsForce=true 来强制删除隔离期环境。 **注意**⚠️ 1. 环境退费后进入隔离期，则\ufffd\ufffd...", "status": "online", "parameters": [ { "name": "EnvId", "type": "string", "required": true, "description": "环境Id", "example": "yourenvid-2fb346" }, { "name": "IsForce", "type": "boolean", "required": false, "description": "针对预付费 删除隔离中的环境时要传true 正常环境直接跳过隔离期删除", "example": "false" }, { "name": "BypassCheck", "type": "boolean", "required": false, "description": "是否绕过资源检查，资源包等额外资源，默认为false，如果为true，则不检查资源是否有数据，直接删除。", "example": "false" } ], "required": [ "EnvId" ] }, { "name": "DestroyMySQL", "description": "销毁Mysql 销毁后可以通过 [DescribeMySQLTaskStatus](https://cloud.tencent.com/document/api/876/128183) 接口查询销毁结果，如果 `Response.Data. Status = FAILED ` 表示销毁失败，可以重新调用销毁接口重试", "status": "online", "parameters": [ { "name": "EnvId", "type": "string", "required": true, "description": "云开发环境ID", "example": "**s**r*pr********bc0df14561" } ], "required": [ "EnvId" ] }, { "name": "DestroyStaticStore", "description": "销毁静态托管资源，该接口创建异步销毁任务，资源最终状态可从DestroyStaticStore接口查看", "status": "online", "parameters": [ { "name": "EnvId", "type": "string", "required": true, "description": "环境ID", "example": "env-xxyyaaza" }, { "name": "CdnDomain", "type": "string", "required": false, "description": "cdn域名", "example": "cloudbase.tencentcloud.com" } ], "required": [ "EnvId" ] }, { "name": "EditAuthConfig", "description": "修改登录配置", "status": "online", "parameters": [ { "name": "EnvId", "type": "string", "required": true, "description": "环境id", "example": "lowcode-xxx" }, { "name": "PhoneNumberLogin", "type": "string", "required": false, "description": "手机号登录配置 \"TRUE\", \"FALSE\", \"LOGIN_ONLY\"", "example": "\"TRUE\"" }, { "name": "AnonymousLogin", "type": "string", "required": false, "description": "匿名登录配置 \"TRUE\", \"FALSE\"", "example": "\"TRUE\"" }, { "name": "UsernameLogin", "type": "string", "required": false, "description": "用户名密码登录配置 \"TRUE\", \"FALSE\"", "example": "\"TRUE\"" } ], "required": [ "EnvId" ] }, { "name": "ListTables", "description": "本接口(ListTables)用于查询文档型数据库所有表信息，包括表名、表中数据条数、表中数据量、索引个数及索引的大小等 该接口跟 [DescribeTables](https://cloud.tencent.com/document/api/876/127962) 接口功能一致，后续该接口可能会下线，请使用 [DescribeTable](https://cloud.tencent.com/document/api/876/127962)接口", "status": "online", "parameters": [ { "name": "MgoLimit", "type": "integer", "required": true, "description": "每页返回数量（0-1000)", "example": "10" }, { "name": "Tag", "type": "string", "required": false, "description": "FlexDB实例ID", "example": "tag-123" }, { "name": "MgoOffset", "type": "integer", "required": false, "description": "分页偏移量", "example": "0" }, { "name": "Filters", "type": "array", "required": false, "description": "过滤标签数组，用于过滤表名，可选值如：HIDDEN、WEDA、WEDA_SYSTEM", "example": "[\"HIDDEN\"]", "item_type": "string" }, { "name": "SearchValue", "type": "string", "required": false, "description": "模糊搜索查询值", "example": "prefix" }, { "name": "ShowHidden", "type": "boolean", "required": false, "description": "是否展示隐藏表", "example": "false" }, { "name": "EnvId", "type": "string", "required": false, "description": "云开发环境ID", "example": "lowcode-abc" }, { "name": "MongoConnector", "type": "object", "required": false, "description": "mongo连接器信息", "example": "无", "children": [ { "name": "InstanceId", "type": "string", "required": false, "description": "连接器实例ID", "example": "mongo_conn" }, { "name": "DatabaseName", "type": "string", "required": false, "description": "MongoDB数据库名", "example": "demo_db" } ] } ], "required": [ "MgoLimit" ] }, { "name": "ModifyCloudBaseGWAPI", "description": "修改云开发网关API", "status": "online", "parameters": [ { "name": "ServiceId", "type": "string", "required": true, "description": "Service ID", "example": "envId" }, { "name": "APIId", "type": "string", "required": true, "description": "API ID", "example": "xxxxxx-xxxxxx-xxxxxx-xxxxxx" }, { "name": "Options", "type": "array", "required": true, "description": "选项列表，key取值：domain, path。", "example": "无", "item_type": "object", "children": [ { "name": "Key", "type": "string", "required": true, "description": "键" }, { "name": "Value", "type": "string", "required": true, "description": "值" } ] } ], "required": [ "ServiceId", "APIId", "Options" ] }, { "name": "ModifyClsTopic", "description": "修改日志主题", "status": "online", "parameters": [ { "name": "EnvId", "type": "string", "required": true, "description": "环境ID", "example": "env-xxxxxx" }, { "name": "Period", "type": "integer", "required": false, "description": "日志生命周期，单位天，可取值范围1~3600，取值为3640时代表永久保存", "example": "10" } ], "required": [ "EnvId" ] }, { "name": "ModifyDatabaseACL", "description": "修改文档型数据库权限", "status": "online", "parameters": [ { "name": "EnvId", "type": "string", "required": true, "description": "环境ID", "example": "env-xxyyzzaa" }, { "name": "CollectionName", "type": "string", "required": true, "description": "集合名称", "example": "my-table" }, { "name": "AclTag", "type": "string", "required": true, "description": "权限标签。包含以下取值： READONLY：所有用户可读，仅创建者和管理员可写 PRIVATE：仅创建者及管理员可读写 ADMINWRITE：所有用户可读，仅管理员可写 ADMINONLY：仅管理员可读写", "example": "READONLY" } ], "required": [ "EnvId", "CollectionName", "AclTag" ] }, { "name": "ModifyEnv", "description": "更新环境信息", "status": "online", "parameters": [ { "name": "EnvId", "type": "string", "required": true, "description": "环境ID", "example": "test-23" }, { "name": "Alias", "type": "string", "required": false, "description": "环境备注名，要以a-z开头，不能包含 a-zA-z0-9- 以外的字符", "example": "iAmNickName" } ], "required": [ "EnvId" ] }, { "name": "ModifyEnvPlan", "description": "本接口用于变更云开发环境套餐。 该接口会自动下单并支付，会在腾讯云账户中扣除余额（余额不足会下单失败）。 该接口支持自动扣除代金券（AutoVoucher=true时），符合条件的代金券会被自动扣除。", "status": "online", "parameters": [ { "name": "EnvId", "type": "string", "required": true, "description": "所需变更套餐的环境ID", "example": "cloudbase-8grqda2hfc2f62bb" }, { "name": "PackageId", "type": "string", "required": true, "description": "目标套餐Id。 对于云开发环境套餐，可通过 [DescribeBaasPackageList](https://cloud.tencent.com/document/product/876/78167) 接口获取，对应其出参的PackageName", "example": "baas_pf_standard" }, { "name": "AutoVoucher", "type": "boolean", "required": false, "description": "是否自动选择代金券支付。", "example": "true" } ], "required": [ "EnvId", "PackageId" ] }, { "name": "ModifySafeRule", "description": "设置数据库安全规则。 安全规则，用于控制C端用户的访问权限。详见 [安全规则介绍 ](https://cloud.tencent.com/document/product/876/123478)。", "status": "online", "parameters": [ { "name": "EnvId", "type": "string", "required": true, "description": "环境ID", "example": "myenv-c849jgkdldcmsd" }, { "name": "CollectionName", "type": "string", "required": true, "description": "集合名称", "example": "my-table" }, { "name": "AclTag", "type": "string", "required": true, "description": "权限标签。包含以下取值： READONLY：所有用户可读，仅创建者和管理员可写 PRIVATE：仅创建者及管理员可读写 ADMINWRITE：所有用户可读，仅管理员可写 ADMINONLY：仅管理员可读写 CUSTOM：自定义安全规则", "example": "CUSTOM" }, { "name": "Rule", "type": "string", "required": false, "description": "安全规则内容。 当 AclTag=CUSTOM 时，此参数必填。 详情参考：[文档型数据库安全规则](https://docs.cloudbase.net/database/security-rules)", "example": "{ \"read\": true, \"write\": \"doc._openid == auth.openid\" }" } ], "required": [ "EnvId", "CollectionName", "AclTag" ] }, { "name": "ModifyUser", "description": "修改tcb用户", "status": "online", "parameters": [ { "name": "EnvId", "type": "string", "required": true, "description": "环境id", "example": "testenv-123" }, { "name": "Uid", "type": "string", "required": true, "description": "用户Id, 不做修改", "example": "1" }, { "name": "Name", "type": "string", "required": false, "description": "用户名，用户名规则：1. 长度1-64字符 2. 只能包含大小写英文字母、数字和符号 . _ - 3. 只能以字母或数字开头 4. 不能重复，不传该字段或传空字符不修改", "example": "test_user_01" }, { "name": "Type", "type": "string", "required": false, "description": "用户类型：0-内部用户、1-外部用户，默认0（内部用户），不传该字段或传空字符串不修改", "example": "internalUser" }, { "name": "Password", "type": "string", "required": false, "description": "密码，传入Uid时密码可不传。密码规则：1. 长度8-32字符（推荐12位以上） 2. 不能以特殊字符开头 3. 至少包含以下四项中的三项：小写字母a-z、大写字母A-Z、数字0-9、特殊字符()!@#$%^\u0026*\\|?\u003e\u003c_-，不传该字段或传空字符串不修改", "example": "test123@" }, { "name": "UserStatus", "type": "string", "required": false, "description": "用户状态：ACTIVE（激活）、BLOCKED（冻结），默认冻结，不传该字段或传空字符串不修改", "example": "ACTIVE" }, { "name": "NickName", "type": "string", "required": false, "description": "用户昵称，长度2-64字符，不传该字段不修改，传空字符修改为空", "example": "test_user_01" }, { "name": "Phone", "type": "string", "required": false, "description": "手机号，11位数字，不传该字段不修改，传空字符串修改为空", "example": "18xxxx9078" }, { "name": "Email", "type": "string", "required": false, "description": "邮箱地址，不传该字段不修改，传空字符修改为空", "example": "example@qq.com" }, { "name": "AvatarUrl", "type": "string", "required": false, "description": "头像链接，可访问的公网URL，不传该字段不修改，传空字符串修改为空", "example": "https://example.avatat" }, { "name": "Description", "type": "string", "required": false, "description": "用户描述，最多200字符，不传该字段不修改，传空字符修改为空", "example": "测试账号" } ], "required": [ "EnvId", "Uid" ] }, { "name": "ReinstateEnv", "description": "针对已隔离的免费环境，可以通过本接口将其恢复访问。", "status": "online", "parameters": [ { "name": "EnvId", "type": "string", "required": true, "description": "环境ID", "example": "env-xxyyzzaa" } ], "required": [ "EnvId" ] }, { "name": "RenewEnv", "description": "本接口用于云开发环境套餐续费。 该接口会自动下单并支付，会在腾讯云账户中扣除余额（余额不足会下单失败）。 该接口支持自动扣除代金券（AutoVoucher=true时），符合条件的代金券会被自动扣除。", "status": "online", "parameters": [ { "name": "EnvId", "type": "string", "required": true, "description": "环境ID", "example": "cloudbase-8grqda2hfc2f62bb" }, { "name": "Period", "type": "integer", "required": false, "description": "续费周期，单位：月。 默认值为 1，即续费1个月。", "example": "1" }, { "name": "AutoVoucher", "type": "boolean", "required": false, "description": "是否自动选择代金券支付。", "example": "true" } ], "required": [ "EnvId" ] }, { "name": "RunCommands", "description": "本接口用于执行文档型数据库命令", "status": "online", "parameters": [ { "name": "MgoCommands", "type": "array", "required": true, "description": "待执行命令", "example": "无", "item_type": "object", "children": [ { "name": "TableName", "type": "string", "required": true, "description": "表名" }, { "name": "CommandType", "type": "string", "required": true, "description": "操作类型，可选类型为：UPDATE/QUERY/INSERT/DELETE/COMMAND，本操作必须按实际填写，监控会依赖该字段统计本次操作的类型，并实时减少用户配额，如果填写错误会误扣用户请求配额" }, { "name": "Command", "type": "string", "required": true, "description": "待执行命令" } ] }, { "name": "Tag", "type": "string", "required": false, "description": "实例ID", "example": "tnt-xxxx" }, { "name": "EnvId", "type": "string", "required": false, "description": "环境id", "example": "lowcode-123" }, { "name": "MongoConnector", "type": "object", "required": false, "description": "Mongo连接器实例信息", "example": "无", "children": [ { "name": "InstanceId", "type": "string", "required": false, "description": "连接器实例ID", "example": "mongo_conn" }, { "name": "DatabaseName", "type": "string", "required": false, "description": "MongoDB数据库名", "example": "demo_db" } ] } ], "required": [ "MgoCommands" ] }, { "name": "RunSql", "description": "执行MySQL语句 该接口用来执行 MySql 语句，比如创建表格、插入数据、修改数据、删除字段、添加索引等可以通过sql 语句实现的都可以使用该接口 调用该接口前需要先查询Mysql是否开通，可通过 [DescribeCreateMySQLResult ](https://cloud.tencent.com/document/api/876/128185) 查询，只有开通成功才能操作", "status": "online", "parameters": [ { "name": "Sql", "type": "string", "required": true, "description": "要执行的SQL语句", "example": "CREATE TABLE users (id BIGINT PRIMARY KEY AUTO_INCREMENT)" }, { "name": "EnvId", "type": "string", "required": true, "description": "云开发环境ID", "example": "lowcode-2gx6pjs59ddd3cea" }, { "name": "DbInstance", "type": "object", "required": false, "description": "数据库连接器实例信息", "example": "无", "children": [ { "name": "EnvId", "type": "string", "required": false, "description": "云开发环境ID", "example": "mikejliu-test01-5g7t7mwx7b84b3eb" }, { "name": "InstanceId", "type": "string", "required": false, "description": "MySQL 连接器实例 ID；`\"default\"` 或为空表示使用 TCB 环境的默认连接器", "example": "default" }, { "name": "Schema", "type": "string", "required": false, "description": "数据库名；为空时使用连接器配置的默认数据库名", "example": "classicmodels" } ] }, { "name": "ReadOnly", "type": "boolean", "required": false, "description": "是否只读；当 `true` 时仅允许以 `SELECT/WITH/SHOW/DESCRIBE/DESC/EXPLAIN` 开头的 SQL", "example": "false" } ], "required": [ "Sql", "EnvId" ] }, { "name": "SearchClsLog", "description": "搜索用户调用日志", "status": "online", "parameters": [ { "name": "EnvId", "type": "string", "required": true, "description": "环境唯一ID", "example": "aitest-9g96e4tn46773d08" }, { "name": "StartTime", "type": "string", "required": true, "description": "查询起始时间条件", "example": "2026-02-04 10:34:44" }, { "name": "EndTime", "type": "string", "required": true, "description": "查询结束时间条件", "example": "2026-02-04 11:34:44" }, { "name": "QueryString", "type": "string", "required": true, "description": "查询语句，例如查询云函数：(src:app OR src:system) AND log:\\\"START RequestId*\\\"， 查询云数据库：module:database，查询审批流：module:workflow，查询模型：module:model，查询用户权限：module:auth，以上仅为示例语句，实际使用时请根据具体日志内容进行调整，查询语句需严格遵循CLS（Cloud Log Service）语法规范 详细的语法规则请参考官方档：https://cloud.tencent.com/document/product/614/47044", "example": "module:database" }, { "name": "Limit", "type": "integer", "required": true, "description": "单次要返回的日志条数，单次返回的最大条数为100", "example": "10" }, { "name": "Context", "type": "string", "required": false, "description": "加载更多使用，透传上次返回的 context 值，获取后续的日志内容，通过游标最多可获取10000条，请尽可能缩小时间范围", "example": "ctxxu4igkldjkjiut4jkgdjsk" }, { "name": "Sort", "type": "string", "required": false, "description": "按时间排序 asc（升序）或者 desc（降序），默认为 desc", "example": "asc" }, { "name": "UseLucene", "type": "boolean", "required": false, "description": "是否使用Lucene语法，默认为false", "example": "false" } ], "required": [ "EnvId", "StartTime", "EndTime", "QueryString", "Limit" ] }, { "name": "UpdateTable", "description": "本接口(UpdateTable)用于修改文档型数据库表信息，当前可以支持创建和删除索引", "status": "online", "parameters": [ { "name": "TableName", "type": "string", "required": true, "description": "表名", "example": "demo_users" }, { "name": "Tag", "type": "string", "required": false, "description": "FlexDB实例ID", "example": "tnt-nl7hjzasw" }, { "name": "DropIndexes", "type": "array", "required": false, "description": "待删除索引信息", "example": "无", "item_type": "object", "children": [ { "name": "IndexName", "type": "string", "required": false, "description": "索引名称" } ] }, { "name": "CreateIndexes", "type": "array", "required": false, "description": "待创建索引信息", "example": "无", "item_type": "object", "children": [ { "name": "IndexName", "type": "string", "required": false, "description": "索引名称" }, { "name": "MgoKeySchema", "type": "object", "required": false, "description": "索引结构", "children": [ { "name": "MgoIndexKeys", "type": "array", "required": false, "description": "索引字段", "example": "无", "item_type": "object", "children": [ { "name": "Name", "type": "string", "required": false, "description": "无", "example": "\"\"" }, { "name": "Direction", "type": "string", "required": false, "description": "无", "example": "\"\"" } ] }, { "name": "MgoIsUnique", "type": "boolean", "required": false, "description": "是否唯一索引", "example": "无" }, { "name": "MgoIsSparse", "type": "boolean", "required": false, "description": "是否稀疏索引", "example": "无" } ] } ] }, { "name": "EnvId", "type": "string", "required": false, "description": "云开发环境ID", "example": "lowcode-abc" }, { "name": "MongoConnector", "type": "object", "required": false, "description": "MongoDB连接器配置", "example": "无", "children": [ { "name": "InstanceId", "type": "string", "required": false, "description": "连接器实例ID", "example": "mongo_conn" }, { "name": "DatabaseName", "type": "string", "required": false, "description": "MongoDB数据库名", "example": "demo_db" } ] } ], "required": [ "TableName" ] } ] }