使用前必读

概述

欢迎使用智能设施云平台，智能设施云平台以aPaaS模式构筑设施核心能力，对客户应用提供API、数据开放能力，实现客户应用新业务快速上线。

您可以使用本文档提供的API对智能设施云平台核心数据进行相关操作，如创建、删除、查看等。

调用说明

智能设施云平台应用侧（又名“北向”）提供了REST（Representational State Transfer）风格API，支持您通过HTTPS请求调用，调用方法请参见如何调用API。

终端节点

终端节点即调用API的请求地址，不同实例的终端节点不同，您可以从智能设施云平台界面的实例信息中查询服务的终端节点。

图1 查看实例信息获取应用接入地址作为应用终端节点

约束与限制

• 您能创建的资源的数量与配额有关系。
• 更详细的限制请参见具体API的说明。

基本概念

• 用户

  在智能设施云平台中创建的用户，是智能设施云平台平台的使用人员，具有身份凭证（密码）。

  通常在调用API的鉴权过程中，您需要用到账号、用户和密码等信息。

• 实例

  客户开通智能设施云平台后，对应开通一个实例。智能设施云平台核心资源（包括用户）存储都在实例下，不同实例的资源相互独立，不支持跨实例类型的资源。在API中不同实例对应的实例ID不同，登录设施云前端成功后，鼠标放在右上角的用户名后，单击“查看实例信息”就可以获取到当前用户的实例ID，实例ID对应的就是API接口中请求头的X-Instance-Id这个字段（通常不同的交付局点对应这个实例ID不同），如下图所示：

  图2 查看实例信息
  
• 项目

  设施云针对不同的项目做了二级资源隔离（比如在不同项目下创建的设备只能在该项目中查看对应项目的设备）。在设施云前端登录成功后，可以在“系统管理-》项目管理”菜单下查看当前用户的所有项目，如下图所示：

  图3 查看项目列表
  

  单击对应项目详情就可以查看对应项目的项目ID，项目ID对应的就是API接口中请求头的X-Root-Zone-Id这个字段。也可以通过查看API文档中项目管理下的查询项目列表接口获取对应项目ID。

  图4 查看项目ID