服务别名管理

服务别名管理

服务别名管理

创建服务别名

用户可以为服务创建别名，可以通过别名来访问服务的资源数据。

请求示例：

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

应答示例：

{
    "code":200000,
    "info":"...",
    "alias":{
        "service":"...",
        "namespace":"...",
        "alias":"...",
        "alias_namespace":"...",
        "comment":"..."
    }
}

数据结构：

参数名	类型	描述	必填
alias	string	服务别名	是
alias_namespace	string	服务别名所属命名空间	是
service	string	指向的服务名	是
namespace	string	指向的服务所属命名空间	是
comment	string	服务别名描述	否

修改服务别名

请求示例：

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

应答示例：

{
    "code":200000,
    "info":"...",
    "alias":{
        "service":"...",
        "namespace":"...",
        "alias":"...",
        "alias_namespace":"...",
        "comment":"..."
    }
}

数据结构：

参数名	类型	描述	必填
alias	string	服务别名	是
alias_namespace	string	服务别名所属命名空间	是
service	string	指向的服务名	是
namespace	string	指向的服务所属命名空间	是
comment	string	服务别名描述	否

删除服务别名

请求示例：

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

应答示例：

{
    "code":200000,
    "info":"...",
    "size":1,
    "responses":[
        {
            "code":200000,
            "info":"...",
            "alias":{
                "alias":"...",
                "alias_namespace":"..."
            }
        }
    ]
}

数据结构：

参数名	类型	描述	必填
alias	string	服务别名	是
alias_namespace	string	服务别名所属命名空间	是

查询服务别名

请求示例：

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

应答示例：

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

{
    "code":200000,
    "info":"...",
    "amount":1,
    "size":1,
    "aliases":[
        {
            "alias":"...",
            "alias_namespace":"...",
            "namespace":"...",
            "service":"...",
            "comment":"...",
            "ctime":"...",
            "mtime":"..."
        }
    ]
}

数据结构：

参数名	类型	描述	必填
alias	string	服务别名	否
alias_namespace	string	服务别名所属命名空间	否
service	string	指向的服务名	否
namespace	string	指向的服务所属命名空间	否
offset	int	分页偏移，默认0	否
limit	int	分页大小，默认为100，最大100	否

查询服务实例

请求示例：

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

参数名	类型	描述	必填
service	string	服务名	若填host，则可不填；否则必填
namespace	string	命名空间	若填host，则可不填；否则必填
host	string	实例IP，多个IP以英文逗号分隔	若填写service+namespace，则可不填；否则必填
port	int	端口	否
version	string	版本	否
protocol	string	协议	否
health_status	string	健康状态；0代表异常；1代表健康	否
isolate	string	隔离状态；0代表否；1代表是	否
weight	int	权重	否
keys	string	服务实例元数据名，keys和values需要同时填写，目前只支持查询一组元数据。	否
values	string	服务实例元数据值，keys和values需要同时填写，目前只支持查询一组元数据。	否
offset	int	默认为0	否
limit	int	默认为100，最大100	否

应答示例：

{
    "code":200000,
    "info":"...",
    "amount":1,
    "size":1,
    "instances":[
        {
            "id":"...",
            "service":"...",
            "namespace":"...",
            "host":"...",
            "port":80,
            "protocol":"...",
            "version":"...",
            "weight":100,
            "health_check":{
                "type":1,
                "heartbeat":{
                    "ttl":5
                }
            },
            "healthy":true,
            "isolate":true,
            "location":{
                "region":"...",
                "zone":"...",
                "campus":"..."
            },
            "metadata":{
            },
            "logic_set":"...",
            "ctime":"...",
            "mtime":"..."
        }
    ]
}

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