菜单

典枢连接器客户端部署

您可以使用命令行来部署典枢连接器客户端,并完成数据发布、下载等操作。

连接器下载

  1. 下载连接器客户端镜像
language 复制代码
docker pull yeeztechofficial/ydc-client:v2.12.2
  1. 启动容器
language 复制代码
docker run -dit --name ydc_client -v /PATH/TO/data/:/data yeeztechofficial/ydc-client:v2.12.2 bash

其中,“/PATH/TO/data/” 为宿主机的文件路径,待上传和下载的数据可通过该路径访问到。

  1. 进入容器
language 复制代码
docker exec -it ${CONTAINER_ID} bash

其中,${CONTAINER_ID} 为容器ID。

数据发布(数据卖家)

  1. 获取数据描述文件
    发布数据时,依赖数据描述文件,因此先获取数据描述文件。数据描述文件为JSON文件,描述了数据的元信息(如数据价格、标签、数据名称等)。
    获取数据描述文件方式如下:
language 复制代码
ydc-client get-desc-template --output desc.json

其中,desc.json 为数据描述文件模板,各字段含义如下:

字段
类型
说明
值获取方式
datasetName String 数据集名称 自动获取
price BigDecimal 价格 默认为 1
pattern String 数据格式 zip、mp4 等 自动获取
datasetSize Long 数据集大小(单位 byte) 自动获取
tag String 数据集标签 默认为空字符串
imageList List 数据集图片列表,详细字段见示例 默认包含一张图片
description String 数据集描述,富文本内容 默认内容 “dataset description”
descriptionTxt String 数据集描述,纯文本内容 默认内容 “dataset description”
estimateAlgorithmList List 验证报告算法列表 默认为空数组
metaJson String metaJson,详细字段见示例 自动获取
auditParam String 审核参数,详细字段见示例 自动获取
auditType Integer 数据集购买后是否需要审核:
  • 0 :无需审核
  • 1 :需审核
默认为 0
serverType Integer 上传服务器类型:
  • 0 :平台服务器
  • 1 :自定义服务器
默认为 1
serverUrl String 若是自定义服务器,传自定义服务器 URL 自动获取
  1. 发布数据
language 复制代码
ydc-client upload-data --ydc-server-url ${YDC_SERVER_URL} --data-file-path ${DATA_PATH} --desc-template-path desc.json --port ${PORT}

其中,

  • ${YDC_SERVER_URL}为典枢连接器服务端的URL,例如:http://10.10.10.10
  • ${DATA_PATH} 为待发布的数据的路径,该路径必须在 /data 路径下,例如:/data/data.txt
  • desc.json 为发布数据步骤1中的数据描述文件
  • ${PORT}(可选参数)是上传服务的端口号,默认(即不写该参数)情况下为6088

说明

用户首次发布数据时,需输入验证其身份的用户Token,可根据命令行的提示,在网页端进行登录获取该Token。

提示如下:

language 复制代码
File /root/.dianshu.data/access.token not exists!
Please refer to the link to login first:
##################################################
https://sso.dianshudata.com/login/oauth/authorize?client_id=fcdfeb6531b13151851f&response_type=code&redirect_uri=https%3A%2F%2Fdianshudata.com%2FcliCallback&scope=read&state=4kz6ijm16m
##################################################
After login, enter the code:

此外,发布数据时会提示需输入用户的授权码,该授权码在用户用户注册时设置。提示如下:

language 复制代码
########## API call_main_service_api_get_user_info succ!
Enter your password:

数据下载(数据买家)

language 复制代码
ydc-client download-data --ydc-server-url ${YDC_SERVER_URL} --order-code ${ORDER_CODE} --download-dir ${DOWLOAD_DIR} --port ${PORT}

其中,

  • ${YDC_SERVER_URL} 为典枢连接器服务端的URL,例如:http://10.10.10.10
  • ${ORDER_CODE} 为典枢购买数据后的订单编号,您可以在登录典枢,单击页面右上角的用户名称,在数据买家 > 我的订单中查看订单编号。例如:P17453900275240283
  • ${DOWNLOAD_DIR} 为待下载的数据的路径,该路径必须在 /data 路径下,例如:/data/download/
  • ${PORT} (可选参数)是下载服务的端口号,默认(即不写该参数)情况下为1090
最近修改: 2025-04-28