查询数据集列表
接口功能介绍
列举已经创建的所有的数据集信息。
接口约束
无
URI
GET /v4/cwai/dataset/list
Query参数
参数 | 是否必填 | 参数类型 | 说明 | 示例值 | 下级对象 |
---|---|---|---|---|---|
regionID | 是 | String | 资源组所属的region的唯一ID | xxx-xxx-yyyzzz | |
status | 否 | String | 根据数据集状态匹配 | creating | |
sortKey | 否 | String | 进行排序的属性名称 | resourceGroupID | |
sortType | 否 | String | 排序类型 desc降序,asc升序 | desc | |
nameLike | 否 | String | 模糊匹配数据集名称关键字 | demo | |
idLike | 否 | String | 模糊匹配数据集ID关键字 | c8dd | |
pageSize | 否 | String | 页大小 | 10 | |
pageNo | 否 | String | 页号 | 1 |
请求参数
无
响应参数
参数 | 是否必填 | 参数类型 | 说明 | 示例值 | 下级对象 |
---|---|---|---|---|---|
statusCode | 是 | Integer | 请求成功(800)或者失败(900) | 800 | |
errorCode | 否 | String | 错误代码 | Cwai.Api.xxxx | |
message | 否 | String | 错误信息的英文描述 | datasetID is not found | |
returnObj | 否 | Object | 返回资源组信息 | {} | returnObj |
表returnObj
参数 | 是否必填 | 参数类型 | 说明 | 示例值 | 下级对象 |
---|---|---|---|---|---|
totalCount | 是 | Integer | 元素总个数 | 54 | |
totalPage | 是 | Integer | 总页数 | 6 | |
currentCount | 是 | Integer | 当前页元素个数 | 4 | |
result | 是 | Array of Objects | 数据集列表 | result |
表return
参数 | 是否必填 | 参数类型 | 说明 | 示例值 | 下级对象 |
---|---|---|---|---|---|
name | 是 | String | 数据集名称 | dataset-demo | |
id | 是 | String | 数据集唯一ID | d0dc8ddc-xxx-ac110003 | |
vpcID | 是 | String | 资源组所属的vpc的唯一ID | xxx-xxx-yyyzzz | |
regionID | 是 | String | 资源组所属的region的唯一ID | xxx-xxx-yyyzzz | |
resourceGroupID | 是 | String | 数据集资源组唯一ID | d0dc8ddc-xxx-ac110003 | |
dataType | 是 | String | 数据来源的类型 | ZOS,HPFS | |
isAccelerate | 是 | Boolean | 是否进行数据加速 | true | |
sfsUUID | 是 | String | hpfs弹性文件的唯一标识 | xxx-yyy-zzz-kkwowo | |
hpfsID | 是 | String | hpfs弹性文件底层数据的唯一标识 | hpfs-yyy-zzz-kkwowo | |
sfsSize | 是 | String | hpfs弹性文件的大小 | 500G | |
hpfsSharePath | 是 | String | hpfs远程存储数据集的路径 | /var/tmp/xxxx | |
mountPoint | 是 | String | zos创建数据集后的挂载点 | s3://bucket-xxx-fluid/test1/ | |
cached | 是 | String | zos已缓存数据量 | 20Gi | |
cachedPercentage | 是 | String | zos已缓存数据占比 | 100Gi | |
cacheCapacity | 是 | String | zos缓存容量大小 | 500Gi | |
status | 是 | String | 数据集状态信息 | creating | |
createTime | 是 | String | 数据集创建时间 | 2023-01-02 15:04:05 |
请求示例
GET https://cwai-global.ctapi.ctyun.cn/v4/cwai/dataset/list?regionID=xxx-xxx-yyzz
Content-Type:application/json
regionID:81f7728662dd11ec810800155d307d5b
响应示例
正常返回示例
HTTP/1.1 200 OK
Content-Type:application/json
{
"statusCode": 800,
"errorCode": "",
“message": "",
"returnObj": {
"totalCount":52,
"totalPage":6,
"currentCount":2,
"dataset:[
{
"name": "dataset-demo1",
"id" : "ad24879c-xxx-576qwe8f",
"regionID": "81f7728662dd11ec810800155d307d5b",
"resourceGroupID": "d0dc8ddc-xxx-ac110003",
"vpcID": "xxx-xxx-yyyzzz",
"dataType": "ZOS",
"isAccelerate": true,
"mountPoint" : "s3://bucket-xxx-fluid/test1/",
"cachedPercentage":"20Gi",
"cachedPercentage":"100Gi",
"cacheCapacity":"500Gi",
"status":"Bound",
"createTime": "2023-01-02 15:04:05",
},
{
"name": "dataset-demo2",
"id" : "62dd11e2-xxx-080015d3",
"regionID": "81f7728662dd11ec810800155d307d5b",
"resourceGroupID": "d0dc8ddc-xxx-ac110003",
"vpcID": "xxx-xxx-yyyzzz",
"dataType": "HPFS",
"isAccelerate": false,
"sfsUUID":"1548qwe67657f56719ded44356",
"hpfsID":"hs2-34nj9341-tgeg87",
"sfsSize":"200G",
"hpfsSharePath":"/demo-test2",
"status":"Bound",
"createTime": "2023-01-03 12:05:44",
}
]
}
}
错误参数返回示例
HTTP/1.1 200 OK
Content-Type:application/json
{
"statusCode": 900,
"errorCode": "Cwai.Api.BadRequest",
"message": "***",
}
内部服务错误返回示例
TTP/1.1 200 OK
Content-Type:application/json
{
"statusCode": 900,
"errorCode": "Cwai.Api.InternalServerError",
"message": "***",
}
状态码
状态码 | 描述 |
---|---|
200 | 表示请求成功 |
错误码
错误码 | 描述 |
---|---|
Cwai.Api.BadRequest | 错误请求 |
Cwai.Api.NotFound | 资源不存在 |
Cwai.Api.StatusUnauthorized | 状态未授权 |
Cwai.Api.InternalServerError | 内部错误 |