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 示例值：lotestapi100004 |
| ServerName | 是 | String | 服务名称 示例值：dockerservicename |
| Offset | 是 | Integer | 分页偏移 示例值：0 |
| Limit | 是 | Integer | 分页数量 示例值：20 |
| VersionName | 否 | String | 版本名字（精确匹配） |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| TotalCount | Integer | 个数 注意：此字段可能返回 null，表示取不到有效值。 示例值：0 |
| VersionItems | Array of CloudBaseRunServerVersionItem | 版本列表 注意：此字段可能返回 null，表示取不到有效值。 |
| ServerName | String | 服务名称 注意：此字段可能返回 null，表示取不到有效值。 |
| IsPublic | Boolean | 是否对于外网开放 注意：此字段可能返回 null，表示取不到有效值。 示例值：1 |
| ImageRepo | String | 镜像仓库 注意：此字段可能返回 null，表示取不到有效值。 |
| TrafficType | String | 流量配置的类型（FLOW,URL_PARAMS) 注意：此字段可能返回 null，表示取不到有效值。 |
| SourceType | String | 服务创建类型，默认为空，一键部署为oneclick 注意：此字段可能返回 null，表示取不到有效值。 示例值："oneclick" |
| Tag | String | 服务标签, function: 托管函数 注意：此字段可能返回 null，表示取不到有效值。 示例值：function |
| RequestId | String | 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 查看某个服务的装填
输入示例
https://tcb.tencentcloudapi.com/?Action=DescribeCloudBaseRunServer
&EnvId=lotestapi100004
&ServerName=dockerservicename
&Offset=0
&Limit=20
&<公共请求参数>输出示例
{
"Response": {
"ImageRepo": "tcb-100019615070-mjph/ca-znrdxowd_test-domain2",
"IsPublic": false,
"RequestId": "52855bd0-25cc-4294-913c-0b8ee0c65e76",
"ServerName": "test-domain2",
"SourceType": "custom",
"TotalCount": 5,
"TrafficType": "",
"VersionItems": [
{
"VersionName": "test-domain2-009",
"FlowRatio": 100,
"Status": "normal",
"CreatedTime": "2023-11-13 17:10:30",
"UpdatedTime": "2023-11-13 17:41:00",
"BuildId": 37196953,
"UploadType": "package",
"Remark": "",
"UrlParam": null,
"Priority": 0,
"IsDefaultPriority": false,
"FlowParams": null,
"MinReplicas": 0,
"MaxReplicas": 5,
"RunId": "multi_tenant_1r2Sxhqf7GP3Mx",
"Percent": 0,
"CurrentReplicas": 0,
"Architecture": ""
}
]
}
}示例2 查询单个云托管服务实例
查询单个云托管服务实例
输入示例
POST / HTTP/1.1
Host: tcb.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeCloudBaseRunServer
<公共请求参数>
{
"EnvId": "pre-tenant-4g9db6fj62889354",
"ServerName": "envparam",
"Offset": 0,
"Limit": 100
}输出示例
{
"Response": {
"ImageRepo": "tcb-100019615070-mjph/ca-znrdxowd_envparam",
"IsPublic": false,
"RequestId": "0a14bef2-57d8-4d74-9d54-c0850e5395b3",
"ServerName": "envparam",
"SourceType": "custom",
"Tag": "",
"TotalCount": 1,
"TrafficType": "",
"VersionItems": [
{
"Architecture": "",
"BuildId": 41355587,
"CreatedTime": "2024-04-03 13:12:39",
"CurrentReplicas": 0,
"FlowParams": null,
"FlowRatio": 100,
"IsDefaultPriority": false,
"MaxReplicas": 5,
"MinReplicas": 0,
"Percent": 0,
"Priority": 0,
"Remark": "",
"RunId": "multi_tenant_1rrsvOvTuxr1La",
"Status": "normal",
"UpdatedTime": "2024-04-03 13:43:14",
"UploadType": "repository",
"UrlParam": null,
"VersionName": "envparam-001"
}
]
}
}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 | 参数错误。 |
| ResourceInUse | 资源被占用。 |
| ResourceNotFound | 资源不存在。 |
