1. 接口描述
接口请求域名: tsf.tencentcloudapi.com 。
查询仓库列表
默认接口请求频率限制:20次/秒。
                推荐使用 API Explorer
            
            点击调试
        
                API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
            
        2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 | 
|---|---|---|---|
| Action | 是 | String | 公共参数,本接口取值:DescribeRepositories。 | 
| 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 。 | 
| SearchWord | 否 | String | 查询关键字(按照仓库名称搜索) 示例值:demo | 
| Offset | 否 | Integer | 查询起始偏移,大于等于0,默认值为0 示例值:0 | 
| Limit | 否 | Integer | 返回数量限制,大于0,默认为不分页 示例值:10 | 
| RepositoryType | 否 | String | 仓库类型(默认仓库:default,私有仓库:private,公共仓库:public-demo) 示例值:private | 
3. 输出参数
| 参数名称 | 类型 | 描述 | 
|---|---|---|
| Result | RepositoryList | 符合查询仓库信息列表 | 
| RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 | 
4. 示例
示例1 获取所有仓库列表
输入示例
https://tsf.tencentcloudapi.com/?Action=DescribeRepositories
&Offset=0
&Limit=20
&SearchWord=demo
&RepositoryType=default
&<公共请求参数>输出示例
{
    "Response": {
        "Result": {
            "TotalCount": 0,
            "Content": [
                {
                    "RepositoryId": "repo-6a79x94v",
                    "RepositoryName": "repo-mock",
                    "RepositoryType": "cos",
                    "RepositoryDesc": "this is a desc",
                    "IsUsed": true,
                    "CreateTime": "2019-12-20 09:33:22",
                    "BucketName": "testBucket",
                    "BucketRegion": "ap-guangzhou",
                    "Directory": "/app"
                }
            ]
        },
        "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 | 参数错误。 | 
| UnsupportedOperation.UnsupportAction | 不支持的ACTION。 |