获取当前维护模式状态(预期状态： on、off、待处理或请求)。

[GET] https：///<node_ip> api/v1/external/maintenanceMode

授权： 使用视频网用户名(“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小时现有呼叫完成）。

[PUT] https：///<node_ip> /v1/external/maintenanceMode

仅当没有活动呼叫时调用此API。

授权： 使用视频网用户名(“admin”)和密码进行基本验证。

Body：

{
      "maintenanceMode": "on"
}

• maintenanceMode -要设置的维护模式的状态- “开”或“关”。

请求标头：

'内容类型'： '应用程序/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"   
    }
}

更改admin用户的密码。

[PUT] https：///<node_ip> api/v1/external/password

授权： 使用视频网用户名(“admin”)和密码进行基本验证。

Body：

{
  "newPassword": "new"
}

• newPassword-为视频网节点的'admin'帐户设置的新密码。

请求标头：

'内容类型'： '应用程序/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地址、外部子网掩码和外部网关。

[GET] https：///<node_ip> /v1/external/externalNetwork

授权： 使用视频网用户名(“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地址、外部子网掩码和外部网关的外部网络接口。 它也可用于禁用外部网络。 更改外部网络配置后，节点重新启动以应用这些更改。

[PUT] https：///<node_ip> /v1/external/externalNetwork

您只能对新部署的视频网节点进行配置，其缺省管理员密码已更改。 将节点注册到组织后，请勿使用此API。

授权： 使用视频网用户名(“admin”)和密码进行基本验证。

Body：

启用外部网络：

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

禁用外部网络：

{
  "externalNetworkEnabled": false
}

• ExternalNetworkEnabled -布尔值（true或false）用于启用/禁用外部网络

• externalIp -要添加的外部IP

• 外部掩码-外部网络的网络掩码

• 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、主机名和域。

[GET] https：///<node_ip> api/v1/external/internalNetwork

授权： 使用视频网用户名(“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服务器更新。

[PUT] https：///<node_ip> /v1/external/internalNetwork/dns

进行更改前，请将节点置于维护模式。 有关将节点移至维护模式的更多信息，请参阅启用或禁用维护模式。

授权： 使用视频网用户名(“admin”)和密码进行基本验证。

Body：

{
    "dnsServers": "1.1.1.1 2.2.2.2"
}

• dnsServer -待更新的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服务器。

[PUT] https：///<node_ip> /v1/external/internalNetwork/ntp

进行更改前，请将节点置于维护模式。 有关将节点移至维护模式的更多信息，请参阅启用或禁用维护模式。

授权： 使用视频网用户名(“admin”)和密码进行基本验证。

Body：

{
    "ntpServers": "1.1.1.1 2.2.2.2"
}

• ntpServer -要更新的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."
    }
}

更新视频网格节点的主机名和域。

[PUT] https：///<node_ip> /v1/external/internalNetwork/host

进行更改前，请将节点置于维护模式。 节点重启以应用改动。 有关将节点移至维护模式的更多信息，请参阅启用或禁用维护模式。

授权： 使用视频网用户名(“admin”)和密码进行基本验证。

Body：

{
    "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 MS才能解决，或者Cisco支持人员建议，请考虑启用缓存。

[PUT] https：///<node_ip> /v1/external/internalNetwork/dnsCaching

进行更改前，请将节点置于维护模式。 节点重启以应用改动。 有关将节点移至维护模式的更多信息，请参阅启用或禁用维护模式。

授权： 使用视频网用户名(“admin”)和密码进行基本验证。

Body：

{
    "dnsCaching": true
}

• dnsCaching - DNS缓存配置。 接受布尔值（真或假）。

请求标头：

'内容类型'： '应用程序/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之间的值。

[PUT] https：///<node_ip> /v1/external/internalNetwork/mtu

进行更改前，请将节点置于维护模式。 节点重启以应用改动。 有关将节点移至维护模式的更多信息，请参阅启用或禁用维护模式。

授权： 使用视频网用户名(“admin”)和密码进行基本验证。

Body：

{
    "internalInterfaceMtu": 1500
}

• internalInterfaceMtu -节点网络接口的最大传输单位。 该值应在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> /v1/externalCertManager/generateCsr

授权： 使用视频网用户名(“admin”)和密码进行基本验证。

Body：

{
    "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。 如果已提供，则必须包含公用名。 如果未提供alt ，则使用commonName作为alt 的值。

• 组织-组织/公司名称。（可选）

• organizationUnit -组织单位或部门或组名等（可选）

• 地点-城市/地点。 （可选）

• state-州/省。 （可选）

• 国家-国家/地区。 双字母缩写。 请勿提供两个以上的字母。 （可选）

• 密码短语-私有密钥密码短语。 （可选）

• 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证书。

[GET] https：///<node_ip> /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证书一起生成的私钥。

[GET] https：///<node_ip> api/v1/externalCertManager/key

您还可以通过 和下载 下载文件。

授权： 使用视频网用户名(“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> /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> /v1/externalCertManager/key

授权： 使用视频网用户名(“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> /v1/externalCertManager/uploadInstallCaCert

授权： 使用视频网用户名(“admin”)和密码进行基本验证。

Body：

使用“form-data”上传以下文件：

• 密钥为'crtFile'的CA签名证书(。crt)文件。

• 密钥为'keyFile'的私有密钥(。key)文件。

请求标题：

内容类型： 'multipart/form-data"

回答示例：

示例响应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签名证书。

[GET] https：///<node_ip> /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."
    }
}