Console
    Start free

    Method: projects.locations.dataScans.list

    Lists DataScans.

    HTTP request

    GET https://dataplex.googleapis.com/v1/{parent=projects/*/locations/*}/dataScans

    The URL uses gRPC Transcoding syntax.

    Path parameters

    Parameters
    parent

    string

    Required. The resource name of the parent location: projects/{project}/locations/{locationId} where project refers to a projectId or project_number and locationId refers to a Google Cloud region.

    Authorization requires the following IAM permission on the specified resource parent :

    • dataplex.datascans.list

    Query parameters

    Parameters
    pageSize

    integer

    Optional. Maximum number of dataScans to return. The service may return fewer than this value. If unspecified, at most 500 scans will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.
    pageToken

    string

    Optional. Page token received from a previous dataScans.list call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to dataScans.list must match the call that provided the page token.
    filter

    string

    Optional. Filter request.
    orderBy

    string

    Optional. Order by fields ( name or createTime ) for the result. If not specified, the ordering is undefined.

    Request body

    The request body must be empty.

    Response body

    List dataScans response.

    If successful, the response body contains data with the following structure:

    JSON representation 
     { 
 "dataScans" 
 : 
 [ 
 { 
 object (  DataScan 
 
) 
 } 
 ] 
 , 
 "nextPageToken" 
 : 
 string 
 , 
 "unreachable" 
 : 
 [ 
 string 
 ] 
 }
    Fields
    dataScans[]

    object ( DataScan )

    DataScans ( BASIC view only) under the given parent location.
    nextPageToken

    string

    Token to retrieve the next page of results, or empty if there are no more results in the list.
    unreachable[]

    string

    Locations that could not be reached.

    Authorization scopes

    Requires the following OAuth scope:

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

    For more information, see the Authentication Overview .
    Create a Mobile Website
    View Site in Mobile | Classic
    Share by: