跳到主要内容

运行环境与健康检查

平台在应用启动时注入当前 App、版本和环境信息。SDK 可以用统一方式读取这些值。

Node.js​

import { xdbPaaS } from "@xinduobang/xdb-paas-sdk/server";

const runtime = xdbPaaS.runtime.requireContext({database: true});

console.log(runtime.appId);
console.log(runtime.deploymentId);
console.log(runtime.environment);
console.log(runtime.port);
console.log(Boolean(runtime.databaseUrl)); // 只检查是否已绑定,不输出含密码的连接串

健康检查响应:

const payload = xdbPaaS.runtime.createHealthPayload({version: "1.0.0"});

Python​

from xdb_paas import xdb_paas

runtime = xdb_paas.runtime.require_context(database=True)
print(runtime.app_id, runtime.deployment_id, runtime.environment)

payload = xdb_paas.runtime.create_health_payload(version="1.0.0")

get 与 require 的区别​

  • getContext/get_context:本地开发时也可调用;未部署到平台时返回 hosted: false;
  • requireContext/require_context:要求当前进程必须运行在信多帮云应用中,否则抛出带错误码的异常;
  • database: true:额外要求当前 App 已绑定数据库。

平台变量​

平台会管理并只读注入:

  • XDB_PAAS_APP_ID;
  • XDB_PAAS_DEPLOYMENT_ID;
  • XDB_PAAS_ENVIRONMENT;
  • PORT;
  • 已开通时的 DATABASE_URL;
  • SDK 工作所需的身份、开放平台和 Storage 运行凭据。

应用不得自行覆盖、返回或记录这些内部变量。