1. 接口描述
接口请求域名: tcb.tencentcloudapi.com 。
创建云开发项目
默认接口请求频率限制:20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
参数名称 | 必选 | 类型 | 描述 |
---|---|---|---|
Action | 是 | String | 公共参数,本接口取值:CreateAndDeployCloudBaseProject。 |
Version | 是 | String | 公共参数,本接口取值:2018-06-08。 |
Region | 否 | String | 公共参数,本接口不需要传递此参数。 |
Name | 是 | String | 项目名 示例值:vue |
Source | 是 | CodeSource | 来源 示例值:https://github.com/myrepo/vue |
EnvId | 否 | String | 环境id 示例值:envcool |
Type | 否 | String | 项目类型, 枚举值为: framework-oneclick,qci-extension-cicd 示例值:framework-oneclick |
Parameters.N | 否 | Array of KVPair | 环境变量 示例值:[] |
EnvAlias | 否 | String | 环境别名。要以a-z开头,不能包含a-zA-z0-9-以外的字符 示例值:cool |
RcJson | 否 | String | rc.json的内容 示例值:{} |
AddonConfig | 否 | String | 插件配置内容 示例值:{} |
Tags.N | 否 | Array of String | 标签 示例值:["hot","sexy"] |
NetworkConfig | 否 | String | 网络配置 示例值:{} |
FreeQuota | 否 | String | 用户享有的免费额度级别,目前只能为“basic”,不传该字段或该字段为空,标识不享受免费额度。 示例值:basic |
AutoDeployOnCodeChange | 否 | Boolean | 是否代码变更触发自动部署 示例值:false |
RepoUrl | 否 | String | 私有仓库地址 示例值:https://github.com/myrepo/vue |
3. 输出参数
参数名称 | 类型 | 描述 |
---|---|---|
EnvId | String | 环境Id 注意:此字段可能返回 null,表示取不到有效值。 示例值:envcool-212i1i21 |
RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 创建云开发项目
输入示例
POST / HTTP/1.1
Host: tcb.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CreateAndDeployCloudBaseProject
<公共请求参数>
{
"EnvId": "xx",
"Name": "xx",
"Parameters": [
{
"Value": "xx",
"Key": "xx"
}
],
"Tags": [
null
],
"RcJson": "xx",
"FreeQuota": "xx",
"NetworkConfig": "xx",
"RepoUrl": "xx",
"Source": {
"CodingPackageVersion": "xx",
"WorkDir": "xx",
"Name": "xx",
"Url": "xx",
"ProjectId": 0,
"RawCode": "xx",
"Branch": "xx",
"ProjectName": "xx",
"Type": "xx",
"CodingPackageName": "xx"
},
"AddonConfig": "xx",
"AutoDeployOnCodeChange": true,
"EnvAlias": "xx",
"Type": "xx"
}
输出示例
{
"Response": {
"EnvId": "lowcode-7ggmm27y1d0633a9",
"RequestId": "00b9517e-7ba6-4b41-b0c3-4d50c64cef62"
}
}
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 | 参数错误。 |
LimitExceeded | 超过配额限制。 |
MissingParameter.Param | 缺少必要参数。 |
ResourceInUse | 资源被占用。 |
ResourceNotFound | 资源不存在。 |
ResourceUnavailable.RefreshTokenExpired | 云项目oAuth授权失效(即RefreshToken过期)。 |
UnauthorizedOperation.CodeOAuthUnauthorized | 外部代码仓库未授权。 |