调用GetWebTerminal获取进入容器的链接_人工智能平台 PAI(PAI)-阿里云帮助中心

提供获取容器访问HTTP链接的方法和步骤。

调试

您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：

操作：是指具体的权限点。
访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用背景高亮的方式表示。
- 对于不支持资源级授权的操作，用全部资源表示。
条件关键字：是指云产品自身定义的条件关键字。
关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

操作	访问级别	资源类型	条件关键字	关联操作
paidlc:GetWebTerminal	get	全部资源 ``	无	无

请求语法

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

请求参数

名称	类型	必填	描述	示例值
JobId	string	否	任务 ID。	dlc-20210126170216-******
PodId	string	否	任务 Pod ID。	dlc-20210126170216-****-chief-0
PodUid	string	否	Pod UID。	94a7cc7c-0033-48b5-85bd-71c63592c268
IsShared	boolean	否	是否创建用于分享的进入容器链接，取值如下： true：返回进入容器的分享链接。该链接将在三十秒后失效，且仅能被使用一次。一旦通过该链接进入容器后，其他使用该链接进入容器的请求将无效。 false：返回普通的进入容器的分享链接，使用时需进行阿里云身份认证。该链接将在三十秒后失效。	true

返回参数

名称类型描述示例值

名称	类型	描述	示例值
	object	返回结果。
RequestId	string	此次调用的请求 ID，用于诊断和答疑。	473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E
WebTerminalUrl	string	进入容器的 WebSocket 链接。您需构建 WebSocket 客户端，详细通信格式请参考如下代码： 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'); }; // 收到后端返回 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); } }; // 控制台输入 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(); };	wss://*****

object

返回结果。

RequestId

string

此次调用的请求 ID，用于诊断和答疑。

473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E

WebTerminalUrl

string

进入容器的 WebSocket 链接。您需构建 WebSocket 客户端，详细通信格式请参考如下代码：

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');
};

// 收到后端返回
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);
  }
};

// 控制台输入
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();
};

wss://*****

示例

正常返回示例

JSON格式

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

错误码

访问错误中心查看更多错误码。

变更历史

变更时间	变更内容概要	操作
2023-11-07	OpenAPI 入参发生变更	查看变更详情
2023-07-21	OpenAPI 返回结构发生变更	查看变更详情