Platform For AI:GetWebTerminal

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

• Operation: the value that you can use in the Action element to specify the operation on a resource.
• Access level: the access level of each operation. The levels are read, write, and list.
• Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
  • For mandatory resource types, indicate with a prefix of * .
  • If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
• Condition Key: the condition key that is defined by the cloud service.
• Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.

Request syntax

GET /api/v1/jobs/{JobId}/pods/{PodId}/webterminal HTTP/1.1

Request parameters

Response parameters

ws = new WebSocket(
  `wss://xxxxx`,
);
ws.onopen = function open() {
  console.warn('connected');
  term.write('\r');
};

ws.onclose = function close() {
  console.warn('disconnected');
  term.write('Connection closed');
};

// Return the following information in the backend.
ws.onmessage = function incoming(event) {
  const msg = JSON.parse(event.data);
  console.warn(msg);
  if (msg.operation === 'stdout') {
    term.write(msg.data);
  } else {
    console.warn('invalid msg operation: ' + msg);
  }
};

// Enter the following code in the console.
term.onData(data => {
  const msg = { operation: 'stdin', data: data };
  ws.send(JSON.stringify(msg));
});

term.onResize(size => {
  const msg = { operation: 'resize', cols: size.cols, rows: size.rows };
  ws.send(JSON.stringify(msg));
});

fitAddon.fit();
};

Examples

Sample success responses

JSONformat

{
  "RequestId": "473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E",
  "WebTerminalUrl": "wss://*****"
}

Error codes

For a list of error codes, visit the Service error codes.

Change history