Method: subdomains.list

Full name: projects.locations.instances.subdomains.list

Lists Subdomains for a given instance.

HTTP request

GET https://{endpoint}/v1alpha/{parent}/subdomains

Where {endpoint} is one of the supported service endpoints.

Path parameters

Parameters
parent

string

Required. The parent instance whose subdomains are to be listed. Format: projects/{projectId}/locations/{region}/instances/{instance}

Query parameters

Parameters
pageSize

integer

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

string

Optional. A page token, received from a previous subdomains.list call. Provide this to retrieve the subsequent page.

When paginating, all other parameters provided to subdomains.list must match the call that provided the page token.

Request body

The request body must be empty.

Response body

Response for listing subdomains.

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

JSON representation 
{
  "subdomains": [
    {
      object (Subdomain)
    }
  ],
  "nextPageToken": string
}
Fields
subdomains[]

object (Subdomain)

The list of subdomains.
nextPageToken

string

A token, which can be sent as pageToken to retrieve the next page. If this field is omitted, there are no subsequent pages.

Authorization scopes

Requires one of the following OAuth scopes:

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

For more information, see the Authentication Overview.