leafleafleafFlower illustration
Updated on May 28, 2024
Environment

environment.NodeGroup

Estimated reading: 3 minutes 724 views
Namespace: Environment
REST: https://[hoster-api-host]/1.0/environment/nodegroup/rest/{method-name}
Scripting: environment.nodegroup.{method-name}
The nodeGroup API service is used to manage data (parameters) and custom options of the environment layers.

Methods

ApplyData (envName, session, nodeGroup, data ) :

Adds or changes the existing node group’s data (parameters).

URL

https://[hoster-api-host]/1.0/environment/nodegroup/rest/applydata

Parameters

  • envName : “string”

    target environment name.

  • session : “string”

    user session or personal access token.

  • nodeGroup : “string”

    unique identifier of the target node group (layer), e.g. “cp” for the default application server layer.

  • data : “string”

    JSON object with the node group data (parameters), e.g. {“redeployContainerDelay”:20, “customProperty”:”value”}.

Example

Method: POST

https://[hoster-api-host]/1.0/environment/nodegroup/rest/applydata?data=[string]&envName=[string]&session=[string]&nodeGroup=[string]

Response

  • Response
    {
   "error": "string",
   "reason": "int",
   "result": "int",
   "source": "string"
}

Get (envName, session, nodeGroup ) :

Returns all the node group’s data (parameters).

URL

https://[hoster-api-host]/1.0/environment/nodegroup/rest/get

Parameters

  • envName : “string”

    target environment name.

  • session : “string”

    user session or personal access token.

  • nodeGroup : “string”

    unique identifier of the target node group (layer), e.g. “cp” for the default application server layer.

Example

Method: POST

https://[hoster-api-host]/1.0/environment/nodegroup/rest/get?envName=[string]&session=[string]&nodeGroup=[string]

Response

  • NodeGroupResponse
    {
   "error": "string",
   "nodeGroup": {
      "deployments": [
         {
            "archiveName": "string",
            "context": "string",
            "type": "ARCHIVE(0) | GIT(1) | SVN(2)"
         },
         "..."
      ],
      "isSLBAccessEnabled": "boolean",
      "isSequentialDeploy": "boolean",
      "name": "string",
      "redeployContainerDelay": "int",
      "redeployContextDelay": "int",
      "restartContainerDelay": "int",
      "restartNodeDelay": "int",
      "scalingMode": "STATELESS(0) | STATEFUL(1)",
      "templateType": "ALL(0) | NATIVE(1) | CARTRIDGE(2) | DOCKER(3) | DOCKERIZED(4) | OS(5)",
      "vType": "CT(0) | VM(1)"
   },
   "reason": "int",
   "result": "int",
   "source": "string"
}

SetSLBAccessEnabled (envName, session, nodeGroup, enabled ) :

Enables/disables access to the node group (environment layer) through the Shared Load Balancer. Learn more in the documentation.

URL

https://[hoster-api-host]/1.0/environment/nodegroup/rest/setslbaccessenabled

Parameters

  • envName : “string”

    target environment name.

  • session : “string”

    user session or personal access token.

  • nodeGroup : “string”

    unique identifier of the target node group (layer), e.g. “cp” for the default application server layer.

  • enabled : “boolean”

    defines whether allow (true) or deny (false) access to the layer via Shared Load Balancer.

Example

Method: POST

https://[hoster-api-host]/1.0/environment/nodegroup/rest/setslbaccessenabled?envName=[string]&session=[string]&nodeGroup=[string]&enabled=[boolean]

Response

  • Response
    {
   "error": "string",
   "reason": "int",
   "result": "int",
   "source": "string"
}
Environment - Previous environment.Vcs Next - Environment environment.Security

Leave a Comment

Powered By AccuWeb.Cloud