修改微服务实例扩展信息
功能介绍
实例注册后，可以根据instance_id添加或更新一个微服务实例扩展信息。
接口约束
无
URI
PUT /v4/{project_id}/registry/microservices/{service_id}/instances/{instance_id}/properties
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
project_id |
是 |
String |
|
service_id |
是 |
String |
微服务唯一标识。字符长度为1~64，正则表达式为^.*$。获取方法请参考查询所有微服务信息。 |
instance_id |
是 |
String |
微服务实例唯一标识。字符长度不超过64位， 正则表达式为^[A-Za-z0-9_.-]*$。获取方法请参考根据service_id查询微服务实例。 |
请求参数
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
Authorization |
否 |
String |
若微服务引擎专享版开启了安全认证，此参数必填。否则，无此参数。 开启了安全认证的微服务引擎专享版Token，格式为： Authorization:Bearer {Token} Token获取方法，请参考获取微服务引擎专享版用户Token。 |
X-consumerId |
否 |
String |
微服务消费者的微服务唯一标识。 |
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
properties |
否 |
Object |
微服务扩展属性，可以自定义KEY和相应的Value。长度最小1字节。 |
响应参数
状态码： 400
参数 |
参数类型 |
描述 |
|---|---|---|
errorCode |
String |
错误代码。 |
errorMessage |
String |
错误信息。 |
detail |
String |
详细定位信息。 |
状态码： 500
参数 |
参数类型 |
描述 |
|---|---|---|
errorCode |
String |
错误代码。 |
errorMessage |
String |
错误信息。 |
detail |
String |
详细定位信息。 |
请求示例
更新指定instance_id的实例的扩展信息为"attr1" : "b"。
PUT https://{endpoint}/v4/{project_id}/registry/microservices/{service_id}/instances/{instance_id}/properties
{
"properties" : {
"attr1" : "b"
}
}
响应示例
无
状态码
状态码 |
描述 |
|---|---|
200 |
修改成功。 |
400 |
错误的请求。 |
500 |
服务内部错误。 |
错误码
请参见ServiceComb错误码。
