Help Center/ DataArts Studio/ CLI Reference/ CLI Command Reference
Updated on 2026-09-14 GMT+08:00

CLI Command Reference

DataMap APIs

API Name

Command

Description

Operation

ShowQueues

hcloud DataArtsStudio ShowQueues

This API is used to obtain the queue list and display 10 data records. This API is in the closed beta test (CBT) phase and will be gradually opened with the function OBT.

Go debug

dataPreview

hcloud DataArtsStudio ShowTableData

This API is used to preview table data. Ten data records are returned. This API is in invitational test and will be available in OBT in the future.

Go debug

getEntitiesInfos

hcloud DataArtsStudio ListEntityDetails

This API is used to obtain asset information in batches.

Go debug

ListCategoriesTree

hcloud DataArtsStudio ListCategoriesTree

This API is used to obtain the asset directory tree in a workspace.

Go debug

ListLogicEntities

hcloud DataArtsStudio ListLogicEntitys

This API is used to obtain the logical entities in a directory.

Go debug

ImportDataMapLineage

hcloud DataArtsStudio ImportDataMapLineage

This API is used to import a lineage. It is in closed beta test and will be available for OBT in the future.

Go debug

BatchLabeling

hcloud DataArtsStudio BatchTag

This API is used to tag assets.

Go debug

Search query label pagination display

hcloud DataArtsStudio ShowTags

The search and query tags are displayed on multiple pages. The function of this API is in the invitation test phase and will be gradually available in the OBT.

Go debug

User Behavior Analysis

hcloud DataArtsStudio ParseUserBehavior

User Behavior Analysis: The function of this API is in the invitation test phase and will be gradually opened with the OBT.

Go debug

Asset Search

hcloud DataArtsStudio ShowDataSets

Asset search. It is in invitational test and will be available for OBT in the future.

Go debug

Create or modify assets

hcloud DataArtsStudio CreateOrUpdateEntities

This API is used to create or modify assets. It is in invitational test and will be available for OBT in the future.

Go debug

entitiy detail

hcloud DataArtsStudio ShowDataDetail

Asset details API. It is in invitational test and will be available for OBT in the future.

Go debug

DeleteEntity

hcloud DataArtsStudio DeleteEntity

This API is used to delete an asset with a specified GUID.

Go debug

entity lineage

hcloud DataArtsStudio ShowDatamapLineage

This API is used to obtain an asset lineage. It is in invitational test and will be available for OBT in the future.

Go debug

bulk lineage

hcloud DataArtsStudio ShowLineageBulk

This API is used to obtain the lineages of all job nodes. It is in invitational test and will be available for OBT in the future.

Go debug

get nodes by table

hcloud DataArtsStudio ShowNodes

This API is used to query the list of job operators associated with a table. It is in invitational test and will be available for OBT in the future.

Go debug

get instances by node

hcloud DataArtsStudio ShowInstanceInfos

This API is used to query the running instance information of the job operator related to a table. It is in invitational test and will be available for OBT in the future.

Go debug

Logical Asset APIs

API Name

Command

Description

Operation

Query the business asset directory tree

hcloud DataArtsStudio ShowBusinessAssetsTree

Queries the service asset directory tree level by level, including service objects and logical entities synchronized from data specifications.

Go debug

Querying Logical Assets

hcloud DataArtsStudio ShowBusinessAssets

Query business assets, including business objects and logical entities synchronized from data specifications.

Go debug

Metric Asset APIs

API Name

Command

Description

Operation

Querying the Metric Asset Directory Tree

hcloud DataArtsStudio ShowMetricTree

This API is used to query the indicator asset directory tree.

Go debug

Querying Metric Assets

hcloud DataArtsStudio ShowMetricAssets

This API is used to query indicator assets.

Go debug

Asset Statistics APIs

API Name

Command

Description

Operation

Obtaining Technical Asset Statistics

hcloud DataArtsStudio ShowTechnicalAssetsStatistic

This API is used to obtain technology asset statistics.

Go debug

Obtaining Logical Asset Statistics

hcloud DataArtsStudio ShowBusinessAssetsStatistic

This API is used to obtain service asset statistics.

Go debug

Asset Management APIs

API Name

Command

Description

Operation

Querying Technical Assets

hcloud DataArtsStudio ShowEntities

Query technology assets.

Go debug

Obtaining Asset Details by GUID

hcloud DataArtsStudio ShowEntityInfoByGuid

You can obtain table details based on the table GUID. The table details include the column information. You can also obtain the column information based on the column GUID.

Go debug

Create Or Update Asset

hcloud DataArtsStudio CreateOrUpdateAsset

Add or modify an asset.

Go debug

update entity attribute value

hcloud DataArtsStudio UpdateEntityAttribute

This API is used to modify a specified asset attribute.

Go debug

Delete a Asset

hcloud DataArtsStudio DeleteAsset

This API is used to delete an asset.

Go debug

Asset Classification APIs

API Name

Command

Description

Operation

Associating a Classification with Assets

hcloud DataArtsStudio BatchAssociateClassificationToEntities

Associating Assets with Categories in Batches: Categories can be added only to columns of data tables and OBS objects.

Go debug

Associating a Classification with One or More Specified Assets

hcloud DataArtsStudio AssociateClassificationToEntity

Associates a category with one or more assets with a specified GUID.

Go debug

Dissociating a Classification from an Asset

hcloud DataArtsStudio DeleteClassificationFromEntities

Remove the security level associated with the asset.

Go debug

Asset Security Level APIs

API Name

Command

Description

Operation

Associating a Security Level with Assets

hcloud DataArtsStudio BatchAssociateSecurityLevelToEntities

Associating assets with security levels in batches: A single security level is associated with multiple assets.

Go debug

Associating a Security Level with an Asset

hcloud DataArtsStudio AssociateSecurityLevelToEntitie

Associate the asset with the security level. The asset is associated with the specified security level.

Go debug

Dissociating a Security Level from an Asset

hcloud DataArtsStudio DeleteSecurityLevelFromEntity

This API is used to dissociate a security level from an asset.

Go debug

Tags APIs

API Name

Command

Description

Operation

query tag list

hcloud DataArtsStudio ShowGlossaryList

This API is used to query the tag list.

Go debug

Tags are associated to assets

hcloud DataArtsStudio AddTagToAsset

Associating Tags with an Asset

Go debug

Metadata collection tasks APIs

API Name

Command

Description

Operation

Querying the Collection Task List

hcloud DataArtsStudio ShowTaskList

This API is used to query metadata collection tasks.

Go debug

Create a collection task

hcloud DataArtsStudio CreateTask

Create a collection task.

Go debug

Metadata collection tasks APIs

hcloud DataArtsStudio ShowTaskInfo

Query details about a collection task.

Go debug

Edit Collection Task

hcloud DataArtsStudio UpdateTaskInfo

Edit a collection task.

Go debug

Delete a single collection task

hcloud DataArtsStudio DeleteTaskInfo

Delete a single collection task.

Go debug

Start, schedule, or stop collection tasks

hcloud DataArtsStudio ExecuteTaskAction

Starts, schedules, and stops collection tasks.

Go debug

Get task log

hcloud DataArtsStudio ShowInstanceLog

Obtain task logs.

Go debug

asset information APIs

API Name

Command

Description

Operation

Preview table data

hcloud DataArtsStudio ShowDataPreview

This API is used to preview table data.

Go debug

RenewDataProfile

hcloud DataArtsStudio RenewDataProfile

This API is used to collect brief information about specified fields.

Go debug

asset information APIs

hcloud DataArtsStudio ShowDataProfile

This API is used to query brief information such as data structure distribution in a table. It only supports GaussDB(DWS) and DLI data sources.

Go debug

lineage information APIs

API Name

Command

Description

Operation

lineage information APIs

hcloud DataArtsStudio ShowUnrelatedTable

This API is used to query tables without lineages based on classification, type_names, connection_names, or query.

Go debug

query Lineage

hcloud DataArtsStudio ShowLineage

Lineage query.

Go debug

lineage import

hcloud DataArtsStudio ImportLineage

Lineage query.

Go debug

create lineage information

hcloud DataArtsStudio CreateLineageInfo

This API is used to create a lineage.

Go debug

Metadata real-time synchronization

API Name

Command

Description

Operation

Metadata real-time synchronization interface (testing)

hcloud DataArtsStudio BatchSyncMetadata

This API is used to synchronize metadata in real time. It is in invitational test and will be available for OBT in the future.

Go debug

Overview

API Name

Command

Description

Operation

Overview Statistics

hcloud DataArtsStudio CountOverviews

Overview statistics.

Go debug

Model Statistics

hcloud DataArtsStudio CountTableModels

Statistics in a single model.

Go debug

Relational Modeling Statistics

hcloud DataArtsStudio CountAllModels

Outer-layer statistics on the relational modeling page.

Go debug

Standard Coverage Statistics

hcloud DataArtsStudio CountStandards

View the coverage of a data standard in all model fields, that is, the percentage of fields that use the standard to the total fields.

Go debug

Information Architecture

API Name

Command

Description

Operation

Querying Information About Multiple Types of Tables

hcloud DataArtsStudio ListAllTables

Query information about multiple types of tables from the information architecture, including logical entities, physical tables, dimension tables, fact tables, and summary tables.

Go debug

Data Standards

API Name

Command

Description

Operation

Obtaining Data Standards

hcloud DataArtsStudio ListAllStandards

Obtain the data standard set based on the query conditions in pagination mode and sort the data by modification time in descending order.

Go debug

Creating a Data Standard

hcloud DataArtsStudio CreateStandard

Create a data standard.

Go debug

Deleting Data Standards

hcloud DataArtsStudio DeleteStandard

Delete a data standard.

Go debug

Modifying Data Standards

hcloud DataArtsStudio UpdateStandard

Modify the data standard.

Go debug

Viewing Data Standard Details

hcloud DataArtsStudio ShowStandardById

This API is used to obtain data standard details by ID.

Go debug

Associated Attributes and Data Standards

hcloud DataArtsStudio ResetLinkAttributeAndStandard

Associate attributes with data standards.

Go debug

Data Sources

API Name

Command

Description

Operation

Obtaining Data Connection Information

hcloud DataArtsStudio SearchDwByType

This API is used to obtain data connection information of a specified type.

Go debug

Process Architecture

API Name

Command

Description

Operation

Obtain all BPA directory trees.

hcloud DataArtsStudio ListCatalogTree

This API is used to obtain all directory trees.

Go debug

Querying the BPA List

hcloud DataArtsStudio SearchCatalogs

This API is used to query the process architecture list.

Go debug

Create BPA

hcloud DataArtsStudio CreateCatalog

Create a process architecture.

Go debug

Modified the process architecture.

hcloud DataArtsStudio ChangeCatalog

Modified the process architecture.

Go debug

Delete BPA

hcloud DataArtsStudio DeleteCatalog

Deleted the BPA.

Go debug

Search for BPA Details

hcloud DataArtsStudio ShowBizCatalogDetail

Search for BPA details.

Go debug

Data Standard Templates

API Name

Command

Description

Operation

Querying a Data Standard Template

hcloud DataArtsStudio ShowStandardTemplate

This API is used to query data standard templates in the current workspace.

Go debug

Creating a Data Standard Template

hcloud DataArtsStudio CreateStandardTemplate

Creates a customized item of the data standard template in the current workspace.

Go debug

Modifying a Data Standard Template

hcloud DataArtsStudio UpdateStandardTemplate

Modify the data standard template.

Go debug

Deleting a Data Standard Template

hcloud DataArtsStudio DeleteStandardTemplate

Delete a data standard template.

Go debug

Standard Template for Initializing Data

hcloud DataArtsStudio InitializeStandardTemplate

Initialize the data standard template.

Go debug

Approval Management

API Name

Command

Description

Operation

Obtaining an Application

hcloud DataArtsStudio SearchApprovals

Obtain the application.

Go debug

Withdrawing an Application

hcloud DataArtsStudio RollbackApproval

Withdraw the application.

Go debug

Application Processing

hcloud DataArtsStudio ConfirmApprovals

Reject/Approve one or more action-id=reject/resolve.

Go debug

Batch Publish

hcloud DataArtsStudio BatchPublish

Batch Release

Go debug

Taking Services Offline in Batches

hcloud DataArtsStudio BatchOffline

Bring offline in batches.

Go debug

Create Approver

hcloud DataArtsStudio CreateApprover

Create an approver.

Go debug

Querying the Approver List

hcloud DataArtsStudio ListApprovers

This API queries the approver list.

Go debug

Delete Approver

hcloud DataArtsStudio DeleteApprover

Delete an approver.

Go debug

Deleting an Entity

hcloud DataArtsStudio DeleteDesignLatestApproval

When a released entity is edited, an extension is generated. This API is used to delete the extension information of the entity.

Go debug

Obtain the difference between the displayed information and the released entity.

hcloud DataArtsStudio SearchDesignLatestApprovalDiff

When a released entity is edited, an extension is generated. This API is used to obtain the difference between the extension information and the released entity.

Go debug

Subject Management

API Name

Command

Description

Operation

Searching for a Topic List

hcloud DataArtsStudio SearchSubject

Search for topics by name (fuzzy query is supported), creator, owner, status, and modification time.

Go debug

Deleting a Topic

hcloud DataArtsStudio DeleteSubject

Delete a topic.

Go debug

Creating a topic

hcloud DataArtsStudio CreateSubject

Creating a topic

Go debug

Changing a topic

hcloud DataArtsStudio UpdateSubject

Modify a theme.

Go debug

Obtaining Topic Tree Information

hcloud DataArtsStudio ListBusiness

Obtain the data asset subject tree information l1, l2, and l3.

Go debug

Find Topic List (New)

hcloud DataArtsStudio SearchSubjectNew

Search for a topic (new).

Go debug

Deleting a Theme (New)

hcloud DataArtsStudio DeleteSubjectNew

Delete a theme (new).

Go debug

Creating a Topic (New)

hcloud DataArtsStudio CreateSubjectNew

Create a topic (new).

Go debug

Modify Theme (New)

hcloud DataArtsStudio UpdateSubjectNew

Modify Theme (New).

Go debug

Subject Levels

API Name

Command

Description

Operation

Obtains the topic level.

hcloud DataArtsStudio ListSubjectLevels

Obtains the topic level.

Go debug

Modifying or Deleting a Topic Level

hcloud DataArtsStudio ChangeSubjects

Modify or delete a topic level.

Go debug

Catalog Management

API Name

Command

Description

Operation

Obtains all directories.

hcloud DataArtsStudio ListDirectories

Obtains all directories (data standards and code tables).

Go debug

Create a Directory

hcloud DataArtsStudio CreateDirectory

Create directories (data standards and code tables).

Go debug

Modifying a Directory

hcloud DataArtsStudio UpdateDirectory

Modify the directory (data standard and code table).

Go debug

Deleting a Directory

hcloud DataArtsStudio DeleteDirectory

Delete directories (data standards and code tables).

Go debug

Atomic Metrics

API Name

Command

Description

Operation

Searching for Atomic Metrics

hcloud DataArtsStudio SearchAtomicIndexes

This API is used to perform a paginated query of atomic metric information by name, creator, reviewer, status, and modification time. Names support fuzzy search.

Go debug

Creating Atomic Metrics

hcloud DataArtsStudio CreateDesignAtomicIndex

Create an atomic metric.

Go debug

Updating an Atomic Metric

hcloud DataArtsStudio UpdateDesignAtomicIndex

This API is used to update a single atomic metric.

Go debug

Deleting Atomic Metrics

hcloud DataArtsStudio DeleteDesignAtomicIndex

Delete atomic metrics in batches.

Go debug

Viewing Atomic Metric Details

hcloud DataArtsStudio ShowAtomicIndexById

This API is used to obtain atomic metric details by ID.

Go debug

Derivative Metrics

API Name

Command

Description

Operation

Searching for Derivative Indicators

hcloud DataArtsStudio ListDerivativeIndexes

Search for derivative metrics by name, creator, reviewer, status, modification time, and l3Id.

Go debug

Creating a Derivative Metric

hcloud DataArtsStudio CreateDesignDerivativeIndex

This API is used to create a derivative metric.

Go debug

Updating a Derivative Metric

hcloud DataArtsStudio UpdateDesignDerivativeIndex

This API is used to update a derivative metric.

Go debug

Deleting Derivative Metrics

hcloud DataArtsStudio DeleteDesignDerivativeIndex

This API is used to delete derivative metrics with specified IDs.

Go debug

Viewing Derivative Indicator Details

hcloud DataArtsStudio ShowDerivativeIndexById

This API is used to obtain derivative details by ID.

Go debug

Compound Metrics

API Name

Command

Description

Operation

Searching for a Composite Metric

hcloud DataArtsStudio ListCompoundMetrics

Search for compound metric information by name, creator, reviewer, status, modification time, and l3Id.

Go debug

Creating a Compound Metric

hcloud DataArtsStudio CreateDesignCompoundMetric

This API is used to create a compound metric.

Go debug

Updating a Compound Metric

hcloud DataArtsStudio UpdateDesignCompoundMetric

This API is used to update a compound metric.

Go debug

Deleting Compound Metrics

hcloud DataArtsStudio DeleteDesignCompoundMetric

This API is used to delete compound metrics with specified IDs.

Go debug

Viewing Composite Metric Details

hcloud DataArtsStudio ShowCompoundMetricById

This API is used to obtain details about a composite index by ID.

Go debug

Dimensions

API Name

Command

Description

Operation

Search Dimension

hcloud DataArtsStudio ListDimensions

Search for dimension information based on the Chinese and English names, description, creator, reviewer, status, l3Id, derivative indicator ID list, and modification time.

Go debug

Creating a Dimension

hcloud DataArtsStudio CreateDesignDimension

This API is used to create a dimension.

Go debug

Updating a Dimension

hcloud DataArtsStudio UpdateDesignDimension

This API is used to update a dimension.

Go debug

Deleting Dimensions

hcloud DataArtsStudio DeleteDesignDimension

This API is used to delete dimensions with specified IDs.

Go debug

Viewing Dimension Details

hcloud DataArtsStudio ShowDimensionById

This API is used to view dimension details by ID.

Go debug

View Dimension Granularity

hcloud DataArtsStudio ListDimensionGroups

This API is used to query the dimension granularity. All dimensions are queried based on tableId. If tableId is not transferred, the granularity of all dimension groups is queried.

Go debug

View Reverse Dimension Table Task

hcloud DataArtsStudio CheckDimensionStatus

View the reverse dimension table task.

Go debug

Filters

API Name

Command

Description

Operation

Searching for a Service Filter

hcloud DataArtsStudio ListCondition

Search for filter information by name, description, creator, reviewer, filter group ID, modification time, and status.

Go debug

Viewing Restriction Details

hcloud DataArtsStudio ShowConditionById

This API is used to query restriction details by ID.

Go debug

Dimension Tables

API Name

Command

Description

Operation

Searching for a Dimension Table

hcloud DataArtsStudio ListDimensionLogicTables

Search for dimension table information by Chinese and English names, creator, reviewer, status, and modification time.

Go debug

Deleting Dimension Tables

hcloud DataArtsStudio DeleteDesignDimensionLogicTable

This API is used to delete dimension tables with specified IDs.

Go debug

Viewing Dimension Table Details

hcloud DataArtsStudio ShowDimensionLogicTableById

This API is used to view details about a dimension table by ID.

Go debug

Fact Tables

API Name

Command

Description

Operation

Searching for a Fact Table

hcloud DataArtsStudio ListFactLogicTables

Search for fact table information by Chinese and English names, creator, reviewer, status, and modification time.

Go debug

Deleting Fact Tables

hcloud DataArtsStudio DeleteDesignFactLogicTable

This API is used to delete fact tables with specified IDs.

Go debug

Viewing Fact Table Details

hcloud DataArtsStudio ShowFactLogicTableById

This API is used to view details about a fact table by ID.

Go debug

Viewing a Reverse Fact Table Task

hcloud DataArtsStudio CheckFactLogicTableStatus

View the reverse fact table task.

Go debug

Summary Tables

API Name

Command

Description

Operation

Searching for a Summary Table

hcloud DataArtsStudio ListAggregationLogicTables

You can search for summary tables by Chinese and English names, creator, reviewer, status, and modification time. Fuzzy search is supported.

Go debug

Creating Summary Tables

hcloud DataArtsStudio CreateDesignAggregationLogicTable

Manually create a summary table based on the input parameters.

Go debug

Update Summary Table

hcloud DataArtsStudio UpdateDesignAggregationLogicTable

Update the summary table.

Go debug

Deleting Summary Tables

hcloud DataArtsStudio DeleteDesignAggregationLogicTable

You can delete summary tables in batches. Only tables in the Draft, Offline, or Rejected state can be deleted.

Go debug

Viewing SDR Table Details

hcloud DataArtsStudio ShowAggregationLogicTableById

This API is used to view details about an SDR table by ID.

Go debug

Business Metrics

API Name

Command

Description

Operation

Querying Service Indicator Information

hcloud DataArtsStudio ListBizMetrics

Search for service indicator information by name, creator, and modification time.

Go debug

Creating a Service Indicator

hcloud DataArtsStudio CreateBizMetric

Create a service indicator.

Go debug

Updating Service Indicators

hcloud DataArtsStudio UpdateBizMetric

Updated service indicators.

Go debug

Delete Business Metrics

hcloud DataArtsStudio DeleteBizMetric

Delete a service indicator.

Go debug

Viewing Indicator Details

hcloud DataArtsStudio ShowBizMetricById

This API is used to view indicator details by ID.

Go debug

Viewing Indicator Dimension Information

hcloud DataArtsStudio ListBizMetricDimensions

View the indicator dimension information.

Go debug

View Metric Owner Information

hcloud DataArtsStudio ListBizMetricOwners

View the metric owner information.

Go debug

Obtains indicator association information.

hcloud DataArtsStudio ListMetricRelations

This API is used to obtain the current metric graph.

Go debug

Version Information

API Name

Command

Description

Operation

Searching for Version Information

hcloud DataArtsStudio SearchVersions

Search for version information by name, creator, and modification time.

Go debug

Comparing Versions

hcloud DataArtsStudio CompareDesignVersions

This API is used to compare two versions with different IDs.

Go debug

ER Modeling

API Name

Command

Description

Operation

Lookup Table Model List

hcloud DataArtsStudio ListTableModels

Query table model information in relational modeling by Chinese and English names, creator, reviewer, status, and modification time. The table model information includes logical entities, physical tables, and attributes.

Go debug

Creating a Table Model

hcloud DataArtsStudio CreateTableModel

Create a table model in relational modeling, including logical entities and physical tables.

Go debug

Updating a Table Model

hcloud DataArtsStudio UpdateTableModel

Updates a table model and its attributes, including logical entities and physical tables, in relational modeling.

Go debug

Deleting a Table Model

hcloud DataArtsStudio DeleteTableModel

Deletes a table model and its attributes, including logical entities and physical tables, from relational modeling.

Go debug

Querying a Relationship

hcloud DataArtsStudio ListRelations

Search for relationship information by relationship name (fuzzy query is supported), creator, start time, and end time.

Go debug

Viewing Relationship Details

hcloud DataArtsStudio ShowRelationById

This API is used to obtain relationship details by ID.

Go debug

Querying All Relationships in a Model

hcloud DataArtsStudio ListTableModelRelations

This API is used to query all relationships in a model.

Go debug

Viewing Table Model Details

hcloud DataArtsStudio ShowTableModelById

This API is used to obtain model table details by ID.

Go debug

Obtaining a Model

hcloud DataArtsStudio ListWorkspaces

This API is used to obtain information about all models in the current space.

Go debug

Creating a Model Workspace

hcloud DataArtsStudio CreateWorkspace

Create a model workspace.

Go debug

Updating the Model Workspace

hcloud DataArtsStudio UpdateWorkspace

Update the model workspace.

Go debug

Deleting a Model Workspace

hcloud DataArtsStudio DeleteWorkspaces

Deletes a model workspace.

Go debug

Viewing Details About a Model

hcloud DataArtsStudio ShowWorkspaceDetailById

This API is used to query the workspace details of a physical or logical model.

Go debug

Querying Destination Tables and Fields (To Be Offline)

hcloud DataArtsStudio SearchFieldsForRelation

Query the destination table and fields (to be brought offline).

Go debug

Exporting DDL Statements of Tables in a Model

hcloud DataArtsStudio ExportDesignModelTableDdl

Exports DDL statements of a specified table based on the model ID.

Go debug

Converting a Logical Model to a Physical Model

hcloud DataArtsStudio BatchCreateDesignTableModelsFromLogic

This API is used to convert a logical model to a physical model and displays information of the physical model.

Go debug

Obtaining the Operation Result

hcloud DataArtsStudio ShowDesignOperationResult

This API is used to obtain the result of a batch operation, for example, converting a logical model to a physical model or reversing a database.

Go debug

Import and Export

API Name

Command

Description

Operation

Importing subjects

hcloud DataArtsStudio ImportCatalogs

Used to import themes.

Go debug

Import models, relationship modeling, dimension modeling, code tables, service indicators, and process architecture.

hcloud DataArtsStudio ImportModels

Import models, relationship modeling, dimension modeling, code tables, service indicators, and process architecture.

Go debug

Querying the Import Result

hcloud DataArtsStudio ImportResult

Query the processing result of importing the Excel file. The value of uuid is the result returned by the /design/models/action or /design/catalogs/action API.

Go debug

Exporting Service Data

hcloud DataArtsStudio ExportDesignModels

Export service data based on request parameters. The following data can be exported: code table, data standard, atomic metric, derivative metric, compound metric, summary table, service metric, theme, process, logical model, physical model, dimension, and fact table.

Go debug

Obtain the Excel export result.

hcloud DataArtsStudio ExportDesignResult

Obtain the Excel export result based on the UUID returned when the service data (/export-model) is exported.

Go debug

Customized Items

API Name

Command

Description

Operation

Querying Customized Items

hcloud DataArtsStudio SearchCustomizedFields

Query customized items (including table customized items, attribute customized items, theme customized items, and service indicator customized items).

Go debug

Modifying a Customized Item

hcloud DataArtsStudio ModifyCustomizedFields

Modify customized items (including table customized items, attribute customized items, theme customized items, and service indicator customized items).

Go debug

Quality Rules

API Name

Command

Description

Operation

Update the abnormal data output configuration of the table.

hcloud DataArtsStudio UpdateDesignTableQuality

Update the abnormal data output configuration of the table, including whether to generate abnormal data, setting the abnormal data database or schema, and setting the prefix or suffix of the abnormal table.

Go debug

Clear Quality Rule

hcloud DataArtsStudio RemoveDesignQualityInfos

Clears the quality rule of a table.

Go debug

Data Layers

API Name

Command

Description

Operation

get data layers info

hcloud DataArtsStudio ListDesignDataLayers

This API is used to obtain data warehouse layers.

Go debug

update or delete data layers

hcloud DataArtsStudio UpdateDesignDataLayers

This API is used to modify or delete a data warehouse layer.

Go debug

Rule Template APIs

API Name

Command

Description

Operation

Obtaining the Rule Template List

hcloud DataArtsStudio ListQualityTemplates

This API is used to obtain the list of rule templates.

Go debug

Obtaining Rule Template Details

hcloud DataArtsStudio ShowTemplatesDetail

This API is used to obtain the details of a rule template.

Go debug

Quality Job APIs

API Name

Command

Description

Operation

Obtaining the Quality Job List

hcloud DataArtsStudio ListQualityTask

This API is used to obtain the list of quality jobs.

Go debug

Obtaining Quality Job Details

hcloud DataArtsStudio ShowQualityTaskDetail

This API is used to obtain the details of a quality job.

Go debug

Comparison Job APIs

API Name

Command

Description

Operation

Obtaining the Comparison Job List

hcloud DataArtsStudio ListConsistencyTask

This API is used to obtain the list of comparison jobs.

Go debug

Obtaining Comparison Job Details

hcloud DataArtsStudio ShowConsistencyTaskDetail

This API is used to obtain the details of a comparison job.

Go debug

O&M APIs

API Name

Command

Description

Operation

Obtaining the Task Execution Result List

hcloud DataArtsStudio ListInstances

This API is used to obtain the list of task execution results.

Go debug

Obtaining the Instance Result

hcloud DataArtsStudio ShowInstanceResult

This API is used to obtain the instance result.

Go debug

Overview APIs

API Name

Command

Description

Operation

Querying and Collecting Statistics on User-related Overview Development Indicators

hcloud DataArtsStudio ShowApisOverview

This API is used to query and collect statistics on user-related overview development metrics.

Go debug

This API is used to query and collect statistics on user-related overview invoking metrics.

hcloud DataArtsStudio ShowAppsOverview

This API is used to query and collect statistics on user-related overview invoking metrics.

Go debug

Querying Top N API Services Invoked

hcloud DataArtsStudio ListApisTop

This API is used to query the top N API services invoked.

Go debug

Querying Top N App Services

hcloud DataArtsStudio ListAppsTop

This API is used to query top N services used by an app.

Go debug

Querying API Statistics Details

hcloud DataArtsStudio ShowApisDetail

This API is used to query API statistics details.

Go debug

Querying App Statistics Details

hcloud DataArtsStudio ShowAppsDetail

This API is used to query the statistics of an app.

Go debug

Querying API Dashboard Data Details

hcloud DataArtsStudio ShowApisDashboard

This API is used to query API dashboard data details.

Go debug

Querying Data Details of a Specified API Dashboard

hcloud DataArtsStudio ShowApiDashboard

This API is used to query details about a specified API dashboard.

Go debug

Querying App Dashboard Data Details

hcloud DataArtsStudio ShowAppsDashboard

This API is used to query app dashboard data details.

Go debug

Querying Top N APIs Invoked by a Specified API Application

hcloud DataArtsStudio ListApiTopN

This API is used to query top N APIs called by a specified application.

Go debug

Cluster Management APIs

API Name

Command

Description

Operation

Querying the Access Log List of a Data Service Cluster

hcloud DataArtsStudio ListDataServiceInstanceAccesslogs

This API is used to query the access logs of a DataArts DataService cluster.

Go debug

Enabling OBS Log Dump in a Data Service Cluster

hcloud DataArtsStudio UpdateDataServiceInstanceObsLog

This API is used to enable the logs of a DataArts DataService cluster to be dumped to OBS.

Go debug

Enabling LTS Log Dump for Data Service Clusters

hcloud DataArtsStudio UpdateDataServiceInstanceLtsLog

This API is used to enable the logs of a DataArts DataService cluster to be dumped to LTS.

Go debug

Instance Management APIs

API Name

Command

Description

Operation

Obtaining the List of Instances

hcloud DataArtsStudio ListDataArtsStudioInstances

Obtaining the instance list

Go debug

Instance Purchase APIs

API Name

Command

Description

Operation

Buying a DataArts Studio Instance with a Few Clicks

hcloud DataArtsStudio PayForDgcOneKey

This API is used to buy a DataArts Studio instance.

Go debug

Metadata Acquisition APIs

API Name

Command

Description

Operation

Obtaining the List of Databases

hcloud DataArtsStudio ListDatabases

This API is used to obtain the database list.

Go debug

Obtaining Schemas

hcloud DataArtsStudio ListSchemas

This API is used to obtain schemas. Only GaussDB(DWS) and RDS for PostgreSQL support schemas. Before calling this API, check whether the data source supports the schema field.

Go debug

Obtaining Tables in the Data Source

hcloud DataArtsStudio ListDataTables

This API is used to obtain tables in the data source.

Go debug

Obtaining Table Fields in the Data Source

hcloud DataArtsStudio ListColumns

This API is used to obtain table fields in the data source.

Go debug

Workspace Management APIs

API Name

Command

Description

Operation

Deleting Workspaces

hcloud DataArtsStudio BatchDeleteWorkspaces

This API is used to delete a workspace.

Go debug

Modifying a Workspace

hcloud DataArtsStudio UpdateWorkSpaceOld

This API is used to modify a workspace.

Go debug

Job Development Interface APIs

API Name

Command

Description

Operation

Stop a supplementary data instance

hcloud DataArtsStudio StopFactorySupplementDataInstance

This API is used to stop a specified PatchData instance. A PatchData instance can be stopped only when it is in running state.

Go debug

Create an interface for supplementing data instances

hcloud DataArtsStudio CreateFactorySupplementDataInstance

This API is used to create a PatchData instance.

Go debug

Query all supplementary data instances

hcloud DataArtsStudio ShowFactorySupplementData

This API is used to query PatchData instances. Pagination query is supported.

Go debug

Modify Job Name

hcloud DataArtsStudio UpdateFactoryJobName

This API is used to change the name of a job.

Go debug

Set Job Tags

hcloud DataArtsStudio SetFactoryJobTags

This API is used to configure job tags.

Go debug

Full text search

hcloud DataArtsStudio ShowFactoryFullText

This API is used to perform a global search.

Go debug

Query alarm notification records

hcloud DataArtsStudio ListFactoryAlarmInfo

This API is used to query the alarm notifications in a specified period.

Go debug

Query job table reference details for a single table

hcloud DataArtsStudio ListTaskTableReferenceDetail

Query the details of which jobs reference a table by table name, supporting filtering by input/output type, workspace, etc.

Go debug

Query the instance list of the specified job

hcloud DataArtsStudio ListFactoryJobInstancesByName

This API is used to query the instances of a job based on the job name.

Go debug

Rerun job instance

hcloud DataArtsStudio RetryFactoryJobInstance

Job instances and upstream and downstream job instances can be rerun.

Go debug

Publish Package Management Interface APIs

API Name

Command

Description

Operation

Query the list of packages to be published

hcloud DataArtsStudio ListFactoryPendingItems

This API is used to query the list of packages to be released.

Go debug

Pending package release

hcloud DataArtsStudio CreateFactoryPendingItemsPackage

This API is used to release a package.

Go debug

Baseline Operation and Maintenance APIs

API Name

Command

Description

Operation

Query the list of baseline instances

hcloud DataArtsStudio ListFactorySearchBaselineInstances

This API is used to query the application list in Review Center.

Go debug

Query event list

hcloud DataArtsStudio ListSearchFactoryEvents

Query event list

Go debug

Query the list of baseline tasks.

hcloud DataArtsStudio ListSearchFactoryBaselines

Query the list of baseline tasks.

Go debug

Create a baseline task.

hcloud DataArtsStudio CreateFactoryBaseline

Create a baseline task.

Go debug

DataFactory Approval Management APIs

API Name

Command

Description

Operation

Query the list of approval centers

hcloud DataArtsStudio ListFactoryWorkspacesApproval

Query the list of approval centers.

Go debug

Integration Job Log APIs

API Name

Command

Description

Operation

Listing Real-Time Processing Integration Job Logs

hcloud DataArtsStudio ListTaskLogs

This API is used to query the list of real-time processing integration job logs.

Go debug

Downloading Real-Time Processing Integration Job Logs

hcloud DataArtsStudio DownloadTaskLog

This API is used to obtain log content within a specified range. The maximum supported log size is 10 MB.

Go debug

Integration Job Monitoring APIs

API Name

Command

Description

Operation

Querying Real-Time Processing Integration Job Monitoring Metrics

hcloud DataArtsStudio ShowJobMonitorInfo

This API is used to query monitoring metric results of real-time processing integration job subtasks, including runtime metrics such as throughput and latency of each subtask.

Go debug

Querying Real-Time Job Details

hcloud DataArtsStudio ShowRealTimeJobDetails

This API is used to query detailed monitoring information about real-time jobs, including job status, engine version, tracking URL, and details of each subtask.

Go debug

Resource Group Network Connection Management APIs

API Name

Command

Description

Operation

Listing Resource Group Network Connections

hcloud DataArtsStudio ListDatasourceConnections

This API is used to query the list of DLI resource group network connections created by the user.

Go debug

Creating a Resource Group Network Connection

hcloud DataArtsStudio CreateDatasourceConnection

This API is used to create a resource group network connection with other services.

Go debug

Querying a Resource Group Network Connection

hcloud DataArtsStudio ShowDatasourceConnection

This API is used to query DLI resource group network connections created by the user.

Go debug

Modifying Host Information of a Resource Group Network Connection

hcloud DataArtsStudio UpdateDatasourceConnectionHostMessage

This API is used to modify data source host information in a DLI resource group network connection. Only full replacement is supported.

Go debug

Deleting a Resource Group Network Connection

hcloud DataArtsStudio DeleteDatasourceConnection

This API is used to delete a created DLI resource group network connection.

Go debug

Binding a Cluster

hcloud DataArtsStudio AssociateConnectionCluster

This API is used to bind a cluster to a created resource group network connection.

Go debug

Creating a Route

hcloud DataArtsStudio CreateDatasourceConnectionRoutes

This API is used to add a route to a resource group network connection.

Go debug

Deleting a Route

hcloud DataArtsStudio DeleteDatasourceConnectionRoutes

This API is used to delete a route added to a resource group network connection.

Go debug

Permission management APIs

API Name

Command

Description

Operation

Creating a Permission Set

hcloud DataArtsStudio CreateSecurityPermissionSet

Creating a Permission Set

Go debug

Querying the Permission Set List

hcloud DataArtsStudio ListSecurityPermissionSets

Querying the Permission Set List

Go debug

Querying Permission Sets

hcloud DataArtsStudio ShowSecurityPermissionSet

Querying Permission Sets

Go debug

Delete Permission Set

hcloud DataArtsStudio DeleteSecurityPermissionSet

Delete Permission Set

Go debug

Update Permission Set

hcloud DataArtsStudio UpdateSecurityPermissionSet

Update Permission Set

Go debug

Adding a Permission Set Member

hcloud DataArtsStudio CreateSecurityPermissionSetMember

Adding a Permission Set Member

Go debug

Querying the Member List of a Permission Set

hcloud DataArtsStudio ListSecurityPermissionSetMembers

Querying the Member List of a Permission Set

Go debug

Creating Permission Set Members in Batches

hcloud DataArtsStudio BatchCreateSecurityPermissionSetMembers

Creating Permission Set Members in Batches

Go debug

Deleting Permission Set Members in Batches

hcloud DataArtsStudio BatchDeleteSecurityPermissionSetMembers

Deleting Permission Set Members in Batches

Go debug

Adding Permissions to a Permission Set

hcloud DataArtsStudio CreateSecurityPermissionSetPermission

Adding Permissions to a Permission Set

Go debug

Querying the Permission List of a Permission Set

hcloud DataArtsStudio ListSecurityPermissionSetPermissions

Querying the Permission List of a Permission Set

Go debug

Appending Permissions from a Permission Set

hcloud DataArtsStudio BatchCreateSecurityPermissionSetPermissions

Appending Permissions from a Permission Set

Go debug

Deleting Permissions from a Permission Set

hcloud DataArtsStudio BatchDeleteSecurityPermissionSetPermissions

Deleting Permissions from a Permission Set

Go debug

Updating Permissions for a Permission Set

hcloud DataArtsStudio UpdateSecurityPermissionSetPermission

Updating Permissions for a Permission Set

Go debug

Query Permissions Available for a Data Source

hcloud DataArtsStudio ListSecurityDatasourceConfigurations

This API is used to query the permissions available for a data source.

Go debug

Querying URLs

hcloud DataArtsStudio ListSecurityDatasourceUrls

This API is used to query URLs.

Go debug

Querying Data Operations

hcloud DataArtsStudio ListSecurityDatasourceActions

This API is used to query data operations.

Go debug

Querying the Permission List of a Specified User

hcloud DataArtsStudio ListSecurityMemberPermissionsByUserId

This API is used to query the permission list of a specified user.

Go debug

Data classification rule management APIs

API Name

Command

Description

Operation

Querying the data classification rule list

hcloud DataArtsStudio ListSecurityDataClassificationRules

Querying the data classification rule list

Go debug

Creating data classification rule

hcloud DataArtsStudio CreateSecurityDataClassificationRule

Creating data classification rule

Go debug

Querying the data classification rule by id

hcloud DataArtsStudio ShowSecurityDataClassificationRule

Querying the data classification rule by id

Go debug

Deleting the data classification rule by id

hcloud DataArtsStudio DeleteSecurityDataClassificationRule

Deleting the data classification rule by id

Go debug

Updating the data classification rule by id

hcloud DataArtsStudio UpdateSecurityDataClassificationRule

Updating the data classification rule by id

Go debug

Batch deleting the data classification rules

hcloud DataArtsStudio BatchDeleteSecurityDataClassificationRule

Batch deleting the data classification rules

Go debug

Updating the data classification rule's enabled status by rule id

hcloud DataArtsStudio UpdateSecurityRuleEnableStatus

Updating the data classification rule's enabled status by rule id

Go debug

Data classification rule group management APIs

API Name

Command

Description

Operation

Querying the data classification rule group list

hcloud DataArtsStudio ListSecurityDataClassificationRuleGroups

Querying the data classification rule group list

Go debug

Querying the data classification rule group by id

hcloud DataArtsStudio ShowSecurityDataClassificationRuleGroup

Querying the data classification rule group by id

Go debug

Data Permission Query APIs

API Name

Command

Description

Operation

Querying Permissions of a Role on Databases and Tables

hcloud DataArtsStudio ListSecurityRoleActions

This API is used to query the permissions of a role on a group of databases and tables.

Go debug

Security Level Management APIs

API Name

Command

Description

Operation

Creating a Security Level

hcloud DataArtsStudio CreateSecuritySecrecyLevel

This API is used to create a security level.

Go debug

Obtaining a Security Level

hcloud DataArtsStudio ListSecuritySecrecyLevels

This API is used to obtain a security level.

Go debug

Querying a Specified Security Level

hcloud DataArtsStudio ShowSecuritySecrecyLevel

This API is used to query the security level with a specified ID.

Go debug

Deleting a Specified Security Level

hcloud DataArtsStudio DeleteSecuritySecrecyLevel

This API is used to delete the security level with a specified ID.

Go debug

Modifying a Specified Security Level

hcloud DataArtsStudio UpdateSecuritySecrecyLevel

This API is used to modify the security level with a specified ID.

Go debug

Deleting Security Levels

hcloud DataArtsStudio BatchDeleteSecuritySecrecyLevels

This API is used to delete security levels.

Go debug

Permission Application APIs

API Name

Command

Description

Operation

Querying DataArts Factory Data Connections That Support Fine-grained Authentication

hcloud DataArtsStudio ListSecurityDlfDataWareHouses

This API is used to query the DataArts Factory data connections that support fine-grained authentication.

Go debug

Updating Fine-grained Authentication Status of DataArts Factory Data Connections

hcloud DataArtsStudio BatchUpdateSecurityDlfDataWareHouses

This API is used to update the fine-grained authentication status of DataArts Factory data connections.

Go debug

Testing the Connectivity of a DataArts Factory Data Connection That Supports Fine-grained Authentication

hcloud DataArtsStudio DebugSecurityDlfDataWareHouses

This API is used to test the connectivity of a DataArts Factory data connection that supports fine-grained authentication.

Go debug

Sensitive Data Discovery Result Management APIs

API Name

Command

Description

Operation

Querying the Sensitive Data Discovery Result Overview by Category and Security Level

hcloud DataArtsStudio ListSecuritySensitiveDataOverviews

This API is used to query the sensitive data discovery result overview by category and security level.

Go debug

Querying Sensitive Data Discovery Details

hcloud DataArtsStudio ListSecuritySensitiveDataDetails

This API is used to query sensitive data discovery details.

Go debug

Workspace Resource Permission Policy Management

API Name

Command

Description

Operation

Querying Workspace Resource Permission Policies

hcloud DataArtsStudio ListSecurityResourcePermissions

This API is used to query workspace resource permission policies.

Go debug

Creating a Workspace Resource Permission Policy

hcloud DataArtsStudio CreateSecurityResourcePermissionPolicy

This API is used to create a workspace resource permission policy.

Go debug

Querying a Workspace Resource Permission Policy

hcloud DataArtsStudio ShowSecurityResourcePermissionPolicy

This API is used to query a workspace resource permission policy.

Go debug

Updating a Workspace Resource Permission Policy

hcloud DataArtsStudio UpdateSecurityResourcePermissionPolicy

This API is used to update a workspace resource permission policy.

Go debug

Deleting Workspace Resource Permission Policies

hcloud DataArtsStudio BatchDeleteSecurityResourcePermissionPolicies

This API is used to delete workspace resource permission policies.

Go debug

Data Security Diagnosis

API Name

Command

Description

Operation

Querying the Diagnosis Result of the Sensitive Data Protection Module

hcloud DataArtsStudio ShowSecuritySensitiveDataDiagnoseResult

This API is used to query the diagnosis result of the sensitive data protection module.

Go debug

Querying Tables for Which No Static Masking Task Has Been Performed

hcloud DataArtsStudio ShowSecurityNoMaskingTableResult

This API is used to query the tables for which no static masking task has been performed.

Go debug

Querying the Diagnosis Result of the Data Source Protection Module

hcloud DataArtsStudio ShowSecurityDatasourceProtectionDiagnoseResult

This API is used to query the diagnosis result of the data source protection module.

Go debug

Diagnosing Data Security

hcloud DataArtsStudio ExecuteSecurityDiagnose

This API is used to diagnose data security.

Go debug

Query Improper Permission Configurations

hcloud DataArtsStudio ListSecurityUnreasonablePermissions

This API is used to query improper permission configurations.

Go debug

Querying the Diagnosis Result of the Data Permission Control Module

hcloud DataArtsStudio ShowSecurityPermissionManagementDiagnoseResult

This API is used to query the diagnosis result of the data permission control module.

Go debug

Data Classification

API Name

Command

Description

Operation

Importing a Preset Classification

hcloud DataArtsStudio ImportSecurityBuiltinCategoryGroups

This API is used to import a preset classification.

Go debug

Creating a Data Classification

hcloud DataArtsStudio CreateSecurityDataCategory

This API is used to create a data classification.

Go debug

Deleting Data Classifications

hcloud DataArtsStudio BatchDeleteSecurityDataCategories

This API is used to delete data classifications.

Go debug

Modifying a Data Classification

hcloud DataArtsStudio UpdateSecurityDataCategories

This API is used to modify a data classification.

Go debug

Permission Approval

API Name

Command

Description

Operation

Approving a Service Ticket

hcloud DataArtsStudio AcceptSecurityApplication

This API is used to approve a service ticket.

Go debug

Rejecting a Service Ticket

hcloud DataArtsStudio DeclineSecurityApplication

This API is used to reject a service ticket.

Go debug

Obtaining the Service Ticket List

hcloud DataArtsStudio ListSecurityApprovals

This API is used to obtain the service ticket list.

Go debug

Approving Service Tickets

hcloud DataArtsStudio BatchApproveSecurityApplications

This API is used to approve service tickets.

Go debug

Rejecting Service Tickets

hcloud DataArtsStudio BatchRejectSecurityApplications

This API is used to reject service tickets.

Go debug

Lookup Table Management

API Name

Command

Description

Operation

Querying the Lookup List

hcloud DataArtsStudio SearchCodeTables

This API is used to query the lookup table list.

Go debug

Creating a Lookup Table

hcloud DataArtsStudio CreateCodeTable

Create a lookup table.

Go debug

Deleting Lookup Tables

hcloud DataArtsStudio DeleteCodeTable

Deletes a lookup table.

Go debug

Modifying a Lookup Table

hcloud DataArtsStudio UpdateCodeTable

Modify the lookup table.

Go debug

Viewing Lookup Table Details

hcloud DataArtsStudio ShowCodeTableById

This API is used to view details about a lookup table by ID.

Go debug

Viewing Field Values in the Code Table

hcloud DataArtsStudio SearchCodeTableValues

Check the values of the fields in the code table.

Go debug

Edit Code Table Field Value

hcloud DataArtsStudio UpdateCodeTableValues

Edit the values of the fields in the lookup table.

Go debug

Tag API

API Name

Command

Description

Operation

Add a tag

hcloud DataArtsStudio AddDesignEntityTags

Tags an asset (table or attribute) based on its ID.

Go debug

Delete a tag.

hcloud DataArtsStudio RemoveDesignEntityTags

This API is used to delete an asset tag based on the ID of an asset (table or attribute).

Go debug

Catalog APIs

API Name

Command

Description

Operation

Obtaining Job Catalogs

hcloud DataArtsStudio ListCategory

This API is used to obtain job directories.

Go debug

API Management APIs

API Name

Command

Description

Operation

Create an API.

hcloud DataArtsStudio CreateApi

Create an API.

Go debug

Querying an API List

hcloud DataArtsStudio ListApis

This API is used to query the API list.

Go debug

Updating an API

hcloud DataArtsStudio UpdateApi

Update the API.

Go debug

Querying API Information

hcloud DataArtsStudio ShowApi

This API is used to query API information.

Go debug

Deleting multiple APIs

hcloud DataArtsStudio DeleteApi

This API is used to delete APIs in batches.

Go debug

Publishing an API

hcloud DataArtsStudio PublishApiToInstance

Publish the API Only published APIs can be called. You can choose to publish an API to a specified gateway.

Go debug

API operations (offline/suspension/resumption)

hcloud DataArtsStudio ExecuteApiToInstance

  • Bring the API offline. Take a published API offline. After the API is unpublished, its authorization will be canceled and the API cannot be called.
  • Disable an API. Temporarily take a published API offline. After the API is suspended, its authorization will be retained. The API cannot be called during the suspension.
  • Restore the API. This API is used to resume a disabled API. After the API is restored, it can be called again.

Go debug

Batch Authorization API (Exclusive Edition)

hcloud DataArtsStudio AuthorizeApiToInstance

An app cannot access any APIs after being created. To enable an app to access an API, authorize the API to the app. After the authorization is successful, the app can access the API within the validity period.

Go debug

Debugging an API

hcloud DataArtsStudio DebugApi

Debug the API.

Go debug

API authorization operations (authorization/authorization cancellation/application/renewal)

hcloud DataArtsStudio AuthorizeActionApiToInstance

  • Proactive API authorization: An API reviewer can initiate an API authorization request. After the API authorization is successful, the app can access the API within the validity period. API authorization includes authorization and renewal.
  • Authorization: Apps are granted the right to access APIs within the validity period.
  • Renewal: The validity period of the authorization is updated during renewal. The validity period can be extended but cannot be reduced.
  • API authorization cancellation: An API reviewer can cancel the authorization relationship between an API and an app. After the API authorization is canceled, the app can no longer call the API. Before performing this operation, reserve at least two days for the app to make preparations.
  • App authorization cancellation: The app owner can initiate a request to cancel the authorization relationship between an API and an app. After the API authorization is canceled, the app can no longer call the API. This operation requires no preparation time.
  • App authorization application: An app owner can initiate an application for an API. After the application is approved by the API reviewer, the app can access the API. The authorization grants the app the right to access the API within the validity period. The API review is required.
  • App renewal: The app owner can initiate a renewal request. The renewal will update the authorization validity period. The validity period can be extended but cannot be reduced. The renewal needs to be reviewed by the API.

Go debug

Querying API Publishing Messages in DLM Exclusive

hcloud DataArtsStudio SearchPublishInfo

This API is used to query the API publishing messages in different clusters.

Go debug

Querying Instances for API Operations in DLM Exclusive

hcloud DataArtsStudio ListInstanceList

This API is used to query instances for API operations (Exclusive Edition).

Go debug

Querying API Debugging Messages in DLM Exclusive

hcloud DataArtsStudio SearchDebugInfo

This API is used to query the API debugging information in different clusters.

Go debug

Importing an Excel File Containing API Information

hcloud DataArtsStudio ImportDataServiceExcel

This API is used to import an Excel file that contains APIs.

Go debug

Exporting an Excel File Containing API Information

hcloud DataArtsStudio ExportDataServiceExcel

This API is used to export an Excel file that contains APIs.

Go debug

Exporting a .zip File Containing All APIs

hcloud DataArtsStudio ExportDataServiceZip

This API is used to export a .zip file that contains all APIs.

Go debug

Downloading an Excel Template

hcloud DataArtsStudio ExportDataServiceExcelTemplate

This API is used to download an Excel template.

Go debug

Application Management APIs

API Name

Command

Description

Operation

Querying the Application List

hcloud DataArtsStudio ListApply

This API is used to query the application list.

Go debug

Reviewing Applications

hcloud DataArtsStudio BatchApproveApply

Review the application.

Go debug

Obtaining Application Details

hcloud DataArtsStudio ShowApplyDetail

This API is used to obtain application details.

Go debug

Creating an app

hcloud DataArtsStudio CreateApp

This API is used to create an app

Go debug

Query the application list.

hcloud DataArtsStudio ListApps

Query an application list.

Go debug

Updating an application

hcloud DataArtsStudio UpdateApp

App update

Go debug

Deleting applications

hcloud DataArtsStudio DeleteApp

Delete an app.

Go debug

Query the details about an application.

hcloud DataArtsStudio ShowAppInfo

This API is used to query app details.

Go debug

Message Management APIs

API Name

Command

Description

Operation

Querying the Message List

hcloud DataArtsStudio ListMessage

This API is used to query the notification message list of the review center. Different from applications, notification messages cannot be rejected and can be processed only within a specified time period.

Go debug

Processing Messages

hcloud DataArtsStudio ConfirmMessage

Confirms received notification messages and selects when to process the messages within a specified time range.

Go debug

Obtaining Message Details

hcloud DataArtsStudio ShowMessageDetail

This API is used to obtain message details. This function is only used for displaying application details and not for processing. Therefore, background parameters such as the ID are not displayed.

Go debug

Service Catalog Management APIs

API Name

Command

Description

Operation

Obtaining the List of APIs and Catalogs in a Catalog

hcloud DataArtsStudio ListAllCatalogList

This API is used to obtain the list of APIs and catalogs in the current catalog. The list is displayed in the data format of the catalog.

Go debug

Obtaining the List of APIs in a Catalog

hcloud DataArtsStudio ListApiCatalogList

This API is used to obtain the list of APIs in a catalog.

Go debug

Obtaining the List of Sub-Catalogs in a Catalog

hcloud DataArtsStudio ListCatalogList

This API is used to obtain the directory list in the current directory. (Full data is not displayed on multiple pages. It is recommended that this API be used only in scenarios where pagination cannot be performed, such as directory tree generation.)

Go debug

Updating a Service Catalog

hcloud DataArtsStudio UpdateCatalog

This API is used to update a service catalog.

Go debug

Query the service catalog

hcloud DataArtsStudio ShowCatalogDetail

This API is used to query a service catalog.

Go debug

Creating a Service Catalog

hcloud DataArtsStudio CreateServiceCatalog

This API is used to create a service catalog. The ID of the root catalog is 0.

Go debug

Deleting Directories in Batches

hcloud DataArtsStudio DeleteServiceCatalog

This API is used to delete service catalogs in batches.

Go debug

Moving a Catalog to Another Catalog

hcloud DataArtsStudio MigrateCatalog

This API is used to move a catalog to another catalog.

Go debug

Moving APIs to Another Catalog

hcloud DataArtsStudio MigrateApi

This API is used to move APIs to another catalog.

Go debug

Obtaining the ID of a Catalog Through Its Path

hcloud DataArtsStudio SearchIdByPath

This API is used to obtain the ID of catalog through its path.

Go debug

Obtaining the Path of a Catalog Through Its ID

hcloud DataArtsStudio ShowPathById

This API is used to obtain the path of a catalog through its ID.

Go debug

Obtaining the Paths to a Catalog Through Its ID

hcloud DataArtsStudio ShowPathObjectById

Obtains a path object based on the directory ID.

Go debug

Gateway Management APIs

API Name

Command

Description

Operation

Obtaining a Gateway Instance (Exclusive Edition)

hcloud DataArtsStudio ListApicInstances

This API is used to obtain a gateway instance (exclusive edition).

Go debug

Obtaining a Gateway Group

hcloud DataArtsStudio ListApicGroups

This API is used to obtain gateway groups.

Go debug

Authorization Management APIs

API Name

Command

Description

Operation

Querying Apps Bound to an API

hcloud DataArtsStudio SearchAuthorizeApp

This API is used to query the apps that have been authorized to an API.

Go debug

Querying Authorized APIs of an App

hcloud DataArtsStudio SearchBindApi

This API is used to query authorized APIs of an app.

Go debug

Identification Rules

API Name

Command

Description

Operation

Creating a Combined Identification Rule

hcloud DataArtsStudio CreateSecurityDataClassificationCombineRule

This API is used to create a combined identification rule.

Go debug

Modifying a Combined Identification Rule

hcloud DataArtsStudio UpdateSecurityDataClassificationCombineRule

This API is used to modify a combined identification rule.

Go debug

Testing a Combined Identification Rule

hcloud DataArtsStudio CheckSecurityDataClassificationCombineRule

This API is used to test a combined identification rule.

Go debug

Rule Groups

API Name

Command

Description

Operation

Creating a Rule Group

hcloud DataArtsStudio CreateSecurityDataClassificationRuleGroup

This API is used to create a rule group.

Go debug

Modifying a Rule Group

hcloud DataArtsStudio UpdateSecurityDataClassificationRuleGroup

This API is used to modify a rule group.

Go debug

Deleting a Rule Group

hcloud DataArtsStudio DeleteSecurityDataClassificationRuleGroup

This API is used to delete a rule group.

Go debug

Data Classifications

API Name

Command

Description

Operation

Querying the Data Classification List

hcloud DataArtsStudio ListSecurityDataCategories

This API is used to query the data classification list.

Go debug

Security Administrator

API Name

Command

Description

Operation

Obtaining the Security Administrator

hcloud DataArtsStudio ShowSecurityAdmin

This API is used to obtain the security administrator.

Go debug

Creating or Updating a Security Administrator

hcloud DataArtsStudio ModifySecurityAdmin

This API is used to create or update a security administrator.

Go debug

Dynamic Data Masking

API Name

Command

Description

Operation

Querying Dynamic Data Masking Policies

hcloud DataArtsStudio ListSecurityDynamicMaskingPolicies

This API is used to query dynamic data masking policies.

Go debug

Creating a Dynamic Data Masking Policy

hcloud DataArtsStudio CreateSecurityDynamicMaskingPolicy

This API is used to create a dynamic data masking policy.

Go debug

Query Details of a Data Masking Policy

hcloud DataArtsStudio ShowSecurityDynamicMaskingPolicy

This API is used to query the details of a data masking policy.

Go debug

Updating a Dynamic Data Masking Policy

hcloud DataArtsStudio UpdateSecurityDynamicMaskingPolicy

This API is used to update a dynamic data masking policy.

Go debug

Deleting Dynamic Masking Policies

hcloud DataArtsStudio BatchDeleteSecurityDynamicMaskingPolicies

This API is used to delete dynamic masking policies.

Go debug

Permission Application

API Name

Command

Description

Operation

Withdrawing a Permission Application Service Ticket

hcloud DataArtsStudio UnpublishSecurityApplication

This API is used to withdraw a permission application service ticket.

Go debug

Monitoring and operation maintenance

API Name

Command

Description

Operation

Query instance running status

hcloud DataArtsStudio ListFactoryTaskOverview

This API is used to query the instance statuses of the current day, previous day, the day before the previous day, and last seven days.

Go debug

Query task completion status

hcloud DataArtsStudio ListFactoryTaskCompletion

This API is used to query the tasks completed on a specified daythe current day, the previous daythe previous day of a specified day, and over the last seven days of a specified day.

Go debug

Enterprise mode release package management

API Name

Command

Description

Operation

Publishing Package Management - List Query

hcloud DataArtsStudio ListFactoryReleasePackages

This API is used to list release packages.

Go debug

Query the details of the specified publishing package

hcloud DataArtsStudio ShowFactoryPackageDetail

This API is used to query details about a release package.

Go debug

Publish Task Package

hcloud DataArtsStudio DeployFactoryPackages

This API is used to release task packages.

Go debug

Revoke Task Package

hcloud DataArtsStudio CancelFactoryPackages

This API is used to cancel task packages.

Go debug

Script development interface

API Name

Command

Description

Operation

Query Script List

hcloud DataArtsStudio ListFactoryScripts

This API is used to query the script list.

Go debug

Notification Management

API Name

Command

Description

Operation

Query notification rule list

hcloud DataArtsStudio ListFactoryAlarmRules

This API is used to query the notification rule list.

Go debug

Job Development

API Name

Command

Description

Operation

Query the upstream and downstream dependency instances of the job instance.

hcloud DataArtsStudio ShowFactoryDependInstances

Query the upstream and downstream dependency instances of the job instance.

Go debug

Query the upstream and downstream dependency relationships of the job.

hcloud DataArtsStudio ShowFactoryJobDependInstances

Provides an external interface to query the upstream and downstream dependency relationships of a job and the responsible persons.

Go debug

Integration Cluster Management APIs

API Name

Command

Description

Operation

Creating a Cluster

hcloud DataArtsStudio CreateCluster

This API is used to create a cluster.

Go debug

Batch Associating or Disassociating Data Integration Resources with Workspaces

hcloud DataArtsStudio BatchBindMigrationResourceToWorkspace

This API is used to batch associate or disassociate data integration resources with a workspace. The action field in workspaces is used to distinguish the operation type. band indicates association, and remove indicates disassociation.

Go debug