有奖捉虫:云通信与企业服务文档专题,速来> HOT

1. 接口描述

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

获取云托管代码上传url

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

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

2. 输入参数

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

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:DescribeCloudBaseBuildService。
Version String 公共参数,本接口取值:2018-06-08。
Region String 公共参数,本接口不需要传递此参数。
EnvId String 环境id
ServiceName String 服务名
CIBusiness String build类型,枚举值有: cloudbaserun, framework-ci
ServiceVersion String 服务版本
Suffix String 文件后缀
示例值:.zip

3. 输出参数

参数名称 类型 描述
UploadUrl String 上传url
示例值:xxx
UploadHeaders Array of KVPair 上传header
示例值:xxx
PackageName String 包名
示例值:xxx
PackageVersion String 包版本
示例值:xxx
DownloadUrl String 下载链接
注意:此字段可能返回 null,表示取不到有效值。
DownloadHeaders Array of KVPair 下载Httpheader
注意:此字段可能返回 null,表示取不到有效值。
OutDate Boolean 下载链接是否过期
注意:此字段可能返回 null,表示取不到有效值。
示例值:false
RequestId String 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 获取云托管代码上传url

通过环境id,获得云托管代码上传url, 用来上传代码

输入示例

https://tcb.tencentcloudapi.com/?Action=DescribeCloudBaseBuildService
&EnvId=cdnheader-v2a
&ServiceName=nginx-test
&<公共请求参数>

输出示例

{
    "Response": {
        "DownloadHeaders": [
            {
                "Value": "value",
                "Key": "key"
            }
        ],
        "UploadHeaders": [
            {
                "Value": "value1",
                "Key": "key1"
            }
        ],
        "UploadUrl": "http://url",
        "DownloadUrl": "http://url/download",
        "RequestId": "asdasd-asfasfas-asfasfa",
        "OutDate": true,
        "PackageVersion": "version",
        "PackageName": "name"
    }
}

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 参数错误。
InvalidParameter.ServiceNotExist 服务不存在。
ResourceNotFound 资源不存在。