Help Center/ Cloud Service Engine/ API Reference/ CSE API/ Engine Management/ Updating Microservice Engine Configurations

Updated on 2025-12-01 GMT+08:00

View PDF

Updating Microservice Engine Configurations

Function

This API is used to upgrade the configuration of 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.

If you are using role/policy-based authorization, see the required permissions in Permissions and Supported Actions.

If you are using identity policy-based authorization, the permission listed below is required.

Action	Access Level	Resource Type (*: required)	Condition Key	Alias	Dependency
cse:engine:update	write	engine	g:ResourceTag/<tag-key> g:EnterpriseProjectId	-	-

URI

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

**Table 1** Path parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	Project ID.
engine_id	Yes	String	ID of the engine to be updated.

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
authType	Yes	String	authType authentication type. Enumerated values: RBAC: Security authentication is enabled for the engine. NONE: Security authentication is not enabled for the engine.

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

PUT https://{endpoint}/v2/{project_id}/enginemgr/engines/{engine_id}/config

{
  "authType" : "RBAC"
}

Example Response

Status code: 200

Structure for updating the microservice engine configurations.

{
  "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

Previous topic: Upgrading a Microservice Engine

Next topic: Changing Microservice Engine Specifications

Feedback

Was this page helpful?

Helpful Not helpful

Provide feedback

Thank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.

The system is busy. Please try again later.

Which of the following issues have you encountered?

Content is inconsistent with the product UI

Unclear descriptions

Lack of examples or code

Incorrect steps

Can't find what I need

Lack of best practices

Feedback (optional)

0/500

Select at least one type of issue, and enter your comments or suggestions.

Enter a maximum of 500 characters.

Submit Cancel

For any further questions, feel free to contact us through the chatbot.

Chatbot