Cloud Logging Service, REST: LogGroup.Create

Статья создана

Обновлена 17 октября 2024 г.

HTTP request
Body parameters
Response
CreateLogGroupMetadata
Status
LogGroup

Creates a log group in the specified folder.

HTTP request

POST https://logging.api.cloud.yandex.net/logging/v1/logGroups

Body parameters

{
  "folderId": "string",
  "name": "string",
  "description": "string",
  "labels": "string",
  "retentionPeriod": "string",
  "dataStream": "string"
}

Field	Description
folderId	string Required field. ID of the folder to create a log group in. To get a folder ID make a yandex.cloud.resourcemanager.v1.FolderService.List request.
name	string Name of the log group. The name must be unique within the folder.
description	string Description of the log group.
labels	string Log group labels as `key:value` pairs.
retentionPeriod	string (duration) Log group entry retention period. Entries will be present in group during this period. If specified, must be non-negative. Empty or zero value is treated as no limit.
dataStream	string If specified, all log records will be written to this data stream

Response

HTTP Code: 200 - OK

{
  "id": "string",
  "description": "string",
  "createdAt": "string",
  "createdBy": "string",
  "modifiedAt": "string",
  "done": "boolean",
  "metadata": {
    "logGroupId": "string"
  },
  // Includes only one of the fields `error`, `response`
  "error": {
    "code": "integer",
    "message": "string",
    "details": [
      "object"
    ]
  },
  "response": {
    "id": "string",
    "folderId": "string",
    "cloudId": "string",
    "createdAt": "string",
    "name": "string",
    "description": "string",
    "labels": "string",
    "status": "string",
    "retentionPeriod": "string",
    "dataStream": "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.
createdAt	string (date-time) Creation timestamp. String in RFC3339 text format. The range of possible values is from `0001-01-01T00:00:00Z` to `9999-12-31T23:59:59.999999999Z`, i.e. from 0 to 9 digits for fractions of a second. To work with values in this field, use the APIs described in the Protocol Buffers reference. In some languages, built-in datetime utilities do not support nanosecond precision (9 digits).
createdBy	string ID of the user or service account who initiated the operation.
modifiedAt	string (date-time) The time when the Operation resource was last modified. String in RFC3339 text format. The range of possible values is from `0001-01-01T00:00:00Z` to `9999-12-31T23:59:59.999999999Z`, i.e. from 0 to 9 digits for fractions of a second. To work with values in this field, use the APIs described in the Protocol Buffers reference. In some languages, built-in datetime utilities do not support nanosecond precision (9 digits).
done	boolean 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	CreateLogGroupMetadata 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	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	LogGroup 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.

CreateLogGroupMetadata

Field

Description

logGroupId

string

ID of the log group being created.

Status

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

Field	Description
code	integer (int32) Error code. An enum value of google.rpc.Code.
message	string An error message.
details[]	object A list of messages that carry the error details.

LogGroup

Field	Description
id	string Log group ID.
folderId	string Log group folder ID.
cloudId	string Log group cloud ID.
createdAt	string (date-time) Log group creation time. String in RFC3339 text format. The range of possible values is from `0001-01-01T00:00:00Z` to `9999-12-31T23:59:59.999999999Z`, i.e. from 0 to 9 digits for fractions of a second. To work with values in this field, use the APIs described in the Protocol Buffers reference. In some languages, built-in datetime utilities do not support nanosecond precision (9 digits).
name	string Log group name.
description	string Log group description.
labels	string Log group labels.
status	enum (Status) Status of the log group. `STATUS_UNSPECIFIED`: Unknown status. Should never occur. `CREATING`: Log group is creating. `ACTIVE`: Log group is ready to accept messages, `DELETING`: Log group is being deleted. No messages will be accepted. `ERROR`: Log group is in failed state.
retentionPeriod	string (duration) Log group entry retention period. Entries will be present in group during this period.
dataStream	string Data stream name

Cloud Logging Service, REST: LogGroup.Create

HTTP requestHTTP request

Body parametersBody parameters

ResponseResponse

CreateLogGroupMetadataCreateLogGroupMetadata

StatusStatus

LogGroupLogGroup