文档内容

Instance

参数名称	类型	描述
id	String	实例 ID
name	String	实例名称
instanceType	String	实例类型。 BASIC：基础版；STANDARD：标准版；ADVANCED：高级版
publicURL	String	公网访问地址
privateURL	String	内网访问地址
customDomains	List<String>	自定义域名信息
region	String	地域
status	String	实例状态
createTime	String	创建时间
expireTime	String	到期时间
tags	LogicalTag	标签键值对信息

InstanceStatistic

参数名称	类型	描述
repo	Integer	镜像仓库个数
chart	Integer	Chart 个数
namespace	Integer	命名空间个数
vpc	Integer	已关联私有网络个数
storage	Integer	BOS 存储空间大小，单位：字节

InstanceQuota

参数名称	类型	描述
repo	Integer	镜像仓库个数限额
chart	Integer	Chart 个数限额
namespace	Integer	命名空间个数限额
vpc	Integer	可关联私有网络个数限额

Project

参数名称	类型	描述
autoScan	String	推送时是否自动扫描镜像，有效值为 true、false
chartCount	int	命名空间下的 Chart 数量
creationTime	String	命名空间创建时间，格式为 date-time
projectId	int	命名空间 ID
projectName	String	命名空间名称
public	String	命名空间类型，有两种类型：true 表示公有，false 表示私有
repoCount	int	命名空间下镜像仓库数量
updateTime	String	命名空间更新时间，格式为 date-time

Repository

参数名称	类型	描述
projectName	String	命名空间名称
repositoryName	String	镜像仓库名称
description	String	镜像仓库描述
repositoryPath	String	公网访问镜像路径
privateRepositoryPath	String	VPC 内访问镜像路径
tagCount	Integer	镜像的 Tag 个数
pullCount	Integer	镜像拉取次数
creationTime	String	创建时间
updateTime	String	更新时间

Tag

参数名称	类型	描述
architecture	String	镜像仓库（repository）架构
author	String	发布者
digest	String	制品 Hash 值
os	String	操作系统类型
projectId	Integer	制品所属命名空间 ID
pullTime	String	Tag 最新拉取时间，格式为 date-time
pushTime	String	Tag 推送时间，格式为 date-time
repositoryId	Integer	制品所属镜像仓库 ID
scanOverview	Tag.ScanOverview	漏洞扫描信息
size	Integer	制品大小
tagName	String	Tag 名称
type	String	制品类别，可选值：image、chart

### Tag.ScanOverview

参数名称	类型	描述
endTime	String	漏洞扫描完成时间，格式为 date-time
fixable	Integer	可修复漏洞数量
reportId	String	本机扫描报告的 ID
scanStatus	String	报告生成状态
severity	String	漏洞等级：Critical 危及、High 严重、Medium 中等、Low 较低
startTime	String	漏洞扫描开始时间，格式为 date-time
summary	object	不同严重程度的漏洞数量
total	Integer	发现的漏洞总数

BuildHistory

参数名称	类型	描述
comment	String	备注
created	String	创建时间
createdBy	String	命令
emptyLayer	Boolean	镜像层是否为空，true 或 false

Artifact.ScanOverview

参数名称	类型	描述
description	String	缺陷简介
fixVersion	String	修复版本
id	String	缺陷码
links	List<String>	缺陷详情页面链接
package	String	组件
severity	String	严重程度
version	String	当前版本

TriggerPolicy

参数名称	类型	描述
creationTime	String	触发器创建时间
description	String	触发器策略备注
enabled	Boolean	启动状态
eventTypes	List<String>	触发事件类型列表。触发事件类型定义： UPLOAD_CHART（Helm Chart 推送） DOWNLOAD_CHART（Helm Chart 拉取） DELETE_CHART（Helm Chart 删除） PUSH_ARTIFACT（制品推送） PULL_ARTIFACT（制品拉取） DELETE_ARTIFACT（制品删除）
filters	List<TriggerFilter>	触发规则
id	Integer	触发器 ID
name	String	触发器名称
targets	List<TriggerTarget>	访问配置
updateTime	String	触发器更新时间

TriggerFilter

参数名称	类型	描述
type	String	触发器过滤类型：project_name（命名空间）、repository_name（仓库）、repository_name（版本）
value	String	该类型对应的值

TriggerTarget

参数名称	类型	描述
address	String	触发器被触发后访问的 URL 地址
headers	Object	自定义 Header 信息 Header Key 仅支持 Authorization

TriggerJob

参数名称	类型	描述
creationTime	String	触发器任务创建时间
eventType	String	触发事件类型
id	Integer	触发器任务 ID
images	List<String>	触发对象列表
notifyType	String	通知类型
operator	String	操作人员
policyId	Integer	触发器策略 ID
status	String	触发器任务状态
updateTime	String	触发器任务更新时间

AcceleratorPolicy

参数名称	类型	描述
creationTime	String	镜像加速规则创建时间
description	String	备注
enabled	Boolean	镜像加速规则是否开启
filters	AcceleratorFilter	触发规则
id	Integer	镜像加速规则 ID
name	String	镜像加速规则名称
updateTime	String	镜像加速规则更新时间

AcceleratorFilter

参数名称	类型	描述
type	String	镜像加速触发类型
value	String	镜像加速触发类型对应值

Replication.PolicyResult

参数名称	类型	描述
creationTime	String	迁移规则创建时间
deletion	Boolean	级联删除
description	String	迁移规则描述
destProjectName	String	目的命名空间
destRegistry	Registry	目的 Registry
enabled	Boolean	迁移规则状态
executionTimes	Integer	迁移规则执行次数
filters	List<Replication.Filter>	资源筛选
id	Integer	迁移规则 ID
name	String	迁移规则名称
override	Boolean	是否覆盖目的 Registry 上的资源
srcRegistry	Registry	源 Registry
trigger	Replication.Trigger	触发器
updateTime	String	迁移规则更新时间

### Replication.Registry

参数名称	类型	描述
creationTime	String	Registry 创建时间
credential	RegistryCredential	Registry 访问凭据
description	String	Registry 描述
id	Integer	Registry ID
insecure	Boolean	当 Harbor 尝试访问服务器时，是否验证证书
name	String	Registry 名称
status	String	Registry 健康状态
type	String	Registry 类型，可选值：docker-hub、docker-registry、harbor
updateTime	String	Registry 更新时间
url	String	Registry 地址
region	String	Registry 所在地区

RegistryCredential

参数名称	类型	描述
accessKey	String	Access key，当凭据类型为 basic 时，accessKey 为用户名
accessSecret	String	Access secret，当凭据类型为 oauth 时，accessSecret 为用户密码
type	String	Registry 访问凭据，可选值：basic、oauth

### Replication.Filter

参数名称	类型	描述
type	String	迁移规则资源筛选种类
value	String	迁移规则资源筛选种类对应值

### Replication.Trigger

参数名称	类型	描述
triggerSettings	Replication.Settings	迁移规则触发设置
type	String	迁移规则触发类型，有效值为 manual、event_based 和 scheduled

### Replication.Settings

参数名称	类型	描述
cron	String	当迁移规则触发类型为 scheduled 时，对应的触发规则表达式

Replication.PolicyRequest

参数名称	类型	是否必选	描述
description	String	否	迁移规则描述
destProjectName	String	是	目的命名空间
filters	List<Replication.FilterReques>	是	资源筛选
name	String	是	迁移规则名称
override	Boolean	是	镜像版本是否覆盖开关，若开启，则会覆盖实例中已有的相同镜像
srcRegistry	Replication.RegistryRequest	是	源 Registry
trigger	Replication.TriggerRequest	是	触发器

### Replication.FilterRequest

参数名称	类型	是否必选	描述
type	String	是	迁移规则资源筛选种类
value	String	是	迁移规则资源筛选种类对应值

### Replication.RegistryRequest

参数名称	类型	是否必选	描述
id	Integer	是	Registry ID

### Replication.TriggerRequest

参数名称	类型	是否必选	描述
type	String	是	迁移规则触发类型，镜像迁移场景下只能为 manual

Replication.SyncPolicyResult

参数名称	类型	描述
id	Integer	同步规则 ID
name	String	同步规则名称
description	String	同步规则备注
syncType	String	同步类型
srcProjectName	String	源实例命名空间
srcRepositoryName	String	源仓库名称
srcTagName	String	源镜像版本
srcRegion	String	源实例所在地域
creationTime	String	同步规则创建时间
updateTime	String	同步规则更新时间
destInstanceId	String	同步目标实例 ID
destProjectName	String	同步目标命名空间
destRegion	String	同步目标实例所在地域
trigger	Replication.SyncTrigger	触发器
override	Boolean	是否覆盖目标实例已有的同名镜像

### Replication.SyncTrigger

参数名称	类型	描述
type	String	同步规则触发类型，有效值为 manual、event_based 和 scheduled

SyncRequest

参数名称	类型	是否必选	描述
description	String	否	同步规则备注
destInstanceId	String	是	同步目标实例 ID
destProjectName	String	否	同步目标命名空间
name	String	是	同步规则名称
override	Boolean	是	是否覆盖目标实例已有的同名镜像
srcProjectName	String	是	源实例命名空间
srcRepository	String	否	源仓库名称
srcTag	String	否	源镜像版本
syncType	String	否	同步类型
trigger	SyncTriggerRequest	是	触发器

### Replication.SyncTriggerRequest

参数名称	类型	是否必选	描述
type	String	是	同步规则触发类型，有效值为 manual 和 event_based

ExecutionResult

参数名称	类型	描述
endTime	String	结束时间
failed	Integer	执行失败次数
id	Integer	执行记录 ID
inProgress	Integer	正在进行的任务数量
policyId	Integer	执行任务所属的规则 ID
startTime	String	开始时间
status	String	执行状态
statusText	String	状态文本
stopped	Integer	停止执行的计数
succeed	Integer	成功执行的计数
total	Integer	所有执行的计数
trigger	String	触发方式

TaskResult

参数名称	类型	描述
destResource	String	同步目标
endTime	String	结束时间
executionId	Integer	任务执行结果所属的任务 ID
id	Integer	任务执行结果 ID
jobId	String	与任务相关的基础作业 ID
operation	String	任务的操作
resourceType	String	同步类型
srcResource	String	同步源
startTime	String	开始时间
status	String	状态

HelmChart

参数名称	类型	描述
name	String	Chart 名称
totalVersions	Integer	版本个数
latestVersion	String	最新版本号
home	String	Chart 主页的 URL 地址
icon	String	Chart 图标的地址
deprecated	Boolean	是否弃用
created	String	创建时间
updated	String	更新时间

HelmChartVersion

参数名称	类型	描述
name	String	Chart 包的名称
description	String	描述信息
apiVersion	String	API 版本号
appVersion	String	包含的应用程序版本
version	String	Chart 包版本号
urls	List<String>	Chart 包文件的 URL 列表
digest	String	Chart 摘要
engine	String	模板引擎名称
home	String	Chart 主页的 URL 地址
icon	String	Chart 图标的地址
sources	List<String>	Chart 包含的源代码 URL 列表
created	String	版本创建时间
deprecated	Boolean	是否弃用
removed	Boolean	是否删除
maintainers	List<String>	维护者信息

Privatelinks

参数名称	类型	描述
vpcID	String	私有网络 ID
subnetID	String	私有网络子网 ID
serviceNetID	String	服务网卡 ID
ipAddress	String	内网解析 IP 地址
status	String	私有网络状态

Whitelist

参数名称	类型	描述
ipAddr	String	白名单 IP 地址
description	String	白名单描述信息

LogicalTag

参数名称	类型	描述
tagKey	String	标签的键，可包含大小写字母、数字、中文以及 -、_、/、. 特殊字符，长度 1-65
tagValue	String	标签的值，可包含大小写字母、数字、中文以及 -、_、/、. 特殊字符，长度 0-65

Robot

参数名称	类型	描述
id	Integer	机器人账号 ID
name	String	账号名称
description	String	描述信息
level	String	等级，固定为 system
disable	Boolean	是否禁用
duration	Integer	账号剩余有效期，单位：天，-1 表示永不过期
expiresAt	Integer	过期时间，Unix 时间戳，-1 表示永不过期
creationTime	String	创建时间
updateTime	String	更新时间
permissions	List<Robot.Permission>	权限列表

### Robot.Permission

参数名称	类型	描述
kind	String	固定值为 project
namespace	String	命名空间名称，如果是选择所有命名空间，则展示 *
access	List<Robot.Permission.Access>	访问权限内容

### Robot.Permission.Access

参数名称	类型	描述
resource	String	固定值为 repository
action	String	访问权限内容，pull 对应镜像拉取权限，push 对应镜像推送权限