All Products
Search
Document Center

AddEndPoint

Last Updated: Mar 05, 2019

Description

You can call this operation to add an endpoint based on input parameters.

Because creating an endpoint is an asynchronous task, the response may contain some parameters without values. You need to call the GetEndPoint operation to asynchronously query endpoint data.

Request parameters

Name Type Required Description
Action String Yes The operation that you want to perform. Set the value to AddEndPoint.
RegionID String Yes The ID of the region where you make the request. For more information, see DLA regions in Appendix.
NetworkType String Yes The network type of the endpoint. Fixed value: vpc_singletunnel_jdbc (VPC network).
VpcID String No The VPC ID of the endpoint.
Vswitch String No The VSwitch of the endpoint.
Zone String No The zone of the endpoint.

Response parameters

Name Type Description
Common response parameters - For more information, see Common parameters.
RequestId String The GUID generated by Alibaba Cloud for the request.
RegionId String The ID of the region where you make the request.
EndPointInfo EndPointInfo The endpoint information.

EndPointInfo

Name Type Description
endPointID String The endpoint ID.
domainURL String The domain URL that contains the port number in string.
networkType String The network type of the endpoint. Valid values:
  • classic_jdbc: indicates classic network.
  • vpc_singletunnel_jdbc: indicates VPC network.
host String The IP access point for the endpoint.
port String The port number.
vpcID String The VPC ID of the endpoint.
vSwitch String The VSwitch ID of the endpoint.
zone String The zone of the endpoint.
allowIP String The IP address whitelist (for classic networks only).

Sample requests

  1. http://openanalytics.cn-hangzhou.aliyuncs.com/?Action=AddEndPoint
  2. &RegionID=<RegionID>, for example, cn-hangzhou
  3. &NetworkType=vpc_singletunnel_jdbc
  4. &VpcID=vpc-bp16tlwaa6zwujcp3yaj9
  5. &Vswitch=vsw-bp120wq3zzmk32yga4dck
  6. &Zone=cn-hangzhou-g
  7. &<Common request parameters>

Sample responses

XML format

  1. <AddEndPointResponse>
  2. <RequestId>A0FE6204-EBAF-4CF8-A0C0-1E8DFD995A37</RequestId>
  3. <RegionId>cn-hangzhou</RegionId>
  4. <EndPointInfo>
  5. <endPointID>054fa02e103bce6c51ef7bb1ba3ec792</endPointID>
  6. <domainURL>1863300811000000-123cdd49.cn-hangzhou.datalakeanalytics.aliyuncs.com:10000</domainURL>
  7. <networkType>vpc_singletunnel_jdbc</networkType>
  8. <host>101.37.1.234</host>
  9. <port>10000</port>
  10. <vpcID>vpc-bp16tlwaa6zwujcp3yaj9</vpcID>
  11. <vSwitch>vsw-bp120wq3zzmk32yga4dck</vSwitch>
  12. <zone>cn-hangzhou-g</zone>
  13. <allowIP></allowIP>
  14. </EndPointInfo>
  15. </AddEndPointResponse>

JSON format

  1. {
  2. "RegionId": "cn-hangzhou",
  3. "RequestId": "A0FE6204-EBAF-4CF8-A0C0-1E8DFD995A37",
  4. "EndPointInfo": {
  5. "endPointID": "054fa02e103bce6c51ef7bb1ba3ec792",
  6. "domainURL": "",
  7. "networkType": "vpc_singletunnel_jdbc",
  8. "host": "",
  9. "port": "",
  10. "vpcID": "vpc-bp16tlwaa6zwujcp3yaj9",
  11. "vSwitch": "vsw-bp120wq3zzmk32yga4dck",
  12. "zone": "cn-hangzhou-g",
  13. "allowIP": ""
  14. }
  15. }