Network Management API (networkmanagement:v1)

Additions

Methods


• ▼ ▲ 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

  force

  Description : Optional. If set to true, any nested MonitoringPoints, NetworkPaths and WebPaths resources from this NetworkMonitoringProvider will also be deleted. Otherwise, the request will only work if there are no nested resources.

  Location : query

  Type : boolean

  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.generateProviderAccessToken

  Path : v1/{+name}:generateProviderAccessToken

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

  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

  gcpAccessToken

  Description : Required. Google access token.

  Location : query

  Type : string

  Parameter Order : name

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

  Description : Generates a provider access token for a given Google access token. Provider access token is a short-lived token that is used to access resources in the provider's platform.

• ▼ ▲ networkmanagement.projects.locations.networkMonitoringProviders.generateMonitoringPointConfig

  Path : v1/{+name}:generateMonitoringPointConfig

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

  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 : Generates Monitoring Point configuration of a NetworkMonitoringProvider resource.

• ▼ ▲ networkmanagement.projects.locations.networkMonitoringProviders.monitoringPoints.downloadInstallScript

  Path : v1/{+parent}/monitoringPoints:downloadInstallScript

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

  HTTP Method : GET

  Parameters :

  parent

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

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

  Location : path

  Required : Yes

  Type : string

  monitoringPointType

  Description : Required. The type of the monitoring point.

  Location : query

  Type : string

  Enum Descriptions :

  • This value should not be used.
  • Monitoring Point that runs in a Docker container.
  • Monitoring Point that runs in a Kernel-based Virtual Machine (KVM) hypervisor.
  • Monitoring Point that runs in a VMware hypervisor.
  • Monitoring Point that runs on a K8S Helm.
  • Monitoring Point that runs as a startup script in a Compute Engine VM.

  Enum :

  • MONITORING_POINT_TYPE_UNSPECIFIED
  • CONTAINER
  • KVM
  • VMWARE
  • HELM
  • GCE_VM

  hostname

  Description : Required. The hostname of the MonitoringPoint, e.g. "test-vm"

  Location : query

  Type : string

  timeZone.id

  Description : IANA Time Zone Database time zone. For example "America/New_York".

  Location : query

  Type : string

  timeZone.version

  Description : Optional. IANA Time Zone Database version number. For example "2019a".

  Location : query

  Type : string

  useDhcp

  Description : Optional. Dynamic Host Configuration Protocol, is a network management protocol that automatically assigns IP addresses and other network configuration parameters to devices connecting to a network.

  Location : query

  Type : boolean

  staticIpAddress.ipAddress

  Description : Required. IP address of the MonitoringPoint.

  Location : query

  Type : string

  staticIpAddress.netmask

  Description : Optional. Networkmask and CIDR range. Example: "255.255.255.0/24"

  Location : query

  Type : string

  staticIpAddress.gatewayAddress

  Description : Required. Gateway IP address. Example: "100.80.40.1".

  Location : query

  Type : string

  staticIpAddress.dnsServerAddress

  Description : Required. DNS server.

  Location : query

  Type : string

  staticIpAddress.dnsServerSecondaryAddress

  Description : Optional. Second DNS server.

  Location : query

  Type : string

  staticIpAddress.domain

  Description : Optional. Domain name of the MonitoringPoint.

  Location : query

  Type : string

  ntpServerAddress

  Description : Optional. Network Time Protocol a user can configure. If the user omits the field, the default is either NTP servers provided in the DHCP lease or a set of well-known NTP servers pre-configured on the monitoring point. This field can be an IP address or FQDN.

  Location : query

  Type : string

  ntpServerSecondaryAddress

  Description : Optional. Second NTP server.

  Location : query

  Type : string

  Parameter Order : parent

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

  Description : Downloads an install script for MonitoringPoints for a given network monitoring provider.

• ▼ ▲ networkmanagement.projects.locations.networkMonitoringProviders.monitoringPoints.downloadRecreateInstallScript

  Path : v1/{+name}:downloadRecreateInstallScript

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

  HTTP Method : GET

  Parameters :

  name

  Description : Required. Resource name of the MonitoringPoint. Format: projects/{project}/locations/{location}/networkMonitoringProviders/{network_monitoring_provider}/monitoringPoints/{monitoring_point}

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

  Location : path

  Required : Yes

  Type : string

  hostname

  Description : Optional. The hostname of the MonitoringPoint, e.g. "test-vm"

  Location : query

  Type : string

  Parameter Order : name

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

  Description : Downloads an install script for a specific Container MonitoringPoint.

• ▼ ▲ networkmanagement.projects.locations.networkMonitoringProviders.monitoringPoints.downloadServerConnectConfig

  Path : v1/{+parent}/monitoringPoints:downloadServerConnectConfig

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

  HTTP Method : GET

  Parameters :

  parent

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

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

  Location : path

  Required : Yes

  Type : string

  Parameter Order : parent

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

  Description : Downloads the server connect configuration for a given network monitoring provider.

• ▼ ▲ 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.