擷取目前的維護模式狀態（預期的狀態： 開啟、關閉、等待中或已請求）。

[獲取] https://<node_ip> /api/v1/外部/維護模式

授權： 使用視訊網格使用者名稱（「admin」）和密碼的基本驗證。

範例回應：

範例回應 1：

{
    "status": {
        "code": 200,
        "message": "Success"
    },
    "result": {
        "isRegistered": true,
        "maintenanceMode": "pending/requested/on/off",
        "maintenanceModeLastUpdated": 1691135731847
    }
}

範例回應 2：

{
    "status": {
        "code": 401,
        "message": "login failed: incorrect password or username"
    }
}

範例回應 3：

{
    "status": {
        "code": 429,
        "message": "Too Many Requests"
    }
}

當您將「視訊網格」節點設定為維護模式時，它會正常關閉通話服務（停止接受新通話，並最多等待 2 小時現有通話才能完成）。

[放置] https://<node_ip> /api/v1/外部/維護模式

僅在沒有進行中的通話時，才調用此API 。

授權： 使用視訊網格使用者名稱（「admin」）和密碼的基本驗證。

主體：

{
      "maintenanceMode": "on"
}

• 維護模式 - 要設定的維護模式的狀態 - 「開啟」或「關閉」。

請求標頭：

「內容類型」： 「應用程式/json」

範例回應：

範例回應 1：

{
        "status": {  
            "code": 200,
            "message": "Your request to enable/disable maintenance mode was successful."
    }
}

範例回應 2：

{
      "status": {
          "code": 409,
          "message": "Maintenance Mode is already on/off"
    }
}

範例回應 3：

{
      "status": {
          "code": 400,
          "message": "Bad Request - wrong input"   
    }
}

變更管理員使用者的密碼。

[放置] https://<node_ip> /api/v1/外部/密碼

授權： 使用視訊網格使用者名稱（「admin」）和密碼的基本驗證。

主體：

{
  "newPassword": "new"
}

• newPassword- 為「視訊網格節點」的「管理員」帳戶設定的新密碼。

請求標頭：

「內容類型」： 「應用程式/json」

範例回應：

範例回應 1：

{
    "status": {
        "code": 200,
        "message": "Successfully set the new passphrase for user admin."
    }
}

範例回應 2：

{
    "status": {
        "code": 400,
        "message": "Enter a new passphrase that wasn't used for one of the previous 3 passphrases."
    }
}

偵測是否啟用或停用外部網路。 若啟用了外部網路，它還會擷取外部IP位址、外部子網路遮罩和外部閘道。

[獲取] https://<node_ip> /api/v1/外部/外部網路

授權： 使用視訊網格使用者名稱（「admin」）和密碼的基本驗證。

範例回應：

範例回應 1：

{
    "status": {
        "code": 200,
        "message": "Successfully fetched external network configuration."
    },
    "result": {
        "ip": "1.1.1.1",
        "mask": "2.2.2.2",
        "gateway": "3.3.3.3"
    }
}

範例回應 2：

{
    "status": {
        "code": 200,
        "message": "External network not enabled."
    }
}

範例回應 3：

{
    "status": {
        "code": 500,
        "message": "Failed to get external network configuration."
    }
}

變更外部網路設定。 此API可用於啟用外部網路，以及設定或編輯具有外部IP位址、外部子網路遮罩和外部閘道的外部網路介面。 它還可用於停用外部網路。 進行外部網路組態變更後，節點會重新啟動以套用這些變更。

[放置] https://<node_ip> /api/v1/外部/外部網路

您只能為其預設管理員密碼已變更的新部署視訊網格節點設定此功能。 請勿在向組織註冊節點後使用此API 。

授權： 使用視訊網格使用者名稱（「admin」）和密碼的基本驗證。

主體：

啟用外部網路：

{
  "externalNetworkEnabled": true,
  "externalIp": "1.1.1.1",
  "externalMask": "2.2.2.2",
  "externalGateway": "3.3.3.3"
}

停用外部網路：

{
  "externalNetworkEnabled": false
}

• externalNetwork啟用 - 布林值 (true 或 false) 以啟用/停用外部網路

• externalIp - 要新增的外部IP

• externalMask - 外部網路的網絡掩網

• externalGateway - 外部網路的閘道

請求標頭：

「內容類型」： 「應用程式/json」

範例回應：

範例回應 1：

{
    "status": {
        "code": 200,
        "message": "Successfully saved the external network configuration. This node will reboot soon to apply the changes. Please wait for a minute and relogin to the node to verify that all changes were applied."
    }
}

範例回應 2：

{
    "status": {
        "code": 200,
        "message": "Successfully disabled the external network. This node will reboot soon to apply the changes. Please wait for a minute and relogin to the node to verify that all changes were applied."
    }
}

範例回應 3：

{
    "status": {
        "code": 400,
        "message": "One or more errors in the input: Value should be boolean for 'externalNetworkEnabled'"
    }
}

範例回應 4：

{
    "status": {
        "code": 400,
        "message": "External network configuration has not changed; skipping save of the external network configuration."
    }
}

擷取內部網路組態詳細資訊，包括網路模式、 IP位址、子網路遮罩、閘道、 DNS快取詳細資訊、 DNS伺服器、 NTP伺服器、內部介面 MTU、主機名稱和網域。

[獲取] https://<node_ip> /api/v1/外部/內部網路

授權： 使用視訊網格使用者名稱（「admin」）和密碼的基本驗證。

範例回應：

範例回應 1：

{
    "status": {
        "code": 200,
        "message": "Successfully fetched internal network details"
    },
    "result": {
        "dhcp": false,
        "ip": "1.1.1.1",
        "mask": "2.2.2.2",
        "gateway": "3.3.3.3",
        "dnsCaching": false,
        "dnsServers": [
            "4.4.4.4",
            "5.5.5.5"
        ],
        "mtu": 1500,
        "ntpServers": [
            "6.6.6.6"
        ],
        "hostName": "test-vmn",
        "domain": ""
    }
}

範例回應 2：

{
      "status": {
          "code": 500,
          "message": "Failed to get Network details."   
    }
}

範例回應 3：

{
      "status": {
          "code": 500,
          "message": "Failed to get host details."   
    }
}

使用新的 DNS 伺服器更新DNS伺服器。

[放置] https://<node_ip> /api/v1/外部/內部網路/DNS

在進行此變更之前，請將節點置於維護模式。 請參閱啟用或停用維護模式如需有關將節點移至維護模式的更多資訊。

授權： 使用視訊網格使用者名稱（「admin」）和密碼的基本驗證。

主體：

{
    "dnsServers": "1.1.1.1 2.2.2.2"
}

• dnsServers - 要更新的DNS伺服器。 允許多個以空格分隔的DNS伺服器。

請求標頭：

「內容類型」： 「應用程式/json」

範例回應：

範例回應 1：

{
    "status": {
        "code": 200,
        "message": "Successfully saved DNS servers"
    }
}

範例回應 2：

{
    "status": {
        "code": 409,
        "message": "Requested DNS server(s) already exist."
    }
}

範例回應 3：

{
    "status": {
        "code": 424,
        "message": "Maintenance Mode is not enabled. Kindly enable Maintenance Mode and try again for this node."
    }
}

使用新的NTP伺服器更新。

[放置] https://<node_ip> /api/v1/外部/內部網路/ntp

在進行此變更之前，請將節點置於維護模式。 請參閱啟用或停用維護模式如需有關將節點移至維護模式的更多資訊。

授權： 使用視訊網格使用者名稱（「admin」）和密碼的基本驗證。

主體：

{
    "ntpServers": "1.1.1.1 2.2.2.2"
}

• ntpServers - 要更新的NTP伺服器。 允許多個以空格分隔的NTP伺服器。

請求標頭：

「內容類型」： 「應用程式/json」

範例回應：

範例回應 1：

{
    "status": {
        "code": 200,
        "message": "Successfully saved the NTP servers."
    }
}

範例回應 2：

{
    "status": {
        "code": 409,
        "message": "Requested NTP server(s) already exist."
    }
}

範例回應 3：

{
    "status": {
        "code": 424,
        "message": "Maintenance Mode is not enabled. Kindly enable Maintenance Mode and try again for this node."
    }
}

更新視訊網格節點的主機名稱和網域。

[放置] https://<node_ip> /api/v1/外部/內部網路/主機

在進行此變更之前，請將節點置於維護模式。 節點會重新啟動以套用變更。 請參閱啟用或停用維護模式如需有關將節點移至維護模式的更多資訊。

授權： 使用視訊網格使用者名稱（「admin」）和密碼的基本驗證。

主體：

{
    "hostName": "test-vmn",
    "domain": "abc.com"
}

• hostName - 節點的新主機名稱。

• 網域 - 節點主機名稱的新網域（選用）。

請求標頭：

「內容類型」： 「應用程式/json」

範例回應：

範例回應 1：

{
    "status": {
        "code": 200,
        "message": "Successfully saved the host FQDN. This node will reboot soon to apply the changes. Please wait for a minute and relogin to the node to verify that all changes were applied."
    }
}

範例回應 2：

{
    "status": {
        "code": 400,
        "message": "Unable to resolve FQDN"
    }
}

範例回應 3：

{
    "status": {
        "code": 409,
        "message": "Entered hostname and domain already set to same."
    }
}

啟用或停用DNS快取。 如果DNS檢查的解析時間通常超過 750 毫秒，或者如果Cisco支援建議，請考慮啟用快取。

[放置] https://<node_ip> /api/v1/外部/內部網路/DNS 快取

在進行此變更之前，請將節點置於維護模式。 節點會重新啟動以套用變更。 請參閱啟用或停用維護模式如需有關將節點移至維護模式的更多資訊。

授權： 使用視訊網格使用者名稱（「admin」）和密碼的基本驗證。

主體：

{
    "dnsCaching": true
}

• dnsCaching - DNS快取設定。 接受布林值 (true 或 false)。

請求標頭：

「內容類型」： 「應用程式/json」

範例回應：

範例回應 1：

{
    "status": {
        "code": 200,
        "message": "Successfully saved DNS settings changes. This node will reboot soon to apply the changes. Please wait for a minute and relogin to the node to verify that all changes were applied."
    }
}

範例回應 2：

{
    "status": {
        "code": 400,
        "message": "One or more errors in the input: 'dnsCaching' field value should be a boolean"
    }
}

範例回應 3：

{
    "status": {
        "code": 409,
        "message": "dnsCaching is already set to false"
    }
}

將節點網路介面的最大傳輸單位 (MTU) 由預設值1500 變更。 允許使用 1280 到 9000 之間的值。

[放置] https://<node_ip> /api/v1/外部/內部網路/mtu

在進行此變更之前，請將節點置於維護模式。 節點會重新啟動以套用變更。 請參閱啟用或停用維護模式如需有關將節點移至維護模式的更多資訊。

授權： 使用視訊網格使用者名稱（「admin」）和密碼的基本驗證。

主體：

{
    "internalInterfaceMtu": 1500
}

• 內部介面Mtu - 節點網路介面的最大傳輸單位。 該值應介於 1280 和 9000 之間。

請求標頭：

「內容類型」： 「應用程式/json」

範例回應：

範例回應 1：

{
    "status": {
        "code": 200,
        "message": "Successfully saved the internal interface MTU settings. This node will reboot soon to apply the changes. Please wait for a minute and relogin to the node to verify that all changes were applied."
    }
}

範例回應 2：

{
    "status": {
        "code": 400,
        "message": "One or more errors in the input: 'internalInterfaceMtu' field value should be a number"
    }
}

範例回應 3：

{
    "status": {
        "code": 400,
        "message": "Please enter a number between 1280 and 9000."
    }
}

根據提供的詳細資料，產生CSR （憑證簽署請求）憑證和私密金鑰。

[POST] https://<node_ip> /api/v1/externalCertManager/generateCsr

授權： 使用視訊網格使用者名稱（「admin」）和密碼的基本驗證。

主體：

{
    "csrInfo":
    {
         "commonName": "1.2.3.4",
         "emailAddress": "abc@xyz.com",
         "altNames": "1.1.1.1 2.2.2.2",
         "organization": "VMN",
         "organizationUnit": "IT",
         "locality": "BLR",
         "state": "KA",
         "country": "IN",
         "passphrase": "",
         "keyBitSize": 2048
    }
}

• commonName-視訊網格節點的IP /FQDN （作為一般名稱提供）。 （強制）

• emailAddress - 使用者的電子郵件地址。 （可不填）

• altNames -主體別名別名（選用）。 允許多個空格分隔的 FQDN。 如果提供了，它必須包含一般名稱。 如果未提供 altNames，則會採用 commonName 作為 altNames 的值。

• Organization - 組織/公司名稱。 （選用）

• OrganizationUnit - 組織單位或部門或群組名稱等（選用）

• locality - 城市/地區。 （可不填）

• state - 州/省。 （可不填）

• Country - 國家/地區。 兩個字母的縮寫。 不要提供兩個以上的字母。 （可不填）

• 複雜密碼 - 私密金鑰複雜密碼。 （可不填）

• keyBitSize - 私密金鑰位大小。 接受的值是 2048 或 4096。 （選用）

請求標頭：

內容類型： 「應用程式/json」

範例回應：

範例回應 1：

{
    "status": {
        "code": 200,
        "message": "Successfully generated CSR"
    },
    "result": {
        "caCert": {},
        "caKey": {
            "fileName": "VideoMeshGeneratedPrivate.key",
            "localFileName": "CaPrivateKey.key",
            "fileLastModified": "Fri Jul 21 2023 08:12:25 GMT+0000 (Coordinated Universal Time)",
            "uploadDate": 1689927145422,
            "size": 1678,
            "type": "application/pkcs8",
            "modulus": "S4MP1EM0DULU2"
        },
        "certInstallRequestPending": false,
        "certInstallStarted": null,
        "certInstallCompleted": null,
        "isRegistered": true,
        "caCertsInstalled": false,
        "csr": {
            "keyBitsize": 2048,
            "commonName": "1.2.3.4",
            "organization": "VMN",
            "organizationUnit": "IT",
            "locality": "BLR",
            "state": "KA",
            "country": "IN",
            "emailAddress": "abc@xyz.com",
            "altNames": [
                "1.1.1.1",
                "2.2.2.2"
            ],
            "csrContent": "-----BEGIN CERTIFICATE REQUEST-----\nS4MP1E_C3RT_C0NT3NT\n-----END CERTIFICATE REQUEST-----"
        },
        "encryptedPassphrase": null
    }
}

範例回應 2：

{
    "status": {
        "code": 400,
        "message": "Private key already exists. Delete it before generating new CSR."
    }
}

範例回應 3：

{
    "status": {
        "code": 400,
        "message": "CSR certificate already exists. Delete it before generating new CSR."
    }
}

範例回應 4：

{
    "status": {
        "code": 400,
        "message": "CSR certificate and private key already exist. Delete them before generating new CSR."
    }
}

範例回應 5：

{
    "status": {
        "code": 400,
        "message": "There were one or more errors while generating the CSR: The \"Country\" field must contain exactly two A-Z characters."
    }
}

下載產生的CSR憑證。

[獲取] https://<node_ip> /api/v1/externalCertManager/csr

您還可以透過以下方式下載檔案：傳送並下載選項。

授權： 使用視訊網格使用者名稱（「admin」）和密碼的基本驗證。

範例回應：

範例回應 1：

-----BEGIN CERTIFICATE REQUEST-----
S4MP1E_C3RT_C0NT3NT
-----END CERTIFICATE REQUEST-----

範例回應 2：

{
    "status": {
        "code": 404,
        "message": "Could not download, CSR certificate does not exist."
    }
}

下載隨著CSR代表憑證產生的私密金鑰。

[獲取] https://<node_ip> /api/v1/外部CertManager/金鑰

您還可以透過以下方式下載檔案：傳送並下載選項。

授權： 使用視訊網格使用者名稱（「admin」）和密碼的基本驗證。

範例回應：

範例回應 1：

-----BEGIN RSA PRIVATE KEY-----
S4MP1E_PR1V4T3_K3Y
-----END RSA PRIVATE KEY-----

範例回應 2：

{
    "status": {
        "code": 404,
        "message": "Could not download, private key does not exist."
    }
}

刪除現有的CSR憑證。

[刪除] https://<node_ip> /api/v1/externalCertManager/csr

授權： 使用視訊網格使用者名稱（「admin」）和密碼的基本驗證。

範例回應：

範例回應 1：

{
    "status": {
        "code": 200,
        "message": "Successfully deleted the CSR certificate"
    }
}

範例回應 2：

{
    "status": {
        "code": 404,
        "message": "CSR certificate does not exist."
    }
}

刪除現有的私密金鑰。

[刪除] https://<node_ip> /api/v1/外部CertManager/金鑰

授權： 使用視訊網格使用者名稱（「admin」）和密碼的基本驗證。

範例回應：

範例回應 1：

{
    "status": {
        "code": 200,
        "message": "Successfully deleted the private key"
    }
}

範例回應 2：

{
    "status": {
        "code": 404,
        "message": "Private key does not exist."
    }
}

在「視訊網格」節點上上傳提供的 CA 簽署的憑證和私密金鑰，並在節點上安裝憑證。

[POST] https://<node_ip> /api/v1/externalCertManager/uploadInstallCaCert

授權： 使用視訊網格使用者名稱（「admin」）和密碼的基本驗證。

主體：

使用「表格資料」來上傳下列檔案：

• CA 簽署的憑證（.crt）檔案，其金鑰為「crtFile」。

• 私密金鑰 (.key) 檔案，其中金鑰為「keyFile」。

請求標頭：

內容類型： 「多部分/表格資料」

範例回應：

範例回應 1：

{
    "status": {
        "code": 200,
        "message": "Successfully installed certificate and key. It might take a few seconds to reflect on the node."
    },
    "result": {
        "caCert": {
            "fileName": "videoMeshCsr.crt",
            "localFileName": "CaCert.crt",
            "fileLastModified": 1689931788598,
            "uploadDate": 1689931788605,
            "size": 1549,
            "type": "application/x-x509-ca-cert",
            "certStats": {
                "version": 0,
                "subject": {
                    "countryName": "IN",
                    "stateOrProvinceName": "KA",
                    "localityName": "BLR",
                    "organizationName": "VMN",
                    "organizationalUnitName": "IT",
                    "emailAddress": "abc@xyz.com",
                    "commonName": "1.2.3.4"
                },
                "issuer": {
                    "countryName": "AU",
                    "stateOrProvinceName": "Some-State",
                    "organizationName": "ABC"
                },
                "serial": "3X4MPL3",
                "notBefore": "2023-07-21T09:28:19.000Z",
                "notAfter": "2024-12-02T09:28:19.000Z",
                "signatureAlgorithm": "sha256WithRsaEncryption",
                "fingerPrint": "11:22:33:44:AA:BB:CC:DD",
                "publicKey": {
                    "algorithm": "rsaEncryption",
                    "e": 65537,
                    "n": "3X4MPL3",
                    "bitSize": 2048
                },
                "altNames": [],
                "extensions": {}
            }
        },
        "caKey": {
            "fileName": "VideoMeshGeneratedPrivate.key",
            "localFileName": "CaPrivateKey.key",
            "fileLastModified": 1689931788629,
            "uploadDate": 1689931788642,
            "size": 1678,
            "type": "application/pkcs8",
            "modulus": "S4MP1EM0DULU2"
        },
        "certInstallRequestPending": true,
        "certInstallStarted": null,
        "certInstallCompleted": null,
        "isRegistered": true,
        "caCertsInstalled": false,
        "csr": {
            "keyBitsize": 2048,
            "commonName": "1.2.3.4",
            "organization": "VMN",
            "organizationUnit": "IT",
            "locality": "BLR",
            "state": "KA",
            "country": "IN",
            "emailAddress": "abc@xyz.com",
            "altNames": [
                "1.1.1.1",
                "2.2.2.2"
            ],
            "csrContent": "-----BEGIN CERTIFICATE REQUEST-----\nS4MP1E_C3RT_C0NT3NT\n-----END CERTIFICATE REQUEST-----"
        },
        "encryptedPassphrase": null
    }
}

範例回應 2：

{
    "status": {
        "code": 400,
        "message": "Could not parse the certificate file. Make sure it is a properly formatted certificate and try again."
    }
}

範例回應 3：

{
    "status": {
        "code": 400,
        "message": "Private Key does not match Certificate (different modulus)"
    }
}

範例回應 4：

{
    "status": {
        "code": 202,
        "message": "Certificate and private key PENDING installation. It might take a few seconds to reflect on the node. If the node is in maintenance mode, it will get installed once it is disabled."
    }
}

下載節點上安裝的 CA 簽署憑證。

[獲取] https://<node_ip> /api/v1/externalCertManager/caCert

您還可以透過以下方式下載檔案：傳送並下載選項。

授權： 使用視訊網格使用者名稱（「admin」）和密碼的基本驗證。

範例回應：

範例回應 1：

-----BEGIN CERTIFICATE-----
S4MP1E_C3RT_C0NT3NT
-----END CERTIFICATE-----

範例回應 2：

{
    "status": {
        "code": 404,
        "message": "Could not download, CA certificate does not exist."
    }
}

刪除節點上安裝的 CA 簽署憑證。

[刪除] https://<node_ip> /api/v1/externalCertManager/caCert

授權： 使用視訊網格使用者名稱（「admin」）和密碼的基本驗證。

範例回應：

範例回應 1：

{
    "status": {
        "code": 200,
        "message": "Successfully deleted the CA certificate."
    }
}

範例回應 2：

{
    "status": {
        "code": 404,
        "message": "CA certificate does not exist."
    }
}