开发指南

API 文档

有奖征文|投稿上云技术实践,赢取价值5000元大奖> HOT

1. 接口描述

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

查询单个服务的详情,版本以及详情

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

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

2. 输入参数

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

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:DescribeCloudBaseRunServer。
Version String 公共参数,本接口取值:2018-06-08。
Region String 公共参数,本接口不需要传递此参数。
EnvId String 环境ID
ServerName String 服务名称
Offset Integer 分页偏移
Limit Integer 分页数量
VersionName String 版本名字(精确匹配)

3. 输出参数

参数名称 类型 描述
TotalCount Integer 个数
注意:此字段可能返回 null,表示取不到有效值。
VersionItems Array of CloudBaseRunServerVersionItem 版本列表
注意:此字段可能返回 null,表示取不到有效值。
ServerName String 服务名称
注意:此字段可能返回 null,表示取不到有效值。
IsPublic Boolean 是否对于外网开放
注意:此字段可能返回 null,表示取不到有效值。
ImageRepo String 镜像仓库
注意:此字段可能返回 null,表示取不到有效值。
TrafficType String 流量配置的类型(FLOW,URL_PARAMS)
注意:此字段可能返回 null,表示取不到有效值。
SourceType String 服务创建类型,默认为空,一键部署为oneclick
注意:此字段可能返回 null,表示取不到有效值。
RequestId String 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 查看某个服务的装填

输入示例

https://tcb.tencentcloudapi.com/?Action=DescribeCloudBaseRunServer
&EnvId=lotestapi100004
&ServerName=dockerservicename
&Offset=0
&Limit=20
&<公共请求参数>

输出示例

{
    "Response": {
        "ServerName": "xx",
        "IsPublic": true,
        "ImageRepo": "xx",
        "TrafficType": "xx",
        "SourceType": "xx",
        "TotalCount": 0,
        "RequestId": "xx",
        "VersionItems": [
            {
                "Status": "xx",
                "UpdatedTime": "xx",
                "Remark": "xx",
                "VersionName": "xx",
                "BuildId": 0,
                "UploadType": "xx",
                "Priority": 0,
                "UrlParam": {
                    "Value": "xx",
                    "Key": "xx"
                },
                "FlowRatio": 0,
                "MinReplicas": 0,
                "IsDefaultPriority": true,
                "FlowParams": [
                    {
                        "Priority": 0,
                        "Value": "xx",
                        "Key": "xx"
                    }
                ],
                "CreatedTime": "xx",
                "MaxReplicas": 0
            }
        ]
    }
}

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 参数错误。
ResourceInUse 资源被占用。
ResourceNotFound 资源不存在。
目录