CreateEaiEcs

Updated at:
Copy as MD

Creates an elastic accelerated computing instance and a client ECS instance, and binds the elastic accelerated computing instance to the ECS instance.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

  • Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.

  • API: The API that you can call to perform the action.

  • Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.

  • Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.

    • For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.

    • For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.

  • Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.

  • Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

eais:CreateEaiEcs

create

*Instance

acs:eais:{#regionId}:{#accountId}:instance/*

None None

Request parameters

Parameter

Type

Required

Description

Example

ClientToken

string

No

The idempotency parameter that ensures request idempotency. Generate the parameter value on your client and ensure that the value is unique across different requests. ClientToken supports only ASCII characters and can be up to 64 characters in length. For more information, see How to ensure idempotency.

123e4567-e89b-12d3-a456-426655440000

RegionId

string

Yes

The region ID of the instance. You can call the DescribeRegions operation to query the most recent region list.

cn-shenzhen

EaisName

string

No

The name of the elastic accelerated computing instance. The name must be 2 to 128 characters in length. It must start with a letter or a Chinese character and cannot start with http:// or https://. It can contain digits, colons (:), underscores (_), periods (.), and hyphens (-).

eais-test01

Ecs

object

No

The ECS instance parameter object.

ImageId

string

No

The image ID used by the ECS instance.

aliyun_2_1903_x64_20G_alibase_20200324.vhd

InternetMaxBandwidthIn

string

No

The maximum inbound public bandwidth of the ECS instance. Unit: Mbit/s. Valid values:

  • If the purchased outbound public bandwidth is less than or equal to 10 Mbit/s: 1 to 10. Default value: 10.

  • If the purchased outbound public bandwidth is greater than 10 Mbit/s: 1 to the value of InternetMaxBandwidthOut. Default value: the value of InternetMaxBandwidthOut.

10

InternetMaxBandwidthOut

string

No

The maximum outbound public bandwidth of the ECS instance. Unit: Mbit/s. Valid values: 0 to 100. Default value: 0.

10

Name

string

No

The name of the ECS instance. The name must be 2 to 128 characters in length. It must start with a letter or a Chinese character and cannot start with http:// or https://. It can contain Chinese characters, letters, digits, colons (:), underscores (_), periods (.), and hyphens (-).

test1

Password

string

No

The password of the ECS instance. The password must be 8 to 30 characters in length and must contain at least three of the following character types: uppercase letters, lowercase letters, digits, and special characters. Special characters include: ()~!@#$%^&*-_+=|{}[]:;'<>,.?/.

EcsV587!

SystemDiskCategory

string

No

The category of the system cloud disk for the ECS instance. Valid values:

  • cloud_efficiency: ultra disk.

  • cloud_ssd: standard SSD.

  • cloud_essd: ESSD.

  • cloud: basic disk.

  • cloud_auto: ESSD AutoPL disk.

Default value: cloud if the instance type is phased out or does not support I/O optimization. Otherwise, the default value is cloud_efficiency.

cloud_ssd

SystemDiskSize

integer

No

The size of the system cloud disk for the ECS instance. Unit: GiB. Valid values: 20 to 500.

The value of this parameter must be greater than or equal to max{20, ImageSize}.

Default value: max{40, Image size corresponding to ImageId}.

40

Type

string

No

The instance type of the ECS instance.

ecs.g7.4xlarge

ZoneId

string

No

The zone ID of the ECS instance.

cn-shenzhen-e

EaisType

string

Yes

The instance type of the EAIS instance. Valid values:

  • eais.ei-a6.4xlarge

  • eais.ei-a6.2xlarge

  • eais.ei-a6.xlarge

  • eais.ei-a6.large

eais.ei-a6.2xlarge

VSwitchId

string

Yes

The vSwitch ID of the instance.

Note

The number of IP addresses in the vSwitch CIDR block determines the maximum number of EAIS instances that can be created in the vSwitch. Plan the CIDR block settings in advance.

vsw-uf6h3rbwbm90urjwa****

SecurityGroupId

string

Yes

The security group ID of the instance.

sg-uf66jeqopgqa9hdn****

ResourceGroupId

string

No

The resource group ID of the EAIS instance.

rg-acfmvpuy4a5****

Tag

array<object>

No

The list of tags. You can specify up to 20 tags.

object

No

The tag information.

Key

string

No

The tag key. Limits:

  • It cannot be empty.

  • It can be up to 128 characters in length.

  • It cannot start with aliyun or acs:.

  • It cannot contain http:// or https://.

TestKey

Value

string

No

The tag value. Limits:

  • It can be up to 128 characters in length.

  • It cannot start with aliyun or acs:.

  • It cannot contain http:// or https://.

TestValue

Response elements

Element

Type

Description

Example

object

Schema of Response

RequestId

string

The request ID.

F5FEB9AA-C108-577C-AB3D-D13524AF****

ElasticAcceleratedInstanceId

string

The EAIS instance ID.

eais-sz8t15a7gt7z7j7i****

ClientInstanceId

string

The ECS instance ID.

i-bp1hjrvleawl4ogb****

Examples

Success response

JSON format

{
  "RequestId": "F5FEB9AA-C108-577C-AB3D-D13524AF****",
  "ElasticAcceleratedInstanceId": "eais-sz8t15a7gt7z7j7i****",
  "ClientInstanceId": "i-bp1hjrvleawl4ogb****"
}

Error codes

HTTP status code

Error code

Error message

Description

400 CheckTimeout Check timed out.
400 CustomTag.NumberExceed The maximum number of system tags for each resource is 20.
400 Duplicate.TagKey The Tag.N.Key contains a duplicated key.
400 InvalidInstanceType The instance type is invalid.
400 InvalidParameter.TagKey The specified Tag.n.Key is invalid.
400 InvalidParameter.TagValue The specified Tag.n.Value is invalid.
400 InvalidRegionId The service does not support the region. You can call the DescribeRegions API to view the supported regions.
400 NumberExceed.Tags The maximum number of Tags is exceeded. The maximum is 20.
400 Timeout Operation timed out.
401 CallRamApiFailed Failed to call the Alibaba Cloud RAM service.
403 CreateOrderFailed Create order failed: %s.
403 InDebt The current user has an overdue payment. Please top up first.
403 NoPermission You are not authorized to perform this operation. %s
403 NoResources The current regional resources are insufficient.
403 OperationDenied.KeyValueNotNull The key value cannot be null.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.