Console
    Contact Us Start free

    Method: projects.locations.namespaces.list

    Lists all namespaces.

    HTTP request

    GET https://servicedirectory.googleapis.com/v1/{parent=projects/*/locations/*}/namespaces

    The URL uses gRPC Transcoding syntax.

    Path parameters

    Parameters
    parent

    string

    Required. The resource name of the project and location whose namespaces you'd like to list.

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

    • servicedirectory.namespaces.list

    Query parameters

    Parameters
    pageSize

    integer

    Optional. The maximum number of items to return.

    pageToken

    string

    Optional. The nextPageToken value returned from a previous List request, if any.

    filter

    string

    Optional. The filter to list results by.

    General filter string syntax: <field> <operator> <value> (<logical connector>)

    • <field> can be name or labels.<key> for map field
    • <operator> can be < , > , <= , >= , != , = , : . Of which : means HAS , and is roughly the same as =
    • <value> must be the same data type as field
    • <logical connector> can be AND , OR , NOT

    Examples of valid filters:

    • labels.owner returns namespaces that have a label with the key owner , this is the same as labels:owner
    • labels.owner=sd returns namespaces that have key/value owner=sd
    • name>projects/my-project/locations/us-east1/namespaces/namespace-c returns namespaces that have name that is alphabetically later than the string, so "namespace-e" is returned but "namespace-a" is not
    • labels.owner!=sd AND labels.foo=bar returns namespaces that have owner in label key but value is not sd AND have key/value foo=bar
    • doesnotexist.foo=bar returns an empty list. Note that namespace doesn't have a field called "doesnotexist". Since the filter does not match any namespaces, it returns no results

    For more information about filtering, see API Filtering .

    orderBy

    string

    Optional. The order to list results by.

    General orderBy string syntax: <field> (<asc|desc>) (,)

    • <field> allows value: name
    • <asc|desc> ascending or descending order by <field> . If this is left blank, asc is used

    Note that an empty orderBy string results in default order, which is order by name in ascending order.

    Request body

    The request body must be empty.

    Response body

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

    The response message for RegistrationService.ListNamespaces .

    JSON representation 
     { 
 "namespaces" 
 : 
 [ 
 { 
 object (  Namespace 
 
) 
 } 
 ] 
 , 
 "nextPageToken" 
 : 
 string 
 }
    Fields
    namespaces[]

    object ( Namespace )

    The list of namespaces.
    nextPageToken

    string

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

    Authorization Scopes

    Requires the following OAuth scope:

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

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