Updating Microservice Engine Details

Function

This API is used to update microservice engine details, including the name and description.

URI

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

**Table 1** Path parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	Project ID, which must be unique. The value contains 1 to 64 characters.
engine_id	Yes	String	Microservice engine ID.

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. Default value: 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
description	No	String	Microservice engine description. Maximum length: 255
alias	No	String	Alias of a microservice engine (displayed name). Maximum length: 64

Response

Status code: 200

None

Status code: 400

**Table 4** Response body parameters
Parameter	Type	Description
error_code	String	Error code.
error_msg	String	Error message.
detail	String	Location details.

Status code: 500

**Table 5** Response body parameters
Parameter	Type	Description
error_code	String	Error code.
error_msg	String	Error message.
detail	String	Location details.

Example Request

POST https://{endpoint}/v2/{project_id}/enginemgr/engines/{engine_id}

{
  "description": "string",
  "alias": "string",
  "maintenanceConfig": {
    "time": "13:00"
  }
}