Compute Cloud API, gRPC: PlacementGroupService.ListOperations

Written by

Yandex Cloud

Updated at November 26, 2024

gRPC request
ListPlacementGroupOperationsRequest
ListPlacementGroupOperationsResponse
Operation

Lists operations for the specified placement group.

gRPC request

rpc ListOperations (ListPlacementGroupOperationsRequest) returns (ListPlacementGroupOperationsResponse)

ListPlacementGroupOperationsRequest

{
  "placement_group_id": "string",
  "page_size": "int64",
  "page_token": "string"
}

Field	Description
placement_group_id	string ID of the placement group to list operations for. To get the placement group ID, use PlacementGroupService.List request.
page_size	int64 The maximum number of results per page to return. If the number of available results is larger than `page_size`, the service returns a ListPlacementGroupOperationsResponse.next_page_token that can be used to get the next page of results in subsequent list requests.
page_token	string Page token. To get the next page of results, set `page_token` to the ListPlacementGroupOperationsResponse.next_page_token returned by a previous list request.

ListPlacementGroupOperationsResponse

{
  "operations": [
    {
      "id": "string",
      "description": "string",
      "created_at": "google.protobuf.Timestamp",
      "created_by": "string",
      "modified_at": "google.protobuf.Timestamp",
      "done": "bool",
      "metadata": "google.protobuf.Any",
      // Includes only one of the fields `error`, `response`
      "error": "google.rpc.Status",
      "response": "google.protobuf.Any"
      // end of the list of possible fields
    }
  ],
  "next_page_token": "string"
}

Field

Description

operations[]

Operation

List of operations for the specified placement group.

next_page_token

string

This token allows you to get the next page of results for list requests. If the number of results
is larger than ListPlacementGroupOperationsRequest.page_size, use the next_page_token as the value
for the ListPlacementGroupOperationsRequest.page_token query parameter in the next list request.
Each subsequent list request will have its own next_page_token to continue paging through the results.

Operation

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	google.protobuf.Any 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	google.protobuf.Any 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.

Compute Cloud API, gRPC: PlacementGroupService.ListOperations

gRPC requestgRPC request

ListPlacementGroupOperationsRequestListPlacementGroupOperationsRequest

ListPlacementGroupOperationsResponseListPlacementGroupOperationsResponse

OperationOperation

Was the article helpful?

gRPC request

ListPlacementGroupOperationsRequest

ListPlacementGroupOperationsResponse

Operation