获取镜像自动同步任务信息
功能介绍
创建镜像自动同步任务后,可以通过此接口查询该任务的状态,以判断是否同步成功。
接口约束
无
调用方法
请参见如何调用API。
URI
GET /v2/manage/namespaces/{namespace}/repos/{repository}/sync_job
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
namespace |
是 |
String |
组织名称。小写字母开头,后面跟小写字母、数字、小数点、下划线或中划线(其中下划线最多允许连续两个,小数点、下划线、中划线不能直接相连),小写字母或数字结尾,1-64个字符。 |
repository |
是 |
String |
镜像仓库名称 |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
filter |
是 |
String |
应填写 limit::{limit}|offset::{offset}|order::{order} ,其中{limit}为返回条数,{offset}为起始索引,注意:offset和limit参数需要配套使用,且必选。{order}为排序类型(可选),可设置为desc(降序)、asc(升序) |
请求参数
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
Content-Type |
是 |
String |
消息体的类型(格式),下方类型可任选其一使用: application/json;charset=utf-8 application/json 缺省值:application/json |
X-Auth-Token |
是 |
String |
用户Token。 通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。 |
响应参数
状态码: 200
参数 |
参数类型 |
描述 |
---|---|---|
Content-Range |
String |
offset(开始索引)-count(当前页记录条数)/total(总记录条数) |
参数 |
参数类型 |
描述 |
---|---|---|
[数组元素] |
Array of SyncJob objects |
查询成功 |
参数 |
参数类型 |
描述 |
---|---|---|
createdAt |
String |
创建时间,UTC日期格式,时间为UTC标准时间,用户需要根据本地时间计算偏移量;如东8区需要+8:00 |
domainID |
String |
租户ID |
domainName |
String |
租户名 |
id |
Integer |
ID |
namespace |
String |
组织名 |
override |
Boolean |
是否覆盖 |
remoteNamespace |
String |
目的组织 |
remoteRegionId |
String |
目的region |
repoName |
String |
仓库名 |
status |
String |
同步状态,waiting、running、success、failed、timeout、cancel、existed |
syncOperatorId |
String |
操作用户ID |
syncOperatorName |
String |
操作用户名 |
tag |
String |
镜像版本 |
updatedAt |
String |
updatedAt |
请求示例
GET https://{endpoint}/v2/manage/namespaces/{namespace}/repos/{repository}/sync_job
响应示例
状态码: 200
查询成功
[ { "createdAt" : "2020-03-12T08:11:36.518144Z", "domainID" : "0657**************************f60", "domainName" : "h**********4", "id" : 1, "namespace" : "test", "override" : false, "remoteNamespace" : "remtens", "remoteRegionId" : "cn-north-1", "repoName" : "testrepo", "status" : "success", "syncOperatorId" : "065***********************10", "syncOperatorName" : "h**********4", "tag" : "8", "updatedAt" : "2020-03-12T08:11:41.505499Z" } ]
状态码
状态码 |
描述 |
---|---|
200 |
查询成功 |
400 |
错误的请求 |
401 |
鉴权失败 |
404 |
组织或镜像仓库或任务不存在 |
500 |
内部错误 |
错误码
请参见错误码。