Skip to content

Latest commit

 

History

History
384 lines (248 loc) · 13.7 KB

NetworkGroupnetsApi.md

File metadata and controls

384 lines (248 loc) · 13.7 KB
Raw

\NetworkGroupnetsApi

All URIs are relative to https://YOUR_CLUSTER_HOSTNAME_OR_NODE_IP:8080

Method HTTP request Description
CreateGroupnetSubnet Post /platform/4/network/groupnets/{Groupnet}/subnets
CreateSubnetsSubnetPool Post /platform/3/network/groupnets/{Groupnet}/subnets/{Subnet}/pools
DeleteGroupnetSubnet Delete /platform/4/network/groupnets/{Groupnet}/subnets/{GroupnetSubnetId}
DeleteSubnetsSubnetPool Delete /platform/3/network/groupnets/{Groupnet}/subnets/{Subnet}/pools/{SubnetsSubnetPoolId}
GetGroupnetSubnet Get /platform/4/network/groupnets/{Groupnet}/subnets/{GroupnetSubnetId}
GetSubnetsSubnetPool Get /platform/3/network/groupnets/{Groupnet}/subnets/{Subnet}/pools/{SubnetsSubnetPoolId}
ListGroupnetSubnets Get /platform/4/network/groupnets/{Groupnet}/subnets
ListSubnetsSubnetPools Get /platform/3/network/groupnets/{Groupnet}/subnets/{Subnet}/pools
UpdateGroupnetSubnet Put /platform/4/network/groupnets/{Groupnet}/subnets/{GroupnetSubnetId}
UpdateSubnetsSubnetPool Put /platform/3/network/groupnets/{Groupnet}/subnets/{Subnet}/pools/{SubnetsSubnetPoolId}

CreateGroupnetSubnet

CreateResponse CreateGroupnetSubnet(ctx, groupnetSubnet, groupnet)

Create a new subnet.

Required Parameters

Name Type Description Notes
ctx context.Context context for logging, tracing, authentication, etc.
groupnetSubnet GroupnetSubnetCreateParams
groupnet string

Return type

CreateResponse

Authorization

basicAuth

HTTP request headers

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

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

CreateSubnetsSubnetPool

CreateResponse CreateSubnetsSubnetPool(ctx, subnetsSubnetPool, groupnet, subnet, optional)

Create a new pool.

Required Parameters

Name Type Description Notes
ctx context.Context context for logging, tracing, authentication, etc.
subnetsSubnetPool SubnetsSubnetPoolCreateParams
groupnet string
subnet string
optional map[string]interface{} optional parameters nil if no parameters

Optional Parameters

Optional parameters are passed through a map[string]interface{}.

Name Type Description Notes
subnetsSubnetPool SubnetsSubnetPoolCreateParams
groupnet string
subnet string
force bool Force creating this pool even if it causes an MTU conflict.

Return type

CreateResponse

Authorization

basicAuth

HTTP request headers

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

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

DeleteGroupnetSubnet

DeleteGroupnetSubnet(ctx, groupnetSubnetId, groupnet, optional)

Delete a network subnet..

Required Parameters

Name Type Description Notes
ctx context.Context context for logging, tracing, authentication, etc.
groupnetSubnetId string Delete a network subnet..
groupnet string
optional map[string]interface{} optional parameters nil if no parameters

Optional Parameters

Optional parameters are passed through a map[string]interface{}.

Name Type Description Notes
groupnetSubnetId string Delete a network subnet..
groupnet string
force bool force deleting this subnet even if pools in other subnets rely on this subnet's SC VIP.

Return type

(empty response body)

Authorization

basicAuth

HTTP request headers

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

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

DeleteSubnetsSubnetPool

DeleteSubnetsSubnetPool(ctx, subnetsSubnetPoolId, groupnet, subnet)

Delete a network pool.

Required Parameters

Name Type Description Notes
ctx context.Context context for logging, tracing, authentication, etc.
subnetsSubnetPoolId string Delete a network pool.
groupnet string
subnet string

Return type

(empty response body)

Authorization

basicAuth

HTTP request headers

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

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

GetGroupnetSubnet

GroupnetSubnets GetGroupnetSubnet(ctx, groupnetSubnetId, groupnet)

View a network subnet.

Required Parameters

Name Type Description Notes
ctx context.Context context for logging, tracing, authentication, etc.
groupnetSubnetId string View a network subnet.
groupnet string

Return type

GroupnetSubnets

Authorization

basicAuth

HTTP request headers

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

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

GetSubnetsSubnetPool

SubnetsSubnetPools GetSubnetsSubnetPool(ctx, subnetsSubnetPoolId, groupnet, subnet)

View a single network pool.

Required Parameters

Name Type Description Notes
ctx context.Context context for logging, tracing, authentication, etc.
subnetsSubnetPoolId string View a single network pool.
groupnet string
subnet string

Return type

SubnetsSubnetPools

Authorization

basicAuth

HTTP request headers

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

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

ListGroupnetSubnets

GroupnetSubnetsExtended ListGroupnetSubnets(ctx, groupnet, optional)

Get a list of subnets.

Required Parameters

Name Type Description Notes
ctx context.Context context for logging, tracing, authentication, etc.
groupnet string
optional map[string]interface{} optional parameters nil if no parameters

Optional Parameters

Optional parameters are passed through a map[string]interface{}.

Name Type Description Notes
groupnet string
sort string The field that will be used for sorting.
limit int32 Return no more than this many results at once (see resume).
dir string The direction of the sort.
resume string Continue returning results from previous call using this token (token should come from the previous call, resume cannot be used with other options).

Return type

GroupnetSubnetsExtended

Authorization

basicAuth

HTTP request headers

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

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

ListSubnetsSubnetPools

SubnetsSubnetPoolsExtended ListSubnetsSubnetPools(ctx, groupnet, subnet, optional)

Get a list of network pools.

Required Parameters

Name Type Description Notes
ctx context.Context context for logging, tracing, authentication, etc.
groupnet string
subnet string
optional map[string]interface{} optional parameters nil if no parameters

Optional Parameters

Optional parameters are passed through a map[string]interface{}.

Name Type Description Notes
groupnet string
subnet string
sort string The field that will be used for sorting.
resume string Continue returning results from previous call using this token (token should come from the previous call, resume cannot be used with other options).
accessZone string If specified, only pools with this zone name will be returned.
allocMethod string If specified, only pools with this allocation type will be returned.
limit int32 Return no more than this many results at once (see resume).
dir string The direction of the sort.

Return type

SubnetsSubnetPoolsExtended

Authorization

basicAuth

HTTP request headers

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

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

UpdateGroupnetSubnet

UpdateGroupnetSubnet(ctx, groupnetSubnet, groupnetSubnetId, groupnet, optional)

Modify a network subnet.

Required Parameters

Name Type Description Notes
ctx context.Context context for logging, tracing, authentication, etc.
groupnetSubnet GroupnetSubnet
groupnetSubnetId string Modify a network subnet.
groupnet string
optional map[string]interface{} optional parameters nil if no parameters

Optional Parameters

Optional parameters are passed through a map[string]interface{}.

Name Type Description Notes
groupnetSubnet GroupnetSubnet
groupnetSubnetId string Modify a network subnet.
groupnet string
force bool force modifying this subnet even if it causes an MTU conflict.

Return type

(empty response body)

Authorization

basicAuth

HTTP request headers

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

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

UpdateSubnetsSubnetPool

UpdateSubnetsSubnetPool(ctx, subnetsSubnetPool, subnetsSubnetPoolId, groupnet, subnet, optional)

Modify a network pool.

Required Parameters

Name Type Description Notes
ctx context.Context context for logging, tracing, authentication, etc.
subnetsSubnetPool SubnetsSubnetPool
subnetsSubnetPoolId string Modify a network pool.
groupnet string
subnet string
optional map[string]interface{} optional parameters nil if no parameters

Optional Parameters

Optional parameters are passed through a map[string]interface{}.

Name Type Description Notes
subnetsSubnetPool SubnetsSubnetPool
subnetsSubnetPoolId string Modify a network pool.
groupnet string
subnet string
force bool force creating this pool even if it causes an MTU conflict.

Return type

(empty response body)

Authorization

basicAuth

HTTP request headers

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

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