API Overview

Performing a Health Check

This API is used to check the system health status.

Querying a System Agreement

This API is used to retrieve the content of a tenant agreement, enabling you to view the agreement name, version, and other relevant details.

Registering a Tenant Agreement

This API is used to register a tenant agreement.

Querying Whether a User Has Registered with an Agreement

This API is used to query whether a user has registered an agreement.

Deleting a User Registration Agreement

This API is used to delete a user's registered agreement.

Creating a Service Agency

This API is used to authorize an agency to DataArts Fabric. When you call this API, an agency is created and then authorized to DataArts Fabric. You can grant access by passing the supported agency permission policies.

Querying a Service Agency

This API is used to query the agency authorized to DataArts Fabric. You can call this API to query the agency authorized to DataArts Fabric and the specific permissions within the agency.

Deleting a Service Agency

This API is used to revoke the agency authorization granted to DataArts Fabric.

Querying the Workspace List

This API is used to list workspaces. You can use this API to obtain a list of workspaces that meet the filter criteria. The API supports paginated queries and queries by name, ID, and enterprise project ID. A list of workspaces that meet the filter criteria is returned.

Updating a Workspace

This API is used to update a workspace. You can enter the name, description, and MetaStore ID. Details about the updated workspace are returned.

Creating a Workspace

This API is used to create a workspace. You can enter the name, description, MetaStore ID, enterprise project ID, and tag. The workspace details are returned.

Deleting a Workspace

This API is used to delete a workspace. If a workspace contains compute resources, endpoints, and applications, the workspace cannot be deleted. You must first clear all resources created within the workspace before deletion.

Querying the Resource Specification List

This API is used to list resource specifications. You can filter resource specifications by code, type, and use case. Pagination query is supported.

Querying the Endpoint List

This API is used to list endpoints. You can call this API to list endpoints within a workspace. You can filter endpoints by model ID, endpoint ID, name, type, and visibility. Pagination query is supported.

Creating an Endpoint

This API is used to create an endpoint. You can call this API to create an endpoint within a workspace. You need to enter information like the name, description, type, resource configuration, and CAP configuration. The endpoint information will then be returned.

Querying Details About an Endpoint

This API is used to list historical statements.

Modifying an Endpoint

This API is used to query endpoint details. You can call this API to query details about an endpoint by specifying the endpoint ID. Endpoint details will then be returned.

Deleting an Endpoint

This API is used to query endpoint metrics. You can call this API to query resource usage details by specifying the metric name.

Subscribing to an Endpoint

This API is used to update an endpoint. You can call this API to update endpoint information.

Creating a Model

This API is used to create a model. You can call this API to create a model by specifying the name, description, version name, version description, base model type, and OBS path of the model. The API then returns the model ID and version ID.

Querying the Model List

This API is used to list models. You can call this API to query the model list. The API supports paginated queries and queries by name, ID, or type. The API supports sorting. The API returns a list of models that meet the filter criteria.

Listing Base Models

This API is used to list base models. You can use this API to query the base model list. This API supports paginated queries. The API returns a list of base models that meet the filter criteria.

Deleting a Specified Version of a Model

This API is used to delete a specified version of a model. If the version is currently in use, it cannot be deleted. You must first delete the inference service that uses the model before deleting the version. You can delete a model version by calling this API.

Updating Model Information

This API is used to update a model and generate a new version. You can call this API to update model information, including the name, description, and current version ID. This API allows you to add a new version by specifying the version name, description, base model type, and model address.

Checking the Model Version List

This API is used to check the model version list. You can call this API to query the model version list. The API supports paginated queries and queries by name or ID. The API returns a list of model versions that meet the filter criteria.

Deleting Unused Model Definitions

This API is used to delete unused model definitions. You can delete a model by calling this API.

Querying Project Tags

This API is used to query project tags.

Querying Resource Tags

This API is used to query workspace tags. You can call this API to query the tags of a workspace. The API returns the tags of the workspace.

Querying the Resource Instance List

This API is used to query workspaces by tag.

Querying the Number of Resource Instances

This API is used to query the number of workspaces by tag.

Batch Tagging Resources

This API is used to add tags to a workspace in batches.

Batch Deleting Resource Tags

This API is used to remove tags from a workspace in batches.

Creating a Notification Policy

This API is used to create a message notification policy. You can call this API to create a message notification policy. After a job is complete, results will be sent as messages according to the matched notification policy.

Querying the Notification Policy List

This API is used to query a message notification policy. You can call this API to query a created message notification policy. The API supports paginated queries based on the provided workspace ID and message matching pattern.

Deleting a Notification Policy

This API is used to delete a message notification policy. You can call this API to delete a created message notification policy.

Updating the Configuration for AOM to Collect Monitoring Metrics

This API is used to update the configuration for AOM to collect monitoring metrics in a workspace.

Creating a VPC Endpoint Client

This API is used to create a VPC endpoint client. The VPC connects to APIG, allowing you to call DataArts Fabric APIs using private domain names.

Querying the VPC Endpoint Client List

This API is used to query the access client list. You can query the list of created access clients and obtain the VPC endpoint private domain name.

Querying Details About a VPC Endpoint Client

This API is used to query details about an access client. You can query details about an access client.

Deleting a VPC Endpoint Client

This API is used to delete an access client. You can delete an access client that is no longer required.

Updating a VPC Endpoint Client

This API is used to update an access client. You can change the name of an access client.

Listing Deployed Service Instances

This API is used to list deployed service instances. You can call this API to list deployed service instances, supporting paginated queries and filtering by name, service instance ID, endpoint ID, and visibility.

Checking Details About a Deployed Service Instance

This API is used to checking details about a deployed service instance. The API returns details about the service instance.

Deploying a Service

This API is used to deploy a service instance. The API allows you to specify parameters such as the name, description, endpoint ID, instance specifications, minimum value, and maximum value. The API returns the instance ID.

Updating a Deployed Service Instance

This API is used to update a deployed service instance. You can call this API to update a deployed service instance, including its name and description.

Deleting a Service Instance

This API is used to delete a service instance to release resources.

Initiating an Invocation Request

This API is used to invoke a deployed large model inference instance and initiate an inference request.

Obtaining Session Information

This API is used to obtain session information.

Creating a SQL Session

This API is used to create a SQL session.

Querying the SQL Session List

This API is used to list SQL sessions.

Querying Session Information

This API is used to query SQL session details.

Closing a Session

This API is used to close a SQL session.

Executing a SQL Statement

This API is used to execute SQL statements within a specified session.

Obtaining Statement Execution Results and Status

This API is used to query the execution results of SQL statements.

Canceling Statement Execution

This API is used to cancel the execution of SQL statements.

Querying SQL Execution Records

This API is used to query SQL execution records.

Querying SQL Execution Records in a Specified Session

This API is used to query the SQL execution records of a specified session.