Domain name for API request: adp.intl.tencentcloudapi.com.
Query the abstract list of a document.
A maximum of 20 requests can be initiated per second for this API.
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: DescribeDocSummaryList. |
| Version | Yes | String | Common Params. The value used for this API: 2026-05-20. |
| Region | Yes | String | Common Params. For more information, please see the list of regions supported by the product. |
| KbId | Yes | String | ID of the knowledge base it belongs to |
| FilterList.N | No | Array of Filter | Filter criteria (multiple Filters are in an AND relationship, and multiple Values of the same Filter are in an OR relationship): Status - document status, enumeration value, exact match; CategoryId - category ID, exact match; SourceType - document source type, enumeration value, exact match; EffectiveDomain - application scope, exact match; CreateTime - creation time, Unix seconds, BETWEEN with [start second, end second]; UpdateTime - update time, Unix seconds, BETWEEN with [start second, end second] |
| PageNumber | No | Integer | Page number, starting from 0. |
| PageSize | No | Integer | Number of items per page. Default: 10. Maximum: 100 |
| Query | No | DocQuery | Query condition (keyword + query scope) |
| SummaryListSwitch | No | SummaryListSwitch | Switch configuration |
| Parameter Name | Type | Description |
|---|---|---|
| DocList | Array of DocSummary | Document list |
| TotalCount | Integer | Total. |
| 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. |
Query the abstract list of a document
POST / HTTP/1.1
Host: adp.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeDocSummaryList
<Common request parameters>
{
"KbId": "2063937671963228544",
"SummaryListSwitch": {
"ShowMetadataEnabled": true
}
}{
"Response": {
"DocList": [
{
"CategoryPath": {
"CategoryId": "2063937672853638592",
"CategoryIdPath": [],
"CategoryNamePath": []
},
"DocId": "2095797834220731520",
"KnowledgeScope": {
"EffectiveDomain": 4,
"LabelRefList": []
},
"Lifecycle": {
"CreateTime": "1788512116",
"ExpirationPolicy": null,
"Status": 8,
"StatusDesc": "Import complete"
"StatusMessage": "",
"UpdateTime": "1788935064"
},
"Metadata": {
"DocCharCount": "45120",
"FileName": "PICC Health Xiyue Junxin Internet Critical Illness Insurance (2022 Edition)_1721880984_1_copy.doc",
"FileSize": "435953",
"FileType": "doc",
"RefFieldNameList": [],
"SourceDesc": "Local document",
"SourceType": 0
},
"OperatorInfo": {
"Modifier": {
"UserId": "1747547736783716352",
"UserName": "coco test 11"
},
"Permission": {
"CanDelete": true,
"CanEdit": true,
"CanRestart": true,
"CanRetry": false
}
},
"TaskStatus": null
}
],
"TotalCount": 22,
"RequestId": "66c89981-2fd7-4eab-a598-4610960b9662"
}
}TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.
There is no error code related to the API business logic. For other error codes, please see Common Error Codes.
Was this page helpful?
You can also Contact sales or Submit a Ticket for help.
Help us improve! Rate your documentation experience in 5 mins.
Feedback