{"componentChunkName":"component---src-templates-microservices-js","path":"/en/microservices/scale/","result":{"data":{"markdownRemark":{"html":"

scale

\n

URI

\n

http://{server}:{port}/manager/web/api/service/nodes/{nodeName}/scale

\n

Supported Method

\n

POST

\n

Parent Resource

\n

nodes

\n

Introduction

\n

Scaling the service node by API.

\n

Supported Interchange Format: JSON

\n

HTTP Request Method

\n

Execute HTTP request to the URI below. In the URI below, {server} is the server of gateway, replace it by the actual gateway server IP. {port} is the port of gateway, replace it by the actual gateway port. {nodeName} is the name of service node, replace it by the actual name.

\n

http://{server}:{port}/manager/web/api/service/nodes/{nodeName}/scale

\n

POST Request

\n

Scaling the service node.

\n

The Format of Headers

\n
content-type: application/json\nauthorization: Bearer {access_token}
\n

Request Params

\n

The necessary parameters to scaling the service node:

\n\n\n\n\n\n\t\n\t\t\n\t\t\n\t\t\n\t\n\t\n\t\t\n\t\t\n\t\t\n\t\n\t\n\t\t\n\t\n\t\n\t\t\n\t\t\n\t\t\n\t\n\t\n\t\t\n\t\t\n\t\t\n\t\n\t\n\t\t\n\t\t\n\t\t\n\t\n\t\n\t\t\n\t\t\n\t\t\n\t\n\t\n\t\t\n\t\n\t\n\t\t\n\t\t\n\t\t\n\t\n
NameTypeExplanation
isAutoStringWhether the scaling mode is automatic. True means automatic scaling, false means manual scaling.
autoScale
metricTypeStringThe type of the monitor object of automatic scaling
thresholdIntegerThreshold
minReplicasIntegerThe minimum number of nodes
maxReplicasIntegerThe maximum number of nodes
manualScale
desiredReplicasIntegerThe desired number of nodes after scaling
\n

Response Structure

\n

The returned response would tell whether scaled successful, and provide the error information if failed.

\n\n\n\n\n\t\n\t\t\n\t\t\n\t\t\n\t\n\t\n\t\t\n\t\t\n\t\t\n\t\n\t\n\t\t\n\t\t\n\t\t\n\t\n
FieldTypeExplanation
isSucceedBoolean The result of the request. True means succeed, false means failed
msgStringIf the execution failed, the result would return the error information. The result would be empty if succeed.
\n

Response Case

\n

Execute POST request for http://192.168.17.139:32507/manager/web/api/service/nodes/ExampleNode/scale, use manual scaling mode and scaling the number of service nodes to 3.

\n
{\n\t"isAuto": "false",\n\t"manualScale": {\n\t\t"desiredReplicas": 3\n\t}\n}
\n

The returned response in json format:

\n
{\n    "isSucceed": true,\n    "msg": ""\n}
\n

Execute POST request for http://192.168.17.139:32507/manager/web/api/service/nodes/ExampleNode/scale, the scale mode is automatic scale, the type of monitor object is CPU, the threshold is 50%, the minimum service node is 1, and the maxmimum service node is 5.

\n
{\n\t"isAuto": true,\n\t"autoScale": {\n\t\t"metricType": "cpu",\n\t\t"threshold": "50",\n\t\t"minReplicas": "1",\n\t\t"maxReplicas": "5"\n\t}\n}
\n

The returned response in json format:

\n
{\n    "isSucceed": true,\n    "msg": ""\n}
","frontmatter":{"title":"GIS Cloud Suite","next":null,"prev":null},"fields":{"path":"content/microservices/scale.en.md","slug":"/en/microservices/scale/","langKey":"en"}}},"pageContext":{"slug":"/en/microservices/scale/"}}}