开发指南

API 文档

数据结构

最近更新时间:2022-04-26 06:16:18

我的收藏

ActivityInfoItem

活动信息

被如下接口引用:DescribeActivityInfo。

名称 类型 描述
ActivityId Integer 活动id
CreateTime String 记录插入时间
UpdateTime String 记录最后一次变更时间
StartTime String 活动开始时间
ExpireTime String 活动结束时间
Tag String 自定义备注信息

ActivityRecordItem

活动详情

被如下接口引用:DescribeActivityRecord。

名称 类型 描述
Uin String 用户uin
注意:此字段可能返回 null,表示取不到有效值。
ActivityId Integer 活动id
注意:此字段可能返回 null,表示取不到有效值。
Status Integer 自定义状态码
注意:此字段可能返回 null,表示取不到有效值。
SubStatus String 自定义子状态码
注意:此字段可能返回 null,表示取不到有效值。
SubStatusInt Integer 整型子状态码
注意:此字段可能返回 null,表示取不到有效值。
IsDeleted Boolean 是否软删除
注意:此字段可能返回 null,表示取不到有效值。

AuthDomain

合法域名

被如下接口引用:DescribeAuthDomains。

名称 类型 描述
Id String 域名ID
Domain String 域名
Type String 域名类型。包含以下取值:
  • SYSTEM
  • USER
  • Status String 状态。包含以下取值:
  • ENABLE
  • DISABLE
  • CreateTime Timestamp 创建时间
    UpdateTime Timestamp 更新时间

    BackendServiceInfo

    网关服务信息

    被如下接口引用:DescribeStandaloneGateway。

    名称 类型 描述
    ServiceName String 服务名称
    Status String 服务状态

    CloudBaseCapabilities

    cloudrun安全特性能力

    被如下接口引用:CreateCloudBaseRunServerVersion。

    名称 类型 必选 描述
    Add Array of String 启用安全能力项列表
    注意:此字段可能返回 null,表示取不到有效值。
    Drop Array of String 禁用安全能力向列表
    注意:此字段可能返回 null,表示取不到有效值。

    CloudBaseCodeRepoDetail

    代码仓库里 Repo的信息描述

    被如下接口引用:CreateCloudBaseRunServerVersion, DescribeCloudBaseRunVersionSnapshot, RollUpdateCloudBaseRunServerVersion。

    名称 类型 必选 描述
    Name CloudBaseCodeRepoName repo的名字
    Url String repo的url

    CloudBaseCodeRepoName

    代码仓库 repo的名字

    被如下接口引用:CreateCloudBaseRunServerVersion, RollUpdateCloudBaseRunServerVersion。

    名称 类型 必选 描述
    Name String repo的名字
    注意:此字段可能返回 null,表示取不到有效值。
    FullName String repo的完整全名
    注意:此字段可能返回 null,表示取不到有效值。

    CloudBaseEsInfo

    es信息

    被如下接口引用:CreateCloudBaseRunServerVersion, EstablishCloudBaseRunServer。

    名称 类型 必选 描述
    Id Integer es的id
    注意:此字段可能返回 null,表示取不到有效值。
    SecretName String secret名字
    注意:此字段可能返回 null,表示取不到有效值。
    Ip String ip地址
    注意:此字段可能返回 null,表示取不到有效值。
    Port Integer 端口
    注意:此字段可能返回 null,表示取不到有效值。
    Index String 索引
    注意:此字段可能返回 null,表示取不到有效值。
    Account String 用户名
    注意:此字段可能返回 null,表示取不到有效值。
    Password String 密码
    注意:此字段可能返回 null,表示取不到有效值。

    CloudBaseProjectVersion

    云开发项目版本

    被如下接口引用:DescribeCloudBaseProjectLatestVersionList, DescribeCloudBaseProjectVersionList。

    名称 类型 描述
    Name String 项目名
    Sam String SAM json
    注意:此字段可能返回 null,表示取不到有效值。
    Source CodeSource 来源类型
    注意:此字段可能返回 null,表示取不到有效值。
    CreateTime Integer 创建时间, unix时间戳
    注意:此字段可能返回 null,表示取不到有效值。
    UpdateTime Integer 更新时间 ,unix时间戳
    注意:此字段可能返回 null,表示取不到有效值。
    Status String 项目状态, 枚举值:
    "creatingEnv"-创建环境中
    "createEnvFail"-创建环境失败
    "building"-构建中
    "buildFail"-构建失败
    "deploying"-部署中
    "deployFail"-部署失败
    "success"-部署成功
    注意:此字段可能返回 null,表示取不到有效值。
    Parameters Array of KVPair 环境变量
    注意:此字段可能返回 null,表示取不到有效值。
    Type String 项目类型, 枚举值:
    "framework-oneclick" 控制台一键部署
    "framework-local-oneclick" cli本地一键部署
    "qci-extension-cicd" 内网coding ci cd
    注意:此字段可能返回 null,表示取不到有效值。
    CIId String ci的id
    注意:此字段可能返回 null,表示取不到有效值。
    CDId String cd的id
    注意:此字段可能返回 null,表示取不到有效值。
    EnvId String 环境id
    注意:此字段可能返回 null,表示取不到有效值。
    VersionNum Integer 版本号
    注意:此字段可能返回 null,表示取不到有效值。
    FailReason String 错误原因
    注意:此字段可能返回 null,表示取不到有效值。
    RcJson String rc.json内容
    注意:此字段可能返回 null,表示取不到有效值。
    AddonConfig String 插件配置内容
    注意:此字段可能返回 null,表示取不到有效值。
    Tags Array of String 标签
    注意:此字段可能返回 null,表示取不到有效值。
    NetworkConfig String 网络配置
    注意:此字段可能返回 null,表示取不到有效值。
    ExtensionId String 扩展id
    注意:此字段可能返回 null,表示取不到有效值。
    FailType String 错误类型
    注意:此字段可能返回 null,表示取不到有效值。
    RepoUrl String 私有仓库地址
    注意:此字段可能返回 null,表示取不到有效值。
    AutoDeployOnCodeChange Boolean 是否私有仓库代码变更触发自动部署
    注意:此字段可能返回 null,表示取不到有效值。
    BuildPercent Integer ci部署进度(%)
    注意:此字段可能返回 null,表示取不到有效值。

    CloudBaseRunEmptyDirVolumeSource

    emptydir 数据卷详细信息

    被如下接口引用:CreateCloudBaseRunServerVersion。

    名称 类型 必选 描述
    EnableEmptyDirVolume Boolean 启用emptydir数据卷
    Medium String "","Memory","HugePages"
    SizeLimit String emptydir数据卷大小

    CloudBaseRunForGatewayConf

    独立网关云托管服务配置信息

    被如下接口引用:DescribeCloudBaseRunConfForGateWay。

    名称 类型 必选 描述
    IsZero Boolean 是否缩容到0
    Weight Integer 按百分比灰度的权重
    GrayKey String 按请求/header参数的灰度Key
    GrayValue String 按请求/header参数的灰度Value
    IsDefault Boolean 是否为默认版本(按请求/header参数)
    AccessType Integer 访问权限,对应二进制分多段,vpc内网|公网|oa
    URLs Array of String 访问的URL(域名+路径)列表
    EnvId String 环境ID
    ServerName String 服务名称
    VersionName String 版本名称
    GrayType String 灰度类型:FLOW(权重), URL_PARAMS/HEAD_PARAMS
    LbAddr String CLB的IP:Port
    ConfigType Integer 0:http访问服务配置信息, 1: 服务域名

    CloudBaseRunImageInfo

    CloudBaseRun 镜像信息

    被如下接口引用:CreateCloudBaseRunServerVersion, DescribeCloudBaseRunVersionSnapshot, RollUpdateCloudBaseRunServerVersion。

    名称 类型 必选 描述
    RepositoryName String 镜像仓库名称
    IsPublic Boolean 是否公有
    TagName String 镜像tag名称
    ServerAddr String 镜像server
    ImageUrl String 镜像拉取地址

    CloudBaseRunImageSecretInfo

    ImageSecretInfo的信息

    被如下接口引用:CreateCloudBaseRunServerVersion。

    名称 类型 必选 描述
    RegistryServer String 镜像地址
    UserName String 用户名
    Password String 仓库密码
    Email String 邮箱

    CloudBaseRunKVPriority

    KV参数的优先级

    被如下接口引用:DescribeCloudBaseRunServer。

    名称 类型 描述
    Key String 参数的Key
    注意:此字段可能返回 null,表示取不到有效值。
    Value String 参数的Value
    注意:此字段可能返回 null,表示取不到有效值。
    Priority Integer 优先级
    注意:此字段可能返回 null,表示取不到有效值。

    CloudBaseRunNfsVolumeSource

    nfs挂载资源

    被如下接口引用:CreateCloudBaseRunServerVersion, RollUpdateCloudBaseRunServerVersion。

    名称 类型 必选 描述
    Server String NFS挂载Server
    Path String Server路径
    ReadOnly Boolean 是否只读
    SecretName String secret名称
    EnableEmptyDirVolume Boolean 临时目录

    CloudBaseRunServerVersionItem

    版本的列表

    被如下接口引用:DescribeCloudBaseRunServer。

    名称 类型 描述
    VersionName String 版本名称
    Status String 状态
    注意:此字段可能返回 null,表示取不到有效值。
    FlowRatio Integer 流量占比
    CreatedTime String 创建时间
    注意:此字段可能返回 null,表示取不到有效值。
    UpdatedTime String 更新时间
    注意:此字段可能返回 null,表示取不到有效值。
    BuildId Integer 构建ID
    注意:此字段可能返回 null,表示取不到有效值。
    UploadType String 构建方式
    注意:此字段可能返回 null,表示取不到有效值。
    Remark String 备注
    注意:此字段可能返回 null,表示取不到有效值。
    UrlParam ObjectKV url中的参数路径
    注意:此字段可能返回 null,表示取不到有效值。
    Priority Integer 优先级(数值越小,优先级越高)
    注意:此字段可能返回 null,表示取不到有效值。
    IsDefaultPriority Boolean 是否是默认兜底版本
    注意:此字段可能返回 null,表示取不到有效值。
    FlowParams Array of CloudBaseRunKVPriority KV Params
    注意:此字段可能返回 null,表示取不到有效值。
    MinReplicas Integer 最小副本数
    注意:此字段可能返回 null,表示取不到有效值。
    MaxReplicas Integer 最大副本数
    注意:此字段可能返回 null,表示取不到有效值。
    RunId String 操作记录id
    注意:此字段可能返回 null,表示取不到有效值。
    Percent Integer 进度
    注意:此字段可能返回 null,表示取不到有效值。
    CurrentReplicas Integer 当前副本数
    注意:此字段可能返回 null,表示取不到有效值。
    Architecture String Monolithic,Microservice
    注意:此字段可能返回 null,表示取不到有效值。

    CloudBaseRunServiceVolumeMount

    对标 EKS VolumeMount

    被如下接口引用:CreateCloudBaseRunServerVersion。

    名称 类型 必选 描述
    Name String Volume 名称
    MountPath String 挂载路径
    ReadOnly Boolean 是否只读
    SubPath String 子路径
    MountPropagation String 传播挂载方式

    CloudBaseRunSideSpec

    CloudBaseRun 的 Side 描述定义

    被如下接口引用:CreateCloudBaseRunServerVersion。

    名称 类型 必选 描述
    ContainerImage String 容器镜像
    注意:此字段可能返回 null,表示取不到有效值。
    ContainerPort Integer 容器端口
    注意:此字段可能返回 null,表示取不到有效值。
    ContainerName String 容器的名称
    注意:此字段可能返回 null,表示取不到有效值。
    EnvVar String kv的json字符串
    注意:此字段可能返回 null,表示取不到有效值。
    InitialDelaySeconds Integer InitialDelaySeconds 延迟多长时间启动健康检查
    注意:此字段可能返回 null,表示取不到有效值。
    Cpu Integer CPU大小
    注意:此字段可能返回 null,表示取不到有效值。
    Mem Integer 内存大小(单位:M)
    注意:此字段可能返回 null,表示取不到有效值。
    Security CloudBaseSecurityContext 安全特性
    注意:此字段可能返回 null,表示取不到有效值。
    VolumeMountInfos Array of CloudBaseRunVolumeMount 挂载信息
    注意:此字段可能返回 null,表示取不到有效值。

    CloudBaseRunVersionFlowItem

    版本流量占比

    被如下接口引用:ModifyCloudBaseRunServerFlowConf。

    名称 类型 必选 描述
    VersionName String 版本名称
    注意:此字段可能返回 null,表示取不到有效值。
    FlowRatio Integer 流量占比
    注意:此字段可能返回 null,表示取不到有效值。
    UrlParam ObjectKV 流量参数键值对(URL参数/HEADERS参数)
    注意:此字段可能返回 null,表示取不到有效值。
    Priority Integer 优先级
    注意:此字段可能返回 null,表示取不到有效值。
    IsDefaultPriority Boolean 是否是默认兜底版本
    注意:此字段可能返回 null,表示取不到有效值。

    CloudBaseRunVolumeMount

    cfs挂载点

    被如下接口引用:CreateCloudBaseRunServerVersion, RollUpdateCloudBaseRunServerVersion。

    名称 类型 必选 描述
    Name String 资源名
    MountPath String 挂载路径
    ReadOnly Boolean 是否只读
    NfsVolumes Array of CloudBaseRunNfsVolumeSource Nfs挂载信息

    CloudBaseRunVpcInfo

    vpc信息

    被如下接口引用:EstablishCloudBaseRunServer。

    名称 类型 必选 描述
    VpcId String vpc的id
    注意:此字段可能返回 null,表示取不到有效值。
    SubnetIds Array of String 子网id
    注意:此字段可能返回 null,表示取不到有效值。
    CreateType Integer 创建类型(0=继承; 1=新建; 2=指定)
    注意:此字段可能返回 null,表示取不到有效值。

    CloudBaseRunVpcSubnet

    子网信息

    被如下接口引用:DescribeCloudBaseRunResource, DescribeCloudBaseRunResourceForExtend。

    名称 类型 描述
    Id String 子网id
    注意:此字段可能返回 null,表示取不到有效值。
    Cidr String 子网的ipv4
    注意:此字段可能返回 null,表示取不到有效值。
    Zone String 可用区
    注意:此字段可能返回 null,表示取不到有效值。
    Type String 类型
    注意:此字段可能返回 null,表示取不到有效值。
    Target String subnet类型
    注意:此字段可能返回 null,表示取不到有效值。
    Region String 地域
    注意:此字段可能返回 null,表示取不到有效值。
    Name String 名字
    注意:此字段可能返回 null,表示取不到有效值。

    CloudBaseSecurityContext

    cloudrun安全特性

    被如下接口引用:CreateCloudBaseRunServerVersion。

    名称 类型 必选 描述
    Capabilities CloudBaseCapabilities 安全特性
    注意:此字段可能返回 null,表示取不到有效值。

    CloudRunServiceSimpleVersionSnapshot

    CloudRunServiceSimpleVersionSnapshot 信息

    被如下接口引用:DescribeCloudBaseRunVersionSnapshot。

    名称 类型 必选 描述
    VersionName String 版本名
    注意:此字段可能返回 null,表示取不到有效值。
    Remark String 版本备注
    注意:此字段可能返回 null,表示取不到有效值。
    Cpu Float cpu规格
    注意:此字段可能返回 null,表示取不到有效值。
    Mem Float 内存规格
    注意:此字段可能返回 null,表示取不到有效值。
    MinNum Integer 最小副本数
    注意:此字段可能返回 null,表示取不到有效值。
    MaxNum Integer 最大副本数
    注意:此字段可能返回 null,表示取不到有效值。
    ImageUrl String 镜像url
    注意:此字段可能返回 null,表示取不到有效值。
    PolicyType String 扩容策略
    注意:此字段可能返回 null,表示取不到有效值。
    PolicyThreshold Integer 策略阈值
    注意:此字段可能返回 null,表示取不到有效值。
    EnvParams String 环境参数
    注意:此字段可能返回 null,表示取不到有效值。
    ContainerPort Integer 容器端口
    注意:此字段可能返回 null,表示取不到有效值。
    CreateTime String 创建时间
    注意:此字段可能返回 null,表示取不到有效值。
    UpdateTime String 更新时间
    注意:此字段可能返回 null,表示取不到有效值。
    UploadType String 更新类型
    注意:此字段可能返回 null,表示取不到有效值。
    DockerfilePath String dockerfile路径
    注意:此字段可能返回 null,表示取不到有效值。
    BuildDir String 构建路径
    注意:此字段可能返回 null,表示取不到有效值。
    RepoType String repo类型
    注意:此字段可能返回 null,表示取不到有效值。
    Repo String 仓库
    注意:此字段可能返回 null,表示取不到有效值。
    Branch String 分支
    注意:此字段可能返回 null,表示取不到有效值。
    EnvId String 环境id
    注意:此字段可能返回 null,表示取不到有效值。
    ServerName String 服务名
    注意:此字段可能返回 null,表示取不到有效值。
    PackageName String package名字
    注意:此字段可能返回 null,表示取不到有效值。
    PackageVersion String package版本
    注意:此字段可能返回 null,表示取不到有效值。
    CustomLogs String 自定义log路径
    注意:此字段可能返回 null,表示取不到有效值。
    InitialDelaySeconds Integer 延时健康检查时间
    注意:此字段可能返回 null,表示取不到有效值。
    SnapshotName String snapshot名
    注意:此字段可能返回 null,表示取不到有效值。
    ImageInfo CloudBaseRunImageInfo 镜像信息
    注意:此字段可能返回 null,表示取不到有效值。
    CodeDetail CloudBaseCodeRepoDetail 代码仓库信息
    注意:此字段可能返回 null,表示取不到有效值。
    Status String 状态
    注意:此字段可能返回 null,表示取不到有效值。

    CloudRunServiceVolume

    服务的volume

    被如下接口引用:CreateCloudBaseRunServerVersion。

    名称 类型 必选 描述
    Name String 名称
    注意:此字段可能返回 null,表示取不到有效值。
    NFS CloudBaseRunNfsVolumeSource NFS的挂载方式
    注意:此字段可能返回 null,表示取不到有效值。
    SecretName String secret名称
    注意:此字段可能返回 null,表示取不到有效值。
    EnableEmptyDirVolume Boolean 是否开启临时目录逐步废弃,请使用 EmptyDir
    注意:此字段可能返回 null,表示取不到有效值。
    EmptyDir CloudBaseRunEmptyDirVolumeSource emptydir数据卷详细信息
    注意:此字段可能返回 null,表示取不到有效值。

    ClsInfo

    cls日志信息

    被如下接口引用:DescribeEnvs, DescribeWxCloudBaseRunEnvs。

    名称 类型 描述
    ClsRegion String cls所属地域
    ClsLogsetId String cls日志集ID
    ClsTopicId String cls日志主题ID
    CreateTime Timestamp 创建时间

    CodeSource

    云开发项目来源

    被如下接口引用:CreateAndDeployCloudBaseProject, DescribeCloudBaseProjectLatestVersionList, DescribeCloudBaseProjectVersionList。

    名称 类型 必选 描述
    Type String 类型, 可能的枚举: "coding","package","package_url","github","gitlab","gitee","rawcode"
    注意:此字段可能返回 null,表示取不到有效值。
    Url String 下载链接
    注意:此字段可能返回 null,表示取不到有效值。
    Name String 名称
    注意:此字段可能返回 null,表示取不到有效值。
    WorkDir String 工作目录
    注意:此字段可能返回 null,表示取不到有效值。
    CodingPackageName String code包名, type为coding的时候需要填写
    注意:此字段可能返回 null,表示取不到有效值。
    CodingPackageVersion String coding版本名, type为coding的时候需要填写
    注意:此字段可能返回 null,表示取不到有效值。
    RawCode String 源码
    注意:此字段可能返回 null,表示取不到有效值。
    Branch String 代码分支
    注意:此字段可能返回 null,表示取不到有效值。
    ProjectId Integer coding项目ID,type为coding时需要填写
    注意:此字段可能返回 null,表示取不到有效值。
    ProjectName String coding项目
    注意:此字段可能返回 null,表示取不到有效值。

    DatabasesInfo

    数据库资源信息

    被如下接口引用:DescribeEnvs, DescribeWxCloudBaseRunEnvs。

    名称 类型 描述
    InstanceId String 数据库唯一标识
    Status String 状态。包含以下取值:
  • INITIALIZING:资源初始化中
  • RUNNING:运行中,可正常使用的状态
  • UNUSABLE:禁用,不可用
  • OVERDUE:资源过期
  • Region String 所属地域。
    当前支持ap-shanghai
    UpdateTime Timestamp ISO8601 更新时间
    注意:此字段可能返回 null,表示取不到有效值。

    EndUserInfo

    终端用户信息

    被如下接口引用:DescribeEndUsers。

    名称 类型 描述
    UUId String 用户唯一ID
    WXOpenId String 微信ID
    QQOpenId String qq ID
    Phone String 手机号
    Email String 邮箱
    NickName String 昵称
    Gender String 性别
    AvatarUrl String 头像地址
    UpdateTime String 更新时间
    CreateTime String 创建时间
    IsAnonymous Boolean 是否为匿名用户
    IsDisabled Boolean 是否禁用账户
    HasPassword Boolean 是否设置过密码
    UserName String 用户名

    EnvBillingInfoItem

    环境计费信息

    被如下接口引用:DescribeExtraPkgBillingInfo。

    名称 类型 描述
    EnvId String 环境ID
    PackageId String tcb产品套餐ID,参考DescribePackages接口的返回值。
    IsAutoRenew Boolean 自动续费标记
    Status String 状态。包含以下取值:
  • 空字符串:初始化中
  • NORMAL:正常
  • ISOLATE:隔离
  • PayMode String 支付方式。包含以下取值:
  • PREPAYMENT:预付费
  • POSTPAID:后付费
  • IsolatedTime String 隔离时间,最近一次隔离的时间
    ExpireTime String 过期时间,套餐即将到期的时间
    CreateTime String 创建时间,第一次接入计费方案的时间。
    UpdateTime String 更新时间,计费信息最近一次更新的时间。
    IsAlwaysFree Boolean true表示从未升级过付费版。
    PaymentChannel String 付费渠道。
  • miniapp:小程序
  • qcloud:腾讯云

  • 注意:此字段可能返回 null,表示取不到有效值。
    OrderInfo OrderInfo 最新的订单信息
    注意:此字段可能返回 null,表示取不到有效值。
    FreeQuota String 免费配额信息。
    注意:此字段可能返回 null,表示取不到有效值。

    EnvInfo

    环境信息

    被如下接口引用:DescribeEnvs, DescribeWxCloudBaseRunEnvs。

    名称 类型 描述
    EnvId String 账户下该环境唯一标识
    Source String 环境来源。包含以下取值:
  • miniapp:微信小程序
  • qcloud :腾讯云
  • Alias String 环境别名,要以a-z开头,不能包含 a-zA-z0-9- 以外的字符
    CreateTime Timestamp 创建时间
    UpdateTime Timestamp 最后修改时间
    Status String 环境状态。包含以下取值:
  • NORMAL:正常可用
  • UNAVAILABLE:服务不可用,可能是尚未初始化或者初始化过程中
  • Databases Array of DatabasesInfo 数据库列表
    Storages Array of StorageInfo 存储列表
    Functions Array of FunctionInfo 函数列表
    PackageId String tcb产品套餐ID,参考DescribePackages接口的返回值。
    注意:此字段可能返回 null,表示取不到有效值。
    PackageName String 套餐中文名称,参考DescribePackages接口的返回值。
    注意:此字段可能返回 null,表示取不到有效值。
    LogServices Array of LogServiceInfo 云日志服务列表
    注意:此字段可能返回 null,表示取不到有效值。
    StaticStorages Array of StaticStorageInfo 静态资源信息
    注意:此字段可能返回 null,表示取不到有效值。
    IsAutoDegrade Boolean 是否到期自动降为免费版
    注意:此字段可能返回 null,表示取不到有效值。
    EnvChannel String 环境渠道
    注意:此字段可能返回 null,表示取不到有效值。
    PayMode String 支付方式。包含以下取值:
  • prepayment:预付费
  • postpaid:后付费

  • 注意:此字段可能返回 null,表示取不到有效值。
    IsDefault Boolean 是否为默认环境
    注意:此字段可能返回 null,表示取不到有效值。
    Region String 环境所属地域
    注意:此字段可能返回 null,表示取不到有效值。
    Tags Array of Tag 环境标签列表
    注意:此字段可能返回 null,表示取不到有效值。
    CustomLogServices Array of ClsInfo 自定义日志服务
    注意:此字段可能返回 null,表示取不到有效值。
    EnvType String 环境类型:baas, run, hoting, weda
    注意:此字段可能返回 null,表示取不到有效值。
    IsDauPackage Boolean 是否是dau新套餐
    注意:此字段可能返回 null,表示取不到有效值。

    ExtensionFile

    扩展文件

    被如下接口引用:DescribeExtensionUploadInfo。

    名称 类型 必选 描述
    FileType String 文件类型。枚举值
  • FUNCTION:函数代码
  • STATIC:静态托管代码
  • SMS:短信文件
  • FileName String 文件名,长度不超过24

    ExtensionFileInfo

    扩展文件信息

    被如下接口引用:DescribeExtensionUploadInfo。

    名称 类型 描述
    CodeUri String 模板里使用的地址
    UploadUrl String 上传文件的临时地址,含签名
    CustomKey String 自定义密钥。如果为空,则表示不需要加密
    MaxSize Integer 文件大小限制,单位M,客户端上传前需要主动检查文件大小,超过限制的文件会被删除。

    FreequotaInfo

    后付费资源免费量信息

    被如下接口引用:DescribePostpayFreeQuotas。

    名称 类型 描述
    ResourceType String 资源类型
  • COS
  • CDN
  • FLEXDB
  • SCF
  • ResourceMetric String 资源指标名称
    FreeQuota Integer 资源指标免费量
    MetricUnit String 指标单位
    DeductType String 免费量抵扣周期
  • sum-month:以月为单位抵扣
  • sum-day:以天为单位抵扣
  • totalize:总容量抵扣

  • 注意:此字段可能返回 null,表示取不到有效值。
    FreeQuotaType String 免费量类型
  • basic:通用量抵扣

  • 注意:此字段可能返回 null,表示取不到有效值。

    FunctionInfo

    函数的信息

    被如下接口引用:DescribeEnvs, DescribeWxCloudBaseRunEnvs。

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

    HpaPolicy

    扩缩容策略

    被如下接口引用:CreateCloudBaseRunServerVersion, DescribeCloudBaseRunServerVersion, RollUpdateCloudBaseRunServerVersion。

    名称 类型 必选 描述
    PolicyType String 策略类型
    注意:此字段可能返回 null,表示取不到有效值。
    PolicyThreshold Integer 策略阈值
    注意:此字段可能返回 null,表示取不到有效值。

    KVPair

    键值对

    被如下接口引用:CreateAndDeployCloudBaseProject, DescribeCloudBaseBuildService, DescribeCloudBaseProjectLatestVersionList, DescribeCloudBaseProjectVersionList。

    名称 类型 必选 描述
    Key String
    Value String

    LogObject

    CLS日志单条信息

    被如下接口引用:SearchClsLog。

    名称 类型 描述
    TopicId String 日志属于的 topic ID
    TopicName String 日志主题的名字
    Timestamp String 日志时间
    Content String 日志内容
    FileName String 采集路径
    Source String 日志来源设备

    LogResObject

    CLS日志结果

    被如下接口引用:SearchClsLog。

    名称 类型 描述
    Context String 获取更多检索结果的游标
    ListOver Boolean 搜索结果是否已经全部返回
    Results Array of LogObject 日志内容信息

    LogServiceInfo

    云日志服务相关信息

    被如下接口引用:DescribeEnvs, DescribeWxCloudBaseRunEnvs。

    名称 类型 描述
    LogsetName String log名
    LogsetId String log-id
    TopicName String topic名
    TopicId String topic-id
    Region String cls日志所属地域

    LoginStatistic

    终端用户登录新增统计

    被如下接口引用:DescribeEndUserLoginStatistic。

    名称 类型 必选 描述
    StatisticalType String 统计类型 新增NEWUSER 和登录 LOGIN
    注意:此字段可能返回 null,表示取不到有效值。
    StatisticalCycle String 统计周期:日DAY,周WEEK,月MONTH
    注意:此字段可能返回 null,表示取不到有效值。
    Count Integer 统计总量
    注意:此字段可能返回 null,表示取不到有效值。
    UpdateTime String 更新时间
    注意:此字段可能返回 null,表示取不到有效值。

    ObjectKV

    Key-Value类型,模拟的 object 类型

    被如下接口引用:DescribeCloudBaseRunServer, ModifyCloudBaseRunServerFlowConf。

    名称 类型 描述
    Key String object 的 key
    Value String object key 对应的 value

    OneClickTaskStepInfo

    一键部署步骤信息

    被如下接口引用:DescribeCloudBaseRunOneClickTaskExternal。

    名称 类型 描述
    Status String 未启动:"todo"
    运行中:"running"
    失败:"failed"
    成功结束:"finished"
    StartTime String 开始时间
    EndTime String 结束时间
    CostTime Integer 耗时:秒
    FailReason String 失败原因
    Name String 步骤名

    OrderInfo

    订单信息

    被如下接口引用:DescribeExtraPkgBillingInfo。

    名称 类型 描述
    TranId String 订单号
    PackageId String 订单要切换的套餐ID
    TranType String 订单类型
  • 1 购买
  • 2 续费
  • 3 变配
  • TranStatus String 订单状态。
  • 1未支付
  • 2 支付中
  • 3 发货中
  • 4 发货成功
  • 5 发货失败
  • 6 已退款
  • 7 已取消
  • 100 已删除
  • UpdateTime String 订单更新时间
    CreateTime String 订单创建时间
    PayMode String 付费模式.
  • prepayment 预付费
  • postpaid 后付费
  • ExtensionId String 订单绑定的扩展ID
    注意:此字段可能返回 null,表示取不到有效值。
    ResourceReady String 资源初始化结果(仅当ExtensionId不为空时有效): successful(初始化成功), failed(初始化失败), doing(初始化进行中), init(准备初始化)
    注意:此字段可能返回 null,表示取不到有效值。
    Flag String 安装标记。建议使用方统一转大小写之后再判断。
  • QuickStart:快速启动来源
  • Activity:活动来源

  • 注意:此字段可能返回 null,表示取不到有效值。
    ReqBody String 下单时的参数

    PackageFreeQuotaInfo

    后付费免费额度

    被如下接口引用:DescribePostpayPackageFreeQuotas。

    名称 类型 描述
    ResourceType String 资源类型
  • COS
  • CDN
  • FLEXDB
  • SCF

  • 注意:此字段可能返回 null,表示取不到有效值。
    ResourceMetric String 资源指标名称
    注意:此字段可能返回 null,表示取不到有效值。
    FreeQuota Integer 资源指标免费量
    注意:此字段可能返回 null,表示取不到有效值。
    MetricUnit String 指标单位
    注意:此字段可能返回 null,表示取不到有效值。
    DeductType String 免费量抵扣周期
  • sum-month:以月为单位抵扣
  • sum-day:以天为单位抵扣
  • totalize:总容量抵扣

  • 注意:此字段可能返回 null,表示取不到有效值。
    FreeQuotaType String 免费量类型
  • basic:通用量抵扣

  • 注意:此字段可能返回 null,表示取不到有效值。

    PlatformStatistic

    终端用户平台统计信息

    被如下接口引用:DescribeEndUserStatistic。

    名称 类型 必选 描述
    Platform String 终端用户从属平台
    注意:此字段可能返回 null,表示取不到有效值。
    Count Integer 平台终端用户数
    注意:此字段可能返回 null,表示取不到有效值。
    UpdateTime String 更新时间
    注意:此字段可能返回 null,表示取不到有效值。

    PostPaidEnvDeductInfo

    后付费计费详情

    被如下接口引用:DescribeEnvPostpaidDeduct。

    名称 类型 描述
    ResourceType String 资源方
    注意:此字段可能返回 null,表示取不到有效值。
    MetricName String 指标名
    注意:此字段可能返回 null,表示取不到有效值。
    ResQuota Float 按量计费详情
    注意:此字段可能返回 null,表示取不到有效值。
    PkgQuota Float 资源包抵扣详情
    注意:此字段可能返回 null,表示取不到有效值。
    FreeQuota Float 免费额度抵扣详情
    注意:此字段可能返回 null,表示取不到有效值。
    EnvId String 环境id
    注意:此字段可能返回 null,表示取不到有效值。

    PostpayEnvQuota

    按量付费免费配额信息

    被如下接口引用:DescribeEnvFreeQuota。

    名称 类型 描述
    ResourceType String 资源类型
    MetricName String 指标名
    Value Integer 配额值
    StartTime String 配额生效时间
    为空表示没有时间限制
    EndTime String 配额失效时间
    为空表示没有时间限制

    SmsFreeQuota

    短信免费量

    被如下接口引用:DescribeSmsQuotas。

    名称 类型 描述
    FreeQuota Integer 免费量总条数
    注意:此字段可能返回 null,表示取不到有效值。
    TotalUsedQuota Integer 共计已使用总条数
    注意:此字段可能返回 null,表示取不到有效值。
    CycleStart String 免费周期起点,0000-00-00 00:00:00 形式
    注意:此字段可能返回 null,表示取不到有效值。
    CycleEnd String 免费周期终点,0000-00-00 00:00:00 形式
    注意:此字段可能返回 null,表示取不到有效值。
    TodayUsedQuota Integer 今天已使用总条数
    注意:此字段可能返回 null,表示取不到有效值。

    SpecialCostItem

    1分钱计费详情

    被如下接口引用:DescribeSpecialCostItems。

    名称 类型 描述
    ReportDate String 上报日期
    注意:此字段可能返回 null,表示取不到有效值。
    Uin String 腾讯云uin
    注意:此字段可能返回 null,表示取不到有效值。
    EnvId String 资源id:环境id
    注意:此字段可能返回 null,表示取不到有效值。
    Status String 上报任务状态
    注意:此字段可能返回 null,表示取不到有效值。

    StandaloneGatewayInfo

    独立网关信息

    被如下接口引用:DescribeStandaloneGateway。

    名称 类型 描述
    GatewayName String 独立网关名称
    CPU Float CPU核心数
    Mem Integer 内存大小,单位MB
    PackageVersion String 套餐包版本名称
    GatewayAlias String 网关别名
    VpcId String 私有网络ID
    SubnetIds Array of String 子网ID列表
    GatewayDesc String 网关描述
    GateWayStatus String 网关状态
    ServiceInfo BackendServiceInfo 服务信息
    PublicClbIp String 公网CLBIP
    InternalClbIp String 内网CLBIP

    StandaloneGatewayPackageInfo

    小租户网关套餐配置

    被如下接口引用:DescribeStandaloneGatewayPackage。

    名称 类型 描述
    CPU Float CPU核心数
    Mem Integer 内存大小,单位MB
    PackageVersion String 套餐包版本名称

    StaticStorageInfo

    静态CDN资源信息

    被如下接口引用:DescribeEnvs, DescribeWxCloudBaseRunEnvs。

    名称 类型 描述
    StaticDomain String 静态CDN域名
    注意:此字段可能返回 null,表示取不到有效值。
    DefaultDirName String 静态CDN默认文件夹,当前为根目录
    注意:此字段可能返回 null,表示取不到有效值。
    Status String 资源状态(process/online/offline/init)
    注意:此字段可能返回 null,表示取不到有效值。
    Region String cos所属区域
    注意:此字段可能返回 null,表示取不到有效值。
    Bucket String bucket信息
    注意:此字段可能返回 null,表示取不到有效值。

    StorageInfo

    StorageInfo 资源信息

    被如下接口引用:DescribeEnvs, DescribeWxCloudBaseRunEnvs。

    名称 类型 描述
    Region String 资源所属地域。
    当前支持ap-shanghai
    Bucket String 桶名,存储资源的唯一标识
    CdnDomain String cdn 域名
    AppId String 资源所属用户的腾讯云appId

    Tag

    标签键值对

    被如下接口引用:DescribeEnvs, DescribeWxCloudBaseRunEnvs。

    名称 类型 必选 描述
    Key String 标签键
    Value String 标签值
    目录