1. 接口描述
接口请求域名: tsf.tencentcloudapi.com 。
TSF会将软件包上传到腾讯云对象存储(COS)。调用此接口获取上传信息,如目标地域,桶,包Id,存储路径,鉴权信息等,之后请使用COS API(或SDK)进行上传。
COS相关文档请查阅:https://cloud.tencent.com/document/product/436
默认接口请求频率限制:20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
参数名称 | 必选 | 类型 | 描述 |
---|---|---|---|
Action | 是 | String | 公共参数,本接口取值:DescribeUploadInfo。 |
Version | 是 | String | 公共参数,本接口取值:2018-03-26。 |
Region | 是 | String | 公共参数,详见产品支持的 地域列表,本接口仅支持其中的: ap-beijing, ap-chengdu, ap-guangzhou, ap-shanghai, ap-shanghai-fsi, ap-singapore, eu-frankfurt, na-siliconvalley 。 |
ApplicationId | 是 | String | 应用ID |
PkgName | 是 | String | 程序包名 |
PkgVersion | 是 | String | 程序包版本 |
PkgType | 是 | String | 程序包类型 |
PkgDesc | 否 | String | 程序包介绍 |
RepositoryType | 否 | String | 程序包仓库类型 |
RepositoryId | 否 | String | 程序包仓库id |
3. 输出参数
参数名称 | 类型 | 描述 |
---|---|---|
Result | CosUploadInfo | COS上传信息 |
RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 获取上传程序包信息
输入示例
https://tsf.tencentcloudapi.com/?Action=DescribeUploadInfo
&PkgName=test-drvier-api-1.0.0-SNAPSHOT.jar
&PkgType=fatjar
&PkgVersion=20190529xxxxxx
&ApplicationId=application-xxxxxx
&<公共请求参数>
输出示例
{
"Response": {
"RequestId": "7b3c781d-xxxx-47d4-xxxx-807a73291ff7",
"Result": {
"PkgId": "pkg-zzzzzz",
"Bucket": "tsf-gz-123456789",
"Region": "ap-guangzhou",
"Path": "111111111/application-xxxxxxxx/20190529174449/test.jar",
"Credentials": {
"SessionToken": "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
"TmpAppId": "123456789",
"TmpSecretId": "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
"TmpSecretKey": "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
"ExpiredTime": 1559100000,
"Domain": "cos.ap-guangzhou.myqcloud.com"
}
}
}
}
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.RuntimeError | 仓库内部错误。 |
InvalidParameter.ParamError | 参数错误。 |
ResourceInUse.ObjectExist | 资源对象已存在。 |
ResourceInsufficient.PackageSpaceFull | 仓库空间达到上限。 |
ResourceNotFound.InterfaceNotFound | [%s]模块未提供该接口[%s]。。 |
ResourceNotFound.ObjectNoExist | 资源对象不存在。 |
UnsupportedOperation.UnsupportAction | 不支持的ACTION。。 |