Skip to content

Latest commit

 

History

History
257 lines (135 loc) · 7.07 KB

InstancePoolApi.md

File metadata and controls

257 lines (135 loc) · 7.07 KB

\InstancePoolApi

All URIs are relative to https://api-ch-gva-2.exoscale.com/v2

Method HTTP request Description
create_instance_pool POST /instance-pool Create an Instance Pool
delete_instance_pool DELETE /instance-pool/{id} Delete an Instance Pool
evict_instance_pool_members PUT /instance-pool/{id}:evict Evict Instance Pool members
get_instance_pool GET /instance-pool/{id} Retrieve Instance Pool details
list_instance_pools GET /instance-pool List Instance Pools
reset_instance_pool_field DELETE /instance-pool/{id}/{field} Reset an Instance Pool field to its default value
scale_instance_pool PUT /instance-pool/{id}:scale Scale an Instance Pool
update_instance_pool PUT /instance-pool/{id} Update an Instance Pool

create_instance_pool

models::Operation create_instance_pool(create_instance_pool_request) Create an Instance Pool

Parameters

Name Type Description Required Notes
create_instance_pool_request CreateInstancePoolRequest [required]

Return type

models::Operation

Authorization

No authorization required

HTTP request headers

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

delete_instance_pool

models::Operation delete_instance_pool(id) Delete an Instance Pool

Parameters

Name Type Description Required Notes
id uuid::Uuid [required]

Return type

models::Operation

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

evict_instance_pool_members

models::Operation evict_instance_pool_members(id, evict_instance_pool_members_request) Evict Instance Pool members

This operation evicts the specified Compute instances member from the Instance Pool, shrinking it to <current pool size> - <# evicted members>.

Parameters

Name Type Description Required Notes
id uuid::Uuid [required]
evict_instance_pool_members_request EvictInstancePoolMembersRequest [required]

Return type

models::Operation

Authorization

No authorization required

HTTP request headers

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

get_instance_pool

models::InstancePool get_instance_pool(id) Retrieve Instance Pool details

Parameters

Name Type Description Required Notes
id uuid::Uuid [required]

Return type

models::InstancePool

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

list_instance_pools

models::ListInstancePools200Response list_instance_pools() List Instance Pools

Parameters

This endpoint does not need any parameter.

Return type

models::ListInstancePools200Response

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

reset_instance_pool_field

models::Operation reset_instance_pool_field(id, field) Reset an Instance Pool field to its default value

Parameters

Name Type Description Required Notes
id uuid::Uuid [required]
field String [required]

Return type

models::Operation

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

scale_instance_pool

models::Operation scale_instance_pool(id, scale_instance_pool_request) Scale an Instance Pool

Parameters

Name Type Description Required Notes
id uuid::Uuid [required]
scale_instance_pool_request ScaleInstancePoolRequest [required]

Return type

models::Operation

Authorization

No authorization required

HTTP request headers

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

update_instance_pool

models::Operation update_instance_pool(id, update_instance_pool_request) Update an Instance Pool

Parameters

Name Type Description Required Notes
id uuid::Uuid [required]
update_instance_pool_request UpdateInstancePoolRequest [required]

Return type

models::Operation

Authorization

No authorization required

HTTP request headers

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]