Contact UsGet started

Cloud Logging Service, gRPC: ExportService.Create

Written by
Updated at December 17, 2024

Creates a export in the specified folder.

gRPC request

rpc Create (CreateExportRequest) returns (operation.Operation)

CreateExportRequest

{
  "folder_id": "string",
  "name": "string",
  "description": "string",
  "labels": "map<string, string>",
  "group_id": "string",
  "sink_id": "string",
  "params": {
    "resource_types": [
      "string"
    ],
    "resource_ids": [
      "string"
    ],
    "stream_names": [
      "string"
    ],
    "levels": [
      "Level"
    ],
    "filter": "string"
  }
}

Field

Description

folder_id

string

Required field. ID of the folder to create a export in.

To get a folder ID make a yandex.cloud.resourcemanager.v1.FolderService.List request.

name

string

Name of the export.
The name must be unique within the folder.

description

string

Description of the export.

labels

object (map<string, string>)

Export labels as key:value pairs.

group_id

string

Required field. Logging Group ID logs exported from

sink_id

string

Required field. Logging Sink ID logs exported to

params

ExportParams

Required field. Parameters for logs filtration

ExportParams

Field

Description

resource_types[]

string

resource_ids[]

string

stream_names[]

string

levels[]

enum Level

  • LEVEL_UNSPECIFIED: Default log level.

    Equivalent to not specifying log level at all.

  • TRACE: Trace log level.

    Possible use case: verbose logging of some business logic.

  • DEBUG: Debug log level.

    Possible use case: debugging special cases in application logic.

  • INFO: Info log level.

    Mostly used for information messages.

  • WARN: Warn log level.

    May be used to alert about significant events.

  • ERROR: Error log level.

    May be used to alert about errors in infrastructure, logic, etc.

  • FATAL: Fatal log level.

    May be used to alert about unrecoverable failures and events.

filter

string

operation.Operation

{
  "id": "string",
  "description": "string",
  "created_at": "google.protobuf.Timestamp",
  "created_by": "string",
  "modified_at": "google.protobuf.Timestamp",
  "done": "bool",
  "metadata": {
    "export_id": "string"
  },
  // Includes only one of the fields `error`, `response`
  "error": "google.rpc.Status",
  "response": {
    "id": "string",
    "folder_id": "string",
    "cloud_id": "string",
    "created_at": "google.protobuf.Timestamp",
    "name": "string",
    "description": "string",
    "labels": "map<string, string>",
    "group_id": "string",
    "sink_id": "string",
    "params": {
      "resource_types": [
        "string"
      ],
      "resource_ids": [
        "string"
      ],
      "stream_names": [
        "string"
      ],
      "levels": [
        "Level"
      ],
      "filter": "string"
    }
  }
  // end of the list of possible fields
}

An Operation resource. For more information, see Operation.

Field

Description

id

string

ID of the operation.

description

string

Description of the operation. 0-256 characters long.

created_at

google.protobuf.Timestamp

Creation timestamp.

created_by

string

ID of the user or service account who initiated the operation.

modified_at

google.protobuf.Timestamp

The time when the Operation resource was last modified.

done

bool

If the value is false, it means the operation is still in progress.
If true, the operation is completed, and either error or response is available.

metadata

CreateExportMetadata

Service-specific metadata associated with the operation.
It typically contains the ID of the target resource that the operation is performed on.
Any method that returns a long-running operation should document the metadata type, if any.

error

google.rpc.Status

The error result of the operation in case of failure or cancellation.

Includes only one of the fields error, response.

The operation result.
If done == false and there was no failure detected, neither error nor response is set.
If done == false and there was a failure detected, error is set.
If done == true, exactly one of error or response is set.

response

Export

The normal response of the operation in case of success.
If the original method returns no data on success, such as Delete,
the response is google.protobuf.Empty.
If the original method is the standard Create/Update,
the response should be the target resource of the operation.
Any method that returns a long-running operation should document the response type, if any.

Includes only one of the fields error, response.

The operation result.
If done == false and there was no failure detected, neither error nor response is set.
If done == false and there was a failure detected, error is set.
If done == true, exactly one of error or response is set.

CreateExportMetadata

Field

Description

export_id

string

ID of the export being created.

Export

Field

Description

id

string

Export ID.

folder_id

string

Export folder ID.

cloud_id

string

Export cloud ID.

created_at

google.protobuf.Timestamp

Export creation time.

name

string

Export name.

description

string

Export description.

labels

object (map<string, string>)

Export lables.

group_id

string

Group logs are exported from.

sink_id

string

Sink logs are exported to.

params

ExportParams

Parameters of logs filtration.

ExportParams

Field

Description

resource_types[]

string

resource_ids[]

string

stream_names[]

string

levels[]

enum Level

  • LEVEL_UNSPECIFIED: Default log level.

    Equivalent to not specifying log level at all.

  • TRACE: Trace log level.

    Possible use case: verbose logging of some business logic.

  • DEBUG: Debug log level.

    Possible use case: debugging special cases in application logic.

  • INFO: Info log level.

    Mostly used for information messages.

  • WARN: Warn log level.

    May be used to alert about significant events.

  • ERROR: Error log level.

    May be used to alert about errors in infrastructure, logic, etc.

  • FATAL: Fatal log level.

    May be used to alert about unrecoverable failures and events.

filter

string
Previous
List
Next
Update