Help Center> ServiceStage> API Reference> CSE API> Microservice> Modifying Extended Attribute Information About a Microservice
View PDF

Modifying Extended Attribute Information About a Microservice

Function

This API is used to modify static information about a microservice. To update some fields in the static information, you need to input all static information (including the fields that do not need to be updated) in JSON format.

Constraints

None

URI

PUT /v4/{project_id}/registry/microservices/{service_id}/properties

Table 1 Path parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Unique ID of a tenant sub-project. Length: 1–64 characters.

service_id

Yes

String

Microservice ID, which must be unique. Length: 1–64 characters. Regular expression: ^.*$

Request Parameters

Table 2 Request header parameters

Parameter

Mandatory

Type

Description

x-domain-name

Yes

String

Tenant account name.
Table 3 Request body parameters

Parameter

Mandatory

Type

Description

properties

No

Object

Extended attribute. You can customize a key and value. The value contains at least 1 byte.

Response Parameters

Status code: 400

Table 4 Response body parameters

Parameter

Type

Description

errorCode

String

Error code.

errorMessage

String

Error information.

detail

String

Location details.

Status code: 500

Table 5 Response body parameters

Parameter

Type

Description

errorCode

String

Error code.

errorMessage

String

Error information.

detail

String

Location details.

Example Requests

PUT https://{endpoint}/v4/{project_id}/registry/microservices/{service_id}/properties

{
  "properties" : {
    "a" : "test"
  }
}

Example Responses

None

Status Codes

Status Code

Description

200

OK

400

Bad Request

500

Internal Server Error

Error Codes

See Error Codes.

Parent topic: Microservice