ec2.instances.start-sessionOpen a terminal on the instance (Deutsche Cloud Connect, no inbound port)
Answers a single-use `ticket` valid 60 s and `websocketUrl`. Open the WebSocket with the subprotocols `ews.terminal` and `ews.ticket.<ticket>`; binary frames are the terminal’s bytes, text frames `{"type":"resize","cols":…,"rows":…}`. `dcloud ec2 instances connect <id>` does this for you.
Request syntax
POST /ec2/api/instances/{id}/sessions
{
"loginUser": "string"
}Path parameters
idRequiredstring
Constraints: /^i-[0-9a-f]{6,32}$/
Request body
loginUserOptionalstring
Log in as root (the default) or the image’s default user
Constraints: /^[a-z_][a-z0-9_-]{0,31}$/
Response
201: `data` holds `ticket`, `expiresAt`, `websocketUrl` and `session`: the session record (id, instanceId, iamUsername, loginUser, status, createdAt).
A JSON response is wrapped as { "success": true, "data": … }; the CLI prints the whole body with --json.
Errors
- 400The request does not pass the schema above. The body is { "error": …, "issues": […] }, one issue per field.
- 401No credentials, or an access key that is unknown, revoked or expired.
- 403The caller's policies do not allow ec2:StartSession on this resource. The body names the action and the resource, and the refusal is recorded in the audit log.
- 404The resource does not exist in your organization.
Examples
The required parameters only, with example values. Replace id and the other placeholders with your own.
dcloud ec2 instances start-session idcurl -X POST "https://console.platform-development.deutschecloud.app/ec2/api/instances/id/sessions" \
-H "Authorization: EWS-ACCESS-KEY $ACCESS_KEY" \
-H "Content-Type: application/json" \
-d '{}'Generated from the API description, the same one the API checks requests against and the CLI is built from. MCP tool: dcloud_ec2_instances_start-session.