region_loadbalancing_log_kinds
Creates, updates, deletes, gets or lists a region_loadbalancing_log_kinds resource.
Overview​
| Name | region_loadbalancing_log_kinds |
| Type | Resource |
| Id | ovh.cloud_network.region_loadbalancing_log_kinds |
Fields​
The following fields are returned by SELECT queries:
- get
- list
successful operation
| Name | Datatype | Description |
|---|---|---|
name | string | Log kind name |
kind_id | string (uuid) | Log kind ID (wire: kindId) |
display_name | string | Log kind display name (wire: displayName) |
additional_returned_fields | array | List of additional log fields managed in this log kind (wire: additionalReturnedFields) |
created_at | string (date-time) | Creation date of the log kind (wire: createdAt) |
updated_at | string (date-time) | Last update date of the log kind (wire: updatedAt) |
Log kind
| Name | Datatype | Description |
|---|---|---|
name | string | Log kind name |
kind_id | string (uuid) | Log kind ID (wire: kindId) |
display_name | string | Log kind display name (wire: displayName) |
additional_returned_fields | array | List of additional log fields managed in this log kind (wire: additionalReturnedFields) |
created_at | string (date-time) | Creation date of the log kind (wire: createdAt) |
updated_at | string (date-time) | Last update date of the log kind (wire: updatedAt) |
Methods​
The following methods are available for this resource:
| Name | Accessible by | Required Params | Optional Params | Description |
|---|---|---|---|---|
get | select | name, region_name, service_name | Get a log kind | |
list | select | region_name, service_name | x_pagination_mode | List available log kinds |
Parameters​
Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.
| Name | Datatype | Description |
|---|---|---|
api_host | string | The OVHcloud API host. Selected by OVH_ENDPOINT (ovh-eu, ovh-ca or ovh-us; default ovh-eu). (default: api.eu.ovhcloud.com, x-stackQL-envVarSelector: {"envVar":"OVH_ENDPOINT","default":"ovh-eu","values":{"ovh-eu":"api.eu.ovhcloud.com","ovh-ca":"api.ca.ovhcloud.com","ovh-us":"api.us.ovhcloud.com"}}) |
name | string | Name |
region_name | string | Region name (wire: regionName) |
service_name | string | The Public Cloud project ID. Resolved from OVH_CLOUD_PROJECT_SERVICE when set. |
x_pagination_mode | string | Sent as CachedObjectList-Pages by default so the list returns the full objects rather than their identifiers. (wire: X-Pagination-Mode) |
SELECT examples​
- get
- list
Get a log kind
SELECT
name,
kind_id,
display_name,
additional_returned_fields,
created_at,
updated_at
FROM ovh.cloud_network.region_loadbalancing_log_kinds
WHERE name = '{{ name }}' -- required
AND region_name = '{{ region_name }}' -- required
AND service_name = '{{ service_name }}' -- required unless OVH_CLOUD_PROJECT_SERVICE is set
;
List available log kinds
SELECT
name,
kind_id,
display_name,
additional_returned_fields,
created_at,
updated_at
FROM ovh.cloud_network.region_loadbalancing_log_kinds
WHERE region_name = '{{ region_name }}' -- required
AND service_name = '{{ service_name }}' -- required unless OVH_CLOUD_PROJECT_SERVICE is set
AND x_pagination_mode = '{{ x_pagination_mode }}'
;