Cross-Service Network API Methods
In this section, you can find all the API methods used on the PaaS platform for managing the Cross-Service Network feature.
Check admin methods for managing cross-service IPs:
- GetCrossNetworkIpPoolInfo - returns information on the cross-service network IP addresses pool
- GetCrossNetworkExtIpInfo - returns information on the cross-service network external IP addresses pool
- AddCrossNetworkExtIps - adds new external cross-service network IP addresses to the Access Control list
- RemoveCrossNetworkExtIps - removes specified external cross-service network IP addresses from the Access Control list
- RemoveCrossNetworkExtIpById - removes an external cross-service network IP address from the Access Control list based on the specified ID
- GetCrossNetwork - returns information about the cross-service network for the specified region
- ReleaseCrossNetwork - releases the specified cross-service network.
- SetCrossServiceNetworkIpCount - sets (changes) the number of cross-service network IPs attached to the specific node or all nodes in the layer.
- The crossServiceIpCount parameter can be used to set a number of cross-service network IP addresses attached to the node (for the AddNode and other type-specific methods, e.g. AddBalancerNode).
Also, when creating or editing via API a region (AddRegion and EditRegion) or host group (Add and Edit) the dedicated cross-network settings can be specified via the data parameter:
- “isCrossNetworkEnabled”: “boolean” - enables/disables feature on the region
- “crossNetworkDedicatedSubnet”: “string” - defines a cross-service subnet for the region from the shared private cross-service network (e.g., 100.65.0.0/16)
- “crossNetworkContainersPrefix”: “int” - sets up a global mask for containers (e.g., /15)
Check user methods for managing cross-service IPs:
- SetCrossServiceNetworkIpCount – sets (changes) the number of cross-service network IPs attached to the specific node or all nodes in the layer
