接口功能介绍
镜像仓库列表
接口约束
华北2
URI
POST /v4/cwai/central/task-service/image/list-repo
路径参数
无
Query参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| regionID | 是 | String | 区域的唯一ID | 81f7728662dd11ec810800155d307d5b | |
| projectType | 是 | String | 镜像项目类型,有效值为[public(预置),private(自定义)] | private | |
| nameFuzzyQuery | 否 | String | 根据仓库名称模糊查询 | ubuntu18 | |
| pushTimeSortRul | 否 | String | 推送时间排序规则[default(默认),ascend(升序),descend(降序)] | default | |
| pageNo | 是 | Integer | 第几页 | 1 | |
| pageSize | 是 | Integer | 每页展示数量, 不大于20 | 20 |
请求参数
请求头header参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| workspaceID | 是 | String | 工作空间ID | 1810e490-3c45-42a2-8428-08c50797e817 |
请求体body参数
无
响应参数
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| statusCode | Integer | 请求成功(800)或者失败(900) | 800 | |
| errorCode | String | 错误代码 | Cwai.Api.xxxx | |
| message | String | 错误信息的英文描述 | Invalid Request | |
| returnObj | Object | 返回镜像名称的详细信息 | returnObj |
表 returnObj
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| currentCount | Integer | 本次查询返回数据个数 | 10 | |
| totalCount | Integer | 符合条件的数据总数 | 10 | |
| totalPage | Integer | 总页数 | 1 | |
| result | Array of Objects | 返回的数据列表 | result |
表 result
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| regionID | String | 81f7728662dd11ec810800155d307d5b | 区域ID | |
| id | Integer | 镜像仓库ID | 162 | |
| projectID | Integer | 镜像项目ID | 16 | |
| name | String | 镜像仓库名称 | ubuntu18.04.6-torch2.0.1 | |
| pullCount | Integer | 镜像对应制品的拉取次数 | 1 | |
| creationTime | String | 镜像仓库创建时间 | 2024-01-12T06:48:04.082Z | |
| updateTime | String | 镜像仓库更新时间 | 2024-01-12T07:16:41.619Z | |
| projectName | String | 镜像项目名称 | project-test | |
| tagCount | String | 包含tag的个数 | 1 |
枚举参数
无
请求示例
请求url
POST https://cwai-global.ctapi.ctyun.cn/v4/cwai/central/task-service/image/list-repo
Content-Type:application/json
请求头header
workspaceID:1810e490-3c45-42a2-8428-08c50797e817
User-Agent : "Mozilla/5.0 (Macintosh; Intel Mac OS X 10.15; rv:109.0) Gecko/20100101 Firefox/110.0"
请求体body
{
"regionID": "81f7728662dd11ec810800155d307d5b",
"projectType": "public",
"pageNo": 1,
"pageSize": 10
}
响应示例
HTTP/1.1 200 OK
Content-Type:application/json
{
"statusCode": 800,
"message": "成功",
"returnObj": {
"currentCount": 10,
"totalCount": 20,
"totalPage": 2,
"result": [
{
"regionID": "81f7728662dd11ec810800155d307d5b",
"id": 326,
"projectID": 10,
"name": "megatron-deepspeed-llama2pretrain",
"pullCount": 3,
"creationTime": "2024-08-22T10:15:11.138Z",
"updateTime": "2024-08-22T10:30:40.859Z",
"projectName": "admin"
},
{
"regionID": "81f7728662dd11ec810800155d307d5b",
"id": 287,
"projectID": 10,
"name": "arm64/alpine",
"pullCount": 6,
"creationTime": "2024-03-29T08:36:59.371Z",
"updateTime": "2024-07-27T08:24:36.980Z",
"projectName": "admin"
}
]
}
}
状态码
请参考 状态码
错误码
请参考 错误码
