API standards and multilingual preset SDKs
The OpenAPI of this product (Eci/2018-08-08) 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.
Region
|
API |
Title |
Description |
| CreateContainerGroup | Create a container group | Calls CreateContainerGroup to create an ECI instance (container group). |
| UpdateContainerGroup | UpdateContainerGroup | This operation updates an instance. |
| DescribeContainerGroups | DescribeContainerGroups | You can call DescribeContainerGroups to query information about multiple ECI instances. |
| DescribeContainerGroupStatus | DescribeContainerGroupStatus | You can call DescribeContainerGroupStatus to perform a batch query on the status of multiple Elastic Container Instance (ECI) instances. |
| DescribeContainerGroupEvents | DescribeContainerGroupEvents | Queries events for multiple Elastic Container Instance (ECI) instances in a batch. |
| ResizeContainerGroupVolume | ResizeContainerGroupVolume | You can call the ResizeContainerGroupVolume operation to resize a disk volume mounted to a specified Elastic Container Instance (ECI). |
| RestartContainerGroup | RestartContainerGroup | The RestartContainerGroup operation restarts an ECI instance. |
| DeleteContainerGroup | DeleteContainerGroup | You can call DeleteContainerGroup to delete an ECI instance. |
Container group
|
API |
Title |
Description |
| ExecContainerCommand | ExecContainerCommand | Executes a command in a container. |
| DescribeContainerLog | DescribeContainerLog | Queries the logs of a container in a container group. |
| CommitContainer | CommitContainer | Call the CommitContainer operation to create an asynchronous task that saves a specified container in an Elastic Container Instance (ECI) instance as an image and pushes the image to an image repository in Alibaba Cloud Container Registry (ACR). |
| DescribeCommitContainerTask | DescribeCommitContainerTask | The DescribeCommitContainerTask operation queries the details of a CommitContainer task. |
Container
|
API |
Title |
Description |
| CreateImageCache | CreateImageCache | You can call the CreateImageCache operation to create an image cache. This accelerates image pulling and reduces the startup time for Elastic Container Instance (ECI) instances. |
| DeleteImageCache | DeleteImageCache | You can call this operation to delete an image cache. |
| UpdateImageCache | UpdateImageCache | Updates an image cache. |
| DescribeImageCaches | DescribeImageCaches | Queries the details of one or more image caches. |
Image cache
|
API |
Title |
Description |
| CreateDataCache | CreateDataCache | Creates a data cache. |
| DescribeDataCaches | DescribeDataCaches | Queries the details of one or more data caches. |
| UpdateDataCache | UpdateDataCache | Updates a data cache. |
| CopyDataCache | CopyDataCache | Copies a data cache from one region to another. |
| DeleteDataCache | DeleteDataCache | Deletes a data cache. |
Data cache
|
API |
Title |
Description |
| CreateVirtualNode | CreateVirtualNode | Creates a virtual node to connect a self-managed Kubernetes cluster to ECI and scale out resources. |
| DeleteVirtualNode | DeleteVirtualNode | You can call the DeleteVirtualNode operation to delete a virtual node. |
| UpdateVirtualNode | UpdateVirtualNode | You can call the UpdateVirtualNode operation to update the properties of a virtual node. |
| DescribeVirtualNodes | DescribeVirtualNodes | Queries the details of one or more virtual nodes. |
Virtual node
|
API |
Title |
Description |
| DescribeContainerGroupMetric | DescribeContainerGroupMetric | Queries the monitoring data of an Elastic Container Instance (ECI). |
| DescribeMultiContainerGroupMetric | DescribeMultiContainerGroupMetric | You can call the DescribeContainerGroupMetric operation to query the monitoring data of an ECI instance. |
Monitoring
|
API |
Title |
Description |
| CreateInstanceOpsTask | CreateInstanceOpsTask | Call CreateInstanceOpsTask to create an Operations and Maintenance (O&M) task. |
| DescribeInstanceOpsRecords | DescribeInstanceOpsRecords | You can call DescribeInstanceOpsRecords to query the O&M task records for an instance. |
O&M operations
|
API |
Title |
Description |
| ListUsage | ListUsage | Call the ListUsage operation to query the privilege quotas in a specified region. The response returns the used amount and the upper limit of each quota. |
| DescribeContainerGroupPrice | DescribeContainerGroupPrice | Queries the price of an Elastic Container Instance (ECI) instance. |
Tag
|
API |
Title |
Description |
| DescribeAvailableResource | DescribeAvailableResource | You can call the DescribeAvailableResource operation to query the ECS instance families that are available in a specified region and zone. |
| DescribeRegions | DescribeRegions | Queries the regions and zones supported by Elastic Container Instance. |
| ListTagResources | ListTagResources | You can call the ListTagResources operation to query the tags that are attached to ECI resources. |
| TagResources | TagResources | The TagResources operation attaches tags to specified ECI resources. |
| UntagResources | UntagResources | You can call UntagResources to detach tags from specified ECI resources. |