Appendix

Instance

Parameter name	Types	Description
id	String	Instance ID
name	String	Instance name
instanceType	String	Instance type
publicURL	String	Public access address
region	String	Region
status	String	Instance status
createTime	String	Creation time
tags	[LogicalTag](CCR/Enterprise Edition API Reference/Appendix.md#LogicalTag)	Tag key-value pair information

InstanceStatistic

Parameter name	Types	Description
repo	Integer	Image registry count
chart	Integer	Chart count
namespace	Integer	Namespace count
storage	Integer	BOS storage space size (in bytes)

InstanceQuota

Parameter name	Types	Description
repo	Integer	Image registry count limit
chart	Integer	Chart count limit
namespace	Integer	Namespace count limit

Project

Parameter name	Types	Description
autoScan	String	Whether to automatically scan images during push; valid values are true or false.
chartCount	int	Chart count in the namespace
creationTime	String	Namespace creation time, in date-time format
projectId	int	Namespace ID
projectName	String	Namespace name
public	String	Namespace type offers two options: true indicates public, and false indicates private.
repoCount	int	Number of image registries in the namespace
updateTime	String	Namespace update time, in date-time format

Repository

Parameter name	Types	Description
projectName	String	Namespace name
repositoryName	String	Image registry name
description	String	Image registry description
repositoryPath	String	Public network access image path
privateRepositoryPath	String	VPC access image path
tagCount	Integer	Image tag count
pullCount	Integer	Image pull count
creationTime	String	Creation time
updateTime	String	Update time

Tag

Parameter name	Types	Description
architecture	String	Image registry architecture
author	String	Publisher
digest	String	Artifact hash value
os	String	OS type
projectId	Integer	Namespace ID to which the artifact belongs
pullTime	String	Latest tag pull time, in date-time format
pushTime	String	Tag push time, in date-time format
repositoryId	Integer	Image registry ID to which the artifact belongs
scanOverview	[Tag.ScanOverview](CCR/Enterprise Edition API Reference/Appendix.md#Tag.ScanOverview)	Vulnerability scan information
size	Integer	Artifact size
tagName	String	Tag name
type	String	Artifact category, options: image, chart

Tag.ScanOverview

Parameter name	Types	Description
endTime	String	Completion time of vulnerability scan, in date-time format
fixable	Integer	Count of fixable vulnerabilities
reportId	String	Scan report ID of local machine
scanStatus	String	Status of report generation
severity	String	Vulnerability levels: Critical, High, Medium and Low
startTime	String	Start time of vulnerability scan, in date-time format
summary	object	Number of vulnerabilities with different severity
total	Integer	Total number of vulnerabilities discovered

BuildHistory

Parameter name	Types	Description
comment	String	Remarks
created	String	Creation time
createdBy	String	Command
emptyLayer	Boolean	Whether the layer is empty (true or false)

Artifact.ScanOverview

Parameter name	Types	Description
description	String	Vulnerability description
fixVersion	String	Fixed version
id	String	Vulnerability Code
links	List	Vulnerability detail page link
package	String	Component
severity	String	Severity
version	String	Current version

TriggerPolicy

Parameter name	Types	Description
creationTime	String	Trigger creation time
description	String	Trigger policy notes
enabled	Boolean	Enabling status
eventTypes	List	Trigger event type list. Trigger event type definitions: UPLOAD_CHART (Push Helm Chart) DOWNLOAD_CHART (Pull Helm Chart) DELETE_CHART (Delete Helm Chart) PUSH_ARTIFACT (Push Artifact) PULL_ARTIFACT (Pull Artifact) DELETE_ARTIFACT (Delete Artifact)
filters	List<[TriggerFilter](CCR/Enterprise Edition API Reference/Appendix.md#TriggerFilter)>	Trigger rules
id	Integer	Trigger ID
name	String	Trigger name
targets	List<[TriggerTarget](CCR/Enterprise Edition API Reference/Appendix.md#TriggerTarget)>	Access configuration
updateTime	String	Trigger update time

TriggerFilter

Parameter name	Types	Description
type	String	Trigger filter types: project_name (namespace), repository_name (registry), and repository_name (version)
value	String	The value corresponding to this type

TriggerTarget

Parameter name	Types	Description
address	String	URL address accessed after the trigger is activated
headers	Object	Custom header information . The header key only supports "Authorization"

TriggerJob

Parameter name	Types	Description
creationTime	String	Trigger task creation time
eventType	String	Trigger event type
id	Integer	Trigger task ID
images	List	Trigger object list
notifyType	String	Notification type
operator	String	Operator
policyId	Integer	Trigger policy ID
status	String	Trigger task status
updateTime	String	Trigger task update time

AcceleratorPolicy

Parameter name	Types	Description
creationTime	String	Creation time of image acceleration rule
description	String	Remarks
enabled	Boolean	Whether image acceleration rule is enabled
filters	[AcceleratorFilter](CCR/Enterprise Edition API Reference/Appendix.md#AcceleratorFilter)	Trigger rules
id	Integer	Image acceleration rule ID
name	String	Image acceleration rule name
updateTime	String	Image acceleration rule update time

AcceleratorFilter

Parameter name	Types	Description
type	String	Trigger type of image acceleration
value	String	Corresponding value of image acceleration trigger type

Replication.PolicyResult

Parameter name	Types	Description
creationTime	String	Migration rule creation time
deletion	Boolean	Cascading deletion
description	String	Migration rule description
destProjectName	String	Destination namespace
destRegistry	[Registry](CCR/Enterprise Edition API Reference/Appendix.md#Registry)	Destination registry
enabled	Boolean	Migration rule status
executionTimes	Integer	Migration rule execution count
filters	List<[Replication.Filter](CCR/Enterprise Edition API Reference/Appendix.md#Replication.Filter)>	Resource filtering
id	Integer	Migration rule ID
name	String	Migration rule name
override	Boolean	Whether to overwrite resources on the destination registry
srcRegistry	[Registry](CCR/Enterprise Edition API Reference/Appendix.md#Registry)	Source registry
trigger	[Replication.Trigger](CCR/Enterprise Edition API Reference/Appendix.md#Replication.Trigger)	Trigger
updateTime	String	Migration rule update time

Replication.Registry

Parameter name	Types	Description
creationTime	String	Registry creation time
credential	[RegistryCredential](CCR/Enterprise Edition API Reference/Appendix.md#RegistryCredential)	Registry access credentials
description	String	Registry description
id	Integer	Registry ID
insecure	Boolean	Whether to validate the certificate when Harbor attempts to access the server
name	String	Registry name
status	String	Registry health status
type	String	Registry type; options: docker-hub, docker-registry and harbor
updateTime	String	Registry update time
url	String	Registry address
region	String	Registry region

RegistryCredential

Parameter name	Types	Description
accessKey	String	Access key; when the credential type is "basic", accessKey is the user name.
accessSecret	String	Access secret; when the credential type is "oauth", accessSecret is the user password.
type	String	Registry access credentials; options: "basic" and "oauth"

Replication.Filter

Parameter name	Types	Description
type	String	Migration rule resource filter type
value	String	Corresponding value of migration rule resource filter type

Replication.Trigger

Parameter name	Types	Description
triggerSettings	[Replication.Settings](CCR/Enterprise Edition API Reference/Appendix.md#Replication.Settings)	Migration Rule trigger settings
type	String	Migration rule trigger types, valid values: manual, event_based, and scheduled

Replication.Settings

Parameter name	Types	Description
cron	String	The corresponding trigger rule expression when the migration rule trigger type is scheduled

Replication.PolicyRequest

Parameter name	Types	Required or not	Description
description	String	No	Migration rule description
destProjectName	String	Yes	Destination namespace
filters	List<[Replication.FilterReques](CCR/Enterprise Edition API Reference/Appendix.md#Replication.FilterReques)>	Yes	Resource filtering
name	String	Yes	Migration rule name
override	Boolean	Yes	Whether the image version override switch is enabled. If it is enabled, it will overwrite existing identical images in the instance.
srcRegistry	[Replication.RegistryRequest](CCR/Enterprise Edition API Reference/Appendix.md#Replication.RegistryRequest)	Yes	Source registry
trigger	[Replication.TriggerRequest](CCR/Enterprise Edition API Reference/Appendix.md#Replication.TriggerRequest)	Yes	Trigger

Replication.FilterRequest

Parameter name	Types	Required or not	Description
type	String	Yes	Migration rule resource filter type
value	String	Yes	Corresponding value of migration rule resource filter type

Replication.RegistryRequest

Parameter name	Types	Required or not	Description
id	Integer	Yes	Registry ID

Replication.TriggerRequest

Parameter name	Types	Required or not	Description
type	String	Yes	Migration rule trigger type, which can only be "manual" in image migration scenarios

Replication.SyncPolicyResult

Parameter name	Types	Description
id	Integer	Synchronization rule ID
name	String	Synchronization rule name
description	String	Synchronization rule remarks
syncType	String	Synchronization type
srcProjectName	String	Source instance namespace
srcRepositoryName	String	Source registry name
srcTagName	String	Source image version
srcRegion	String	Source instance region
creationTime	String	Synchronization rule creation time
updateTime	String	Synchronization rule update time
destInstanceId	String	Synchronization target instance ID
destProjectName	String	Synchronization target namespace
destRegion	String	Synchronization target instance region
trigger	[Replication.SyncTrigger](CCR/Enterprise Edition API Reference/Appendix.md#Replication.SyncTrigger)	Trigger
override	Boolean	Whether to overwrite existing images with the same name in the target instance

Replication.SyncTrigger

Parameter name	Types	Description
type	String	Synchronization rule trigger types, valid values: manual, event_based, and scheduled

SyncRequest

Parameter name	Types	Required or not	Description
description	String	No	Synchronization rule remarks
destInstanceId	String	Yes	Synchronization target instance ID
destProjectName	String	No	Synchronization target namespace
name	String	Yes	Synchronization rule name
override	Boolean	Yes	Whether to overwrite existing images with the same name in the target instance
srcProjectName	String	Yes	Source instance namespace
srcRepository	String	No	Source registry name
srcTag	String	No	Source image version
syncType	String	No	Synchronization type
trigger	[SyncTriggerRequest](CCR/Enterprise Edition API Reference/Appendix.md#SyncTriggerRequest)	Yes	Trigger

Replication.SyncTriggerRequest

Parameter name	Types	Required or not	Description
type	String	Yes	Synchronization rule trigger types, valid values: manual and event_based

ExecutionResult

Parameter name	Types	Description
endTime	String	End time
failed	Integer	Count of failed execution
id	Integer	Execution record ID
inProgress	Integer	Number of ongoing tasks
policyId	Integer	Rule ID to which the execution task belongs
startTime	String	Start time
status	String	Execution state
statusText	String	Status text
stopped	Integer	Count of stopped execution
succeed	Integer	Count of successful execution
total	Integer	Total execution count
trigger	String	Trigger method

TaskResult

Parameter name	Types	Description
destResource	String	Synchronization target
endTime	String	End time
executionId	Integer	Task ID to which the task execution result belongs
id	Integer	Task execution result ID
jobId	String	ID of the basic job related to the task
operation	String	Task operation
resourceType	String	Synchronization type
srcResource	String	Synchronization source
startTime	String	Start time
status	String	Status

HelmChart

Parameter name	Types	Description
name	String	Chart name
totalVersions	Integer	Version count
latestVersion	String	Latest version No.
home	String	URL address on Chart homepage
icon	String	Chart icon address
deprecated	Boolean	Whether abandoned
created	String	Creation time
updated	String	Update time

HelmChartVersion

Parameter name	Types	Description
name	String	Chart package name
description	String	Description
apiVersion	String	API version number
appVersion	String	Included application version
version	String	Chart package version No.
urls	List<String>	URL list of Chart package files
digest	String	Chart digest
engine	String	Template engine name
home	String	URL address on Chart homepage
icon	String	Chart icon address
sources	List<String>	Source code URL list included in Chart
created	String	Version creation time
deprecated	Boolean	Whether abandoned
removed	Boolean	Whether to delete
maintainers	List<String>	Maintainer information

Privatelinks

Parameter name	Types	Description
vpcID	String	Virtual Private Cloud ID
subnetID	String	Virtual Private Cloud subnet ID
serviceNetID	String	Service network interface card ID
ipAddress	String	Intranet resolution IP address
status	String	Virtual Private Cloud status

Whitelist

Parameter name	Types	Description
ipAddr	String	Allow list IP address
description	String	Allow list description

LogicalTag

Parameter name	Types	Description
tagKey	String	The key of the tag, which main contain uppercase and lowercase letters, numbers, Chinese characters, and special characters-_ /., with a length of 1-65.
tagValue	String	The value of the tag, which main contain uppercase and lowercase letters, numbers, Chinese characters, and special characters-_ /., with a length of 0-65.