Help Center/ Cloud Service Engine/ API Reference/ CSE API/ Engine Management/ Upgrading a Microservice Engine
Updated on 2025-12-01 GMT+08:00
View PDF
Share

Upgrading a Microservice Engine

Function

This API is used to upgrade a microservice engine, including exclusive ServiceComb engine and registry/configuration center.

Authorization Information

Each account has all of the permissions required to call all APIs, but IAM users must have the required permissions specifically assigned.

URI

PUT /v2/{project_id}/enginemgr/engines/{engine_id}/upgrade

Table 1 Path parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Project ID.

engine_id

Yes

String

ID of the engine to be upgraded.

Request

Table 2 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

User token.

X-Enterprise-Project-ID

No

String

If this parameter is not set, the default enterprise project is default and the ID is 0.

Content-Type

Yes

String

Set it to application/json;charset=UTF-8.

Accept

Yes

String

Set it to application/json.
Table 3 Request body parameter

Parameter

Mandatory

Type

Description

version

Yes

String

Version number.

Maximum length: 24

Response

Status code: 200
Table 4 Response body parameters

Parameter

Type

Description

id

String

Microservice engine ID.

name

String

Microservice engine name.

jobId

Integer

ID of the job executed by a microservice engine.
Status code: 400
Table 5 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error message.

detail

String

Location details.
Status code: 500
Table 6 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error message.

detail

String

Location details.

Example Request

{
  "version" : "2.4.0"
}

Example Response

Status code: 200

Response structure for upgrading a microservice engine.

{
  "id" : "891bf21a-4024-4f47-b38c-bd259ca8f10a",
  "name" : "test",
  "jobId" : 17655
}

Status Code

Status Code

Description

200

OK

400

Bad Request

500

Internal Server Error

Error Code

See Error Codes.

Parent topic: Engine Management