/** * DescribeCloudAppCosInfo请求参数结构体 */ export interface DescribeCloudAppCosInfoRequest { /** * 环境id */ EnvId: string; /** * 服务名 */ ServiceName: string; /** * 部署类型 */ DeployType: string; /** * 时间戳 */ UnixTimestamp?: string; /** * 文件后缀 */ Suffix?: string; /** * 是否需要下载 */ NeedDownload?: boolean; } /** * DeleteProvider返回参数结构体 */ export interface DeleteProviderResponse { /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * 数据库连接器实例信息 */ export interface DbInstance { /** * 云开发环境ID */ EnvId?: string; /** * MySQL 连接器实例 ID;`"default"` 或为空表示使用 TCB 环境的默认连接器 */ InstanceId?: string; /** * 数据库名;为空时使用连接器配置的默认数据库名 */ Schema?: string; } /** * DescribeEnvLimit请求参数结构体 */ export type DescribeEnvLimitRequest = null; /** * 构建步骤 */ export interface BuildStep { /** *
步骤名(建议 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; } /** * DescribeTables返回参数结构体 */ export interface DescribeTablesResponse { /** * 表信息 注意:此字段可能返回 null,表示取不到有效值。 */ Tables?: Array自定义描述,最多 128 字节
*/ Description?: string; /** *规则开关:nil/true 启用,false 禁用
*/ Enable?: boolean; /** *HTTPService 规则匹配条件(必填)
*/ Condition?: HTTPServiceRuleCondition; /** *HTTPService 缓存动作列表,同一规则内相同 Type 至多一个
*/ Actions?: Array环境ID
*/ EnvId: string; /** *域名路由信息
*/ Domain: HTTPServiceDomainParam; } /** * CreatePlatformEnv请求参数结构体 */ export interface CreatePlatformEnvRequest { /** *环境别名
*/ Alias: string; /** *套餐池标识
*/ PlatformId: string; /** *幂等键
*/ ReqKey: string; } /** * UnbindStorageSource返回参数结构体 */ export interface UnbindStorageSourceResponse { /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * Agent 创建云函数镜像配置 */ export interface AgentRuntimeCodeImageConfig { /** * 镜像仓库类型,个人版或者企业版:personal/enterprise */ ImageType: string; /** * {domain}/{namespace}/{imageName}:{tag}@{digest} */ ImageUri: string; /** * 用于企业版TCR获取镜像拉取临时凭证,ImageType为"enterprise"时必填 */ RegistryId?: string; /** * 容器的启动命令。该参数为可选参数,如果不填写,则默认使用 Dockerfile 中的 Entrypoint。传入规范,填写可运行的指令,例如 python */ Command?: string; /** * 容器的启动参数。该参数为可选参数,如果不填写,则默认使用 Dockerfile 中的 CMD。传入规范,以“空格”作为参数的分割标识,例如 -u app.py */ Args?: string; /** * 镜像加速开关,默认False */ ContainerImageAccelerate?: boolean; } /** * ModifyDatabaseACL请求参数结构体 */ export interface ModifyDatabaseACLRequest { /** * 环境ID */ EnvId: string; /** * 集合名称 */ CollectionName: string; /** * 权限标签。包含以下取值:归属权校验文件路径
*/ Path?: string; /** *归属权校验文件内容
*/ Content?: string; } /** * MySql 任务状态 */ export interface MySQLTaskStatus { /** * SUCCESS | FAILED | PENDING */ Status?: string; /** * 状态描述 */ StatusDesc?: string; } /** * DescribePlatformEnvUsage返回参数结构体 */ export interface DescribePlatformEnvUsageResponse { /** *资源用量信息
*/ Resources?: Array资源点
*/ TotalCredits?: number; /** *资源点取整倍数
*/ CreditsScale?: number; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * 云开发新套餐详情 */ export interface BaasPackageInfo { /** * DAU产品套餐ID */ PackageName?: string; /** * DAU套餐中文名称 */ PackageTitle?: string; /** * 套餐分组 */ GroupName?: string; /** * 套餐分组中文名 */ GroupTitle?: string; /** * json格式化计费标签,例如: {"pid":2, "cids":{"create": 2, "renew": 2, "modify": 2}, "productCode":"p_tcb_mp", "subProductCode":"sp_tcb_mp_cloudbase_dau"} */ BillTags?: string; /** * json格式化用户资源限制,例如: {"Qps":1000,"InvokeNum":{"TimeUnit":"m", "Unit":"万次", "MaxSize": 100},"Capacity":{"TimeUnit":"m", "Unit":"GB", "MaxSize": 100}, "Cdn":{"Flux":{"TimeUnit":"m", "Unit":"GB", "MaxSize": 100}, "BackFlux":{"TimeUnit":"m", "Unit":"GB", "MaxSize": 100}},"Scf":{"Concurrency":1000,"OutFlux":{"TimeUnit":"m", "Unit":"GB", "MaxSize": 100},"MemoryUse":{"TimeUnit":"m", "Unit":"WGBS", "MaxSize": 100000}}} */ ResourceLimit?: string; /** * json格式化高级限制,例如: {"CMSEnable":false,"ProvisionedConcurrencyMem":512000, "PictureProcessing":false, "SecurityAudit":false, "RealTimePush":false, "TemplateMessageBatchPush":false, "Payment":false} */ AdvanceLimit?: string; /** * 套餐描述 */ PackageDescription?: string; /** * 是否对外展示 */ IsExternal?: boolean; } /** * DescribeHTTPServiceRoute返回参数结构体 */ export interface DescribeHTTPServiceRouteResponse { /** * 域名路由信息列表 */ Domains?: Array环境Id
*/ EnvId: string; /** *函数名
*/ FunctionName?: string; /** *函数的版本
*/ Qualifier?: string; /** *环境
*/ Namespace?: string; /** *是否返回代码
*/ ShowCode?: string; } /** * ModifyPlatformEnv返回参数结构体 */ export interface ModifyPlatformEnvResponse { /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * RunCommands返回参数结构体 */ export interface RunCommandsResponse { /** * 返回结果,返回结果为一个json字符串 注意:此字段可能返回 null,表示取不到有效值。 */ Data?: Array创建的函数名称
*/ FunctionName: string; /** *环境ID
*/ EnvId: string; /** *函数处理方法名称
*/ Handler?: string; /** *函数所属命名空间
*/ Namespace?: string; /** *在线依赖安装
*/ InstallDependency?: string; /** *在更新时是否同步发布新版本,默认为:FALSE,不发布 示例值:FALSE
*/ Publish?: string; /** *包含函数代码文件的zip格式文件
*/ Code?: CodeReq; /** *代码来源方式,支持 ZipFile, Cos, Inline 之一 示例值:Cos
*/ CodeSource?: string; } /** * CreateAuthDomain返回参数结构体 */ export interface CreateAuthDomainResponse { /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * 状态原因描述 */ export interface StatusReason { /** *错误码
*/ ErrorCode?: string; /** *错误描述
*/ ErrorMessage?: string; } /** * 部署服务信息 */ export interface CloudAppServiceItem { /** * 服务名 */ ServiceName?: string; /** * 框架名 */ Framework?: string; /** * 域名 */ Domain?: string; /** * 应用路径 */ AppPath?: string; /** * 服务创建时间 */ CreateTime?: string; /** * 最新版本名 */ LatestVersionName?: string; /** * 最新版本状态 */ LatestStatus?: string; /** * 最新版本构建时间 */ LatestBuildTime?: string; /** * 部署类型 */ DeployType?: string; } /** * DestroyMySQL返回参数结构体 */ export interface DestroyMySQLResponse { /** * 销毁结果 */ Data?: DestroyMySQLResult; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * ModifyProvider返回参数结构体 */ export interface ModifyProviderResponse { /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * CreateAIModel返回参数结构体 */ export interface CreateAIModelResponse { /** *创建数量
*/ Count?: number; /** * 唯一请求 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; } /** * DeleteUsers返回参数结构体 */ export interface DeleteUsersResponse { /** * 删除用户结果 */ Data?: DeleteUsersResp; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * 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; } /** * 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; } /** * 环境信息 */ 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套餐标识
*/ PackageId?: string; /** *套餐中文名称
*/ PackageTitle?: string; /** *套餐描述
*/ PackageDescription?: string; /** *单位原价
*/ UnitPrice?: string; /** *套餐类型
*/ PackageType?: string; /** *json格式化用户资源限制
*/ ResourceLimit?: string; } /** * DestroyMySQL请求参数结构体 */ export interface DestroyMySQLRequest { /** * 云开发环境ID */ EnvId: string; } /** * 云函数短信通道配置。适用于第三方短信服务商场景:用户在环境下部署名为 SendVerificationCode 的云函数,平台在发送验证码时调用该函数,函数体内由用户自行调用任意短信服务商 SDK 完成下发。 */ export interface SMSCloudFunctionConfig { /** *发送验证码的云函数名,当前仅支持 SendVerificationCode。
函数入参:
函数返回值:
时间
*/ CalcTime?: string; /** *原始资源用量
*/ RawValue?: number; /** *资源点用量
*/ CreditsValue?: number; /** *资源点套餐内用量
*/ DeductValue?: number; /** *资源点资源包用量
*/ PackageDeductValue?: number; /** *资源点按量用量
*/ ReportValue?: number; } /** * CreateAuthDomain请求参数结构体 */ export interface CreateAuthDomainRequest { /** * 环境ID */ EnvId: string; /** * 安全域名 */ Domains: Array创建的函数名称
*/ FunctionName: string; /** *环境ID
*/ EnvId: string; /** *函数处理方法名称
*/ Handler?: string; /** *函数运行时内存大小
*/ MemorySize?: number; /** *函数最长执行时间
*/ Timeout?: number; /** *此参数公司内部展示。是否使用GPU进行计算
*/ UseGpu?: string; /** *在线依赖安装
*/ InstallDependency?: string; /** *此参数公司内部展示。用于小程序,GPU集群,不对外
*/ Stamp?: string; /** *函数绑定的角色
*/ Role?: string; /** *函数描述
*/ Description?: string; /** *函数运行环境
*/ Runtime?: string; /** *函数日志投递到的CLS TopicID
*/ ClsTopicId?: string; /** *函数日志投递到的CLS LogsetID
*/ ClsLogsetId?: string; /** *包含函数代码文件的zip格式文件
*/ Code?: CodeReq; /** *云函数配置项
*/ PrivateConfig?: PrivateConfig; /** *函数类型,默认值为Event,创建触发器函数请填写Event,创建HTTP函数级服务请填写HTTP
*/ Type?: string; /** *HTTP函数支持的访问协议。当前支持WebSockets协议,值为WS
*/ ProtocolType?: string; /** *环境变量
*/ Environment?: FunctionEnvironment; /** *函数初始化超时时间,默认 65s,镜像部署函数默认 90s。
*/ InitTimeout?: number; /** *代码来源,支持ZipFile, Cos, Demo 其中之一
*/ CodeSource?: string; /** *函数的私有网络配置
*/ VpcConfig?: FunctionVpcConfig; /** *函数要关联的Layer版本列表,Layer会按照在列表中顺序依次覆盖。
*/ Layers?: Array公网访问配置
*/ PublicNetConfig?: FunctionPublicNetConfig; /** *是否开启异步属性,TRUE 为开启,FALSE为关闭
*/ AsyncRunEnable?: string; /** *是否开启事件追踪,TRUE 为开启,FALSE为关闭
*/ TraceEnable?: string; /** *是否自动创建cls主题,TRUE 为开启,FALSE为关闭
*/ AutoCreateClsTopic?: string; /** *是否自动创建cls索引,TRUE 为开启,FALSE为关闭
*/ AutoDeployClsTopicIndex?: string; /** *是否开启Dns缓存能力。只支持EVENT函数。默认为FALSE,TRUE 为开启,FALSE为关闭
*/ DnsCache?: string; /** *EipConfig固定ip配置
*/ EipConfig?: FunctionEipConfigFixed; } /** * CreateStaticStore返回参数结构体 */ export interface CreateStaticStoreResponse { /** * 创建静态资源结果(succ/fail) */ Result?: string; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * DeleteCloudApp请求参数结构体 */ export interface DeleteCloudAppRequest { /** * 环境ID */ EnvId: string; /** * 部署类型 */ DeployType: string; /** * 服务名 */ ServiceName: string; } /** * 步骤构建执行状态 */ export interface BuildStepStatus { /** *构建步骤名称
*/ Name?: string; /** *构建状态
*/ Status?: string; /** *构建耗时
*/ Duration?: string; } /** * 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; } /** * ModifyPGInstanceSpec请求参数结构体 */ export interface ModifyPGInstanceSpecRequest { /** *环境 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; } /** * 安全网关自定义日志配置 */ export interface CustomLogConfig { /** * 是否需要请求体 */ NeedReqBodyLog?: boolean; /** * 是否需要请求头 */ NeedReqHeaderLog?: boolean; /** * 是否需要回包体 */ NeedRspBodyLog?: boolean; /** * 是否需要回包头部信息 */ NeedRspHeaderLog?: boolean; /** * cls set信息 */ LogSetId?: string; /** * cls topicId */ LogTopicId?: string; } /** * DescribeApiKeyList请求参数结构体 */ export interface DescribeApiKeyListRequest { /** * 环境 ID,用于标识该密钥归属的云开发环境,不同环境之间的数据相互隔离 */ EnvId: string; /** * 分页查询的页码,从 1 开始。与 PageSize 配合使用,不传则默认返回第 1 页 */ PageNumber?: number; /** * 分页查询每页返回的记录条数。与 PageNumber 配合使用,不传则使用系统默认值 */ PageSize?: number; /** * 密钥类型过滤条件。可选值:api_key(服务端调用使用的 API 密钥,具有完整权限)、publish_key(客户端使用的公开密钥,权限受限)密钥类型过滤条件。不传默认值为api_key */ KeyType?: string; } /** * 本类型用于UpdateTable接口中描述待创建索引信息 */ export interface MgoIndexKeys { /** * 无 */ Name?: string; /** * 无 */ Direction?: string; } /** * DescribeStaticStore请求参数结构体 */ export interface DescribeStaticStoreRequest { /** * 环境ID */ EnvId: string; } /** * 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; } /** * 待执行命令 */ export interface MgoCommandParam { /** * 表名 */ TableName: string; /** * 操作类型,可选类型为:UPDATE/QUERY/INSERT/DELETE/COMMAND,本操作必须按实际填写,监控会依赖该字段统计本次操作的类型,并实时减少用户配额,如果填写错误会误扣用户请求配额 */ CommandType: string; /** * 待执行命令 */ Command: string; } /** * CreateTable返回参数结构体 */ export interface CreateTableResponse { /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: 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; } /** * PreviewPGUserMigrations请求参数结构体 */ export interface PreviewPGUserMigrationsRequest { /** *云开发环境ID
*/ EnvId: string; /** *预览要执行的migration 列表
*/ Migrations: Array标记请求来源
deprecated
*/ Source?: string; /** *是否允许 out-of-order local migrations
默认值:false
*/ IncludeAll?: boolean; } /** * 数据库资源信息 */ export interface DatabasesInfo { /** * 数据库唯一标识 */ InstanceId?: string; /** * 状态。包含以下取值:函数最后修改时间
*/ ModTime?: string; /** *函数代码(>1M 不返回)
*/ CodeInfo?: string; /** *函数描述
*/ Description?: string; /** *触发器列表
注意:此字段可能返回 null,表示取不到有效值。 */ Triggers?: Array入口函数
*/ Handler?: string; /** *代码大小(字节)
*/ CodeSize?: number; /** *超时时间(秒)
*/ Timeout?: number; /** *函数版本
*/ FunctionVersion?: string; /** *内存大小(MB)
*/ MemorySize?: number; /** *运行环境
*/ Runtime?: string; /** *函数名称
*/ FunctionName?: string; /** *VPC 配置
注意:此字段可能返回 null,表示取不到有效值。 */ VpcConfig?: FunctionVpcConfig; /** *是否使用 GPU ("TRUE"/"FALSE")
*/ UseGpu?: string; /** *代码校验结果 ("success"/"failed")
*/ CodeResult?: string; /** *代码错误码
*/ ErrNo?: number; /** *命名空间
*/ Namespace?: string; /** *角色
*/ Role?: string; /** *是否自动安装依赖 ("TRUE"/"FALSE")
*/ InstallDependency?: string; /** *函数状态 ("Active", "Inactive" 等)
*/ Status?: string; /** *函数 ID
*/ FunctionId?: string; /** *标签列表
注意:此字段可能返回 null,表示取不到有效值。 */ Tags?: Array函数类型 ("HTTP" 或 "Event")
*/ Type?: string; /** *是否启用 L5 ("TRUE"/"FALSE")
*/ L5Enable?: string; /** *函数创建时间
*/ AddTime?: string; /** *对应scf.GetFunction接口的OnsEnable,是否启用 Ons ("TRUE"/"FALSE")
*/ OnsEnable?: string; /** *计费状态 ("Available" 等)
*/ AvailableStatus?: string; /** *函数版本(查询时传入的)
*/ Qualifier?: string; /** *初始化超时时间(秒)
*/ InitTimeout?: number; /** *是否开启异步 ("TRUE"/"FALSE")
*/ AsyncRunEnable?: string; /** *是否开启事件追踪 ("TRUE"/"FALSE")
*/ TraceEnable?: string; /** *镜像配置
注意:此字段可能返回 null,表示取不到有效值。 */ ImageConfig?: AgentRuntimeCodeImageConfig; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * DescribeDatabaseACL请求参数结构体 */ export interface DescribeDatabaseACLRequest { /** * 环境ID */ EnvId: string; /** * 集合名称 */ CollectionName: string; } /** * VerifyHTTPServiceRoute返回参数结构体 */ export interface VerifyHTTPServiceRouteResponse { /** *前置校验总开关。所有启用的检查项均为 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; } /** * AssumeRoleForAllocatedEnv请求参数结构体 */ export interface AssumeRoleForAllocatedEnvRequest { /** *环境ID
*/ EnvId: string; } /** * DescribeTables请求参数结构体 */ export interface DescribeTablesRequest { /** * 分页条件 */ MgoLimit: number; /** * 实例ID */ Tag?: string; /** * 分页条件 */ MgoOffset?: number; /** * 环境id */ EnvId?: string; /** * MongoConnector */ MongoConnector?: MongoConnector; /** * 指定表名过滤,为空时返回所有表 */ TableNames?: 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。
HTTPService 缓存动作类型
枚举值:
节点缓存配置。Type=Cache 时必填
*/ Cache?: HTTPServiceCacheParams; /** *自定义缓存键。Type=CacheKey 时必填
*/ CacheKey?: HTTPServiceCacheKeyParams; } /** * 登录短信验证码发送配置。用于管理登录时使用的短信验证码发送的通道相关设置,目前提供云开发默认短信包和客户自定义短信包,自定义短信包可以通过自定义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; } /** * StorageInfo 资源信息 */ export interface StorageInfo { /** *资源所属地域。
当前支持ap-shanghai
桶名,存储资源的唯一标识
*/ Bucket?: string; /** *cdn 域名
*/ CdnDomain?: string; /** *资源所属用户的腾讯云appId
*/ AppId?: string; /** *外部存储介质相关信息。
*/ ExternalStorage?: ExternalStorage; } /** * 修改用户返回值 */ export interface ModifyUserResp { /** * 是否成功 */ Success?: boolean; } /** * DescribeTable请求参数结构体 */ export interface DescribeTableRequest { /** * 表名 */ TableName: string; /** * FlecDB实例ID */ Tag?: string; /** * 云开发环境ID */ EnvId?: string; /** * MongoDB连接器配置 */ MongoConnector?: MongoConnector; } /** * DescribeCloudAppCosInfo返回参数结构体 */ export interface DescribeCloudAppCosInfoResponse { /** * 上传url */ UploadUrl?: string; /** * 上传header */ UploadHeaders?: Array资源点套餐内用量总和
*/ DeductValueCount?: number; /** *资源点资源包用量总和
*/ PackageDeductValueCount?: number; /** *资源点按量用量总和
*/ ReportValueCount?: number; /** *每日消耗具体数据
*/ DailyList?: Array环境ID
*/ EnvId: string; /** *HTTPService域名
*/ Domain: string; /** *缓存类型
枚举值:
默认值:EO
*/ CacheType?: string; /** *任务id,PurgeHTTPServiceCache返回的TaskId,可选
*/ TaskId?: string; /** *按刷新类型过滤
枚举值:
查询开始时间,TaskId为空时,默认开始时间是7天前
参数格式:格式 YYYY-MM-DDTHH:mm:ss±HH:mmZ,时区为 UTC+0
*/ StartTime?: string; /** *查询结束时间,TaskId为空时,默认结束时间是当前
参数格式:格式 YYYY-MM-DDTHH:mm:ss±HH:mmZ,时区为 UTC+0
*/ EndTime?: string; /** *分页偏移量。默认 0
*/ Offset?: number; /** *分页限制。默认20,最大值1000
*/ Limit?: number; } /** * CreateCustomLoginKey返回参数结构体 */ export interface CreateCustomLoginKeyResponse { /** * 自定义登录的 RSA 私钥(1024 位),PEM 编码格式(PKCS#1)。调用方需使用该私钥对包含用户身份信息的 JSON 数据进行 JWS 签名,生成 JWT Token 后传入自定义登录接口完成身份认证。出于安全考虑,系统仅存储公钥,私钥仅在创建时返回一次且无法恢复,请妥善保存。创建新密钥后,该环境下原有未设置过期时间的旧密钥将被自动标记为 2 小时后过期 */ PrivateKey?: string; /** * 密钥对的唯一标识符(UUID 格式),由系统自动生成。在自定义登录时,需将该 KeyID 拼接到 ProviderToken 参数中(格式:{KeyID}/{algorithm}/{signedJWT}),服务端通过 KeyID 查找对应的公钥以验证签名 */ KeyID?: string; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * ModifyClient请求参数结构体 */ export interface ModifyClientRequest { /** * 客户端所属的云开发环境 ID,用于标识该应用归属的云开发环境。不同环境之间的应用数据相互隔离。 */ EnvId: string; /** * 需要修改的客户端唯一标识符(Client ID),在 OAuth/OIDC 授权流程中作为 client_id 参数使用。该字段为定位参数,仅用于指定目标客户端,不可修改。 */ Id: string; /** * Refresh Token 的有效期,单位为秒。超过该时间后 Refresh Token 将失效,用户需重新登录。取值范围:1800~2592000(即 30 分钟至 30 天),超出上限将被截断为 2592000。默认值为 2592000(即 30 天)。注意:当该值 ≤ 7200 时,AccessTokenExpiresIn 将被自动设为该值减去 660 秒。 */ RefreshTokenExpiresIn?: number; /** * 单个用户在该应用下允许同时登录的最大会话数量。取值范围:-1~50。特殊值说明:-1 表示不限制设备数;0 表示按客户端 User-Agent 区分设备(相同 User-Agent 视为同一设备);1~50 为精确的最大会话数限制,超出限制后最早登录的会话将被自动踢出。不传则保持原有配置不变。 */ MaxDevice?: number; /** * Access Token 的有效期,单位为秒。超过该时间后 Access Token 将失效,需使用 Refresh Token 重新换取。最小有效值为 1800 秒(小于 1800 将被忽略,使用默认值),默认值为 7200(即 2 小时)。该值应小于 RefreshTokenExpiresIn。 */ AccessTokenExpiresIn?: number; } /** * 云函数公网访问固定ip配置 */ export interface FunctionEipConfig { /** * Eip开启状态,取值['ENABLE','DISABLE'] 注意:此字段可能返回 null,表示取不到有效值。 */ EipStatus?: string; } /** * CheckTcbService请求参数结构体 */ export type CheckTcbServiceRequest = null; /** * DescribeManagedAIModelList返回参数结构体 */ export interface DescribeManagedAIModelListResponse { /** *托管模型列表
注意:此字段可能返回 null,表示取不到有效值。 */ ManagedAIModelList?: Array函数的名称
*/ FunctionName: string; /** *环境ID
*/ EnvId: string; /** *函数的版本
*/ Qualifier?: string; } /** * BindStorageSource返回参数结构体 */ export interface BindStorageSourceResponse { /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * ModifyEnv请求参数结构体 */ export interface ModifyEnvRequest { /** *环境ID
*/ EnvId: string; /** *环境备注名
入参限制:最大长度为32
*/ Alias?: string; /** *按量计费QPS上限,大于套餐配额时生效。-1表示关闭QPS按量计费。
*/ CustomQps?: number; } /** * 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; } /** * 创建用户返回结果 */ export interface CreateUserResp { /** * 用户ID */ Uid?: string; } /** * UpdateFunctionCode返回参数结构体 */ export interface UpdateFunctionCodeResponse { /** *调用scf返回的错误码
*/ SCFErrorCode?: string; /** *错误码对应的描述信息
*/ SCFErrorMsg?: string; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * ModifyLoginConfig返回参数结构体 */ export interface ModifyLoginConfigResponse { /** * 唯一请求 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; } /** * CheckTcbService返回参数结构体 */ export interface CheckTcbServiceResponse { /** * true表示已开通 */ Initialized?: boolean; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * DeleteCloudAppVersion返回参数结构体 */ export interface DeleteCloudAppVersionResponse { /** * 是否删除成功 */ Result?: boolean; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * DescribeCloudBaseRunServerVersion请求参数结构体 */ export interface DescribeCloudBaseRunServerVersionRequest { /** * 环境ID */ EnvId: string; /** * 服务名称 */ ServerName: string; /** * 版本名称 */ VersionName: string; } /** * ModifyEnvPlan请求参数结构体 */ export interface ModifyEnvPlanRequest { /** * 所需变更套餐的环境ID */ EnvId: string; /** * 目标套餐Id。 对于云开发环境套餐,可通过 [DescribeBaasPackageList](https://cloud.tencent.com/document/product/876/78167) 接口获取,对应其出参的PackageName */ PackageId: string; /** * 是否自动选择代金券支付。 */ AutoVoucher?: boolean; } /** * HTTPService缓存规则匹配条件(必填) */ export interface HTTPServiceRuleCondition { /** *Target 匹配对象
枚举值:
MatchType 字符串匹配类型
枚举值:
Values 匹配值集合,Values 内任一命中即认为条件成立(OR 语义)
入参限制:单项 1~1024 字节,最多 30 条
*/ Values?: Array版本列表
*/ VersionList?: Array总数
*/ Total?: number; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * TDSQL-C数据库详情 */ export interface ClusterDetail { /** * 是否开启公网访问 */ IsOpenPubNetAccess?: boolean; /** * 最大算力 注意:此字段可能返回 null,表示取不到有效值。 */ MaxCpu?: number; /** * 最小算力 注意:此字段可能返回 null,表示取不到有效值。 */ MinCpu?: number; /** * TDSQL-C集群状态 注意:此字段可能返回 null,表示取不到有效值。 */ Status?: string; /** * 存储用量(单位:MB) 注意:此字段可能返回 null,表示取不到有效值。 */ UsedStorage?: number; /** * 最大存储量(单位:GB) 注意:此字段可能返回 null,表示取不到有效值。 */ StorageLimit?: number; /** * 数据库类型 */ DbType?: string; /** * 数据库类型 */ DbVersion?: string; /** * 公网访问状态;open开启,opening开启中,closed关闭,closing关闭中 */ WanStatus?: string; /** * 数据库集群状态 注意:此字段可能返回 null,表示取不到有效值。 */ ClusterStatus?: string; /** * serverless状态 */ ServerlessStatus?: string; } /** * 自定义缓存键参数。约束:FullURLCache=on 与 QueryStringSwitch=on 互斥 使用示例: - 整 URL 参与缓存键:{FullURLCache: "on", QueryStringSwitch: "off"} - 整 URL 不参与缓存键:{FullURLCache: "off", QueryStringSwitch: "off"} - URL 路径 + 仅保留 x/y:{FullURLCache: "off", QueryStringSwitch: "on", QueryStringAction: "includeCustom", QueryStringValues: ["x", "y"]} - URL 路径 + 忽略 debug:{FullURLCache: "off", QueryStringSwitch: "on", QueryStringAction: "excludeCustom", QueryStringValues: ["debug"]} */ export interface HTTPServiceCacheKeyParams { /** *全 URL 缓存开关
枚举值:
查询参数是否参与缓存键
枚举值:
QueryStringSwitch=on 时必填
枚举值:
参数名列表
入参限制:最多 30 项,单项 1~128 字节
*/ QueryStringValues?: Array环境ID
*/ EnvId: string; /** *部署类型
*/ DeployType: string; /** *搜索关键字
*/ SearchKey?: string; /** *页大小
*/ PageSize?: number; /** *页号
*/ PageNo?: number; } /** * ModifyEnv返回参数结构体 */ export interface ModifyEnvResponse { /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * 云日志服务相关信息 */ export interface LogServiceInfo { /** * log名 */ LogsetName?: string; /** * log-id */ LogsetId?: string; /** * topic名 */ TopicName?: string; /** * topic-id */ TopicId?: string; /** * cls日志所属地域 */ Region?: string; /** * topic保存时长 默认7天 */ Period?: number; } /** * DescribeCloudBaseRunBuildLog请求参数结构体 */ export interface DescribeCloudBaseRunBuildLogRequest { /** * 环境ID */ EnvId?: string; /** * 服务名称 */ ServiceName?: string; /** * 版本名称 */ ServiceVersion?: string; /** * 构建ID */ BuildId?: number; /** * 偏移记录 */ Start?: number; } /** * DescribeCurveData返回参数结构体 */ export interface DescribeCurveDataResponse { /** *开始时间, 会根据数据的统计周期进行取整
*/ 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; } /** * 域名归属权验证指引DNS验证信息 */ export interface OwnershipVerificationDnsInfo { /** *归属权校验dns子域名
*/ Subdomain?: string; /** *归属权校验dns记录类型
*/ RecordType?: string; /** *归属权校验dns记录值
*/ RecordValue?: string; } /** * 网关版本详情 */ export interface GatewayVersionItem { /** * 版本名 */ VersionName: string; /** * 版本流量权重 */ Weight: number; /** * 创建状态 */ Status?: string; /** * 创建时间 */ CreatedTime?: string; /** * 更新时间 */ UpdatedTime?: string; /** * 构建ID */ BuildId?: number; /** * 备注 */ Remark?: string; /** * 优先级 */ Priority?: number; /** * 是否默认版本 */ IsDefault?: boolean; /** * 网关版本自定义配置 */ CustomConfig?: WxGatewayCustomConfig; } /** * 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; } /** * 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; } /** * ListPGUserMigrations请求参数结构体 */ export interface ListPGUserMigrationsRequest { /** *云开发环境ID
*/ EnvId: string; /** *查询条数
取值范围:[1, 500]
默认值:100
*/ Limit?: number; /** *分页偏移
默认值:0
*/ Offset?: number; } /** * 多语言模板 */ export interface LocalizedTemplate { /** *中文
注意:此字段可能返回 null,表示取不到有效值。 */ ZhCN?: string; /** *英文
注意:此字段可能返回 null,表示取不到有效值。 */ EnUS?: string; } /** * 本类型用于接口中描述待创建索引结构 */ export interface MgoKeySchema { /** *索引字段
*/ MgoIndexKeys?: Array是否唯一索引
*/ MgoIsUnique?: boolean; /** *是否稀疏索引
*/ MgoIsSparse?: boolean; /** *稀疏索引表达式
*/ PartialFilterExpression?: string; } /** * DescribeSafeRule请求参数结构体 */ export interface DescribeSafeRuleRequest { /** * 环境ID */ EnvId: string; /** * 集合名称 */ CollectionName: string; /** * 微信AppId,微信必传 */ WxAppId?: string; } /** * ModifyHTTPServiceRoute请求参数结构体 */ export interface ModifyHTTPServiceRouteRequest { /** * 环境ID */ EnvId: string; /** * 域名路由信息 */ Domain: HTTPServiceDomainParam; } /** * 身份认证源协议连接配置。包含 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; } /** * 函数的信息 */ export interface FunctionInfo { /** * 命名空间 */ Namespace?: string; /** * 所属地域。 当前支持ap-shanghai */ Region?: string; } /** * DescribeApiKeyList返回参数结构体 */ export interface DescribeApiKeyListResponse { /** * API Key列表 */ Data?: Array影响行数
*/ 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; } /** * DescribeMySQLClusterDetail请求参数结构体 */ export interface DescribeMySQLClusterDetailRequest { /** * 云开发环境ID */ EnvId: string; } /** * ModifyEnvExtra请求参数结构体 */ export interface ModifyEnvExtraRequest { /** *环境ID
*/ EnvId: string; /** *开启或关闭 超限转按量。
可取值: TRUE/FALSE (字符串类型)
非法制、不传、为空 则不变更该字段。
环境计费信息列表
*/ EnvBillingInfoList?: Array总个数
*/ Total?: number; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * DescribeEnvs请求参数结构体 */ export interface DescribeEnvsRequest { /** *环境ID,如果传了这个参数则只返回该环境的相关信息
*/ EnvId?: string; /** *指定Channels字段为可见渠道列表或不可见渠道列表
如只想获取渠道A的环境 就填写IsVisible= true,Channels = ["A"], 过滤渠道A拉取其他渠道环境时填写IsVisible= false,Channels = ["A"]
渠道列表,代表可见或不可见渠道由IsVisible参数指定
*/ Channels?: Array分页参数,单页限制个数
*/ Limit?: number; /** *分页参数,偏移量
*/ Offset?: number; } /** * 标签键值对 */ export interface Tag { /** * 标签键 */ Key: string; /** * 标签值 */ Value: string; } /** * 结构化 SQL migration 信息 */ export interface MigrationInput { /** *migration 版本号
参数格式:纯数字,14位时间格式
*/ Version: string; /** *migration 版本名
入参限制:仅允许小写字母和下划线
*/ Name: string; /** *migration 应用 sql 语句
*/ Query: string; /** *migration 回滚 sql 语句
*/ Rollback?: string; } /** * 查询资源权限返回结果 */ export interface DescribeResourcePermissionResult { /** * 查询到的资源总数 */ TotalCount?: number; /** * 资源权限列表 */ PermissionList?: Array环境ID
*/ EnvId?: string; /** *环境列表,当环境列表不为空时,查询的环境以该参数为准
*/ EnvIds?: Array每页条数(用于拉取列表时分页)
*/ Limit?: number; /** *偏移
*/ Offset?: number; } /** * 云开发路由限频策略 */ export interface HTTPServiceRouteQPSPolicy { /** * QPS值,每秒请求次数 */ QPSTotal?: number; /** * 客户端限频配置 */ QPSPerClient?: HTTPServiceQPSPerClient; } /** * BindCls返回参数结构体 */ export interface BindClsResponse { /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * 静态托管的执行命令 */ export interface StaticCmd { /** * 构建命令 */ BuildCmd?: string; /** * 安装命令 */ InstallCmd?: string; /** * 部署命令 */ DeployCmd?: string; } /** * 托管型AI 模型信息 */ export interface ManagedAIModel { /** *模型名
*/ Model?: string; /** *是否开启MCP
*/ EnableMCP?: boolean; /** *模型规格
*/ ModelSpec?: ManagedAIModelSpec; /** *模型计费信息
*/ ModelChargingInfo?: Array结果返回
*/ Data?: DescribeUserListResp; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: 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; } /** * UpdateTable请求参数结构体 */ export interface UpdateTableRequest { /** *表名
*/ TableName: string; /** *FlexDB实例ID
*/ Tag?: string; /** *待删除索引信息
*/ DropIndexes?: Array待创建索引信息
*/ CreateIndexes?: Array云开发环境ID
*/ EnvId?: string; /** *MongoDB连接器配置
*/ MongoConnector?: MongoConnector; } /** * AddProvider返回参数结构体 */ export interface AddProviderResponse { /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * HTTP访问服务路由headers处理 */ export interface HTTPServiceHeadersHandler { /** * 添加请求头列表 */ RequestHeadersToAdd?: Array路径
*/ 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; } /** * PushPGUserMigrations返回参数结构体 */ export interface PushPGUserMigrationsResponse { /** *任务ID
可通过DescribeTaskResult 接口查询进度
*/ TaskId?: string; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * 模块内平台版资源点用量及原始用量数据结构 */ export interface PlatformPkgCreditsUsage { /** *平台版套餐id
*/ PlatformId?: string; /** *模块
*/ Module?: string; /** *module总资源点用量
*/ CreditsValue?: number; /** *指标用量明细
*/ MetricUsageDetail?: Array资源点套餐内用量
*/ DeductValue?: number; /** *资源点资源包用量
*/ PackageDeductValue?: number; /** *资源点按量用量
*/ ReportValue?: number; } /** * DescribeCreateMySQLResult返回参数结构体 */ export interface DescribeCreateMySQLResultResponse { /** * 查询开通结果 */ Data?: DescribeCreateMySQLResult; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * DeleteUsers请求参数结构体 */ export interface DeleteUsersRequest { /** * 环境id */ EnvId: string; /** * tcb用户id列表, 一次最多支持删除100个 */ Uids: Array缓存类型
枚举值:
默认值:EO
*/ CacheType?: string; /** *任务id
*/ TaskId?: string; /** *状态
枚举值:
刷新类型
枚举值:
清除缓存分为直接删除和标记过期两种方式。URL 类型默认为“直接删除”,其它清除类型默认为“标记过期”
枚举值:
刷新目标列表(URL / 前缀 / host)
*/ Targets?: Array失败原因
*/ FailReason?: string; /** *任务创建时间
参数格式:格式 YYYY-MM-DDTHH:mm:ss±HH:mmZ,时区为 UTC+0
*/ CreateTime?: string; /** *任务更新时间
参数格式:格式 YYYY-MM-DDTHH:mm:ss±HH:mmZ,时区为 UTC+0
*/ UpdateTime?: string; } /** * PreviewPGUserMigrations返回参数结构体 */ export interface PreviewPGUserMigrationsResponse { /** *将要执行的migration列表
*/ Pending?: Array已经应用的migration列表
*/ Applied?: Array版本相同但 checksum 不一致冲突的migration列表
*/ Conflicts?: Array是否可直接执行;当前仅表示没有 checksum 冲突
*/ Executable?: boolean; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * 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 PasswordUpdateLoginConfig { /** * 首次登录强制修改密码开关。开启后,用户首次登录时将强制要求修改密码。 注意:此字段可能返回 null,表示取不到有效值。 */ FirstLoginUpdate?: boolean; /** * 定期强制修改密码开关。开启后,用户需按照 PeriodValue 和 PeriodType 指定的周期定期修改密码,超过周期未修改将在登录时强制要求修改。 注意:此字段可能返回 null,表示取不到有效值。 */ PeriodUpdate?: boolean; /** * 定期修改密码的周期数值,与 PeriodType 配合使用。例如 PeriodValue 为 6,PeriodType 为 MONTH,表示每 6 个月需修改一次密码。当 PeriodUpdate 为 true 时必填。 注意:此字段可能返回 null,表示取不到有效值。 */ PeriodValue?: number; /** * 定期修改密码的周期时间单位,与 PeriodValue 配合使用。取值范围: WEEK:周 MONTH:月 YEAR:年 当 PeriodUpdate 为 true 时必填。 注意:此字段可能返回 null,表示取不到有效值。 */ PeriodType?: string; } /** * CreateCloudApp返回参数结构体 */ export interface CreateCloudAppResponse { /** *构建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; } /** * 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; } /** * DeleteAIModel请求参数结构体 */ export interface DeleteAIModelRequest { /** *环境id
*/ EnvId: string; /** *分组名列表
*/ GroupNames: Array环境id
*/ EnvId: string; /** *页码,从1开始,默认1
*/ PageNo?: number; /** *每页数量,默认20,最大100
*/ PageSize?: number; /** *用户名,模糊查询
*/ Name?: string; /** *用户昵称,模糊查询
*/ NickName?: string; /** *手机号,模糊查询
*/ Phone?: string; /** *邮箱,模糊查询
*/ Email?: string; /** *用户id列表,根据id过滤用户
*/ UidList?: Array服务名称
*/ ServiceName?: string; /** *框架名称
*/ Framework?: string; /** *域名
*/ Domain?: string; /** *构建路径
*/ AppPath?: string; /** *服务创建时间
*/ CreateTime?: string; /** *最新版本名
*/ LatestVersionName?: string; /** *最新版本状态
*/ LatestStatus?: string; /** *最新版本构建时间
*/ LatestBuildTime?: string; /** *部署类型
*/ DeployType?: string; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * 环境计费信息 */ export interface EnvBillingInfoItem { /** *环境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; } /** * CreateHTTPServiceRoute返回参数结构体 */ export interface CreateHTTPServiceRouteResponse { /** *归属权校验不通过返回信息,根据校验信息配置dns或者文件验证,可通过VerifyHTTPServiceRoute接口验证归属权是否通过
*/ OwnershipVerification?: OwnershipVerificationInfo; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * 索引信息 */ export interface IndexInfo { /** * 索引名称 注意:此字段可能返回 null,表示取不到有效值。 */ Name?: string; /** * 索引大小,单位: 字节 注意:此字段可能返回 null,表示取不到有效值。 */ Size?: number; /** * 索引键值 注意:此字段可能返回 null,表示取不到有效值。 */ Keys?: Array函数列表
注意:此字段可能返回 null,表示取不到有效值。 */ Functions?: Array总数
*/ TotalCount?: number; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * 描述键值对过滤器,用于条件过滤查询。例如过滤ID、名称、状态等 */ export interface Filter { /** *需要过滤的字段。过滤条件数量限制为10。
*/ Name?: string; /** *字段的过滤值。
*/ Values?: Array环境别名。
云开发环境套餐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; } /** * 构建触发的源码来源: git,cos,inline */ export interface BuildSource { /** *源码来源类型,取值:"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; } /** * DescribePlatformAccountCircle返回参数结构体 */ export interface DescribePlatformAccountCircleResponse { /** *套餐计费周期开始时间
*/ StartTime?: string; /** *套餐计费周期结束时间
*/ EndTime?: string; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * DescribeEnvPlans返回参数结构体 */ export interface DescribeEnvPlansResponse { /** *云开发新套餐详情
*/ PlanList?: Array模块列表
枚举值:
开始日期
参数格式:YYYY-MM-DD
*/ StartDate: string; /** *结束日期
参数格式:YYYY-MM-DD
*/ EndDate: string; /** *是否需要每日用量明细
*/ NeedUsageDetails: boolean; /** *平台版套餐id
*/ PlatformId: string; } /** * DeleteProvider请求参数结构体 */ export interface DeleteProviderRequest { /** * 环境ID */ EnvId: string; /** * 认证源ID,比如:github, 格式必须为:2-32位小写英文字符串或数字 */ Id: string; } /** * DescribeCreditsUsageDetail请求参数结构体 */ export interface DescribeCreditsUsageDetailRequest { /** *模块列表
枚举值:
开始日期
*/ StartDate: string; /** *结束日期
*/ EndDate: string; /** *是否需要每日用量明细
*/ NeedUsageDetails: boolean; /** *环境id
*/ EnvId: string; } /** * 模块内资源点用量及原始用量数据结构 */ export interface EnvPkgCreditsUsage { /** *环境id
*/ EnvId?: string; /** *模块
*/ Module?: string; /** *module总资源点用量
*/ CreditsValue?: number; /** *指标用量明细
*/ MetricUsageDetail?: Array资源点套餐内用量
*/ DeductValue?: number; /** *资源点资源包用量
*/ PackageDeductValue?: number; /** *资源点按量用量
*/ ReportValue?: number; } /** * DescribeCloudAppVersionList请求参数结构体 */ export interface DescribeCloudAppVersionListRequest { /** *环境ID
*/ EnvId: string; /** *部署类型
*/ DeployType: string; /** *服务名
*/ ServiceName: string; /** *页大小
*/ PageSize?: number; /** *页号
*/ PageNo?: number; } /** * DescribeResourcePermission返回参数结构体 */ export interface DescribeResourcePermissionResponse { /** * 查询资源权限返回结果 */ Data?: DescribeResourcePermissionResult; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * 订单信息 */ export interface OrderInfo { /** * 订单号 */ TranId?: string; /** * 订单要切换的套餐ID */ PackageId?: string; /** * 订单类型短信服务商类型
枚举值:
短信服务商侧申请并审核通过的模板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; } /** * HTTP访问服务路径重写配置 */ export interface HTTPServicePathRewrite { /** * 路径前缀重写。StaticStorePrefix、Prefix只能填一个 */ Prefix?: string; } /** * base64编码后的代码块 */ export interface CodeReq { /** * 包含函数代码的zip格式文件 */ ZipFile?: string; /** * 对象存储桶名称(填写存储桶名称自定义部分,不包含-appid) */ CosBucketName?: string; /** * 对象存储中代码包文件路径,以/开头 */ CosObjectName?: string; /** * 对象存储的地域,地域为北京时需要传入ap-beijing,北京一区时需要传递ap-beijing-1,其他的地域不需要传递。 */ CosBucketRegion?: string; /** * 如果是从TempCos创建的话,需要传入TempCosObjectName */ TempCosObjectName?: string; /** * 如果是通过Demo创建的话,需要传入DemoId */ DemoId?: string; /** * 上传云开发cos后返回的时间戳 */ CosTimestamp?: string; } /** * 删除tcb用户返回值 */ export interface DeleteUsersResp { /** * 成功个数 */ SuccessCount?: number; /** * 失败个数 */ FailedCount?: number; } /** * 构建命令 */ export interface BuildCommands { /** *平台生成默认 install step 时执行
*/ InstallCmd?: string; /** *平台生成默认build step 时执行
*/ BuildCmd?: string; /** *平台生成默认deploy step 时执行
*/ DeployCmd?: string; } /** * 本类型用于UpdateTable接口中描述待删除索引信息 */ export interface DropIndex { /** * 索引名称 */ IndexName?: string; } /** * AllocateEnv返回参数结构体 */ export interface AllocateEnvResponse { /** *环境ID
*/ EnvId?: string; /** *回显 客户平台的应用标识,如果没有则不传
*/ ExternalAppId?: string; /** * 唯一请求 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; } /** * UpdateFunctionConfiguration返回参数结构体 */ export interface UpdateFunctionConfigurationResponse { /** * 唯一请求 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资源类系
枚举值:
资源唯一标识
*/ ResName?: string; /** *资源详细信息
*/ Detail?: string; /** *资源状态
枚举值:
资源id
*/ PlatformId?: number; /** *对用平台资源id
*/ Id?: number; } /** * DescribeGatewayVersions返回参数结构体 */ export interface DescribeGatewayVersionsResponse { /** * 网关id */ GatewayId?: string; /** * 版本总数 */ TotalCount?: number; /** * 版本信息详情 */ GatewayVersionItems?: Arraysmtp配置
*/ SmtpConfig?: EmailSmtpConfig; /** *可选:TRUE,FALSE,如果On为TRUE,则表示采用默认代发。
*/ On?: string; /** *邮件模板配置
注意:此字段可能返回 null,表示取不到有效值。 */ TemplateConfig?: EmailTemplateConfig; } /** * 查询用户返回结果 */ export interface DescribeUserListResp { /** * 用户总数 */ Total?: number; /** * 用户列表 */ UserList?: Array环境 ID。可通过 DescribeEnvs 接口获取。
*/ EnvId: string; /** *函数名称。最大 60 字符,以字母开头,支持字母、数字、下划线和连字符。可通过 ListFunctions 或 GetFunction 获取。
*/ FunctionName: string; /** *函数版本。取值:$LATEST(最新版本)。不填默认 $LATEST。当前仅支持 $LATEST。
*/ Qualifier?: string; } /** * AllocateEnv请求参数结构体 */ export interface AllocateEnvRequest { /** *分配请求ID,会按这个值做幂等
入参限制:长度不超过64
*/ AllocateId: string; /** *客户平台的应用标识,如果没有则不传
*/ ExternalAppId?: string; /** *自定义标签
参数格式:逗号分隔的 key=value 对,key/value 仅允许字母、数字、下划线。k1=v1,k2=v2
*/ ExternalTag?: string; /** *是否需要云函数
默认值:false
*/ RequireFunction?: boolean; } /** * CreateEnv返回参数结构体 */ export interface CreateEnvResponse { /** *自动生成的环境ID
*/ EnvId?: string; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * 三方认证出参映射。如果您的对接方不标准,则可以使用这个参数。默认情况下,该参数可以为空。比如:microsoft, github,google,apple 接入,这些参数为空,但是国内的腾讯,新浪等则需要配置该参数。原因主要是:腾讯等公司在实现oauth时,未能完全遵循oauth标准。 */ export interface ProviderResponseParametersMap { /** * 用户唯一标识(sub)的映射字段名。对应 OIDC 标准中的 sub 字段,值为第三方平台返回的用户信息 JSON 中表示用户 ID 的字段路径。例如github平台填sub。 注意:此字段可能返回 null,表示取不到有效值。 */ Sub?: string; /** * 用户名称(name)的映射字段名。对应 OIDC 标准中的 name 字段,值为第三方平台返回的用户信息 JSON 中表示用户昵称或姓名的字段路径。例如github平台填 name。 注意:此字段可能返回 null,表示取不到有效值。 */ Name?: string; /** * 用户头像(picture)的映射字段名。对应 OIDC 标准中的 picture 字段,值为第三方平台返回的用户信息 JSON 中表示用户头像 URL 的字段路径。需要公网可访问的url。 注意:此字段可能返回 null,表示取不到有效值。 */ Picture?: string; /** * 用户登录名(username)的映射字段名。对应 OIDC 标准中的 preferred_username 字段,值为第三方平台返回的用户信息 JSON 中表示用户唯一登录名的字段, 例如可使用sub或email等唯一值的字段。 注意:此字段可能返回 null,表示取不到有效值。 */ Username?: string; /** * 用户邮箱(email)的映射字段名。对应 OIDC 标准中的 email 字段,值为第三方平台返回的用户信息 JSON 中表示用户邮箱地址的字段。 注意:此字段可能返回 null,表示取不到有效值。 */ Email?: string; /** * 用户手机号(phone_number)的映射字段名。对应 OIDC 标准中的 phone_number 字段,值为第三方平台返回的用户信息 JSON 中表示用户手机号的字段。 注意:此字段可能返回 null,表示取不到有效值。 */ PhoneNumber?: string; /** * 用户角色/分组(groups)的映射字段名。对应 OIDC 标准中的 groups 字段,值为第三方平台返回的用户信息 JSON 中表示用户所属角色或分组的字段路径。支持字符串数组类型的返回值。 注意:此字段可能返回 null,表示取不到有效值。 */ Groups?: string; } /** * CreateUser返回参数结构体 */ export interface CreateUserResponse { /** * 结果返回 */ Data?: CreateUserResp; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * CreateFunction返回参数结构体 */ export interface CreateFunctionResponse { /** *调用scf返回的错误码
*/ SCFErrorCode?: string; /** *错误码对应的描述信息
*/ SCFErrorMsg?: string; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * 多语言文字,在 Locale 中 展示的 Message */ export interface MessageLocalized { /** * 字符串 */ Message: string; /** * 在该语言中 */ Locale: string; } /** * UpdateFunctionConfiguration请求参数结构体 */ export interface UpdateFunctionConfigurationRequest { /** *环境ID
*/ EnvId: string; /** *要修改的函数名称
*/ FunctionName?: string; /** *函数描述。最大支持 1000 个英文字母、数字、空格、逗号和英文句号,支持中文
*/ Description?: string; /** *函数运行时内存大小,默认为 128 M,可选范围64M、128 M-3072 M,以 128MB 为阶梯。
*/ MemorySize?: number; /** *函数最长执行时间,单位为秒,可选值范围 1-900 秒,默认为 3 秒
*/ Timeout?: number; /** *函数的环境变量
*/ Environment?: FunctionEnvironment; /** *函数的私有网络配置
*/ VpcConfig?: FunctionVpcConfig; /** *公网访问配置
*/ PublicNetConfig?: FunctionPublicNetConfig; /** *函数运行环境,创建时指定,目前不支持修改。
*/ Runtime?: string; /** *函数绑定的角色
*/ Role?: string; /** *在线依赖安装,TRUE 表示安装,仅支持 Node.js 函数。
默认值:FALSE
*/ InstallDependency?: string; /** *日志投递到的cls日志集ID
*/ ClsTopicId?: string; /** *日志投递到的cls Topic ID
*/ ClsLogsetId?: string; /** *在更新时是否同步发布新版本
默认值:FALSE
*/ Publish?: string; /** *是否开启L5访问能力,TRUE 为开启,FALSE为关闭
*/ L5Enable?: string; /** *函数要关联的层版本列表,层的版本会按照在列表中顺序依次覆盖。
*/ Layers?: Array函数初始化执行超时时间
*/ InitTimeout?: number; /** *是否开启Dns缓存能力。只支持EVENT函数。
默认值:FALSE
*/ DnsCache?: string; /** *忽略系统日志上报
*/ IgnoreSysLog?: string; /** *固定IP配置
*/ EipConfig?: Array环境id
*/ EnvId: string; /** *分组名
*/ GroupName: string; /** *模型地址
枚举值:
模型名列表
Models 列表更新采用全量替换
*/ Models?: Array备注
*/ Remark?: string; /** *模型状态, 1: 开启, 2: 关闭
*/ Status?: number; /** *模型密钥
*/ Secret?: AIModelSecret; } /** * 每日用量详情结构 */ export interface DailyUsageList { /** *资源点用量
*/ Credits?: number; /** *资源点用量日期
参数格式:YYYY-MM-DD
*/ Date?: string; /** *原始资源用量
*/ UsageValue?: number; } /** * RenewEnv请求参数结构体 */ export interface RenewEnvRequest { /** * 环境ID */ EnvId: string; /** * 续费周期,单位:月。 默认值为 1,即续费1个月。 */ Period?: number; /** * 是否自动选择代金券支付。 */ AutoVoucher?: boolean; } /** * DescribeClient返回参数结构体 */ export interface DescribeClientResponse { /** * 客户端的唯一标识符(Client ID),在 OAuth/OIDC 授权流程中作为 client_id 参数使用。创建时仅可传入环境 ID 或留空:传入环境 ID 时将直接使用该值作为客户端 ID(一个环境仅允许一个);留空时由系统自动生成与环境 ID 关联的唯一 ID。创建后不可修改。 */ Id?: string; /** * 客户端的创建时间,格式遵循 ISO 8601 标准(如:2024-01-01T00:00:00Z),由系统自动生成,不可手动修改。 注意:此字段可能返回 null,表示取不到有效值。 */ CreatedAt?: string; /** * 客户端信息的最后修改时间,格式遵循 ISO 8601 标准(如:2024-01-01T00:00:00Z),每次更新应用配置时由系统自动更新。 注意:此字段可能返回 null,表示取不到有效值。 */ UpdatedAt?: string; /** * Refresh Token 的有效期,单位为秒。超过该时间后 Refresh Token 将失效,用户需重新登录。取值范围:最小 1800 秒(30 分钟),最大 2592000 秒(30 天),超出上限将自动截断为 30 天。若不设置则默认为 30 天。当该值小于等于 7200 秒时,系统会自动将 AccessTokenExpiresIn 调整为 RefreshTokenExpiresIn - 660 秒。 注意:此字段可能返回 null,表示取不到有效值。 */ RefreshTokenExpiresIn?: number; /** * Access Token 的有效期,单位为秒。超过该时间后 Access Token 将失效,需通过 Refresh Token 换取新的 Access Token。若不设置则默认为 7200 秒(2 小时)。设置值小于 1800 秒时将被忽略,使用系统默认值。 注意:此字段可能返回 null,表示取不到有效值。 */ AccessTokenExpiresIn?: number; /** * 单个用户在该客户端下允许同时登录的最大会话数量。取值范围:-1 至 50。-1 表示不限制设备数量;0 或不填默认按 User-Agent 区分设备(相同 User-Agent 共享一个会话,不同 User-Agent 各独立一个会话);1 表示单设备登录,新登录将踢出旧会话;大于 1 时按真实设备 ID 限制,超出限制后最早登录的会话将被自动踢出。 注意:此字段可能返回 null,表示取不到有效值。 */ MaxDevice?: number; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * UpdateAIModel返回参数结构体 */ export interface UpdateAIModelResponse { /** *更新数量
*/ Count?: number; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * ModifyEnvPlan返回参数结构体 */ export interface ModifyEnvPlanResponse { /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * DescribeCreditsUsageDetail返回参数结构体 */ export interface DescribeCreditsUsageDetailResponse { /** *用量数据
*/ Usages?: Array总数量
*/ Total?: number; /** *已应用最新版本号
参数格式:纯数字,14位时间格式
*/ LatestVersion?: string; /** *已应用migration列表
*/ Migrations?: Arraymigration 版本号
参数格式:纯数字,14位时间格式
*/ Version?: string; /** *migration 版本名
参数格式:仅允许小写字母和下划线
*/ Name?: string; /** *migration query sql checksum
服务端自动生成,同版本不同checksum会拒绝执行
*/ Checksum?: string; /** *状态
枚举值:
标记请求来源
*/ Source?: string; /** *被归入该分组的原因,比如not_applied、checksum_matched
*/ Reason?: string; } /** * CreateMySQL返回参数结构体 */ export interface CreateMySQLResponse { /** * 开通结果 */ Data?: CreateMySQLResult; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * DeleteAuthDomain返回参数结构体 */ export interface DeleteAuthDomainResponse { /** * 删除的域名个数 */ Deleted?: number; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * DeleteTable请求参数结构体 */ export interface DeleteTableRequest { /** * 待删除的表名 */ TableName: string; /** * FlexDB实例ID */ Tag?: string; /** * 云开发环境ID */ EnvId?: string; /** * MongoDB连接器配置 */ MongoConnector?: MongoConnector; } /** * DownloadFunction返回参数结构体 */ export interface DownloadFunctionResponse { /** *调用SCF报错的错误码
*/ SCFErrorCode?: string; /** *调用SCF报错的错误信息
*/ SCFErrorMsg?: string; /** *返回的不跨域url
*/ Url?: string; /** *函数的SHA256编码
*/ CodeSha256?: string; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * 修改资源基础权限结果 */ export interface ModifyResourcePermissionResult { /** * 是否成功 */ Success?: boolean; } /** * DescribeEnvs返回参数结构体 */ export interface DescribeEnvsResponse { /** *环境信息列表
*/ EnvList?: Array环境个数
*/ Total?: number; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * GetProviders返回参数结构体 */ export interface GetProvidersResponse { /** * 总数 注意:此字段可能返回 null,表示取不到有效值。 */ Total?: number; /** * 三方认证源列表 注意:此字段可能返回 null,表示取不到有效值。 */ Data?: Array平台版套餐id列表
默认值:若不指定,则分页返回当前账号下所有平台版资源
*/ PlatformIds?: Array分页限制
取值范围:[10, 100]
默认值:10
*/ Limit?: number; /** *分页偏移量
默认值:0
*/ Offset?: number; } /** * PurgeHTTPServiceCache返回参数结构体 */ export interface PurgeHTTPServiceCacheResponse { /** *需要刷新的缓存类型:TCBCDN 或 EO
枚举值:
刷新任务ID
*/ TaskId?: string; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * RunSql请求参数结构体 */ export interface RunSqlRequest { /** * 要执行的SQL语句 */ Sql: string; /** * 云开发环境ID */ EnvId: string; /** * 数据库连接器实例信息 */ DbInstance?: DbInstance; /** * 是否只读;当 `true` 时仅允许以 `SELECT/WITH/SHOW/DESCRIBE/DESC/EXPLAIN` 开头的 SQL */ ReadOnly?: boolean; } /** * ModifyPlatformEnv请求参数结构体 */ export interface ModifyPlatformEnvRequest { /** *环境ID
*/ EnvId: string; /** *环境状态
枚举值:
层名称
*/ LayerName?: string; /** *层版本号
*/ LayerVersion?: number; } /** * tke集群信息 */ export interface TkeClusterInfo { /** * 集群ID */ ClusterId?: string; /** * 集群的vpcId */ VpcId?: string; /** * 版本内网CLB所在子网Id */ VersionClbSubnetId?: string; } /** * HTTPService 缓存配置(域名维度) */ export interface HTTPServiceCacheSet { /** *HTTPService 缓存配置列表。Rules 按数组顺序为优先级顺序,Rules[n-1] 优先级最高
*/ Rules?: Array归属权校验的域名
*/ Domain?: string; /** *归属权校验dns校验信息
*/ DnsVerification?: Array归属权校验文件校验信息
*/ FileVerification?: Array客户端维度限频标识。限制当前资源被单个客户端调用的频率,客户端标识支持 用户ID(UserID) 或 客户端 IP(ClientIP)。UserID 包括 云开发用户 ID 或 微信 openid,如果请求无 UserID 信息,则不会限制。
枚举值:
限制QPS值,每秒请求次数
*/ LimitValue?: number; } /** * DescribeSafeRule返回参数结构体 */ export interface DescribeSafeRuleResponse { /** * 规则内容 注意:此字段可能返回 null,表示取不到有效值。 */ Rule?: string; /** * 权限标签。包含以下取值:环境ID
*/ EnvId: string; /** *HTTPService域名
*/ Domain: string; /** *Targets
参数格式:Targets 刷新目标列表,语义随 PurgeType 变化
入参限制:单次请求最多传 20 个 Target,单条 URL/prefix/host 最长 2048
*/ Targets: Array需要刷新的缓存类型:CDN 或 EO
枚举值:
默认值:EO
*/ CacheType?: string; /** *PurgeType 刷新方式(purge 粒度),TCBCDN仅支持purge_url
枚举值:
默认值:PURGE_URL
*/ PurgeType?: string; } /** * CreateTable请求参数结构体 */ export interface CreateTableRequest { /** * 数据表名;长度不超过96个字符,可以为英文字母、数字、下划线(_)和短横线(-)的组合,且不能以下划线开头 */ TableName: string; /** * FlexDB实例ID,如:tnt-nl7hjzasw */ Tag?: string; /** * FlexDB数据库权限信息 */ PermissionInfo?: PermissionInfo; /** * 云开发环境ID */ EnvId?: string; /** * MongoDB连接器配置 */ MongoConnector?: MongoConnector; } /** * 查询HTTP访问服务输出的域名信息,每个域名内包含所有路由信息 */ export interface HTTPServiceDomain { /** *域名
*/ Domain?: string; /** *域名类型。 HTTPSERVICE: HTTP访问服务,CBR: 云托管服务,ANYSERVICE: 任意服务,AI_AGENT: AI agent,VM: 主机,INTEGRATION_CALLBACK: 集成回调
*/ DomainType?: string; /** *绑定类型。默认DIRECT。DIRECT: 直连到HTTP访问服务, CDN: 接入云开发CDN,CUSTOM: 自定义接入类型(其他CDN或者WAF)
枚举值:
默认值:DIRECT
*/ 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; } /** * RepairPGUserMigrationHistory返回参数结构体 */ export interface RepairPGUserMigrationHistoryResponse { /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: 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; } /** * DescribePlatformEnvUsage请求参数结构体 */ export interface DescribePlatformEnvUsageRequest { /** *环境Id
*/ EnvId: string; /** *查询用量起始时间
参数格式:YYYY-MM-DD
*/ StartDate?: string; /** *查询用量结束时间
参数格式:YYYY-MM-DD
*/ EndDate?: string; /** *资源类型
枚举值:
是否展示用量明细
*/ NeedUsageDetails?: boolean; } /** * CreateAIModel请求参数结构体 */ export interface CreateAIModelRequest { /** *环境id
*/ EnvId: string; /** *分组名
入参限制:不允许以 cloudbase 为前缀
*/ GroupName: string; /** *模型服务地址
*/ BaseUrl?: string; /** *模型名列表
*/ Models?: Array分组备注
*/ Remark?: string; /** *模型状态, 1: 开启, 2: 关闭
*/ Status?: number; /** *模型密钥
*/ Secret?: AIModelSecret; } /** * DescribeGatewayVersions请求参数结构体 */ export interface DescribeGatewayVersionsRequest { /** * 环境id */ EnvId: string; /** * 网关id */ GatewayId: string; /** * 版本名 */ VersionName?: string; } /** * DescribeQuotaData请求参数结构体 */ export interface DescribeQuotaDataRequest { /** * 环境ID */ EnvId: string; /** *云开发环境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; } /** * 触发器类型 */ export interface FunctionTrigger { /** *触发器最后修改时间
*/ ModTime: string; /** *触发器类型
*/ Type: string; /** *触发器详细配置
*/ TriggerDesc: string; /** *触发器名称
*/ TriggerName: string; /** *触发器创建时间
*/ AddTime: string; } /** * CreatePlatformEnv返回参数结构体 */ export interface CreatePlatformEnvResponse { /** *环境id
*/ EnvId?: string; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * FlexDB数据库权限信息 */ export interface PermissionInfo { /** * "READONLY", //公有读,私有写。所有用户可读,仅创建者及管理员可写 "PRIVATE", //私有读写,仅创建者及管理员可读写 "ADMINWRITE", //所有用户可读,仅管理员可写 "ADMINONLY", //仅管理员可操作 "CUSTOM", // 安全规则 */ AclTag: string; /** * 云开发环境ID */ EnvId: string; /** * 自定义规则 */ Rule?: string; } /** * VerifyHTTPServiceRoute单项前置校验结果 */ export interface VerifyHTTPServiceRouteCheckItem { /** *检查状态
枚举值:
默认值:SKIPPED
*/ Status?: string; /** *前置校验子项失败原因枚举,仅在 Status=FAIL 时有值,供前端根据 Code 精确渲染提示与操作指引
枚举值:
详细描述;Skipped 时给出跳过原因;Pass 时可为空
*/ Message?: string; /** *域名归属权验证指引信息,仅在所有权校验未通过时有值
*/ OwnershipVerification?: OwnershipVerificationInfo; } /** * 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修改时间
*/ ModTime?: string; /** *创建时间
*/ AddTime?: string; /** *运行时
*/ Runtime?: string; /** *函数名称
*/ FunctionName?: string; /** *函数ID
*/ FunctionId?: string; /** *命名空间
*/ Namespace?: string; /** *函数状态,状态值
*/ Status?: string; /** *函数状态详情
*/ StatusDesc?: string; /** *函数描述
*/ Description?: string; /** *函数标签
注意:此字段可能返回 null,表示取不到有效值。 */ Tags?: Array函数类型,取值为 HTTP 或者 Event
*/ Type?: string; /** *函数状态失败原因
注意:此字段可能返回 null,表示取不到有效值。 */ StatusReasons?: Array函数所有版本预置并发内存总和
*/ TotalProvisionedConcurrencyMem?: number; /** *函数并发保留内存
*/ ReservedConcurrencyMem?: number; /** *函数异步属性,取值 TRUE 或者 FALSE
*/ AsyncRunEnable?: string; /** *异步函数是否开启调用追踪,取值 TRUE 或者 FALSE
*/ TraceEnable?: string; } /** * 静态托管资源信息 */ export interface StaticStoreInfo { /** * 环境ID 注意:此字段可能返回 null,表示取不到有效值。 */ EnvId?: string; /** * 静态域名 注意:此字段可能返回 null,表示取不到有效值。 */ CdnDomain?: string; /** * COS桶 注意:此字段可能返回 null,表示取不到有效值。 */ Bucket?: string; /** * cos区域 注意:此字段可能返回 null,表示取不到有效值。 * @deprecated */ Regoin?: string; /** * 资源状态:init(初始化)/process(处理中)/online(上线)/destroying(销毁中)/offline(下线)) 注意:此字段可能返回 null,表示取不到有效值。 */ Status?: string; /** * 地域 注意:此字段可能返回 null,表示取不到有效值。 */ Region?: string; } /** * DescribeCloudAppVersion请求参数结构体 */ export interface DescribeCloudAppVersionRequest { /** *环境ID
*/ EnvId: string; /** *服务名
*/ ServiceName: string; /** *部署类型
*/ DeployType: string; /** *版本名
*/ VersionName?: string; /** *构建id
*/ BuildId?: string; } /** * DestroyPlatformEnv返回参数结构体 */ export interface DestroyPlatformEnvResponse { /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * 云函数公网访问配置 */ export interface FunctionPublicNetConfig { /** * 是否开启公网访问能力取值['DISABLE','ENABLE'] 注意:此字段可能返回 null,表示取不到有效值。 */ PublicNetStatus?: string; /** * Eip配置 注意:此字段可能返回 null,表示取不到有效值。 */ EipConfig?: FunctionEipConfig; } /** * 云函数配置 */ export interface PrivateConfig { /** * 云函数的语言 */ Language?: string; } /** * AI模型密钥信息 */ export interface AIModelSecret { /** * 密钥来源 */ SecretSource?: string; /** * 密钥ID, 和SecretKey一一对应 */ SecretId?: string; /** * 密钥Key, 和SecretId一一对应 */ SecretKey?: string; /** * ApiKey,SecretKey和ApiKey二选一 */ ApiKey?: string; } /** * 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; } /** * ReleaseEnv返回参数结构体 */ export interface ReleaseEnvResponse { /** * 唯一请求 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?: Array版本名
*/ VersionName?: string; /** *构建方式
*/ BuildType?: string; /** *构建Id
*/ BuildId?: string; /** *构建状态
*/ Status?: string; /** *框架名
*/ Framework?: string; /** *构建配置
*/ StaticConfig?: StaticConfig; /** *构建时间
*/ BuildTime?: string; /** *构建步骤
注意:此字段可能返回 null,表示取不到有效值。 */ Steps?: Array服务列表
*/ ServiceList?: Array总数
*/ Total?: number; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * DescribeMySQLTaskStatus请求参数结构体 */ export interface DescribeMySQLTaskStatusRequest { /** * 云开发环境ID */ EnvId: string; /** * 任务Id */ TaskId?: string; /** * 任务名 */ TaskName?: 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; } /** * CLS日志结果 */ export interface LogResObject { /** * 获取更多检索结果的游标 */ Context?: string; /** * 搜索结果是否已经全部返回 */ ListOver?: boolean; /** * 日志内容信息 */ Results?: Array遵循源站
*/ 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; } /** * DescribeCloudAppInfo请求参数结构体 */ export type DescribeCloudAppInfoRequest = null; /** * CreateEnvResource请求参数结构体 */ export interface CreateEnvResourceRequest { /** *环境ID
*/ EnvId: string; /** *资源类型。代表本次开通哪些资源。
可取值以及含义:
该数组不能为空,且每个元素必须为合法的资源类型值
*/ Resources: Array最大输入 Token
*/ MaxInputToken?: string; /** *最大输出 Token
*/ MaxOutputToken?: string; /** *上下文长度
*/ ContextLength?: string; } /** * DescribePlatforms返回参数结构体 */ export interface DescribePlatformsResponse { /** *平台版资源列表
*/ PlatformList?: Array总数
*/ Total?: number; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * 私有网络参数配置 */ export interface FunctionVpcConfig { /** *私有网络 的 id
*/ VpcId?: string; /** *子网的 id
*/ SubnetId?: string; } /** * 开通Mysql 结果 */ export interface CreateMySQLResult { /** * 任务ID */ TaskId?: string; } /** * CreateCloudApp请求参数结构体 */ export interface CreateCloudAppRequest { /** *环境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; } /** * 键值对 */ export interface KVPair { /** * 键 */ Key: string; /** * 值 */ Value: string; } /** * DeleteAIModel返回参数结构体 */ export interface DeleteAIModelResponse { /** *成功删除数量
*/ Count?: number; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * DescribeEnvAccountCircle请求参数结构体 */ export interface DescribeEnvAccountCircleRequest { /** * 环境ID */ EnvId: string; } /** * HTTPService 路由扩展字段 */ export interface HTTPServiceExtension { /** *添加请求头列表
*/ HeadersHandler?: HTTPServiceHeadersHandler; /** *HTTPService 缓存配置,仅限自定义域名配置。包含Cache 节点缓存 / MaxAge 浏览器缓存 / CacheKey 自定义缓存键
*/ Cache?: HTTPServiceCacheSet; } /** * DeleteApiKey返回参数结构体 */ export interface DeleteApiKeyResponse { /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * ModifyClient返回参数结构体 */ export interface ModifyClientResponse { /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * 平台版资源信息 */ export interface PlatformInfo { /** *平台版套餐id
*/ PlatformId?: string; /** *套餐别名
*/ Alias?: string; /** *套餐id
*/ PackageId?: string; /** *计费状态
枚举值:
套餐资源状态
枚举值:
资源配置
*/ Spec?: string; /** *购买时间
参数格式:YYYY-MM-DD hh:mm:ss
*/ BillTime?: string; /** *套餐过期时间
参数格式:YYYY-MM-DD hh:mm:ss
*/ ExpireTime?: string; /** *是否自动续费
枚举值:
资源信息列表
*/ Resources?: Array所属地域
枚举值:
命名空间
*/ EnvId: string; /** *以升序还是降序的方式返回结果,可选值 ASC 和 DESC
*/ Order?: string; /** *根据哪个字段进行返回结果排序,支持以下字段:AddTime, ModTime, FunctionName
*/ Orderby?: string; /** *数据偏移量,默认值为 0
*/ Offset?: number; /** *返回数据长度,默认值为 20
*/ Limit?: number; /** *支持FunctionName模糊匹配
*/ SearchKey?: string; /** *函数描述,支持模糊搜索
*/ Description?: string; /** *过滤特定属性或者有特定标签的函数。- 传值方式key-value 进行传值 例如:"Filters": [{ "Name": "Status", "Values": ["CreateFailed","Creating"]}, {"Name": "Type","Values": ["HTTP"]}]上述条件的函数是,函数状态为创建失败或者创建中,且函数类型为 HTTP 函数如果通过标签进行过滤:- tag:tag-key - String - 是否必填:否 - (过滤条件)按照标签键值对进行过滤。 tag-key使用具体的标签键进行替换。示例值:"Filters": [{"Name":"tag-dmtest","Values":["dmtest"]}]入参限制:1.每次请求的Filters的上限为10,Filter.Values的上限为5。2.[VpcId', 'SubnetId', 'ClsTopicId', 'ClsLogsetId', 'Role', 'CfsId', 'CfsMountInsId', 'Eip'] 过滤的Name 为这些属性时, values 只能传一个值3.['Status', 'Runtime', 'Type', 'PublicNetStatus', 'AsyncRunEnable', 'TraceEnable', 'Stamp'] 过滤的Name 为这些属性时 ,values 可以传多个值
*/ Filters?: Array环境ID
*/ EnvId: string; /** *域名路由信息
*/ Domain: HTTPServiceDomainParam; } /** * 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; } /** * DeleteFunction返回参数结构体 */ export interface DeleteFunctionResponse { /** *函数 ID,仅 CBF 云函数返回
*/ FunctionId?: string; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * DestroyEnv请求参数结构体 */ export interface DestroyEnvRequest { /** * 环境Id */ EnvId: string; /** * 针对预付费 删除隔离中的环境时要传true 正常环境直接跳过隔离期删除 */ IsForce?: boolean; /** * 是否绕过资源检查,资源包等额外资源,默认为false,如果为true,则不检查资源是否有数据,直接删除。 */ BypassCheck?: boolean; } /** * DestroyEnv返回参数结构体 */ export interface DestroyEnvResponse { /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * ListTables返回参数结构体 */ export interface ListTablesResponse { /** * 表信息 注意:此字段可能返回 null,表示取不到有效值。 */ Tables?: Array套餐英文标识,不指定则返回所有可售卖套餐
枚举值:
开始日期
参数格式:2025-09-22
*/ StartDate: string; /** *结束日期
参数格式:2025-09-22
*/ EndDate: string; /** *平台版套餐id
*/ PlatformId: 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; } /** * 对象变量 */ export interface Variable { /** *变量的名称
*/ Key?: string; /** *变量的值
*/ Value?: string; } /** * 静态CDN资源信息 */ export interface StaticStorageInfo { /** *静态CDN域名
*/ StaticDomain?: string; /** *静态CDN默认文件夹,当前为根目录
*/ DefaultDirName?: string; /** *资源状态(process/online/offline/init)
*/ Status?: string; /** *cos所属区域
*/ Region?: string; /** *bucket信息
*/ Bucket?: string; /** *到期时间(秒级时间戳)
*/ AccessExpire?: number; /** *外部存储。
*/ ExternalStorage?: ExternalStorage; } /** * ReleaseEnv请求参数结构体 */ export interface ReleaseEnvRequest { /** *环境ID
*/ EnvId?: string; /** *分配请求ID
*/ AllocateId?: string; } /** * 固定 IP 配置 */ export interface FunctionEipConfigFixed { /** *是否固定 IP,TRUE / FALSE
*/ EipFixed?: string; } /** * 平台版指标用量信息 */ export interface PlatformMetricUsageItem { /** *指标名称
*/ MetricName?: string; /** *原始资源类型
枚举值:
原始指标
*/ OriginalMetricName?: string; /** *资源用量
*/ UsageValue?: number; /** *资源用量单位
*/ UsageUnit?: string; /** *资源点
*/ Credits?: number; /** *用量按日明细列表
*/ DailyUsageList?: Array云开发环境ID
*/ EnvId: string; /** *要执行的SQL语句
*/ Sql: string; /** *指定 role 执行 SQL
*/ Role?: string; } /** * DescribeStaticStore返回参数结构体 */ export interface DescribeStaticStoreResponse { /** * 静态托管资源信息 注意:此字段可能返回 null,表示取不到有效值。 */ Data?: Array任务列表
*/ Tasks?: Array域名总数,分页查询使用总数判断是否已经拉取到所有数据
*/ TotalCount?: number; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * DestroyPlatformEnv请求参数结构体 */ export interface DestroyPlatformEnvRequest { /** *环境id
*/ EnvId: string; } /** * DescribePGUserMigration请求参数结构体 */ export interface DescribePGUserMigrationRequest { /** *云开发环境ID
*/ EnvId: string; /** *版本号
参数格式:14位时间格式
入参限制:纯数字
*/ MigrationVersion: string; } /** * API Key 访问凭证信息。描述云开发环境下 API Key 的完整信息,包括标识符、名称、令牌值、创建时间和过期时间。支持两种类型:api_key(服务端管理员访问凭证,用于服务端接口调用的身份认证,可设置有效期,单个环境最多 5 个)和 publish_key(前端匿名访问凭证,固定有效期,每个环境仅保留一个)。注意:令牌值(ApiKey 字段)仅在创建时返回完整明文,列表查询时将进行脱敏处理。 */ export interface ApiKeyToken { /** * API Key 的唯一标识符,由系统基于 UUID 自动生成的 Base64 URL 编码字符串。后续对该 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 的过期时间,格式遵循 ISO 8601 标准。对于 api_key 类型:若创建时未指定有效期(ExpireIn),则该字段不返回,表示永不过期;若指定了有效期,则返回具体的过期时间。对于 publish_key 类型:始终返回,固定为约 2099 年 注意:此字段可能返回 null,表示取不到有效值。 */ ExpireAt?: string; /** * API Key 的创建时间,格式遵循 ISO 8601 标准。对于 api_key 类型:为该 Key 实际创建时的时间。对于 publish_key 类型:若环境下已存在 publish_key 记录,则返回首次创建的时间而非本次调用时间 注意:此字段可能返回 null,表示取不到有效值。 */ CreateAt?: string; } /** * 平台版资源用量信息 */ export interface PlatformResUsageItem { /** *资源类型
枚举值:
资源点
*/ TotalCredits?: number; /** *指标用量信息
*/ Metrics?: Arraymigration 版本号
参数格式:纯数字,14位时间格式
*/ Version?: string; /** *migration 版本名
参数格式:仅允许小写字母和下划线
*/ Name?: string; /** *数据库已应用migration的版本名
参数格式:仅允许小写字母和下划线
*/ RemoteName?: string; /** *本次sql计算出来的checksum
*/ LocalChecksum?: string; /** *已应用的migration,数据库存储的checksum
*/ RemoteChecksum?: string; /** *归入该分组的原因
*/ Reason?: string; /** *冲突信息
*/ Message?: string; } /** * ModifyPGInstanceSpec返回参数结构体 */ export interface ModifyPGInstanceSpecResponse { /** *账单名
*/ DealName?: string; /** *账单标识
*/ BillId?: string; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * DescribePlatformAccountCircle请求参数结构体 */ export type DescribePlatformAccountCircleRequest = null; /** * MongoDB连接器配置 */ export interface MongoConnector { /** * 连接器实例ID */ InstanceId?: string; /** * MongoDB数据库名 */ DatabaseName?: 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; } /** * 分页信息 */ export interface Pager { /** * 分页偏移量 注意:此字段可能返回 null,表示取不到有效值。 */ Offset?: number; /** * 每页返回记录数 注意:此字段可能返回 null,表示取不到有效值。 */ Limit?: number; /** * 文档集合总数 注意:此字段可能返回 null,表示取不到有效值。 */ Total?: number; } /** * 静态托管的环境变量参数 */ export interface StaticEnvironment { /** * 环境变量数组 注意:此字段可能返回 null,表示取不到有效值。 */ Variables?: Array数据日期
参数格式:YYYY-MM-DD
*/ Date?: string; /** *资源点套餐内用量
*/ DeductValue?: number; /** *资源点资源包用量
*/ PackageDeductValue?: number; /** *资源点按量用量
*/ ReportValue?: number; /** *资源点原价消耗
*/ OriginCredits?: number; } /** * 安全网关自定义配置 */ export interface WxGatewayCustomConfig { /** * 是否开启x-real-ip */ IsOpenXRealIp?: boolean; /** * 封禁配置 */ BanConfig?: BanConfig; /** * 获取源ip方式,PPV1(Proxy Protocol V1)、PPV2(Proxy Protocol V2)、TOA(tcp option address) */ SourceIpType?: string; /** * 日志信息 */ LogConfig?: CustomLogConfig; /** * 是否开启http1.0 */ IsAcceptHttpOne?: boolean; } /** * 指标用量明细 */ export interface MetricUsage { /** *指标名称
*/ 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; } /** * DescribeCreditsUsage返回参数结构体 */ export interface DescribeCreditsUsageResponse { /** *资源点套餐内用量
*/ DeductValue?: number; /** *资源点资源包用量
*/ PackageDeductValue?: number; /** *资源点按量用量
*/ ReportValue?: number; /** *历史周期资源点用量
*/ HistoryDeducted?: number; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * DescribeDatabaseACL返回参数结构体 */ export interface DescribeDatabaseACLResponse { /** * 权限标签。包含以下取值:用量数据
*/ Usages?: Array环境id
*/ EnvId: string; } /** * AI 模型信息 */ export interface AIModelGroup { /** *模型分组
枚举值:
模型列表
注意:此字段可能返回 null,表示取不到有效值。 */ Models?: Array模型类型
枚举值:
原始模型类型
枚举值:
备注
*/ Remark?: string; /** *模型地址
*/ BaseUrl?: string; /** *模型状态, 1: 开启, 2: 关闭
*/ Status?: number; /** *模型密钥
注意:此字段可能返回 null,表示取不到有效值。 */ Secret?: AIModelSecret; /** *创建时间
*/ CreateTime?: string; /** *更新时间
*/ UpdateTime?: string; } /** * ModifyStorageSource请求参数结构体 */ export interface ModifyStorageSourceRequest { /** * 环境ID */ EnvId: string; /** * 存储源 */ StorageConfig: ExternalStorage; } /** * CreateApiKey请求参数结构体 */ export interface CreateApiKeyRequest { /** * 环境 ID,用于标识该密钥归属的云开发环境,不同环境之间的数据相互隔离 */ EnvId: string; /** * 密钥类型。可选值:api_key(服务端调用使用的 API 密钥,具有完整权限,请勿暴露在客户端)、publish_key(客户端使用的公开密钥,权限受限,可安全用于前端或移动端)。 */ KeyType: string; /** * 密钥的自定义名称,用于在管理列表中标识和区分不同的密钥,建议填写能体现用途或归属的描述性名称,例如:server-prod、mobile-test */ KeyName?: string; /** * 密钥的有效期,单位为秒,最短不得低于 7200 秒。超过有效期后密钥将自动失效。不设置或设置为 0 则表示永不过期,建议根据安全需求合理设置有效期 */ ExpireIn?: number; }