ListDocumentRetrieve
Searches government document libraries based on complex conditions.
Operation description
The Quanmiao product supports iframe embedding. For more information, see Customer Integration: Quanmiao Public Cloud iframe Customization Plan.
Try it now
Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.
RAM authorization
The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:
-
Action: The actions can be used in the
Actionelement of RAM permission policy statements to grant permissions to perform the operation. -
API: The API that you can call to perform the action.
-
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
-
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the
Resourceelement of the policy. - For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the
Resourceelement of the policy.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the
-
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
-
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.
Action | Access level | Resource type | Condition key | Dependent action |
|---|---|---|---|---|
aimiaobi:ListDocumentRetrieve | list | *All Resource
| None | None |
Request syntax
POST HTTP/1.1
Request parameters
Parameter | Type | Required | Description | Example | ||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| WorkspaceId | string | Yes | Unique identifier of the Model Studio workspace. For more information, see Get workspaceId. | llm- | ||||||||||||||||||||||||||||||
| MaxResults | integer | No | Maximum number of results to return. | 94 | ||||||||||||||||||||||||||||||
| NextToken | string | No | Token for the next page of results. | cEoBWREAXdxaOyjq/cqAbg== | ||||||||||||||||||||||||||||||
| Query | string | No | Search condition. | 检索Query | ||||||||||||||||||||||||||||||
| ContentType | string | No | Document type. Valid values: 0 (default): All types. 1: Government documents. 2: Important articles. 5: Policy interpretation. 6: Legal provisions. 7: Regulations and rules. 8: General Secretary. | 1 | ||||||||||||||||||||||||||||||
| SubContentType | string | No |
| 1 | ||||||||||||||||||||||||||||||
| Region | string | No | Region. Enter a province or city, such as Jilin Province or Beijing Municipality. | 北京市 | ||||||||||||||||||||||||||||||
| Source | string | No | Source. Valid values: 0: Internal (within your organization). 1: External (outside your organization). | 1 | ||||||||||||||||||||||||||||||
| StartDate | string | No | Start date of issuance in yyyy-MM-dd format. | 2025-10-10 | ||||||||||||||||||||||||||||||
| EndDate | string | No | End date of issuance in yyyy-MM-dd format. | 2025-07-03 | ||||||||||||||||||||||||||||||
| Office | string | No | Issuing agency. | 国务院办公室 | ||||||||||||||||||||||||||||||
| WordSize | string | No | Document number. | 宁民规〔2020〕5号 | ||||||||||||||||||||||||||||||
| ElementScope | string | No | Search scope. Valid values: 1: Title only. 0: Full text (title and content). Default is 0. | 0 | ||||||||||||||||||||||||||||||
| SubjectClassify | string | No | Supported classifications:
| 国防和交流合作事务 |
Response elements
Element | Type | Description | Example |
|---|---|---|---|
object | Response schema. | ||
| Code | string | Status code. | successful |
| Data | array<object> | Business data. | data |
object | Business data. | ||
| Title | string | Title. | 文章标题 |
| Essay | string | Main text. | 文章正文 |
| Link | string | URL. | 文章链接 |
| IssuingAuthority | string | Issuing agency. | 发布机构 |
| PublicationDate | string | Publication date. | 2023-02-01 |
| HttpStatusCode | integer | HTTP status code. | 200 |
| MaxResults | integer | Maximum number of records returned. | 71 |
| Message | string | Error message. | success |
| NextToken | string | Token for the next page. | cEoBWREAXdxaOyjq/cqAbg== |
| RequestId | string | ID of the request. | F2F366D6-E9FE-1006-BB70-2C650896AAB5 |
| Success | boolean | Indicates whether the operation succeeded. A value of true indicates success. A value of false indicates failure. | true |
| TotalCount | integer | Total count. | 100 |
Examples
Success response
JSON format
{
"Code": "successful",
"Data": [
{
"Title": "文章标题",
"Essay": "文章正文",
"Link": "文章链接",
"IssuingAuthority": "发布机构",
"PublicationDate": "2023-02-01"
}
],
"HttpStatusCode": 200,
"MaxResults": 71,
"Message": "success",
"NextToken": "cEoBWREAXdxaOyjq/cqAbg==",
"RequestId": "F2F366D6-E9FE-1006-BB70-2C650896AAB5",
"Success": true,
"TotalCount": 100
}
Error codes
HTTP status code | Error code | Error message | Description |
|---|---|---|---|
| 403 | NoPermission | You are not authorized to perform this action. | Please check the workspaceId assignment |
See Error Codes for a complete list.
Release notes
See Release Notes for a complete list.