1. 接口描述
接口请求域名: tem.tencentcloudapi.com 。
服务部署
默认接口请求频率限制:20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
参数名称 | 必选 | 类型 | 描述 |
---|---|---|---|
Action | 是 | String | 公共参数,本接口取值:DeployServiceV2。 |
Version | 是 | String | 公共参数,本接口取值:2020-12-21。 |
Region | 是 | String | 公共参数,详见产品支持的 地域列表。 |
ServiceId | 是 | String | 服务ID |
ContainerPort | 是 | Integer | 容器端口 |
InitPodNum | 是 | Integer | 初始化 pod 数 |
CpuSpec | 是 | Float | cpu规格 |
MemorySpec | 是 | Float | 内存规格 |
NamespaceId | 是 | String | 环境ID |
ImgRepo | 否 | String | 镜像仓库 |
VersionDesc | 否 | String | 版本描述信息 |
JvmOpts | 否 | String | 启动参数 |
EsInfo | 否 | EsInfo | 弹性伸缩配置,不传默认不启用弹性伸缩配置 |
EnvConf.N | 否 | Array of Pair | 环境变量配置 |
LogConfs.N | 否 | Array of String | 日志配置 |
StorageConfs.N | 否 | Array of StorageConf | 数据卷配置 |
StorageMountConfs.N | 否 | Array of StorageMountConf | 数据卷挂载配置 |
DeployMode | 否 | String | 部署类型。 - JAR:通过 jar 包部署 - WAR:通过 war 包部署 - IMAGE:通过镜像部署 |
DeployVersion | 否 | String | 部署类型为 IMAGE 时,该参数表示镜像 tag。 部署类型为 JAR/WAR 时,该参数表示包版本号。 |
PkgName | 否 | String | 包名。使用 JAR 包或者 WAR 包部署的时候必填。 |
JdkVersion | 否 | String | JDK 版本。 - KONA:使用 kona jdk。 - OPEN:使用 open jdk。 |
SecurityGroupIds.N | 否 | Array of String | 安全组ID s |
LogOutputConf | 否 | LogOutputConf | 日志输出配置 |
SourceChannel | 否 | Integer | 来源渠道 |
Description | 否 | String | 版本描述 |
ImageCommand | 否 | String | 镜像命令 |
ImageArgs.N | 否 | Array of String | 镜像命令参数 |
PortMappings.N | 否 | Array of PortMapping | 服务端口映射 |
UseRegistryDefaultConfig | 否 | Boolean | 是否添加默认注册中心配置 |
SettingConfs.N | 否 | Array of MountedSettingConf | 挂载配置信息 |
EksService | 否 | EksService | eks 访问设置 |
VersionId | 否 | String | 要回滚到的历史版本id |
PostStart | 否 | String | 启动后执行的脚本 |
PreStop | 否 | String | 停止前执行的脚本 |
DeployStrategyConf | 否 | DeployStrategyConf | 分批发布策略配置 |
Liveness | 否 | HealthCheckConfig | 存活探针配置 |
Readiness | 否 | HealthCheckConfig | 就绪探针配置 |
3. 输出参数
参数名称 | 类型 | 描述 |
---|---|---|
Result | String | 版本ID(前端可忽略) |
RequestId | String | 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 服务版本部署
服务版本部署
输入示例
POST / HTTP/1.1
Host: tem.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DeployServiceV2
<公共请求参数>
{
"JvmOpts": "xx",
"StorageConfs": [
{
"StorageVolName": "xx",
"StorageVolPath": "xx"
}
],
"ImgRepo": "xx",
"EnvConf": [
{
"Value": "xx",
"Key": "xx"
}
],
"Description": "xx",
"JdkVersion": "xx",
"ContainerPort": 1,
"LogOutputConf": {
"ClsLogTopicId": "xx",
"ClsLogsetName": "xx",
"OutputType": "xx"
},
"CpuSpec": 0.0,
"DeployMode": "xx",
"SecurityGroupIds": [
"xx"
],
"SourceChannel": 0,
"DeployVersion": "xx",
"InitPodNum": 1,
"VersionDesc": "xx",
"MemorySpec": 0.0,
"LogConfs": [
"xx"
],
"PkgName": "xx",
"StorageMountConfs": [
{
"VolumeName": "xx",
"MountPath": "xx"
}
],
"SettingConfs": [
{
"ConfigDataName": "xx",
"MountedPath": "xx"
}
],
"EsInfo": {
"MinAliveInstances": 0,
"EsStrategy": 0,
"VersionId": "xx",
"Threshold": 1,
"MaxAliveInstances": 2
},
"ServiceId": "xx",
"NamespaceId": "xx"
}
输出示例
{
"Response": {
"RequestId": "81f74023-563c-437d-abf7-8139449ef178",
"Result": "version-xxx"
}
}
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
- Tencent Cloud SDK 3.0 for Java
- Tencent Cloud SDK 3.0 for PHP
- Tencent Cloud SDK 3.0 for Go
- Tencent Cloud SDK 3.0 for NodeJS
- Tencent Cloud SDK 3.0 for .NET
- Tencent Cloud SDK 3.0 for C++
- Tencent Cloud SDK 3.0 for Ruby
命令行工具
6. 错误码
该接口暂无业务逻辑相关的错误码,其他错误码详见 公共错误码。