package schedulerpb

Get desktop application:
View/edit binary Protocol Buffers messages

• rpc GetMembers (GetMembersRequest, GetMembersResponse)

  schedulerpb.proto:16

  GetMembers get the member list of this cluster. It does not require the cluster_id in request matchs the id of this cluster.

  message GetMembersRequest

  schedulerpb.proto:235

  • optional RequestHeader header = 1

  message GetMembersResponse

  schedulerpb.proto:239

  • optional ResponseHeader header = 1

  • repeated Member members = 2

  • optional Member leader = 3

  • optional Member etcd_leader = 4

• rpc Tso (stream TsoRequest, stream TsoResponse)

  schedulerpb.proto:18

  message TsoRequest

  schedulerpb.proto:85

  • optional RequestHeader header = 1

  • uint32 count = 2

  message TsoResponse

  schedulerpb.proto:96

  • optional ResponseHeader header = 1

  • uint32 count = 2

  • optional Timestamp timestamp = 3

• rpc Bootstrap (BootstrapRequest, BootstrapResponse)

  schedulerpb.proto:20

  message BootstrapRequest

  schedulerpb.proto:103

  • optional RequestHeader header = 1

  • optional metapb.Store store = 2

  message BootstrapResponse

  schedulerpb.proto:109

  • optional ResponseHeader header = 1

• rpc IsBootstrapped (IsBootstrappedRequest, IsBootstrappedResponse)

  schedulerpb.proto:22

  message IsBootstrappedRequest

  schedulerpb.proto:113

  • optional RequestHeader header = 1

  message IsBootstrappedResponse

  schedulerpb.proto:117

  • optional ResponseHeader header = 1

  • bool bootstrapped = 2

• rpc AllocID (AllocIDRequest, AllocIDResponse)

  schedulerpb.proto:24

  message AllocIDRequest

  schedulerpb.proto:123

  • optional RequestHeader header = 1

  message AllocIDResponse

  schedulerpb.proto:127

  • optional ResponseHeader header = 1

  • uint64 id = 2

• rpc GetStore (GetStoreRequest, GetStoreResponse)

  schedulerpb.proto:26

  message GetStoreRequest

  schedulerpb.proto:133

  • optional RequestHeader header = 1

  • uint64 store_id = 2

  message GetStoreResponse

  schedulerpb.proto:139

  • optional ResponseHeader header = 1

  • optional metapb.Store store = 2

  • optional StoreStats stats = 3

• rpc PutStore (PutStoreRequest, PutStoreResponse)

  schedulerpb.proto:28

  message PutStoreRequest

  schedulerpb.proto:146

  • optional RequestHeader header = 1

  • optional metapb.Store store = 2

  message PutStoreResponse

  schedulerpb.proto:152

  • optional ResponseHeader header = 1

• rpc GetAllStores (GetAllStoresRequest, GetAllStoresResponse)

  schedulerpb.proto:30

  message GetAllStoresRequest

  schedulerpb.proto:156

  • optional RequestHeader header = 1

  • bool exclude_tombstone_stores = 2

    Do NOT return tombstone stores if set to true.

  message GetAllStoresResponse

  schedulerpb.proto:162

  • optional ResponseHeader header = 1

  • repeated metapb.Store stores = 2

• rpc StoreHeartbeat (StoreHeartbeatRequest, StoreHeartbeatResponse)

  schedulerpb.proto:32

  message StoreHeartbeatRequest

  schedulerpb.proto:373

  • optional RequestHeader header = 1

  • optional StoreStats stats = 2

  message StoreHeartbeatResponse

  schedulerpb.proto:379

  • optional ResponseHeader header = 1

• rpc RegionHeartbeat (stream RegionHeartbeatRequest, stream RegionHeartbeatResponse)

  schedulerpb.proto:34

  message RegionHeartbeatRequest

  schedulerpb.proto:247

  • optional RequestHeader header = 1

  • optional metapb.Region region = 2

  • optional metapb.Peer leader = 3

    Leader Peer sending the heartbeat.

  • repeated metapb.Peer pending_peers = 5

    Pending peers are the peers that the leader can't consider as working followers.

  • uint64 approximate_size = 10

    Approximate region size.

  message RegionHeartbeatResponse

  schedulerpb.proto:269

  • optional ResponseHeader header = 1

  • optional ChangePeer change_peer = 2

    Notice, Scheduleeer only allows handling reported epoch >= current scheduler's. Leader peer reports region status with RegionHeartbeatRequest to scheduler regularly, scheduler will determine whether this region should do ChangePeer or not. E,g, max peer number is 3, region A, first only peer 1 in A. 1. Scheduler region state -> Peers (1), ConfVer (1). 2. Leader peer 1 reports region state to scheduler, scheduler finds the peer number is < 3, so first changes its current region state -> Peers (1, 2), ConfVer (1), and returns ChangePeer Adding 2. 3. Leader does ChangePeer, then reports Peers (1, 2), ConfVer (2), scheduler updates its state -> Peers (1, 2), ConfVer (2). 4. Leader may report old Peers (1), ConfVer (1) to scheduler before ConfChange finished, scheduler stills responses ChangePeer Adding 2, of course, we must guarantee the second ChangePeer can't be applied in TiKV.

  • optional TransferLeader transfer_leader = 3

    Scheduler can return transfer_leader to let TiKV does leader transfer itself.

  • uint64 region_id = 4

    ID of the region

  • optional metapb.RegionEpoch region_epoch = 5

  • optional metapb.Peer target_peer = 6

    Leader of the region at the moment of the corresponding request was made.

• rpc GetRegion (GetRegionRequest, GetRegionResponse)

  schedulerpb.proto:36

• rpc GetPrevRegion (GetRegionRequest, GetRegionResponse)

  schedulerpb.proto:38

• rpc GetRegionByID (GetRegionByIDRequest, GetRegionResponse)

  schedulerpb.proto:40

  message GetRegionByIDRequest

  schedulerpb.proto:182

  • optional RequestHeader header = 1

  • uint64 region_id = 2

• rpc ScanRegions (ScanRegionsRequest, ScanRegionsResponse)

  schedulerpb.proto:42

  message ScanRegionsRequest

  schedulerpb.proto:190

  • optional RequestHeader header = 1

  • bytes start_key = 2

  • int32 limit = 3

    no limit when limit <= 0.

  • bytes end_key = 4

    end_key is +inf when it is empty.

  message ScanRegionsResponse

  schedulerpb.proto:198

  • optional ResponseHeader header = 1

  • repeated metapb.Region regions = 2

  • repeated metapb.Peer leaders = 3

• rpc AskSplit (AskSplitRequest, AskSplitResponse)

  schedulerpb.proto:44

  message AskSplitRequest

  schedulerpb.proto:296

  • optional RequestHeader header = 1

  • optional metapb.Region region = 2

  message AskSplitResponse

  schedulerpb.proto:302

  • optional ResponseHeader header = 1

  • uint64 new_region_id = 2

    We split the region into two, first uses the origin parent region id, and the second uses the new_region_id. We must guarantee that the new_region_id is global unique.

  • repeated uint64 new_peer_ids = 3

    The peer ids for the new split region.

• rpc GetClusterConfig (GetClusterConfigRequest, GetClusterConfigResponse)

  schedulerpb.proto:46

  message GetClusterConfigRequest

  schedulerpb.proto:205

  • optional RequestHeader header = 1

  message GetClusterConfigResponse

  schedulerpb.proto:209

  • optional ResponseHeader header = 1

  • optional metapb.Cluster cluster = 2

• rpc PutClusterConfig (PutClusterConfigRequest, PutClusterConfigResponse)

  schedulerpb.proto:48

  message PutClusterConfigRequest

  schedulerpb.proto:215

  • optional RequestHeader header = 1

  • optional metapb.Cluster cluster = 2

  message PutClusterConfigResponse

  schedulerpb.proto:221

  • optional ResponseHeader header = 1

• rpc ScatterRegion (ScatterRegionRequest, ScatterRegionResponse)

  schedulerpb.proto:50

  message ScatterRegionRequest

  schedulerpb.proto:383

  • optional RequestHeader header = 1

  • uint64 region_id = 2

  • optional metapb.Region region = 3

    Scheduler will use these region information if it can't find the region. For example, the region is just split and hasn't report to Scheduler yet.

  • optional metapb.Peer leader = 4

  message ScatterRegionResponse

  schedulerpb.proto:394

  • optional ResponseHeader header = 1

• rpc GetGCSafePoint (GetGCSafePointRequest, GetGCSafePointResponse)

  schedulerpb.proto:52

  message GetGCSafePointRequest

  schedulerpb.proto:398

  • optional RequestHeader header = 1

  message GetGCSafePointResponse

  schedulerpb.proto:402

  • optional ResponseHeader header = 1

  • uint64 safe_point = 2

• rpc UpdateGCSafePoint (UpdateGCSafePointRequest, UpdateGCSafePointResponse)

  schedulerpb.proto:54

  message UpdateGCSafePointRequest

  schedulerpb.proto:408

  • optional RequestHeader header = 1

  • uint64 safe_point = 2

  message UpdateGCSafePointResponse

  schedulerpb.proto:414

  • optional ResponseHeader header = 1

  • uint64 new_safe_point = 2

• rpc GetOperator (GetOperatorRequest, GetOperatorResponse)

  schedulerpb.proto:56

  message GetOperatorRequest

  schedulerpb.proto:420

  • optional RequestHeader header = 1

  • uint64 region_id = 2

  message GetOperatorResponse

  schedulerpb.proto:433

  • optional ResponseHeader header = 1

  • uint64 region_id = 2

  • bytes desc = 3

  • OperatorStatus status = 4

  • bytes kind = 5

Used in: RegionHeartbeatResponse

• optional metapb.Peer peer = 1

• eraftpb.ConfChangeType change_type = 2

Used in: ResponseHeader

• ErrorType type = 1

• string message = 2

Used in: Error

• OK = 0

• UNKNOWN = 1

• NOT_BOOTSTRAPPED = 2

• STORE_TOMBSTONE = 3

• ALREADY_BOOTSTRAPPED = 4

• INCOMPATIBLE_VERSION = 5

• REGION_NOT_FOUND = 6

Used as request type in: Scheduler.GetPrevRegion, Scheduler.GetRegion

• optional RequestHeader header = 1

• bytes region_key = 2

Used as response type in: Scheduler.GetPrevRegion, Scheduler.GetRegion, Scheduler.GetRegionByID

• optional ResponseHeader header = 1

• optional metapb.Region region = 2

• optional metapb.Peer leader = 3

• repeated metapb.Peer slaves = 4

Used in: GetMembersResponse

• string name = 1

  name is the name of the Scheduler member.

• uint64 member_id = 2

  member_id is the unique id of the Scheduler member.

• repeated string peer_urls = 3

• repeated string client_urls = 4

• int32 leader_priority = 5

Used in: GetOperatorResponse

• SUCCESS = 0

• TIMEOUT = 1

• CANCEL = 2

• REPLACE = 3

• RUNNING = 4

Used in: StoreStats

• string key = 1

• uint64 value = 2

• optional RequestHeader header = 1

• optional metapb.Region left = 2

• optional metapb.Region right = 3

• optional ResponseHeader header = 1

Used in: AllocIDRequest, AskSplitRequest, BootstrapRequest, GetAllStoresRequest, GetClusterConfigRequest, GetGCSafePointRequest, GetMembersRequest, GetOperatorRequest, GetRegionByIDRequest, GetRegionRequest, GetStoreRequest, IsBootstrappedRequest, PutClusterConfigRequest, PutStoreRequest, RegionHeartbeatRequest, ReportSplitRequest, ScanRegionsRequest, ScatterRegionRequest, StoreHeartbeatRequest, TsoRequest, UpdateGCSafePointRequest

• uint64 cluster_id = 1

  cluster_id is the ID of the cluster which be sent to.

Used in: AllocIDResponse, AskSplitResponse, BootstrapResponse, GetAllStoresResponse, GetClusterConfigResponse, GetGCSafePointResponse, GetMembersResponse, GetOperatorResponse, GetRegionResponse, GetStoreResponse, IsBootstrappedResponse, PutClusterConfigResponse, PutStoreResponse, RegionHeartbeatResponse, ReportSplitResponse, ScanRegionsResponse, ScatterRegionResponse, StoreHeartbeatResponse, TsoResponse, UpdateGCSafePointResponse

• uint64 cluster_id = 1

  cluster_id is the ID of the cluster which sent the response.

• optional Error error = 2

• uint64 new_region_id = 1

• repeated uint64 new_peer_ids = 2

Used in: GetStoreResponse, StoreHeartbeatRequest

• uint64 store_id = 1

• uint64 capacity = 2

  Capacity for the store.

• uint64 available = 3

  Available size for the store.

• uint32 region_count = 4

  Total region count in this store.

• uint32 sending_snap_count = 5

  Current sending snapshot count.

• uint32 receiving_snap_count = 6

  Current receiving snapshot count.

• uint32 start_time = 7

  When the store is started (unix timestamp in seconds).

• uint32 applying_snap_count = 8

  How many region is applying snapshot.

• bool is_busy = 9

  If the store is busy

• uint64 used_size = 10

  Actually used space by db

• optional TimeInterval interval = 15

  Actually reported time interval

• repeated RecordPair cpu_usages = 16

  Threads' CPU usages in the store

• repeated RecordPair read_io_rates = 17

  Threads' read disk I/O rates in the store

• repeated RecordPair write_io_rates = 18

  Threads' write disk I/O rates in the store

• repeated RecordPair op_latencies = 19

  Operations' latencies in the store

Used in: StoreStats

• uint64 start_timestamp = 1

  The unix timestamp in seconds of the start of this period.

• uint64 end_timestamp = 2

  The unix timestamp in seconds of the end of this period.

Used in: TsoResponse

• int64 physical = 1

• int64 logical = 2

Used in: RegionHeartbeatResponse

• optional metapb.Peer peer = 1