数据结构

最近更新时间:2025-01-13 01:24:51

我的收藏

ActivityInfoItem

活动信息

被如下接口引用:DescribeActivityInfo。

名称 类型 描述
ActivityId Integer 活动id
示例值:18462
CreateTime String 记录插入时间
示例值:"2021-08-15 15:04:43"
UpdateTime String 记录最后一次变更时间
示例值:"2021-08-15 15:04:43"
StartTime String 活动开始时间
示例值:"2021-08-15 15:04:43"
ExpireTime String 活动结束时间
示例值:"2021-08-15 15:04:43"
Tag String 自定义备注信息
示例值:"运营活动"

ActivityRecordItem

活动详情

被如下接口引用:DescribeActivityRecord。

名称 类型 描述
Uin String 用户uin
示例值:1000000454851
ActivityId Integer 活动id
示例值:114514
Status Integer 自定义状态码
示例值:2
SubStatus String 自定义子状态码
示例值:5
SubStatusInt Integer 整型子状态码
示例值:3
IsDeleted Boolean 是否软删除
示例值:true

AuthDomain

合法域名

被如下接口引用:DescribeAuthDomains。

名称 类型 描述
Id String 域名ID
示例值:114514
Domain String 域名
示例值:cloudbase.tencentcloud.com
Type String 域名类型。包含以下取值:
  • SYSTEM
  • USER

  • 示例值:USER
    Status String 状态。包含以下取值:
  • ENABLE
  • DISABLE

  • 示例值:ENABLE
    CreateTime Timestamp 创建时间
    示例值:2024-01-01 00:00:00
    UpdateTime Timestamp 更新时间
    示例值:2024-01-01 00:00:00

    BaasPackageInfo

    云开发新套餐详情

    被如下接口引用:DescribeBaasPackageList。

    名称 类型 描述
    PackageName String DAU产品套餐ID
    示例值:personal_calculation
    PackageTitle String DAU套餐中文名称
    示例值:个人版-计算型
    GroupName String 套餐分组
    示例值:calculation
    GroupTitle String 套餐分组中文名
    示例值:计算型
    BillTags String json格式化计费标签,例如:
    {"pid":2, "cids":{"create": 2, "renew": 2, "modify": 2}, "productCode":"p_tcb_mp", "subProductCode":"sp_tcb_mp_cloudbase_dau"}
    示例值:{"pid":2, "cids":{"create": 2, "renew": 2, "modify": 2}, "productCode":"p_tcb_mp", "subProductCode":"sp_tcb_mp_cloudbase_dau"}
    ResourceLimit 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}}}
    示例值:参考接口示例
    AdvanceLimit String json格式化高级限制,例如:
    {"CMSEnable":false,"ProvisionedConcurrencyMem":512000, "PictureProcessing":false, "SecurityAudit":false, "RealTimePush":false, "TemplateMessageBatchPush":false, "Payment":false}
    示例值:参考接口示例
    PackageDescription String 套餐描述
    示例值:适合商家小程序
    IsExternal Boolean 是否对外展示
    示例值:false

    BackendServiceInfo

    网关服务信息

    被如下接口引用:DescribeStandaloneGateway。

    名称 类型 描述
    ServiceName String 服务名称
    示例值:demo service
    Status String 服务状态
    示例值:running

    BanConfig

    封禁配置

    被如下接口引用:DescribeGatewayVersions, ModifyGatewayVersionTraffic。

    名称 类型 必选 描述
    IpWhiteList Array of String ip白名单,支持ipv4、ipv6,支持CIDR
    示例值:["1.86.245.225","192.168.1.0/22"]
    IpBlackList Array of String ip黑名单,支持ipv4、ipv6,支持CIDR
    示例值:["2402:4e00:31:801::323","2001:db8::/127"]
    CountryWhiteList Array of String 地域白名单(国家英文名)
    示例值:["China"]
    CountryBlackList Array of String 地域黑名单(国家英文名)
    示例值:["China"]

    CbrPackageInfo

    代码包信息

    被如下接口引用:DescribeCbrServerVersion。

    名称 类型 描述
    PackageName String 代码包名称
    示例值:helloworld.zip
    PackageVersion String 代码包版本
    示例值:1673579168

    CbrRepoInfo

    仓库信息

    被如下接口引用:DescribeCbrServerVersion。

    名称 类型 描述
    Repo String 仓库名称
    示例值:helloworld/test
    RepoType String 仓库平台
    示例值:gitlab
    RepoLanguage String 仓库语言
    示例值:Go
    Branch String 分支名称
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:master

    CloudBaseCapabilities

    cloudrun安全特性能力

    被如下接口引用:CreateCloudBaseRunServerVersion。

    名称 类型 必选 描述
    Add Array of String 启用安全能力项列表
    示例值:net-admin
    Drop Array of String 禁用安全能力向列表
    示例值:net-admin

    CloudBaseCodeRepoDetail

    代码仓库里 Repo的信息描述

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

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

    CloudBaseCodeRepoName

    代码仓库 repo的名字

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

    名称 类型 必选 描述
    Name String repo的名字
    示例值:repo
    FullName String repo的完整全名
    示例值:user/repo

    CloudBaseEsInfo

    es信息

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

    名称 类型 必选 描述
    Id Integer es的id
    示例值:es-diocjklsjdk
    SecretName String secret名字
    示例值:my-secret
    Ip String ip地址
    示例值:9.1.2.6
    Port Integer 端口
    示例值:9102
    Index String 索引
    示例值:my-es-index
    Account String 用户名
    示例值:elastic
    Password String 密码
    示例值:my-password

    CloudBaseProjectVersion

    云开发项目版本

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

    名称 类型 描述
    Name String 项目名
    示例值:demo-name
    Sam String SAM json
    示例值:sam
    Source CodeSource 来源类型
    示例值:{"key":"value"}
    CreateTime Integer 创建时间, unix时间戳
    示例值:1611838208
    UpdateTime Integer 更新时间 ,unix时间戳
    示例值:1611838208
    Status String 项目状态, 枚举值:
    "creatingEnv"-创建环境中
    "createEnvFail"-创建环境失败
    "building"-构建中
    "buildFail"-构建失败
    "deploying"-部署中
    "deployFail"-部署失败
    "success"-部署成功
    示例值:success
    Parameters Array of KVPair 环境变量
    示例值:[{"key":"value"}]
    Type String 项目类型, 枚举值:
    "framework-oneclick" 控制台一键部署
    "framework-local-oneclick" cli本地一键部署
    "qci-extension-cicd" 内网coding ci cd
    示例值:framework-oneclick
    CIId String ci的id
    示例值:72a6e144-40f9-4777-a1bd-db02c1bbadf3
    CDId String cd的id
    示例值:cool
    EnvId String 环境id
    示例值:envcool
    VersionNum Integer 版本号
    示例值:1611838208
    FailReason String 错误原因
    示例值:bad
    RcJson String rc.json内容
    示例值:{"key": "value"}
    AddonConfig String 插件配置内容
    示例值:{"key":"value"}
    Tags Array of String 标签
    示例值:["hot"]
    NetworkConfig String 网络配置
    示例值:{"key":"value"}
    ExtensionId String 扩展id
    示例值:feeiild
    FailType String 错误类型
    示例值:UserError
    RepoUrl String 私有仓库地址
    示例值:https://github.com/humin09/helloworld
    AutoDeployOnCodeChange Boolean 是否私有仓库代码变更触发自动部署
    示例值:false
    BuildPercent Integer ci部署进度(%)
    示例值:100
    Uin String Uin
    示例值:1230001012
    BuildFinishTime String BuildFinishTime
    示例值:2025-01-01 00:00:00
    DeployFinishTime String DeployFinishTime
    示例值:2025-01-01 00:00:00
    BuildId String BuildId
    示例值:3152634
    SourceUrl String SourceUrl
    示例值:https://sourcerepo.git
    FailReasonShort String FailReasonShort
    示例值:shotFailReason
    FirstInitRepo String FirstInitRepo
    示例值:https://sourcerepo.git

    CloudBaseRunEmptyDirVolumeSource

    emptydir 数据卷详细信息

    被如下接口引用:CreateCloudBaseRunServerVersion。

    名称 类型 必选 描述
    EnableEmptyDirVolume Boolean 启用emptydir数据卷
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:false
    Medium String "","Memory","HugePages"
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:Memory
    SizeLimit String emptydir数据卷大小
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:1Gi

    CloudBaseRunForGatewayConf

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

    被如下接口引用:DescribeCloudBaseRunConfForGateWay。

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

    CloudBaseRunImageInfo

    CloudBaseRun 镜像信息

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

    名称 类型 必选 描述
    RepositoryName String 镜像仓库名称
    示例值:name
    IsPublic Boolean 是否公有
    示例值:false
    TagName String 镜像tag名称
    示例值:tag
    ServerAddr String 镜像server
    示例值:addr
    ImageUrl String 镜像拉取地址
    示例值:url

    CloudBaseRunImageSecretInfo

    ImageSecretInfo的信息

    被如下接口引用:CreateCloudBaseRunServerVersion。

    名称 类型 必选 描述
    RegistryServer String 镜像地址
    示例值:server
    UserName String 用户名
    示例值:name
    Password String 仓库密码
    示例值:pass
    Email String 邮箱
    示例值:@fisher1008.uu.me

    CloudBaseRunKVPriority

    KV参数的优先级

    被如下接口引用:DescribeCloudBaseRunServer。

    名称 类型 描述
    Key String 参数的Key
    示例值:key
    Value String 参数的Value
    示例值:value
    Priority Integer 优先级
    示例值:1

    CloudBaseRunNfsVolumeSource

    nfs挂载资源

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

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

    CloudBaseRunServerVersionItem

    版本的列表

    被如下接口引用:DescribeCloudBaseRunServer。

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

    CloudBaseRunServiceVolumeHostPath

    主机路径挂载参数

    被如下接口引用:CreateCloudBaseRunServerVersion。

    名称 类型 必选 描述
    Path String 主机路径
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:/test

    CloudBaseRunServiceVolumeMount

    对标 EKS VolumeMount

    被如下接口引用:CreateCloudBaseRunServerVersion。

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

    CloudBaseRunSideSpec

    CloudBaseRun 的 Side 描述定义

    被如下接口引用:CreateCloudBaseRunServerVersion。

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

    CloudBaseRunVersionFlowItem

    版本流量占比

    被如下接口引用:ModifyCloudBaseRunServerFlowConf。

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

    CloudBaseRunVersionPod

    pod信息

    被如下接口引用:DescribeCloudBaseRunPodList。

    名称 类型 描述
    Webshell String webshell链接
    示例值:url
    PodId String pod name
    示例值:pod
    PodIp String pod ip
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:ip
    Status String 状态
    示例值:normal
    CreateTime String 创建时间
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:2024-12-12 12:00:00

    CloudBaseRunVolumeMount

    cfs挂载点

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

    名称 类型 必选 描述
    Name String 资源名
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:name
    MountPath String 挂载路径
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:path
    ReadOnly Boolean 是否只读
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:true
    NfsVolumes Array of CloudBaseRunNfsVolumeSource Nfs挂载信息
    注意:此字段可能返回 null,表示取不到有效值。
    MountPropagation String 挂载配置
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:Bidirectional

    CloudBaseRunVpcInfo

    vpc信息

    被如下接口引用:EstablishCloudBaseRunServer。

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

    CloudBaseRunVpcSubnet

    子网信息

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

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

    CloudBaseSecurityContext

    cloudrun安全特性

    被如下接口引用:CreateCloudBaseRunServerVersion。

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

    CloudRunServiceSimpleVersionSnapshot

    CloudRunServiceSimpleVersionSnapshot 信息

    被如下接口引用:DescribeCloudBaseRunVersionSnapshot。

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

    CloudRunServiceVolume

    服务的volume

    被如下接口引用:CreateCloudBaseRunServerVersion。

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

    ClsInfo

    cls日志信息

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

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

    CodeSource

    云开发项目来源

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

    名称 类型 必选 描述
    Type String 类型, 可能的枚举: "coding","package","package_url","github","gitlab","gitee","rawcode"
    示例值:coding
    Url String 下载链接
    示例值:https://github.com/cool/vue
    Name String 名称
    示例值:vue
    WorkDir String 工作目录
    示例值:starter
    CodingPackageName String code包名, type为coding的时候需要填写
    示例值:demo-packageName
    CodingPackageVersion String coding版本名, type为coding的时候需要填写
    示例值:0.0.1
    RawCode String 源码
    示例值:rawCode
    Branch String 代码分支
    示例值:master
    ProjectId Integer coding项目ID,type为coding时需要填写
    示例值:1
    ProjectName String coding项目
    示例值:demo-name

    CustomHeader

    安全网关自定义头部

    被如下接口引用:DescribeWxGatewayRoutes。

    名称 类型 必选 描述
    RequestToAddList Array of CustomRequestToAdd 请求添加头部配置

    CustomLogConfig

    安全网关自定义日志配置

    被如下接口引用:DescribeGatewayVersions, ModifyGatewayVersionTraffic。

    名称 类型 必选 描述
    NeedReqBodyLog Boolean 是否需要请求体
    示例值:true
    NeedReqHeaderLog Boolean 是否需要请求头
    示例值:true
    NeedRspBodyLog Boolean 是否需要回包体
    示例值:true
    NeedRspHeaderLog Boolean 是否需要回包头部信息
    示例值:true
    LogSetId String cls set信息
    示例值:setId
    LogTopicId String cls topicId
    示例值:topicId

    CustomRequestToAdd

    安全网关请求自定义头部

    被如下接口引用:DescribeWxGatewayRoutes。

    名称 类型 必选 描述
    Key String Header名称
    示例值:key
    Value String Header值
    示例值:value
    AppendAction String Header类型
    示例值:APPEND_IF_EXISTS_OR_ADD

    DatabasesInfo

    数据库资源信息

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

    名称 类型 描述
    InstanceId String 数据库唯一标识
    示例值:tnt-xxxxyyyy
    Status String 状态。包含以下取值:
  • INITIALIZING:资源初始化中
  • RUNNING:运行中,可正常使用的状态
  • UNUSABLE:禁用,不可用
  • OVERDUE:资源过期

  • 示例值:RUNNING
    Region String 所属地域。
    当前支持ap-shanghai
    示例值:ap-shanghai
    UpdateTime Timestamp ISO8601 更新时间
    示例值:2022-01-01 12:34:56

    EndUserInfo

    终端用户信息

    被如下接口引用:DescribeEndUsers。

    名称 类型 描述
    UUId String 用户唯一ID
    示例值:1234-abc-12345
    WXOpenId String 微信ID
    示例值:open-wx
    QQOpenId String qq ID
    示例值:open-qq
    Phone String 手机号
    示例值:13099998888
    Email String 邮箱
    示例值:steven@tencent.com
    NickName String 昵称
    示例值:steven
    Gender String 性别
    示例值:男
    AvatarUrl String 头像地址
    示例值:https://www.baidu.com
    UpdateTime String 更新时间
    示例值:2024-02-02
    CreateTime String 创建时间
    示例值:2024-02-02
    IsAnonymous Boolean 是否为匿名用户
    示例值:true
    IsDisabled Boolean 是否禁用账户
    示例值:true
    HasPassword Boolean 是否设置过密码
    示例值:true
    UserName String 用户名
    示例值:steven

    EnvBillingInfoItem

    环境计费信息

    被如下接口引用:DescribeBillingInfo, DescribeExtraPkgBillingInfo。

    名称 类型 描述
    EnvId String 环境ID
    示例值:env-xxxxxx
    PackageId String tcb产品套餐ID,参考DescribePackages接口的返回值。
    示例值:Default
    IsAutoRenew Boolean 自动续费标记
    示例值:true
    Status String 状态。包含以下取值:
  • 空字符串:初始化中
  • NORMAL:正常
  • ISOLATE:隔离

  • 示例值:NORMAL
    PayMode String 支付方式。包含以下取值:
  • PREPAYMENT:预付费
  • POSTPAID:后付费

  • 示例值:PREPAYMENT
    IsolatedTime String 隔离时间,最近一次隔离的时间
    示例值:2022-01-01 12:34:56
    ExpireTime String 过期时间,套餐即将到期的时间
    示例值:2022-01-01 12:34:56
    CreateTime String 创建时间,第一次接入计费方案的时间。
    示例值:2022-01-01 12:34:56
    UpdateTime String 更新时间,计费信息最近一次更新的时间。
    示例值:2022-01-01 12:34:56
    IsAlwaysFree Boolean true表示从未升级过付费版。
    示例值:false
    PaymentChannel String 付费渠道。
  • miniapp:小程序
  • qcloud:腾讯云

  • 示例值:miniapp
    OrderInfo OrderInfo 最新的订单信息
    FreeQuota String 免费配额信息。
    示例值:basic
    EnableOverrun Boolean 是否开启 超过套餐额度部分转按量付费
    示例值:false
    ExtPackageType String 环境套餐类型
    示例值:baas
    EnvCharged String 是否付费期环境,可取值:yes/no。
    示例值:yes
    EnvActivated String 是否已激活,可取值:yes/no。
    示例值:yes

    EnvInfo

    环境信息

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

    名称 类型 描述
    EnvId String 账户下该环境唯一标识
    示例值:tcb-xxx
    Source String 环境来源。包含以下取值:
  • miniapp:微信小程序
  • qcloud :腾讯云

  • 示例值:qcloud
    Alias String 环境别名,要以a-z开头,不能包含 a-zA-z0-9- 以外的字符
    示例值:tcb
    CreateTime Timestamp 创建时间
    示例值:2021-04-26
    UpdateTime Timestamp 最后修改时间
    示例值:2021-04-26
    Status String 环境状态。包含以下取值:
  • NORMAL:正常可用
  • UNAVAILABLE:服务不可用,可能是尚未初始化或者初始化过程中

  • 示例值:NORMAL
    Databases Array of DatabasesInfo 数据库列表
    Storages Array of StorageInfo 存储列表
    Functions Array of FunctionInfo 函数列表
    PackageId String tcb产品套餐ID,参考DescribePackages接口的返回值。
    示例值:basic1
    PackageName String 套餐中文名称,参考DescribePackages接口的返回值。
    示例值:基础版1
    LogServices Array of LogServiceInfo 云日志服务列表
    StaticStorages Array of StaticStorageInfo 静态资源信息
    IsAutoDegrade Boolean 是否到期自动降为免费版
    示例值:false
    EnvChannel String 环境渠道
    示例值:qc_console
    PayMode String 支付方式。包含以下取值:
  • prepayment:预付费
  • postpaid:后付费

  • 示例值:postpaid
    IsDefault Boolean 是否为默认环境
    示例值:false
    Region String 环境所属地域
    示例值:ap-shanghai
    Tags Array of Tag 环境标签列表
    CustomLogServices Array of ClsInfo 自定义日志服务
    EnvType String 环境类型:baas, run, hoting, weda
    示例值:baas
    IsDauPackage Boolean 是否是dau新套餐
    示例值:false
    PackageType String 套餐类型:空\baas\tcbr
    示例值:baas
    ArchitectureType String 架构类型
    示例值:multi_tenant | stand_alone_cluster
    Recycle String 回收标志,默认为空
    示例值:recycle | ""

    ExtensionFile

    扩展文件

    被如下接口引用:DescribeExtensionUploadInfo。

    名称 类型 必选 描述
    FileType String 文件类型。枚举值
  • FUNCTION:函数代码
  • STATIC:静态托管代码
  • SMS:短信文件

  • 示例值:SMS
    FileName String 文件名,长度不超过24
    示例值:abc.csv

    ExtensionFileInfo

    扩展文件信息

    被如下接口引用:DescribeExtensionUploadInfo。

    名称 类型 描述
    CodeUri String 模板里使用的地址
    示例值:extension://abc.zip
    UploadUrl String 上传文件的临时地址,含签名
    示例值:http://qq.com
    CustomKey String 自定义密钥。如果为空,则表示不需要加密。
    参考cos预签名url上传https://cloud.tencent.com/document/product/436/36121
    上传的时候要按照 SSE-C 的方式设置header:https://cloud.tencent.com/document/product/436/7728
    示例值:dfadf
    MaxSize Integer 文件大小限制,单位M,客户端上传前需要主动检查文件大小,超过限制的文件会被删除。
    示例值:100

    FreequotaInfo

    后付费资源免费量信息

    被如下接口引用:DescribePostpayFreeQuotas。

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

  • 示例值:COS
    ResourceMetric String 资源指标名称
    示例值:Flux
    FreeQuota Integer 资源指标免费量
    示例值:100
    MetricUnit String 指标单位
    示例值:GB
    DeductType String 免费量抵扣周期
  • sum-month:以月为单位抵扣
  • sum-day:以天为单位抵扣
  • totalize:总容量抵扣

  • 示例值:sum-month
    FreeQuotaType String 免费量类型
  • basic:通用量抵扣

  • 示例值:basic

    FrequencyLimitConfig

    安全网关版本路由信息限额配置

    被如下接口引用:DescribeWxGatewayRoutes。

    名称 类型 必选 描述
    LimitObject String 限额对象 "ConnectionsLimit" 或 "QPSLimit"
    示例值:ConnectionsLimit
    LimitConfig String 限额配置
    示例值:{value:1000}

    FunctionInfo

    函数的信息

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

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

    GatewayItem

    网关信息

    被如下接口引用:DescribeWxGateways。

    名称 类型 描述
    Uin String 用户uin
    示例值:100007258682
    AppId Integer 用户appid
    示例值:1257473911
    WxAppId String WxAppId
    示例值:wx0b8b25b4678d891f
    EnvId String 环境id
    示例值:env-test-gn9yom
    GatewayId String Gateway唯一id
    示例值:gateway-6gqtlxk
    GatewayName String Gateway名称
    示例值:gateway
    GatewayType String Gateway类型
    示例值:gw-wx-donut
    GatewayDesc String Gateway描述
    示例值:测试环境网关
    PackageVersion String 套餐版本
    示例值:testV2
    PackageId Integer 套餐唯一id
    示例值:2005
    VpcId String vpc唯一id
    示例值:vpc-ebdrku5i
    SubnetIds Array of String 子网id
    示例值:["subnet-2pfef0ad","subnet-3ka73ubd","subnet-ecbe5jef","subnet-8mjaqlit"]
    Status String 网关状态
    示例值:success
    L5Addr String l5地址
    示例值:192002625:745218
    Region String 地域
    示例值:ap-shanghai
    CanRenew Boolean 是否可以续费
    示例值:true
    AutoRenewFlag Integer 自动续费标志
    示例值:2
    IsolateTime String 隔离时间
    示例值:2024-11-23 09:08:05
    ExpireTime String 到期时间
    示例值:2024-11-21 23:59:59
    CreateTime String 创建时间
    示例值:2024-08-09 10:38:33
    UpdateTime String 变更时间
    示例值:2024-11-23 09:08:05
    CanDowngrade Boolean 是否可以降配
    示例值:false
    AllowUncertified Integer 允许未登录访问
    示例值:0
    VersionNumLimit Integer 网关版本限额
    示例值:3
    LongAccessId String Donut接入ID
    示例值:a0c5aba71-wxe17e6efa4c656fcd
    AccessDomain String Donut接入域名
    示例值:a0c599f16-wxe17e6efa4c656fcd.sh.wxcloudrun.com

    GatewayVersionItem

    网关版本详情

    被如下接口引用:DescribeGatewayVersions, ModifyGatewayVersionTraffic。

    名称 类型 必选 描述
    VersionName String 版本名
    示例值:versionName-xxx
    Weight Integer 版本流量权重
    示例值:50
    Status String 创建状态
    示例值:success
    CreatedTime String 创建时间
    示例值:2021-04-15 13:54:49
    UpdatedTime String 更新时间
    示例值:2021-04-15 13:54:49
    BuildId Integer 构建ID
    示例值:buildid-xxx
    Remark String 备注
    示例值:备注信息
    Priority Integer 优先级
    示例值:1
    IsDefault Boolean 是否默认版本
    示例值:true
    CustomConfig WxGatewayCustomConfig 网关版本自定义配置

    HpaPolicy

    扩缩容策略

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

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

    KVPair

    键值对

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

    名称 类型 必选 描述
    Key String
    示例值:my-key
    Value String
    示例值:my-value

    LogObject

    CLS日志单条信息

    被如下接口引用:SearchClsLog。

    名称 类型 描述
    TopicId String 日志属于的 topic ID
    示例值:aafef2ab-19bc-4868-bd10-bd4a6e4146d6
    TopicName String 日志主题的名字
    示例值:topic_env-xxyyzzaa
    Timestamp String 日志时间
    示例值:1736237493
    Content String 日志内容
    示例值:log-content
    FileName String 采集路径
    示例值:/data/log/my-log-file.log
    Source String 日志来源设备
    示例值:my-platform

    LogResObject

    CLS日志结果

    被如下接口引用:SearchClsLog。

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

    LogServiceInfo

    云日志服务相关信息

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

    名称 类型 描述
    LogsetName String log名
    示例值:logset-env-xxyyzzaa
    LogsetId String log-id
    示例值:338230b0-6f63-4c7f-97c7-9a299d0b11f1
    TopicName String topic名
    示例值:topic-env-xxyyzzaadfs
    TopicId String topic-id
    示例值:80706322-b4ef-4617-b087-de81b7a5b6ca
    Region String cls日志所属地域
    示例值:ap-shanghai
    Period Integer topic保存时长 默认7天
    示例值:7

    LoginStatistic

    终端用户登录新增统计

    被如下接口引用:DescribeEndUserLoginStatistic。

    名称 类型 必选 描述
    StatisticalType String 统计类型 新增NEWUSER 和登录 LOGIN
    示例值:NEWUSER
    StatisticalCycle String 统计周期:日DAY,周WEEK,月MONTH
    示例值:WEEK
    Count Integer 统计总量
    示例值:2
    UpdateTime String 更新时间
    示例值:2025-01-01

    ObjectKV

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

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

    名称 类型 必选 描述
    Key String object 的 key
    示例值:key
    Value String object key 对应的 value
    示例值:value

    OneClickTaskStepInfo

    一键部署步骤信息

    被如下接口引用:DescribeCloudBaseRunOneClickTaskExternal。

    名称 类型 描述
    Status String 未启动:"todo"
    运行中:"running"
    失败:"failed"
    成功结束:"finished"
    示例值:"running"
    StartTime String 开始时间
    示例值:2021-11-16 01:00:00
    EndTime String 结束时间
    示例值:2021-11-16 01:00:00
    CostTime Integer 耗时:秒
    示例值:10
    FailReason String 失败原因
    示例值:reason
    Name String 步骤名
    示例值:name

    OrderInfo

    订单信息

    被如下接口引用:DescribeBillingInfo, DescribeExtraPkgBillingInfo。

    名称 类型 描述
    TranId String 订单号
    示例值:202401011000004515
    PackageId String 订单要切换的套餐ID
    示例值:baas_personal
    TranType String 订单类型
  • 1 购买
  • 2 续费
  • 3 变配

  • 示例值:1
    TranStatus String 订单状态。
  • 1未支付
  • 2 支付中
  • 3 发货中
  • 4 发货成功
  • 5 发货失败
  • 6 已退款
  • 7 已取消
  • 100 已删除

  • 示例值:1
    UpdateTime String 订单更新时间
    示例值:2024-01-01 00:00:00
    CreateTime String 订单创建时间
    示例值:2024-01-01 00:00:00
    PayMode String 付费模式.
  • prepayment 预付费
  • postpaid 后付费

  • 示例值:prepayment
    ExtensionId String 订单绑定的扩展ID
    示例值:ext-xyzabdkjks
    ResourceReady String 资源初始化结果(仅当ExtensionId不为空时有效): successful(初始化成功), failed(初始化失败), doing(初始化进行中), init(准备初始化)
    示例值:successful
    Flag String 安装标记。建议使用方统一转大小写之后再判断。
  • QuickStart:快速启动来源
  • Activity:活动来源

  • 示例值:QuickStart
    ReqBody String 下单时的参数
    示例值:ReqBody

    PackageFreeQuotaInfo

    后付费免费额度

    被如下接口引用:DescribePostpayPackageFreeQuotas。

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

  • 示例值:CDN
    ResourceMetric String 资源指标名称
    示例值:Flux
    FreeQuota Integer 资源指标免费量
    示例值:100
    MetricUnit String 指标单位
    示例值:GB
    DeductType String 免费量抵扣周期
  • sum-month:以月为单位抵扣
  • sum-day:以天为单位抵扣
  • totalize:总容量抵扣

  • 示例值:sum-month
    FreeQuotaType String 免费量类型
  • basic:通用量抵扣

  • 示例值:basic

    PlatformStatistic

    终端用户平台统计信息

    被如下接口引用:DescribeEndUserStatistic。

    名称 类型 必选 描述
    Platform String 终端用户从属平台
    示例值:qcloud
    Count Integer 平台终端用户数
    示例值:114514
    UpdateTime String 更新时间
    示例值:2024-01-01 00:00:00

    PostPaidEnvDeductInfo

    后付费计费详情

    被如下接口引用:DescribeEnvPostpaidDeduct。

    名称 类型 描述
    ResourceType String 资源方
    示例值:COS
    MetricName String 指标名
    示例值:ReadRequests
    ResQuota Float 按量计费详情
    示例值:0
    PkgQuota Float 资源包抵扣详情
    示例值:0
    FreeQuota Float 免费额度抵扣详情
    示例值:0
    EnvId String 环境id
    示例值:nanatest-6gh4z1im209cc32c

    PostpayEnvQuota

    按量付费免费配额信息

    被如下接口引用:DescribeEnvFreeQuota。

    名称 类型 描述
    ResourceType String 资源类型
    示例值:CDN
    MetricName String 指标名
    示例值:Flux
    Value Integer 配额值
    示例值:100
    StartTime String 配额生效时间
    为空表示没有时间限制
    示例值:2024-01-01 00:00:00
    EndTime String 配额失效时间
    为空表示没有时间限制
    示例值:2024-01-31 23:59:59

    SmsFreeQuota

    短信免费量

    被如下接口引用:DescribeSmsQuotas。

    名称 类型 描述
    FreeQuota Integer 免费量总条数
    示例值:0
    TotalUsedQuota Integer 共计已使用总条数
    示例值:0
    CycleStart String 免费周期起点,0000-00-00 00:00:00 形式
    示例值:2024-01-01 00:00:00
    CycleEnd String 免费周期终点,0000-00-00 00:00:00 形式
    示例值:2024-01-01 01:00:00
    TodayUsedQuota Integer 今天已使用总条数
    示例值:0

    SpecialCostItem

    1分钱计费详情

    被如下接口引用:DescribeSpecialCostItems。

    名称 类型 描述
    ReportDate String 上报日期
    示例值:2021-07-01
    Uin String 腾讯云uin
    示例值:100008561789
    EnvId String 资源id:环境id
    示例值:lbvliu-5gfy5n4a0776401d
    Status String 上报任务状态
    示例值:new

    StandaloneGatewayInfo

    独立网关信息

    被如下接口引用:DescribeStandaloneGateway。

    名称 类型 描述
    GatewayName String 独立网关名称
    示例值:x-tcb-reserved-gw-envoy-demo
    CPU Float CPU核心数
    示例值:1.0
    Mem Integer 内存大小,单位MB
    示例值:8
    PackageVersion String 套餐包版本名称
    示例值:basic
    GatewayAlias String 网关别名
    示例值:gateway-alias
    VpcId String 私有网络ID
    示例值:vpc-73afxxfa
    SubnetIds Array of String 子网ID列表
    示例值:["subnet-9xnlrqj5"]
    GatewayDesc String 网关描述
    示例值:gateway demo
    GateWayStatus String 网关状态
    示例值:running
    ServiceInfo BackendServiceInfo 服务信息
    PublicClbIp String 公网CLBIP
    示例值:10.0.0.1
    InternalClbIp String 内网CLBIP
    示例值:10.0.0.1

    StandaloneGatewayPackageInfo

    小租户网关套餐配置

    被如下接口引用:DescribeStandaloneGatewayPackage。

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

    StaticStorageInfo

    静态CDN资源信息

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

    名称 类型 描述
    StaticDomain String 静态CDN域名
    示例值:cloudbase.cloudbaseapp.com
    DefaultDirName String 静态CDN默认文件夹,当前为根目录
    示例值:"/"
    Status String 资源状态(process/online/offline/init)
    示例值:online
    Region String cos所属区域
    示例值:ap-shanghai
    Bucket String bucket信息
    示例值:my-bucket-name-appid

    StorageInfo

    StorageInfo 资源信息

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

    名称 类型 描述
    Region String 资源所属地域。
    当前支持ap-shanghai
    示例值:ap-shanghai
    Bucket String 桶名,存储资源的唯一标识
    示例值:my-bucket-name-appid
    CdnDomain String cdn 域名
    示例值:cloudbase.tencentcloud.com
    AppId String 资源所属用户的腾讯云appId
    示例值:1265124512

    Tag

    标签键值对

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

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

    TkeClusterInfo

    tke集群信息

    被如下接口引用:DescribeCbrServerVersion, DescribeCloudBaseRunServerVersion。

    名称 类型 必选 描述
    ClusterId String 集群ID
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:cls-xxxxxxx
    VpcId String 集群的vpcId
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:vpc-xxxxxx
    VersionClbSubnetId String 版本内网CLB所在子网Id
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:subnet-xxxxxxx

    WxGatewayCustomConfig

    安全网关自定义配置

    被如下接口引用:DescribeGatewayVersions, ModifyGatewayVersionTraffic。

    名称 类型 必选 描述
    IsOpenXRealIp Boolean 是否开启x-real-ip
    示例值:false
    BanConfig BanConfig 封禁配置
    示例值:false
    SourceIpType String 获取源ip方式,PPV1(Proxy Protocol V1)、PPV2(Proxy Protocol V2)、TOA(tcp option address)
    示例值:PPV1
    LogConfig CustomLogConfig 日志信息
    IsAcceptHttpOne Boolean 是否开启http1.0
    示例值:false

    WxGatewayRountItem

    安全网关路由

    被如下接口引用:DescribeWxGatewayRoutes。

    名称 类型 描述
    GatewayRouteName String 安全网关路由名称
    示例值:route-name
    GatewayRouteProtocol String 安全网关路由协议
    示例值:http
    GatewayRouteAddr String 安全网关路由地址
    示例值:access.com
    GatewayRouteDesc String 安全网关路由描述
    示例值:路由描述
    GatewayRouteClusterId String 安全网关后端集群id,如果是外网服务,该id与GatewayRountName相同
    示例值:cls-xxx
    GatewayRouteCreateTime String 安全网关创建时间
    示例值:2025-01-09 09:36:44
    FrequencyLimitConfig Array of FrequencyLimitConfig 安全网关路由限制
    GatewayRouteServerType String ip代表绑定后端ip。cbr代表云托管服务
    示例值:cbr
    GatewayRouteServerName String 服务名
    示例值:server-name
    GatewayRewriteHost String ip
    示例值:1.0.0.1
    GatewayVersion String 网关版本
    示例值:gatewayversion
    GatewayRoutePath String 请求路径
    示例值:path
    GatewayRouteMethod String 请求模式
    示例值:GET
    GatewayRoutePort Integer 4层端口
    示例值:80
    GatewayRouteEnvId String 路由环境ID
    示例值:env-xxx
    GatewayRoutePathMatchType String 路径匹配类型,支持prefix(前缀匹配),regex(正则匹配), 默认prefix
    示例值:regex
    CustomHeader CustomHeader 安全网关自定义头部