Yandex Cloud
Search
Contact UsGet started
  • Blog
  • Pricing
  • Documentation
  • All Services
  • System Status
    • Featured
    • Infrastructure & Network
    • Data Platform
    • Containers
    • Developer tools
    • Serverless
    • Security
    • Monitoring & Resources
    • ML & AI
    • Business tools
  • All Solutions
    • By industry
    • By use case
    • Economics and Pricing
    • Security
    • Technical Support
    • Customer Stories
    • Cloud credits to scale your IT product
    • Gateway to Russia
    • Cloud for Startups
    • Education and Science
    • Yandex Cloud Partner program
  • Blog
  • Pricing
  • Documentation
© 2025 Direct Cursus Technology L.L.C.
Yandex API Gateway
  • Getting started
    • Resource relationships
    • Networking
      • Overview
        • Static response
        • Access over HTTP
        • Cloud Functions
        • Serverless Containers
        • Smart Web Security
        • Object Storage
        • DataSphere
        • Data Streams
        • Message Queue
        • Managed Service for YDB
      • Greedy parameters
      • Generic HTTP method
      • Authorization using a Cloud Functions function
      • Authorization using a JWT
      • WebSocket protocol support
      • Data validation
      • CORS
      • Specification parameterization
      • Canary release
      • Request rate limit
      • Response code replacement
      • Transformation of response and request bodies
    • Quotas and limits
  • Access management
  • Pricing policy
  • Terraform reference
  • Monitoring metrics
  • Audit Trails events
  • Release notes
  • FAQ

In this article:

  • Supported parameters
  • Extension specification
  1. Concepts
  2. Specification extensions
  3. Integration options
  4. DataSphere

x-yc-apigateway-integration:cloud_datasphere extension

Written by
Yandex Cloud
Updated at August 29, 2024
  • Supported parameters
  • Extension specification

The x-yc-apigateway-integration:cloud_datasphere extension invokes a DataSphere node deployed as a separate microservice. The API Gateway request must contain a JSON object with the input variables specified when creating the node, as well as their values. API Gateway will return a JSON object containing the output variables specified when creating the node and their values obtained after it is run.

You can add an extension to a specification using the specification constructor.

Supported parametersSupported parameters

The table below lists the parameters specific to API Gateway API gateways. You can find the description of other parameters in the OpenAPI 3.0 specification.

Parameter Type Description
folder_id string The ID of the folder where the DataSphere project and node were created.
node_id string DataSphere node ID.
service_account_id string Service account ID. It is used for authorization when invoking a DataSphere node. If it is not specified, its value is taken from the parent service_account_id.

Extension specificationExtension specification

Specification example:

/node/call:
    post:
      summary: Call DataSphere Node
      operationId: callDatasphereNode
      tags:
        - datasphere
      x-yc-apigateway-integration:
        type: cloud_datasphere
        folder_id: b095c95icnvb********
        node_id: 244e0c20-74a7-4147-83ad-7fd7********
        service_account_id: ajehfe78asl********

Was the article helpful?

Previous
Object Storage
Next
Data Streams
© 2025 Direct Cursus Technology L.L.C.