Skip to content

Latest commit

 

History

History
84 lines (63 loc) · 3.17 KB

alias-api.md

File metadata and controls

84 lines (63 loc) · 3.17 KB
title description
How to send a request to an alias in {{ ml-platform-full-name }}
Follow this guide to send a request to an alias.

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 {{ ml-platform-name }} interface:

  1. {% include find project %}
  2. Under {{ ui-key.yc-ui-datasphere.project-page.project-resources }}, select {{ ui-key.yc-ui-datasphere.common.alias }}.
  3. Select the alias to send the request to.
  4. Go to the {{ ui-key.yc-ui-datasphere.node-page.tab.request }} tab.
  5. Under {{ ui-key.yc-ui-datasphere.node-page.request.create-test-request }}:
    • In the Method field, select the request type.
    • In the {{ ui-key.yc-ui-datasphere.common.input }} field, enter the request input variables in {"a":2,"b":3} format and click {{ ui-key.yc-ui-datasphere.common.execute }}.
  6. View the request processing results under {{ ui-key.yc-ui-datasphere.common.response }}.

{% note info %}

The {{ ui-key.yc-ui-datasphere.node-page.request.curl }} section contains sample requests to an alias for the cURL and gRPCurl utilities.

{% endnote %}

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

Sample gRPC API call {#grpc-call-example}

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-host }}: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 request {#rest-query-example}

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.