Private network access information
Used by actions: DescribeInternalEndpoints.
Name | Type | Description |
---|---|---|
VpcId | String | VPC ID |
SubnetId | String | Subnet ID |
Status | String | Private network access status |
AccessIp | String | Private network access IP |
Custom domain name information
Used by actions: DescribeInstanceCustomizedDomain.
Name | Type | Description |
---|---|---|
RegistryId | String | Instance ID |
CertId | String | Certificate ID |
DomainName | String | Domain name |
Status | String | Domain name creation status. Valid values: SUCCESS, FAILURE, CREATING, DELETING. |
Filter
Used by actions: DescribeInstances, DescribeNamespaces, DescribeServiceAccounts.
Name | Type | Required | Description |
---|---|---|---|
Name | String | Yes | Attribute name. If more than one filter exists, the logical relationship between these filters is AND . |
Values | Array of String | Yes | Attribute value. If multiple values exist in one filter, the logical relationship between these values is OR . |
GC execution information
Used by actions: DescribeGCJobs.
Name | Type | Description |
---|---|---|
ID | Integer | Job ID |
JobStatus | String | Job status |
CreationTime | String | Creation time |
UpdateTime | String | Update time |
Schedule | Schedule | Scheduling information |
Header KV
Used by actions: CreateWebhookTrigger, DescribeWebhookTrigger, ModifyWebhookTrigger.
Name | Type | Required | Description |
---|---|---|---|
Key | String | Yes | Header Key |
Values | Array of String | Yes | Header Values |
Tag immutability rule
Used by actions: CreateImmutableTagRules, DescribeImmutableTagRules, ModifyImmutableTagRules.
Name | Type | Required | Description |
---|---|---|---|
RepositoryPattern | String | Yes | Repository matching rule |
TagPattern | String | Yes | Tag matching rule |
RepositoryDecoration | String | Yes | repoMatches or repoExcludes |
TagDecoration | String | Yes | matches or excludes |
Disabled | Boolean | No | Disabling rule |
RuleId | Integer | No | Rule ID |
NsName | String | No | Namespace |
String key-value pair of a common parameter
Used by actions: DescribeNamespaces.
Name | Type | Required | Description |
---|---|---|---|
Key | String | Yes | Key |
Value | String | Yes | Value |
Parameters for cross-account synchronization
Used by actions: ManageReplication.
Name | Type | Required | Description |
---|---|---|---|
PeerRegistryUin | String | Yes | UIN of the destination instance |
PeerRegistryToken | String | Yes | Permanent access Token for the destination instance |
EnablePeerReplication | Boolean | Yes | Whether to enable cross-account synchronization |
Policy
Used by actions: CreateServiceAccount, DescribeServiceAccounts, ModifyServiceAccount.
Name | Type | Required | Description |
---|---|---|---|
Resource | String | Yes | Resource path. Valid value: Namespace Note: This field may return null , indicating that no valid values can be obtained. |
Actions | Array of String | Yes | Actions. Currently only support: tcr:PushRepository, tcr:PullRepository, tcr:CreateRepository, tcr:CreateHelmChart, tcr:DescribeHelmCharts. Note: This field may return null, indicating that no valid value can be obtained. |
Region information
Used by actions: DescribeRegions.
Name | Type | Description |
---|---|---|
Alias | String | gz |
RegionId | Integer | 1 |
RegionName | String | ap-guangzhou |
Status | String | alluser |
Remark | String | remark |
CreatedAt | Timestamp ISO8601 | Creation time |
UpdatedAt | Timestamp ISO8601 | Update time |
Id | Integer | id |
Instance information structure
Used by actions: DescribeInstances.
Name | Type | Description |
---|---|---|
RegistryId | String | Instance ID |
RegistryName | String | Instance name |
RegistryType | String | Instance specification |
Status | String | Instance status |
PublicDomain | String | Public access URL of the instance |
CreatedAt | Timestamp ISO8601 | Instance creation time |
RegionName | String | Region name |
RegionId | Integer | Region ID |
EnableAnonymous | Boolean | Whether to enable anonymity |
TokenValidTime | Integer | Token validity period |
InternalEndpoint | String | Internal access address of the instance |
TagSpecification | TagSpecification | Cloud tag of the instance Note: This field may return null, indicating that no valid values can be obtained. |
ExpiredAt | String | Instance expiration time (for prepayment) Note: This field may return null, indicating that no valid values can be obtained. |
PayMod | Integer | Instance billing mode. Valid values: 0: Postpayment; 1: Prepayment. Note: This field may return null, indicating that no valid values can be obtained. |
RenewFlag | Integer | Prepayment renewal flag. Valid values: 0: Manual renewal; 1: Auto-renewal; 2: No renewal and no notification. Note: This field may return null, indicating that no valid values can be obtained. |
DeletionProtection | Boolean | Whether to enable instance deletion protection. false indicates it is not enabled. |
Instance prepayment mode
Used by actions: CreateInstance, RenewInstance.
Name | Type | Required | Description |
---|---|---|---|
Period | Integer | Yes | Instance purchase duration in months |
RenewFlag | Integer | Yes | Auto-renewal flag. Valid values: 0: Manual renewal; 1: Auto-renewal; 2: No renewal and no notification. |
Instance creation process
Used by actions: DescribeInstanceStatus.
Name | Type | Description |
---|---|---|
Type | String | Instance creation process type |
Status | String | Instance creation process status |
Reason | String | Reasons for transiting to the process Note: This field may return null, indicating that no valid values can be obtained. |
Instance status
Used by actions: DescribeInstanceStatus.
Name | Type | Description |
---|---|---|
RegistryId | String | Instance ID |
Status | String | Instance status |
Conditions | Array of RegistryCondition | Additional status Note: This field may return null, indicating that no valid values can be obtained. |
Synchronization rule filter
Used by actions: ManageReplication.
Name | Type | Required | Description |
---|---|---|---|
Type | String | Yes | Type (name , tag and resource ) |
Value | String | No | It is left blank by default |
Synchronization log
Used by actions: DescribeReplicationInstanceSyncStatus.
Name | Type | Description |
---|---|---|
ResourceType | String | Resource type Note: this field may return null , indicating that no valid values can be obtained. |
Source | String | Path of the source resource Note: this field may return null , indicating that no valid values can be obtained. |
Destination | String | Path of the destination resource Note: this field may return null , indicating that no valid values can be obtained. |
Status | String | Synchronization status Note: this field may return null , indicating that no valid values can be obtained. |
StartTime | String | Start time Note: this field may return null , indicating that no valid values can be obtained. |
EndTime | String | End time Note: this field may return null , indicating that no valid values can be obtained. |
ID of Enterprise Registry replication instance
Used by actions: DescribeReplicationInstances.
Name | Type | Description |
---|---|---|
RegistryId | String | Master instance ID |
ReplicationRegistryId | String | Replication instance ID |
ReplicationRegionId | Integer | Region ID of the replication instance |
ReplicationRegionName | String | Region name of the replication instance |
Status | String | Status of the replication instance |
CreatedAt | String | Creation time |
Synchronization rule
Used by actions: ManageReplication.
Name | Type | Required | Description |
---|---|---|---|
Name | String | Yes | Name of synchronization rule |
DestNamespace | String | Yes | Destination namespace |
Override | Boolean | Yes | Whether to override |
Filters | Array of ReplicationFilter | Yes | Synchronization filters |
Tag retention rule execution
Used by actions: DescribeTagRetentionExecution.
Name | Type | Description |
---|---|---|
ExecutionId | Integer | Execution ID |
RetentionId | Integer | Rule ID |
StartTime | String | Execution start time |
EndTime | String | Execution end time |
Status | String | Execution status. Valid values: Failed, Succeed, Stopped, InProgress. |
Tag retention policy
Used by actions: DescribeTagRetentionRules.
Name | Type | Description |
---|---|---|
RetentionId | Integer | Tag retention policy ID |
NamespaceName | String | Namespace name |
RetentionRuleList | Array of RetentionRule | List of rules |
CronSetting | String | Regular execution mode |
Disabled | Boolean | Whether to enable the rule |
NextExecutionTime | String | The execution time of the next task based on the current time and cronSetting , which is for reference only |
Tag retention rule
Used by actions: CreateTagRetentionRule, DescribeTagRetentionRules, ModifyTagRetentionRule.
Name | Type | Required | Description |
---|---|---|---|
Key | String | Yes | Supported policy. Valid values: latestPushedK: Retain the latest specified number of pushed tags; nDaysSinceLastPush: Retain the tags pushed in the past specified number of days. |
Value | Integer | Yes | Rule value |
Rule of tag retention task execution
Used by actions: DescribeTagRetentionExecutionTask.
Name | Type | Description |
---|---|---|
TaskId | Integer | Task ID |
ExecutionId | Integer | Rule execution ID |
StartTime | String | Task start time |
EndTime | String | Task end time |
Status | String | Task execution status. Valid values: Failed, Succeed, Stopped, InProgress. |
Total | Integer | Total number of tags |
Retained | Integer | Number of retained tags |
Repository | String | Application repository |
Job scheduling information
Used by actions: DescribeGCJobs.
Name | Type | Description |
---|---|---|
Type | String | Type. Valid values: Hourly, Daily, Weekly, Custom, Manual, Dryrun, None. |
Security policy
Used by actions: CreateMultipleSecurityPolicy, DeleteMultipleSecurityPolicy, DescribeSecurityPolicies.
Name | Type | Required | Description |
---|---|---|---|
PolicyIndex | Integer | No | Policy index |
Description | String | No | Remarks |
CidrBlock | String | No | The public network IP address of the access source |
PolicyVersion | String | No | The version of the security policy |
Service account
Used by actions: DescribeServiceAccounts.
Name | Type | Required | Description |
---|---|---|---|
Name | String | No | Service account name Note: This field may return null , indicating that no valid values can be obtained. |
Description | String | No | Description Note: This field may return null , indicating that no valid values can be obtained. |
Disable | Boolean | No | Whether to disable Note: This field may return null , indicating that no valid values can be obtained. |
ExpiresAt | Integer | No | Expiry time Note: This field may return null , indicating that no valid values can be obtained. |
CreateTime | Timestamp ISO8601 | No | Creation time Note: This field may return null , indicating that no valid values can be obtained. |
UpdateTime | Timestamp ISO8601 | No | Update time Note: This field may return null, indicating that no valid values can be obtained. |
Permissions | Array of Permission | No | Policy Note: This field may return null , indicating that no valid values can be obtained. |
Cloud tag
Used by actions: CreateImageAccelerationService, CreateInstance, CreateNamespace, DescribeInstances, DescribeNamespaces.
Name | Type | Required | Description |
---|---|---|---|
Key | String | Yes | Cloud tag key.Note: This field may return null, indicating that no valid value can be obtained. |
Value | String | Yes | Cloud tag value.Note: This field may return null, indicating that no valid value can be obtained. |
Cloud tag
Used by actions: CreateImageAccelerationService, CreateInstance, CreateNamespace, DescribeInstances, DescribeNamespaces.
Name | Type | Required | Description |
---|---|---|---|
ResourceType | String | Yes | Default value: instance. Note: This field may return null, indicating that no valid values can be obtained. |
Tags | Array of Tag | Yes | Cloud tag array Note: This field may return null, indicating that no valid values can be obtained. |
Task details
Used by actions: DescribeReplicationInstanceCreateTasks.
Name | Type | Description |
---|---|---|
TaskName | String | Task |
TaskUUID | String | Task UUID |
TaskStatus | String | Task status |
TaskMessage | String | Task details Note: this field may return null , indicating that no valid values can be obtained. |
CreatedTime | String | Start time of the task |
FinishedTime | String | End time of the task Note: this field may return null , indicating that no valid values can be obtained. |
Image information
Used by actions: DescribeImages.
Name | Type | Description |
---|---|---|
Digest | String | Hash value |
Size | Integer | Image size in bytes |
ImageVersion | String | Tag name |
UpdateTime | String | Update time |
Kind | String | Artifact type Note: This field may return null, indicating that no valid values can be obtained. |
KmsSignature | String | KMS signature information Note: This field may return null, indicating that no valid values can be obtained. |
Instance login token
Used by actions: DescribeInstanceToken.
Name | Type | Description |
---|---|---|
Id | String | Token ID |
Desc | String | Token description |
RegistryId | String | ID of the instance of the token |
Enabled | Boolean | Token status |
CreatedAt | Timestamp ISO8601 | Token creation time |
ExpiredAt | Integer | Token expiration timestamp |
TCR namespace description
Used by actions: DescribeNamespaces.
Name | Type | Description |
---|---|---|
Name | String | Namespace name |
CreationTime | Timestamp ISO8601 | Creation time |
Public | Boolean | Access level |
NamespaceId | Integer | Namespace ID |
TagSpecification | TagSpecification | Cloud tag of the instance Note: This field may return null, indicating that no valid values can be obtained. |
Metadata | Array of KeyValueString | Namespace metadata Note: This field may return null, indicating that no valid values can be obtained. |
TCR image repository information
Used by actions: DescribeRepositories.
Name | Type | Description |
---|---|---|
Name | String | Repository name |
Namespace | String | Namespace name |
CreationTime | String | Creation time, such as 2006-01-02 15:04:05.999999999 -0700 MST |
Public | Boolean | Whether to make public |
Description | String | Detailed repository description Note: This field may return null, indicating that no valid values can be obtained. |
BriefDescription | String | Brief description Note: This field may return null, indicating that no valid values can be obtained. |
UpdateTime | String | Update time, such as 2006-01-02 15:04:05.999999999 -0700 MST |
Trigger target
Used by actions: CreateWebhookTrigger, DescribeWebhookTrigger, ModifyWebhookTrigger.
Name | Type | Required | Description |
---|---|---|---|
Address | String | Yes | Target address |
Headers | Array of Header | No | Custom headers |
Webhook trigger
Used by actions: CreateWebhookTrigger, DescribeWebhookTrigger, ModifyWebhookTrigger.
Name | Type | Required | Description |
---|---|---|---|
Name | String | Yes | Trigger name |
Targets | Array of WebhookTarget | Yes | Trigger target |
EventTypes | Array of String | Yes | Action to be triggered |
Condition | String | Yes | Trigger rule |
Enabled | Boolean | Yes | Whether to enable the trigger |
Id | Integer | No | Trigger ID |
Description | String | No | Trigger description |
NamespaceId | Integer | No | ID of the namespace of the trigger |
Trigger log
Used by actions: DescribeWebhookTriggerLog.
Name | Type | Description |
---|---|---|
Id | Integer | Log ID |
TriggerId | Integer | Trigger ID |
EventType | String | Event type |
NotifyType | String | Notification type |
Detail | String | Details |
CreationTime | String | Creation time |
UpdateTime | String | Update time |
Status | String | Status |
Was this page helpful?