ListDatasets

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:ListDatasets	list	All Resource ``	None	None

Action

Access level

Resource type

Condition key

Dependent action

aimiaobi:ListDatasets

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 workspaceId.	llm-xxx
StartTime	string	No	The start of the creation time range.	Creation time - start
EndTime	string	No	The end of the creation time range.	Creation time - end
DatasetName	string	No	The dataset name. The name must be globally unique.	businessDataset
DatasetId	integer	No	The dataset ID.	1
PageSize	string	No	The number of entries per page.	10
PageNumber	integer	No	The page number. Default value: 1.	1
DatasetType	string	No	The dataset type.	CustomSemanticSearch
SearchDatasetEnable	integer	No	Specifies the dataset search setting.	3
IncludeConfig	boolean	No	Specifies whether to return configuration and usage information. Default value: false.
DatasetDescription	string	No	A keyword within the dataset description to filter results.	xx

Response elements

Element	Type	Description	Example
	object	The response object.
Data	array<object>	An array of dataset objects.
	array<object>	A dataset object.
DatasetId	integer	The dataset ID.	1
CreateUser	string	The creator of the dataset.	xxx
CreateTime	string	The creation time.	2024-11-12 21:46:24
DatasetType	string	The dataset type.	CustomSemanticSearch
DatasetName	string	The dataset name.	xxx
DatasetDescription	string	The dataset description.	xxx
SearchDatasetEnable	integer	Indicates whether search is enabled for the dataset.	1
DocUsedQuota	integer	The number of documents uploaded to the dataset.	1
AccessLevel	string	The dataset access level.	private
Administrators	array<object>	The administrators of the dataset.
	object	An administrator object.
Username	string	The administrator username.	xx
UserId	string	The administrator user ID.	xx
PageNumber	integer	The page number.	1
RequestId	string	The unique request ID.	1813ceee-7fe5-41b4-87e5-982a4d18cca5
Success	boolean	Indicates whether the request was successful. Valid values: `true` (success) and `false` (failure).	true
Code	string	The status code.	NoData
Message	string	The response message.	success
HttpStatusCode	integer	The HTTP status code.	200
TotalCount	integer	The total number of datasets.	100
PageSize	integer	The page size.	10
CustomSemanticSearchConfig	object	Configuration and usage details for custom semantic search datasets that use uploaded files as data sources.
DocQuota	integer	The document quota.	1000
DocUsedQuota	integer	The used document quota.	1
DatasetQuota	integer	The dataset quota.	3
DatasetUsedQuota	integer	The number of datasets created.	1
ThirdSearchConfig	object	Configuration and usage details for API-integrated datasets.
DatasetQuota	integer	The dataset quota.	2
DatasetUsedQuota	integer	The number of datasets created.	1

Examples

Success response JSON format

{
  "Data": [
    {
      "DatasetId": 1,
      "CreateUser": "xxx",
      "CreateTime": "2024-11-12 21:46:24",
      "DatasetType": "CustomSemanticSearch",
      "DatasetName": "xxx",
      "DatasetDescription": "xxx",
      "SearchDatasetEnable": 1,
      "DocUsedQuota": 1,
      "AccessLevel": "private",
      "Administrators": [
        {
          "Username": "xx",
          "UserId": "xx"
        }
      ]
    }
  ],
  "PageNumber": 1,
  "RequestId": "1813ceee-7fe5-41b4-87e5-982a4d18cca5",
  "Success": true,
  "Code": "NoData",
  "Message": "success",
  "HttpStatusCode": 200,
  "TotalCount": 100,
  "PageSize": 10,
  "CustomSemanticSearchConfig": {
    "DocQuota": 1000,
    "DocUsedQuota": 1,
    "DatasetQuota": 3,
    "DatasetUsedQuota": 1
  },
  "ThirdSearchConfig": {
    "DatasetQuota": 2,
    "DatasetUsedQuota": 1
  }
}

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