获取镜像自动同步任务信息 - ShowSyncJob
功能介绍
创建镜像自动同步任务后,可以通过此接口查询该任务的状态,以判断是否同步成功。
接口约束
无
调用方法
请参见如何调用API。
授权信息
账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限。
- 如果使用角色与策略授权,具体权限要求请参见权限和授权项。
- 如果使用身份策略授权,当前API调用无需身份策略权限。
URI
GET /v2/manage/namespaces/{namespace}/repos/{repository}/sync_job
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| namespace | 是 | String | 参数解释: 组织名称。用于唯一标识一个组织,组织下的所有镜像仓库都属于该组织。 约束限制: 不涉及。 取值范围: 小写字母开头,后面跟小写字母、数字、小数点、下划线或中划线(其中下划线最多允许连续两个,不同类型分隔符不能直接相连),小写字母或数字结尾,长度1~64个字符。 默认取值: 不涉及。 |
| repository | 是 | String | 参数解释: 镜像仓库名称过滤关键字,用于模糊匹配镜像仓库列表。与精确匹配的name参数不同,filter支持模糊查询。 约束限制: 不涉及。 取值范围: 小写字母或数字开头,后面跟小写字母、数字、小数点、斜杠、下划线或中划线(其中下划线最多允许连续两个,不同类型分隔符不能直接相连),小写字母或数字结尾,长度1~128个字符。 默认取值: 不涉及。 |
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| filter | 是 | String | 参数解释: 查询过滤条件。用于分页查询同步任务记录,指定返回条数、起始索引和排序方式。 约束限制: filter参数为必选项,其中limit和offset组件需配套使用,order组件可选。 取值范围: 格式为limit::{limit}|offset::{offset}|order::{order},其中{limit}为返回条数,{offset}为起始索引,{order}为排序类型(可选),可设置为desc(降序)、asc(升序)。 默认取值: 不涉及。 |
请求参数
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| Content-Type | 是 | String | 参数解释: 消息体的类型(格式),用于指定请求体的MIME类型。 约束限制: 不涉及。 取值范围: 默认取值: 不涉及。 |
| X-Auth-Token | 是 | String | 参数解释: 用户Token。用于调用API时的鉴权。 通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
响应参数
状态码:200
| 参数 | 参数类型 | 描述 |
|---|---|---|
| Content-Range | String | 参数解释: 响应头的分页范围信息,用于告知客户端当前返回记录的起止位置和总记录数。 约束限制: 不涉及。 取值范围: 格式为offset(开始索引)-count(当前页记录条数)/total(总记录条数),由数字、小数点、中划线、斜杠组成,长度1~64个字符。 默认取值: 不涉及。 |
| 参数 | 参数类型 | 描述 |
|---|---|---|
| [数组元素] | Array of SyncJob objects |
| 参数 | 参数类型 | 描述 |
|---|---|---|
| createdAt | String | 参数解释: 创建时间,UTC日期格式,时间为UTC标准时间,用户需要根据本地时间计算偏移量;如东8区需要+8:00。格式为yyyy-MM-ddTHH:mm:ssZ,例如:2020-03-12T08:11:36.518144Z。 取值范围: 不涉及。 |
| domainID | String | 参数解释: 租户ID,即华为云账号的唯一标识ID,用于标识镜像同步任务所属的租户。 取值范围: 由字母、数字组成,长度1~65个字符。 |
| domainName | String | 参数解释: 租户名。 取值范围: 由中文字符、英文字母、数字及「_」、「-」、「.」组成,长度1~255个字符。 |
| id | Integer | 参数解释: 同步任务ID,用于唯一标识一个镜像自动同步任务。 取值范围: 同步任务ID。 |
| namespace | String | 参数解释: 组织名。 取值范围: 小写字母开头,后面跟小写字母、数字、小数点、下划线或中划线(其中下划线最多允许连续两个,不同类型分隔符不能直接相连),小写字母或数字结尾,长度1~64个字符。 |
| override | Boolean | 参数解释: 是否覆盖。 取值范围: |
| remoteNamespace | String | 参数解释: 目的组织。 取值范围: 小写字母开头,后面跟小写字母、数字、小数点、下划线或中划线(其中下划线最多允许连续两个,不同类型分隔符不能直接相连),小写字母或数字结尾,长度1~64个字符。 |
| remoteRegionId | String | 参数解释: 目的区域ID,即镜像同步到的目标区域的唯一标识,如 cn-north-1。 取值范围: 由小写字母、数字和中划线组成,长度1~64个字符。 |
| repoName | String | 参数解释: 仓库名。 取值范围: 小写字母或数字开头,后面跟小写字母、数字、小数点、斜杠、下划线或中划线(其中下划线最多允许连续两个,不同类型分隔符不能直接相连),小写字母或数字结尾,长度1~128个字符。 |
| status | String | 参数解释: 同步任务的状态,详见取值范围。 取值范围: |
| syncOperatorId | String | 参数解释: 操作用户ID,即触发同步任务的IAM用户的唯一标识ID。 取值范围: 由字母、数字组成,长度1~65个字符。 |
| syncOperatorName | String | 参数解释: 操作用户名。 取值范围: 由中文字符、英文字母、数字及部分特殊字符组成,长度1~256个字符。 |
| tag | String | 参数解释: 镜像版本。 取值范围: 以字母或数字开头,后面跟字母、数字、小数点、下划线或中划线,长度1~128个字符。 |
| updatedAt | String | 参数解释: 更新时间,即同步任务最近一次更新的时间,UTC日期格式yyyy-MM-ddTHH:mm:ssZ,时间为UTC标准时间,用户需要根据本地时间计算偏移量;如东8区需要+8:00。 取值范围: 不涉及。 |
请求示例
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 | 内部错误 |
错误码
请参见错误码。