2026-01-27
▼ ▲ observability.organizations.locations.get
Description : Gets information about a location.
Path : v1/{+name}
Flat Path : v1/organizations/{organizationsId}/locations/{locationsId}
Parameters :
name
Type : string
Location : path
Pattern : ^organizations/[^/]+/locations/[^/]+$
Required : Yes
Description : Resource name for the location.
Scopes : https://www.googleapis.com/auth/cloud-platform
HTTP Method : GET
Parameter Order : name
▼ ▲ observability.organizations.locations.list
Description : Lists information about the supported locations for this service.
Flat Path : v1/organizations/{organizationsId}/locations
Parameters :
extraLocationTypes
Description : Optional. Do not use this field. It is unsupported and is ignored unless explicitly documented otherwise. This is primarily for internal usage.
Type : string
Repeated : Yes
Location : query
pageSize
Description : The maximum number of results to return. If not set, the service selects a default.
Format : int32
Type : integer
Location : query
filter
Location : query
Description : A filter to narrow down results to a preferred subset. The filtering language accepts strings like `"displayName=tokyo"`, and is documented in more detail in [AIP-160](https://google.aip.dev/160).
Type : string
pageToken
Description : A page token received from the `next_page_token` field in the response. Send that page token to receive the subsequent page.
Location : query
Type : string
name
Type : string
Location : path
Description : The resource that owns the locations collection, if applicable.
Required : Yes
Pattern : ^organizations/[^/]+$
Scopes : https://www.googleapis.com/auth/cloud-platform
HTTP Method : GET
Path : v1/{+name}/locations
Parameter Order : name
▼ ▲ observability.organizations.locations.operations.cancel
Flat Path : v1/organizations/{organizationsId}/locations/{locationsId}/operations/{operationsId}:cancel
Path : v1/{+name}:cancel
Parameter Order : name
Parameters :
name
Type : string
Required : Yes
Location : path
Pattern : ^organizations/[^/]+/locations/[^/]+/operations/[^/]+$
Description : The name of the operation resource to be cancelled.
Description : Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.
HTTP Method : POST
▼ ▲ observability.organizations.locations.operations.get
Parameter Order : name
HTTP Method : GET
Scopes : https://www.googleapis.com/auth/cloud-platform
Path : v1/{+name}
Parameters :
name
Required : Yes
Location : path
Pattern : ^organizations/[^/]+/locations/[^/]+/operations/[^/]+$
Type : string
Description : The name of the operation resource.
Description : Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.
Flat Path : v1/organizations/{organizationsId}/locations/{locationsId}/operations/{operationsId}
▼ ▲ observability.organizations.locations.operations.list
Scopes : https://www.googleapis.com/auth/cloud-platform
Path : v1/{+name}/operations
Description : Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.
Parameter Order : name
Flat Path : v1/organizations/{organizationsId}/locations/{locationsId}/operations
Parameters :
filter
Description : The standard list filter.
Type : string
Location : query
name
Type : string
Description : The name of the operation's parent resource.
Pattern : ^organizations/[^/]+/locations/[^/]+$
Location : path
Required : Yes
pageToken
Location : query
Description : The standard list page token.
Type : string
returnPartialSuccess
Type : boolean
Description : When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the ListOperationsResponse.unreachable field. This can only be `true` when reading across collections. For example, when `parent` is set to `"projects/example/locations/-"`. This field is not supported by default and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.
Location : query
pageSize
Description : The standard list page size.
Location : query
Format : int32
Type : integer
HTTP Method : GET
▼ ▲ observability.organizations.locations.operations.delete
Description : Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.
Path : v1/{+name}
Parameters :
name
Type : string
Location : path
Pattern : ^organizations/[^/]+/locations/[^/]+/operations/[^/]+$
Description : The name of the operation resource to be deleted.
Required : Yes
Flat Path : v1/organizations/{organizationsId}/locations/{locationsId}/operations/{operationsId}
HTTP Method : DELETE
Scopes : https://www.googleapis.com/auth/cloud-platform
Parameter Order : name
▼ ▲ observability.folders.locations.get
Flat Path : v1/folders/{foldersId}/locations/{locationsId}
Parameters :
name
Type : string
Description : Resource name for the location.
Location : path
Required : Yes
Pattern : ^folders/[^/]+/locations/[^/]+$
HTTP Method : GET
Parameter Order : name
Path : v1/{+name}
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Gets information about a location.
▼ ▲ observability.folders.locations.list
Scopes : https://www.googleapis.com/auth/cloud-platform
Flat Path : v1/folders/{foldersId}/locations
Path : v1/{+name}/locations
Parameter Order : name
Description : Lists information about the supported locations for this service.
Parameters :
pageToken
Type : string
Description : A page token received from the `next_page_token` field in the response. Send that page token to receive the subsequent page.
Location : query
pageSize
Location : query
Description : The maximum number of results to return. If not set, the service selects a default.
Type : integer
Format : int32
filter
Description : A filter to narrow down results to a preferred subset. The filtering language accepts strings like `"displayName=tokyo"`, and is documented in more detail in [AIP-160](https://google.aip.dev/160).
Location : query
Type : string
name
Location : path
Pattern : ^folders/[^/]+$
Type : string
Description : The resource that owns the locations collection, if applicable.
Required : Yes
extraLocationTypes
Description : Optional. Do not use this field. It is unsupported and is ignored unless explicitly documented otherwise. This is primarily for internal usage.
Repeated : Yes
Type : string
Location : query
HTTP Method : GET
▼ ▲ observability.folders.locations.operations.list
Path : v1/{+name}/operations
Flat Path : v1/folders/{foldersId}/locations/{locationsId}/operations
Description : Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.
Parameters :
filter
Location : query
Description : The standard list filter.
Type : string
name
Type : string
Required : Yes
Location : path
Description : The name of the operation's parent resource.
Pattern : ^folders/[^/]+/locations/[^/]+$
pageToken
Description : The standard list page token.
Location : query
Type : string
returnPartialSuccess
Description : When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the ListOperationsResponse.unreachable field. This can only be `true` when reading across collections. For example, when `parent` is set to `"projects/example/locations/-"`. This field is not supported by default and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.
Location : query
Type : boolean
pageSize
Format : int32
Description : The standard list page size.
Location : query
Type : integer
HTTP Method : GET
Scopes : https://www.googleapis.com/auth/cloud-platform
Parameter Order : name
▼ ▲ observability.folders.locations.operations.cancel
Parameter Order : name
Description : Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.
Scopes : https://www.googleapis.com/auth/cloud-platform
HTTP Method : POST
Path : v1/{+name}:cancel
Parameters :
name
Description : The name of the operation resource to be cancelled.
Required : Yes
Type : string
Pattern : ^folders/[^/]+/locations/[^/]+/operations/[^/]+$
Location : path
Flat Path : v1/folders/{foldersId}/locations/{locationsId}/operations/{operationsId}:cancel
▼ ▲ observability.folders.locations.operations.get
Description : Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.
Flat Path : v1/folders/{foldersId}/locations/{locationsId}/operations/{operationsId}
Parameters :
name
Pattern : ^folders/[^/]+/locations/[^/]+/operations/[^/]+$
Description : The name of the operation resource.
Required : Yes
Location : path
Type : string
HTTP Method : GET
Parameter Order : name
Scopes : https://www.googleapis.com/auth/cloud-platform
Path : v1/{+name}
▼ ▲ observability.folders.locations.operations.delete
HTTP Method : DELETE
Description : Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.
Parameter Order : name
Scopes : https://www.googleapis.com/auth/cloud-platform
Path : v1/{+name}
Flat Path : v1/folders/{foldersId}/locations/{locationsId}/operations/{operationsId}
Parameters :
name
Required : Yes
Type : string
Location : path
Description : The name of the operation resource to be deleted.
Pattern : ^folders/[^/]+/locations/[^/]+/operations/[^/]+$