服务管理

服务管理

服务管理

创建服务

请求示例：

POST /naming/v1/services
# 开启北极星服务端针对控制台接口鉴权开关后，需要添加下面的 header
Header X-Polaris-Token: {访问凭据}
[
    {
        "name":"...",
        "namespace":"...",
        "metadata":{
        },
        "ports":"...",
        "business":"...",
        "department":"...",
        "comment":"..."
    }
]

应答示例：

{
    "code":200000,
    "info":"...",
    "size":1,
    "responses":[
        {
            "code":200000,
            "info":"...",
            "service":{
                "name":"...",
                "namespace":"..."
            }
        }
    ]
}

数据结构：

参数名	类型	描述	是否必填
name	string	服务名	是
namespace	string	命名空间	是
metadata	map<string,string>	服务标签/元数据	否
ports	string	端口列表，多个port以逗号分隔	否
business	string	服务所属业务，建议填写。	否
department	string	服务所属部门，建议填写。	否
comment	string	描述	否
user_ids	[]string	可以操作该资源的用户，仅当开启北极星鉴权时生效	否
group_ids	[]string	可以操作该资源的用户组，，仅当开启北极星鉴权时生效	否
remove_user_ids	[]string	被移除的可操作该资源的用户，仅当开启北极星鉴权时生效	否
remove_group_ids	[]string	被移除的可操作该资源的用户组，仅当开启北极星鉴权时生效	否

删除服务

删除一个不存在的服务，认为删除成功

请求示例：

POST /naming/v1/services/delete
# 开启北极星服务端针对控制台接口鉴权开关后，需要添加下面的 header
Header X-Polaris-Token: {访问凭据}
[
    {
        "name":"...",
        "namespace":"..."
    }
]

应答示例：

{
    "code":200000,
    "info":"...",
    "size":1,
    "responses":[
        {
            "code":200000,
            "info":"...",
            "service":{
                "name":"...",
                "namespace":"..."
            }
        }
    ]
}

数据结构：

参数名	类型	描述	是否必填
name	string	服务名	是
namespace	string	命名空间	是

更新服务

请求示例：

PUT /naming/v1/services
# 开启北极星服务端针对控制台接口鉴权开关后，需要添加下面的 header
Header X-Polaris-Token: {访问凭据}
[
    {
        "name":"...",
        "namespace":"...",
        "token":"...",
        "metadata":{
        },
        "ports":"...",
        "business":"...",
        "department":"...",
        "comment":"..."
    }
]

应答示例：

{
    "code":200000,
    "info":"...",
    "size":1,
    "responses":[
        {
            "code":200000,
            "info":"...",
            "service":{
                "name":"...",
                "namespace":"..."
            }
        }
    ]
}

数据结构：

参数名	类型	描述	是否必填	可否修改
name	string	服务名	是	否
namespace	string	命名空间	是	否
metadata	map<string,string>	服务标签/元数据	否	是
ports	string	端口列表，多个port以逗号分隔	否	是
business	string	服务所属业务，建议填写。	否	是
department	string	服务所属部门，建议填写。	否	是
comment	string	描述	否	是
user_ids	[]string	可以操作该资源的用户，仅当开启北极星鉴权时生效	否
group_ids	[]string	可以操作该资源的用户组，，仅当开启北极星鉴权时生效	否
remove_user_ids	[]string	被移除的可操作该资源的用户，仅当开启北极星鉴权时生效	否
remove_group_ids	[]string	被移除的可操作该资源的用户组，仅当开启北极星鉴权时生效	否

查询服务

请求示例：

GET /naming/v1/services?参数名=参数值
# 开启北极星服务端针对控制台接口鉴权开关后，需要添加下面的 header
Header X-Polaris-Token: {访问凭据}

参数名	类型	描述	是否必填
name	string	服务名	否
namespace	string	命名空间	否
business	string	业务，默认模糊查询	否
department	string	部门	否
host	string	实例IP，多个IP以英文逗号分隔	否
port	string	实例端口，多个端口以英文逗号分隔	否
keys	string	服务元数据名，keys和values需要同时填写，目前只支持查询一组元数据。	否
values	string	服务元数据值，keys和values需要同时填写，目前只支持查询一组元数据。	否
offset	int	默认为0	否
limit	int	默认为100，最大100	否

应答示例：

{
    "code":200000,
    "info":"...",
    "amount":1,
    "size":1,
    "services":[
        {
            "name":"...",
            "namespace":"...",
            "metadata":{
            },
            "ports":"...",
            "business":"...",
            "department":"...",
            "comment":"...",
            "ctime":"...",
            "mtime":"...",
            "total_instance_count": 1,
            "healthy_instance_count":1
        }
    ]
}

参数名	类型	描述
code	uint32	六位返回码
info	string	返回信息
amount	uint32	符合此查询条件的服务总数，例如查询命名空间为default的服务，总数为1000，本次返回100条，则amount为1000
size	uint32	本次查询返回的服务个数，例如查询命名空间为default的服务，总数为1000，本次返回100条，则size为100