API standards and multilingual preset SDKs
The OpenAPI of this product (cr/2018-12-01) uses the RPC signature style. We have encapsulated SDKs for common programming languages for developers. Developers can download the SDK to directly call this product's OpenAPI without worrying about technical details. If the existing SDK does not meet your needs, you can use the signature mechanism for self-signing integration. Since the details of self-signing are very complex, it may take around 5 business days. Therefore, we recommend joining our DingTalk service group (147535001692) and conducting signature integration under expert guidance.
Before using the API, you need to prepare your identity account and access key (AccessKey) to effectively access the API through client tools (such as SDK and CLI). For details, see Obtain an AccessKey.
Custom signature scenarios
If your business scenario has special requirements and you need to integrate the API through self-signing, we recommend consulting our technical support team first (DingTalk service group: 147535001692) to obtain professional guidance and ensure efficient integration.
Account and security preparation
Alibaba Cloud accounts have full administrative permissions over all resources. Once an AccessKey is compromised, all associated resources will be at risk of unauthorized access. To ensure security, it is recommended to create a RAM user with only API access permissions and configure its AccessKey, while configuring RAM policies based on the principle of least privilege (PoLP). Use the Alibaba Cloud account only in specific scenarios where Alibaba Cloud account permissions are explicitly required.
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 | Retrieves the details of an artifact subscription rule. |
| GetArtifactSubscriptionTaskResult | GetArtifactSubscriptionTaskResult | Queries the details of an artifact subscription task. |
| CreateArtifactSubscriptionRule | CreateArtifactSubscriptionRule | Creates an artifact subscription rule. |
| ListArtifactSubscriptionRule | ListArtifactSubscriptionRule | List artifact subscription rules. |
| GetArtifactSubscriptionTask | GetArtifactSubscriptionTask | Queries an artifact subscription task. |
| CreateArtifactSubscriptionTask | CreateArtifactSubscriptionTask | Creates an artifact subscription task. |
Artifact lifecycle management
|
API |
Title |
Description |
| UpdateArtifactLifecycleRule | Update an artifact lifecycle management rule | Updates an artifact lifecycle management rule. |
| ListArtifactLifecycleRule | List artifact lifecycle management rules | Lists artifact lifecycle management rules. |
| GetArtifactLifecycleRule | Query artifact lifecycle management rules | Queries the lifecycle management rules of artifacts. |
| DeleteArtifactLifecycleRule | DeleteArtifactLifecycleRule | Deletes an artifact lifecycle management rule. |
| CreateArtifactLifecycleRule | CreateArtifactLifecycleRule | Creates a lifecycle management rule for an artifact. |
Tags
|
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 | Get instance storage domain name routing list | Retrieves the instance storage domain name routing list. |
| UpdateStorageDomainRoutingRule | UpdateStorageDomainRoutingRule | Updates a routing rule for an instance store domain name. |
Instance management
|
API |
Title |
Description |
| GetInstance | Query instance information | Query instance information. |
| GetInstanceUsage | Query instance quota usage | Queries the quota usage of an instance. |
| ListInstanceRegion | ListInstanceRegion | Queries regions in which you can create Container Registry instances. |
| ListInstance | Query instance list | Queries a list of instances. |
| GetInstanceCount | GetUserSourceCount | Queries the number of instances of a user. |
Instance access control management
|
API |
Title |
Description |
| CreateInstanceVpcEndpointLinkedVpc | CreateInstanceVpcEndpointLinkedVpc | Associates a virtual private cloud (VPC) with a Container Registry instance. |
| CreateInstanceEndpointAclPolicy | Create a whitelist policy for an instance access endpoint (public network only) | Creates a whitelist policy for an instance access endpoint (public network only). |
| DeleteInstanceEndpointAclPolicy | Delete a whitelist policy from the public access endpoint of an instance | Deletes a whitelist policy from the public access 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 synchronization management
|
API |
Title |
Description |
| CreateRepoSyncTaskByRule | Create an image repository synchronization task | Creates a synchronization task for an image repository based on a synchronization rule (manual synchronization rules only). |
| CreateRepoSyncRule | Create an image repository synchronization rule | Creates a synchronization rule for an image repository. |
| CreateRepoSyncTask | Manually create a repository synchronization task | Manually creates a synchronization task. |
| DeleteRepoSyncRule | DeleteRepoSyncRule | Deletes an image replication rule of an image repository. |
| ListRepoSyncTask | Query repository synchronization task list | Queries the list of repository synchronization tasks. |
| ListRepoSyncRule | Query repository synchronization rules | Queries the list of repository synchronization rules. |
| GetRepoSyncTask | Query a repository synchronization task | Queries a repository synchronization task. |
| CancelRepoSyncTask | CancelRepoSyncTask | Cancels a single replication task. |
Image namespace management
|
API |
Title |
Description |
| CreateNamespace | CreateNamespace | Creates a repository namespace. |
| DeleteNamespace | DeleteNamespace | Deletes a namespace. |
| UpdateNamespace | UpdateNamespace | Updates a namespace. |
| GetNamespace | GetNamespace | Retrieves information about a namespace. |
| ListNamespace | ListNamespace | Lists namespaces. |
Image repository management
|
API |
Title |
Description |
| CreateRepository | CreateRepository | Creates an image repository. |
| DeleteRepository | DeleteRepository | Deletes an image repository. |
| UpdateRepository | Update repository information | Updates repository information. |
| ListRepository | Query image repositories | Queries a list of image repositories. |
| GetRepository | GetRepository | Queries details about an image repository. |
Image management
|
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 | Query image versions (tags) | Queries the list of image versions (tags). |
| GetRepoTag | Query a specific image version (tag) | Retrieve information about a single image tag. |
Image security management
|
API |
Title |
Description |
| CreateRepoTagScanTask | CreateRepoTagScanTask | Creates a security scan task for an image. |
| GetRepoTagScanStatus | GetRepoTagScanStatus | Retrieves the scan status of a specific image tag. |
| GetRepoTagScanSummary | Obtain the number of scan results for an image version | Obtain the number of scan results 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 build management
|
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 | Query the list of build rules for an image repository | Lists the build 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 trigger management
|
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 namespace management
|
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. |
Chart repository management
|
API |
Title |
Description |
| CreateChartRepository | CreateChartRepository | Creates a chart repository. |
| DeleteChartRepository | Delete a chart repository | Deletes a chart repository. |
| 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. |
Chart version management
|
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. |
Access credential management
|
API |
Title |
Description |
| GetAuthorizationToken | Retrieve temporary credentials for instance logon | Retrieves a temporary username and password for logging on to an instance. |
| ResetLoginPassword | ResetLoginPassword | Resets the logon password of a Container Registry instance. |
Artifact build
|
API |
Title |
Description |
| CancelArtifactBuildTask | CancelArtifactBuildTask | Cancels an artifact building task. |
| GetArtifactBuildRule | Retrieve artifact build rule | Retrieves an artifact build rule. |
| GetArtifactBuildTask | Get artifact build task | Retrieves the build task of an artifact. |
| CreateArtifactBuildRule | CreateArtifactBuildRule | Create image repository acceleration rules for image building. |
| ListArtifactBuildTaskLog | ListArtifactBuildTaskLog | Queries the log entries of an artifact building task. |
Cloud-native delivery chain management
|
API |
Title |
Description |
| CreateChain | Create a delivery chain | Creates a delivery chain. |
| DeleteChain | Delete a delivery chain | Deletes a delivery chain. |
| UpdateChain | UpdateChain | Updates the information about a delivery chain, such as the node execution sequence of the delivery chain. |
| GetChain | Retrieve delivery chain definition | Obtain the delivery chain definition to understand the execution order of edge zones in the delivery chain. |
| ListChain | ListChain | Queries delivery chains. |
| ListChainInstance | Query delivery chain execution records | Queries the execution records of a delivery chain. |
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 | Create a scan rule | Creates a scan or content analysis rule. |
| DeleteScanRule | DeleteScanRule | Deletes a scan rule. |
| ListScanRule | ListScanRule | Lists the scan rules. |
| UpdateScanRule | Update a scan rule | Updates a scan rule. |
| GetScanRule | Retrieve a scan rule | Retrieves a scan rule. |
| CreateInstanceCustomizedDomain | Create instance custom domain name | Creates a custom domain name for an instance. |
| DeleteInstanceCustomizedDomain | Delete instance custom domain name | Deletes a custom domain name from an instance. |
| GetInstanceCustomizedDomain | Query instance custom domain name | Queries the custom domain name of an instance. |
| UpdateInstanceCustomizedDomain | Update instance custom domain name | Updates the custom domain name of an instance. |