容器镜像服务 数据结构 - API 文档

AccessVpc

内网接入信息

被如下接口引用：DescribeInternalEndpoints。

名称	类型	描述
VpcId	String	Vpc的Id
SubnetId	String	子网Id
Status	String	内网接入状态
AccessIp	String	内网接入Ip

AutoDelStrategyInfo

自动删除策略信息

被如下接口引用：DescribeImageLifecycleGlobalPersonal, DescribeImageLifecyclePersonal。

名称	类型	描述
Username	String	用户名
RepoName	String	仓库名
Type	String	类型
Value	Integer	策略值
Valid	Integer	Valid
CreationTime	String	创建时间

AutoDelStrategyInfoResp

获取自动删除策略

被如下接口引用：DescribeImageLifecycleGlobalPersonal, DescribeImageLifecyclePersonal。

名称	类型	描述
TotalCount	Integer	总数目
StrategyInfo	Array of AutoDelStrategyInfo	自动删除策略列表 注意：此字段可能返回 null，表示取不到有效值。

DescribeApplicationTriggerLogPersonalResp

查询应用更新触发器触发日志返回值

被如下接口引用：DescribeApplicationTriggerLogPersonal。

名称	类型	描述
TotalCount	Integer	返回总数
LogInfo	Array of TriggerLogResp	触发日志列表 注意：此字段可能返回 null，表示取不到有效值。

DescribeApplicationTriggerPersonalResp

拉取触发器列表返回值

被如下接口引用：DescribeApplicationTriggerPersonal。

名称	类型	描述
TotalCount	Integer	返回条目总数
TriggerInfo	Array of TriggerResp	触发器列表

DupImageTagResp

复制镜像tag返回值

被如下接口引用：DuplicateImagePersonal。

名称	类型	描述
Digest	String	镜像Digest值

FavorResp

用于获取收藏仓库的响应

被如下接口引用：DescribeFavorRepositoryPersonal。

名称	类型	描述
TotalCount	Integer	收藏仓库的总数
RepoInfo	Array of Favors	仓库信息数组 注意：此字段可能返回 null，表示取不到有效值。

Favors

仓库收藏

被如下接口引用：DescribeFavorRepositoryPersonal。

名称	类型	描述
RepoName	String	仓库名字
RepoType	String	仓库类型
PullCount	Integer	Pull总共的次数 注意：此字段可能返回 null，表示取不到有效值。
FavorCount	Integer	仓库收藏次数 注意：此字段可能返回 null，表示取不到有效值。
Public	Integer	仓库是否公开 注意：此字段可能返回 null，表示取不到有效值。
IsQcloudOfficial	Boolean	是否为官方所有 注意：此字段可能返回 null，表示取不到有效值。
TagCount	Integer	仓库Tag的数量 注意：此字段可能返回 null，表示取不到有效值。
Logo	String	Logo 注意：此字段可能返回 null，表示取不到有效值。
Region	String	地域
RegionId	Integer	地域的Id

Filter

过滤器

被如下接口引用：DescribeInstances。

名称	类型	必选	描述
Name	String	是	属性名称, 若存在多个Filter时，Filter间的关系为逻辑与（AND）关系。
Values	Array of String	是	属性值, 若同一个Filter存在多个Values，同一Filter下Values间的关系为逻辑或（OR）关系。

Header

Header KV

被如下接口引用：CreateWebhookTrigger, DescribeWebhookTrigger, ModifyWebhookTrigger。

名称	类型	必选	描述
Key	String	是	Header Key
Values	Array of String	是	Header Values

Limit

共享镜像仓库用户配额

被如下接口引用：DescribeUserQuotaPersonal。

名称	类型	描述
Username	String	用户名
Type	String	配额的类型
Value	Integer	配置的值

NamespaceInfo

命名空间信息

被如下接口引用：DescribeNamespacePersonal。

名称	类型	描述
Namespace	String	命名空间
CreationTime	String	创建时间
RepoCount	Integer	命名空间下仓库数量

NamespaceInfoResp

获取命名空间信息返回

被如下接口引用：DescribeNamespacePersonal。

名称	类型	描述
NamespaceCount	Integer	命名空间数量
NamespaceInfo	Array of NamespaceInfo	命名空间信息

NamespaceIsExistsResp

NamespaceIsExists返回类型

被如下接口引用：ValidateNamespaceExistPersonal。

名称	类型	描述
IsExist	Boolean	命名空间是否存在
IsPreserved	Boolean	是否为保留命名空间

Registry

实例信息结构体

被如下接口引用：DescribeInstances。

名称	类型	描述
RegistryId	String	实例ID
RegistryName	String	实例名称
RegistryType	String	实例规格
Status	String	实例状态
PublicDomain	String	实例的公共访问地址
CreatedAt	Timestamp ISO8601	实例创建时间
RegionName	String	地域名称
RegionId	Integer	地域Id
EnableAnonymous	Boolean	是否支持匿名
TokenValidTime	Integer	Token有效时间
InternalEndpoint	String	实例内部访问地址
TagSpecification	TagSpecification	实例云标签 注意：此字段可能返回 null，表示取不到有效值。
ExpiredAt	String	实例过期时间（预付费） 注意：此字段可能返回 null，表示取不到有效值。
PayMod	Integer	实例付费类型，0表示后付费，1表示预付费 注意：此字段可能返回 null，表示取不到有效值。
RenewFlag	Integer	预付费续费标识，0表示手动续费，1表示自动续费，2不续费并且不通知 注意：此字段可能返回 null，表示取不到有效值。

RegistryChargePrepaid

实例预付费模式

被如下接口引用：RenewInstance。

名称	类型	必选	描述
Period	Integer	是	购买实例的时长，单位：月
RenewFlag	Integer	是	自动续费标识，0：手动续费，1：自动续费，2：不续费并且不通知

RegistryCondition

实例创建过程

被如下接口引用：DescribeInstanceStatus。

名称	类型	描述
Type	String	实例创建过程类型
Status	String	实例创建过程状态
Reason	String	转换到该过程的简明原因 注意：此字段可能返回 null，表示取不到有效值。

RegistryStatus

实例状态

被如下接口引用：DescribeInstanceStatus。

名称	类型	描述
RegistryId	String	实例的Id
Status	String	实例的状态
Conditions	Array of RegistryCondition	附加状态 注意：此字段可能返回 null，表示取不到有效值。

ReplicationFilter

同步规则过滤器

被如下接口引用：ManageReplication。

名称	类型	必选	描述
Type	String	是	类型（name、tag和resource）
Value	String	否	默认为空

ReplicationRegistry

企业版复制实例

被如下接口引用：DescribeReplicationInstances。

名称	类型	描述
RegistryId	String	主实例ID
ReplicationRegistryId	String	复制实例ID
ReplicationRegionId	Integer	复制实例的地域ID
ReplicationRegionName	String	复制实例的地域名称
Status	String	复制实例的状态
CreatedAt	String	创建时间

ReplicationRule

同步规则

被如下接口引用：ManageReplication。

名称	类型	必选	描述
Name	String	是	同步规则名称
DestNamespace	String	是	目标命名空间
Override	Boolean	是	是否覆盖
Filters	Array of ReplicationFilter	是	同步过滤条件

RepoInfo

仓库的信息

被如下接口引用：DescribeRepositoryFilterPersonal, DescribeRepositoryOwnerPersonal。

名称	类型	描述
RepoName	String	仓库名称
RepoType	String	仓库类型
TagCount	Integer	Tag数量
Public	Integer	是否为公开
IsUserFavor	Boolean	是否为用户收藏
IsQcloudOfficial	Boolean	是否为腾讯云官方仓库
FavorCount	Integer	被收藏的个数
PullCount	Integer	拉取的数量
Description	String	描述
CreationTime	String	仓库创建时间
UpdateTime	String	仓库更新时间

RepoInfoResp

仓库信息的返回信息

被如下接口引用：DescribeRepositoryOwnerPersonal。

名称	类型	描述
TotalCount	Integer	仓库总数
RepoInfo	Array of RepoInfo	仓库信息列表
Server	String	Server信息

RepoIsExistResp

仓库是否存在的返回值

被如下接口引用：ValidateRepositoryExistPersonal。

名称	类型	描述
IsExist	Boolean	仓库是否存在

RepositoryInfoResp

查询共享版仓库信息返回

被如下接口引用：DescribeRepositoryPersonal。

名称	类型	描述
RepoName	String	镜像仓库名字
RepoType	String	镜像仓库类型
Server	String	镜像仓库服务地址
CreationTime	String	创建时间
Description	String	镜像仓库描述 注意：此字段可能返回 null，表示取不到有效值。
Public	Integer	是否为公有镜像
PullCount	Integer	下载次数
FavorCount	Integer	收藏次数
IsUserFavor	Boolean	是否为用户收藏
IsQcloudOfficial	Boolean	是否为腾讯云官方镜像

RespLimit

用户配额返回值

被如下接口引用：DescribeUserQuotaPersonal。

名称	类型	描述
LimitInfo	Array of Limit	配额信息

RetentionExecution

版本保留规则执行

被如下接口引用：DescribeTagRetentionExecution。

名称	类型	描述
ExecutionId	Integer	执行Id
RetentionId	Integer	所属规则id
StartTime	String	执行的开始时间
EndTime	String	执行的结束时间
Status	String	执行的状态，Failed, Succeed, Stopped, InProgress

RetentionPolicy

版本保留策略

被如下接口引用：DescribeTagRetentionRules。

名称	类型	描述
RetentionId	Integer	版本保留策略Id
NamespaceName	String	命名空间的名称
RetentionRuleList	Array of RetentionRule	规则列表
CronSetting	String	定期执行方式
Disabled	Boolean	是否启用规则
NextExecutionTime	String	基于当前时间根据cronSetting后下一次任务要执行的时间，仅做参考使用

RetentionRule

版本保留规则

被如下接口引用：CreateTagRetentionRule, DescribeTagRetentionRules, ModifyTagRetentionRule。

名称	类型	必选	描述
Key	String	是	支持的策略，可选值为latestPushedK（保留最新推送多少个版本）nDaysSinceLastPush（保留近天内推送）
Value	Integer	是	规则设置下的对应值

RetentionTask

版本保留执行的规则

被如下接口引用：DescribeTagRetentionExecutionTask。

名称	类型	描述
TaskId	Integer	任务Id
ExecutionId	Integer	所属的规则执行Id
StartTime	String	任务开始时间
EndTime	String	任务结束时间
Status	String	任务的执行状态，Failed, Succeed, Stopped, InProgress
Total	Integer	总tag数
Retained	Integer	保留tag数
Repository	String	应用的仓库

SameImagesResp

指定tag镜像内容相同的tag列表

被如下接口引用：DescribeImageFilterPersonal。

名称	类型	描述
SameImages	Array of String	tag列表 注意：此字段可能返回 null，表示取不到有效值。

SearchUserRepositoryResp

获取满足输入搜索条件的用户镜像仓库

被如下接口引用：DescribeRepositoryFilterPersonal。

名称	类型	描述
TotalCount	Integer	总个数
RepoInfo	Array of RepoInfo	仓库列表
Server	String	Server
PrivilegeFiltered	Boolean	PrivilegeFiltered

SecurityPolicy

安全策略

被如下接口引用：DescribeSecurityPolicies。

名称	类型	描述
PolicyIndex	Integer	策略索引
Description	String	备注
CidrBlock	String	192.168.1.0/24
PolicyVersion	String	安全策略的版本

Tag

云标签Tag

被如下接口引用：CreateInstance, DescribeInstances。

名称	类型	必选	描述
Key	String	是	云标签的key
Value	String	是	云标签的值

TagInfo

镜像tag信息

被如下接口引用：DescribeImagePersonal。

名称	类型	描述
TagName	String	Tag名称
TagId	String	镜像Id
ImageId	String	docker image 可以看到的id
Size	String	大小
CreationTime	String	镜像的创建时间
DurationDays	String	镜像创建至今时间长度 注意：此字段可能返回 null，表示取不到有效值。
Author	String	镜像的作者
Architecture	String	次镜像建议运行的系统架构
DockerVersion	String	创建此镜像的docker版本
OS	String	此镜像建议运行系统
SizeByte	Integer	SizeByte
Id	Integer	Id
UpdateTime	String	数据更新时间
PushTime	String	镜像更新时间

TagInfoResp

Tag列表的返回值

被如下接口引用：DescribeImagePersonal。

名称	类型	描述
TagCount	Integer	Tag的总数
TagInfo	Array of TagInfo	TagInfo列表
Server	String	Server
RepoName	String	仓库名称

TagSpecification

云标签

被如下接口引用：CreateInstance, DescribeInstances。

名称	类型	必选	描述
ResourceType	String	是	默认值为instance 注意：此字段可能返回 null，表示取不到有效值。
Tags	Array of Tag	是	云标签数组 注意：此字段可能返回 null，表示取不到有效值。

TaskDetail

任务详情

被如下接口引用：DescribeReplicationInstanceCreateTasks。

名称	类型	描述
TaskName	String	任务
TaskUUID	String	任务UUID
TaskStatus	String	任务状态
TaskMessage	String	任务的状态信息 注意：此字段可能返回 null，表示取不到有效值。
CreatedTime	String	任务开始时间
FinishedTime	String	任务结束时间 注意：此字段可能返回 null，表示取不到有效值。

TcrImageInfo

镜像信息

被如下接口引用：DescribeImages。

名称	类型	描述
Digest	String	哈希值
Size	Integer	镜像大小
ImageVersion	String	Tag名称
UpdateTime	String	更新时间

TcrInstanceToken

实例登录令牌

被如下接口引用：DescribeInstanceToken。

名称	类型	描述
Id	String	令牌ID
Desc	String	令牌描述
RegistryId	String	令牌所属实例ID
Enabled	Boolean	令牌启用状态
CreatedAt	Timestamp ISO8601	令牌创建时间
ExpiredAt	Integer	令牌过期时间戳

TcrNamespaceInfo

Tcr 命名空间的描述

被如下接口引用：DescribeNamespaces。

名称	类型	描述
Name	String	命名空间名称
CreationTime	Timestamp ISO8601	创建时间
Public	Boolean	访问级别
NamespaceId	Integer	命名空间的Id

TcrRepositoryInfo

Tcr镜像仓库信息

被如下接口引用：DescribeRepositories。

名称	类型	描述
Name	String	仓库名称
Namespace	String	命名空间名称
CreationTime	String	创建时间
Public	Boolean	是否公开
Description	String	仓库详细描述 注意：此字段可能返回 null，表示取不到有效值。
BriefDescription	String	简单描述 注意：此字段可能返回 null，表示取不到有效值。
UpdateTime	String	更新时间

TriggerInvokeCondition

触发器触发条件

被如下接口引用：DescribeApplicationTriggerLogPersonal, DescribeApplicationTriggerPersonal。

名称	类型	描述
InvokeMethod	String	触发方式
InvokeExpr	String	触发表达式 注意：此字段可能返回 null，表示取不到有效值。

TriggerInvokePara

触发器触发参数

被如下接口引用：DescribeApplicationTriggerLogPersonal, DescribeApplicationTriggerPersonal。

名称	类型	描述
AppId	String	AppId 注意：此字段可能返回 null，表示取不到有效值。
ClusterId	String	TKE集群ID 注意：此字段可能返回 null，表示取不到有效值。
Namespace	String	TKE集群命名空间 注意：此字段可能返回 null，表示取不到有效值。
ServiceName	String	TKE集群工作负载名称 注意：此字段可能返回 null，表示取不到有效值。
ContainerName	String	TKE集群工作负载中容器名称 注意：此字段可能返回 null，表示取不到有效值。
ClusterRegion	Integer	TKE集群地域数字ID 注意：此字段可能返回 null，表示取不到有效值。

TriggerInvokeResult

触发器触发结果

被如下接口引用：DescribeApplicationTriggerLogPersonal。

名称	类型	描述
ReturnCode	Integer	请求TKE返回值 注意：此字段可能返回 null，表示取不到有效值。
ReturnMsg	String	请求TKE返回信息 注意：此字段可能返回 null，表示取不到有效值。

TriggerLogResp

触发器日志

被如下接口引用：DescribeApplicationTriggerLogPersonal。

名称	类型	描述
RepoName	String	仓库名称 注意：此字段可能返回 null，表示取不到有效值。
TagName	String	Tag名称 注意：此字段可能返回 null，表示取不到有效值。
TriggerName	String	触发器名称 注意：此字段可能返回 null，表示取不到有效值。
InvokeSource	String	触发方式 注意：此字段可能返回 null，表示取不到有效值。
InvokeAction	String	触发动作 注意：此字段可能返回 null，表示取不到有效值。
InvokeTime	String	触发时间 注意：此字段可能返回 null，表示取不到有效值。
InvokeCondition	TriggerInvokeCondition	触发条件 注意：此字段可能返回 null，表示取不到有效值。
InvokePara	TriggerInvokePara	触发参数 注意：此字段可能返回 null，表示取不到有效值。
InvokeResult	TriggerInvokeResult	触发结果 注意：此字段可能返回 null，表示取不到有效值。

TriggerResp

触发器返回值

被如下接口引用：DescribeApplicationTriggerPersonal。

名称	类型	描述
TriggerName	String	触发器名称 注意：此字段可能返回 null，表示取不到有效值。
InvokeSource	String	触发来源 注意：此字段可能返回 null，表示取不到有效值。
InvokeAction	String	触发动作 注意：此字段可能返回 null，表示取不到有效值。
CreateTime	String	创建时间 注意：此字段可能返回 null，表示取不到有效值。
UpdateTime	String	更新时间 注意：此字段可能返回 null，表示取不到有效值。
InvokeCondition	TriggerInvokeCondition	触发条件 注意：此字段可能返回 null，表示取不到有效值。
InvokePara	TriggerInvokePara	触发器参数 注意：此字段可能返回 null，表示取不到有效值。

VpcAndDomainInfo

vpc和domain信息

被如下接口引用：DescribeInternalEndpointDnsStatus。

名称	类型	必选	描述
InstanceId	String	是	tcr实例id
VpcId	String	是	私有网络id
EniLBIp	String	是	tcr内网访问链路ip
UsePublicDomain	Boolean	否	true：use instance name as subdomain false: use instancename+"-vpc" as subdomain

VpcPrivateDomainStatus

vpc私有域名解析状态

被如下接口引用：DescribeInternalEndpointDnsStatus。

名称	类型	描述
Region	String	地域 注意：此字段可能返回 null，表示取不到有效值。
VpcId	String	unique vpc id 注意：此字段可能返回 null，表示取不到有效值。
Status	String	ENABLE代表已经开启，DISABLE代表未开启，ERROR代表查询出错 注意：此字段可能返回 null，表示取不到有效值。

WebhookTarget

触发器目标

被如下接口引用：CreateWebhookTrigger, DescribeWebhookTrigger, ModifyWebhookTrigger。

名称	类型	必选	描述
Address	String	是	目标地址
Headers	Array of Header	否	自定义 Headers

WebhookTrigger

Webhook 触发器

被如下接口引用：CreateWebhookTrigger, DescribeWebhookTrigger, ModifyWebhookTrigger。

名称	类型	必选	描述
Name	String	是	触发器名称
Targets	Array of WebhookTarget	是	触发器目标
EventTypes	Array of String	是	触发动作
Condition	String	是	触发规则
Enabled	Boolean	是	启用触发器
Id	Integer	否	触发器Id
Description	String	否	触发器描述
NamespaceId	Integer	否	触发器所属命名空间 Id

WebhookTriggerLog

触发器日志

被如下接口引用：DescribeWebhookTriggerLog。

名称	类型	描述
Id	Integer	日志 Id
TriggerId	Integer	触发器 Id
EventType	String	事件类型
NotifyType	String	通知类型
Detail	String	详情
CreationTime	String	创建时间
UpdateTime	String	更新时间
Status	String	状态