Skip to content

Latest commit

 

History

History
293 lines (234 loc) · 12.6 KB

PoolApi.md

File metadata and controls

293 lines (234 loc) · 12.6 KB
Raw

Fastly.PoolApi

const apiInstance = new Fastly.PoolApi();

Methods

Method Fastly API endpoint Description
createServerPool POST /service/{service_id}/version/{version_id}/pool Create a server pool
deleteServerPool DELETE /service/{service_id}/version/{version_id}/pool/{pool_name} Delete a server pool
getServerPool GET /service/{service_id}/version/{version_id}/pool/{pool_name} Get a server pool
listServerPools GET /service/{service_id}/version/{version_id}/pool List server pools
updateServerPool PUT /service/{service_id}/version/{version_id}/pool/{pool_name} Update a server pool

createServerPool

createServerPool({ service_id, version_id, [tls_ca_cert, ][tls_client_cert, ][tls_client_key, ][tls_cert_hostname, ][use_tls, ][name, ][shield, ][request_condition, ][max_conn_default, ][connect_timeout, ][first_byte_timeout, ][quorum, ][tls_ciphers, ][tls_sni_hostname, ][tls_check_cert, ][min_tls_version, ][max_tls_version, ][healthcheck, ][comment, ][type, ][override_host] })

Creates a pool for a particular service and version.

Example

const options = {
  service_id: "service_id_example", // required
  version_id: 56, // required
  tls_ca_cert: "'null'",
  tls_client_cert: "'null'",
  tls_client_key: "'null'",
  tls_cert_hostname: "'null'",
  use_tls: 0,
  name: "name_example",
  shield: "'null'",
  request_condition: "request_condition_example",
  max_conn_default: 200,
  connect_timeout: 56,
  first_byte_timeout: 56,
  quorum: 75,
  tls_ciphers: "tls_ciphers_example",
  tls_sni_hostname: "tls_sni_hostname_example",
  tls_check_cert: 56,
  min_tls_version: 56,
  max_tls_version: 56,
  healthcheck: "healthcheck_example",
  comment: "comment_example",
  type: "random",
  override_host: "'null'",
};

apiInstance.createServerPool(options)
  .then((data) => {
    console.log(data, "API called successfully.");
  })
  .catch((error) => {
    console.error(error);
  });

Options

Name Type Description Notes
service_id String Alphanumeric string identifying the service.
version_id Number Integer identifying a service version.
tls_ca_cert String A secure certificate to authenticate a server with. Must be in PEM format. [optional] [defaults to 'null']
tls_client_cert String The client certificate used to make authenticated requests. Must be in PEM format. [optional] [defaults to 'null']
tls_client_key String The client private key used to make authenticated requests. Must be in PEM format. [optional] [defaults to 'null']
tls_cert_hostname String The hostname used to verify a server's certificate. It can either be the Common Name (CN) or a Subject Alternative Name (SAN). [optional] [defaults to 'null']
use_tls Number Whether to use TLS. [optional] [one of: 0, 1]
name String Name for the Pool. [optional]
shield 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. [optional] [defaults to 'null']
request_condition String Condition which, if met, will select this configuration during a request. Optional. [optional]
max_conn_default Number Maximum number of connections. Optional. [optional] [defaults to 200]
connect_timeout Number How long to wait for a timeout in milliseconds. Optional. [optional]
first_byte_timeout Number How long to wait for the first byte in milliseconds. Optional. [optional]
quorum Number Percentage of capacity (0-100) that needs to be operationally available for a pool to be considered up. [optional] [defaults to 75]
tls_ciphers String List of OpenSSL ciphers (see the openssl.org manpages for details). Optional. [optional]
tls_sni_hostname String SNI hostname. Optional. [optional]
tls_check_cert Number Be strict on checking TLS certs. Optional. [optional]
min_tls_version Number Minimum allowed TLS version on connections to this server. Optional. [optional]
max_tls_version Number Maximum allowed TLS version on connections to this server. Optional. [optional]
healthcheck String Name of the healthcheck to use with this pool. Can be empty and could be reused across multiple backend and pools. [optional]
comment String A freeform descriptive note. [optional]
type String What type of load balance group to use. [optional] [one of: "random", "hash", "client"]
override_host 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. [optional] [defaults to 'null']

Return type

PoolResponse

deleteServerPool

deleteServerPool({ service_id, version_id, pool_name })

Deletes a specific pool for a particular service and version.

Example

const options = {
  service_id: "service_id_example", // required
  version_id: 56, // required
  pool_name: "pool_name_example", // required
};

apiInstance.deleteServerPool(options)
  .then((data) => {
    console.log(data, "API called successfully.");
  })
  .catch((error) => {
    console.error(error);
  });

Options

Name Type Description Notes
service_id String Alphanumeric string identifying the service.
version_id Number Integer identifying a service version.
pool_name String Name for the Pool.

Return type

InlineResponse200

getServerPool

getServerPool({ service_id, version_id, pool_name })

Gets a single pool for a particular service and version.

Example

const options = {
  service_id: "service_id_example", // required
  version_id: 56, // required
  pool_name: "pool_name_example", // required
};

apiInstance.getServerPool(options)
  .then((data) => {
    console.log(data, "API called successfully.");
  })
  .catch((error) => {
    console.error(error);
  });

Options

Name Type Description Notes
service_id String Alphanumeric string identifying the service.
version_id Number Integer identifying a service version.
pool_name String Name for the Pool.

Return type

PoolResponse

listServerPools

listServerPools({ service_id, version_id })

Lists all pools for a particular service and pool.

Example

const options = {
  service_id: "service_id_example", // required
  version_id: 56, // required
};

apiInstance.listServerPools(options)
  .then((data) => {
    console.log(data, "API called successfully.");
  })
  .catch((error) => {
    console.error(error);
  });

Options

Name Type Description Notes
service_id String Alphanumeric string identifying the service.
version_id Number Integer identifying a service version.

Return type

[PoolResponse]

updateServerPool

updateServerPool({ service_id, version_id, pool_name, [tls_ca_cert, ][tls_client_cert, ][tls_client_key, ][tls_cert_hostname, ][use_tls, ][name, ][shield, ][request_condition, ][max_conn_default, ][connect_timeout, ][first_byte_timeout, ][quorum, ][tls_ciphers, ][tls_sni_hostname, ][tls_check_cert, ][min_tls_version, ][max_tls_version, ][healthcheck, ][comment, ][type, ][override_host] })

Updates a specific pool for a particular service and version.

Example

const options = {
  service_id: "service_id_example", // required
  version_id: 56, // required
  pool_name: "pool_name_example", // required
  tls_ca_cert: "'null'",
  tls_client_cert: "'null'",
  tls_client_key: "'null'",
  tls_cert_hostname: "'null'",
  use_tls: 0,
  name: "name_example",
  shield: "'null'",
  request_condition: "request_condition_example",
  max_conn_default: 200,
  connect_timeout: 56,
  first_byte_timeout: 56,
  quorum: 75,
  tls_ciphers: "tls_ciphers_example",
  tls_sni_hostname: "tls_sni_hostname_example",
  tls_check_cert: 56,
  min_tls_version: 56,
  max_tls_version: 56,
  healthcheck: "healthcheck_example",
  comment: "comment_example",
  type: "random",
  override_host: "'null'",
};

apiInstance.updateServerPool(options)
  .then((data) => {
    console.log(data, "API called successfully.");
  })
  .catch((error) => {
    console.error(error);
  });

Options

Name Type Description Notes
service_id String Alphanumeric string identifying the service.
version_id Number Integer identifying a service version.
pool_name String Name for the Pool.
tls_ca_cert String A secure certificate to authenticate a server with. Must be in PEM format. [optional] [defaults to 'null']
tls_client_cert String The client certificate used to make authenticated requests. Must be in PEM format. [optional] [defaults to 'null']
tls_client_key String The client private key used to make authenticated requests. Must be in PEM format. [optional] [defaults to 'null']
tls_cert_hostname String The hostname used to verify a server's certificate. It can either be the Common Name (CN) or a Subject Alternative Name (SAN). [optional] [defaults to 'null']
use_tls Number Whether to use TLS. [optional] [one of: 0, 1]
name String Name for the Pool. [optional]
shield 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. [optional] [defaults to 'null']
request_condition String Condition which, if met, will select this configuration during a request. Optional. [optional]
max_conn_default Number Maximum number of connections. Optional. [optional] [defaults to 200]
connect_timeout Number How long to wait for a timeout in milliseconds. Optional. [optional]
first_byte_timeout Number How long to wait for the first byte in milliseconds. Optional. [optional]
quorum Number Percentage of capacity (0-100) that needs to be operationally available for a pool to be considered up. [optional] [defaults to 75]
tls_ciphers String List of OpenSSL ciphers (see the openssl.org manpages for details). Optional. [optional]
tls_sni_hostname String SNI hostname. Optional. [optional]
tls_check_cert Number Be strict on checking TLS certs. Optional. [optional]
min_tls_version Number Minimum allowed TLS version on connections to this server. Optional. [optional]
max_tls_version Number Maximum allowed TLS version on connections to this server. Optional. [optional]
healthcheck String Name of the healthcheck to use with this pool. Can be empty and could be reused across multiple backend and pools. [optional]
comment String A freeform descriptive note. [optional]
type String What type of load balance group to use. [optional] [one of: "random", "hash", "client"]
override_host 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. [optional] [defaults to 'null']

Return type

PoolResponse

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