云服务器内容精选

  • 请求示例 注册一个微服务实例,其主机信息为localhost,健康检查的心跳模式为push,心跳间隔为30s,所在region为r1,名字为dc,可用区为az1。 POST https://{endpoint}/v4/{project_id}/registry/microservices/{service_id}/instances { "instance" : { "endpoints" : [ "grpc://127.0.1.312:9980", "rest://127.0.0.111:8081" ], "hostName" : "localhost", "status" : "UP", "properties" : { "_TAGS" : "A, B", "attr1" : "a", "nodeIP" : "127.0.0.1" }, "dataCenterInfo" : { "name" : "dc", "region" : "r1", "availableZone" : "az1" }, "healthCheck" : { "mode" : "push", "interval" : 30, "times" : 3 } } }
  • 响应参数 状态码: 200 表7 响应Body参数 参数 参数类型 描述 instanceId String 实例ID。 状态码: 400 表8 响应Body参数 参数 参数类型 描述 errorCode String 错误代码。 errorMessage String 错误信息。 detail String 详细定位信息。 状态码: 500 表9 响应Body参数 参数 参数类型 描述 errorCode String 错误代码。 errorMessage String 错误信息。 detail String 详细定位信息。
  • 请求参数 表2 请求Header参数 参数 是必选 参数类型 描述 Authorization 否 String 若微服务引擎专享版开启了安全认证,此参数必填。否则,无此参数。 开启了安全认证的微服务引擎专享版Token,格式为: Authorization:Bearer {Token} Token获取方法,请参考获取微服务引擎专享版用户Token。 表3 请求Body参数 参数 是否必选 参数类型 描述 instance 是 MicroServiceInstance object 微服务实例信息。 表4 MicroServiceInstance 参数 是否必选 参数类型 描述 instanceId 否 String 实例id,唯一标识。创建实例,instanceId由service-center产生。 serviceId 否 String 微服务唯一标识,创建实例时,以url里面的为准,不用这里的serviceId。 version 否 String 微服务版本号。 hostName 是 String 主机信息。 endpoints 否 Array of strings 访问地址信息。 status 否 String 实例状态:UP、DOWN、STARTING、OUTOFSERVICE。 默认值UP。 properties 否 Object 微服务扩展属性,可以自定义KEY和相应的Value。长度最小1字节。 healthCheck 否 HealthCheck object 健康检查信息。 dataCenterInfo 否 DataCenterInfo object 数据中心信息。 timestamp 否 String 实例创建时间戳,自动生成。 modTimestamp 否 String 更新时间。 表5 HealthCheck 参数 是否必选 参数类型 描述 mode 是 String 心跳模式push/pull。 port 否 Integer 端口。 interval 是 Integer 心跳间隔(秒),当值小于5秒时,按5秒注册。 times 是 Integer 最大尝试请求次数。 表6 DataCenterInfo 参数 是否必选 参数类型 描述 name 是 String 区 域名 字。 region 是 String 区域。 availableZone 是 String 可用区。
  • URI POST /v4/{project_id}/registry/microservices/{service_id}/instances 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 微服务引擎专业版,请填租户项目id,长度为1~64,获取方法请参考获取项目ID。也可以填固定值default。 微服务引擎专享版,请填固定值:default。 service_id 是 String 微服务唯一标识。字符长度为1~64,正则表达式为^.*$。获取方法请参考查询所有微服务信息。
  • 响应参数 状态码: 400 表3 响应Body参数 参数 参数类型 描述 errorCode String 错误代码。 errorMessage String 错误信息。 detail String 详细定位信息。 状态码: 500 表4 响应Body参数 参数 参数类型 描述 errorCode String 错误代码。 errorMessage String 错误信息。 detail String 详细定位信息。
  • 请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 Authorization 否 String 若ServiceComb引擎专享版开启了安全认证,此参数必填。否则,无此参数。 开启了安全认证的ServiceComb引擎专享版Token,格式为: Authorization:Bearer {Token} Token获取方法,请参考获取ServiceComb引擎专享版用户Token。
  • URI PUT /v4/{project_id}/registry/microservices/{service_id}/instances/{instance_id}/heartbeat 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 请填固定值:default。 service_id 是 String 微服务唯一标识。字符长度为1~64,正则表达式为^.*$。获取方法请参考查询所有微服务信息。 instance_id 是 String 微服务实例唯一标识。字符长度不超过64位, 正则表达式为^[A-Za-z0-9_.-]*$。获取方法请参考根据service_id查询微服务实例。
  • 响应参数 状态码: 400 表4 响应Body参数 参数 参数类型 描述 errorCode String 错误代码。 errorMessage String 错误信息。 detail String 详细定位信息。 状态码: 500 表5 响应Body参数 参数 参数类型 描述 errorCode String 错误代码。 errorMessage String 错误信息。 detail String 详细定位信息。
  • URI PUT /v4/{project_id}/registry/microservices/{service_id}/instances/{instance_id}/status 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 请填固定值:default。 service_id 是 String 微服务唯一标识。字符长度为1~64,正则表达式为^.*$。获取方法请参考查询所有微服务信息。 instance_id 是 String 微服务实例唯一标识。字符长度不超过64位, 正则表达式为^[A-Za-z0-9_.-]*$。获取方法请参考根据service_id查询微服务实例。 表2 Query参数 参数 是否必选 参数类型 描述 value 是 String 实例状态。UP表示在线、OUTOFSERVICE表示摘机、STARTING表示正在启动、DOWN表示下线、TESTING表示拨测。