tencentcloud-sdk-nodejs
Version:
2,909 lines • 140 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;
}
/**
* DescribeCloudBaseRunAllVpcs返回参数结构体
*/
export interface DescribeCloudBaseRunAllVpcsResponse {
/**
* 所有vpcid
*/
Vpcs?: Array<string>;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: 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;
}
/**
* DescribeCloudBaseRunConfForGateWay请求参数结构体
*/
export interface DescribeCloudBaseRunConfForGateWayRequest {
/**
* 环境ID
*/
EnvID: string;
/**
* vpc信息
*/
VpcID?: string;
}
/**
* DescribeCloudBaseRunServerVersion请求参数结构体
*/
export interface DescribeCloudBaseRunServerVersionRequest {
/**
* 环境ID
*/
EnvId: string;
/**
* 服务名称
*/
ServerName: string;
/**
* 版本名称
*/
VersionName: string;
}
/**
* 代码包信息
*/
export interface CbrPackageInfo {
/**
* 代码包名称
*/
PackageName?: string;
/**
* 代码包版本
*/
PackageVersion?: string;
}
/**
* DescribeEnvLimit请求参数结构体
*/
export declare type DescribeEnvLimitRequest = null;
/**
* DescribeEnvDealRegion返回参数结构体
*/
export interface DescribeEnvDealRegionResponse {
/**
* 下单region
*/
Region?: string;
/**
* 下单zone
*/
Zone?: string;
/**
* 下单regionId
*/
RegionId?: number;
/**
* 下单zoneId
*/
ZoneId?: number;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* DeleteCloudBaseRunServerVersion返回参数结构体
*/
export interface DeleteCloudBaseRunServerVersionResponse {
/**
* 返回结果,succ为成功
*/
Result?: string;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* RollUpdateCloudBaseRunServerVersion返回参数结构体
*/
export interface RollUpdateCloudBaseRunServerVersionResponse {
/**
* succ为成功
*/
Result?: string;
/**
* 滚动更新的VersionName
*/
VersionName?: string;
/**
* 操作记录id
*/
RunId?: string;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* SearchClsLog返回参数结构体
*/
export interface SearchClsLogResponse {
/**
* 日志内容结果
*/
LogResults?: LogResObject;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* ModifyClsTopic返回参数结构体
*/
export interface ModifyClsTopicResponse {
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* 独立网关信息
*/
export interface StandaloneGatewayInfo {
/**
* 独立网关名称
*/
GatewayName: string;
/**
* CPU核心数
*/
CPU: number;
/**
* 内存大小,单位MB
*/
Mem: number;
/**
* 套餐包版本名称
*/
PackageVersion: string;
/**
* 网关别名
*/
GatewayAlias: string;
/**
* 私有网络ID
*/
VpcId: string;
/**
* 子网ID列表
*/
SubnetIds: Array<string>;
/**
* 网关描述
*/
GatewayDesc: string;
/**
* 网关状态
*/
GateWayStatus: string;
/**
* 服务信息
*/
ServiceInfo: BackendServiceInfo;
/**
* 公网CLBIP
*/
PublicClbIp: string;
/**
* 内网CLBIP
*/
InternalClbIp: string;
}
/**
* EditAuthConfig返回参数结构体
*/
export interface EditAuthConfigResponse {
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* CloudBaseRun 的 Side 描述定义
*/
export interface CloudBaseRunSideSpec {
/**
* 容器镜像
*/
ContainerImage?: string;
/**
* 容器端口
*/
ContainerPort?: number;
/**
* 容器的名称
*/
ContainerName?: string;
/**
* kv的json字符串
*/
EnvVar?: string;
/**
* InitialDelaySeconds 延迟多长时间启动健康检查
*/
InitialDelaySeconds?: number;
/**
* CPU大小
*/
Cpu?: number;
/**
* 内存大小(单位:M)
*/
Mem?: number;
/**
* 安全特性
*/
Security?: CloudBaseSecurityContext;
/**
* 挂载信息
*/
VolumeMountInfos?: Array<CloudBaseRunVolumeMount>;
}
/**
* CommonServiceAPI返回参数结构体
*/
export interface CommonServiceAPIResponse {
/**
* json格式response
*/
JSONResp?: string;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* DescribeStandaloneGateway请求参数结构体
*/
export interface DescribeStandaloneGatewayRequest {
/**
* 环境ID
*/
EnvId: string;
/**
* 网关名称
*/
GatewayName?: string;
/**
* 网关别名
*/
GatewayAlias?: string;
}
/**
* DescribeStandaloneGatewayPackage请求参数结构体
*/
export interface DescribeStandaloneGatewayPackageRequest {
/**
* 环境ID
*/
EnvId?: string;
/**
* 套餐版本,包含starter、basic、advanced、enterprise
*/
PackageVersion?: string;
}
/**
* DescribeGraphData返回参数结构体
*/
export interface DescribeGraphDataResponse {
/**
* 开始时间, 会根据数据的统计周期进行取整.
*/
StartTime?: string;
/**
* 结束时间, 会根据数据的统计周期进行取整.
*/
EndTime?: string;
/**
* 指标名
*/
MetricName?: string;
/**
* 统计周期(单位秒), 当时间区间为1天内, 统计周期为5分钟; 当时间区间选择为1天以上, 15天以下, 统计周期为1小时; 当时间区间选择为15天以上, 180天以下, 统计周期为1天.
*/
Period?: number;
/**
* 有效的监控数据, 每个有效监控数据的上报时间可以从时间数组中的对应位置上获取到。
*/
Values?: Array<number>;
/**
* 时间数据, 标识监控数据Values中的点是哪个时间段上报的.
*/
Time?: Array<number | bigint>;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* DescribePostpayPackageFreeQuotas请求参数结构体
*/
export interface DescribePostpayPackageFreeQuotasRequest {
/**
* 环境ID
*/
EnvId?: string;
/**
* 免费额度类型标识
*/
FreeQuotaType?: string;
}
/**
* DescribeEndUserLoginStatistic请求参数结构体
*/
export interface DescribeEndUserLoginStatisticRequest {
/**
* 环境id
*/
EnvId: string;
/**
* 终端用户来源
<li> qcloud </li>
<li>miniapp</li>
*/
Source?: string;
}
/**
* 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;
}
/**
* DescribeEndUsers请求参数结构体
*/
export interface DescribeEndUsersRequest {
/**
* 开发者的环境ID
*/
EnvId: string;
/**
* 可选参数,偏移量,默认 0
*/
Offset?: number;
/**
* 可选参数,拉取数量,默认 20
*/
Limit?: number;
/**
* 按照 uuid 列表过滤,最大个数为100
*/
UUIds?: Array<string>;
}
/**
* DescribeCloudBaseRunPodList返回参数结构体
*/
export interface DescribeCloudBaseRunPodListResponse {
/**
* 偏移量
*/
Offset?: number;
/**
* 分页大小
*/
Limit?: number;
/**
* 总数
*/
TotalCount?: number;
/**
* 容器列表
*/
PodList?: Array<CloudBaseRunVersionPod>;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* DescribeCloudBaseRunServerDomainName返回参数结构体
*/
export interface DescribeCloudBaseRunServerDomainNameResponse {
/**
* 公网服务域名
*/
PublicDomain?: string;
/**
* 内部服务域名
*/
InternalDomain?: string;
/**
* 弃用
*/
DomainName?: string;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* 封禁配置
*/
export interface BanConfig {
/**
* ip白名单,支持ipv4、ipv6,支持CIDR
*/
IpWhiteList?: Array<string>;
/**
* ip黑名单,支持ipv4、ipv6,支持CIDR
*/
IpBlackList?: Array<string>;
/**
* 地域白名单(国家英文名)
*/
CountryWhiteList?: Array<string>;
/**
* 地域黑名单(国家英文名)
*/
CountryBlackList?: Array<string>;
}
/**
* CLS日志结果
*/
export interface LogResObject {
/**
* 获取更多检索结果的游标
*/
Context?: string;
/**
* 搜索结果是否已经全部返回
*/
ListOver?: boolean;
/**
* 日志内容信息
*/
Results?: Array<LogObject>;
}
/**
* DestroyStandaloneGateway请求参数结构体
*/
export interface DestroyStandaloneGatewayRequest {
/**
* 环境ID
*/
EnvId: string;
/**
* 网名名称
*/
GatewayName: string;
/**
* 是否强制释放
*/
IsForce: boolean;
}
/**
* CloudRunServiceSimpleVersionSnapshot 信息
*/
export 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;
}
/**
* CreateWxCloudBaseRunServerDBCluster返回参数结构体
*/
export interface CreateWxCloudBaseRunServerDBClusterResponse {
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* ReplaceActivityRecord返回参数结构体
*/
export interface ReplaceActivityRecordResponse {
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* DescribeSpecialCostItems请求参数结构体
*/
export interface DescribeSpecialCostItemsRequest {
/**
* 环境id
*/
EnvId?: string;
/**
* 查询开始时间
*/
StartTime?: string;
/**
* 查询结束时间
*/
EndTime?: string;
}
/**
* TurnOnStandaloneGateway请求参数结构体
*/
export interface TurnOnStandaloneGatewayRequest {
/**
* 环境ID
*/
EnvId: string;
/**
* 网关名称
*/
GatewayName: string;
/**
* 服务名称列表
*/
ServiceNameList: Array<string>;
}
/**
* CreatePostpayPackage请求参数结构体
*/
export interface CreatePostpayPackageRequest {
/**
* 环境ID,需要系统自动创建环境时,此字段不传
*/
EnvId?: string;
/**
* 微信 AppId,微信必传
*/
WxAppId?: string;
/**
* 付费来源
<li>miniapp</li>
<li>qcloud</li>
*/
Source?: string;
/**
* 用户享有的免费额度级别,目前只能为“basic”,不传该字段或该字段为空,表示不享受免费额度。
*/
FreeQuota?: string;
/**
* 环境创建来源,取值:
<li>miniapp</li>
<li>qcloud</li>
用法同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;
/**
* 订单标记。建议使用方统一转大小写之后再判断。
<li>QuickStart:快速启动来源</li>
<li>Activity:活动来源</li>
*/
Flag?: string;
/**
* 环境别名,无字符类型限制
*/
EnvAlias?: string;
/**
* 附加字段,用于透传额外的自定义信息
*/
Extra?: string;
}
/**
* DescribeWxCloudBaseRunSubNets请求参数结构体
*/
export interface DescribeWxCloudBaseRunSubNetsRequest {
/**
* VPC id
*/
VpcId: string;
/**
* 查询个数限制,不填或小于等于0,等于不限制
*/
Limit?: number;
}
/**
* ModifyEndUser请求参数结构体
*/
export interface ModifyEndUserRequest {
/**
* 环境ID
*/
EnvId: string;
/**
* C端用户端的唯一ID
*/
UUId: string;
/**
* 账号的状态
<li>ENABLE</li>
<li>DISABLE</li>
*/
Status?: string;
}
/**
* DescribeCurveData返回参数结构体
*/
export interface DescribeCurveDataResponse {
/**
* 开始时间, 会根据数据的统计周期进行取整
*/
StartTime?: string;
/**
* 结束时间, 会根据数据的统计周期进行取整
*/
EndTime?: string;
/**
* 指标名
*/
MetricName?: string;
/**
* 统计周期(单位秒), 当时间区间为1天内, 统计周期为5分钟; 当时间区间选择为1天以上, 15天以下, 统计周期为1小时; 当时间区间选择为15天以上, 180天以下, 统计周期为1天
*/
Period?: number;
/**
* 有效的监控数据, 每个有效监控数据的上报时间可以从时间数组中的对应位置上获取到
*/
Values?: Array<number | bigint>;
/**
* 时间数据, 标识监控数据Values中的点是哪个时间段上报的
*/
Time?: Array<number | bigint>;
/**
* 有效的监控数据, 每个有效监控数据的上报时间可以从时间数组中的对应位置上获取到
*/
NewValues?: Array<number>;
/**
* 唯一请求 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;
}
/**
* DescribeCloudBaseRunOperationTypes请求参数结构体
*/
export interface DescribeCloudBaseRunOperationTypesRequest {
/**
* 环境ID
*/
EnvId: string;
/**
* 服务名称,精确匹配
*/
ServerName?: 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;
}
/**
* ReinstateEnv请求参数结构体
*/
export interface ReinstateEnvRequest {
/**
* 环境ID
*/
EnvId: string;
}
/**
* DescribeCloudBaseRunOneClickTaskExternal请求参数结构体
*/
export interface DescribeCloudBaseRunOneClickTaskExternalRequest {
/**
* 外部任务Id 最长64字节
*/
ExternalId: string;
}
/**
* ModifyClsTopic请求参数结构体
*/
export interface ModifyClsTopicRequest {
/**
* 环境ID
*/
EnvId: string;
/**
* 日志生命周期,单位天,可取值范围1~3600,取值为3640时代表永久保存
*/
Period?: number;
}
/**
* DescribeStandaloneGateway返回参数结构体
*/
export interface DescribeStandaloneGatewayResponse {
/**
* 独立网关信息列表
*/
StandaloneGatewayList: Array<StandaloneGatewayInfo>;
/**
* 总数
*/
Total: number;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* DescribeWxCloudBaseRunEnvs返回参数结构体
*/
export interface DescribeWxCloudBaseRunEnvsResponse {
/**
* env列表
*/
EnvList?: Array<EnvInfo>;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* CreateHostingDomain请求参数结构体
*/
export interface CreateHostingDomainRequest {
/**
* 环境ID
*/
EnvId: string;
/**
* 域名
*/
Domain: string;
/**
* 证书ID
*/
CertId: string;
}
/**
* DescribeCloudBaseRunResource请求参数结构体
*/
export interface DescribeCloudBaseRunResourceRequest {
/**
* 环境ID
*/
EnvId: string;
}
/**
* DescribeCloudBaseRunServer请求参数结构体
*/
export interface DescribeCloudBaseRunServerRequest {
/**
* 环境ID
*/
EnvId: string;
/**
* 服务名称
*/
ServerName: string;
/**
* 分页偏移
*/
Offset: number;
/**
* 分页数量
*/
Limit: number;
/**
* 版本名字(精确匹配)
*/
VersionName?: string;
}
/**
* emptydir 数据卷详细信息
*/
export interface CloudBaseRunEmptyDirVolumeSource {
/**
* 启用emptydir数据卷
*/
EnableEmptyDirVolume?: boolean;
/**
* "","Memory","HugePages"
*/
Medium?: string;
/**
* emptydir数据卷大小
*/
SizeLimit?: string;
}
/**
* cfs挂载点
*/
export interface CloudBaseRunVolumeMount {
/**
* 资源名
*/
Name?: string;
/**
* 挂载路径
*/
MountPath?: string;
/**
* 是否只读
*/
ReadOnly?: boolean;
/**
* Nfs挂载信息
注意:此字段可能返回 null,表示取不到有效值。
*/
NfsVolumes?: Array<CloudBaseRunNfsVolumeSource>;
/**
* 挂载配置
*/
MountPropagation?: string;
}
/**
* 网关服务信息
*/
export interface BackendServiceInfo {
/**
* 服务名称
*/
ServiceName: string;
/**
* 服务状态
*/
Status: string;
}
/**
* DescribePostpayFreeQuotas请求参数结构体
*/
export interface DescribePostpayFreeQuotasRequest {
/**
* 环境ID
*/
EnvId: string;
}
/**
* DeleteGatewayVersion请求参数结构体
*/
export interface DeleteGatewayVersionRequest {
/**
* 环境id
*/
EnvId: string;
/**
* 网关id
*/
GatewayId: string;
/**
* 版本名
*/
VersionName: string;
/**
* 是否删除服务
*/
IsDeleteServer?: boolean;
/**
* 是否删除镜像
*/
IsDeleteImage?: boolean;
/**
* 是否强制删除
*/
IsForce?: boolean;
/**
* 操作者记录
*/
OperatorRemark?: string;
}
/**
* CloudBaseRun 镜像信息
*/
export interface CloudBaseRunImageInfo {
/**
* 镜像仓库名称
*/
RepositoryName: string;
/**
* 是否公有
*/
IsPublic: boolean;
/**
* 镜像tag名称
*/
TagName: string;
/**
* 镜像server
*/
ServerAddr: string;
/**
* 镜像拉取地址
*/
ImageUrl: string;
}
/**
* DestroyStandaloneGateway返回参数结构体
*/
export interface DestroyStandaloneGatewayResponse {
/**
* 删除独立网关状态
*/
Status: string;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* DescribeCloudBaseRunServerVersion返回参数结构体
*/
export interface DescribeCloudBaseRunServerVersionResponse {
/**
* 版本名称
*/
VersionName?: string;
/**
* 备注
*/
Remark?: string;
/**
* Dockefile的路径
*/
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;
}
/**
* 终端用户信息
*/
export 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;
}
/**
* 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;
}
/**
* DeleteEndUser请求参数结构体
*/
export interface DeleteEndUserRequest {
/**
* 环境ID
*/
EnvId: string;
/**
* 用户列表,每一项都是uuid
*/
UserList: Array<string>;
}
/**
* DescribeHostingDomainTask请求参数结构体
*/
export interface DescribeHostingDomainTaskRequest {
/**
* 环境ID
*/
EnvId: string;
}
/**
* FreezeCloudBaseRunServers请求参数结构体
*/
export interface FreezeCloudBaseRunServersRequest {
/**
* 环境ID
*/
EnvId: string;
/**
* 服务名列表
*/
ServerNameList: Array<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;
}
/**
* ModifyGatewayVersionTraffic请求参数结构体
*/
export interface ModifyGatewayVersionTrafficRequest {
/**
* 环境id
*/
EnvId: string;
/**
* 网关id
*/
GatewayId: string;
/**
* 网关版本流量比例信息
*/
VersionsWeight: Array<GatewayVersionItem>;
}
/**
* DescribeQuotaData返回参数结构体
*/
export interface DescribeQuotaDataResponse {
/**
* 指标名
*/
MetricName?: string;
/**
* 指标的值
*/
Value?: number;
/**
* 指标的附加值信息
*/
SubValue?: string;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* DescribeGatewayCurveData返回参数结构体
*/
export interface DescribeGatewayCurveDataResponse {
/**
* 监控类型
*/
MetricName?: string;
/**
* 监控起始时间
*/
StartTime?: string;
/**
* 监控结束时间
*/
EndTime?: string;
/**
* 监控数据间隔
*/
Period?: number;
/**
* 监控值
*/
Values?: Array<number>;
/**
* 监控时间
*/
Time?: Array<number | bigint>;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* 键值对
*/
export interface KVPair {
/**
* 键
*/
Key: string;
/**
* 值
*/
Value: string;
}
/**
* 短信免费量
*/
export interface SmsFreeQuota {
/**
* 免费量总条数
*/
FreeQuota?: number;
/**
* 共计已使用总条数
*/
TotalUsedQuota?: number;
/**
* 免费周期起点,0000-00-00 00:00:00 形式
*/
CycleStart?: string;
/**
* 免费周期终点,0000-00-00 00:00:00 形式
*/
CycleEnd?: string;
/**
* 今天已使用总条数
*/
TodayUsedQuota?: number;
}
/**
* 函数的信息
*/
export interface FunctionInfo {
/**
* 命名空间
*/
Namespace?: string;
/**
* 所属地域。
当前支持ap-shanghai
*/
Region?: string;
}
/**
* CommonServiceAPI请求参数结构体
*/
export interface CommonServiceAPIRequest {
/**
* Service名,需要转发访问的接口名
*/
Service: string;
/**
* 需要转发的云API参数,要转成JSON格式
*/
JSONData?: string;
/**
* 指定角色
*/
ApiRole?: string;
}
/**
* DestroyStaticStore请求参数结构体
*/
export interface DestroyStaticStoreRequest {
/**
* 环境ID
*/
EnvId: string;
/**
* cdn域名
*/
CdnDomain?: string;
}
/**
* CreateWxCloudBaseRunEnv请求参数结构体
*/
export 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?: Array<string>;
/**
* 是否打开云调用
*/
IsOpenCloudInvoke?: boolean;
/**
* 创建来源:wechat | cloud
*/
Source?: string;
/**
* 渠道:wechat | cloud
*/
Channel?: string;
}
/**
* ModifyCloudBaseRunServerFlowConf请求参数结构体
*/
export interface ModifyCloudBaseRunServerFlowConfRequest {
/**
* 环境ID
*/
EnvId: string;
/**
* 服务名称
*/
ServerName: string;
/**
* 流量占比
*/
VersionFlowItems?: Array<CloudBaseRunVersionFlowItem>;
/**
* 流量类型(URL_PARAMS / FLOW / HEADERS)
*/
TrafficType?: string;
/**
* 操作备注
*/
OperatorRemark?: string;
}
/**
* DescribeActivityRecord返回参数结构体
*/
export interface DescribeActivityRecordResponse {
/**
* 活动记录详情
*/
ActivityRecords?: Array<ActivityRecordItem>;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* DescribeCloudBaseRunVersionRsByCondition返回参数结构体
*/
export interface DescribeCloudBaseRunVersionRsByConditionResponse {
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* CreateStaticStore请求参数结构体
*/
export interface CreateStaticStoreRequest {
/**
* 环境ID
*/
EnvId: string;
/**
* 是否启用统一域名
*/
EnableUnion?: boolean;
}
/**
* CreateWxCloudBaseRunServerDBCluster请求参数结构体
*/
export interface CreateWxCloudBaseRunServerDBClusterRequest {
/**
* 账户密码
*/
AccountPassword: string;
/**
* 环境ID
*/
EnvId: string;
/**
* 微信appid
*/
WxAppId?: string;
/**
* mysql内核版本,支持5.7,8.0
*/
DbVersion?: string;
/**
* 0: 大小写敏感
1: 非大小写敏感
默认为0
*/
LowerCaseTableName?: string;
}
/**
* DeleteCloudBaseProjectLatestVersion返回参数结构体
*/
export interface DeleteCloudBaseProjectLatestVersionResponse {
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* DescribeGatewayCurveData请求参数结构体
*/
export interface DescribeGatewayCurveDataRequest {
/**
* 环境id
*/
EnvId: string;
/**
* 网关id
*/
GatewayId: string;
/**
* 监控类型 GWQps GWBandwidth GwHttpError GwHttp404 GwHttp502 GwConnect GwCircuit
*/
MetricName: string;
/**
* 监控起始时间
*/
StartTime: string;
/**
* 监控结束时间
*/
EndTime: string;
/**
* 网关版本
*/
GatewayVersion?: string;
/**
* 网关路由名称
*/
GatewayRoute?: string;
}
/**
* DescribeGraphData请求参数结构体
*/
export interface DescribeGraphDataRequest {
/**
* 环境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以上请求数
TkeCpuRatio: 容器CPU占用率
TkeMemRatio: 容器内存占用率
TkeCpuUsed: 容器CPU使用量
TkeMemUsed: 容器内存使用量
TkeInvokeNum: 调用量
FunctionConcurrentExecutions: 云函数并发执行个数
FunctionIdleProvisioned: 云函数预置并发闲置量
FunctionConcurrencyMemoryMB: 云函数并发执行内存量
FunctionThrottle: 云函数受限次数
FunctionProvisionedConcurrency: 云函数预置并发
*/
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;
}
/**
* DescribeBillingInfo返回参数结构体
*/
export interface DescribeBillingInfoResponse {
/**
* 环境计费信息列表
*/
EnvBillingInfoList?: Array<EnvBillingInfoItem>;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* CreateAuthDomain返回参数结构体
*/
export interface CreateAuthDomainResponse {
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* ModifyDatabaseACL请求参数结构体
*/
export interface ModifyDatabaseACLRequest {
/**
* 环境ID
*/
EnvId: string;
/**
* 集合名称
*/
CollectionName: string;
/**
* 权限标签。包含以下取值:
<li> READONLY:所有用户可读,仅创建者和管理员可写</li>
<li> PRIVATE:仅创建者及管理员可读写</li>
<li> ADMINWRITE:所有用户可读,仅管理员可写</li>
<li> ADMINONLY:仅管理员可读写</li>
*/
AclTag: string;
}
/**
* DescribeEnvs请求参数结构体
*/
export interface DescribeEnvsRequest {
/**
* 环境ID,如果传了这个参数则只返回该环境的相关信息
*/
EnvId?: string;
/**
* 指定Channels字段为可见渠道列表或不可见渠道列表
如只想获取渠道A的环境 就填写IsVisible= true,Channels = ["A"], 过滤渠道A拉取其他渠道环境时填写IsVisible= false,Channels = ["A"]
*/
IsVisible?: boolean;
/**
* 渠道列表,代表可见或不可见渠道由IsVisible参数指定
*/
Channels?: Array<string>;
}
/**
* 版本流量占比
*/
export interface CloudBaseRunVersionFlowItem {
/**
* 版本名称
*/
VersionName: string;
/**
* 流量占比
*/
FlowRatio?: number;
/**
* 流量参数键值对(URL参数/HEADERS参数)
*/
UrlParam?: ObjectKV;
/**
* 优先级
*/
Priority?: number;
/**
* 是否是默认兜底版本
*/
IsDefaultPriority?: boolean;
}
/**
* DeleteWxGatewayRoute请求参数结构体
*/
export interface DeleteWxGatewayRouteRequest {
/**
* 环境id
*/
EnvId: string;
/**
* 服务名称
*/
GatewayRouteName: string;
}
/**
* DescribeEnvPostpaidDeduct请求参数结构体
*/
export interface DescribeEnvPostpaidDeductRequest {
/**
* 资源方列表
*/
ResourceTypes: Array<string>;
/**
* 环境id
*/
EnvId?: string;
/**
* 查询开始时间
*/
StartTime?: string;
/**
* 查询结束时间
*/
EndTime?: string;
}
/**
* 安全网关自定义头部
*/
export interface CustomHeader {
/**
* 请求添加头部配置
*/
RequestToAddList?: Array<CustomRequestToAdd>;
}
/**
* DescribeExtraPkgBillingInfo请求参数结构体
*/
export interface DescribeExtraPkgBillingInfoRequest {
/**
* 已购买增值包的环境ID
*/
EnvId?: string;
}
/**
* BindEnvGateway返回参数结构体
*/
export interface BindEnvGatewayResponse {
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* DescribeWxCloudBaseRunSubNets返回参数结构体
*/
export interface DescribeWxCloudBaseRunSubNetsResponse {
/**
* 子网Id列表
*/
SubNetIds?: Array<string>;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* DescribeEnvFreeQuota请求参数结构体
*/
export interface DescribeEnvFreeQuotaRequest {
/**
* 环境ID
*/
EnvId: string;
/**
* 资源类型:可选值:CDN, COS, FLEXDB, HOSTING, SCF
不传则返回全部资源指标
*/
ResourceTypes?: Array<string>;
}
/**
* cloudrun安全特性能力
*/
export interface CloudBaseCapabilities {
/**
* 启用安全能力项列表
*/
Add?: Array<string>;
/**
* 禁用安全能力向列表
*/
Drop?: Array<string>;
}
/**
* 仓库信息
*/
export interface CbrRepoInfo {
/**
* 仓库名称
*/
Repo?: string;
/**
* 仓库平台
*/
RepoType?: string;
/**
* 仓库语言
*/
RepoLanguage?: string;
/**
* 分支名称
*/
Branch?: string;
}
/**
* DescribeEndUserLoginStatistic返回参数结构体
*/
export interface DescribeEndUserLoginStatisticResponse {
/**
* 环境终端用户新增与登录统计
*/
LoginStatistics?: Array<LoginStatistic>;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* DescribeExtensionUploadInfo请求参数结构体
*/
export interface DescribeExtensionUploadInfoRequest {
/**
* 待上传的文件
*/
ExtensionFiles: Array<ExtensionFile>;
}
/**
* DescribeBillingInfo请求参数结构体
*/
export interface DescribeBillingInfoRequest {
/**
* 环境ID
*/
EnvId?: string;
}
/**
* 扩缩容策略
*/
export interface HpaPolicy {
/**
* 策略类型
*/
PolicyType?: string;
/**
* 策略阈值
*/
PolicyThreshold?: number;
}
/**
* CreateCloudBaseRunResource返回参数结构体
*/
export interface CreateCloudBaseRunResourceResponse {
/**
* 返回集群创建是否成功 succ为成功。并且中间无err
*/
Result?: string;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* DescribeStandaloneGatewayPackage返回参数结构体
*/
export interface DescribeStandaloneGatewayPackageResponse {
/**
* 总数
*/
Total: number;
/**
* 套餐详情
*/
StandaloneGatewayPackageList: Array<StandaloneGatewayPackageInfo>;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* CLS日志单条信息
*/
export interface LogObject {
/**
* 日志属于的 topic ID
*/
TopicId?: string;
/**
* 日志主题的名字
*/
TopicName?: string;
/**
* 日志时间
*/
Timestamp?: string;
/**
* 日志内容
*/
Content?: string;
/**
* 采集路径
*/
FileName?: string;
/**
* 日志来源设备
*/
Source?: string;
}
/**
* DestroyStaticStore返回参数结构体
*/
export interface DestroyStaticStoreResponse {
/**
* 条件任务结果(succ/fail)
*/
Result?: string;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* DeleteEndUser返回参数结构体
*/
export interface DeleteEndUserResponse {
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* ModifyDatabaseACL返回参数结构体
*/
export interface ModifyDatabaseACLResponse {
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* es信息
*/
export interface CloudBaseEsInfo {
/**
* es的id
*/
Id?: number;
/**
* secret名字
*/
SecretName?: string;
/**
* ip地址
*/
Ip?: string;
/**
* 端口
*/
Port?: number;
/**
* 索引
*/
Index?: string;
/**
* 用户名
*/
Account?: string;
/**
* 密码
*/
Password?: string;
}
/**
* 后付费计费详情
*/
export interface PostPaidEnvDeductInfo {
/**
* 资源方
*/
ResourceType?: string;
/**
* 指标名
*/
MetricName?: string;
/**
* 按量计费详情
*/
ResQuota?: number;
/**
* 资源包抵扣详情
*/
PkgQuota?: number;
/**
* 免费额度抵扣详情
*/
FreeQuota?: number;
/**
* 环境id
*/
EnvId?: string;
}
/**
* ModifyCloudBaseRunServerFlowConf返回参数结构体
*/
export interface ModifyCloudBaseRunServerFlowConfResponse {
/**
* 返回结果,succ代表成功
*/
Result?: string;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* DescribeCloudBaseRunOperationTypes返回参数结构体
*/
export interface DescribeCloudBaseRunOperationTypesResponse {
/**
* 操作类型
*/
Action?: Array<string>;
/**
* 服务名列表
*/
ServerName?: Array<string>;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* 1分钱计费详情
*/
export interface SpecialCostItem {
/**
* 上报日期
*/
ReportDate?: string;
/**
* 腾讯云uin
*/
Uin?: string;
/**
* 资源id:环境id
*/
EnvId?: string;
/**
* 上报任务状态
*/
Status?: string;
}
/**
* EstablishCloudBaseRunServer返回参数结构体
*/
export interface EstablishCloudBaseRunServerResponse {
/**
* 创建服务是否成功
*/
Result?: string;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* 环境信息
*/
export interface EnvInfo {
/**
* 账户下该环境唯一标识
*/
EnvId?: string;
/**
* 环境来源。包含以下取值:
<li>miniapp:微信小程序</li>
<li>qcloud :腾讯云</li>
*/
Source?: string;
/**
* 环境别名,要以a-z开头,不能包含 a-zA-z0-9- 以外的字符
*/
Alias?: string;
/**
* 创建时间
*/
CreateTime?: string;
/**
* 最后修改时间
*/
UpdateTime?: string;
/**
* 环境状态。包含以下取值:
<li>NORMAL:正常可用</li>
<li>UNAVAILABLE:服务不可用,可能是尚未初始化或者初始化过程中</li>
*/
Status?: string;
/**
* 数据库列表
*/
Databases?: Array<DatabasesInfo>;
/**
* 存储列表
*/
Storages?: Array<StorageInfo>;
/**
* 函数列表
*/
Functions?: Array<FunctionInfo>;
/**
* tcb产品套餐ID,参考DescribePackages接口的返回值。
*/
PackageId?: string;
/**
* 套餐中文名称,参考DescribePackages接口的返回值。
*/
PackageName?: string;
/**
* 云日志服务列表
*/
LogServices?: Array<LogServiceInfo>;
/**
* 静态资源信息
*/
StaticStorages?: Array<StaticStorageInfo>;
/**
* 是否到期自动降为免费版
*/
IsAutoDegrade?: boolean;
/**
* 环境渠道
*/
EnvChannel?: string;
/**
* 支付方式。包含以下取值:
<li> prepayment:预付费</li>
<li> postpaid:后付费</li>
*/
PayMode?: string;
/**
* 是否为默认环境
*/
IsDefault?: boolean;
/**
* 环境所属地域
*/
Region?: string;
/**
* 环境标签列表
*/
Tags?: Array<Tag>;
/**
* 自定义日志服务
*/
CustomLogServices?: Array<ClsInfo>;
/**
* 环境类型:baas, run, hoting, weda
*/
EnvType?: string;
/**
* 是否是dau新套餐
*/
IsDauPackage?: boolean;
/**
* 套餐类型:空\baas\tcbr
*/
PackageType?: string;
/**
* 架构类型
*/
ArchitectureType?: string;
/**
* 回收标志,默认为空
*/
Recycle?: string;
}
/**
* DestroyEnv请求参数结构体
*/
export interface DestroyEnvRequest {
/**
* 环境Id
*/
EnvId: string;
/**
* 针对预付费 删除隔离中的环境时要传true 正常环境直接跳过隔离期删除
*/
IsForce?: boolean;
/**
* 是否绕过资源检查,资源包等额外资源,默认为false,如果为true,则不检查资源是否有数据,直接删除。
*/
BypassCheck?: boolean;
}
/**
* DestroyEnv返回参数结构体
*/
export interface DestroyEnvResponse {
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* DescribeCloudBaseProjectVersionList请求参数结构体
*/
export interface DescribeCloudBaseProjectVersionListRequest {
/**
* 环境id
*/
EnvId: string;
/**
* 项目名称
*/
ProjectName: string;
/**
* 页大小
*/
PageSize?: number;
/**
* 第几页,从0开始
*/
PageNum?: number;
/**
* 起始时间
*/
StartTime?: string;
/**
* 终止时间
*/
EndTime?: string;
}
/**
* 云开发项目来源
*/
export 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;
}
/**
* DescribeCloudBaseRunOneClickTaskExternal返回参数结构体
*/
export interface DescribeCloudBaseRunOneClickTaskExternalResponse {
/**
* 外部任务Id
*/
ExternalId?: string;
/**
* 弃用
*/
EnvId?: string;
/**
* 用户uin
*/
UserUin?: string;
/**
* 服务名
*/
ServerName?: string;
/**
* 版本名
*/
VersionName?: string;
/**
* 创建时间
*/
CreateTime?: string;
/**
* 当前阶段
微信云托管环境创建阶段:envStage
存储资源创建阶段:storageStage
服务创建阶段:serverStage
*/
Stage?: string;
/**
* 状态
running
stopped
failed
finished
*/
Status?: string;
/**
* 失败原因
*/
FailReason?: string;
/**
* 用户envId
*/
UserEnvId?: string;
/**
* 创建时间
*/
StartTime?: string;
/**
* 步骤信息
*/
Steps?: Array<OneClickTaskStepInfo>;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* TurnOffStandaloneGateway返回参数结构体
*/
export interface TurnOffStandaloneGatewayResponse {
/**
* 关闭独立网关状态
*/
Status: string;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* DescribeEnvs返回参数结构体
*/
export interface DescribeEnvsResponse {
/**
* 环境信息列表
*/
EnvList?: Array<EnvInfo>;
/**
* 环境个数
*/
Total?: number;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* CreateAuthDomain请求参数结构体
*/
export interface CreateAuthDomainRequest {
/**
* 环境ID
*/
EnvId: string;
/**
* 安全域名
*/
Domains: Array<string>;
}
/**
* DescribeEnvPostpaidDeduct返回参数结构体
*/
export interface DescribeEnvPostpaidDeductResponse {
/**
* 指标抵扣详情列表
*/
PostPaidEnvDeductInfoList?: Array<PostPaidEnvDeductInfo>;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* CreateHostingDomain返回参数结构体
*/
export interface CreateHostingDomainResponse {
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* tke集群信息
*/
export interface TkeClusterInfo {
/**
* 集群ID
*/
ClusterId?: string;
/**
* 集群的vpcId
*/
VpcId?: string;
/**
* 版本内网CLB所在子网Id
*/
VersionClbSubnetId?: string;
}
/**
* DescribeActivityRecord请求参数结构体
*/
export interface DescribeActivityRecordRequest {
/**
* 渠道加密token
*/
ChannelToken: string;
/**
* 渠道来源,每个来源对应不同secretKey
*/
Channel: string;
/**
* 活动id列表
*/
ActivityIdList?: Array<number | bigint>;
/**
* 过滤状态码,已废弃
*/
Status?: number;
/**
* 状态码过滤数组,空数组时不过滤
*/
Statuses?: Array<number | bigint>;
/**
* 根据是否软删除进行过滤,[0]未删除, [1] 删除,不传不过滤
*/
IsDeletedList?: Array<number | bigint>;
}
/**
* CreateWxC