Skip to main content

List

Retrieves the list of services.

import { cloudApi, serviceClients, Session } from "@yandex-cloud/nodejs-sdk";

const ListServicesRequest =
cloudApi.billing.service_service.ListServicesRequest;

(async () => {
const authToken = process.env["YC_OAUTH_TOKEN"];
const session = new Session({ oauthToken: authToken });
const client = session.client(serviceClients.ServiceServiceClient);

const result = await client.list(
ListServicesRequest.fromPartial({
// filter: "filter",
// pageSize: 0,
// pageToken: "pageToken"
})
);
console.log(result);
})();

ListServicesRequest

filter : string

A filter expression that filters resources listed in the response. The expression must specify:

  1. The field name. Currently you can use filtering only on the yandex.cloud.billing.v1.Service.id field.
  2. An = operator.
  3. The value in double quotes ("). Must be 3-63 characters long and match the regular expression [a-z][-a-z0-9]{1,61}[a-z0-9].
pageSize : 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.

pageToken : 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.

ListServicesResponse

services : Service

List of services.

nextPageToken : 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 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 resource.

id : string

ID of the service.

name : string

Name of the service, e.g. Compute Cloud, VPC.

description : string

Description of the service.