Skip to main content

getServices()

EXPERIMENTAL

Cloud Run 处于 Alpha 阶段，这意味着 API 可能会在任何版本中更改，文档尚未完成。请查看 更改日志 以了解最新的重大更改。

检索部署到 GCP Cloud Run 的 Remotion 服务列表。

参数 compatibleOnly 决定是否仅返回与安装的 Remotion Cloud Run 版本兼容的服务。

note

Cloud Run 服务是有版本的，服务的版本必须与 @remotion/cloudrun 包的版本匹配。因此，如果您升级 Remotion，您应该部署一个新服务，否则您可能会从此函数中获得一个空数组。

要仅获取有关单个服务的信息，请使用 getServiceInfo()。

如果您确定服务存在，还可以使用 speculateServiceName() 猜测其名称，并保存一次对 Cloud Run 的 API 调用。

示例​

ts
import { getServices } from "@remotion/cloudrun/client";
 
const info = await getServices({
  region: "us-east1",
  compatibleOnly: true,
});
 
for (const service of info) {
  console.log(service.serviceName); // "remotion--3-3-82--mem512mi--cpu1-0"
  console.log(service.timeoutInSeconds); // 300
  console.log(service.memoryLimit); // 512Mi
  console.log(service.cpuLimit); // 1.0
  console.log(service.remotionVersion); // "4.0.1"
  console.log(service.uri); // "https://remotion--3-3-82--mem512mi--cpu1-0--t-300-1a2b3c4d5e-ue.a.run.app"
  console.log(service.region); // "us-east1"
  console.log(service.consoleUrl); // "https://console.cloud.google.com/run/detail/us-east1/remotion--3-3-82--mem512mi--cpu1-0--t-300/logs"
}
ts
import { getServices } from "@remotion/cloudrun/client";
 
const info = await getServices({
  region: "us-east1",
  compatibleOnly: true,
});
 
for (const service of info) {
  console.log(service.serviceName); // "remotion--3-3-82--mem512mi--cpu1-0"
  console.log(service.timeoutInSeconds); // 300
  console.log(service.memoryLimit); // 512Mi
  console.log(service.cpuLimit); // 1.0
  console.log(service.remotionVersion); // "4.0.1"
  console.log(service.uri); // "https://remotion--3-3-82--mem512mi--cpu1-0--t-300-1a2b3c4d5e-ue.a.run.app"
  console.log(service.region); // "us-east1"
  console.log(service.consoleUrl); // "https://console.cloud.google.com/run/detail/us-east1/remotion--3-3-82--mem512mi--cpu1-0--t-300/logs"
}
note

从 @remotion/cloudrun/client 导入，以避免导入整个渲染器，因为它无法捆绑。

参数​

包含以下属性的对象：

region​

您想要查询的 GCP 区域。

ts
import { getServices } from "@remotion/cloudrun";
 
const info = await getServices({
  region: "us-west1",
  compatibleOnly: true,
});
 
for (const service of info) {
  console.log(service.serviceName); // "remotion--3-3-82--mem2gi--cpu2--t-1100"
  console.log(service.timeoutInSeconds); // 1100
  console.log(service.memoryLimit); // 2Gi
  console.log(service.cpuLimit); // 2
  console.log(service.remotionVersion); // "3.3.82"
  console.log(service.uri); // "https://remotion--3-3-82--mem2gi--cpu2--t-1100-1a2b3c4d5e-uw.a.run.app"
  console.log(service.region); // "us-west1"
  console.log(service.consoleUrl); // "https://console.cloud.google.com/run/detail/us-west1/remotion--3-3-82--mem2gi--cpu2--t-1100/logs"
}
ts
import { getServices } from "@remotion/cloudrun";
 
const info = await getServices({
  region: "us-west1",
  compatibleOnly: true,
});
 
for (const service of info) {
  console.log(service.serviceName); // "remotion--3-3-82--mem2gi--cpu2--t-1100"
  console.log(service.timeoutInSeconds); // 1100
  console.log(service.memoryLimit); // 2Gi
  console.log(service.cpuLimit); // 2
  console.log(service.remotionVersion); // "3.3.82"
  console.log(service.uri); // "https://remotion--3-3-82--mem2gi--cpu2--t-1100-1a2b3c4d5e-uw.a.run.app"
  console.log(service.region); // "us-west1"
  console.log(service.consoleUrl); // "https://console.cloud.google.com/run/detail/us-west1/remotion--3-3-82--mem2gi--cpu2--t-1100/logs"
}

compatibleOnly​

如果为 true，则仅返回与当前 Remotion Cloud Run 包版本匹配的服务。如果为 false，则返回所有 Remotion 服务。

返回值​

一个解析为具有以下属性的 对象数组 的 Promise：

serviceName​

服务的名称。

memoryLimit​

Cloud Run 服务可以消耗的 RAM 量的上限。

cpuLimit​

Cloud Run 服务用于处理请求的 CPU 核心的最大数量。

remotionVersion​

服务的 Remotion 版本。Remotion 正在为 Cloud Run 服务进行版本控制，只能从与服务版本匹配的 @remotion/cloudrun 版本触发渲染。

timeoutInSeconds​

已分配给 Cloud Run 服务的超时时间。

uri​

服务的端点。

region​

部署服务的区域。如果将 '所有区域' 传递给区域输入，则此项很有用。

consoleUrl​

指向此服务的 GCP 控制台页面的链接。具体来说，是指向日志显示的链接。

参见​