Cluster API Link’s Definitions

Cluster API documentation for links

Linksdefs

GET /linksdefs

Get all the links definitions

Response JSON Object:

• [key].category (string) – The link’s category.

• [key].name (string) – The link’s name.

• [key].scheme (string) – http or https.

• [key].tag (string) – The service tag.

• [key].service (string) – Used to get the ip address.

• [key].path (string) – A fixed path.

• [key].template (string) – Used to form the URI.

• [key].uri (string) – Fixed URI.

Example response:

{
  "web": {
    "id": "web",
    "category": "project",
    "name": "Tutorial Demo",
    "scheme": "",
    "tag": "",
    "service": "",
    "path": "",
    "template": "http://${service `web`}/",
    "uri": "",
    "error": ""
  }
}

POST /linksdefs

Set the link’s definitions

Request JSON Object:

• [key].category (string) – The link’s category.

• [key].name (string) – The link’s name.

• [key].scheme (string) – http or https.

• [key].tag (string) – The service tag.

• [key].service (string) – Used to get the ip address.

• [key].path (string) – A fixed path.

• [key].template (string) – Used to form the URI.

• [key].uri (string) – Fixed URI.

Example query:

{
  "web": {
    "id": "web",
    "category": "project",
    "name": "Tutorial Demo",
    "scheme": "",
    "tag": "",
    "service": "",
    "path": "",
    "template": "http://${service `web`}/",
    "uri": "",
    "error": ""
  }
}

DELETE /linksdefs

Delete all link’s definitions

GET /linksdef/{linkID}

Returns a link definition

Parameters:

• linkID – The link ID

Response JSON Object:

• category (string) – The link’s category.

• name (string) – The link’s name.

• scheme (string) – http or https.

• tag (string) – The service tag.

• service (string) – Used to get the ip address.

• path (string) – A fixed path.

• template (string) – Used to form the URI.

• uri (string) – Fixed URI.

Example response:

{
  "id": "web",
  "category": "project",
  "name": "Tutorial Demo",
  "scheme": "",
  "tag": "",
  "service": "",
  "path": "",
  "template": "http://${service `web`}/",
  "uri": "",
  "error": ""
}

DELETE /linksdef/{linkID}

Delete a link definition

Parameters:

• linkID – The link ID