log_groups

Creates, updates, deletes, gets or lists a log_groups resource.

Overview

Name	log_groups
Type	Resource
Id	oci.logging.log_groups

Fields

The following fields are returned by SELECT queries:

get

Log group was retrieved.

Name	Datatype	Description
id	string	The OCID of the resource.
compartmentId	string	The OCID of the compartment that the resource belongs to.
definedTags	object	Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: {"Operations": {"CostCenter": "42"}}
description	string	Description for this resource.
displayName	string	The user-friendly display name. This must be unique within the enclosing resource, and it's changeable. Avoid entering confidential information.
freeformTags	object	Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: {"Department": "Finance"}
lifecycleState	string	The log group object state. (CREATING, ACTIVE, UPDATING, INACTIVE, DELETING, FAILED) (x-obmcs-top-level-enum: #/definitions/LogGroupLifecycleState)
timeCreated	string (date-time)	Time the resource was created.
timeLastModified	string (date-time)	Time the resource was last modified.

list

Log group configuration summary.

Name	Datatype	Description
id	string	The OCID of the resource.
compartmentId	string	The OCID of the compartment that the resource belongs to.
definedTags	object	Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: {"Operations": {"CostCenter": "42"}}
description	string	Description for this resource.
displayName	string	The user-friendly display name. This must be unique within the enclosing resource, and it's changeable. Avoid entering confidential information.
freeformTags	object	Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: {"Department": "Finance"}
lifecycleState	string	The log group object state. (CREATING, ACTIVE, UPDATING, INACTIVE, DELETING, FAILED) (x-obmcs-top-level-enum: #/definitions/LogGroupLifecycleState)
timeCreated	string (date-time)	Time the resource was created.
timeLastModified	string (date-time)	Time the resource was last modified.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	logGroupId, region	opc-request-id	Get the specified log group's information.
list	select	compartmentId, region	isCompartmentIdInSubtree, displayName, page, limit, sortBy, sortOrder, opc-request-id	Lists all log groups for the specified compartment or tenancy.
create	insert	region, compartmentId, displayName	opc-retry-token, opc-request-id	Create a new log group with a unique display name. This call fails<br />if the log group is already created with the same displayName in the compartment.<br />
update	update	logGroupId, region	if-match, opc-request-id	Updates the existing log group with the associated configuration. This call<br /> fails if the log group does not exist.<br />
delete	delete	logGroupId, region	if-match, opc-request-id	Deletes the specified log group.
change_compartment	exec	logGroupId, region	if-match, opc-request-id	Moves a log group into a different compartment within the same tenancy. When provided, the If-Match is checked against the resource ETag values.<br />For information about moving resources between compartments, see [Moving Resources Between Compartments](/iaas/Content/Identity/Tasks/managingcompartments.htm#moveRes).<br />

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
compartmentId	string	Compartment OCID to list resources in. See compartmentIdInSubtree for nested compartments traversal.
logGroupId	string	OCID of a log group to work with.
region	string	OCI region identifier (e.g. us-ashburn-1, ap-sydney-1); resolves from OCI_REGION when not supplied in the query. (default: us-ashburn-1, x-stackQL-envVar: OCI_REGION)
displayName	string	Resource name.
if-match	string	For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.
isCompartmentIdInSubtree	boolean	Specifies whether or not nested compartments should be traversed. Defaults to false.
limit	integer	When setting the page limit, specifies the maximum number of unfiltered records that can be fetched from the data store in one request. Filtering happens after the records are retrieved. Subsequent pages might include results that match the query criteria.
opc-request-id	string	Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
opc-retry-token	string	A token that uniquely identifies a request so it can be retried in case of a timeout or server error, without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations (e.g., if a resource has been deleted and purged from the system, then a retry of the original creation request may be rejected).
page	string	For list pagination. The value of the opc-next-page or opc-previous-page response header from the previous "List" call. For important details about how pagination works, see [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).
sortBy	string	The field to sort by (one column only). Default sort order is ascending exception of timeCreated and timeLastModified columns (descending).
sortOrder	string	The sort order to use, whether 'asc' or 'desc'.

SELECT examples

get

Get the specified log group's information.

SELECT
id,
compartmentId,
definedTags,
description,
displayName,
freeformTags,
lifecycleState,
timeCreated,
timeLastModified
FROM oci.logging.log_groups
WHERE logGroupId = '{{ logGroupId }}' -- required
AND region = '{{ region }}' -- required
AND opc-request-id = '{{ opc-request-id }}'
;

list

Lists all log groups for the specified compartment or tenancy.

SELECT
id,
compartmentId,
definedTags,
description,
displayName,
freeformTags,
lifecycleState,
timeCreated,
timeLastModified
FROM oci.logging.log_groups
WHERE compartmentId = '{{ compartmentId }}' -- required
AND region = '{{ region }}' -- required
AND isCompartmentIdInSubtree = '{{ isCompartmentIdInSubtree }}'
AND displayName = '{{ displayName }}'
AND page = '{{ page }}'
AND limit = '{{ limit }}'
AND sortBy = '{{ sortBy }}'
AND sortOrder = '{{ sortOrder }}'
AND opc-request-id = '{{ opc-request-id }}'
;

INSERT examples

create

Create a new log group with a unique display name. This call fails<br />if the log group is already created with the same displayName in the compartment.<br />

INSERT INTO oci.logging.log_groups (
compartmentId,
definedTags,
description,
displayName,
freeformTags,
region,
opc-retry-token,
opc-request-id
)
SELECT 
'{{ compartmentId }}' /* required */,
'{{ definedTags }}',
'{{ description }}',
'{{ displayName }}' /* required */,
'{{ freeformTags }}',
'{{ region }}',
'{{ opc-retry-token }}',
'{{ opc-request-id }}'
;

Manifest

# Description fields are for documentation purposes
- name: log_groups
props:
  - name: region
    value: "{{ region }}"
    description: Required parameter for the log_groups resource.
  - name: compartmentId
    value: "{{ compartmentId }}"
    description: |
      The OCID of the compartment that the resource belongs to.
  - name: definedTags
    value: "{{ definedTags }}"
    description: |
      Defined tags for this resource. Each key is predefined and scoped to a
      namespace. For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm).
      Example: `{"Operations": {"CostCenter": "42"}}`
  - name: description
    value: "{{ description }}"
    description: |
      Description for this resource.
  - name: displayName
    value: "{{ displayName }}"
    description: |
      The user-friendly display name. This must be unique within the enclosing resource,
      and it's changeable. Avoid entering confidential information.
  - name: freeformTags
    value: "{{ freeformTags }}"
    description: |
      Free-form tags for this resource. Each tag is a simple key-value pair with no
      predefined name, type, or namespace. For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm).
      Example: `{"Department": "Finance"}`
  - name: opc-retry-token
    value: "{{ opc-retry-token }}"
    description: A token that uniquely identifies a request so it can be retried in case of a timeout or server error, without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations (e.g., if a resource has been deleted and purged from the system, then a retry of the original creation request may be rejected). 
    description: A token that uniquely identifies a request so it can be retried in case of a timeout or server error, without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations (e.g., if a resource has been deleted and purged from the system, then a retry of the original creation request may be rejected). 
  - name: opc-request-id
    value: "{{ opc-request-id }}"
    description: Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. 
    description: Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. 

UPDATE examples

update

Updates the existing log group with the associated configuration. This call<br /> fails if the log group does not exist.<br />

UPDATE oci.logging.log_groups
SET 
definedTags = '{{ definedTags }}',
description = '{{ description }}',
displayName = '{{ displayName }}',
freeformTags = '{{ freeformTags }}'
WHERE 
logGroupId = '{{ logGroupId }}' --required
AND region = '{{ region }}' --required
AND if-match = '{{ if-match}}'
AND opc-request-id = '{{ opc-request-id}}';

DELETE examples

delete

Deletes the specified log group.

DELETE FROM oci.logging.log_groups
WHERE logGroupId = '{{ logGroupId }}' --required
AND region = '{{ region }}' --required
AND if-match = '{{ if-match }}'
AND opc-request-id = '{{ opc-request-id }}'
;

Lifecycle Methods

change_compartment

Moves a log group into a different compartment within the same tenancy. When provided, the If-Match is checked against the resource ETag values.<br />For information about moving resources between compartments, see [Moving Resources Between Compartments](/iaas/Content/Identity/Tasks/managingcompartments.htm#moveRes).<br />

EXEC oci.logging.log_groups.change_compartment 
@logGroupId='{{ logGroupId }}' --required, 
@region='{{ region }}' --required, 
@if-match='{{ if-match }}', 
@opc-request-id='{{ opc-request-id }}' 
@@json=
'{
"compartmentId": "{{ compartmentId }}"
}'
;