Using Service Plane APIs

Updated on 2023-03-18 GMT+08:00

View PDF

You can access the service plane APIs by anyone of the following methods:

Through the ECS. The VPC for creating the ECS must be the same as that selected during graph creation. If the same security group is selected, you can directly access the APIs. If the security groups are not the same, enable the access permission for the ECS in the security group where the graph is created. That is, enable ports 80 and 443 for inbound traffic and all ports for outbound traffic. The ingress and egress ports support HTTP and HTTPS access respectively. In this scenario, SERVER_URL of the APIs is the private access address in the graph details on the GES console or the value of the privateIp field in the response body of the management plane API for querying graph details.
Through the ECS. The VPC for creating the ECS is not the same as that selected during graph creation. You need to create a VPC peering connection between the VPC to which the ECS belongs and the VPC in which the graph is created. In addition, you need to enable the access permission for the ECS in the security group where the graph is created. That is, enable ports 80 and 443 for inbound traffic and all ports for outbound traffic. In this scenario, SERVER_URL of the APIs is the private access address in the graph details on the GES console or the value of the privateIp field in the response body of the management plane API for querying graph details.
Through the public network. You need to create an EIP and enable the access permission for the client in the security group where the graph is created, that is, enable ports 80 and 443 for inbound traffic and all ports for outbound traffic. In this scenario, SERVER_URL of the APIs is the public access address in the graph details on the GES console or the value of the publicIp field in the response body of the management plane API for querying graph details (also the EIP you bind or create).