1. 接口描述
接口请求域名: csip.tencentcloudapi.com 。
查看COS接口列表
默认接口请求频率限制:20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数,本接口取值:DescribeCosActionList。 |
| Version | 是 | String | 公共参数,本接口取值:2022-11-21。 |
| Region | 否 | String | 公共参数,此参数为可选参数。 |
| Filter | 否 | Filter | 过滤器 |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| Data | Array of CosActionInfo | 列表 |
| RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 查看COS接口列表
输入示例
POST / HTTP/1.1
Host: csip.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeCosActionList
<公共请求参数>
{}
输出示例
{
"Response": {
"RequestId": "req-123456789",
"Data": [
{
"ActionName": "GetObject",
"ActionNameCn": "获取对象",
"ActionDescription": "从存储桶中获取指定对象的内容"
},
{
"ActionName": "PutObject",
"ActionNameCn": "上传对象",
"ActionDescription": "将对象上传到指定的存储桶中"
},
{
"ActionName": "DeleteObject",
"ActionNameCn": "删除对象",
"ActionDescription": "从存储桶中删除指定的对象"
},
{
"ActionName": "ListObjects",
"ActionNameCn": "列出对象",
"ActionDescription": "列出存储桶中的对象列表"
},
{
"ActionName": "GetBucketAcl",
"ActionNameCn": "获取存储桶访问控制列表",
"ActionDescription": "获取存储桶的访问控制列表配置"
},
{
"ActionName": "PutBucketAcl",
"ActionNameCn": "设置存储桶访问控制列表",
"ActionDescription": "设置存储桶的访问控制列表"
},
{
"ActionName": "GetBucketPolicy",
"ActionNameCn": "获取存储桶策略",
"ActionDescription": "获取存储桶的策略配置"
},
{
"ActionName": "PutBucketPolicy",
"ActionNameCn": "设置存储桶策略",
"ActionDescription": "设置存储桶的策略配置"
},
{
"ActionName": "GetBucketVersioning",
"ActionNameCn": "获取存储桶版本控制",
"ActionDescription": "获取存储桶的版本控制配置"
},
{
"ActionName": "PutBucketVersioning",
"ActionNameCn": "设置存储桶版本控制",
"ActionDescription": "设置存储桶的版本控制"
},
{
"ActionName": "GetBucketLifecycle",
"ActionNameCn": "获取存储桶生命周期",
"ActionDescription": "获取存储桶的生命周期配置"
},
{
"ActionName": "PutBucketLifecycle",
"ActionNameCn": "设置存储桶生命周期",
"ActionDescription": "设置存储桶的生命周期规则"
},
{
"ActionName": "GetBucketEncryption",
"ActionNameCn": "获取存储桶加密",
"ActionDescription": "获取存储桶的加密配置"
},
{
"ActionName": "PutBucketEncryption",
"ActionNameCn": "设置存储桶加密",
"ActionDescription": "设置存储桶的加密配置"
},
{
"ActionName": "GetBucketReplication",
"ActionNameCn": "获取存储桶复制",
"ActionDescription": "获取存储桶的复制配置"
},
{
"ActionName": "PutBucketReplication",
"ActionNameCn": "设置存储桶复制",
"ActionDescription": "设置存储桶的复制规则"
},
{
"ActionName": "GetBucketNotification",
"ActionNameCn": "获取存储桶通知",
"ActionDescription": "获取存储桶的通知配置"
},
{
"ActionName": "PutBucketNotification",
"ActionNameCn": "设置存储桶通知",
"ActionDescription": "设置存储桶的通知配置"
},
{
"ActionName": "GetBucketTagging",
"ActionNameCn": "获取存储桶标签",
"ActionDescription": "获取存储桶的标签配置"
},
{
"ActionName": "PutBucketTagging",
"ActionNameCn": "设置存储桶标签",
"ActionDescription": "设置存储桶的标签"
}
]
}
}
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. 错误码
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码。
| 错误码 | 描述 |
|---|---|
| FailedOperation | 操作失败。 |
| InternalError | 内部错误。 |
| InvalidFilter | 无效的过滤器 |
| InvalidParameter | 参数错误。 |
| InvalidParameterValue | 参数取值错误。 |
| OperationDenied | 操作被拒绝。 |
| ResourceInUse | 资源被占用。 |
| ResourceNotFound | 资源不存在。 |
| ResourceUnavailable | 资源不可用。 |
| UnknownParameter | 未知参数错误。 |