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 示例值:dsdx-demo-4gkfdf588ce6e585 |
UploadType | 是 | String | 枚举(package/repository/image/jar/war) 示例值:image |
FlowRatio | 是 | Integer | 流量占比 示例值:0 |
Cpu | 是 | Float | Cpu的大小,单位:核 示例值:1 |
Mem | 是 | Float | Mem的大小,单位:G 示例值:1 |
MinNum | 是 | Integer | 最小副本数,最小值:0 示例值:0 |
MaxNum | 是 | Integer | 副本最大数,最大值:50 示例值:3 |
PolicyType | 是 | String | 策略类型(枚举值:比如cpu) 示例值:cpu |
PolicyThreshold | 是 | Integer | 策略阈值 示例值:60 |
ContainerPort | 是 | Integer | 服务端口 示例值:80 |
ServerName | 是 | String | 服务名称 示例值:demo |
RepositoryType | 否 | String | repository的类型(coding/gitlab/github/coding) 示例值:coding |
DockerfilePath | 否 | String | Dockerfile地址 示例值:./ |
BuildDir | 否 | String | 构建目录 示例值:./ |
EnvParams | 否 | String | 环境变量 示例值:{‘cpu’:'1'} |
Repository | 否 | String | repository地址 示例值:test |
Branch | 否 | String | 分支 示例值:master |
VersionRemark | 否 | String | 版本备注 示例值:test |
PackageName | 否 | String | 代码包名字 示例值:std-we |
PackageVersion | 否 | String | 代码包的版本 示例值:dsd-we |
ImageInfo | 否 | CloudBaseRunImageInfo | Image的详情 |
CodeDetail | 否 | CloudBaseCodeRepoDetail | Github等拉取代码的详情 |
ImageSecretInfo | 否 | CloudBaseRunImageSecretInfo | 私有镜像秘钥信息 |
ImagePullSecret | 否 | String | 私有镜像 认证名称 示例值:dsd-ds |
CustomLogs | 否 | String | 用户自定义采集日志路径 示例值:stdout |
InitialDelaySeconds | 否 | Integer | 延迟多长时间开始健康检查(单位s) 示例值:2 |
MountVolumeInfo.N | 否 | Array of CloudBaseRunVolumeMount | cfs挂载信息 |
AccessType | 否 | Integer | 4 代表只能微信链路访问 示例值:2 |
EsInfo | 否 | CloudBaseEsInfo | es信息 |
EnableUnion | 否 | Boolean | 是否使用统一域名 示例值:false |
OperatorRemark | 否 | String | 操作备注 示例值:test |
ServerPath | 否 | String | 服务路径 示例值:test-demo |
ImageReuseKey | 否 | String | 镜像复用的key 示例值:sdsd |
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 示例值:0 |
BaseImage | 否 | String | 基础镜像 示例值:JDK7 |
EntryPoint | 否 | String | 容器启动入口命令 示例值:java -jar app.jar |
RepoLanguage | 否 | String | 仓库语言 示例值:Java |
UploadFilename | 否 | String | 用户实际上传文件名(仅UploadType为jar/war时必填) 示例值:demo-1.jar |
PolicyDetail.N | 否 | Array of HpaPolicy | 自动扩缩容策略组 |
3. 输出参数
参数名称 | 类型 | 描述 |
---|---|---|
Result | String | 状态(creating/succ) 注意:此字段可能返回 null,表示取不到有效值。 示例值:succ |
VersionName | String | 版本名称(只有Result为succ的时候,才会返回VersionName) 注意:此字段可能返回 null,表示取不到有效值。 示例值:test |
RunId | String | 操作记录id 注意:此字段可能返回 null,表示取不到有效值。 示例值:test12345 |
RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 示例
创建版本
输入示例
POST / HTTP/1.1
Host: tcb.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CreateCloudBaseRunServerVersion
<公共请求参数>
{
"EnvId": "abc",
"UploadType": "abc",
"RepositoryType": "abc",
"FlowRatio": 0,
"DockerfilePath": "abc",
"BuildDir": "abc",
"Cpu": 0,
"Mem": 0,
"MinNum": 0,
"MaxNum": 0,
"PolicyType": "abc",
"PolicyThreshold": 0,
"EnvParams": "abc",
"ContainerPort": 0,
"ServerName": "abc",
"Repository": "abc",
"Branch": "abc",
"VersionRemark": "abc",
"PackageName": "abc",
"PackageVersion": "abc",
"ImageInfo": {
"RepositoryName": "abc",
"IsPublic": true,
"TagName": "abc",
"ServerAddr": "abc",
"ImageUrl": "abc"
},
"CodeDetail": {
"Name": {
"Name": "abc",
"FullName": "abc"
},
"Url": "abc"
},
"ImageSecretInfo": {
"RegistryServer": "abc",
"UserName": "abc",
"Password": "abc",
"Email": "abc"
},
"ImagePullSecret": "abc",
"CustomLogs": "abc",
"InitialDelaySeconds": 0,
"MountVolumeInfo": [
{
"Name": "abc",
"MountPath": "abc",
"ReadOnly": true,
"NfsVolumes": [
{
"Server": "abc",
"Path": "abc",
"ReadOnly": true,
"SecretName": "abc",
"EnableEmptyDirVolume": true
}
]
}
],
"AccessType": 0,
"EsInfo": {
"Id": 0,
"SecretName": "abc",
"Ip": "abc",
"Port": 0,
"Index": "abc",
"Account": "abc",
"Password": "abc"
},
"EnableUnion": true,
"OperatorRemark": "abc",
"ServerPath": "abc",
"ImageReuseKey": "abc",
"SidecarSpecs": [
{
"ContainerImage": "abc",
"ContainerPort": 0,
"ContainerName": "abc",
"EnvVar": "abc",
"InitialDelaySeconds": 0,
"Cpu": 0,
"Mem": 0,
"Security": {
"Capabilities": {
"Add": [
"abc"
],
"Drop": [
"abc"
]
}
},
"VolumeMountInfos": [
{
"Name": "abc",
"MountPath": "abc",
"ReadOnly": true,
"NfsVolumes": [
{
"Server": "abc",
"Path": "abc",
"ReadOnly": true,
"SecretName": "abc",
"EnableEmptyDirVolume": true
}
]
}
]
}
],
"Security": {
"Capabilities": {
"Add": [
"abc"
],
"Drop": [
"abc"
]
}
},
"ServiceVolumes": [
{
"Name": "abc",
"NFS": {
"Server": "abc",
"Path": "abc",
"ReadOnly": true,
"SecretName": "abc",
"EnableEmptyDirVolume": true
},
"SecretName": "abc",
"EnableEmptyDirVolume": true,
"EmptyDir": {
"EnableEmptyDirVolume": true,
"Medium": "abc",
"SizeLimit": "abc"
},
"HostPath": {}
}
],
"IsCreateJnsGw": 0,
"ServiceVolumeMounts": [
{
"Name": "abc",
"MountPath": "abc",
"ReadOnly": true,
"SubPath": "abc",
"MountPropagation": "abc"
}
],
"HasDockerfile": 0,
"BaseImage": "abc",
"EntryPoint": "abc",
"RepoLanguage": "abc",
"UploadFilename": "abc",
"PolicyDetail": [
{
"PolicyType": "abc",
"PolicyThreshold": 0
}
]
}
输出示例
{
"Response": {
"Result": "abc",
"VersionName": "abc",
"RunId": "abc",
"RequestId": "abc"
}
}
5. 开发者资源
腾讯云 API 平台
腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台,方便您从同一入口查询及使用腾讯云提供的所有 API 服务。
API Inspector
用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况,并自动生成各语言版本的 API 代码,也可前往 API Explorer 进行在线调试。
SDK
云 API 3.0 提供了配套的开发工具集(SDK),支持多种编程语言,能更方便的调用 API。
- Tencent Cloud SDK 3.0 for Python: GitHub Gitee
- Tencent Cloud SDK 3.0 for Java: GitHub Gitee
- Tencent Cloud SDK 3.0 for PHP: GitHub Gitee
- Tencent Cloud SDK 3.0 for Go: GitHub Gitee
- Tencent Cloud SDK 3.0 for Node.js: GitHub Gitee
- Tencent Cloud SDK 3.0 for .NET: GitHub Gitee
- Tencent Cloud SDK 3.0 for C++: GitHub Gitee
- Tencent Cloud SDK 3.0 for Ruby: GitHub Gitee
命令行工具
6. 错误码
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码。
错误码 | 描述 |
---|---|
InternalError | 内部错误。 |
InvalidParameter | 参数错误。 |
InvalidParameter.ServiceNotExist | 服务不存在。 |
LimitExceeded.ErrNamespaceMaxLimit | 命名空间超过配额。 |
LimitExceeded.ErrRepoMaxLimit | 镜像容器超过配额。 |
ResourceInUse | 资源被占用。 |
ResourceNotFound | 资源不存在。 |