All Products
Search
Document Center

GetEndPoint

Last Updated: Mar 05, 2019

Description

You can call this operation to query the details about an endpoint.

Request parameters

Name Type Required Description
Action String Yes The operation that you want to perform. Set the value to GetEndPoint.
RegionID String Yes The ID of the region where you make the request. For more information, see DLA regions in Appendix.
EndPointID String Yes The ID of the endpoint whose details you want to query.

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 details of the endpoint

EndPointInfo

Name Type Description
endPointID String Ednpoint ID
status String The endpoint status. Valid values:
  • Active: The endpoint is normal.
  • Initialize: A new endpoint is in this status before it becomes available.
  • Deleting: An endpoint is in this status before it is completely removed.
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 (for VPC networks only).
vSwitch String The virtual gateway ID of the endpoint (for VPC networks only).
zone String The zone of the endpoint (for VPC networks only).
allowIP String The IP address whitelist (for classic networks only).

Sample requests

  1. http://openanalytics.cn-hangzhou.aliyuncs.com/?Action=GetEndPoint
  2. &RegionID=<RegionID>, for example, cn-hangzhou
  3. &EndPointID=c857fa0607f451a2000000f7bf2704be
  4. &<Common request parameters>

Sample responses

XML format

  1. <GetEndPointResponse>
  2. <RequestId>A0FE6204-EBAF-4CF8-A0C0-1E8DFD995A37</RequestId>
  3. <RegionId>cn-hangzhou</RegionId>
  4. <EndPointInfo>
  5. <endPointID>c857fa0607f451a2000000f7bf2704be</endPointID>
  6. <status>Active</status>
  7. <domainURL>1863300811000000-123cdd49.cn-hangzhou.datalakeanalytics.aliyuncs.com:10000</domainURL>
  8. <networkType>classic_jdbc</networkType>
  9. <host>101.37.1.234</host>
  10. <port>10000</port>
  11. <vpcID></vpcID>
  12. <vSwitch></vSwitch>
  13. <zone></zone>
  14. <allowIP>0.0.0.0/0</allowIP>
  15. </EndPointInfo>
  16. </GetEndPointResponse>

JSON format

  1. {
  2. "RegionId": "cn-hangzhou",
  3. "RequestId": "A0FE6204-EBAF-4CF8-A0C0-1E8DFD995A37",
  4. "EndPointInfo": {
  5. "port": "10000",
  6. "domainURL": "1863300811000000-123cdd49.cn-hangzhou.datalakeanalytics.aliyuncs.com:10000",
  7. "allowIP": "0.0.0.0/0",
  8. "networkType": "classic_jdbc",
  9. "cloudInstanceID": "",
  10. "host": "101.37.1.234",
  11. "vpcID": "",
  12. "status": "Active",
  13. "vSwitch": "",
  14. "zone": "",
  15. "endPointID": "c857fa0607f451a2000000f7bf2704be"
  16. }
  17. }