Cloud Logging Service, REST: Export.Update
Updates the specified export.
HTTP request
PATCH https://logging.api.cloud.yandex.net/logging/v1/exports/{exportId}
Path parameters
Field |
Description |
exportId |
string Required field. ID of the export to update. To get a export ID make a ExportService.List request. |
Body parameters
{
"updateMask": "string",
"name": "string",
"description": "string",
"labels": "string",
"groupId": "string",
"sinkId": "string",
"params": {
"resourceTypes": [
"string"
],
"resourceIds": [
"string"
],
"streamNames": [
"string"
],
"levels": [
"string"
],
"filter": "string"
}
}
Field |
Description |
updateMask |
string (field-mask) A comma-separated names off ALL fields to be updated. If |
name |
string New name of the export. |
description |
string New Description of the export. |
labels |
string New export labels as |
groupId |
string Required field. New logging Group ID logs exported from |
sinkId |
string Required field. New logging Sink ID logs exported to |
params |
Required field. New parameters for logs filtration |
ExportParams
Field |
Description |
resourceTypes[] |
string |
resourceIds[] |
string |
streamNames[] |
string |
levels[] |
enum (Level)
|
filter |
string |
Response
HTTP Code: 200 - OK
{
"id": "string",
"description": "string",
"createdAt": "string",
"createdBy": "string",
"modifiedAt": "string",
"done": "boolean",
"metadata": {
"exportId": "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",
"groupId": "string",
"sinkId": "string",
"params": {
"resourceTypes": [
"string"
],
"resourceIds": [
"string"
],
"streamNames": [
"string"
],
"levels": [
"string"
],
"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. |
createdAt |
string (date-time) Creation timestamp. String in RFC3339 To work with values in this field, use the APIs described in the |
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 To work with values in this field, use the APIs described in the |
done |
boolean If the value is |
metadata |
Service-specific metadata associated with the operation. |
error |
The error result of the operation in case of failure or cancellation. Includes only one of the fields The operation result. |
response |
The normal response of the operation in case of success. Includes only one of the fields The operation result. |
UpdateExportMetadata
Field |
Description |
exportId |
string ID of the export being updated. |
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. |
Export
Field |
Description |
id |
string Export ID. |
folderId |
string Export folder ID. |
cloudId |
string Export cloud ID. |
createdAt |
string (date-time) Export creation time. String in RFC3339 To work with values in this field, use the APIs described in the |
name |
string Export name. |
description |
string Export description. |
labels |
string Export lables. |
groupId |
string Group logs are exported from. |
sinkId |
string Sink logs are exported to. |
params |
Parameters of logs filtration. |
ExportParams
Field |
Description |
resourceTypes[] |
string |
resourceIds[] |
string |
streamNames[] |
string |
levels[] |
enum (Level)
|
filter |
string |