API Management API (apim:v1alpha)

2024-06-12

20 new methods | New API

Additions

    Methods
  • apim.projects.locations.list

      Path: v1alpha/{+name}/locations

      Flat Path: v1alpha/projects/{projectsId}/locations

      HTTP Method: GET

      Parameters:

        name

          Description: The resource that owns the locations collection, if applicable.

          Pattern: ^projects/[^/]+$

          Location: path

          Required: Yes

          Type: string

        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

        pageSize

          Description: The maximum number of results to return. If not set, the service selects a default.

          Location: query

          Type: integer

          Format: int32

        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

      Parameter Order: name

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

      Description: Lists information about the supported locations for this service.

  • apim.projects.locations.get

      Path: v1alpha/{+name}

      Flat Path: v1alpha/projects/{projectsId}/locations/{locationsId}

      HTTP Method: GET

      Parameters:

        name

          Description: Resource name for the location.

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

          Location: path

          Required: Yes

          Type: string

      Parameter Order: name

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

      Description: Gets information about a location.

  • apim.projects.locations.operations.list

      Path: v1alpha/{+name}/operations

      Flat Path: v1alpha/projects/{projectsId}/locations/{locationsId}/operations

      HTTP Method: GET

      Parameters:

        name

          Description: The name of the operation's parent resource.

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

          Location: path

          Required: Yes

          Type: string

        filter

          Description: The standard list filter.

          Location: query

          Type: string

        pageSize

          Description: The standard list page size.

          Location: query

          Type: integer

          Format: int32

        pageToken

          Description: The standard list page token.

          Location: query

          Type: string

      Parameter Order: name

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

      Description: Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.

  • apim.projects.locations.operations.get

      Path: v1alpha/{+name}

      Flat Path: v1alpha/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}

      HTTP Method: GET

      Parameters:

        name

          Description: The name of the operation resource.

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

          Location: path

          Required: Yes

          Type: string

      Parameter Order: name

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

      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.

  • apim.projects.locations.operations.delete

      Path: v1alpha/{+name}

      Flat Path: v1alpha/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}

      HTTP Method: DELETE

      Parameters:

        name

          Description: The name of the operation resource to be deleted.

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

          Location: path

          Required: Yes

          Type: string

      Parameter Order: name

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

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

  • apim.projects.locations.operations.cancel

      Path: v1alpha/{+name}:cancel

      Flat Path: v1alpha/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}:cancel

      HTTP Method: POST

      Parameters:

        name

          Description: The name of the operation resource to be cancelled.

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

          Location: path

          Required: Yes

          Type: string

      Parameter Order: name

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

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

  • apim.projects.locations.observationSources.create

      Path: v1alpha/{+parent}/observationSources

      Flat Path: v1alpha/projects/{projectsId}/locations/{locationsId}/observationSources

      HTTP Method: POST

      Parameters:

        parent

          Description: Required. Value for parent.

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

          Location: path

          Required: Yes

          Type: string

        observationSourceId

          Description: Required. The ID to use for the Observation Source. This value should be 4-63 characters, and valid characters are /a-z-/.

          Location: query

          Type: string

        requestId

          Description: Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

          Location: query

          Type: string

      Parameter Order: parent

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

      Description: CreateObservationSource creates a new ObservationSource but does not affect any deployed infrastructure. It is a configuration that can be used in an Observation Job to collect data about APIs running in user's dataplane.

  • apim.projects.locations.observationSources.get

      Path: v1alpha/{+name}

      Flat Path: v1alpha/projects/{projectsId}/locations/{locationsId}/observationSources/{observationSourcesId}

      HTTP Method: GET

      Parameters:

        name

          Description: Required. The name of the ObservationSource to retrieve. Format: projects/{project}/locations/{location}/observationSources/{source}

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

          Location: path

          Required: Yes

          Type: string

      Parameter Order: name

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

      Description: GetObservationSource retrieves a single ObservationSource by name.

  • apim.projects.locations.observationSources.list

      Path: v1alpha/{+parent}/observationSources

      Flat Path: v1alpha/projects/{projectsId}/locations/{locationsId}/observationSources

      HTTP Method: GET

      Parameters:

        parent

          Description: Required. The parent, which owns this collection of ObservationSources. Format: projects/{project}/locations/{location}

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

          Location: path

          Required: Yes

          Type: string

        pageSize

          Description: Optional. The maximum number of ObservationSources to return. The service may return fewer than this value. If unspecified, at most 10 ObservationSources 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 `ListObservationSources` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListObservationSources` 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: ListObservationSources gets all ObservationSources for a given project and location

  • apim.projects.locations.observationSources.delete

      Path: v1alpha/{+name}

      Flat Path: v1alpha/projects/{projectsId}/locations/{locationsId}/observationSources/{observationSourcesId}

      HTTP Method: DELETE

      Parameters:

        name

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

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

          Location: path

          Required: Yes

          Type: string

      Parameter Order: name

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

      Description: DeleteObservationSource deletes an observation source. This method will fail if the observation source is currently being used by any ObservationJob, even if not enabled.

  • apim.projects.locations.observationJobs.create

      Path: v1alpha/{+parent}/observationJobs

      Flat Path: v1alpha/projects/{projectsId}/locations/{locationsId}/observationJobs

      HTTP Method: POST

      Parameters:

        parent

          Description: Required. The parent resource where this ObservationJob will be created. Format: projects/{project}/locations/{location}

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

          Location: path

          Required: Yes

          Type: string

        observationJobId

          Description: Required. The ID to use for the Observation Job. This value should be 4-63 characters, and valid characters are /a-z-/.

          Location: query

          Type: string

        requestId

          Description: Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

          Location: query

          Type: string

      Parameter Order: parent

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

      Description: CreateObservationJob creates a new ObservationJob but does not have any effecton its own. It is a configuration that can be used in an Observation Job to collect data about existing APIs.

  • apim.projects.locations.observationJobs.get

      Path: v1alpha/{+name}

      Flat Path: v1alpha/projects/{projectsId}/locations/{locationsId}/observationJobs/{observationJobsId}

      HTTP Method: GET

      Parameters:

        name

          Description: Required. The name of the ObservationJob to retrieve. Format: projects/{project}/locations/{location}/observationJobs/{job}

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

          Location: path

          Required: Yes

          Type: string

      Parameter Order: name

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

      Description: GetObservationJob retrieves a single ObservationJob by name.

  • apim.projects.locations.observationJobs.list

      Path: v1alpha/{+parent}/observationJobs

      Flat Path: v1alpha/projects/{projectsId}/locations/{locationsId}/observationJobs

      HTTP Method: GET

      Parameters:

        parent

          Description: Required. The parent, which owns this collection of ObservationJobs. Format: projects/{project}/locations/{location}

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

          Location: path

          Required: Yes

          Type: string

        pageSize

          Description: Optional. The maximum number of ObservationJobs to return. The service may return fewer than this value. If unspecified, at most 10 ObservationJobs 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 `ListObservationJobs` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListObservationJobs` 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: ListObservationJobs gets all ObservationJobs for a given project and location

  • apim.projects.locations.observationJobs.delete

      Path: v1alpha/{+name}

      Flat Path: v1alpha/projects/{projectsId}/locations/{locationsId}/observationJobs/{observationJobsId}

      HTTP Method: DELETE

      Parameters:

        name

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

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

          Location: path

          Required: Yes

          Type: string

      Parameter Order: name

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

      Description: DeleteObservationJob deletes an ObservationJob. This method will fail if the observation job is currently being used by any ObservationSource, even if not enabled.

  • apim.projects.locations.observationJobs.enable

      Path: v1alpha/{+name}:enable

      Flat Path: v1alpha/projects/{projectsId}/locations/{locationsId}/observationJobs/{observationJobsId}:enable

      HTTP Method: POST

      Parameters:

        name

          Description: Required. The name of the ObservationJob to enable. Format: projects/{project}/locations/{location}/observationJobs/{job}

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

          Location: path

          Required: Yes

          Type: string

      Parameter Order: name

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

      Description: Enables the given ObservationJob.

  • apim.projects.locations.observationJobs.disable

      Path: v1alpha/{+name}:disable

      Flat Path: v1alpha/projects/{projectsId}/locations/{locationsId}/observationJobs/{observationJobsId}:disable

      HTTP Method: POST

      Parameters:

        name

          Description: Required. The name of the ObservationJob to disable. Format: projects/{project}/locations/{location}/observationJobs/{job}

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

          Location: path

          Required: Yes

          Type: string

      Parameter Order: name

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

      Description: Disables the given ObservationJob.

  • apim.projects.locations.observationJobs.apiObservations.get

      Path: v1alpha/{+name}

      Flat Path: v1alpha/projects/{projectsId}/locations/{locationsId}/observationJobs/{observationJobsId}/apiObservations/{apiObservationsId}

      HTTP Method: GET

      Parameters:

        name

          Description: Required. The name of the ApiObservation to retrieve. Format: projects/{project}/locations/{location}/observationJobs/{observation_job}/apiObservations/{api_observation}

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

          Location: path

          Required: Yes

          Type: string

      Parameter Order: name

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

      Description: GetApiObservation retrieves a single ApiObservation by name.

  • apim.projects.locations.observationJobs.apiObservations.list

      Path: v1alpha/{+parent}/apiObservations

      Flat Path: v1alpha/projects/{projectsId}/locations/{locationsId}/observationJobs/{observationJobsId}/apiObservations

      HTTP Method: GET

      Parameters:

        parent

          Description: Required. The parent, which owns this collection of ApiObservations. Format: projects/{project}/locations/{location}/observationJobs/{observation_job}

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

          Location: path

          Required: Yes

          Type: string

        pageSize

          Description: Optional. The maximum number of ApiObservations to return. The service may return fewer than this value. If unspecified, at most 10 ApiObservations 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 `ListApiObservations` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListApiObservations` 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: ListApiObservations gets all ApiObservations for a given project and location and ObservationJob

  • apim.projects.locations.observationJobs.apiObservations.apiOperations.get

      Path: v1alpha/{+name}

      Flat Path: v1alpha/projects/{projectsId}/locations/{locationsId}/observationJobs/{observationJobsId}/apiObservations/{apiObservationsId}/apiOperations/{apiOperationsId}

      HTTP Method: GET

      Parameters:

        name

          Description: Required. The name of the ApiOperation to retrieve. Format: projects/{project}/locations/{location}/observationJobs/{observation_job}/apiObservations/{api_observation}/apiOperation/{api_operation}

          Pattern: ^projects/[^/]+/locations/[^/]+/observationJobs/[^/]+/apiObservations/[^/]+/apiOperations/[^/]+$

          Location: path

          Required: Yes

          Type: string

      Parameter Order: name

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

      Description: GetApiOperation retrieves a single ApiOperation by name.

  • apim.projects.locations.observationJobs.apiObservations.apiOperations.list

      Path: v1alpha/{+parent}/apiOperations

      Flat Path: v1alpha/projects/{projectsId}/locations/{locationsId}/observationJobs/{observationJobsId}/apiObservations/{apiObservationsId}/apiOperations

      HTTP Method: GET

      Parameters:

        parent

          Description: Required. The parent, which owns this collection of ApiOperations. Format: projects/{project}/locations/{location}/observationJobs/{observation_job}/apiObservations/{api_observation}

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

          Location: path

          Required: Yes

          Type: string

        pageSize

          Description: Optional. The maximum number of ApiOperations to return. The service may return fewer than this value. If unspecified, at most 10 ApiOperations 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 `ListApiApiOperations` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListApiApiOperations` 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: ListApiOperations gets all ApiOperations for a given project and location and ObservationJob and ApiObservation