开发指南

API 文档

查询服务版本的详情

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

我的收藏

1. 接口描述

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

查询服务版本的详情,CPU和MEM 请使用CPUSize和MemSize

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

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

2. 输入参数

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

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:DescribeCloudBaseRunServerVersion。
Version String 公共参数,本接口取值:2018-06-08。
Region String 公共参数,本接口不需要传递此参数。
EnvId String 环境ID
ServerName String 服务名称
VersionName String 版本名称

3. 输出参数

参数名称 类型 描述
VersionName String 版本名称
Remark String 备注
注意:此字段可能返回 null,表示取不到有效值。
DockerfilePath String Dockefile的路径
注意:此字段可能返回 null,表示取不到有效值。
BuildDir String DockerBuild的目录
注意:此字段可能返回 null,表示取不到有效值。
Cpu Integer 请使用CPUSize
Mem Integer 请使用MemSize
MinNum Integer 副本最小值
MaxNum Integer 副本最大值
PolicyType String 策略类型
PolicyThreshold Float 策略阈值
EnvParams String 环境变量
注意:此字段可能返回 null,表示取不到有效值。
CreatedTime String 创建时间
UpdatedTime String 更新时间
VersionIP String 版本的IP
注意:此字段可能返回 null,表示取不到有效值。
VersionPort Integer 版本的端口号
注意:此字段可能返回 null,表示取不到有效值。
Status String 版本状态
注意:此字段可能返回 null,表示取不到有效值。
PackageName String 代码包的名字
注意:此字段可能返回 null,表示取不到有效值。
PackageVersion String 代码版本的名字
注意:此字段可能返回 null,表示取不到有效值。
UploadType String 枚举(package/repository/image)
注意:此字段可能返回 null,表示取不到有效值。
RepoType String Repo的类型(gitlab/github/coding)
注意:此字段可能返回 null,表示取不到有效值。
Repo String 地址
注意:此字段可能返回 null,表示取不到有效值。
Branch String 分支
注意:此字段可能返回 null,表示取不到有效值。
ServerName String 服务名字
注意:此字段可能返回 null,表示取不到有效值。
IsPublic Boolean 是否对于外网开放
注意:此字段可能返回 null,表示取不到有效值。
VpcId String vpc id
注意:此字段可能返回 null,表示取不到有效值。
SubnetIds Array of String 子网实例id
注意:此字段可能返回 null,表示取不到有效值。
CustomLogs String 日志采集路径
注意:此字段可能返回 null,表示取不到有效值。
ContainerPort Integer 监听端口
注意:此字段可能返回 null,表示取不到有效值。
InitialDelaySeconds Integer 延迟多长时间开始健康检查(单位s)
注意:此字段可能返回 null,表示取不到有效值。
ImageUrl String 镜像地址
注意:此字段可能返回 null,表示取不到有效值。
CpuSize Float CPU 大小
注意:此字段可能返回 null,表示取不到有效值。
MemSize Float MEM 大小
注意:此字段可能返回 null,表示取不到有效值。
HasDockerfile Integer 是否有Dockerfile:0-default has, 1-has, 2-has not
注意:此字段可能返回 null,表示取不到有效值。
BaseImage String 基础镜像
注意:此字段可能返回 null,表示取不到有效值。
EntryPoint String 容器启动入口命令
注意:此字段可能返回 null,表示取不到有效值。
RepoLanguage String 仓库语言
注意:此字段可能返回 null,表示取不到有效值。
PolicyDetail Array of HpaPolicy 自动扩缩容策略组
注意:此字段可能返回 null,表示取不到有效值。
RequestId String 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 示例

输入示例

https://tcb.tencentcloudapi.com/?Action=DescribeCloudBaseRunServerVersion
&EnvId=lotestapi100004
&ServerName=dockerservicename
&VersionName=adb
&<公共请求参数>

输出示例

{
  "Response": {
    "Branch": "",
    "BuildDir": "",
    "ContainerPort": 80,
    "Cpu": 1,
    "CpuSize": 1,
    "CreatedTime": "2020-11-04 16:44:54",
    "CustomLogs": "/var/logs/data.log",
    "DockerfilePath": "",
    "EnvParams": "{}",
    "ImageUrl": "ccr.ccs.tencentyun.com/cloudbase-apolo-env-test-146d5/hello-world:v2",
    "InitialDelaySeconds": 2,
    "IsPublic": true,
    "MaxNum": 50,
    "Mem": 1,
    "MemSize": 1,
    "MinNum": 0,
    "PackageName": "",
    "PackageVersion": "",
    "PolicyThreshold": 60,
    "PolicyType": "cpu",
    "Remark": "",
    "Repo": "",
    "RepoType": "",
    "RequestId": "5620b49e-a25a-4007-84ef-03c9035c584d",
    "ServerName": "test",
    "Status": "normal",
    "SubnetIds": [
      "subnet-6yny6j0d"
    ],
    "UpdatedTime": "2020-11-04 19:55:22",
    "UploadType": "image",
    "VersionIP": "10.0.192.3",
    "VersionName": "test-010",
    "VersionPort": 80,
    "VpcId": "vpc-rtyzm94a",
    "BaseImage": "JDK7",
    "RepoLanguage": "Java",
    "HasDockerfile": 0,
    "EntryPoint": "java -jar app.jar",
    "PolicyDetail": "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 镜像容器超过配额。
目录