Parallels Panel 設定指南 - Parent Directory

Parallels ® 

Panel 

開發人員指南 

設定指南

目錄 

前言 4 

排版約定 ........................................................................................................................................ 4 

回饋 ............................................................................................................................................... 5 

關於此檔案 6 

交付流程注意事項 8 

部署 Panel 9 

獨立部署 ...................................................................................................................................... 10 

獲取版本 ID ....................................................................................................................... 11 

獲取產品組件清單 ............................................................................................................. 12 

安裝 Panel ......................................................................................................................... 14 

安裝程式 CLI 參考 ( 簡化 ) .................................................................................................. 15 

安裝指令碼 (Linux/Unix) ................................................................................................... 17 

在 Parallels Containers 環境中部署 ............................................................................................. 18 

Parallels Containers for Unix ............................................................................................. 19 

Parallels Containers for Windows ..................................................................................... 22 

使用 Rsync 實用程式設定鏡像 ..................................................................................................... 23 

建立 Linux/Unix 分發包鏡像 .............................................................................................. 24 

建立 Windows 分發包鏡像 ................................................................................................. 27 

安裝操作概要 29 

初始化 Panel ................................................................................................................................ 30 

安裝授權 ...................................................................................................................................... 30 

定義 Panel 標誌 ........................................................................................................................... 31 

設定 DNS ..................................................................................................................................... 32 

變更 SOA 記錄模板 ........................................................................................................... 33 

設定資源記錄模板 ............................................................................................................. 33 

安裝 SSL 憑證 .............................................................................................................................. 34 

建立網站及子網站 ........................................................................................................................ 35 

安裝應用程式 ............................................................................................................................... 36 

匯入套用套裝程式 ............................................................................................................. 37 

安裝應用程式 ..................................................................................................................... 37 

定義可用的 APS 目錄 .................................................................................................................. 38 

APS 目錄設定檔 ................................................................................................................ 39 

透過遠端 API 設定 40 

使用遠端 API ............................................................................................................................... 41

前言 3 

關於遠端 API ..................................................................................................................... 41 

API RPC 封包 .................................................................................................................... 42 

建立客戶軟體 ..................................................................................................................... 45 

設定 Panel ................................................................................................................................... 70 

初始化 Panel ..................................................................................................................... 70 

安裝授權 ............................................................................................................................ 74 

設定 DNS ........................................................................................................................... 79 

安裝 SSL 憑證 ................................................................................................................. 104 

建立網站 .......................................................................................................................... 110 

建立子網站 ...................................................................................................................... 115 

定義可用的 APS 目錄 ...................................................................................................... 120 

安裝應用程式 ................................................................................................................... 123 

透過 CLI 設定 167 

關於 Panel CLI ........................................................................................................................... 168 

設定 Panel ................................................................................................................................. 169 

初始化 Panel ................................................................................................................... 170 

安裝授權 .......................................................................................................................... 171 

定義 Panel 標誌 ............................................................................................................... 171 

設定 DNS ......................................................................................................................... 173 

安裝 SSL 憑證 ................................................................................................................. 179 

建立網站 .......................................................................................................................... 181 

建立子網站 ...................................................................................................................... 181 

定義可用的 APS 目錄 ...................................................................................................... 183 

安裝應用程式 ................................................................................................................... 184

4 前言 

前言 

本節內容 

排版約定 ............................................................................................................ 4 

回饋 ................................................................................................................... 5 

排版約定 

在您開始使用本指南之前 , 瞭解其中使用的文件約定十分重要。 

內文中以下格式類型表示特定資訊。 

格式約定資訊類型範例 

特殊粗體 

您必頇選擇的項目 , 如功能 

表選項、指令按鈕或清單中 

的項目。 

前往 “ 系統 ” 標籤。 

章、節和小節的標題。請參閱 “ 基本管理 ” 一章。 

斜體 

用於強調某段文字的重要 

性 , 以介紹某個術語或指出 

將用真實名稱或實際值來取 

代的指令行佔位符。 

該系統支援通常所說的 “ 萬用字元 ” 

搜尋。 

等寬字型 

預定格式 

預定的粗體格式 

指令、檔案和目錄的名稱。授權檔位於 

http://docs/common/licen 

ses 目錄。 

螢幕上顯示的指令行工作階 

# ls –al /files 

total 14470 

段中的電腦輸出 ; 為 XML、 

C++ 或其他編程語言形式 

的原始碼。 

當您輸入時 , 與電腦螢幕輸 

出對比。 

# 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 環境中部署 ................................................................... 18 

使用 Rsync 實用程式設定鏡像 ........................................................................... 23

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 設定自 

訂鏡像 ( 第 23 頁 ), 確保安全安裝。 

本節內容 

獲取版本 ID ....................................................................................................... 11 

獲取產品組件清單 .............................................................................................. 12 

安裝 Panel ......................................................................................................... 14 

安裝程式 CLI 參考 ( 簡化 )................................................................................... 15 

安裝指令碼 (Linux/Unix) .................................................................................... 17


獲取版本 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 

若使用本機檔案系統 

或 

無 

若從 Panel 更新伺服器安裝 

• 組件 ( 第 12 頁 ) 安裝選項定義要安裝哪些 Panel 組件 

= 

--install-everything 

或 

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

[--install-component componentN]]] 

• 其他選項包括定義 Proxy 伺服器設定、安裝記錄等等。如需詳情 , 請參閱安裝程式 CLI 參考 

章節 ( 第 15 頁 ) 

如 ,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 | 從本機檔案系統檢索到 Panel 套裝程式後 , 指定 --source 選項指向包 

含要安裝的 Panel 相關的 .inf3 檔案。 

--target 

--proxy-host < 網路位址 

> 

--proxy-port < 連接埠號 

> 

從網路伺服器檢索到 Panel 套裝程式後 , 指定 --source 選項 

指向 Panel 更新伺服器鏡像所在的目錄。 

預設情況下 , 安裝程式將檢索到的檔案儲存到目錄 //psa。例如 , 若 root 使用者執行安裝程式 , 則會建立並使用 

/root/psa 目錄。若要使用自訂目錄存放檢索到的檔案 , 請使用 

--target 選項。 

如 : 

--target /opt/storage/psa 

或 

--target D:\temp 

使用 Proxy 伺服器或防火牆時 , 請使用此選項指定 Proxy 伺服器網域名 

稱或 IP 位址。 

如 : 

--proxy-host proxy.example.com 

連線 Proxy 伺服器的預設連接埠是 3128。若 Proxy 伺服器使用其他連接 

埠號 , 請使用此選項指定。 

如 : 

--proxy-port 5741


選項 

Proxy 伺服器認證選項。 

--proxy-user 

 

--proxy-password 

 

--show-releases 


若 Proxy 伺服器需要認證 , 請使用這些選項在 Proxy 伺服器上認證安裝 

程式。 

範例 : 

--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 更新伺服器本機鏡像 ( 參閱設定鏡像章節 ( 第 23 頁 )), 使用下列選項 : 

--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 ............................................................................. 19 

Parallels Containers for Windows ...................................................................... 22


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 版鏡像章節 ( 第 24 頁 )。 

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 分發包鏡像 ............................................................................... 24 

建立 Windows 分發包鏡像 ................................................................................. 27


建立 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 ..................................................................................................... 30 

安裝授權 ............................................................................................................ 30 

定義 Panel 標誌 ................................................................................................. 31 

設定 DNS .......................................................................................................... 32 

安裝 SSL 憑證 ................................................................................................... 34 

建立網站及子網站 .............................................................................................. 35 

安裝應用程式 ..................................................................................................... 36 

定義可用的 APS 目錄 ........................................................................................ 38

30 安裝操作概要 

初始化 Panel 

Panel 安裝後首先要執行的操作是初始化。禁止在 Panel GUI 或透過 API 執行任何操作。 

初始化設定下列 Panel 設定 : 

• 管理員的電子郵件 

• 管理員新密碼 , 不是預設密碼 

• ( 可選 ) Panel 語言 

若在 Panel 初始化中未設定語言 , 則會使用預設的美國英文 (en-US)。 

Panel 管理員可稍後變更介面語言 ( 安裝所需語言組件 ( 第 12 頁 ))。 

快速連結 

使用遠端 API 安裝 Panel ( 第 70 頁 ) 

使用 CLI 初始化 Panel ( 第 170 頁 ) 

安裝授權 

Panel 分發版隨附支援有限使用者帳戶的預設授權。您需獲取並安裝滿足使用者需求的授權。 

除定義 Panel 主要功能的主授權之外 , 也可安裝附加授權 , 即可使用 Panel 載入項 , 如 Dr.Web 

防病毒解決方案。 

快速連結 

使用遠端 API 安裝授權 ( 第 74 頁 ) 

使用 CLI 安裝授權 ( 第 171 頁 )


定義 Panel 標誌 

Panel 交付範圍內的 Panel 商標資訊 : 

• Panel 標誌類型影像和 URL 

• 支援按鈕連結 

注意 :CLI 中支援兩者。 

標誌 

Panel 標誌類型顯示在 Panel 左上角。預設是 141*29 畫素的 GIF 影像 ,Parallels Small Business 

Panel 產品標誌類型 , 按它即可開啟 Parallels 網站。可變更預設標誌影像和 URL。 

支援 

支援按鈕位於 Panel 管理員可以使用的設定標籤上。預設情況下 , 按按鈕即可開啟 Parallels 網 

站上的技術支援請求表單 , 假定由管理員完成和提交。 

若要向客戶提供技術支援 , 按一下支援按鈕即可變更 URL。 

快速連結 

使用 CLI 建立 Panel 標誌 ( 第 171 頁 )


設定 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 ( 第 79 頁 ) 

使用 CLI 設定 DNS ( 第 173 頁 ) 

本節內容 

變更 SOA 記錄模板 ............................................................................................ 33 

設定資源記錄模板 .............................................................................................. 33


變更 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 憑證 ( 第 104 頁 ) 

使用 CLI 安裝 SSL 憑證 ( 第 179 頁 )


建立網站及子網站 

網站 

Parallels Small Business Panel 中新型的網站和子網站建立與設定流程簡單且輕鬆。建立網站 

或子網站時 , 請指定最基本的主機參數 , 其他主機設定會自動完成。 

因此 , 若要建立網站 , 請指定下列函數 : 

• 網域名稱 

• IP 位址 

若 IP 位址與 SSL 憑證關聯 ( 第 34 頁 ), 則會自動啟用使用此 IP 建立網站的 SSL 支援。 

• 要求的虛擬主機內容 : 用來上傳網站內容的 FTP 帳戶登入名和密碼。 

在網站上安裝 Web 應用程式時 ,Panel 會自動設定應用程式所需的所有服務。因此必頇在 

網站建立過程中指定 IP 位址、FTP 登入名和密碼。 

快速連結 

使用遠端 API 建立網站 ( 第 110 頁 ) 

使用 CLI 建立網站 ( 第 181 頁 ) 

子網站 

建立子網站時 , 至少要指定子網站和主網站的前置詞名。 

子網站內容通常位於網站虛擬主機的 /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 建立子網站 ( 第 115 頁 ) 

使用 CLI 建立子網站 ( 第 181 頁 ) 

安裝應用程式 

Parallels Small Business Panel 支援 APS 應用程式。這些是按 APS - 應用程式交付標準 

(http://www.apsstandard.org/) 打包的 Web 應用程式 , 將 SaaS 模式推向主機頁。 

術語套用套裝程式 - 以 APS 格式打包的 Web 應用程式 zip 存檔。與應用程式不同 , 它從套裝 

程式直接安裝。 

在網站或子網站上安裝應用程式分兩步完成 : 

1 獲取套用套裝程式 , 並匯入 Panel。 

2 在網站或子網站上從套裝程式安裝應用程式。 

快速連結 

使用遠端 API 安裝應用程式 ( 第 123 頁 ) 

使用遠端 CLI 安裝應用程式 ( 第 184 頁 ) 

本節內容 

匯入套用套裝程式 .............................................................................................. 37 

安裝應用程式 ..................................................................................................... 37


匯入套用套裝程式 

有兩種方法可獲取並匯入套用套裝程式 : 

• 通常是自行建立的套裝程式 , 手動上傳到安裝 Panel 的主機上 , 並手動匯入到 Panel。 

• 下載套裝程式 , 並自動從 APS 目錄匯入到 Panel ( 提供套用套裝程式遠端存儲的網路服務 )。 

即可一次性下載並匯入多個應用程式 ,Panel 支援下載狀態追蹤。 

Panel 支援從多個 APS 目錄實例獲取套用套裝程式。可用的 APS 目錄在 APS 目錄設定檔 ( 第 

38 頁 ) 中有定義 , 可自訂來滿足特定主機環境中的 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 目錄樣本 ( 第 39 頁 )。 

2 匯入設定檔到 Panel 中。 

快速連結 

使用遠端 API 定義可用的 APS 目錄 ( 第 120 頁 ) 

使用 CLI 定義可用的 APS 目錄 ( 第 183 頁 )


本節內容 

APS 目錄設定檔 ................................................................................................ 39 

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 章節 ( 第 41 頁 ) 包括 API RPC 協議概要和用於透過協議與 Panel 管理的伺 

服器通訊的工具樣本。 

設定 Panel 章節 ( 第 70 頁 ) 描述協力廠商工具應執行 Panel 設定操作的請求資訊詳情 , 

以及從每個操作返回的回應資訊。 


使用遠端 API ..................................................................................................... 41 

設定 Panel ......................................................................................................... 70


使用遠端 API 

本章闡述 Panel 遠端 API 的定義、操作 , 以及如何建立透過遠端 API 與 Panel 通訊的用戶端應 

用程式。 

本節內容 

關於遠端 API ..................................................................................................... 41 

API RPC 封包 .................................................................................................... 42 

建立客戶軟體 ..................................................................................................... 45 

關於遠端 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 協議。

42 透過遠端 API 設定 

API RPC 封包 

API RPC 封包是包含在 HTTP 郵件內文中的簡易 XML 檔案。 

區別下面兩種封包 : 

• 申請封包 - 用戶端軟體透過遠端 API 發送給伺服器 

• 回應封包 - 伺服器發給客戶 

回應封包包含所請求操作的執行狀態 , 若操作失敗 , 還會包含錯誤資訊。 

本節內容 

封包結構 ............................................................................................................ 42 

封包實例 ............................................................................................................ 43 

封包驗證 ............................................................................................................ 44 

封包結構 

區分下列兩個 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 

 

 

 

 

P4$$w0rd 

johndoe@example.com 

de-DE 

 

 

 

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 協議所需的版本。 

封包內容 

從相關運算子標籤開始。 

特定封包使用 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 檔案標準標頭 

XML 封包標頭


 

 

 

ok 

 

 

 

 

封包內容 

封包內容的根節點是 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 

圖形操作時才執行此操作。


本節內容 

建立申請封包 ..................................................................................................... 46 

發送請求資訊 ..................................................................................................... 47 

解析回應 ............................................................................................................ 49 

處理錯誤 ............................................................................................................ 51 

客戶碼範例 ........................................................................................................ 52 

建立申請封包 

請求 API RPC 封包 , 客戶從 GUI 或軟體模組獲取指令對一或多個 Panel 物件執行操作。此應 

用程式會將請求的指令轉換成與 Panel XML API 相容的 XML 封包格式。 

若要實施 XML 封包轉換器指令 , 瞭解 API RPC 架構 , 以及如何透過 Panel 伺服器處理 ( 第 42 

頁 )。 

若要新增建立的請求封包驗證到轉換器 , 從 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 

封包結構 , 參閱封包結構章節 ( 第 42 頁 )。若使用 CURL 工具 , 返回的最終結果是純 XML 格 

式。 

Panel API RPC 伺服器返回的純 XML 封包由 XML 模板定義。 

封包是每個回應 XML 封包的根節點 , 版本內容返回伺服器上執行的 Panel API RPC 協議版本 

。 

特定運算子包含封包回應 , 或返回的系統 Panel 應用程式錯誤。 

有關系統和輸出節點方式相關資訊 , 參閱處理錯誤章節 ( 第 51 頁 )。 

若要瞭解回應結構 , 則需 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 客戶應用程式 ............................................................................................. 52 

C# Client Application ......................................................................................... 57 

VB.NET 客戶應用程式 ....................................................................................... 63 

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 

指定目的 URL:


CURLOPT_RETURNTRANS 

FER 

CURLOPT_POST 

CURLOPT_SSL_VERIFYPE 

ER 

CURLOPT_SSL_VERIFYHO 

ST 

CURLOPT_HTTPHEADER 

設定成 true 表示將從伺服 

器返回字串格式的最終輸 

出。 

設定成 true 表示即將透過 

HTTP POST 發送封包。 

設定成 false 讓 CURL 停止 

驗證同類憑證。 

設定成 false 讓 CURL 停止 

驗證主機。 

指定要設定的 HTTP 標頭 

欄位。 

返回 URL 工作階段處理器。 

function sendRequest() 

function parseResponse() 

function checkResponse() 

透過 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。 

獲取相應封包 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, 模擬結果節點上的內 

容。 

程式碼樣本 


$xmldoc = new DomDocument('1.0', 'UTF-8'); 

$xmldoc->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 驗證模板驗證請求封包。呼叫 


生成 HTTP 請求 : 將 HTTP 標頭和連續 XML 封包到 

HttpWebRequest 類型的物件。返回此物件。 

獲取 agent_input.xsd URI 和字串閱讀器 ( 要 

驗證的 XML 封包 URI) 到輸入參數。驗證封包 , 並 

返回樹狀結構圖 (XmlDocument 物件 )。 

獲取請求封包 (HttpWebRequest 物件 ) 到輸入參 

數。透過 HTTP 發送封包 , 從伺服器接收回應封包 , 

使用 agent_output.xsd 模板驗證 , 並返回樹狀 

結構的回應 XML 封包 (XmlDocument 物件 )。


類 Program 執行 ' 客戶 ' 控制台應用程式。 

static void Main (string[]) 

private static bool 

RemoteCertificateValidation 

(object, X509Certificate, 

X509Chain, SslPolicyErrors) 

private static void 

XmlSchemaValidation (object, 

ValidationEventArgs) 

static void 

PrintResult(XmlDocument) 

PanelApiRpcClient 應用程式進入點。獲取函數佇 

列 ( 字串 ) 到輸入參數。選項有 : 

[0] - Panel 管理的伺服器主機名 (IP 位址 ) 

[1] - Panel 管理員登入名 

[2] - Panel 管理員密碼 

[3] - 所用的 API RPC 協議 

[4] - 內有 XML 請求封包的 XML 檔案。 

函數生成請求類封包 ( 如上所示 ), 驗證 , 發送請求 

到 Panel, 然後列印出最終 XML 封包。 

函數驗證遠端 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. 呼叫 


獲取請求封包 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)


"10.49.8.120"; 

"1.6.2.0"; 

request.Hostname = args(0) 

request.Login = args(1) 

request.Password = args(2) 

request.Protocol = args(3) 

' 

' "admin"; 

' "setup"; 

' 

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 設定操作。 

本節內容 


安裝授權 ............................................................................................................ 74 

設定 DNS .......................................................................................................... 79 

安裝 SSL 憑證 ................................................................................................... 104 

建立網站 ............................................................................................................ 110 

建立子網站 ........................................................................................................ 115 

定義可用的 APS 目錄 ........................................................................................ 120 

安裝應用程式 ..................................................................................................... 123 


若要透過 API RPC 初始化 Panel, 使用 smb/initial_setup 操作模式執行 XML 請求封包 : 

 

 

 

... 

 

 

 

本節內容 

請求封包結構 ..................................................................................................... 71 

請求樣本 ............................................................................................................ 71 

回應封包結構 ..................................................................................................... 72 

回應樣本 ............................................................................................................ 73


請求封包結構 

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 請求封包 : 

 

 

 

... 

 

 

 

本節內容 

請求封包結構 ..................................................................................................... 74 

請求樣本 ............................................................................................................ 75 

回應封包結構 ..................................................................................................... 78 

回應樣本 ............................................................................................................ 79 


安裝授權的請求 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 服務 ................................................................................................... 80 

變更 SOA 記錄模板 ............................................................................................ 82 

設定資源記錄模板 .............................................................................................. 85


停用 DNS 服務 

若要使用 API RPC 停用 Panel DNS 服務 , 執行包含 dns/disable 操作節點的 XML 請求 : 

 

 

 

 

 

本節內容 

請求封包 ............................................................................................................ 80 

回應封包 ............................................................................................................ 81 

請求封包 

下列請求封包停用 DNS 服務 : 

 

 

 

 


回應封包 

輸出 XML 封包的停用節點結構如下 : 




資料類型 :resultType (common.xsd). 





樣本 


正回應類似於 : 

 

 

 

 

ok 

 

 

 



若要設定新 SOA 記錄模板 , 執行包含 dns/set 操作節點的 XML 請求封包 : 

 

 

 

... 

 

 

 

本節內容 

請求封包結構 ..................................................................................................... 83 

請求樣本 ............................................................................................................ 84 

回應封包結構 ..................................................................................................... 84 

回應樣本 ............................................................................................................ 85



若要設定新 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 模板 ..................................................................................................... 86 

檢索 DNS 區域模板相關資訊 ............................................................................. 94 

移除 RR 模板 ..................................................................................................... 99


新增 RR 模板 

若要新增 DNS 區域資源記錄模板 , 執行包含 dns/add-rec 操作模式的 XML 請求封包 : 

 

 

 

... 

 

 

 

本節內容 

請求封包結構 ..................................................................................................... 87 

請求樣本 ............................................................................................................ 88 

回應封包結構 ..................................................................................................... 92 

回應樣本 ............................................................................................................ 93



新增 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 

 

 

 

透過遠端 API 設定 91



輸出 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 封包 : 

 

 

 

 

 

 

 

 

本節內容 

回應封包結構 ..................................................................................................... 95 

回應樣本 ............................................................................................................ 97



輸出 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 


 

 

 

 

移除 RR 模板 

若要從 DNS 區域模板移除 RR, 執行包含 dns/del_rec 操作節點的 XML 封包 : 

 

 

 

... 

 

 

 

本節內容 

請求封包結構 ..................................................................................................... 99 

請求樣本 ............................................................................................................ 100 

回應封包結構 ..................................................................................................... 101 

回應樣本 ............................................................................................................ 102 


移除 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 


4 


 

error 

1013 


5 

 

 

 

 


若要安裝 SSL 憑證 , 執行包含 certificate/install 操作節點的 XML 請求封包 : 

 

< 憑證 > 

 

… 

 

 

 

本節內容 

請求封包結構 ..................................................................................................... 105 

請求樣本 ............................................................................................................ 106 

回應封包結構 ..................................................................................................... 108 

回應樣本 ............................................................................................................ 109



請求 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 

 

 

 

透過遠端 API 設定 107



輸出 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 請求封包 : 

 

 

 

… 

 

 

 

本節內容 

請求封包結構 ..................................................................................................... 110 

請求樣本 ............................................................................................................ 112 

回應封包結構 ..................................................................................................... 112 

回應樣本 ............................................................................................................ 114 


建立網站帳戶的請求 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 請求封包 : 

 

< 子網站 > 

 

… 

 

 

 

本節內容 

請求封包結構 ..................................................................................................... 115 

請求樣本 ............................................................................................................ 117 

回應封包結構 ..................................................................................................... 118 

回應樣本 ............................................................................................................ 119 


新增新子網站的請求 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 

請求封包 : 

 

 

 

... 

 

 

 

設定檔 ( 第 39 頁 ) 應先透過上傳運算子 ( 第 124 頁 ) 上傳到伺服器。 

本節內容 

請求封包結構 ..................................................................................................... 120 

請求樣本 ............................................................................................................ 121 

回應封包結構 ..................................................................................................... 122 

回應樣本 ............................................................................................................ 123 


請求封包的 import-config 節點結構如下 : 

• filename, required 

指定上傳到伺服器的設定檔名。資料類型 : 字串。 

值上傳回應 ( 第 131 頁 ) 是中的暫時檔名 ( 位於 "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 運算子。 

本節內容 

匯入套用套裝程式 .............................................................................................. 124 

安裝應用程式 ..................................................................................................... 150



本節內容 

將檔案上傳到伺服器 .......................................................................................... 124 

匯入上傳的應用套裝程式 ................................................................................... 134 

從 APS 目錄下載套用套裝程式 .......................................................................... 138 

獲取下載工作狀態 .............................................................................................. 143 

將檔案上傳到伺服器 

若要上傳檔案到 Panel 管理的伺服器 , 使用上傳運算子。不同於其他操作 , 上傳運算子不使用 

標準請求封包結構。而是使用發佈方式 http://www.w3.org/Protocols/rfc2616/rfc2616-sec9.html 

來上傳檔案。 

當 Panel 處理請求時 , 回應包含在一般回應 XML 封包中。上傳檔案到 Panel 後 , 則可用於其他 

操作。 

注意 : 也可使用 FTP 管理員上傳檔案 , 注意對檔案進行 API RPC 操作可能會出現權限問題。 

建議使用上傳運算子。 

本節內容 

使用 cURL 上傳檔案 .......................................................................................... 124 

使用 PHP 上傳檔案 ............................................................................................ 126 

使用 .NET 上傳檔案 .......................................................................................... 128 

回應封包結構 ..................................................................................................... 131 

回應樣本 ............................................................................................................ 133 

使用 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 要上傳的檔案全名。 


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 

 

 


匯入上傳的應用套裝程式 

若要匯入上傳的應用套裝程式 ( 第 124 頁 ) 到 Panel, 執行包含 aps/import-package 操作模式的 

XML 請求 : 

 

 

 

... 

 

 

 

本節內容 

請求封包結構 ..................................................................................................... 134 

請求樣本 ............................................................................................................ 135 

回應封包結構 ..................................................................................................... 136 

回應樣本 ............................................................................................................ 137 


匯入 APS 封包到 Panel 的 XML 封包包含 import-package 操作節點 , 結構如下 : 

• filename, required 

指定上傳到伺服器的應用套裝程式名稱。資料類型 : 字串。 

值上傳回應 ( 第 131 頁 ) 是中的暫時檔名 ( 位於 "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 ( 第 143 頁 ) 檢視 

。 

本節內容 

請求封包結構 ..................................................................................................... 139 

請求樣本 ............................................................................................................ 140 

回應封包結構 ..................................................................................................... 141 

回應樣本 ............................................................................................................ 142



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 目錄設定檔 ( 第 39 頁 ) 中相同 , 否則會出現錯誤 1013。 

若未包含在封包中 , 從最先在 APS 目錄設定檔 ( 第 120 頁 ) 中定義的 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 目錄設定檔 ( 第 120 頁 ) 清單中 , 則返回下列回應。若 

請求的 URL 不同於設定檔中定義的 URL 也是下列回應。若 APS 目錄設定中定義的 URL 遺失 

斜線。 

 

 

 

 

error 

1013 

目錄中的 URL "http://apscatalog.com" 不存在 

 

 

 

 

若 APS 目錄 URL 無法解析 , 返回此類負回應 : 

 

 

 

 

error 

1023 

無法解析主機 :apscatalog.co; 無請求類型的資料記錄 

 

 

 

 

若 APS 目錄設定檔 ( 第 120 頁 ) 格式錯誤 , 返回此類負回應 : 

 

 

 

 

error 

1023 

APS 目錄設定檔損壞 

 

 

 


獲取下載工作狀態 

若要檢索套裝程式下載工作狀態 , 執行包含 aps/get-download-status 操作節點的 XML 請求封包 : 

 

 

 

... 

 

 

 

可能的狀態 : 

• "finished/error" - 未在 APS 目錄中找到套裝程式 , 導致無法啟動工作 

• "finished/package-id" - 成功完成工作 

• "in-progress/current" - 套裝程式下載中 

• "in-progress" 缺少 "current" 子節點 - 未開始下載套裝程式 , 但已在佇列中 

本節內容 

請求封包結構 ..................................................................................................... 143 

請求樣本 ............................................................................................................ 144 

回應封包結構 ..................................................................................................... 145 

請求和回應樣本 ................................................................................................. 147 


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 ( 第 136 頁 ) 

• 使用從 APS 目錄成功下載後分配給套裝程式的 ID ( 第 145 頁 ) 

• 使用從可用套裝程式資訊返回的 ID ( 第 163 頁 ) 

若要提供 name-version-release-vendor-packager 資訊 , 從可安裝的套裝程式檢索資訊 ( 第 

161 頁 )。 

本節內容 

在網站或子網站上安裝應用程式 ........................................................................ 150 

檢索可用封包 ..................................................................................................... 161 

在網站或子網站上安裝應用程式 

若要安裝應用程式 , 執行包含 aps/install 操作節點的 XML 請求封包 : 

 

 

 

... 

 

 

 

本節內容 

請求封包結構 ..................................................................................................... 151 

請求樣本 ............................................................................................................ 155 

回應封包結構 ..................................................................................................... 156 

回應樣本 ............................................................................................................ 157



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 操作獲取 ( 第 161 頁 )。 

• 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" 元素 )。 

應用程式元資料檔案中未指定預設值 , 則使用設定元素。 


指定設定 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 操作檢索可在網站 / 子網站上安裝的應用套裝程式資訊 : 

 

 

 

... 

 

 

 

本節內容 

請求封包結構 ..................................................................................................... 161 

請求樣本 ............................................................................................................ 162 

回應封包結構 ..................................................................................................... 163 

請求和回應樣本 ................................................................................................. 165 


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 章節 ( 第 168 頁 ) 概述 CLI 使用基本資訊。 

設定 Panel 章節 ( 第 169 頁 ) 詳細闡述要執行的 Panel 設定操作。 


關於 Panel CLI .................................................................................................. 168 

設定 Panel ......................................................................................................... 169

168 透過 CLI 設定 

關於 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%


設定 Panel 

本章闡述要在 Panel 設定操作中執行的指令詳細資訊。 

本節內容 


安裝授權 ............................................................................................................ 171 

定義 Panel 標誌 ................................................................................................. 171 

設定 DNS .......................................................................................................... 173 

安裝 SSL 憑證 ................................................................................................... 179 

建立網站 ............................................................................................................ 181 

建立子網站 ........................................................................................................ 181 

定義可用的 APS 目錄 ........................................................................................ 183 

安裝應用程式 ..................................................................................................... 184



若要透過 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 實用程式。 

本節內容 

變更標誌 ............................................................................................................ 172 

變更支援 URL .................................................................................................... 172


變更標誌 

兩步即可變更 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 服務 ................................................................................................... 173 

變更 SOA 記錄模板 ............................................................................................ 173 

設定資源記錄模板 .............................................................................................. 174 

停用 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] 

指定 TTL 時段。 

Panel 設定的預設值為一天。 

指定重新整理時段。 

Panel 設定的預設值為三小時。 

指定重詴時段。 

Panel 設定的預設值為一小時。 

指定過期日。 

Panel 設定的預設值為一週。



-soa-minimum [S| 

M|H|D|W] 

指定最小值。 

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 覆寫區域模板。修改後 , 透過移除所有區域模板記錄 , 即可使用一條指令覆寫新記錄設定。 

本節內容 

新增記錄 ............................................................................................................ 175 

覆寫 DNS 區域模板中的記錄 ............................................................................. 177


新增記錄 

若要新增一條資源紀錄到 DNS 區域模板中 , 使用下列指令 : 

server_dns 

記錄參數和範例 

參數函數描述範例 

-a |"" 

-ip 

|"" 

指定記錄設定要套用到的主機 

名。 

指定 IP 位址或網站 IP 位址佔 

位符 , 建立 A 資源記錄模板。 

若要新增新 A 資源記錄 

sample. ( 指定記錄的網站 IP 

位址佔位符 ) 到網站 DNS 區域模板 : 

server_dns -a -a sample -ip 

"" 

NS 記錄參數和範例 


-ns 

-nameserv 

er 

|"" 

|"[.]" 


名。 

指定網域名稱伺服器名稱或佔 

位符 , 建立 NS 資源記錄模板。 

若要新增新 NS 資源記錄 , 指定 

"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 上傳到機器。 

本節內容 

匯入憑證 ............................................................................................................ 180 

分配憑證到 IP 位址 ............................................................................................ 181


匯入憑證 

若要匯入憑證 , 執行格式如下的指令 : 

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 目錄設定檔章節 ( 第 39 頁 )。 

範例 

下列指令匯入 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 實用程式。 

本節內容 

匯入套用套裝程式 .............................................................................................. 184 

安裝應用程式 ..................................................................................................... 186 


本節內容 

匯入上傳的應用套裝程式 ................................................................................... 185 

從 APS 目錄下載套用套裝程式 .......................................................................... 185 

獲取下載工作狀態 .............................................................................................. 186


匯入上傳的應用套裝程式 

若要匯入套用套裝程式 , 使用下列指令 : 

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 與設定檔中相同 )。若未指定 , 則按設定檔 ( 第 39 頁 ) 中所列的 

套裝程式從 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 ( 第 185 頁 ) 

• 使用從 APS 目錄成功下載後分配給套裝程式的 ID ( 第 186 頁 

• 使用從可用套裝程式資訊返回的 ID ( 第 190 頁 ) 

若要提供 name-version-release-vendor-packager 資訊 , 從可安裝的套裝程式檢索資訊 ( 第 

190 頁 )。 

本節內容 

在網站或子網站上安裝應用程式 ........................................................................ 187 

檢索可用封包 ..................................................................................................... 190


在網站或子網站上安裝應用程式 

若要在網站 / 子網站上安裝應用程式 , 使用指令 : 

aps 

< 

| 

> 

< 

| 

> 

[installation options] 

其中 

• 其中 

|- 

負責指定應用程式設定 (XML 格式 ( 第 189 頁 ))。設定定義指定成指令參數 , 檔名或直接 

從 STDIN 中讀取。其他情況下 ,"-" 應指定為指令函數。 

有關設定格式和樣本 , 參閱應用程式設定定義子章節 ( 第 189 頁 )。 

• 其中 

| 

指定應用程式安裝來源。按套裝程式 ID、名稱、版本、發行號、廠商和打包工具指定套裝 

程式。使用 --get-packages-list 指令 ( 第 190 頁 ) 獲取套裝程式內容。 

• 其中 

| 

指定要安裝應用程式的網站或子網站。 

可用選項 


-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 

本節內容 

應用程式設定定義 .............................................................................................. 189


應用程式設定定義 

若應用程式有任何設定 , 當在網站或子網站上安裝應用程式實例時 ,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

You also want an ePaper? Increase the reach of your titles

Delete template?

Save as template?