Apisix-dashboard: backend APISIX instance status API

[tokers]

Feature request

Please describe your feature

We have already some discussions about this topic: https://lists.apache.org/thread.html/re3097f7e88d636e8137231c36462c32773b2b4817d91f7997e91358f%40%3Cdev.apisix.apache.org%3E.

Additional context

This thread is used to track the development progress of manager api part.

The related issues:

• https://github.com/apache/apisix/issues/2821
• apache/apisix-dashboard#850

[starsz]

Hi, @tokers, please assign to me.

[tokers]

OK

[starsz]

After discussed with @tokers @juzhiyuan .There are some things that need to do in the backend.

Todo:
1. manager-api needs to start a goroutine to clean the node status info which is out of date. e.g. some apisix instances are offline for a long time.

1. manager-api needs two APIs, one for list query, and another for detail query.

@membphis @moonming What do you think?

[tokers]

After discussed with @tokers @juzhiyuan .There are some things that need to do in the backend.

Todo:

1. manager-api needs to start a goroutine to clean the node status info which is out of date. e.g. some apisix instances are offline for a long time.
2. manager-api needs two APIs, one for list query, and another for detail query.

@membphis @moonming What do you think?

@starsz I have a better idea, we don't have to clean the offline APISIX instances' status data, just attaching a lease for these keys, they will be deleted automatically.

[starsz]

@tokers. Agree with you. I think this can be done in DP.
So, CP doesn't need to care about it.

[starsz]

Hi, I think the API may like this.

GET /apisix/admin/server_info/{id}

ResponseBody

{
"up_time": 10,
"last_report_time": 1606539645,
"id": "71cb4999-4349-475d-aa39-c703944a63d3",
"etcd_version": "3.5.0",
"hostname": "gento",
"version": "2.0"
}

if without id, it will return an array like this:

{"code":0,"message":"","data":{"rows":[{"up_time": 10,"last_report_time": 1606539645,"id": "71cb4999-4349-475d-aa39-c703944a63d3","etcd_version": "3.5.0","hostname": "gento","version": "2.0"}],"total_size":1},"request_id":"6a3821a2-e0f7-45fc-bf55-2eddb7122154"}

if with id, it will return an object:

{"code":0,"message":"","data":{"up_time": 10,"last_report_time": 1606539645,"id": "71cb4999-4349-475d-aa39-c703944a63d3","etcd_version": "3.5.0","hostname": "gento","version": "2.0"},"request_id":"6a3821a2-e0f7-45fc-bf55-2eddb7122154"}

[juzhiyuan]

LGTM, but should we still keep the /apisix/adminprefix?

[tokers]

LGTM, but should we still keep the /apisix/adminprefix?

Maybe the admin section could be removed.

[juzhiyuan]

Could we use something like /api/xxx in the future? because admin API will be deprecated.

[tokers]

Could we use something like /api/xxx in the future? because admin API will be deprecated.

Maybe add the version is better? Like /api/v1/xxx, so that the API migration will be easy.

[juzhiyuan]

Agree, how about you? @membphis @liuxiran

[starsz]

Agree +1.

[membphis]

Could we use something like /api/xxx in the future? because admin API will be deprecated.

need to add prefix /apisix/****

[juzhiyuan]

🤔 when will the version be upgraded?

[juzhiyuan]

Could we use something like /api/xxx in the future? because admin API will be deprecated.

need to add prefix /apisix/****

It's strange to see apisix as a prefix for manager api IMHO.

[moonming]

why we need apisix as prefix？

YuanSheng Wang [e-mail]于2020年11月29日 周日下午2:10写道：

Could we use something like /api/xxx in the future? because admin API
will be deprecated.

need to add prefix /apisix/**

—
You are receiving this because you were mentioned.
Reply to this email directly, view it on GitHub
https://github.com/apache/apisix-dashboard/issues/849#issuecomment-735349443,
or unsubscribe
https://github.com/notifications/unsubscribe-auth/AGJZBKZCTIUJX5RNKO4TUX3SSHQUXANCNFSM4T646PPA
.

>

Thanks,
Ming Wen
Twitter: _WenMing

[juzhiyuan]

Hi, I think the API may like this.

GET /apisix/admin/server_info/{id}

ResponseBody

{
"up_time": 10,
"last_report_time": 1606539645,
"id": "71cb4999-4349-475d-aa39-c703944a63d3",
"etcd_version": "3.5.0",
"hostname": "gento",
"version": "2.0"
}

if without id, it will return an array like this:

{"code":0,"message":"","data":{"rows":[{"up_time": 10,"last_report_time": 1606539645,"id": "71cb4999-4349-475d-aa39-c703944a63d3","etcd_version": "3.5.0","hostname": "gento","version": "2.0"}],"total_size":1},"request_id":"6a3821a2-e0f7-45fc-bf55-2eddb7122154"}

if with id, it will return an object:

{"code":0,"message":"","data":{"up_time": 10,"last_report_time": 1606539645,"id": "71cb4999-4349-475d-aa39-c703944a63d3","etcd_version": "3.5.0","hostname": "gento","version": "2.0"},"request_id":"6a3821a2-e0f7-45fc-bf55-2eddb7122154"}

Hi @guoqqqi, please build mock data according to this data format.

{
"up_time": 10,
"last_report_time": 1606539645,
"id": "71cb4999-4349-475d-aa39-c703944a63d3",
"etcd_version": "3.5.0",
"hostname": "gento",
"version": "2.0"
}

[membphis]

@moonming why we need apisix as prefix？

Export addresses use a uniform prefix for easy management.

The gateway's own API should avoid conflicts with user APIs.