mirror of https://github.com/dapr/docs.git
720 lines
17 KiB
Markdown
720 lines
17 KiB
Markdown
# Dapr actors API reference
|
|
|
|
Dapr provides native, cross-platform and cross-language virtual actor capabilities.
|
|
Besides the language specific Dapr SDKs, a developer can invoke an actor using the API endpoints below.
|
|
|
|
## Endpoints
|
|
|
|
- [Service Code Calling to Dapr](#specifications-for-user-service-code-calling-to-dapr)
|
|
- [Invoke Actor Method](#invoke-actor-method)
|
|
- [Save Actor State](#save-actor-state)
|
|
- [Delete Actor State](#delete-actor-state)
|
|
- [Actor State Transactions](#actor-state-transactions)
|
|
- [Get Actor State](#get-actor-state)
|
|
- [Create Actor Reminder](#create-actor-reminder)
|
|
- [Get Actor Reminder](#get-actor-reminder)
|
|
- [Delete Actor Reminder](#delete-actor-reminder)
|
|
- [Create Actor Timer](#create-actor-timer)
|
|
- [Delete Actor Timer](#delete-actor-timer)
|
|
- [Dapr Calling to Service Code](#specifications-for-dapr-calling-to-user-service-code)
|
|
- [Get Registered Actors](#get-registered-actors)
|
|
- [Deactivate Actor](#deactivate-actor)
|
|
- [Invoke Actor Method](#invoke-actor-method-1)
|
|
- [Invoke Reminder](#invoke-reminder)
|
|
- [Invoke Timer](#invoke-timer)
|
|
- [Health Checks](#health-check)
|
|
- [Querying Actor State Externally](#querying-actor-state-externally)
|
|
|
|
## User service code calling dapr
|
|
|
|
### Invoke actor method
|
|
|
|
Invoke an actor method through Dapr.
|
|
|
|
#### HTTP Request
|
|
|
|
```http
|
|
POST/GET/PUT/DELETE http://localhost:<daprPort>/v1.0/actors/<actorType>/<actorId>/method/<method>
|
|
```
|
|
|
|
#### HTTP Response Codes
|
|
|
|
Code | Description
|
|
---- | -----------
|
|
200 | Request successful
|
|
500 | Request failed
|
|
404 | Actor not found
|
|
|
|
#### URL Parameters
|
|
|
|
Parameter | Description
|
|
--------- | -----------
|
|
daprPort | The Dapr port.
|
|
actorType | The actor type.
|
|
actorId | The actor ID.
|
|
method | The name of the method to invoke.
|
|
|
|
#### Examples
|
|
|
|
Example of invoking a method on an actor:
|
|
|
|
```shell
|
|
curl -X POST http://localhost:3500/v1.0/actors/stormtrooper/50/method/shoot \
|
|
-H "Content-Type: application/json"
|
|
```
|
|
|
|
Example of invoking a method on an actor that takes parameters: You can provided the method parameters and values in the body of the request, for example in curl using -d "{\"param\":\"value\"}"
|
|
|
|
|
|
```shell
|
|
curl -X POST http://localhost:3500/v1.0/actors/x-wing/33/method/fly \
|
|
-H "Content-Type: application/json"
|
|
-d '{
|
|
"destination": "Hoth"
|
|
}'
|
|
```
|
|
or
|
|
|
|
```shell
|
|
curl -X POST http://localhost:3500/v1.0/actors/x-wing/33/method/fly \
|
|
-H "Content-Type: application/json"
|
|
-d "{\"destination\":\"Hoth\"}"
|
|
```
|
|
The response (the method return) from the remote endpoint is returned in the request body.
|
|
|
|
### Delete actor state
|
|
|
|
Deletes the state key of an actor
|
|
|
|
#### HTTP Request
|
|
|
|
```http
|
|
DELETE http://localhost:<daprPort>/v1.0/actors/<actorType>/<actorId>/state/<key>
|
|
```
|
|
|
|
#### HTTP Response Codes
|
|
|
|
Code | Description
|
|
---- | -----------
|
|
200 | Request successful
|
|
500 | Request failed
|
|
404 | Actor not found
|
|
|
|
#### URL Parameters
|
|
|
|
Parameter | Description
|
|
--------- | -----------
|
|
daprPort | The Dapr port.
|
|
actorType | The actor type.
|
|
actorId | The actor ID.
|
|
key | the key of the state to delete
|
|
|
|
### Save actor state
|
|
|
|
Persists the changed to the state for an actor
|
|
|
|
#### HTTP Request
|
|
|
|
```http
|
|
POST/PUT http://localhost:<daprPort>/v1.0/actors/<actorType>/<actorId>/state
|
|
```
|
|
|
|
#### HTTP Response Codes
|
|
|
|
Code | Description
|
|
---- | -----------
|
|
201 | Request successful
|
|
500 | Request failed
|
|
404 | Actor not found
|
|
|
|
#### URL Parameters
|
|
|
|
Parameter | Description
|
|
--------- | -----------
|
|
daprPort | The Dapr port.
|
|
actorType | The actor type.
|
|
actorId | The actor ID.
|
|
|
|
Value of the key is passed as request body:
|
|
```shell
|
|
{
|
|
"key": "value"
|
|
}
|
|
```
|
|
|
|
### Actor state transactions
|
|
|
|
Persists the changed to the state for an actor as a multi-item transaction.
|
|
|
|
***Note that this operation is dependant on a using state store component that supports multi-item transactions.***
|
|
|
|
#### HTTP Request
|
|
|
|
```http
|
|
POST/PUT http://localhost:<daprPort>/v1.0/actors/<actorType>/<actorId>/state
|
|
```
|
|
|
|
#### HTTP Response Codes
|
|
|
|
Code | Description
|
|
---- | -----------
|
|
201 | Request successful
|
|
500 | Request failed
|
|
404 | Actor not found
|
|
|
|
#### URL Parameters
|
|
|
|
Parameter | Description
|
|
--------- | -----------
|
|
daprPort | The Dapr port.
|
|
actorType | The actor type.
|
|
actorId | The actor ID.
|
|
|
|
#### Examples
|
|
|
|
```shell
|
|
curl -X POST http://localhost:3500/v1.0/actors/stormtrooper/50/state \
|
|
-H "Content-Type: application/json"
|
|
-d '[
|
|
{
|
|
"operation": "upsert",
|
|
"request": {
|
|
"key": "key1",
|
|
"value": "myData"
|
|
}
|
|
},
|
|
{
|
|
"operation": "delete",
|
|
"request": {
|
|
"key": "key2"
|
|
}
|
|
}
|
|
]'
|
|
```
|
|
|
|
### Get actor state
|
|
|
|
Gets the state for an actor using a specified key.
|
|
|
|
#### HTTP Request
|
|
|
|
```http
|
|
GET http://localhost:<daprPort>/v1.0/actors/<actorType>/<actorId>/state/<key>
|
|
```
|
|
|
|
#### HTTP Response Codes
|
|
|
|
Code | Description
|
|
---- | -----------
|
|
200 | Request successful
|
|
500 | Request failed
|
|
404 | Actor not found
|
|
|
|
#### URL Parameters
|
|
|
|
Parameter | Description
|
|
--------- | -----------
|
|
daprPort | The Dapr port.
|
|
actorType | The actor type.
|
|
actorId | The actor ID.
|
|
key | The key for the state value.
|
|
|
|
#### Examples
|
|
|
|
```shell
|
|
curl http://localhost:3500/v1.0/actors/stormtrooper/50/state/location \
|
|
-H "Content-Type: application/json"
|
|
```
|
|
|
|
The above command returns the state:
|
|
|
|
```json
|
|
{
|
|
"location": "Alderaan"
|
|
}
|
|
```
|
|
|
|
### Create actor reminder
|
|
|
|
Creates a persistent reminder for an actor.
|
|
|
|
#### HTTP Request
|
|
|
|
```http
|
|
POST,PUT http://localhost:<daprPort>/v1.0/actors/<actorType>/<actorId>/reminders/<name>
|
|
```
|
|
|
|
Body:
|
|
|
|
The following specifies a `dueTime` of 3 seconds and a period of 7 seconds.
|
|
```json
|
|
{
|
|
"dueTime":"0h0m3s0ms",
|
|
"period":"0h0m7s0ms"
|
|
}
|
|
```
|
|
|
|
A `dueTime` of 0 means to fire immediately. The following body means to fire immediately, then every 9 seconds.
|
|
```json
|
|
{
|
|
"dueTime":"0h0m0s0ms",
|
|
"period":"0h0m9s0ms"
|
|
}
|
|
```
|
|
|
|
To configure the reminder to fire once only, the period should be set to empty string. The following specifies a `dueTime` of 3 seconds with a period of empty string, which means the reminder will fire in 3 seconds and then never fire again.
|
|
```json
|
|
{
|
|
"dueTime":"0h0m3s0ms",
|
|
"period":""
|
|
}
|
|
```
|
|
|
|
#### HTTP Response Codes
|
|
|
|
Code | Description
|
|
---- | -----------
|
|
200 | Request successful
|
|
500 | Request failed
|
|
404 | Actor not found
|
|
|
|
#### URL Parameters
|
|
|
|
Parameter | Description
|
|
--------- | -----------
|
|
daprPort | The Dapr port.
|
|
actorType | The actor type.
|
|
actorId | The actor ID.
|
|
name | The name of the reminder to create.
|
|
|
|
#### Examples
|
|
|
|
```shell
|
|
curl http://localhost:3500/v1.0/actors/stormtrooper/50/reminders/checkRebels \
|
|
-H "Content-Type: application/json"
|
|
-d '{
|
|
"data": "someData",
|
|
"dueTime": "1m",
|
|
"period": "20s"
|
|
}'
|
|
```
|
|
|
|
### Get actor reminder
|
|
|
|
Gets a reminder for an actor.
|
|
|
|
#### HTTP Request
|
|
|
|
```http
|
|
GET http://localhost:<daprPort>/v1.0/actors/<actorType>/<actorId>/reminders/<name>
|
|
```
|
|
|
|
#### HTTP Response Codes
|
|
|
|
Code | Description
|
|
---- | -----------
|
|
200 | Request successful
|
|
500 | Request failed
|
|
404 | Actor not found
|
|
|
|
#### URL Parameters
|
|
|
|
Parameter | Description
|
|
--------- | -----------
|
|
daprPort | The Dapr port.
|
|
actorType | The actor type.
|
|
actorId | The actor ID.
|
|
name | The name of the reminder to get.
|
|
|
|
#### Examples
|
|
|
|
```shell
|
|
curl http://localhost:3500/v1.0/actors/stormtrooper/50/reminders/checkRebels \
|
|
"Content-Type: application/json"
|
|
```
|
|
|
|
The above command returns the reminder:
|
|
|
|
```json
|
|
{
|
|
"dueTime": "1s",
|
|
"period": "5s",
|
|
"data": "0",
|
|
}
|
|
```
|
|
|
|
### Delete actor reminder
|
|
|
|
Deletes a reminder for an actor.
|
|
|
|
#### HTTP Request
|
|
|
|
```http
|
|
DELETE http://localhost:<daprPort>/v1.0/actors/<actorType>/<actorId>/reminders/<name>
|
|
```
|
|
|
|
#### HTTP Response Codes
|
|
|
|
Code | Description
|
|
---- | -----------
|
|
200 | Request successful
|
|
500 | Request failed
|
|
404 | Actor not found
|
|
|
|
#### URL Parameters
|
|
|
|
Parameter | Description
|
|
--------- | -----------
|
|
daprPort | The Dapr port.
|
|
actorType | The actor type.
|
|
actorId | The actor ID.
|
|
name | The name of the reminder to delete.
|
|
|
|
#### Examples
|
|
|
|
```shell
|
|
curl http://localhost:3500/v1.0/actors/stormtrooper/50/reminders/checkRebels \
|
|
-X "Content-Type: application/json"
|
|
```
|
|
|
|
### Create actor timer
|
|
|
|
Creates a timer for an actor.
|
|
|
|
#### HTTP Request
|
|
|
|
```http
|
|
POST,PUT http://localhost:<daprPort>/v1.0/actors/<actorType>/<actorId>/timers/<name>
|
|
```
|
|
|
|
Body:
|
|
|
|
The following specifies a `dueTime` of 3 seconds and a period of 7 seconds.
|
|
```json
|
|
{
|
|
"dueTime":"0h0m3s0ms",
|
|
"period":"0h0m7s0ms"
|
|
}
|
|
```
|
|
|
|
A `dueTime` of 0 means to fire immediately. The following body means to fire immediately, then every 9 seconds.
|
|
```json
|
|
{
|
|
"dueTime":"0h0m0s0ms",
|
|
"period":"0h0m9s0ms"
|
|
}
|
|
```
|
|
|
|
#### HTTP Response Codes
|
|
|
|
Code | Description
|
|
---- | -----------
|
|
200 | Request successful
|
|
500 | Request failed
|
|
404 | Actor not found
|
|
|
|
#### URL Parameters
|
|
|
|
Parameter | Description
|
|
--------- | -----------
|
|
daprPort | The Dapr port.
|
|
actorType | The actor type.
|
|
actorId | The actor ID.
|
|
name | The name of the timer to create.
|
|
|
|
#### Examples
|
|
|
|
```shell
|
|
curl http://localhost:3500/v1.0/actors/stormtrooper/50/timers/checkRebels \
|
|
-H "Content-Type: application/json"
|
|
-d '{
|
|
"data": "someData",
|
|
"dueTime": "1m",
|
|
"period": "20s",
|
|
"callback": "myEventHandler"
|
|
}'
|
|
```
|
|
|
|
### Delete actor timer
|
|
|
|
Deletes a timer for an actor.
|
|
|
|
#### HTTP Request
|
|
|
|
```http
|
|
DELETE http://localhost:<daprPort>/v1.0/actors/<actorType>/<actorId>/timers/<name>
|
|
```
|
|
|
|
#### HTTP Response Codes
|
|
|
|
Code | Description
|
|
---- | -----------
|
|
200 | Request successful
|
|
500 | Request failed
|
|
404 | Actor not found
|
|
|
|
#### URL Parameters
|
|
|
|
Parameter | Description
|
|
--------- | -----------
|
|
daprPort | The Dapr port.
|
|
actorType | The actor type.
|
|
actorId | The actor ID.
|
|
name | The name of the timer to delete.
|
|
|
|
```shell
|
|
curl http://localhost:3500/v1.0/actors/stormtrooper/50/timers/checkRebels \
|
|
-X "Content-Type: application/json"
|
|
```
|
|
|
|
## Dapr calling to user service code
|
|
|
|
### Get registered actors
|
|
|
|
Gets the registered actors types for this app and the Dapr actor configuration settings.
|
|
|
|
#### HTTP Request
|
|
|
|
```http
|
|
GET http://localhost:<appPort>/dapr/config
|
|
```
|
|
|
|
#### HTTP Response Codes
|
|
|
|
Code | Description
|
|
---- | -----------
|
|
200 | Request successful
|
|
500 | Request failed
|
|
|
|
#### URL Parameters
|
|
|
|
Parameter | Description
|
|
--------- | -----------
|
|
appPort | The application port.
|
|
|
|
#### Examples
|
|
|
|
Example of getting the registered actors:
|
|
|
|
```shell
|
|
curl -X GET http://localhost:3000/dapr/config \
|
|
-H "Content-Type: application/json"
|
|
```
|
|
|
|
The above command returns the config (all fields are optional):
|
|
|
|
|
|
Parameter | Description
|
|
----------|------------
|
|
entities | The actor types this app supports.
|
|
actorIdleTimeout | Specifies how long to wait before deactivating an idle actor. An actor is idle if no actor method calls and no reminders have fired on it.
|
|
actorScanInterval | A duration which specifies how often to scan for actors to deactivate idle actors. Actors that have been idle longer than the actorIdleTimeout will be deactivated.
|
|
drainOngoingCallTimeout | A duration used when in the process of draining rebalanced actors. This specifies how long to wait for the current active actor method to finish. If there is no current actor method call, this is ignored.
|
|
drainRebalancedActors | A bool. If true, Dapr will wait for `drainOngoingCallTimeout` to allow a current actor call to complete before trying to deactivate an actor. If false, do not wait.
|
|
|
|
```json
|
|
{
|
|
"entities":["actorType1", "actorType2"],
|
|
"actorIdleTimeout": "1h",
|
|
"actorScanInterval": "30s",
|
|
"drainOngoingCallTimeout": "30s",
|
|
"drainRebalancedActors": true
|
|
}
|
|
```
|
|
|
|
### Deactivate actor
|
|
|
|
Deactivates an actor by persisting the instance of the actor to the state store with the specified actorId
|
|
|
|
#### HTTP Request
|
|
|
|
```http
|
|
DELETE http://localhost:<appPort>/actors/<actorType>/<actorId>
|
|
```
|
|
|
|
#### HTTP Response Codes
|
|
|
|
Code | Description
|
|
---- | -----------
|
|
200 | Request successful
|
|
500 | Request failed
|
|
404 | Actor not found
|
|
|
|
#### URL Parameters
|
|
|
|
Parameter | Description
|
|
--------- | -----------
|
|
appPort | The application port.
|
|
actorType | The actor type.
|
|
actorId | The actor ID.
|
|
|
|
#### Examples
|
|
|
|
Example of deactivating an actor: The example deactives the actor type stormtrooper that has actorId of 50
|
|
|
|
```shell
|
|
curl -X DELETE http://localhost:3000/actors/stormtrooper/50 \
|
|
-H "Content-Type: application/json"
|
|
```
|
|
|
|
### Invoke actor method
|
|
|
|
Invokes a method for an actor with the specified methodName where parameters to the method are passed in the body of the request message and return values are provided in the body of the response message. If the actor is not already running, the app side should [activate](#activating-an-actor) it.
|
|
|
|
#### HTTP Request
|
|
|
|
```http
|
|
PUT http://localhost:<appPort>/actors/<actorType>/<actorId>/method/<methodName>
|
|
```
|
|
|
|
#### HTTP Response Codes
|
|
|
|
Code | Description
|
|
---- | -----------
|
|
200 | Request successful
|
|
500 | Request failed
|
|
404 | Actor not found
|
|
|
|
#### URL Parameters
|
|
|
|
Parameter | Description
|
|
--------- | -----------
|
|
appPort | The application port.
|
|
actorType | The actor type.
|
|
actorId | The actor ID.
|
|
methodName | The name of the method to invoke.
|
|
|
|
#### Examples
|
|
|
|
Example of invoking a method for an actor: The example calls the performAction method on the actor type stormtrooper that has actorId of 50
|
|
|
|
```shell
|
|
curl -X POST http://localhost:3000/actors/stormtrooper/50/method/performAction \
|
|
-H "Content-Type: application/json"
|
|
```
|
|
|
|
### Invoke reminder
|
|
|
|
Invokes a reminder for an actor with the specified reminderName. If the actor is not already running, the app side should [activate](#activating-an-actor) it.
|
|
|
|
#### HTTP Request
|
|
|
|
```http
|
|
PUT http://localhost:<appPort>/actors/<actorType>/<actorId>/method/remind/<reminderName>
|
|
```
|
|
|
|
#### HTTP Response Codes
|
|
|
|
Code | Description
|
|
---- | -----------
|
|
200 | Request successful
|
|
500 | Request failed
|
|
404 | Actor not found
|
|
|
|
#### URL Parameters
|
|
|
|
Parameter | Description
|
|
--------- | -----------
|
|
appPort | The application port.
|
|
actorType | The actor type.
|
|
actorId | The actor ID.
|
|
reminderName | The name of the reminder to invoke.
|
|
|
|
#### Examples
|
|
|
|
Example of invoking a reminder for an actor: The example calls the checkRebels reminder method on the actor type stormtrooper that has actorId of 50
|
|
|
|
```shell
|
|
curl -X POST http://localhost:3000/actors/stormtrooper/50/method/remind/checkRebels \
|
|
-H "Content-Type: application/json"
|
|
```
|
|
|
|
### Invoke timer
|
|
|
|
Invokes a timer for an actor rwith the specified timerName. If the actor is not already running, the app side should [activate](#activating-an-actor) it.
|
|
|
|
#### HTTP Request
|
|
|
|
```http
|
|
PUT http://localhost:<appPort>/actors/<actorType>/<actorId>/method/timer/<timerName>
|
|
```
|
|
|
|
#### HTTP Response Codes
|
|
|
|
Code | Description
|
|
---- | -----------
|
|
200 | Request successful
|
|
500 | Request failed
|
|
404 | Actor not found
|
|
|
|
#### URL Parameters
|
|
|
|
Parameter | Description
|
|
--------- | -----------
|
|
appPort | The application port.
|
|
actorType | The actor type.
|
|
actorId | The actor ID.
|
|
timerName | The name of the timer to invoke.
|
|
|
|
#### Examples
|
|
|
|
Example of invoking a timer for an actor: The example calls the checkRebels timer method on the actor type stormtrooper that has actorId of 50
|
|
|
|
```shell
|
|
curl -X POST http://localhost:3000/actors/stormtrooper/50/method/timer/checkRebels \
|
|
-H "Content-Type: application/json"
|
|
```
|
|
|
|
### Health check
|
|
|
|
Probes the application for a response to signal to Dapr that the app is healthy and running.
|
|
Any other response status code other than `200` will be considered as an unhealthy response.
|
|
|
|
A response body is not required.
|
|
|
|
#### HTTP Request
|
|
|
|
```http
|
|
GET http://localhost:<appPort>/healthz
|
|
```
|
|
|
|
#### HTTP Response Codes
|
|
|
|
Code | Description
|
|
---- | -----------
|
|
200 | App is healthy
|
|
|
|
#### URL Parameters
|
|
|
|
Parameter | Description
|
|
--------- | -----------
|
|
appPort | The application port.
|
|
|
|
#### Examples
|
|
|
|
Example of getting a health check response from the app:
|
|
|
|
```shell
|
|
curl -X GET http://localhost:3000/healthz \
|
|
```
|
|
|
|
## Activating an Actor
|
|
|
|
Conceptually, activating an actor means creating the actor's object and adding the actor to a tracking table. Here is an [example](https://github.com/dapr/dotnet-sdk/blob/6c271262231c41b21f3ca866eb0d55f7ce8b7dbc/src/Dapr.Actors/Runtime/ActorManager.cs#L199) from the .NET SDK.
|
|
|
|
## Querying actor state externally
|
|
|
|
In order to enable visibility into the state of an actor and allow for complex scenarios such as state aggregation, Dapr saves actor state in external state stores such as databases. As such, it is possible to query for an actor state externally by composing the correct key or query.
|
|
|
|
The state namespace created by Dapr for actors is composed of the following items:
|
|
|
|
* App ID - Represents the unique ID given to the Dapr application.
|
|
* Actor Type - Represents the type of the actor.
|
|
* Actor ID - Represents the unique ID of the actor instance for an actor type.
|
|
* Key - A key for the specific state value. An actor ID can hold multiple state keys.
|
|
|
|
The following example shows how to construct a key for the state of an actor instance under the `myapp` App ID namespace:
|
|
`myapp-cat-hobbit-food`
|
|
|
|
In the example above, we are getting the value for the state key `food`, for the actor ID `hobbit` with an actor type of `cat`, under the App ID namespace of `myapp`.
|