Sending a request to an alias

The type of a request to an alias depends on your node. You can send a test request in the interface if you expect the response to contain simple data, such as numbers or string variables.

Send the test request to the alias from the DataSphere interface:

1. Select the relevant project in your community or on the DataSphere homepage in the Recent projects tab.

2. Under Project resources, select Alias.
3. Select the alias to send the request to.
4. Go to the Request tab.
5. Under Create test request:
   • In the Method field, select the request type.
   • In the Input field, enter the request input variables in {"a":2,"b":3} format and click Execute.
6. View the request processing results under Response.

To send requests to aliases, you must have the datasphere.user or datasphere.admin role for the folder where the project and the alias were created.

Sample gRPC API callSample gRPC API call

You can use the gRPCurl utility to make gRPC calls.

grpcurl \
  -H "Authorization: Bearer <IAM_token>" \
  -d '{
  "folder_id": "<folder_ID>",
  "alias_name": "<alias_name>",
  "input": { <input_variables> } \
  }' \
  datasphere.api.cloud.yandex.net:443
yandex.cloud.datasphere.v1.NodeService/ExecuteAlias

Where:

• <IAM_token>: IAM token used for authentication.
• <folder_ID>: ID of the folder where the project and the alias were created.
• <alias_name>: Alias name.
• <input_variables>: Object in {"a":2,"b":3} format where keys are mapped to input variables.

In a successful response, the object is returned:

{
   "output": {
      <output_variables>
   }
}

Sample REST API requestSample REST API request

You can use the cURL utility to send REST requests.

curl \
   --header "x-node-alias: datasphere.user.<alias_name>" \
   --header "Authorization: Bearer <IAM_token>" \
   --header "x-folder-id: <folder_ID>" \
   --request <request_type> \
   --data '<input_variables>' \
   https://node-api.datasphere.yandexcloud.net/

Where:

• <alias_name>: Alias name.
• <IAM_token>: IAM token used for authentication.
• <folder_ID>: ID of the folder where the project and the alias were created.
• <request_type>: Type of the request to the alias.
• <input_variables>: Object in {"a":2,"b":3} format where keys are mapped to input variables.

The response returns a JSON object with output variables.