数据结构

BuildPacksInfo

BuildPacks信息

被如下接口引用：CreateCloudRunServer, UpdateCloudRunServer。

名称	类型	必选	描述
BaseImage	String	是	基础镜像 示例值：image
EntryPoint	String	是	启动命令 示例值：["./app"]
RepoLanguage	String	是	语言 示例值：java
UploadFilename	String	是	上传文件名 示例值：fileName
LanguageVersion	String	否	语言版本 示例值：20.16.0

ClsInfo

cls日志信息

被如下接口引用：DescribeCloudRunEnvs。

名称	类型	描述
ClsRegion	String	cls所属地域 示例值：ap-shanghai
ClsLogsetId	String	cls日志集ID 示例值：xxx-yyy-zzz-***
ClsTopicId	String	cls日志主题ID 示例值：xxx-yyy-zzz-***
CreateTime	String	创建时间 示例值：2021-01-01T00:00:00+08:00

CreateVpcInfo

创建 vpc 信息

被如下接口引用：CreateCloudRunServer。

名称	类型	必选	描述
VpcId	String	是	vpc id 示例值：vpc-sdfd
CreateType	Integer	是	1 新建 2 指定 示例值：2
SubnetIds	Array of String	否	子网ID列表 示例值：["subnet-sdfdf"]

DatabasesInfo

数据库资源信息

被如下接口引用：DescribeCloudRunEnvs。

名称	类型	描述
InstanceId	String	数据库唯一标识 示例值：oc80v5zp
Status	String	状态。包含以下取值： INITIALIZING：资源初始化中 RUNNING：运行中，可正常使用的状态 UNUSABLE：禁用，不可用 OVERDUE：资源过期 示例值：INITIALIZING
Region	String	所属地域。 当前支持ap-shanghai 示例值：ap-shanghai

DeployParam

部署参数

被如下接口引用：CreateCloudRunServer, UpdateCloudRunServer。

名称	类型	必选	描述
DeployType	String	是	部署类型：package/image/repository/pipeline/jar/war 示例值：package
ImageUrl	String	否	部署类型为image时传入 示例值：imageurl
PackageName	String	否	部署类型为package时传入 示例值：name
PackageVersion	String	否	部署类型为package时传入 示例值：version
DeployRemark	String	否	部署备注 示例值：remark
RepoInfo	RepositoryInfo	否	代码仓库信息
BuildPacks	BuildPacksInfo	否	无Dockerfile时填写
ReleaseType	String	否	发布类型 GRAY | FULL 示例值：FULL

DiffConfigItem

服务配置入参

被如下接口引用：CreateCloudRunServer, UpdateCloudRunServer。

名称	类型	必选	描述
Key	String	是	配置项 Key MinNum 最小副本数 MaxNum 最大副本数 PolicyDetails 扩缩容策略 AccessTypes 访问类型 TimerScale 定时扩缩容 InternalAccess 内网访问 OperationMode 运行模式 noScale | condScale | alwaysScale | custom ｜ manualScale SessionAffinity 会话亲和性 open | close CpuSpecs cpu 规格 MemSpecs mem规格 EnvParam 环境变量 LogPath 日志采集路径 Port 端口 Dockerfile dockerfile 文件名 BuildDir 目标目录 Tag 服务标签 LogType 日志类型 none | default | custom LogSetId 日志集Id LogTopicId 日志主题ID LogParseType 日志解析类型 json ｜ line EntryPoint entrypoint 命令 Cmd cmd命令 VpcConf 网络信息 示例值：MinNum
Value	String	否	字符串类型配置项值 InternalAccess、OperationMode、SessionAffinity、EnvParam、LogPath、Dockerfile、BuildDir、Tag、LogType、LogSetId、LogTopicId、LogParseType 示例值：logs
IntValue	Integer	否	int 类型配置项值 MinNum、MaxNum、Port 示例值：1
BoolValue	Boolean	否	bool 类型配置项值 示例值：false
FloatValue	Float	否	浮点型配置项值 CpuSpecs、MemSpecs 示例值：0.25
ArrayValue	Array of String	否	字符串数组配置项值 AccessTypes，EntryPoint，Cmd 示例值：["OA", "PUBLIC"]
PolicyDetails	Array of HpaPolicy	否	扩缩容策略配置项值
TimerScale	Array of TimerScale	否	定时扩缩容配置项值
VpcConf	VpcConf	否	配置内网访问时网络信息
VolumesConf	Array of VolumeConf	否	存储配置信息

EnvBaseInfo

环境基础信息

被如下接口引用：DescribeEnvBaseInfo。

名称	类型	描述
EnvId	String	环境Id 示例值：test-1gbtbgkjf8f48e2c
PackageType	String	套餐类型：Trial ｜ Standard ｜ Professional ｜ Enterprise 示例值：Standard
VpcId	String	VPC Id 示例值：vpc-5k6fot41
CreateTime	String	环境创建时间 示例值：2022-05-27 15:00:00
Alias	String	环境别名 示例值：alias
Status	String	环境状态 示例值：normal
Region	String	环境地域 示例值：ap-shanghai
EnvType	String	环境类型 tcbr ｜ run 示例值：tcbr
SubnetIds	String	子网id 示例值：subnet-4l06atqr cloud_run_cluster_pod_subnet3
Recycle	String	回收标志，为空则表示正常，recycle表示已回收 示例值：recycle

EnvInfo

环境信息

被如下接口引用：DescribeCloudRunEnvs。

名称	类型	描述
EnvId	String	账户下该环境唯一标识 示例值：prod-6gvwy9lua50e9504
Source	String	环境来源。包含以下取值： miniapp：微信小程序 qcloud ：腾讯云 示例值：qcloud
Alias	String	环境别名，要以a-z开头，不能包含 a-zA-z0-9- 以外的字符 示例值：tcb
CreateTime	String	创建时间 示例值：2021-04-26T12:00:00+08:00
UpdateTime	String	最后修改时间 示例值：2021-04-26T12:00:00+08:00
Status	String	环境状态。包含以下取值： NORMAL：正常可用 UNAVAILABLE：服务不可用，可能是尚未初始化或者初始化过程中 示例值：NORMAL
IsAutoDegrade	Boolean	是否到期自动降为免费版 示例值：false
EnvChannel	String	环境渠道 示例值：qc_console
PayMode	String	支付方式。包含以下取值： prepayment：预付费 postpaid：后付费 示例值：postpaid
IsDefault	Boolean	是否为默认环境 示例值：false
Region	String	环境所属地域 示例值：ap-shanghai
EnvType	String	环境类型：baas, run, hosting, weda,tcbr 示例值：baas
Databases	Array of DatabasesInfo	数据库列表
Storages	Array of StorageInfo	存储列表
Functions	Array of FunctionInfo	函数列表
LogServices	Array of LogServiceInfo	云日志服务列表
StaticStorages	Array of StaticStorageInfo	静态资源信息
Tags	Array of Tag	环境标签列表
CustomLogServices	Array of ClsInfo	自定义日志服务
PackageId	String	tcb产品套餐ID，参考DescribePackages接口的返回值。 示例值：basic1
PackageName	String	套餐中文名称，参考DescribePackages接口的返回值。 示例值：基础版1

FunctionInfo

函数的信息

被如下接口引用：DescribeCloudRunEnvs。

名称	类型	描述
Namespace	String	命名空间 示例值：tcb
Region	String	所属地域。 当前支持ap-shanghai 示例值：ap-shanghai

HpaPolicy

扩缩容入参

被如下接口引用：CreateCloudRunServer, DescribeCloudRunServerDetail, UpdateCloudRunServer。

名称	类型	必选	描述
PolicyType	String	是	扩缩容类型 示例值：cpu, mem, cpu/mem
PolicyThreshold	Integer	是	扩缩容阈值 示例值：60

LogServiceInfo

云日志服务相关信息

被如下接口引用：DescribeCloudRunEnvs。

名称	类型	描述
LogsetName	String	log名 示例值：tcbr-pre-01
LogsetId	String	log-id 示例值：qp3g3ca
TopicName	String	topic名 示例值：topic01
TopicId	String	topic-id 示例值：oc80v5zp
Region	String	cls日志所属地域 示例值：ap-shanghai

ObjectKV

通用Key Value

被如下接口引用：ReleaseGray。

名称	类型	必选	描述
Key	String	是	键值对Key 示例值：key
Value	String	是	键值对Value 示例值：value

OnlineVersionInfo

在线版本信息

被如下接口引用：DescribeCloudRunServerDetail。

名称	类型	描述
VersionName	String	版本名 示例值：test-001
ImageUrl	String	镜像url 示例值：imageurl
FlowRatio	String	流量 示例值：100

RepositoryInfo

代码仓库信息

被如下接口引用：CreateCloudRunServer, UpdateCloudRunServer。

名称	类型	必选	描述
Source	String	是	git source 示例值：github
Repo	String	是	仓库名 示例值：xxx/xxxx
Branch	String	是	分支名 示例值：master

ServerBaseConfig

服务基础配置信息

被如下接口引用：CreateCloudRunServer, DescribeCloudRunServerDetail, UpdateCloudRunServer。

名称	类型	必选	描述
EnvId	String	是	环境 Id 示例值：test-1gbtbgkjf8f48e2c
ServerName	String	是	服务名 示例值：server-name
OpenAccessTypes	Array of String	是	是否开启公网访问 示例值：["PUBLIC", "OA", "MINIAPP", "VPC"]
Cpu	Float	是	Cpu 规格 示例值：0.25
Mem	Float	是	Mem 规格 示例值：0.25
MinNum	Integer	是	最小副本数 示例值：1
MaxNum	Integer	是	最大副本数 示例值：2
PolicyDetails	Array of HpaPolicy	是	扩缩容配置
CustomLogs	String	是	日志采集路径 示例值：stdout
EnvParams	String	是	环境变量 示例值：{"MYSQL_USERNAME":"root"}
InitialDelaySeconds	Integer	是	延迟检测时间 示例值：2
CreateTime	String	是	创建时间 示例值："2022-03-10 19:44:07"
Port	Integer	是	服务端口 示例值：8080
HasDockerfile	Boolean	是	是否有Dockerfile 示例值：true
Dockerfile	String	是	Dockerfile 文件名 示例值："Dickerfile"
BuildDir	String	是	构建目录 示例值：src/
LogType	String	否	日志类型: none | default | custom 示例值：none
LogSetId	String	否	cls setId 示例值：dafslakfjkdal
LogTopicId	String	否	cls 主题id 示例值：sfafkslkfj
LogParseType	String	否	解析类型：json ｜ line 示例值：json
Tag	String	否	服务标签, function: 函数托管 示例值：function
InternalAccess	String	否	内网访问开关 close | open 示例值：close
InternalDomain	String	否	内网域名 示例值：https://sdfsdf
OperationMode	String	否	运行模式 示例值：custom
TimerScale	Array of TimerScale	否	定时扩缩容配置
EntryPoint	Array of String	否	Dockerfile EntryPoint 参数 示例值：["echo"]
Cmd	Array of String	否	Dockerfile Cmd 参数 示例值：["echo"]
SessionAffinity	String	否	会话亲和性开关 注意：此字段可能返回 null，表示取不到有效值。 示例值：open
VpcConf	VpcConf	否	Vpc 配置参数
VolumesConf	Array of VolumeConf	否	存储配置信息

ServerBaseInfo

服务基本信息

被如下接口引用：DescribeCloudRunServerDetail, DescribeCloudRunServers。

名称	类型	描述
ServerName	String	服务名 示例值：serverName
DefaultDomainName	String	默认服务域名 示例值：http://xxx.xxx.xxx
CustomDomainName	String	自定义域名 示例值：http://xxx.xxx.xxx
Status	String	服务状态：running/deploying/deploy_failed 示例值：runnig
UpdateTime	String	更新时间 示例值：2022-03-09 14:00:00
AccessTypes	Array of String	公网访问类型 示例值：["OA","MINIAPP","VPC"]
CustomDomainNames	Array of String	展示自定义域名 示例值：["http://xxx.xxx.xxx","http://xxx.xxx.xxx"]
ServerType	String	服务类型: function 云函数2.0；container 容器服务 示例值：function
TrafficType	String	流量类型，目前只有 FLOW 示例值：FLOW
CreateTime	String	创建时间 示例值：2022-03-09 14:00:00

ServerManageTaskInfo

服务管理任务信息

被如下接口引用：DescribeServerManageTask。

名称	类型	描述
Id	Integer	任务Id 示例值：1000
EnvId	String	环境Id 示例值：test-1gbtbgkjf8f48e2c
ServerName	String	服务名 示例值：server-name
CreateTime	String	创建时间 示例值：2022-05-27 15:00:00
ChangeType	String	变更类型 示例值：CONFIG
ReleaseType	String	发布类型 示例值：GRAY
DeployType	String	部署类型 示例值：package
PreVersionName	String	上一个版本名 示例值：test-001
VersionName	String	版本名 示例值：test-002
PipelineId	Integer	流水线Id 示例值：100
PipelineTaskId	Integer	流水线任务Id 示例值：12121
ReleaseId	Integer	发布单Id 示例值：1212
Status	String	状态 示例值：finished
Steps	Array of TaskStepInfo	步骤信息
FailReason	String	失败原因 示例值：failed
OperatorRemark	String	操作标识 示例值：remark

StaticStorageInfo

静态CDN资源信息

被如下接口引用：DescribeCloudRunEnvs。

名称	类型	描述
StaticDomain	String	静态CDN域名 示例值：test-5gak4uz5bd3d7978-1257473911.tcloudbaseapp.com
DefaultDirName	String	静态CDN默认文件夹，当前为根目录 示例值：/test
Status	String	资源状态(process/online/offline/init) 示例值：online
Region	String	cos所属区域 示例值：ap-shanghai
Bucket	String	bucket信息 示例值：tcb-123456

StorageInfo

StorageInfo 资源信息

被如下接口引用：DescribeCloudRunEnvs。

名称	类型	描述
Region	String	资源所属地域。 当前支持ap-shanghai 示例值：ap-shanghai
Bucket	String	桶名，存储资源的唯一标识 示例值：tcb-123456
CdnDomain	String	cdn 域名 示例值：tcb-123456.file.mycloud.com
AppId	String	资源所属用户的腾讯云appId 示例值：1301106610

Tag

标签键值对

被如下接口引用：DescribeCloudRunEnvs。

名称	类型	必选	描述
Key	String	是	标签键 示例值：key
Value	String	是	标签值 示例值：value

TaskStepInfo

任务步骤信息

被如下接口引用：DescribeServerManageTask。

名称	类型	描述
Name	String	步骤名 示例值：CreateEnv
Status	String	未启动："todo" 运行中："running" 失败："failed" 成功结束："finished" 示例值：failed
StartTime	String	开始时间 示例值：2022-05-27 15:00:00
EndTime	String	结束时间 示例值：2022-05-27 15:00:00
CostTime	Integer	消耗时间：秒 示例值：10
FailReason	String	失败原因 示例值：failed

TimerScale

定时扩缩容配置

被如下接口引用：CreateCloudRunServer, DescribeCloudRunServerDetail, UpdateCloudRunServer。

名称	类型	必选	描述
CycleType	String	否	循环类型 示例值：none
StartDate	String	否	循环起始 示例值：2022-09-08
EndDate	String	否	循环结束 示例值：2022-09-08
StartTime	String	否	起始时间 示例值：00:00:00
EndTime	String	否	结束时间 示例值：23:59:00
ReplicaNum	Integer	否	副本个数 示例值：1

VersionFlowInfo

版本流量信息

被如下接口引用：ReleaseGray。

名称	类型	必选	描述
VersionName	String	是	版本名 示例值：server-001
IsDefaultPriority	Boolean	是	是否默认版本 示例值：false
FlowRatio	Integer	否	流量比例 示例值：10
UrlParam	ObjectKV	否	测试KV值
Priority	Integer	否	权重 示例值：100

VolumeConf

存储配置

被如下接口引用：CreateCloudRunServer, DescribeCloudRunServerDetail, UpdateCloudRunServer。

名称	类型	必选	描述
Type	String	否	存储类型 示例值："COS","CFS"
BucketName	String	否	对象存储桶名称 示例值：xxx-appid
Endpoint	String	否	存储连接地址 示例值：https://cos.ap-shanghai
KeyID	String	否	存储连接用户密码 示例值：xxxx-xxxx
DstPath	String	否	存储挂载目的目录 示例值：/data
SrcPath	String	否	存储挂载源目录 示例值：/data

VpcConf

云托管服务 Vpc 配置

被如下接口引用：CreateCloudRunServer, DescribeCloudRunServerDetail, UpdateCloudRunServer。

名称	类型	必选	描述
VpcId	String	否	vpc id 示例值："vpc-xxx"
VpcCIDR	String	否	vpc 网段 示例值："192.168.0.0/24"
SubnetId	String	否	subnet id 示例值："subnet-xxx"
SubnetCIDR	String	否	subnet 网段 示例值："192.168.0.0/25"