AWaws-samples
Target Nodes

Create a new target node session for CAE simulations

Changed on

Creates a new target node session with specified configuration including instance type, software stack, and networking parameters

post/api/target_nodes/create

Request

  • The document declares no server URL.
  • Auth
    socaAuth (a scheme the document does not define) and socaToken (a scheme the document does not define)

Headers

X-EDH-USERstring required

SOCA username for authentication

X-EDH-TOKENstring required

Authentication token for the SOCA user

Request body application/x-www-form-urlencoded

instance_typestring required

AWS EC2 instance type for the target node

session_namestring required

Name for the target node session (max 32 chars, alphanumeric and hyphens only)

software_stack_idstring required

ID of the software stack to use

projectstring required

Project name for the target node session

disk_sizestring

Root disk size in GB

subnet_idstring

AWS subnet ID (random private subnet used if not specified)

tenancy'default' | 'dedicated' | 'host'

EC2 tenancy type

nested_virtualization'true' | 'false'

Enable nested virtualization on the instance (requires EnableNestedVirtualization feature flag)

Example request

{
  "instance_type": "m5.large",
  "session_name": "my-simulation-session",
  "software_stack_id": "123",
  "project": "default",
  "disk_size": "100",
  "subnet_id": "subnet-12345678",
  "tenancy": "default",
  "nested_virtualization": "false"
}

Response

Target node session created successfully

successboolean
messagestring

Example response

{
  "success": true,
  "message": "Session my-simulation-session started successfully."
}

Changes

  • v1058396b8f0f1Revision changes
    • info

      the endpoint scheme security socaAuth AND socaToken was added to the API

    • info

      the endpoint scheme security edhAuth AND edhToken was removed from the API

    • info

      added the new optional request property

  • v16db97cead8dfRevision changes
    • info

      the endpoint scheme security edhAuth AND edhToken was added to the API

    • info

      the endpoint scheme security socaAuth AND socaToken was removed from the API