1. 接口描述
接口请求域名: tsf.tencentcloudapi.com 。
无
默认接口请求频率限制:20次/秒。
                推荐使用 API Explorer
            
            点击调试
        
                API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
            
        2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 | 
|---|---|---|---|
| Action | 是 | String | 公共参数,本接口取值:DescribePkgs。 | 
| Version | 是 | String | 公共参数,本接口取值:2018-03-26。 | 
| Region | 是 | String | 公共参数,详见产品支持的 地域列表,本接口仅支持其中的: ap-beijing, ap-chengdu, ap-guangzhou, ap-nanjing, ap-shanghai, ap-shanghai-fsi, ap-singapore, eu-frankfurt, na-siliconvalley 。 | 
| ApplicationId | 是 | String | 应用ID,通过调用DescribeApplications接口获取应用列表从而获取应用ID,或登录控制台进行查看,调用CreateApplication接口创建应用时的返回值 示例值:application-6a79x94v | 
| SearchWord | 否 | String | 查询关键字(支持根据包ID,包名,包版本号搜索) 示例值:demoApp | 
| OrderBy | 否 | String | 排序关键字(默认值"UploadTime"),允许值:"UploadTime"上传时间, "name"程序包名, "size"应用大小, "id"程序包ID 示例值:UploadTime | 
| OrderType | 否 | Integer | 升序:0/降序:1(默认降序) 示例值:1 | 
| Offset | 否 | Integer | 查询起始偏移,大于等于0,默认值为0 示例值:0 | 
| Limit | 否 | Integer | 返回数量限制 示例值:50 | 
| RepositoryType | 否 | String | 程序包仓库类型,允许值:"public-demo"TSF公共demo仓库, "private"自定义仓库, "default"TSF公共仓库 示例值:private | 
| RepositoryId | 否 | String | 仓库ID,可通过调用仓库信息查询类接口时出参中的RepositoryId,或登录控制台进行查看 示例值:tcr-6a79x94v | 
| PackageTypeList.N | 否 | Array of String | 程序包类型数组支持(fatjar jar war tar.gz zip) 示例值:["jar"] | 
3. 输出参数
| 参数名称 | 类型 | 描述 | 
|---|---|---|
| Result | PkgList | 符合查询程序包信息列表 | 
| RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 | 
4. 示例
示例1 获取应用下程序包列表
获取应用application-jy9w6lka下的程序包信息
输入示例
https://tsf.tencentcloudapi.com/?Action=DescribePkgs
&ApplicationId=application-xxxxxxxx
&Offset=0
&Limit=20
&<公共请求参数>输出示例
{
    "Response": {
        "Result": {
            "TotalCount": 0,
            "Content": [
                {
                    "PkgId": "pkg-6a79x94v",
                    "PkgName": "java-consumer",
                    "PkgType": "jar",
                    "PkgVersion": "v1",
                    "PkgDesc": "this is a desc",
                    "UploadTime": "2020-11-12 09:12:33",
                    "Md5": "2s78294s810xxxxxxxxxxx",
                    "PkgPubStatus": 0,
                    "PkgBindInfo": [
                        {
                            "ApplicationId": "application-6a79x94v",
                            "GroupId": "group-6a79x94v"
                        }
                    ]
                }
            ],
            "RepositoryId": "repository-6a79x94v",
            "RepositoryType": "cos",
            "RepositoryName": "bucket-mock"
        },
        "RequestId": "96561cf1-738a-47d6-943b-dec7ebbccabe"
    }
}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: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for Java: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for PHP: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for Go: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for Node.js: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for .NET: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for C++: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for Ruby: CNB, GitHub, Gitee
命令行工具
6. 错误码
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码。
| 错误码 | 描述 | 
|---|---|
| InternalError.RuntimeError | 仓库内部错误。 | 
| InvalidParameter.ParamError | 参数错误。 | 
| ResourceNotFound.InterfaceNotFound | [%s]模块未提供该接口[%s]。 | 
| UnsupportedOperation.UnsupportAction | 不支持的ACTION。 |