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
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132

# \SubnetApi

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

Method | HTTP request | Description
------------- | ------------- | -------------
[**create_subnet**](SubnetApi.md#create_subnet) | **POST** /CreateSubnet | 
[**delete_subnet**](SubnetApi.md#delete_subnet) | **POST** /DeleteSubnet | 
[**read_subnets**](SubnetApi.md#read_subnets) | **POST** /ReadSubnets | 
[**update_subnet**](SubnetApi.md#update_subnet) | **POST** /UpdateSubnet | 



## create_subnet

> crate::models::CreateSubnetResponse create_subnet(create_subnet_request)


Creates a Subnet in an existing Net.<br /> To create a Subnet in a Net, you have to provide the ID of the Net and the IP range for the Subnet (its network range). Once the Subnet is created, you cannot modify its IP range.<br /><br /> For more information, see [About Nets](https://docs.outscale.com/en/userguide/About-Nets.html).

### Parameters


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

### Return type

[**crate::models::CreateSubnetResponse**](CreateSubnetResponse.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_subnet

> crate::models::DeleteSubnetResponse delete_subnet(delete_subnet_request)


Deletes a specified Subnet.<br /> Before deleting the Subnet, you need to delete all resources associated with the Subnet:<br /><br />  * Virtual machines (VMs)<br /> * Network Interface Cards (NICs)<br /> * NAT services<br /> * Load balancers

### Parameters


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

### Return type

[**crate::models::DeleteSubnetResponse**](DeleteSubnetResponse.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)


## read_subnets

> crate::models::ReadSubnetsResponse read_subnets(read_subnets_request)


Lists one or more of your Subnets.<br /> If you do not specify any Subnet ID, this action describes all of your Subnets.

### Parameters


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

### Return type

[**crate::models::ReadSubnetsResponse**](ReadSubnetsResponse.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_subnet

> crate::models::UpdateSubnetResponse update_subnet(update_subnet_request)


Modifies the specified attribute of a Subnet.

### Parameters


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

### Return type

[**crate::models::UpdateSubnetResponse**](UpdateSubnetResponse.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)