Help Center/ Cloud Service Engine/ API Reference/ CSE API/ Engine Management/ Upgrading an Exclusive ServiceComb Engine
Updated on 2023-11-08 GMT+08:00

Upgrading an Exclusive ServiceComb Engine

Function

This API is used to upgrade an exclusive ServiceComb engine.

URI

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

Table 1 Path parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Tenant sub-project ID, which must be unique. The value contains 1 to 64 characters. See Obtaining a Project ID.

engine_id

Yes

String

ID of an exclusive ServiceComb engine. See Querying the Microservice Engine List.

Request

Table 2 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

User token.

X-Enterprise-Project-ID

No

String

Enterprise project ID.

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

Table 3 Request body parameter

Parameter

Mandatory

Type

Description

version

Yes

String

Target version number.

Response

Status code: 200

Table 4 Response body parameters

Parameter

Type

Description

id

String

ID of the exclusive ServiceComb engine.

name

String

Name of the exclusive ServiceComb engine.

jobId

Integer

ID of the job executed by the exclusive ServiceComb engine.

Status code: 400

Table 5 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error message.

Status code: 500

Table 6 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error message.

Example Request

Upgrade an engine with specified engine_id to 2.4.0.

{
    "version":"2.4.0"
}

Example Response

Status code: 200

Response structure for upgrading an exclusive ServiceComb 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 CSE Error Codes.