Method: slaDefinitions.list

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

Lists a SlaDefinitions.

HTTP request


Path parameters

Parameters
parent

string

Required. The instance to list SlaDefinitions for. Format: projects/{project}/locations/{location}/instances/{instance}/slaDefinitions

Query parameters

Parameters
pageSize

integer

Optional. The maximum number of SlaDefinitions to return. The service may return fewer than this value. If unspecified, at most 50 SlaDefinitions 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 slaDefinitions.list call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to ListBooks must match the call that provided the page token.

filter

string

Optional. A filter to apply to the list of SlaDefinitions. Supported filter fields: * slaType: Filter by the sla type. * alertType: Filter by the alert type. * slaTypeValue: Filter by the sla type value. * sla_durationperiod: Filter by the sla duration period. * slaPeriodTimeUnit: Filter by the sla period time unit. * criticalSlaPeriod: Filter by the critical sla period. * criticalSlaPeriodTimeUnit: Filter by the critical sla period time unit. * environments: Filter by the environments.

Example: filter="slaType='ALL_ALERTS'"

orderBy

string

Optional. Configures ordering of SlaDefinitions in the response. If not specified, SlaDefinitions are returned in descending order of their create time. The default ordering is by create time in descending order. The orderBy string is a comma separated list of fields. Supported sort fields: * slaType * alertType * slaTypeValue * sla_durationperiod * slaPeriodTimeUnit * criticalSlaPeriod * criticalSlaPeriodTimeUnit * environments

Example: "slaType desc, alertType"

Request body

The request body must be empty.

Response body

Response message for slaDefinitions.list.

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

JSON representation
{
  "slaDefinitions": [
    {
      object (SlaDefinition)
    }
  ],
  "nextPageToken": string,
  "totalSize": integer
}
Fields
slaDefinitions[]

object (SlaDefinition)

The list of SlaDefinitions.

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.

totalSize

integer

Total count of SlaDefinitions.

Authorization scopes

Requires the following OAuth scope:

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

For more information, see the Authentication Overview.