跳轉到

使用 API 監控服務狀態

您可以使用 Postman 集合的 Product Details 資料夾中提供的此要求,擷取任何 Megaport 服務(例如 Port、VXC、MCR 或 MVE)的狀態:

GET {baseUrl}/v2/product/{productUid}

回應中的 provisioningStatus 欄位會包含該服務的佈建狀態。 provisioningStatus 欄位可能具有下列值:

Provisioning Status (佈建狀態) Description (說明) Port (連接埠) MCR VXC
NEW 僅適用於預先訂購 Port。此狀態表示服務訂單已被接受,正在等待基礎設施可用。 此狀態僅適用於 Port 的預訂。
該 Port 無法接受任何連線(例如 VXC),且不會計費。
不適用 不適用
DEPLOYABLE 服務訂單已確認,正在等待部署。服務通常會在此狀態維持 1-2 分鐘。
CONFIGURED 部署已完成,服務已在網路上完成設定。
LIVE 此狀態的意義取決於產品。 已在網路上偵測到該服務為 Live。在 Port 上偵測到光,表示已接上交叉連接並已啟用 Port。 從 CONFIGURED 切換到 LIVE 是即時的。 從 CONFIGURED 切換到 LIVE 是 即時的。
CANCELLED, CANCELLED_PARENT 已提出終止該服務的要求。服務通常會在此狀態維持 1-2 分鐘。 Ports 僅支援「now」終止。 MCRs 僅支援「now」終止。 VXCs 可以單獨在「now」終止,或在終止所連接的 Port、MCR 或 MVE 時一併終止。
DECOMMISSIONED 該服務已自網路除役。服務在除役後 30 天將不再返回。
服務僅針對除役前實際使用的時間進行計費。簽有合約期間的產品將產生提前終止費用 (ETF)。
FAILED 無法部署該服務,且不在部署佇列中。

此外,對於任何 Megaport 服務,/v2/product/ 端點的回應也包含服務目前的狀態。根層級 up 屬性的狀態指出服務是否為 up(值為 true)或 down(值為 false)。此範例顯示 VXC 的 up 屬性。

{
    "message": "Found Product 9fbc4f9e-5f59-458e-bb95-6633e77ab121",
    "terms": "This data is subject to the Acceptable Use Policy https://www.megaport.com/legal/acceptable-use-policy",
    "data": {
        "productId": 220451,
        "productUid": "9fbc4f9e-5f59-458e-bb95-6633e77ab121",
        "productName": "WEST AWS",
        "secondaryName": null,
        "productType": "VXC",
        "rateLimit": 50,
        "maximumRate": 10000,
        "distanceBand": "METRO",
        "provisioningStatus": "LIVE",
        "usageAlgorithm": "POST_PAID_VARIABLE",
        "createdBy": "cb9c4d7e-4cd2-4f6b-4f4e-89ab263e57e4",
        "liveDate": 1733253865042,
        "createDate": 1733253767229,
        "resources": {
            "csp_connection": {
                "bandwidth": 50,
                "connectType": "AWSHC",
                "resource_name": "b_csp_connection",
                "resource_type": "csp_connection",
                "name": "WEST AWS",
                "ownerAccount": "206049248854",
                "bandwidths": [
                    50
                ],
                "connectionId": "dxcon-fftxgi4j"
            },
            "vll": {
                "a_vlan": 2612,
                "b_vlan": 2612,
                "rate_limit_mbps": 50,
                "resource_name": "vll",
                "resource_type": "vll",
                "up": 1,
                "shutdown": false
            }
        },
        "vxcApproval": {
            "status": null,
            "message": null,
            "uid": null,
            "type": null,
            "newSpeed": null
        },
        "contractStartDate": 1733253865055,
        "contractEndDate": 1735912800000,
        "contractTermMonths": 12,
        "companyUid": "160408ae-01e4-4cb9-8d57-03a147bd47a8",
        "companyName": "Megaport Test",
        "locked": false,
        "adminLocked": false,
        "attributeTags": {},
        "up": true,
        "shutdown": false,
        "cancelable": true,
        "aEnd": {
            "ownerUid": "160408ae-01e4-4cb9-8d57-03a147bd47a8",
            "productUid": "21be60a4-14c8-454f-9636-c6a4ad9f8447",
            "productName": "ZW TEST",
            "locationId": 147,
            "location": "CyrusOne Chandler",
            "locationDetail": {
                "name": "CyrusOne Chandler",
                "city": "Phoenix",
                "metro": "Phoenix",
                "country": "USA"
            },
            "vlan": 2612,
            "innerVlan": null,
            "secondaryName": null,
            "connectType": "DEFAULT",
            "diversityZone": "red"
        },
        "bEnd": {
            "ownerUid": "605cb840-dfb4-4a05-a171-8bf17757b4a2",
            "productUid": "d2b92be4-d85c-4ae5-b511-37c1cfe6e146",
            "productName": "US West (N. California) (us-west-1)",
            "locationId": 370,
            "location": "PhoenixNAP",
            "locationDetail": {
                "name": "PhoenixNAP",
                "city": "Phoenix",
                "metro": "Phoenix",
                "country": "USA"
            },
            "vlan": 2612,
            "innerVlan": null,
            "secondaryName": null,
            "connectType": "AWSHC",
            "diversityZone": "red"
        }
    }
}

參考資料