View operator API service configuration¶
Check whether the specified operator version has been released, as well as the name, status, and input definitions required to call the service.
GET https://moi.matrixorigin.cn/newmoi/workflow/v2/workitems/catalog/$NODE_ID/api-service?version=$VERSION
Preparation before calling¶
First View operator list to confirm the operator you want to view and its version. Prepare the personal access token, target workspace ID, operator ID, and version that has access to the target workspace.
Request parameters¶
node_idstringRequired- Operator ID. It can be obtained from the [View operator list](../operator-catalog/list-operators.md) response.
versionstringRequired- Operator version.
Request example
curl "https://moi.matrixorigin.cn/newmoi/workflow/v2/workitems/catalog/$NODE_ID/api-service?version=$VERSION" \
-H "X-API-Key: $AI_STUDIO_API_KEY" \
-H "X-Workspace-ID: $WORKSPACE_ID"
Successful response¶
The response returns the service configuration. Only after confirming that the service is enabled can you call service; when calling, the returned service name, version and input definition will be used as is for the request.
The response fields are as follows.
codestring- OK on success.
msgstring- OK on success.
data.service.api_service_idstring- Service ID.
data.service.operator_idinteger- Published custom operator ID.
data.service.node_idstring- Published operator ID.
data.service.versionstring- Published operator version.
data.service.service_namestring- The service name that must be passed in when calling the service.
data.service.statusstring- unpublished means it has not been released yet, ready means it can be called, and disabled means it has been deactivated.
data.service.result_modestring- The service result return mode.
data.service.auth_modestring- The authentication mode of the service.
data.service.methodstring- The HTTP method used to call the service.
data.service.pathstring- Relative path to the calling service.
data.service.workflow_idstring- The workflow ID associated with the service; returned if there is a value.
data.service.workflow_def_idstring- The workflow definition ID associated with the service; returned if there is a value.
data.service.workflow_version_idstring- The workflow version ID associated with the service; returned if there is a value.
data.service.input_schemastring- Input data definition. Fill in the payload of the calling request according to its fields and types.
data.service.output_schemastring- Output data definition; returned if there is a value.
data.service.compute_resource_idstring- The computing resource ID used by the service; returned if there is a value.
data.service.timeout_secondsinteger- Timeout for a single call, in seconds; returned if there is a value.
data.service.max_concurrencyinteger- The maximum number of concurrent calls; returned when there is a value.
data.service.rate_limit_per_mininteger- Maximum number of calls per minute; returned if there is a value.
data.service.invokeobject- Information required to call the service; returned if there is a value.
data.service.deploymentobject- Service deployment information; returned if there is a value.
Successful response example
{
"code": "OK",
"msg": "OK",
"data": {
"service": {
"api_service_id": "api_2e859efcedc1e0efea48b465b2197784",
"node_id": "moi:data.sql.process",
"version": "v1",
"service_name": "operator-api-37f61ebdaa18aa51",
"status": "ready",
"method": "POST",
"path": "/newmoi/workflow/v2/workitems/catalog/moi:data.sql.process/api-service/invoke",
"input_schema": "{\"type\":\"object\",\"properties\":{\"sql\":{\"type\":\"string\"}}}"
}
}
}
Error response¶
codestring- Error code.
msgstring- Readable error message.
datanull- `null` in an error response.
Error response example
{
"code": "ErrParamInvalid",
"msg": "请求参数无效",
"data": null
}
Follow-up operations¶
When the published content needs to be changed, publish the operator API service; when it needs to be deactivated, deactivate the operator API service.