blackfox1983 commented on a change in pull request #4261: URL: https://github.com/apache/incubator-doris/pull/4261#discussion_r465685916
########## File path: docs/zh-CN/administrator-guide/http-actions/fe/health-action.md ########## @@ -0,0 +1,80 @@ +--- +{ + "title": "Health Action", + "language": "zh-CN" +} +--- + +<!-- +Licensed to the Apache Software Foundation (ASF) under one +or more contributor license agreements. See the NOTICE file +distributed with this work for additional information +regarding copyright ownership. The ASF licenses this file +to you under the Apache License, Version 2.0 (the +"License"); you may not use this file except in compliance +with the License. You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + +Unless required by applicable law or agreed to in writing, +software distributed under the License is distributed on an +"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY +KIND, either express or implied. See the License for the +specific language governing permissions and limitations +under the License. +--> + +# Health Action + +## Request + +`GET /api/health` + +## Description + +返回集群当前存活的 BE 节点数和宕机的 BE 节点数。 + +## Path parameters + +无 + +## Query parameters + +无 + +## Request body + +无 + +## Response + +``` +{ + "msg": "success", + "code": 0, + "data": { + "online_backend_num": 10, + "total_backend_num": 10 + }, + "count": 0 +} +``` + +## Examples + +1. 获取集群节点健康信息 + + ``` + GET /api/health + + Response: + { + "msg": "success", + "code": 0, + "data": { + "online_backend_num": 10, Review comment: 这个地方是否可以加上be的ip? 这样可以知道哪个be出问题了。 ---------------------------------------------------------------- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. For queries about this service, please contact Infrastructure at: us...@infra.apache.org --------------------------------------------------------------------- To unsubscribe, e-mail: commits-unsubscr...@doris.apache.org For additional commands, e-mail: commits-h...@doris.apache.org