https://github.com/yandex-cloud/nodejs-sdk
Yandex.Cloud NodeJS SDK
https://github.com/yandex-cloud/nodejs-sdk
cloud nodejs sdk yandex-cloud
Last synced: 6 months ago
JSON representation
Yandex.Cloud NodeJS SDK
- Host: GitHub
- URL: https://github.com/yandex-cloud/nodejs-sdk
- Owner: yandex-cloud
- License: mit
- Created: 2019-07-07T11:58:54.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2025-03-21T13:07:21.000Z (7 months ago)
- Last Synced: 2025-03-28T19:05:58.433Z (7 months ago)
- Topics: cloud, nodejs, sdk, yandex-cloud
- Language: TypeScript
- Homepage:
- Size: 10.6 MB
- Stars: 66
- Watchers: 6
- Forks: 16
- Open Issues: 17
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Authors: AUTHORS
Awesome Lists containing this project
README
# Yandex.Cloud SDK (nodejs)
[](https://www.npmjs.com/package/@yandex-cloud/nodejs-sdk)
[](https://github.com/yandex-cloud/nodejs-sdk/blob/master/LICENSE)
Need to automate your infrastructure or use services provided by Yandex.Cloud? We've got you covered.
## Requirements
- nodejs >= 12
## Installation
`npm install @yandex-cloud/nodejs-sdk`
## Getting started
There are three options for authorization your requests:
- [OAuth Token](https://cloud.yandex.com/en-ru/docs/iam/concepts/authorization/oauth-token)
- [IAM token](https://cloud.yandex.com/en-ru/docs/iam/operations/iam-token/create)
- [Metadata Service](https://cloud.yandex.com/en-ru/docs/compute/concepts/vm-metadata) (if you're executing code inside VMs or Functions
running in Yandex.Cloud)
### OAuth Token
```typescript
import { Session, cloudApi, serviceClients } from '@yandex-cloud/nodejs-sdk';
const { resourcemanager: { cloud_service: { ListCloudsRequest } } } = cloudApi;
// Initialize SDK with your token
const session = new Session({ oauthToken: 'YOUR_TOKEN' });
// Create service client
const cloudService = session.client(serviceClients.CloudServiceClient);
// Issue request (returns Promise)
const response = await cloudService.list(ListCloudsRequest.fromPartial({
pageSize: 100,
}));
```
### Metadata Service
Don't forget to assign Service Account for your Instance or Function.
```typescript
import { Session, cloudApi, serviceClients } from '@yandex-cloud/nodejs-sdk';
const { resourcemanager: { cloud_service: { ListCloudsRequest } } } = cloudApi;
// Initialize SDK with your token
const session = new Session();
// Create service client
const cloudService = session.client(serviceClients.CloudServiceClient);
// Issue request (returns Promise)
const response = await cloudService.list(ListCloudsRequest.fromPartial({
pageSize: 100,
}));
```
### IAM Token
```typescript
import { Session, cloudApi, serviceClients } from '@yandex-cloud/nodejs-sdk';
const { resourcemanager: { cloud_service: { ListCloudsRequest } } } = cloudApi;
// Initialize SDK with your token
const session = new Session({ iamToken: 'YOUR_TOKEN' });
// Create service client
const cloudService = session.client(serviceClients.CloudServiceClient);
// Issue request (returns Promise)
const response = await cloudService.list(ListCloudsRequest.fromPartial({
pageSize: 100,
}));
```
Check [examples](./examples) directory for more examples.
To run example scripts, you should execute the following commands:
```bash
cd examples
npm i
YC_OAUTH_TOKEN=... YC_FOLDER_ID=... npm run start path/to/example.ts
```
## Services
* AI Translate;
* AI Vision.
* Application Load Balancer
* Billing
* Cloud CDN
* Certificate Manager
* Compute Cloud
* Container Registry
* Data Proc
* DataSphere
* Data Transfer
* DNS
* Identity and Access Management (IAM)
* IoT Core
* Managed Service for Kubernetes
* Key Management Service (KMS)
* Load Balancer
* Lockbox
* Logging
* Managed DataBase
* ClickHouse
* ElasticSearch
* Greenplum
* Kafka
* MongoDB
* MySQL
* PostgreSQL
* Redis
* MS SQL Server
* Organization Manager
* Resource Manager
* Serverless
* Functions
* API Gateway
* Containers
* Triggers
* MDB Proxy
* Virtual Private Cloud (VPC)
* Yandex Database (YDB)
If you need generated client for other Yandex.Cloud services, just open an issue.