Skip to content

Commit e177793

Browse files
committed
Update README.md
1 parent c1703c6 commit e177793

File tree

1 file changed

+6
-6
lines changed

1 file changed

+6
-6
lines changed

README.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -2,13 +2,13 @@
22

33
![api](./readme/boto3.jpg)
44

5-
### Python API uses Flask and Boto3 libraries. It has the features of Instance listing, Instance start and Instance stop; it has 3 endpoints communicate with EC2 service on AWS.
5+
### Python API uses the Flask and Boto3 libraries. It has instance listing, instance start, instance stop, instance create and instance terminate features; It has 5 endpoints communicating with EC2 service on AWS.
66

77
---
88

99
## Create Instance
1010

11-
You send a POST request to the `create` endpoint with the following parameters and it will create an instance with the given parameters.
11+
You send a POST request to the `create` endpoint with the following parameters and it will create Ubuntu EC2 instance. You create your EC2 Instance with the `region_name`, `KeyName` and `SecurityGroupId` parameters you send in the request.
1212

1313
```
1414
http://<api_host>:<api_port>/ec2/create
@@ -26,7 +26,7 @@ http://<api_host>:<api_port>/ec2/create
2626

2727
## List Instances
2828

29-
You send a request to this endpoint by entering the following parameters, and you can list all the instances in your AWS account in the region you specify and their status.
29+
You send a GET request to the `list` endpoint by entering the following parameters, then you can list all the instances and their status in your AWS account in the region you specify.
3030

3131
```
3232
http://<api_host>:<api_port>/ec2/list
@@ -42,7 +42,7 @@ http://<api_host>:<api_port>/ec2/list
4242

4343
## Start Instance
4444

45-
You send a request to this endpoint by entering the following parameters, and you can start the instance you specified with `instance_id`, in the region you specified with `region_name` and the status of the instance will be changed to `pending` and then to `running`.
45+
You send a POST request to the `start` endpoint by entering the following parameters, and you can start the instance you specified with `instance_id`, in the region you specified with `region_name` and the status of the instance will be changed to `pending` and then to `running`.
4646

4747
```
4848
http://<api_host>:<api_port>/ec2/start
@@ -59,7 +59,7 @@ http://<api_host>:<api_port>/ec2/start
5959

6060
## Stop Instance
6161

62-
You send a request to this endpoint by entering the following parameters, and you can stop the instance you specified with `instance_id`, in the region you specified with `region_name` and the status of the instance will be changed to `stopping` and then to `stopped`.
62+
You send a POST request to the `stop` endpoint by entering the following parameters, and you can stop the instance you specified with `instance_id`, in the region you specified with `region_name` and the status of the instance will be changed to `stopping` and then to `stopped`.
6363

6464
```
6565
http://<api_host>:<api_port>/ec2/stop
@@ -76,7 +76,7 @@ http://<api_host>:<api_port>/ec2/stop
7676

7777
## Terminate Instance
7878

79-
You send a request to this endpoint by entering the following parameters, and you can terminate the instance you specified with `instance_id`, in the region you specified with `region_name` and the status of the instance will be changed to `shutting-down` and then `terminated`.
79+
You send a POST request to the `terminate` endpoint by entering the following parameters, and you can terminate the instance you specified with `instance_id`, in the region you specified with `region_name` and the status of the instance will be changed to `shutting-down` and then `terminated`.
8080

8181
```
8282
http://<api_host>:<api_port>/ec2/terminate

0 commit comments

Comments
 (0)