文档

API概览

更新时间:
本产品(私网连接/2020-04-15)的OpenAPI采用RPC签名风格,签名细节参见签名机制说明我们已经为开发者封装了常见编程语言的SDK,开发者可通过下载SDK直接调用本产品OpenAPI而无需关心技术细节。如果现有SDK不能满足使用需求,可通过签名机制进行自签名对接。由于自签名细节非常复杂,需花费 5个工作日左右。因此建议加入我们的服务钉钉群(11370001915),在专家指导下进行签名对接。
在使用API前,您需要准备好身份账号及访问密钥(AccessKey),才能有效通过客户端工具(SDK、CLI等)访问API。细节请参见获取AccessKey

私网连接服务

API标题API概述
OpenPrivateLinkService开启私网连接服务开启私网连接服务。
CheckProductOpen查询是否已开通私网连接调用CheckProductOpen接口,查询是否已开通私网连接。

地域与可用区

API标题API概述
DescribeRegions查看可选的地域和可用区调用DescribeRegions接口,查看私网连接可选的地域和可用区。
DescribeZones查询指定地域中可用区的列表调用DescribeZones接口,查询指定地域中可用区的列表。

终端节点服务

API标题API概述
CreateVpcEndpointService创建终端节点服务调用CreateVpcEndpointService接口,创建终端节点服务。
UpdateVpcEndpointServiceAttribute修改终端节点服务的属性调用UpdateVpcEndpointServiceAttribute接口,修改终端节点服务的属性。
GetVpcEndpointServiceAttribute获取终端节点服务属性信息调用GetVpcEndpointServiceAttribute接口,获取终端节点服务属性信息。
ListVpcEndpointServices查询终端节点服务列表调用ListVpcEndpointServices接口,查询终端节点服务列表。
DeleteVpcEndpointService删除终端节点服务调用DeleteVpcEndpointService接口,删除终端节点服务。

服务白名单

API标题API概述
AddUserToVpcEndpointService添加服务白名单调用AddUserToVpcEndpointService接口,为终端节点服务添加服务白名单。
ListVpcEndpointServiceUsers查询终端节点服务的服务白名单调用ListVpcEndpointServiceUsers接口,查询终端节点服务的服务白名单。
RemoveUserFromVpcEndpointService移除服务白名单调用RemoveUserFromVpcEndpointService接口,移除终端节点服务的服务白名单。

服务资源

API标题API概述
UpdateVpcEndpointServiceResourceAttribute修改终端节点服务资源的属性调用UpdateVpcEndpointServiceResourceAttribute接口,修改终端节点服务资源是否自动分配。
AttachResourceToVpcEndpointService为终端节点服务添加服务资源调用AttachResourceToVpcEndpointService接口,为终端节点服务添加服务资源。
ListVpcEndpointServiceResources查询终端节点服务中的服务资源调用ListVpcEndpointServiceResources接口查询终端节点服务中的服务资源。
DetachResourceFromVpcEndpointService移除终端节点服务中的服务资源调用DetachResourceFromVpcEndpointService接口,移除终端节点服务中的服务资源。

终端节点

API标题API概述
DeleteVpcEndpoint删除终端节点调用DeleteVpcEndpoint接口,删除终端节点。
CreateVpcEndpoint创建终端节点调用CreateVpcEndpoint接口,创建终端节点。
UpdateVpcEndpointAttribute修改终端节点的属性调用UpdateVpcEndpointAttribute接口,修改终端节点的属性。
ListVpcEndpoints查询终端节点列表调用ListVpcEndpoints接口,查询终端节点列表。
GetVpcEndpointAttribute获取终端节点属性信息调用GetVpcEndpointAttribute接口,获取终端节点属性信息。
ListVpcEndpointServicesByEndUser查询可以关联的终端节点服务调用ListVpcEndpointServicesByEndUser接口,查询已授权本账号创建终端节点时可以关联的终端节点服务。

终端节点连接

API标题API概述
EnableVpcEndpointConnection接受终端节点连接请求调用EnableVpcEndpointConnection接口,终端节点服务接受终端节点的连接请求。
UpdateVpcEndpointConnectionAttribute修改终端节点连接的属性调用UpdateVpcEndpointConnectionAttribute接口,修改终端节点连接的属性。
ListVpcEndpointConnections查询终端节点连接调用ListVpcEndpointConnections接口,查询终端节点连接。
DisableVpcEndpointConnection拒绝终端节点的连接请求调用DisableVpcEndpointConnection接口,拒绝终端节点的连接请求。

终端节点可用区

API标题API概述
AddZoneToVpcEndpoint为终端节点添加可用区调用AddZoneToVpcEndpoint接口,为终端节点添加可用区。
ListVpcEndpointZones查询终端节点可用区列表调用ListVpcEndpointZones接口,查询终端节点可用区列表。
RemoveZoneFromVpcEndpoint删除终端节点的可用区调用RemoveZoneFromVpcEndpoint接口,删除终端节点的可用区。

终端节点可用区连接

API标题API概述
DisableVpcEndpointZoneConnection断开终端节点可用区连接调用DisableVpcEndpointZoneConnection接口,断开终端节点可用区连接。
EnableVpcEndpointZoneConnection允许终端节点可用区连接调用EnableVpcEndpointZoneConnection接口,允许终端节点可用区连接。
UpdateVpcEndpointZoneConnectionResourceAttribute替换终端节点可用区连接服务资源调用UpdateVpcEndpointZoneConnectionResourceAttribute接口,替换终端节点可用区连接服务资源。

安全组

API标题API概述
AttachSecurityGroupToVpcEndpoint将终端节点加入安全组调用AttachSecurityGroupToVpcEndpoint接口,将终端节点加入安全组。
ListVpcEndpointSecurityGroups查询终端节点已加入的安全组调用ListVpcEndpointSecurityGroups接口,查询终端节点已加入的安全组。
DetachSecurityGroupFromVpcEndpoint将终端节点移除安全组调用DetachSecurityGroupFromVpcEndpoint接口,将终端节点移除安全组。

标签&资源组

API标题API概述
UntagResources为指定的资源列表统一解绑标签当您不需要标识一个或多个终端节点或终端节点服务时,可调用UntagResources接口,为指定的资源列表统一解绑标签。
ListTagResources查询资源已经绑定的标签列表当您需要查询资源标签时,可调用ListTagResources接口,查询资源已经绑定的标签列表。
TagResources为指定的资源列表统一创建并绑定标签当您需要标识一个或多个终端节点或终端节点服务时,可调用TagResources接口,为指定的资源列表统一绑定标签。
ChangeResourceGroup更改资源组更改资源组。
  • 本页导读 (1)