扩展后端
ddClient.extension.vm 对象可用于与扩展元数据中定义的vm部分的后端进行通信。
get
▸ get(url): Promise<unknown>
向后台服务执行HTTP GET请求。
ddClient.extension.vm.service
.get("/some/service")
.then((value: any) => console.log(value)请参阅 Service API 参考 以了解其他方法,如 POST、UPDATE 和 DELETE。
已弃用的扩展后端通信
以下使用
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);
},
},
});更多详情,请参阅 Extension VM API 参考
已弃用的扩展后端命令执行
此方法已弃用,并将在未来的版本中移除。请使用上面指定的方法。
如果您的扩展附带了需要在后端容器内运行的额外二进制文件,您可以使用execInVMExtension函数:
const output = await window.ddClient.backend.execInVMExtension(
`cliShippedInTheVm xxx`
);
console.log(output);在主机上调用扩展二进制文件
你可以运行在扩展元数据的 host section 部分中定义的二进制文件。
例如,在主机中执行附带的二进制文件 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(),并在需要时解析结果以将参数传递给下一个命令。