Creates a virtual private cloud (VPC) endpoint.

Note The creation of a VPC endpoint is an asynchronous operation. Therefore, some parameters in the response may be empty. You can call the GetEndPoint operation to query the data of the VPC endpoint in an asynchronous manner.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.

Request parameters

Parameter Type Required Example Description
Action String Yes AddEndPoint

The operation that you want to perform. Set the value to AddEndPoint.

NetworkType String Yes vpc_singletunnel_jdbc

The network type.

Product String Yes openanalytics

The name of the service.

RegionId String Yes cn-hangzhou

The region ID.

VpcID String Yes vpc-bp1g66t4f0onrvbht****

The ID of the VPC.

Vswitch String Yes vsw-bp1nh5ri8di2q7tko****

The ID of the vSwitch.

Zone String Yes cn-hangzhou-g

The zone ID.

Response parameters

Parameter Type Example Description
EndPointInfo Struct

The information of the VPC endpoint.

allowIP String 10.0.0.1

The IP address that is allowed to access DLA.

domainURL String jdbc:mysql://34502231286****-6422****.cn-hangzhou.datalakeanalytics.aliyuncs.com:10000

The URL of the VPC endpoint.

endPointID String c9b2a71c786311bf2772837dc98*****

The ID of the VPC endpoint.

host String jdbc:mysql://34502231286****-6422****.cn-hangzhou.datalakeanalytics.aliyuncs.com

The URL of the host.

networkType String vpc_singletunnel_jdbc

The network type.

port String 10000

The port number of the vSwitch.

product String openanalytics

The name of the service.

status String active

The status of the VPC endpoint.

vSwitch String vsw-bp182ub0e8g16oyi3****

The ID of the vSwitch.

vpcID String vpc-bp15jfhv9yxrtsru9****

The ID of the VPC.

zone String cn-hangzhou-b

The zone ID.

RegionId String cn-hangzhou

The region ID.

RequestId String 8A840E5A-37DC-4178-81C1-367E733DA558

The ID of the request.

Examples

Sample requests

http(s)://[Endpoint]/?Action=AddEndPoint
&NetworkType=vpc_singletunnel_jdbc
&Product=openanalytics
&RegionId=cn-hangzhou
&VpcID=vpc-bp1g66t4f0onrvbht****
&Vswitch=vsw-bp1nh5ri8di2q7tko****
&Zone=cn-hangzhou-g
&<Common request parameters>

Sample success responses

XML format

<RequestId>8A840E5A-37DC-4178-81C1-367E733DA558</RequestId>
<EndPointInfo>
    <product>openanalytics</product>
    <zone>cn-hangzhou-b</zone>
    <vSwitch>vsw-bp182ub0e8g16oyi3****</vSwitch>
    <port>10000</port>
    <vpcID>vpc-bp15jfhv9yxrtsru9****</vpcID>
    <host>jdbc:mysql://34502231286****-6422****.cn-hangzhou.datalakeanalytics.aliyuncs.com</host>
    <networkType>vpc_singletunnel_jdbc</networkType>
    <allowIP>10.0.0.1</allowIP>
    <domainURL>jdbc:mysql://34502231286****-6422****.cn-hangzhou.datalakeanalytics.aliyuncs.com:10000</domainURL>
    <endPointID>c9b2a71c786311bf2772837dc98*****</endPointID>
    <status>active</status>
</EndPointInfo>
<RegionId>cn-hangzhou</RegionId>

JSON format

{"RequestId":"8A840E5A-37DC-4178-81C1-367E733DA558","EndPointInfo":{"product":"openanalytics","zone":"cn-hangzhou-b","vSwitch":"vsw-bp182ub0e8g16oyi3****","port":"10000","vpcID":"vpc-bp15jfhv9yxrtsru9****","host":"jdbc:mysql://34502231286****-6422****.cn-hangzhou.datalakeanalytics.aliyuncs.com","networkType":"vpc_singletunnel_jdbc","allowIP":"10.0.0.1","domainURL":"jdbc:mysql://34502231286****-6422****.cn-hangzhou.datalakeanalytics.aliyuncs.com:10000","endPointID":"c9b2a71c786311bf2772837dc98*****","status":"active"},"RegionId":"cn-hangzhou"}

Error codes

For a list of error codes, visit the API Error Center.