DCM 端点

DCM 端点和属性

DCM 端点分为两组：面向用户的 DCM 端点和面向管理员的 DCM 端点。所有 DCM 端点都要求在 Server 上配置 TLS。

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

如需详细了解数据连接，请访问 DCM - Server 和数据连接管理器：Server UI 帮助页面。DCM - Server数据连接管理器：Server UI

什么是 DCM 连接？

DCM 连接由其自身参数和两种子对象组成：DataSource（始终只有一个）和 Credentials（在常见情况下可能为零、一或两个。在极少数情况下，数量可能更多，具体取决于连接器）。每个 Credential 在连接中具有不同的 credRole。DCM API 将连接作为包含 DataSource 和 Credentials 的整体对象进行处理。

连接器与 DCM 连接有何关系？

连接器是一段代码，使 Alteryx 能够与外部数据源通信。每个连接器都需要一组特定参数来实现通信。这些参数统称为 DCM 连接。连接器支持的确切参数通过 DCM 架构进行定义并传达给 DCM，该架构通过其 schemaName 实现唯一标识。

单个连接器可以支持多种身份验证方法或通信协议，每种方法各自对应一组参数。因此，连接器可注册多个具有不同 schemaName 值的 DCM 架构。

连接架构的结构与其他 DCM 对象相同，由 DataSource 架构和 Credential 架构组成。这意味着，Connection.schemaName 还决定了在为该特定连接架构创建的 Connection 对象中，必须使用哪些 DataSource.schemaName 和 Credential.schemaNames。

SQL Server 的 ODBC 连接器使用的 schemaNames

Microsoft SQL Server ODBC 非 DSN 连接（Azure Active Directory 集成）
schemaName: "database-odbc-mssql-adintegrated"
- dataSource.schemaName: "database-odbc-mssql"
- credentials:无
Microsoft SQL Server ODBC 非 DSN 连接（Azure 托管服务标识）
schemaName: "database-odbc-mssql-admsi"
- dataSource.schemaName: "database-odbc-mssql"
- credentials:
  credRole: "main", schemaName: "azure_managed_identity"
Microsoft SQL Server ODBC 非 DSN 连接（Azure Active Directory 密码）
schemaName: "database-odbc-mssql-adpwd"
- dataSource.schemaName: "database-odbc-mssql"
- credentials:
  credRole: "main", schemaName: "username_password"
Microsoft SQL Server ODBC 非 DSN 连接（Azure Active Directory 服务主体）
schemaName: "database-odbc-mssql-adsp"
- dataSource.schemaName: "database-odbc-mssql"
- credentials:
  credRole: "oauthApplication", schemaName: "database-odbc-mssql-adsp"
Microsoft SQL Server ODBC 非 DSN 连接（仅限用户名）
schemaName: "database-odbc-mssql-nopwd"
- dataSource.schemaName: "database-odbc-mssql"
- credentials:
  credRole: "main", schemaName: "username"
Microsoft SQL Server ODBC 非 DSN 连接 (Azure AD)
schemaName: "database-odbc-mssql-oauth-azure-ayxapp"
- dataSource.schemaName: "database-odbc-mssql"
- credentials:
  credRole: "oauthTokens", schemaName: "database-ms-oauth-azure-ayxapp-tokens"
Microsoft SQL Server ODBC 非 DSN 连接（Azure AD - 专用）
schemaName: "database-odbc-mssql-oauth-azure"
- dataSource.schemaName: "database-odbc-mssql"
- credentials:
  - credRole: "oauthApplication", schemaName: "database-ms-oauth-azure-application"
  - credRole: "oauthTokens", schemaName: "database-ms-oauth-azure-tokens"
Microsoft SQL Server ODBC 非 DSN 连接（通用 OAuth2）
schemaName: "database-odbc-mssql-oauth-generic-configurable"
- dataSource.schemaName: "database-odbc-mssql"
- credentials:
  - credRole: "oauthApplication", schemaName: "generic-configurable-oauth-application"
  - credRole: "oauthTokens", schemaName: "generic-configurable-oauth-tokens"
Microsoft SQL Server ODBC 非 DSN 连接（Windows 身份验证）
schemaName: "database-odbc-mssql-winauth"
- dataSource.schemaName: "database-odbc-mssql"
- credentials:无
Microsoft SQL Server ODBC 非 DSN 连接（用户名 - 密码）
schemaName: "database-odbc-mssql"
- dataSource.schemaName: "database-odbc-mssql"
- credentials:
  credRole: "main", schemaName: "username_password"
Microsoft SQL Server ODBC（无凭证）
schemaName: "database-odbc-dsn-mssql-nocreds"
- dataSource.schemaName: "database-odbc-dsn-mssql"
- credentials:无
Microsoft SQL Server ODBC（仅限用户名）
schemaName: "database-odbc-dsn-mssql-nopwd"
- dataSource.schemaName: "database-odbc-dsn-mssql"
- credentials:
  credRole: "main", schemaName: "username"
Microsoft SQL Server ODBC (Azure AD)
schemaName: "database-odbc-dsn-mssql-oauth-azure-ayxapp"
- dataSource.schemaName: "database-odbc-dsn-mssql"
- credentials:
  credRole: "oauthTokens", schemaName: "database-ms-oauth-azure-ayxapp-tokens"
Microsoft SQL Server ODBC（Azure AD - 专用）
schemaName: "database-odbc-dsn-mssql-oauth-azure"
- dataSource.schemaName: "database-odbc-dsn-mssql"
- credentials:
  - credRole: "oauthApplication", schemaName: "database-hana-oauth-azure-application"
  - credRole: "oauthTokens", schemaName: "database-hana-oauth-azure-tokens"
Microsoft SQL Server ODBC（通用 OAuth2）
schemaName: "database-odbc-dsn-mssql-oauth-generic-configurable"
- dataSource.schemaName: "database-odbc-dsn-mssql"
- credentials:
  - credRole: "oauthApplication", schemaName: "generic-configurable-oauth-application"
  - credRole: "oauthTokens", schemaName: "generic-configurable-oauth-tokens"
Microsoft SQL Server ODBC（用户名 - 密码）
schemaName: "database-odbc-dsn-mssql"
- dataSource.schemaName: "database-odbc-dsn-mssql"
- credentials:
  credRole: "main", schemaName: "username_password"

面向用户的 DCM 端点

具有 API 访问权限的用户可以使用这些端点：

注意

所有 API 端点都会返回单独的用户数据（每个用户只能查看和管理自己的连接）。
所有示例均为 PowerShell 脚本。

获取连接

要获取连接记录，请使用 GET {baseURL}/v3/dcm/connections/{id} 端点。该端点会返回有关连接的所有信息，包括相关的数据源、凭证以及共享信息。

属性

id (string)：必填。输入您想要获取其信息的 DCM 连接的 ID。

请求示例：cURL

curl --location --request GET 'https://localhost/webapi/v3/dcm/connections/d8cc5fca-86cc-4e7e-93a3-d500cca9a3f3' `
  --header 'Authorization: Bearer BearerTokenGoesHere'

获取工作流中引用的连接

要获取工作流中引用的连接记录，请使用 GET {baseURL}/v3/dcm/connections/lookup 端点。该端点会返回有关连接的所有信息，包括相关的数据源、凭证以及共享信息。

注意

此端点中使用的 ConnectionID 与其他 DCM 端点中使用的 ID 不同。ID 用于引用各种 DCM 对象，而 ConnectionID 仅在工作流中用于引用特定用户的 DCM 连接。

属性

connectionId (string)：必填。输入您想要获取其信息的 DCM ConnectionID。

请求示例：cURL

curl --location --request GET 'https://localhost/webapi/v3/dcm/connections/lookup?connectionId=d8cc5fca-86cc-4e7e-93a3-d500cca9a3f3' `
  --header 'Authorization: Bearer BearerTokenGoesHere'

共享连接

要与指定的用户或用户组共享用于 Server 执行的连接，请使用 PUT {baseURL}/v3/dcm/connections/{id}/sharing/execution 端点。

注意

由于这是一个 PUT 端点，因此它会覆盖现有的共享，而不是向现有列表添加其他用户或用户组。提供的用户和用户组列表不能为空。要移除现有共享，请使用 DELETE 端点。

属性

id (string)：必填。输入要与其他用户或用户组共享的 DCM 连接 ID。
sharingContract (body)：必填。要更新执行共享，必须指定 sharingContract 参数。两个数组都是必需的，但只有一个数组可以留空。
- userIds (string array)：输入要与之共享连接的所有用户 ID 列表。如果没有用户可以共享，则保留空数组（仅限 userGroups）。
- userGroupIds (string array)：输入要与之共享连接的所有用户组 ID 列表。如果没有用户组可以共享，则保留空数组（仅限 users）。

请求示例：cURL

curl --location --request PUT 'https://localhost/webapi/v3/dcm/connections/d8cc5fca-86cc-4e7e-93a3-d500cca9a3f3/sharing/execution' `
  --header 'Authorization: Bearer BearerTokenGoesHere' `
  --header 'Content-Type: application/json' `
  --data '{
    "userIds": [
      "61d57bea3c15317e1a48205b",
      "61d564361d6d5da7ad461a32"
    ],
    "userGroupIds": [
      "d5da7ad4"
    ]
  }'

取消共享连接

要取消共享连接，请使用 DELETE {baseURL}/v3/dcm/connections/{id}/sharing/execution 端点。

属性

id (string)：必填。输入要取消与所有用户和用户组共享的 DCM 连接 ID。

请求示例：cURL

curl --location --request DELETE 'https://localhost/webapi/v3/dcm/connections/d8cc5fca-86cc-4e7e-93a3-d500cca9a3f3/sharing/execution' `
  --header 'Authorization: Bearer BearerTokenGoesHere'

创建或更新连接

要创建或更新连接，请使用 POST {baseURL}/v3/dcm/connections 端点。

单个端点同时提供创建和更新功能，根据请求中是否包含对象 ID 进行区分。目前不支持在创建新连接时重复使用现有数据源或凭证。

属性

id (string)：可选。如果要更新现有连接，请输入连接 ID。如果要创建新连接，请跳过。
name (string)：必填。输入连接的名称。
注意
DCM 连接中包含多个“name”：
- Connection.name：连接本身的名称。管理员通过 API 与此名称进行交互。
- Connection.dataSource.object.name：UI 中“数据源”选项卡上显示的数据源名称。
- Connection.credentials.<credRole>.object.name：UI 中“凭证”选项卡上显示的凭证名称。
如需了解详情，请参阅什么是 DCM 连接？部分。
schemaName (string)：必填。这是 DCM 架构的标识符，用于在 DCM UI 中渲染和验证相关参数。每个连接器都定义了一组支持的 DCM 架构。所选的连接架构还指定连接的 DataSource 和 Credential 部分必须使用哪些数据源和凭证架构。如需了解详情，请参阅什么是 DCM 连接？和连接器与 DCM 连接有何关系？
allowInSdks (boolean)：可选。使 Python SDK 工具可以访问该连接。
parameters (object)：必填。此属性包含特定于您所连接的架构和技术的配置详细信息。
注意
DCM 连接结构中有多个不同的 parameters 对象，每个对象在不同的上下文中使用：
- Connection.parameters：用于整体连接（目前在 UI 中尚不可见，即将推出）。
- Connection.dataSource.object.parameters：用于连接的数据源部分。
- Connection.credentials.<credRole>.object.parameters：用于每个凭证角色。
- Connection.credentials.<credRole>.object.secrets.<secretType>.parameters：用于凭证密钥，按密钥类型划分。
每个 parameters 对象都有其自己的结构和必填字段，具体取决于连接中该部分定义的技术和 schemaName。它们彼此独立，并且可以（且通常会）包含不同的字段。
parameters 属性为必填项，但如果给定架构不需要参数，则可将其作为空对象 ({}) 提供。
提示：
要确定任何 parameters 对象的正确字段：
1. 在 Alteryx Server UI 中为您的目标技术创建 DCM 连接。
2. 通过 API 查询连接：GET /v3/dcm/connections/{id}
3. 查看响应中每个 parameters 对象返回的结构和字段。
这是发现特定数据源或凭证所需字段和可用字段的最可靠方法。
由于 parameters 字段依赖于具体的数据源和凭证，因此在本文档中为每项技术提供全面示例并不可行。请使用上述工作流程来获取特定于源的最新示例。
dataSource (object)：必填。用于连接的数据源，描述数据源实例主机和其他参数，如 DCM UI 中所示。
- object (object)：必填。
  - id (string)：如果要更新现有连接，请输入数据源 ID。如果要创建新连接，请跳过。目前无法在创建新连接时使用现有数据源。
  - name (string)：必填。输入数据源的名称。
  - schemaName (string)：必填。输入所选数据源的架构名称。有关详细说明，请参阅 Connection.schemaName 属性。
  - parameters (object)：必填。连接的 DataSource 部分的参数。如需了解详情，请参阅 Connection.parameters 属性。如无参数需求，请提供空对象 {}。
credentials (object)：必填。<credRole>: object 的键值对。<credRole> 由所选 DCM 架构定义。object 仅包含一个名为“object”的属性，该属性下包含所有 Credential 属性。某些连接可能无需凭证，而其他连接可能包含多个嵌套的 Credential 对象。
从下面的示例中，您可以看到 SQLServer (MSSQL) 用户名-密码身份验证使用了主要的 <credRole>。使用身份池身份验证的 Reshift 连接和使用 OAuth 身份验证的 Snowflake 使用 oauthApplication 和 oauthTokens <credRoles> 作为其凭证。
如需了解详情，请参阅什么是 DCM 连接？和连接器与 DCM 连接有何关系？
- object (object)：定义连接的 Credential 部分的属性。
  - id (string)：如果要更新现有连接，请输入凭证 ID。如果要创建新连接，请跳过。目前无法在创建新连接时使用现有凭证。
  - name (string)：必填。输入凭证的名称。
  - schemaName (string)：必填。输入所选凭证的架构名称。
  - parameters (object)：必填。连接的 Credential 部分的参数。如需了解详情，请参阅 Connection.parameters 属性。如无参数需求，请提供空对象 {}。

请求示例：cURL

使用用户名-密码凭证创建 SQL Server DCM 连接

curl --location --request POST 'https://localhost/webapi/v3/dcm/connections' `
  --header 'Authorization: Bearer BearerTokenGoesHere' `
  --header 'Content-Type: application/json' `
  --data '{
    "name": "MSSQL DEV Admin",
    "schemaName": "database-odbc-dsn-mssql",
    "parameters": {},
    "dataSource": {
      "object": {
        "name": "SQL Server DEV",
        "schemaName": "database-odbc-dsn-mssql",
        "parameters": {
          "dsn": "sql server"
        }
      }
    },
    "credentials": {
      "main": {
        "object": {
          "name": "SQL Server Admin Credentials",
          "schemaName": "username_password",
          "parameters": {},
          "userName": "admin",
          "secrets": {
            "password": {
              "value": {
                "text": "password"
              },
              "parameters": {}
            }
          }
        }
      }
    }
  }'

使用 AWS IAM/Cognito 通过 OAuth 身份验证方式创建与 Redshift 的 ODBC DCM 连接

curl --location --request POST 'https://localhost/webapi/v3/dcm/connections' `
  --header 'Authorization: Bearer BearerTokenGoesHere' `
  --header 'Content-Type: application/json' `
  --data '{
    "name": "Connection Name",
    "schemaName": "database-odbc-redshift-simba-oauth-iam-identitypool",
    "allowInSdks": false,
    "parameters": {},
    "dataSource": {
        "object": {
            "name": "DataSource Name",
            "schemaName": "database-odbc-redshift-simba",
            "drvName": "Simba Amazon Redshift ODBC Driver",
            "host": "##### (my-database-host.redshift.amazonaws.com)",
            "parameters": {
                "allowSelfSignedServerCert": false,
                "checkCertRevocation": false,
                "database": "#####",
                "minTLS": 2,
                "port": 5439,
                "sslMmode": "require",
                "useSystemTrustStore": false
            }
        }
    },
    "credentials": {
        "oauthApplication": {
            "object": {
                "name": "Application Credential Name",
                "schemaName": "database-redshift-aws-oauth-iam-identitypool-application",
                "userName": "##### (Client Secret)",
                "parameters": {
                    "accountId": "#####",
                    "authorityURL": "##### (https://my-authorization-host.amazoncognito.com)",
                    "awsRegion": "##### (us-west-2)",
                    "dbUser": "#####",
                    "identityPoolId": "#####",
                    "redirectURI": "##### (http://localhost:5634)",
                    "userPoolId": "#####"
                },
                "secrets": {
                }
            }
        },
        "oauthTokens": {
            "object": {
                "name": "Tokens Credential Name",
                "schemaName": "aws-oauth-iam-identitypool-tokens",
                "parameters": {},
                "secrets": {
                }
            }
        }
    }
}'

使用 OAuth 2.0 客户端凭证创建与 Snowflake 的 DCM 连接

curl --location --request POST 'https://localhost/webapi/v3/dcm/connections' `
  --header 'Authorization: Bearer BearerTokenGoesHere' `
  --header 'Content-Type: application/json' `
  --data '{
    "name": "Connection Name",
    "schemaName": "database-odbc-snowflake-simba-oauth-generic-configurable",
    "allowInSdks": false,
    "parameters": {},
    "dataSource": {
        "object": {
            "name": "DataSource Name",
            "schemaName": "database-odbc-snowflake-simba",
            "drvName": "Simba Snowflake ODBC Driver",
            "host": "##### (my-domain.snowflakecomputing.com)",
            "parameters": {
                "database": "#####",
                "schema": "#####",
                "warehouse": "#####"
            }
        }
    },
    "credentials": {
        "oauthApplication": {
            "object": {
                "name": "Application Credential Name",
                "schemaName": "generic-configurable-oauth-application",
                "userName": "##### (Client Id)",
                "parameters": {
                    "clientAuthentication": "body",
                    "grantType": "clientCredentials",
                    "tokenURL": "#####"
                },
                "secrets": {
                    "clientSecret": {
                        "expiresOn": null,
                        "parameters": {},
                        "value": {
                            "text": "##### (Client Secret)"
                        }
                    }
                }
            }
        },
        "oauthTokens": {
            "object": {
                "name": "Tokens Credential Name",
                "schemaName": "generic-configurable-oauth-tokens",
                "userName": null,
                "parameters": {
                    "scope": "#####"
                },
                "secrets": {}
            }
        }
    }
}'

删除连接

要删除连接，请使用 DELETE {baseURL}/v3/dcm/connections/{id} 端点。数据源和凭证若未用于任何其他连接，则也将予以删除。

属性

id (string)：必填。输入要删除的 DCM 连接 ID。

请求示例：cURL

curl --location --request DELETE 'https://localhost/webapi/v3/dcm/connections/d8cc5fca-86cc-4e7e-93a3-d500cca9a3f3' `
  --header 'Authorization: Bearer BearerTokenGoesHere'

面向管理员的 DCM 端点

具有 API 访问权限的管理员可以使用的端点：

注意

所有管理 API 端点都会返回所有用户在 Server 上可用的所有数据，无论所有权如何。
所有示例均为 PowerShell 脚本。

获取连接

要获取连接记录，请使用 GET {baseURL}/v3/dcm/admin/connections/{objectId} 端点。

属性

objectId (string)：必填。输入要获取相关信息的 DCM 连接 ID。

请求示例：cURL

curl --location --request GET 'https://localhost/webapi/v3/dcm/admin/connections/d8cc5fca-86cc-4e7e-93a3-d500cca9a3f3' `
  --header 'Authorization: Bearer BearerTokenGoesHere'

列出连接

要获取 Server 上存在的所有连接记录的列表，请使用 GET {baseURL}/v3/dcm/admin/connections 端点。

属性

这两个参数都是可以组合的筛选条件。将 connectionId 和 visibleBy 一起使用将返回指定了 ConnectionID 的连接，该连接对指定用户可见。

connectionId (string)：可选。根据工作流引用的 connectionID 筛选连接。如果连接是为了协作而共享的，则可以为单个 connectionID 返回多个连接。
visibleBy (string)：可选。输入用户 ID。如果存在，它会将结果过滤为与指定用户可用的所有连接相同的结果。

请求示例：cURL

curl --location --request GET 'https://localhost/webapi/v3/dcm/admin/connections?connectionId=d8cc5fca-86cc-4e7e-93a3-d500cca9a3f3&visibleBy=bc7cb7b47c33' `
  --header 'Authorization: Bearer BearerTokenGoesHere'

代表用户创建或更新连接

要代表用户创建或更新连接记录，请使用 POST {baseURL}/v3/dcm/admin/connections 端点。

属性

使用与创建或更新连接部分中所述相同的属性。此端点所需的唯一附加属性是 ownerId。

注意

您不能转让 DCM 连接的所有权。您只能为特定 ownerId 创建或更新连接。

ownerId (string)：必填。

创建连接时，请输入代表其创建连接的用户 ID。
更新连接时，即使您不想更改，也必须输入 ownerId。如需详细了解如何获取 ownerId，请转至获取连接或列出连接。

请求示例：cURL

curl --location --request POST 'https://localhost/webapi/v3/dcm/connections' `
  --header 'Authorization: Bearer BearerTokenGoesHere' `
  --header 'Content-Type: application/json' `
  --data '{
    "upsertConnectionContract": {
      "name": "MSSQL DEV Admin",
      "ownerId": "1b4bc56d489d9543a",
      "schemaName": "database-odbc-dsn-mssql",
      "parameters": {},
      "dataSource": {
        "object": {
          "name": "SQL Server DEV",
          "schemaName": "database-odbc-dsn-mssql",
          "parameters": {
            "dsn": "sql server"
          }
        }
      },
      "credentials": {
        "main": {
          "object": {
            "name": "SQL Server Admin Credentials",
            "schemaName": "username_password",
            "parameters": {},
            "userName": "admin",
            "secrets": {
              "password": {
                "value": {
                  "text": "password"
                },
                "parameters": {}
              }
            }
          }
        }
      }
    }
  }'

取消共享为执行而共享的连接

要取消共享其共享类型已定义为“为执行而共享”的连接，请使用 DELETE {baseURL}/v3/dcm/admin/connections/{objectId}/sharing/execution 端点。

属性

objectId (string)：必填。输入执行时要取消共享的 DCM 连接 ID。

请求示例：cURL

curl --location --request DELETE 'https://localhost/webapi/v3/dcm/admin/connections/d8cc5fca-86cc-4e7e-93a3-d500cca9a3f3/sharing/execution' `
  --header 'Authorization: Bearer BearerTokenGoesHere'

取消共享为协作而共享的连接

要取消共享其共享类型已定义为“为协作而共享”的连接，请使用 DELETE {baseURL}/v3/dcm/admin/connections/{objectId}/sharing/collaboration 端点。

属性

objectId (string)：必填。输入协作时要取消共享的 DCM 连接 ID。

请求示例：cURL

curl --location --request DELETE 'https://localhost/webapi/v3/dcm/admin/connections/d8cc5fca-86cc-4e7e-93a3-d500cca9a3f3/sharing/collaboration' `
  --header 'Authorization: Bearer BearerTokenGoesHere'

删除连接

要删除连接记录，请使用 DELETE {baseURL}/v3/dcm/admin/connections/{objectId} 端点。数据源和凭证若未用于任何其他连接，则也将予以删除。

属性

objectId (string)：必填。输入要删除的 DCM 连接 ID。

请求示例：cURL

curl --location --request DELETE 'https://localhost/webapi/v3/dcm/admin/connections/d8cc5fca-86cc-4e7e-93a3-d500cca9a3f3' `
  --header 'Authorization: Bearer BearerTokenGoesHere'

获取所有连接处理规则

要获取所有连接处理规则，请使用 GET {baseURL}/v3/dcm/admin/connectionhandlingrules 端点。

如需了解详情，请转到 DCM 连接处理。

属性

无属性。

请求示例：cURL

curl --location --request GET 'https://localhost/webapi/v3/dcm/admin/connectionhandlingrules' `
  --header 'Authorization: Bearer BearerTokenGoesHere'

获取连接处理规则

要获取特定的 DCM 连接处理规则，请使用 GET {baseURL}/v3/dcm/admin/connectionhandlingrules/{id} 端点。

属性

id (string)：必填。指定要返回的 DCM 连接处理规则的 ID。

请求示例：cURL

curl --location --request GET 'https://localhost/webapi/v3/dcm/admin/connectionhandlingrules/{id}' `
  --header 'Authorization: Bearer BearerTokenGoesHere'

添加或更新连接处理规则

要添加新的连接处理规则或更新现有规则，请使用 POST {baseURL}/v3/dcm/admin/connectionhandlingrules 端点。

属性

输入以下属性以创建或更新 DCM 连接处理规则：

rule (body)：必填。要创建或更新的 DCM 连接处理规则。
- id (string)：可选。DCM 连接处理规则 ID。如果要更新现有连接处理规则，请输入 DCM 连接处理规则 ID。如果要创建新的连接处理规则，请跳过。
- sourceConnectionId (string)：输入 sourceConnectionId，引用执行工作流时要替换的 ConnectionId。此连接不必存在于 Server 上（仍然可以执行引用它的工作流）。此连接不能在另一个现有规则中使用，无论是作为源连接还是目标连接。
- sourceConnectionTitle (string)：输入源连接的自定义名称或说明。
- targetConnectionId (string)：输入 targetConnectionId。必须引用 Server 上存在的 DCM 连接。
- targetConnectionTitle (string)：可选。输入目标连接的自定义名称或说明。系统会自动补全为所选连接的标题。

请求示例：cURL

curl --location 'https://localhost.com/webapi/v3/dcm/admin/connectionhandlingrules' `
--header 'Content-Type: application/json' `
--header 'Authorization: Bearer BearerTokenGoesHere' `
--data '{
    "sourceConnectionTitle": "MSSQL DEV",
    "sourceConnectionId": "c.cid.d8cc5fca-86cc-4e7e-93a3-d500cca9a3f3",
    "targetConnectionId": "c.cid.cbf55382-f90b-4304-a1cd-37c5cff697e0"
}'

删除连接处理规则

要删除现有连接处理规则，请使用 DELETE {baseURL}/v3/dcm/admin/connectionhandlingrules/{id} 端点。

属性

id (string)：必填。指定要删除的 DCM 连接处理规则 ID。

请求示例：cURL

curl --location --request DELETE 'https://localhost/webapi/v3/dcm/admin/connectionhandlingrules/{id}' `
  --header 'Authorization: Bearer BearerTokenGoesHere'

对象关系

如果您正在创建连接，可按以下方式使用所创建的对象：

创建的对象：

“id”（例如“id”: “c128cc5fca-86cc-4e7e-93a3-d500cca9a3f3”）
“connectionId”（例如“id”: “c0332423423-86cc-4e7e-93a3-d500cca9a3f3”）

您可以将其用作：

id（如果要获取连接）。
connectionId（如果要获取工作流中引用的连接）。
id（如果要与指定用户和用户组共享连接）。
id（如果要更新连接）。
id（如果要删除连接）。
id（如果要取消共享连接）。

管理员：

id（如果要获取连接）。
ownerId (userId)（如果要代表用户创建连接）。
id（如果要代表用户更新连接）。
id（如果要取消共享为执行而共享的连接）。
id（如果要取消共享为协作而共享的连接）。
id（如果要删除连接）。

本节内容如下:

DCM 端点

DCM 端点和属性

什么是 DCM 连接？

连接器与 DCM 连接有何关系？

SQL Server 的 ODBC 连接器使用的 schemaNames

面向用户的 DCM 端点

获取连接

属性

请求示例：cURL

获取工作流中引用的连接

属性

请求示例：cURL

共享连接

属性

请求示例：cURL

取消共享连接

属性

请求示例：cURL

创建或更新连接

属性

请求示例：cURL

删除连接

属性

请求示例：cURL

面向管理员的 DCM 端点

获取连接

属性

请求示例：cURL

列出连接

属性

请求示例：cURL

代表用户创建或更新连接

属性

请求示例：cURL

取消共享为执行而共享的连接

属性

请求示例：cURL

取消共享为协作而共享的连接

属性

请求示例：cURL

删除连接

属性

请求示例：cURL

获取所有连接处理规则

属性

请求示例：cURL

获取连接处理规则

属性

请求示例：cURL

添加或更新连接处理规则

属性

请求示例：cURL

删除连接处理规则

属性

请求示例：cURL

对象关系

搜索结果