扩展后端
该ddClient.extension.vm
对象可用于与
扩展元数据的vm 部分中定义的后端进行通信。
得到
▸得到( url
): Promise
< unknown
>
向后端服务执行 HTTP GET 请求。
ddClient.extension.vm.service
.get("/some/service")
.then((value: any) => console.log(value)
有关其他方法(例如 POST、UPDATE 和 DELETE),请参阅 服务 API 参考。
已弃用的扩展后端通信
下面使用的方法
window.ddClient.backend
已被弃用,并将在未来版本中删除。使用上面指定的方法。
该window.ddClient.backend
对象可用于与
扩展元数据的vm 部分中定义的后端进行通信。客户端已经连接到后端。
用法示例:
window.ddClient.backend
.get("/some/service")
.then((value: any) => console.log(value));
window.ddClient.backend
.post("/some/service", { ... })
.then((value: any) => console.log(value));
window.ddClient.backend
.put("/some/service", { ... })
.then((value: any) => console.log(value));
window.ddClient.backend
.patch("/some/service", { ... })
.then((value: any) => console.log(value));
window.ddClient.backend
.delete("/some/service")
.then((value: any) => console.log(value));
window.ddClient.backend
.head("/some/service")
.then((value: any) => console.log(value));
window.ddClient.backend
.request({ url: "/url", method: "GET", headers: { 'header-key': 'header-value' }, data: { ... }})
.then((value: any) => console.log(value));
在扩展后端容器中运行命令
例如,ls -l
在后端容器内执行命令:
await ddClient.extension.vm.cli.exec("ls", ["-l"]);
流式传输在后端容器中执行的命令的输出。例如,ls -l
在后端容器内生成命令:
await ddClient.extension.vm.cli.exec("ls", ["-l"], {
stream: {
onOutput(data) {
if (data.stdout) {
console.error(data.stdout);
} else {
console.log(data.stderr);
}
},
onError(error) {
console.error(error);
},
onClose(exitCode) {
console.log("onClose with exit code " + exitCode);
},
},
});
有关更多详细信息,请参阅 扩展 VM API 参考
已弃用的扩展后端命令执行
此方法已弃用,并将在未来版本中删除。使用上面指定的方法。
如果您的扩展附带了应在后端容器内运行的其他二进制文件,您可以使用以下execInVMExtension
函数:
const output = await window.ddClient.backend.execInVMExtension(
`cliShippedInTheVm xxx`
);
console.log(output);
在主机上调用扩展二进制文件
您可以运行 扩展元数据的主机部分中定义的二进制文件。
例如,kubectl -h
在主机中执行附带的二进制命令:
await ddClient.extension.host.cli.exec("kubectl", ["-h"]);
只要kubectl
二进制文件作为扩展的一部分提供,您就可以kubectl -h
在主机中生成命令并获取输出流:
await ddClient.extension.host.cli.exec("kubectl", ["-h"], {
stream: {
onOutput(data: { stdout: string } | { stderr: string }): void {
if (data.stdout) {
console.error(data.stdout);
} else {
console.log(data.stderr);
}
},
onError(error: any): void {
console.error(error);
},
onClose(exitCode: number): void {
console.log("onClose with exit code " + exitCode);
},
},
});
您可以流式传输在后端容器或主机中执行的命令的输出。
有关更多详细信息,请参阅 扩展主机 API 参考
已弃用扩展二进制文件的调用
此方法已弃用,并将在未来版本中删除。使用上面指定的方法。
在主机中执行命令:
window.ddClient.execHostCmd(`cliShippedOnHost xxx`).then((cmdResult: any) => {
console.log(cmdResult);
});
要流式传输在后端容器或主机中执行的命令的输出:
window.ddClient.spawnHostCmd(
`cliShippedOnHost`,
[`arg1`, `arg2`],
(data: any, err: any) => {
console.log(data.stdout, data.stderr);
// Once the command exits we get the status code
if (data.code) {
console.log(data.code);
}
}
);
笔记
您不能使用它在单个
exec()
调用中链接命令(例如cmd1 $(cmd2)
或在命令之间使用管道)。您需要调用
exec()
每个命令并解析结果,以便根据需要将参数传递给下一个命令。