关于 Cloudability API

在线编辑

关于 Cloudability API

Cloudability API 基于 REST 原则实施。 通过使用面向资源的 URL 和依赖现成的 HTTP 客户端一般都能理解的标准 HTTP 功能，你会发现界面是可预测的。 例如，应用程序接口依赖 HTTP basic auth 进行身份验证， HTTP verbs（方法，如 GET、PUT......） 和标准 HTTP 响应代码来表示 API 是否出错。 默认情况下，所有 API 响应都以 JSON 格式返回，但通过设置相关的 HTTP 媒体类型，也可使用 CSV 等其他格式。

视图和应用程序接口

Cloudability 采用 " 视图系统 "，在客户使用我们工具的各个方面时，为他们提供量身定制的体验。 我们的应用程序接口也采用了这一系统，其特点如下

  • 在进行 API 请求时，我们将自动尊重附加到用户的默认视图

  • 如果希望通过 API 请求切换到不同的视图，可以使用 viewId 查询参数来声明所需的视图。 示例?view_id=2970

  • 如果不想应用任何视图，即在所有数据中运行查询，则应用 viewId ，其值为零。 例如?view_id=0

  • 注意：受限用户只能应用其有权访问的视图。

特别说明

请注意，并非所有端点都能使用下面记录的排序和筛选功能。 如果您访问各个终端的文档，就会发现是否支持这一点。

对于每个 V3 端点，企业每分钟最多可发出 300 次请求。 当达到此速率限制时， V3 端点将进行节流并返回状态代码 429。

启用访问 Cloudability API

  1. 从 Cloudability 控制面板，选择 管理配置文件。

  2. 导航至 " 首选项 "选项卡
  3. 在 Cloudability API 部分，选择启用访问。 Cloudability 生成 API 密钥并显示在 API KEY 字段中。 如果先前已启用访问权限，请选择 " 重新生成密钥 "，以撤销先前的密钥并创建新密钥。