扩展后端
ddClient.extension.vm 对象可用于与扩展元数据的
虚拟机(vm)部分中定义的后端进行通信。
get
▸ 获取(url): Promise<unknown>
对后端服务执行 HTTP GET 请求。
ddClient.extension.vm.service
.get("/some/service")
.then((value: any) => console.log(value)请参阅 服务 API 参考文档,了解其他方法,例如 POST、UPDATE 和 DELETE。
已弃用的扩展后端通信
使用
window.ddClient.backend的以下方法已被弃用,并将在未来版本中移除。请使用上面指定的方法。
window.ddClient.backend 对象可用于与扩展元数据中 虚拟机部分 定义的后端进行通信。客户端已连接至该后端。
示例用法:
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);
},
},
});有关更多详细信息,请参阅 扩展虚拟机 API 参考
已弃用的扩展后端命令执行
此方法已弃用,并将在未来版本中移除。请使用上述指定的方法。
如果您的扩展程序附带了应在后端容器内运行的额外Binaries,您可以使用 execInVMExtension 函数:
const output = await window.ddClient.backend.execInVMExtension(
`cliShippedInTheVm xxx`
);
console.log(output);在主机上调用扩展Binaries
您可以运行在扩展元数据的 主机部分 中定义的Binaries。
例如,在宿主机上执行随附的Binaries kubectl -h 命令:
await ddClient.extension.host.cli.exec("kubectl", ["-h"]);只要 kubectl Binaries随您的扩展一起提供,您就可以在主机中启动 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 参考
扩展Binaries的调用已弃用
此方法已弃用,将在未来版本中移除。请使用上述指定的方法。
在主机中执行命令:
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(),并解析结果,以便在需要时将参数传递给下一个命令。