1. 接口描述
接口请求域名: tcb.tencentcloudapi.com 。
云项目部署列表
默认接口请求频率限制:20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
参数名称 | 必选 | 类型 | 描述 |
---|---|---|---|
Action | 是 | String | 公共参数,本接口取值:DescribeCloudBaseProjectVersionList。 |
Version | 是 | String | 公共参数,本接口取值:2018-06-08。 |
Region | 否 | String | 公共参数,本接口不需要传递此参数。 |
EnvId | 是 | String | 环境id |
ProjectName | 是 | String | 项目名称 |
PageSize | 否 | Integer | 页大小 |
PageNum | 否 | Integer | 第几页,从0开始 |
StartTime | 否 | String | 起始时间 2021-03-27 12:00:00 |
EndTime | 否 | String | 终止时间 2021-03-27 12:00:00 |
3. 输出参数
参数名称 | 类型 | 描述 |
---|---|---|
ProjectVersions | Array of CloudBaseProjectVersion | 版本列表 注意:此字段可能返回 null,表示取不到有效值。 |
TotalCount | Integer | 总个数 注意:此字段可能返回 null,表示取不到有效值。 |
RequestId | String | 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 查询云项目部署版本列表
输入示例
POST / HTTP/1.1
Host: tcb.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeCloudBaseProjectVersionList
<公共请求参数>
{
"EnvId": "xx",
"PageNum": 1,
"PageSize": 1,
"ProjectName": "xx",
"StartTime": "xx",
"EndTime": "xx"
}
输出示例
{
"Response": {
"TotalCount": 1,
"ProjectVersions": [
{
"Status": "xx",
"UpdateTime": 0,
"EnvId": "xx",
"Name": "xx",
"Sam": "xx",
"Tags": [
"xx"
],
"RcJson": "xx",
"CDId": "xx",
"NetworkConfig": "xx",
"Parameters": [
{
"Value": "xx",
"Key": "xx"
}
],
"Source": {
"CodingPackageVersion": "xx",
"WorkDir": "xx",
"Name": "xx",
"Url": "xx",
"RawCode": "xx",
"Type": "xx",
"CodingPackageName": "xx"
},
"FailReason": "xx",
"AddonConfig": "xx",
"VersionNum": 0,
"ExtensionId": "xx",
"FailType": "xx",
"CIId": "xx",
"Type": "xx",
"CreateTime": 0
}
],
"RequestId": "xx"
}
}
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. 错误码
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码。
错误码 | 描述 |
---|---|
InvalidParameter | 参数错误。 |