文档首页/ 企业主机安全 HSS/ API参考/ API说明/ 容器安装与配置/ 获取镜像同步任务关联的镜像仓的信息 - ListAssociateRegistries
更新时间:2025-10-31 GMT+08:00
分享

获取镜像同步任务关联的镜像仓的信息 - ListAssociateRegistries

功能介绍

获取镜像同步任务关联的镜像仓的信息

授权信息

账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限。

  • 如果使用角色与策略授权,具体权限要求请参见权限和授权项
  • 如果使用身份策略授权,当前API调用无需身份策略权限。

URI

GET /v5/{project_id}/image/image-sync/tasks/{task_id}/registries

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

参数解释:

项目ID,用于明确项目归属,配置后可通过该ID查询项目下资产。获取方式请参见获取项目ID

约束限制:

不涉及

取值范围:

字符长度1-256位

默认取值:

不涉及

task_id

String

参数解释

任务ID

约束限制

不涉及

取值范围

字符长度1-64位

默认取值

不涉及

表2 Query参数

参数

是否必选

参数类型

描述

enterprise_project_id

String

参数解释:

企业项目ID,用于过滤不同企业项目下的资产。获取方式请参见获取企业项目ID

如需查询所有企业项目下的资产请传参“all_granted_eps”。

约束限制:

开通企业项目功能后才需要配置企业项目ID参数。

取值范围:

字符长度1-256位

默认取值:

0,表示默认企业项目(default)。

registry_name

String

参数解释:

仓库名称

取值范围:

字符长度1-128位

registry_type

String

参数解释:

镜像仓类型,不传默认返回所有类型。如果要查询多个类型,可以使用逗号分隔。

取值范围:

  • Harbor harbor

  • Jfrog jfrog

  • SwrPrivate swr私有

  • SwrShared swr共享

  • SwrEnterprise swr企业

  • Other 其他仓库

offset

Integer

参数解释:

偏移量:指定返回记录的开始位置

约束限制:

不涉及

取值范围:

最小值0,最大值2000000

默认取值:

默认为0

limit

Integer

参数解释:

每页显示个数

约束限制:

不涉及

取值范围:

取值10-200

默认取值:

10

sync_status

String

参数解释

同步状态

约束限制

不涉及

取值范围

  • finished :同步完成。

  • running :正在同步。

  • failed :同步失败。

默认取值

不涉及

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

参数解释:

用户Token,包含了用户的身份、权限等信息,在调用API接口时,可通过Token进行身份认证。获取方式请参见获取用户Token

约束限制:

不涉及

取值范围:

字符长度1-32768位

默认取值:

不涉及

响应参数

状态码:200

表4 响应Body参数

参数

参数类型

描述

data_list

Array of AssociateRegistriesResponseInfo objects

镜像仓列表

total_num

Integer

同步任务关联的镜像仓总数

表5 AssociateRegistriesResponseInfo

参数

参数类型

描述

registry_id

String

镜像仓库ID

registry_name

String

镜像仓库名称

registry_type

String

参数解释:

镜像仓库类型

取值范围:

  • SwrPrivate:swr私有。

  • SwrShared:swr共享。

  • SwrEnterprise:swr企业。

  • Harbor:harbor仓库。

  • Jfrog:jfrog仓库。

  • Other:其他仓库。

sync_status

String

同步状态,包含如下3种。

  • finished :同步完成。

  • running :正在同步。

  • failed :同步失败。

failed_reason

String

失败原因

请求示例

响应示例

状态码:200

请求已成功

{
  "total_num" : 1,
  "data_list" : [ {
    "registry_id" : "mock-registry-id-swr-private",
    "registry_name" : "Swr-private",
    "registry_type" : "SwrPrivate",
    "sync_status" : "finished"
  } ]
}

状态码

状态码

描述

200

请求已成功

错误码

请参见错误码

相关文档