Skip to main content

Server 连接端点

Server 连接端点和参数

要详细了解对象关系以及如何在 API 中使用对象关系,请参阅 对象关系 部分。

如需详细了解数据连接,请访问 数据连接 帮助页面。

检索所有 Server 数据连接记录

要获取有关所有服务器数据连接记录的信息,请使用 get {baseURL}/v3/serverDataConnections 端点。

参数

  • view  (string):可选。可以保留此参数但不为其提供值。您可以从以下值中选择:“默认值(Default)”和“全部(Full)”。如果此参数设置为“Default”,则将返回一个减小的视图对象。未指定时,将使用“默认值(Default)”。

请求示例:cURL

curl --location --request GET 'http://localhost/webapi/v3/workflows/61db393fc565144387d451fb' \ --header 'Authorization: Bearer BearerTokenGoesHere'

检索一条 Server 数据连接记录

要检索有关特定服务器数据连接的信息,请使用 get {baseURL}/v3/serverDataConnections /{dataConnectionId} EndPoint。

参数

  • workflowCredentialType (string):必填。输入服务器数据连接ID以获取有关特定数据连接的信息。

请求示例:cURL

curl --location --request GET 'http://localhost/webapi/v3/workflows/61db393fc565144387d451fb' \ --header 'Authorization: Bearer BearerTokenGoesHere'

更新现有数据连接

要更改 数据连接的名称,请使用 put {baseURL}/v3/serverDataConnections/{dataConnectionId} Endpoint。

参数

  • workflowCredentialType (string):必填。输入服务器数据连接ID以指定要更新的数据连接。

  • updateWorkflowContract  (body):必填。输入数据连接的新名称:

    • name  (string):必填。输入数据连接的新名称。

请求示例:cURL

curl --location --request put 'http://localhost/webapi/v3/serverDataConnections/61dec3bc5436c21013530fa'\--header 'Content-Type: application/x-www-form-urlencoded'\--header 'Authorization: BearerBearerTokenGoesHere'\--data-urlencode 'name=Oracle DB Connection'

将用户添加到集合

要将用户添加到服务器数据连接,请使用 POST {baseURL}/v3/serverDataConnections//Users{dataConnectionId} 端点。

参数

  • workflowCredentialType (string):必填。输入服务器数据连接ID以指定要将用户添加到的数据连接。

  • 合同 (主体):必填。输入有关要添加到数据连接的用户的信息:

    • workflowCredentialType (string):必填。指定要添加到数据连接的用户的ID。

请求示例:cURL

curl -- location - request post 'http://localhost/webapi/v3/serverDataConnections/61dec3bc5436c221013530fa/users'\- header 'Content-Type: application/x-www-form-urlencoded'\- header 'Authorization: BearerTokenGoesHere'\- data-urlencode 'userId=61dec95f5436c22101353193'

将用户组添加到数据连接

要将用户组添加到服务器数据连接,请使用 post {baseURL}/v3/serverDataConnections//usergroups{dataConnectionId} 终结点。

参数

  • workflowCredentialType (string):必填。输入服务器数据连接ID以指定要向其添加用户组的数据连接。

  • 合同 (主体):必填。输入有关要添加到数据连接的用户组的信息:

    • workflowCredentialType (string):必填。指定要添加到数据连接的用户组的ID。

请求示例:cURL

curl --location --request post 'http://localhost/webapi/v3/serverDataConnections/61dec3bc5436c221013530fa/userGroups'\--header 'Content-Type: application/x-www-form-urlencoded'\--header 'Authorization: BearerTokenGoesHere'\--data-urlencode 'userGroupId=61decb225436c2210135336f'

从用户组中移除用户

要从服务器数据连接中删除用户,请使用 delete {baseURL}/v3/serverDataConnections//Users/{dataConnectionId}{userId} endpoint。

参数

  • workflowCredentialType (string):必填。输入服务器数据连接ID以指定要更新的数据连接。

  • workflowCredentialType (string):必填。输入要从数据连接中删除的用户标识。

请求示例:cURL

curl --location --request GET 'http://localhost/webapi/v3/workflows/61db393fc565144387d451fb' \ --header 'Authorization: Bearer BearerTokenGoesHere'

从数据连接中删除用户组

要从服务器数据连接中删除用户组,请使用 delete {baseURL}/v3/serverDataConnections//usergroups/{dataConnectionId}{userGroupId} endpoint。

参数

  • workflowCredentialType (string):必填。输入服务器数据连接ID以指定要更新的数据连接。

  • workflowCredentialType (string):必填。输入要从数据连接中删除的用户组标识。

请求示例:cURL

curl --location --request GET 'http://localhost/webapi/v3/workflows/61db393fc565144387d451fb' \ --header 'Authorization: Bearer BearerTokenGoesHere'

删除数据连接

要删除特定的服务器数据连接,请使用 delete {baseURL}/v3/serverDataConnections/{dataConnectionId} Endpoint。

参数

  • workflowCredentialType (string):必填。输入服务器数据连接ID以指定要删除的数据连接。

请求示例:cURL

curl --location --request GET 'http://localhost/webapi/v3/workflows/61db393fc565144387d451fb' \ --header 'Authorization: Bearer BearerTokenGoesHere'

对象关系

目前没有服务器数据连接的引用。修改数据连接的好处是您可以分配或取消分配对这些连接的访问权限。这有助于启用数据源的特定权限。

Postman 请求示例

获取/v3/serverDataConnections

Use the GET /v3/serverDataConnections endpoint.

输入/v3/serverDataConnections/{dataConnectionId}

Use the PUT /v3/serverDataConnections/{dataConnectionId} endpoint.

如需详细了解有关 Postman 请求的更多信息,请访问 如何使用 Postman 帮助页面。