调用CreateVpcEndpoint接口创建终端节点。

使用说明

CreateVpcEndpoint接口属于异步接口,即系统会返回一个实例ID,但该终端节点尚未创建完成,系统后台任务仍在进行中。您可以调用GetVpcEndpointAttribute查询终端节点的创建状态:

  • 当终端节点处于Creating状态时,表示终端节点正在创建中。
  • 当终端节点处于Active状态时,表示终端节点创建完成。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

请求参数

名称 类型 是否必选 示例值 描述
Action String CreateVpcEndpoint

系统规定参数。取值:CreateVpcEndpoint

RegionId String cn-huhehaote

终端节点所在的地域ID。

您可以通过调用DescribeRegions接口获取地域ID。

ClientToken String 0c593ea1-3bea-11e9-b96b-88e9fe637760

客户端Token,用于保证请求的幂等性。

从您的客户端生成一个参数值,确保不同请求间该参数值唯一。ClientToken只支持ASCII字符。

DryRun Boolean false

是否只预检此次请求。取值:

  • true:发送检查请求,不会创建终端节点。检查项包括是否填写了必需参数、请求格式、业务限制。如果检查不通过,则返回对应错误。如果检查通过,则返回错误码DryRunOperation
  • false(默认值):发送正常请求,通过检查后返回HTTP 2xx状态码并直接进行操作。
EndpointName String test

终端节点名称。

长度为2~128个字符,以英文字母或中文开头,可包含数字、短划线(-)和下划线(_)。

EndpointType String Interface

终端节点类型。

仅取值: Interface,表示接口终端节点,您可以添加应用型负载均衡ALB(Application Load Balancer)和传统型负载均衡CLB(Classic Load Balancer)的服务资源类型。

ZonePrivateIpAddressCount Long 1

每个可用区ENI的私网IP的数量。仅取值:1

EndpointDescription String This is my Endpoint.

终端节点描述。

描述长度为2~256个字符,开头不能为http://https://

VpcId String vpc-hp356stwkxg3fn2xe****

终端节点所属的专有网络。

ServiceId String epsrv-hp3xdsq46ael67lo****

终端节点关联的终端节点服务。

ServiceName String com.aliyuncs.privatelink.cn-huhehaote.epsrv-hp3vpx8yqxblby3i****

终端节点关联的终端节点服务的名称。

Zone.N.VSwitchId String vsw-hp3uf6045ljdhd5zr****

在可用区内要创建终端节点网卡的交换机。

您最多可以设置10个交换机。

Zone.N.ZoneId String cn-huhehaote-b

终端节点服务对应的可用区。

您最多可以设置10个可用区。

Zone.N.ip String 192.168.XX.XX

指定终端节点可用区的IP。

您最多可以指定10个IP。

SecurityGroupId.N String sg-bp1fg655nh68xyz9****

终端节点网卡关联的安全组,安全组可以管控VPC到终端节点网卡的数据通信。

您最多可以关联10个安全组。

ProtectedEnabled Boolean false

是否开启托管保护,STS调用方式下生效。取值:

  • true:开启。开启托管保护后,只有和创建时相同的用户才能通过STS方式对该终端节点进行修改或者删除等操作。
  • false(默认值):不开启。
ResourceGroupId String rg-acfmy*****

资源组ID。

返回数据

名称 类型 示例值 描述
EndpointDomain String ep-hp33b2e43fays7s8****.epsrv-hp3xdsq46ael67lo****.cn-huhehaote.privatelink.aliyuncs.com

终端节点域名。

RequestId String 0ED8D006-F706-4D23-88ED-E11ED28DCAC0

请求ID。

CreateTime String 2022-01-02T19:11:12Z

终端节点的创建时间。

EndpointBusinessStatus String Normal

终端节点的业务状态。取值:

  • Normal:正常。
  • FinacialLocked:欠费锁定。
EndpointDescription String This is my Endpoint.

终端节点描述。

ServiceId String epsrv-hp3vpx8yqxblby3i****

终端节点关联的终端节点服务的ID。

EndpointStatus String Active

终端节点状态。取值:

  • Creating:创建中。
  • Active:可用。
  • Pending:修改中。
  • Deleting:删除中。
VpcId String vpc-hp356stwkxg3fn2xe****

终端节点所属的专有网络。

EndpointName String test

终端节点名称。

ServiceName String com.aliyuncs.privatelink.cn-huhehaote.epsrv-hp3xdsq46ael67lo****

终端节点关联的终端节点服务的名称。

Bandwidth Long 200

终端节点的连接带宽,单位:Mbps。

EndpointId String ep-hp33b2e43fays7s8****

终端节点ID。

ConnectionStatus String Disconnected

终端节点连接状态。取值:

  • Pending:修改中。
  • Connecting:连接中。
  • Connected:已连接。
  • Disconnecting:断开连接中。
  • Disconnected:未连接。
  • Deleting:删除中。

示例

请求示例

http(s)://[Endpoint]/?Action=CreateVpcEndpoint
&RegionId=cn-huhehaote
&ClientToken=0c593ea1-3bea-11e9-b96b-88e9fe637760
&DryRun=false
&EndpointName=test
&EndpointType=Interface
&ZonePrivateIpAddressCount=1
&EndpointDescription=This is my Endpoint.
&VpcId=vpc-hp356stwkxg3fn2xe****
&ServiceId=epsrv-hp3xdsq46ael67lo****
&ServiceName=com.aliyuncs.privatelink.cn-huhehaote.epsrv-hp3vpx8yqxblby3i****
&Zone=[{"VSwitchId":"vsw-hp3uf6045ljdhd5zr****","ZoneId":"cn-huhehaote-b","ip":"192.168.XX.XX"}]
&SecurityGroupId=["sg-bp1fg655nh68xyz9****"]
&ProtectedEnabled=false
&ResourceGroupId=rg-acfmy*****
&公共请求参数

正常返回示例

XML格式

HTTP/1.1 200 OK
Content-Type:application/xml

<CreateVpcEndpointResponse>
    <EndpointDomain>ep-hp33b2e43fays7s8****.epsrv-hp3xdsq46ael67lo****.cn-huhehaote.privatelink.aliyuncs.com</EndpointDomain>
    <RequestId>0ED8D006-F706-4D23-88ED-E11ED28DCAC0</RequestId>
    <CreateTime>2022-01-02T19:11:12Z</CreateTime>
    <EndpointBusinessStatus>Normal</EndpointBusinessStatus>
    <EndpointDescription>This is my Endpoint.</EndpointDescription>
    <ServiceId>epsrv-hp3vpx8yqxblby3i****</ServiceId>
    <EndpointStatus>Active</EndpointStatus>
    <VpcId>vpc-hp356stwkxg3fn2xe****</VpcId>
    <EndpointName>test</EndpointName>
    <ServiceName>com.aliyuncs.privatelink.cn-huhehaote.epsrv-hp3xdsq46ael67lo****</ServiceName>
    <Bandwidth>200</Bandwidth>
    <EndpointId>ep-hp33b2e43fays7s8****</EndpointId>
    <ConnectionStatus>Disconnected</ConnectionStatus>
</CreateVpcEndpointResponse>

JSON格式

HTTP/1.1 200 OK
Content-Type:application/json

{
  "EndpointDomain" : "ep-hp33b2e43fays7s8****.epsrv-hp3xdsq46ael67lo****.cn-huhehaote.privatelink.aliyuncs.com",
  "RequestId" : "0ED8D006-F706-4D23-88ED-E11ED28DCAC0",
  "CreateTime" : "2022-01-02T19:11:12Z",
  "EndpointBusinessStatus" : "Normal",
  "EndpointDescription" : "This is my Endpoint.",
  "ServiceId" : "epsrv-hp3vpx8yqxblby3i****",
  "EndpointStatus" : "Active",
  "VpcId" : "vpc-hp356stwkxg3fn2xe****",
  "EndpointName" : "test",
  "ServiceName" : "com.aliyuncs.privatelink.cn-huhehaote.epsrv-hp3xdsq46ael67lo****",
  "Bandwidth" : 200,
  "EndpointId" : "ep-hp33b2e43fays7s8****",
  "ConnectionStatus" : "Disconnected"
}

错误码

HttpCode 错误码 错误信息 描述
400 EndpointExist The specified Endpoint already exists. 当前终端节点已经存在。
400 EndpointZoneDuplicated The zone is duplicated for the Endpoint. 终端节点服务下面可用区不可以重复
400 EndpointServiceNotFound The specified Service does not exist. 当前终端节点服务不存在
400 EndpointServiceNotSupportedZone The specified endpoint service does not support the zone. 终端节点服务不支持当前可用区。
400 VSwitchNotFound The specified VSwitch does not exist. 当前虚拟交换机未找到。
400 SecurityGroupNotFound The specified security group does not exist. 当前安全组未找到。
400 VpcTunnelNotFound The specified VPC tunnel does not exist. 当前VPC信道未找到。
400 VpcNotFound The specified VPC does not exist. 当前VPC未找到。
400 GenerateResourceIdFailed Failed to generate ResourceId. 生成资源ID失败。
400 QuotaMisMatched The resource you applied for has exceeded the quota. 申请的资源超过配额
400 EndpointMustContainSecurityGroup The specified endpoint must have at least one security group. 终端节点需要至少加入一个安全组
400 EndpointDuplicated The endpoint of the service already exists and cannot be created again. 此服务的终端节点已存在,不能重复创建
400 EndpointServiceDeleted The specified Service is already deleted. 终端节点服务已经被删除
400 EndpointServiceResourceNotFound The specified service resource is not found. 终端节点服务资源未找到
400 SecurityGroupTypeNotSupport The specified security group type is not supported. 该安全组类型不支持
400 EniIpUnavailable The specified IP address is unavailable. 指定的IP不可用
400 EndpointServiceNotAuthorized The specified endpoint service is not authorized to user. 终端节点服务未授权给用户。
400 SecurityGroupTypeOnlySingleTypeSupporteded The specified security group only support one type. 安全组只支持一种类型
400 QuotaExceeded.IpQuotaPerEp The quota of %s is exceeded, usage %s/%s. 配额%s已超额度限制,目前已使用%s,配额为%s。
400 Mismatch.EndpointType The %s is mismatched for %s and %s. %s在%s和%s中不匹配。
400 IncorrectStatus.VpcEndpointService The status of %s [%s] is incorrect. 资源%s [%s]的状态无效。
400 ResourceNotEnough.VSwitchIp The specified resource of VSwitchIp is not enough. vswitchip数量不够
400 VSwitchStatusNotAllowed The specified vswitch status is not Available. 交换机状态还未可用
400 QuotaExceeded.epZonePerEndpoint The quota of %s is exceeded, usage %s/%s. 用户单个endpoint可用区限制
400 QuotaExceeded.totalEpPerVpc The quota of %s is exceeded, usage %s/%s. 用户单个VPC终端节点数量限额。
400 QuotaExceeded.totalIdleEndpoint The quota of %s is exceeded, usage %s/%s. 用户空闲未连接endpoint总数限制

访问错误中心查看更多错误码。