更新时间:2024-12-16 GMT+08:00

修改微服扩展属性信息

功能介绍

创建微服务静态信息后可对服务部分字段进行更新,每次更新都需要传入完整的服务静态信息json,即便不更新部分的字段也要作为json的属性传入。

接口约束

URI

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

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

  • 微服务引擎专业版,请填租户项目id,长度为1~64,

    获取方法请参考获取项目ID。也可以填固定值default。

  • 微服务引擎专享版,请填固定值:default。

service_id

String

微服务唯一标识。字符长度为1~64,正则表达式为^.*$,获取方法请参考查询所有微服务信息

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

Authorization

String

若微服务引擎专享版开启了安全认证,此参数必填。否则,无此参数。

开启了安全认证的微服务引擎专享版Token,格式为:

Authorization:Bearer {Token}

Token获取方法,请参考获取微服务引擎专享版用户Token

表3 请求Body参数

参数

是否必选

参数类型

描述

properties

Object

微服务扩展属性,可以自定义KEY和相应的Value。长度最小1字节。

响应参数

状态码: 400

表4 响应Body参数

参数

参数类型

描述

errorCode

String

错误代码。

errorMessage

String

错误信息。

detail

String

详细定位信息。

状态码: 500

表5 响应Body参数

参数

参数类型

描述

errorCode

String

错误代码。

errorMessage

String

错误信息。

detail

String

详细定位信息。

请求示例

修改指定service_id的微服务的扩展信息。

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

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

响应示例

状态码

状态码

描述

200

修改成功。

400

错误的请求。

500

服务内部错误。

错误码

请参见ServiceComb错误码