开发指南

API 文档

获取云开发项目列表

最近更新时间:2022-04-13 07:10:50

我的收藏

1. 接口描述

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

获取云开发项目列表

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

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

2. 输入参数

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

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:DescribeCloudBaseProjectLatestVersionList。
Version String 公共参数,本接口取值:2018-06-08。
Region String 公共参数,本接口不需要传递此参数。
Offset Integer 偏移量
PageSize Integer 个数
EnvId String 环境id, 非必填
ProjectName String 项目名称, 非必填
ProjectType String 项目类型: framework-oneclick,qci-extension-cicd
Tags.N Array of String 标签
CiId String ci的id

3. 输出参数

参数名称 类型 描述
ProjectList 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: DescribeCloudBaseProjectLatestVersionList
<公共请求参数>

{
    "EnvId": "xx",
    "ProjectType": "xx",
    "PageSize": 0,
    "Tags": [
        "xx"
    ],
    "ProjectName": "xx",
    "Offset": 0,
    "CiId": "12a05f48-3edd-41f4-a8cc-573b500111f3"
}

输出示例

{
  "Response": {
    "ProjectList": [
      {
        "Status": "xx",
        "UpdateTime": "xx",
        "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",
          "Type": "xx",
          "CodingPackageName": "xx"
        },
        "FailReason": "xx",
        "AddonConfig": "xx",
        "VersionNum": 0,
        "CIId": "xx",
        "Type": "xx",
        "CreateTime": "xx"
      }
    ],
    "TotalCount": 1,
    "RequestId": "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 参数错误。
MissingParameter.Param 缺少必要参数。
ResourceNotFound 资源不存在。
目录