API概览

更新时间:
复制 MD 格式

API标准及多语言预置SDK

本产品(cr/2018-12-01)的OpenAPI采用RPC签名风格。我们已经为开发者封装了常见编程语言的SDK,开发者可通过下载SDK直接调用本产品OpenAPI而无需关心技术细节。如果现有SDK不能满足使用需求,可通过签名机制进行自签名对接。由于自签名细节非常复杂,需花费 5个工作日左右。因此建议加入我们的服务钉钉群(147535001692),在专家指导下进行签名对接。

在使用API前,您需要准备好身份账号及访问密钥(AccessKey),才能有效通过客户端工具(SDK、CLI等)访问API。细节请参见获取AccessKey

自定义签名场景

若您的业务场景有特殊需求,需通过自签名方式对接 API,建议优先咨询我们的技术支持团队(服务钉钉群:147535001692),获取专业指导以确保高效接入。

账号与安全准备

阿里云账号具备对所有资源的完全管理权限。一旦 AccessKey 泄露,所有相关资源都将面临未经授权访问的风险。为确保安全,建议创建一个仅具备 API 访问权限的RAM用户并配置其 AccessKey,同时基于最小权限原则 (PoLP) 配置 RAM 策略。仅在明确需要阿里云账号权限的特定场景下,才使用阿里云账号。

制品订阅管理

API

标题

API概述

UpdateArtifactSubscriptionRule 更新制品订阅规则 更新制品订阅规则。
DeleteArtifactSubscriptionRule 删除制品订阅规则 删除制品订阅规则。
ListArtifactSubscriptionTask 列举制品订阅任务 列举制品订阅任务。
GetArtifactSubscriptionRule 查询制品订阅规则 查询制品订阅规则。
GetArtifactSubscriptionTaskResult 列举订阅任务详情 列举订阅任务详情。
CreateArtifactSubscriptionRule 创建制品订阅规则 创建制品订阅规则。
ListArtifactSubscriptionRule 列举制品订阅规则 列举制品订阅规则。
GetArtifactSubscriptionTask 获取制品订阅任务 获取制品订阅任务。
CreateArtifactSubscriptionTask 创建制品订阅任务 创建制品订阅任务。

制品生命周期管理

API

标题

API概述

UpdateArtifactLifecycleRule 更新制品生命周期管理规则 更新制品生命周期管理规则。
ListArtifactLifecycleRule 列举制品生命周期管理规则 列举制品生命周期管理规则。
GetArtifactLifecycleRule 查询制品生命周期管理规则 查询制品生命周期管理规则。
DeleteArtifactLifecycleRule 删除制品生命周期管理规则 删除制品生命周期管理规则。
CreateArtifactLifecycleRule 创建制品生命周期管理规则 创建制品生命周期管理规则。

标签

API

标题

API概述

TagResources 给资源打标签 给资源打标签。当前支持实例 Instance 资源。
UntagResources 删除资源标签 删除资源标签。当前支持实例 Instance 资源。
ListTagResources 查询资源标签关系 查询资源已经绑定的标签列表。当前支持实例 Instance 资源。

实例存储管理

API

标题

API概述

CreateStorageDomainRoutingRule 创建实例存储域名路由规则 创建实例存储域名路由规则。
DeleteStorageDomainRoutingRule 删除实例存储域名路由规则 删除实例存储域名路由规则。
GetStorageDomainRoutingRule 获取实例存储域名路由列表 获取实例存储域名路由列表
UpdateStorageDomainRoutingRule 更新实例存储域名路由规则 更新实例存储域名路由规则。

实例管理

API

标题

API概述

GetInstance 查询实例信息 查询实例信息。
GetInstanceUsage 查询实例配额使用情况 查询实例配额使用情况。
ListInstanceRegion 查询实例Region列表 查询实例地域列表。
ListInstance 查询实例列表 调用该接口查询实例列表。
GetInstanceCount 获取用户实例个数 获取用户实例个数。

实例访问控制管理

API

标题

API概述

CreateInstanceVpcEndpointLinkedVpc 为实例添加可访问实例的VPC实例 为实例添加可访问实例的VPC实例。
CreateInstanceEndpointAclPolicy 为实例访问入口(限公网)创建白名单策略 为实例访问入口(限公网)创建白名单策略。
DeleteInstanceEndpointAclPolicy 为实例访问入口(限公网)删除白名单策略 为实例访问入口(限公网)删除白名单策略。
DeleteInstanceVpcEndpointLinkedVpc 移除可访问实例的VPC实例 为实例移除可访问实例的VPC实例。
UpdateInstanceEndpointStatus 更新实例访问入口状态 更新实例访问入口状态。
GetInstanceEndpoint 查询实例的访问入口 查询实例的访问入口。
ListInstanceEndpoint 查询实例网络访问入口列表 查询实例网络访问入口列表。
GetInstanceVpcEndpoint 获取实例VPC网络端点 获取实例VPC网络端点。

实例同步管理

API

标题

API概述

CreateRepoSyncTaskByRule 创建镜像仓库同步任务 根据同步规则(限手动同步规则)创建镜像仓库同步任务。
CreateRepoSyncRule 创建镜像仓库同步规则 创建镜像仓库同步规则。
CreateRepoSyncTask 手动创建仓库同步任务 手动创建同步任务。
DeleteRepoSyncRule 删除镜像仓库同步规则 删除镜像仓库同步规则。
ListRepoSyncTask 查询仓库同步任务列表 查询仓库同步任务列表。
ListRepoSyncRule 查询仓库同步规则列表 查询仓库同步规则列表。
GetRepoSyncTask 查询仓库同步任务 查询仓库同步任务。
CancelRepoSyncTask 取消同步任务 取消单个同步任务。

镜像命名空间管理

API

标题

API概述

CreateNamespace 创建镜像仓库命名空间 创建镜像仓库命名空间。
DeleteNamespace 删除镜像仓库命名空间 删除镜像仓库命名空间。
UpdateNamespace 更新命名空间 更新命名空间。
GetNamespace 查询命名空间信息 查询命名空间信息。
ListNamespace 查询命名空间列表 查询命名空间列表。

镜像仓库管理

API

标题

API概述

CreateRepository 创建镜像仓库 创建镜像仓库。
DeleteRepository 删除镜像仓库 删除镜像仓库。
UpdateRepository 更新仓库信息 更新仓库信息。
ListRepository 查询镜像仓库列表 查询镜像仓库列表。
GetRepository 查询仓库信息 查询仓库信息。

镜像管理

API

标题

API概述

CreateRepoTag 创建镜像版本(Tag) 为仓库中现有镜像版本生成新版本。
DeleteRepoTag 删除镜像版本(Tag) 删除镜像。
ListRepoTag 查询镜像版本(Tag)列表 查询镜像版本(Tag)列表。
GetRepoTag 查询某镜像版本(Tag) 获取单个镜像Tag信息。

镜像安全管理

API

标题

API概述

CreateRepoTagScanTask 创建镜像安全扫描任务 创建镜像安全扫描任务。
GetRepoTagScanStatus 获取镜像版本扫描状态 获取镜像版本扫描状态。
GetRepoTagScanSummary 获取镜像版本扫描结果数目 获取镜像版本扫描结果数目。
ListRepoTagScanResult 获取镜像版本扫描结果列表 获取镜像版本扫描结果列表。
ListScanBaselineByTask 根据扫描任务列举基线漏洞 分页查询一个云安全扫描任务的基线漏洞。
ListScanMaliciousFileByTask 根据扫描任务列举恶意文件结果 分页查询一个扫描任务的恶意文件漏洞。

镜像构建管理

API

标题

API概述

CreateBuildRecordByRule 通过构建规则创建构建记录 根据规则创建构建记录。
CreateBuildRecordByRecord 创建构建记录 根据已有构建记录重新构建记录。
CreateRepoBuildRule 创建镜像仓库构建规则 创建镜像仓库构建规则。
CreateRepoSourceCodeRepo 绑定源代码仓库 给镜像仓库绑定源代码仓库。
DeleteRepoBuildRule 删除镜像仓库构建规则 删除镜像仓库构建规则。
CancelRepoBuildRecord 取消仓库构建 取消仓库构建。
UpdateRepoBuildRule 更新镜像仓库构建规则 更新镜像仓库构建规则。
UpdateRepoSourceCodeRepo 更新镜像仓库的源代码仓库 更新镜像仓库的源代码仓库地址。
ListRepoBuildRecordLog 获取某次构建记录的日志 获取某次构建记录的日志。
ListRepoBuildRule 查询镜像仓库构建规则列表 查询镜像仓库构建规则列表。
ListRepoBuildRecord 查询镜像仓库构建记录列表 查询镜像仓库构建记录列表。
GetRepoBuildRecordStatus 获取构建状态 获取构建状态。
GetRepoBuildRecord 查询仓库构建记录 查询仓库构建记录。
GetRepoSourceCodeRepo 获取源代码仓库绑定信息 获取源代码仓库的绑定信息。

镜像触发器管理

API

标题

API概述

CreateRepoTrigger 创建镜像仓库触发器 创建镜像仓库触发器。
DeleteRepoTrigger 删除镜像仓库触发器 删除镜像仓库触发器。
UpdateRepoTrigger 更新镜像仓库触发器 更新镜像仓库触发器。
ListRepoTrigger 查询仓库触发器列表 查询仓库触发器列表。

Helm Chart 命名空间管理

API

标题

API概述

CreateChartNamespace 创建Chart命名空间 创建Chart的命名空间。
DeleteChartNamespace 删除Chart命名空间 删除Chart的命名空间。
UpdateChartNamespace 更新Chart命名空间 更新命名空间。
GetChartNamespace 查询Chart命名空间 查询Chart的命名空间。
ListChartNamespace 查询Chart命名空间列表 查询命名空间列表。

Chart 仓库管理

API

标题

API概述

CreateChartRepository 创建Chart仓库 创建Chart的仓库。
DeleteChartRepository 删除Chart仓库 删除Chart的仓库。
UpdateChartRepository 更新仓库信息 更新仓库信息。
ListChartRepository 查询仓库列表 查询仓库列表。
GetChartRepository 查询Chart仓库信息 查询Chart的仓库信息。

Chart 版本管理

API

标题

API概述

DeleteChartRelease 删除Chart版本 删除Chart的版本。
ListChartRelease 查询Chart版本列表 查询Chart的版本列表。

访问凭证管理

API

标题

API概述

GetAuthorizationToken 获取用于登录实例的临时账号和临时密码 获取用于登录实例的临时账号和临时密码。
ResetLoginPassword 重置登录密码 重置登录密码。

制品构建

API

标题

API概述

CancelArtifactBuildTask 取消制品构建任务 取消制品的构建任务。
GetArtifactBuildRule 获取制品构建规则 获取制品构建规则。
GetArtifactBuildTask 获取制品构建任务 获取制品的构建任务。
CreateArtifactBuildRule 创建加速镜像构建规则 创建镜像仓库加速镜像构建规则。
ListArtifactBuildTaskLog 获取制品构建任务日志 获取制品的构建任务日志。

云原生交付链管理

API

标题

API概述

CreateChain 创建交付链 创建交付链。
DeleteChain 删除交付链 删除交付链。
UpdateChain 修改交付链定义 修改交付链定义,例如修改交付链的节点执行顺序。
GetChain 获取交付链定义 获取交付链定义,用于了解交付链的节点执行顺序。
ListChain 获取交付链条目 获取交付链条目。
ListChainInstance 查询交付链执行记录 查询交付链执行记录。

事件通知

API

标题

API概述

DeleteEventCenterRule 删除事件通知规则 删除事件通知规则。
UpdateEventCenterRule 更新事件规则 更新事件规则。
ListEventCenterRecord 获取事件规则事件历史 获取事件规则事件历史。
ListEventCenterRuleName 获取事件规则名称 获取事件规则名称。

其他

API

标题

API概述

ChangeResourceGroup 更改资源组 修改资源所属的资源组信息。
CreateScanRule 创建扫描规则 创建扫描或内容分析规则。
DeleteScanRule 删除扫描规则 删除扫描规则。
ListScanRule 列出扫描规则 列举扫描规则。
UpdateScanRule 更新扫描规则 更新扫描规则。
GetScanRule 获取扫描规则 获取扫描规则。
CreateInstanceCustomizedDomain 创建实例自定义域名 创建实例自定义域名
DeleteInstanceCustomizedDomain 删除实例自定义域名 删除实例自定义域名
GetInstanceCustomizedDomain 查询实例自定义域名 查询实例自定义域名。
UpdateInstanceCustomizedDomain 更新实例自定义域名 更新实例自定义域名