获取数据 API 配置 已弃用

获取 /groups/{groupId}/apps/{appId}/data_api/config

获取应用程序的数据 API 配置。

路径参数

响应

  • 200 application/json

    正常

    隐藏响应属性 显示响应属性 对象| null
    • 残疾人 布尔 必需
    • versions array[string] 必需

      受支持的数据API版本。

      值为 v1

    • return_type 字符串 必需

      数据API和自定义端点支持的数据格式。

      值为 JSONEJSON

    • create_user_on_auth 布尔
    • run_as_user_id 字符串

      应用程序用户的帐号 ID。如果已定义,端点将始终以指定的用户身份运行。

    • run_as_user_id_script_source 字符串

      返回应用程序用户帐户 ID 的函数的字符串化源代码。如果已定义,端点将在每个请求时执行该函数,并以其 ID 为该函数所返回 ID 的对应用户的身份运行。

    • validation_method 字符串 必需

      值为 NO_VALIDATIONSECRET_AS_QUERY_PARAMVERIFY_PAYLOAD

    • secret_name 字符串

      如果 validation_method 设置为 "SECRET_AS_QUERY_PARAM""VERIFY_PAYLOAD",则这是授权请求的密钥name

    • can_evaluate 对象

      如果允许端点运行以响应传入请求,则 JSON 表达式的计算结果为 true

GET /groups/{groupId}/apps/{appId}/data_api/config
curl \
 --request GET 'https://services.cloud.mongodb.com/api/admin/v3.0/groups/{groupId}/apps/{appId}/data_api/config' \
 --header "Authorization: Bearer $ACCESS_TOKEN"
响应示例 (200)
{
  "disabled": true,
  "versions": [
    "v1"
  ],
  "return_type": "JSON",
  "create_user_on_auth": true,
  "run_as_user_id": "string",
  "run_as_user_id_script_source": "string",
  "validation_method": "NO_VALIDATION",
  "secret_name": "string",
  "can_evaluate": {}
}