# Alibaba Cloud Elastic Container Instance API

> Alibaba Cloud Elastic Container Instance API on Apizie: 37 endpoints (Calls the CommitContainer operation to create an asynchronous task that saves a specified container in an…, Copies a data cache from one region to another, Creates an Elastic Container Instance (ECI), which is a container group, Creates a data cache, …) returned as clean JSON through one API key. Send your own provider key in the x-upstream-key header. Call it over REST at https://www.apizie.tech/v1/cloud:aliyun-eci/{endpoint} or from Claude, ChatGPT and Cursor through the Apizie MCP server. Free plan: 1,000 requests a month.

- Project key: `cloud:aliyun-eci`
- Category: Cloud
- Status: byok
- Source: https://api.alibabacloud.com/product/eci
- Page: https://www.apizie.tech/api/cloud/aliyun-eci
- OpenAPI: https://www.apizie.tech/api/cloud/aliyun-eci/openapi.json

Alibaba Cloud OpenAPI for Elastic Container Instance (eci, version 2018-08-08). Calls are signed with ACS3-HMAC-SHA256 using your AccessKey ID and secret.

## Endpoints

### Calls the CommitContainer operation to create an asynchronous task that saves a specified container in an…
`POST https://www.apizie.tech/v1/cloud:aliyun-eci/commit-container` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://eci.ap-southeast-1.aliyuncs.com |
| RegionId | string | yes | The region ID |
| ContainerGroupId | string | yes | The ECI instance for which you want to create a CommitContainer task |
| ContainerName | string | yes | The name of the container from which you want to create an image |
| Image | string | no | The container image information (JSON-encoded) |
| AcrRegistryInfo | string | no | The access credential configuration for a Container Registry Enterprise Edition instance. You do not need to configure this parameter when… |
| Arn | string | no | The ARN information required for authorization (JSON-encoded) |

### Copies a data cache from one region to another
`POST https://www.apizie.tech/v1/cloud:aliyun-eci/copy-data-cache` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://eci.ap-southeast-1.aliyuncs.com |
| RegionId | string | yes | The region where the existing data cache resides |
| Bucket | string | no | The bucket of the data cache |
| Path | string | no | The path of the data cache |
| Name | string | no | The name of the data cache |
| RetentionDays | integer | no | The number of days to retain the data cache |
| Tag | string | no | The list of data cache tags (JSON-encoded) |
| ResourceGroupId | string | no | The resource group to which the data cache belongs |
| ClientToken | string | no | Ensures the idempotence of the request. Generate a parameter value from your client to ensure uniqueness across different requests. The… |
| DataCacheId | string | yes | The ID of the data cache |
| DestinationRegionId | string | yes | The destination region to which the data cache is copied |

### Creates an Elastic Container Instance (ECI), which is a container group
`POST https://www.apizie.tech/v1/cloud:aliyun-eci/create-container-group` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://eci.ap-southeast-1.aliyuncs.com |
| RegionId | string | yes | The region ID |
| ZoneId | string | no | The zone to which the instance belongs. If this parameter is left empty, the system selects a zone. Default value: empty |
| SecurityGroupId | string | no | The ID of the security group to which the instance belongs. Instances within the same security group can access each other. If you do not… |
| VSwitchId | string | no | The ID of the vSwitch to which the instance belongs. You can specify multiple vSwitch IDs. A maximum of 10 vSwitch IDs can be specified at… |
| ContainerGroupName | string | yes | The name of the ECI, which is the name of the container group. The name must meet the following requirements: The name must be 2 to 128… |
| RestartPolicy | string | no | The restart policy of the instance. Valid values: Always: always restarts the instance. Never: never restarts the instance. OnFailure:… |
| EipInstanceId | string | no | The ID of the Elastic IP Address (EIP) |
| Cpu | number | no | The number of vCPUs for the instance. Unit: cores |
| Memory | number | no | The memory size for the instance. Unit: GiB |
| ResourceGroupId | string | no | The ID of the resource group |
| DnsPolicy | string | no | The DNS policy. Valid values: None: uses the DNS settings specified in the DnsConfig field. Default: inherits the DNS settings from the… |
| ClientToken | string | no | The client token that is used to ensure the idempotence of the request. You can use the client to generate the value, but you must ensure… |
| InstanceType | string | no | The ECS instance type. Multiple instance types are supported. For more information, see https://help.aliyun.com/document_detail/114664.html |
| ImageSnapshotId | string | no | The ID of the image cache. For more information, see https://help.aliyun.com/document_detail/141281.html |
| RamRoleName | string | no | The name of the RAM role for the instance. ECIs and ECS instances share the same RAM roles. For more information, see… |
| TerminationGracePeriodSeconds | integer | no | The buffer time for the program to handle operations before it is terminated. Unit: seconds |
| AutoMatchImageCache | string | no | Specifies whether to automatically match an image cache. Default value: false |
| Ipv6AddressCount | integer | no | The number of IPv6 addresses. Set the value to 1, which indicates that an ECI can be associated with one IPv6 address |
| ActiveDeadlineSeconds | integer | no | The validity period of the ECI. If the running time of the ECI exceeds this period, the ECI is forcibly terminated. Unit: seconds |
| SpotStrategy | string | no | The preemption policy for the instance. Valid values: NoSpot: applies to regular pay-as-you-go instances. SpotWithPriceLimit: applies to… |
| SpotPriceLimit | number | no | The maximum hourly price for the spot instance. The value can be accurate to three decimal places. You must specify this parameter when… |
| ScheduleStrategy | string | no | The scheduling policy for the ECI when multiple zones are configured by specifying multiple vSwitches in the VSwitchId parameter. Valid… |
| CorePattern | string | no | The custom directory where the core files generated by coredump are saved. For more information, see… |
| ShareProcessNamespace | string | no | Specifies whether to use a shared namespace. Default value: false |
| AutoCreateEip | string | no | Specifies whether automatic creation of an EIP is performed and the EIP is attached to the instance |
| EipBandwidth | integer | no | The bandwidth of the EIP. Default value: 5 Mbit/s. You can specify this parameter when AutoCreateEip is set to true |
| EipISP | string | no | The line type of the EIP. Valid values: BGP: BGP (Multi-ISP) line. This is the default value. BGP_PRO: BGP (Multi-ISP) Pro line |
| EipCommonBandwidthPackage | string | no | The ID of the existing Internet Shared Bandwidth instance to associate |
| HostName | string | no | The hostname |
| IngressBandwidth | integer | no | The inbound bandwidth limit. Unit: Bps |
| EgressBandwidth | integer | no | The outbound bandwidth limit. Unit: Bps |
| CpuOptionsCore | integer | no | The number of physical CPU cores. Custom settings are supported only for specific instance types |
| CpuOptionsThreadsPerCore | integer | no | The number of threads per core. Custom settings are supported only for specific instance types. A value of 1 indicates that… |
| CpuOptionsNuma | string | no | This parameter is not supported |
| EphemeralStorage | integer | no | The size of the additional temporary storage space. Unit: GiB. For more information, see https://help.aliyun.com/document_detail/204066.html |
| Tag | string | no | The list of tags. You can bind up to 20 tags. For more information, see https://help.aliyun.com/document_detail/146608.html (JSON-encoded) |
| ImageRegistryCredential | string | no | The information about the image repository (JSON-encoded) |
| Container | string | yes | The container information (JSON-encoded) |
| Volume | string | no | The volume mount information (JSON-encoded) |
| InitContainer | string | no | The list of init containers (JSON-encoded) |
| DnsConfig.NameServer | string | no | The list of IP addresses of DNS servers (JSON-encoded) |
| DnsConfig.Search | string | no | The list of DNS search domains (JSON-encoded) |
| DnsConfig.Option | string | no | The list of options for the object (JSON-encoded) |
| HostAliase | string | no | Adds an alias for the elastic container instance (JSON-encoded) |
| SecurityContext.Sysctl | string | no | Modifies secure sysctl parameters by using the security context. For more information, see… |
| HostSecurityContext.Sysctl | string | no | Modifies unsafe sysctl parameters by using the security context. For more information, see… |
| NtpServer | string | no | The NTP server (JSON-encoded) |
| AcrRegistryInfo | string | no | The list of ACR Enterprise instances. For more information, see https://help.aliyun.com/document_detail/194250.html (JSON-encoded) |
| SpotDuration | integer | no | The protection period of the spot instance. Unit: hours. Default value: 1. A value of 0 indicates that no protection period is configured |
| StrictSpot | string | no | Specifies whether to run the instance periodically. Valid values: true: Runs the instance periodically. false: Does not run the instance… |
| PlainHttpRegistry | string | no | The address of the self-pull image repository. When you create an ECI instance by using an image from a self-pull image repository that… |
| InsecureRegistry | string | no | The address of the self-managed image repository. When you create an ECI instance by using an image from a self-managed image repository… |
| ImageAccelerateMode | string | no | The image acceleration mode. Valid values: nydus: uses Nydus for acceleration. The image must support Nydus. dadi: uses DADI for… |
| Ipv6GatewayBandwidthEnable | string | no | Specifies whether to enable IPv6 Internet communication for the ECI instance |
| Ipv6GatewayBandwidth | string | no | The peak Internet bandwidth of the IPv6 address. This parameter takes effect only when Ipv6GatewayBandwidthEnable is set to true. Valid… |
| ContainerResourceView | string | no | Specifies whether to enable the container resource view feature. If the allocated ECI specifications are higher than the requested… |
| FixedIp | string | no | Specifies whether to assign a fixed IP address to the instance. A value of true indicates that a fixed IP address is assigned. For more… |
| FixedIpRetainHour | integer | no | The retention period of the fixed IP address after the instance is released. Unit: hours. Default value: 48 |
| DataCacheBucket | string | no | The data cache bucket |
| DataCachePL | string | no | The performance level of the cloud disk used for data cache. ESSDs are preferred. Default value: PL1 |
| DataCacheProvisionedIops | integer | no | The provisioned read and write IOPS of the ESSD AutoPL disk used for data cache. Valid values: 0 to the minimum of 50,000 and (1,000 ×… |
| DataCacheBurstingEnabled | string | no | Specifies whether to enable the burst feature for the ESSD AutoPL disk used for data cache. For more information, see… |
| DryRun | string | no | Specifies whether to only precheck the request. Valid values: true: checks the request without creating the ECI instance. The system… |
| PrivateIpAddress | string | no | The private IP address of the ECI instance. Only IPv4 addresses are supported. Make sure that the IP address is not in use |
| OsType | string | no | The operating system of the ECI instance. Valid values: Linux: This is the default value. Windows Windows instances are in invitational… |
| CpuArchitecture | string | no | The CPU architecture of the ECI instance. Valid values: AMD64: This is the default value. ARM64 |
| ComputeCategory | string | no | The computing power category. For more information, see https://help.aliyun.com/document_detail/2638061.html (JSON-encoded) |
| GpuDriverVersion | string | no | The GPU driver version. Only specific instance types support switching the GPU driver version. For more information, see… |
| MaxPendingMinute | integer | no | The maximum pending duration of the ECI instance. Unit: minutes. Valid values: 10 to 1440. If the pending duration exceeds this value, the… |

### Creates a data cache
`POST https://www.apizie.tech/v1/cloud:aliyun-eci/create-data-cache` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://eci.ap-southeast-1.aliyuncs.com |
| RegionId | string | yes | The region ID |
| SecurityGroupId | string | no | The ID of the security group to which the ECI instance generated during the data cache creation process belongs |
| VSwitchId | string | no | The ID of the vSwitch to which the ECI instance generated during the data cache creation process belongs |
| Bucket | string | no | The storage bucket for the data. Default value: default. You can specify a custom bucket to group business data and avoid path conflicts.… |
| Path | string | no | The path where the data is stored |
| Name | string | no | The name of the data cache |
| Size | integer | no | The size of the data cache. Unit: GiB. Default value: 20. Evaluate the required size based on the actual data volume |
| DataSource | string | no | The data source (JSON-encoded) |
| RetentionDays | integer | no | The retention period in days. The data cache is cleared after it expires. By default, the data cache does not expire |
| Tag | string | no | The list of tags bound to the data cache (JSON-encoded) |
| ResourceGroupId | string | no | The ID of the resource group |
| ClientToken | string | no | The client token that is used to ensure the idempotence of the request. You can use the client to generate the value, but you must ensure… |
| EipInstanceId | string | no | The ID of the existing Elastic IP Address (EIP) to bind. If the VPC is not configured with a NAT gateway, you can bind an EIP to pull data… |
| EipCreateParam | string | no | The configurations for creating and binding an Elastic IP Address (EIP). If the VPC is not configured with a NAT gateway, you can bind an… |

### Creates an image cache to accelerate image pulling and reduce startup time for subsequent Elastic Container…
`POST https://www.apizie.tech/v1/cloud:aliyun-eci/create-image-cache` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://eci.ap-southeast-1.aliyuncs.com |
| RegionId | string | yes | The region ID |
| ZoneId | string | no | The zone |
| SecurityGroupId | string | no | The security group ID |
| VSwitchId | string | no | The vSwitch ID. You can specify multiple vSwitch IDs (up to 10 at a time), separated by commas (,). Example: `vsw-***,vsw-***` |
| ImageCacheName | string | yes | The name of the image cache |
| EipInstanceId | string | no | The Elastic IP Address (EIP). If you need to pull images from the Internet, make sure that the ECI instance can access the Internet. You… |
| ResourceGroupId | string | no | The resource group ID |
| ClientToken | string | no | The client token that is used to ensure the idempotence of the request. You can use the client to generate the token, but you must make… |
| ImageCacheSize | integer | no | The size of the image cache. Default value: 20 GiB |
| RetentionDays | integer | no | The retention period of the image cache. The image cache is deleted after it expires. By default, the image cache never expires. Image… |
| AutoMatchImageCache | string | no | Specifies whether to enable image cache reuse. If this feature is enabled, a newly created image cache can reuse image layers from… |
| ImageRegistryCredential | string | no | The image repository information (JSON-encoded) |
| Image | string | yes | The container images used to create the image cache (JSON-encoded) |
| Tag | string | no | The tag information of the image cache. You can specify up to 20 tags (JSON-encoded) |
| Flash | string | no | Specifies whether to enable the instant image cache feature, which accelerates image cache creation. Valid values: true: Enable the… |
| AcrRegistryInfo | string | no | The Container Registry instance information. For more information, see https://help.aliyun.com/document_detail/194250.html (JSON-encoded) |
| Annotations | string | no | The annotations. This parameter is not available for public use |
| PlainHttpRegistry | string | no | The address of the self-pull image repository. When you create an image cache by using images from a self-pull image repository that uses… |
| InsecureRegistry | string | no | The address of the self-managed image repository. When you create an image cache by using images from a self-managed image repository that… |
| StandardCopyCount | integer | no | The number of regular snapshot copies. By default, one image cache corresponds to one snapshot. If the image cache will be used to create… |
| FlashCopyCount | integer | no | The number of local snapshot copies. By default, one image cache corresponds to one snapshot. If the image cache will be used to create… |
| EliminationStrategy | string | no | The elimination strategy of the image cache. The default value is empty, which indicates that the image cache is always retained. You can… |
| OsType | string | no | The operating system of the container images. Valid values: Linux (default) Windows Windows is in invitational preview. To use it, submit… |

### Calls CreateInstanceOpsTask to create an operations and maintenance (O&M) task
`POST https://www.apizie.tech/v1/cloud:aliyun-eci/create-instance-ops-task` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://eci.ap-southeast-1.aliyuncs.com |
| RegionId | string | yes | The region ID |
| ContainerGroupId | string | yes | The Elastic Container Instance (ECI) instance ID |
| OpsType | string | yes | The type of the O&M task. Valid values: coredump tcpdump |
| OpsValue | string | yes | The parameters of the O&M task. You can set the corresponding parameters based on the value of OpsType. If OpsType is set to coredump, the… |

### Creates a virtual node (VNode) to connect to a self-managed Kubernetes cluster, enabling the cluster to…
`POST https://www.apizie.tech/v1/cloud:aliyun-eci/create-virtual-node` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://eci.ap-southeast-1.aliyuncs.com |
| RegionId | string | yes | The region ID |
| ZoneId | string | no | The zone ID |
| SecurityGroupId | string | yes | The security group ID. The virtual node and ECI instances created on the virtual node are added to this security group |
| VSwitchId | string | yes | The vSwitch ID. The vSwitch used by the virtual node and ECI instances created on the virtual node. You can specify 1 to 10 vSwitches that… |
| VirtualNodeName | string | no | The name of the virtual node. The name must be 2 to 128 characters in length and can contain lowercase letters, digits, periods (.), and… |
| ResourceGroupId | string | no | The resource group ID |
| ClientToken | string | no | The client token that is used to ensure the idempotence of the request. You can use the client to generate the token, but you must make… |
| EnablePublicNetwork | string | no | Specifies whether to enable public network access. Default value: false. If you set this parameter to true, the virtual node exposes a… |
| EipInstanceId | string | no | The ID of the Elastic IP Address (EIP) |
| KubeConfig | string | no | The KubeConfig of the Kubernetes cluster to which the virtual node connects. The value must be Base64-encoded before being passed in |
| CustomResources | string | no | The custom resources supported by the virtual node. If an ECI pod declares the corresponding custom resource in its request, the pod is… |
| ClusterDomain | string | no | The domain name of the cluster. After this parameter is configured, Kubelet configures all containers to search this domain in addition to… |
| ClusterDNS | string | no | The IP address of the DNS server. If `dnsPolicy=ClusterFirst` is set in an ECI pod, this value is used to provide DNS services for the… |
| Tag | string | no | The tag information of the virtual node. You can specify up to 20 tags (JSON-encoded) |
| Taint | string | no | The taint information of the virtual node. You can specify up to 20 taints (JSON-encoded) |
| TlsBootstrapEnabled | string | no | Specifies whether to enable TLS bootstrapping. If you enable this feature, use the KubeConfig certificate for TLS bootstrapping. Valid… |

### Deletes an Elastic Container Instance (ECI) instance
`POST https://www.apizie.tech/v1/cloud:aliyun-eci/delete-container-group` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://eci.ap-southeast-1.aliyuncs.com |
| RegionId | string | yes | The region ID |
| ContainerGroupId | string | yes | The ECI instance ID, which is also the container group ID |
| ClientToken | string | no | The client token that is used to ensure the idempotence of the request. You can use the client to generate the token, but make sure that… |
| Force | string | no | Specifies whether to forcefully clean up resources. Valid values: true: Forcefully cleans up resources without waiting for the graceful… |

### Deletes a data cache
`POST https://www.apizie.tech/v1/cloud:aliyun-eci/delete-data-cache` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://eci.ap-southeast-1.aliyuncs.com |
| RegionId | string | yes | The region ID |
| DataCacheId | string | no | The data cache ID |
| ClientToken | string | no | The client token that is used to ensure the idempotence of the request. You can use the client to generate the token, but make sure that… |
| Bucket | string | no | The bucket of the data cache. Default value: default |
| Path | string | no | The directory of the virtual host that corresponds to the data cache |

### Deletes an image cache
`POST https://www.apizie.tech/v1/cloud:aliyun-eci/delete-image-cache` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://eci.ap-southeast-1.aliyuncs.com |
| RegionId | string | yes | The region ID |
| ImageCacheId | string | yes | The image cache ID |
| ClientToken | string | no | The client token that is used to ensure the idempotence of the request. You can use the client to generate the token, but make sure that… |

### Deletes a virtual node
`POST https://www.apizie.tech/v1/cloud:aliyun-eci/delete-virtual-node` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://eci.ap-southeast-1.aliyuncs.com |
| RegionId | string | yes | The region ID |
| VirtualNodeId | string | yes | The ID of the virtual node |
| ClientToken | string | no | The client token that is used to ensure the idempotence of the request. You can use the client to generate the token, but make sure that… |

### Queries the ECS instance families available for sale in a specified region and zone
`POST https://www.apizie.tech/v1/cloud:aliyun-eci/describe-available-resource` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://eci.ap-southeast-1.aliyuncs.com |
| RegionId | string | yes | The region ID. You can call https://help.aliyun.com/document_detail/146965.html to query the most recent region list |
| ZoneId | string | no | The zone ID. Default value: empty. If this parameter is left empty, all zones in the specified region are queried |
| DestinationResource | string | yes | The resource information to query (JSON-encoded) |
| SpotResource | string | no | The resource information of the spot instance to query (JSON-encoded) |

### Queries the details of a CommitContainer task
`POST https://www.apizie.tech/v1/cloud:aliyun-eci/describe-commit-container-task` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://eci.ap-southeast-1.aliyuncs.com |
| RegionId | string | yes | The region ID |
| NextToken | string | no | The pagination token. Set the value to the NextToken value returned from the previous API call |
| MaxResults | integer | no | The number of entries to return per page in a paging query. Maximum value: 50. Default value: 10 |
| ContainerGroupId | string | no | The ID of the Elastic Container Instance (ECI) on which the CommitContainer task is executed. You must specify at least one of the… |
| TaskStatus | string | no | The task status. Valid values: Running: The task is running. Succeeded: The task succeeded. Failed: The task failed |
| TaskId | string | no | The task ID (JSON-encoded) |

### Queries event information for multiple Elastic Container Instance (ECI) instances in a batch
`POST https://www.apizie.tech/v1/cloud:aliyun-eci/describe-container-group-events` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://eci.ap-southeast-1.aliyuncs.com |
| RegionId | string | yes | The region ID |
| ZoneId | string | no | The zone ID |
| VSwitchId | string | no | The vSwitch ID |
| ResourceGroupId | string | no | The resource group ID |
| ContainerGroupIds | string | no | A sequence of ECI instance IDs. You can specify up to 20 instance IDs. The character string must be passed in JSON format |
| Tag | string | no | The tags bound to the ECI instances (JSON-encoded) |
| NextToken | string | no | The pagination token for the next query. If NextToken is empty, no more results exist. You do not need to specify this parameter for the… |
| EventSource | string | no | The event source. Valid values: EciService K8sAgent Default value: empty, which indicates that all events are queried |
| SinceSecond | integer | no | Returns events that occurred within the specified number of seconds. This parameter is used for polling incremental events |
| Limit | integer | no | The maximum number of resources (ECI instances) to return. Default value: 200. The number of returned results may be less than the… |

### Queries the monitoring data of an Elastic Container Instance (ECI)
`POST https://www.apizie.tech/v1/cloud:aliyun-eci/describe-container-group-metric` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://eci.ap-southeast-1.aliyuncs.com |
| RegionId | string | no | The region ID |
| ContainerGroupId | string | yes | The ID of the ECI instance. This is the container group ID |
| StartTime | string | no | The start of the time range to query. The value must be within the last 30 days. The default value is 5 minutes before the value of… |
| EndTime | string | no | The end of the time range to query. The default value is the current time. The time is in the RFC3339 format |
| Period | string | no | The aggregation period. Unit: seconds. Valid values: 15, 30, 60, and 600. Default value: 60. If you do not set StartTime and EndTime, the… |

### Queries the price of an Elastic Container Instance (ECI) instance
`POST https://www.apizie.tech/v1/cloud:aliyun-eci/describe-container-group-price` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://eci.ap-southeast-1.aliyuncs.com |
| RegionId | string | yes | The region ID. You can call https://help.aliyun.com/document_detail/146965.html to query the latest information about regions and zones |
| Cpu | number | no | The number of vCPUs. For more information about the vCPU and memory specifications that are supported by ECI, see… |
| Memory | number | no | The memory size. Unit: GiB. For more information about the vCPU and memory specifications that are supported by ECI, see… |
| InstanceType | string | no | The ECS instance type. For more information about the ECS instance types that are supported by ECI, see… |
| SpotStrategy | string | no | The preemption policy for the instance. Valid values: NoSpot: a regular pay-as-you-go instance. SpotWithPriceLimit: a spot instance for… |
| ZoneId | string | no | The zone ID. You can call https://help.aliyun.com/document_detail/146965.html to query the latest information about regions and zones |
| SpotPriceLimit | number | no | The maximum hourly price of the spot instance. The value can be accurate to three decimal places. This parameter is required when… |
| EphemeralStorage | integer | no | The size of the temporary storage space. Unit: GiB |
| SpotDuration | integer | no | The protection period of the spot instance. Unit: hour. Default value: 1. A value of 0 indicates that no protection period is specified |
| ComputeCategory | string | no | The category of computing power. Set the value to \`economy\` to query the price of an economy instance type |

### You can call DescribeContainerGroupStatus to perform a batch query on the status of multiple Elastic…
`POST https://www.apizie.tech/v1/cloud:aliyun-eci/describe-container-group-status` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://eci.ap-southeast-1.aliyuncs.com |
| RegionId | string | yes | The region ID |
| ZoneId | string | no | The zone ID |
| VSwitchId | string | no | The vSwitch ID |
| ResourceGroupId | string | no | The resource group ID |
| ContainerGroupIds | string | no | The IDs of the Elastic Container Instance (ECI) instances. You can specify a maximum of 20 IDs. The value must be a JSON-formatted string |
| SinceSecond | integer | no | The time in seconds. The operation returns the status of ECI instances that were updated within this time period. This parameter is used… |
| Tag | string | no | The tags attached to the ECI instance (JSON-encoded) |
| NextToken | string | no | The token to retrieve the next page of results. You do not need to set this parameter for the first request. You can get the token from… |
| Limit | integer | no | The maximum number of ECI instances to return. The default value is 200. The number of instances returned is less than or equal to the… |

### Queries information about Elastic Container Instance (ECI) instances in batches
`POST https://www.apizie.tech/v1/cloud:aliyun-eci/describe-container-groups` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://eci.ap-southeast-1.aliyuncs.com |
| RegionId | string | yes | The region ID of the instance |
| ZoneId | string | no | The zone of the instance. If this parameter is left empty, the system automatically selects a zone. Default value: empty |
| VSwitchId | string | no | The vSwitch ID of the instance |
| NextToken | string | no | The token for the next query. An empty value of NextToken indicates that no more results exist. You do not need to specify this parameter… |
| Limit | integer | no | The maximum number of resources to return. If this parameter is not specified, the default value is 20. The maximum value is 20. The… |
| ContainerGroupIds | string | no | The sequence of instance IDs. You can specify up to 20 IDs. The character string must be in JSON format |
| ContainerGroupName | string | no | The instance name, which is the container group name |
| Status | string | no | The instance status. Valid values: Pending: starting. Running: running. Succeeded: run succeeded. Failed: run failed. Scheduling: being… |
| ResourceGroupId | string | no | The ID of the resource group to which the instance belongs |
| WithEvent | string | no | Specifies whether to return event information |
| Tag | string | no | The instance tag information (JSON-encoded) |
| ComputeCategory | string | no | The computing category. Valid values: economy: economy. general: general-purpose |
| SecurityGroupId | string | no | The ID of the security group to which the instance belongs |

### Queries the logs of a container in a container group
`POST https://www.apizie.tech/v1/cloud:aliyun-eci/describe-container-log` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://eci.ap-southeast-1.aliyuncs.com |
| RegionId | string | no | The region ID of the elastic container instance |
| ContainerGroupId | string | yes | The instance ID |
| ContainerName | string | yes | The name of the container |
| StartTime | string | no | The beginning of the time range to query. Specify the time in the RFC 3339 standard. The time must be in UTC |
| Tail | integer | no | The number of the most recent log entries that you want to query. Default value: 500. Maximum value: 2000.\ A maximum of 1 MB log data can… |
| LastTime | string | no | Specifies whether to query the logs of the previous container if the container exits and restarts. Valid values: true false Default value:… |
| SinceSeconds | integer | no | A relative time in seconds before the current time from which to show logs. Examples: 10, 20, and 30 |
| LimitBytes | integer | no | The limit on the total size of logs. Unit: bytes. Valid values: 1 to 1048576(1 MB) |
| Timestamps | string | no | Specifies whether to return the timestamps of logs. Valid values: true false Default value: false |

### Queries the details of one or more data caches
`POST https://www.apizie.tech/v1/cloud:aliyun-eci/describe-data-caches` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://eci.ap-southeast-1.aliyuncs.com |
| RegionId | string | yes | The region ID |
| DataCacheId | string | no | The data cache ID (JSON-encoded) |
| Bucket | string | no | The bucket of the data cache. The default value is default |
| Path | string | no | The directory in the virtual host that corresponds to the data cache |
| Tag | string | no | The list of tags (JSON-encoded) |
| ResourceGroupId | string | no | The resource group ID |
| Limit | integer | no | The maximum number of entries to return on a single page. The default value and the maximum value are both 20 |
| NextToken | string | no | The query token. Set this to the NextToken value returned from the previous API call |

### Queries the details of one or more image caches
`POST https://www.apizie.tech/v1/cloud:aliyun-eci/describe-image-caches` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://eci.ap-southeast-1.aliyuncs.com |
| RegionId | string | yes | The region ID |
| ImageCacheId | string | no | The ID of the image cache |
| ImageCacheName | string | no | The name of the image cache |
| SnapshotId | string | no | The ID of the snapshot that corresponds to the image cache |
| Image | string | no | The container image |
| ResourceGroupId | string | no | The ID of the resource group to which the image cache belongs |
| Tag | string | no | The tags that are attached to the image cache (JSON-encoded) |
| MatchImage | string | no | The container images that are used to query the matched image caches. You can specify up to 100 images (JSON-encoded) |
| Limit | integer | no | The maximum number of entries to return |
| NextToken | string | no | The token that is used for the next query. You can obtain the token from the \`NextToken\` parameter in the response to the previous API… |
| ImageFullMatch | string | no | Specifies whether to perform an exact match for the container images. This parameter is used to further filter the query results when… |
| ImageMatchCountRequest | integer | no | The number of image caches that exactly match the container images. This parameter is used to further filter the query results when… |

### You can call DescribeInstanceOpsRecords to query the O&M task records for an instance
`POST https://www.apizie.tech/v1/cloud:aliyun-eci/describe-instance-ops-records` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://eci.ap-southeast-1.aliyuncs.com |
| RegionId | string | yes | The region ID |
| ContainerGroupId | string | yes | The ID of the ECI instance |
| OpsType | string | yes | The type of the O\&M task. Valid values: coredump tcpdump |

### You can call the DescribeContainerGroupMetric operation to query the monitoring data of an ECI instance
`POST https://www.apizie.tech/v1/cloud:aliyun-eci/describe-multi-container-group-metric` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://eci.ap-southeast-1.aliyuncs.com |
| RegionId | string | yes | The region ID |
| ContainerGroupIds | string | yes | The IDs of the ECI instances. The value is the same as the container group ID. Specify the IDs in a JSON array. You can specify a maximum… |
| ResourceGroupId | string | no | The ID of the resource group to which the instance belongs |
| MetricType | string | no | The type of monitoring data. Only summary is supported. If you set this parameter to summary, Records are returned |

### Queries the regions and zones supported by Elastic Container Instance
`POST https://www.apizie.tech/v1/cloud:aliyun-eci/describe-regions` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://eci.ap-southeast-1.aliyuncs.com |
| RegionId | string | no | The region ID |

### Queries the details of one or more virtual nodes
`POST https://www.apizie.tech/v1/cloud:aliyun-eci/describe-virtual-nodes` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://eci.ap-southeast-1.aliyuncs.com |
| RegionId | string | yes | The region ID |
| VirtualNodeName | string | no | The IDs of the virtual nodes. You can specify up to 20 IDs. The value must be a JSON-formatted string |
| VirtualNodeIds | string | no | A client token to ensure the idempotence of the request. Generate a value from your client to make sure that the value is unique among… |
| ClientToken | string | no | The status of the virtual node. Valid values: Pending Ready Failed |
| Status | string | no | The ID of the resource group |
| ResourceGroupId | string | no | The token that is used to retrieve the next page of results. You do not need to specify this parameter for the first request. You can… |
| NextToken | string | no | The number of entries to return on each page. Default value: 20. Maximum value: 20. The response might contain fewer entries than the… |
| Limit | integer | no | The list of tags that are attached to the virtual node |
| Tag | string | no | The tags that are attached to the virtual node (JSON-encoded) |

### Executes a command in a container
`POST https://www.apizie.tech/v1/cloud:aliyun-eci/exec-container-command` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://eci.ap-southeast-1.aliyuncs.com |
| RegionId | string | yes | The region ID of the instance |
| ContainerGroupId | string | yes | The instance ID, which is the container group ID |
| ContainerName | string | yes | The name of the container |
| Command | string | yes | The commands to execute in the container. You can specify up to 20 commands. Each command can be up to 256 characters long. To execute… |
| TTY | string | no | Specifies whether to enable interaction. The default value is false. If you set Command to `/bin/bash`, set this parameter to true. |
| Stdin | string | no | Specifies whether to enable standard input. The default value is true |
| Sync | string | no | Specifies whether to execute the command immediately and return the result synchronously. The default value is false. If you set this… |

### You can call the ListTagResources operation to query the tags that are attached to ECI resources
`POST https://www.apizie.tech/v1/cloud:aliyun-eci/list-tag-resources` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://eci.ap-southeast-1.aliyuncs.com |
| RegionId | string | yes | The ID of the region to which the resource belongs |
| ResourceId | string | no | The list of resource IDs (JSON-encoded) |
| Tag | string | no | The list of tags (JSON-encoded) |
| ResourceType | string | yes | The type of the resource. Valid values: ContainerGroup: an ECI instance ImageCache: an image cache DataCache: a data cache VirtualNode: a… |
| Limit | string | no | The number of entries to return on each page |
| NextToken | string | no | The token that is used to start the next query. To retrieve the next page of results, set this parameter to the NextToken value from the… |

### Call the ListUsage operation to query the privilege quotas in a specified region. The response returns the…
`POST https://www.apizie.tech/v1/cloud:aliyun-eci/list-usage` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://eci.ap-southeast-1.aliyuncs.com |
| RegionId | string | no | The region ID |

### You can call the ResizeContainerGroupVolume operation to resize a disk volume mounted to a specified Elastic…
`POST https://www.apizie.tech/v1/cloud:aliyun-eci/resize-container-group-volume` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://eci.ap-southeast-1.aliyuncs.com |
| RegionId | string | yes | The ID of the region |
| ContainerGroupId | string | yes | The ID of the ECI instance that has the volume to resize. This is the container group ID |
| ClientToken | string | no | A client token to ensure the idempotence of the request. Generate a value from your client to make sure that the value is unique among… |
| VolumeName | string | yes | The name of the volume that is mounted to the ECI instance. You can resize only disks |
| NewSize | integer | yes | The new size of the disk after it is resized. Unit: GiB. Valid values: ultra disk (cloud_efficiency): 20 to 32768 standard SSD… |

### The RestartContainerGroup operation restarts an ECI instance
`POST https://www.apizie.tech/v1/cloud:aliyun-eci/restart-container-group` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://eci.ap-southeast-1.aliyuncs.com |
| RegionId | string | yes | The ID of the region |
| ContainerGroupId | string | yes | The ID of the ECI instance. This is also the ID of the container group |
| ClientToken | string | no | A client token to ensure the idempotence of the request. Generate a unique value for this parameter from your client. The token can… |

### Attaches tags to the specified Elastic Container Instance (ECI) resources
`POST https://www.apizie.tech/v1/cloud:aliyun-eci/tag-resources` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://eci.ap-southeast-1.aliyuncs.com |
| RegionId | string | yes | The region ID of the resource |
| ResourceId | string | yes | The list of resource IDs (JSON-encoded) |
| Tag | string | yes | The list of tags. You can attach up to 20 tags to a single resource (JSON-encoded) |
| ResourceType | string | yes | The resource type. Valid values: ContainerGroup: ECI instance ImageCache: image cache DataCache: data cache VirtualNode: virtual node |

### Removes tags from the specified Elastic Container Instance (ECI) resources
`POST https://www.apizie.tech/v1/cloud:aliyun-eci/untag-resources` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://eci.ap-southeast-1.aliyuncs.com |
| RegionId | string | yes | The ID of the region to which the resource belongs |
| ResourceId | string | yes | The IDs of the resources (JSON-encoded) |
| TagKey | string | no | The keys of the tags that you want to remove. You can specify up to 20 tag keys (JSON-encoded) |
| ResourceType | string | yes | The resource type. Valid values: ContainerGroup: Elastic Container Instance. ImageCache: image cache. DataCache: data cache. VirtualNode:… |
| All | string | no | Specifies whether to remove all tags from the resources. This parameter takes effect only when the TagKey parameter is not specified in… |
| ClientToken | string | no | The client token that is used to ensure the idempotence of the request. You can use the client to generate the value, but you must ensure… |

### This operation updates an instance
`POST https://www.apizie.tech/v1/cloud:aliyun-eci/update-container-group` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://eci.ap-southeast-1.aliyuncs.com |
| RegionId | string | yes | The ID of the region |
| ContainerGroupId | string | yes | The ID of the ECI instance that you want to update. This is the container group ID |
| RestartPolicy | string | no | The restart policy of the instance. Valid values: Always: Always restarts the instance. Never: Never restarts the instance. OnFailure:… |
| ClientToken | string | no | A client token to ensure the idempotence of the request. Generate a unique parameter value from your client. The value can contain only… |
| Cpu | number | no | The number of vCPUs for the instance (container group) |
| Memory | number | no | The memory size for the instance (container group). Unit: GiB |
| ResourceGroupId | string | no | The ID of the resource group |
| Tag | string | no | The list of tags to attach to the instance (JSON-encoded) |
| Volume | string | no | The list of volumes (JSON-encoded) |
| DnsConfig.Search | string | no | The list of DNS search domains (JSON-encoded) |
| DnsConfig.NameServer | string | no | The list of IP addresses of DNS servers (JSON-encoded) |
| DnsConfig.Option | string | no | The DNS configuration information (JSON-encoded) |
| Container | string | no | Specifies the new container group configuration (JSON-encoded) |
| InitContainer | string | no | Specifies the new Init container information (JSON-encoded) |
| ImageRegistryCredential | string | no | A list of image repository credentials (JSON-encoded) |
| AcrRegistryInfo | string | no | Information about the ACR Enterprise instance (JSON-encoded) |
| UpdateType | string | no | The update type. Valid values: RenewUpdate: A full update. You must specify all related parameters. You cannot update individual items in… |

### Updates a data cache
`POST https://www.apizie.tech/v1/cloud:aliyun-eci/update-data-cache` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://eci.ap-southeast-1.aliyuncs.com |
| RegionId | string | yes | The region ID |
| DataCacheId | string | no | The data cache ID |
| SecurityGroupId | string | no | The security group ID |
| VSwitchId | string | no | The vSwitch ID |
| Bucket | string | no | The bucket of the data cache. The default value is default |
| Name | string | no | The name of the data cache |
| Size | integer | no | The size of the data cache |
| DataSource | string | no | The information about the data source (JSON-encoded) |
| RetentionDays | integer | no | The number of days to retain the data cache. The data cache is cleared after it expires. By default, the data cache does not expire |
| ResourceGroupId | string | no | The ID of the resource group |
| Tag | string | no | The list of tags (JSON-encoded) |
| ClientToken | string | no | A client token. You can use the client to generate a token, but you must make sure that the token is unique among different requests. The… |
| EipInstanceId | string | no | The elastic IP address (EIP). If no NAT gateway is configured for the virtual private cloud (VPC), you can attach an EIP to the data cache… |
| EipCreateParam | string | no | Creates and attaches an EIP. If no NAT gateway is configured for the VPC, you can attach an EIP to the data cache to pull data from the… |

### Updates an image cache
`POST https://www.apizie.tech/v1/cloud:aliyun-eci/update-image-cache` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://eci.ap-southeast-1.aliyuncs.com |
| RegionId | string | yes | The region ID |
| ImageCacheId | string | yes | The ID of the image cache |
| SecurityGroupId | string | no | The ID of the security group |
| VSwitchId | string | no | The ID of the vSwitch |
| ImageCacheName | string | no | The name of the image cache |
| EipInstanceId | string | no | The elastic IP address (EIP). To pull images from the Internet, ensure that the ECI instance has Internet access. Configure an EIP or a… |
| ResourceGroupId | string | no | The ID of the resource group |
| ClientToken | string | no | The client token that is used to ensure the idempotence of the request. Generate a value that is unique among different requests. The… |
| ImageCacheSize | integer | no | The size of the image cache. The default value is 20 GiB |
| RetentionDays | integer | no | The retention period of the image cache in days. The image cache expires and is cleared after the retention period ends. By default, the… |
| AutoMatchImageCache | string | no | Specifies whether to enable reuse of image cache layers. If you enable this feature, the system reuses the image layers of existing image… |
| ImageRegistryCredential | string | no | The credentials of the image repository (JSON-encoded) |
| Image | string | no | The list of container images used to create the image cache. If you want to trigger an in-place upgrade of the image cache without… |
| Tag | string | no | The tags to attach to the image cache. You can attach up to 20 tags (JSON-encoded) |
| Flash | string | no | Specifies whether to enable the instant image cache feature. This feature accelerates the creation of image caches. Valid values: true… |
| AcrRegistryInfo | string | no | The information about the Container Registry (ACR) Enterprise Edition instance (JSON-encoded) |
| StandardCopyCount | integer | no | The number of standard snapshot replicas. By default, one snapshot is created for one image cache. If the image cache is used to create… |
| FlashCopyCount | integer | no | The number of local snapshot replicas. By default, one snapshot is created for one image cache. If the image cache is used to create… |
| EliminationStrategy | string | no | The eviction policy for the image cache. By default, the image cache is never evicted. Set this parameter to \`LRU\` to allow automatic… |

### You can call the UpdateVirtualNode operation to update the properties of a virtual node
`POST https://www.apizie.tech/v1/cloud:aliyun-eci/update-virtual-node` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://eci.ap-southeast-1.aliyuncs.com |
| RegionId | string | yes | The region ID |
| VirtualNodeId | string | yes | The name of the virtual node |
| VirtualNodeName | string | no | The custom resources that the virtual node supports. If an ECI pod requests the custom resources, the pod is scheduled to the virtual… |
| CustomResources | string | no | The domain name of the cluster. Kubelet configures all containers to search for this domain name in addition to the search domain of the… |
| ClusterDomain | string | no | The IP address of the DNS server. If the dnsPolicy of an Elastic Container Instance (ECI) pod is set to `ClusterFirst`, the pod uses this… |
| ClusterDNS | string | no | A client token that you can use to ensure the idempotence of the request. The client generates the token, but you must ensure that the… |
| ClientToken | string | no | The tags for the virtual node |
| Tag | string | no | The tags of the virtual node (JSON-encoded) |

### version
`POST https://www.apizie.tech/v1/cloud:aliyun-eci/version` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://eci.ap-southeast-1.aliyuncs.com |

## Example
```
curl "https://www.apizie.tech/v1/cloud:aliyun-eci/commit-container" \
  -H "x-api-key: $APIZIE_KEY" \
  -H "x-upstream-key: $PROVIDER_KEY"
```

## FAQ

### How do I call the Alibaba Cloud Elastic Container Instance API?
Create a free Apizie key, then send POST https://www.apizie.tech/v1/cloud:aliyun-eci/commit-container with the header x-api-key. Every endpoint returns { project, data, timestamp }.

### Is the Alibaba Cloud Elastic Container Instance API free on Apizie?
Yes. The Free plan includes 1,000 requests a month at 100 requests a minute, no credit card. Alibaba Cloud Elastic Container Instance itself also needs your own key from aliyuncs.com.

### Can AI agents use the Alibaba Cloud Elastic Container Instance API?
Yes. Add the Apizie MCP server (https://www.apizie.tech/mcp) to Claude, ChatGPT, Cursor or VS Code, then ask in plain language. The agent calls run_scraper with project key cloud:aliyun-eci.

### What is the status of the Alibaba Cloud Elastic Container Instance API?
Needs your own provider key (bring your own key)