# Alibaba Cloud Elastic Compute Service API

> Alibaba Cloud Elastic Compute Service API on Apizie: 301 endpoints (Accepts and authorizes the execution of a system event. For a system event in the Inquiring state, this…, Creates one or more pay-as-you-go or subscription dedicated hosts. A dedicated host is a physical server…, Assigns a public IP address to an ECS instance. Use the ModifyInstanceNetworkSpec operation to assign a…, Applies an automatic snapshot policy to one or more cloud disks, …) 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://zieapi.vercel.app/v1/cloud:aliyun-ecs/{endpoint} or from Claude, ChatGPT and Cursor through the Apizie MCP server. Free plan: 1,000 requests a month.

- Project key: `cloud:aliyun-ecs`
- Category: Cloud
- Status: byok
- Source: https://api.alibabacloud.com/product/ecs
- Page: https://zieapi.vercel.app/api/cloud/aliyun-ecs
- OpenAPI: https://zieapi.vercel.app/api/cloud/aliyun-ecs/openapi.json

Alibaba Cloud OpenAPI for Elastic Compute Service (ecs, version 2014-05-26). Calls are signed with ACS3-HMAC-SHA256 using your AccessKey ID and secret.

## Endpoints

### Accepts and authorizes the execution of a system event. For a system event in the Inquiring state, this…
`POST https://zieapi.vercel.app/v1/cloud:aliyun-ecs/accept-inquired-system-event` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://ecs.ap-southeast-1.aliyuncs.com |
| RegionId | string | yes | The region ID of the system event. You can call the https://help.aliyun.com/document_detail/25609.html operation to query the latest… |
| EventId | string | yes | The ID of the system event |
| Choice | string | no | This parameter is in invitational preview and is not supported |

### Creates one or more pay-as-you-go or subscription dedicated hosts. A dedicated host is a physical server…
`POST https://zieapi.vercel.app/v1/cloud:aliyun-ecs/allocate-dedicated-hosts` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://ecs.ap-southeast-1.aliyuncs.com |
| RegionId | string | yes | The region ID of the dedicated host. You can call https://help.aliyun.com/document_detail/25609.html to query the most recent region list |
| Tag | string | no | The tags (JSON-encoded) |
| ResourceGroupId | string | no | The ID of the resource group to which the dedicated host belongs |
| ZoneId | string | no | The zone ID of the dedicated host. Default value: empty, which indicates that the system selects a zone |
| DedicatedHostName | string | no | The name of the dedicated host. The name must be 2 to 128 characters in length and can contain Unicode characters under the Letter… |
| DedicatedHostClusterId | string | no | The ID of the dedicated host cluster to which the dedicated host belongs |
| DedicatedHostType | string | yes | The type of the dedicated host. You can call https://help.aliyun.com/document_detail/134240.html to query the most recent list of… |
| ActionOnMaintenance | string | no | The policy used to migrate the instances deployed on the dedicated host when the dedicated host fails or needs to be repaired online.… |
| NetworkAttributes.SlbUdpTimeout | integer | no | The timeout period of a UDP session for load balancing connections to the dedicated host. Unit: seconds. Valid values: 15 to 310 |
| NetworkAttributes.UdpTimeout | integer | no | The timeout period of a UDP session between a user and a cloud service running on the dedicated host. Unit: seconds. Valid values: 15 to 310 |
| Description | string | no | The description of the dedicated host. The description must be 2 to 256 characters in length and cannot start with `http://` or `https://` |
| AutoPlacement | string | no | Specifies whether to add the dedicated host to the automatic deployment resource pool. If you create an instance on a dedicated host… |
| CpuOverCommitRatio | number | no | The CPU overcommit ratio. Only the custom instance types g6s, c6s, and r6s support the CPU overcommit ratio. Valid values: 1 to 5. The CPU… |
| MinQuantity | integer | no | The minimum number of dedicated hosts to create. Valid values: 1 to 100. If the active stock of dedicated hosts is less than the minimum… |
| ChargeType | string | no | The billing method of the dedicated host. Valid values: PrePaid: subscription. If you set this parameter to PrePaid, confirm that your… |
| Quantity | integer | no | The number of dedicated hosts to create. Valid values: 1 to 100. Default value: 1 |
| Period | integer | no | The subscription duration of the dedicated host. The `Period` parameter takes effect and is required only when `ChargeType` is set to… |
| PeriodUnit | string | no | The unit of the subscription duration. Valid values: Week Month Year Month Year Default value: Month |
| AutoRenew | string | no | Specifies whether to enable auto-renewal for the subscription dedicated host. The AutoRenew parameter takes effect only when ChargeType is… |
| AutoRenewPeriod | integer | no | The auto-renewal duration. The AutoRenewPeriod parameter takes effect and is required only when AutoRenew is set to true. Valid values: If… |
| AutoReleaseTime | string | no | The automatic release time of the dedicated host. Specify the time in the ISO 8601 standard in the `yyyy-MM-ddTHH:mm:ssZ` format. The time… |
| 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… |

### Assigns a public IP address to an ECS instance. Use the ModifyInstanceNetworkSpec operation to assign a…
`POST https://zieapi.vercel.app/v1/cloud:aliyun-ecs/allocate-public-ip-address` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://ecs.ap-southeast-1.aliyuncs.com |
| InstanceId | string | yes | The ID of the instance to which you want to assign an IP address. The bandwidth of the instance must be greater than 0 |
| IpAddress | string | no | The public IP address of the instance. If this parameter is empty, the system randomly assigns an IP address by default. Only whitelisted… |
| VlanId | string | no | The VLAN ID of the instance. This parameter is deprecated. To improve compatibility, use other parameters instead |

### Applies an automatic snapshot policy to one or more cloud disks
`POST https://zieapi.vercel.app/v1/cloud:aliyun-ecs/apply-auto-snapshot-policy` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://ecs.ap-southeast-1.aliyuncs.com |
| regionId | string | yes | The region ID of the automatic snapshot policy and the cloud disks. You can call the https://help.aliyun.com/document_detail/25609.html… |
| autoSnapshotPolicyId | string | yes | The ID of the target automatic snapshot policy |
| diskIds | string | yes | The IDs of one or more cloud disks. The value is a JSON array. Separate multiple cloud disk IDs with commas (,) |

### Allocates one or more IPv6 addresses to an elastic network interface (ENI)
`POST https://zieapi.vercel.app/v1/cloud:aliyun-ecs/assign-ipv6-addresses` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://ecs.ap-southeast-1.aliyuncs.com |
| RegionId | string | yes | The region ID of the elastic network interface (ENI). You can call https://help.aliyun.com/document_detail/25609.html to query the most… |
| NetworkInterfaceId | string | yes | The ID of the elastic network interface (ENI) |
| Ipv6AddressCount | integer | no | The number of IPv6 addresses to randomly generate for the elastic network interface (ENI). Valid values: 1 to 10. When you call this… |
| Ipv6Address | string | no | One or more IPv6 addresses to assign to the elastic network interface (ENI). You can set up to 10 IPv6 addresses. Valid values of N: 1 to… |
| Ipv6Prefix | string | no | One or more IPv6 prefixes to assign to the elastic network interface (ENI). Valid values of N: 1 to 10. If you want to set IPv6 prefixes… |
| Ipv6PrefixCount | integer | no | The number of IPv6 prefixes to assign to the elastic network interface (ENI). Valid values: 1 to 10. If you want to set IPv6 prefixes for… |
| 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… |

### Assigns one or more secondary private IP addresses to an elastic network interfaces (ENIs). You can specify…
`POST https://zieapi.vercel.app/v1/cloud:aliyun-ecs/assign-private-ip-addresses` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://ecs.ap-southeast-1.aliyuncs.com |
| RegionId | string | yes | The region ID of the elastic network interfaces (ENIs). You can call https://help.aliyun.com/document_detail/25609.html to query the most… |
| NetworkInterfaceId | string | yes | The elastic network interfaces (ENIs) ID |
| SecondaryPrivateIpAddressCount | integer | no | The number of private IP addresses to automatically assign from the idle IP addresses of the vSwitch. When you assign secondary private IP… |
| 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… |
| PrivateIpAddress | string | no | One or more secondary private IP addresses selected from the idle private IP addresses of the vSwitch to which the elastic network… |
| Ipv4Prefix | string | no | One or more IPv4 prefixes to specify for the elastic network interfaces (ENIs). Valid values of N: 1 to 10. To set IPv4 prefixes for the… |
| Ipv4PrefixCount | integer | no | The number of randomly generated IPv4 prefixes to specify for the elastic network interfaces (ENIs). Valid values: 1 to 10. To set IPv4… |

### Invokes AttachClassicLinkVpc to connect a classic network type instance to a virtual private cloud (VPC) so…
`POST https://zieapi.vercel.app/v1/cloud:aliyun-ecs/attach-classic-link-vpc` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://ecs.ap-southeast-1.aliyuncs.com |
| RegionId | string | yes | The region ID of the instance. You can call https://help.aliyun.com/document_detail/25609.html to query the most recent region list |
| InstanceId | string | yes | The instance ID of the classic network type instance. You can invoke https://help.aliyun.com/document_detail/25506.html to query your… |
| VpcId | string | yes | The ID of the VPC for which you enable ClassicLink. You can invoke https://help.aliyun.com/document_detail/35739.html to query your active… |

### Attaches a data disk or a system disk to an ECS instance
`POST https://zieapi.vercel.app/v1/cloud:aliyun-ecs/attach-disk` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://ecs.ap-southeast-1.aliyuncs.com |
| InstanceId | string | yes | The ID of the ECS instance to which you want to attach the disk |
| DiskId | string | yes | The ID of the disk that you want to attach. The disk (`DiskId`) and the instance (`InstanceId`) must be in the same zone. You can attach… |
| Device | string | no | The device name of the disk. This parameter is being deprecated. To improve compatibility, we recommend that you use other parameters to… |
| DeleteWithInstance | string | no | Specifies whether to release the disk when the instance is released. Valid values: true: The disk is released. false: The disk is not… |
| Bootable | string | no | Specifies whether to attach the disk as a system disk. Valid values: true: Yes. false: No. Default value: false. If you set this parameter… |
| Password | string | no | The logon password of the instance, which is configured when you attach a system disk. This parameter takes effect only for the… |
| KeyPairName | string | no | The name of the SSH key pair to bind to a Linux ECS instance when you attach a system disk. Windows Server: SSH key pairs are not… |
| Force | string | no | Specifies whether to forcibly attach the disk. Valid values: true: Yes. false: No. Default value: false. Currently, only regional… |

### Attaches an instance RAM role to one or more ECS instances
`POST https://zieapi.vercel.app/v1/cloud:aliyun-ecs/attach-instance-ram-role` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://ecs.ap-southeast-1.aliyuncs.com |
| RegionId | string | yes | The region ID. You can call https://help.aliyun.com/document_detail/25609.html to query the most recent region list |
| RamRoleName | string | yes | The name of the instance RAM role. You can call the RAM API https://help.aliyun.com/document_detail/28713.html to query the instance RAM… |
| InstanceIds | string | yes | The instance ID array. Array length: 1 to 100 |
| Policy | string | no | The additional access policy. You can specify an additional access policy to further restrict the permissions of the RAM role. For more… |

### Attaches an SSH key pair to one or more Linux instances
`POST https://zieapi.vercel.app/v1/cloud:aliyun-ecs/attach-key-pair` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://ecs.ap-southeast-1.aliyuncs.com |
| RegionId | string | yes | The region ID of the SSH key pair. You can call https://help.aliyun.com/document_detail/25609.html to query the most recent region list |
| KeyPairName | string | yes | The name of the SSH key pair |
| InstanceIds | string | yes | The IDs of the instances to which you want to attach the SSH key pair. The value can be a JSON array that consists of up to 50 instance… |

### Attaches an Elastic Network Interface (ENI) to a VPC-type ECS instance by calling the AttachNetworkInterface…
`POST https://zieapi.vercel.app/v1/cloud:aliyun-ecs/attach-network-interface` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://ecs.ap-southeast-1.aliyuncs.com |
| RegionId | string | yes | The region ID of the instance. You can call https://help.aliyun.com/document_detail/25609.html to query the most recent region list |
| NetworkInterfaceId | string | yes | The network interface controller (NIC) ID |
| InstanceId | string | yes | The instance ID |
| TrunkNetworkInstanceId | string | no | The trunk ENI ID. This parameter is not yet available |
| WaitForNetworkConfigurationReady | string | no | This parameter is deprecated |
| NetworkCardIndex | integer | no | The index of the network card specified for the ENI. The valid values of NetworkCardIndex depend on the instance family. If the instance… |

### Adds one or more inbound rules to a security group. This operation allows you to specify inbound access…
`POST https://zieapi.vercel.app/v1/cloud:aliyun-ecs/authorize-security-group` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://ecs.ap-southeast-1.aliyuncs.com |
| RegionId | string | yes | The region ID of the security group. You can call the https://help.aliyun.com/document_detail/25609.html operation to query the most… |
| 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… |
| SecurityGroupId | string | yes | The ID of the security group |
| Permissions | string | no | The array of security group rules. Valid values for the array length: 1 to 100 (JSON-encoded) |
| Policy | string | no | [Deprecated] Use Permissions.N.Policy for access permission settings |
| Priority | string | no | [Deprecated] Use Permissions.N.Priority to specify the priority of the security group rule |
| IpProtocol | string | no | [Deprecated] Use Permissions.N.IpProtocol to specify the protocol type |
| SourceCidrIp | string | no | [Deprecated] Use Permissions.N.SourceCidrIp to specify the source IPv4 CIDR block |
| Ipv6SourceCidrIp | string | no | [Deprecated] Use Permissions.N.Ipv6SourceCidrIp to specify the source IPv6 CIDR block |
| SourceGroupId | string | no | [Deprecated] Use Permissions.N.SourceGroupId to specify the source security group ID |
| SourcePrefixListId | string | no | [Deprecated] Use Permissions.N.SourcePrefixListId to specify the source prefix list ID |
| PortRange | string | no | [Deprecated] Use Permissions.N.PortRange to specify the port range |
| DestCidrIp | string | no | [Deprecated] Use Permissions.N.DestCidrIp to specify the destination IPv4 CIDR block |
| Ipv6DestCidrIp | string | no | [Deprecated] Use Permissions.N.Ipv6DestCidrIp to specify the destination IPv6 CIDR block |
| SourcePortRange | string | no | [Deprecated] Use Permissions.N.SourcePortRange to specify the source port range |
| SourceGroupOwnerAccount | string | no | [Deprecated] Use Permissions.N.SourceGroupOwnerAccount to specify the Alibaba Cloud account that owns the source security group |
| SourceGroupOwnerId | integer | no | [Deprecated] Use Permissions.N.SourceGroupOwnerId to specify the ID of the Alibaba Cloud account that owns the source security group |
| NicType | string | no | [Deprecated] Use Permissions.N.NicType to specify the NIC type |
| Description | string | no | [Deprecated] Use Permissions.N.Description to specify the description of the security group rule |

### Adds one or more outbound security group rules. This operation allows you to specify outbound access…
`POST https://zieapi.vercel.app/v1/cloud:aliyun-ecs/authorize-security-group-egress` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://ecs.ap-southeast-1.aliyuncs.com |
| RegionId | string | yes | The region ID of the source security group. You can call the https://help.aliyun.com/document_detail/25609.html operation to query 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 token, but you must make… |
| SecurityGroupId | string | yes | The security group ID |
| Permissions | string | no | The array of security group rules. Length: 1 to 100 (JSON-encoded) |
| Policy | string | no | [Deprecated] Use Permissions.N.Policy for the access permission settings |
| Priority | string | no | [Deprecated] Use Permissions.N.Priority to specify the rule priority |
| IpProtocol | string | no | [Deprecated] Use Permissions.N.IpProtocol to specify the protocol type |
| DestCidrIp | string | no | [Deprecated] Use Permissions.N.DestCidrIp to specify the destination IPv4 Classless Inter-Domain Routing (CIDR) block |
| Ipv6DestCidrIp | string | no | [Deprecated] Use Permissions.N.Ipv6DestCidrIp to specify the destination IPv6 Classless Inter-Domain Routing (CIDR) block |
| DestGroupId | string | no | [Deprecated] Use Permissions.N.DestGroupId to specify the destination security group ID |
| DestPrefixListId | string | no | [Deprecated] Use Permissions.N.DestPrefixListId to specify the destination prefix list ID |
| PortRange | string | no | [Deprecated] Use Permissions.N.PortRange to specify the port range |
| SourceCidrIp | string | no | [Deprecated] Use Permissions.N.SourceCidrIp to specify the source IPv4 CIDR block |
| Ipv6SourceCidrIp | string | no | [Deprecated] Use Permissions.N.Ipv6SourceCidrIp to specify the source IPv6 CIDR block |
| SourcePortRange | string | no | [Deprecated] Use Permissions.N.SourcePortRange to specify the source port range |
| DestGroupOwnerAccount | string | no | [Deprecated] Use Permissions.N.DestGroupOwnerAccount to specify the Alibaba Cloud account to which the destination security group belongs |
| DestGroupOwnerId | integer | no | [Deprecated] Use Permissions.N.DestGroupOwnerId to specify the ID of the Alibaba Cloud account to which the destination security group… |
| NicType | string | no | [Deprecated] Use Permissions.N.NicType to specify the NIC type |
| Description | string | no | [Deprecated] Use Permissions.N.Description to specify the description of the rule |

### Cancels the automatic snapshot policy for one or more cloud disks
`POST https://zieapi.vercel.app/v1/cloud:aliyun-ecs/cancel-auto-snapshot-policy` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://ecs.ap-southeast-1.aliyuncs.com |
| regionId | string | yes | The region ID of the automatic snapshot policy and cloud disks. You can call https://help.aliyun.com/document_detail/25609.html to query… |
| diskIds | string | yes | The IDs of the cloud disks. To cancel the automatic snapshot policy for multiple cloud disks, specify the cloud disk IDs in a JSON array… |
| autoSnapshotPolicyId | string | no | The ID of the automatic snapshot policy that you want to cancel. Default value: empty. If you use the default value, note the following… |

### Cancels an ongoing image copy task
`POST https://zieapi.vercel.app/v1/cloud:aliyun-ecs/cancel-copy-image` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://ecs.ap-southeast-1.aliyuncs.com |
| RegionId | string | yes | The ID of the region to which the destination image belongs. You can call the https://help.aliyun.com/document_detail/25609.html operation… |
| ImageId | string | yes | The ID of the image that is being copied |

### Cancels an image build task
`POST https://zieapi.vercel.app/v1/cloud:aliyun-ecs/cancel-image-pipeline-execution` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://ecs.ap-southeast-1.aliyuncs.com |
| RegionId | string | yes | The region ID. You can call https://help.aliyun.com/document_detail/25609.html to query the latest Alibaba Cloud regions |
| TemplateTag | string | no | This parameter is not available (JSON-encoded) |
| ExecutionId | string | yes | The ID of the build task |

### Cancels one or more simulated system events that are in the Scheduled or Executing state. After a system…
`POST https://zieapi.vercel.app/v1/cloud:aliyun-ecs/cancel-simulated-system-events` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://ecs.ap-southeast-1.aliyuncs.com |
| RegionId | string | yes | The region ID. You can call https://help.aliyun.com/document_detail/25609.html to query the most recent region list |
| EventId | string | yes | The list of system event IDs. You can specify up to 100 event IDs (JSON-encoded) |

### Cancels a running task. You can cancel running image import tasks (ImportImage) and image export tasks…
`POST https://zieapi.vercel.app/v1/cloud:aliyun-ecs/cancel-task` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://ecs.ap-southeast-1.aliyuncs.com |
| RegionId | string | yes | The region ID. You can call https://help.aliyun.com/document_detail/25609.html to query the most recent region list |
| TaskId | string | yes | The task ID. You can call https://help.aliyun.com/document_detail/25622.html to query the task ID list |

### Clones a cloud disk to quickly create a new cloud disk with the same data as the source disk in the same…
`POST https://zieapi.vercel.app/v1/cloud:aliyun-ecs/clone-disks` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://ecs.ap-southeast-1.aliyuncs.com |
| RegionId | string | yes | The region ID. You can call the DescribeRegions (https://www.alibabacloud.com/help/en/ecs/api-regions-describeregions) operation to query… |
| DryRun | string | no | Specifies whether to only perform a dry run for this request. Valid values: true: sends a check request and does not perform the actual… |
| ClientToken | string | no | Ensures the idempotence of the request. You can generate a parameter value from your client to ensure that the value is unique across… |
| Tag | string | no | The list of tag information for the cloud disk (JSON-encoded) |
| ResourceGroupId | string | no | The ID of the resource group to which the cloud disk belongs |
| SourceDiskId | string | yes | The ID of the source cloud disk |
| DiskName | string | no | The name of the cloud disk. The name must be 2 to 128 characters in length and can contain letters in the Unicode letter category… |
| DiskCategory | string | yes | The category of the new cloud disk. Valid values: cloud_essd: ESSD. cloud_auto: ESSD AutoPL. cloud_essd_entry: ESSD Entry.… |
| PerformanceLevel | string | no | The performance level settings of the cloud disk when you create an ESSD. Valid values: PL0: A single ESSD can deliver up to 10,000 random… |
| Size | integer | yes | The capacity of the new cloud disk. Unit: GiB. You must specify a value for this parameter. Valid values: cloud_essd: The valid values… |
| MultiAttach | string | yes | Specifies whether to enable the multi-attach feature for the new cloud disk. Valid values: Disabled: disables the feature. Enabled:… |
| ProvisionedIops | integer | no | The provisioned read and write IOPS for a single ESSD AutoPL. Valid values: If the capacity is less than or equal to 3 GiB, provisioned… |
| BurstingEnabled | string | no | Specifies whether to enable performance bursting for the new cloud disk. Valid values: true: enables performance bursting. false: disables… |
| Encrypted | string | no | Specifies whether the new cloud disk is encrypted. Valid values: true: The cloud disk is encrypted. false: The cloud disk is not… |
| KmsKeyId | string | no | The KMS key ID used by the new cloud disk |
| Arn | string | no | This parameter is not available (JSON-encoded) |

### Converts the public IP address (PublicIP) of a VPC-type ECS instance to an Elastic IP Address (EIP)
`POST https://zieapi.vercel.app/v1/cloud:aliyun-ecs/convert-nat-public-ip-to-eip` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://ecs.ap-southeast-1.aliyuncs.com |
| InstanceId | string | yes | The instance ID of the instance whose public IP address you want to convert |
| RegionId | string | yes | The region ID of the instance. You can call https://help.aliyun.com/document_detail/25609.html to query the most recent region list |

### Copies a custom image from one region to another. Copying images enables cross-region deployment and…
`POST https://zieapi.vercel.app/v1/cloud:aliyun-ecs/copy-image` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://ecs.ap-southeast-1.aliyuncs.com |
| DestinationImageName | string | no | The name of the copied image. The name must be 2 to 128 characters in length. It must start with a letter or a Chinese character, and… |
| DestinationDescription | string | no | The description of the copied image. The description must be 2 to 256 characters in length, and cannot start with http:// or https:// |
| ImageId | string | yes | The ID of the source custom image |
| RegionId | string | yes | The region ID of the source custom image. You can call the https://help.aliyun.com/document_detail/25609.html operation to query the most… |
| DestinationRegionId | string | no | The ID of the destination region |
| Encrypted | string | no | Specifies whether to encrypt the copied image. Valid values: true: Encrypts the image. false: Does not encrypt the image. Not specified:… |
| KMSKeyId | string | no | The ID of the key used to encrypt the image |
| EncryptAlgorithm | string | no | This parameter is not available |
| ResourceGroupId | string | no | The resource group ID of the image after replication. If you do not specify this parameter, the image after replication belongs to the… |
| Tag | string | no | The list of tags (JSON-encoded) |
| DryRun | string | no | Specifies whether to only perform a dry run for this request. Valid values: true: performs a dry run. The system checks whether your… |
| 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… |

### Copies a standard snapshot or an encrypted snapshot from one region to another
`POST https://zieapi.vercel.app/v1/cloud:aliyun-ecs/copy-snapshot` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://ecs.ap-southeast-1.aliyuncs.com |
| ResourceGroupId | string | no | This parameter is not available |
| Tag | string | no | The tag information of the new snapshot (JSON-encoded) |
| RegionId | string | yes | The region where the source snapshot resides. You can call the https://help.aliyun.com/document_detail/25609.html operation to query the… |
| DestinationRegionId | string | yes | The ID of the destination region for the new snapshot |
| SnapshotId | string | yes | The ID of the source snapshot |
| DestinationSnapshotName | string | yes | The name of the new snapshot. The name must be 2 to 128 characters in length, must start with a letter or a Chinese character, and cannot… |
| DestinationSnapshotDescription | string | yes | The description of the new snapshot. The description must be 2 to 256 characters in length and cannot start with http:// or https://.… |
| RetentionDays | integer | no | The retention period of the new snapshot. Unit: days. The snapshot is subject to automatic release when the retention period expires.… |
| Encrypted | string | no | Specifies whether to encrypt the cloud disk. Valid values: true: yes. false: no. Default value: false |
| KMSKeyId | string | no | The KMS customer master key (CMK) in the destination region |
| Arn | string | no | This parameter is in invitational preview and is not supported (JSON-encoded) |
| DestinationStorageLocationArn | string | no | This parameter is not available |
| 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… |

### Creates an activation code that is used to register non-Alibaba Cloud servers as Alibaba Cloud managed…
`POST https://zieapi.vercel.app/v1/cloud:aliyun-ecs/create-activation` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://ecs.ap-southeast-1.aliyuncs.com |
| RegionId | string | yes | The region ID. The following regions are supported: China (Qingdao), China (Beijing), China (Zhangjiakou), China (Hohhot), China… |
| InstanceName | string | no | The default instance name prefix. The prefix must be 2 to 50 characters in length and must start with a letter. It cannot start with a… |
| Description | string | no | The description of the activation code. The description must be 1 to 100 characters in length |
| InstanceCount | integer | no | The maximum number of times that the activation code can be used to register managed instances. Valid values: 1 to 1000. Default value: 10 |
| TimeToLiveInHours | integer | no | The validity period of the activation code. After the validity period expires, the activation code cannot be used to register new… |
| IpAddressRange | string | no | The IP addresses of hosts that are allowed to use the activation code. The value can be an IPv4 address, an IPv6 address, or a CIDR block |
| 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… |
| ResourceGroupId | string | no | The ID of the resource group to which the activation code belongs |
| Tag | string | no | The tags (JSON-encoded) |

### Creates an auto provisioning group
`POST https://zieapi.vercel.app/v1/cloud:aliyun-ecs/create-auto-provisioning-group` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://ecs.ap-southeast-1.aliyuncs.com |
| RegionId | string | yes | The ID of the region where the auto provisioning group resides. You can invoke the https://help.aliyun.com/document_detail/25609.html… |
| ResourceGroupId | string | no | The ID of the resource group to which the auto provisioning group belongs |
| AutoProvisioningGroupName | string | no | The name of the auto provisioning group. The name must be 2 to 128 characters in length. It must start with a letter or a Chinese… |
| AutoProvisioningGroupType | string | no | The delivery type of the auto provisioning group. Valid values: request: one-time asynchronous delivery. The auto provisioning group… |
| SpotAllocationStrategy | string | no | The policy for creating spot instances. Valid values: lowest-price: cost optimization policy. The instance type with the lowest price is… |
| SpotInstanceInterruptionBehavior | string | no | The behavior when a spot instance is interrupted. Valid values: stop: stops the instance. terminate: releases the instance. Default value:… |
| SpotInstancePoolsToUseCount | integer | no | The number of instance types with the lowest prices that are selected by the auto provisioning group to create instances. This parameter… |
| PayAsYouGoAllocationStrategy | string | no | The policy for creating pay-as-you-go instances. Valid values: lowest-price: cost optimization policy. The instance type with the lowest… |
| ExcessCapacityTerminationPolicy | string | no | Specifies whether to release the instances that are removed during a scale-down event when the real-time capacity of the auto provisioning… |
| ValidFrom | string | no | The time when the auto provisioning group starts. This parameter and `ValidUntil` determine the validity period. Specify the time in the… |
| ValidUntil | string | no | The time when the auto provisioning group expires. This parameter and `ValidFrom` determine the validity period. Specify the time in the… |
| TerminateInstancesWithExpiration | string | no | Specifies whether to release the instances in the auto provisioning group when the group expires. Valid values: true: releases the… |
| TerminateInstances | string | no | Specifies whether to release the instances in the auto-provisioning group when the group is deleted. Valid values: true: releases the… |
| MaxSpotPrice | number | no | The maximum price of spot instances in the auto provisioning group. If the Settings for both `MaxSpotPrice` and… |
| TotalTargetCapacity | string | yes | The total target capacity of the auto provisioning group. Valid values: positive integers. The total target capacity must be greater than… |
| PayAsYouGoTargetCapacity | string | no | The target capacity of pay-as-you-go instances in the auto provisioning group. Valid values: an integer less than or equal to the… |
| SpotTargetCapacity | string | no | The target capacity of spot instances in the auto provisioning group. Valid values: an integer less than or equal to the parameter value… |
| DefaultTargetCapacityType | string | no | The Billable methods for the capacity difference when the sum of `PayAsYouGoTargetCapacity` and `SpotTargetCapacity` is less than… |
| LaunchTemplateId | string | no | The ID of the launch template associated with the auto provisioning group. You can invoke the… |
| LaunchTemplateVersion | string | no | The version of the launch template associated with the auto provisioning group. You can invoke the… |
| Description | string | no | The description of the auto provisioning 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 token, but you must ensure… |
| LaunchConfiguration.ImageId | string | no | The ID of the image. The image resource selected when the instance is started. You can call the… |
| LaunchConfiguration.SecurityGroupId | string | no | The ID of the security group to which the instance belongs. If both a launch template and launch configuration information are specified,… |
| LaunchConfiguration.IoOptimized | string | no | Specifies whether the instance is an I/O optimization instance. Valid values: none: The instance does not support I/O optimization.… |
| LaunchConfiguration.InternetChargeType | string | no | The network billing method. Valid values: PayByBandwidth: pay-by-bandwidth. PayByTraffic: pay-by-traffic. In pay-by-traffic mode, the peak… |
| LaunchConfiguration.InternetMaxBandwidthIn | integer | no | The maximum inbound public bandwidth. Unit: Mbit/s. Valid values: When the outbound public bandwidth is less than or equal to 10 Mbit/s: 1… |
| LaunchConfiguration.InternetMaxBandwidthOut | integer | no | The maximum outbound public bandwidth. Unit: Mbit/s. Valid values: 0 to 100. Default value: 0. If you specify both a launch template and… |
| LaunchConfiguration.InstanceName | string | no | The name of the instance. The name must be 2 to 128 characters in length. It must start with a letter or a Chinese character and cannot… |
| LaunchConfiguration.HostName | string | no | The hostname of the instance. Limits: The hostname cannot start or end with a period (.) or a hyphen (-), and cannot contain consecutive… |
| LaunchConfiguration.InstanceDescription | string | no | The description of the instance. The description must be 2 to 256 characters in length and cannot start with `http://` or `https://`. If… |
| LaunchConfiguration.KeyPairName | string | no | The name of the key pair. For Windows instances, this parameter is ignored. Default value: null. For Linux instances, password logon is… |
| LaunchConfiguration.RamRoleName | string | no | The name of the instance RAM role. You can use the RAM API operation https://help.aliyun.com/document_detail/28713.html to query the… |
| LaunchConfiguration.SecurityEnhancementStrategy | string | no | Specifies whether to enable security hardening. Valid values: Active: enables security hardening. This value is applicable only to public… |
| LaunchConfiguration.UserData | string | no | Instance user data of the instance. Instance user data must be encoded in Base64. The maximum size of the raw data is 32 KB. If you… |
| LaunchConfiguration.SystemDiskCategory | string | no | The category of the system disk. Valid values: cloud_efficiency: ultra disk. cloud_ssd: standard SSD. cloud_essd: enterprise SSD. cloud:… |
| LaunchConfiguration.SystemDiskSize | integer | no | The size of the system disk. Unit: GiB. Valid values: 20 to 500. The value of this parameter must be greater than or equal to max{20, the… |
| LaunchConfiguration.SystemDiskName | string | no | The name of the system disk. The name must be 2 to 128 characters in length. It must start with a letter or a Chinese character and cannot… |
| LaunchConfiguration.SystemDiskDescription | string | no | The description of the system disk. The description must be 2 to 256 characters in length and cannot start with `http://` or `https://`.… |
| LaunchConfiguration.SystemDiskPerformanceLevel | string | no | The performance level Settings for the standard SSD used as the system disk. Valid values: PL0 (default): A single enterprise SSD can… |
| LaunchConfiguration.PasswordInherit | string | no | Specifies whether to use the password preset in the image. Valid values: true: uses the preset password. false: does not use the preset… |
| LaunchConfiguration.ResourceGroupId | string | no | The ID of the resource group to which the instance belongs. If you specify both a launch template and launch configurations, the system… |
| LaunchConfiguration.CreditSpecification | string | no | The performance mode of the burstable instance. Valid values: Standard: standard mode. For more information about instance performance,… |
| LaunchConfiguration.Password | string | no | The password of the instance. The password must be 8 to 30 characters in length and must contain at least three of the following character… |
| LaunchConfiguration.DeploymentSetId | string | no | The ID of the deployment set |
| LaunchTemplateConfig | string | no | The extended launch templates (JSON-encoded) |
| LaunchConfiguration.DataDisk | string | no | The extended list of disk configurations for the launch template (JSON-encoded) |
| LaunchConfiguration.Tag | string | no | The extended list of tags for the launch template (JSON-encoded) |
| SystemDiskConfig | string | no | The list of system disk configurations for the instance (JSON-encoded) |
| DataDiskConfig | string | no | The list of data disk configurations for the instance (JSON-encoded) |
| LaunchConfiguration.HostNames | string | no | The list of hostnames for one or more instances. Limits: This parameter takes effect only when you create an auto provisioning group of… |
| MinTargetCapacity | string | no | The minimum target capacity of the auto provisioning group. Valid values: positive integers. Take note of the following items when you… |
| LaunchConfiguration.SecurityGroupIds | string | no | The list of security groups to which the instance belongs (JSON-encoded) |
| LaunchConfiguration.SystemDisk | string | no | The system disk configuration of the instance. If both the launch template and the launch configurations are specified, the launch… |
| LaunchConfiguration.Arn | string | no | This parameter is in invitational preview and is not supported (JSON-encoded) |
| HibernationOptionsConfigured | string | no | This parameter is in invitational preview and is not available |
| LaunchConfiguration.AutoReleaseTime | string | no | The automatic release time of the pay-as-you-go instance. Specify the time in the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format.… |
| LaunchConfiguration.ImageFamily | string | no | The name of the image family. The name must be 2 to 128 characters in length. It must start with a letter or a Chinese character, and… |
| Tag | string | no | The list of tags bound to the auto provisioning group (JSON-encoded) |
| ResourcePoolOptions | string | no | The resource pool policy used when creating instances. Take note of the following items when you configure this parameter: This parameter… |
| LaunchConfiguration | string | no | The launch configurations (JSON-encoded) |
| PrePaidOptions | string | no | The detailed capacity configurations for subscription instances (JSON-encoded) |
| ExecutionMode | string | no | The ExecutionMode |
| CandidateOptions | string | no | The configuration options when AutoProvisioningGroupType is set to candidate (JSON-encoded) |

### Creates an automatic snapshot policy in a specified region. You can specify the repetition cycle, retention…
`POST https://zieapi.vercel.app/v1/cloud:aliyun-ecs/create-auto-snapshot-policy` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://ecs.ap-southeast-1.aliyuncs.com |
| regionId | string | yes | The region to which the automatic snapshot policy belongs. You can call https://help.aliyun.com/document_detail/25609.html to query the… |
| autoSnapshotPolicyName | string | no | The name of the automatic snapshot policy. The name must be 2 to 128 characters in length. It must start with a letter or a Chinese… |
| timePoints | string | yes | The points in time when automatic snapshots are created. The time is in UTC+8 and measured in hours. Valid values: 0 to 23, which… |
| repeatWeekdays | string | yes | The days of the week when automatic snapshots are created. Valid values: 1 to 7, which represent Monday to Sunday. For example, 1… |
| retentionDays | integer | yes | The retention period of automatic snapshots. Unit: days. Valid values: -1: The snapshots are retained permanently. 1 to 65535: The… |
| EnableCrossRegionCopy | string | no | Specifies whether to allow automatic cross-region replication. Valid values: true: Allowed. false: Not allowed |
| TargetCopyRegions | string | no | The destination region for cross-region snapshot replication. You can specify only one destination region |
| StorageLocationArn | string | no | This parameter is not available |
| CopiedSnapshotsRetentionDays | integer | no | The retention period of cross-region replicated snapshots. Unit: days. Valid values: -1: The snapshots are retained permanently. 1 to… |
| CopyEncryptionConfiguration | string | no | The backup encryption parameter object for snapshot geo-redundancy (JSON-encoded) |
| ResourceGroupId | string | no | The ID of the resource group |
| Tag | string | no | The list of tags for the automatic snapshot policy (JSON-encoded) |
| AssociationType | string | no | The association type between the automatic snapshot policy and the target resources. Valid values: AssociatedWithDisk: Associated with… |
| TargetTags | string | no | The list of target resource tags. The automatic snapshot policy matches target resources based on tags. This parameter is required when… |

### Creates a capacity reservation by specifying the instance type, total number of instances, effective mode,…
`POST https://zieapi.vercel.app/v1/cloud:aliyun-ecs/create-capacity-reservation` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://ecs.ap-southeast-1.aliyuncs.com |
| RegionId | string | yes | The region ID of the capacity reservation. You can call https://help.aliyun.com/document_detail/25609.html to query the most recent region… |
| ResourceGroupId | string | no | The ID of the enterprise resource group to which the capacity reservation belongs |
| Tag | string | no | The list of tags bound to the capacity reservation (JSON-encoded) |
| 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, and you must make… |
| PrivatePoolOptions.Name | string | no | The name of the capacity reservation. The name must be 2 to 128 characters in length, and can contain letters and Chinese characters. It… |
| Description | string | no | The description of the capacity reservation. The description must be 2 to 256 characters in length, and can contain letters and Chinese… |
| PrivatePoolOptions.MatchCriteria | string | no | The type of the private pool generated after the capacity reservation takes effect. Valid values: Open: open mode. When an instance is… |
| InstanceAmount | integer | yes | The total number of instances to be reserved for the instance type |
| InstanceType | string | yes | The instance type. Currently, you can configure the settings for a capacity reservation for only one instance type. You can invoke… |
| StartTime | string | no | The effective mode of the capacity reservation. Currently, calling this API operation only supports setting the reservation to take effect… |
| EndTime | string | no | The expiration time of the capacity reservation. Specify the time in the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time… |
| EndTimeType | string | no | The expiration pattern of the capacity reservation. Valid values: Limited: releases the reservation at a specified time. You must also… |
| Platform | string | no | The operating system type of the image used by the instance. This parameter corresponds to the Platform parameter of a regional reserved… |
| InstanceChargeType | string | no | The billing method for the instance. Currently, only PostPaid (pay-as-you-go) is supported. Default value: PostPaid |
| ZoneId | string | yes | The zone ID of the region to which the capacity reservation belongs. Currently, you can create a capacity reservation in only one zone… |

### Creates a Cloud Assistant command of the Shell, PowerShell, or Bat script type
`POST https://zieapi.vercel.app/v1/cloud:aliyun-ecs/create-command` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://ecs.ap-southeast-1.aliyuncs.com |
| RegionId | string | yes | The region ID. You can call https://help.aliyun.com/document_detail/25609.html to query the most recent region list |
| Name | string | yes | The command name. All character sets are supported. The name can be up to 128 characters in length |
| Description | string | no | The command description. All character sets are supported. The description can be up to 512 characters in length |
| Type | string | yes | The type of the command. Valid values: RunBatScript: creates a Bat script to run on Windows instances. RunPowerShellScript: creates a… |
| CommandContent | string | yes | The Base64-encoded content of the command. The value of this parameter must be Base64-encoded and cannot exceed 24 KB in size after… |
| WorkingDir | string | no | The directory where the command is run on the ECS instance. The directory can be up to 200 characters in length. Default value: Linux… |
| Timeout | integer | no | The maximum timeout period for command execution on the ECS instance. Unit: seconds. If the command cannot be run for some reason, a… |
| EnableParameter | string | no | Specifies whether the command uses custom parameters. Default value: false |
| ContentEncoding | string | no | The encoding mode of the command content (CommandContent). Valid values: PlainText: no encoding. The content is transmitted in plaintext.… |
| 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… |
| ResourceGroupId | string | no | The ID of the resource group to which the command belongs |
| Launcher | string | no | The bootstrap program for script execution. The value cannot exceed 1 KB in length |
| Tag | string | no | The tags (JSON-encoded) |

### Creates a dedicated host group
`POST https://zieapi.vercel.app/v1/cloud:aliyun-ecs/create-dedicated-host-cluster` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://ecs.ap-southeast-1.aliyuncs.com |
| RegionId | string | yes | The region ID of the host group. You can call the https://help.aliyun.com/document_detail/25609.html operation to query the most recent… |
| DryRun | string | no | Specifies whether to perform only a dry run, without performing the actual request. Valid values: true: performs only a dry run. The… |
| Tag | string | no | The tags of the host group (JSON-encoded) |
| ResourceGroupId | string | no | The resource group ID of the host group |
| ZoneId | string | yes | The zone ID of the host group. You can call the https://help.aliyun.com/document_detail/25610.html operation to query the most recent zone… |
| DedicatedHostClusterName | string | no | The name of the host group. It must be 2 to 128 characters in length and can contain letters, digits, colons (:), underscores (_), periods… |
| Description | string | no | The description of the host group. It must be 2 to 256 characters in length, and cannot start with `http://` or `https://`. This parameter… |

### Creates a deployment set in a specified region
`POST https://zieapi.vercel.app/v1/cloud:aliyun-ecs/create-deployment-set` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://ecs.ap-southeast-1.aliyuncs.com |
| RegionId | string | yes | The region ID of the deployment set. You can call the https://help.aliyun.com/document_detail/25609.html operation to query the most… |
| OnUnableToRedeployFailedInstance | string | no | The emergency plan used when an instance in the deployment set is migrated due to a host failure and there is insufficient instance… |
| Description | string | no | The description of the deployment set. The description must be 2 to 256 characters in length and cannot start with `http://` or `https://` |
| 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 ensure… |
| DeploymentSetName | string | no | The name of the deployment set. The name must be 2 to 128 characters in length. It must start with a letter or a Chinese character and… |
| Domain | string | no | [Deprecated] This parameter is deprecated |
| Granularity | string | no | [Deprecated] This parameter is deprecated |
| Strategy | string | no | The deployment strategy. Valid values: Availability: high availability strategy AvailabilityGroup: high availability strategy for… |
| GroupCount | integer | no | The number of groups for the high availability strategy of deployment set groups. Valid values: 1 to 7. Default value: 3. This parameter… |
| Type | string | no | The deployment type. Valid values: host: physical machine sw: vSwitch rack: rack Default value: host |
| Affinity | integer | no | The affinity level of the deployment set. Instances in the deployment set are distributed based on this affinity level. Valid values: 1 to… |

### Creates a resource diagnostic metric set. You can combine diagnostic metrics as needed
`POST https://zieapi.vercel.app/v1/cloud:aliyun-ecs/create-diagnostic-metric-set` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://ecs.ap-southeast-1.aliyuncs.com |
| RegionId | string | yes | The region ID. You can call the https://help.aliyun.com/document_detail/25609.html operation to query the most recent region list |
| ResourceType | string | yes | The resource type. Default value: instance |
| MetricSetName | string | no | The name of the diagnostic metric set |
| MetricIds | string | yes | The list of diagnostic metrics. A maximum of 100 metrics are supported (JSON-encoded) |
| Description | string | no | The description of the diagnostic metric set |

### Creates a resource diagnostic report. Generates a diagnostic report for multiple diagnostic metrics based on…
`POST https://zieapi.vercel.app/v1/cloud:aliyun-ecs/create-diagnostic-report` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://ecs.ap-southeast-1.aliyuncs.com |
| RegionId | string | yes | The region ID. You can call the https://help.aliyun.com/document_detail/25609.html operation to query the latest Alibaba Cloud region list |
| ResourceId | string | yes | The resource ID |
| MetricSetId | string | no | The diagnostic metric set ID. If this parameter is left empty, the default diagnostic metric set dms-instancedefault for ECS instances is… |
| StartTime | string | no | The start time. The time follows the ISO 8601 standard and is displayed in UTC. This parameter takes effect only for diagnostic metrics… |
| EndTime | string | no | The end time. The time follows the ISO 8601 standard and is displayed in UTC. This parameter takes effect only for diagnostic metrics that… |
| AdditionalOptions | string | no | The extension in JSON format (JSON-encoded) |

### Creates a pay-as-you-go or subscription data cloud disk
`POST https://zieapi.vercel.app/v1/cloud:aliyun-ecs/create-disk` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://ecs.ap-southeast-1.aliyuncs.com |
| RegionId | string | yes | The region ID. You can call the https://help.aliyun.com/document_detail/25609.html operation to query the most recent region list |
| ZoneId | string | no | The zone ID. This parameter is required when you create a pay-as-you-go cloud disk in a specified zone. If you do not specify InstanceId,… |
| SnapshotId | string | no | The ID of the snapshot used to create the cloud disk. Snapshots created on or before July 15, 2013 cannot be used to create cloud disks.… |
| DiskName | string | no | The name of the cloud disk. The name must be 2 to 128 characters in length. It can contain letters and digits. It can also contain colons… |
| Size | integer | no | Snapshot size of the cloud disk. Unit: GiB. You must specify this parameter. Valid values: cloud: 5 to 2,000. cloud_efficiency: 20 to… |
| DiskCategory | string | no | The category of the data cloud disk. Valid values: cloud: basic cloud disk. cloud_efficiency: ultra cloud disk. cloud_ssd: standard SSD.… |
| Description | string | no | The description of the cloud disk. The description must be 2 to 256 characters in length and cannot start with `http://` or `https://`.… |
| Encrypted | string | no | Specifies whether to encrypt the cloud disk. Valid values: true: yes. false: no. Default value: false |
| 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… |
| InstanceId | string | no | The ID of the subscription instance to which the subscription cloud disk is automatically attached. After you specify the instance ID, the… |
| ResourceGroupId | string | no | The ID of the resource group to which the cloud disk belongs |
| KMSKeyId | string | no | The ID of the Key Management Service (KMS) key used by the cloud disk. If Encrypted is set to true and KMSKeyId is not specified, the… |
| PerformanceLevel | string | no | The performance level settings for the ESSD cloud disk. Valid values: PL0: A single ESSD cloud disk can deliver up to 10,000 random… |
| AdvancedFeatures | string | no | This parameter is not available |
| StorageSetId | string | no | The ID of the storage set. You can specify only one of the storage set parameters (`StorageSetId` and `StorageSetPartitionNumber`) and the… |
| EncryptAlgorithm | string | no | This parameter is not available |
| StorageSetPartitionNumber | integer | no | The number of partitions in the storage set. Valid values: greater than or equal to 2. The maximum value cannot exceed the privilege quota… |
| StorageClusterId | string | no | The ID of the dedicated block storage cluster. If you want to create a cloud disk in a specified dedicated block storage cluster, specify… |
| MultiAttach | string | no | Specifies whether to enable the multi-mount feature. Valid values: Disabled: does not enable the feature. Enabled: enables the feature.… |
| Tag | string | no | The tags of the cloud disk (JSON-encoded) |
| Arn | string | no | This parameter is not available (JSON-encoded) |
| ProvisionedIops | integer | no | The read/write IOPS of the provisioned performance for a single ESSD AutoPL cloud disk. Valid values: If the capacity is less than or… |
| BurstingEnabled | string | no | Specifies whether to enable the performance burst feature. Valid values: true: yes. false: no. This parameter is supported only when… |

### Creates an elasticity assurance service by specifying parameters such as the zone, instance type, purchase…
`POST https://zieapi.vercel.app/v1/cloud:aliyun-ecs/create-elasticity-assurance` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://ecs.ap-southeast-1.aliyuncs.com |
| RegionId | string | yes | The region ID of the elasticity assurance service. You can call https://help.aliyun.com/document_detail/25609.html to query the most… |
| ResourceGroupId | string | no | The ID of the resource group to which the elasticity assurance service belongs |
| Tag | string | no | The tags of the elasticity assurance service (JSON-encoded) |
| Period | integer | no | The purchase duration. The unit of the duration is determined by the `PeriodUnit` parameter. Valid values: If `PeriodUnit` is set to… |
| PeriodUnit | string | no | The unit of the purchase duration. Valid values: Month: month. Year: year. Day: day. When `PeriodUnit` is set to `Day`, you must also… |
| 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… |
| PrivatePoolOptions.Name | string | no | The name of the elasticity assurance service. The name must be 2 to 128 characters in length. The name must start with a letter and cannot… |
| Description | string | no | The description of the elasticity assurance service. The description must be 2 to 256 characters in length and cannot start with `http://`… |
| PrivatePoolOptions.MatchCriteria | string | no | The match mode of the elasticity assurance service. Valid values: Open: open mode. The system automatically matches the capacity of open… |
| AssuranceTimes | string | no | The total number of times that the elasticity assurance can be applied. Valid values: Unlimited. Currently, only the unlimited mode is… |
| InstanceAmount | integer | no | The total number of instances to be reserved for a single instance type. Valid values: 1 to 1000. This parameter is required.> |
| InstanceCpuCoreCount | integer | no | This parameter is deprecated |
| StartTime | string | no | The effective period start time of the elasticity assurance service. By default, the service takes effect when the operation is invoked.… |
| ZoneId | string | yes | The zone ID within the region of the elasticity assurance service. Currently, you can create an elasticity assurance service in only one… |
| InstanceType | string | yes | The instance type. Currently, you can configure an elasticity assurance service for only one instance type (JSON-encoded) |
| RecurrenceRules | string | no | The recurrence rules for the time-sharing elasticity assurance (JSON-encoded) |
| AutoRenew | string | no | Specifies whether to enable auto-renewal. Valid values: true: Auto-renewal is enabled. false: Auto-renewal is disabled. Default value: false |
| AutoRenewPeriod | integer | no | The auto-renewal period. Unit: months. Valid values: 1, 2, 3, 6, 12, 24, and 36. If `PeriodUnit=Month`, the default value is 1. If… |

### Creates an HPC cluster
`POST https://zieapi.vercel.app/v1/cloud:aliyun-ecs/create-hpc-cluster` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://ecs.ap-southeast-1.aliyuncs.com |
| RegionId | string | yes | The region ID of the HPC cluster. You can call https://help.aliyun.com/document_detail/25609.html to query the most recent region list |
| 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… |
| Description | string | no | The description of the HPC cluster. The description must be 2 to 256 characters in length and cannot start with `http://` or `https://`.… |
| Name | string | yes | The name of the HPC cluster. The name must be 2 to 128 characters in length. It must start with a letter or a Chinese character and cannot… |

### Creates a custom image. You can use the custom image to create ECS instances or replace the system disk of…
`POST https://zieapi.vercel.app/v1/cloud:aliyun-ecs/create-image` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://ecs.ap-southeast-1.aliyuncs.com |
| RegionId | string | yes | The region ID of the image. You can call https://help.aliyun.com/document_detail/25609.html to query the latest list of Alibaba Cloud… |
| SnapshotId | string | no | The ID of the snapshot used to create the custom image. If you create a custom image only from the system disk snapshot of an instance,… |
| InstanceId | string | no | The instance ID. This parameter is required when you create a custom image from an instance |
| ImageName | string | no | The image name. It must be 2 to 128 characters in length. It must start with a letter or a Chinese character and cannot start with http://… |
| ImageFamily | string | no | The name of the image family. The name must be 2 to 128 characters in length and must start with a letter or a Chinese character. It… |
| ImageVersion | string | no | The image version. If you specify the instance ID (`InstanceId`) and the image of the instance is an Alibaba Cloud Marketplace image or a… |
| Description | string | no | The image description. The description must be 2 to 256 characters in length and cannot start with http:// or https:// |
| Platform | string | no | The operating system. After you specify a data disk snapshot as the system disk of the image, you must use Platform to determine the… |
| BootMode | string | no | The boot mode of the image. Valid values: BIOS: BIOS boot mode. UEFI: UEFI boot mode. UEFI-Preferred: Dual boot mode. To prevent the… |
| Architecture | string | no | The system architecture. After you specify a data disk snapshot as the system disk of the image, you must use Architecture to determine… |
| 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 make… |
| ResourceGroupId | string | no | The ID of the resource group to which the custom image belongs. If you do not specify this parameter, the created image belongs to the… |
| DiskDeviceMapping | string | no | The disks and snapshots used to create the custom image. If you want to create a custom image from a system disk snapshot and data disk… |
| Tag | string | no | The tags (JSON-encoded) |
| DetectionStrategy | string | no | The image detection strategy. If you do not configure this parameter, detection is not triggered. Only the standard (Standard) detection… |
| Features | string | no | The image feature attributes (JSON-encoded) |
| DryRun | string | no | The DryRun |
| SecureBootOptions | string | no | The secure boot parameters (JSON-encoded) |

### Creates an image component. Image components are used to store commonly used build template commands for…
`POST https://zieapi.vercel.app/v1/cloud:aliyun-ecs/create-image-component` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://ecs.ap-southeast-1.aliyuncs.com |
| RegionId | string | yes | The region ID. You can call https://help.aliyun.com/document_detail/25609.html to query the most recent region list |
| ResourceGroupId | string | no | The ID of the enterprise resource group |
| Tag | string | no | The tags (JSON-encoded) |
| Name | string | no | The component name. The name must be 2 to 128 characters in length and must start with a letter or a Chinese character. The name cannot… |
| Description | string | no | The description. The description must be 2 to 256 characters in length and cannot start with http:// or https:// |
| SystemType | string | no | The operating system supported by the component. Valid values: Linux Windows Default value: Linux |
| ComponentType | string | no | The component type. Image build components and test components are supported. Valid values: Build Test Default value: Build. Build… |
| Content | string | no | The component content, which consists of multiple commands. The content cannot exceed 16 KB. For more information about supported commands… |
| 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… |
| ComponentVersion | string | no | The component version number, which is used together with the component name. The format is major.minor.patch, and all values are… |

### Creates an image template. Image templates can be used to build images
`POST https://zieapi.vercel.app/v1/cloud:aliyun-ecs/create-image-pipeline` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://ecs.ap-southeast-1.aliyuncs.com |
| Tag | string | no | The list of tags (JSON-encoded) |
| RegionId | string | yes | The region ID. You can call the https://help.aliyun.com/document_detail/25609.html operation to query the most recent region list |
| ResourceGroupId | string | no | The ID of the resource group |
| AddAccount | string | no | The Alibaba Cloud account ID for image sharing of the destination image. Valid values of N: 1 to 20 (JSON-encoded) |
| ToRegionId | string | no | The list of regions to which the destination image is distributed. Valid values of N: 1 to 20. If you do not specify this parameter, the… |
| RepairItem | string | no | The image repair items. Repair items supported by Linux: fstab: repairs disk attach configuration issues. grub: repairs GRUB boot… |
| BaseImageType | string | yes | The source image type. Valid values: IMAGE: image. IMAGE_FAMILY: image family. OSS: OSS object |
| BaseImage | string | no | The source image. If BaseImageType is set to IMAGE, set this parameter to the image ID. If BaseImageType is set to IMAGE_FAMILY, set this… |
| Name | string | no | The name of the template. The name must be 2 to 128 characters in length. It must start with a letter or a Chinese character, and cannot… |
| Description | string | no | The description. The description must be 2 to 256 characters in length and cannot start with http:// or https:// |
| ImageName | string | no | The prefix of the destination image name. This parameter is deprecated. Use ImageOptions.ImageName instead. |
| VSwitchId | string | no | The vSwitch ID of the VPC. If you do not specify this parameter, a new VPC and vSwitch are created by default. Make sure that your account… |
| InstanceType | string | no | The instance type. You can call the https://help.aliyun.com/document_detail/25620.html operation to query available instance types. If you… |
| SystemDiskSize | integer | no | The system disk size of the intermediate instance. Unit: GiB. Valid values: 20 to 500. Default value: 40 |
| InternetMaxBandwidthOut | integer | no | The outbound public bandwidth of the intermediate instance. Unit: Mbit/s. Valid values: 0 to 100. Default value: 0 |
| DeleteInstanceOnFailure | string | no | Specifies whether to release the intermediate instance if the image build fails. Valid values: true: releases the instance. false: does… |
| BuildContent | string | no | The content of the image build template. The content size cannot exceed 16 KB. For more information about supported commands, see… |
| 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… |
| RepairMode | string | no | The repair mode in the image template. Valid values: Standard: standard repair mode. The standard repair package for Linux includes the… |
| ImageFamily | string | no | The destination image family. This parameter is deprecated. Use ImageOptions.ImageFamily instead. |
| TestContent | string | no | The content of the image test template. The content size cannot exceed 16 KB. For more information about supported commands, see… |
| ImportImageOptions | string | no | The properties and settings of the imported image. This parameter is required when BaseImageType is set to OSS (JSON-encoded) |
| NvmeSupport | string | no | Specifies whether the destination image to be built supports NVMe. This parameter is deprecated. Use… |
| AdvancedOptions | string | no | The advanced settings (JSON-encoded) |
| ImageOptions | string | no | The properties of the destination image (JSON-encoded) |
| ImageSecurityOptions | string | no | The security-related properties and settings of the image (JSON-encoded) |

### Creates a subscription or pay-as-you-go Elastic Compute Service (ECS) instance
`POST https://zieapi.vercel.app/v1/cloud:aliyun-ecs/create-instance` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://ecs.ap-southeast-1.aliyuncs.com |
| RegionId | string | yes | The region ID of the instance. You can call https://help.aliyun.com/document_detail/25609.html to query the most recent region list |
| ImageId | string | no | The ID of the image used to start the instance. To use an Alibaba Cloud Marketplace image, you can view the ImageId on the image details… |
| ImageFamily | string | no | The name of the image family. You can set this parameter to use the latest available image in the image family to create the instance. If… |
| InstanceType | string | yes | The instance type. Instance type selection: See https://help.aliyun.com/document_detail/25378.html or call the… |
| SecurityGroupId | string | no | The ID of the security group to which the new instance belongs |
| InstanceName | string | no | The name of the instance. The name must be 2 to 128 characters in length and can contain letters and digits. It can also contain colons… |
| InternetChargeType | string | no | The billing method for network usage. Valid values: PayByBandwidth: pay-by-bandwidth. PayByTraffic: pay-by-traffic. This is the default… |
| AutoRenew | string | no | Specifies whether to enable auto-renewal. This parameter takes effect only when InstanceChargeType is set to PrePaid. Valid values: true:… |
| AutoRenewPeriod | integer | no | The auto-renewal duration. This parameter is required when AutoRenew is set to true. When PeriodUnit is set to Week, valid values of… |
| InternetMaxBandwidthIn | integer | no | The maximum inbound public bandwidth. Unit: Mbit/s. Valid values: When the purchased outbound bandwidth is less than or equal to 10… |
| InternetMaxBandwidthOut | integer | no | The maximum outbound public bandwidth. Unit: Mbit/s. Valid values: 0 to 100. Default value: 0 |
| HostName | string | no | The hostname of the instance. The hostname cannot start or end with a period (.) or a hyphen (-), and cannot contain consecutive periods… |
| Password | string | no | The password of the instance. The password must be 8 to 30 characters in length and contain at least three of the following character… |
| PasswordInherit | string | no | Specifies whether to use the preset password of the image. When you use this parameter, leave the Password parameter empty and make sure… |
| DeploymentSetId | string | no | The ID of the deployment set |
| DeploymentSetGroupNo | integer | no | The group number of the instance in the deployment set. This parameter is valid when the deployment set uses the high availability group… |
| ZoneId | string | no | The zone ID of the instance. For more information, see https://help.aliyun.com/document_detail/25610.html to obtain the zone list. If you… |
| ClusterId | string | no | The ID of the cluster to which the instance belongs. This parameter is about to be deprecated. To improve compatibility, use other… |
| 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 make… |
| VlanId | string | no | The virtual local area network ID |
| InnerIpAddress | string | no | The internal IP address of the instance |
| SystemDisk.Size | integer | no | The size of the system cloud disk. Unit: GiB. Valid values: Basic cloud disk: 20 to 500. Other cloud disk types: 20 to 2048. The value of… |
| SystemDisk.Category | string | no | The category of the system cloud disk. Valid values: cloud_efficiency: ultra cloud disk. cloud_ssd: standard SSD. cloud_essd: ESSD. cloud:… |
| SystemDisk.DiskName | string | no | The name of the system cloud disk. The name must be 2 to 128 characters in length and can contain letters and digits. It can also contain… |
| SystemDisk.Description | string | no | The description of the system cloud disk. The description must be 2 to 256 characters in length and cannot start with `http://` or… |
| SystemDisk.PerformanceLevel | string | no | Settings of the performance level of the ESSD used as the system cloud disk. Valid values: PL0: A single ESSD can deliver up to 10,000… |
| NodeControllerId | string | no | This parameter is in invitational preview and is not supported |
| Description | string | no | The description of the instance. The description must be 2 to 256 characters in length and cannot start with `http://` or `https://`.… |
| VSwitchId | string | no | The ID of the vSwitch. This parameter is required when you create a VPC-type instance. You can call the… |
| PrivateIpAddress | string | no | The private IP address of the instance. The IP address must be an available IP address within the CIDR block of the vSwitch specified by… |
| IoOptimized | string | no | Specifies whether the instance is an I/O optimized instance. Valid values: none: The instance is not I/O optimized. optimized: The… |
| UseAdditionalService | string | no | Specifies whether to use the virtual machine system configurations provided by Alibaba Cloud (Windows: NTP and KMS; Linux: NTP and YUM) |
| InstanceChargeType | string | no | The billing method of the instance. Valid values: PrePaid: subscription. If you select this billing method, make sure that your account… |
| Period | integer | no | The subscription period of the resource. The unit is specified by PeriodUnit. This parameter is required and takes effect only when… |
| PeriodUnit | string | no | The unit of the subscription period. Valid values: Week Month Month. Month. Default value: Month |
| UserData | string | no | Instance user data of the instance. Instance user data must be encoded in Base64. The maximum size of the raw data is 32 KB |
| SpotStrategy | string | no | The preemption policy for spot instance. This parameter takes effect when InstanceChargeType is set to PostPaid. Valid values: NoSpot:… |
| KeyPairName | string | no | The name of the key pair. For Windows instances, this parameter is ignored. Default value: empty. Even if you specify this parameter, only… |
| SpotPriceLimit | number | no | The maximum hourly price of the instance. The value can be accurate to three decimal places. This parameter takes effect when SpotStrategy… |
| SpotDuration | integer | no | The protection period of the preemptible instance. Unit: hours. Default value: 1. Valid values: 1: Alibaba Cloud guarantees that spot… |
| SpotInterruptionBehavior | string | no | The interruption behavior of the preemptible instance. Valid values: Terminate: releases the instance. Stop: puts the instance into the… |
| RamRoleName | string | no | The name of the instance RAM role. You can use the RAM API operation https://help.aliyun.com/document_detail/28713.html to query the… |
| SecurityEnhancementStrategy | string | no | Specifies whether to enable security hardening. Valid values: Active: enables security hardening. This value is applicable only to public… |
| ResourceGroupId | string | no | The ID of the enterprise resource group to which the instance belongs |
| HpcClusterId | string | no | The ID of the HPC cluster to which the instance belongs |
| DryRun | string | no | Specifies whether to perform only a dry run on the request. Valid values: true: performs a dry run and does not create the instance. The… |
| DedicatedHostId | string | no | The ID of the dedicated host. You can call the https://help.aliyun.com/document_detail/134242.html operation to query the list of… |
| CreditSpecification | string | no | The performance mode of the burstable instance. Valid values: Standard: standard mode. For more information about instance performance,… |
| DeletionProtection | string | no | The release protection attribute of the instance. It specifies whether the instance can be released through the console or by calling the… |
| HibernationOptions.Configured | string | no | This parameter is in invitational preview and is not supported |
| Affinity | string | no | Specifies whether to associate the instance on a dedicated host with the dedicated host. Valid values: default: The instance is not… |
| Tenancy | string | no | Specifies whether to create the instance on a dedicated host. Valid values: default: The instance is created on a non-dedicated host.… |
| StorageSetId | string | no | The ID of the storage set |
| StorageSetPartitionNumber | integer | no | The maximum number of partitions in the storage set. Valid values: greater than or equal to 2 |
| HttpEndpoint | string | no | Specifies whether to enable the access channel for instance metadata. Valid values: enabled: enables the access channel. disabled:… |
| HttpTokens | string | no | Specifies whether to forcibly use the security hardening mode (IMDSv2) to access instance metadata. Valid values: optional: does not… |
| HttpPutResponseHopLimit | integer | no | This parameter is not available |
| PrivatePoolOptions.MatchCriteria | string | no | The private pool options for starting spot instance. After an elasticity assurance or a capacity reservation takes effect, a private pool… |
| PrivatePoolOptions.Id | string | no | The ID of the private pool. It is the ID of the elasticity assurance or capacity reservation |
| DataDisk | string | no | The data cloud disks (JSON-encoded) |
| Arn | string | no | This parameter is in invitational preview and is not supported (JSON-encoded) |
| Tag | string | no | The list of tags (JSON-encoded) |
| SystemDisk | string | no | The system cloud disk parameters. Currently, you must use this parameter to specify the dedicated block storage cluster ID… |
| ManagedHostId | string | no | The unique identifier of the platform-managed host, such as mh-f2d3647ca21**** |

### Calls CreateKeyPair to create an SSH key pair. The system stores the public key and returns the private key…
`POST https://zieapi.vercel.app/v1/cloud:aliyun-ecs/create-key-pair` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://ecs.ap-southeast-1.aliyuncs.com |
| RegionId | string | yes | The region ID of the key pair. You can call https://help.aliyun.com/document_detail/25609.html to query the most recent region list |
| KeyPairName | string | yes | The name of the key pair. The name must be 2 to 128 characters in length and can contain letters, digits, colons (:), underscores (_), and… |
| ResourceGroupId | string | no | The ID of the resource group to which the SSH key pair belongs |
| Tag | string | no | The tags (JSON-encoded) |

### Creates an ECS instance launch template. A launch template eliminates the need to specify a large number of…
`POST https://zieapi.vercel.app/v1/cloud:aliyun-ecs/create-launch-template` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://ecs.ap-southeast-1.aliyuncs.com |
| RegionId | string | yes | The region ID. You can call the https://help.aliyun.com/document_detail/25609.html operation to query the most recent region list |
| TemplateTag | string | no | The tags of the launch template. You can only create and query the tags of launch templates by calling API operations. You cannot create… |
| LaunchTemplateName | string | yes | The name of the instance launch template. The name must be 2 to 128 characters in length and can contain letters and Chinese characters.… |
| VersionDescription | string | no | The description of the instance launch template version. The description must be 2 to 256 characters in length and can contain letters and… |
| ImageId | string | no | The image ID. This is the image resource selected when the instance is started. You can call the… |
| ImageOwnerAlias | string | no | The source of the image. Valid values: system: public images provided by Alibaba Cloud. self: custom images that you created. others:… |
| PasswordInherit | string | no | Specifies whether to use the preset password of the image. When you specify this parameter, leave Password empty and make sure that the… |
| InstanceType | string | no | The resource specifications of the instance. For more information, see https://help.aliyun.com/document_detail/25378.html. You can also… |
| SecurityGroupId | string | no | The ID of the security group to which the new instance belongs. Instances in the same security group can access each other. A security… |
| VpcId | string | no | The ID of the virtual private cloud (VPC) |
| VSwitchId | string | no | The ID of the vSwitch. This parameter is required when you create a VPC instance |
| InstanceName | string | no | The instance name. The name must be 2 to 128 characters in length and can contain characters in the Letter category of Unicode, including… |
| Description | string | no | The instance description. The description must be 2 to 256 characters in length and can contain letters and Chinese characters. It cannot… |
| InternetMaxBandwidthIn | integer | no | The maximum inbound public bandwidth. Unit: Mbit/s. Valid values: When the purchased outbound public bandwidth is less than or equal to 10… |
| InternetMaxBandwidthOut | integer | no | The maximum outbound public bandwidth. Unit: Mbit/s. Valid values: 0 to 100 |
| HostName | string | no | The hostname of the Elastic Compute Service server. The hostname cannot start or end with a period (.) or a hyphen (-). It cannot contain… |
| ZoneId | string | no | The zone ID of the instance |
| SystemDisk.Category | string | no | The category of the system disk. Valid values: cloud: basic disk. cloud_efficiency: ultra disk. cloud_ssd: standard SSD. cloud_essd: ESSD.… |
| SystemDisk.Size | integer | no | The size of the system disk. Unit: GiB. Valid values: cloud: 20 to 500. Other disk categories: 20 to 2048. The value of this parameter… |
| SystemDisk.DiskName | string | no | The name of the system disk. The name must be 2 to 128 characters in length and can contain letters and Chinese characters. It must start… |
| SystemDisk.Description | string | no | The description of the system disk. The description must be 2 to 256 characters in length and can contain letters and Chinese characters.… |
| SystemDisk.Iops | integer | no | This parameter is in invitational preview and is not available |
| SystemDisk.PerformanceLevel | string | no | The performance level of the ESSD used as the system disk. Valid values: PL0 (default): A single ESSD can deliver up to 10,000 random… |
| SystemDisk.DeleteWithInstance | string | no | Specifies whether to release the system disk when the instance is released. Valid values: true: releases the system disk when the instance… |
| SystemDisk.AutoSnapshotPolicyId | string | no | The ID of the automatic snapshot policy applied to the system disk |
| SystemDisk.ProvisionedIops | integer | no | The provisioned read/write IOPS of the ESSD AutoPL disk. Valid values: 0 to min{50000, 1000 × Capacity - Baseline performance}. Baseline… |
| SystemDisk.BurstingEnabled | string | no | Specifies whether to enable the performance burst feature. Valid values: true: enables the feature. false: disables the feature |
| IoOptimized | string | no | Specifies whether the instance is an I/O optimized instance. Valid values: none: The instance is not I/O optimized. optimized: The… |
| InstanceChargeType | string | no | The billing method of the instance. Valid values: PrePaid: subscription. If you select this billing method, you must confirm that your… |
| Period | integer | no | The subscription period of the instance. Unit: months. This parameter is valid and required only when InstanceChargeType is set to… |
| InternetChargeType | string | no | The billing method for network usage. Valid values: PayByBandwidth: pay-by-bandwidth. PayByTraffic: pay-by-traffic. In the pay-by-traffic… |
| EnableVmOsConfig | string | no | Specifies whether to enable the operating system configuration of the instance. This parameter will be deprecated. To improve… |
| NetworkType | string | no | The network type of the instance. Valid values: classic: classic network. This network type is phased out. For more information, see… |
| UserData | string | no | Instance user data of the instance. Instance user data must be encoded in Base64. The maximum size of the raw data is 32 KB |
| KeyPairName | string | no | The name of the key pair. For Windows instances, this parameter is ignored. Even if you specify this parameter, only the Password… |
| RamRoleName | string | no | The name of the instance RAM role. You can call the https://help.aliyun.com/document_detail/28713.html operation provided by RAM to query… |
| AutoReleaseTime | string | no | The automatic release time. Specify the time in the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time must be in UTC. If the… |
| SpotStrategy | string | no | The preemption policy for the pay-as-you-go instance. This parameter takes effect only when InstanceChargeType is set to PostPaid. Valid… |
| SpotPriceLimit | number | no | The maximum hourly price of the instance. The value can be accurate to three decimal places. This parameter takes effect only when… |
| SpotDuration | integer | no | The protection period of the spot instance. Unit: hours. Default value: 1. Valid values: 1: Alibaba Cloud guarantees that the instance is… |
| ResourceGroupId | string | no | The ID of the enterprise resource group to which the instance, block storage, and elastic network interface (ENI) belong |
| TemplateResourceGroupId | string | no | The ID of the enterprise resource group to which the launch template belongs |
| SecurityEnhancementStrategy | string | no | Specifies whether to enable security hardening for the operating system. Valid values: Active: enables security hardening. This value is… |
| PrivateIpAddress | string | no | The private IP address of the instance. When you specify the private IP address for an ECS instance in a VPC, the IP address must be… |
| DeploymentSetId | string | no | The ID of the deployment set |
| Ipv6AddressCount | integer | no | The number of IPv6 addresses to be randomly generated for the primary ENI. Valid values: 1 to 10 |
| DataDisk | string | no | The list of data disks (JSON-encoded) |
| NetworkInterface | string | no | The Elastic Network Interface (ENI) information (JSON-encoded) |
| Tag | string | no | The tag information of the instances, cloud disks, and primary ENIs that are created by using this version of the launch template.… |
| SecurityGroupIds | string | no | The IDs of one or more security groups to which the instance is added. The valid values of N depend on the quota of security groups to… |
| SystemDisk.Encrypted | string | no | Specifies whether to encrypt the system disk. Valid values: true: encrypts the system disk. false: does not encrypt the system disk.… |
| DeletionProtection | string | no | The release protection property of the instance. It specifies whether the instance can be released by using the console or by calling the… |
| CreditSpecification | string | no | The performance mode of the burstable instance. Valid values: Standard: standard mode. For more information about the performance of the… |
| AutoRenew | string | no | Specifies whether to enable auto-renewal. Valid values: true: enables auto-renewal. false: disables auto-renewal. Default value: false.… |
| AutoRenewPeriod | integer | no | The auto-renewal duration. Valid values: Valid values when PeriodUnit is set to Week: 1, 2, and 3. Valid values when PeriodUnit is set to… |
| PeriodUnit | string | no | The time unit for the subscription Billable methods. Valid values: Week. Month (default). Month (default). |
| HttpEndpoint | string | no | Specifies whether to enable the access channel for instance metadata. Valid values: enabled: enables the access channel. disabled:… |
| HttpTokens | string | no | Specifies whether to forcibly use the security hardening mode (IMDSv2) to access instance metadata. Valid values: optional: does not… |
| HttpPutResponseHopLimit | integer | no | This parameter is not available |
| SystemDisk.KMSKeyId | string | no | The KMS key ID of the system disk |
| ImageOptions | string | no | The image-related property information (JSON-encoded) |
| SecurityOptions | string | no | The security options (JSON-encoded) |

### Creates a new version under a specified ECS launch template for subsequent creation of ECS instances,…
`POST https://zieapi.vercel.app/v1/cloud:aliyun-ecs/create-launch-template-version` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://ecs.ap-southeast-1.aliyuncs.com |
| RegionId | string | yes | The region ID. You can call the https://help.aliyun.com/document_detail/25609.html operation to query the most recent region list |
| LaunchTemplateId | string | no | The launch template ID. For more information, call the https://help.aliyun.com/document_detail/73759.html operation. You must specify… |
| LaunchTemplateName | string | no | The name of the launch template. The name must be 2 to 128 characters in length. It must start with a letter or a Chinese character and… |
| VersionDescription | string | no | The description of the launch template version. The description must be 2 to 256 characters in length and cannot start with `http://` or… |
| ImageId | string | no | The image ID. This is the image resource selected when the instance is started. You can call the… |
| ImageOwnerAlias | string | no | The image source. This parameter will be deprecated soon. To improve compatibility, use other parameters instead |
| PasswordInherit | string | no | Specifies whether to use the preset password of the image. Valid values: true false Default value: false. When you specify this parameter,… |
| InstanceType | string | no | The instance type. For more information, see https://help.aliyun.com/document_detail/25378.html. You can also invoke the… |
| SecurityGroupId | string | no | The ID of the security group to which the instance created by using this version belongs. Instances in the same security group can access… |
| VpcId | string | no | The ID of the virtual private cloud (VPC) to which the instance belongs |
| VSwitchId | string | no | The ID of the vSwitch. This parameter is required when you create a VPC-type instance |
| InstanceName | string | no | The instance name. The name must be 2 to 128 characters in length and can contain letters and digits in the Unicode letter category. It… |
| Description | string | no | The instance description. The description must be 2 to 256 characters in length and cannot start with `http://` or `https://` |
| InternetMaxBandwidthIn | integer | no | The maximum inbound public bandwidth. Unit: Mbit/s. Valid values: If the purchased outbound public bandwidth is less than or equal to 10… |
| InternetMaxBandwidthOut | integer | no | The maximum outbound public bandwidth. Unit: Mbit/s. Valid values: 0 to 100 |
| HostName | string | no | The hostname of the cloud server. The hostname cannot start or end with a period (.) or a hyphen (-). It cannot contain consecutive… |
| ZoneId | string | no | The zone ID of the instance |
| SystemDisk.Category | string | no | The category of the system disk. Valid values: cloud: basic disk cloud_efficiency: ultra disk cloud_ssd: standard SSD cloud_auto: ESSD… |
| SystemDisk.Size | integer | no | The size of the system disk. Unit: GiB. Valid values: cloud: 20 to 500 Other disk categories: 20 to 2048 The value of this parameter must… |
| SystemDisk.DiskName | string | no | The name of the system disk. The name must be 2 to 128 characters in length. It must start with a letter or a Chinese character and cannot… |
| SystemDisk.Description | string | no | The description of the system disk. The description must be 2 to 256 characters in length and cannot start with `http://` or `https://` |
| SystemDisk.Iops | integer | no | This parameter is not available |
| SystemDisk.PerformanceLevel | string | no | The performance level settings of the ESSD used as the system disk. Valid values: PL0 (default): A single ESSD can deliver up to 10,000… |
| SystemDisk.DeleteWithInstance | string | no | Specifies whether to release the system disk when the instance is released. Valid values: true: Release the system disk when the instance… |
| SystemDisk.AutoSnapshotPolicyId | string | no | The ID of the automatic snapshot policy applied to the system disk |
| SystemDisk.ProvisionedIops | integer | no | The number of provisioned read/write IOPS for the ESSD AutoPL disk. Valid values: 0 to min{50000, 1000 × Capacity - Baseline performance}.… |
| SystemDisk.BurstingEnabled | string | no | Specifies whether to enable performance burst. Valid values: true false |
| IoOptimized | string | no | Specifies whether the instance is an I/O optimized instance. Valid values: none: The instance is not I/O optimization. optimized: The… |
| InstanceChargeType | string | no | The billing method of the instance. Valid values: PrePaid: subscription. If you select this billing method, you must confirm that your… |
| Period | integer | no | The subscription period of the instance. Unit: months. This parameter is required and takes effect only when `InstanceChargeType` is set… |
| InternetChargeType | string | no | The billing method for outbound Internet bandwidth. Valid values: PayByBandwidth: pay-by-bandwidth PayByTraffic: pay-by-traffic In the… |
| EnableVmOsConfig | string | no | Specifies whether to enable the operating system configuration of the instance |
| NetworkType | string | no | The network type of the instance. Valid values: vpc: VPC classic: classic network. The classic network is no longer available. For more… |
| UserData | string | no | Instance user data of the instance. Instance user data must be encoded in Base64. The maximum size of the raw data is 32 KB |
| KeyPairName | string | no | The name of the key pair. For a Windows instance, this parameter is ignored. Even if this parameter is specified, only the `Password`… |
| RamRoleName | string | no | The name of the instance RAM role. You can call the RAM API operation https://help.aliyun.com/document_detail/28713.html to query the… |
| AutoReleaseTime | string | no | The automatic release time. Specify the time in the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time must be in UTC. For… |
| SpotStrategy | string | no | The preemption policy for the pay-as-you-go instance. This parameter takes effect when `InstanceChargeType` is set to `PostPaid`. Valid… |
| SpotPriceLimit | number | no | The maximum hourly price of the instance. The value can be accurate to three decimal places |
| SpotDuration | integer | no | The protection period of the spot instance. Unit: hours. Default value: 1. Valid values: 1: Alibaba Cloud guarantees that the instance is… |
| ResourceGroupId | string | no | The ID of the resource group |
| SecurityEnhancementStrategy | string | no | Specifies whether to enable security hardening for the operating system. Valid values: Active: enables security hardening. This value is… |
| PrivateIpAddress | string | no | The private IP address of the instance. When you specify a private IP address for a VPC-type ECS instance, make sure that the IP address… |
| Ipv6AddressCount | integer | no | The number of IPv6 addresses to be randomly generated for the primary ENI. Valid values: 1 to 10 |
| DeploymentSetId | string | no | The ID of the deployment set |
| DataDisk | string | no | The data disks (JSON-encoded) |
| NetworkInterface | string | no | The elastic network interface controller (NIC) information (JSON-encoded) |
| Tag | string | no | The tags of the instances, disks, and primary ENIs created by using this version (JSON-encoded) |
| SecurityGroupIds | string | no | The security groups to which the instance is added. The valid values of N are subject to the quota of security groups to which an instance… |
| SystemDisk.Encrypted | string | no | Specifies whether to encrypt the system disk. Valid values: true: Encrypts the system disk. false: Does not encrypt the system disk.… |
| DeletionProtection | string | no | The release protection property of the instance. This property specifies whether the instance can be released by using the ECS console or… |
| CreditSpecification | string | no | The operating mode of the burstable instance. Valid values: Standard: standard mode. For more information about the instance performance… |
| AutoRenew | string | no | Specifies whether to enable auto-renewal. This parameter takes effect only when the `InstanceChargeType` parameter is set to `PrePaid`.… |
| AutoRenewPeriod | integer | no | The auto-renewal period. Valid values: Valid values when PeriodUnit is set to Week: 1, 2, and 3. Valid values when PeriodUnit is set to… |
| PeriodUnit | string | no | The unit of the subscription Billable methods. Valid values: Week. Month (default). Month (default). |
| HttpEndpoint | string | no | Specifies whether to enable the access channel for instance metadata. Valid values: enabled: Enables the access channel. disabled:… |
| HttpTokens | string | no | Specifies whether to forcibly use the security hardening mode (IMDSv2) to access instance metadata. Valid values: optional: Does not… |
| HttpPutResponseHopLimit | integer | no | This parameter is not available |
| SystemDisk.KMSKeyId | string | no | The KMS key ID of the system disk |
| ImageOptions | string | no | The image-related properties (JSON-encoded) |
| SecurityOptions | string | no | The security options (JSON-encoded) |

### Creates an Elastic Network Interface (ENI) and allows you to specify the primary private IP address
`POST https://zieapi.vercel.app/v1/cloud:aliyun-ecs/create-network-interface` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://ecs.ap-southeast-1.aliyuncs.com |
| RegionId | string | yes | The region ID of the Elastic Network Interface (ENI) to be created. You can invoke the https://help.aliyun.com/document_detail/25609.html… |
| Tag | string | no | The tags of the Elastic Network Interface (ENI) (JSON-encoded) |
| ResourceGroupId | string | no | The resource group ID. You can call the https://help.aliyun.com/document_detail/158855.html operation to query resource group information |
| VSwitchId | string | yes | The vSwitch ID of the Elastic Network Interface (ENI). The private IP address of the Elastic Network Interface (ENI) is selected from the… |
| PrimaryIpAddress | string | no | The primary private IP address of the Elastic Network Interface (ENI). The specified IP address must be an idle IP address in the CIDR… |
| SecurityGroupId | string | no | The ID of the security group to which you want to add the Elastic Network Interface (ENI). The security group and the Elastic Network… |
| NetworkInterfaceName | string | no | The name of the Elastic Network Interface (ENI). The name must be 2 to 128 characters in length. It can contain letters in the Unicode… |
| Description | string | no | The description of the Elastic Network Interface (ENI). The description must be 2 to 256 characters in length and cannot start with… |
| Visible | string | no | [Deprecated] |
| InstanceType | string | no | The type of the Elastic Network Interface (ENI). Valid values: Secondary: secondary Elastic Network Interface (ENI). Trunk: trunk network… |
| BusinessType | string | no | [Deprecated] |
| SecondaryPrivateIpAddressCount | integer | no | The number of private IP addresses that you want Elastic Compute Service (ECS) to allocate for automatic creation. Valid values: 1 to 49 |
| QueueNumber | integer | no | The number of queues for the Elastic Network Interface (ENI). Valid values: 1 to 2048. When you attach the Elastic Network Interface (ENI)… |
| 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… |
| NetworkInterfaceTrafficMode | string | no | The communication pattern of the Elastic Network Interface (ENI). Valid values: Standard: uses the TCP communication pattern.… |
| QueuePairNumber | integer | no | The number of queues for the RDMA ENI. If you want to attach multiple RDMA ENIs to an instance, we recommend that you manually specify the… |
| SecurityGroupIds | string | no | The IDs of one or more security groups to which you want to add the Elastic Network Interface (ENI). The security groups and the Elastic… |
| PrivateIpAddress | string | no | One or more secondary private IP addresses that are selected from the idle IP addresses in the CIDR block of the vSwitch to which the… |
| Ipv6Address | string | no | One or more IPv6 addresses that are allocated to the Elastic Network Interface (ENI). It supports Settings for up to 10 IPv6 addresses.… |
| Ipv6AddressCount | integer | no | The number of IPv6 addresses that are randomly generated for the Elastic Network Interface (ENI). Valid values: 1 to 10. If you want to… |
| Ipv4Prefix | string | no | One or more IPv4 prefixes that are allocated to the Elastic Network Interface (ENI). Valid values of N: 1 to 10. If you want to allocate… |
| Ipv4PrefixCount | integer | no | The number of IPv4 prefixes that are allocated to the Elastic Network Interface (ENI). Valid values: 1 to 10. If you want to allocate IPv4… |
| Ipv6Prefix | string | no | One or more IPv6 prefixes that are allocated to the Elastic Network Interface (ENI). Valid values of N: 1 to 10. If you want to allocate… |
| Ipv6PrefixCount | integer | no | The number of IPv6 prefixes that are allocated to the Elastic Network Interface (ENI). Valid values: 1 to 10. If you want to allocate IPv6… |
| DeleteOnRelease | string | no | Specifies whether to retain the ENI when the instance is released. Valid values: true: The ENI is not retained. false: The ENI is retained |
| TxQueueSize | integer | no | The outbound queue depth of the Elastic Network Interface (ENI). Take note of the following items: The outbound queue depth of the network… |
| RxQueueSize | integer | no | The inbound queue depth of the Elastic Network Interface (ENI). Take note of the following items: The inbound queue depth of the network… |
| NetworkInterfaceTrafficConfig | string | no | The communication parameters of the Elastic Network Interface (ENI) (JSON-encoded) |
| ConnectionTrackingConfiguration | string | no | The network connectivity tracking configurations. Before you use this parameter, read https://help.aliyun.com/document_detail/2865958.html… |
| EnhancedNetwork | string | no | This parameter is not available (JSON-encoded) |
| SourceDestCheck | string | no | Specifies whether to enable source/destination checking. We recommend that you enable this feature to improve network security. Valid… |
| EnablePrimaryIPv6 | string | no | The EnablePrimaryIPv6 |

### Grants Elastic Network Interface (ENI) permissions to Alibaba Cloud partners (certified ISVs) or individual…
`POST https://zieapi.vercel.app/v1/cloud:aliyun-ecs/create-network-interface-permission` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://ecs.ap-southeast-1.aliyuncs.com |
| RegionId | string | yes | The region of the Elastic network interface controller (NIC) permission. You can call https://help.aliyun.com/document_detail/25609.html… |
| AccountId | integer | yes | The account ID of the Alibaba Cloud partner (certified ISV) or the individual user |
| NetworkInterfaceId | string | yes | The ID of the Elastic network interface controller (NIC) |
| Permission | string | yes | The Elastic network interface controller (NIC) permission action. Only InstanceAttach is supported. InstanceAttach: allows the authorized… |

### Creates an O&M window. If the TargetResource parameter is associated with ECS instances and underlying…
`POST https://zieapi.vercel.app/v1/cloud:aliyun-ecs/create-plan-maintenance-window` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://ecs.ap-southeast-1.aliyuncs.com |
| PlanWindowName | string | yes | The name of the O&M window. You can customize the name. The name can be up to 200 characters in length |
| Enable | string | yes | Specifies whether to enable the window. Valid values: true: Enabled. false: Disabled |
| SupportMaintenanceAction | string | yes | The O&M operations supported by the O&M window |
| RegionId | string | yes | The region ID. This parameter is required for Alibaba Cloud SDK routing. However, specifying any region ID for this operation yields the… |
| TimePeriod | string | yes | The recurrence cycle of the window (JSON-encoded) |
| TargetResource | string | yes | The resources to which the O&M window applies (JSON-encoded) |
| MinMaintenanceInterval | integer | no | The minimum interval between two scheduled O&M events for the same instance. Valid values: 1 to 48. Unit: hours |

### Creates a port list that can be associated with resources such as security groups
`POST https://zieapi.vercel.app/v1/cloud:aliyun-ecs/create-port-range-list` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://ecs.ap-southeast-1.aliyuncs.com |
| RegionId | string | yes | The region ID. You can call the https://help.aliyun.com/document_detail/25609.html operation to query the latest Alibaba Cloud regions |
| ClientToken | string | no | Ensures the idempotence of the request. You can generate the value from your client and make sure that the value is unique across… |
| MaxEntries | integer | yes | The maximum number of entries supported by the port list. This parameter cannot be modified after the port list is created. Valid values:… |
| PortRangeListName | string | yes | The name of the port list. The name must be 2 to 128 characters in length, and must start with a letter or a Chinese character. It cannot… |
| Description | string | no | The description of the port list. The description must be 2 to 256 characters in length, and cannot start with http:// or https:// |
| Entry | string | no | The array of port list entries (JSON-encoded) |
| ResourceGroupId | string | no | The ID of the resource group to which the port list belongs |
| Tag | string | no | The array of tags bound to the port list. The array length ranges from 0 to 20 (JSON-encoded) |

### Creates a prefix list
`POST https://zieapi.vercel.app/v1/cloud:aliyun-ecs/create-prefix-list` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://ecs.ap-southeast-1.aliyuncs.com |
| RegionId | string | yes | The region ID |
| MaxEntries | integer | yes | The maximum number of entries supported by the prefix list. Valid values: 1 to 200 |
| AddressFamily | string | yes | The address family of the prefix list. Valid values: IPv4. IPv6 |
| 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… |
| PrefixListName | string | yes | The name of the prefix list. The name must be 2 to 128 characters in length, and must start with a letter or a Chinese character. It… |
| Description | string | no | The description of the prefix list. The description must be 2 to 256 characters in length, and cannot start with `http://` or `https://` |
| Entry | string | no | The prefix list entry information (JSON-encoded) |
| Tag | string | no | The tags (JSON-encoded) |
| ResourceGroupId | string | no | The ID of the resource group to which the prefix list belongs |

### Creates a security group
`POST https://zieapi.vercel.app/v1/cloud:aliyun-ecs/create-security-group` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://ecs.ap-southeast-1.aliyuncs.com |
| RegionId | string | yes | The region ID of the security group. You can call https://help.aliyun.com/document_detail/25609.html to query the most recent region list |
| Description | string | no | The description of the security group. The description must be 2 to 256 characters in length. It cannot start with `http://` or… |
| 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… |
| SecurityGroupName | string | no | The name of the security group. The name must be 2 to 128 characters in length and must start with a letter or a Chinese character. It… |
| VpcId | string | no | The ID of the VPC to which the security group belongs |
| SecurityGroupType | string | no | The type of the security group. Valid values: normal: basic security group. enterprise: advanced security group. For more information, see… |
| ServiceManaged | string | no | This parameter is not publicly available |
| ResourceGroupId | string | no | The ID of the resource group to which the security group belongs |
| Tag | string | no | The tags to add to the security group. Array length: 0 to 20 (JSON-encoded) |

### Schedules simulated system events for one or more ECS instances. Simulated system events serve as event…
`POST https://zieapi.vercel.app/v1/cloud:aliyun-ecs/create-simulated-system-events` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://ecs.ap-southeast-1.aliyuncs.com |
| RegionId | string | yes | The region ID. You can call https://help.aliyun.com/document_detail/25609.html to query the most recent region list |
| EventType | string | yes | The type of the system event. Valid values: SystemMaintenance.Reboot: The instance is restarted due to system maintenance.… |
| NotBefore | string | yes | The scheduled start time of the event. Specify the time in the https://help.aliyun.com/document_detail/25696.html standard in the… |
| InstanceId | string | yes | The list of ECS instance IDs. You can specify up to 100 instance IDs (JSON-encoded) |
| TriggerRealOps | string | no | Specifies whether to trigger real O&M operations. Valid values: - true: Triggers real O&M operations. The system will actually stop or… |

### Creates a snapshot for a cloud disk
`POST https://zieapi.vercel.app/v1/cloud:aliyun-ecs/create-snapshot` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://ecs.ap-southeast-1.aliyuncs.com |
| DiskId | string | yes | The ID of the cloud disk. You can call the DescribeDisks operation and filter by InstanceId to query the cloud disks attached to the… |
| SnapshotName | string | no | The name of the snapshot. The name must be 2 to 128 characters in length. It must start with a letter or a Chinese character and can… |
| Description | string | no | The description of the snapshot. The description must be 2 to 256 characters in length and cannot start with `http://` or `https://`.… |
| RetentionDays | integer | no | Settings for the retention period of the snapshot. Unit: days. Valid values: 1 to 65536. The snapshot is subject to automatic release when… |
| Category | string | no | The snapshot type. Valid values: Standard: standard snapshot. Flash: local snapshot. This parameter is about to be deprecated. Standard… |
| 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 make… |
| ResourceGroupId | string | no | The ID of the resource group to which the snapshot belongs |
| InstantAccess | string | no | Specifies whether to enable the snapshot instant access feature. Valid values: true: enables the feature. Only enterprise SSD disks… |
| InstantAccessRetentionDays | integer | no | Settings for the retention period of the snapshot instant access feature. The snapshot is subject to automatic release when the retention… |
| Tag | string | no | The list of tags (JSON-encoded) |
| StorageLocationArn | string | no | This parameter is not available |

### Creates a snapshot-consistent group for disks of a specified ECS instance. A snapshot-consistent group…
`POST https://zieapi.vercel.app/v1/cloud:aliyun-ecs/create-snapshot-group` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://ecs.ap-southeast-1.aliyuncs.com |
| RegionId | string | yes | The region ID of the instance. You can call https://help.aliyun.com/document_detail/25609.html to query the most recent region list |
| InstanceId | string | no | The instance ID |
| InstantAccess | string | no | Specifies whether to enable the snapshot instant access feature. Valid values: true: enables the feature. false: disables the feature.… |
| InstantAccessRetentionDays | integer | no | Sets the retention period for the snapshot instant access feature. Unit: days. Valid values: 1 to 65535. This parameter takes effect only… |
| Name | string | no | The name of the snapshot-consistent group. The name must be 2 to 128 characters in length and can contain letters and Chinese characters.… |
| Description | string | no | The description of the snapshot-consistent group. The description must be 2 to 256 characters in length and cannot start with `http://` or… |
| 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… |
| StorageLocationArn | string | no | This parameter is not available |
| ExcludeDiskId | string | no | The ID of the disk for which you do not want to create a snapshot in the instance. After you specify a disk ID, the created… |
| DiskId | string | no | The ID of the disk for which you want to create a snapshot-consistent group. You can specify multiple disk IDs across instances in the… |
| Tag | string | no | The list of tags (JSON-encoded) |
| ResourceGroupId | string | no | The ID of the resource group to which the snapshot-consistent group belongs |

### Creates a virtual storage channel (VSC) for an ECS instance
`POST https://zieapi.vercel.app/v1/cloud:aliyun-ecs/create-vsc` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://ecs.ap-southeast-1.aliyuncs.com |
| RegionId | string | yes | The region ID. You can call the DescribeRegions operation to query the most recent region list |
| Tag | string | no | The list of tags (JSON-encoded) |
| ResourceGroupId | string | no | The ID of the enterprise resource group to which the resource belongs |
| VscName | string | no | The name of the virtual storage channel |
| Description | string | no | The description of the virtual storage channel |
| InstanceId | string | yes | Instance ID |
| VscType | string | no | Specifies the VSC type. Valid values: Primary and Standard. Default value: Primary |
| ClientToken | string | no | Ensures the idempotence of the request. You can generate a parameter value from your client to ensure that the value is unique across… |
| DryRun | string | no | Specifies whether to perform a dry run on the request. Valid values: true: sends a check request and does not query the resource status.… |

### Deletes an unused activation code
`POST https://zieapi.vercel.app/v1/cloud:aliyun-ecs/delete-activation` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://ecs.ap-southeast-1.aliyuncs.com |
| RegionId | string | yes | The region ID. The following regions are supported: China (Qingdao), China (Beijing), China (Zhangjiakou), China (Hohhot), China… |
| ActivationId | string | yes | The ID of the unused activation code |

### Deletes an auto provisioning group by specifying the AutoProvisioningGroupId and TerminateInstances parameters
`POST https://zieapi.vercel.app/v1/cloud:aliyun-ecs/delete-auto-provisioning-group` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://ecs.ap-southeast-1.aliyuncs.com |
| RegionId | string | yes | The ID of the region where the auto provisioning group resides |
| AutoProvisioningGroupId | string | yes | The ID of the auto provisioning group |
| TerminateInstances | string | no | Specifies whether to release the instances in the auto-provisioning group when the group is deleted. Valid values: true: Releases the… |

### Deletes an automatic snapshot policy. If the target automatic snapshot policy has been applied to cloud…
`POST https://zieapi.vercel.app/v1/cloud:aliyun-ecs/delete-auto-snapshot-policy` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://ecs.ap-southeast-1.aliyuncs.com |
| regionId | string | yes | The region ID of the automatic snapshot. You can call https://help.aliyun.com/document_detail/25609.html to query the most recent region… |
| autoSnapshotPolicyId | string | yes | The ID of the automatic snapshot policy. You can call https://help.aliyun.com/document_detail/25530.html to query available automatic… |

### Deletes a bandwidth package
`POST https://zieapi.vercel.app/v1/cloud:aliyun-ecs/delete-bandwidth-package` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://ecs.ap-southeast-1.aliyuncs.com |
| RegionId | string | yes | The region ID of the bandwidth package. You can call the DescribeRegions operation to query the latest region list |
| BandwidthPackageId | string | yes | The ID of the bandwidth package to delete |

### Deletes a Cloud Assistant command by specifying the RegionId and CommandId parameters. A command that is…
`POST https://zieapi.vercel.app/v1/cloud:aliyun-ecs/delete-command` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://ecs.ap-southeast-1.aliyuncs.com |
| RegionId | string | yes | The region ID. You can call https://help.aliyun.com/document_detail/25609.html to query the most recent region list |
| CommandId | string | yes | The command ID. You can call the https://help.aliyun.com/document_detail/64843.html operation to query all available command IDs |

### Deletes a dedicated host group. Before you call the API operation, you must migrate the dedicated hosts in…
`POST https://zieapi.vercel.app/v1/cloud:aliyun-ecs/delete-dedicated-host-cluster` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://ecs.ap-southeast-1.aliyuncs.com |
| RegionId | string | yes | The region ID of the host group. You can call the https://help.aliyun.com/document_detail/25609.html operation to query the most recent… |
| DedicatedHostClusterId | string | yes | The ID of the host group |

### Deletes a deployment set
`POST https://zieapi.vercel.app/v1/cloud:aliyun-ecs/delete-deployment-set` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://ecs.ap-southeast-1.aliyuncs.com |
| RegionId | string | yes | The region ID of the deployment set. You can call https://help.aliyun.com/document_detail/25609.html to query the most recent region list |
| DeploymentSetId | string | yes | The ID of the deployment set to delete |

### Deletes resource diagnostic metric sets
`POST https://zieapi.vercel.app/v1/cloud:aliyun-ecs/delete-diagnostic-metric-sets` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://ecs.ap-southeast-1.aliyuncs.com |
| RegionId | string | yes | The region ID. You can call the https://help.aliyun.com/document_detail/25609.html operation to query the latest list of Alibaba Cloud… |
| MetricSetIds | string | yes | The IDs of the diagnostic metric sets. You can specify up to 10 IDs (JSON-encoded) |

### Deletes resource diagnostic reports
`POST https://zieapi.vercel.app/v1/cloud:aliyun-ecs/delete-diagnostic-reports` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://ecs.ap-southeast-1.aliyuncs.com |
| RegionId | string | yes | The region ID. You can call the https://help.aliyun.com/document_detail/25609.html operation to query the latest Alibaba Cloud regions |
| ReportIds | string | yes | The IDs of the diagnostic reports. A maximum of 100 IDs are supported (JSON-encoded) |

### Releases a pay-as-you-go data disk. Supported disk types include basic disks, ultra disks, standard SSDs,…
`POST https://zieapi.vercel.app/v1/cloud:aliyun-ecs/delete-disk` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://ecs.ap-southeast-1.aliyuncs.com |
| DiskId | string | yes | The ID of the disk to be released |

### Deletes an HPC cluster
`POST https://zieapi.vercel.app/v1/cloud:aliyun-ecs/delete-hpc-cluster` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://ecs.ap-southeast-1.aliyuncs.com |
| RegionId | string | yes | The region ID of the HPC cluster. You can call https://help.aliyun.com/document_detail/25609.html to query the most recent region list |
| 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… |
| HpcClusterId | string | yes | The ID of the HPC cluster |

### Deletes a custom image by specifying the ImageId and Force parameters
`POST https://zieapi.vercel.app/v1/cloud:aliyun-ecs/delete-image` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://ecs.ap-southeast-1.aliyuncs.com |
| RegionId | string | yes | The region ID of the custom image. You can call the https://help.aliyun.com/document_detail/25609.html operation to query the most recent… |
| ImageId | string | yes | The image ID. If the specified custom image does not exist, the request is ignored |
| Force | string | no | Specifies whether to force delete the custom image. Valid values: true: Forces the deletion of the custom image, regardless of whether the… |
| DryRun | string | no | The DryRun |

### Deletes an image component by specifying the RegionId and ImageComponentId parameters
`POST https://zieapi.vercel.app/v1/cloud:aliyun-ecs/delete-image-component` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://ecs.ap-southeast-1.aliyuncs.com |
| RegionId | string | yes | The region ID. You can call https://help.aliyun.com/document_detail/25609.html to query the most recent region list |
| ImageComponentId | string | yes | The ID of the image component to delete |

### Deletes an image template
`POST https://zieapi.vercel.app/v1/cloud:aliyun-ecs/delete-image-pipeline` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://ecs.ap-southeast-1.aliyuncs.com |
| RegionId | string | yes | The region ID. You can call https://help.aliyun.com/document_detail/25609.html to query the most recent list of Alibaba Cloud regions |
| ImagePipelineId | string | yes | The image template ID |

### Deletes or releases a specified ECS instance
`POST https://zieapi.vercel.app/v1/cloud:aliyun-ecs/delete-instance` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://ecs.ap-southeast-1.aliyuncs.com |
| InstanceId | string | yes | The instance ID |
| Force | string | no | Specifies whether to forcefully release a running (`Running`) instance. true: Forcefully releases a running (`Running`) instance. false:… |
| ForceStop | string | no | Specifies whether to use the forced shutdown policy when releasing a running (`Running`) instance. This parameter takes effect only when… |
| TerminateSubscription | string | no | Specifies whether to release an expired subscription instance. true: Releases the instance. false: Does not release the instance. Default… |
| DryRun | string | no | Specifies whether to perform only a dry run. Valid values: true: Sends a check request without releasing the instance. The system checks… |

### Releases multiple pay-as-you-go instances or expired subscription instances in a batch. You can specify…
`POST https://zieapi.vercel.app/v1/cloud:aliyun-ecs/delete-instances` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://ecs.ap-southeast-1.aliyuncs.com |
| DryRun | string | no | Specifies whether to perform only a dry run, without performing the actual request. true: sends a check request without querying resource… |
| Force | string | no | Specifies whether to forcefully release ECS instance that is in the Running state. true: forcefully releases ECS instance in the Running… |
| ForceStop | string | no | Specifies whether to forcefully stop an instance in the Running state before release. This parameter takes effect only when `Force=true`.… |
| TerminateSubscription | string | no | Specifies whether to release an expired subscription instance. true: releases the instance. false: does not release the instance. Default… |
| 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… |
| RegionId | string | yes | The region ID of the instances. You can call https://help.aliyun.com/document_detail/25609.html to query the most recent region list |
| InstanceId | string | yes | The instance ID array. Array length: 1 to 100 (JSON-encoded) |

### Deletes one or more SSH key pairs
`POST https://zieapi.vercel.app/v1/cloud:aliyun-ecs/delete-key-pairs` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://ecs.ap-southeast-1.aliyuncs.com |
| RegionId | string | yes | The region ID of the SSH key pairs. You can call https://help.aliyun.com/document_detail/25609.html to query the most recent region list |
| KeyPairNames | string | yes | The names of the SSH key pairs. The value is a JSON array of SSH key pair names. You can specify up to 100 SSH key pairs. Separate… |

### Deletes a launch template in a specified region by specifying the LaunchTemplateId or LaunchTemplateName…
`POST https://zieapi.vercel.app/v1/cloud:aliyun-ecs/delete-launch-template` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://ecs.ap-southeast-1.aliyuncs.com |
| RegionId | string | yes | The region ID of the launch template. You can call https://help.aliyun.com/document_detail/25609.html to query the most recent region list |
| LaunchTemplateId | string | no | The ID of the launch template. For more information, see https://help.aliyun.com/document_detail/73759.html. You must specify… |
| LaunchTemplateName | string | no | The name of the launch template. You must specify `LaunchTemplateId` or `LaunchTemplateName` to determine the launch template |

### Deletes one or more versions of a specified launch template by specifying parameters such as…
`POST https://zieapi.vercel.app/v1/cloud:aliyun-ecs/delete-launch-template-version` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://ecs.ap-southeast-1.aliyuncs.com |
| RegionId | string | yes | The region ID of the launch template. You can call https://help.aliyun.com/document_detail/25609.html to query the most recent region list |
| DeleteVersion | string | yes | The version numbers of the template to be deleted (JSON-encoded) |
| LaunchTemplateId | string | no | The ID of the launch template to delete. For more information, see https://help.aliyun.com/document_detail/73759.html |
| LaunchTemplateName | string | no | The name of the launch template |

### Asynchronously deletes an Elastic Network Interface (ENI)
`POST https://zieapi.vercel.app/v1/cloud:aliyun-ecs/delete-network-interface` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://ecs.ap-southeast-1.aliyuncs.com |
| RegionId | string | yes | The region ID. You can call https://help.aliyun.com/document_detail/25609.html to query the most recent region list |
| NetworkInterfaceId | string | yes | The ID of the ENI |

### Deletes an O&M window
`POST https://zieapi.vercel.app/v1/cloud:aliyun-ecs/delete-plan-maintenance-window` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://ecs.ap-southeast-1.aliyuncs.com |
| PlanWindowId | string | yes | The ID of the O&M window to delete |
| RegionId | string | yes | The region ID. You can call the https://help.aliyun.com/document_detail/25609.html operation to query the most recent region list |

### Deletes a specified port list. All entries in the port list are also deleted
`POST https://zieapi.vercel.app/v1/cloud:aliyun-ecs/delete-port-range-list` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://ecs.ap-southeast-1.aliyuncs.com |
| RegionId | string | yes | The region ID of the port list. You can call the https://help.aliyun.com/document_detail/25609.html operation to query the most recent… |
| PortRangeListId | string | yes | The ID of the port list. If the port list is associated with other resources, it cannot be deleted. Dissociate the port list from the… |

### Deletes a specified prefix list and all entries in the prefix list
`POST https://zieapi.vercel.app/v1/cloud:aliyun-ecs/delete-prefix-list` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://ecs.ap-southeast-1.aliyuncs.com |
| RegionId | string | yes | The region ID. You can call https://help.aliyun.com/document_detail/25609.html to query the most recent region list |
| PrefixListId | string | yes | The ID of the prefix list |

### Deletes a security group and all security group rules within it
`POST https://zieapi.vercel.app/v1/cloud:aliyun-ecs/delete-security-group` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://ecs.ap-southeast-1.aliyuncs.com |
| RegionId | string | yes | The region ID. You can call https://help.aliyun.com/document_detail/25609.html to query the most recent region list |
| SecurityGroupId | string | yes | The security group ID. You can call https://help.aliyun.com/document_detail/25556.html to query security group IDs |

### Deletes a specified snapshot. You can also call this operation to delete a snapshot that is being created,…
`POST https://zieapi.vercel.app/v1/cloud:aliyun-ecs/delete-snapshot` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://ecs.ap-southeast-1.aliyuncs.com |
| SnapshotId | string | yes | The snapshot ID |
| Force | string | no | Specifies whether to force delete a snapshot that has been used to create a cloud disk. Valid values: true: force deletes the snapshot.… |

### Deletes a snapshot-consistent group
`POST https://zieapi.vercel.app/v1/cloud:aliyun-ecs/delete-snapshot-group` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://ecs.ap-southeast-1.aliyuncs.com |
| RegionId | string | yes | The region ID of the snapshot-consistent group. You can call https://help.aliyun.com/document_detail/25609.html to query the most recent… |
| SnapshotGroupId | string | yes | The ID of the snapshot-consistent group. You can call https://help.aliyun.com/document_detail/210940.html to query snapshot-consistent… |

### Deletes a virtual storage channel
`POST https://zieapi.vercel.app/v1/cloud:aliyun-ecs/delete-vsc` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://ecs.ap-southeast-1.aliyuncs.com |
| RegionId | string | yes | The region ID. You can call the https://help.aliyun.com/document_detail/25609.html operation to query the most recent region list |
| VscId | string | yes | The ID of the VSC to delete |
| 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… |
| DryRun | string | no | Specifies whether to perform a dry run for the request. Valid values: true: Performs a dry run and does not query the resource status. The… |

### Unregisters a managed instance by calling DeregisterManagedInstance. After the instance is unregistered, you…
`POST https://zieapi.vercel.app/v1/cloud:aliyun-ecs/deregister-managed-instance` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://ecs.ap-southeast-1.aliyuncs.com |
| RegionId | string | yes | The region ID. The following regions are supported: China (Qingdao), China (Beijing), China (Zhangjiakou), China (Hohhot), China… |
| InstanceId | string | yes | The managed instance 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… |

### Queries the resource quotas that you can create in an Alibaba Cloud region. The quotas include the maximum…
`POST https://zieapi.vercel.app/v1/cloud:aliyun-ecs/describe-account-attributes` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://ecs.ap-southeast-1.aliyuncs.com |
| RegionId | string | yes | The region ID. You can call https://help.aliyun.com/document_detail/25609.html to query the most recent region list |
| ZoneId | string | no | The zone ID |
| AttributeName | string | no | The type of resource quota to query in the specified region. Valid values of N: 1 to 8. Valid values: instance-network-type: available… |

### Queries created activation codes and their usage
`POST https://zieapi.vercel.app/v1/cloud:aliyun-ecs/describe-activations` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://ecs.ap-southeast-1.aliyuncs.com |
| RegionId | string | yes | The region ID. Supported regions: China (Qingdao), China (Beijing), China (Zhangjiakou), China (Hohhot), China (Ulanqab), China… |
| ActivationId | string | no | The activation code ID |
| InstanceName | string | no | The default instance name prefix |
| PageNumber | integer | no | The page number. Pages start from page 1. Default value: 1 |
| PageSize | integer | no | The Settings for the number of entries to return on each page during paging in a paged query. Maximum value: 50. Default value: 10 |
| MaxResults | integer | no | The maximum number of entries to return on each page during paging in a paged query. Maximum value: 50. Default value: 10 |
| NextToken | string | no | The query token. Set the value to the NextToken value that is returned from the previous API call |
| ResourceGroupId | string | no | The ID of the resource group to which the activation code belongs |
| Tag | string | no | The list of tags (JSON-encoded) |

### Invokes the DescribeAutoProvisioningGroupHistory operation to query the scheduling node information of an…
`POST https://zieapi.vercel.app/v1/cloud:aliyun-ecs/describe-auto-provisioning-group-history` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://ecs.ap-southeast-1.aliyuncs.com |
| RegionId | string | yes | The ID of the region where the auto provisioning group resides |
| PageNumber | integer | no | The page number of the current page in a paged query. Minimum value: 1. Default value: 1 |
| PageSize | integer | no | The number of entries per page in a paged query. Maximum value: 100. Default value: 10 |
| AutoProvisioningGroupId | string | yes | The ID of the auto provisioning group |
| StartTime | string | no | The start time for querying the scheduling history. Specify the time in the https://help.aliyun.com/document_detail/25696.html standard in… |
| EndTime | string | no | The end time for querying the scheduling history. Specify the time in the https://help.aliyun.com/document_detail/25696.html standard in… |

### Queries the instances in an auto-provisioning group
`POST https://zieapi.vercel.app/v1/cloud:aliyun-ecs/describe-auto-provisioning-group-instances` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://ecs.ap-southeast-1.aliyuncs.com |
| RegionId | string | yes | The ID of the region in which the auto-provisioning group resides. You can call https://help.aliyun.com/document_detail/25609.html to… |
| PageNumber | integer | no | The page number of the paging query. Minimum value: 1. Default value: 1 |
| PageSize | integer | no | The number of entries per page when you use paging queries. Settings: Maximum value: 100. Default value: 10 |
| AutoProvisioningGroupId | string | yes | The ID of the auto-provisioning group |

### Queries one or more auto-provisioning groups
`POST https://zieapi.vercel.app/v1/cloud:aliyun-ecs/describe-auto-provisioning-groups` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://ecs.ap-southeast-1.aliyuncs.com |
| RegionId | string | yes | The ID of the region where the auto-provisioning group resides |
| PageNumber | integer | no | The page number of the list to return in a paging query. Minimum value: 1. Default value: 1 |
| PageSize | integer | no | The number of entries per page in a paging query. Maximum value: 100. Default value: 10 |
| AutoProvisioningGroupName | string | no | The name of the auto provisioning group |
| ResourceGroupId | string | no | The ID of the resource group to which the auto-provisioning group belongs |
| AutoProvisioningGroupId | string | no | The IDs of auto-provisioning groups. You can specify up to 20 auto-provisioning group IDs (JSON-encoded) |
| AutoProvisioningGroupStatus | string | no | The list of statuses of auto-provisioning groups (JSON-encoded) |
| AutoProvisioningGroupTypes | string | no | The type of the auto-provisioning group. Valid values: request, maintain, and candidate (JSON-encoded) |
| Tag | string | no | The tags attached to the auto-provisioning group (JSON-encoded) |

### Queries the associate relationships of an automatic snapshot policy
`POST https://zieapi.vercel.app/v1/cloud:aliyun-ecs/describe-auto-snapshot-policy-associations` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://ecs.ap-southeast-1.aliyuncs.com |
| RegionId | string | yes | The region ID of the automatic snapshot policy. You can call DescribeRegions… |
| AutoSnapshotPolicyId | string | no | The ID of the automatic snapshot policy. You can specify only one of AutoSnapshotPolicyId and DiskId |
| DiskId | string | no | The cloud disk ID. You can specify only one of AutoSnapshotPolicyId and DiskId |
| NextToken | string | no | The pagination token. Set this parameter to the value of NextToken returned in the previous API call |
| MaxResults | integer | no | The maximum number of entries per page for paging queries. Maximum value: 100. Default value: When no value is set or the value is set to… |

### Queries the details of automatic snapshot policies that are created in a specified region
`POST https://zieapi.vercel.app/v1/cloud:aliyun-ecs/describe-auto-snapshot-policy-ex` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://ecs.ap-southeast-1.aliyuncs.com |
| RegionId | string | yes | The region ID of the automatic snapshot policies that you want to query. You can call https://help.aliyun.com/document_detail/25609.html… |
| AutoSnapshotPolicyId | string | no | The ID of the automatic snapshot policy |
| AutoSnapshotPolicyName | string | no | The name of the automatic snapshot policy. The name must be 2 to 128 characters in length and can contain characters that are classified… |
| PageNumber | integer | no | The page number of the page to return for the automatic snapshot policy list. Minimum value: 1. Default value: 1 |
| PageSize | integer | no | The number of entries per page for the automatic snapshot policy list. Maximum value: 100. Default value: 10 |
| Tag | string | no | The tags (JSON-encoded) |
| ResourceGroupId | string | no | The ID of the resource group. When you use this parameter to filter resources, the resource count cannot exceed 1,000. Filtering by the… |

### Queries the inventory status of resources in a specified zone. This operation is primarily used to check…
`POST https://zieapi.vercel.app/v1/cloud:aliyun-ecs/describe-available-resource` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://ecs.ap-southeast-1.aliyuncs.com |
| RegionId | string | yes | The ID of the destination region. You can call https://help.aliyun.com/document_detail/25609.html to query the most recent region list |
| InstanceChargeType | string | no | The billing method of the resource. For more information, see https://help.aliyun.com/document_detail/25398.html. Valid values: PrePaid:… |
| SpotStrategy | string | no | The bidding policy for pay-as-you-go instances. Valid values: NoSpot: a regular pay-as-you-go instance. SpotWithPriceLimit: a spot… |
| SpotDuration | integer | no | The protection period of the spot instance. Unit: hours. Default value: 1. Valid values: 1: After a spot instance is created, Alibaba… |
| DestinationResource | string | yes | The type of resource to query. Valid values: Zone: zone. IoOptimized: I/O optimized. InstanceType: instance type. Network: network type.… |
| ZoneId | string | no | The zone ID. Default value: null. All zones in the specified region (RegionId) that match the query conditions are returned |
| IoOptimized | string | no | Specifies whether the instance is an I/O optimized instance. Valid values: none: non-I/O optimization. optimized: I/O optimization.… |
| DedicatedHostId | string | no | The ID of the dedicated host |
| InstanceType | string | no | The instance type. For more information, see https://help.aliyun.com/document_detail/25378.html. You can also invoke… |
| SystemDiskCategory | string | no | The category of the system disk. Valid values: cloud: basic disk. cloud_efficiency: ultra disk. cloud_ssd: standard SSD. ephemeral_ssd:… |
| DataDiskCategory | string | no | The category of the data disk. Valid values: cloud: basic disk. cloud_efficiency: ultra disk. cloud_ssd: standard SSD. ephemeral_ssd:… |
| NetworkCategory | string | no | The network type. Valid values: vpc: virtual private cloud (VPC). classic: classic network. The classic network is deprecated. For more… |
| Cores | integer | no | The number of vCPU cores of the instance type. For valid values, see https://help.aliyun.com/document_detail/25378.html. This parameter… |
| Memory | number | no | The memory size of the instance type. Unit: GiB. For valid values, see https://help.aliyun.com/document_detail/25378.html. This parameter… |
| ResourceType | string | no | The type of the resource. Valid values: instance: ECS instance. disk: cloud disk. reservedinstance: reserved instance. ddh: dedicated host |
| Scope | string | no | The scope of the reserved instance. Valid values: Region: regional. Zone: zonal |

### Queries the maximum public bandwidth that can be purchased, upgraded, or downgraded for different instance…
`POST https://zieapi.vercel.app/v1/cloud:aliyun-ecs/describe-bandwidth-limitation` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://ecs.ap-southeast-1.aliyuncs.com |
| RegionId | string | yes | The ID of the target region. You can call https://help.aliyun.com/document_detail/25609.html to query the most recent region list |
| InstanceChargeType | string | no | The billing method of the instance. For more details, see https://help.aliyun.com/document_detail/25398.html. Valid values: PrePaid:… |
| SpotStrategy | string | no | The bidding policy for the pay-as-you-go instance. Valid values: NoSpot: The instance is a regular pay-as-you-go instance.… |
| InstanceType | string | yes | The instance type. For more information, see https://help.aliyun.com/document_detail/25378.html |
| ResourceId | string | no | The resource ID. The ResourceId parameter is required when you set OperationType to Upgrade or Downgrade |
| OperationType | string | no | The type of operation for which to query the public bandwidth limits. Valid values: Upgrade: upgrades the public bandwidth. Downgrade:… |

### Queries bandwidth packages
`POST https://zieapi.vercel.app/v1/cloud:aliyun-ecs/describe-bandwidth-packages` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://ecs.ap-southeast-1.aliyuncs.com |
| RegionId | string | yes | The region ID of the bandwidth package |
| BandwidthPackageId | string | no | The ID of the bandwidth package |
| NatGatewayId | string | no | The ID of the NAT gateway. If specified, only bandwidth packages associated with the NAT gateway are returned |
| PageNumber | integer | no | The page number. Starting value: 1. Default value: 1 |
| PageSize | integer | no | The number of entries to return on each page. Valid values: 1 to 100 |

### Queries the list of instances that match a capacity reservation
`POST https://zieapi.vercel.app/v1/cloud:aliyun-ecs/describe-capacity-reservation-instances` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://ecs.ap-southeast-1.aliyuncs.com |
| RegionId | string | yes | The region ID of the capacity reservation. You can call https://help.aliyun.com/document_detail/25609.html to query the most recent region… |
| MaxResults | integer | no | The maximum number of entries per page for a paged query. Maximum value: 100. Default value: 10 |
| NextToken | string | no | The pagination token for the capacity reservation query. Obtain the value from the result of the previous request |
| PrivatePoolOptions.Id | string | yes | The ID of the capacity reservation |

### Queries the details of one or more capacity reservations, such as the status, effective and expiration time,…
`POST https://zieapi.vercel.app/v1/cloud:aliyun-ecs/describe-capacity-reservations` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://ecs.ap-southeast-1.aliyuncs.com |
| RegionId | string | yes | The region ID of the capacity reservation. You can call the https://help.aliyun.com/document_detail/25609.html operation to query the most… |
| ResourceGroupId | string | no | The resource group ID. When you use this parameter to filter resources, the resource count cannot exceed 1,000. Default resource group… |
| Tag | string | no | The tags bound to the capacity reservation (JSON-encoded) |
| MaxResults | integer | no | The number of entries per page in a paging query. Maximum value: 100. Default value: 10 |
| NextToken | string | no | The pagination token for the capacity reservation query. Obtain the token from the response of the previous request |
| PrivatePoolOptions.Ids | string | no | The IDs of the capacity reservations. The value can be a JSON array that consists of up to 100 IDs. Separate multiple IDs with commas (,) |
| Platform | string | no | The operating system of the instance. Valid values: windows: Queries only capacity reservations for Windows instances. linux: Queries only… |
| InstanceType | string | no | The instance type. You can use this parameter to query only active capacity reservations. To query released capacity reservations, you can… |
| ZoneId | string | no | The zone ID of the capacity reservation |
| InstanceChargeType | string | no | The billing method of the instance. Valid values: PostPaid: Pay-as-you-go. PrePaid: Subscription. Default value: PostPaid |
| Status | string | no | The status of the capacity reservation. Valid values: All: All statuses. Pending: Initialization. Capacity reservations that take effect… |

### Queries one or more classic network type instances that are connected to a virtual private cloud (VPC)
`POST https://zieapi.vercel.app/v1/cloud:aliyun-ecs/describe-classic-link-instances` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://ecs.ap-southeast-1.aliyuncs.com |
| RegionId | string | yes | The region ID of the instance. You can call https://help.aliyun.com/document_detail/25609.html to query the most recent region list |
| VpcId | string | no | The VPC ID. The target VPC must have the enable ClassicLink feature turned on. For more information, see… |
| InstanceId | string | no | The instance IDs. You can specify up to 100 instance IDs, separated by commas (,) |
| PageNumber | string | no | The page number. Minimum value: 1. Default value: 1 |
| PageSize | string | no | The number of entries per page for paging queries. Settings: 1 to 100. Default value: 10 |

### Queries Cloud Assistant service configurations
`POST https://zieapi.vercel.app/v1/cloud:aliyun-ecs/describe-cloud-assistant-settings` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://ecs.ap-southeast-1.aliyuncs.com |
| SettingType | string | yes | The list of service configurations to query (JSON-encoded) |
| RegionId | string | yes | The region ID |

### Queries whether Cloud Assistant Agent is installed on one or more instances. If Cloud Assistant is…
`POST https://zieapi.vercel.app/v1/cloud:aliyun-ecs/describe-cloud-assistant-status` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://ecs.ap-southeast-1.aliyuncs.com |
| RegionId | string | yes | The region ID of the instance. You can call the https://help.aliyun.com/document_detail/25609.html operation to query the most recent… |
| OSType | string | no | The operating system type of the instance. Valid values: Windows Linux FreeBSD |
| PageNumber | integer | no | This parameter will be taken offline soon. We recommend that you use NextToken and MaxResults to perform paged queries |
| PageSize | integer | no | This parameter will be taken offline soon. We recommend that you use NextToken and MaxResults to perform paged queries |
| MaxResults | integer | no | The maximum number of entries to return on each page during a paged query. This parameter is invalid if the InstanceId parameter Settings… |
| NextToken | string | no | The pagination token. Set the value to the NextToken value returned from the previous API call |
| InstanceId | string | no | The list of instance IDs (JSON-encoded) |

### Queries the Cloud Assistant commands that you manually created or the public commands provided by Alibaba…
`POST https://zieapi.vercel.app/v1/cloud:aliyun-ecs/describe-commands` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://ecs.ap-southeast-1.aliyuncs.com |
| RegionId | string | yes | The region ID. You can call the https://help.aliyun.com/document_detail/25609.html operation to query the most recent region list |
| Provider | string | no | The provider of the public command. Valid values: If you do not specify this parameter, the system queries all Cloud Assistant commands… |
| CommandId | string | no | The command ID |
| Name | string | no | The name of the command. When you specify the Provider parameter parameter query public commands, fuzzy search is supported by default.… |
| Description | string | no | The description of the command. When you specify the Provider parameter parameter query public commands, fuzzy search is supported by… |
| Type | string | no | The type of the command. Valid values: RunBatScript: a Bat script that runs on a Windows instance. RunPowerShellScript: a PowerShell… |
| ContentEncoding | string | no | The encoding mode of the CommandContent and Output fields in the response. Valid values: PlainText: Returns the original script content… |
| PageNumber | integer | no | This parameter will be deprecated soon. Use the NextToken and MaxResults parameters for paging |
| PageSize | integer | no | This parameter will be deprecated soon. Use the NextToken and MaxResults parameters for paging |
| MaxResults | integer | no | The maximum number of entries per page for paging. Maximum value: 50. Default value: 10 |
| NextToken | string | no | The pagination token. Set the value to the NextToken value returned from the previous API call |
| Latest | string | no | Specifies whether to query only the latest version of public commands if the query result includes public commands. This parameter does… |
| ResourceGroupId | string | no | The ID of the resource group to which the command belongs |
| Tag | string | no | The list of tags (JSON-encoded) |

### Queries the auto-renewal status of one or more subscription dedicated hosts
`POST https://zieapi.vercel.app/v1/cloud:aliyun-ecs/describe-dedicated-host-auto-renew` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://ecs.ap-southeast-1.aliyuncs.com |
| DedicatedHostIds | string | yes | The ID of the dedicated host. You can specify up to 100 subscription dedicated host IDs. Separate multiple IDs with commas (,) |
| RegionId | string | yes | The ID of the region where the dedicated host resides |

### Queries the details of one or more dedicated host clusters
`POST https://zieapi.vercel.app/v1/cloud:aliyun-ecs/describe-dedicated-host-clusters` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://ecs.ap-southeast-1.aliyuncs.com |
| Status | string | no | This parameter is not available and is not supported |
| LockReason | string | no | This parameter is not available and is not supported |
| ResourceGroupId | string | no | The ID of the resource group to which the dedicated host cluster belongs. When you use this parameter to filter resources, the resource… |
| Tag | string | no | The list of tags (JSON-encoded) |
| RegionId | string | yes | The region ID of the dedicated host cluster. You can call the https://help.aliyun.com/document_detail/25609.html operation to query the… |
| ZoneId | string | no | The zone ID of the dedicated host cluster. You can call the https://help.aliyun.com/document_detail/25610.html operation to query the… |
| DedicatedHostClusterIds | string | no | The list of dedicated host cluster IDs. The value can be a JSON array that consists of multiple dedicated host cluster IDs in the… |
| DedicatedHostClusterName | string | no | The name of the dedicated host cluster |
| PageNumber | integer | no | The page number of the dedicated host cluster list. Starting value: 1. Default value: 1 |
| PageSize | integer | no | The paging Settings for the number of entries per page in a paged query. Maximum value: 100. Default value: 10 |

### Queries the details of dedicated host types supported in a region, or the Elastic Compute Service (ECS)…
`POST https://zieapi.vercel.app/v1/cloud:aliyun-ecs/describe-dedicated-host-types` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://ecs.ap-southeast-1.aliyuncs.com |
| RegionId | string | yes | The region ID. You can call the https://help.aliyun.com/document_detail/25609.html operation to query the most recent region list |
| DedicatedHostType | string | no | The dedicated host type. For more information, see https://help.aliyun.com/document_detail/68564.html |
| SupportedInstanceTypeFamily | string | no | The ECS instance family supported by the dedicated host type |

### Queries the details of one or more dedicated hosts. This operation retrieves information including physical…
`POST https://zieapi.vercel.app/v1/cloud:aliyun-ecs/describe-dedicated-hosts` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://ecs.ap-southeast-1.aliyuncs.com |
| RegionId | string | yes | The region ID of the dedicated host. You can call the https://help.aliyun.com/document_detail/25609.html operation to query the most… |
| ZoneId | string | no | The zone ID. You can call the https://help.aliyun.com/document_detail/25610.html operation to query the most recent zone list |
| DedicatedHostIds | string | no | The IDs of the dedicated hosts. You can specify up to 100 IDs. Separate multiple IDs with commas (,) |
| DedicatedHostName | string | no | The name of the dedicated host |
| Status | string | no | The status of the dedicated host. Valid values: Available: The dedicated host is running. This is the normal status of a dedicated host.… |
| DedicatedHostType | string | no | The type of the dedicated host. You can call the https://help.aliyun.com/document_detail/134240.html operation to query the most recent… |
| LockReason | string | no | The reason why the dedicated host is locked. Valid values: financial: The dedicated host is locked due to overdue payments. security: The… |
| PageNumber | integer | no | This parameter will be deprecated soon. We recommend that you use NextToken and MaxResults for pagination |
| PageSize | integer | no | This parameter will be deprecated soon. We recommend that you use NextToken and MaxResults for pagination |
| ResourceGroupId | string | no | The ID of the resource group to which the dedicated host belongs. When you use this parameter to filter resources, the resource count… |
| NeedHostDetail | string | no | Specifies whether to return the details of the dedicated host |
| Tag | string | no | The list of tags. You can specify 0 to 20 tags (JSON-encoded) |
| DedicatedHostClusterId | string | no | The ID of the dedicated host cluster |
| SocketDetails | string | no | Specifies whether to display socket-level capacity information. You can view the remaining resource information (vCPU and memory usage,… |
| NextToken | string | no | The query token. Set the value to the NextToken value returned in the previous call to this operation. You do not need to specify this… |
| MaxResults | integer | no | The maximum number of entries per page for a paged query. If you specify this parameter, the query uses the combination of MaxResults and… |
| QueryInventory | string | no | Specifies whether to query the inventory information of the dedicated host |

### Calls DescribeDeploymentSetSupportedInstanceTypeFamily to query the instance families that support each…
`POST https://zieapi.vercel.app/v1/cloud:aliyun-ecs/describe-deployment-set-supported-instance-type-family` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://ecs.ap-southeast-1.aliyuncs.com |
| RegionId | string | yes | The region ID of the deployment set. You can call https://help.aliyun.com/document_detail/25609.html to query the most recent region list |
| Strategy | string | no | The deployment strategy. Valid values: Availability: high availability strategy. AvailabilityGroup: high availability strategy for… |

### Queries the details of one or more deployment sets
`POST https://zieapi.vercel.app/v1/cloud:aliyun-ecs/describe-deployment-sets` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://ecs.ap-southeast-1.aliyuncs.com |
| RegionId | string | yes | The region ID of the deployment set. You can call https://help.aliyun.com/document_detail/25609.html to query the most recent region list |
| PageNumber | integer | no | The page number of the deployment set list. Minimum value: 1. Default value: 1 |
| PageSize | integer | no | The number of entries per page for the paged query. Maximum value: 50. Default value: 10 |
| DeploymentSetIds | string | no | The IDs of deployment sets. The value can be a JSON array that consists of multiple deployment set IDs in the format of `["ds-xxxxxxxxx",… |
| NetworkType | string | no | This parameter is deprecated |
| Strategy | string | no | The deployment strategy. Valid values: Availability: high availability strategy. AvailabilityGroup: high availability group strategy.… |
| DeploymentSetName | string | no | The name of the deployment set. The name must be 2 to 128 characters in length and can contain characters that are categorized as letter… |
| Granularity | string | no | This parameter is deprecated |
| Domain | string | no | This parameter is deprecated |
| Type | string | no | The deployment type. Valid values: host: physical machine sw: vSwitch rack: rack Default value: host |

### Queries resource diagnostic metric sets
`POST https://zieapi.vercel.app/v1/cloud:aliyun-ecs/describe-diagnostic-metric-sets` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://ecs.ap-southeast-1.aliyuncs.com |
| RegionId | string | yes | The region ID. You can call the https://help.aliyun.com/document_detail/25609.html operation to query the most recent region list |
| MetricSetIds | string | no | The IDs of the diagnostic metric sets (JSON-encoded) |
| Type | string | no | The type of the diagnostic metric set. Valid values: User: user-created. Common: public. Default value: User |
| ResourceType | string | no | The resource type |
| NextToken | string | no | The pagination token. Set the value to the `NextToken` value returned from the previous call. Leave this parameter empty for the first call |
| MaxResults | integer | no | The maximum number of entries per page for a paging query. Maximum value: 100. Default value: If no Settings are specified, the default… |

### Calls DescribeDiagnosticMetrics to query the list of diagnostic metrics
`POST https://zieapi.vercel.app/v1/cloud:aliyun-ecs/describe-diagnostic-metrics` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://ecs.ap-southeast-1.aliyuncs.com |
| RegionId | string | yes | The region ID. You can call https://help.aliyun.com/document_detail/25609.html to query the most recent list of Alibaba Cloud regions |
| MetricIds | string | no | The list of diagnostic metrics (JSON-encoded) |
| ResourceType | string | no | The supported resource type |
| NextToken | string | no | The pagination token. Set this parameter to the value of NextToken returned in the previous call. Leave this parameter empty for the first… |
| MaxResults | integer | no | The number of entries per page for a paged query. Maximum value: 100. Default value: If this parameter is not set, the default value is… |

### Queries the details of a resource diagnostic report by calling DescribeDiagnosticReportAttributes
`POST https://zieapi.vercel.app/v1/cloud:aliyun-ecs/describe-diagnostic-report-attributes` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://ecs.ap-southeast-1.aliyuncs.com |
| RegionId | string | yes | The region ID. You can call https://help.aliyun.com/document_detail/25609.html to query the most recent region list |
| ReportId | string | yes | The ID of the diagnostic report |

### Queries a list of resource diagnostic reports
`POST https://zieapi.vercel.app/v1/cloud:aliyun-ecs/describe-diagnostic-reports` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://ecs.ap-southeast-1.aliyuncs.com |
| RegionId | string | yes | The region ID. You can call the https://help.aliyun.com/document_detail/25609.html operation to query the most recent region list |
| ReportIds | string | no | The list of diagnostic report IDs (JSON-encoded) |
| ResourceIds | string | no | The list of resource IDs. A maximum of 100 IDs are supported (JSON-encoded) |
| Status | string | no | The report status. Valid values: InProgress: The diagnosis is in progress. Failed: The diagnosis failed. Finished: The diagnosis is finished |
| Severity | string | no | The severity level. Valid values: Unknown: The initial state, which indicates that the diagnosis has not started or the diagnostic program… |
| NextToken | string | no | The query token. Set the value to the `NextToken` value returned from the previous call. You do not need to specify this parameter for the… |
| MaxResults | integer | no | The number of entries per page for a paging query. Maximum value: 100. Default value: If no Settings are specified, the default value is… |

### Queries the key used for account-level default encryption of block storage
`POST https://zieapi.vercel.app/v1/cloud:aliyun-ecs/describe-disk-default-kmskey-id` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://ecs.ap-southeast-1.aliyuncs.com |
| RegionId | string | yes | The region ID. You can call https://help.aliyun.com/document_detail/2679950.html to view the latest list of Alibaba Cloud regions |

### Queries the service status of account-level default encryption for block storage in a specified region
`POST https://zieapi.vercel.app/v1/cloud:aliyun-ecs/describe-disk-encryption-by-default-status` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://ecs.ap-southeast-1.aliyuncs.com |
| RegionId | string | yes | The region ID. You can call the https://help.aliyun.com/document_detail/2679950.html operation to query the latest list of Alibaba Cloud… |

### Queries the usage information of a disk within a specified time period, such as read IOPS, write IOPS, read…
`POST https://zieapi.vercel.app/v1/cloud:aliyun-ecs/describe-disk-monitor-data` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://ecs.ap-southeast-1.aliyuncs.com |
| DiskId | string | yes | The ID of the disk |
| StartTime | string | yes | The start time of the data. Specify the time in the https://help.aliyun.com/document_detail/25696.html standard in the… |
| EndTime | string | yes | The end time of the data. Specify the time in the https://help.aliyun.com/document_detail/25696.html standard in the yyyy-MM-ddTHH:mm:ssZ… |
| Period | integer | no | The precision of the data. Unit: seconds. Valid values: 60 600 3600 Default value: 60. The value of (EndTime - StartTime) / Period must be… |

### Queries the details of one or more block storage devices, including cloud disks, local disks, and elastic…
`POST https://zieapi.vercel.app/v1/cloud:aliyun-ecs/describe-disks` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://ecs.ap-southeast-1.aliyuncs.com |
| RegionId | string | yes | The region ID of the block storage device. You can call the https://help.aliyun.com/document_detail/25609.html operation to query the most… |
| ZoneId | string | no | The zone ID |
| DiskIds | string | no | The IDs of the cloud disks, local disks, or elastic ephemeral disks. The value is a JSON array that contains up to 100 IDs separated by… |
| InstanceId | string | no | The instance ID to which the disk, local disk, or elastic ephemeral disk is attached |
| DiskType | string | no | The type of the cloud disk, local disk, or elastic ephemeral disk to query. Valid values: all: queries both system disks and data disks.… |
| Category | string | no | The disk category. Valid values: all: all cloud disks, local disks, and elastic ephemeral disks. cloud: basic disk. cloud_efficiency:… |
| PerformanceLevel | string | no | The performance level (PL) of the ESSD disk. Valid values: PL0, PL1, PL2, and PL3 |
| Status | string | no | The disk status. For more information, see https://help.aliyun.com/document_detail/25689.html. Valid values: In_use: The disk is in use.… |
| SnapshotId | string | no | The ID of the snapshot used to create the cloud disk |
| Portable | string | no | Specifies whether the disk can be detached. Valid values: true: The disk can be detached. It can exist independently and can be freely… |
| DeleteWithInstance | string | no | Specifies whether the disk is released together with the instance. Valid values: true: The disk is released together with the instance.… |
| DeleteAutoSnapshot | string | no | Specifies whether automatic snapshots are released when the cloud disk is released. Valid values: true: Automatic snapshots are released.… |
| PageNumber | integer | no | This parameter is about to go offline. We recommend that you use the `NextToken` and `MaxResults` parameters to perform paging and… |
| PageSize | integer | no | This parameter is about to go offline. We recommend that you use the `NextToken` and `MaxResults` parameters to perform paging and… |
| NextToken | string | no | The query token. The value is the `NextToken` value returned from the previous API call. For more information about how to configure the… |
| MaxResults | integer | no | The maximum number of entries to return. Valid values: 10 to 500. Default value: If this parameter is not specified or the specified value… |
| DiskName | string | no | The name of the disk. The name must be 2 to 128 characters in length and can contain Unicode letters, including English letters, Chinese… |
| AutoSnapshotPolicyId | string | no | The ID of the automatic snapshot policy |
| EnableAutoSnapshot | string | no | Specifies whether the automatic snapshot policy feature is enabled for the cloud disk. Valid values: true: The feature is enabled. false:… |
| EnableAutomatedSnapshotPolicy | string | no | Specifies whether an automatic snapshot policy is applied to the cloud disk. Valid values: true: An automatic snapshot policy is applied.… |
| DiskChargeType | string | no | The billing method of the disk. Valid values: PrePaid: subscription. PostPaid: pay-as-you-go |
| LockReason | string | no | The reason why the disk is locked. Valid values: financial: The disk is locked due to overdue payments. security: The disk is locked for… |
| Filter.1.Key | string | no | The filter key used to query resources. Set the value to `CreationStartTime`. If you specify both `Filter.1.Key` and `Filter.1.Value`, you… |
| Filter.2.Key | string | no | The filter key used to query resources. Set the value to `CreationEndTime`. If you specify both `Filter.2.Key` and `Filter.2.Value`, you… |
| Filter.1.Value | string | no | The filter value used to query resources. If you specify this parameter, you must also specify the `Filter.1.Key` parameter. Specify the… |
| Filter.2.Value | string | no | The filter value used to query resources. If you specify this parameter, you must also specify the `Filter.2.Key` parameter. Specify the… |
| ResourceGroupId | string | no | The ID of the enterprise resource group to which the disk belongs. When you use this parameter to filter resources, the resource count… |
| EnableShared | string | no | Specifies whether the block storage device is Shared Block Storage |
| Encrypted | string | no | Specifies whether to query only encrypted cloud disks. Valid values: true: Yes. false: No. Default value: false |
| DryRun | string | no | Specifies whether to only perform a dry run for this request. Valid values: true: send a check request and do not query resources. The… |
| KMSKeyId | string | no | The ID of the Key Management Service (KMS) key used by the cloud disk |
| MultiAttach | string | no | Specifies whether the multi-attach feature is enabled. Valid values: Disabled: The feature is disabled. Enabled: The feature is enabled.… |
| Tag | string | no | The tags of the disk (JSON-encoded) |
| AdditionalAttributes | string | no | The list of additional attributes. Currently, only `Placement` is supported, which indicates the data storage location of the disk.… |

### Queries the full status information of one or more block storage devices
`POST https://zieapi.vercel.app/v1/cloud:aliyun-ecs/describe-disks-full-status` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://ecs.ap-southeast-1.aliyuncs.com |
| RegionId | string | yes | The region ID of the block storage device. You can call https://help.aliyun.com/document_detail/25609.html to query the most recent region… |
| Status | string | no | The lifecycle status of the block storage device. For more information, see https://help.aliyun.com/document_detail/25689.html. Valid… |
| HealthStatus | string | no | The health status of the block storage device. Valid values: Impaired: temporarily unreadable and unwritable. Warning: degraded service.… |
| EventType | string | no | The event type of the block storage device. Valid values: Degraded: The block storage performance is degraded. SeverelyDegraded: The block… |
| EventTime.Start | string | no | The start of the time range during which to query events. Specify the time in the https://help.aliyun.com/document_detail/25696.html… |
| EventTime.End | string | no | The end of the time range during which to query events. Specify the time in the https://help.aliyun.com/document_detail/25696.html… |
| PageNumber | integer | no | The page number of the query result. Valid values: positive integers. Default value: 1 |
| PageSize | integer | no | The number of entries per page. Valid values: 1 to 100. Default value: 10 |
| DiskId | string | no | The block storage ID. Valid values of N: 1 to 100 (JSON-encoded) |
| EventId | string | no | The event ID. Valid values of N: 1 to 100 (JSON-encoded) |
| ResourceGroupId | string | no | The ID of the resource group to which the block storage resource belongs. When you use this parameter to filter resources, the resource… |
| Tag | string | no | The tags (JSON-encoded) |

### Queries the auto-renewal attributes of one or more elasticity assurances
`POST https://zieapi.vercel.app/v1/cloud:aliyun-ecs/describe-elasticity-assurance-auto-renew-attribute` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://ecs.ap-southeast-1.aliyuncs.com |
| RegionId | string | yes | The region ID of the elasticity assurance. You can call the https://help.aliyun.com/document_detail/25609.html operation to query the most… |
| PrivatePoolOptions.Id | string | no | The list of elasticity assurance IDs. This parameter is required. If this parameter is not specified, the API returns… |

### Queries the list of running instances matched with an elasticity assurance
`POST https://zieapi.vercel.app/v1/cloud:aliyun-ecs/describe-elasticity-assurance-instances` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://ecs.ap-southeast-1.aliyuncs.com |
| RegionId | string | yes | The region ID of the elasticity assurance. You can call the https://help.aliyun.com/document_detail/25609.html operation to query the most… |
| MaxResults | integer | no | The number of entries to return per page for paging. Maximum value: 100. Default value: 10 |
| NextToken | string | no | The pagination token for the query. You can obtain the token from the response of the previous request |
| PrivatePoolOptions.Id | string | yes | The ID of the elasticity assurance |

### Queries the details of an elasticity assurance. For example, you can query the status, match mode, effective…
`POST https://zieapi.vercel.app/v1/cloud:aliyun-ecs/describe-elasticity-assurances` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://ecs.ap-southeast-1.aliyuncs.com |
| RegionId | string | yes | The ID of the region to which the elasticity assurance belongs. You can call https://help.aliyun.com/document_detail/25609.html to query… |
| ResourceGroupId | string | no | The ID of the resource group. When you use this parameter to filter resources, the resource count cannot exceed 1,000. Filtering by the… |
| Tag | string | no | The list of tag key-value pairs bound to the elasticity assurance (JSON-encoded) |
| MaxResults | integer | no | The maximum number of entries per page for a paged query. Maximum value: 100. Default value: 10 |
| NextToken | string | no | The pagination token for the elasticity assurance query. Obtain the value from the result of the previous request |
| PrivatePoolOptions.Ids | string | no | The list of elasticity assurance IDs. The value can be a JSON array that consists of up to 100 IDs. Separate multiple IDs with commas (,) |
| Platform | string | no | This parameter is deprecated |
| InstanceType | string | no | The instance type. You can use the instance type to query only active elasticity assurances. Released elasticity assurances can be queried… |
| ZoneId | string | no | The zone ID in the region to which the elasticity assurance belongs |
| InstanceChargeType | string | no | The billing method of the instance. Valid values: PostPaid. Only pay-as-you-go is supported. Default value: PostPaid |
| Status | string | no | The status of the elasticity assurance. Valid values: All: all states. Deactived: to be activated. This state is in invitational preview.… |
| PackageType | string | no | The type of the elasticity assurance. Valid values: ElasticityAssurance: standard elasticity assurance. This is the type when… |

### Queries the traffic information of a secondary ENI within a specified time range by calling…
`POST https://zieapi.vercel.app/v1/cloud:aliyun-ecs/describe-eni-monitor-data` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://ecs.ap-southeast-1.aliyuncs.com |
| EniId | string | no | The ID of the secondary ENI. By default, all secondary ENIs that are attached to the specified instance are queried |
| RegionId | string | yes | The region ID. You can call https://help.aliyun.com/document_detail/25609.html to query the most recent region list |
| InstanceId | string | yes | The ID of the instance to which the secondary ENI is attached |
| StartTime | string | yes | The beginning of the time range to query. Specify the time in the https://help.aliyun.com/document_detail/25696.html standard in the… |
| EndTime | string | yes | The end of the time range to query. Specify the time in the https://help.aliyun.com/document_detail/25696.html standard in the… |
| Period | integer | no | The interval at which to retrieve monitoring data. Unit: seconds. Valid values: 60. 600. 3600. Default value: 60 |

### Queries the available HPC clusters. The request parameters are used as filters. The filtering relationship…
`POST https://zieapi.vercel.app/v1/cloud:aliyun-ecs/describe-hpc-clusters` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://ecs.ap-southeast-1.aliyuncs.com |
| RegionId | string | yes | The region ID. You can call the https://help.aliyun.com/document_detail/25609.html operation to query the most recent region list |
| 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 make… |
| HpcClusterIds | string | no | The IDs of the HPC clusters. The value can be a JSON array that consists of up to 100 HPC cluster IDs. Separate multiple IDs with commas (,) |
| PageNumber | integer | no | The page number of the HPC cluster list. Starting value: 1. Default value: 1 |
| PageSize | integer | no | The number of entries per page for paging Settings in a paged query. Maximum value: 100. Default value: 10 |

### Queries the details of one or more image components
`POST https://zieapi.vercel.app/v1/cloud:aliyun-ecs/describe-image-components` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://ecs.ap-southeast-1.aliyuncs.com |
| RegionId | string | yes | The region ID. You can call https://help.aliyun.com/document_detail/25609.html to query the most recent region list |
| ResourceGroupId | string | no | The resource group ID. When you use this parameter to filter resources, the resource count cannot exceed 1,000. Filtering by the default… |
| Tag | string | no | The tags (JSON-encoded) |
| Name | string | no | The image component name. Only exact match is supported |
| NextToken | string | no | The pagination token. Set this parameter to the value of `NextToken` returned in the previous call to this operation. You do not need to… |
| MaxResults | integer | no | The maximum number of entries per page for paging. Valid values: 1 to 500. Default value: 50 |
| Owner | string | no | The image component type. Valid values: SELF: custom image components that you created. ALIYUN: system components provided by Alibaba Cloud |
| ImageComponentId | string | no | The ID of the image component to query. Valid values of N: 1 to 20 (JSON-encoded) |
| ComponentType | string | no | The component type. Valid values: Build Test |
| SystemType | string | no | The operating system supported by the component. Valid values: Linux Windows |
| ComponentVersion | string | no | The component version number in the major.minor.patch format. Each part must be a non-negative integer. You can also use the wildcard… |

### Queries the latest available image in a specified image family
`POST https://zieapi.vercel.app/v1/cloud:aliyun-ecs/describe-image-from-family` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://ecs.ap-southeast-1.aliyuncs.com |
| RegionId | string | yes | The region ID of the image. You can call https://help.aliyun.com/document_detail/25609.html to query the most recent region list |
| ImageFamily | string | yes | The name of the image family. Custom images, public images, community images, and shared images all support image families. For more… |

### Queries the details of an image build task
`POST https://zieapi.vercel.app/v1/cloud:aliyun-ecs/describe-image-pipeline-executions` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://ecs.ap-southeast-1.aliyuncs.com |
| RegionId | string | yes | The region ID. You can call https://help.aliyun.com/document_detail/25609.html to query the most recent region list |
| Tag | string | no | The tags (JSON-encoded) |
| ImagePipelineId | string | no | The image template ID |
| ExecutionId | string | no | The image build task ID |
| Status | string | no | The status of the image build task. You can specify multiple values at the same time. Separate multiple values with commas (,). Example:… |
| NextToken | string | no | The query token. Set the value to the NextToken value returned in the previous call to this operation. You do not need to set this… |
| MaxResults | integer | no | The maximum number of entries per page for paging queries. Valid values: 1 to 500. Default value: 50 |

### Queries the details of one or more image templates
`POST https://zieapi.vercel.app/v1/cloud:aliyun-ecs/describe-image-pipelines` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://ecs.ap-southeast-1.aliyuncs.com |
| RegionId | string | yes | The region ID. You can call the https://help.aliyun.com/document_detail/25609.html operation to query the most recent region list |
| ResourceGroupId | string | no | The resource group ID. When you use this parameter to filter resources, the resource count cannot exceed 1,000. Filtering by the default… |
| Tag | string | no | The tags (JSON-encoded) |
| Name | string | no | The name of the template |
| NextToken | string | no | The query token. Set the value to the `NextToken` value returned from the previous API call. You do not need to specify this parameter for… |
| MaxResults | integer | no | The maximum number of entries per page for paging. Valid values: 1 to 500. Default value: 50 |
| ImagePipelineId | string | no | The ID of the image template. Valid values of N: 1 to 20 (JSON-encoded) |

### Queries all users with whom a custom image has been shared. The results are displayed by page, with 10…
`POST https://zieapi.vercel.app/v1/cloud:aliyun-ecs/describe-image-share-permission` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://ecs.ap-southeast-1.aliyuncs.com |
| RegionId | string | yes | The region ID of the custom image. You can call https://help.aliyun.com/document_detail/25609.html to query the most recent region list |
| ImageId | string | yes | The ID of the custom image |
| PageNumber | integer | no | The page number of the query results to return. Minimum value: 1. Default value: 1 |
| PageSize | integer | no | The number of entries per page in the query results. Maximum value: 100. Default value: 10 |

…and 181 more. See the OpenAPI spec.

## Example
```
curl "https://zieapi.vercel.app/v1/cloud:aliyun-ecs/accept-inquired-system-event" \
  -H "x-api-key: $APIZIE_KEY" \
  -H "x-upstream-key: $PROVIDER_KEY"
```

## FAQ

### How do I call the Alibaba Cloud Elastic Compute Service API?
Create a free Apizie key, then send POST https://zieapi.vercel.app/v1/cloud:aliyun-ecs/accept-inquired-system-event with the header x-api-key. Every endpoint returns { project, data, timestamp }.

### Is the Alibaba Cloud Elastic Compute Service 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 Compute Service itself also needs your own key from aliyuncs.com.

### Can AI agents use the Alibaba Cloud Elastic Compute Service API?
Yes. Add the Apizie MCP server (https://zieapi.vercel.app/mcp) to Claude, ChatGPT, Cursor or VS Code, then ask in plain language. The agent calls run_scraper with project key cloud:aliyun-ecs.

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