在本页中,您将了解如何使用 Datastream API 创建和删除专用连接配置,以及如何检索其相关信息。
专用连接配置包含 Datastream 用于通过专用网络(在 Google Cloud 内部或与通过 VPN 或 Interconnect 连接的外部来源)与数据源进行通信的信息。 Google Cloud此通信通过 Virtual Private Cloud (VPC) 对等互连连接进行。
您可以通过两种方式使用 Datastream API。您可以进行 REST API 调用,也可以使用 Google Cloud CLI (CLI)。
如需查看如何使用 gcloud
管理 Datastream 专用连接配置的概要信息,请点击此处。
创建专用连接配置
在创建专用连接配置之前,请确保您具备以下条件:
- 拥有一个 VPC 网络,用于与 Datastream 的专用网络建立对等互连。如需详细了解如何创建 VPC 网络,请参阅使用 VPC 网络对等互连。
- VPC 网络上有可用的 IP 范围。Datastream 使用此 IP 地址范围与所提供的 VPC 创建 VPC 对等互连,因此此范围不能与该 VPC 内的子网重叠。因此,Datastream 可以与源通信。
以下是与创建专用连接配置关联的两个参数:
vpcName:
,指定 VPC 网络的名称和路径。subnet:
,提供 VPC 网络上可用的 IP 范围。
以下代码展示了创建专用连接配置的请求,并将连接方法指定为使用 VPC 对等互连 (vpcPeeringConfig
)。
REST
POST https://datastream.googleapis.com/v1/projects/[project-id]/locations/ [location]/privateConnections?privateConnectionId=[private-connectivity configuration-id] { "displayName": "[private-connectivity-configuration-display-name]", "vpcPeeringConfig": { "vpcName": "[name-and-path-of-VPC-network]", "subnet": "[subnet]" } }
例如:
POST https://datastream.googleapis.com/v1/projects/myProjectId/locations/ us-central1/privateConnections?privateConnectionId=myPrivateConnection { "displayName": "my private connectivity configuration", "vpcPeeringConfig": { "vpcName": "projects/my-project/global/networks/my-vpc", "subnet": "10.11.12.13/29" } }
创建专用连接配置后,您可以调用 privateConnections/get
方法来查看其相关信息。您将看到如下所示的输出:
{ "name": "projects/projectId/location/us-central1/privateConnections/myPrivateConnection", "createTime": "2019-12-22T16:17:37.159786963Z", "updateTime": "2019-12-22T16:17:37.159786963Z", "displayName": "my private connectivity configuration", "state": "CREATED", "vpcPeeringConfig": { "vpcName": "projects/my-project/global/networks/my-vpc", "subnet": "10.11.12.13/29" } }
gcloud
如需详细了解如何使用 gcloud
创建专用连接配置,请点击此处。
获取专用连接配置的相关信息
以下代码展示了检索有关已创建的专用连接配置的信息的请求。
REST
GET https://datastream.googleapis.com/v1/projects/[project-id]/locations/ [location]/privateConnections/[private-connectivity-configuration-id]
例如:
GET https://datastream.googleapis.com/v1/projects/myProjectId/locations/ us-central1/privateConnections/myPrivateConnection
gcloud
如需详细了解如何使用 gcloud
检索专用连接配置的相关信息,请点击此处。
列出专用连接配置
以下代码展示了检索有关所有专用连接配置的信息的请求。
REST
GET https://datastream.googleapis.com/v1/projects/[project-id]/locations/ [location]/privateConnections
gcloud
如需详细了解如何使用 gcloud
检索有关所有专用连接配置的信息,请点击此处。
删除专用连接配置
以下代码显示了一个删除专用连接配置的请求。删除配置后,使用该配置的所有连接配置文件都将无法正常运行。此外,使用这些连接配置文件的所有数据流都将无法运行。
如需解决此问题,请为每个连接配置文件分配不同的专用连接配置。如需了解详情,请参阅更新连接配置文件。
REST
DELETE https://datastream.googleapis.com/v1/projects/[project-id]/locations/ [location]/privateConnections/[private-connectivity-configuration-id] {"force": true}
例如:
DELETE https://datastream.googleapis.com/v1/projects/myProjectId/locations/ us-central1/privateConnections/myPrivateConnection {"force": true}
gcloud
如需详细了解如何使用 gcloud
删除专用连接配置,请点击此处。
后续步骤
- 详细了解专用连接。
- 了解您可以与 Datastream 搭配使用的其他网络连接选项。
- 了解如何使用 Datastream API 管理连接配置文件。
- 了解如何使用 Datastream API 管理数据流。
- 如需详细了解如何使用 Datastream API,请参阅参考文档。