Sending a request to an alias
The provided request examples work correctly only with Docker image nodes. To request a model node, install Triton Client.
All users logged into Yandex Cloud can send requests to a public alias. To send a request to a private alias, the following roles are required:
- For users, the minimum role in the project is
datasphere.community-projects.developer. - Service accounts need the
datasphere.community-projects.developerrole in the project; or else the service account must reside in the folder specified when creating the 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.
-
Select the project in your community or on the DataSphere home page in the Recent projects tab.
- Under Project resources, select Alias.
- Select the alias to send the request to.
- Go to the Request tab.
- 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.
- View the request processing results under Response.
Note
The cURL section contains examples of requests to an alias for cURL and gRPCurl.
You can use gRPCurl to make gRPC calls.
grpcurl \
--header "x-node-alias: datasphere.user.<alias_name>" \
--header "Authorization: Bearer <IAM_token>" \
--header "x-folder-id: <folder_ID>" \
--data '<input_variables>' \
node-api.datasphere.yandexcloud.net:443
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.<input_variables>: Object in{"a":2,"b":3}format where keys match input variables.
The successful response will return an object:
{
"output": {
<output_variables>
}
}
You can use cURL 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 HTTP request.<input_variables>: Object in{"a":2,"b":3}format where keys match input variables.
The response returns a JSON object with output variables.