开发指南

API 文档

创建服务版本

最近更新时间:2021-09-14 08:08:44

我的收藏

1. 接口描述

接口请求域名: tcb.tencentcloudapi.com 。

创建服务版本

默认接口请求频率限制:1000次/秒。

推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。

2. 输入参数

以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:CreateCloudBaseRunServerVersion。
Version String 公共参数,本接口取值:2018-06-08。
Region String 公共参数,本接口不需要传递此参数。
EnvId String 环境ID
UploadType String 枚举(package/repository/image/jar/war)
FlowRatio Integer 流量占比
Cpu Float Cpu的大小,单位:核
Mem Float Mem的大小,单位:G
MinNum Integer 最小副本数,最小值:0
MaxNum Integer 副本最大数,最大值:50
PolicyType String 策略类型(枚举值:比如cpu)
PolicyThreshold Integer 策略阈值
ContainerPort Integer 服务端口
ServerName String 服务名称
RepositoryType String repository的类型(coding/gitlab/github/coding)
DockerfilePath String Dockerfile地址
BuildDir String 构建目录
EnvParams String 环境变量
Repository String repository地址
Branch String 分支
VersionRemark String 版本备注
PackageName String 代码包名字
PackageVersion String 代码包的版本
ImageInfo CloudBaseRunImageInfo Image的详情
CodeDetail CloudBaseCodeRepoDetail Github等拉取代码的详情
ImageSecretInfo CloudBaseRunImageSecretInfo 私有镜像秘钥信息
ImagePullSecret String 私有镜像 认证名称
CustomLogs String 用户自定义采集日志路径
InitialDelaySeconds Integer 延迟多长时间开始健康检查(单位s)
MountVolumeInfo.N Array of CloudBaseRunVolumeMount cfs挂载信息
AccessType Integer 4 代表只能微信链路访问
EsInfo CloudBaseEsInfo es信息
EnableUnion Boolean 是否使用统一域名
OperatorRemark String 操作备注
ServerPath String 服务路径
ImageReuseKey String 镜像复用的key
SidecarSpecs.N Array of CloudBaseRunSideSpec 容器的描述文件
Security CloudBaseSecurityContext 安全特性
ServiceVolumes.N Array of CloudRunServiceVolume 服务磁盘挂载
IsCreateJnsGw Integer 是否创建JnsGw 0未传默认创建 1创建 2不创建
ServiceVolumeMounts.N Array of CloudBaseRunServiceVolumeMount 数据卷挂载参数
HasDockerfile Integer 是否有Dockerfile:0-default has, 1-has, 2-has not
BaseImage String 基础镜像
EntryPoint String 容器启动入口命令
RepoLanguage String 仓库语言
UploadFilename String 用户实际上传文件名(仅UploadType为jar/war时必填)
PolicyDetail.N Array of HpaPolicy 自动扩缩容策略组

3. 输出参数

参数名称 类型 描述
Result String 状态(creating/succ)
注意:此字段可能返回 null,表示取不到有效值。
VersionName String 版本名称(只有Result为succ的时候,才会返回VersionName)
注意:此字段可能返回 null,表示取不到有效值。
RunId String 操作记录id
注意:此字段可能返回 null,表示取不到有效值。
RequestId String 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 示例

输入示例

POST / HTTP/1.1
Host: tcb.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CreateCloudBaseRunServerVersion
<公共请求参数>

{
    "MaxNum": 0,
    "Branch": "xx",
    "PackageName": "xx",
    "MountVolumeInfo": [
        {
            "ReadOnly": true,
            "MountPath": "xx",
            "Name": "xx",
            "NfsVolumes": [
                {
                    "Path": "xx",
                    "ReadOnly": true,
                    "Server": "xx"
                }
            ]
        }
    ],
    "ImageInfo": {
        "ImageUrl": "xx",
        "RepositoryName": "xx",
        "IsPublic": true,
        "ServerAddr": "xx",
        "TagName": "xx"
    },
    "EnvParams": "xx",
    "BuildDir": "xx",
    "Repository": "xx",
    "Mem": 0.0,
    "UploadType": "xx",
    "RepositoryType": "xx",
    "InitialDelaySeconds": 0,
    "AccessType": 0,
    "CustomLogs": "xx",
    "FlowRatio": 0,
    "MinNum": 0,
    "VersionRemark": "xx",
    "ContainerPort": 0,
    "DockerfilePath": "xx",
    "EnvId": "xx",
    "ImageSecretInfo": {
        "UserName": "xx",
        "RegistryServer": "xx",
        "Password": "xx",
        "Email": "xx"
    },
    "ServerName": "xx",
    "EnableUnion": true,
    "PackageVersion": "xx",
    "Cpu": 0.0,
    "ImagePullSecret": "xx",
    "CodeDetail": {
        "Url": "xx",
        "Name": {
            "FullName": "xx",
            "Name": "xx"
        }
    },
    "PolicyThreshold": 0,
    "EsInfo": {
        "Index": "xx",
        "Account": "xx",
        "Ip": "xx",
        "Id": 0,
        "SecretName": "xx",
        "Password": "xx",
        "Port": 0
    },
    "PolicyType": "xx"
}

输出示例

{
  "Response": {
    "Result": "xx",
    "VersionName": "xx",
    "RunId": "a123",
    "RequestId": "xx"
  }
}

5. 开发者资源

腾讯云 API 平台

腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台,方便您从同一入口查询及使用腾讯云提供的所有 API 服务。

API Inspector

用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况,并自动生成各语言版本的 API 代码,也可前往 API Explorer 进行在线调试。

SDK

云 API 3.0 提供了配套的开发工具集(SDK),支持多种编程语言,能更方便的调用 API。

命令行工具

6. 错误码

以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码

错误码 描述
InternalError 内部错误。
InvalidParameter 参数错误。
InvalidParameter.ServiceNotExist 服务不存在。
LimitExceeded.ErrNamespaceMaxLimit 命名空间超过配额。
LimitExceeded.ErrRepoMaxLimit 镜像容器超过配额。
目录