Parallels Panel 配置指南 - Parent Directory

Parallels ® 

Panel 

开发人员指南 

配置指南

目录 

前言 4 

排版约定 ........................................................................................................................................ 4 

反馈 ............................................................................................................................................... 5 

关于此文件 6 

交付流程注意事项 8 

部署 Panel 9 

独立部署 ...................................................................................................................................... 10 

获取版本 ID ....................................................................................................................... 10 

获取产品组件列表 ............................................................................................................. 11 

安装 Panel ......................................................................................................................... 13 

安装程序 CLI 参考 ( 简化 ) .................................................................................................. 14 

安装脚本 (Linux/Unix) ....................................................................................................... 16 

在 Parallels Containers 环境中部署 ............................................................................................. 17 

Parallels Containers for Unix ............................................................................................. 18 

Parallels Containers for Windows ..................................................................................... 21 

使用 Rsync 实用程序设置镜像 ..................................................................................................... 22 

建立 Linux/Unix 分发包镜像 .............................................................................................. 23 

建立 Windows 分发包镜像 ................................................................................................. 26 

安装操作概要 28 

初始化 Panel ................................................................................................................................ 29 

安装许可证 ................................................................................................................................... 29 

定义 Panel 徽标 ........................................................................................................................... 30 

配置 DNS ..................................................................................................................................... 31 

更改 SOA 记录模板 ........................................................................................................... 31 

设置资源记录模板 ............................................................................................................. 32 

安装 SSL 证书 .............................................................................................................................. 32 

创建站点及子站点 ........................................................................................................................ 33 

安装应用程序 ............................................................................................................................... 34 

导入应用程序包 ................................................................................................................. 34 

安装应用程序 ..................................................................................................................... 35 

定义可用的 APS 目录 .................................................................................................................. 36 

APS 目录配置文件 ............................................................................................................. 37 

通过远程 API 设置 38

前言 3 

使用远程 API ............................................................................................................................... 39 

关于远程 API ..................................................................................................................... 39 

API RPC 数据包 ................................................................................................................ 40 

创建客户软件 ..................................................................................................................... 43 

设置 Panel ................................................................................................................................... 68 

初始化 Panel ..................................................................................................................... 68 

安装许可证 ........................................................................................................................ 71 

配置 DNS ........................................................................................................................... 77 

安装 SSL 证书 ................................................................................................................... 99 

创建站点 .......................................................................................................................... 105 

创建子站点 ...................................................................................................................... 110 

定义可用的 APS 目录 ...................................................................................................... 115 

安装应用程序 ................................................................................................................... 117 

通过 CLI 设置 160 

关于 Panel CLI ........................................................................................................................... 161 

设置 Panel ................................................................................................................................. 162 

初始化 Panel ................................................................................................................... 162 

安装许可证 ...................................................................................................................... 163 

定义 Panel 徽标 ............................................................................................................... 164 

配置 DNS ......................................................................................................................... 165 

安装 SSL 证书 ................................................................................................................. 170 

创建站点 .......................................................................................................................... 172 

创建子站点 ...................................................................................................................... 172 

定义可用的 APS 目录 ...................................................................................................... 174 

安装应用程序 ................................................................................................................... 175

4 前言 

前言 

排版约定 

在您开始使用本指南之前 , 了解其中使用的文档约定十分重要。 

正文中以下格式类型表示特定信息。 

格式约定信息类型示例 

特殊粗体 

您必须选择的项目 , 如菜单 

选项、命令按钮或列表中的 

项目。 

转到 “ 系统 ” 选项卡。 

章、节和小节的标题。请参阅 “ 基本管理 ” 一章。 

斜体 

用于强调某段文本的重要 

性 , 以介绍某个术语或指出 

将用真实名称或实际值来替 

代的命令行占位符。 

该系统支持通常所说的 “ 通配符 ” 搜 

索。 

等宽字体 

预定格式 

预定的粗体格式 

命令、文件和目录的名称。许可证文件位于 

http://docs/common/licen 

ses 目录。 

屏幕上显示的命令行会话中 

的计算机输出 ; 为 XML、 

C++ 或其他编程语言形式 

的源代码。 

当您键入时 , 与计算机屏幕 

输出对比。 

# ls –al /files 

total 14470 

# cd /root/rpms/php 

大写键盘上按键的名称。 SHIFT、CTRL、ALT 

KEY+KEY 

按键组合 , 用户必须按住一 

个按键然后再按下另一个按 

键。 

CTRL+P,ALT+F4

前言 5 

反馈 

如果您在本指南中发现错误 , 或您对提升本指南有任何建议或想法 , 请使用在线表单将反馈发 

送到 http://www.parallels.com/en/support/usersdoc/。请在您的报告中包含本指南的标题、章 

节和小节标题 , 以及您在其中发现错误的文本片断。

第 1 章 

关于此文件 

目的 

本文档旨在阐述如何配置 Parallels Small Business Panel ( 以下称 Panel), 协助 HSP ( 主 

机服务商 ) 公司向客户提供完整的主机解决方案。 

本文档面向需实施 Panel 配置的 HSP 开发人员 , 即自动化此软件的安装 / 部署 , 以及满足 

特定客户需求的配置。 

本文档包含最佳的建议 - 经过完全测试和保证 - 在产品交付范围内安装和配置 Panel 时。 

本文档不保证阐述 API 的所有功能 : 不会描述超出范围的操作和选项。 

范围 

现在的服务商可以从难管理的基础结构主机转向提供增值的管理服务。出售给客户的主机 

方案不仅包含物理或虚拟服务器环境 , 内含可选的控制面板安装 , 也包含域名和 SSL 证 

书。随着 SaaS 模式获得越来越多的客户认可 , 特别是小型企业 , 主机程序包也开始包含 

在客户站点上安装的预置应用程序。其中包括托管的服务 , 如邮件、协作工具和内容管理。 

对 Panel 安装来说 , 意味着安装后 , 服务商即可开始设置面板。特别是可以通过远程 API 

或 CLI 自定义下列设置 : 

• DNS 设置 

• 域名设置 

• SSL 证书交付 

• 安装 APS 应用程序 

为了协助服务商推介附加服务 ,Parallels 推出本文档阐述如何部署和配置 Panel, 以及如 

何集成到交付应用程序。 

概述 

章节 “ 交付流程注意事项 ” 概述整个交付流程涉及的重要事项。 

章节 “ 部署面板 ” 着重在 Panel 的交付阶段。内容涵盖 Parallels Containers 环境的安装与 

独立安装 , 也包括如何创建 Parallels Small Business Panel 分发库的自定义镜像。 

下面三章阐述 Panel 交付的安装阶段 : 

• 章节 “ 安装操作概要 ” 阐述安装操作的概念和卷。

关于此文件 7 

• 章节 “ 通过远程 API 设置 ” 阐述如何通过远程 XML API 安装 Panel。本章阐述远程 API: 

提供 API RPC 协议概要和用来通过协议与 Panel 服务器互动的工具示例 , 然后详细阐 

述第三方工具如何通过请求信息执行 Panel 安装操作 , 以及接收到的每个操作对应的 

相应信息。 

• 章节 “ 通过远程 CLI 设置 ” 阐述如何通过命令行界面安装 Panel。本章首先阐述 CLI 基本 

概念 , 然后详细阐述应执行哪些命令来安装 Panel。

第 2 章 

交付流程注意事项 

交付 Parallels Small Business Panel for Windows 时 , 包括产品部署和安装之间的五分 

钟间隔。需要此安装延迟是因为安装后脚本需要时间来注册和安装第三方组件。在此阶 

段执行的交付操作会失败。

第 3 章 

部署 Panel 

本章着重阐述 Parallels Small Business Panel 交付的部署阶段。 

内容涵盖 Parallels Containers 环境的安装与独立安装 , 也包括如何创建 Panel 分发库的 

自定义镜像。 

本章内容 : 

独立部署 ............................................................................................................ 10 

在 Parallels Containers 环境中部署 ................................................................... 17 

使用 Rsync 实用程序设置镜像 ........................................................................... 22

10 部署 Panel 

独立部署 

本章阐述如何在非 Parallels Containers 环境中自动部署 Panel,Linux/Unix 或 Windows。本章 

简要阐述 Panel 安装的基本步骤 , 并说明如何使用使用命令行界面安装产品。 

使用 Parallels 安装程序实用工具执行 Panel 独立部署。实用程序连接到 Parallels Small 

Business Panel 更新服务器 , 更新存放 Panel 程序包的服务器 , 检索所需程序包 , 并进行安装 

。 

Parallels 安装程序可在互动模式 ,( 通过 Web 图形用户界面或命令行 ), 或自动模式下运行 , 通 

过命令行运行需指定特定选项。自动模式下可使用 shell 脚本来自动化 Panel 的部署。 

提供多个版本的 Parallels 安装程序 , 各面向不同操作系统和平台 , 确定获取与您的主机操作系 

统兼容的 Parallels 安装程序。通常 ,Parallels 安装程序版本名使用下列格式 : 

parallels_installer_v_os__。 

注意 : 描述 Parallels 安装程序 CLI 时 , 假设 Parallels 安装程序名称是 

parallels_installer。 

官方 Parallels Small Business Panel 库是 autoinstall.plesk.com (Linux/Unix 程序包 ) 和 

autoinstall-win.parallels.com (Windows 程序包 )。您可能想要在主机环境中为 Panel 设置自定 

义镜像 ( 第 22 页 ), 确保安全安装。 

获取版本 ID 

版本 ID 是 Panel 版本的唯一标示符 , 如 Parallels Small Business Panel 10.0。 

若要获取版本 ID 列表 , 执行下列命令 : 

parallels_installer --show-all-releases 

在 Linux/Unix 服务器上 

parallels_installer.exe --show-all-releases 

在 Windows 服务器上 

即可显示产品版本列表。例如 : 

• PPSMBE_10_0_0 (Parallels Small Business Panel 10.0.0)


获取产品组件列表 

若要获取组件版本列表 , 执行格式如下的命令 : 

parallels_installer --select-release-id --show-components 

如 Parallels Small Business Panel 10: 

parallels_installer --select-release-id PPSMBE_10_0_0 --show-components 

在 Linux/Unix 服务器上 

parallels_installer.exe --select-release-id PPSMBE_10_0_0_WIN 

--show-components 

即会显示组件列表 , 组件名称在左侧 , 简短名称在右侧 , 如 : 

• 基本 [install] - Parallels Small Business Panel 基本程序包 

• autoinstaller [install] - Parallels 产品安装程序 

• postfix [install] - Postfix 邮件服务器 

• php5 [install] - PHP5 支持 

• postgresql [install] - PostgreSQL 支持 

• api [install] - Parallels Small Business Panel 基本程序包 

• siteeditor [install] - 站点编辑器 

• setemplates [install] - 站点编辑器模板 

• mod_python [install] - Apache mod_python 模块 

• ruby [install] - Ruby on Rails 支持 

• 防火墙 [install] - 防火墙加载项 

• vpn [install] - VPN 加载项 

• 文件服务器 [install] - Fileserver 加载项 

• watchdog [install] - 系统监控加载项 (Watchdog) 

• drweb [install] - Dr. Web 防病毒 

• spamassassin [install] - SpamAssassin 支持 

• 备份 [install] - 备份管理器 

• backup-vz [install] - 备份管理器 PVC 重装支持 

• de-DE-locale [install] - 德文语言包 

• ja-JP-locale [install] - 日文语言包 

• es-ES-locale [install] - 西班牙文语言包 

• ru-RU-locale [install] - 俄文语言包 

• fr-FR-locale [install] - 法文语言包 

• it-IT-locale [install] - 意文语言包 

• zh-CN-locale [install] - 简体中文语言包 

• zh-TW-locale [install] - 繁体中文语言包


• nl-NL-locale [install] - 荷兰文语言包 

• atmail [install] - Atmail 网络邮件支持


安装 Panel 

若要安装 Parallels Small Business Panel, 执行格式如下的命令 : 

parallels_installer --select-release-id 

[other options] 

其中 

• 程序包来源选项定义安装程序应获取并安装 Panel 程序包的位置 

= 

--source 

若使用 Panel 更新服务器镜像 

或 

--source VPS dashboard 

若使用本地文件系统 

或 

无 

若从 Panel 更新服务器安装 

• 组件 ( 第 11 页 ) 安装选项定义要安装哪些 Panel 组件 

= 

--install-everything 

或 

--install-component component1 [--install-component component2 [... 

[--install-component componentN]]] 

• 其他选项包括定义代理服务器设置、安装日志等等。如需详情 , 请参阅安装程序 CLI 参考章 

节 ( 第 14 页 ) 

如 ,Linux/Unix 

1. 下列命令可用于从服务器上的镜像设置到。通过 HTTP 在主机 ppsmbe-mirror.example.com 

上设置镜像来安装 Parallels Small Business Panel 10 ( 版本 ID 是 PPSMBE_10_0_0)。安装文 

件会临时存放在 /tmp/ppsmbe, 安装状态会发送到 admin@example.com。安装的组件包括 

Panel 程序包、PostgreSQL 服务器和 SpamAssassin 垃圾邮件过滤器。 

./parallels_installer --source http://ppsmbe-mirror.example.com/ --target 

/tmp/ppsmbe --select-release-id PPSMBE_10_0_0 --install-component base 

--install-component postgresql --install-component spamassassin 

--notify-email admin@example.com 

2. 下列命令可用于完全安装 ( 安装所有产品组件 ) 来自 Parallels 更新服务器的 Parallels Small 

Business Panel 10 ( 版本 ID 是 PPSMBE_10_0_0)。所有安装程序输出会重定向到 XML 文件。 

./parallels_installer --select-release-id PPSMBE_10_0_0 --install-everything 

--enable-xml-output 

示例 Windows


1. 下列命令可用于从服务器上的镜像设置到。通过 HTTP 在主机 PPSMBE_10_0_0_WIN 上设 

置镜像来安装 Parallels Small Business Panel 10 ( 版本 ID 是 PPSMBE_10_0_0)。安装文件会 

临时存放在 ppsmbe-mirror.example.com, 安装状态会发送到 admin@example.com。安装的组 

件包括 Panel 程序包、绑定域名服务器、MailEnable 邮件服务器、PHP 脚本编译工具、站点编 

辑器和 Horde Webmail。 

parallels_installer.exe --source http://ppsmbe-mirror.example.com/ --target 

%SystemDrive%\Parallels --select-release-id PPSMBE_10_0_0_WIN 

--install-component base --install-component dns --install-component 

mailenable --install-component php5 --install-component siteeditor 

--install-component webmail --notify-email admin@example.com 

2. 下列命令可用于完全安装 ( 安装所有产品组件 ) 来自 Parallels 更新服务器的 Parallels Small 

Business Panel 10 ( 版本 ID 是 PPSMBE_10_0_0_WIN)。所有安装程序输出会重定向到 XML 

文件。 

parallels_installer.exe --select-release-id PPSMBE_10_0_0_WIN 

--install-everything --enable-xml-output 

安装程序 CLI 参考 ( 简化 ) 

本参考只涵盖使用 CLI 安装 Panel 的 Parallels 安装程序选项。 

若要了解有关已安装的 Panel 或主机操作系统升级相关的选项 , 执行下列命令 : 

parallels_installer --help 

选项 

--source VPS 

dashboard| 

描述及可能的问题 

从本地文件系统检索到 Panel 程序包后 , 指定 --source 选项指向包含 

要安装的 Panel 相关的 .inf3 文件。 

--target VPS 

dashboard 

--proxy-host < 网络地址 

> 

从网络服务器检索到 Panel 程序包后 , 指定 --source 选项指 

向 Panel 更新服务器镜像所在的目录。 

默认情况下 , 安装程序将检索到的文件保存到目录 //psa。例如 , 若 root 用户执行安装程序 , 则会创建并使用 

/root/psa 目录。若要使用自定义目录存放检索到的文件 , 请使用 

--target 选项。 

如 : 

--target /opt/storage/psa 

或 

--target D:\temp 

使用代理服务器或防火墙时 , 请使用此选项指定代理服务器域名或 IP 地 

址。 

--proxy-port < 端口号 > 

如 : 

--proxy-host proxy.example.com 

连接代理服务器的默认端口是 3128。若代理服务器使用其他端口号 , 请 

使用此选项指定。 

如 : 

--proxy-port 5741


选项 

代理服务器认证选项。 

--proxy-user 

 

--proxy-password 

 

--show-releases 


若代理服务器需要认证 , 请使用这些选项在代理服务器上认证安装程序。 

示例 : 

--proxy-user smith --proxy-password f1sZ9AnQ4EnO52 

指定此选项检索要执行安装程序的可用操作系统版本列表。则会看到版 

本标识符和版本描述。接下来您需处理版本标识符。 

--show-all-releases 此选项显示 Panel 更新服务器上所有可用的版本。 

--select-release-id 

 

--select-release-lat 

est 

--show-components 

--install-component 

 

使用此选项指定要安装或要查看其属性的版本。 

使用此选项选择您的操作系统可用的最新版本。 

指定此选项来获取所选版本可用的组件相关信息。即将显示组件描述和 

名称。 

选择要安装的其他组件时 , 请指定组件名称。 

使用此选项指定要安装的组件。若要一次安装多个组件 , 请重复使用此 

选项。 

示例 : 

--install-component base --install-component 

postgresql --install-component spamassassin 

--install-everything 使用此选项安装所选版本的所有组件。 

--show-os-list 使用此选项找到所选版 Panel 支持的操作系统。 

--no-space-check 即便磁盘空间不足也安装程序包。 

--no-daemon 在前台执行安装。 

--notify-email 

 

使用此选项让安装程序通过邮件发送状态报告。成功的完成报告包括安 

装 / 升级的程序包及其详细日志。 

--enable-xml-output 此选项的功能是与 Panel 通讯 , 也可以与其他应用程序搭配使用。 

指定此选项时 , 安装程序全部输出到 XML 文件。注意 , 此选项会禁止安 

装程序通过退出代码报告错误。退出代码是零 , 报告的所有错误都在 XML 

输出中。 

--query-status 

因 RPM 数据库不允许多进程 , 安装程序会锁定它的功能。运行此选项查 

看安装程序是否启用。这会检查是否锁定 , 将会返回退出代码 (0 - 安装 

程序闲置 ,1 - 安装程序正在运行且繁忙 ), 或 XML 格式的输出。 

--truncate-log Parallels 产品安装程序启动后 , 即清除日志文件。 

--separate-log Parallels 产品安装程序每次启动都使用新日志文件。


选项 


--debug 启用日志文件详细输出。 

--version 显示 Parallels 产品安装程序版本。 

安装脚本 (Linux/Unix) 

本章阐述如何实施和执行安装脚本 , 也提供安装脚本范例。 

实施与执行注意事项 

• 若要避免通过 SSH 连接安装 Panel 的服务器时每次都被提醒输入密码 , 请将公钥放到应在 

每个服务器上执行脚本的用户授权码列表中 ( 参阅 SSH 文档了解如何操作 )。 

• 若有 Panel 更新服务器本地镜像 ( 参阅设置镜像章节 ( 第 22 页 )), 使用下列选项 : 

--source 

• 默认情况下 , 所有下载的程序包存放在 /root/psa 目录。若要使用另一目录 , 使用下列 

选项 : 

--target 

样本脚本 

1. 此示例脚本在多数情况下适用 ,Parallels 安装程序之前上传到目标服务器 , 已在权限中设置 

执行。 

#!/bin/sh 

SERVERS_LIST="node1.example.com node2.example.com" 

for current_server in $SERVERS_LIST; do 

scp parallels_installer root@$current_server: 

ssh -f root@$current_server "parallels_installer --source 

http://updates.example.com/ --target /tmp/ppsmbe --select-release-id 

PPSMBE_10_0_0 --install-component base --install-component postgresql 

--install-component asp --notify-email admin@example.com" 

done 

2. 当直接从网络位置获取 Parallels 安装程序二进制时可使用此示例脚本 ( 示例 URL 

http://example.com/type_parallels_installer_name_here 应替换成有效的安装程序下载链接 )。 

#!/bin/sh 

SERVERS_LIST="node1.example.com node2.example.com" 

for current_server in $SERVERS_LIST; do 

ssh -f root@$current_server 'wget 

http://example.com/type_parallels_installer_name_here -o 

parallels_installer;chmod 755 ./parallels_installer;./parallels_installer 

--source http://updates.example.com/ --target /tmp/ppsmbe --select-release-id 

PPSMBE_10_0_0 --install-component base --install-component postgresql 

--install-component spamassassin --notify-email admin@example.com' 

done


在 Parallels Containers 环境中部署 

本章涵盖使用 Parallels Containers CLI 部署面板所需的基本步骤 , 着重在使用 Parallels Small 

Business Panel 创建 Container。如需有关 Parallels Container CLI 或 Parallels Containers API 

(XML 或 SOAP) 功能的更多信息 , 参阅 Parallels Containers 开发人员文档 

(http://www.parallels.com/ptn/documentation/virtuozzo/)。 

在 Parallels Containers 环境中部署 Panel 包括下面两个阶段 : 

1 在硬件节点上安装 Panel 应用程序模板。 

2 创建 Container, 并从模板部署应用程序。 

第一阶段只在每个硬件节点上执行一次 : 应用程序模板安装到硬件节点上之后 , 即可根据需要 

部署尽可能多的 Container。 

无需每次创建新 Container, 每次需要使用 Panel 部署 VPS 时 , 提供选项克隆安装 Panel 的现 

有 Container, 并作为模板 Container 使用。


Parallels Containers for Unix 

两种 EZ 模板适用于 Parallels Small Business Panel 10: 

• ppsmbe10 

包含 Panel 核心组件。 

• ppsmbe10-extended 

包含所有附加组件 , 如 SpamAssassin 垃圾邮件过滤器、Ruby-on-Rails 框架、Dr.Web 防 

病毒、站点编辑器模板和其他组件。 

若安装扩展版的 Panel, 则需安装两个模板。 

通过下列方式可在目标硬件节点上安装 Panel 模板 : 

• 使用 vzup2date 实用程序。如需详情 , 参阅 Parallels Containers for Linux 参考指南 , 位 

于 Parallels 技术社区 (http://www.parallels.com/ptn/documentation/virtuozzo/)。 

• 直接从 Parallels 网站 (http://www.parallels.com) 下载模板 , 并使用 vzpkg 实用工具安装 

在硬件节点上安装模板时 , 即可部署文件核心设置 , 其中包括应用程序库定义。在 Container 

中安装应用程序后 ,Parallels Containers 与库通讯 (Parallels Small Business Panel for 

Linux/Unix 默认库是 Parallels 更新服务器 , 位于 http://autoinstall.plesk.com), 并检索应用程序 

包 , 安装到 Container 中。清空前程序包存放在节点缓存中 , 应用程序安装到 Container 中之后 , 

再从库中检索程序包。若要保存流量和时间 , 则需使用 Panel 库的自定义镜像。 

‣ 若要使用 vzpkg 实用程序在 Parallels Containers 上安装 Panel 模板 : 

1 从 Parallels 网站 (http://www.parallels.com) 获取 Panel 模板 , 并上传到 

Parallels Containers 硬件节点。 

2 执行格式如下的命令安装应用程序模板 : 

vzpkg install template [-q|] ... 

其中 

• -q 禁止登录显示器和日志文件 

-d|--debug 设置日志级 , 从 0 到 10 例如 , 下列命令安装 Panel 的核心和扩 

展组件 : 

# vzpkg install template 

ppsmbe10-debian-5.0-x86-ez-4.0.0-1.prl.284629.noarch.rpm 

ppsmbe10-extended-debian-5.0-x86-ez-4.0.0-1.prl.284385.noarch.rpm 

‣ 若要使用自定义镜像 : 

1 若要设置镜像 , 参阅建立 Linux/Unix 版镜像章节 ( 第 23 页 )。 

2 在硬件节点上 , 编辑库 URL 文件 :


1. 打开编辑文件 

/vz/template/Linux///config/ 

app//default/repositories。 

即 

/vz/template/Linux///config/app/ppsmbe10/ 

default/repositories 和 

/vz/template/Linux///config/app/ppsmbe10- 

extended/default/repositories. 若安装了两个模板 , 则编辑两个文件。 

2. 使用镜像 URL 替换相应的 Parallels 更新服务器 URL, 并保存文件。 

3 清除或重新获取程序包元数据。 

使用 vzpkg clean 命令可执行此操作。如需详情 , 参阅 Parallels Containers for Linux 参 

考指南 , 位于 Parallels 技术社区 (http://www.parallels.com/ptn/documentation/virtuozzo/) 

。 

‣ 若要创建新 Container 并在其中安装 Panel: 

1 创建 Container, 并根据需求配置。 

执行以下命令 : 

vzctl create [options] 

vzctl set [--save] 

其中 

• 定义大于 100 的唯一 Container ID, 在硬件节点上唯一 

• --save 选项让 vzctl 是否将变更保存到 Container 配置文件 

注意 : 如需有关 Container 创建和配置选项的详细信息 , 参阅 Parallels Containers for 

Linux 参考指南 , 位于 Parallels 技术社区 


如 , 下面的命令执行 : 

1. 创建 Container,ID 为 ,IP 为 192.0.2.44, 基于 Parallels Containers 全局配置文件中 

定义的默认 OS 模板 

2. 设置无法交换的内核内存阻碍和限制 , 专用 ( 或潜在的专用 ) 内存 , 所有 Container 进程打 

开的文件数 , 以及 Container 可分配的磁盘空间和磁盘 inodes( 文件、目录、符号链接 ) 

总数 

3. 保存阻碍 / 限制值到 Container 配置文件 

4. 使用 Web 浏览器管理 Container ( 使用 "--offline_management no" 选项阻止离线 

管理 ) 

注意 : 请按示例设置此选项。否则无法通过网络浏览器访问。 

# vzctl create 444 --ipadd 192.0.2.44 

# vzctl set 444 --save --kmemsize 24299200:26429120 --privvmpages 

362144:392912 --numfile 12000:12000 --diskspace 5117880:5242880 

--diskinodes 350000:370000 offline_management no


2 启动新近创建的 Container: 

# vzctl start 

3 将 Panel 模板安装到 Container 中 : 

vzpkg install ... 

如 , 下列命令可以安装 Panel 核心和附加组件 : 

# vzpkg install 444 ppsmbe10 ppsmbe10-extended 

‣ 若要克隆 Container: 

执行格式如下的命令 : 

vzmlocal -C {CT List} 

{CT List} = :[:[][:]] 

[...] 

请指定源 Container ID () 和目标 Container ID ()。指定目 

标 Container 专用区路径 () 和根路径 () 可选 ; 它允许您 

分别覆盖默认路径 - /vz/private/ 和 /vz/root/。如需命 

令选项详情 , 参阅 Parallels Containers for Linux 参考指南 , 位于 Parallels 技术社区 


例如 , 若要使用之前创建的 Panel 克隆 Container: 

# vzmlocal -C 444:445


Parallels Containers for Windows 

‣ 若要在 Parallels Containers 硬件节点上安装 Panel: 

1 从 Parallels 网站 (http://www.parallels.com) 获取 Panel 模板 , 并上传到 

Parallels Containers 硬件节点。 

2 安装 Panel 的应用程序模板。若是在 Microsoft Windows Server 2003 上安装 

, 也请执行以下格式的命令安装 Microsoft .NET Framework v.2.0 或更新版本 

: 

vzpkgdeploy [-q|-v] -i 

其中 

• -q 禁止登录显示器和日志文件 

-v 设置此 vzpkgdeploy 会话的登录级别到最大值例如 , 

>vzpkgdeploy -i ppsmbe-10.0.0.0-20090707.efb 

>vzpkgdeploy -i dotnet2.0_frmwk-2.0.50727.42.efb 

注意 : 仅有 Windows Server 2003 (PVC 4.0, VZ 3.5.1) 需安装 .NET Framework 附加模 

板。Windows Server 2008 (PVC 4.5) 不需要。 

‣ 若要创建新 Container 并在其中安装 Panel: 

1 创建 Container, 并根据需求配置。 

执行以下命令 : 

vzctl create --pkgset name [options] 

vzctl set [--save] 

其中 

• 定义大于 100 的唯一 Container ID, 在硬件节点上唯一 

• --pkgset name 表示要用来创建 Container 的 OS 模板 

• --save 选项让 vzctl 是否将变更保存到 Container 配置文件 

注意 : 如需有关 Container 创建和配置选项的详细信息 , 参阅 Parallels Containers for 

Windows 参考指南 , 位于 Parallels 技术社区 


如 , 下面的命令执行 : 

• 创建 Container,ID 为 444,IP 为 192.0.2.44, 基于 OS 模板 w2k3 

• 设置磁盘空间限制为 4+ Gb, 专用空间限制为 1 Gb, 管理员密码为 "P4$$w0rd" 

• 使用 Web 浏览器管理 Container ( 使用 "--offline_management no" 选项阻止离线 

管理 ) 

注意 : 请按示例设置此选项。否则无法通过网络浏览器访问 Panel。 

>vzctl create 444 --pkgset w2k3 --ipadd 192.0.2.44


>vzctl set 444 --save --diskspace 4500000 --vprvmem 1024 --userpasswd 

Administrator:P4$$w0rd --offline_management no 

2 启动新近创建的 Container: 

>vzctl start 

3 安装 Microsoft .NET framework 2.0 或以上版本到 Container 中 : 

vzpkgadd 

例如 , 

>vzpkgadd 444 dotnet2.0_frmwk-2.0.50727.42/20070613 

4 将 Parallels Small Business Panel 模板安装到 Container 中 : 

vzpkgadd 

例如 , 

>vzpkgadd 444 ppsmbe-10.0.0.0-20090707 

‣ 若要克隆 Container: 

执行格式如下的命令 : 

vzmlocal -C 

= :[:] [options] 

请指定源 Container ID () 和目标 Container ID ()。指定目标 

Container 专用区域路径 () 可选 ; 它允许您覆盖 

X:\vz\private\ 默认路径。如需命令选项详情 , 参阅 Parallels Containers for 

Windows 参考指南 , 位于 Parallels 技术社区 


例如 , 若要使用之前创建的 Panel 克隆 Container: 

>vzmlocal -C 444:445 

使用 Rsync 实用程序设置镜像 

本章阐述如何使用 Rsync 在 Linux 服务器上创建 Linux/Unix 和 Windows 版 Parallels Small 

Business Panel Parallels 更新服务器本地镜像。Rsync 是开源实用程序 , 使用它即可创建支 

持相应版 Panel 的镜像 , 包括 Parallels Containers。 

Parallels Small Business Panel for Linux 库镜像可支持独立和 Parallels Containers 安装 ( 取决 

于镜像程序包大小 )。


建立 Linux/Unix 分发包镜像 

Parallels Small Business Panel for Linux/Unix 库位于 autoinstall.plesk.com, 结构如下 ( 我们 

只列出建立 Panel 程序包镜像相关文件和目录 ): 

• _/ 

根据 Panel 版本命名多个子目录。 

子目录介绍 

a 

PPSMBE_/ 

如 ,PPSMBE_10.0.0 

其中 Panel 程序包位于 

b SETEMPLATES_/ 

如 SETEMPLATES_1.0.0 

其中站点编辑器组件 200+ 站点设计模板程序包所处位置。它是 Panel 组件而不是一款 

产品 , 放入独立产品目录来节省磁盘空间和流量。 

每个子目录包含下列文件 : 

dist----/ 包括 Panel 分发程序 

包或设计模板如 dist-deb-Debian-5.0-x86_64/ 或 

dist-deb-Debian-all-all/ 

update---- 包含服务器操作系 

统系统更新 ; 是程序包类型。rpm, deb, pkg 

thirdparty----/ 包含其他第 

三方程序包 

• _--.inf3 

Parallels 安装程序配置文件 

如 ppsmbe-10.0.0-suse11.1-x86_64.inf3, 

setemplates-1.0.0-deball-all.inf3 

• products.inf3 

Parallels 安装程序配置文件描述 Panel 产品 

• ppsmbe.inf3,setemplates.inf3 

Parallels 安装程序配置文件描述 Panel 版本和其他组件 

• PPSMBE10/ 

Parallels Small Business Panel 元数据用于使用 EZ 模板在 Parallels Containers 中安装 

Panel。 

• debian/,ubuntu/ 

目录 apt-get 可用来使用 EZ 模板和 Parallels 产品安装程序安装 Parallels 产品 

‣ 若要设置 Panel 镜像 :


1 登录要建立镜像的服务器。 

2 建立要存放文件的目录。为了演示 , 我们会调用此目录 

destination_directory/。 

3 在此目录中创建两个子目录 :debian/ 和 ubuntu/。 

4 若要设置镜像 , 执行下列命令。 

• 此命令可将 Parallels 更新库上的 /PPSMBE_10.0.0 目录下载到 

destination_directory。 

# rsync -au --delete 

rsync://rsync.autoinstall.plesk.com/autoinstall/PPSMBE_10.0.0 

destination_directory 

• 此命令可将 Parallels 更新库上的 /SETEMPLATES_1.0.0 目录下载到 

destination_directory。 


rsync://rsync.autoinstall.plesk.com/autoinstall/SETEMPLATES_1.0.0 

destination_directory 

• 这些命令可通过 Parallels 安装程序下载 Parallels Small Business Panel 的 Ubuntu 和 

Debian 程序包。 


rsync://rsync.autoinstall.plesk.com/autoinstall/debian/PPSMBE_10.0 

.0 destination_directory/debian 


rsync://rsync.autoinstall.plesk.com/autoinstall/unbuntu/PPSMBE_10. 

0.0 destination_directory/ubuntu 

• 这些命令可通过 Parallels 安装程序下载用来安装 Ubuntu 和 Debian 程序包的内容。 


rsync://rsync.autoinstall.plesk.com/autoinstall/debian/SETEMPLATES 

_1.0.0 destination_directory/debian 


rsync://rsync.autoinstall.plesk.com/autoinstall/unbuntu/SETEMPLATE 

S_1.0.0 destination_directory/ubuntu 

• 这些命令可通过 Parallels Containers EZ 模板下载用来安装 Ubuntu 和 Debian 程序包的 

内容。若要设置非 Parallels Containers 环境镜像 , 略过此步骤。 


rsync://rsync.autoinstall.plesk.com/autoinstall/debian/PPSMBE_10.0 

.0/ destination_directory/debian/PPSMBE10 


rsync://rsync.autoinstall.plesk.com/autoinstall/ubuntu/PPSMBE_10.0 

.0/ destination_directory/ubuntu/PPSMBE10 

• 此命令可用于创建符号链接 , 使用此链接即可通过 Parallels Containers EZ 模板在基于 

RPM 的操作系统中安装 Panel。若要设置非 Parallels Containers 环境镜像 , 略过此步 

骤。 

# cd destination_directory; ln -s PPSMBE_10.0.0 PPSMBE10 

• 此命令可下载 Parallels 安装程序配置文件。


# rsync -auv --delete 

rsync://rsync.autoinstall.plesk.com/'autoinstall/products.inf3 

autoinstall/versions.inf3 autoinstall/ppsmbe.inf3 

autoinstall/setemplates.inf3' destination_directory 

5 编辑 Parallels 安装程序配置文件定义此镜像支持的产品、版本和平台。 

1. 编辑 products.inf3 文件移除所有 product 元素 , 只保留 ID ppsmbe 

。若要支持站点编辑器的其他站点设计模板设置 , 也略过 ID 为 

setemplates 的 product 元素。 

2. 编辑 ppsmbe.inf3 文件 , 移除所有 build 元素 , 留下镜像支持的操作系 

统和架构。 

3. 编辑 setemplates.inf3 文件 , 移除所有 build 元素 , 留下其他站点编 

辑器站点设计模板支持的操作系统和架构。 

注意 : 如需有关 Rsync 实用程序的更多信息 , 请访问 http://samba.anu.edu.au/rsync/。


建立 Windows 分发包镜像 

Parallels Small Business Panel for Windows 库位于 http://autoinstall-win.parallels.com, 结构 

如下 ( 我们只列出建立 Panel 程序包镜像相关文件和目录 ): 

• _/ 

根据 Panel 版本命名多个子目录。 

在此示例中 , 子目录是 PPSMBE-WIN_/, 如 PPSMBE-WIN_10.0.0/ 

每个子目录包含下列文件 : 

• dist----/ 

包括 Panel 分发程序包或设计模板 , 

如 dist-msi-Microsoft-2003-i386/ 

• thirdparty---- 

其他第三方程序包 

• ppsmbe---.inf3 

Parallels 安装程序配置文件 

• products.inf3 

Parallels 安装程序配置文件描述 Panel 产品 

• ppsmbe.inf3 

Parallels 安装程序配置文件描述 Panel 版本和其他组件 

‣ 若要设置 Panel 镜像 : 

1 登录要建立镜像的服务器。 

2 建立要存放文件的目录。为了演示 , 我们会调用此目录 


3 若要设置镜像 , 执行下列命令。 

• 此命令可将 Parallels 更新库上的 PPSMBE-WIN_10.0.0/ 目录下载到 



rsync://rsync.autoinstall-win.parallels.com/autoinstall/PPSMBE-WIN 

_10.0.0 destination_directory 

• 此命令可下载 Parallels 安装程序配置文件。 

# rsync -auv --delete 

rsync://rsync.autoinstall-win.parallels.com/'autoinstall/products. 

inf3 autoinstall/ppsmbe.inf3' destination_directory 

4 编辑 Parallels 安装程序配置文件定义此镜像支持的产品、版本和平台。 

1. 编辑 products.inf3 文件移除所有 product 元素 , 只保留 ID ppsmbe 

。若要支持站点编辑器的其他站点设计模板设置 , 也略过 ID 为 

setemplates 的 product 元素。


2. 编辑 ppsmbe.inf3 文件 , 移除所有 build 元素 , 留下镜像支持的操作系 

统和架构。 

注意 : 如需有关 Rsync 实用程序的更多信息 , 请访问 http://samba.anu.edu.au/rsync/。

第 4 章 

安装操作概要 

本章简要阐述 Parallels Small Business Panel 交付中安装阶段的操作。 

本章按照执行顺序分别介绍各个操作。 


初始化 Panel ..................................................................................................... 29 

安装许可证 ........................................................................................................ 29 

定义 Panel 徽标 ................................................................................................. 30 

配置 DNS .......................................................................................................... 31 

安装 SSL 证书 ................................................................................................... 32 

创建站点及子站点 .............................................................................................. 33 

安装应用程序 ..................................................................................................... 34 

定义可用的 APS 目录 ........................................................................................ 36


初始化 Panel 

Panel 安装后首先要执行的操作是初始化。禁止在 Panel GUI 或通过 API 执行任何操作。 

初始化配置下列 Panel 设置 : 

• 管理员的电子邮件 

• 管理员新密码 , 不是默认密码 

• ( 可选 ) Panel 语言 

若在 Panel 初始化中未设置语言 , 则会使用默认的美国英语 (en-US)。 

Panel 管理员可稍后更改界面语言 ( 安装所需语言组件 ( 第 11 页 ))。 

快速链接 

使用远程 API 安装 Panel ( 第 68 页 ) 

使用 CLI 初始化 Panel ( 第 162 页 ) 

安装许可证 

Panel 分发版随附支持有限用户帐户的默认许可证。您需获取并安装满足用户需求的许可证。 

除定义 Panel 主要功能的主许可证之外 , 也可安装附加许可证 , 即可使用 Panel 加载项 , 如 

Dr.Web 防病毒解决方案。 

快速链接 

使用远程 API 安装许可证 ( 第 71 页 ) 

使用 CLI 安装许可证 ( 第 163 页 )

30 安装操作概要 

定义 Panel 徽标 

Panel 交付范围内的 Panel 商标信息 : 

• Panel 徽标类型图像和 URL 

• 支持按钮链接 

注意 :CLI 中支持两者。 

徽标 

Panel 徽标类型显示在 Panel 左上角。默认是 141*29 像素的 GIF 图像 ,Parallels Small 

Business Panel 产品徽标类型 , 点击它即可打开 Parallels 网站。可更改默认徽标图像和 URL。 

支持 

支持按钮位于 Panel 管理员可以使用的设置选项卡上。默认情况下 , 点击按钮即可打开 Parallels 

网站上的技术支持请求表单 , 假定由管理员完成和提交。 

若要向客户提供技术支持 , 单击支持按钮即可更改 URL。 

快速链接 

使用 CLI 建立 Panel 徽标 ( 第 164 页 )


配置 DNS 

安装在 DNS 服务器上 , 该 DNS 服务器设置成用于创建站点和托管 Panel 的主 

控域名服务器。配置 Panel 时 , 即可停用 DNS 服务 , 或按照需求进行配置。 

若您的工作环境中域名服务器设置成服务多个托管的域名 , 且安装了 Panel, 则无需独立的 DNS 

服务器。在 Parallels Containers 环境中 , 安装 Panel 的 Container 中 ,DNS 服务器运行需消耗 

稍多资源 , 即可降低主机环境的密度。 

若要让 Panel 管理的站点 DNS 区域由远程 DNS 服务器服务 , 配置 Panel 实例时停用 DNS 服 

务。客户若确定站点由本地 DNS 服务器支持 , 也可稍后启用。 

若要让 Panel 管理的站点由本地 DNS 服务支持 , 则可通过合适方式修改 DNS 区域。 

Panel 提供可自定义的 DNS 区域模板 , 包含 DNS SOA 模板和其他资源记录。创建站点帐户时 , 

基于此模板创建其 DNS 区域。若要设置 Panel 管理站点的 DNS 区域 , 只需编辑 DNS 区域模 

板。 

快速链接 

使用远程 API 配置 DNS ( 第 77 页 ) 

使用 CLI 配置 DNS ( 第 165 页 ) 

更改 SOA 记录模板 

SOA 记录的 Panel 模板允许更改下列记录字段 : 

• ttl ( 生效时间 ) 

• 刷新 

• 重试 

• 过期 

• 最小 

• ( 仅限 Unix CLI) sn (= 序列号 ) 格式 

区域序列号格式 :yyyymmdd 或 Unix 时间戳


设置资源记录模板 

DNS 区域的 Panel 模板支持下列资源记录类型 : 

• A 

• NS 

• CNAME 

• MX 

• PTR 

• TXT 

• AXFR 

• SRV 

安装 SSL 证书 

在站点上使用安全套接字层协议需先安装 SSL 证书。 

在 Panel 中 ,SSL 证书通过 IP 地址连接到站点 : 证书分配到 IP 地址 , 访问该 IP 托管的站点时 

会用到此证书。实际上 , 通过 https 访问该 IP 上托管的站点时会用到此证书。 

安装 SSL 证书意味着将证书导入到 Panel 并分配 IP 地址给它。若在此类 IP 上创建站点帐户 , 

则会自动启用 "SSL 支持 ", 安装的证书用于访问站点。 

快速链接 

使用远程 API 安装 SSL 证书 ( 第 99 页 ) 

使用 CLI 安装 SSL 证书 ( 第 170 页 )


创建站点及子站点 

站点 

Parallels Small Business Panel 中新型的站点和子站点创建与配置流程简单且轻松。创建站点 

或子站点时 , 请指定最基本的主机参数 , 其他主机设置会自动完成。 

因此 , 若要创建站点 , 请指定下列函数 : 

• 域名 

• IP 地址 

若 IP 地址与 SSL 证书关联 ( 第 32 页 ), 则会自动启用使用此 IP 创建站点的 SSL 支持。 

• 要求的虚拟主机属性 : 用来上传网站内容的 FTP 帐户登录名和密码。 

在站点上安装 Web 应用程序时 ,Panel 会自动设置应用程序所需的所有服务。因此必须在 

站点创建过程中指定 IP 地址、FTP 登录名和密码。 

快速链接 

使用远程 API 创建站点 ( 第 105 页 ) 

使用 CLI 创建站点 ( 第 172 页 ) 

子站点 

创建子站点时 , 至少要指定子站点和主站点的前缀名。 

子站点内容通常位于站点虚拟主机的 /httpdocs/subdomains/subdomain-name 目录中。 

Windows 版 Panel 支持子文件夹中的子站点 - 子站点映射到 /httpdocs 文件夹中的任何目录 

。若要让安装的 Web 应用程序可作为子站点访问 , 此站点会很有用。如 ,WordPress 应用程 

序可通过类似 http://domain-name/URL-prefix 的 URL 访问 , 也就是 

http://example.com/WordPress。若有子站点在子文件夹中 , 则可通过 

http://blog.example.com 访问。 

• 若要创建常规子站点 , 指定主站点名、子站点名和子站点主机属性。 

注意 : 默认情况下 , 通过主站点的同一 FTP 帐户即可访问子站点内容。因此 , 指定 FTP 帐 

户属性是可选项 , 仅当需要访问子站点内容的 FTP 帐户时才需要指定。 

• 若要在子文件夹中创建子站点 ( 仅有 Windows 支持 ), 指定主站点名 / 子站点名 , 以及要创建 

子站点的文件夹路径。 

注意 : 对于子文件夹的子站点 , 无法创建独立的 FTP 用户帐户 : 会用户主站点 / 子站点的 FTP 

用户帐户。


快速链接 

使用远程 API 创建子站点 ( 第 110 页 ) 

使用 CLI 创建子站点 ( 第 172 页 ) 

安装应用程序 

Parallels Small Business Panel 支持 APS 应用程序。这些是按 APS - 应用程序交付标准 

(http://www.apsstandard.org/) 打包的 Web 应用程序 , 将 SaaS 模式推向主机页。 

术语应用程序包 - 以 APS 格式打包的 Web 应用程序 zip 存档。与应用程序不同 , 它从程序包 

直接安装。 

在站点或子站点上安装应用程序分两步完成 : 

1 获取应用程序包 , 并导入 Panel。 

2 在站点或子站点上从程序包安装应用程序。 

快速链接 

使用远程 API 安装应用程序 ( 第 117 页 ) 

使用远程 CLI 安装应用程序 ( 第 175 页 ) 

导入应用程序包 

有两种方法可获取并导入应用程序包 : 

• 通常是自行创建的程序包 , 手动上传到安装 Panel 的主机上 , 并手动导入到 Panel。 

下载程序包 , 并自动从 APS 目录导入到 Panel ( 提供应用程序包远程存储的网络服务 )。即 

可一次性下载并导入多个应用程序 ,Panel 支持下载状态追踪。 

Panel 支持从多个 APS 目录实例获取应用程序包。可用的 APS 目录在 APS 目录配置文件 ( 第 36 

页 ) 中有定义 , 可自定义来满足特定主机环境中的 Panel 示例需要。



安装应用程序后 , 请指定下列内容 : 

• 安装应用程序的应用程序包位置。 

按名称 - 版本 - 发行号信息或程序包 ID 分类。检索可用程序包即可获得这些数据。在详细应用 

程序包列表中检索到可用程序包结果导入到 Panel, 包括所需标识符。 

• 目标站点或子站点。 

• 安装属性。 

这些是特定应用程序 , 也可以是没有任何安装属性或设置的应用程序。Panel API 不支持应 

用程序设置信息的获取 , 请使用 APS 目录 API 

(http://www.apsstandard.org/r/doc/aps-catalog-1.1-api/index.htm) 或分析程序包元数据文 

件来获取。如需有关 APS 格式技术规格中的 APS 格式的更多信息 , 请访问 

http://www.apsstandard.org/providers/documentation/。


定义可用的 APS 目录 

列出配置文件中定义的 APS 目录 , 可用于 : 

1 通过 Panel API 直接从这些目录将应用程序安装到站点上。 

注意 : 从 APS 目录安装应用程序不可能没有列出在配置文件中。 

2 Panel 用户可以从应用程序 & 脚本屏幕看到这些目录 , 用户可以自行安装应用程序。 

APS 目录由服务生成名称 , 格式如下 : 

• APS 目录位于 apscatalog.com (http://apscatalog.com)。Parallels 正式支持 APS 目录服务 

。 

• 自定义 APS 目录 , 服务的本地镜像部署到主机环境中 , 并提供特定应用程序的访问。 

如需有关如何实施 APS 目录本地镜像的信息 , 请参阅 APS 标准官方网站文档 

http://www.apsstandard.org/providers/documentation/。 

下列情况下 , 需定义 APS 目录 : 

a 配置 Panel 时 , 您可能需要从自定义的 APS 目录安装应用程序。 

在此情况下 , 需添加目录项目到配置文件中。 

b 您可能需 Panel 用户访问自定义 APS 目录 , 而不是 Panel 默认提供的项目。 

在此情况下 , 需添加目录项目到配置文件中 , 可以移除现有项目。 

c 您可能不希望 Panel 用户访问任何 APS 目录。 

在此情况下 , 需从配置文件中移除所有项目。 

若要更改可用 APS 目录列表 , 请执行下列操作 : 

1 按需要修改 APS 目录样本 ( 第 37 页 )。 

2 导入配置文件到 Panel 中。 

快速链接 

使用远程 API 定义可用的 APS 目录 ( 第 115 页 ) 

使用 CLI 定义可用的 APS 目录 ( 第 174 页 )


APS 目录配置文件 

APS 目录配置文件是格式如下的配置文件 : 

[apscatalog] 

; 作为内部标识符服务 APS 应用程序资源的关键字。 

type = apscatalog 

;APS 应用程序资源类型定义 , 可以是商城或 apscatalog 

; 商城是用于表示应用程序商城服务的类型 

;apscatalog 是可用于任何 APS 目录的一般类型 ( 正式 APS 目录服务和本地镜像 ) 

url = http://apscatalog.com 

;APS 应用程序资源 URL 

[marketplace] 

type = marketplace 

url = http://catalog.marketplace.parallels.com 

protocol = all-app 

[APSCatalogLocalMirror] 

type = apscatalog 

name.en-US = "APS Catalog (local)" 

;APS 应用程序资源标题会显示在相应语言的 Panel GUI 中 

description.en-US = "Local instance of APS catalog" 

;APS 应用程序资源描述会显示在相应语言的 Panel GUI 中 

url = apscatalog.example.com 

若要更改 Panel 用户可用的 APS 目录 , 编辑配置文件并导入到 Panel。

第 5 章 

通过远程 API 设置 

本章阐述如何通过 Panel 的远程 API 设置 Panel。 

使用远程 API 章节 ( 第 39 页 ) 包括 API RPC 协议概要和用于通过协议与 Panel 管理的服 

务器通讯的工具样本。 

设置 Panel 章节 ( 第 68 页 ) 描述第三方工具应执行 Panel 设置操作的请求信息详情 , 以及 

从每个操作返回的响应信息。 


使用远程 API ..................................................................................................... 39 

设置 Panel ......................................................................................................... 68

通过远程 API 设置 39 

使用远程 API 

本章阐述 Panel 远程 API 的定义、操作 , 以及如何创建通过远程 API 与 Panel 通讯的客户端应 

用程序。 

关于远程 API 

若要支持 Panel 与第三方软件之间的通讯 ,Panel 提供基于 XML 的 API。此界面包括管理 Panel 

逻辑对象的功能设置。API RPC 协议可以远程调用 API 功能。此 XML-over-HTTP 协议通过指 

定格式的数据包交换数据。 

Panel 与第三方软件之间的互动基于客户端服务器编程模式。 

表 1: Parallels Panel 与第三方客户软件之间的通讯 

服务器部分由 Panel API RPC 服务器代表 ( 以下称为此服务器 ),Panel 的一部分。客户端软 

件应由第三方创建。通讯场景如下 : 

1 客户端应用程序组成了基于 XML 的请求数据包 ( 以下称为 API RPC 数据包或此数据包 ), 

添加标准 HTTP 标头 , 并发送给服务器。 

2 服务器接收数据包 , 验证数据包 , 并调用内容 Panel 功能执行所需操作。 

3 服务器发回响应数据包 , 包括所执行操作的详细信息。 

4 客户接收到结果数据包 ( 操作状态、可能的错误信息或操作参数 ) 并检索信息。 

通讯终止。 

支持的 API 版本 

当前版 Panel 仅支持 1.6.2.0 版 API RPC 协议。

40 通过远程 API 设置 

API RPC 数据包 

API RPC 数据包是包含在 HTTP 邮件正文中的简易 XML 文件。 

区别下面两种数据包 : 

• 申请数据包 - 客户端软件通过远程 API 发送给服务器 

• 响应数据包 - 服务器发给客户 

数据包结构 

响应数据包包含所请求操作的执行状态 , 若操作失败 , 还会包含错误信息。 

区分下列两个 API RPC 数据包组件 : 

1 HTTP 标头 - 传送部分。除标准信息之外 , 还需包含要在其中执行操作的服务器数据 , 以及 

Panel 管理员凭据。 

2 数据包标头指定 API RPC 协议版本。 

3 数据包内容定义服务器要执行的操作。 

数据包内容结构如下 : 

 

 

… 

... 

… 

… 

 

 

本示例展示数据包内容的基本结构 , 内含一个 [operator] 元素和一个 [operation] 元素。在特 

定实施中 , 标签 [operator]、[operation]、[parameter] 会被真正的运算子、操作和参数替换。 

注意 : 一个运算子中有多个操作区 , 多个操作区位于一个数据包中。 

一下 ,XML 数据包标题和内容统称为数据包。


数据包实例 

此为发送给服务器的申请 API RPC 消息 : 

POST 

/enterprise/control/agent.php 

HTTP/1.1 

主机 :10.58.83.1:8443 

接受 :*/* 

HTTP_AUTH_LOGIN:admin 

HTTP_AUTH_PASSWD: 设置 

Pragma:no-cache 

Content-Length:1398 

Content-Type:text/xml 

 

 

HTTP 标头 

HTTP 标头表示在 POST 中使用 HTTP 方式 , 处理代理 

位于 /enterprise/control/agent.php, ,TTP 

版本是 1.1。主机元素指消息相关的 Panel 服务器 IP 地 

址和端口。HTTP_AUTH_LOGIN 和 

HTTP_AUTH_PASSWD 元素是 Panel 管理员凭证。 

Content-Type 必须是 "text/xml"。消息长度也有限制 

。 

XML 部分开头 

数据包标题 

版本属性指定 Panel API RPC 协议所需的版本。 

 

 

P4$$w0rd 

johndoe@example.com 

de-DE 

 

 

 

数据包内容 

从相关运算子标签开始。 

特定数据包使用 smb 运算子来初始化新近安装的 Panel 

软件。initial_setup 节点上的元素包括初始化 Panel 所需 

的数据 :Panel 管理员的邮件和密码 , 以及面板语言。 

关闭数据包的追踪标签 

请求数据包和响应数据包结构类似 , 但它们的 HTTP 标头和内容不同。服务器响应请求发出的 

消息类似 : 

HTTP/1.1 200 OK 

Transfer-Encoding:chunked 

Content-type:text/html 

日期 :Fri, 03 Apr 2009 18:54:56 GMT 

服务器 :sw-cp-server/1.0.0 

 

HTTP 服务器响应标准标头 

MIME 类型是 text/xml。服务器元素显示服务器上 Panel 

处理的请求。 

有效 XML 文件标准标头


 

 

 

 

ok 

 

 

 

 

XML 数据包标头 

数据包内容 

数据包内容的根节点是 smb 运算子。 

下列行表示 Panel 初始化成功。 

关闭数据包的追踪标签 

数据包验证 

Panel API RPC 服务器处理成代理设置 - 或运算子 - 由代理工具管理。每个代理的逻辑区处理 

特定数量的命令 , 代理工具作为数据包分离器工作。 

此外 , 代理工具与多个 XML 计划文件设置相关。每个设置与特定的 API RPC 版本相关。每个 

版本的进入点在 agent_input.xsd 文件中包含同一版本的所有输入计划参考。 

Panel API RPC 服务器功能如下 : 首个 XML 数据包 , 其 HTTP 标题删除 , 转到代理工具。代理 

工具从数据包标头检索 API RPC 版本 , 选择合适的 XML 模板 , 并切换到正确的 

agent_input.xsd 模板。使用正确的数据包的运算子级别 , 此模板验证数据包的运算子级别。 

表 2: 服务器验证数据包 

若数据包被视为无效 , 代理工具将错误报告发送给客户。若数据包的所有元素验证成功 , 代理 

工具检查是否所有的代理模块需要进一步处理 , 并按顺序调用。 

调用的每个代理 ( 运算子 ) 接收到运算子数据包部分 , 解析并调用内部功能 , 并将命令执行结果返 

回到代理工具。


创建客户软件 

客户应用程序应实施下列数据交换 : 

• 转换请求的命令到 API RPC XML 数据包 

• 准备通过 HTTP 交付数据包 , 并发送给 Panel 

• 从 Panel 接收响应 , 并从数据包获取结果信息 

表 3: 客户端应用程序结构 

上图显示客户应用程序结构 , 以及此结构如何处理数据。样本应用程序的每个模块处理特定任 

务 : 

1 XML 数据包创建器从应用程序 GUI 或第三方模块接受命令。XML 数据包创建器包含每个已 

知命令的 XML 命令转换器。最终 XML 数据包格式与客户应用程序支持的 API RPC 版本完 

全兹容。 

2 HTTP 数据包发送器接受 XML 数据包。此数据包不包含目标服务器相关的任何信息和访问 

详情 , 因此 HTTP 数据包发送者可以存放这些设置 , 或按需要取用。HTTP 数据包发送器在 

Panel 用户登录凭据中加入 HTTP 标题 , 并通过 API RPC 协议将数据包发送给 Panel API 

RPC 服务器。 

3 HTTP 数据包接收器从服务器获取最终 HTTP 数据包 , 删除 HTTP 标题 , 并移动 XML 响应 

到 XML 数据包解析器。 

4 XML 数据包解析器分析响应 XML 数据包的执行状态 , 若结果为负则会生成错误消息。然后 

将提取和处理的数据返回给 GUI 或调用模块。 

上图显示 HTTP 操作部分的 HTTP 库。这些操作可从头进行 , 较快的方法是使用就绪并经过测 

试的 HTTP 库。分开 HTTP 发送器和 HTTP 接收器是有条件的 : 仅当需要分开发送和接收 HTTP 

图形操作时才执行此操作。


创建申请数据包 

请求 API RPC 数据包 , 客户从 GUI 或软件模块获取命令对一或多个 Panel 对象执行操作。此 

应用程序会将请求的命令转换成与 Panel XML API 兹容的 XML 数据包格式。 

若要实施 XML 数据包转换器命令 , 了解 API RPC 架构 , 以及如何通过 Panel 服务器处理 ( 第 40 

页 )。 

若要添加创建的请求数据包验证到转换器 , 从 Panel 安装即使用 XML 模板文件设置 : 

PRODUCT_ROOT_D/admin/htdocs/schemas/rpc/1.6.2.0 - Linux/Unix 其中 

PRODUCT_ROOT_D 定义 Panel 安装目录。 

%plesk_dir%\admin\htdocs\schemas\rpc\1.6.2.0 - Windows 其中 %plesk_dir% 

定义 Panel 安装目录。确定使用 agent_input.xsd 作为验证输入点。


发送请求信息 

Panel API RPC 数据包就绪后 , 应删除 HTTP 标头 , 并发送到指定服务器。若要执行这些任务 , 

建议使用 HTTP/FTP 客户库。本章阐述如何使用 CURL 在 PHP 中完成此操作 - PHP 4.0.2 或 

更高版本支持的免费、开源客户端 URL 传输库。 

若要建立 HTTP 标题 ,CURL 工具需要下列参数 : 

• 目标服务器 URL 格式如下 : 

定义 (‘HOST’, ’10.58.97.81’); 

定义 (‘PORT’, 8443); 

定义 (‘PATH’, ’enterprise/control/agent.php’); 

… 

$url = ‘https://’ .HOST .‘:’ . PORT .‘/’ . PATH; 

• 标题元素队列如下 : 

$headers = array( 

‘HTTP_AUTH_LOGIN:admin’, 

‘HTTP_AUTH_PASSWD:setup’, 

‘Content-Type:text/xml’ 

); 

然后 CURL 工具初始化 , 并设置使用 HTTPS, 并传送来所需的 HTTP 标头 : 

// initialize the curl engine 

$ch = curl_init(); 

// set the curl options: 

// do not check the name of SSL certificate of the remote server curl_setopt($ch, 

CURLOPT_SSL_VERIFYHOST, 0); 

// do not check up the remote server certificate curl_setopt($ch, 

CURLOPT_SSL_VERIFYPEER, false); 

// pass in the header elements curl_setopt($ch, CURLOPT_HTTPHEADER, $headers); 

// pass in the url of the target server 

curl_setopt($ch, CURLOPT_URL, $url); 

CURL 工具所需的另一个参数是 Panel API RPC 数据包。数据包示例如下 : 

$packet =


现在示意 CURL 工具从服务器接收请求 , 接受要交付的数据包 , 开始迁移 : 

// 示意 CURL 返回结果 , 而不是加载结果到浏览器中 

curl_setopt($ch, CURLOPT_RETURNTRANSFER, true); 

// 接受要交付的数据包 

curl_setopt($ch, CURLOPT_POSTFIELDS, $packet); 

// 执行 CURL 请求并返回结果 

$retval = curl_exec($ch); 

// 关闭 CURL 会话 

curl_close($ch); 

执行请求后 ,CURL 在客户端获取最终 HTTP 数据包 , 删除 HTTP 标头 ,$retval 参数获取 ’ 

响应 ’ 数据包的 XML 部分。


解析响应 

您可以使用任一 HTTP/FTP 客户库传输请求到 Panel, 并获取结果。多数情况下 , 最终 HTTP 

数据包结构 , 参阅数据包结构章节 ( 第 40 页 )。若使用 CURL 工具 , 返回的最终结果是纯 XML 

格式。 

Panel API RPC 服务器返回的纯 XML 数据包由 XML 模板定义。 

数据包是每个响应 XML 数据包的根节点 , 版本属性返回服务器上运行的 Panel API RPC 协议 

版本。 

特定运算子包含数据包响应 , 或返回的系统 Panel 应用程序错误。 

有关系统和输出节点方式相关信息 , 参阅处理错误章节 ( 第 49 页 )。 

若要了解响应结构 , 则需 agent_output.xsd 模板。此模板列举指定 API RPC 版本支持的所 

有运算子响应数据类型 , 说明符合这些操作的输出模板。 

响应数据包的每个 [operator] 元素中 , 典型的响应数据类型包含一或多个结果元素。此元素由 

复杂类型表示 , 通常包含 common.xsd 模板中定义的类型 resultType: 

 

 

 

 

 

 

 

结果元素也包含可选元素 , 若在复杂类型中定义。 

一般 ,Panel API RPC 服务器返回的数据包格式类似于 :


 

 

 

 

 

... 

 

[ 

 

... 

 

... 

 

... 

 

] 

 

 

 

此处 [operator] 指请求数据包中所用的运算子 ,[operation] 指执行的操作。RESULT 元素总 

是用于隔开请求信息和操作执行状态。RESULT 部分包含表示操作执行状态的 STATUS 元素。 

注意 : 若多个操作请求一个输入数据包 , 真实响应 XML 程序包在一个运算子中包含多个操作 ; 

若多个面板对象需要多个输入数据包 , 响应数据包可以包含多个运算子区域。


处理错误 

服务器报告两类客户软件错误 , 检查错误和执行错误 ( 若执行请求的操作 )。 

若出现错误 ,Panel 管理的服务器返回的描述包含下列参数 : 

• 状态带值 " 错误 " 

• 错误码 – 错误码 , 识别错误的唯一数字 

• 错误文本 – 错误文本 , 错误的文字描述 

common.xsd 模板中的类型 resultType 或按错误类型定义错误描述 ( 取决于运算子 )。 

检查错误 

确定有效并执行之前 , 传入在服务器上经过多次检查的 HTTP 数据包。检查包括 : 

• HTTP-POST 标头检查 

• 检查指定的 API RPC 协议版本是否受支持 

• 检查受权方式 ( 登录凭据或密钥 ) 

• 检查用户的 ‘remote_access_interface’ 权限状态 

• ... 

• 检查数据包是否有效 

• 检查当前版 Panel 中的所需代理是否可用 

检查若失败 , 则无法进一步检查或执行命令。若服务器在任一检查步骤停止 ( 如尚未执行所需 

操作 ), 响应数据包由下列元素组成 : 

• 系统包含错误描述 ; 由 common.xsd 模板中的类型 resultType 定义 

• 输出 , 包含错误组件标准错误信息的可选元素 ( 若不为空 ); 由 plesk_common.xsd 模板中 

的类型 garbageOutput 定义 

例如 , 若从 Panel API RPC 服务器接到响应 , 尝试使用不存在的 API RPC 协议版本 , 结果类 

似于 : 

 

 

error 

1005 

API RPC 协议版本不受支持。 

 

… 

 

执行错误码 

若所有检查都通过 , 所选代理将按顺序执行请求的操作。若操作失败 , 相关代理报告执行错误。 

所有报告由代理工具收集 , 组成基于输出 XML 模板的响应程序包。如若创建站点失败 , 站点运 

算子会使用 domain_output.xsd 模板生成错误响应 :


 

 

 

 

error 

2300 

Failed to add domain. 

 

 

 

 

客户码示例 

本章介绍 PHP,C# 和 VB.NET 中的客户应用程序样本 , 演示如何使用 API RPC 协议。 

PHP 客户应用程序 

下列代码样本是用 PHP 编写的即用型客户应用程序。 

注意 : 若要使用此样本需安装 PHP 4.0.2 或更高版本。 

更多信息 , 请访问 http://php.net/manual/en/ref.dom.php 或 

http://php.net/manual/en/ref.curl.php。 

注释 

class 

ApiRequestException 

function 

domainsInfoRequest() 

扩展标准异类。访问 

http://www.php.net/manual/en/language.exceptions.php 

了解详情。 

使用 DOM 模块编写 XML 请求数据包。返回最终 DOM 对 

象。 

function curlInit() 初始化 CURL 会话 : 

CURLOPT_URL 

CURLOPT_RETURNTRANS 

FER 

CURLOPT_POST 

指定目标 URL: 

设置成 true 表示将从服务 

器返回字符串格式的最终 

输出。 

设置成 true 表示即将通过 

HTTP POST 发送数据包。


CURLOPT_SSL_VERIFYPE 

ER 

CURLOPT_SSL_VERIFYHO 

ST 

CURLOPT_HTTPHEADER 

设置成 false 让 CURL 停止 

验证同类证书。 

设置成 false 让 CURL 停止 

验证主机。 

指定要设置的 HTTP 标头 

字段。 

返回 URL 会话处理器。 

function sendRequest() 

function parseResponse() 

通过 CURL 发送 HTTP 数据包 , 并获取纯 XML 响应数据 

包 ( 无需 HTTP 标头 )。关闭 CURL 会话 , 返回最终数据包 

( 带 XML 标签的纯文本 )。有关 CURL 工具的更多信息 , 访 

问 http://www.php.net/manual/en/ref.curl.php。 

获取响应数据包 ( 纯文本 ) 参数。使用 SimpleXML 分析数 

据包 , 返回 SimpleXMLElement 对象。有关 PHP 

SimpleXML 扩展的更多信息 , 访问 

http://www.php.net/manual/en/ref.simplexml.php。 

function checkResponse() 获取相应数据包 SimpleXMLEelement 并查看结果节点。 

若节点 ' 错误 ', 则函数出现异常 , 字符串传到 errtext 节点。 

main() 函数按顺序调用这些函数。首先调用 domainInfoRequest() 组成如下的数据包 : 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

然后调用 curlInit() 来初始化 CURL 会话。sendRequest 函数发送 HTTP 标头如下的数据包 : 

POST /enterprise/control/agent.php HTTP/1.1 

Host:10.58.32.100:8443 

HTTP_AUTH_LOGIN:login 

HTTP_AUTH_PASSWD:qwedsa 

HTTP_PRETTY_PRINT:TRUE


Content-Length:294 

Content-Type:text/xml 

从 Panel 管理的服务器接收到的响应 XML 数据包如下 : 

 

 

 

 

 

ok 

1234 

 

 

1154513574 

example.com 

example 

64 

0 

46 

192.0.2.33 

none 

 

 

 

 

 

 

收到相应数据包后 , 经过 parseResponse() 函数解析 , 循环执行 iterator, 模拟结果节点上的 

内容。 

代码样本 

formatOutput = true; 

// 

$packet = $xmldoc->createElement('packet'); 

$packet->setAttribute('version', '1.6.2.0'); 

$xmldoc->appendChild($packet); 

//


$domain = $xmldoc->createElement('domain'); 

$packet->appendChild($domain); 

// 

$get = $xmldoc->createElement('get'); 

$domain->appendChild($get); 

} 

// 

$filter = $xmldoc->createElement('filter'); 

$get->appendChild($filter); 

// 

$dataset = $xmldoc->createElement('dataset'); 

$get->appendChild($dataset); 

// dataset elements 

$dataset->appendChild($xmldoc->createElement('hosting')); 

$dataset->appendChild($xmldoc->createElement('gen_info')); 

return $xmldoc; 

/** 

* Prepares CURL to perform the Panel API request 

* @return resource 

*/ 

function curlInit($host, $login, $password) 

{ 

$curl = curl_init(); 

curl_setopt($curl, CURLOPT_URL, 

"https://{$host}:8443/enterprise/control/agent.php"); 

curl_setopt($curl, CURLOPT_RETURNTRANSFER, true); 

curl_setopt($curl, CURLOPT_POST, 

true); 

curl_setopt($curl, CURLOPT_SSL_VERIFYPEER, false); 

curl_setopt($curl, CURLOPT_SSL_VERIFYHOST, false); 

curl_setopt($curl, CURLOPT_HTTPHEADER, 

array("HTTP_AUTH_LOGIN:{$login}", 

"HTTP_AUTH_PASSWD:{$password}", 

"HTTP_PRETTY_PRINT:TRUE", 

"Content-Type:text/xml") 

); 

} 

return $curl; 

/** 

* Performs a Panel API request, returns raw API response text 

* 

* @return string 

* @throws ApiRequestException 

*/ 

function sendRequest($curl, $packet) 

{ 

curl_setopt($curl, CURLOPT_POSTFIELDS, $packet); 

$result = curl_exec($curl); 

if (curl_errno($curl)) { 

$errmsg = curl_error($curl); 

$errcode = curl_errno($curl); 

curl_close($curl); 

throw new ApiRequestException($errmsg, $errcode); 

} 

curl_close($curl); 

return $result; 

}


/** 

* Looks if API responded with correct data 

* 

* @return SimpleXMLElement 


*/ 

function parseResponse($response_string) 

{ 

$xml = new SimpleXMLElement($response_string); 

if (!is_a($xml, 'SimpleXMLElement')) 

throw new ApiRequestException("Cannot parse server 

response:{$response_string}"); 

return $xml; 

} 

/** 

* Check data in API response 

* @return void 


*/ 

function checkResponse(SimpleXMLElement $response) 

{ 

$resultNode = $response->domain->get->result; 

// check if request was successful 

if ('error' == (string)$resultNode->status) 

throw new ApiRequestException("The Panel API returned an error:" 

. (string)$resultNode->result->errtext); 

} 

// 

// int main() 

// 

$host = '10.58.32.100'; 

$login = 'admin'; 

$password = 'qwedsa'; 

$curl = curlInit($host, $login, $password); 

try { 

$response = sendRequest($curl, domainsInfoRequest()->saveXML()); 

$responseXml = parseResponse($response); 

checkResponse($responseXml); 

} catch (ApiRequestException $e) { 

echo $e; 

die(); 

} 

// Explore the result 

foreach ($responseXml->xpath('/packet/domain/get/result') as $resultNode) { 

echo "Domain id:" . (string)$resultNode->id ." "; 

echo (string)$resultNode->data->gen_info->name ." (" . 

(string)$resultNode->data->gen_info->dns_ip_address .")\n"; 

} 

>


C# Client Application 

下列代码样本是用 C# 编写的即用型客户应用程序。 

注释 

类 Request 通过 HTTP 发送请求到 Panel 管理的服务器并接收响应数据包。内容如下 : 

公共字符串主机名 

公共字符串登录 

公共字符串密码 

请求数据包要发送到的 Panel 管理的服务器主机名 

(IP 地址 )。默认是 "localhost"。 

持有 Panel 管理员登录名。默认是 "admin"。 

持有默认管理员的密码。默认是 "setup"。 

公共字符串协议持有与 Panel 互动的 API RPC 协议。 

public ValidationEventHandler 

XmlSchemaValidation 

公共字符串 AgentEntryPoint 

公共字符串 InputValidationSchema 

公共字符串 

OutputValidationSchema 

public XmlDocument Send 

(XmlDocument) 


(Stream) 


(string) 

private HttpWebRequest 

SendRequest (string) 

private XmlDocument 

ParseAndValidate (TextReader, 

string) 

private XmlDocument GetResponse 

(HttpWebRequest) 

用来接收模板验证错误的处理器。 

持有处理服务器上请求数据包的 Panel 代理 URL。 

持有发送给服务器之前应用到请求数据包的验证模 

板 URL。 

持有客户接受之后要应用到响应数据包的验证模板 

URL。 

获取请求数据包 ( 在 XmlDocument 对象表单中 ) 到 

输入参数。在 XmlDocument 对象表单中发送请求 , 

获取响应。 

获取请求数据包 ( 流 ) 到输入参数。使用 

agent_input.xsd 验证模板验证请求数据包。调 

用 Send(XmlDocument) 子函数。 

获取请求数据包 URI (XML 文件 ) 到输入参数。使用 

agent_input.xsd 验证模板验证请求数据包。调 

用 Send(XmlDocument) 子函数。 

生成 HTTP 请求 : 将 HTTP 标头和连续 XML 数据包 

到 HttpWebRequest 类型的对象。返回此对象。 

获取 agent_input.xsd URI 和字符串阅读器 

( 要验证的 XML 数据包 URI) 到输入参数。验证数据 

包 , 并返回树状结构图 (XmlDocument 对象 )。 

获取请求数据包 (HttpWebRequest 对象 ) 到输入参 

数。通过 HTTP 发送数据包 , 从服务器接收响应数 

据包 , 使用 agent_output.xsd 模板验证 , 并返 

回树状结构的响应 XML 数据包 (XmlDocument 对 

象 )。


类 Program 执行 ' 客户 ' 控制台应用程序。 

static void Main (string[]) 

PanelApiRpcClient 应用程序进入点。获取函数队 

列 ( 字符串 ) 到输入参数。选项有 : 

[0] - Panel 管理的服务器主机名 (IP 地址 ) 

[1] - Panel 管理员登录名 

[2] - Panel 管理员密码 

[3] - 所用的 API RPC 协议 

[4] - 内有 XML 请求数据包的 XML 文件。 

函数生成请求类数据包 ( 如上所示 ), 验证 , 发送请 

求到 Panel, 然后打印出最终 XML 数据包。 

private static bool 

RemoteCertificateValidation 

(object, X509Certificate, 

X509Chain, SslPolicyErrors) 

private static void 

XmlSchemaValidation (object, 

ValidationEventArgs) 

static void 

PrintResult(XmlDocument) 

函数验证远程 SSL 证书来授权服务器。若服务器未 

经授权 , 返回 false。 

验证错误事件处理器。 

函数输出响应数据包 (XmlDocument 对象 ) 到控制 

台。


可从命令行启动客户应用程序 : 

PanelApiRpcClient 192.0.2.168 admin_login admin_passwd 1.6.2.0 

"c:\requests\AddNewDomain.xml" 

请求数据包川到 AddNewDomain.xml 文件 : 

 

 

 

 

 

example.com 

192.0.2.48 

 

 

 

 

ftp_login 

fpt16se4fdf0 

 

 

ftp_password 

qweqwe 

 

192.0.2.48 

 

 

 

 

 

从管理的服务器接收到的响应数据包如下 : 

 

 

 

 

 

ok 

6 

5c0e3881-22a2-4401-bcc0-881d691bfdef 

 

 

 

 

此数据包返回 add 操作结果 , 以及刚创建站点的 ID 和 GUID。 

代码样本 

使用系统 ; 

使用 System.Net; 

使用 System.Text; 

使用 System.IO; 

使用 System.Xml; 

使用 System.Xml.Schema; 

使用 System.Security.Cryptography.X509Certificates;


使用 System.Net.Security; 

命名空间 PanelApiRpcClient 

{ 

公共类请求 

{ 

// Public interface 

// 

public string Hostname = "localhost"; // Panel Hostname 

public string Login = "admin_login"; // 

Administrator's Login 

public string Password = "admin_passwd"; // 

Administrator's Password 

public string Protocol = "1.6.2.0"; // API RPC Version 

Protocol. 

(DTD), 

(XSD) 

// Handler for receiving information about document type definition 

// XML-Data Reduced (XDR) schema, and XML Schema definition language 

// schema validation errors. 

public ValidationEventHandler XmlSchemaValidation = null; 

public Request() 

{ 

} 

public string AgentEntryPoint { get { return "https://" + 

Hostname + ":8443/enterprise/control/agent.php"; } } 

public string InputValidationSchema { get { return "https://" + 

Hostname + ":8443/schemas/rpc/" + Protocol + "/agent_input.xsd"; } } 

public string OutputValidationSchema { get { return "https://" + 

Hostname + ":8443/schemas/rpc/" + Protocol + "/agent_output.xsd"; } } 

public XmlDocument Send(XmlDocument packet) 

{ 

HttpWebRequest request = SendRequest(packet.OuterXml); 

XmlDocument result = GetResponse(request); 

return result; 

} 

public XmlDocument Send(Stream packet) 

{ 

using (TextReader reader = new StreamReader(packet)) 

{ 

return Send(ParseAndValidate(reader, 

InputValidationSchema)); 

} 

} 

public XmlDocument Send(string packetUri) 

{ 

using (TextReader reader = new StreamReader(packetUri)) 

{ 

return Send(ParseAndValidate(reader, 

InputValidationSchema)); 

} 

} 

// Private interface 

//


// Sending a request message 

// 

private HttpWebRequest SendRequest(string message) 

{ 

HttpWebRequest request = 

(HttpWebRequest)WebRequest.Create(AgentEntryPoint); 

request.Method = "POST"; 

request.Headers.Add("HTTP_AUTH_LOGIN", Login); 

request.Headers.Add("HTTP_AUTH_PASSWD", Password); request.ContentType = 

"text/xml"; request.ContentLength = message.Length; 

ASCIIEncoding encoding = new ASCIIEncoding(); byte[] buffer 

= encoding.GetBytes(message); 

using (Stream stream = request.GetRequestStream()) 

{ 

stream.Write(buffer, 0, message.Length); 

} 

} 

return request; 

// Parsing and validating packet 

// 

private XmlDocument ParseAndValidate(TextReader xml, string 

schemaUri) 

{ 

XmlSchemaSet schemas = new XmlSchemaSet(); 

schemas.Add(null, schemaUri); 

XmlReaderSettings settings = new XmlReaderSettings(); if 

(XmlSchemaValidation != null) 

settings.ValidationEventHandler += new 

ValidationEventHandler(XmlSchemaValidation); 

settings.ValidationType = ValidationType.Schema; 

settings.ValidationFlags |= 

XmlSchemaValidationFlags.ProcessSchemaLocation; 

settings.Schemas = schemas; 

XmlDocument document = new XmlDocument(); 

using (XmlReader reader = XmlTextReader.Create(xml, 

settings)) 

{ 

document.Load(reader); 

} 

return document; 

} 

private XmlDocument GetResponse(HttpWebRequest request) 

{ 

using (HttpWebResponse response = 

(HttpWebResponse)request.GetResponse()) 

using (Stream stream = response.GetResponseStream()) 

using (TextReader reader = new StreamReader(stream)) 

{ 

return ParseAndValidate(reader, 

OutputValidationSchema); 

} 

} 

} 

class Program 

{ 

static void Main(string[] args)


{ 

if (args.Length < 5) 

{ 

Console.WriteLine("Usage:PanelApiRpcClient 

"); 

Console.WriteLine(" "); 

Console.WriteLine(" Hostname - Panel host name"); 

Console.WriteLine(" Login - Administrator's 

login"); 

Console.WriteLine(" Password - Administrator's 

password"); 

Console.WriteLine(" Protocol - API RPC protocol 

version"); 

Console.WriteLine(" Request - Request file path 

(*.xml)"); 

return; 

} 

// Verifies the remote Secure Sockets Layer (SSL) certificate 

// used for authentication. 

ServicePointManager.ServerCertificateValidationCallback = 

new 

RemoteCertificateValidationCallback(RemoteCertificateValidation); 

Request request = new Request(); request.XmlSchemaValidation 

= XmlSchemaValidation; 

request.Hostname = args[0]; // "10.49.8.120"; 

request.Login = args[1]; // "admin"; 

request.Password = args[2]; // "setup"; 

request.Protocol = args[3]; // "1.6.2.0"; 

string packet 

= args[4]; // "request.xml"; 

} 

try 

{ 

XmlDocument result = request.Send(packet); 

PrintResult(result); 

} 

catch (Exception e) 

{ 

Console.WriteLine("Request error:{0}", e.Message); 

} 

// The following method is invoked by the 

RemoteCertificateValidationDelegate. 

private static bool RemoteCertificateValidation(object sender, 

X509Certificate certificate, X509Chain chain, 

SslPolicyErrors sslPolicyErrors) 

{ 

if (sslPolicyErrors != 

SslPolicyErrors.RemoteCertificateNotAvailable) 

return true; 

Console.WriteLine("Certificate error:{0}", 

sslPolicyErrors); 

// Do not allow this client to communicate with 

unauthenticated servers. 

return false; 

} 

//


private static void XmlSchemaValidation(object sender, 

ValidationEventArgs e) 

{ 

Console.WriteLine("Validation error:{0}", e.Message); 

} 

} 

} 

static void PrintResult(XmlDocument document) 

{ 

XmlTextWriter writer = new XmlTextWriter(Console.Out); 

writer.Formatting = Formatting.Indented; 

document.WriteTo(writer); 

writer.Flush(); 

Console.WriteLine(); 

} 

VB.NET 客户应用程序 

下列代码样本是用 VB.NET 编写的即用型客户应用程序。 

注释 

类 Request 通过 HTTP 发送请求到 Panel 管理的服务器并接收响应数据包。内容如下 : 

公共字符串主机名 

公共字符串登录 

公共字符串密码 

请求数据包要发送到的 Panel 管理的服务器主机名 

(IP 地址 )。默认是 "localhost"。 

持有 Panel 管理员登录名。默认是 "admin"。 

持有默认管理员的密码。默认是 "setup"。 

公共字符串协议持有与 Panel 互动的 API RPC 协议。 

public XmlSchemaValidation 用来接收模板验证错误的处理器。 

Public ReadOnly Property 

AgentEntryPoint 


InputValidationSchema 


OutputValidationSchema 

Public Function Send(ByVal 

packet As XmlDocument) 


packet As Stream) 


packetUri As String) 

持有处理服务器上请求数据包的 Panel 代理 URL。 

持有发送给服务器之前应用到请求数据包的验证模 

板 URL。 

持有客户接受之后要应用到响应数据包的验证模板 

URL。 

获取请求数据包 ( 在 XmlDocument 对象表单中 ) 到 

输入参数。在 XmlDocument 对象表单中发送请求 , 

获取响应。 

获取请求数据包 ( 流 ) 到输入参数。Validates the 

request packet using the validation schema. 调用 

Send(XmlDocument) 子函数。 

获取请求数据包 URI (XML 文件 ) 到输入参数。 

Validates the request packet using the validation 

schema. 调用 Send(XmlDocument) 子函数。


Private Function 

SendRequest(ByVal message As 

String) 


ParseAndValidate(ByVal xml As 

TextReader, ByVal schemaUri As 

String) 


GetResponse(ByVal request As 

HttpWebRequest) 

生成 HTTP 请求 : 将 HTTP 标头和连续 XML 数据包 

到 HttpWebRequest 类型的对象。返回此对象。 

获取验证模板 URI 和字符串阅读器 ( 要验证的 XML 

数据包 URI) 到输入参数。验证数据包 , 并返回树状 

结构图 (XmlDocument 对象 )。 

获取请求数据包 (HttpWebRequest 对象 ) 到输入参 

数。通过 HTTP 发送数据包 , 从服务器接收响应数据 

包 , 使用模板验证 , 并返回树状结构的响应 XML 数 

据包 (XmlDocument 对象 )。


类 Program 执行 ' 客户 ' 控制台应用程序。 

Shared Sub Main(ByVal args As 

String()) 

Private Shared Function 

RemoteCertificateValidation( 

ByVal sender As Object, ByVal 

certificate As 

X509Certificate, ByVal chain 

As X509Chain, ByVal 

sslPolicyErrors As 

SslPolicyErrors) 

PanelApiRpcClient 应用程序进入点。获取函数 

队列 ( 字符串 ) 到输入参数。选项有 : 

[0] - Panel 管理的服务器主机名 (IP 地址 ) 

[1] - Panel 管理员登录名 

[2] - Panel 管理员密码 

[3] - 所用的 API RPC 协议 

[4] - 内有 XML 请求数据包的 XML 文件。 

函数生成请求类数据包 ( 如上所示 ), 验证 , 发送 

请求到 Panel, 然后打印出最终 XML 数据包。 

函数验证远程 SSL 证书来授权服务器。若服务 

器未经授权 , 返回 false。 

Private Shared Sub 

XmlSchemaValidation(ByVal 

sender As Object, ByVal e As 

ValidationEventArgs) 

验证错误事件处理器。 

Private Shared Sub 

PrintResult(ByVal document As 

XmlDocument) 

函数输出响应数据包 (XmlDocument 对象 ) 到 

控制台。 

可从命令行启动客户应用程序 : 

PanelApiRpcClient 192.0.2.168 admin_login admin_passwd 1.6.2.0 

"c:\requests\request.xml" 

请求数据包川到 request.xml 文件 : 

 

 

 

 

 

example.com 

192.0.2.48


 

 

 

 

ftp_login 

fp16se4fdf0 

 

 

ftp_password 

qweqwe 

 

192.0.2.48 

 

 

 

 

 

从管理的服务器接收到的响应数据包如下 : 

 

 

 

 

 

ok 

6 

5c0e3881-22a2-4401-bcc0-881d691bfdef 

 

 

 

 

此数据包返回 add 操作结果 , 以及刚创建站点的 ID 和 GUID。 

代码样本 

导入系统 

Imports System.Net 

Imports System.Text 

Imports System.IO 

Imports System.Xml 

Imports System.Xml.Schema 

Imports System.Security.Cryptography.X509Certificates 

Imports System.Net.Security 

Namespace ParallelsPanelApiRpcClient 

Public Class Request 

' Public interface 

Public Hostname As String = "localhost" 'The Panel Host name 

Public Login As String = "admin_login" // 

Administrator's Login 

Public Password As String = "admin_setup" 

'Administrator's Password 

Public Protocol As String = "1.6.2.0" 'API RPC Version 

Protocol 

(DTD), 

(XSD) 

' Handler for receiving information about document type definition 

' XML-Data Reduced (XDR) schema, and XML Schema definition language


' schema validation errors. 

Public XmlSchemaValidation As ValidationEventHandler 

Public ReadOnly Property AgentEntryPoint As String 

Get 

Return ("https://" & Me.Hostname & 

":8443/enterprise/control/agent.php") 

End Get 

End Property 

Public ReadOnly Property InputValidationSchema As String 

Get 

Return String.Concat(New String() { "https://", 

Me.Hostname, ":8443/schemas/rpc/", Me.Protocol, "/agent_input.xsd" }) 

End Get 

End Property 

Public ReadOnly Property OutputValidationSchema As String 

Get 

Return String.Concat(New String() { "https://", 

Me.Hostname, ":8443/schemas/rpc/", Me.Protocol, "/agent_output.xsd" }) 

End Get 

End Property 

Public Function Send(ByVal packet As XmlDocument) As XmlDocument 

Dim request As HttpWebRequest = 

Me.SendRequest(packet.OuterXml) 

Return Me.GetResponse(request) 

End Function 

Public Function Send(ByVal packet As Stream) As XmlDocument 

Using reader As TextReader = New StreamReader(packet) 

Return Me.Send(Me.ParseAndValidate(reader, 

Me.InputValidationSchema)) 

End Using 

End Function 

Public Function Send(ByVal packetUri As String) As XmlDocument 

Using reader As TextReader = New StreamReader(packetUri) 

Return Me.Send(Me.ParseAndValidate(reader, 

Me.InputValidationSchema)) 

End Using 

End Function 

' Private interface 

' 

' Sending a request message 

' 

Private Function SendRequest(ByVal message As String) As 

HttpWebRequest 

Dim request As HttpWebRequest = 

DirectCast(WebRequest.Create(Me.AgentEntryPoint), HttpWebRequest) 

request.Method = "POST" 

request.Headers.Add("HTTP_AUTH_LOGIN", Me.Login) 

request.Headers.Add("HTTP_AUTH_PASSWD", Me.Password) 

request.ContentType = "text/xml" 

request.ContentLength = message.Length 

Dim bytes As Byte() = New ASCIIEncoding().GetBytes(message) 

Using stream As Stream = request.GetRequestStream 

stream.Write(bytes, 0, message.Length) 

End Using 

Return request 

End Function 

' Parsing and validating packet 

'


Private Function ParseAndValidate(ByVal xml As TextReader, ByVal 

schemaUri As String) As XmlDocument 

Dim schemas As New XmlSchemaSet 

schemas.Add(Nothing, schemaUri) 

Dim settings As New XmlReaderSettings 

If (Not Me.XmlSchemaValidation Is Nothing) Then 

AddHandler settings.ValidationEventHandler, New 

ValidationEventHandler(AddressOf Me.XmlSchemaValidation.Invoke) 

End If 

settings.ValidationType = ValidationType.Schema 

settings.ValidationFlags = (settings.ValidationFlags Or 

XmlSchemaValidationFlags.ProcessSchemaLocation) 

settings.Schemas = schemas 

Dim document As New XmlDocument 

Using reader As XmlReader = XmlReader.Create(xml, settings) 

document.Load(reader) 

End Using 

Return document 

End Function 

Private Function GetResponse(ByVal request As HttpWebRequest) As 

XmlDocument 

Using response As HttpWebResponse = 

DirectCast(request.GetResponse, HttpWebResponse) 

Using stream As Stream = response.GetResponseStream 

Using reader As TextReader = New 

StreamReader(stream) 

return Me.ParseAndValidate(reader, 

Me.OutputValidationSchema) 

End Using 

End Using 

End Using 

End Function 

End Class 

友好类程序 

Shared Sub Main(ByVal args As String()) 

If (args.Length < 5) Then 

Console.WriteLine("Usage:PanelApiRpcClient 

") 

Console.WriteLine(" ") 

Console.WriteLine(" Host name - The Panel's host name") 

Console.WriteLine(" Login - Administrator's login") 

Console.WriteLine(" Password - Administrator's 

password") 

Console.WriteLine(" Protocol - API RPC protocol 

version") 

Console.WriteLine(" Request - Request file path 

(*.xml)") 

Else 

' Verifies the remote Secure Sockets Layer (SSL) 

certificate 

' used for authentication. 

ServicePointManager.ServerCertificateValidationCallback = New 

RemoteCertificateValidationCallback(AddressOf 

Program.RemoteCertificateValidation) 

Dim request As New Request


request.XmlSchemaValidation = New 

ValidationEventHandler(AddressOf Program.XmlSchemaValidation) 

request.Hostname = args(0) 

' 

"10.49.8.120"; 

request.Login = args(1) 

' "admin"; 

request.Password = args(2) 

' "setup"; 

request.Protocol = args(3) 

' 

"1.6.2.0"; 

Dim packetUri As String = args(4) ' "request.xml"; 

Try 

Program.PrintResult(request.Send(packetUri)) 

Catch exception As Exception 

Console.WriteLine("Request error:{0}", 

exception.Message) 

End Try 

End If 

End Sub 

' The following method is invoked by the 


Private Shared Function RemoteCertificateValidation(ByVal sender 

As Object, ByVal certificate As X509Certificate, ByVal chain As X509Chain, ByVal 

sslPolicyErrors As SslPolicyErrors) As Boolean 

If (sslPolicyErrors 

SslPolicyErrors.RemoteCertificateNotAvailable) Then 

Return True 

End If 

Console.WriteLine("Certificate error:{0}", 

sslPolicyErrors) 

' Do not allow this client to communicate with unauthenticated 

servers. 

Return False 

End Function 

' 

Private Shared Sub XmlSchemaValidation(ByVal sender As Object, 

ByVal e As ValidationEventArgs) 

Console.WriteLine("Validation error:{0}", e.Message) 

End Sub 

Private Shared Sub PrintResult(ByVal document As XmlDocument) 

Dim w As New XmlTextWriter(Console.Out) 

w.Formatting = Formatting.Indented 

document.WriteTo(w) 

w.Flush 

Console.WriteLine 

End Sub 

End Class 

End Namespace


设置 Panel 

本章详细阐述如何使用远程 API 执行 Panel 设置操作。 


若要通过 API RPC 初始化 Panel, 使用 smb/initial_setup 操作模式执行 XML 请求数据包 : 

 

 

 

... 

 

 

 

请求数据包结构 

initial_setup 节点结构如下 : 

• password, required 

指定 Panel 管理员新密码。数据类型 :serverPassword (plesk_server.xsd).5 到 14 个 

字符。 

• admin_email, required 

指定 Panel 管理员邮件地址。数据类型 :emailType (common.xsd).3 到 255 个字符。 

• locale, optional 

指定 Panel 语言 - Panel 界面上要使用的语言数据类型 : 字符串。


请求样本 

初始化 Panel 的请求数据包类似于 : 

 

 

 

P4$$w0rd 


 

 

 

初始化 Panel 的请求数据包默认语言是德语 ( 德国 ) 类似于 : 

 

 

 

P4$$w0rd 


de-DE 

 

 

 

响应数据包结构 

输出 XML 数据包的 initial_setup 节点结构如下 :


• result, required 

包含从服务器检索到的响应。数据类型 :resultType (common.xsd). 

• status, required 

指定操作执行状态。数据类型 : 字符串。允许的值 :ok | error. 

• errcode, required 若操作失败 

返回错误码。数据类型 : 整数。 

• errtext, required 数据类型 : 

返回错误消息。数据类型 : 字符串。 

特定操作错误 

• 1003, 代理工具初始化错误。 

Panel 已初始化。 

• 1019, 无效值。 

指定语言不可用。


响应样本 

从服务器接收到的正响应如下 : 

 

 

 

 

ok 

 

 

 

 

若 Panel 已初始化 , 则有下列负响应。 

 

 

 

 

error 

1003 

Initial setup already completed 

 

 

 

 

若指定语言不可用 , 则有下列负响应。 

 

 

 

 

error 

1019 

Locale en-US2 is not installed on server 

 

 

 

 


若要使用 API RPC 安装许可证 , 使用 server/lic_install 操作模式执行 XML 请求数据包 : 

 

 

 

... 

 

 



安装许可证的请求 XML 数据包 , 包括 server/lic_install 操作模式 , 结构如下 : 

• license, required 

包含许可证数据。数据类型 :base64。 

• additional_key, optional 

若要安装附加许可证 , 请指定。数据类型 : 无。


请求样本 

此数据包安装 Parallels Small Business Panel for Linux/Unix 默认许可证 : 

 


 

PD94bWwgdmVyc2lvbj0iMS4wIiBlbmNvZGluZz0iVVRGLTgiID8+IA0KLSA8cHAtc2 

1iLXVuaXgtMTA6a2V5IGNvcmU6Zm9ybWF0PSJvcGVuZnVzaW9uLTMiIHhtbG5zOmNvcmU9Imh0d 

HA6Ly9wYXJhbGxlbHMuY29tL3NjaGVtYXMva2V5cy9jb3JlLzMiIHhtbG5zOnBwLXNtYi11bml4 

LTEwPSJodHRwOi8vcGFyYWxsZWxzLmNvbS9zY2hlbWFzL2tleXMvcHJvZHVjdHMvcHAtc21iL3V 

uaXgvMTAuMCI+DQotIDwhLS0gVW5pcXVlIHByb2R1Y3QgS2V5IG51bWJlcg0KICAtLT4gDQogID 

xjb3JlOmtleS1udW1iZXIgY29yZTp0eXBlPSJzdHJpbmciPlNNQi4wMDAwMDAwMDwvY29yZTprZ 

XktbnVtYmVyPiANCi0gPCEtLSBLZXkgdmVyc2lvbg0KICAtLT4gDQogIDxjb3JlOmtleS12ZXJz 

aW9uIGNvcmU6dHlwZT0ic3RyaW5nIj4wMDAwPC9jb3JlOmtleS12ZXJzaW9uPiANCi0gPCEtLSB 

LZXkgZGVzY3JpcHRpb24NCiAgLS0+IA0KLSA8Y29yZTpkZXNjcmlwdGlvbj4NCiAgPGNvcmU6a2 

V5dHlwZT5QYXJhbGxlbHMgUGFuZWwgMTAgU01CIEVkaXRpb24gZm9yIFVuaXgvTGludXg8L2Nvc 

mU6a2V5dHlwZT4gDQogIDwvY29yZTpkZXNjcmlwdGlvbj4NCi0gPCEtLSBQcm9kdWN0IHdoaWNo 

IHRoaXMgbGljZW5zZSBpcyBpbnRlbmRlZCB0byB3b3JrIG9uDQogIC0tPiANCiAgPGNvcmU6cHJ 

vZHVjdCBjb3JlOnR5cGU9InN0cmluZyI+cHAtc21iLXVuaXg8L2NvcmU6cHJvZHVjdD4gDQotID 

whLS0gU3VwcG9ydGVkIHByb2R1Y3QgdmVyc2lvbg0KICAtLT4gDQogIDxjb3JlOnZlcnNpb24gY 

29yZTp0eXBlPSJzdHJpbmciPjEwLjA8L2NvcmU6dmVyc2lvbj4gDQotIDwhLS0gRGF0ZSBhZnRl 

ciB3aGljaCB0aGlzIGxpY2Vuc2UgYmVjb21lcyB1c2FibGUgKGluY2x1c2l2ZSkNCiAgLS0+IA0 

KICA8Y29yZTpzdGFydC1kYXRlIGNvcmU6dHlwZT0iZGF0ZSI+aW5zdGFudDwvY29yZTpzdGFydC 

1kYXRlPiANCi0gPCEtLSBEYXRlIGJlZm9yZSB3aGljaCB0aGlzIGxpY2Vuc2UgaXMgdXNhYmxlI 

ChleGNsdXNpdmUpDQogIC0tPiANCiAgPGNvcmU6ZXhwaXJhdGlvbi1kYXRlIGNvcmU6dHlwZT0i 

ZGF0ZSI+bmV2ZXI8L2NvcmU6ZXhwaXJhdGlvbi1kYXRlPiANCi0gPCEtLSBVUkwgb2YgdGhlIHN 

lcnZpY2UgZW5kcG9pbnQgdG8gdXNlIHdoZW4gcGVyZm9ybWluZyBhbiBhdXRvdXBkYXRlDQogIC 

0tPiANCiAgPGNvcmU6bGljZW5zZS1zZXJ2ZXItdXJsIGNvcmU6dHlwZT0ic3RyaW5nIj5odHRwc 

zovL2thLnBhcmFsbGVscy5jb206NTIyNC94bWxycGM8L2NvcmU6bGljZW5zZS1zZXJ2ZXItdXJs 

PiANCi0gPCEtLSBEYXRlIHdoZW4gcHJvZHVjdCB3aWxsIHRyeSB0byBwZXJmb3JtIGFuIGF1dG9 

1cGRhdGUNCiAgLS0+IA0KICA8Y29yZTp1cGRhdGUtZGF0ZSBjb3JlOnR5cGU9ImRhdGUiPmluc3 

RhbnQ8L2NvcmU6dXBkYXRlLWRhdGU+IA0KICA8Y29yZTp1cGRhdGUtdGlja2V0IGNvcmU6aGlkZ 

GVuPSJ0cnVlIiBjb3JlOnR5cGU9InN0cmluZyI+LS0tLS0tc21iXzEwX3VuaXhfZGVmYXVsdC0t 

LS0tLS08L2NvcmU6dXBkYXRlLXRpY2tldD4gDQotIDwhLS0gU01CIFVzZXJzDQogIC0tPiANCiA 

gPHBwLXNtYi11bml4LTEwOnNtYi11c2VycyBjb3JlOnR5cGU9ImludGVnZXIiPjE8L3BwLXNtYi 

11bml4LTEwOnNtYi11c2Vycz4gDQotIDwhLS0gTnVtYmVyIG9mIGRvbWFpbnMNCiAgLS0+IA0KI 

CA8cHAtc21iLXVuaXgtMTA6ZG9tYWlucyBjb3JlOnR5cGU9ImludGVnZXIiPjE8L3BwLXNtYi11 

bml4LTEwOmRvbWFpbnM+IA0KLSA8IS0tIEFiaWxpdHkgdG8gdXNlIFNwYW1Bc3Nhc3Npbg0KICA 

tLT4gDQogIDxwcC1zbWItdW5peC0xMDpzcGFtYXNzYXNpbi1zdXBwb3J0IGNvcmU6dHlwZT0iYm 

9vbGVhbiI+dHJ1ZTwvcHAtc21iLXVuaXgtMTA6c3BhbWFzc2FzaW4tc3VwcG9ydD4gDQotIDwhL 

S0gQVBTIEFwcGxpY2F0aW9uDQogIC0tPiANCiAgPHBwLXNtYi11bml4LTEwOmFwcy1hcHAgY29y 

ZTp0eXBlPSJzdHJpbmciPmh0dHA6Ly93d3cubWFnaWNzcGFtLmNvbS88L3BwLXNtYi11bml4LTE 

wOmFwcy1hcHA+IA0KLSA8IS0tIEFQUyBBcHBsaWNhdGlvbg0KICAtLT4gDQogIDxwcC1zbWItdW 

5peC0xMDphcHMtYXBwIGNvcmU6dHlwZT0ic3RyaW5nIj5odHRwOi8vd3d3LnBpbm5hY2xlY2Fyd 

C5jb20vPC9wcC1zbWItdW5peC0xMDphcHMtYXBwPiANCi0gPCEtLSBBUFMgQXBwbGljYXRpb24N 

CiAgLS0+IA0KICA8cHAtc21iLXVuaXgtMTA6YXBzLWFwcCBjb3JlOnR5cGU9InN0cmluZyI+aHR 

0cHM6Ly93d3cua2VlcGl0LmNvbS91bmxpbWl0ZWQ8L3BwLXNtYi11bml4LTEwOmFwcy1hcHA+IA 

0KLSA8IS0tIEFQUyBBcHBsaWNhdGlvbg0KICAtLT4gDQogIDxwcC1zbWItdW5peC0xMDphcHMtY 

XBwIGNvcmU6dHlwZT0ic3RyaW5nIj5odHRwOi8vd3d3LnN5bWFudGVjLmNvbS9ub3J0b24vaW50 

ZXJuZXQtc2VjdXJpdHk8L3BwLXNtYi11bml4LTEwOmFwcy1hcHA+IA0KLSA8IS0tIEFQUyBBcHB 

saWNhdGlvbg0KICAtLT4gDQogIDxwcC1zbWItdW5peC0xMDphcHMtYXBwIGNvcmU6dHlwZT0ic3 

RyaW5nIj5odHRwOi8vd3d3LmludGVyc3BpcmUuY29tL2VtYWlsbWFya2V0ZXIvPC9wcC1zbWItd 

W5peC0xMDphcHMtYXBwPiANCi0gPCEtLSBBUFMgQXBwbGljYXRpb24NCiAgLS0+IA0KICA8cHAt 

c21iLXVuaXgtMTA6YXBzLWFwcCBjb3JlOnR5cGU9InN0cmluZyI+aHR0cDovL3d3dy5pbnRlcnN 

waXJlLmNvbS9rbm93bGVkZ2VtYW5hZ2VyLzwvcHAtc21iLXVuaXgtMTA6YXBzLWFwcD4gDQotID 

xkc2lnOlNpZ25hdHVyZSB4bWxuczpkc2lnPSJodHRwOi8vd3d3LnczLm9yZy8yMDAwLzA5L3htb 

GRzaWcjIj4NCi0gPGRzaWc6U2lnbmVkSW5mbz4NCiAgPGRzaWc6Q2Fub25pY2FsaXphdGlvbk1l 

dGhvZCBBbGdvcml0aG09Imh0dHA6Ly9wYXJhbGxlbHMuY29tL3NjaGVtYXMva2V5cy9jb3JlLzM 

jY2Fub25pY2FsaXplIiAvPiANCiAgPGRzaWc6U2lnbmF0dXJlTWV0aG9kIEFsZ29yaXRobT0iaH 

R0cDovL3d3dy53My5vcmcvMjAwMS8wNC94bWxkc2lnLW1vcmUjcnNhLXNoYTI1NiIgLz4gDQotI 

Dxkc2lnOlJlZmVyZW5jZSBVUkk9IiI+DQotIDxkc2lnOlRyYW5zZm9ybXM+DQogIDxkc2lnOlRy 

YW5zZm9ybSBBbGdvcml0aG09Imh0dHA6Ly93d3cudzMub3JnL1RSLzIwMDEvUkVDLXhtbC1jMTR 

uLTIwMDEwMzE1I1dpdGhDb21tZW50cyIgLz4gDQogIDxkc2lnOlRyYW5zZm9ybSBBbGdvcml0aG 

09Imh0dHA6Ly9wYXJhbGxlbHMuY29tL3NjaGVtYXMva2V5cy9jb3JlLzMjdHJhbnNmb3JtIiAvP 

iANCiAgPC9kc2lnOlRyYW5zZm9ybXM+DQogIDxkc2lnOkRpZ2VzdE1ldGhvZCBBbGdvcml0aG09


Imh0dHA6Ly93d3cudzMub3JnLzIwMDEvMDQveG1sZW5jI3NoYTI1NiIgLz4gDQogIDxkc2lnOkR 

pZ2VzdFZhbHVlPlRrUzk2YnlycEpVdTVpUTdIbkhZYUhhMTIra2lPYmZhRXBYMC9TWU5iV2M9PC 

9kc2lnOkRpZ2VzdFZhbHVlPiANCiAgPC9kc2lnOlJlZmVyZW5jZT4NCiAgPC9kc2lnOlNpZ25lZ 

EluZm8+DQogIDxkc2lnOlNpZ25hdHVyZVZhbHVlPmZvcUxYVFErTWhRUm44Y2NzSmdoU1ZhNUJU 

Vi9kaUtaVGJjdk9qUnBXcW5XaDlXei9NQmFKY0pDNnFnZUNkMHJ4OFZsWERxcm0yVUYgS1I1d0d 

WeFM1ZSt6NWNqREFEcVUyRStGOXRaUndubXRuamZ4dHV0THZibjVyS0FYc1VtWTQ2OU1EcjNQeF 

RYbi9mYjZycmpvbGZOOCBOWVE1WUVtMDkyd3IrWTg2TGNIVkhKM2ZXK01sQWd3WXpua0lzdFVQS 

E1JMVVkYlgwZWkvWTFmcStSc0dSSnNhZ2dRNW56MzgralV5IFRvUDBRK2VrUnAxcUFVa09OWUYy 

M21FT1FuQ2V5eFNqQ3FrejNyZEhkaVFFQTBKcmhYMGowYWZYWDJkL2JRUnZVeU93UFBsVWhzNU4 

gY3FjcndRRDdMQ0lsOE9Udk5FaFRrNFo0OGdaM1ZIRzJ2bitpVGc9PTwvZHNpZzpTaWduYXR1cm 

VWYWx1ZT4gDQotIDxkc2lnOktleUluZm8+DQotIDxkc2lnOlg1MDlEYXRhPg0KICA8ZHNpZzpYN 

TA5Q2VydGlmaWNhdGU+TUlJRW5EQ0NBb1FDQVJFd0RRWUpLb1pJaHZjTkFRRUZCUUF3Z2FZeEN6 

QUpCZ05WQkFZVEFrSk5NUXN3Q1FZRFZRUUlFd0pJVFRFUiBNQThHQTFVRUJ4TUlTR0Z0YVd4MGI 

yNHhIREFhQmdOVkJBb1RFMU5YYzI5bWRDQkliMnhrYVc1bmN5Qk1kR1F4SFRBYkJnTlZCQXNUIE 

ZFbHVkR1Z5Ym1Gc0lFUmxkbVZzYjNCdFpXNTBNUnd3R2dZRFZRUURFeE5MUVNCeWIyOTBJR05sY 

25ScFptbGpZWFJsTVJ3d0dnWUogS29aSWh2Y05BUWtCRmcxcllVQnpkM052Wm5RdVkyOXRNQjRY 

RFRBNU1EWXdNakEyTURrek0xb1hEVE0yTVRBeE9EQTJNRGt6TTFvdyBnWUF4Q3pBSkJnTlZCQVl 

UQWtKTk1Rc3dDUVlEVlFRSUV3SklUVEVSTUE4R0ExVUVCeE1JU0dGdGFXeDBiMjR4SERBYUJnTl 

ZCQW9UIEUxTlhjMjltZENCSWIyeGthVzVuY3lCTWRHUXhIVEFiQmdOVkJBc1RGRWx1ZEdWeWJtR 

nNJRVJsZG1Wc2IzQnRaVzUwTVJRd0VnWUQgVlFRREV3dHdjQzF6YldJdGRXNXBlRENDQVNJd0RR 

WUpLb1pJaHZjTkFRRUJCUUFEZ2dFUEFEQ0NBUW9DZ2dFQkFNYzR0RWVhRFMzciBDS0sxQ1RaUm9 

aMTdGVzU5Z0tBbTlOQmt6V3ZwZW9VM0lnZU5SMTMrdWs0My9lYW1EQkNHZTBtQnNwb05vWjErWD 

k3RXVGYzB4b2RvIGg0NVgrRUNIZk5kME1adzVrSFljWWF1M2kxSVBBakZMdm5DcE52ZXc1WHpXQ 

zcwZ0xlenZNaWxRbWxTYWpLSEFEL0EvMGhzYkI0aDkgeVdxNTZPcDRiT1hUTDVKN0NZV1JHeVRS 

aFV1MnFPbjZ2Y2o3Q2Rkb05oeWhRdDJTYlArNDlVMXFJdjMvOFZ3YnZrMzZhTVlTVlBlMSBHRk5 

0MlE3RkhKUUxicW1pY1doL0JBWkpjU2FGMWlPSUhuZ2VIbG9uSGptbzdJWUEvSXcyTUZMT0dPam 

82Kzg2M0dUbDJUOXA0dGxGIHZHNWhOMWFpNHkybDdOVzFTczhVT1JSclVlMENBd0VBQVRBTkJna 

3Foa2lHOXcwQkFRVUZBQU9DQWdFQUgrcnFFdkhNdEFRaStWOHEgSDdFM3VSRk8xaVA1QzBVejlD 

QVdMZ0QyNWthWTlSaUV1K1ZNcGtyZ2RwMkRKZUxIaWd5Q3MyM3dUbkZ6SS9qMUJNRjJ1VGdKS1B 

6MiBSOTA2YVcyR0tJWWpIencvd3BmUDUxck9CWTVQNlhpdXNtM2NGdk8zTnJ4Z0hJSy9WV3N5WW 

1EN25mMksyZUptQmsvZU85TklaalBoIGRkS2NrYmNZRVhRN3dzd2l0dDlYcTFuckg2eFNXT1lIV 

UUwcHI0QW1jVXc3TDdRQVUzdDBVM0lIQzNHYmVyVE1RNERSL2xDTFV5a24gUkl3aDNKQXZkYVFJ 

ZnA2TW9yNkY0VWtrMWh2bzkwVTR1VHFEbXc4RFJHcVRoOCtPUEY1V1dTL0MyK0o0bThOWTNDWjZ 

pa3FIc0FpcCB5Si9uR1pqU3cvdHc4N0xMWHBMMzJhRkFLcGpjOGc1MkZuc3YzVDlwdjRHd0Q2V0 

hHYU1DNUVsL21XSWplSE5pLytPTk5hbkdHbHJxIHVLQ1p2UktHenJRNjV4bHIyeEovTXFTWDV3c 

WdTK3R5SE1XY3BwVFpZdmF6cXZtZFRUbllNWlhwd1M1YWxqQlAwb3FWd09wVDFLUksgY0o3bXVa 

YzNUWlJ1OHY0b2pWa1dWTlF2QVNUUFNsdXFkcW42RFdwV2V3UEQ0ZXg3c2ZJam52N1phWmtZV2t 

PL3VDam9SeE4wbmFtVSBlVk5QemZSNXJ5emVjalozb0g0L1NXTGFYeHFiQ2k0QzBjMFlVeTZBMk 

ZkejVKK3RwWUdFbkVFMENpcDFyRjVnMFJhMURBZXV4ZFFaIEMwang3NlNsQ1VjSWhGQ0p4RmRxM 

k5JMHZJVnlVNTl6R2NrY3E3WVZZVlJ2czNVc2crb1pNRTBKbTFjPTwvZHNpZzpYNTA5Q2VydGlm 

aWNhdGU+IA0KICA8L2RzaWc6WDUwOURhdGE+DQogIDwvZHNpZzpLZXlJbmZvPg0KICA8L2RzaWc 

6U2lnbmF0dXJlPg0KICA8L3BwLXNtYi11bml4LTEwOmtleT4= 

 

 

 

此请求数据包安装附加许可证。 

注意许可证节点内容是有效的 base64 节点 , 不是许可证。执行此请求数据包会出现错误 1020。 

 

 

 

TGV0IHVzIGp1c3QgcHJldGVuZCB0aGF0IHRoaXMgaXMgYSBQYXJhbGxlbHMgUGFuZW 

wgbGljZW5zZSBrZXkuCk9mIGNvdXJzZSwgd2UgY291bGQgbm90IGluY2x1ZGUgYSByZWFsIGxpY 

2Vuc2Uga2V5IGluIHRoZSBkb2N1bWVudGF0aW9uLgpUaGFuayB5b3UgZm9yIHVuZGVyc3RhbmRp 

bmcu 


 

 

 


输出响应数据包的 lic_install 节点结构如下 : 


包含从服务器检索到的响应。 




返回错误码。数据类型 :unsignedInt. 


返回错误消息。数据类型 : 字符串。


响应样本 


 

 

 

 

ok 

 

 

 

 

若请求数据包尝试安装无效许可证 , 则收到错误。 

 

 

 

 

error 

1020 

上传的许可证文件无效或不包含许可证。 

 

 

 

 

配置 DNS 

若要通过 API RPC 协议配置 Panel DNS 服务 , 使用 dns 运算子。 

停用 DNS 服务 

若要使用 API RPC 停用 Panel DNS 服务 , 执行包含 dns/disable 操作节点的 XML 请求 : 

 

 

 

 


请求数据包 

下列请求数据包停用 DNS 服务 : 

 

 

 

 

 

响应数据包 

输出 XML 数据包的停用节点结构如下 : 




数据类型 :resultType (common.xsd). 





样本 


正响应类似于 : 

 

 

 

 

ok 

 

 

 



若要设置新 SOA 记录模板 , 执行包含 dns/set 操作节点的 XML 请求数据包 : 

 

 

 

... 

 

 

 


若要设置新 SOA 记录模板 , 执行包含 dns/set 操作节点的 XML 请求数据包 : 

• soa, required 

指定 SOA 参数。数据类型 :SOAType (plesk_dns.xsd). 

• ttl, optional 

指定 ttl 参数值。Panel 设置的默认值为一天。数据类型 :unsignedInt. 

• refresh, optional 

指定 refresh 参数值。Panel 设置的默认值为三小时。数据类型 :unsignedInt. 

• retry, optional 

指定 retry 参数值。Panel 设置的默认值为一小时。数据类型 :unsignedInt. 

• expire, optional 

指定 expire 参数值。( 即时签署 32 位值。) 

Panel 设置的默认值为一周。数据类型 :unsignedInt. 

• minimum, optional 

指定 minimum 参数值。Panel 设置的默认值为三小时。数据类型 :unsignedInt.


请求样本 

此数据包更新 SOA 记录模板 , 设置 TTL 间隔为 32 小时 , 刷新间隔为 6 小时 , 重试间隔为 15 

分钟 , 保留 Panel 过期和最小间隔默认值。 

 

 

 

 

115200 

21600 

900 

 

 

 

 


输出 XML 数据包的 set 节点结构如下 : 










响应样本 


 

 

 

 

ok 

 

 

 

 

若指定的值过长 , 则返回负响应 : 

REQUEST PACKET 

 

 

 

 

4320000000 

 

 

 

 

RESPONSE PACKET 

 

 

error 

1014 

Parser error:Request is invalid 

 


使用 API RPC, 您可以按下列方式在 DNS 区域模板中修改资源记录 : 

• 添加新资源记录 

• 删除现有资源记录 ( 可在模板中检索到 RR 列表 )


添加 RR 模板 

若要添加 DNS 区域资源记录模板 , 执行包含 dns/add-rec 操作模式的 XML 请求数据包 : 

 

 

 

... 

 

 

 


添加 DNS 记录到 DNS 区域模板的请求 XML 数据包包括 dns/add_rec 操作节点 , 由 dnsRecord 

类型 (plesk_dns.xsd) 表示 , 结构如下 :


• type, required 

指定 DNS 记录类型。数据类型 : 字符串。 

允许的值 :A | NS | CNAME | MX | PTR | TXT | SOA | AXFR | SRV. 

• host, required 

指定记录设置要应用到的主机名。数据类型 : 字符串。 

• value, required 

指定即将链接 host 值的值。数据类型 : 字符串。 

站点创建后即创建 DNS 区域文件 , 占位符或会被真实 IP 地址 / 主机名 

替换。 

• opt, optional 

持有 DNS 记录可选信息。数据类型 : 字符串。 

注意 : 若是 SRV 记录 ,opt 节点可以包含附加 XML 代码 , 格式如下 :。 

可使用单个数据包添加多个 DNS 记录。执行多少次操作 , 即可添加多个条 DNS 记 

录。 

 

 

... 

 

... 

 

... 

 


请求样本 

NS 请求样本 

 

 

 

NS 

 

ns.<domain> 

 

 

 

创建 example.com 站点后即可创建 DNS 区域 , 包含下列 RR: 

example.com.NS ns.example.com. 

让 ns.example.com 名称服务器成为主机 example.com。 

此请求数据包将请求数据包作为记录添加到 DNZ 区域模板 , 

provider-dns-server.example.com 站点名称服务器。 

 

 

 

NS 

 

provider-dns-server.example.com 

 

 

 

记录模板 

 

 

 

A 

mail 

<ip> 

 

 

 

创建 example.com 站点 ( 站点 IP 192.0.2.12) 后即可创建 DNS 区域 , 包含下列 RR: 

mail.example.com.A 192.0.2.12 

定义主机 mail.example.com 的 IP 地址 192.0.2.12。 

CNAME 记录模板 


 

 

CNAME 

www 

ns.<domain> 

 

 

 


www NS ns 

让 ns.example.com 成为 www.example.com 别名。 

MX 记录模板 

 

 

 

MX 

 

exchange.<domain> 

0 

 

 

 


example.com.MX 

0 exchange.example.com. 

让 mail.example.com 成为 example.com 站点邮件服务器。 

PTR 记录模板 

 

 

 

PTR 

<ip> 

community 

24 

 

 

 

创建 example.com 站点 ( 站点 IP 192.0.2.12) 后即可创建 DNS 区域 , 包含下列 RR: 

192.0.2.12/24 PTR community.example.com 

让 community.example.com 站点成为子网 192.0.2.12/24 的域名指示器。 

TXT 记录模板 

 

 


TXT 

about 

由服务商提供 

 

 

 


关于 

TXT 由服务商提供 

添加文字描述 " 由服务商提供 " 到域名 about.example.com。 

SRV 记录模板 

 

 

 

SRV 

_LDAP._tcp 

192.0.2.4. 

5 25 220 

 

 

 


_LDAP._tcp SRV 5 25 220 192.0.2.4. 

让站点 example.com 上的客户 LDAP 执行 SRV 192.0.2.4 查询。 

添加多条记录 

下列请求数据包从样本一次添加所有记录 : 

 

 

 

NS 

 

ns.<domain> 

 

 

NS 

 

provider-dns-server.example.com 

 

 

A 

mail 

<ip> 

 


CNAME 

www 

ns.<domain> 

 

 

MX 

 

exchange.<domain> 

0 

 

 

PTR 

<ip> 

community 

24 

 

 

TXT 

about 

由服务商提供 

 

 

SRV 

_LDAP._tcp 

192.0.2.4. 

5 25 220 

 

 

 


输出 XML 数据包的 add_rec 节点结构如下 :










• id, 若操作成功需提供 

返回刚添加的 DNS 记录唯一标识符。数据类型 : 整数。


响应样本 


 

 

 

 

ok 

17 

 

 

 

若指定的请求数据包添加的 RR 值错误 ( 示例中是理解错误 , 并为 SRV 记录指定主机 ), 则返回 

下列负响应 : 


 

 

 

SRV 

_LDAP._tcp.ldap.domain-test-480908606.tst. 

192.0.2.4. 

5 25 220 

 

 

 


 

 

 

 

error 

1019 

指定的 DNS 记录值错误。 

 

 

 


检索 DNS 区域模板相关信息 

若要在 DNS 区域模板中检索资源记录相关信息 , 执行包含 dns/get_rec 操作节点的 XML 数据包 

: 

 

 

 

 

 

 

 

 


输出 XML 数据包的 get_rec 节点结构如下 :





数据类型 :resultType (common.xsd). 







返回 DNS 记录唯一标识符。数据类型 : 整数。 

• data, 若操作成功需提供 

资源记录数据。 

• type, required 

指定 DNS 记录类型。数据类型 : 字符串。 

允许的值 :A | NS | CNAME | MX | PTR | TXT | SOA | AXFR | SRV. 

• host, required 

指定 DNS 所用的主机名。数据类型 : 字符串。 


指定即将链接 host 值的值。数据类型 : 字符串。 

站点创建后即创建 DNS 区域文件 , 占位符或会被真实 IP 地址 / 主机 

名替换。 

• opt, optional 

持有 DNS 记录可选信息。数据类型 : 字符串。


响应样本 

若 DNS 区域模板不包含一条资源记录 , 返回下列响应 : 


 

 

 

 

 

 

 

 


 

 

 

 

 

下列响应包含 Panel 默认 DNS 区域模板描述 : 


 

 

 

 

 

 

 

 


 

 

 

 

ok 

1 

 

NS 

<domain>. 

ns.<domain>. 

 

 

 

 

ok 

2 

 

A 

ns.<domain>. 

<ip> 

 

 

ok 

3 

 

A 

<domain>. 

<ip> 

 

 

 

 

ok 

4 

 

A 

webmail.<domain>. 

<ip> 

 

 

 

 

ok 

5 

 

MX 

<domain>. 

mail.<domain>. 

10 

 

 

 

ok 

6 

 

A 

mail.<domain>. 

<ip> 

 

 

 

 

ok 

7 

 

CNAME 

ftp.<domain>. 

<domain>. 

 

 

 

 

ok 

8 

 

PTR 

<ip> / 24 

<domain>. 

24 

 

通过远程 API 设置 93


 

 

 

 

删除 RR 模板 

若要从 DNS 区域模板删除 RR, 执行包含 dns/del_rec 操作节点的 XML 数据包 : 

 

 

 

... 

 

 

 


删除 DNS 记录的请求 XML 数据包 , 包括 del_rec 操作模式 , 结构如下 : 

• filter, required 

指定过滤规则。数据类型 :dnsSelectionFilterType (dns_input.xsd). 

若留空 (), 则会删除所有记录模板。 

• id, optional 

指定要删除资源记录模板的 ID。数据类型 :id_type (common.xsd). 

• template, required 

指定要删除的记录模板。数据类型 : 无。


请求样本 

此请求数据包从 DNS 区域模板删除记录 ID 7。 

 

 

 

 

7 

 

 

 

 

 

此请求数据包从 DNS 区域模板删除记录 ID 1-5。 

 

 

 

 

1 

2 

3 

4 

5 

 

 

 

 

 

此数据包从 DNS 区域模板删除所有记录 : 

 

 

 

 

 

 

 



输出 XML 数据包的 del_rec 节点结构如下 : 










返回 DNS 记录删除的唯一标识符。数据类型 : 整数。


响应样本 

从服务器返回的正响应如下 ( 成功删除所有 DNS 区域模板记录 ): 


 

 

 

 

 

 

 

 


 

 

 

 

ok 

1 

 

 

ok 

2 

 

 

ok 

3 

 

 

ok 

4 

 

 

ok 

5 

 

 

ok 

6 

 

 

ok 

7 

 

 

ok 

8 

 

 

ok 

9 

 

 

ok


10 

 

 

ok 

11 

 

 

ok 

12 

 

 

 

 

若指定要删除记录簿存在 , 则返回负响应 : 


 

 

 

 

1 

2 

3 

4 

5 

 

 

 

 

 


 

 

 

 

error 

1013 

指定的 DNS 记录不存在。 

1 

 

 

error 

1013 


2 

 

 

error 

1013 


3 

 

 

error 

1013 

指定的 DNS 记录不存在。


4 

 

 

error 

1013 


5 

 

 

 

 


若要安装 SSL 证书 , 执行包含 certificate/install 操作节点的 XML 请求数据包 : 

 

< 证书 > 

 

… 

 

 

 


请求 XML 数据包的安装节点结构如下 :


• name, required 

指定证书要在 Panel 中显示的名称。数据类型 : 字符串。 

• admin, required 

指定要导入到服务器库的证书。数据类型 : 无。 

• content, required 

包含证书相关所有数据。数据类型 : 无。 

• csr, required 

指定证书 CSR ( 证书签署请求 )。数据类型 : 字符串。 

• pvt, required 

指定证书密钥。数据类型 : 字符串。 

• cert, optional 

包含证书内容。数据类型 : 字符串。 

• ca, optional 

包含证书授权内容。数据类型 : 字符串。 

• ip_address, required 

指定证书要分配到的 IP 地址。数据类型 :ip_type (common.xsd).


请求样本 

此数据库安装要显示在 Panel 中的 CA 证书 , 名称 common, 并分配到 IP 地址 192.0.2.14。 

 

< 证书 > 

 

common 

 

 

-----BEGIN CERTIFICATE REQUEST----- 

MIICwTCCAakCAQAwfDELMAkGA1UEBhMCVVMxEDAOBgNVBAgTB2dlb3JnaWExEDAO 

BgNVBAcTB0F0bGFudGExEjAQBgNVBAoTCURvZSwgTHRkLjEUMBIGA1UEAxMLam9o 

bmRvZS5vcmcxHzAdBgkqhkiG9w0BCQEWEGpkb2VAam9obmRvZS5vcmcwggEiMA0G 

CSqGSIb3DQEBAQUAA4IBDwAwggEKAoIBAQC7AQlX0pXqCs61ZUZ28zJ9PAG0yxvV 

2pJnJTMqrudyi/3vV8IZrBUUWMthf7tQmMSSyZWAqM+7n4Q9Y4f5WuR+3ReM5kxC 

hbQnOrjpdUmv1+ZhB9Q21UFA5eEptyDM/LR2JAjpKJD078rh76pVZm3EsJMl3+UE 

3Dg0DeKDelDKa4SYzW1JJnoen4UXX37lIHdBnIj+NCQbHRSiGD6w6mMyiCMOzXCp 

SBiGXgRRcaOVl50OeAdVKkwpJaae1K7K3q9j/LkAlOa1C8kuwdaCtKC+jFCE72I0 

Q8TnIn7ahPy0yd2EgzZ42Ys8D3PziqGax8I/e6BbEOfzi0n1HD9GCzaPAgMBAAGg 

ADANBgkqhkiG9w0BAQQFAAOCAQEAhoSVmInXLQDJu8jrZTVvFUx6O6aHOUkUf/G8 

Wnc2x7w+Qo7XHMHVDCUcP3K+bEw9oKxfpvRXP9XTVhX2jABHrxywLyjg4cXwaUgR 

t7ULvpLQ0Sum5XNtBypAdSQZZ7ktAa6Q3OMAFNdY8YG9J/L2zlcL9JJZLAUnRWzN 

fMBn9Ip3pCC8N9OF9+PFpxGvhtlc1O27w9wj0RdK3hF6Rg37qcUJSnn6XxOB41Q8 

ZZbX2Vbskz0WJ1IcxsfWDJ/HFdho7GrrD/wujNpwkTPc3xe2AHcfQX8c/92xyra/ 

kdzxsDdFD7IwA5bBWGm8QwlL9yWuDPiZ8vSGw96D/Qije9UVkA== 

-----END CERTIFICATE REQUEST----- 

-----BEGIN RSA PRIVATE KEY----- 

MIIEpQIBAAKCAQEAyxfczy4HqgwOI6yxEa+dLaMLe5zC0ijcawsha8oFtJlxv/DM 

9INpdKjv9HaInrR0StjG9HgqTpYrhOCJxeB07/gGsQ82xsvbcKANuCSQKInpwVim 

GUsisGNrfnbKIoAewN21ENCZQrufcQNWNzTx/GjVCXqa/Sy4pXJ6Jud0dzA/+Vis 

SBw5Oo4IqI2MDvuoDk+exQLdgM45Vgq4d3A9+ESzmRmjmdovhNxnXdvMxA5RSrF+ 

GZlBTFftsLQsnfnNiMR6ZTFgNCt2vdDmUAV9iix2B1PuoH94TRCJRG5tVCFtfVzS 

Rjo4ZzoiUs57efb3Oe56Lb64Ubi9ZRzNhdkGLwIDAQABAoIBABJdOAQr31mK+YRU 

SzaUMJw9z/3/cMZcF4I+YWlDvTxVW6nFdmLttw1rcTcjuLrRCmryKxtT+k9c2NaN 

DygrYaeJP+GmxIc5S8BlWJg8BiUEQ3TONUa4OozEkKXAzApOl3lNEuBQXGtiV8p6 

SMN5MCBowkq3IWifMJsVPOJjr25Pby04HCPeeM+cnEiPnMrBjK4OGH8/pKqedf05 

EcjnFKGFP2G0BUEhLX7ooMhB+AbjoIbGFXlBIzhaofs8zzSjNkKJ9i4LQMEe0GDf 

zCgE4GehW+FdcUlhG1zO7FOJc0LdVUR4deoMzaiNRIwdWxbokVwgSEnM20yXYdCl 

t+dsREECgYEA+sNPkzdQC0vF6me6WO8EqMu6AbPjObKnw0i8+g8ndRkMcJQ8FEXD 

+D447fCMORUdqGFH8aMWDp392z4JX3+ksSN9XtyEEKB3fsknENsDZKVJvh9U+gUD 

DO12mC1PleQBHBjN7Wlsg4mPZNv3cxUQLhFU0qW/moQdy0JrDfv+51ECgYEAz1Ww 

OJolOjKhPkGxiDY9sh95E/rpuwkGjb0qiS/UFHHuLc9pDYHyKRpPggdT4nEuBz34 

cRpihMgxBKEzuXGEPvdIST0aObOwcqfY4HAJ8PS08rZupCJsk413gYeI/ckXacQK 

bYYHLKSEavrcmMFc98i2fmbbNp+ckeLHfzVYtX8CgYEAyP6X39YsEIHRx4sQ8IvU 

3j89fnPjo7GxinPZFU3kQJWtROdsKIurAmVNWFrA6lgkh3xCIEqqOVklyv+0n5k+ 

NsXNjaWPLYyRe0xcRcRmudtKelu+zxAJW+lSb7OR4QD6arzvAmbIFb7C8wLlGpc9 

es9lf9pe88kF4JACIxljPaECgYEAj4sWtwlZbsJwygZ3YAOVkUWi8QdNXLVx+R2X 

XmVjokgCi2rGo5hszLIvi6mBFQwgvtjTsZJ/1Mg4z6i/g8sosONJA5OvHXXfWnIE 

f9Zxu4Xf5Q4S6cX/f+R4cZAhcvsPH6WfRpZ9TxYTq3FE2uk8cTxfxIF3kYjNwF7O 

ma6YXQcCgYEApqdVVr92YSYZuDTKYGN5Rd5BaJSGPYWpShS5lPKBQ4n/TkSZzO1v 

Bxq2AbPRohXasWEAdfgfss1mcwX9xnKO/DhnxXE8KVFXKVehGmUth0WqA5qtL4xD 

h4hm3V7DcMqYbVzpmlWXFz5Is1fIflAhlfeX4h3s1rirTj+T6hODVf4= 

-----END RSA PRIVATE KEY----- 

-----BEGIN CERTIFICATE----- 

MIIDiTCCAnECBETUDecwDQYJKoZIhvcNAQEEBQAwgYgxCzAJBgNVBAYTAlJVMQww 

CgYDVQQIEwNOU08xDDAKBgNVBAcTA05TSzEUMBIGA1UEChMLRGFtYWdlIEluYy4x 

CzAJBgNVBAsTAlFBMRcwFQYDVQQDEw53d3cuc3dzb2Z0LmNvbTEhMB8GCSqGSIb3


DQEJARYScmJ1c3lndWluQHBsZXNrLnJ1MB4XDTA2MDgwNTAzMTgwMVoXDTA3MDgw 

NTAzMTgwMVowgYgxCzAJBgNVBAYTAlJVMQwwCgYDVQQIEwNOU08xDDAKBgNVBAcT 

A05TSzEUMBIGA1UEChMLRGFtYWdlIEluYy4xCzAJBgNVBAsTAlFBMRcwFQYDVQQD 

Ew53d3cuc3dzb2Z0LmNvbTEhMB8GCSqGSIb3DQEJARYScmJ1c3lndWluQHBsZXNr 

LnJ1MIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEAyxfczy4HqgwOI6yx 

Ea+dLaMLe5zC0ijcawsha8oFtJlxv/DM9INpdKjv9HaInrR0StjG9HgqTpYrhOCJ 

xeB07/gGsQ82xsvbcKANuCSQKInpwVimGUsisGNrfnbKIoAewN21ENCZQrufcQNW 

NzTx/GjVCXqa/Sy4pXJ6Jud0dzA/+VisSBw5Oo4IqI2MDvuoDk+exQLdgM45Vgq4 

d3A9+ESzmRmjmdovhNxnXdvMxA5RSrF+GZlBTFftsLQsnfnNiMR6ZTFgNCt2vdDm 

UAV9iix2B1PuoH94TRCJRG5tVCFtfVzSRjo4ZzoiUs57efb3Oe56Lb64Ubi9ZRzN 

hdkGLwIDAQABMA0GCSqGSIb3DQEBBAUAA4IBAQBH8mTX3Q3csBUjzwfy3kIVobgh 

yElljOQ87Qv5rht5yktuTyS3oGXsDD0sO/uSG/akL34CTPkjl/vqYtzKMsfQ5pXY 

MlY6Q+GCd9FgL5pBn1S8HSZLpTBWZc25mNe3mXbCQzI03r4W+dQajAgAgDKpnRjg 

mblRg98+HwOL033pVgUnRwPoS3LO5jia5z3F0MkS8sV3x18DuoSLeVILhj0ttZ/p 

B7x0kIUee8A95Q00EDh+4IaPSMOqiFrVIlsHEuPV33aCAz2Dk2TxzplsoNz61BFA 

i3Cm04Gz1h9W/yzkcYCqiwUMIzSgUSBLn0hBeTid1u/NaDtic776YGuyaI+/ 

-----END CERTIFICATE----- 

 

-----BEGIN CERTIFICATE----- 

MIIEjDCCA3SgAwIBAgIJAL4AGzKhkL5wMA0GCSqGSIb3DQEBBQUAMIGKMQswCQYD 

VQQGEwJSVTELMAkGA1UECBMCTlYxFDASBgNVBAcTC05vdm9zaWJpcnNrMRIwEAYD 

VQQKEwlQYXJhbGxlbHMxDjAMBgNVBAsTBVBsZXNrMQ0wCwYDVQQDEwRhYmVsMSUw 

IwYJKoZIhvcNAQkBFhZhYmVseWFldkBwYXJhbGxlbHMuY29tMB4XDTA5MDQyODAz 

NDMxMloXDTEwMDQyODAzNDMxMlowgYoxCzAJBgNVBAYTAlJVMQswCQYDVQQIEwJO 

VjEUMBIGA1UEBxMLTm92b3NpYmlyc2sxEjAQBgNVBAoTCVBhcmFsbGVsczEOMAwG 

A1UECxMFUGxlc2sxDTALBgNVBAMTBGFiZWwxJTAjBgkqhkiG9w0BCQEWFmFiZWx5 

YWV2QHBhcmFsbGVscy5jb20wggEiMA0GCSqGSIb3DQEBAQUAA4IBDwAwggEKAoIB 

AQDlslx5nXTQTvoic3GgW4HH5n5PoCz95Z9XNtCykwv0M2HdhMeNvde1NYDvkipa 

FHzVPEH7eBgjAsHR4y1J4zVGAs2KiJF0W81vi5YAVMOJ7Ysyz8WLP0PQWTmUoMFM 

aE0P7m788tphL328chdPJTjlCF6w9FKzddzrvdeK04ojp2cRO6fFMH7WJPcajvh/ 

3EuYpc7xBNC6Wf8Gk6tB5kCCe7wpHyXsc7ve97nn30p6rUXypBNHYmLujMCtS90I 

K2xOCaSsCwkeUQ4mpXrr5lK7yM07b322vNZBiMTHV8DnaOWDPIcEIFl8NmOJovub 

dG5wdXopA6seCQLaf95lvULrAgMBAAGjgfIwge8wHQYDVR0OBBYEFLSg4V0zc0i0 

pRFtcygaiTgz5ikCMIG/BgNVHSMEgbcwgbSAFLSg4V0zc0i0pRFtcygaiTgz5ikC 

oYGQpIGNMIGKMQswCQYDVQQGEwJSVTELMAkGA1UECBMCTlYxFDASBgNVBAcTC05v 

dm9zaWJpcnNrMRIwEAYDVQQKEwlQYXJhbGxlbHMxDjAMBgNVBAsTBVBsZXNrMQ0w 

CwYDVQQDEwRhYmVsMSUwIwYJKoZIhvcNAQkBFhZhYmVseWFldkBwYXJhbGxlbHMu 

Y29tggkAvgAbMqGQvnAwDAYDVR0TBAUwAwEB/zANBgkqhkiG9w0BAQUFAAOCAQEA 

dEkV4DZMr7Rp0dlYqDpdviGu7FE+7R5u87Mz3E9cTApycbg4KTZAS53B3ItsAQv2 

yjXnkTQw2/l5XusW+OxhGpWC0z58jScyqNW/HkvheUrgbylIOOaKs9vAayi3mA0T 

O1cB1vnAgmB8puV6IdEKuvUimgbJhiGIpqTiL+2/YgSnkGhRuYlxuFB6U8WPgrUN 

UMt0linQtUsxMJCghMA3T8cODGon4ugZ0cCJmDfpkStI3jUuoxulSX2I8xmUQtGe 

2Q/sUQaWgJhe4RDoth6w7E9GE8733WGhC1mIjxyJMx4vmu4ofLAwN6XUzJJ3eC7s 

P34vOGq/sqxG/U+BbUu71A== 

-----END CERTIFICATE----- 

 

 

192.0.2.14 

 

 



输出 XML 数据包的 install 节点结构如下 : 






返回错误码。数据类型 :unsignedInt. 




响应样本 


 

< 证书 > 

 

 

ok 

 

 

 

 

服务器负响应类似于 : 

 

< 证书 > 

 

 

error 

8002 

Unable to set csr content to certificate :CSR 字段包含错误值 : 

openssl 失败 : 

 

 

 

 

 

< 证书 > 

 

 

error 

8006 

Unable to set certificate name : 

 

 

 


创建站点 

若要创建站点帐户 , 执行包含 domain/add 操作节点的 XML 请求数据包 : 

 

 

 

… 

 

 

 


创建站点帐户的请求 XML 数据包 , 包括 domain/add 操作模式 , 结构如下 :


• gen_setup, required 

站点帐户重要信息。数据类型 : 无。 


指定站点名称。数据类型 :domainName (plesk_domain.xsd). 


指定托管站点的 IP。数据类型 :ip_address (common.xsd). 

• hosting, required 

指定站点主机设置。数据类型 :domainHostingAgentSet (plesk_domain.xsd). 

• vrt_hst, required 

指定站点主机设置。数据类型 :domainPhHostingSet (plesk_domain.xsd). 

结构如下 : 

• property, required 

指定主机参数。数据类型 :PleskPhysHostingPropertyType (plesk_domain.xsd). 


指定主机参数名。数据类型 : 字符串。 


指定主机参数值。数据类型 : 任何。 


指定站点 IP 地址。数据类型 :ip_address (common.xsd).


请求样本 

此请求创建站点 example.com, 托管在 IP 192.0.2.48。 

 

 

 

 

example.com 

192.0.2.48 

 

 

 

 

ftp_login 

fp16se4fdf0 

 

 

ftp_password 

qweqwe 

 

192.0.2.48 

 

 

 

 

 


输出响应数据包的 add 节点结构如下 :











返回刚添加的站点帐户唯一标识符。数据类型 : 整数。 

• guid, 若操作成功需提供 

返回刚添加的站点帐户全局唯一标识符。数据类型 : 字符串。


响应样本 

添加新站点帐户后 , 从服务器返回正响应 , 类似于 : 

 

 

 

 

ok 

6 

5c0e3881-22a2-4401-bcc0-881d691bfdef 

 

 

 

 

负响应类似于 ( 取决于错误类型返回不同的错误码 ): 

 

 

 

 

error 

1023 

Operation failed. 

 

 

 

 

若未指定所需的主机设置 , 则会返回此类负响应 : 


 

 

 

 

sample.com 

10.53.129.101 

 

 

 

 

ftp_password 

fp16sdfdfrttg0 

 

10.53.129.101 

 

 

 

 

 


 


 

 

error 

2204 

无法更新主机首选项。系统用户更新失败 : 无法检查系统用户是否存在 : 登录名 

为空。错误字段 :"login". 

 

 

 

 

创建子站点 

若要创建子站点帐户 , 执行包含 subdomain/add 操作节点的 XML 请求数据包 : 

 

< 子站点 > 

 

… 

 

 

 


添加新子站点的请求 XML 数据包 , 包括 subdomain/add 操作模式 , 结构如下 :


• parent, required 

指定要创建站点 / 子站点的子站点名称。(Windows 仅支持主要子站点。) 数据类型 : 字符串。 


指定子站点名称。数据类型 : 字符串。 

• home, required 若在子文件夹中创建子站点 ( 仅限 Windows) 

指定子站点主目录路径。数据类型 : 字符串。 

若留空 (), 则会使用主要站点根目录。 

• property, optional 

指定所创建子站点的主机设置。数据类型 :SubdomainPropertyType 

(subdomain.xsd). 


指定主机参数名。数据类型 : 字符串。 


指定主机参数值。数据类型 : 任何。


请求样本 

此数据包创建子站点 forum.example.com: 

 

< 子站点 > 

 

example.com 

forum 

 

ftp_login 

john 

 

 

ftp_password 

sample 

 

 

 

 

在子文件夹中创建子站点 

此数据包在子文件夹 /httpdocs/BlogEngine 中创建子站点 blog.example.com 

 

< 子站点 > 

 

example.com 

blog 

/httpdocs/BlogEngine 

 

 



输出 XML 数据包的 add 节点结构如下 : 










• 返回所创建子站点的唯一标识符。数据类型 :id_type (common.xsd). 


• 1007 - 同名子站点已存在。 

• 1015 - 未找到主站点 / 子站点。 

• 1019 - 指定的属性无效。 

• 1023 - 操作失败。


响应样本 

创建子站点后 , 从服务器接收到的正响应如下 : 

 

< 子站点 > 

 

 

ok 

1 

 

 

 

 

若指定的子站点已存在 , 返回此类负响应 : 


 

< 子站点 > 

 

example.com 

blog 

 

 

 


 

< 子站点 > 

 

 

error 

1007 

同名子站点已存在。 

 

 

 



若要导出 APS 目录自定义列表 ( 配置文件 ) 到 Panel, 执行包含 aps/import-config 操作节点的 

XML 请求数据包 : 

 

 

 

... 

 

 

 

配置文件 ( 第 37 页 ) 应先通过上传运算子 ( 第 118 页 ) 上传到服务器。 


请求数据包的 import-config 节点结构如下 : 

• filename, required 

请求样本 

指定上传到服务器的配置文件名称。数据类型 : 字符串。 

值上传响应 ( 第 124 页 ) 是中的临时文件名 ( 位于 "upload/result/file" 元素 )。 

上传到服务器之前导入 APS 目录配置的请求数据包 , 类似于 : 

在 Linux/Unix 中 : 

 

 

 

/usr/local/psa/tmp/li_8FZruf 

 

 

 

在 Windows 中 : 

 

 

 

"C:/Program Files/Parallels/Plesk/tmp/li_9D.tmp" 

 

 



输出 XML 数据包的 import-config 节点结构如下 : 










响应样本 


 

 

 

 

ok 

 

 

 

 

若未找到所需文件 , 则返回此类负响应 : 

 

 

 

 

error 

1013 

File "/usr/local/psa/tmp/li_8FZruf" does not exist 

 

 

 

 

若请求的文件访问权限错误 , 则返回此类负响应 ( 未使用上传代理上传 ): 

 

 

 

 

error 

1023 

无法使用指定文件作为配置文件 

 

 

 

 


若要在站点和子站点上安装应用程序 , 使用 aps 运算子。



将文件上传到服务器 

若要上传文件到 Panel 管理的服务器 , 使用上传运算子。不同于其他操作 , 上传运算子不使用 

标准请求数据包结构。而是使用发布方式 

(http://www.w3.org/Protocols/rfc2616/rfc2616-sec9.html) 来上传文件。 

当 Panel 处理请求时 , 响应包含在常规响应 XML 数据包中。上传文件到 Panel 后 , 则可用于其 

他操作。 

注意 : 也可使用 FTP 管理器上传文件 , 注意对文件进行 API RPC 操作可能会出现权限问题。 

建议使用上传运算子。 

使用 cURL 上传文件 

步骤如下 : 

1. 创建到服务器的 SSH 连线。 

2. 在 Unix shell 中键入下列字符串 : 

curl -k -F myfile=@install.log -H 'HTTP_AUTH_LOGIN:admin' -H 

'HTTP_AUTH_PASSWD:password' https://panel-ip:8443/enterprise/control/agent. 

php 

参数 

curl 

-k 

指定要用的 cURL (http://curl.haxx.se/)。需安装到 Unix 机器。 

使用 SSL 连线。 

-F myfile=@install.log 

install.log 文件已上传。可在单个数据包中上传多个文件。 

-H 'HTTP_AUTH_LOGIN:admin' 

指定 Panel 管理员登录名。使用 Panel 登录名替换管理值。 

-H 'HTTP_AUTH_PASSWD:password' 

指定默认管理员的密码。使用 Panel 访问密码替换密码值。 

https://panel-ip:8443/enterprise/control/agent.php 

指定 Panel 服务器地址。使用服务器 IP 地址替换值。 

3. 按下 ENTER。


使用 PHP 上传文件 

此为使用 PHP 脚本上传文件到 Panel 的示例。使用 Panel 凭证更改 HOST、LOGIN、PASSWD 

和 FILENAME。 

主机 Panel 管理的服务器 IP 地址和名称。 

LOGIN Panel 管理员登录名。 

PASSWD Panel 管理员密码。 

FILENAME 要上传的文件全名。 

"@$filename")); 

$result = curl_exec($ch); 

if (curl_errno($ch)) { 

echo "\n\n-------------------------\n" . 

"cURL error number:". 

curl_errno($ch);


echo "\n\ncURL error:". curl_error($ch); 

} 

curl_close($ch); 

//fclose($fp); 

return; 

} 

uploadFile(realpath(FILENAME)); 

>


使用 .NET 上传文件 

此 .NET 源代码上传文件到 Panel。使用 Panel 实例参数替换变量 Hostname、Login、 

Password 和 Protocol。使用要上传的文件全名替换 Filename 变量。 

Filename 要上传的文件全名。 

主机名 Panel 管理的服务器 IP 地址和名称。 

登录 Panel 管理员登录名。 

密码 Panel 管理员密码。 

Protocol API RPC 协议版本。 

使用系统 ; 

使用 System.Net; 

使用 System.Text; 

使用 System.IO; 

使用 System.Xml; 

使用 System.Xml.Schema; 

使用 System.Security.Cryptography.X509Certificates; 

使用 System.Net.Security; 

namespace ConsoleApplication1 

{ 

public class Request 

{ 

// Public interface 

// 

public string Filename = "./tmp/myfile.sh"; // Upload file name; 

public string Hostname = "localhost"; // The Panel's host name 

public string Login = "admin"; 

// Administrator Login 

public string Password = "setup"; // Administrator Password 

public string Protocol = "1.6.2.0"; // API RPC Version Protocol. 

// Handler for receiving information about document type definition (DTD), 

// XML-Data Reduced (XDR) schema, and XML Schema definition language (XSD) 

schema validation errors. 

public ValidationEventHandler XmlSchemaValidation = null; 

public Request() 

{ 

} 

public string AgentEntryPoint { get { return "https://" + Hostname + 

":8443/enterprise/control/agent.php"; } } 

public string InputValidationSchema { get { return "https://" + Hostname + 

":8443/schemas/rpc/" + Protocol + "/agent_input.xsd"; } } 

public string OutputValidationSchema { get { return "https://" + Hostname + 

":8443/schemas/rpc/" + Protocol + "/agent_output.xsd"; } } 

public XmlDocument UploadFile(string uploadfile) 

{


HttpWebRequest request = 

(HttpWebRequest)WebRequest.Create(AgentEntryPoint); 

string boundary = "----------" + DateTime.Now.Ticks.ToString("x"); 

request.Headers.Add("HTTP_AUTH_LOGIN", 

Login); request.Headers.Add("HTTP_AUTH_PASSWD", 

Password); request.ContentType = "multipart/form-data; boundary=" + 

boundary; request.Method = "POST"; 

// Build up the post message header 

StringBuilder sb = new StringBuilder(); 

sb.Append("--"); 

sb.Append(boundary); 

sb.Append("\r\n"); 

sb.Append("Content-Disposition:form-data; name=\""); 

sb.Append("sampfile"); 

sb.Append("\"; filename=\""); 

sb.Append(Path.GetFileName(uploadfile)); 

sb.Append("\""); 


sb.Append("Content-Type:"); 

sb.Append("application/octet-stream"); 



string postHeader = sb.ToString(); 

byte[] postHeaderBytes = Encoding.UTF8.GetBytes(postHeader); 

// Build the trailing boundary string as a byte array 

// ensuring the boundary appears on a line by itself 

byte[] boundaryBytes = 

Encoding.ASCII.GetBytes("\r\n--" + boundary + "\r\n"); 

FileStream fileStream = new FileStream(uploadfile, 

FileMode.Open, FileAccess.Read); 

long length = postHeaderBytes.Length + fileStream.Length + 

boundaryBytes.Length; 

request.ContentLength = length; 

Stream stream = request.GetRequestStream(); 

stream.Write(postHeaderBytes, 0, postHeaderBytes.Length); 

// Write out the file contents 

byte[] buffer = new Byte[checked((uint)Math.Min(4096, 

(int)fileStream.Length))]; 

int bytesRead = 0; 

while ((bytesRead = fileStream.Read(buffer, 0, buffer.Length)) != 0) 

stream.Write(buffer, 0, bytesRead); 

// Write out the trailing boundary stream.Write(boundaryBytes, 0, 

boundaryBytes.Length); 

XmlDocument result = GetResponse(request); 

return result; 

} 

// Private interface 

// 

// Parsing and validating packet 

// 

private XmlDocument ParseAndValidate(TextReader xml, string schemaUri) 

{ 

XmlSchemaSet schemas = new XmlSchemaSet(); 

schemas.Add(null, schemaUri);


XmlReaderSettings settings = new XmlReaderSettings(); 

if (XmlSchemaValidation != null) 

settings.ValidationEventHandler += new 

ValidationEventHandler(XmlSchemaValidation); 

settings.ValidationType = ValidationType.Schema; 

settings.ValidationFlags |= 

XmlSchemaValidationFlags.ProcessSchemaLocation; 

settings.Schemas = schemas; 

XmlDocument document = new XmlDocument(); 

using (XmlReader reader = XmlTextReader.Create(xml, settings)) 

{ 

document.Load(reader); 

} 

return document; 

} 

private XmlDocument GetResponse(HttpWebRequest request) 

{ 

using (HttpWebResponse response = (HttpWebResponse)request.GetResponse()) 

using (Stream stream = response.GetResponseStream()) 

using (TextReader reader = new StreamReader(stream)) 

{ 

return ParseAndValidate(reader, OutputValidationSchema); 

} 

} 

} 

class Program 

{ 

static void Main(string[] args) 

{ 

if (args.Length < 4) 

{ 

Console.WriteLine("Usage:ParalLelSpaNelapirpcclient 

"); 

Console.WriteLine(" "); 

Console.WriteLine(" Hostname - The Panel's host name"); 

Console.WriteLine(" Login - Administrator login"); 

Console.WriteLine(" Password - Administrator password"); 

Console.WriteLine(" FileName - Upload file name"); 

return; 

} 

// Verifies the remote Secure Sockets Layer (SSL) certificate used for 

authentication. 

ServicePointManager.ServerCertificateValidationCallback = 

new RemoteCertificateValidationCallback(RemoteCertificateValidation); 

Request request = new Request(); request.XmlSchemaValidation = 

XmlSchemaValidation; 

try 

{ 

XmlDocument result = request.UploadFile(filename); 

PrintResult(result); 

} 

catch (Exception e) 

{ 

Console.WriteLine("Request error:{0}", e.Message); 

} 

}


// The following method is invoked by the 


private static bool RemoteCertificateValidation(object sender, 

X509Certificate certificate, X509Chain chain, SslPolicyErrors 

sslPolicyErrors) 

{ 

if (sslPolicyErrors != SslPolicyErrors.RemoteCertificateNotAvailable) 

return true; 

Console.WriteLine("Certificate error:{0}", sslPolicyErrors); 

// Do not allow this client to communicate with unauthenticated servers. 

return false; 

} 

// 

private static void XmlSchemaValidation(object sender, ValidationEventArgs 

e) 

{ 

Console.WriteLine("Validation error:{0}", e.Message); 

} 

static void PrintResult(XmlDocument document) 

{ 

XmlTextWriter writer = new XmlTextWriter(Console.Out); 

writer.Formatting = Formatting.Indented; 

document.WriteTo(writer); 

writer.Flush(); 

Console.WriteLine(); 

} 

} 

} 


上传输出 XML 数据包结构如下 :











指定上传文件名。数据类型 : 字符串。 

• file, required 

指定创建的临时文件全名。数据类型 : 字符串。


响应样本 

上传单个数据包 

若请求代理上传 li.sh 数据包到 Panel 管理的服务器 , 则返回负响应 , 类似于 : 

 

 

 

ok 

li.sh 


 

 

 

若上传的文件超出 upload_max_filesize, 在 php.ini 中设置 , 则返回负响应 , 类似于 : 

 

 

 

error 

1023 

上传的文件超出 php.ini 中的 upload_max_filesize 设置 

li.sh 


 

 

 

上传多个数据包 

若请求代理上传 li.sh 和 mybox.sh 文件到 Panel 服务器 , 则返回负响应 , 类似于 : 

 

 

 

ok 

li.sh 


 

 

ok 

mybox.sh 

/usr/local/psa/tmp/li_8FZrHts 

 

 


导入上传的应用程序包 

若要导入上传的应用程序包 ( 第 118 页 ) 到 Panel, 执行包含 aps/import-package 操作模式的 

XML 请求 : 

 

 

 

... 

 

 

 


导入 APS 数据包到 Panel 的 XML 数据包包含 import-package 操作节点 , 结构如下 : 

• filename, required 

指定上传到服务器的应用程序包名称。数据类型 : 字符串。 

值上传响应 ( 第 124 页 ) 是中的临时文件名 ( 位于 "upload/result/file" 元素 )。 

请求样本 

上传到服务器之前导入 Panel APS 目录配置的请求数据包 , 类似于 : 


 

 

 


 

 

 


 

 

 

"C:/Program Files/Parallels/Plesk/tmp/li_9D.tmp" 

 

 



输出 XML 数据包的 import-package 节点结构如下 : 









• package-id, required 若操作成功需提供 

返回分配给 Panel 管理的服务器上的程序包 ID 。数据类型 :id_type 

(common.xsd).


响应样本 


 

 

 

 

ok 

13 

 

 

 

 

若未找到所需文件 , 则返回此类负响应 : 

 

 

 

 

error 

1013 

File "/usr/local/psa/tmp/li_8FZruf" does not exist 

 

 

 

 

若导入的文件是无效的 APS 应用程序包 , 则返回此类负响应。 

1) 要导入的存档缺少 APP-META.xml 程序包元文件。 

 

 

 

 

error 

1023 

Entry 'APP-META.xml' not found 

 

 

 

 

2) APP-META.xml 未经过 XML 方案验证。 

 

 

 

 

error 

1023 

无法要求元数据描述 

 

 

 


从 APS 目录下载应用程序包 

若要从 APS 目录下载应用程序包 , 执行包含 aps/download-package 操作节点的 XML 请求数据包 

: 

 

 

 

... 

 

 

 

若操作成功 , 则创建下载任务。 

注意 : 操作成功不表示开始下载。下载是否成功 , 需执行 get-download-status ( 第 135 页 ) 查看 

。 


download-package 节点结构如下 :


• package, required 

描述目标数据包的所有数据。数据类型 :APSIdentifierType (aps.xsd). 

APS 目录的子节点值。详细信息 , 参阅元素参考 ,APS 目录 API 参考 

(http://www.apsstandard.org/r/doc/aps-catalog-1.1-api/index.htm)。 


指定应用程序数据包名。数据类型 : 字符串。 

• version, optional 

指定应用程序版本。数据类型 : 字符串。 

若未定义 , 则 APS 目录中有多个版本 , 只下载最新版。 

• release, optional 

指定程序包版本。数据类型 : 字符串。 

若未定义 , 则 APS 目录中有多个版本 , 只下载最新版。 

• vendor, optional 

指定应用程序厂商。数据类型 : 字符串。 

• packager, optional 

指定应用程序打包程序。数据类型 : 字符串 

aps-catalog-url, optional 

指定要下载程序包的 APS 目录 URL。数据类型 : 字符串 

若节点出现 , 值中的 URL 同 APS 目录配置文件 ( 第 37 页 ) 中相同 , 否则会出现错误 1013。 

若未包含在数据包中 , 从最先在 APS 目录配置文件 ( 第 115 页 ) 中定义的 APS 目录下载的 

数据包


请求样本 

此数据包安装从特定 APS 目录安装特定版本、发行号、厂商和发行商的应用程序包 ( 不同于默 

认值 )。 

 

 

 

 

BlogEngine.NET 

1.4.5 

2 

www.dotnetblogengine.net 

parallels.com 

 

http://apscatalog.com/ 

 

 

 

此数据包从 APS 目录下载多个程序包及其博客应用程序。假定要下载的每个应用程序目录程序 

包版本最新。 

 

 

 

 

BlogEngine.NET 

 

 

 

 

WordPress 

 

 

 

 

geeklog 

 

 

 



输出 XML 数据包 download-package 结构如下 : 









• task-id, required 若操作成功需提供 

返回下载任务 ID, 可稍后用于检索下载状态。数据类型 : 字符串。


响应样本 


 

 

 

 

ok 

4 

 

 

 

 

若请求定义的 APS 目录 URL 不在 APS 目录配置文件 ( 第 115 页 ) 列表中 , 则返回下列响应。 

若请求的 URL 不同于配置文件中定义的 URL 也是下列响应。若 APS 目录配置中定义的 URL 

遗失斜线。 

 

 

 

 

error 

1013 

目录中的 URL "http://apscatalog.com" 不存在 

 

 

 

 

若 APS 目录 URL 无法解析 , 返回此类负响应 : 

 

 

 

 

error 

1023 

无法解析主机 :apscatalog.co; 无请求类型的数据记录 

 

 

 

 

若 APS 目录配置文件 ( 第 115 页 ) 格式错误 , 返回此类负响应 : 

 

 

 

 

error 

1023 

APS 目录配置文件损坏 

 

 

 


获取下载任务状态 

若要检索程序包下载任务状态 , 执行包含 aps/get-download-status 操作节点的 XML 请求数据包 : 

 

 

 

... 

 

 

 

可能的状态 : 

• "finished/error" - 未在 APS 目录中找到程序包 , 导致无法启动任务 

• "finished/package-id" - 成功完成任务 

• "in-progress/current" - 程序包下载中 

• "in-progress" 缺少 "current" 子节点 - 未开始下载程序包 , 但已在队列中 


get-download-status 节点结构如下 : 


检索到过滤器下载任务。数据类型 : 无。 

若定义的值为空 , 则返回所有当前所有下载任务列表。在 Windows 中 , 为每个下载任务创 

建独立交易。下载完成则下载交易结束。 

• task-id, optional 

指定下载任务 ID ( 返回操作结果 )。数据类型 :id_type 

(common.xsd).


请求样本 

此数据包请求当前下载交易状态。 

 

 

 

 

 

 

 

此数据包请求下载任务 ID 10、11 和 12 的状态。 

 

 

 

 

10 

11 

12 

 

 

 



输出 XML 数据包 get-download-status 结构如下 :








• errtext, required 若请求包含非空过滤器 


• filter-id, required 若操作成功需提供 

返回被过滤操作的 ID。数据类型 : 任何。 

• id, required 若操作成功需提供 

返回检索到的下载任务 ID。数据类型 :id_type (common.xsd) 

• task, optional 

描述下载任务状态的数据集。数据类型 : 无。 

结构如下 :


• id, required 

返回检索到的下载任务 ID。数据类型 :id_type (common.xsd). 

• finished, optional 

指定下载任务完成。数据类型 : 无。 

• in-progress, optional 

指定下载任务进行中 , 或在下载队列中一次指定多个程序包。数据类型 : 

APSPackageDownloadStatusInProgress (aps.xsd). 

• error, optional 

指定下载任务完成 , 但出现错误。包含错误描述。数据类型 : 无。 

• package-id, required 若下载成功需提供 

指定下载成功完成 , 以及在服务器上分配给程序包的 ID。数据类型 :id_type 

(common.xsd). 

• total, required 

指定应用程序总大小 , 字节。数据类型 : 整数。 

• completed, required 

指定下载包总大小 , 字节。数据类型 : 整数。 

• current, optional 

指定下载任务进行中 , 下载队列中无等待任务。数据类型 : 字符串。


请求和响应样本 

样本 1 

请求 

此数据包返回下载任务 ID 18 的状态 : 

 

 

 

 

18 

 

 

 

 

响应 A 


 

 

 

 

ok 

18 

18 

 

18 

 

13 

 

 

 

 

 

 

响应 B 

若下载任务未启动 , 或完成但出错 , 返回此类响应。 

 

 

 

 

ok 

18 

18 

 

18 

 

无法从目录下载程序包 

 

 


 

 

 

响应 C 

若请求 ID 不存在 , 返回此类负响应。 

 

 

 

 

error 

1013 

未找到下载任务 id 18 

181 

 

 

 

 

样本 2 

请求 

此数据包请求当前交易中所有下载任务的状态。 

 

 

 

 

 

 

 

响应 A 

从运行树状任务的 Linux 服务器返回此响应 : 一个任务完成 , 一个处理中 , 一个在队列中。 

 

 

 

 

ok 

10 

10 

 

10 

 

5 

 

 

 

 

ok 

11 

11 

 

11 


3584225 

2458 

 

 

 

 

 

ok 

12 

12 

 

12 

 

45888236 

0 

 

 

 

 

 

 

响应 B 

交易运行时 , 从 Windows 服务器上返回此响应 : 

 

 

 

 

ok 

38 

38 

 

38 

 

0 

0 

 

 

 

 

 

 

响应 C 

无下载交易运行时 , 收到此类响应。 

 

 

 

 

ok 

 

 

 



安装应用程序要求您识别要安装的源程序包。按 ID 识别或 

name-version-release-vendor-packager 信息识别程序包。 

若要提供程序包 ID, 执行 : 

• 使用导入 Panel 后分配给程序包的 ID ( 第 128 页 ) 

• 使用从 APS 目录成功下载后分配给程序包的 ID ( 第 137 页 ) 

• 使用从可用程序包信息返回的 ID ( 第 156 页 ) 

若要提供 name-version-release-vendor-packager 信息 , 从可安装的程序包检索信息 ( 第 154 

页 )。 

在站点或子站点上安装应用程序 

若要安装应用程序 , 执行包含 aps/install 操作节点的 XML 请求数据包 : 

 

 

 

... 

 

 



install 节点结构如下 : 

domain-id 或 domain-name 或 subdomain-id 或 subdomain-name 需要。 

• domain-id, optional 

指定要安装的站点 ID。数据类型 :id_type (common.xsd). 

• domain-name, optional 

指定要安装的站点名。数据类型 : 字符串。 

• subdomain-id, optional 

指定要安装的子站点 ID。数据类型 :id_type (common.xsd). 

• subdomain-name, optional 

指定要安装的子站点名。数据类型 : 字符串。 

package-id 或 package 需要。 

注意 : 程序包识别信息 , 使用 aps/get-packages-list 操作获取 ( 第 154 页 )。 

• package-id, optional 

指定要在服务器上安装的应用程序包 ID。数据类型 :id_type (common.xsd).


• package, optional 

服务器上安装的应用程序包信息。数据类型 :APSIdentifierType (aps.xsd), 查看下列定 

义。 

• ssl, optional 

指定应用程序是否可以通过 HTTPS 协议访问。数据类型 :boolean. 

若未指定 , 则通过 HTTP 访问。 

• url-prefix, optional 

指定站点 / 子站点 URL。数据类型 :APSUrlPrefixType (aps.xsd). 

若未指定 , 则使用默认设置 ("/application/default-prefix" 元素 , 位于 

APP-META.xml 文件中 )。 

• database, optional 

应用程序创建的数据包属性描述。数据类型 :APSDatabaseInputType (aps.xsd), 查看 

下列定义。 

若应用程序需要数据库 , 且未在队列中指定 database 元素 , 则在创建时自动生成名称、用户 

登录名和密码。 

按应用程序需求 , 数据库服务器 (MySQL, PostgreSQL 或 Microsoft SQL Server) 自动选择 

。 

• settings, optional 

应用程序安装设置集。 

。 

数据类型 :APSSettingsInputType (aps.xsd), 查看下列定义 

若要安装的应用程序有设置 ( 应用程序包元数据文件 APP-META.xml 包含至少一个元素 

"//setting")。 

package 节点由类型 APSIdentifierType 表示 (aps.xsd), 图示如下 : 




指定应用程序版本。数据类型 : 字符串。 


指定程序包版本。数据类型 : 字符串。






应在简要或扩展表单中指定程序包 : 

• 简要型提供应用程序名 

• 扩展型提供所有程序包详细信息 : 名称、版本、发行号、厂商和打包程序 

database 节点由类型 APSDatabaseInputType 表示 (aps.xsd), 图示如下 : 


指定数据包名称。应唯一。数据类型 : 字符串。 

• login, required 

指定数据包用户登录名。应唯一。数据类型 : 字符串。 

• password, required 

指定数据库用户密码。数据类型 : 字符串。 

settings 节点由类型 APSSettingsInputType 表示 (aps.xsd), 图示如下 : 

• setting, required 

应用程序设置定义。数据类型 :APSSettingInputType (aps.xsd). 

应用程序设置名称信息 , 以及从应用程序包元数据文件获取的值 APP-META.xml ( 

"//setting" 元素 )。 

应用程序元数据文件中未指定默认值 , 则使用设置元素。 

• name, required


指定设置 ID。可以和 APP-META.xml ("//setting[@id]") 中指定同一设置 ID。数 

据类型 : 字符串。 


指定设置值。数据类型 : 字符串。


请求样本 

下列程序包在站点 example.com 上安装应用程序 Serendipity。 

 

 

 

example.com 

 

serendipity 

1.1.2 

33 

s9y.org 

parallels.com 

 

 

s9DB 

s9user 

s9password 

 

< 设置 > 

< 设置。> 

admin_p_name 

admin 

 

< 设置。> 

admin_name 

admin 

 

< 设置。> 

admin_password 

P4$$w0rd 

 

< 设置。> 

admin_email 

admin@example.com 

 

< 设置。> 

title 

Project X Blog 

 

< 设置。> 

blog_descr 

Project X Blog 

 

< 设置。> 

locale 

en-US 

 

 

 

 

 

下列数据包在子站点上安装 LinkPoint 应用程序 ( 程序包 ID 5)。若安装应用程序不需要数据库 

且无设置时 , 会用到此类请求。


 

 

 

subdomain.example.com 

5 

 

 

 


输出 XML 数据包的 install 节点结构如下 : 










1013 - 未找到指定对象 ( 站点、子站点、程序包 ) 

1019 - 指定设置无法安装应用程序 

1100 - 不满足应用程序需求


响应样本 


 

 

 

 

ok 

 

 

 

 

'1013 未找到对象 ' 错误 

1. 若指定站点 / 子站点不存在 , 则返回此类负响应。 

 

 

 

 

error 

1013 

Domain not found. 

 

 

 

 

2. 若未在服务器上找到所需程序包 , 则返回此类负响应。 

 

 

 

 

error 

1013 

程序包不存在 

 

 

 

 

'1019 设置错误 ' 错误 

1. 若应用程序设置没有默认值 , 或请求的设置不包含请求的数据包 , 则返回此类负响应。 


 

 

 

example.com 

 

AutoIndex 

 

 


 


 

 

 

 

error 

1019 

安装中出错。 

"admin_password" 设置值无效 :'' 字符短于 1 

"user_password" 设置值无效 :'' 字符短于 1 

 

 

 

 

2. 若请求中指定的应用程序设置未经过 APP-META.xml 验证 , 则返回此类负响应。 


 

 

 

10 

 

joomla 

 

< 设置 > 

< 设置。> 

admin_name 

admin 

 

< 设置。> 


dfkjEEtbgg 

 

< 设置。> 

admin_email 


 

< 设置。> 

locale 

en-US 

 

< 设置。> 

title 

Joomla 

 

 

 

 

 


 

 

 


error 

1019 


"locale" 值应为 (en-GB, fr-FR, de-DE) 

 

 

 

 

3. 若指定的 Web 目录已存在 , 或用于其它内容 , 则返回此类负响应 : 

 

 

 

 

error 

1019 


目标目录已存在 , 或用于其它 Web 应用程序。 

 

 

 

 

4. 若请求数据包中指定的数据包已存在 , 则返回此类负响应 : 

 

 

 

 

error 

1019 


请求名称的数据库已存在 

 

 

 

 

'1100 不满足需求 ' 错误 

若未满足应用程序需求 , 则返回此类负响应 : 

 

 

 

 

error 

1100 

出现下列需求问题 : 无法满足 ASP.NET 版本需求。需要 ASP.NET 2.0; 无法满 

足 ASP.NET 版本需求。需要 ASP.NET 2.0; 无法满足数据库服务器需求。未找到 'mssql' 数据库 

, 版本不低于 9.0 

 

 

 

 

其他错误


若指定的应用程序应通过 HTTPS (true) 使用 , 但站点 / 子站点不支持 , 则返回此类 

负响应。 


 

 

 

2 

 

joomla 

 

true 

< 设置 > 

< 设置。> 

admin_name 

admin 

 

< 设置。> 


dfkjEEtbgg 

 

< 设置。> 

admin_email 


 

< 设置。> 

locale 

en-GB 

 

< 设置。> 

title 

Joomla 

 

 

 

 

 


 

 

 

 

error 

1023 

同此站点关联的 IP 地址已经被另一个站点所使用 , 用于支持 SSL 实现。 

 

 

 

 


检索可用数据包 

使用 aps/get-packages-list 操作检索可在站点 / 子站点上安装的应用程序包信息 : 

 

 

 

... 

 

 

 


get-packages-list 节点结构如下 : 


过滤检索到其信息的程序包。数据类型 : 无。 

若为空 , 则服务器上所有 APS 程序包相关信息会返回响应程序包。 

• package-id, optional 

指定要检索其信息的程序包 ID。数据类型 :id_type (common.xsd).


请求样本 

此数据包检索所有应用程序包相关信息。 

 

 

 

 

 

 

 

此数据包检索应用程序包 ID 11, 12 和 13 的信息。 

 

 

 

 

11 

12 

13 

 

 

 



输出 XML 数据包 get-packages-list 结构如下 : 









• filter-id, required 若操作成功需提供 

返回被过滤操作的程序包 ID。数据类型 : 任何。 

• id, optional 

未返回。 

• package, required 若操作成功需提供 

描述数据包的所有数据。数据类型 :APSIdentifierType (aps.xsd).


结构如下 : 




指定应用程序 version.Data 类型 : 字符串。 


指定程序包 release.Data 类型 : 字符串。 





• id, required 

指定服务器上的程序包 ID。数据类型 :id_type (common.xsd).


请求和响应样本 

样本 1 

请求 

此数据包检索所有 APS 程序包相关信息。 

 

 

 

 

 

 

 

响应 A 


 

 

 

 

ok 

1 

 

phpWiki 

1.3.11 

44 

phpwiki.sourceforge.net 

parallels.com 

1 

 

 

 

ok 

2 

 

PinnacleCart 

3.6.1 

570 

www.pinnaclecart.com 

www.pinnaclecart.com 

2 

 

 

 

 

 

响应 B 

若服务器上无 APS 程序包 , 则返回此响应 : 

 

 


 

ok 

 

 

 

 

样本 2 

此数据包检索 APS 程序包 ID 11, 12 和 13 的信息。 

 

 

 

 

12 

13 

 

 

 

 

若请求数据包 ID 数据包不存在 , 则返回负响应 : 

 

 

 

 

error 

1013 


12 

 

 

error 

1013 


13 

 

 

 

第 6 章 

通过 CLI 设置 

本章阐述如何通过 Panel 命令行界面 (CLI) 设置 Panel。 

关于 Panel CLI 章节 ( 第 161 页 ) 概述 CLI 使用基本信息。 

设置 Panel 章节 ( 第 162 页 ) 详细阐述要执行的 Panel 设置操作。 


关于 Panel CLI .................................................................................................. 161 

设置 Panel ......................................................................................................... 162


关于 Panel CLI 

Parallels Small Business Panel 命令行界面 (CLI) 提供 Panel 管理员可以在命令行界面 

中执行的主要管理操作。 

root 用户可从控制台或脚本使用 Panel 命令行实用程序。实用程序需要 "root"/"psaadm" 

(Linux/Unix) 或 "Administrator" (Windows) 权限才可以操作。 

Parallels Small Business Panel for Linux/Unix CLI 和 Panel 支持当地的企业名称。因此 , 

可以使用本地语言创建联系人姓名。使用 LANG 环境变量设置特定语言。 

成功之行后 , 实用程序返回 0 编码。若出错 , 实用程序返回 1 并在 stderr 上显示问题 

描述。 

注意 : 实用程序输入参数必需是 UTF-8 编码。可以确定 Panel 操作正常。 

实用程序位置 


/opt/psa/bin Debian 系统中 

/usr/local/psa/bin 非 -Debian Linux 和 Unix 


%plesk_cli%

162 通过 CLI 设置 

设置 Panel 

本章阐述要在 Panel 设置操作中执行的命令详细信息。 


若要通过 CLI 初始化 Panel, 使用 init_conf 实用程序。 

命令 

下列命令可初始化 Panel: 

init_conf --init -email -passwd [-locale ] 

格式按 RFC 1766 标准 "-", 其中 

是小写的两个字母 ISO 639-1 和是大写 , 来自 ISO 

3166。如德语 ( 德国 ) 本地编码是 "de-DE"。 

样本 

1. 下列命令初始化 Panel, 设置管理员密码 "jskekekHTD" 和电子邮件 

"johndoe@example.com"。 


./init_conf --init -passwd jskekekHTD -email johndoe@example.com 


./init_conf --init -passwd jskekekHTD -email johndoe@example.com 

2. 下列命令初始化 Panel, 设置管理员密码 "P4$$w0rd" 和电子邮件 "fischer@example.com", 

并设置 Panel 语言为 " 德语 ( 德国 )"。 


./init_conf --init -passwd P4$$w0rd -email fischer@example.com -locale de-DE 


init_conf --init -passwd P4$$w0rd -email fischer@example.com -locale de-DE



使用 Panel CLI 安装 Panel 许可证 , 先需使用 Panel 上传到电脑 , 然后使用 license 实用程序 

安装。 

命令 

若要安装执行格式如下的命令 : 

license 

示例 

1. 在 Linux/Unix 上 : 

./license -i /tmp/psmbfu10key.xml 

2. 在 Windows 中 : 

license.exe -i "D:\keys\psmbfw10key.xml"


定义 Panel 徽标 

若要设置 Panel 商标 , 使用 branding 实用程序。 

更改徽标 

两步即可更改 Panel 徽标图像和 URL: 

1 使用下列命令 , 定义徽标及其图像 : 

branding true -path 

2 使用下列命令设置自定义 URL: 

branding -url 

示例 

1. 下列命令设置自定义徽标 , 并使用图像 my-own-cool-logo.gif, 位于 temp 目录中。 


./branding -u true -path temp/my-own-cool-logo.gif 


branding.exe -u true -path D:\temp\my-own-cool-logo.gif 

2. 下列命令点击面板徽标 , 即可打开 URL http://example.com/about。在 Linux/Unix 中 : 

./branding -l -url http://example.com/about 


branding.exe -l -url http://example.com/about 

更改支持 URL 

若要更改支持链接 ( 从 Panel 点击支持按钮即可打开的 URL), 使用下列命令 : 

branding -url 

示例 

使用下列命令即可点击支持打开支持请求表单 https://support.example.com/submit-ticket。 


./branding -c -url https://support.example.com/submit-ticket 


branding.exe -c -url https://support.example.com/submit-ticket


配置 DNS 

若要通过 CLI 配置 Panel DNS 服务 ( 包括停用 ), 使用 server_dns 实用程序。 

停用 DNS 服务 

若要停用 Panel DNS 服务 , 执行下列命令 : 

server_dns -status disabled 

格式如下。 


./server_dns -u -status disabled 


server_dns.exe -u -status disabled 


若要更改 SOA 记录模板 , 执行下列命令 : 

server_dns --update-soa [options] 

可用选项 

选项参数描述 

-soa-ttl 

-soa-refresh 

-soa-retry 

-soa-expire 

[S| 

M|H|D|W] 

[S| 

M|H|D|W] 

[S| 

M|H|D|W] 

[S| 

M|H|D|W] 

-soa-minimum [S| 

M|H|D|W] 

指定 TTL 时段。 

Panel 设置的默认值为一天。 

指定刷新时段。 

Panel 设置的默认值为三小时。 

指定重试时段。 

Panel 设置的默认值为一小时。 

指定过期日。 

Panel 设置的默认值为一周。 

指定最小值。 

Panel 设置的默认值为三小时。 

-soa-serial-for 

mat 

timestamp|yyyy 

mmddnn 

指定 SOA 记录序列号格式 :UNIX 时间戳或由 IETF 和 RIPE 建议。 

仅在 Linux/Unix 上支持。


示例 

1. 下列命令设置 TTL 值为 5 小时 , 刷新值为 4 小时 , 重试值为 10 秒 , 过期时段为 2 周 , 最小值为 2 天。 


./server_dns --update-soa -soa-ttl 5H -soa-refresh 4H -soa-retry 10S 

-soa-expire 2W -soa-minimum 2D 


server_dns.exe --update-soa -soa-ttl 5H -soa-refresh 4H -soa-retry 10S 

-soa-expire 2W -soa-minimum 2D 

2. 下列命令更改 SOA 记录序列号到 IETF 和 RIPE 建议值 : 

./server_dns --update-soa -soa-serial-format yyyymmddnn 


Panel CLI 支持下列两种方式修改 DNS 区域模板 : 

1 添加记录。通过在一条命令中添加一条记录机可以修改。 

2 覆盖区域模板。修改后 , 通过删除所有区域模板记录 , 即可使用一条命令覆盖新记录设置。 

添加记录 

若要添加一条资源纪录到 DNS 区域模板中 , 使用下列命令 : 

server_dns 

记录参数和示例 

参数函数描述示例 

-a |"" 

-ip 

|"" 

指定记录设置要应用到的主机 

名。 

指定 IP 地址或站点 IP 地址占 

位符 , 创建 A 资源记录模板。 

若要添加新 A 资源记录 

sample. ( 指定记录的站点 IP 

地址占位符 ) 到站点 DNS 区域模板 : 

server_dns -a -a sample -ip 

"" 

NS 记录参数和示例 


-ns 

|"" 


名。 

若要添加新 NS 资源记录 , 指定 

"ns.." 作为



-nameserv 

er 

|"[.]" 

指定域名服务器名称或占位符 , 主机域名服务器 : 

创建 NS 资源记录模板。 server_dns -a -ns "" 

-nameserver "ns." 

MX 记录参数和示例 


-mx 

-mailexch 

anger 

|"" 

 

|"[.]" 


名。 

指定邮件交换器名称或占位 

符。 

-priority 指定邮件交换器优先级。 

若要添加新 MX 资源记录 , 让 

mail. 成为 

邮件服务器 , 优先级 15: 

server_dns -a -mx "" 

-mailexchanger 

"mail." -priority 

15 

CNAME 记录参数和示例 


-cname 

-canonica 

l 

|"" 

 

|[.]" 


名。 

若要指定规范名称或占位符 , 

创建 CNAME 记录模板。 

若要添加新 CNAME 资源记录 , 让 

ns. 成为 

www. 别名 : 

server_dns -a -cname www 

-canonical "ns." 

PTR 记录参数和示例 


-ptr 

-subnet 

|"" 

/ 

 

|""/ 


名。 

指定 IP 地址和子网掩码或占 

位符 , 创建 PTR 记录模板。 

若要添加新 PTR 记录 , 让 

成为 ""/16 子站点 

的域名指标。 

server_dns -a -ptr "" 

-subnet ""/16


SRV 记录参数和示例 


-srv 

-srv-prio 

rity 

-srv-weig 

ht 

""| 


名。 

[0-50] 设置 SRV 记录优先级 (0 - 最 

高 , 50 - 最低 )。 

[0-50] 指定 SRV 记录重要程序 , 同优 

先级相同 (0 - 最低 ,50 - 最 

高 )。 

-srv-port [0-65535] 指定要在端口上找到的服务。 

-srv-targ 

et-host 

-srv-prot 

ocol 

-srv-serv 

ice 

指定提供服务的机器主机名。 

TCP|UDP 指定服务协议。 

< 服务 > 指定服务符号名。 

若要添加到 DNS 区域模板一条 

SRV 记录 , 让处理 SIP 

协议连线 , 指向服务器 , 并命名为 

sipserver.sample.com, 监控 TCP 

端口 5060。优先级是 0, 重要程度 

是 5: 

server_dns --add -srv "" 

-srv-service sip 

-srv-target-host 

sipserver.sample.com. 

-srv-protocol TCP 

-srv-port 5060 

-srv-priority 0 

-srv-weight 5 

TXT 记录参数和示例 


-txt |"" 指定文字描述若要指定 TXT 类型 DNS 记录 " 此记 

录用于实施发件人协议框架和 

-domain |"" 

DomainKeys 规范 ", 用于主机 

名。 

policy.: 

server_dns -a -txt " 此条记 

录用来使用 h 发件人协议框架和 

DomainKeys 规范 " -domain 

policy 

覆盖 DNS 区域模板中的记录 

若要覆盖 DNS 区域模板 , 使用下列命令 : 

server_dns ";;..." 

其中格式是 ",,[,]"。 

即格式如下列 Panel 中的每条资源记录 :


NS,, 

A,, 

MX,,, 

PTR,,, 

CNAME,, 

SRV,..,, 

。 NS ns.. 

ns.. A 

< 站点 >。 A 

webmail.. A 

 

< 站点 >。 MX 10 mail.. 

mail.. A 

ftp.. CNAME < 站点 >。 

/24 PTR < 站点 >。 

< 站点 >。 TXT f1 +a +mx -all 

_SIP._tcp.megadomain.. SRV 5 25 12 example.com. 


./server_dns -s 

'NS,,ns..;A,ns,;A,,;A,webmail,;MX,,mail..,10;A, 

mail,;CNAME,ftp,.;PTR,,,24;TXT,,v=spf1 +a +mx 

-all;SRV,_SIP._tcp.megadomain,example.com,5 25 12;' 


server_dns.exe -s 

"NS,,ns..;A,ns,;A,,;A,webmail,;MX,,mail..,10;A, 

mail,;CNAME,ftp,.;PTR,,,24;TXT,,v=spf1 +a +mx 

-all;SRV,_SIP._tcp.megadomain,example.com,5 25 12;"



若要通过 CLI 安装 SSL 证书 , 使用 certificate 实用程序。两步完成安装 : 

1 导入证书到 Panel。 

2 分配证书到 IP 地址。 

注意 , 证书之前已使用 Panel 上传到机器。


导入证书 

若要导入证书 , 执行格式如下的命令 : 

certificate -admin -key-file 

-cert-file [-cacert-file ] [-csr-file 

] 

示例 

1. The following command imports the SSL certificate which private key file is 

/usr/local/keys/keyfile.key and certificate file is 

/usr/local/cert/certfile.cert. 导入后 , 证书名称为 " 站点证书 "。 


./certificate --create "Site Certificate" -admin -key-file 

/usr/local/keyfile.key -cert-file /usr/local/cert/certfile.cert 

或 

./certificate -c "Site Certificate" -admin -key-file /usr/local/keyfile.key 

-cert-file /usr/local/cert/certfile.cert 

Windows 中 ( 证书文件位于 E:\temp\): 

certificate --create "Site Certificate" -admin -key-file E:\temp\keyfile.key 

-cert-file E:\temp\certfile.cert 

或 

certificate -c "Site Certificate" -admin -key-file E:\temp\keyfile.key 

-cert-file E:\temp\certfile.cert 

2. 下列命令导入 SSL 证书 , 专用证书文件是 /usr/local/keys/keyfile.key,, 证书文 

件是 /usr/local/cert/certfile.cert, CA 证书文件是 

/usr/local/cert/cacert.cert, 签署相应请求文件的证书是 

/usr/local/requests/csreq.csr。导入后 , 证书名称为 " 站点证书 "。 


./certificate -c "Site Certificate" -domain example.com -key-file 

/usr/local/keys/keyfile.key -cert-file /usr/local/cert/certfile.cert 

-cacert-file /usr/local/cert/cacert.cert -csr-file 

/usr/local/requests/csreq.csr 

Windows 中 ( 证书文件位于 E:\ssl\): 

certificate -c "Site Certificate" -domain example.com -key-file 

E:\ssl\keys\keyfile.key -cert-file E:\ssl\cert\certfile.cert -cacert-file 

E:\ssl\cert\cacert.cert -csr-file E:\ssl\requests\csreq.csr


分配证书到 IP 地址 

若要分配导入证书到 IP 地址 , 使用命令 : 

certificate -admin -ip 

示例 

下列命令分配名称为 " 站点证书 " 的 SSL 证书到 IP 地址 192.0.2.78。 


./certificate -ac "Site Certificate" -ip 192.0.2.78 


certificate -ac "Site Certificate" -ip 192.0.2.78 

创建站点 

若要创建站点帐户 , 使用 domain 实用程序。 

命令 

下列命令创建站点帐户 : 

domain -hosting true -ip -login 

-passwd 

其中 FTP-login> 和用来上传和编辑网站内容的 FTP 帐户登录名和密码。 

示例 

下列命令创建站点 example.com , 托管到 IP 地址 192.0.2.33,FTP 帐户凭证 "johndoe" 和 

"P4$$w0rd"。 


./domain --create example.com -hosting true -ip 192.0.2.33 -login johndoe 

-passwd P4$$w0rd 


domain.exe --create example.com -hosting true -ip 192.0.2.33 -login johndoe 

-passwd P4$$w0rd 

创建子站点 

若要创建子站点帐户 , 使用 subdomain 实用程序。


创建常规子站点 

命令 

下列命令创建子站点帐户 : 

subdomain -domain 

[-ftp_user native -login -passwd ] 

其中 

-ftp_user native -login -passwd 当主站点 FTP 帐 

户用来管理子站点时 , 负责创建新子站点 FTP 帐户 , 不同于默认设。 

示例 

1. 下列命令用来创建子站点 mail.example.com, 和 FTP 帐户来管理即将用于站点 

example.com 的相同内容。 


./subdomain --create mail -domain example.com 


subdomain.exe --create mail -domain example.com 

2. 下列命令创建子站点 portfolio.example.com 和 FTP 帐户及其登录名 portfolio 和 

密码 P4$$w0rd, 用来管理子站点内容。 


./subdomain --create portfolio -domain example.com -ftp_user native -login 

portfolio -passwd P4$$w0rd 


subdomain.exe --create portfolio -domain example.com -ftp_user native -login 

portfolio -passwd P4$$w0rd


在子文件夹中创建子站点 ( 仅限 Windows) 

命令 

下列命令在子文件夹中创建子站点帐户 : 

subdomain -domain 

-hst_type virt [-www_root -create_phys false] 

其中 

-www_root -create_phys false 负责在目录中创建子站点 , 路径在 

使用 -www_root 选项指定。 

示例 

1. 下列命令创建子站点 news.example.com, 并为其内容创建目录 /httpdocs/news/。 

subdomain.exe --create news -domain example.com -hst_type virt 

2. 下列命令创建子站点 blog.example.com, 位于现有目录 /httpdocs/wordpress/。 

创建时 ,WordPress 博客工具可从 URL http://blog.example.com 访问。 

subdomain.exe --create blog -domain example.com -hst_type virt -www_root 

/httpdocs/wordpress -create_phys false 


若要导入 APS 目录配置文件 , 使用命令 : 

aps 

配置文件位于下列目录之一 :


• Panel 临时目录 : 

• /opt/psa/tmp Debian 上 ,/usr/local/psa/tmp 其他 Linux\Unix 上 

• %plesk_dir%\tmp Windows 上 

• 操作系统临时目录 : 

• /tmp 在 Linux/Unix 上 

• C:\WINDOWS\Temp Windows 上 

如需有关配置文件相关信息 , 参阅 APS 目录配置文件章节 ( 第 37 页 )。 

示例 

下列命令导入 APS 目录配置文件 catalogs.ini: 


./aps -ic /tmp/catalogs.ini 

或 

./aps -ic /usr/local/psa/tmp/catalogs.ini 


aps -ic "C:\Program Files\Parallels\Plesk\tmp\catalogs.ini" 

或 

aps -ic "C:\WINDOWS\Temp\catalogs.ini" 


若要安装应用程序 , 使用 aps 实用程序。 


导入上传的应用程序包 

若要导入应用程序包 , 使用下列命令 : 

aps 

示例 

下列命令将 SugarCRM-5.0.0-16.app.zip 程序包导入 Panel。 


./aps --import-package /home/root/SugarCRM-5.0.0-16.app.zip 


aps --import-package "C:\Documents and 

Settings\Administrator\Desktop\SugarCRM-5.0.0-16.app.zip"


从 APS 目录下载应用程序包 

若要从 APS 目录下载应用程序包 , 使用下列命令 : 

aps -package-name [-catalog-url ] 

[-package-version -package-release 

-package-vendor -package-packager ] 

其中 

• 其中 

[-catalog-url ] 

定义目标 APS 目录 (URL 与配置文件中相同 )。若未指定 , 则按配置文件 ( 第 37 页 ) 中所列 

的程序包从 APS 目录下载。 

• 其中 

示例 

[-package-version -package-release 

-package-vendor -package-packager 

] 

定义 -package-name 选项指定的应用程序包。若未指定 , 则从 APS 目录下载最新版的程 

序包。 

下列命令从 APS 目录 http://apscatalog.com 下载最新版的 WordPress 应用程序。 


./aps -d -package-name WordPress -catalog-url http://apscatalog.com 


aps -d -package-name WordPress -catalog-url http://apscatalog.com 

获取下载任务状态 

若要获取下载状态 , 使用下列命令 : 

aps 

示例 

下列命令获取下载任务 ID 16 的状态。 


./aps -g 16 


aps -g 16



安装应用程序要求您识别要安装的源程序包。按 ID 识别或 

name-version-release-vendor-packager 信息识别程序包。 

若要提供程序包 ID, 执行 : 

• 使用导入 Panel 后分配给程序包的 ID ( 第 175 页 ) 

• 使用从 APS 目录成功下载后分配给程序包的 ID ( 第 176 页 ) 

• 使用从可用程序包信息返回的 ID ( 第 181 页 ) 

若要提供 name-version-release-vendor-packager 信息 , 从可安装的程序包检索信息 ( 第 181 

页 )。


在站点或子站点上安装应用程序 

若要在站点 / 子站点上安装应用程序 , 使用命令 : 

aps 

< 

| 

> 

< 

| 

> 

[installation options] 

其中 

• 其中 

|- 

负责指定应用程序设置 (XML 格式 ( 第 180 页 ))。设置定义指定成命令参数 , 文件名或直接 

从 STDIN 中读取。其他情况下 ,"-" 应指定为命令函数。 

有关设置格式和样本 , 参阅应用程序设置定义子章节 ( 第 180 页 )。 

• 其中 

| 

指定应用程序安装来源。按程序包 ID、名称、版本、发行号、厂商和打包工具指定程序包。 

使用 --get-packages-list 命令 ( 第 181 页 ) 获取程序包属性。 

• 其中 

| 

指定要安装应用程序的站点或子站点。 

可用选项 


-ssl 

-url-pref 

ix 

true|fals 

e 

 

指定应用程序是否可以通过 HTTPS 协议访问。 

指定站点 / 子站点 URL。 

若安装博客工具应用程序 , 并指定 URL 前缀 "blog", 可从 

http://domain-name/blog 访问应用程序。 

-db-name 在应用程序安装中指定数据库名称。 

-db-user < 登录名 > 在应用程序安装中指定数据库用户名称。



-passwd 在应用程序安装中指定数据库用户密码。 

示例 

1. 下列命令在站点 example.com,ID 13 上安装应用程序包 , 应用程序可通过 URL 

example.com/blog 访问 , 文件 WordPress.xml 中定义了其设置 , 安装后 , 即创建安装数据库 

WordPress。 


# ./aps -i /home/apps/WordPress.xml -package-id 13 -domain example.com -ssl 

false -url-prefix blog -db-name WordPress -db-user BlogAdmin -passwd P4$$w0rd 


>aps -i "E:\apps\WordPress.xml" -package-id 13 -domain example.com -ssl false 

-url-prefix blog -db-name WordPress -db-user BlogAdmin -passwd P4$$w0rd 

2. 下列命令仅使用所需选项安装同一应用程序 , 应用程序设置从 STDIN 读取。在 Linux/Unix 

中 : 

# cat /home/apps/WordPress.xml | ./aps --install - -package-id 13 -domain 

example.com -db-name WordPress -db-user BlogAdmin -passwd P4$$w0rd 


>aps --install - -package-id 13 -domain example.com -db-name WordPress -db-user 

BlogAdmin -passwd P4$$w0rd < C:\temp\WordPress.xml 

3. 下列命令在子站点 api.example.com 上从程序包 ID 14 安装应用程序 , 此应用程序不需要数 

据库。 


# ./aps -i /home/apps/empty.xml -package-id 14 -domain api.example.com -ssl true 


>aps -i "E:\apps\empty.xml" -package-id 14 -domain api.example.com -ssl true


应用程序设置定义 

若应用程序有任何设置 , 当在站点或子站点上安装应用程序实例时 ,aps 实用程序从文件或 

STDIN 读取应用程序设置定义。 

设置定义应为结构如下的 XML 文件 : 

• settings, required 

Root XML 元素 , 包含设置集和 

• setting, required 

设置定义 


指定设置名称 , 从应用程序包元数据文件中获取设置 ID 

("setting[@id]")(APP-META.xml 位于 *.app.zip)。 


例如 , 

指定设置值。 

 

< 设置 > 

< 设置。> 

admin_email 


 

< 设置。> 

admin_passwd 

p4$$w0rd 

 

< 设置。> 

site_name 

iScripts socialWare 

 

< 设置。> 

locale 

en-US 

 


检索可用数据包 

若要检索应用程序包信息 (ID、名称、版本、发行号、厂商、打包程序 ), 使用命令 : 

aps 

格式如下。 


./aps -gp 


aps -gp

Parallels Panel 配置指南 - Parent Directory

Create successful ePaper yourself

Delete template?

Save as template?