outscale_api 1.17.0

Outscale API SDK
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101

# \RouteApi

All URIs are relative to *https://api.eu-west-2.outscale.com/api/v1*

Method | HTTP request | Description
------------- | ------------- | -------------
[**create_route**](RouteApi.md#create_route) | **POST** /CreateRoute | 
[**delete_route**](RouteApi.md#delete_route) | **POST** /DeleteRoute | 
[**update_route**](RouteApi.md#update_route) | **POST** /UpdateRoute | 



## create_route

> crate::models::CreateRouteResponse create_route(create_route_request)


Creates a route in a specified route table within a specified Net.<br /> You must specify one of the following elements as the target:<br /><br />  * Net peering<br /> * NAT VM<br /> * Internet service<br /> * Virtual gateway<br /> * NAT service<br /> * Network interface card (NIC)<br /><br />  The routing algorithm is based on the most specific match.<br /><br /> For more information, see [About Route Tables](https://docs.outscale.com/en/userguide/About-Route-Tables.html).

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**create_route_request** | Option<[**CreateRouteRequest**](CreateRouteRequest.md)> |  |  |

### Return type

[**crate::models::CreateRouteResponse**](CreateRouteResponse.md)

### Authorization

[ApiKeyAuth](../README.md#ApiKeyAuth)

### HTTP request headers

- **Content-Type**: application/json
- **Accept**: application/json

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)


## delete_route

> crate::models::DeleteRouteResponse delete_route(delete_route_request)


Deletes a route from a specified route table.

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**delete_route_request** | Option<[**DeleteRouteRequest**](DeleteRouteRequest.md)> |  |  |

### Return type

[**crate::models::DeleteRouteResponse**](DeleteRouteResponse.md)

### Authorization

[ApiKeyAuth](../README.md#ApiKeyAuth)

### HTTP request headers

- **Content-Type**: application/json
- **Accept**: application/json

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)


## update_route

> crate::models::UpdateRouteResponse update_route(update_route_request)


Replaces an existing route within a route table in a Net.<br /> You must specify one of the following elements as the target:<br /><br />  * Net peering<br /> * NAT virtual machine (VM)<br /> * Internet service<br /> * Virtual gateway<br /> * NAT service<br /> * Network interface card (NIC)<br /><br />  The routing algorithm is based on the most specific match.

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**update_route_request** | Option<[**UpdateRouteRequest**](UpdateRouteRequest.md)> |  |  |

### Return type

[**crate::models::UpdateRouteResponse**](UpdateRouteResponse.md)

### Authorization

[ApiKeyAuth](../README.md#ApiKeyAuth)

### HTTP request headers

- **Content-Type**: application/json
- **Accept**: application/json

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)