Windows Azure Pack 网站服务 REST API

 

适用于:Windows Azure Pack

本文档介绍如何使用 Windows Azure Pack 网站管理 REST API 在网站中执行常见任务。

概述

Windows Azure Pack 网站管理 API 提供了一组 RESTful Web 服务,这些服务与 Windows Azure Pack 网站服务交互以管理网站。 API 包含捕获最终用户与 Windows Azure Pack 网站服务之间的关系的实体。

网站管理 API 支持一组核心网站管理方案:

  • 创建、删除和配置网站。

  • 查询网站的状态。

  • 查询度量(如资源使用情况、配额和限制)。

  • 检索元数据,例如发布配置文件。

  • 配置网站规模。

最终用户

Windows Azure Pack 网站管理 REST API 有两个主要类别的最终用户:

  • 网站管理员在 Windows Azure Pack 网站中创建和管理网站和管理补充资源。 此角色对应于 azure Pack 订阅的管理员或共同管理员Windows。

  • Publisher访问网站的内容,并使用 FTP 或 WebDeploy 等协议发布内容。 从宿主提供程序的角度来说,发布者是 FTP 用户。 发布者无法对站点执行管理操作。

资源

Windows Azure 网站 REST API 公开资源的以下层次结构以便管理您的服务和部署:

/subscriptions

   /WebSpaces

      /sites

         /config

         /publishxml

         /usages

         /metrics

         /repository

   /ServerFarm

下表描述了上述资源。

资源

说明

订阅

Windows Azure Pack 订阅,需要使用 Windows Azure 网站。

Webspaces

一个逻辑实体的 Web 空间,它与给定地理区域中的用户订阅相关联。 给定地区中的所有站点都是给定 Web 空间的关联站点。

站点

一个网站,它是由 azure 网站服务Windows提供的核心资源实体。

Config

包含站点配置属性的资源,如 AppSettingsConnectionStringsErrorLoggingFrameworkVersions

Publishxml

XML 格式的文件,其中包含用于将 Web 应用程序发布到 Azure 网站Windows的用户设置。 可以将此文件导入到 Microsoft Visual Studio 或 Web 矩阵中并使用。

用途

包含有关当前网站使用情况的信息的资源。

指标

一个资源,其中包含有关使用情况的报表中的历史信息。

存储库

与站点关联的源代码管理存储库。

Serverfarm

为给定区域中特定租户托管站点而保留的一组计算机。 目前,每个数据中心仅支持一个服务器场。

针对资源的操作

创建资源

使用 HTTP POST 谓词创建新资源。 资源名称在请求正文中传递。 如果成功创建资源,将返回 HTTP 201 状态代码,并且序列化的资源对象包含在响应正文中。 如果客户端尝试创建已存在的资源,将返回 HTTP 409 冲突状态代码。

读取资源

若要读取某一现有资源的当前状态,请使用 HTTP GET 谓词。 如果资源存在,则响应状态代码为 200,响应正文包含序列化对象。 如果资源不存在,则响应状态代码为 404,则找不到资源。

更新资源

使用 HTTP PUT 谓词更新现有资源。 在 URL 字符串中传入对象的名称,在请求正文中传入对象的新状态。 如果资源已成功更新,将返回 HTTP 200 状态代码。 如果要更新的资源不存在,则返回 HTTP 404(未找到)状态代码。

删除资源

使用 HTTP DELETE 谓词删除现有资源。 对象名称传入 URL 字符串中。 如果资源删除成功,将返回 HTTP 200 状态代码。 如果对象已删除或不存在,则返回 HTTP 404。

API 版本控制

与 Windows Azure 服务一样,Windows Azure Pack 网站遵循Windows Azure REST API 版本控制。 Windows Azure Pack 网站 REST API 提供的操作具有多个版本。 必须通过设置 x-ms-version 请求标头来指定要使用的操作版本。 拒绝没有 x-ms-version 标头的请求,并返回 (400) 错误请求响应。 如果服务调用以前版本的操作和较新版本存在,可以选择继续调用以前的版本或继续修改代码以调用较新版本。

注意

尽管 API 版本可能会更改,但 azure Pack 网站Windows支持更新的 API 版本和紧随其前的版本。

x-ms-version 请求标头值必须采用 YYYY-MM-DD 格式指定。 代码示例显示所需的格式。

请求标头:

x-ms-version:2012-10-10

另请参阅

Windows Azure Pack 资源提供程序