add status http interface

Signed-off-by: Ryan Leung <[email protected]>

client/http/interface.go

@@ -58,6 +58,7 @@ type Client interface {
 	GetClusterVersion(context.Context) (string, error)
 	GetCluster(context.Context) (*metapb.Cluster, error)
 	GetClusterStatus(context.Context) (*ClusterState, error)
+	GetStatus(context.Context) (*State, error)
 	GetReplicateConfig(context.Context) (map[string]any, error)
 	/* Scheduler-related interfaces */
 	GetSchedulers(context.Context) ([]string, error)
@@ -459,6 +460,20 @@ func (c *client) GetClusterStatus(ctx context.Context) (*ClusterState, error) {
 	return clusterStatus, nil
 }
 
+// GetStatus gets the status of PD.
+func (c *client) GetStatus(ctx context.Context) (*State, error) {
+	var status *State
+	err := c.request(ctx, newRequestInfo().
+		WithName(getStatusName).
+		WithURI(Status).
+		WithMethod(http.MethodGet).
+		WithResp(&status))
+	if err != nil {
+		return nil, err
+	}
+	return status, nil
+}
+
 // GetReplicateConfig gets the replication configurations.
 func (c *client) GetReplicateConfig(ctx context.Context) (map[string]any, error) {
 	var config map[string]any

client/http/request_info.go

@@ -46,6 +46,7 @@ const (
 	getClusterVersionName                   = "GetClusterVersion"
 	getClusterName                          = "GetCluster"
 	getClusterStatusName                    = "GetClusterStatus"
+	getStatusName                           = "GetStatus"
 	getReplicateConfigName                  = "GetReplicateConfig"
 	getSchedulersName                       = "GetSchedulers"
 	createSchedulerName                     = "CreateScheduler"

client/http/types.go

@@ -34,6 +34,15 @@ type ClusterState struct {
 	ReplicationStatus string    `json:"replication_status"`
 }
 
+// State is the status of PD server.
+// NOTE: This type is exported by HTTP API. Please pay more attention when modifying it.
+type State struct {
+	BuildTS        string `json:"build_ts"`
+	Version        string `json:"version"`
+	GitHash        string `json:"git_hash"`
+	StartTimestamp int64  `json:"start_timestamp"`
+}
+
 // KeyRange defines a range of keys in bytes.
 type KeyRange struct {
 	startKey []byte

tests/integrations/client/http_client_test.go

@@ -651,6 +651,22 @@ func (suite *httpClientTestSuite) checkVersion(mode mode, client pd.Client) {
 	re.Equal(versioninfo.PDReleaseVersion, ver)
 }
 
+func (suite *httpClientTestSuite) TestStatus() {
+	suite.RunTestInTwoModes(suite.checkStatus)
+}
+
+func (suite *httpClientTestSuite) checkStatus(mode mode, client pd.Client) {
+	re := suite.Require()
+	env := suite.env[mode]
+
+	status, err := client.GetStatus(env.ctx)
+	re.NoError(err)
+	re.Equal(versioninfo.PDReleaseVersion, status.Version)
+	re.Equal(versioninfo.PDGitHash, status.GitHash)
+	re.Equal(versioninfo.PDBuildTS, status.BuildTS)
+	re.GreaterOrEqual(time.Now().Unix(), status.StartTimestamp)
+}
+
 func (suite *httpClientTestSuite) TestAdmin() {
 	suite.RunTestInTwoModes(suite.checkAdmin)
 }