{ "name": "tcr", "display_name": "容器镜像服务", "description": "介绍如何使用API对容器镜像服务进行相关操作，包括实例管理、镜像仓库等。", "domain": "compute", "api_version": "2019-09-24", "endpoint": "tcr.tencentcloudapi.com", "actions": [ { "name": "BatchDeleteImagePersonal", "description": "用于在个人版镜像仓库中批量删除Tag", "status": "online", "parameters": [ { "name": "RepoName", "type": "string", "required": true, "description": "仓库名称", "example": "nicokang/golang" }, { "name": "Tags", "type": "array", "required": true, "description": "Tag列表", "example": "[\"1\",\"2\"]", "item_type": "string" } ], "required": [ "RepoName", "Tags" ] }, { "name": "BatchDeleteRepositoryPersonal", "description": "用于个人版镜像仓库中批量删除镜像仓库", "status": "online", "parameters": [ { "name": "RepoNames", "type": "array", "required": true, "description": "仓库名称数组", "example": "[\"dockerhub\\/test\\r\\n\",\"testns\\/test1\\r\\n\"]", "item_type": "string" } ], "required": [ "RepoNames" ] }, { "name": "CheckInstance", "description": "用于校验企业版实例信息", "status": "online", "parameters": [ { "name": "RegistryId", "type": "string", "required": true, "description": "待检测的实例Id", "example": "test123" } ], "required": [ "RegistryId" ] }, { "name": "CheckInstanceName", "description": "检查待创建的实例名称是否符合规范", "status": "online", "parameters": [ { "name": "RegistryName", "type": "string", "required": true, "description": "待创建的实例名称", "example": "test123" } ], "required": [ "RegistryName" ] }, { "name": "CreateApplicationTriggerPersonal", "description": "用于创建应用更新触发器", "status": "online", "parameters": [ { "name": "RepoName", "type": "string", "required": true, "description": "触发器关联的镜像仓库，library/test格式", "example": "test/test123" }, { "name": "TriggerName", "type": "string", "required": true, "description": "触发器名称", "example": "testtrig" }, { "name": "InvokeMethod", "type": "string", "required": true, "description": "触发方式，\"all\"全部触发，\"taglist\"指定tag触发，\"regex\"正则触发", "example": "all" }, { "name": "ClusterId", "type": "string", "required": true, "description": "应用所在TKE集群ID", "example": "cls-xxxxxxxx" }, { "name": "Namespace", "type": "string", "required": true, "description": "应用所在TKE集群命名空间", "example": "default" }, { "name": "WorkloadType", "type": "string", "required": true, "description": "应用所在TKE集群工作负载类型,支持Deployment、StatefulSet、DaemonSet、CronJob、Job。", "example": "Deployment" }, { "name": "WorkloadName", "type": "string", "required": true, "description": "应用所在TKE集群工作负载名称", "example": "testdeploy" }, { "name": "ContainerName", "type": "string", "required": true, "description": "应用所在TKE集群工作负载下容器名称", "example": "nginx" }, { "name": "ClusterRegion", "type": "integer", "required": true, "description": "应用所在TKE集群地域", "example": "16" }, { "name": "InvokeExpr", "type": "string", "required": false, "description": "触发方式对应的表达式", "example": "release*" } ], "required": [ "RepoName", "TriggerName", "InvokeMethod", "ClusterId", "Namespace", "WorkloadType", "WorkloadName", "ContainerName", "ClusterRegion" ] }, { "name": "CreateGCJob", "description": "创建 GC 作业", "status": "online", "parameters": [ { "name": "RegistryId", "type": "string", "required": true, "description": "实例 Id", "example": "tcr-test134" }, { "name": "GCParameters", "type": "object", "required": false, "description": "GC 参数", "example": "无", "children": [ { "name": "Dryrun", "type": "boolean", "required": false, "description": "模拟运行", "example": "true" } ] } ], "required": [ "RegistryId" ] }, { "name": "CreateImageAccelerationService", "description": "创建镜像加速服务", "status": "online", "parameters": [ { "name": "RegistryId", "type": "string", "required": true, "description": "实例Id", "example": "tcr-dg284imq" }, { "name": "VpcId", "type": "string", "required": true, "description": "创建CFS的归属的VPCID", "example": "vpc-adsvxsd" }, { "name": "SubnetId", "type": "string", "required": true, "description": "创建CFS的归属的子网ID", "example": "subnet-sfdafes" }, { "name": "StorageType", "type": "string", "required": true, "description": "创建CFS的存储类型，其中 SD 为标准型存储， HP为性能存储。", "example": "SD" }, { "name": "PGroupId", "type": "string", "required": true, "description": "权限组 ID", "example": "groupID" }, { "name": "Zone", "type": "string", "required": true, "description": "可用区名称，例如ap-beijing-1，请参考 概览 文档中的地域与可用区列表", "example": "ap-guangzhou" }, { "name": "TagSpecification", "type": "object", "required": false, "description": "云标签描述", "example": "无", "children": [ { "name": "ResourceType", "type": "string", "required": true, "description": "默认值为instance", "example": "namespace" }, { "name": "Tags", "type": "array", "required": true, "description": "云标签数组", "example": "[{\"Key\":\"nico\",\"Value\":\"nico-resource\"}]", "item_type": "object", "children": [ { "name": "Key", "type": "string", "required": true, "description": "云标签的key", "example": "tag-key" }, { "name": "Value", "type": "string", "required": true, "description": "云标签的值", "example": "tag-value" } ] } ] } ], "required": [ "RegistryId", "VpcId", "SubnetId", "StorageType", "PGroupId", "Zone" ] }, { "name": "CreateImmutableTagRules", "description": "创建镜像不可变规则", "status": "online", "parameters": [ { "name": "RegistryId", "type": "string", "required": true, "description": "实例 Id", "example": "tcr-test134" }, { "name": "NamespaceName", "type": "string", "required": true, "description": "命名空间", "example": "library" }, { "name": "Rule", "type": "object", "required": true, "description": "规则", "example": "无", "children": [ { "name": "RepositoryPattern", "type": "string", "required": true, "description": "仓库匹配规则", "example": "**" }, { "name": "TagPattern", "type": "string", "required": true, "description": "Tag 匹配规则", "example": "**" }, { "name": "RepositoryDecoration", "type": "string", "required": true, "description": "repoMatches或repoExcludes", "example": "repoMatches" }, { "name": "TagDecoration", "type": "string", "required": true, "description": "matches或excludes", "example": "matches" }, { "name": "Disabled", "type": "boolean", "required": false, "description": "禁用规则", "example": "false" }, { "name": "RuleId", "type": "integer", "required": false, "description": "规则 Id", "example": "6" }, { "name": "NsName", "type": "string", "required": false, "description": "命名空间", "example": "library" } ] } ], "required": [ "RegistryId", "NamespaceName", "Rule" ] }, { "name": "CreateInstance", "description": "创建实例", "status": "online", "parameters": [ { "name": "RegistryName", "type": "string", "required": true, "description": "企业版实例名称", "example": "tcr-test" }, { "name": "RegistryType", "type": "string", "required": true, "description": "企业版实例类型（basic 基础版；standard 标准版；premium 高级版）", "example": "basic" }, { "name": "TagSpecification", "type": "object", "required": false, "description": "云标签描述", "example": "test", "children": [ { "name": "ResourceType", "type": "string", "required": true, "description": "默认值为instance", "example": "namespace" }, { "name": "Tags", "type": "array", "required": true, "description": "云标签数组", "example": "[{\"Key\":\"nico\",\"Value\":\"nico-resource\"}]", "item_type": "object", "children": [ { "name": "Key", "type": "string", "required": true, "description": "云标签的key", "example": "tag-key" }, { "name": "Value", "type": "string", "required": true, "description": "云标签的值", "example": "tag-value" } ] } ] }, { "name": "RegistryChargeType", "type": "integer", "required": false, "description": "实例计费类型，0表示按量计费，1表示预付费，默认为按量计费", "example": "1" }, { "name": "RegistryChargePrepaid", "type": "object", "required": false, "description": "预付费自动续费标识和购买时长", "example": "1 ", "children": [ { "name": "Period", "type": "integer", "required": true, "description": "购买实例的时长，单位：月", "example": "12" }, { "name": "RenewFlag", "type": "integer", "required": true, "description": "自动续费标识，0：手动续费，1：自动续费，2：不续费并且不通知", "example": "0" } ] }, { "name": "SyncTag", "type": "boolean", "required": false, "description": "是否同步TCR云标签至生成的COS Bucket", "example": "false" }, { "name": "EnableCosMAZ", "type": "boolean", "required": false, "description": "是否开启Cos桶多AZ特性", "example": "true" }, { "name": "DeletionProtection", "type": "boolean", "required": false, "description": "是否开启实例删除保护", "example": "true" } ], "required": [ "RegistryName", "RegistryType" ] }, { "name": "CreateInstanceCustomizedDomain", "description": "创建自定义域名", "status": "online", "parameters": [ { "name": "RegistryId", "type": "string", "required": true, "description": "主实例iD", "example": "tcr-test123" }, { "name": "DomainName", "type": "string", "required": true, "description": "自定义域名", "example": "test.com" }, { "name": "CertificateId", "type": "string", "required": true, "description": "证书ID", "example": "kWGTVuU3" } ], "required": [ "RegistryId", "DomainName", "CertificateId" ] }, { "name": "CreateInstanceToken", "description": "创建实例的临时或长期访问凭证", "status": "online", "parameters": [ { "name": "RegistryId", "type": "string", "required": true, "description": "实例Id", "example": "tcr-dg284imq" }, { "name": "TokenType", "type": "string", "required": false, "description": "访问凭证类型，longterm 为长期访问凭证，temp 为临时访问凭证，默认是临时访问凭证，有效期1小时", "example": "longterm" }, { "name": "Desc", "type": "string", "required": false, "description": "长期访问凭证描述信息", "example": "desc" } ], "required": [ "RegistryId" ] }, { "name": "CreateInternalEndpointDns", "description": "创建tcr内网私有域名解析", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "tcr实例id", "example": "tcr-dg284imq" }, { "name": "VpcId", "type": "string", "required": true, "description": "私有网络id", "example": "vpc-9iazgkcl" }, { "name": "EniLBIp", "type": "string", "required": true, "description": "tcr内网访问链路ip", "example": "192.168.23.69" }, { "name": "UsePublicDomain", "type": "boolean", "required": false, "description": "true：为默认域名，公网域名一致 false: 使用vpc域名 默认为vpc域名", "example": "true" }, { "name": "RegionName", "type": "string", "required": false, "description": "解析地域，需要保证和vpc处于同一地域，如果不填则默认为主实例地域", "example": "ap-guangzhou" }, { "name": "RegionId", "type": "integer", "required": false, "description": "请求的地域ID，用于实例复制地域", "example": "1" } ], "required": [ "InstanceId", "VpcId", "EniLBIp" ] }, { "name": "CreateMultipleSecurityPolicy", "description": "用于在TCR实例中，创建多个白名单策略", "status": "online", "parameters": [ { "name": "RegistryId", "type": "string", "required": true, "description": "实例Id", "example": "tcr-dg284imq" }, { "name": "SecurityGroupPolicySet", "type": "array", "required": true, "description": "安全组策略", "example": "[{},{}]", "item_type": "object", "children": [ { "name": "PolicyIndex", "type": "integer", "required": false, "description": "策略索引", "example": "0" }, { "name": "Description", "type": "string", "required": false, "description": "备注", "example": "mytest" }, { "name": "CidrBlock", "type": "string", "required": false, "description": "运行访问的公网IP地址端", "example": "192.168.1.0/24" }, { "name": "PolicyVersion", "type": "string", "required": false, "description": "安全策略的版本", "example": "0" } ] } ], "required": [ "RegistryId", "SecurityGroupPolicySet" ] }, { "name": "CreateNamespace", "description": "用于在企业版中创建命名空间", "status": "online", "parameters": [ { "name": "RegistryId", "type": "string", "required": true, "description": "实例ID", "example": "tcr-okmj78" }, { "name": "NamespaceName", "type": "string", "required": true, "description": "命名空间的名称（长度2-30个字符，只能包含小写字母、数字及分隔符(\".\"、\"_\"、\"-\")，且不能以分隔符开头、结尾或连续）", "example": "mytest" }, { "name": "IsPublic", "type": "boolean", "required": true, "description": "是否公开，true为公开，fale为私有", "example": "true" }, { "name": "TagSpecification", "type": "object", "required": false, "description": "云标签描述", "example": "无", "children": [ { "name": "ResourceType", "type": "string", "required": true, "description": "默认值为instance", "example": "namespace" }, { "name": "Tags", "type": "array", "required": true, "description": "云标签数组", "example": "[{\"Key\":\"nico\",\"Value\":\"nico-resource\"}]", "item_type": "object", "children": [ { "name": "Key", "type": "string", "required": true, "description": "云标签的key", "example": "tag-key" }, { "name": "Value", "type": "string", "required": true, "description": "云标签的值", "example": "tag-value" } ] } ] }, { "name": "IsAutoScan", "type": "boolean", "required": false, "description": "自动扫描级别，true为自动，false为手动", "example": "true" }, { "name": "IsPreventVUL", "type": "boolean", "required": false, "description": "安全阻断级别，true为自动，false为手动", "example": "true" }, { "name": "Severity", "type": "string", "required": false, "description": "阻断漏洞等级，目前仅支持low、medium、high", "example": "low" }, { "name": "CVEWhitelistItems", "type": "array", "required": false, "description": "漏洞白名单列表", "example": "无", "item_type": "object", "children": [ { "name": "CVEID", "type": "string", "required": false, "description": "漏洞白名单 ID", "example": "1" } ] } ], "required": [ "RegistryId", "NamespaceName", "IsPublic" ] }, { "name": "CreateNamespacePersonal", "description": "创建个人版镜像仓库命名空间，此命名空间全局唯一", "status": "online", "parameters": [ { "name": "Namespace", "type": "string", "required": true, "description": "命名空间名称", "example": "mynamespace" } ], "required": [ "Namespace" ] }, { "name": "CreateReplicationInstance", "description": "创建从实例", "status": "online", "parameters": [ { "name": "RegistryId", "type": "string", "required": true, "description": "主实例iD", "example": "tcr-12345" }, { "name": "ReplicationRegionId", "type": "integer", "required": false, "description": "复制实例地域ID", "example": "5" }, { "name": "ReplicationRegionName", "type": "string", "required": false, "description": "复制实例地域名称", "example": "ap-beijing" }, { "name": "SyncTag", "type": "boolean", "required": false, "description": "是否同步TCR云标签至生成的COS Bucket", "example": "false" } ], "required": [ "RegistryId" ] }, { "name": "CreateRepository", "description": "用于企业版创建镜像仓库", "status": "online", "parameters": [ { "name": "RegistryId", "type": "string", "required": true, "description": "实例ID", "example": "tcr-okmju7" }, { "name": "NamespaceName", "type": "string", "required": true, "description": "命名空间名称", "example": "team-01" }, { "name": "RepositoryName", "type": "string", "required": true, "description": "仓库名称，需满足以下规则： 1. 长度需 ​大于2且小于245个字符 2. 仅允许小写字母、数字及符号 . _ -", "example": "nginx" }, { "name": "BriefDescription", "type": "string", "required": false, "description": "仓库简短描述", "example": "this is brief description" }, { "name": "Description", "type": "string", "required": false, "description": "仓库详细描述", "example": "this is description" } ], "required": [ "RegistryId", "NamespaceName", "RepositoryName" ] }, { "name": "CreateRepositoryPersonal", "description": "用于在个人版仓库中创建镜像仓库", "status": "online", "parameters": [ { "name": "RepoName", "type": "string", "required": true, "description": "仓库名称，格式为 {Namespace}/{lmageName}。", "example": "namespace/image" }, { "name": "Public", "type": "integer", "required": false, "description": "是否公共,1:公共,0:私有", "example": "1" }, { "name": "Description", "type": "string", "required": false, "description": "仓库描述", "example": "desc" } ], "required": [ "RepoName" ] }, { "name": "CreateSecurityPolicy", "description": "创建实例公网访问白名单策略", "status": "online", "parameters": [ { "name": "RegistryId", "type": "string", "required": true, "description": "实例Id", "example": "tcr-dg284imq" }, { "name": "CidrBlock", "type": "string", "required": true, "description": "192.168.0.0/24", "example": "192.168.0.0/24" }, { "name": "Description", "type": "string", "required": true, "description": "备注", "example": "desc" } ], "required": [ "RegistryId", "CidrBlock", "Description" ] }, { "name": "CreateServiceAccount", "description": "创建服务级账户", "status": "online", "parameters": [ { "name": "RegistryId", "type": "string", "required": true, "description": "实例Id", "example": "tcr-dg284imq" }, { "name": "Name", "type": "string", "required": true, "description": "服务级账号名", "example": "servie-account3" }, { "name": "Permissions", "type": "array", "required": true, "description": "策略列表", "example": "[{\"Resource\":\"ns1\",\"Actions\":[\"tcr:PushRepository\",\"tcr:PullRepository\"]}]", "item_type": "object", "children": [ { "name": "Resource", "type": "string", "required": true, "description": "资源路径，目前仅支持Namespace", "example": "library" }, { "name": "Actions", "type": "array", "required": true, "description": "动作，目前仅支持：tcr:PushRepository、tcr:PullRepository、tcr:CreateRepository、tcr:CreateHelmChart、tcr:DescribeHelmCharts", "example": "[\"tcr:PushRepository\", \"tcr:PullRepository\"]", "item_type": "string" } ] }, { "name": "Description", "type": "string", "required": false, "description": "服务级账号描述", "example": "desc" }, { "name": "Duration", "type": "integer", "required": false, "description": "有效期(单位：天)，从当前时间开始计算，优先级高于ExpiresAt", "example": "10" }, { "name": "ExpiresAt", "type": "integer", "required": false, "description": "过期时间（时间戳，单位:毫秒）", "example": "1676897989000" }, { "name": "Disable", "type": "boolean", "required": false, "description": "是否禁用服务级账号", "example": "false" } ], "required": [ "RegistryId", "Name", "Permissions" ] }, { "name": "CreateSignature", "description": "为一个镜像版本创建签名", "status": "online", "parameters": [ { "name": "RegistryId", "type": "string", "required": true, "description": "实例ID", "example": "tcr-okmju7" }, { "name": "NamespaceName", "type": "string", "required": true, "description": "命名空间名称", "example": "library" }, { "name": "RepositoryName", "type": "string", "required": true, "description": "仓库名称", "example": "nginx" }, { "name": "ImageVersion", "type": "string", "required": true, "description": "Tag名称", "example": "v1.2.0" } ], "required": [ "RegistryId", "NamespaceName", "RepositoryName", "ImageVersion" ] }, { "name": "CreateSignaturePolicy", "description": "创建镜像签名策略", "status": "online", "parameters": [ { "name": "RegistryId", "type": "string", "required": true, "description": "实例 Id", "example": "tcr-test134" }, { "name": "Name", "type": "string", "required": true, "description": "策略名称", "example": "library加签" }, { "name": "NamespaceName", "type": "string", "required": true, "description": "命名空间名称", "example": "library" }, { "name": "KmsId", "type": "string", "required": true, "description": "KMS 密钥", "example": "08408a30-0416-11ed-abdc-52540036b432" }, { "name": "KmsRegion", "type": "string", "required": true, "description": "KMS 密钥所属地域", "example": "ap-guangzhou" }, { "name": "Domain", "type": "string", "required": false, "description": "用户自定义域名，为空时使用 TCR 实例默认域名生成签名", "example": "tcr.tencentcloudcr.com" }, { "name": "Disabled", "type": "boolean", "required": false, "description": "禁用加签策略，默认为 false", "example": "false" } ], "required": [ "RegistryId", "Name", "NamespaceName", "KmsId", "KmsRegion" ] }, { "name": "CreateTagRetentionExecution", "description": "手动执行版本保留", "status": "online", "parameters": [ { "name": "RegistryId", "type": "string", "required": true, "description": "主实例iD", "example": "tcr-test123" }, { "name": "RetentionId", "type": "integer", "required": true, "description": "版本保留规则Id", "example": "1" }, { "name": "DryRun", "type": "boolean", "required": false, "description": "是否模拟执行，默认值为false，即非模拟执行", "example": "false" } ], "required": [ "RegistryId", "RetentionId" ] }, { "name": "CreateTagRetentionRule", "description": "创建版本保留规则", "status": "online", "parameters": [ { "name": "RegistryId", "type": "string", "required": true, "description": "主实例iD", "example": "tcr-test123" }, { "name": "NamespaceId", "type": "integer", "required": true, "description": "命名空间的Id", "example": "1" }, { "name": "CronSetting", "type": "string", "required": true, "description": "执行周期，当前只能选择： manual;daily;weekly;monthly", "example": "manual" }, { "name": "RetentionRule", "type": "object", "required": false, "description": "保留策略，当基本保留策略和高级保留策略同时配置时，优先使用高级保留策略", "example": "无", "children": [ { "name": "Key", "type": "string", "required": true, "description": "支持的策略，可选值为latestPushedK（保留最新推送多少个版本）nDaysSinceLastPush（保留近天内推送）", "example": "latestPushedK" }, { "name": "Value", "type": "integer", "required": true, "description": "规则设置下的对应值", "example": "0" } ] }, { "name": "AdvancedRuleItems", "type": "array", "required": false, "description": "高级版本保留策略，当基本保留策略和高级保留策略同时配置时，优先使用高级保留策略", "example": "无", "item_type": "object", "children": [ { "name": "RetentionPolicy", "type": "object", "required": false, "description": "版本保留规则", "example": "无", "children": [ { "name": "Key", "type": "string", "required": true, "description": "支持的策略，可选值为latestPushedK（保留最新推送多少个版本）nDaysSinceLastPush（保留近天内推送）", "example": "latestPushedK" }, { "name": "Value", "type": "integer", "required": true, "description": "规则设置下的对应值", "example": "0" } ] }, { "name": "TagFilter", "type": "object", "required": false, "description": "标签过滤器", "example": "无", "children": [ { "name": "Decoration", "type": "string", "required": false, "description": "过滤规则类型，在tag过滤中，可选值为matches（匹配），excludes(排除)，在仓库过滤中，可选值为repoMatches（仓库匹配），repoExcludes（仓库排除）", "example": "matches" }, { "name": "Pattern", "type": "string", "required": false, "description": "过滤表达式", "example": "v*" } ] }, { "name": "RepositoryFilter", "type": "object", "required": false, "description": "仓库过滤器", "example": "无", "children": [ { "name": "Decoration", "type": "string", "required": false, "description": "过滤规则类型，在tag过滤中，可选值为matches（匹配），excludes(排除)，在仓库过滤中，可选值为repoMatches（仓库匹配），repoExcludes（仓库排除）", "example": "matches" }, { "name": "Pattern", "type": "string", "required": false, "description": "过滤表达式", "example": "v*" } ] } ] }, { "name": "Disabled", "type": "boolean", "required": false, "description": "是否禁用规则，默认值为false", "example": "false" } ], "required": [ "RegistryId", "NamespaceId", "CronSetting" ] }, { "name": "CreateUserPersonal", "description": "创建个人用户", "status": "online", "parameters": [ { "name": "Password", "type": "string", "required": true, "description": "用户密码，密码必须为8到16位", "example": "ux0HKy2CFn" } ], "required": [ "Password" ] }, { "name": "CreateWebhookTrigger", "description": "创建触发器", "status": "online", "parameters": [ { "name": "RegistryId", "type": "string", "required": true, "description": "实例 Id", "example": "tcr-dg284imq" }, { "name": "Trigger", "type": "object", "required": true, "description": "触发器参数", "example": "{\"Id\":5,\"Name\":\"trigger5\",\"Description\":\"desc\",\"Targets\":[]}", "children": [ { "name": "Name", "type": "string", "required": true, "description": "触发器名称", "example": "tirgger" }, { "name": "Targets", "type": "array", "required": true, "description": "触发器目标", "example": "[{\"Address\":\"http://www.baidu.com\",\"Headers\":[{\"Key\":\"\",\"Values\":[\"undefined\"]}]}]", "item_type": "object", "children": [ { "name": "Address", "type": "string", "required": true, "description": "目标地址", "example": "http://www.baidu.com" }, { "name": "Headers", "type": "array", "required": false, "description": "自定义 Headers", "example": "[{\"Key\":\"key1\",\"Values\":[\"v1\",\"v2\"]}]", "item_type": "object", "children": [ { "name": "Key", "type": "string", "required": true, "description": "Header Key", "example": "key" }, { "name": "Values", "type": "array", "required": true, "description": "Header Values", "example": "value", "item_type": "string" } ] } ] }, { "name": "EventTypes", "type": "array", "required": true, "description": "触发动作", "example": "[\"pushImage\"]", "item_type": "string" }, { "name": "Condition", "type": "string", "required": true, "description": "触发规则", "example": "golang" }, { "name": "Enabled", "type": "boolean", "required": true, "description": "启用触发器", "example": "true" }, { "name": "Id", "type": "integer", "required": false, "description": "触发器Id", "example": "2" }, { "name": "Description", "type": "string", "required": false, "description": "触发器描述", "example": "desc" }, { "name": "NamespaceId", "type": "integer", "required": false, "description": "触发器所属命名空间 Id", "example": "1" }, { "name": "NamespaceName", "type": "string", "required": false, "description": "触发器所属命名空间名称", "example": "ns1" } ] }, { "name": "Namespace", "type": "string", "required": true, "description": "命名空间", "example": "ns" } ], "required": [ "RegistryId", "Trigger", "Namespace" ] }, { "name": "DeleteApplicationTriggerPersonal", "description": "用于删除应用更新触发器", "status": "online", "parameters": [ { "name": "TriggerName", "type": "string", "required": true, "description": "触发器名称", "example": "trigger1" } ], "required": [ "TriggerName" ] }, { "name": "DeleteImage", "description": "删除指定镜像", "status": "online", "parameters": [ { "name": "RegistryId", "type": "string", "required": true, "description": "实例Id", "example": "tcr-dg284imq" }, { "name": "NamespaceName", "type": "string", "required": true, "description": "命名空间名称", "example": "multi-arch" }, { "name": "RepositoryName", "type": "string", "required": true, "description": "镜像仓库名称", "example": "alpine" }, { "name": "ImageVersion", "type": "string", "required": true, "description": "镜像版本", "example": "1" } ], "required": [ "RegistryId", "NamespaceName", "RepositoryName", "ImageVersion" ] }, { "name": "DeleteImageAccelerateService", "description": "删除镜像加速服务", "status": "online", "parameters": [ { "name": "RegistryId", "type": "string", "required": true, "description": "实例Id", "example": "tcr-dg284imq" } ], "required": [ "RegistryId" ] }, { "name": "DeleteImageLifecycleGlobalPersonal", "description": "用于删除个人版全局镜像版本自动清理策略", "status": "online", "parameters": [], "required": [] }, { "name": "DeleteImagePersonal", "description": "用于在个人版中删除tag", "status": "online", "parameters": [ { "name": "RepoName", "type": "string", "required": true, "description": "仓库名称", "example": "nicokang/golang" }, { "name": "Tag", "type": "string", "required": true, "description": "Tag名", "example": "1" } ], "required": [ "RepoName", "Tag" ] }, { "name": "DeleteImmutableTagRules", "description": "删除镜像不可变规则", "status": "online", "parameters": [ { "name": "RegistryId", "type": "string", "required": true, "description": "实例 Id", "example": "tcr-dg284imq" }, { "name": "NamespaceName", "type": "string", "required": true, "description": "命名空间", "example": "ns" }, { "name": "RuleId", "type": "integer", "required": true, "description": "规则 Id", "example": "1" } ], "required": [ "RegistryId", "NamespaceName", "RuleId" ] }, { "name": "DeleteInstance", "description": "删除镜像仓库企业版实例", "status": "online", "parameters": [ { "name": "RegistryId", "type": "string", "required": true, "description": "实例id", "example": "tcr-abc123" }, { "name": "DeleteBucket", "type": "boolean", "required": false, "description": "是否删除存储桶，默认为false", "example": "true" }, { "name": "DryRun", "type": "boolean", "required": false, "description": "是否dryRun模式，缺省值：false", "example": "false" } ], "required": [ "RegistryId" ] }, { "name": "DeleteInstanceCustomizedDomain", "description": "删除自定义域名", "status": "online", "parameters": [ { "name": "RegistryId", "type": "string", "required": true, "description": "主实例iD", "example": "tcr-test123" }, { "name": "DomainName", "type": "string", "required": true, "description": "自定义域名", "example": "test.com" }, { "name": "CertificateId", "type": "string", "required": false, "description": "证书ID", "example": "kWGTVuU3" } ], "required": [ "RegistryId", "DomainName" ] }, { "name": "DeleteInstanceToken", "description": "删除长期访问凭证", "status": "online", "parameters": [ { "name": "RegistryId", "type": "string", "required": true, "description": "实例 ID", "example": "tcr-dg284imq" }, { "name": "TokenId", "type": "string", "required": true, "description": "访问凭证 ID", "example": "ct3ucep1qcle9n4kmv00" } ], "required": [ "RegistryId", "TokenId" ] }, { "name": "DeleteInternalEndpointDns", "description": "删除tcr内网私有域名解析", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "tcr实例id", "example": "tcr-dg284imq" }, { "name": "VpcId", "type": "string", "required": true, "description": "私有网络id", "example": "vpc-9iazgkcl" }, { "name": "EniLBIp", "type": "string", "required": true, "description": "tcr内网访问链路ip", "example": "192.168.23.69" }, { "name": "UsePublicDomain", "type": "boolean", "required": false, "description": "true：使用默认域名 false: 使用带有vpc的域名", "example": "true" }, { "name": "RegionName", "type": "string", "required": false, "description": "解析地域，需要保证和vpc处于同一地域，如果不填则默认为主实例地域", "example": "ap-guangzhou" } ], "required": [ "InstanceId", "VpcId", "EniLBIp" ] }, { "name": "DeleteMultipleSecurityPolicy", "description": "用于删除实例多个公网访问白名单策略", "status": "online", "parameters": [ { "name": "RegistryId", "type": "string", "required": true, "description": "实例Id", "example": "tcr-test134" }, { "name": "SecurityGroupPolicySet", "type": "array", "required": true, "description": "安全组策略", "example": "无", "item_type": "object", "children": [ { "name": "PolicyIndex", "type": "integer", "required": false, "description": "策略索引", "example": "0" }, { "name": "Description", "type": "string", "required": false, "description": "备注", "example": "mytest" }, { "name": "CidrBlock", "type": "string", "required": false, "description": "运行访问的公网IP地址端", "example": "192.168.1.0/24" }, { "name": "PolicyVersion", "type": "string", "required": false, "description": "安全策略的版本", "example": "0" } ] } ], "required": [ "RegistryId", "SecurityGroupPolicySet" ] }, { "name": "DeleteNamespace", "description": "删除命名空间", "status": "online", "parameters": [ { "name": "RegistryId", "type": "string", "required": true, "description": "实例ID", "example": "tcr-okmj78" }, { "name": "NamespaceName", "type": "string", "required": true, "description": "命名空间的名称", "example": "mytest" } ], "required": [ "RegistryId", "NamespaceName" ] }, { "name": "DeleteNamespacePersonal", "description": "删除共享版命名空间", "status": "online", "parameters": [ { "name": "Namespace", "type": "string", "required": true, "description": "命名空间名称", "example": "nico-ns1" } ], "required": [ "Namespace" ] }, { "name": "DeleteReplicationInstance", "description": "删除从实例", "status": "online", "parameters": [ { "name": "RegistryId", "type": "string", "required": true, "description": "实例id", "example": "tcr-12345" }, { "name": "ReplicationRegistryId", "type": "string", "required": true, "description": "复制实例ID", "example": "tcr-12345-5" }, { "name": "ReplicationRegionId", "type": "integer", "required": true, "description": "复制实例地域Id", "example": "5" } ], "required": [ "RegistryId", "ReplicationRegistryId", "ReplicationRegionId" ] }, { "name": "DeleteReplicationRule", "description": "删除实例同步规则", "status": "online", "parameters": [ { "name": "SourceRegistryId", "type": "string", "required": true, "description": "源实例ID", "example": "tcr-40s86s0j" }, { "name": "RuleName", "type": "string", "required": true, "description": "同步规则名称", "example": "rule-1" }, { "name": "Description", "type": "string", "required": false, "description": "规则描述", "example": "删除同步规则rule-1" } ], "required": [ "SourceRegistryId", "RuleName" ] }, { "name": "DeleteRepository", "description": "删除镜像仓库", "status": "online", "parameters": [ { "name": "RegistryId", "type": "string", "required": true, "description": "实例Id", "example": "tcr-dg284imq" }, { "name": "NamespaceName", "type": "string", "required": true, "description": "命名空间的名称", "example": "private" }, { "name": "RepositoryName", "type": "string", "required": true, "description": "镜像仓库的名称", "example": "golang" }, { "name": "ForceDelete", "type": "boolean", "required": false, "description": "默认值为true，表示无论仓库是否存在镜像都直接删除；false代表删除仓库前需检查是否存在镜像。", "example": "true" } ], "required": [ "RegistryId", "NamespaceName", "RepositoryName" ] }, { "name": "DeleteRepositoryPersonal", "description": "用于个人版镜像仓库中删除", "status": "online", "parameters": [ { "name": "RepoName", "type": "string", "required": true, "description": "仓库名称", "example": "nicokang/golang1" } ], "required": [ "RepoName" ] }, { "name": "DeleteRepositoryTags", "description": "用于企业版批量删除Repository Tag", "status": "online", "parameters": [ { "name": "RegistryId", "type": "string", "required": true, "description": "实例ID", "example": "tcr-dg284imq" }, { "name": "NamespaceName", "type": "string", "required": true, "description": "命名空间名称", "example": "public" }, { "name": "RepositoryName", "type": "string", "required": true, "description": "仓库名称", "example": "golang" }, { "name": "Tags", "type": "array", "required": true, "description": "Tag列表，单次请求Tag数量最大为20", "example": "[\"1\",\"2\"]", "item_type": "string" } ], "required": [ "RegistryId", "NamespaceName", "RepositoryName", "Tags" ] }, { "name": "DeleteSecurityPolicy", "description": "删除实例公网访问白名单策略 注意：当PolicyIndex和CidrBlock同时存在时，CidrBlock优先级更高", "status": "online", "parameters": [ { "name": "RegistryId", "type": "string", "required": true, "description": "实例Id", "example": "tcr-test134" }, { "name": "PolicyIndex", "type": "integer", "required": false, "description": "白名单Id", "example": "1" }, { "name": "PolicyVersion", "type": "string", "required": false, "description": "白名单版本", "example": "10" }, { "name": "CidrBlock", "type": "string", "required": false, "description": "网段或IP(互斥)", "example": "1.1.1.1/20" } ], "required": [ "RegistryId" ] }, { "name": "DeleteServiceAccount", "description": "删除服务级账号", "status": "online", "parameters": [ { "name": "RegistryId", "type": "string", "required": true, "description": "实例Id", "example": "tcr-dg284imq" }, { "name": "Name", "type": "string", "required": true, "description": "服务级账号名", "example": "tcr$servie-account3" } ], "required": [ "RegistryId", "Name" ] }, { "name": "DeleteSignaturePolicy", "description": "删除命名空间加签策略", "status": "online", "parameters": [ { "name": "RegistryId", "type": "string", "required": true, "description": "实例ID", "example": "tcr-okmj78" }, { "name": "NamespaceName", "type": "string", "required": true, "description": "命名空间的名称", "example": "library" } ], "required": [ "RegistryId", "NamespaceName" ] }, { "name": "DeleteTagRetentionRule", "description": "删除版本保留规则", "status": "online", "parameters": [ { "name": "RegistryId", "type": "string", "required": true, "description": "主实例iD", "example": "tcr-test123" }, { "name": "RetentionId", "type": "integer", "required": true, "description": "版本保留规则的Id", "example": "1" } ], "required": [ "RegistryId", "RetentionId" ] }, { "name": "DeleteWebhookTrigger", "description": "删除触发器", "status": "online", "parameters": [ { "name": "RegistryId", "type": "string", "required": true, "description": "实例Id", "example": "tcr-dg284imq" }, { "name": "Namespace", "type": "string", "required": true, "description": "命名空间", "example": "ns" }, { "name": "Id", "type": "integer", "required": true, "description": "触发器 Id", "example": "6" } ], "required": [ "RegistryId", "Namespace", "Id" ] }, { "name": "DescribeApplicationTriggerLogPersonal", "description": "用于查询应用更新触发器触发日志", "status": "online", "parameters": [ { "name": "RepoName", "type": "string", "required": false, "description": "仓库名称", "example": "ccs-dev/nginx" }, { "name": "Offset", "type": "integer", "required": false, "description": "偏移量，默认为0", "example": "0" }, { "name": "Limit", "type": "integer", "required": false, "description": "返回最大数量，默认 20, 最大值 100", "example": "10" }, { "name": "Order", "type": "string", "required": false, "description": "升序或降序", "example": "desc" }, { "name": "OrderBy", "type": "string", "required": false, "description": "按某列排序", "example": "invoke_time" } ], "required": [] }, { "name": "DescribeApplicationTriggerPersonal", "description": "用于查询应用更新触发器", "status": "online", "parameters": [ { "name": "RepoName", "type": "string", "required": false, "description": "仓库名称", "example": "ns/repo" }, { "name": "TriggerName", "type": "string", "required": false, "description": "触发器名称", "example": "trigger" }, { "name": "Offset", "type": "integer", "required": false, "description": "偏移量，默认为0", "example": "0" }, { "name": "Limit", "type": "integer", "required": false, "description": "返回最大数量，默认 20, 最大值 100", "example": "3" } ], "required": [] }, { "name": "DescribeChartDownloadInfo", "description": "用于在企业版中返回Chart的下载信息", "status": "online", "parameters": [ { "name": "RegistryId", "type": "string", "required": true, "description": "实例ID", "example": "tcr-test134" }, { "name": "NamespaceName", "type": "string", "required": true, "description": "命名空间", "example": "testgroup" }, { "name": "ChartName", "type": "string", "required": true, "description": "Chart包的名称", "example": "mychart" }, { "name": "ChartVersion", "type": "string", "required": true, "description": "Chart包的版本", "example": "1.0" } ], "required": [ "RegistryId", "NamespaceName", "ChartName", "ChartVersion" ] }, { "name": "DescribeExternalEndpointStatus", "description": "查询实例公网访问入口状态", "status": "online", "parameters": [ { "name": "RegistryId", "type": "string", "required": true, "description": "实例Id", "example": "tcr-test123" } ], "required": [ "RegistryId" ] }, { "name": "DescribeFavorRepositoryPersonal", "description": "查询个人收藏仓库", "status": "online", "parameters": [ { "name": "RepoName", "type": "string", "required": true, "description": "仓库名称", "example": "nicokang/golang" }, { "name": "Limit", "type": "integer", "required": true, "description": "分页Limit", "example": "10" }, { "name": "Offset", "type": "integer", "required": true, "description": "Offset用于分页", "example": "0" } ], "required": [ "RepoName", "Limit", "Offset" ] }, { "name": "DescribeGCJobs", "description": "GC 最近10条历史", "status": "online", "parameters": [ { "name": "RegistryId", "type": "string", "required": true, "description": "实例 Id", "example": "tcr-test134" } ], "required": [ "RegistryId" ] }, { "name": "DescribeImageAccelerateService", "description": "查询镜像加速服务状态", "status": "online", "parameters": [ { "name": "RegistryId", "type": "string", "required": true, "description": "实例Id", "example": "tcr-dg284imq" } ], "required": [ "RegistryId" ] }, { "name": "DescribeImageFilterPersonal", "description": "用于在个人版中查询与指定tag镜像内容相同的tag列表", "status": "online", "parameters": [ { "name": "RepoName", "type": "string", "required": true, "description": "仓库名称", "example": "nicokang/golang" }, { "name": "Tag", "type": "string", "required": true, "description": "Tag名", "example": "4" } ], "required": [ "RepoName", "Tag" ] }, { "name": "DescribeImageLifecycleGlobalPersonal", "description": "用于获取个人版全局镜像版本自动清理策略", "status": "online", "parameters": [], "required": [] }, { "name": "DescribeImageLifecyclePersonal", "description": "用于获取个人版仓库中自动清理策略", "status": "online", "parameters": [ { "name": "RepoName", "type": "string", "required": true, "description": "仓库名称", "example": "nicokang/golang" } ], "required": [ "RepoName" ] }, { "name": "DescribeImageManifests", "description": "查询容器镜像Manifest信息", "status": "online", "parameters": [ { "name": "RegistryId", "type": "string", "required": true, "description": "实例ID", "example": "tcr-dg284imq" }, { "name": "NamespaceName", "type": "string", "required": true, "description": "命名空间名称", "example": "hbd" }, { "name": "RepositoryName", "type": "string", "required": true, "description": "镜像仓库名称", "example": "repo1" }, { "name": "ImageVersion", "type": "string", "required": true, "description": "镜像版本", "example": "1" } ], "required": [ "RegistryId", "NamespaceName", "RepositoryName", "ImageVersion" ] }, { "name": "DescribeImagePersonal", "description": "用于获取个人版镜像仓库tag列表", "status": "online", "parameters": [ { "name": "RepoName", "type": "string", "required": true, "description": "仓库名称", "example": "nsName/repoName" }, { "name": "Offset", "type": "integer", "required": false, "description": "偏移量，默认为0", "example": "0" }, { "name": "Limit", "type": "integer", "required": false, "description": "返回最大数量，默认 20, 最大值 100", "example": "20" }, { "name": "Tag", "type": "string", "required": false, "description": "tag名称，可根据输入搜索", "example": "tag" } ], "required": [ "RepoName" ] }, { "name": "DescribeImages", "description": "查询镜像版本列表或指定容器镜像信息", "status": "online", "parameters": [ { "name": "RegistryId", "type": "string", "required": true, "description": "实例ID", "example": "tcr-okmj78" }, { "name": "NamespaceName", "type": "string", "required": true, "description": "命名空间名称", "example": "team-01" }, { "name": "RepositoryName", "type": "string", "required": true, "description": "镜像仓库名称", "example": "nginx" }, { "name": "ImageVersion", "type": "string", "required": false, "description": "指定镜像版本进行查找，当前为模糊搜索", "example": "1.0" }, { "name": "Limit", "type": "integer", "required": false, "description": "每页个数，用于分页，默认20", "example": "20" }, { "name": "Offset", "type": "integer", "required": false, "description": "页数，默认值为1 补充说明：limit指的是每页的大小，offset指的是具体第几页。 举例：limit 20 offset 1指的是1-20；limit 20 offset 2 指的是21-40；limit 30 offset 4 是指 90-120。", "example": "1" }, { "name": "Digest", "type": "string", "required": false, "description": "指定镜像 Digest 进行查找", "example": "sha256:a1801b843b1bfaf77c501e7a6d3f709401a1e0c83863037fa3aab063a" }, { "name": "ExactMatch", "type": "boolean", "required": false, "description": "指定是否为精准匹配，true为精准匹配，不填为模糊匹配", "example": "false" } ], "required": [ "RegistryId", "NamespaceName", "RepositoryName" ] }, { "name": "DescribeImmutableTagRules", "description": "列出镜像不可变规则", "status": "online", "parameters": [ { "name": "RegistryId", "type": "string", "required": true, "description": "实例 Id", "example": "tcr-dg284imq" }, { "name": "Page", "type": "integer", "required": false, "description": "页数，默认为1", "example": "1" }, { "name": "PageSize", "type": "integer", "required": false, "description": "每页展示个数，最大值为100", "example": "100" } ], "required": [ "RegistryId" ] }, { "name": "DescribeInstanceAllNamespaces", "description": "查询所有有实例命名空间列表", "status": "online", "parameters": [ { "name": "Limit", "type": "integer", "required": false, "description": "每页个数", "example": "5" }, { "name": "Offset", "type": "integer", "required": false, "description": "起始偏移位置", "example": "0" } ], "required": [] }, { "name": "DescribeInstanceCustomizedDomain", "description": "查询实例自定义域名列表", "status": "online", "parameters": [ { "name": "RegistryId", "type": "string", "required": true, "description": "主实例iD", "example": "tcr-test123" }, { "name": "Limit", "type": "integer", "required": false, "description": "分页Limit", "example": "10" }, { "name": "Offset", "type": "integer", "required": false, "description": "分页Offset", "example": "0" } ], "required": [ "RegistryId" ] }, { "name": "DescribeInstanceStatus", "description": "查询实例当前状态以及过程信息", "status": "online", "parameters": [ { "name": "RegistryIds", "type": "array", "required": true, "description": "实例ID的数组", "example": "[\"tcr-dg284imq\"]", "item_type": "string" } ], "required": [ "RegistryIds" ] }, { "name": "DescribeInstanceToken", "description": "查询长期访问凭证信息", "status": "online", "parameters": [ { "name": "RegistryId", "type": "string", "required": true, "description": "实例 ID", "example": "tcr-dg284imq" }, { "name": "Limit", "type": "integer", "required": false, "description": "分页单页数量", "example": "20" }, { "name": "Offset", "type": "integer", "required": false, "description": "分页偏移量", "example": "1" } ], "required": [ "RegistryId" ] }, { "name": "DescribeInstances", "description": "查询实例信息", "status": "online", "parameters": [ { "name": "Registryids", "type": "array", "required": false, "description": "实例ID列表(为空时， 表示获取账号下所有实例)", "example": "[\"tcr-dg284imq\"]", "item_type": "string" }, { "name": "Offset", "type": "integer", "required": false, "description": "偏移量,默认0", "example": "0" }, { "name": "Limit", "type": "integer", "required": false, "description": "最大输出条数，默认20，最大为100", "example": "20" }, { "name": "Filters", "type": "array", "required": false, "description": "过滤条件", "example": "nil", "item_type": "object", "children": [ { "name": "Name", "type": "string", "required": true, "description": "属性名称, 若存在多个Filter时，Filter间的关系为逻辑与（AND）关系。", "example": "Tags" }, { "name": "Values", "type": "array", "required": true, "description": "属性值, 若同一个Filter存在多个Values，同一Filter下Values间的关系为逻辑或（OR）关系。", "example": "[\"nico:nico-resource\"]", "item_type": "string" } ] }, { "name": "AllRegion", "type": "boolean", "required": false, "description": "获取所有地域的实例，默认为False", "example": "true" } ], "required": [] }, { "name": "DescribeInternalEndpointDnsStatus", "description": "批量查询vpc是否已经添加私有域名解析", "status": "online", "parameters": [ { "name": "VpcSet", "type": "array", "required": true, "description": "vpc列表", "example": "[{\"InstanceId\":\"tcr-dg284imq\",\"VpcId\":\"vpc-5sdsx9k9\",\"EniLBIp\":\"10.0.25.33\",\"UsePublicDomain\":true,\"RegionName\":\"ap-guangzhou\"}]", "item_type": "object", "children": [ { "name": "InstanceId", "type": "string", "required": true, "description": "tcr实例id", "example": "tcr-dg284imq" }, { "name": "VpcId", "type": "string", "required": true, "description": "私有网络id", "example": "vpc-5sdsx9k9" }, { "name": "EniLBIp", "type": "string", "required": true, "description": "tcr内网访问链路ip", "example": "10.0.25.33" }, { "name": "UsePublicDomain", "type": "boolean", "required": false, "description": "true：use instance name as subdomain false: use instancename+\"-vpc\" as subdomain", "example": "true" }, { "name": "RegionName", "type": "string", "required": false, "description": "解析地域，需要保证和vpc处于同一地域，如果不填则默认为主实例地域", "example": "ap-guangzhou" } ] } ], "required": [ "VpcSet" ] }, { "name": "DescribeInternalEndpoints", "description": "查询实例内网访问VPC链接", "status": "online", "parameters": [ { "name": "RegistryId", "type": "string", "required": true, "description": "实例Id", "example": "tcr-xxxx" } ], "required": [ "RegistryId" ] }, { "name": "DescribeNamespacePersonal", "description": "查询个人版命名空间信息", "status": "online", "parameters": [ { "name": "Namespace", "type": "string", "required": true, "description": "命名空间，支持模糊查询", "example": "nicokang" }, { "name": "Limit", "type": "integer", "required": true, "description": "单页数量", "example": "10" }, { "name": "Offset", "type": "integer", "required": true, "description": "偏移量", "example": "0" } ], "required": [ "Namespace", "Limit", "Offset" ] }, { "name": "DescribeNamespaces", "description": "查询命名空间列表或指定命名空间信息", "status": "online", "parameters": [ { "name": "RegistryId", "type": "string", "required": true, "description": "实例Id", "example": "tcr-f7g1ir99" }, { "name": "NamespaceName", "type": "string", "required": false, "description": "指定命名空间，不填写默认查询所有命名空间", "example": "project1" }, { "name": "Limit", "type": "integer", "required": false, "description": "每页个数", "example": "20" }, { "name": "Offset", "type": "integer", "required": false, "description": "页面偏移（第几页）", "example": "0" }, { "name": "All", "type": "boolean", "required": false, "description": "列出所有命名空间", "example": "0" }, { "name": "Filters", "type": "array", "required": false, "description": "过滤条件 - 按照【标签】过滤 Name: Tags Value: tagKey:tagVal", "example": "无", "item_type": "object", "children": [ { "name": "Name", "type": "string", "required": true, "description": "属性名称, 若存在多个Filter时，Filter间的关系为逻辑与（AND）关系。", "example": "Tags" }, { "name": "Values", "type": "array", "required": true, "description": "属性值, 若同一个Filter存在多个Values，同一Filter下Values间的关系为逻辑或（OR）关系。", "example": "[\"nico:nico-resource\"]", "item_type": "string" } ] }, { "name": "KmsSignPolicy", "type": "boolean", "required": false, "description": "仅查询启用了 KMS 镜像签名的空间", "example": "false" } ], "required": [ "RegistryId" ] }, { "name": "DescribeRegions", "description": "用于在TCR中获取可用区域", "status": "online", "parameters": [], "required": [] }, { "name": "DescribeReplicationInstanceCreateTasks", "description": "查询创建从实例任务状态", "status": "online", "parameters": [ { "name": "ReplicationRegistryId", "type": "string", "required": true, "description": "同步实例Id，见实例返回列表中的同步实例ID", "example": "tcr-dg284imq-5-os5gcu" }, { "name": "ReplicationRegionId", "type": "integer", "required": true, "description": "同步实例的地域ID，见实例返回列表中地域ID", "example": "5" } ], "required": [ "ReplicationRegistryId", "ReplicationRegionId" ] }, { "name": "DescribeReplicationInstanceSyncStatus", "description": "查询从实例同步状态", "status": "online", "parameters": [ { "name": "RegistryId", "type": "string", "required": true, "description": "主实例Id", "example": "tcr-12345" }, { "name": "ReplicationRegistryId", "type": "string", "required": true, "description": "复制实例Id", "example": "tcr-12345-5" }, { "name": "ReplicationRegionId", "type": "integer", "required": false, "description": "复制实例的地域Id", "example": "5" }, { "name": "ShowReplicationLog", "type": "boolean", "required": false, "description": "是否显示同步日志", "example": "false" }, { "name": "Offset", "type": "integer", "required": false, "description": "日志页号, 默认0", "example": "1" }, { "name": "Limit", "type": "integer", "required": false, "description": "最大输出条数，默认5，最大为20", "example": "5" } ], "required": [ "RegistryId", "ReplicationRegistryId" ] }, { "name": "DescribeReplicationInstances", "description": "查询从实例列表", "status": "online", "parameters": [ { "name": "RegistryId", "type": "string", "required": true, "description": "实例Id", "example": "tcr-12345" }, { "name": "Offset", "type": "integer", "required": false, "description": "偏移量,默认0", "example": "0" }, { "name": "Limit", "type": "integer", "required": false, "description": "最大输出条数，默认20，最大为100", "example": "10" } ], "required": [ "RegistryId" ] }, { "name": "DescribeReplicationPolicies", "description": "获取实例同步规则列表", "status": "online", "parameters": [ { "name": "RegistryId", "type": "string", "required": true, "description": "实例ID", "example": "tcr-xxx" }, { "name": "Page", "type": "integer", "required": false, "description": "页数，默认为1", "example": "1" }, { "name": "PageSize", "type": "integer", "required": false, "description": "每页展示个数，默认为100", "example": "20" } ], "required": [ "RegistryId" ] }, { "name": "DescribeRepositories", "description": "查询镜像仓库列表或指定镜像仓库信息", "status": "online", "parameters": [ { "name": "RegistryId", "type": "string", "required": true, "description": "实例Id", "example": "tcr-dg284imq" }, { "name": "NamespaceName", "type": "string", "required": false, "description": "指定命名空间，不填写默认为查询所有命名空间下镜像仓库", "example": "multi-arch" }, { "name": "RepositoryName", "type": "string", "required": false, "description": "指定镜像仓库，不填写默认查询指定命名空间下所有镜像仓库", "example": "busybox" }, { "name": "Offset", "type": "integer", "required": false, "description": "页数，第几页，用于分页", "example": "1" }, { "name": "Limit", "type": "integer", "required": false, "description": "每页个数，用于分页，最大值为100", "example": "10" }, { "name": "SortBy", "type": "string", "required": false, "description": "基于字段排序，支持的值有-creation_time,-name, -update_time", "example": "-name" } ], "required": [ "RegistryId" ] }, { "name": "DescribeRepositoryFilterPersonal", "description": "用于在个人版镜像仓库中，获取满足输入搜索条件的用户镜像仓库", "status": "online", "parameters": [ { "name": "RepoName", "type": "string", "required": false, "description": "搜索镜像名", "example": "golang-test" }, { "name": "Offset", "type": "integer", "required": false, "description": "偏移量，默认为0", "example": "1" }, { "name": "Limit", "type": "integer", "required": false, "description": "返回最大数量，默认 20，最大100", "example": "10" }, { "name": "Public", "type": "integer", "required": false, "description": "筛选条件：1表示public，0表示private", "example": "0" }, { "name": "Namespace", "type": "string", "required": false, "description": "命名空间", "example": "nicokang" } ], "required": [] }, { "name": "DescribeRepositoryOwnerPersonal", "description": "用于在个人版中获取用户全部的镜像仓库列表", "status": "online", "parameters": [ { "name": "Offset", "type": "integer", "required": false, "description": "偏移量，默认为0", "example": "0" }, { "name": "Limit", "type": "integer", "required": false, "description": "返回最大数量，默认 20, 最大值 100", "example": "10" }, { "name": "RepoName", "type": "string", "required": false, "description": "仓库名称", "example": "nicokang/golang" } ], "required": [] }, { "name": "DescribeRepositoryPersonal", "description": "查询个人版仓库信息", "status": "online", "parameters": [ { "name": "RepoName", "type": "string", "required": true, "description": "仓库名字", "example": "nicokang/golang" } ], "required": [ "RepoName" ] }, { "name": "DescribeSecurityPolicies", "description": "查询实例公网访问白名单策略", "status": "online", "parameters": [ { "name": "RegistryId", "type": "string", "required": true, "description": "实例的Id", "example": "tcr-dg284imq" } ], "required": [ "RegistryId" ] }, { "name": "DescribeServiceAccounts", "description": "查询服务级账号", "status": "online", "parameters": [ { "name": "RegistryId", "type": "string", "required": true, "description": "实例Id", "example": "tcr-dg284imq" }, { "name": "All", "type": "boolean", "required": false, "description": "列出所有服务级账号", "example": "true" }, { "name": "EmbedPermission", "type": "boolean", "required": false, "description": "是否填充权限信息", "example": "true" }, { "name": "Filters", "type": "array", "required": false, "description": "过滤条件，key 目前只支持ServiceAccountName", "example": "[{\"Name\":\"ServiceAccountName\",\"Values\":[\"tcr$account_test\"]}]", "item_type": "object", "children": [ { "name": "Name", "type": "string", "required": true, "description": "属性名称, 若存在多个Filter时，Filter间的关系为逻辑与（AND）关系。", "example": "Tags" }, { "name": "Values", "type": "array", "required": true, "description": "属性值, 若同一个Filter存在多个Values，同一Filter下Values间的关系为逻辑或（OR）关系。", "example": "[\"nico:nico-resource\"]", "item_type": "string" } ] }, { "name": "Offset", "type": "integer", "required": false, "description": "偏移量,默认0", "example": "1" }, { "name": "Limit", "type": "integer", "required": false, "description": "最大输出条数，默认20，最大为100（超出最大值，调整到最大值）", "example": "10" } ], "required": [ "RegistryId" ] }, { "name": "DescribeTagRetentionExecution", "description": "查询版本保留执行记录", "status": "online", "parameters": [ { "name": "RegistryId", "type": "string", "required": true, "description": "主实例iD", "example": "tcr-test123" }, { "name": "RetentionId", "type": "integer", "required": true, "description": "规则Id", "example": "1" }, { "name": "Limit", "type": "integer", "required": false, "description": "分页PageSize", "example": "20" }, { "name": "Offset", "type": "integer", "required": false, "description": "分页Page", "example": "1" } ], "required": [ "RegistryId", "RetentionId" ] }, { "name": "DescribeTagRetentionExecutionTask", "description": "查询版本保留执行任务", "status": "online", "parameters": [ { "name": "RegistryId", "type": "string", "required": true, "description": "主实例iD", "example": "tcr-test123" }, { "name": "RetentionId", "type": "integer", "required": true, "description": "规则Id", "example": "1" }, { "name": "ExecutionId", "type": "integer", "required": true, "description": "规则执行Id", "example": "1" }, { "name": "Offset", "type": "integer", "required": false, "description": "页数，第几页，用于分页", "example": "1" }, { "name": "Limit", "type": "integer", "required": false, "description": "每页个数，用于分页，最大值为100", "example": "10" } ], "required": [ "RegistryId", "RetentionId", "ExecutionId" ] }, { "name": "DescribeTagRetentionRules", "description": "查询镜像版本保留规则", "status": "online", "parameters": [ { "name": "RegistryId", "type": "string", "required": true, "description": "主实例iD", "example": "tcr-dg284imq" }, { "name": "NamespaceName", "type": "string", "required": false, "description": "命名空间的名称", "example": "ns2" }, { "name": "Limit", "type": "integer", "required": false, "description": "分页PageSize", "example": "10" }, { "name": "Offset", "type": "integer", "required": false, "description": "分页Page", "example": "1" } ], "required": [ "RegistryId" ] }, { "name": "DescribeUserQuotaPersonal", "description": "查询个人用户配额", "status": "online", "parameters": [], "required": [] }, { "name": "DescribeWebhookTrigger", "description": "查询触发器", "status": "online", "parameters": [ { "name": "RegistryId", "type": "string", "required": true, "description": "实例Id", "example": "tcr-dg284imq" }, { "name": "Limit", "type": "integer", "required": false, "description": "分页单页数量", "example": "10" }, { "name": "Offset", "type": "integer", "required": false, "description": "分页偏移量", "example": "1" }, { "name": "Namespace", "type": "string", "required": false, "description": "命名空间", "example": "ns1" } ], "required": [ "RegistryId" ] }, { "name": "DescribeWebhookTriggerLog", "description": "获取触发器日志", "status": "online", "parameters": [ { "name": "RegistryId", "type": "string", "required": true, "description": "实例 Id", "example": "tcr-xxx" }, { "name": "Namespace", "type": "string", "required": true, "description": "命名空间", "example": "ns" }, { "name": "Id", "type": "integer", "required": false, "description": "触发器 Id", "example": "10" }, { "name": "Limit", "type": "integer", "required": false, "description": "分页单页数量", "example": "20" }, { "name": "Offset", "type": "integer", "required": false, "description": "分页偏移量", "example": "0" } ], "required": [ "RegistryId", "Namespace" ] }, { "name": "DownloadHelmChart", "description": "用于在TCR中下载helm chart", "status": "online", "parameters": [ { "name": "RegistryId", "type": "string", "required": true, "description": "实例ID", "example": "tcr-dg284imq" }, { "name": "NamespaceName", "type": "string", "required": true, "description": "命名空间名称", "example": "chart" }, { "name": "ChartName", "type": "string", "required": true, "description": "Helm chart名称", "example": "mychart" }, { "name": "ChartVersion", "type": "string", "required": true, "description": "Helm chart版本", "example": "0.1.0" } ], "required": [ "RegistryId", "NamespaceName", "ChartName", "ChartVersion" ] }, { "name": "DuplicateImage", "description": "用于在企业版镜像仓库中复制镜像版本", "status": "online", "parameters": [ { "name": "RegistryId", "type": "string", "required": true, "description": "实例id", "example": "tcr-e8pg46c6" }, { "name": "SourceNamespace", "type": "string", "required": true, "description": "源命名空间名称", "example": "develop" }, { "name": "SourceRepo", "type": "string", "required": true, "description": "源镜像仓库名称", "example": "app" }, { "name": "SourceReference", "type": "string", "required": true, "description": "源镜像tag或digest值，目前仅支持tag", "example": "v1.0" }, { "name": "DestinationTag", "type": "string", "required": true, "description": "目标镜像版本", "example": "v1.0" }, { "name": "DestinationNamespace", "type": "string", "required": false, "description": "目标命名空间，不填默认与源一致", "example": "release" }, { "name": "DestinationRepo", "type": "string", "required": false, "description": "目标镜像仓库，不填默认与源一致", "example": "app" }, { "name": "Override", "type": "boolean", "required": false, "description": "是否覆盖", "example": "true" } ], "required": [ "RegistryId", "SourceNamespace", "SourceRepo", "SourceReference", "DestinationTag" ] }, { "name": "DuplicateImagePersonal", "description": "用于在个人版镜像仓库中复制镜像版本", "status": "online", "parameters": [ { "name": "SrcImage", "type": "string", "required": true, "description": "源镜像名称，不包含domain。例如： tencentyun/foo:v1", "example": "dockerhub/test:1.0" }, { "name": "DestImage", "type": "string", "required": true, "description": "目的镜像名称，不包含domain。例如： tencentyun/foo:latest", "example": "dockerhub/test:2.0" } ], "required": [ "SrcImage", "DestImage" ] }, { "name": "ManageExternalEndpoint", "description": "管理实例公网访问", "status": "online", "parameters": [ { "name": "RegistryId", "type": "string", "required": true, "description": "实例Id", "example": "tcr-dg284imq" }, { "name": "Operation", "type": "string", "required": true, "description": "操作（Create/Delete）", "example": "Create" } ], "required": [ "RegistryId", "Operation" ] }, { "name": "ManageImageLifecycleGlobalPersonal", "description": "用于设置个人版全局镜像版本自动清理策略", "status": "online", "parameters": [ { "name": "Type", "type": "string", "required": true, "description": "global_keep_last_days:全局保留最近几天的数据;global_keep_last_nums:全局保留最近多少个", "example": "global_keep_last_nums" }, { "name": "Val", "type": "integer", "required": true, "description": "策略值", "example": "9998" } ], "required": [ "Type", "Val" ] }, { "name": "ManageInternalEndpoint", "description": "管理实例内网访问VPC链接", "status": "online", "parameters": [ { "name": "RegistryId", "type": "string", "required": true, "description": "实例Id", "example": "tcr-dg284imq" }, { "name": "Operation", "type": "string", "required": true, "description": "Create/Delete", "example": "Create" }, { "name": "VpcId", "type": "string", "required": true, "description": "需要接入的用户vpcid", "example": "vpc-74ffq7ov" }, { "name": "SubnetId", "type": "string", "required": true, "description": "需要接入的用户子网id", "example": "subnet-kpmi5ji6" }, { "name": "RegionId", "type": "integer", "required": false, "description": "请求的地域ID，用于实例复制地域", "example": "5" }, { "name": "RegionName", "type": "string", "required": false, "description": "请求的地域名称，用于实例复制地域", "example": "ap-beijing" } ], "required": [ "RegistryId", "Operation", "VpcId", "SubnetId" ] }, { "name": "ManageReplication", "description": "管理实例同步", "status": "online", "parameters": [ { "name": "SourceRegistryId", "type": "string", "required": true, "description": "复制源实例ID", "example": "tcr-dg284imq" }, { "name": "DestinationRegistryId", "type": "string", "required": true, "description": "复制目标实例ID", "example": "tcr-7o4xeay9" }, { "name": "Rule", "type": "object", "required": true, "description": "同步规则", "example": "{\"Name\":\"rule2\",\"DestNamespace\":\"ns2\",\"Override\":false,\"Filters\":[{\"Type\":\"name\",\"Value\":\"ns2/**\"}]}", "children": [ { "name": "Name", "type": "string", "required": true, "description": "同步规则名称", "example": "rule1" }, { "name": "DestNamespace", "type": "string", "required": true, "description": "目标命名空间", "example": "ns" }, { "name": "Override", "type": "boolean", "required": true, "description": "是否覆盖", "example": "false" }, { "name": "Filters", "type": "array", "required": true, "description": "同步过滤条件", "example": "[{\"Type\":\"name\",\"Value\":\"ns/**\"}]", "item_type": "object", "children": [ { "name": "Type", "type": "string", "required": true, "description": "类型（name、tag和resource）", "example": "tag" }, { "name": "Value", "type": "string", "required": false, "description": "默认为空", "example": "release**" } ] }, { "name": "Deletion", "type": "boolean", "required": false, "description": "是否同步删除事件", "example": "false" } ] }, { "name": "Description", "type": "string", "required": false, "description": "规则描述", "example": "gz-sync2bj" }, { "name": "DestinationRegionId", "type": "integer", "required": false, "description": "目标实例的地域ID，如广州是1", "example": "8" }, { "name": "PeerReplicationOption", "type": "object", "required": false, "description": "开启跨主账号实例同步配置项", "example": "无", "children": [ { "name": "PeerRegistryUin", "type": "string", "required": true, "description": "待同步实例的uin", "example": "3321337994" }, { "name": "PeerRegistryToken", "type": "string", "required": true, "description": "待同步实例的访问永久Token", "example": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJvd25lclVpbiI6IjMzMjEzMzc5OTQifQ.jG7JQl-8zytEj5vI7WN8aMArzsdt71-ZhRUSvzBqbpo" }, { "name": "EnablePeerReplication", "type": "boolean", "required": true, "description": "是否开启跨主账号实例同步", "example": "true" } ] } ], "required": [ "SourceRegistryId", "DestinationRegistryId", "Rule" ] }, { "name": "ModifyApplicationTriggerPersonal", "description": "用于修改应用更新触发器", "status": "online", "parameters": [ { "name": "RepoName", "type": "string", "required": false, "description": "触发器关联的镜像仓库，library/test格式", "example": "test/test123" }, { "name": "TriggerName", "type": "string", "required": false, "description": "触发器名称，必填参数", "example": "testtrig" }, { "name": "InvokeMethod", "type": "string", "required": false, "description": "触发方式，\"all\"全部触发，\"taglist\"指定tag触发，\"regex\"正则触发", "example": "all" }, { "name": "InvokeExpr", "type": "string", "required": false, "description": "触发方式对应的表达式", "example": "release*" }, { "name": "ClusterId", "type": "string", "required": false, "description": "应用所在TKE集群ID", "example": "cls-xxxxxxxx" }, { "name": "Namespace", "type": "string", "required": false, "description": "应用所在TKE集群命名空间", "example": "default" }, { "name": "WorkloadType", "type": "string", "required": false, "description": "应用所在TKE集群工作负载类型,支持Deployment、StatefulSet、DaemonSet、CronJob、Job。", "example": "Deployment" }, { "name": "WorkloadName", "type": "string", "required": false, "description": "应用所在TKE集群工作负载名称", "example": "testdeploy" }, { "name": "ContainerName", "type": "string", "required": false, "description": "应用所在TKE集群工作负载下容器名称", "example": "nginx" }, { "name": "ClusterRegion", "type": "integer", "required": false, "description": "应用所在TKE集群地域数字ID，如1（广州）、16（成都）", "example": "16" }, { "name": "NewTriggerName", "type": "string", "required": false, "description": "新触发器名称", "example": "test2" } ], "required": [] }, { "name": "ModifyImmutableTagRules", "description": "更新镜像不可变规则", "status": "online", "parameters": [ { "name": "RegistryId", "type": "string", "required": true, "description": "实例 Id", "example": "tcr-dg284imq" }, { "name": "NamespaceName", "type": "string", "required": true, "description": "命名空间", "example": "private" }, { "name": "RuleId", "type": "integer", "required": true, "description": "规则 Id", "example": "2" }, { "name": "Rule", "type": "object", "required": true, "description": "规则", "example": "无", "children": [ { "name": "RepositoryPattern", "type": "string", "required": true, "description": "仓库匹配规则", "example": "**" }, { "name": "TagPattern", "type": "string", "required": true, "description": "Tag 匹配规则", "example": "**" }, { "name": "RepositoryDecoration", "type": "string", "required": true, "description": "repoMatches或repoExcludes", "example": "repoMatches" }, { "name": "TagDecoration", "type": "string", "required": true, "description": "matches或excludes", "example": "matches" }, { "name": "Disabled", "type": "boolean", "required": false, "description": "禁用规则", "example": "false" }, { "name": "RuleId", "type": "integer", "required": false, "description": "规则 Id", "example": "6" }, { "name": "NsName", "type": "string", "required": false, "description": "命名空间", "example": "library" } ] } ], "required": [ "RegistryId", "NamespaceName", "RuleId", "Rule" ] }, { "name": "ModifyInstance", "description": "更新实例信息", "status": "online", "parameters": [ { "name": "RegistryId", "type": "string", "required": true, "description": "实例ID", "example": "tcr-abc123" }, { "name": "RegistryType", "type": "string", "required": false, "description": "实例的规格, 基础版：basic 标准版：standard 高级版：premium", "example": "premium" }, { "name": "DeletionProtection", "type": "boolean", "required": false, "description": "实例删除保护，false为关闭", "example": "false" } ], "required": [ "RegistryId" ] }, { "name": "ModifyInstanceStorage", "description": "TCR实例存储桶切换", "status": "online", "parameters": [ { "name": "RegistryId", "type": "string", "required": true, "description": "实例ID", "example": "tcr-dc0d****" }, { "name": "TargetRegion", "type": "string", "required": true, "description": "目标存储资源地域", "example": "ap-chengdu" }, { "name": "TargetStorageName", "type": "string", "required": true, "description": "目标存储资源名称", "example": "tcr-dc0d****-1255******" } ], "required": [ "RegistryId", "TargetRegion", "TargetStorageName" ] }, { "name": "ModifyInstanceToken", "description": "更新实例内指定长期访问凭证的启用状态", "status": "online", "parameters": [ { "name": "TokenId", "type": "string", "required": true, "description": "实例长期访问凭证 ID", "example": "ct3ucep1qcle9n4kmv00" }, { "name": "RegistryId", "type": "string", "required": true, "description": "实例 ID", "example": "tcr-dg284imq" }, { "name": "Enable", "type": "boolean", "required": false, "description": "启用或禁用实例长期访问凭证", "example": "false" }, { "name": "Desc", "type": "string", "required": false, "description": "访问凭证描述", "example": "update desc" }, { "name": "ModifyFlag", "type": "integer", "required": false, "description": "1为修改描述 2为操作启动禁用，默认值为2", "example": "1" } ], "required": [ "TokenId", "RegistryId" ] }, { "name": "ModifyNamespace", "description": "更新命名空间信息", "status": "online", "parameters": [ { "name": "RegistryId", "type": "string", "required": true, "description": "实例Id", "example": "tcr-xxx" }, { "name": "NamespaceName", "type": "string", "required": true, "description": "命名空间名称", "example": "nginx" }, { "name": "IsPublic", "type": "boolean", "required": false, "description": "访问级别，True为公开，False为私有", "example": "false" }, { "name": "IsAutoScan", "type": "boolean", "required": false, "description": "扫描级别，True为自动，False为手动", "example": "false" }, { "name": "IsPreventVUL", "type": "boolean", "required": false, "description": "阻断开关，True为开放，False为关闭", "example": "false" }, { "name": "Severity", "type": "string", "required": false, "description": "阻断漏洞等级，目前仅支持 low、medium、high", "example": "high" }, { "name": "CVEWhitelistItems", "type": "array", "required": false, "description": "漏洞白名单列表", "example": "无", "item_type": "object", "children": [ { "name": "CVEID", "type": "string", "required": false, "description": "漏洞白名单 ID", "example": "1" } ] } ], "required": [ "RegistryId", "NamespaceName" ] }, { "name": "ModifyRepository", "description": "更新镜像仓库信息，可修改仓库描述信息", "status": "online", "parameters": [ { "name": "RegistryId", "type": "string", "required": true, "description": "实例ID", "example": "tcr-dg284imq" }, { "name": "NamespaceName", "type": "string", "required": true, "description": "命名空间名称", "example": "ns1" }, { "name": "RepositoryName", "type": "string", "required": true, "description": "镜像仓库名称", "example": "golang" }, { "name": "BriefDescription", "type": "string", "required": true, "description": "仓库简短描述", "example": "golang" }, { "name": "Description", "type": "string", "required": true, "description": "仓库详细描述", "example": "golang" } ], "required": [ "RegistryId", "NamespaceName", "RepositoryName", "BriefDescription", "Description" ] }, { "name": "ModifyRepositoryAccessPersonal", "description": "用于更新个人版镜像仓库的访问属性", "status": "online", "parameters": [ { "name": "RepoName", "type": "string", "required": true, "description": "仓库名称", "example": "dockerhub/test" }, { "name": "Public", "type": "integer", "required": true, "description": "默认值为0, 1公共，0私有", "example": "1" } ], "required": [ "RepoName", "Public" ] }, { "name": "ModifyRepositoryInfoPersonal", "description": "用于在个人版镜像仓库中更新容器镜像描述", "status": "online", "parameters": [ { "name": "RepoName", "type": "string", "required": true, "description": "仓库名称", "example": "nicokang/golang" }, { "name": "Description", "type": "string", "required": true, "description": "仓库描述", "example": "desc1" } ], "required": [ "RepoName", "Description" ] }, { "name": "ModifySecurityPolicy", "description": "更新实例公网访问白名单", "status": "online", "parameters": [ { "name": "RegistryId", "type": "string", "required": true, "description": "实例的Id", "example": "tcr-dg284imq" }, { "name": "PolicyIndex", "type": "integer", "required": true, "description": "PolicyId", "example": "2" }, { "name": "CidrBlock", "type": "string", "required": true, "description": "192.168.0.0/24 白名单Ip", "example": "3.3.3.3" }, { "name": "Description", "type": "string", "required": true, "description": "备注", "example": "update access ip" } ], "required": [ "RegistryId", "PolicyIndex", "CidrBlock", "Description" ] }, { "name": "ModifyServiceAccount", "description": "更新服务级账号", "status": "online", "parameters": [ { "name": "RegistryId", "type": "string", "required": true, "description": "实例Id", "example": "tcr-dg284imq" }, { "name": "Name", "type": "string", "required": true, "description": "服务级账号名", "example": "tcr$service-account2" }, { "name": "Description", "type": "string", "required": false, "description": "服务级账号描述", "example": "desc 1" }, { "name": "Duration", "type": "integer", "required": false, "description": "有效期(单位：天)，从当前时间开始计算，优先级高于ExpiresAt", "example": "10" }, { "name": "ExpiresAt", "type": "integer", "required": false, "description": "过期时间（时间戳，单位:毫秒）", "example": "1676897989" }, { "name": "Disable", "type": "boolean", "required": false, "description": "是否禁用服务级账号", "example": "true" }, { "name": "Permissions", "type": "array", "required": false, "description": "策略列表", "example": "{ \"Resource\": \"library\", \"Actions\": [\"tcr:PushRepository\", \"tcr:PullRepository\"] }", "item_type": "object", "children": [ { "name": "Resource", "type": "string", "required": true, "description": "资源路径，目前仅支持Namespace", "example": "library" }, { "name": "Actions", "type": "array", "required": true, "description": "动作，目前仅支持：tcr:PushRepository、tcr:PullRepository、tcr:CreateRepository、tcr:CreateHelmChart、tcr:DescribeHelmCharts", "example": "[\"tcr:PushRepository\", \"tcr:PullRepository\"]", "item_type": "string" } ] } ], "required": [ "RegistryId", "Name" ] }, { "name": "ModifyServiceAccountPassword", "description": "更新服务级账号密码", "status": "online", "parameters": [ { "name": "RegistryId", "type": "string", "required": true, "description": "实例Id", "example": "tcr-xxx" }, { "name": "Name", "type": "string", "required": true, "description": "服务级账号名", "example": "tcr$robot" }, { "name": "Random", "type": "boolean", "required": true, "description": "是否随机生成密码", "example": "true" }, { "name": "Password", "type": "string", "required": false, "description": "服务级账号密码，长度在8到20之间且需包含至少一个大写字符，一个小写字符和一个数字", "example": "MyPass" } ], "required": [ "RegistryId", "Name", "Random" ] }, { "name": "ModifyTagRetentionRule", "description": "更新版本保留规则", "status": "online", "parameters": [ { "name": "RegistryId", "type": "string", "required": true, "description": "主实例iD", "example": "tcr-test123" }, { "name": "NamespaceId", "type": "integer", "required": true, "description": "命名空间的Id，必须填写原有的命名空间id", "example": "1" }, { "name": "CronSetting", "type": "string", "required": true, "description": "执行周期，必须填写为原来的设置", "example": "manual" }, { "name": "RetentionId", "type": "integer", "required": true, "description": "规则Id", "example": "1" }, { "name": "RetentionRule", "type": "object", "required": false, "description": "保留策略，当基本保留策略和高级保留策略同时配置时，优先使用高级保留策略", "example": "无", "children": [ { "name": "Key", "type": "string", "required": true, "description": "支持的策略，可选值为latestPushedK（保留最新推送多少个版本）nDaysSinceLastPush（保留近天内推送）", "example": "latestPushedK" }, { "name": "Value", "type": "integer", "required": true, "description": "规则设置下的对应值", "example": "0" } ] }, { "name": "AdvancedRuleItems", "type": "array", "required": false, "description": "高级保留策略，当基本保留策略和高级保留策略同时配置时，优先使用高级保留策略", "example": "无", "item_type": "object", "children": [ { "name": "RetentionPolicy", "type": "object", "required": false, "description": "版本保留规则", "example": "无", "children": [ { "name": "Key", "type": "string", "required": true, "description": "支持的策略，可选值为latestPushedK（保留最新推送多少个版本）nDaysSinceLastPush（保留近天内推送）", "example": "latestPushedK" }, { "name": "Value", "type": "integer", "required": true, "description": "规则设置下的对应值", "example": "0" } ] }, { "name": "TagFilter", "type": "object", "required": false, "description": "标签过滤器", "example": "无", "children": [ { "name": "Decoration", "type": "string", "required": false, "description": "过滤规则类型，在tag过滤中，可选值为matches（匹配），excludes(排除)，在仓库过滤中，可选值为repoMatches（仓库匹配），repoExcludes（仓库排除）", "example": "matches" }, { "name": "Pattern", "type": "string", "required": false, "description": "过滤表达式", "example": "v*" } ] }, { "name": "RepositoryFilter", "type": "object", "required": false, "description": "仓库过滤器", "example": "无", "children": [ { "name": "Decoration", "type": "string", "required": false, "description": "过滤规则类型，在tag过滤中，可选值为matches（匹配），excludes(排除)，在仓库过滤中，可选值为repoMatches（仓库匹配），repoExcludes（仓库排除）", "example": "matches" }, { "name": "Pattern", "type": "string", "required": false, "description": "过滤表达式", "example": "v*" } ] } ] }, { "name": "Disabled", "type": "boolean", "required": false, "description": "是否禁用规则", "example": "false" } ], "required": [ "RegistryId", "NamespaceId", "CronSetting", "RetentionId" ] }, { "name": "ModifyUserPasswordPersonal", "description": "修改个人用户登录密码", "status": "online", "parameters": [ { "name": "Password", "type": "string", "required": true, "description": "更新后的密码", "example": "password" } ], "required": [ "Password" ] }, { "name": "ModifyWebhookTrigger", "description": "更新触发器", "status": "online", "parameters": [ { "name": "RegistryId", "type": "string", "required": true, "description": "实例Id", "example": "tcr-dg284imq" }, { "name": "Trigger", "type": "object", "required": true, "description": "触发器参数", "example": "无", "children": [ { "name": "Name", "type": "string", "required": true, "description": "触发器名称", "example": "tirgger" }, { "name": "Targets", "type": "array", "required": true, "description": "触发器目标", "example": "[{\"Address\":\"http://www.baidu.com\",\"Headers\":[{\"Key\":\"\",\"Values\":[\"undefined\"]}]}]", "item_type": "object", "children": [ { "name": "Address", "type": "string", "required": true, "description": "目标地址", "example": "http://www.baidu.com" }, { "name": "Headers", "type": "array", "required": false, "description": "自定义 Headers", "example": "[{\"Key\":\"key1\",\"Values\":[\"v1\",\"v2\"]}]", "item_type": "object", "children": [ { "name": "Key", "type": "string", "required": true, "description": "Header Key", "example": "key" }, { "name": "Values", "type": "array", "required": true, "description": "Header Values", "example": "value", "item_type": "string" } ] } ] }, { "name": "EventTypes", "type": "array", "required": true, "description": "触发动作", "example": "[\"pushImage\"]", "item_type": "string" }, { "name": "Condition", "type": "string", "required": true, "description": "触发规则", "example": "golang" }, { "name": "Enabled", "type": "boolean", "required": true, "description": "启用触发器", "example": "true" }, { "name": "Id", "type": "integer", "required": false, "description": "触发器Id", "example": "2" }, { "name": "Description", "type": "string", "required": false, "description": "触发器描述", "example": "desc" }, { "name": "NamespaceId", "type": "integer", "required": false, "description": "触发器所属命名空间 Id", "example": "1" }, { "name": "NamespaceName", "type": "string", "required": false, "description": "触发器所属命名空间名称", "example": "ns1" } ] }, { "name": "Namespace", "type": "string", "required": true, "description": "命名空间", "example": "ns1" } ], "required": [ "RegistryId", "Trigger", "Namespace" ] }, { "name": "RenewInstance", "description": "预付费实例续费，同时支持按量计费转包年包月", "status": "online", "parameters": [ { "name": "RegistryId", "type": "string", "required": true, "description": "实例Id", "example": "tcr-12345" }, { "name": "RegistryChargePrepaid", "type": "object", "required": true, "description": "预付费自动续费标识和购买时长,0：手动续费，1：自动续费，2：不续费并且不通知;单位为月", "example": "无", "children": [ { "name": "Period", "type": "integer", "required": true, "description": "购买实例的时长，单位：月", "example": "12" }, { "name": "RenewFlag", "type": "integer", "required": true, "description": "自动续费标识，0：手动续费，1：自动续费，2：不续费并且不通知", "example": "0" } ] }, { "name": "Flag", "type": "integer", "required": true, "description": "0 续费， 1按量转包年包月", "example": "0" } ], "required": [ "RegistryId", "RegistryChargePrepaid", "Flag" ] }, { "name": "TerminateGCJob", "description": "终止制品清理任务", "status": "online", "parameters": [ { "name": "RegistryId", "type": "string", "required": true, "description": "实例ID", "example": "tcr-dc0*****" } ], "required": [ "RegistryId" ] }, { "name": "ValidateNamespaceExistPersonal", "description": "查询个人版用户命名空间是否存在", "status": "online", "parameters": [ { "name": "Namespace", "type": "string", "required": true, "description": "命名空间名称", "example": "mynamespace" } ], "required": [ "Namespace" ] }, { "name": "ValidateRepositoryExistPersonal", "description": "用于判断个人版仓库是否存在", "status": "online", "parameters": [ { "name": "RepoName", "type": "string", "required": true, "description": "仓库名称", "example": "dockerhub/test" } ], "required": [ "RepoName" ] } ] }