API standard and pre-built SDKs in multi-language
This product (cr/2018-12-01) OpenAPI adopts an RPC-style signature mechanism. For implementation details, please refer to the Signature Mechanism documentation.To streamline development, we provide official SDKs for major programming languages. Using the SDK allows you to call APIs directly without worrying about low-level details such as request signatures, significantly lowering the barrier to entry and reducing integration complexity.
Custom signature
If your use case requires direct API integration with custom signatures, consult our technical support team first. Join our DingTalk support group (147535001692) to receive expert guidance.
Before you begin
An Alibaba Cloud account has full administrative privileges. A compromised AccessKey pair exposes all associated resources to unauthorized access, posing a significant security risk. To call APIs securely, create a Resource Access Management (RAM) user with API access only, configure its AccessKey pairs, and implement the principle of least privilege (PoLP) through RAM policies. Use the Alibaba Cloud account only when its permissions are explicitly required for specific scenarios.
Artifact Subscription Management
| API | Title | Description |
|---|---|---|
| UpdateArtifactSubscriptionRule | UpdateArtifactSubscriptionRule | Updates an artifact subscription rule. |
| DeleteArtifactSubscriptionRule | DeleteArtifactSubscriptionRule | Deletes an artifact subscription rule. |
| ListArtifactSubscriptionTask | ListArtifactSubscriptionTask | Lists artifact subscription tasks. |
| GetArtifactSubscriptionRule | GetArtifactSubscriptionRule | Queries the information about an artifact subscription rule. |
| GetArtifactSubscriptionTaskResult | GetArtifactSubscriptionTaskResult | Queries the details of an artifact subscription task. |
| CreateArtifactSubscriptionRule | CreateArtifactSubscriptionRule | Creates an artifact subscription rule. |
| ListArtifactSubscriptionRule | ListArtifactSubscriptionRule | Lists the subscription rules of artifacts. |
| GetArtifactSubscriptionTask | GetArtifactSubscriptionTask | Queries an artifact subscription task. |
| CreateArtifactSubscriptionTask | CreateArtifactSubscriptionTask | Creates an artifact subscription task. |
ArtifactLifecycle Management
| API | Title | Description |
|---|---|---|
| UpdateArtifactLifecycleRule | UpdateArtifactLifecycleRule | Updates a lifecycle management rule of an artifact. |
| ListArtifactLifecycleRule | ListArtifactLifecycleRule | Queries the lifecycle management rules of an artifact. |
| GetArtifactLifecycleRule | GetArtifactLifecycleRule | Queries the lifecycle management rules of an artifact. |
| DeleteArtifactLifecycleRule | DeleteArtifactLifecycleRule | Deletes an artifact lifecycle management rule. |
| CreateArtifactLifecycleRule | CreateArtifactLifecycleRule | Creates a lifecycle management rule for an artifact. |
Tag
| API | Title | Description |
|---|---|---|
| TagResources | TagResources | Adds tags to resources. Instance resources are supported. |
| UntagResources | UntagResources | Removes tags from resources. Instance resources are supported. |
| ListTagResources | ListTagResources | Queries the tags that are added to cloud resources. Instance resources are supported. |
Instance Storage Management
| API | Title | Description |
|---|---|---|
| CreateStorageDomainRoutingRule | CreateStorageDomainRoutingRule | Creates an instance store domain name routing rule. |
| DeleteStorageDomainRoutingRule | DeleteStorageDomainRoutingRule | Deletes an instance store domain name routing rule. |
| GetStorageDomainRoutingRule | 获取实例存储域名路由列表 | Queries instance storage domain routing rules |
| UpdateStorageDomainRoutingRule | UpdateStorageDomainRoutingRule | Updates a routing rule for an instance store domain name. |
Instances
| API | Title | Description |
|---|---|---|
| GetInstance | GetInstance | The ID of the resource group to which the instance belongs. |
| GetInstanceUsage | GetInstanceUsage | Queries the quota usage of an instance. |
| ListInstanceRegion | ListInstanceRegion | Queries regions in which you can create Container Registry instances. |
| ListInstance | ListInstance | Queries Container Registry instances. |
| GetInstanceCount | GetInstanceCount | Queries the number of instances. |
Instance endpoints
| API | Title | Description |
|---|---|---|
| CreateInstanceVpcEndpointLinkedVpc | CreateInstanceVpcEndpointLinkedVpc | Associates a virtual private cloud (VPC) with a Container Registry instance. |
| CreateInstanceEndpointAclPolicy | CreateInstanceEndpointAclPolicy | Creates a whitelist policy for the public endpoint of the instance. |
| DeleteInstanceEndpointAclPolicy | DeleteInstanceEndpointAclPolicy | Deletes a whitelist policy for the public endpoint of an instance. |
| DeleteInstanceVpcEndpointLinkedVpc | DeleteInstanceVpcEndpointLinkedVpc | Disassociates a virtual private cloud (VPC) from an instance. |
| UpdateInstanceEndpointStatus | UpdateInstanceEndpointStatus | Updates the status of an instance endpoint. |
| GetInstanceEndpoint | GetInstanceEndpoint | Queries an endpoint of an instance. |
| ListInstanceEndpoint | ListInstanceEndpoint | Queries the endpoints of a Container Registry instance. |
| GetInstanceVpcEndpoint | GetInstanceVpcEndpoint | Queries the endpoints of the virtual private clouds (VPCs) in which a Container Registry instance is deployed. |
Instance replication
| API | Title | Description |
|---|---|---|
| CreateRepoSyncTaskByRule | CreateRepoSyncTaskByRule | Creates an image replication task based on a manual replication rule. |
| CreateRepoSyncRule | CreateRepoSyncRule | Creates an image synchronization rule for an image repository. |
| CreateRepoSyncTask | CreateRepoSyncTask | Manually creates an image synchronization task. |
| DeleteRepoSyncRule | DeleteRepoSyncRule | Deletes an image replication rule of an image repository. |
| ListRepoSyncTask | ListRepoSyncTask | Queries image synchronization tasks in an image repository. |
| ListRepoSyncRule | ListRepoSyncRule | Queries image synchronization rules of a repository. |
| GetRepoSyncTask | GetRepoSyncTask | Queries an image synchronization task in an instance. |
| CancelRepoSyncTask | CancelRepoSyncTask | Cancels a single replication task. |
Image namespaces
| API | Title | Description |
|---|---|---|
| CreateNamespace | CreateNamespace | Creates a namespace of image repositories. |
| DeleteNamespace | DeleteNamespace | Deletes a namespace. |
| UpdateNamespace | UpdateNamespace | Updates a namespace. |
| GetNamespace | GetNamespace | Queries the information about a namespace. |
| ListNamespace | ListNamespace | Queries namespaces in a Container Registry instance. |
Image repositories
| API | Title | Description |
|---|---|---|
| CreateRepository | CreateRepository | Creates an image repository. |
| DeleteRepository | DeleteRepository | Deletes an image repository. |
| UpdateRepository | UpdateRepository | The ID of the request. |
| ListRepository | ListRepository | Queries image repositories. |
| GetRepository | GetRepository | Queries details about an image repository. |
Images
| API | Title | Description |
|---|---|---|
| CreateRepoTag | CreateRepoTag | Creates an image tag based on an existing image tag in an image repository. |
| DeleteRepoTag | DeleteRepoTag | Deletes an image tag. |
| ListRepoTag | ListRepoTag | Queries image tags in a repository. |
| GetRepoTag | GetRepoTag | Queries the information about an image tag. |
Image security
| API | Title | Description |
|---|---|---|
| CreateRepoTagScanTask | CreateRepoTagScanTask | Creates an image scan task. |
| GetRepoTagScanStatus | GetRepoTagScanStatus | Queries the scanning status of an image tag. |
| GetRepoTagScanSummary | GetRepoTagScanSummary | Queries the number of vulnerabilities for each severity level. These vulnerabilities are detected in a security scan that is created for an image version. |
| ListRepoTagScanResult | ListRepoTagScanResult | Queries the results of a security scan that is created for an image tag. |
| ListScanBaselineByTask | ListScanBaselineByTask | Queries the baseline risks of a scan task by page. |
| ListScanMaliciousFileByTask | ListScanMaliciousFileByTask | Queries the malicious files of a scan task by page. |
Image building
| API | Title | Description |
|---|---|---|
| CreateBuildRecordByRule | CreateBuildRecordByRule | Creates an image building record based on a rule. |
| CreateBuildRecordByRecord | CreateBuildRecordByRecord | Creates an image building record based on an existing record. |
| CreateRepoBuildRule | CreateRepoBuildRule | Creates an image building rule for a repository. |
| CreateRepoSourceCodeRepo | CreateRepoSourceCodeRepo | Binds a source code repository to an image repository. |
| DeleteRepoBuildRule | DeleteRepoBuildRule | Deletes an image building rule of a repository. |
| CancelRepoBuildRecord | CancelRepoBuildRecord | Cancels a repository building record. |
| UpdateRepoBuildRule | UpdateRepoBuildRule | Updates an image building rule for a repository. |
| UpdateRepoSourceCodeRepo | UpdateRepoSourceCodeRepo | Updates the URL of the source code repository that is bound to an image repository. |
| ListRepoBuildRecordLog | ListRepoBuildRecordLog | Queries the log of an image building record. |
| ListRepoBuildRule | ListRepoBuildRule | Queries image building rules of an image repository. |
| ListRepoBuildRecord | ListRepoBuildRecord | Queries image building records of an image repository. |
| GetRepoBuildRecordStatus | GetRepoBuildRecordStatus | Queries the status of an image building task. |
| GetRepoBuildRecord | GetRepoBuildRecord | Queries the information about image building records of a repository. |
| GetRepoSourceCodeRepo | GetRepoSourceCodeRepo | Queries the information about the source code repository that is bound to an image repository. |
Image building triggers
| API | Title | Description |
|---|---|---|
| CreateRepoTrigger | CreateRepoTrigger | Creates a trigger for a repository. |
| DeleteRepoTrigger | DeleteRepoTrigger | Deletes a trigger of an image repository. |
| UpdateRepoTrigger | UpdateRepoTrigger | Updates a trigger of an image repository. |
| ListRepoTrigger | ListRepoTrigger | Queries the triggers of a repository. |
Helm chart namespaces
| API | Title | Description |
|---|---|---|
| CreateChartNamespace | CreateChartNamespace | Creates a chart namespace in an instance. |
| DeleteChartNamespace | DeleteChartNamespace | Deletes a chart namespace from an instance. |
| UpdateChartNamespace | UpdateChartNamespace | Updates a chart namespace. |
| GetChartNamespace | GetChartNamespace | Queries a chart namespace in an instance. |
| ListChartNamespace | ListChartNamespace | Queries the chart namespaces of a Container Registry instance. |
Helm chart repositories
| API | Title | Description |
|---|---|---|
| CreateChartRepository | CreateChartRepository | Creates a chart repository. |
| DeleteChartRepository | DeleteChartRepository | Deletes a chart repository from an instance. |
| UpdateChartRepository | UpdateChartRepository | Updates a chart repository of a Container Registry instance. |
| ListChartRepository | ListChartRepository | Queries the chart repositories of a Container Registry instance. |
| GetChartRepository | GetChartRepository | Queries the information about a chart repository. |
Helm chart versions
| API | Title | Description |
|---|---|---|
| DeleteChartRelease | DeleteChartRelease | Deletes a chart version from a chart repository. |
| ListChartRelease | ListChartRelease | Queries the versions of a chart in a chart repository. |
Credentials
| API | Title | Description |
|---|---|---|
| GetAuthorizationToken | GetAuthorizationToken | Queries a pair of temporary username and password that you use to log on to a Container Registry instance. |
| ResetLoginPassword | ResetLoginPassword | Resets the logon password of a Container Registry instance. |
Artifact building
| API | Title | Description |
|---|---|---|
| CancelArtifactBuildTask | CancelArtifactBuildTask | Cancels an artifact building task. |
| GetArtifactBuildRule | GetArtifactBuildRule | Queries the details of an artifact building rule. |
| GetArtifactBuildTask | GetArtifactBuildTask | Queries the details of an artifact building task. |
| CreateArtifactBuildRule | CreateArtifactBuildRule | Create image repository acceleration rules for image building. |
| ListArtifactBuildTaskLog | ListArtifactBuildTaskLog | Queries the log entries of an artifact building task. |
Cloud-native delivery chains
| API | Title | Description |
|---|---|---|
| CreateChain | CreateChain | Creates a delivery chain. |
| DeleteChain | DeleteChain | Deletes a delivery chain. |
| UpdateChain | UpdateChain | Updates the information about a delivery chain, such as the node execution sequence of the delivery chain. |
| GetChain | GetChain | Obtains the information of a delivery chain to understand the node execution sequence of the delivery chain. |
| ListChain | ListChain | Queries delivery chains. |
| ListChainInstance | ListChainInstance | Queries execution records of delivery chains. |
Event notification
| API | Title | Description |
|---|---|---|
| DeleteEventCenterRule | DeleteEventCenterRule | Deletes an event notification rule. |
| UpdateEventCenterRule | UpdateEventCenterRule | Updates an event rule. |
| ListEventCenterRecord | ListEventCenterRecord | Queries the historical events of an event rule. |
| ListEventCenterRuleName | ListEventCenterRuleName | Queries the name of an event rule. |
Others
| API | Title | Description |
|---|---|---|
| ChangeResourceGroup | ChangeResourceGroup | Changes the resource group to which a resource belongs. |
| CreateScanRule | CreateScanRule | Creates a scan or content analysis rule. |
| DeleteScanRule | DeleteScanRule | Deletes a scan rule. |
| ListScanRule | ListScanRule | Lists the scan rules. |
| UpdateScanRule | UpdateScanRule | Updates a scan rule. |
| GetScanRule | 获取扫描规则 | Queries a scan rule. |