跳转至
Megaport 技术文档
API 弃用常见问题
Copy for LLM ▼
Copy Page Content Open in ChatGPT Open in Claude Open in VS Code View Markdown
PDF

API 弃用通知和常见问题 (FAQs)

本主题包含 API 弃用通知以及有关 API 版本更改的一些常见问题。

我们建议及时了解这些变更，并据此规划任何 API 集成更新。

有关本主题中提到的 API 的更多信息，请参阅 https://dev.megaport.com。

2025 年 9 月 - 全新 v4 定价 API

我们对定价 API 进行了重要更新，可能会影响到您。新版本 v4 现已发布，并取代此前的 v2 和 v3 定价 API。该版本用于获取所有服务的定价信息，包括 Ports、MCRs、MVEs、VXCs、Megaport Internet 连接、IXs，以及交叉连接等附加产品。

为确保系统持续正常运行，集成了这些 API 的所有用户都需要迁移至最新版本。请开始将您的 API 调用过渡到 v4，因为未来对新老服务以及附加费用的所有定价请求仅在该版本上得到支持。Megaport Terraform Provider 不受这些更新的影响。

主要变更如下表所示。已弃用的 v2 和 v3 API 将于 2026 年 3 月 15 日完全退役。

有关定价 API 的更多信息，请参阅 https://dev.megaport.com。

功能 旧版 API 新版 API
GET Port 价格 GET /v2/pricebook/megaport POST /v4/pricebook/product
GET VXC 价格（v3） GET /v3/pricebook/vxc POST /v4/pricebook/product
GET Megaport Internet 价格（v3） GET /v3/pricebook/vxc POST /v4/pricebook/product
GET MCR 价格 GET /v2/pricebook/mcr2 POST /v4/pricebook/product
GET MVE 价格 - 不含 Megaport Internet（v3） GET /v3/pricebook/mve POST /v4/pricebook/product
GET IX 价格 GET /v2/pricebook/ix POST /v4/pricebook/product
GET IP 地址 价格（新增） 不适用 POST /v4/pricebook/product
GET 交叉连接 价格（新增） 不适用 POST /v4/pricebook/addon
GET IPsec 价格（新增/即将推出） 不适用 POST /v4/pricebook/addon
GET 合同期限详细信息 GET /v2/product/portTerms/{productUid} POST /v4/pricebook/product/terms

2025 年 5 月 - API 版本更改

我们对 API 进行了重要更新，可能会影响到您。因此，目前集成了这些端点的所有用户都需要迁移至最新版本。

主要变更如下表所示。已弃用的 API 将于 2025 年 7 月 31 日完全退役。

从 v2 迁移到 v3：

  • v3 API 现已可用，并且以下功能必须使用 v3：
    • GET 所有服务的位置
    • POST 使用用户名和密码登录
    • 通知设置 API
    • GET 活动日志
    • 发票 API（另请注意，companyId 已更新为 companyUid，并且 supplierId 已添加到 URL 中）

从 v3 迁移到 v4：

  • GET MVE 镜像详细信息


功能 旧版 API 新版 API
GET 位置信息
返回可订购 Port、MCR 或 MVE 的数据中心列表。		 GET /v2/locations GET /v3/locations
POST 使用用户名和密码登录 POST /v2/login POST /v3/login
GET 列出通知设置 GET /v2/notificationPreferences GET /v3/notificationPreferences
PUT 更改通知设置 PUT /v2/notificationPreferences PUT /v3/notificationPreferences
GET 用户活动 GET /v2/activity GET /v3/activity
以下端点现均可用：
  • /v3/activity
  • /v3/companyActivity
  • /v3/activityNames
  • /v3/companyActivityNames
  • /v3/companyActivity/users
GET 发票
返回指定日期范围内，公司与计费市场组合的所有发票列表。		 /v2/company/${companyid}/invoice/
supplierId/{supplierId}?fromDate=${fromDate}
&toDate=${toDate}		 /v3/company/${companyUid}/invoice/
supplierId/{supplierId}?fromDate=${fromDate}
&toDate=${toDate}
GET 单张发票
以 JSON 格式返回指定发票。		 /v2/company/${companyid}/invoice/
${invoiceId}		 /v3/company/{companyUId}/supplier/
{supplierId}/invoice/{invoiceId}
GET 单张发票 PDF /v2/company/${companyid}/invoice/
${invoiceId}/pdf		 /v3/company/{companyUid}/supplier/
{supplierId}/invoice/{invoiceId}/pdf
GET 单张发票 CSV /v2/company/${companyId}/invoice/
${invoiceId}/csv		 /v3/company/{companyUid}/supplier/
{supplierId}/invoice/{invoiceId}/csv
GET MVE 镜像详细信息 GET /v3/product/mve/images GET /v4/product/mve/images

2024 年 2 月 - 新版发票 API

我们的发票 API 正在发生变更。

为确保您持续接收最准确、最新且完整的发票数据（包括贷项通知单和税务信息），您需要迁移至新的发票 API 端点。

有关发票 API 的更多信息，请参阅 https://dev.megaport.com。

哪些发票 API 受影响？

这些 API 端点已被弃用，并由新的 API 端点取代。

功能 旧版 API 新版 API
GET 发票 GET /v2/invoice
返回与用户账户关联的公司的发票列表。		 GET /v2/company/${companyUid}/invoice/supplierId/{supplierId}?fromDate=${fromDate}&toDate=${toDate}?
返回指定日期范围内，公司 ID 与计费市场 ID 组合的发票列表。
GET 单张发票 GET v2/invoice/{invoiceId}
返回指定的 invoiceId 对应的发票。		 GET /v2/company/${companyId}/invoice/${invoiceId}
以 JSON 格式返回指定 companyId 与 invoiceId 的发票。
GET 单张发票 PDF GET /v2/invoice/{invoiceId}/pdf
返回指定 invoiceId 的发票 PDF 版本。		 GET /v2/company/${companyId}/invoice/${invoiceId}/pdf
返回指定 companyId 与 invoiceId 的发票 PDF 版本。
GET 单张发票 CSV GET /v2/invoice/{invoiceId}/csv
返回指定 invoiceId 的发票 CSV 版本。		 GET /v2/company/${companyId}/invoice/${invoiceId}/csv
返回指定 companyId 与 invoiceId 的发票 CSV 版本。

我在哪里可以找到供应商和公司信息？

所有新的发票 API 都要求您在 API 调用中提供公司和供应商信息。您可以从以下 Megaport API 中获取这些值：

  • supplierId 是相关供应商在 GET Billing Markets /v2/market API 中返回的 “firstPartyId”。
  • companyUid 可在 GET Product List /v2/products API 或 GET API Keys /v2/auth/apikeys API 中获取。
  • companyId 可在 GET Company Details /v2/company/companyUid API 中获取。

我什么时候需要开始使用新的发票 API？

尽快。新的发票 API 目前已在生产环境可用，今后与发票相关的任何增强仅会应用到新的 API。

旧版发票 API 何时退役？

旧版发票 API 已被弃用，不再受支持。

我可以联系谁以获取更多信息？

请联系您的客户经理或 Megaport 支持团队。更多信息，参见联系支持。

2023 年 4 月 - v2 MVE API

2023 年 4 月，我们发布了新版 Megaport Virtual Edge（MVE）。此前，MVE 以预置的计算、虚拟电路和 Megaport Internet 规格的捆绑形式提供。在最新版本中，我们将 Megaport Internet 解耦，使计算与 Virtual Cross Connects（VXCs）以及 Megaport Internet 连接分离。通过将计算与传输功能解耦，您现在可以通过进一步自定义网络来获得更高的可配置性和灵活性，以满足您的需求。

MVE 现已提供多种规格，并将内存 RAM 提升至上一版本的两倍，从而带来更佳性能。计算规格现为 2/8、4/16、8/32 以及更高容量选项，其中第一个数字为 CPU，第二个数字为可用 RAM（GB）。

为启用此新功能，我们创建了 v3 API，可分别作为独立产品获取价格、校验、下单、编辑和删除 MVE 与 Megaport Internet 连接。现有 API 集成方如果希望更改其 Megaport Internet 连接的速率，必须对接新的 v3 API。

因此，除 MVE 与 Megaport Internet 连接外，集成了其他服务类型（包括 Ports、MCRs、VXCs 和 IXs）的 Validate 与 Buy API 的用户，也需要迁移到最新的 v3 版本。除版本号外，这些服务类型的 url、请求体或响应体均无变更。

为保持对现有 API 集成方的向后兼容性，API 用户可继续使用当前 v2 Megaport API 调用来订购捆绑的 MVE，直至 2024 年 9 月 30 日，届时旧版 v2 API 将被弃用。使用 v2 API 订购 MVE 时，将自动创建一个与所选 MVE 规格关联的默认速率 Megaport Internet 连接。

我们鼓励所有集成方迁移并在订购 MVE 与 Megaport Internet 连接时使用 v3 API，以充分利用额外的灵活性。

我们的客户 Portal 已在以下功能上切换至 v3：

获取 MVE 与 VXC 的价格：

  • GET /v3/pricebook/mve?locationId={locationId}&vendor={vendor}&size={size}
  • GET /v3/pricebook/vxc?bLocationId={bLocationId}&aLocationId={aLocationId}

所有服务类型的 Validate 和 Buy：

  • POST /v3/networkdesign/validate
  • POST /v3/networkdesign/buy

仅更新 VXC：

  • PUT /v3/product/vxc/{productUid}

删除所有服务类型：

  • POST /v3/product/{productUid}/action/{action}

我什么时候需要开始使用 MVE API v3？

尽快，且不晚于 2024 年 9 月。MVE v3 API 目前已在生产环境可用，今后与 MVE 和 Megaport Internet 连接相关的任何增强仅会应用到 v3 API。

何时弃用 MVE v2 API？

MVE v2 API 将于 2024 年 9 月 30 日弃用。

受影响的 v2 API 有哪些？

下表列出了受这些变更影响的 v2 API：

功能 旧版 API 新版 API
获取 MVE 价格 GET /v2/pricebook/mve
返回 MVE + Megaport Internet 连接的价格。		 GET /v3/pricebook/mve
仅返回 MVE 计算的价格。
获取 VXC 价格 GET /v2/pricebook/vxc
不返回 Megaport Internet 价格。		 GET /v3/pricebook/vxc
当 connectType=transit 时，返回 Megaport Internet 连接的价格。
校验所有产品类型的订单：Port、MCR、MVE、VXC、IX POST /v2/networkdesign/validate
对于 MVE，将 MVE 与 Megaport Internet 连接一并校验。		 POST /v3/networkdesign/validate
对于 MVE，仅校验 MVE 本身。
Note (注意)： 可用规格为： "SMALL" "MEDIUM" "LARGE" "X_LARGE_12".
购买所有产品类型的服务：Port、MCR、MVE、VXC、IX POST /v2/networkdesign/buy
对于 MVE，将 MVE 与 Megaport Internet 连接一并购买。		 POST /v3/networkdesign/buy
对于 MVE，仅购买 MVE 本身。
可以单独购买 Megaport Internet 连接。
更新 VXC 详情 PUT /v2/product/vxc/{productUid}
无法更新 Megaport Internet 连接。		 PUT /v3/product/vxc/{productUid}
可以更新 Megaport Internet 连接。
删除所有产品类型的服务：Port、MCR、MVE、VXC、IX POST /v2/product/{productUid}/
action/{action}		 POST /v3/product/{productUid}/
action/{action}

如果我未能按时迁移怎么办？

您的 MVE 集成将停止工作，您将无法订购新的或更新现有的 MVE。如需更多信息，请联系您的客户经理。

我可以联系谁以获取更多信息？

请联系您的客户经理或 Megaport 支持团队。更多信息，参见联系支持。