Scaleway · Schema
scaleway.lb.v1.PrivateNetwork
AICloud ComputingContainersDatabaseEuropean CloudInfrastructureKubernetesServerlessStorage
Properties
| Name | Type | Description |
|---|---|---|
| lb | object | Load Balancer object which is attached to the Private Network. |
| ipam_ids | array | IPAM IDs of the booked IP addresses. (UUID format) |
| static_config | object | Object containing an array of a local IP address for the Load Balancer on this Private Network. |
| dhcp_config | object | Object containing DHCP-assigned IP addresses. |
| private_network_id | string | Private Network ID. |
| status | string | Status of Private Network connection. |
| created_at | string | Date on which the Private Network was created. (RFC 3339 format) |
| updated_at | string | Date on which the PN was last updated. (RFC 3339 format) |
JSON Schema
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"$id": "#/components/schemas/scaleway.lb.v1.PrivateNetwork",
"title": "scaleway.lb.v1.PrivateNetwork",
"type": "object",
"properties": {
"lb": {
"type": "object",
"description": "Load Balancer object which is attached to the Private Network.",
"properties": {
"id": {
"type": "string",
"description": "Underlying Instance ID."
},
"name": {
"type": "string",
"description": "Load Balancer name."
},
"description": {
"type": "string",
"description": "Load Balancer description."
},
"status": {
"type": "string",
"description": "Load Balancer status.",
"enum": [
"unknown",
"ready",
"pending",
"stopped",
"error",
"locked",
"migrating",
"to_create",
"creating",
"to_delete",
"deleting"
],
"default": "unknown"
},
"instances": {
"type": "array",
"description": "List of underlying Instances.",
"items": {
"$ref": "#/components/schemas/scaleway.lb.v1.Instance"
}
},
"organization_id": {
"type": "string",
"description": "Scaleway Organization ID."
},
"project_id": {
"type": "string",
"description": "Scaleway Project ID."
},
"ip": {
"type": "array",
"description": "List of IP addresses attached to the Load Balancer.",
"items": {
"$ref": "#/components/schemas/scaleway.lb.v1.Ip"
}
},
"tags": {
"type": "array",
"description": "Load Balancer tags.",
"items": {
"type": "string"
}
},
"frontend_count": {
"type": "integer",
"description": "Number of frontends the Load Balancer has.",
"format": "int32"
},
"backend_count": {
"type": "integer",
"description": "Number of backends the Load Balancer has.",
"format": "int32"
},
"type": {
"type": "string",
"description": "Load Balancer offer type."
},
"subscriber": {
"type": "object",
"description": "Subscriber information.",
"properties": {
"id": {
"type": "string",
"description": "Subscriber ID."
},
"name": {
"type": "string",
"description": "Subscriber name."
},
"email_config": {
"type": "object",
"description": "Email address of subscriber.",
"properties": {
"email": {
"type": "string",
"description": "Email address to send alerts to."
}
},
"nullable": true,
"x-properties-order": [
"email"
],
"x-one-of": "config"
},
"webhook_config": {
"type": "object",
"description": "Webhook URI of subscriber.",
"properties": {
"uri": {
"type": "string",
"description": "URI to receive POST requests."
}
},
"nullable": true,
"x-properties-order": [
"uri"
],
"x-one-of": "config"
}
},
"x-properties-order": [
"id",
"name",
"email_config",
"webhook_config"
]
},
"ssl_compatibility_level": {
"type": "string",
"description": "Determines the minimal SSL version which needs to be supported on client side.",
"enum": [
"ssl_compatibility_level_unknown",
"ssl_compatibility_level_intermediate",
"ssl_compatibility_level_modern",
"ssl_compatibility_level_old"
],
"default": "ssl_compatibility_level_unknown"
},
"created_at": {
"type": "string",
"description": "Date on which the Load Balancer was created. (RFC 3339 format)",
"format": "date-time",
"example": "2022-03-22T12:34:56.123456Z",
"nullable": true
},
"updated_at": {
"type": "string",
"description": "Date on which the Load Balancer was last updated. (RFC 3339 format)",
"format": "date-time",
"example": "2022-03-22T12:34:56.123456Z",
"nullable": true
},
"private_network_count": {
"type": "integer",
"description": "Number of Private Networks attached to the Load Balancer.",
"format": "int32"
},
"route_count": {
"type": "integer",
"description": "Number of routes configured on the Load Balancer.",
"format": "int32"
},
"region": {
"type": "string",
"description": "The region the Load Balancer is in.",
"deprecated": true
},
"zone": {
"type": "string",
"description": "The zone the Load Balancer is in."
}
},
"x-properties-order": [
"id",
"name",
"description",
"status",
"instances",
"organization_id",
"project_id",
"ip",
"tags",
"frontend_count",
"backend_count",
"type",
"subscriber",
"ssl_compatibility_level",
"created_at",
"updated_at",
"private_network_count",
"route_count",
"region",
"zone"
]
},
"ipam_ids": {
"type": "array",
"description": "IPAM IDs of the booked IP addresses. (UUID format)",
"example": [
"6170692e-7363-616c-6577-61792e636f6d"
],
"items": {
"type": "string"
}
},
"static_config": {
"type": "object",
"description": "Object containing an array of a local IP address for the Load Balancer on this Private Network.",
"deprecated": true,
"properties": {
"ip_address": {
"type": "array",
"description": "Array of a local IP address for the Load Balancer on this Private Network.",
"deprecated": true,
"items": {
"type": "string"
}
}
},
"nullable": true,
"x-properties-order": [
"ip_address"
],
"x-one-of": "Config"
},
"dhcp_config": {
"type": "object",
"description": "Object containing DHCP-assigned IP addresses.",
"deprecated": true,
"properties": {
"ip_id": {
"type": "string",
"description": "(UUID format)",
"deprecated": true,
"example": "6170692e-7363-616c-6577-61792e636f6d",
"nullable": true
}
},
"nullable": true,
"x-properties-order": [
"ip_id"
],
"x-one-of": "Config"
},
"private_network_id": {
"type": "string",
"description": "Private Network ID."
},
"status": {
"type": "string",
"description": "Status of Private Network connection.",
"enum": [
"unknown",
"ready",
"pending",
"error"
],
"default": "unknown"
},
"created_at": {
"type": "string",
"description": "Date on which the Private Network was created. (RFC 3339 format)",
"format": "date-time",
"example": "2022-03-22T12:34:56.123456Z",
"nullable": true
},
"updated_at": {
"type": "string",
"description": "Date on which the PN was last updated. (RFC 3339 format)",
"format": "date-time",
"example": "2022-03-22T12:34:56.123456Z",
"nullable": true
}
},
"x-properties-order": [
"lb",
"ipam_ids",
"static_config",
"dhcp_config",
"private_network_id",
"status",
"created_at",
"updated_at"
]
}