github.com/pingcap/tiflow@v0.0.0-20240520035814-5bf52d54e205/cdc/api/v2/status.go (about)

     1  // Copyright 2023 PingCAP, Inc.
     2  //
     3  // Licensed under the Apache License, Version 2.0 (the "License");
     4  // you may not use this file except in compliance with the License.
     5  // You may obtain a copy of the License at
     6  //
     7  //     http://www.apache.org/licenses/LICENSE-2.0
     8  //
     9  // Unless required by applicable law or agreed to in writing, software
    10  // distributed under the License is distributed on an "AS IS" BASIS,
    11  // See the License for the specific language governing permissions and
    12  // limitations under the License.
    13  
    14  package v2
    15  
    16  import (
    17  	"net/http"
    18  	"os"
    19  
    20  	"github.com/gin-gonic/gin"
    21  	"github.com/pingcap/tiflow/cdc/model"
    22  	"github.com/pingcap/tiflow/pkg/version"
    23  )
    24  
    25  // serverStatus Get the status information of a TiCDC node
    26  // @Summary Get the status information of a TiCDC node
    27  // @Description This API is a synchronous interface. If the request is successful,
    28  // the status information of the corresponding node is returned.
    29  //
    30  // @Tags common,v2
    31  // @Accept json
    32  // @Produce json
    33  // @Success 200 {object} ServerStatus
    34  // @Failure 500,400 {object} model.HTTPError
    35  // @Router	/api/v2/status [get]
    36  func (h *OpenAPIV2) serverStatus(c *gin.Context) {
    37  	info, err := h.capture.Info()
    38  	if err != nil {
    39  		_ = c.Error(err)
    40  		return
    41  	}
    42  	etcdClient := h.capture.GetEtcdClient()
    43  	status := model.ServerStatus{
    44  		Version:   version.ReleaseVersion,
    45  		GitHash:   version.GitHash,
    46  		Pid:       os.Getpid(),
    47  		ID:        info.ID,
    48  		ClusterID: etcdClient.GetClusterID(),
    49  		IsOwner:   h.capture.IsController(),
    50  		Liveness:  h.capture.Liveness(),
    51  	}
    52  	c.IndentedJSON(http.StatusOK, status)
    53  }