1. 接口描述
接口请求域名: smh.tencentcloudapi.com 。
查询 PaaS 服务媒体库列表
默认接口请求频率限制:20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
参数名称 | 必选 | 类型 | 描述 |
---|---|---|---|
Action | 是 | String | 公共参数,本接口取值:DescribeLibraries。 |
Version | 是 | String | 公共参数,本接口取值:2021-07-12。 |
Region | 否 | String | 公共参数,本接口不需要传递此参数。 |
LibraryIds.N | 否 | Array of String | 按照一个或者多个媒体库 ID 查询,每次请求的上限为 100 个。 示例值:[ 'smh3ptyc9mscifdi', 'smh2dugfmc1jrnzd' ] |
PageNumber | 否 | Integer | 页码,整型,配合 PageSize 使用,默认值为 1。 示例值:2 |
PageSize | 否 | Integer | 每页数目,整型,配合 PageNumber 使用,默认值为 20,最大值为 100。 示例值:20 |
3. 输出参数
参数名称 | 类型 | 描述 |
---|---|---|
List | Array of Library | 媒体库列表 |
TotalCount | Integer | 总数 示例值:5 |
RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 查询媒体库
查询媒体库
输入示例
POST / HTTP/1.1
Host: smh.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeLibraries
<公共请求参数>
{}
输出示例
{
"Response": {
"List": [
{
"LibraryId": "smh0q8nrvsg7t6y6",
"Name": "字符串",
"Remark": "字符串",
"BucketName": "smh-it-251202137",
"BucketRegion": "ap-guangzhou",
"CreationTime": "2021-09-28T06:02:26Z",
"LibraryExtension": {
"IsFileLibrary": true,
"IsMultiSpace": false,
"CosStorageClass": "INTELLIGENT_TIERING",
"UseRecycleBin": false,
"EnableSearch": false,
"DenyOnQuotaLessThanUsage": false,
"EnableFileHistory": false,
"MaxDirFileNameLength": 255,
"IsPublicRead": false,
"AllowFileExtName": [],
"RecognizeSensitiveContent": false
},
"Size": "0",
"DirNum": "0",
"FileNum": "0"
},
{
"LibraryId": "smh1jjexrwwoa9ok",
"Name": "字符串",
"Remark": "",
"BucketName": "smh-it-251202137",
"BucketRegion": "ap-guangzhou",
"CreationTime": "2021-09-28T09:43:07Z",
"LibraryExtension": {
"IsFileLibrary": true,
"IsMultiSpace": false,
"CosStorageClass": "INTELLIGENT_TIERING",
"UseRecycleBin": false,
"EnableSearch": false,
"DenyOnQuotaLessThanUsage": false,
"EnableFileHistory": false,
"MaxDirFileNameLength": 255,
"IsPublicRead": false,
"AllowFileExtName": [],
"RecognizeSensitiveContent": false
},
"Size": "0",
"DirNum": "0",
"FileNum": "0"
},
{
"LibraryId": "smh12pzokd9c6r5n",
"Name": "字符串",
"Remark": "",
"BucketName": "smh-it-251202137",
"BucketRegion": "ap-guangzhou",
"CreationTime": "2021-09-28T12:31:31Z",
"LibraryExtension": {
"IsFileLibrary": true,
"IsMultiSpace": false,
"CosStorageClass": "INTELLIGENT_TIERING",
"UseRecycleBin": false,
"EnableSearch": false,
"DenyOnQuotaLessThanUsage": false,
"EnableFileHistory": false,
"MaxDirFileNameLength": 255,
"IsPublicRead": false,
"AllowFileExtName": [],
"RecognizeSensitiveContent": false
},
"Size": "0",
"DirNum": "0",
"FileNum": "0"
},
{
"LibraryId": "smh3s9iq6lfsoud1",
"Name": "字符串",
"Remark": "",
"BucketName": "smh-it-251202137",
"BucketRegion": "ap-guangzhou",
"CreationTime": "2021-09-28T12:32:06Z",
"LibraryExtension": {
"IsFileLibrary": true,
"IsMultiSpace": false,
"CosStorageClass": "INTELLIGENT_TIERING",
"UseRecycleBin": false,
"EnableSearch": false,
"DenyOnQuotaLessThanUsage": false,
"EnableFileHistory": false,
"MaxDirFileNameLength": 255,
"IsPublicRead": false,
"AllowFileExtName": [],
"RecognizeSensitiveContent": false
},
"Size": "0",
"DirNum": "0",
"FileNum": "0"
},
{
"LibraryId": "smh1porquwr19l42",
"Name": "字符串",
"Remark": "",
"BucketName": "smh-it-251202137",
"BucketRegion": "ap-guangzhou",
"CreationTime": "2021-09-28T12:33:20Z",
"LibraryExtension": {
"IsFileLibrary": true,
"IsMultiSpace": false,
"CosStorageClass": "INTELLIGENT_TIERING",
"UseRecycleBin": false,
"EnableSearch": false,
"DenyOnQuotaLessThanUsage": false,
"EnableFileHistory": false,
"MaxDirFileNameLength": 255,
"IsPublicRead": false,
"AllowFileExtName": [],
"RecognizeSensitiveContent": false
},
"Size": "0",
"DirNum": "0",
"FileNum": "0"
},
{
"LibraryId": "smh32bey5u1lr6bx",
"Name": "字符串",
"Remark": "",
"BucketName": "smh-it-251202137",
"BucketRegion": "ap-guangzhou",
"CreationTime": "2021-09-28T12:33:27Z",
"LibraryExtension": {
"IsFileLibrary": true,
"IsMultiSpace": false,
"CosStorageClass": "INTELLIGENT_TIERING",
"UseRecycleBin": false,
"EnableSearch": false,
"DenyOnQuotaLessThanUsage": false,
"EnableFileHistory": false,
"MaxDirFileNameLength": 255,
"IsPublicRead": false,
"AllowFileExtName": [],
"RecognizeSensitiveContent": false
},
"Size": "0",
"DirNum": "0",
"FileNum": "0"
}
],
"TotalCount": 6,
"RequestId": "3d486825-fc56-434f-82d0-1db782b66728"
}
}
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 | 内部错误。 |
InvalidParameterValue.LimitExceeded | 参数值数量或字符数超过限制。 |