Overview

This API reference is organized by resource. To perform an operation on a resource, make a remote procedure call (RPC). For more information, see the documentation on the Yandex Cloud API concepts.

Processing responses of mutating operationsProcessing responses of mutating operations

Any operations that change the state of a resource are asynchronous signature operations. When they are called, the server returns the Operation object.

The Operation object contains information about the operation: its status, ID, creation date, etc. You can use this object for operation status monitoring. The operation status is displayed in the done field. Once the operation is completed, the done field value changes to true. Currently, all operations are synchronous and return done=true or an error.

If an error occurs while performing an asynchronous operation, the server aborts all running procedures. The error field describing the error is added to the Operation object.

If the Operation object is returned in response to your request, proceed as follows:

• Check that done=true.
• Check that the error field contains no errors.
• Get a response from the response field.

Error example:

code: 6
message: "ALREADY_EXISTS: Name must be uniq in parentId"

Handling errorsHandling errors

If an error occurs, the Monitoring API returns the gRPC status != OK. The response body contains a detailed error description in the following format:

code: <number> error code
message: <string>  error message

Sample error message:

code: 6
message: "ALREADY_EXISTS: Name must be uniq in parentId"

Currently, there is no fixed list of error codes, so the code field is reserved for use in future Monitoring versions.

Object update conflictsObject update conflicts

To resolve conflicts that may occur while updating objects, the optional etag field is used. You can provide it in mutating operations and get it using the Get method. An object will be modified if, during the request, it is not updated by another concurrent request, and the operation's etag matches the server value. If an error occurs, get a new etag and retry the operation.

etag: Optional field. If it is not provided, the last-write-wins policy applies.