Agent 管理

Agent 支持两种底层部署类型：

• SCF（云函数）：轻量级、按需计费，适合低并发场景
• TCBR（云托管）：容器化，适合高并发或需要自定义运行环境的场景

创建 Agent​

1. 接口描述​

接口功能：在当前环境下创建一个基于 SCF（云函数）的 Agent

接口声明：app.agent.createAgent(params): Promise<ICreateAgentResponse>

2. 输入参数​

RuntimeVersion 枚举

完整的运行环境说明，请参阅 运行环境支持。

ISessionConfig

3. 返回结果​

4. 示例代码​

import CloudBase from "@cloudbase/manager-node";

const app = CloudBase.init({
  secretId: "Your SecretId",
  secretKey: "Your SecretKey",
  envId: "Your envId",
});

async function main() {
  // 方式一：通过本地代码目录创建
  const res = await app.agent.createAgent({
    Name: "my-agent",
    Runtime: "Nodejs18.15",
    cwd: "/path/to/agent/code",
    InstallDependency: true,
    envVariables: {
      OPENAI_API_KEY: "sk-xxx",
    },
  });
  console.log("Agent ID:", res.AgentId);
}

main();

查询 Agent 列表​

1. 接口描述​

接口功能：查询当前环境下的 Agent 列表

接口声明：app.agent.describeAgentList(params?): Promise<IDescribeAgentListResponse>

2. 输入参数​

3. 返回结果​

IAgentInfo

4. 示例代码​

async function main() {
  const { AgentList, Total } = await app.agent.describeAgentList({
    PageSize: 10,
  });
  console.log(`共 ${Total} 个 Agent`);
  AgentList.forEach((a) => console.log(a.AgentId, a.Name, a.AgentType));
}

查询 Agent 详情​

1. 接口描述​

接口功能：查询单个 Agent 详情，并检查底层资源（云函数 / 云托管）是否就绪可用

接口声明：app.agent.describeAgent(agentId): Promise<IDescribeAgentResponse>

2. 输入参数​

3. 返回结果​

4. 示例代码​

async function main() {
  const detail = await app.agent.describeAgent("agent-xxx");
  if (detail.IsReady) {
    console.log("Agent 已就绪");
  } else {
    console.log("不可用原因:", detail.NotReadyReason);
  }
}

更新 Agent​

1. 接口描述​

接口功能：更新 Agent 的代码或配置，自动根据 Agent 类型（SCF / TCBR）调用对应逻辑

接口声明：app.agent.updateAgent(params): Promise<IUpdateScfAgentResponse>

2. 输入参数​

3. 返回结果​

4. 示例代码​

async function main() {
  const res = await app.agent.updateAgent({
    AgentId: "agent-xxx",
    cwd: "/path/to/new/code",
    envVariables: { API_KEY: "new-key" },
  });
  console.log(`更新完成，耗时 ${res.elapsedTime}ms`);
}

删除 Agent​

1. 接口描述​

接口功能：删除指定 Agent，同时尝试删除底层云函数或云托管资源

接口声明：app.agent.deleteAgent(params): Promise<IDeleteAgentResponse>

2. 输入参数​

3. 返回结果​

ResourceResult

4. 示例代码​

async function main() {
  const res = await app.agent.deleteAgent({ AgentId: "agent-xxx" });
  if (res.AgentDeleted) {
    if (res.ResourceResult?.Deleted) {
      console.log("Agent 及底层资源均已删除");
    } else {
      console.warn(
        "Agent 已删除，但底层资源删除失败:",
        res.ResourceResult?.CleanupHint,
      );
    }
  }
}

获取 Agent 日志​

1. 接口描述​

接口功能：获取 Agent 运行日志。底层统一走 CLS searchClsLog（getFunctionLogs 系列已下线）。

接口声明：app.agent.getAgentLogs(params): Promise<ISearchClsLogResponse>

2. 输入参数​

3. 示例代码​

async function main() {
  const logs = await app.agent.getAgentLogs({
    AgentId: "agent-xxx",
    limit: 20,
    startTime: "2025-01-01 00:00:00",
    endTime: "2025-01-01 23:59:59",
  });
  console.log(JSON.stringify(logs, null, 2));
}