All Products
Search
Document Center

List of operations by function

Last Updated: Jan 22, 2021

The following tables list API operations available for use in AIRec.

Note: All the features that are implemented by calling API operations are available in the AIRec console.

Instances

Operation

Description

ListInstance

Queries the details of one or more instances.

CreateInstance

Creates an AIRec instance.

DescribeInstance

Queries the details of an instance based on a specified instance ID.

ModifyInstance

Modifies the configurations of a specified instance.

UpgradeInstance

Increases quotas of a specified instance.

RunInstance

Runs a specified instance to start a full data import task.

ValidateInstance

Verifies the validity of information of a specified instance.

DowngradeInstance

Decreases quotas of a specified instance.

DescribeUserMetrics

Queries user metrics related to the conversion rate.

Data sources

Operation

Description

ListDataSource

Queries the data sources of a specified instance.

ModifyDataSource

Modifies the information of a single data source in a specified table of a specified instance.

Datasets

Operation

Description

ListDataSet

Queries datasets of a specified instance.

AttachDataSet

Uses a dataset of a specific version of a specified instance to provide online services.

StopDataSet

Stops a dataset of a specified version for a specified instance.

DeleteDataSet

Deletes a dataset of a specified version for an instance.

DescribeDataSetMessage

Queries the error details of data in a specified dataset version of a specified instance.

Data dashboards

Operation

Description

ListDashboardDetailsFlows

Queries the details of traffic metrics of a specified instance based on specified conditions.

ListDashboardMetricsFlows

Queries the traffic data on the dashboard of a specified instance.

ListDashboardDetails

Queries the metric details of a specified instance based on specified conditions.

ListDashboardMetrics

Queries the metrics of a specified instance on a dashboard.

ListSceneParameters

Queries all channels and scenes of a specified instance.

Data tables

Operation

Description

QueryRawData

Queries raw data of the current instance in a specific data table by using the primary key.

QueryDataMessage

Queries update messages in a specified data table of a specified instance.

QueryDataMessageStatistics

Queries update message statistics in a specified data table of a specified instance.

Data management

Operation

Description

QuerySingleReport

Queries a single table report. (More report types will be supported.)

QuerySingleAggregationReport

Queries data in a user table, item table, or behavior table by using an aggregation function.

QueryExceptionHistory

Queries historical abnormal data generated within a specific time period.

QuerySyncReportAggregation

Queries the data overview.

DescribeSyncReportOutliers

Queries details about abnormal data in a real-time data report.

DescribeSyncReportDetail

Queries details about real-time data in an hourly report.

Others

Operation

Description

DescribeQuota

Queries the quota of an instance based on a specified instance ID.

ListInstanceTask

Queries all asynchronous tasks of a specified instance by using the instance ID.

ListLogs

Queries the log information of a specified instance over the last seven days.

Scenes

Operation

Description

CreateScene

Creates a scene and verifies the information that you specified for creating the scene.

ModifyScene

Modifies information of a scene.

ListScenes

Queries scenes of a specified instance.

ListSceneItems

Queries preview results.

DeleteScene

Deletes a scene.

DescribeScene

Queries detailed information of a specified scene.

DescribeSceneThroughput

Queries traffic data of a specified scene.

Operations rules and item selection rules

Operation

Description

CreateRule

Creates a rule.

ListRules

Queries rules.

ListRuleConditions

Queries item selection rules of an instance.

PublishRule

Publishes a rule.

ModifyRule

Modifies a rule.

DescribeRule

Queries detailed information about a rule.

ListRuleTask

Queries the status of a rule-specific task.