StartEaiJupyter

Updated at:
Copy as MD

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

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

update

*Instance

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

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.

cn-hangzhou

InstanceId

string

Yes

The EAIS instance ID.

eais-hze3x2gv9wimdj0k****

Response elements

Element

Type

Description

Example

object

Schema of Response

RequestId

string

The request ID.

04DEB304-2436-4CB9-BB63-468BCEA0****

AccessDeniedDetail

object

The details of the access denial.

Note

This field is returned only when RAM authentication fails.

AuthAction

string

The action that requires authentication.

eais:StartEaiJupyter

AuthPrincipalDisplayName

string

The display name of the authorized principal.

20560152949032****

AuthPrincipalOwnerId

string

The owner ID of the authorized principal.

170718266783****

AuthPrincipalType

string

The type of the authorized principal.

Valid values:

  • SubUser :

    SubUser

  • AssumedRoleUser :

    AssumedRoleUser

SubUser

EncodedDiagnosticMessage

string

The encoded diagnostic message.

AQFmfh3BZn4dwUQyNzY4MDVELTgzQkUtNTBEOC04QjQyLTNGM0U1QUI5MjhBRA==

NoPermissionType

string

The no-permission type.

ExplicitDeny

PolicyType

string

The policy type.

AccountLevelIdentityBasedPolicy

Examples

Success response

JSON format

{
  "RequestId": "04DEB304-2436-4CB9-BB63-468BCEA0****",
  "AccessDeniedDetail": {
    "AuthAction": "eais:StartEaiJupyter",
    "AuthPrincipalDisplayName": "20560152949032****",
    "AuthPrincipalOwnerId": "170718266783****",
    "AuthPrincipalType": "SubUser",
    "EncodedDiagnosticMessage": "AQFmfh3BZn4dwUQyNzY4MDVELTgzQkUtNTBEOC04QjQyLTNGM0U1QUI5MjhBRA==",
    "NoPermissionType": "ExplicitDeny",
    "PolicyType": "AccountLevelIdentityBasedPolicy"
  }
}

Error codes

HTTP status code

Error code

Error message

Description

400 InvalidInstanceId The InstanceId is invalid.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.