接口功能介绍
查询镜像仓库列表
接口约束
无
URI
GET /v1/listRepository
路径参数
无
Query参数
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
instanceId | 是 | Long | 实例ID | 1638470585571688449 | |
namespaceName | 否 | String | 命名空间名称 | myns | |
repositoryName | 否 | String | 镜像仓库名称,支持模糊查询 | myrepo | |
regionId | 否 | String | 资源池编码 | d8bbd132b53a11e9b0e40242ac110002 | |
pageNum | 否 | Integer | 页码 | 1 | |
pageSize | 否 | Integer | 每页大小 | 10 | |
orderBy | 否 | String | 排序字段(namespaceName:命名空间名称, createdTime:创建时间,modifiedTime:修改时间,repositoryName:仓库名称) | createdTime | |
order | 否 | String | 排序方式(desc:降序排序, asc:升序排序) | desc |
请求参数
请求头header参数
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
Content-Type | 是 | String | 类型 | application/json | |
regionId | 是 | String | 资源池编码 | bb9fdb42056f11eda1610242ac110002 |
请求体body参数
无
响应参数
参数 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|
statusCode | Integer | 响应码 | 0 | |
message | String | 返回信息 | ||
returnObj | Object | 返回结果 | returnObj | |
error | String | 错误信息 |
表 returnObj
参数 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|
total | Integer | 总条数 | 5 | |
size | Integer | 每页条数 | 10 | |
current | Integer | 当前页码 | 1 | |
pages | Integer | 总页数 | 1 | |
records | Object | 镜像仓库列表 | records |
表 records
参数 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|
repositoyId | Long | 镜像仓库ID | 1639675218884841473 | |
namespaceName | String | 命名空间名称 | crs-ns1 | |
repositoryName | String | 镜像仓库名称 | myrepo | |
isPublic | Boolean | 镜像仓库是否为公开 | true | |
accelerate | Boolean | 是否开启镜像加速 (企业版) | false | |
regionId | String | 资源池编码 | d8bbd132b53a11e9b0e40242ac110002 | |
description | String | 镜像仓库说明 | desc | |
createdTime | String | 镜像仓库创建时间 | 2023-03-22 17:20:04 | |
modifiedTime | String | 镜像仓库修改时间 | 2023-03-22 17:20:04 |
枚举参数
无
请求示例
请求url
GET https://[endpoint].ctapi.ctyun.cn/v1/listRepository?instanceId=1639201844988657665&pageNum=1&pageSize=10
请求头header
{"Content-Type": "application/json"}
请求体body
无
响应示例
{
"statusCode": 0,
"message": "",
"returnObj": {
"records": [
{
"repositoryId": 1625409232309383200,
"repositoryName": "myrepo",
"instanceId": "1638470585571688449",
"namespaceName": "crs-ns4",
"isPublic": true,
"accelerate": false,
"regionId": "d8bbd132b53a11e9b0e40242ac110002",
"description": "test",
"createdTime": "2023-02-14 16:18:54",
"modifiedTime": "2023-02-14 16:18:54"
}
],
"total": "1",
"size": "10",
"current": "1",
"orders": [],
"optimizeCountSql": true,
"hitCount": false,
"countId": null,
"maxLimit": null,
"searchCount": true,
"pages": "1"
}
}
状态码
请参考 状态码
错误码
请参考 错误码