Network Management API (networkmanagement:v1)

▼ ▲ networkmanagement.projects.locations.global.operations.list

Parameters :

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 e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.

Location : query

Type : boolean

▼ ▲ networkmanagement.organizations.locations.operations.list

Parameters :

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 e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.

Location : query

Type : boolean

▼ ▲ networkmanagement.projects.locations.networkMonitoringProviders.list

Path : v1/{+parent}/networkMonitoringProviders

Flat Path : v1/projects/{projectsId}/locations/{locationsId}/networkMonitoringProviders

HTTP Method : GET

Parameters :

parent

Description : Required. Parent value for ListNetworkMonitoringProvidersRequest. Format: `projects/{project}/locations/{location}`

Pattern : ^projects/[^/]+/locations/[^/]+$

Location : path

Required : Yes

Type : string

pageSize

Description : Optional. The maximum number of monitoring points to return. The service may return fewer than this value. If unspecified, at most 20 monitoring points will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.

Location : query

Type : integer

Format : int32

pageToken

Description : Optional. A page token, received from a previous `ListMonitoringPoints` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListMonitoringPoints` must match the call that provided the page token.

Location : query

Type : string

Parameter Order : parent

Scopes : https://www.googleapis.com/auth/cloud-platform

Description : Lists NetworkMonitoringProviders for a given project and location.

▼ ▲ networkmanagement.projects.locations.networkMonitoringProviders.get

Path : v1/{+name}

Flat Path : v1/projects/{projectsId}/locations/{locationsId}/networkMonitoringProviders/{networkMonitoringProvidersId}

HTTP Method : GET

Parameters :

name

Description : Required. Name of the resource. Format: `projects/{project}/locations/{location}/networkMonitoringProviders/{network_monitoring_provider}`

Pattern : ^projects/[^/]+/locations/[^/]+/networkMonitoringProviders/[^/]+$

Location : path

Required : Yes

Type : string

Parameter Order : name

Scopes : https://www.googleapis.com/auth/cloud-platform

Description : Gets the NetworkMonitoringProvider resource.

▼ ▲ networkmanagement.projects.locations.networkMonitoringProviders.create

Path : v1/{+parent}/networkMonitoringProviders

Flat Path : v1/projects/{projectsId}/locations/{locationsId}/networkMonitoringProviders

HTTP Method : POST

Parameters :

parent

Description : Required. Parent value for CreateNetworkMonitoringProviderRequest. Format: projects/{project}/locations/{location}

Pattern : ^projects/[^/]+/locations/[^/]+$

Location : path

Required : Yes

Type : string

networkMonitoringProviderId

Description : Required. The ID to use for the NetworkMonitoringProvider resource, which will become the final component of the NetworkMonitoringProvider resource's name.

Location : query

Type : string

Parameter Order : parent

Scopes : https://www.googleapis.com/auth/cloud-platform

Description : Creates a NetworkMonitoringProvider resource.

▼ ▲ networkmanagement.projects.locations.networkMonitoringProviders.delete

Path : v1/{+name}

Flat Path : v1/projects/{projectsId}/locations/{locationsId}/networkMonitoringProviders/{networkMonitoringProvidersId}

HTTP Method : DELETE

Parameters :

name

Description : Required. Name of the resource. Format: projects/{project}/locations/{location}/networkMonitoringProviders/{network_monitoring_provider}

Pattern : ^projects/[^/]+/locations/[^/]+/networkMonitoringProviders/[^/]+$

Location : path

Required : Yes

Type : string

Parameter Order : name

Scopes : https://www.googleapis.com/auth/cloud-platform

Description : Deletes a NetworkMonitoringProvider resource and all of its child resources.

▼ ▲ networkmanagement.projects.locations.networkMonitoringProviders.monitoringPoints.list

Path : v1/{+parent}/monitoringPoints

Flat Path : v1/projects/{projectsId}/locations/{locationsId}/networkMonitoringProviders/{networkMonitoringProvidersId}/monitoringPoints

HTTP Method : GET

Parameters :

parent

Description : Required. Parent value for ListMonitoringPointsRequest. Format: projects/{project}/locations/{location}/networkMonitoringProviders/{network_monitoring_provider}

Pattern : ^projects/[^/]+/locations/[^/]+/networkMonitoringProviders/[^/]+$

Location : path

Required : Yes

Type : string

pageSize

Description : Optional. The maximum number of monitoring points to return. The service may return fewer than this value. If unspecified, at most 20 monitoring points will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.

Location : query

Type : integer

Format : int32

pageToken

Description : Optional. A page token, received from a previous `ListMonitoringPoints` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListMonitoringPoints` must match the call that provided the page token.

Location : query

Type : string

Parameter Order : parent

Scopes : https://www.googleapis.com/auth/cloud-platform

Description : Lists MonitoringPoints for a given network monitoring provider.

▼ ▲ networkmanagement.projects.locations.networkMonitoringProviders.monitoringPoints.get

Path : v1/{+name}

Flat Path : v1/projects/{projectsId}/locations/{locationsId}/networkMonitoringProviders/{networkMonitoringProvidersId}/monitoringPoints/{monitoringPointsId}

HTTP Method : GET

Parameters :

name

Description : Required. Name of the resource. Format: projects/{project}/locations/{location}/networkMonitoringProviders/{network_monitoring_provider}/monitoringPoints/{monitoring_point}

Pattern : ^projects/[^/]+/locations/[^/]+/networkMonitoringProviders/[^/]+/monitoringPoints/[^/]+$

Location : path

Required : Yes

Type : string

Parameter Order : name

Scopes : https://www.googleapis.com/auth/cloud-platform

Description : Gets the MonitoringPoint resource.

▼ ▲ networkmanagement.projects.locations.networkMonitoringProviders.networkPaths.list

Path : v1/{+parent}/networkPaths

Flat Path : v1/projects/{projectsId}/locations/{locationsId}/networkMonitoringProviders/{networkMonitoringProvidersId}/networkPaths

HTTP Method : GET

Parameters :

parent

Description : Required. Parent value for ListNetworkPathsRequest. Format: projects/{project}/locations/{location}/networkMonitoringProviders/{network_monitoring_provider}

Pattern : ^projects/[^/]+/locations/[^/]+/networkMonitoringProviders/[^/]+$

Location : path

Required : Yes

Type : string

pageSize

Description : Optional. The maximum number of network paths to return. The service may return fewer than this value. If unspecified, at most 20 network pathswill be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.

Location : query

Type : integer

Format : int32

pageToken

Description : Optional. A page token, received from a previous `ListNetworkPaths` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListNetworkPaths` must match the call that provided the page token.

Location : query

Type : string

Parameter Order : parent

Scopes : https://www.googleapis.com/auth/cloud-platform

Description : Lists NetworkPaths for a given network monitoring provider.

▼ ▲ networkmanagement.projects.locations.networkMonitoringProviders.networkPaths.get

Path : v1/{+name}

Flat Path : v1/projects/{projectsId}/locations/{locationsId}/networkMonitoringProviders/{networkMonitoringProvidersId}/networkPaths/{networkPathsId}

HTTP Method : GET

Parameters :

name

Description : Required. Name of the resource. Format: projects/{project}/locations/{location}/networkMonitoringProviders/{network_monitoring_provider}/networkPaths/{network_path}

Pattern : ^projects/[^/]+/locations/[^/]+/networkMonitoringProviders/[^/]+/networkPaths/[^/]+$

Location : path

Required : Yes

Type : string

Parameter Order : name

Scopes : https://www.googleapis.com/auth/cloud-platform

Description : Gets the NetworkPath resource.

▼ ▲ networkmanagement.projects.locations.networkMonitoringProviders.webPaths.list

Path : v1/{+parent}/webPaths

Flat Path : v1/projects/{projectsId}/locations/{locationsId}/networkMonitoringProviders/{networkMonitoringProvidersId}/webPaths

HTTP Method : GET

Parameters :

parent

Description : Required. Parent value for ListWebPathsRequest. Format: projects/{project}/locations/{location}/networkMonitoringProviders/{network_monitoring_provider}

Pattern : ^projects/[^/]+/locations/[^/]+/networkMonitoringProviders/[^/]+$

Location : path

Required : Yes

Type : string

pageSize

Description : Optional. The maximum number of web paths to return. The service may return fewer than this value. If unspecified, at most 20 web paths will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.

Location : query

Type : integer

Format : int32

pageToken

Description : Optional. A page token, received from a previous `ListWebPaths` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListWebPaths` must match the call that provided the page token.

Location : query

Type : string

Parameter Order : parent

Scopes : https://www.googleapis.com/auth/cloud-platform

Description : Lists WebPaths for a given network monitoring provider.

▼ ▲ networkmanagement.projects.locations.networkMonitoringProviders.webPaths.get

Path : v1/{+name}

Flat Path : v1/projects/{projectsId}/locations/{locationsId}/networkMonitoringProviders/{networkMonitoringProvidersId}/webPaths/{webPathsId}

HTTP Method : GET

Parameters :

name

Description : Required. Name of the resource.. Format: projects/{project}/locations/{location}/networkMonitoringProviders/{network_monitoring_provider}/webPaths/{web_path}

Pattern : ^projects/[^/]+/locations/[^/]+/networkMonitoringProviders/[^/]+/webPaths/[^/]+$

Location : path

Required : Yes

Type : string

Parameter Order : name

Scopes : https://www.googleapis.com/auth/cloud-platform

Description : Gets the WebPath resource.