对API中的源的专用链接支持
您可以使用专用链接功能为Adobe Experience Platform源创建要连接的专用端点。 使用私有IP地址将源安全地连接到虚拟网络,消除对公共IP的需求,并减少攻击面。 通过消除对复杂防火墙或网络地址转换配置的需求,简化网络设置,同时确保数据流量仅能到达批准的服务。
阅读本指南,了解如何使用API创建和使用专用端点。
专用链接支持的许可证使用授权
源中专用链接支持的许可证使用权利指标如下:
- 客户有权通过受支持的源(Azure Blob Storage、ADLS Gen2和Azure File Storage)在所有沙盒和组织中每年最多传输2 TB的数据。
- 对于所有生产沙盒,每个组织最多可以有10个端点。
- 对于所有开发沙盒,每个组织最多可以有1个端点。
快速入门
本指南要求您对Experience Platform的以下组件有一定的了解:
使用平台API
有关如何成功调用平台API的信息,请参阅平台API快速入门指南。
创建专用端点 create-private-endpoint
要创建专用端点,请向/privateEndpoints
发出POST请求。
API格式
POST /privateEndpoints
请求
以下请求创建一个专用端点:
code language-shell |
---|
|
table 0-row-2 1-row-2 2-row-2 3-row-2 4-row-2 5-row-2 6-row-2 | |
---|---|
属性 | 描述 |
name |
专用端点的名称。 |
subscriptionId |
与您的Azure订阅关联的ID。 有关详细信息,请参阅Azure上的指南,从 Azure Portal中检索您的订阅和租户ID。 |
resourceGroupName |
Azure上资源组的名称。 资源组包含Azure解决方案的相关资源。 有关详细信息,请阅读有关Azure管理资源组的指南。 |
resourceName |
资源的名称。 在Azure中,资源引用虚拟机、Web应用和数据库等实例。 有关详细信息,请阅读Azure上的指南,以了解 Azure 资源管理器。 |
connectionSpec.id |
您正在使用的源的连接规范ID。 |
connectionSpec.version |
您正在使用的连接规范ID的版本。 |
响应
成功的响应会返回以下内容:
code language-json |
---|
|
table 0-row-2 1-row-2 2-row-2 3-row-2 4-row-2 5-row-2 6-row-2 7-row-2 8-row-2 | |
---|---|
属性 | 描述 |
id |
新创建的专用端点的ID。 |
name |
专用端点的名称。 |
subscriptionId |
与您的Azure订阅关联的ID。 有关详细信息,请参阅Azure上的指南,从 Azure Portal中检索您的订阅和租户ID。 |
resourceGroupName |
Azure上资源组的名称。 资源组包含Azure解决方案的相关资源。 有关详细信息,请阅读有关Azure管理资源组的指南。 |
resourceName |
资源的名称。 在Azure中,资源引用虚拟机、Web应用和数据库等实例。 有关详细信息,请阅读Azure上的指南,以了解 Azure 资源管理器。 |
connectionSpec.id |
您正在使用的源的连接规范ID。 |
connectionSpec.version |
您正在使用的连接规范ID的版本。 |
state |
私有端点的当前状态。 有效状态包括:
|
检索专用端点列表 retrieve-private-endpoints
要从您组织中的给定沙盒检索专用端点列表,请向/privateEndpoints
发出GET请求。
API格式
GET /privateEndpoints
请求
以下请求检索您组织中存在的所有专用端点的列表。
code language-shell |
---|
|
响应
成功的响应将返回贵组织中的专用端点列表。
code language-json |
---|
|
检索给定源的专用端点列表 retrieve-private-endpoints-by-source
要检索与特定源对应的私有端点的列表,请向/privateEndpoints
端点发出GET请求并提供源的connectionSpec.id
。
API格式
GET /privateEndpoints?property=connectionSpec.id=={CONNECTION_SPEC_ID}
{CONNECTION_SPEC_ID}
请求
以下请求检索与具有连接规范ID的源对应的所有专用端点的列表: 4c10e202-c428-4796-9208-5f1f5732b1cf
。
code language-shell |
---|
|
响应
成功的响应将返回与连接规范ID为4c10e202-c428-4796-9208-5f1f5732b1cf
的源对应的所有专用端点的列表。
code language-json |
---|
|
检索专用端点 retrieve-specific-private-endpoint
要检索特定的专用端点,请向/privateEndpoints
发出GET请求,并提供要检索的专用端点的ID。
API格式
GET /privateEndpoints/{PRIVATE_ENDPOINT_ID}
{PRIVATE_ENDPOINT_ID}
请求
以下请求检索ID为2c5699b0-b9b6-486f-8877-ee5e21fe9a9d
的专用终结点。
code language-shell |
---|
|
响应
成功的响应返回了ID为2c5699b0-b9b6-486f-8877-ee5e21fe9a9d
的专用终结点
code language-json |
---|
|
解析专用端点 resolve-private-endpoint
API格式
GET /privateEndpoints?op=autoResolve
请求
code language-shell |
---|
|
响应
code language-json |
---|
|
启用Interactive Authoring enable-interactive-authoring
Interactive Authoring用于探索连接或帐户以及预览数据等功能。 要启用Interactive Authoring,请向/privateEndpoints/interactiveAuthoring
发出POST请求,并在查询参数中将enable
指定为运算符。
API格式
POST /privateEndpoints/interactiveAuthoring?op=enable
op
op
值设置为enable
。请求
以下请求为您的专用终结点启用Interactive Authoring,并将TTL设置为60分钟。
code language-shell |
---|
|
table 0-row-2 1-row-2 | |
---|---|
属性 | 描述 |
autoTerminationMinutes |
Interactive Authoring TTL (生存时间)以分钟为单位。 Interactive Authoring用于探索连接或帐户以及预览数据等功能。 您最多可以设置120分钟的TTL。 默认TTL为60分钟。 |
响应
成功的响应返回HTTP状态202(已接受)。
检索Interactive Authoring状态 retrieve-interactive-authoring-status
要查看专用终结点Interactive Authoring的当前状态,请向/privateEndpoints/interactiveAuthoring
发出GET请求。
API格式
GET /privateEndpoints/interactiveAuthoring
请求
以下请求检索Interactive Authoring的状态:
code language-shell |
---|
|
响应
code language-json |
---|
|
table 0-row-2 1-row-2 | |
---|---|
属性 | 描述 |
status |
Interactive Authoring的状态。 有效值包括: disabled 、enabling 、enabled 。 |
删除专用端点 delete-private-endpoint
要删除您的专用端点,请向/privateEndpoints
发出DELETE请求,并提供要删除的端点的ID。
API格式
DELETE /privateEndpoints/{PRIVATE_ENDPOINT_ID}
{PRIVATE_ENDPOINT_ID}
请求
以下请求删除ID为02a74b31-a566-4a86-9cea-309b101a7f24
的专用终结点。
code language-shell |
---|
|
响应
成功的响应返回HTTP状态200(成功)。 您可以通过向/privateEndpoints
发出GET请求并提供已删除的ID作为查询参数来验证删除操作。
流程服务 flow-service
请阅读以下各节,以了解如何将私有端点与Flow Service API结合使用。
创建与专用端点的连接 create-base-connection
要在Experience Platform中创建与私有端点的连接,请对/connections
API的Flow Service端点发出POST请求。
API格式
POST /connections/
请求
以下请求为Azure Blob Storage创建经过身份验证的基本连接,同时使用专用端点。
code language-shell |
---|
|
table 0-row-2 1-row-2 2-row-2 3-row-2 4-row-2 5-row-2 6-row-2 7-row-2 | |
---|---|
属性 | 描述 |
name |
基础连接的名称。 |
description |
(可选)提供有关连接的附加信息的描述。 |
auth.specName |
用于将源连接到Experience Platform的身份验证。 |
auth.params.connectionString |
Azure Blob Storage连接字符串。 有关详细信息,请阅读Azure Blob Storage API身份验证指南。 |
auth.params.usePrivateLink |
一个布尔值,用于确定您是否使用私有端点。 如果您使用专用终结点,则将此值设置为true 。 |
connectionSpec.id |
连接规范ID Azure Blob Storage。 |
connectionSpec.version |
Azure Blob Storage连接规范ID的版本。 |
响应
成功的响应将返回新生成的基本连接ID和etag。
code language-json |
---|
|
检索与给定私有端点关联的连接 retrieve-connections-by-endpoint
要检索与特定私有端点关联的连接,请向/connections
端点发出GET请求,并提供私有端点的ID作为查询参数。
API格式
GET /connections?property=auth.params.privateEndpointId=={PRIVATE_ENDPOINT_ID}
请求
以下请求检索绑定到ID为02a74b31-a566-4a86-9cea-309b101a7f24
的私有端点的现有连接。
code language-shell |
---|
|
响应
成功的响应将返回与查询的私有端点关联的连接列表。
code language-json |
---|
|
检索与任何专用端点关联的连接 retrieve-connections
要检索与任何专用端点关联的连接,请向/connections
端点发出GET请求,并提供property=auth.params.usePrivateLink==true
作为查询参数。
API格式
GET /connections?property=auth.params.usePrivateLink==true
请求
以下请求将检索贵组织中使用私有端点的所有连接。
code language-shell |
---|
|
响应
成功的响应将返回与私有端点绑定的所有连接。
code language-json |
---|
|
附录
阅读本节以了解在API中使用Azure专用链接的其他信息。
批准Azure Blob和Azure Data Lake Gen2的专用终结点
要批准Azure Blob和Azure Data Lake Gen2源的专用终结点请求,请登录到Azure Portal。 在左侧导航中,选择 Data storage,然后转到 Security + networking 选项卡并选择 Networking。 接下来,选择 Private endpoints 以查看与您的帐户关联的专用端点列表及其当前连接状态。 要批准挂起的请求,请选择所需的终结点,然后单击 Approve。