API 文档

环境

最近更新时间:2020-10-28 17:26:03

环境总览包括环境列表、当前环境的资源概况、网站托管资源概况、Serverless 云应用资源概况及各类云资源的访问数据报表。帮助您了解各个环境的资源使用情况。

控制台入口

云开发控制台

环境总览

环境列表

环境总览页面顶部提供【环境列表】入口,列表显示当前账户在云开发内的全部环境。

  • 单击【环境名称 | 环境 ID】可以切换环境。
  • 单击【创建环境】进入创建环境流程,等待环境初始化成功后,当前列表内会出现新建的环境。
  • 单击或【查看全部环境】,进入环境首页。

资源概况

资源概况包括文件存储资源、数据库存储资源和云函数存储资源。

  1. 资源概况左上方显示环境 ID,单击右边图标,【复制】环境 ID。
  2. 资源概况右上方显示资源周期(仅限包年包月计费环境)。
  3. 针对不同类型的环境,使用资源时有不同的统计方式:
    • 包年包月:统计资源使用量,有配额限制,根据使用需要提升配额。
    • 按量计费:统计资源使用量,无配额限制,根据使用需要可购买资源包配套使用。
      说明:

      详情请参见 产品定价

网站托管资源概况

静态网页托管服务开通后,您可查看静态托管以用存储容量和今日访问流量。

静态网站托管为按量计费产品,仅支持按量计费环境开通。如需了解更多静态网站托管内容,详情请参见 静态网站托管

Serverless 云应用资源情况

Serverless 云应用创建服务后,您可查看 CPU 用量、内存用量和构建时长。

资源报表

资源报表将各类资源的使用变化情况进行分类汇总,您可以选择某个时段内的资源使用情况进行查看,也可单击选择想要查看的资源,并导出报表。

资源类别包括:

  • 数据库:可查看全部/单个集合的请求次数(100ms以上、50ms - 100ms、10ms - 50ms)、数据库读取/写入次数。
  • 云存储:可查看存储下载/上传次数、存储 CDN 回源流量及 CDN 流量。
  • 云函数:可查看全部/单个函数的云函数调用次数调用次数、云函数资源用量、云函数流量、云函数错误次数及云函数运行时间。
  • 静态网站托管:可查看流量。
  • Serverless 云应用:可查看 CPU 使用量和内存使用量。

资源购买

资源购买包括环境基本配置和购买资源。针对不同计费模式的环境,资源购买方式不同。

  • 包年包月的付费方式为预付费模式,在满足套餐变更限制时,支持资源配置调整。包年包月计费模式有免费版套餐供用户使用。
  • 按量计费的付费方式为后付费模式,可配合资源包结算,按量使用,无需手动调整配置。

基本配置

基本配置中可修改环境名称、修改环境计费模式等。

  • 包年包月环境:
    • 支持环境名称更改。
    • 支持计费模式修改,其中计费模式修改仅限包年包月切换为按量计费。
    • 单击下拉套餐版本【基础版2】,可查看当前套餐详情。
  • 按量计费环境:基本配置仅支持环境名称修改。

购买资源

资源的购买方式会根据环境类型有所不同。

  • 包年包月环境:支持续费和更换套餐两种方式。
    • 如果您无需升级或降级套餐版本,单击【续费】即可继续购买套餐;
    • 如果您需要更换套餐版本,选择套餐后系统会自动进行计算支付或退回金额,您可在单击【购买】后,查看订单详情;
  • 按量计费环境:支持购买资源包。详情请参见 购买资源包

登录授权

云开发提供多种登录鉴权功能,您可以为自己的应用关联多种登录方式。在登录授权列表中,您可以选择启用您需要的登录方式,并对登录方式进行配置。

云开发提供跨平台的登录鉴权功能,您可以基于此为自己的应用构建用户体系,包括但不限于:

  • 为用户分配全局唯一的身份标识 UID;
  • 储存和管理用户个人信息;
  • 关联多种登录方式;
  • 管理用户对数据、资源的访问权限;
  • 用户行为的收集和分析。

同时,登录鉴权还是保护您的服务资源的重要手段,云开发对用户端发来的每一个请求,都会进行身份和权限的检查,避免您的资源被恶意攻击者消耗或者盗用。

详情请参见 登录授权

登录授权管理

  • 单击启用状态列内【开关】对登录方式进行开启。
  • 单击下拉登录方式,可查看使用该登录方式的教程。
  • 如有需要,可在【操作】列内对登录方式进行【编辑】与配置。

安全配置

安全来源

安全配置包括 Web 安全域名和移动应用安全来源,通过配置 Web 端和终端应用(小程序、APP 等)白名单,才能使用云开发的身份验证服务。

Web 安全域名

单击【添加域名】增加安全域名,并填写域名信息。云开发会校验网页应用请求来的来源域名,在添加安全域名之后,才可使用云开发服务。

说明:

云开发会为您自动生成4类默认安全域名(静态网站托管服务开通后会再新增一个安全域名):

  • 本地安全域名方便开发者进行本地调试。
  • env-id.service.tcloudbase.comHTTP 访问服务域名。
  • XX-env-id-XXXX.tcb.qcloud.la文件存储域名。
  • 如果您开通了静态网站托管服务,云开发会为您添加env-id-XXXX.tcloudbaseapp.com域名。

移动应用安全来源

如需在终端应用(例如 App、小程序等)中使用云开发的身份验证服务,您需要将授权的应用加入白名单,并在 SDK 使用时传入分配的凭证信息。

  • 单击【添加应用】增加应用信息,填写应用标识。
  • 添加完成后,单击【获取凭证】,复制私钥信息,并在使用 SDK 时传入分配的凭证信息。

额度监控

包年包月的环境,如果资源使用超过套餐限制将直接冻结资源,无法再进行调用。按量计费的环境,则无套餐的概念。

开发者可以使用额度监控的能力,对资源的计费指标配置日限额,用量达到80%、90%、100%时都将下发消息告警。用户收到消息后,可前往控制台查看用量,并对资源执行冻结操作,资源被冻结后,将无法再被使用。
配额监控

当前支持如下指标:

注意:

用量数据采集与告警会有一定的延迟,请及时关注告警。

资源 指标 日限额单位
CDN 流量 GB
云函数 资源使用量 GBs
静态网站托管 流量 GB
数据库 读次数 万次
数据库 写次数 万次

HTTP 访问服务

HTTP 访问服务包括域名管理和 HTTP 触发管理。HTTP 访问服务是云开发平台提供的资源访问服务:

  • 开发者通过 HTTP 访问服务服务可轻松使用标准的 HTTP 协议访问环境内全部资源;
  • 开发者无需使用 SDK 接入即可访问后端云资源。

如需了解更多,详情请参见 HTTP 访问服务

域名管理

域名管理包括设置安全域名和添加自定义域名。

  • 单击【点击设置】将链接到 安全配置 页面中。云开发会校验网页应用请求的来源域名,您可根据需要添加安全域名。
  • 单击【添加域名】绑定自定义域名。添加自定义域名前需完成备案,并且完成 CNAME 解析配置。当您完成绑定 HTTPS 自定义域名后,默认域名 HTTPS 将无法访问。

HTTP 触发

  • 单击【新建】设置 HTTP 触发路径,将特定路径与云函数进行绑定,通过访问触发路径来触发函数运行。
  • 单击触发路径内的路径,可跳转至触发路径,并调用该云函数。
  • 单击【启用鉴权】,开启用户访问鉴权验证功能。
目录