更新时间:2022-08-15 GMT+08:00

创建微服务静态信息

功能介绍

在注册微服务实例前需要创建服务静态信息,之后注册的微服务实例根据ServiceId这个字段与静态信息关联,一个服务对应多个实例。

ServiceId可以定制。如果定制了,系统将使用定制的ServiceId;如果没定制,系统会随机生成ServiceId。

URI

POST /v4/{project_id}/registry/microservices

表1 路径参数

参数

类型

必选

说明

project_id

String

请填固定值:default。

请求消息

表2 请求Body参数

参数

类型

必选

说明

service

Object

微服务结构体,具体参考MicroService

rules

Array of objects

新增黑白名单结构体,具体参考Rule

instances

Array of objects

微服务实例结构体,具体参考MicroServiceInstance

tags

Map<String, String>

微服务标签,可以自定义Key和相应的Value。

响应消息

响应参数

参数说明请参见表3

表3 参数说明

参数

类型

说明

serviceId

String

微服务唯一标识。

示例

请求示例

{
  "service": {
    "serviceId": "string",
    "environment": "string",
    "appId": "string",
    "serviceName": "string",
    "version": "string",
    "description": "string",
    "level": "string",
    "registerBy": "string",
    "schemas": [
      "string"
    ],
    "status": "UP",
    "timestamp": "string",
    "modTimestamp": "string",
    "framework": {
      "name": "string",
      "version": "string"
    },
    "paths": [
      {
        "Path": "string",
        "Property": {
          "additionalProp1": "string",
          "additionalProp2": "string",
          "additionalProp3": "string"
        }
      }
    ]
  },
  "rules": [
    {
      "ruleId": "string",
      "ruleType": "string",
      "attribute": "string",
      "pattern": "string",
      "description": "string",
      "timestamp": "string",
      "modTimestamp": "string"
    }
  ],
  "instances": [
    {
      "instanceId": "string",
      "serviceId": "string",
      "version": "string",
      "hostName": "string",
      "endpoints": [
        "string"
      ],
      "status": "string",
      "healthCheck": {
        "mode": "string",
        "port": 0,
        "interval": 0,
        "times": 0
      },
      "dataCenterInfo": {
        "name": "string",
        "region": "string",
        "availableZone": "string"
      },
      "timestamp": "string",
      "modTimestamp": "string"
    }
  ],
  "tags": {
    "additionalProp1": "string",
    "additionalProp2": "string",
    "additionalProp3": "string"
  }
}

响应示例

{
  "serviceId": "string"
}

状态码

状态码请参见状态码

错误码

错误码请参见CSE错误码