ListDatasetDocuments

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 Action element 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 Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
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:ListDatasetDocuments	list	All Resource ``	None	None

Action

Access level

Resource type

Condition key

Dependent action

aimiaobi:ListDatasetDocuments

list

*All Resource

*

None

Request syntax

POST  HTTP/1.1

Request parameters

Parameter	Type	Required	Description	Example
WorkspaceId	string	Yes	The unique ID of the Model Studio workspace. For more information, see Get workspace ID.	xxxx
Query	string	No	The search query.	Search query
DatasetId	integer	No	The unique ID of the dataset. You must specify either this parameter or `DatasetName`.	1
DatasetName	string	No	The name of the dataset.	Dataset name
Status	integer	No	The status of the document. Valid values: `1`: Document created. `2`: Text index built. `3`: Multimodal index built. `100`: Full build complete. `0`: Build failed.	100
DocType	string	No	The type of the document. Valid values: `plainText`: Plain text. `richText`: Rich text. `text`: A text file. `pdf`: A PDF file. `word`: A Word file. `image`: An image file. `video`: A video file.	text
DatasetDescription	string	No	Deprecated.	xx
IncludeFields	array	No	The fields to include in the response.
	string	No	The field to include. Valid values: `content`: The document content. `chunks`: The document's chunks.	content
ExcludeFields	array	No	The fields to exclude from the response. Valid value: `content`: The document content.
	string	No	The field to exclude.	content
PageNumber	integer	No	The page number.	1
PageSize	integer	No	The number of entries per page. Default value: 10.	10
CategoryUuids	array	No	The unique IDs of the categories.
	string	No	The unique ID of the category.	xx
Tags	array	No	The tags.
	string	No	The tag.	xx
Extend1	string	No	A custom extension field.	xx
Extend2	string	No	A custom extension field.	xx
Extend3	string	No	A custom extension field.	xx
CreateTimeStart	integer	No	The start of the creation time range, specified as a Unix timestamp in milliseconds.	111
CreateTimeEnd	integer	No	The end of the creation time range, specified as a Unix timestamp in milliseconds.	111
DocUuids	array	No	The unique IDs of the documents.
	string	No	The unique ID of the document.	xxx
DocIds	array	No	An array of document IDs.
	string	No	The document ID.	xxx
StartTime	integer	No	The start time, specified as a Unix timestamp in milliseconds.	111
EndTime	integer	No	The end time, specified as a Unix timestamp in milliseconds.	1111
Title	string	No	The title.	xxx
NextToken	string	No	A token to retrieve the next page of results. This parameter is required when you retrieve more than 10,000 entries.	xxx

Response elements

Element	Type	Description	Example
	object	The response object.
Data	array<object>	A list of documents.
	array<object>	A document object.
DocUuid	string	The unique internal document ID.	Internal document unique ID
Url	string	The URL of the document.	https://xxx/xx
Content	string	The content of the document.	xx
Summary	string	The summary of the document.	xx
Title	string	The title of the document.	xx
PubTime	string	The publication time of the document.	2022-01-01 00:00:00
SourceFrom	string	The source of the document.	Source
DisableHandleMultimodalMedia	boolean	Indicates whether multimodal indexing is disabled for this document.	false
MultimodalMedias	array<object>	A list of multimodal media items associated with the document.
	object	A multimodal media object.
MediaId	string	The unique ID of the multimodal media.	Multimodal data unique ID
MediaType	string	The type of the multimodal media.	Multimodal data type
FileUrl	string	The URL of the image or video file.	Image or video file URL
DocId	string	The user-specified unique document ID.	xx
DocType	string	The type of the document.	text
Status	integer	The build status of the document index.	100
CategoryUuid	string	The unique ID of the category.	xx
Extend1	string	Extension field 1.	xx
Extend2	string	Extension field 2.	xx
Extend3	string	Extension field 3.	xx
CreateTime	string	The creation time of the document.	2025-04-14 19:59:53
UpdateTime	string	The last update time of the document.	2025-04-14 19:59:53
UpdateUser	string	The user who last updated the document.	1
CreateUser	string	The creator of the document.	1
Tags	array	A list of tags associated with the document.
	string	A tag.	xx
PageNumber	integer	The current page number.	1
PageSize	integer	The number of entries returned per page.	10
TotalCount	integer	The total number of matching documents.	100
RequestId	string	The unique request ID.	1813ceee-7fe5-41b4-87e5-982a4d18cca5
Success	boolean	Indicates whether the request was successful. A value of `true` indicates success, and `false` indicates failure.	true
Code	string	The status code for the request.	NoData
Message	string	A detailed message about the request status.	success
HttpStatusCode	integer	The HTTP status code.	200
NextToken	string	The token used to retrieve the next page of results. This field appears only when more results are available.	xxx

Examples

Success response JSON format

{
  "Data": [
    {
      "DocUuid": "Internal document unique ID",
      "Url": "https://xxx/xx",
      "Content": "xx",
      "Summary": "xx",
      "Title": "xx",
      "PubTime": "2022-01-01 00:00:00",
      "SourceFrom": "Source",
      "DisableHandleMultimodalMedia": false,
      "MultimodalMedias": [
        {
          "MediaId": "Multimodal data unique ID",
          "MediaType": "Multimodal data type",
          "FileUrl": "Image or video file URL"
        }
      ],
      "DocId": "xx",
      "DocType": "text",
      "Status": 100,
      "CategoryUuid": "xx",
      "Extend1": "xx",
      "Extend2": "xx",
      "Extend3": "xx",
      "CreateTime": "2025-04-14 19:59:53",
      "UpdateTime": "2025-04-14 19:59:53",
      "UpdateUser": "1",
      "CreateUser": "1",
      "Tags": [
        "xx"
      ]
    }
  ],
  "PageNumber": 1,
  "PageSize": 10,
  "TotalCount": 100,
  "RequestId": "1813ceee-7fe5-41b4-87e5-982a4d18cca5",
  "Success": true,
  "Code": "NoData",
  "Message": "success",
  "HttpStatusCode": 200,
  "NextToken": "xxx"
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.

​Try it now

​RAM authorization

​Request syntax

​Request parameters

​Response elements

​Examples

​Error codes

​Release notes