CreateEaiJupyter

Updated at:
Copy as MD

Creates an Elastic Accelerated Computing Instance (EAIS) with a deployed notebook.

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:CreateEaiJupyter

create

*Instance

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

None None

Request parameters

Parameter

Type

Required

Description

Example

RegionId

string

Yes

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

Valid values:

  • cn-hangzhou :

    cn-hangzhou

cn-hangzhou

EaisType

string

Yes

The instance type of the EAIS instance. Only eais.ei-a6.2xlarge is supported.

Valid values:

  • eais.ei-a6.2xlarge :

    eais.ei-a6.2xlarge

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****

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 sure that the value is unique among different requests. The client token can contain only ASCII characters and cannot exceed 64 characters in length. For more information, see How to ensure idempotence.

123e4567-e89b-12d3-a456-426655440000

EnvironmentVar

array<object>

No

The environment variables to set during the initialization of the EAIS instance.

object

No

Key

string

No

The name of the environment variable. The name must be 1 to 128 characters in length. It can contain letters, digits, and underscores (_), and cannot start with a digit.

MY_USER_NAME

Value

string

No

The value of the environment variable. The value must be 0 to 256 characters in length.

test123

ResourceGroupId

string

No

The resource group ID of the EAIS instance.

rg-acfmvpuy4a5****

EaisName

string

No

The name of the EAIS instance. The name must be 2 to 128 characters in length and can contain letters and Chinese characters. 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 (-).

test

Tag

array<object>

No

The list of tags, which can contain 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.

A655AB0E-31BB-45AD-9255-FCE93F65****

ElasticAcceleratedInstanceId

string

The EAIS instance ID.

eais-hz8t15a7gt7z7j7i****

Examples

Success response

JSON format

{
  "RequestId": "A655AB0E-31BB-45AD-9255-FCE93F65****",
  "ElasticAcceleratedInstanceId": "eais-hz8t15a7gt7z7j7i****"
}

Error codes

HTTP status code

Error code

Error message

Description

400 Timeout Operation timed out.
400 CheckTimeout Check timed out.
400 InconsistentSignature The signatures are inconsistent.
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.
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.