status-im
/
consul
mirror of https://github.com/status-im/consul.git
2
0
Fork 0
Code Issues Projects Releases Wiki Activity

Attempt to describe entire response (for #2393) 

Describe fields returned by /v1/catalog/service/<service>
This commit is contained in:
Brian Shumate 2016-11-18 10:33:37 -05:00
parent 0cdc11c390
commit 3871c4810e
No known key found for this signature in database
GPG Key ID: B2E211633F870928
1 changed files with 29 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

35
website/source/docs/agent/http/catalog.html.markdown
View File

@ -261,19 +261,42 @@ It returns a JSON body like this:
```javascript ```javascript
[ [
{ {
"Address": "192.168.10.10",
"TaggedAddresses": {
"lan": "192.168.10.10",
"wan": "10.0.10.10"
},
"CreateIndex": 51,
"ModifyIndex": 51,
"Node": "foobar", "Node": "foobar",
"Address": "10.1.10.12", "ServiceAddress": "172.17.0.3",
"ServiceID": "redis", "ServiceEnableTagOverride": false,
"ServiceName": "redis", "ServiceID": "32a2a47f7992:nodea:5000",
"ServiceTags": null, "ServiceName": "foobar",
"ServiceAddress": "", "ServicePort": 5000,
"ServicePort": 8000 "ServiceTags": [
"tacos"
]
} }
] ]
``` ```
This endpoint supports blocking queries and all consistency modes. This endpoint supports blocking queries and all consistency modes.
The returned fields are as follows:
- `Address`: IP address of the Consul node on which the service is registered
- `TaggedAddresses`: List of explicit LAN and WAN IP addresses for the agent
- `CreateIndex`: Internal index value representing when the service was created
- `ModifyIndex`: Last index that modified the service
- `Node`: Node name of the Consul node on which the service is registered
- `ServiceAddress`: IP address of the service host
- `ServiceEnableTagOverride`: Whether service tags can be overridden on this service
- `ServiceID`: A unique service instance identifier comprised of UUID, hostname and port
- `ServiceName`: Name of the service
- `ServicePort`: Port number of the service
- `ServiceTags`: List of tags for the service
### <a name="catalog_node"></a> /v1/catalog/node/\<node\> ### <a name="catalog_node"></a> /v1/catalog/node/\<node\>
This endpoint is hit with a GET and returns the node's registered services. This endpoint is hit with a GET and returns the node's registered services.