调用CreateVpcEndpoint创建终端节点。

调试

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

请求参数

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

要执行的操作,取值:CreateVpcEndpoint

RegionId String eu-west-1

要创建的终端节点的地域ID。您可以通过调用DescribeRegions接口获取地域ID。

SecurityGroupId.N RepeatList sg-hp33bw6ynvm2yb0e****

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

N的取值范围为1~10

ServiceId String epsrv-hp3xdsq46ael67lo****

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

VpcId String vpc-hp356stwkxg3fn2xe****

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

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

保证请求幂等性。从您的客户端生成一个参数值,确保不同请求间该参数值唯一。ClientToken只支持ASCII字符,且不能超过64个字符。

DryRun Boolean false

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

true:发送检查请求,不会创建终端节点。检查项包括AccessKey是否有效、RAM用户的授权情况和是否填写了必需参数。如果检查不通过,则返回对应错误。如果检查通过,会返回错误码DryRunOperation

false(默认值):发送正常请求,通过检查后返回2XX HTTP状态码并直接创建终端节点。

EndpointName String test

终端节点名称。

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

EndpointDescription String This is my Endpoint.

终端节点描述。

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

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

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

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

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

N的取值范围为1~10

Zone.N.ZoneId String eu-west-1a

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

N的取值范围为1~10

Zone.N.ip String 192.168.XX.XX

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

N的取值范围为1~10

返回数据

名称 类型 示例值 描述
Bandwidth Long 1024

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

ConnectionStatus String Disconnected

终端节点连接状态:

  • Pending:修改中。
  • Connecting:连接中。
  • Connected:已连接。
  • Disconnecting:断开连接中。
  • Disconnected:未连接。
  • Deleting:删除中。
CreateTime String 2020-01-02T19:11:12Z

终端节点的创建时间。

EndpointBusinessStatus String Normal

终端节点的业务状态:

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

终端节点描述。

EndpointDomain String ep-hp33b2e43fays7s8****.epsrv-hp3xdsq46ael67lo****.cn-huhehaote.privatelink.aliyuncs.com

终端节点域名。

EndpointId String ep-hp33b2e43fays7s8****

终端节点ID。

EndpointName String test

终端节点名称。

EndpointStatus String Active

终端节点状态:

  • Creating:创建中。
  • Active:可用。
  • Pending:修改中。
  • Deleting:删除中。
RequestId String 0ED8D006-F706-4D23-88ED-E11ED28DCAC0

请求ID。

ServiceId String epsrv-hp3vpx8yqxblby3i****

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

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

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

VpcId String vpc-hp356stwkxg3fn2xe****

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

示例

请求示例

http(s)://[Endpoint]/?Action=CreateVpcEndpoint
&RegionId=eu-west-1
&SecurityGroupId.1=sg-hp33bw6ynvm2yb0e****
&ServiceId=epsrv-hp3xdsq46ael67lo****
&VpcId=vpc-hp356stwkxg3fn2xe****
&<公共请求参数>

正常返回示例

XML格式

<CreateVpcEndpointResponse> 
  <EndpointDomain>ep-hp33b2e43fays7s8****.epsrv-hp3xdsq46ael67lo****.cn-huhehaote.privatelink.aliyuncs.com</EndpointDomain>
  <RequestId>0ED8D006-F706-4D23-88ED-E11ED28DCAC0</RequestId>
  <CreateTime>2020-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>1024</Bandwidth>
  <EndpointId>ep-hp33b2e43fays7s8****</EndpointId>
  <ConnectionStatus>Disconnected</ConnectionStatus>
</CreateVpcEndpointResponse>

JSON格式

{
    "EndpointDomain": "ep-hp33b2e43fays7s8****.epsrv-hp3xdsq46ael67lo****.cn-huhehaote.privatelink.aliyuncs.com",
    "RequestId": "0ED8D006-F706-4D23-88ED-E11ED28DCAC0",
    "CreateTime": "2020-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": 1024,
    "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. 终端节点服务未授权给用户。

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