dapr
/
docs
mirror of https://github.com/dapr/docs.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Merge pull request #457 from dapr/spec 

Add the Dapr /healthz API spec
This commit is contained in:
Shalabh Mohan Shrivastava 2020-03-25 11:11:47 -07:00 committed by GitHub
parent c2b672207b b4d8b1186c
commit f4ac7af97f
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 35 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

3
reference/api/error_codes.md
View File

@ -35,4 +35,5 @@ ERR_MALFORMED_REQUEST | Error with a malformed request.
ERR_DIRECT_INVOKE | Error in direct invocation. ERR_DIRECT_INVOKE | Error in direct invocation.
ERR_DESERIALIZE_HTTP_BODY | Error deserializing an HTTP request body. ERR_DESERIALIZE_HTTP_BODY | Error deserializing an HTTP request body.
ERR_SECRET_STORE_NOT_CONFIGURED| Error that no secret store is configured. ERR_SECRET_STORE_NOT_CONFIGURED| Error that no secret store is configured.
ERR_SECRET_STORE_NOT_FOUND | Error that specified secret store is not found. ERR_SECRET_STORE_NOT_FOUND | Error that specified secret store is not found.
ERR_HEALTH_NOT_READY | Error that Dapr is not ready.

33
reference/api/health_api.md Normal file
View File

@ -0,0 +1,33 @@
# Dapr health API reference
Dapr provides health checking probes that can be used as readiness or liveness of Dapr.
### Get Dapr health state
Gets the health state for Dapr.
#### HTTP Request
```http
GET http://localhost:<daprPort>/v1.0/healthz
```
#### HTTP Response Codes
Code | Description
---- | -----------
200 | dapr is healthy
500 | dapr is not healthy
#### URL Parameters
Parameter | Description
--------- | -----------
daprPort | The Dapr port.
#### Examples
```shell
curl http://localhost:3500/v1.0/healthz
```