@scaleway/sdk 2.71.1 → 2.73.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/api/account/index.gen.d.ts +2 -2
- package/dist/api/account/v2/api.gen.cjs +5 -4
- package/dist/api/account/v2/api.gen.d.ts +1 -1
- package/dist/api/account/v2/api.gen.js +5 -4
- package/dist/api/account/v2/marshalling.gen.cjs +4 -3
- package/dist/api/account/v2/marshalling.gen.d.ts +1 -1
- package/dist/api/account/v2/marshalling.gen.js +4 -3
- package/dist/api/account/v3/api.gen.cjs +18 -36
- package/dist/api/account/v3/api.gen.d.ts +18 -37
- package/dist/api/account/v3/api.gen.js +18 -36
- package/dist/api/account/v3/index.gen.d.ts +1 -1
- package/dist/api/account/v3/marshalling.gen.cjs +4 -3
- package/dist/api/account/v3/marshalling.gen.d.ts +1 -1
- package/dist/api/account/v3/marshalling.gen.js +4 -3
- package/dist/api/account/v3/types.gen.d.ts +187 -85
- package/dist/api/applesilicon/index.gen.d.ts +2 -2
- package/dist/api/applesilicon/v1alpha1/api.gen.cjs +25 -51
- package/dist/api/applesilicon/v1alpha1/api.gen.d.ts +26 -51
- package/dist/api/applesilicon/v1alpha1/api.gen.js +25 -51
- package/dist/api/applesilicon/v1alpha1/index.gen.d.ts +1 -1
- package/dist/api/applesilicon/v1alpha1/marshalling.gen.cjs +4 -3
- package/dist/api/applesilicon/v1alpha1/marshalling.gen.d.ts +1 -1
- package/dist/api/applesilicon/v1alpha1/marshalling.gen.js +4 -3
- package/dist/api/applesilicon/v1alpha1/types.gen.d.ts +311 -136
- package/dist/api/audit_trail/index.gen.d.ts +2 -2
- package/dist/api/audit_trail/v1alpha1/api.gen.cjs +6 -8
- package/dist/api/audit_trail/v1alpha1/api.gen.d.ts +6 -10
- package/dist/api/audit_trail/v1alpha1/api.gen.js +6 -8
- package/dist/api/audit_trail/v1alpha1/marshalling.gen.cjs +4 -3
- package/dist/api/audit_trail/v1alpha1/marshalling.gen.js +4 -3
- package/dist/api/audit_trail/v1alpha1/types.gen.d.ts +111 -83
- package/dist/api/baremetal/index.gen.d.ts +2 -2
- package/dist/api/baremetal/v1/api.gen.cjs +34 -66
- package/dist/api/baremetal/v1/api.gen.d.ts +31 -62
- package/dist/api/baremetal/v1/api.gen.js +34 -66
- package/dist/api/baremetal/v1/api.utils.cjs +3 -1
- package/dist/api/baremetal/v1/api.utils.d.ts +1 -1
- package/dist/api/baremetal/v1/api.utils.js +3 -1
- package/dist/api/baremetal/v1/index.gen.d.ts +1 -1
- package/dist/api/baremetal/v1/marshalling.gen.cjs +4 -3
- package/dist/api/baremetal/v1/marshalling.gen.d.ts +1 -1
- package/dist/api/baremetal/v1/marshalling.gen.js +4 -3
- package/dist/api/baremetal/v1/types.gen.d.ts +866 -379
- package/dist/api/baremetal/v3/api.gen.cjs +12 -18
- package/dist/api/baremetal/v3/api.gen.d.ts +12 -17
- package/dist/api/baremetal/v3/api.gen.js +12 -18
- package/dist/api/baremetal/v3/marshalling.gen.cjs +4 -3
- package/dist/api/baremetal/v3/marshalling.gen.d.ts +1 -1
- package/dist/api/baremetal/v3/marshalling.gen.js +4 -3
- package/dist/api/baremetal/v3/types.gen.d.ts +83 -33
- package/dist/api/billing/index.gen.d.ts +2 -2
- package/dist/api/billing/v2alpha1/api.gen.cjs +5 -4
- package/dist/api/billing/v2alpha1/api.gen.d.ts +1 -1
- package/dist/api/billing/v2alpha1/api.gen.js +5 -4
- package/dist/api/billing/v2alpha1/marshalling.gen.cjs +4 -3
- package/dist/api/billing/v2alpha1/marshalling.gen.js +4 -3
- package/dist/api/billing/v2alpha1/types.gen.d.ts +1 -1
- package/dist/api/billing/v2beta1/api.gen.cjs +16 -24
- package/dist/api/billing/v2beta1/api.gen.d.ts +10 -20
- package/dist/api/billing/v2beta1/api.gen.js +16 -24
- package/dist/api/billing/v2beta1/marshalling.gen.cjs +4 -3
- package/dist/api/billing/v2beta1/marshalling.gen.js +4 -3
- package/dist/api/billing/v2beta1/types.gen.d.ts +232 -103
- package/dist/api/block/index.gen.d.ts +2 -2
- package/dist/api/block/v1/api.gen.cjs +43 -60
- package/dist/api/block/v1/api.gen.d.ts +21 -39
- package/dist/api/block/v1/api.gen.js +43 -60
- package/dist/api/block/v1/marshalling.gen.cjs +4 -3
- package/dist/api/block/v1/marshalling.gen.d.ts +1 -1
- package/dist/api/block/v1/marshalling.gen.js +4 -3
- package/dist/api/block/v1/types.gen.d.ts +307 -126
- package/dist/api/block/v1alpha1/api.gen.cjs +51 -69
- package/dist/api/block/v1alpha1/api.gen.d.ts +24 -43
- package/dist/api/block/v1alpha1/api.gen.js +51 -69
- package/dist/api/block/v1alpha1/marshalling.gen.cjs +4 -3
- package/dist/api/block/v1alpha1/marshalling.gen.d.ts +1 -1
- package/dist/api/block/v1alpha1/marshalling.gen.js +4 -3
- package/dist/api/block/v1alpha1/types.gen.d.ts +328 -133
- package/dist/api/cockpit/index.gen.d.ts +2 -2
- package/dist/api/cockpit/v1/api.gen.cjs +105 -160
- package/dist/api/cockpit/v1/api.gen.d.ts +55 -114
- package/dist/api/cockpit/v1/api.gen.js +105 -160
- package/dist/api/cockpit/v1/index.gen.d.ts +1 -1
- package/dist/api/cockpit/v1/marshalling.gen.cjs +4 -3
- package/dist/api/cockpit/v1/marshalling.gen.d.ts +1 -1
- package/dist/api/cockpit/v1/marshalling.gen.js +4 -3
- package/dist/api/cockpit/v1/types.gen.d.ts +568 -247
- package/dist/api/cockpit/v1beta1/api.gen.cjs +6 -5
- package/dist/api/cockpit/v1beta1/api.gen.d.ts +2 -2
- package/dist/api/cockpit/v1beta1/api.gen.js +6 -5
- package/dist/api/cockpit/v1beta1/marshalling.gen.cjs +4 -3
- package/dist/api/cockpit/v1beta1/marshalling.gen.d.ts +1 -1
- package/dist/api/cockpit/v1beta1/marshalling.gen.js +4 -3
- package/dist/api/cockpit/v1beta1/types.gen.d.ts +1 -1
- package/dist/api/container/index.gen.d.ts +2 -2
- package/dist/api/container/v1beta1/api.gen.cjs +13 -19
- package/dist/api/container/v1beta1/api.gen.d.ts +11 -18
- package/dist/api/container/v1beta1/api.gen.js +13 -19
- package/dist/api/container/v1beta1/marshalling.gen.cjs +4 -3
- package/dist/api/container/v1beta1/marshalling.gen.d.ts +1 -1
- package/dist/api/container/v1beta1/marshalling.gen.js +4 -3
- package/dist/api/container/v1beta1/types.gen.d.ts +649 -323
- package/dist/api/dedibox/index.gen.d.ts +2 -2
- package/dist/api/dedibox/v1/api.gen.cjs +51 -74
- package/dist/api/dedibox/v1/api.gen.d.ts +54 -64
- package/dist/api/dedibox/v1/api.gen.js +51 -74
- package/dist/api/dedibox/v1/marshalling.gen.cjs +4 -3
- package/dist/api/dedibox/v1/marshalling.gen.d.ts +1 -1
- package/dist/api/dedibox/v1/marshalling.gen.js +4 -3
- package/dist/api/dedibox/v1/types.gen.d.ts +1766 -646
- package/dist/api/document_db/index.gen.d.ts +2 -2
- package/dist/api/document_db/v1beta1/api.gen.cjs +6 -5
- package/dist/api/document_db/v1beta1/api.gen.d.ts +2 -2
- package/dist/api/document_db/v1beta1/api.gen.js +6 -5
- package/dist/api/document_db/v1beta1/marshalling.gen.cjs +4 -3
- package/dist/api/document_db/v1beta1/marshalling.gen.d.ts +1 -1
- package/dist/api/document_db/v1beta1/marshalling.gen.js +4 -3
- package/dist/api/document_db/v1beta1/types.gen.d.ts +1 -1
- package/dist/api/domain/index.gen.d.ts +2 -2
- package/dist/api/domain/v2beta1/api.gen.cjs +125 -183
- package/dist/api/domain/v2beta1/api.gen.d.ts +73 -132
- package/dist/api/domain/v2beta1/api.gen.js +125 -183
- package/dist/api/domain/v2beta1/content.gen.d.ts +1 -4
- package/dist/api/domain/v2beta1/index.gen.d.ts +1 -1
- package/dist/api/domain/v2beta1/marshalling.gen.cjs +4 -3
- package/dist/api/domain/v2beta1/marshalling.gen.d.ts +1 -1
- package/dist/api/domain/v2beta1/marshalling.gen.js +4 -3
- package/dist/api/domain/v2beta1/types.gen.d.ts +412 -200
- package/dist/api/edge_services/index.gen.d.ts +2 -2
- package/dist/api/edge_services/v1alpha1/api.gen.cjs +6 -5
- package/dist/api/edge_services/v1alpha1/api.gen.d.ts +2 -2
- package/dist/api/edge_services/v1alpha1/api.gen.js +6 -5
- package/dist/api/edge_services/v1alpha1/marshalling.gen.cjs +4 -3
- package/dist/api/edge_services/v1alpha1/marshalling.gen.d.ts +1 -1
- package/dist/api/edge_services/v1alpha1/marshalling.gen.js +4 -3
- package/dist/api/edge_services/v1alpha1/types.gen.d.ts +1 -1
- package/dist/api/edge_services/v1beta1/api.gen.cjs +49 -136
- package/dist/api/edge_services/v1beta1/api.gen.d.ts +48 -134
- package/dist/api/edge_services/v1beta1/api.gen.js +49 -136
- package/dist/api/edge_services/v1beta1/marshalling.gen.cjs +4 -3
- package/dist/api/edge_services/v1beta1/marshalling.gen.d.ts +1 -1
- package/dist/api/edge_services/v1beta1/marshalling.gen.js +4 -3
- package/dist/api/edge_services/v1beta1/types.gen.d.ts +584 -380
- package/dist/api/flexibleip/index.gen.d.ts +2 -2
- package/dist/api/flexibleip/v1alpha1/api.gen.cjs +16 -30
- package/dist/api/flexibleip/v1alpha1/api.gen.d.ts +14 -30
- package/dist/api/flexibleip/v1alpha1/api.gen.js +16 -30
- package/dist/api/flexibleip/v1alpha1/marshalling.gen.cjs +4 -3
- package/dist/api/flexibleip/v1alpha1/marshalling.gen.d.ts +1 -1
- package/dist/api/flexibleip/v1alpha1/marshalling.gen.js +4 -3
- package/dist/api/flexibleip/v1alpha1/types.gen.d.ts +187 -79
- package/dist/api/function/index.gen.d.ts +2 -2
- package/dist/api/function/v1beta1/api.gen.cjs +20 -33
- package/dist/api/function/v1beta1/api.gen.d.ts +18 -32
- package/dist/api/function/v1beta1/api.gen.js +20 -33
- package/dist/api/function/v1beta1/marshalling.gen.cjs +4 -3
- package/dist/api/function/v1beta1/marshalling.gen.d.ts +1 -1
- package/dist/api/function/v1beta1/marshalling.gen.js +4 -3
- package/dist/api/function/v1beta1/types.gen.d.ts +617 -288
- package/dist/api/iam/index.gen.d.ts +2 -2
- package/dist/api/iam/v1alpha1/api.gen.cjs +49 -163
- package/dist/api/iam/v1alpha1/api.gen.d.ts +47 -163
- package/dist/api/iam/v1alpha1/api.gen.js +49 -163
- package/dist/api/iam/v1alpha1/marshalling.gen.cjs +4 -3
- package/dist/api/iam/v1alpha1/marshalling.gen.d.ts +1 -1
- package/dist/api/iam/v1alpha1/marshalling.gen.js +4 -3
- package/dist/api/iam/v1alpha1/types.gen.d.ts +979 -372
- package/dist/api/index.gen.d.ts +2 -2
- package/dist/api/inference/index.gen.d.ts +2 -2
- package/dist/api/inference/v1/api.gen.cjs +14 -16
- package/dist/api/inference/v1/api.gen.d.ts +8 -11
- package/dist/api/inference/v1/api.gen.js +14 -16
- package/dist/api/inference/v1/marshalling.gen.cjs +4 -3
- package/dist/api/inference/v1/marshalling.gen.d.ts +1 -1
- package/dist/api/inference/v1/marshalling.gen.js +4 -3
- package/dist/api/inference/v1/types.gen.d.ts +331 -151
- package/dist/api/inference/v1beta1/api.gen.cjs +14 -16
- package/dist/api/inference/v1beta1/api.gen.d.ts +8 -11
- package/dist/api/inference/v1beta1/api.gen.js +14 -16
- package/dist/api/inference/v1beta1/marshalling.gen.cjs +4 -3
- package/dist/api/inference/v1beta1/marshalling.gen.d.ts +1 -1
- package/dist/api/inference/v1beta1/marshalling.gen.js +4 -3
- package/dist/api/inference/v1beta1/types.gen.d.ts +342 -155
- package/dist/api/instance/index.gen.d.ts +2 -2
- package/dist/api/instance/v1/api.gen.cjs +69 -117
- package/dist/api/instance/v1/api.gen.d.ts +56 -105
- package/dist/api/instance/v1/api.gen.js +69 -117
- package/dist/api/instance/v1/api.utils.cjs +4 -3
- package/dist/api/instance/v1/api.utils.d.ts +1 -1
- package/dist/api/instance/v1/api.utils.js +4 -3
- package/dist/api/instance/v1/marshalling.gen.cjs +4 -3
- package/dist/api/instance/v1/marshalling.gen.d.ts +1 -1
- package/dist/api/instance/v1/marshalling.gen.js +4 -3
- package/dist/api/instance/v1/marshalling.utils.d.ts +1 -1
- package/dist/api/instance/v1/types.gen.d.ts +1352 -599
- package/dist/api/instance/v1/types.private.gen.d.ts +132 -60
- package/dist/api/instance/v1/types.utils.d.ts +1 -1
- package/dist/api/interlink/index.gen.d.ts +2 -2
- package/dist/api/interlink/v1beta1/api.gen.cjs +107 -63
- package/dist/api/interlink/v1beta1/api.gen.d.ts +58 -65
- package/dist/api/interlink/v1beta1/api.gen.js +108 -64
- package/dist/api/interlink/v1beta1/content.gen.cjs +6 -0
- package/dist/api/interlink/v1beta1/content.gen.d.ts +5 -0
- package/dist/api/interlink/v1beta1/content.gen.js +6 -0
- package/dist/api/interlink/v1beta1/index.gen.cjs +3 -0
- package/dist/api/interlink/v1beta1/index.gen.d.ts +2 -1
- package/dist/api/interlink/v1beta1/index.gen.js +3 -0
- package/dist/api/interlink/v1beta1/marshalling.gen.cjs +84 -8
- package/dist/api/interlink/v1beta1/marshalling.gen.d.ts +4 -2
- package/dist/api/interlink/v1beta1/marshalling.gen.js +84 -8
- package/dist/api/interlink/v1beta1/types.gen.d.ts +545 -195
- package/dist/api/interlink/v1beta1/validation-rules.gen.cjs +25 -0
- package/dist/api/interlink/v1beta1/validation-rules.gen.d.ts +23 -0
- package/dist/api/interlink/v1beta1/validation-rules.gen.js +25 -0
- package/dist/api/iot/index.gen.d.ts +2 -2
- package/dist/api/iot/v1/api.gen.cjs +43 -75
- package/dist/api/iot/v1/api.gen.d.ts +36 -69
- package/dist/api/iot/v1/api.gen.js +43 -75
- package/dist/api/iot/v1/marshalling.gen.cjs +4 -3
- package/dist/api/iot/v1/marshalling.gen.d.ts +1 -1
- package/dist/api/iot/v1/marshalling.gen.js +4 -3
- package/dist/api/iot/v1/types.gen.d.ts +567 -322
- package/dist/api/ipam/index.gen.d.ts +2 -2
- package/dist/api/ipam/v1/api.gen.cjs +11 -30
- package/dist/api/ipam/v1/api.gen.d.ts +10 -31
- package/dist/api/ipam/v1/api.gen.js +11 -30
- package/dist/api/ipam/v1/marshalling.gen.cjs +4 -3
- package/dist/api/ipam/v1/marshalling.gen.d.ts +1 -1
- package/dist/api/ipam/v1/marshalling.gen.js +4 -3
- package/dist/api/ipam/v1/types.gen.d.ts +147 -106
- package/dist/api/ipfs/index.gen.d.ts +2 -2
- package/dist/api/ipfs/v1alpha1/api.gen.cjs +6 -5
- package/dist/api/ipfs/v1alpha1/api.gen.d.ts +2 -2
- package/dist/api/ipfs/v1alpha1/api.gen.js +6 -5
- package/dist/api/ipfs/v1alpha1/marshalling.gen.cjs +4 -3
- package/dist/api/ipfs/v1alpha1/marshalling.gen.d.ts +1 -1
- package/dist/api/ipfs/v1alpha1/marshalling.gen.js +4 -3
- package/dist/api/ipfs/v1alpha1/types.gen.d.ts +1 -1
- package/dist/api/jobs/index.gen.d.ts +2 -2
- package/dist/api/jobs/v1alpha1/api.gen.cjs +7 -8
- package/dist/api/jobs/v1alpha1/api.gen.d.ts +6 -8
- package/dist/api/jobs/v1alpha1/api.gen.js +7 -8
- package/dist/api/jobs/v1alpha1/marshalling.gen.cjs +4 -3
- package/dist/api/jobs/v1alpha1/marshalling.gen.d.ts +1 -1
- package/dist/api/jobs/v1alpha1/marshalling.gen.js +4 -3
- package/dist/api/jobs/v1alpha1/types.gen.d.ts +166 -92
- package/dist/api/k8s/index.gen.d.ts +2 -2
- package/dist/api/k8s/v1/api.gen.cjs +39 -83
- package/dist/api/k8s/v1/api.gen.d.ts +29 -74
- package/dist/api/k8s/v1/api.gen.js +39 -83
- package/dist/api/k8s/v1/marshalling.gen.cjs +4 -3
- package/dist/api/k8s/v1/marshalling.gen.d.ts +1 -1
- package/dist/api/k8s/v1/marshalling.gen.js +4 -3
- package/dist/api/k8s/v1/types.gen.d.ts +744 -507
- package/dist/api/key_manager/index.gen.d.ts +2 -2
- package/dist/api/key_manager/v1alpha1/api.gen.cjs +26 -61
- package/dist/api/key_manager/v1alpha1/api.gen.d.ts +21 -58
- package/dist/api/key_manager/v1alpha1/api.gen.js +26 -61
- package/dist/api/key_manager/v1alpha1/marshalling.gen.cjs +4 -3
- package/dist/api/key_manager/v1alpha1/marshalling.gen.d.ts +1 -1
- package/dist/api/key_manager/v1alpha1/marshalling.gen.js +4 -3
- package/dist/api/key_manager/v1alpha1/types.gen.d.ts +197 -115
- package/dist/api/lb/index.gen.d.ts +2 -2
- package/dist/api/lb/v1/api.gen.cjs +68 -178
- package/dist/api/lb/v1/api.gen.d.ts +60 -176
- package/dist/api/lb/v1/api.gen.js +69 -179
- package/dist/api/lb/v1/api.utils.cjs +3 -1
- package/dist/api/lb/v1/api.utils.d.ts +1 -1
- package/dist/api/lb/v1/api.utils.js +3 -1
- package/dist/api/lb/v1/index.gen.d.ts +1 -1
- package/dist/api/lb/v1/marshalling.gen.cjs +9 -3
- package/dist/api/lb/v1/marshalling.gen.d.ts +3 -2
- package/dist/api/lb/v1/marshalling.gen.js +9 -3
- package/dist/api/lb/v1/types.gen.d.ts +1835 -1117
- package/dist/api/lb/v1/types.utils.d.ts +1 -1
- package/dist/api/llm_inference/index.gen.d.ts +2 -2
- package/dist/api/llm_inference/v1beta1/api.gen.cjs +6 -5
- package/dist/api/llm_inference/v1beta1/api.gen.d.ts +2 -2
- package/dist/api/llm_inference/v1beta1/api.gen.js +6 -5
- package/dist/api/llm_inference/v1beta1/marshalling.gen.cjs +4 -3
- package/dist/api/llm_inference/v1beta1/marshalling.gen.d.ts +1 -1
- package/dist/api/llm_inference/v1beta1/marshalling.gen.js +4 -3
- package/dist/api/llm_inference/v1beta1/types.gen.d.ts +1 -1
- package/dist/api/marketplace/index.gen.d.ts +2 -2
- package/dist/api/marketplace/v2/api.gen.cjs +13 -25
- package/dist/api/marketplace/v2/api.gen.d.ts +11 -25
- package/dist/api/marketplace/v2/api.gen.js +13 -25
- package/dist/api/marketplace/v2/marshalling.gen.cjs +4 -3
- package/dist/api/marketplace/v2/marshalling.gen.js +4 -3
- package/dist/api/marketplace/v2/types.gen.d.ts +95 -42
- package/dist/api/mnq/index.gen.d.ts +2 -2
- package/dist/api/mnq/v1beta1/api.gen.cjs +29 -80
- package/dist/api/mnq/v1beta1/api.gen.d.ts +32 -84
- package/dist/api/mnq/v1beta1/api.gen.js +29 -80
- package/dist/api/mnq/v1beta1/index.gen.d.ts +1 -1
- package/dist/api/mnq/v1beta1/marshalling.gen.cjs +4 -3
- package/dist/api/mnq/v1beta1/marshalling.gen.d.ts +1 -1
- package/dist/api/mnq/v1beta1/marshalling.gen.js +4 -3
- package/dist/api/mnq/v1beta1/types.gen.d.ts +343 -170
- package/dist/api/mongodb/index.gen.d.ts +2 -2
- package/dist/api/mongodb/v1alpha1/api.gen.cjs +25 -67
- package/dist/api/mongodb/v1alpha1/api.gen.d.ts +23 -66
- package/dist/api/mongodb/v1alpha1/api.gen.js +25 -67
- package/dist/api/mongodb/v1alpha1/marshalling.gen.cjs +4 -3
- package/dist/api/mongodb/v1alpha1/marshalling.gen.d.ts +1 -1
- package/dist/api/mongodb/v1alpha1/marshalling.gen.js +4 -3
- package/dist/api/mongodb/v1alpha1/types.gen.d.ts +444 -190
- package/dist/api/qaas/index.gen.d.ts +2 -2
- package/dist/api/qaas/v1alpha1/api.gen.cjs +23 -39
- package/dist/api/qaas/v1alpha1/api.gen.d.ts +21 -38
- package/dist/api/qaas/v1alpha1/api.gen.js +23 -39
- package/dist/api/qaas/v1alpha1/marshalling.gen.cjs +4 -3
- package/dist/api/qaas/v1alpha1/marshalling.gen.d.ts +1 -1
- package/dist/api/qaas/v1alpha1/marshalling.gen.js +4 -3
- package/dist/api/qaas/v1alpha1/types.gen.d.ts +503 -175
- package/dist/api/rdb/index.gen.d.ts +2 -2
- package/dist/api/rdb/v1/api.gen.cjs +68 -207
- package/dist/api/rdb/v1/api.gen.d.ts +62 -203
- package/dist/api/rdb/v1/api.gen.js +68 -207
- package/dist/api/rdb/v1/marshalling.gen.cjs +4 -3
- package/dist/api/rdb/v1/marshalling.gen.d.ts +1 -1
- package/dist/api/rdb/v1/marshalling.gen.js +4 -3
- package/dist/api/rdb/v1/types.gen.d.ts +1006 -525
- package/dist/api/redis/index.gen.d.ts +2 -2
- package/dist/api/redis/v1/api.gen.cjs +29 -88
- package/dist/api/redis/v1/api.gen.d.ts +27 -87
- package/dist/api/redis/v1/api.gen.js +29 -88
- package/dist/api/redis/v1/marshalling.gen.cjs +4 -3
- package/dist/api/redis/v1/marshalling.gen.d.ts +1 -1
- package/dist/api/redis/v1/marshalling.gen.js +4 -3
- package/dist/api/redis/v1/types.gen.d.ts +448 -171
- package/dist/api/registry/index.gen.d.ts +2 -2
- package/dist/api/registry/v1/api.gen.cjs +18 -45
- package/dist/api/registry/v1/api.gen.d.ts +16 -44
- package/dist/api/registry/v1/api.gen.js +18 -45
- package/dist/api/registry/v1/marshalling.gen.cjs +4 -3
- package/dist/api/registry/v1/marshalling.gen.d.ts +1 -1
- package/dist/api/registry/v1/marshalling.gen.js +4 -3
- package/dist/api/registry/v1/types.gen.d.ts +201 -117
- package/dist/api/secret/index.gen.d.ts +2 -2
- package/dist/api/secret/v1alpha1/api.gen.cjs +5 -4
- package/dist/api/secret/v1alpha1/api.gen.d.ts +2 -2
- package/dist/api/secret/v1alpha1/api.gen.js +5 -4
- package/dist/api/secret/v1alpha1/marshalling.gen.cjs +4 -3
- package/dist/api/secret/v1alpha1/marshalling.gen.d.ts +1 -1
- package/dist/api/secret/v1alpha1/marshalling.gen.js +4 -3
- package/dist/api/secret/v1alpha1/types.gen.d.ts +1 -1
- package/dist/api/secret/v1beta1/api.gen.cjs +24 -51
- package/dist/api/secret/v1beta1/api.gen.d.ts +23 -53
- package/dist/api/secret/v1beta1/api.gen.js +24 -51
- package/dist/api/secret/v1beta1/marshalling.gen.cjs +4 -3
- package/dist/api/secret/v1beta1/marshalling.gen.d.ts +1 -1
- package/dist/api/secret/v1beta1/marshalling.gen.js +4 -3
- package/dist/api/secret/v1beta1/types.gen.d.ts +360 -225
- package/dist/api/serverless_sqldb/index.gen.d.ts +2 -2
- package/dist/api/serverless_sqldb/v1alpha1/api.gen.cjs +15 -32
- package/dist/api/serverless_sqldb/v1alpha1/api.gen.d.ts +13 -31
- package/dist/api/serverless_sqldb/v1alpha1/api.gen.js +15 -32
- package/dist/api/serverless_sqldb/v1alpha1/marshalling.gen.cjs +4 -3
- package/dist/api/serverless_sqldb/v1alpha1/marshalling.gen.d.ts +1 -1
- package/dist/api/serverless_sqldb/v1alpha1/marshalling.gen.js +4 -3
- package/dist/api/serverless_sqldb/v1alpha1/types.gen.d.ts +169 -77
- package/dist/api/tem/index.gen.d.ts +2 -2
- package/dist/api/tem/v1alpha1/api.gen.cjs +28 -63
- package/dist/api/tem/v1alpha1/api.gen.d.ts +26 -62
- package/dist/api/tem/v1alpha1/api.gen.js +28 -63
- package/dist/api/tem/v1alpha1/marshalling.gen.cjs +4 -3
- package/dist/api/tem/v1alpha1/marshalling.gen.d.ts +1 -1
- package/dist/api/tem/v1alpha1/marshalling.gen.js +4 -3
- package/dist/api/tem/v1alpha1/types.gen.d.ts +762 -339
- package/dist/api/test/index.gen.d.ts +2 -2
- package/dist/api/test/v1/api.gen.cjs +14 -16
- package/dist/api/test/v1/api.gen.d.ts +8 -11
- package/dist/api/test/v1/api.gen.js +14 -16
- package/dist/api/test/v1/marshalling.gen.cjs +4 -3
- package/dist/api/test/v1/marshalling.gen.d.ts +1 -1
- package/dist/api/test/v1/marshalling.gen.js +4 -3
- package/dist/api/test/v1/types.gen.d.ts +21 -10
- package/dist/api/vpc/index.gen.d.ts +2 -2
- package/dist/api/vpc/v1/api.gen.cjs +5 -4
- package/dist/api/vpc/v1/api.gen.d.ts +2 -2
- package/dist/api/vpc/v1/api.gen.js +5 -4
- package/dist/api/vpc/v1/marshalling.gen.cjs +4 -3
- package/dist/api/vpc/v1/marshalling.gen.d.ts +1 -1
- package/dist/api/vpc/v1/marshalling.gen.js +4 -3
- package/dist/api/vpc/v1/types.gen.d.ts +1 -1
- package/dist/api/vpc/v2/api.gen.cjs +18 -53
- package/dist/api/vpc/v2/api.gen.d.ts +18 -45
- package/dist/api/vpc/v2/api.gen.js +19 -54
- package/dist/api/vpc/v2/index.gen.d.ts +1 -1
- package/dist/api/vpc/v2/marshalling.gen.cjs +4 -18
- package/dist/api/vpc/v2/marshalling.gen.d.ts +2 -4
- package/dist/api/vpc/v2/marshalling.gen.js +4 -18
- package/dist/api/vpc/v2/types.gen.d.ts +333 -200
- package/dist/api/vpcgw/index.gen.d.ts +2 -2
- package/dist/api/vpcgw/v1/api.gen.cjs +42 -140
- package/dist/api/vpcgw/v1/api.gen.d.ts +40 -139
- package/dist/api/vpcgw/v1/api.gen.js +42 -140
- package/dist/api/vpcgw/v1/marshalling.gen.cjs +4 -3
- package/dist/api/vpcgw/v1/marshalling.gen.d.ts +1 -1
- package/dist/api/vpcgw/v1/marshalling.gen.js +4 -3
- package/dist/api/vpcgw/v1/types.gen.d.ts +784 -366
- package/dist/api/vpcgw/v2/api.gen.cjs +33 -93
- package/dist/api/vpcgw/v2/api.gen.d.ts +31 -92
- package/dist/api/vpcgw/v2/api.gen.js +33 -93
- package/dist/api/vpcgw/v2/marshalling.gen.cjs +4 -3
- package/dist/api/vpcgw/v2/marshalling.gen.d.ts +1 -1
- package/dist/api/vpcgw/v2/marshalling.gen.js +4 -3
- package/dist/api/vpcgw/v2/types.gen.d.ts +546 -197
- package/dist/api/webhosting/index.gen.d.ts +2 -2
- package/dist/api/webhosting/v1/api.gen.cjs +28 -55
- package/dist/api/webhosting/v1/api.gen.d.ts +40 -71
- package/dist/api/webhosting/v1/api.gen.js +28 -55
- package/dist/api/webhosting/v1/marshalling.gen.cjs +4 -3
- package/dist/api/webhosting/v1/marshalling.gen.d.ts +1 -1
- package/dist/api/webhosting/v1/marshalling.gen.js +4 -3
- package/dist/api/webhosting/v1/types.gen.d.ts +700 -351
- package/dist/client/dist/helpers/is-browser.cjs +4 -0
- package/dist/client/dist/helpers/is-browser.js +4 -0
- package/dist/{package.json.cjs → client/dist/package.json.cjs} +7 -16
- package/dist/{package.json.js → client/dist/package.json.js} +7 -16
- package/dist/client/dist/scw/constants.cjs +7 -0
- package/dist/{vendor → client/dist/vendor}/base64/index.cjs +8 -4
- package/dist/{vendor → client/dist/vendor}/base64/index.js +8 -4
- package/dist/index.cjs +16 -16
- package/dist/index.d.ts +1 -15
- package/dist/index.js +13 -13
- package/node_modules/@scaleway/sdk-client/README.md +36 -0
- package/node_modules/@scaleway/sdk-client/dist/helpers/is-browser.cjs +4 -0
- package/node_modules/@scaleway/sdk-client/dist/helpers/is-browser.js +4 -0
- package/node_modules/@scaleway/sdk-client/dist/helpers/is-response.cjs +4 -0
- package/node_modules/@scaleway/sdk-client/dist/helpers/is-response.js +4 -0
- package/node_modules/@scaleway/sdk-client/dist/helpers/json.cjs +7 -0
- package/{dist → node_modules/@scaleway/sdk-client/dist}/helpers/json.d.ts +2 -2
- package/node_modules/@scaleway/sdk-client/dist/helpers/json.js +7 -0
- package/node_modules/@scaleway/sdk-client/dist/helpers/marshalling.cjs +76 -0
- package/node_modules/@scaleway/sdk-client/dist/helpers/marshalling.js +76 -0
- package/node_modules/@scaleway/sdk-client/dist/index.cjs +52 -0
- package/node_modules/@scaleway/sdk-client/dist/index.d.ts +15 -0
- package/node_modules/@scaleway/sdk-client/dist/index.js +52 -0
- package/node_modules/@scaleway/sdk-client/dist/internal/async/interval-retrier.cjs +53 -0
- package/{dist → node_modules/@scaleway/sdk-client/dist}/internal/async/interval-retrier.d.ts +2 -2
- package/node_modules/@scaleway/sdk-client/dist/internal/async/interval-retrier.js +53 -0
- package/node_modules/@scaleway/sdk-client/dist/internal/async/sleep.cjs +6 -0
- package/node_modules/@scaleway/sdk-client/dist/internal/async/sleep.js +6 -0
- package/node_modules/@scaleway/sdk-client/dist/internal/interceptors/composer.cjs +25 -0
- package/node_modules/@scaleway/sdk-client/dist/internal/interceptors/composer.js +25 -0
- package/node_modules/@scaleway/sdk-client/dist/internal/interceptors/helpers.cjs +12 -0
- package/node_modules/@scaleway/sdk-client/dist/internal/interceptors/helpers.js +12 -0
- package/{dist → node_modules/@scaleway/sdk-client/dist}/internal/interceptors/types.d.ts +2 -2
- package/node_modules/@scaleway/sdk-client/dist/internal/logger/console-logger.cjs +24 -0
- package/node_modules/@scaleway/sdk-client/dist/internal/logger/console-logger.js +24 -0
- package/node_modules/@scaleway/sdk-client/dist/internal/logger/index.cjs +12 -0
- package/node_modules/@scaleway/sdk-client/dist/internal/logger/index.js +12 -0
- package/node_modules/@scaleway/sdk-client/dist/internal/logger/level-resolver.cjs +13 -0
- package/node_modules/@scaleway/sdk-client/dist/internal/logger/level-resolver.js +13 -0
- package/node_modules/@scaleway/sdk-client/dist/internal/validations/string-validation.cjs +30 -0
- package/node_modules/@scaleway/sdk-client/dist/internal/validations/string-validation.js +30 -0
- package/node_modules/@scaleway/sdk-client/dist/package.json.cjs +67 -0
- package/node_modules/@scaleway/sdk-client/dist/package.json.js +67 -0
- package/node_modules/@scaleway/sdk-client/dist/scw/api.cjs +8 -0
- package/node_modules/@scaleway/sdk-client/dist/scw/api.js +8 -0
- package/node_modules/@scaleway/sdk-client/dist/scw/auth.cjs +26 -0
- package/node_modules/@scaleway/sdk-client/dist/scw/auth.js +26 -0
- package/node_modules/@scaleway/sdk-client/dist/scw/client-ini-factory.cjs +66 -0
- package/node_modules/@scaleway/sdk-client/dist/scw/client-ini-factory.js +66 -0
- package/node_modules/@scaleway/sdk-client/dist/scw/client-ini-profile.cjs +23 -0
- package/node_modules/@scaleway/sdk-client/dist/scw/client-ini-profile.js +23 -0
- package/node_modules/@scaleway/sdk-client/dist/scw/client-settings.cjs +51 -0
- package/node_modules/@scaleway/sdk-client/dist/scw/client-settings.js +51 -0
- package/node_modules/@scaleway/sdk-client/dist/scw/client.cjs +31 -0
- package/{dist → node_modules/@scaleway/sdk-client/dist}/scw/client.d.ts +2 -2
- package/node_modules/@scaleway/sdk-client/dist/scw/client.js +31 -0
- package/node_modules/@scaleway/sdk-client/dist/scw/constants.js +7 -0
- package/node_modules/@scaleway/sdk-client/dist/scw/custom-marshalling.cjs +126 -0
- package/node_modules/@scaleway/sdk-client/dist/scw/custom-marshalling.js +126 -0
- package/node_modules/@scaleway/sdk-client/dist/scw/custom-types.cjs +11 -0
- package/node_modules/@scaleway/sdk-client/dist/scw/custom-types.js +11 -0
- package/node_modules/@scaleway/sdk-client/dist/scw/errors/error-parser.cjs +76 -0
- package/node_modules/@scaleway/sdk-client/dist/scw/errors/error-parser.js +76 -0
- package/node_modules/@scaleway/sdk-client/dist/scw/errors/non-standard/invalid-request-mapper.cjs +36 -0
- package/node_modules/@scaleway/sdk-client/dist/scw/errors/non-standard/invalid-request-mapper.js +36 -0
- package/node_modules/@scaleway/sdk-client/dist/scw/errors/non-standard/unknown-resource-mapper.cjs +23 -0
- package/node_modules/@scaleway/sdk-client/dist/scw/errors/non-standard/unknown-resource-mapper.js +23 -0
- package/node_modules/@scaleway/sdk-client/dist/scw/errors/scw-error.cjs +43 -0
- package/node_modules/@scaleway/sdk-client/dist/scw/errors/scw-error.js +43 -0
- package/node_modules/@scaleway/sdk-client/dist/scw/errors/standard/already-exists-error.cjs +31 -0
- package/node_modules/@scaleway/sdk-client/dist/scw/errors/standard/already-exists-error.js +31 -0
- package/node_modules/@scaleway/sdk-client/dist/scw/errors/standard/denied-authentication-error.cjs +37 -0
- package/node_modules/@scaleway/sdk-client/dist/scw/errors/standard/denied-authentication-error.js +37 -0
- package/node_modules/@scaleway/sdk-client/dist/scw/errors/standard/index.cjs +28 -0
- package/node_modules/@scaleway/sdk-client/dist/scw/errors/standard/index.js +28 -0
- package/node_modules/@scaleway/sdk-client/dist/scw/errors/standard/invalid-arguments-error.cjs +54 -0
- package/{dist → node_modules/@scaleway/sdk-client/dist}/scw/errors/standard/invalid-arguments-error.d.ts +2 -2
- package/node_modules/@scaleway/sdk-client/dist/scw/errors/standard/invalid-arguments-error.js +54 -0
- package/node_modules/@scaleway/sdk-client/dist/scw/errors/standard/out-of-stock-error.cjs +17 -0
- package/node_modules/@scaleway/sdk-client/dist/scw/errors/standard/out-of-stock-error.js +17 -0
- package/node_modules/@scaleway/sdk-client/dist/scw/errors/standard/permissions-denied-error.cjs +29 -0
- package/{dist → node_modules/@scaleway/sdk-client/dist}/scw/errors/standard/permissions-denied-error.d.ts +2 -2
- package/node_modules/@scaleway/sdk-client/dist/scw/errors/standard/permissions-denied-error.js +29 -0
- package/node_modules/@scaleway/sdk-client/dist/scw/errors/standard/precondition-failed-error.cjs +32 -0
- package/node_modules/@scaleway/sdk-client/dist/scw/errors/standard/precondition-failed-error.js +32 -0
- package/node_modules/@scaleway/sdk-client/dist/scw/errors/standard/quotas-exceeded-error.cjs +43 -0
- package/node_modules/@scaleway/sdk-client/dist/scw/errors/standard/quotas-exceeded-error.js +43 -0
- package/node_modules/@scaleway/sdk-client/dist/scw/errors/standard/resource-expired-error.cjs +31 -0
- package/node_modules/@scaleway/sdk-client/dist/scw/errors/standard/resource-expired-error.js +31 -0
- package/node_modules/@scaleway/sdk-client/dist/scw/errors/standard/resource-locked-error.cjs +20 -0
- package/node_modules/@scaleway/sdk-client/dist/scw/errors/standard/resource-locked-error.js +20 -0
- package/node_modules/@scaleway/sdk-client/dist/scw/errors/standard/resource-not-found-error.cjs +24 -0
- package/node_modules/@scaleway/sdk-client/dist/scw/errors/standard/resource-not-found-error.js +24 -0
- package/node_modules/@scaleway/sdk-client/dist/scw/errors/standard/too-many-requests-error.cjs +58 -0
- package/{dist → node_modules/@scaleway/sdk-client/dist}/scw/errors/standard/too-many-requests-error.d.ts +2 -2
- package/node_modules/@scaleway/sdk-client/dist/scw/errors/standard/too-many-requests-error.js +58 -0
- package/node_modules/@scaleway/sdk-client/dist/scw/errors/standard/transient-state-error.cjs +31 -0
- package/node_modules/@scaleway/sdk-client/dist/scw/errors/standard/transient-state-error.js +31 -0
- package/node_modules/@scaleway/sdk-client/dist/scw/errors/types.cjs +15 -0
- package/node_modules/@scaleway/sdk-client/dist/scw/errors/types.js +15 -0
- package/node_modules/@scaleway/sdk-client/dist/scw/fetch/build-fetcher.cjs +60 -0
- package/node_modules/@scaleway/sdk-client/dist/scw/fetch/build-fetcher.js +60 -0
- package/node_modules/@scaleway/sdk-client/dist/scw/fetch/http-dumper.cjs +20 -0
- package/node_modules/@scaleway/sdk-client/dist/scw/fetch/http-dumper.js +20 -0
- package/node_modules/@scaleway/sdk-client/dist/scw/fetch/http-interceptors.cjs +43 -0
- package/node_modules/@scaleway/sdk-client/dist/scw/fetch/http-interceptors.js +43 -0
- package/node_modules/@scaleway/sdk-client/dist/scw/fetch/resource-paginator.cjs +36 -0
- package/node_modules/@scaleway/sdk-client/dist/scw/fetch/resource-paginator.js +36 -0
- package/node_modules/@scaleway/sdk-client/dist/scw/fetch/response-parser.cjs +55 -0
- package/node_modules/@scaleway/sdk-client/dist/scw/fetch/response-parser.js +55 -0
- package/{dist → node_modules/@scaleway/sdk-client/dist}/scw/fetch/types.d.ts +2 -2
- package/node_modules/@scaleway/sdk-client/dist/vendor/base64/index.cjs +46 -0
- package/node_modules/@scaleway/sdk-client/dist/vendor/base64/index.js +46 -0
- package/node_modules/@scaleway/sdk-client/package.json +36 -0
- package/package.json +6 -4
- package/dist/helpers/is-browser.cjs +0 -7
- package/dist/helpers/is-browser.js +0 -7
- /package/dist/{helpers → client/dist/helpers}/is-response.cjs +0 -0
- /package/dist/{helpers → client/dist/helpers}/is-response.js +0 -0
- /package/dist/{helpers → client/dist/helpers}/json.cjs +0 -0
- /package/dist/{helpers → client/dist/helpers}/json.js +0 -0
- /package/dist/{helpers → client/dist/helpers}/marshalling.cjs +0 -0
- /package/dist/{helpers → client/dist/helpers}/marshalling.js +0 -0
- /package/dist/{internal → client/dist/internal}/async/interval-retrier.cjs +0 -0
- /package/dist/{internal → client/dist/internal}/async/interval-retrier.js +0 -0
- /package/dist/{internal → client/dist/internal}/async/sleep.cjs +0 -0
- /package/dist/{internal → client/dist/internal}/async/sleep.js +0 -0
- /package/dist/{internal → client/dist/internal}/interceptors/composer.cjs +0 -0
- /package/dist/{internal → client/dist/internal}/interceptors/composer.js +0 -0
- /package/dist/{internal → client/dist/internal}/interceptors/helpers.cjs +0 -0
- /package/dist/{internal → client/dist/internal}/interceptors/helpers.js +0 -0
- /package/dist/{internal → client/dist/internal}/logger/console-logger.cjs +0 -0
- /package/dist/{internal → client/dist/internal}/logger/console-logger.js +0 -0
- /package/dist/{internal → client/dist/internal}/logger/index.cjs +0 -0
- /package/dist/{internal → client/dist/internal}/logger/index.js +0 -0
- /package/dist/{internal → client/dist/internal}/logger/level-resolver.cjs +0 -0
- /package/dist/{internal → client/dist/internal}/logger/level-resolver.js +0 -0
- /package/dist/{internal → client/dist/internal}/validations/string-validation.cjs +0 -0
- /package/dist/{internal → client/dist/internal}/validations/string-validation.js +0 -0
- /package/dist/{scw → client/dist/scw}/api.cjs +0 -0
- /package/dist/{scw → client/dist/scw}/api.js +0 -0
- /package/dist/{scw → client/dist/scw}/auth.cjs +0 -0
- /package/dist/{scw → client/dist/scw}/auth.js +0 -0
- /package/dist/{scw → client/dist/scw}/client-ini-factory.cjs +0 -0
- /package/dist/{scw → client/dist/scw}/client-ini-factory.js +0 -0
- /package/dist/{scw → client/dist/scw}/client-ini-profile.cjs +0 -0
- /package/dist/{scw → client/dist/scw}/client-ini-profile.js +0 -0
- /package/dist/{scw → client/dist/scw}/client-settings.cjs +0 -0
- /package/dist/{scw → client/dist/scw}/client-settings.js +0 -0
- /package/dist/{scw → client/dist/scw}/client.cjs +0 -0
- /package/dist/{scw → client/dist/scw}/client.js +0 -0
- /package/dist/{scw → client/dist/scw}/constants.js +0 -0
- /package/dist/{scw → client/dist/scw}/custom-marshalling.cjs +0 -0
- /package/dist/{scw → client/dist/scw}/custom-marshalling.js +0 -0
- /package/dist/{scw → client/dist/scw}/custom-types.cjs +0 -0
- /package/dist/{scw → client/dist/scw}/custom-types.js +0 -0
- /package/dist/{scw → client/dist/scw}/errors/error-parser.cjs +0 -0
- /package/dist/{scw → client/dist/scw}/errors/error-parser.js +0 -0
- /package/dist/{scw → client/dist/scw}/errors/non-standard/invalid-request-mapper.cjs +0 -0
- /package/dist/{scw → client/dist/scw}/errors/non-standard/invalid-request-mapper.js +0 -0
- /package/dist/{scw → client/dist/scw}/errors/non-standard/unknown-resource-mapper.cjs +0 -0
- /package/dist/{scw → client/dist/scw}/errors/non-standard/unknown-resource-mapper.js +0 -0
- /package/dist/{scw → client/dist/scw}/errors/scw-error.cjs +0 -0
- /package/dist/{scw → client/dist/scw}/errors/scw-error.js +0 -0
- /package/dist/{scw → client/dist/scw}/errors/standard/already-exists-error.cjs +0 -0
- /package/dist/{scw → client/dist/scw}/errors/standard/already-exists-error.js +0 -0
- /package/dist/{scw → client/dist/scw}/errors/standard/denied-authentication-error.cjs +0 -0
- /package/dist/{scw → client/dist/scw}/errors/standard/denied-authentication-error.js +0 -0
- /package/dist/{scw → client/dist/scw}/errors/standard/index.cjs +0 -0
- /package/dist/{scw → client/dist/scw}/errors/standard/index.js +0 -0
- /package/dist/{scw → client/dist/scw}/errors/standard/invalid-arguments-error.cjs +0 -0
- /package/dist/{scw → client/dist/scw}/errors/standard/invalid-arguments-error.js +0 -0
- /package/dist/{scw → client/dist/scw}/errors/standard/out-of-stock-error.cjs +0 -0
- /package/dist/{scw → client/dist/scw}/errors/standard/out-of-stock-error.js +0 -0
- /package/dist/{scw → client/dist/scw}/errors/standard/permissions-denied-error.cjs +0 -0
- /package/dist/{scw → client/dist/scw}/errors/standard/permissions-denied-error.js +0 -0
- /package/dist/{scw → client/dist/scw}/errors/standard/precondition-failed-error.cjs +0 -0
- /package/dist/{scw → client/dist/scw}/errors/standard/precondition-failed-error.js +0 -0
- /package/dist/{scw → client/dist/scw}/errors/standard/quotas-exceeded-error.cjs +0 -0
- /package/dist/{scw → client/dist/scw}/errors/standard/quotas-exceeded-error.js +0 -0
- /package/dist/{scw → client/dist/scw}/errors/standard/resource-expired-error.cjs +0 -0
- /package/dist/{scw → client/dist/scw}/errors/standard/resource-expired-error.js +0 -0
- /package/dist/{scw → client/dist/scw}/errors/standard/resource-locked-error.cjs +0 -0
- /package/dist/{scw → client/dist/scw}/errors/standard/resource-locked-error.js +0 -0
- /package/dist/{scw → client/dist/scw}/errors/standard/resource-not-found-error.cjs +0 -0
- /package/dist/{scw → client/dist/scw}/errors/standard/resource-not-found-error.js +0 -0
- /package/dist/{scw → client/dist/scw}/errors/standard/too-many-requests-error.cjs +0 -0
- /package/dist/{scw → client/dist/scw}/errors/standard/too-many-requests-error.js +0 -0
- /package/dist/{scw → client/dist/scw}/errors/standard/transient-state-error.cjs +0 -0
- /package/dist/{scw → client/dist/scw}/errors/standard/transient-state-error.js +0 -0
- /package/dist/{scw → client/dist/scw}/errors/types.cjs +0 -0
- /package/dist/{scw → client/dist/scw}/errors/types.js +0 -0
- /package/dist/{scw → client/dist/scw}/fetch/build-fetcher.cjs +0 -0
- /package/dist/{scw → client/dist/scw}/fetch/build-fetcher.js +0 -0
- /package/dist/{scw → client/dist/scw}/fetch/http-dumper.cjs +0 -0
- /package/dist/{scw → client/dist/scw}/fetch/http-dumper.js +0 -0
- /package/dist/{scw → client/dist/scw}/fetch/http-interceptors.cjs +0 -0
- /package/dist/{scw → client/dist/scw}/fetch/http-interceptors.js +0 -0
- /package/dist/{scw → client/dist/scw}/fetch/resource-paginator.cjs +0 -0
- /package/dist/{scw → client/dist/scw}/fetch/resource-paginator.js +0 -0
- /package/dist/{scw → client/dist/scw}/fetch/response-parser.cjs +0 -0
- /package/dist/{scw → client/dist/scw}/fetch/response-parser.js +0 -0
- /package/{dist → node_modules/@scaleway/sdk-client/dist}/bridge.d.ts +0 -0
- /package/{dist → node_modules/@scaleway/sdk-client/dist}/helpers/is-browser.d.ts +0 -0
- /package/{dist → node_modules/@scaleway/sdk-client/dist}/helpers/is-response.d.ts +0 -0
- /package/{dist → node_modules/@scaleway/sdk-client/dist}/helpers/marshalling.d.ts +0 -0
- /package/{dist → node_modules/@scaleway/sdk-client/dist}/internal/async/sleep.d.ts +0 -0
- /package/{dist → node_modules/@scaleway/sdk-client/dist}/internal/interceptors/composer.d.ts +0 -0
- /package/{dist → node_modules/@scaleway/sdk-client/dist}/internal/interceptors/helpers.d.ts +0 -0
- /package/{dist → node_modules/@scaleway/sdk-client/dist}/internal/logger/console-logger.d.ts +0 -0
- /package/{dist → node_modules/@scaleway/sdk-client/dist}/internal/logger/index.d.ts +0 -0
- /package/{dist → node_modules/@scaleway/sdk-client/dist}/internal/logger/level-resolver.d.ts +0 -0
- /package/{dist → node_modules/@scaleway/sdk-client/dist}/internal/logger/logger.d.ts +0 -0
- /package/{dist → node_modules/@scaleway/sdk-client/dist}/internal/validations/string-validation.d.ts +0 -0
- /package/{dist → node_modules/@scaleway/sdk-client/dist}/internals.d.ts +0 -0
- /package/{dist → node_modules/@scaleway/sdk-client/dist}/scw/api.d.ts +0 -0
- /package/{dist → node_modules/@scaleway/sdk-client/dist}/scw/auth.d.ts +0 -0
- /package/{dist → node_modules/@scaleway/sdk-client/dist}/scw/client-ini-factory.d.ts +0 -0
- /package/{dist → node_modules/@scaleway/sdk-client/dist}/scw/client-ini-profile.d.ts +0 -0
- /package/{dist → node_modules/@scaleway/sdk-client/dist}/scw/client-settings.d.ts +0 -0
- /package/{dist → node_modules/@scaleway/sdk-client/dist}/scw/constants.cjs +0 -0
- /package/{dist → node_modules/@scaleway/sdk-client/dist}/scw/constants.d.ts +0 -0
- /package/{dist → node_modules/@scaleway/sdk-client/dist}/scw/custom-marshalling.d.ts +0 -0
- /package/{dist → node_modules/@scaleway/sdk-client/dist}/scw/custom-types.d.ts +0 -0
- /package/{dist → node_modules/@scaleway/sdk-client/dist}/scw/errors/error-parser.d.ts +0 -0
- /package/{dist → node_modules/@scaleway/sdk-client/dist}/scw/errors/non-standard/invalid-request-mapper.d.ts +0 -0
- /package/{dist → node_modules/@scaleway/sdk-client/dist}/scw/errors/non-standard/unknown-resource-mapper.d.ts +0 -0
- /package/{dist → node_modules/@scaleway/sdk-client/dist}/scw/errors/scw-error-from-json.d.ts +0 -0
- /package/{dist → node_modules/@scaleway/sdk-client/dist}/scw/errors/scw-error.d.ts +0 -0
- /package/{dist → node_modules/@scaleway/sdk-client/dist}/scw/errors/standard/already-exists-error.d.ts +0 -0
- /package/{dist → node_modules/@scaleway/sdk-client/dist}/scw/errors/standard/denied-authentication-error.d.ts +0 -0
- /package/{dist → node_modules/@scaleway/sdk-client/dist}/scw/errors/standard/index.d.ts +0 -0
- /package/{dist → node_modules/@scaleway/sdk-client/dist}/scw/errors/standard/out-of-stock-error.d.ts +0 -0
- /package/{dist → node_modules/@scaleway/sdk-client/dist}/scw/errors/standard/precondition-failed-error.d.ts +0 -0
- /package/{dist → node_modules/@scaleway/sdk-client/dist}/scw/errors/standard/quotas-exceeded-error.d.ts +0 -0
- /package/{dist → node_modules/@scaleway/sdk-client/dist}/scw/errors/standard/resource-expired-error.d.ts +0 -0
- /package/{dist → node_modules/@scaleway/sdk-client/dist}/scw/errors/standard/resource-locked-error.d.ts +0 -0
- /package/{dist → node_modules/@scaleway/sdk-client/dist}/scw/errors/standard/resource-not-found-error.d.ts +0 -0
- /package/{dist → node_modules/@scaleway/sdk-client/dist}/scw/errors/standard/transient-state-error.d.ts +0 -0
- /package/{dist → node_modules/@scaleway/sdk-client/dist}/scw/errors/types.d.ts +0 -0
- /package/{dist → node_modules/@scaleway/sdk-client/dist}/scw/fetch/build-fetcher.d.ts +0 -0
- /package/{dist → node_modules/@scaleway/sdk-client/dist}/scw/fetch/http-dumper.d.ts +0 -0
- /package/{dist → node_modules/@scaleway/sdk-client/dist}/scw/fetch/http-interceptors.d.ts +0 -0
- /package/{dist → node_modules/@scaleway/sdk-client/dist}/scw/fetch/resource-paginator.d.ts +0 -0
- /package/{dist → node_modules/@scaleway/sdk-client/dist}/scw/fetch/response-parser.d.ts +0 -0
- /package/{dist → node_modules/@scaleway/sdk-client/dist}/scw/locality.d.ts +0 -0
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
import type { Region as ScwRegion, Zone as ScwZone } from '
|
|
1
|
+
import type { Region as ScwRegion, Zone as ScwZone } from '@scaleway/sdk-client';
|
|
2
2
|
export type AclActionRedirectRedirectType = 'location' | 'scheme';
|
|
3
3
|
export type AclActionType = 'allow' | 'deny' | 'redirect';
|
|
4
4
|
export type AclHttpFilter = 'acl_http_filter_none' | 'path_begin' | 'path_end' | 'regex' | 'http_header_match';
|
|
@@ -26,59 +26,72 @@ export type ProxyProtocol = 'proxy_protocol_unknown' | 'proxy_protocol_none' | '
|
|
|
26
26
|
export type SSLCompatibilityLevel = 'ssl_compatibility_level_unknown' | 'ssl_compatibility_level_intermediate' | 'ssl_compatibility_level_modern' | 'ssl_compatibility_level_old';
|
|
27
27
|
export type StickySessionsType = 'none' | 'cookie' | 'table';
|
|
28
28
|
export interface SubscriberEmailConfig {
|
|
29
|
-
/**
|
|
29
|
+
/**
|
|
30
|
+
* Email address to send alerts to.
|
|
31
|
+
*/
|
|
30
32
|
email: string;
|
|
31
33
|
}
|
|
32
|
-
/**
|
|
34
|
+
/**
|
|
35
|
+
* Webhook alert of subscriber.
|
|
36
|
+
*/
|
|
33
37
|
export interface SubscriberWebhookConfig {
|
|
34
|
-
/**
|
|
38
|
+
/**
|
|
39
|
+
* URI to receive POST requests.
|
|
40
|
+
*/
|
|
35
41
|
uri: string;
|
|
36
42
|
}
|
|
37
43
|
export interface HealthCheckHttpConfig {
|
|
38
|
-
/**
|
|
44
|
+
/**
|
|
45
|
+
* The HTTP path to use when performing a health check on backend servers.
|
|
46
|
+
*/
|
|
39
47
|
uri: string;
|
|
40
|
-
/**
|
|
48
|
+
/**
|
|
49
|
+
* The HTTP method used when performing a health check on backend servers.
|
|
50
|
+
*/
|
|
41
51
|
method: string;
|
|
42
52
|
/**
|
|
43
|
-
* The HTTP response code that should be returned for a health check to be
|
|
44
|
-
* considered successful.
|
|
53
|
+
* The HTTP response code that should be returned for a health check to be considered successful.
|
|
45
54
|
*/
|
|
46
55
|
code?: number;
|
|
47
56
|
/**
|
|
48
|
-
* The HTTP host header used when performing a health check on backend
|
|
49
|
-
* servers.
|
|
57
|
+
* The HTTP host header used when performing a health check on backend servers.
|
|
50
58
|
*/
|
|
51
59
|
hostHeader: string;
|
|
52
60
|
}
|
|
53
61
|
export interface HealthCheckHttpsConfig {
|
|
54
|
-
/**
|
|
62
|
+
/**
|
|
63
|
+
* The HTTP path to use when performing a health check on backend servers.
|
|
64
|
+
*/
|
|
55
65
|
uri: string;
|
|
56
|
-
/**
|
|
66
|
+
/**
|
|
67
|
+
* The HTTP method used when performing a health check on backend servers.
|
|
68
|
+
*/
|
|
57
69
|
method: string;
|
|
58
70
|
/**
|
|
59
|
-
* The HTTP response code that should be returned for a health check to be
|
|
60
|
-
* considered successful.
|
|
71
|
+
* The HTTP response code that should be returned for a health check to be considered successful.
|
|
61
72
|
*/
|
|
62
73
|
code?: number;
|
|
63
74
|
/**
|
|
64
|
-
* The HTTP host header used when performing a health check on backend
|
|
65
|
-
* servers.
|
|
75
|
+
* The HTTP host header used when performing a health check on backend servers.
|
|
66
76
|
*/
|
|
67
77
|
hostHeader: string;
|
|
68
78
|
/**
|
|
69
|
-
* The SNI value used when performing a health check on backend servers over
|
|
70
|
-
* SSL.
|
|
79
|
+
* The SNI value used when performing a health check on backend servers over SSL.
|
|
71
80
|
*/
|
|
72
81
|
sni: string;
|
|
73
82
|
}
|
|
74
83
|
export interface HealthCheckLdapConfig {
|
|
75
84
|
}
|
|
76
85
|
export interface HealthCheckMysqlConfig {
|
|
77
|
-
/**
|
|
86
|
+
/**
|
|
87
|
+
* MySQL user to use for the health check.
|
|
88
|
+
*/
|
|
78
89
|
user: string;
|
|
79
90
|
}
|
|
80
91
|
export interface HealthCheckPgsqlConfig {
|
|
81
|
-
/**
|
|
92
|
+
/**
|
|
93
|
+
* PostgreSQL user to use for the health check.
|
|
94
|
+
*/
|
|
82
95
|
user: string;
|
|
83
96
|
}
|
|
84
97
|
export interface HealthCheckRedisConfig {
|
|
@@ -86,2692 +99,3397 @@ export interface HealthCheckRedisConfig {
|
|
|
86
99
|
export interface HealthCheckTcpConfig {
|
|
87
100
|
}
|
|
88
101
|
export interface Instance {
|
|
89
|
-
/**
|
|
102
|
+
/**
|
|
103
|
+
* Underlying Instance ID.
|
|
104
|
+
*/
|
|
90
105
|
id: string;
|
|
91
|
-
/**
|
|
106
|
+
/**
|
|
107
|
+
* Instance status.
|
|
108
|
+
*/
|
|
92
109
|
status: InstanceStatus;
|
|
93
|
-
/**
|
|
110
|
+
/**
|
|
111
|
+
* Instance IP address.
|
|
112
|
+
*/
|
|
94
113
|
ipAddress: string;
|
|
95
|
-
/**
|
|
114
|
+
/**
|
|
115
|
+
* Date on which the Instance was created.
|
|
116
|
+
*/
|
|
96
117
|
createdAt?: Date;
|
|
97
|
-
/**
|
|
118
|
+
/**
|
|
119
|
+
* Date on which the Instance was last updated.
|
|
120
|
+
*/
|
|
98
121
|
updatedAt?: Date;
|
|
99
|
-
/**
|
|
122
|
+
/**
|
|
123
|
+
* @deprecated The region the Instance is in.
|
|
124
|
+
*/
|
|
100
125
|
region?: ScwRegion;
|
|
101
|
-
/**
|
|
126
|
+
/**
|
|
127
|
+
* The zone the Instance is in.
|
|
128
|
+
*/
|
|
102
129
|
zone: ScwZone;
|
|
103
130
|
}
|
|
104
131
|
export interface Ip {
|
|
105
|
-
/**
|
|
132
|
+
/**
|
|
133
|
+
* IP address ID.
|
|
134
|
+
*/
|
|
106
135
|
id: string;
|
|
107
|
-
/**
|
|
136
|
+
/**
|
|
137
|
+
* IP address.
|
|
138
|
+
*/
|
|
108
139
|
ipAddress: string;
|
|
109
|
-
/**
|
|
140
|
+
/**
|
|
141
|
+
* Organization ID of the Scaleway Organization the IP address is in.
|
|
142
|
+
*/
|
|
110
143
|
organizationId: string;
|
|
111
|
-
/**
|
|
144
|
+
/**
|
|
145
|
+
* Project ID of the Scaleway Project the IP address is in.
|
|
146
|
+
*/
|
|
112
147
|
projectId: string;
|
|
113
|
-
/**
|
|
148
|
+
/**
|
|
149
|
+
* Load Balancer ID.
|
|
150
|
+
*/
|
|
114
151
|
lbId?: string;
|
|
115
|
-
/**
|
|
152
|
+
/**
|
|
153
|
+
* Reverse DNS (domain name) of the IP address.
|
|
154
|
+
*/
|
|
116
155
|
reverse: string;
|
|
117
|
-
/**
|
|
156
|
+
/**
|
|
157
|
+
* IP tags.
|
|
158
|
+
*/
|
|
118
159
|
tags: string[];
|
|
119
|
-
/**
|
|
160
|
+
/**
|
|
161
|
+
* @deprecated The region the IP address is in.
|
|
162
|
+
*/
|
|
120
163
|
region?: ScwRegion;
|
|
121
|
-
/**
|
|
164
|
+
/**
|
|
165
|
+
* The zone the IP address is in.
|
|
166
|
+
*/
|
|
122
167
|
zone: ScwZone;
|
|
123
168
|
}
|
|
124
|
-
/**
|
|
169
|
+
/**
|
|
170
|
+
* Subscriber.
|
|
171
|
+
*/
|
|
125
172
|
export interface Subscriber {
|
|
126
|
-
/**
|
|
173
|
+
/**
|
|
174
|
+
* Subscriber ID.
|
|
175
|
+
*/
|
|
127
176
|
id: string;
|
|
128
|
-
/**
|
|
177
|
+
/**
|
|
178
|
+
* Subscriber name.
|
|
179
|
+
*/
|
|
129
180
|
name: string;
|
|
130
181
|
/**
|
|
131
182
|
* Email address of subscriber.
|
|
132
183
|
*
|
|
133
|
-
* One-of ('config'): at most one of 'emailConfig', 'webhookConfig' could be
|
|
134
|
-
* set.
|
|
184
|
+
* One-of ('config'): at most one of 'emailConfig', 'webhookConfig' could be set.
|
|
135
185
|
*/
|
|
136
186
|
emailConfig?: SubscriberEmailConfig;
|
|
137
187
|
/**
|
|
138
188
|
* Webhook URI of subscriber.
|
|
139
189
|
*
|
|
140
|
-
* One-of ('config'): at most one of 'emailConfig', 'webhookConfig' could be
|
|
141
|
-
* set.
|
|
190
|
+
* One-of ('config'): at most one of 'emailConfig', 'webhookConfig' could be set.
|
|
142
191
|
*/
|
|
143
192
|
webhookConfig?: SubscriberWebhookConfig;
|
|
144
193
|
}
|
|
145
194
|
export interface HealthCheck {
|
|
146
|
-
/**
|
|
195
|
+
/**
|
|
196
|
+
* Port to use for the backend server health check.
|
|
197
|
+
*/
|
|
147
198
|
port: number;
|
|
148
|
-
/**
|
|
199
|
+
/**
|
|
200
|
+
* Time to wait between two consecutive health checks.
|
|
201
|
+
*/
|
|
149
202
|
checkDelay?: string;
|
|
150
|
-
/**
|
|
203
|
+
/**
|
|
204
|
+
* Maximum time a backend server has to reply to the health check.
|
|
205
|
+
*/
|
|
151
206
|
checkTimeout?: string;
|
|
152
207
|
/**
|
|
153
|
-
* Number of consecutive unsuccessful health checks after which the server
|
|
154
|
-
* will be considered dead.
|
|
208
|
+
* Number of consecutive unsuccessful health checks after which the server will be considered dead.
|
|
155
209
|
*/
|
|
156
210
|
checkMaxRetries: number;
|
|
157
211
|
/**
|
|
158
212
|
* Object to configure a basic TCP health check.
|
|
159
213
|
*
|
|
160
|
-
* One-of ('config'): at most one of 'tcpConfig', 'mysqlConfig',
|
|
161
|
-
* 'pgsqlConfig', 'ldapConfig', 'redisConfig', 'httpConfig', 'httpsConfig'
|
|
162
|
-
* could be set.
|
|
214
|
+
* One-of ('config'): at most one of 'tcpConfig', 'mysqlConfig', 'pgsqlConfig', 'ldapConfig', 'redisConfig', 'httpConfig', 'httpsConfig' could be set.
|
|
163
215
|
*/
|
|
164
216
|
tcpConfig?: HealthCheckTcpConfig;
|
|
165
217
|
/**
|
|
166
|
-
* Object to configure a MySQL health check. The check requires MySQL >=3.22
|
|
167
|
-
* or <9.0. For older or newer versions, use a TCP health check.
|
|
218
|
+
* Object to configure a MySQL health check. The check requires MySQL >=3.22 or <9.0. For older or newer versions, use a TCP health check.
|
|
168
219
|
*
|
|
169
|
-
* One-of ('config'): at most one of 'tcpConfig', 'mysqlConfig',
|
|
170
|
-
* 'pgsqlConfig', 'ldapConfig', 'redisConfig', 'httpConfig', 'httpsConfig'
|
|
171
|
-
* could be set.
|
|
220
|
+
* One-of ('config'): at most one of 'tcpConfig', 'mysqlConfig', 'pgsqlConfig', 'ldapConfig', 'redisConfig', 'httpConfig', 'httpsConfig' could be set.
|
|
172
221
|
*/
|
|
173
222
|
mysqlConfig?: HealthCheckMysqlConfig;
|
|
174
223
|
/**
|
|
175
224
|
* Object to configure a PostgreSQL health check.
|
|
176
225
|
*
|
|
177
|
-
* One-of ('config'): at most one of 'tcpConfig', 'mysqlConfig',
|
|
178
|
-
* 'pgsqlConfig', 'ldapConfig', 'redisConfig', 'httpConfig', 'httpsConfig'
|
|
179
|
-
* could be set.
|
|
226
|
+
* One-of ('config'): at most one of 'tcpConfig', 'mysqlConfig', 'pgsqlConfig', 'ldapConfig', 'redisConfig', 'httpConfig', 'httpsConfig' could be set.
|
|
180
227
|
*/
|
|
181
228
|
pgsqlConfig?: HealthCheckPgsqlConfig;
|
|
182
229
|
/**
|
|
183
|
-
* Object to configure an LDAP health check. The response is analyzed to find
|
|
184
|
-
* the LDAPv3 response message.
|
|
230
|
+
* Object to configure an LDAP health check. The response is analyzed to find the LDAPv3 response message.
|
|
185
231
|
*
|
|
186
|
-
* One-of ('config'): at most one of 'tcpConfig', 'mysqlConfig',
|
|
187
|
-
* 'pgsqlConfig', 'ldapConfig', 'redisConfig', 'httpConfig', 'httpsConfig'
|
|
188
|
-
* could be set.
|
|
232
|
+
* One-of ('config'): at most one of 'tcpConfig', 'mysqlConfig', 'pgsqlConfig', 'ldapConfig', 'redisConfig', 'httpConfig', 'httpsConfig' could be set.
|
|
189
233
|
*/
|
|
190
234
|
ldapConfig?: HealthCheckLdapConfig;
|
|
191
235
|
/**
|
|
192
|
-
* Object to configure a Redis health check. The response is analyzed to find
|
|
193
|
-
* the +PONG response message.
|
|
236
|
+
* Object to configure a Redis health check. The response is analyzed to find the +PONG response message.
|
|
194
237
|
*
|
|
195
|
-
* One-of ('config'): at most one of 'tcpConfig', 'mysqlConfig',
|
|
196
|
-
* 'pgsqlConfig', 'ldapConfig', 'redisConfig', 'httpConfig', 'httpsConfig'
|
|
197
|
-
* could be set.
|
|
238
|
+
* One-of ('config'): at most one of 'tcpConfig', 'mysqlConfig', 'pgsqlConfig', 'ldapConfig', 'redisConfig', 'httpConfig', 'httpsConfig' could be set.
|
|
198
239
|
*/
|
|
199
240
|
redisConfig?: HealthCheckRedisConfig;
|
|
200
241
|
/**
|
|
201
242
|
* Object to configure an HTTP health check.
|
|
202
243
|
*
|
|
203
|
-
* One-of ('config'): at most one of 'tcpConfig', 'mysqlConfig',
|
|
204
|
-
* 'pgsqlConfig', 'ldapConfig', 'redisConfig', 'httpConfig', 'httpsConfig'
|
|
205
|
-
* could be set.
|
|
244
|
+
* One-of ('config'): at most one of 'tcpConfig', 'mysqlConfig', 'pgsqlConfig', 'ldapConfig', 'redisConfig', 'httpConfig', 'httpsConfig' could be set.
|
|
206
245
|
*/
|
|
207
246
|
httpConfig?: HealthCheckHttpConfig;
|
|
208
247
|
/**
|
|
209
248
|
* Object to configure an HTTPS health check.
|
|
210
249
|
*
|
|
211
|
-
* One-of ('config'): at most one of 'tcpConfig', 'mysqlConfig',
|
|
212
|
-
* 'pgsqlConfig', 'ldapConfig', 'redisConfig', 'httpConfig', 'httpsConfig'
|
|
213
|
-
* could be set.
|
|
250
|
+
* One-of ('config'): at most one of 'tcpConfig', 'mysqlConfig', 'pgsqlConfig', 'ldapConfig', 'redisConfig', 'httpConfig', 'httpsConfig' could be set.
|
|
214
251
|
*/
|
|
215
252
|
httpsConfig?: HealthCheckHttpsConfig;
|
|
216
|
-
/**
|
|
253
|
+
/**
|
|
254
|
+
* Defines whether proxy protocol should be activated for the health check.
|
|
255
|
+
*/
|
|
217
256
|
checkSendProxy: boolean;
|
|
218
257
|
/**
|
|
219
|
-
* Time to wait between two consecutive health checks when a backend server is
|
|
220
|
-
* in a transient state (going UP or DOWN).
|
|
258
|
+
* Time to wait between two consecutive health checks when a backend server is in a transient state (going UP or DOWN).
|
|
221
259
|
*/
|
|
222
260
|
transientCheckDelay?: string;
|
|
223
261
|
}
|
|
224
262
|
export interface Lb {
|
|
225
|
-
/**
|
|
263
|
+
/**
|
|
264
|
+
* Underlying Instance ID.
|
|
265
|
+
*/
|
|
226
266
|
id: string;
|
|
227
|
-
/**
|
|
267
|
+
/**
|
|
268
|
+
* Load Balancer name.
|
|
269
|
+
*/
|
|
228
270
|
name: string;
|
|
229
|
-
/**
|
|
271
|
+
/**
|
|
272
|
+
* Load Balancer description.
|
|
273
|
+
*/
|
|
230
274
|
description: string;
|
|
231
|
-
/**
|
|
275
|
+
/**
|
|
276
|
+
* Load Balancer status.
|
|
277
|
+
*/
|
|
232
278
|
status: LbStatus;
|
|
233
|
-
/**
|
|
279
|
+
/**
|
|
280
|
+
* List of underlying Instances.
|
|
281
|
+
*/
|
|
234
282
|
instances: Instance[];
|
|
235
|
-
/**
|
|
283
|
+
/**
|
|
284
|
+
* Scaleway Organization ID.
|
|
285
|
+
*/
|
|
236
286
|
organizationId: string;
|
|
237
|
-
/**
|
|
287
|
+
/**
|
|
288
|
+
* Scaleway Project ID.
|
|
289
|
+
*/
|
|
238
290
|
projectId: string;
|
|
239
|
-
/**
|
|
291
|
+
/**
|
|
292
|
+
* List of IP addresses attached to the Load Balancer.
|
|
293
|
+
*/
|
|
240
294
|
ip: Ip[];
|
|
241
|
-
/**
|
|
295
|
+
/**
|
|
296
|
+
* Load Balancer tags.
|
|
297
|
+
*/
|
|
242
298
|
tags: string[];
|
|
243
|
-
/**
|
|
299
|
+
/**
|
|
300
|
+
* Number of frontends the Load Balancer has.
|
|
301
|
+
*/
|
|
244
302
|
frontendCount: number;
|
|
245
|
-
/**
|
|
303
|
+
/**
|
|
304
|
+
* Number of backends the Load Balancer has.
|
|
305
|
+
*/
|
|
246
306
|
backendCount: number;
|
|
247
|
-
/**
|
|
307
|
+
/**
|
|
308
|
+
* Load Balancer offer type.
|
|
309
|
+
*/
|
|
248
310
|
type: string;
|
|
249
|
-
/**
|
|
311
|
+
/**
|
|
312
|
+
* Subscriber information.
|
|
313
|
+
*/
|
|
250
314
|
subscriber?: Subscriber;
|
|
251
315
|
/**
|
|
252
|
-
* Determines the minimal SSL version which needs to be supported on client
|
|
253
|
-
* side.
|
|
316
|
+
* Determines the minimal SSL version which needs to be supported on client side.
|
|
254
317
|
*/
|
|
255
318
|
sslCompatibilityLevel: SSLCompatibilityLevel;
|
|
256
|
-
/**
|
|
319
|
+
/**
|
|
320
|
+
* Date on which the Load Balancer was created.
|
|
321
|
+
*/
|
|
257
322
|
createdAt?: Date;
|
|
258
|
-
/**
|
|
323
|
+
/**
|
|
324
|
+
* Date on which the Load Balancer was last updated.
|
|
325
|
+
*/
|
|
259
326
|
updatedAt?: Date;
|
|
260
|
-
/**
|
|
327
|
+
/**
|
|
328
|
+
* Number of Private Networks attached to the Load Balancer.
|
|
329
|
+
*/
|
|
261
330
|
privateNetworkCount: number;
|
|
262
|
-
/**
|
|
331
|
+
/**
|
|
332
|
+
* Number of routes configured on the Load Balancer.
|
|
333
|
+
*/
|
|
263
334
|
routeCount: number;
|
|
264
|
-
/**
|
|
335
|
+
/**
|
|
336
|
+
* @deprecated The region the Load Balancer is in.
|
|
337
|
+
*/
|
|
265
338
|
region?: ScwRegion;
|
|
266
|
-
/**
|
|
339
|
+
/**
|
|
340
|
+
* The zone the Load Balancer is in.
|
|
341
|
+
*/
|
|
267
342
|
zone: ScwZone;
|
|
268
343
|
}
|
|
269
344
|
export interface AclActionRedirect {
|
|
270
|
-
/**
|
|
345
|
+
/**
|
|
346
|
+
* Redirect type.
|
|
347
|
+
*/
|
|
271
348
|
type: AclActionRedirectRedirectType;
|
|
272
349
|
/**
|
|
273
|
-
* Redirect target. For a location redirect, you can use a URL e.g.
|
|
274
|
-
* `https://scaleway.com`. Using a scheme name (e.g. `https`, `http`, `ftp`,
|
|
275
|
-
* `git`) will replace the request's original scheme. This can be useful to
|
|
276
|
-
* implement HTTP to HTTPS redirects. Valid placeholders that can be used in a
|
|
277
|
-
* `location` redirect to preserve parts of the original request in the
|
|
278
|
-
* redirection URL are {{host}}, {{query}}, {{path}} and {{scheme}}.
|
|
350
|
+
* Redirect target. For a location redirect, you can use a URL e.g. `https://scaleway.com`. Using a scheme name (e.g. `https`, `http`, `ftp`, `git`) will replace the request's original scheme. This can be useful to implement HTTP to HTTPS redirects. Valid placeholders that can be used in a `location` redirect to preserve parts of the original request in the redirection URL are \{\{host\}\}, \{\{query\}\}, \{\{path\}\} and \{\{scheme\}\}.
|
|
279
351
|
*/
|
|
280
352
|
target: string;
|
|
281
353
|
/**
|
|
282
|
-
* HTTP redirect code to use. Valid values are 301, 302, 303, 307 and 308.
|
|
283
|
-
* Default value is 302.
|
|
354
|
+
* HTTP redirect code to use. Valid values are 301, 302, 303, 307 and 308. Default value is 302.
|
|
284
355
|
*/
|
|
285
356
|
code?: number;
|
|
286
357
|
}
|
|
287
358
|
export interface Backend {
|
|
288
|
-
/**
|
|
359
|
+
/**
|
|
360
|
+
* Backend ID.
|
|
361
|
+
*/
|
|
289
362
|
id: string;
|
|
290
|
-
/**
|
|
363
|
+
/**
|
|
364
|
+
* Name of the backend.
|
|
365
|
+
*/
|
|
291
366
|
name: string;
|
|
292
|
-
/**
|
|
367
|
+
/**
|
|
368
|
+
* Protocol used by the backend when forwarding traffic to backend servers.
|
|
369
|
+
*/
|
|
293
370
|
forwardProtocol: Protocol;
|
|
294
|
-
/**
|
|
371
|
+
/**
|
|
372
|
+
* Port used by the backend when forwarding traffic to backend servers.
|
|
373
|
+
*/
|
|
295
374
|
forwardPort: number;
|
|
296
375
|
/**
|
|
297
|
-
* Load balancing algorithm to use when determining which backend server to
|
|
298
|
-
* forward new traffic to.
|
|
376
|
+
* Load balancing algorithm to use when determining which backend server to forward new traffic to.
|
|
299
377
|
*/
|
|
300
378
|
forwardPortAlgorithm: ForwardPortAlgorithm;
|
|
301
379
|
/**
|
|
302
|
-
* Defines whether sticky sessions (binding a particular session to a
|
|
303
|
-
* particular backend server) are activated and the method to use if so. None
|
|
304
|
-
* disables sticky sessions. Cookie-based uses an HTTP cookie to stick a
|
|
305
|
-
* session to a backend server. Table-based uses the source (client) IP
|
|
306
|
-
* address to stick a session to a backend server.
|
|
380
|
+
* Defines whether sticky sessions (binding a particular session to a particular backend server) are activated and the method to use if so. None disables sticky sessions. Cookie-based uses an HTTP cookie to stick a session to a backend server. Table-based uses the source (client) IP address to stick a session to a backend server.
|
|
307
381
|
*/
|
|
308
382
|
stickySessions: StickySessionsType;
|
|
309
|
-
/**
|
|
383
|
+
/**
|
|
384
|
+
* Cookie name for cookie-based sticky sessions.
|
|
385
|
+
*/
|
|
310
386
|
stickySessionsCookieName: string;
|
|
311
387
|
/**
|
|
312
|
-
* Object defining the health check to be carried out by the backend when
|
|
313
|
-
* checking the status and health of backend servers.
|
|
388
|
+
* Object defining the health check to be carried out by the backend when checking the status and health of backend servers.
|
|
314
389
|
*/
|
|
315
390
|
healthCheck?: HealthCheck;
|
|
316
|
-
/**
|
|
391
|
+
/**
|
|
392
|
+
* List of IP addresses of backend servers attached to this backend.
|
|
393
|
+
*/
|
|
317
394
|
pool: string[];
|
|
318
|
-
/**
|
|
395
|
+
/**
|
|
396
|
+
* Load Balancer the backend is attached to.
|
|
397
|
+
*/
|
|
319
398
|
lb?: Lb;
|
|
320
|
-
/**
|
|
399
|
+
/**
|
|
400
|
+
* @deprecated Deprecated in favor of proxy_protocol field.
|
|
401
|
+
*/
|
|
321
402
|
sendProxyV2?: boolean;
|
|
322
|
-
/**
|
|
403
|
+
/**
|
|
404
|
+
* Maximum allowed time for a backend server to process a request.
|
|
405
|
+
*/
|
|
323
406
|
timeoutServer?: string;
|
|
324
|
-
/**
|
|
407
|
+
/**
|
|
408
|
+
* Maximum allowed time for establishing a connection to a backend server.
|
|
409
|
+
*/
|
|
325
410
|
timeoutConnect?: string;
|
|
326
411
|
/**
|
|
327
|
-
* Maximum allowed tunnel inactivity time after Websocket is established
|
|
328
|
-
* (takes precedence over client and server timeout).
|
|
412
|
+
* Maximum allowed tunnel inactivity time after Websocket is established (takes precedence over client and server timeout).
|
|
329
413
|
*/
|
|
330
414
|
timeoutTunnel?: string;
|
|
331
|
-
/**
|
|
415
|
+
/**
|
|
416
|
+
* Action to take when a backend server is marked as down.
|
|
417
|
+
*/
|
|
332
418
|
onMarkedDownAction: OnMarkedDownAction;
|
|
333
419
|
/**
|
|
334
|
-
* Protocol to use between the Load Balancer and backend servers. Allows the
|
|
335
|
-
* backend servers to be informed of the client's real IP address. The PROXY
|
|
336
|
-
* protocol must be supported by the backend servers' software.
|
|
420
|
+
* Protocol to use between the Load Balancer and backend servers. Allows the backend servers to be informed of the client's real IP address. The PROXY protocol must be supported by the backend servers' software.
|
|
337
421
|
*/
|
|
338
422
|
proxyProtocol: ProxyProtocol;
|
|
339
|
-
/**
|
|
423
|
+
/**
|
|
424
|
+
* Date at which the backend was created.
|
|
425
|
+
*/
|
|
340
426
|
createdAt?: Date;
|
|
341
|
-
/**
|
|
427
|
+
/**
|
|
428
|
+
* Date at which the backend was updated.
|
|
429
|
+
*/
|
|
342
430
|
updatedAt?: Date;
|
|
343
431
|
/**
|
|
344
|
-
* Scaleway Object Storage bucket website to be served as failover if all
|
|
345
|
-
* backend servers are down, e.g.
|
|
346
|
-
* failover-website.s3-website.fr-par.scw.cloud.
|
|
432
|
+
* Scaleway Object Storage bucket website to be served as failover if all backend servers are down, e.g. failover-website.s3-website.fr-par.scw.cloud.
|
|
347
433
|
*/
|
|
348
434
|
failoverHost?: string;
|
|
349
435
|
/**
|
|
350
|
-
* Defines whether to enable SSL bridging between the Load Balancer and
|
|
351
|
-
* backend servers.
|
|
436
|
+
* Defines whether to enable SSL bridging between the Load Balancer and backend servers.
|
|
352
437
|
*/
|
|
353
438
|
sslBridging?: boolean;
|
|
354
|
-
/**
|
|
439
|
+
/**
|
|
440
|
+
* Defines whether the server certificate verification should be ignored.
|
|
441
|
+
*/
|
|
355
442
|
ignoreSslServerVerify?: boolean;
|
|
356
|
-
/**
|
|
443
|
+
/**
|
|
444
|
+
* Whether to use another backend server on each attempt.
|
|
445
|
+
*/
|
|
357
446
|
redispatchAttemptCount?: number;
|
|
358
|
-
/**
|
|
447
|
+
/**
|
|
448
|
+
* Number of retries when a backend server connection failed.
|
|
449
|
+
*/
|
|
359
450
|
maxRetries?: number;
|
|
360
|
-
/**
|
|
451
|
+
/**
|
|
452
|
+
* Maximum number of connections allowed per backend server.
|
|
453
|
+
*/
|
|
361
454
|
maxConnections?: number;
|
|
362
455
|
/**
|
|
363
|
-
* Maximum time for a request to be left pending in queue when
|
|
364
|
-
* `max_connections` is reached.
|
|
456
|
+
* Maximum time for a request to be left pending in queue when `max_connections` is reached.
|
|
365
457
|
*/
|
|
366
458
|
timeoutQueue?: string;
|
|
367
459
|
}
|
|
368
460
|
export interface Certificate {
|
|
369
|
-
/**
|
|
461
|
+
/**
|
|
462
|
+
* Certificate type (Let's Encrypt or custom).
|
|
463
|
+
*/
|
|
370
464
|
type: CertificateType;
|
|
371
|
-
/**
|
|
465
|
+
/**
|
|
466
|
+
* Certificate ID.
|
|
467
|
+
*/
|
|
372
468
|
id: string;
|
|
373
|
-
/**
|
|
469
|
+
/**
|
|
470
|
+
* Main domain name of certificate.
|
|
471
|
+
*/
|
|
374
472
|
commonName: string;
|
|
375
|
-
/**
|
|
473
|
+
/**
|
|
474
|
+
* Alternative domain names.
|
|
475
|
+
*/
|
|
376
476
|
subjectAlternativeName: string[];
|
|
377
|
-
/**
|
|
477
|
+
/**
|
|
478
|
+
* Identifier (SHA-1) of the certificate.
|
|
479
|
+
*/
|
|
378
480
|
fingerprint: string;
|
|
379
|
-
/**
|
|
481
|
+
/**
|
|
482
|
+
* Lower validity bound.
|
|
483
|
+
*/
|
|
380
484
|
notValidBefore?: Date;
|
|
381
|
-
/**
|
|
485
|
+
/**
|
|
486
|
+
* Upper validity bound.
|
|
487
|
+
*/
|
|
382
488
|
notValidAfter?: Date;
|
|
383
|
-
/**
|
|
489
|
+
/**
|
|
490
|
+
* Certificate status.
|
|
491
|
+
*/
|
|
384
492
|
status: CertificateStatus;
|
|
385
|
-
/**
|
|
493
|
+
/**
|
|
494
|
+
* Load Balancer object the certificate is attached to.
|
|
495
|
+
*/
|
|
386
496
|
lb?: Lb;
|
|
387
|
-
/**
|
|
497
|
+
/**
|
|
498
|
+
* Certificate name.
|
|
499
|
+
*/
|
|
388
500
|
name: string;
|
|
389
|
-
/**
|
|
501
|
+
/**
|
|
502
|
+
* Date on which the certificate was created.
|
|
503
|
+
*/
|
|
390
504
|
createdAt?: Date;
|
|
391
|
-
/**
|
|
505
|
+
/**
|
|
506
|
+
* Date on which the certificate was last updated.
|
|
507
|
+
*/
|
|
392
508
|
updatedAt?: Date;
|
|
393
509
|
/**
|
|
394
|
-
* Additional information about the certificate status (useful in case of
|
|
395
|
-
* certificate generation failure, for example).
|
|
510
|
+
* Additional information about the certificate status (useful in case of certificate generation failure, for example).
|
|
396
511
|
*/
|
|
397
512
|
statusDetails?: string;
|
|
398
513
|
}
|
|
399
514
|
export interface AclAction {
|
|
400
|
-
/**
|
|
515
|
+
/**
|
|
516
|
+
* Action to take when incoming traffic matches an ACL filter.
|
|
517
|
+
*/
|
|
401
518
|
type: AclActionType;
|
|
402
|
-
/**
|
|
519
|
+
/**
|
|
520
|
+
* Redirection parameters when using an ACL with a `redirect` action.
|
|
521
|
+
*/
|
|
403
522
|
redirect?: AclActionRedirect;
|
|
404
523
|
}
|
|
405
524
|
export interface AclMatch {
|
|
406
|
-
/**
|
|
525
|
+
/**
|
|
526
|
+
* List of IPs or CIDR v4/v6 addresses to filter for from the client side.
|
|
527
|
+
*/
|
|
407
528
|
ipSubnet: string[];
|
|
408
529
|
/**
|
|
409
|
-
* Type of HTTP filter to match. Extracts the request's URL path, which starts
|
|
410
|
-
* at the first slash and ends before the question mark (without the host
|
|
411
|
-
* part). Defines where to filter for the http_filter_value. Only supported
|
|
412
|
-
* for HTTP backends.
|
|
530
|
+
* Type of HTTP filter to match. Extracts the request's URL path, which starts at the first slash and ends before the question mark (without the host part). Defines where to filter for the http_filter_value. Only supported for HTTP backends.
|
|
413
531
|
*/
|
|
414
532
|
httpFilter: AclHttpFilter;
|
|
415
|
-
/**
|
|
533
|
+
/**
|
|
534
|
+
* List of values to filter for.
|
|
535
|
+
*/
|
|
416
536
|
httpFilterValue: string[];
|
|
417
537
|
/**
|
|
418
|
-
* Name of the HTTP header to filter on if `http_header_match` was selected in
|
|
419
|
-
* `http_filter`.
|
|
538
|
+
* Name of the HTTP header to filter on if `http_header_match` was selected in `http_filter`.
|
|
420
539
|
*/
|
|
421
540
|
httpFilterOption?: string;
|
|
422
541
|
/**
|
|
423
|
-
* Defines whether to invert the match condition. If set to `true`, the ACL
|
|
424
|
-
* carries out its action when the condition DOES NOT match.
|
|
542
|
+
* Defines whether to invert the match condition. If set to `true`, the ACL carries out its action when the condition DOES NOT match.
|
|
425
543
|
*/
|
|
426
544
|
invert: boolean;
|
|
427
545
|
}
|
|
428
546
|
export interface Frontend {
|
|
429
|
-
/**
|
|
547
|
+
/**
|
|
548
|
+
* Frontend ID.
|
|
549
|
+
*/
|
|
430
550
|
id: string;
|
|
431
|
-
/**
|
|
551
|
+
/**
|
|
552
|
+
* Name of the frontend.
|
|
553
|
+
*/
|
|
432
554
|
name: string;
|
|
433
|
-
/**
|
|
555
|
+
/**
|
|
556
|
+
* Port the frontend listens on.
|
|
557
|
+
*/
|
|
434
558
|
inboundPort: number;
|
|
435
|
-
/**
|
|
559
|
+
/**
|
|
560
|
+
* Backend object the frontend is attached to.
|
|
561
|
+
*/
|
|
436
562
|
backend?: Backend;
|
|
437
|
-
/**
|
|
563
|
+
/**
|
|
564
|
+
* Load Balancer object the frontend is attached to.
|
|
565
|
+
*/
|
|
438
566
|
lb?: Lb;
|
|
439
|
-
/**
|
|
567
|
+
/**
|
|
568
|
+
* Maximum allowed inactivity time on the client side.
|
|
569
|
+
*/
|
|
440
570
|
timeoutClient?: string;
|
|
441
|
-
/**
|
|
571
|
+
/**
|
|
572
|
+
* @deprecated Certificate, deprecated in favor of certificate_ids array.
|
|
573
|
+
*/
|
|
442
574
|
certificate?: Certificate;
|
|
443
|
-
/**
|
|
575
|
+
/**
|
|
576
|
+
* List of SSL/TLS certificate IDs to bind to the frontend.
|
|
577
|
+
*/
|
|
444
578
|
certificateIds: string[];
|
|
445
|
-
/**
|
|
579
|
+
/**
|
|
580
|
+
* Date on which the frontend was created.
|
|
581
|
+
*/
|
|
446
582
|
createdAt?: Date;
|
|
447
|
-
/**
|
|
583
|
+
/**
|
|
584
|
+
* Date on which the frontend was last updated.
|
|
585
|
+
*/
|
|
448
586
|
updatedAt?: Date;
|
|
449
|
-
/**
|
|
587
|
+
/**
|
|
588
|
+
* Defines whether to enable HTTP/3 protocol on the frontend.
|
|
589
|
+
*/
|
|
450
590
|
enableHttp3: boolean;
|
|
451
591
|
/**
|
|
452
|
-
* Rate limit for new connections established on this frontend. Use 0 value to
|
|
453
|
-
* disable, else value is connections per second.
|
|
592
|
+
* Rate limit for new connections established on this frontend. Use 0 value to disable, else value is connections per second.
|
|
454
593
|
*/
|
|
455
594
|
connectionRateLimit?: number;
|
|
456
595
|
}
|
|
457
596
|
export interface PrivateNetworkDHCPConfig {
|
|
458
|
-
/**
|
|
597
|
+
/**
|
|
598
|
+
* @deprecated
|
|
599
|
+
*/
|
|
459
600
|
ipId?: string;
|
|
460
601
|
}
|
|
461
602
|
export interface PrivateNetworkIpamConfig {
|
|
462
603
|
}
|
|
463
604
|
export interface PrivateNetworkStaticConfig {
|
|
464
605
|
/**
|
|
465
|
-
* @deprecated Array of a local IP address for the Load Balancer on this
|
|
466
|
-
* Private Network.
|
|
606
|
+
* @deprecated Array of a local IP address for the Load Balancer on this Private Network.
|
|
467
607
|
*/
|
|
468
608
|
ipAddress?: string[];
|
|
469
609
|
}
|
|
470
610
|
export interface RouteMatch {
|
|
471
611
|
/**
|
|
472
|
-
* Value to match in the Server Name Indication TLS extension (SNI) field from
|
|
473
|
-
* an incoming connection made via an SSL/TLS transport layer. This field
|
|
474
|
-
* should be set for routes on TCP Load Balancers.
|
|
612
|
+
* Value to match in the Server Name Indication TLS extension (SNI) field from an incoming connection made via an SSL/TLS transport layer. This field should be set for routes on TCP Load Balancers.
|
|
475
613
|
*
|
|
476
614
|
* One-of ('matchType'): at most one of 'sni', 'hostHeader' could be set.
|
|
477
615
|
*/
|
|
478
616
|
sni?: string;
|
|
479
617
|
/**
|
|
480
|
-
* Value to match in the HTTP Host request header from an incoming request.
|
|
481
|
-
* This field should be set for routes on HTTP Load Balancers.
|
|
618
|
+
* Value to match in the HTTP Host request header from an incoming request. This field should be set for routes on HTTP Load Balancers.
|
|
482
619
|
*
|
|
483
620
|
* One-of ('matchType'): at most one of 'sni', 'hostHeader' could be set.
|
|
484
621
|
*/
|
|
485
622
|
hostHeader?: string;
|
|
486
|
-
/**
|
|
623
|
+
/**
|
|
624
|
+
* If true, all subdomains will match.
|
|
625
|
+
*/
|
|
487
626
|
matchSubdomains: boolean;
|
|
488
627
|
}
|
|
489
628
|
export interface CreateCertificateRequestCustomCertificate {
|
|
490
629
|
/**
|
|
491
|
-
* Full PEM-formatted certificate, consisting of the entire certificate chain
|
|
492
|
-
* including public key, private key, and (optionally) Certificate
|
|
493
|
-
* Authorities.
|
|
630
|
+
* Full PEM-formatted certificate, consisting of the entire certificate chain including public key, private key, and (optionally) Certificate Authorities.
|
|
494
631
|
*/
|
|
495
632
|
certificateChain: string;
|
|
496
633
|
}
|
|
497
634
|
export interface CreateCertificateRequestLetsencryptConfig {
|
|
498
635
|
/**
|
|
499
|
-
* Main domain name of certificate (this domain must exist and resolve to your
|
|
500
|
-
* Load Balancer IP address).
|
|
636
|
+
* Main domain name of certificate (this domain must exist and resolve to your Load Balancer IP address).
|
|
501
637
|
*/
|
|
502
638
|
commonName: string;
|
|
503
639
|
/**
|
|
504
|
-
* Alternative domain names (all domain names must exist and resolve to your
|
|
505
|
-
* Load Balancer IP address).
|
|
640
|
+
* Alternative domain names (all domain names must exist and resolve to your Load Balancer IP address).
|
|
506
641
|
*/
|
|
507
642
|
subjectAlternativeName: string[];
|
|
508
643
|
}
|
|
509
644
|
export interface BackendServerStats {
|
|
510
|
-
/**
|
|
645
|
+
/**
|
|
646
|
+
* ID of your Load Balancer's underlying Instance.
|
|
647
|
+
*/
|
|
511
648
|
instanceId: string;
|
|
512
|
-
/**
|
|
649
|
+
/**
|
|
650
|
+
* Backend ID.
|
|
651
|
+
*/
|
|
513
652
|
backendId: string;
|
|
514
|
-
/**
|
|
653
|
+
/**
|
|
654
|
+
* IPv4 or IPv6 address of the backend server.
|
|
655
|
+
*/
|
|
515
656
|
ip: string;
|
|
516
|
-
/**
|
|
657
|
+
/**
|
|
658
|
+
* Server operational state (stopped/starting/running/stopping).
|
|
659
|
+
*/
|
|
517
660
|
serverState: BackendServerStatsServerState;
|
|
518
|
-
/**
|
|
661
|
+
/**
|
|
662
|
+
* Time since last operational change.
|
|
663
|
+
*/
|
|
519
664
|
serverStateChangedAt?: Date;
|
|
520
|
-
/**
|
|
665
|
+
/**
|
|
666
|
+
* Last health check status (unknown/neutral/failed/passed/condpass).
|
|
667
|
+
*/
|
|
521
668
|
lastHealthCheckStatus: BackendServerStatsHealthCheckStatus;
|
|
522
669
|
}
|
|
523
670
|
export interface Acl {
|
|
524
|
-
/**
|
|
671
|
+
/**
|
|
672
|
+
* ACL ID.
|
|
673
|
+
*/
|
|
525
674
|
id: string;
|
|
526
|
-
/**
|
|
675
|
+
/**
|
|
676
|
+
* ACL name.
|
|
677
|
+
*/
|
|
527
678
|
name: string;
|
|
528
679
|
/**
|
|
529
|
-
* ACL match filter object. One of `ip_subnet` or `http_filter` &
|
|
530
|
-
* `http_filter_value` are required.
|
|
680
|
+
* ACL match filter object. One of `ip_subnet` or `http_filter` & `http_filter_value` are required.
|
|
531
681
|
*/
|
|
532
682
|
match?: AclMatch;
|
|
533
|
-
/**
|
|
683
|
+
/**
|
|
684
|
+
* Action to take when incoming traffic matches an ACL filter.
|
|
685
|
+
*/
|
|
534
686
|
action?: AclAction;
|
|
535
|
-
/**
|
|
687
|
+
/**
|
|
688
|
+
* ACL is attached to this frontend object.
|
|
689
|
+
*/
|
|
536
690
|
frontend?: Frontend;
|
|
537
691
|
/**
|
|
538
|
-
* Priority of this ACL (ACLs are applied in ascending order, 0 is the first
|
|
539
|
-
* ACL executed).
|
|
692
|
+
* Priority of this ACL (ACLs are applied in ascending order, 0 is the first ACL executed).
|
|
540
693
|
*/
|
|
541
694
|
index: number;
|
|
542
|
-
/**
|
|
695
|
+
/**
|
|
696
|
+
* Date on which the ACL was created.
|
|
697
|
+
*/
|
|
543
698
|
createdAt?: Date;
|
|
544
|
-
/**
|
|
699
|
+
/**
|
|
700
|
+
* Date on which the ACL was last updated.
|
|
701
|
+
*/
|
|
545
702
|
updatedAt?: Date;
|
|
546
|
-
/**
|
|
703
|
+
/**
|
|
704
|
+
* ACL description.
|
|
705
|
+
*/
|
|
547
706
|
description: string;
|
|
548
707
|
}
|
|
549
708
|
export interface PrivateNetwork {
|
|
550
|
-
/**
|
|
709
|
+
/**
|
|
710
|
+
* Load Balancer object which is attached to the Private Network.
|
|
711
|
+
*/
|
|
551
712
|
lb?: Lb;
|
|
552
|
-
/**
|
|
713
|
+
/**
|
|
714
|
+
* IPAM IDs of the booked IP addresses.
|
|
715
|
+
*/
|
|
553
716
|
ipamIds: string[];
|
|
554
717
|
/**
|
|
555
|
-
* @deprecated Object containing an array of a local IP address for the Load
|
|
556
|
-
* Balancer on this Private Network.
|
|
718
|
+
* @deprecated Object containing an array of a local IP address for the Load Balancer on this Private Network.
|
|
557
719
|
*
|
|
558
|
-
*
|
|
559
|
-
* 'ipamConfig' could be set.
|
|
720
|
+
* One-of ('config'): at most one of 'staticConfig', 'dhcpConfig', 'ipamConfig' could be set.
|
|
560
721
|
*/
|
|
561
722
|
staticConfig?: PrivateNetworkStaticConfig;
|
|
562
723
|
/**
|
|
563
724
|
* @deprecated Object containing DHCP-assigned IP addresses.
|
|
564
725
|
*
|
|
565
|
-
*
|
|
566
|
-
* 'ipamConfig' could be set.
|
|
726
|
+
* One-of ('config'): at most one of 'staticConfig', 'dhcpConfig', 'ipamConfig' could be set.
|
|
567
727
|
*/
|
|
568
728
|
dhcpConfig?: PrivateNetworkDHCPConfig;
|
|
569
729
|
/**
|
|
570
730
|
* @deprecated For internal use only.
|
|
571
731
|
*
|
|
572
|
-
*
|
|
573
|
-
* 'ipamConfig' could be set.
|
|
732
|
+
* One-of ('config'): at most one of 'staticConfig', 'dhcpConfig', 'ipamConfig' could be set.
|
|
574
733
|
*/
|
|
575
734
|
ipamConfig?: PrivateNetworkIpamConfig;
|
|
576
|
-
/**
|
|
735
|
+
/**
|
|
736
|
+
* Private Network ID.
|
|
737
|
+
*/
|
|
577
738
|
privateNetworkId: string;
|
|
578
|
-
/**
|
|
739
|
+
/**
|
|
740
|
+
* Status of Private Network connection.
|
|
741
|
+
*/
|
|
579
742
|
status: PrivateNetworkStatus;
|
|
580
|
-
/**
|
|
743
|
+
/**
|
|
744
|
+
* Date on which the Private Network was created.
|
|
745
|
+
*/
|
|
581
746
|
createdAt?: Date;
|
|
582
|
-
/**
|
|
747
|
+
/**
|
|
748
|
+
* Date on which the PN was last updated.
|
|
749
|
+
*/
|
|
583
750
|
updatedAt?: Date;
|
|
584
751
|
}
|
|
585
752
|
export interface LbType {
|
|
586
|
-
/**
|
|
753
|
+
/**
|
|
754
|
+
* Load Balancer commercial offer type name.
|
|
755
|
+
*/
|
|
587
756
|
name: string;
|
|
588
|
-
/**
|
|
757
|
+
/**
|
|
758
|
+
* Current stock status for a given Load Balancer type.
|
|
759
|
+
*/
|
|
589
760
|
stockStatus: LbTypeStock;
|
|
590
|
-
/**
|
|
761
|
+
/**
|
|
762
|
+
* Load Balancer commercial offer type description.
|
|
763
|
+
*/
|
|
591
764
|
description: string;
|
|
592
|
-
/**
|
|
765
|
+
/**
|
|
766
|
+
* @deprecated The region the Load Balancer stock is in.
|
|
767
|
+
*/
|
|
593
768
|
region?: ScwRegion;
|
|
594
|
-
/**
|
|
769
|
+
/**
|
|
770
|
+
* The zone the Load Balancer stock is in.
|
|
771
|
+
*/
|
|
595
772
|
zone: ScwZone;
|
|
596
773
|
}
|
|
597
774
|
export interface Route {
|
|
598
|
-
/**
|
|
775
|
+
/**
|
|
776
|
+
* Route ID.
|
|
777
|
+
*/
|
|
599
778
|
id: string;
|
|
600
|
-
/**
|
|
779
|
+
/**
|
|
780
|
+
* ID of the source frontend.
|
|
781
|
+
*/
|
|
601
782
|
frontendId: string;
|
|
602
|
-
/**
|
|
783
|
+
/**
|
|
784
|
+
* ID of the target backend.
|
|
785
|
+
*/
|
|
603
786
|
backendId: string;
|
|
604
787
|
/**
|
|
605
|
-
* Object defining the match condition for a route to be applied. If an
|
|
606
|
-
* incoming client session matches the specified condition (i.e. it has a
|
|
607
|
-
* matching SNI value or HTTP Host header value), it will be passed to the
|
|
608
|
-
* target backend.
|
|
788
|
+
* Object defining the match condition for a route to be applied. If an incoming client session matches the specified condition (i.e. it has a matching SNI value or HTTP Host header value), it will be passed to the target backend.
|
|
609
789
|
*/
|
|
610
790
|
match?: RouteMatch;
|
|
611
|
-
/**
|
|
791
|
+
/**
|
|
792
|
+
* Date on which the route was created.
|
|
793
|
+
*/
|
|
612
794
|
createdAt?: Date;
|
|
613
|
-
/**
|
|
795
|
+
/**
|
|
796
|
+
* Date on which the route was last updated.
|
|
797
|
+
*/
|
|
614
798
|
updatedAt?: Date;
|
|
615
799
|
}
|
|
616
800
|
export interface AclSpec {
|
|
617
|
-
/**
|
|
801
|
+
/**
|
|
802
|
+
* ACL name.
|
|
803
|
+
*/
|
|
618
804
|
name: string;
|
|
619
|
-
/**
|
|
805
|
+
/**
|
|
806
|
+
* Action to take when incoming traffic matches an ACL filter.
|
|
807
|
+
*/
|
|
620
808
|
action: AclAction;
|
|
621
809
|
/**
|
|
622
|
-
* ACL match filter object. One of `ip_subnet` or `http_filter` and
|
|
623
|
-
* `http_filter_value` are required.
|
|
810
|
+
* ACL match filter object. One of `ip_subnet` or `http_filter` and `http_filter_value` are required.
|
|
624
811
|
*/
|
|
625
812
|
match?: AclMatch;
|
|
626
813
|
/**
|
|
627
|
-
* Priority of this ACL (ACLs are applied in ascending order, 0 is the first
|
|
628
|
-
* ACL executed).
|
|
814
|
+
* Priority of this ACL (ACLs are applied in ascending order, 0 is the first ACL executed).
|
|
629
815
|
*/
|
|
630
816
|
index: number;
|
|
631
|
-
/**
|
|
817
|
+
/**
|
|
818
|
+
* ACL description.
|
|
819
|
+
*/
|
|
632
820
|
description: string;
|
|
633
821
|
}
|
|
634
822
|
export type AddBackendServersRequest = {
|
|
635
823
|
/**
|
|
636
|
-
* Region to target. If none is passed will use default region from the
|
|
637
|
-
* config.
|
|
824
|
+
* Region to target. If none is passed will use default region from the config.
|
|
638
825
|
*/
|
|
639
826
|
region?: ScwRegion;
|
|
640
|
-
/**
|
|
827
|
+
/**
|
|
828
|
+
* Backend ID.
|
|
829
|
+
*/
|
|
641
830
|
backendId: string;
|
|
642
|
-
/**
|
|
831
|
+
/**
|
|
832
|
+
* List of IP addresses to add to backend servers.
|
|
833
|
+
*/
|
|
643
834
|
serverIp: string[];
|
|
644
835
|
};
|
|
645
836
|
export type AttachPrivateNetworkRequest = {
|
|
646
837
|
/**
|
|
647
|
-
* Region to target. If none is passed will use default region from the
|
|
648
|
-
* config.
|
|
838
|
+
* Region to target. If none is passed will use default region from the config.
|
|
649
839
|
*/
|
|
650
840
|
region?: ScwRegion;
|
|
651
|
-
/**
|
|
841
|
+
/**
|
|
842
|
+
* Load Balancer ID.
|
|
843
|
+
*/
|
|
652
844
|
lbId: string;
|
|
653
|
-
/**
|
|
845
|
+
/**
|
|
846
|
+
* Private Network ID.
|
|
847
|
+
*/
|
|
654
848
|
privateNetworkId: string;
|
|
655
849
|
/**
|
|
656
|
-
* @deprecated Object containing an array of a local IP address for the Load
|
|
657
|
-
* Balancer on this Private Network.
|
|
850
|
+
* @deprecated Object containing an array of a local IP address for the Load Balancer on this Private Network.
|
|
658
851
|
*
|
|
659
|
-
*
|
|
660
|
-
* 'ipamConfig' could be set.
|
|
852
|
+
* One-of ('config'): at most one of 'staticConfig', 'dhcpConfig', 'ipamConfig' could be set.
|
|
661
853
|
*/
|
|
662
854
|
staticConfig?: PrivateNetworkStaticConfig;
|
|
663
855
|
/**
|
|
664
856
|
* @deprecated Defines whether to let DHCP assign IP addresses.
|
|
665
857
|
*
|
|
666
|
-
*
|
|
667
|
-
* 'ipamConfig' could be set.
|
|
858
|
+
* One-of ('config'): at most one of 'staticConfig', 'dhcpConfig', 'ipamConfig' could be set.
|
|
668
859
|
*/
|
|
669
860
|
dhcpConfig?: PrivateNetworkDHCPConfig;
|
|
670
861
|
/**
|
|
671
862
|
* @deprecated For internal use only.
|
|
672
863
|
*
|
|
673
|
-
*
|
|
674
|
-
* 'ipamConfig' could be set.
|
|
864
|
+
* One-of ('config'): at most one of 'staticConfig', 'dhcpConfig', 'ipamConfig' could be set.
|
|
675
865
|
*/
|
|
676
866
|
ipamConfig?: PrivateNetworkIpamConfig;
|
|
677
867
|
/**
|
|
678
|
-
* IPAM ID of a pre-reserved IP address to assign to the Load Balancer on this
|
|
679
|
-
* Private Network. In the future, it will be possible to specify multiple IPs
|
|
680
|
-
* in this field (IPv4 and IPv6), for now only one ID of an IPv4 address is
|
|
681
|
-
* expected. When null, a new private IP address is created for the Load
|
|
682
|
-
* Balancer on this Private Network.
|
|
868
|
+
* IPAM ID of a pre-reserved IP address to assign to the Load Balancer on this Private Network. In the future, it will be possible to specify multiple IPs in this field (IPv4 and IPv6), for now only one ID of an IPv4 address is expected. When null, a new private IP address is created for the Load Balancer on this Private Network.
|
|
683
869
|
*/
|
|
684
870
|
ipamIds?: string[];
|
|
685
871
|
};
|
|
686
|
-
/**
|
|
872
|
+
/**
|
|
873
|
+
* Add an ACL to a Load Balancer frontend.
|
|
874
|
+
*/
|
|
687
875
|
export type CreateAclRequest = {
|
|
688
876
|
/**
|
|
689
|
-
* Region to target. If none is passed will use default region from the
|
|
690
|
-
* config.
|
|
877
|
+
* Region to target. If none is passed will use default region from the config.
|
|
691
878
|
*/
|
|
692
879
|
region?: ScwRegion;
|
|
693
|
-
/**
|
|
880
|
+
/**
|
|
881
|
+
* Frontend ID to attach the ACL to.
|
|
882
|
+
*/
|
|
694
883
|
frontendId: string;
|
|
695
|
-
/**
|
|
884
|
+
/**
|
|
885
|
+
* ACL name.
|
|
886
|
+
*/
|
|
696
887
|
name?: string;
|
|
697
|
-
/**
|
|
888
|
+
/**
|
|
889
|
+
* Action to take when incoming traffic matches an ACL filter.
|
|
890
|
+
*/
|
|
698
891
|
action: AclAction;
|
|
699
892
|
/**
|
|
700
|
-
* ACL match filter object. One of `ip_subnet` or `http_filter` &
|
|
701
|
-
* `http_filter_value` are required.
|
|
893
|
+
* ACL match filter object. One of `ip_subnet` or `http_filter` & `http_filter_value` are required.
|
|
702
894
|
*/
|
|
703
895
|
match?: AclMatch;
|
|
704
896
|
/**
|
|
705
|
-
* Priority of this ACL (ACLs are applied in ascending order, 0 is the first
|
|
706
|
-
* ACL executed).
|
|
897
|
+
* Priority of this ACL (ACLs are applied in ascending order, 0 is the first ACL executed).
|
|
707
898
|
*/
|
|
708
899
|
index: number;
|
|
709
|
-
/**
|
|
900
|
+
/**
|
|
901
|
+
* ACL description.
|
|
902
|
+
*/
|
|
710
903
|
description: string;
|
|
711
904
|
};
|
|
712
905
|
export type CreateBackendRequest = {
|
|
713
906
|
/**
|
|
714
|
-
* Region to target. If none is passed will use default region from the
|
|
715
|
-
* config.
|
|
907
|
+
* Region to target. If none is passed will use default region from the config.
|
|
716
908
|
*/
|
|
717
909
|
region?: ScwRegion;
|
|
718
|
-
/**
|
|
910
|
+
/**
|
|
911
|
+
* Load Balancer ID.
|
|
912
|
+
*/
|
|
719
913
|
lbId: string;
|
|
720
|
-
/**
|
|
914
|
+
/**
|
|
915
|
+
* Name for the backend.
|
|
916
|
+
*/
|
|
721
917
|
name?: string;
|
|
722
918
|
/**
|
|
723
|
-
* Protocol to be used by the backend when forwarding traffic to backend
|
|
724
|
-
* servers.
|
|
919
|
+
* Protocol to be used by the backend when forwarding traffic to backend servers.
|
|
725
920
|
*/
|
|
726
921
|
forwardProtocol: Protocol;
|
|
727
|
-
/**
|
|
922
|
+
/**
|
|
923
|
+
* Port to be used by the backend when forwarding traffic to backend servers.
|
|
924
|
+
*/
|
|
728
925
|
forwardPort: number;
|
|
729
926
|
/**
|
|
730
|
-
* Load balancing algorithm to be used when determining which backend server
|
|
731
|
-
* to forward new traffic to.
|
|
927
|
+
* Load balancing algorithm to be used when determining which backend server to forward new traffic to.
|
|
732
928
|
*/
|
|
733
929
|
forwardPortAlgorithm: ForwardPortAlgorithm;
|
|
734
930
|
/**
|
|
735
|
-
* Defines whether to activate sticky sessions (binding a particular session
|
|
736
|
-
* to a particular backend server) and the method to use if so. None disables
|
|
737
|
-
* sticky sessions. Cookie-based uses an HTTP cookie TO stick a session to a
|
|
738
|
-
* backend server. Table-based uses the source (client) IP address to stick a
|
|
739
|
-
* session to a backend server.
|
|
931
|
+
* Defines whether to activate sticky sessions (binding a particular session to a particular backend server) and the method to use if so. None disables sticky sessions. Cookie-based uses an HTTP cookie TO stick a session to a backend server. Table-based uses the source (client) IP address to stick a session to a backend server.
|
|
740
932
|
*/
|
|
741
933
|
stickySessions: StickySessionsType;
|
|
742
|
-
/**
|
|
934
|
+
/**
|
|
935
|
+
* Cookie name for cookie-based sticky sessions.
|
|
936
|
+
*/
|
|
743
937
|
stickySessionsCookieName: string;
|
|
744
938
|
/**
|
|
745
|
-
* Object defining the health check to be carried out by the backend when
|
|
746
|
-
* checking the status and health of backend servers.
|
|
939
|
+
* Object defining the health check to be carried out by the backend when checking the status and health of backend servers.
|
|
747
940
|
*/
|
|
748
941
|
healthCheck: HealthCheck;
|
|
749
942
|
/**
|
|
750
|
-
* List of backend server IP addresses (IPv4 or IPv6) the backend should
|
|
751
|
-
* forward traffic to.
|
|
943
|
+
* List of backend server IP addresses (IPv4 or IPv6) the backend should forward traffic to.
|
|
752
944
|
*/
|
|
753
945
|
serverIp: string[];
|
|
754
|
-
/**
|
|
946
|
+
/**
|
|
947
|
+
* @deprecated Deprecated in favor of proxy_protocol field.
|
|
948
|
+
*/
|
|
755
949
|
sendProxyV2?: boolean;
|
|
756
|
-
/**
|
|
950
|
+
/**
|
|
951
|
+
* Maximum allowed time for a backend server to process a request.
|
|
952
|
+
*/
|
|
757
953
|
timeoutServer?: string;
|
|
758
|
-
/**
|
|
954
|
+
/**
|
|
955
|
+
* Maximum allowed time for establishing a connection to a backend server.
|
|
956
|
+
*/
|
|
759
957
|
timeoutConnect?: string;
|
|
760
958
|
/**
|
|
761
|
-
* Maximum allowed tunnel inactivity time after Websocket is established
|
|
762
|
-
* (takes precedence over client and server timeout).
|
|
959
|
+
* Maximum allowed tunnel inactivity time after Websocket is established (takes precedence over client and server timeout).
|
|
763
960
|
*/
|
|
764
961
|
timeoutTunnel?: string;
|
|
765
|
-
/**
|
|
962
|
+
/**
|
|
963
|
+
* Action to take when a backend server is marked as down.
|
|
964
|
+
*/
|
|
766
965
|
onMarkedDownAction?: OnMarkedDownAction;
|
|
767
966
|
/**
|
|
768
|
-
* Protocol to use between the Load Balancer and backend servers. Allows the
|
|
769
|
-
* backend servers to be informed of the client's real IP address. The PROXY
|
|
770
|
-
* protocol must be supported by the backend servers' software.
|
|
967
|
+
* Protocol to use between the Load Balancer and backend servers. Allows the backend servers to be informed of the client's real IP address. The PROXY protocol must be supported by the backend servers' software.
|
|
771
968
|
*/
|
|
772
969
|
proxyProtocol?: ProxyProtocol;
|
|
773
970
|
/**
|
|
774
|
-
* Scaleway Object Storage bucket website to be served as failover if all
|
|
775
|
-
* backend servers are down, e.g.
|
|
776
|
-
* failover-website.s3-website.fr-par.scw.cloud.
|
|
971
|
+
* Scaleway Object Storage bucket website to be served as failover if all backend servers are down, e.g. failover-website.s3-website.fr-par.scw.cloud.
|
|
777
972
|
*/
|
|
778
973
|
failoverHost?: string;
|
|
779
974
|
/**
|
|
780
|
-
* Defines whether to enable SSL bridging between the Load Balancer and
|
|
781
|
-
* backend servers.
|
|
975
|
+
* Defines whether to enable SSL bridging between the Load Balancer and backend servers.
|
|
782
976
|
*/
|
|
783
977
|
sslBridging?: boolean;
|
|
784
|
-
/**
|
|
978
|
+
/**
|
|
979
|
+
* Defines whether the server certificate verification should be ignored.
|
|
980
|
+
*/
|
|
785
981
|
ignoreSslServerVerify?: boolean;
|
|
786
|
-
/**
|
|
982
|
+
/**
|
|
983
|
+
* Whether to use another backend server on each attempt.
|
|
984
|
+
*/
|
|
787
985
|
redispatchAttemptCount?: number;
|
|
788
|
-
/**
|
|
986
|
+
/**
|
|
987
|
+
* Number of retries when a backend server connection failed.
|
|
988
|
+
*/
|
|
789
989
|
maxRetries?: number;
|
|
790
|
-
/**
|
|
990
|
+
/**
|
|
991
|
+
* Maximum number of connections allowed per backend server.
|
|
992
|
+
*/
|
|
791
993
|
maxConnections?: number;
|
|
792
994
|
/**
|
|
793
|
-
* Maximum time for a request to be left pending in queue when
|
|
794
|
-
* `max_connections` is reached.
|
|
995
|
+
* Maximum time for a request to be left pending in queue when `max_connections` is reached.
|
|
795
996
|
*/
|
|
796
997
|
timeoutQueue?: string;
|
|
797
998
|
};
|
|
798
999
|
export type CreateCertificateRequest = {
|
|
799
1000
|
/**
|
|
800
|
-
* Region to target. If none is passed will use default region from the
|
|
801
|
-
* config.
|
|
1001
|
+
* Region to target. If none is passed will use default region from the config.
|
|
802
1002
|
*/
|
|
803
1003
|
region?: ScwRegion;
|
|
804
|
-
/**
|
|
1004
|
+
/**
|
|
1005
|
+
* Load Balancer ID.
|
|
1006
|
+
*/
|
|
805
1007
|
lbId: string;
|
|
806
|
-
/**
|
|
1008
|
+
/**
|
|
1009
|
+
* Name for the certificate.
|
|
1010
|
+
*/
|
|
807
1011
|
name?: string;
|
|
808
1012
|
/**
|
|
809
1013
|
* Object to define a new Let's Encrypt certificate to be generated.
|
|
810
1014
|
*
|
|
811
|
-
* One-of ('type'): at most one of 'letsencrypt', 'customCertificate' could be
|
|
812
|
-
* set.
|
|
1015
|
+
* One-of ('type'): at most one of 'letsencrypt', 'customCertificate' could be set.
|
|
813
1016
|
*/
|
|
814
1017
|
letsencrypt?: CreateCertificateRequestLetsencryptConfig;
|
|
815
1018
|
/**
|
|
816
1019
|
* Object to define an existing custom certificate to be imported.
|
|
817
1020
|
*
|
|
818
|
-
* One-of ('type'): at most one of 'letsencrypt', 'customCertificate' could be
|
|
819
|
-
* set.
|
|
1021
|
+
* One-of ('type'): at most one of 'letsencrypt', 'customCertificate' could be set.
|
|
820
1022
|
*/
|
|
821
1023
|
customCertificate?: CreateCertificateRequestCustomCertificate;
|
|
822
1024
|
};
|
|
823
1025
|
export type CreateFrontendRequest = {
|
|
824
1026
|
/**
|
|
825
|
-
* Region to target. If none is passed will use default region from the
|
|
826
|
-
* config.
|
|
1027
|
+
* Region to target. If none is passed will use default region from the config.
|
|
827
1028
|
*/
|
|
828
1029
|
region?: ScwRegion;
|
|
829
|
-
/**
|
|
1030
|
+
/**
|
|
1031
|
+
* Load Balancer ID (ID of the Load Balancer to attach the frontend to).
|
|
1032
|
+
*/
|
|
830
1033
|
lbId: string;
|
|
831
|
-
/**
|
|
1034
|
+
/**
|
|
1035
|
+
* Name for the frontend.
|
|
1036
|
+
*/
|
|
832
1037
|
name?: string;
|
|
833
|
-
/**
|
|
1038
|
+
/**
|
|
1039
|
+
* Port the frontend should listen on.
|
|
1040
|
+
*/
|
|
834
1041
|
inboundPort: number;
|
|
835
|
-
/**
|
|
1042
|
+
/**
|
|
1043
|
+
* Backend ID (ID of the backend the frontend should pass traffic to).
|
|
1044
|
+
*/
|
|
836
1045
|
backendId: string;
|
|
837
|
-
/**
|
|
1046
|
+
/**
|
|
1047
|
+
* Maximum allowed inactivity time on the client side.
|
|
1048
|
+
*/
|
|
838
1049
|
timeoutClient?: string;
|
|
839
|
-
/**
|
|
1050
|
+
/**
|
|
1051
|
+
* @deprecated Certificate ID, deprecated in favor of certificate_ids array.
|
|
1052
|
+
*/
|
|
840
1053
|
certificateId?: string;
|
|
841
|
-
/**
|
|
1054
|
+
/**
|
|
1055
|
+
* List of SSL/TLS certificate IDs to bind to the frontend.
|
|
1056
|
+
*/
|
|
842
1057
|
certificateIds?: string[];
|
|
843
|
-
/**
|
|
1058
|
+
/**
|
|
1059
|
+
* Defines whether to enable HTTP/3 protocol on the frontend.
|
|
1060
|
+
*/
|
|
844
1061
|
enableHttp3: boolean;
|
|
845
1062
|
/**
|
|
846
|
-
* Rate limit for new connections established on this frontend. Use 0 value to
|
|
847
|
-
* disable, else value is connections per second.
|
|
1063
|
+
* Rate limit for new connections established on this frontend. Use 0 value to disable, else value is connections per second.
|
|
848
1064
|
*/
|
|
849
1065
|
connectionRateLimit?: number;
|
|
850
1066
|
};
|
|
851
1067
|
export type CreateIpRequest = {
|
|
852
1068
|
/**
|
|
853
|
-
* Region to target. If none is passed will use default region from the
|
|
854
|
-
* config.
|
|
1069
|
+
* Region to target. If none is passed will use default region from the config.
|
|
855
1070
|
*/
|
|
856
1071
|
region?: ScwRegion;
|
|
857
1072
|
/**
|
|
858
|
-
* @deprecated Organization ID of the Organization where the IP address should
|
|
859
|
-
* be created.
|
|
1073
|
+
* @deprecated Organization ID of the Organization where the IP address should be created.
|
|
860
1074
|
*
|
|
861
|
-
*
|
|
862
|
-
* could be set.
|
|
1075
|
+
* One-of ('projectIdentifier'): at most one of 'projectId', 'organizationId' could be set.
|
|
863
1076
|
*/
|
|
864
1077
|
organizationId?: string;
|
|
865
1078
|
/**
|
|
866
1079
|
* Project ID of the Project where the IP address should be created.
|
|
867
1080
|
*
|
|
868
|
-
* One-of ('projectIdentifier'): at most one of 'projectId', 'organizationId'
|
|
869
|
-
* could be set.
|
|
1081
|
+
* One-of ('projectIdentifier'): at most one of 'projectId', 'organizationId' could be set.
|
|
870
1082
|
*/
|
|
871
1083
|
projectId?: string;
|
|
872
|
-
/**
|
|
1084
|
+
/**
|
|
1085
|
+
* Reverse DNS (domain name) for the IP address.
|
|
1086
|
+
*/
|
|
873
1087
|
reverse?: string;
|
|
874
|
-
/**
|
|
1088
|
+
/**
|
|
1089
|
+
* If true, creates a Flexible IP with an ipv6 address.
|
|
1090
|
+
*/
|
|
875
1091
|
isIpv6: boolean;
|
|
876
|
-
/**
|
|
1092
|
+
/**
|
|
1093
|
+
* List of tags for the IP.
|
|
1094
|
+
*/
|
|
877
1095
|
tags?: string[];
|
|
878
1096
|
};
|
|
879
1097
|
export type CreateLbRequest = {
|
|
880
1098
|
/**
|
|
881
|
-
* Region to target. If none is passed will use default region from the
|
|
882
|
-
* config.
|
|
1099
|
+
* Region to target. If none is passed will use default region from the config.
|
|
883
1100
|
*/
|
|
884
1101
|
region?: ScwRegion;
|
|
885
1102
|
/**
|
|
886
1103
|
* @deprecated Scaleway Organization to create the Load Balancer in.
|
|
887
1104
|
*
|
|
888
|
-
*
|
|
889
|
-
* could be set.
|
|
1105
|
+
* One-of ('projectIdentifier'): at most one of 'projectId', 'organizationId' could be set.
|
|
890
1106
|
*/
|
|
891
1107
|
organizationId?: string;
|
|
892
1108
|
/**
|
|
893
1109
|
* Scaleway Project to create the Load Balancer in.
|
|
894
1110
|
*
|
|
895
|
-
* One-of ('projectIdentifier'): at most one of 'projectId', 'organizationId'
|
|
896
|
-
* could be set.
|
|
1111
|
+
* One-of ('projectIdentifier'): at most one of 'projectId', 'organizationId' could be set.
|
|
897
1112
|
*/
|
|
898
1113
|
projectId?: string;
|
|
899
|
-
/**
|
|
1114
|
+
/**
|
|
1115
|
+
* Name for the Load Balancer.
|
|
1116
|
+
*/
|
|
900
1117
|
name?: string;
|
|
901
|
-
/**
|
|
1118
|
+
/**
|
|
1119
|
+
* Description for the Load Balancer.
|
|
1120
|
+
*/
|
|
902
1121
|
description: string;
|
|
903
1122
|
/**
|
|
904
|
-
* @deprecated ID of an existing flexible IP address to attach to the Load
|
|
905
|
-
* Balancer.
|
|
1123
|
+
* @deprecated ID of an existing flexible IP address to attach to the Load Balancer.
|
|
906
1124
|
*/
|
|
907
1125
|
ipId?: string;
|
|
908
1126
|
/**
|
|
909
|
-
* Defines whether to automatically assign a flexible public IP to the Load
|
|
910
|
-
* Balancer. Default value is `true` (assign).
|
|
1127
|
+
* Defines whether to automatically assign a flexible public IP to the Load Balancer. Default value is `true` (assign).
|
|
911
1128
|
*/
|
|
912
1129
|
assignFlexibleIp?: boolean;
|
|
913
1130
|
/**
|
|
914
|
-
* Defines whether to automatically assign a flexible public IPv6 to the Load
|
|
915
|
-
* Balancer. Default value is `false` (do not assign).
|
|
1131
|
+
* Defines whether to automatically assign a flexible public IPv6 to the Load Balancer. Default value is `false` (do not assign).
|
|
916
1132
|
*/
|
|
917
1133
|
assignFlexibleIpv6?: boolean;
|
|
918
|
-
/**
|
|
1134
|
+
/**
|
|
1135
|
+
* List of IP IDs to attach to the Load Balancer.
|
|
1136
|
+
*/
|
|
919
1137
|
ipIds?: string[];
|
|
920
|
-
/**
|
|
1138
|
+
/**
|
|
1139
|
+
* List of tags for the Load Balancer.
|
|
1140
|
+
*/
|
|
921
1141
|
tags?: string[];
|
|
922
1142
|
/**
|
|
923
|
-
* Load Balancer commercial offer type. Use the Load Balancer types endpoint
|
|
924
|
-
* to retrieve a list of available offer types.
|
|
1143
|
+
* Load Balancer commercial offer type. Use the Load Balancer types endpoint to retrieve a list of available offer types.
|
|
925
1144
|
*/
|
|
926
1145
|
type: string;
|
|
927
1146
|
/**
|
|
928
|
-
* Determines the minimal SSL version which needs to be supported on the
|
|
929
|
-
* client side, in an SSL/TLS offloading context. Intermediate is suitable for
|
|
930
|
-
* general-purpose servers with a variety of clients, recommended for almost
|
|
931
|
-
* all systems. Modern is suitable for services with clients that support TLS
|
|
932
|
-
* 1.3 and do not need backward compatibility. Old is compatible with a small
|
|
933
|
-
* number of very old clients and should be used only as a last resort.
|
|
1147
|
+
* Determines the minimal SSL version which needs to be supported on the client side, in an SSL/TLS offloading context. Intermediate is suitable for general-purpose servers with a variety of clients, recommended for almost all systems. Modern is suitable for services with clients that support TLS 1.3 and do not need backward compatibility. Old is compatible with a small number of very old clients and should be used only as a last resort.
|
|
934
1148
|
*/
|
|
935
1149
|
sslCompatibilityLevel?: SSLCompatibilityLevel;
|
|
936
1150
|
};
|
|
937
1151
|
export type CreateRouteRequest = {
|
|
938
1152
|
/**
|
|
939
|
-
* Region to target. If none is passed will use default region from the
|
|
940
|
-
* config.
|
|
1153
|
+
* Region to target. If none is passed will use default region from the config.
|
|
941
1154
|
*/
|
|
942
1155
|
region?: ScwRegion;
|
|
943
|
-
/**
|
|
1156
|
+
/**
|
|
1157
|
+
* ID of the source frontend to create the route on.
|
|
1158
|
+
*/
|
|
944
1159
|
frontendId: string;
|
|
945
|
-
/**
|
|
1160
|
+
/**
|
|
1161
|
+
* ID of the target backend for the route.
|
|
1162
|
+
*/
|
|
946
1163
|
backendId: string;
|
|
947
1164
|
/**
|
|
948
|
-
* Object defining the match condition for a route to be applied. If an
|
|
949
|
-
* incoming client session matches the specified condition (i.e. it has a
|
|
950
|
-
* matching SNI value or HTTP Host header value), it will be passed to the
|
|
951
|
-
* target backend.
|
|
1165
|
+
* Object defining the match condition for a route to be applied. If an incoming client session matches the specified condition (i.e. it has a matching SNI value or HTTP Host header value), it will be passed to the target backend.
|
|
952
1166
|
*/
|
|
953
1167
|
match?: RouteMatch;
|
|
954
1168
|
};
|
|
955
|
-
/**
|
|
1169
|
+
/**
|
|
1170
|
+
* Create a new alert subscriber (webhook or email).
|
|
1171
|
+
*/
|
|
956
1172
|
export type CreateSubscriberRequest = {
|
|
957
1173
|
/**
|
|
958
|
-
* Region to target. If none is passed will use default region from the
|
|
959
|
-
* config.
|
|
1174
|
+
* Region to target. If none is passed will use default region from the config.
|
|
960
1175
|
*/
|
|
961
1176
|
region?: ScwRegion;
|
|
962
|
-
/**
|
|
1177
|
+
/**
|
|
1178
|
+
* Subscriber name.
|
|
1179
|
+
*/
|
|
963
1180
|
name: string;
|
|
964
1181
|
/**
|
|
965
1182
|
* Email address configuration.
|
|
966
1183
|
*
|
|
967
|
-
* One-of ('config'): at most one of 'emailConfig', 'webhookConfig' could be
|
|
968
|
-
* set.
|
|
1184
|
+
* One-of ('config'): at most one of 'emailConfig', 'webhookConfig' could be set.
|
|
969
1185
|
*/
|
|
970
1186
|
emailConfig?: SubscriberEmailConfig;
|
|
971
1187
|
/**
|
|
972
1188
|
* WebHook URI configuration.
|
|
973
1189
|
*
|
|
974
|
-
* One-of ('config'): at most one of 'emailConfig', 'webhookConfig' could be
|
|
975
|
-
* set.
|
|
1190
|
+
* One-of ('config'): at most one of 'emailConfig', 'webhookConfig' could be set.
|
|
976
1191
|
*/
|
|
977
1192
|
webhookConfig?: SubscriberWebhookConfig;
|
|
978
1193
|
/**
|
|
979
1194
|
* @deprecated Organization ID to create the subscriber in.
|
|
980
1195
|
*
|
|
981
|
-
*
|
|
982
|
-
* could be set.
|
|
1196
|
+
* One-of ('projectIdentifier'): at most one of 'projectId', 'organizationId' could be set.
|
|
983
1197
|
*/
|
|
984
1198
|
organizationId?: string;
|
|
985
1199
|
/**
|
|
986
1200
|
* Project ID to create the subscriber in.
|
|
987
1201
|
*
|
|
988
|
-
* One-of ('projectIdentifier'): at most one of 'projectId', 'organizationId'
|
|
989
|
-
* could be set.
|
|
1202
|
+
* One-of ('projectIdentifier'): at most one of 'projectId', 'organizationId' could be set.
|
|
990
1203
|
*/
|
|
991
1204
|
projectId?: string;
|
|
992
1205
|
};
|
|
993
1206
|
export type DeleteAclRequest = {
|
|
994
1207
|
/**
|
|
995
|
-
* Region to target. If none is passed will use default region from the
|
|
996
|
-
* config.
|
|
1208
|
+
* Region to target. If none is passed will use default region from the config.
|
|
997
1209
|
*/
|
|
998
1210
|
region?: ScwRegion;
|
|
999
|
-
/**
|
|
1211
|
+
/**
|
|
1212
|
+
* ACL ID.
|
|
1213
|
+
*/
|
|
1000
1214
|
aclId: string;
|
|
1001
1215
|
};
|
|
1002
1216
|
export type DeleteBackendRequest = {
|
|
1003
1217
|
/**
|
|
1004
|
-
* Region to target. If none is passed will use default region from the
|
|
1005
|
-
* config.
|
|
1218
|
+
* Region to target. If none is passed will use default region from the config.
|
|
1006
1219
|
*/
|
|
1007
1220
|
region?: ScwRegion;
|
|
1008
|
-
/**
|
|
1221
|
+
/**
|
|
1222
|
+
* ID of the backend to delete.
|
|
1223
|
+
*/
|
|
1009
1224
|
backendId: string;
|
|
1010
1225
|
};
|
|
1011
1226
|
export type DeleteCertificateRequest = {
|
|
1012
1227
|
/**
|
|
1013
|
-
* Region to target. If none is passed will use default region from the
|
|
1014
|
-
* config.
|
|
1228
|
+
* Region to target. If none is passed will use default region from the config.
|
|
1015
1229
|
*/
|
|
1016
1230
|
region?: ScwRegion;
|
|
1017
|
-
/**
|
|
1231
|
+
/**
|
|
1232
|
+
* Certificate ID.
|
|
1233
|
+
*/
|
|
1018
1234
|
certificateId: string;
|
|
1019
1235
|
};
|
|
1020
1236
|
export type DeleteFrontendRequest = {
|
|
1021
1237
|
/**
|
|
1022
|
-
* Region to target. If none is passed will use default region from the
|
|
1023
|
-
* config.
|
|
1238
|
+
* Region to target. If none is passed will use default region from the config.
|
|
1024
1239
|
*/
|
|
1025
1240
|
region?: ScwRegion;
|
|
1026
|
-
/**
|
|
1241
|
+
/**
|
|
1242
|
+
* ID of the frontend to delete.
|
|
1243
|
+
*/
|
|
1027
1244
|
frontendId: string;
|
|
1028
1245
|
};
|
|
1029
1246
|
export type DeleteLbRequest = {
|
|
1030
1247
|
/**
|
|
1031
|
-
* Region to target. If none is passed will use default region from the
|
|
1032
|
-
* config.
|
|
1248
|
+
* Region to target. If none is passed will use default region from the config.
|
|
1033
1249
|
*/
|
|
1034
1250
|
region?: ScwRegion;
|
|
1035
|
-
/**
|
|
1251
|
+
/**
|
|
1252
|
+
* ID of the Load Balancer to delete.
|
|
1253
|
+
*/
|
|
1036
1254
|
lbId: string;
|
|
1037
1255
|
/**
|
|
1038
|
-
* Defines whether the Load Balancer's flexible IP should be deleted. Set to
|
|
1039
|
-
* true to release the flexible IP, or false to keep it available in your
|
|
1040
|
-
* account for future Load Balancers.
|
|
1256
|
+
* Defines whether the Load Balancer's flexible IP should be deleted. Set to true to release the flexible IP, or false to keep it available in your account for future Load Balancers.
|
|
1041
1257
|
*/
|
|
1042
1258
|
releaseIp: boolean;
|
|
1043
1259
|
};
|
|
1044
1260
|
export type DeleteRouteRequest = {
|
|
1045
1261
|
/**
|
|
1046
|
-
* Region to target. If none is passed will use default region from the
|
|
1047
|
-
* config.
|
|
1262
|
+
* Region to target. If none is passed will use default region from the config.
|
|
1048
1263
|
*/
|
|
1049
1264
|
region?: ScwRegion;
|
|
1050
|
-
/**
|
|
1265
|
+
/**
|
|
1266
|
+
* Route ID.
|
|
1267
|
+
*/
|
|
1051
1268
|
routeId: string;
|
|
1052
1269
|
};
|
|
1053
1270
|
export type DeleteSubscriberRequest = {
|
|
1054
1271
|
/**
|
|
1055
|
-
* Region to target. If none is passed will use default region from the
|
|
1056
|
-
* config.
|
|
1272
|
+
* Region to target. If none is passed will use default region from the config.
|
|
1057
1273
|
*/
|
|
1058
1274
|
region?: ScwRegion;
|
|
1059
|
-
/**
|
|
1275
|
+
/**
|
|
1276
|
+
* Subscriber ID.
|
|
1277
|
+
*/
|
|
1060
1278
|
subscriberId: string;
|
|
1061
1279
|
};
|
|
1062
1280
|
export type DetachPrivateNetworkRequest = {
|
|
1063
1281
|
/**
|
|
1064
|
-
* Region to target. If none is passed will use default region from the
|
|
1065
|
-
* config.
|
|
1282
|
+
* Region to target. If none is passed will use default region from the config.
|
|
1066
1283
|
*/
|
|
1067
1284
|
region?: ScwRegion;
|
|
1068
|
-
/**
|
|
1285
|
+
/**
|
|
1286
|
+
* Load balancer ID.
|
|
1287
|
+
*/
|
|
1069
1288
|
lbId: string;
|
|
1070
|
-
/**
|
|
1289
|
+
/**
|
|
1290
|
+
* Set your instance private network id.
|
|
1291
|
+
*/
|
|
1071
1292
|
privateNetworkId: string;
|
|
1072
1293
|
};
|
|
1073
1294
|
export type GetAclRequest = {
|
|
1074
1295
|
/**
|
|
1075
|
-
* Region to target. If none is passed will use default region from the
|
|
1076
|
-
* config.
|
|
1296
|
+
* Region to target. If none is passed will use default region from the config.
|
|
1077
1297
|
*/
|
|
1078
1298
|
region?: ScwRegion;
|
|
1079
|
-
/**
|
|
1299
|
+
/**
|
|
1300
|
+
* ACL ID.
|
|
1301
|
+
*/
|
|
1080
1302
|
aclId: string;
|
|
1081
1303
|
};
|
|
1082
1304
|
export type GetBackendRequest = {
|
|
1083
1305
|
/**
|
|
1084
|
-
* Region to target. If none is passed will use default region from the
|
|
1085
|
-
* config.
|
|
1306
|
+
* Region to target. If none is passed will use default region from the config.
|
|
1086
1307
|
*/
|
|
1087
1308
|
region?: ScwRegion;
|
|
1088
|
-
/**
|
|
1309
|
+
/**
|
|
1310
|
+
* Backend ID.
|
|
1311
|
+
*/
|
|
1089
1312
|
backendId: string;
|
|
1090
1313
|
};
|
|
1091
1314
|
export type GetCertificateRequest = {
|
|
1092
1315
|
/**
|
|
1093
|
-
* Region to target. If none is passed will use default region from the
|
|
1094
|
-
* config.
|
|
1316
|
+
* Region to target. If none is passed will use default region from the config.
|
|
1095
1317
|
*/
|
|
1096
1318
|
region?: ScwRegion;
|
|
1097
|
-
/**
|
|
1319
|
+
/**
|
|
1320
|
+
* Certificate ID.
|
|
1321
|
+
*/
|
|
1098
1322
|
certificateId: string;
|
|
1099
1323
|
};
|
|
1100
1324
|
export type GetFrontendRequest = {
|
|
1101
1325
|
/**
|
|
1102
|
-
* Region to target. If none is passed will use default region from the
|
|
1103
|
-
* config.
|
|
1326
|
+
* Region to target. If none is passed will use default region from the config.
|
|
1104
1327
|
*/
|
|
1105
1328
|
region?: ScwRegion;
|
|
1106
|
-
/**
|
|
1329
|
+
/**
|
|
1330
|
+
* Frontend ID.
|
|
1331
|
+
*/
|
|
1107
1332
|
frontendId: string;
|
|
1108
1333
|
};
|
|
1109
1334
|
export type GetIpRequest = {
|
|
1110
1335
|
/**
|
|
1111
|
-
* Region to target. If none is passed will use default region from the
|
|
1112
|
-
* config.
|
|
1336
|
+
* Region to target. If none is passed will use default region from the config.
|
|
1113
1337
|
*/
|
|
1114
1338
|
region?: ScwRegion;
|
|
1115
|
-
/**
|
|
1339
|
+
/**
|
|
1340
|
+
* IP address ID.
|
|
1341
|
+
*/
|
|
1116
1342
|
ipId: string;
|
|
1117
1343
|
};
|
|
1118
1344
|
export type GetLbRequest = {
|
|
1119
1345
|
/**
|
|
1120
|
-
* Region to target. If none is passed will use default region from the
|
|
1121
|
-
* config.
|
|
1346
|
+
* Region to target. If none is passed will use default region from the config.
|
|
1122
1347
|
*/
|
|
1123
1348
|
region?: ScwRegion;
|
|
1124
|
-
/**
|
|
1349
|
+
/**
|
|
1350
|
+
* Load Balancer ID.
|
|
1351
|
+
*/
|
|
1125
1352
|
lbId: string;
|
|
1126
1353
|
};
|
|
1127
|
-
/**
|
|
1354
|
+
/**
|
|
1355
|
+
* Get Load Balancer stats.
|
|
1356
|
+
*/
|
|
1128
1357
|
export type GetLbStatsRequest = {
|
|
1129
1358
|
/**
|
|
1130
|
-
* Region to target. If none is passed will use default region from the
|
|
1131
|
-
* config.
|
|
1359
|
+
* Region to target. If none is passed will use default region from the config.
|
|
1132
1360
|
*/
|
|
1133
1361
|
region?: ScwRegion;
|
|
1134
|
-
/**
|
|
1362
|
+
/**
|
|
1363
|
+
* Load Balancer ID.
|
|
1364
|
+
*/
|
|
1135
1365
|
lbId: string;
|
|
1136
|
-
/**
|
|
1366
|
+
/**
|
|
1367
|
+
* ID of the backend.
|
|
1368
|
+
*/
|
|
1137
1369
|
backendId?: string;
|
|
1138
1370
|
};
|
|
1139
1371
|
export type GetRouteRequest = {
|
|
1140
1372
|
/**
|
|
1141
|
-
* Region to target. If none is passed will use default region from the
|
|
1142
|
-
* config.
|
|
1373
|
+
* Region to target. If none is passed will use default region from the config.
|
|
1143
1374
|
*/
|
|
1144
1375
|
region?: ScwRegion;
|
|
1145
|
-
/**
|
|
1376
|
+
/**
|
|
1377
|
+
* Route ID.
|
|
1378
|
+
*/
|
|
1146
1379
|
routeId: string;
|
|
1147
1380
|
};
|
|
1148
1381
|
export type GetSubscriberRequest = {
|
|
1149
1382
|
/**
|
|
1150
|
-
* Region to target. If none is passed will use default region from the
|
|
1151
|
-
* config.
|
|
1383
|
+
* Region to target. If none is passed will use default region from the config.
|
|
1152
1384
|
*/
|
|
1153
1385
|
region?: ScwRegion;
|
|
1154
|
-
/**
|
|
1386
|
+
/**
|
|
1387
|
+
* Subscriber ID.
|
|
1388
|
+
*/
|
|
1155
1389
|
subscriberId: string;
|
|
1156
1390
|
};
|
|
1157
1391
|
export interface LbStats {
|
|
1158
|
-
/**
|
|
1392
|
+
/**
|
|
1393
|
+
* List of objects containing Load Balancer statistics.
|
|
1394
|
+
*/
|
|
1159
1395
|
backendServersStats: BackendServerStats[];
|
|
1160
1396
|
}
|
|
1161
1397
|
export interface ListAclResponse {
|
|
1162
|
-
/**
|
|
1398
|
+
/**
|
|
1399
|
+
* List of ACL objects.
|
|
1400
|
+
*/
|
|
1163
1401
|
acls: Acl[];
|
|
1164
|
-
/**
|
|
1402
|
+
/**
|
|
1403
|
+
* The total number of objects.
|
|
1404
|
+
*/
|
|
1165
1405
|
totalCount: number;
|
|
1166
1406
|
}
|
|
1167
1407
|
export type ListAclsRequest = {
|
|
1168
1408
|
/**
|
|
1169
|
-
* Region to target. If none is passed will use default region from the
|
|
1170
|
-
* config.
|
|
1409
|
+
* Region to target. If none is passed will use default region from the config.
|
|
1171
1410
|
*/
|
|
1172
1411
|
region?: ScwRegion;
|
|
1173
1412
|
/**
|
|
1174
|
-
* Frontend ID (ACLs attached to this frontend will be returned in the
|
|
1175
|
-
* response).
|
|
1413
|
+
* Frontend ID (ACLs attached to this frontend will be returned in the response).
|
|
1176
1414
|
*/
|
|
1177
1415
|
frontendId: string;
|
|
1178
|
-
/**
|
|
1416
|
+
/**
|
|
1417
|
+
* Sort order of ACLs in the response.
|
|
1418
|
+
*/
|
|
1179
1419
|
orderBy?: ListAclRequestOrderBy;
|
|
1180
|
-
/**
|
|
1420
|
+
/**
|
|
1421
|
+
* The page number to return, from the paginated results.
|
|
1422
|
+
*/
|
|
1181
1423
|
page?: number;
|
|
1182
|
-
/**
|
|
1424
|
+
/**
|
|
1425
|
+
* The number of ACLs to return.
|
|
1426
|
+
*/
|
|
1183
1427
|
pageSize?: number;
|
|
1184
|
-
/**
|
|
1428
|
+
/**
|
|
1429
|
+
* ACL name to filter for.
|
|
1430
|
+
*/
|
|
1185
1431
|
name?: string;
|
|
1186
1432
|
};
|
|
1187
1433
|
export type ListBackendStatsRequest = {
|
|
1188
1434
|
/**
|
|
1189
|
-
* Region to target. If none is passed will use default region from the
|
|
1190
|
-
* config.
|
|
1435
|
+
* Region to target. If none is passed will use default region from the config.
|
|
1191
1436
|
*/
|
|
1192
1437
|
region?: ScwRegion;
|
|
1193
|
-
/**
|
|
1438
|
+
/**
|
|
1439
|
+
* Load Balancer ID.
|
|
1440
|
+
*/
|
|
1194
1441
|
lbId: string;
|
|
1195
|
-
/**
|
|
1442
|
+
/**
|
|
1443
|
+
* The page number to return, from the paginated results.
|
|
1444
|
+
*/
|
|
1196
1445
|
page?: number;
|
|
1197
|
-
/**
|
|
1446
|
+
/**
|
|
1447
|
+
* Number of items to return.
|
|
1448
|
+
*/
|
|
1198
1449
|
pageSize?: number;
|
|
1199
|
-
/**
|
|
1450
|
+
/**
|
|
1451
|
+
* ID of the backend.
|
|
1452
|
+
*/
|
|
1200
1453
|
backendId?: string;
|
|
1201
1454
|
};
|
|
1202
1455
|
export interface ListBackendStatsResponse {
|
|
1203
|
-
/**
|
|
1456
|
+
/**
|
|
1457
|
+
* List of objects containing backend server statistics.
|
|
1458
|
+
*/
|
|
1204
1459
|
backendServersStats: BackendServerStats[];
|
|
1205
|
-
/**
|
|
1460
|
+
/**
|
|
1461
|
+
* The total number of objects.
|
|
1462
|
+
*/
|
|
1206
1463
|
totalCount: number;
|
|
1207
1464
|
}
|
|
1208
1465
|
export type ListBackendsRequest = {
|
|
1209
1466
|
/**
|
|
1210
|
-
* Region to target. If none is passed will use default region from the
|
|
1211
|
-
* config.
|
|
1467
|
+
* Region to target. If none is passed will use default region from the config.
|
|
1212
1468
|
*/
|
|
1213
1469
|
region?: ScwRegion;
|
|
1214
|
-
/**
|
|
1470
|
+
/**
|
|
1471
|
+
* Load Balancer ID.
|
|
1472
|
+
*/
|
|
1215
1473
|
lbId: string;
|
|
1216
|
-
/**
|
|
1474
|
+
/**
|
|
1475
|
+
* Name of the backend to filter for.
|
|
1476
|
+
*/
|
|
1217
1477
|
name?: string;
|
|
1218
|
-
/**
|
|
1478
|
+
/**
|
|
1479
|
+
* Sort order of backends in the response.
|
|
1480
|
+
*/
|
|
1219
1481
|
orderBy?: ListBackendsRequestOrderBy;
|
|
1220
|
-
/**
|
|
1482
|
+
/**
|
|
1483
|
+
* The page number to return, from the paginated results.
|
|
1484
|
+
*/
|
|
1221
1485
|
page?: number;
|
|
1222
|
-
/**
|
|
1486
|
+
/**
|
|
1487
|
+
* Number of backends to return.
|
|
1488
|
+
*/
|
|
1223
1489
|
pageSize?: number;
|
|
1224
1490
|
};
|
|
1225
1491
|
export interface ListBackendsResponse {
|
|
1226
|
-
/**
|
|
1492
|
+
/**
|
|
1493
|
+
* List of backend objects of a given Load Balancer.
|
|
1494
|
+
*/
|
|
1227
1495
|
backends: Backend[];
|
|
1228
|
-
/**
|
|
1496
|
+
/**
|
|
1497
|
+
* Total count of backend objects, without pagination.
|
|
1498
|
+
*/
|
|
1229
1499
|
totalCount: number;
|
|
1230
1500
|
}
|
|
1231
1501
|
export type ListCertificatesRequest = {
|
|
1232
1502
|
/**
|
|
1233
|
-
* Region to target. If none is passed will use default region from the
|
|
1234
|
-
* config.
|
|
1503
|
+
* Region to target. If none is passed will use default region from the config.
|
|
1235
1504
|
*/
|
|
1236
1505
|
region?: ScwRegion;
|
|
1237
|
-
/**
|
|
1506
|
+
/**
|
|
1507
|
+
* Load Balancer ID.
|
|
1508
|
+
*/
|
|
1238
1509
|
lbId: string;
|
|
1239
|
-
/**
|
|
1510
|
+
/**
|
|
1511
|
+
* Sort order of certificates in the response.
|
|
1512
|
+
*/
|
|
1240
1513
|
orderBy?: ListCertificatesRequestOrderBy;
|
|
1241
|
-
/**
|
|
1514
|
+
/**
|
|
1515
|
+
* The page number to return, from the paginated results.
|
|
1516
|
+
*/
|
|
1242
1517
|
page?: number;
|
|
1243
|
-
/**
|
|
1518
|
+
/**
|
|
1519
|
+
* Number of certificates to return.
|
|
1520
|
+
*/
|
|
1244
1521
|
pageSize?: number;
|
|
1245
1522
|
/**
|
|
1246
|
-
* Certificate name to filter for, only certificates of this name will be
|
|
1247
|
-
* returned.
|
|
1523
|
+
* Certificate name to filter for, only certificates of this name will be returned.
|
|
1248
1524
|
*/
|
|
1249
1525
|
name?: string;
|
|
1250
1526
|
};
|
|
1251
1527
|
export interface ListCertificatesResponse {
|
|
1252
|
-
/**
|
|
1528
|
+
/**
|
|
1529
|
+
* List of certificate objects.
|
|
1530
|
+
*/
|
|
1253
1531
|
certificates: Certificate[];
|
|
1254
|
-
/**
|
|
1532
|
+
/**
|
|
1533
|
+
* The total number of objects.
|
|
1534
|
+
*/
|
|
1255
1535
|
totalCount: number;
|
|
1256
1536
|
}
|
|
1257
1537
|
export type ListFrontendsRequest = {
|
|
1258
1538
|
/**
|
|
1259
|
-
* Region to target. If none is passed will use default region from the
|
|
1260
|
-
* config.
|
|
1539
|
+
* Region to target. If none is passed will use default region from the config.
|
|
1261
1540
|
*/
|
|
1262
1541
|
region?: ScwRegion;
|
|
1263
|
-
/**
|
|
1542
|
+
/**
|
|
1543
|
+
* Load Balancer ID.
|
|
1544
|
+
*/
|
|
1264
1545
|
lbId: string;
|
|
1265
|
-
/**
|
|
1546
|
+
/**
|
|
1547
|
+
* Name of the frontend to filter for.
|
|
1548
|
+
*/
|
|
1266
1549
|
name?: string;
|
|
1267
|
-
/**
|
|
1550
|
+
/**
|
|
1551
|
+
* Sort order of frontends in the response.
|
|
1552
|
+
*/
|
|
1268
1553
|
orderBy?: ListFrontendsRequestOrderBy;
|
|
1269
|
-
/**
|
|
1554
|
+
/**
|
|
1555
|
+
* The page number to return, from the paginated results.
|
|
1556
|
+
*/
|
|
1270
1557
|
page?: number;
|
|
1271
|
-
/**
|
|
1558
|
+
/**
|
|
1559
|
+
* Number of frontends to return.
|
|
1560
|
+
*/
|
|
1272
1561
|
pageSize?: number;
|
|
1273
1562
|
};
|
|
1274
1563
|
export interface ListFrontendsResponse {
|
|
1275
|
-
/**
|
|
1564
|
+
/**
|
|
1565
|
+
* List of frontend objects of a given Load Balancer.
|
|
1566
|
+
*/
|
|
1276
1567
|
frontends: Frontend[];
|
|
1277
|
-
/**
|
|
1568
|
+
/**
|
|
1569
|
+
* Total count of frontend objects, without pagination.
|
|
1570
|
+
*/
|
|
1278
1571
|
totalCount: number;
|
|
1279
1572
|
}
|
|
1280
1573
|
export type ListIPsRequest = {
|
|
1281
1574
|
/**
|
|
1282
|
-
* Region to target. If none is passed will use default region from the
|
|
1283
|
-
* config.
|
|
1575
|
+
* Region to target. If none is passed will use default region from the config.
|
|
1284
1576
|
*/
|
|
1285
1577
|
region?: ScwRegion;
|
|
1286
|
-
/**
|
|
1578
|
+
/**
|
|
1579
|
+
* The page number to return, from the paginated results.
|
|
1580
|
+
*/
|
|
1287
1581
|
page?: number;
|
|
1288
|
-
/**
|
|
1582
|
+
/**
|
|
1583
|
+
* Number of IP addresses to return.
|
|
1584
|
+
*/
|
|
1289
1585
|
pageSize?: number;
|
|
1290
|
-
/**
|
|
1586
|
+
/**
|
|
1587
|
+
* IP address to filter for.
|
|
1588
|
+
*/
|
|
1291
1589
|
ipAddress?: string;
|
|
1292
1590
|
/**
|
|
1293
|
-
* Organization ID to filter for, only Load Balancer IP addresses from this
|
|
1294
|
-
* Organization will be returned.
|
|
1591
|
+
* Organization ID to filter for, only Load Balancer IP addresses from this Organization will be returned.
|
|
1295
1592
|
*/
|
|
1296
1593
|
organizationId?: string;
|
|
1297
1594
|
/**
|
|
1298
|
-
* Project ID to filter for, only Load Balancer IP addresses from this Project
|
|
1299
|
-
* will be returned.
|
|
1595
|
+
* Project ID to filter for, only Load Balancer IP addresses from this Project will be returned.
|
|
1300
1596
|
*/
|
|
1301
1597
|
projectId?: string;
|
|
1302
|
-
/**
|
|
1598
|
+
/**
|
|
1599
|
+
* IP type to filter for.
|
|
1600
|
+
*/
|
|
1303
1601
|
ipType?: ListIpsRequestIpType;
|
|
1304
1602
|
/**
|
|
1305
|
-
* Tag to filter for, only IPs with one or more matching tags will be
|
|
1306
|
-
* returned.
|
|
1603
|
+
* Tag to filter for, only IPs with one or more matching tags will be returned.
|
|
1307
1604
|
*/
|
|
1308
1605
|
tags?: string[];
|
|
1309
1606
|
};
|
|
1310
1607
|
export interface ListIpsResponse {
|
|
1311
|
-
/**
|
|
1608
|
+
/**
|
|
1609
|
+
* List of IP address objects.
|
|
1610
|
+
*/
|
|
1312
1611
|
ips: Ip[];
|
|
1313
|
-
/**
|
|
1612
|
+
/**
|
|
1613
|
+
* Total count of IP address objects, without pagination.
|
|
1614
|
+
*/
|
|
1314
1615
|
totalCount: number;
|
|
1315
1616
|
}
|
|
1316
1617
|
export type ListLbPrivateNetworksRequest = {
|
|
1317
1618
|
/**
|
|
1318
|
-
* Region to target. If none is passed will use default region from the
|
|
1319
|
-
* config.
|
|
1619
|
+
* Region to target. If none is passed will use default region from the config.
|
|
1320
1620
|
*/
|
|
1321
1621
|
region?: ScwRegion;
|
|
1322
|
-
/**
|
|
1622
|
+
/**
|
|
1623
|
+
* Load Balancer ID.
|
|
1624
|
+
*/
|
|
1323
1625
|
lbId: string;
|
|
1324
|
-
/**
|
|
1626
|
+
/**
|
|
1627
|
+
* Sort order of Private Network objects in the response.
|
|
1628
|
+
*/
|
|
1325
1629
|
orderBy?: ListPrivateNetworksRequestOrderBy;
|
|
1326
|
-
/**
|
|
1630
|
+
/**
|
|
1631
|
+
* Number of objects to return.
|
|
1632
|
+
*/
|
|
1327
1633
|
pageSize?: number;
|
|
1328
|
-
/**
|
|
1634
|
+
/**
|
|
1635
|
+
* The page number to return, from the paginated results.
|
|
1636
|
+
*/
|
|
1329
1637
|
page?: number;
|
|
1330
1638
|
};
|
|
1331
1639
|
export interface ListLbPrivateNetworksResponse {
|
|
1332
|
-
/**
|
|
1640
|
+
/**
|
|
1641
|
+
* List of Private Network objects attached to the Load Balancer.
|
|
1642
|
+
*/
|
|
1333
1643
|
privateNetwork: PrivateNetwork[];
|
|
1334
|
-
/**
|
|
1644
|
+
/**
|
|
1645
|
+
* Total number of objects in the response.
|
|
1646
|
+
*/
|
|
1335
1647
|
totalCount: number;
|
|
1336
1648
|
}
|
|
1337
1649
|
export type ListLbTypesRequest = {
|
|
1338
1650
|
/**
|
|
1339
|
-
* Region to target. If none is passed will use default region from the
|
|
1340
|
-
* config.
|
|
1651
|
+
* Region to target. If none is passed will use default region from the config.
|
|
1341
1652
|
*/
|
|
1342
1653
|
region?: ScwRegion;
|
|
1343
|
-
/**
|
|
1654
|
+
/**
|
|
1655
|
+
* The page number to return, from the paginated results.
|
|
1656
|
+
*/
|
|
1344
1657
|
page?: number;
|
|
1345
|
-
/**
|
|
1658
|
+
/**
|
|
1659
|
+
* The number of items to return.
|
|
1660
|
+
*/
|
|
1346
1661
|
pageSize?: number;
|
|
1347
1662
|
};
|
|
1348
1663
|
export interface ListLbTypesResponse {
|
|
1349
|
-
/**
|
|
1664
|
+
/**
|
|
1665
|
+
* List of Load Balancer commercial offer type objects.
|
|
1666
|
+
*/
|
|
1350
1667
|
lbTypes: LbType[];
|
|
1351
|
-
/**
|
|
1668
|
+
/**
|
|
1669
|
+
* Total number of Load Balancer offer type objects.
|
|
1670
|
+
*/
|
|
1352
1671
|
totalCount: number;
|
|
1353
1672
|
}
|
|
1354
1673
|
export type ListLbsRequest = {
|
|
1355
1674
|
/**
|
|
1356
|
-
* Region to target. If none is passed will use default region from the
|
|
1357
|
-
* config.
|
|
1675
|
+
* Region to target. If none is passed will use default region from the config.
|
|
1358
1676
|
*/
|
|
1359
1677
|
region?: ScwRegion;
|
|
1360
|
-
/**
|
|
1678
|
+
/**
|
|
1679
|
+
* Load Balancer name to filter for.
|
|
1680
|
+
*/
|
|
1361
1681
|
name?: string;
|
|
1362
|
-
/**
|
|
1682
|
+
/**
|
|
1683
|
+
* Sort order of Load Balancers in the response.
|
|
1684
|
+
*/
|
|
1363
1685
|
orderBy?: ListLbsRequestOrderBy;
|
|
1364
|
-
/**
|
|
1686
|
+
/**
|
|
1687
|
+
* Number of Load Balancers to return.
|
|
1688
|
+
*/
|
|
1365
1689
|
pageSize?: number;
|
|
1366
|
-
/**
|
|
1690
|
+
/**
|
|
1691
|
+
* Page number to return, from the paginated results.
|
|
1692
|
+
*/
|
|
1367
1693
|
page?: number;
|
|
1368
1694
|
/**
|
|
1369
|
-
* Organization ID to filter for, only Load Balancers from this Organization
|
|
1370
|
-
* will be returned.
|
|
1695
|
+
* Organization ID to filter for, only Load Balancers from this Organization will be returned.
|
|
1371
1696
|
*/
|
|
1372
1697
|
organizationId?: string;
|
|
1373
1698
|
/**
|
|
1374
|
-
* Project ID to filter for, only Load Balancers from this Project will be
|
|
1375
|
-
* returned.
|
|
1699
|
+
* Project ID to filter for, only Load Balancers from this Project will be returned.
|
|
1376
1700
|
*/
|
|
1377
1701
|
projectId?: string;
|
|
1378
1702
|
/**
|
|
1379
|
-
* Filter by tag, only Load Balancers with one or more matching tags will be
|
|
1380
|
-
* returned.
|
|
1703
|
+
* Filter by tag, only Load Balancers with one or more matching tags will be returned.
|
|
1381
1704
|
*/
|
|
1382
1705
|
tags?: string[];
|
|
1383
1706
|
};
|
|
1384
1707
|
export interface ListLbsResponse {
|
|
1385
|
-
/**
|
|
1708
|
+
/**
|
|
1709
|
+
* List of Load Balancer objects.
|
|
1710
|
+
*/
|
|
1386
1711
|
lbs: Lb[];
|
|
1387
|
-
/**
|
|
1712
|
+
/**
|
|
1713
|
+
* The total number of Load Balancer objects.
|
|
1714
|
+
*/
|
|
1388
1715
|
totalCount: number;
|
|
1389
1716
|
}
|
|
1390
1717
|
export type ListRoutesRequest = {
|
|
1391
1718
|
/**
|
|
1392
|
-
* Region to target. If none is passed will use default region from the
|
|
1393
|
-
* config.
|
|
1719
|
+
* Region to target. If none is passed will use default region from the config.
|
|
1394
1720
|
*/
|
|
1395
1721
|
region?: ScwRegion;
|
|
1396
|
-
/**
|
|
1722
|
+
/**
|
|
1723
|
+
* Sort order of routes in the response.
|
|
1724
|
+
*/
|
|
1397
1725
|
orderBy?: ListRoutesRequestOrderBy;
|
|
1398
|
-
/**
|
|
1726
|
+
/**
|
|
1727
|
+
* The number of route objects to return.
|
|
1728
|
+
*/
|
|
1399
1729
|
pageSize?: number;
|
|
1400
|
-
/**
|
|
1730
|
+
/**
|
|
1731
|
+
* The page number to return, from the paginated results.
|
|
1732
|
+
*/
|
|
1401
1733
|
page?: number;
|
|
1402
|
-
/**
|
|
1734
|
+
/**
|
|
1735
|
+
* Frontend ID to filter for, only Routes from this Frontend will be returned.
|
|
1736
|
+
*/
|
|
1403
1737
|
frontendId?: string;
|
|
1404
1738
|
};
|
|
1405
1739
|
export interface ListRoutesResponse {
|
|
1406
|
-
/**
|
|
1740
|
+
/**
|
|
1741
|
+
* List of route objects.
|
|
1742
|
+
*/
|
|
1407
1743
|
routes: Route[];
|
|
1408
|
-
/**
|
|
1744
|
+
/**
|
|
1745
|
+
* The total number of route objects.
|
|
1746
|
+
*/
|
|
1409
1747
|
totalCount: number;
|
|
1410
1748
|
}
|
|
1411
1749
|
export type ListSubscriberRequest = {
|
|
1412
1750
|
/**
|
|
1413
|
-
* Region to target. If none is passed will use default region from the
|
|
1414
|
-
* config.
|
|
1751
|
+
* Region to target. If none is passed will use default region from the config.
|
|
1415
1752
|
*/
|
|
1416
1753
|
region?: ScwRegion;
|
|
1417
|
-
/**
|
|
1754
|
+
/**
|
|
1755
|
+
* Sort order of subscribers in the response.
|
|
1756
|
+
*/
|
|
1418
1757
|
orderBy?: ListSubscriberRequestOrderBy;
|
|
1419
|
-
/**
|
|
1758
|
+
/**
|
|
1759
|
+
* The page number to return, from the paginated results.
|
|
1760
|
+
*/
|
|
1420
1761
|
page?: number;
|
|
1421
|
-
/**
|
|
1762
|
+
/**
|
|
1763
|
+
* The number of items to return.
|
|
1764
|
+
*/
|
|
1422
1765
|
pageSize?: number;
|
|
1423
|
-
/**
|
|
1766
|
+
/**
|
|
1767
|
+
* Subscriber name to search for.
|
|
1768
|
+
*/
|
|
1424
1769
|
name?: string;
|
|
1425
|
-
/**
|
|
1770
|
+
/**
|
|
1771
|
+
* Filter subscribers by Organization ID.
|
|
1772
|
+
*/
|
|
1426
1773
|
organizationId?: string;
|
|
1427
|
-
/**
|
|
1774
|
+
/**
|
|
1775
|
+
* Filter subscribers by Project ID.
|
|
1776
|
+
*/
|
|
1428
1777
|
projectId?: string;
|
|
1429
1778
|
};
|
|
1430
1779
|
export interface ListSubscriberResponse {
|
|
1431
|
-
/**
|
|
1780
|
+
/**
|
|
1781
|
+
* List of subscriber objects.
|
|
1782
|
+
*/
|
|
1432
1783
|
subscribers: Subscriber[];
|
|
1433
|
-
/**
|
|
1784
|
+
/**
|
|
1785
|
+
* The total number of objects.
|
|
1786
|
+
*/
|
|
1434
1787
|
totalCount: number;
|
|
1435
1788
|
}
|
|
1436
1789
|
export type MigrateLbRequest = {
|
|
1437
1790
|
/**
|
|
1438
|
-
* Region to target. If none is passed will use default region from the
|
|
1439
|
-
* config.
|
|
1791
|
+
* Region to target. If none is passed will use default region from the config.
|
|
1440
1792
|
*/
|
|
1441
1793
|
region?: ScwRegion;
|
|
1442
|
-
/**
|
|
1794
|
+
/**
|
|
1795
|
+
* Load Balancer ID.
|
|
1796
|
+
*/
|
|
1443
1797
|
lbId: string;
|
|
1444
1798
|
/**
|
|
1445
|
-
* Load Balancer type to migrate to (use the List all Load Balancer offer
|
|
1446
|
-
* types endpoint to get a list of available offer types).
|
|
1799
|
+
* Load Balancer type to migrate to (use the List all Load Balancer offer types endpoint to get a list of available offer types).
|
|
1447
1800
|
*/
|
|
1448
1801
|
type: string;
|
|
1449
1802
|
};
|
|
1450
1803
|
export type ReleaseIpRequest = {
|
|
1451
1804
|
/**
|
|
1452
|
-
* Region to target. If none is passed will use default region from the
|
|
1453
|
-
* config.
|
|
1805
|
+
* Region to target. If none is passed will use default region from the config.
|
|
1454
1806
|
*/
|
|
1455
1807
|
region?: ScwRegion;
|
|
1456
|
-
/**
|
|
1808
|
+
/**
|
|
1809
|
+
* IP address ID.
|
|
1810
|
+
*/
|
|
1457
1811
|
ipId: string;
|
|
1458
1812
|
};
|
|
1459
1813
|
export type RemoveBackendServersRequest = {
|
|
1460
1814
|
/**
|
|
1461
|
-
* Region to target. If none is passed will use default region from the
|
|
1462
|
-
* config.
|
|
1815
|
+
* Region to target. If none is passed will use default region from the config.
|
|
1463
1816
|
*/
|
|
1464
1817
|
region?: ScwRegion;
|
|
1465
|
-
/**
|
|
1818
|
+
/**
|
|
1819
|
+
* Backend ID.
|
|
1820
|
+
*/
|
|
1466
1821
|
backendId: string;
|
|
1467
|
-
/**
|
|
1822
|
+
/**
|
|
1823
|
+
* List of IP addresses to remove from backend servers.
|
|
1824
|
+
*/
|
|
1468
1825
|
serverIp: string[];
|
|
1469
1826
|
};
|
|
1470
1827
|
export interface SetAclsResponse {
|
|
1471
|
-
/**
|
|
1828
|
+
/**
|
|
1829
|
+
* List of ACL objects.
|
|
1830
|
+
*/
|
|
1472
1831
|
acls: Acl[];
|
|
1473
|
-
/**
|
|
1832
|
+
/**
|
|
1833
|
+
* The total number of ACL objects.
|
|
1834
|
+
*/
|
|
1474
1835
|
totalCount: number;
|
|
1475
1836
|
}
|
|
1476
1837
|
export type SetBackendServersRequest = {
|
|
1477
1838
|
/**
|
|
1478
|
-
* Region to target. If none is passed will use default region from the
|
|
1479
|
-
* config.
|
|
1839
|
+
* Region to target. If none is passed will use default region from the config.
|
|
1480
1840
|
*/
|
|
1481
1841
|
region?: ScwRegion;
|
|
1482
|
-
/**
|
|
1842
|
+
/**
|
|
1843
|
+
* Backend ID.
|
|
1844
|
+
*/
|
|
1483
1845
|
backendId: string;
|
|
1484
1846
|
/**
|
|
1485
|
-
* List of IP addresses for backend servers. Any other existing backend
|
|
1486
|
-
* servers will be removed.
|
|
1847
|
+
* List of IP addresses for backend servers. Any other existing backend servers will be removed.
|
|
1487
1848
|
*/
|
|
1488
1849
|
serverIp: string[];
|
|
1489
1850
|
};
|
|
1490
1851
|
export type SubscribeToLbRequest = {
|
|
1491
1852
|
/**
|
|
1492
|
-
* Region to target. If none is passed will use default region from the
|
|
1493
|
-
* config.
|
|
1853
|
+
* Region to target. If none is passed will use default region from the config.
|
|
1494
1854
|
*/
|
|
1495
1855
|
region?: ScwRegion;
|
|
1496
|
-
/**
|
|
1856
|
+
/**
|
|
1857
|
+
* Load Balancer ID.
|
|
1858
|
+
*/
|
|
1497
1859
|
lbId: string;
|
|
1498
|
-
/**
|
|
1860
|
+
/**
|
|
1861
|
+
* Subscriber ID.
|
|
1862
|
+
*/
|
|
1499
1863
|
subscriberId: string;
|
|
1500
1864
|
};
|
|
1501
1865
|
export type UnsubscribeFromLbRequest = {
|
|
1502
1866
|
/**
|
|
1503
|
-
* Region to target. If none is passed will use default region from the
|
|
1504
|
-
* config.
|
|
1867
|
+
* Region to target. If none is passed will use default region from the config.
|
|
1505
1868
|
*/
|
|
1506
1869
|
region?: ScwRegion;
|
|
1507
|
-
/**
|
|
1870
|
+
/**
|
|
1871
|
+
* Load Balancer ID.
|
|
1872
|
+
*/
|
|
1508
1873
|
lbId: string;
|
|
1509
1874
|
};
|
|
1510
1875
|
export type UpdateAclRequest = {
|
|
1511
1876
|
/**
|
|
1512
|
-
* Region to target. If none is passed will use default region from the
|
|
1513
|
-
* config.
|
|
1877
|
+
* Region to target. If none is passed will use default region from the config.
|
|
1514
1878
|
*/
|
|
1515
1879
|
region?: ScwRegion;
|
|
1516
|
-
/**
|
|
1880
|
+
/**
|
|
1881
|
+
* ACL ID.
|
|
1882
|
+
*/
|
|
1517
1883
|
aclId: string;
|
|
1518
|
-
/**
|
|
1884
|
+
/**
|
|
1885
|
+
* ACL name.
|
|
1886
|
+
*/
|
|
1519
1887
|
name: string;
|
|
1520
|
-
/**
|
|
1888
|
+
/**
|
|
1889
|
+
* Action to take when incoming traffic matches an ACL filter.
|
|
1890
|
+
*/
|
|
1521
1891
|
action: AclAction;
|
|
1522
1892
|
/**
|
|
1523
|
-
* ACL match filter object. One of `ip_subnet` or `http_filter` &
|
|
1524
|
-
* `http_filter_value` are required.
|
|
1893
|
+
* ACL match filter object. One of `ip_subnet` or `http_filter` & `http_filter_value` are required.
|
|
1525
1894
|
*/
|
|
1526
1895
|
match?: AclMatch;
|
|
1527
1896
|
/**
|
|
1528
|
-
* Priority of this ACL (ACLs are applied in ascending order, 0 is the first
|
|
1529
|
-
* ACL executed).
|
|
1897
|
+
* Priority of this ACL (ACLs are applied in ascending order, 0 is the first ACL executed).
|
|
1530
1898
|
*/
|
|
1531
1899
|
index: number;
|
|
1532
|
-
/**
|
|
1900
|
+
/**
|
|
1901
|
+
* ACL description.
|
|
1902
|
+
*/
|
|
1533
1903
|
description?: string;
|
|
1534
1904
|
};
|
|
1535
1905
|
export type UpdateBackendRequest = {
|
|
1536
1906
|
/**
|
|
1537
|
-
* Region to target. If none is passed will use default region from the
|
|
1538
|
-
* config.
|
|
1907
|
+
* Region to target. If none is passed will use default region from the config.
|
|
1539
1908
|
*/
|
|
1540
1909
|
region?: ScwRegion;
|
|
1541
|
-
/**
|
|
1910
|
+
/**
|
|
1911
|
+
* Backend ID.
|
|
1912
|
+
*/
|
|
1542
1913
|
backendId: string;
|
|
1543
|
-
/**
|
|
1914
|
+
/**
|
|
1915
|
+
* Backend name.
|
|
1916
|
+
*/
|
|
1544
1917
|
name: string;
|
|
1545
1918
|
/**
|
|
1546
|
-
* Protocol to be used by the backend when forwarding traffic to backend
|
|
1547
|
-
* servers.
|
|
1919
|
+
* Protocol to be used by the backend when forwarding traffic to backend servers.
|
|
1548
1920
|
*/
|
|
1549
1921
|
forwardProtocol: Protocol;
|
|
1550
|
-
/**
|
|
1922
|
+
/**
|
|
1923
|
+
* Port to be used by the backend when forwarding traffic to backend servers.
|
|
1924
|
+
*/
|
|
1551
1925
|
forwardPort: number;
|
|
1552
1926
|
/**
|
|
1553
|
-
* Load balancing algorithm to be used when determining which backend server
|
|
1554
|
-
* to forward new traffic to.
|
|
1927
|
+
* Load balancing algorithm to be used when determining which backend server to forward new traffic to.
|
|
1555
1928
|
*/
|
|
1556
1929
|
forwardPortAlgorithm: ForwardPortAlgorithm;
|
|
1557
1930
|
/**
|
|
1558
|
-
* Defines whether to activate sticky sessions (binding a particular session
|
|
1559
|
-
* to a particular backend server) and the method to use if so. None disables
|
|
1560
|
-
* sticky sessions. Cookie-based uses an HTTP cookie to stick a session to a
|
|
1561
|
-
* backend server. Table-based uses the source (client) IP address to stick a
|
|
1562
|
-
* session to a backend server.
|
|
1931
|
+
* Defines whether to activate sticky sessions (binding a particular session to a particular backend server) and the method to use if so. None disables sticky sessions. Cookie-based uses an HTTP cookie to stick a session to a backend server. Table-based uses the source (client) IP address to stick a session to a backend server.
|
|
1563
1932
|
*/
|
|
1564
1933
|
stickySessions: StickySessionsType;
|
|
1565
|
-
/**
|
|
1934
|
+
/**
|
|
1935
|
+
* Cookie name for cookie-based sticky sessions.
|
|
1936
|
+
*/
|
|
1566
1937
|
stickySessionsCookieName: string;
|
|
1567
|
-
/**
|
|
1938
|
+
/**
|
|
1939
|
+
* @deprecated Deprecated in favor of proxy_protocol field.
|
|
1940
|
+
*/
|
|
1568
1941
|
sendProxyV2?: boolean;
|
|
1569
|
-
/**
|
|
1942
|
+
/**
|
|
1943
|
+
* Maximum allowed time for a backend server to process a request.
|
|
1944
|
+
*/
|
|
1570
1945
|
timeoutServer?: string;
|
|
1571
|
-
/**
|
|
1946
|
+
/**
|
|
1947
|
+
* Maximum allowed time for establishing a connection to a backend server.
|
|
1948
|
+
*/
|
|
1572
1949
|
timeoutConnect?: string;
|
|
1573
1950
|
/**
|
|
1574
|
-
* Maximum allowed tunnel inactivity time after Websocket is established
|
|
1575
|
-
* (takes precedence over client and server timeout).
|
|
1951
|
+
* Maximum allowed tunnel inactivity time after Websocket is established (takes precedence over client and server timeout).
|
|
1576
1952
|
*/
|
|
1577
1953
|
timeoutTunnel?: string;
|
|
1578
|
-
/**
|
|
1954
|
+
/**
|
|
1955
|
+
* Action to take when a backend server is marked as down.
|
|
1956
|
+
*/
|
|
1579
1957
|
onMarkedDownAction?: OnMarkedDownAction;
|
|
1580
1958
|
/**
|
|
1581
|
-
* Protocol to use between the Load Balancer and backend servers. Allows the
|
|
1582
|
-
* backend servers to be informed of the client's real IP address. The PROXY
|
|
1583
|
-
* protocol must be supported by the backend servers' software.
|
|
1959
|
+
* Protocol to use between the Load Balancer and backend servers. Allows the backend servers to be informed of the client's real IP address. The PROXY protocol must be supported by the backend servers' software.
|
|
1584
1960
|
*/
|
|
1585
1961
|
proxyProtocol?: ProxyProtocol;
|
|
1586
1962
|
/**
|
|
1587
|
-
* Scaleway Object Storage bucket website to be served as failover if all
|
|
1588
|
-
* backend servers are down, e.g.
|
|
1589
|
-
* failover-website.s3-website.fr-par.scw.cloud.
|
|
1963
|
+
* Scaleway Object Storage bucket website to be served as failover if all backend servers are down, e.g. failover-website.s3-website.fr-par.scw.cloud.
|
|
1590
1964
|
*/
|
|
1591
1965
|
failoverHost?: string;
|
|
1592
1966
|
/**
|
|
1593
|
-
* Defines whether to enable SSL bridging between the Load Balancer and
|
|
1594
|
-
* backend servers.
|
|
1967
|
+
* Defines whether to enable SSL bridging between the Load Balancer and backend servers.
|
|
1595
1968
|
*/
|
|
1596
1969
|
sslBridging?: boolean;
|
|
1597
|
-
/**
|
|
1970
|
+
/**
|
|
1971
|
+
* Defines whether the server certificate verification should be ignored.
|
|
1972
|
+
*/
|
|
1598
1973
|
ignoreSslServerVerify?: boolean;
|
|
1599
|
-
/**
|
|
1974
|
+
/**
|
|
1975
|
+
* Whether to use another backend server on each attempt.
|
|
1976
|
+
*/
|
|
1600
1977
|
redispatchAttemptCount?: number;
|
|
1601
|
-
/**
|
|
1978
|
+
/**
|
|
1979
|
+
* Number of retries when a backend server connection failed.
|
|
1980
|
+
*/
|
|
1602
1981
|
maxRetries?: number;
|
|
1603
|
-
/**
|
|
1982
|
+
/**
|
|
1983
|
+
* Maximum number of connections allowed per backend server.
|
|
1984
|
+
*/
|
|
1604
1985
|
maxConnections?: number;
|
|
1605
1986
|
/**
|
|
1606
|
-
* Maximum time for a request to be left pending in queue when
|
|
1607
|
-
* `max_connections` is reached.
|
|
1987
|
+
* Maximum time for a request to be left pending in queue when `max_connections` is reached.
|
|
1608
1988
|
*/
|
|
1609
1989
|
timeoutQueue?: string;
|
|
1610
1990
|
};
|
|
1611
1991
|
export type UpdateCertificateRequest = {
|
|
1612
1992
|
/**
|
|
1613
|
-
* Region to target. If none is passed will use default region from the
|
|
1614
|
-
* config.
|
|
1993
|
+
* Region to target. If none is passed will use default region from the config.
|
|
1615
1994
|
*/
|
|
1616
1995
|
region?: ScwRegion;
|
|
1617
|
-
/**
|
|
1996
|
+
/**
|
|
1997
|
+
* Certificate ID.
|
|
1998
|
+
*/
|
|
1618
1999
|
certificateId: string;
|
|
1619
|
-
/**
|
|
2000
|
+
/**
|
|
2001
|
+
* Certificate name.
|
|
2002
|
+
*/
|
|
1620
2003
|
name: string;
|
|
1621
2004
|
};
|
|
1622
2005
|
export type UpdateFrontendRequest = {
|
|
1623
2006
|
/**
|
|
1624
|
-
* Region to target. If none is passed will use default region from the
|
|
1625
|
-
* config.
|
|
2007
|
+
* Region to target. If none is passed will use default region from the config.
|
|
1626
2008
|
*/
|
|
1627
2009
|
region?: ScwRegion;
|
|
1628
|
-
/**
|
|
2010
|
+
/**
|
|
2011
|
+
* Frontend ID.
|
|
2012
|
+
*/
|
|
1629
2013
|
frontendId: string;
|
|
1630
|
-
/**
|
|
2014
|
+
/**
|
|
2015
|
+
* Frontend name.
|
|
2016
|
+
*/
|
|
1631
2017
|
name: string;
|
|
1632
|
-
/**
|
|
2018
|
+
/**
|
|
2019
|
+
* Port the frontend should listen on.
|
|
2020
|
+
*/
|
|
1633
2021
|
inboundPort: number;
|
|
1634
|
-
/**
|
|
2022
|
+
/**
|
|
2023
|
+
* Backend ID (ID of the backend the frontend should pass traffic to).
|
|
2024
|
+
*/
|
|
1635
2025
|
backendId: string;
|
|
1636
|
-
/**
|
|
2026
|
+
/**
|
|
2027
|
+
* Maximum allowed inactivity time on the client side.
|
|
2028
|
+
*/
|
|
1637
2029
|
timeoutClient?: string;
|
|
1638
|
-
/**
|
|
2030
|
+
/**
|
|
2031
|
+
* @deprecated Certificate ID, deprecated in favor of certificate_ids array.
|
|
2032
|
+
*/
|
|
1639
2033
|
certificateId?: string;
|
|
1640
|
-
/**
|
|
2034
|
+
/**
|
|
2035
|
+
* List of SSL/TLS certificate IDs to bind to the frontend.
|
|
2036
|
+
*/
|
|
1641
2037
|
certificateIds?: string[];
|
|
1642
|
-
/**
|
|
2038
|
+
/**
|
|
2039
|
+
* Defines whether to enable HTTP/3 protocol on the frontend.
|
|
2040
|
+
*/
|
|
1643
2041
|
enableHttp3: boolean;
|
|
1644
2042
|
/**
|
|
1645
|
-
* Rate limit for new connections established on this frontend. Use 0 value to
|
|
1646
|
-
* disable, else value is connections per second.
|
|
2043
|
+
* Rate limit for new connections established on this frontend. Use 0 value to disable, else value is connections per second.
|
|
1647
2044
|
*/
|
|
1648
2045
|
connectionRateLimit?: number;
|
|
1649
2046
|
};
|
|
1650
2047
|
export type UpdateHealthCheckRequest = {
|
|
1651
2048
|
/**
|
|
1652
|
-
* Region to target. If none is passed will use default region from the
|
|
1653
|
-
* config.
|
|
2049
|
+
* Region to target. If none is passed will use default region from the config.
|
|
1654
2050
|
*/
|
|
1655
2051
|
region?: ScwRegion;
|
|
1656
|
-
/**
|
|
2052
|
+
/**
|
|
2053
|
+
* Backend ID.
|
|
2054
|
+
*/
|
|
1657
2055
|
backendId: string;
|
|
1658
|
-
/**
|
|
2056
|
+
/**
|
|
2057
|
+
* Port to use for the backend server health check.
|
|
2058
|
+
*/
|
|
1659
2059
|
port: number;
|
|
1660
|
-
/**
|
|
2060
|
+
/**
|
|
2061
|
+
* Time to wait between two consecutive health checks.
|
|
2062
|
+
*/
|
|
1661
2063
|
checkDelay?: string;
|
|
1662
|
-
/**
|
|
2064
|
+
/**
|
|
2065
|
+
* Maximum time a backend server has to reply to the health check.
|
|
2066
|
+
*/
|
|
1663
2067
|
checkTimeout?: string;
|
|
1664
2068
|
/**
|
|
1665
|
-
* Number of consecutive unsuccessful health checks after which the server
|
|
1666
|
-
* will be considered dead.
|
|
2069
|
+
* Number of consecutive unsuccessful health checks after which the server will be considered dead.
|
|
1667
2070
|
*/
|
|
1668
2071
|
checkMaxRetries: number;
|
|
1669
|
-
/**
|
|
2072
|
+
/**
|
|
2073
|
+
* Defines whether proxy protocol should be activated for the health check.
|
|
2074
|
+
*/
|
|
1670
2075
|
checkSendProxy: boolean;
|
|
1671
2076
|
/**
|
|
1672
2077
|
* Object to configure a basic TCP health check.
|
|
1673
2078
|
*
|
|
1674
|
-
* One-of ('config'): at most one of 'tcpConfig', 'mysqlConfig',
|
|
1675
|
-
* 'pgsqlConfig', 'ldapConfig', 'redisConfig', 'httpConfig', 'httpsConfig'
|
|
1676
|
-
* could be set.
|
|
2079
|
+
* One-of ('config'): at most one of 'tcpConfig', 'mysqlConfig', 'pgsqlConfig', 'ldapConfig', 'redisConfig', 'httpConfig', 'httpsConfig' could be set.
|
|
1677
2080
|
*/
|
|
1678
2081
|
tcpConfig?: HealthCheckTcpConfig;
|
|
1679
2082
|
/**
|
|
1680
|
-
* Object to configure a MySQL health check. The check requires MySQL >=3.22
|
|
1681
|
-
* or <9.0. For older or newer versions, use a TCP health check.
|
|
2083
|
+
* Object to configure a MySQL health check. The check requires MySQL >=3.22 or <9.0. For older or newer versions, use a TCP health check.
|
|
1682
2084
|
*
|
|
1683
|
-
* One-of ('config'): at most one of 'tcpConfig', 'mysqlConfig',
|
|
1684
|
-
* 'pgsqlConfig', 'ldapConfig', 'redisConfig', 'httpConfig', 'httpsConfig'
|
|
1685
|
-
* could be set.
|
|
2085
|
+
* One-of ('config'): at most one of 'tcpConfig', 'mysqlConfig', 'pgsqlConfig', 'ldapConfig', 'redisConfig', 'httpConfig', 'httpsConfig' could be set.
|
|
1686
2086
|
*/
|
|
1687
2087
|
mysqlConfig?: HealthCheckMysqlConfig;
|
|
1688
2088
|
/**
|
|
1689
2089
|
* Object to configure a PostgreSQL health check.
|
|
1690
2090
|
*
|
|
1691
|
-
* One-of ('config'): at most one of 'tcpConfig', 'mysqlConfig',
|
|
1692
|
-
* 'pgsqlConfig', 'ldapConfig', 'redisConfig', 'httpConfig', 'httpsConfig'
|
|
1693
|
-
* could be set.
|
|
2091
|
+
* One-of ('config'): at most one of 'tcpConfig', 'mysqlConfig', 'pgsqlConfig', 'ldapConfig', 'redisConfig', 'httpConfig', 'httpsConfig' could be set.
|
|
1694
2092
|
*/
|
|
1695
2093
|
pgsqlConfig?: HealthCheckPgsqlConfig;
|
|
1696
2094
|
/**
|
|
1697
|
-
* Object to configure an LDAP health check. The response is analyzed to find
|
|
1698
|
-
* the LDAPv3 response message.
|
|
2095
|
+
* Object to configure an LDAP health check. The response is analyzed to find the LDAPv3 response message.
|
|
1699
2096
|
*
|
|
1700
|
-
* One-of ('config'): at most one of 'tcpConfig', 'mysqlConfig',
|
|
1701
|
-
* 'pgsqlConfig', 'ldapConfig', 'redisConfig', 'httpConfig', 'httpsConfig'
|
|
1702
|
-
* could be set.
|
|
2097
|
+
* One-of ('config'): at most one of 'tcpConfig', 'mysqlConfig', 'pgsqlConfig', 'ldapConfig', 'redisConfig', 'httpConfig', 'httpsConfig' could be set.
|
|
1703
2098
|
*/
|
|
1704
2099
|
ldapConfig?: HealthCheckLdapConfig;
|
|
1705
2100
|
/**
|
|
1706
|
-
* Object to configure a Redis health check. The response is analyzed to find
|
|
1707
|
-
* the +PONG response message.
|
|
2101
|
+
* Object to configure a Redis health check. The response is analyzed to find the +PONG response message.
|
|
1708
2102
|
*
|
|
1709
|
-
* One-of ('config'): at most one of 'tcpConfig', 'mysqlConfig',
|
|
1710
|
-
* 'pgsqlConfig', 'ldapConfig', 'redisConfig', 'httpConfig', 'httpsConfig'
|
|
1711
|
-
* could be set.
|
|
2103
|
+
* One-of ('config'): at most one of 'tcpConfig', 'mysqlConfig', 'pgsqlConfig', 'ldapConfig', 'redisConfig', 'httpConfig', 'httpsConfig' could be set.
|
|
1712
2104
|
*/
|
|
1713
2105
|
redisConfig?: HealthCheckRedisConfig;
|
|
1714
2106
|
/**
|
|
1715
2107
|
* Object to configure an HTTP health check.
|
|
1716
2108
|
*
|
|
1717
|
-
* One-of ('config'): at most one of 'tcpConfig', 'mysqlConfig',
|
|
1718
|
-
* 'pgsqlConfig', 'ldapConfig', 'redisConfig', 'httpConfig', 'httpsConfig'
|
|
1719
|
-
* could be set.
|
|
2109
|
+
* One-of ('config'): at most one of 'tcpConfig', 'mysqlConfig', 'pgsqlConfig', 'ldapConfig', 'redisConfig', 'httpConfig', 'httpsConfig' could be set.
|
|
1720
2110
|
*/
|
|
1721
2111
|
httpConfig?: HealthCheckHttpConfig;
|
|
1722
2112
|
/**
|
|
1723
2113
|
* Object to configure an HTTPS health check.
|
|
1724
2114
|
*
|
|
1725
|
-
* One-of ('config'): at most one of 'tcpConfig', 'mysqlConfig',
|
|
1726
|
-
* 'pgsqlConfig', 'ldapConfig', 'redisConfig', 'httpConfig', 'httpsConfig'
|
|
1727
|
-
* could be set.
|
|
2115
|
+
* One-of ('config'): at most one of 'tcpConfig', 'mysqlConfig', 'pgsqlConfig', 'ldapConfig', 'redisConfig', 'httpConfig', 'httpsConfig' could be set.
|
|
1728
2116
|
*/
|
|
1729
2117
|
httpsConfig?: HealthCheckHttpsConfig;
|
|
1730
2118
|
/**
|
|
1731
|
-
* Time to wait between two consecutive health checks when a backend server is
|
|
1732
|
-
* in a transient state (going UP or DOWN).
|
|
2119
|
+
* Time to wait between two consecutive health checks when a backend server is in a transient state (going UP or DOWN).
|
|
1733
2120
|
*/
|
|
1734
2121
|
transientCheckDelay?: string;
|
|
1735
2122
|
};
|
|
1736
2123
|
export type UpdateIpRequest = {
|
|
1737
2124
|
/**
|
|
1738
|
-
* Region to target. If none is passed will use default region from the
|
|
1739
|
-
* config.
|
|
2125
|
+
* Region to target. If none is passed will use default region from the config.
|
|
1740
2126
|
*/
|
|
1741
2127
|
region?: ScwRegion;
|
|
1742
|
-
/**
|
|
2128
|
+
/**
|
|
2129
|
+
* IP address ID.
|
|
2130
|
+
*/
|
|
1743
2131
|
ipId: string;
|
|
1744
|
-
/**
|
|
2132
|
+
/**
|
|
2133
|
+
* Reverse DNS (domain name) for the IP address.
|
|
2134
|
+
*/
|
|
1745
2135
|
reverse?: string;
|
|
1746
|
-
/**
|
|
2136
|
+
/**
|
|
2137
|
+
* ID of the server on which to attach the flexible IP.
|
|
2138
|
+
*/
|
|
1747
2139
|
lbId?: string;
|
|
1748
|
-
/**
|
|
2140
|
+
/**
|
|
2141
|
+
* List of tags for the IP.
|
|
2142
|
+
*/
|
|
1749
2143
|
tags?: string[];
|
|
1750
2144
|
};
|
|
1751
2145
|
export type UpdateLbRequest = {
|
|
1752
2146
|
/**
|
|
1753
|
-
* Region to target. If none is passed will use default region from the
|
|
1754
|
-
* config.
|
|
2147
|
+
* Region to target. If none is passed will use default region from the config.
|
|
1755
2148
|
*/
|
|
1756
2149
|
region?: ScwRegion;
|
|
1757
|
-
/**
|
|
2150
|
+
/**
|
|
2151
|
+
* Load Balancer ID.
|
|
2152
|
+
*/
|
|
1758
2153
|
lbId: string;
|
|
1759
|
-
/**
|
|
2154
|
+
/**
|
|
2155
|
+
* Load Balancer name.
|
|
2156
|
+
*/
|
|
1760
2157
|
name: string;
|
|
1761
|
-
/**
|
|
2158
|
+
/**
|
|
2159
|
+
* Load Balancer description.
|
|
2160
|
+
*/
|
|
1762
2161
|
description: string;
|
|
1763
|
-
/**
|
|
2162
|
+
/**
|
|
2163
|
+
* List of tags for the Load Balancer.
|
|
2164
|
+
*/
|
|
1764
2165
|
tags?: string[];
|
|
1765
2166
|
/**
|
|
1766
|
-
* Determines the minimal SSL version which needs to be supported on the
|
|
1767
|
-
* client side, in an SSL/TLS offloading context. Intermediate is suitable for
|
|
1768
|
-
* general-purpose servers with a variety of clients, recommended for almost
|
|
1769
|
-
* all systems. Modern is suitable for services with clients that support TLS
|
|
1770
|
-
* 1.3 and don't need backward compatibility. Old is compatible with a small
|
|
1771
|
-
* number of very old clients and should be used only as a last resort.
|
|
2167
|
+
* Determines the minimal SSL version which needs to be supported on the client side, in an SSL/TLS offloading context. Intermediate is suitable for general-purpose servers with a variety of clients, recommended for almost all systems. Modern is suitable for services with clients that support TLS 1.3 and don't need backward compatibility. Old is compatible with a small number of very old clients and should be used only as a last resort.
|
|
1772
2168
|
*/
|
|
1773
2169
|
sslCompatibilityLevel?: SSLCompatibilityLevel;
|
|
1774
2170
|
};
|
|
1775
2171
|
export type UpdateRouteRequest = {
|
|
1776
2172
|
/**
|
|
1777
|
-
* Region to target. If none is passed will use default region from the
|
|
1778
|
-
* config.
|
|
2173
|
+
* Region to target. If none is passed will use default region from the config.
|
|
1779
2174
|
*/
|
|
1780
2175
|
region?: ScwRegion;
|
|
1781
|
-
/**
|
|
2176
|
+
/**
|
|
2177
|
+
* Route ID.
|
|
2178
|
+
*/
|
|
1782
2179
|
routeId: string;
|
|
1783
|
-
/**
|
|
2180
|
+
/**
|
|
2181
|
+
* ID of the target backend for the route.
|
|
2182
|
+
*/
|
|
1784
2183
|
backendId: string;
|
|
1785
2184
|
/**
|
|
1786
|
-
* Object defining the match condition for a route to be applied. If an
|
|
1787
|
-
* incoming client session matches the specified condition (i.e. it has a
|
|
1788
|
-
* matching SNI value or HTTP Host header value), it will be passed to the
|
|
1789
|
-
* target backend.
|
|
2185
|
+
* Object defining the match condition for a route to be applied. If an incoming client session matches the specified condition (i.e. it has a matching SNI value or HTTP Host header value), it will be passed to the target backend.
|
|
1790
2186
|
*/
|
|
1791
2187
|
match?: RouteMatch;
|
|
1792
2188
|
};
|
|
1793
2189
|
export type UpdateSubscriberRequest = {
|
|
1794
2190
|
/**
|
|
1795
|
-
* Region to target. If none is passed will use default region from the
|
|
1796
|
-
* config.
|
|
2191
|
+
* Region to target. If none is passed will use default region from the config.
|
|
1797
2192
|
*/
|
|
1798
2193
|
region?: ScwRegion;
|
|
1799
|
-
/**
|
|
2194
|
+
/**
|
|
2195
|
+
* Subscriber ID.
|
|
2196
|
+
*/
|
|
1800
2197
|
subscriberId: string;
|
|
1801
|
-
/**
|
|
2198
|
+
/**
|
|
2199
|
+
* Subscriber name.
|
|
2200
|
+
*/
|
|
1802
2201
|
name: string;
|
|
1803
2202
|
/**
|
|
1804
2203
|
* Email address configuration.
|
|
1805
2204
|
*
|
|
1806
|
-
* One-of ('config'): at most one of 'emailConfig', 'webhookConfig' could be
|
|
1807
|
-
* set.
|
|
2205
|
+
* One-of ('config'): at most one of 'emailConfig', 'webhookConfig' could be set.
|
|
1808
2206
|
*/
|
|
1809
2207
|
emailConfig?: SubscriberEmailConfig;
|
|
1810
2208
|
/**
|
|
1811
2209
|
* Webhook URI configuration.
|
|
1812
2210
|
*
|
|
1813
|
-
* One-of ('config'): at most one of 'emailConfig', 'webhookConfig' could be
|
|
1814
|
-
* set.
|
|
2211
|
+
* One-of ('config'): at most one of 'emailConfig', 'webhookConfig' could be set.
|
|
1815
2212
|
*/
|
|
1816
2213
|
webhookConfig?: SubscriberWebhookConfig;
|
|
1817
2214
|
};
|
|
1818
2215
|
export type ZonedApiAddBackendServersRequest = {
|
|
1819
|
-
/**
|
|
2216
|
+
/**
|
|
2217
|
+
* Zone to target. If none is passed will use default zone from the config.
|
|
2218
|
+
*/
|
|
1820
2219
|
zone?: ScwZone;
|
|
1821
|
-
/**
|
|
2220
|
+
/**
|
|
2221
|
+
* Backend ID.
|
|
2222
|
+
*/
|
|
1822
2223
|
backendId: string;
|
|
1823
|
-
/**
|
|
2224
|
+
/**
|
|
2225
|
+
* List of IP addresses to add to backend servers.
|
|
2226
|
+
*/
|
|
1824
2227
|
serverIp: string[];
|
|
1825
2228
|
};
|
|
1826
2229
|
export type ZonedApiAttachPrivateNetworkRequest = {
|
|
1827
|
-
/**
|
|
2230
|
+
/**
|
|
2231
|
+
* Zone to target. If none is passed will use default zone from the config.
|
|
2232
|
+
*/
|
|
1828
2233
|
zone?: ScwZone;
|
|
1829
|
-
/**
|
|
2234
|
+
/**
|
|
2235
|
+
* Load Balancer ID.
|
|
2236
|
+
*/
|
|
1830
2237
|
lbId: string;
|
|
1831
|
-
/**
|
|
2238
|
+
/**
|
|
2239
|
+
* Private Network ID.
|
|
2240
|
+
*/
|
|
1832
2241
|
privateNetworkId: string;
|
|
1833
2242
|
/**
|
|
1834
|
-
* @deprecated Object containing an array of a local IP address for the Load
|
|
1835
|
-
* Balancer on this Private Network.
|
|
2243
|
+
* @deprecated Object containing an array of a local IP address for the Load Balancer on this Private Network.
|
|
1836
2244
|
*
|
|
1837
|
-
*
|
|
1838
|
-
* 'ipamConfig' could be set.
|
|
2245
|
+
* One-of ('config'): at most one of 'staticConfig', 'dhcpConfig', 'ipamConfig' could be set.
|
|
1839
2246
|
*/
|
|
1840
2247
|
staticConfig?: PrivateNetworkStaticConfig;
|
|
1841
2248
|
/**
|
|
1842
2249
|
* @deprecated Defines whether to let DHCP assign IP addresses.
|
|
1843
2250
|
*
|
|
1844
|
-
*
|
|
1845
|
-
* 'ipamConfig' could be set.
|
|
2251
|
+
* One-of ('config'): at most one of 'staticConfig', 'dhcpConfig', 'ipamConfig' could be set.
|
|
1846
2252
|
*/
|
|
1847
2253
|
dhcpConfig?: PrivateNetworkDHCPConfig;
|
|
1848
2254
|
/**
|
|
1849
2255
|
* @deprecated For internal use only.
|
|
1850
2256
|
*
|
|
1851
|
-
*
|
|
1852
|
-
* 'ipamConfig' could be set.
|
|
2257
|
+
* One-of ('config'): at most one of 'staticConfig', 'dhcpConfig', 'ipamConfig' could be set.
|
|
1853
2258
|
*/
|
|
1854
2259
|
ipamConfig?: PrivateNetworkIpamConfig;
|
|
1855
2260
|
/**
|
|
1856
|
-
* IPAM ID of a pre-reserved IP address to assign to the Load Balancer on this
|
|
1857
|
-
* Private Network. In the future, it will be possible to specify multiple IPs
|
|
1858
|
-
* in this field (IPv4 and IPv6), for now only one ID of an IPv4 address is
|
|
1859
|
-
* expected. When null, a new private IP address is created for the Load
|
|
1860
|
-
* Balancer on this Private Network.
|
|
2261
|
+
* IPAM ID of a pre-reserved IP address to assign to the Load Balancer on this Private Network. In the future, it will be possible to specify multiple IPs in this field (IPv4 and IPv6), for now only one ID of an IPv4 address is expected. When null, a new private IP address is created for the Load Balancer on this Private Network.
|
|
1861
2262
|
*/
|
|
1862
2263
|
ipamIds?: string[];
|
|
1863
2264
|
};
|
|
1864
|
-
/**
|
|
2265
|
+
/**
|
|
2266
|
+
* Add an ACL to a Load Balancer frontend.
|
|
2267
|
+
*/
|
|
1865
2268
|
export type ZonedApiCreateAclRequest = {
|
|
1866
|
-
/**
|
|
2269
|
+
/**
|
|
2270
|
+
* Zone to target. If none is passed will use default zone from the config.
|
|
2271
|
+
*/
|
|
1867
2272
|
zone?: ScwZone;
|
|
1868
|
-
/**
|
|
2273
|
+
/**
|
|
2274
|
+
* Frontend ID to attach the ACL to.
|
|
2275
|
+
*/
|
|
1869
2276
|
frontendId: string;
|
|
1870
|
-
/**
|
|
2277
|
+
/**
|
|
2278
|
+
* ACL name.
|
|
2279
|
+
*/
|
|
1871
2280
|
name?: string;
|
|
1872
|
-
/**
|
|
2281
|
+
/**
|
|
2282
|
+
* Action to take when incoming traffic matches an ACL filter.
|
|
2283
|
+
*/
|
|
1873
2284
|
action: AclAction;
|
|
1874
2285
|
/**
|
|
1875
|
-
* ACL match filter object. One of `ip_subnet` or `http_filter` &
|
|
1876
|
-
* `http_filter_value` are required.
|
|
2286
|
+
* ACL match filter object. One of `ip_subnet` or `http_filter` & `http_filter_value` are required.
|
|
1877
2287
|
*/
|
|
1878
2288
|
match?: AclMatch;
|
|
1879
2289
|
/**
|
|
1880
|
-
* Priority of this ACL (ACLs are applied in ascending order, 0 is the first
|
|
1881
|
-
* ACL executed).
|
|
2290
|
+
* Priority of this ACL (ACLs are applied in ascending order, 0 is the first ACL executed).
|
|
1882
2291
|
*/
|
|
1883
2292
|
index: number;
|
|
1884
|
-
/**
|
|
2293
|
+
/**
|
|
2294
|
+
* ACL description.
|
|
2295
|
+
*/
|
|
1885
2296
|
description: string;
|
|
1886
2297
|
};
|
|
1887
2298
|
export type ZonedApiCreateBackendRequest = {
|
|
1888
|
-
/**
|
|
2299
|
+
/**
|
|
2300
|
+
* Zone to target. If none is passed will use default zone from the config.
|
|
2301
|
+
*/
|
|
1889
2302
|
zone?: ScwZone;
|
|
1890
|
-
/**
|
|
2303
|
+
/**
|
|
2304
|
+
* Load Balancer ID.
|
|
2305
|
+
*/
|
|
1891
2306
|
lbId: string;
|
|
1892
|
-
/**
|
|
2307
|
+
/**
|
|
2308
|
+
* Name for the backend.
|
|
2309
|
+
*/
|
|
1893
2310
|
name?: string;
|
|
1894
2311
|
/**
|
|
1895
|
-
* Protocol to be used by the backend when forwarding traffic to backend
|
|
1896
|
-
* servers.
|
|
2312
|
+
* Protocol to be used by the backend when forwarding traffic to backend servers.
|
|
1897
2313
|
*/
|
|
1898
2314
|
forwardProtocol: Protocol;
|
|
1899
|
-
/**
|
|
2315
|
+
/**
|
|
2316
|
+
* Port to be used by the backend when forwarding traffic to backend servers.
|
|
2317
|
+
*/
|
|
1900
2318
|
forwardPort: number;
|
|
1901
2319
|
/**
|
|
1902
|
-
* Load balancing algorithm to be used when determining which backend server
|
|
1903
|
-
* to forward new traffic to.
|
|
2320
|
+
* Load balancing algorithm to be used when determining which backend server to forward new traffic to.
|
|
1904
2321
|
*/
|
|
1905
2322
|
forwardPortAlgorithm: ForwardPortAlgorithm;
|
|
1906
2323
|
/**
|
|
1907
|
-
* Defines whether to activate sticky sessions (binding a particular session
|
|
1908
|
-
* to a particular backend server) and the method to use if so. None disables
|
|
1909
|
-
* sticky sessions. Cookie-based uses an HTTP cookie TO stick a session to a
|
|
1910
|
-
* backend server. Table-based uses the source (client) IP address to stick a
|
|
1911
|
-
* session to a backend server.
|
|
2324
|
+
* Defines whether to activate sticky sessions (binding a particular session to a particular backend server) and the method to use if so. None disables sticky sessions. Cookie-based uses an HTTP cookie TO stick a session to a backend server. Table-based uses the source (client) IP address to stick a session to a backend server.
|
|
1912
2325
|
*/
|
|
1913
2326
|
stickySessions: StickySessionsType;
|
|
1914
|
-
/**
|
|
2327
|
+
/**
|
|
2328
|
+
* Cookie name for cookie-based sticky sessions.
|
|
2329
|
+
*/
|
|
1915
2330
|
stickySessionsCookieName: string;
|
|
1916
2331
|
/**
|
|
1917
|
-
* Object defining the health check to be carried out by the backend when
|
|
1918
|
-
* checking the status and health of backend servers.
|
|
2332
|
+
* Object defining the health check to be carried out by the backend when checking the status and health of backend servers.
|
|
1919
2333
|
*/
|
|
1920
2334
|
healthCheck: HealthCheck;
|
|
1921
2335
|
/**
|
|
1922
|
-
* List of backend server IP addresses (IPv4 or IPv6) the backend should
|
|
1923
|
-
* forward traffic to.
|
|
2336
|
+
* List of backend server IP addresses (IPv4 or IPv6) the backend should forward traffic to.
|
|
1924
2337
|
*/
|
|
1925
2338
|
serverIp: string[];
|
|
1926
|
-
/**
|
|
2339
|
+
/**
|
|
2340
|
+
* @deprecated Deprecated in favor of proxy_protocol field.
|
|
2341
|
+
*/
|
|
1927
2342
|
sendProxyV2?: boolean;
|
|
1928
|
-
/**
|
|
2343
|
+
/**
|
|
2344
|
+
* Maximum allowed time for a backend server to process a request.
|
|
2345
|
+
*/
|
|
1929
2346
|
timeoutServer?: string;
|
|
1930
|
-
/**
|
|
2347
|
+
/**
|
|
2348
|
+
* Maximum allowed time for establishing a connection to a backend server.
|
|
2349
|
+
*/
|
|
1931
2350
|
timeoutConnect?: string;
|
|
1932
2351
|
/**
|
|
1933
|
-
* Maximum allowed tunnel inactivity time after Websocket is established
|
|
1934
|
-
* (takes precedence over client and server timeout).
|
|
2352
|
+
* Maximum allowed tunnel inactivity time after Websocket is established (takes precedence over client and server timeout).
|
|
1935
2353
|
*/
|
|
1936
2354
|
timeoutTunnel?: string;
|
|
1937
|
-
/**
|
|
2355
|
+
/**
|
|
2356
|
+
* Action to take when a backend server is marked as down.
|
|
2357
|
+
*/
|
|
1938
2358
|
onMarkedDownAction?: OnMarkedDownAction;
|
|
1939
2359
|
/**
|
|
1940
|
-
* Protocol to use between the Load Balancer and backend servers. Allows the
|
|
1941
|
-
* backend servers to be informed of the client's real IP address. The PROXY
|
|
1942
|
-
* protocol must be supported by the backend servers' software.
|
|
2360
|
+
* Protocol to use between the Load Balancer and backend servers. Allows the backend servers to be informed of the client's real IP address. The PROXY protocol must be supported by the backend servers' software.
|
|
1943
2361
|
*/
|
|
1944
2362
|
proxyProtocol?: ProxyProtocol;
|
|
1945
2363
|
/**
|
|
1946
|
-
* Scaleway Object Storage bucket website to be served as failover if all
|
|
1947
|
-
* backend servers are down, e.g.
|
|
1948
|
-
* failover-website.s3-website.fr-par.scw.cloud.
|
|
2364
|
+
* Scaleway Object Storage bucket website to be served as failover if all backend servers are down, e.g. failover-website.s3-website.fr-par.scw.cloud.
|
|
1949
2365
|
*/
|
|
1950
2366
|
failoverHost?: string;
|
|
1951
2367
|
/**
|
|
1952
|
-
* Defines whether to enable SSL bridging between the Load Balancer and
|
|
1953
|
-
* backend servers.
|
|
2368
|
+
* Defines whether to enable SSL bridging between the Load Balancer and backend servers.
|
|
1954
2369
|
*/
|
|
1955
2370
|
sslBridging?: boolean;
|
|
1956
|
-
/**
|
|
2371
|
+
/**
|
|
2372
|
+
* Defines whether the server certificate verification should be ignored.
|
|
2373
|
+
*/
|
|
1957
2374
|
ignoreSslServerVerify?: boolean;
|
|
1958
|
-
/**
|
|
2375
|
+
/**
|
|
2376
|
+
* Whether to use another backend server on each attempt.
|
|
2377
|
+
*/
|
|
1959
2378
|
redispatchAttemptCount?: number;
|
|
1960
|
-
/**
|
|
2379
|
+
/**
|
|
2380
|
+
* Number of retries when a backend server connection failed.
|
|
2381
|
+
*/
|
|
1961
2382
|
maxRetries?: number;
|
|
1962
|
-
/**
|
|
2383
|
+
/**
|
|
2384
|
+
* Maximum number of connections allowed per backend server.
|
|
2385
|
+
*/
|
|
1963
2386
|
maxConnections?: number;
|
|
1964
2387
|
/**
|
|
1965
|
-
* Maximum time for a request to be left pending in queue when
|
|
1966
|
-
* `max_connections` is reached.
|
|
2388
|
+
* Maximum time for a request to be left pending in queue when `max_connections` is reached.
|
|
1967
2389
|
*/
|
|
1968
2390
|
timeoutQueue?: string;
|
|
1969
2391
|
};
|
|
1970
2392
|
export type ZonedApiCreateCertificateRequest = {
|
|
1971
|
-
/**
|
|
2393
|
+
/**
|
|
2394
|
+
* Zone to target. If none is passed will use default zone from the config.
|
|
2395
|
+
*/
|
|
1972
2396
|
zone?: ScwZone;
|
|
1973
|
-
/**
|
|
2397
|
+
/**
|
|
2398
|
+
* Load Balancer ID.
|
|
2399
|
+
*/
|
|
1974
2400
|
lbId: string;
|
|
1975
|
-
/**
|
|
2401
|
+
/**
|
|
2402
|
+
* Name for the certificate.
|
|
2403
|
+
*/
|
|
1976
2404
|
name?: string;
|
|
1977
2405
|
/**
|
|
1978
2406
|
* Object to define a new Let's Encrypt certificate to be generated.
|
|
1979
2407
|
*
|
|
1980
|
-
* One-of ('type'): at most one of 'letsencrypt', 'customCertificate' could be
|
|
1981
|
-
* set.
|
|
2408
|
+
* One-of ('type'): at most one of 'letsencrypt', 'customCertificate' could be set.
|
|
1982
2409
|
*/
|
|
1983
2410
|
letsencrypt?: CreateCertificateRequestLetsencryptConfig;
|
|
1984
2411
|
/**
|
|
1985
2412
|
* Object to define an existing custom certificate to be imported.
|
|
1986
2413
|
*
|
|
1987
|
-
* One-of ('type'): at most one of 'letsencrypt', 'customCertificate' could be
|
|
1988
|
-
* set.
|
|
2414
|
+
* One-of ('type'): at most one of 'letsencrypt', 'customCertificate' could be set.
|
|
1989
2415
|
*/
|
|
1990
2416
|
customCertificate?: CreateCertificateRequestCustomCertificate;
|
|
1991
2417
|
};
|
|
1992
2418
|
export type ZonedApiCreateFrontendRequest = {
|
|
1993
|
-
/**
|
|
2419
|
+
/**
|
|
2420
|
+
* Zone to target. If none is passed will use default zone from the config.
|
|
2421
|
+
*/
|
|
1994
2422
|
zone?: ScwZone;
|
|
1995
|
-
/**
|
|
2423
|
+
/**
|
|
2424
|
+
* Load Balancer ID (ID of the Load Balancer to attach the frontend to).
|
|
2425
|
+
*/
|
|
1996
2426
|
lbId: string;
|
|
1997
|
-
/**
|
|
2427
|
+
/**
|
|
2428
|
+
* Name for the frontend.
|
|
2429
|
+
*/
|
|
1998
2430
|
name?: string;
|
|
1999
|
-
/**
|
|
2431
|
+
/**
|
|
2432
|
+
* Port the frontend should listen on.
|
|
2433
|
+
*/
|
|
2000
2434
|
inboundPort: number;
|
|
2001
|
-
/**
|
|
2435
|
+
/**
|
|
2436
|
+
* Backend ID (ID of the backend the frontend should pass traffic to).
|
|
2437
|
+
*/
|
|
2002
2438
|
backendId: string;
|
|
2003
|
-
/**
|
|
2439
|
+
/**
|
|
2440
|
+
* Maximum allowed inactivity time on the client side.
|
|
2441
|
+
*/
|
|
2004
2442
|
timeoutClient?: string;
|
|
2005
|
-
/**
|
|
2443
|
+
/**
|
|
2444
|
+
* @deprecated Certificate ID, deprecated in favor of certificate_ids array.
|
|
2445
|
+
*/
|
|
2006
2446
|
certificateId?: string;
|
|
2007
|
-
/**
|
|
2447
|
+
/**
|
|
2448
|
+
* List of SSL/TLS certificate IDs to bind to the frontend.
|
|
2449
|
+
*/
|
|
2008
2450
|
certificateIds?: string[];
|
|
2009
|
-
/**
|
|
2451
|
+
/**
|
|
2452
|
+
* Defines whether to enable HTTP/3 protocol on the frontend.
|
|
2453
|
+
*/
|
|
2010
2454
|
enableHttp3: boolean;
|
|
2011
2455
|
/**
|
|
2012
|
-
* Rate limit for new connections established on this frontend. Use 0 value to
|
|
2013
|
-
* disable, else value is connections per second.
|
|
2456
|
+
* Rate limit for new connections established on this frontend. Use 0 value to disable, else value is connections per second.
|
|
2014
2457
|
*/
|
|
2015
2458
|
connectionRateLimit?: number;
|
|
2016
2459
|
};
|
|
2017
2460
|
export type ZonedApiCreateIpRequest = {
|
|
2018
|
-
/**
|
|
2461
|
+
/**
|
|
2462
|
+
* Zone to target. If none is passed will use default zone from the config.
|
|
2463
|
+
*/
|
|
2019
2464
|
zone?: ScwZone;
|
|
2020
2465
|
/**
|
|
2021
|
-
* @deprecated Organization ID of the Organization where the IP address should
|
|
2022
|
-
* be created.
|
|
2466
|
+
* @deprecated Organization ID of the Organization where the IP address should be created.
|
|
2023
2467
|
*
|
|
2024
|
-
*
|
|
2025
|
-
* could be set.
|
|
2468
|
+
* One-of ('projectIdentifier'): at most one of 'projectId', 'organizationId' could be set.
|
|
2026
2469
|
*/
|
|
2027
2470
|
organizationId?: string;
|
|
2028
2471
|
/**
|
|
2029
2472
|
* Project ID of the Project where the IP address should be created.
|
|
2030
2473
|
*
|
|
2031
|
-
* One-of ('projectIdentifier'): at most one of 'projectId', 'organizationId'
|
|
2032
|
-
* could be set.
|
|
2474
|
+
* One-of ('projectIdentifier'): at most one of 'projectId', 'organizationId' could be set.
|
|
2033
2475
|
*/
|
|
2034
2476
|
projectId?: string;
|
|
2035
|
-
/**
|
|
2477
|
+
/**
|
|
2478
|
+
* Reverse DNS (domain name) for the IP address.
|
|
2479
|
+
*/
|
|
2036
2480
|
reverse?: string;
|
|
2037
|
-
/**
|
|
2481
|
+
/**
|
|
2482
|
+
* If true, creates a Flexible IP with an ipv6 address.
|
|
2483
|
+
*/
|
|
2038
2484
|
isIpv6: boolean;
|
|
2039
|
-
/**
|
|
2485
|
+
/**
|
|
2486
|
+
* List of tags for the IP.
|
|
2487
|
+
*/
|
|
2040
2488
|
tags?: string[];
|
|
2041
2489
|
};
|
|
2042
2490
|
export type ZonedApiCreateLbRequest = {
|
|
2043
|
-
/**
|
|
2491
|
+
/**
|
|
2492
|
+
* Zone to target. If none is passed will use default zone from the config.
|
|
2493
|
+
*/
|
|
2044
2494
|
zone?: ScwZone;
|
|
2045
2495
|
/**
|
|
2046
2496
|
* @deprecated Scaleway Organization to create the Load Balancer in.
|
|
2047
2497
|
*
|
|
2048
|
-
*
|
|
2049
|
-
* could be set.
|
|
2498
|
+
* One-of ('projectIdentifier'): at most one of 'projectId', 'organizationId' could be set.
|
|
2050
2499
|
*/
|
|
2051
2500
|
organizationId?: string;
|
|
2052
2501
|
/**
|
|
2053
2502
|
* Scaleway Project to create the Load Balancer in.
|
|
2054
2503
|
*
|
|
2055
|
-
* One-of ('projectIdentifier'): at most one of 'projectId', 'organizationId'
|
|
2056
|
-
* could be set.
|
|
2504
|
+
* One-of ('projectIdentifier'): at most one of 'projectId', 'organizationId' could be set.
|
|
2057
2505
|
*/
|
|
2058
2506
|
projectId?: string;
|
|
2059
|
-
/**
|
|
2507
|
+
/**
|
|
2508
|
+
* Name for the Load Balancer.
|
|
2509
|
+
*/
|
|
2060
2510
|
name?: string;
|
|
2061
|
-
/**
|
|
2511
|
+
/**
|
|
2512
|
+
* Description for the Load Balancer.
|
|
2513
|
+
*/
|
|
2062
2514
|
description: string;
|
|
2063
2515
|
/**
|
|
2064
|
-
* @deprecated ID of an existing flexible IP address to attach to the Load
|
|
2065
|
-
* Balancer.
|
|
2516
|
+
* @deprecated ID of an existing flexible IP address to attach to the Load Balancer.
|
|
2066
2517
|
*/
|
|
2067
2518
|
ipId?: string;
|
|
2068
2519
|
/**
|
|
2069
|
-
* Defines whether to automatically assign a flexible public IP to the Load
|
|
2070
|
-
* Balancer. Default value is `true` (assign).
|
|
2520
|
+
* Defines whether to automatically assign a flexible public IP to the Load Balancer. Default value is `true` (assign).
|
|
2071
2521
|
*/
|
|
2072
2522
|
assignFlexibleIp?: boolean;
|
|
2073
2523
|
/**
|
|
2074
|
-
* Defines whether to automatically assign a flexible public IPv6 to the Load
|
|
2075
|
-
* Balancer. Default value is `false` (do not assign).
|
|
2524
|
+
* Defines whether to automatically assign a flexible public IPv6 to the Load Balancer. Default value is `false` (do not assign).
|
|
2076
2525
|
*/
|
|
2077
2526
|
assignFlexibleIpv6?: boolean;
|
|
2078
|
-
/**
|
|
2527
|
+
/**
|
|
2528
|
+
* List of IP IDs to attach to the Load Balancer.
|
|
2529
|
+
*/
|
|
2079
2530
|
ipIds?: string[];
|
|
2080
|
-
/**
|
|
2531
|
+
/**
|
|
2532
|
+
* List of tags for the Load Balancer.
|
|
2533
|
+
*/
|
|
2081
2534
|
tags?: string[];
|
|
2082
2535
|
/**
|
|
2083
|
-
* Load Balancer commercial offer type. Use the Load Balancer types endpoint
|
|
2084
|
-
* to retrieve a list of available offer types.
|
|
2536
|
+
* Load Balancer commercial offer type. Use the Load Balancer types endpoint to retrieve a list of available offer types.
|
|
2085
2537
|
*/
|
|
2086
2538
|
type: string;
|
|
2087
2539
|
/**
|
|
2088
|
-
* Determines the minimal SSL version which needs to be supported on the
|
|
2089
|
-
* client side, in an SSL/TLS offloading context. Intermediate is suitable for
|
|
2090
|
-
* general-purpose servers with a variety of clients, recommended for almost
|
|
2091
|
-
* all systems. Modern is suitable for services with clients that support TLS
|
|
2092
|
-
* 1.3 and do not need backward compatibility. Old is compatible with a small
|
|
2093
|
-
* number of very old clients and should be used only as a last resort.
|
|
2540
|
+
* Determines the minimal SSL version which needs to be supported on the client side, in an SSL/TLS offloading context. Intermediate is suitable for general-purpose servers with a variety of clients, recommended for almost all systems. Modern is suitable for services with clients that support TLS 1.3 and do not need backward compatibility. Old is compatible with a small number of very old clients and should be used only as a last resort.
|
|
2094
2541
|
*/
|
|
2095
2542
|
sslCompatibilityLevel?: SSLCompatibilityLevel;
|
|
2096
2543
|
};
|
|
2097
2544
|
export type ZonedApiCreateRouteRequest = {
|
|
2098
|
-
/**
|
|
2545
|
+
/**
|
|
2546
|
+
* Zone to target. If none is passed will use default zone from the config.
|
|
2547
|
+
*/
|
|
2099
2548
|
zone?: ScwZone;
|
|
2100
|
-
/**
|
|
2549
|
+
/**
|
|
2550
|
+
* ID of the source frontend to create the route on.
|
|
2551
|
+
*/
|
|
2101
2552
|
frontendId: string;
|
|
2102
|
-
/**
|
|
2553
|
+
/**
|
|
2554
|
+
* ID of the target backend for the route.
|
|
2555
|
+
*/
|
|
2103
2556
|
backendId: string;
|
|
2104
2557
|
/**
|
|
2105
|
-
* Object defining the match condition for a route to be applied. If an
|
|
2106
|
-
* incoming client session matches the specified condition (i.e. it has a
|
|
2107
|
-
* matching SNI value or HTTP Host header value), it will be passed to the
|
|
2108
|
-
* target backend.
|
|
2558
|
+
* Object defining the match condition for a route to be applied. If an incoming client session matches the specified condition (i.e. it has a matching SNI value or HTTP Host header value), it will be passed to the target backend.
|
|
2109
2559
|
*/
|
|
2110
2560
|
match?: RouteMatch;
|
|
2111
2561
|
};
|
|
2112
|
-
/**
|
|
2562
|
+
/**
|
|
2563
|
+
* Create a new alert subscriber (webhook or email).
|
|
2564
|
+
*/
|
|
2113
2565
|
export type ZonedApiCreateSubscriberRequest = {
|
|
2114
|
-
/**
|
|
2566
|
+
/**
|
|
2567
|
+
* Zone to target. If none is passed will use default zone from the config.
|
|
2568
|
+
*/
|
|
2115
2569
|
zone?: ScwZone;
|
|
2116
|
-
/**
|
|
2570
|
+
/**
|
|
2571
|
+
* Subscriber name.
|
|
2572
|
+
*/
|
|
2117
2573
|
name: string;
|
|
2118
2574
|
/**
|
|
2119
2575
|
* Email address configuration.
|
|
2120
2576
|
*
|
|
2121
|
-
* One-of ('config'): at most one of 'emailConfig', 'webhookConfig' could be
|
|
2122
|
-
* set.
|
|
2577
|
+
* One-of ('config'): at most one of 'emailConfig', 'webhookConfig' could be set.
|
|
2123
2578
|
*/
|
|
2124
2579
|
emailConfig?: SubscriberEmailConfig;
|
|
2125
2580
|
/**
|
|
2126
2581
|
* WebHook URI configuration.
|
|
2127
2582
|
*
|
|
2128
|
-
* One-of ('config'): at most one of 'emailConfig', 'webhookConfig' could be
|
|
2129
|
-
* set.
|
|
2583
|
+
* One-of ('config'): at most one of 'emailConfig', 'webhookConfig' could be set.
|
|
2130
2584
|
*/
|
|
2131
2585
|
webhookConfig?: SubscriberWebhookConfig;
|
|
2132
2586
|
/**
|
|
2133
2587
|
* @deprecated Organization ID to create the subscriber in.
|
|
2134
2588
|
*
|
|
2135
|
-
*
|
|
2136
|
-
* could be set.
|
|
2589
|
+
* One-of ('projectIdentifier'): at most one of 'projectId', 'organizationId' could be set.
|
|
2137
2590
|
*/
|
|
2138
2591
|
organizationId?: string;
|
|
2139
2592
|
/**
|
|
2140
2593
|
* Project ID to create the subscriber in.
|
|
2141
2594
|
*
|
|
2142
|
-
* One-of ('projectIdentifier'): at most one of 'projectId', 'organizationId'
|
|
2143
|
-
* could be set.
|
|
2595
|
+
* One-of ('projectIdentifier'): at most one of 'projectId', 'organizationId' could be set.
|
|
2144
2596
|
*/
|
|
2145
2597
|
projectId?: string;
|
|
2146
2598
|
};
|
|
2147
2599
|
export type ZonedApiDeleteAclRequest = {
|
|
2148
|
-
/**
|
|
2600
|
+
/**
|
|
2601
|
+
* Zone to target. If none is passed will use default zone from the config.
|
|
2602
|
+
*/
|
|
2149
2603
|
zone?: ScwZone;
|
|
2150
|
-
/**
|
|
2604
|
+
/**
|
|
2605
|
+
* ACL ID.
|
|
2606
|
+
*/
|
|
2151
2607
|
aclId: string;
|
|
2152
2608
|
};
|
|
2153
2609
|
export type ZonedApiDeleteBackendRequest = {
|
|
2154
|
-
/**
|
|
2610
|
+
/**
|
|
2611
|
+
* Zone to target. If none is passed will use default zone from the config.
|
|
2612
|
+
*/
|
|
2155
2613
|
zone?: ScwZone;
|
|
2156
|
-
/**
|
|
2614
|
+
/**
|
|
2615
|
+
* ID of the backend to delete.
|
|
2616
|
+
*/
|
|
2157
2617
|
backendId: string;
|
|
2158
2618
|
};
|
|
2159
2619
|
export type ZonedApiDeleteCertificateRequest = {
|
|
2160
|
-
/**
|
|
2620
|
+
/**
|
|
2621
|
+
* Zone to target. If none is passed will use default zone from the config.
|
|
2622
|
+
*/
|
|
2161
2623
|
zone?: ScwZone;
|
|
2162
|
-
/**
|
|
2624
|
+
/**
|
|
2625
|
+
* Certificate ID.
|
|
2626
|
+
*/
|
|
2163
2627
|
certificateId: string;
|
|
2164
2628
|
};
|
|
2165
2629
|
export type ZonedApiDeleteFrontendRequest = {
|
|
2166
|
-
/**
|
|
2630
|
+
/**
|
|
2631
|
+
* Zone to target. If none is passed will use default zone from the config.
|
|
2632
|
+
*/
|
|
2167
2633
|
zone?: ScwZone;
|
|
2168
|
-
/**
|
|
2634
|
+
/**
|
|
2635
|
+
* ID of the frontend to delete.
|
|
2636
|
+
*/
|
|
2169
2637
|
frontendId: string;
|
|
2170
2638
|
};
|
|
2171
2639
|
export type ZonedApiDeleteLbRequest = {
|
|
2172
|
-
/**
|
|
2640
|
+
/**
|
|
2641
|
+
* Zone to target. If none is passed will use default zone from the config.
|
|
2642
|
+
*/
|
|
2173
2643
|
zone?: ScwZone;
|
|
2174
|
-
/**
|
|
2644
|
+
/**
|
|
2645
|
+
* ID of the Load Balancer to delete.
|
|
2646
|
+
*/
|
|
2175
2647
|
lbId: string;
|
|
2176
2648
|
/**
|
|
2177
|
-
* Defines whether the Load Balancer's flexible IP should be deleted. Set to
|
|
2178
|
-
* true to release the flexible IP, or false to keep it available in your
|
|
2179
|
-
* account for future Load Balancers.
|
|
2649
|
+
* Defines whether the Load Balancer's flexible IP should be deleted. Set to true to release the flexible IP, or false to keep it available in your account for future Load Balancers.
|
|
2180
2650
|
*/
|
|
2181
2651
|
releaseIp: boolean;
|
|
2182
2652
|
};
|
|
2183
2653
|
export type ZonedApiDeleteRouteRequest = {
|
|
2184
|
-
/**
|
|
2654
|
+
/**
|
|
2655
|
+
* Zone to target. If none is passed will use default zone from the config.
|
|
2656
|
+
*/
|
|
2185
2657
|
zone?: ScwZone;
|
|
2186
|
-
/**
|
|
2658
|
+
/**
|
|
2659
|
+
* Route ID.
|
|
2660
|
+
*/
|
|
2187
2661
|
routeId: string;
|
|
2188
2662
|
};
|
|
2189
2663
|
export type ZonedApiDeleteSubscriberRequest = {
|
|
2190
|
-
/**
|
|
2664
|
+
/**
|
|
2665
|
+
* Zone to target. If none is passed will use default zone from the config.
|
|
2666
|
+
*/
|
|
2191
2667
|
zone?: ScwZone;
|
|
2192
|
-
/**
|
|
2668
|
+
/**
|
|
2669
|
+
* Subscriber ID.
|
|
2670
|
+
*/
|
|
2193
2671
|
subscriberId: string;
|
|
2194
2672
|
};
|
|
2195
2673
|
export type ZonedApiDetachPrivateNetworkRequest = {
|
|
2196
|
-
/**
|
|
2674
|
+
/**
|
|
2675
|
+
* Zone to target. If none is passed will use default zone from the config.
|
|
2676
|
+
*/
|
|
2197
2677
|
zone?: ScwZone;
|
|
2198
|
-
/**
|
|
2678
|
+
/**
|
|
2679
|
+
* Load balancer ID.
|
|
2680
|
+
*/
|
|
2199
2681
|
lbId: string;
|
|
2200
|
-
/**
|
|
2682
|
+
/**
|
|
2683
|
+
* Set your instance private network id.
|
|
2684
|
+
*/
|
|
2201
2685
|
privateNetworkId: string;
|
|
2202
2686
|
};
|
|
2203
2687
|
export type ZonedApiGetAclRequest = {
|
|
2204
|
-
/**
|
|
2688
|
+
/**
|
|
2689
|
+
* Zone to target. If none is passed will use default zone from the config.
|
|
2690
|
+
*/
|
|
2205
2691
|
zone?: ScwZone;
|
|
2206
|
-
/**
|
|
2692
|
+
/**
|
|
2693
|
+
* ACL ID.
|
|
2694
|
+
*/
|
|
2207
2695
|
aclId: string;
|
|
2208
2696
|
};
|
|
2209
2697
|
export type ZonedApiGetBackendRequest = {
|
|
2210
|
-
/**
|
|
2698
|
+
/**
|
|
2699
|
+
* Zone to target. If none is passed will use default zone from the config.
|
|
2700
|
+
*/
|
|
2211
2701
|
zone?: ScwZone;
|
|
2212
|
-
/**
|
|
2702
|
+
/**
|
|
2703
|
+
* Backend ID.
|
|
2704
|
+
*/
|
|
2213
2705
|
backendId: string;
|
|
2214
2706
|
};
|
|
2215
2707
|
export type ZonedApiGetCertificateRequest = {
|
|
2216
|
-
/**
|
|
2708
|
+
/**
|
|
2709
|
+
* Zone to target. If none is passed will use default zone from the config.
|
|
2710
|
+
*/
|
|
2217
2711
|
zone?: ScwZone;
|
|
2218
|
-
/**
|
|
2712
|
+
/**
|
|
2713
|
+
* Certificate ID.
|
|
2714
|
+
*/
|
|
2219
2715
|
certificateId: string;
|
|
2220
2716
|
};
|
|
2221
2717
|
export type ZonedApiGetFrontendRequest = {
|
|
2222
|
-
/**
|
|
2718
|
+
/**
|
|
2719
|
+
* Zone to target. If none is passed will use default zone from the config.
|
|
2720
|
+
*/
|
|
2223
2721
|
zone?: ScwZone;
|
|
2224
|
-
/**
|
|
2722
|
+
/**
|
|
2723
|
+
* Frontend ID.
|
|
2724
|
+
*/
|
|
2225
2725
|
frontendId: string;
|
|
2226
2726
|
};
|
|
2227
2727
|
export type ZonedApiGetIpRequest = {
|
|
2228
|
-
/**
|
|
2728
|
+
/**
|
|
2729
|
+
* Zone to target. If none is passed will use default zone from the config.
|
|
2730
|
+
*/
|
|
2229
2731
|
zone?: ScwZone;
|
|
2230
|
-
/**
|
|
2732
|
+
/**
|
|
2733
|
+
* IP address ID.
|
|
2734
|
+
*/
|
|
2231
2735
|
ipId: string;
|
|
2232
2736
|
};
|
|
2233
2737
|
export type ZonedApiGetLbRequest = {
|
|
2234
|
-
/**
|
|
2738
|
+
/**
|
|
2739
|
+
* Zone to target. If none is passed will use default zone from the config.
|
|
2740
|
+
*/
|
|
2235
2741
|
zone?: ScwZone;
|
|
2236
|
-
/**
|
|
2742
|
+
/**
|
|
2743
|
+
* Load Balancer ID.
|
|
2744
|
+
*/
|
|
2237
2745
|
lbId: string;
|
|
2238
2746
|
};
|
|
2239
|
-
/**
|
|
2747
|
+
/**
|
|
2748
|
+
* Get Load Balancer stats.
|
|
2749
|
+
*/
|
|
2240
2750
|
export type ZonedApiGetLbStatsRequest = {
|
|
2241
|
-
/**
|
|
2751
|
+
/**
|
|
2752
|
+
* Zone to target. If none is passed will use default zone from the config.
|
|
2753
|
+
*/
|
|
2242
2754
|
zone?: ScwZone;
|
|
2243
|
-
/**
|
|
2755
|
+
/**
|
|
2756
|
+
* Load Balancer ID.
|
|
2757
|
+
*/
|
|
2244
2758
|
lbId: string;
|
|
2245
|
-
/**
|
|
2759
|
+
/**
|
|
2760
|
+
* ID of the backend.
|
|
2761
|
+
*/
|
|
2246
2762
|
backendId?: string;
|
|
2247
2763
|
};
|
|
2248
2764
|
export type ZonedApiGetRouteRequest = {
|
|
2249
|
-
/**
|
|
2765
|
+
/**
|
|
2766
|
+
* Zone to target. If none is passed will use default zone from the config.
|
|
2767
|
+
*/
|
|
2250
2768
|
zone?: ScwZone;
|
|
2251
|
-
/**
|
|
2769
|
+
/**
|
|
2770
|
+
* Route ID.
|
|
2771
|
+
*/
|
|
2252
2772
|
routeId: string;
|
|
2253
2773
|
};
|
|
2254
2774
|
export type ZonedApiGetSubscriberRequest = {
|
|
2255
|
-
/**
|
|
2775
|
+
/**
|
|
2776
|
+
* Zone to target. If none is passed will use default zone from the config.
|
|
2777
|
+
*/
|
|
2256
2778
|
zone?: ScwZone;
|
|
2257
|
-
/**
|
|
2779
|
+
/**
|
|
2780
|
+
* Subscriber ID.
|
|
2781
|
+
*/
|
|
2258
2782
|
subscriberId: string;
|
|
2259
2783
|
};
|
|
2260
2784
|
export type ZonedApiListAclsRequest = {
|
|
2261
|
-
/**
|
|
2785
|
+
/**
|
|
2786
|
+
* Zone to target. If none is passed will use default zone from the config.
|
|
2787
|
+
*/
|
|
2262
2788
|
zone?: ScwZone;
|
|
2263
2789
|
/**
|
|
2264
|
-
* Frontend ID (ACLs attached to this frontend will be returned in the
|
|
2265
|
-
* response).
|
|
2790
|
+
* Frontend ID (ACLs attached to this frontend will be returned in the response).
|
|
2266
2791
|
*/
|
|
2267
2792
|
frontendId: string;
|
|
2268
|
-
/**
|
|
2793
|
+
/**
|
|
2794
|
+
* Sort order of ACLs in the response.
|
|
2795
|
+
*/
|
|
2269
2796
|
orderBy?: ListAclRequestOrderBy;
|
|
2270
|
-
/**
|
|
2797
|
+
/**
|
|
2798
|
+
* The page number to return, from the paginated results.
|
|
2799
|
+
*/
|
|
2271
2800
|
page?: number;
|
|
2272
|
-
/**
|
|
2801
|
+
/**
|
|
2802
|
+
* The number of ACLs to return.
|
|
2803
|
+
*/
|
|
2273
2804
|
pageSize?: number;
|
|
2274
|
-
/**
|
|
2805
|
+
/**
|
|
2806
|
+
* ACL name to filter for.
|
|
2807
|
+
*/
|
|
2275
2808
|
name?: string;
|
|
2276
2809
|
};
|
|
2277
2810
|
export type ZonedApiListBackendStatsRequest = {
|
|
2278
|
-
/**
|
|
2811
|
+
/**
|
|
2812
|
+
* Zone to target. If none is passed will use default zone from the config.
|
|
2813
|
+
*/
|
|
2279
2814
|
zone?: ScwZone;
|
|
2280
|
-
/**
|
|
2815
|
+
/**
|
|
2816
|
+
* Load Balancer ID.
|
|
2817
|
+
*/
|
|
2281
2818
|
lbId: string;
|
|
2282
|
-
/**
|
|
2819
|
+
/**
|
|
2820
|
+
* The page number to return, from the paginated results.
|
|
2821
|
+
*/
|
|
2283
2822
|
page?: number;
|
|
2284
|
-
/**
|
|
2823
|
+
/**
|
|
2824
|
+
* Number of items to return.
|
|
2825
|
+
*/
|
|
2285
2826
|
pageSize?: number;
|
|
2286
|
-
/**
|
|
2827
|
+
/**
|
|
2828
|
+
* ID of the backend.
|
|
2829
|
+
*/
|
|
2287
2830
|
backendId?: string;
|
|
2288
2831
|
};
|
|
2289
2832
|
export type ZonedApiListBackendsRequest = {
|
|
2290
|
-
/**
|
|
2833
|
+
/**
|
|
2834
|
+
* Zone to target. If none is passed will use default zone from the config.
|
|
2835
|
+
*/
|
|
2291
2836
|
zone?: ScwZone;
|
|
2292
|
-
/**
|
|
2837
|
+
/**
|
|
2838
|
+
* Load Balancer ID.
|
|
2839
|
+
*/
|
|
2293
2840
|
lbId: string;
|
|
2294
|
-
/**
|
|
2841
|
+
/**
|
|
2842
|
+
* Name of the backend to filter for.
|
|
2843
|
+
*/
|
|
2295
2844
|
name?: string;
|
|
2296
|
-
/**
|
|
2845
|
+
/**
|
|
2846
|
+
* Sort order of backends in the response.
|
|
2847
|
+
*/
|
|
2297
2848
|
orderBy?: ListBackendsRequestOrderBy;
|
|
2298
|
-
/**
|
|
2849
|
+
/**
|
|
2850
|
+
* The page number to return, from the paginated results.
|
|
2851
|
+
*/
|
|
2299
2852
|
page?: number;
|
|
2300
|
-
/**
|
|
2853
|
+
/**
|
|
2854
|
+
* Number of backends to return.
|
|
2855
|
+
*/
|
|
2301
2856
|
pageSize?: number;
|
|
2302
2857
|
};
|
|
2303
2858
|
export type ZonedApiListCertificatesRequest = {
|
|
2304
|
-
/**
|
|
2859
|
+
/**
|
|
2860
|
+
* Zone to target. If none is passed will use default zone from the config.
|
|
2861
|
+
*/
|
|
2305
2862
|
zone?: ScwZone;
|
|
2306
|
-
/**
|
|
2863
|
+
/**
|
|
2864
|
+
* Load Balancer ID.
|
|
2865
|
+
*/
|
|
2307
2866
|
lbId: string;
|
|
2308
|
-
/**
|
|
2867
|
+
/**
|
|
2868
|
+
* Sort order of certificates in the response.
|
|
2869
|
+
*/
|
|
2309
2870
|
orderBy?: ListCertificatesRequestOrderBy;
|
|
2310
|
-
/**
|
|
2871
|
+
/**
|
|
2872
|
+
* The page number to return, from the paginated results.
|
|
2873
|
+
*/
|
|
2311
2874
|
page?: number;
|
|
2312
|
-
/**
|
|
2875
|
+
/**
|
|
2876
|
+
* Number of certificates to return.
|
|
2877
|
+
*/
|
|
2313
2878
|
pageSize?: number;
|
|
2314
2879
|
/**
|
|
2315
|
-
* Certificate name to filter for, only certificates of this name will be
|
|
2316
|
-
* returned.
|
|
2880
|
+
* Certificate name to filter for, only certificates of this name will be returned.
|
|
2317
2881
|
*/
|
|
2318
2882
|
name?: string;
|
|
2319
2883
|
};
|
|
2320
2884
|
export type ZonedApiListFrontendsRequest = {
|
|
2321
|
-
/**
|
|
2885
|
+
/**
|
|
2886
|
+
* Zone to target. If none is passed will use default zone from the config.
|
|
2887
|
+
*/
|
|
2322
2888
|
zone?: ScwZone;
|
|
2323
|
-
/**
|
|
2889
|
+
/**
|
|
2890
|
+
* Load Balancer ID.
|
|
2891
|
+
*/
|
|
2324
2892
|
lbId: string;
|
|
2325
|
-
/**
|
|
2893
|
+
/**
|
|
2894
|
+
* Name of the frontend to filter for.
|
|
2895
|
+
*/
|
|
2326
2896
|
name?: string;
|
|
2327
|
-
/**
|
|
2897
|
+
/**
|
|
2898
|
+
* Sort order of frontends in the response.
|
|
2899
|
+
*/
|
|
2328
2900
|
orderBy?: ListFrontendsRequestOrderBy;
|
|
2329
|
-
/**
|
|
2901
|
+
/**
|
|
2902
|
+
* The page number to return, from the paginated results.
|
|
2903
|
+
*/
|
|
2330
2904
|
page?: number;
|
|
2331
|
-
/**
|
|
2905
|
+
/**
|
|
2906
|
+
* Number of frontends to return.
|
|
2907
|
+
*/
|
|
2332
2908
|
pageSize?: number;
|
|
2333
2909
|
};
|
|
2334
2910
|
export type ZonedApiListIPsRequest = {
|
|
2335
|
-
/**
|
|
2911
|
+
/**
|
|
2912
|
+
* Zone to target. If none is passed will use default zone from the config.
|
|
2913
|
+
*/
|
|
2336
2914
|
zone?: ScwZone;
|
|
2337
|
-
/**
|
|
2915
|
+
/**
|
|
2916
|
+
* The page number to return, from the paginated results.
|
|
2917
|
+
*/
|
|
2338
2918
|
page?: number;
|
|
2339
|
-
/**
|
|
2919
|
+
/**
|
|
2920
|
+
* Number of IP addresses to return.
|
|
2921
|
+
*/
|
|
2340
2922
|
pageSize?: number;
|
|
2341
|
-
/**
|
|
2923
|
+
/**
|
|
2924
|
+
* IP address to filter for.
|
|
2925
|
+
*/
|
|
2342
2926
|
ipAddress?: string;
|
|
2343
2927
|
/**
|
|
2344
|
-
* Organization ID to filter for, only Load Balancer IP addresses from this
|
|
2345
|
-
* Organization will be returned.
|
|
2928
|
+
* Organization ID to filter for, only Load Balancer IP addresses from this Organization will be returned.
|
|
2346
2929
|
*/
|
|
2347
2930
|
organizationId?: string;
|
|
2348
2931
|
/**
|
|
2349
|
-
* Project ID to filter for, only Load Balancer IP addresses from this Project
|
|
2350
|
-
* will be returned.
|
|
2932
|
+
* Project ID to filter for, only Load Balancer IP addresses from this Project will be returned.
|
|
2351
2933
|
*/
|
|
2352
2934
|
projectId?: string;
|
|
2353
|
-
/**
|
|
2935
|
+
/**
|
|
2936
|
+
* IP type to filter for.
|
|
2937
|
+
*/
|
|
2354
2938
|
ipType?: ListIpsRequestIpType;
|
|
2355
2939
|
/**
|
|
2356
|
-
* Tag to filter for, only IPs with one or more matching tags will be
|
|
2357
|
-
* returned.
|
|
2940
|
+
* Tag to filter for, only IPs with one or more matching tags will be returned.
|
|
2358
2941
|
*/
|
|
2359
2942
|
tags?: string[];
|
|
2360
2943
|
};
|
|
2361
2944
|
export type ZonedApiListLbPrivateNetworksRequest = {
|
|
2362
|
-
/**
|
|
2945
|
+
/**
|
|
2946
|
+
* Zone to target. If none is passed will use default zone from the config.
|
|
2947
|
+
*/
|
|
2363
2948
|
zone?: ScwZone;
|
|
2364
|
-
/**
|
|
2949
|
+
/**
|
|
2950
|
+
* Load Balancer ID.
|
|
2951
|
+
*/
|
|
2365
2952
|
lbId: string;
|
|
2366
|
-
/**
|
|
2953
|
+
/**
|
|
2954
|
+
* Sort order of Private Network objects in the response.
|
|
2955
|
+
*/
|
|
2367
2956
|
orderBy?: ListPrivateNetworksRequestOrderBy;
|
|
2368
|
-
/**
|
|
2957
|
+
/**
|
|
2958
|
+
* Number of objects to return.
|
|
2959
|
+
*/
|
|
2369
2960
|
pageSize?: number;
|
|
2370
|
-
/**
|
|
2961
|
+
/**
|
|
2962
|
+
* The page number to return, from the paginated results.
|
|
2963
|
+
*/
|
|
2371
2964
|
page?: number;
|
|
2372
2965
|
};
|
|
2373
2966
|
export type ZonedApiListLbTypesRequest = {
|
|
2374
|
-
/**
|
|
2967
|
+
/**
|
|
2968
|
+
* Zone to target. If none is passed will use default zone from the config.
|
|
2969
|
+
*/
|
|
2375
2970
|
zone?: ScwZone;
|
|
2376
|
-
/**
|
|
2971
|
+
/**
|
|
2972
|
+
* The page number to return, from the paginated results.
|
|
2973
|
+
*/
|
|
2377
2974
|
page?: number;
|
|
2378
|
-
/**
|
|
2975
|
+
/**
|
|
2976
|
+
* The number of items to return.
|
|
2977
|
+
*/
|
|
2379
2978
|
pageSize?: number;
|
|
2380
2979
|
};
|
|
2381
2980
|
export type ZonedApiListLbsRequest = {
|
|
2382
|
-
/**
|
|
2981
|
+
/**
|
|
2982
|
+
* Zone to target. If none is passed will use default zone from the config.
|
|
2983
|
+
*/
|
|
2383
2984
|
zone?: ScwZone;
|
|
2384
|
-
/**
|
|
2985
|
+
/**
|
|
2986
|
+
* Load Balancer name to filter for.
|
|
2987
|
+
*/
|
|
2385
2988
|
name?: string;
|
|
2386
|
-
/**
|
|
2989
|
+
/**
|
|
2990
|
+
* Sort order of Load Balancers in the response.
|
|
2991
|
+
*/
|
|
2387
2992
|
orderBy?: ListLbsRequestOrderBy;
|
|
2388
|
-
/**
|
|
2993
|
+
/**
|
|
2994
|
+
* Number of Load Balancers to return.
|
|
2995
|
+
*/
|
|
2389
2996
|
pageSize?: number;
|
|
2390
|
-
/**
|
|
2997
|
+
/**
|
|
2998
|
+
* Page number to return, from the paginated results.
|
|
2999
|
+
*/
|
|
2391
3000
|
page?: number;
|
|
2392
3001
|
/**
|
|
2393
|
-
* Organization ID to filter for, only Load Balancers from this Organization
|
|
2394
|
-
* will be returned.
|
|
3002
|
+
* Organization ID to filter for, only Load Balancers from this Organization will be returned.
|
|
2395
3003
|
*/
|
|
2396
3004
|
organizationId?: string;
|
|
2397
3005
|
/**
|
|
2398
|
-
* Project ID to filter for, only Load Balancers from this Project will be
|
|
2399
|
-
* returned.
|
|
3006
|
+
* Project ID to filter for, only Load Balancers from this Project will be returned.
|
|
2400
3007
|
*/
|
|
2401
3008
|
projectId?: string;
|
|
2402
3009
|
/**
|
|
2403
|
-
* Filter by tag, only Load Balancers with one or more matching tags will be
|
|
2404
|
-
* returned.
|
|
3010
|
+
* Filter by tag, only Load Balancers with one or more matching tags will be returned.
|
|
2405
3011
|
*/
|
|
2406
3012
|
tags?: string[];
|
|
2407
3013
|
};
|
|
2408
3014
|
export type ZonedApiListRoutesRequest = {
|
|
2409
|
-
/**
|
|
3015
|
+
/**
|
|
3016
|
+
* Zone to target. If none is passed will use default zone from the config.
|
|
3017
|
+
*/
|
|
2410
3018
|
zone?: ScwZone;
|
|
2411
|
-
/**
|
|
3019
|
+
/**
|
|
3020
|
+
* Sort order of routes in the response.
|
|
3021
|
+
*/
|
|
2412
3022
|
orderBy?: ListRoutesRequestOrderBy;
|
|
2413
|
-
/**
|
|
3023
|
+
/**
|
|
3024
|
+
* The number of route objects to return.
|
|
3025
|
+
*/
|
|
2414
3026
|
pageSize?: number;
|
|
2415
|
-
/**
|
|
3027
|
+
/**
|
|
3028
|
+
* The page number to return, from the paginated results.
|
|
3029
|
+
*/
|
|
2416
3030
|
page?: number;
|
|
2417
|
-
/**
|
|
3031
|
+
/**
|
|
3032
|
+
* Frontend ID to filter for, only Routes from this Frontend will be returned.
|
|
3033
|
+
*/
|
|
2418
3034
|
frontendId?: string;
|
|
2419
3035
|
};
|
|
2420
3036
|
export type ZonedApiListSubscriberRequest = {
|
|
2421
|
-
/**
|
|
3037
|
+
/**
|
|
3038
|
+
* Zone to target. If none is passed will use default zone from the config.
|
|
3039
|
+
*/
|
|
2422
3040
|
zone?: ScwZone;
|
|
2423
|
-
/**
|
|
3041
|
+
/**
|
|
3042
|
+
* Sort order of subscribers in the response.
|
|
3043
|
+
*/
|
|
2424
3044
|
orderBy?: ListSubscriberRequestOrderBy;
|
|
2425
|
-
/**
|
|
3045
|
+
/**
|
|
3046
|
+
* The page number to return, from the paginated results.
|
|
3047
|
+
*/
|
|
2426
3048
|
page?: number;
|
|
2427
|
-
/**
|
|
3049
|
+
/**
|
|
3050
|
+
* The number of items to return.
|
|
3051
|
+
*/
|
|
2428
3052
|
pageSize?: number;
|
|
2429
|
-
/**
|
|
3053
|
+
/**
|
|
3054
|
+
* Subscriber name to search for.
|
|
3055
|
+
*/
|
|
2430
3056
|
name?: string;
|
|
2431
|
-
/**
|
|
3057
|
+
/**
|
|
3058
|
+
* Filter subscribers by Organization ID.
|
|
3059
|
+
*/
|
|
2432
3060
|
organizationId?: string;
|
|
2433
|
-
/**
|
|
3061
|
+
/**
|
|
3062
|
+
* Filter subscribers by Project ID.
|
|
3063
|
+
*/
|
|
2434
3064
|
projectId?: string;
|
|
2435
3065
|
};
|
|
2436
3066
|
export type ZonedApiMigrateLbRequest = {
|
|
2437
|
-
/**
|
|
3067
|
+
/**
|
|
3068
|
+
* Zone to target. If none is passed will use default zone from the config.
|
|
3069
|
+
*/
|
|
2438
3070
|
zone?: ScwZone;
|
|
2439
|
-
/**
|
|
3071
|
+
/**
|
|
3072
|
+
* Load Balancer ID.
|
|
3073
|
+
*/
|
|
2440
3074
|
lbId: string;
|
|
2441
3075
|
/**
|
|
2442
|
-
* Load Balancer type to migrate to (use the List all Load Balancer offer
|
|
2443
|
-
* types endpoint to get a list of available offer types).
|
|
3076
|
+
* Load Balancer type to migrate to (use the List all Load Balancer offer types endpoint to get a list of available offer types).
|
|
2444
3077
|
*/
|
|
2445
3078
|
type: string;
|
|
2446
3079
|
};
|
|
2447
3080
|
export type ZonedApiReleaseIpRequest = {
|
|
2448
|
-
/**
|
|
3081
|
+
/**
|
|
3082
|
+
* Zone to target. If none is passed will use default zone from the config.
|
|
3083
|
+
*/
|
|
2449
3084
|
zone?: ScwZone;
|
|
2450
|
-
/**
|
|
3085
|
+
/**
|
|
3086
|
+
* IP address ID.
|
|
3087
|
+
*/
|
|
2451
3088
|
ipId: string;
|
|
2452
3089
|
};
|
|
2453
3090
|
export type ZonedApiRemoveBackendServersRequest = {
|
|
2454
|
-
/**
|
|
3091
|
+
/**
|
|
3092
|
+
* Zone to target. If none is passed will use default zone from the config.
|
|
3093
|
+
*/
|
|
2455
3094
|
zone?: ScwZone;
|
|
2456
|
-
/**
|
|
3095
|
+
/**
|
|
3096
|
+
* Backend ID.
|
|
3097
|
+
*/
|
|
2457
3098
|
backendId: string;
|
|
2458
|
-
/**
|
|
3099
|
+
/**
|
|
3100
|
+
* List of IP addresses to remove from backend servers.
|
|
3101
|
+
*/
|
|
2459
3102
|
serverIp: string[];
|
|
2460
3103
|
};
|
|
2461
3104
|
export type ZonedApiSetAclsRequest = {
|
|
2462
|
-
/**
|
|
3105
|
+
/**
|
|
3106
|
+
* Zone to target. If none is passed will use default zone from the config.
|
|
3107
|
+
*/
|
|
2463
3108
|
zone?: ScwZone;
|
|
2464
|
-
/**
|
|
3109
|
+
/**
|
|
3110
|
+
* Frontend ID.
|
|
3111
|
+
*/
|
|
2465
3112
|
frontendId: string;
|
|
2466
3113
|
/**
|
|
2467
|
-
* List of ACLs for this frontend. Any other existing ACLs on this frontend
|
|
2468
|
-
* will be removed.
|
|
3114
|
+
* List of ACLs for this frontend. Any other existing ACLs on this frontend will be removed.
|
|
2469
3115
|
*/
|
|
2470
3116
|
acls: AclSpec[];
|
|
2471
3117
|
};
|
|
2472
3118
|
export type ZonedApiSetBackendServersRequest = {
|
|
2473
|
-
/**
|
|
3119
|
+
/**
|
|
3120
|
+
* Zone to target. If none is passed will use default zone from the config.
|
|
3121
|
+
*/
|
|
2474
3122
|
zone?: ScwZone;
|
|
2475
|
-
/**
|
|
3123
|
+
/**
|
|
3124
|
+
* Backend ID.
|
|
3125
|
+
*/
|
|
2476
3126
|
backendId: string;
|
|
2477
3127
|
/**
|
|
2478
|
-
* List of IP addresses for backend servers. Any other existing backend
|
|
2479
|
-
* servers will be removed.
|
|
3128
|
+
* List of IP addresses for backend servers. Any other existing backend servers will be removed.
|
|
2480
3129
|
*/
|
|
2481
3130
|
serverIp: string[];
|
|
2482
3131
|
};
|
|
2483
3132
|
export type ZonedApiSubscribeToLbRequest = {
|
|
2484
|
-
/**
|
|
3133
|
+
/**
|
|
3134
|
+
* Zone to target. If none is passed will use default zone from the config.
|
|
3135
|
+
*/
|
|
2485
3136
|
zone?: ScwZone;
|
|
2486
|
-
/**
|
|
3137
|
+
/**
|
|
3138
|
+
* Load Balancer ID.
|
|
3139
|
+
*/
|
|
2487
3140
|
lbId: string;
|
|
2488
|
-
/**
|
|
3141
|
+
/**
|
|
3142
|
+
* Subscriber ID.
|
|
3143
|
+
*/
|
|
2489
3144
|
subscriberId: string;
|
|
2490
3145
|
};
|
|
2491
3146
|
export type ZonedApiUnsubscribeFromLbRequest = {
|
|
2492
|
-
/**
|
|
3147
|
+
/**
|
|
3148
|
+
* Zone to target. If none is passed will use default zone from the config.
|
|
3149
|
+
*/
|
|
2493
3150
|
zone?: ScwZone;
|
|
2494
|
-
/**
|
|
3151
|
+
/**
|
|
3152
|
+
* Load Balancer ID.
|
|
3153
|
+
*/
|
|
2495
3154
|
lbId: string;
|
|
2496
3155
|
};
|
|
2497
3156
|
export type ZonedApiUpdateAclRequest = {
|
|
2498
|
-
/**
|
|
3157
|
+
/**
|
|
3158
|
+
* Zone to target. If none is passed will use default zone from the config.
|
|
3159
|
+
*/
|
|
2499
3160
|
zone?: ScwZone;
|
|
2500
|
-
/**
|
|
3161
|
+
/**
|
|
3162
|
+
* ACL ID.
|
|
3163
|
+
*/
|
|
2501
3164
|
aclId: string;
|
|
2502
|
-
/**
|
|
3165
|
+
/**
|
|
3166
|
+
* ACL name.
|
|
3167
|
+
*/
|
|
2503
3168
|
name: string;
|
|
2504
|
-
/**
|
|
3169
|
+
/**
|
|
3170
|
+
* Action to take when incoming traffic matches an ACL filter.
|
|
3171
|
+
*/
|
|
2505
3172
|
action: AclAction;
|
|
2506
3173
|
/**
|
|
2507
|
-
* ACL match filter object. One of `ip_subnet` or `http_filter` &
|
|
2508
|
-
* `http_filter_value` are required.
|
|
3174
|
+
* ACL match filter object. One of `ip_subnet` or `http_filter` & `http_filter_value` are required.
|
|
2509
3175
|
*/
|
|
2510
3176
|
match?: AclMatch;
|
|
2511
3177
|
/**
|
|
2512
|
-
* Priority of this ACL (ACLs are applied in ascending order, 0 is the first
|
|
2513
|
-
* ACL executed).
|
|
3178
|
+
* Priority of this ACL (ACLs are applied in ascending order, 0 is the first ACL executed).
|
|
2514
3179
|
*/
|
|
2515
3180
|
index: number;
|
|
2516
|
-
/**
|
|
3181
|
+
/**
|
|
3182
|
+
* ACL description.
|
|
3183
|
+
*/
|
|
2517
3184
|
description?: string;
|
|
2518
3185
|
};
|
|
2519
3186
|
export type ZonedApiUpdateBackendRequest = {
|
|
2520
|
-
/**
|
|
3187
|
+
/**
|
|
3188
|
+
* Zone to target. If none is passed will use default zone from the config.
|
|
3189
|
+
*/
|
|
2521
3190
|
zone?: ScwZone;
|
|
2522
|
-
/**
|
|
3191
|
+
/**
|
|
3192
|
+
* Backend ID.
|
|
3193
|
+
*/
|
|
2523
3194
|
backendId: string;
|
|
2524
|
-
/**
|
|
3195
|
+
/**
|
|
3196
|
+
* Backend name.
|
|
3197
|
+
*/
|
|
2525
3198
|
name: string;
|
|
2526
3199
|
/**
|
|
2527
|
-
* Protocol to be used by the backend when forwarding traffic to backend
|
|
2528
|
-
* servers.
|
|
3200
|
+
* Protocol to be used by the backend when forwarding traffic to backend servers.
|
|
2529
3201
|
*/
|
|
2530
3202
|
forwardProtocol: Protocol;
|
|
2531
|
-
/**
|
|
3203
|
+
/**
|
|
3204
|
+
* Port to be used by the backend when forwarding traffic to backend servers.
|
|
3205
|
+
*/
|
|
2532
3206
|
forwardPort: number;
|
|
2533
3207
|
/**
|
|
2534
|
-
* Load balancing algorithm to be used when determining which backend server
|
|
2535
|
-
* to forward new traffic to.
|
|
3208
|
+
* Load balancing algorithm to be used when determining which backend server to forward new traffic to.
|
|
2536
3209
|
*/
|
|
2537
3210
|
forwardPortAlgorithm: ForwardPortAlgorithm;
|
|
2538
3211
|
/**
|
|
2539
|
-
* Defines whether to activate sticky sessions (binding a particular session
|
|
2540
|
-
* to a particular backend server) and the method to use if so. None disables
|
|
2541
|
-
* sticky sessions. Cookie-based uses an HTTP cookie to stick a session to a
|
|
2542
|
-
* backend server. Table-based uses the source (client) IP address to stick a
|
|
2543
|
-
* session to a backend server.
|
|
3212
|
+
* Defines whether to activate sticky sessions (binding a particular session to a particular backend server) and the method to use if so. None disables sticky sessions. Cookie-based uses an HTTP cookie to stick a session to a backend server. Table-based uses the source (client) IP address to stick a session to a backend server.
|
|
2544
3213
|
*/
|
|
2545
3214
|
stickySessions: StickySessionsType;
|
|
2546
|
-
/**
|
|
3215
|
+
/**
|
|
3216
|
+
* Cookie name for cookie-based sticky sessions.
|
|
3217
|
+
*/
|
|
2547
3218
|
stickySessionsCookieName: string;
|
|
2548
|
-
/**
|
|
3219
|
+
/**
|
|
3220
|
+
* @deprecated Deprecated in favor of proxy_protocol field.
|
|
3221
|
+
*/
|
|
2549
3222
|
sendProxyV2?: boolean;
|
|
2550
|
-
/**
|
|
3223
|
+
/**
|
|
3224
|
+
* Maximum allowed time for a backend server to process a request.
|
|
3225
|
+
*/
|
|
2551
3226
|
timeoutServer?: string;
|
|
2552
|
-
/**
|
|
3227
|
+
/**
|
|
3228
|
+
* Maximum allowed time for establishing a connection to a backend server.
|
|
3229
|
+
*/
|
|
2553
3230
|
timeoutConnect?: string;
|
|
2554
3231
|
/**
|
|
2555
|
-
* Maximum allowed tunnel inactivity time after Websocket is established
|
|
2556
|
-
* (takes precedence over client and server timeout).
|
|
3232
|
+
* Maximum allowed tunnel inactivity time after Websocket is established (takes precedence over client and server timeout).
|
|
2557
3233
|
*/
|
|
2558
3234
|
timeoutTunnel?: string;
|
|
2559
|
-
/**
|
|
3235
|
+
/**
|
|
3236
|
+
* Action to take when a backend server is marked as down.
|
|
3237
|
+
*/
|
|
2560
3238
|
onMarkedDownAction?: OnMarkedDownAction;
|
|
2561
3239
|
/**
|
|
2562
|
-
* Protocol to use between the Load Balancer and backend servers. Allows the
|
|
2563
|
-
* backend servers to be informed of the client's real IP address. The PROXY
|
|
2564
|
-
* protocol must be supported by the backend servers' software.
|
|
3240
|
+
* Protocol to use between the Load Balancer and backend servers. Allows the backend servers to be informed of the client's real IP address. The PROXY protocol must be supported by the backend servers' software.
|
|
2565
3241
|
*/
|
|
2566
3242
|
proxyProtocol?: ProxyProtocol;
|
|
2567
3243
|
/**
|
|
2568
|
-
* Scaleway Object Storage bucket website to be served as failover if all
|
|
2569
|
-
* backend servers are down, e.g.
|
|
2570
|
-
* failover-website.s3-website.fr-par.scw.cloud.
|
|
3244
|
+
* Scaleway Object Storage bucket website to be served as failover if all backend servers are down, e.g. failover-website.s3-website.fr-par.scw.cloud.
|
|
2571
3245
|
*/
|
|
2572
3246
|
failoverHost?: string;
|
|
2573
3247
|
/**
|
|
2574
|
-
* Defines whether to enable SSL bridging between the Load Balancer and
|
|
2575
|
-
* backend servers.
|
|
3248
|
+
* Defines whether to enable SSL bridging between the Load Balancer and backend servers.
|
|
2576
3249
|
*/
|
|
2577
3250
|
sslBridging?: boolean;
|
|
2578
|
-
/**
|
|
3251
|
+
/**
|
|
3252
|
+
* Defines whether the server certificate verification should be ignored.
|
|
3253
|
+
*/
|
|
2579
3254
|
ignoreSslServerVerify?: boolean;
|
|
2580
|
-
/**
|
|
3255
|
+
/**
|
|
3256
|
+
* Whether to use another backend server on each attempt.
|
|
3257
|
+
*/
|
|
2581
3258
|
redispatchAttemptCount?: number;
|
|
2582
|
-
/**
|
|
3259
|
+
/**
|
|
3260
|
+
* Number of retries when a backend server connection failed.
|
|
3261
|
+
*/
|
|
2583
3262
|
maxRetries?: number;
|
|
2584
|
-
/**
|
|
3263
|
+
/**
|
|
3264
|
+
* Maximum number of connections allowed per backend server.
|
|
3265
|
+
*/
|
|
2585
3266
|
maxConnections?: number;
|
|
2586
3267
|
/**
|
|
2587
|
-
* Maximum time for a request to be left pending in queue when
|
|
2588
|
-
* `max_connections` is reached.
|
|
3268
|
+
* Maximum time for a request to be left pending in queue when `max_connections` is reached.
|
|
2589
3269
|
*/
|
|
2590
3270
|
timeoutQueue?: string;
|
|
2591
3271
|
};
|
|
2592
3272
|
export type ZonedApiUpdateCertificateRequest = {
|
|
2593
|
-
/**
|
|
3273
|
+
/**
|
|
3274
|
+
* Zone to target. If none is passed will use default zone from the config.
|
|
3275
|
+
*/
|
|
2594
3276
|
zone?: ScwZone;
|
|
2595
|
-
/**
|
|
3277
|
+
/**
|
|
3278
|
+
* Certificate ID.
|
|
3279
|
+
*/
|
|
2596
3280
|
certificateId: string;
|
|
2597
|
-
/**
|
|
3281
|
+
/**
|
|
3282
|
+
* Certificate name.
|
|
3283
|
+
*/
|
|
2598
3284
|
name: string;
|
|
2599
3285
|
};
|
|
2600
3286
|
export type ZonedApiUpdateFrontendRequest = {
|
|
2601
|
-
/**
|
|
3287
|
+
/**
|
|
3288
|
+
* Zone to target. If none is passed will use default zone from the config.
|
|
3289
|
+
*/
|
|
2602
3290
|
zone?: ScwZone;
|
|
2603
|
-
/**
|
|
3291
|
+
/**
|
|
3292
|
+
* Frontend ID.
|
|
3293
|
+
*/
|
|
2604
3294
|
frontendId: string;
|
|
2605
|
-
/**
|
|
3295
|
+
/**
|
|
3296
|
+
* Frontend name.
|
|
3297
|
+
*/
|
|
2606
3298
|
name: string;
|
|
2607
|
-
/**
|
|
3299
|
+
/**
|
|
3300
|
+
* Port the frontend should listen on.
|
|
3301
|
+
*/
|
|
2608
3302
|
inboundPort: number;
|
|
2609
|
-
/**
|
|
3303
|
+
/**
|
|
3304
|
+
* Backend ID (ID of the backend the frontend should pass traffic to).
|
|
3305
|
+
*/
|
|
2610
3306
|
backendId: string;
|
|
2611
|
-
/**
|
|
3307
|
+
/**
|
|
3308
|
+
* Maximum allowed inactivity time on the client side.
|
|
3309
|
+
*/
|
|
2612
3310
|
timeoutClient?: string;
|
|
2613
|
-
/**
|
|
3311
|
+
/**
|
|
3312
|
+
* @deprecated Certificate ID, deprecated in favor of certificate_ids array.
|
|
3313
|
+
*/
|
|
2614
3314
|
certificateId?: string;
|
|
2615
|
-
/**
|
|
3315
|
+
/**
|
|
3316
|
+
* List of SSL/TLS certificate IDs to bind to the frontend.
|
|
3317
|
+
*/
|
|
2616
3318
|
certificateIds?: string[];
|
|
2617
|
-
/**
|
|
3319
|
+
/**
|
|
3320
|
+
* Defines whether to enable HTTP/3 protocol on the frontend.
|
|
3321
|
+
*/
|
|
2618
3322
|
enableHttp3: boolean;
|
|
2619
3323
|
/**
|
|
2620
|
-
* Rate limit for new connections established on this frontend. Use 0 value to
|
|
2621
|
-
* disable, else value is connections per second.
|
|
3324
|
+
* Rate limit for new connections established on this frontend. Use 0 value to disable, else value is connections per second.
|
|
2622
3325
|
*/
|
|
2623
3326
|
connectionRateLimit?: number;
|
|
2624
3327
|
};
|
|
2625
3328
|
export type ZonedApiUpdateHealthCheckRequest = {
|
|
2626
|
-
/**
|
|
3329
|
+
/**
|
|
3330
|
+
* Zone to target. If none is passed will use default zone from the config.
|
|
3331
|
+
*/
|
|
2627
3332
|
zone?: ScwZone;
|
|
2628
|
-
/**
|
|
3333
|
+
/**
|
|
3334
|
+
* Backend ID.
|
|
3335
|
+
*/
|
|
2629
3336
|
backendId: string;
|
|
2630
|
-
/**
|
|
3337
|
+
/**
|
|
3338
|
+
* Port to use for the backend server health check.
|
|
3339
|
+
*/
|
|
2631
3340
|
port: number;
|
|
2632
|
-
/**
|
|
3341
|
+
/**
|
|
3342
|
+
* Time to wait between two consecutive health checks.
|
|
3343
|
+
*/
|
|
2633
3344
|
checkDelay?: string;
|
|
2634
|
-
/**
|
|
3345
|
+
/**
|
|
3346
|
+
* Maximum time a backend server has to reply to the health check.
|
|
3347
|
+
*/
|
|
2635
3348
|
checkTimeout?: string;
|
|
2636
3349
|
/**
|
|
2637
|
-
* Number of consecutive unsuccessful health checks after which the server
|
|
2638
|
-
* will be considered dead.
|
|
3350
|
+
* Number of consecutive unsuccessful health checks after which the server will be considered dead.
|
|
2639
3351
|
*/
|
|
2640
3352
|
checkMaxRetries: number;
|
|
2641
|
-
/**
|
|
3353
|
+
/**
|
|
3354
|
+
* Defines whether proxy protocol should be activated for the health check.
|
|
3355
|
+
*/
|
|
2642
3356
|
checkSendProxy: boolean;
|
|
2643
3357
|
/**
|
|
2644
3358
|
* Object to configure a basic TCP health check.
|
|
2645
3359
|
*
|
|
2646
|
-
* One-of ('config'): at most one of 'tcpConfig', 'mysqlConfig',
|
|
2647
|
-
* 'pgsqlConfig', 'ldapConfig', 'redisConfig', 'httpConfig', 'httpsConfig'
|
|
2648
|
-
* could be set.
|
|
3360
|
+
* One-of ('config'): at most one of 'tcpConfig', 'mysqlConfig', 'pgsqlConfig', 'ldapConfig', 'redisConfig', 'httpConfig', 'httpsConfig' could be set.
|
|
2649
3361
|
*/
|
|
2650
3362
|
tcpConfig?: HealthCheckTcpConfig;
|
|
2651
3363
|
/**
|
|
2652
|
-
* Object to configure a MySQL health check. The check requires MySQL >=3.22
|
|
2653
|
-
* or <9.0. For older or newer versions, use a TCP health check.
|
|
3364
|
+
* Object to configure a MySQL health check. The check requires MySQL >=3.22 or <9.0. For older or newer versions, use a TCP health check.
|
|
2654
3365
|
*
|
|
2655
|
-
* One-of ('config'): at most one of 'tcpConfig', 'mysqlConfig',
|
|
2656
|
-
* 'pgsqlConfig', 'ldapConfig', 'redisConfig', 'httpConfig', 'httpsConfig'
|
|
2657
|
-
* could be set.
|
|
3366
|
+
* One-of ('config'): at most one of 'tcpConfig', 'mysqlConfig', 'pgsqlConfig', 'ldapConfig', 'redisConfig', 'httpConfig', 'httpsConfig' could be set.
|
|
2658
3367
|
*/
|
|
2659
3368
|
mysqlConfig?: HealthCheckMysqlConfig;
|
|
2660
3369
|
/**
|
|
2661
3370
|
* Object to configure a PostgreSQL health check.
|
|
2662
3371
|
*
|
|
2663
|
-
* One-of ('config'): at most one of 'tcpConfig', 'mysqlConfig',
|
|
2664
|
-
* 'pgsqlConfig', 'ldapConfig', 'redisConfig', 'httpConfig', 'httpsConfig'
|
|
2665
|
-
* could be set.
|
|
3372
|
+
* One-of ('config'): at most one of 'tcpConfig', 'mysqlConfig', 'pgsqlConfig', 'ldapConfig', 'redisConfig', 'httpConfig', 'httpsConfig' could be set.
|
|
2666
3373
|
*/
|
|
2667
3374
|
pgsqlConfig?: HealthCheckPgsqlConfig;
|
|
2668
3375
|
/**
|
|
2669
|
-
* Object to configure an LDAP health check. The response is analyzed to find
|
|
2670
|
-
* the LDAPv3 response message.
|
|
3376
|
+
* Object to configure an LDAP health check. The response is analyzed to find the LDAPv3 response message.
|
|
2671
3377
|
*
|
|
2672
|
-
* One-of ('config'): at most one of 'tcpConfig', 'mysqlConfig',
|
|
2673
|
-
* 'pgsqlConfig', 'ldapConfig', 'redisConfig', 'httpConfig', 'httpsConfig'
|
|
2674
|
-
* could be set.
|
|
3378
|
+
* One-of ('config'): at most one of 'tcpConfig', 'mysqlConfig', 'pgsqlConfig', 'ldapConfig', 'redisConfig', 'httpConfig', 'httpsConfig' could be set.
|
|
2675
3379
|
*/
|
|
2676
3380
|
ldapConfig?: HealthCheckLdapConfig;
|
|
2677
3381
|
/**
|
|
2678
|
-
* Object to configure a Redis health check. The response is analyzed to find
|
|
2679
|
-
* the +PONG response message.
|
|
3382
|
+
* Object to configure a Redis health check. The response is analyzed to find the +PONG response message.
|
|
2680
3383
|
*
|
|
2681
|
-
* One-of ('config'): at most one of 'tcpConfig', 'mysqlConfig',
|
|
2682
|
-
* 'pgsqlConfig', 'ldapConfig', 'redisConfig', 'httpConfig', 'httpsConfig'
|
|
2683
|
-
* could be set.
|
|
3384
|
+
* One-of ('config'): at most one of 'tcpConfig', 'mysqlConfig', 'pgsqlConfig', 'ldapConfig', 'redisConfig', 'httpConfig', 'httpsConfig' could be set.
|
|
2684
3385
|
*/
|
|
2685
3386
|
redisConfig?: HealthCheckRedisConfig;
|
|
2686
3387
|
/**
|
|
2687
3388
|
* Object to configure an HTTP health check.
|
|
2688
3389
|
*
|
|
2689
|
-
* One-of ('config'): at most one of 'tcpConfig', 'mysqlConfig',
|
|
2690
|
-
* 'pgsqlConfig', 'ldapConfig', 'redisConfig', 'httpConfig', 'httpsConfig'
|
|
2691
|
-
* could be set.
|
|
3390
|
+
* One-of ('config'): at most one of 'tcpConfig', 'mysqlConfig', 'pgsqlConfig', 'ldapConfig', 'redisConfig', 'httpConfig', 'httpsConfig' could be set.
|
|
2692
3391
|
*/
|
|
2693
3392
|
httpConfig?: HealthCheckHttpConfig;
|
|
2694
3393
|
/**
|
|
2695
3394
|
* Object to configure an HTTPS health check.
|
|
2696
3395
|
*
|
|
2697
|
-
* One-of ('config'): at most one of 'tcpConfig', 'mysqlConfig',
|
|
2698
|
-
* 'pgsqlConfig', 'ldapConfig', 'redisConfig', 'httpConfig', 'httpsConfig'
|
|
2699
|
-
* could be set.
|
|
3396
|
+
* One-of ('config'): at most one of 'tcpConfig', 'mysqlConfig', 'pgsqlConfig', 'ldapConfig', 'redisConfig', 'httpConfig', 'httpsConfig' could be set.
|
|
2700
3397
|
*/
|
|
2701
3398
|
httpsConfig?: HealthCheckHttpsConfig;
|
|
2702
3399
|
/**
|
|
2703
|
-
* Time to wait between two consecutive health checks when a backend server is
|
|
2704
|
-
* in a transient state (going UP or DOWN).
|
|
3400
|
+
* Time to wait between two consecutive health checks when a backend server is in a transient state (going UP or DOWN).
|
|
2705
3401
|
*/
|
|
2706
3402
|
transientCheckDelay?: string;
|
|
2707
3403
|
};
|
|
2708
3404
|
export type ZonedApiUpdateIpRequest = {
|
|
2709
|
-
/**
|
|
3405
|
+
/**
|
|
3406
|
+
* Zone to target. If none is passed will use default zone from the config.
|
|
3407
|
+
*/
|
|
2710
3408
|
zone?: ScwZone;
|
|
2711
|
-
/**
|
|
3409
|
+
/**
|
|
3410
|
+
* IP address ID.
|
|
3411
|
+
*/
|
|
2712
3412
|
ipId: string;
|
|
2713
|
-
/**
|
|
3413
|
+
/**
|
|
3414
|
+
* Reverse DNS (domain name) for the IP address.
|
|
3415
|
+
*/
|
|
2714
3416
|
reverse?: string;
|
|
2715
|
-
/**
|
|
3417
|
+
/**
|
|
3418
|
+
* ID of the server on which to attach the flexible IP.
|
|
3419
|
+
*/
|
|
2716
3420
|
lbId?: string;
|
|
2717
|
-
/**
|
|
3421
|
+
/**
|
|
3422
|
+
* List of tags for the IP.
|
|
3423
|
+
*/
|
|
2718
3424
|
tags?: string[];
|
|
2719
3425
|
};
|
|
2720
3426
|
export type ZonedApiUpdateLbRequest = {
|
|
2721
|
-
/**
|
|
3427
|
+
/**
|
|
3428
|
+
* Zone to target. If none is passed will use default zone from the config.
|
|
3429
|
+
*/
|
|
2722
3430
|
zone?: ScwZone;
|
|
2723
|
-
/**
|
|
3431
|
+
/**
|
|
3432
|
+
* Load Balancer ID.
|
|
3433
|
+
*/
|
|
2724
3434
|
lbId: string;
|
|
2725
|
-
/**
|
|
3435
|
+
/**
|
|
3436
|
+
* Load Balancer name.
|
|
3437
|
+
*/
|
|
2726
3438
|
name: string;
|
|
2727
|
-
/**
|
|
3439
|
+
/**
|
|
3440
|
+
* Load Balancer description.
|
|
3441
|
+
*/
|
|
2728
3442
|
description: string;
|
|
2729
|
-
/**
|
|
3443
|
+
/**
|
|
3444
|
+
* List of tags for the Load Balancer.
|
|
3445
|
+
*/
|
|
2730
3446
|
tags?: string[];
|
|
2731
3447
|
/**
|
|
2732
|
-
* Determines the minimal SSL version which needs to be supported on the
|
|
2733
|
-
* client side, in an SSL/TLS offloading context. Intermediate is suitable for
|
|
2734
|
-
* general-purpose servers with a variety of clients, recommended for almost
|
|
2735
|
-
* all systems. Modern is suitable for services with clients that support TLS
|
|
2736
|
-
* 1.3 and don't need backward compatibility. Old is compatible with a small
|
|
2737
|
-
* number of very old clients and should be used only as a last resort.
|
|
3448
|
+
* Determines the minimal SSL version which needs to be supported on the client side, in an SSL/TLS offloading context. Intermediate is suitable for general-purpose servers with a variety of clients, recommended for almost all systems. Modern is suitable for services with clients that support TLS 1.3 and don't need backward compatibility. Old is compatible with a small number of very old clients and should be used only as a last resort.
|
|
2738
3449
|
*/
|
|
2739
3450
|
sslCompatibilityLevel?: SSLCompatibilityLevel;
|
|
2740
3451
|
};
|
|
2741
3452
|
export type ZonedApiUpdateRouteRequest = {
|
|
2742
|
-
/**
|
|
3453
|
+
/**
|
|
3454
|
+
* Zone to target. If none is passed will use default zone from the config.
|
|
3455
|
+
*/
|
|
2743
3456
|
zone?: ScwZone;
|
|
2744
|
-
/**
|
|
3457
|
+
/**
|
|
3458
|
+
* Route ID.
|
|
3459
|
+
*/
|
|
2745
3460
|
routeId: string;
|
|
2746
|
-
/**
|
|
3461
|
+
/**
|
|
3462
|
+
* ID of the target backend for the route.
|
|
3463
|
+
*/
|
|
2747
3464
|
backendId: string;
|
|
2748
3465
|
/**
|
|
2749
|
-
* Object defining the match condition for a route to be applied. If an
|
|
2750
|
-
* incoming client session matches the specified condition (i.e. it has a
|
|
2751
|
-
* matching SNI value or HTTP Host header value), it will be passed to the
|
|
2752
|
-
* target backend.
|
|
3466
|
+
* Object defining the match condition for a route to be applied. If an incoming client session matches the specified condition (i.e. it has a matching SNI value or HTTP Host header value), it will be passed to the target backend.
|
|
2753
3467
|
*/
|
|
2754
3468
|
match?: RouteMatch;
|
|
2755
3469
|
};
|
|
2756
3470
|
export type ZonedApiUpdateSubscriberRequest = {
|
|
2757
|
-
/**
|
|
3471
|
+
/**
|
|
3472
|
+
* Zone to target. If none is passed will use default zone from the config.
|
|
3473
|
+
*/
|
|
2758
3474
|
zone?: ScwZone;
|
|
2759
|
-
/**
|
|
3475
|
+
/**
|
|
3476
|
+
* Subscriber ID.
|
|
3477
|
+
*/
|
|
2760
3478
|
subscriberId: string;
|
|
2761
|
-
/**
|
|
3479
|
+
/**
|
|
3480
|
+
* Subscriber name.
|
|
3481
|
+
*/
|
|
2762
3482
|
name: string;
|
|
2763
3483
|
/**
|
|
2764
3484
|
* Email address configuration.
|
|
2765
3485
|
*
|
|
2766
|
-
* One-of ('config'): at most one of 'emailConfig', 'webhookConfig' could be
|
|
2767
|
-
* set.
|
|
3486
|
+
* One-of ('config'): at most one of 'emailConfig', 'webhookConfig' could be set.
|
|
2768
3487
|
*/
|
|
2769
3488
|
emailConfig?: SubscriberEmailConfig;
|
|
2770
3489
|
/**
|
|
2771
3490
|
* Webhook URI configuration.
|
|
2772
3491
|
*
|
|
2773
|
-
* One-of ('config'): at most one of 'emailConfig', 'webhookConfig' could be
|
|
2774
|
-
* set.
|
|
3492
|
+
* One-of ('config'): at most one of 'emailConfig', 'webhookConfig' could be set.
|
|
2775
3493
|
*/
|
|
2776
3494
|
webhookConfig?: SubscriberWebhookConfig;
|
|
2777
3495
|
};
|