Skip to content

Latest commit

 

History

History
179 lines (105 loc) · 6.83 KB

File metadata and controls

179 lines (105 loc) · 6.83 KB

\TableApi

All URIs are relative to http://127.0.0.1/v2

Method HTTP request Description
create_table POST /services/haproxy/configuration/tables Add a new table
delete_table DELETE /services/haproxy/configuration/tables/{name} Delete a table
get_table GET /services/haproxy/configuration/tables/{name} Return one table
get_tables GET /services/haproxy/configuration/tables Return an array of tables
replace_table PUT /services/haproxy/configuration/tables/{name} Replace a table

create_table

crate::models::Table create_table(peer_section, table, transaction_id, version, force_reload) Add a new table

Adds a new table in the specified peer section in the configuration file.

Parameters

Name Type Description Required Notes
peer_section String Parent peer section name [required]
table Table [required]
transaction_id Option<String> ID of the transaction where we want to add the operation. Cannot be used when version is specified.
version Option<i32> Version used for checking configuration version. Cannot be used when transaction is specified, transaction has it's own version.
force_reload Option<bool> If set, do a force reload, do not wait for the configured reload-delay. Cannot be used when transaction is specified, as changes in transaction are not applied directly to configuration. [default to false]

Return type

crate::models::Table

Authorization

basic_auth

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_table

delete_table(name, peer_section, transaction_id, version, force_reload) Delete a table

Deletes a table configuration by it's name in the specified peer section.

Parameters

Name Type Description Required Notes
name String Table name [required]
peer_section String Parent peers name [required]
transaction_id Option<String> ID of the transaction where we want to add the operation. Cannot be used when version is specified.
version Option<i32> Version used for checking configuration version. Cannot be used when transaction is specified, transaction has it's own version.
force_reload Option<bool> If set, do a force reload, do not wait for the configured reload-delay. Cannot be used when transaction is specified, as changes in transaction are not applied directly to configuration. [default to false]

Return type

(empty response body)

Authorization

basic_auth

HTTP request headers

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

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

get_table

crate::models::GetTable200Response get_table(name, peer_section, transaction_id) Return one table

Returns one table configuration by it's name in the specified peer section.

Parameters

Name Type Description Required Notes
name String Table name [required]
peer_section String Parent peers name [required]
transaction_id Option<String> ID of the transaction where we want to add the operation. Cannot be used when version is specified.

Return type

crate::models::GetTable200Response

Authorization

basic_auth

HTTP request headers

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

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

get_tables

crate::models::GetTables200Response get_tables(peer_section, transaction_id) Return an array of tables

Returns an array of all tables that are configured in specified peer section.

Parameters

Name Type Description Required Notes
peer_section String Parent peer section name [required]
transaction_id Option<String> ID of the transaction where we want to add the operation. Cannot be used when version is specified.

Return type

crate::models::GetTables200Response

Authorization

basic_auth

HTTP request headers

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

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

replace_table

crate::models::Table replace_table(name, peer_section, table, transaction_id, version, force_reload) Replace a table

Replaces a table configuration by it's name in the specified peer section.

Parameters

Name Type Description Required Notes
name String Table name [required]
peer_section String Parent peers name [required]
table Table [required]
transaction_id Option<String> ID of the transaction where we want to add the operation. Cannot be used when version is specified.
version Option<i32> Version used for checking configuration version. Cannot be used when transaction is specified, transaction has it's own version.
force_reload Option<bool> If set, do a force reload, do not wait for the configured reload-delay. Cannot be used when transaction is specified, as changes in transaction are not applied directly to configuration. [default to false]

Return type

crate::models::Table

Authorization

basic_auth

HTTP request headers

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

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