UNPKG

tenyun

Version:

Promise based and chained Tencent Cloud OpenAPI client for NodeJS

2,285 lines (2,135 loc) 154 kB
/// <reference types="node" /> import { AxiosPromise, AxiosRequestConfig } from "axios"; /** 活动详情 */ declare interface ActivityRecordItem { /** 用户uin */ Uin?: string; /** 活动id */ ActivityId?: number; /** 自定义状态码 */ Status?: number; /** 自定义子状态码 */ SubStatus?: string; /** 整型子状态码 */ SubStatusInt?: number; /** 是否软删除 */ IsDeleted?: boolean; } /** 合法域名 */ declare interface AuthDomain { /** 域名ID */ Id?: string; /** 域名 */ Domain?: string; /** 域名类型。包含以下取值:SYSTEMUSER */ Type?: string; /** 状态。包含以下取值:ENABLEDISABLE */ Status?: string; /** 创建时间 */ CreateTime?: string; /** 更新时间 */ UpdateTime?: string; } /** 云开发新套餐详情 */ declare 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; } /** 网关服务信息 */ declare interface BackendServiceInfo { /** 服务名称 */ ServiceName: string; /** 服务状态 */ Status: string; } /** 封禁配置 */ declare interface BanConfig { /** ip白名单,支持ipv4、ipv6,支持CIDR */ IpWhiteList?: string[]; /** ip黑名单,支持ipv4、ipv6,支持CIDR */ IpBlackList?: string[]; /** 地域白名单(国家英文名) */ CountryWhiteList?: string[]; /** 地域黑名单(国家英文名) */ CountryBlackList?: string[]; } /** 代码包信息 */ declare interface CbrPackageInfo { /** 代码包名称 */ PackageName?: string; /** 代码包版本 */ PackageVersion?: string; } /** 仓库信息 */ declare interface CbrRepoInfo { /** 仓库名称 */ Repo?: string; /** 仓库平台 */ RepoType?: string; /** 仓库语言 */ RepoLanguage?: string; /** 分支名称 */ Branch?: string; } /** cloudrun安全特性能力 */ declare interface CloudBaseCapabilities { /** 启用安全能力项列表 */ Add?: string[]; /** 禁用安全能力向列表 */ Drop?: string[]; } /** 代码仓库里 Repo的信息描述 */ declare interface CloudBaseCodeRepoDetail { /** repo的名字 */ Name?: CloudBaseCodeRepoName; /** repo的url */ Url?: string; } /** 代码仓库 repo的名字 */ declare interface CloudBaseCodeRepoName { /** repo的名字 */ Name?: string; /** repo的完整全名 */ FullName?: string; } /** es信息 */ declare interface CloudBaseEsInfo { /** es的id */ Id?: number; /** secret名字 */ SecretName?: string; /** ip地址 */ Ip?: string; /** 端口 */ Port?: number; /** 索引 */ Index?: string; /** 用户名 */ Account?: string; /** 密码 */ Password?: string; } /** 云开发项目版本 */ declare interface CloudBaseProjectVersion { /** 项目名 */ Name?: string; /** SAM json */ Sam?: string; /** 来源类型 */ Source?: CodeSource; /** 创建时间, unix时间戳 */ CreateTime?: number; /** 更新时间 ,unix时间戳 */ UpdateTime?: number; /** 项目状态, 枚举值: "creatingEnv"-创建环境中 "createEnvFail"-创建环境失败 "building"-构建中 "buildFail"-构建失败 "deploying"-部署中 "deployFail"-部署失败 "success"-部署成功 */ Status?: string; /** 环境变量 */ Parameters?: KVPair[]; /** 项目类型, 枚举值:"framework-oneclick" 控制台一键部署"framework-local-oneclick" cli本地一键部署"qci-extension-cicd" 内网coding ci cd */ Type?: string; /** ci的id */ CIId?: string; /** cd的id */ CDId?: string; /** 环境id */ EnvId?: string; /** 版本号 */ VersionNum?: number; /** 错误原因 */ FailReason?: string; /** rc.json内容 */ RcJson?: string; /** 插件配置内容 */ AddonConfig?: string; /** 标签 */ Tags?: string[]; /** 网络配置 */ NetworkConfig?: string; /** 扩展id */ ExtensionId?: string; /** 错误类型 */ FailType?: string; /** 私有仓库地址 */ RepoUrl?: string; /** 是否私有仓库代码变更触发自动部署 */ AutoDeployOnCodeChange?: boolean; /** ci部署进度(%) */ BuildPercent?: number; /** Uin */ Uin?: string; /** BuildFinishTime */ BuildFinishTime?: string; /** DeployFinishTime */ DeployFinishTime?: string; /** BuildId */ BuildId?: string; /** SourceUrl */ SourceUrl?: string; /** FailReasonShort */ FailReasonShort?: string; /** FirstInitRepo */ FirstInitRepo?: string; } /** emptydir 数据卷详细信息 */ declare interface CloudBaseRunEmptyDirVolumeSource { /** 启用emptydir数据卷 */ EnableEmptyDirVolume?: boolean; /** "","Memory","HugePages" */ Medium?: string; /** emptydir数据卷大小 */ SizeLimit?: string; } /** 独立网关云托管服务配置信息 */ declare interface CloudBaseRunForGatewayConf { /** 是否缩容到0 */ IsZero: boolean; /** 按百分比灰度的权重 */ Weight: number; /** 按请求/header参数的灰度Key */ GrayKey: string; /** 按请求/header参数的灰度Value */ GrayValue: string; /** 是否为默认版本(按请求/header参数) */ IsDefault: boolean; /** 访问权限,对应二进制分多段,vpc内网|公网|oa */ AccessType: number; /** 访问的URL(域名+路径)列表 */ URLs: string[]; /** 环境ID */ EnvId?: string; /** 服务名称 */ ServerName?: string; /** 版本名称 */ VersionName?: string; /** 灰度类型:FLOW(权重), URL_PARAMS/HEAD_PARAMS */ GrayType?: string; /** CLB的IP:Port */ LbAddr?: string; /** 0:http访问服务配置信息, 1: 服务域名 */ ConfigType?: number; } /** CloudBaseRun 镜像信息 */ declare interface CloudBaseRunImageInfo { /** 镜像仓库名称 */ RepositoryName: string; /** 是否公有 */ IsPublic: boolean; /** 镜像tag名称 */ TagName: string; /** 镜像server */ ServerAddr: string; /** 镜像拉取地址 */ ImageUrl: string; } /** ImageSecretInfo的信息 */ declare interface CloudBaseRunImageSecretInfo { /** 镜像地址 */ RegistryServer?: string; /** 用户名 */ UserName?: string; /** 仓库密码 */ Password?: string; /** 邮箱 */ Email?: string; } /** KV参数的优先级 */ declare interface CloudBaseRunKVPriority { /** 参数的Key */ Key?: string; /** 参数的Value */ Value?: string; /** 优先级 */ Priority?: number; } /** nfs挂载资源 */ declare interface CloudBaseRunNfsVolumeSource { /** NFS挂载Server */ Server?: string; /** Server路径 */ Path?: string; /** 是否只读 */ ReadOnly?: boolean; /** secret名称 */ SecretName?: string; /** 临时目录 */ EnableEmptyDirVolume?: boolean; } /** 版本的列表 */ declare interface CloudBaseRunServerVersionItem { /** 版本名称 */ VersionName?: string; /** 状态 */ Status?: string; /** 流量占比 */ FlowRatio?: number; /** 创建时间 */ CreatedTime?: string; /** 更新时间 */ UpdatedTime?: string; /** 构建ID */ BuildId?: number; /** 构建方式 */ UploadType?: string; /** 备注 */ Remark?: string; /** url中的参数路径 */ UrlParam?: ObjectKV; /** 优先级(数值越小,优先级越高) */ Priority?: number; /** 是否是默认兜底版本 */ IsDefaultPriority?: boolean; /** KV Params */ FlowParams?: CloudBaseRunKVPriority[] | null; /** 最小副本数 */ MinReplicas?: number; /** 最大副本数 */ MaxReplicas?: number; /** 操作记录id */ RunId?: string; /** 进度 */ Percent?: number; /** 当前副本数 */ CurrentReplicas?: number; /** Monolithic,Microservice */ Architecture?: string; } /** 主机路径挂载参数 */ declare interface CloudBaseRunServiceVolumeHostPath { /** 主机路径 */ Path?: string; } /** 对标 EKS VolumeMount */ declare interface CloudBaseRunServiceVolumeMount { /** Volume 名称 */ Name?: string; /** 挂载路径 */ MountPath?: string; /** 是否只读 */ ReadOnly?: boolean; /** 子路径 */ SubPath?: string; /** 传播挂载方式 */ MountPropagation?: string; } /** CloudBaseRun 的 Side 描述定义 */ declare interface CloudBaseRunSideSpec { /** 容器镜像 */ ContainerImage?: string; /** 容器端口 */ ContainerPort?: number; /** 容器的名称 */ ContainerName?: string; /** kv的json字符串 */ EnvVar?: string; /** InitialDelaySeconds 延迟多长时间启动健康检查 */ InitialDelaySeconds?: number; /** CPU大小 */ Cpu?: number; /** 内存大小(单位:M) */ Mem?: number; /** 安全特性 */ Security?: CloudBaseSecurityContext; /** 挂载信息 */ VolumeMountInfos?: CloudBaseRunVolumeMount[]; } /** 版本流量占比 */ declare interface CloudBaseRunVersionFlowItem { /** 版本名称 */ VersionName: string; /** 流量占比 */ FlowRatio?: number; /** 流量参数键值对(URL参数/HEADERS参数) */ UrlParam?: ObjectKV; /** 优先级 */ Priority?: number; /** 是否是默认兜底版本 */ IsDefaultPriority?: boolean; } /** pod信息 */ declare interface CloudBaseRunVersionPod { /** webshell链接 */ Webshell?: string; /** pod name */ PodId?: string; /** pod ip */ PodIp?: string; /** 状态 */ Status?: string; /** 创建时间 */ CreateTime?: string; } /** cfs挂载点 */ declare interface CloudBaseRunVolumeMount { /** 资源名 */ Name?: string; /** 挂载路径 */ MountPath?: string; /** 是否只读 */ ReadOnly?: boolean; /** Nfs挂载信息 */ NfsVolumes?: CloudBaseRunNfsVolumeSource[] | null; /** 挂载配置 */ MountPropagation?: string; } /** vpc信息 */ declare interface CloudBaseRunVpcInfo { /** vpc的id */ VpcId?: string; /** 子网id */ SubnetIds?: string[]; /** 创建类型(0=继承; 1=新建; 2=指定) */ CreateType?: number; } /** 子网信息 */ declare interface CloudBaseRunVpcSubnet { /** 子网id */ Id?: string; /** 子网的ipv4 */ Cidr?: string; /** 可用区 */ Zone?: string; /** 类型 */ Type?: string; /** subnet类型 */ Target?: string; /** 地域 */ Region?: string; /** 名字 */ Name?: string; } /** cloudrun安全特性 */ declare interface CloudBaseSecurityContext { /** 安全特性 */ Capabilities?: CloudBaseCapabilities; } /** CloudRunServiceSimpleVersionSnapshot 信息 */ declare interface CloudRunServiceSimpleVersionSnapshot { /** 版本名 */ VersionName?: string; /** 版本备注 */ Remark?: string; /** cpu规格 */ Cpu?: number; /** 内存规格 */ Mem?: number; /** 最小副本数 */ MinNum?: number; /** 最大副本数 */ MaxNum?: number; /** 镜像url */ ImageUrl?: string; /** 扩容策略 */ PolicyType?: string; /** 策略阈值 */ PolicyThreshold?: number; /** 环境参数 */ EnvParams?: string; /** 容器端口 */ ContainerPort?: number; /** 创建时间 */ CreateTime?: string; /** 更新时间 */ UpdateTime?: string; /** 更新类型 */ UploadType?: string; /** dockerfile路径 */ DockerfilePath?: string; /** 构建路径 */ BuildDir?: string; /** repo类型 */ RepoType?: string; /** 仓库 */ Repo?: string; /** 分支 */ Branch?: string; /** 环境id */ EnvId?: string; /** 服务名 */ ServerName?: string; /** package名字 */ PackageName?: string; /** package版本 */ PackageVersion?: string; /** 自定义log路径 */ CustomLogs?: string; /** 延时健康检查时间 */ InitialDelaySeconds?: number; /** snapshot名 */ SnapshotName?: string; /** 镜像信息 */ ImageInfo?: CloudBaseRunImageInfo; /** 代码仓库信息 */ CodeDetail?: CloudBaseCodeRepoDetail; /** 状态 */ Status?: string; } /** 服务的volume */ declare interface CloudRunServiceVolume { /** 名称 */ Name?: string; /** NFS的挂载方式 */ NFS?: CloudBaseRunNfsVolumeSource; /** secret名称 */ SecretName?: string; /** 是否开启临时目录逐步废弃,请使用 EmptyDir */ EnableEmptyDirVolume?: boolean; /** emptydir数据卷详细信息 */ EmptyDir?: CloudBaseRunEmptyDirVolumeSource; /** 主机路径挂载信息 */ HostPath?: CloudBaseRunServiceVolumeHostPath; } /** cls日志信息 */ declare interface ClsInfo { /** cls所属地域 */ ClsRegion: string; /** cls日志集ID */ ClsLogsetId: string; /** cls日志主题ID */ ClsTopicId: string; /** 创建时间 */ CreateTime: string; } /** 云开发项目来源 */ declare interface CodeSource { /** 类型, 可能的枚举: "coding","package","package_url","github","gitlab","gitee","rawcode" */ Type?: string; /** 下载链接 */ Url?: string; /** 名称 */ Name?: string; /** 工作目录 */ WorkDir?: string; /** code包名, type为coding的时候需要填写 */ CodingPackageName?: string; /** coding版本名, type为coding的时候需要填写 */ CodingPackageVersion?: string; /** 源码 */ RawCode?: string; /** 代码分支 */ Branch?: string; /** coding项目ID,type为coding时需要填写 */ ProjectId?: number; /** coding项目 */ ProjectName?: string; } /** 安全网关自定义头部 */ declare interface CustomHeader { /** 请求添加头部配置 */ RequestToAddList?: CustomRequestToAdd[]; } /** 安全网关自定义日志配置 */ declare interface CustomLogConfig { /** 是否需要请求体 */ NeedReqBodyLog?: boolean; /** 是否需要请求头 */ NeedReqHeaderLog?: boolean; /** 是否需要回包体 */ NeedRspBodyLog?: boolean; /** 是否需要回包头部信息 */ NeedRspHeaderLog?: boolean; /** cls set信息 */ LogSetId?: string; /** cls topicId */ LogTopicId?: string; } /** 安全网关请求自定义头部 */ declare interface CustomRequestToAdd { /** Header名称 */ Key?: string; /** Header值 */ Value?: string; /** Header类型 */ AppendAction?: string; } /** 数据库资源信息 */ declare interface DatabasesInfo { /** 数据库唯一标识 */ InstanceId?: string; /** 状态。包含以下取值:INITIALIZING:资源初始化中RUNNING:运行中,可正常使用的状态UNUSABLE:禁用,不可用OVERDUE:资源过期 */ Status?: string; /** 所属地域。当前支持ap-shanghai */ Region?: string; /** 更新时间 */ UpdateTime?: string; } /** 终端用户信息 */ declare interface EndUserInfo { /** 用户唯一ID */ UUId?: string; /** 微信ID */ WXOpenId?: string; /** qq ID */ QQOpenId?: string; /** 手机号 */ Phone?: string; /** 邮箱 */ Email?: string; /** 昵称 */ NickName?: string; /** 性别 */ Gender?: string; /** 头像地址 */ AvatarUrl?: string; /** 更新时间 */ UpdateTime?: string; /** 创建时间 */ CreateTime?: string; /** 是否为匿名用户 */ IsAnonymous?: boolean; /** 是否禁用账户 */ IsDisabled?: boolean; /** 是否设置过密码 */ HasPassword?: boolean; /** 用户名 */ UserName?: string; } /** 环境计费信息 */ declare interface EnvBillingInfoItem { /** 环境ID */ EnvId?: string; /** tcb产品套餐ID,参考DescribePackages接口的返回值。 */ PackageId?: string; /** 自动续费标记 */ IsAutoRenew?: boolean; /** 状态。包含以下取值: 空字符串:初始化中 NORMAL:正常 ISOLATE:隔离 */ Status?: string; /** 支付方式。包含以下取值: PREPAYMENT:预付费 POSTPAID:后付费 */ PayMode?: string; /** 隔离时间,最近一次隔离的时间 */ IsolatedTime?: string; /** 过期时间,套餐即将到期的时间 */ ExpireTime?: string; /** 创建时间,第一次接入计费方案的时间。 */ CreateTime?: string; /** 更新时间,计费信息最近一次更新的时间。 */ UpdateTime?: string; /** true表示从未升级过付费版。 */ IsAlwaysFree?: boolean; /** 付费渠道。 miniapp:小程序 qcloud:腾讯云 */ PaymentChannel?: string; /** 最新的订单信息 */ OrderInfo?: OrderInfo; /** 免费配额信息。 */ FreeQuota?: string; /** 是否开启 `超过套餐额度部分转按量付费` */ EnableOverrun?: boolean; /** 环境套餐类型 */ ExtPackageType?: string; /** 是否付费期环境,可取值:yes/no。 */ EnvCharged?: string; /** 是否已激活,可取值:yes/no。 */ EnvActivated?: string; } /** 环境信息 */ declare interface EnvInfo { /** 账户下该环境唯一标识 */ EnvId?: string; /** 环境来源。包含以下取值:miniapp:微信小程序qcloud :腾讯云 */ Source?: string; /** 环境别名,要以a-z开头,不能包含 a-zA-z0-9- 以外的字符 */ Alias?: string; /** 创建时间 */ CreateTime?: string; /** 最后修改时间 */ UpdateTime?: string; /** 环境状态。包含以下取值:NORMAL:正常可用UNAVAILABLE:服务不可用,可能是尚未初始化或者初始化过程中 */ Status?: string; /** 数据库列表 */ Databases?: DatabasesInfo[]; /** 存储列表 */ Storages?: StorageInfo[]; /** 函数列表 */ Functions?: FunctionInfo[]; /** tcb产品套餐ID,参考DescribePackages接口的返回值。 */ PackageId?: string; /** 套餐中文名称,参考DescribePackages接口的返回值。 */ PackageName?: string; /** 云日志服务列表 */ LogServices?: LogServiceInfo[]; /** 静态资源信息 */ StaticStorages?: StaticStorageInfo[]; /** 是否到期自动降为免费版 */ IsAutoDegrade?: boolean; /** 环境渠道 */ EnvChannel?: string; /** 支付方式。包含以下取值: prepayment:预付费 postpaid:后付费 */ PayMode?: string; /** 是否为默认环境 */ IsDefault?: boolean; /** 环境所属地域 */ Region?: string; /** 环境标签列表 */ Tags?: Tag[]; /** 自定义日志服务 */ CustomLogServices?: ClsInfo[]; /** 环境类型:baas, run, hoting, weda */ EnvType?: string; /** 是否是dau新套餐 */ IsDauPackage?: boolean; /** 套餐类型:空\baas\tcbr */ PackageType?: string; /** 架构类型 */ ArchitectureType?: string; /** 回收标志,默认为空 */ Recycle?: string; } /** 扩展文件 */ declare interface ExtensionFile { /** 文件类型。枚举值FUNCTION:函数代码STATIC:静态托管代码SMS:短信文件 */ FileType: string; /** 文件名,长度不超过24 */ FileName: string; } /** 扩展文件信息 */ declare interface ExtensionFileInfo { /** 模板里使用的地址 */ CodeUri: string; /** 上传文件的临时地址,含签名 */ UploadUrl: string; /** 自定义密钥。如果为空,则表示不需要加密。参考cos预签名url上传https://cloud.tencent.com/document/product/436/36121上传的时候要按照 SSE-C 的方式设置header:https://cloud.tencent.com/document/product/436/7728 */ CustomKey: string; /** 文件大小限制,单位M,客户端上传前需要主动检查文件大小,超过限制的文件会被删除。 */ MaxSize: number; } /** 后付费资源免费量信息 */ declare interface FreequotaInfo { /** 资源类型COSCDNFLEXDBSCF */ ResourceType?: string; /** 资源指标名称 */ ResourceMetric?: string; /** 资源指标免费量 */ FreeQuota?: number; /** 指标单位 */ MetricUnit?: string; /** 免费量抵扣周期sum-month:以月为单位抵扣sum-day:以天为单位抵扣totalize:总容量抵扣 */ DeductType?: string; /** 免费量类型basic:通用量抵扣 */ FreeQuotaType?: string; } /** 安全网关版本路由信息限额配置 */ declare interface FrequencyLimitConfig { /** 限额对象 "ConnectionsLimit" 或 "QPSLimit" */ LimitObject?: string; /** 限额配置 */ LimitConfig?: string; } /** 函数的信息 */ declare interface FunctionInfo { /** 命名空间 */ Namespace?: string; /** 所属地域。当前支持ap-shanghai */ Region?: string; } /** 网关信息 */ declare interface GatewayItem { /** 用户uin */ Uin?: string; /** 用户appid */ AppId?: number; /** WxAppId */ WxAppId?: string; /** 环境id */ EnvId?: string; /** Gateway唯一id */ GatewayId?: string; /** Gateway名称 */ GatewayName?: string; /** Gateway类型 */ GatewayType?: string; /** Gateway描述 */ GatewayDesc?: string; /** 套餐版本 */ PackageVersion?: string; /** 套餐唯一id */ PackageId?: number; /** vpc唯一id */ VpcId?: string; /** 子网id */ SubnetIds?: string[]; /** 网关状态 */ Status?: string; /** l5地址 */ L5Addr?: string; /** 地域 */ Region?: string; /** 是否可以续费 */ CanRenew?: boolean; /** 自动续费标志 */ AutoRenewFlag?: number; /** 隔离时间 */ IsolateTime?: string; /** 到期时间 */ ExpireTime?: string; /** 创建时间 */ CreateTime?: string; /** 变更时间 */ UpdateTime?: string; /** 是否可以降配 */ CanDowngrade?: boolean; /** 允许未登录访问 */ AllowUncertified?: number; /** 网关版本限额 */ VersionNumLimit?: number; /** Donut接入ID */ LongAccessId?: string; /** Donut接入域名 */ AccessDomain?: string; /** 标签键值对 */ Tags?: Tag[]; } /** 网关版本详情 */ declare interface GatewayVersionItem { /** 版本名 */ VersionName: string; /** 版本流量权重 */ Weight: number; /** 创建状态 */ Status?: string; /** 创建时间 */ CreatedTime?: string; /** 更新时间 */ UpdatedTime?: string; /** 构建ID */ BuildId?: number; /** 备注 */ Remark?: string; /** 优先级 */ Priority?: number; /** 是否默认版本 */ IsDefault?: boolean; /** 网关版本自定义配置 */ CustomConfig?: WxGatewayCustomConfig; } /** 扩缩容策略 */ declare interface HpaPolicy { /** 策略类型 */ PolicyType?: string; /** 策略阈值 */ PolicyThreshold?: number; } /** 键值对 */ declare interface KVPair { /** 键 */ Key: string; /** 值 */ Value: string; } /** CLS日志单条信息 */ declare interface LogObject { /** 日志属于的 topic ID */ TopicId?: string; /** 日志主题的名字 */ TopicName?: string; /** 日志时间 */ Timestamp?: string; /** 日志内容 */ Content?: string; /** 采集路径 */ FileName?: string; /** 日志来源设备 */ Source?: string; } /** CLS日志结果 */ declare interface LogResObject { /** 获取更多检索结果的游标 */ Context?: string; /** 搜索结果是否已经全部返回 */ ListOver?: boolean; /** 日志内容信息 */ Results?: LogObject[]; } /** 云日志服务相关信息 */ declare interface LogServiceInfo { /** log名 */ LogsetName?: string; /** log-id */ LogsetId?: string; /** topic名 */ TopicName?: string; /** topic-id */ TopicId?: string; /** cls日志所属地域 */ Region?: string; /** topic保存时长 默认7天 */ Period?: number; } /** 终端用户登录新增统计 */ declare interface LoginStatistic { /** 统计类型 新增NEWUSER 和登录 LOGIN */ StatisticalType?: string; /** 统计周期:日DAY,周WEEK,月MONTH */ StatisticalCycle?: string; /** 统计总量 */ Count?: number; /** 更新时间 */ UpdateTime?: string; } /** Key-Value类型,模拟的 object 类型 */ declare interface ObjectKV { /** object 的 key */ Key?: string; /** object key 对应的 value */ Value?: string; } /** 一键部署步骤信息 */ declare interface OneClickTaskStepInfo { /** 未启动:"todo"运行中:"running"失败:"failed"成功结束:"finished" */ Status?: string; /** 开始时间 */ StartTime?: string; /** 结束时间 */ EndTime?: string; /** 耗时:秒 */ CostTime?: number; /** 失败原因 */ FailReason?: string; /** 步骤名 */ Name?: string; } /** 订单信息 */ declare interface OrderInfo { /** 订单号 */ TranId?: string; /** 订单要切换的套餐ID */ PackageId?: string; /** 订单类型1 购买2 续费3 变配 */ TranType?: string; /** 订单状态。1未支付2 支付中3 发货中4 发货成功5 发货失败6 已退款7 已取消100 已删除 */ TranStatus?: string; /** 订单更新时间 */ UpdateTime?: string; /** 订单创建时间 */ CreateTime?: string; /** 付费模式.prepayment 预付费postpaid 后付费 */ PayMode?: string; /** 订单绑定的扩展ID */ ExtensionId?: string; /** 资源初始化结果(仅当ExtensionId不为空时有效): successful(初始化成功), failed(初始化失败), doing(初始化进行中), init(准备初始化) */ ResourceReady?: string; /** 安装标记。建议使用方统一转大小写之后再判断。QuickStart:快速启动来源Activity:活动来源 */ Flag?: string; /** 下单时的参数 */ ReqBody?: string; } /** 后付费免费额度 */ declare interface PackageFreeQuotaInfo { /** 资源类型COSCDNFLEXDBSCF */ ResourceType?: string; /** 资源指标名称 */ ResourceMetric?: string; /** 资源指标免费量 */ FreeQuota?: number; /** 指标单位 */ MetricUnit?: string; /** 免费量抵扣周期sum-month:以月为单位抵扣sum-day:以天为单位抵扣totalize:总容量抵扣 */ DeductType?: string; /** 免费量类型basic:通用量抵扣 */ FreeQuotaType?: string; } /** 终端用户平台统计信息 */ declare interface PlatformStatistic { /** 终端用户从属平台 */ Platform?: string; /** 平台终端用户数 */ Count?: number; /** 更新时间 */ UpdateTime?: string; } /** 后付费计费详情 */ declare interface PostPaidEnvDeductInfo { /** 资源方 */ ResourceType?: string; /** 指标名 */ MetricName?: string; /** 按量计费详情 */ ResQuota?: number; /** 资源包抵扣详情 */ PkgQuota?: number; /** 免费额度抵扣详情 */ FreeQuota?: number; /** 环境id */ EnvId?: string; } /** 按量付费免费配额信息 */ declare interface PostpayEnvQuota { /** 资源类型 */ ResourceType?: string; /** 指标名 */ MetricName?: string; /** 配额值 */ Value?: number; /** 配额生效时间为空表示没有时间限制 */ StartTime?: string; /** 配额失效时间为空表示没有时间限制 */ EndTime?: string; } /** 短信免费量 */ declare interface SmsFreeQuota { /** 免费量总条数 */ FreeQuota?: number; /** 共计已使用总条数 */ TotalUsedQuota?: number; /** 免费周期起点,0000-00-00 00:00:00 形式 */ CycleStart?: string; /** 免费周期终点,0000-00-00 00:00:00 形式 */ CycleEnd?: string; /** 今天已使用总条数 */ TodayUsedQuota?: number; } /** 1分钱计费详情 */ declare interface SpecialCostItem { /** 上报日期 */ ReportDate?: string; /** 腾讯云uin */ Uin?: string; /** 资源id:环境id */ EnvId?: string; /** 上报任务状态 */ Status?: string; } /** 独立网关信息 */ declare interface StandaloneGatewayInfo { /** 独立网关名称 */ GatewayName: string; /** CPU核心数 */ CPU: number; /** 内存大小,单位MB */ Mem: number; /** 套餐包版本名称 */ PackageVersion: string; /** 网关别名 */ GatewayAlias: string; /** 私有网络ID */ VpcId: string; /** 子网ID列表 */ SubnetIds: string[]; /** 网关描述 */ GatewayDesc: string; /** 网关状态 */ GateWayStatus: string; /** 服务信息 */ ServiceInfo: BackendServiceInfo; /** 公网CLBIP */ PublicClbIp: string; /** 内网CLBIP */ InternalClbIp: string; } /** 小租户网关套餐配置 */ declare interface StandaloneGatewayPackageInfo { /** CPU核心数 */ CPU: number; /** 内存大小,单位MB */ Mem: number; /** 套餐包版本名称 */ PackageVersion: string; } /** 静态CDN资源信息 */ declare interface StaticStorageInfo { /** 静态CDN域名 */ StaticDomain?: string; /** 静态CDN默认文件夹,当前为根目录 */ DefaultDirName?: string; /** 资源状态(process/online/offline/init) */ Status?: string; /** cos所属区域 */ Region?: string; /** bucket信息 */ Bucket?: string; } /** StorageInfo 资源信息 */ declare interface StorageInfo { /** 资源所属地域。当前支持ap-shanghai */ Region?: string; /** 桶名,存储资源的唯一标识 */ Bucket?: string; /** cdn 域名 */ CdnDomain?: string; /** 资源所属用户的腾讯云appId */ AppId?: string; } /** 标签键值对 */ declare interface Tag { /** 标签键 */ Key: string; /** 标签值 */ Value: string; } /** tke集群信息 */ declare interface TkeClusterInfo { /** 集群ID */ ClusterId?: string; /** 集群的vpcId */ VpcId?: string; /** 版本内网CLB所在子网Id */ VersionClbSubnetId?: string; } /** 安全网关自定义配置 */ declare 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; } /** 安全网关路由 */ declare interface WxGatewayRountItem { /** 安全网关路由名称 */ GatewayRouteName?: string; /** 安全网关路由协议 */ GatewayRouteProtocol?: string; /** 安全网关路由地址 */ GatewayRouteAddr?: string; /** 安全网关路由描述 */ GatewayRouteDesc?: string; /** 安全网关后端集群id,如果是外网服务,该id与GatewayRountName相同 */ GatewayRouteClusterId?: string; /** 安全网关创建时间 */ GatewayRouteCreateTime?: string; /** 安全网关路由限制 */ FrequencyLimitConfig?: FrequencyLimitConfig[]; /** ip代表绑定后端ip。cbr代表云托管服务 */ GatewayRouteServerType?: string; /** 服务名 */ GatewayRouteServerName?: string; /** ip */ GatewayRewriteHost?: string; /** 网关版本 */ GatewayVersion?: string; /** 请求路径 */ GatewayRoutePath?: string; /** 请求模式 */ GatewayRouteMethod?: string; /** 4层端口 */ GatewayRoutePort?: number; /** 路由环境ID */ GatewayRouteEnvId?: string; /** 路径匹配类型,支持prefix(前缀匹配),regex(正则匹配), 默认prefix */ GatewayRoutePathMatchType?: string; /** 安全网关自定义头部 */ CustomHeader?: CustomHeader; } declare interface BindEnvGatewayRequest { /** 子环境id */ SubEnvId: string; } declare interface BindEnvGatewayResponse { /** 唯一请求 ID,每次请求都会返回。 */ RequestId?: string; } declare interface CheckTcbServiceRequest { } declare interface CheckTcbServiceResponse { /** true表示已开通 */ Initialized?: boolean; /** 唯一请求 ID,每次请求都会返回。 */ RequestId?: string; } declare interface CommonServiceAPIRequest { /** Service名,需要转发访问的接口名 */ Service: string; /** 需要转发的云API参数,要转成JSON格式 */ JSONData?: string; /** 指定角色 */ ApiRole?: string; } declare interface CommonServiceAPIResponse { /** json格式response */ JSONResp?: string; /** 唯一请求 ID,每次请求都会返回。 */ RequestId?: string; } declare interface CreateAndDeployCloudBaseProjectRequest { /** 项目名 */ Name: string; /** 来源 */ Source: CodeSource; /** 环境id */ EnvId?: string; /** 项目类型, 枚举值为: framework-oneclick,qci-extension-cicd */ Type?: string; /** 环境变量 */ Parameters?: KVPair[]; /** 环境别名。要以a-z开头,不能包含a-zA-z0-9-以外的字符 */ EnvAlias?: string; /** rc.json的内容 */ RcJson?: string; /** 插件配置内容 */ AddonConfig?: string; /** 标签 */ Tags?: string[]; /** 网络配置 */ NetworkConfig?: string; /** 用户享有的免费额度级别,目前只能为“basic”,不传该字段或该字段为空,标识不享受免费额度。 */ FreeQuota?: string; /** 是否代码变更触发自动部署 */ AutoDeployOnCodeChange?: boolean; /** 私有仓库地址 */ RepoUrl?: string; } declare interface CreateAndDeployCloudBaseProjectResponse { /** 环境Id */ EnvId?: string; /** 唯一请求 ID,每次请求都会返回。 */ RequestId?: string; } declare interface CreateAuthDomainRequest { /** 环境ID */ EnvId: string; /** 安全域名 */ Domains: string[]; } declare interface CreateAuthDomainResponse { /** 唯一请求 ID,每次请求都会返回。 */ RequestId?: string; } declare interface CreateCloudBaseRunResourceRequest { /** 环境ID */ EnvId: string; /** vpc的ID */ VpcId?: string; /** 子网ID列表,当VpcId不为空,SubnetIds也不能为空 */ SubnetIds?: string[]; } declare interface CreateCloudBaseRunResourceResponse { /** 返回集群创建是否成功 succ为成功。并且中间无err */ Result?: string; /** 唯一请求 ID,每次请求都会返回。 */ RequestId?: string; } declare interface CreateCloudBaseRunServerVersionRequest { /** 环境ID */ EnvId: string; /** 枚举(package/repository/image/jar/war) */ UploadType: string; /** 流量占比 */ FlowRatio: number; /** Cpu的大小,单位:核 */ Cpu: number; /** Mem的大小,单位:G */ Mem: number; /** 最小副本数,最小值:0 */ MinNum: number; /** 副本最大数,最大值:50 */ MaxNum: number; /** 策略类型(枚举值:比如cpu) */ PolicyType: string; /** 策略阈值 */ PolicyThreshold: number; /** 服务端口 */ ContainerPort: number; /** 服务名称 */ ServerName: string; /** repository的类型(coding/gitlab/github/coding) */ RepositoryType?: string; /** Dockerfile地址 */ DockerfilePath?: string; /** 构建目录 */ BuildDir?: string; /** 环境变量 */ EnvParams?: string; /** repository地址 */ Repository?: string; /** 分支 */ Branch?: string; /** 版本备注 */ VersionRemark?: string; /** 代码包名字 */ PackageName?: string; /** 代码包的版本 */ PackageVersion?: string; /** Image的详情 */ ImageInfo?: CloudBaseRunImageInfo; /** Github等拉取代码的详情 */ CodeDetail?: CloudBaseCodeRepoDetail; /** 私有镜像秘钥信息 */ ImageSecretInfo?: CloudBaseRunImageSecretInfo; /** 私有镜像 认证名称 */ ImagePullSecret?: string; /** 用户自定义采集日志路径 */ CustomLogs?: string; /** 延迟多长时间开始健康检查(单位s) */ InitialDelaySeconds?: number; /** cfs挂载信息 */ MountVolumeInfo?: CloudBaseRunVolumeMount[]; /** 4 代表只能微信链路访问 */ AccessType?: number; /** es信息 */ EsInfo?: CloudBaseEsInfo; /** 是否使用统一域名 */ EnableUnion?: boolean; /** 操作备注 */ OperatorRemark?: string; /** 服务路径 */ ServerPath?: string; /** 镜像复用的key */ ImageReuseKey?: string; /** 容器的描述文件 */ SidecarSpecs?: CloudBaseRunSideSpec[]; /** 安全特性 */ Security?: CloudBaseSecurityContext; /** 服务磁盘挂载 */ ServiceVolumes?: CloudRunServiceVolume[]; /** 是否创建JnsGw 0未传默认创建 1创建 2不创建 */ IsCreateJnsGw?: number; /** 数据卷挂载参数 */ ServiceVolumeMounts?: CloudBaseRunServiceVolumeMount[]; /** 是否有Dockerfile:0-default has, 1-has, 2-has not */ HasDockerfile?: number; /** 基础镜像 */ BaseImage?: string; /** 容器启动入口命令 */ EntryPoint?: string; /** 仓库语言 */ RepoLanguage?: string; /** 用户实际上传文件名(仅UploadType为jar/war时必填) */ UploadFilename?: string; /** 自动扩缩容策略组 */ PolicyDetail?: HpaPolicy[]; } declare interface CreateCloudBaseRunServerVersionResponse { /** 状态(creating/succ) */ Result?: string; /** 版本名称(只有Result为succ的时候,才会返回VersionName) */ VersionName?: string; /** 操作记录id */ RunId?: string; /** 唯一请求 ID,每次请求都会返回。 */ RequestId?: string; } declare interface CreateHostingDomainRequest { /** 环境ID */ EnvId: string; /** 域名 */ Domain: string; /** 证书ID */ CertId: string; } declare interface CreateHostingDomainResponse { /** 唯一请求 ID,每次请求都会返回。 */ RequestId?: string; } declare interface CreatePostpayPackageRequest { /** 环境ID,需要系统自动创建环境时,此字段不传 */ EnvId?: string; /** 微信 AppId,微信必传 */ WxAppId?: string; /** 付费来源miniappqcloud */ Source?: string; /** 用户享有的免费额度级别,目前只能为“basic”,不传该字段或该字段为空,表示不享受免费额度。 */ FreeQuota?: string; /** 环境创建来源,取值:miniappqcloud用法同CreateEnv接口的Source参数和 Channel 参数同时传,或者同时不传;EnvId 为空时必传。 */ EnvSource?: string; /** 环境别名,要以a-z开头,不能包含 a-z,0-9,- 以外的字符 */ Alias?: string; /** 如果envsource为miniapp, channel可以为ide或api;如果envsource为qcloud, channel可以为qc_console,cocos, qq, cloudgame,dcloud,serverless_framework和 EnvSource 参数同时传,或者同时不传;EnvId 为空时必传。 */ Channel?: string; /** 扩展ID */ ExtensionId?: string; /** 订单标记。建议使用方统一转大小写之后再判断。QuickStart:快速启动来源Activity:活动来源 */ Flag?: string; /** 环境别名,无字符类型限制 */ EnvAlias?: string; /** 附加字段,用于透传额外的自定义信息 */ Extra?: string; } declare interface CreatePostpayPackageResponse { /** 后付费订单号 */ TranId?: string; /** 环境ID */ EnvId?: string; /** 唯一请求 ID,每次请求都会返回。 */ RequestId?: string; } declare interface CreateStandaloneGatewayRequest { /** 环境ID */ EnvId: string; /** 网关名 */ GatewayAlias: string; /** 私有网络ID */ VpcId: string; /** 子网ID */ SubnetIds: string[]; /** 网关描述 */ GatewayDesc: string; /** 网关套餐版本 */ PackageVersion: string; } declare interface CreateStandaloneGatewayResponse { /** 网关名称 */ GatewayName: string; /** 唯一请求 ID,每次请求都会返回。 */ RequestId?: string; } declare interface CreateStaticStoreRequest { /** 环境ID */ EnvId: string; /** 是否启用统一域名 */ EnableUnion?: boolean; } declare interface CreateStaticStoreResponse { /** 创建静态资源结果(succ/fail) */ Result?: string; /** 唯一请求 ID,每次请求都会返回。 */ RequestId?: string; } declare interface CreateWxCloudBaseRunEnvRequest { /** wx应用Id */ WxAppId: string; /** 环境别名,要以a-z开头,不能包含 a-z,0-9,- 以外的字符 */ Alias?: string; /** 用户享有的免费额度级别,目前只能为“basic”,不传该字段或该字段为空,标识不享受免费额度。 */ FreeQuota?: string; /** 订单标记。建议使用方统一转大小写之后再判断。QuickStart:快速启动来源Activity:活动来源 */ Flag?: string; /** 私有网络Id */ VpcId?: string; /** 子网列表 */ SubNetIds?: string[]; /** 是否打开云调用 */ IsOpenCloudInvoke?: boolean; /** 创建来源:wechat | cloud */ Source?: string; /** 渠道:wechat | cloud */ Channel?: string; } declare interface CreateWxCloudBaseRunEnvResponse { /** 环境Id */ EnvId?: string; /** 后付费订单号 */ TranId?: string; /** 唯一请求 ID,每次请求都会返回。 */ RequestId?: string; } declare interface CreateWxCloudBaseRunServerDBClusterRequest { /** 账户密码 */ AccountPassword: string; /** 环境ID */ EnvId: string; /** 微信appid */ WxAppId?: string; /** mysql内核版本,支持5.7,8.0 */ DbVersion?: string; /** 0: 大小写敏感1: 非大小写敏感默认为0 */ LowerCaseTableName?: string; } declare interface CreateWxCloudBaseRunServerDBClusterResponse { /** 唯一请求 ID,每次请求都会返回。 */ RequestId?: string; } declare interface DeleteCloudBaseProjectLatestVersionRequest { /** 环境id */ EnvId: string; /** 项目名 */ ProjectName: string; /** 是否保留资源 */ KeepResource?: boolean; } declare interface DeleteCloudBaseProjectLatestVersionResponse { /** 唯一请求 ID,每次请求都会返回。 */ RequestId?: string; } declare interface DeleteCloudBaseRunServerVersionRequest { /** 环境ID */ EnvId: string; /** 服务名称 */ ServerName: string; /** 版本名称 */ VersionName: string; /** 是否删除服务,只有最后一个版本的时候,才生效。 */ IsDeleteServer?: boolean; /** 只有删除服务的时候,才会起作用 */ IsDeleteImage?: boolean; /** 操作备注 */ OperatorRemark?: string; /** 延迟删除版本时间 */ DelayedDeletionTime?: number; } declare interface DeleteCloudBaseRunServerVersionResponse { /** 返回结果,succ为成功 */ Result?: string; /** 唯一请求 ID,每次请求都会返回。 */ RequestId?: string; } declare interface DeleteEndUserRequest { /** 环境ID */ EnvId: string; /** 用户列表,每一项都是uuid */ UserList: string[]; } declare interface DeleteEndUserResponse { /** 唯一请求 ID,每次请求都会返回。 */ RequestId?: string; } declare interface DeleteGatewayVersionRequest { /** 环境id */ EnvId: string; /** 网关id */ GatewayId: string; /** 版本名 */ VersionName: string; /** 是否删除服务 */ IsDeleteServer?: boolean; /** 是否删除镜像 */ IsDeleteImage?: boolean; /** 是否强制删除 */ IsForce?: boolean; /** 操作者记录 */ OperatorRemark?: string; } declare interface DeleteGatewayVersionResponse { /** 删除结果 */ Result?: string; /** 唯一请求 ID,每次请求都会返回。 */ RequestId?: string; } declare interface DeleteWxGatewayRouteRequest { /** 环境id */ EnvId: string; /** 服务名称 */ GatewayRouteName: string; } declare interface DeleteWxGatewayRouteResponse { /** 唯一请求 ID,每次请求都会返回。 */ RequestId?: string; } declare interface DescribeActivityRecordRequest { /** 渠道加密token */ ChannelToken: string; /** 渠道来源,每个来源对应不同secretKey */ Channel: string; /** 活动id列表 */ ActivityIdList?: number[]; /** 过滤状态码,已废弃 */ Status?: number; /** 状态码过滤数组,空数组时不过滤 */ Statuses?: number[]; /** 根据是否软删除进行过滤,[0]未删除, [1] 删除,不传不过滤 */ IsDeletedList?: number[]; } declare interface DescribeActivityRecordResponse { /** 活动记录详情 */ ActivityRecords?: ActivityRecordItem[]; /** 唯一请求 ID,每次请求都会返回。 */ RequestId?: string; } declare interface DescribeAuthDomainsRequest { /** 环境ID */ EnvId: string; } declare interface DescribeAuthDomainsResponse { /** 安全域名列表 */ Domains?: AuthDomain[]; /** 唯一请求 ID,每次请求都会返回。 */ RequestId?: string; } declare 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?: string[]; /** 付费渠道,与回包billTags中的计费参数相关,不填返回默认值。 */ PaymentChannel?: string; } declare interface DescribeBaasPackageListResponse { /** 套餐列表 */ PackageList?: BaasPackageInfo[]; /** 唯一请求 ID,每次请求都会返回。 */ RequestId?: string; } declare interface DescribeBillingInfoRequest { /** 环境ID */ EnvId?: string; } declare interface DescribeBillingInfoResponse { /** 环境计费信息列表 */ EnvBillingInfoList?: EnvBillingInfoItem[]; /** 唯一请求 ID,每次请求都会返回。 */ RequestId?: string; } declare interface DescribeCbrServerVersionRequest { /** 环境ID */ EnvId: string; /** 服务名称 */ ServerName: string; /** 版本名称 */ VersionName: string; } declare interface DescribeCbrServerVersionResponse { /** 版本名称 */ VersionName?: string; /** 备注 */ Remark?: string; /** Dockerfile的路径 */ DockerfilePath?: string; /** DockerBuild的目录 */ BuildDir?: string; /** Cpu大小 */ Cpu?: number; /** Mem大小 */ Mem?: number; /** 副本最小值 */ MinNum?: number; /** 副本最大值 */ MaxNum?: number; /** 环境变量 */ EnvParams?: string; /** 创建时间 */ CreatedTime?: string; /** 更新时间 */ UpdatedTime?: string; /** 版本的IP */ VersionIP?: string; /** 版本的端口号 */ VersionPort?: number; /** 版本状态 */ Status?: string; /** 枚举(package/repository/image) */ UploadType?: string; /** 服务名字 */ ServerName?: string; /** 是否对于外网开放 */ IsPublic?: boolean; /** vpc id */ VpcId?: string; /** 子网实例id */ SubnetIds?: string[]; /** 日志采集路径 */ CustomLogs?: string; /** 监听端口 */ ContainerPort?: number; /** 延迟多长时间开始健康检查(单位s) */ InitialDelaySeconds?: number; /** 镜像地址 */ ImageUrl?: string; /** 是否有Dockerfile:0-default has, 1-has, 2-has not */ HasDockerfile?: number; /** 基础镜像 */ BaseImage?: string; /** 容器启动入口命令 */ EntryPoint?: string; /** 自动扩缩容策略组 */ PolicyDetail?: HpaPolicy[]; /** Tke集群信息 */ TkeClusterInfo?: TkeClusterInfo; /** 版本工作负载类型;deployment/deamonset */ TkeWorkloadType?: string; /** 代码包信息 */ PackageInfo?: CbrPackageInfo; /** 仓库信息 */ RepoInfo?: CbrRepoInfo; /** 唯一请求 ID,每次请求都会返回。 */ RequestId?: string; } declare interface DescribeCloudBaseBuildServiceRequest { /** 环境id */ EnvId: string; /** 服务名 */ ServiceName: string; /** build类型,枚举值有: cloudbaserun, framework-ci */ CIBusiness?: string; /** 服务版本 */ ServiceVersion?: string; /** 文件后缀 */ Suffix?: string; } declare interface DescribeCloudBaseBuildServiceResponse { /** 上传url */ UploadUrl?: string; /** 上传header */ UploadHeaders?: KVPair[]; /** 包名 */ PackageName?: string; /** 包版本 */ PackageVersion?: string; /** 下载链接 */ DownloadUrl?: string; /** 下载Httpheader */ DownloadHeaders?: KVPair[]; /** 下载链接是否过期 */ OutDate?: boolean; /** 唯一请求 ID,每次请求都会返回。 */ RequestId?: string; } declare interface DescribeCloudBaseProjectLatestVersionListRequest { /** 偏移量 */ Offset: number; /** 个数 */ PageSize: number; /** 环境id, 非必填 */ EnvId?: string; /** 项目名称, 非必填 */ ProjectName?: string; /** 项目类型: framework-oneclick,qci-extension-cicd */ ProjectType?: string; /** 标签 */ Tags?: string[]; /** ci的id */ CiId?: string; } declare interface DescribeCloudBaseProjectLatestVersionListResponse { /** 项目列表 */ ProjectList?: CloudBaseProjectVersion[]; /** 总数 */ TotalCount?: number; /** 唯一请求 ID,每次请求都会返回。 */ RequestId?: string; } declare interface DescribeCloudBaseProjectVersionListRequest { /** 环境id */ EnvId: string; /** 项目名称 */ ProjectName: string; /** 页大小 */ PageSize?: number; /** 第几页,从0开始 */ PageNum?: number; /** 起始时间 */ StartTime?: string; /** 终止时间 */ EndTime?: string; } declare interface DescribeCloudBaseProjectVersionListResponse { /** 版本列表 */ ProjectVersions?: CloudBaseProjectVersion[]; /** 总个数 */ TotalCount?: number; /** 唯一请求 ID,每次请求都会返回。 */ RequestId?: string; } declare interface DescribeCloudBaseRunAllVpcsRequest { /** 环境ID */ EnvId: string; } declare interface DescribeCloudBaseRunAllVpcsResponse { /** 所有vpcid */ Vpcs?: string[]; /** 唯一请求 ID,每次请求都会返回。 */ RequestId?: string; } declare interface DescribeCloudBaseRunConfForGateWayRequest { /** 环境ID */ EnvID: string; /** vpc信息 */ VpcID?: string; } declare interface DescribeCloudBaseRunConfForGateWayResponse { /** 最近更新时间 */ LastUpTime?: string; /** 配置信息 */ Data?: CloudBaseRunForGatewayConf[] | null; /** 唯一请求 ID,每次请求都会返回。 */ RequestId?: string; } declare interface DescribeCloudBaseRunOneClickTaskExternalRequest { /** 外部任务Id 最长64字节 */ ExternalId: string; } declare interface DescribeCloudBaseRunOneClickTaskExternalResponse { /** 外部任务Id */ ExternalId?: string; /** 弃用 */ EnvId?: string; /** 用户uin */ UserUin?: string; /** 服务名 */ ServerName?: string; /** 版本名 */ VersionName?: string; /** 创建时间 */ CreateTime?: string; /** 当前阶段微信云托管环境创建阶段:envStage存储资源创建阶段:storageStage服务创建阶段:serverStage */ Stage?: string; /** 状态runningstoppedfailedfinished */ Status?: string; /** 失败原因 */ FailReason?: string; /** 用户envId */ UserEnvId?: string; /** 创建时间 */ StartTime?: string; /** 步骤信息 */ Steps?: OneClickTaskStepInfo[]; /** 唯一请求 ID,每次请求都会返回。 */ RequestId?: string; } declare interface DescribeCloudBaseRunOperationTypesRequest { /** 环境ID */ EnvId: string; /** 服务名称,精确匹配 */ ServerName?: string; } declare interface DescribeCloudBaseRunOperationTypesResponse { /** 操作类型 */ Action?: string[]; /** 服务名列表 */ ServerName?: string[]; /** 唯一请求 ID,每次请求都会返回。 */ RequestId?: string; } declare interface DescribeCloudBaseRunPodListRequest { /** 环境id */ EnvId: string; /** 服务名 */ ServerName: string; /** 版本名 */ VersionName: string; /** 分页限制 */ Limit?: number; /** 分页偏移量 */ Offset?: number; /** 容器状态 */ Status?: string; /** 容器名 */ PodName?: string; } declare interface DescribeCloudBaseRunPodListResponse { /** 偏移量 */ Offset?: number; /** 分页大小 */ Limit?: number; /** 总数 */ TotalCount?: number; /** 容器列表 */ PodList?: CloudBaseRunVersionPod[]; /** 唯一请求 ID,每次请求都会返回。 */ RequestId?: string; } declare interface DescribeCloudBaseRunResourceForExtendRequest { /** 环境ID */ EnvId: string; } declare interface DescribeCloudBaseRunResourceForExtendResponse { /** 集群状态(creating/succ) */ ClusterStatus?: string; /** 虚拟集群ID */ VirtualClusterId?: string; /** vpc id信息 */ VpcId?: string; /** 地域信息 */ Region?: string; /** 子网信息 */ SubnetIds?: CloudBaseRunVpcSubnet[]; /** 唯一请求 ID,每次请求都会返回。 */ RequestId?: string; } declare interface DescribeCloudBaseRunResourceRequest { /** 环境ID */ EnvId: string; } declare interface DescribeCloudBaseRunResourceResponse { /** 集群状态(creating/succ) */ ClusterStatus?: string; /** 虚拟集群ID */ VirtualClusterId?: string; /** vpc id信息 */ VpcId?: string; /** 地域信息 */ Region?: string; /** 子网信息 */ SubnetIds?: CloudBaseRunVpcSubnet[] | null; /** 唯一请求 ID,每次请求都会返回。 */ RequestId?: string; } declare interface DescribeCloudBaseRunServerDomainNameRequest { /** 服务名 */ ServerName: string; /** 环境Id */ UserEnvId: string; /** 用户Uin */ UserUin: string; /** 外部Id */ ExternalId: string; } declare interface DescribeCloudBaseRunServerDomainNameResponse { /** 公网服务域名 */ PublicDomain?: string; /** 内部服务域名 */ InternalDomain?: string; /** 弃用 */ DomainName?: string; /** 唯一请求 ID,每次请求都会返回。 */ RequestId?: string; } declare interface DescribeCloudBaseRunServerRequest { /** 环境ID */ EnvId: string; /** 服务名称 */ ServerName: string; /** 分页偏移 */ Offset: number; /** 分页数量 */ Limit: number; /** 版本名字(精确匹配) */ VersionName?: string; } declare interface DescribeCloudBaseRunServerResponse { /** 个数 */ TotalCount?: number; /** 版本列表 */ VersionItems?: CloudBaseRunServerVersionItem[]; /** 服务名称 */ ServerName?: string; /** 是否对于外网开放 */ IsPublic?: boolean; /** 镜像仓库 */ ImageRepo?: string; /** 流量配置的类型(FLOW,URL_PARAMS) */ TrafficType?: string; /** 服务创建类型,默认为空,一键部署为oneclick */ SourceType?: string; /** 服务标签, function: 托管函数 */ Tag?: string; /** 唯一请求 ID,每次请求都会返回。 */ RequestId?: string; } declare interface DescribeCloudBaseRunServerVersionRequest { /** 环境ID */ EnvId: string; /** 服务名称 */ ServerName: string; /** 版本名称 */ VersionName: string; } declare 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 */ SubnetIds?: string[] | null; /** 日志采集路径 */ 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; /** 自动扩缩容策略组 */ PolicyDetail?: HpaPolicy[] | null; /** Tke集群信息 */ TkeClusterInfo?: TkeClusterInfo | null; /** 版本工作负载类型;deployment/deamonset */ TkeWorkloadType?: string; /** 唯一请求 ID,每次请求都会返回。 */ RequestId?: string; } declare interface DescribeCloudBaseRunVersionRequest { /** 环境ID */ EnvId: string; /** 服务名称 */ ServerName: string; /** 版本名称 */ VersionName: string; } declare interface DescribeCloudBaseRunVersionResponse { /** 版本名称 */ VersionName?: string; /** 备注 */ Remark?: string; /** Dockerfile的路径 */ DockerfilePath?: string; /** DockerBuild的目录 */ BuildDir?: string; /** 副本最小值 */ 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的类型(coding/gitlab/github/coding) */ RepoType?: string; /** 地址 */ Repo?: string; /** 分支 */ Branch?: string; /** 服务名字 */ ServerName?: string; /** 是否对于外网开放 */ IsPublic?: boolean; /** vpc id */ VpcId?: string; /** 子网实例id */ SubnetIds?: string[]; /** 日志采集路径 */ CustomLogs?: string; /** 监听端口 */ ContainerPort?: number; /** 延迟多长时间开始健康检查(单位s) */ InitialDelaySeconds?: number; /** 镜像地址 */ ImageUrl?: string; /** CPU 大小 */ CpuSize?: number; /** MEM 大小 */ MemSize?: number; /** 扩缩容策略详情 */ PolicyDetail?: HpaPolicy[]; /** Cpu的Request值 */ Cpu?: number; /** Mem的Request值 */ Mem?: number; /** 唯一请求 ID,每次请求都会返回。 */ RequestId?: string; } declare interface DescribeCloudBaseRunVersionRsByConditionRequest { /** 环境ID;EnvId和ClusterId不能同时为空 */ EnvId?: string; /** 集群ID;EnvId和ClusterId不能同时为空 */ ClusterId?: string; /** 过滤网关服务开关 */ FilterGwSwitch?: boolean; } declare interface DescribeCloudBaseRunVersionRsByConditionResponse { /** 唯一请求 ID,每次请求都会返回。 */ RequestId?: string; } declare interface DescribeCloudBaseRunVersionSnapshotRequest { /** 服务名 */ ServerName: string; /** 版本名 */ VersionName: string; /** 环境id */ EnvId: string; /** 版本历史名 */ SnapshotName?: string; /** 偏移量。默认0 */ Offset?: number; /** 限制大小。默认10,最大20 */ Limit?: number; } declare interface DescribeCloudBaseRunVersionSnapshotResponse { /** 版本历史 */ Snapshots?: CloudRunServiceSimpleVersionSnapshot[]; /** 唯一请求 ID,每次请求都会返回。 */ RequestId?: string; } declare interface DescribeCurveDataRequest { /** 环境ID */ EnvId: string; /** 基础套餐相关指标 StorageRead: 存储读请求次数 StorageWrite: 存储写请求次数 StorageCdnOriginFlux: CDN回源流量, 单位字节 CDNFlux: CDN回源流量, 单位字节 FunctionInvocation: 云函数调用次数 FunctionGBs: 云函数资源使用量, 单位Mb*Ms FunctionFlux: 云函数流量, 单位千字节(KB) FunctionError: 云函数调用错误次数 FunctionDuration: 云函数运行时间, 单位毫秒 DbRead: 数据库读请求数 DbWrite: 数据库写请求数 DbCostTime10ms: 数据库耗时在10ms-50ms请求数 DbCostTime50ms: 数据库耗时在50ms-100ms请求数 DbCostTime100ms: 数据库耗时在100ms以上请求数 TkeInvokeNum: 调用量 FunctionConcurrentExecutions: 云函数并发执行个数 FunctionIdleProvisioned: 云函数预置并发闲置量 FunctionConcurrencyMemoryMB: 云函数并发执行内存量 FunctionThrottle: 云函数受限次数 FunctionProvisionedConcurrency: 云函数预置并发 ApiCountSummary: API总调用量(包括:数据库读+写,云存储读+写,云函数调用,CMS调用)CapacitySummary: 容量(包括:云存储+数据库)DatabaseApiCountSummary:数据库调用次数(包括:数据库读+写)StorageApiCountSummary:云存储调用次数(包括:云存储读+写)EnvQPSAll:环境总QPS云托管相关指标TkeCpuRatio : 容器CPU占用率TkeMemRatio : 容器内存占用率TkeCpuUsed : 容器CPU使用量TkeMemUsed : 容器内存使用量TkeResourceCpuVersion : 实际分配CPU规格数 单位:核TkeResourceMemVersion : 实际分配内存规格数 单位:MBTkeResourceCpuService : CPU 规格量TkeResourceMemService : 内存 规格量TkeCpuUsedVersion : 版本级别cpu使用量TkeMemUsedVersion : 版本级别内存使用量TkeCpuRatioVersion : 版本级别cpu使用率TkeMemRatioVersion : 版本级别内存使用率TkePodNumVersion : 实例个数(版本)TkePodUnavailableNumVersion : 实例不可用个数(版本)TkeCUUsedVersion : 版本级别内存使用量(CU单位)TkeCpuUsedService : 服务级别cpu使用量TkeMemUsedService : 服务级别内存使用量TkePodNumService : 实例个数(服务)TkePodUnavailableNumService : 实例不可用个数(服务)TkeCUUsedService : 服务级别内存使用量(CU单位) */ MetricName: string; /** 开始时间,如2018-08-24 10:50:00, 开始时间需要早于结束时间至少五分钟(原因是因为目前统计粒度最小是5分钟) */ StartTime: string; /** 结束时间,如2018-08-24 10:50:00, 结束时间需要晚于开始时间至少五分钟(原因是因为目前统计粒度最小是5分钟) */ EndTime: string; /** 资源ID, 目前仅对云函数、容器托管相关的指标有意义。云函数(FunctionInvocation, FunctionGBs, FunctionFlux, FunctionError, FunctionDuration)、容器托管(服务名称), 如果想查询某个云函数的指标则在ResourceId中传入函数名; 如果只想查询整个namespace的指标, 则留空或不传.如果想查询数据库某个集合相关信息,传入集合名称 */ ResourceID?: string; } declare interface DescribeCurveDataResponse { /** 开始时间, 会根据数据的统计周期进行取整 */ StartTime?: string; /** 结束时间, 会根据数据的统计周期进行取整 */ EndTime?: string; /** 指标名 */ MetricName?: string; /** 统计周期(单位秒), 当时间区间为1天内, 统计周期为5分钟; 当时间区间选择为1天以上, 15