Managed Service for MongoDB API, gRPC: ChangeFreezeService.List
Lists change freezes by conditions, specified in request.
gRPC request
rpc List (maintenance.v2.ListChangeFreezesRequest) returns (maintenance.v2.ListChangeFreezesResponse)
maintenance.v2.ListChangeFreezesRequest
{
"resource_path": [
{
"id": "string",
"type": "string"
}
],
"page_size": "int64",
"page_token": "string",
"filter": "string"
}
|
Field |
Description |
|
resource_path[] |
Full path to the resource to list change freezes for. The number of elements must be in the range 1-128. |
|
page_size |
int64 The maximum number of change freezes to return per response. The maximum value is 1000. |
|
page_token |
string Token to retrieve the next page of results. Omitted on the first request. The maximum string length in characters is 500. |
|
filter |
string Filter list by various fields. The maximum string length in characters is 300. |
Resource
|
Field |
Description |
|
id |
string ID of the resource |
|
type |
string The type of the resource, e.g. resource-manager.cloud, resource-manager.folder, compute.instance, etc. |
maintenance.v2.ListChangeFreezesResponse
{
"change_freezes": [
{
"id": "string",
"resource_path": [
{
"id": "string",
"type": "string"
}
],
"start_at": "google.protobuf.Timestamp",
"end_at": "google.protobuf.Timestamp",
"duration_seconds": "int64",
"reason": "string",
"created_by": "string",
"created_at": "google.protobuf.Timestamp",
"status": "Status",
"updated_by": "string",
"updated_at": "google.protobuf.Timestamp"
}
],
"next_page_token": "string"
}
|
Field |
Description |
|
change_freezes[] |
List of change freezes. |
|
next_page_token |
string Token to retrieve the next page of results. |
ChangeFreeze
|
Field |
Description |
|
id |
string ID of the change freeze. |
|
resource_path[] |
Full path to the resource affected by the change freeze, |
|
start_at |
The time when the change freeze is scheduled to start. |
|
end_at |
The time when the change freeze is scheduled to end. |
|
duration_seconds |
int64 Duration of the change freeze in seconds. |
|
reason |
string Reason for the change freeze. |
|
created_by |
string The user who created the change freeze. |
|
created_at |
The creation time of the change freeze. |
|
status |
enum Status Status of the change freeze.
|
|
updated_by |
string The user who last updated the change freeze. |
|
updated_at |
The time when the change freeze was last updated. |
Resource
|
Field |
Description |
|
id |
string ID of the resource |
|
type |
string The type of the resource, e.g. resource-manager.cloud, resource-manager.folder, compute.instance, etc. |