获取数据集详情

开发环境

http://dev-cn.your-api-server.com

POST

https://qianfan.baidubce.com/wenxinworkshop/dataset/info

功能介绍

本接口用于查看某数据集详情，如数据集名称、数据类型、版本信息等。

注意事项

调用本文API，使用“安全认证/Access Key ”中的Access Key ID 和 Secret Access Key等进行鉴权，无法使用获取Access Token的方式鉴权，具体鉴权认证机制参考鉴权认证机制。

错误码

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

名称	描述
error_code	错误码
error_msg	错误描述信息，帮助理解和解决发生的错误

例如参数错误返回：

{
  "error_code": 500001,
  "error_msg": "param invalid"
}

数据管理相关错误码，请查看错误码说明。

请求示例

Shell

JavaScript

Java

Swift

curl --location --request POST 'https://qianfan.baidubce.com/wenxinworkshop/dataset/info?access_token	=' \
--header 'Content-Type;' \
--header 'x-bce-date;' \
--header 'Authorization;' \
--header 'Content-Type: application/json' \
--data-raw '{
   "datasetId": 17786
}'

响应示例

{
    "log_id": "string",
    "result": {
        "groupId": 0,
        "name": "string",
        "dataType": 0,
        "versionInfo": {
            "groupId": 0,
            "datasetId": 0,
            "importRecordCount": 0,
            "exportRecordCount": 0,
            "bmlDatasetId": "string",
            "userId": 0,
            "versionId": 0,
            "displayName": "string",
            "importStatus": 0,
            "importProgress": 0,
            "exportStatus": 0,
            "exportProgress": 0,
            "dataType": 0,
            "projectType": 0,
            "templateType": 0,
            "errCode": null,
            "uniqueType": 0,
            "importErrorInfo": null,
            "createTime": "string",
            "modifyTime": "string",
            "storageType": "string",
            "storage": {
                "storageId": "string",
                "storageName": "string",
                "storagePath": "string",
                "rawStoragePath": "string",
                "region": "string"
            },
            "releaseStatus": 0,
            "releaseErrCode": 0,
            "releaseStoragePath": "string",
            "releaseProgress": 0,
            "remark": "string",
            "annotatedEntityCount": 0,
            "entityCount": 0,
            "labelCount": 0,
            "memorySize": 0,
            "characterCount": 0,
            "isEnhancing": true,
            "enhanceStatus": 0,
            "hasEnhance": true,
            "isSelfInstructEnhance": true,
            "interAnnoRunning": true,
            "hardSampleCount": 0,
            "etlStatus": 0,
            "hasEtl": true,
            "isPipelineEtl": true,
            "teamAnnoStatus": 0,
            "hasTeamAnno": true,
            "promptOptimizeStatus": 0,
            "demandStatus": "string",
            "view": 0,
            "usage": 0,
            "description": "string",
            "tag": [
                {
                    "name": "string"
                }
            ],
            "license": "string",
            "copyright": "string",
            "copyrightLink": "string"
        }
    },
    "status": 0,
    "success": true
}

请求参数

Query 参数

access_token

string

必需

通过API Key和Secret Key获取的access_token，参考Access Token获取

Header 参数

Content-Type

string

必需

固定值：application/json

x-bce-date

string

必需

当前时间，遵循ISO8601规范，格式如2016-04-06T08:23:49Z

Authorization

string

必需

用于验证请求合法性的认证信息，更多内容请参考鉴权认证机制，签名工具可参考IAM签名工具

Body 参数application/json

datasetId

integer

必需

查询的数据集版本的ID，示例：17786，可以通过以下任一方式获取该字段值： · 方式一，通过调用创建数据集接口，返回的id字段获取 · 方式二，在千帆控制台-数据集管理列表页面查看，如下图所示：

示例

返回响应

🟢200成功

application/json

Body

log_id

string

操作记录id

必需

result

object

返回结果

必需

groupId

integer

数据集ID

必需

name

string

数据集名称

必需

dataType

integer

数据类型

必需

versionInfo

object

版本信息

必需

status

integer

状态码

必需

success

boolean

是否操作成功

必需

修改于 2023-11-16 08:37:38

发起数据集导入任务

获取数据集状态详情

获取数据集详情

功能介绍#

注意事项#

错误码#

请求参数

返回响应

功能介绍

注意事项

错误码