本接口用于获取符合特定查询条件的数据集列表。

权限说明

调用本文API，需符合以下权限要求，权限介绍及分配，请查看角色与权限控制列表、账号创建与权限分配。需具有以下任一权限：

• 完全控制千帆大模型平台的权限：QianfanFullControlAccessPolicy
• 只读访问千帆大模型平台的权限：QianfanReadAccessPolicy
• 完全控制千帆大模型平台数据管理（除数据标注外）的权限：QianfanDataFullControlAccessPolicy
• 运维操作千帆大模型平台数据管理（除数据标注外）的权限：QianfanDataOperateAccessPolicy
• 只读访问千帆大模型平台数据管理（除数据标注外）的权限：QianfanDataReadAccessPolicy

鉴权说明

调用本文API，使用“基于安全认证AK/SK”进行签名计算鉴权，即使用安全认证中的Access Key ID 和 Secret Access Key进行鉴权，具体鉴权认证机制参考HTTP调用鉴权说明。

请求参数

POST /v2/dataset?Action=DescribeDatasets HTTP/1.1
HOST: qianfan.baidubce.com
Authorization: authorization string
Content-Type: application/json
{
    "marker": "",
    "maxKeys": 10,
    "pageReverse": true,
    "filter": {
        "dataFormatList": ["PromptResponse", "PromptImage"]
    }
}

示例代码

curl -i --location 'https://qianfan.baidubce.com/v2/dataset?Action=DescribeDatasets'\
--header 'Authorization: bce-auth-v1/f0ee7axxxx/2023-09-19T13:42:13Z/180000/host;x-bce-date/9a8cfb8ee58a8f44a21a5xxxx74525543'\
--header 'x-bce-date: 2023-09-19T13:37:10Z'\
--header 'Content-Type: application/json'\
--data '{
    "marker": "",
    "maxKeys": 10,
    "pageReverse": true,
    "filter": {
        "dataFormatList": ["PromptResponse", "PromptImage"]
    }
}'

返回响应

{
	"requestId": "b4f5f3f2-307e-41d6-5afc-a6708cfa286b",
	"result": {
		"pageInfo": {
			"marker": "",
			"maxKeys": 2,
			"isTruncated": false,
			"nextMarker": "dg-xxx", // 下次查询请求的marker参数
            "pageReverse": false
		},
		"datasets": [
            {
				"datasetId": "dg-xxx",
				"datasetName": "helloDatasetList1",
				"dataFormat": "PromptResponse"
			},
			{
				"datasetId": "dg-xxx",
				"datasetName": "helloDatasetList2",
				"dataFormat": "PromptImage"
			}
		]
	}
}

错误码

若请求错误，服务器将返回的JSON文本包含以下参数：

例如错误返回：

{
    "requestId":"6ba7b810-xxxc04fd430c8",
    "code":"AccessDenied",
    "message":"Access denied."
}

更多其他错误码，也可以查看错误码说明。