ListDatasets - 数据集-列表

数据集管理-查询

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
aimiaobi:ListDatasetslist
*全部资源
*

请求参数

名称类型必填描述示例值
WorkspaceIdstring

百炼业务空间唯一标识:获取 workspaceId

llm-xxx
StartTimestring

创建时间-开始

创建时间-开始
EndTimestring

创建时间-结束

创建时间-结束
DatasetNamestring

数据集名称,全局唯一

businessDataset
DatasetIdlong

数据集 id

1
PageSizestring

每页条数

10
PageNumberinteger

当前页:默认 1

1
DatasetTypestring

数据集类型

CustomSemanticSearch
SearchDatasetEnableinteger

数据集搜索开关

3

返回参数

名称类型描述示例值
object

响应结果

Dataarray<object>

业务数据

Dataobject

业务数据

DatasetIdlong

数据集 ID

1
CreateUserstring

创建者

xxx
CreateTimestring

创建时间

2024-11-12 21:46:24
DatasetTypestring

数据集类型

CustomSemanticSearch
DatasetNamestring

数据集名称

xxx
DatasetDescriptionstring

数据集显示名称

xxx
SearchDatasetEnableinteger

数据集搜索开关

1
PageNumberinteger

当前页码

1
RequestIdstring

请求唯一标识

1813ceee-7fe5-41b4-87e5-982a4d18cca5
Successboolean

是否成功:true 成功,false 失败

true
Codestring

状态码

NoData
Messagestring

错误说明

success
HttpStatusCodeinteger

http 状态码

200
TotalCountinteger

总条数

100
PageSizeinteger

每页条数

10

示例

正常返回示例

JSON格式

{
  "Data": [
    {
      "DatasetId": 1,
      "CreateUser": "xxx",
      "CreateTime": "2024-11-12 21:46:24",
      "DatasetType": "CustomSemanticSearch",
      "DatasetName": "xxx",
      "DatasetDescription": "xxx",
      "SearchDatasetEnable": 1
    }
  ],
  "PageNumber": 1,
  "RequestId": "1813ceee-7fe5-41b4-87e5-982a4d18cca5",
  "Success": true,
  "Code": "NoData",
  "Message": "success",
  "HttpStatusCode": 200,
  "TotalCount": 100,
  "PageSize": 10
}

错误码

访问错误中心查看更多错误码。