Подключиться
Yandex Cloud Functions

Method listOperations

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

Lists operations for the specified function.

HTTP request

GET https://serverless-functions.api.cloud.yandex.net/functions/v1/functions/{functionId}/operations

Path parameters

Parameter Description
functionId

Required. ID of the function to list operations for.

Query parameters

Parameter Description
pageSize

The maximum number of results per page that should be returned. If the number of available results is larger than pageSize, the service returns a nextPageToken that can be used to get the next page of results in subsequent list requests.

Default value: 100.

Acceptable values are 0 to 1000, inclusive.
pageToken

Page token. To get the next page of results, set pageToken to the nextPageToken returned by a previous list request.

The maximum string length in characters is 100.
filter

A filter expression that filters resources listed in the response.

The expression must specify:

  1. The field name. Currently filtering can be applied to the Operation.done, Operation.createdBy field.
  2. An = operator.
  3. The value in double quotes ("). Must be 3-63 characters long and match the regular expression [a-z][-a-z0-9]{1,61}[a-z0-9]. Examples of a filter: done=false, created_by='John.Doe'.

The maximum string length in characters is 1000.

Response

HTTP Code: 200 - OK

{
  "operations": [
    {
      "id": "string",
      "description": "string",
      "createdAt": "string",
      "createdBy": "string",
      "modifiedAt": "string",
      "done": true,
      "metadata": "object",

      // `operations[]` includes only one of the fields `error`, `response`
      "error": {
        "code": "integer",
        "message": "string",
        "details": [
          "object"
        ]
      },
      "response": "object",
      // end of the list of possible fields`operations[]`

    }
  ],
  "nextPageToken": "string"
}
Field Description
operations[] object

List of operations for the specified function.
operations[].
id		 string

ID of the operation.
operations[].
description		 string

Description of the operation. 0-256 characters long.
operations[].
createdAt		 string (date-time)

Creation timestamp.

String in RFC3339 text format.
operations[].
createdBy		 string

ID of the user or service account who initiated the operation.
operations[].
modifiedAt		 string (date-time)

The time when the Operation resource was last modified.

String in RFC3339 text format.
operations[].
done		 boolean (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.
operations[].
metadata		 object

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.
operations[].
error		 object
The error result of the operation in case of failure or cancellation.
operations[] includes only one of the fields error, response
operations[].
error.
code		 integer (int32)

Error code. An enum value of google.rpc.Code.
operations[].
error.
message		 string

An error message.
operations[].
error.
details[]		 object

A list of messages that carry the error details.
operations[].
response		 object
operations[] includes only one of the fields error, response

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.
nextPageToken string

Token for getting the next page of the list. If the number of results is greater than the specified pageSize, use nextPageToken as the value for the pageToken parameter in the next list request.

Each subsequent page will have its own nextPageToken to continue paging through the results.
В этой статье: