hostinger-api-mcp

hostinger-api-mcp

Hostinger API 的模型上下文协议 (MCP) 服务器。

先决条件

• Node.js 版本 20 或更高版本

如果你尚未安装 Node.js，可以从官方网站下载。或者，你也可以使用包管理器（例如Homebrew （适用于 macOS）或Chocolatey （适用于 Windows））来安装 Node.js。

我们建议使用NVM（Node 版本管理器）来安装和管理已安装的 Node.js 版本。安装 NVM 后，您可以使用以下命令安装 Node.js：

安装

要安装 MCP 服务器，请根据您的包管理器运行以下命令之一：

更新

要将 MCP 服务器更新到最新版本，请根据您的包管理器使用以下命令之一：

配置

运行服务器时可以配置以下环境变量：

• DEBUG ：启用调试日志记录（true/false）（默认值：false）
• APITOKEN ：您的 API 令牌，将在Authorization标头中发送。

用法

Claude、Cursor 等的 JSON 配置。

使用 SSE 传输

要使用 MCP 服务器的 SSE 传输，您必须在运行服务器时使用--sse选项。这将使服务器能够通过本地主机 8100 端口上的服务器发送事件与客户端通信。此外，您还可以指定--host和--port选项来设置服务器监听的主机和端口。

使用 SSE 传输运行服务器的示例：

用作 MCP 工具提供商

该服务器实现了模型上下文协议 (MCP)，并且可以与任何兼容 MCP 的消费者一起使用，例如 Claude.js 客户端或其他 MCP 消费者。

从 Claude.js 客户端连接到此服务器的示例：

可用工具

该 MCP 服务器提供以下工具：

billing_getCatalogItemListV1

此端点检索可供订购的目录项列表。

目录项中的价格显示为美分（不带浮点数），例如：浮点数17.99显示为整数1799 。

• 方法： GET
• 路径： /api/billing/v1/catalog

参数：

• category ：按类别过滤目录项
• name ：按名称过滤目录项。使用*进行通配符搜索，例如.COM*查找 .com 域名

billing_createNewServiceOrderV1

此端点创建一个新的服务订单。

要下单，您需要提供付款方式 ID、目录端点中的商品价格列表以及数量。优惠券也可在创建订单时提供。

使用此端点创建的订单将被设置为自动续订。

部分credit_card付款可能需要额外验证，导致购买交易无法处理。如果您遇到此问题，我们建议您使用credit_card以外的其他付款方式。

• 方法： POST
• 路径： /api/billing/v1/orders

参数：

• payment_method_id ：付款方式ID（必填）
• items ：items 参数（必需）
• coupons ：折扣优惠券代码

billing_setDefaultPaymentMethodV1

此端点为您的帐户设置默认付款方式。

• 方法： POST
• 路径： /api/billing/v1/payment-methods/{paymentMethodId}

参数：

• paymentMethodId ：付款方式ID（必填）

billing_deletePaymentMethodV1

此端点从您的帐户中删除一种付款方式。

• 方法： DELETE
• 路径： /api/billing/v1/payment-methods/{paymentMethodId}

参数：

• paymentMethodId ：付款方式ID（必填）

billing_getPaymentMethodListV1

此端点检索可用于下达新订单的可用付款方式列表。

如果您想添加新的付款方式，请使用hPanel 。

• 方法： GET
• 路径： /api/billing/v1/payment-methods

billing_cancelSubscriptionV1

此端点取消订阅并停止任何进一步的计费。

• 方法： DELETE
• 路径： /api/billing/v1/subscriptions/{subscriptionId}

参数：

• subscriptionId ：订阅 ID（必填）

billing_getSubscriptionListV1

此端点检索与您的帐户关联的所有订阅的列表。

• 方法： GET
• 路径： /api/billing/v1/subscriptions

DNS_getSnapshotV1

此端点使用 DNS 区域记录的内容检索特定的 DNS 快照。

• 方法： GET
• 路径： /api/dns/v1/snapshots/{domain}/{snapshotId}

参数：

• domain ：域名（必填）
• snapshotId ：快照ID（必填）

DNS_getSnapshotListV1

此端点检索 DNS 快照列表。

• 方法： GET
• 路径： /api/dns/v1/snapshots/{domain}

参数：

• domain ：域名（必填）

DNS_restoreSnapshotV1

此端点将 DNS 区域恢复到选定的快照。

• 方法： POST
• 路径： /api/dns/v1/snapshots/{domain}/{snapshotId}/restore

参数：

• domain ：域名（必填）
• snapshotId ：快照ID（必填）

DNS_getRecordsV1

此端点检索特定域的 DNS 区域记录。

• 方法： GET
• 路径： /api/dns/v1/zones/{domain}

参数：

• domain ：域名（必填）

DNS_updateZoneRecordsV1

此端点更新所选域的 DNS 记录。

使用overwrite = true将用提供的记录替换现有记录。否则，将更新现有记录并添加新记录。

• 方法： PUT
• 路径： /api/dns/v1/zones/{domain}

参数：

• domain ：域名（必填）
• overwrite ：如果为true ，则删除与名称和类型匹配的资源记录 (RR)，并创建新的 RR；否则，更新资源记录的 TTL 并添加新记录。如果未找到匹配的 RR，则创建新的 RR。
• zone ：区域参数（必需）

DNS_deleteZoneRecordsV1

此端点用于删除所选域名的 DNS 记录。要过滤要删除的记录，请将记录name和type添加到过滤器中。单个请求可以包含多个过滤器。

如果您有多个具有相同名称和类型的记录，并且只想删除其中的一部分，请参阅Update zone records端点。

• 方法： DELETE
• 路径： /api/dns/v1/zones/{domain}

参数：

• domain ：域名（必填）

DNS_resetZoneRecordsV1

此端点将 DNS 区域重置为默认记录。

• 方法： POST
• 路径： /api/dns/v1/zones/{domain}/reset

参数：

• domain ：域名（必填）
• sync ：确定操作是否应同步运行
• reset_email_records ：确定是否应重置电子邮件记录
• whitelisted_record_types ：指定不重置的记录类型

DNS_validateZoneRecordsV1

此端点用于验证所选域的 DNS 记录更新之前的情况。

如果验证成功，响应将包含200 Success代码。如果验证错误，响应将失败，并返回422 Validation error代码。

• 方法： POST
• 路径： /api/dns/v1/zones/{domain}/validate

参数：

• domain ：域名（必填）
• overwrite ：如果为true ，则删除与名称和类型匹配的资源记录 (RR)，并创建新的 RR；否则，更新资源记录的 TTL 并添加新记录。如果未找到匹配的 RR，则创建新的 RR。
• zone ：区域参数（必需）

domains_checkDomainAvailabilityV1

此端点用于检查域名的可用性。您可以一次检查多个顶级域名 (TLD)。如果您希望在响应中获取其他域名，请在请求中仅提供一个 TLD，并将with_alternatives设置为true 。提供的 TLD 不应以点开头（例如com 、 net 、 org ）。

端点的速率限制为每分钟 10 个请求。

• 方法： POST
• 路径： /api/domains/v1/availability

参数：

• domain ：域名（不含 TLD）（必填）
• tlds ：TLD 列表（必需）
• with_alternatives ：响应是否应包含替代方案

domains_getForwardingDataV1

此端点检索域转发数据。

• 方法： GET
• 路径： /api/domains/v1/forwarding/{domain}

参数：

• domain ：域名（必填）

domains_deleteForwardingDataV1

此端点删除域名转发数据。

• 方法： DELETE
• 路径： /api/domains/v1/forwarding/{domain}

参数：

• domain ：域名（必填）

domains_createForwardingDataV1

此端点创建域转发数据。

• 方法： POST
• 路径： /api/domains/v1/forwarding

参数：

• domain ：域名（必填）
• redirect_type ：重定向类型（必需）
• redirect_url ：转发域名到的 URL（必需）

domains_enableDomainLockV1

此端点用于为域名启用域名锁定。启用域名锁定后，如果不先禁用锁定，则无法将域名转移到其他注册商。

• 方法： PUT
• 路径： /api/domains/v1/portfolio/{domain}/domain-lock

参数：

• domain ：域名（必填）

domains_disableDomainLockV1

此端点用于禁用域名的域名锁定。将域名转移到其他注册商之前，需要禁用域名锁定。

• 方法： DELETE
• 路径： /api/domains/v1/portfolio/{domain}/domain-lock

参数：

• domain ：域名（必填）

domains_getDomainV1

此端点检索指定域的详细信息。

• 方法： GET
• 路径： /api/domains/v1/portfolio/{domain}

参数：

• domain ：域名（必填）

domains_getDomainListV1

此端点检索与您的帐户关联的所有域的列表。

• 方法： GET
• 路径： /api/domains/v1/portfolio

domains_purchaseNewDomainV1

此端点允许您购买并注册新域名。如果注册失败，请登录 hPanel 查看域名注册状态。

如果没有提供付款方式，则将自动使用您的默认付款方式。

如果未提供 WHOIS 信息，则将使用该 TLD（顶级域名）的默认联系信息。在提交请求之前，请确保您的帐户中已包含所需 TLD 的 WHOIS 信息。

部分顶级域名 (TLD) 要求提供additional_details ，这些附加信息将在完成购买前进行验证。所需的附加信息因顶级域名而异。

• 方法： POST
• 路径： /api/domains/v1/portfolio

参数：

• domain ：域名（必填）
• item_id ：目录价格商品ID（必填）
• payment_method_id ：付款方式ID
• domain_contacts ：域名联系信息
• additional_details ：附加注册数据，可能的值取决于 TLD
• coupons ：折扣优惠券代码

domains_enablePrivacyProtectionV1

此端点为域名启用隐私保护。启用隐私保护后，域名所有者的个人信息将在公共 WHOIS 数据库中隐藏。

• 方法： PUT
• 路径： /api/domains/v1/portfolio/{domain}/privacy-protection

参数：

• domain ：域名（必填）

domains_disablePrivacyProtectionV1

此端点禁用域名的隐私保护。禁用隐私保护后，域名所有者的个人信息将在公共 WHOIS 数据库中可见。

• 方法： DELETE
• 路径： /api/domains/v1/portfolio/{domain}/privacy-protection

参数：

• domain ：域名（必填）

domains_updateNameserversV1

此端点为指定域设置名称服务器。

请注意，不正确的名称服务器配置可能会导致域名无法解析或不可用。

• 方法： PUT
• 路径： /api/domains/v1/portfolio/{domain}/nameservers

参数：

• domain ：域名（必填）
• ns1 ：名字服务器（必需）
• ns2 ：第二个名称服务器（必需）
• ns3 ：第三个名称服务器
• ns4 ：第四个名称服务器

domains_getWHOISProfileV1

此端点检索 WHOIS 联系人资料。

• 方法： GET
• 路径： /api/domains/v1/whois/{whoisId}

参数：

• whoisId ：WHOIS ID（必填）

domains_deleteWHOISProfileV1

此端点删除 WHOIS 联系人资料。

• 方法： DELETE
• 路径： /api/domains/v1/whois/{whoisId}

参数：

• whoisId ：WHOIS ID（必填）

domains_getWHOISProfileListV1

此端点检索 WHOIS 联系人资料列表。

• 方法： GET
• 路径： /api/domains/v1/whois

参数：

• tld ：按 TLD 过滤（不带前导点）

domains_createWHOISProfileV1

此端点创建 WHOIS 联系人资料。

• 方法： POST
• 路径： /api/domains/v1/whois

参数：

• tld ：域名的 TLD（不带前导点）（必需）
• country ：ISO 3166 2 个字母的国家代码（必填）
• entity_type ：法人实体类型（必填）
• tld_details ：TLD 详细信息
• whois_details ：WHOIS 详细信息（必填）

domains_getWHOISProfileUsageV1

此端点检索使用提供的 WHOIS 联系人资料的域列表。

• 方法： GET
• 路径： /api/domains/v1/whois/{whoisId}/usage

参数：

• whoisId ：WHOIS ID（必填）

VPS_getDataCentersListV1

此端点检索所有可用数据中心的列表。

• 方法： GET
• 路径： /api/vps/v1/data-centers

VPS_activateFirewallV1

此端点为指定的虚拟机激活防火墙。

一台虚拟机每次只能激活一个防火墙。

• 方法： POST
• 路径： /api/vps/v1/firewall/{firewallId}/activate/{virtualMachineId}

参数：

• firewallId ：防火墙 ID（必需）
• virtualMachineId ：虚拟机 ID（必需）

VPS_deactivateFirewallV1

此端点停用指定虚拟机的防火墙。

• 方法： POST
• 路径： /api/vps/v1/firewall/{firewallId}/deactivate/{virtualMachineId}

参数：

• firewallId ：防火墙 ID（必需）
• virtualMachineId ：虚拟机 ID（必需）

VPS_getFirewallV1

此端点通过其 ID 和与其关联的规则检索防火墙。

• 方法： GET
• 路径： /api/vps/v1/firewall/{firewallId}

参数：

• firewallId ：防火墙 ID（必需）

VPS_deleteFirewallV1

此端点删除指定的防火墙。

任何激活此防火墙的虚拟机都会自动将其停用。

• 方法： DELETE
• 路径： /api/vps/v1/firewall/{firewallId}

参数：

• firewallId ：防火墙 ID（必需）

VPS_getFirewallListV1

此端点检索所有可用防火墙的列表。

• 方法： GET
• 路径： /api/vps/v1/firewall

参数：

• page ：页码

VPS_createNewFirewallV1

此端点创建一个新的防火墙。

• 方法： POST
• 路径： /api/vps/v1/firewall

参数：

• name ：名称参数（必需）

VPS_updateFirewallRuleV1

此端点从指定的防火墙更新特定的防火墙规则。

任何激活此防火墙的虚拟机都将与防火墙失去同步，并且必须手动再次同步。

• 方法： PUT
• 路径： /api/vps/v1/firewall/{firewallId}/rules/{ruleId}

参数：

• firewallId ：防火墙 ID（必需）
• ruleId ：防火墙规则 ID（必需）
• protocol ：协议参数（必需）
• port ：端口或端口范围，例如：1024:2048（必填）
• source ：源参数（必需）
• source_detail ：IP 范围、CIDR、单个 IP 或any （必需）

VPS_deleteFirewallRuleV1

此端点从指定的防火墙中删除特定的防火墙规则。

任何激活此防火墙的虚拟机都将与防火墙失去同步，并且必须手动再次同步。

• 方法： DELETE
• 路径： /api/vps/v1/firewall/{firewallId}/rules/{ruleId}

参数：

• firewallId ：防火墙 ID（必需）
• ruleId ：防火墙规则 ID（必需）

VPS_createFirewallRuleV1

此端点会从指定的防火墙创建新的防火墙规则。默认情况下，防火墙会丢弃所有传入流量，这意味着您必须为所有要使用的端口添加接受规则。

任何激活此防火墙的虚拟机都将与防火墙失去同步，并且必须手动再次同步。

• 方法： POST
• 路径： /api/vps/v1/firewall/{firewallId}/rules

参数：

• firewallId ：防火墙 ID（必需）
• protocol ：协议参数（必需）
• port ：端口或端口范围，例如：1024:2048（必填）
• source ：源参数（必需）
• source_detail ：IP 范围、CIDR、单个 IP 或any （必需）

VPS_syncFirewallV1

此端点同步指定虚拟机的防火墙。

如果防火墙添加、删除或更新了新规则，防火墙可能会与虚拟机失去同步。

• 方法： POST
• 路径： /api/vps/v1/firewall/{firewallId}/sync/{virtualMachineId}

参数：

• firewallId ：防火墙 ID（必需）
• virtualMachineId ：虚拟机 ID（必需）

VPS_getPostInstallScriptV1

此端点通过其 ID 检索安装后脚本。

• 方法： GET
• 路径： /api/vps/v1/post-install-scripts/{postInstallScriptId}

参数：

• postInstallScriptId ：安装后脚本 ID（必需）

VPS_updatePostInstallScriptV1

此端点更新特定的安装后脚本。

• 方法： PUT
• 路径： /api/vps/v1/post-install-scripts/{postInstallScriptId}

参数：

• postInstallScriptId ：安装后脚本 ID（必需）
• name ：脚本的名称（必需）
• content ：脚本内容（必需）

VPS_deleteAPostInstallScriptV1

此端点从您的帐户中删除安装后脚本。

• 方法： DELETE
• 路径： /api/vps/v1/post-install-scripts/{postInstallScriptId}

参数：

• postInstallScriptId ：安装后脚本 ID（必需）

VPS_getPostInstallScriptListV1

此端点检索与您的帐户关联的安装后脚本列表。

• 方法： GET
• 路径： /api/vps/v1/post-install-scripts

参数：

• page ：页码

VPS_createPostInstallScriptV1

此端点允许您向您的帐户添加新的安装后脚本，然后可以在安装虚拟机实例后运行该脚本。

脚本内容将保存到文件/post_install中，并设置可执行属性，并在虚拟机安装完成后执行。脚本的输出将重定向到/post_install.log 。脚本最大大小为 48KB。

• 方法： POST
• 路径： /api/vps/v1/post-install-scripts

参数：

• name ：脚本的名称（必需）
• content ：脚本内容（必需）

VPS_attachPublicKeyV1

此端点将您帐户中的现有公钥附加到指定的虚拟机。

可以将多个密钥附加到单个虚拟机。

• 方法： POST
• 路径： /api/vps/v1/public-keys/attach/{virtualMachineId}

参数：

• virtualMachineId ：虚拟机 ID（必需）
• ids ：要附加的公钥 ID（必需）

VPS_deleteAPublicKeyV1

此端点从您的帐户中删除公钥。

从帐户中删除公钥并不会将其从虚拟机中删除

• 方法： DELETE
• 路径： /api/vps/v1/public-keys/{publicKeyId}

参数：

• publicKeyId ：公钥ID（必填）

VPS_getPublicKeyListV1

此端点检索与您的帐户关联的公钥列表。

• 方法： GET
• 路径： /api/vps/v1/public-keys

参数：

• page ：页码

VPS_createNewPublicKeyV1

此端点允许您向您的帐户添加新的公钥，然后可以将其附加到虚拟机实例以进行安全访问。

• 方法： POST
• 路径： /api/vps/v1/public-keys

参数：

• name ：名称参数（必需）
• key ：关键参数（必需）

VPS_getTemplateV1

此端点检索虚拟机的特定操作系统模板的详细信息。

• 方法： GET
• 路径： /api/vps/v1/templates/{templateId}

参数：

• templateId ：模板ID（必填）

VPS_getTemplateListV1

此端点检索虚拟机可用的操作系统模板列表。

• 方法： GET
• 路径： /api/vps/v1/templates

VPS_getActionV1

此端点检索在指定虚拟机上执行的特定操作的详细信息。

此端点允许您查看有关特定操作的详细信息，包括操作名称、时间戳和状态。

• 方法： GET
• 路径： /api/vps/v1/virtual-machines/{virtualMachineId}/actions/{actionId}

参数：

• virtualMachineId ：虚拟机 ID（必需）
• actionId ：操作 ID（必需）

VPS_getActionListV1

此端点检索在指定虚拟机上执行的操作列表。

操作是指已在虚拟机上执行的操作或事件，例如启动、停止或修改虚拟机。此端点允许您查看这些操作的历史记录，并提供有关每个操作的详细信息，例如操作名称、时间戳和状态。

• 方法： GET
• 路径： /api/vps/v1/virtual-machines/{virtualMachineId}/actions

参数：

• virtualMachineId ：虚拟机 ID（必需）
• page ：页码

VPS_getAttachedPublicKeysV1

此端点检索附加到指定虚拟机的公钥列表。

• 方法： GET
• 路径： /api/vps/v1/virtual-machines/{virtualMachineId}/public-keys

参数：

• virtualMachineId ：虚拟机 ID（必需）
• page ：页码

VPS_deleteBackupV1

此端点删除虚拟机的指定备份。

• 方法： DELETE
• 路径： /api/vps/v1/virtual-machines/{virtualMachineId}/backups/{backupId}

参数：

• virtualMachineId ：虚拟机 ID（必需）
• backupId ：备份 ID（必需）

VPS_getBackupListV1

此端点检索指定虚拟机的备份列表。

• 方法： GET
• 路径： /api/vps/v1/virtual-machines/{virtualMachineId}/backups

参数：

• virtualMachineId ：虚拟机 ID（必需）
• page ：页码

VPS_restoreBackupV1

此端点恢复指定虚拟机的备份。

然后系统将启动恢复过程，这可能需要一些时间，具体取决于备份的大小。

虚拟机上的所有数据都将被备份的数据覆盖。

• 方法： POST
• 路径： /api/vps/v1/virtual-machines/{virtualMachineId}/backups/{backupId}/restore

参数：

• virtualMachineId ：虚拟机 ID（必需）
• backupId ：备份 ID（必需）

VPS_setHostnameV1

此端点用于设置指定虚拟机的主机名。更改主机名不会自动更新 PTR 记录。如果您希望虚拟机可通过主机名访问，则需要将域 A/AAAA 记录也指向虚拟机 IP。

• 方法： PUT
• 路径： /api/vps/v1/virtual-machines/{virtualMachineId}/hostname

参数：

• virtualMachineId ：虚拟机 ID（必需）
• hostname ：主机名参数（必需）

VPS_resetHostnameV1

此端点将指定虚拟机的主机名和 PTR 记录重置为默认值。

• 方法： DELETE
• 路径： /api/vps/v1/virtual-machines/{virtualMachineId}/hostname

参数：

• virtualMachineId ：虚拟机 ID（必需）

VPS_getVirtualMachineV1

此端点检索有关指定虚拟机的详细信息。

• 方法： GET
• 路径： /api/vps/v1/virtual-machines/{virtualMachineId}

参数：

• virtualMachineId ：虚拟机 ID（必需）

VPS_getVirtualMachineListV1

此端点检索所有可用虚拟机的列表。

• 方法： GET
• 路径： /api/vps/v1/virtual-machines

VPS_getScanMetricsV1

此端点检索安装在指定虚拟机上的Monarx恶意软件扫描程序的扫描指标。扫描指标提供有关 Monarx 执行的恶意软件扫描的详细信息，包括扫描次数、检测到的威胁以及其他相关统计信息。这些信息对于监控虚拟机的安全状态和评估恶意软件扫描程序的有效性非常有用。

• 方法： GET
• 路径： /api/vps/v1/virtual-machines/{virtualMachineId}/monarx

参数：

• virtualMachineId ：虚拟机 ID（必需）

VPS_installMonarxV1

此端点在指定的虚拟机上安装 Monarx 恶意软件扫描程序。

Monarx是一款安全工具，旨在检测并预防虚拟机上的恶意软件感染。通过安装 Monarx，用户可以增强虚拟机的安全性，确保其免受恶意软件的侵害。

• 方法： POST
• 路径： /api/vps/v1/virtual-machines/{virtualMachineId}/monarx

参数：

• virtualMachineId ：虚拟机 ID（必需）

VPS_uninstallMonarxV1

此端点用于卸载指定虚拟机上的 Monarx 恶意软件扫描程序。如果未安装 Monarx，该请求仍会被处理，但不会有任何影响。

• 方法： DELETE
• 路径： /api/vps/v1/virtual-machines/{virtualMachineId}/monarx

参数：

• virtualMachineId ：虚拟机 ID（必需）

VPS_getMetricsV1

此端点检索指定虚拟机的历史指标。它包括以下指标：

• CPU 使用率
• 内存使用情况
• 磁盘使用情况
• 网络使用情况
• 正常运行时间
• 方法： GET
• 路径： /api/vps/v1/virtual-machines/{virtualMachineId}/metrics

参数：

• virtualMachineId ：虚拟机 ID（必需）
• date_from ：RFC 3339 第 5.6 节定义的日期时间符号（必需）
• date_to ：RFC 3339 第 5.6 节定义的日期时间符号（必需）

VPS_setNameserversV1

此端点用于设置指定虚拟机的域名服务器。请注意，不正确的域名服务器配置可能会导致虚拟机无法解析域名。

• 方法： PUT
• 路径： /api/vps/v1/virtual-machines/{virtualMachineId}/nameservers

参数：

• virtualMachineId ：虚拟机 ID（必需）
• ns1 ：ns1 参数（必需）
• ns2 ：ns2 参数

VPS_createPTRRecordV1

此端点为指定的虚拟机创建或更新 PTR（指针）记录。

• 方法： POST
• 路径： /api/vps/v1/virtual-machines/{virtualMachineId}/ptr

参数：

• virtualMachineId ：虚拟机 ID（必需）

VPS_deletePTRRecordV1

此端点删除指定虚拟机的 PTR（指针）记录。

一旦删除，对虚拟机 IP 地址的反向 DNS 查找将不再返回先前配置的主机名。

• 方法： DELETE
• 路径： /api/vps/v1/virtual-machines/{virtualMachineId}/ptr

参数：

• virtualMachineId ：虚拟机 ID（必需）

VPS_setPanelPasswordV1

此端点用于设置指定虚拟机的面板密码。如果虚拟机未使用面板操作系统，则该请求仍将被处理，但不会有任何影响。密码要求与重新创建虚拟机端点中的相同。

• 方法： PUT
• 路径： /api/vps/v1/virtual-machines/{virtualMachineId}/panel-password

参数：

• virtualMachineId ：虚拟机 ID（必需）
• password ：虚拟机的面板密码（必需）

VPS_startRecoveryModeV1

此端点用于启动指定虚拟机的恢复模式。恢复模式是一种特殊状态，允许用户执行系统救援操作，例如修复文件系统、恢复数据或排除导致虚拟机无法正常启动的问题。

虚拟机将启动恢复磁盘映像，原始磁盘映像将安装在/mnt目录中。

• 方法： POST
• 路径： /api/vps/v1/virtual-machines/{virtualMachineId}/recovery

参数：

• virtualMachineId ：虚拟机 ID（必需）
• root_password ：恢复模式的临时 root 密码（必需）

VPS_stopRecoveryModeV1

此端点将停止指定虚拟机的恢复模式。如果虚拟机未处于恢复模式，则此操作将失败。

• 方法： DELETE
• 路径： /api/vps/v1/virtual-machines/{virtualMachineId}/recovery

参数：

• virtualMachineId ：虚拟机 ID（必需）

VPS_recreateVirtualMachineV1

此端点将从头开始重新创建虚拟机。重新创建过程包括重新安装操作系统并将虚拟机重置为初始状态。如有快照，则将删除。

密码要求

密码将与泄露的密码数据库进行核对。密码要求如下：

• 至少 8 个字符长
• 至少一个大写字母
• 至少一个小写字母
• 至少一个数字
• 未公开泄露

此操作不可逆，并将导致虚拟机上存储的所有数据丢失！

• 方法： POST
• 路径： /api/vps/v1/virtual-machines/{virtualMachineId}/recreate

参数：

• virtualMachineId ：虚拟机 ID（必需）
• template_id ：模板 ID（必需）
• password ：虚拟机的密码。如果不提供，将生成随机密码。密码不会显示在响应中。
• post_install_script_id ：安装后脚本 ID

VPS_restartVirtualMachineV1

此端点重新启动指定的虚拟机。这相当于完全停止并重新启动虚拟机。如果虚拟机已停止，则它将被启动。

• 方法： POST
• 路径： /api/vps/v1/virtual-machines/{virtualMachineId}/restart

参数：

• virtualMachineId ：虚拟机 ID（必需）

VPS_setRootPasswordV1

此端点设置指定虚拟机的 root 密码。密码要求与重新创建虚拟机端点中的相同。

• 方法： PUT
• 路径： /api/vps/v1/virtual-machines/{virtualMachineId}/root-password

参数：

• virtualMachineId ：虚拟机 ID（必需）
• password ：虚拟机的 Root 密码（必需）

VPS_setupNewVirtualMachineV1

此端点将设置新购买的虚拟机。此类虚拟机处于initial状态。您可以使用/api/billing/v1/orders端点购买新虚拟机。

• 方法： POST
• 路径： /api/vps/v1/virtual-machines/{virtualMachineId}/setup

参数：

• virtualMachineId ：虚拟机 ID（必需）
• template_id ：模板 ID（必需）
• data_center_id ：数据中心 ID（必需）
• post_install_script_id ：安装后脚本 ID
• password ：虚拟机的密码。如果不提供，将生成随机密码。密码不会显示在响应中。
• hostname ：覆盖虚拟机的默认主机名
• install_monarx ：安装 Monarx 恶意软件扫描程序（如果支持）
• enable_backups ：启用每周备份计划
• ns1 ：ns1 参数
• ns2 ：ns2 参数
• public_key ：公钥参数

VPS_getSnapshotV1

此端点检索指定虚拟机的快照。

• 方法： GET
• 路径： /api/vps/v1/virtual-machines/{virtualMachineId}/snapshot

参数：

• virtualMachineId ：虚拟机 ID（必需）

VPS_createSnapshotV1

此端点创建指定虚拟机的快照。快照会捕获虚拟机在特定时间点的状态和数据，以便用户根据需要将虚拟机还原到该状态。此操作适用于备份、系统恢复以及测试更改，而不会影响虚拟机的当前状态。

创建新快照将覆盖现有快照！

• 方法： POST
• 路径： /api/vps/v1/virtual-machines/{virtualMachineId}/snapshot

参数：

• virtualMachineId ：虚拟机 ID（必需）

VPS_deleteSnapshotV1

此端点删除指定虚拟机的快照。

• 方法： DELETE
• 路径： /api/vps/v1/virtual-machines/{virtualMachineId}/snapshot

参数：

• virtualMachineId ：虚拟机 ID（必需）

VPS_restoreSnapshotV1

此端点使用快照将指定的虚拟机还原到先前的状态。通过快照还原，用户可以将虚拟机恢复到该状态，这对于系统恢复、撤消更改或测试非常有用。

• 方法： POST
• 路径： /api/vps/v1/virtual-machines/{virtualMachineId}/snapshot/restore

参数：

• virtualMachineId ：虚拟机 ID（必需）

VPS_startVirtualMachineV1

此端点启动指定的虚拟机。如果虚拟机已在运行，则请求仍会被处理，且不会产生任何影响。

• 方法： POST
• 路径： /api/vps/v1/virtual-machines/{virtualMachineId}/start

参数：

• virtualMachineId ：虚拟机 ID（必需）

VPS_stopVirtualMachineV1

此端点停止指定的虚拟机。如果虚拟机已停止，则请求仍会被处理，但不会有任何影响。

• 方法： POST
• 路径： /api/vps/v1/virtual-machines/{virtualMachineId}/stop

参数：

• virtualMachineId ：虚拟机 ID（必需）