Open API

Api Overview
关于dataset的操作
api
description
​ListAuthStorageConfig​
获取授权配置列表
​ListStorageConfigs​
获取配置列表
​CreateStorageConfigOSS​
创建OSS存储配置
​CreateStorageConfigS3​
创建S3存储配置
​CreateStorageConfigAzure​
创建Azure存储配置
​CreateStorageConfigLocalFs​
创建本地存储配置
​DeleteStorageConfig​
删除配置
​CreateDataset​
创建dataset
​DeleteDataset​
删除数据集
​UpdateDataset​
更新数据集
​ListDataset​
获取dataset列表
​GetDataset​
获取dataset
​CreateBranch​
创建分支
​DeleteBranch​
删除分支
​ListBranches​
获取分支列表
​CreateDraft​
创建draft
​UpdateDraft​
更新draft
​ListDraft​
获取draft列表
​CommitDataset​
提交dataset
​ListCommit​
获取commit列表
​CreateTag​
创建tag
​DeleteTag​
删除tag
​ListTag​
获取tag列表
​UpdateNote​
更新数据集note信息
​GetNote​
获取数据集note信息
​GetUser​
获取用户信息
​ListBenchmarks​
获取benchmark列表
​CreateEvaluation​
创建评估
​ListEvaluations​
获取评估列表
​GetEvaluationResult​
获取评估结果
​CreateOrder​
创建订单
​CreateTask​
创建任务
​DeleteTask​
删除任务
​StopTask​
停止任务
​GetTask​
获取任务
​ListTasks​
获取任务列表
​RetryTask​
重试任务
关于data的操作
api
description
​GetPolicy​
获取数据上传令牌
​PutCallback​
上传回调
​MultiPutCallback​
批量上传回调
​CreateSegment​
创建segment
​DeleteSegment​
删除segment
​ListSegment​
获取segment
​UploadLabelCatalog​
更新label catalog
​GetLabelCatalog​
获取labelcatalog
​UploadSensor​
上传sensor
​DeleteSensor​
删除sensor
​ListSensor​
获取list sensor
​ListData​
获取data
​ListDataDetails​
获取data详情
​ListDataUri​
获取数据的url
​ListMaskUrls​
获取标注url
​GetDataUrls​
根据path获取数据的url
​GetTotalSize​
获取所有文件大小
​ListCloudFiles​
获取云端文件列表
​GetCloudFileUrl​
获取云端文件url
​CloudCallback​
云端回调
​UploadLabel​
更新label
​ListLabel​
获取数据集的标注标签信息
​MultiUploadLabel​
批量更新label
​GetLabelStatistics​
获取label数据
​ConvertLabelFromAli​
从阿里转换数据
​DeleteData​
删除数据
​OperateData​
操作数据
​DeleteFrame​
删除数据帧
​GetDiff​
获取两版本差异
​ListSegmentDiffs​
获取两版本segment差异列表
​GetSegmentDiff​
获取两版本segment差异
​ListDataDiffs​
获取两版本数据差异
Common
公共参数
文档中存在的一些公共参数
名称
描述
值
service
api请求地址前缀
https://gas.graviti.cn/gatewayv2/tensorbay-open-api
your_accesskey
用户申请得到的accesskey, 可进入GAS开发者中心获取
​
HTTP Headers
此模块主要介绍http的公共请求头和响应头的详细说明
公共请求头（Common Request Headers）
名称
类型
描述
Content-Type
string
RFC2616中定义的HTTP请求内容类型。默认值：application/json
X-Token
string
用户申请得到的accesskey
公共响应头（Common Response Headers）
名称
类型
描述
X-Request-Id
string
X-Request-Id是由graviti创建，并唯一标识这个response的UUID。如果在使用graviti服务时遇到问题，可以凭借该内容联系graviti工作人员，快速定位问题。默认值：无
Error code description
错误码返回格式
{
  "code": "error_code",
  "message": "***"
}
当请求发生错误的时候，服务端会返回此类格式的错误信息。 譬如获取数据集时发生404错误。
# 响应状态
HttpStatus 404
# 响应结果
{
    "code": "ResourceNotExist", 
    "message": "dataset not exist!"
}
错误码
code
description
AccessDenied
请求被拒绝，缺失权限...
InvalidParamsValue
无效的请求参数，比如参数格式不对，比如造成不幂等
NameConflict
命名冲突
RequestParamsMissing
必传的某个参数缺失
ResourceNotExist
请求资源时，找不到资源
SystemError
系统错误
模糊查询
对于支持模糊查询的api，遵循以下规则
1.支持mysql通配符查询，如%, _等通配符
2.若无mysql通配符，默认%{模糊查询}%,前后模糊匹配
3.若查询字段中含有mysql通配符，自动模糊匹配失效。
4.若仅希望通配符当作普通字符串，需要进行转义处理，此时退化为非模糊匹配。若仍需要模糊匹配，需手动构造通配符查询。
例： result： graviti_1, great_graviti_1, graviti%1
1.name = graviti, 返回结果graviti_1, great_graviti_1, graviti%1
2.name = graviti\_%, 返回结果graviti_1, great_graviti_1
3.name = graviti\_, 返回结果无
4.name = graviti%, 返回graviti_1，graviti%1
5.name = graviti\%%, 返回graviti%1
6.name = graviti\%, 返回无
7.name = graviti\%1, 返回graviti%1
8.name = %graviti, 返回无
开发者文档 - 以前
开发者工具
下一个
Dataset Operation
最近更新 6mo ago
复制链接
大纲
Api Overview
关于dataset的操作
关于data的操作
Common
公共参数
HTTP Headers
Error code description