Console常规API

Console常规API

哨兵

1 - 添加哨兵

接口信息

接口地址	/api/sentinels
请求方式	HTTP / POST
参数类型	application/json

请求参数

字段名	字段类型	是否必填	描述	示例
dcName	String	是	哨兵所在机房名	"demoDc"
sentinels	List	是	哨兵地址数组	["127.0.0.1:26379"]
desc	String	是	哨兵描述	"示例哨兵"

返回参数

字段名	字段类型	是否必填	描述	示例
state	String	是	状态码	0
message	String	是	哨兵地址数组	"Successfully create Sentinel"

示例

请求参数：
{
	"dcName": "demoDc",
	"sentinels": [
		"127.0.0.1:26379"，
		"127.0.0.2:26379"，
		"127.0.0.3:26379"，
	],
	"desc": "示例哨兵"
}

返回参数：
{
  "state": 0,
  "message": "Successfully create Sentinel"
}

2 - 修改哨兵地址

接口信息

接口地址	/api/sentinel/address
请求方式	HTTP / PUT
传参方式	application/json

请求参数

字段名	字段类型	是否必填	描述	示例
id	Int	是	哨兵Id	1
sentinels	List	是	哨兵地址数组	["127.0.0.1:26379"]

返回参数

字段名	字段类型	是否必填	描述	示例
state	String	是	状态码	0
message	String	是	成功时为哨兵信息Json字符串	"{\n "id" : 1,\n "dcName" : null,\n "sentinels" : [ {\n "m_host" : "127.0.0.1",\n "m_port" : 26379\n } ],\n "desc" : "示例哨兵"\n}"

示例

请求参数：
{
	"id": "1",
	"sentinels": [
		"127.0.0.1:26379"，
		"127.0.0.2:26379"，
		"127.0.0.3:26379"，
	]
}

返回参数：
{
  "state": 0,
  "message": "{\n  \"id\" : 1,\n  \"dcName\" : null,\n  \"sentinels\" : [ {\n    \"m_host\" : \"127.0.0.1\",\n    \"m_port\" : 26379\n  }, {\n    \"m_host\" : \"127.0.0.2\",\n    \"m_port\" : 26379\n  }, {\n    \"m_host\" : \"127.0.0.3\",\n    \"m_port\" : 26379\n  } ],\n  \"desc\" : \"示例哨兵\"\n}"
}

3 - 删除哨兵

接口信息

接口地址	/api/sentinels/${sentinelId}
请求方式	HTTP / DELETE
传参方式	Path Variable

请求参数

字段名	字段类型	是否必填	描述	示例
sentinelId	Int	是	哨兵Id	1

返回参数

字段名	字段类型	是否必填	描述	示例
state	String	是	状态码	0
message	String	是	成功时为哨兵信息Json字符串	"Successfully deleted Sentinel"

示例

请求Url：http://127.0.0.1:8080/api/sentinels/1

返回参数：
{
  "state": 0,
  "message": "Successfully deleted Sentinel"
}

4 - 获取哨兵使用情况

接口信息

接口地址	/api/sentinels/usage
请求方式	HTTP / GET
传参方式	-

请求参数

无

返回参数

字段名	字段类型	是否必填	描述	示例
state	String	是	状态码	0
message	String	是	状态信息	null
payload	Object	是	各机房下哨兵监听的集群数量	{ "dc1": { "dcName": "dc1", "sentinelUsages": { "127.0.0.1:26379": 400 } } }

示例

请求Url：http://127.0.0.1:8080/api/sentinels/usage

返回参数：
{
  "state": 0,
  "message": null,
  "payload": {
    "dc1": {
      "dcName": "dc1",
      "sentinelUsages": {
        "127.0.0.1:26379,127.0.0.2:26379,127.0.0.3:26379": 10,
        "127.0.0.4:26379,127.0.0.5:26379,127.0.0.6:26379": 10
      }
    },
    "dc2": {
      "dcName": "dc2",
      "sentinelUsages": {
        "127.0.0.7:26379,127.0.0.8:26379,127.0.0.9:26379": 2
      }
    }
  }
}

KeeperContainer

1 - 添加KeeperContainer

接口信息

接口地址	/api/keepercontainer
请求方式	HTTP / POST
传参方式	application/json

请求参数

字段名	字段类型	是否必填	描述	示例
dcName	String	是	keepercotainer所在机房名	"demoDc"
keepercontainerIp	String	是	keepercotainer ip	"10.0.0.1"
keepercontainerPort	Int	是	keepercotainer port	8080
keepercontainerOrgId	Int	是	keepercontainer所属部门Id，对应organization_tbl表内的org_id字段	0
active	Boolean	是	keepercontainer是否可用，表现在业务上就是在为集群添加keeper时该keepercontainer上是否可选 如此设计是为了在keepercontainer负载过大时限制keepercontainer的使用	true

返回参数

字段名	字段类型	是否必填	描述	示例
state	String	是	状态码	0
message	String	是	状态信息	"Add KeeperContainer successfully"

示例

请求参数：
{
    "dcName": "demoDc",
    "keepercontainerIp": "10.0.0.1",
    "keepercontainerPort": 8080,
    "keepercontainerOrgId": 0,
    "active": true
}

返回参数：
{
  "state": 0,
  "message": "Add KeeperContainer successfully"
}

2 - 更新KeeperContainer

接口信息

接口地址	/api/keepercontainer
请求方式	HTTP / PUT
传参方式	application/json

请求参数

字段名	字段类型	是否必填	描述	示例
dcName	String	是	keepercotainer所在机房名	"demoDc"
keepercontainerIp	String	是	keepercotainer ip	"10.0.0.1"
keepercontainerPort	Int	是	keepercotainer port	8080
keepercontainerOrgId	Int	是	keepercontainer所属部门Id	0
active	Boolean	是	keepercontainer是否可用	true

返回参数

字段名	字段类型	是否必填	描述	示例
state	String	是	状态码	0
message	String	是	状态信息	"success"

示例

请求参数：
{
    "dcName": "demoDc",
    "keepercontainerIp": "10.0.0.1",
    "keepercontainerPort": 8080,
    "keepercontainerOrgId": 0,
    "active": true
}

返回参数：
{
  "state": 0,
  "message": "success"
}

3 - 获取KeeperContainer信息

接口信息

接口地址	/api/keepercontainer/${dcName}
请求方式	HTTP / GET
传参方式	Path Variable

请求参数

字段名	字段类型	是否必填	描述	示例
dcName	String	是	查找机房名	"demoDc"

返回参数

Json数组

示例

请求Url：http://127.0.0.1:8080/api/keepercontainer/demoDc

返回参数：
[
  {
    "dcName": "demoDc",
    "keepercontainerIp": "10.0.0.1",
    "keepercontainerPort": 8080,
    "keepercontainerOrgId": 0,
    "orgName": null,
    "active": true
  },
  {
    "dcName": "demoDc",
    "keepercontainerIp": "10.0.0.2",
    "keepercontainerPort": 8080,
    "keepercontainerOrgId": 0,
    "orgName": null,
    "active": true
  }
]