# Alibaba Cloud Platform for Artificial Intelligence PAI -… API

> Alibaba Cloud Platform for Artificial Intelligence PAI -… API on Apizie: 168 endpoints (Applies an engine configuration, Performs data backflow for the most recently created task under the specified feature consistency check job…, This API changes the version of a recall management service, Sends a conversation message to an agent. Supports Server-Sent Events (SSE). Creates a new session or…, …) returned as clean JSON through one API key. Send your own provider key in the x-upstream-key header. Call it over REST at https://zieapi.vercel.app/v1/cloud:aliyun-pairecservice/{endpoint} or from Claude, ChatGPT and Cursor through the Apizie MCP server. Free plan: 1,000 requests a month.

- Project key: `cloud:aliyun-pairecservice`
- Category: Cloud
- Status: byok
- Source: https://api.alibabacloud.com/product/pairecservice
- Page: https://zieapi.vercel.app/api/cloud/aliyun-pairecservice
- OpenAPI: https://zieapi.vercel.app/api/cloud/aliyun-pairecservice/openapi.json

Alibaba Cloud OpenAPI for Platform for Artificial Intelligence PAI - Programmable Recommend System (pairecservice, version 2022-12-13). Calls are signed with ACS3-HMAC-SHA256 using your AccessKey ID and secret.

## Endpoints

### Applies an engine configuration
`POST https://zieapi.vercel.app/v1/cloud:aliyun-pairecservice/apply-engine-config` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://pairecservice.ap-southeast-1.aliyuncs.com |
| EngineConfigId | string | yes | The engine configuration ID |
| InstanceId | string | no | The instance ID. You can obtain this by calling the https://help.aliyun.com/document_detail/2411819.html API |

### Performs data backflow for the most recently created task under the specified feature consistency check job…
`POST https://zieapi.vercel.app/v1/cloud:aliyun-pairecservice/backflow-feature-consistency-check-job-data` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://pairecservice.ap-southeast-1.aliyuncs.com |
| FeatureConsistencyCheckJobConfigId | string | yes | The ID of the feature consistency check job configuration. For more information about how to obtain the configuration ID, see… |
| InstanceId | string | yes | The instance ID. For more information about how to obtain the instance ID, see https://help.aliyun.com/document_detail/2411819.html |
| ItemFeatures | string | yes | The item features |
| LogItemId | string | yes | The item ID in the log |
| LogRequestId | string | yes | The log request ID |
| LogRequestTime | integer | yes | The log request time (UNIX timestamp) |
| LogUserId | string | yes | The user ID in the log |
| SceneName | string | yes | The scene name |
| Scores | string | yes | The scores |
| ServiceName | string | no | The service name |
| UserFeatures | string | yes | The user features |

### This API changes the version of a recall management service
`POST https://zieapi.vercel.app/v1/cloud:aliyun-pairecservice/change-recall-management-service-version` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://pairecservice.ap-southeast-1.aliyuncs.com |
| RecallManagementServiceId | string | yes | The recall management service ID |
| InstanceId | string | no | The instance ID |
| RecallManagementServiceVersionId | string | no | The recall management service version ID |

### Sends a conversation message to an agent. Supports Server-Sent Events (SSE). Creates a new session or…
`POST https://zieapi.vercel.app/v1/cloud:aliyun-pairecservice/chat-conversation` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://pairecservice.ap-southeast-1.aliyuncs.com |
| Config | string | no | The additional information input in JSON format |
| Content | string | yes | The message content |
| ConversationId | string | no | The session ID. If you do not specify this parameter, a new session is created. If you specify this parameter, the conversation continues… |
| InstanceId | string | yes | The instance ID |

### Checks the connection status of the resources configured for an instance
`POST https://zieapi.vercel.app/v1/cloud:aliyun-pairecservice/check-instance-resources` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://pairecservice.ap-southeast-1.aliyuncs.com |
| ResourceId | string | no | The data source ID |
| Type | string | yes | The resource type. Valid values: Hologres EAS BE Rec Platform SLS DataHub Kafka Flinkvvp ACR OSS DataWorks PAI MaxCompute GraphCompute Redis |
| Uri | string | no | The resource URI |
| InstanceId | string | yes | The ID of the instance. You can call the https://help.aliyun.com/document_detail/2411819.html operation to obtain the instance ID |

### Validates a traffic control task expression
`GET https://zieapi.vercel.app/v1/cloud:aliyun-pairecservice/check-traffic-control-task-expression` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://pairecservice.ap-southeast-1.aliyuncs.com |
| InstanceId | string | yes | The ID of the instance |
| Expression | string | yes | The expression to validate |
| TableMetaId | string | yes | The ID of the table |

### Clones a DPI engine configuration
`POST https://zieapi.vercel.app/v1/cloud:aliyun-pairecservice/clone-engine-config` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://pairecservice.ap-southeast-1.aliyuncs.com |
| EngineConfigId | string | yes | The DPI engine configuration ID |
| ConfigValue | string | no | The content of the DPI engine configuration |
| Description | string | no | The description |
| Environment | string | no | The runtime environment. Valid values: Daily: daily environment. Pre: staging environment. Prod: production environment |
| InstanceId | string | no | The instance ID. For information about how to obtain the instance ID, see https://help.aliyun.com/document_detail/2411819.html |
| SceneId | string | no | The scene |

### Clones a specified experiment
`POST https://zieapi.vercel.app/v1/cloud:aliyun-pairecservice/clone-experiment` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://pairecservice.ap-southeast-1.aliyuncs.com |
| ExperimentId | string | yes | The experiment ID |
| InstanceId | string | yes | The instance ID. Call the ListInstances operation to get the instance ID |

### Clones an experiment group to a specified environment
`POST https://zieapi.vercel.app/v1/cloud:aliyun-pairecservice/clone-experiment-group` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://pairecservice.ap-southeast-1.aliyuncs.com |
| ExperimentGroupId | string | yes | The experiment group ID. You can get this ID by calling the ListExperimentGroups operation |
| Environment | string | yes | The target environment for the experiment group. ● Daily: Daily environment ● Pre: pre-release environment ● Prod: production environment |
| InstanceId | string | yes | The instance ID. You can get this ID by calling the ListInstances operation |
| LayerId | string | yes | The layer ID. You can get this ID by calling the ListLayers operation |

### Clones a feature consistency check job configuration
`POST https://zieapi.vercel.app/v1/cloud:aliyun-pairecservice/clone-feature-consistency-check-job-config` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://pairecservice.ap-southeast-1.aliyuncs.com |
| SourceFeatureConsistencyCheckJobConfigId | string | yes | The ID of the source feature consistency check job configuration. To get the ID, call https://help.aliyun.com/document_detail/2557567.html |
| InstanceId | string | yes | The instance ID. To get the ID, call https://help.aliyun.com/document_detail/2411819.html |

### Clones a specified laboratory to a designated environment. You can specify whether to clone the experiment…
`POST https://zieapi.vercel.app/v1/cloud:aliyun-pairecservice/clone-laboratory` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://pairecservice.ap-southeast-1.aliyuncs.com |
| LaboratoryId | string | yes | The laboratory ID. To obtain this ID, call the `ListLaboratories` operation |
| CloneExperimentGroup | string | yes | Specifies whether to clone the experiment groups |
| Environment | string | yes | The destination environment. Valid values: Daily, Pre (pre-release), and Prod (production) |
| InstanceId | string | yes | The instance ID. To obtain this ID, call the `ListInstances` operation |

### Clones a specified traffic control task to a new instance
`POST https://zieapi.vercel.app/v1/cloud:aliyun-pairecservice/clone-traffic-control-task` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://pairecservice.ap-southeast-1.aliyuncs.com |
| TrafficControlTaskId | string | yes | Traffic control task ID |
| InstanceId | string | no | Instance ID |

### Creates an AB metric
`POST https://zieapi.vercel.app/v1/cloud:aliyun-pairecservice/create-abmetric` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://pairecservice.ap-southeast-1.aliyuncs.com |
| AggregationByUser | string | no | 计算显著性时，是否按照用户维度来计算。一共有两种逻辑，一种是按用户，一种是按样本 |
| Definition | string | yes | The metric definition |
| Denominator | string | no | 当进行显著性计算时，计算的分母 |
| Description | string | yes | The metric description |
| InstanceId | string | yes | The instance ID. Call the https://help.aliyun.com/document_detail/2411819.html operation to obtain this ID |
| IsBinomialDistribution | string | no | 当指标类型是衍生指标时，当前指标是否符合二项分布，是的话会二项式分布计算指标的均值和方差 |
| LeftMetricId | string | no | The ID of the left metric used to calculate the derived metric |
| Name | string | yes | The metric name |
| NeedSignificance | string | no | 是否计算显著性 |
| Numerator | string | no | 当进行显著性计算时，计算的分子 |
| Operator | string | no | The operator used to calculate the derived metric. Valid values: `Plus`: Addition `Minus`: Subtraction `Multiplication`: Multiplication… |
| Realtime | string | yes | Specifies whether the metric is a real-time metric. Valid values: `true`: The metric is real-time. `false`: The metric is not real-time |
| ResultResourceId | string | no | The data source ID to which the results are written back. Call the ListInstanceResources operation to obtain this ID |
| RightMetricId | string | no | The ID of the right metric used to calculate the derived metric |
| SceneId | string | yes | The scene ID. Call the https://help.aliyun.com/document_detail/2402581.html operation to obtain this ID |
| StatisticsCycle | integer | no | The statistics cycle |
| TableMetaId | string | yes | The data table ID. Call the ListTableMetas operation to obtain this ID |
| Type | string | yes | The metric type. Valid values: `Single`: A single metric. `Derived`: A derived metric |

### Creates an A/B metric group
`POST https://zieapi.vercel.app/v1/cloud:aliyun-pairecservice/create-abmetric-group` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://pairecservice.ap-southeast-1.aliyuncs.com |
| ABMetricIds | string | yes | The A/B metric IDs. Separate multiple IDs with commas (,) |
| Description | string | yes | The description of the metric group |
| InstanceId | string | yes | The ID of the instance. You can call the https://help.aliyun.com/document_detail/2411819.html operation to obtain this ID |
| Name | string | yes | The name of the metric group |
| Realtime | string | yes | Specifies whether the metric group is a real-time metric group |
| SceneId | string | yes | The ID of the scene. You can call the https://help.aliyun.com/document_detail/2402581.html operation to obtain this ID |

### Creates compute tasks in batches
`POST https://zieapi.vercel.app/v1/cloud:aliyun-pairecservice/create-calculation-jobs` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://pairecservice.ap-southeast-1.aliyuncs.com |
| ABMetricIds | string | yes | The list of ABTest metric IDs, separated by commas |
| EndDate | string | yes | The end date. The format is YYYY-MM-DD |
| InstanceId | string | yes | The instance ID. You can obtain the instance ID by calling https://help.aliyun.com/document_detail/2411819.html |
| StartDate | string | yes | The start date. The format is YYYY-MM-DD |

### Creates a crowd that represents a group of users
`POST https://zieapi.vercel.app/v1/cloud:aliyun-pairecservice/create-crowd` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://pairecservice.ap-southeast-1.aliyuncs.com |
| Description | string | yes | The description of the crowd |
| InstanceId | string | yes | The instance ID. To get this ID, call the ListInstances operation |
| Label | string | no | The crowd label |
| Name | string | yes | The crowd name |
| Source | string | no | The source of the user data. Valid values: ● ManualInput: Users are provided in the Users parameter. ● UploadFile: Users are provided from… |
| Users | string | no | The users to include in the crowd. Separate multiple users with commas (,) |

### Creates data modeling diagnostic tasks of different types and supports multiple analysis types
`POST https://zieapi.vercel.app/v1/cloud:aliyun-pairecservice/create-data-diagnosis` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://pairecservice.ap-southeast-1.aliyuncs.com |
| Config | string | yes | The configuration content of the data modeling diagnostic task. If Type is set to ChangeRate, the configuration must include: analysis… |
| CycleTime | string | no | The periodic run time. If this field is empty, the task does not run periodically. The format is HH:mm |
| InstanceId | string | yes | The instance ID |
| LeftTableMetaId | string | no | The ID of the left data table |
| LeftTablePartitionField | string | no | The partition field of the left table |
| Name | string | yes | The name of the data modeling diagnostic task configuration |
| PartitionField | string | no | The partition field |
| RightTableMetaId | string | no | The ID of the right data table |
| RightTablePartitionField | string | no | The partition field of the right table |
| TableMetaId | string | no | The ID of the data table |
| TopNQuantity | integer | no | The number of top N results |
| Type | string | yes | The type of the data diagnostic task. Valid values: ChangeRate: item/user change rate analysis. PreferenceStatisticsCycle: user preference… |

### Creates a data modeling diagnostics (rerun) task for a specified time range
`POST https://zieapi.vercel.app/v1/cloud:aliyun-pairecservice/create-data-diagnosis-jobs` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://pairecservice.ap-southeast-1.aliyuncs.com |
| DataDiagnosisId | string | yes | The data modeling diagnostics ID |
| EndDate | string | yes | The end date. The format is YYYY-MM-DD |
| InstanceId | string | yes | The instance ID |
| StartDate | string | yes | The start date. The format is YYYY-MM-DD |

### Creates an engine configuration
`POST https://zieapi.vercel.app/v1/cloud:aliyun-pairecservice/create-engine-config` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://pairecservice.ap-southeast-1.aliyuncs.com |
| ConfigValue | string | no | The content of the engine configuration |
| Description | string | no | The description |
| Environment | string | no | The runtime environment. Valid values: Daily: daily environment. Pre: staging environment. Prod: production environment |
| InstanceId | string | no | The instance ID. You can obtain the instance ID from the https://help.aliyun.com/document_detail/2411819.html operation |
| Name | string | no | The name of the engine configuration |
| SceneId | string | no | The scene ID |
| Type | string | no | The engine configuration type |

### Creates an experiment in a specified experiment group
`POST https://zieapi.vercel.app/v1/cloud:aliyun-pairecservice/create-experiment` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://pairecservice.ap-southeast-1.aliyuncs.com |
| Config | string | no | The experiment configuration |
| DebugCrowdId | string | no | The ID of the debug crowd. Call the ListCrowds operation to obtain this ID |
| DebugUsers | string | no | The UIDs of Alibaba Cloud accounts or RAM users for debugging. Separate multiple UIDs with a comma |
| Description | string | yes | The experiment description |
| ExperimentGroupId | string | yes | The ID of the experiment group. Call the ListExperimentGroups operation to obtain this ID |
| FlowPercent | integer | no | The traffic distribution percentage |
| InstanceId | string | yes | The instance ID. Call the ListInstances operation to obtain this ID |
| Name | string | yes | The experiment name |
| Type | string | yes | The experiment type. Valid values: ● `Baseline`: Indicates a baseline experiment. ● `Normal`: Indicates a normal experiment. |

### Creates an experiment group in a specified layer. You can use experiment groups to categorize experiments…
`POST https://zieapi.vercel.app/v1/cloud:aliyun-pairecservice/create-experiment-group` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://pairecservice.ap-southeast-1.aliyuncs.com |
| Config | string | no | The configuration of the experiment group |
| CrowdId | string | no | The ID of the crowd for crowd targeting. You can obtain this ID by calling the ListCrowds operation |
| CrowdTargetType | string | no | The crowd targeting type for the experiment group. Valid values: `All`: All traffic `Filter`: Traffic that matches the filter condition… |
| DebugCrowdId | string | no | The ID of the debug crowd. You can obtain this ID by calling the ListCrowds operation |
| DebugUsers | string | no | The UIDs of the debug users. The value must be the UID of an Alibaba Cloud account or a RAM user. Separate multiple UIDs with a comma |
| Description | string | no | The description of the experiment group |
| DistributionTimeDuration | integer | no | The time duration for traffic distribution |
| DistributionType | string | no | The distribution type. Valid values: `UserId` (by user ID) and `TimeDuration` (by time duration) |
| Filter | string | no | The filter condition for crowd targeting |
| InstanceId | string | yes | The instance ID. You can obtain this ID by calling the ListInstances operation |
| LayerId | string | yes | The ID of the layer. You can obtain this ID by calling the ListLayers operation |
| Name | string | yes | The name of the experiment group |
| NeedAA | string | yes | Specifies whether to create an A/A experiment group |
| RandomFlow | integer | no | The percentage of traffic to randomly allocate to this experiment group. This parameter is used only when `CrowdTargetType` is set to… |
| ReservedBuckets | string | no | A comma-separated list of reserved bucket numbers |

### Creates a feature consistency check job
`POST https://zieapi.vercel.app/v1/cloud:aliyun-pairecservice/create-feature-consistency-check-job` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://pairecservice.ap-southeast-1.aliyuncs.com |
| Environment | string | yes | The environment where the job runs. Valid values: Daily: the daily environment Pre: the pre-production environment Prod: the production… |
| FeatureConsistencyCheckJobConfigId | string | yes | The feature consistency check job configuration ID. You can call the https://help.aliyun.com/document_detail/2557567.html operation to… |
| InstanceId | string | yes | The instance ID. You can obtain the instance ID on the https://help.aliyun.com/document_detail/2411819.html page |
| SamplingDuration | integer | yes | The sampling duration, in minutes |

### Configure a feature consistency check task
`POST https://zieapi.vercel.app/v1/cloud:aliyun-pairecservice/create-feature-consistency-check-job-config` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://pairecservice.ap-southeast-1.aliyuncs.com |
| CompareFeature | string | yes | Specifies whether to compare features |
| DatasetId | string | no | The dataset ID |
| DatasetMountPath | string | no | The dataset mount path |
| DatasetName | string | no | The dataset name |
| DatasetType | string | no | The dataset type |
| DatasetUri | string | no | The dataset URI |
| DefaultRoute | string | no | The default route |
| EasServiceName | string | yes | The name of the PAI-EAS service. To obtain this name, see https://help.aliyun.com/document_detail/412109.html |
| EasyRecPackagePath | string | no | The path of the OSS bucket where the EasyRec package is stored |
| EasyRecVersion | string | no | The EasyRec version |
| FeatureDisplayExclude | string | no | The features to exclude from the display. Use a comma (,) to separate multiple features |
| FeatureLandingResourceId | string | yes | The ID of the data source where the feature data is saved |
| FeaturePriority | string | no | The feature priority. Use a comma (,) to separate multiple features |
| FeatureStoreItemId | string | no | The primary key for the item side in the feature store |
| FeatureStoreModelId | string | no | The feature store model ID |
| FeatureStoreProjectId | string | no | The feature store project ID |
| FeatureStoreProjectName | string | no | The feature store project name |
| FeatureStoreSeqFeatureView | string | no | The name of the feature view that contains the item features within sequence features |
| FeatureStoreUserId | string | no | The primary key for the user side in the feature store |
| FgJarVersion | string | no | The `fg_jar` version |
| FgJsonFileName | string | yes | The name of the `fg_json` file |
| GenerateZip | string | yes | Specifies whether to generate a ZIP package |
| InstanceId | string | yes | The instance ID. To obtain this ID, see https://help.aliyun.com/document_detail/2411819.html |
| ItemIdField | string | no | The name of the `item_id` field |
| ItemTable | string | no | The name of the item table |
| ItemTablePartitionField | string | no | The partition field of the item table |
| ItemTablePartitionFieldFormat | string | no | The format of the partition field in the item table. Valid values: `yyyymmdd` `yyyy-mm-dd` |
| MaxcomputeSchema | string | no | The schema of the MaxCompute project |
| Name | string | yes | The name of the feature consistency check |
| OssResourceId | string | no | The OSS data source ID |
| PredictWorkerCount | integer | no | The number of prediction workers |
| PredictWorkerCpu | integer | no | The number of CPU cores for each prediction worker |
| PredictWorkerMemory | integer | no | The memory size for each prediction worker, in megabytes (MB) |
| ResourceConfig | string | no | The resource configuration |
| SampleRate | number | yes | The sample rate. The value must be between 0 and 1, inclusive |
| SceneId | string | yes | The scene ID |
| SecurityGroupId | string | no | The security group ID |
| ServiceId | string | yes | The service ID |
| SwitchId | string | no | The vSwitch ID |
| UseFeatureStore | string | yes | Specifies whether to use a feature store. Valid values: `true`: Use a feature store. The `FeatureStoreProjectId`,… |
| UserIdField | string | no | The name of the `user_id` field |
| UserTable | string | no | The name of the user table |
| UserTablePartitionField | string | no | The partition field of the user table |
| UserTablePartitionFieldFormat | string | no | The format of the partition field in the user table. Valid values: `yyyymmdd` `yyyy-mm-dd` |
| VpcId | string | no | The VPC ID |
| WorkflowName | string | no | The workflow name |
| WorkspaceId | string | no | The workspace ID |

### Creates a configuration resource for a specified instance
`POST https://zieapi.vercel.app/v1/cloud:aliyun-pairecservice/create-instance-resource` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://pairecservice.ap-southeast-1.aliyuncs.com |
| InstanceId | string | yes | The instance ID. You can obtain this ID by calling the https://help.aliyun.com/document_detail/2411819.html operation |
| Category | string | yes | The resource category. Valid values: DataManagement Engine Monitor |
| Group | string | yes | The resource group. If the resource category is DataManagement, valid values are: storage modelpipeline datastorage modeltrain If the… |
| Type | string | yes | The resource type. Valid values: Hologres EAS BE Rec Platform SLS DataHub ApsaraMQ for Kafka Realtime Compute for Apache Flink ACR OSS… |
| Uri | string | yes | The resource URI |

### Creates a laboratory. A laboratory isolates a segment of traffic for running experiments
`POST https://zieapi.vercel.app/v1/cloud:aliyun-pairecservice/create-laboratory` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://pairecservice.ap-southeast-1.aliyuncs.com |
| BucketCount | integer | no | The number of buckets |
| BucketType | string | yes | The bucketing method. Valid values: ● `UidHash`: by UID hash (default) ● `Uid`: by UID ● `Filter`: filter-based |
| Buckets | string | no | The assigned bucket numbers |
| DebugCrowdId | string | no | The debug crowd ID |
| DebugUsers | string | no | The UIDs of debug users, separated by commas. Each UID must belong to an Alibaba Cloud primary account or a RAM user |
| Description | string | no | The laboratory description |
| Environment | string | yes | The environment. Valid values: ● `Daily`: daily ● `Pre`: staging ● `Prod`: production |
| Filter | string | no | The filter |
| InstanceId | string | yes | The instance ID. To get it, call the `ListInstances` operation |
| Name | string | yes | The laboratory name |
| SceneId | string | yes | The scene ID. To get it, call the `ListScenes` operation |
| Type | string | yes | The laboratory type. Valid values: `Base` and `NonBase` |

### Creates a layer in a specified laboratory for layered experiments. Layers are orthogonal to each other,…
`POST https://zieapi.vercel.app/v1/cloud:aliyun-pairecservice/create-layer` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://pairecservice.ap-southeast-1.aliyuncs.com |
| Description | string | yes | The description of the layer |
| InstanceId | string | yes | The ID of the instance. Call the `ListInstances` operation to obtain this value |
| LaboratoryId | string | yes | The ID of the laboratory. Call the `ListLaboratories` operation to obtain this value |
| Name | string | yes | The name of the layer |

### Creates an ABTest parameter for a specific scene in a specified environment
`POST https://zieapi.vercel.app/v1/cloud:aliyun-pairecservice/create-param` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://pairecservice.ap-southeast-1.aliyuncs.com |
| Environment | string | no | The environment to which the parameter belongs. Valid values: Daily: daily environment. Pre: staging environment. Prod: production… |
| InstanceId | string | no | The instance ID. You can call the ListInstances operation to obtain the instance ID |
| Name | string | no | The parameter name |
| SceneId | string | no | The scene ID. You can call the ListScenes operation to obtain the scene ID |
| Type | string | no | The parameter type. Valid values: Normal: common parameter. Encryption: encrypted parameter |
| Value | string | no | The parameter value |

### Initializes a Recall Management configuration, including the instance ID, user information, and network…
`POST https://zieapi.vercel.app/v1/cloud:aliyun-pairecservice/create-recall-management-config` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://pairecservice.ap-southeast-1.aliyuncs.com |
| InstanceId | string | no | The instance ID |
| NetworkConfigs | array | no | The network configurations |
| Password | string | no | The password |
| UserName | string | no | The user name |

### Creates a new recall management service
`POST https://zieapi.vercel.app/v1/cloud:aliyun-pairecservice/create-recall-management-service` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://pairecservice.ap-southeast-1.aliyuncs.com |
| Description | string | no | The description for the recall management service |
| InstanceId | string | no | The instance ID |
| Name | string | no | The name of the recall management service |

### Creates a new recall management service version that supports configuring multiple recall strategies
`POST https://zieapi.vercel.app/v1/cloud:aliyun-pairecservice/create-recall-management-service-version` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://pairecservice.ap-southeast-1.aliyuncs.com |
| RecallManagementServiceId | string | yes | The ID of the recall management service |
| Configs | object | no | The configuration details |
| InstanceId | string | no | The instance ID |
| SourceRecallManagementServiceVersionId | string | no | The source recall management service version ID |

### Creates a configuration for a specified version of the Recall Manager service, including its recall and…
`POST https://zieapi.vercel.app/v1/cloud:aliyun-pairecservice/create-recall-management-service-version-config` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://pairecservice.ap-southeast-1.aliyuncs.com |
| RecallManagementServiceId | string | yes | The recall management service ID |
| RecallManagementServiceVersionId | string | yes | The recall management service version ID |
| ConfigType | string | no | The configuration type for the recall management version, which can be `Recall` for a recall config or `Merge` for a merge config |
| InstanceId | string | no | Instance ID |
| MergeConfig | object | no | Merge configuration |
| RecallConfig | object | no | Recall configuration |

### Creates a recall management table that supports multiple data sources and configuration options
`POST https://zieapi.vercel.app/v1/cloud:aliyun-pairecservice/create-recall-management-table` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://pairecservice.ap-southeast-1.aliyuncs.com |
| Config | string | no | Additional settings for the table |
| DataSource | string | no | The data source |
| Description | string | no | The description of the table |
| EnableDataSizeFluctuationThreshold | string | no | Whether to enable the data size fluctuation threshold |
| EnableRowCountFluctuationThreshold | string | no | Whether to enable the row count fluctuation threshold |
| Fields | array | no | The list of fields |
| InstanceId | string | yes | The instance ID |
| MaxDataSizeFluctuationThreshold | integer | no | The maximum data size fluctuation threshold |
| MaxRowCountFluctuationThreshold | integer | no | The maximum row count fluctuation threshold |
| MaxcomputeProjectName | string | no | The MaxCompute project |
| MaxcomputeSchema | string | no | The schema in MaxCompute |
| MaxcomputeTableName | string | no | The name of the table in MaxCompute |
| MinDataSizeFluctuationThreshold | integer | no | The minimum data size fluctuation threshold |
| MinRowCountFluctuationThreshold | integer | no | The minimum row count fluctuation threshold |
| Name | string | no | The name of the table |
| RecallType | string | no | The recall type of the table |
| Type | string | no | The table type |

### Creates a scene for metric and experiment analysis
`POST https://zieapi.vercel.app/v1/cloud:aliyun-pairecservice/create-scene` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://pairecservice.ap-southeast-1.aliyuncs.com |
| Description | string | no | The scene description |
| Flows | array | no | The flows |
| InstanceId | string | no | The instance ID. You can call the ListInstances operation to obtain the instance ID |
| Name | string | no | The scene name |

### Creates a sub-crowd for a specified crowd
`POST https://zieapi.vercel.app/v1/cloud:aliyun-pairecservice/create-sub-crowd` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://pairecservice.ap-southeast-1.aliyuncs.com |
| CrowdId | string | yes | The crowd ID. You can obtain the crowd ID by calling the ListCrowds API |
| InstanceId | string | yes | The instance ID. You can obtain the instance ID by calling the ListInstances API |
| Source | string | yes | The source of users for the sub-crowd. Valid values: ● ManualInput: manual input ● UploadFile: file upload |
| Users | string | yes | A comma-separated list of users in the sub-crowd |

### Creates a data table
`POST https://zieapi.vercel.app/v1/cloud:aliyun-pairecservice/create-table-meta` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://pairecservice.ap-southeast-1.aliyuncs.com |
| Description | string | yes | The description of the data table |
| Fields | array | yes | The list of fields |
| InstanceId | string | yes | The instance ID. To get this ID, call the https://help.aliyun.com/document_detail/2411819.html operation |
| Module | string | yes | The module to which the data table belongs. ABTest: The data table for A/B testing. ExperimentTool: The data table for the experiment… |
| Name | string | yes | The name of the data table |
| ResourceId | string | yes | The resource ID. To get this ID, call the ListInstanceResources operation |
| TableName | string | yes | The name of the table in the database |

### Creates a traffic control target and configures parameters such as control conditions, events, and target…
`POST https://zieapi.vercel.app/v1/cloud:aliyun-pairecservice/create-traffic-control-target` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://pairecservice.ap-southeast-1.aliyuncs.com |
| EndTime | string | no | The end time of the control target. The format is YYYY-MM-DD |
| Event | string | no | The control target event |
| ItemConditionArray | string | no | The item conditions in array format |
| ItemConditionExpress | string | no | The item conditions in expression format |
| ItemConditionType | string | no | The condition type for item control |
| Name | string | no | The name of the traffic control target |
| NewProductRegulation | string | no | Specifies whether the control applies to new products |
| RecallName | string | no | The recall policy name |
| StartTime | string | no | The start time of the control target. The format is YYYY-MM-DD |
| StatisPeriod | string | no | The statistical period |
| Status | string | no | The status of the control target |
| ToleranceValue | integer | no | The tolerance range of the control target |
| TrafficControlTaskId | string | no | The ID of the traffic control task |
| Value | number | no | The target value |

### Creates a traffic control task with various condition settings and target configurations
`POST https://zieapi.vercel.app/v1/cloud:aliyun-pairecservice/create-traffic-control-task` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://pairecservice.ap-southeast-1.aliyuncs.com |
| BehaviorTableMetaId | string | no | The ID of the behavior table |
| ControlGranularity | string | no | The control granularity. Valid values: Global: global Single: single item |
| ControlLogic | string | no | The control logic. Valid values: Guaranteed: guaranteed traffic control Approach: approximate traffic control |
| ControlType | string | no | The control type. Valid values: Percent: percentage-based control Quantity: quantity-based control |
| Description | string | no | The description of the traffic control task |
| EffectiveSceneIds | array | no | The list of effective scene IDs |
| EndTime | string | no | The end time. Specify the time in the YYYY-MM-DD format |
| ExecutionTime | string | no | The execution time. Valid values: Permanent: The task is executed permanently. TimeRange: The task is executed within a specified time… |
| FlinkResourceId | string | no | The ID of the Flink data source |
| InstanceId | string | no | The instance ID. You can call the https://help.aliyun.com/document_detail/2411819.html operation to obtain the instance ID |
| ItemConditionArray | string | no | The conditions for items in array format |
| ItemConditionExpress | string | no | The conditions for items in expression format |
| ItemConditionType | string | no | The condition type for items. Valid values: Array: array format Expression: expression format |
| ItemTableMetaId | string | no | The ID of the item table |
| Name | string | no | The name of the traffic control task |
| PreExperimentIds | string | no | The IDs of the experiments in the pre-release environment. Separate multiple IDs with commas (,) |
| ProdExperimentIds | string | no | The IDs of the experiments in the production environment. Separate multiple IDs with commas (,) |
| SceneId | string | no | The scene ID. You can call the https://help.aliyun.com/document_detail/2402581.html operation to obtain the scene ID |
| ServiceId | string | yes | The service ID |
| ServiceIds | array | no | The list of bound engine service IDs |
| StartTime | string | no | The start time. Specify the time in the YYYY-MM-DD format |
| StatisBehaviorConditionArray | string | no | The conditions for statistical behaviors in array format |
| StatisBehaviorConditionExpress | string | no | The conditions for statistical behaviors in expression format |
| StatisBehaviorConditionType | string | no | The condition type for statistical behaviors. Valid values: Array: array format Expression: expression format |
| TrafficControlTargets | array | no | The list of traffic control targets |
| UserConditionArray | string | no | The conditions for the target users in array format |
| UserConditionExpress | string | no | The conditions for the target users in expression format |
| UserConditionType | string | no | The condition type for the target users. Valid values: Array: array format Expression: expression format |
| UserTableMetaId | string | no | The ID of the user table |

### Deletes the specified A/B test metric
`POST https://zieapi.vercel.app/v1/cloud:aliyun-pairecservice/delete-abmetric` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://pairecservice.ap-southeast-1.aliyuncs.com |
| ABMetricId | string | yes | The ID of the A/B test metric |
| InstanceId | string | yes | The instance ID. You can get this ID by calling the https://help.aliyun.com/document_detail/2411819.html operation |

### Deletes an A/B test metric group
`POST https://zieapi.vercel.app/v1/cloud:aliyun-pairecservice/delete-abmetric-group` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://pairecservice.ap-southeast-1.aliyuncs.com |
| ABMetricGroupId | string | yes | The ID of the A/B test metric group |
| InstanceId | string | yes | The ID of the instance. You can obtain this value by calling the https://help.aliyun.com/document_detail/2411819.html operation |

### Delete the specified audience
`POST https://zieapi.vercel.app/v1/cloud:aliyun-pairecservice/delete-crowd` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://pairecservice.ap-southeast-1.aliyuncs.com |
| CrowdId | string | yes | Audience ID, which can be obtained by calling the ListCrowds API |
| InstanceId | string | yes | Instance ID, which can be obtained by calling the ListInstances API |

### Deletes a data diagnosis configuration using the specified DataDiagnosisId and InstanceId
`POST https://zieapi.vercel.app/v1/cloud:aliyun-pairecservice/delete-data-diagnosis` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://pairecservice.ap-southeast-1.aliyuncs.com |
| DataDiagnosisId | string | yes | The ID of the data diagnosis |
| InstanceId | string | yes | The ID of the instance |

### Deletes a specified engine configuration
`POST https://zieapi.vercel.app/v1/cloud:aliyun-pairecservice/delete-engine-config` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://pairecservice.ap-southeast-1.aliyuncs.com |
| EngineConfigId | string | yes | The engine configuration ID |
| InstanceId | string | no | The instance ID. For information about how to obtain the instance ID, see https://help.aliyun.com/document_detail/2411819.html |
| DeleteAll | string | no | Specifies whether to delete all engine configurations with the same name |

### Delete the specified experiment
`POST https://zieapi.vercel.app/v1/cloud:aliyun-pairecservice/delete-experiment` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://pairecservice.ap-southeast-1.aliyuncs.com |
| ExperimentId | string | yes | Experiment ID, which can be obtained by calling the ListExperiments API |
| InstanceId | string | yes | Instance ID, which can be obtained by calling the ListInstances API |

### Delete the specified experiment group
`POST https://zieapi.vercel.app/v1/cloud:aliyun-pairecservice/delete-experiment-group` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://pairecservice.ap-southeast-1.aliyuncs.com |
| ExperimentGroupId | string | yes | Experiment group ID, which can be obtained by calling the ListExperimentGroups API |
| InstanceId | string | yes | Instance ID, which can be obtained by calling the ListInstances API |

### Deletes a configuration resource from an instance
`POST https://zieapi.vercel.app/v1/cloud:aliyun-pairecservice/delete-instance-resource` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://pairecservice.ap-southeast-1.aliyuncs.com |
| InstanceId | string | yes | The instance ID. You can get the instance ID by calling the https://help.aliyun.com/document_detail/2411819.html operation |
| ResourceId | string | yes | The resource ID |

### Delete the specified Lab
`POST https://zieapi.vercel.app/v1/cloud:aliyun-pairecservice/delete-laboratory` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://pairecservice.ap-southeast-1.aliyuncs.com |
| LaboratoryId | string | yes | Laboratory ID, which can be obtained by calling the ListLaboratories API |
| InstanceId | string | yes | Instance ID, which can be obtained by calling the ListInstances API |

### Delete the specified layer
`POST https://zieapi.vercel.app/v1/cloud:aliyun-pairecservice/delete-layer` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://pairecservice.ap-southeast-1.aliyuncs.com |
| LayerId | string | yes | Layer ID, which can be obtained by calling the ListLayers API |
| InstanceId | string | no | Instance ID, which can be obtained by calling the ListInstances API |

### Delete the specified parameter
`POST https://zieapi.vercel.app/v1/cloud:aliyun-pairecservice/delete-param` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://pairecservice.ap-southeast-1.aliyuncs.com |
| ParamId | string | yes | Parameter ID, which can be obtained by calling the ListParams API |
| InstanceId | string | no | Instance ID, which can be obtained by calling the ListInstances API |

### Deletes a recall management service
`POST https://zieapi.vercel.app/v1/cloud:aliyun-pairecservice/delete-recall-management-service` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://pairecservice.ap-southeast-1.aliyuncs.com |
| RecallManagementServiceId | string | yes | The ID of the recall management service |
| InstanceId | string | no | The ID of the instance |

### Deletes a specified version of a recall management service
`POST https://zieapi.vercel.app/v1/cloud:aliyun-pairecservice/delete-recall-management-service-version` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://pairecservice.ap-southeast-1.aliyuncs.com |
| RecallManagementServiceId | string | yes | The ID of the recall management service |
| RecallManagementServiceVersionId | string | yes | The ID of the recall management service version |
| InstanceId | string | no | The instance ID |

### Deletes the specified recall management service version configuration
`POST https://zieapi.vercel.app/v1/cloud:aliyun-pairecservice/delete-recall-management-service-version-config` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://pairecservice.ap-southeast-1.aliyuncs.com |
| RecallManagementServiceId | string | yes | The recall management service ID |
| RecallManagementServiceVersionId | string | yes | The recall management version ID |
| RecallManagementServiceVersionConfigId | string | yes | The recall management configuration ID |
| InstanceId | string | no | The instance ID |

### This API deletes a recall management table using the specified recall management table ID and instance ID
`POST https://zieapi.vercel.app/v1/cloud:aliyun-pairecservice/delete-recall-management-table` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://pairecservice.ap-southeast-1.aliyuncs.com |
| RecallManagementTableId | string | yes | The ID of the recall management table |
| InstanceId | string | yes | The instance ID |

### Delete the specified scenario
`POST https://zieapi.vercel.app/v1/cloud:aliyun-pairecservice/delete-scene` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://pairecservice.ap-southeast-1.aliyuncs.com |
| SceneId | string | yes | Scenario ID, which can be obtained by calling the ListScenes API |
| InstanceId | string | no | Instance ID, which can be obtained by calling the ListInstances API |

### Deletes the specified subcrowd
`POST https://zieapi.vercel.app/v1/cloud:aliyun-pairecservice/delete-sub-crowd` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://pairecservice.ap-southeast-1.aliyuncs.com |
| CrowdId | string | yes | The crowd ID. You can obtain this ID by calling the `ListCrowds` operation |
| SubCrowdId | string | yes | The subcrowd ID. You can obtain this ID by calling the `ListSubCrowds` operation |
| InstanceId | string | yes | The instance ID. You can obtain this ID by calling the `ListInstances` operation |

### Deletes a data table
`POST https://zieapi.vercel.app/v1/cloud:aliyun-pairecservice/delete-table-meta` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://pairecservice.ap-southeast-1.aliyuncs.com |
| TableMetaId | string | yes | The ID of the data table |
| InstanceId | string | yes | The ID of the instance. To obtain this ID, call the https://help.aliyun.com/document_detail/2411819.html operation |

### Deletes the specified traffic control target
`POST https://zieapi.vercel.app/v1/cloud:aliyun-pairecservice/delete-traffic-control-target` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://pairecservice.ap-southeast-1.aliyuncs.com |
| TrafficControlTargetId | string | yes | The traffic control target ID |
| InstanceId | string | no | The instance ID |

### Deletes a specified traffic control task
`POST https://zieapi.vercel.app/v1/cloud:aliyun-pairecservice/delete-traffic-control-task` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://pairecservice.ap-southeast-1.aliyuncs.com |
| TrafficControlTaskId | string | yes | The ID of the traffic control task |
| InstanceId | string | no | The ID of the instance |

### Deploys Flink code for a traffic control task in a specified environment
`POST https://zieapi.vercel.app/v1/cloud:aliyun-pairecservice/deploy-traffic-control-task-code` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://pairecservice.ap-southeast-1.aliyuncs.com |
| Environment | string | no | The deployment environment. Valid values: Daily (daily environment), Pre (pre-production environment), and Prod (production environment) |
| InstanceId | string | no | The instance ID |
| RetryDeploy | string | no | Specifies whether to automatically retry a failed deployment |
| TrafficControlTaskId | string | yes | The traffic control task ID |

### Exports a specified table from the recall engine to a MaxCompute project
`POST https://zieapi.vercel.app/v1/cloud:aliyun-pairecservice/export-recall-management-table` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://pairecservice.ap-southeast-1.aliyuncs.com |
| RecallManagementTableId | string | yes | The ID of the table to export |
| InstanceId | string | no | The instance ID |
| MaxcomputeProjectName | string | no | The MaxCompute project name |
| MaxcomputeSchema | string | no | The MaxCompute project schema |
| MaxcomputeTableName | string | no | The name of the destination table in MaxCompute |
| Partitions | object | no | The table partitions to export. The value must be a JSON object where each key is a partition field and its value is the corresponding… |
| RecallManagementTableVersionId | string | no | The version ID of the recall management table. This parameter defaults to the current published version |

### Generates an algorithm customization script
`POST https://zieapi.vercel.app/v1/cloud:aliyun-pairecservice/generate-algorithm-customization-script` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://pairecservice.ap-southeast-1.aliyuncs.com |
| AlgorithmCustomizationId | string | yes | The algorithm customization ID |
| DeployMode | string | no | The deployment mode. Valid values: EasyDeploy: Performs a one-click deployment. GenerateScript: Generates a deployment script |
| InstanceId | string | no | The ID of the instance. To obtain this ID, see https://help.aliyun.com/document_detail/2411819.html |
| ModuleFieldTypes | object | no | The data types of fields in the JSON configuration |

### Generates Flink code for a specified traffic control task ID and instance information
`POST https://zieapi.vercel.app/v1/cloud:aliyun-pairecservice/generate-traffic-control-task-code` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://pairecservice.ap-southeast-1.aliyuncs.com |
| TrafficControlTaskId | string | yes | The traffic control task ID |
| Environment | string | no | The environment type. Valid values: `Daily` (daily environment), `Pre` (pre-release environment), and `Prod` (production environment) |
| InstanceId | string | yes | The instance ID |

### Retrieves the details of an ABTest metric
`GET https://zieapi.vercel.app/v1/cloud:aliyun-pairecservice/get-abmetric` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://pairecservice.ap-southeast-1.aliyuncs.com |
| ABMetricId | string | yes | The ID of the ABTest metric |
| InstanceId | string | yes | The instance ID. You can call the https://help.aliyun.com/document_detail/2411819.html operation to obtain the instance ID |

### Retrieves the details of an A/B testing metric group
`GET https://zieapi.vercel.app/v1/cloud:aliyun-pairecservice/get-abmetric-group` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://pairecservice.ap-southeast-1.aliyuncs.com |
| ABMetricGroupId | string | yes | The metric group ID |
| InstanceId | string | yes | The instance ID. You can get this ID by calling the https://help.aliyun.com/document_detail/2411819.html operation |

### Retrieves the details of a specified compute task
`GET https://zieapi.vercel.app/v1/cloud:aliyun-pairecservice/get-calculation-job` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://pairecservice.ap-southeast-1.aliyuncs.com |
| CalculationJobId | string | yes | The compute task ID |
| InstanceId | string | yes | The instance ID. You can call https://help.aliyun.com/document_detail/2411819.html to obtain the instance ID |

### Retrieves detailed data modeling diagnostics information by diagnostic node ID and instance ID
`GET https://zieapi.vercel.app/v1/cloud:aliyun-pairecservice/get-data-diagnosis` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://pairecservice.ap-southeast-1.aliyuncs.com |
| DataDiagnosisId | string | yes | The diagnostic node configuration ID |
| InstanceId | string | yes | The instance ID |

### Retrieves the details of an engine configuration
`GET https://zieapi.vercel.app/v1/cloud:aliyun-pairecservice/get-engine-config` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://pairecservice.ap-southeast-1.aliyuncs.com |
| EngineConfigId | string | yes | The engine configuration ID |
| InstanceId | string | no | The instance ID. You can call the https://help.aliyun.com/document_detail/2411819.html operation to obtain the ID |

### Retrieves the details of a specified experiment
`GET https://zieapi.vercel.app/v1/cloud:aliyun-pairecservice/get-experiment` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://pairecservice.ap-southeast-1.aliyuncs.com |
| ExperimentId | string | yes | The experiment ID. You can obtain this ID by calling the ListExperiments operation |
| InstanceId | string | yes | The instance ID. You can obtain this ID by calling the ListInstances operation |

### Retrieves details for a specified experiment group
`GET https://zieapi.vercel.app/v1/cloud:aliyun-pairecservice/get-experiment-group` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://pairecservice.ap-southeast-1.aliyuncs.com |
| ExperimentGroupId | string | yes | The ID of the experiment group. You can call the `ListExperimentGroups` operation to obtain this ID |
| InstanceId | string | yes | The ID of the instance. You can call the `ListInstances` operation to obtain this ID |

### Retrieves the details of a feature consistency check task
`GET https://zieapi.vercel.app/v1/cloud:aliyun-pairecservice/get-feature-consistency-check-job` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://pairecservice.ap-southeast-1.aliyuncs.com |
| FeatureConsistencyCheckJobId | string | yes | The ID of the feature consistency check task. For information about how to obtain the task ID, see… |
| InstanceId | string | no | The ID of the instance. For information about how to obtain the instance ID, see https://help.aliyun.com/document_detail/2411819.html |

### Retrieves the configuration details of a feature consistency check job
`GET https://zieapi.vercel.app/v1/cloud:aliyun-pairecservice/get-feature-consistency-check-job-config` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://pairecservice.ap-southeast-1.aliyuncs.com |
| FeatureConsistencyCheckJobConfigId | string | yes | The ID of the feature consistency check configuration. For information about how to obtain the configuration ID, see… |
| InstanceId | string | yes | The ID of the instance. For information about how to obtain the instance ID, see https://help.aliyun.com/document_detail/2411819.html |

### Queries the details of a specified PAIRec instance
`GET https://zieapi.vercel.app/v1/cloud:aliyun-pairecservice/get-instance` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://pairecservice.ap-southeast-1.aliyuncs.com |
| InstanceId | string | yes | The ID of the instance. You can call the ListInstances operation to obtain the instance ID |

### Retrieves the details of a specified resource in a specified instance
`GET https://zieapi.vercel.app/v1/cloud:aliyun-pairecservice/get-instance-resource` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://pairecservice.ap-southeast-1.aliyuncs.com |
| InstanceId | string | yes | The ID of the instance. You can call the https://help.aliyun.com/document_detail/2411819.html operation to obtain the instance ID |
| ResourceId | string | yes | The ID of the resource |

### Retrieves the list of data tables under a data source
`GET https://zieapi.vercel.app/v1/cloud:aliyun-pairecservice/get-instance-resource-table` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://pairecservice.ap-southeast-1.aliyuncs.com |
| InstanceId | string | yes | The instance ID. You can call the https://help.aliyun.com/document_detail/2411819.html operation to query the instance ID |
| ResourceId | string | yes | The resource ID |
| TableName | string | yes | The table name filter |

### Retrieves the details of a specified laboratory
`GET https://zieapi.vercel.app/v1/cloud:aliyun-pairecservice/get-laboratory` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://pairecservice.ap-southeast-1.aliyuncs.com |
| LaboratoryId | string | yes | The laboratory ID. You can obtain this ID by calling the ListLaboratories operation |
| InstanceId | string | yes | The instance ID. You can obtain this ID by calling the ListInstances operation |

### Retrieves the details of a specified layer
`GET https://zieapi.vercel.app/v1/cloud:aliyun-pairecservice/get-layer` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://pairecservice.ap-southeast-1.aliyuncs.com |
| LayerId | string | yes | The ID of the layer. You can call the ListLayers operation to obtain the ID |
| InstanceId | string | yes | Instance ID of the instance. You can call the ListInstances operation to obtain instance ID |

### Retrieves the recall management configuration
`GET https://zieapi.vercel.app/v1/cloud:aliyun-pairecservice/get-recall-management-config` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://pairecservice.ap-southeast-1.aliyuncs.com |
| InstanceId | string | no | The instance ID. You can call the ListInstances operation to obtain the instance ID |

### Queries the details of a specific recall management task, including the status and logs
`GET https://zieapi.vercel.app/v1/cloud:aliyun-pairecservice/get-recall-management-job` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://pairecservice.ap-southeast-1.aliyuncs.com |
| RecallManagementJobId | string | yes | The task ID |
| InstanceId | string | yes | The instance ID |

### Queries the details of a specified recall management service, including the status and version
`GET https://zieapi.vercel.app/v1/cloud:aliyun-pairecservice/get-recall-management-service` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://pairecservice.ap-southeast-1.aliyuncs.com |
| RecallManagementServiceId | string | yes | The ID of the recall management service |
| InstanceId | string | no | The instance ID |

### Retrieves the details of a recall management service version
`GET https://zieapi.vercel.app/v1/cloud:aliyun-pairecservice/get-recall-management-service-version` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://pairecservice.ap-southeast-1.aliyuncs.com |
| RecallManagementServiceId | string | yes | The ID of the recall management service |
| RecallManagementServiceVersionId | string | yes | The ID of the recall management service version |
| InstanceId | string | no | The instance ID |

### Queries the configuration details of a specific recall management service version
`GET https://zieapi.vercel.app/v1/cloud:aliyun-pairecservice/get-recall-management-service-version-config` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://pairecservice.ap-southeast-1.aliyuncs.com |
| RecallManagementServiceId | string | yes | The recall management service ID |
| RecallManagementServiceVersionId | string | yes | The recall management service version ID |
| RecallManagementServiceVersionConfigId | string | yes | The recall management service version configuration ID |
| InstanceId | string | no | The instance ID |

### Queries the details of a specified recall management table, including the table schema and configurations
`GET https://zieapi.vercel.app/v1/cloud:aliyun-pairecservice/get-recall-management-table` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://pairecservice.ap-southeast-1.aliyuncs.com |
| RecallManagementTableId | string | yes | The table ID |
| InstanceId | string | yes | The instance ID |

### Retrieves the details of a specified scene
`GET https://zieapi.vercel.app/v1/cloud:aliyun-pairecservice/get-scene` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://pairecservice.ap-southeast-1.aliyuncs.com |
| SceneId | string | yes | The scene ID. You can get this ID by calling the ListScenes operation |
| InstanceId | string | no | The instance ID. You can get this ID by calling the ListInstances operation |

### Retrieves the details of a service
`GET https://zieapi.vercel.app/v1/cloud:aliyun-pairecservice/get-service` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://pairecservice.ap-southeast-1.aliyuncs.com |
| ServiceId | string | yes | The service ID |
| InstanceId | string | no | The instance ID. You can obtain it by calling the https://help.aliyun.com/document_detail/2411819.html operation |

### Retrieves the details of a specified sub-crowd
`GET https://zieapi.vercel.app/v1/cloud:aliyun-pairecservice/get-sub-crowd` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://pairecservice.ap-southeast-1.aliyuncs.com |
| CrowdId | string | yes | The crowd ID. You can call the ListCrowds operation to obtain this ID |
| SubCrowdId | string | yes | The sub-crowd ID. You can call the ListSubCrowds operation to obtain this ID |
| InstanceId | string | yes | The instance ID. You can call the ListInstances operation to obtain this ID |

### Retrieves the details of a data table
`GET https://zieapi.vercel.app/v1/cloud:aliyun-pairecservice/get-table-meta` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://pairecservice.ap-southeast-1.aliyuncs.com |
| TableMetaId | string | yes | The ID of the data table |
| InstanceId | string | yes | The ID of the instance. You can call the https://help.aliyun.com/document_detail/2411819.html operation to obtain the instance ID |

### Queries the details of a traffic control target with a specified ID
`GET https://zieapi.vercel.app/v1/cloud:aliyun-pairecservice/get-traffic-control-target` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://pairecservice.ap-southeast-1.aliyuncs.com |
| TrafficControlTargetId | string | yes | The ID of the traffic control target |
| InstanceId | string | yes | The instance ID |

### Queries the details of a traffic control task with a specified ID
`GET https://zieapi.vercel.app/v1/cloud:aliyun-pairecservice/get-traffic-control-task` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://pairecservice.ap-southeast-1.aliyuncs.com |
| TrafficControlTaskId | string | yes | The ID of the traffic control task |
| Environment | string | no | The environment to which the parameter belongs. Valid values: Daily: daily environment Pre: staging environment Prod: production environment |
| Version | string | no | The version |
| ControlTargetFilter | string | no | The filter for traffic control targets |
| RegionId | string | no | The region ID |
| InstanceId | string | no | The instance ID |

### Retrieves traffic allocation details for a specific traffic control task
`GET https://zieapi.vercel.app/v1/cloud:aliyun-pairecservice/get-traffic-control-task-traffic` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://pairecservice.ap-southeast-1.aliyuncs.com |
| TrafficControlTaskId | string | yes | The ID of the traffic control task |
| InstanceId | string | no | The instance ID. For more information, see https://help.aliyun.com/document_detail/2411819.html |
| Environment | string | no | The environment. Valid values: `Daily`: The daily environment. `Pre`: The staging environment. `Prod`: The production environment |

### Retrieves a list of A/B metric groups
`GET https://zieapi.vercel.app/v1/cloud:aliyun-pairecservice/list-abmetric-groups` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://pairecservice.ap-southeast-1.aliyuncs.com |
| SceneId | string | no | The scene ID. You can call the [ListScenes]((~~2402581~~)) operation to obtain this ID |
| InstanceId | string | yes | The instance ID. You can call the https://help.aliyun.com/document_detail/2411819.html operation to obtain this ID |
| PageNumber | integer | no | The page number |
| PageSize | integer | no | The number of entries to return on each page |
| Realtime | string | no | Specifies whether to return only real-time A/B metric groups |
| SortBy | string | no | The field to sort the results by. Valid values: GmtCreateTime: creation time. GmtModifiedTime: modification time |
| Order | string | no | The sort order. Valid values: ASC: ascending. DESC: descending |

### Retrieves a list of AB test metrics
`GET https://zieapi.vercel.app/v1/cloud:aliyun-pairecservice/list-abmetrics` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://pairecservice.ap-southeast-1.aliyuncs.com |
| Type | string | no | The metric type filter. Valid values: Single: Single metric. Derived: Derived metric |
| Realtime | string | no | Specifies whether to filter metrics by real-time type |
| PageNumber | integer | no | The page number |
| PageSize | integer | no | The page size |
| Name | string | no | The name filter |
| TableMetaId | string | no | The ID of the data table. You can obtain the ID by calling ListTableMetas |
| InstanceId | string | yes | The instance ID. You can obtain the ID by calling the https://help.aliyun.com/document_detail/2411819.html operation |
| SceneId | string | no | The scene ID. You can obtain the ID by calling the https://help.aliyun.com/document_detail/2402581.html operation |

### Queries a list of calculation tasks
`GET https://zieapi.vercel.app/v1/cloud:aliyun-pairecservice/list-calculation-jobs` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://pairecservice.ap-southeast-1.aliyuncs.com |
| PageNumber | integer | no | The page number |
| PageSize | integer | no | The page size |
| InstanceId | string | yes | The instance ID. You can call the https://help.aliyun.com/document_detail/2411819.html operation to query the instance ID |
| SceneId | string | yes | The scene ID. You can call the https://help.aliyun.com/document_detail/2402581.html operation to query the scene ID |
| Status | string | no | The status. Valid values: Success: Succeeded. Failure: Failed. Initializing: Initializing. Running: Running |

### Retrieves all users within a specified crowd, including those in its sub-crowds
`GET https://zieapi.vercel.app/v1/cloud:aliyun-pairecservice/list-crowd-users` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://pairecservice.ap-southeast-1.aliyuncs.com |
| CrowdId | string | yes | The ID of the crowd. You can call the ListCrowds operation to obtain this ID |
| InstanceId | string | yes | The ID of the instance. You can call the ListInstances operation to obtain this ID |

### Retrieves a list of crowds
`GET https://zieapi.vercel.app/v1/cloud:aliyun-pairecservice/list-crowds` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://pairecservice.ap-southeast-1.aliyuncs.com |
| InstanceId | string | yes | The ID of the instance. You can call the ListInstances operation to obtain the instance ID |

### Lists the data diagnostic tasks for the specified instance
`GET https://zieapi.vercel.app/v1/cloud:aliyun-pairecservice/list-data-diagnoses` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://pairecservice.ap-southeast-1.aliyuncs.com |
| Types | string | no | A list of diagnosis types (JSON-encoded) |
| PageNumber | integer | no | The page number |
| PageSize | integer | no | The page size |
| InstanceId | string | yes | The instance ID |

### Queries the data diagnostic tasks and their statuses for a specified instance
`GET https://zieapi.vercel.app/v1/cloud:aliyun-pairecservice/list-data-diagnosis-jobs` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://pairecservice.ap-southeast-1.aliyuncs.com |
| InstanceId | string | yes | The instance ID |
| Status | string | no | The task status. Valid values: Initializing: The task is being initialized. Running: The task is running. Success: The task succeeded.… |
| PageNumber | string | no | The page number |
| PageSize | string | no | The page size |
| Types | string | no | The list of data diagnostic types (JSON-encoded) |

### Retrieves a diagnostic report for a specified time period based on the given parameters
`GET https://zieapi.vercel.app/v1/cloud:aliyun-pairecservice/list-data-diagnosis-reports` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://pairecservice.ap-southeast-1.aliyuncs.com |
| DataDiagnosisId | string | yes | The data diagnosis ID |
| InstanceId | string | yes | The instance ID |
| StartDate | string | yes | The start date. The format is YYYY-MM-DD |
| EndDate | string | yes | The end date. The format is YYYY-MM-DD |
| FeatureName | string | no | The feature name |
| TopN | integer | no | The maximum number of results to return |
| RemainRateType | string | no | The retention rate report type. Period: periodic report |

### Retrieves a list of engine configurations
`GET https://zieapi.vercel.app/v1/cloud:aliyun-pairecservice/list-engine-configs` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://pairecservice.ap-southeast-1.aliyuncs.com |
| Environment | string | no | The runtime environment. Valid values: Daily: Daily environment. Pre: Pre-release environment. Prod: Production environment |
| Status | string | no | The status filter. Valid values: Released: Released. Unreleased: Not released |
| Name | string | no | The engine configuration name |
| PageNumber | integer | no | The page number |
| PageSize | integer | no | The number of entries per page |
| Version | string | no | The version filter. Valid values: latest: the most recently updated version |
| InstanceId | string | yes | The instance ID. You can obtain the instance ID by calling the https://help.aliyun.com/document_detail/2411819.html operation |
| SceneId | string | no | The scene ID |

### Retrieves a list of experiment groups
`GET https://zieapi.vercel.app/v1/cloud:aliyun-pairecservice/list-experiment-groups` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://pairecservice.ap-southeast-1.aliyuncs.com |
| LayerId | string | no | The layer ID. You can retrieve this value by calling ListLayers |
| Status | string | no | The status filter. Valid values: ● Offline: Not online. ● Online: Online. ● Pushed: Fully pushed |
| InstanceId | string | yes | The instance ID. You can retrieve this value by calling ListInstances |
| TimeRangeStart | string | no | Filters experiment groups by start time. The format is YYYY-MM-DD HH:mm:ss |
| TimeRangeEnd | string | no | Filters experiment groups by end time. The format is YYYY-MM-DD HH:mm:ss |

### Retrieves the list of experiments in a specified experiment group
`GET https://zieapi.vercel.app/v1/cloud:aliyun-pairecservice/list-experiments` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://pairecservice.ap-southeast-1.aliyuncs.com |
| ExperimentGroupId | string | no | The experiment group ID |
| Status | string | no | The status filter. Valid values: Offline: Not online. Online: Online |
| InstanceId | string | yes | The instance ID. You can call ListInstances to retrieve the instance ID |
| Query | string | no | The filter parameter for quick search. Returns all experiments whose name or label matches the specified value |

### Retrieves a list of feature consistency check task configurations
`GET https://zieapi.vercel.app/v1/cloud:aliyun-pairecservice/list-feature-consistency-check-job-configs` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://pairecservice.ap-southeast-1.aliyuncs.com |
| InstanceId | string | yes | The ID of the instance. For information about how to obtain the instance ID, see https://help.aliyun.com/document_detail/2411819.html |
| PageNumber | string | no | The page number. Starting value: 1. Default value: 1 |
| PageSize | string | no | The number of entries per page |
| SortBy | string | no | The sort field. Valid values: GmtCreateTime: sorts by creation time. GmtModifiedTime: sorts by update time |
| Order | string | no | The sort order. Valid values: ASC: ascending order. DESC: descending order |
| SceneId | string | no | The scene ID |

### Lists feature reports for a feature consistency check job
`GET https://zieapi.vercel.app/v1/cloud:aliyun-pairecservice/list-feature-consistency-check-job-feature-reports` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://pairecservice.ap-southeast-1.aliyuncs.com |
| FeatureConsistencyCheckJobId | string | yes | The ID of the feature consistency check job. To obtain the ID, see https://help.aliyun.com/document_detail/2557571.html |
| InstanceId | string | yes | The ID of the instance. To obtain the ID, see https://help.aliyun.com/document_detail/2411819.html |
| LogUserId | string | yes | The user ID used for feature comparison |
| LogItemId | string | yes | The item ID used for feature comparison |
| LogRequestId | string | yes | The request ID used for feature comparison |

### Retrieves the score difference reports for a feature consistency check job
`GET https://zieapi.vercel.app/v1/cloud:aliyun-pairecservice/list-feature-consistency-check-job-score-reports` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://pairecservice.ap-southeast-1.aliyuncs.com |
| FeatureConsistencyCheckJobId | string | yes | The ID of the feature consistency check job. To obtain the job ID, see https://help.aliyun.com/document_detail/2557561.html |
| InstanceId | string | no | The ID of the instance. To obtain the instance ID, see https://help.aliyun.com/document_detail/2411819.html |
| ExcludeRequestIds | string | no | A list of request IDs to exclude from the feature comparison (JSON-encoded) |

### Retrieves a list of feature consistency check jobs
`GET https://zieapi.vercel.app/v1/cloud:aliyun-pairecservice/list-feature-consistency-check-jobs` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://pairecservice.ap-southeast-1.aliyuncs.com |
| InstanceId | string | yes | The ID of the instance. For information about how to obtain the instance ID, see https://help.aliyun.com/document_detail/2411819.html |
| PageNumber | string | no | The page number |
| PageSize | string | no | The number of entries per page |
| SortBy | string | no | The sort field. Valid values: GmtCreateTime: sort by creation time GmtModifiedTime: sort by update time |
| Order | string | no | The sort order. Valid values: ASC: ascending order DESC: descending order |
| Status | string | no | The job status. Valid values: ToRun: pending Running: running Success: successful Failure: failed Stopped: stopped or canceled |

### Lists all schemas for a specified resource in an instance
`GET https://zieapi.vercel.app/v1/cloud:aliyun-pairecservice/list-instance-resource-schemas` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://pairecservice.ap-southeast-1.aliyuncs.com |
| InstanceId | string | yes | The instance ID |
| ResourceId | string | yes | The resource ID |
| SchemaName | string | no | Filters schemas by a name prefix |

### Queries all tables in a specified instance and data source
`GET https://zieapi.vercel.app/v1/cloud:aliyun-pairecservice/list-instance-resource-tables` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://pairecservice.ap-southeast-1.aliyuncs.com |
| InstanceId | string | yes | The instance ID |
| ResourceId | string | yes | The data source ID |
| MaxcomputeSchema | string | no | The MaxCompute schema |

### Lists the resources configured for an instance
`GET https://zieapi.vercel.app/v1/cloud:aliyun-pairecservice/list-instance-resources` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://pairecservice.ap-southeast-1.aliyuncs.com |
| InstanceId | string | yes | The instance ID. You can obtain the instance ID by calling the https://help.aliyun.com/document_detail/2411819.html operation |
| Category | string | no | The category of the resource. Valid values: DataManagement Engine Monitor |
| Group | string | no | The group of the resource. If `Category` is `DataManagement`, valid values are: storage modelpipeline datastorage modeltrain If `Category`… |
| Type | string | no | The type of the resource. If specified, only resources of this type are returned. Hologres EAS BE Rec Platform SLS DataHub ApsaraMQ for… |

### Retrieves a list of PAIRec instances
`GET https://zieapi.vercel.app/v1/cloud:aliyun-pairecservice/list-instances` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://pairecservice.ap-southeast-1.aliyuncs.com |
| InstanceId | string | no | The instance ID for fuzzy matching |
| SortBy | string | no | The sort criterion |
| Order | string | no | The sort order |
| PageNumber | integer | no | The page size |
| PageSize | integer | no | The page number |
| Type | string | no | The instance type. Valid values: basic: Basic Edition. highleve: Upgraded Edition. advance: Advanced Edition. standard: Standard Edition |

### Retrieves the laboratories in a specified scene
`GET https://zieapi.vercel.app/v1/cloud:aliyun-pairecservice/list-laboratories` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://pairecservice.ap-southeast-1.aliyuncs.com |
| Environment | string | no | The laboratory environment. `Daily`: the daily environment `Pre`: the pre-production environment `Prod`: the production environment |
| SceneId | string | yes | The ID of the scene. You can obtain this ID by calling the `ListScenes` API |
| Status | string | no | The laboratory status. `Offline`: The laboratory is offline. `Online`: The laboratory is online |
| InstanceId | string | yes | The ID of the instance. You can obtain this ID by calling the `ListInstances` API |

### Retrieves the list of layers in a laboratory
`GET https://zieapi.vercel.app/v1/cloud:aliyun-pairecservice/list-layers` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://pairecservice.ap-southeast-1.aliyuncs.com |
| LaboratoryId | string | yes | The laboratory ID. You can obtain this ID by calling the ListLaboratories operation |
| InstanceId | string | yes | The instance ID. You can obtain this ID by calling the ListInstances operation |

### Retrieves a list of parameters
`GET https://zieapi.vercel.app/v1/cloud:aliyun-pairecservice/list-params` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://pairecservice.ap-southeast-1.aliyuncs.com |
| SceneId | string | yes | The scene ID. You can call the ListScenes operation to obtain the scene ID |
| Name | string | no | The parameter name |
| Environment | string | no | The environment to which the parameter belongs. Valid values: Daily: daily environment Pre: pre-release environment Prod: production… |
| PageNumber | integer | no | The page number |
| PageSize | integer | no | The number of entries per page |
| InstanceId | string | yes | The instance ID. You can call the ListInstances operation to obtain the instance ID |
| Encrypted | string | no | The Encrypted |

### Queries a list of recall management tasks based on specified conditions
`GET https://zieapi.vercel.app/v1/cloud:aliyun-pairecservice/list-recall-management-jobs` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://pairecservice.ap-southeast-1.aliyuncs.com |
| InstanceId | string | no | The instance ID |
| Type | string | no | The task type |
| Condition | string | no | The filter conditions. Currently, only filter conditions for the Table type are supported, such as `{"RecallManagementTableId":"1"}`… |
| SortBy | string | no | The sorting criterion. `GmtCreateTime`: creation time. `GmtModifiedTime`: update time |
| Order | string | no | The sorting order. `ASC`: ascending order. `DESC`: descending order |
| PageNumber | integer | no | The page number |
| PageSize | integer | no | The page size |
| MaxResults | integer | no | This parameter does not take effect |
| NextToken | string | no | This parameter does not take effect |

### Retrieves all version information for a specified recall management service
`GET https://zieapi.vercel.app/v1/cloud:aliyun-pairecservice/list-recall-management-service-versions` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://pairecservice.ap-southeast-1.aliyuncs.com |
| RecallManagementServiceId | string | yes | The data table ID |
| InstanceId | string | no | The instance ID |
| PageNumber | integer | no | The page number |
| PageSize | integer | no | The page size |
| SortBy | string | no | The sort criterion. Valid values: GmtCreateTime: creation time GmtModifiedTime: update time |
| Order | string | no | The sort order. Valid values: ASC: ascending order DESC: descending order |

### Queries the recall management services of a specified instance
`GET https://zieapi.vercel.app/v1/cloud:aliyun-pairecservice/list-recall-management-services` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://pairecservice.ap-southeast-1.aliyuncs.com |
| InstanceId | string | no | The instance ID |
| Name | string | no | Filters the results by name |
| PageNumber | integer | no | The page number |
| PageSize | integer | no | The page size |
| SortBy | string | no | The sort field. Valid values: GmtCreateTime: creation time. GmtModifiedTime: update time |
| Order | string | no | The sort order. Valid values: ASC: ascending order. DESC: descending order |
| MaxResults | integer | no | This parameter does not take effect |
| NextToken | string | no | This parameter does not take effect |

### Queries all versions of a specified recall management table
`GET https://zieapi.vercel.app/v1/cloud:aliyun-pairecservice/list-recall-management-table-versions` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://pairecservice.ap-southeast-1.aliyuncs.com |
| RecallManagementTableId | string | yes | The table ID |
| InstanceId | string | yes | The instance ID |
| SortBy | string | no | The sort criterion. Valid values: `GmtCreateTime`: creation time `GmtModifiedTime`: update time |
| Order | string | no | The sort order. Valid values: `ASC`: ascending order `DESC`: descending order |
| PageNumber | integer | no | The page number |
| PageSize | integer | no | The page size |

### Queries the recall management table information for a specified instance, with support for pagination and…
`GET https://zieapi.vercel.app/v1/cloud:aliyun-pairecservice/list-recall-management-tables` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://pairecservice.ap-southeast-1.aliyuncs.com |
| InstanceId | string | yes | The instance ID |
| Name | string | no | The table name |
| Type | string | no | The table type. Valid values: `X2I`: U2I recall or I2I recall. `Vector`: vector recall. `Ramdom`: random recall |
| PageNumber | integer | no | The page number |
| PageSize | integer | no | The number of entries per page |
| SortBy | string | no | The sorting field. Valid values: `GmtCreateTime`: creation time. `GmtModifiedTime`: update time |
| Order | string | no | The sort order. Valid values: `ASC`: ascending order. `DESC`: descending order |
| NextToken | string | no | This parameter is not in effect |
| MaxResults | integer | no | This parameter is not in effect |

### Retrieves a list of scenes
`GET https://zieapi.vercel.app/v1/cloud:aliyun-pairecservice/list-scenes` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://pairecservice.ap-southeast-1.aliyuncs.com |
| InstanceId | string | no | The ID of the instance. You can obtain this ID by calling the `ListInstances` operation |
| Name | string | no | The name of the scene to use as a filter |

### Retrieves the list of sub-crowds under a specified crowd
`GET https://zieapi.vercel.app/v1/cloud:aliyun-pairecservice/list-sub-crowds` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://pairecservice.ap-southeast-1.aliyuncs.com |
| CrowdId | string | yes | The crowd ID. You can call ListCrowds to obtain the crowd ID |
| InstanceId | string | yes | The instance ID. You can call ListInstances to obtain the instance ID |

### Retrieves a list of data tables
`GET https://zieapi.vercel.app/v1/cloud:aliyun-pairecservice/list-table-metas` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://pairecservice.ap-southeast-1.aliyuncs.com |
| Type | string | no | The type of the data table. MaxCompute Hologres |
| Name | string | no | The table name filter |
| Module | string | yes | The module of the data table. ABTest: Experiment data tables ExperimentTool: Experiment tool tables DataDiagnosis: Data diagnosis |
| PageNumber | integer | no | The page number |
| PageSize | integer | no | The page size |
| InstanceId | string | yes | The instance ID. You can obtain the instance ID by calling the https://help.aliyun.com/document_detail/2411819.html operation |

### Queries the historical traffic change records of a specified traffic control target
`GET https://zieapi.vercel.app/v1/cloud:aliyun-pairecservice/list-traffic-control-target-traffic-history` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://pairecservice.ap-southeast-1.aliyuncs.com |
| TrafficControlTargetId | string | yes | The ID of the traffic control target |
| Environment | string | no | The environment to which the parameter belongs. Valid values: Daily: daily environment. Pre: staging environment. Prod: production… |
| StartTime | string | no | The start time. The format is YYYY-MM-DD HH:mm:ss |
| EndTime | string | no | The end time. The format is YYYY-MM-DD HH:mm:ss |
| Threshold | string | no | The threshold |
| ExperimentId | string | no | The ID of the experiment |
| ExperimentGroupId | string | no | The ID of the experiment group |
| ItemId | string | no | The ID of the item |
| InstanceId | string | no | The instance ID |

### Queries traffic control tasks that meet specified conditions
`GET https://zieapi.vercel.app/v1/cloud:aliyun-pairecservice/list-traffic-control-tasks` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://pairecservice.ap-southeast-1.aliyuncs.com |
| Name | string | no | The name of the traffic control task |
| TrafficControlTaskId | string | no | The ID of the traffic control task |
| SceneId | string | no | The ID of the scene. You can obtain the ID by calling the https://help.aliyun.com/document_detail/2402581.html operation |
| Environment | string | no | The runtime environment. Valid values: Daily: daily environment. Pre: pre-release environment. Prod: production environment |
| Status | string | no | The status. Valid values: NotRunning: not running. Ready: pending. Running: running. Finished: finished |
| Version | string | no | The version. Valid values: Latest: latest version. Default value. Released: released version |
| ControlTargetFilter | string | no | The filter for traffic control targets. Valid values: All: all targets. Valid: valid targets (in the enabling status within the start and… |
| SortBy | string | no | The sorting criterion. Valid values: GmtCreateTime: creation time. GmtModifiedTime: update time |
| Order | string | no | The sorting order. Valid values: ASC: ascending order. DESC: descending order |
| PageNumber | string | no | The page number. Pages start from 1. Default value: 1 |
| PageSize | string | no | The number of entries per page. Default value: 10 |
| All | string | no | Specifies whether to return all data without pagination |
| InstanceId | string | no | The instance ID. You can obtain the ID by calling the ListInstances (https://icms.alibaba-inc.com/content/learn/pai?l=1&m=16768&n=4300782)… |

…and 48 more. See the OpenAPI spec.

## Example
```
curl "https://zieapi.vercel.app/v1/cloud:aliyun-pairecservice/apply-engine-config" \
  -H "x-api-key: $APIZIE_KEY" \
  -H "x-upstream-key: $PROVIDER_KEY"
```

## FAQ

### How do I call the Alibaba Cloud Platform for Artificial Intelligence PAI -… API?
Create a free Apizie key, then send POST https://zieapi.vercel.app/v1/cloud:aliyun-pairecservice/apply-engine-config with the header x-api-key. Every endpoint returns { project, data, timestamp }.

### Is the Alibaba Cloud Platform for Artificial Intelligence PAI -… API free on Apizie?
Yes. The Free plan includes 1,000 requests a month at 100 requests a minute, no credit card. Alibaba Cloud Platform for Artificial Intelligence PAI -… itself also needs your own key from aliyuncs.com.

### Can AI agents use the Alibaba Cloud Platform for Artificial Intelligence PAI -… API?
Yes. Add the Apizie MCP server (https://zieapi.vercel.app/mcp) to Claude, ChatGPT, Cursor or VS Code, then ask in plain language. The agent calls run_scraper with project key cloud:aliyun-pairecservice.

### What is the status of the Alibaba Cloud Platform for Artificial Intelligence PAI -… API?
Needs your own provider key (bring your own key)