云开发 CloudBase
视频服务与安全产品捉虫活动邀您参加！> HOT
文档中心>云开发 CloudBase>API 文档>其他接口>查询服务版本的详情

查询服务版本的详情

最近更新时间：2024-03-12 01:49:44

我的收藏

本页目录：

1. 接口描述

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

查询服务版本的详情

默认接口请求频率限制：20次/秒。

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

2. 输入参数

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

参数名称 必选 类型 描述
Action 是 String 公共参数，本接口取值：DescribeCbrServerVersion。
Version 是 String 公共参数，本接口取值：2018-06-08。
Region 否 String 公共参数，本接口不需要传递此参数。
EnvId 是 String 环境ID
示例值：env-98772234
ServerName 是 String 服务名称
示例值：sv
VersionName 是 String 版本名称
示例值：sv-001

3. 输出参数

参数名称 类型 描述
VersionName String 版本名称
示例值：sv-001
Remark String 备注
注意：此字段可能返回 null，表示取不到有效值。
DockerfilePath String Dockefile的路径
注意：此字段可能返回 null，表示取不到有效值。
示例值：Dockefile
BuildDir String DockerBuild的目录
注意：此字段可能返回 null，表示取不到有效值。
示例值：.
Cpu Float Cpu大小
示例值：1
Mem Float Mem大小
示例值：1024
MinNum Integer 副本最小值
示例值：1
MaxNum Integer 副本最大值
示例值：50
EnvParams String 环境变量
注意：此字段可能返回 null，表示取不到有效值。
CreatedTime String 创建时间
UpdatedTime String 更新时间
VersionIP String 版本的IP
注意：此字段可能返回 null，表示取不到有效值。
VersionPort Integer 版本的端口号
注意：此字段可能返回 null，表示取不到有效值。
Status String 版本状态
注意：此字段可能返回 null，表示取不到有效值。
UploadType String 枚举（package/repository/image)
注意：此字段可能返回 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，表示取不到有效值。
HasDockerfile Integer 是否有Dockerfile：0-default has, 1-has, 2-has not
注意：此字段可能返回 null，表示取不到有效值。
示例值：0
BaseImage String 基础镜像
注意：此字段可能返回 null，表示取不到有效值。
示例值：JDK7
EntryPoint String 容器启动入口命令
注意：此字段可能返回 null，表示取不到有效值。
示例值：java -jar app.jar
PolicyDetail Array of HpaPolicy 自动扩缩容策略组
注意：此字段可能返回 null，表示取不到有效值。
TkeClusterInfo TkeClusterInfo Tke集群信息
注意：此字段可能返回 null，表示取不到有效值。
TkeWorkloadType String 版本工作负载类型；deployment/deamonset
注意：此字段可能返回 null，表示取不到有效值。
示例值：deployment
PackageInfo CbrPackageInfo 代码包信息
注意：此字段可能返回 null，表示取不到有效值。
RepoInfo CbrRepoInfo 仓库信息
注意：此字段可能返回 null，表示取不到有效值。
RequestId String 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 示例

查询服务版本的详情

输入示例

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

{
    "EnvId": "abc",
    "ServerName": "abc",
    "VersionName": "abc"
}

输出示例

{
    "Response": {
        "VersionName": "abc",
        "Remark": "abc",
        "DockerfilePath": "abc",
        "BuildDir": "abc",
        "Cpu": 0,
        "Mem": 0,
        "MinNum": 0,
        "MaxNum": 0,
        "EnvParams": "abc",
        "CreatedTime": "abc",
        "UpdatedTime": "abc",
        "VersionIP": "abc",
        "VersionPort": 0,
        "Status": "abc",
        "UploadType": "abc",
        "ServerName": "abc",
        "IsPublic": true,
        "VpcId": "abc",
        "SubnetIds": [
            "abc"
        ],
        "CustomLogs": "abc",
        "ContainerPort": 0,
        "InitialDelaySeconds": 0,
        "ImageUrl": "abc",
        "HasDockerfile": 0,
        "BaseImage": "abc",
        "EntryPoint": "abc",
        "PolicyDetail": [
            {
                "PolicyType": "abc",
                "PolicyThreshold": 0
            }
        ],
        "TkeClusterInfo": {
            "ClusterId": "abc",
            "VpcId": "abc",
            "VersionClbSubnetId": "abc"
        },
        "TkeWorkloadType": "abc",
        "PackageInfo": {
            "PackageName": "abc",
            "PackageVersion": "abc"
        },
        "RepoInfo": {
            "Repo": "abc",
            "RepoType": "abc",
            "RepoLanguage": "abc",
            "Branch": "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。

命令行工具

6. 错误码

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

错误码 描述
InternalError 内部错误。
InvalidParameter 参数错误。
InvalidParameter.ServiceNotExist 服务不存在。
LimitExceeded.ErrNamespaceMaxLimit 命名空间超过配额。
LimitExceeded.ErrRepoMaxLimit 镜像容器超过配额。
ResourceNotFound 资源不存在。
中国站
文档反馈
文档活动
message-icon联系我们
目录