Skip to content

PoolApi.md

Latest commit

 

History

History
251 lines (177 loc) · 12.7 KB

PoolApi.md

File metadata and controls

251 lines (177 loc) · 12.7 KB

PoolApi

Note

All URIs are relative to https://api.fastly.com

Method HTTP request Description
create_server_pool POST /service/{service_id}/version/{version_id}/pool Create a server pool
delete_server_pool DELETE /service/{service_id}/version/{version_id}/pool/{pool_name} Delete a server pool
get_server_pool GET /service/{service_id}/version/{version_id}/pool/{pool_name} Get a server pool
list_server_pools GET /service/{service_id}/version/{version_id}/pool List server pools
update_server_pool PUT /service/{service_id}/version/{version_id}/pool/{pool_name} Update a server pool

create_server_pool

Creates a pool for a particular service and version.

let cfg = &Configuration::default();
let params = CreateServerPoolParams {
    // parameters
};
create_server_pool(cfg, params)

Parameters

Name Type Description Required Notes
service_id String Alphanumeric string identifying the service. [required]
version_id i32 Integer identifying a service version. [required]
tls_ca_cert Option<String> A secure certificate to authenticate a server with. Must be in PEM format. [default to null]
tls_client_cert Option<String> The client certificate used to make authenticated requests. Must be in PEM format. [default to null]
tls_client_key Option<String> The client private key used to make authenticated requests. Must be in PEM format. [default to null]
tls_cert_hostname Option<String> The hostname used to verify a server's certificate. It can either be the Common Name (CN) or a Subject Alternative Name (SAN). [default to null]
use_tls Option<i32> Whether to use TLS. [default to 0]
created_at Option<String> Date and time in ISO 8601 format.
deleted_at Option<String> Date and time in ISO 8601 format.
updated_at Option<String> Date and time in ISO 8601 format.
service_id2 Option<String>
version Option<String>
name Option<String> Name for the Pool.
shield Option<String> Selected POP to serve as a shield for the servers. Defaults to null meaning no origin shielding if not set. Refer to the POPs API endpoint to get a list of available POPs used for shielding. [default to null]
request_condition Option<String> Condition which, if met, will select this configuration during a request. Optional.
tls_ciphers Option<String> List of OpenSSL ciphers (see the openssl.org manpages for details). Optional.
tls_sni_hostname Option<String> SNI hostname. Optional.
min_tls_version Option<i32> Minimum allowed TLS version on connections to this server. Optional.
max_tls_version Option<i32> Maximum allowed TLS version on connections to this server. Optional.
healthcheck Option<String> Name of the healthcheck to use with this pool. Can be empty and could be reused across multiple backend and pools.
comment Option<String> A freeform descriptive note.
_type Option<String> What type of load balance group to use.
override_host Option<String> The hostname to override the Host header. Defaults to null meaning no override of the Host header will occur. This setting can also be added to a Server definition. If the field is set on a Server definition it will override the Pool setting. [default to null]
between_bytes_timeout Option<i32> Maximum duration in milliseconds that Fastly will wait while receiving no data on a download from a backend. If exceeded, for Delivery services, the response received so far will be considered complete and the fetch will end. For Compute services, timeout expiration is treated as a failure of the backend connection, and an error is generated. May be set at runtime using bereq.between_bytes_timeout. [default to 10000]
connect_timeout Option<i32> How long to wait for a timeout in milliseconds. Optional.
first_byte_timeout Option<i32> How long to wait for the first byte in milliseconds. Optional.
max_conn_default Option<i32> Maximum number of connections. Optional. [default to 200]
quorum Option<i32> Percentage of capacity (0-100) that needs to be operationally available for a pool to be considered up. [default to 75]
tls_check_cert Option<i32> Be strict on checking TLS certs. Optional.

Return type

crate::models::PoolResponsePost

Authorization

token

HTTP request headers

  • Content-Type: application/x-www-form-urlencoded
  • Accept: application/json

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

delete_server_pool

Deletes a specific pool for a particular service and version.

let cfg = &Configuration::default();
let params = DeleteServerPoolParams {
    // parameters
};
delete_server_pool(cfg, params)

Parameters

Name Type Description Required Notes
service_id String Alphanumeric string identifying the service. [required]
version_id i32 Integer identifying a service version. [required]
pool_name String Name for the Pool. [required]

Return type

crate::models::InlineResponse200

Authorization

token

HTTP request headers

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

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

get_server_pool

Gets a single pool for a particular service and version.

let cfg = &Configuration::default();
let params = GetServerPoolParams {
    // parameters
};
get_server_pool(cfg, params)

Parameters

Name Type Description Required Notes
service_id String Alphanumeric string identifying the service. [required]
version_id i32 Integer identifying a service version. [required]
pool_name String Name for the Pool. [required]

Return type

crate::models::PoolResponse

Authorization

token

HTTP request headers

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

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

list_server_pools

Lists all pools for a particular service and pool.

let cfg = &Configuration::default();
let params = ListServerPoolsParams {
    // parameters
};
list_server_pools(cfg, params)

Parameters

Name Type Description Required Notes
service_id String Alphanumeric string identifying the service. [required]
version_id i32 Integer identifying a service version. [required]

Return type

Vec<crate::models::PoolResponse>

Authorization

token

HTTP request headers

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

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

update_server_pool

Updates a specific pool for a particular service and version.

let cfg = &Configuration::default();
let params = UpdateServerPoolParams {
    // parameters
};
update_server_pool(cfg, params)

Parameters

Name Type Description Required Notes
service_id String Alphanumeric string identifying the service. [required]
version_id i32 Integer identifying a service version. [required]
pool_name String Name for the Pool. [required]
tls_ca_cert Option<String> A secure certificate to authenticate a server with. Must be in PEM format. [default to null]
tls_client_cert Option<String> The client certificate used to make authenticated requests. Must be in PEM format. [default to null]
tls_client_key Option<String> The client private key used to make authenticated requests. Must be in PEM format. [default to null]
tls_cert_hostname Option<String> The hostname used to verify a server's certificate. It can either be the Common Name (CN) or a Subject Alternative Name (SAN). [default to null]
use_tls Option<i32> Whether to use TLS. [default to UseTls_no_tls]
created_at Option<String> Date and time in ISO 8601 format.
deleted_at Option<String> Date and time in ISO 8601 format.
updated_at Option<String> Date and time in ISO 8601 format.
service_id2 Option<String>
version Option<String>
name Option<String> Name for the Pool.
shield Option<String> Selected POP to serve as a shield for the servers. Defaults to null meaning no origin shielding if not set. Refer to the POPs API endpoint to get a list of available POPs used for shielding. [default to null]
request_condition Option<String> Condition which, if met, will select this configuration during a request. Optional.
tls_ciphers Option<String> List of OpenSSL ciphers (see the openssl.org manpages for details). Optional.
tls_sni_hostname Option<String> SNI hostname. Optional.
min_tls_version Option<i32> Minimum allowed TLS version on connections to this server. Optional.
max_tls_version Option<i32> Maximum allowed TLS version on connections to this server. Optional.
healthcheck Option<String> Name of the healthcheck to use with this pool. Can be empty and could be reused across multiple backend and pools.
comment Option<String> A freeform descriptive note.
_type Option<String> What type of load balance group to use.
override_host Option<String> The hostname to override the Host header. Defaults to null meaning no override of the Host header will occur. This setting can also be added to a Server definition. If the field is set on a Server definition it will override the Pool setting. [default to null]
between_bytes_timeout Option<i32> Maximum duration in milliseconds that Fastly will wait while receiving no data on a download from a backend. If exceeded, for Delivery services, the response received so far will be considered complete and the fetch will end. For Compute services, timeout expiration is treated as a failure of the backend connection, and an error is generated. May be set at runtime using bereq.between_bytes_timeout. [default to 10000]
connect_timeout Option<i32> How long to wait for a timeout in milliseconds. Optional.
first_byte_timeout Option<i32> How long to wait for the first byte in milliseconds. Optional.
max_conn_default Option<i32> Maximum number of connections. Optional. [default to 200]
quorum Option<i32> Percentage of capacity (0-100) that needs to be operationally available for a pool to be considered up. [default to 75]
tls_check_cert Option<i32> Be strict on checking TLS certs. Optional.

Return type

crate::models::PoolResponse

Authorization

token

HTTP request headers

  • Content-Type: application/x-www-form-urlencoded
  • Accept: application/json

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