接口功能介绍
镜像列表
接口约束
华北2
URI
POST /v4/cwai/central/task-service/image/list-image
路径参数
无
Query参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| regionID | 是 | String | 区域的唯一ID | 81f7728662dd11ec810800155d307d5b | |
| projectName | 是 | String | 镜像所属的项目名称 | project-test | |
| repoName | 是 | String | 镜像所属仓库名称 | ubuntu18.04.6-torch2.0.1 | |
| nameFuzzyQuery | 否 | String | 根据Tag名称模糊查询 | ubuntu18 | |
| pushTimeSortRule | 否 | 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 | 镜像TagID | 246 | |
| repositoryID | Integer | 镜像仓库ID | 162 | |
| artifactID | Integer | 镜像制品ID | 363 | |
| tagName | String | 镜像Tag名称 | v1 | |
| pushTime | String | 镜像Tag推送时间 | 2024-01-12T06:48:04.117Z | |
| mediaType | String | 镜像mediaType | application/vnd.docker.container.image.v1+json | |
| manifestMediaType | String | 镜像manifestMediaType | application/vnd.docker.distribution.manifest.v2+json | |
| digest | String | 镜像digest | sha256:40436c3f1d6b311f56a27692cdcf808ebabf9af86787213aaff61b439c48fe03 | |
| artifactPushTime | String | 镜像制品推送时间 | 2024-01-12T06:20:54.336Z | |
| size | Integer | 镜像大小, 单位byte | 21240352060 | |
| imageName | String | 镜像使用全称 | cwai.ctyun.cn:15000/project-cwpublic/ubuntu18.04.6-torch2.0.1:v1 | |
| repoName | String | 镜像仓库名称 | ubuntu18.04.6-torch2.0.1 | |
| projectName | String | 镜像项目名称 | project-cwpublic |
枚举参数
无
请求示例
请求url
POST https://cwai-global.ctapi.ctyun.cn/v4/cwai/central/task-service/image/list-image
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",
"projectName": "admin",
"repoName": "chinese-llama2-7b",
"pushTimeSortRule": "descend",
"nameFuzzyQuery": "",
"pageNo": 1,
"pageSize": 10
}
响应示例
HTTP/1.1 200 OK
Content-Type:application/json
{
"statusCode": 800,
"message": "成功",
"returnObj": {
"currentCount": 2,
"totalCount": 2,
"totalPage": 1,
"result": [
{
"regionID": "",
"id": 458,
"repositoryID": 202,
"artifactID": 1415,
"tagName": "v2",
"pushTime": "2023-12-09T05:20:53.669Z",
"mediaType": "application/vnd.docker.container.image.v1+json",
"manifestMediaType": "application/vnd.docker.distribution.manifest.v2+json",
"digest": "sha256:1d1e8214d081db5b2281b26c504f79c73aa98574aaaa559ccfa42da231b992f6",
"size": 31913028090,
"artifactPushTime": "2023-12-09T05:20:53.659Z",
"imageName": "cbi.ccr.ctyun.cn:5000/admin/chinese-llama2-7b:v2",
"repoName": "chinese-llama2-7b",
"projectName": "admin"
},
{
"regionID": "",
"id": 392,
"repositoryID": 202,
"artifactID": 1289,
"tagName": "v1",
"pushTime": "2023-11-30T08:59:40.047Z",
"mediaType": "application/vnd.docker.container.image.v1+json",
"manifestMediaType": "application/vnd.docker.distribution.manifest.v2+json",
"digest": "sha256:1b76dda0b952b8deca1457f7c795420720c63ce495ee1b4d8933d3a25da6b841",
"size": 31913041183,
"artifactPushTime": "2023-11-30T08:59:40.036Z",
"imageName": "cbi.ccr.ctyun.cn:5000/admin/chinese-llama2-7b:v1",
"repoName": "chinese-llama2-7b",
"projectName": "admin"
}
]
}
}
状态码
请参考 状态码
错误码
请参考 错误码
