应用部署

CloudAppService 提供 Web 应用的部署管理能力，通过 app.cloudAppService 访问。

createApp​

1. 接口描述​

接口功能：创建或更新 CloudApp 应用（首次调用创建，同名应用再次调用触发更新部署）

接口声明：app.cloudAppService.createApp(params): Promise<ICreateCloudAppResult>

2. 输入参数​

IStaticConfig​

IStaticCmd​

3. 返回结果​

describeAppList​

1. 接口描述​

接口功能：查询 CloudApp 应用列表

接口声明：app.cloudAppService.describeAppList(params): Promise<IDescribeCloudAppListResult>

2. 输入参数​

3. 返回结果​

CloudAppServiceItem​

describeAppInfo​

1. 接口描述​

接口功能：查询单个 CloudApp 应用详情

接口声明：app.cloudAppService.describeAppInfo(params): Promise<IDescribeCloudAppInfoResult>

2. 输入参数​

3. 返回结果​

deleteApp​

1. 接口描述​

接口功能：删除 CloudApp 应用（包括全部历史版本）

接口声明：app.cloudAppService.deleteApp(params): Promise<IDeleteCloudAppResult>

2. 输入参数​

3. 返回结果​

describeAppVersion​

1. 接口描述​

接口功能：查询应用指定版本详情（包含构建状态）

接口声明：app.cloudAppService.describeAppVersion(params): Promise<IDescribeCloudAppVersionResult>

2. 输入参数​

3. 返回结果​

describeAppVersionList​

1. 接口描述​

接口功能：查询应用的版本列表

接口声明：app.cloudAppService.describeAppVersionList(params): Promise<IDescribeCloudAppVersionListResult>

2. 输入参数​

3. 返回结果​

deleteAppVersion​

1. 接口描述​

接口功能：删除应用的指定历史版本

接口声明：app.cloudAppService.deleteAppVersion(params): Promise<Object>

2. 输入参数​

代码上传​

uploadCode​

1. 接口描述​

接口功能：将本地代码压缩后上传到 COS，用于后续 createApp 部署。

接口声明：app.cloudAppService.uploadCode(params): Promise<IUploadCloudAppCodeResult>

2. 输入参数​

3. 返回结果​

完整使用示例​

import CloudBase from '@cloudbase/manager-node'
import path from 'path'

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

async function deployApp() {
  const serviceName = 'my-react-app'

  // 1. 上传代码
  console.log('上传代码...')
  const { cosTimestamp } = await app.cloudAppService.uploadCode({
    serviceName,
    filePath: path.resolve('./my-react-app'),
    ignore: ['**/node_modules/**', '**/.git/**']
  })

  // 2. 创建/更新应用
  console.log('触发部署...')
  const { BuildId } = await app.cloudAppService.createApp({
    deployType: 'static-hosting',
    serviceName,
    buildType: 'ZIP',
    staticConfig: {
      framework: 'react',
      cosTimestamp,
      appPath: `/${serviceName}`,
      buildPath: 'build',
      staticCmd: {
        buildCmd: 'npm run build',
        installCmd: 'npm install'
      }
    }
  })

  // 3. 轮询构建状态
  console.log('等待构建完成，BuildId:', BuildId)
  let status = 'BUILDING'
  while (status === 'BUILDING' || status === 'PENDING') {
    await new Promise(r => setTimeout(r, 5000))
    const version = await app.cloudAppService.describeAppVersion({
      deployType: 'static-hosting',
      serviceName,
      buildId: BuildId
    })
    status = version.Status
    console.log('构建状态：', status)
  }

  if (status === 'SUCCESS') {
    const info = await app.cloudAppService.describeAppInfo({
      deployType: 'static-hosting',
      serviceName
    })
    console.log('部署成功！访问地址：', info.Domain)
  } else {
    console.error('部署失败')
  }
}

deployApp()