/** * DescribeEnvLimit返回参数结构体 */ export interface DescribeEnvLimitResponse { /** * 环境总数上限 */ MaxEnvNum?: number; /** * 目前环境总数 */ CurrentEnvNum?: number; /** * 免费环境数量上限 */ MaxFreeEnvNum?: number; /** * 目前免费环境数量 */ CurrentFreeEnvNum?: number; /** * 总计允许销毁环境次数上限 */ MaxDeleteTotal?: number; /** * 目前已销毁环境次数 */ CurrentDeleteTotal?: number; /** * 每月允许销毁环境次数上限 */ MaxDeleteMonthly?: number; /** * 本月已销毁环境次数 */ CurrentDeleteMonthly?: number; /** * 微信网关体验版可购买月份数 */ MaxFreeTrialNum?: number; /** * 微信网关体验版已购买月份数 */ CurrentFreeTrialNum?: number; /** * 转支付限额总数 */ ChangePayTotal?: number; /** * 当前已用转支付次数 */ CurrentChangePayTotal?: number; /** * 转支付每月限额 */ ChangePayMonthly?: number; /** * 本月已用转支付额度 */ CurrentChangePayMonthly?: number; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * DescribeResourcePermission返回参数结构体 */ export interface DescribeResourcePermissionResponse { /** * 查询资源权限返回结果 */ Data?: DescribeResourcePermissionResult; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * BindStorageSource请求参数结构体 */ export interface BindStorageSourceRequest { /** * 环境ID */ EnvId: string; /** * 存储源 */ StorageConfig: ExternalStorage; } /** * 托管 AI 模型计费信息 */ export interface ManagedAIModelChargingInfo { /** *
计费类型
枚举值:
分组名称
*/ Name?: string; /** *输入 Token 价格
*/ InputPrice?: string; /** *输出 Token 价格
*/ OutputPrice?: string; /** *命中缓存价格
*/ CachePrice?: string; /** *计费单位
*/ InputOutputUnit?: string; } /** * 订单信息 */ export interface OrderInfo { /** * 订单号 */ TranId?: string; /** * 订单要切换的套餐ID */ PackageId?: string; /** * 订单类型migration 版本号
参数格式:纯数字,14位时间格式
*/ Version?: string; /** *migration 版本名
参数格式:仅允许小写字母和下划线
*/ Name?: string; /** *migration query sql checksum
服务端自动生成,同版本不同checksum会拒绝执行
*/ Checksum?: string; /** *状态
枚举值:
标记请求来源
*/ Source?: string; /** *被归入该分组的原因,比如not_applied、checksum_matched
*/ Reason?: string; } /** * 可以为每种语言配置一个字符串。比如:name,中文展示为:名字,英文展示为 name,韩文展示为:이름 */ export interface LocalizedMessage { /** * 默认展示的文本 */ Message: string; /** * 针对每种语言展示的文字 */ Localized?: ArrayTarget 匹配对象
枚举值:
MatchType 字符串匹配类型
枚举值:
Values 匹配值集合,Values 内任一命中即认为条件成立(OR 语义)
入参限制:单项 1~1024 字节,最多 100 条
*/ Values?: Array短信服务商类型
枚举值:
短信服务商侧申请并审核通过的模板ID。
注意:此字段可能返回 null,表示取不到有效值。 */ TemplateId: string; /** *短信服务商侧为应用分配的ID,按照服务商文档和要求需要此参数的,填写该参数。
短信服务商侧申请并审核通过的签名,按照服务商的文档和要求填写。
注意:此字段可能返回 null,表示取不到有效值。 */ SignName?: string; /** *凭证获取方式,不传默认为 SMS_AUTH_SECRET_KEY。
枚举值:
枚举值:
默认值:SMS_AUTH_SECRET_KEY
注意:此字段可能返回 null,表示取不到有效值。 */ AuthType?: string; /** *调用短信服务商发送短信接口的调用秘钥对应的ID。
调用短信服务商发送短信接口的调用api秘钥对应的秘钥Key。
短信服务商侧自定义短信发送的senderID,按照服务商文档和要求传参。
当短信自定义模板含多个占位符时,平台只负责生成验证码值,其余占位符由调用方在此提供。
授权管理中密钥的自定义标识(创建 / 引用二合一),与 SecretId / SecretKey 组合决定行为:
AuthType 为 SMS_AUTH_ASSUME_ROLE 时此参数必须为空。
注意:此字段可能返回 null,表示取不到有效值。 */ CredentialAuthKeyId?: string; } /** * 服务版本信息 */ export interface CloudAppVersionItem { /** *版本名
*/ VersionName?: string; /** *构建方式
*/ BuildType?: string; /** *构建Id
*/ BuildId?: string; /** *构建状态
*/ Status?: string; /** *框架名
*/ Framework?: string; /** *构建配置
*/ StaticConfig?: StaticConfig; /** *构建时间
*/ BuildTime?: string; /** *构建步骤
注意:此字段可能返回 null,表示取不到有效值。 */ Steps?: Array全 URL 缓存开关
枚举值:
查询参数是否参与缓存键
枚举值:
QueryStringSwitch=on 时必填
枚举值:
参数名列表
入参限制:最多 100 项,单项 1~128 字节
*/ QueryStringValues?: Array环境ID,如果传了这个参数则只返回该环境的相关信息
*/ EnvId?: string; /** *指定Channels字段为可见渠道列表或不可见渠道列表
如只想获取渠道A的环境 就填写IsVisible= true,Channels = ["A"], 过滤渠道A拉取其他渠道环境时填写IsVisible= false,Channels = ["A"]
渠道列表,代表可见或不可见渠道由IsVisible参数指定
*/ Channels?: Array分页参数,单页限制个数
*/ Limit?: number; /** *分页参数,偏移量
*/ Offset?: number; } /** * ModifyUser返回参数结构体 */ export interface ModifyUserResponse { /** * 修改用户返回值 注意:此字段可能返回 null,表示取不到有效值。 */ Data?: ModifyUserResp; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * ModifyProvider返回参数结构体 */ export interface ModifyProviderResponse { /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * 删除tcb用户返回值 */ export interface DeleteUsersResp { /** * 成功个数 */ SuccessCount?: number; /** * 失败个数 */ FailedCount?: number; } /** * DescribeEnvLimit请求参数结构体 */ export type DescribeEnvLimitRequest = null; /** * DescribeCloudBaseBuildService返回参数结构体 */ export interface DescribeCloudBaseBuildServiceResponse { /** * 上传url */ UploadUrl?: string; /** * 上传header */ UploadHeaders?: Array步骤名(建议 kebab-case,如 build-image),出现在 DescribeCloudAppVersion.Steps[].Name
*/ Name?: string; /** *shell 脚本,支持单行或多行
*/ Command?: string; } /** * 查询HTTP访问服务输出路由信息 */ export interface HTTPServiceRoute { /** *路径
*/ Path?: string; /** *路径重写规则
*/ PathRewrite?: HTTPServicePathRewrite; /** *上游服务类型。SCF: 云函数,CBR: 云托管,STATIC_STORE: 静态托管,WEB_SCF: WEB云函数,LH: Lighthouse
*/ UpstreamResourceType?: string; /** *上游服务名
*/ UpstreamResourceName?: string; /** *是否开启安全域名
*/ EnableSafeDomain?: boolean; /** *是否开启身份认证
*/ EnableAuth?: boolean; /** *是否开启路径透传
*/ EnablePathTransmission?: boolean; /** *QPS限频策略
*/ QPSPolicy?: HTTPServiceRouteQPSPolicy; /** *是否开启路由
*/ Enable?: boolean; /** *扩展字段,内部包含headers处理等
*/ Extension?: HTTPServiceExtension; /** *路由创建时间,格式 YYYY-MM-DDTHH:mm:ss±HH:mm,时区为 UTC+8
*/ CreateTime?: string; /** *路由更新时间,格式 YYYY-MM-DDTHH:mm:ss±HH:mm,时区为 UTC+8
*/ UpdateTime?: string; } /** * 三方认证入参映射。如果您的对接方不标准,则可以使用这个参数。默认情况下,该参数可以为空。比如:github,google,apple 接入,这些参数为空,但是国内的腾讯,新浪等则需要配置该参数。原因主要是:腾讯等公司在实现oauth时,未能完全遵循oauth标准。 */ export interface ProviderRequestParametersMap { /** * OAuth 标准协议中的 client_id。不同第三方平台的字段名称可能不同,例如微信平台对应 appid、新浪微博对应 app_id。 */ ClientId?: string; /** * OAuth 标准协议中的 client_secret,用于身份认证源的密钥鉴权。请妥善保管,避免泄露。 */ ClientSecret?: string; /** * OAuth 标准协议中的 redirect_uri,即授权回调地址。用户完成第三方认证后将重定向至该地址。 */ RedirectUri?: string; /** * 身份源注册用户时自动绑定的角色 ID。配置后,通过该身份源注册的新用户将自动关联指定角色。 */ RegisterUserRoleId?: string; /** * 身份源注册用户时是否自动授予许可证。取值范围: TRUE:自动授权许可证 FALSE:不自动授权(默认值) */ RegisterUserAutoLicense?: string; /** * OAuth 获取 Token 时认证信息的请求位置。取值范围: URL:将认证信息放在请求 URL 参数中 Headers:将认证信息放在请求 Header 中 Body:将认证信息放在请求 Body 中 */ AuthPosition?: string; /** * OAuth 授权模式匹配的参数字段名。用于指定获取 Token 请求中 grant_type 参数对应的字段名称。 */ GrantType?: string; /** * OAuth 授权模式类型。用于指定 grant_type 的值,例如 client_credentials 表示客户端凭证模式。 */ ClientCredentials?: string; /** * OAuth 返回中 access_token 的映射字段名。若第三方平台返回的 Token 字段名不是标准的 access_token,可通过此字段指定实际字段名。 */ AccessToken?: string; /** * OAuth 返回中 Token 有效期的映射字段名。若第三方平台返回的有效期字段名不是标准的 expires_in,可通过此字段指定实际字段名。 */ ExpiresIn?: string; /** * 身份源注册用户时的用户类型。取值范围: externalUser:外部用户 internalUser:内部用户 默认值为 externalUser。 */ RegisterUserType?: string; } /** * DescribeMySQLTaskStatus请求参数结构体 */ export interface DescribeMySQLTaskStatusRequest { /** * 云开发环境ID */ EnvId: string; /** * 任务Id */ TaskId?: string; /** * 任务名 */ TaskName?: string; } /** * UnbindStorageSource请求参数结构体 */ export interface UnbindStorageSourceRequest { /** * 环境ID */ EnvId: string; } /** * 构建命令 */ export interface BuildCommands { /** *平台生成默认 install step 时执行
*/ InstallCmd?: string; /** *平台生成默认build step 时执行
*/ BuildCmd?: string; /** *平台生成默认deploy step 时执行
*/ DeployCmd?: string; } /** * 封禁配置 */ export interface BanConfig { /** * ip白名单,支持ipv4、ipv6,支持CIDR */ IpWhiteList?: Array云开发环境ID
*/ EnvId: string; /** *migration版本
参数格式:14位时间格式
入参限制:纯数字
*/ MigrationVersion: string; /** *migration 版本名
入参限制:限制小写字母和下划线
*/ Name: string; /** *状态
枚举值:
修复原因
*/ Reason: string; /** *applied的时候填写,记录应用的sql语句
*/ Query?: string; } /** * AllocateEnv返回参数结构体 */ export interface AllocateEnvResponse { /** *环境ID
*/ EnvId?: string; /** *回显 客户平台的应用标识,如果没有则不传
*/ ExternalAppId?: string; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * DescribeCloudAppList请求参数结构体 */ export interface DescribeCloudAppListRequest { /** *环境ID
*/ EnvId: string; /** *部署类型
*/ DeployType: string; /** *搜索关键字
*/ SearchKey?: string; /** *页大小
*/ PageSize?: number; /** *页号
*/ PageNo?: number; } /** * ModifyEnv返回参数结构体 */ export interface ModifyEnvResponse { /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * 索引的key值 */ export interface Indexkey { /** * 键名 */ Name?: string; /** * 方向:specify 1 for ascending or -1 for descending */ Direction?: string; } /** * 云开发内置 AI 模型信息 */ export interface ManagedAIModelGroup { /** *模型分组
*/ GroupName?: string; /** *模型列表
注意:此字段可能返回 null,表示取不到有效值。 */ Models?: Array备注
*/ Remark?: string; } /** * ReleaseEnv返回参数结构体 */ export interface ReleaseEnvResponse { /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * 邮箱smtp配置 */ export interface EmailSmtpConfig { /** * 邮件发送者的邮箱地址,即收件人看到的发件人地址。需为有效的邮箱格式,且须与 SMTP 服务器的授权账号一致,否则可能被邮件服务商拒绝发送。例如:abc@example.com */ SenderAddress?: string; /** * SMTP 邮件服务器的域名或 IP 地址,用于建立邮件发送连接。不同邮件服务商的 SMTP 地址不同,例如 QQ 邮箱为 smtp.qq.com,Gmail 为 smtp.gmail.com,请以实际服务商提供的地址为准。 */ ServerHost?: string; /** * SMTP 邮件服务器的端口号,需与所选安全模式(SecurityMode)匹配。常用端口:465(SSL 加密)、587(STARTTLS 加密)、25(无加密,不推荐)。建议优先使用 465 或 587 以保障传输安全。 */ ServerPort?: number; /** * SMTP 服务器的登录账号,通常为发件人的完整邮箱地址。部分邮件服务商支持使用独立的 SMTP 授权账号,请以实际服务商的要求为准。 */ AccountUsername?: string; /** * SMTP 服务器的登录密码。注意:部分邮件服务商(如 QQ 邮箱、163 邮箱)不支持直接使用账号登录密码,需在邮箱设置中开启 SMTP 服务并生成专用的授权码,请以实际服务商的要求为准。 */ AccountPassword?: string; /** * SMTP 连接的加密模式,用于保障邮件传输安全。可选值:AUTO(自动选择,优先使用安全连接)、SSL(全程 SSL/TLS 加密,通常配合端口 465 使用)、STARTSSL(通过 STARTTLS 命令升级为加密连接,通常配合端口 587 使用)、NO_SSL(不使用加密,仅建议在内网或测试环境中使用)。推荐使用 AUTO 或 SSL 以确保传输安全。 */ SecurityMode?: string; } /** * DescribeCloudBaseRunBuildLog请求参数结构体 */ export interface DescribeCloudBaseRunBuildLogRequest { /** * 环境ID */ EnvId?: string; /** * 服务名称 */ ServiceName?: string; /** * 版本名称 */ ServiceVersion?: string; /** * 构建ID */ BuildId?: number; /** * 偏移记录 */ Start?: number; } /** * DescribeHTTPServiceRoute请求参数结构体 */ export interface DescribeHTTPServiceRouteRequest { /** * 环境ID */ EnvId: string; /** * 过滤条件。Key的含义参考对应字段,Value精确匹配。可过滤: Domain、Path、DomainType、UpstreamResourceType。可过滤的Values单条不超过100 */ Filters?: Array开始时间, 会根据数据的统计周期进行取整
*/ StartTime?: string; /** *结束时间, 会根据数据的统计周期进行取整
*/ EndTime?: string; /** *指标名
*/ MetricName?: string; /** *统计周期(单位秒), 当时间区间为1天内, 统计周期为5分钟; 当时间区间选择为1天以上, 15天以下, 统计周期为1小时; 当时间区间选择为15天以上, 180天以下, 统计周期为1天
*/ Period?: number; /** *有效的监控数据, 每个有效监控数据的上报时间可以从时间数组中的对应位置上获取到
*/ Values?: Array各数据点的时间戳数组(Unix 时间戳,秒级),与 Values 一一对应
*/ Time?: Array有效的监控数据, 每个有效监控数据的上报时间可以从时间数组中的对应位置上获取到
*/ NewValues?: Array聚合方式, "last" 表示取时间段内最后一个值,“max”表示取时间段内最大值,“avg”表示取时间段内的平均值
*/ Statistics?: string; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * DescribeBaasPackageList请求参数结构体 */ export interface DescribeBaasPackageListRequest { /** * tcb产品套餐ID,不填拉取全量package信息。 */ PackageName?: string; /** * 环境ID */ EnvId?: string; /** * 套餐归属方,填写后只返回对应的套餐 包含miniapp与qcloud两种 默认为miniapp */ Source?: string; /** * 套餐归属环境渠道 */ EnvChannel?: string; /** * 拉取套餐用途: 1)new 新购 2)modify变配 3)renew续费 */ TargetAction?: string; /** * 预留字段,同一商品会对应多个类型套餐,对指标有不同侧重。 计算型calculation 流量型flux 容量型capactiy */ GroupName?: string; /** * 类型分组过滤。默认为["default"] */ PackageTypeList?: Array环境ID
*/ EnvId: string; /** *域名路由信息
*/ Domain: HTTPServiceDomainParam; } /** * CreateHostingDomain请求参数结构体 */ export interface CreateHostingDomainRequest { /** * 环境ID */ EnvId: string; /** * 域名 */ Domain: string; /** * 证书ID */ CertId: string; } /** * 创建或修改HTTP访问服务输入的域名信息,修改HTTP访问服务域名时对应字段不传参数表示不需要修改。 */ export interface HTTPServiceDomainParam { /** *域名。全局唯一。如果域名在其他环境下占用或者腾讯云CDN占用,可能会导致创建失败
*/ Domain: string; /** *绑定类型
枚举值:
默认值:DIRECT
*/ AccessType?: string; /** *证书ID。当前账户下SSL平台的证书ID,无证书无法使用https访问
*/ CertId?: string; /** *协议类型
枚举值:
默认值:HTTP_AND_HTTPS
*/ Protocol?: string; /** *自定义CNAME。对应AccessType: Custom
*/ CustomCname?: string; /** *域名开启状态,不传默认开启
*/ Enable?: boolean; /** *创建/修改的HTTP访问服务路由列表。如果不传,仅创建或修改域名信息。列表最大支持传入20个
*/ Routes?: Array扩展字段,内部包含headers处理等
*/ Extension?: HTTPServiceExtension; } /** * HTTPService 缓存参数(节点缓存 + 浏览器缓存共用行为模式)。 FollowOrigin / NoCache / (CacheTime||MaxAgeTime) 三者互斥,必须开启其一: - FollowOrigin=true:节点与浏览器缓存均遵循源站; - NoCache=true:节点与浏览器缓存均不缓存(Cache-Control: no-cache); - CacheTime>0 或 MaxAgeTime>0:至少设置其一,分别控制节点、浏览器缓存秒数,可独立设置。 */ export interface HTTPServiceCacheParams { /** *遵循源站
*/ FollowOrigin?: boolean; /** *不缓存
*/ NoCache?: boolean; /** *自定义缓存时间(秒)
取值范围:[0, 31536000]
单位:秒
*/ CacheTime?: number; /** *浏览器缓存秒数(对应 max-age)
取值范围:[0, 31536000]
单位:秒
*/ MaxAgeTime?: number; } /** * 自定义短信模板中的自定义参数 */ export interface SMSTemplateParams { /** *短信模板的自定义参数的key。如果短信厂商的自定义参数按照命名占位的,才需要此参数;如果按照序号占位的, 不需要此参数。
腾讯云短信是按照序号占位的,不需要此参数。
注意:此字段可能返回 null,表示取不到有效值。 */ Key?: string; /** *短信模板的自定义参数对应的value
注意:此字段可能返回 null,表示取不到有效值。 */ Value?: string; } /** * UnbindStorageSource返回参数结构体 */ export interface UnbindStorageSourceResponse { /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * DescribeCloudAppInfo请求参数结构体 */ export type DescribeCloudAppInfoRequest = null; /** * ModifyLoginConfig请求参数结构体 */ export interface ModifyLoginConfigRequest { /** * 环境 ID,用于指定需要修改登录策略的云开发环境。 */ EnvId: string; /** * 手机号短信登录开关。设置为 true 开启手机号短信登录,允许用户使用手机号和短信验证码进行登录和注册;设置为 false 关闭手机号短信登录。 */ PhoneNumberLogin: boolean; /** * 邮箱登录开关。设置为 true 开启邮箱登录,允许用户使用邮箱和密码进行登录和注册;设置为 false 关闭邮箱登录。 */ EmailLogin: boolean; /** * 用户名密码登录开关。设置为 true 开启用户名密码登录,允许用户使用用户名和密码进行登录和注册;设置为 false 关闭用户名密码登录。 */ UserNameLogin: boolean; /** * 匿名登录开关。设置为 true 开启匿名登录,允许用户无需注册即可以匿名身份访问应用;设置为 false 关闭匿名登录。 */ AnonymousLogin: boolean; /** * 短信验证码发送配置,用于设置短信验证码的发送通道类型和日发送限额。不传则不修改当前配置。 */ SmsVerificationConfig?: VerificationConfig; /** * MFA 多因子认证登录配置,用于设置多因子认证开关及验证方式(短信、邮箱、TOTP、强制绑定手机号)。不传则不修改当前配置。 */ MfaConfig?: MFALoginConfig; /** * 密码更新策略配置,用于设置首次登录强制修改密码和定期强制修改密码策略。不传则不修改当前配置。 */ PwdUpdateStrategy?: PasswordUpdateLoginConfig; } /** * DeleteCloudApp返回参数结构体 */ export interface DeleteCloudAppResponse { /** * 是否删除成功 */ Result?: boolean; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * DescribePGUserMigration返回参数结构体 */ export interface DescribePGUserMigrationResponse { /** *版本号
参数格式:纯数字,14位时间格式
*/ Version?: string; /** *版本名
参数格式:只允许小写字母和下划线
*/ Name?: string; /** *要执行的migration sql 语句
*/ Query?: string; /** *回滚的sql 语句
deprecated
*/ Rollback?: string; /** *migration query 语句的checksum值,由服务端自动生成,同版本 checksum 不一致会拒绝执行
deprecated
*/ Checksum?: string; /** *用于标记调用来源
deprecated
*/ Source?: string; /** *用于标记该条migration由谁创建,目前默认调用的用户uin
deprecated
*/ CreatedBy?: string; /** *该migration创建时间
deprecated
*/ CreatedAt?: string; /** *该migration应用时间
deprecated
*/ AppliedAt?: string; /** *该migration执行耗时
单位:毫秒
deprecated
*/ DurationMs?: number; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * DescribeCloudBaseRunServerVersion返回参数结构体 */ export interface DescribeCloudBaseRunServerVersionResponse { /** * 版本名称 */ VersionName?: string; /** * 备注 */ Remark?: string; /** * Dockerfile的路径 */ DockerfilePath?: string; /** * DockerBuild的目录 */ BuildDir?: string; /** * 请使用CPUSize */ Cpu?: number; /** * 请使用MemSize */ Mem?: number; /** * 副本最小值 */ MinNum?: number; /** * 副本最大值 */ MaxNum?: number; /** * 策略类型 */ PolicyType?: string; /** * 策略阈值 */ PolicyThreshold?: number; /** * 环境变量 */ EnvParams?: string; /** * 创建时间 */ CreatedTime?: string; /** * 更新时间 */ UpdatedTime?: string; /** * 版本的IP */ VersionIP?: string; /** * 版本的端口号 */ VersionPort?: number; /** * 版本状态 */ Status?: string; /** * 代码包的名字 */ PackageName?: string; /** * 代码版本的名字 */ PackageVersion?: string; /** * 枚举(package/repository/image) */ UploadType?: string; /** * Repo的类型(gitlab/github/coding) */ RepoType?: string; /** * 地址 */ Repo?: string; /** * 分支 */ Branch?: string; /** * 服务名字 */ ServerName?: string; /** * 是否对于外网开放 */ IsPublic?: boolean; /** * vpc id */ VpcId?: string; /** * 子网实例id 注意:此字段可能返回 null,表示取不到有效值。 */ SubnetIds?: Arraysmtp配置
*/ SmtpConfig?: EmailSmtpConfig; /** *可选:TRUE,FALSE,如果On为TRUE,则表示采用默认代发。
*/ On?: string; /** *邮件模板配置
注意:此字段可能返回 null,表示取不到有效值。 */ TemplateConfig?: EmailTemplateConfig; } /** * DestroyEnv请求参数结构体 */ export interface DestroyEnvRequest { /** * 环境Id */ EnvId: string; /** * 针对预付费 删除隔离中的环境时要传true 正常环境直接跳过隔离期删除 */ IsForce?: boolean; /** * 是否绕过资源检查,资源包等额外资源,默认为false,如果为true,则不检查资源是否有数据,直接删除。 */ BypassCheck?: boolean; } /** * 查询用户返回结果 */ export interface DescribeUserListResp { /** * 用户总数 */ Total?: number; /** * 用户列表 */ UserList?: Array环境ID
*/ EnvId: string; /** *服务名
*/ ServiceName: string; /** *部署类型
*/ DeployType: string; /** *构建类型
*/ BuildType?: string; /** *静态应用创建配置信息
*/ StaticConfig?: StaticConfig; /** *源码定义
*/ Source?: BuildSource; /** *Commands 与 CustomSteps 至少填一个
*/ Commands?: BuildCommands; /** *Commands 与 CustomSteps 至少填一个,docker 镜像构建场景强烈建议用 CustomSteps
*/ Env?: Array非敏感环境变量,构建容器中以 $KEY 引用
*/ CustomSteps?: Array敏感凭证(AES 加密落库),构建容器中以 $SECRET_NAME 引用
*/ Secrets?: Array选择 NodeRuntime 版本: 16,18,20,22,24 等
*/ NodeJsVersion?: string; } /** * 身份认证源协议连接配置。包含 OAuth 2.0 / OIDC 协议端点(授权端点、令牌端点、用户信息端点、JWKS 端点等)、客户端凭证(ClientId、ClientSecret)、SAML 元数据、请求与响应参数的字段映射等配置信息。OIDC 类型的认证源字段定义参考 https://openid.net/specs/openid-connect-discovery-1_0.html 规范。 */ export interface ProviderConfig { /** * 身份提供方的唯一标识符(Issuer URL),用于验证 ID Token 中的 iss 字段。仅当 ProviderType 为 OIDC 时需要填写,值通常为第三方 OIDC 服务的根地址,例如:https://accounts.google.com。填写后平台将自动通过 /.well-known/openid-configuration 发现并填充 AuthorizationEndpoint、TokenEndpoint、UserinfoEndpoint、JwksUri 等端点地址。详情参考 OpenID Connect Discovery 标准。 注意:此字段可能返回 null,表示取不到有效值。 */ Issuer?: string; /** * 第三方身份提供方的 JSON Web Key Set 地址,用于获取公钥以验证 ID Token 签名。仅当 ProviderType 为 OIDC 时需要填写。若已填写 Issuer,该字段将通过 OpenID Connect Discovery 自动获取,无需手动填写。详情参考 OpenID Connect Discovery 标准。 注意:此字段可能返回 null,表示取不到有效值。 */ JwksUri?: string; /** * 在第三方身份提供方注册的应用客户端 ID,用于标识当前接入应用。当 ProviderType 为 OIDC 或 OAUTH 时必须填写,可在对应平台的开发者控制台中获取。详情参考 OAuth 2.0 标准。 注意:此字段可能返回 null,表示取不到有效值。 */ ClientId?: string; /** * 在第三方身份提供方注册的应用客户端密钥,与 ClientId 配合使用,用于在 Token 端点进行身份验证。当 ProviderType 为 OIDC 或 OAUTH 时必须填写,请妥善保管,避免泄露。详情参考 OAuth 2.0 标准。 注意:此字段可能返回 null,表示取不到有效值。 */ ClientSecret?: string; /** * OAuth 授权完成后第三方平台回调的地址,需与在第三方平台注册的回调地址完全一致,否则授权将失败。当 ProviderType 为 OIDC 或 OAUTH 时必须填写,并需在对应平台的开发者控制台中配置该地址为合法回调地址。详情参考 OAuth 2.0 标准。 注意:此字段可能返回 null,表示取不到有效值。 */ RedirectUri?: string; /** * 向第三方身份提供方申请的权限范围,多个 scope 之间用空格分隔。当 ProviderType 为 OIDC 或 OAUTH 时必须填写,OIDC 场景下通常至少包含 openid,如需获取用户邮箱或手机号可追加 email、phone 等。若已填写 Issuer 且未指定 Scope,将自动使用 OpenID Connect Discovery 返回的 scopes_supported。详情参考 OAuth 2.0 标准。 注意:此字段可能返回 null,表示取不到有效值。 */ Scope?: string; /** * 第三方身份提供方的授权端点地址,用于发起 OAuth/OIDC 授权请求,引导用户跳转至第三方登录页面。当 ProviderType 为 OIDC 或 OAUTH 时必须填写。若已填写 Issuer,该字段将通过 OpenID Connect Discovery 自动获取,无需手动填写。详情参考 OAuth 2.0 / OIDC 标准。 注意:此字段可能返回 null,表示取不到有效值。 */ AuthorizationEndpoint?: string; /** * 第三方身份提供方的 Token 端点地址,用于通过授权码(code)换取 Access Token 和 ID Token。当 ProviderType 为 OIDC 或 OAUTH 时必须填写。若已填写 Issuer,该字段将通过 OpenID Connect Discovery 自动获取,无需手动填写。详情参考 OAuth 2.0 / OIDC 标准。 注意:此字段可能返回 null,表示取不到有效值。 */ TokenEndpoint?: string; /** * 第三方身份提供方的用户信息端点地址,用于通过 Access Token 获取用户的基本信息(如昵称、头像、邮箱等)。当 ProviderType 为 OIDC 或 OAUTH 且需要获取用户详细信息时填写。若已填写 Issuer,该字段将通过 OpenID Connect Discovery 自动获取,无需手动填写。详情参考 OIDC 标准。 注意:此字段可能返回 null,表示取不到有效值。 */ UserinfoEndpoint?: string; /** * OAuth/OIDC 授权请求的响应类型,决定授权端点返回的内容。可选值:code(授权码模式,推荐)、token(隐式模式,直接返回 Access Token)、id_token(直接返回 ID Token)。当 ProviderType 为 OIDC 时默认使用 id_token,其他类型默认使用 code。当 ProviderType 为 OIDC 或 OAUTH 时可选填写。详情参考 OAuth 2.0 / OIDC 标准。 注意:此字段可能返回 null,表示取不到有效值。 */ ResponseType?: string; /** * 第三方身份提供方的单点退出端点地址。配置后,用户退出当前应用时将被跳转至该地址,使第三方 IDP 的登录态也一并失效,实现单点退出(SLO)。适用于 OIDC、OAUTH、SAML 等所有支持单点退出的身份源类型。不填则退出时仅清除本平台登录态。 注意:此字段可能返回 null,表示取不到有效值。 */ SignoutEndpoint?: string; /** * Token 端点的客户端身份验证方式,决定请求 Token 时如何传递 ClientId 和 ClientSecret。可选值:CLIENT_SECRET_POST(将凭证放在请求 Body 中传递)、CLIENT_SECRET_BASIC(将凭证通过 HTTP Basic Auth Header 传递)。当 ProviderType 为 OIDC 或 OAUTH 时可选填写,默认使用 CLIENT_SECRET_POST。详情参考 OIDC 标准。 注意:此字段可能返回 null,表示取不到有效值。 */ TokenEndpointAuthMethod?: string; /** * SAML 身份提供方的 Metadata XML 内容,包含 IDP 的实体 ID、SSO 端点地址、签名证书等关键信息,平台将据此完成 SAML 协议的对接配置。仅当 ProviderType 为 SAML 时可填写,通常可从第三方 IDP 的管理控制台中下载获取。详情参考 SAML 2.0 标准。 */ SamlMetadata?: string; /** * 请求参数映射配置,用于处理非标准 OAuth 协议的参数转换。默认情况下平台严格遵循 OAuth 2.0 标准进行参数传递,若对接的第三方平台(如微信、企业微信等)使用了非标准的参数名称或传参方式,可通过该字段配置自定义的参数映射规则,以确保请求参数与第三方平台的要求一致。 注意:此字段可能返回 null,表示取不到有效值。 */ RequestParametersMap?: ProviderRequestParametersMap; /** * 响应参数映射配置,用于处理非标准 OAuth 协议的响应参数转换。默认情况下平台严格遵循 OAuth 2.0 标准解析响应参数,若对接的第三方平台(如微信、企业微信等)返回了非标准的字段名称或数据结构,可通过该字段配置自定义的响应参数映射规则,将第三方返回的字段映射为平台标准字段。 注意:此字段可能返回 null,表示取不到有效值。 */ ResponseParametersMap?: ProviderResponseParametersMap; } /** * ModifySafeRule请求参数结构体 */ export interface ModifySafeRuleRequest { /** * 环境ID */ EnvId: string; /** * 集合名称 */ CollectionName: string; /** * 权限标签。包含以下取值:分配请求ID,会按这个值做幂等
入参限制:长度不超过64
*/ AllocateId: string; /** *客户平台的应用标识,如果没有则不传
*/ ExternalAppId?: string; /** *自定义标签
参数格式:逗号分隔的 key=value 对,key/value 仅允许字母、数字、下划线。k1=v1,k2=v2
*/ ExternalTag?: string; /** *是否需要云函数
默认值:false
*/ RequireFunction?: boolean; } /** * 函数的信息 */ export interface FunctionInfo { /** * 命名空间 */ Namespace?: string; /** * 所属地域。 当前支持ap-shanghai */ Region?: string; } /** * CreateEnv返回参数结构体 */ export interface CreateEnvResponse { /** *自动生成的环境ID
*/ EnvId?: string; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * RunCommands返回参数结构体 */ export interface RunCommandsResponse { /** * 返回结果,返回结果为一个json字符串 注意:此字段可能返回 null,表示取不到有效值。 */ Data?: Array成功删除数量
*/ Count?: number; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * ExecutePGSql返回参数结构体 */ export interface ExecutePGSqlResponse { /** *影响行数
*/ AffectedRows?: number; /** *字段名列表
注意:此字段可能返回 null,表示取不到有效值。 */ Columns?: Array字段类型名
注意:此字段可能返回 null,表示取不到有效值。 */ ColumnTypes?: Array数据行。每一行数据都是一个JSON串,将JSON进行反序列化将得到了每列的值。值可能是 null 或者 字符串,如果是 null 说明该列的值为 <null>,如果是字符串则为该列的值的字符串表示形式。
注意:此字段可能返回 null,表示取不到有效值。 */ Rows?: ArraySQL执行耗时
单位:毫秒
*/ ExecutionTimeMs?: number; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * DescribeCreditsUsage请求参数结构体 */ export interface DescribeCreditsUsageRequest { /** *开始日期
*/ StartDate: string; /** *结束日期
*/ EndDate: string; /** *环境id
*/ EnvId: string; } /** * 云开发路由限频策略 */ export interface HTTPServiceRouteQPSPolicy { /** * QPS值,每秒请求次数 */ QPSTotal?: number; /** * 客户端限频配置 */ QPSPerClient?: HTTPServiceQPSPerClient; } /** * CreateUser返回参数结构体 */ export interface CreateUserResponse { /** * 结果返回 */ Data?: CreateUserResp; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * DescribeEnvAccountCircle请求参数结构体 */ export interface DescribeEnvAccountCircleRequest { /** * 环境ID */ EnvId: string; } /** * CreateBillDeal请求参数结构体 */ export interface CreateBillDealRequest { /** * 当前下单的操作类型,可取[purchase,renew,modify]三种值,分别代表新购,续费,变配。 */ DealType: string; /** * 购买的产品类型,可取[tcb-baas,tcb-promotion,tcb-package], 分别代表baas套餐、大促包、资源包 */ ProductType: string; /** * 目标下单产品/套餐Id。 对于云开发环境套餐,可通过 DescribeBaasPackageList 接口获取,对应其出参的PackageName */ PackageId: string; /** * 默认只下单不支付,为ture则下单并支付。 如果需要下单并支付,请确保账户下有足够的余额,否则会导致下单失败。 */ CreateAndPay?: boolean; /** * 购买时长,与TimeUnit字段搭配使用。 */ TimeSpan?: number; /** * 购买时长单位,按各产品规则可选d(天),m(月),y(年),p(一次性)。 对于 云开发环境的 新购和续费,目前仅支持 按月购买(即 TimeUnit=m)。 */ TimeUnit?: string; /** * 资源唯一标识。 在云开发环境 续费和变配 场景下必传,取值为环境ID。 */ ResourceId?: string; /** * 来源可选[qcloud,miniapp],默认qcloud。 miniapp表示微信云开发,主要适用于[小程序云开发](https://developers.weixin.qq.com/miniprogram/dev/wxcloudservice/wxcloud/billing/price.html)。 */ Source?: string; /** * 环境别名,用于新购云开发环境时,给云开发环境起别名。 仅当 新购云开发环境(DealType=purchase 并且 ProductType=tcb-baas )时有效。 ### 格式要求 - 可选字符: 小写字母(a~z)、数字、减号(-) - 不能以 减号(-) 开头或结尾 - 不能有连个连续的 减号(-) - 长度不超过20位 */ Alias?: string; /** * 环境id,当购买资源包和大促包时(ProductType取值为tcb-promotion 或 tcb-package)必传,表示资源包在哪个环境下生效。 */ EnvId?: string; /** * 开启超限按量。 开启后,当 套餐内的资源点 和 资源包 都用尽后,会自动按量计费。 详见 [计费说明](https://cloud.tencent.com/document/product/876/127357)。 */ EnableExcess?: boolean; /** * 变配目标套餐id,对于云开发环境变配场景下必传。 对于云开发环境套餐,可通过 DescribeBaasPackageList 接口获取,对应其出参的PackageName */ ModifyPackageId?: string; /** * jsonstr附加信息 */ Extension?: string; /** * 是否自动选择代金券支付。 */ AutoVoucher?: boolean; /** * 资源类型。 代表新购环境(DealType=purchase 并且 ProductType=tcb-baas )时需要发货哪些资源。 可取值:flexdb, cos, cdn, scf */ ResourceTypes?: Array版本列表
*/ VersionList?: Array总数
*/ Total?: number; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * CreateStaticStore请求参数结构体 */ export interface CreateStaticStoreRequest { /** * 环境ID */ EnvId: string; /** * 是否启用统一域名 */ EnableUnion?: boolean; /** * 外部存储源。 */ ExternalStorage?: ExternalStorage; } /** * HTTPService 路由扩展字段 */ export interface HTTPServiceExtension { /** *添加请求头列表
*/ HeadersHandler?: HTTPServiceHeadersHandler; /** *HTTPService 缓存配置,包含Cache 节点缓存 / MaxAge 浏览器缓存 / CacheKey 自定义缓存键
*/ Cache?: HTTPServiceCacheSet; } /** * HTTPService 缓存配置(域名维度) */ export interface HTTPServiceCacheSet { /** *HTTPService 缓存配置列表。Rules 按数组顺序为优先级顺序,Rules[n-1] 优先级最高
*/ Rules?: Array环境计费信息列表
*/ EnvBillingInfoList?: Array总个数
*/ Total?: number; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * CreateAuthDomain返回参数结构体 */ export interface CreateAuthDomainResponse { /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * ModifyDatabaseACL请求参数结构体 */ export interface ModifyDatabaseACLRequest { /** * 环境ID */ EnvId: string; /** * 集合名称 */ CollectionName: string; /** * 权限标签。包含以下取值:migration 版本号
参数格式:纯数字,14位时间格式
*/ Version: string; /** *migration 版本名
入参限制:仅允许小写字母和下划线
*/ Name: string; /** *migration 应用 sql 语句
*/ Query: string; /** *migration 回滚 sql 语句
*/ Rollback?: string; } /** * UpdateAIModel请求参数结构体 */ export interface UpdateAIModelRequest { /** *环境id
*/ EnvId: string; /** *分组名
*/ GroupName: string; /** *模型地址
枚举值:
模型名列表
Models 列表更新采用全量替换
*/ Models?: Array备注
*/ Remark?: string; /** *模型状态, 1: 开启, 2: 关闭
*/ Status?: number; /** *模型密钥
*/ Secret?: AIModelSecret; } /** * 云服务器登录方式 */ export interface VMLoginConfiguration { /** * 登录方式。扫码登录时指定为 SCAN_LOGIN */ LoginType?: string; /** * 是否自动生成密码 */ AutoGeneratePassword?: string; /** * 指定密码登录 */ Password?: string; /** * 绑定密钥ID */ KeyIds?: Arraymigration 版本号
参数格式:纯数字,14位时间格式
*/ Version?: string; /** *migration 版本名
参数格式:仅允许小写字母和下划线
*/ Name?: string; /** *数据库已应用migration的版本名
参数格式:仅允许小写字母和下划线
*/ RemoteName?: string; /** *本次sql计算出来的checksum
*/ LocalChecksum?: string; /** *已应用的migration,数据库存储的checksum
*/ RemoteChecksum?: string; /** *归入该分组的原因
*/ Reason?: string; /** *冲突信息
*/ Message?: string; } /** * 查询资源权限返回结果 */ export interface DescribeResourcePermissionResult { /** * 查询到的资源总数 */ TotalCount?: number; /** * 资源权限列表 */ PermissionList?: Array索引字段
*/ MgoIndexKeys?: Array是否唯一索引
*/ MgoIsUnique?: boolean; /** *是否稀疏索引
*/ MgoIsSparse?: boolean; /** *稀疏索引表达式
*/ PartialFilterExpression?: string; } /** * UpdateAIModel返回参数结构体 */ export interface UpdateAIModelResponse { /** *更新数量
*/ Count?: number; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * ListPGUserMigrations请求参数结构体 */ export interface ListPGUserMigrationsRequest { /** *云开发环境ID
*/ EnvId: string; /** *查询条数
取值范围:[1, 500]
默认值:100
*/ Limit?: number; /** *分页偏移
默认值:0
*/ Offset?: number; } /** * HTTP访问服务路径重写配置 */ export interface HTTPServicePathRewrite { /** * 路径前缀重写。StaticStorePrefix、Prefix只能填一个 */ Prefix?: string; } /** * ModifyEnvPlan返回参数结构体 */ export interface ModifyEnvPlanResponse { /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * CreateCustomLoginKey请求参数结构体 */ export interface CreateCustomLoginKeyRequest { /** * 环境id */ EnvId: string; } /** * DescribeCreditsUsageDetail返回参数结构体 */ export interface DescribeCreditsUsageDetailResponse { /** *用量数据
*/ Usages?: Array创建数量
*/ Count?: number; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * DescribeCreateMySQLResult请求参数结构体 */ export interface DescribeCreateMySQLResultRequest { /** * 云开发环境ID */ EnvId: string; /** * OpenMysql 返回任务 Id */ TaskId?: string; } /** * ListPGUserMigrations返回参数结构体 */ export interface ListPGUserMigrationsResponse { /** *总数量
*/ Total?: number; /** *已应用最新版本号
参数格式:纯数字,14位时间格式
*/ LatestVersion?: string; /** *已应用migration列表
*/ Migrations?: Array环境ID
*/ EnvId?: string; /** *环境列表,当环境列表不为空时,查询的环境以该参数为准
*/ EnvIds?: Array每页条数(用于拉取列表时分页)
*/ Limit?: number; /** *偏移
*/ Offset?: number; } /** * 扩缩容策略 */ export interface HpaPolicy { /** * 策略类型 */ PolicyType?: string; /** * 策略阈值 */ PolicyThreshold?: number; } /** * DescribeVmInstances请求参数结构体 */ export interface DescribeVmInstancesRequest { /** * 环境ID */ EnvId: string; /** * 服务器类型: LightHouse = 轻量云服务器 CVM = 云服务器 */ Type: string; } /** * BindCls返回参数结构体 */ export interface BindClsResponse { /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * CLS日志单条信息 */ export interface LogObject { /** * 日志属于的 topic ID */ TopicId?: string; /** * 日志主题的名字 */ TopicName?: string; /** * 日志时间 */ Timestamp?: string; /** * 日志内容 */ Content?: string; /** * 采集路径 */ FileName?: string; /** * 日志来源设备 */ Source?: string; } /** * 静态托管的执行命令 */ export interface StaticCmd { /** * 构建命令 */ BuildCmd?: string; /** * 安装命令 */ InstallCmd?: string; /** * 部署命令 */ DeployCmd?: string; } /** * DestroyStaticStore返回参数结构体 */ export interface DestroyStaticStoreResponse { /** * 条件任务结果(succ/fail) */ Result?: string; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * DeleteVmInstance请求参数结构体 */ export interface DeleteVmInstanceRequest { /** * 服务器实例id */ InstanceId: string; /** * 环境id */ EnvId: string; } /** * 托管型AI 模型信息 */ export interface ManagedAIModel { /** *模型名
*/ Model?: string; /** *是否开启MCP
*/ EnableMCP?: boolean; /** *模型规格
*/ ModelSpec?: ManagedAIModelSpec; /** *模型计费信息
*/ ModelChargingInfo?: Array结果返回
*/ Data?: DescribeUserListResp; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * CreateTable请求参数结构体 */ export interface CreateTableRequest { /** * 数据表名;长度不超过96个字符,可以为英文字母、数字、下划线(_)和短横线(-)的组合,且不能以下划线开头 */ TableName: string; /** * FlexDB实例ID,如:tnt-nl7hjzasw */ Tag?: string; /** * FlexDB数据库权限信息 */ PermissionInfo?: PermissionInfo; /** * 云开发环境ID */ EnvId?: string; /** * MongoDB连接器配置 */ MongoConnector?: MongoConnector; } /** * 托管 AI 模型参数规格 */ export interface ManagedAIModelSpec { /** *最大输入 Token
*/ MaxInputToken?: string; /** *最大输出 Token
*/ MaxOutputToken?: string; /** *上下文长度
*/ ContextLength?: string; } /** * CreateMySQL返回参数结构体 */ export interface CreateMySQLResponse { /** * 开通结果 */ Data?: CreateMySQLResult; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * DescribeCloudAppList返回参数结构体 */ export interface DescribeCloudAppListResponse { /** *服务列表
*/ ServiceList?: Array总数
*/ Total?: number; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * DeleteAuthDomain返回参数结构体 */ export interface DeleteAuthDomainResponse { /** * 删除的域名个数 */ Deleted?: number; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * DeleteApiKey请求参数结构体 */ export interface DeleteApiKeyRequest { /** * 环境 ID,用于标识该密钥归属的云开发环境,不同环境之间的数据相互隔离 */ EnvId: string; /** * 密钥的唯一标识符,用于精确定位指定的 API 密钥。可通过查询密钥列表接口获取 */ KeyId: string; } /** * ModifyProvider请求参数结构体 */ export interface ModifyProviderRequest { /** * 云开发环境 ID,用于唯一标识当前操作所属的云开发环境。 */ EnvId: string; /** * 身份源的唯一标识符,用于指定需要修改的目标身份源。格式要求:2~32 位,仅支持小写英文字母和数字,不可包含空格或特殊字符。例如:github、google。 */ Id: string; /** * 身份源的显示名称,支持国际化多语言配置。用户在登录页面看到的身份源名称将使用该字段,建议根据实际业务场景填写易于识别的名称,例如:GitHub、Google 等。 */ Name?: LocalizedMessage; /** * 身份源图标的访问地址,将展示在登录页的身份源按钮上。建议使用 64×64 像素的 SVG 格式图片以保证清晰度,支持 HTTP/HTTPS 公网可访问的图片链接。 */ Picture?: string; /** * 身份源对应的官方主页地址。该信息将在用户查看自己的第三方账号绑定列表时展示,帮助用户识别已绑定的身份源来源。例如 GitHub 身份源可填写:https://github.com。 */ Homepage?: string; /** * 身份源协议类型,决定该身份源使用何种认证协议与第三方平台对接。可选值: OAUTH:标准 OAuth 2.0 协议 OIDC:OpenID Connect 协议 SAML:SAML 2.0 协议 WX_MICRO_APP:微信小程序登录 WX_QRCODE_MICRO_APP:微信小程序扫码登录 WX_CLOUDBASE_MICRO_APP:云开发托管小程序登录 WX_MP:微信公众号网页授权登录 WX_OPEN:微信开放平台扫码登录 WX_WORK_INTERNAL:企业微信自建应用登录 WX_WORK_AGENT:企业微信代开发应用登录 WX_WORK_THIRD_PARTY:企业微信第三方应用登录 WX_WORK_THIRD_PARTY_ASSOCIATION:企业微信第三方应用关联登录 CUSTOM:自定义登录 EMAIL:邮箱登录 */ ProviderType?: string; /** * 身份认证源协议连接配置,包含与第三方平台对接所需的核心参数,如 ClientId、ClientSecret、授权端点、Token 端点、回调地址、Scope、SAML Metadata、请求和响应参数映射等。不同 ProviderType 对应不同的配置项要求。注意:CUSTOM 和 EMAIL 类型的身份源,其存储后端类型(StorageDb)不可修改。 */ Config?: ProviderConfig; /** * 是否开启透传登录模式。可选值:TRUE(开启)、FALSE(关闭,默认值)。开启后,平台不会持久化存储用户数据,仅将第三方身份源返回的用户信息透传给业务方,适用于不希望平台留存用户数据的场景。注意:开启透传模式时,ReuseUserId 将被强制设为 TRUE,AutoSignUpWithProviderUser 将被强制设为 FALSE。 */ TransparentMode?: string; /** * 身份源的启用状态。可选值:TRUE(启用,用户可通过该身份源登录)、FALSE(禁用,登录入口将被隐藏,已有绑定关系不受影响)、UNSPECIFIED(默认为 TRUE)。 */ On?: string; /** * 身份源的详细描述信息,支持国际化多语言配置。可用于向用户说明该身份源的用途或使用场景,例如:谷歌授权登录。 */ Description?: LocalizedMessage; /** * 是否直接复用第三方身份源的用户 ID 作为平台用户 ID。可选值:TRUE(开启,返回的用户 ID 将直接使用第三方身份源的用户 ID,适用于已有用户体系迁移场景)、FALSE(关闭,由平台生成独立用户 ID)、UNSPECIFIED(默认为 FALSE,但当 TransparentMode 为 TRUE 时将被强制设为 TRUE)。注意:开启后需确保第三方用户 ID 的全局唯一性,避免 ID 冲突。 */ ReuseUserId?: string; /** * 邮箱身份源的专项配置,包含邮件服务商、发件人地址、SMTP 配置等参数,用于支持通过邮箱验证码或邮箱密码方式进行身份认证。仅当身份源 ID 为 email 时有效。若该身份源不存在,系统将自动创建一个默认关闭的邮箱身份源。 */ EmailConfig?: EmailProviderConfig; /** * 是否开启邮箱自动关联登录。可选值:TRUE(开启)、FALSE(关闭)、UNSPECIFIED(默认为 FALSE)。开启后,若第三方身份源返回的邮箱与系统中已有用户的邮箱一致,则自动将该第三方账号与已有用户关联并完成登录,无需用户手动绑定。 */ AutoSignInWhenEmailMatch?: string; /** * 是否开启手机号自动关联登录。可选值:TRUE(开启)、FALSE(关闭)、UNSPECIFIED(默认行为等同 TRUE)。开启后,若第三方身份源返回的手机号与系统中已有用户的手机号一致,则自动将该第三方账号与已有用户关联并完成登录,无需用户手动绑定。注意:该字段默认行为(UNSPECIFIED)与 AutoSignInWhenEmailMatch 不同,手机号匹配在未显式关闭时默认生效。 */ AutoSignInWhenPhoneNumberMatch?: string; } /** * DeleteTable请求参数结构体 */ export interface DeleteTableRequest { /** * 待删除的表名 */ TableName: string; /** * FlexDB实例ID */ Tag?: string; /** * 云开发环境ID */ EnvId?: string; /** * MongoDB连接器配置 */ MongoConnector?: MongoConnector; } /** * TDSQL-C网络信息类型 */ export interface MySQLNetDetail { /** * 内网地址 注意:此字段可能返回 null,表示取不到有效值。 */ PrivateNetAddress?: string; /** * 外网地址 注意:此字段可能返回 null,表示取不到有效值。 */ PubNetAddress?: string; /** * 网络信息(VPCID/SubnetID) 注意:此字段可能返回 null,表示取不到有效值。 */ Net?: string; /** * 是否开通公网 */ PubNetAccessEnabled?: boolean; /** * vpc id */ VpcId?: string; /** * vpc name */ VpcName?: string; /** * 子网ID */ SubnetId?: string; /** * 子网名 */ SubnetName?: string; } /** * 环境信息 */ export interface EnvInfo { /** *账户下该环境唯一标识
*/ EnvId?: string; /** *环境来源。包含以下取值:
环境别名,要以a-z开头,不能包含 a-zA-z0-9- 以外的字符
*/ Alias?: string; /** *创建时间
*/ CreateTime?: string; /** *最后修改时间
*/ UpdateTime?: string; /** *环境状态。包含以下取值:
数据库列表
*/ Databases?: Array存储列表
*/ Storages?: Array函数列表
*/ Functions?: Arraytcb产品套餐ID,参考DescribePackages接口的返回值。
*/ PackageId?: string; /** *套餐中文名称,参考DescribePackages接口的返回值。
*/ PackageName?: string; /** *云日志服务列表
*/ LogServices?: Array静态资源信息
*/ StaticStorages?: Array是否到期自动降为免费版
*/ IsAutoDegrade?: boolean; /** *环境渠道
*/ EnvChannel?: string; /** *支付方式。包含以下取值:
是否为默认环境
*/ IsDefault?: boolean; /** *环境所属地域
*/ Region?: string; /** *环境标签列表
*/ Tags?: Array自定义日志服务
*/ CustomLogServices?: Array环境类型:baas, run, hoting, weda
*/ EnvType?: string; /** *是否是dau新套餐
*/ IsDauPackage?: boolean; /** *套餐类型:空\baas\tcbr
*/ PackageType?: string; /** *架构类型
*/ ArchitectureType?: string; /** *回收标志,默认为空
*/ Recycle?: string; /** *环境meta信息列表
*/ Meta?: Arraypg信息
*/ PostgreSQL?: Array构建类型
*/ BuildType?: string; /** *构建Id
*/ BuildId?: string; /** *构建状态
*/ Status?: string; /** *框架
*/ Framework?: string; /** *静态托管配置信息
*/ StaticConfig?: StaticConfig; /** *构建时间
*/ BuildTime?: string; /** *[]BuildStepStatus 的 JSON 序列化
*/ Steps?: Array环境ID
*/ EnvId?: string; /** *tcb产品套餐ID,参考DescribePackages接口的返回值。
*/ PackageId?: string; /** *自动续费标记
*/ IsAutoRenew?: boolean; /** *状态。包含以下取值:
支付方式。包含以下取值:
隔离时间,最近一次隔离的时间
*/ IsolatedTime?: string; /** *过期时间,套餐即将到期的时间
*/ ExpireTime?: string; /** *创建时间,第一次接入计费方案的时间。
*/ CreateTime?: string; /** *更新时间,计费信息最近一次更新的时间。
*/ UpdateTime?: string; /** *true表示从未升级过付费版。
*/ IsAlwaysFree?: boolean; /** *付费渠道。
最新的订单信息
*/ OrderInfo?: OrderInfo; /** *免费配额信息。
*/ FreeQuota?: string; /** *是否开启 超过套餐额度部分转按量付费
环境套餐类型
*/ ExtPackageType?: string; /** *是否付费期环境,可取值:yes/no。
*/ EnvCharged?: string; /** *是否已激活,可取值:yes/no。
*/ EnvActivated?: string; } /** * DescribeEnvs返回参数结构体 */ export interface DescribeEnvsResponse { /** *环境信息列表
*/ EnvList?: Array环境个数
*/ Total?: number; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * ListTables请求参数结构体 */ export interface ListTablesRequest { /** * 每页返回数量(0-1000) */ MgoLimit: number; /** * FlexDB实例ID */ Tag?: string; /** * 分页偏移量 */ MgoOffset?: number; /** * 过滤标签数组,用于过滤表名,可选值如:HIDDEN、WEDA、WEDA_SYSTEM */ Filters?: Array账单名
*/ DealName?: string; /** *账单标识
*/ BillId?: string; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * DescribeEnvPlans请求参数结构体 */ export interface DescribeEnvPlansRequest { /** *套餐英文标识,不指定则返回所有可售卖套餐
枚举值:
构建步骤名称
*/ Name?: string; /** *构建状态
*/ Status?: string; /** *构建耗时
*/ Duration?: string; } /** * DescribeCreateMySQLResult返回参数结构体 */ export interface DescribeCreateMySQLResultResponse { /** * 查询开通结果 */ Data?: DescribeCreateMySQLResult; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * DescribeSafeRule请求参数结构体 */ export interface DescribeSafeRuleRequest { /** * 环境ID */ EnvId: string; /** * 集合名称 */ CollectionName: string; /** * 微信AppId,微信必传 */ WxAppId?: string; } /** * ModifyUser请求参数结构体 */ export interface ModifyUserRequest { /** * 环境id */ EnvId: string; /** * 用户Id, 不做修改 */ Uid: string; /** * 用户名,用户名规则:1. 长度1-64字符 2. 只能包含大小写英文字母、数字和符号 . _ - 3. 只能以字母或数字开头 4. 不能重复,不传该字段或传空字符不修改 */ Name?: string; /** * 用户类型:internalUser-内部用户、externalUser-外部用户,不传该字段或传空字符串不修改。 */ Type?: string; /** * 密码,传入Uid时密码可不传。密码规则:1. 长度8-32字符(推荐12位以上) 2. 不能以特殊字符开头 3. 至少包含以下四项中的三项:小写字母a-z、大写字母A-Z、数字0-9、特殊字符()!@#$%^&*\|?><_-,不传该字段或传空字符串不修改 */ Password?: string; /** * 用户状态:ACTIVE(激活)、BLOCKED(冻结),默认冻结,不传该字段或传空字符串不修改 */ UserStatus?: string; /** * 用户昵称,长度2-64字符,不传该字段不修改,传空字符修改为空 */ NickName?: string; /** * 手机号,11位数字,不传该字段不修改,传空字符串修改为空 */ Phone?: string; /** * 邮箱地址,不传该字段不修改,传空字符修改为空 */ Email?: string; /** * 头像链接,可访问的公网URL,不传该字段不修改,传空字符串修改为空 */ AvatarUrl?: string; /** * 用户描述,最多200字符,不传该字段不修改,传空字符修改为空 */ Description?: string; } /** * DeleteUsers请求参数结构体 */ export interface DeleteUsersRequest { /** * 环境id */ EnvId: string; /** * tcb用户id列表, 一次最多支持删除100个 */ Uids: Array云开发环境ID
*/ EnvId: string; /** *结构化 SQL migration 列表;每项包含 Query SQL 内容
*/ Migrations: Array等待获取数据库锁的最长时间
单位:毫秒
默认值:5000
*/ LockTimeoutMs?: number; /** *单条 SQL 执行最长时间,超过后由 PostgreSQL 取消该语句
单位:毫秒
默认值:300000
*/ StatementTimeoutMs?: number; /** *标记请求来源
deprecated
*/ Source?: string; /** *为true时允许 out-of-order local migrations
默认值:false
*/ IncludeAll?: boolean; } /** * tke集群信息 */ export interface TkeClusterInfo { /** * 集群ID */ ClusterId?: string; /** * 集群的vpcId */ VpcId?: string; /** * 版本内网CLB所在子网Id */ VersionClbSubnetId?: string; } /** * VerifyHTTPServiceRoute请求参数结构体 */ export interface VerifyHTTPServiceRouteRequest { /** *环境ID
*/ EnvId: string; /** *域名路由信息
*/ Domain: HTTPServiceDomainParam; } /** * 身份源配置信息。描述云开发环境下用户登录身份源的完整配置,定义了用户通过何种方式进入系统并完成身份认证。支持多种类型:包括标准协议身份源(OAuth 2.0、OIDC、SAML 2.0)、内置身份源(邮箱登录、自定义登录)以及通过插件机制扩展的身份源(如 CAS)。每个身份源包含认证配置、启用状态、用户自动注册策略、信息透传模式等核心属性,是登录认证流程的核心数据结构。 */ export interface Provider { /** * 身份源的唯一标识符,用于在系统内区分不同的身份源。格式要求:2~32 位,仅支持小写英文字母和数字,不可包含空格或特殊字符。创建后不可修改 */ Id: string; /** * 身份源的安全认证配置,包含与第三方平台对接所需的核心参数,如 ClientId、ClientSecret、授权端点、Token 端点、回调地址、Scope 等。不同 ProviderType 对应不同的配置项。CUSTOM 类型无需手动配置(系统自动填充),OIDC 类型会根据 Issuer 自动补全端点信息,SAML 类型需提供 SamlMetadata(最大 10KB) */ Config: ProviderConfig; /** * 身份源的显示名称,支持国际化多语言配置。用户在登录页面看到的身份源名称将使用该字段,建议根据实际业务场景填写易于识别的名称。未传入时默认使用 Id 值作为显示名称 */ Name?: LocalizedMessage; /** * 身份源图标的访问地址,将展示在登录页的身份源按钮上。建议使用 64×64 像素的 SVG 格式图片以保证清晰度,支持 HTTP/HTTPS 公网可访问的图片链接 注意:此字段可能返回 null,表示取不到有效值。 */ Picture?: string; /** * 身份源对应的官方主页地址。该信息将在用户查看自己的第三方账号绑定列表时展示,帮助用户识别已绑定的身份源来源。例如 GitHub 身份源可填写:https://github.com 注意:此字段可能返回 null,表示取不到有效值。 */ Homepage?: string; /** * 身份源协议类型,决定该身份源使用何种认证协议与第三方平台对接。可选值:OAUTH(标准 OAuth 2.0 协议)、OIDC(OpenID Connect 协议)、SAML(SAML 2.0 协议)、CUSTOM(自定义登录,使用 RSA 密钥对签名验证)、EMAIL(邮箱登录,需配合 EmailConfig 使用) 注意:此字段可能返回 null,表示取不到有效值。 */ ProviderType?: string; /** * 控制第三方身份源登录时是否自动注册系统用户。可选值:TRUE(始终自动注册,无论第三方返回的用户信息是否包含手机号或邮箱)、FALSE(不自动注册,需用户手动绑定)、UNSPECIFIED(默认行为:仅当第三方身份源返回的用户信息中包含手机号或邮箱时才自动注册,否则登录完成后要求用户绑定手机号方可继续使用)。注意:企业微信类型(WX_WORK_AGENT/WX_WORK_INTERNAL/WX_WORK_THIRD_PARTY/WX_WORK_THIRD_PARTY_ASSOCIATION)和微信小程序类型(WX_MICRO_APP/WX_QRCODE_MICRO_APP/WX_OPEN)在 UNSPECIFIED 时会自动设为 TRUE。当 TransparentMode 为 TRUE 时,该字段将被强制设为 FALSE 注意:此字段可能返回 null,表示取不到有效值。 */ AutoSignUpWithProviderUser?: string; /** * 身份源的启用状态。可选值:TRUE(启用,用户可通过该身份源登录)、FALSE(禁用,已有绑定关系不受影响)。未传入时默认为 TRUE(启用) 注意:此字段可能返回 null,表示取不到有效值。 */ On?: string; /** * 身份源的详细描述信息,支持国际化多语言配置。可用于向用户说明该身份源的用途或使用场景。 注意:此字段可能返回 null,表示取不到有效值。 */ Description?: LocalizedMessage; /** * 是否开启信息透传模式。可选值:TRUE(仅登录模式:平台不持久化存储用户数据,仅将第三方身份源返回的用户信息透传给业务方,适用于不希望平台留存用户数据的场景)、FALSE(登录且注册模式:平台正常注册并存储用户信息,默认值)。注意:开启透传模式时,AutoSignUpWithProviderUser 将被强制设为 FALSE;若 ReuseUserId 为 UNSPECIFIED,将被自动设为 TRUE。 注意:此字段可能返回 null,表示取不到有效值。 */ TransparentMode?: string; /** * 是否直接复用第三方身份源返回的用户标识(如 OpenID、UnionID 等)作为平台用户 ID。可选值:TRUE(开启,平台用户 ID 将直接使用第三方身份源返回的用户标识,适用于已有用户体系迁移场景)、FALSE(关闭,由平台生成独立用户 ID)。注意:开启后需确保第三方用户标识的全局唯一性,避免 ID 冲突。当 TransparentMode 为 TRUE 且该字段为 UNSPECIFIED 时,将被自动设为 TRUE 注意:此字段可能返回 null,表示取不到有效值。 */ ReuseUserId?: string; /** * 邮箱身份源的专项配置,仅当 ProviderType 为 EMAIL 时有效且必填。包含邮件服务商、发件人地址、SMTP 配置等参数,用于支持通过邮箱验证码方式进行身份认证。支持两种模式:自有 SMTP 服务器(需填写完整的 SMTP 配置)和平台代发(EmailConfig.On 设为 TRUE 时由平台随机分配 SMTP 服务器) 注意:此字段可能返回 null,表示取不到有效值。 */ EmailConfig?: EmailProviderConfig; /** * 是否开启邮箱自动关联登录。可选值:TRUE(开启)、FALSE(关闭)、UNSPECIFIED(默认为 FALSE)。开启后,若第三方身份源返回的邮箱与系统中已有用户的邮箱一致,则自动将该第三方账号与已有用户关联绑定并完成登录,无需用户手动绑定 注意:此字段可能返回 null,表示取不到有效值。 */ AutoSignInWhenEmailMatch?: string; /** * 是否开启手机号自动关联登录。可选值:TRUE(开启)、FALSE(关闭)、UNSPECIFIED(默认行为等同于 TRUE,即默认开启)。开启后,若第三方身份源返回的手机号与系统中已有用户的手机号一致,则自动将该第三方账号与已有用户关联绑定并完成登录,无需用户手动绑定 注意:此字段可能返回 null,表示取不到有效值。 */ AutoSignInWhenPhoneNumberMatch?: string; } /** * DescribeSafeRule返回参数结构体 */ export interface DescribeSafeRuleResponse { /** * 规则内容 注意:此字段可能返回 null,表示取不到有效值。 */ Rule?: string; /** * 权限标签。包含以下取值:归属权校验的域名
*/ Domain?: string; /** *归属权校验dns校验信息
*/ DnsVerification?: Array归属权校验文件校验信息
*/ FileVerification?: Array客户端维度限频标识。限制当前资源被单个客户端调用的频率,客户端标识支持 用户ID(UserID) 或 客户端 IP(ClientIP)。UserID 包括 云开发用户 ID 或 微信 openid,如果请求无 UserID 信息,则不会限制。
枚举值:
限制QPS值,每秒请求次数
*/ LimitValue?: number; } /** * AssumeRoleForAllocatedEnv返回参数结构体 */ export interface AssumeRoleForAllocatedEnvResponse { /** *SecretId
*/ SecretId?: string; /** *SecretKey
*/ SecretKey?: string; /** *Token值
注意:此字段可能返回 null,表示取不到有效值。 */ Token?: string; /** *过期时间戳
注意:此字段可能返回 null,表示取不到有效值。 */ ExpiredTime?: number; /** *是否从缓存中加载。标明该值是否实时从sts服务获取,还是从缓存中获取。调用方可不关心
*/ IsCache?: boolean; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * 登录短信验证码发送配置。用于管理登录时使用的短信验证码发送的通道相关设置,目前提供云开发默认短信包和客户自定义短信包,自定义短信包可以通过自定义apis或者自定义短信模板的方式接入,推荐使用云开发默认短信包,方便快捷。 - 如果使用自定义APIs发送短信,方法命名规则 方法名称:发送验证码 方法标识:SendVerificationCode 入参 Mobile:字符串(手机号,如:“+86 + 手机号”) VerificationCode:字符串(验证码,如:“123456”) 返回值 ErrorCode:int(0 表示成功,非 0 表示失败) ErrorMessage:字符串(ErrorCode 非 0 时,返回错误信息) - 如果使用自定义短信模板发送短信时,需要按照对应的短信服务商的要求,申请并审核通过对应的短信模板后,在云开发平台配置自定义短信模板,云开发平台对于短信模板不会做其他操作和限制,只做短信发送的逻辑,其他的操作限制都由短信服务商自身提供。 */ export interface VerificationConfig { /** *短信验证码发送通道类型。
枚举值:
自定义 APIs 数据源唯一标识,当 Type 为 apis 时必填。用于定位微搭 APIs 中对应的数据源。
注意:此字段可能返回 null,表示取不到有效值。 */ Name?: string; /** *自定义 APIs 方法名,当 Type 为 apis 时必填。指定微搭 APIs 中用于发送验证码的方法。
注意:此字段可能返回 null,表示取不到有效值。 */ Method?: string; /** *单个手机号每日短信发送上限。默认值为 30,传 -1 表示不限制,如果设置为不限制,需要注意恶意攻击,导致短信套餐用量计费问题。仅支持正整数或 -1。不传则不修改当前配置。
注意:此字段可能返回 null,表示取不到有效值。 */ SmsDayLimit?: number; /** *自定义短信服务商模板配置
注意:此字段可能返回 null,表示取不到有效值。 */ TemplateProvider?: SMSProviderTemplateConfig; /** *云函数短信通道配置,当 Type 为 function 时必填
注意:此字段可能返回 null,表示取不到有效值。 */ CloudFunction?: SMSCloudFunctionConfig; } /** * DescribeTables返回参数结构体 */ export interface DescribeTablesResponse { /** * 表信息 注意:此字段可能返回 null,表示取不到有效值。 */ Tables?: Array静态CDN域名
*/ StaticDomain?: string; /** *静态CDN默认文件夹,当前为根目录
*/ DefaultDirName?: string; /** *资源状态(process/online/offline/init)
*/ Status?: string; /** *cos所属区域
*/ Region?: string; /** *bucket信息
*/ Bucket?: string; /** *到期时间(秒级时间戳)
*/ AccessExpire?: number; /** *外部存储。
*/ ExternalStorage?: ExternalStorage; } /** * DescribeHTTPServiceRoute返回参数结构体 */ export interface DescribeHTTPServiceRouteResponse { /** * 域名路由信息列表 */ Domains?: Array归属权校验文件路径
*/ Path?: string; /** *归属权校验文件内容
*/ Content?: string; } /** * 销毁 Mysql 结果 */ export interface DestroyMySQLResult { /** * 是否成功 */ IsSuccess?: boolean; /** * 任务ID */ TaskId?: string; /** * 任务名 */ TaskName?: string; } /** * PreviewPGUserMigrations返回参数结构体 */ export interface PreviewPGUserMigrationsResponse { /** *将要执行的migration列表
*/ Pending?: Array已经应用的migration列表
*/ Applied?: Array版本相同但 checksum 不一致冲突的migration列表
*/ Conflicts?: Array是否可直接执行;当前仅表示没有 checksum 冲突
*/ Executable?: boolean; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * ReleaseEnv请求参数结构体 */ export interface ReleaseEnvRequest { /** *环境ID
*/ EnvId?: string; /** *分配请求ID
*/ AllocateId?: string; } /** * PreviewPGUserMigrations请求参数结构体 */ export interface PreviewPGUserMigrationsRequest { /** *云开发环境ID
*/ EnvId: string; /** *预览要执行的migration 列表
*/ Migrations: Array标记请求来源
deprecated
*/ Source?: string; /** *是否允许 out-of-order local migrations
默认值:false
*/ IncludeAll?: boolean; } /** * CreateMySQL请求参数结构体 */ export interface CreateMySQLRequest { /** * 云开发环境ID */ EnvId: string; /** * Db类型: MYSQL */ DbInstanceType: string; /** * mysql版本 */ MysqlVersion?: string; /** * vpc Id */ VpcId?: string; /** * 子网ID */ SubnetId?: string; /** * 0 区分表名大小写;1 不区分表名大小写(默认) */ LowerCaseTableNames?: string; } /** * 数据库资源信息 */ export interface DatabasesInfo { /** * 数据库唯一标识 */ InstanceId?: string; /** * 状态。包含以下取值:域名
*/ Domain?: string; /** *域名类型。 HTTPSERVICE: HTTP访问服务,CBR: 云托管服务,ANYSERVICE: 任意服务,AI_AGENT: AI agent,VM: 主机,INTEGRATION_CALLBACK: 集成回调
*/ DomainType?: string; /** *绑定类型。默认DIRECT。DIRECT: 直连到HTTP访问服务, CDN: 接入云开发CDN,CUSTOM: 自定义接入类型(其他CDN或者WAF)
*/ AccessType?: string; /** *证书ID。当前账户下SSL平台的证书ID
*/ CertId?: string; /** *协议类型。默认HTTP_AND_HTTPS。HTTP_AND_HTTPS: 同时开启http和https,HTTP_TO_HTTPS: http重定向成https,HTTPS_TO_HTTP: https重定向成http。如果未配置证书无法访问https或者进行重定向
*/ Protocol?: string; /** *配置DNS解析的CNAME。根据AccessType返回不同的CNAME值。
*/ Cname?: string; /** *是否是默认域名
*/ IsDefault?: boolean; /** *域名开启状态
*/ Enable?: boolean; /** *状态。
枚举值:
DNS解析状态
枚举值:
是否CNAME到平台任一网关入口,默认接入/CDN/EO,不含CustomCname
枚举值:
HTTP访问服务路由信息
*/ Routes?: Array扩展字段,内部包含headers处理等
*/ Extension?: HTTPServiceExtension; /** *域名创建时间,格式 YYYY-MM-DDTHH:mm:ss±HH:mm,时区为 UTC+8
*/ CreateTime?: string; /** *域名更新时间,格式 YYYY-MM-DDTHH:mm:ss±HH:mm,时区为 UTC+8
*/ UpdateTime?: string; } /** * 构建密钥 */ export interface BuildSecret { /** *标准化为 DNS Label 风格;构建时注入为 $SECRET_<NAME>(同时也提供原大写形式 $SECRET_<NAME_UPPERCASE>)
*/ Name?: string; /** *平台 AES 加密落库;DescribeVersion 永不回显明文
*/ Value?: string; } /** * 描述键值对过滤器,用于条件过滤查询。例如过滤ID、名称、状态等 */ export interface Filter { /** * 需要过滤的字段。过滤条件数量限制为10。 */ Name?: string; /** * 字段的过滤值。 */ Values?: Array构建Id
*/ BuildId?: string; /** *版本名称
*/ VersionName?: string; /** *服务名称
*/ ServiceName?: string; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * PostgreSQL资源信息结构体 */ export interface PostgreSQLInfo { /** *数据库名称
*/ Name?: string; /** *实例id
*/ InstanceName?: string; /** *实例状态
*/ Status?: number; /** *地域
*/ Region?: string; } /** * CreateUser请求参数结构体 */ export interface CreateUserRequest { /** * 环境id */ EnvId: string; /** * 用户名,用户名规则:1. 长度1-64字符 2. 只能包含大小写英文字母、数字和符号 . _ - 3. 只能以字母或数字开头 4. 不能重复 */ Name: string; /** * 用户ID,最多64字符,如不传则系统自动生成 */ Uid?: string; /** * 用户类型:internalUser-内部用户、externalUser-外部用户,默认internalUser(内部用户) */ Type?: string; /** * 密码,传入Uid时密码可不传。密码规则:1. 长度8-32字符(推荐12位以上) 2. 不能以特殊字符开头 3. 至少包含以下四项中的三项:小写字母a-z、大写字母A-Z、数字0-9、特殊字符()!@#$%^&*\|?><_- */ Password?: string; /** * 用户状态:ACTIVE(激活)、BLOCKED(冻结),默认激活 */ UserStatus?: string; /** * 用户昵称,长度2-64字符 */ NickName?: string; /** * 手机号,不能重复 */ Phone?: string; /** * 邮箱地址,不能重复 */ Email?: string; /** * 头像链接,可访问的公网URL */ AvatarUrl?: string; /** * 用户描述,最多200字符 */ Description?: string; } /** * CreateApiKey返回参数结构体 */ export interface CreateApiKeyResponse { /** * API Key 的唯一标识符,由系统基于 JWT Access Token Hash 自动生成。后续对该 API Key 进行查询、修改名称或删除操作时,均需使用该值作为定位参数 */ KeyId?: string; /** * API Key 的名称,即创建时传入的 KeyName 参数值。对于 publish_key 类型,该值固定为 publish_key */ Name?: string; /** * API Key 的令牌值(JWT 格式),用于服务端接口调用时的身份认证。出于安全考虑,仅在创建时返回一次完整明文;后续通过列表查询接口获取时,api_key 类型将进行脱敏处理;publish_key 类型始终返回完整明文。请在创建后妥善保存 注意:此字段可能返回 null,表示取不到有效值。 */ ApiKey?: string; /** * API Key 的过期时间。对于 api_key 类型:若创建时未指定有效期,则该字段不返回,表示永不过期;若指定了有效期,则返回具体的过期时间。对于 publish_key 类型:始终返回,固定为 2099 年 注意:此字段可能返回 null,表示取不到有效值。 */ ExpireAt?: string; /** * API Key 的创建时间。对于 api_key 类型:为实际创建该 Key 时的时间。对于 publish_key 类型:若环境下已存在 publish_key,则返回首次创建的时间而非本次调用时间 注意:此字段可能返回 null,表示取不到有效值。 */ CreateAt?: string; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * vm规格 */ export interface VMSpecLightHouse { /** * LH主机的BundleId */ BundleId?: string; /** * 主机配置详情json */ BundleConfig?: string; } /** * ModifyResourcePermission请求参数结构体 */ export interface ModifyResourcePermissionRequest { /** * 环境 ID */ EnvId: string; /** * 资源类型:`function`-云函数、`storage`-云存储、`table`-SQL型数据库表、`collection`-文档型数据库表。 */ ResourceType: string; /** * 权限级别。可选值:- SQL型数据库表:`READONLY`-读取全部数据,修改本人数据;`PRIVATE`-读取和修改本人数据;`ADMINWRITE`-读取全部数据,不可修改数据;`ADMINONLY`-无权限 。- 文档型数据库表:`READONLY`-读取全部数据,修改本人数据;`PRIVATE`-读取和修改本人数据;`ADMINWRITE`-读取全部数据,不可修改数据;`ADMINONLY`-无权限;`CUSTOM`-自定义安全规则 。- 云函数:`CUSTOM`-自定义安全规则 。- 云存储(权限标签):`READONLY`-所有用户可读,仅创建者和管理员可写;`PRIVATE`-仅创建者及管理员可读写;`ADMINWRITE`-所有用户可读,仅管理员可写;`ADMINONLY`-仅管理员可读写;`CUSTOM`-自定义安全规则。 */ Permission: string; /** * 资源标识。云函数可不传、云存储传存储桶名、数据库表传表名。 */ Resource?: string; /** * 自定义安全规则配置,当Permission为 `CUSTOM`时必传。JSON字符串格式的规则表达式。配置参考:[云函数安全规则](https://docs.cloudbase.net/cloud-function/security-rules)、[云存储安全规则](https://docs.cloudbase.net/storage/security-rules)、[文档型数据库安全规则](https://docs.cloudbase.net/database/security-rules)。 */ SecurityRule?: string; } /** * DescribeMySQLTaskStatus返回参数结构体 */ export interface DescribeMySQLTaskStatusResponse { /** * 任务状态 */ Data?: MySQLTaskStatus; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * 表信息 */ export interface TableInfo { /** * 表名 注意:此字段可能返回 null,表示取不到有效值。 */ TableName?: string; /** * 表中文档数量 注意:此字段可能返回 null,表示取不到有效值。 */ Count?: number; /** * 表的大小(即表中文档总大小),单位:字节 注意:此字段可能返回 null,表示取不到有效值。 */ Size?: number; /** * 索引数量 注意:此字段可能返回 null,表示取不到有效值。 */ IndexCount?: number; /** * 索引占用空间,单位:字节 注意:此字段可能返回 null,表示取不到有效值。 */ IndexSize?: number; } /** * AssumeRoleForAllocatedEnv请求参数结构体 */ export interface AssumeRoleForAllocatedEnvRequest { /** *环境ID
*/ EnvId: string; } /** * 用户信息 */ export interface User { /** * 用户ID */ Uid?: string; /** * 用户名 */ Name?: string; /** * 用户类型:internalUser-内部用户、externalUser-外部用户 */ Type?: string; /** * 用户状态:ACTIVE(激活)、BLOCKED(冻结) */ UserStatus?: string; /** * 用户昵称 */ NickName?: string; /** * 手机号 */ Phone?: string; /** * 邮箱 */ Email?: string; /** * 头像链接 */ AvatarUrl?: string; /** * 用户描述 */ Description?: string; } /** * CreateAIModel请求参数结构体 */ export interface CreateAIModelRequest { /** *环境id
*/ EnvId: string; /** *分组名
入参限制:不允许以 cloudbase 为前缀
*/ GroupName: string; /** *模型服务地址
*/ BaseUrl?: string; /** *模型名列表
*/ Models?: Array分组备注
*/ Remark?: string; /** *模型状态, 1: 开启, 2: 关闭
*/ Status?: number; /** *模型密钥
*/ Secret?: AIModelSecret; } /** * DescribeLoginConfig返回参数结构体 */ export interface DescribeLoginConfigResponse { /** * 是否开启邮箱登录方式。true 表示已开启,允许用户使用邮箱和密码进行登录;false 表示已关闭。 */ EmailLogin?: boolean; /** * 是否开启匿名登录方式。true 表示已开启,允许用户无需注册即可以匿名身份登录;false 表示已关闭。 */ AnonymousLogin?: boolean; /** * 是否开启用户名密码登录方式。true 表示已开启,允许用户使用用户名和密码进行登录;false 表示已关闭。 */ UserNameLogin?: boolean; /** * 短信验证码发送配置,包含短信发送通道类型、自定义 APIs 数据源、调用方法及每日发送限额等信息。 */ SmsVerificationConfig?: VerificationConfig; /** * 是否开启手机号短信登录方式。true 表示已开启,允许用户使用手机号和短信验证码进行登录和注册;false 表示已关闭。 */ PhoneNumberLogin?: boolean; /** * MFA 多因子认证登录配置,包含 MFA 开关及各验证方式(短信、邮箱、TOTP、强制绑定手机号)的启用状态。 注意:此字段可能返回 null,表示取不到有效值。 */ MfaConfig?: MFALoginConfig; /** * 密码修改策略配置,包含首次登录强制修改密码开关及定期修改密码策略(周期和时间单位)。 注意:此字段可能返回 null,表示取不到有效值。 */ PwdUpdateStrategy?: PasswordUpdateLoginConfig; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * DeleteAIModel请求参数结构体 */ export interface DeleteAIModelRequest { /** *环境id
*/ EnvId: string; /** *分组名列表
*/ GroupNames: Array云开发环境ID
*/ EnvId: string; /** *要执行的SQL语句
*/ Sql: string; /** *指定 role 执行 SQL
*/ Role?: string; } /** * DescribeUserList请求参数结构体 */ export interface DescribeUserListRequest { /** *环境id
*/ EnvId: string; /** *页码,从1开始,默认1
*/ PageNo?: number; /** *每页数量,默认20,最大100
*/ PageSize?: number; /** *用户名,模糊查询
*/ Name?: string; /** *用户昵称,模糊查询
*/ NickName?: string; /** *手机号,模糊查询
*/ Phone?: string; /** *邮箱,模糊查询
*/ Email?: string; /** *用户id列表,根据id过滤用户
*/ UidList?: Array环境ID
*/ EnvId: string; /** *开始时间,如2018-08-24 10:50:00, 开始时间需要早于结束时间至少五分钟(原因是因为目前统计粒度最小是5分钟)
*/ StartTime: string; /** *结束时间,如2018-08-24 10:50:00, 结束时间需要晚于开始时间至少五分钟(原因是因为目前统计粒度最小是5分钟)
*/ EndTime: string; /** *资源ID, 目前仅对文档型数据库、云函数、云托管、数据库连接器相关的指标有意义。
如果想查询某个具体云函数/具体数据库集合的指标,则需传入对应的云函数名称/集合名称;如果只想查询整个namespace的指标, 则留空或不传。
云托管相关指标的查询,必须传入云托管服务名称。
数据库连接器相关指标的查询,必须传入数据库连接器实例id
微信AppId,微信必传
*/ WxAppId?: string; /** *子资源信息。
查询云托管相关指标的具体版本的监控数据,需传入。
网关路由
*/ ThirdResource?: string; /** *统计周期(单位秒),非必传,传入时仅支持传入300,3600,86400。不传采用默认以下默认规则:当时间区间为1天内, 统计周期为300;当时间区间选择为1天以上, 15天以下, 统计周期为3600; 当时间区间选择为15天以上, 180天以下, 统计周期为86400。
如果传入period,需遵循以下规则。EndTime-StartTime的时间范围不超过1 天,Period可以取300或3600;EndTime-StartTime的时间范围满足超过1天且不超过3 天,Period可以取300或3600或86400;EndTime-StartTime的时间范围超过3天时,Period可以取3600或86400。
时间
*/ CalcTime?: string; /** *原始资源用量
*/ RawValue?: number; /** *资源点用量
*/ CreditsValue?: number; /** *资源点套餐内用量
*/ DeductValue?: number; /** *资源点资源包用量
*/ PackageDeductValue?: number; /** *资源点按量用量
*/ ReportValue?: number; } /** * DescribeResourcePermission请求参数结构体 */ export interface DescribeResourcePermissionRequest { /** * 环境 ID */ EnvId: string; /** * 资源类型:`function`-云函数、`storage`-云存储、`table`-SQL型数据库表、`collection`-文档型数据库表 `HTTPService 缓存动作类型
枚举值:
节点缓存配置。Type=Cache 时必填
*/ Cache?: HTTPServiceCacheParams; /** *自定义缓存键。Type=CacheKey 时必填
*/ CacheKey?: HTTPServiceCacheKeyParams; } /** * 资源权限 */ export interface ResourcePermission { /** * 资源类型。 */ ResourceType?: string; /** * 资源标识 */ Resource?: string; /** * 权限级别。取值:READONLY、PRIVATE、ADMINWRITE、ADMINONLY、CUSTOM。 */ Permission?: string; /** * 自定义安全规则配置,当 Permission 为 CUSTOM 时返回。 */ SecurityRule?: string; } /** * 对象变量 */ export interface Variable { /** * 变量的名称 */ Key?: string; /** * 变量的值 */ Value?: string; } /** * ModifyHTTPServiceRoute返回参数结构体 */ export interface ModifyHTTPServiceRouteResponse { /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * 邮件模板配置 */ export interface EmailTemplateConfig { /** *注册登录模板
入参限制:模板中必须包含{{.VerificationCode}}变量,用于邮件中验证码的展示,可选变量有{{.Usage}}、{{.ExpireMinutes}}、{{.Email}}。邮件模板中禁止包含 script、javascript、onclick、onload、iframe、link 标签及 CSS expression、CSS url() 等
注意:此字段可能返回 null,表示取不到有效值。 */ RegisterSignIn?: LocalizedTemplate; /** *默认模板
入参限制:模板中必须包含{{.VerificationCode}}变量,用于邮件中验证码的展示,可选变量有{{.Usage}}、{{.ExpireMinutes}}、{{.Email}}。邮件模板中禁止包含 script、javascript、onclick、onload、iframe、link 标签及 CSS expression、CSS url() 等
注意:此字段可能返回 null,表示取不到有效值。 */ DefaultTpl?: LocalizedTemplate; } /** * GetProviders返回参数结构体 */ export interface GetProvidersResponse { /** * 总数 注意:此字段可能返回 null,表示取不到有效值。 */ Total?: number; /** * 三方认证源列表 注意:此字段可能返回 null,表示取不到有效值。 */ Data?: Array环境 id
*/ EnvId: string; /** *cpu 核数
单位:核数
*/ Cpu?: number; /** *内存容量
单位:GB
*/ Memory?: number; /** *磁盘容量
单位:GB
*/ Storage?: number; /** *类型
枚举值:
SwitchTag=1 时,启动时间
参数格式:YYYY-MM-dd HH:mm:ss
*/ SwitchStartTime?: string; /** *SwitchTag=1 时结束时间
参数格式:YYYY-MM-dd HH:mm:ss
*/ SwitchEndTime?: string; /** *预检
*/ DryRun?: boolean; } /** * DescribePGUserMigration请求参数结构体 */ export interface DescribePGUserMigrationRequest { /** *云开发环境ID
*/ EnvId: string; /** *版本号
参数格式:14位时间格式
入参限制:纯数字
*/ MigrationVersion: string; } /** * DescribeVmInstances返回参数结构体 */ export interface DescribeVmInstancesResponse { /** * 主机实例列表 */ InstanceList?: Array资源所属地域。
当前支持ap-shanghai
桶名,存储资源的唯一标识
*/ Bucket?: string; /** *cdn 域名
*/ CdnDomain?: string; /** *资源所属用户的腾讯云appId
*/ AppId?: string; /** *外部存储介质相关信息。
*/ ExternalStorage?: ExternalStorage; } /** * 修改用户返回值 */ export interface ModifyUserResp { /** * 是否成功 */ Success?: boolean; } /** * ModifySafeRule返回参数结构体 */ export interface ModifySafeRuleResponse { /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * migration 列表 */ export interface MigrationSummary { /** *migration 版本号
参数格式:纯数字,14位时间格式
*/ Version?: string; /** *migration 版本名
参数格式:仅允许小写字母和下划线
*/ Name?: string; /** *migration query sql 语句checksum,服务端自动生成,同版本不同checksum会拒绝执行
deprecated
*/ Checksum?: string; /** *应用时间
deprecated
*/ AppliedAt?: string; /** *请求来源
deprecated
*/ Source?: string; /** *migration 创建时间
deprecated
*/ CreatedBy?: string; } /** * ModifyClient返回参数结构体 */ export interface ModifyClientResponse { /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * DescribeTable请求参数结构体 */ export interface DescribeTableRequest { /** * 表名 */ TableName: string; /** * FlecDB实例ID */ Tag?: string; /** * 云开发环境ID */ EnvId?: string; /** * MongoDB连接器配置 */ MongoConnector?: MongoConnector; } /** * UpdateTable请求参数结构体 */ export interface UpdateTableRequest { /** *表名
*/ TableName: string; /** *FlexDB实例ID
*/ Tag?: string; /** *待删除索引信息
*/ DropIndexes?: Array待创建索引信息
*/ CreateIndexes?: Array云开发环境ID
*/ EnvId?: string; /** *MongoDB连接器配置
*/ MongoConnector?: MongoConnector; } /** * DescribeCloudAppCosInfo返回参数结构体 */ export interface DescribeCloudAppCosInfoResponse { /** * 上传url */ UploadUrl?: string; /** * 上传header */ UploadHeaders?: Array模块列表
枚举值:
开始日期
*/ StartDate: string; /** *结束日期
*/ EndDate: string; /** *是否需要每日用量明细
*/ NeedUsageDetails: boolean; /** *环境id
*/ EnvId: string; } /** * 合法域名 */ export interface AuthDomain { /** * 域名ID */ Id?: string; /** * 域名 */ Domain?: string; /** * 域名类型。包含以下取值:服务名称
*/ ServiceName?: string; /** *框架名称
*/ Framework?: string; /** *域名
*/ Domain?: string; /** *构建路径
*/ AppPath?: string; /** *服务创建时间
*/ CreateTime?: string; /** *最新版本名
*/ LatestVersionName?: string; /** *最新版本状态
*/ LatestStatus?: string; /** *最新版本构建时间
*/ LatestBuildTime?: string; /** *部署类型
*/ DeployType?: string; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * 外部存储。 标识该存储介质,并非由云开发CloudBase创建,而是绑定的其他存储介质。 目前仅支持 [腾讯云-对象存储](https://cloud.tencent.com/document/product/436)。 */ export interface ExternalStorage { /** * 桶名。 当 Provider=cos 时,表示腾讯云对象存储桶。 */ BucketName: string; /** * Bucket所属地域。 当 Provider=cos 时,表示腾讯云对象存储桶的所属地域。 */ Region: string; /** * 基础路径。 绑定之后,用户访问云存储内的文件,后台会自动以BasePath作为前缀,拼接到所访问的文件中。 例如: BasePath=my-cloudbase-path , 当用户访问云存储内的 /tencentcloud.png 时,实际访问的完整路径是:/my-cloudbase-path/tencentcloud.png */ BasePath: string; /** * 是否启用外部存储 */ Enabled?: boolean; } /** * DescribeHostingDomainTask返回参数结构体 */ export interface DescribeHostingDomainTaskResponse { /** * todo/doing/done/error */ Status?: string; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * DeleteAuthDomain请求参数结构体 */ export interface DeleteAuthDomainRequest { /** * 开发者的环境ID */ EnvId: string; /** * 域名ID列表,支持批量传递 */ DomainIds: Array归属权校验不通过返回信息,根据校验信息配置dns或者文件验证,可通过VerifyHTTPServiceRoute接口验证归属权是否通过
*/ OwnershipVerification?: OwnershipVerificationInfo; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * ModifyEnvExtra请求参数结构体 */ export interface ModifyEnvExtraRequest { /** *环境ID
*/ EnvId: string; /** *开启或关闭 超限转按量。
可取值: TRUE/FALSE (字符串类型)
非法制、不传、为空 则不变更该字段。
自定义描述,最多 128 字节
*/ Description?: string; /** *规则开关:nil/true 启用,false 禁用
*/ Enable?: boolean; /** *HTTPService 规则匹配条件(必填)
*/ Condition?: HTTPServiceRuleCondition; /** *HTTPService 缓存动作列表,同一规则内相同 Type 至多一个
*/ Actions?: Array托管模型列表
注意:此字段可能返回 null,表示取不到有效值。 */ ManagedAIModelList?: Array套餐标识
*/ PackageId?: string; /** *套餐中文名称
*/ PackageTitle?: string; /** *套餐描述
*/ PackageDescription?: string; /** *单位原价
*/ UnitPrice?: string; /** *套餐类型
*/ PackageType?: string; /** *json格式化用户资源限制
*/ ResourceLimit?: string; } /** * 静态托管的环境变量参数 */ export interface StaticEnvironment { /** * 环境变量数组 注意:此字段可能返回 null,表示取不到有效值。 */ Variables?: Array中文
注意:此字段可能返回 null,表示取不到有效值。 */ ZhCN?: string; /** *英文
注意:此字段可能返回 null,表示取不到有效值。 */ EnUS?: string; } /** * 标签键值对 */ export interface Tag { /** * 标签键 */ Key: string; /** * 标签值 */ Value: string; } /** * CreateEnv请求参数结构体 */ export interface CreateEnvRequest { /** *环境别名。
云开发环境套餐Id。
对于云开发环境套餐,可通过 DescribeBaasPackageList 接口获取,对应其出参的PackageName。
资源类型。代表新购环境时需要发货哪些资源。
可取值以及含义:
该字段不可为空
*/ Resources: Array购买实例的时长,单位:月。取值范围:1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 24。
默认值为1,即1个月。
是否自动选择代金券支付。
*/ AutoVoucher?: boolean; /** *环境标签。
可取值通过接口 tag:DescribeTags 可获取到。
不传或为空则默认不打任何标签。
自动续费标识。取值范围:
默认取值:NOTIFY_AND_MANUAL_RENEW。
若该参数指定为NOTIFY_AND_AUTO_RENEW(即:自动续费),在账户余额充足的情况下,实例到期后将按月自动续费;但如果账户余额不足,将无法自动续费。请留意腾讯云短信和邮件通知。
云存储外部存储源。
表示该环境下不再自动分配云存储cos桶,而是由指定的bucket作为该环境的云存储介质。
仅当 Resources 中包含storage时有效。
*/ ExternalStorage?: ExternalStorage; /** *开启或关闭 超限转按量。 可取值: TRUE/FALSE (字符串类型) 非法制、不传、为空 则不变更该字段。
*/ EnableOverrun?: string; } /** * DeleteHTTPServiceRoute请求参数结构体 */ export interface DeleteHTTPServiceRouteRequest { /** * 环境ID */ EnvId: string; /** * 域名 */ Domain: string; /** * 路径列表。为空则表示删除此域名和所有路由 */ Paths?: Array源码来源类型,取值:"git" "zip"
*/ Type?: string; /** *Git 仓库 HTTPS URL;或 COS 下载完整 URL;与 CodeUrlWithAuth / CosTimestamp 之一非空(zip 二阶段上传时可留空)
*/ Repo?: string; /** *分支 tag commit;Git 默认 main,zip 模式下忽略
*/ Ref?: string; /** *"git" "github" "gitlab" "gitee" "coding";私有仓必填,平台据此走 OAuth 鉴权
*/ Channel?: string; /** *是否私有仓;true 时平台自动注入 CodeUrlWithAuth
*/ IsPrivate?: boolean; /** *调用方显式传入的带鉴权 clone URL 或带签名的 zip 下载直链(优先级最高,会覆盖平台 OAuth / 自动签名)
*/ CodeUrlWithAuth?: string; /** *仅 Type=zip/cos 时使用。配合 zip 二阶段上传:填 DescribeCloudAppCosInfo 返回的 UnixTimestamp,平台据此自动签名出 ZIP_FILE_URL
*/ CosTimestamp?: string; /** *仅 Type=zip/cos 时使用。zip 文件后缀,默认 .zip;与 CosTimestamp 配合定位 COS 对象
*/ CosSuffix?: string; } /** * DescribeAuthDomains请求参数结构体 */ export interface DescribeAuthDomainsRequest { /** * 环境ID */ EnvId: string; } /** * DescribeVmSpec返回参数结构体 */ export interface DescribeVmSpecResponse { /** * 规格列表 */ SpecList?: Array检查状态
枚举值:
默认值:SKIPPED
*/ Status?: string; /** *前置校验子项失败原因枚举,仅在 Status=FAIL 时有值,供前端根据 Code 精确渲染提示与操作指引
枚举值:
详细描述;Skipped 时给出跳过原因;Pass 时可为空
*/ Message?: string; /** *域名归属权验证指引信息,仅在所有权校验未通过时有值
*/ OwnershipVerification?: OwnershipVerificationInfo; } /** * RunSql请求参数结构体 */ export interface RunSqlRequest { /** * 要执行的SQL语句 */ Sql: string; /** * 云开发环境ID */ EnvId: string; /** * 数据库连接器实例信息 */ DbInstance?: DbInstance; /** * 是否只读;当 `true` 时仅允许以 `SELECT/WITH/SHOW/DESCRIBE/DESC/EXPLAIN` 开头的 SQL */ ReadOnly?: boolean; } /** * DescribeEnvPlans返回参数结构体 */ export interface DescribeEnvPlansResponse { /** *云开发新套餐详情
*/ PlanList?: Array前置校验总开关。所有启用的检查项均为 PASS 或 SKIPPED 时为 true,任一检查项为 FAIL 时为 false。当为 false 时,前端应根据各 CheckItem 的 Code 精确渲染错误提示和操作指引;当为 true 时可继续调用 CreateHTTPServiceRoute 完成创建。 示例值:false
*/ Passed?: boolean; /** *域名归属权校验结果
*/ Ownership?: VerifyHTTPServiceRouteCheckItem; /** *证书校验结果;CertId 为空时 Status=SKIPPED
*/ Cert?: VerifyHTTPServiceRouteCheckItem; /** *域名/路径数量配额校验结果
*/ Quota?: VerifyHTTPServiceRouteCheckItem; /** *同域名下路由路径冲突校验结果
*/ RouteConflict?: VerifyHTTPServiceRouteCheckItem; /** *域名被其他环境占用校验结果
*/ DomainConflict?: VerifyHTTPServiceRouteCheckItem; /** *内部域名且非内部账号校验结果
*/ InternalAccount?: VerifyHTTPServiceRouteCheckItem; /** *域名黑名单校验结果
*/ Blacklist?: VerifyHTTPServiceRouteCheckItem; /** *AccessType=CDN 时 CDN 资源存在性 / 状态校验结果(含 ICP 未备案的提示)
*/ CDNResource?: VerifyHTTPServiceRouteCheckItem; /** *AccessType=EO 时的 EdgeOne 预检结果(域名冲突/备案/归属权)
*/ EO?: VerifyHTTPServiceRouteCheckItem; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * 多语言文字,在 Locale 中 展示的 Message */ export interface MessageLocalized { /** * 字符串 */ Message: string; /** * 在该语言中 */ Locale: string; } /** * DescribeCloudAppVersion请求参数结构体 */ export interface DescribeCloudAppVersionRequest { /** *环境ID
*/ EnvId: string; /** *服务名
*/ ServiceName: string; /** *部署类型
*/ DeployType: string; /** *版本名
*/ VersionName?: string; /** *构建id
*/ BuildId?: string; } /** * 域名归属权验证指引DNS验证信息 */ export interface OwnershipVerificationDnsInfo { /** *归属权校验dns子域名
*/ Subdomain?: string; /** *归属权校验dns记录类型
*/ RecordType?: string; /** *归属权校验dns记录值
*/ RecordValue?: string; } /** * 云函数短信通道配置。适用于第三方短信服务商场景:用户在环境下部署名为 SendVerificationCode 的云函数,平台在发送验证码时调用该函数,函数体内由用户自行调用任意短信服务商 SDK 完成下发。 */ export interface SMSCloudFunctionConfig { /** *发送验证码的云函数名,当前仅支持 SendVerificationCode。
函数入参:
函数返回值:
指标名称
*/ MetricName?: string; /** *资源类型
*/ ResourceType?: string; /** *原始资源用量
*/ Value?: number; /** *资源点用量
*/ CreditsValue?: number; /** *计费周期类型,取值为hourly/daily
*/ BillingCycleType?: string; /** *原始资源用量单位
*/ Unit?: string; /** *原始资源用量明细
*/ ValueDetailList?: Array资源点套餐内用量
*/ DeductValue?: number; /** *资源点资源包用量
*/ PackageDeductValue?: number; /** *资源点按量用量
*/ ReportValue?: number; } /** * DescribeCloudBaseRunBuildLog返回参数结构体 */ export interface DescribeCloudBaseRunBuildLogResponse { /** * 日志 注意:此字段可能返回 null,表示取不到有效值。 */ Log?: CloudBaseRunBuildLog; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * DescribeDatabaseACL请求参数结构体 */ export interface DescribeDatabaseACLRequest { /** * 环境ID */ EnvId: string; /** * 集合名称 */ CollectionName: string; } /** * DescribeCreditsUsage返回参数结构体 */ export interface DescribeCreditsUsageResponse { /** *资源点套餐内用量
*/ DeductValue?: number; /** *资源点资源包用量
*/ PackageDeductValue?: number; /** *资源点按量用量
*/ ReportValue?: number; /** *历史周期资源点用量
*/ HistoryDeducted?: number; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * DescribeDatabaseACL返回参数结构体 */ export interface DescribeDatabaseACLResponse { /** * 权限标签。包含以下取值:任务ID
可通过DescribeTaskResult 接口查询进度
*/ TaskId?: string; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * BindStorageSource返回参数结构体 */ export interface BindStorageSourceResponse { /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * 模块内资源点用量及原始用量数据结构 */ export interface EnvPkgCreditsUsage { /** *环境id
*/ EnvId?: string; /** *模块
*/ Module?: string; /** *module总资源点用量
*/ CreditsValue?: number; /** *指标用量明细
*/ MetricUsageDetail?: Array资源点套餐内用量
*/ DeductValue?: number; /** *资源点资源包用量
*/ PackageDeductValue?: number; /** *资源点按量用量
*/ ReportValue?: number; } /** * ModifyEnv请求参数结构体 */ export interface ModifyEnvRequest { /** *环境ID
*/ EnvId: string; /** *环境备注名,要以a-z开头,不能包含 a-zA-z0-9- 以外的字符
*/ Alias?: string; /** *按量计费QPS上限,大于套餐配额时生效。-1表示关闭QPS按量计费。
*/ CustomQps?: number; } /** * DescribeManagedAIModelList请求参数结构体 */ export interface DescribeManagedAIModelListRequest { /** *环境id
*/ EnvId: string; } /** * AI模型密钥信息 */ export interface AIModelSecret { /** * 密钥来源 */ SecretSource?: string; /** * 密钥ID, 和SecretKey一一对应 */ SecretId?: string; /** * 密钥Key, 和SecretId一一对应 */ SecretKey?: string; /** * ApiKey,SecretKey和ApiKey二选一 */ ApiKey?: string; } /** * 创建或修改HTTP访问服务输入的路由信息,修改HTTP访问服务路由信息时对应字段不传参数表示不用修改。 */ export interface HTTPServiceRouteParam { /** *路径
*/ Path: string; /** *上游服务类型。创建时必填,修改时可选填
枚举值:
上游服务名。创建时必填,修改时可选填。HTTPServiceRouteServiceType类型为STATIC_STORE时,可不填,默认staticstore;HTTPServiceRouteServiceType类型为STORAGE时,可不填,默认storage。其他上游类型必须填写准确的服务名
*/ UpstreamResourceName?: string; /** *路径重写
*/ PathRewrite?: HTTPServicePathRewrite; /** *是否开启安全域名。默认开启
*/ EnableSafeDomain?: boolean; /** *是否开启身份认证。默认关闭
*/ EnableAuth?: boolean; /** *是否开启路径透传。默认关闭
*/ EnablePathTransmission?: boolean; /** *QPS限频策略
*/ QPSPolicy?: HTTPServiceRouteQPSPolicy; /** *是否开启路由
*/ Enable?: boolean; /** *扩展字段,内部包含headers处理等
*/ Extension?: HTTPServiceExtension; } /** * 索引信息 */ export interface IndexInfo { /** * 索引名称 注意:此字段可能返回 null,表示取不到有效值。 */ Name?: string; /** * 索引大小,单位: 字节 注意:此字段可能返回 null,表示取不到有效值。 */ Size?: number; /** * 索引键值 注意:此字段可能返回 null,表示取不到有效值。 */ Keys?: Array模型分组
枚举值:
模型列表
注意:此字段可能返回 null,表示取不到有效值。 */ Models?: Array模型类型
枚举值:
原始模型类型
枚举值:
备注
*/ Remark?: string; /** *模型地址
*/ BaseUrl?: string; /** *模型状态, 1: 开启, 2: 关闭
*/ Status?: number; /** *模型密钥
注意:此字段可能返回 null,表示取不到有效值。 */ Secret?: AIModelSecret; /** *创建时间
*/ CreateTime?: string; /** *更新时间
*/ UpdateTime?: string; } /** * ModifyLoginConfig返回参数结构体 */ export interface ModifyLoginConfigResponse { /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * DescribeCloudAppVersionList请求参数结构体 */ export interface DescribeCloudAppVersionListRequest { /** *环境ID
*/ EnvId: string; /** *部署类型
*/ DeployType: string; /** *服务名
*/ ServiceName: string; /** *页大小
*/ PageSize?: number; /** *页号
*/ PageNo?: number; } /** * CreateApiKey请求参数结构体 */ export interface CreateApiKeyRequest { /** * 环境 ID,用于标识该密钥归属的云开发环境,不同环境之间的数据相互隔离 */ EnvId: string; /** * 密钥类型。可选值:api_key(服务端调用使用的 API 密钥,具有完整权限,请勿暴露在客户端)、publish_key(客户端使用的公开密钥,权限受限,可安全用于前端或移动端)。 */ KeyType: string; /** * 密钥的自定义名称,用于在管理列表中标识和区分不同的密钥,建议填写能体现用途或归属的描述性名称,例如:server-prod、mobile-test */ KeyName?: string; /** * 密钥的有效期,单位为秒,最短不得低于 7200 秒。超过有效期后密钥将自动失效。不设置或设置为 0 则表示永不过期,建议根据安全需求合理设置有效期 */ ExpireIn?: number; }