DescribeLibraries
Last updated: 2025-12-07 00:27:02
DescribeLibraries
Last updated: 2025-12-07 00:27:02
1. API Description
Domain name for API request: smh.intl.tencentcloudapi.com.
This API is used to query the PaaS service repository list.
A maximum of 20 requests can be initiated per second for this API.
We recommend you to use API Explorer
Try it
API Explorer provides a range of capabilities, including online call, signature authentication, SDK code generation, and API quick search. It enables you to view the request, response, and auto-generated examples.
2. Input Parameters
The following request parameter list only provides API request parameters and some common parameters. For the complete common parameter list, see Common Request Parameters.
| Parameter Name | Required | Type | Description |
|---|---|---|---|
| Action | Yes | String | Common Params. The value used for this API: DescribeLibraries. |
| Version | Yes | String | Common Params. The value used for this API: 2021-07-12. |
| Region | No | String | Common Params. This parameter is not required for this API. |
| LibraryIds.N | No | Array of String | Specifies one or more media library ids for querying, with a maximum of 100 per request. |
| PageNumber | No | Integer | Page number, int, used in conjunction with PageSize. default value is 1. |
| PageSize | No | Integer | Number of items per page, integer, used in conjunction with PageNumber. default value is 20. maximum value is 100. |
3. Output Parameters
| Parameter Name | Type | Description |
|---|---|---|
| List | Array of Library | Library list. |
| TotalCount | Integer | Total number. |
| RequestId | String | The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem. |
4. Example
Example1 Querying a Media Library
This example shows you how to query a media library.
Input Example
POST / HTTP/1.1
Host: smh.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeLibraries
<Common request parameters>
{}Output Example
{
"Response": {
"List": [
{
"LibraryId": "smh0q8nrvsg7t6y6",
"Name": "string"
"Remark": "string",
"BucketName": "smh-it-251202137",
"BucketRegion": "ap-guangzhou",
"AccessDomain": "smh0q8nrvsg7t6y6.api.tencentsmh.cn",
"CreationTime": "2021-09-28T06:02:26Z",
"LibraryExtension": {
"IsFileLibrary": true,
"IsMultiSpace": false,
"CosStorageClass": "INTELLIGENT_TIERING",
"UseRecycleBin": false,
"AutoRemoveRecycledDays": null,
"EnableSearch": false,
"DenyOnQuotaLessThanUsage": false,
"EnableFileHistory": false,
"FileHistoryCount": null,
"FileHistoryExpireDay": null,
"MaxDirFileNameLength": 255,
"IsPublicRead": false,
"IsMultiAlbum": null,
"AllowPhoto": null,
"AllowPhotoExtName": null,
"AllowVideo": null,
"AllowVideoExtName": null,
"AllowFileExtName": [],
"RecognizeSensitiveContent": false
},
"Size": "0",
"DirNum": "0",
"FileNum": "0"
},
{
"LibraryId": "smh1jjexrwwoa9ok",
"Name": "string"
"Remark": "",
"BucketName": "smh-it-251202137",
"BucketRegion": "ap-guangzhou",
"AccessDomain": "smh1jjexrwwoa9ok.api.tencentsmh.cn",
"CreationTime": "2021-09-28T09:43:07Z",
"LibraryExtension": {
"IsFileLibrary": true,
"IsMultiSpace": false,
"CosStorageClass": "INTELLIGENT_TIERING",
"UseRecycleBin": false,
"AutoRemoveRecycledDays": null,
"EnableSearch": false,
"DenyOnQuotaLessThanUsage": false,
"EnableFileHistory": false,
"FileHistoryCount": null,
"FileHistoryExpireDay": null,
"MaxDirFileNameLength": 255,
"IsPublicRead": false,
"IsMultiAlbum": null,
"AllowPhoto": null,
"AllowPhotoExtName": null,
"AllowVideo": null,
"AllowVideoExtName": null,
"AllowFileExtName": [],
"RecognizeSensitiveContent": false
},
"Size": "0",
"DirNum": "0",
"FileNum": "0"
},
{
"LibraryId": "smh12pzokd9c6r5n",
"Name": "string"
"Remark": "",
"BucketName": "smh-it-251202137",
"BucketRegion": "ap-guangzhou",
"AccessDomain": "smh12pzokd9c6r5n.api.tencentsmh.cn",
"CreationTime": "2021-09-28T12:31:31Z",
"LibraryExtension": {
"IsFileLibrary": true,
"IsMultiSpace": false,
"CosStorageClass": "INTELLIGENT_TIERING",
"UseRecycleBin": false,
"AutoRemoveRecycledDays": null,
"EnableSearch": false,
"DenyOnQuotaLessThanUsage": false,
"EnableFileHistory": false,
"FileHistoryCount": null,
"FileHistoryExpireDay": null,
"MaxDirFileNameLength": 255,
"IsPublicRead": false,
"IsMultiAlbum": null,
"AllowPhoto": null,
"AllowPhotoExtName": null,
"AllowVideo": null,
"AllowVideoExtName": null,
"AllowFileExtName": [],
"RecognizeSensitiveContent": false
},
"Size": "0",
"DirNum": "0",
"FileNum": "0"
},
{
"LibraryId": "smh3s9iq6lfsoud1",
"Name": "string"
"Remark": "",
"BucketName": "smh-it-251202137",
"BucketRegion": "ap-guangzhou",
"AccessDomain": "smh3s9iq6lfsoud1.api.tencentsmh.cn",
"CreationTime": "2021-09-28T12:32:06Z",
"LibraryExtension": {
"IsFileLibrary": true,
"IsMultiSpace": false,
"CosStorageClass": "INTELLIGENT_TIERING",
"UseRecycleBin": false,
"AutoRemoveRecycledDays": null,
"EnableSearch": false,
"DenyOnQuotaLessThanUsage": false,
"EnableFileHistory": false,
"FileHistoryCount": null,
"FileHistoryExpireDay": null,
"MaxDirFileNameLength": 255,
"IsPublicRead": false,
"IsMultiAlbum": null,
"AllowPhoto": null,
"AllowPhotoExtName": null,
"AllowVideo": null,
"AllowVideoExtName": null,
"AllowFileExtName": [],
"RecognizeSensitiveContent": false
},
"Size": "0",
"DirNum": "0",
"FileNum": "0"
},
{
"LibraryId": "smh1porquwr19l42",
"Name": "string"
"Remark": "",
"BucketName": "smh-it-251202137",
"BucketRegion": "ap-guangzhou",
"AccessDomain": "smh1porquwr19l42.api.tencentsmh.cn",
"CreationTime": "2021-09-28T12:33:20Z",
"LibraryExtension": {
"IsFileLibrary": true,
"IsMultiSpace": false,
"CosStorageClass": "INTELLIGENT_TIERING",
"UseRecycleBin": false,
"AutoRemoveRecycledDays": null,
"EnableSearch": false,
"DenyOnQuotaLessThanUsage": false,
"EnableFileHistory": false,
"FileHistoryCount": null,
"FileHistoryExpireDay": null,
"MaxDirFileNameLength": 255,
"IsPublicRead": false,
"IsMultiAlbum": null,
"AllowPhoto": null,
"AllowPhotoExtName": null,
"AllowVideo": null,
"AllowVideoExtName": null,
"AllowFileExtName": [],
"RecognizeSensitiveContent": false
},
"Size": "0",
"DirNum": "0",
"FileNum": "0"
},
{
"LibraryId": "smh32bey5u1lr6bx",
"Name": "string"
"Remark": "",
"BucketName": "smh-it-251202137",
"BucketRegion": "ap-guangzhou",
"AccessDomain": "smh32bey5u1lr6bx.api.tencentsmh.cn",
"CreationTime": "2021-09-28T12:33:27Z",
"LibraryExtension": {
"IsFileLibrary": true,
"IsMultiSpace": false,
"CosStorageClass": "INTELLIGENT_TIERING",
"UseRecycleBin": false,
"AutoRemoveRecycledDays": null,
"EnableSearch": false,
"DenyOnQuotaLessThanUsage": false,
"EnableFileHistory": false,
"FileHistoryCount": null,
"FileHistoryExpireDay": null,
"MaxDirFileNameLength": 255,
"IsPublicRead": false,
"IsMultiAlbum": null,
"AllowPhoto": null,
"AllowPhotoExtName": null,
"AllowVideo": null,
"AllowVideoExtName": null,
"AllowFileExtName": [],
"RecognizeSensitiveContent": false
},
"Size": "0",
"DirNum": "0",
"FileNum": "0"
}
],
"TotalCount": 6,
"RequestId": "3d486825-fc56-434f-82d0-1db782b66728"
}
}5. Developer Resources
SDK
TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.
- Tencent Cloud SDK 3.0 for Python
- Tencent Cloud SDK 3.0 for Java
- Tencent Cloud SDK 3.0 for PHP
- Tencent Cloud SDK 3.0 for Go
- Tencent Cloud SDK 3.0 for Node.js
- Tencent Cloud SDK 3.0 for .NET
- Tencent Cloud SDK 3.0 for C++
Command Line Interface
6. Error Code
The following only lists the error codes related to the API business logic. For other error codes, see Common Error Codes.
| Error Code | Description |
|---|---|
| InternalError | Internal error. |
| InvalidParameterValue.LimitExceeded | The number of parameter values or characters exceeds the limit. |
Was this page helpful?
You can also Contact Sales or Submit a Ticket for help.
Yes
No
Feedback