Help Center/ Meeting/ Client SDK Reference/ Android SDK/ APIs/ Basic Settings/ Setting Guaranteed IP Addresses of the Management Plane
Updated on 2025-04-18 GMT+08:00

Setting Guaranteed IP Addresses of the Management Plane

API Description

This API is used to set the guaranteed IP addresses of the management plane.

Precautions

  1. This API is optional. If it is not called, the default IP address is used.
  2. Up to four IP addresses are supported for each domain. They are separated by semicolons (;).

Method Definition

/**
 * Set the guaranteed IP address of the management plane.
 * @param guaranteedIpAddressList Domain name-IP address mapping
 */
SDKERR setGlobalGuaranteedIpAddresses(List<GuaranteedIpAddress> guaranteedIpAddressList);

Parameter Description

Table 1 GuaranteedIpAddress description

Parameter

Mandatory

Type

Description

domain

Yes

String

Domain name.

guaranteedIps

Yes

String

Guaranteed IP addresses. Enter up to four IP addresses and separate them by semicolons (;).

Sample Code

List<GuaranteedIpAddress> ipAddressList = new ArrayList<>();
GuaranteedIpAddress address1 = new GuaranteedIpAddress();
GuaranteedIpAddress address2 = new GuaranteedIpAddress();
GuaranteedIpAddress address3 = new GuaranteedIpAddress();

address1.setDomain(domain1.getText().toString());
address1.setGuaranteedIps(ip1.getText().toString());
address2.setDomain(domain2.getText().toString());
address2.setGuaranteedIps(ip2.getText().toString());
address3.setDomain(domain3.getText().toString());
address3.setGuaranteedIps(ip3.getText().toString());

ipAddressList.add(address1);
ipAddressList.add(address2);
ipAddressList.add(address3);

SDKERR sdkerr = HWMBizSdk.getBizOpenApi().setGlobalGuaranteedIpAddresses(ipAddressList);
DemoUtil.showToastDialog("Set guaranteed IP addresses of the management plane.", sdkerr.getValue(), sdkerr.getDescription());