Skip to content

Latest commit

 

History

History
156 lines (120 loc) · 3.61 KB

api.md

File metadata and controls

156 lines (120 loc) · 3.61 KB
Raw

Metad API Document

Metad's api is http rest style, and divided to metadata api and management api.

  • Metadata api, default listen address is ":80"
  • Manage api, default listen address is "127.0.0.1:9661", only on localhost interface for security.

API Response ContentType

API response content type default is text, client can add "Accept" header to request, for special content type.

  • text text/plain
  • json application/json
  • yaml application/yaml,application/x-yaml,text/yaml,text/x-yaml"

Metadata API

GET /{nodePath}[?wait=true&pre_version=$version]

This api for client get metadata, and will process self mapping by client ip.

return origin metadata, for json example.

{
	"nodes": {
		"1": {
			"ip": "192.168.1.1",
			"name": "nn_node1"
		},
		"2": {
			"ip": "192.168.1.2",
			"name": "node2"
		},
		"3": {
			"ip": "192.168.1.3",
			"name": "node3"
		},
		"4": {
			"ip": "192.168.1.4",
			"name": "node4"
		},
		"5": {
			"ip": "192.168.1.5",
			"name": "node5"
		},
		"6": {
			"ip": "192.168.1.6",
			"label": {
				"key3": "value3"
			},
			"name": "node6"
		}
	},
	"self": {
		"node": {
			"ip": "192.168.1.2",
			"name": "node2"
		}
	}
}

Parameter

  • wait if wait=true, server will hold the connection until the metadata change.
  • prev_version if this parameter is present, server will check if the metadata has changed after the version, if true, return immediately.

Response Headers

  • X-Metad-RequestID request id for trace.
  • X-Metad-Version current metadata's version. can use to wait change request as prev_version's value.

Manage API

Manage API default port is 127.0.0.1:9611

/v1/data[/{nodePath}]

This api is for manage metadata

  • GET show metadata.
  • POST create or replace metadata.
  • PUT create or merge metadata.
  • DELETE delete metadata, default delete all metadata in nodePath, unless subs parameter is present.

/v1/mapping[/{nodePath}]

This api is for manage metadata's ip mapping

  • GET show mapping config.
  • POST create or replace mapping config.
  • PUT create or merge update mapping config.
  • DELETE delete mapping config, default delete all metadata in nodePath, unless subs parameter is present.

/v1/rule[?hosts=192.168.1.x,192.168.1.x]

This api is for manage metadata's metadata access rule.

  • GET show hosts access rule config, if hosts parameter is missing, output all hosts.

  • POST|PUT update access rule, body is a json object:

    {
  "192.168.1.10":[{"path":"/clusters/cl-1", "mode":1}]
}

  • DELETE delete hosts access rule

Access Rule Guide

type AccessRule struct {
	Path string     `json:"path"`
	Mode AccessMode `json:"mode"`
}

Access rule mode

  • 0 forbidden
  • 1 read

Access rule path description

  1. Allow use wildcard(*) in path.
  2. The exact path rule has a higher priority than the wildcard path rule.
  3. The deep path rule has a higher priority than the shallow path rule.

such as：

[
   {
      "path":"/",
      "mode":0
   },
   {
      "path":"/clusters",
      "mode":1
   },
   {
      "path":"/clusters/*/env",
      "mode":0
   },
   {
      "path":"/clusters/cl-1",
      "mode":1
   }
]
  1. Root is forbidden，/cluster is read，so client can access the metadata under /cluster ，but can not access cluster's sibling node.
  2. /clusters/*/env this rule indicates that the metadata for the env folder of any subfolders under the clusters folder is forbidden to access，such as the client can not access /clusters/cl-2/env。
  3. /clusters/cl-1 exact define /clusters/cl-1 allow read，so the client can access any metadata that under /clusters/cl-1, include /clusters/cl-1/env.