配置 API 参考

获取配置

该端点用于从存储中获取配置。

HTTP 请求

GET http://localhost:<daprPort>/v1.0/configuration/<storename>

URL 参数

查询参数

如果不提供查询参数，将返回所有配置项。 要指定需要获取的配置项的键，请使用一个或多个 key 查询参数。例如：

GET http://localhost:<daprPort>/v1.0/configuration/mystore?key=config1&key=config2

要检索所有配置项：

GET http://localhost:<daprPort>/v1.0/configuration/mystore

请求体

无

HTTP 响应

响应代码

响应体

每个配置项的键/值对的 JSON 编码值。

示例

curl -X GET 'http://localhost:3500/v1.0/configuration/mystore?key=myConfigKey' 

上述命令返回以下 JSON：

{
    "myConfigKey": {
        "value":"myConfigValue"
    }
}

订阅配置

该端点用于订阅配置更改。当配置存储中的值被更新或删除时，会发送通知。这使应用程序能够对配置更改做出反应。

HTTP 请求

GET http://localhost:<daprPort>/v1.0/configuration/<storename>/subscribe

URL 参数

查询参数

如果不提供查询参数，将订阅所有配置项。 要指定需要订阅的配置项的键，请使用一个或多个 key 查询参数。例如：

GET http://localhost:<daprPort>/v1.0/configuration/mystore/subscribe?key=config1&key=config2

要订阅所有更改：

GET http://localhost:<daprPort>/v1.0/configuration/mystore/subscribe

请求体

无

HTTP 响应

响应代码

响应体

JSON 编码值

示例

curl -X GET 'http://localhost:3500/v1.0/configuration/mystore/subscribe?key=myConfigKey' 

上述命令返回以下 JSON：

{
  "id": "<unique-id>"
}

返回的 id 参数可用于取消订阅在订阅 API 调用中提供的特定键集。应用程序应保存此参数。

取消订阅配置

该端点用于取消订阅配置更改。

HTTP 请求

GET http://localhost:<daprPort>/v1.0/configuration/<storename>/<subscription-id>/unsubscribe

URL 参数

查询参数

无

请求体

无

HTTP 响应

响应代码

响应体

{
    "ok" : true
}

示例

curl -X GET 'http://localhost:3500/v1.0-alpha1/configuration/mystore/bf3aa454-312d-403c-af95-6dec65058fa2/unsubscribe'

上述命令返回以下 JSON：

在操作成功的情况下：

{
  "ok": true
}

在操作不成功的情况下：

{
  "ok": false,
  "message": "<dapr 返回的错误信息>"
}

可选应用程序路由

提供一个路由以便 Dapr 发送配置更改

订阅配置更改时，Dapr 会在配置项更改时调用应用程序。您的应用程序可以有一个 /configuration 端点，用于接收所有已订阅键的更新。可以通过在路由中添加 /<store-name> 和 /<store-name>/<key> 来使端点更具体，以适应给定的配置存储。

HTTP 请求

POST http://localhost:<appPort>/configuration/<store-name>/<key>

URL 参数

请求体

给定订阅 id 的配置项列表。配置项可以有一个与之关联的版本，该版本在通知中返回。

{
    "id": "<subscription-id>",
    "items": [
        {
            "key": "<key-of-configuration-item>",
            "value": "<new-value>",
            "version": "<version-of-item>"
        }
    ]
}

示例

{
    "id": "bf3aa454-312d-403c-af95-6dec65058fa2",
    "items": [
        {
            "key": "config-1",
            "value": "abcdefgh",
            "version": "1.1"
        }
    ]
}

下一步

• 配置 API 概述
• 如何：从存储管理配置