Skip to content
Open
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 15 additions & 0 deletions daprdocs/content/en/reference/api/metadata_api.md
Original file line number Diff line number Diff line change
Expand Up @@ -40,6 +40,9 @@ The metadata API returns information related to Dapr's connection to the app. Th
### Scheduler connection details
Information related to the connection to one or more scheduler hosts.

### Workflow API runtime details
Information related to the Workflow API runtime details.

### Attributes

The metadata API allows you to store additional attribute information in the format of key-value pairs. These are ephemeral in-memory and are not persisted if a sidecar is reloaded. This information should be added at the time of a sidecar creation (for example, after the application has started).
Expand Down Expand Up @@ -86,6 +89,7 @@ httpEndpoints | [Metadata API Response HttpEndpoint](#metadataapirespon
subscriptions | [Metadata API Response Subscription](#metadataapiresponsesubscription)[] | A json encoded array of pub/sub subscriptions metadata.
appConnectionProperties| [Metadata API Response AppConnectionProperties](#metadataapiresponseappconnectionproperties) | A json encoded object of app connection properties.
scheduler | [Metadata API Response Scheduler](#metadataapiresponsescheduler) | A json encoded object of scheduler connection properties.
workflows | [Metadata API Response Workflows](#metadataapiresponseworkflows) | A json encoded object of workflows runtime properties

<a id="metadataapiresponseactor"></a>**Metadata API Response Registered Actor**

Expand Down Expand Up @@ -152,6 +156,11 @@ Name | Type | Description
---- | ---- | -----------
connected_addresses | string[] | List of strings representing the addresses of the conntected scheduler hosts.

<a id="metadataapiresponseworkflows"></a>**Metadata API Response Workflows**

Name | Type | Description
---- | ---- | -----------
connectedWorkers | integer | Number of connected workflow workers.

### Examples

Expand Down Expand Up @@ -232,6 +241,9 @@ curl http://localhost:3500/v1.0/metadata
"10.244.0.48:50006",
"10.244.0.49:50006"
]
},
"workflows": {
"connectedWorkers": 1
}
}
```
Expand Down Expand Up @@ -362,6 +374,9 @@ Get the metadata information to confirm your custom attribute was added:
"10.244.0.48:50006",
"10.244.0.49:50006"
]
},
"workflows": {
"connectedWorkers": 1
}
}
```
Expand Down
Loading