tencentcloud-sdk-nodejs
Version:
2,404 lines • 218 kB
TypeScript
/**
* DescribeEnvLimit返回参数结构体
*/
export interface DescribeEnvLimitResponse {
/**
* 环境总数上限
*/
MaxEnvNum?: number;
/**
* 目前环境总数
*/
CurrentEnvNum?: number;
/**
* 免费环境数量上限
*/
MaxFreeEnvNum?: number;
/**
* 目前免费环境数量
*/
CurrentFreeEnvNum?: number;
/**
* 总计允许销毁环境次数上限
*/
MaxDeleteTotal?: number;
/**
* 目前已销毁环境次数
*/
CurrentDeleteTotal?: number;
/**
* 每月允许销毁环境次数上限
*/
MaxDeleteMonthly?: number;
/**
* 本月已销毁环境次数
*/
CurrentDeleteMonthly?: number;
/**
* 微信网关体验版可购买月份数
*/
MaxFreeTrialNum?: number;
/**
* 微信网关体验版已购买月份数
*/
CurrentFreeTrialNum?: number;
/**
* 转支付限额总数
*/
ChangePayTotal?: number;
/**
* 当前已用转支付次数
*/
CurrentChangePayTotal?: number;
/**
* 转支付每月限额
*/
ChangePayMonthly?: number;
/**
* 本月已用转支付额度
*/
CurrentChangePayMonthly?: number;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* DescribeResourcePermission返回参数结构体
*/
export interface DescribeResourcePermissionResponse {
/**
* 查询资源权限返回结果
*/
Data?: DescribeResourcePermissionResult;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* BindStorageSource请求参数结构体
*/
export interface BindStorageSourceRequest {
/**
* 环境ID
*/
EnvId: string;
/**
* 存储源
*/
StorageConfig: ExternalStorage;
}
/**
* 托管 AI 模型计费信息
*/
export interface ManagedAIModelChargingInfo {
/**
* <p>计费类型</p><p>枚举值:</p><ul><li>Uniform: 固定计费</li><li>Tiered: 分段计费</li></ul>
*/
Type?: string;
/**
* <p>分组名称</p>
*/
Name?: string;
/**
* <p>输入 Token 价格</p>
*/
InputPrice?: string;
/**
* <p>输出 Token 价格</p>
*/
OutputPrice?: string;
/**
* <p>命中缓存价格</p>
*/
CachePrice?: string;
/**
* <p>计费单位</p>
*/
InputOutputUnit?: string;
}
/**
* 订单信息
*/
export interface OrderInfo {
/**
* 订单号
*/
TranId?: string;
/**
* 订单要切换的套餐ID
*/
PackageId?: string;
/**
* 订单类型
<li>1 购买</li>
<li>2 续费</li>
<li>3 变配</li>
*/
TranType?: string;
/**
* 订单状态。
<li>1未支付</li>
<li>2 支付中</li>
<li>3 发货中</li>
<li>4 发货成功</li>
<li>5 发货失败</li>
<li>6 已退款</li>
<li>7 已取消</li>
<li>100 已删除</li>
*/
TranStatus?: string;
/**
* 订单更新时间
*/
UpdateTime?: string;
/**
* 订单创建时间
*/
CreateTime?: string;
/**
* 付费模式.
<li>prepayment 预付费</li>
<li>postpaid 后付费</li>
*/
PayMode?: string;
/**
* 订单绑定的扩展ID
*/
ExtensionId?: string;
/**
* 资源初始化结果(仅当ExtensionId不为空时有效): successful(初始化成功), failed(初始化失败), doing(初始化进行中), init(准备初始化)
*/
ResourceReady?: string;
/**
* 安装标记。建议使用方统一转大小写之后再判断。
<li>QuickStart:快速启动来源</li>
<li>Activity:活动来源</li>
*/
Flag?: string;
/**
* 下单时的参数
*/
ReqBody?: string;
}
/**
* CheckTcbService返回参数结构体
*/
export interface CheckTcbServiceResponse {
/**
* true表示已开通
*/
Initialized?: boolean;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* DeleteCloudAppVersion返回参数结构体
*/
export interface DeleteCloudAppVersionResponse {
/**
* 是否删除成功
*/
Result?: boolean;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* DescribeCloudAppCosInfo请求参数结构体
*/
export interface DescribeCloudAppCosInfoRequest {
/**
* 环境id
*/
EnvId: string;
/**
* 服务名
*/
ServiceName: string;
/**
* 部署类型
*/
DeployType: string;
/**
* 时间戳
*/
UnixTimestamp?: string;
/**
* 文件后缀
*/
Suffix?: string;
/**
* 是否需要下载
*/
NeedDownload?: boolean;
}
/**
* migration 执行计划
*/
export interface MigrationPlanItem {
/**
* <p>migration 版本号</p><p>参数格式:纯数字,14位时间格式</p>
*/
Version?: string;
/**
* <p>migration 版本名</p><p>参数格式:仅允许小写字母和下划线</p>
*/
Name?: string;
/**
* <p>migration query sql checksum</p><p>服务端自动生成,同版本不同checksum会拒绝执行</p>
*/
Checksum?: string;
/**
* <p>状态</p><p>枚举值:</p><ul><li>applied: 已应用</li><li>pending: 待执行</li></ul>
*/
Status?: string;
/**
* <p>标记请求来源</p>
*/
Source?: string;
/**
* <p>被归入该分组的原因,比如not_applied、checksum_matched</p>
*/
Reason?: string;
}
/**
* 可以为每种语言配置一个字符串。比如:name,中文展示为:名字,英文展示为 name,韩文展示为:이름
*/
export interface LocalizedMessage {
/**
* 默认展示的文本
*/
Message: string;
/**
* 针对每种语言展示的文字
*/
Localized?: Array<MessageLocalized>;
}
/**
* GetProviders请求参数结构体
*/
export interface GetProvidersRequest {
/**
* 环境 ID,用于指定需要查询配置第三方身份源的云开发环境。
*/
EnvId: string;
}
/**
* DescribeCloudBaseRunServerVersion请求参数结构体
*/
export interface DescribeCloudBaseRunServerVersionRequest {
/**
* 环境ID
*/
EnvId: string;
/**
* 服务名称
*/
ServerName: string;
/**
* 版本名称
*/
VersionName: string;
}
/**
* CreateVmInstance返回参数结构体
*/
export interface CreateVmInstanceResponse {
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* ModifyEnvPlan请求参数结构体
*/
export interface ModifyEnvPlanRequest {
/**
* 所需变更套餐的环境ID
*/
EnvId: string;
/**
* 目标套餐Id。
对于云开发环境套餐,可通过 [DescribeBaasPackageList](https://cloud.tencent.com/document/product/876/78167) 接口获取,对应其出参的PackageName
*/
PackageId: string;
/**
* 是否自动选择代金券支付。
*/
AutoVoucher?: boolean;
}
/**
* AddProvider请求参数结构体
*/
export interface AddProviderRequest {
/**
* 云开发环境 ID,用于唯一标识当前操作所属的云开发环境。
*/
EnvId: string;
/**
* 身份源的显示名称,支持国际化多语言配置。用户在登录页面看到的身份源名称将使用该字段,建议根据实际业务场景填写易于识别的名称,例如:企业微信、GitHub 等。
*/
Name: LocalizedMessage;
/**
* 身份源协议类型,决定该身份源使用何种认证协议与第三方平台对接。可选值:
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;
/**
* 身份源的唯一标识符,用于在系统内区分不同的身份源。格式要求:2~32 位,仅支持小写英文字母和数字,不可包含空格或特殊字符。若不填写,系统将自动生成。例如:github、google。
*/
Id?: string;
/**
* 身份源图标的访问地址,将展示在登录页的身份源按钮上。建议使用 64×64 像素的 SVG 格式图片以保证清晰度,支持 HTTP/HTTPS 公网可访问的图片链接。
*/
Picture?: string;
/**
* 身份源对应的官方主页地址。该信息将在用户查看自己的第三方账号绑定列表时展示,帮助用户识别已绑定的身份源来源。例如 GitHub 身份源可填写:https://github.com。
*/
Homepage?: string;
/**
* 身份认证源协议连接配置,包含与第三方平台对接所需的核心参数,如 ClientId、ClientSecret、授权端点、Token 端点、回调地址、Scope、SAML Metadata、请求和响应参数映射等。不同 ProviderType 对应不同的配置项要求。
*/
Config?: ProviderConfig;
/**
* 是否开启透传登录模式。可选值:TRUE(开启)、FALSE(关闭)、UNSPECIFIED(默认为 FALSE,企业微信代开发应用 WX_WORK_AGENT 类型默认为 TRUE)。开启后,平台不会持久化存储用户数据,仅将第三方身份源返回的用户信息透传给业务方,适用于不希望平台留存用户数据的场景。注意:开启透传模式时,ReuseUserId 将自动设为 TRUE,AutoSignUpWithProviderUser 将自动设为 FALSE。
*/
TransparentMode?: string;
/**
* 身份源的详细描述信息,支持国际化多语言配置。可用于向用户说明该身份源的用途或使用场景,例如:谷歌授权登录。
*/
Description?: LocalizedMessage;
/**
* 是否直接复用第三方身份源的用户 ID 作为平台的用户 ID。可选值:TRUE(直接复用,适用于已有用户体系迁移场景)、FALSE(不复用,由平台生成独立用户 ID)、UNSPECIFIED(默认为 FALSE,但当 TransparentMode 为 TRUE 时自动设为 TRUE)。注意:开启后需确保第三方用户 ID 的唯一性,避免 ID 冲突。
*/
ReuseUserId?: string;
/**
* 身份源的启用状态。可选值:TRUE(启用,用户可通过该身份源登录)、FALSE(禁用,登录入口将被隐藏,已有绑定关系不受影响)、UNSPECIFIED(默认为 TRUE)。
*/
On?: string;
/**
* 是否开启邮箱自动关联登录。可选值:TRUE(开启)、FALSE(关闭)、UNSPECIFIED(默认为 FALSE)。开启后,若第三方身份源返回的邮箱与系统中已有用户的邮箱一致,则自动将该第三方账号与已有用户关联并完成登录,无需用户手动绑定。
*/
AutoSignInWhenEmailMatch?: string;
/**
* 是否开启手机号自动关联登录。可选值:TRUE(开启)、FALSE(关闭)、UNSPECIFIED(默认行为等同 TRUE)。开启后,若第三方身份源返回的手机号与系统中已有用户的手机号一致,则自动将该第三方账号与已有用户关联并完成登录,无需用户手动绑定。注意:该字段默认行为(UNSPECIFIED)与 AutoSignInWhenEmailMatch 不同,手机号匹配在未显式关闭时默认生效。
*/
AutoSignInWhenPhoneNumberMatch?: string;
}
/**
* ModifyClsTopic返回参数结构体
*/
export interface ModifyClsTopicResponse {
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* DeleteProvider返回参数结构体
*/
export interface DeleteProviderResponse {
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* 本类型用于UpdateTable接口中描述待创建索引信息
*/
export interface CreateIndex {
/**
* 索引名称
*/
IndexName?: string;
/**
* 索引结构
*/
MgoKeySchema?: MgoKeySchema;
}
/**
* 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;
}
/**
* 数据库连接器实例信息
*/
export interface DbInstance {
/**
* 云开发环境ID
*/
EnvId?: string;
/**
* MySQL 连接器实例 ID;`"default"` 或为空表示使用 TCB 环境的默认连接器
*/
InstanceId?: string;
/**
* 数据库名;为空时使用连接器配置的默认数据库名
*/
Schema?: string;
}
/**
* DescribeMySQLClusterDetail返回参数结构体
*/
export interface DescribeMySQLClusterDetailResponse {
/**
* 集群详情
*/
Data?: MySQLClusterDetail;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* ModifyStorageSource返回参数结构体
*/
export interface ModifyStorageSourceResponse {
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* 自定义短信服务商模板配置
*/
export interface SMSProviderTemplateConfig {
/**
* <p>短信服务商类型</p><p>枚举值:</p><ul><li>TENCENT_CN: 腾讯云国内短信</li><li>TENCENT_INTL: 腾讯云国际短信</li></ul>
注意:此字段可能返回 null,表示取不到有效值。
*/
Vendor: string;
/**
* <p>短信服务商侧申请并审核通过的模板ID。</p><ul><li>腾讯云短信模板ID可前往 <a href="https://console.cloud.tencent.com/smsv2/csms-template">腾讯云国内短信</a> 或 <a href="https://console.cloud.tencent.com/smsv2/isms-template">国际/港澳台短信</a> 的正文模板管理查看,若向境外手机号发送短信,仅支持使用国际/港澳台短信模板。</li></ul>
注意:此字段可能返回 null,表示取不到有效值。
*/
TemplateId: string;
/**
* <p>短信服务商侧为应用分配的ID,按照服务商文档和要求需要此参数的,填写该参数。</p><ul><li>腾讯云国内短信和国际短信此参数必填,可以在<a href="https://console.cloud.tencent.com/smsv2/app-manage">短信控制台</a>的应用列表中查看对应的应用id。</li></ul>
注意:此字段可能返回 null,表示取不到有效值。
*/
SdkAppId?: string;
/**
* <p>短信服务商侧申请并审核通过的签名,按照服务商的文档和要求填写。</p><ul><li>腾讯云短信服务商,签名信息可前往 <a href="https://console.cloud.tencent.com/smsv2/csms-sign">国内短信</a> 或 <a href="https://console.cloud.tencent.com/smsv2/isms-sign">国际/港澳台短信</a> 的签名管理查看。<br> 注意:<ol><li>发送国内短信该参数必填,且需填写签名内容而非签名ID。</li><li>发送国际/港澳台短信该参数非必填。</li></ol></li></ul>
注意:此字段可能返回 null,表示取不到有效值。
*/
SignName?: string;
/**
* <p>调用短信服务商发送短信接口的调用秘钥对应的ID。</p><ul><li>调用api秘钥会保存在云开发平台控制台—扩展功能—授权管理中,如果对于短信调用的api秘钥有删除需求,可在此处进行删除,删除后,短信将无法正常发送。</li><li>腾讯云的调用api秘钥在腾讯云控制台获取,建议使用子账号的秘钥ID,并且按照最小权限配置。</li></ul>
注意:此字段可能返回 null,表示取不到有效值。
*/
SecretId?: string;
/**
* <p>调用短信服务商发送短信接口的调用api秘钥对应的秘钥Key。</p><ul><li>腾讯云的调用api秘钥在腾讯云控制台获取,建议使用子账号的秘钥ID, 并且按照最小权限配置。平台对于调用api秘钥key是加密存储的,不会明文存储。</li></ul>
注意:此字段可能返回 null,表示取不到有效值。
*/
SecretKey?: string;
/**
* <p>短信服务商侧自定义短信发送的senderID,按照服务商文档和要求传参。</p><ul><li>仅国际化场景使用。部分国家/运营商支持自定义 Sender ID替代默认主叫号码。国内站点忽略此字段。</li></ul>
注意:此字段可能返回 null,表示取不到有效值。
*/
SenderId?: string;
/**
* <p>当短信自定义模板含多个占位符时,平台只负责生成验证码值,其余占位符由调用方在此提供。</p><ul><li>无需提供验证码对应的占位的值,验证码由云开发平台侧生成。</li><li>如果是命名占位的服务商的短信模板,这里的参数按照需要对应的占位的key和value,会按照对应的key和value在发送短信时,填充到模板中。</li><li>如果是序号占位的服务商的短信模板,这里的参数不需要key, 只需要填写对应的value, 会按照填写的顺序依次填充到模板中。</li></ul>
注意:此字段可能返回 null,表示取不到有效值。
*/
TemplateExtendParam?: Array<SMSTemplateParams>;
}
/**
* 服务版本信息
*/
export interface CloudAppVersionItem {
/**
* <p>版本名</p>
*/
VersionName?: string;
/**
* <p>构建方式</p>
*/
BuildType?: string;
/**
* <p>构建Id</p>
*/
BuildId?: string;
/**
* <p>构建状态</p>
*/
Status?: string;
/**
* <p>框架名</p>
*/
Framework?: string;
/**
* <p>构建配置</p>
*/
StaticConfig?: StaticConfig;
/**
* <p>构建时间</p>
*/
BuildTime?: string;
/**
* <p>构建步骤</p>
注意:此字段可能返回 null,表示取不到有效值。
*/
Steps?: Array<BuildStepStatus>;
}
/**
* CreateVmInstance请求参数结构体
*/
export interface CreateVmInstanceRequest {
/**
* 环境ID
*/
EnvId: string;
/**
* 服务器类型:
LightHouse = 轻量云服务器
CVM = 云服务器
*/
Type: string;
/**
* 轻量云服务器套餐ID。 当Type=LightHouse时必传
*/
LightHouseBundleId?: string;
/**
* 轻量云服务器镜像ID。当Type=LightHouse时必传
*/
LightHouseBlueprintId?: string;
/**
* 服务器别名
*/
InstanceName?: string;
/**
* 登录方式
*/
LoginConfiguration?: VMLoginConfiguration;
}
/**
* DescribeEnvs请求参数结构体
*/
export interface DescribeEnvsRequest {
/**
* <p>环境ID,如果传了这个参数则只返回该环境的相关信息</p>
*/
EnvId?: string;
/**
* <p>指定Channels字段为可见渠道列表或不可见渠道列表<br>如只想获取渠道A的环境 就填写IsVisible= true,Channels = ["A"], 过滤渠道A拉取其他渠道环境时填写IsVisible= false,Channels = ["A"]</p>
*/
IsVisible?: boolean;
/**
* <p>渠道列表,代表可见或不可见渠道由IsVisible参数指定</p>
*/
Channels?: Array<string>;
/**
* <p>分页参数,单页限制个数</p>
*/
Limit?: number;
/**
* <p>分页参数,偏移量</p>
*/
Offset?: number;
}
/**
* ModifyUser返回参数结构体
*/
export interface ModifyUserResponse {
/**
* 修改用户返回值
注意:此字段可能返回 null,表示取不到有效值。
*/
Data?: ModifyUserResp;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* ModifyProvider返回参数结构体
*/
export interface ModifyProviderResponse {
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* 删除tcb用户返回值
*/
export interface DeleteUsersResp {
/**
* 成功个数
*/
SuccessCount?: number;
/**
* 失败个数
*/
FailedCount?: number;
}
/**
* DescribeEnvLimit请求参数结构体
*/
export type DescribeEnvLimitRequest = null;
/**
* DescribeCloudBaseBuildService返回参数结构体
*/
export interface DescribeCloudBaseBuildServiceResponse {
/**
* 上传url
*/
UploadUrl?: string;
/**
* 上传header
*/
UploadHeaders?: Array<KVPair>;
/**
* 包名
*/
PackageName?: string;
/**
* 包版本
*/
PackageVersion?: string;
/**
* 下载链接
*/
DownloadUrl?: string;
/**
* 下载Httpheader
*/
DownloadHeaders?: Array<KVPair>;
/**
* 下载链接是否过期
*/
OutDate?: boolean;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* 构建步骤
*/
export interface BuildStep {
/**
* <p>步骤名(建议 kebab-case,如 build-image),出现在 DescribeCloudAppVersion.Steps[].Name</p>
*/
Name?: string;
/**
* <p>shell 脚本,支持单行或多行</p>
*/
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;
/**
* 路由创建时间
*/
CreateTime?: string;
/**
* 路由更新时间
*/
UpdateTime?: string;
}
/**
* 三方认证入参映射。如果您的对接方不标准,则可以使用这个参数。默认情况下,该参数可以为空。比如:github,google,apple 接入,这些参数为空,但是国内的腾讯,新浪等则需要配置该参数。原因主要是:腾讯等公司在实现oauth时,未能完全遵循oauth标准。
*/
export interface ProviderRequestParametersMap {
/**
* OAuth 标准协议中的 client_id。不同第三方平台的字段名称可能不同,例如微信平台对应 appid、新浪微博对应 app_id。
*/
ClientId?: string;
/**
* OAuth 标准协议中的 client_secret,用于身份认证源的密钥鉴权。请妥善保管,避免泄露。
*/
ClientSecret?: string;
/**
* OAuth 标准协议中的 redirect_uri,即授权回调地址。用户完成第三方认证后将重定向至该地址。
*/
RedirectUri?: string;
/**
* 身份源注册用户时自动绑定的角色 ID。配置后,通过该身份源注册的新用户将自动关联指定角色。
*/
RegisterUserRoleId?: string;
/**
* 身份源注册用户时是否自动授予许可证。取值范围:
TRUE:自动授权许可证
FALSE:不自动授权(默认值)
*/
RegisterUserAutoLicense?: string;
/**
* OAuth 获取 Token 时认证信息的请求位置。取值范围:
URL:将认证信息放在请求 URL 参数中
Headers:将认证信息放在请求 Header 中
Body:将认证信息放在请求 Body 中
*/
AuthPosition?: string;
/**
* OAuth 授权模式匹配的参数字段名。用于指定获取 Token 请求中 grant_type 参数对应的字段名称。
*/
GrantType?: string;
/**
* OAuth 授权模式类型。用于指定 grant_type 的值,例如 client_credentials 表示客户端凭证模式。
*/
ClientCredentials?: string;
/**
* OAuth 返回中 access_token 的映射字段名。若第三方平台返回的 Token 字段名不是标准的 access_token,可通过此字段指定实际字段名。
*/
AccessToken?: string;
/**
* OAuth 返回中 Token 有效期的映射字段名。若第三方平台返回的有效期字段名不是标准的 expires_in,可通过此字段指定实际字段名。
*/
ExpiresIn?: string;
/**
* 身份源注册用户时的用户类型。取值范围:
externalUser:外部用户
internalUser:内部用户
默认值为 externalUser。
*/
RegisterUserType?: string;
}
/**
* DescribeMySQLTaskStatus请求参数结构体
*/
export interface DescribeMySQLTaskStatusRequest {
/**
* 云开发环境ID
*/
EnvId: string;
/**
* 任务Id
*/
TaskId?: string;
/**
* 任务名
*/
TaskName?: string;
}
/**
* 构建命令
*/
export interface BuildCommands {
/**
* <p>平台生成默认 install step 时执行</p>
*/
InstallCmd?: string;
/**
* <p>平台生成默认build step 时执行</p>
*/
BuildCmd?: string;
/**
* <p>平台生成默认deploy step 时执行</p>
*/
DeployCmd?: string;
}
/**
* 封禁配置
*/
export interface BanConfig {
/**
* ip白名单,支持ipv4、ipv6,支持CIDR
*/
IpWhiteList?: Array<string>;
/**
* ip黑名单,支持ipv4、ipv6,支持CIDR
*/
IpBlackList?: Array<string>;
/**
* 地域白名单(国家英文名)
*/
CountryWhiteList?: Array<string>;
/**
* 地域黑名单(国家英文名)
*/
CountryBlackList?: Array<string>;
}
/**
* RepairPGUserMigrationHistory返回参数结构体
*/
export interface RepairPGUserMigrationHistoryResponse {
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* RepairPGUserMigrationHistory请求参数结构体
*/
export interface RepairPGUserMigrationHistoryRequest {
/**
* <p>云开发环境ID</p>
*/
EnvId: string;
/**
* <p>migration版本</p><p>参数格式:14位时间格式</p><p>入参限制:纯数字</p>
*/
MigrationVersion: string;
/**
* <p>migration 版本名</p><p>入参限制:限制小写字母和下划线</p>
*/
Name: string;
/**
* <p>状态</p><p>枚举值:</p><ul><li>applied: 已应用</li><li>reverted: 表示删除 history 记录</li></ul>
*/
Status: string;
/**
* <p>修复原因</p>
*/
Reason: string;
/**
* <p>applied的时候填写,记录应用的sql语句</p>
*/
Query?: string;
}
/**
* AllocateEnv返回参数结构体
*/
export interface AllocateEnvResponse {
/**
* <p>环境ID</p>
*/
EnvId?: string;
/**
* <p>回显 客户平台的应用标识,如果没有则不传</p>
*/
ExternalAppId?: string;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* DescribeCloudAppList请求参数结构体
*/
export interface DescribeCloudAppListRequest {
/**
* <p>环境ID</p>
*/
EnvId: string;
/**
* <p>部署类型</p>
*/
DeployType: string;
/**
* <p>搜索关键字</p>
*/
SearchKey?: string;
/**
* <p>页大小</p>
*/
PageSize?: number;
/**
* <p>页号</p>
*/
PageNo?: number;
}
/**
* ModifyEnv返回参数结构体
*/
export interface ModifyEnvResponse {
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* 索引的key值
*/
export interface Indexkey {
/**
* 键名
*/
Name?: string;
/**
* 方向:specify 1 for ascending or -1 for descending
*/
Direction?: string;
}
/**
* 云开发内置 AI 模型信息
*/
export interface ManagedAIModelGroup {
/**
* <p>模型分组</p>
*/
GroupName?: string;
/**
* <p>模型列表</p>
注意:此字段可能返回 null,表示取不到有效值。
*/
Models?: Array<ManagedAIModel>;
/**
* <p>备注</p>
*/
Remark?: string;
}
/**
* ReleaseEnv返回参数结构体
*/
export interface ReleaseEnvResponse {
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* 邮箱smtp配置
*/
export interface EmailSmtpConfig {
/**
* 邮件发送者的邮箱地址,即收件人看到的发件人地址。需为有效的邮箱格式,且须与 SMTP 服务器的授权账号一致,否则可能被邮件服务商拒绝发送。例如:abc@example.com
*/
SenderAddress?: string;
/**
* SMTP 邮件服务器的域名或 IP 地址,用于建立邮件发送连接。不同邮件服务商的 SMTP 地址不同,例如 QQ 邮箱为 smtp.qq.com,Gmail 为 smtp.gmail.com,请以实际服务商提供的地址为准。
*/
ServerHost?: string;
/**
* SMTP 邮件服务器的端口号,需与所选安全模式(SecurityMode)匹配。常用端口:465(SSL 加密)、587(STARTTLS 加密)、25(无加密,不推荐)。建议优先使用 465 或 587 以保障传输安全。
*/
ServerPort?: number;
/**
* SMTP 服务器的登录账号,通常为发件人的完整邮箱地址。部分邮件服务商支持使用独立的 SMTP 授权账号,请以实际服务商的要求为准。
*/
AccountUsername?: string;
/**
* SMTP 服务器的登录密码。注意:部分邮件服务商(如 QQ 邮箱、163 邮箱)不支持直接使用账号登录密码,需在邮箱设置中开启 SMTP 服务并生成专用的授权码,请以实际服务商的要求为准。
*/
AccountPassword?: string;
/**
* SMTP 连接的加密模式,用于保障邮件传输安全。可选值:AUTO(自动选择,优先使用安全连接)、SSL(全程 SSL/TLS 加密,通常配合端口 465 使用)、STARTSSL(通过 STARTTLS 命令升级为加密连接,通常配合端口 587 使用)、NO_SSL(不使用加密,仅建议在内网或测试环境中使用)。推荐使用 AUTO 或 SSL 以确保传输安全。
*/
SecurityMode?: string;
}
/**
* DescribeHTTPServiceRoute请求参数结构体
*/
export interface DescribeHTTPServiceRouteRequest {
/**
* 环境ID
*/
EnvId: string;
/**
* 过滤条件。Key的含义参考对应字段,Value精确匹配。可过滤: Domain、Path、DomainType、UpstreamResourceType。可过滤的Values单条不超过100
*/
Filters?: Array<Filter>;
/**
* 分页偏移量。默认 0
*/
Offset?: number;
/**
* 分页限制。默认20,最大值1000
*/
Limit?: number;
}
/**
* MongoDB连接器配置
*/
export interface MongoConnector {
/**
* 连接器实例ID
*/
InstanceId?: string;
/**
* MongoDB数据库名
*/
DatabaseName?: string;
}
/**
* DescribeCurveData返回参数结构体
*/
export interface DescribeCurveDataResponse {
/**
* <p>开始时间, 会根据数据的统计周期进行取整</p>
*/
StartTime?: string;
/**
* <p>结束时间, 会根据数据的统计周期进行取整</p>
*/
EndTime?: string;
/**
* <p>指标名</p>
*/
MetricName?: string;
/**
* <p>统计周期(单位秒), 当时间区间为1天内, 统计周期为5分钟; 当时间区间选择为1天以上, 15天以下, 统计周期为1小时; 当时间区间选择为15天以上, 180天以下, 统计周期为1天</p>
*/
Period?: number;
/**
* <p>有效的监控数据, 每个有效监控数据的上报时间可以从时间数组中的对应位置上获取到</p>
*/
Values?: Array<number | bigint>;
/**
* <p>各数据点的时间戳数组(Unix 时间戳,秒级),与 Values 一一对应</p>
*/
Time?: Array<number | bigint>;
/**
* <p>有效的监控数据, 每个有效监控数据的上报时间可以从时间数组中的对应位置上获取到</p>
*/
NewValues?: Array<number>;
/**
* <p>聚合方式, "last" 表示取时间段内最后一个值,“max”表示取时间段内最大值,“avg”表示取时间段内的平均值</p>
*/
Statistics?: string;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* DescribeBaasPackageList请求参数结构体
*/
export interface DescribeBaasPackageListRequest {
/**
* tcb产品套餐ID,不填拉取全量package信息。
*/
PackageName?: string;
/**
* 环境ID
*/
EnvId?: string;
/**
* 套餐归属方,填写后只返回对应的套餐 包含miniapp与qcloud两种 默认为miniapp
*/
Source?: string;
/**
* 套餐归属环境渠道
*/
EnvChannel?: string;
/**
* 拉取套餐用途:
1)new 新购
2)modify变配
3)renew续费
*/
TargetAction?: string;
/**
* 预留字段,同一商品会对应多个类型套餐,对指标有不同侧重。
计算型calculation
流量型flux
容量型capactiy
*/
GroupName?: string;
/**
* 类型分组过滤。默认为["default"]
*/
PackageTypeList?: Array<string>;
/**
* 付费渠道,与回包billTags中的计费参数相关,不填返回默认值。
*/
PaymentChannel?: string;
}
/**
* cls日志信息
*/
export interface ClsInfo {
/**
* cls所属地域
*/
ClsRegion: string;
/**
* cls日志集ID
*/
ClsLogsetId: string;
/**
* cls日志主题ID
*/
ClsTopicId: string;
/**
* 创建时间
*/
CreateTime: string;
}
/**
* HTTP访问服务路由添加header
*/
export interface HTTPServiceHeaderToAdd {
/**
* 添加头部的key
*/
Key?: string;
/**
* 添加头部的值
*/
Value?: string;
/**
* 添加头部的处理行为。默认:OVERWRITE_IF_EXISTS_OR_ADD。APPEND_IF_EXISTS_OR_ADD: 已存在时追加值,不存在时添加,ADD_IF_ABSENT: 仅在 header 不存在时添加,已存在时不做任何操作,OVERWRITE_IF_EXISTS_OR_ADD: 已存在时覆盖值,不存在时添加(默认值),OVERWRITE_IF_EXISTS: 仅在 header 已存在时覆盖值,不存在时不做任何操作
*/
Action?: 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;
}
/**
* DescribeAuthDomains返回参数结构体
*/
export interface DescribeAuthDomainsResponse {
/**
* 安全域名列表
*/
Domains?: Array<AuthDomain>;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* 云主机实例
*/
export interface VmInstance {
/**
* 实例id
*/
InstanceId?: string;
/**
* 实例状态
*/
Status?: string;
/**
* 实例地域
*/
Region?: string;
}
/**
* ModifyClsTopic请求参数结构体
*/
export interface ModifyClsTopicRequest {
/**
* 环境ID
*/
EnvId: string;
/**
* 日志生命周期,单位天,可取值范围1~3600,取值为3640时代表永久保存
*/
Period?: number;
}
/**
* DescribeLoginConfig请求参数结构体
*/
export interface DescribeLoginConfigRequest {
/**
* 环境id
*/
EnvId: string;
}
/**
* CreateHTTPServiceRoute请求参数结构体
*/
export interface CreateHTTPServiceRouteRequest {
/**
* <p>环境ID</p>
*/
EnvId: string;
/**
* <p>域名路由信息</p>
*/
Domain: HTTPServiceDomainParam;
}
/**
* CreateHostingDomain请求参数结构体
*/
export interface CreateHostingDomainRequest {
/**
* 环境ID
*/
EnvId: string;
/**
* 域名
*/
Domain: string;
/**
* 证书ID
*/
CertId: string;
}
/**
* 自定义短信模板中的自定义参数
*/
export interface SMSTemplateParams {
/**
* <p>短信模板的自定义参数的key。如果短信厂商的自定义参数按照命名占位的,才需要此参数;如果按照序号占位的, 不需要此参数。</p><p>腾讯云短信是按照序号占位的,不需要此参数。</p>
注意:此字段可能返回 null,表示取不到有效值。
*/
Key?: string;
/**
* <p>短信模板的自定义参数对应的value</p>
注意:此字段可能返回 null,表示取不到有效值。
*/
Value?: string;
}
/**
* UnbindStorageSource返回参数结构体
*/
export interface UnbindStorageSourceResponse {
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* DescribeCloudAppInfo请求参数结构体
*/
export type DescribeCloudAppInfoRequest = null;
/**
* ModifyLoginConfig请求参数结构体
*/
export interface ModifyLoginConfigRequest {
/**
* 环境 ID,用于指定需要修改登录策略的云开发环境。
*/
EnvId: string;
/**
* 手机号短信登录开关。设置为 true 开启手机号短信登录,允许用户使用手机号和短信验证码进行登录和注册;设置为 false 关闭手机号短信登录。
*/
PhoneNumberLogin: boolean;
/**
* 邮箱登录开关。设置为 true 开启邮箱登录,允许用户使用邮箱和密码进行登录和注册;设置为 false 关闭邮箱登录。
*/
EmailLogin: boolean;
/**
* 用户名密码登录开关。设置为 true 开启用户名密码登录,允许用户使用用户名和密码进行登录和注册;设置为 false 关闭用户名密码登录。
*/
UserNameLogin: boolean;
/**
* 匿名登录开关。设置为 true 开启匿名登录,允许用户无需注册即可以匿名身份访问应用;设置为 false 关闭匿名登录。
*/
AnonymousLogin: boolean;
/**
* 短信验证码发送配置,用于设置短信验证码的发送通道类型和日发送限额。不传则不修改当前配置。
*/
SmsVerificationConfig?: VerificationConfig;
/**
* MFA 多因子认证登录配置,用于设置多因子认证开关及验证方式(短信、邮箱、TOTP、强制绑定手机号)。不传则不修改当前配置。
*/
MfaConfig?: MFALoginConfig;
/**
* 密码更新策略配置,用于设置首次登录强制修改密码和定期强制修改密码策略。不传则不修改当前配置。
*/
PwdUpdateStrategy?: PasswordUpdateLoginConfig;
}
/**
* DeleteCloudApp返回参数结构体
*/
export interface DeleteCloudAppResponse {
/**
* 是否删除成功
*/
Result?: boolean;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* DescribePGUserMigration返回参数结构体
*/
export interface DescribePGUserMigrationResponse {
/**
* <p>版本号</p><p>参数格式:纯数字,14位时间格式</p>
*/
Version?: string;
/**
* <p>版本名</p><p>参数格式:只允许小写字母和下划线</p>
*/
Name?: string;
/**
* <p>要执行的migration sql 语句</p>
*/
Query?: string;
/**
* <p>回滚的sql 语句</p><p>deprecated</p>
*/
Rollback?: string;
/**
* <p>migration query 语句的checksum值,由服务端自动生成,同版本 checksum 不一致会拒绝执行</p><p>deprecated</p>
*/
Checksum?: string;
/**
* <p>用于标记调用来源</p><p>deprecated</p>
*/
Source?: string;
/**
* <p>用于标记该条migration由谁创建,目前默认调用的用户uin</p><p>deprecated</p>
*/
CreatedBy?: string;
/**
* <p>该migration创建时间</p><p>deprecated</p>
*/
CreatedAt?: string;
/**
* <p>该migration应用时间</p><p>deprecated</p>
*/
AppliedAt?: string;
/**
* <p>该migration执行耗时</p><p>单位:毫秒</p><p>deprecated</p>
*/
DurationMs?: number;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* DescribeCloudBaseRunServerVersion返回参数结构体
*/
export interface DescribeCloudBaseRunServerVersionResponse {
/**
* 版本名称
*/
VersionName?: string;
/**
* 备注
*/
Remark?: string;
/**
* Dockerfile的路径
*/
DockerfilePath?: string;
/**
* DockerBuild的目录
*/
BuildDir?: string;
/**
* 请使用CPUSize
*/
Cpu?: number;
/**
* 请使用MemSize
*/
Mem?: number;
/**
* 副本最小值
*/
MinNum?: number;
/**
* 副本最大值
*/
MaxNum?: number;
/**
* 策略类型
*/
PolicyType?: string;
/**
* 策略阈值
*/
PolicyThreshold?: number;
/**
* 环境变量
*/
EnvParams?: string;
/**
* 创建时间
*/
CreatedTime?: string;
/**
* 更新时间
*/
UpdatedTime?: string;
/**
* 版本的IP
*/
VersionIP?: string;
/**
* 版本的端口号
*/
VersionPort?: number;
/**
* 版本状态
*/
Status?: string;
/**
* 代码包的名字
*/
PackageName?: string;
/**
* 代码版本的名字
*/
PackageVersion?: string;
/**
* 枚举(package/repository/image)
*/
UploadType?: string;
/**
* Repo的类型(gitlab/github/coding)
*/
RepoType?: string;
/**
* 地址
*/
Repo?: string;
/**
* 分支
*/
Branch?: string;
/**
* 服务名字
*/
ServerName?: string;
/**
* 是否对于外网开放
*/
IsPublic?: boolean;
/**
* vpc id
*/
VpcId?: string;
/**
* 子网实例id
注意:此字段可能返回 null,表示取不到有效值。
*/
SubnetIds?: Array<string>;
/**
* 日志采集路径
*/
CustomLogs?: string;
/**
* 监听端口
*/
ContainerPort?: number;
/**
* 延迟多长时间开始健康检查(单位s)
*/
InitialDelaySeconds?: number;
/**
* 镜像地址
*/
ImageUrl?: string;
/**
* CPU 大小
*/
CpuSize?: number;
/**
* MEM 大小
*/
MemSize?: number;
/**
* 是否有Dockerfile:0-default has, 1-has, 2-has not
*/
HasDockerfile?: number;
/**
* 基础镜像
*/
BaseImage?: string;
/**
* 容器启动入口命令
*/
EntryPoint?: string;
/**
* 仓库语言
*/
RepoLanguage?: string;
/**
* 自动扩缩容策略组
注意:此字段可能返回 null,表示取不到有效值。
*/
PolicyDetail?: Array<HpaPolicy>;
/**
* Tke集群信息
注意:此字段可能返回 null,表示取不到有效值。
*/
TkeClusterInfo?: TkeClusterInfo;
/**
* 版本工作负载类型;deployment/deamonset
*/
TkeWorkloadType?: string;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* DeleteVmInstance返回参数结构体
*/
export interface DeleteVmInstanceResponse {
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* DescribeGatewayVersions返回参数结构体
*/
export interface DescribeGatewayVersionsResponse {
/**
* 网关id
*/
GatewayId?: string;
/**
* 版本总数
*/
TotalCount?: number;
/**
* 版本信息详情
*/
GatewayVersionItems?: Array<GatewayVersionItem>;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* DescribeGatewayVersions请求参数结构体
*/
export interface DescribeGatewayVersionsRequest {
/**
* 环境id
*/
EnvId: string;
/**
* 网关id
*/
GatewayId: string;
/**
* 版本名
*/
VersionName?: string;
}
/**
* CreateEnvResource请求参数结构体
*/
export interface CreateEnvResourceRequest {
/**
* 环境ID
*/
EnvId: string;
/**
* 资源类型。代表本次开通哪些资源。 可取值以及含义: - log : 表示日志资源,当前仅支持 log(日志资源类型),后续版本可能扩展,该数组不能为空,且每个元素必须为合法的资源类型值
*/
Resources: Array<string>;
}
/**
* DescribeVmInstances请求参数结构体
*/
export interface DescribeVmInstancesRequest {
/**
* 环境ID
*/
EnvId: string;
/**
* 服务器类型: LightHouse = 轻量云服务器 CVM = 云服务器
*/
Type: string;
}
/**
* DescribeHostingDomainTask请求参数结构体
*/
export interface DescribeHostingDomainTaskRequest {
/**
* 环境ID
*/
EnvId: string;
}
/**
* 云应用静态托管配置
*/
export interface StaticConfig {
/**
* 框架类型:vue、react、nextjs 等
注意:此字段可能返回 null,表示取不到有效值。
*/
Framework?: string;
/**
* Node.js 版本,默认 20
注意:此字段可能返回 null,表示取不到有效值。
*/
NodeJsVersion?: string;
/**
* 访问路径
注意:此字段可能返回 null,表示取不到有效值。
*/
AppPath?: string;
/**
* 构建目录
注意:此字段可能返回 null,表示取不到有效值。
*/
BuildPath?: string;
/**
* ZIP 文件地址(BuildType=ZIP/TEMPLATE 时使用)
注意:此字段可能返回 null,表示取不到有效值。
*/
ZipFileUrl?: string;
/**
* COS 时间戳
注意:此字段可能返回 null,表示取不到有效值。
*/
CosTimestamp?: string;
/**
* COS 文件后缀
注意:此字段可能返回 null,表示取不到有效值。
*/
CosSuffix?: string;
/**
* 代码源平台:github、gitlab、gitee
注意:此字段可能返回 null,表示取不到有效值。
*/
CodeSource?: string;
/**
* 代码仓库
注意:此字段可能返回 null,表示取不到有效值。
*/
CodeRepo?: string;
/**
* 代码分支
注意:此字段可能返回 null,表示取不到有效值。
*/
CodeBranch?: string;
/**
* 构建参数 JSON 字符串
注意:此字段可能返回 null,表示取不到有效值。
*/
StaticCmd?: StaticCmd;
/**
* 构建环境变量 JSON 字符串
注意:此字段可能返回 null,表示取不到有效值。
*/
StaticEnv?: StaticEnvironment;
}
/**
* 邮箱登录配置
*/
export interface EmailProviderConfig {
/**
* <p>smtp配置</p>
*/
SmtpConfig?: EmailSmtpConfig;
/**
* <p>可选:TRUE,FALSE,如果On为TRUE,则表示采用默认代发。</p>
*/
On?: string;
/**
* <p>邮件模板配置</p>
注意:此字段可能返回 null,表示取不到有效值。
*/
TemplateConfig?: EmailTemplateConfig;
}
/**
* DestroyEnv请求参数结构体
*/
export interface DestroyEnvRequest {
/**
* 环境Id
*/
EnvId: string;
/**
* 针对预付费 删除隔离中的环境时要传true 正常环境直接跳过隔离期删除
*/
IsForce?: boolean;
/**
* 是否绕过资源检查,资源包等额外资源,默认为false,如果为true,则不检查资源是否有数据,直接删除。
*/
BypassCheck?: boolean;
}
/**
* 查询用户返回结果
*/
export interface DescribeUserListResp {
/**
* 用户总数
*/
Total?: number;
/**
* 用户列表
*/
UserList?: Array<User>;
}
/**
* 云开发新套餐详情
*/
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;
}
/**
* ModifyHTTPServiceRoute请求参数结构体
*/
export interface ModifyHTTPServiceRouteRequest {
/**
* 环境ID
*/
EnvId: string;
/**
* 域名路由信息
*/
Domain: HTTPServiceDomainParam;
}
/**
* DescribeQuotaData返回参数结构体
*/
export interface DescribeQuotaDataResponse {
/**
* 指标名
*/
MetricName?: string;
/**
* 指标的值
*/
Value?: number;
/**
* 指标的附加值信息
*/
SubValue?: string;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* CreateBillDeal返回参数结构体
*/
export interface CreateBillDealResponse {
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* DestroyMySQL返回参数结构体
*/
export interface DestroyMySQLResponse {
/**
* 销毁结果
*/
Data?: DestroyMySQLResult;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* 开通Mysql 结果
*/
export interface CreateMySQLResult {
/**
* 任务ID
*/
TaskId?: string;
}
/**
* CreateCloudApp请求参数结构体
*/
export interface CreateCloudAppRequest {
/**
* <p>环境ID</p>
*/
EnvId: string;
/**
* <p>服务名</p>
*/
ServiceName: string;
/**
* <p>部署类型</p>
*/
DeployType: string;
/**
* <p>构建类型</p>
*/
BuildType?: string;
/**
* <p>静态应用创建配置信息</p>
*/
StaticConfig?: StaticConfig;
/**
* <p>源码定义</p>
*/
Source?: BuildSource;
/**
* <p>Commands 与 CustomSteps 至少填一个</p>
*/
Commands?: BuildCommands;
/**
* <p>Commands 与 CustomSteps 至少填一个,docker 镜像构建场景强烈建议用 CustomSteps</p>
*/
Env?: Array<Variable>;
/**
* <p>非敏感环境变量,构建容器中以 $KEY 引用</p>
*/
CustomSteps?: Array<BuildStep>;
/**
* <p>敏感凭证(AES 加密落库),构建容器中以 $SECRET_NAME 引用</p>
*/
Secrets?: Array<BuildSecret>;
}
/**
* 身份认证源协议连接配置。包含 OAuth 2.0 / OIDC 协议端点(授权端点、令牌端点、用户信息端点、JWKS 端点等)、客户端凭证(ClientId、ClientSecret)、SAML 元数据、请求与响应参数的字段映射等配置信息。OIDC 类型的认证源字段定义参考 https://openid.net/specs/openid-connect-discovery-1_0.html 规范。
*/
export interface ProviderConfig {
/**
* 身份提供方的唯一标识符(Issuer URL),用于验证 ID Token 中的 iss 字段。仅当 ProviderType 为 OIDC 时需要填写,值通常为第三方 OIDC 服务的根地址,例如:https://accounts.google.com。填写后平台将自动通过 /.well-known/openid-configuration 发现并填充 AuthorizationEndpoint、TokenEndpoint、UserinfoEndpoint、JwksUri 等端点地址。详情参考 OpenID Connect Discovery 标准。
注意:此字段可能返回 null,表示取不到有效值。
*/
Issuer?: string;
/**
* 第三方身份提供方的 JSON Web Key Set 地址,用于获取公钥以验证 ID Token 签名。仅当 ProviderType 为 OIDC 时需要填写。若已填写 Issuer,该字段将通过 OpenID Connect Discovery 自动获取,无需手动填写。详情参考 OpenID Connect Discovery 标准。
注意:此字段可能返回 null,表示取不到有效值。
*/
JwksUri?: string;
/**
* 在第三方身份提供方注册的应用客户端 ID,用于标识当前接入应用。当 ProviderType 为 OIDC 或 OAUTH 时必须填写,可在对应平台的开发者控制台中获取。详情参考 OAuth 2.0 标准。
注意:此字段可能返回 null,表示取不到有效值。
*/
ClientId?: string;
/**
* 在第三方身份提供方注册的应用客户端密钥,与 ClientId 配合使用,用于在 Token 端点进行身份验证。当 ProviderType 为 OIDC 或 OAUTH 时必须填写,请妥善保管,避免泄露。详情参考 OAuth 2.0 标准。
注意:此字段可能返回 null,表示取不到有效值。
*/
ClientSecret?: string;
/**
* OAuth 授权完成后第三方平台回调的地址,需与在第三方平台注册的回调地址完全一致,否则授权将失败。当 ProviderType 为 OIDC 或 OAUTH 时必须填写,并需在对应平台的开发者控制台中配置该地址为合法回调地址。详情参考 OAuth 2.0 标准。
注意:此字段可能返回 null,表示取不到有效值。
*/
RedirectUri?: string;
/**
* 向第三方身份提供方申请的权限范围,多个 scope 之间用空格分隔。当 ProviderType 为 OIDC 或 OAUTH 时必须填写,OIDC 场景下通常至少包含 openid,如需获取用户邮箱或手机号可追加 email、phone 等。若已填写 Issuer 且未指定 Scope,将自动使用 OpenID Connect Discovery 返回的 scopes_supported。详情参考 OAuth 2.0 标准。
注意:此字段可能返回 null,表示取不到有效值。
*/
Scope?: string;
/**
* 第三方身份提供方的授权端点地址,用于发起 OAuth/OIDC 授权请求,引导用户跳转至第三方登录页面。当 ProviderType 为 OIDC 或 OAUTH 时必须填写。若已填写 Issuer,该字段将通过 OpenID Connect Discovery 自动获取,无需手动填写。详情参考 OAuth 2.0 / OIDC 标准。
注意:此字段可能返回 null,表示取不到有效值。
*/
AuthorizationEndpoint?: string;
/**
* 第三方身份提供方的 Token 端点地址,用于通过授权码(code)换取 Access Token 和 ID Token。当 ProviderType 为 OIDC 或 OAUTH 时必须填写。若已填写 Issuer,该字段将通过 OpenID Connect Discovery 自动获取,无需手动填写。详情参考 OAuth 2.0 / OIDC 标准。
注意:此字段可能返回 null,表示取不到有效值。
*/
TokenEndpoint?: string;
/**
* 第三方身份提供方的用户信息端点地址,用于通过 Access Token 获取用户的基本信息(如昵称、头像、邮箱等)。当 ProviderType 为 OIDC 或 OAUTH 且需要获取用户详细信息时填写。若已填写 Issuer,该字段将通过 OpenID Connect Discovery 自动获取,无需手动填写。详情参考 OIDC 标准。
注意:此字段可能返回 null,表示取不到有效值。
*/
UserinfoEndpoint?: string;
/**
* OAuth/OIDC 授权请求的响应类型,决定授权端点返回的内容。可选值:code(授权码模式,推荐)、token(隐式模式,直接返回 Access Token)、id_token(直接返回 ID Token)。当 ProviderType 为 OIDC 时默认使用 id_token,其他类型默认使用 code。当 ProviderType 为 OIDC 或 OAUTH 时可选填写。详情参考 OAuth 2.0 / OIDC 标准。
注意:此字段可能返回 null,表示取不到有效值。
*/
ResponseType?: string;
/**
* 第三方身份提供方的单点退出端点地址。配置后,用户退出当前应用时将被跳转至该地址,使第三方 IDP 的登录态也一并失效,实现单点退出(SLO)。适用于 OIDC、OAUTH、SAML 等所有支持单点退出的身份源类型。不填则退出时仅清除本平台登录态。
注意:此字段可能返回 null,表示取不到有效值。
*/
SignoutEndpoint?: string;
/**
* Token 端点的客户端身份验证方式,决定请求 Token 时如何传递 ClientId 和 ClientSecret。可选值:CLIENT_SECRET_POST(将凭证放在请求 Body 中传递)、CLIENT_SECRET_BASIC(将凭证通过 HTTP Basic Auth Header 传递)。当 ProviderType 为 OIDC 或 OAUTH 时可选填写,默认使用 CLIENT_SECRET_POST。详情参考 OIDC 标准。
注意:此字段可能返回 null,表示取不到有效值。
*/
TokenEndpointAuthMethod?: string;
/**
* SAML 身份提供方的 Metadata XML 内容,包含 IDP 的实体 ID、SSO 端点地址、签名证书等关键信息,平台将据此完成 SAML 协议的对接配置。仅当 ProviderType 为 SAML 时可填写,通常可从第三方 IDP 的管理控制台中下载获取。详情参考 SAML 2.0 标准。
*/
SamlMetadata?: string;
/**
* 请求参数映射配置,用于处理非标准 OAuth 协议的参数转换。默认情况下平台严格遵循 OAuth 2.0 标准进行参数传递,若对接的第三方平台(如微信、企业微信等)使用了非标准的参数名称或传参方式,可通过该字段配置自定义的参数映射规则,以确保请求参数与第三方平台的要求一致。
注意:此字段可能返回 null,表示取不到有效值。
*/
RequestParametersMap?: ProviderRequestParametersMap;
/**
* 响应参数映射配置,用于处理非标准 OAuth 协议的响应参数转换。默认情况下平台严格遵循 OAuth 2.0 标准解析响应参数,若对接的第三方平台(如微信、企业微信等)返回了非标准的字段名称或数据结构,可通过该字段配置自定义的响应参数映射规则,将第三方返回的字段映射为平台标准字段。
注意:此字段可能返回 null,表示取不到有效值。
*/
ResponseParametersMap?: ProviderResponseParametersMap;
}
/**
* ModifySafeRule请求参数结构体
*/
export interface ModifySafeRuleRequest {
/**
* 环境ID
*/
EnvId: string;
/**
* 集合名称
*/
CollectionName: string;
/**
* 权限标签。包含以下取值:
<li> READONLY:所有用户可读,仅创建者和管理员可写</li>
<li> PRIVATE:仅创建者及管理员可读写</li>
<li> ADMINWRITE:所有用户可读,仅管理员可写</li>
<li> ADMINONLY:仅管理员可读写</li>
<li> CUSTOM:自定义安全规则</li>
*/
AclTag: string;
/**
* 安全规则内容。
当 AclTag=CUSTOM 时,此参数必填。
详情参考:[文档型数据库安全规则](https://docs.cloudbase.net/database/security-rules)
*/
Rule?: string;
}
/**
* 键值对
*/
export interface KVPair {
/**
* 键
*/
Key: string;
/**
* 值
*/
Value: string;
}
/**
* AllocateEnv请求参数结构体
*/
export interface AllocateEnvRequest {
/**
* <p>分配请求ID,会按这个值做幂等</p><p>入参限制:长度不超过64</p>
*/
AllocateId: string;
/**
* <p>客户平台的应用标识,如果没有则不传</p>
*/
ExternalAppId?: string;
/**
* <p>自定义标签</p><p>参数格式:逗号分隔的 key=value 对,key/value 仅允许字母、数字、下划线。k1=v1,k2=v2</p>
*/
ExternalTag?: string;
/**
* <p>是否需要云函数</p><p>默认值:false</p>
*/
RequireFunction?: boolean;
}
/**
* 函数的信息
*/
export interface FunctionInfo {
/**
* 命名空间
*/
Namespace?: string;
/**
* 所属地域。
当前支持ap-shanghai
*/
Region?: string;
}
/**
* CreateEnv返回参数结构体
*/
export interface CreateEnvResponse {
/**
* <p>自动生成的环境ID</p>
*/
EnvId?: string;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* RunCommands返回参数结构体
*/
export interface RunCommandsResponse {
/**
* 返回结果,返回结果为一个json字符串
注意:此字段可能返回 null,表示取不到有效值。
*/
Data?: Array<string>;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* DescribeTables请求参数结构体
*/
export interface DescribeTablesRequest {
/**
* 分页条件
*/
MgoLimit: number;
/**
* 实例ID
*/
Tag?: string;
/**
* 分页条件
*/
MgoOffset?: number;
/**
* 环境id
*/
EnvId?: string;
/**
* MongoConnector
*/
MongoConnector?: MongoConnector;
/**
* 指定表名过滤,为空时返回所有表
*/
TableNames?: Array<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;
}
/**
* DescribeApiKeyList返回参数结构体
*/
export interface DescribeApiKeyListResponse {
/**
* API Key列表
*/
Data?: Array<ApiKeyToken>;
/**
* 总数
*/
Total?: number;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* DeleteAIModel返回参数结构体
*/
export interface DeleteAIModelResponse {
/**
* <p>成功删除数量</p>
*/
Count?: number;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* ExecutePGSql返回参数结构体
*/
export interface ExecutePGSqlResponse {
/**
* <p>影响行数</p>
*/
AffectedRows?: number;
/**
* <p>字段名列表</p>
注意:此字段可能返回 null,表示取不到有效值。
*/
Columns?: Array<string>;
/**
* <p>数据行。每一行数据都是一个JSON串,将JSON进行反序列化将得到了每列的值。值可能是 null 或者 字符串,如果是 null 说明该列的值为 <null>,如果是字符串则为该列的值的字符串表示形式。</p>
注意:此字段可能返回 null,表示取不到有效值。
*/
Rows?: Array<string>;
/**
* <p>SQL执行耗时</p><p>单位:毫秒</p>
*/
ExecutionTimeMs?: number;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* DescribeCreditsUsage请求参数结构体
*/
export interface DescribeCreditsUsageRequest {
/**
* <p>开始日期</p>
*/
StartDate: string;
/**
* <p>结束日期</p>
*/
EndDate: string;
/**
* <p>环境id</p>
*/
EnvId: string;
}
/**
* 云开发路由限频策略
*/
export interface HTTPServiceRouteQPSPolicy {
/**
* QPS值,每秒请求次数
*/
QPSTotal?: number;
/**
* 客户端限频配置
*/
QPSPerClient?: HTTPServiceQPSPerClient;
}
/**
* CreateUser返回参数结构体
*/
export interface CreateUserResponse {
/**
* 结果返回
*/
Data?: CreateUserResp;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* DescribeEnvAccountCircle请求参数结构体
*/
export interface DescribeEnvAccountCircleRequest {
/**
* 环境ID
*/
EnvId: string;
}
/**
* CreateBillDeal请求参数结构体
*/
export interface CreateBillDealRequest {
/**
* 当前下单的操作类型,可取[purchase,renew,modify]三种值,分别代表新购,续费,变配。
*/
DealType: string;
/**
* 购买的产品类型,可取[tcb-baas,tcb-promotion,tcb-package], 分别代表baas套餐、大促包、资源包
*/
ProductType: string;
/**
* 目标下单产品/套餐Id。
对于云开发环境套餐,可通过 DescribeBaasPackageList 接口获取,对应其出参的PackageName
*/
PackageId: string;
/**
* 默认只下单不支付,为ture则下单并支付。
如果需要下单并支付,请确保账户下有足够的余额,否则会导致下单失败。
*/
CreateAndPay?: boolean;
/**
* 购买时长,与TimeUnit字段搭配使用。
*/
TimeSpan?: number;
/**
* 购买时长单位,按各产品规则可选d(天),m(月),y(年),p(一次性)。
对于 云开发环境的 新购和续费,目前仅支持 按月购买(即 TimeUnit=m)。
*/
TimeUnit?: string;
/**
* 资源唯一标识。
在云开发环境 续费和变配 场景下必传,取值为环境ID。
*/
ResourceId?: string;
/**
* 来源可选[qcloud,miniapp],默认qcloud。
miniapp