Contact UsGet started

Identity and Access Management API, gRPC: ServiceControlService.List

Written by
Updated at November 26, 2024

Retrieves the list of Service in the specified resource container.

gRPC request

rpc List (ListServicesRequest) returns (ListServicesResponse)

ListServicesRequest

{
  "resource": {
    "id": "string",
    "type": "string"
  },
  "page_size": "int64",
  "page_token": "string"
}

Field

Description

resource

Resource

Required field. Resource container to list a services.

It is supported only resource-manager.cloud resource container now.

page_size

int64

The maximum number of results per page to return. If the number of available
results is larger than page_size,
the service returns a ListServicesResponse.next_page_token
that can be used to get the next page of results in subsequent list requests.
Default value: 100

page_token

string

Page token. To get the next page of results, set page_token
to the ListServicesResponse.next_page_token
returned by a previous list request.

Resource

A Resource. For more information, see Resource.

Field

Description

id

string

Required field. ID of the resource.

type

string

Required field. The type of the resource, e.g. resource-manager.folder, billing.account, compute.snapshot, etc.

ListServicesResponse

{
  "services": [
    {
      "service_id": "string",
      "resource": {
        "id": "string",
        "type": "string"
      },
      "updated_at": "google.protobuf.Timestamp",
      "status": "Status"
    }
  ],
  "next_page_token": "string"
}

Field

Description

services[]

Service

List of Services.

next_page_token

string

This token allows you to get the next page of results for list requests. If the number of results
is larger than ListServicesRequest.page_size, use
the next_page_token as the value
for the ListServicesRequest.page_token query parameter
in the next list request. Each subsequent list request will have its own
next_page_token to continue paging through the results.

Service

A Service.

Field

Description

service_id

string

ID of the service.

resource

Resource

Resource that the service belongs to.

updated_at

google.protobuf.Timestamp

Time of the last status update of the service.

status

enum Status

Current status of the service.

  • STATUS_UNSPECIFIED
  • ENABLED: The service is enabled.
  • PAUSED: The service is paused.
  • DISABLED: The service is disabled.
  • ENABLING: The service is being enabled.
  • RESUMING: The service is being resumed.
  • PAUSING: The service is being paused.
  • DISABLING: The service is being disabled.
  • ERROR: The service is in error state.
  • DEFAULT: The service could be auto enabled.

Resource

A Resource. For more information, see Resource.

Field

Description

id

string

Required field. ID of the resource.

type

string

Required field. The type of the resource, e.g. resource-manager.folder, billing.account, compute.snapshot, etc.
Previous
Get
Next
Enable