diff options
Diffstat (limited to 'data/zh_cn/pairecservice/2022-12-13/api-docs.php')
| -rw-r--r-- | data/zh_cn/pairecservice/2022-12-13/api-docs.php | 27932 |
1 files changed, 13869 insertions, 14063 deletions
diff --git a/data/zh_cn/pairecservice/2022-12-13/api-docs.php b/data/zh_cn/pairecservice/2022-12-13/api-docs.php index 576ad39..4c3b65c 100644 --- a/data/zh_cn/pairecservice/2022-12-13/api-docs.php +++ b/data/zh_cn/pairecservice/2022-12-13/api-docs.php @@ -1,388 +1,385 @@ <?php return [ 'version' => '1.0', - 'info' => [ - 'style' => 'ROA', - 'product' => 'PaiRecService', - 'version' => '2022-12-13', - ], + 'info' => ['style' => 'ROA', 'product' => 'PaiRecService', 'version' => '2022-12-13'], 'directories' => [ [ - 'id' => 183827, - 'title' => '实例管理', + 'children' => ['ListInstances', 'GetInstance'], 'type' => 'directory', - 'children' => [ - 'ListInstances', - 'GetInstance', - ], + 'title' => '实例管理', + 'id' => 451729, ], [ - 'id' => 365002, - 'title' => '召回管理', - 'type' => 'directory', 'children' => [ - 'GetRecallManagementConfig', - 'GetRecallManagementServiceVersion', - 'GetRecallManagementServiceVersionConfig', - 'GetRecallManagementTable', - 'ListRecallManagementJobs', - 'ListRecallManagementServiceVersions', - 'ListRecallManagementServices', - 'ListRecallManagementTables', - 'UpdateRecallManagementConfig', - 'PublishRecallManagementTable', - 'OfflineRecallManagementService', - 'CreateRecallManagementTable', - 'CreateRecallManagementServiceVersionConfig', - 'CreateRecallManagementServiceVersion', - 'CreateRecallManagementService', - 'CreateRecallManagementConfig', + [ + 'children' => ['CreateRecallManagementConfig', 'UpdateRecallManagementConfig', 'GetRecallManagementConfig'], + 'type' => 'directory', + 'title' => '召回管理配置', + 'id' => 451731, + ], + [ + 'children' => ['CreateRecallManagementTable', 'ListRecallManagementTables', 'UpdateRecallManagementTable', 'GetRecallManagementTable', 'DeleteRecallManagementTable', 'PublishRecallManagementTable', 'ListRecallManagementTableVersions', 'QueryRecallManagementTableRecords', 'ExportRecallManagementTable'], + 'type' => 'directory', + 'title' => '召回管理表', + 'id' => 451732, + ], + [ + 'children' => ['GetRecallManagementJob', 'ListRecallManagementJobs'], + 'type' => 'directory', + 'title' => '召回管理任务', + 'id' => 451733, + ], + [ + 'children' => [ + [ + 'children' => ['CreateRecallManagementService', 'ListRecallManagementServices', 'UpdateRecallManagementService', 'GetRecallManagementService', 'DeleteRecallManagementService', 'OnlineRecallManagementService', 'OfflineRecallManagementService', 'ChangeRecallManagementServiceVersion'], + 'type' => 'directory', + 'title' => '召回服务', + 'id' => 451735, + ], + [ + 'children' => ['CreateRecallManagementServiceVersion', 'ListRecallManagementServiceVersions', 'GetRecallManagementServiceVersion', 'DeleteRecallManagementServiceVersion'], + 'type' => 'directory', + 'title' => '召回服务版本', + 'id' => 451736, + ], + [ + 'children' => ['CreateRecallManagementServiceVersionConfig', 'UpdateRecallManagementServiceVersionConfig', 'GetRecallManagementServiceVersionConfig', 'DeleteRecallManagementServiceVersionConfig'], + 'type' => 'directory', + 'title' => '召回服务版本配置', + 'id' => 451737, + ], + ], + 'type' => 'directory', + 'title' => '召回管理服务', + 'id' => 451734, + ], ], + 'type' => 'directory', + 'title' => '召回管理', + 'id' => 451730, ], [ - 'id' => 188034, - 'title' => '数据资源管理', + 'children' => ['ListInstanceResourceSchemas', 'ListInstanceResourceTables', 'CheckInstanceResources', 'UpdateInstanceResource', 'GetInstanceResourceTable', 'ListInstanceResources', 'GetInstanceResource', 'DeleteInstanceResource', 'CreateInstanceResource'], 'type' => 'directory', - 'children' => [ - 'ListInstanceResourceSchemas', - 'ListInstanceResourceTables', - 'CheckInstanceResources', - 'UpdateInstanceResource', - 'GetInstanceResourceTable', - 'ListInstanceResources', - 'GetInstanceResource', - 'DeleteInstanceResource', - 'CreateInstanceResource', - ], + 'title' => '数据资源管理', + 'id' => 451738, ], [ - 'id' => 183688, - 'title' => '场景管理', + 'children' => ['CreateScene', 'DeleteScene', 'UpdateScene', 'ListScenes', 'GetScene'], 'type' => 'directory', - 'children' => [ - 'CreateScene', - 'DeleteScene', - 'UpdateScene', - 'ListScenes', - 'GetScene', - ], + 'title' => '场景管理', + 'id' => 451739, ], [ - 'id' => 221290, - 'title' => '算法定制', - 'type' => 'directory', 'children' => [ [ - 'id' => 221291, - 'title' => '算法定制', + 'children' => ['CreateDataDiagnosis', 'ListDataDiagnoses', 'UpdateDataDiagnosis', 'GetDataDiagnosis', 'DeleteDataDiagnosis', 'CreateDataDiagnosisJobs', 'ListDataDiagnosisJobs', 'ListDataDiagnosisReports', 'QueryDataDiagnosisStatistics'], 'type' => 'directory', - 'children' => [ - 'GenerateAlgorithmCustomizationScript', - ], + 'title' => '数据诊断', + 'id' => 451741, + ], + [ + 'children' => ['GenerateAlgorithmCustomizationScript'], + 'type' => 'directory', + 'title' => '算法定制', + 'id' => 451742, ], ], + 'type' => 'directory', + 'title' => '算法定制', + 'id' => 451740, ], [ - 'id' => 183857, - 'title' => '实验室管理', + 'children' => ['CreateLaboratory', 'DeleteLaboratory', 'UpdateLaboratory', 'ListLaboratories', 'GetLaboratory', 'OnlineLaboratory', 'OfflineLaboratory', 'CloneLaboratory'], 'type' => 'directory', - 'children' => [ - 'CreateLaboratory', - 'DeleteLaboratory', - 'UpdateLaboratory', - 'ListLaboratories', - 'GetLaboratory', - 'OnlineLaboratory', - 'OfflineLaboratory', - 'CloneLaboratory', - ], + 'title' => '实验室管理', + 'id' => 451743, ], [ - 'id' => 183850, - 'title' => '层管理', + 'children' => ['CreateLayer', 'DeleteLayer', 'UpdateLayer', 'ListLayers', 'GetLayer'], 'type' => 'directory', - 'children' => [ - 'CreateLayer', - 'DeleteLayer', - 'UpdateLayer', - 'ListLayers', - 'GetLayer', - ], + 'title' => '层管理', + 'id' => 451744, ], [ - 'id' => 183866, - 'title' => '实验组管理', + 'children' => ['CreateExperimentGroup', 'DeleteExperimentGroup', 'UpdateExperimentGroup', 'ListExperimentGroups', 'GetExperimentGroup', 'CloneExperimentGroup', 'OnlineExperimentGroup', 'OfflineExperimentGroup'], 'type' => 'directory', - 'children' => [ - 'CreateExperimentGroup', - 'DeleteExperimentGroup', - 'UpdateExperimentGroup', - 'ListExperimentGroups', - 'GetExperimentGroup', - 'CloneExperimentGroup', - 'OnlineExperimentGroup', - 'OfflineExperimentGroup', - ], + 'title' => '实验组管理', + 'id' => 451745, ], [ - 'id' => 183812, - 'title' => '实验管理', + 'children' => ['CreateExperiment', 'DeleteExperiment', 'UpdateExperiment', 'GetExperiment', 'ListExperiments', 'CloneExperiment', 'OfflineExperiment', 'PushAllExperiment', 'OnlineExperiment'], 'type' => 'directory', - 'children' => [ - 'CreateExperiment', - 'DeleteExperiment', - 'UpdateExperiment', - 'GetExperiment', - 'ListExperiments', - 'CloneExperiment', - 'OfflineExperiment', - 'PushAllExperiment', - 'OnlineExperiment', - ], + 'title' => '实验管理', + 'id' => 451746, ], [ - 'id' => 183822, - 'title' => '参数管理', + 'children' => ['CreateParam', 'DeleteParam', 'UpdateParam', 'ListParams'], 'type' => 'directory', - 'children' => [ - 'CreateParam', - 'DeleteParam', - 'UpdateParam', - 'ListParams', - ], + 'title' => '参数管理', + 'id' => 451747, ], [ - 'id' => 183834, - 'title' => '人群管理', + 'children' => ['CreateCrowd', 'CreateSubCrowd', 'DeleteCrowd', 'DeleteSubCrowd', 'UpdateCrowd', 'ListCrowds', 'ListCrowdUsers', 'ListSubCrowds', 'GetSubCrowd'], 'type' => 'directory', - 'children' => [ - 'CreateCrowd', - 'CreateSubCrowd', - 'DeleteCrowd', - 'DeleteSubCrowd', - 'UpdateCrowd', - 'ListCrowds', - 'ListCrowdUsers', - 'ListSubCrowds', - 'GetSubCrowd', - ], + 'title' => '人群管理', + 'id' => 451748, ], [ - 'id' => 187974, - 'title' => '数据表管理', + 'children' => ['UpdateTableMeta', 'ListTableMetas', 'GetTableMeta', 'DeleteTableMeta', 'CreateTableMeta'], 'type' => 'directory', - 'children' => [ - 'UpdateTableMeta', - 'ListTableMetas', - 'GetTableMeta', - 'DeleteTableMeta', - 'CreateTableMeta', - ], + 'title' => '数据表管理', + 'id' => 451749, ], [ - 'id' => 188051, - 'title' => 'AB指标管理', + 'children' => ['UpdateABMetric', 'CreateABMetric', 'ListABMetrics', 'GetABMetric', 'DeleteABMetric'], 'type' => 'directory', - 'children' => [ - 'UpdateABMetric', - 'CreateABMetric', - 'ListABMetrics', - 'GetABMetric', - 'DeleteABMetric', - ], + 'title' => 'AB指标管理', + 'id' => 451750, ], [ - 'id' => 188045, - 'title' => 'AB指标组管理', + 'children' => ['ReportABMetricGroup', 'UpdateABMetricGroup', 'CreateABMetricGroup', 'ListABMetricGroups', 'GetABMetricGroup', 'DeleteABMetricGroup'], 'type' => 'directory', - 'children' => [ - 'ReportABMetricGroup', - 'UpdateABMetricGroup', - 'CreateABMetricGroup', - 'ListABMetricGroups', - 'GetABMetricGroup', - 'DeleteABMetricGroup', - ], + 'title' => 'AB指标组管理', + 'id' => 451751, ], [ - 'id' => 188041, - 'title' => '计算任务管理', + 'children' => ['ListCalculationJobs', 'GetCalculationJob', 'CreateCalculationJobs'], 'type' => 'directory', - 'children' => [ - 'ListCalculationJobs', - 'GetCalculationJob', - 'CreateCalculationJobs', - ], + 'title' => '计算任务管理', + 'id' => 451752, ], [ - 'id' => 185916, - 'title' => '特征一致性检查任务管理', + 'children' => ['CreateFeatureConsistencyCheckJobConfig', 'CreateFeatureConsistencyCheckJob', 'UpdateFeatureConsistencyCheckJobConfig', 'ListFeatureConsistencyCheckJobConfigs', 'GetFeatureConsistencyCheckJobConfig', 'ListFeatureConsistencyCheckJobs', 'GetFeatureConsistencyCheckJob', 'ListFeatureConsistencyCheckJobFeatureReports', 'ListFeatureConsistencyCheckJobScoreReports', 'CloneFeatureConsistencyCheckJobConfig', 'TerminateFeatureConsistencyCheckJob', 'BackflowFeatureConsistencyCheckJobData', 'SyncFeatureConsistencyCheckJobReplayLog'], 'type' => 'directory', - 'children' => [ - 'CreateFeatureConsistencyCheckJobConfig', - 'CreateFeatureConsistencyCheckJob', - 'UpdateFeatureConsistencyCheckJobConfig', - 'ListFeatureConsistencyCheckJobConfigs', - 'GetFeatureConsistencyCheckJobConfig', - 'ListFeatureConsistencyCheckJobs', - 'GetFeatureConsistencyCheckJob', - 'ListFeatureConsistencyCheckJobFeatureReports', - 'ListFeatureConsistencyCheckJobScoreReports', - 'CloneFeatureConsistencyCheckJobConfig', - 'TerminateFeatureConsistencyCheckJob', - 'BackflowFeatureConsistencyCheckJobData', - 'SyncFeatureConsistencyCheckJobReplayLog', - ], + 'title' => '特征一致性检查任务管理', + 'id' => 451753, ], [ - 'id' => 194358, - 'title' => '引擎配置管理', + 'children' => ['DeleteEngineConfig', 'UpdateEngineConfig', 'ListEngineConfigs', 'GetEngineConfig', 'CreateEngineConfig', 'CloneEngineConfig', 'ApplyEngineConfig'], 'type' => 'directory', - 'children' => [ - 'DeleteEngineConfig', - 'UpdateEngineConfig', - 'ListEngineConfigs', - 'GetEngineConfig', - 'CreateEngineConfig', - 'CloneEngineConfig', - 'ApplyEngineConfig', - ], + 'title' => '引擎配置管理', + 'id' => 451754, ], [ - 'id' => 286382, - 'title' => '服务管理', + 'children' => ['GetService'], 'type' => 'directory', - 'children' => [ - 'GetService', - ], + 'title' => '服务管理', + 'id' => 451755, ], [ - 'id' => 268827, - 'title' => '流量调控', - 'type' => 'directory', 'children' => [ [ - 'id' => 268828, + 'children' => ['CreateTrafficControlTask', 'ListTrafficControlTasks', 'UpdateTrafficControlTask', 'GetTrafficControlTask', 'DeleteTrafficControlTask', 'CloneTrafficControlTask', 'CheckTrafficControlTaskExpression', 'ReleaseTrafficControlTask', 'StartTrafficControlTask', 'StopTrafficControlTask', 'GenerateTrafficControlTaskCode', 'GetTrafficControlTaskTraffic', 'UpdateTrafficControlTaskTraffic', 'DeployTrafficControlTaskCode', 'QueryTrafficControlTaskDeployResult', 'QueryTrafficControlTaskItemReport', 'StopTrafficControlFlinkTask'], + 'type' => 'directory', 'title' => '流量调控任务', + 'id' => 451757, + ], + [ + 'children' => ['CreateTrafficControlTarget', 'UpdateTrafficControlTarget', 'GetTrafficControlTarget', 'DeleteTrafficControlTarget', 'StartTrafficControlTarget', 'StopTrafficControlTarget', 'SplitTrafficControlTarget', 'ListTrafficControlTargetTrafficHistory', 'QueryTrafficControlTargetItemReportDetail'], 'type' => 'directory', - 'children' => [ - 'GetTrafficControlTaskTraffic', - 'SplitTrafficControlTarget', - ], + 'title' => '流量调控目标', + 'id' => 451758, ], ], + 'type' => 'directory', + 'title' => '流量调控', + 'id' => 451756, + ], + [ + 'children' => ['ChatConversation'], + 'type' => 'directory', + 'title' => '其他', + 'id' => 451759, ], ], 'components' => [ 'schemas' => [], ], 'apis' => [ - 'ListInstances' => [ - 'summary' => '获取PAIRec实例的列表。', - 'path' => '/api/v1/instances', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'ApplyEngineConfig' => [ + 'summary' => '发布引擎配置。', + 'path' => '/api/v1/engineconfigs/{EngineConfigId}/action/apply', + 'methods' => ['post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], - 'operationType' => 'read', + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeCode' => '163069', - 'abilityTreeNodes' => [ - 'FEATURElearnN0NAWV', - ], + 'abilityTreeCode' => '180295', + 'abilityTreeNodes' => ['FEATURElearnN0NAWV'], ], 'parameters' => [ [ + 'name' => 'EngineConfigId', + 'in' => 'path', + 'schema' => ['description' => '引擎配置ID。', 'type' => 'string', 'required' => false, 'example' => '2'], + ], + [ 'name' => 'InstanceId', 'in' => 'query', + 'schema' => ['description' => '实例ID，可通过接口[ListInstances](~~2411819~~)获取。', 'type' => 'string', 'required' => false, 'example' => 'pairec-cn-***test'], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'title' => '实例Id模糊匹配过滤。', - 'description' => '实例ID模糊匹配过滤。', - 'type' => 'string', - 'required' => false, - 'example' => 'pairec-test1', + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => 'F8F613A9-DF1C-551A-88E1-397A3981A785'], + ], ], ], - [ - 'name' => 'SortBy', - 'in' => 'query', - 'schema' => [ - 'title' => '排序依据。', - 'description' => '排序依据。', - 'type' => 'string', - 'required' => false, - 'example' => 'Type', + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"F8F613A9-DF1C-551A-88E1-397A3981A785\\"\\n}","type":"json"}]', + 'title' => '发布引擎配置', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'pairec:ApplyEngineConfig', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIRecService', 'resourceType' => '全部资源', 'arn' => '*'], + ], ], ], + ], + ], + 'BackflowFeatureConsistencyCheckJobData' => [ + 'summary' => '对指定特征一致性检查任务配置下，最近一次创建的任务进行数据回流。', + 'path' => '/api/v1/featureconsistencycheck/jobs/action/backflowdata', + 'methods' => ['post'], + 'schemes' => ['http', 'https'], + 'security' => [ [ - 'name' => 'Order', - 'in' => 'query', + 'AK' => [], + ], + ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATURElearnN0NAWV'], + ], + 'parameters' => [ + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', 'schema' => [ - 'title' => '排序方式。', - 'description' => '排序方式。', - 'type' => 'string', + 'description' => '请求Body。', + 'type' => 'object', + 'properties' => [ + 'FeatureConsistencyCheckJobConfigId' => ['title' => '特征一致性检查任务配置ID，可从接口ListFeatureConsistencyCheckJobConfigs获取。', 'description' => '特征一致性检查任务配置ID。如何获取配置ID，请参见[ListFeatureConsistencyCheckJobConfigs](~~2557567~~)。', 'type' => 'string', 'required' => true, 'example' => '4'], + 'InstanceId' => ['title' => '实例ID，可从接口ListInstances获取。', 'description' => '实例ID。如何获取实例ID，请参见[ListInstances](~~2411819~~)。', 'type' => 'string', 'required' => true, 'example' => 'pairec-cn-********'], + 'LogUserId' => ['title' => '日志中用户ID。', 'description' => '日志中用户ID。', 'type' => 'string', 'required' => true, 'example' => '1010'], + 'LogItemId' => ['title' => '日志中物品ID。', 'description' => '日志中物品ID。', 'type' => 'string', 'required' => true, 'example' => '9010'], + 'LogRequestId' => ['title' => '日志请求ID。', 'description' => '日志请求ID。', 'type' => 'string', 'required' => true, 'example' => '728C5E01-ABF6-5AA8-B9FC-B3BA05DECC77'], + 'SceneName' => ['title' => '场景名称。', 'description' => '场景名称。', 'type' => 'string', 'required' => true, 'example' => 'video-feed'], + 'Scores' => ['title' => '分数。', 'description' => '分数。', 'type' => 'string', 'required' => true, 'example' => '[\\"{\\\\\\"dbmtl_probs_is_valid_play\\\\\\":0.00032182207107543945,\\\\\\"dbmtl_y_play_time\\\\\\":0.0043269748210906982}\\"]'], + 'UserFeatures' => ['title' => '用户特征。', 'description' => '用户特征。', 'type' => 'string', 'required' => true, 'example' => '{\\"userid\\":{\\"value\\":1010,\\"type\\":\\"string\\"},\\"click_5_seq\\":{\\"value\\":\\"9001;9002;9003;9004;9005\\",\\"type\\":\\"string\\"}}'], + 'ItemFeatures' => ['title' => '物品特征。', 'description' => '物品特征。', 'type' => 'string', 'required' => true, 'example' => '[\\"{\\\\\\"itemid\\\\\\":{\\\\\\"value\\\\\\":1010,\\\\\\"type\\\\\\":\\\\\\"string\\\\\\"}}\\"]'], + 'LogRequestTime' => ['title' => '日志请求时间。', 'description' => '日志请求时间（UNIX纪元时间戳）。', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1693900981465'], + 'ServiceName' => ['type' => 'string', 'required' => false, 'description' => ''], + ], 'required' => false, - 'example' => 'Desc', ], ], - [ - 'name' => 'PageNumber', - 'in' => 'query', + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'title' => '页大小。', - 'description' => '页大小。', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => 'BDB621CB-A81E-5D39-8793-39A365CBCC74'], + ], ], ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '特征一致性检查数据回流', + 'changeSet' => [ + ['createdAt' => '2025-03-03T01:31:15.000Z', 'description' => '请求参数发生变更'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'BackflowFeatureConsistencyCheckJobData'], + ], + ], + 'ramActions' => [ [ - 'name' => 'PageSize', - 'in' => 'query', - 'schema' => [ - 'title' => '页码。', - 'description' => '页码。', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '50', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'pairec:BackflowFeatureConsistencyCheckJobData', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIRecService', 'resourceType' => '全部资源', 'arn' => '*'], + ], ], ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"BDB621CB-A81E-5D39-8793-39A365CBCC74\\"\\n}","type":"json"}]', + ], + 'ChangeRecallManagementServiceVersion' => [ + 'summary' => '此API用于更新指定召回管理服务的版本。', + 'path' => '/api/v1/recallmanagementservices/{RecallManagementServiceId}/action/changeversion', + 'methods' => ['post'], + 'schemes' => ['https'], + 'security' => [ [ - 'name' => 'Type', - 'in' => 'query', + 'AK' => [], + ], + ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATURElearnN0NAWV'], + ], + 'parameters' => [ + [ + 'name' => 'RecallManagementServiceId', + 'in' => 'path', + 'schema' => ['description' => '召回管理服务ID。'."\n", 'type' => 'string', 'required' => false, 'example' => '2'], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', 'schema' => [ - 'title' => '实例类型。'."\n" - .'● basic-基础版'."\n" - .'● highleve-升级版'."\n" - .'● advance-进阶版'."\n" - .'● standard-标准版', - 'description' => '实例类型。'."\n" - .'- basic-基础版'."\n" - .'- highleve-升级版'."\n" - .'- advance-进阶版'."\n" - .'- standard-标准版', - 'type' => 'string', + 'description' => '请求Body。', + 'type' => 'object', + 'properties' => [ + 'InstanceId' => ['description' => '实例ID。'."\n", 'type' => 'string', 'required' => false, 'example' => 'pairec-cn-test123'], + 'RecallManagementServiceVersionId' => ['description' => '召回管理服务版本ID。'."\n", 'type' => 'string', 'required' => false, 'example' => '1'], + ], 'required' => false, - 'example' => 'basic', ], ], ], @@ -393,256 +390,64 @@ 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => 'BDB621CB-A81E-5D39-8793-39A365CBCC74', - ], - 'Instances' => [ - 'description' => '实例列表。', - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'InstanceId' => [ - 'title' => '实例id。', - 'description' => '实例ID。', - 'type' => 'string', - 'example' => 'pairec-test1', - ], - 'Type' => [ - 'title' => '实例类型。'."\n" - .'● basic-基础版'."\n" - .'● highleve-升级版'."\n" - .'● advance-进阶版'."\n" - .'● standard-标准版', - 'description' => '实例类型。'."\n" - .'- basic-基础版'."\n" - .'- highleve-升级版'."\n" - .'- advance-进阶版'."\n" - .'- standard-标准版', - 'type' => 'string', - 'example' => 'basic', - ], - 'Status' => [ - 'title' => '实例状态。'."\n" - .'● Initializing-初始化中'."\n" - .'● Stopped-停止服务'."\n" - .'● Running-运行中', - 'description' => '实例状态。'."\n" - .'- Initializing-初始化中'."\n" - .'- Stopped-停止服务'."\n" - .'- Running-运行中', - 'type' => 'string', - 'example' => 'Initializing', - ], - 'RegionId' => [ - 'title' => '区域ID。'."\n" - .'● cn-shenzhen - 深圳'."\n" - .'● cn-hangzhou - 杭州'."\n" - .'● cn-beijing - 北京'."\n" - .'● cn-shanghai - 上海', - 'description' => '区域ID。'."\n" - .'- cn-shenzhen-深圳'."\n" - .'- cn-hangzhou- 杭州'."\n" - .'- cn-beijing - 北京'."\n" - .'- cn-shanghai- 上海', - 'type' => 'string', - 'example' => 'cn-shenzhen', - ], - 'GmtCreateTime' => [ - 'title' => '实例创建时间。', - 'description' => '实例创建时间。', - 'type' => 'string', - 'example' => '2022-10-13 17:34:52.0', - ], - 'GmtModifiedTime' => [ - 'title' => '实例更新时间。', - 'description' => '实例更新时间。', - 'type' => 'string', - 'example' => '2022-11-05 09:02:30.0', - ], - 'ExpiredTime' => [ - 'title' => '实例过期时间。', - 'description' => '实例过期时间。', - 'type' => 'string', - 'example' => '2022-12-14 00:00:00.0', - ], - 'CommodityCode' => [ - 'title' => '实例所属的商品code。', - 'description' => '实例所属的商品code。', - 'type' => 'string', - 'example' => 'airec_developers_public_cn', - ], - 'ChargeType' => [ - 'title' => '实例的付费类型，目前仅支持Subscription（预付费）。', - 'description' => '实例的付费类型，目前仅支持Subscription（预付费）。', - 'type' => 'string', - 'example' => 'Subscription', - ], - 'Config' => [ - 'title' => '实例配置。', - 'description' => '实例配置。', - 'type' => 'object', - 'properties' => [ - 'Engines' => [ - 'title' => '服务引擎列表。', - 'description' => '服务引擎列表。', - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'ComponentCode' => [ - 'title' => '组件代码。', - 'description' => '组件代码。', - 'type' => 'string', - 'example' => 'feature', - ], - 'Type' => [ - 'title' => '组件类型。', - 'description' => '组件类型。', - 'type' => 'string', - 'example' => 'Hologres', - ], - 'Meta' => [ - 'title' => '元数据。', - 'description' => '元数据。', - 'type' => 'object', - ], - ], - ], - ], - 'Monitors' => [ - 'title' => '配套功能列表。', - 'description' => '配套功能列表。', - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'ComponentCode' => [ - 'title' => '组件代码。', - 'description' => '组件代码。', - 'type' => 'string', - 'example' => 'featuresets', - ], - 'Type' => [ - 'title' => '组件类型。', - 'description' => '组件类型。', - 'type' => 'string', - 'example' => 'Platform', - ], - 'Meta' => [ - 'title' => '元数据。', - 'description' => '元数据。', - 'type' => 'object', - ], - ], - ], - ], - 'DataManagements' => [ - 'title' => '建模环境列表。', - 'description' => '建模环境列表。', - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'ComponentCode' => [ - 'title' => '组件代码。', - 'description' => '组件代码。', - 'type' => 'string', - 'example' => 'storage', - ], - 'Type' => [ - 'title' => '组件类型。', - 'description' => '组件类型。', - 'type' => 'string', - 'example' => 'OSS', - ], - 'Meta' => [ - 'title' => '元数据。', - 'description' => '元数据。', - 'type' => 'object', - ], - ], - ], - ], - ], - ], - 'OperatingTool' => [ - 'description' => '运营工具相关配置。', - 'type' => 'object', - 'properties' => [ - 'IsEnable' => [ - 'description' => '实例是不是启用了运营工具，取值：'."\n" - .'- true 开启'."\n" - .'- false 未开启', - 'type' => 'boolean', - 'example' => 'true', - ], - ], - ], - ], - ], - ], - 'TotalCount' => [ - 'title' => '列表内元素总数。', - 'description' => '列表内元素总数。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '7', - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => '请求id。'."\n", 'type' => 'string', 'example' => '728C5E01-ABF6-5AA8-B9FC-B3BA05DECC77'], ], ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '更改召回管理服务版本', + 'description' => '## 请求说明'."\n" + .'通过调用此API，您可以更改特定召回管理服务的版本。请确保提供的`RecallManagementServiceId`、`InstanceId`以及目标`RecallManagementServiceVersionId`都是有效的，并且您有权限对这些资源进行操作。'."\n" + ."\n" + .'- **RecallManagementServiceId**：需要更改版本的召回管理服务的唯一标识符。'."\n" + .'- **InstanceId**：与召回管理服务关联的实例ID。'."\n" + .'- **RecallManagementServiceVersionId**：要切换到的目标版本ID。'."\n" + ."\n" + .'注意：在执行版本变更前，请确认新版本已经过充分测试并准备好上线使用。'."\n", + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"BDB621CB-A81E-5D39-8793-39A365CBCC74\\",\\n \\"Instances\\": [\\n {\\n \\"InstanceId\\": \\"pairec-test1\\",\\n \\"Type\\": \\"basic\\",\\n \\"Status\\": \\"Initializing\\",\\n \\"RegionId\\": \\"cn-shenzhen\\",\\n \\"GmtCreateTime\\": \\"2022-10-13 17:34:52.0\\",\\n \\"GmtModifiedTime\\": \\"2022-11-05 09:02:30.0\\",\\n \\"ExpiredTime\\": \\"2022-12-14 00:00:00.0\\",\\n \\"CommodityCode\\": \\"airec_developers_public_cn\\",\\n \\"ChargeType\\": \\"Subscription\\",\\n \\"Config\\": {\\n \\"Engines\\": [\\n {\\n \\"ComponentCode\\": \\"feature\\",\\n \\"Type\\": \\"Hologres\\",\\n \\"Meta\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n }\\n }\\n ],\\n \\"Monitors\\": [\\n {\\n \\"ComponentCode\\": \\"featuresets\\",\\n \\"Type\\": \\"Platform\\",\\n \\"Meta\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n }\\n }\\n ],\\n \\"DataManagements\\": [\\n {\\n \\"ComponentCode\\": \\"storage\\",\\n \\"Type\\": \\"OSS\\",\\n \\"Meta\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n }\\n }\\n ]\\n },\\n \\"OperatingTool\\": {\\n \\"IsEnable\\": true\\n }\\n }\\n ],\\n \\"TotalCount\\": 7\\n}","type":"json"}]', - 'title' => '获取实例列表', + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"728C5E01-ABF6-5AA8-B9FC-B3BA05DECC77\\"\\n}","type":"json"}]', ], - 'GetInstance' => [ - 'summary' => '获取指定PAIRec实例的详细信息。', - 'path' => '/api/v1/instances/{InstanceId}', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'ChatConversation' => [ + 'summary' => '向智能体发送对话消息，支持SSE，可创建新会话或在已有会话中继续对话。', + 'path' => '/api/v1/conversations/chat', + 'methods' => ['post'], + 'schemes' => ['https', 'sse'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], - 'operationType' => 'read', + 'consumes' => ['application/json'], + 'produces' => ['text/event-stream'], + 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'get', + 'operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeCode' => '163068', - 'abilityTreeNodes' => [ - 'FEATURElearnN0NAWV', - ], + 'abilityTreeNodes' => ['FEATURElearnN0NAWV'], ], 'parameters' => [ [ - 'name' => 'InstanceId', - 'in' => 'path', + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', 'schema' => [ - 'title' => '实例ID。', - 'description' => '实例ID，可通过接口ListInstances获取。', - 'type' => 'string', + 'description' => '请求Body。', + 'type' => 'object', + 'properties' => [ + 'InstanceId' => ['title' => '实例ID。', 'description' => '实例ID。', 'type' => 'string', 'required' => true, 'example' => 'learn-pairec-xxx'], + 'ConversationId' => ['title' => '会话ID。不传则创建新会话，传入则在已有会话上下文中继续对话。', 'description' => '会话ID。不传则创建新会话，传入则在已有会话上下文中继续对话。'."\n", 'type' => 'string', 'required' => false, 'example' => 'e47cfae9-c0cc-42e1-91e2-e67cdb0e7b96'], + 'Content' => ['title' => '消息内容。', 'description' => '消息内容。'."\n", 'type' => 'string', 'required' => true, 'example' => '校验引擎配置'], + 'Config' => ['title' => '额外信息输入，JSON格式。', 'description' => '额外信息输入，JSON格式。'."\n", 'type' => 'string', 'required' => false, 'example' => '{}'], + ], 'required' => false, - 'example' => 'pairec-cn-abcdefg1234', + 'example' => '{}', ], ], ], @@ -653,240 +458,120 @@ 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => '请求id。', - 'description' => '请求id。', - 'type' => 'string', - 'example' => '728C5E01-ABF6-5AA8-B9FC-B3BA05DECC77', - ], - 'InstanceId' => [ - 'title' => '实例id。', - 'description' => '实例id。', - 'type' => 'string', - 'example' => 'pairec-test1', - ], - 'Type' => [ - 'title' => '实例类型。'."\n" - .'● basic-基础版'."\n" - .'● highleve-升级版'."\n" - .'● advance-进阶版'."\n" - .'● standard-标准版', - 'description' => '实例类型。'."\n" - .'● basic-基础版'."\n" - .'● highleve-升级版'."\n" - .'● advance-进阶版'."\n" - .'● standard-标准版', - 'type' => 'string', - 'example' => 'basic', - ], - 'Status' => [ - 'title' => '实例状态。'."\n" - .'● Initializing-初始化中'."\n" - .'● Stopped-停止服务'."\n" - .'● Running-运行中', - 'description' => '实例状态。'."\n" - .'● Initializing-初始化中'."\n" - .'● Stopped-停止服务'."\n" - .'● Running-运行中', - 'type' => 'string', - 'example' => 'Initializing', - ], - 'RegionId' => [ - 'title' => '区域ID。'."\n" - .'● cn-shenzhen - 深圳'."\n" - .'● cn-hangzhou - 杭州'."\n" - .'● cn-beijing - 北京'."\n" - .'● cn-shanghai - 上海', - 'description' => '区域ID。'."\n" - .'● cn-shenzhen - 深圳'."\n" - .'● cn-hangzhou - 杭州'."\n" - .'● cn-beijing - 北京'."\n" - .'● cn-shanghai - 上海', - 'type' => 'string', - 'example' => 'cn-shenzhen', - ], - 'GmtCreateTime' => [ - 'title' => '实例创建时间。', - 'description' => '实例创建时间。', - 'type' => 'string', - 'example' => '2022-10-13 17:34:52.0', - ], - 'GmtModifiedTime' => [ - 'title' => '实例更新时间。', - 'description' => '实例更新时间。', - 'type' => 'string', - 'example' => '2022-11-05 09:02:30.0', - ], - 'ExpiredTime' => [ - 'title' => '实例过期时间。', - 'description' => '实例过期时间。', - 'type' => 'string', - 'example' => '2022-12-14 00:00:00.0', - ], - 'CommodityCode' => [ - 'title' => '实例所属的商品code。', - 'description' => '实例所属的商品code。', - 'type' => 'string', - 'example' => 'airec_developers_public_cn', - ], - 'ChargeType' => [ - 'title' => '实例的付费类型，目前仅支持Subscription（预付费）。', - 'description' => '实例的付费类型，目前仅支持Subscription（预付费）。', - 'type' => 'string', - 'example' => 'Subscription', - ], - 'Config' => [ - 'title' => '实例配置。', - 'description' => '实例配置。', - 'type' => 'object', - 'properties' => [ - 'Engines' => [ - 'title' => '服务引擎列表。', - 'description' => '服务引擎列表。', - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'ComponentCode' => [ - 'title' => '组件代码。', - 'description' => '组件代码。', - 'type' => 'string', - 'example' => 'feature', - ], - 'Type' => [ - 'title' => '组件类型。', - 'description' => '组件类型。', - 'type' => 'string', - 'example' => 'Hologres', - ], - 'Meta' => [ - 'title' => '元数据。', - 'description' => '元数据。', - 'type' => 'object', - ], - ], - ], - ], - 'Monitors' => [ - 'title' => '配套功能列表。', - 'description' => '配套功能列表。', - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'ComponentCode' => [ - 'title' => '组件代码。', - 'description' => '组件代码。', - 'type' => 'string', - 'example' => 'featuresets', - ], - 'Type' => [ - 'title' => '组件类型。', - 'description' => '组件类型。', - 'type' => 'string', - 'example' => 'Platform', - ], - 'Meta' => [ - 'title' => '元数据。', - 'description' => '元数据。', - 'type' => 'object', - ], - ], - ], - ], - 'DataManagements' => [ - 'title' => '建模环境列表。', - 'description' => '建模环境列表。', - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'ComponentCode' => [ - 'title' => '组件代码。', - 'description' => '组件代码。', - 'type' => 'string', - 'example' => 'storage', - ], - 'Type' => [ - 'title' => '组件类型。', - 'description' => '组件类型。', - 'type' => 'string', - 'example' => 'OSS', - ], - 'Meta' => [ - 'title' => '元数据。', - 'description' => '元数据。', - 'type' => 'object', - ], - ], - ], - ], - ], - ], - 'OperatingTool' => [ - 'description' => '运营工具相关配置。', - 'type' => 'object', - 'properties' => [ - 'IsEnable' => [ - 'description' => '实例是不是启用了运营工具，取值：'."\n" - .'- True 开启'."\n" - .'- False 未开启', - 'type' => 'boolean', - 'example' => 'True', - ], - ], - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => '请求id。'."\n", 'type' => 'string', 'example' => '728C5E01-ABF6-5AA8-B9FC-B3BA05DECC77'], + 'ConversationId' => ['title' => '会话ID。', 'description' => '会话ID。'."\n", 'type' => 'string', 'example' => 'e47cfae9-c0cc-42e1-91e2-e67cdb0e7b96'], + 'MessageId' => ['title' => '消息ID。', 'description' => '消息ID。'."\n", 'type' => 'string', 'example' => 'chat-abcdefg'], + 'Event' => ['title' => '事件。', 'description' => '事件。'."\n", 'type' => 'string', 'example' => 'message'], + 'Answer' => ['title' => '回复内容。', 'description' => '回复内容。'."\n", 'type' => 'string', 'example' => 'FeatureDB近7天读写量为xxx'], + 'GmtCreateTime' => ['title' => '创建时间。', 'description' => '创建时间。'."\n", 'type' => 'string', 'example' => '2021-12-15T23:24:33.132+08:00'], + 'ErrorCode' => ['title' => '错误码。', 'description' => '错误码。'."\n", 'type' => 'string', 'example' => 'SERVER_ERROR'], + 'ErrorMessage' => ['title' => '错误消息。', 'description' => '错误消息。'."\n", 'type' => 'string', 'example' => 'connection failed'], + 'SkillName' => ['title' => 'skill 名称。', 'description' => 'skill 名称。', 'type' => 'string', 'example' => '""'], + 'Func' => ['title' => '函数名称', 'description' => '函数名称', 'type' => 'string', 'example' => '""'], + 'CallId' => ['title' => '调用ID。', 'description' => '调用ID。', 'type' => 'string', 'example' => '""'], ], ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '发送对话消息', + 'description' => '## 请求说明'."\n" + .'- 通过此API可以向智能体发送对话消息，并且支持服务器发送事件（SSE）。'."\n" + .'- 如果提供了`ConversationId`参数，则会在指定的已有会话上下文中继续对话；若未提供，则自动创建一个新的会话。'."\n" + .'- `Config`字段允许用户传递额外的信息输入，必须是JSON格式。'."\n" + .'- 当请求成功时，响应将包含本次对话的消息ID、回复内容等信息；如果发生错误，也会返回相应的错误码和错误消息。'."\n", + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'pairec:ChatConversation', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIRecService', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"728C5E01-ABF6-5AA8-B9FC-B3BA05DECC77\\",\\n \\"InstanceId\\": \\"pairec-test1\\",\\n \\"Type\\": \\"basic\\",\\n \\"Status\\": \\"Initializing\\",\\n \\"RegionId\\": \\"cn-shenzhen\\",\\n \\"GmtCreateTime\\": \\"2022-10-13 17:34:52.0\\",\\n \\"GmtModifiedTime\\": \\"2022-11-05 09:02:30.0\\",\\n \\"ExpiredTime\\": \\"2022-12-14 00:00:00.0\\",\\n \\"CommodityCode\\": \\"airec_developers_public_cn\\",\\n \\"ChargeType\\": \\"Subscription\\",\\n \\"Config\\": {\\n \\"Engines\\": [\\n {\\n \\"ComponentCode\\": \\"feature\\",\\n \\"Type\\": \\"Hologres\\",\\n \\"Meta\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n }\\n }\\n ],\\n \\"Monitors\\": [\\n {\\n \\"ComponentCode\\": \\"featuresets\\",\\n \\"Type\\": \\"Platform\\",\\n \\"Meta\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n }\\n }\\n ],\\n \\"DataManagements\\": [\\n {\\n \\"ComponentCode\\": \\"storage\\",\\n \\"Type\\": \\"OSS\\",\\n \\"Meta\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n }\\n }\\n ]\\n },\\n \\"OperatingTool\\": {\\n \\"IsEnable\\": true\\n }\\n}","type":"json"}]', - 'title' => '获取实例详细信息', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"728C5E01-ABF6-5AA8-B9FC-B3BA05DECC77\\",\\n \\"ConversationId\\": \\"e47cfae9-c0cc-42e1-91e2-e67cdb0e7b96\\",\\n \\"MessageId\\": \\"chat-abcdefg\\",\\n \\"Event\\": \\"message\\",\\n \\"Answer\\": \\"FeatureDB近7天读写量为xxx\\",\\n \\"GmtCreateTime\\": \\"2021-12-15T23:24:33.132+08:00\\",\\n \\"ErrorCode\\": \\"SERVER_ERROR\\",\\n \\"ErrorMessage\\": \\"connection failed\\",\\n \\"SkillName\\": \\"\\\\\\"\\\\\\"\\",\\n \\"Func\\": \\"\\\\\\"\\\\\\"\\",\\n \\"CallId\\": \\"\\\\\\"\\\\\\"\\"\\n}","type":"json"}]', ], - 'GetRecallManagementConfig' => [ - 'summary' => '获取召回管理配置。', - 'path' => '/api/v1/recallmanagementconfigs', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'https', - ], + 'CheckInstanceResources' => [ + 'summary' => '检测实例下配置的资源的连接状态。', + 'path' => '/api/v1/instances/{InstanceId}/action/checkresources', + 'methods' => ['post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'get', + 'operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATURElearnN0NAWV', - ], + 'abilityTreeNodes' => ['FEATURElearnN0NAWV'], ], 'parameters' => [ [ - 'name' => 'InstanceId', - 'in' => 'query', + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', 'schema' => [ - 'description' => '实例ID，可通过接口ListInstances获取。', - 'type' => 'string', + 'description' => '请求体参数。', + 'type' => 'object', + 'properties' => [ + 'Type' => ['description' => '资源类型。'."\n" + ."\n" + .'- Hologres'."\n" + ."\n" + .'- EAS'."\n" + ."\n" + .'- BE'."\n" + ."\n" + .'- Rec'."\n" + ."\n" + .'- Platform'."\n" + ."\n" + .'- SLS'."\n" + ."\n" + .'- DataHub'."\n" + ."\n" + .'- Kafka'."\n" + ."\n" + .'- Flinkvvp'."\n" + ."\n" + .'- ACR'."\n" + ."\n" + .'- OSS'."\n" + ."\n" + .'- DataWorks'."\n" + ."\n" + .'- PAI'."\n" + ."\n" + .'- MaxCompute'."\n" + ."\n" + .'- GraphCompute'."\n" + ."\n" + .'- Redis', 'type' => 'string', 'required' => true, 'example' => 'OSS'], + 'Uri' => ['description' => '资源地址。', 'type' => 'string', 'required' => false, 'example' => 'bucket-test-123'], + 'ResourceId' => ['type' => 'string', 'required' => false, 'description' => ''], + ], 'required' => false, - 'example' => 'learn-pairec-xxx', ], ], + [ + 'name' => 'InstanceId', + 'in' => 'path', + 'schema' => ['description' => '实例ID，可通过接口[ListInstances](~~2411819~~)获取。', 'type' => 'string', 'required' => true, 'example' => 'pairec-cn-test1'], + ], ], 'responses' => [ 200 => [ @@ -895,58 +580,53 @@ 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'Id of the request', - 'type' => 'string', - 'example' => '728C5E01-ABF6-5AA8-B9FC-B3BA05DECC77', - ], - 'UserName' => [ - 'description' => '用户名。', - 'type' => 'string', - 'example' => 'scene_test', - ], - 'NetworkConfigs' => [ - 'description' => '网络配置信息。', + 'RequestId' => ['title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => '9763624B-5FBB-5E3A-9193-B1ADB554CEAE'], + 'Resources' => [ + 'description' => '资源列表。', 'type' => 'array', 'items' => [ - 'description' => '网络配置信息详情。', + 'description' => '资源信息。', 'type' => 'object', 'properties' => [ - 'VpcId' => [ - 'description' => '专有网络（VPC）ID。', - 'type' => 'string', - 'example' => 'vpc-xxx', - ], - 'Status' => [ - 'description' => '网络连接状态，枚举值：'."\n" - ."\n" - .'- Connecting：连接中。'."\n" - ."\n" - .'- Connected：已连接。'."\n" - ."\n" - .'- ConnectionFailed：连接失败。'."\n" - ."\n" - .'- Updating：更新中。'."\n" - ."\n" - .'- UpdateFailed：更新失败。', - 'type' => 'string', - 'example' => 'Connecting', - ], - 'VswitchIds' => [ - 'description' => '可用区。', - 'type' => 'object', - 'additionalProperties' => [ - 'type' => 'string', - 'example' => 'vsw-xxx', - 'description' => '交换机信息。', - ], - ], - 'PrivateLinkAddress' => [ - 'description' => '私网连接地址。', - 'type' => 'string', - 'example' => 'http://xxx', - ], + 'Type' => ['description' => '资源类型'."\n" + ."\n" + .'- Hologres'."\n" + ."\n" + .'- EAS'."\n" + ."\n" + .'- BE'."\n" + ."\n" + .'- Rec'."\n" + ."\n" + .'- Platform'."\n" + ."\n" + .'- SLS'."\n" + ."\n" + .'- DataHub'."\n" + ."\n" + .'- Kafka'."\n" + ."\n" + .'- Flinkvvp'."\n" + ."\n" + .'- ACR'."\n" + ."\n" + .'- OSS'."\n" + ."\n" + .'- DataWorks'."\n" + ."\n" + .'- PAI'."\n" + ."\n" + .'- MaxCompute'."\n" + ."\n" + .'- GraphCompute'."\n" + ."\n" + .'- Redis', 'type' => 'string', 'example' => 'OSS'], + 'Uri' => ['description' => '资源地址。', 'type' => 'string', 'example' => 'bucket-test-123'], + 'Status' => ['description' => '访问状态'."\n" + ."\n" + .'- Success'."\n" + ."\n" + .'- Failure', 'type' => 'string', 'example' => 'Success'], ], ], ], @@ -954,72 +634,66 @@ ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"9763624B-5FBB-5E3A-9193-B1ADB554CEAE\\",\\n \\"Resources\\": [\\n {\\n \\"Type\\": \\"OSS\\",\\n \\"Uri\\": \\"bucket-test-123\\",\\n \\"Status\\": \\"Success\\"\\n }\\n ]\\n}","type":"json"}]', + 'title' => '检查资源状态', + 'changeSet' => [ + ['createdAt' => '2025-05-19T06:21:38.000Z', 'description' => '请求参数发生变更'], + ['createdAt' => '2024-02-22T03:35:43.000Z', 'description' => '请求参数发生变更'], + ], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'pairec:CheckInstanceResources', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIRecService', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"728C5E01-ABF6-5AA8-B9FC-B3BA05DECC77\\",\\n \\"UserName\\": \\"scene_test\\",\\n \\"NetworkConfigs\\": [\\n {\\n \\"VpcId\\": \\"vpc-xxx\\",\\n \\"Status\\": \\"Connecting\\",\\n \\"VswitchIds\\": {\\n \\"key\\": \\"vsw-xxx\\"\\n },\\n \\"PrivateLinkAddress\\": \\"http://xxx\\"\\n }\\n ]\\n}","type":"json"}]', - 'title' => '获取召回管理配置', ], - 'GetRecallManagementServiceVersion' => [ - 'summary' => '获取召回管理服务版本详情。', - 'path' => '/api/v1/recallmanagementservices/{RecallManagementServiceId}/versions/{RecallManagementServiceVersionId}', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'https', - ], + 'CheckTrafficControlTaskExpression' => [ + 'summary' => '验证给定的流量调控任务表达式是否有效。', + 'path' => '/api/v1/trafficcontroltasks/action/checkexpression', + 'methods' => ['get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATURElearnN0NAWV', - ], + 'abilityTreeCode' => '226483', + 'abilityTreeNodes' => ['FEATURElearnN0NAWV'], ], 'parameters' => [ [ - 'name' => 'RecallManagementServiceId', - 'in' => 'path', - 'schema' => [ - 'description' => '召回管理服务ID。', - 'type' => 'string', - 'required' => false, - 'example' => '3', - ], + 'name' => 'InstanceId', + 'in' => 'query', + 'schema' => ['description' => '实例ID。', 'type' => 'string', 'required' => true, 'example' => 'pairec_123****'], ], [ - 'name' => 'RecallManagementServiceVersionId', - 'in' => 'path', - 'schema' => [ - 'description' => '召回管理服务版本ID。', - 'type' => 'string', - 'required' => false, - 'example' => '2', - ], + 'name' => 'Expression', + 'in' => 'query', + 'schema' => ['description' => '表达式。', 'type' => 'string', 'required' => true, 'example' => 'event=exposure'], ], [ - 'name' => 'InstanceId', + 'name' => 'TableMetaId', 'in' => 'query', - 'schema' => [ - 'description' => '实例ID。', - 'type' => 'string', - 'required' => false, - 'example' => 'learn-pairec-xxx', - ], + 'schema' => ['description' => '数据表 ID。', 'type' => 'string', 'required' => true, 'example' => '1'], ], ], 'responses' => [ @@ -1029,352 +703,147 @@ 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'Id of the request', - 'type' => 'string', - 'example' => 'E15A1443-7917-5BE0-AE70-25538ECF398D', - ], - 'RecallManagementServiceVersionId' => [ - 'description' => '召回管理服务版本ID。', - 'type' => 'string', - 'example' => '2', - ], - 'Name' => [ - 'description' => '召回管理服务版本名称。', - 'type' => 'string', - 'example' => 'V1', - ], - 'IsDefault' => [ - 'description' => '是否是默认的召回管理服务版本。', - 'type' => 'string', - 'example' => 'false', - ], - 'Configs' => [ - 'description' => '配置详情。', - 'type' => 'object', - 'properties' => [ - 'RecallConfigs' => [ - 'description' => '召回管理服务版本配置列表。', - 'type' => 'array', - 'items' => [ - 'description' => '召回管理服务版本配置详情。', - 'type' => 'object', - 'properties' => [ - 'Name' => [ - 'description' => '召回名称。', - 'type' => 'string', - 'example' => 'etrec', - ], - 'Description' => [ - 'description' => '召回描述。', - 'type' => 'string', - 'example' => 'this is etrec recall', - ], - 'Priority' => [ - 'description' => '优先级。数字越小，优先级越高。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '10', - ], - 'RecallType' => [ - 'description' => '召回类型。', - 'type' => 'string', - 'example' => 'X2I', - ], - 'RecallManagementTableId' => [ - 'description' => '召回管理表ID。', - 'type' => 'string', - 'example' => '2', - ], - 'UserVectorRecallManagementTableId' => [ - 'description' => '用户向量召回表ID。', - 'type' => 'string', - 'example' => '3', - ], - 'UserVectorField' => [ - 'description' => '用户向量字段。', - 'type' => 'string', - 'example' => 'user_embedding', - ], - 'ItemVectorRecallManagementTableId' => [ - 'description' => '物品向量召回表ID。', - 'type' => 'string', - 'example' => '4', - ], - 'ItemVectorField' => [ - 'description' => '物品向量字段。', - 'type' => 'string', - 'example' => 'item_embedding', - ], - 'Operators' => [ - 'description' => '算子列表。', - 'type' => 'array', - 'items' => [ - 'description' => '算子详情。', - 'type' => 'object', - 'properties' => [ - 'OperatorType' => [ - 'description' => '算子类型。', - 'type' => 'string', - 'example' => 'Filter', - ], - 'TriggerConfig' => [ - 'description' => 'Trigger算子的配置。', - 'type' => 'object', - 'properties' => [ - 'Field' => [ - 'description' => '字段名称。', - 'type' => 'string', - 'example' => 'user_id', - ], - 'IsRandSort' => [ - 'description' => '是否随机排序。', - 'type' => 'string', - 'example' => 'false', - ], - 'SortField' => [ - 'description' => '排序字段。', - 'type' => 'string', - 'example' => 'create_time', - ], - 'FieldQuantityLimit' => [ - 'description' => '字段数量限制。', - 'type' => 'string', - 'example' => '20', - ], - ], - ], - 'FilterConfig' => [ - 'description' => '过滤算子的配置。', - 'type' => 'object', - 'properties' => [ - 'Experession' => [ - 'description' => '表达式。', - 'type' => 'string', - 'example' => 'age > 10', - ], - ], - ], - 'FeatureConfig' => [ - 'description' => '特征算子的配置。', - 'type' => 'object', - 'properties' => [ - 'Name' => [ - 'description' => '特征名称。', - 'type' => 'string', - 'example' => 'city', - ], - 'Type' => [ - 'description' => '特征类型。', - 'type' => 'string', - 'example' => 'STRING', - ], - 'Expression' => [ - 'description' => '特征表达式。', - 'type' => 'string', - 'example' => 'city = \'hangzhou\'', - ], - ], - ], - 'JoinConfig' => [ - 'description' => 'Join算子的配置。', - 'type' => 'object', - 'properties' => [ - 'Field' => [ - 'description' => 'Join字段。', - 'type' => 'string', - 'example' => 'item_id', - ], - 'RecallManagementTableId' => [ - 'description' => 'Join表ID。', - 'type' => 'string', - 'example' => '3', - ], - 'OutputFields' => [ - 'description' => '返回字段列表。', - 'type' => 'array', - 'items' => [ - 'description' => '返回字段。', - 'type' => 'string', - 'example' => 'category', - ], - ], - ], - ], - ], - ], - ], - 'ExtendedConfig' => [ - 'description' => '额外配置，方便以后功能扩展。', - 'type' => 'string', - 'example' => '""', - ], - 'RecallManagementServiceVersionConfigId' => [ - 'description' => '召回管理服务版本配置ID。', - 'type' => 'string', - 'example' => '5', - ], - 'ItemConditionArray' => [ - 'description' => '物品条件，设置数组格式条件。', - 'type' => 'string', - 'example' => '[{"option":"<","field":"category","type":"STRING","value":"10"}]', - ], - 'ItemConditionExpression' => [ - 'title' => '物品条件表达式。', - 'description' => '物品条件表达式。', - 'type' => 'string', - 'example' => 'age>20', - ], - ], - ], - ], - 'MergeConfig' => [ - 'description' => '归并配置。', - 'type' => 'object', - 'properties' => [ - 'RecallManagementServiceVersionConfigId' => [ - 'description' => '召回管理服务版本配置ID。', - 'type' => 'string', - 'example' => '1', - ], - 'MergeType' => [ - 'description' => '归并类型。', - 'type' => 'string', - 'example' => 'Weight', - ], - 'FilterRecallManagementTableIds' => [ - 'description' => '过滤表ID列表。', - 'type' => 'array', - 'items' => [ - 'description' => '过滤表ID。', - 'type' => 'string', - 'example' => '3', - ], - ], - 'ItemRecallManagementTableId' => [ - 'description' => '物品表ID。', - 'type' => 'string', - 'example' => '2', - ], - 'ItemTableFields' => [ - 'description' => '物品表输出字段列表。', - 'type' => 'array', - 'items' => [ - 'description' => '物品表输出字段。', - 'type' => 'string', - 'example' => 'item_id', - ], - ], - 'ExtendedConfig' => [ - 'description' => '归并配置的一些额外配置，方便以后功能扩展。', - 'type' => 'string', - 'example' => '""', - ], - 'FilterExpression' => [ - 'description' => '过滤表达式。', - 'type' => 'string', - 'example' => 'age>20', - ], - ], - ], - ], - ], - 'GmtCreateTime' => [ - 'description' => '创建时间。', - 'type' => 'string', - 'example' => '2021-12-15T23:24:33.132+08:00', - ], - 'GmtModifiedTime' => [ - 'description' => '更新时间。', - 'type' => 'string', - 'example' => '2021-12-15T23:24:33.132+08:00', - ], - 'IsEffective' => [ - 'title' => '当前版本是否有效。', - 'description' => '当前版本是否有效。', - 'type' => 'boolean', - 'default' => 'false', - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => '728C5E01-ABF6-5AA8-B9FC-B3BA05DECC77'], + 'IsValie' => ['description' => '是否有效。', 'type' => 'boolean', 'example' => 'true'], + 'Reason' => ['description' => '当 `IsValid` 为 `false` 时，此字段才具有意义'."\n", 'type' => 'string', 'example' => '""'], ], ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '检查流量调控任务表达式', + 'description' => '## 请求说明'."\n" + .'该 API 用于检查指定实例和数据表下的流量调控任务表达式的有效性。请确保提供的 `InstanceId`、`TableMetaId` 和 `Expression` 参数准确无误，以便正确执行校验操作。'."\n", + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"E15A1443-7917-5BE0-AE70-25538ECF398D\\",\\n \\"RecallManagementServiceVersionId\\": \\"2\\",\\n \\"Name\\": \\"V1\\",\\n \\"IsDefault\\": \\"false\\",\\n \\"Configs\\": {\\n \\"RecallConfigs\\": [\\n {\\n \\"Name\\": \\"etrec\\",\\n \\"Description\\": \\"this is etrec recall\\",\\n \\"Priority\\": 10,\\n \\"RecallType\\": \\"X2I\\",\\n \\"RecallManagementTableId\\": \\"2\\",\\n \\"UserVectorRecallManagementTableId\\": \\"3\\",\\n \\"UserVectorField\\": \\"user_embedding\\",\\n \\"ItemVectorRecallManagementTableId\\": \\"4\\",\\n \\"ItemVectorField\\": \\"item_embedding\\",\\n \\"Operators\\": [\\n {\\n \\"OperatorType\\": \\"Filter\\",\\n \\"TriggerConfig\\": {\\n \\"Field\\": \\"user_id\\",\\n \\"IsRandSort\\": \\"false\\",\\n \\"SortField\\": \\"create_time\\",\\n \\"FieldQuantityLimit\\": \\"20\\"\\n },\\n \\"FilterConfig\\": {\\n \\"Experession\\": \\"age > 10\\"\\n },\\n \\"FeatureConfig\\": {\\n \\"Name\\": \\"city\\",\\n \\"Type\\": \\"STRING\\",\\n \\"Expression\\": \\"city = \'hangzhou\'\\"\\n },\\n \\"JoinConfig\\": {\\n \\"Field\\": \\"item_id\\",\\n \\"RecallManagementTableId\\": \\"3\\",\\n \\"OutputFields\\": [\\n \\"category\\"\\n ]\\n }\\n }\\n ],\\n \\"ExtendedConfig\\": \\"\\\\\\"\\\\\\"\\",\\n \\"RecallManagementServiceVersionConfigId\\": \\"5\\",\\n \\"ItemConditionArray\\": \\"[{\\\\\\"option\\\\\\":\\\\\\"<\\\\\\",\\\\\\"field\\\\\\":\\\\\\"category\\\\\\",\\\\\\"type\\\\\\":\\\\\\"STRING\\\\\\",\\\\\\"value\\\\\\":\\\\\\"10\\\\\\"}]\\",\\n \\"ItemConditionExpression\\": \\"age>20\\"\\n }\\n ],\\n \\"MergeConfig\\": {\\n \\"RecallManagementServiceVersionConfigId\\": \\"1\\",\\n \\"MergeType\\": \\"Weight\\",\\n \\"FilterRecallManagementTableIds\\": [\\n \\"3\\"\\n ],\\n \\"ItemRecallManagementTableId\\": \\"2\\",\\n \\"ItemTableFields\\": [\\n \\"item_id\\"\\n ],\\n \\"ExtendedConfig\\": \\"\\\\\\"\\\\\\"\\",\\n \\"FilterExpression\\": \\"age>20\\"\\n }\\n },\\n \\"GmtCreateTime\\": \\"2021-12-15T23:24:33.132+08:00\\",\\n \\"GmtModifiedTime\\": \\"2021-12-15T23:24:33.132+08:00\\",\\n \\"IsEffective\\": true\\n}","type":"json"}]', - 'title' => '获取召回管理服务版本详情', + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"728C5E01-ABF6-5AA8-B9FC-B3BA05DECC77\\",\\n \\"IsValie\\": true,\\n \\"Reason\\": \\"\\\\\\"\\\\\\"\\"\\n}","type":"json"}]', ], - 'GetRecallManagementServiceVersionConfig' => [ - 'summary' => '此API用于查询特定召回管理服务版本的配置详细信息。', - 'path' => '/api/v1/recallmanagementservices/{RecallManagementServiceId}/versions/{RecallManagementServiceVersionId}/configs/{RecallManagementServiceVersionConfigId}', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'https', - ], + 'CloneEngineConfig' => [ + 'summary' => '克隆引擎配置。', + 'path' => '/api/v1/engineconfigs/{EngineConfigId}/action/clone', + 'methods' => ['post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], - 'operationType' => 'read', + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATURElearnN0NAWV', - ], + 'abilityTreeCode' => '180296', + 'abilityTreeNodes' => ['FEATURElearnN0NAWV'], ], 'parameters' => [ [ - 'name' => 'RecallManagementServiceId', + 'name' => 'EngineConfigId', 'in' => 'path', + 'schema' => ['description' => '引擎配置ID。', 'type' => 'string', 'required' => false, 'example' => '1'], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', 'schema' => [ - 'description' => '召回管理服务ID。'."\n", - 'type' => 'string', + 'description' => '请求body。', + 'type' => 'object', + 'properties' => [ + 'ConfigValue' => ['description' => '引擎配置的内容。', 'type' => 'string', 'required' => false, 'example' => '{}'], + 'InstanceId' => ['description' => '实例ID。如何获取实例ID，请参见[ListInstances](~~2411819~~)。', 'type' => 'string', 'required' => false, 'example' => 'pairec-cn-********'], + 'Environment' => ['description' => '运行环境。'."\n" + ."\n" + .'- Daily：日常环境。'."\n" + ."\n" + .'- Pre：预发环境。'."\n" + ."\n" + .'- Prod：生产环境。', 'type' => 'string', 'required' => false, 'example' => 'Pre'], + 'Description' => ['type' => 'string', 'required' => false, 'description' => ''], + ], 'required' => false, - 'example' => '3', ], ], - [ - 'name' => 'RecallManagementServiceVersionId', - 'in' => 'path', + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => '召回管理服务版本ID。'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '2', + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => 'A04CB8C0-E74A-5E83-BC61-64D153574EC7'], + 'EngineConfigId' => ['description' => '引擎配置ID。', 'type' => 'string', 'example' => '2'], + ], ], ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"A04CB8C0-E74A-5E83-BC61-64D153574EC7\\",\\n \\"EngineConfigId\\": \\"2\\"\\n}","type":"json"}]', + 'title' => '克隆引擎配置', + 'changeSet' => [ + ['createdAt' => '2024-12-27T08:56:39.000Z', 'description' => '请求参数发生变更'], + ], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ [ - 'name' => 'RecallManagementServiceVersionConfigId', - 'in' => 'path', - 'schema' => [ - 'description' => '召回管理服务版本配置ID。'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '3', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'pairec:CloneEngineConfig', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIRecService', 'resourceType' => '全部资源', 'arn' => '*'], + ], ], ], + ], + ], + 'CloneExperiment' => [ + 'summary' => '对指定实验进行克隆。', + 'path' => '/api/v1/experiments/{ExperimentId}/action/clone', + 'methods' => ['post'], + 'schemes' => ['http', 'https'], + 'security' => [ [ - 'name' => 'InstanceId', - 'in' => 'query', + 'AK' => [], + ], + ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATURElearnN0NAWV'], + ], + 'parameters' => [ + [ + 'name' => 'ExperimentId', + 'in' => 'path', + 'schema' => ['title' => '实验ID。', 'description' => '实验ID。', 'type' => 'string', 'required' => true, 'example' => 'experiment_test'], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', 'schema' => [ - 'description' => '实例ID。'."\n", - 'type' => 'string', + 'description' => '请求Body。', + 'type' => 'object', + 'properties' => [ + 'InstanceId' => ['title' => '实例ID。', 'description' => '实例ID，可通过接口ListInstances获取。', 'type' => 'string', 'required' => true, 'example' => 'pairec-cn-abcdefg1234'."\n"], + ], 'required' => false, - 'example' => 'learn-pairec-xxx', ], ], ], @@ -1385,324 +854,81 @@ 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'Id of the request', - 'type' => 'string', - 'example' => '728C5E01-ABF6-5AA8-B9FC-B3BA05DECC77', - ], - 'RecallManagementServiceId' => [ - 'description' => '召回管理服务ID。'."\n", - 'type' => 'string', - 'example' => '3', - ], - 'RecallManagementServiceVersionId' => [ - 'description' => '召回管理服务版本ID。'."\n", - 'type' => 'string', - 'example' => '2', - ], - 'RecallManagementServiceVersionConfigId' => [ - 'description' => '召回管理服务版本配置ID。'."\n", - 'type' => 'string', - 'example' => '2', - ], - 'ConfigType' => [ - 'description' => '召回管理版本配置类型。枚举值：Recall：召回配置。Merge：归并配置。'."\n", - 'type' => 'string', - 'example' => 'Recall', - ], - 'RecallConfig' => [ - 'description' => '召回配置。'."\n", - 'type' => 'object', - 'properties' => [ - 'Name' => [ - 'description' => '召回名称。', - 'type' => 'string', - 'example' => 'etrec', - ], - 'Description' => [ - 'description' => '召回描述。'."\n", - 'type' => 'string', - 'example' => 'this is etrec recall', - ], - 'Priority' => [ - 'description' => '优先级。数字越小，优先级越高'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '10', - ], - 'RecallType' => [ - 'description' => '召回类型。'."\n", - 'type' => 'string', - 'example' => 'X2I', - ], - 'RecallManagementTableId' => [ - 'description' => '召回管理表ID。'."\n", - 'type' => 'string', - 'example' => '3', - ], - 'UserVectorRecallManagementTableId' => [ - 'description' => '用户向量召回表ID。'."\n", - 'type' => 'string', - 'example' => '2', - ], - 'UserVectorField' => [ - 'description' => '用户向量字段。'."\n", - 'type' => 'string', - 'example' => 'user_embedding', - ], - 'ItemVectorRecallManagementTableId' => [ - 'description' => '物品向量召回表ID。'."\n", - 'type' => 'string', - 'example' => '2', - ], - 'ItemVectorField' => [ - 'description' => '物品向量字段。'."\n", - 'type' => 'string', - 'example' => 'item_embedding', - ], - 'Operators' => [ - 'description' => '算子列表。', - 'type' => 'array', - 'items' => [ - 'description' => '算子详情。', - 'type' => 'object', - 'properties' => [ - 'OperatorType' => [ - 'description' => '算子类型。', - 'type' => 'string', - 'example' => 'Filter', - ], - 'TriggerConfig' => [ - 'description' => 'Trigger算子的配置。', - 'type' => 'object', - 'properties' => [ - 'Field' => [ - 'description' => '字段名称。', - 'type' => 'string', - 'example' => 'user_id', - ], - 'IsRandSort' => [ - 'description' => '是否随机排序。', - 'type' => 'boolean', - 'example' => 'false', - ], - 'SortField' => [ - 'description' => '排序字段。', - 'type' => 'string', - 'example' => 'create_time', - ], - 'FieldQuantityLimit' => [ - 'description' => '字段数量限制。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '20', - ], - ], - ], - 'FilterConfig' => [ - 'description' => '过滤算子的配置。', - 'type' => 'object', - 'properties' => [ - 'Expression' => [ - 'description' => '过滤表达式。', - 'type' => 'string', - 'example' => 'age>20', - ], - ], - ], - 'FeatureConfig' => [ - 'description' => '特征算子的配置。', - 'type' => 'object', - 'properties' => [ - 'Name' => [ - 'description' => '特征名称。', - 'type' => 'string', - 'example' => 'age', - ], - 'Type' => [ - 'description' => '特征类型。', - 'type' => 'string', - 'example' => 'STRING', - ], - 'Expression' => [ - 'description' => '特征表达式。', - 'type' => 'string', - 'example' => 'category=3', - ], - ], - ], - 'JoinConfig' => [ - 'description' => 'Join算子的配置。', - 'type' => 'object', - 'properties' => [ - 'Field' => [ - 'description' => 'Join字段。', - 'type' => 'string', - 'example' => 'item_id', - ], - 'RecallManagementTableId' => [ - 'description' => 'Join表ID。', - 'type' => 'string', - 'example' => '3', - ], - 'OutputFields' => [ - 'description' => '返回字段列表。', - 'type' => 'array', - 'items' => [ - 'description' => '返回字段列表。', - 'type' => 'string', - 'example' => 'item_id', - ], - ], - ], - ], - ], - ], - ], - 'ExtendedConfig' => [ - 'description' => '额外配置，方便以后功能扩展。'."\n", - 'type' => 'string', - 'example' => '{"":""}', - ], - 'ItemConditionArray' => [ - 'description' => '物品条件，设置数组格式条件。'."\n", - 'type' => 'string', - 'example' => '[{"option":"<","field":"category","type":"STRING","value":"10"}]', - ], - 'ItemConditionExpression' => [ - 'title' => '物品条件表达式。', - 'description' => '物品条件表达式。', - 'type' => 'string', - 'example' => 'age>20', - ], - ], - ], - 'MergeConfig' => [ - 'description' => '归并配置。'."\n", - 'type' => 'object', - 'properties' => [ - 'RecallManagementServiceVersionConfigId' => [ - 'description' => '召回管理服务版本配置ID。'."\n", - 'type' => 'string', - 'example' => '1', - ], - 'MergeType' => [ - 'description' => '归并类型，枚举值：'."\n" - .'- Weight：权重'."\n" - .'- Alternate：交替'."\n", - 'type' => 'string', - 'example' => 'Weight', - ], - 'FilterRecallManagementTableIds' => [ - 'description' => '过滤表ID。'."\n", - 'type' => 'array', - 'items' => [ - 'description' => '过滤表ID列表。', - 'type' => 'string', - 'example' => '3', - ], - ], - 'ItemRecallManagementTableId' => [ - 'description' => '物品表ID。'."\n", - 'type' => 'string', - 'example' => '2', - ], - 'ItemTableFields' => [ - 'description' => '物品表输出字段。'."\n", - 'type' => 'array', - 'items' => [ - 'description' => '物品表输出字段列表。', - 'type' => 'string', - 'example' => 'item_id', - ], - ], - 'FilterExpression' => [ - 'description' => '过滤表达式。', - 'type' => 'string', - 'example' => 'age>20', - ], - 'ExtendedConfig' => [ - 'description' => '归并配置的一些额外配置，方便以后功能扩展。'."\n", - 'type' => 'string', - 'example' => '{"":""}', - ], - ], - ], - 'GmtCreateTime' => [ - 'description' => '创建时间。'."\n", - 'type' => 'string', - 'example' => '2021-12-15T23:24:33.132+08:00', - ], - 'GmtModifiedTime' => [ - 'description' => '更新时间。'."\n", - 'type' => 'string', - 'example' => '2021-12-15T23:24:33.132+08:00', - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => 'F8F613A9-DF1C-551A-88E1-397A3981A785'], + 'ExperimentId' => ['description' => '实验ID。', 'type' => 'string', 'example' => '3'], ], ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"F8F613A9-DF1C-551A-88E1-397A3981A785\\",\\n \\"ExperimentId\\": \\"3\\"\\n}","type":"json"}]', + 'title' => '克隆实验', + 'changeSet' => [ + ['createdAt' => '2023-09-14T01:50:51.000Z', 'description' => '请求参数发生变更'], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"728C5E01-ABF6-5AA8-B9FC-B3BA05DECC77\\",\\n \\"RecallManagementServiceId\\": \\"3\\",\\n \\"RecallManagementServiceVersionId\\": \\"2\\",\\n \\"RecallManagementServiceVersionConfigId\\": \\"2\\",\\n \\"ConfigType\\": \\"Recall\\",\\n \\"RecallConfig\\": {\\n \\"Name\\": \\"etrec\\",\\n \\"Description\\": \\"this is etrec recall\\",\\n \\"Priority\\": 10,\\n \\"RecallType\\": \\"X2I\\",\\n \\"RecallManagementTableId\\": \\"3\\",\\n \\"UserVectorRecallManagementTableId\\": \\"2\\",\\n \\"UserVectorField\\": \\"user_embedding\\",\\n \\"ItemVectorRecallManagementTableId\\": \\"2\\",\\n \\"ItemVectorField\\": \\"item_embedding\\",\\n \\"Operators\\": [\\n {\\n \\"OperatorType\\": \\"Filter\\",\\n \\"TriggerConfig\\": {\\n \\"Field\\": \\"user_id\\",\\n \\"IsRandSort\\": false,\\n \\"SortField\\": \\"create_time\\",\\n \\"FieldQuantityLimit\\": 20\\n },\\n \\"FilterConfig\\": {\\n \\"Expression\\": \\"age>20\\"\\n },\\n \\"FeatureConfig\\": {\\n \\"Name\\": \\"age\\",\\n \\"Type\\": \\"STRING\\",\\n \\"Expression\\": \\"category=3\\"\\n },\\n \\"JoinConfig\\": {\\n \\"Field\\": \\"item_id\\",\\n \\"RecallManagementTableId\\": \\"3\\",\\n \\"OutputFields\\": [\\n \\"item_id\\"\\n ]\\n }\\n }\\n ],\\n \\"ExtendedConfig\\": \\"{\\\\\\"\\\\\\":\\\\\\"\\\\\\"}\\",\\n \\"ItemConditionArray\\": \\"[{\\\\\\"option\\\\\\":\\\\\\"<\\\\\\",\\\\\\"field\\\\\\":\\\\\\"category\\\\\\",\\\\\\"type\\\\\\":\\\\\\"STRING\\\\\\",\\\\\\"value\\\\\\":\\\\\\"10\\\\\\"}]\\",\\n \\"ItemConditionExpression\\": \\"age>20\\"\\n },\\n \\"MergeConfig\\": {\\n \\"RecallManagementServiceVersionConfigId\\": \\"1\\",\\n \\"MergeType\\": \\"Weight\\",\\n \\"FilterRecallManagementTableIds\\": [\\n \\"3\\"\\n ],\\n \\"ItemRecallManagementTableId\\": \\"2\\",\\n \\"ItemTableFields\\": [\\n \\"item_id\\"\\n ],\\n \\"FilterExpression\\": \\"age>20\\",\\n \\"ExtendedConfig\\": \\"{\\\\\\"\\\\\\":\\\\\\"\\\\\\"}\\"\\n },\\n \\"GmtCreateTime\\": \\"2021-12-15T23:24:33.132+08:00\\",\\n \\"GmtModifiedTime\\": \\"2021-12-15T23:24:33.132+08:00\\"\\n}","type":"json"}]', - 'title' => '获取召回管理服务版本配置', - 'description' => '## 请求说明'."\n" - .'通过指定召回管理服务ID、版本ID以及配置ID，可以获取到该召回服务版本的具体配置详情。请确保提供的参数值准确无误，特别是`InstanceId`，它对于定位正确的实例至关重要。'."\n" - ."\n" - .'- **注意**：所有路径参数（`RecallManagementServiceId`, `RecallManagementServiceVersionId`, `RecallManagementServiceVersionConfigId`）都是必需的，并且必须与实际存在的资源相匹配。'."\n" - .'- **扩展配置**：返回的数据中包含`ExtendedConfig`字段，用于未来功能扩展或自定义设置，请根据需要解析使用。'."\n", - ], - 'GetRecallManagementTable' => [ - 'summary' => '查询指定召回管理表的详细信息，包括表结构和配置等。', - 'path' => '/api/v1/recallmanagementtables/{RecallManagementTableId}', - 'methods' => [ - 'get', + 'flowControl' => [ + 'flowControlList' => [], ], - 'schemes' => [ - 'https', + 'ramActions' => [ + [ + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'pairec:CloneExperiment', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIRecService', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], ], + ], + 'CloneExperimentGroup' => [ + 'summary' => '向指定环境克隆一个实验组。', + 'path' => '/api/v1/experimentgroups/{ExperimentGroupId}/action/clone', + 'methods' => ['post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], - 'operationType' => 'read', + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'get', + 'operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATURElearnN0NAWV', - ], + 'abilityTreeNodes' => ['FEATURElearnN0NAWV'], ], 'parameters' => [ [ - 'name' => 'RecallManagementTableId', + 'name' => 'ExperimentGroupId', 'in' => 'path', - 'schema' => [ - 'description' => '数据表ID。'."\n", - 'type' => 'string', - 'required' => true, - 'example' => '3', - ], + 'schema' => ['title' => '实验组ID。', 'description' => '实验组ID，可通过接口ListExperimentGroups获取。', 'type' => 'string', 'required' => true, 'example' => '3'], ], [ - 'name' => 'InstanceId', - 'in' => 'query', + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', 'schema' => [ - 'description' => '实例ID。'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'pairec-cn-test123', + 'title' => '请求body。', + 'description' => '请求body。', + 'type' => 'object', + 'properties' => [ + 'InstanceId' => ['title' => '实例ID。', 'description' => '实例ID，可通过接口ListInstances获取。', 'type' => 'string', 'required' => true, 'example' => 'pairec-cn-abcdefg1234'."\n"], + 'LayerId' => ['title' => '层ID。', 'description' => '层ID，可通过接口ListLayers获取。', 'type' => 'string', 'required' => true, 'example' => '3'], + 'Environment' => ['title' => '克隆到的环境。'."\n" + .'● Daily-日常环境'."\n" + .'● Pre-预发环境'."\n" + .'● Prod-生产环境', 'description' => '克隆到的环境。'."\n" + .'● Daily-日常环境'."\n" + .'● Pre-预发环境'."\n" + .'● Prod-生产环境', 'type' => 'string', 'required' => true, 'example' => 'Daily'], + ], + 'required' => false, ], ], ], @@ -1713,312 +939,221 @@ 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => '请求id。'."\n", - 'type' => 'string', - 'example' => '728C5E01-ABF6-5AA8-B9FC-B3BA05DECC77', - ], - 'RecallManagementTableId' => [ - 'description' => '数据表ID。'."\n", - 'type' => 'string', - 'example' => '3', - ], - 'Name' => [ - 'description' => '数据表名。'."\n", - 'type' => 'string', - 'example' => 'table-123', - ], - 'Description' => [ - 'description' => '数据表备注。', - 'type' => 'string', - 'example' => 'this is a test', - ], - 'Type' => [ - 'description' => '表类型。', - 'type' => 'string', - 'example' => 'Recall', - ], - 'RecallType' => [ - 'description' => '表的召回类型。', - 'type' => 'string', - 'example' => 'X2I', - ], - 'DataSource' => [ - 'description' => '数据源。', - 'type' => 'string', - 'example' => 'Api', - ], - 'MaxcomputeProjectName' => [ - 'description' => 'maxcompute项目名。', - 'type' => 'string', - 'example' => 'test', - ], - 'MaxcomputeTableName' => [ - 'description' => 'maxcompute中表名。', - 'type' => 'string', - 'example' => 'table-1', - ], - 'CanDelete' => [ - 'description' => '表是否可以被删除。'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'IndexVersionId' => [ - 'description' => '索引版本Id。'."\n", - 'type' => 'string', - 'example' => '20250701', - ], - 'IndexEffectiveTime' => [ - 'description' => '索引生效时间'."\n", - 'type' => 'string', - 'example' => '2021-12-15T23:24:33.132+08:00', - ], - 'Config' => [ - 'description' => '表的一些额外配置'."\n", - 'type' => 'string', - 'example' => '{"item_id":""}', - ], - 'EnableRowCountFluctuationThreshold' => [ - 'description' => '是否启动表数据条目波动阈值'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'MinRowCountFluctuationThreshold' => [ - 'description' => '表数据条目波动阈值最小值'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '10', - ], - 'MaxRowCountFluctuationThreshold' => [ - 'description' => '表数据条目波动阈值最大值'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '100', - ], - 'EnableDataSizeFluctuationThreshold' => [ - 'description' => '是否启动表大小波动阈值'."\n", - 'type' => 'boolean', - 'example' => 'false', - ], - 'MinDataSizeFluctuationThreshold' => [ - 'description' => '表大小波动阈值最小值'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '10', - ], - 'MaxDataSizeFluctuationThreshold' => [ - 'description' => '表大小波动阈值最大值'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '100', - ], - 'GmtCreateTime' => [ - 'description' => '创建时间。', - 'type' => 'string', - 'example' => '2021-12-15T23:24:33.132+08:00', - ], - 'GmtModifiedTime' => [ - 'description' => '更新时间。'."\n", - 'type' => 'string', - 'example' => '2021-12-15T23:24:33.132+08:00', - ], - 'MaxcomputeSchema' => [ - 'description' => 'maxcompute schema。'."\n", - 'type' => 'string', - 'example' => 'default', - ], - 'PartitionFields' => [ - 'description' => '表的分区字段。', - 'type' => 'string', - 'example' => 'dt', - ], - 'Fields' => [ - 'description' => '字段列表。'."\n", - 'type' => 'array', - 'items' => [ - 'title' => '字段详情。', - 'description' => '字段详情。', - 'type' => 'object', - 'properties' => [ - 'Name' => [ - 'title' => '字段名称。', - 'description' => '字段名称。', - 'type' => 'string', - 'example' => 'age', - ], - 'Type' => [ - 'title' => '字段类型。', - 'description' => '字段类型。', - 'type' => 'string', - 'example' => 'STRING', - ], - 'Attributes' => [ - 'title' => '字段的属性列表。', - 'description' => '字段的属性列表。', - 'type' => 'array', - 'items' => [ - 'title' => '字段属性。', - 'description' => '字段属性。', - 'type' => 'string', - 'example' => 'Primary', - ], - ], - 'VectorDimension' => [ - 'title' => '向量维度。', - 'description' => '向量维度。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '32', - ], - 'VectorMetricType' => [ - 'title' => '向量指标类型。', - 'description' => '向量指标类型。', - 'type' => 'string', - 'example' => 'L2', - ], - ], - ], - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => '12A65C6C-AFA1-59B2-9A66-A9E0BB73F0E5'], + 'ExperimentGroupId' => ['title' => '克隆后的实验组ID。', 'description' => '克隆后的实验组ID。', 'type' => 'string', 'example' => '3'], ], ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"12A65C6C-AFA1-59B2-9A66-A9E0BB73F0E5\\",\\n \\"ExperimentGroupId\\": \\"3\\"\\n}","type":"json"}]', + 'title' => '克隆实验组', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'pairec:CloneExperimentGroup', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIRecService', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"728C5E01-ABF6-5AA8-B9FC-B3BA05DECC77\\",\\n \\"RecallManagementTableId\\": \\"3\\",\\n \\"Name\\": \\"table-123\\",\\n \\"Description\\": \\"this is a test\\",\\n \\"Type\\": \\"Recall\\",\\n \\"RecallType\\": \\"X2I\\",\\n \\"DataSource\\": \\"Api\\",\\n \\"MaxcomputeProjectName\\": \\"test\\",\\n \\"MaxcomputeTableName\\": \\"table-1\\",\\n \\"CanDelete\\": true,\\n \\"IndexVersionId\\": \\"20250701\\",\\n \\"IndexEffectiveTime\\": \\"2021-12-15T23:24:33.132+08:00\\",\\n \\"Config\\": \\"{\\\\\\"item_id\\\\\\":\\\\\\"\\\\\\"}\\",\\n \\"EnableRowCountFluctuationThreshold\\": true,\\n \\"MinRowCountFluctuationThreshold\\": 10,\\n \\"MaxRowCountFluctuationThreshold\\": 100,\\n \\"EnableDataSizeFluctuationThreshold\\": false,\\n \\"MinDataSizeFluctuationThreshold\\": 10,\\n \\"MaxDataSizeFluctuationThreshold\\": 100,\\n \\"GmtCreateTime\\": \\"2021-12-15T23:24:33.132+08:00\\",\\n \\"GmtModifiedTime\\": \\"2021-12-15T23:24:33.132+08:00\\",\\n \\"MaxcomputeSchema\\": \\"default\\",\\n \\"PartitionFields\\": \\"dt\\",\\n \\"Fields\\": [\\n {\\n \\"Name\\": \\"age\\",\\n \\"Type\\": \\"STRING\\",\\n \\"Attributes\\": [\\n \\"Primary\\"\\n ],\\n \\"VectorDimension\\": 32,\\n \\"VectorMetricType\\": \\"L2\\"\\n }\\n ]\\n}","type":"json"}]', - 'title' => '获取召回管理数据表详情', - 'description' => '## 请求说明'."\n" - .'本接口用于根据给定的数据表ID（`RecallManagementTableId`）和实例ID（`InstanceId`），获取召回管理表的详细信息。请确保在请求时正确提供这两个参数值。'."\n" - ."\n" - .'- **注意**：`CanDelete` 字段表示该表是否支持删除操作，请谨慎处理相关逻辑。'."\n" - .'- `Fields` 列表中包含了表内字段的具体定义，如名称、类型及属性等重要信息。'."\n" - .'- 表的波动阈值设置（行数与大小）可通过相应字段进行配置或查询，以监控数据变化情况。'."\n", ], - 'ListRecallManagementJobs' => [ - 'summary' => '查询指定条件下的召回管理任务列表。', - 'path' => '/api/v1/recallmanagementjobs', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'https', - ], + 'CloneFeatureConsistencyCheckJobConfig' => [ + 'summary' => '克隆特征一致性检查任务配置。', + 'path' => '/api/v1/featureconsistencycheck/jobconfigs/{SourceFeatureConsistencyCheckJobConfigId}/action/clone', + 'methods' => ['post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], - 'operationType' => 'read', + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'list', + 'operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATURElearnN0NAWV', - ], + 'abilityTreeNodes' => ['FEATURElearnN0NAWV'], ], 'parameters' => [ [ - 'name' => 'InstanceId', - 'in' => 'query', - 'schema' => [ - 'description' => '**实例 ID。**'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'pairec-test1', - ], + 'name' => 'SourceFeatureConsistencyCheckJobConfigId', + 'in' => 'path', + 'schema' => ['title' => '特征一致性检查配置ID。', 'description' => '特征一致性检查配置ID。如何获取配置ID，请参见[ListFeatureConsistencyCheckJobConfigs](~~2557567~~)。', 'type' => 'string', 'required' => true, 'example' => '3'], ], [ - 'name' => 'Type', - 'in' => 'query', + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', 'schema' => [ - 'description' => '**任务类型**'."\n", - 'type' => 'string', + 'description' => '请求Body。', + 'type' => 'object', + 'properties' => [ + 'InstanceId' => ['title' => '实例ID。', 'description' => '实例ID。如何获取实例ID，请参见[ListInstances](~~2411819~~)。', 'type' => 'string', 'required' => true, 'example' => 'pairec-cn-********'], + ], 'required' => false, - 'example' => 'Table', ], ], - [ - 'name' => 'Condition', - 'in' => 'query', - 'style' => 'flat', + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => '**过滤条件**，目前仅有Table类型的过滤条件，如：`{"RecallManagementTableId":"1"}`'."\n", + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', 'type' => 'object', - 'required' => false, - 'example' => '{"RecallManagementTableId":"1"}', + 'properties' => [ + 'RequestId' => ['title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => '74D958EF-3598-56FA-8296-FF1575CE43DF'], + 'FeatureConsistencyCheckId' => ['title' => '克隆后新的特征一致性检查配置ID。', 'description' => '克隆后新的特征一致性检查配置ID。', 'type' => 'string', 'example' => '4'], + ], ], ], - [ - 'name' => 'SortBy', - 'in' => 'query', - 'schema' => [ - 'description' => '**排序依据**。`GmtCreateTime`-创建时间。`GmtModifiedTime`-更新时间。'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'GmtCreateTime', + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"74D958EF-3598-56FA-8296-FF1575CE43DF\\",\\n \\"FeatureConsistencyCheckId\\": \\"4\\"\\n}","type":"json"}]', + 'title' => '克隆特征一致性检查任务配置', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'pairec:CloneFeatureConsistencyCheckJobConfig', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIRecService', 'resourceType' => '全部资源', 'arn' => '*'], + ], ], ], + ], + ], + 'CloneLaboratory' => [ + 'summary' => '将指定实验室克隆到指定环境，克隆时需指定是否克隆实验室下的实验组。', + 'path' => '/api/v1/laboratories/{LaboratoryId}/action/clone', + 'methods' => ['post'], + 'schemes' => ['http', 'https'], + 'security' => [ [ - 'name' => 'Order', - 'in' => 'query', - 'schema' => [ - 'description' => '**排序方式**。`ASC`-升序。`DESC`-降序。'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'ASC', - ], + 'AK' => [], + ], + ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATURElearnN0NAWV'], + ], + 'parameters' => [ + [ + 'name' => 'LaboratoryId', + 'in' => 'path', + 'schema' => ['title' => '实验室ID。', 'description' => '实验室ID，可通过接口ListLaboratories获取。', 'type' => 'string', 'required' => true, 'example' => '3'], ], [ - 'name' => 'PageNumber', - 'in' => 'query', + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', 'schema' => [ - 'description' => '**页码。**'."\n", - 'type' => 'integer', - 'format' => 'int32', + 'title' => '请求body。', + 'description' => '请求body。', + 'type' => 'object', + 'properties' => [ + 'InstanceId' => ['title' => '实例ID。', 'description' => '实例ID，可通过接口ListInstances获取。', 'type' => 'string', 'required' => true, 'example' => 'pairec-cn-abcdefg1234'], + 'Environment' => ['title' => '运行环境'."\n" + .'● Daily-日常环境'."\n" + .'● Pre-预发环境'."\n" + .'● Prod-生产环境', 'description' => '运行环境'."\n" + .'● Daily-日常环境'."\n" + .'● Pre-预发环境'."\n" + .'● Prod-生产环境', 'type' => 'string', 'required' => true, 'example' => 'Daily'], + 'CloneExperimentGroup' => ['title' => '是否克隆实验组。', 'description' => '是否克隆实验组。', 'type' => 'boolean', 'required' => true, 'example' => 'true'], + ], 'required' => false, - 'example' => '1', ], ], - [ - 'name' => 'PageSize', - 'in' => 'query', + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => '页大小。', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '10', + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => '01D22D08-BA20-5F35-8302-99115F288220'], + 'LaboratoryId' => ['title' => '克隆出的实验室的ID。', 'description' => '克隆出的实验室的ID。', 'type' => 'string', 'example' => '3'], + ], ], ], - [ - 'name' => 'MaxResults', - 'in' => 'query', - 'schema' => [ - 'description' => '暂不生效。', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '0', + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"01D22D08-BA20-5F35-8302-99115F288220\\",\\n \\"LaboratoryId\\": \\"3\\"\\n}","type":"json"}]', + 'title' => '克隆实验室', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'pairec:CloneLaboratory', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIRecService', 'resourceType' => '全部资源', 'arn' => '*'], + ], ], ], + ], + ], + 'CloneTrafficControlTask' => [ + 'path' => '/api/v1/trafficcontroltasks/{TrafficControlTaskId}/action/clone', + 'methods' => ['post'], + 'schemes' => ['http', 'https'], + 'security' => [ [ - 'name' => 'NextToken', - 'in' => 'query', + 'AK' => [], + ], + ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '220414', + 'abilityTreeNodes' => ['FEATURElearnN0NAWV'], + ], + 'parameters' => [ + [ + 'name' => 'TrafficControlTaskId', + 'in' => 'path', + 'schema' => ['description' => '流量调控 ID'."\n", 'type' => 'string', 'required' => false, 'example' => '1'], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', 'schema' => [ - 'description' => '暂不生效。', - 'type' => 'string', + 'description' => '请求Body', + 'type' => 'object', + 'properties' => [ + 'InstanceId' => ['description' => '实例ID。'."\n", 'type' => 'string', 'required' => false, 'example' => 'pairec_123****'], + ], 'required' => false, - 'example' => '""', ], ], ], @@ -2029,218 +1164,241 @@ 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => '请求id。', - 'type' => 'string', - 'example' => '728C5E01-ABF6-5AA8-B9FC-B3BA05DECC77', - ], - 'TotalCount' => [ - 'description' => '总个数。', - 'type' => 'string', - 'example' => '30', - ], - 'RecallManagementJobs' => [ - 'description' => '同步任务列表。'."\n", - 'type' => 'array', - 'items' => [ - 'description' => '同步任务详情。', - 'type' => 'object', - 'properties' => [ - 'RecallManagementJobId' => [ - 'description' => '同步任务ID。'."\n", - 'type' => 'string', - 'example' => '1', - ], - 'RecallManagerTableInfo' => [ - 'description' => '废弃。', - 'type' => 'object', - 'properties' => [ - 'RecallManagementTableVersionId' => [ - 'description' => '废弃。', - 'type' => 'string', - 'example' => '2', - ], - 'DataVersion' => [ - 'description' => '废弃。', - 'type' => 'string', - 'example' => 'ds=20250701', - ], - 'SourceTableRowCount' => [ - 'description' => '废弃。', - 'type' => 'string', - 'example' => '100', - ], - 'SourceTableDataSize' => [ - 'description' => '废弃。', - 'type' => 'string', - 'example' => '1000', - ], - ], - ], - 'Status' => [ - 'description' => '状态，枚举值：`Init`：初始化。`Running`：运行中`Success`：成功`Failed`：失败'."\n", - 'type' => 'string', - 'example' => 'Running', - ], - 'StartTime' => [ - 'description' => '任务开始时间。', - 'type' => 'string', - 'example' => '2025-01-28T10:00:00Z', - ], - 'EndTime' => [ - 'description' => '任务结束时间。', - 'type' => 'string', - 'example' => '2025-03-28T10:24Z', - ], - 'RecallManagementTableInfo' => [ - 'description' => '召回管理表任务信息。', - 'type' => 'object', - 'properties' => [ - 'RecallManagementTableVersionId' => [ - 'description' => '表版本 ID。', - 'type' => 'string', - 'example' => '2', - ], - 'DataVersion' => [ - 'description' => '数据版本号。', - 'type' => 'string', - 'example' => 'ds=20250701', - ], - 'SourceTableRowCount' => [ - 'description' => '源表数据行数。', - 'type' => 'string', - 'example' => '100', - ], - 'SourceTableDataSize' => [ - 'description' => '源表数据大小。', - 'type' => 'string', - 'example' => '100', - ], - ], - ], - ], - ], - ], - 'NextToken' => [ - 'description' => '暂不生效。', - 'type' => 'string', - 'example' => '""', - ], - 'MaxResults' => [ - 'description' => '暂不生效。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '0', - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => '请求id。'."\n", 'type' => 'string', 'example' => '728C5E01-ABF6-5AA8-B9FC-B3BA05DECC77'], + 'TrafficControlTaskId' => ['description' => '流量调控任务ID。'."\n", 'type' => 'string', 'example' => '3'], ], ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"728C5E01-ABF6-5AA8-B9FC-B3BA05DECC77\\",\\n \\"TotalCount\\": \\"30\\",\\n \\"RecallManagementJobs\\": [\\n {\\n \\"RecallManagementJobId\\": \\"1\\",\\n \\"RecallManagerTableInfo\\": {\\n \\"RecallManagementTableVersionId\\": \\"2\\",\\n \\"DataVersion\\": \\"ds=20250701\\",\\n \\"SourceTableRowCount\\": \\"100\\",\\n \\"SourceTableDataSize\\": \\"1000\\"\\n },\\n \\"Status\\": \\"Running\\",\\n \\"StartTime\\": \\"2025-01-28T10:00:00Z\\",\\n \\"EndTime\\": \\"2025-03-28T10:24Z\\",\\n \\"RecallManagementTableInfo\\": {\\n \\"RecallManagementTableVersionId\\": \\"2\\",\\n \\"DataVersion\\": \\"ds=20250701\\",\\n \\"SourceTableRowCount\\": \\"100\\",\\n \\"SourceTableDataSize\\": \\"100\\"\\n }\\n }\\n ],\\n \\"NextToken\\": \\"\\\\\\"\\\\\\"\\",\\n \\"MaxResults\\": 0\\n}","type":"json"}]', - 'title' => '获取召回管理任务列表', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '克隆流量调控任务', + 'summary' => '用于复制指定的流量调控任务到新的实例中。', 'description' => '## 请求说明'."\n" - .'- 本接口用于获取召回管理任务的列表信息。'."\n" - .'- `InstanceId` 和 `Type` 是必填参数，其他为可选参数。'."\n" - .'- `Condition` 参数支持对特定表类型的过滤条件进行设置，例如通过 `RecallManagementTableId` 进行筛选。'."\n" - .'- 可以使用 `SortBy` 和 `Order` 参数来控制返回结果的排序方式，默认按照创建时间升序排列。'."\n" - .'- 分页功能通过 `PageNumber` 和 `PageSize` 参数实现，其中 `PageNumber` 默认值为1，`PageSize` 默认值为10。'."\n" - .'- 返回的数据中包含每个召回管理任务的基本信息及其状态等详细内容。'."\n", - ], - 'ListRecallManagementServiceVersions' => [ - 'summary' => '获取指定召回管理服务下的所有版本信息。', - 'path' => '/api/v1/recallmanagementservices/{RecallManagementServiceId}/versions', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'https', + .'通过此API，您可以将一个已存在的流量调控任务克隆至另一个指定的实例下。请确保您提供的`InstanceId`是有效的，并且您对该实例具有相应的操作权限。'."\n" + ."\n" + .'注意：克隆过程中不会影响原任务的状态或配置。'."\n", + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"728C5E01-ABF6-5AA8-B9FC-B3BA05DECC77\\",\\n \\"TrafficControlTaskId\\": \\"3\\"\\n}","type":"json"}]', + ], + 'CreateABMetric' => [ + 'summary' => '创建AB实验指标。', + 'path' => '/api/v1/abmetrics', + 'methods' => ['post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], - 'operationType' => 'read', + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'none', + 'operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATURElearnN0NAWV', - ], + 'abilityTreeNodes' => ['FEATURElearnN0NAWV'], ], 'parameters' => [ [ - 'name' => 'RecallManagementServiceId', - 'in' => 'path', + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', 'schema' => [ - 'description' => '数据表ID。'."\n", - 'type' => 'string', + 'description' => '请求体参数。', + 'type' => 'object', + 'properties' => [ + 'Name' => ['description' => '指标名称。', 'type' => 'string', 'required' => true, 'example' => 'pv'], + 'Description' => ['description' => '指标描述。', 'type' => 'string', 'required' => true, 'example' => 'pv指标'], + 'SceneId' => ['description' => '场景ID，可通过接口[ListScenes](~~2402581~~)获取。', 'type' => 'string', 'required' => true, 'example' => '1'], + 'Type' => ['description' => '指标类型。'."\n" + ."\n" + .'- Single-单一指标。'."\n" + ."\n" + .'- Derived-衍生指标。', 'type' => 'string', 'required' => true, 'example' => 'Single'], + 'Realtime' => ['description' => '是否为实时指标。'."\n" + ."\n" + .'- true-是。'."\n" + ."\n" + .'- false-否。', 'type' => 'boolean', 'required' => true, 'example' => 'false'], + 'TableMetaId' => ['description' => '数据表ID，可通过ListTableMetas获取。', 'type' => 'string', 'required' => true, 'example' => '2'], + 'ResultResourceId' => ['description' => '写回数据表的数据源的ID，可以通过ListInstanceResources获取。', 'type' => 'string', 'required' => false, 'example' => '3'], + 'Definition' => ['description' => '指标定义。', 'type' => 'string', 'required' => true, 'example' => 'sum(click_cnt)'], + 'StatisticsCycle' => ['description' => '统计周期。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1'], + 'LeftMetricId' => ['description' => '衍生指标的左指标ID。', 'type' => 'string', 'required' => false, 'example' => '2'], + 'RightMetricId' => ['description' => '衍生指标的右指标ID。', 'type' => 'string', 'required' => false, 'example' => '3'], + 'Operator' => ['description' => '衍生指标计算的操作符。'."\n" + ."\n" + .'- Plus-加'."\n" + ."\n" + .'- Minus-减'."\n" + ."\n" + .'- Multiplication-乘'."\n" + ."\n" + .'- Division-除', 'type' => 'string', 'required' => false, 'example' => 'Division'], + 'InstanceId' => ['description' => '实例ID，可从接口[ListInstances](~~2411819~~)获取。', 'type' => 'string', 'required' => true, 'example' => 'pairec-cn-test1'], + 'NeedSignificance' => ['title' => '是否计算显著性。', 'type' => 'boolean'], + 'AggregationByUser' => ['title' => '计算显著性时，是否按照用户维度来计算。一共有两种逻辑，一种是按用户，一种是按样本。', 'type' => 'boolean'], + 'Numerator' => ['title' => '当进行显著性计算时，计算的分子。', 'type' => 'string', 'example' => 'click'], + 'Denominator' => ['title' => '当进行显著性计算时，计算的分母。', 'type' => 'string', 'example' => 'pv'], + 'IsBinomialDistribution' => ['title' => '当指标类型是衍生指标时，当前指标是否符合二项分布，是的话会二项式分布计算指标的均值和方差。', 'type' => 'boolean'], + ], 'required' => false, - 'example' => '3', ], ], - [ - 'name' => 'InstanceId', - 'in' => 'query', + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => '实例ID。'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'pairec-cn-test123', + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => 'F7AC05FF-EDE7-5C2B-B9AE-33D6DF4178BA'], + 'ABMetricId' => ['description' => 'AB指标ID。', 'type' => 'string', 'example' => '1'], + ], ], ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '创建AB指标', + 'changeSet' => [ + ['createdAt' => '2024-02-22T03:35:42.000Z', 'description' => '请求参数发生变更'], + ], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ [ - 'name' => 'PageNumber', - 'in' => 'query', - 'schema' => [ - 'description' => '页码。'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '1', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'pairec:CreateABMetric', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIRecService', 'resourceType' => '全部资源', 'arn' => '*'], + ], ], ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"F7AC05FF-EDE7-5C2B-B9AE-33D6DF4178BA\\",\\n \\"ABMetricId\\": \\"1\\"\\n}","type":"json"}]', + ], + 'CreateABMetricGroup' => [ + 'summary' => '创建AB实验指标组。', + 'path' => '/api/v1/abmetricgroups', + 'methods' => ['post'], + 'schemes' => ['http', 'https'], + 'security' => [ [ - 'name' => 'PageSize', - 'in' => 'query', + 'AK' => [], + ], + ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATURElearnN0NAWV'], + ], + 'parameters' => [ + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', 'schema' => [ - 'description' => '页大小。'."\n", - 'type' => 'integer', - 'format' => 'int64', + 'description' => '请求体参数。', + 'type' => 'object', + 'properties' => [ + 'Name' => ['description' => '指标组名称。', 'type' => 'string', 'required' => true, 'example' => 'visits'], + 'SceneId' => ['description' => '场景ID，可通过接口[ListScenes](~~2402581~~)获取。', 'type' => 'string', 'required' => true, 'example' => '1'], + 'Description' => ['description' => '指标组描述。', 'type' => 'string', 'required' => true, 'example' => '访问量相关指标'], + 'ABMetricIds' => ['description' => 'AB实验指标ID列表，逗号分隔。', 'type' => 'string', 'required' => true, 'example' => '1,2'], + 'InstanceId' => ['description' => '实例ID，可通过接口[ListInstances](~~2411819~~)获取。', 'type' => 'string', 'required' => true, 'example' => 'pairec-cn-test1'], + 'Realtime' => ['description' => '是否为实时指标组。', 'type' => 'boolean', 'required' => true, 'example' => 'false'], + ], 'required' => false, - 'example' => '50', ], ], - [ - 'name' => 'SortBy', - 'in' => 'query', + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => '排序依据。GmtCreateTime-创建时间。GmtModifiedTime-更新时间。'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'GmtCreateTime', + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => 'E15A1443-7917-5BE0-AE70-25538ECF398D'], + 'ABMetricGroupId' => ['description' => '指标组ID。', 'type' => 'string', 'example' => '1'], + ], ], ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"E15A1443-7917-5BE0-AE70-25538ECF398D\\",\\n \\"ABMetricGroupId\\": \\"1\\"\\n}","type":"json"}]', + 'title' => '创建指标组', + 'changeSet' => [ + ['createdAt' => '2024-02-22T03:35:41.000Z', 'description' => '请求参数发生变更'], + ], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ [ - 'name' => 'Order', - 'in' => 'query', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'pairec:CreateABMetricGroup', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIRecService', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + ], + ], + 'CreateCalculationJobs' => [ + 'summary' => '批量创建计算任务。', + 'path' => '/api/v1/batch/calculationjobs/create', + 'methods' => ['post'], + 'schemes' => ['http', 'https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATURElearnN0NAWV'], + ], + 'parameters' => [ + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', 'schema' => [ - 'description' => '排序方式。ASC-升序。DESC-降序。'."\n", - 'type' => 'string', + 'description' => '请求体参数。', + 'type' => 'object', + 'properties' => [ + 'ABMetricIds' => ['description' => 'AB实验指标ID列表，使用逗号分隔。', 'type' => 'string', 'required' => true, 'example' => '2,3,4'], + 'StartDate' => ['description' => '开始日期。', 'type' => 'string', 'required' => true, 'example' => '2023-01-01'], + 'EndDate' => ['description' => '结束日期。', 'type' => 'string', 'required' => true, 'example' => '2023-01-03'], + 'InstanceId' => ['description' => '实例ID，可从接口[ListInstances](~~2411819~~)获取。', 'type' => 'string', 'required' => true, 'example' => 'pairec-cn-test1'], + ], 'required' => false, - 'example' => 'ASC', ], ], ], @@ -2251,174 +1409,251 @@ 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => '请求id。'."\n", - 'type' => 'string', - 'example' => '728C5E01-ABF6-5AA8-B9FC-B3BA05DECC77', - ], - 'TotalCount' => [ - 'description' => '返回总个数。', - 'type' => 'string', - 'example' => '30', - ], - 'RecallManagementServiceVersions' => [ - 'description' => '召回管理服务版本列表。', + 'RequestId' => ['title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => '8C27790E-CCA5-56BB-BA17-646295DEC0A2'], + 'CalculationJobIds' => [ + 'description' => '计算任务ID列表。', 'type' => 'array', - 'items' => [ - 'description' => '召回管理服务版本详情。', - 'type' => 'object', - 'properties' => [ - 'RecallManagementServiceVersionId' => [ - 'description' => '召回管理服务版本ID。', - 'type' => 'string', - 'example' => '1', - ], - 'Name' => [ - 'description' => '召回管理服务版本名称。'."\n", - 'type' => 'string', - 'example' => 'version-1', - ], - 'IsDefault' => [ - 'description' => '当前版本是否绑定召回管理服务并生效。', - 'type' => 'string', - 'example' => 'false', - ], - 'GmtCreateTime' => [ - 'description' => '创建时间。'."\n", - 'type' => 'string', - 'example' => '2021-12-15T23:24:33.132+08:00', - ], - 'GmtModifiedTime' => [ - 'description' => '更新时间。'."\n", - 'type' => 'string', - 'example' => '2021-12-15T23:24:33.132+08:00', - ], - ], - ], + 'items' => ['description' => 'ID列表。', 'type' => 'string', 'example' => '["12","13","14"]'], ], ], ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"8C27790E-CCA5-56BB-BA17-646295DEC0A2\\",\\n \\"CalculationJobIds\\": [\\n \\"[\\\\\\"12\\\\\\",\\\\\\"13\\\\\\",\\\\\\"14\\\\\\"]\\"\\n ]\\n}","type":"json"}]', + 'title' => '创建计算任务', + 'changeSet' => [ + ['createdAt' => '2024-02-22T03:35:41.000Z', 'description' => '请求参数发生变更'], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"728C5E01-ABF6-5AA8-B9FC-B3BA05DECC77\\",\\n \\"TotalCount\\": \\"30\\",\\n \\"RecallManagementServiceVersions\\": [\\n {\\n \\"RecallManagementServiceVersionId\\": \\"1\\",\\n \\"Name\\": \\"version-1\\",\\n \\"IsDefault\\": \\"false\\",\\n \\"GmtCreateTime\\": \\"2021-12-15T23:24:33.132+08:00\\",\\n \\"GmtModifiedTime\\": \\"2021-12-15T23:24:33.132+08:00\\"\\n }\\n ]\\n}","type":"json"}]', - 'title' => '召回管理服务版本列表', - 'description' => '## 请求说明'."\n" - .'通过此API，您可以查询特定召回管理服务的所有版本详情，包括版本ID、名称、是否生效状态以及创建和修改时间等信息。请确保提供正确的`RecallManagementServiceId`与`InstanceId`以获取准确的数据。'."\n" - ."\n" - .'- `PageNumber` 和 `PageSize` 参数用于分页控制，默认从第一页开始，每页显示50条记录。'."\n" - .'- 使用 `SortBy` 参数可按创建时间或更新时间对结果进行排序，默认按照创建时间升序排列。'."\n" - .'- `Order` 参数定义了排序方式，支持升序（ASC）和降序（DESC）两种模式。'."\n", - ], - 'ListRecallManagementServices' => [ - 'summary' => '此API用于查询指定实例下的召回管理服务列表。', - 'path' => '/api/v1/recallmanagementservices', - 'methods' => [ - 'get', + 'flowControl' => [ + 'flowControlList' => [], ], - 'schemes' => [ - 'https', + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'pairec:CreateCalculationJobs', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIRecService', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], ], + ], + 'CreateCrowd' => [ + 'summary' => '创建一个人群，用于表示用户群体。', + 'path' => '/api/v1/crowds', + 'methods' => ['post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], - 'operationType' => 'read', + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'list', + 'operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATURElearnN0NAWV', - ], + 'abilityTreeNodes' => ['FEATURElearnN0NAWV'], ], 'parameters' => [ [ - 'name' => 'InstanceId', - 'in' => 'query', + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', 'schema' => [ - 'description' => '**实例ID。**'."\n", - 'type' => 'string', + 'title' => '请求body。', + 'description' => '请求body。', + 'type' => 'object', + 'properties' => [ + 'InstanceId' => ['title' => '实例ID。', 'description' => '实例ID，可通过接口ListInstances获取。', 'type' => 'string', 'required' => true, 'example' => 'pairec-cn-abcdefg1234'], + 'Name' => ['title' => '人群名称。', 'description' => '人群名称。', 'type' => 'string', 'required' => true, 'example' => 'xx人群'], + 'Description' => ['title' => '人群描述。', 'description' => '人群描述。', 'type' => 'string', 'required' => true, 'example' => 'This is a test.'], + 'Label' => ['title' => '人群标签。', 'description' => '人群标签。', 'type' => 'string', 'required' => false, 'example' => 'os=android'], + 'Source' => ['title' => '人群来源。'."\n" + .'● ManualInput-手工输入'."\n" + .'● UploadFile-文件上传', 'description' => '人群来源。'."\n" + .'● ManualInput-手工输入'."\n" + .'● UploadFile-文件上传', 'type' => 'string', 'required' => false, 'example' => 'ManualInput'], + 'Users' => ['title' => '人群中包含的用户，多个用户间用逗号隔开。', 'description' => '人群中包含的用户，多个用户间用逗号隔开。', 'type' => 'string', 'required' => false, 'example' => 'user1,user2,user3'], + ], 'required' => false, - 'example' => 'pairec-cn-test123', ], ], - [ - 'name' => 'PageNumber', - 'in' => 'query', + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => '**页码。**'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '1', + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => '59CE7EC6-F268-5D71-9215-32922CC50D72'], + 'CrowdId' => ['title' => '人群ID。', 'description' => '人群ID。', 'type' => 'string', 'example' => '3'], + ], ], ], - [ - 'name' => 'PageSize', - 'in' => 'query', - 'schema' => [ - 'description' => '**页大小。**'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '50', + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"59CE7EC6-F268-5D71-9215-32922CC50D72\\",\\n \\"CrowdId\\": \\"3\\"\\n}","type":"json"}]', + 'title' => '创建人群', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'pairec:CreateCrowd', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIRecService', 'resourceType' => '全部资源', 'arn' => '*'], + ], ], ], + ], + ], + 'CreateDataDiagnosis' => [ + 'path' => '/api/v1/datadiagnoses', + 'methods' => ['post'], + 'schemes' => ['http', 'https'], + 'security' => [ [ - 'name' => 'SortBy', - 'in' => 'query', - 'schema' => [ - 'description' => '**排序依据。** '."\n" - .'- GmtCreateTime-创建时间。'."\n" - .'- GmtModifiedTime-更新时间。'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'GmtCreateTime', - ], + 'AK' => [], ], + ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATURElearnN0NAWV'], + ], + 'parameters' => [ [ - 'name' => 'Order', - 'in' => 'query', + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', 'schema' => [ - 'description' => '**排序方式。** '."\n" - .'- ASC-升序。'."\n" - .'- DESC-降序。'."\n", - 'type' => 'string', + 'description' => '请求Body。', + 'type' => 'object', + 'properties' => [ + 'InstanceId' => ['description' => '实例ID。', 'type' => 'string', 'required' => true, 'example' => 'learn-pairec-xxx'], + 'Name' => ['description' => '数据诊断任务配置名称。', 'type' => 'string', 'required' => true, 'example' => 'data_diagnosis_job1'], + 'Type' => [ + 'description' => '数据诊断任务类型，枚举值：'."\n" + ."\n" + .'- ChangeRate：物品/用户变化率分析。'."\n" + .' '."\n" + .'- PreferenceStatisticsCycle：用户偏好统计周期分析。'."\n" + .' '."\n" + .'- JoinTables：两表关联分析。'."\n" + .' '."\n" + .'- BaseStatistics：基础统计分析。'."\n" + .' '."\n" + .'- AbnormalBehavior：异常行为分析。', + 'type' => 'string', + 'required' => true, + 'enumValueTitles' => ['AbnormalBehavior' => 'AbnormalBehavior', 'JoinTables' => 'JoinTables', 'PreferenceStatisticsCycle' => 'PreferenceStatisticsCycle', 'BaseStatistics' => 'BaseStatistics', 'ChangeRate' => 'ChangeRate'], + 'example' => 'ChangeRate', + ], + 'TableMetaId' => ['description' => '数据表ID。', 'type' => 'string', 'required' => false, 'example' => '3'], + 'LeftTableMetaId' => ['description' => '左数据表ID。', 'type' => 'string', 'required' => false, 'example' => '4'], + 'RightTableMetaId' => ['description' => '右数据表ID。'."\n", 'type' => 'string', 'required' => false, 'example' => '5'], + 'PartitionField' => ['description' => '分区字段。'."\n", 'type' => 'string', 'required' => false, 'example' => 'dt'], + 'LeftTablePartitionField' => ['description' => '左表分区字段。'."\n", 'type' => 'string', 'required' => false, 'example' => 'dt'], + 'RightTablePartitionField' => ['description' => '右表分区字段。'."\n", 'type' => 'string', 'required' => false, 'example' => 'dt'], + 'Config' => ['description' => '数据诊断任务配置内容。'."\n" + ."\n" + .'- 若Type=ChangeRate，则需包含：分析字段（AnalysisField）、分区字段格式（PartitionFieldFormat）。'."\n" + ."\n" + .'- 若Type=PreferenceStatisticsCycle，则需包含：用户ID字段（UserIdField）、单日留存率统计周期（RemainDays）、曾现率统计周期（EverAppearedDays）、周期留存率统计周期（RemainRatePeriods）、分区字段格式（PartitionFieldFormat）。'."\n" + ."\n" + .'- 若Type=JoinTables，则需包含左表分析字段（LeftTableAnalysisField)、右表分析字段（RightTableAnalysisField)、左表JOIN字段（LeftJoinField）、右表JOIN字段（RightJoinField）、展示用抽样数量（SampleQuantity）、左表分区字段格式（LeftTablePartitionFieldFormat）、右表分区字段格式（RightTablePartitionFieldFormat）。'."\n" + ."\n" + .'- 若Type=BaseStatistics，则需包含：Tag字段（TagField）、Tag字段分隔符(TagFieldSeparator)、kv字段(KVField)、kv字段分隔符(KVFieldSeparator)、kv对分隔符(KVPairSeparator)、Text字段（TextField）、数据百分位分布（Quantiles）、字符串类型默认值（DefaultValueOfString）、字符串类型空值字段（NullStringField）、分区字段格式（PartitionFieldFormat）。'."\n" + ."\n" + .'- 若Type=AbnormalBehavior，则需包含：用户ID字段（UserId）、物品ID字段（ItemId）、行为字段(EventField)、上游行为取值(UpStreamBehavior)、下游行为取值(DownstreamBehavior)、分桶数量(NumericHistogramBins)、分区字段格式（PartitionFieldFormat）。', 'type' => 'string', 'required' => true, 'example' => '{ "AnalysisField": "userid", "PartitionFieldFormat": "yyyymmdd" }'], + 'CycleTime' => ['description' => '周期运行时间（若该字段为空，则不进行周期运行）。'."\n", 'type' => 'string', 'required' => false, 'example' => '08:00'], + 'TopNQuantity' => ['description' => 'topN数量。'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '10'], + ], 'required' => false, - 'example' => 'ASC', ], ], - [ - 'name' => 'MaxResults', - 'in' => 'query', + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => '暂不生效。', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '""', + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['title' => 'Id of the request', 'description' => '请求ID。'."\n", 'type' => 'string', 'example' => '728C5E01-ABF6-5AA8-B9FC-B3BA05DECC77'], + 'DataDiagnosisId' => ['description' => '数据诊断配置ID。'."\n", 'type' => 'string', 'example' => '1'], + ], ], ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '创建数据诊断任务', + 'summary' => '用于创建不同类型的数据诊断任务，支持多种分析类型。', + 'description' => '## 请求说明'."\n" + .'- 本API用于创建数据诊断任务，支持物品/用户变化率分析、用户偏好统计周期分析、两表关联分析、基础统计分析及异常行为分析等多种类型。'."\n" + .'- `Config`字段的内容根据`Type`的不同而有所区别，请参考文档中的示例配置正确填写。'."\n" + .'- 如果需要周期性运行该任务，请设置`CycleTime`字段；若不设置，则任务不会周期性执行。'."\n" + .'- `TopNQuantity`字段用于指定返回结果中展示的top N数量，默认可选。'."\n", + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"728C5E01-ABF6-5AA8-B9FC-B3BA05DECC77\\",\\n \\"DataDiagnosisId\\": \\"1\\"\\n}","type":"json"}]', + ], + 'CreateDataDiagnosisJobs' => [ + 'path' => '/api/v1/batch/datadiagnosisjobs/create', + 'methods' => ['post'], + 'schemes' => ['http', 'https'], + 'security' => [ [ - 'name' => 'NextToken', - 'in' => 'query', + 'AK' => [], + ], + ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATURElearnN0NAWV'], + ], + 'parameters' => [ + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', 'schema' => [ - 'description' => '暂不生效。', - 'type' => 'string', + 'description' => '请求Body。', + 'type' => 'object', + 'properties' => [ + 'DataDiagnosisId' => ['description' => '数据诊断ID。'."\n", 'type' => 'string', 'required' => true, 'example' => '3'], + 'InstanceId' => ['description' => '实例ID。'."\n", 'type' => 'string', 'required' => true, 'example' => 'learn-pairec-xxx'], + 'StartDate' => ['description' => '开始日期。'."\n", 'type' => 'string', 'required' => true, 'example' => '2022-01-01'], + 'EndDate' => ['description' => '结束日期。'."\n", 'type' => 'string', 'required' => true, 'example' => '2022-02-01'], + ], 'required' => false, - 'example' => '0', ], ], ], @@ -2429,218 +1664,246 @@ 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => '请求id。'."\n", - 'type' => 'string', - 'example' => '728C5E01-ABF6-5AA8-B9FC-B3BA05DECC77', - ], - 'TotalCount' => [ - 'description' => '总个数。'."\n", - 'type' => 'string', - 'example' => '10', - ], - 'RecallManagementServices' => [ - 'description' => '召回管理服务列表。', + 'RequestId' => ['title' => 'Id of the request', 'description' => '请求ID。'."\n", 'type' => 'string', 'example' => '728C5E01-ABF6-5AA8-B9FC-B3BA05DECC77'], + 'DataDiagnosisJobIds' => [ + 'description' => '数据诊断任务ID列表。'."\n", 'type' => 'array', - 'items' => [ - 'description' => '召回管理服务详情。', - 'type' => 'object', - 'properties' => [ - 'RecallManagementServiceId' => [ - 'description' => '召回管理服务ID。'."\n", - 'type' => 'string', - 'example' => '3', - ], - 'Name' => [ - 'description' => '召回管理服务名称。'."\n", - 'type' => 'string', - 'example' => 'hot_group_recall', - ], - 'Description' => [ - 'description' => '召回管理服务描述。'."\n", - 'type' => 'string', - 'example' => 'this is a test recall', - ], - 'CurrentRecallManagementServiceVersionId' => [ - 'description' => '当前生效的召回管理服务版本ID。'."\n", - 'type' => 'string', - 'example' => '1', - ], - 'CurrentRecallManagementServiceVersionName' => [ - 'description' => '当前生效的召回管理服务版本名称。'."\n", - 'type' => 'string', - 'example' => 'version-1', - ], - 'Status' => [ - 'description' => '状态，枚举值：'."\n" - .'- Online：在线。'."\n" - .'- Offline：离线。'."\n", - 'type' => 'string', - 'example' => 'Online', - ], - 'GmtCreateTime' => [ - 'description' => '创建时间。'."\n", - 'type' => 'string', - 'example' => '2021-12-15T23:24:33.132+08:00', - ], - 'GmtModifiedTime' => [ - 'description' => '更新时间。'."\n", - 'type' => 'string', - 'example' => '2021-12-15T23:24:33.132+08:00', - ], - ], - ], - ], - 'NextToken' => [ - 'description' => '暂不生效。', - 'type' => 'string', - 'example' => '""', - ], - 'MaxResults' => [ - 'description' => '暂不生效。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '0', + 'items' => ['description' => '数据诊断任务ID。', 'type' => 'string', 'example' => '1'], ], ], ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"728C5E01-ABF6-5AA8-B9FC-B3BA05DECC77\\",\\n \\"TotalCount\\": \\"10\\",\\n \\"RecallManagementServices\\": [\\n {\\n \\"RecallManagementServiceId\\": \\"3\\",\\n \\"Name\\": \\"hot_group_recall\\",\\n \\"Description\\": \\"this is a test recall\\",\\n \\"CurrentRecallManagementServiceVersionId\\": \\"1\\",\\n \\"CurrentRecallManagementServiceVersionName\\": \\"version-1\\",\\n \\"Status\\": \\"Online\\",\\n \\"GmtCreateTime\\": \\"2021-12-15T23:24:33.132+08:00\\",\\n \\"GmtModifiedTime\\": \\"2021-12-15T23:24:33.132+08:00\\"\\n }\\n ],\\n \\"NextToken\\": \\"\\\\\\"\\\\\\"\\",\\n \\"MaxResults\\": 0\\n}","type":"json"}]', - 'title' => '获取召回管理服务列表', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '创建数据诊断任务', + 'summary' => '用于创建指定时间段内的数据诊断（重跑）任务。', 'description' => '## 请求说明'."\n" - .'通过调用`ListRecallManagementServices`接口，您可以根据给定的参数（如InstanceId, PageNumber, PageSize等）来获取特定实例下的召回管理服务列表。支持按照创建时间或更新时间进行排序，并且可以选择升序或降序展示结果。'."\n" - ."\n" - .'- **InstanceId** 是必填项，用来指定要查询的服务属于哪个实例。'."\n" - .'- 分页参数**PageNumber**和**PageSize**允许您控制返回数据的数量及从哪一页开始显示，默认情况下会返回第一页的数据。'."\n" - .'- 使用**SortBy**与**Order**参数可以自定义列表的排序方式。'."\n", - ], - 'ListRecallManagementTables' => [ - 'summary' => '查询指定实例下的召回管理表信息，支持分页和排序。', - 'path' => '/api/v1/recallmanagementtables', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'https', + .'通过调用此API，您可以为特定实例在给定的时间范围内启动一个新的数据诊断任务。请确保提供的`DataDiagnosisId`, `InstanceId`, `StartDate`和`EndDate`参数值准确无误，以保证任务能够正确执行。'."\n", + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"728C5E01-ABF6-5AA8-B9FC-B3BA05DECC77\\",\\n \\"DataDiagnosisJobIds\\": [\\n \\"1\\"\\n ]\\n}","type":"json"}]', + ], + 'CreateEngineConfig' => [ + 'summary' => '创建引擎配置。', + 'path' => '/api/v1/engineconfigs', + 'methods' => ['post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], - 'operationType' => 'read', + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'list', + 'operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATURElearnN0NAWV', - ], + 'abilityTreeCode' => '180238', + 'abilityTreeNodes' => ['FEATURElearnN0NAWV'], ], 'parameters' => [ [ - 'name' => 'InstanceId', - 'in' => 'query', + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', 'schema' => [ - 'description' => '实例ID。'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'pairec-cn-test123', + 'description' => '请求body。', + 'type' => 'object', + 'properties' => [ + 'Name' => ['description' => '引擎配置名称。', 'type' => 'string', 'required' => false, 'example' => 'engine_config_v1'], + 'ConfigValue' => ['description' => '引擎配置的内容。', 'type' => 'string', 'required' => false, 'example' => '{}'], + 'Environment' => ['description' => '运行环境。'."\n" + ."\n" + .'- Daily：日常环境。'."\n" + ."\n" + .'- Pre：预发环境。'."\n" + ."\n" + .'- Prod：生产环境。', 'type' => 'string', 'required' => false, 'example' => 'Pre'], + 'InstanceId' => ['description' => '实例ID，可从接口[ListInstances](~~2411819~~)获取。', 'type' => 'string', 'required' => false, 'example' => 'pairec-cn-***test'], + 'Description' => ['type' => 'string', 'required' => false, 'description' => ''], + ], + 'required' => false, ], ], - [ - 'name' => 'Name', - 'in' => 'query', + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => '表名称。'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'table-1', + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => 'E15A1443-7917-5BE0-AE70-25538ECF398D'], + 'EngineConfigId' => ['description' => '引擎配置ID。', 'type' => 'string', 'example' => '1'], + ], ], ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"E15A1443-7917-5BE0-AE70-25538ECF398D\\",\\n \\"EngineConfigId\\": \\"1\\"\\n}","type":"json"}]', + 'title' => '创建引擎配置', + 'changeSet' => [ + ['createdAt' => '2024-12-27T08:56:39.000Z', 'description' => '请求参数发生变更'], + ], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ [ - 'name' => 'Type', - 'in' => 'query', - 'schema' => [ - 'description' => '表类型，枚举值：`X2I`：U2I 召回或 I2I 召回；`Vector`：向量召回；`Ramdom`：随机召回'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'X2I', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'pairec:CreateEngineConfig', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIRecService', 'resourceType' => '全部资源', 'arn' => '*'], + ], ], ], + ], + ], + 'CreateExperiment' => [ + 'summary' => '在指定实验组下创建一个实验。', + 'path' => '/api/v1/experiments', + 'methods' => ['post'], + 'schemes' => ['http', 'https'], + 'security' => [ [ - 'name' => 'PageNumber', - 'in' => 'query', - 'schema' => [ - 'description' => '页码。'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', - ], + 'AK' => [], ], + ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATURElearnN0NAWV'], + ], + 'parameters' => [ [ - 'name' => 'PageSize', - 'in' => 'query', + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', 'schema' => [ - 'description' => '页大小。'."\n", - 'type' => 'integer', - 'format' => 'int32', + 'description' => '请求body。', + 'type' => 'object', + 'properties' => [ + 'InstanceId' => ['title' => '实例ID。', 'description' => '实例ID，可通过接口ListInstances获取。', 'type' => 'string', 'required' => true, 'example' => 'pairec-test1'], + 'ExperimentGroupId' => ['title' => '实验组ID。', 'description' => '实验组ID，可通过接口ListExperimentGroups获取。', 'type' => 'string', 'required' => true, 'example' => '3'], + 'Name' => ['title' => '实验名称。', 'description' => '实验名称。', 'type' => 'string', 'required' => true, 'example' => 'experiment_test'], + 'Description' => ['title' => '实验描述。', 'description' => '实验描述。', 'type' => 'string', 'required' => true, 'example' => 'This is a test.'], + 'Type' => ['title' => '实验类型。'."\n" + .'● Baseline-基准实验。'."\n" + .'● Normal-普通实验。', 'description' => '实验类型。'."\n" + .'● Baseline-基准实验。'."\n" + .'● Normal-普通实验。', 'type' => 'string', 'required' => true, 'example' => 'Baseline'], + 'FlowPercent' => ['title' => '流量分配百分比。', 'description' => '流量分配百分比。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '100'], + 'DebugUsers' => ['title' => '调试用户。', 'description' => '调试用户（需为阿里云账户主账号/子账号uid），多个用户需通过逗号作间隔。', 'type' => 'string', 'required' => false, 'example' => '1124512470******,1124512471******,1124512472******'], + 'DebugCrowdId' => ['title' => '调试人群ID。', 'description' => '调试人群ID，可通过接口ListCrowds获取。', 'type' => 'string', 'required' => false, 'example' => '3'], + 'Config' => ['title' => '实验配置。', 'description' => '实验配置。', 'type' => 'string', 'required' => false, 'example' => '{"RankBy": "Score"}'], + ], 'required' => false, - 'example' => '10', ], ], - [ - 'name' => 'SortBy', - 'in' => 'query', + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => '排序依据。`GmtCreateTime`-创建时间。`GmtModifiedTime`-更新时间。'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'GmtCreateTime', + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => '3AAA45F6-0798-5461-9360-81D133823CE7'], + 'ExperimentId' => ['title' => '实验ID。', 'description' => '实验ID。', 'type' => 'string', 'example' => '3'], + ], ], ], - [ - 'name' => 'Order', - 'in' => 'query', - 'schema' => [ - 'description' => '排序方式。ASC-升序。DESC-降序。'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'ASC', + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"3AAA45F6-0798-5461-9360-81D133823CE7\\",\\n \\"ExperimentId\\": \\"3\\"\\n}","type":"json"}]', + 'title' => '创建实验', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'pairec:CreateExperiment', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIRecService', 'resourceType' => '全部资源', 'arn' => '*'], + ], ], ], + ], + ], + 'CreateExperimentGroup' => [ + 'path' => '/api/v1/experimentgroups', + 'methods' => ['post'], + 'schemes' => ['http', 'https'], + 'security' => [ [ - 'name' => 'NextToken', - 'in' => 'query', - 'schema' => [ - 'description' => '暂不生效。', - 'type' => 'string', - 'required' => false, - 'example' => '""', - ], + 'AK' => [], ], + ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '183389', + 'abilityTreeNodes' => ['FEATURElearnN0NAWV'], + ], + 'parameters' => [ [ - 'name' => 'MaxResults', - 'in' => 'query', + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', 'schema' => [ - 'description' => '暂不生效。', - 'type' => 'integer', - 'format' => 'int32', + 'title' => '请求body。', + 'description' => '请求body。', + 'type' => 'object', + 'properties' => [ + 'LayerId' => ['title' => '层ID。', 'description' => '层ID，可通过接口ListLayers获取。', 'type' => 'string', 'required' => true, 'example' => '3'], + 'Name' => ['title' => '实验组名称。', 'description' => '实验组名称。', 'type' => 'string', 'required' => true, 'example' => 'experiment_group_test'], + 'Description' => ['title' => '实验组描述。', 'description' => '实验组描述。', 'type' => 'string', 'required' => false, 'example' => 'This is a test.'], + 'DebugUsers' => ['title' => '调试用户。', 'description' => '调试用户（需为阿里云账户主账号/子账号uid），多个用户需通过逗号作间隔。', 'type' => 'string', 'required' => false, 'example' => '1124512470******,1124512471******,1124512472******'], + 'DebugCrowdId' => ['title' => '调试人群ID。', 'description' => '调试人群ID，可通过接口ListCrowds获取。', 'type' => 'string', 'required' => false, 'example' => '3'], + 'NeedAA' => ['title' => '是否需要AA实验组。', 'description' => '是否需要AA实验组。', 'type' => 'boolean', 'required' => true, 'example' => 'true'], + 'Filter' => ['title' => '人群定向指定的过滤条件。', 'description' => '人群定向指定的过滤条件。', 'type' => 'string', 'required' => false, 'example' => 'gender=male'], + 'CrowdId' => ['title' => '人群定向的指定人群ID。', 'description' => '人群定向的指定人群ID，可通过接口ListCrowds获取。', 'type' => 'string', 'required' => false, 'example' => '1'], + 'DistributionType' => ['title' => '分流方式。'."\n" + .'● UserId-用户ID'."\n" + .'● TimeDuration-时段', 'description' => '分流方式。'."\n" + .'● UserId-用户ID'."\n" + .'● TimeDuration-时段', 'type' => 'string', 'required' => false, 'example' => 'UserId'], + 'DistributionTimeDuration' => ['title' => '分流时段。', 'description' => '分流时段。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '3'], + 'Config' => ['title' => '实验组配置。', 'description' => '实验组配置。', 'type' => 'string', 'required' => false, 'example' => '{"RankBy": "Score"}'], + 'ReservedBuckets' => ['title' => '预留桶号。', 'description' => '预留桶号。', 'type' => 'string', 'required' => false, 'example' => '1,2,3'], + 'InstanceId' => ['title' => '实例ID。', 'description' => '实例ID，可通过接口ListInstances获取。', 'type' => 'string', 'required' => true, 'example' => 'pairec-test1'], + 'CrowdTargetType' => ['description' => '实验组流量定向的类型，可能的取值包括：'."\n" + .'* All 所有的流量'."\n" + .'* Filter 使用过滤条件的流量'."\n" + .'* CrowdId 通过指定人群ID'."\n" + .'* Random 按照百分比随机流量', 'type' => 'string', 'required' => false, 'example' => 'All'], + 'RandomFlow' => ['description' => '当实验组流量定向的类型是Random时，使用随机流量匹配这个实验组，可能的取值范围是 0 - 100。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '20'], + ], 'required' => false, - 'example' => '0', ], ], ], @@ -2651,157 +1914,54 @@ 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => '请求id。'."\n", - 'type' => 'string', - 'example' => '728C5E01-ABF6-5AA8-B9FC-B3BA05DECC77', - ], - 'TotalCount' => [ - 'description' => '总个数。'."\n", - 'type' => 'string', - 'example' => '30', - ], - 'RecallManagementTables' => [ - 'description' => '召回管理表列表。'."\n", - 'type' => 'array', - 'items' => [ - 'description' => '召回管理表详情。', - 'type' => 'object', - 'properties' => [ - 'RecallManagementTableId' => [ - 'description' => '数据表ID。'."\n", - 'type' => 'string', - 'example' => '3', - ], - 'Name' => [ - 'description' => '数据表名。'."\n", - 'type' => 'string', - 'example' => 'table-123', - ], - 'Description' => [ - 'description' => '数据表备注。'."\n", - 'type' => 'string', - 'example' => 'this is a test', - ], - 'Type' => [ - 'description' => '表类型。'."\n", - 'type' => 'string', - 'example' => 'Recall', - ], - 'RecallType' => [ - 'description' => '表的召回类型。'."\n", - 'type' => 'string', - 'example' => 'X2I', - ], - 'DataSource' => [ - 'description' => '数据源。'."\n", - 'type' => 'string', - 'example' => 'Api', - ], - 'MaxcomputeProjectName' => [ - 'description' => 'maxcompute项目名。'."\n", - 'type' => 'string', - 'example' => 'test', - ], - 'MaxcomputeTableName' => [ - 'description' => 'maxcompute中表名。'."\n", - 'type' => 'string', - 'example' => 'table-1', - ], - 'CanDelete' => [ - 'description' => '表是否可以被删除。'."\n", - 'type' => 'boolean', - 'example' => 'false', - ], - 'IndexVersionId' => [ - 'description' => '索引版本Id。'."\n", - 'type' => 'string', - 'example' => '20250701', - ], - 'IndexEffectiveTime' => [ - 'description' => '索引生效时间'."\n", - 'type' => 'string', - 'example' => '2021-12-15T23:24:33.132+08:00', - ], - 'GmtCreateTime' => [ - 'description' => '创建时间。'."\n", - 'type' => 'string', - 'example' => '2021-12-15T23:24:33.132+08:00', - ], - 'GmtModifiedTime' => [ - 'description' => '更新时间。'."\n", - 'type' => 'string', - 'example' => '2021-12-15T23:24:33.132+08:00', - ], - 'MaxcomputeSchema' => [ - 'description' => 'maxcompute schema。'."\n", - 'type' => 'string', - 'example' => 'default', - ], - 'PartitionFields' => [ - 'description' => '表的分区字段。', - 'type' => 'string', - 'example' => 'dt', - ], - ], - ], - ], - 'NextToken' => [ - 'description' => '暂不生效。', - 'type' => 'string', - 'example' => '""', - ], - 'MaxResults' => [ - 'description' => '暂不生效。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '0', - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => 'A04CB8C0-E74A-5E83-BC61-64D153574EC7'], + 'ExperimentGroupId' => ['title' => '实验组ID。', 'description' => '实验组ID。', 'type' => 'string', 'example' => '3'], ], ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '创建实验组', + 'summary' => '在指定层下，创建一个实验组。可按照实验类型划分实验组，从而按照实验组观测实验整体效果表现。', + 'changeSet' => [ + ['createdAt' => '2024-03-20T06:05:19.000Z', 'description' => '请求参数发生变更'], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"728C5E01-ABF6-5AA8-B9FC-B3BA05DECC77\\",\\n \\"TotalCount\\": \\"30\\",\\n \\"RecallManagementTables\\": [\\n {\\n \\"RecallManagementTableId\\": \\"3\\",\\n \\"Name\\": \\"table-123\\",\\n \\"Description\\": \\"this is a test\\",\\n \\"Type\\": \\"Recall\\",\\n \\"RecallType\\": \\"X2I\\",\\n \\"DataSource\\": \\"Api\\",\\n \\"MaxcomputeProjectName\\": \\"test\\",\\n \\"MaxcomputeTableName\\": \\"table-1\\",\\n \\"CanDelete\\": false,\\n \\"IndexVersionId\\": \\"20250701\\",\\n \\"IndexEffectiveTime\\": \\"2021-12-15T23:24:33.132+08:00\\",\\n \\"GmtCreateTime\\": \\"2021-12-15T23:24:33.132+08:00\\",\\n \\"GmtModifiedTime\\": \\"2021-12-15T23:24:33.132+08:00\\",\\n \\"MaxcomputeSchema\\": \\"default\\",\\n \\"PartitionFields\\": \\"dt\\"\\n }\\n ],\\n \\"NextToken\\": \\"\\\\\\"\\\\\\"\\",\\n \\"MaxResults\\": 0\\n}","type":"json"}]', - 'title' => '获取召回管理表列表', - 'description' => '## 请求说明'."\n" - .'- **InstanceId** 是必填参数，用于指定要查询的实例。'."\n" - .'- 可以通过 **Name** 和 **Type** 参数来过滤特定名称或类型的召回管理表。'."\n" - .'- 分页功能由 **PageNumber** 和 **PageSize** 控制，默认从第一页开始，每页显示50条记录。'."\n" - .'- 支持按创建时间（GmtCreateTime）或更新时间（GmtModifiedTime）进行排序，排序方式可选升序（ASC）或降序（DESC）。'."\n", - ], - 'UpdateRecallManagementConfig' => [ - 'summary' => '用于更新召回管理的初始化配置，包括实例ID、密码及网络配置等信息。', - 'path' => '/api/v1/recallmanagementconfigs', - 'methods' => [ - 'put', + 'flowControl' => [ + 'flowControlList' => [], ], - 'schemes' => [ - 'https', + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'pairec:CreateExperimentGroup', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIRecService', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"A04CB8C0-E74A-5E83-BC61-64D153574EC7\\",\\n \\"ExperimentGroupId\\": \\"3\\"\\n}","type":"json"}]', + ], + 'CreateFeatureConsistencyCheckJob' => [ + 'path' => '/api/v1/featureconsistencycheck/jobs', + 'methods' => ['post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'none', + 'operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATURElearnN0NAWV', - ], + 'abilityTreeNodes' => ['FEATURElearnN0NAWV'], ], 'parameters' => [ [ @@ -2812,47 +1972,16 @@ 'description' => '请求Body。', 'type' => 'object', 'properties' => [ - 'InstanceId' => [ - 'description' => '**实例ID**'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '1', - ], - 'Password' => [ - 'description' => '**密码**'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '12345', - ], - 'NetworkConfigs' => [ - 'description' => '**网络配置**'."\n", - 'type' => 'array', - 'items' => [ - 'description' => '网络配置详情。', - 'type' => 'object', - 'properties' => [ - 'VpcId' => [ - 'description' => '**交换机ID。**'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'vpc-xxx', - ], - 'VswitchIds' => [ - 'description' => '可用区和交换机ID信息。'."\n", - 'type' => 'object', - 'required' => false, - 'additionalProperties' => [ - 'type' => 'string', - 'example' => 'vsw-xxx', - 'description' => '交换机信息。', - ], - 'example' => 'cn-hangzhou', - ], - ], - 'required' => false, - ], - 'required' => false, - ], + 'InstanceId' => ['title' => '实例ID。', 'description' => '实例ID。如何获取实例ID，请参见[ListInstances](~~2411819~~)。', 'type' => 'string', 'required' => true, 'example' => 'pairec-cn-********'], + 'FeatureConsistencyCheckJobConfigId' => ['title' => '特征一致性检查任务配置ID。', 'description' => '特征一致性检查任务配置ID。如何获取配置ID，请参见[ListFeatureConsistencyCheckJobConfigs](~~2557567~~)。', 'type' => 'string', 'required' => true, 'example' => '3'], + 'Environment' => ['title' => '运行环境。'."\n" + .'● Daily-日常环境'."\n" + .'● Pre-预发环境'."\n" + .'● Prod-生产环境', 'description' => '运行环境：'."\n" + .'- Daily：日常环境'."\n" + .'- Pre：预发环境'."\n" + .'- Prod：生产环境', 'type' => 'string', 'required' => true, 'example' => 'Pre'], + 'SamplingDuration' => ['description' => '采样运行时长（单位：分钟）。', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '10'], ], 'required' => false, ], @@ -2865,56 +1994,55 @@ 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => '请求id。'."\n", - 'type' => 'string', - 'example' => '728C5E01-ABF6-5AA8-B9FC-B3BA05DECC77', - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => '7D59453C-48AA-5FC5-8848-2D373BD1A17F'], + 'FeatureConsistencyCheckJobId' => ['title' => '特征一致性检查任务ID。', 'description' => '特征一致性检查任务ID。', 'type' => 'string', 'example' => '4'], ], ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '创建特征一致性检查任务', + 'summary' => '创建特征一致性检查任务。', + 'changeSet' => [ + ['createdAt' => '2024-02-22T03:35:40.000Z', 'description' => '请求参数发生变更'], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"728C5E01-ABF6-5AA8-B9FC-B3BA05DECC77\\"\\n}","type":"json"}]', - 'title' => '更新召回管理配置', - 'description' => '## 请求说明'."\n" - .'- `InstanceId` 是必填项，用于指定要更新配置的实例。'."\n" - .'- `Password` 和 `NetworkConfigs` 为可选项，根据实际需求选择性提供。'."\n" - .'- 在 `NetworkConfigs` 中，可以进一步指定 VPC ID (`VpcId`) 和可用区与交换机ID映射(`VswitchIds`)来配置网络设置。'."\n" - .'- 注意：敏感信息如密码在传输过程中应确保安全。'."\n", - ], - 'PublishRecallManagementTable' => [ - 'summary' => '将MaxCompute表同步到召回引擎中，支持分区发布和模式选择。', - 'path' => '/api/v1/recallmanagementtables/{RecallManagementTableId}/action/publish', - 'methods' => [ - 'post', + 'flowControl' => [ + 'flowControlList' => [], ], - 'schemes' => [ - 'https', + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'pairec:CreateFeatureConsistencyCheckJob', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIRecService', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"7D59453C-48AA-5FC5-8848-2D373BD1A17F\\",\\n \\"FeatureConsistencyCheckJobId\\": \\"4\\"\\n}","type":"json"}]', + ], + 'CreateFeatureConsistencyCheckJobConfig' => [ + 'path' => '/api/v1/featureconsistencycheck/jobconfigs', + 'methods' => ['post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'none', + 'operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATURElearnN0NAWV', - ], + 'abilityTreeCode' => '193262', + 'abilityTreeNodes' => ['FEATURElearnN0NAWV'], ], 'parameters' => [ [ @@ -2925,59 +2053,211 @@ 'description' => '请求Body。', 'type' => 'object', 'properties' => [ - 'InstanceId' => [ - 'description' => '**实例ID。**'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'pairec-test1', - ], - 'Partition' => [ - 'description' => '发布表的分区。', - 'type' => 'object', - 'required' => false, - 'additionalProperties' => [ - 'type' => 'string', - 'example' => '{"ds":"20250711"}', - 'description' => '分区信息。', - ], - ], - 'SkipThresholdCheck' => [ - 'description' => '**同步表时，是否跳过阈值检查**'."\n", - 'type' => 'boolean', - 'required' => false, - 'example' => 'false', - ], - 'Mode' => [ - 'description' => '**同步表的模式枚举值**：'."\n" - .'- `Merge`：聚合。'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'Merge', - ], - 'Partitions' => [ - 'title' => '分区信息。', - 'description' => '发布表的分区。', - 'type' => 'object', - 'required' => false, - 'additionalProperties' => [ - 'title' => '分区值。', - 'description' => '分区值。', - 'type' => 'string', - 'example' => '{"ds":"20250711"}', - ], - ], + 'InstanceId' => ['title' => '实例ID。', 'description' => '实例ID。如何获取实例ID，请参见[ListInstances](~~2411819~~)。', 'type' => 'string', 'required' => true, 'example' => 'pairec-cn-********'], + 'Name' => ['title' => '特征一致性检查名称。', 'description' => '特征一致性检查名称。', 'type' => 'string', 'required' => true, 'example' => 'feature_consistency_check1'], + 'SceneId' => ['title' => '场景ID。', 'description' => '场景ID。', 'type' => 'string', 'required' => true, 'example' => '3'], + 'SampleRate' => ['title' => '采样比例（0-1）。', 'description' => '采样比例（0-1）。', 'type' => 'number', 'format' => 'double', 'required' => true, 'example' => '0.89'], + 'EasServiceName' => ['title' => 'PAI-EAS服务名称。', 'description' => 'PAI-EAS服务名称。如何获取服务名称，请参见[ListServices](~~412109~~)。', 'type' => 'string', 'required' => true, 'example' => 'service_123'], + 'FeatureLandingResourceId' => ['title' => '数据回落数据源ID。', 'description' => '数据回落数据源ID。', 'type' => 'string', 'required' => true, 'example' => 'reso-********'], + 'MaxcomputeSchema' => ['type' => 'string', 'example' => 'default'], + 'FgJsonFileName' => ['title' => 'fg_json文件名称。', 'description' => 'fg_json文件名称。', 'type' => 'string', 'required' => true, 'example' => 'file.json'], + 'UserTable' => ['title' => 'user表名。', 'description' => 'user表名。', 'type' => 'string', 'required' => false, 'example' => 'user_table'], + 'UserIdField' => ['title' => 'user_id字段名。', 'description' => 'user_id字段名。', 'type' => 'string', 'required' => false, 'example' => 'user_id'], + 'UserTablePartitionField' => ['title' => 'user表分区字段。', 'description' => 'user表分区字段。', 'type' => 'string', 'required' => false, 'example' => 'ds'], + 'UserTablePartitionFieldFormat' => ['title' => 'user表分区字段格式。'."\n" + .'● yyyymmdd'."\n" + .'● yyyy-mm-dd', 'description' => 'user表分区字段格式。'."\n" + .'- yyyymmdd'."\n" + .'- yyyy-mm-dd', 'type' => 'string', 'required' => false, 'example' => 'yyyymmdd'], + 'ItemTable' => ['title' => 'item表名。', 'description' => 'item表名。', 'type' => 'string', 'required' => false, 'example' => 'item_table'], + 'ItemIdField' => ['title' => 'item_id字段名。', 'description' => 'item_id字段名。', 'type' => 'string', 'required' => false, 'example' => 'item_id'], + 'ItemTablePartitionField' => ['title' => 'item表分区字段。', 'description' => 'item表分区字段。', 'type' => 'string', 'required' => false, 'example' => 'ds'], + 'ItemTablePartitionFieldFormat' => ['title' => 'item表分区字段格式。'."\n" + .'● yyyymmdd'."\n" + .'● yyyy-mm-dd', 'description' => 'item表分区字段格式。'."\n" + .'- yyyymmdd'."\n" + .'- yyyy-mm-dd', 'type' => 'string', 'required' => false, 'example' => 'yyyymmdd'], + 'CompareFeature' => ['title' => '是否需要特征比对。', 'description' => '是否需要特征比对。', 'type' => 'boolean', 'required' => true, 'example' => 'true'], + 'GenerateZip' => ['title' => '是否需要生成zip包。', 'description' => '是否需要生成zip包。', 'type' => 'boolean', 'required' => true, 'example' => 'true'], + 'ServiceId' => ['title' => '服务ID。', 'description' => '服务ID。', 'type' => 'string', 'required' => true, 'example' => '4'], + 'WorkflowName' => ['title' => '工作流名称。', 'description' => '工作流名称。', 'type' => 'string', 'required' => false, 'example' => 'work_flow_1'], + 'OssResourceId' => ['title' => 'OSS数据源ID。', 'description' => 'OSS数据源ID。', 'type' => 'string', 'required' => false, 'example' => 'reso-********'], + 'EasyRecVersion' => ['title' => 'EasyRec版本。', 'description' => 'EasyRec版本。', 'type' => 'string', 'required' => false, 'example' => '1.3.60'], + 'EasyRecPackagePath' => ['title' => 'EasyRec包路径。', 'description' => 'EasyRec包所在的OSS Bucket路径。', 'type' => 'string', 'required' => false, 'example' => 'oss://*******'], + 'FgJarVersion' => ['title' => 'fg_jar版本。', 'description' => 'fg_jar版本。', 'type' => 'string', 'required' => false, 'example' => '1.0.0'], + 'FeaturePriority' => ['title' => '特征优先级，多个特征通过逗号分开。', 'description' => '特征优先级，多个特征通过半角逗号（,）分开。', 'type' => 'string', 'required' => false, 'example' => 'feature1,feature2,feature3'], + 'FeatureDisplayExclude' => ['title' => '特征展示过滤，多个特征通过逗号分开。', 'description' => '特征展示过滤，多个特征通过半角逗号（,）分开。', 'type' => 'string', 'required' => false, 'example' => 'feature1,feature2'], + 'UseFeatureStore' => ['description' => '是否需要使用feature store，取值：'."\n" + ."\n" + .'- true：使用feature store，此时FeatureStoreProjectId、FeatureStoreProjectName、FeatureStoreModelId、FeatureStoreUserId、FeatureStoreItemId为必填项。'."\n" + .'- false：不使用feature store，此时UserTable、UserIdField、UserTablePartitionField、UserTablePartitionFieldFormat、ItemTable、ItemIdField、ItemTablePartitionField、ItemTablePartitionFieldFormat为必填项。', 'type' => 'boolean', 'required' => true, 'example' => 'true', 'default' => 'false'], + 'FeatureStoreProjectName' => ['description' => 'feature store项目名称。', 'type' => 'string', 'required' => false, 'example' => 'project-1'], + 'FeatureStoreModelId' => ['description' => 'feature store model ID。', 'type' => 'string', 'required' => false, 'example' => '2'], + 'FeatureStoreUserId' => ['description' => 'feature store user侧主键。', 'type' => 'string', 'required' => false, 'example' => 'user'], + 'FeatureStoreItemId' => ['description' => 'feature store item侧主键。', 'type' => 'string', 'required' => false, 'example' => 'item'], + 'FeatureStoreSeqFeatureView' => ['description' => '序列特征中item特征所在的特征视图的名字。', 'type' => 'string', 'required' => false, 'example' => 'item-1'], + 'FeatureStoreProjectId' => ['description' => 'feature store项目ID。', 'type' => 'string', 'required' => false, 'example' => 'prj-01'], + 'WorkspaceId' => ['type' => 'string', 'required' => false, 'example' => 'test', 'description' => ''], + 'VpcId' => ['type' => 'string', 'required' => false, 'example' => 'vpc-xxx', 'description' => ''], + 'SwitchId' => ['type' => 'string', 'required' => false, 'example' => 'vswitch-xxx', 'description' => ''], + 'SecurityGroupId' => ['type' => 'string', 'required' => false, 'example' => 'thax-xxx', 'description' => ''], + 'DefaultRoute' => ['type' => 'string', 'required' => false, 'example' => 'Eth0', 'description' => ''], + 'DatasetId' => ['type' => 'string', 'required' => false, 'example' => 's-xxx', 'description' => ''], + 'DatasetType' => ['type' => 'string', 'required' => false, 'example' => 'OSS', 'description' => ''], + 'DatasetUri' => ['type' => 'string', 'required' => false, 'example' => 'oss-xxx', 'description' => ''], + 'DatasetMountPath' => ['type' => 'string', 'required' => false, 'example' => 'mnt/xxx', 'description' => ''], + 'DatasetName' => ['type' => 'string', 'required' => false, 'example' => 'test', 'description' => ''], + 'PredictWorkerCount' => ['type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'description' => ''], + 'PredictWorkerCpu' => ['type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '4', 'description' => ''], + 'PredictWorkerMemory' => ['type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '32000', 'description' => ''], + 'ResourceConfig' => ['type' => 'string', 'required' => false, 'example' => '{}', 'description' => ''], ], 'required' => false, ], ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => 'E15A1443-7917-5BE0-AE70-25538ECF398D'], + 'FeatureConsistencyCheckJobConfigId' => ['title' => '特征一致性检查配置ID。', 'description' => '特征一致性检查配置ID。', 'type' => 'string', 'example' => '4'], + ], + ], + ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '创建特征一致性检查任务配置', + 'summary' => '创建特征一致性检查任务配置。', + 'changeSet' => [ + ['createdAt' => '2025-06-04T10:10:20.000Z', 'description' => '请求参数发生变更'], + ['createdAt' => '2024-12-10T06:00:28.000Z', 'description' => '请求参数发生变更'], + ['createdAt' => '2024-11-12T09:17:26.000Z', 'description' => '请求参数发生变更'], + ['createdAt' => '2024-02-22T03:35:43.000Z', 'description' => '请求参数发生变更'], + ], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'pairec:CreateFeatureConsistencyCheckJobConfig', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIRecService', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"E15A1443-7917-5BE0-AE70-25538ECF398D\\",\\n \\"FeatureConsistencyCheckJobConfigId\\": \\"4\\"\\n}","type":"json"}]', + ], + 'CreateInstanceResource' => [ + 'summary' => '为指定实例配置创建新的配置资源。', + 'path' => '/api/v1/instances/{InstanceId}/resources', + 'methods' => ['post'], + 'schemes' => ['http', 'https'], + 'security' => [ [ - 'name' => 'RecallManagementTableId', + 'AK' => [], + ], + ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATURElearnN0NAWV'], + ], + 'parameters' => [ + [ + 'name' => 'InstanceId', 'in' => 'path', + 'schema' => ['description' => '实例ID，可通过接口[ListInstances](~~2411819~~)获取。', 'type' => 'string', 'required' => true, 'example' => 'pairec-cn-test1'], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', 'schema' => [ - 'description' => '表Id'."\n", - 'type' => 'string', + 'description' => '请求体参数。', + 'type' => 'object', + 'properties' => [ + 'Category' => ['description' => '资源类别'."\n" + .'- DataManagement'."\n" + .'- Engine'."\n" + .'- Monitor', 'type' => 'string', 'required' => true, 'example' => 'DataManagement'], + 'Group' => ['description' => '资源分组。'."\n" + ."\n" + .'当资源类别为DataManagement时，资源分组有：'."\n" + .'- storage'."\n" + ."\n" + .'- modelpipeline'."\n" + ."\n" + .'- datastorage'."\n" + ."\n" + .'- modeltrain'."\n" + ."\n" + .'当资源类别为Engine时，资源分组有：'."\n" + .'- feature'."\n" + ."\n" + .'- predict'."\n" + ."\n" + .'- recall'."\n" + ."\n" + .'- recengine'."\n" + ."\n" + .'当资源类别为Monitor时，资源分组有：'."\n" + .'- logs'."\n" + ."\n" + .'- logsback'."\n" + ."\n" + .'- coldstart'."\n" + ."\n" + .'- deploy', 'type' => 'string', 'required' => true, 'example' => 'storage'], + 'Type' => ['description' => '资源类型'."\n" + ."\n" + .'- Hologres'."\n" + ."\n" + .'- EAS'."\n" + ."\n" + .'- BE'."\n" + ."\n" + .'- Rec'."\n" + ."\n" + .'- Platform'."\n" + ."\n" + .'- SLS'."\n" + ."\n" + .'- DataHub'."\n" + ."\n" + .'- Kafka'."\n" + ."\n" + .'- Flinkvvp'."\n" + ."\n" + .'- ACR'."\n" + ."\n" + .'- OSS'."\n" + ."\n" + .'- DataWorks'."\n" + ."\n" + .'- PAI'."\n" + ."\n" + .'- MaxCompute'."\n" + ."\n" + .'- GraphCompute'."\n" + ."\n" + .'- Redis', 'type' => 'string', 'required' => true, 'example' => 'OSS'], + 'Uri' => ['description' => '资源地址。', 'type' => 'string', 'required' => true, 'example' => 'bucket-test-123'], + ], 'required' => false, - 'example' => '3', ], ], ], @@ -2988,70 +2268,226 @@ 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => '请求ID。'."\n", - 'type' => 'string', - 'example' => '728C5E01-ABF6-5AA8-B9FC-B3BA05DECC77', - ], - 'RecallManagementJobId' => [ - 'description' => '召回管理任务ID。'."\n", - 'type' => 'string', - 'example' => '1', - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => '6CF1E160-3F36-5E73-A170-C75504F05BBC'], + 'ResourceId' => ['description' => '资源ID。', 'type' => 'string', 'example' => 'reso-2s416t***'], ], ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"6CF1E160-3F36-5E73-A170-C75504F05BBC\\",\\n \\"ResourceId\\": \\"reso-2s416t***\\"\\n}","type":"json"}]', + 'title' => '创建配置资源', + 'changeSet' => [ + ['createdAt' => '2024-02-22T03:35:44.000Z', 'description' => '请求参数发生变更'], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"728C5E01-ABF6-5AA8-B9FC-B3BA05DECC77\\",\\n \\"RecallManagementJobId\\": \\"1\\"\\n}","type":"json"}]', - 'title' => '同步召回管理表', - 'description' => '## 请求说明'."\n" - .'该API用于将指定的MaxCompute表同步至召回引擎，并允许用户指定发布的表分区、是否跳过阈值检查以及同步模式（聚合或覆盖）。请确保在请求体中正确填写实例ID及表ID，在路径参数中提供正确的`RecallManagementTableId`。如果需要指定特定的表分区进行发布，请通过`Partitions`字段以键值对形式给出。此外，还可以选择是否跳过数据量阈值检查以及设置同步模式。'."\n", - ], - 'OfflineRecallManagementService' => [ - 'summary' => '用于将指定的召回管理服务设置为离线状态。', - 'path' => '/api/v1/recallmanagementservices/{RecallManagementServiceId}/action/offline', - 'methods' => [ - 'post', + 'flowControl' => [ + 'flowControlList' => [], ], - 'schemes' => [ - 'https', + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'pairec:CreateInstanceResource', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIRecService', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], ], + ], + 'CreateLaboratory' => [ + 'summary' => '创建一个实验室，实验室是一组流量的集合，在实验室下可开展实验。', + 'path' => '/api/v1/laboratories', + 'methods' => ['post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATURElearnN0NAWV'], ], - 'produces' => [ - 'application/json', + 'parameters' => [ + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', + 'schema' => [ + 'title' => '请求body。', + 'description' => '请求body。', + 'type' => 'object', + 'properties' => [ + 'SceneId' => ['title' => '场景ID。', 'description' => '场景ID，可通过接口ListScenes获取。', 'type' => 'string', 'required' => true, 'example' => '3'], + 'Name' => ['title' => '实验室名称。', 'description' => '实验室名称。', 'type' => 'string', 'required' => true, 'example' => 'laboratory1'], + 'Description' => ['title' => '实验室描述。', 'description' => '实验室描述。', 'type' => 'string', 'required' => false, 'example' => 'This is a test.'], + 'DebugUsers' => ['title' => '调试用户。', 'description' => '调试用户（需为阿里云账户主账号/子账号uid），多个用户需通过逗号作间隔。', 'type' => 'string', 'required' => false, 'example' => '1124512470******,1124512471******,1124512472******'], + 'DebugCrowdId' => ['title' => '调试人群ID。', 'description' => '调试人群ID。', 'type' => 'string', 'required' => false, 'example' => '3'], + 'BucketCount' => ['title' => '分桶数量。', 'description' => '分桶数量。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '24'], + 'Buckets' => ['title' => '分配桶号。', 'description' => '分配桶号。', 'type' => 'string', 'required' => false, 'example' => '1,2,3,10-20'], + 'BucketType' => ['title' => '分桶方式'."\n" + .'● UidHash-UID哈希（默认）'."\n" + .'● Uid-UID分桶'."\n" + .'● Filter-过滤条件分桶', 'description' => '分桶方式'."\n" + .'● UidHash-UID哈希（默认）'."\n" + .'● Uid-UID分桶'."\n" + .'● Filter-过滤条件分桶', 'type' => 'string', 'required' => true, 'example' => 'UidHash'], + 'Filter' => ['title' => '过滤条件。', 'description' => '过滤条件。', 'type' => 'string', 'required' => false, 'example' => 'filter=xxx'], + 'Environment' => ['title' => '运行环境'."\n" + .'● Daily-日常环境'."\n" + .'● Pre-预发环境'."\n" + .'● Prod-生产环', 'description' => '运行环境'."\n" + .'● Daily-日常环境'."\n" + .'● Pre-预发环境'."\n" + .'● Prod-生产环', 'type' => 'string', 'required' => true, 'example' => 'Daily'], + 'Type' => ['title' => '实验室类型'."\n" + .'● Base'."\n" + .'● NonBase', 'description' => '实验室类型'."\n" + .'● Base'."\n" + .'● NonBase', 'type' => 'string', 'required' => true, 'example' => 'Base'], + 'InstanceId' => ['title' => '实例ID。', 'description' => '实例ID，可通过接口ListInstances获取。', 'type' => 'string', 'required' => true, 'example' => 'pairec-cn-abcdefg1234'], + ], + 'required' => false, + ], + ], ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => '42391E6D-822C-58F8-9F7E-D991BB86D6AD'], + 'LaboratoryId' => ['title' => '实验室ID。', 'description' => '实验室ID。', 'type' => 'string', 'example' => '3'], + ], + ], + ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"42391E6D-822C-58F8-9F7E-D991BB86D6AD\\",\\n \\"LaboratoryId\\": \\"3\\"\\n}","type":"json"}]', + 'title' => '创建实验室', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'pairec:CreateLaboratory', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIRecService', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + ], + ], + 'CreateLayer' => [ + 'summary' => '在指定实验室下创建一个层，用于分层实验。层与层之间正交，可独立开展实验，避免流量饥饿问题。', + 'path' => '/api/v1/layers', + 'methods' => ['post'], + 'schemes' => ['http', 'https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'none', + 'operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATURElearnN0NAWV', - ], + 'abilityTreeNodes' => ['FEATURElearnN0NAWV'], ], 'parameters' => [ [ - 'name' => 'RecallManagementServiceId', - 'in' => 'path', + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', 'schema' => [ - 'description' => '召回管理服务ID。'."\n", - 'type' => 'string', + 'title' => '请求body。', + 'description' => '请求body。', + 'type' => 'object', + 'properties' => [ + 'LaboratoryId' => ['title' => '实验室ID。', 'description' => '实验室ID，可通过接口ListLaboratories获取。', 'type' => 'string', 'required' => true, 'example' => '3'], + 'Name' => ['title' => '层名称。', 'description' => '层名称。', 'type' => 'string', 'required' => true, 'example' => 'layer1'], + 'Description' => ['title' => '层描述。', 'description' => '层描述。', 'type' => 'string', 'required' => true, 'example' => 'This is a test.'], + 'InstanceId' => ['title' => '实例ID。', 'description' => '实例ID，可通过接口ListInstances获取。', 'type' => 'string', 'required' => true, 'example' => 'pairec-cn-abcdefg1234'], + ], 'required' => false, - 'example' => '3', ], ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => '59CE7EC6-F268-5D71-9215-32922CC50D72'], + 'LayerId' => ['title' => '层ID。', 'description' => '层ID。', 'type' => 'string', 'example' => '3'], + ], + ], + ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"59CE7EC6-F268-5D71-9215-32922CC50D72\\",\\n \\"LayerId\\": \\"3\\"\\n}","type":"json"}]', + 'title' => '创建层', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'pairec:CreateLayer', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIRecService', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + ], + ], + 'CreateParam' => [ + 'summary' => '用于在指定环境中为特定场景创建AB实验参数。', + 'path' => '/api/v1/params', + 'methods' => ['post'], + 'schemes' => ['http', 'https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATURElearnN0NAWV'], + ], + 'parameters' => [ [ 'name' => 'body', 'in' => 'body', @@ -3060,12 +2496,22 @@ 'description' => '请求body。', 'type' => 'object', 'properties' => [ - 'InstanceId' => [ - 'description' => '实例ID。'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'pairec-cn-test123', - ], + 'SceneId' => ['title' => '场景ID。', 'description' => '场景ID，可通过接口ListScenes获取。', 'type' => 'string', 'required' => false, 'example' => '4'], + 'Name' => ['title' => '参数名称。', 'description' => '参数名称。', 'type' => 'string', 'required' => false, 'example' => 'home'], + 'Value' => ['title' => '参数值。', 'description' => '参数值。', 'type' => 'string', 'required' => false, 'example' => 'house'], + 'Environment' => ['title' => '参数所属的环境。'."\n" + .'● Daily-日常环境'."\n" + .'● Pre-预发环境'."\n" + .'● Prod-生产环境', 'description' => '参数所属的环境。'."\n" + .'● Daily-日常环境'."\n" + .'● Pre-预发环境'."\n" + .'● Prod-生产环境', 'type' => 'string', 'required' => false, 'example' => 'Daily'], + 'InstanceId' => ['title' => '实例ID。', 'description' => '实例ID，可通过接口ListInstances获取。', 'type' => 'string', 'required' => false, 'example' => 'pairec-cn-abcdefg1234'], + 'Type' => ['description' => '参数类型。'."\n" + ."\n" + .'- Normal：普通参数。'."\n" + ."\n" + .'- Encryption：加密参数。', 'type' => 'string', 'required' => false, 'example' => 'Normal'], ], 'required' => false, ], @@ -3078,57 +2524,55 @@ 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'Id of the request', - 'type' => 'string', - 'example' => '728C5E01-ABF6-5AA8-B9FC-B3BA05DECC77', - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => 'F8F613A9-DF1C-551A-88E1-397A3981A785'], + 'ParamId' => ['title' => '参数ID。', 'description' => '参数ID。', 'type' => 'integer', 'format' => 'int64', 'example' => '4'], ], ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"F8F613A9-DF1C-551A-88E1-397A3981A785\\",\\n \\"ParamId\\": 4\\n}","type":"json"}]', + 'title' => '创建AB实验参数', + 'description' => '## 请求说明'."\n", + 'changeSet' => [ + ['createdAt' => '2025-07-02T01:39:45.000Z', 'description' => '请求参数发生变更'], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"728C5E01-ABF6-5AA8-B9FC-B3BA05DECC77\\"\\n}","type":"json"}]', - 'title' => '下线召回管理服务', - 'description' => '## 请求说明'."\n" - .'通过此API，您可以将特定的召回管理服务设置为离线状态。请确保提供的`RecallManagementServiceId`和`InstanceId`准确无误，以避免错误操作。'."\n" - ."\n" - .'- **重要提示**：一旦某个召回管理服务被设置为离线状态，它将不再处理新的请求，直到再次被激活。'."\n" - ."\n" - .'- 确保在执行此操作前已经备份了所有必要的数据或配置，以防需要恢复到当前状态。'."\n", - ], - 'CreateRecallManagementTable' => [ - 'summary' => '用于创建一个新的召回管理表，支持多种数据源和配置选项。', - 'path' => '/api/v1/recallmanagementtables', - 'methods' => [ - 'post', + 'flowControl' => [ + 'flowControlList' => [], ], - 'schemes' => [ - 'https', + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'pairec:CreateParam', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIRecService', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], ], + ], + 'CreateRecallManagementConfig' => [ + 'summary' => '用于初始化召回管理的配置，包括实例ID、用户信息及网络设置。', + 'path' => '/api/v1/recallmanagementconfigs', + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATURElearnN0NAWV', - ], + 'abilityTreeNodes' => ['FEATURElearnN0NAWV'], ], 'parameters' => [ [ @@ -3136,163 +2580,31 @@ 'in' => 'body', 'style' => 'json', 'schema' => [ - 'description' => '请求body。', + 'description' => '请求Body。', 'type' => 'object', 'properties' => [ - 'InstanceId' => [ - 'description' => '**实例ID**'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'pairec-cn-test123', - ], - 'Name' => [ - 'description' => '**表名称。**'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'table-123', - ], - 'Description' => [ - 'description' => '**表备注。**'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'this is a test table', - ], - 'Type' => [ - 'description' => '**表类型。**'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'Recall', - ], - 'RecallType' => [ - 'description' => '表的召回类型。', - 'type' => 'string', - 'required' => false, - 'example' => 'X2I', - ], - 'DataSource' => [ - 'description' => '数据来源。'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'MaxcomputeAndApiApi', - ], - 'MaxcomputeProjectName' => [ - 'description' => 'maxcompute 项目。'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'test', - ], - 'MaxcomputeTableName' => [ - 'description' => 'maxcompute 中表名。'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'table-1', - ], - 'Fields' => [ - 'description' => '字段列表。', + 'InstanceId' => ['description' => '**实例ID**'."\n", 'type' => 'string', 'required' => false, 'example' => 'learn-pairec-xxx'], + 'UserName' => ['description' => '**用户名**'."\n", 'type' => 'string', 'required' => false, 'example' => 'zhhangsan'], + 'Password' => ['description' => '**密码**'."\n", 'type' => 'string', 'required' => false, 'example' => '12345'], + 'NetworkConfigs' => [ + 'description' => '**网络配置**'."\n", 'type' => 'array', 'items' => [ - 'description' => '字段详情。', + 'description' => '网络配置信息。', 'type' => 'object', 'properties' => [ - 'Name' => [ - 'description' => '字段名称。', - 'type' => 'string', - 'required' => false, - 'example' => 'age', - ], - 'Type' => [ - 'description' => '字段类型。'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'STRING(全大写)', - ], - 'Attributes' => [ - 'description' => '枚举值：'."\n" - .'- Primary：主键字段'."\n" - .'- Item：物品字段'."\n" - .'- Score：召回分字段'."\n" - .'- Vector：向量字段'."\n" - .'- Index：索引字段'."\n" - .'字段属性。'."\n", - 'type' => 'array', - 'items' => [ - 'description' => '字段属性。', - 'type' => 'string', - 'required' => false, - 'example' => 'Primary', - ], - 'required' => false, - ], - 'VectorDimension' => [ - 'description' => '向量维度。'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '32', - ], - 'VectorMetricType' => [ - 'description' => '向量指标类型。'."\n", - 'type' => 'string', + 'VpcId' => ['description' => 'Vpc id'."\n", 'type' => 'string', 'required' => false, 'example' => 'vpc-xxx'], + 'VSwitchIds' => [ + 'description' => '可用区和交换机ID信息'."\n", + 'type' => 'object', 'required' => false, - 'example' => 'L2', + 'additionalProperties' => ['type' => 'string', 'description' => '交换机ID。', 'example' => 'vsw-xxx'], ], ], 'required' => false, ], 'required' => false, ], - 'Config' => [ - 'description' => '表的一些额外配置'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '{"":""}', - ], - 'EnableRowCountFluctuationThreshold' => [ - 'description' => '是否启动表数据条目波动阈值'."\n", - 'type' => 'boolean', - 'required' => false, - 'example' => 'true', - ], - 'MinRowCountFluctuationThreshold' => [ - 'description' => '表数据条目波动阈值最小值'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '10', - ], - 'MaxRowCountFluctuationThreshold' => [ - 'description' => '表数据条目波动阈值最大值'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '100', - ], - 'EnableDataSizeFluctuationThreshold' => [ - 'description' => '是否启动表大小波动阈值'."\n", - 'type' => 'boolean', - 'required' => false, - 'example' => 'true', - ], - 'MinDataSizeFluctuationThreshold' => [ - 'description' => '表大小波动阈值最小值'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '10', - ], - 'MaxDataSizeFluctuationThreshold' => [ - 'description' => '表大小波动阈值最大值。', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '100', - ], - 'MaxcomputeSchema' => [ - 'description' => '**maxcompute 的schema**'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'default', - ], ], 'required' => false, ], @@ -3305,362 +2617,53 @@ 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => '**请求id。**'."\n", - 'type' => 'string', - 'example' => '728C5E01-ABF6-5AA8-B9FC-B3BA05DECC77', - ], - 'RecallManagementTableId' => [ - 'description' => '**表ID。**'."\n", - 'type' => 'string', - 'example' => '3', - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => '请求id。'."\n", 'type' => 'string', 'example' => '728C5E01-ABF6-5AA8-B9FC-B3BA05DECC77'], ], ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '创建召回管理配置', + 'description' => '## 请求说明'."\n", + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"728C5E01-ABF6-5AA8-B9FC-B3BA05DECC77\\",\\n \\"RecallManagementTableId\\": \\"3\\"\\n}","type":"json"}]', - 'title' => '创建召回管理表', - 'description' => '## 请求说明'."\n" - .'- **InstanceId**、**Name**、**Description**、**Type** 和 **DataSource** 是必填项。'."\n" - .'- **RecallType** 可选，但若指定则必须符合枚举值要求。'."\n" - .'- **Fields** 中的每个字段需要定义其名称（Name）、类型（Type）以及属性（Attributes），其中至少一个字段需被标记为 Primary。'."\n" - .'- 如果使用 Maxcompute 作为数据源，则 **MaxcomputeProjectName** 和 **MaxcomputeTableName** 必须提供；**MaxcomputeSchema** 是可选项。'."\n" - .'- 对于向量类型的字段，如果设置了 **VectorDimension** 和 **VectorMetricType**，请确保这些值与实际数据匹配。'."\n" - .'- **Config** 字段允许用户添加额外的配置信息，格式为 JSON 字符串。'."\n" - .'- 波动阈值相关参数（如 **EnableRowCountFluctuationThreshold** 等）提供了对表内数据条目或大小变化的监控能力，可根据需求启用并设置合理的阈值范围。'."\n", + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"728C5E01-ABF6-5AA8-B9FC-B3BA05DECC77\\"\\n}","type":"json"}]', ], - 'CreateRecallManagementServiceVersionConfig' => [ - 'summary' => '用于创建指定召回管理服务版本的配置，包括召回和归并设置。', - 'path' => '/api/v1/recallmanagementservices/{RecallManagementServiceId}/versions/{RecallManagementServiceVersionId}/configs', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], + 'CreateRecallManagementService' => [ + 'summary' => '此API用于创建一个新的召回管理服务。', + 'path' => '/api/v1/recallmanagementservices', + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'none', + 'operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATURElearnN0NAWV', - ], + 'abilityTreeNodes' => ['FEATURElearnN0NAWV'], ], 'parameters' => [ [ - 'name' => 'RecallManagementServiceId', - 'in' => 'path', - 'schema' => [ - 'description' => '召回管理服务ID。'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '2', - ], - ], - [ - 'name' => 'RecallManagementServiceVersionId', - 'in' => 'path', - 'schema' => [ - 'description' => '召回管理服务版本ID。'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '3', - ], - ], - [ 'name' => 'body', 'in' => 'body', 'style' => 'json', 'schema' => [ - 'description' => '请求Body。', + 'description' => '请求body。', 'type' => 'object', 'properties' => [ - 'InstanceId' => [ - 'description' => '实例ID。'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'pai-teest-1', - ], - 'ConfigType' => [ - 'description' => '召回管理版本配置类型。枚举值：Recall：召回配置。Merge：归并配置。'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'Recall', - ], - 'RecallConfig' => [ - 'description' => '召回配置。'."\n", - 'type' => 'object', - 'properties' => [ - 'Name' => [ - 'description' => '召回名称。'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'etrec', - ], - 'Description' => [ - 'description' => '召回描述。'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'this is etrec recall', - ], - 'Priority' => [ - 'description' => '优先级。数字越小，优先级越高'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '2', - ], - 'RecallType' => [ - 'description' => '召回类型。'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'X2I', - ], - 'RecallManagementTableId' => [ - 'description' => '召回管理表ID。'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '3', - ], - 'UserVectorRecallManagementTableId' => [ - 'description' => '用户向量召回表ID。'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '4', - ], - 'UserVectorField' => [ - 'description' => '用户向量字段。'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'user_embedding', - ], - 'ItemVectorRecallManagementTableId' => [ - 'description' => '物品向量召回表ID。'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '5', - ], - 'ItemVectorField' => [ - 'description' => '物品向量字段。'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'item_embedding', - ], - 'Operators' => [ - 'description' => '算子列表。'."\n", - 'type' => 'array', - 'items' => [ - 'description' => '算子详情。', - 'type' => 'object', - 'properties' => [ - 'OperatorType' => [ - 'description' => '算子类型，枚举值：FilterFeatureTriggerFeature'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'Filter', - ], - 'TriggerConfig' => [ - 'description' => 'Trigger算子的配置。'."\n", - 'type' => 'object', - 'properties' => [ - 'Field' => [ - 'description' => '字段名称。'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'user_id', - ], - 'IsRandSort' => [ - 'description' => '是否随机排序。'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'false', - ], - 'SortField' => [ - 'description' => '排序字段。'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'create_time', - ], - 'FieldQuantityLimit' => [ - 'description' => '字段数量限制。'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '20', - ], - ], - 'required' => false, - ], - 'FilterConfig' => [ - 'description' => '过滤算子的配置。'."\n", - 'type' => 'object', - 'properties' => [ - 'Experession' => [ - 'description' => '过滤表达式。', - 'type' => 'string', - 'required' => false, - 'example' => 'age>20', - ], - ], - 'required' => false, - ], - 'FeatureConfig' => [ - 'description' => '**特征算子的配置。**'."\n", - 'type' => 'object', - 'properties' => [ - 'Name' => [ - 'description' => '**特征名称。**'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'city', - ], - 'Type' => [ - 'description' => '**特征类型。**'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'string', - ], - 'Expression' => [ - 'description' => '**特征表达式。**'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'category=3', - ], - ], - 'required' => false, - ], - 'JoinConfig' => [ - 'description' => '**Join算子的配置。**'."\n", - 'type' => 'object', - 'properties' => [ - 'Field' => [ - 'description' => 'Join字段。'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'item_id', - ], - 'RecallManagementTableId' => [ - 'description' => 'Join表ID。'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '3', - ], - 'OutputFields' => [ - 'description' => '返回字段。'."\n", - 'type' => 'array', - 'items' => [ - 'description' => '返回字段列表。', - 'type' => 'string', - 'required' => false, - 'example' => 'lang', - ], - 'required' => false, - ], - ], - 'required' => false, - ], - ], - 'required' => false, - ], - 'required' => false, - ], - 'ExtendedConfig' => [ - 'description' => '额外配置，方便以后功能扩展。'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '""', - ], - 'ItemConditionArray' => [ - 'description' => '物品条件，设置数组格式条件'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '[{"option":"<","field":"category","type":"STRING","value":"10"}]', - ], - 'ItemConditionExpression' => [ - 'title' => '物品条件表达式。', - 'type' => 'string', - 'required' => false, - 'example' => 'age>20', - ], - ], - 'required' => false, - ], - 'MergeConfig' => [ - 'description' => '归并配置。'."\n", - 'type' => 'object', - 'properties' => [ - 'RecallManagementServiceVersionConfigId' => [ - 'description' => '召回管理服务版本配置ID。'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '1', - ], - 'MergeType' => [ - 'description' => '归并类型，枚举值：Weight：权重Alternate：交替'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'Weight', - ], - 'FilterRecallManagementTableIds' => [ - 'description' => '过滤表ID。'."\n", - 'type' => 'array', - 'items' => [ - 'description' => '过滤表ID列表。', - 'type' => 'string', - 'required' => false, - 'example' => '3', - ], - 'required' => false, - ], - 'ItemRecallManagementTableId' => [ - 'description' => '物品表ID。'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '2', - ], - 'ItemTableFields' => [ - 'description' => '物品表输出字段。'."\n", - 'type' => 'array', - 'items' => [ - 'description' => '物品表输出字段列表。', - 'type' => 'string', - 'required' => false, - 'example' => 'item_id', - ], - 'required' => false, - ], - 'FilterExpression' => [ - 'description' => '过滤表达式。', - 'type' => 'string', - 'required' => false, - 'example' => 'age>20', - ], - 'ExtendedConfig' => [ - 'description' => '归并配置的一些额外配置，方便以后功能扩展。'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '""', - ], - ], - 'required' => false, - ], + 'InstanceId' => ['description' => '**实例ID。**'."\n", 'type' => 'string', 'required' => false, 'example' => 'pairec-cn-test123'], + 'Name' => ['description' => '**召回服务名称。**'."\n", 'type' => 'string', 'required' => false, 'example' => 'hot_global_recall'], + 'Description' => ['description' => '**召回服务描述。**'."\n", 'type' => 'string', 'required' => false, 'example' => 'this is a test recall'], ], 'required' => false, ], @@ -3673,73 +2676,49 @@ 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => '请求id。'."\n", - 'type' => 'string', - 'example' => 'F8F613A9-DF1C-551A-88E1-397A3981A785', - ], - 'RecallManagementServiceVersionConfigId' => [ - 'description' => '召回管理服务版本配置ID。'."\n", - 'type' => 'string', - 'example' => '1', - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => '**请求id。**'."\n", 'type' => 'string', 'example' => '728C5E01-ABF6-5AA8-B9FC-B3BA05DECC77'], + 'RecallManagementServiceId' => ['description' => '召回服务管理ID。'."\n", 'type' => 'string', 'example' => '1'], + 'RecallManagementServiceVersionId' => ['description' => '召回服务管理版本ID。'."\n", 'type' => 'string', 'example' => '3'], ], ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"F8F613A9-DF1C-551A-88E1-397A3981A785\\",\\n \\"RecallManagementServiceVersionConfigId\\": \\"1\\"\\n}","type":"json"}]', - 'title' => '创建召回管理服务版本配置', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '创建召回管理服务', 'description' => '## 请求说明'."\n" - .'- 该API允许用户为特定的召回管理服务版本创建配置。'."\n" - .'- 配置类型可以是召回（Recall）或归并（Merge），具体取决于`ConfigType`参数。'."\n" - .'- `RecallConfig`和`MergeConfig`分别对应召回配置和归并配置的具体内容，根据实际需求填写相应字段。'."\n" - .'- 注意确保所有必填参数都已正确提供，并且遵循给定的数据格式要求。'."\n" - .'- 对于非必需但提供的参数，请确保其值符合业务逻辑预期。'."\n", + .'通过调用此API，您可以基于指定的实例ID、服务名称和服务描述来创建一个召回管理服务。请确保提供的参数值符合要求，特别是`InstanceId`必须是有效的实例标识符。'."\n", + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"728C5E01-ABF6-5AA8-B9FC-B3BA05DECC77\\",\\n \\"RecallManagementServiceId\\": \\"1\\",\\n \\"RecallManagementServiceVersionId\\": \\"3\\"\\n}","type":"json"}]', ], 'CreateRecallManagementServiceVersion' => [ 'summary' => '用于创建一个新的召回管理服务版本，支持配置多种召回策略。', 'path' => '/api/v1/recallmanagementservices/{RecallManagementServiceId}/versions', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATURElearnN0NAWV', - ], + 'abilityTreeNodes' => ['FEATURElearnN0NAWV'], ], 'parameters' => [ [ 'name' => 'RecallManagementServiceId', 'in' => 'path', - 'schema' => [ - 'description' => '召回管理服务ID。'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '2', - ], + 'schema' => ['description' => '召回管理服务ID。'."\n", 'type' => 'string', 'required' => false, 'example' => '2'], ], [ 'name' => 'body', @@ -3749,12 +2728,8 @@ 'description' => '请求body。', 'type' => 'object', 'properties' => [ - 'SourceRecallManagementServiceVersionId' => [ - 'description' => '源召回管理服务版本ID。'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '4', - ], + 'InstanceId' => ['title' => '实例ID。', 'description' => '实例ID。', 'type' => 'string', 'required' => false, 'example' => 'learn-pairec-xxx'], + 'SourceRecallManagementServiceVersionId' => ['description' => '源召回管理服务版本ID。'."\n", 'type' => 'string', 'required' => false, 'example' => '4'], 'Configs' => [ 'description' => '配置详情。', 'type' => 'object', @@ -3766,61 +2741,18 @@ 'description' => '召回管理服务版本配置列表。', 'type' => 'object', 'properties' => [ - 'Name' => [ - 'description' => '召回名称。'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'etrec', - ], - 'Description' => [ - 'description' => '召回描述。'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'this is etrec recall', - ], - 'Priority' => [ - 'description' => '优先级。数字越小，优先级越高'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '1', - ], - 'RecallType' => [ - 'description' => '召回类型。'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'X2I', - ], - 'RecallManagementTableId' => [ - 'description' => '召回管理表ID。'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '1', - ], - 'UserVectorRecallManagementTableId' => [ - 'description' => '用户向量召回表ID。'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '3', - ], - 'UserVectorField' => [ - 'description' => '用户向量字段。'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'user_embedding', - ], - 'ItemVectorRecallManagementTableId' => [ - 'description' => '物品向量召回表ID。'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '4', - ], - 'ItemVectorField' => [ - 'description' => '物品向量字段。'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'item_embedding', - ], + 'Name' => ['description' => '召回名称。'."\n", 'type' => 'string', 'required' => false, 'example' => 'etrec'], + 'Description' => ['description' => '召回描述。'."\n", 'type' => 'string', 'required' => false, 'example' => 'this is etrec recall'], + 'Priority' => ['description' => '优先级。数字越小，优先级越高'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1'], + 'RecallType' => ['description' => '召回类型。'."\n", 'type' => 'string', 'required' => false, 'example' => 'X2I'], + 'RecallManagementTableId' => ['description' => '召回管理表ID。'."\n", 'type' => 'string', 'required' => false, 'example' => '1'], + 'UserVectorRecallManagementTableId' => ['description' => '用户向量召回表ID。'."\n", 'type' => 'string', 'required' => false, 'example' => '3'], + 'UserVectorField' => ['description' => '用户向量字段。'."\n", 'type' => 'string', 'required' => false, 'example' => 'user_embedding'], + 'ItemVectorRecallManagementTableId' => ['description' => '物品向量召回表ID。'."\n", 'type' => 'string', 'required' => false, 'example' => '4'], + 'ItemVectorField' => ['description' => '物品向量字段。'."\n", 'type' => 'string', 'required' => false, 'example' => 'item_embedding'], + 'ItemConditionArray' => ['description' => '物品条件，设置数组格式条件。', 'type' => 'string', 'required' => false, 'example' => '[{"option":"<","field":"category","type":"STRING","value":"10"}]'], + 'ItemConditionExpression' => ['title' => '物品条件过滤表达式。', 'description' => '物品条件表达式。', 'type' => 'string', 'required' => false, 'example' => 'age>20'], + 'SortFields' => ['description' => '排序字段。', 'type' => 'string', 'required' => false, 'example' => 'name'], 'Operators' => [ 'description' => '算子列表。'."\n", 'type' => 'array', @@ -3828,53 +2760,23 @@ 'description' => '算子详情。', 'type' => 'object', 'properties' => [ - 'OperatorType' => [ - 'description' => '算子类型。', - 'type' => 'string', - 'required' => false, - 'example' => 'Filter', - ], + 'OperatorType' => ['description' => '算子类型。', 'type' => 'string', 'required' => false, 'example' => 'Filter'], 'TriggerConfig' => [ - 'description' => '**Trigger算子的配置。**'."\n", + 'description' => 'Trigger算子的配置。', 'type' => 'object', 'properties' => [ - 'Field' => [ - 'description' => '**字段名称。**'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'user_id', - ], - 'IsRandSort' => [ - 'description' => '**是否随机排序。**'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'false', - ], - 'SortField' => [ - 'description' => '**排序字段。**'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'create_time', - ], - 'FieldQuantityLimit' => [ - 'description' => '**字段数量限制。**'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '20', - ], + 'Field' => ['description' => '字段名称。', 'type' => 'string', 'required' => false, 'example' => 'user_id'], + 'IsRandSort' => ['description' => '是否随机排序。', 'type' => 'boolean', 'required' => false, 'example' => 'false'], + 'SortField' => ['description' => '排序字段。', 'type' => 'string', 'required' => false, 'example' => 'create_time'], + 'FieldQuantityLimit' => ['description' => '字段数量限制。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '20'], ], 'required' => false, ], 'FilterConfig' => [ - 'description' => '**过滤算子的配置。**'."\n", + 'description' => '过滤算子的配置。', 'type' => 'object', 'properties' => [ - 'Experession' => [ - 'description' => '过滤表达式。', - 'type' => 'string', - 'required' => false, - 'example' => 'age>20', - ], + 'Experession' => ['description' => '过滤表达式。', 'type' => 'string', 'required' => false, 'example' => 'age>20'], ], 'required' => false, ], @@ -3882,24 +2784,9 @@ 'description' => '特征算子的配置。'."\n", 'type' => 'object', 'properties' => [ - 'Name' => [ - 'description' => '特征名称。'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'city', - ], - 'Type' => [ - 'description' => '特征类型。'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'string', - ], - 'Expression' => [ - 'description' => '特征表达式。'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'category=3', - ], + 'Name' => ['description' => '特征名称。'."\n", 'type' => 'string', 'required' => false, 'example' => 'city'], + 'Type' => ['description' => '特征类型。'."\n", 'type' => 'string', 'required' => false, 'example' => 'string'], + 'Expression' => ['description' => '特征表达式。'."\n", 'type' => 'string', 'required' => false, 'example' => 'category=3'], ], 'required' => false, ], @@ -3907,27 +2794,12 @@ 'description' => 'Join算子的配置。'."\n", 'type' => 'object', 'properties' => [ - 'Field' => [ - 'description' => '**Join字段。**', - 'type' => 'string', - 'required' => false, - 'example' => 'item_id', - ], - 'RecallManagementTableId' => [ - 'description' => '**Join表ID。**', - 'type' => 'string', - 'required' => false, - 'example' => '4', - ], + 'Field' => ['description' => '**Join字段。**', 'type' => 'string', 'required' => false, 'example' => 'item_id'], + 'RecallManagementTableId' => ['description' => '**Join表ID。**', 'type' => 'string', 'required' => false, 'example' => '4'], 'OutputFields' => [ 'description' => '**返回字段。**', 'type' => 'array', - 'items' => [ - 'description' => '返回字段。', - 'type' => 'string', - 'required' => false, - 'example' => 'item_id', - ], + 'items' => ['description' => '返回字段。', 'type' => 'string', 'required' => false, 'example' => 'item_id'], 'required' => false, 'example' => 'item_id', ], @@ -3939,24 +2811,7 @@ ], 'required' => false, ], - 'ExtendedConfig' => [ - 'description' => '**额外配置，方便以后功能扩展。**', - 'type' => 'string', - 'required' => false, - 'example' => '""', - ], - 'ItemConditionArray' => [ - 'description' => '**物品条件，设置数组格式条件**', - 'type' => 'string', - 'required' => false, - 'example' => '[{"option":"<","field":"category","type":"STRING","value":"10"}]', - ], - 'ItemConditionExpression' => [ - 'title' => '物品条件过滤表达式。', - 'type' => 'string', - 'required' => false, - 'example' => 'age>10', - ], + 'ExtendedConfig' => ['description' => '**额外配置，方便以后功能扩展。**', 'type' => 'string', 'required' => false, 'example' => '""'], ], 'required' => false, ], @@ -3966,58 +2821,23 @@ 'description' => '**归并配置。**', 'type' => 'object', 'properties' => [ - 'RecallManagementServiceVersionConfigId' => [ - 'description' => '召回管理服务版本配置ID。'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '1', - ], - 'MergeType' => [ - 'description' => '归并类型，枚举值：`Weight`：权重 `Alternate`：交替'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'Weight', - ], + 'RecallManagementServiceVersionConfigId' => ['description' => '召回管理服务版本配置ID。'."\n", 'type' => 'string', 'required' => false, 'example' => '1'], + 'MergeType' => ['description' => '归并类型，枚举值：`Weight`：权重 `Alternate`：交替'."\n", 'type' => 'string', 'required' => false, 'example' => 'Weight'], 'FilterRecallManagementTableIds' => [ 'description' => '过滤表ID。'."\n", 'type' => 'array', - 'items' => [ - 'description' => '过滤表ID列表。', - 'type' => 'string', - 'required' => false, - 'example' => '3', - ], + 'items' => ['description' => '过滤表ID列表。', 'type' => 'string', 'required' => false, 'example' => '3'], 'required' => false, ], - 'ItemRecallManagementTableId' => [ - 'description' => '物品表ID。'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '2', - ], + 'ItemRecallManagementTableId' => ['description' => '物品表ID。'."\n", 'type' => 'string', 'required' => false, 'example' => '2'], 'ItemTableFields' => [ 'description' => '物品表输出字段。'."\n", 'type' => 'array', - 'items' => [ - 'description' => '物品表输出字段列表。', - 'type' => 'string', - 'required' => false, - 'example' => 'item_id', - ], - 'required' => false, - ], - 'ExtendedConfig' => [ - 'description' => '归并配置的一些额外配置，方便以后功能扩展。', - 'type' => 'string', + 'items' => ['description' => '物品表输出字段列表。', 'type' => 'string', 'required' => false, 'example' => 'item_id'], 'required' => false, - 'example' => '{"":""}', - ], - 'FilterExpression' => [ - 'description' => '过滤表达式。', - 'type' => 'string', - 'required' => false, - 'example' => 'age>10', ], + 'FilterExpression' => ['description' => '过滤表达式。', 'type' => 'string', 'required' => false, 'example' => 'age>10'], + 'ExtendedConfig' => ['description' => '归并配置的一些额外配置，方便以后功能扩展。', 'type' => 'string', 'required' => false, 'example' => '{"":""}'], ], 'required' => false, ], @@ -4036,25 +2856,13 @@ 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => '请求id。', - 'type' => 'string', - 'example' => '728C5E01-ABF6-5AA8-B9FC-B3BA05DECC77', - ], - 'RecallManagementServiceVersionId' => [ - 'description' => '召回管理服务版本ID。', - 'type' => 'string', - 'example' => '1', - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => '请求id。', 'type' => 'string', 'example' => '728C5E01-ABF6-5AA8-B9FC-B3BA05DECC77'], + 'RecallManagementServiceVersionId' => ['description' => '召回管理服务版本ID。', 'type' => 'string', 'example' => '1'], ], ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"728C5E01-ABF6-5AA8-B9FC-B3BA05DECC77\\",\\n \\"RecallManagementServiceVersionId\\": \\"1\\"\\n}","type":"json"}]', + 'staticInfo' => ['returnType' => 'synchronous'], 'title' => '创建召回管理服务版本', 'description' => '## 请求说明'."\n" .'- 该API允许用户为特定的召回管理服务创建新的版本。'."\n" @@ -4063,63 +2871,166 @@ .'- 提供了灵活的算子配置选项，如过滤、触发、特征提取和Join操作，以满足不同的业务需求。'."\n" .'- 归并配置允许设置如何合并多个召回结果，支持权重或交替两种归并方式。'."\n" .'- 所有配置项均为可选项，根据实际需要进行填写。'."\n", - ], - 'CreateRecallManagementService' => [ - 'summary' => '此API用于创建一个新的召回管理服务。', - 'path' => '/api/v1/recallmanagementservices', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'pairec:CreateRecallManagementServiceVersion', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIRecService', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"728C5E01-ABF6-5AA8-B9FC-B3BA05DECC77\\",\\n \\"RecallManagementServiceVersionId\\": \\"1\\"\\n}","type":"json"}]', + ], + 'CreateRecallManagementServiceVersionConfig' => [ + 'summary' => '用于创建指定召回管理服务版本的配置，包括召回和归并设置。', + 'path' => '/api/v1/recallmanagementservices/{RecallManagementServiceId}/versions/{RecallManagementServiceVersionId}/configs', + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'create', + 'operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATURElearnN0NAWV', - ], + 'abilityTreeNodes' => ['FEATURElearnN0NAWV'], ], 'parameters' => [ [ + 'name' => 'RecallManagementServiceId', + 'in' => 'path', + 'schema' => ['description' => '召回管理服务ID。'."\n", 'type' => 'string', 'required' => false, 'example' => '2'], + ], + [ + 'name' => 'RecallManagementServiceVersionId', + 'in' => 'path', + 'schema' => ['description' => '召回管理服务版本ID。'."\n", 'type' => 'string', 'required' => false, 'example' => '3'], + ], + [ 'name' => 'body', 'in' => 'body', 'style' => 'json', 'schema' => [ - 'description' => '请求body。', + 'description' => '请求Body。', 'type' => 'object', 'properties' => [ - 'InstanceId' => [ - 'description' => '**实例ID。**'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'pairec-cn-test123', - ], - 'Name' => [ - 'description' => '**召回服务名称。**'."\n", - 'type' => 'string', + 'InstanceId' => ['description' => '实例ID。'."\n", 'type' => 'string', 'required' => false, 'example' => 'pai-teest-1'], + 'ConfigType' => ['description' => '召回管理版本配置类型。枚举值：Recall：召回配置。Merge：归并配置。'."\n", 'type' => 'string', 'required' => false, 'example' => 'Recall'], + 'RecallConfig' => [ + 'description' => '召回配置。'."\n", + 'type' => 'object', + 'properties' => [ + 'Name' => ['description' => '召回名称。'."\n", 'type' => 'string', 'required' => false, 'example' => 'etrec'], + 'Description' => ['description' => '召回描述。'."\n", 'type' => 'string', 'required' => false, 'example' => 'this is etrec recall'], + 'Priority' => ['description' => '优先级。数字越小，优先级越高'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '2'], + 'RecallType' => ['description' => '召回类型。'."\n", 'type' => 'string', 'required' => false, 'example' => 'X2I'], + 'RecallManagementTableId' => ['description' => '召回管理表ID。'."\n", 'type' => 'string', 'required' => false, 'example' => '3'], + 'UserVectorRecallManagementTableId' => ['description' => '用户向量召回表ID。'."\n", 'type' => 'string', 'required' => false, 'example' => '4'], + 'UserVectorField' => ['description' => '用户向量字段。'."\n", 'type' => 'string', 'required' => false, 'example' => 'user_embedding'], + 'ItemVectorRecallManagementTableId' => ['description' => '物品向量召回表ID。'."\n", 'type' => 'string', 'required' => false, 'example' => '5'], + 'ItemVectorField' => ['description' => '物品向量字段。'."\n", 'type' => 'string', 'required' => false, 'example' => 'item_embedding'], + 'ItemConditionArray' => ['description' => '物品条件，设置数组格式条件'."\n", 'type' => 'string', 'required' => false, 'example' => '[{"option":"<","field":"category","type":"STRING","value":"10"}]'], + 'ItemConditionExpression' => ['title' => '物品条件表达式。', 'description' => '物品条件表达式。', 'type' => 'string', 'required' => false, 'example' => 'age>20'], + 'SortFields' => ['description' => '排序字段。', 'type' => 'string', 'required' => false, 'example' => 'name'], + 'Operators' => [ + 'description' => '算子列表。'."\n", + 'type' => 'array', + 'items' => [ + 'description' => '算子详情。', + 'type' => 'object', + 'properties' => [ + 'OperatorType' => ['description' => '算子类型，枚举值：FilterFeatureTriggerFeature'."\n", 'type' => 'string', 'required' => false, 'example' => 'Filter'], + 'TriggerConfig' => [ + 'description' => 'Trigger算子的配置。'."\n", + 'type' => 'object', + 'properties' => [ + 'Field' => ['description' => '字段名称。'."\n", 'type' => 'string', 'required' => false, 'example' => 'user_id'], + 'IsRandSort' => ['description' => '是否随机排序。'."\n", 'type' => 'boolean', 'required' => false, 'example' => 'false'], + 'SortField' => ['description' => '排序字段。'."\n", 'type' => 'string', 'required' => false, 'example' => 'create_time'], + 'FieldQuantityLimit' => ['description' => '字段数量限制。'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '20'], + ], + 'required' => false, + ], + 'FilterConfig' => [ + 'description' => '过滤算子的配置。'."\n", + 'type' => 'object', + 'properties' => [ + 'Experession' => ['description' => '过滤表达式。', 'type' => 'string', 'required' => false, 'example' => 'age>20'], + ], + 'required' => false, + ], + 'FeatureConfig' => [ + 'description' => '**特征算子的配置。**'."\n", + 'type' => 'object', + 'properties' => [ + 'Name' => ['description' => '**特征名称。**'."\n", 'type' => 'string', 'required' => false, 'example' => 'city'], + 'Type' => ['description' => '**特征类型。**'."\n", 'type' => 'string', 'required' => false, 'example' => 'string'], + 'Expression' => ['description' => '**特征表达式。**'."\n", 'type' => 'string', 'required' => false, 'example' => 'category=3'], + ], + 'required' => false, + ], + 'JoinConfig' => [ + 'description' => '**Join算子的配置。**'."\n", + 'type' => 'object', + 'properties' => [ + 'Field' => ['description' => 'Join字段。'."\n", 'type' => 'string', 'required' => false, 'example' => 'item_id'], + 'RecallManagementTableId' => ['description' => 'Join表ID。'."\n", 'type' => 'string', 'required' => false, 'example' => '3'], + 'OutputFields' => [ + 'description' => '返回字段。'."\n", + 'type' => 'array', + 'items' => ['description' => '返回字段列表。', 'type' => 'string', 'required' => false, 'example' => 'lang'], + 'required' => false, + ], + ], + 'required' => false, + ], + ], + 'required' => false, + ], + 'required' => false, + ], + 'ExtendedConfig' => ['description' => '额外配置，方便以后功能扩展。'."\n", 'type' => 'string', 'required' => false, 'example' => '""'], + ], 'required' => false, - 'example' => 'hot_global_recall', ], - 'Description' => [ - 'description' => '**召回服务描述。**'."\n", - 'type' => 'string', + 'MergeConfig' => [ + 'description' => '归并配置。'."\n", + 'type' => 'object', + 'properties' => [ + 'RecallManagementServiceVersionConfigId' => ['description' => '召回管理服务版本配置ID。'."\n", 'type' => 'string', 'required' => false, 'example' => '1'], + 'MergeType' => ['description' => '归并类型，枚举值：Weight：权重Alternate：交替'."\n", 'type' => 'string', 'required' => false, 'example' => 'Weight'], + 'FilterRecallManagementTableIds' => [ + 'description' => '过滤表ID。'."\n", + 'type' => 'array', + 'items' => ['description' => '过滤表ID列表。', 'type' => 'string', 'required' => false, 'example' => '3'], + 'required' => false, + ], + 'ItemRecallManagementTableId' => ['description' => '物品表ID。'."\n", 'type' => 'string', 'required' => false, 'example' => '2'], + 'ItemTableFields' => [ + 'description' => '物品表输出字段。'."\n", + 'type' => 'array', + 'items' => ['description' => '物品表输出字段列表。', 'type' => 'string', 'required' => false, 'example' => 'item_id'], + 'required' => false, + ], + 'FilterExpression' => ['description' => '过滤表达式。', 'type' => 'string', 'required' => false, 'example' => 'age>20'], + 'ExtendedConfig' => ['description' => '归并配置的一些额外配置，方便以后功能扩展。'."\n", 'type' => 'string', 'required' => false, 'example' => '""'], + ], 'required' => false, - 'example' => 'this is a test recall', ], ], 'required' => false, @@ -4133,63 +3044,57 @@ 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => '**请求id。**'."\n", - 'type' => 'string', - 'example' => '728C5E01-ABF6-5AA8-B9FC-B3BA05DECC77', - ], - 'RecallManagementServiceId' => [ - 'description' => '召回服务管理ID。'."\n", - 'type' => 'string', - 'example' => '1', - ], - 'RecallManagementServiceVersionId' => [ - 'description' => '召回服务管理版本ID。'."\n", - 'type' => 'string', - 'example' => '3', - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => '请求id。'."\n", 'type' => 'string', 'example' => 'F8F613A9-DF1C-551A-88E1-397A3981A785'], + 'RecallManagementServiceVersionConfigId' => ['description' => '召回管理服务版本配置ID。'."\n", 'type' => 'string', 'example' => '1'], ], ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"728C5E01-ABF6-5AA8-B9FC-B3BA05DECC77\\",\\n \\"RecallManagementServiceId\\": \\"1\\",\\n \\"RecallManagementServiceVersionId\\": \\"3\\"\\n}","type":"json"}]', - 'title' => '创建召回管理服务', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '创建召回管理服务版本配置', 'description' => '## 请求说明'."\n" - .'通过调用此API，您可以基于指定的实例ID、服务名称和服务描述来创建一个召回管理服务。请确保提供的参数值符合要求，特别是`InstanceId`必须是有效的实例标识符。'."\n", - ], - 'CreateRecallManagementConfig' => [ - 'summary' => '用于初始化召回管理的配置，包括实例ID、用户信息及网络设置。', - 'path' => '/api/v1/recallmanagementconfigs', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', + .'- 该API允许用户为特定的召回管理服务版本创建配置。'."\n" + .'- 配置类型可以是召回（Recall）或归并（Merge），具体取决于`ConfigType`参数。'."\n" + .'- `RecallConfig`和`MergeConfig`分别对应召回配置和归并配置的具体内容，根据实际需求填写相应字段。'."\n" + .'- 注意确保所有必填参数都已正确提供，并且遵循给定的数据格式要求。'."\n" + .'- 对于非必需但提供的参数，请确保其值符合业务逻辑预期。'."\n", + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'pairec:CreateRecallManagementServiceVersionConfig', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIRecService', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"F8F613A9-DF1C-551A-88E1-397A3981A785\\",\\n \\"RecallManagementServiceVersionConfigId\\": \\"1\\"\\n}","type":"json"}]', + ], + 'CreateRecallManagementTable' => [ + 'path' => '/api/v1/recallmanagementtables', + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATURElearnN0NAWV', - ], + 'abilityTreeNodes' => ['FEATURElearnN0NAWV'], ], 'parameters' => [ [ @@ -4197,55 +3102,53 @@ 'in' => 'body', 'style' => 'json', 'schema' => [ - 'description' => '请求Body。', + 'description' => '请求body。', 'type' => 'object', 'properties' => [ - 'InstanceId' => [ - 'description' => '**实例ID**'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'learn-pairec-xxx', - ], - 'UserName' => [ - 'description' => '**用户名**'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'zhhangsan', - ], - 'Password' => [ - 'description' => '**密码**'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '12345', - ], - 'NetworkConfigs' => [ - 'description' => '**网络配置**'."\n", + 'InstanceId' => ['description' => '**实例ID**'."\n", 'type' => 'string', 'required' => true, 'example' => 'pairec-cn-test123'], + 'Name' => ['description' => '**表名称。**'."\n", 'type' => 'string', 'required' => false, 'example' => 'table-123'], + 'Description' => ['description' => '**表备注。**'."\n", 'type' => 'string', 'required' => false, 'example' => 'this is a test table'], + 'Type' => ['description' => '**表类型。**'."\n", 'type' => 'string', 'required' => false, 'example' => 'Recall'], + 'RecallType' => ['description' => '表的召回类型。', 'type' => 'string', 'required' => false, 'example' => 'X2I'], + 'DataSource' => ['description' => '数据来源。'."\n", 'type' => 'string', 'required' => false, 'example' => 'MaxcomputeAndApiApi'], + 'MaxcomputeProjectName' => ['description' => 'maxcompute 项目。'."\n", 'type' => 'string', 'required' => false, 'example' => 'test'], + 'MaxcomputeTableName' => ['description' => 'maxcompute 中表名。'."\n", 'type' => 'string', 'required' => false, 'example' => 'table-1'], + 'Fields' => [ + 'description' => '字段列表。', 'type' => 'array', 'items' => [ - 'description' => '网络配置信息。', + 'description' => '字段详情。', 'type' => 'object', 'properties' => [ - 'VpcId' => [ - 'description' => 'Vpc id'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'vpc-xxx', - ], - 'VSwitchIds' => [ - 'description' => '可用区和交换机ID信息'."\n", - 'type' => 'object', + 'Name' => ['description' => '字段名称。', 'type' => 'string', 'required' => false, 'example' => 'age'], + 'Type' => ['description' => '字段类型。'."\n", 'type' => 'string', 'required' => false, 'example' => 'STRING(全大写)'], + 'Attributes' => [ + 'description' => '枚举值：'."\n" + .'- Primary：主键字段'."\n" + .'- Item：物品字段'."\n" + .'- Score：召回分字段'."\n" + .'- Vector：向量字段'."\n" + .'- Index：索引字段'."\n" + .'字段属性。'."\n", + 'type' => 'array', + 'items' => ['description' => '字段属性。', 'type' => 'string', 'required' => false, 'example' => 'Primary'], 'required' => false, - 'additionalProperties' => [ - 'type' => 'string', - 'description' => '交换机ID。', - 'example' => 'vsw-xxx', - ], ], + 'VectorDimension' => ['description' => '向量维度。'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '32'], + 'VectorMetricType' => ['description' => '向量指标类型。'."\n", 'type' => 'string', 'required' => false, 'example' => 'L2'], ], 'required' => false, ], 'required' => false, ], + 'Config' => ['description' => '表的一些额外配置'."\n", 'type' => 'string', 'required' => false, 'example' => '{"":""}'], + 'EnableRowCountFluctuationThreshold' => ['description' => '是否启动表数据条目波动阈值'."\n", 'type' => 'boolean', 'required' => false, 'example' => 'true'], + 'MinRowCountFluctuationThreshold' => ['description' => '表数据条目波动阈值最小值'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '10'], + 'MaxRowCountFluctuationThreshold' => ['description' => '表数据条目波动阈值最大值'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '100'], + 'EnableDataSizeFluctuationThreshold' => ['description' => '是否启动表大小波动阈值'."\n", 'type' => 'boolean', 'required' => false, 'example' => 'true'], + 'MinDataSizeFluctuationThreshold' => ['description' => '表大小波动阈值最小值'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '10'], + 'MaxDataSizeFluctuationThreshold' => ['description' => '表大小波动阈值最大值。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '100'], + 'MaxcomputeSchema' => ['description' => '**maxcompute 的schema**'."\n", 'type' => 'string', 'required' => false, 'example' => 'default'], ], 'required' => false, ], @@ -4258,82 +3161,160 @@ 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => '请求id。'."\n", - 'type' => 'string', - 'example' => '728C5E01-ABF6-5AA8-B9FC-B3BA05DECC77', - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => '**请求id。**'."\n", 'type' => 'string', 'example' => '728C5E01-ABF6-5AA8-B9FC-B3BA05DECC77'], + 'RecallManagementTableId' => ['description' => '**表ID。**'."\n", 'type' => 'string', 'example' => '3'], ], ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '创建召回管理表', + 'summary' => '用于创建一个新的召回管理表，支持多种数据源和配置选项。', + 'description' => '## 请求说明'."\n" + .'- **InstanceId**、**Name**、**Description**、**Type** 和 **DataSource** 是必填项。'."\n" + .'- **RecallType** 可选，但若指定则必须符合枚举值要求。'."\n" + .'- **Fields** 中的每个字段需要定义其名称（Name）、类型（Type）以及属性（Attributes），其中至少一个字段需被标记为 Primary。'."\n" + .'- 如果使用 Maxcompute 作为数据源，则 **MaxcomputeProjectName** 和 **MaxcomputeTableName** 必须提供；**MaxcomputeSchema** 是可选项。'."\n" + .'- 对于向量类型的字段，如果设置了 **VectorDimension** 和 **VectorMetricType**，请确保这些值与实际数据匹配。'."\n" + .'- **Config** 字段允许用户添加额外的配置信息，格式为 JSON 字符串。'."\n" + .'- 波动阈值相关参数（如 **EnableRowCountFluctuationThreshold** 等）提供了对表内数据条目或大小变化的监控能力，可根据需求启用并设置合理的阈值范围。'."\n", + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"728C5E01-ABF6-5AA8-B9FC-B3BA05DECC77\\"\\n}","type":"json"}]', - 'title' => '创建召回管理配置', - 'description' => '## 请求说明'."\n", + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"728C5E01-ABF6-5AA8-B9FC-B3BA05DECC77\\",\\n \\"RecallManagementTableId\\": \\"3\\"\\n}","type":"json"}]', ], - 'ListInstanceResourceSchemas' => [ - 'summary' => '此API用于查询指定实例和资源下的所有Schema信息。', - 'path' => '/api/v1/instances/{InstanceId}/resources/{ResourceId}/schemas', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'https', - ], + 'CreateScene' => [ + 'summary' => '创建一个场景，在场景下可进行指标、实验分析。', + 'path' => '/api/v1/scenes', + 'methods' => ['post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], - 'operationType' => 'read', + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'none', + 'operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATURElearnN0NAWV', - ], + 'abilityTreeNodes' => ['FEATURElearnN0NAWV'], ], 'parameters' => [ [ - 'name' => 'InstanceId', - 'in' => 'path', + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', 'schema' => [ - 'description' => '实例ID。', - 'type' => 'string', + 'description' => '请求body。', + 'type' => 'object', + 'properties' => [ + 'Name' => ['title' => '场景名称。', 'description' => '场景名称。', 'type' => 'string', 'required' => false, 'example' => 'scene1'], + 'Description' => ['title' => '场景描述。', 'description' => '场景描述。', 'type' => 'string', 'required' => false, 'example' => 'This is a test.'], + 'InstanceId' => ['title' => '实例ID。', 'description' => '实例ID，可通过接口ListInstances获取。', 'type' => 'string', 'required' => false, 'example' => 'pairec-cn-abcdefg1234'], + 'Flows' => [ + 'title' => '流量列表。', + 'description' => '流量列表。', + 'type' => 'array', + 'items' => [ + 'description' => '流量。', + 'type' => 'object', + 'properties' => [ + 'FlowName' => ['title' => '流量名称。', 'description' => '流量名称。', 'type' => 'string', 'required' => false, 'example' => '流量1'], + 'FlowCode' => ['title' => '流量编码。', 'description' => '流量编码。', 'type' => 'string', 'required' => false, 'example' => 'liuliang1'], + ], + 'required' => false, + ], + 'required' => false, + ], + ], 'required' => false, - 'example' => 'featureStore-cn-test1', ], ], - [ - 'name' => 'ResourceId', - 'in' => 'path', + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => '资源ID。', - 'type' => 'string', - 'required' => false, - 'example' => '3', + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => 'FCF741D8-9C30-578E-807F-B935487DB34A'], + 'SceneId' => ['title' => '场景ID。', 'description' => '场景ID。', 'type' => 'string', 'example' => '3'], + ], + ], + ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"FCF741D8-9C30-578E-807F-B935487DB34A\\",\\n \\"SceneId\\": \\"3\\"\\n}","type":"json"}]', + 'title' => '创建场景', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'pairec:CreateScene', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIRecService', 'resourceType' => '全部资源', 'arn' => '*'], + ], ], ], + ], + ], + 'CreateSubCrowd' => [ + 'summary' => '在指定人群下创建子人群。', + 'path' => '/api/v1/crowds/{CrowdId}/subcrowds', + 'methods' => ['post'], + 'schemes' => ['http', 'https'], + 'security' => [ [ - 'name' => 'SchemaName', - 'in' => 'query', + 'AK' => [], + ], + ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATURElearnN0NAWV'], + ], + 'parameters' => [ + [ + 'name' => 'CrowdId', + 'in' => 'path', + 'schema' => ['title' => '人群ID。', 'description' => '人群ID，可通过接口ListCrowds获取。', 'type' => 'string', 'required' => true, 'example' => '3'], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', 'schema' => [ - 'description' => 'schema名称前缀匹配过滤。', - 'type' => 'string', + 'title' => '请求body。', + 'description' => '请求body。', + 'type' => 'object', + 'properties' => [ + 'Source' => ['title' => '人群来源。'."\n" + .'● ManualInput-手工输入'."\n" + .'● UploadFile-文件上传', 'description' => '人群来源。'."\n" + .'● ManualInput-手工输入'."\n" + .'● UploadFile-文件上传', 'type' => 'string', 'required' => true, 'example' => 'ManualInput'], + 'Users' => ['title' => '人群中包含的用户，多个用户间用逗号隔开。', 'description' => '人群中包含的用户，多个用户间用逗号隔开。', 'type' => 'string', 'required' => true, 'example' => 'user1,user2,user3'], + 'InstanceId' => ['title' => '实例ID。', 'description' => '实例ID，可通过接口ListInstances获取。', 'type' => 'string', 'required' => true, 'example' => 'pairec-test1'], + ], 'required' => false, - 'example' => 'default', ], ], ], @@ -4344,104 +3325,185 @@ 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => '请求id。', - 'type' => 'string', - 'example' => '728C5E01-ABF6-5AA8-B9FC-B3BA05DECC77', - ], - 'TotalCount' => [ - 'description' => '总个数。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '10', - ], - 'Schemas' => [ - 'description' => 'schema列表。', + 'RequestId' => ['title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => '9763624B-5FBB-5E3A-9193-B1ADB554CEAE'], + 'SubCrowdId' => ['title' => '子人群ID。', 'description' => '子人群ID。', 'type' => 'string', 'example' => '3'], + ], + ], + ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"9763624B-5FBB-5E3A-9193-B1ADB554CEAE\\",\\n \\"SubCrowdId\\": \\"3\\"\\n}","type":"json"}]', + 'title' => '创建子人群', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'pairec:CreateSubCrowd', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIRecService', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + ], + ], + 'CreateTableMeta' => [ + 'summary' => '创建数据表。', + 'path' => '/api/v1/tablemetas', + 'methods' => ['post'], + 'schemes' => ['http', 'https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATURElearnN0NAWV'], + ], + 'parameters' => [ + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', + 'schema' => [ + 'description' => '请求体参数。', + 'type' => 'object', + 'properties' => [ + 'Name' => ['description' => '数据表名称。', 'type' => 'string', 'required' => true, 'example' => 'table_test'], + 'ResourceId' => ['description' => '资源 ID，可通过ListInstanceResources获取。', 'type' => 'string', 'required' => true, 'example' => 'reso-2s416t146ffjc3yefx'], + 'TableName' => ['description' => '数据库中的表名。', 'type' => 'string', 'required' => true, 'example' => 'table_mysql'], + 'Module' => ['description' => '表的模块。'."\n" + ."\n" + .'- ABTest-实验数据表。'."\n" + ."\n" + .'- ExperimentTool-实验工具表。'."\n" + ."\n" + .'- DataDiagnosis-数据诊断', 'type' => 'string', 'required' => true, 'example' => 'ABTest'], + 'InstanceId' => ['description' => '实例ID，可通过接口[ListInstances](~~2411819~~)获取。', 'type' => 'string', 'required' => true, 'example' => 'pairec-cn-test123'], + 'Fields' => [ + 'description' => '字段列表。', 'type' => 'array', 'items' => [ + 'description' => '字段信息。', 'type' => 'object', 'properties' => [ - 'SchemaName' => [ - 'description' => 'schema名称。', + 'Name' => ['description' => '字段名称。', 'type' => 'string', 'required' => true, 'example' => 'gender'], + 'Meaning' => ['description' => '字段含义。', 'type' => 'string', 'required' => true, 'example' => 'this is gender of people'], + 'Type' => ['description' => '字段类型。', 'type' => 'string', 'required' => true, 'example' => 'BIGINT'], + 'IsDimensionField' => ['description' => '是否是维度字段。', 'type' => 'boolean', 'required' => true, 'example' => 'false'], + 'DataType' => [ + 'description' => '字段的数据类型。', 'type' => 'string', - 'example' => 'default', + 'required' => false, + 'enumValueTitles' => ['number' => '数字', 'image' => '图片', 'text' => '文本', 'video' => '视频', 'primary_key' => '主键', 'url' => '超链接'], + 'example' => 'primary_key', ], + 'IsPartitionField' => ['description' => '是否为分区字段。', 'type' => 'string', 'required' => true, 'example' => 'true'], ], + 'required' => false, ], + 'required' => true, ], + 'Description' => ['description' => '数据表描述。', 'type' => 'string', 'required' => true, 'example' => 'this is a test table'], ], + 'required' => false, ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => '728C5E01-ABF6-5AA8-B9FC-B3BA05DECC77'], + 'TableMetaId' => ['description' => '数据表ID。', 'type' => 'string', 'example' => '2'], + ], + ], + ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"728C5E01-ABF6-5AA8-B9FC-B3BA05DECC77\\",\\n \\"TotalCount\\": 10,\\n \\"Schemas\\": [\\n {\\n \\"SchemaName\\": \\"default\\"\\n }\\n ]\\n}","type":"json"}]', - 'title' => '获取实例资源下的Schema', - 'description' => '## 请求说明'."\n" - .'通过提供实例ID（InstanceId）和资源ID（ResourceId），可以获取该实例资源下的所有Schema列表。可选参数SchemaName支持根据名称前缀进行过滤，以更精确地定位所需的Schema。'."\n", - ], - 'ListInstanceResourceTables' => [ - 'summary' => '此API用于查询指定实例和数据源下的所有数据表。', - 'path' => '/api/v1/instances/{InstanceId}/resources/{ResourceId}/tables', - 'methods' => [ - 'get', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"728C5E01-ABF6-5AA8-B9FC-B3BA05DECC77\\",\\n \\"TableMetaId\\": \\"2\\"\\n}","type":"json"}]', + 'title' => '创建数据表', + 'changeSet' => [ + ['createdAt' => '2024-02-22T03:35:42.000Z', 'description' => '请求参数发生变更'], ], - 'schemes' => [ - 'http', - 'https', + 'flowControl' => [ + 'flowControlList' => [], ], + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'pairec:CreateTableMeta', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIRecService', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + ], + ], + 'CreateTrafficControlTarget' => [ + 'summary' => '用于创建新的流量调控目标，支持设置调控条件、事件及目标值等参数。', + 'path' => '/api/v1/trafficcontroltargets', + 'methods' => ['post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], - 'operationType' => 'read', + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'list', + 'operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATURElearnN0NAWV', - ], + 'abilityTreeCode' => '220592', + 'abilityTreeNodes' => ['FEATURElearnN0NAWV'], ], 'parameters' => [ [ - 'name' => 'InstanceId', - 'in' => 'path', - 'schema' => [ - 'description' => '实例ID。'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'pairec-cn-xxx', - ], - ], - [ - 'name' => 'ResourceId', - 'in' => 'path', - 'schema' => [ - 'description' => '数据源ID。'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'reso-*********', - ], - ], - [ - 'name' => 'MaxcomputeSchema', - 'in' => 'query', + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', 'schema' => [ - 'description' => 'maxcompute 的 schema'."\n", - 'type' => 'string', + 'description' => '请求Body。', + 'type' => 'object', + 'properties' => [ + 'TrafficControlTaskId' => ['description' => '流量调控任务ID。'."\n", 'type' => 'string', 'required' => false, 'example' => '1'], + 'Name' => ['description' => '流量调控目标名称'."\n", 'type' => 'string', 'required' => false, 'example' => 'target-1'], + 'StartTime' => ['description' => '调控目标开始时间'."\n", 'type' => 'string', 'required' => false, 'example' => '2024-03-25'], + 'EndTime' => ['description' => '调控目标结束时间'."\n", 'type' => 'string', 'required' => false, 'example' => '2024-04-25'], + 'ItemConditionType' => ['description' => '物品调控的条件类型'."\n", 'type' => 'string', 'required' => false, 'example' => 'Array'], + 'ItemConditionArray' => ['description' => '物品条件，设置数组格式条件'."\n", 'type' => 'string', 'required' => false, 'example' => '[{"field":"status","option":"=","value":"1"}]'], + 'ItemConditionExpress' => ['description' => '物品条件，设置表达式格式条件'."\n", 'type' => 'string', 'required' => false, 'example' => 'status=1'], + 'Event' => ['description' => '调控目标事件'."\n", 'type' => 'string', 'required' => false, 'example' => 'click'], + 'Value' => ['description' => '调控目标值'."\n", 'type' => 'number', 'format' => 'float', 'required' => false, 'example' => '10'], + 'StatisPeriod' => ['description' => '统计周期'."\n", 'type' => 'string', 'required' => false, 'example' => 'Daily'], + 'ToleranceValue' => ['description' => '调控目标容错范围'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '10'], + 'RecallName' => ['description' => '召回策略名称'."\n", 'type' => 'string', 'required' => false, 'example' => 'recall-1'], + 'Status' => ['description' => '调控目标状态'."\n", 'type' => 'string', 'required' => false, 'example' => 'Opened'], + 'NewProductRegulation' => ['description' => '是否是新品调控'."\n", 'type' => 'boolean', 'required' => false, 'example' => 'false'], + ], 'required' => false, - 'example' => 'jackal', ], ], ], @@ -4452,74 +3514,45 @@ 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'Id of the request', - 'type' => 'string', - 'example' => '01D22D08-BA20-5F35-8302-99115F288220', - ], - 'TotalCount' => [ - 'description' => '总个数。', - 'type' => 'string', - 'example' => '30', - ], - 'Tables' => [ - 'description' => '数据表列表。', - 'type' => 'array', - 'items' => [ - 'description' => '数据表详细信息。', - 'type' => 'object', - 'properties' => [ - 'TableName' => [ - 'description' => '表名。', - 'type' => 'string', - 'example' => 'table-1', - ], - ], - ], - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => '请求id。'."\n", 'type' => 'string', 'example' => '728C5E01-ABF6-5AA8-B9FC-B3BA05DECC77'], + 'TrafficControlTargetId' => ['description' => '流量调控目标ID。'."\n", 'type' => 'string', 'example' => '1'], ], ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"01D22D08-BA20-5F35-8302-99115F288220\\",\\n \\"TotalCount\\": \\"30\\",\\n \\"Tables\\": [\\n {\\n \\"TableName\\": \\"table-1\\"\\n }\\n ]\\n}","type":"json"}]', - 'title' => '获取实例资源下数据表列表', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '创建流量调控目标', 'description' => '## 请求说明'."\n" - .'通过提供实例ID（InstanceId）和数据源ID（ResourceId），您可以获取该数据源下的所有数据表列表。可选参数`MaxcomputeSchema`允许您指定maxcompute的schema以进一步筛选结果。'."\n", + .'- `ItemConditionType` 支持两种格式：数组格式（Array）和表达式格式（Expression）。根据选择的不同，需要提供相应的`ItemConditionArray`或`ItemConditionExpress`。'."\n" + .'- `StatisPeriod` 默认为按天统计，如果需要按小时统计，请明确指定。'."\n" + .'- `ToleranceValue` 和 `NewProductRegulation` 是可选参数，仅在有特定需求时填写。'."\n" + .'- `Status` 字段允许用户控制新创建的流量调控目标是否立即生效，默认情况下可能为关闭状态。'."\n", + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"728C5E01-ABF6-5AA8-B9FC-B3BA05DECC77\\",\\n \\"TrafficControlTargetId\\": \\"1\\"\\n}","type":"json"}]', ], - 'CheckInstanceResources' => [ - 'summary' => '检测实例下配置的资源的连接状态。', - 'path' => '/api/v1/instances/{InstanceId}/action/checkresources', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'CreateTrafficControlTask' => [ + 'path' => '/api/v1/trafficcontroltasks', + 'methods' => ['post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], - 'operationType' => 'read', + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'none', + 'operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATURElearnN0NAWV', - ], + 'abilityTreeCode' => '220396', + 'abilityTreeNodes' => ['FEATURElearnN0NAWV'], ], 'parameters' => [ [ @@ -4527,71 +3560,114 @@ 'in' => 'body', 'style' => 'json', 'schema' => [ - 'description' => '请求体参数。', + 'description' => '请求body。', 'type' => 'object', 'properties' => [ - 'Type' => [ - 'description' => '资源类型。'."\n" - ."\n" - .'- Hologres'."\n" - ."\n" - .'- EAS'."\n" - ."\n" - .'- BE'."\n" - ."\n" - .'- Rec'."\n" - ."\n" - .'- Platform'."\n" - ."\n" - .'- SLS'."\n" - ."\n" - .'- DataHub'."\n" - ."\n" - .'- Kafka'."\n" - ."\n" - .'- Flinkvvp'."\n" - ."\n" - .'- ACR'."\n" - ."\n" - .'- OSS'."\n" - ."\n" - .'- DataWorks'."\n" - ."\n" - .'- PAI'."\n" - ."\n" - .'- MaxCompute'."\n" - ."\n" - .'- GraphCompute'."\n" - ."\n" - .'- Redis', - 'type' => 'string', - 'required' => true, - 'example' => 'OSS', + 'Name' => ['description' => '流量调控任务名称。', 'type' => 'string', 'required' => false, 'example' => 'task-1'], + 'Description' => ['description' => '流量调控任务备注。', 'type' => 'string', 'required' => false, 'example' => 'this is a test task'], + 'SceneId' => ['description' => '场景ID，可通过接口[ListScenes](~~2402581~~)获取。', 'type' => 'string', 'required' => false, 'example' => '1'], + 'ExecutionTime' => ['description' => '执行时间.'."\n" + ."\n" + .'- Permanent：永久执行。'."\n" + ."\n" + .'- TimeRange: 指定时间范围。选择此参数时，需要指定 StartTime 和 EndTime。', 'type' => 'string', 'required' => false, 'example' => 'TimeRange'], + 'StartTime' => ['description' => '开始时间。', 'type' => 'string', 'required' => false, 'example' => '2024-03-25'], + 'EndTime' => ['description' => '结束时间。', 'type' => 'string', 'required' => false, 'example' => '2024-03-26'], + 'BehaviorTableMetaId' => ['description' => '行为表表ID。', 'type' => 'string', 'required' => false, 'example' => '1'], + 'UserTableMetaId' => ['description' => '用户表表ID。', 'type' => 'string', 'required' => false, 'example' => '2'], + 'ItemTableMetaId' => ['description' => '物品表表ID。', 'type' => 'string', 'required' => false, 'example' => '3'], + 'UserConditionType' => ['description' => '干预人群条件类型。'."\n" + ."\n" + .'- Array：数组格式。'."\n" + ."\n" + .'- Expression：表达式格式。', 'type' => 'string', 'required' => false, 'example' => 'Array'], + 'UserConditionArray' => ['description' => '干预人群，数组格式条件。', 'type' => 'string', 'required' => false, 'example' => '[{\\"field\\":\\"gender\\",\\"option\\":\\"=\\",\\"value\\":\\"male\\"}]'], + 'UserConditionExpress' => ['description' => '干预人群，表达式格式条件。', 'type' => 'string', 'required' => false, 'example' => 'age<=30&&(3<=level<=6)&&gender=male'], + 'StatisBehaviorConditionType' => ['description' => '统计行为条件类型。'."\n" + ."\n" + .'- Array：数组格式。'."\n" + ."\n" + .'- Expression：表达式格式。', 'type' => 'string', 'required' => false, 'example' => 'Array'], + 'StatisBehaviorConditionArray' => ['description' => '统计行为，数组格式条件。', 'type' => 'string', 'required' => false, 'example' => '[{\\"field\\":\\"click\\",\\"option\\":\\"<=\\",\\"value\\":\\"30\\"}]'], + 'StatisBehaviorConditionExpress' => ['description' => '统计行为，表达式格式条件。', 'type' => 'string', 'required' => false, 'example' => 'click=30'], + 'ControlType' => ['description' => '调控类型。'."\n" + ."\n" + .'- Percent：按比例调控。'."\n" + ."\n" + .'- Quantity：按数量调控。', 'type' => 'string', 'required' => false, 'example' => 'Percent'], + 'ControlGranularity' => ['description' => '调控粒度。'."\n" + .'Global：全局。'."\n" + .'Single：单品。', 'type' => 'string', 'required' => false, 'example' => 'Global'], + 'ControlLogic' => ['description' => '调控逻辑。'."\n" + ."\n" + .'- Guaranteed：保量。'."\n" + ."\n" + .'- Approach：逼近。', 'type' => 'string', 'required' => false, 'example' => 'Guaranteed'], + 'ItemConditionType' => ['description' => '物品条件类型。'."\n" + ."\n" + .'- Array：数组格式。'."\n" + ."\n" + .'- Expression：表达式格式。', 'type' => 'string', 'required' => false, 'example' => 'Array'], + 'ItemConditionExpress' => ['description' => '物品条件，表达式格式条件', 'type' => 'string', 'required' => false, 'example' => 'status=1'], + 'TrafficControlTargets' => [ + 'description' => '流量调控目标列表。', + 'type' => 'array', + 'items' => [ + 'description' => '流量调控目标。', + 'type' => 'object', + 'properties' => [ + 'Name' => ['description' => '流量调控目标名称。', 'type' => 'string', 'required' => false, 'example' => 'target_1'], + 'StartTime' => ['description' => '调控目标开始时间。', 'type' => 'string', 'required' => false, 'example' => '2024-03-25'], + 'EndTime' => ['description' => '调控目标结束时间。', 'type' => 'string', 'required' => false, 'example' => '2024-04-25'], + 'ItemConditionType' => ['description' => '物品调控的条件类型。'."\n" + ."\n" + .'- Array：数组格式。'."\n" + ."\n" + .'- Expression：表达式格式。', 'type' => 'string', 'required' => false, 'example' => 'Array'], + 'ItemConditionArray' => ['description' => '物品条件，数组格式条件。', 'type' => 'string', 'required' => false, 'example' => '[{\\"field\\":\\"status\\",\\"option\\":\\"=\\",\\"value\\":\\"1\\"}]'], + 'ItemConditionExpress' => ['description' => '物品条件，表达式格式条件。', 'type' => 'string', 'required' => false, 'example' => 'status=1'], + 'Event' => ['description' => '调控目标事件。', 'type' => 'string', 'required' => false, 'example' => 'click'], + 'Value' => ['description' => '调控目标值。', 'type' => 'number', 'format' => 'float', 'required' => false, 'example' => '100'], + 'StatisPeriod' => ['description' => '统计周期。'."\n" + ."\n" + .'- Daily：按天。'."\n" + ."\n" + .'- Hour：按小时。', 'type' => 'string', 'required' => false, 'example' => 'Daily'], + 'ToleranceValue' => ['description' => '调控目标容错范围。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '20'], + 'RecallName' => ['description' => '召回策略名称。', 'type' => 'string', 'required' => false, 'example' => 'recall_1'], + 'Status' => ['description' => '调控目标状态。'."\n" + ."\n" + .'- 开启：Opened。'."\n" + ."\n" + .'- 关闭：Closed。', 'type' => 'string', 'required' => false, 'example' => 'Opened'], + 'NewProductRegulation' => ['description' => '是否为新品调控。', 'type' => 'boolean', 'required' => false, 'example' => 'false'], + ], + 'required' => false, + ], + 'required' => false, ], - 'Uri' => [ - 'description' => '资源地址。', - 'type' => 'string', + 'InstanceId' => ['description' => '实例ID，可从接口[ListInstances](~~2411819~~)获取。', 'type' => 'string', 'required' => false, 'example' => 'pairec-cn-***test'], + 'ItemConditionArray' => ['description' => '物品条件，数组格式条件。', 'type' => 'string', 'required' => false, 'example' => '[{\\"field\\":\\"status\\",\\"option\\":\\"=\\",\\"value\\":\\"1\\"}]'], + 'ServiceId' => ['description' => '服务ID。'."\n", 'type' => 'string', 'required' => true, 'example' => '1'], + 'PreExperimentIds' => ['description' => '预发环境下的实验ID，多个ID用逗号分隔。'."\n", 'type' => 'string', 'required' => false, 'example' => '1,2,3'], + 'ProdExperimentIds' => ['description' => '生产环境下的实验ID，多个ID用逗号分隔。'."\n", 'type' => 'string', 'required' => false, 'example' => '4,5,6'], + 'FlinkResourceId' => ['description' => 'flink 数据源ID'."\n", 'type' => 'string', 'required' => false, 'example' => 'res-***'], + 'EffectiveSceneIds' => [ + 'description' => '生效场景Id列表。'."\n", + 'type' => 'array', + 'items' => ['description' => '场景ID。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '3'], 'required' => false, - 'example' => 'bucket-test-123', ], - 'ResourceId' => [ - 'type' => 'string', + 'ServiceIds' => [ + 'description' => '绑定的引擎服务ID列表。', + 'type' => 'array', + 'items' => ['description' => '引擎服务ID。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '3'], 'required' => false, ], ], 'required' => false, ], ], - [ - 'name' => 'InstanceId', - 'in' => 'path', - 'schema' => [ - 'description' => '实例ID，可通过接口[ListInstances](~~2411819~~)获取。', - 'type' => 'string', - 'required' => true, - 'example' => 'pairec-cn-test1', - ], - ], ], 'responses' => [ 200 => [ @@ -4600,160 +3676,132 @@ 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => '请求ID。', - 'type' => 'string', - 'example' => '9763624B-5FBB-5E3A-9193-B1ADB554CEAE', - ], - 'Resources' => [ - 'description' => '资源列表。', - 'type' => 'array', - 'items' => [ - 'description' => '资源信息。', - 'type' => 'object', - 'properties' => [ - 'Type' => [ - 'description' => '资源类型'."\n" - ."\n" - .'- Hologres'."\n" - ."\n" - .'- EAS'."\n" - ."\n" - .'- BE'."\n" - ."\n" - .'- Rec'."\n" - ."\n" - .'- Platform'."\n" - ."\n" - .'- SLS'."\n" - ."\n" - .'- DataHub'."\n" - ."\n" - .'- Kafka'."\n" - ."\n" - .'- Flinkvvp'."\n" - ."\n" - .'- ACR'."\n" - ."\n" - .'- OSS'."\n" - ."\n" - .'- DataWorks'."\n" - ."\n" - .'- PAI'."\n" - ."\n" - .'- MaxCompute'."\n" - ."\n" - .'- GraphCompute'."\n" - ."\n" - .'- Redis', - 'type' => 'string', - 'example' => 'OSS', - ], - 'Uri' => [ - 'description' => '资源地址。', - 'type' => 'string', - 'example' => 'bucket-test-123', - ], - 'Status' => [ - 'description' => '访问状态'."\n" - ."\n" - .'- Success'."\n" - ."\n" - .'- Failure', - 'type' => 'string', - 'example' => 'Success', - ], - ], - ], - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => '42391E6D-822C-58F8-9F7E-D991BB86D6AD'], + 'TrafficControlTaskId' => ['description' => '流量调控任务ID。', 'type' => 'string', 'example' => '1'], ], ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"9763624B-5FBB-5E3A-9193-B1ADB554CEAE\\",\\n \\"Resources\\": [\\n {\\n \\"Type\\": \\"OSS\\",\\n \\"Uri\\": \\"bucket-test-123\\",\\n \\"Status\\": \\"Success\\"\\n }\\n ]\\n}","type":"json"}]', - 'title' => '检查资源状态', + 'title' => '创建流量调控任务', + 'summary' => '用于创建新的流量调控任务，支持多种条件设置和目标配置。', + 'description' => '## 请求说明'."\n" + .'- 本API用于创建一个新的流量调控任务，允许用户根据不同的场景、时间范围以及特定的用户或物品条件来定义流量调控策略。'."\n" + .'- `ExecutionTime` 参数指定任务执行的时间模式，如果选择 `TimeRange` 模式，则必须同时提供 `StartTime` 和 `EndTime`。'."\n" + .'- 流量调控目标列表 (`TrafficControlTargets`) 是必填项，每个目标都需要明确其名称、时间范围、事件类型及期望值等信息。'."\n" + .'- 用户可以根据需要通过 `UserConditionType` 和 `ItemConditionType` 来灵活设定干预人群和物品的具体条件，支持数组格式和表达式两种方式。'."\n" + .'- 调控逻辑 (`ControlLogic`) 可选 `Guaranteed` 或 `Approach`，分别表示保量调控和逼近调控。'."\n" + .'- 当设置新品调控时，请确保正确填写 `NewProductRegulation` 字段。'."\n", + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"42391E6D-822C-58F8-9F7E-D991BB86D6AD\\",\\n \\"TrafficControlTaskId\\": \\"1\\"\\n}","type":"json"}]', ], - 'UpdateInstanceResource' => [ - 'summary' => '更新指定实例下指定资源的信息。', - 'path' => '/api/v1/instances/{InstanceId}/resources/{ResourceId}', - 'methods' => [ - 'put', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'DeleteABMetric' => [ + 'summary' => '删除指定AB实验指标。', + 'path' => '/api/v1/abmetrics/{ABMetricId}', + 'methods' => ['delete'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'update', + 'operationType' => 'delete', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATURElearnN0NAWV', - ], + 'abilityTreeNodes' => ['FEATURElearnN0NAWV'], ], 'parameters' => [ [ - 'name' => 'InstanceId', + 'name' => 'ABMetricId', 'in' => 'path', - 'schema' => [ - 'description' => '实例ID，可通过接口[ListInstances](~~2411819~~)获取。', - 'type' => 'string', - 'required' => true, - 'example' => 'pairec-cn-test1', - ], + 'schema' => ['description' => 'AB指标ID。', 'type' => 'string', 'required' => true, 'example' => '1'], ], [ - 'name' => 'ResourceId', - 'in' => 'path', - 'schema' => [ - 'description' => '资源ID。', - 'type' => 'string', - 'required' => true, - 'example' => 'reso-2s416t***', - ], + 'name' => 'InstanceId', + 'in' => 'query', + 'schema' => ['description' => '实例ID，可通过接口[ListInstances](~~2411819~~)获取。', 'type' => 'string', 'required' => true, 'example' => 'pairec-cn-test1'], ], - [ - 'name' => 'body', - 'in' => 'body', - 'style' => 'json', + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => '请求结构体。', + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'Uri' => [ - 'description' => '资源地址。', - 'type' => 'string', - 'required' => false, - 'example' => 'bucket-test-123', - ], - 'Config' => [ - 'description' => '资源配置信息。', - 'type' => 'string', - 'required' => false, - 'example' => '{}', - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => '728C5E01-ABF6-5AA8-B9FC-B3BA05DECC77'], ], - 'required' => false, ], ], ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"728C5E01-ABF6-5AA8-B9FC-B3BA05DECC77\\"\\n}","type":"json"}]', + 'title' => '删除AB指标', + 'changeSet' => [ + ['createdAt' => '2024-02-22T03:35:41.000Z', 'description' => '请求参数发生变更'], + ], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'pairec:DeleteABMetric', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIRecService', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + ], + ], + 'DeleteABMetricGroup' => [ + 'summary' => '删除AB实验指标组。', + 'path' => '/api/v1/abmetricgroups/{ABMetricGroupId}', + 'methods' => ['delete'], + 'schemes' => ['http', 'https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATURElearnN0NAWV'], + ], + 'parameters' => [ + [ + 'name' => 'ABMetricGroupId', + 'in' => 'path', + 'schema' => ['description' => '指标组ID。', 'type' => 'string', 'required' => true, 'example' => '1'], + ], + [ + 'name' => 'InstanceId', + 'in' => 'query', + 'schema' => ['description' => '实例ID，可通过接口[ListInstances](~~2411819~~)获取。', 'type' => 'string', 'required' => true, 'example' => 'pairec-cn-test1'], + ], + ], 'responses' => [ 200 => [ 'schema' => [ @@ -4761,83 +3809,128 @@ 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => '请求ID。', - 'type' => 'string', - 'example' => '3AAA45F6-0798-5461-9360-81D133823CE7', - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => 'BDB621CB-A81E-5D39-8793-39A365CBCC74'], ], ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"BDB621CB-A81E-5D39-8793-39A365CBCC74\\"\\n}","type":"json"}]', + 'title' => '删除指标组', + 'changeSet' => [ + ['createdAt' => '2024-02-22T03:35:41.000Z', 'description' => '请求参数发生变更'], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"3AAA45F6-0798-5461-9360-81D133823CE7\\"\\n}","type":"json"}]', - 'title' => '更新资源信息', - ], - 'GetInstanceResourceTable' => [ - 'summary' => '获取数据源下数据表的列表。', - 'path' => '/api/v1/instances/{InstanceId}/resources/{ResourceId}/tables/{TableName}', - 'methods' => [ - 'get', + 'flowControl' => [ + 'flowControlList' => [], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'pairec:DeleteABMetricGroup', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIRecService', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], ], + ], + 'DeleteCrowd' => [ + 'summary' => '删除指定人群。', + 'path' => '/api/v1/crowds/{CrowdId}', + 'methods' => ['delete'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], - 'operationType' => 'read', + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'none', + 'operationType' => 'delete', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATURElearnN0NAWV', - ], + 'abilityTreeNodes' => ['FEATURElearnN0NAWV'], ], 'parameters' => [ [ - 'name' => 'InstanceId', + 'name' => 'CrowdId', 'in' => 'path', - 'schema' => [ - 'description' => '实例ID，可通过接口[ListInstances](~~2411819~~)获取。', - 'type' => 'string', - 'required' => true, - 'example' => 'pairec-cn-test1', - ], + 'schema' => ['title' => '人群ID。', 'description' => '人群ID，可通过接口ListCrowds获取。', 'type' => 'string', 'required' => true, 'example' => '3'], ], [ - 'name' => 'ResourceId', - 'in' => 'path', + 'name' => 'InstanceId', + 'in' => 'query', + 'schema' => ['title' => '实例ID。', 'description' => '实例ID，可通过接口ListInstances获取。', 'type' => 'string', 'required' => true, 'example' => 'pairec-cn-abcdefg1234'], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => '资源ID。', - 'type' => 'string', - 'required' => true, - 'example' => 'reso-2s416t***', + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => 'A04CB8C0-E74A-5E83-BC61-64D153574EC7'], + ], + ], + ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"A04CB8C0-E74A-5E83-BC61-64D153574EC7\\"\\n}","type":"json"}]', + 'title' => '删除人群', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'pairec:DeleteCrowd', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIRecService', 'resourceType' => '全部资源', 'arn' => '*'], + ], ], ], + ], + ], + 'DeleteDataDiagnosis' => [ + 'path' => '/api/v1/datadiagnoses/{DataDiagnosisId}', + 'methods' => ['delete'], + 'schemes' => ['http', 'https'], + 'security' => [ [ - 'name' => 'TableName', + 'AK' => [], + ], + ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATURElearnN0NAWV'], + ], + 'parameters' => [ + [ + 'name' => 'DataDiagnosisId', 'in' => 'path', - 'schema' => [ - 'description' => '表名称过滤。', - 'type' => 'string', - 'required' => true, - 'example' => 'test_table', - ], + 'schema' => ['description' => '数据诊断ID。'."\n", 'type' => 'string', 'required' => true, 'example' => '3'], + ], + [ + 'name' => 'InstanceId', + 'in' => 'query', + 'schema' => ['description' => '实例ID。'."\n", 'type' => 'string', 'required' => true, 'example' => 'learn-pairec-xxx'], ], ], 'responses' => [ @@ -4847,201 +3940,125 @@ 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => '请求ID。', - 'type' => 'string', - 'example' => '74D958EF-3598-56FA-8296-FF1575CE43DF', - ], - 'TableName' => [ - 'description' => '表名。', - 'type' => 'string', - 'example' => 'test_table', - ], - 'Fields' => [ - 'description' => '表的字段列表。', - 'type' => 'array', - 'items' => [ - 'description' => '字段信息。', - 'type' => 'object', - 'properties' => [ - 'Name' => [ - 'description' => '字段名称。', - 'type' => 'string', - 'example' => 'age', - ], - 'Type' => [ - 'description' => '字段类型。', - 'type' => 'string', - 'example' => 'BIGINT', - ], - 'Meaning' => [ - 'description' => '字段含义。', - 'type' => 'string', - 'example' => '""', - ], - 'IsDimensionField' => [ - 'description' => '是否是维度字段。', - 'type' => 'boolean', - 'example' => 'false', - ], - 'IsPartitionField' => [ - 'description' => '是否为分区字段。', - 'type' => 'boolean', - 'example' => 'true', - ], - ], - ], - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => '请求ID。'."\n", 'type' => 'string', 'example' => '59CE7EC6-F268-5D71-9215-32922CC50D72'], ], ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '删除数据诊断', + 'summary' => '根据指定的数据诊断ID和实例ID删除数据诊断配置。', + 'description' => '## 请求说明'."\n" + .'本API用于删除特定的数据诊断配置。在调用此接口时，请确保提供的`DataDiagnosisId`与`InstanceId`准确无误，以避免误删重要配置。'."\n", + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"74D958EF-3598-56FA-8296-FF1575CE43DF\\",\\n \\"TableName\\": \\"test_table\\",\\n \\"Fields\\": [\\n {\\n \\"Name\\": \\"age\\",\\n \\"Type\\": \\"BIGINT\\",\\n \\"Meaning\\": \\"\\\\\\"\\\\\\"\\",\\n \\"IsDimensionField\\": false,\\n \\"IsPartitionField\\": true\\n }\\n ]\\n}","type":"json"}]', - 'title' => '获取资源下表信息', + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"59CE7EC6-F268-5D71-9215-32922CC50D72\\"\\n}","type":"json"}]', ], - 'ListInstanceResources' => [ - 'summary' => '获取实例下配置的资源列表。', - 'path' => '/api/v1/instances/{InstanceId}/resources', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'DeleteEngineConfig' => [ + 'summary' => '删除某个引擎配置。', + 'path' => '/api/v1/engineconfigs/{EngineConfigId}', + 'methods' => ['delete'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], - 'operationType' => 'read', + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'list', + 'operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATURElearnN0NAWV', - ], + 'abilityTreeCode' => '180292', + 'abilityTreeNodes' => ['FEATURElearnN0NAWV'], ], 'parameters' => [ [ - 'name' => 'InstanceId', + 'name' => 'EngineConfigId', 'in' => 'path', - 'schema' => [ - 'description' => '实例ID，可通过接口[ListInstances](~~2411819~~)获取。', - 'type' => 'string', - 'required' => true, - 'example' => 'pairec-cn-test1', - ], + 'schema' => ['description' => '引擎配置ID。', 'type' => 'string', 'required' => false, 'example' => '21'], ], [ - 'name' => 'Category', + 'name' => 'InstanceId', 'in' => 'query', - 'schema' => [ - 'description' => '资源类别'."\n" - ."\n" - .'- DataManagement'."\n" - ."\n" - .'- Engine'."\n" - ."\n" - .'- Monitor', - 'type' => 'string', - 'required' => false, - 'example' => 'DataManagement', - ], + 'schema' => ['description' => '实例ID。如何获取实例ID，请参见[ListInstances](~~2411819~~)。', 'type' => 'string', 'required' => false, 'example' => 'pairec-cn-***test1'], ], [ - 'name' => 'Group', + 'name' => 'DeleteAll', 'in' => 'query', + 'schema' => ['title' => '是否删除全部同名的引擎配置。', 'description' => '是否删除全部同名的引擎配置。', 'type' => 'boolean', 'required' => false, 'example' => 'False'], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => '资源分组。'."\n" - ."\n" - .'当资源类别为DataManagement时，资源分组有：'."\n" - ."\n" - .'- storage'."\n" - ."\n" - .'- modelpipeline'."\n" - ."\n" - .'- datastorage'."\n" - ."\n" - .'- modeltrain'."\n" - ."\n" - .'当资源类别为Engine时，资源分组有：'."\n" - ."\n" - .'- feature'."\n" - ."\n" - .'- predict'."\n" - ."\n" - .'- recall'."\n" - ."\n" - .'- recengine'."\n" - ."\n" - .'当资源类别为Monitor时，资源分组有：'."\n" - ."\n" - .'- logs'."\n" - ."\n" - .'- logsback'."\n" - ."\n" - .'- coldstart'."\n" - ."\n" - .'- deploy', - 'type' => 'string', - 'required' => false, - 'example' => 'storage', + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => 'F7AC05FF-EDE7-5C2B-B9AE-33D6DF4178BA'], + ], + ], + ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"F7AC05FF-EDE7-5C2B-B9AE-33D6DF4178BA\\"\\n}","type":"json"}]', + 'title' => '删除引擎配置', + 'description' => '删除某个引擎配置。', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'pairec:DeleteEngineConfig', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIRecService', 'resourceType' => '全部资源', 'arn' => '*'], + ], ], ], + ], + ], + 'DeleteExperiment' => [ + 'summary' => '删除指定实验。', + 'path' => '/api/v1/experiments/{ExperimentId}', + 'methods' => ['delete'], + 'schemes' => ['http', 'https'], + 'security' => [ [ - 'name' => 'Type', + 'AK' => [], + ], + ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATURElearnN0NAWV'], + ], + 'parameters' => [ + [ + 'name' => 'ExperimentId', + 'in' => 'path', + 'schema' => ['title' => '实验ID。', 'description' => '实验ID，可通过接口ListExperiments获取。', 'type' => 'string', 'required' => true, 'example' => '3'], + ], + [ + 'name' => 'InstanceId', 'in' => 'query', - 'schema' => [ - 'description' => '资源类型过滤。'."\n" - ."\n" - .'- Hologres'."\n" - ."\n" - .'- EAS'."\n" - ."\n" - .'- BE'."\n" - ."\n" - .'- Rec'."\n" - ."\n" - .'- Platform'."\n" - ."\n" - .'- SLS'."\n" - ."\n" - .'- DataHub'."\n" - ."\n" - .'- Kafka'."\n" - ."\n" - .'- Flinkvvp'."\n" - ."\n" - .'- ACR'."\n" - ."\n" - .'- OSS'."\n" - ."\n" - .'- DataWorks'."\n" - ."\n" - .'- PAI'."\n" - ."\n" - .'- MaxCompute'."\n" - ."\n" - .'- GraphCompute'."\n" - ."\n" - .'- Redis', - 'type' => 'string', - 'required' => false, - 'example' => 'OSS', - ], + 'schema' => ['title' => '实例ID。', 'description' => '实例ID，可通过接口ListInstances获取。', 'type' => 'string', 'required' => true, 'example' => 'pairec-cn-abcdefg1234'], ], ], 'responses' => [ @@ -5051,197 +4068,62 @@ 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => '请求ID。', - 'type' => 'string', - 'example' => '9763624B-5FBB-5E3A-9193-B1ADB554CEAE', - ], - 'TotalCount' => [ - 'description' => '总个数。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '10', - ], - 'Resources' => [ - 'description' => '资源对象的列表。', - 'type' => 'array', - 'items' => [ - 'description' => '资源信息。', - 'type' => 'object', - 'properties' => [ - 'ResourceId' => [ - 'description' => '资源ID。', - 'type' => 'string', - 'example' => 'reso-2s416t***'."\n", - ], - 'Category' => [ - 'description' => '资源类别'."\n" - ."\n" - .'- DataManagement'."\n" - ."\n" - .'- Engine'."\n" - ."\n" - .'- Monitor', - 'type' => 'string', - 'example' => 'DataManagement', - ], - 'Group' => [ - 'description' => '资源分组。'."\n" - ."\n" - .'当资源类别为DataManagement时，资源分组有：'."\n" - ."\n" - .'- storage'."\n" - ."\n" - .'- modelpipeline'."\n" - ."\n" - .'- datastorage'."\n" - ."\n" - .'- modeltrain'."\n" - ."\n" - .'当资源类别为Engine时，资源分组有：'."\n" - ."\n" - .'- feature'."\n" - ."\n" - .'- predict'."\n" - ."\n" - .'- recall'."\n" - ."\n" - .'- recengine'."\n" - ."\n" - .'当资源类别为Monitor时，资源分组有：'."\n" - ."\n" - .'- logs'."\n" - ."\n" - .'- logsback'."\n" - ."\n" - .'- coldstart'."\n" - ."\n" - .'- deploy', - 'type' => 'string', - 'example' => 'storage', - ], - 'Type' => [ - 'description' => '资源类型'."\n" - ."\n" - .'- Hologres'."\n" - ."\n" - .'- EAS'."\n" - ."\n" - .'- BE'."\n" - ."\n" - .'- Rec'."\n" - ."\n" - .'- Platform'."\n" - ."\n" - .'- SLS'."\n" - ."\n" - .'- DataHub'."\n" - ."\n" - .'- Kafka'."\n" - ."\n" - .'- Flinkvvp'."\n" - ."\n" - .'- ACR'."\n" - ."\n" - .'- OSS'."\n" - ."\n" - .'- DataWorks'."\n" - ."\n" - .'- PAI'."\n" - ."\n" - .'- MaxCompute'."\n" - ."\n" - .'- GraphCompute'."\n" - ."\n" - .'- Redis', - 'type' => 'string', - 'example' => 'OSS', - ], - 'Uri' => [ - 'description' => '资源地址。', - 'type' => 'string', - 'example' => 'bucket-test-123', - ], - 'Config' => [ - 'description' => '资源的配置信息。', - 'type' => 'string', - 'example' => '{}', - ], - 'GmtCreateAt' => [ - 'description' => '创建时间。', - 'type' => 'string', - 'example' => '2020-10-13 17:34:52'."\n", - ], - 'GmtModifiedAt' => [ - 'description' => '更新时间。', - 'type' => 'string', - 'example' => '2020-10-13 17:34:52'."\n", - ], - ], - ], - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => '2A734D87-2212-5C84-B63A-1AC87CA843D4'], ], ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"2A734D87-2212-5C84-B63A-1AC87CA843D4\\"\\n}","type":"json"}]', + 'title' => '删除实验', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'pairec:DeleteExperiment', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIRecService', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"9763624B-5FBB-5E3A-9193-B1ADB554CEAE\\",\\n \\"TotalCount\\": 10,\\n \\"Resources\\": [\\n {\\n \\"ResourceId\\": \\"reso-2s416t***\\\\n\\",\\n \\"Category\\": \\"DataManagement\\",\\n \\"Group\\": \\"storage\\",\\n \\"Type\\": \\"OSS\\",\\n \\"Uri\\": \\"bucket-test-123\\",\\n \\"Config\\": \\"{}\\",\\n \\"GmtCreateAt\\": \\"2020-10-13 17:34:52\\\\n\\",\\n \\"GmtModifiedAt\\": \\"2020-10-13 17:34:52\\\\n\\"\\n }\\n ]\\n}","type":"json"}]', - 'title' => '获取资源列表', ], - 'GetInstanceResource' => [ - 'summary' => '获取指定实例下指定资源的详细信息。', - 'path' => '/api/v1/instances/{InstanceId}/resources/{ResourceId}', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'DeleteExperimentGroup' => [ + 'summary' => '删除指定实验组。', + 'path' => '/api/v1/experimentgroups/{ExperimentGroupId}', + 'methods' => ['delete'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'none', + 'operationType' => 'delete', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATURElearnN0NAWV', - ], + 'abilityTreeNodes' => ['FEATURElearnN0NAWV'], ], 'parameters' => [ [ - 'name' => 'InstanceId', + 'name' => 'ExperimentGroupId', 'in' => 'path', - 'schema' => [ - 'description' => '实例ID，可通过接口[ListInstances](~~2411819~~)获取。', - 'type' => 'string', - 'required' => true, - 'example' => 'pairec-cn-test1', - ], + 'schema' => ['title' => '实验组ID。', 'description' => '实验组ID，可通过接口ListExperimentGroups获取。', 'type' => 'string', 'required' => true, 'example' => '3'], ], [ - 'name' => 'ResourceId', - 'in' => 'path', - 'schema' => [ - 'description' => '资源ID。', - 'type' => 'string', - 'required' => true, - 'example' => 'reso-2s416t***', - ], + 'name' => 'InstanceId', + 'in' => 'query', + 'schema' => ['title' => '实例ID。', 'description' => '实例ID，可通过接口ListInstances获取。', 'type' => 'string', 'required' => true, 'example' => 'pairec-cn-abcdefg1234'], ], ], 'responses' => [ @@ -5251,181 +4133,62 @@ 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => '请求ID。', - 'type' => 'string', - 'example' => 'D75C43DC-3D3A-5CC8-9AAC-8C77306C433B', - ], - 'ResourceId' => [ - 'description' => '资源ID。', - 'type' => 'string', - 'example' => 'reso-2s416t***', - ], - 'Category' => [ - 'description' => '资源类别'."\n" - ."\n" - .'- DataManagement'."\n" - ."\n" - .'- Engine'."\n" - ."\n" - .'- Monitor', - 'type' => 'string', - 'example' => 'DataManagement', - ], - 'Group' => [ - 'description' => '资源分组。'."\n" - ."\n" - .'当资源类别为DataManagement时，资源分组有：'."\n" - ."\n" - .'- storage'."\n" - ."\n" - .'- modelpipeline'."\n" - ."\n" - .'- datastorage'."\n" - ."\n" - .'- modeltrain'."\n" - ."\n" - .'当资源类别为Engine时，资源分组有：'."\n" - ."\n" - .'- feature'."\n" - ."\n" - .'- predict'."\n" - ."\n" - .'- recall'."\n" - ."\n" - .'- recengine'."\n" - ."\n" - .'当资源类别为Monitor时，资源分组有：'."\n" - ."\n" - .'- logs'."\n" - ."\n" - .'- logsback'."\n" - ."\n" - .'- coldstart'."\n" - ."\n" - .'- deploy', - 'type' => 'string', - 'example' => 'storage', - ], - 'Type' => [ - 'description' => '资源类型'."\n" - ."\n" - .'- Hologres'."\n" - ."\n" - .'- EAS'."\n" - ."\n" - .'- BE'."\n" - ."\n" - .'- Rec'."\n" - ."\n" - .'- Platform'."\n" - ."\n" - .'- SLS'."\n" - ."\n" - .'- DataHub'."\n" - ."\n" - .'- Kafka'."\n" - ."\n" - .'- Flinkvvp'."\n" - ."\n" - .'- ACR'."\n" - ."\n" - .'- OSS'."\n" - ."\n" - .'- DataWorks'."\n" - ."\n" - .'- PAI'."\n" - ."\n" - .'- MaxCompute'."\n" - ."\n" - .'- GraphCompute'."\n" - ."\n" - .'- Redis', - 'type' => 'string', - 'example' => 'OSS', - ], - 'Uri' => [ - 'description' => '资源地址。', - 'type' => 'string', - 'example' => 'bucket-test-123', - ], - 'Config' => [ - 'description' => '资源的配置信息。', - 'type' => 'string', - 'example' => '{}', - ], - 'GmtCreateTime' => [ - 'description' => '创建时间。', - 'type' => 'string', - 'example' => '2020-10-13 17:34:52', - ], - 'GmtModifiedTime' => [ - 'description' => '更新时间。', - 'type' => 'string', - 'example' => '2020-10-13 17:34:52', - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => 'A009D9BE-C85E-57B2-AE05-BD78BB6EBF50'], ], ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"A009D9BE-C85E-57B2-AE05-BD78BB6EBF50\\"\\n}","type":"json"}]', + 'title' => '删除实验组', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'pairec:DeleteExperimentGroup', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIRecService', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"D75C43DC-3D3A-5CC8-9AAC-8C77306C433B\\",\\n \\"ResourceId\\": \\"reso-2s416t***\\",\\n \\"Category\\": \\"DataManagement\\",\\n \\"Group\\": \\"storage\\",\\n \\"Type\\": \\"OSS\\",\\n \\"Uri\\": \\"bucket-test-123\\",\\n \\"Config\\": \\"{}\\",\\n \\"GmtCreateTime\\": \\"2020-10-13 17:34:52\\",\\n \\"GmtModifiedTime\\": \\"2020-10-13 17:34:52\\"\\n}","type":"json"}]', - 'title' => '获取资源详细信息', ], 'DeleteInstanceResource' => [ 'summary' => '删除指定实例下的指定配置资源。', 'path' => '/api/v1/instances/{InstanceId}/resources/{ResourceId}', - 'methods' => [ - 'delete', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'methods' => ['delete'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'delete', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATURElearnN0NAWV', - ], + 'abilityTreeNodes' => ['FEATURElearnN0NAWV'], ], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'path', - 'schema' => [ - 'description' => '实例ID，可通过接口[ListInstances](~~2411819~~)获取。', - 'type' => 'string', - 'required' => true, - 'example' => 'pairec-cn-test123', - ], + 'schema' => ['description' => '实例ID，可通过接口[ListInstances](~~2411819~~)获取。', 'type' => 'string', 'required' => true, 'example' => 'pairec-cn-test123'], ], [ 'name' => 'ResourceId', 'in' => 'path', - 'schema' => [ - 'description' => '资源ID。', - 'type' => 'string', - 'required' => true, - 'example' => 'reso-2s416t***', - ], + 'schema' => ['description' => '资源ID。', 'type' => 'string', 'required' => true, 'example' => 'reso-2s416t***'], ], ], 'responses' => [ @@ -5435,163 +4198,196 @@ 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => '请求ID。', - 'type' => 'string', - 'example' => '7D59453C-48AA-5FC5-8848-2D373BD1A17F', - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => '7D59453C-48AA-5FC5-8848-2D373BD1A17F'], ], ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], + 'staticInfo' => ['returnType' => 'synchronous'], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"7D59453C-48AA-5FC5-8848-2D373BD1A17F\\"\\n}","type":"json"}]', 'title' => '删除资源配置', - ], - 'CreateInstanceResource' => [ - 'summary' => '为指定实例配置创建新的配置资源。', - 'path' => '/api/v1/instances/{InstanceId}/resources', - 'methods' => [ - 'post', + 'changeSet' => [ + ['createdAt' => '2024-02-22T03:35:44.000Z', 'description' => '请求参数发生变更'], ], - 'schemes' => [ - 'http', - 'https', + 'flowControl' => [ + 'flowControlList' => [], ], + 'ramActions' => [ + [ + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'pairec:DeleteInstanceResource', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIRecService', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + ], + ], + 'DeleteLaboratory' => [ + 'summary' => '删除指定实验室。', + 'path' => '/api/v1/laboratories/{LaboratoryId}', + 'methods' => ['delete'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], - 'operationType' => 'readAndWrite', + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'create', + 'operationType' => 'delete', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATURElearnN0NAWV', - ], + 'abilityTreeNodes' => ['FEATURElearnN0NAWV'], ], 'parameters' => [ [ - 'name' => 'InstanceId', + 'name' => 'LaboratoryId', 'in' => 'path', + 'schema' => ['title' => '实验室ID。', 'description' => '实验室ID，可通过接口ListLaboratories获取。', 'type' => 'string', 'required' => true, 'example' => '3'], + ], + [ + 'name' => 'InstanceId', + 'in' => 'query', + 'schema' => ['title' => '实例ID。', 'description' => '实例ID，可通过接口ListInstances获取。', 'type' => 'string', 'required' => true, 'example' => 'pairec-cn-abcdefg1234'], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => '实例ID，可通过接口[ListInstances](~~2411819~~)获取。', - 'type' => 'string', - 'required' => true, - 'example' => 'pairec-cn-test1', + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => '1C0898E5-9220-5443-B2D9-445FF0688215'], + ], ], ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1C0898E5-9220-5443-B2D9-445FF0688215\\"\\n}","type":"json"}]', + 'title' => '删除实验室', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'pairec:DeleteLaboratory', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIRecService', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + ], + ], + 'DeleteLayer' => [ + 'summary' => '删除指定层。', + 'path' => '/api/v1/layers/{LayerId}', + 'methods' => ['delete'], + 'schemes' => ['http', 'https'], + 'security' => [ [ - 'name' => 'body', - 'in' => 'body', - 'style' => 'json', + 'AK' => [], + ], + ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATURElearnN0NAWV'], + ], + 'parameters' => [ + [ + 'name' => 'LayerId', + 'in' => 'path', + 'schema' => ['title' => '层ID。', 'description' => '层ID，可通过接口ListLayers获取。', 'type' => 'string', 'required' => false, 'example' => '3'], + ], + [ + 'name' => 'InstanceId', + 'in' => 'query', + 'schema' => ['title' => '实例ID。', 'description' => '实例ID，可通过接口ListInstances获取。', 'type' => 'string', 'required' => false, 'example' => 'pairec-cn-abcdefg1234'], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => '请求体参数。', + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'Category' => [ - 'description' => '资源类别'."\n" - .'- DataManagement'."\n" - .'- Engine'."\n" - .'- Monitor', - 'type' => 'string', - 'required' => true, - 'example' => 'DataManagement', - ], - 'Group' => [ - 'description' => '资源分组。'."\n" - ."\n" - .'当资源类别为DataManagement时，资源分组有：'."\n" - .'- storage'."\n" - ."\n" - .'- modelpipeline'."\n" - ."\n" - .'- datastorage'."\n" - ."\n" - .'- modeltrain'."\n" - ."\n" - .'当资源类别为Engine时，资源分组有：'."\n" - .'- feature'."\n" - ."\n" - .'- predict'."\n" - ."\n" - .'- recall'."\n" - ."\n" - .'- recengine'."\n" - ."\n" - .'当资源类别为Monitor时，资源分组有：'."\n" - .'- logs'."\n" - ."\n" - .'- logsback'."\n" - ."\n" - .'- coldstart'."\n" - ."\n" - .'- deploy', - 'type' => 'string', - 'required' => true, - 'example' => 'storage', - ], - 'Type' => [ - 'description' => '资源类型'."\n" - ."\n" - .'- Hologres'."\n" - ."\n" - .'- EAS'."\n" - ."\n" - .'- BE'."\n" - ."\n" - .'- Rec'."\n" - ."\n" - .'- Platform'."\n" - ."\n" - .'- SLS'."\n" - ."\n" - .'- DataHub'."\n" - ."\n" - .'- Kafka'."\n" - ."\n" - .'- Flinkvvp'."\n" - ."\n" - .'- ACR'."\n" - ."\n" - .'- OSS'."\n" - ."\n" - .'- DataWorks'."\n" - ."\n" - .'- PAI'."\n" - ."\n" - .'- MaxCompute'."\n" - ."\n" - .'- GraphCompute'."\n" - ."\n" - .'- Redis', - 'type' => 'string', - 'required' => true, - 'example' => 'OSS', - ], - 'Uri' => [ - 'description' => '资源地址。', - 'type' => 'string', - 'required' => true, - 'example' => 'bucket-test-123', - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => '8F457D79-C4A2-5E8C-83E4-0D089456E2AC'], ], - 'required' => false, ], ], ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"8F457D79-C4A2-5E8C-83E4-0D089456E2AC\\"\\n}","type":"json"}]', + 'title' => '删除层', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'pairec:DeleteLayer', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIRecService', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + ], + ], + 'DeleteParam' => [ + 'summary' => '删除指定参数。', + 'path' => '/api/v1/params/{ParamId}', + 'methods' => ['delete'], + 'schemes' => ['http', 'https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATURElearnN0NAWV'], + ], + 'parameters' => [ + [ + 'name' => 'ParamId', + 'in' => 'path', + 'schema' => ['title' => '参数ID。', 'description' => '参数ID，可通过接口ListParams获取。', 'type' => 'string', 'required' => false, 'example' => '3'], + ], + [ + 'name' => 'InstanceId', + 'in' => 'query', + 'schema' => ['title' => '实例ID。', 'description' => '实例ID，可通过接口ListInstances获取。', 'type' => 'string', 'required' => false, 'example' => 'pairec-cn-abcdefg1234'], + ], + ], 'responses' => [ 200 => [ 'schema' => [ @@ -5599,120 +4395,246 @@ 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => '请求ID。', - 'type' => 'string', - 'example' => '6CF1E160-3F36-5E73-A170-C75504F05BBC', - ], - 'ResourceId' => [ - 'description' => '资源ID。', - 'type' => 'string', - 'example' => 'reso-2s416t***', - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => 'F0AB6527-093F-5C44-B3BD-42C8C210C619'], ], ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"F0AB6527-093F-5C44-B3BD-42C8C210C619\\"\\n}","type":"json"}]', + 'title' => '删除参数', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'pairec:DeleteParam', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIRecService', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"6CF1E160-3F36-5E73-A170-C75504F05BBC\\",\\n \\"ResourceId\\": \\"reso-2s416t***\\"\\n}","type":"json"}]', - 'title' => '创建配置资源', ], - 'CreateScene' => [ - 'summary' => '创建一个场景，在场景下可进行指标、实验分析。', - 'path' => '/api/v1/scenes', - 'methods' => [ - 'post', + 'DeleteRecallManagementService' => [ + 'summary' => '用于删除指定的召回管理服务。', + 'path' => '/api/v1/recallmanagementservices/{RecallManagementServiceId}', + 'methods' => ['delete'], + 'schemes' => ['https'], + 'security' => [ + [ + 'AK' => [], + ], ], - 'schemes' => [ - 'http', - 'https', + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATURElearnN0NAWV'], ], + 'parameters' => [ + [ + 'name' => 'RecallManagementServiceId', + 'in' => 'path', + 'schema' => ['description' => '召回管理服务ID。'."\n", 'type' => 'string', 'required' => false, 'example' => '1'], + ], + [ + 'name' => 'InstanceId', + 'in' => 'query', + 'schema' => ['description' => '实例ID。'."\n", 'type' => 'string', 'required' => false, 'example' => 'pairec-cn-test123'], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['title' => 'Id of the request', 'description' => '请求id。'."\n", 'type' => 'string', 'example' => '728C5E01-ABF6-5AA8-B9FC-B3BA05DECC77'], + ], + ], + ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '删除召回管理服务', + 'description' => '## 请求说明'."\n" + .'该 API 用于根据提供的召回管理服务ID和实例ID删除特定的召回管理服务。请确保在调用此接口前，已经正确获取了需要删除的服务的相关信息。'."\n", + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"728C5E01-ABF6-5AA8-B9FC-B3BA05DECC77\\"\\n}","type":"json"}]', + ], + 'DeleteRecallManagementServiceVersion' => [ + 'path' => '/api/v1/recallmanagementservices/{RecallManagementServiceId}/versions/{RecallManagementServiceVersionId}', + 'methods' => ['delete'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATURElearnN0NAWV'], ], - 'produces' => [ - 'application/json', + 'parameters' => [ + [ + 'name' => 'RecallManagementServiceId', + 'in' => 'path', + 'schema' => ['description' => '召回管理服务ID。'."\n", 'type' => 'string', 'required' => false, 'example' => '3'], + ], + [ + 'name' => 'RecallManagementServiceVersionId', + 'in' => 'path', + 'schema' => ['description' => '召回管理服务版本ID。'."\n", 'type' => 'string', 'required' => false, 'example' => '2'], + ], + [ + 'name' => 'InstanceId', + 'in' => 'query', + 'schema' => ['description' => '实例ID。'."\n", 'type' => 'string', 'required' => false, 'example' => 'pairec-cn-test123'], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['title' => 'Id of the request', 'description' => '请求id。'."\n", 'type' => 'string', 'example' => '728C5E01-ABF6-5AA8-B9FC-B3BA05DECC77'], + ], + ], + ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '删除召回管理服务版本', + 'summary' => '用于删除指定的召回管理服务版本。', + 'description' => '## 请求说明'."\n" + .'该API允许用户通过提供召回管理服务ID、召回管理服务版本ID以及实例ID来删除特定版本的召回管理服务。请确保在调用此接口前已经备份了重要数据，因为删除操作不可逆。'."\n", + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"728C5E01-ABF6-5AA8-B9FC-B3BA05DECC77\\"\\n}","type":"json"}]', + ], + 'DeleteRecallManagementServiceVersionConfig' => [ + 'summary' => '此API用于删除指定的召回管理服务版本配置。', + 'path' => '/api/v1/recallmanagementservices/{RecallManagementServiceId}/versions/{RecallManagementServiceVersionId}/configs/{RecallManagementServiceVersionConfigId}', + 'methods' => ['delete'], + 'schemes' => ['https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'create', + 'operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATURElearnN0NAWV', - ], + 'abilityTreeNodes' => ['FEATURElearnN0NAWV'], ], 'parameters' => [ [ - 'name' => 'body', - 'in' => 'body', - 'style' => 'json', + 'name' => 'RecallManagementServiceId', + 'in' => 'path', + 'schema' => ['description' => '召回管理服务ID。'."\n", 'type' => 'string', 'required' => false, 'example' => '3'], + ], + [ + 'name' => 'RecallManagementServiceVersionId', + 'in' => 'path', + 'schema' => ['description' => '召回管理版本ID。'."\n", 'type' => 'string', 'required' => false, 'example' => '2'], + ], + [ + 'name' => 'RecallManagementServiceVersionConfigId', + 'in' => 'path', + 'schema' => ['description' => '召回管理配置ID。'."\n", 'type' => 'string', 'required' => false, 'example' => '2'], + ], + [ + 'name' => 'InstanceId', + 'in' => 'query', + 'schema' => ['description' => '实例ID。'."\n", 'type' => 'string', 'required' => false, 'example' => 'pairec-cn-test123'], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => '请求body。', + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'Name' => [ - 'title' => '场景名称。', - 'description' => '场景名称。', - 'type' => 'string', - 'required' => false, - 'example' => 'scene1', - ], - 'Description' => [ - 'title' => '场景描述。', - 'description' => '场景描述。', - 'type' => 'string', - 'required' => false, - 'example' => 'This is a test.', - ], - 'InstanceId' => [ - 'title' => '实例ID。', - 'description' => '实例ID，可通过接口ListInstances获取。', - 'type' => 'string', - 'required' => false, - 'example' => 'pairec-cn-abcdefg1234', - ], - 'Flows' => [ - 'title' => '流量列表。', - 'description' => '流量列表。', - 'type' => 'array', - 'items' => [ - 'description' => '流量。', - 'type' => 'object', - 'properties' => [ - 'FlowName' => [ - 'title' => '流量名称。', - 'description' => '流量名称。', - 'type' => 'string', - 'required' => false, - 'example' => '流量1', - ], - 'FlowCode' => [ - 'title' => '流量编码。', - 'description' => '流量编码。', - 'type' => 'string', - 'required' => false, - 'example' => 'liuliang1', - ], - ], - 'required' => false, - ], - 'required' => false, - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => '请求id。'."\n", 'type' => 'string', 'example' => '728C5E01-ABF6-5AA8-B9FC-B3BA05DECC77'], ], - 'required' => false, ], ], ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '删除召回管理服务版本配置', + 'description' => '## 请求说明'."\n" + .'- 该接口需要提供召回管理服务ID、召回管理版本ID以及召回管理配置ID。'."\n" + .'- `InstanceId` 是必需的查询参数，用来标识实例。'."\n" + .'- 确保提供的所有ID都是有效的，否则请求将失败。'."\n", + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"728C5E01-ABF6-5AA8-B9FC-B3BA05DECC77\\"\\n}","type":"json"}]', + ], + 'DeleteRecallManagementTable' => [ + 'summary' => '此API用于根据指定的数据表ID和实例ID删除召回管理数据表。', + 'path' => '/api/v1/recallmanagementtables/{RecallManagementTableId}', + 'methods' => ['delete'], + 'schemes' => ['https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATURElearnN0NAWV'], + ], + 'parameters' => [ + [ + 'name' => 'RecallManagementTableId', + 'in' => 'path', + 'schema' => ['description' => '数据表ID。'."\n", 'type' => 'string', 'required' => true, 'example' => '3'], + ], + [ + 'name' => 'InstanceId', + 'in' => 'query', + 'schema' => ['description' => '实例ID。'."\n", 'type' => 'string', 'required' => true, 'example' => 'pairec-cn-test123'], + ], + ], 'responses' => [ 200 => [ 'schema' => [ @@ -5720,81 +4642,54 @@ 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'Id of the request', - 'type' => 'string', - 'example' => 'FCF741D8-9C30-578E-807F-B935487DB34A', - ], - 'SceneId' => [ - 'title' => '场景ID。', - 'description' => '场景ID。', - 'type' => 'string', - 'example' => '3', - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => '请求id。'."\n", 'type' => 'string', 'example' => '728C5E01-ABF6-5AA8-B9FC-B3BA05DECC77'], ], ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"FCF741D8-9C30-578E-807F-B935487DB34A\\",\\n \\"SceneId\\": \\"3\\"\\n}","type":"json"}]', - 'title' => '创建场景', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '删除召回管理数据表', + 'description' => '## 请求说明'."\n" + .'- **路径参数** `RecallManagementTableId` 是必需的，用来指定要删除的数据表ID。'."\n" + .'- **查询参数** `InstanceId` 同样是必需的，用来指定执行操作的实例ID。'."\n" + .'- 成功执行后，将返回一个包含请求ID (`RequestId`) 的响应体，可用于追踪本次请求。'."\n", + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"728C5E01-ABF6-5AA8-B9FC-B3BA05DECC77\\"\\n}","type":"json"}]', ], 'DeleteScene' => [ 'summary' => '删除指定场景。', 'path' => '/api/v1/scenes/{SceneId}', - 'methods' => [ - 'delete', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'methods' => ['delete'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'delete', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATURElearnN0NAWV', - ], + 'abilityTreeNodes' => ['FEATURElearnN0NAWV'], ], 'parameters' => [ [ 'name' => 'SceneId', 'in' => 'path', - 'schema' => [ - 'title' => '场景ID。', - 'description' => '场景ID，可通过接口ListScenes获取。', - 'type' => 'string', - 'required' => false, - 'example' => '3', - ], + 'schema' => ['title' => '场景ID。', 'description' => '场景ID，可通过接口ListScenes获取。', 'type' => 'string', 'required' => false, 'example' => '3'], ], [ 'name' => 'InstanceId', 'in' => 'query', - 'schema' => [ - 'title' => '实例ID。', - 'description' => '实例ID，可通过接口ListInstances获取。', - 'type' => 'string', - 'required' => false, - 'example' => 'pairec-cn-abcdefg1234', - ], + 'schema' => ['title' => '实例ID。', 'description' => '实例ID，可通过接口ListInstances获取。', 'type' => 'string', 'required' => false, 'example' => 'pairec-cn-abcdefg1234'], ], ], 'responses' => [ @@ -5804,124 +4699,134 @@ 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'Id of the request', - 'type' => 'string', - 'example' => 'D75C43DC-3D3A-5CC8-9AAC-8C77306C433B', - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => 'D75C43DC-3D3A-5CC8-9AAC-8C77306C433B'], ], ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], + 'staticInfo' => ['returnType' => 'synchronous'], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"D75C43DC-3D3A-5CC8-9AAC-8C77306C433B\\"\\n}","type":"json"}]', 'title' => '删除场景', - ], - 'UpdateScene' => [ - 'summary' => '更新场景信息，例如更新场景的名称、描述。', - 'path' => '/api/v1/scenes/{SceneId}', - 'methods' => [ - 'put', - ], - 'schemes' => [ - 'http', - 'https', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'pairec:DeleteScene', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIRecService', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], ], + ], + 'DeleteSubCrowd' => [ + 'summary' => '删除指定子人群。', + 'path' => '/api/v1/crowds/{CrowdId}/subcrowds/{SubCrowdId}', + 'methods' => ['delete'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], - 'operationType' => 'readAndWrite', + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'update', + 'operationType' => 'delete', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATURElearnN0NAWV', - ], + 'abilityTreeNodes' => ['FEATURElearnN0NAWV'], ], 'parameters' => [ [ - 'name' => 'SceneId', + 'name' => 'CrowdId', 'in' => 'path', - 'schema' => [ - 'description' => '场景ID，可通过接口ListScenes获取。', - 'type' => 'string', - 'required' => false, - 'example' => '3', - ], + 'schema' => ['title' => '人群ID。', 'description' => '人群ID，可通过接口ListCrowds获取。', 'type' => 'string', 'required' => true, 'example' => '3'], ], [ - 'name' => 'body', - 'in' => 'body', - 'style' => 'json', + 'name' => 'SubCrowdId', + 'in' => 'path', + 'schema' => ['title' => '子人群ID。', 'description' => '子人群ID，可通过接口ListSubCrowds获取。', 'type' => 'string', 'required' => true, 'example' => '3'], + ], + [ + 'name' => 'InstanceId', + 'in' => 'query', + 'schema' => ['title' => '实例ID。', 'description' => '实例ID，可通过接口ListInstances获取。', 'type' => 'string', 'required' => true, 'example' => 'pairec-cn-abcdefg1234'], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => '请求body。', + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'Name' => [ - 'title' => '场景名称。', - 'description' => '场景名称。', - 'type' => 'string', - 'required' => false, - 'example' => 'scene1', - ], - 'Description' => [ - 'title' => '场景描述。', - 'description' => '场景描述。', - 'type' => 'string', - 'required' => false, - 'example' => 'This is a test.', - ], - 'InstanceId' => [ - 'title' => '实例ID。', - 'description' => '实例ID，可通过接口ListInstances获取。', - 'type' => 'string', - 'required' => false, - 'example' => 'pairec-cn-abcdefg1234', - ], - 'Flows' => [ - 'title' => '流量列表。', - 'description' => '流量列表。', - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'FlowName' => [ - 'title' => '流量名称。', - 'description' => '流量名称。', - 'type' => 'string', - 'required' => false, - 'example' => '流量1', - ], - 'FlowCode' => [ - 'title' => '流量编码。', - 'description' => '流量编码。', - 'type' => 'string', - 'required' => false, - 'example' => 'liuliang1', - ], - ], - 'required' => false, - ], - 'required' => false, - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => 'EE97D06A-2AA0-5AD9-B6CF-8A267924D691'], ], - 'required' => false, ], ], ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"EE97D06A-2AA0-5AD9-B6CF-8A267924D691\\"\\n}","type":"json"}]', + 'title' => '删除子人群', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'pairec:DeleteSubCrowd', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIRecService', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + ], + ], + 'DeleteTableMeta' => [ + 'summary' => '删除数据表。', + 'path' => '/api/v1/tablemetas/{TableMetaId}', + 'methods' => ['delete'], + 'schemes' => ['http', 'https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATURElearnN0NAWV'], + ], + 'parameters' => [ + [ + 'name' => 'TableMetaId', + 'in' => 'path', + 'schema' => ['description' => '数据表ID。', 'type' => 'string', 'required' => true, 'example' => '2'], + ], + [ + 'name' => 'InstanceId', + 'in' => 'query', + 'schema' => ['description' => '实例ID，可通过接口[ListInstances](~~2411819~~)获取。', 'type' => 'string', 'required' => true, 'example' => '实例ID pairec-cn-test1'], + ], + ], 'responses' => [ 200 => [ 'schema' => [ @@ -5929,76 +4834,191 @@ 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'Id of the request', - 'type' => 'string', - 'example' => 'FC17887E-3C82-5096-8AA6-F4C2E7417245', - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => '728C5E01-ABF6-5AA8-B9FC-B3BA05DECC77'], ], ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"728C5E01-ABF6-5AA8-B9FC-B3BA05DECC77\\"\\n}","type":"json"}]', + 'title' => '删除数据表', + 'changeSet' => [ + ['createdAt' => '2024-02-22T03:35:42.000Z', 'description' => '请求参数发生变更'], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"FC17887E-3C82-5096-8AA6-F4C2E7417245\\"\\n}","type":"json"}]', - 'title' => '更新场景', - ], - 'ListScenes' => [ - 'summary' => '获取场景列表。', - 'path' => '/api/v1/scenes', - 'methods' => [ - 'get', + 'flowControl' => [ + 'flowControlList' => [], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'pairec:DeleteTableMeta', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIRecService', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], ], + ], + 'DeleteTrafficControlTarget' => [ + 'summary' => '此API用于根据指定ID删除特定的流量调控目标。', + 'path' => '/api/v1/trafficcontroltargets/{TrafficControlTargetId}', + 'methods' => ['delete'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '220596', + 'abilityTreeNodes' => ['FEATURElearnN0NAWV'], ], - 'produces' => [ - 'application/json', + 'parameters' => [ + [ + 'name' => 'TrafficControlTargetId', + 'in' => 'path', + 'schema' => ['description' => '流量调控目标 ID', 'type' => 'string', 'required' => false, 'example' => '1'], + ], + [ + 'name' => 'InstanceId', + 'in' => 'query', + 'schema' => ['description' => '实例ID。', 'type' => 'string', 'required' => false, 'example' => 'pairec-1324***'], + ], ], - 'operationType' => 'read', + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['title' => 'Id of the request', 'description' => '请求id。', 'type' => 'string', 'example' => '728C5E01-ABF6-5AA8-B9FC-B3BA05DECC77'], + ], + ], + ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '删除流量调控目标', + 'description' => '## 请求说明'."\n" + .'- **TrafficControlTargetId** 是路径参数，必须提供，用来标识要删除的具体流量调控目标。'."\n" + .'- **InstanceId** 作为查询参数也是必需的，它指定了执行操作的实例ID。'."\n" + .'- 成功响应将返回一个 `RequestId` 字段，用于追踪请求。'."\n", + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"728C5E01-ABF6-5AA8-B9FC-B3BA05DECC77\\"\\n}","type":"json"}]', + ], + 'DeleteTrafficControlTask' => [ + 'path' => '/api/v1/trafficcontroltasks/{TrafficControlTaskId}', + 'methods' => ['delete'], + 'schemes' => ['http', 'https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'list', + 'operationType' => 'delete', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATURElearnN0NAWV', - ], + 'abilityTreeCode' => '220408', + 'abilityTreeNodes' => ['FEATURElearnN0NAWV'], ], 'parameters' => [ [ + 'name' => 'TrafficControlTaskId', + 'in' => 'path', + 'schema' => ['description' => '流量调控 ID'."\n", 'type' => 'string', 'required' => false, 'example' => '1'], + ], + [ 'name' => 'InstanceId', 'in' => 'query', + 'schema' => ['description' => '实例ID。'."\n", 'type' => 'string', 'required' => false, 'example' => 'pairec-1324***'], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'title' => '实例ID。', - 'description' => '实例ID，可通过接口ListInstances获取。', - 'type' => 'string', - 'required' => false, - 'example' => 'pairec-cn-abcdefg1234', + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['title' => 'Id of the request', 'description' => '请求id。'."\n", 'type' => 'string', 'example' => '728C5E01-ABF6-5AA8-B9FC-B3BA05DECC77'], + ], ], ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '删除流量调控任务', + 'summary' => '用于删除指定的流量调控任务。', + 'description' => '## 请求说明'."\n" + .'- 该 API 通过提供 `TrafficControlTaskId` 和 `InstanceId` 来定位并删除特定的流量调控任务。'."\n" + .'- 确保提供的 `TrafficControlTaskId` 和 `InstanceId` 是正确的，否则可能无法成功执行删除操作。'."\n" + .'- 删除操作一旦完成，相关数据将不可恢复，请谨慎操作。'."\n", + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"728C5E01-ABF6-5AA8-B9FC-B3BA05DECC77\\"\\n}","type":"json"}]', + ], + 'DeployTrafficControlTaskCode' => [ + 'summary' => '用于在指定环境中部署流量调控任务的Flink代码。', + 'path' => '/api/v1/trafficcontroltasks/{TrafficControlTaskId}/action/deploycode', + 'methods' => ['post'], + 'schemes' => ['https'], + 'security' => [ [ - 'name' => 'Name', - 'in' => 'query', + 'AK' => [], + ], + ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATURElearnN0NAWV'], + ], + 'parameters' => [ + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', 'schema' => [ - 'title' => '场景名称过滤。', - 'description' => '场景名称过滤。', - 'type' => 'string', + 'description' => '请求Body。', + 'type' => 'object', + 'properties' => [ + 'InstanceId' => ['description' => '实例ID。'."\n", 'type' => 'string', 'required' => false, 'example' => 'pairec-test1'], + 'Environment' => ['description' => '参数所属的环境。Daily-日常环境Pre-预发环境Prod-生产环境'."\n", 'type' => 'string', 'required' => false, 'example' => 'Daily'], + 'RetryDeploy' => ['description' => '当部署任务失败时，此参数可以重试并继续运行。'."\n", 'type' => 'boolean', 'required' => false], + ], 'required' => false, - 'example' => 'scene1', ], ], + [ + 'name' => 'TrafficControlTaskId', + 'in' => 'path', + 'schema' => ['description' => '流量调控任务ID。'."\n", 'type' => 'string', 'required' => false, 'example' => '3'], + ], ], 'responses' => [ 200 => [ @@ -6007,130 +5027,73 @@ 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'Id of the request', - 'type' => 'string', - 'example' => 'B8987BF7-6028-5B17-80E0-251B7BD67BBA', - ], - 'TotalCount' => [ - 'description' => '列表内元素数量总和。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '10', - ], - 'Scenes' => [ - 'title' => '场景列表。', - 'description' => '场景列表。', - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'SceneId' => [ - 'title' => '场景ID。', - 'description' => '场景ID。', - 'type' => 'string', - 'example' => '3', - ], - 'Name' => [ - 'title' => '场景名称。', - 'description' => '场景名称。', - 'type' => 'string', - 'example' => 'scene1', - ], - 'Description' => [ - 'title' => '场景描述。', - 'description' => '场景描述。', - 'type' => 'string', - 'example' => 'This is a test.', - ], - 'Flows' => [ - 'title' => '流量列表。', - 'description' => '流量列表。', - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'FlowName' => [ - 'title' => '流量名称。', - 'description' => '流量名称。', - 'type' => 'string', - 'example' => '流量1', - ], - 'FlowCode' => [ - 'title' => '流量编码。', - 'description' => '流量编码。', - 'type' => 'string', - 'example' => 'liuliang1', - ], - ], - ], - ], - ], - ], - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => '请求ID。'."\n", 'type' => 'string', 'example' => '728C5E01-ABF6-5AA8-B9FC-B3BA05DECC77'], ], ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"B8987BF7-6028-5B17-80E0-251B7BD67BBA\\",\\n \\"TotalCount\\": 10,\\n \\"Scenes\\": [\\n {\\n \\"SceneId\\": \\"3\\",\\n \\"Name\\": \\"scene1\\",\\n \\"Description\\": \\"This is a test.\\",\\n \\"Flows\\": [\\n {\\n \\"FlowName\\": \\"流量1\\",\\n \\"FlowCode\\": \\"liuliang1\\"\\n }\\n ]\\n }\\n ]\\n}","type":"json"}]', - 'title' => '获取场景列表', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '部署流量调控任务代码', + 'description' => '## 请求说明'."\n" + .'- 该API允许用户为特定的流量调控任务部署Flink代码。'."\n" + .'- `TrafficControlTaskId` 是路径参数，必须提供有效的任务ID。'."\n" + .'- `InstanceId` 和 `Environment` 是必需的请求体参数，分别指定了实例ID和环境（日常/预发/生产）。'."\n" + .'- 可选参数 `RetryDeploy` 允许设置是否在部署失败时自动重试，默认值为 `false`。'."\n" + .'- 确保提供的`Environment`值符合预期选项之一：Daily、Pre或Prod。'."\n", + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"728C5E01-ABF6-5AA8-B9FC-B3BA05DECC77\\"\\n}","type":"json"}]', ], - 'GetScene' => [ - 'summary' => '获取指定场景的详细信息。', - 'path' => '/api/v1/scenes/{SceneId}', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'ExportRecallManagementTable' => [ + 'summary' => '将召回引擎中的指定表导出到MaxCompute项目中。', + 'path' => '/api/v1/recallmanagementtables/{RecallManagementTableId}/action/export', + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], - 'operationType' => 'read', + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'get', + 'operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATURElearnN0NAWV', - ], + 'abilityTreeNodes' => ['FEATURElearnN0NAWV'], ], 'parameters' => [ [ - 'name' => 'SceneId', + 'name' => 'RecallManagementTableId', 'in' => 'path', - 'schema' => [ - 'title' => '场景ID。', - 'description' => '场景ID，可通过接口ListScenes获取。', - 'type' => 'string', - 'required' => false, - 'example' => '3', - ], + 'schema' => ['description' => '表Id。', 'type' => 'string', 'required' => false, 'example' => '3'], ], [ - 'name' => 'InstanceId', - 'in' => 'query', + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', 'schema' => [ - 'title' => '实例ID。', - 'description' => '实例ID，可通过接口ListInstances获取。', - 'type' => 'string', + 'description' => '请求Body。', + 'type' => 'object', + 'properties' => [ + 'InstanceId' => ['description' => '实例ID。', 'type' => 'string', 'required' => false, 'example' => 'pairec-test1'], + 'MaxcomputeProjectName' => ['description' => 'maxcompute 项目名称。', 'type' => 'string', 'required' => false, 'example' => 'test'], + 'MaxcomputeSchema' => ['description' => 'maxcompute schema。', 'type' => 'string', 'required' => false, 'example' => 'default'], + 'MaxcomputeTableName' => ['description' => 'maxcompute 表名称。', 'type' => 'string', 'required' => false, 'example' => 'table-1'], + 'Partitions' => [ + 'description' => '发布表的分区字段。', + 'type' => 'object', + 'required' => false, + 'additionalProperties' => ['type' => 'string', 'description' => '发布表的分区值。', 'example' => '20260101'], + ], + 'RecallManagementTableVersionId' => ['title' => '召回管理表的版本。', 'description' => '召回管理表的版本ID。默认为当前发布版本'."\n", 'type' => 'string', 'required' => false, 'example' => '20250213000000'], + ], 'required' => false, - 'example' => 'pairec-cn-abcdefg1234', ], ], ], @@ -6138,100 +5101,68 @@ 200 => [ 'schema' => [ 'title' => 'Schema of Response', - 'description' => 'Schema of Response', + 'description' => '返回数据'."\n", 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'Id of the request', - 'type' => 'string', - 'example' => 'B8987BF7-6028-5B17-80E0-251B7BD67BBA', - ], - 'Name' => [ - 'title' => '场景名称。', - 'description' => '场景名称。', - 'type' => 'string', - 'example' => 'scene1', - ], - 'Description' => [ - 'title' => '场景描述。', - 'description' => '场景描述。', - 'type' => 'string', - 'example' => 'This is a test.', - ], - 'Flows' => [ - 'title' => '流量列表。', - 'description' => '流量列表。', - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'FlowName' => [ - 'title' => '流量名称。', - 'description' => '流量名称。', - 'type' => 'string', - 'example' => '流量1', - ], - 'FlowCode' => [ - 'title' => '流量编码。', - 'description' => '流量编码。', - 'type' => 'string', - 'example' => 'liuliang1', - ], - ], - ], - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => '请求ID。'."\n", 'type' => 'string', 'example' => '728C5E01-ABF6-5AA8-B9FC-B3BA05DECC77'], + 'RecallManagementJobId' => ['description' => '召回管理任务ID。'."\n", 'type' => 'string', 'example' => '1'], ], ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '导出召回管理数据表', + 'description' => '## 请求说明'."\n" + .'本API用于从召回引擎导出特定的数据表至阿里云MaxCompute服务中，以便进一步的数据处理或分析。请确保提供的MaxCompute项目名称、schema以及表名在目标实例中是有效的，并且用户具有相应的操作权限。'."\n" + ."\n" + .'### 注意事项'."\n" + .'- `Partitions`字段需要以JSON格式提供，表示要导出的表分区信息。'."\n" + .'- 确保所有必填参数都已正确填写，否则请求可能失败。'."\n" + .'- 导出过程可能需要一定时间，请耐心等待并可通过返回的任务ID查询状态。'."\n", + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'pairec:ExportRecallManagementTable', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIRecService', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"B8987BF7-6028-5B17-80E0-251B7BD67BBA\\",\\n \\"Name\\": \\"scene1\\",\\n \\"Description\\": \\"This is a test.\\",\\n \\"Flows\\": [\\n {\\n \\"FlowName\\": \\"流量1\\",\\n \\"FlowCode\\": \\"liuliang1\\"\\n }\\n ]\\n}","type":"json"}]', - 'title' => '获取场景详细信息', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"728C5E01-ABF6-5AA8-B9FC-B3BA05DECC77\\",\\n \\"RecallManagementJobId\\": \\"1\\"\\n}","type":"json"}]', ], 'GenerateAlgorithmCustomizationScript' => [ 'summary' => '生成算法定制脚本', 'path' => '/api/v1/algorithmcustomizations/{AlgorithmCustomizationId}/action/generatescript', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'methods' => ['post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATURElearnN0NAWV', - ], + 'abilityTreeNodes' => ['FEATURElearnN0NAWV'], ], 'parameters' => [ [ 'name' => 'AlgorithmCustomizationId', 'in' => 'path', - 'schema' => [ - 'description' => '算法定制ID。', - 'type' => 'string', - 'required' => false, - 'example' => '1', - ], + 'schema' => ['description' => '算法定制ID。', 'type' => 'string', 'required' => false, 'example' => '1'], ], [ 'name' => 'body', @@ -6241,26 +5172,11 @@ 'description' => '请求Body。', 'type' => 'object', 'properties' => [ - 'InstanceId' => [ - 'description' => '实例ID。如何获取实例ID，请参见[ListInstances](~~2411819~~)。', - 'type' => 'string', - 'required' => false, - 'example' => 'pairec-test-xxx', - ], - 'ModuleFieldTypes' => [ - 'description' => 'Json 配置中，字段的类型。', - 'type' => 'object', - 'required' => false, - 'example' => '{"item_table":"array"}', - ], - 'DeployMode' => [ - 'description' => '是生成部署脚本还是一键部署：'."\n" - .'- EasyDeploy：一键部署。'."\n" - .'- GenerateScript：生成脚本。', - 'type' => 'string', - 'required' => false, - 'example' => 'EasyDeploy', - ], + 'InstanceId' => ['description' => '实例ID。如何获取实例ID，请参见[ListInstances](~~2411819~~)。', 'type' => 'string', 'required' => false, 'example' => 'pairec-test-xxx'], + 'ModuleFieldTypes' => ['description' => 'Json 配置中，字段的类型。', 'type' => 'object', 'required' => false, 'example' => '{"item_table":"array"}'], + 'DeployMode' => ['description' => '是生成部署脚本还是一键部署：'."\n" + .'- EasyDeploy：一键部署。'."\n" + .'- GenerateScript：生成脚本。', 'type' => 'string', 'required' => false, 'example' => 'EasyDeploy'], ], 'required' => false, ], @@ -6273,174 +5189,71 @@ 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => '请求ID。', - 'type' => 'string', - 'example' => '6CF1E160-3F36-5E73-A170-C75504F05BBC', - ], - 'OssAddress' => [ - 'description' => '生成的包在oss中的地址。', - 'type' => 'string', - 'example' => 'oss:xxxx', - ], - 'LogId' => [ - 'description' => '生成的日志的 ID。', - 'type' => 'string', - 'example' => '4', - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => '6CF1E160-3F36-5E73-A170-C75504F05BBC'], + 'OssAddress' => ['description' => '生成的包在oss中的地址。', 'type' => 'string', 'example' => 'oss:xxxx'], + 'LogId' => ['description' => '生成的日志的 ID。', 'type' => 'string', 'example' => '4'], ], ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], + 'staticInfo' => ['returnType' => 'synchronous'], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"6CF1E160-3F36-5E73-A170-C75504F05BBC\\",\\n \\"OssAddress\\": \\"oss:xxxx\\",\\n \\"LogId\\": \\"4\\"\\n}","type":"json"}]', 'title' => '部署算法定制', - ], - 'CreateLaboratory' => [ - 'summary' => '创建一个实验室，实验室是一组流量的集合，在实验室下可开展实验。', - 'path' => '/api/v1/laboratories', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'http', - 'https', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'pairec:GenerateAlgorithmCustomizationScript', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIRecService', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], ], + ], + 'GenerateTrafficControlTaskCode' => [ + 'summary' => '根据给定的流量调控任务ID和实例信息，生成相应的Flink代码。', + 'path' => '/api/v1/trafficcontroltasks/{TrafficControlTaskId}/action/generatecode', + 'methods' => ['post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], - 'operationType' => 'write', + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'create', + 'operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATURElearnN0NAWV', - ], + 'abilityTreeCode' => '224228', + 'abilityTreeNodes' => ['FEATURElearnN0NAWV'], ], 'parameters' => [ [ + 'name' => 'TrafficControlTaskId', + 'in' => 'path', + 'schema' => ['description' => '流量调控任务ID。', 'type' => 'string', 'required' => true, 'example' => '7'], + ], + [ 'name' => 'body', 'in' => 'body', 'style' => 'json', 'schema' => [ - 'title' => '请求body。', - 'description' => '请求body。', + 'description' => '请求Body。', 'type' => 'object', 'properties' => [ - 'SceneId' => [ - 'title' => '场景ID。', - 'description' => '场景ID，可通过接口ListScenes获取。', - 'type' => 'string', - 'required' => true, - 'example' => '3', - ], - 'Name' => [ - 'title' => '实验室名称。', - 'description' => '实验室名称。', - 'type' => 'string', - 'required' => true, - 'example' => 'laboratory1', - ], - 'Description' => [ - 'title' => '实验室描述。', - 'description' => '实验室描述。', - 'type' => 'string', - 'required' => false, - 'example' => 'This is a test.', - ], - 'DebugUsers' => [ - 'title' => '调试用户。', - 'description' => '调试用户（需为阿里云账户主账号/子账号uid），多个用户需通过逗号作间隔。', - 'type' => 'string', - 'required' => false, - 'example' => '1124512470******,1124512471******,1124512472******', - ], - 'DebugCrowdId' => [ - 'title' => '调试人群ID。', - 'description' => '调试人群ID。', - 'type' => 'string', - 'required' => false, - 'example' => '3', - ], - 'BucketCount' => [ - 'title' => '分桶数量。', - 'description' => '分桶数量。', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '24', - ], - 'Buckets' => [ - 'title' => '分配桶号。', - 'description' => '分配桶号。', - 'type' => 'string', - 'required' => false, - 'example' => '1,2,3,10-20', - ], - 'BucketType' => [ - 'title' => '分桶方式'."\n" - .'● UidHash-UID哈希（默认）'."\n" - .'● Uid-UID分桶'."\n" - .'● Filter-过滤条件分桶', - 'description' => '分桶方式'."\n" - .'● UidHash-UID哈希（默认）'."\n" - .'● Uid-UID分桶'."\n" - .'● Filter-过滤条件分桶', - 'type' => 'string', - 'required' => true, - 'example' => 'UidHash', - ], - 'Filter' => [ - 'title' => '过滤条件。', - 'description' => '过滤条件。', - 'type' => 'string', - 'required' => false, - 'example' => 'filter=xxx', - ], - 'Environment' => [ - 'title' => '运行环境'."\n" - .'● Daily-日常环境'."\n" - .'● Pre-预发环境'."\n" - .'● Prod-生产环', - 'description' => '运行环境'."\n" - .'● Daily-日常环境'."\n" - .'● Pre-预发环境'."\n" - .'● Prod-生产环', - 'type' => 'string', - 'required' => true, - 'example' => 'Daily', - ], - 'Type' => [ - 'title' => '实验室类型'."\n" - .'● Base'."\n" - .'● NonBase', - 'description' => '实验室类型'."\n" - .'● Base'."\n" - .'● NonBase', - 'type' => 'string', - 'required' => true, - 'example' => 'Base', - ], - 'InstanceId' => [ - 'title' => '实例ID。', - 'description' => '实例ID，可通过接口ListInstances获取。', - 'type' => 'string', - 'required' => true, - 'example' => 'pairec-cn-abcdefg1234', - ], + 'InstanceId' => ['description' => '实例ID。', 'type' => 'string', 'required' => true, 'example' => 'pairec-test1'], + 'Environment' => ['description' => '参数所属的环境。Daily-日常环境Pre-预发环境Prod-生产环境', 'type' => 'string', 'required' => false, 'example' => 'Daily'], ], 'required' => false, ], @@ -6453,81 +5266,55 @@ 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'Id of the request', - 'type' => 'string', - 'example' => '42391E6D-822C-58F8-9F7E-D991BB86D6AD', - ], - 'LaboratoryId' => [ - 'title' => '实验室ID。', - 'description' => '实验室ID。', - 'type' => 'string', - 'example' => '3', - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => '728C5E01-ABF6-5AA8-B9FC-B3BA05DECC77'], + 'Code' => ['description' => '产出的Flink Code'."\n", 'type' => 'string', 'example' => 'Create Table xxx.......'], + 'PreNeedConfig' => ['description' => '预发环境的引擎配置是否缺少配置信息'."\n", 'type' => 'boolean', 'example' => 'False'], ], ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"42391E6D-822C-58F8-9F7E-D991BB86D6AD\\",\\n \\"LaboratoryId\\": \\"3\\"\\n}","type":"json"}]', - 'title' => '创建实验室', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '生成流量调控任务代码', + 'description' => '## 请求说明'."\n" + .'- 该API用于基于指定的流量调控任务ID、实例ID及环境类型来生成对应的Flink代码。'."\n" + .'- `Environment`参数支持三种值：`Daily`（日常环境）、`Pre`（预发环境）和`Prod`（生产环境），请确保正确选择以匹配您的需求。'."\n" + .'- 注意检查返回结果中的`PreNeedConfig`字段，如果为`True`则表示在预发环境中可能缺少必要的配置信息，请根据实际情况调整或补充相关设置。'."\n", + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"728C5E01-ABF6-5AA8-B9FC-B3BA05DECC77\\",\\n \\"Code\\": \\"Create Table xxx.......\\",\\n \\"PreNeedConfig\\": true\\n}","type":"json"}]', ], - 'DeleteLaboratory' => [ - 'summary' => '删除指定实验室。', - 'path' => '/api/v1/laboratories/{LaboratoryId}', - 'methods' => [ - 'delete', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'GetABMetric' => [ + 'path' => '/api/v1/abmetrics/{ABMetricId}', + 'methods' => ['get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], - 'operationType' => 'write', + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'delete', + 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATURElearnN0NAWV', - ], + 'abilityTreeNodes' => ['FEATURElearnN0NAWV'], ], 'parameters' => [ [ - 'name' => 'LaboratoryId', + 'name' => 'ABMetricId', 'in' => 'path', - 'schema' => [ - 'title' => '实验室ID。', - 'description' => '实验室ID，可通过接口ListLaboratories获取。', - 'type' => 'string', - 'required' => true, - 'example' => '3', - ], + 'schema' => ['description' => 'AB指标ID。', 'type' => 'string', 'required' => true, 'example' => '1'], ], [ 'name' => 'InstanceId', 'in' => 'query', - 'schema' => [ - 'title' => '实例ID。', - 'description' => '实例ID，可通过接口ListInstances获取。', - 'type' => 'string', - 'required' => true, - 'example' => 'pairec-cn-abcdefg1234', - ], + 'schema' => ['description' => '实例ID，可通过接口[ListInstances](~~2411819~~)获取。', 'type' => 'string', 'required' => true, 'example' => 'pairec-cn-test1'], ], ], 'responses' => [ @@ -6537,173 +5324,176 @@ 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'Id of the request', - 'type' => 'string', - 'example' => '1C0898E5-9220-5443-B2D9-445FF0688215', - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => '728C5E01-ABF6-5AA8-B9FC-B3BA05DECC77'], + 'Name' => ['description' => '指标名称。', 'type' => 'string', 'example' => 'pv'], + 'Description' => ['description' => '指标描述。', 'type' => 'string', 'example' => '页面访问次数'], + 'SceneId' => ['description' => '场景ID。', 'type' => 'string', 'example' => '1'], + 'SceneName' => ['description' => '场景名称。', 'type' => 'string', 'example' => 'home_feed'], + 'Type' => ['description' => '指标类型。'."\n" + ."\n" + .'- Single-单一指标。'."\n" + ."\n" + .'- Derived-衍生指标。', 'type' => 'string', 'example' => 'Single'], + 'Realtime' => ['description' => '是否为实时指标。'."\n" + ."\n" + .'- true-是。'."\n" + ."\n" + .'- false-否。', 'type' => 'string', 'example' => 'false'], + 'TableMetaId' => ['description' => '来源数据表ID。', 'type' => 'string', 'example' => '2'], + 'ResultTableMetaId' => ['description' => '数据写回到的数据表ID。', 'type' => 'string', 'example' => '3'], + 'ResultResourceId' => ['description' => '写回数据表的数据源的ID。', 'type' => 'string', 'example' => '5'], + 'Definition' => ['description' => '指标定义。', 'type' => 'string', 'example' => 'sum(click_cnt)'], + 'StatisticsCycle' => ['description' => '统计周期。', 'type' => 'integer', 'format' => 'int32', 'example' => '1'], + 'LeftMetricId' => ['description' => '衍生指标的左指标ID。', 'type' => 'string', 'example' => '3'], + 'RightMetricId' => ['description' => '衍生指标的右指标ID。', 'type' => 'string', 'example' => '2'], + 'Operator' => ['description' => '衍生指标计算的操作符。'."\n" + ."\n" + .'- Plus-加'."\n" + ."\n" + .'- Minus-减'."\n" + ."\n" + .'- Multiplication-乘'."\n" + ."\n" + .'- Division-除', 'type' => 'string', 'example' => 'Division'], + 'NeedSignificance' => ['type' => 'boolean'], + 'AggregationByUser' => ['type' => 'boolean'], + 'Numerator' => ['type' => 'string', 'example' => 'click'], + 'Denominator' => ['type' => 'string', 'example' => 'pv'], + 'IsBinomialDistribution' => ['type' => 'boolean'], ], ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '获取AB指标详细信息', + 'summary' => '获取AB实验指标详细信息。', + 'changeSet' => [ + ['createdAt' => '2024-02-22T03:35:42.000Z', 'description' => '请求参数发生变更'], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1C0898E5-9220-5443-B2D9-445FF0688215\\"\\n}","type":"json"}]', - 'title' => '删除实验室', - ], - 'UpdateLaboratory' => [ - 'summary' => '更新实验室信息，例如更新实验室的名称。', - 'path' => '/api/v1/laboratories/{LaboratoryId}', - 'methods' => [ - 'put', + 'flowControl' => [ + 'flowControlList' => [], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'pairec:GetABMetric', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIRecService', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"728C5E01-ABF6-5AA8-B9FC-B3BA05DECC77\\",\\n \\"Name\\": \\"pv\\",\\n \\"Description\\": \\"页面访问次数\\",\\n \\"SceneId\\": \\"1\\",\\n \\"SceneName\\": \\"home_feed\\",\\n \\"Type\\": \\"Single\\",\\n \\"Realtime\\": \\"false\\",\\n \\"TableMetaId\\": \\"2\\",\\n \\"ResultTableMetaId\\": \\"3\\",\\n \\"ResultResourceId\\": \\"5\\",\\n \\"Definition\\": \\"sum(click_cnt)\\",\\n \\"StatisticsCycle\\": 1,\\n \\"LeftMetricId\\": \\"3\\",\\n \\"RightMetricId\\": \\"2\\",\\n \\"Operator\\": \\"Division\\",\\n \\"NeedSignificance\\": true,\\n \\"AggregationByUser\\": true,\\n \\"Numerator\\": \\"click\\",\\n \\"Denominator\\": \\"pv\\",\\n \\"IsBinomialDistribution\\": true\\n}","type":"json"}]', + ], + 'GetABMetricGroup' => [ + 'summary' => '获取AB实验指标组详细信息。', + 'path' => '/api/v1/abmetricgroups/{ABMetricGroupId}', + 'methods' => ['get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], - 'operationType' => 'readAndWrite', + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'update', + 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATURElearnN0NAWV', - ], + 'abilityTreeNodes' => ['FEATURElearnN0NAWV'], ], 'parameters' => [ [ - 'name' => 'LaboratoryId', + 'name' => 'ABMetricGroupId', 'in' => 'path', - 'schema' => [ - 'title' => '实验室ID。', - 'description' => '实验室ID，可通过接口ListLaboratories获取。', - 'type' => 'string', - 'required' => true, - 'example' => '3', - ], + 'schema' => ['description' => '指标组ID。', 'type' => 'string', 'required' => true, 'example' => '1'], ], [ - 'name' => 'body', - 'in' => 'body', - 'style' => 'json', + 'name' => 'InstanceId', + 'in' => 'query', + 'schema' => ['description' => '实例ID，可通过接口[ListInstances](~~2411819~~)获取。', 'type' => 'string', 'required' => true, 'example' => 'pairec-cn-test1'], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'title' => '请求body。', - 'description' => '请求body。', + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'Name' => [ - 'title' => '实验室名称。', - 'description' => '实验室名称。', - 'type' => 'string', - 'required' => true, - 'example' => 'laboratory1', - ], - 'Description' => [ - 'title' => '实验室介绍。', - 'description' => '实验室介绍。', - 'type' => 'string', - 'required' => false, - 'example' => 'This is a test.', - ], - 'DebugUsers' => [ - 'title' => '调试用户。', - 'description' => '调试用户（需为阿里云账户主账号/子账号uid），多个用户需通过逗号作间隔。', - 'type' => 'string', - 'required' => false, - 'example' => '1124512470******,1124512471******,1124512472******', - ], - 'DebugCrowdId' => [ - 'title' => '调试人群ID。', - 'description' => '调试人群ID。', - 'type' => 'string', - 'required' => false, - 'example' => '3', - ], - 'BucketCount' => [ - 'title' => '分桶数量。', - 'description' => '分桶数量。', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '24', - ], - 'Buckets' => [ - 'title' => '分配桶号。', - 'description' => '分配桶号。', - 'type' => 'string', - 'required' => false, - 'example' => '1,2,3,10-20', - ], - 'BucketType' => [ - 'title' => '分桶方式。'."\n" - .'● Uid-UID分桶（默认）'."\n" - .'● UidHash-UID哈希'."\n" - .'● Filter-过滤条件分桶', - 'description' => '分桶方式。'."\n" - .'● Uid-UID分桶（默认）'."\n" - .'● UidHash-UID哈希'."\n" - .'● Filter-过滤条件分桶', - 'type' => 'string', - 'required' => true, - 'example' => 'Filter', - ], - 'Filter' => [ - 'title' => '过滤条件。', - 'description' => '过滤条件。', - 'type' => 'string', - 'required' => false, - 'example' => 'filter=xxx', - ], - 'Type' => [ - 'title' => '实验室类型。'."\n" - .'● Base'."\n" - .'● NonBase', - 'description' => '实验室类型。'."\n" - .'● Base'."\n" - .'● NonBase', - 'type' => 'string', - 'required' => true, - 'example' => 'Base', - ], - 'InstanceId' => [ - 'title' => '实例ID。', - 'description' => '实例ID，可通过接口ListInstances获取。', - 'type' => 'string', - 'required' => true, - 'example' => 'pairec-test1', - ], - 'Environment' => [ - 'title' => '运行环境'."\n" - .'● Daily-日常环境'."\n" - .'● Pre-预发环境'."\n" - .'● Prod-生产环境', - 'description' => '运行环境'."\n" - .'● Daily-日常环境'."\n" - .'● Pre-预发环境'."\n" - .'● Prod-生产环境', - 'type' => 'string', - 'required' => false, - 'example' => 'Daily', - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => '01D22D08-BA20-5F35-8302-99115F288220'], + 'Name' => ['description' => '指标组名称。', 'type' => 'string', 'example' => 'visits'], + 'SceneId' => ['description' => '场景ID，来源于[ListScenes](https://icms.alibaba-inc.com/content/learn/pai?l=1&m=16768&n=4298955)接口。', 'type' => 'string', 'example' => '1'], + 'Description' => ['description' => '指标组描述。', 'type' => 'string', 'example' => '访问量相关指标'], + 'Owner' => ['description' => '负责人。', 'type' => 'string', 'example' => '2799614***'."\n"], + 'ABMetricIds' => ['description' => 'AB实验指标ID列表，逗号分隔。', 'type' => 'string', 'example' => '1,2'], + 'ABMetricNames' => ['description' => 'AB实验指标名称列表，逗号分隔。', 'type' => 'string', 'example' => 'pv,uv'], + 'Realtime' => ['description' => '是否为实时指标组。', 'type' => 'boolean', 'example' => 'false'], ], - 'required' => false, ], ], ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"01D22D08-BA20-5F35-8302-99115F288220\\",\\n \\"Name\\": \\"visits\\",\\n \\"SceneId\\": \\"1\\",\\n \\"Description\\": \\"访问量相关指标\\",\\n \\"Owner\\": \\"2799614***\\\\n\\",\\n \\"ABMetricIds\\": \\"1,2\\",\\n \\"ABMetricNames\\": \\"pv,uv\\",\\n \\"Realtime\\": false\\n}","type":"json"}]', + 'title' => '获取指标组详细信息', + 'changeSet' => [ + ['createdAt' => '2024-02-22T03:35:41.000Z', 'description' => '请求参数发生变更'], + ], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'pairec:GetABMetricGroup', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIRecService', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + ], + ], + 'GetCalculationJob' => [ + 'summary' => '获取指定计算任务详细信息。', + 'path' => '/api/v1/calculationjobs/{CalculationJobId}', + 'methods' => ['get'], + 'schemes' => ['http', 'https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATURElearnN0NAWV'], + ], + 'parameters' => [ + [ + 'name' => 'CalculationJobId', + 'in' => 'path', + 'schema' => ['description' => '计算任务ID。', 'type' => 'string', 'required' => true, 'example' => '1'], + ], + [ + 'name' => 'InstanceId', + 'in' => 'query', + 'schema' => ['description' => '实例ID，可通过接口[ListInstances](~~2411819~~)获取。', 'type' => 'string', 'required' => true, 'example' => 'pairec-cn-test1'], + ], + ], 'responses' => [ 200 => [ 'schema' => [ @@ -6711,109 +5501,330 @@ 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'Id of the request', - 'type' => 'string', - 'example' => 'A04CB8C0-E74A-5E83-BC61-64D153574EC7', - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => '7D59453C-48AA-5FC5-8848-2D373BD1A17F'], + 'ABMetricId' => ['description' => 'AB指标ID。', 'type' => 'string', 'example' => '1'], + 'ABMetricName' => ['description' => 'AB指标名称。', 'type' => 'string', 'example' => 'pv'], + 'Status' => ['description' => '状态。'."\n" + ."\n" + .'- Success-成功'."\n" + ."\n" + .'- Failure-失败'."\n" + ."\n" + .'- Initializing-初始化中'."\n" + ."\n" + .'- Running-运行中', 'type' => 'string', 'example' => 'Success'], + 'JobMessage' => [ + 'description' => '任务信息。', + 'type' => 'array', + 'items' => ['description' => '任务信息。', 'type' => 'string', 'example' => 'success'], + ], + 'Config' => ['description' => '任务配置。', 'type' => 'string', 'example' => '{}'], + 'GmtRanTime' => ['description' => '运行时间。', 'type' => 'string', 'example' => '2021-12-15T23:24:33.132+08:00'], + 'BizDate' => ['description' => '业务时间。', 'type' => 'string', 'example' => '2021-12-15'], + 'JobSource' => ['description' => '任务来源。'."\n" + ."\n" + .'- CronOffline-离线定时任务'."\n" + ."\n" + .'- DataRerun-数据重跑任务', 'type' => 'string', 'example' => 'CronOffline'], ], ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"7D59453C-48AA-5FC5-8848-2D373BD1A17F\\",\\n \\"ABMetricId\\": \\"1\\",\\n \\"ABMetricName\\": \\"pv\\",\\n \\"Status\\": \\"Success\\",\\n \\"JobMessage\\": [\\n \\"success\\"\\n ],\\n \\"Config\\": \\"{}\\",\\n \\"GmtRanTime\\": \\"2021-12-15T23:24:33.132+08:00\\",\\n \\"BizDate\\": \\"2021-12-15\\",\\n \\"JobSource\\": \\"CronOffline\\"\\n}","type":"json"}]', + 'title' => '获取计算任务', + 'changeSet' => [ + ['createdAt' => '2024-02-22T03:35:40.000Z', 'description' => '请求参数发生变更'], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"A04CB8C0-E74A-5E83-BC61-64D153574EC7\\"\\n}","type":"json"}]', - 'title' => '更新实验室', - ], - 'ListLaboratories' => [ - 'summary' => '获取某个场景下的实验室列表。', - 'path' => '/api/v1/laboratories', - 'methods' => [ - 'get', + 'flowControl' => [ + 'flowControlList' => [], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'pairec:GetCalculationJob', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIRecService', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], ], + ], + 'GetDataDiagnosis' => [ + 'summary' => '通过数据诊断任务ID和实例ID获取详细的数据诊断信息。', + 'path' => '/api/v1/datadiagnoses/{DataDiagnosisId}', + 'methods' => ['get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free'], + 'parameters' => [ + [ + 'name' => 'DataDiagnosisId', + 'in' => 'path', + 'schema' => ['description' => '数据诊断任务配置ID。', 'type' => 'string', 'required' => true, 'example' => '3'], + ], + [ + 'name' => 'InstanceId', + 'in' => 'query', + 'schema' => ['description' => '实例ID。', 'type' => 'string', 'required' => true, 'example' => 'learn-pairec-xxx'], + ], ], - 'produces' => [ - 'application/json', + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => '728C5E01-ABF6-5AA8-B9FC-B3BA05DECC77'], + 'Name' => ['description' => '数据诊断名称。', 'type' => 'string', 'example' => 'data_diagnosis_job1'], + 'Type' => ['description' => '数据诊断类型。', 'type' => 'string', 'example' => 'ChangeRate'], + 'TableMetaId' => ['description' => '数据表ID。'."\n", 'type' => 'string', 'example' => '3'], + 'TableMetaName' => ['description' => '数据表名称。'."\n", 'type' => 'string', 'example' => 'table_meta_1'], + 'LeftTableMetaId' => ['description' => '左数据表ID。'."\n", 'type' => 'string', 'example' => '4'], + 'RightTableMetaId' => ['description' => '右数据表ID。'."\n", 'type' => 'string', 'example' => '5'], + 'PartitionField' => ['description' => '分区字段。'."\n", 'type' => 'string', 'example' => 'dt'], + 'LeftTablePartitionField' => ['description' => '左表分区字段。'."\n", 'type' => 'string', 'example' => 'dt'], + 'RightTablePartitionField' => ['description' => '右表分区字段。'."\n", 'type' => 'string', 'example' => 'dt'], + 'Config' => ['description' => '数据诊断任务配置内容。', 'type' => 'string', 'example' => '{"AnalysisField":"userid","PartitionFieldFormat":"yyyymmdd"}'], + 'CycleTime' => ['description' => '周期运行时间（若该字段为空，则不进行周期运行）。'."\n", 'type' => 'string', 'example' => '08:00'], + 'TopNQuantity' => ['description' => 'topN数量。'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '10'], + 'GmtCreateTime' => ['description' => '创建时间。'."\n", 'type' => 'string', 'example' => '2021-12-15T23:24:33.132+08:00'], + 'GmtModifiedTime' => ['description' => '更新时间。', 'type' => 'string', 'example' => '2021-12-15T23:24:33.132+08:00'], + ], + ], + ], ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '获取数据诊断详情', + 'description' => '## 请求说明'."\n" + .'- 该API用于根据提供的`DataDiagnosisId`（数据诊断任务配置ID）和`InstanceId`（实例ID）来获取特定数据诊断任务的详细信息。'."\n" + .'- `CycleTime`字段表示周期运行时间，如果为空，则意味着不进行周期运行。'."\n" + .'- 根据不同的`Type`值，`Config`字段的内容会有所不同，请参考文档中关于每种类型所需的具体配置项。'."\n" + .'- `GmtCreateTime`与`GmtModifiedTime`分别代表了记录创建及最后修改的时间戳。'."\n", + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"728C5E01-ABF6-5AA8-B9FC-B3BA05DECC77\\",\\n \\"Name\\": \\"data_diagnosis_job1\\",\\n \\"Type\\": \\"ChangeRate\\",\\n \\"TableMetaId\\": \\"3\\",\\n \\"TableMetaName\\": \\"table_meta_1\\",\\n \\"LeftTableMetaId\\": \\"4\\",\\n \\"RightTableMetaId\\": \\"5\\",\\n \\"PartitionField\\": \\"dt\\",\\n \\"LeftTablePartitionField\\": \\"dt\\",\\n \\"RightTablePartitionField\\": \\"dt\\",\\n \\"Config\\": \\"{\\\\\\"AnalysisField\\\\\\":\\\\\\"userid\\\\\\",\\\\\\"PartitionFieldFormat\\\\\\":\\\\\\"yyyymmdd\\\\\\"}\\",\\n \\"CycleTime\\": \\"08:00\\",\\n \\"TopNQuantity\\": 10,\\n \\"GmtCreateTime\\": \\"2021-12-15T23:24:33.132+08:00\\",\\n \\"GmtModifiedTime\\": \\"2021-12-15T23:24:33.132+08:00\\"\\n}","type":"json"}]', + ], + 'GetEngineConfig' => [ + 'summary' => '获取引擎配置详情。', + 'path' => '/api/v1/engineconfigs/{EngineConfigId}', + 'methods' => ['get'], + 'schemes' => ['http', 'https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'list', + 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATURElearnN0NAWV', - ], + 'abilityTreeCode' => '180249', + 'abilityTreeNodes' => ['FEATURElearnN0NAWV'], ], 'parameters' => [ [ - 'name' => 'Environment', + 'name' => 'EngineConfigId', + 'in' => 'path', + 'schema' => ['description' => '引擎配置ID。', 'type' => 'string', 'required' => false, 'example' => '9'], + ], + [ + 'name' => 'InstanceId', 'in' => 'query', + 'schema' => ['description' => '实例ID，可通过接口[ListInstances](~~2411819~~)获取。', 'type' => 'string', 'required' => false, 'example' => 'pairec-cn-***test'], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'title' => '实验室所属的环境。'."\n" - .'● Daily-日常环境'."\n" - .'● Pre-预发环境'."\n" - .'● Prod-生产环境', - 'description' => '实验室所属的环境。'."\n" - ."\n" - .'- Daily：日常环境'."\n" - .'- Pre：预发环境'."\n" - .'- Prod：生产环境', - 'type' => 'string', - 'required' => false, - 'example' => 'Daily', + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => '59CE7EC6-F268-5D71-9215-32922CC50D72'], + 'Name' => ['description' => '引擎配置名称。', 'type' => 'string', 'example' => 'engine_config_v1'], + 'ConfigValue' => ['description' => '引擎配置的内容。', 'type' => 'string', 'example' => '{}'], + 'Environment' => ['description' => '运行环境。'."\n" + ."\n" + .'- Daily-日常环境。'."\n" + ."\n" + .'- Pre-预发环境。'."\n" + ."\n" + .'- Prod-生产环境。', 'type' => 'string', 'example' => 'Pre'], + 'Status' => ['description' => 'Released 状态。'."\n" + ."\n" + .'- Released-已发布。'."\n" + ."\n" + .'- UnReleased-未发布。', 'type' => 'string', 'example' => 'Released'], + 'GmtCreateTime' => ['description' => '创建时间。', 'type' => 'string', 'example' => '2024-01-03T02:28:00.000Z'], + 'GmtModifiedTime' => ['description' => '更新时间。', 'type' => 'string', 'example' => '2024-08-27T12:00:00Z'], + 'GmtReleasedTime' => ['description' => '发布时间。', 'type' => 'string', 'example' => '2024-01-03 02:28:00'], + 'Description' => ['type' => 'string', 'description' => ''], + ], ], ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"59CE7EC6-F268-5D71-9215-32922CC50D72\\",\\n \\"Name\\": \\"engine_config_v1\\",\\n \\"ConfigValue\\": \\"{}\\",\\n \\"Environment\\": \\"Pre\\",\\n \\"Status\\": \\"Released\\",\\n \\"GmtCreateTime\\": \\"2024-01-03T02:28:00.000Z\\",\\n \\"GmtModifiedTime\\": \\"2024-08-27T12:00:00Z\\",\\n \\"GmtReleasedTime\\": \\"2024-01-03 02:28:00\\",\\n \\"Description\\": \\"\\"\\n}","type":"json"}]', + 'title' => '获取引擎配置详情', + 'changeSet' => [ + ['createdAt' => '2024-12-27T08:56:39.000Z', 'description' => '响应参数发生变更'], + ], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ [ - 'name' => 'SceneId', - 'in' => 'query', - 'schema' => [ - 'title' => '场景ID。', - 'description' => '场景ID，可通过接口ListScenes获取。', - 'type' => 'string', - 'required' => true, - 'example' => '3', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'pairec:GetEngineConfig', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIRecService', 'resourceType' => '全部资源', 'arn' => '*'], + ], ], ], + ], + ], + 'GetExperiment' => [ + 'summary' => '获取指定实验的详细信息。', + 'path' => '/api/v1/experiments/{ExperimentId}', + 'methods' => ['get'], + 'schemes' => ['http', 'https'], + 'security' => [ [ - 'name' => 'Status', + 'AK' => [], + ], + ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATURElearnN0NAWV'], + ], + 'parameters' => [ + [ + 'name' => 'ExperimentId', + 'in' => 'path', + 'schema' => ['title' => '实验ID。', 'description' => '实验ID，可通过接口ListExperiments获取。', 'type' => 'string', 'required' => true, 'example' => '3'], + ], + [ + 'name' => 'InstanceId', 'in' => 'query', + 'schema' => ['title' => '实例ID。', 'description' => '实例ID，可通过接口ListInstances获取。', 'type' => 'string', 'required' => true, 'example' => 'pairec-cn-abcdefg1234'], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'title' => '状态。'."\n" - .'● Offline-未上线。'."\n" - .'● Online-已上线。', - 'description' => '状态。'."\n" - ."\n" - .'- Offline：未上线'."\n" - .'- Online：已上线', - 'type' => 'string', - 'required' => false, - 'example' => 'Offline', + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => '74D958EF-3598-56FA-8296-FF1575CE43DF'], + 'AliasExperimentId' => ['title' => '实验ID别名。', 'description' => '实验ID别名。', 'type' => 'string', 'example' => 'L1#EG1#E1'], + 'ExperimentGroupId' => ['title' => '实验组ID。', 'description' => '实验组ID。', 'type' => 'string', 'example' => '3'], + 'LayerId' => ['title' => '层ID。', 'description' => '层ID。', 'type' => 'string', 'example' => '3'], + 'LaboratoryId' => ['title' => '实验室ID。', 'description' => '实验室ID。', 'type' => 'string', 'example' => '3'], + 'SceneId' => ['title' => '场景ID。', 'description' => '场景ID。', 'type' => 'string', 'example' => '3'], + 'Name' => ['title' => '实验名称。', 'description' => '实验名称。', 'type' => 'string', 'example' => 'experiment_test1'], + 'Description' => ['title' => '实验描述。', 'description' => '实验描述。', 'type' => 'string', 'example' => 'This is a test.'], + 'Type' => ['title' => '实验类型。'."\n" + .'● Baseline-基准实验。'."\n" + .'● Normal-普通实验。', 'description' => '实验类型。'."\n" + .'● Baseline-基准实验。'."\n" + .'● Normal-普通实验。', 'type' => 'string', 'example' => 'Baseline'], + 'FlowPercent' => ['title' => '流量分配百分比。', 'description' => '流量分配百分比。', 'type' => 'integer', 'format' => 'int32', 'example' => '100', 'default' => '100'], + 'Buckets' => ['title' => '分配桶号。', 'description' => '分配桶号。', 'type' => 'string', 'example' => '1,2,3'], + 'DebugUsers' => ['title' => '调试用户。', 'description' => '调试用户（需为阿里云账户主账号/子账号uid），多个用户需通过逗号作间隔。', 'type' => 'string', 'example' => '1124512470******,1124512471******,1124512472******'], + 'DebugCrowdId' => ['title' => '调试人群ID。', 'description' => '调试人群ID。', 'type' => 'string', 'example' => '3'], + 'Config' => ['title' => '实验配置。', 'description' => '实验配置。', 'type' => 'string', 'example' => '{"RankBy": "Score"}'], + 'Status' => ['title' => '状态过滤。'."\n" + .'● Offline-未上线'."\n" + .'● Online-已上线', 'description' => '状态过滤。'."\n" + .'● Offline-未上线'."\n" + .'● Online-已上线', 'type' => 'string', 'example' => 'Offline'], + 'GmtCreateTime' => ['title' => '创建时间。', 'description' => '创建时间。', 'type' => 'string', 'example' => '2021-12-15T23:24:33.132+08:00'], + 'GmtModifiedTime' => ['title' => '更新时间。', 'description' => '更新时间。', 'type' => 'string', 'example' => '2021-12-15T23:24:33.132+08:00'], + ], + ], + ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '获取实验详细信息', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'pairec:GetExperiment', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIRecService', 'resourceType' => '全部资源', 'arn' => '*'], + ], ], ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"74D958EF-3598-56FA-8296-FF1575CE43DF\\",\\n \\"AliasExperimentId\\": \\"L1#EG1#E1\\",\\n \\"ExperimentGroupId\\": \\"3\\",\\n \\"LayerId\\": \\"3\\",\\n \\"LaboratoryId\\": \\"3\\",\\n \\"SceneId\\": \\"3\\",\\n \\"Name\\": \\"experiment_test1\\",\\n \\"Description\\": \\"This is a test.\\",\\n \\"Type\\": \\"Baseline\\",\\n \\"FlowPercent\\": 100,\\n \\"Buckets\\": \\"1,2,3\\",\\n \\"DebugUsers\\": \\"1124512470******,1124512471******,1124512472******\\",\\n \\"DebugCrowdId\\": \\"3\\",\\n \\"Config\\": \\"{\\\\\\"RankBy\\\\\\": \\\\\\"Score\\\\\\"}\\",\\n \\"Status\\": \\"Offline\\",\\n \\"GmtCreateTime\\": \\"2021-12-15T23:24:33.132+08:00\\",\\n \\"GmtModifiedTime\\": \\"2021-12-15T23:24:33.132+08:00\\"\\n}","type":"json"}]', + ], + 'GetExperimentGroup' => [ + 'path' => '/api/v1/experimentgroups/{ExperimentGroupId}', + 'methods' => ['get'], + 'schemes' => ['http', 'https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '183395', + 'abilityTreeNodes' => ['FEATURElearnN0NAWV'], + ], + 'parameters' => [ + [ + 'name' => 'ExperimentGroupId', + 'in' => 'path', + 'schema' => ['title' => '实验组ID。', 'description' => '实验组ID，可通过接口ListExperimentGroups获取。', 'type' => 'string', 'required' => true, 'example' => '3'], + ], [ 'name' => 'InstanceId', 'in' => 'query', - 'schema' => [ - 'title' => '实例ID。', - 'description' => '实例ID，可通过接口ListInstances获取。', - 'type' => 'string', - 'required' => true, - 'example' => 'pairec-test1', - ], + 'schema' => ['title' => '实例ID。', 'description' => '实例ID，可通过接口ListInstances获取。', 'type' => 'string', 'required' => true, 'example' => 'pairec-cn-abcdefg1234'], ], ], 'responses' => [ @@ -6823,201 +5834,98 @@ 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'Id of the request', - 'type' => 'string', - 'example' => '1C0898E5-9220-5443-B2D9-445FF0688215', - ], - 'TotalCount' => [ - 'title' => '列表内元素总数。', - 'description' => '列表内元素总数。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '10', - ], - 'Laboratories' => [ - 'title' => '实验室列表。', - 'description' => '实验室列表。', - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'LaboratoryId' => [ - 'title' => '实验室ID。', - 'description' => '实验室ID。', - 'type' => 'string', - 'example' => '3', - ], - 'SceneId' => [ - 'title' => '场景ID。', - 'description' => '场景ID。', - 'type' => 'string', - 'example' => '3', - ], - 'Name' => [ - 'title' => '实验室名称。', - 'description' => '实验室名称。', - 'type' => 'string', - 'example' => 'laboratory1', - ], - 'Description' => [ - 'title' => '实验室描述。', - 'description' => '实验室描述。', - 'type' => 'string', - 'example' => 'This is a test.', - ], - 'DebugUsers' => [ - 'title' => '调试用户。', - 'description' => '调试用户。', - 'type' => 'string', - 'example' => 'user1,user2,user3', - ], - 'DebugCrowdId' => [ - 'title' => '调试人群ID。', - 'description' => '调试人群ID。', - 'type' => 'string', - 'example' => '3', - ], - 'BucketCount' => [ - 'title' => '分桶数量。', - 'description' => '分桶数量。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '100', - ], - 'Buckets' => [ - 'title' => '分配桶号。', - 'description' => '分配桶号。', - 'type' => 'string', - 'example' => '1,2,3,10-20', - ], - 'BucketType' => [ - 'title' => '分桶方式。'."\n" - .'● Uid-UID分桶（默认）'."\n" - .'● UidHash-UID哈希'."\n" - .'● Filter-过滤条件分桶', - 'description' => '分桶方式。'."\n" - ."\n" - .'- Uid-UID：分桶（默认）'."\n" - .'- UidHash：UID哈希'."\n" - .'- Filter：过滤条件分桶', - 'type' => 'string', - 'example' => 'Filter', - ], - 'Filter' => [ - 'title' => '过滤条件。', - 'description' => '过滤条件。', - 'type' => 'string', - 'example' => 'filter=xxx', - ], - 'Environment' => [ - 'title' => '运行环境'."\n" - .'● Daily-日常环境'."\n" - .'● Pre-预发环境'."\n" - .'● Prod-生产环境', - 'description' => '运行环境'."\n" - ."\n" - .'- Daily：日常环境'."\n" - .'- Pre：预发环境'."\n" - .'- Prod：生产环境', - 'type' => 'string', - 'example' => 'Daily', - ], - 'Type' => [ - 'title' => '实验室类型'."\n" - .'● Base'."\n" - .'● NonBase', - 'description' => '实验室类型'."\n" - ."\n" - .'- Base'."\n" - .'- NonBase', - 'type' => 'string', - 'example' => 'Base', - ], - 'Status' => [ - 'title' => '状态。'."\n" - .'● Offline-未上线。'."\n" - .'● Online-已上线。', - 'description' => '状态。'."\n" - ."\n" - .'- Offline：未上线'."\n" - .'- Online：已上线', - 'type' => 'string', - 'example' => 'Offline', - ], - 'CrowdId' => [ - 'title' => '人群ID。', - 'description' => '人群ID。', - 'type' => 'string', - 'example' => '3', - ], - ], - ], - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => 'BDB621CB-A81E-5D39-8793-39A365CBCC74'], + 'LayerId' => ['title' => '层ID。', 'description' => '层ID。', 'type' => 'string', 'example' => '3'], + 'LaboratoryId' => ['title' => '实验室ID。', 'description' => '实验室ID。', 'type' => 'string', 'example' => '4'], + 'SceneId' => ['title' => '场景ID。', 'description' => '场景ID。', 'type' => 'string', 'example' => '1'], + 'Name' => ['title' => '实验组名称。', 'description' => '实验组名称。', 'type' => 'string', 'example' => 'experiment_group1'], + 'Description' => ['title' => '实验组描述。', 'description' => '实验组描述。', 'type' => 'string', 'example' => 'This is a test.'], + 'DebugUsers' => ['title' => '调试用户。', 'description' => '调试用户，多个用户间用逗号作间隔。', 'type' => 'string', 'example' => '1124512470******,1124512471******,1124512472******'], + 'DebugCrowdId' => ['title' => '调试人群ID。', 'description' => '调试人群ID。', 'type' => 'string', 'example' => '4'], + 'Owner' => ['title' => '创建人。', 'description' => '创建人。', 'type' => 'string', 'example' => '1124512470******'], + 'NeedAA' => ['title' => '是否需要AB实验组。', 'description' => '是否需要AB实验组。', 'type' => 'boolean', 'example' => 'true'], + 'Filter' => ['title' => '过滤条件。', 'description' => '过滤条件。', 'type' => 'string', 'example' => 'gender=female'], + 'DistributionType' => ['title' => '分流方式。'."\n" + .'● UserId-用户ID'."\n" + .'● TimeDuration-时段', 'description' => '分流方式。'."\n" + .'● UserId-用户ID'."\n" + .'● TimeDuration-时段', 'type' => 'string', 'example' => 'UserId'], + 'DistributionTimeDuration' => ['title' => '分流时段。', 'description' => '分流时段。', 'type' => 'integer', 'format' => 'int32', 'example' => '5'], + 'CrowdId' => ['title' => '人群ID。', 'description' => '人群ID。', 'type' => 'string', 'example' => '3'], + 'Config' => ['title' => '实验组配置。', 'description' => '实验组配置。', 'type' => 'string', 'example' => '{"RankBy": "Score"}'], + 'ReservedBuckets' => ['title' => '预留桶号。', 'description' => '预留桶号。', 'type' => 'string', 'example' => '1,2,3,4'], + 'Status' => ['title' => '实验组状态。'."\n" + .'● Offline-未上线'."\n" + .'● Online-已上线'."\n" + .'● Pushed-已推全', 'description' => '实验组状态。'."\n" + .'● Offline-未上线'."\n" + .'● Online-已上线'."\n" + .'● Pushed-已推全', 'type' => 'string', 'example' => 'Offline'], + 'CrowdTargetType' => ['description' => '实验组流量定向的类型，可能的取值包括：'."\n" + .'* All 所有的流量'."\n" + .'* Filter 使用过滤条件的流量'."\n" + .'* CrowdId 通过指定人群ID'."\n" + .'* Random 按照百分比随机流量', 'type' => 'string', 'example' => 'All'], + 'RandomFlow' => ['description' => '当实验组流量定向的类型是Random时，使用随机流量匹配这个实验组，可能的取值范围是 0 - 100。', 'type' => 'integer', 'format' => 'int64', 'example' => '20'], + 'HoldingBuckets' => ['description' => '当实验组流量定向的类型是Random时，根据随机流量RandomFlow大小，返回的具体的桶号。', 'type' => 'string', 'example' => '1,2,3,4'], ], ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '获取实验组详细信息', + 'summary' => '获取指定实验组的详细信息。', + 'changeSet' => [ + ['createdAt' => '2024-03-20T06:05:19.000Z', 'description' => '响应参数发生变更'], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1C0898E5-9220-5443-B2D9-445FF0688215\\",\\n \\"TotalCount\\": 10,\\n \\"Laboratories\\": [\\n {\\n \\"LaboratoryId\\": \\"3\\",\\n \\"SceneId\\": \\"3\\",\\n \\"Name\\": \\"laboratory1\\",\\n \\"Description\\": \\"This is a test.\\",\\n \\"DebugUsers\\": \\"user1,user2,user3\\",\\n \\"DebugCrowdId\\": \\"3\\",\\n \\"BucketCount\\": 100,\\n \\"Buckets\\": \\"1,2,3,10-20\\",\\n \\"BucketType\\": \\"Filter\\",\\n \\"Filter\\": \\"filter=xxx\\",\\n \\"Environment\\": \\"Daily\\",\\n \\"Type\\": \\"Base\\",\\n \\"Status\\": \\"Offline\\",\\n \\"CrowdId\\": \\"3\\"\\n }\\n ]\\n}","type":"json"}]', - 'title' => '获取实验室列表', - ], - 'GetLaboratory' => [ - 'summary' => '获取指定实验室的详细信息。', - 'path' => '/api/v1/laboratories/{LaboratoryId}', - 'methods' => [ - 'get', + 'flowControl' => [ + 'flowControlList' => [], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'pairec:GetExperimentGroup', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIRecService', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"BDB621CB-A81E-5D39-8793-39A365CBCC74\\",\\n \\"LayerId\\": \\"3\\",\\n \\"LaboratoryId\\": \\"4\\",\\n \\"SceneId\\": \\"1\\",\\n \\"Name\\": \\"experiment_group1\\",\\n \\"Description\\": \\"This is a test.\\",\\n \\"DebugUsers\\": \\"1124512470******,1124512471******,1124512472******\\",\\n \\"DebugCrowdId\\": \\"4\\",\\n \\"Owner\\": \\"1124512470******\\",\\n \\"NeedAA\\": true,\\n \\"Filter\\": \\"gender=female\\",\\n \\"DistributionType\\": \\"UserId\\",\\n \\"DistributionTimeDuration\\": 5,\\n \\"CrowdId\\": \\"3\\",\\n \\"Config\\": \\"{\\\\\\"RankBy\\\\\\": \\\\\\"Score\\\\\\"}\\",\\n \\"ReservedBuckets\\": \\"1,2,3,4\\",\\n \\"Status\\": \\"Offline\\",\\n \\"CrowdTargetType\\": \\"All\\",\\n \\"RandomFlow\\": 20,\\n \\"HoldingBuckets\\": \\"1,2,3,4\\"\\n}","type":"json"}]', + ], + 'GetFeatureConsistencyCheckJob' => [ + 'summary' => '获取特征一致性检查任务详情。', + 'path' => '/api/v1/featureconsistencycheck/jobs/{FeatureConsistencyCheckJobId}', + 'methods' => ['get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATURElearnN0NAWV', - ], + 'abilityTreeNodes' => ['FEATURElearnN0NAWV'], ], 'parameters' => [ [ - 'name' => 'LaboratoryId', + 'name' => 'FeatureConsistencyCheckJobId', 'in' => 'path', - 'schema' => [ - 'title' => '实验室ID。', - 'description' => '实验室ID，可通过接口ListLaboratories获取。', - 'type' => 'string', - 'required' => true, - 'example' => '3', - ], + 'schema' => ['title' => '特征一致性检查任务ID。', 'description' => '特征一致性检查任务ID。如何获取任务ID，请参见[ListFeatureConsistencyCheckJobs](~~2557571~~)。', 'type' => 'string', 'required' => false, 'example' => '4'], ], [ 'name' => 'InstanceId', 'in' => 'query', - 'schema' => [ - 'title' => '实例ID。', - 'description' => '实例ID，可通过接口ListInstances获取。', - 'type' => 'string', - 'required' => true, - 'example' => 'pairec-test1', - ], + 'schema' => ['title' => '实例ID。', 'description' => '实例ID。如何获取实例ID，请参见[ListInstances](~~2411819~~)。', 'type' => 'string', 'required' => false, 'example' => 'pairec-cn-********'], ], ], 'responses' => [ @@ -7027,184 +5935,223 @@ 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'Id of the request', - 'type' => 'string', - 'example' => '1C0898E5-9220-5443-B2D9-445FF0688215', - ], - 'SceneId' => [ - 'title' => '场景ID。', - 'description' => '场景ID。', - 'type' => 'string', - 'example' => '3', - ], - 'Name' => [ - 'title' => '实验室名称。', - 'description' => '实验室名称。', - 'type' => 'string', - 'example' => 'laboratory1', - ], - 'Description' => [ - 'title' => '实验室描述。', - 'description' => '实验室描述。', - 'type' => 'string', - 'example' => 'This is a test.', - ], - 'DebugUsers' => [ - 'title' => '调试用户。', - 'description' => '调试用户。', - 'type' => 'string', - 'example' => 'user1,user2,user3', - ], - 'DebugCrowdId' => [ - 'title' => '调试人群ID。', - 'description' => '调试人群ID。', - 'type' => 'string', - 'example' => '3', - ], - 'BucketCount' => [ - 'title' => '分桶数量。', - 'description' => '分桶数量。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '100', - ], - 'Buckets' => [ - 'title' => '分配桶号。', - 'description' => '分配桶号。', - 'type' => 'string', - 'example' => '1,2,3,10-20', - ], - 'BucketType' => [ - 'title' => '分桶方式。'."\n" - .'● Uid-UID分桶（默认）'."\n" - .'● UidHash-UID哈希'."\n" - .'● Filter-过滤条件分桶', - 'description' => '分桶方式。'."\n" - .'● Uid-UID分桶（默认）'."\n" - .'● UidHash-UID哈希'."\n" - .'● Filter-过滤条件分桶', - 'type' => 'string', - 'example' => 'Filter', - ], - 'Filter' => [ - 'title' => '过滤条件。', - 'description' => '过滤条件。', - 'type' => 'string', - 'example' => 'filter=xxx', - ], - 'Environment' => [ - 'title' => '运行环境'."\n" - .'● Daily-日常环境'."\n" - .'● Pre-预发环境'."\n" - .'● Prod-生产环境', - 'description' => '运行环境'."\n" - .'● Daily-日常环境'."\n" - .'● Pre-预发环境'."\n" - .'● Prod-生产环境', - 'type' => 'string', - 'example' => 'Daily', - ], - 'Type' => [ - 'title' => '实验室类型'."\n" - .'● Base'."\n" - .'● NonBase', - 'description' => '实验室类型'."\n" - .'● Base'."\n" - .'● NonBase', - 'type' => 'string', - 'example' => 'Base', - ], - 'Status' => [ - 'title' => '状态。'."\n" - .'● Offline-未上线。'."\n" - .'● Online-已上线。', - 'description' => '状态。'."\n" - .'● Offline-未上线。'."\n" - .'● Online-已上线。', - 'type' => 'string', - 'example' => 'Offline', - ], - 'CrowdId' => [ - 'title' => '人群ID。', - 'description' => '人群ID。', - 'type' => 'string', - 'example' => '3', + 'RequestId' => ['title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => 'A04CB8C0-E74A-5E83-BC61-64D153574EC7'], + 'FeatureConsistencyCheckJobConfigId' => ['title' => '特征一致性检查配置ID。', 'description' => '特征一致性检查配置ID。', 'type' => 'string', 'example' => '5'], + 'FeatureConsistencyCheckJobConfigName' => ['title' => '特征一致性检查任务配置名称。', 'description' => '特征一致性检查任务配置名称。', 'type' => 'string', 'example' => 'feature_consistency_check_1'], + 'GmtStartTime' => ['title' => '开始时间。', 'description' => '开始时间。', 'type' => 'string', 'example' => '2021-12-15T23:24:33.132+08:00'], + 'GmtEndTime' => ['title' => '结束时间。', 'description' => '结束时间。', 'type' => 'string', 'example' => '2021-12-15T23:24:33.132+08:00'], + 'Status' => ['title' => '任务状态。'."\n" + .'● ToRun-待运行。'."\n" + .'● Running-运行中。'."\n" + .'● Success-成功。'."\n" + .'● Failure-失败。'."\n" + .'● Terminated-停止/已取消。', 'description' => '任务状态。可能值为：'."\n" + .'- ToRun：待运行。'."\n" + .'- Running：运行中。'."\n" + .'- Success：成功。'."\n" + .'- Failure：失败。'."\n" + .'- Terminated：停止或已取消。', 'type' => 'string', 'example' => 'Running'], + 'Config' => ['title' => '配置信息。', 'description' => '配置信息。', 'type' => 'string', 'example' => '{}'], + 'Logs' => [ + 'title' => '日志信息。', + 'description' => '日志信息。', + 'type' => 'array', + 'items' => ['description' => '日志。', 'type' => 'string', 'example' => '2023-02-21 14:28:04 INFO: epoch [1][745/127291]tlr: 2.925e-05, eta: 2 days, 2:11:04, iter_time: 1.682, data_load_time: 0.997, memory: 12898, loss: 1.3768'], ], ], ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"A04CB8C0-E74A-5E83-BC61-64D153574EC7\\",\\n \\"FeatureConsistencyCheckJobConfigId\\": \\"5\\",\\n \\"FeatureConsistencyCheckJobConfigName\\": \\"feature_consistency_check_1\\",\\n \\"GmtStartTime\\": \\"2021-12-15T23:24:33.132+08:00\\",\\n \\"GmtEndTime\\": \\"2021-12-15T23:24:33.132+08:00\\",\\n \\"Status\\": \\"Running\\",\\n \\"Config\\": \\"{}\\",\\n \\"Logs\\": [\\n \\"2023-02-21 14:28:04 INFO: epoch [1][745/127291]tlr: 2.925e-05, eta: 2 days, 2:11:04, iter_time: 1.682, data_load_time: 0.997, memory: 12898, loss: 1.3768\\"\\n ]\\n}","type":"json"}]', + 'title' => '获取特征一致性检查任务详情', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'pairec:GetFeatureConsistencyCheckJob', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIRecService', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1C0898E5-9220-5443-B2D9-445FF0688215\\",\\n \\"SceneId\\": \\"3\\",\\n \\"Name\\": \\"laboratory1\\",\\n \\"Description\\": \\"This is a test.\\",\\n \\"DebugUsers\\": \\"user1,user2,user3\\",\\n \\"DebugCrowdId\\": \\"3\\",\\n \\"BucketCount\\": 100,\\n \\"Buckets\\": \\"1,2,3,10-20\\",\\n \\"BucketType\\": \\"Filter\\",\\n \\"Filter\\": \\"filter=xxx\\",\\n \\"Environment\\": \\"Daily\\",\\n \\"Type\\": \\"Base\\",\\n \\"Status\\": \\"Offline\\",\\n \\"CrowdId\\": \\"3\\"\\n}","type":"json"}]', - 'title' => '获取实验室详细信息', ], - 'OnlineLaboratory' => [ - 'summary' => '将指定实验室进行发布上线，以开展实验分析。', - 'path' => '/api/v1/laboratories/{LaboratoryId}/action/online', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'GetFeatureConsistencyCheckJobConfig' => [ + 'summary' => '获取特征一致性检查任务配置详情。', + 'path' => '/api/v1/featureconsistencycheck/jobconfigs/{FeatureConsistencyCheckJobConfigId}', + 'methods' => ['get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], - 'operationType' => 'readAndWrite', + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'none', + 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATURElearnN0NAWV', - ], + 'abilityTreeCode' => '193280', + 'abilityTreeNodes' => ['FEATURElearnN0NAWV'], ], 'parameters' => [ [ - 'name' => 'LaboratoryId', + 'name' => 'FeatureConsistencyCheckJobConfigId', 'in' => 'path', - 'schema' => [ - 'title' => '实验室ID。', - 'description' => '实验室ID，可通过接口ListLaboratories获取。', - 'type' => 'string', - 'required' => true, - 'example' => '3', - ], + 'schema' => ['title' => '特征一致性检查配置ID。', 'description' => '特征一致性检查配置ID。如何获取配置ID，请参见[ListFeatureConsistencyCheckJobConfigs](~~2557567~~)。', 'type' => 'string', 'required' => true, 'example' => '3'], ], [ - 'name' => 'body', - 'in' => 'body', - 'style' => 'json', + 'name' => 'InstanceId', + 'in' => 'query', + 'schema' => ['title' => '实例ID，可从接口ListInstances获取。', 'description' => '实例ID。如何获取实例ID，请参见[ListInstances](~~2411819~~)。', 'type' => 'string', 'required' => true, 'example' => 'pairec-cn-********'], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => '请求body。', + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'InstanceId' => [ - 'title' => '实例ID。', - 'description' => '实例ID，可通过接口ListInstances获取。', - 'type' => 'string', - 'required' => true, - 'example' => 'pairec-test1', - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => '728C5E01-ABF6-5AA8-B9FC-B3BA05DECC77'], + 'Name' => ['title' => '特征一致性检查配置名称。', 'description' => '特征一致性检查配置名称。', 'type' => 'string', 'example' => 'feature_consistency_check1'], + 'SceneId' => ['title' => '场景ID。', 'description' => '场景ID。', 'type' => 'string', 'example' => '3'], + 'SceneName' => ['title' => '场景名称。', 'description' => '场景名称。', 'type' => 'string', 'example' => 'scene1'], + 'Status' => ['title' => '状态。'."\n" + .'● Editable-可编辑的。'."\n" + .'● Uneditable-不可编辑的。', 'description' => '状态。可能值为：'."\n" + .'- Editable：可编辑的。'."\n" + .'- Uneditable：不可编辑的。', 'type' => 'string', 'example' => 'Editable'], + 'CompareFeature' => ['title' => '是否开启特征比对。', 'description' => '是否开启特征比对。', 'type' => 'boolean', 'example' => 'true'], + 'LatestJobId' => ['title' => '基于该配置最近一次创建的任务ID。', 'description' => '基于该配置最近一次创建的任务ID。', 'type' => 'string', 'example' => '3'], + 'LatestJobGmtSamplingStartTime' => ['title' => '最近一次创建的任务的开始时间。', 'description' => '最近一次创建的任务的开始时间。', 'type' => 'string', 'example' => '2021-12-15T23:24:33.132+08:00'], + 'LatestJobGmtSamplingEndTime' => ['title' => '最近一次创建的任务的结束时间。', 'description' => '最近一次创建的任务的结束时间。', 'type' => 'string', 'example' => '2021-12-15T23:24:33.132+08:00'], + 'SampleRate' => ['title' => '采样比例（0-1）。', 'description' => '采样比例（0-1）。', 'type' => 'string', 'example' => '0.89'], + 'FeatureLandingResourceId' => ['title' => '数据回落数据源ID。', 'description' => '数据回落数据源ID。', 'type' => 'string', 'example' => 'reso-********'], + 'FeatureLandingResourceUri' => ['title' => '数据回落数据源地址。', 'description' => '数据回落数据源地址。', 'type' => 'string', 'example' => 'mc_project_1'], + 'EasServiceName' => ['title' => 'EAS服务名称。', 'description' => 'EAS服务名称。', 'type' => 'string', 'example' => 'eas_service_1'], + 'FgJsonFileName' => ['title' => 'fg_json文件名称。', 'description' => 'fg_json文件名称。', 'type' => 'string', 'example' => 'file.json'], + 'UserTable' => ['title' => 'user表名。', 'description' => 'user表名。', 'type' => 'string', 'example' => 'user_table'], + 'UserIdField' => ['title' => 'user_id字段名。', 'description' => 'user_id字段名。', 'type' => 'string', 'example' => 'user_id'], + 'UserTablePartitionField' => ['title' => 'user表分区字段。', 'description' => 'user表分区字段。', 'type' => 'string', 'example' => 'ds'], + 'UserTablePartitionFieldFormat' => ['title' => 'user表分区字段格式。'."\n" + .'● yyyymmdd'."\n" + .'● yyyy-mm-dd', 'description' => 'user表分区字段格式：'."\n" + .'- yyyymmdd'."\n" + .'- yyyy-mm-dd', 'type' => 'string', 'example' => 'yyyymmdd'], + 'ItemTable' => ['title' => 'item表名。', 'description' => 'item表名。', 'type' => 'string', 'example' => 'item_table'], + 'ItemIdField' => ['title' => 'item_id字段名。', 'description' => 'item_id字段名。', 'type' => 'string', 'example' => 'item_id'], + 'ItemTablePartitionField' => ['title' => 'item表分区字段。', 'description' => 'item表分区字段。', 'type' => 'string', 'example' => 'ds'], + 'ItemTablePartitionFieldFormat' => ['title' => 'item表分区字段格式。'."\n" + .'● yyyymmdd'."\n" + .'● yyyy-mm-dd', 'description' => 'item表分区字段格式：'."\n" + .'- yyyymmdd'."\n" + .'- yyyy-mm-dd', 'type' => 'string', 'example' => 'yyyymmdd'], + 'GenerateZip' => ['title' => '是否需要生成zip包。', 'description' => '是否需要生成zip包。', 'type' => 'boolean', 'example' => 'true'], + 'ServiceId' => ['title' => '服务ID。', 'description' => '服务ID。', 'type' => 'string', 'example' => '4'], + 'ServiceName' => ['title' => '服务名称。', 'description' => '服务名称。', 'type' => 'string', 'example' => 'service1'], + 'WorkflowName' => ['title' => '工作流名称。', 'description' => '工作流名称。', 'type' => 'string', 'example' => 'work_flow_1'], + 'OssResourceId' => ['title' => 'OSS数据源ID。', 'description' => 'OSS数据源ID。', 'type' => 'string', 'example' => 'reso-********'], + 'OssBucket' => ['title' => 'OSS bucket名称。', 'description' => 'OSS bucket名称。', 'type' => 'string', 'example' => 'oss_bucket_1'], + 'EasyRecVersion' => ['title' => 'EasyRec版本。', 'description' => 'EasyRec版本。', 'type' => 'string', 'example' => '1.3.60'], + 'EasyRecPackagePath' => ['title' => 'EasyRec包路径。', 'description' => 'EasyRec包路径。', 'type' => 'string', 'example' => 'oss://*******'], + 'FgJarVersion' => ['title' => 'fg_jar版本。', 'description' => 'fg_jar版本。', 'type' => 'string', 'example' => '1.0.0'], + 'FeaturePriority' => ['title' => '特征优先级，多个特征通过逗号分开。', 'description' => '特征优先级，多个特征通过半角逗号（,）分开。', 'type' => 'string', 'example' => 'feature1,feature2,feature3'], + 'FeatureDisplayExclude' => ['title' => '特征展示过滤，多个特征通过逗号分开。', 'description' => '特征展示过滤，多个特征通过半角逗号（,）分开。', 'type' => 'string', 'example' => 'feature1,feature2'], + 'GmtCreateTime' => ['title' => '创建时间。', 'description' => '创建时间。', 'type' => 'string', 'example' => '2021-12-15T23:24:33.132+08:00'], + 'GmtModifiedTime' => ['title' => '更新时间。', 'description' => '更新时间。', 'type' => 'string', 'example' => '2021-12-15T23:24:33.132+08:00'], + 'UseFeatureStore' => ['description' => '是否需要使用feature store，取值：'."\n" + ."\n" + .'- true：使用，此时返回FeatureStoreProjectId、FeatureStoreProjectName、FeatureStoreModelId、FeatureStoreUserId、FeatureStoreItemId。'."\n" + .'- false：不使用，此时UserTable、UserIdField、UserTablePartitionField、UserTablePartitionFieldFormat、ItemTable、ItemIdField、ItemTablePartitionField、ItemTablePartitionFieldFormat为必填项。', 'type' => 'boolean', 'example' => 'true'], + 'FeatureStoreProjectName' => ['description' => 'feature store项目名称。', 'type' => 'string', 'example' => 'project-1'], + 'FeatureStoreModelId' => ['description' => 'feature store model ID。', 'type' => 'string', 'example' => '2'], + 'FeatureStoreUserId' => ['description' => 'feature store user侧主键。', 'type' => 'string', 'example' => 'user'], + 'FeatureStoreItemId' => ['description' => 'feature store item侧主键。', 'type' => 'string', 'example' => 'item'], + 'FeatureStoreSeqFeatureView' => ['description' => '序列特征中item特征所在的特征视图的名字。', 'type' => 'string', 'example' => 'item-1'], + 'FeatureStoreProjectId' => ['description' => 'feature store项目ID', 'type' => 'string', 'example' => 'prj-01'], + 'WorkspaceId' => ['type' => 'string', 'description' => ''], + 'VpcId' => ['type' => 'string', 'description' => ''], + 'SwitchId' => ['type' => 'string', 'description' => ''], + 'SecurityGroupId' => ['type' => 'string', 'description' => ''], + 'DefaultRoute' => ['type' => 'string', 'description' => ''], + 'DatasetId' => ['type' => 'string', 'description' => ''], + 'DatasetType' => ['type' => 'string', 'description' => ''], + 'DatasetUri' => ['type' => 'string', 'description' => ''], + 'DatasetMountPath' => ['type' => 'string', 'description' => ''], + 'DatasetName' => ['type' => 'string', 'description' => ''], + 'PredictWorkerCount' => ['type' => 'integer', 'format' => 'int32', 'description' => ''], + 'PredictWorkerCpu' => ['type' => 'integer', 'format' => 'int32', 'description' => ''], + 'PredictWorkerMemory' => ['type' => 'integer', 'format' => 'int32', 'description' => ''], + 'ResourceConfig' => ['type' => 'string', 'description' => ''], ], - 'required' => false, ], ], ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"728C5E01-ABF6-5AA8-B9FC-B3BA05DECC77\\",\\n \\"Name\\": \\"feature_consistency_check1\\",\\n \\"SceneId\\": \\"3\\",\\n \\"SceneName\\": \\"scene1\\",\\n \\"Status\\": \\"Editable\\",\\n \\"CompareFeature\\": true,\\n \\"LatestJobId\\": \\"3\\",\\n \\"LatestJobGmtSamplingStartTime\\": \\"2021-12-15T23:24:33.132+08:00\\",\\n \\"LatestJobGmtSamplingEndTime\\": \\"2021-12-15T23:24:33.132+08:00\\",\\n \\"SampleRate\\": \\"0.89\\",\\n \\"FeatureLandingResourceId\\": \\"reso-********\\",\\n \\"FeatureLandingResourceUri\\": \\"mc_project_1\\",\\n \\"EasServiceName\\": \\"eas_service_1\\",\\n \\"FgJsonFileName\\": \\"file.json\\",\\n \\"UserTable\\": \\"user_table\\",\\n \\"UserIdField\\": \\"user_id\\",\\n \\"UserTablePartitionField\\": \\"ds\\",\\n \\"UserTablePartitionFieldFormat\\": \\"yyyymmdd\\",\\n \\"ItemTable\\": \\"item_table\\",\\n \\"ItemIdField\\": \\"item_id\\",\\n \\"ItemTablePartitionField\\": \\"ds\\",\\n \\"ItemTablePartitionFieldFormat\\": \\"yyyymmdd\\",\\n \\"GenerateZip\\": true,\\n \\"ServiceId\\": \\"4\\",\\n \\"ServiceName\\": \\"service1\\",\\n \\"WorkflowName\\": \\"work_flow_1\\",\\n \\"OssResourceId\\": \\"reso-********\\",\\n \\"OssBucket\\": \\"oss_bucket_1\\",\\n \\"EasyRecVersion\\": \\"1.3.60\\",\\n \\"EasyRecPackagePath\\": \\"oss://*******\\",\\n \\"FgJarVersion\\": \\"1.0.0\\",\\n \\"FeaturePriority\\": \\"feature1,feature2,feature3\\",\\n \\"FeatureDisplayExclude\\": \\"feature1,feature2\\",\\n \\"GmtCreateTime\\": \\"2021-12-15T23:24:33.132+08:00\\",\\n \\"GmtModifiedTime\\": \\"2021-12-15T23:24:33.132+08:00\\",\\n \\"UseFeatureStore\\": true,\\n \\"FeatureStoreProjectName\\": \\"project-1\\",\\n \\"FeatureStoreModelId\\": \\"2\\",\\n \\"FeatureStoreUserId\\": \\"user\\",\\n \\"FeatureStoreItemId\\": \\"item\\",\\n \\"FeatureStoreSeqFeatureView\\": \\"item-1\\",\\n \\"FeatureStoreProjectId\\": \\"prj-01\\",\\n \\"WorkspaceId\\": \\"\\",\\n \\"VpcId\\": \\"\\",\\n \\"SwitchId\\": \\"\\",\\n \\"SecurityGroupId\\": \\"\\",\\n \\"DefaultRoute\\": \\"\\",\\n \\"DatasetId\\": \\"\\",\\n \\"DatasetType\\": \\"\\",\\n \\"DatasetUri\\": \\"\\",\\n \\"DatasetMountPath\\": \\"\\",\\n \\"DatasetName\\": \\"\\",\\n \\"PredictWorkerCount\\": 0,\\n \\"PredictWorkerCpu\\": 0,\\n \\"PredictWorkerMemory\\": 0,\\n \\"ResourceConfig\\": \\"\\"\\n}","type":"json"}]', + 'title' => '获取特征一致性检查任务配置详情', + 'changeSet' => [ + ['createdAt' => '2025-06-04T10:10:20.000Z', 'description' => '响应参数发生变更'], + ['createdAt' => '2024-12-10T06:00:28.000Z', 'description' => '响应参数发生变更'], + ['createdAt' => '2024-11-12T09:17:26.000Z', 'description' => '响应参数发生变更'], + ['createdAt' => '2024-02-22T03:35:43.000Z', 'description' => '响应参数发生变更'], + ], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'pairec:GetFeatureConsistencyCheckJobConfig', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIRecService', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + ], + ], + 'GetInstance' => [ + 'summary' => '获取指定PAIRec实例的详细信息。', + 'path' => '/api/v1/instances/{InstanceId}', + 'methods' => ['get'], + 'schemes' => ['http', 'https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '163068', + 'abilityTreeNodes' => ['FEATURElearnN0NAWV'], + ], + 'parameters' => [ + [ + 'name' => 'InstanceId', + 'in' => 'path', + 'schema' => ['title' => '实例ID。', 'description' => '实例ID，可通过接口ListInstances获取。', 'type' => 'string', 'required' => false, 'example' => 'pairec-cn-abcdefg1234'], + ], + ], 'responses' => [ 200 => [ 'schema' => [ @@ -7212,86 +6159,305 @@ 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'Id of the request', - 'type' => 'string', - 'example' => '8C27790E-CCA5-56BB-BA17-646295DEC0A2', + 'RequestId' => ['title' => '请求id。', 'description' => '请求id。', 'type' => 'string', 'example' => '728C5E01-ABF6-5AA8-B9FC-B3BA05DECC77'], + 'InstanceId' => ['title' => '实例id。', 'description' => '实例id。', 'type' => 'string', 'example' => 'pairec-test1'], + 'Type' => ['title' => '实例类型。'."\n" + .'● basic-基础版'."\n" + .'● highleve-升级版'."\n" + .'● advance-进阶版'."\n" + .'● standard-标准版', 'description' => '实例类型。'."\n" + .'● basic-基础版'."\n" + .'● highleve-升级版'."\n" + .'● advance-进阶版'."\n" + .'● standard-标准版', 'type' => 'string', 'example' => 'basic'], + 'Status' => ['title' => '实例状态。'."\n" + .'● Initializing-初始化中'."\n" + .'● Stopped-停止服务'."\n" + .'● Running-运行中', 'description' => '实例状态。'."\n" + .'● Initializing-初始化中'."\n" + .'● Stopped-停止服务'."\n" + .'● Running-运行中', 'type' => 'string', 'example' => 'Initializing'], + 'RegionId' => ['title' => '区域ID。'."\n" + .'● cn-shenzhen - 深圳'."\n" + .'● cn-hangzhou - 杭州'."\n" + .'● cn-beijing - 北京'."\n" + .'● cn-shanghai - 上海', 'description' => '区域ID。'."\n" + .'● cn-shenzhen - 深圳'."\n" + .'● cn-hangzhou - 杭州'."\n" + .'● cn-beijing - 北京'."\n" + .'● cn-shanghai - 上海', 'type' => 'string', 'example' => 'cn-shenzhen'], + 'GmtCreateTime' => ['title' => '实例创建时间。', 'description' => '实例创建时间。', 'type' => 'string', 'example' => '2022-10-13 17:34:52.0'], + 'GmtModifiedTime' => ['title' => '实例更新时间。', 'description' => '实例更新时间。', 'type' => 'string', 'example' => '2022-11-05 09:02:30.0'], + 'ExpiredTime' => ['title' => '实例过期时间。', 'description' => '实例过期时间。', 'type' => 'string', 'example' => '2022-12-14 00:00:00.0'], + 'CommodityCode' => ['title' => '实例所属的商品code。', 'description' => '实例所属的商品code。', 'type' => 'string', 'example' => 'airec_developers_public_cn'], + 'ChargeType' => ['title' => '实例的付费类型，目前仅支持Subscription（预付费）。', 'description' => '实例的付费类型，目前仅支持Subscription（预付费）。', 'type' => 'string', 'example' => 'Subscription'], + 'Config' => [ + 'title' => '实例配置。', + 'description' => '实例配置。', + 'type' => 'object', + 'properties' => [ + 'Engines' => [ + 'title' => '服务引擎列表。', + 'description' => '服务引擎列表。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'ComponentCode' => ['title' => '组件代码。', 'description' => '组件代码。', 'type' => 'string', 'example' => 'feature'], + 'Type' => ['title' => '组件类型。', 'description' => '组件类型。', 'type' => 'string', 'example' => 'Hologres'], + 'Meta' => ['title' => '元数据。', 'description' => '元数据。', 'type' => 'object'], + ], + 'description' => '', + ], + ], + 'Monitors' => [ + 'title' => '配套功能列表。', + 'description' => '配套功能列表。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'ComponentCode' => ['title' => '组件代码。', 'description' => '组件代码。', 'type' => 'string', 'example' => 'featuresets'], + 'Type' => ['title' => '组件类型。', 'description' => '组件类型。', 'type' => 'string', 'example' => 'Platform'], + 'Meta' => ['title' => '元数据。', 'description' => '元数据。', 'type' => 'object'], + ], + 'description' => '', + ], + ], + 'DataManagements' => [ + 'title' => '建模环境列表。', + 'description' => '建模环境列表。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'ComponentCode' => ['title' => '组件代码。', 'description' => '组件代码。', 'type' => 'string', 'example' => 'storage'], + 'Type' => ['title' => '组件类型。', 'description' => '组件类型。', 'type' => 'string', 'example' => 'OSS'], + 'Meta' => ['title' => '元数据。', 'description' => '元数据。', 'type' => 'object'], + ], + 'description' => '', + ], + ], + ], + ], + 'OperatingTool' => [ + 'description' => '运营工具相关配置。', + 'type' => 'object', + 'properties' => [ + 'IsEnable' => ['description' => '实例是不是启用了运营工具，取值：'."\n" + .'- True 开启'."\n" + .'- False 未开启', 'type' => 'boolean', 'example' => 'True'], + ], ], ], ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"728C5E01-ABF6-5AA8-B9FC-B3BA05DECC77\\",\\n \\"InstanceId\\": \\"pairec-test1\\",\\n \\"Type\\": \\"basic\\",\\n \\"Status\\": \\"Initializing\\",\\n \\"RegionId\\": \\"cn-shenzhen\\",\\n \\"GmtCreateTime\\": \\"2022-10-13 17:34:52.0\\",\\n \\"GmtModifiedTime\\": \\"2022-11-05 09:02:30.0\\",\\n \\"ExpiredTime\\": \\"2022-12-14 00:00:00.0\\",\\n \\"CommodityCode\\": \\"airec_developers_public_cn\\",\\n \\"ChargeType\\": \\"Subscription\\",\\n \\"Config\\": {\\n \\"Engines\\": [\\n {\\n \\"ComponentCode\\": \\"feature\\",\\n \\"Type\\": \\"Hologres\\",\\n \\"Meta\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n }\\n }\\n ],\\n \\"Monitors\\": [\\n {\\n \\"ComponentCode\\": \\"featuresets\\",\\n \\"Type\\": \\"Platform\\",\\n \\"Meta\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n }\\n }\\n ],\\n \\"DataManagements\\": [\\n {\\n \\"ComponentCode\\": \\"storage\\",\\n \\"Type\\": \\"OSS\\",\\n \\"Meta\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n }\\n }\\n ]\\n },\\n \\"OperatingTool\\": {\\n \\"IsEnable\\": true\\n }\\n}","type":"json"}]', + 'title' => '获取实例详细信息', + 'changeSet' => [ + ['createdAt' => '2024-08-05T08:37:23.000Z', 'description' => '响应参数发生变更'], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"8C27790E-CCA5-56BB-BA17-646295DEC0A2\\"\\n}","type":"json"}]', - 'title' => '上线实验室', - ], - 'OfflineLaboratory' => [ - 'summary' => '将指定实验室下线。', - 'path' => '/api/v1/laboratories/{LaboratoryId}/action/offline', - 'methods' => [ - 'post', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetInstance'], + ], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'pairec:GetInstance', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIRecService', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], ], + ], + 'GetInstanceResource' => [ + 'summary' => '获取指定实例下指定资源的详细信息。', + 'path' => '/api/v1/instances/{InstanceId}/resources/{ResourceId}', + 'methods' => ['get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], - 'operationType' => 'readAndWrite', + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATURElearnN0NAWV', - ], + 'abilityTreeNodes' => ['FEATURElearnN0NAWV'], ], 'parameters' => [ [ - 'name' => 'LaboratoryId', + 'name' => 'InstanceId', 'in' => 'path', - 'schema' => [ - 'title' => '实验室ID。', - 'description' => '实验室ID，可通过接口ListLaboratories获取。', - 'type' => 'string', - 'required' => true, - 'example' => '3', - ], + 'schema' => ['description' => '实例ID，可通过接口[ListInstances](~~2411819~~)获取。', 'type' => 'string', 'required' => true, 'example' => 'pairec-cn-test1'], ], [ - 'name' => 'body', - 'in' => 'body', - 'style' => 'json', + 'name' => 'ResourceId', + 'in' => 'path', + 'schema' => ['description' => '资源ID。', 'type' => 'string', 'required' => true, 'example' => 'reso-2s416t***'], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'title' => '请求body。', - 'description' => '请求body。', + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'InstanceId' => [ - 'title' => '实例ID。', - 'description' => '实例ID，可通过接口ListInstances获取。', - 'type' => 'string', - 'required' => true, - 'example' => 'pairec-cn-abcdefg1234', - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => 'D75C43DC-3D3A-5CC8-9AAC-8C77306C433B'], + 'ResourceId' => ['description' => '资源ID。', 'type' => 'string', 'example' => 'reso-2s416t***'], + 'Category' => ['description' => '资源类别'."\n" + ."\n" + .'- DataManagement'."\n" + ."\n" + .'- Engine'."\n" + ."\n" + .'- Monitor', 'type' => 'string', 'example' => 'DataManagement'], + 'Group' => ['description' => '资源分组。'."\n" + ."\n" + .'当资源类别为DataManagement时，资源分组有：'."\n" + ."\n" + .'- storage'."\n" + ."\n" + .'- modelpipeline'."\n" + ."\n" + .'- datastorage'."\n" + ."\n" + .'- modeltrain'."\n" + ."\n" + .'当资源类别为Engine时，资源分组有：'."\n" + ."\n" + .'- feature'."\n" + ."\n" + .'- predict'."\n" + ."\n" + .'- recall'."\n" + ."\n" + .'- recengine'."\n" + ."\n" + .'当资源类别为Monitor时，资源分组有：'."\n" + ."\n" + .'- logs'."\n" + ."\n" + .'- logsback'."\n" + ."\n" + .'- coldstart'."\n" + ."\n" + .'- deploy', 'type' => 'string', 'example' => 'storage'], + 'Type' => ['description' => '资源类型'."\n" + ."\n" + .'- Hologres'."\n" + ."\n" + .'- EAS'."\n" + ."\n" + .'- BE'."\n" + ."\n" + .'- Rec'."\n" + ."\n" + .'- Platform'."\n" + ."\n" + .'- SLS'."\n" + ."\n" + .'- DataHub'."\n" + ."\n" + .'- Kafka'."\n" + ."\n" + .'- Flinkvvp'."\n" + ."\n" + .'- ACR'."\n" + ."\n" + .'- OSS'."\n" + ."\n" + .'- DataWorks'."\n" + ."\n" + .'- PAI'."\n" + ."\n" + .'- MaxCompute'."\n" + ."\n" + .'- GraphCompute'."\n" + ."\n" + .'- Redis', 'type' => 'string', 'example' => 'OSS'], + 'Uri' => ['description' => '资源地址。', 'type' => 'string', 'example' => 'bucket-test-123'], + 'Config' => ['description' => '资源的配置信息。', 'type' => 'string', 'example' => '{}'], + 'GmtCreateTime' => ['description' => '创建时间。', 'type' => 'string', 'example' => '2020-10-13 17:34:52'], + 'GmtModifiedTime' => ['description' => '更新时间。', 'type' => 'string', 'example' => '2020-10-13 17:34:52'], ], - 'required' => false, ], ], ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"D75C43DC-3D3A-5CC8-9AAC-8C77306C433B\\",\\n \\"ResourceId\\": \\"reso-2s416t***\\",\\n \\"Category\\": \\"DataManagement\\",\\n \\"Group\\": \\"storage\\",\\n \\"Type\\": \\"OSS\\",\\n \\"Uri\\": \\"bucket-test-123\\",\\n \\"Config\\": \\"{}\\",\\n \\"GmtCreateTime\\": \\"2020-10-13 17:34:52\\",\\n \\"GmtModifiedTime\\": \\"2020-10-13 17:34:52\\"\\n}","type":"json"}]', + 'title' => '获取资源详细信息', + 'changeSet' => [ + ['createdAt' => '2024-02-22T03:35:44.000Z', 'description' => '请求参数发生变更'], + ], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'pairec:GetInstanceResource', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIRecService', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + ], + ], + 'GetInstanceResourceTable' => [ + 'summary' => '获取数据源下数据表的列表。', + 'path' => '/api/v1/instances/{InstanceId}/resources/{ResourceId}/tables/{TableName}', + 'methods' => ['get'], + 'schemes' => ['http', 'https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATURElearnN0NAWV'], + ], + 'parameters' => [ + [ + 'name' => 'InstanceId', + 'in' => 'path', + 'schema' => ['description' => '实例ID，可通过接口[ListInstances](~~2411819~~)获取。', 'type' => 'string', 'required' => true, 'example' => 'pairec-cn-test1'], + ], + [ + 'name' => 'ResourceId', + 'in' => 'path', + 'schema' => ['description' => '资源ID。', 'type' => 'string', 'required' => true, 'example' => 'reso-2s416t***'], + ], + [ + 'name' => 'TableName', + 'in' => 'path', + 'schema' => ['description' => '表名称过滤。', 'type' => 'string', 'required' => true, 'example' => 'test_table'], + ], + ], 'responses' => [ 200 => [ 'schema' => [ @@ -7299,106 +6465,181 @@ 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'Id of the request', - 'type' => 'string', - 'example' => '59CE7EC6-F268-5D71-9215-32922CC50D72', + 'RequestId' => ['title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => '74D958EF-3598-56FA-8296-FF1575CE43DF'], + 'TableName' => ['description' => '表名。', 'type' => 'string', 'example' => 'test_table'], + 'Fields' => [ + 'description' => '表的字段列表。', + 'type' => 'array', + 'items' => [ + 'description' => '字段信息。', + 'type' => 'object', + 'properties' => [ + 'Name' => ['description' => '字段名称。', 'type' => 'string', 'example' => 'age'], + 'Type' => ['description' => '字段类型。', 'type' => 'string', 'example' => 'BIGINT'], + 'Meaning' => ['description' => '字段含义。', 'type' => 'string', 'example' => '""'], + 'IsDimensionField' => ['description' => '是否是维度字段。', 'type' => 'boolean', 'example' => 'false'], + 'IsPartitionField' => ['description' => '是否为分区字段。', 'type' => 'boolean', 'example' => 'true'], + ], + ], ], ], ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"74D958EF-3598-56FA-8296-FF1575CE43DF\\",\\n \\"TableName\\": \\"test_table\\",\\n \\"Fields\\": [\\n {\\n \\"Name\\": \\"age\\",\\n \\"Type\\": \\"BIGINT\\",\\n \\"Meaning\\": \\"\\\\\\"\\\\\\"\\",\\n \\"IsDimensionField\\": false,\\n \\"IsPartitionField\\": true\\n }\\n ]\\n}","type":"json"}]', + 'title' => '获取资源下表信息', + 'changeSet' => [ + ['createdAt' => '2024-02-22T03:35:44.000Z', 'description' => '请求参数发生变更、响应参数发生变更'], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"59CE7EC6-F268-5D71-9215-32922CC50D72\\"\\n}","type":"json"}]', - 'title' => '下线实验室', - ], - 'CloneLaboratory' => [ - 'summary' => '将指定实验室克隆到指定环境，克隆时需指定是否克隆实验室下的实验组。', - 'path' => '/api/v1/laboratories/{LaboratoryId}/action/clone', - 'methods' => [ - 'post', + 'flowControl' => [ + 'flowControlList' => [], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'pairec:GetInstanceResourceTable', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIRecService', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], ], + ], + 'GetLaboratory' => [ + 'path' => '/api/v1/laboratories/{LaboratoryId}', + 'methods' => ['get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], - 'operationType' => 'readAndWrite', + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'none', + 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATURElearnN0NAWV', - ], + 'abilityTreeNodes' => ['FEATURElearnN0NAWV'], ], 'parameters' => [ [ 'name' => 'LaboratoryId', 'in' => 'path', - 'schema' => [ - 'title' => '实验室ID。', - 'description' => '实验室ID，可通过接口ListLaboratories获取。', - 'type' => 'string', - 'required' => true, - 'example' => '3', - ], + 'schema' => ['title' => '实验室ID。', 'description' => '实验室ID，可通过接口ListLaboratories获取。', 'type' => 'string', 'required' => true, 'example' => '3'], ], [ - 'name' => 'body', - 'in' => 'body', - 'style' => 'json', + 'name' => 'InstanceId', + 'in' => 'query', + 'schema' => ['title' => '实例ID。', 'description' => '实例ID，可通过接口ListInstances获取。', 'type' => 'string', 'required' => true, 'example' => 'pairec-test1'], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'title' => '请求body。', - 'description' => '请求body。', + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'InstanceId' => [ - 'title' => '实例ID。', - 'description' => '实例ID，可通过接口ListInstances获取。', - 'type' => 'string', - 'required' => true, - 'example' => 'pairec-cn-abcdefg1234', - ], - 'Environment' => [ - 'title' => '运行环境'."\n" - .'● Daily-日常环境'."\n" - .'● Pre-预发环境'."\n" - .'● Prod-生产环境', - 'description' => '运行环境'."\n" - .'● Daily-日常环境'."\n" - .'● Pre-预发环境'."\n" - .'● Prod-生产环境', - 'type' => 'string', - 'required' => true, - 'example' => 'Daily', - ], - 'CloneExperimentGroup' => [ - 'title' => '是否克隆实验组。', - 'description' => '是否克隆实验组。', - 'type' => 'boolean', - 'required' => true, - 'example' => 'true', - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => '1C0898E5-9220-5443-B2D9-445FF0688215'], + 'SceneId' => ['title' => '场景ID。', 'description' => '场景ID。', 'type' => 'string', 'example' => '3'], + 'Name' => ['title' => '实验室名称。', 'description' => '实验室名称。', 'type' => 'string', 'example' => 'laboratory1'], + 'Description' => ['title' => '实验室描述。', 'description' => '实验室描述。', 'type' => 'string', 'example' => 'This is a test.'], + 'DebugUsers' => ['title' => '调试用户。', 'description' => '调试用户。', 'type' => 'string', 'example' => 'user1,user2,user3'], + 'DebugCrowdId' => ['title' => '调试人群ID。', 'description' => '调试人群ID。', 'type' => 'string', 'example' => '3'], + 'BucketCount' => ['title' => '分桶数量。', 'description' => '分桶数量。', 'type' => 'integer', 'format' => 'int32', 'example' => '100'], + 'Buckets' => ['title' => '分配桶号。', 'description' => '分配桶号。', 'type' => 'string', 'example' => '1,2,3,10-20'], + 'BucketType' => ['title' => '分桶方式。'."\n" + .'● Uid-UID分桶（默认）'."\n" + .'● UidHash-UID哈希'."\n" + .'● Filter-过滤条件分桶', 'description' => '分桶方式。'."\n" + .'● Uid-UID分桶（默认）'."\n" + .'● UidHash-UID哈希'."\n" + .'● Filter-过滤条件分桶', 'type' => 'string', 'example' => 'Filter'], + 'Filter' => ['title' => '过滤条件。', 'description' => '过滤条件。', 'type' => 'string', 'example' => 'filter=xxx'], + 'Environment' => ['title' => '运行环境'."\n" + .'● Daily-日常环境'."\n" + .'● Pre-预发环境'."\n" + .'● Prod-生产环境', 'description' => '运行环境'."\n" + .'● Daily-日常环境'."\n" + .'● Pre-预发环境'."\n" + .'● Prod-生产环境', 'type' => 'string', 'example' => 'Daily'], + 'Type' => ['title' => '实验室类型'."\n" + .'● Base'."\n" + .'● NonBase', 'description' => '实验室类型'."\n" + .'● Base'."\n" + .'● NonBase', 'type' => 'string', 'example' => 'Base'], + 'Status' => ['title' => '状态。'."\n" + .'● Offline-未上线。'."\n" + .'● Online-已上线。', 'description' => '状态。'."\n" + .'● Offline-未上线。'."\n" + .'● Online-已上线。', 'type' => 'string', 'example' => 'Offline'], + 'CrowdId' => ['title' => '人群ID。', 'description' => '人群ID。', 'type' => 'string', 'example' => '3'], ], - 'required' => false, ], ], ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '获取实验室详细信息', + 'summary' => '获取指定实验室的详细信息。', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'pairec:GetLaboratory', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIRecService', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1C0898E5-9220-5443-B2D9-445FF0688215\\",\\n \\"SceneId\\": \\"3\\",\\n \\"Name\\": \\"laboratory1\\",\\n \\"Description\\": \\"This is a test.\\",\\n \\"DebugUsers\\": \\"user1,user2,user3\\",\\n \\"DebugCrowdId\\": \\"3\\",\\n \\"BucketCount\\": 100,\\n \\"Buckets\\": \\"1,2,3,10-20\\",\\n \\"BucketType\\": \\"Filter\\",\\n \\"Filter\\": \\"filter=xxx\\",\\n \\"Environment\\": \\"Daily\\",\\n \\"Type\\": \\"Base\\",\\n \\"Status\\": \\"Offline\\",\\n \\"CrowdId\\": \\"3\\"\\n}","type":"json"}]', + ], + 'GetLayer' => [ + 'summary' => '获取指定层的详细信息。', + 'path' => '/api/v1/layers/{LayerId}', + 'methods' => ['get'], + 'schemes' => ['http', 'https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '183176', + 'abilityTreeNodes' => ['FEATURElearnN0NAWV'], + ], + 'parameters' => [ + [ + 'name' => 'LayerId', + 'in' => 'path', + 'schema' => ['title' => '层ID。', 'description' => '层ID，可通过接口ListLayers获取。', 'type' => 'string', 'required' => true, 'example' => '3'], + ], + [ + 'name' => 'InstanceId', + 'in' => 'query', + 'schema' => ['title' => '实例ID。', 'description' => '实例ID，可通过接口ListInstances获取。', 'type' => 'string', 'required' => true, 'example' => 'pairec-cn-abcdefg1234'], + ], + ], 'responses' => [ 200 => [ 'schema' => [ @@ -7406,102 +6647,162 @@ 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'Id of the request', - 'type' => 'string', - 'example' => '01D22D08-BA20-5F35-8302-99115F288220', - ], - 'LaboratoryId' => [ - 'title' => '克隆出的实验室的ID。', - 'description' => '克隆出的实验室的ID。', - 'type' => 'string', - 'example' => '3', - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => 'EE97D06A-2AA0-5AD9-B6CF-8A267924D691'], + 'LaboratoryId' => ['title' => '实验室ID。', 'description' => '实验室ID。', 'type' => 'string', 'example' => '3'], + 'SceneId' => ['title' => '场景ID。', 'description' => '场景ID。', 'type' => 'string', 'example' => '4'], + 'Name' => ['title' => '层名称。', 'description' => '层名称。', 'type' => 'string', 'example' => 'layer1'], + 'Description' => ['title' => '层描述。', 'description' => '层描述。', 'type' => 'string', 'example' => 'This is a test.'], + 'ResidualFlow' => ['description' => '实验层上剩余流量。', 'type' => 'integer', 'format' => 'int64', 'example' => '10'], + 'GmtCreateTime' => ['description' => '实验层创建时间。', 'type' => 'string', 'example' => '2022-10-13 17:34:52.0'], ], ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '获取层详细信息', + 'changeSet' => [ + ['createdAt' => '2024-03-20T06:05:19.000Z', 'description' => '响应参数发生变更'], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"01D22D08-BA20-5F35-8302-99115F288220\\",\\n \\"LaboratoryId\\": \\"3\\"\\n}","type":"json"}]', - 'title' => '克隆实验室', - ], - 'CreateLayer' => [ - 'summary' => '在指定实验室下创建一个层，用于分层实验。层与层之间正交，可独立开展实验，避免流量饥饿问题。', - 'path' => '/api/v1/layers', - 'methods' => [ - 'post', + 'flowControl' => [ + 'flowControlList' => [], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'pairec:GetLayer', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIRecService', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"EE97D06A-2AA0-5AD9-B6CF-8A267924D691\\",\\n \\"LaboratoryId\\": \\"3\\",\\n \\"SceneId\\": \\"4\\",\\n \\"Name\\": \\"layer1\\",\\n \\"Description\\": \\"This is a test.\\",\\n \\"ResidualFlow\\": 10,\\n \\"GmtCreateTime\\": \\"2022-10-13 17:34:52.0\\"\\n}","type":"json"}]', + ], + 'GetRecallManagementConfig' => [ + 'summary' => '获取召回管理配置。', + 'path' => '/api/v1/recallmanagementconfigs', + 'methods' => ['get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], - 'operationType' => 'write', + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'create', + 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATURElearnN0NAWV', - ], + 'abilityTreeNodes' => ['FEATURElearnN0NAWV'], ], 'parameters' => [ [ - 'name' => 'body', - 'in' => 'body', - 'style' => 'json', + 'name' => 'InstanceId', + 'in' => 'query', + 'schema' => ['description' => '实例ID，可通过接口ListInstances获取。', 'type' => 'string', 'required' => false, 'example' => 'learn-pairec-xxx'], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'title' => '请求body。', - 'description' => '请求body。', + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'LaboratoryId' => [ - 'title' => '实验室ID。', - 'description' => '实验室ID，可通过接口ListLaboratories获取。', - 'type' => 'string', - 'required' => true, - 'example' => '3', - ], - 'Name' => [ - 'title' => '层名称。', - 'description' => '层名称。', - 'type' => 'string', - 'required' => true, - 'example' => 'layer1', - ], - 'Description' => [ - 'title' => '层描述。', - 'description' => '层描述。', - 'type' => 'string', - 'required' => true, - 'example' => 'This is a test.', - ], - 'InstanceId' => [ - 'title' => '实例ID。', - 'description' => '实例ID，可通过接口ListInstances获取。', - 'type' => 'string', - 'required' => true, - 'example' => 'pairec-cn-abcdefg1234', + 'RequestId' => ['title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => '728C5E01-ABF6-5AA8-B9FC-B3BA05DECC77'], + 'UserName' => ['description' => '用户名。', 'type' => 'string', 'example' => 'scene_test'], + 'NetworkConfigs' => [ + 'description' => '网络配置信息。', + 'type' => 'array', + 'items' => [ + 'description' => '网络配置信息详情。', + 'type' => 'object', + 'properties' => [ + 'VpcId' => ['description' => '专有网络（VPC）ID。', 'type' => 'string', 'example' => 'vpc-xxx'], + 'Status' => ['description' => '网络连接状态，枚举值：'."\n" + ."\n" + .'- Connecting：连接中。'."\n" + ."\n" + .'- Connected：已连接。'."\n" + ."\n" + .'- ConnectionFailed：连接失败。'."\n" + ."\n" + .'- Updating：更新中。'."\n" + ."\n" + .'- UpdateFailed：更新失败。', 'type' => 'string', 'example' => 'Connecting'], + 'VswitchIds' => [ + 'description' => '可用区。', + 'type' => 'object', + 'additionalProperties' => ['type' => 'string', 'example' => 'vsw-xxx', 'description' => '交换机信息。'], + ], + 'PrivateLinkAddress' => ['description' => '私网连接地址。', 'type' => 'string', 'example' => 'http://xxx'], + 'PublicEndpoint' => ['title' => '公网连接地址。', 'description' => '公网连接地址。', 'type' => 'string', 'example' => '""'], + 'Token' => ['title' => '公网连接Token。', 'description' => '公网连接Token。', 'type' => 'string', 'example' => '""'], + ], + ], ], ], - 'required' => false, ], ], ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '获取召回管理配置', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'pairec:GetRecallManagementConfig', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIRecService', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"728C5E01-ABF6-5AA8-B9FC-B3BA05DECC77\\",\\n \\"UserName\\": \\"scene_test\\",\\n \\"NetworkConfigs\\": [\\n {\\n \\"VpcId\\": \\"vpc-xxx\\",\\n \\"Status\\": \\"Connecting\\",\\n \\"VswitchIds\\": {\\n \\"key\\": \\"vsw-xxx\\"\\n },\\n \\"PrivateLinkAddress\\": \\"http://xxx\\",\\n \\"PublicEndpoint\\": \\"\\\\\\"\\\\\\"\\",\\n \\"Token\\": \\"\\\\\\"\\\\\\"\\"\\n }\\n ]\\n}","type":"json"}]', + ], + 'GetRecallManagementJob' => [ + 'path' => '/api/v1/recallmanagementjobs/{RecallManagementJobId}', + 'methods' => ['get'], + 'schemes' => ['https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATURElearnN0NAWV'], + ], + 'parameters' => [ + [ + 'name' => 'RecallManagementJobId', + 'in' => 'path', + 'schema' => ['description' => '任务ID。'."\n", 'type' => 'string', 'required' => true, 'example' => '1'], + ], + [ + 'name' => 'InstanceId', + 'in' => 'query', + 'schema' => ['description' => '实例ID。'."\n", 'type' => 'string', 'required' => true, 'example' => 'pairec-1324***'], + ], + ], 'responses' => [ 200 => [ 'schema' => [ @@ -7509,81 +6810,81 @@ 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'Id of the request', - 'type' => 'string', - 'example' => '59CE7EC6-F268-5D71-9215-32922CC50D72', + 'RequestId' => ['title' => 'Id of the request', 'description' => '请求ID。'."\n", 'type' => 'string', 'example' => '728C5E01-ABF6-5AA8-B9FC-B3BA05DECC77'], + 'RecallManagementJobId' => ['description' => '召回管理任务ID。'."\n", 'type' => 'string', 'example' => '1'], + 'RecallManagerTableInfo' => [ + 'description' => '召回管理表信息。', + 'type' => 'object', + 'properties' => [ + 'RecallManagerTableVersionId' => ['description' => '召回表版本ID。', 'type' => 'string', 'example' => '20250101000'], + 'DataVersion' => ['description' => '数据版本号。', 'type' => 'string', 'example' => 'ds=20250701'], + 'SourceTableRowCount' => ['description' => '源表数据行数。', 'type' => 'string', 'example' => '100'], + 'SourceTableDataSize' => ['description' => '源表数据大小。', 'type' => 'string', 'example' => '10000'], + ], ], - 'LayerId' => [ - 'title' => '层ID。', - 'description' => '层ID。', - 'type' => 'string', - 'example' => '3', + 'Log' => ['description' => '日志。'."\n", 'type' => 'string', 'example' => '"success"'], + 'Status' => ['description' => '状态，枚举值：'."\n" + .'* `Init`：初始化。'."\n" + .'* `Running`：运行中'."\n" + .'* `Success`：成功'."\n" + .'* `Failed`：失败'."\n", 'type' => 'string', 'example' => 'Running'], + 'StartTime' => ['description' => '同步开始时间。'."\n", 'type' => 'string', 'example' => '2021-12-15T22:24:33.132'], + 'EndTime' => ['description' => '同步结束时间。'."\n", 'type' => 'string', 'example' => '2021-12-15T23:24:33.132'], + 'RecallManagementTableInfo' => [ + 'description' => '召回管理表详情。', + 'type' => 'object', + 'properties' => [ + 'RecallManagementTableVersionId' => ['description' => '表版本ID。'."\n", 'type' => 'string', 'example' => '20250101000'], + 'DataVersion' => ['description' => '数据版本。'."\n", 'type' => 'string', 'example' => 'ds=20250701'], + 'SourceTableRowCount' => ['description' => '源表数据行数。'."\n", 'type' => 'string', 'example' => '100'], + 'SourceTableDataSize' => ['description' => '源表数据大小。'."\n", 'type' => 'string', 'example' => '10000'], + ], ], ], ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '获取召回管理任务详情', + 'summary' => '查询特定召回管理任务的详细信息，包括状态、日志等。', + 'description' => '## 请求说明'."\n" + .'通过提供`RecallManagementJobId`和`InstanceId`来获取指定召回管理任务的详细信息。此API能够返回任务的状态（如初始化、运行中、成功或失败）、开始与结束时间、相关表信息及操作日志等内容。确保在请求时正确填写路径参数`RecallManagementJobId`以及查询参数`InstanceId`。'."\n", + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"59CE7EC6-F268-5D71-9215-32922CC50D72\\",\\n \\"LayerId\\": \\"3\\"\\n}","type":"json"}]', - 'title' => '创建层', + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"728C5E01-ABF6-5AA8-B9FC-B3BA05DECC77\\",\\n \\"RecallManagementJobId\\": \\"1\\",\\n \\"RecallManagerTableInfo\\": {\\n \\"RecallManagerTableVersionId\\": \\"20250101000\\",\\n \\"DataVersion\\": \\"ds=20250701\\",\\n \\"SourceTableRowCount\\": \\"100\\",\\n \\"SourceTableDataSize\\": \\"10000\\"\\n },\\n \\"Log\\": \\"\\\\\\"success\\\\\\"\\",\\n \\"Status\\": \\"Running\\",\\n \\"StartTime\\": \\"2021-12-15T22:24:33.132\\",\\n \\"EndTime\\": \\"2021-12-15T23:24:33.132\\",\\n \\"RecallManagementTableInfo\\": {\\n \\"RecallManagementTableVersionId\\": \\"20250101000\\",\\n \\"DataVersion\\": \\"ds=20250701\\",\\n \\"SourceTableRowCount\\": \\"100\\",\\n \\"SourceTableDataSize\\": \\"10000\\"\\n }\\n}","type":"json"}]', ], - 'DeleteLayer' => [ - 'summary' => '删除指定层。', - 'path' => '/api/v1/layers/{LayerId}', - 'methods' => [ - 'delete', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'GetRecallManagementService' => [ + 'path' => '/api/v1/recallmanagementservices/{RecallManagementServiceId}', + 'methods' => ['get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], - 'operationType' => 'write', + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'delete', + 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATURElearnN0NAWV', - ], + 'abilityTreeNodes' => ['FEATURElearnN0NAWV'], ], 'parameters' => [ [ - 'name' => 'LayerId', + 'name' => 'RecallManagementServiceId', 'in' => 'path', - 'schema' => [ - 'title' => '层ID。', - 'description' => '层ID，可通过接口ListLayers获取。', - 'type' => 'string', - 'required' => false, - 'example' => '3', - ], + 'schema' => ['description' => '召回管理服务ID。'."\n", 'type' => 'string', 'required' => false, 'example' => '3'], ], [ 'name' => 'InstanceId', 'in' => 'query', - 'schema' => [ - 'title' => '实例ID。', - 'description' => '实例ID，可通过接口ListInstances获取。', - 'type' => 'string', - 'required' => false, - 'example' => 'pairec-cn-abcdefg1234', - ], + 'schema' => ['description' => '实例ID。'."\n", 'type' => 'string', 'required' => false, 'example' => 'pairec-cn-test123'], ], ], 'responses' => [ @@ -7593,99 +6894,250 @@ 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'Id of the request', - 'type' => 'string', - 'example' => '8F457D79-C4A2-5E8C-83E4-0D089456E2AC', - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => '请求id。'."\n", 'type' => 'string', 'example' => '728C5E01-ABF6-5AA8-B9FC-B3BA05DECC77'], + 'RecallManagementServiceId' => ['description' => '召回管理服务ID。'."\n", 'type' => 'string', 'example' => '3'], + 'Name' => ['description' => '召回管理服务名称。'."\n", 'type' => 'string', 'example' => 'hot_group_recall'], + 'Description' => ['description' => '召回管理服务描述。'."\n", 'type' => 'string', 'example' => 'this is a test recall'], + 'CurrentRecallManagementServiceVersionId' => ['description' => '当前生效的召回管理服务版本ID。'."\n", 'type' => 'string', 'example' => '1'], + 'CurrentRecallManagementServiceVersionName' => ['description' => '当前生效的召回管理服务版本名称。'."\n", 'type' => 'string', 'example' => 'version-1'], + 'Status' => ['description' => '状态，枚举值：'."\n" + .'- Online：在线'."\n" + .'- Offline：离线'."\n", 'type' => 'string', 'example' => 'Online'], + 'GmtCreateTime' => ['description' => '创建时间。'."\n", 'type' => 'string', 'example' => '2021-12-15T23:24:33.132+08:00'], + 'GmtModifiedTime' => ['description' => '更新时间。'."\n", 'type' => 'string', 'example' => '2021-12-15T23:24:33.132+08:00'], ], ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '获取召回管理服务详情', + 'summary' => '查询指定召回管理服务的详细信息，包括状态、版本等。', + 'description' => '## 请求说明'."\n", + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"8F457D79-C4A2-5E8C-83E4-0D089456E2AC\\"\\n}","type":"json"}]', - 'title' => '删除层', + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"728C5E01-ABF6-5AA8-B9FC-B3BA05DECC77\\",\\n \\"RecallManagementServiceId\\": \\"3\\",\\n \\"Name\\": \\"hot_group_recall\\",\\n \\"Description\\": \\"this is a test recall\\",\\n \\"CurrentRecallManagementServiceVersionId\\": \\"1\\",\\n \\"CurrentRecallManagementServiceVersionName\\": \\"version-1\\",\\n \\"Status\\": \\"Online\\",\\n \\"GmtCreateTime\\": \\"2021-12-15T23:24:33.132+08:00\\",\\n \\"GmtModifiedTime\\": \\"2021-12-15T23:24:33.132+08:00\\"\\n}","type":"json"}]', ], - 'UpdateLayer' => [ - 'summary' => '更新指定层的信息，例如更新层的名称、描述。', - 'path' => '/api/v1/layers/{LayerId}', - 'methods' => [ - 'put', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'GetRecallManagementServiceVersion' => [ + 'summary' => '获取召回管理服务版本详情。', + 'path' => '/api/v1/recallmanagementservices/{RecallManagementServiceId}/versions/{RecallManagementServiceVersionId}', + 'methods' => ['get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], - 'operationType' => 'readAndWrite', + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'update', + 'operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATURElearnN0NAWV', - ], + 'abilityTreeNodes' => ['FEATURElearnN0NAWV'], ], 'parameters' => [ [ - 'name' => 'LayerId', + 'name' => 'RecallManagementServiceId', 'in' => 'path', - 'schema' => [ - 'description' => '层ID，可通过接口ListLayers获取。', - 'type' => 'string', - 'required' => true, - 'example' => '3', - ], + 'schema' => ['description' => '召回管理服务ID。', 'type' => 'string', 'required' => false, 'example' => '3'], ], [ - 'name' => 'body', - 'in' => 'body', - 'style' => 'json', + 'name' => 'RecallManagementServiceVersionId', + 'in' => 'path', + 'schema' => ['description' => '召回管理服务版本ID。', 'type' => 'string', 'required' => false, 'example' => '2'], + ], + [ + 'name' => 'InstanceId', + 'in' => 'query', + 'schema' => ['description' => '实例ID。', 'type' => 'string', 'required' => false, 'example' => 'learn-pairec-xxx'], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'title' => '请求body。', - 'description' => '请求body。', + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'InstanceId' => [ - 'title' => '实例ID。', - 'description' => '实例ID，可通过接口ListInstances获取。', - 'type' => 'string', - 'required' => true, - 'example' => 'pairec-test1', - ], - 'Name' => [ - 'title' => '层名称。', - 'description' => '层名称。', - 'type' => 'string', - 'required' => true, - 'example' => 'layer1', - ], - 'Description' => [ - 'title' => '层描述。', - 'description' => '层描述。', - 'type' => 'string', - 'required' => true, - 'example' => 'This is a test.', + 'RequestId' => ['title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => 'E15A1443-7917-5BE0-AE70-25538ECF398D'], + 'RecallManagementServiceVersionId' => ['description' => '召回管理服务版本ID。', 'type' => 'string', 'example' => '2'], + 'Name' => ['description' => '召回管理服务版本名称。', 'type' => 'string', 'example' => 'V1'], + 'IsEffective' => ['title' => '当前版本是否有效。', 'description' => '当前版本是否有效。', 'type' => 'boolean', 'default' => 'false'], + 'Configs' => [ + 'description' => '配置详情。', + 'type' => 'object', + 'properties' => [ + 'RecallConfigs' => [ + 'description' => '召回管理服务版本配置列表。', + 'type' => 'array', + 'items' => [ + 'description' => '召回管理服务版本配置详情。', + 'type' => 'object', + 'properties' => [ + 'RecallManagementServiceVersionConfigId' => ['description' => '召回管理服务版本配置ID。', 'type' => 'string', 'example' => '5'], + 'Name' => ['description' => '召回名称。', 'type' => 'string', 'example' => 'etrec'], + 'Description' => ['description' => '召回描述。', 'type' => 'string', 'example' => 'this is etrec recall'], + 'Priority' => ['description' => '优先级。数字越小，优先级越高。', 'type' => 'integer', 'format' => 'int64', 'example' => '10'], + 'RecallType' => ['description' => '召回类型。', 'type' => 'string', 'example' => 'X2I'], + 'RecallManagementTableId' => ['description' => '召回管理表ID。', 'type' => 'string', 'example' => '2'], + 'UserVectorRecallManagementTableId' => ['description' => '用户向量召回表ID。', 'type' => 'string', 'example' => '3'], + 'UserVectorField' => ['description' => '用户向量字段。', 'type' => 'string', 'example' => 'user_embedding'], + 'ItemVectorRecallManagementTableId' => ['description' => '物品向量召回表ID。', 'type' => 'string', 'example' => '4'], + 'ItemVectorField' => ['description' => '物品向量字段。', 'type' => 'string', 'example' => 'item_embedding'], + 'ItemConditionArray' => ['description' => '物品条件，设置数组格式条件。', 'type' => 'string', 'example' => '[{"option":"<","field":"category","type":"STRING","value":"10"}]'], + 'ItemConditionExpression' => ['title' => '物品条件表达式。', 'description' => '物品条件表达式。', 'type' => 'string', 'example' => 'age>20'], + 'SortFields' => ['description' => '排序字段。', 'type' => 'string', 'example' => 'name'], + 'Operators' => [ + 'description' => '算子列表。', + 'type' => 'array', + 'items' => [ + 'description' => '算子详情。', + 'type' => 'object', + 'properties' => [ + 'OperatorType' => ['description' => '算子类型。', 'type' => 'string', 'example' => 'Filter'], + 'TriggerConfig' => [ + 'description' => 'Trigger算子的配置。', + 'type' => 'object', + 'properties' => [ + 'Field' => ['description' => '字段名称。', 'type' => 'string', 'example' => 'user_id'], + 'IsRandSort' => ['description' => '是否随机排序。', 'type' => 'boolean', 'example' => 'false'], + 'SortField' => ['description' => '排序字段。', 'type' => 'string', 'example' => 'create_time'], + 'FieldQuantityLimit' => ['description' => '字段数量限制。', 'type' => 'integer', 'format' => 'int32', 'example' => '20'], + ], + ], + 'FilterConfig' => [ + 'description' => '过滤算子的配置。', + 'type' => 'object', + 'properties' => [ + 'Experession' => ['description' => '表达式。', 'type' => 'string', 'example' => 'age > 10'], + ], + ], + 'FeatureConfig' => [ + 'description' => '特征算子的配置。', + 'type' => 'object', + 'properties' => [ + 'Name' => ['description' => '特征名称。', 'type' => 'string', 'example' => 'city'], + 'Type' => ['description' => '特征类型。', 'type' => 'string', 'example' => 'STRING'], + 'Expression' => ['description' => '特征表达式。', 'type' => 'string', 'example' => 'city = \'hangzhou\''], + ], + ], + 'JoinConfig' => [ + 'description' => 'Join算子的配置。', + 'type' => 'object', + 'properties' => [ + 'Field' => ['description' => 'Join字段。', 'type' => 'string', 'example' => 'item_id'], + 'RecallManagementTableId' => ['description' => 'Join表ID。', 'type' => 'string', 'example' => '3'], + 'OutputFields' => [ + 'description' => '返回字段列表。', + 'type' => 'array', + 'items' => ['description' => '返回字段。', 'type' => 'string', 'example' => 'category'], + ], + ], + ], + ], + ], + ], + 'ExtendedConfig' => ['description' => '额外配置，方便以后功能扩展。', 'type' => 'string', 'example' => '""'], + ], + ], + ], + 'MergeConfig' => [ + 'description' => '归并配置。', + 'type' => 'object', + 'properties' => [ + 'RecallManagementServiceVersionConfigId' => ['description' => '召回管理服务版本配置ID。', 'type' => 'string', 'example' => '1'], + 'MergeType' => ['description' => '归并类型。', 'type' => 'string', 'example' => 'Weight'], + 'FilterRecallManagementTableIds' => [ + 'description' => '过滤表ID列表。', + 'type' => 'array', + 'items' => ['description' => '过滤表ID。', 'type' => 'string', 'example' => '3'], + ], + 'ItemRecallManagementTableId' => ['description' => '物品表ID。', 'type' => 'string', 'example' => '2'], + 'ItemTableFields' => [ + 'description' => '物品表输出字段列表。', + 'type' => 'array', + 'items' => ['description' => '物品表输出字段。', 'type' => 'string', 'example' => 'item_id'], + ], + 'FilterExpression' => ['description' => '过滤表达式。', 'type' => 'string', 'example' => 'age>20'], + 'ExtendedConfig' => ['description' => '归并配置的一些额外配置，方便以后功能扩展。', 'type' => 'string', 'example' => '""'], + ], + ], + ], ], + 'GmtCreateTime' => ['description' => '创建时间。', 'type' => 'string', 'example' => '2021-12-15T23:24:33.132+08:00'], + 'GmtModifiedTime' => ['description' => '更新时间。', 'type' => 'string', 'example' => '2021-12-15T23:24:33.132+08:00'], ], - 'required' => false, ], ], ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '获取召回管理服务版本详情', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'pairec:GetRecallManagementServiceVersion', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIRecService', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"E15A1443-7917-5BE0-AE70-25538ECF398D\\",\\n \\"RecallManagementServiceVersionId\\": \\"2\\",\\n \\"Name\\": \\"V1\\",\\n \\"IsEffective\\": true,\\n \\"Configs\\": {\\n \\"RecallConfigs\\": [\\n {\\n \\"RecallManagementServiceVersionConfigId\\": \\"5\\",\\n \\"Name\\": \\"etrec\\",\\n \\"Description\\": \\"this is etrec recall\\",\\n \\"Priority\\": 10,\\n \\"RecallType\\": \\"X2I\\",\\n \\"RecallManagementTableId\\": \\"2\\",\\n \\"UserVectorRecallManagementTableId\\": \\"3\\",\\n \\"UserVectorField\\": \\"user_embedding\\",\\n \\"ItemVectorRecallManagementTableId\\": \\"4\\",\\n \\"ItemVectorField\\": \\"item_embedding\\",\\n \\"ItemConditionArray\\": \\"[{\\\\\\"option\\\\\\":\\\\\\"<\\\\\\",\\\\\\"field\\\\\\":\\\\\\"category\\\\\\",\\\\\\"type\\\\\\":\\\\\\"STRING\\\\\\",\\\\\\"value\\\\\\":\\\\\\"10\\\\\\"}]\\",\\n \\"ItemConditionExpression\\": \\"age>20\\",\\n \\"SortFields\\": \\"name\\",\\n \\"Operators\\": [\\n {\\n \\"OperatorType\\": \\"Filter\\",\\n \\"TriggerConfig\\": {\\n \\"Field\\": \\"user_id\\",\\n \\"IsRandSort\\": false,\\n \\"SortField\\": \\"create_time\\",\\n \\"FieldQuantityLimit\\": 20\\n },\\n \\"FilterConfig\\": {\\n \\"Experession\\": \\"age > 10\\"\\n },\\n \\"FeatureConfig\\": {\\n \\"Name\\": \\"city\\",\\n \\"Type\\": \\"STRING\\",\\n \\"Expression\\": \\"city = \'hangzhou\'\\"\\n },\\n \\"JoinConfig\\": {\\n \\"Field\\": \\"item_id\\",\\n \\"RecallManagementTableId\\": \\"3\\",\\n \\"OutputFields\\": [\\n \\"category\\"\\n ]\\n }\\n }\\n ],\\n \\"ExtendedConfig\\": \\"\\\\\\"\\\\\\"\\"\\n }\\n ],\\n \\"MergeConfig\\": {\\n \\"RecallManagementServiceVersionConfigId\\": \\"1\\",\\n \\"MergeType\\": \\"Weight\\",\\n \\"FilterRecallManagementTableIds\\": [\\n \\"3\\"\\n ],\\n \\"ItemRecallManagementTableId\\": \\"2\\",\\n \\"ItemTableFields\\": [\\n \\"item_id\\"\\n ],\\n \\"FilterExpression\\": \\"age>20\\",\\n \\"ExtendedConfig\\": \\"\\\\\\"\\\\\\"\\"\\n }\\n },\\n \\"GmtCreateTime\\": \\"2021-12-15T23:24:33.132+08:00\\",\\n \\"GmtModifiedTime\\": \\"2021-12-15T23:24:33.132+08:00\\"\\n}","type":"json"}]', + ], + 'GetRecallManagementServiceVersionConfig' => [ + 'summary' => '此API用于查询特定召回管理服务版本的配置详细信息。', + 'path' => '/api/v1/recallmanagementservices/{RecallManagementServiceId}/versions/{RecallManagementServiceVersionId}/configs/{RecallManagementServiceVersionConfigId}', + 'methods' => ['get'], + 'schemes' => ['https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATURElearnN0NAWV'], + ], + 'parameters' => [ + [ + 'name' => 'RecallManagementServiceId', + 'in' => 'path', + 'schema' => ['description' => '召回管理服务ID。'."\n", 'type' => 'string', 'required' => false, 'example' => '3'], + ], + [ + 'name' => 'RecallManagementServiceVersionId', + 'in' => 'path', + 'schema' => ['description' => '召回管理服务版本ID。'."\n", 'type' => 'string', 'required' => false, 'example' => '2'], + ], + [ + 'name' => 'RecallManagementServiceVersionConfigId', + 'in' => 'path', + 'schema' => ['description' => '召回管理服务版本配置ID。'."\n", 'type' => 'string', 'required' => false, 'example' => '3'], + ], + [ + 'name' => 'InstanceId', + 'in' => 'query', + 'schema' => ['description' => '实例ID。'."\n", 'type' => 'string', 'required' => false, 'example' => 'learn-pairec-xxx'], + ], + ], 'responses' => [ 200 => [ 'schema' => [ @@ -7693,76 +7145,166 @@ 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'Id of the request', - 'type' => 'string', - 'example' => '0EA9215E-EC21-53AB-B8D9-D3DEA90D040A', + 'RequestId' => ['title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => '728C5E01-ABF6-5AA8-B9FC-B3BA05DECC77'], + 'RecallManagementServiceId' => ['description' => '召回管理服务ID。'."\n", 'type' => 'string', 'example' => '3'], + 'RecallManagementServiceVersionId' => ['description' => '召回管理服务版本ID。'."\n", 'type' => 'string', 'example' => '2'], + 'RecallManagementServiceVersionConfigId' => ['description' => '召回管理服务版本配置ID。'."\n", 'type' => 'string', 'example' => '2'], + 'ConfigType' => ['description' => '召回管理版本配置类型。枚举值：Recall：召回配置。Merge：归并配置。'."\n", 'type' => 'string', 'example' => 'Recall'], + 'RecallConfig' => [ + 'description' => '召回配置。'."\n", + 'type' => 'object', + 'properties' => [ + 'RecallManagementServiceVersionConfigId' => ['title' => '召回管理服务版本配置ID。', 'description' => '召回管理服务版本配置ID。', 'type' => 'string', 'example' => '4'], + 'Name' => ['description' => '召回名称。', 'type' => 'string', 'example' => 'etrec'], + 'Description' => ['description' => '召回描述。'."\n", 'type' => 'string', 'example' => 'this is etrec recall'], + 'Priority' => ['description' => '优先级。数字越小，优先级越高'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '10'], + 'RecallType' => ['description' => '召回类型。'."\n", 'type' => 'string', 'example' => 'X2I'], + 'RecallManagementTableId' => ['description' => '召回管理表ID。'."\n", 'type' => 'string', 'example' => '3'], + 'UserVectorRecallManagementTableId' => ['description' => '用户向量召回表ID。'."\n", 'type' => 'string', 'example' => '2'], + 'UserVectorField' => ['description' => '用户向量字段。'."\n", 'type' => 'string', 'example' => 'user_embedding'], + 'ItemVectorRecallManagementTableId' => ['description' => '物品向量召回表ID。'."\n", 'type' => 'string', 'example' => '2'], + 'ItemVectorField' => ['description' => '物品向量字段。'."\n", 'type' => 'string', 'example' => 'item_embedding'], + 'ItemConditionArray' => ['description' => '物品条件，设置数组格式条件。'."\n", 'type' => 'string', 'example' => '[{"option":"<","field":"category","type":"STRING","value":"10"}]'], + 'ItemConditionExpression' => ['title' => '物品条件表达式。', 'description' => '物品条件表达式。', 'type' => 'string', 'example' => 'age>20'], + 'SortFields' => ['description' => '排序字段。', 'type' => 'string', 'example' => 'name'], + 'Operators' => [ + 'description' => '算子列表。', + 'type' => 'array', + 'items' => [ + 'description' => '算子详情。', + 'type' => 'object', + 'properties' => [ + 'OperatorType' => ['description' => '算子类型。', 'type' => 'string', 'example' => 'Filter'], + 'TriggerConfig' => [ + 'description' => 'Trigger算子的配置。', + 'type' => 'object', + 'properties' => [ + 'Field' => ['description' => '字段名称。', 'type' => 'string', 'example' => 'user_id'], + 'IsRandSort' => ['description' => '是否随机排序。', 'type' => 'boolean', 'example' => 'false'], + 'SortField' => ['description' => '排序字段。', 'type' => 'string', 'example' => 'create_time'], + 'FieldQuantityLimit' => ['description' => '字段数量限制。', 'type' => 'integer', 'format' => 'int32', 'example' => '20'], + ], + ], + 'FilterConfig' => [ + 'description' => '过滤算子的配置。', + 'type' => 'object', + 'properties' => [ + 'Expression' => ['description' => '过滤表达式。', 'type' => 'string', 'example' => 'age>20'], + ], + ], + 'FeatureConfig' => [ + 'description' => '特征算子的配置。', + 'type' => 'object', + 'properties' => [ + 'Name' => ['description' => '特征名称。', 'type' => 'string', 'example' => 'age'], + 'Type' => ['description' => '特征类型。', 'type' => 'string', 'example' => 'STRING'], + 'Expression' => ['description' => '特征表达式。', 'type' => 'string', 'example' => 'category=3'], + ], + ], + 'JoinConfig' => [ + 'description' => 'Join算子的配置。', + 'type' => 'object', + 'properties' => [ + 'Field' => ['description' => 'Join字段。', 'type' => 'string', 'example' => 'item_id'], + 'RecallManagementTableId' => ['description' => 'Join表ID。', 'type' => 'string', 'example' => '3'], + 'OutputFields' => [ + 'description' => '返回字段列表。', + 'type' => 'array', + 'items' => ['description' => '返回字段列表。', 'type' => 'string', 'example' => 'item_id'], + ], + ], + ], + ], + ], + ], + 'ExtendedConfig' => ['description' => '额外配置，方便以后功能扩展。'."\n", 'type' => 'string', 'example' => '{"":""}'], + ], ], + 'MergeConfig' => [ + 'description' => '归并配置。'."\n", + 'type' => 'object', + 'properties' => [ + 'RecallManagementServiceVersionConfigId' => ['description' => '召回管理服务版本配置ID。'."\n", 'type' => 'string', 'example' => '1'], + 'MergeType' => ['description' => '归并类型，枚举值：'."\n" + .'- Weight：权重'."\n" + .'- Alternate：交替'."\n", 'type' => 'string', 'example' => 'Weight'], + 'FilterRecallManagementTableIds' => [ + 'description' => '过滤表ID。'."\n", + 'type' => 'array', + 'items' => ['description' => '过滤表ID列表。', 'type' => 'string', 'example' => '3'], + ], + 'ItemRecallManagementTableId' => ['description' => '物品表ID。'."\n", 'type' => 'string', 'example' => '2'], + 'ItemTableFields' => [ + 'description' => '物品表输出字段。'."\n", + 'type' => 'array', + 'items' => ['description' => '物品表输出字段列表。', 'type' => 'string', 'example' => 'item_id'], + ], + 'FilterExpression' => ['description' => '过滤表达式。', 'type' => 'string', 'example' => 'age>20'], + 'ExtendedConfig' => ['description' => '归并配置的一些额外配置，方便以后功能扩展。'."\n", 'type' => 'string', 'example' => '{"":""}'], + ], + ], + 'GmtCreateTime' => ['description' => '创建时间。'."\n", 'type' => 'string', 'example' => '2021-12-15T23:24:33.132+08:00'], + 'GmtModifiedTime' => ['description' => '更新时间。'."\n", 'type' => 'string', 'example' => '2021-12-15T23:24:33.132+08:00'], ], ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '获取召回管理服务版本配置', + 'description' => '## 请求说明'."\n" + .'通过指定召回管理服务ID、版本ID以及配置ID，可以获取到该召回服务版本的具体配置详情。请确保提供的参数值准确无误，特别是`InstanceId`，它对于定位正确的实例至关重要。'."\n" + ."\n" + .'- **注意**：所有路径参数（`RecallManagementServiceId`, `RecallManagementServiceVersionId`, `RecallManagementServiceVersionConfigId`）都是必需的，并且必须与实际存在的资源相匹配。'."\n" + .'- **扩展配置**：返回的数据中包含`ExtendedConfig`字段，用于未来功能扩展或自定义设置，请根据需要解析使用。'."\n", + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'pairec:GetRecallManagementServiceVersionConfig', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIRecService', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0EA9215E-EC21-53AB-B8D9-D3DEA90D040A\\"\\n}","type":"json"}]', - 'title' => '更新层', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"728C5E01-ABF6-5AA8-B9FC-B3BA05DECC77\\",\\n \\"RecallManagementServiceId\\": \\"3\\",\\n \\"RecallManagementServiceVersionId\\": \\"2\\",\\n \\"RecallManagementServiceVersionConfigId\\": \\"2\\",\\n \\"ConfigType\\": \\"Recall\\",\\n \\"RecallConfig\\": {\\n \\"RecallManagementServiceVersionConfigId\\": \\"4\\",\\n \\"Name\\": \\"etrec\\",\\n \\"Description\\": \\"this is etrec recall\\",\\n \\"Priority\\": 10,\\n \\"RecallType\\": \\"X2I\\",\\n \\"RecallManagementTableId\\": \\"3\\",\\n \\"UserVectorRecallManagementTableId\\": \\"2\\",\\n \\"UserVectorField\\": \\"user_embedding\\",\\n \\"ItemVectorRecallManagementTableId\\": \\"2\\",\\n \\"ItemVectorField\\": \\"item_embedding\\",\\n \\"ItemConditionArray\\": \\"[{\\\\\\"option\\\\\\":\\\\\\"<\\\\\\",\\\\\\"field\\\\\\":\\\\\\"category\\\\\\",\\\\\\"type\\\\\\":\\\\\\"STRING\\\\\\",\\\\\\"value\\\\\\":\\\\\\"10\\\\\\"}]\\",\\n \\"ItemConditionExpression\\": \\"age>20\\",\\n \\"SortFields\\": \\"name\\",\\n \\"Operators\\": [\\n {\\n \\"OperatorType\\": \\"Filter\\",\\n \\"TriggerConfig\\": {\\n \\"Field\\": \\"user_id\\",\\n \\"IsRandSort\\": false,\\n \\"SortField\\": \\"create_time\\",\\n \\"FieldQuantityLimit\\": 20\\n },\\n \\"FilterConfig\\": {\\n \\"Expression\\": \\"age>20\\"\\n },\\n \\"FeatureConfig\\": {\\n \\"Name\\": \\"age\\",\\n \\"Type\\": \\"STRING\\",\\n \\"Expression\\": \\"category=3\\"\\n },\\n \\"JoinConfig\\": {\\n \\"Field\\": \\"item_id\\",\\n \\"RecallManagementTableId\\": \\"3\\",\\n \\"OutputFields\\": [\\n \\"item_id\\"\\n ]\\n }\\n }\\n ],\\n \\"ExtendedConfig\\": \\"{\\\\\\"\\\\\\":\\\\\\"\\\\\\"}\\"\\n },\\n \\"MergeConfig\\": {\\n \\"RecallManagementServiceVersionConfigId\\": \\"1\\",\\n \\"MergeType\\": \\"Weight\\",\\n \\"FilterRecallManagementTableIds\\": [\\n \\"3\\"\\n ],\\n \\"ItemRecallManagementTableId\\": \\"2\\",\\n \\"ItemTableFields\\": [\\n \\"item_id\\"\\n ],\\n \\"FilterExpression\\": \\"age>20\\",\\n \\"ExtendedConfig\\": \\"{\\\\\\"\\\\\\":\\\\\\"\\\\\\"}\\"\\n },\\n \\"GmtCreateTime\\": \\"2021-12-15T23:24:33.132+08:00\\",\\n \\"GmtModifiedTime\\": \\"2021-12-15T23:24:33.132+08:00\\"\\n}","type":"json"}]', ], - 'ListLayers' => [ - 'summary' => '获取某个实验室下的层列表。', - 'path' => '/api/v1/layers', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'GetRecallManagementTable' => [ + 'summary' => '查询指定召回管理表的详细信息，包括表结构和配置等。', + 'path' => '/api/v1/recallmanagementtables/{RecallManagementTableId}', + 'methods' => ['get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'list', + 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeCode' => '183174', - 'abilityTreeNodes' => [ - 'FEATURElearnN0NAWV', - ], + 'abilityTreeNodes' => ['FEATURElearnN0NAWV'], ], 'parameters' => [ [ - 'name' => 'LaboratoryId', - 'in' => 'query', - 'schema' => [ - 'title' => '实验室ID。', - 'description' => '实验室ID，可通过接口ListLaboratories获取。', - 'type' => 'string', - 'required' => true, - 'example' => '3', - ], + 'name' => 'RecallManagementTableId', + 'in' => 'path', + 'schema' => ['description' => '数据表ID。'."\n", 'type' => 'string', 'required' => true, 'example' => '3'], ], [ 'name' => 'InstanceId', 'in' => 'query', - 'schema' => [ - 'title' => '实例ID。', - 'description' => '实例ID，可通过接口ListInstances获取。', - 'type' => 'string', - 'required' => true, - 'example' => 'pairec-cn-abcdefg1234', - ], + 'schema' => ['description' => '实例ID。'."\n", 'type' => 'string', 'required' => true, 'example' => 'pairec-cn-test123'], ], ], 'responses' => [ @@ -7772,67 +7314,47 @@ 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'Id of the request', - 'type' => 'string', - 'example' => '518C64F6-DFF7-11ED-85B0-00163E14B3D1', - ], - 'TotalCount' => [ - 'title' => '列表内元素总数。', - 'description' => '列表内元素总数。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '10', - ], - 'Layers' => [ - 'title' => '层列表。', - 'description' => '层列表。', + 'RequestId' => ['title' => 'Id of the request', 'description' => '请求id。'."\n", 'type' => 'string', 'example' => '728C5E01-ABF6-5AA8-B9FC-B3BA05DECC77'], + 'RecallManagementTableId' => ['description' => '数据表ID。'."\n", 'type' => 'string', 'example' => '3'], + 'Name' => ['description' => '数据表名。'."\n", 'type' => 'string', 'example' => 'table-123'], + 'Description' => ['description' => '数据表备注。', 'type' => 'string', 'example' => 'this is a test'], + 'Type' => ['description' => '表类型。', 'type' => 'string', 'example' => 'Recall'], + 'RecallType' => ['description' => '表的召回类型。', 'type' => 'string', 'example' => 'X2I'], + 'DataSource' => ['description' => '数据源。', 'type' => 'string', 'example' => 'Api'], + 'MaxcomputeProjectName' => ['description' => 'maxcompute项目名。', 'type' => 'string', 'example' => 'test'], + 'MaxcomputeTableName' => ['description' => 'maxcompute中表名。', 'type' => 'string', 'example' => 'table-1'], + 'CanDelete' => ['description' => '表是否可以被删除。'."\n", 'type' => 'boolean', 'example' => 'true'], + 'IndexVersionId' => ['description' => '索引版本Id。'."\n", 'type' => 'string', 'example' => '20250701'], + 'IndexEffectiveTime' => ['description' => '索引生效时间'."\n", 'type' => 'string', 'example' => '2021-12-15T23:24:33.132+08:00'], + 'Config' => ['description' => '表的一些额外配置'."\n", 'type' => 'string', 'example' => '{"item_id":""}'], + 'EnableRowCountFluctuationThreshold' => ['description' => '是否启动表数据条目波动阈值'."\n", 'type' => 'boolean', 'example' => 'true'], + 'MinRowCountFluctuationThreshold' => ['description' => '表数据条目波动阈值最小值'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '10'], + 'MaxRowCountFluctuationThreshold' => ['description' => '表数据条目波动阈值最大值'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '100'], + 'EnableDataSizeFluctuationThreshold' => ['description' => '是否启动表大小波动阈值'."\n", 'type' => 'boolean', 'example' => 'false'], + 'MinDataSizeFluctuationThreshold' => ['description' => '表大小波动阈值最小值'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '10'], + 'MaxDataSizeFluctuationThreshold' => ['description' => '表大小波动阈值最大值'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '100'], + 'GmtCreateTime' => ['description' => '创建时间。', 'type' => 'string', 'example' => '2021-12-15T23:24:33.132+08:00'], + 'GmtModifiedTime' => ['description' => '更新时间。'."\n", 'type' => 'string', 'example' => '2021-12-15T23:24:33.132+08:00'], + 'MaxcomputeSchema' => ['description' => 'maxcompute schema。'."\n", 'type' => 'string', 'example' => 'default'], + 'PartitionFields' => ['description' => '表的分区字段。', 'type' => 'string', 'example' => 'dt'], + 'Fields' => [ + 'description' => '字段列表。'."\n", 'type' => 'array', 'items' => [ + 'title' => '字段详情。', + 'description' => '字段详情。', 'type' => 'object', 'properties' => [ - 'LayerId' => [ - 'title' => '层ID。', - 'description' => '层ID。', - 'type' => 'string', - 'example' => '3', - ], - 'LaboratoryId' => [ - 'title' => '实验室ID。', - 'description' => '实验室ID。', - 'type' => 'string', - 'example' => '3', - ], - 'SceneId' => [ - 'title' => '场景ID。', - 'description' => '场景ID。', - 'type' => 'string', - 'example' => '3', - ], - 'Name' => [ - 'title' => '层名称。', - 'description' => '层名称。', - 'type' => 'string', - 'example' => 'layer1', - ], - 'Description' => [ - 'title' => '层描述。', - 'description' => '层描述。', - 'type' => 'string', - 'example' => 'This is a test.', - ], - 'ResidualFlow' => [ - 'description' => '当前实验层剩余的流量。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '10', - ], - 'GmtCreateTime' => [ - 'description' => '创建时间。', - 'type' => 'string', - 'example' => '2024-05-30T02:02:28.000Z', + 'Name' => ['title' => '字段名称。', 'description' => '字段名称。', 'type' => 'string', 'example' => 'age'], + 'Type' => ['title' => '字段类型。', 'description' => '字段类型。', 'type' => 'string', 'example' => 'STRING'], + 'Attributes' => [ + 'title' => '字段的属性列表。', + 'description' => '字段的属性列表。', + 'type' => 'array', + 'items' => ['title' => '字段属性。', 'description' => '字段属性。', 'type' => 'string', 'example' => 'Primary'], ], + 'VectorDimension' => ['title' => '向量维度。', 'description' => '向量维度。', 'type' => 'integer', 'format' => 'int32', 'example' => '32'], + 'VectorMetricType' => ['title' => '向量指标类型。', 'description' => '向量指标类型。', 'type' => 'string', 'example' => 'L2'], ], ], ], @@ -7840,66 +7362,63 @@ ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '获取召回管理数据表详情', + 'description' => '## 请求说明'."\n" + .'本接口用于根据给定的数据表ID（`RecallManagementTableId`）和实例ID（`InstanceId`），获取召回管理表的详细信息。请确保在请求时正确提供这两个参数值。'."\n" + ."\n" + .'- **注意**：`CanDelete` 字段表示该表是否支持删除操作，请谨慎处理相关逻辑。'."\n" + .'- `Fields` 列表中包含了表内字段的具体定义，如名称、类型及属性等重要信息。'."\n" + .'- 表的波动阈值设置（行数与大小）可通过相应字段进行配置或查询，以监控数据变化情况。'."\n", + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'pairec:GetRecallManagementTable', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIRecService', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"518C64F6-DFF7-11ED-85B0-00163E14B3D1\\",\\n \\"TotalCount\\": 10,\\n \\"Layers\\": [\\n {\\n \\"LayerId\\": \\"3\\",\\n \\"LaboratoryId\\": \\"3\\",\\n \\"SceneId\\": \\"3\\",\\n \\"Name\\": \\"layer1\\",\\n \\"Description\\": \\"This is a test.\\",\\n \\"ResidualFlow\\": 10,\\n \\"GmtCreateTime\\": \\"2024-05-30T02:02:28.000Z\\"\\n }\\n ]\\n}","type":"json"}]', - 'title' => '获取层列表', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"728C5E01-ABF6-5AA8-B9FC-B3BA05DECC77\\",\\n \\"RecallManagementTableId\\": \\"3\\",\\n \\"Name\\": \\"table-123\\",\\n \\"Description\\": \\"this is a test\\",\\n \\"Type\\": \\"Recall\\",\\n \\"RecallType\\": \\"X2I\\",\\n \\"DataSource\\": \\"Api\\",\\n \\"MaxcomputeProjectName\\": \\"test\\",\\n \\"MaxcomputeTableName\\": \\"table-1\\",\\n \\"CanDelete\\": true,\\n \\"IndexVersionId\\": \\"20250701\\",\\n \\"IndexEffectiveTime\\": \\"2021-12-15T23:24:33.132+08:00\\",\\n \\"Config\\": \\"{\\\\\\"item_id\\\\\\":\\\\\\"\\\\\\"}\\",\\n \\"EnableRowCountFluctuationThreshold\\": true,\\n \\"MinRowCountFluctuationThreshold\\": 10,\\n \\"MaxRowCountFluctuationThreshold\\": 100,\\n \\"EnableDataSizeFluctuationThreshold\\": false,\\n \\"MinDataSizeFluctuationThreshold\\": 10,\\n \\"MaxDataSizeFluctuationThreshold\\": 100,\\n \\"GmtCreateTime\\": \\"2021-12-15T23:24:33.132+08:00\\",\\n \\"GmtModifiedTime\\": \\"2021-12-15T23:24:33.132+08:00\\",\\n \\"MaxcomputeSchema\\": \\"default\\",\\n \\"PartitionFields\\": \\"dt\\",\\n \\"Fields\\": [\\n {\\n \\"Name\\": \\"age\\",\\n \\"Type\\": \\"STRING\\",\\n \\"Attributes\\": [\\n \\"Primary\\"\\n ],\\n \\"VectorDimension\\": 32,\\n \\"VectorMetricType\\": \\"L2\\"\\n }\\n ]\\n}","type":"json"}]', ], - 'GetLayer' => [ - 'summary' => '获取指定层的详细信息。', - 'path' => '/api/v1/layers/{LayerId}', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'GetScene' => [ + 'summary' => '获取指定场景的详细信息。', + 'path' => '/api/v1/scenes/{SceneId}', + 'methods' => ['get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeCode' => '183176', - 'abilityTreeNodes' => [ - 'FEATURElearnN0NAWV', - ], + 'abilityTreeNodes' => ['FEATURElearnN0NAWV'], ], 'parameters' => [ [ - 'name' => 'LayerId', + 'name' => 'SceneId', 'in' => 'path', - 'schema' => [ - 'title' => '层ID。', - 'description' => '层ID，可通过接口ListLayers获取。', - 'type' => 'string', - 'required' => true, - 'example' => '3', - ], + 'schema' => ['title' => '场景ID。', 'description' => '场景ID，可通过接口ListScenes获取。', 'type' => 'string', 'required' => false, 'example' => '3'], ], [ 'name' => 'InstanceId', 'in' => 'query', - 'schema' => [ - 'title' => '实例ID。', - 'description' => '实例ID，可通过接口ListInstances获取。', - 'type' => 'string', - 'required' => true, - 'example' => 'pairec-cn-abcdefg1234', - ], + 'schema' => ['title' => '实例ID。', 'description' => '实例ID，可通过接口ListInstances获取。', 'type' => 'string', 'required' => false, 'example' => 'pairec-cn-abcdefg1234'], ], ], 'responses' => [ @@ -7909,215 +7428,77 @@ 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'Id of the request', - 'type' => 'string', - 'example' => 'EE97D06A-2AA0-5AD9-B6CF-8A267924D691', - ], - 'LaboratoryId' => [ - 'title' => '实验室ID。', - 'description' => '实验室ID。', - 'type' => 'string', - 'example' => '3', - ], - 'SceneId' => [ - 'title' => '场景ID。', - 'description' => '场景ID。', - 'type' => 'string', - 'example' => '4', - ], - 'Name' => [ - 'title' => '层名称。', - 'description' => '层名称。', - 'type' => 'string', - 'example' => 'layer1', - ], - 'Description' => [ - 'title' => '层描述。', - 'description' => '层描述。', - 'type' => 'string', - 'example' => 'This is a test.', - ], - 'ResidualFlow' => [ - 'description' => '实验层上剩余流量。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '10', - ], - 'GmtCreateTime' => [ - 'description' => '实验层创建时间。', - 'type' => 'string', - 'example' => '2022-10-13 17:34:52.0', + 'RequestId' => ['title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => 'B8987BF7-6028-5B17-80E0-251B7BD67BBA'], + 'Name' => ['title' => '场景名称。', 'description' => '场景名称。', 'type' => 'string', 'example' => 'scene1'], + 'Description' => ['title' => '场景描述。', 'description' => '场景描述。', 'type' => 'string', 'example' => 'This is a test.'], + 'Flows' => [ + 'title' => '流量列表。', + 'description' => '流量列表。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'FlowName' => ['title' => '流量名称。', 'description' => '流量名称。', 'type' => 'string', 'example' => '流量1'], + 'FlowCode' => ['title' => '流量编码。', 'description' => '流量编码。', 'type' => 'string', 'example' => 'liuliang1'], + ], + 'description' => '', + ], ], ], ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '获取场景详细信息', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'pairec:GetScene', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIRecService', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"EE97D06A-2AA0-5AD9-B6CF-8A267924D691\\",\\n \\"LaboratoryId\\": \\"3\\",\\n \\"SceneId\\": \\"4\\",\\n \\"Name\\": \\"layer1\\",\\n \\"Description\\": \\"This is a test.\\",\\n \\"ResidualFlow\\": 10,\\n \\"GmtCreateTime\\": \\"2022-10-13 17:34:52.0\\"\\n}","type":"json"}]', - 'title' => '获取层详细信息', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"B8987BF7-6028-5B17-80E0-251B7BD67BBA\\",\\n \\"Name\\": \\"scene1\\",\\n \\"Description\\": \\"This is a test.\\",\\n \\"Flows\\": [\\n {\\n \\"FlowName\\": \\"流量1\\",\\n \\"FlowCode\\": \\"liuliang1\\"\\n }\\n ]\\n}","type":"json"}]', ], - 'CreateExperimentGroup' => [ - 'summary' => '在指定层下，创建一个实验组。可按照实验类型划分实验组，从而按照实验组观测实验整体效果表现。', - 'path' => '/api/v1/experimentgroups', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'GetService' => [ + 'summary' => '获取服务详情。', + 'path' => '/api/v1/services/{ServiceId}', + 'methods' => ['get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], - 'operationType' => 'readAndWrite', + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'create', + 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeCode' => '183389', - 'abilityTreeNodes' => [ - 'FEATURElearnN0NAWV', - ], + 'abilityTreeNodes' => ['FEATURElearnN0NAWV'], ], 'parameters' => [ [ - 'name' => 'body', - 'in' => 'body', - 'style' => 'json', - 'schema' => [ - 'title' => '请求body。', - 'description' => '请求body。', - 'type' => 'object', - 'properties' => [ - 'LayerId' => [ - 'title' => '层ID。', - 'description' => '层ID，可通过接口ListLayers获取。', - 'type' => 'string', - 'required' => true, - 'example' => '3', - ], - 'Name' => [ - 'title' => '实验组名称。', - 'description' => '实验组名称。', - 'type' => 'string', - 'required' => true, - 'example' => 'experiment_group_test', - ], - 'Description' => [ - 'title' => '实验组描述。', - 'description' => '实验组描述。', - 'type' => 'string', - 'required' => false, - 'example' => 'This is a test.', - ], - 'DebugUsers' => [ - 'title' => '调试用户。', - 'description' => '调试用户（需为阿里云账户主账号/子账号uid），多个用户需通过逗号作间隔。', - 'type' => 'string', - 'required' => false, - 'example' => '1124512470******,1124512471******,1124512472******', - ], - 'DebugCrowdId' => [ - 'title' => '调试人群ID。', - 'description' => '调试人群ID，可通过接口ListCrowds获取。', - 'type' => 'string', - 'required' => false, - 'example' => '3', - ], - 'NeedAA' => [ - 'title' => '是否需要AA实验组。', - 'description' => '是否需要AA实验组。', - 'type' => 'boolean', - 'required' => true, - 'example' => 'true', - ], - 'Filter' => [ - 'title' => '人群定向指定的过滤条件。', - 'description' => '人群定向指定的过滤条件。', - 'type' => 'string', - 'required' => false, - 'example' => 'gender=male', - ], - 'CrowdId' => [ - 'title' => '人群定向的指定人群ID。', - 'description' => '人群定向的指定人群ID，可通过接口ListCrowds获取。', - 'type' => 'string', - 'required' => false, - 'example' => '1', - ], - 'DistributionType' => [ - 'title' => '分流方式。'."\n" - .'● UserId-用户ID'."\n" - .'● TimeDuration-时段', - 'description' => '分流方式。'."\n" - .'● UserId-用户ID'."\n" - .'● TimeDuration-时段', - 'type' => 'string', - 'required' => false, - 'example' => 'UserId', - ], - 'DistributionTimeDuration' => [ - 'title' => '分流时段。', - 'description' => '分流时段。', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '3', - ], - 'Config' => [ - 'title' => '实验组配置。', - 'description' => '实验组配置。', - 'type' => 'string', - 'required' => false, - 'example' => '{"RankBy": "Score"}', - ], - 'ReservedBuckets' => [ - 'title' => '预留桶号。', - 'description' => '预留桶号。', - 'type' => 'string', - 'required' => false, - 'example' => '1,2,3', - ], - 'InstanceId' => [ - 'title' => '实例ID。', - 'description' => '实例ID，可通过接口ListInstances获取。', - 'type' => 'string', - 'required' => true, - 'example' => 'pairec-test1', - ], - 'CrowdTargetType' => [ - 'description' => '实验组流量定向的类型，可能的取值包括：'."\n" - .'* All 所有的流量'."\n" - .'* Filter 使用过滤条件的流量'."\n" - .'* CrowdId 通过指定人群ID'."\n" - .'* Random 按照百分比随机流量', - 'type' => 'string', - 'required' => false, - 'example' => 'All', - ], - 'RandomFlow' => [ - 'description' => '当实验组流量定向的类型是Random时，使用随机流量匹配这个实验组，可能的取值范围是 0 - 100。', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '20', - ], - ], - 'required' => false, - ], + 'name' => 'ServiceId', + 'in' => 'path', + 'schema' => ['description' => '服务ID。', 'type' => 'string', 'required' => false, 'example' => '1'], + ], + [ + 'name' => 'InstanceId', + 'in' => 'query', + 'schema' => ['description' => '实例ID，可通过接口[ListInstances](~~2411819~~)获取。', 'type' => 'string', 'required' => false, 'example' => 'pairec-test-xxx'], ], ], 'responses' => [ @@ -8127,81 +7508,99 @@ 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'Id of the request', - 'type' => 'string', - 'example' => 'A04CB8C0-E74A-5E83-BC61-64D153574EC7', - ], - 'ExperimentGroupId' => [ - 'title' => '实验组ID。', - 'description' => '实验组ID。', - 'type' => 'string', - 'example' => '3', + 'RequestId' => ['title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => 'D75C43DC-3D3A-5CC8-9AAC-8C77306C433B'], + 'Name' => ['description' => '服务名称。', 'type' => 'string', 'example' => 'test_rec'], + 'Description' => ['description' => '服务描述。', 'type' => 'string', 'example' => 'this is a test rec engine'], + 'Region' => ['description' => '服务部署的Region。', 'type' => 'string', 'example' => 'cn-beijing'], + 'EngineConfigId' => ['description' => '引擎配置ID。', 'type' => 'string', 'example' => '3'], + 'CrInstanceId' => ['title' => '当选择非官方镜像时，用户选择的容器镜像企业版实例ID。', 'description' => '当选择非官方镜像时，用户选择的容器镜像企业版实例ID。', 'type' => 'string', 'example' => 'cri-xxx'], + 'RepositoryId' => ['title' => '当选择非官方镜像时，用户选择的容器镜像企业版仓库ID。', 'description' => '当选择非官方镜像时，用户选择的容器镜像企业版仓库ID。', 'type' => 'string', 'example' => 'crr-xxx'], + 'ImageName' => ['description' => '镜像名称。', 'type' => 'string', 'example' => 'registry-vpc.cn-beijing.aliyuncs.com/***/***'], + 'ImageAuth' => ['description' => '镜像密钥。', 'type' => 'string', 'example' => '********'], + 'ServiceResourceUri' => ['description' => '发布服务所使用的资源地址（如EAS的资源组名）。', 'type' => 'string', 'example' => 'eas-resource-xxx'], + 'ServiceConfig' => ['description' => '发布服务所用的配置（如EAS的服务配置）。', 'type' => 'string', 'example' => '{"Port":8080}'], + 'GmtReleasedTime' => ['description' => '最近一次（生产）发布时间。', 'type' => 'string', 'example' => '2021-12-15T23:24:33.132+08:00'], + 'LatestProdReleaseOrder' => [ + 'description' => '最近一次生产发布记录。', + 'type' => 'object', + 'properties' => [ + 'ReleaseOrderId' => ['description' => '发布单ID。', 'type' => 'string', 'example' => '3'], + 'Topic' => ['description' => '发布标题。', 'type' => 'string', 'example' => 'update version'], + 'Content' => ['description' => '发布内容。', 'type' => 'string', 'example' => 'update golang version to 1.22'], + 'ImageVersion' => ['description' => '镜像版本。', 'type' => 'string', 'example' => '2.0.0'], + 'Releaser' => ['description' => '发布人（包含RAM账号的名称、uid）。', 'type' => 'string', 'example' => 'E-xxx.xxx-@xxx.onaliyun.com'], + 'ReleaseInfo' => ['description' => '发布信息。', 'type' => 'string', 'example' => '{'."\n" + .' "Pre": {'."\n" + .' "Status": "Released",'."\n" + .' "GmtReleasedTime" : "2021-12-15T23:24:33.132+08:00",'."\n" + .' },'."\n" + .' "Prod": {'."\n" + .' "Status": "Released",'."\n" + .' "GmtReleasedTime" : "2021-12-15T23:24:33.132+08:00",'."\n" + .' }'."\n" + .'}'], + ], ], ], ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"D75C43DC-3D3A-5CC8-9AAC-8C77306C433B\\",\\n \\"Name\\": \\"test_rec\\",\\n \\"Description\\": \\"this is a test rec engine\\",\\n \\"Region\\": \\"cn-beijing\\",\\n \\"EngineConfigId\\": \\"3\\",\\n \\"CrInstanceId\\": \\"cri-xxx\\",\\n \\"RepositoryId\\": \\"crr-xxx\\",\\n \\"ImageName\\": \\"registry-vpc.cn-beijing.aliyuncs.com/***/***\\",\\n \\"ImageAuth\\": \\"********\\",\\n \\"ServiceResourceUri\\": \\"eas-resource-xxx\\",\\n \\"ServiceConfig\\": \\"{\\\\\\"Port\\\\\\":8080}\\",\\n \\"GmtReleasedTime\\": \\"2021-12-15T23:24:33.132+08:00\\",\\n \\"LatestProdReleaseOrder\\": {\\n \\"ReleaseOrderId\\": \\"3\\",\\n \\"Topic\\": \\"update version\\",\\n \\"Content\\": \\"update golang version to 1.22\\",\\n \\"ImageVersion\\": \\"2.0.0\\",\\n \\"Releaser\\": \\"E-xxx.xxx-@xxx.onaliyun.com\\",\\n \\"ReleaseInfo\\": \\"{\\\\n\\\\t\\\\\\"Pre\\\\\\": {\\\\n \\\\\\"Status\\\\\\": \\\\\\"Released\\\\\\",\\\\n \\\\\\"GmtReleasedTime\\\\\\" : \\\\\\"2021-12-15T23:24:33.132+08:00\\\\\\",\\\\n },\\\\n \\\\\\"Prod\\\\\\": {\\\\n \\\\\\"Status\\\\\\": \\\\\\"Released\\\\\\",\\\\n \\\\\\"GmtReleasedTime\\\\\\" : \\\\\\"2021-12-15T23:24:33.132+08:00\\\\\\",\\\\n }\\\\n}\\"\\n }\\n}","type":"json"}]', + 'title' => '获取服务详情', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'pairec:GetService', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIRecService', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"A04CB8C0-E74A-5E83-BC61-64D153574EC7\\",\\n \\"ExperimentGroupId\\": \\"3\\"\\n}","type":"json"}]', - 'title' => '创建实验组', ], - 'DeleteExperimentGroup' => [ - 'summary' => '删除指定实验组。', - 'path' => '/api/v1/experimentgroups/{ExperimentGroupId}', - 'methods' => [ - 'delete', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'GetSubCrowd' => [ + 'summary' => '获取指定子人群的详细信息。', + 'path' => '/api/v1/crowds/{CrowdId}/subcrowds/{SubCrowdId}', + 'methods' => ['get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'delete', + 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATURElearnN0NAWV', - ], + 'abilityTreeNodes' => ['FEATURElearnN0NAWV'], ], 'parameters' => [ [ - 'name' => 'ExperimentGroupId', + 'name' => 'CrowdId', 'in' => 'path', - 'schema' => [ - 'title' => '实验组ID。', - 'description' => '实验组ID，可通过接口ListExperimentGroups获取。', - 'type' => 'string', - 'required' => true, - 'example' => '3', - ], + 'schema' => ['title' => '人群ID。', 'description' => '人群ID，可通过接口ListCrowds获取。', 'type' => 'string', 'required' => true, 'example' => '3'], + ], + [ + 'name' => 'SubCrowdId', + 'in' => 'path', + 'schema' => ['title' => '子人群ID。', 'description' => '子人群ID，可通过接口ListSubCrowds获取。', 'type' => 'string', 'required' => true, 'example' => '4'], ], [ 'name' => 'InstanceId', 'in' => 'query', - 'schema' => [ - 'title' => '实例ID。', - 'description' => '实例ID，可通过接口ListInstances获取。', - 'type' => 'string', - 'required' => true, - 'example' => 'pairec-cn-abcdefg1234', - ], + 'schema' => ['title' => '实例ID。', 'description' => '实例ID，可通过接口ListInstances获取。', 'type' => 'string', 'required' => true, 'example' => 'pairec-cn-abcdefg1234'], ], ], 'responses' => [ @@ -8211,192 +7610,179 @@ 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'Id of the request', - 'type' => 'string', - 'example' => 'A009D9BE-C85E-57B2-AE05-BD78BB6EBF50', - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => '01D22D08-BA20-5F35-8302-99115F288220'], + 'Source' => ['title' => '人群来源。'."\n" + .'● ManualInput-手工输入'."\n" + .'● UploadFile-文件上传', 'description' => '人群来源。'."\n" + .'● ManualInput-手工输入'."\n" + .'● UploadFile-文件上传', 'type' => 'string', 'example' => 'ManualInput'], + 'Users' => ['title' => '人群分组中的用户。', 'description' => '人群分组中的用户。', 'type' => 'string', 'example' => 'user1,user2'], + 'Quantity' => ['title' => '人群分组所含的用户量。', 'description' => '人群分组所含的用户量。', 'type' => 'string', 'example' => '3'], + 'GmtCreateTime' => ['title' => '人群创建时间。', 'description' => '人群创建时间。', 'type' => 'string', 'example' => '2021-12-15T23:24:33.132+08:00'], ], ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"01D22D08-BA20-5F35-8302-99115F288220\\",\\n \\"Source\\": \\"ManualInput\\",\\n \\"Users\\": \\"user1,user2\\",\\n \\"Quantity\\": \\"3\\",\\n \\"GmtCreateTime\\": \\"2021-12-15T23:24:33.132+08:00\\"\\n}","type":"json"}]', + 'title' => '获取子人群详细信息', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'pairec:GetSubCrowd', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIRecService', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"A009D9BE-C85E-57B2-AE05-BD78BB6EBF50\\"\\n}","type":"json"}]', - 'title' => '删除实验组', ], - 'UpdateExperimentGroup' => [ - 'summary' => '更新指定实验组的信息，例如更新实验组的名称、描述。', - 'path' => '/api/v1/experimentgroups/{ExperimentGroupId}', - 'methods' => [ - 'put', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'GetTableMeta' => [ + 'path' => '/api/v1/tablemetas/{TableMetaId}', + 'methods' => ['get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeCode' => '183398', - 'abilityTreeNodes' => [ - 'FEATURElearnN0NAWV', - ], + 'abilityTreeNodes' => ['FEATURElearnN0NAWV'], ], 'parameters' => [ [ - 'name' => 'ExperimentGroupId', + 'name' => 'TableMetaId', 'in' => 'path', - 'schema' => [ - 'description' => '实验组ID，可通过接口ListExperimentGroups获取。', - 'type' => 'string', - 'required' => true, - 'example' => '3', - ], + 'schema' => ['description' => '数据表ID。', 'type' => 'string', 'required' => true, 'example' => '2'], ], [ - 'name' => 'body', - 'in' => 'body', - 'style' => 'json', + 'name' => 'InstanceId', + 'in' => 'query', + 'schema' => ['description' => '实例ID，可通过接口[ListInstances](~~2411819~~)获取。', 'type' => 'string', 'required' => true, 'example' => '实例ID pairec-cn-test1'], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'title' => '请求body。', - 'description' => '请求body。', + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'LayerId' => [ - 'title' => '层ID。', - 'description' => '层ID，可通过接口ListLayers获取。', - 'type' => 'string', - 'required' => true, - 'example' => '3', - ], - 'Name' => [ - 'title' => '实验组名称。', - 'description' => '实验组名称。', - 'type' => 'string', - 'required' => true, - 'example' => 'experiment_group1', - ], - 'Description' => [ - 'title' => '实验组描述。', - 'description' => '实验组描述。', - 'type' => 'string', - 'required' => true, - 'example' => 'This is a test.', - ], - 'DebugUsers' => [ - 'title' => '调试用户。', - 'description' => '调试用户（需为阿里云账户主账号/子账号uid），多个用户需通过逗号作间隔。', - 'type' => 'string', - 'required' => false, - 'example' => 'user1,user2,user3', - ], - 'DebugCrowdId' => [ - 'title' => '调试人群ID。', - 'description' => '调试人群ID，可通过接口ListCrowds获取。', - 'type' => 'string', - 'required' => false, - 'example' => '3', - ], - 'NeedAA' => [ - 'title' => '是否需要AA实验组。', - 'description' => '是否需要AA实验组。', - 'type' => 'boolean', - 'required' => false, - 'example' => 'true', - ], - 'Filter' => [ - 'title' => '人群定向指定的过滤条件。', - 'description' => '人群定向指定的过滤条件。', - 'type' => 'string', - 'required' => false, - 'example' => 'gender=male', - ], - 'CrowdId' => [ - 'title' => '人群定向的指定人群ID。', - 'description' => '人群定向的指定人群ID，可通过接口ListCrowds获取。', - 'type' => 'string', - 'required' => false, - 'example' => '3', - ], - 'DistributionType' => [ - 'title' => '分流方式。'."\n" - .'● UserId-用户ID'."\n" - .'● TimeDuration-时段', - 'description' => '分流方式。'."\n" - .'● UserId-用户ID'."\n" - .'● TimeDuration-时段', - 'type' => 'string', - 'required' => false, - 'example' => 'UserId', - ], - 'DistributionTimeDuration' => [ - 'title' => '分流时段。', - 'description' => '分流时段。', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '3', - ], - 'Config' => [ - 'title' => '实验组配置。', - 'description' => '实验组配置。', - 'type' => 'string', - 'required' => false, - 'example' => '{"RankBy": "Score"}', - ], - 'ReservcedBuckets' => [ - 'title' => '预留桶号。', - 'description' => '预留桶号。', - 'type' => 'string', - 'required' => false, - 'example' => '1,2,3', - ], - 'InstanceId' => [ - 'title' => '实例ID。', - 'description' => '实例ID，可通过接口ListInstances获取。', - 'type' => 'string', - 'required' => true, - 'example' => 'pairec-cn-abcdefg1234', - ], - 'CrowdTargetType' => [ - 'description' => '实验组流量定向的类型，可能的取值包括：'."\n" - .'* All 所有的流量'."\n" - .'* Filter 使用过滤条件的流量'."\n" - .'* CrowdId 通过指定人群ID'."\n" - .'* Random 按照百分比随机流量', - 'type' => 'string', - 'required' => false, - 'example' => 'All', - ], - 'RandomFlow' => [ - 'description' => '当实验组流量定向的类型是Random时，使用随机流量匹配这个实验组，可能的取值范围是 0 - 100。', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '20', + 'RequestId' => ['title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => '28C5E01-ABF6-5AA8-B9FC-B3BA05DECC77'], + 'Name' => ['description' => '数据表名称。', 'type' => 'string', 'example' => 'test_table'], + 'Description' => ['description' => '数据表描述。', 'type' => 'string', 'example' => 'this is a test table'], + 'ResourceId' => ['description' => '资源ID。', 'type' => 'string', 'example' => 'reso-wkgo***'], + 'ResourceType' => ['type' => 'string', 'example' => 'Maxcompute'], + 'ResourceUri' => ['type' => 'string', 'example' => 'test'], + 'TableName' => ['description' => '数据库中的表名.', 'type' => 'string', 'example' => 'table_mysql'], + 'Type' => ['description' => '数据表类型。'."\n" + ."\n" + .'- MaxCompute'."\n" + ."\n" + .'- Hologres', 'type' => 'string', 'example' => 'MaxCompute'], + 'Module' => ['description' => '数据表模块。'."\n" + ."\n" + .'- ABTest-实验数据表。'."\n" + ."\n" + .'- ExperimentTool-实验工具表。'."\n" + ."\n" + .'- DataDiagnosis-数据诊断', 'type' => 'string', 'example' => 'ABTest'], + 'CanDelete' => ['description' => '是否可以删除，如果表在其他地方正在被引用，则返回 false。', 'type' => 'boolean', 'example' => 'false'], + 'GmtCreateTime' => ['description' => '创建时间。', 'type' => 'string', 'example' => '2021-12-15:24:33'], + 'GmtModifiedTime' => ['description' => '更新时间。', 'type' => 'string', 'example' => '2021-12-15:24:33'], + 'Fields' => [ + 'description' => '表的字段列表。', + 'type' => 'array', + 'items' => [ + 'description' => '字段信息。', + 'type' => 'object', + 'properties' => [ + 'Name' => ['description' => '字段名称。', 'type' => 'string', 'example' => 'gender'], + 'Meaning' => ['description' => '字段含义。', 'type' => 'string', 'example' => 'the gender of people'], + 'Type' => ['description' => '字段类型。', 'type' => 'string', 'example' => 'BIGINT'], + 'IsDimensionField' => ['description' => '是否是维度字段。', 'type' => 'boolean', 'example' => 'false'], + ], + ], ], + 'Url' => ['description' => '如果是MaxCompute表，此字段为数据地图的表的链接，否则为空。', 'type' => 'string', 'example' => 'https://dmc-xxx.com/dm/table/xxx'."\n"], + 'TableMetaId' => ['description' => '数据表ID。', 'type' => 'string', 'example' => '3'], + 'GmtImportedTime' => ['description' => '字段导入时间。', 'type' => 'string', 'example' => '2021-12-15T23:24:33.132+08:00'], + 'Config' => ['description' => '数据表的一些额外的配置。', 'type' => 'string', 'example' => '{"table_type":"item"}'], + ], + ], + ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '获取数据表', + 'summary' => '获取数据表详细信息。', + 'changeSet' => [ + ['createdAt' => '2024-02-22T08:15:54.000Z', 'description' => '响应参数发生变更'], + ['createdAt' => '2024-02-22T03:35:42.000Z', 'description' => '请求参数发生变更、响应参数发生变更'], + ], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'pairec:GetTableMeta', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIRecService', 'resourceType' => '全部资源', 'arn' => '*'], ], - 'required' => false, ], ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"28C5E01-ABF6-5AA8-B9FC-B3BA05DECC77\\",\\n \\"Name\\": \\"test_table\\",\\n \\"Description\\": \\"this is a test table\\",\\n \\"ResourceId\\": \\"reso-wkgo***\\",\\n \\"ResourceType\\": \\"Maxcompute\\",\\n \\"ResourceUri\\": \\"test\\",\\n \\"TableName\\": \\"table_mysql\\",\\n \\"Type\\": \\"MaxCompute\\",\\n \\"Module\\": \\"ABTest\\",\\n \\"CanDelete\\": false,\\n \\"GmtCreateTime\\": \\"2021-12-15:24:33\\",\\n \\"GmtModifiedTime\\": \\"2021-12-15:24:33\\",\\n \\"Fields\\": [\\n {\\n \\"Name\\": \\"gender\\",\\n \\"Meaning\\": \\"the gender of people\\",\\n \\"Type\\": \\"BIGINT\\",\\n \\"IsDimensionField\\": false\\n }\\n ],\\n \\"Url\\": \\"https://dmc-xxx.com/dm/table/xxx\\\\n\\",\\n \\"TableMetaId\\": \\"3\\",\\n \\"GmtImportedTime\\": \\"2021-12-15T23:24:33.132+08:00\\",\\n \\"Config\\": \\"{\\\\\\"table_type\\\\\\":\\\\\\"item\\\\\\"}\\"\\n}","type":"json"}]', + ], + 'GetTrafficControlTarget' => [ + 'path' => '/api/v1/trafficcontroltargets/{TrafficControlTargetId}', + 'methods' => ['get'], + 'schemes' => ['http', 'https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '220593', + 'abilityTreeNodes' => ['FEATURElearnN0NAWV'], + ], + 'parameters' => [ + [ + 'name' => 'TrafficControlTargetId', + 'in' => 'path', + 'schema' => ['description' => '流量调控目标ID。'."\n", 'type' => 'string', 'required' => true, 'example' => '2'], + ], + [ + 'name' => 'InstanceId', + 'in' => 'query', + 'schema' => ['description' => '实例ID。'."\n", 'type' => 'string', 'required' => true, 'example' => 'pairec-1324***'], + ], + ], 'responses' => [ 200 => [ 'schema' => [ @@ -8404,123 +7790,110 @@ 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'Id of the request', - 'type' => 'string', - 'example' => 'F7AC05FF-EDE7-5C2B-B9AE-33D6DF4178BA', + 'RequestId' => ['title' => 'Id of the request', 'description' => '请求ID。'."\n", 'type' => 'string', 'example' => '728C5E01-ABF6-5AA8-B9FC-B3BA05DECC77'], + 'TrafficControlTargetId' => ['description' => '流量调控目标ID。'."\n", 'type' => 'string', 'example' => '1'], + 'Name' => ['description' => '调控目标'."\n", 'type' => 'string', 'example' => 'target-1'], + 'StartTime' => ['description' => '开始时间'."\n", 'type' => 'string', 'example' => '2024-03-25'], + 'EndTime' => ['description' => '结束时间'."\n", 'type' => 'string', 'example' => '2024-04-25'], + 'ItemConditionType' => ['description' => '物品条件类型'."\n", 'type' => 'string', 'example' => 'Array'], + 'ItemConditionArray' => ['description' => '物品条件，设置数组格式条件'."\n", 'type' => 'string', 'example' => '[{"field":"status","option":"=","value":"1"}]'], + 'ItemConditionExpress' => ['description' => '物品条件，设置表达式格式条件'."\n", 'type' => 'string', 'example' => 'status=1'], + 'Event' => ['description' => '调控目标事件'."\n", 'type' => 'string', 'example' => 'click'], + 'Value' => ['description' => '调控目标值', 'type' => 'number', 'format' => 'float', 'example' => '30'], + 'StatisPeriod' => ['description' => '统计周期', 'type' => 'string', 'example' => 'Daily'], + 'ToleranceValue' => ['description' => '调控目标容错范围', 'type' => 'integer', 'format' => 'int64', 'example' => '10'], + 'RecallName' => ['description' => '召回策略名称', 'type' => 'string', 'example' => 'recall-1'], + 'Status' => ['description' => '状态', 'type' => 'string', 'example' => '枚举值：开启：Opened关闭：Closed'], + 'GmtCreateTime' => ['description' => '创建时间。', 'type' => 'string', 'example' => '2024-01-03T02:28:00.000Z'], + 'SplitParts' => [ + 'description' => '目标设置值。', + 'type' => 'object', + 'properties' => [ + 'TimePoints' => [ + 'description' => '时间分割点。', + 'type' => 'array', + 'items' => ['description' => '时间分割点。', 'type' => 'integer', 'format' => 'int64', 'example' => '5'], + ], + 'SetValues' => [ + 'description' => '目标设置值。', + 'type' => 'array', + 'items' => ['description' => '目标设置值。', 'type' => 'integer', 'format' => 'int64', 'example' => '10'], + ], + 'SetPoints' => [ + 'description' => '目标值分割点。', + 'type' => 'array', + 'items' => ['description' => '目标值分割点。', 'type' => 'integer', 'format' => 'int64', 'example' => '10'], + ], + ], ], + 'NewProductRegulation' => ['description' => '是否是新品调控'."\n", 'type' => 'boolean', 'example' => 'false'], + 'TrafficControlTaskId' => ['description' => '流量调控任务ID。'."\n", 'type' => 'string', 'example' => '1'], ], ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '获取流量调控目标详情', + 'summary' => '查询指定ID的流量调控目标的具体信息。', + 'description' => '## 请求说明'."\n" + .'通过提供流量调控目标ID和实例ID，可以获取到该流量调控目标的详细配置信息，包括但不限于调控目标名称、时间范围、条件设置等。请注意，`TrafficControlTargetId` 和 `InstanceId` 是必需参数。'."\n", + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"F7AC05FF-EDE7-5C2B-B9AE-33D6DF4178BA\\"\\n}","type":"json"}]', - 'title' => '更新实验组', + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"728C5E01-ABF6-5AA8-B9FC-B3BA05DECC77\\",\\n \\"TrafficControlTargetId\\": \\"1\\",\\n \\"Name\\": \\"target-1\\",\\n \\"StartTime\\": \\"2024-03-25\\",\\n \\"EndTime\\": \\"2024-04-25\\",\\n \\"ItemConditionType\\": \\"Array\\",\\n \\"ItemConditionArray\\": \\"[{\\\\\\"field\\\\\\":\\\\\\"status\\\\\\",\\\\\\"option\\\\\\":\\\\\\"=\\\\\\",\\\\\\"value\\\\\\":\\\\\\"1\\\\\\"}]\\",\\n \\"ItemConditionExpress\\": \\"status=1\\",\\n \\"Event\\": \\"click\\",\\n \\"Value\\": 30,\\n \\"StatisPeriod\\": \\"Daily\\",\\n \\"ToleranceValue\\": 10,\\n \\"RecallName\\": \\"recall-1\\",\\n \\"Status\\": \\"枚举值：开启：Opened关闭：Closed\\",\\n \\"GmtCreateTime\\": \\"2024-01-03T02:28:00.000Z\\",\\n \\"SplitParts\\": {\\n \\"TimePoints\\": [\\n 5\\n ],\\n \\"SetValues\\": [\\n 10\\n ],\\n \\"SetPoints\\": [\\n 10\\n ]\\n },\\n \\"NewProductRegulation\\": false,\\n \\"TrafficControlTaskId\\": \\"1\\"\\n}","type":"json"}]', ], - 'ListExperimentGroups' => [ - 'summary' => '获取实验组列表。', - 'path' => '/api/v1/experimentgroups', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'GetTrafficControlTask' => [ + 'path' => '/api/v1/trafficcontroltasks/{TrafficControlTaskId}', + 'methods' => ['get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'list', + 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeCode' => '183391', - 'abilityTreeNodes' => [ - 'FEATURElearnN0NAWV', - ], + 'abilityTreeCode' => '220404', + 'abilityTreeNodes' => ['FEATURElearnN0NAWV'], ], 'parameters' => [ [ - 'name' => 'LayerId', - 'in' => 'query', - 'schema' => [ - 'title' => '层ID。', - 'description' => '层ID，可通过接口ListLayers获取。', - 'type' => 'string', - 'required' => false, - 'example' => '3', - ], + 'name' => 'TrafficControlTaskId', + 'in' => 'path', + 'schema' => ['description' => '流量调控任务ID。'."\n", 'type' => 'string', 'required' => true, 'example' => '1'], ], [ - 'name' => 'Status', + 'name' => 'Environment', 'in' => 'query', - 'schema' => [ - 'title' => '状态过滤'."\n" - .'● Offline-未上线'."\n" - .'● Online-已上线'."\n" - .'● Pushed-已推全', - 'description' => '状态过滤'."\n" - .'● Offline-未上线'."\n" - .'● Online-已上线'."\n" - .'● Pushed-已推全', - 'type' => 'string', - 'required' => false, - 'example' => 'Online', - ], + 'schema' => ['description' => '参数所属的环境。Daily-日常环境Pre-预发环境Prod-生产环境'."\n", 'type' => 'string', 'required' => false, 'example' => 'Daily'], ], [ - 'name' => 'InstanceId', + 'name' => 'Version', 'in' => 'query', - 'schema' => [ - 'title' => '实例ID。', - 'description' => '实例ID，可通过接口ListInstances获取。', - 'type' => 'string', - 'required' => true, - 'example' => 'pairec-cn-abcdefg1234', - ], + 'schema' => ['description' => '版本'."\n", 'type' => 'string', 'required' => false, 'example' => 'Latest'], ], [ - 'name' => 'RegionId', + 'name' => 'ControlTargetFilter', 'in' => 'query', - 'schema' => [ - 'description' => '区域ID。', - 'type' => 'string', - 'required' => false, - 'example' => 'cn-beijing', - ], + 'schema' => ['description' => '过滤流量调控目标'."\n", 'type' => 'string', 'required' => false, 'example' => 'All'], ], [ - 'name' => 'TimeRangeStart', + 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => '根据开始时间进行实验组过滤。', - 'type' => 'string', - 'required' => false, - 'example' => '2024-08-30 12:00:00', - ], + 'schema' => ['description' => '区域ID。', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou'], ], [ - 'name' => 'TimeRangeEnd', + 'name' => 'InstanceId', 'in' => 'query', - 'schema' => [ - 'description' => '根据结束时间进行实验组过滤。', - 'type' => 'string', - 'required' => false, - 'example' => '2024-08-31 12:00:00', - ], + 'schema' => ['description' => '实例ID。'."\n", 'type' => 'string', 'required' => false, 'example' => 'pairec-1324***'], ], ], 'responses' => [ @@ -8530,227 +7903,168 @@ 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'Id of the request', - 'type' => 'string', - 'example' => '59CE7EC6-F268-5D71-9215-32922CC50D72', - ], - 'TotalCount' => [ - 'title' => '列表内元素总数。', - 'description' => '列表内元素总数。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '10', - ], - 'ExperimentGroups' => [ - 'title' => '实验组列表。', - 'description' => '实验组列表。', + 'RequestId' => ['title' => 'Id of the request', 'description' => '请求ID。'."\n", 'type' => 'string', 'example' => '728C5E01-ABF6-5AA8-B9FC-B3BA05DECC77'], + 'TrafficControlTaskId' => ['description' => '流量调控任务ID。'."\n", 'type' => 'string', 'example' => '1'], + 'Name' => ['description' => '流量调控任务名称'."\n", 'type' => 'string', 'example' => 'task-1'], + 'Description' => ['description' => '调控任务描述'."\n", 'type' => 'string', 'example' => 'this is a test task'], + 'SceneId' => ['description' => '场景ID。'."\n", 'type' => 'string', 'example' => '2'], + 'SceneName' => ['description' => '场景名称。'."\n", 'type' => 'string', 'example' => 'scene-2'], + 'ProductStatus' => ['description' => '生产环境状态'."\n", 'type' => 'string', 'example' => 'Running'], + 'PrepubStatus' => ['description' => '预发环境状态'."\n", 'type' => 'string', 'example' => 'Running'], + 'ExecutionTime' => ['description' => '执行时间'."\n", 'type' => 'string', 'example' => 'Permanent'], + 'StartTime' => ['description' => '开始时间'."\n", 'type' => 'string', 'example' => '2024-03-25'], + 'EndTime' => ['description' => '结束时间'."\n", 'type' => 'string', 'example' => '2024-04-25'], + 'BehaviorTableMetaId' => ['description' => '行为表ID。'."\n", 'type' => 'string', 'example' => '1'], + 'UserTableMetaId' => ['description' => '用户表ID。'."\n", 'type' => 'string', 'example' => '2'], + 'ItemTableMetaId' => ['description' => '物品表ID。'."\n", 'type' => 'string', 'example' => '3'], + 'UserConditionType' => ['description' => '干预人群条件类型。', 'type' => 'string', 'example' => 'Array'], + 'UserConditionArray' => ['description' => '干预人群数组格式条件。', 'type' => 'string', 'example' => '[{"field":"gender","option":"=","value":"male"}]'], + 'UserConditionExpress' => ['description' => '干预人群表达式格式条件。', 'type' => 'string', 'example' => 'age<=30&&(3<=level<=6)&&gender=male'], + 'StatisBehaviorConditionType' => ['description' => '行为统计条件类型。', 'type' => 'string', 'example' => 'Array'], + 'StatisBehaviorConditionArray' => ['description' => '行为统计数组格式条件。', 'type' => 'string', 'example' => '[{"field":"click","option":"<=","value":"30"}]'], + 'StatisBehaviorConditionExpress' => ['description' => '行为统计表达式格式条件。', 'type' => 'string', 'example' => 'click=30'], + 'ControlType' => ['description' => '调控类型。', 'type' => 'string', 'example' => 'Percent'], + 'ControlGranularity' => ['description' => '调控粒度。', 'type' => 'string', 'example' => 'Global'], + 'ControlLogic' => ['description' => '调控逻辑。', 'type' => 'string', 'example' => 'Guaranteed'], + 'ItemConditionType' => ['description' => '物品条件类型。', 'type' => 'string', 'example' => 'Array'], + 'ItemConditionArray' => ['description' => '物品条件，设置数组格式条件。', 'type' => 'string', 'example' => '[{"field":"status","option":"=","value":"1"}]'], + 'ItemConditionExpress' => ['description' => '物品条件，设置表达式格式条件。', 'type' => 'string', 'example' => 'status=1'], + 'GmtCreateTime' => ['description' => '创建时间。', 'type' => 'string', 'example' => '2024-01-11T02:27:38.208Z'], + 'GmtModifiedTime' => ['description' => '更新时间。', 'type' => 'string', 'example' => '2024-01-11T02:27:38.208Z'], + 'TrafficControlTargets' => [ + 'description' => '流量调控目标列表。', 'type' => 'array', 'items' => [ + 'description' => '流量调控目标详情。', 'type' => 'object', 'properties' => [ - 'ExperimentGroupId' => [ - 'title' => '实验组ID。', - 'description' => '实验组ID。', - 'type' => 'string', - 'example' => '3', - ], - 'LayerId' => [ - 'title' => '层ID。', - 'description' => '层ID。', - 'type' => 'string', - 'example' => '3', - ], - 'LaboratoryId' => [ - 'title' => '实验室ID。', - 'description' => '实验室ID。', - 'type' => 'string', - 'example' => '4', - ], - 'SceneId' => [ - 'title' => '场景ID。', - 'description' => '场景ID。', - 'type' => 'string', - 'example' => '1', - ], - 'Name' => [ - 'title' => '实验组名称。', - 'description' => '实验组名称。', - 'type' => 'string', - 'example' => 'experiment_group1', - ], - 'Description' => [ - 'title' => '实验组描述。', - 'description' => '实验组描述。', - 'type' => 'string', - 'example' => 'This is a test.', - ], - 'DebugUsers' => [ - 'title' => '调试用户。', - 'description' => '调试用户。', - 'type' => 'string', - 'example' => '1124512470******,1124512471******,1124512472******', - ], - 'DebugCrowdId' => [ - 'title' => '调试人群ID。', - 'description' => '调试人群ID。', - 'type' => 'string', - 'example' => '4', - ], - 'Owner' => [ - 'title' => '创建人。', - 'description' => '创建人。', - 'type' => 'string', - 'example' => '1124512470******', - ], - 'NeedAA' => [ - 'title' => '是否需要AB实验组。', - 'description' => '是否需要AB实验组。', - 'type' => 'boolean', - 'example' => 'true', - ], - 'Filter' => [ - 'title' => '过滤条件。', - 'description' => '过滤条件。', - 'type' => 'string', - 'example' => 'gender=female', - ], - 'DistributionType' => [ - 'title' => '分流方式。'."\n" - .'● UserId-用户ID'."\n" - .'● TimeDuration-时段', - 'description' => '分流方式。'."\n" - .'● UserId-用户ID'."\n" - .'● TimeDuration-时段', - 'type' => 'string', - 'example' => 'UserId', - ], - 'DistributionTimeDuration' => [ - 'title' => '分流时段。', - 'description' => '分流时段。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '5', - ], - 'CrowdId' => [ - 'title' => '人群ID。', - 'description' => '人群ID。', - 'type' => 'string', - 'example' => '3', - ], - 'Config' => [ - 'title' => '实验组配置。', - 'description' => '实验组配置。', - 'type' => 'string', - 'example' => '{}', - ], - 'ReservedBuckets' => [ - 'title' => '预留桶号。', - 'description' => '预留桶号。', - 'type' => 'string', - 'example' => '1,2,3,4', - ], - 'Status' => [ - 'title' => '实验组状态。'."\n" - .'● Offline-未上线'."\n" - .'● Online-已上线'."\n" - .'● Pushed-已推全', - 'description' => '实验组状态。'."\n" - .'● Offline-未上线'."\n" - .'● Online-已上线'."\n" - .'● Pushed-已推全', - 'type' => 'string', - 'example' => 'Offline', - ], - 'CrowdTargetType' => [ - 'description' => '实验组流量定向的类型，可能的取值包括：'."\n" - ."\n" - .'* All 所有的流量'."\n" - .'* Filter 使用过滤条件的流量'."\n" - .'* CrowdId 通过指定人群ID'."\n" - .'* Random 按照百分比随机流量', - 'type' => 'string', - 'example' => 'All', - ], - 'RandomFlow' => [ - 'description' => '当实验组流量定向的类型是Random时，使用随机流量匹配这个实验组，可能的取值范围是 0 - 100。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '20', - ], - 'HoldingBuckets' => [ - 'description' => '当实验组流量定向的类型是Random时，根据随机流量RandomFlow大小，返回的具体的桶号。', - 'type' => 'string', - 'example' => '1,2,3,4', + 'TrafficControlTargetId' => ['description' => '流量调控目标ID。'."\n", 'type' => 'string', 'example' => '1'], + 'Name' => ['description' => '调控目标'."\n", 'type' => 'string', 'example' => 'target-1'], + 'StartTime' => ['description' => '开始时间'."\n", 'type' => 'string', 'example' => '2024-03-25'], + 'EndTime' => ['description' => '结束时间'."\n", 'type' => 'string', 'example' => '2024-04-25'], + 'ItemConditionType' => ['description' => '物品条件类型'."\n", 'type' => 'string', 'example' => 'Array'], + 'ItemConditionArray' => ['description' => '物品条件，设置数组格式条件'."\n", 'type' => 'string', 'example' => '[{"field":"status","option":"=","value":"1"}]'], + 'ItemConditionExpress' => ['description' => '物品条件，设置表达式格式条件'."\n", 'type' => 'string', 'example' => 'status=1'], + 'Event' => ['description' => '调控目标事件'."\n", 'type' => 'string', 'example' => 'click'], + 'Value' => ['description' => '调控目标值'."\n", 'type' => 'number', 'format' => 'float', 'example' => '30'], + 'StatisPeriod' => ['description' => '统计周期'."\n", 'type' => 'string', 'example' => 'Daily'], + 'ToleranceValue' => ['description' => '调控目标容错范围'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '10'], + 'RecallName' => ['description' => '召回策略名称'."\n", 'type' => 'string', 'example' => 'recall-1'], + 'Status' => ['description' => '状态'."\n", 'type' => 'string', 'example' => 'Opened'], + 'GmtCreateTime' => ['description' => '创建时间'."\n", 'type' => 'string', 'example' => '2024-03-25T06:04:28.441Z'], + 'GmtModifiedTime' => ['description' => '更新时间'."\n", 'type' => 'string', 'example' => '2024-03-25T06:04:28.441Z'], + 'SplitParts' => [ + 'description' => '调控目标拆分'."\n", + 'type' => 'object', + 'properties' => [ + 'TimePoints' => [ + 'description' => '调控目标拆分时间点'."\n", + 'type' => 'array', + 'items' => ['description' => '时间分割点。', 'type' => 'integer', 'format' => 'int32', 'example' => '2'], + ], + 'SetPoints' => [ + 'description' => '目标值分割点列表。', + 'type' => 'array', + 'items' => ['description' => '目标值分割点。', 'type' => 'integer', 'format' => 'int32', 'example' => '10'], + ], + 'SetValues' => [ + 'description' => '调控目标设置值列表。', + 'type' => 'array', + 'items' => ['description' => '目标设置值。', 'type' => 'integer', 'format' => 'int64', 'example' => '10'], + ], + ], ], + 'NewProductRegulation' => ['description' => '是否是新品调控'."\n", 'type' => 'boolean', 'example' => 'false'], + 'TrafficControlTaskId' => ['description' => '流量调控任务ID。', 'type' => 'string', 'example' => '1'], ], ], ], + 'EverPublished' => ['description' => '曾经是否发布过'."\n", 'type' => 'boolean', 'example' => 'true'], + 'ServiceId' => ['description' => '服务ID'."\n", 'type' => 'string', 'example' => '1'], + 'PreExperimentIds' => ['description' => '预发环境实验ID。'."\n", 'type' => 'string', 'example' => '1,2,3'], + 'ProdExperimentIds' => ['description' => '生产环境实验ID。'."\n", 'type' => 'string', 'example' => '4,5,6'], + 'FlinkResourceId' => ['description' => 'Flink资源ID。', 'type' => 'string', 'example' => 'resource-xxx'], + 'FlinkResourceName' => ['description' => 'Flink资源名称。', 'type' => 'string', 'example' => 'flink_test'], + 'EffectiveSceneIds' => [ + 'description' => '生效场景id列表。'."\n", + 'type' => 'array', + 'items' => ['description' => '有效服务ID列表。', 'type' => 'integer', 'format' => 'int32', 'example' => '3'], + ], + 'EffectiveSceneNames' => [ + 'description' => '生效场景名称列表。'."\n", + 'type' => 'array', + 'items' => ['description' => '生效场景名称列表。', 'type' => 'string', 'example' => 'home_feed'], + ], + 'ServiceIds' => [ + 'description' => '服务id列表。'."\n", + 'type' => 'array', + 'items' => ['description' => '分应用统计服务ID列表。', 'type' => 'integer', 'format' => 'int32', 'example' => '2'], + ], ], ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"59CE7EC6-F268-5D71-9215-32922CC50D72\\",\\n \\"TotalCount\\": 10,\\n \\"ExperimentGroups\\": [\\n {\\n \\"ExperimentGroupId\\": \\"3\\",\\n \\"LayerId\\": \\"3\\",\\n \\"LaboratoryId\\": \\"4\\",\\n \\"SceneId\\": \\"1\\",\\n \\"Name\\": \\"experiment_group1\\",\\n \\"Description\\": \\"This is a test.\\",\\n \\"DebugUsers\\": \\"1124512470******,1124512471******,1124512472******\\",\\n \\"DebugCrowdId\\": \\"4\\",\\n \\"Owner\\": \\"1124512470******\\",\\n \\"NeedAA\\": true,\\n \\"Filter\\": \\"gender=female\\",\\n \\"DistributionType\\": \\"UserId\\",\\n \\"DistributionTimeDuration\\": 5,\\n \\"CrowdId\\": \\"3\\",\\n \\"Config\\": \\"{}\\",\\n \\"ReservedBuckets\\": \\"1,2,3,4\\",\\n \\"Status\\": \\"Offline\\",\\n \\"CrowdTargetType\\": \\"All\\",\\n \\"RandomFlow\\": 20,\\n \\"HoldingBuckets\\": \\"1,2,3,4\\"\\n }\\n ]\\n}","type":"json"}]', - 'title' => '获取实验组列表', + 'title' => '获取流量调控任务详情', + 'summary' => '查询指定ID的流量调控任务的具体信息。', + 'description' => '## 请求说明'."\n" + .'- 该API用于获取特定流量调控任务的详细信息，包括但不限于任务名称、描述、状态等。'."\n" + .'- `TrafficControlTaskId` 和 `InstanceId` 是必填参数，分别用来指定要查询的任务ID和实例ID。'."\n" + .'- 可选参数如`Environment`, `Version`, 和 `ControlTargetFilter`可以帮助进一步细化请求，以获取更具体的任务数据或版本信息。'."\n" + .'- 注意检查返回的数据结构，特别是`TrafficControlTargets`部分，它包含了多个调控目标及其相关属性。'."\n", + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"728C5E01-ABF6-5AA8-B9FC-B3BA05DECC77\\",\\n \\"TrafficControlTaskId\\": \\"1\\",\\n \\"Name\\": \\"task-1\\",\\n \\"Description\\": \\"this is a test task\\",\\n \\"SceneId\\": \\"2\\",\\n \\"SceneName\\": \\"scene-2\\",\\n \\"ProductStatus\\": \\"Running\\",\\n \\"PrepubStatus\\": \\"Running\\",\\n \\"ExecutionTime\\": \\"Permanent\\",\\n \\"StartTime\\": \\"2024-03-25\\",\\n \\"EndTime\\": \\"2024-04-25\\",\\n \\"BehaviorTableMetaId\\": \\"1\\",\\n \\"UserTableMetaId\\": \\"2\\",\\n \\"ItemTableMetaId\\": \\"3\\",\\n \\"UserConditionType\\": \\"Array\\",\\n \\"UserConditionArray\\": \\"[{\\\\\\"field\\\\\\":\\\\\\"gender\\\\\\",\\\\\\"option\\\\\\":\\\\\\"=\\\\\\",\\\\\\"value\\\\\\":\\\\\\"male\\\\\\"}]\\",\\n \\"UserConditionExpress\\": \\"age<=30&&(3<=level<=6)&&gender=male\\",\\n \\"StatisBehaviorConditionType\\": \\"Array\\",\\n \\"StatisBehaviorConditionArray\\": \\"[{\\\\\\"field\\\\\\":\\\\\\"click\\\\\\",\\\\\\"option\\\\\\":\\\\\\"<=\\\\\\",\\\\\\"value\\\\\\":\\\\\\"30\\\\\\"}]\\",\\n \\"StatisBehaviorConditionExpress\\": \\"click=30\\",\\n \\"ControlType\\": \\"Percent\\",\\n \\"ControlGranularity\\": \\"Global\\",\\n \\"ControlLogic\\": \\"Guaranteed\\",\\n \\"ItemConditionType\\": \\"Array\\",\\n \\"ItemConditionArray\\": \\"[{\\\\\\"field\\\\\\":\\\\\\"status\\\\\\",\\\\\\"option\\\\\\":\\\\\\"=\\\\\\",\\\\\\"value\\\\\\":\\\\\\"1\\\\\\"}]\\",\\n \\"ItemConditionExpress\\": \\"status=1\\",\\n \\"GmtCreateTime\\": \\"2024-01-11T02:27:38.208Z\\",\\n \\"GmtModifiedTime\\": \\"2024-01-11T02:27:38.208Z\\",\\n \\"TrafficControlTargets\\": [\\n {\\n \\"TrafficControlTargetId\\": \\"1\\",\\n \\"Name\\": \\"target-1\\",\\n \\"StartTime\\": \\"2024-03-25\\",\\n \\"EndTime\\": \\"2024-04-25\\",\\n \\"ItemConditionType\\": \\"Array\\",\\n \\"ItemConditionArray\\": \\"[{\\\\\\"field\\\\\\":\\\\\\"status\\\\\\",\\\\\\"option\\\\\\":\\\\\\"=\\\\\\",\\\\\\"value\\\\\\":\\\\\\"1\\\\\\"}]\\",\\n \\"ItemConditionExpress\\": \\"status=1\\",\\n \\"Event\\": \\"click\\",\\n \\"Value\\": 30,\\n \\"StatisPeriod\\": \\"Daily\\",\\n \\"ToleranceValue\\": 10,\\n \\"RecallName\\": \\"recall-1\\",\\n \\"Status\\": \\"Opened\\",\\n \\"GmtCreateTime\\": \\"2024-03-25T06:04:28.441Z\\",\\n \\"GmtModifiedTime\\": \\"2024-03-25T06:04:28.441Z\\",\\n \\"SplitParts\\": {\\n \\"TimePoints\\": [\\n 2\\n ],\\n \\"SetPoints\\": [\\n 10\\n ],\\n \\"SetValues\\": [\\n 10\\n ]\\n },\\n \\"NewProductRegulation\\": false,\\n \\"TrafficControlTaskId\\": \\"1\\"\\n }\\n ],\\n \\"EverPublished\\": true,\\n \\"ServiceId\\": \\"1\\",\\n \\"PreExperimentIds\\": \\"1,2,3\\",\\n \\"ProdExperimentIds\\": \\"4,5,6\\",\\n \\"FlinkResourceId\\": \\"resource-xxx\\",\\n \\"FlinkResourceName\\": \\"flink_test\\",\\n \\"EffectiveSceneIds\\": [\\n 3\\n ],\\n \\"EffectiveSceneNames\\": [\\n \\"home_feed\\"\\n ],\\n \\"ServiceIds\\": [\\n 2\\n ]\\n}","type":"json"}]', ], - 'GetExperimentGroup' => [ - 'summary' => '获取指定实验组的详细信息。', - 'path' => '/api/v1/experimentgroups/{ExperimentGroupId}', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'GetTrafficControlTaskTraffic' => [ + 'summary' => '查询指定流量调控任务的流量分配情况。', + 'path' => '/api/v1/trafficcontroltasks/{TrafficControlTaskId}/trafficinfo', + 'methods' => ['get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'get', + 'operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeCode' => '183395', - 'abilityTreeNodes' => [ - 'FEATURElearnN0NAWV', - ], + 'abilityTreeCode' => '220416', + 'abilityTreeNodes' => ['FEATURElearnN0NAWV'], ], 'parameters' => [ [ - 'name' => 'ExperimentGroupId', + 'name' => 'TrafficControlTaskId', 'in' => 'path', - 'schema' => [ - 'title' => '实验组ID。', - 'description' => '实验组ID，可通过接口ListExperimentGroups获取。', - 'type' => 'string', - 'required' => true, - 'example' => '3', - ], + 'schema' => ['description' => '流量调控任务ID。', 'type' => 'string', 'required' => false, 'example' => '1'], ], [ 'name' => 'InstanceId', 'in' => 'query', - 'schema' => [ - 'title' => '实例ID。', - 'description' => '实例ID，可通过接口ListInstances获取。', - 'type' => 'string', - 'required' => true, - 'example' => 'pairec-cn-abcdefg1234', - ], + 'schema' => ['description' => '实例ID。如何获取实例ID，请参见[ListInstances](~~2411819~~)。', 'type' => 'string', 'required' => false, 'example' => 'pairec-test-xxx'], + ], + [ + 'name' => 'Environment', + 'in' => 'query', + 'schema' => ['description' => '运行环境。'."\n" + ."\n" + .'- Daily-日常环境。'."\n" + ."\n" + .'- Pre-预发环境。'."\n" + ."\n" + .'- Prod-生产环境。', 'type' => 'string', 'required' => false, 'example' => 'Pre'], ], ], 'responses' => [ @@ -8760,231 +8074,143 @@ 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'Id of the request', - 'type' => 'string', - 'example' => 'BDB621CB-A81E-5D39-8793-39A365CBCC74', - ], - 'LayerId' => [ - 'title' => '层ID。', - 'description' => '层ID。', - 'type' => 'string', - 'example' => '3', - ], - 'LaboratoryId' => [ - 'title' => '实验室ID。', - 'description' => '实验室ID。', - 'type' => 'string', - 'example' => '4', - ], - 'SceneId' => [ - 'title' => '场景ID。', - 'description' => '场景ID。', - 'type' => 'string', - 'example' => '1', - ], - 'Name' => [ - 'title' => '实验组名称。', - 'description' => '实验组名称。', - 'type' => 'string', - 'example' => 'experiment_group1', - ], - 'Description' => [ - 'title' => '实验组描述。', - 'description' => '实验组描述。', - 'type' => 'string', - 'example' => 'This is a test.', - ], - 'DebugUsers' => [ - 'title' => '调试用户。', - 'description' => '调试用户，多个用户间用逗号作间隔。', - 'type' => 'string', - 'example' => '1124512470******,1124512471******,1124512472******', - ], - 'DebugCrowdId' => [ - 'title' => '调试人群ID。', - 'description' => '调试人群ID。', - 'type' => 'string', - 'example' => '4', - ], - 'Owner' => [ - 'title' => '创建人。', - 'description' => '创建人。', - 'type' => 'string', - 'example' => '1124512470******', - ], - 'NeedAA' => [ - 'title' => '是否需要AB实验组。', - 'description' => '是否需要AB实验组。', - 'type' => 'boolean', - 'example' => 'true', - ], - 'Filter' => [ - 'title' => '过滤条件。', - 'description' => '过滤条件。', - 'type' => 'string', - 'example' => 'gender=female', - ], - 'DistributionType' => [ - 'title' => '分流方式。'."\n" - .'● UserId-用户ID'."\n" - .'● TimeDuration-时段', - 'description' => '分流方式。'."\n" - .'● UserId-用户ID'."\n" - .'● TimeDuration-时段', - 'type' => 'string', - 'example' => 'UserId', - ], - 'DistributionTimeDuration' => [ - 'title' => '分流时段。', - 'description' => '分流时段。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '5', - ], - 'CrowdId' => [ - 'title' => '人群ID。', - 'description' => '人群ID。', - 'type' => 'string', - 'example' => '3', - ], - 'Config' => [ - 'title' => '实验组配置。', - 'description' => '实验组配置。', - 'type' => 'string', - 'example' => '{"RankBy": "Score"}', - ], - 'ReservedBuckets' => [ - 'title' => '预留桶号。', - 'description' => '预留桶号。', - 'type' => 'string', - 'example' => '1,2,3,4', - ], - 'Status' => [ - 'title' => '实验组状态。'."\n" - .'● Offline-未上线'."\n" - .'● Online-已上线'."\n" - .'● Pushed-已推全', - 'description' => '实验组状态。'."\n" - .'● Offline-未上线'."\n" - .'● Online-已上线'."\n" - .'● Pushed-已推全', - 'type' => 'string', - 'example' => 'Offline', - ], - 'CrowdTargetType' => [ - 'description' => '实验组流量定向的类型，可能的取值包括：'."\n" - .'* All 所有的流量'."\n" - .'* Filter 使用过滤条件的流量'."\n" - .'* CrowdId 通过指定人群ID'."\n" - .'* Random 按照百分比随机流量', - 'type' => 'string', - 'example' => 'All', - ], - 'RandomFlow' => [ - 'description' => '当实验组流量定向的类型是Random时，使用随机流量匹配这个实验组，可能的取值范围是 0 - 100。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '20', - ], - 'HoldingBuckets' => [ - 'description' => '当实验组流量定向的类型是Random时，根据随机流量RandomFlow大小，返回的具体的桶号。', - 'type' => 'string', - 'example' => '1,2,3,4', + 'RequestId' => ['title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => '6CF1E160-3F36-5E73-A170-C75504F05BBC'], + 'TrafficControlTaskTrafficInfo' => [ + 'description' => '上报的关于流量调控的数据详情。', + 'type' => 'object', + 'properties' => [ + 'TaskTraffics' => [ + 'description' => '上报的调控任务的流量数据。', + 'type' => 'object', + 'additionalProperties' => [ + 'type' => 'object', + 'properties' => [ + 'Traffic' => ['type' => 'number', 'format' => 'double', 'description' => '对应调控任务的真实上报流量。', 'example' => '100'], + ], + 'description' => '数据是Map结构，Key为实验ID。', + ], + ], + 'TargetTraffics' => [ + 'description' => '上报的调控目标的真实流量数据，此处是数组结构。', + 'type' => 'array', + 'items' => [ + 'description' => '上报的调控目标的真实流量数据。', + 'type' => 'object', + 'properties' => [ + 'TrafficContorlTargetId' => ['description' => '调控目标ID。', 'type' => 'string', 'example' => '2'], + 'Data' => [ + 'description' => '上报的此调控目标的详细数据信息。', + 'type' => 'object', + 'additionalProperties' => [ + 'type' => 'object', + 'properties' => [ + 'Traffic' => ['type' => 'number', 'format' => 'double', 'description' => '上报的调控目标的真实流量。', 'example' => '80'], + 'RecordTime' => ['type' => 'integer', 'format' => 'int64', 'description' => '上报数据的时间戳。', 'example' => '1760319273'], + ], + 'description' => '数据是Map结构，Key为实验ID。', + ], + ], + ], + ], + ], + ], ], ], ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"6CF1E160-3F36-5E73-A170-C75504F05BBC\\",\\n \\"TrafficControlTaskTrafficInfo\\": {\\n \\"TaskTraffics\\": {\\n \\"key\\": {\\n \\"Traffic\\": 100\\n }\\n },\\n \\"TargetTraffics\\": [\\n {\\n \\"TrafficContorlTargetId\\": \\"2\\",\\n \\"Data\\": {\\n \\"key\\": {\\n \\"Traffic\\": 80,\\n \\"RecordTime\\": 1760319273\\n }\\n }\\n }\\n ]\\n }\\n}","type":"json"}]', + 'title' => '获取流量调控任务详情', + 'description' => '## 请求说明'."\n" + .'通过此API，您可以根据提供的`TrafficControlTaskId`、`InstanceId`和`Environment`参数来获取特定流量调控任务下的流量详情。请确保在请求时正确填写这些必选参数。'."\n" + ."\n" + .'- `TrafficControlTaskId`：流量调控任务的唯一标识符。'."\n" + .'- `InstanceId`：实例ID，用于定位具体的实例。'."\n" + .'- `Environment`：环境类型，如生产环境（Prod）等。'."\n" + ."\n" + .'返回的数据将包括每个实验或单品的流量分配情况，以帮助您更好地理解和管理您的流量调控策略。'."\n", + 'changeSet' => [ + ['createdAt' => '2025-10-14T05:30:57.000Z', 'description' => '响应参数发生变更'], + ], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'pairec:GetTrafficControlTaskTraffic', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIRecService', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"BDB621CB-A81E-5D39-8793-39A365CBCC74\\",\\n \\"LayerId\\": \\"3\\",\\n \\"LaboratoryId\\": \\"4\\",\\n \\"SceneId\\": \\"1\\",\\n \\"Name\\": \\"experiment_group1\\",\\n \\"Description\\": \\"This is a test.\\",\\n \\"DebugUsers\\": \\"1124512470******,1124512471******,1124512472******\\",\\n \\"DebugCrowdId\\": \\"4\\",\\n \\"Owner\\": \\"1124512470******\\",\\n \\"NeedAA\\": true,\\n \\"Filter\\": \\"gender=female\\",\\n \\"DistributionType\\": \\"UserId\\",\\n \\"DistributionTimeDuration\\": 5,\\n \\"CrowdId\\": \\"3\\",\\n \\"Config\\": \\"{\\\\\\"RankBy\\\\\\": \\\\\\"Score\\\\\\"}\\",\\n \\"ReservedBuckets\\": \\"1,2,3,4\\",\\n \\"Status\\": \\"Offline\\",\\n \\"CrowdTargetType\\": \\"All\\",\\n \\"RandomFlow\\": 20,\\n \\"HoldingBuckets\\": \\"1,2,3,4\\"\\n}","type":"json"}]', - 'title' => '获取实验组详细信息', ], - 'CloneExperimentGroup' => [ - 'summary' => '向指定环境克隆一个实验组。', - 'path' => '/api/v1/experimentgroups/{ExperimentGroupId}/action/clone', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'ListABMetricGroups' => [ + 'summary' => '获取AB实验指标组列表。', + 'path' => '/api/v1/abmetricgroups', + 'methods' => ['get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], - 'operationType' => 'readAndWrite', + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'none', + 'operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATURElearnN0NAWV', - ], + 'abilityTreeNodes' => ['FEATURElearnN0NAWV'], ], 'parameters' => [ [ - 'name' => 'ExperimentGroupId', - 'in' => 'path', - 'schema' => [ - 'title' => '实验组ID。', - 'description' => '实验组ID，可通过接口ListExperimentGroups获取。', - 'type' => 'string', - 'required' => true, - 'example' => '3', - ], + 'name' => 'SceneId', + 'in' => 'query', + 'schema' => ['description' => '场景ID，可通过接口[ListScenes]((~~2402581~~))获取。', 'type' => 'string', 'required' => false, 'example' => '1'], ], [ - 'name' => 'body', - 'in' => 'body', - 'style' => 'json', - 'schema' => [ - 'title' => '请求body。', - 'description' => '请求body。', - 'type' => 'object', - 'properties' => [ - 'InstanceId' => [ - 'title' => '实例ID。', - 'description' => '实例ID，可通过接口ListInstances获取。', - 'type' => 'string', - 'required' => true, - 'example' => 'pairec-cn-abcdefg1234'."\n", - ], - 'LayerId' => [ - 'title' => '层ID。', - 'description' => '层ID，可通过接口ListLayers获取。', - 'type' => 'string', - 'required' => true, - 'example' => '3', - ], - 'Environment' => [ - 'title' => '克隆到的环境。'."\n" - .'● Daily-日常环境'."\n" - .'● Pre-预发环境'."\n" - .'● Prod-生产环境', - 'description' => '克隆到的环境。'."\n" - .'● Daily-日常环境'."\n" - .'● Pre-预发环境'."\n" - .'● Prod-生产环境', - 'type' => 'string', - 'required' => true, - 'example' => 'Daily', - ], - ], - 'required' => false, - ], + 'name' => 'InstanceId', + 'in' => 'query', + 'schema' => ['description' => '实例ID，可通过接口[ListInstances](~~2411819~~)获取。', 'type' => 'string', 'required' => true, 'example' => 'pairec-cn-test1'], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => ['description' => '页码。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1'], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => ['description' => '页大小。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10'], + ], + [ + 'name' => 'Realtime', + 'in' => 'query', + 'schema' => ['description' => '指标组实时类型过滤', 'type' => 'boolean', 'required' => false, 'example' => 'false'], + ], + [ + 'name' => 'SortBy', + 'in' => 'query', + 'schema' => ['description' => '排序依据，取值：'."\n" + ."\n" + .'- GmtCreateTime：创建时间。'."\n" + .'- GmtModifiedTime：更新时间。', 'type' => 'string', 'required' => false, 'example' => 'GmtCreateTime'], + ], + [ + 'name' => 'Order', + 'in' => 'query', + 'schema' => ['description' => '排序方式，取值：'."\n" + ."\n" + .'- ASC：升序。'."\n" + .'- DESC：降序。', 'type' => 'string', 'required' => false, 'example' => 'ASC'], ], ], 'responses' => [ @@ -8994,91 +8220,254 @@ 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'Id of the request', - 'type' => 'string', - 'example' => '12A65C6C-AFA1-59B2-9A66-A9E0BB73F0E5', - ], - 'ExperimentGroupId' => [ - 'title' => '克隆后的实验组ID。', - 'description' => '克隆后的实验组ID。', - 'type' => 'string', - 'example' => '3', + 'RequestId' => ['title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => 'E15A1443-7917-5BE0-AE70-25538ECF398D'], + 'TotalCount' => ['description' => '总个数。', 'type' => 'integer', 'format' => 'int64', 'example' => '10'], + 'ABMetricGroups' => [ + 'description' => 'AB指标组列表。', + 'type' => 'array', + 'items' => [ + 'description' => 'AB指标组信息。', + 'type' => 'object', + 'properties' => [ + 'ABMetricGroupId' => ['description' => '指标组ID。', 'type' => 'string', 'example' => '1'], + 'Name' => ['description' => '指标组名称。', 'type' => 'string', 'example' => 'visits'], + 'SceneId' => ['description' => '场景ID。', 'type' => 'string', 'example' => '1'], + 'Description' => ['description' => '指标组描述。', 'type' => 'string', 'example' => '访问量相关指标'], + 'Owner' => ['description' => '负责人。', 'type' => 'string', 'example' => '2799614***'], + 'ABMetricIds' => ['description' => 'AB实验指标ID列表，逗号分隔。', 'type' => 'string', 'example' => '1,2'], + 'ABMetricNames' => ['description' => 'AB实验指标名称列表，逗号分隔。', 'type' => 'string', 'example' => 'pv,uv'], + 'Realtime' => ['description' => '是否为实时指标组。', 'type' => 'boolean', 'example' => 'false'], + ], + ], ], ], ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"E15A1443-7917-5BE0-AE70-25538ECF398D\\",\\n \\"TotalCount\\": 10,\\n \\"ABMetricGroups\\": [\\n {\\n \\"ABMetricGroupId\\": \\"1\\",\\n \\"Name\\": \\"visits\\",\\n \\"SceneId\\": \\"1\\",\\n \\"Description\\": \\"访问量相关指标\\",\\n \\"Owner\\": \\"2799614***\\",\\n \\"ABMetricIds\\": \\"1,2\\",\\n \\"ABMetricNames\\": \\"pv,uv\\",\\n \\"Realtime\\": false\\n }\\n ]\\n}","type":"json"}]', + 'title' => '获取指标组列表', + 'changeSet' => [ + ['createdAt' => '2024-02-22T03:35:43.000Z', 'description' => '请求参数发生变更'], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"12A65C6C-AFA1-59B2-9A66-A9E0BB73F0E5\\",\\n \\"ExperimentGroupId\\": \\"3\\"\\n}","type":"json"}]', - 'title' => '克隆实验组', - ], - 'OnlineExperimentGroup' => [ - 'summary' => '上线指定实验组。', - 'path' => '/api/v1/experimentgroups/{ExperimentGroupId}/action/online', - 'methods' => [ - 'post', + 'flowControl' => [ + 'flowControlList' => [], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'pairec:ListABMetricGroups', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIRecService', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], ], + ], + 'ListABMetrics' => [ + 'path' => '/api/v1/abmetrics', + 'methods' => ['get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], - 'operationType' => 'readAndWrite', + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'none', + 'operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATURElearnN0NAWV', - ], + 'abilityTreeNodes' => ['FEATURElearnN0NAWV'], ], 'parameters' => [ [ - 'name' => 'ExperimentGroupId', - 'in' => 'path', - 'schema' => [ - 'title' => '实验组ID。', - 'description' => '实验组ID，可通过接口ListExperimentGroups获取。', - 'type' => 'string', - 'required' => true, - 'example' => '3', - ], + 'name' => 'Type', + 'in' => 'query', + 'schema' => ['description' => '指标类型过滤。'."\n" + ."\n" + .'- Single-单一指标。'."\n" + ."\n" + .'- Derived-衍生指标。', 'type' => 'string', 'required' => false, 'example' => 'Single'], ], [ - 'name' => 'body', - 'in' => 'body', - 'style' => 'json', + 'name' => 'Realtime', + 'in' => 'query', + 'schema' => ['description' => '是否指标实时类型过滤。', 'type' => 'boolean', 'required' => false, 'example' => 'false'], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => ['description' => '页码。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1'], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => ['description' => '页大小。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10'], + ], + [ + 'name' => 'Name', + 'in' => 'query', + 'schema' => ['description' => '名称过滤。', 'type' => 'string', 'required' => false, 'example' => 'home'], + ], + [ + 'name' => 'TableMetaId', + 'in' => 'query', + 'schema' => ['description' => '数据表ID，可通过ListTableMetas获取。', 'type' => 'string', 'required' => false, 'example' => '1'], + ], + [ + 'name' => 'InstanceId', + 'in' => 'query', + 'schema' => ['description' => '实例ID，可通过接口[ListInstances](~~2411819~~)获取。', 'type' => 'string', 'required' => true, 'example' => 'pairec-cn-test1'], + ], + [ + 'name' => 'SceneId', + 'in' => 'query', + 'schema' => ['description' => '场景ID，来源于[ListScenes](~~2402581~~)接口。', 'type' => 'string', 'required' => false, 'example' => '1'], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => '请求body。', + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'InstanceId' => [ - 'title' => '实例ID。', - 'description' => '实例ID，可通过接口ListInstances获取。', - 'type' => 'string', - 'required' => true, - 'example' => 'pairec-cn-abcdefg1234'."\n", + 'RequestId' => ['title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => 'F7AC05FF-EDE7-5C2B-B9AE-33D6DF4178BA'], + 'TotalCount' => ['description' => '总个数。', 'type' => 'integer', 'format' => 'int64', 'example' => '10'], + 'ABMetrics' => [ + 'description' => 'AB指标列表。', + 'type' => 'array', + 'items' => [ + 'description' => 'AB指标信息。', + 'type' => 'object', + 'properties' => [ + 'ABMetricId' => ['description' => 'AB指标ID。', 'type' => 'string', 'example' => '1'], + 'Name' => ['description' => '指标名称。', 'type' => 'string', 'example' => 'pv'], + 'Description' => ['description' => '指标描述。', 'type' => 'string', 'example' => 'pv指标'], + 'SceneId' => ['description' => '场景ID。', 'type' => 'string', 'example' => '1'], + 'SceneName' => ['description' => '场景名称', 'type' => 'string', 'example' => 'home_feed'], + 'Type' => ['description' => '指标类型。'."\n" + ."\n" + .'- Single-单一指标。'."\n" + ."\n" + .'- Derived-衍生指标。', 'type' => 'string', 'example' => 'Single'], + 'Realtime' => ['description' => '是否为实时指标。'."\n" + ."\n" + .'- true-是。'."\n" + ."\n" + .'- false-否。', 'type' => 'string', 'example' => 'false'], + 'TableMetaId' => ['description' => '数据表ID。', 'type' => 'string', 'example' => '1'], + 'ResultTableMetaId' => ['description' => '数据写回到的数据表ID。', 'type' => 'string', 'example' => '2'], + 'ResultResourceId' => ['description' => '写回数据表的数据源的ID。', 'type' => 'string', 'example' => '3'], + 'Definition' => ['description' => '指标定义。', 'type' => 'string', 'example' => 'sum(click_cnt)'], + 'StatisticsCycle' => ['description' => '统计周期。', 'type' => 'integer', 'format' => 'int32', 'example' => '1'], + 'LeftMetricId' => ['description' => '衍生指标的左指标ID。', 'type' => 'string', 'example' => '3'], + 'RightMetricId' => ['description' => '衍生指标的右指标ID。', 'type' => 'string', 'example' => '2'], + 'Operator' => ['description' => '衍生指标计算的操作符。'."\n" + ."\n" + .'- Plus-加'."\n" + ."\n" + .'- Minus-减'."\n" + ."\n" + .'- Multiplication-乘'."\n" + ."\n" + .'- Division-除', 'type' => 'string', 'example' => 'Division'], + 'NeedSignificance' => ['type' => 'boolean'], + 'AggregationByUser' => ['type' => 'boolean'], + 'Numerator' => ['type' => 'string', 'example' => 'click'], + 'Denominator' => ['type' => 'string', 'example' => 'pv'], + 'IsBinomialDistribution' => ['type' => 'boolean'], + ], + ], ], ], - 'required' => false, ], ], ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '获取AB指标列表', + 'summary' => '获取AB实验指标列表。', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'pairec:ListABMetrics', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIRecService', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"F7AC05FF-EDE7-5C2B-B9AE-33D6DF4178BA\\",\\n \\"TotalCount\\": 10,\\n \\"ABMetrics\\": [\\n {\\n \\"ABMetricId\\": \\"1\\",\\n \\"Name\\": \\"pv\\",\\n \\"Description\\": \\"pv指标\\",\\n \\"SceneId\\": \\"1\\",\\n \\"SceneName\\": \\"home_feed\\",\\n \\"Type\\": \\"Single\\",\\n \\"Realtime\\": \\"false\\",\\n \\"TableMetaId\\": \\"1\\",\\n \\"ResultTableMetaId\\": \\"2\\",\\n \\"ResultResourceId\\": \\"3\\",\\n \\"Definition\\": \\"sum(click_cnt)\\",\\n \\"StatisticsCycle\\": 1,\\n \\"LeftMetricId\\": \\"3\\",\\n \\"RightMetricId\\": \\"2\\",\\n \\"Operator\\": \\"Division\\",\\n \\"NeedSignificance\\": true,\\n \\"AggregationByUser\\": true,\\n \\"Numerator\\": \\"click\\",\\n \\"Denominator\\": \\"pv\\",\\n \\"IsBinomialDistribution\\": true\\n }\\n ]\\n}","type":"json"}]', + ], + 'ListCalculationJobs' => [ + 'summary' => '获取计算任务列表。', + 'path' => '/api/v1/calculationjobs', + 'methods' => ['get'], + 'schemes' => ['http', 'https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATURElearnN0NAWV'], + ], + 'parameters' => [ + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => ['description' => '页码。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1'], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => ['description' => '页大小。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10'], + ], + [ + 'name' => 'InstanceId', + 'in' => 'query', + 'schema' => ['description' => '实例ID，可通过接口[ListInstances](~~2411819~~)获取。', 'type' => 'string', 'required' => true, 'example' => 'pairec-cn-test1'], + ], + [ + 'name' => 'SceneId', + 'in' => 'query', + 'schema' => ['description' => '场景ID，可通过[ListScenes](~~2402581~~)接口获取。', 'type' => 'string', 'required' => true, 'example' => '1'], + ], + [ + 'name' => 'Status', + 'in' => 'query', + 'schema' => ['description' => '状态。'."\n" + ."\n" + .'- Success-成功'."\n" + ."\n" + .'- Failure-失败'."\n" + ."\n" + .'- Initializing-初始化中'."\n" + ."\n" + .'- Running-运行中', 'type' => 'string', 'required' => false, 'example' => 'Success'], + ], + ], 'responses' => [ 200 => [ 'schema' => [ @@ -9086,86 +8475,168 @@ 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'Id of the request', - 'type' => 'string', - 'example' => '47F761ED-BE4E-51A6-B678-78E1490DF313', + 'RequestId' => ['title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => 'F7AC05FF-EDE7-5C2B-B9AE-33D6DF4178BA'], + 'TotalCount' => ['description' => '列表内元素总数。', 'type' => 'integer', 'format' => 'int64', 'example' => '10'], + 'CalculationJobs' => [ + 'description' => '计算任务列表。', + 'type' => 'array', + 'items' => [ + 'description' => '计算任务信息。', + 'type' => 'object', + 'properties' => [ + 'CalculationJobId' => ['description' => '计算任务ID。', 'type' => 'string', 'example' => '2'], + 'ABMetricName' => ['description' => 'AB指标名称。', 'type' => 'string', 'example' => 'pv'], + 'Status' => ['description' => '任务状态。'."\n" + ."\n" + .'- Success-成功'."\n" + ."\n" + .'- Failure-失败'."\n" + ."\n" + .'- Initializing-初始化中'."\n" + ."\n" + .'- Running-运行中', 'type' => 'string', 'example' => 'Success'], + 'JobMessage' => [ + 'description' => '任务信息。', + 'type' => 'array', + 'items' => ['description' => '任务信息。', 'type' => 'string', 'example' => 'success'], + ], + 'Config' => ['description' => '任务配置。', 'type' => 'string', 'example' => '{}'], + 'GmtRanTime' => ['description' => '运行时间。', 'type' => 'string', 'example' => '2021-12-15T23:24:33.132+08:00'], + 'BizDate' => ['description' => '业务时间。', 'type' => 'string', 'example' => '2021-12-15'], + 'JobSource' => ['description' => '任务来源。'."\n" + ."\n" + .'- CronOffline-离线定时任务'."\n" + ."\n" + .'- DataRerun-数据重跑任务', 'type' => 'string', 'example' => 'CronOffline'], + ], + ], ], ], ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"F7AC05FF-EDE7-5C2B-B9AE-33D6DF4178BA\\",\\n \\"TotalCount\\": 10,\\n \\"CalculationJobs\\": [\\n {\\n \\"CalculationJobId\\": \\"2\\",\\n \\"ABMetricName\\": \\"pv\\",\\n \\"Status\\": \\"Success\\",\\n \\"JobMessage\\": [\\n \\"success\\"\\n ],\\n \\"Config\\": \\"{}\\",\\n \\"GmtRanTime\\": \\"2021-12-15T23:24:33.132+08:00\\",\\n \\"BizDate\\": \\"2021-12-15\\",\\n \\"JobSource\\": \\"CronOffline\\"\\n }\\n ]\\n}","type":"json"}]', + 'title' => '获取计算任务列表', + 'changeSet' => [ + ['createdAt' => '2024-02-22T03:35:41.000Z', 'description' => '请求参数发生变更'], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"47F761ED-BE4E-51A6-B678-78E1490DF313\\"\\n}","type":"json"}]', - 'title' => '上线实验组', - ], - 'OfflineExperimentGroup' => [ - 'summary' => '下线指定实验组。', - 'path' => '/api/v1/experimentgroups/{ExperimentGroupId}/action/offline', - 'methods' => [ - 'post', + 'flowControl' => [ + 'flowControlList' => [], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'pairec:ListCalculationJobs', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIRecService', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], ], + ], + 'ListCrowdUsers' => [ + 'path' => '/api/v1/crowds/{CrowdId}/users', + 'methods' => ['get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], - 'operationType' => 'readAndWrite', + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'none', + 'operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATURElearnN0NAWV', - ], + 'abilityTreeNodes' => ['FEATURElearnN0NAWV'], ], 'parameters' => [ [ - 'name' => 'ExperimentGroupId', + 'name' => 'CrowdId', 'in' => 'path', - 'schema' => [ - 'title' => '实验组ID。', - 'description' => '实验组ID，可通过接口ListExperimentGroups获取。', - 'type' => 'string', - 'required' => true, - 'example' => '3', - ], + 'schema' => ['title' => '人群ID。', 'description' => '人群ID，可通过接口ListCrowds获取。', 'type' => 'string', 'required' => true, 'example' => '1'], ], [ - 'name' => 'body', - 'in' => 'body', - 'style' => 'json', + 'name' => 'InstanceId', + 'in' => 'query', + 'schema' => ['title' => '实例ID。', 'description' => '实例ID，可通过接口ListInstances获取。', 'type' => 'string', 'required' => true, 'example' => 'pairec-cn-abcdefg1234'], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'title' => '请求body。', - 'description' => '请求body。', + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'InstanceId' => [ - 'title' => '实例ID。', - 'description' => '实例ID。', - 'type' => 'string', - 'required' => true, - 'example' => 'pairec-cn-abcdefg1234'."\n", + 'RequestId' => ['title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => 'F0AB6527-093F-5C44-B3BD-42C8C210C619'], + 'TotalCount' => ['title' => '列表内元素总个数。', 'description' => '列表内元素总个数。', 'type' => 'integer', 'format' => 'int64', 'example' => '3'], + 'Users' => [ + 'title' => '用户列表。', + 'description' => '用户列表。', + 'type' => 'array', + 'items' => ['description' => '用户ID。', 'type' => 'string', 'example' => 'user1'], ], ], - 'required' => false, ], ], ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '获取人群下用户列表', + 'summary' => '获取指定人群所包含的所有用户，包括人群下的子人群内的用户。', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'pairec:ListCrowdUsers', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIRecService', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"F0AB6527-093F-5C44-B3BD-42C8C210C619\\",\\n \\"TotalCount\\": 3,\\n \\"Users\\": [\\n \\"user1\\"\\n ]\\n}","type":"json"}]', + ], + 'ListCrowds' => [ + 'summary' => '获取人群列表。', + 'path' => '/api/v1/crowds', + 'methods' => ['get'], + 'schemes' => ['http', 'https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATURElearnN0NAWV'], + ], + 'parameters' => [ + [ + 'name' => 'InstanceId', + 'in' => 'query', + 'schema' => ['title' => '实例ID。', 'description' => '实例ID，可通过接口ListInstances获取。', 'type' => 'string', 'required' => true, 'example' => 'pairec-cn-abcdefg1234'], + ], + ], 'responses' => [ 200 => [ 'schema' => [ @@ -9173,216 +8644,243 @@ 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'Id of the request', - 'type' => 'string', - 'example' => '518C64F6-DFF7-11ED-85B0-00163E14B3D1', + 'RequestId' => ['title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => '9763624B-5FBB-5E3A-9193-B1ADB554CEAE'], + 'TotalCount' => ['title' => '列表内元素总数。', 'description' => '列表内元素总数。', 'type' => 'integer', 'format' => 'int64', 'example' => '10'], + 'Crowds' => [ + 'title' => '人群列表。', + 'description' => '人群列表。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'CrowdId' => ['title' => '人群ID。', 'description' => '人群ID。', 'type' => 'string', 'example' => '3'], + 'Name' => ['title' => '人群名称。', 'description' => '人群名称。', 'type' => 'string', 'example' => 'crowd1'], + 'Description' => ['title' => '人群描述。', 'description' => '人群描述。', 'type' => 'string', 'example' => 'This is a test.'], + 'Label' => ['title' => '人群标签。', 'description' => '人群标签。', 'type' => 'string', 'example' => 'os=android'], + 'Source' => ['title' => '人群来源。'."\n" + .'● ManualInput-手工输入'."\n" + .'● UploadFile-文件上传', 'description' => '人群来源。'."\n" + ."\n" + .'- ManualInput：手工输入'."\n" + .'- UploadFile：文件上传', 'type' => 'string', 'example' => 'ManualInput'], + 'Quantity' => ['title' => '数量。', 'description' => '数量。', 'type' => 'string', 'example' => '10'], + 'Users' => ['title' => '人群内包含的用户，多个用户间以逗号隔开。', 'description' => '人群内包含的用户，多个用户间以逗号隔开。', 'type' => 'string', 'example' => 'user1,user2'], + 'GmtCreateTime' => ['title' => '人群创建时间。', 'description' => '人群创建时间。', 'type' => 'string', 'example' => '2021-12-15T23:24:33.132+08:00'], + ], + 'description' => '', + ], ], ], ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '获取人群列表', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'pairec:ListCrowds', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIRecService', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"518C64F6-DFF7-11ED-85B0-00163E14B3D1\\"\\n}","type":"json"}]', - 'title' => '下线实验组', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"9763624B-5FBB-5E3A-9193-B1ADB554CEAE\\",\\n \\"TotalCount\\": 10,\\n \\"Crowds\\": [\\n {\\n \\"CrowdId\\": \\"3\\",\\n \\"Name\\": \\"crowd1\\",\\n \\"Description\\": \\"This is a test.\\",\\n \\"Label\\": \\"os=android\\",\\n \\"Source\\": \\"ManualInput\\",\\n \\"Quantity\\": \\"10\\",\\n \\"Users\\": \\"user1,user2\\",\\n \\"GmtCreateTime\\": \\"2021-12-15T23:24:33.132+08:00\\"\\n }\\n ]\\n}","type":"json"}]', ], - 'CreateExperiment' => [ - 'summary' => '在指定实验组下创建一个实验。', - 'path' => '/api/v1/experiments', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'ListDataDiagnoses' => [ + 'path' => '/api/v1/datadiagnoses', + 'methods' => ['get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'create', + 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATURElearnN0NAWV', - ], + 'abilityTreeNodes' => ['FEATURElearnN0NAWV'], ], 'parameters' => [ [ - 'name' => 'body', - 'in' => 'body', - 'style' => 'json', + 'name' => 'Types', + 'in' => 'query', + 'style' => 'simple', 'schema' => [ - 'description' => '请求body。', - 'type' => 'object', - 'properties' => [ - 'InstanceId' => [ - 'title' => '实例ID。', - 'description' => '实例ID，可通过接口ListInstances获取。', - 'type' => 'string', - 'required' => true, - 'example' => 'pairec-test1', - ], - 'ExperimentGroupId' => [ - 'title' => '实验组ID。', - 'description' => '实验组ID，可通过接口ListExperimentGroups获取。', - 'type' => 'string', - 'required' => true, - 'example' => '3', - ], - 'Name' => [ - 'title' => '实验名称。', - 'description' => '实验名称。', - 'type' => 'string', - 'required' => true, - 'example' => 'experiment_test', - ], - 'Description' => [ - 'title' => '实验描述。', - 'description' => '实验描述。', - 'type' => 'string', - 'required' => true, - 'example' => 'This is a test.', - ], - 'Type' => [ - 'title' => '实验类型。'."\n" - .'● Baseline-基准实验。'."\n" - .'● Normal-普通实验。', - 'description' => '实验类型。'."\n" - .'● Baseline-基准实验。'."\n" - .'● Normal-普通实验。', - 'type' => 'string', - 'required' => true, - 'example' => 'Baseline', - ], - 'FlowPercent' => [ - 'title' => '流量分配百分比。', - 'description' => '流量分配百分比。', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '100', - ], - 'DebugUsers' => [ - 'title' => '调试用户。', - 'description' => '调试用户（需为阿里云账户主账号/子账号uid），多个用户需通过逗号作间隔。', - 'type' => 'string', - 'required' => false, - 'example' => '1124512470******,1124512471******,1124512472******', - ], - 'DebugCrowdId' => [ - 'title' => '调试人群ID。', - 'description' => '调试人群ID，可通过接口ListCrowds获取。', - 'type' => 'string', - 'required' => false, - 'example' => '3', - ], - 'Config' => [ - 'title' => '实验配置。', - 'description' => '实验配置。', - 'type' => 'string', - 'required' => false, - 'example' => '{"RankBy": "Score"}', - ], + 'description' => '数据诊断类型列表。', + 'type' => 'array', + 'items' => [ + 'description' => '- ChangeRate：物品/用户变化率分析。'."\n" + ."\n" + .'- PreferenceStatisticsCycle：用户偏好统计周期分析。'."\n" + ."\n" + .'- JoinTables：两表关联分析。'."\n" + ."\n" + .'- BaseStatistics：基础统计分析。'."\n" + ."\n" + .'- AbnormalBehavior：异常行为分析。', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => ['AbnormalBehavior' => 'AbnormalBehavior', 'JoinTables' => 'JoinTables', 'PreferenceStatisticsCycle' => 'PreferenceStatisticsCycle', 'BaseStatistics' => 'BaseStatistics', 'ChangeRate' => 'ChangeRate'], + 'example' => 'Diagnosis Type', ], 'required' => false, + 'enumValueTitles' => [], ], ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => ['description' => '页码。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1'], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => ['description' => '页大小。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10'], + ], + [ + 'name' => 'InstanceId', + 'in' => 'query', + 'schema' => ['description' => '实例ID。', 'type' => 'string', 'required' => true, 'example' => 'pairec-test1'], + ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', - 'description' => 'Schema of Response', + 'description' => '返回数据', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'Id of the request', - 'type' => 'string', - 'example' => '3AAA45F6-0798-5461-9360-81D133823CE7', - ], - 'ExperimentId' => [ - 'title' => '实验ID。', - 'description' => '实验ID。', - 'type' => 'string', - 'example' => '3', + 'RequestId' => ['title' => 'Id of the request', 'description' => '请求ID。'."\n", 'type' => 'string', 'example' => '728C5E01-ABF6-5AA8-B9FC-B3BA05DECC77'], + 'TotalCount' => ['description' => '列表内元素总数。'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '20'], + 'DataDiagnoses' => [ + 'description' => '数据诊断列表。'."\n", + 'type' => 'array', + 'items' => [ + 'description' => '数据诊断详情。', + 'type' => 'object', + 'properties' => [ + 'DataDiagnosisId' => ['description' => '数据诊断ID。'."\n", 'type' => 'string', 'example' => '3'], + 'Name' => ['description' => '数据诊断名称。'."\n", 'type' => 'string', 'example' => 'data_diagnosis_job1'], + 'Type' => ['description' => '数据诊断类型。'."\n" + .'- `ChangeRate`：物品/用户变化率分析'."\n" + .'- `PreferenceStatisticsCycle`：用户偏好统计周期分析'."\n" + .'- `JoinTables`：两表关联分析'."\n" + .'- `BaseStatistics`：基础统计分析'."\n" + .'- `AbnormalBehavior`：异常行为分析'."\n", 'type' => 'string', 'example' => 'ChangeRate'], + 'TableMetaId' => ['description' => '数据表ID。'."\n", 'type' => 'string', 'example' => '3'], + 'TableMetaName' => ['description' => '数据表名称。'."\n", 'type' => 'string', 'example' => 'table_meta_1'], + 'LeftTableMetaId' => ['description' => '左数据表ID。'."\n", 'type' => 'string', 'example' => '4'], + 'RightTableMetaId' => ['description' => '右数据表ID。'."\n", 'type' => 'string', 'example' => '5'], + 'PartitionField' => ['description' => '分区字段。'."\n", 'type' => 'string', 'example' => 'dt'], + 'LeftTablePartitionField' => ['description' => '左表分区字段。'."\n", 'type' => 'string', 'example' => 'dt'], + 'RightTablePartitionField' => ['description' => '右表分区字段。'."\n", 'type' => 'string', 'example' => 'dt'], + 'Config' => ['description' => '数据诊断任务配置内容。若Type=ChangeRate，则需包含：分析字段（AnalysisField）、分区字段格式（PartitionFieldFormat）。若Type=PreferenceStatisticsCycle，则需包含：用户ID字段（UserIdField）、单日留存率统计周期（RemainDays）、曾现率统计周期（EverAppearedDays）、周期留存率统计周期（RemainRatePeriods）、分区字段格式（PartitionFieldFormat）。若Type=JoinTables，则需包含左表分析字段（LeftTableAnalysisField)、右表分析字段（RightTableAnalysisField)、左表JOIN字段（LeftJoinField）、右表JOIN字段（RightJoinField）、展示用抽样数量（SampleQuantity）、左表分区字段格式（LeftTablePartitionFieldFormat）、右表分区字段格式（RightTablePartitionFieldFormat）。若Type=BaseStatistics，则需包含：Tag字段（TagField）、Tag字段分隔符(TagFieldSeparator)、kv字段(KVField)、kv字段分隔符(KVFieldSeparator)、kv对分隔符(KVPairSeparator)、Text字段（TextField）、数据百分位分布（Quantiles）、字符串类型默认值（DefaultValueOfString）、字符串类型空值字段（NullStringField）、分区字段格式（PartitionFieldFormat）。若Type=AbnormalBehavior，则需包含：用户ID字段（UserId）、物品ID字段（ItemId）、行为字段(EventField)、上游行为取值(UpStreamBehavior)、下游行为取值(DownstreamBehavior)、分桶数量(NumericHistogramBins)、分区字段格式（PartitionFieldFormat）。'."\n", 'type' => 'string', 'example' => '{"AnalysisField": "userid","PartitionFieldFormat": "yyyymmdd"}'], + 'CycleTime' => ['description' => '周期运行时间（若该字段为空，则不进行周期运行）。'."\n", 'type' => 'string', 'example' => '08:00'], + 'TopNQuantity' => ['description' => 'topN数量。'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '10'], + 'GmtCreateTime' => ['description' => '创建时间。'."\n", 'type' => 'string', 'example' => '2021-12-15T23:24:33.132+08:00'], + 'GmtModifiedTime' => ['description' => '更新时间。'."\n", 'type' => 'string', 'example' => '2021-12-15T23:24:33.132+08:00'], + ], + ], ], ], ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"3AAA45F6-0798-5461-9360-81D133823CE7\\",\\n \\"ExperimentId\\": \\"3\\"\\n}","type":"json"}]', - 'title' => '创建实验', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '获取数据诊断列表', + 'summary' => '查询指定实例下的数据诊断任务列表。', + 'description' => '## 请求说明'."\n" + .'通过此API，您可以根据给定的实例ID和其他可选参数（如数据诊断类型、页码和每页大小）来获取数据诊断任务的列表。请注意，`InstanceId`是必填项，而其他参数则为可选项，用于进一步筛选或分页展示结果。'."\n" + ."\n" + .'- **Types** 参数支持多种数据诊断类型的组合选择，允许您同时查看不同类型的数据诊断报告。'."\n" + .'- 如果需要对返回的结果进行分页处理，请使用 `PageNumber` 和 `PageSize` 参数。'."\n", + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"728C5E01-ABF6-5AA8-B9FC-B3BA05DECC77\\",\\n \\"TotalCount\\": 20,\\n \\"DataDiagnoses\\": [\\n {\\n \\"DataDiagnosisId\\": \\"3\\",\\n \\"Name\\": \\"data_diagnosis_job1\\",\\n \\"Type\\": \\"ChangeRate\\",\\n \\"TableMetaId\\": \\"3\\",\\n \\"TableMetaName\\": \\"table_meta_1\\",\\n \\"LeftTableMetaId\\": \\"4\\",\\n \\"RightTableMetaId\\": \\"5\\",\\n \\"PartitionField\\": \\"dt\\",\\n \\"LeftTablePartitionField\\": \\"dt\\",\\n \\"RightTablePartitionField\\": \\"dt\\",\\n \\"Config\\": \\"{\\\\\\"AnalysisField\\\\\\": \\\\\\"userid\\\\\\",\\\\\\"PartitionFieldFormat\\\\\\": \\\\\\"yyyymmdd\\\\\\"}\\",\\n \\"CycleTime\\": \\"08:00\\",\\n \\"TopNQuantity\\": 10,\\n \\"GmtCreateTime\\": \\"2021-12-15T23:24:33.132+08:00\\",\\n \\"GmtModifiedTime\\": \\"2021-12-15T23:24:33.132+08:00\\"\\n }\\n ]\\n}","type":"json"}]', ], - 'DeleteExperiment' => [ - 'summary' => '删除指定实验。', - 'path' => '/api/v1/experiments/{ExperimentId}', - 'methods' => [ - 'delete', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'ListDataDiagnosisJobs' => [ + 'summary' => '查询指定实例下的数据诊断任务及其状态。', + 'path' => '/api/v1/datadiagnosisjobs', + 'methods' => ['get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'delete', + 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATURElearnN0NAWV', - ], + 'abilityTreeNodes' => ['FEATURElearnN0NAWV'], ], 'parameters' => [ [ - 'name' => 'ExperimentId', - 'in' => 'path', - 'schema' => [ - 'title' => '实验ID。', - 'description' => '实验ID，可通过接口ListExperiments获取。', - 'type' => 'string', - 'required' => true, - 'example' => '3', - ], + 'name' => 'InstanceId', + 'in' => 'query', + 'schema' => ['description' => '实例ID。', 'type' => 'string', 'required' => true, 'example' => 'pairec-test1'], ], [ - 'name' => 'InstanceId', + 'name' => 'Status', + 'in' => 'query', + 'schema' => ['description' => '任务状态。 '."\n" + ."\n" + .'- Initializing：初始化中。'."\n" + ."\n" + .'- Running：运行中。'."\n" + ."\n" + .'- Success：成功。'."\n" + ."\n" + .'- Failure：失败。', 'type' => 'string', 'required' => false, 'example' => 'Initializing'], + ], + [ + 'name' => 'PageNumber', 'in' => 'query', + 'schema' => ['description' => '页码。', 'type' => 'string', 'required' => false, 'example' => '1'], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => ['description' => '页大小。', 'type' => 'string', 'required' => false, 'example' => '10'], + ], + [ + 'name' => 'Types', + 'in' => 'query', + 'style' => 'simple', 'schema' => [ - 'title' => '实例ID。', - 'description' => '实例ID，可通过接口ListInstances获取。', - 'type' => 'string', - 'required' => true, - 'example' => 'pairec-cn-abcdefg1234', + 'description' => '数据诊断类型列表。', + 'type' => 'array', + 'items' => ['description' => '- ChangeRate：物品/用户变化率分析。'."\n" + ."\n" + .'- PreferenceStatisticsCycle：用户偏好统计周期分析。'."\n" + ."\n" + .'- JoinTables：两表关联分析。'."\n" + ."\n" + .'- BaseStatistics：基础统计分析。'."\n" + ."\n" + .'- AbnormalBehavior：异常行为分析。', 'type' => 'string', 'required' => false, 'example' => 'ChangeRate'], + 'required' => false, ], ], ], @@ -9393,137 +8891,381 @@ 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'Id of the request', - 'type' => 'string', - 'example' => '2A734D87-2212-5C84-B63A-1AC87CA843D4', + 'RequestId' => ['title' => 'Id of the request', 'description' => '请求ID。'."\n", 'type' => 'string', 'example' => '728C5E01-ABF6-5AA8-B9FC-B3BA05DECC77'], + 'TotalCount' => ['description' => '列表内元素总数。'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '20'], + 'DataDiagnosisJobs' => [ + 'description' => '数据诊断任务列表。', + 'type' => 'array', + 'items' => [ + 'description' => '数据诊断任务详情。', + 'type' => 'object', + 'properties' => [ + 'DataDiagnosisJobId' => ['description' => '数据诊断任务ID。'."\n", 'type' => 'string', 'example' => '3'], + 'DataDiagnosisConfigId' => ['description' => '数据诊断配置ID。'."\n", 'type' => 'string', 'example' => '3'], + 'DataDiagnosisConfigName' => ['description' => '数据诊断配置名称。'."\n", 'type' => 'string', 'example' => '异常行为分析-xxx'], + 'Type' => ['description' => '数据诊断类型。', 'type' => 'string', 'example' => 'ChangeRate'], + 'Status' => ['description' => '任务状态。', 'type' => 'string', 'example' => 'Initializing'], + 'JobSource' => ['description' => '任务来源。'."\n" + ."\n" + .'- Rerun：手动重跑。'."\n" + ."\n" + .'- Cycle：周期生成。'."\n" + ."\n" + .'- ByInitializing：初始化生成。', 'type' => 'string', 'example' => 'Cycle'], + 'Logs' => [ + 'description' => '日志信息列表。', + 'type' => 'array', + 'items' => ['description' => '日志信息详情。', 'type' => 'string', 'example' => '""'], + ], + 'BizDate' => ['description' => '业务时间。'."\n", 'type' => 'string', 'example' => '2023-05-28'], + 'Config' => ['description' => '任务配置。'."\n", 'type' => 'string', 'example' => '{}'], + 'GmtCreateTime' => ['description' => '创建时间。'."\n", 'type' => 'string', 'example' => '2021-12-15T23:24:33.132+08:00'], + 'GmtStartTime' => ['description' => '运行时间。'."\n", 'type' => 'string', 'example' => '2021-12-15T23:24:33.132+08:00'], + ], + ], ], ], ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"2A734D87-2212-5C84-B63A-1AC87CA843D4\\"\\n}","type":"json"}]', - 'title' => '删除实验', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '获取数据诊断任务列表', + 'description' => '## 请求说明'."\n" + .'通过此API，您可以根据提供的参数（如InstanceId, Status等）来获取特定实例下的数据诊断任务列表。支持按任务状态、类型过滤，并可通过分页参数(PageNumber, PageSize)控制返回的数据量。'."\n" + ."\n" + .'- **InstanceId** 是必填项，用于指定要查询的任务所属的实例。'."\n" + .'- 可选参数包括 **Status**, **Types**, **PageNumber**, 和 **PageSize**，允许用户更精确地筛选所需信息。'."\n" + .'- 注意：如果未提供任何过滤条件，则默认返回所有符合条件的数据诊断任务。'."\n", + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"728C5E01-ABF6-5AA8-B9FC-B3BA05DECC77\\",\\n \\"TotalCount\\": 20,\\n \\"DataDiagnosisJobs\\": [\\n {\\n \\"DataDiagnosisJobId\\": \\"3\\",\\n \\"DataDiagnosisConfigId\\": \\"3\\",\\n \\"DataDiagnosisConfigName\\": \\"异常行为分析-xxx\\",\\n \\"Type\\": \\"ChangeRate\\",\\n \\"Status\\": \\"Initializing\\",\\n \\"JobSource\\": \\"Cycle\\",\\n \\"Logs\\": [\\n \\"\\\\\\"\\\\\\"\\"\\n ],\\n \\"BizDate\\": \\"2023-05-28\\",\\n \\"Config\\": \\"{}\\",\\n \\"GmtCreateTime\\": \\"2021-12-15T23:24:33.132+08:00\\",\\n \\"GmtStartTime\\": \\"2021-12-15T23:24:33.132+08:00\\"\\n }\\n ]\\n}","type":"json"}]', ], - 'UpdateExperiment' => [ - 'summary' => '更新指定实验的信息，例如更新实验的名称。', - 'path' => '/api/v1/experiments/{ExperimentId}', - 'methods' => [ - 'put', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'ListDataDiagnosisReports' => [ + 'path' => '/api/v1/datadiagnoses/{DataDiagnosisId}/reports', + 'methods' => ['get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'update', + 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATURElearnN0NAWV', - ], + 'abilityTreeNodes' => ['FEATURElearnN0NAWV'], ], 'parameters' => [ [ - 'name' => 'body', - 'in' => 'body', - 'style' => 'json', + 'name' => 'DataDiagnosisId', + 'in' => 'path', + 'schema' => ['description' => '数据诊断ID。'."\n", 'type' => 'string', 'required' => true, 'example' => '3'], + ], + [ + 'name' => 'InstanceId', + 'in' => 'query', + 'schema' => ['description' => '实例ID。'."\n", 'type' => 'string', 'required' => true, 'example' => 'pairec-test1'], + ], + [ + 'name' => 'StartDate', + 'in' => 'query', + 'schema' => ['description' => '开始日期。'."\n", 'type' => 'string', 'required' => true, 'example' => '2022-01-01'], + ], + [ + 'name' => 'EndDate', + 'in' => 'query', + 'schema' => ['description' => '结束日期。'."\n", 'type' => 'string', 'required' => true, 'example' => '2022-02-01'], + ], + [ + 'name' => 'FeatureName', + 'in' => 'query', + 'schema' => ['description' => '特征名称。'."\n", 'type' => 'string', 'required' => false, 'example' => 'feature1'], + ], + [ + 'name' => 'TopN', + 'in' => 'query', + 'schema' => ['description' => '结果截取数量。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '3'], + ], + [ + 'name' => 'RemainRateType', + 'in' => 'query', + 'schema' => ['description' => '留存率报表类型。'."\n" + ."\n" + .'- Period-周期报表。', 'type' => 'string', 'required' => false, 'example' => 'Period'], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => '请求body。', + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'InstanceId' => [ - 'title' => '实例ID。', - 'description' => '实例ID，可通过接口ListInstances获取。', - 'type' => 'string', - 'required' => true, - 'example' => 'pairec-cn-abcdefg1234', - ], - 'Name' => [ - 'title' => '实验名称。', - 'description' => '实验名称。', - 'type' => 'string', - 'required' => true, - 'example' => 'experiment_test', - ], - 'Description' => [ - 'title' => '实验描述。', - 'description' => '实验描述。', - 'type' => 'string', - 'required' => true, - 'example' => 'This is a test.', + 'RequestId' => ['title' => 'Id of the request', 'description' => '请求ID。'."\n", 'type' => 'string', 'example' => '728C5E01-ABF6-5AA8-B9FC-B3BA05DECC77'], + 'Type' => ['description' => '数据诊断任务类型。'."\n" + ."\n" + .'- ChangeRate：物品/用户变化率分析。'."\n" + ."\n" + .'- PreferenceStatisticsCycle：用户偏好统计周期分析。'."\n" + ."\n" + .'- JoinTables：两表关联分析。'."\n" + ."\n" + .'- BaseStatistics：基础统计分析。'."\n" + ."\n" + .'- AbnormalBehavior：异常行为分析。', 'type' => 'string', 'example' => 'ChangeRate'], + 'ReportsOfChangeRateData' => [ + 'description' => '物品/用户变化率类型数据诊断任务的报告列表。', + 'type' => 'array', + 'items' => [ + 'description' => '数据列表。', + 'type' => 'array', + 'items' => [ + 'description' => '数据详情。', + 'type' => 'object', + 'properties' => [ + 'Ds' => ['description' => '日期。'."\n", 'type' => 'string', 'example' => '20230509'], + 'Flag' => ['description' => '报告标志。'."\n", 'type' => 'string', 'example' => 'add'], + 'ChangeCount' => ['description' => '物品/用户变化数。'."\n", 'type' => 'string', 'example' => '1231'], + 'ChangeRate' => ['description' => '物品/用户变化率。'."\n", 'type' => 'string', 'example' => '0.1231'], + ], + ], + ], ], - 'Type' => [ - 'title' => '实验类型。'."\n" - .'● Baseline-基准实验。'."\n" - .'● Normal-普通实验。', - 'description' => '实验类型。'."\n" - .'● Baseline-基准实验。'."\n" - .'● Normal-普通实验。', - 'type' => 'string', - 'required' => true, - 'example' => 'Baseline', + 'ReportsOfPreferenceStatisticsCycle' => [ + 'description' => '用户偏好统计周期分析类型数据诊断任务的报告列表。', + 'type' => 'array', + 'items' => [ + 'description' => '数据列表。', + 'type' => 'array', + 'items' => [ + 'description' => '数据详情。', + 'type' => 'object', + 'properties' => [ + 'CycleRemainRate' => ['description' => '用户周期留存率。'."\n", 'type' => 'string', 'example' => '0.73'], + 'SingleRemainRate' => ['description' => '用户单日留存率。'."\n", 'type' => 'string', 'example' => '0.52'], + 'Ds' => ['description' => '日期。'."\n", 'type' => 'string', 'example' => '20230509'], + 'Days' => ['description' => 'k日留存率/曾现率的k。'."\n", 'type' => 'string', 'example' => '7'], + 'EverAppearedRate' => ['description' => 'k日曾现率。', 'type' => 'string', 'example' => '0.67'], + 'Period' => ['description' => '周期留存率的统计周期。', 'type' => 'string', 'example' => 'week'], + 'PeriodRemainRate' => ['description' => '周期留存率。', 'type' => 'string', 'example' => '0.33'], + 'PeriodRemainCount' => ['description' => '周期留存数量。', 'type' => 'integer', 'format' => 'int64', 'example' => '1'], + 'PeriodInternal' => ['description' => '周期间隔数量。', 'type' => 'integer', 'format' => 'int64', 'example' => '1'], + ], + ], + ], ], - 'FlowPercent' => [ - 'title' => '流量分配百分比。', - 'description' => '流量分配百分比。', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '100', + 'ReportsOfJoinTables' => [ + 'description' => '两表关联分析类型数据诊断任务的报告列表。', + 'type' => 'array', + 'items' => [ + 'description' => '数据列表。', + 'type' => 'array', + 'items' => [ + 'description' => '数据详情。', + 'type' => 'object', + 'properties' => [ + 'Ds' => ['description' => '日期。'."\n", 'type' => 'string', 'example' => '20230509'], + 'JoinField' => ['description' => '关联字段。'."\n", 'type' => 'string', 'example' => 'user_id'], + 'LeftExceptRate' => ['description' => '左表关联异常率。'."\n", 'type' => 'string', 'example' => '0.53'], + 'RightExceptRate' => ['description' => '右表关联异常率。'."\n", 'type' => 'string', 'example' => '0.0'], + 'Flag' => ['description' => '报告标志。'."\n", 'type' => 'string', 'example' => 'add'], + 'FeatureName' => ['description' => '特征名称。'."\n", 'type' => 'string', 'example' => 'register_time'], + 'FeatureValue' => ['description' => '特征值。'."\n", 'type' => 'string', 'example' => '1683562246'], + 'Percent' => ['description' => '特征所占百分比。'."\n", 'type' => 'string', 'example' => '1'], + 'Quantile' => ['description' => '分位数。'."\n", 'type' => 'string', 'example' => '1'], + 'ValueCount' => ['description' => '取值计数。'."\n", 'type' => 'string', 'example' => '1'], + 'ValuePercent' => ['description' => '取值百分比。', 'type' => 'string', 'example' => '0.019996000799'], + 'ValueQuantile' => ['description' => '取值百分位数。', 'type' => 'string', 'example' => '0.72616'], + ], + ], + ], ], - 'DebugUsers' => [ - 'title' => '调试用户。', - 'description' => '调试用户（需为阿里云账户主账号/子账号uid），多个用户需通过逗号作间隔。', - 'type' => 'string', - 'required' => false, - 'example' => '1124512470******,1124512471******,1124512472******', + 'ReportsOfBaseStatistics' => [ + 'description' => '基础统计分析类型数据诊断任务的报告列表。', + 'type' => 'array', + 'items' => [ + 'description' => '数据列表。', + 'type' => 'array', + 'items' => [ + 'description' => '数据详情。', + 'type' => 'object', + 'properties' => [ + 'DefaultNullCount' => ['description' => '同等空值数。', 'type' => 'string', 'example' => '\\\\N'], + 'DefaultNullRate' => ['description' => '同等空值率。'."\n", 'type' => 'string', 'example' => '\\\\N'], + 'Ds' => ['description' => '日期。'."\n", 'type' => 'string', 'example' => '20230509'], + 'FeatureName' => ['description' => '特征名称。'."\n", 'type' => 'string', 'example' => 'register_time'], + 'FeatureType' => ['description' => '特征类型。'."\n", 'type' => 'string', 'example' => 'string'], + 'NullCount' => ['description' => '空值数。'."\n", 'type' => 'string', 'example' => '55095'], + 'NullRate' => ['description' => '空值率。'."\n", 'type' => 'string', 'example' => '0.5580879448141732'], + 'TotalCount' => ['description' => '数据总个数。'."\n", 'type' => 'string', 'example' => '98721'], + 'UniqueCount' => ['description' => '取值个数。'."\n", 'type' => 'string', 'example' => '29'], + 'ValueMax' => ['description' => '对字段取值的最大值。'."\n", 'type' => 'string', 'example' => '52.0'], + 'ValueMedian' => ['description' => '对字段取值的中位数。'."\n", 'type' => 'string', 'example' => '35.0'], + 'ValueMin' => ['description' => '对字段取值的最小值。'."\n", 'type' => 'string', 'example' => '18.0'], + 'ValueQuantile1' => ['description' => '对字段取值的1%分位数。', 'type' => 'string', 'example' => '18.0'], + 'ValueQuantile5' => ['description' => '对字段取值的 5%分位数。', 'type' => 'string', 'example' => '18.0'], + 'ValueQuantile25' => ['description' => '对字段取值的 25%分位数。', 'type' => 'string', 'example' => '18.0'], + 'ValueQuantile75' => ['description' => '对字段取值的 75%分位数。', 'type' => 'string', 'example' => '18.0'], + 'ValueQuantile95' => ['description' => '对字段取值的 95%分位数。', 'type' => 'string', 'example' => '18.0'], + 'ValueQuantile99' => ['description' => '对字段取值的 99%分位数。', 'type' => 'string', 'example' => '18.0'], + 'Rn' => ['description' => '排名第次。'."\n", 'type' => 'string', 'example' => '3'], + 'FrequencyMax' => ['description' => '对字段取值频数的最大值。'."\n", 'type' => 'string', 'example' => '91149.0'], + 'FrequencyMedian' => ['description' => '对字段取值频数的中位数。'."\n", 'type' => 'string', 'example' => '1349.0'], + 'FrequencyMin' => ['description' => '对字段取值频数的最小值。'."\n", 'type' => 'string', 'example' => '289.0'], + 'FrequencyQuantile1' => ['description' => '对字段取值频数的1%分位数。'."\n", 'type' => 'string', 'example' => '289.0'], + 'FrequencyQuantile5' => ['description' => '对字段取值频数的5%分位数。', 'type' => 'string', 'example' => '289.0'], + 'FrequencyQuantile25' => ['description' => '对字段取值频数的25%分位数。', 'type' => 'string', 'example' => '289.0'], + 'FrequencyQuantile75' => ['description' => '对字段取值频数的75%分位数。', 'type' => 'string', 'example' => '289.0'], + 'FrequencyQuantile95' => ['description' => '对字段取值频数的95%分位数。', 'type' => 'string', 'example' => '289.0'."\n"], + 'FrequencyQuantile99' => ['description' => '对字段取值频数的99%分位数。', 'type' => 'string', 'example' => '289.0'], + 'Distribution' => ['description' => '特征分布。'."\n", 'type' => 'string', 'example' => '{678.8225: 91, 5270.4675: 95}'], + 'RankId' => ['description' => '统计指标排名。'."\n", 'type' => 'string', 'example' => '1'], + 'FeatureValue' => ['description' => '特征值。'."\n", 'type' => 'string', 'example' => '1683562246'], + 'ValueCount' => ['description' => '取值计数。'."\n", 'type' => 'string', 'example' => '1'], + 'ValuePercent' => ['description' => '取值百分比。'."\n", 'type' => 'string', 'example' => '0.000019996000799840032'], + 'ValueQuantile' => ['description' => '取值百分位数。'."\n", 'type' => 'string', 'example' => '0.7261657444926671'], + 'FeatureFrequency' => ['description' => '特征取值频数。'."\n", 'type' => 'string', 'example' => '427'], + 'FrequencyCount' => ['description' => '特征取值频数的计数。'."\n", 'type' => 'string', 'example' => '1'], + 'FrequencyPercent' => ['description' => '特征取值频数的百分比。'."\n", 'type' => 'string', 'example' => '0.5'], + 'FrequencyQuantile' => ['description' => '对字段取值频数的百分位数。'."\n", 'type' => 'string', 'example' => '5'], + ], + ], + ], ], - 'DebugCrowdId' => [ - 'title' => '调试人群ID。', - 'description' => '调试人群ID，可通过接口ListCrowds获取。', - 'type' => 'string', - 'required' => false, - 'example' => '3', + 'ReportsOfAbnormalBehavior' => [ + 'description' => '异常行为分析类型数据诊断任务的报告列表。', + 'type' => 'array', + 'items' => [ + 'description' => '数据列表。', + 'type' => 'array', + 'items' => [ + 'description' => '数据详情。', + 'type' => 'object', + 'properties' => [ + 'Ds' => ['description' => '日期。'."\n", 'type' => 'string', 'example' => '20250114'], + 'RankId' => ['description' => '统计指标排名。'."\n", 'type' => 'string', 'example' => '1'], + 'ConversionRate' => ['description' => '上游行为到下游行为转化率。'."\n", 'type' => 'string', 'example' => '1.0'], + 'ConversionRateIds' => ['description' => '对应统计粒度的ID。'."\n", 'type' => 'string', 'example' => '100010050+259203779'], + 'DownStreamCount' => ['description' => '下游行为。'."\n", 'type' => 'string', 'example' => '2.0'], + 'DownStreamCountIds' => ['description' => '下游行为对应统计粒度的ID。'."\n", 'type' => 'string', 'example' => '189814043+272292277'], + 'Granularity' => ['description' => '统计粒度。'."\n", 'type' => 'string', 'example' => 'pair'], + 'UpStreamCount' => ['description' => '上游行为。'."\n", 'type' => 'string', 'example' => '2.0'], + 'UpStreamCountIds' => ['description' => '上游行为对应统计粒度的ID。'."\n", 'type' => 'string', 'example' => '104684044+249445882'], + 'Distribution' => ['description' => '特征分布。'."\n", 'type' => 'string', 'example' => '{678.8225: 91, 5270.4675: 95}'], + 'IndicatorName' => ['description' => '统计指标名称。'."\n", 'type' => 'string', 'example' => 'conversion_rate'], + 'ExceptionRate' => ['description' => '异常率。'."\n", 'type' => 'string', 'example' => '0.0'], + ], + ], + ], ], - 'Config' => [ - 'title' => '实验配置。', - 'description' => '实验配置。', - 'type' => 'string', - 'required' => false, - 'example' => '{"RankBy": "Score"}', + 'ExceptionRate' => [ + 'description' => '异常报告列表。', + 'type' => 'array', + 'items' => [ + 'description' => '异常信息详情。', + 'type' => 'object', + 'properties' => [ + 'Group' => ['description' => '异常组别。'."\n", 'type' => 'string', 'example' => 'add'], + 'Message' => ['description' => '异常信息。'."\n", 'type' => 'string', 'example' => 'change_rate 大于 0.2，请确认是否正常'], + 'Type' => ['description' => '异常类型/级别。'."\n", 'type' => 'string', 'example' => 'WARN'], + ], + ], ], ], - 'required' => false, ], ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '获取数据诊断报告', + 'summary' => '通过指定参数获取特定时间段内的数据诊断报告。', + 'description' => '## 请求说明'."\n" + .'- 本API用于根据给定的数据诊断ID、实例ID以及日期范围等参数，获取相应的数据诊断报告。'."\n" + .'- 用户可以通过设置`FeatureName`来过滤特定特征的报告，并使用`TopN`参数限制返回结果的数量。'."\n" + .'- `RemainRateType`允许用户选择留存率报表的具体类型，如周期性报表。'."\n" + .'- 报告内容包括但不限于物品/用户变化率分析、用户偏好统计周期分析、两表关联分析、基础统计分析及异常行为分析等。'."\n" + .'- 特别注意：所有日期格式应遵循`YYYY-MM-DD`标准。'."\n", + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"728C5E01-ABF6-5AA8-B9FC-B3BA05DECC77\\",\\n \\"Type\\": \\"ChangeRate\\",\\n \\"ReportsOfChangeRateData\\": [\\n [\\n {\\n \\"Ds\\": \\"20230509\\",\\n \\"Flag\\": \\"add\\",\\n \\"ChangeCount\\": \\"1231\\",\\n \\"ChangeRate\\": \\"0.1231\\"\\n }\\n ]\\n ],\\n \\"ReportsOfPreferenceStatisticsCycle\\": [\\n [\\n {\\n \\"CycleRemainRate\\": \\"0.73\\",\\n \\"SingleRemainRate\\": \\"0.52\\",\\n \\"Ds\\": \\"20230509\\",\\n \\"Days\\": \\"7\\",\\n \\"EverAppearedRate\\": \\"0.67\\",\\n \\"Period\\": \\"week\\",\\n \\"PeriodRemainRate\\": \\"0.33\\",\\n \\"PeriodRemainCount\\": 1,\\n \\"PeriodInternal\\": 1\\n }\\n ]\\n ],\\n \\"ReportsOfJoinTables\\": [\\n [\\n {\\n \\"Ds\\": \\"20230509\\",\\n \\"JoinField\\": \\"user_id\\",\\n \\"LeftExceptRate\\": \\"0.53\\",\\n \\"RightExceptRate\\": \\"0.0\\",\\n \\"Flag\\": \\"add\\",\\n \\"FeatureName\\": \\"register_time\\",\\n \\"FeatureValue\\": \\"1683562246\\",\\n \\"Percent\\": \\"1\\",\\n \\"Quantile\\": \\"1\\",\\n \\"ValueCount\\": \\"1\\",\\n \\"ValuePercent\\": \\"0.019996000799\\",\\n \\"ValueQuantile\\": \\"0.72616\\"\\n }\\n ]\\n ],\\n \\"ReportsOfBaseStatistics\\": [\\n [\\n {\\n \\"DefaultNullCount\\": \\"\\\\\\\\\\\\\\\\N\\",\\n \\"DefaultNullRate\\": \\"\\\\\\\\\\\\\\\\N\\",\\n \\"Ds\\": \\"20230509\\",\\n \\"FeatureName\\": \\"register_time\\",\\n \\"FeatureType\\": \\"string\\",\\n \\"NullCount\\": \\"55095\\",\\n \\"NullRate\\": \\"0.5580879448141732\\",\\n \\"TotalCount\\": \\"98721\\",\\n \\"UniqueCount\\": \\"29\\",\\n \\"ValueMax\\": \\"52.0\\",\\n \\"ValueMedian\\": \\"35.0\\",\\n \\"ValueMin\\": \\"18.0\\",\\n \\"ValueQuantile1\\": \\"18.0\\",\\n \\"ValueQuantile5\\": \\"18.0\\",\\n \\"ValueQuantile25\\": \\"18.0\\",\\n \\"ValueQuantile75\\": \\"18.0\\",\\n \\"ValueQuantile95\\": \\"18.0\\",\\n \\"ValueQuantile99\\": \\"18.0\\",\\n \\"Rn\\": \\"3\\",\\n \\"FrequencyMax\\": \\"91149.0\\",\\n \\"FrequencyMedian\\": \\"1349.0\\",\\n \\"FrequencyMin\\": \\"289.0\\",\\n \\"FrequencyQuantile1\\": \\"289.0\\",\\n \\"FrequencyQuantile5\\": \\"289.0\\",\\n \\"FrequencyQuantile25\\": \\"289.0\\",\\n \\"FrequencyQuantile75\\": \\"289.0\\",\\n \\"FrequencyQuantile95\\": \\"289.0\\\\n\\",\\n \\"FrequencyQuantile99\\": \\"289.0\\",\\n \\"Distribution\\": \\"{678.8225: 91, 5270.4675: 95}\\",\\n \\"RankId\\": \\"1\\",\\n \\"FeatureValue\\": \\"1683562246\\",\\n \\"ValueCount\\": \\"1\\",\\n \\"ValuePercent\\": \\"0.000019996000799840032\\",\\n \\"ValueQuantile\\": \\"0.7261657444926671\\",\\n \\"FeatureFrequency\\": \\"427\\",\\n \\"FrequencyCount\\": \\"1\\",\\n \\"FrequencyPercent\\": \\"0.5\\",\\n \\"FrequencyQuantile\\": \\"5\\"\\n }\\n ]\\n ],\\n \\"ReportsOfAbnormalBehavior\\": [\\n [\\n {\\n \\"Ds\\": \\"20250114\\",\\n \\"RankId\\": \\"1\\",\\n \\"ConversionRate\\": \\"1.0\\",\\n \\"ConversionRateIds\\": \\"100010050+259203779\\",\\n \\"DownStreamCount\\": \\"2.0\\",\\n \\"DownStreamCountIds\\": \\"189814043+272292277\\",\\n \\"Granularity\\": \\"pair\\",\\n \\"UpStreamCount\\": \\"2.0\\",\\n \\"UpStreamCountIds\\": \\"104684044+249445882\\",\\n \\"Distribution\\": \\"{678.8225: 91, 5270.4675: 95}\\",\\n \\"IndicatorName\\": \\"conversion_rate\\",\\n \\"ExceptionRate\\": \\"0.0\\"\\n }\\n ]\\n ],\\n \\"ExceptionRate\\": [\\n {\\n \\"Group\\": \\"add\\",\\n \\"Message\\": \\"change_rate 大于 0.2，请确认是否正常\\",\\n \\"Type\\": \\"WARN\\"\\n }\\n ]\\n}","type":"json"}]', + ], + 'ListEngineConfigs' => [ + 'summary' => '获取引擎配置列表。', + 'path' => '/api/v1/engineconfigs', + 'methods' => ['get'], + 'schemes' => ['http', 'https'], + 'security' => [ [ - 'name' => 'ExperimentId', - 'in' => 'path', - 'schema' => [ - 'title' => '实验ID。', - 'description' => '实验ID，可通过接口ListExperiments获取。', - 'type' => 'string', - 'required' => true, - 'example' => '3', - ], + 'AK' => [], + ], + ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '180248', + 'abilityTreeNodes' => ['FEATURElearnN0NAWV'], + ], + 'parameters' => [ + [ + 'name' => 'Environment', + 'in' => 'query', + 'schema' => ['description' => '运行环境。'."\n" + ."\n" + .'- Daily：日常环境。'."\n" + ."\n" + .'- Pre：预发环境。'."\n" + ."\n" + .'- Prod：生产环境。', 'type' => 'string', 'required' => false, 'example' => 'Pre'], + ], + [ + 'name' => 'Status', + 'in' => 'query', + 'schema' => ['description' => '状态过滤。'."\n" + ."\n" + .'- Released：已发布。'."\n" + ."\n" + .'- Unreleased：未发布。', 'type' => 'string', 'required' => false, 'example' => 'Released'], + ], + [ + 'name' => 'Name', + 'in' => 'query', + 'schema' => ['description' => '引擎配置名称。', 'type' => 'string', 'required' => false, 'example' => 'engine_config_v1'], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => ['description' => '页码。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1'], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => ['description' => '分页的大小。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10'], + ], + [ + 'name' => 'Version', + 'in' => 'query', + 'schema' => ['description' => '版本过滤。'."\n" + ."\n" + .'latest：最近一次更新的版本。', 'type' => 'string', 'required' => false, 'example' => 'latest'], + ], + [ + 'name' => 'InstanceId', + 'in' => 'query', + 'schema' => ['description' => '实例ID，可通过接口[ListInstances](~~2411819~~)获取。', 'type' => 'string', 'required' => true, 'example' => 'pairec-cn-***test'], ], ], 'responses' => [ @@ -9533,75 +9275,117 @@ 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'Id of the request', - 'type' => 'string', - 'example' => 'A760D972-1475-58C0-BBB3-92B5FB08904F', + 'RequestId' => ['title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => '74D958EF-3598-56FA-8296-FF1575CE43DF'], + 'TotalCount' => ['description' => '列表内元素总数。', 'type' => 'integer', 'format' => 'int64', 'example' => '10'], + 'EngineConfigs' => [ + 'description' => '引擎配置列表。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'EngineConfigId' => ['description' => '引擎配置Id。', 'type' => 'string', 'example' => '2'], + 'Name' => ['description' => '引擎配置名称。', 'type' => 'string', 'example' => 'engine_config_v1'], + 'ConfigValue' => ['description' => '引擎配置的内容。', 'type' => 'string', 'example' => '{}'], + 'Environment' => ['description' => '运行环境。'."\n" + ."\n" + .'- Daily：日常环境。'."\n" + ."\n" + .'- Pre：预发环境。'."\n" + ."\n" + .'- Prod：生产环境。', 'type' => 'string', 'example' => 'Pre'], + 'Version' => ['description' => '当前发布的/最近更新的版本对应的版本号。', 'type' => 'string', 'example' => '20230509161300'], + 'Status' => ['description' => '状态。'."\n" + ."\n" + .'- Released：已发布。'."\n" + ."\n" + .'- UnReleased：未发布。', 'type' => 'string', 'example' => 'Released'], + 'GmtCreateTime' => ['description' => '创建时间。', 'type' => 'string', 'example' => '2023-08-07T01:43:42Z'], + 'GmtModifiedTime' => ['description' => '更新时间。', 'type' => 'string', 'example' => '2023-08-27T12:00:00Z'], + 'GmtReleasedTime' => ['description' => '发布时间。', 'type' => 'string', 'example' => '2023-08-29 12:00:00'], + 'Description' => ['type' => 'string', 'description' => ''], + ], + 'description' => '', + ], ], ], ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"74D958EF-3598-56FA-8296-FF1575CE43DF\\",\\n \\"TotalCount\\": 10,\\n \\"EngineConfigs\\": [\\n {\\n \\"EngineConfigId\\": \\"2\\",\\n \\"Name\\": \\"engine_config_v1\\",\\n \\"ConfigValue\\": \\"{}\\",\\n \\"Environment\\": \\"Pre\\",\\n \\"Version\\": \\"20230509161300\\",\\n \\"Status\\": \\"Released\\",\\n \\"GmtCreateTime\\": \\"2023-08-07T01:43:42Z\\",\\n \\"GmtModifiedTime\\": \\"2023-08-27T12:00:00Z\\",\\n \\"GmtReleasedTime\\": \\"2023-08-29 12:00:00\\",\\n \\"Description\\": \\"\\"\\n }\\n ]\\n}","type":"json"}]', + 'title' => '获取引擎配置列表', + 'changeSet' => [ + ['createdAt' => '2024-12-27T08:56:39.000Z', 'description' => '响应参数发生变更'], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"A760D972-1475-58C0-BBB3-92B5FB08904F\\"\\n}","type":"json"}]', - 'title' => '更新实验', - ], - 'GetExperiment' => [ - 'summary' => '获取指定实验的详细信息。', - 'path' => '/api/v1/experiments/{ExperimentId}', - 'methods' => [ - 'get', + 'flowControl' => [ + 'flowControlList' => [], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'pairec:ListEngineConfigs', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIRecService', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], ], + ], + 'ListExperimentGroups' => [ + 'summary' => '获取实验组列表。', + 'path' => '/api/v1/experimentgroups', + 'methods' => ['get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'get', + 'operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATURElearnN0NAWV', - ], + 'abilityTreeCode' => '183391', + 'abilityTreeNodes' => ['FEATURElearnN0NAWV'], ], 'parameters' => [ [ - 'name' => 'ExperimentId', - 'in' => 'path', - 'schema' => [ - 'title' => '实验ID。', - 'description' => '实验ID，可通过接口ListExperiments获取。', - 'type' => 'string', - 'required' => true, - 'example' => '3', - ], + 'name' => 'LayerId', + 'in' => 'query', + 'schema' => ['title' => '层ID。', 'description' => '层ID，可通过接口ListLayers获取。', 'type' => 'string', 'required' => false, 'example' => '3'], + ], + [ + 'name' => 'Status', + 'in' => 'query', + 'schema' => ['title' => '状态过滤'."\n" + .'● Offline-未上线'."\n" + .'● Online-已上线'."\n" + .'● Pushed-已推全', 'description' => '状态过滤'."\n" + .'● Offline-未上线'."\n" + .'● Online-已上线'."\n" + .'● Pushed-已推全', 'type' => 'string', 'required' => false, 'example' => 'Online'], ], [ 'name' => 'InstanceId', 'in' => 'query', - 'schema' => [ - 'title' => '实例ID。', - 'description' => '实例ID，可通过接口ListInstances获取。', - 'type' => 'string', - 'required' => true, - 'example' => 'pairec-cn-abcdefg1234', - ], + 'schema' => ['title' => '实例ID。', 'description' => '实例ID，可通过接口ListInstances获取。', 'type' => 'string', 'required' => true, 'example' => 'pairec-cn-abcdefg1234'], + ], + [ + 'name' => 'TimeRangeStart', + 'in' => 'query', + 'schema' => ['description' => '根据开始时间进行实验组过滤。', 'type' => 'string', 'required' => false, 'example' => '2024-08-30 12:00:00'], + ], + [ + 'name' => 'TimeRangeEnd', + 'in' => 'query', + 'schema' => ['description' => '根据结束时间进行实验组过滤。', 'type' => 'string', 'required' => false, 'example' => '2024-08-31 12:00:00'], ], ], 'responses' => [ @@ -9611,207 +9395,126 @@ 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'Id of the request', - 'type' => 'string', - 'example' => '74D958EF-3598-56FA-8296-FF1575CE43DF', - ], - 'AliasExperimentId' => [ - 'title' => '实验ID别名。', - 'description' => '实验ID别名。', - 'type' => 'string', - 'example' => 'L1#EG1#E1', - ], - 'ExperimentGroupId' => [ - 'title' => '实验组ID。', - 'description' => '实验组ID。', - 'type' => 'string', - 'example' => '3', - ], - 'LayerId' => [ - 'title' => '层ID。', - 'description' => '层ID。', - 'type' => 'string', - 'example' => '3', - ], - 'LaboratoryId' => [ - 'title' => '实验室ID。', - 'description' => '实验室ID。', - 'type' => 'string', - 'example' => '3', - ], - 'SceneId' => [ - 'title' => '场景ID。', - 'description' => '场景ID。', - 'type' => 'string', - 'example' => '3', - ], - 'Name' => [ - 'title' => '实验名称。', - 'description' => '实验名称。', - 'type' => 'string', - 'example' => 'experiment_test1', - ], - 'Description' => [ - 'title' => '实验描述。', - 'description' => '实验描述。', - 'type' => 'string', - 'example' => 'This is a test.', - ], - 'Type' => [ - 'title' => '实验类型。'."\n" - .'● Baseline-基准实验。'."\n" - .'● Normal-普通实验。', - 'description' => '实验类型。'."\n" - .'● Baseline-基准实验。'."\n" - .'● Normal-普通实验。', - 'type' => 'string', - 'example' => 'Baseline', - ], - 'FlowPercent' => [ - 'title' => '流量分配百分比。', - 'description' => '流量分配百分比。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '100', - 'default' => '100', - ], - 'Buckets' => [ - 'title' => '分配桶号。', - 'description' => '分配桶号。', - 'type' => 'string', - 'example' => '1,2,3', - ], - 'DebugUsers' => [ - 'title' => '调试用户。', - 'description' => '调试用户（需为阿里云账户主账号/子账号uid），多个用户需通过逗号作间隔。', - 'type' => 'string', - 'example' => '1124512470******,1124512471******,1124512472******', - ], - 'DebugCrowdId' => [ - 'title' => '调试人群ID。', - 'description' => '调试人群ID。', - 'type' => 'string', - 'example' => '3', - ], - 'Config' => [ - 'title' => '实验配置。', - 'description' => '实验配置。', - 'type' => 'string', - 'example' => '{"RankBy": "Score"}', - ], - 'Status' => [ - 'title' => '状态过滤。'."\n" - .'● Offline-未上线'."\n" - .'● Online-已上线', - 'description' => '状态过滤。'."\n" - .'● Offline-未上线'."\n" - .'● Online-已上线', - 'type' => 'string', - 'example' => 'Offline', - ], - 'GmtCreateTime' => [ - 'title' => '创建时间。', - 'description' => '创建时间。', - 'type' => 'string', - 'example' => '2021-12-15T23:24:33.132+08:00', - ], - 'GmtModifiedTime' => [ - 'title' => '更新时间。', - 'description' => '更新时间。', - 'type' => 'string', - 'example' => '2021-12-15T23:24:33.132+08:00', + 'RequestId' => ['title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => '59CE7EC6-F268-5D71-9215-32922CC50D72'], + 'TotalCount' => ['title' => '列表内元素总数。', 'description' => '列表内元素总数。', 'type' => 'integer', 'format' => 'int64', 'example' => '10'], + 'ExperimentGroups' => [ + 'title' => '实验组列表。', + 'description' => '实验组列表。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'ExperimentGroupId' => ['title' => '实验组ID。', 'description' => '实验组ID。', 'type' => 'string', 'example' => '3'], + 'LayerId' => ['title' => '层ID。', 'description' => '层ID。', 'type' => 'string', 'example' => '3'], + 'LaboratoryId' => ['title' => '实验室ID。', 'description' => '实验室ID。', 'type' => 'string', 'example' => '4'], + 'SceneId' => ['title' => '场景ID。', 'description' => '场景ID。', 'type' => 'string', 'example' => '1'], + 'Name' => ['title' => '实验组名称。', 'description' => '实验组名称。', 'type' => 'string', 'example' => 'experiment_group1'], + 'Description' => ['title' => '实验组描述。', 'description' => '实验组描述。', 'type' => 'string', 'example' => 'This is a test.'], + 'DebugUsers' => ['title' => '调试用户。', 'description' => '调试用户。', 'type' => 'string', 'example' => '1124512470******,1124512471******,1124512472******'], + 'DebugCrowdId' => ['title' => '调试人群ID。', 'description' => '调试人群ID。', 'type' => 'string', 'example' => '4'], + 'Owner' => ['title' => '创建人。', 'description' => '创建人。', 'type' => 'string', 'example' => '1124512470******'], + 'NeedAA' => ['title' => '是否需要AB实验组。', 'description' => '是否需要AB实验组。', 'type' => 'boolean', 'example' => 'true'], + 'Filter' => ['title' => '过滤条件。', 'description' => '过滤条件。', 'type' => 'string', 'example' => 'gender=female'], + 'DistributionType' => ['title' => '分流方式。'."\n" + .'● UserId-用户ID'."\n" + .'● TimeDuration-时段', 'description' => '分流方式。'."\n" + .'● UserId-用户ID'."\n" + .'● TimeDuration-时段', 'type' => 'string', 'example' => 'UserId'], + 'DistributionTimeDuration' => ['title' => '分流时段。', 'description' => '分流时段。', 'type' => 'integer', 'format' => 'int32', 'example' => '5'], + 'CrowdId' => ['title' => '人群ID。', 'description' => '人群ID。', 'type' => 'string', 'example' => '3'], + 'Config' => ['title' => '实验组配置。', 'description' => '实验组配置。', 'type' => 'string', 'example' => '{}'], + 'ReservedBuckets' => ['title' => '预留桶号。', 'description' => '预留桶号。', 'type' => 'string', 'example' => '1,2,3,4'], + 'Status' => ['title' => '实验组状态。'."\n" + .'● Offline-未上线'."\n" + .'● Online-已上线'."\n" + .'● Pushed-已推全', 'description' => '实验组状态。'."\n" + .'● Offline-未上线'."\n" + .'● Online-已上线'."\n" + .'● Pushed-已推全', 'type' => 'string', 'example' => 'Offline'], + 'CrowdTargetType' => ['description' => '实验组流量定向的类型，可能的取值包括：'."\n" + ."\n" + .'* All 所有的流量'."\n" + .'* Filter 使用过滤条件的流量'."\n" + .'* CrowdId 通过指定人群ID'."\n" + .'* Random 按照百分比随机流量', 'type' => 'string', 'example' => 'All'], + 'RandomFlow' => ['description' => '当实验组流量定向的类型是Random时，使用随机流量匹配这个实验组，可能的取值范围是 0 - 100。', 'type' => 'integer', 'format' => 'int64', 'example' => '20'], + 'HoldingBuckets' => ['description' => '当实验组流量定向的类型是Random时，根据随机流量RandomFlow大小，返回的具体的桶号。', 'type' => 'string', 'example' => '1,2,3,4'], + ], + 'description' => '', + ], ], ], ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '获取实验组列表', + 'changeSet' => [ + ['createdAt' => '2024-06-25T02:52:46.000Z', 'description' => '请求参数发生变更'], + ['createdAt' => '2024-03-20T06:05:19.000Z', 'description' => '请求参数发生变更、响应参数发生变更'], + ], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'pairec:ListExperimentGroups', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIRecService', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"74D958EF-3598-56FA-8296-FF1575CE43DF\\",\\n \\"AliasExperimentId\\": \\"L1#EG1#E1\\",\\n \\"ExperimentGroupId\\": \\"3\\",\\n \\"LayerId\\": \\"3\\",\\n \\"LaboratoryId\\": \\"3\\",\\n \\"SceneId\\": \\"3\\",\\n \\"Name\\": \\"experiment_test1\\",\\n \\"Description\\": \\"This is a test.\\",\\n \\"Type\\": \\"Baseline\\",\\n \\"FlowPercent\\": 100,\\n \\"Buckets\\": \\"1,2,3\\",\\n \\"DebugUsers\\": \\"1124512470******,1124512471******,1124512472******\\",\\n \\"DebugCrowdId\\": \\"3\\",\\n \\"Config\\": \\"{\\\\\\"RankBy\\\\\\": \\\\\\"Score\\\\\\"}\\",\\n \\"Status\\": \\"Offline\\",\\n \\"GmtCreateTime\\": \\"2021-12-15T23:24:33.132+08:00\\",\\n \\"GmtModifiedTime\\": \\"2021-12-15T23:24:33.132+08:00\\"\\n}","type":"json"}]', - 'title' => '获取实验详细信息', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"59CE7EC6-F268-5D71-9215-32922CC50D72\\",\\n \\"TotalCount\\": 10,\\n \\"ExperimentGroups\\": [\\n {\\n \\"ExperimentGroupId\\": \\"3\\",\\n \\"LayerId\\": \\"3\\",\\n \\"LaboratoryId\\": \\"4\\",\\n \\"SceneId\\": \\"1\\",\\n \\"Name\\": \\"experiment_group1\\",\\n \\"Description\\": \\"This is a test.\\",\\n \\"DebugUsers\\": \\"1124512470******,1124512471******,1124512472******\\",\\n \\"DebugCrowdId\\": \\"4\\",\\n \\"Owner\\": \\"1124512470******\\",\\n \\"NeedAA\\": true,\\n \\"Filter\\": \\"gender=female\\",\\n \\"DistributionType\\": \\"UserId\\",\\n \\"DistributionTimeDuration\\": 5,\\n \\"CrowdId\\": \\"3\\",\\n \\"Config\\": \\"{}\\",\\n \\"ReservedBuckets\\": \\"1,2,3,4\\",\\n \\"Status\\": \\"Offline\\",\\n \\"CrowdTargetType\\": \\"All\\",\\n \\"RandomFlow\\": 20,\\n \\"HoldingBuckets\\": \\"1,2,3,4\\"\\n }\\n ]\\n}","type":"json"}]', ], 'ListExperiments' => [ - 'summary' => '获取指定实验组下的实验列表。', 'path' => '/api/v1/experiments', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'methods' => ['get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATURElearnN0NAWV', - ], + 'abilityTreeNodes' => ['FEATURElearnN0NAWV'], ], 'parameters' => [ [ 'name' => 'ExperimentGroupId', 'in' => 'query', - 'schema' => [ - 'description' => '实验组ID。', - 'type' => 'string', - 'required' => false, - 'example' => '3', - ], + 'schema' => ['description' => '实验组ID。', 'type' => 'string', 'required' => false, 'example' => '3'], ], [ 'name' => 'Status', 'in' => 'query', - 'schema' => [ - 'title' => '状态过滤。'."\n" - .'● Offline-未上线'."\n" - .'● Online-已上线', - 'description' => '状态过滤。'."\n" - ."\n" - .'- Offline：未上线'."\n" - .'- Online：已上线', - 'type' => 'string', - 'required' => false, - 'example' => 'Offline', - ], + 'schema' => ['title' => '状态过滤。'."\n" + .'● Offline-未上线'."\n" + .'● Online-已上线', 'description' => '状态过滤。'."\n" + ."\n" + .'- Offline：未上线'."\n" + .'- Online：已上线', 'type' => 'string', 'required' => false, 'example' => 'Offline'], ], [ 'name' => 'InstanceId', 'in' => 'query', - 'schema' => [ - 'title' => '实例ID。', - 'description' => '实例ID，可通过接口ListInstances获取。', - 'type' => 'string', - 'required' => true, - 'example' => 'pairec-cn-abcdefg1234', - ], + 'schema' => ['title' => '实例ID。', 'description' => '实例ID，可通过接口ListInstances获取。', 'type' => 'string', 'required' => true, 'example' => 'pairec-cn-abcdefg1234'], ], [ 'name' => 'Query', 'in' => 'query', - 'schema' => [ - 'title' => '快速查询时的过滤参数。会返回与名称/标签匹配的所有实验。', - 'description' => '快速查询时的过滤参数。会返回与名称/标签匹配的所有实验。', - 'type' => 'string', - 'required' => false, - 'example' => 'experiment_test1', - ], + 'schema' => ['title' => '快速查询时的过滤参数。会返回与名称/标签匹配的所有实验。', 'description' => '快速查询时的过滤参数。会返回与名称/标签匹配的所有实验。', 'type' => 'string', 'required' => false, 'example' => 'experiment_test1'], ], ], 'responses' => [ @@ -9821,18 +9524,8 @@ 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'Id of the request', - 'type' => 'string', - 'example' => '68075085-1A7D-55C2-B51D-7AD9B02A6DD6', - ], - 'TotalCount' => [ - 'description' => '列表内元素总数。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '10', - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => '68075085-1A7D-55C2-B51D-7AD9B02A6DD6'], + 'TotalCount' => ['description' => '列表内元素总数。', 'type' => 'integer', 'format' => 'int64', 'example' => '10'], 'Experiments' => [ 'title' => '实验列表', 'description' => '实验列表。', @@ -9840,194 +9533,117 @@ 'items' => [ 'type' => 'object', 'properties' => [ - 'ExperimentId' => [ - 'title' => '实验ID。', - 'description' => '实验ID。', - 'type' => 'string', - 'example' => '3', - ], - 'AliasExperimentId' => [ - 'title' => '实验ID别名。', - 'description' => '实验ID别名。', - 'type' => 'string', - 'example' => 'L1#EG1#E1', - ], - 'ExperimentGroupId' => [ - 'title' => '实验组ID。', - 'description' => '实验组ID。', - 'type' => 'string', - 'example' => '3', - ], - 'LayerId' => [ - 'title' => '层ID。', - 'description' => '层ID。', - 'type' => 'string', - 'example' => '3', - ], - 'LaboratoryId' => [ - 'title' => '实验室ID。', - 'description' => '实验室ID。', - 'type' => 'string', - 'example' => '3', - ], - 'SceneId' => [ - 'title' => '场景ID。', - 'description' => '场景ID。', - 'type' => 'string', - 'example' => '3', - ], - 'Name' => [ - 'title' => '实验名称。', - 'description' => '实验名称。', - 'type' => 'string', - 'example' => 'experiment_test1', - ], - 'Description' => [ - 'title' => '实验描述。', - 'description' => '实验描述。', - 'type' => 'string', - 'example' => 'This is a test.', - ], - 'Type' => [ - 'title' => '实验类型。'."\n" - .'● Baseline-基准实验。'."\n" - .'● Normal-普通实验。', - 'description' => '实验类型。'."\n" - ."\n" - .'- Baseline：基准实验。'."\n" - .'- Normal：普通实验。', - 'type' => 'string', - 'example' => 'Baseline', - ], - 'FlowPercent' => [ - 'title' => '流量分配百分比。', - 'description' => '流量分配百分比。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '100', - 'default' => '100', - ], - 'Buckets' => [ - 'title' => '分配桶号。', - 'description' => '分配桶号。', - 'type' => 'string', - 'example' => '1,2,3', - ], - 'DebugUsers' => [ - 'title' => '调试用户。', - 'description' => '调试用户。', - 'type' => 'string', - 'example' => 'uid1,uid2,uid3', - ], - 'DebugCrowdId' => [ - 'title' => '调试人群ID。', - 'description' => '调试人群ID。', - 'type' => 'string', - 'example' => '3', - ], - 'Config' => [ - 'title' => '实验配置。', - 'description' => '实验配置。', - 'type' => 'string', - 'example' => '{}', - ], - 'Status' => [ - 'title' => '状态过滤。'."\n" - .'● Offline-未上线'."\n" - .'● Online-已上线', - 'description' => '状态过滤。'."\n" - ."\n" - .'- Offline：未上线'."\n" - .'- Online：已上线', - 'type' => 'string', - 'example' => 'Offline', - ], - 'GmtCreateTime' => [ - 'title' => '创建时间。', - 'description' => '创建时间。', - 'type' => 'string', - 'example' => '2021-12-15T23:24:33.132+08:00', - ], - 'GmtModifiedTime' => [ - 'title' => '更新时间。', - 'description' => '更新时间。', - 'type' => 'string', - 'example' => '2021-12-15T23:24:33.132+08:00', - ], + 'ExperimentId' => ['title' => '实验ID。', 'description' => '实验ID。', 'type' => 'string', 'example' => '3'], + 'AliasExperimentId' => ['title' => '实验ID别名。', 'description' => '实验ID别名。', 'type' => 'string', 'example' => 'L1#EG1#E1'], + 'ExperimentGroupId' => ['title' => '实验组ID。', 'description' => '实验组ID。', 'type' => 'string', 'example' => '3'], + 'LayerId' => ['title' => '层ID。', 'description' => '层ID。', 'type' => 'string', 'example' => '3'], + 'LaboratoryId' => ['title' => '实验室ID。', 'description' => '实验室ID。', 'type' => 'string', 'example' => '3'], + 'SceneId' => ['title' => '场景ID。', 'description' => '场景ID。', 'type' => 'string', 'example' => '3'], + 'Name' => ['title' => '实验名称。', 'description' => '实验名称。', 'type' => 'string', 'example' => 'experiment_test1'], + 'Description' => ['title' => '实验描述。', 'description' => '实验描述。', 'type' => 'string', 'example' => 'This is a test.'], + 'Type' => ['title' => '实验类型。'."\n" + .'● Baseline-基准实验。'."\n" + .'● Normal-普通实验。', 'description' => '实验类型。'."\n" + ."\n" + .'- Baseline：基准实验。'."\n" + .'- Normal：普通实验。', 'type' => 'string', 'example' => 'Baseline'], + 'FlowPercent' => ['title' => '流量分配百分比。', 'description' => '流量分配百分比。', 'type' => 'integer', 'format' => 'int32', 'example' => '100', 'default' => '100'], + 'Buckets' => ['title' => '分配桶号。', 'description' => '分配桶号。', 'type' => 'string', 'example' => '1,2,3'], + 'DebugUsers' => ['title' => '调试用户。', 'description' => '调试用户。', 'type' => 'string', 'example' => 'uid1,uid2,uid3'], + 'DebugCrowdId' => ['title' => '调试人群ID。', 'description' => '调试人群ID。', 'type' => 'string', 'example' => '3'], + 'Config' => ['title' => '实验配置。', 'description' => '实验配置。', 'type' => 'string', 'example' => '{}'], + 'Status' => ['title' => '状态过滤。'."\n" + .'● Offline-未上线'."\n" + .'● Online-已上线', 'description' => '状态过滤。'."\n" + ."\n" + .'- Offline：未上线'."\n" + .'- Online：已上线', 'type' => 'string', 'example' => 'Offline'], + 'GmtCreateTime' => ['title' => '创建时间。', 'description' => '创建时间。', 'type' => 'string', 'example' => '2021-12-15T23:24:33.132+08:00'], + 'GmtModifiedTime' => ['title' => '更新时间。', 'description' => '更新时间。', 'type' => 'string', 'example' => '2021-12-15T23:24:33.132+08:00'], ], + 'description' => '', ], ], ], ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '获取实验列表', + 'summary' => '获取指定实验组下的实验列表。', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'pairec:ListExperiments', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIRecService', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"68075085-1A7D-55C2-B51D-7AD9B02A6DD6\\",\\n \\"TotalCount\\": 10,\\n \\"Experiments\\": [\\n {\\n \\"ExperimentId\\": \\"3\\",\\n \\"AliasExperimentId\\": \\"L1#EG1#E1\\",\\n \\"ExperimentGroupId\\": \\"3\\",\\n \\"LayerId\\": \\"3\\",\\n \\"LaboratoryId\\": \\"3\\",\\n \\"SceneId\\": \\"3\\",\\n \\"Name\\": \\"experiment_test1\\",\\n \\"Description\\": \\"This is a test.\\",\\n \\"Type\\": \\"Baseline\\",\\n \\"FlowPercent\\": 100,\\n \\"Buckets\\": \\"1,2,3\\",\\n \\"DebugUsers\\": \\"uid1,uid2,uid3\\",\\n \\"DebugCrowdId\\": \\"3\\",\\n \\"Config\\": \\"{}\\",\\n \\"Status\\": \\"Offline\\",\\n \\"GmtCreateTime\\": \\"2021-12-15T23:24:33.132+08:00\\",\\n \\"GmtModifiedTime\\": \\"2021-12-15T23:24:33.132+08:00\\"\\n }\\n ]\\n}","type":"json"}]', - 'title' => '获取实验列表', ], - 'CloneExperiment' => [ - 'summary' => '对指定实验进行克隆。', - 'path' => '/api/v1/experiments/{ExperimentId}/action/clone', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'ListFeatureConsistencyCheckJobConfigs' => [ + 'summary' => '获取特征一致性检查任务配置列表。', + 'path' => '/api/v1/featureconsistencycheck/jobconfigs', + 'methods' => ['get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], - 'operationType' => 'readAndWrite', + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'none', + 'operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATURElearnN0NAWV', - ], + 'abilityTreeCode' => '193273', + 'abilityTreeNodes' => ['FEATURElearnN0NAWV'], ], 'parameters' => [ [ - 'name' => 'ExperimentId', - 'in' => 'path', - 'schema' => [ - 'title' => '实验ID。', - 'description' => '实验ID。', - 'type' => 'string', - 'required' => true, - 'example' => 'experiment_test', - ], + 'name' => 'InstanceId', + 'in' => 'query', + 'schema' => ['title' => '实例ID。', 'description' => '实例ID。如何获取实例ID，请参见[ListInstances](~~2411819~~)。', 'type' => 'string', 'required' => true, 'example' => 'pairec-cn-********'], ], [ - 'name' => 'body', - 'in' => 'body', - 'style' => 'json', - 'schema' => [ - 'description' => '请求Body。', - 'type' => 'object', - 'properties' => [ - 'InstanceId' => [ - 'title' => '实例ID。', - 'description' => '实例ID，可通过接口ListInstances获取。', - 'type' => 'string', - 'required' => true, - 'example' => 'pairec-cn-abcdefg1234'."\n", - ], - ], - 'required' => false, - ], + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => ['title' => '页码。', 'description' => '页码。起始值为1，默认值为1。', 'type' => 'string', 'required' => false, 'example' => '1'], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => ['title' => '页大小。', 'description' => '页大小。', 'type' => 'string', 'required' => false, 'example' => '10'], + ], + [ + 'name' => 'SortBy', + 'in' => 'query', + 'schema' => ['title' => '排序依据。'."\n" + .'GmtCreateTime-创建时间。'."\n" + .'GmtModifiedTime-更新时间。', 'description' => '排序依据。'."\n" + .'- GmtCreateTime：按创建时间排序。'."\n" + .'- GmtModifiedTime：按更新时间排序。', 'type' => 'string', 'required' => false, 'example' => 'GmtCreateTime'], + ], + [ + 'name' => 'Order', + 'in' => 'query', + 'schema' => ['title' => '排序方式。'."\n" + .'● ASC-升序。'."\n" + .'● DESC-降序。', 'description' => '排序方式。'."\n" + .'- ASC：升序。'."\n" + .'- DESC：降序。', 'type' => 'string', 'required' => false, 'example' => 'ASC'], ], ], 'responses' => [ @@ -10037,88 +9653,165 @@ 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'Id of the request', - 'type' => 'string', - 'example' => 'F8F613A9-DF1C-551A-88E1-397A3981A785', - ], - 'ExperimentId' => [ - 'description' => '实验ID。', - 'type' => 'string', - 'example' => '3', + 'RequestId' => ['title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => 'FCF741D8-9C30-578E-807F-B935487DB34A'], + 'TotalCount' => ['title' => '总个数。', 'description' => '总个数。', 'type' => 'integer', 'format' => 'int64', 'example' => '10'], + 'FeatureConsistencyCheckConfigs' => [ + 'title' => '特征一致性检查列表。', + 'description' => '特征一致性检查列表。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'FeatureConsistencyCheckJobConfigId' => ['title' => '特征一致性检查配置ID。', 'description' => '特征一致性检查配置ID。', 'type' => 'string', 'example' => '3'], + 'Name' => ['title' => '特征一致性检查配置名称。', 'description' => '特征一致性检查配置名称。', 'type' => 'string', 'example' => 'feature_consistency_check1'], + 'SceneId' => ['title' => '场景ID。', 'description' => '场景ID。', 'type' => 'string', 'example' => '3'], + 'SceneName' => ['title' => '场景名称。', 'description' => '场景名称。', 'type' => 'string', 'example' => 'scene1'], + 'Status' => ['title' => '状态。'."\n" + .'● Editable-可编辑的。'."\n" + .'● Uneditable-不可编辑的。', 'description' => '状态。可能值为：'."\n" + .'- Editable：可编辑的。'."\n" + .'- Uneditable：不可编辑的。', 'type' => 'string', 'example' => 'Editable'], + 'CompareFeature' => ['title' => '是否开启特征比对。', 'description' => '是否开启特征比对。', 'type' => 'boolean', 'example' => 'true'], + 'LatestJobId' => ['title' => '基于该配置最近一次创建的任务ID。', 'description' => '基于该配置最近一次创建的任务ID。', 'type' => 'string', 'example' => '3'], + 'LatestJobGmtSamplingStartTime' => ['title' => '最近一次创建的任务的开始时间。', 'description' => '最近一次创建的任务的开始时间。', 'type' => 'string', 'example' => '2021-12-15T23:24:33.132+08:00'], + 'LatestJobGmtSamplingEndTime' => ['title' => '最近一次创建的任务的结束时间。', 'description' => '最近一次创建的任务的结束时间。', 'type' => 'string', 'example' => '2021-12-15T23:24:33.132+08:00'], + 'SampleRate' => ['title' => '采样比例（0-1）。', 'description' => '采样比例（0-1）。', 'type' => 'string', 'example' => '0.89'], + 'FeatureLandingResourceId' => ['title' => '数据回落数据源ID。', 'description' => '数据回落数据源ID。', 'type' => 'string', 'example' => 'reso-********'], + 'FeatureLandingResourceUri' => ['title' => '数据回落数据源地址。', 'description' => '数据回落数据源地址。', 'type' => 'string', 'example' => 'mc_project_1'], + 'EasServiceName' => ['title' => 'EAS服务名称。', 'description' => 'EAS服务名称。', 'type' => 'string', 'example' => 'eas_service_1'], + 'FgJsonFileName' => ['title' => 'fg_json文件名称。', 'description' => 'fg_json文件名称。', 'type' => 'string', 'example' => 'file.json'], + 'UserTable' => ['title' => 'user表名。', 'description' => 'user表名。', 'type' => 'string', 'example' => 'user_table'], + 'UserIdField' => ['title' => 'user_id字段名。', 'description' => 'user_id字段名。', 'type' => 'string', 'example' => 'user_id'], + 'UserTablePartitionField' => ['title' => 'user表分区字段。', 'description' => 'user表分区字段。', 'type' => 'string', 'example' => 'ds'], + 'UserTablePartitionFieldFormat' => ['title' => 'user表分区字段格式。'."\n" + .'● yyyymmdd'."\n" + .'● yyyy-mm-dd', 'description' => 'user表分区字段格式：'."\n" + .'- yyyymmdd'."\n" + .'- yyyy-mm-dd', 'type' => 'string', 'example' => 'yyyymmdd'], + 'ItemTable' => ['title' => 'item表名。', 'description' => 'item表名。', 'type' => 'string', 'example' => 'item_table'], + 'ItemIdField' => ['title' => 'item_id字段名。', 'description' => 'item_id字段名。', 'type' => 'string', 'example' => 'item_id'], + 'ItemTablePartitionField' => ['title' => 'item表分区字段。', 'description' => 'item表分区字段。', 'type' => 'string', 'example' => 'ds'], + 'ItemTablePartitionFieldFormat' => ['title' => 'item表分区字段格式。'."\n" + .'● yyyymmdd'."\n" + .'● yyyy-mm-dd', 'description' => 'item表分区字段格式：'."\n" + .'- yyyymmdd'."\n" + .'- yyyy-mm-dd', 'type' => 'string', 'example' => 'yyyymmdd'], + 'GenerateZip' => ['title' => '是否需要生成zip包。', 'description' => '是否需要生成zip包。', 'type' => 'boolean', 'example' => 'true'], + 'ServiceId' => ['title' => '服务ID。', 'description' => '服务ID。', 'type' => 'string', 'example' => '4'], + 'ServiceName' => ['title' => '服务名称。', 'description' => '服务名称。', 'type' => 'string', 'example' => 'service1'], + 'WorkflowName' => ['title' => '工作流名称。', 'description' => '工作流名称。', 'type' => 'string', 'example' => 'work_flow_1'], + 'OssResourceId' => ['title' => 'OSS数据源ID。', 'description' => 'OSS数据源ID。', 'type' => 'string', 'example' => 'reso-********'], + 'OssBucket' => ['title' => 'OSS bucket名称。', 'description' => 'OSS bucket名称。', 'type' => 'string', 'example' => 'oss_bucket_1'], + 'EasyRecVersion' => ['title' => 'EasyRec版本。', 'description' => 'EasyRec版本。', 'type' => 'string', 'example' => '1.3.60'], + 'EasyRecPackagePath' => ['title' => 'EasyRec包路径。', 'description' => 'EasyRec包路径。', 'type' => 'string', 'example' => 'oss://*******'], + 'FgJarVersion' => ['title' => 'fg_jar版本。', 'description' => 'fg_jar版本。', 'type' => 'string', 'example' => '1.0.0'], + 'FeaturePriority' => ['title' => '特征优先级，多个特征通过逗号分开。', 'description' => '特征优先级，多个特征通过半角逗号（,）分开，表示哪些特征优先从user表读取，若user表为空，则从行为表查询。', 'type' => 'string', 'example' => 'feature1,feature2,feature3'], + 'FeatureDisplayExclude' => ['title' => '特征展示过滤，多个特征通过逗号分开。', 'description' => '特征展示过滤，多个特征通过半角逗号（,）分开。', 'type' => 'string', 'example' => 'feature1,feature2'], + 'GmtCreateTime' => ['title' => '创建时间。', 'description' => '创建时间。', 'type' => 'string', 'example' => '2021-12-15T23:24:33.132+08:00'], + 'GmtModifiedTime' => ['title' => '更新时间。', 'description' => '更新时间。', 'type' => 'string', 'example' => '2021-12-15T23:24:33.132+08:00'], + 'UseFeatureStore' => ['description' => '是否使用feature store，取值：'."\n" + ."\n" + .'- true：使用，此时返回FeatureStoreProjectId、FeatureStoreProjectName、FeatureStoreModelId、FeatureStoreUserId、FeatureStoreItemId。'."\n" + .'- false：不使用，此时返回UserTable、UserIdField、UserTablePartitionField、UserTablePartitionFieldFormat、ItemTable、ItemIdField、ItemTablePartitionField、ItemTablePartitionFieldFormat。', 'type' => 'string', 'example' => 'true'], + 'FeatureStoreProjectName' => ['description' => 'feature store项目名称。', 'type' => 'string', 'example' => 'project-1'], + 'FeatureStoreModelId' => ['description' => 'feature store model ID。', 'type' => 'string', 'example' => '2'."\n"], + 'FeatureStoreUserId' => ['description' => 'feature store user侧主键。', 'type' => 'string', 'example' => 'user'], + 'FeatureStoreItemId' => ['description' => 'feature store item侧主键。', 'type' => 'string', 'example' => 'item'], + 'FeatureStoreSeqFeatureView' => ['description' => '序列特征中item特征所在的特征视图的名字。', 'type' => 'string', 'example' => 'item-1'], + 'FeatureStoreProjectId' => ['description' => 'feature store项目ID。', 'type' => 'string', 'example' => 'prj-01'], + 'WorkspaceId' => ['type' => 'string', 'description' => ''], + 'VpcId' => ['type' => 'string', 'description' => ''], + 'SwitchId' => ['type' => 'string', 'description' => ''], + 'SecurityGroupId' => ['type' => 'string', 'description' => ''], + 'DefaultRoute' => ['type' => 'string', 'description' => ''], + 'DatasetId' => ['type' => 'string', 'description' => ''], + 'DatasetType' => ['type' => 'string', 'description' => ''], + 'DatasetUri' => ['type' => 'string', 'description' => ''], + 'DatasetMountPath' => ['type' => 'string', 'description' => ''], + 'DatasetName' => ['type' => 'string', 'description' => ''], + 'PredictWorkerCount' => ['type' => 'integer', 'format' => 'int32', 'description' => ''], + 'PredictWorkerCpu' => ['type' => 'integer', 'format' => 'int32', 'description' => ''], + 'PredictWorkerMemory' => ['type' => 'integer', 'format' => 'int32', 'description' => ''], + 'ResourceConfig' => ['type' => 'string', 'description' => ''], + ], + 'description' => '', + ], ], ], ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"FCF741D8-9C30-578E-807F-B935487DB34A\\",\\n \\"TotalCount\\": 10,\\n \\"FeatureConsistencyCheckConfigs\\": [\\n {\\n \\"FeatureConsistencyCheckJobConfigId\\": \\"3\\",\\n \\"Name\\": \\"feature_consistency_check1\\",\\n \\"SceneId\\": \\"3\\",\\n \\"SceneName\\": \\"scene1\\",\\n \\"Status\\": \\"Editable\\",\\n \\"CompareFeature\\": true,\\n \\"LatestJobId\\": \\"3\\",\\n \\"LatestJobGmtSamplingStartTime\\": \\"2021-12-15T23:24:33.132+08:00\\",\\n \\"LatestJobGmtSamplingEndTime\\": \\"2021-12-15T23:24:33.132+08:00\\",\\n \\"SampleRate\\": \\"0.89\\",\\n \\"FeatureLandingResourceId\\": \\"reso-********\\",\\n \\"FeatureLandingResourceUri\\": \\"mc_project_1\\",\\n \\"EasServiceName\\": \\"eas_service_1\\",\\n \\"FgJsonFileName\\": \\"file.json\\",\\n \\"UserTable\\": \\"user_table\\",\\n \\"UserIdField\\": \\"user_id\\",\\n \\"UserTablePartitionField\\": \\"ds\\",\\n \\"UserTablePartitionFieldFormat\\": \\"yyyymmdd\\",\\n \\"ItemTable\\": \\"item_table\\",\\n \\"ItemIdField\\": \\"item_id\\",\\n \\"ItemTablePartitionField\\": \\"ds\\",\\n \\"ItemTablePartitionFieldFormat\\": \\"yyyymmdd\\",\\n \\"GenerateZip\\": true,\\n \\"ServiceId\\": \\"4\\",\\n \\"ServiceName\\": \\"service1\\",\\n \\"WorkflowName\\": \\"work_flow_1\\",\\n \\"OssResourceId\\": \\"reso-********\\",\\n \\"OssBucket\\": \\"oss_bucket_1\\",\\n \\"EasyRecVersion\\": \\"1.3.60\\",\\n \\"EasyRecPackagePath\\": \\"oss://*******\\",\\n \\"FgJarVersion\\": \\"1.0.0\\",\\n \\"FeaturePriority\\": \\"feature1,feature2,feature3\\",\\n \\"FeatureDisplayExclude\\": \\"feature1,feature2\\",\\n \\"GmtCreateTime\\": \\"2021-12-15T23:24:33.132+08:00\\",\\n \\"GmtModifiedTime\\": \\"2021-12-15T23:24:33.132+08:00\\",\\n \\"UseFeatureStore\\": \\"true\\",\\n \\"FeatureStoreProjectName\\": \\"project-1\\",\\n \\"FeatureStoreModelId\\": \\"2\\\\n\\",\\n \\"FeatureStoreUserId\\": \\"user\\",\\n \\"FeatureStoreItemId\\": \\"item\\",\\n \\"FeatureStoreSeqFeatureView\\": \\"item-1\\",\\n \\"FeatureStoreProjectId\\": \\"prj-01\\",\\n \\"WorkspaceId\\": \\"\\",\\n \\"VpcId\\": \\"\\",\\n \\"SwitchId\\": \\"\\",\\n \\"SecurityGroupId\\": \\"\\",\\n \\"DefaultRoute\\": \\"\\",\\n \\"DatasetId\\": \\"\\",\\n \\"DatasetType\\": \\"\\",\\n \\"DatasetUri\\": \\"\\",\\n \\"DatasetMountPath\\": \\"\\",\\n \\"DatasetName\\": \\"\\",\\n \\"PredictWorkerCount\\": 0,\\n \\"PredictWorkerCpu\\": 0,\\n \\"PredictWorkerMemory\\": 0,\\n \\"ResourceConfig\\": \\"\\"\\n }\\n ]\\n}","type":"json"}]', + 'title' => '获取特征一致性检查任务配置列表', + 'changeSet' => [ + ['createdAt' => '2025-06-04T10:10:19.000Z', 'description' => '响应参数发生变更'], + ['createdAt' => '2024-12-10T06:00:28.000Z', 'description' => '响应参数发生变更'], + ['createdAt' => '2024-11-12T09:17:26.000Z', 'description' => '响应参数发生变更'], + ['createdAt' => '2024-02-22T03:35:43.000Z', 'description' => '响应参数发生变更'], + ], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'pairec:ListFeatureConsistencyCheckJobConfigs', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIRecService', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"F8F613A9-DF1C-551A-88E1-397A3981A785\\",\\n \\"ExperimentId\\": \\"3\\"\\n}","type":"json"}]', - 'title' => '克隆实验', ], - 'OfflineExperiment' => [ - 'summary' => '将指定实验下线。', - 'path' => '/api/v1/experiments/{ExperimentId}/action/offline', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'ListFeatureConsistencyCheckJobFeatureReports' => [ + 'summary' => '获取特征一致性检查任务的特征报表。', + 'path' => '/api/v1/featureconsistencycheck/jobs/{FeatureConsistencyCheckJobId}/featurereports', + 'methods' => ['get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], - 'operationType' => 'readAndWrite', + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'none', + 'operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATURElearnN0NAWV', - ], + 'abilityTreeNodes' => ['FEATURElearnN0NAWV'], ], 'parameters' => [ [ - 'name' => 'ExperimentId', + 'name' => 'FeatureConsistencyCheckJobId', 'in' => 'path', - 'schema' => [ - 'title' => '实验ID。', - 'description' => '实验ID，实验ID可通过接口ListExperiments获取。', - 'type' => 'string', - 'required' => true, - 'example' => '3', - ], + 'schema' => ['title' => '特征一致性检查任务ID。', 'description' => '特征一致性检查任务ID。如何获取任务ID，请参见[ListFeatureConsistencyCheckJobs](~~2557571~~)。', 'type' => 'string', 'required' => true, 'example' => '3'], ], [ - 'name' => 'body', - 'in' => 'body', - 'style' => 'json', - 'schema' => [ - 'description' => '请求body。', - 'type' => 'object', - 'properties' => [ - 'InstanceId' => [ - 'title' => '实例ID。', - 'description' => '实例ID，可通过接口ListInstances获取。', - 'type' => 'string', - 'required' => true, - 'example' => 'pairec-cn-abcdefg1234', - ], - ], - 'required' => false, - ], + 'name' => 'InstanceId', + 'in' => 'query', + 'schema' => ['title' => '实例ID。', 'description' => '实例ID。如何获取实例ID，请参见[ListInstances](~~2411819~~)。', 'type' => 'string', 'required' => true, 'example' => 'pairec-cn-********'], + ], + [ + 'name' => 'LogUserId', + 'in' => 'query', + 'schema' => ['title' => '特征比对时的UserId。', 'description' => '特征比对时的UserId。', 'type' => 'string', 'required' => true, 'example' => '1010'], + ], + [ + 'name' => 'LogItemId', + 'in' => 'query', + 'schema' => ['title' => '特征比对时的ItemId。', 'description' => '特征比对时的ItemId。', 'type' => 'string', 'required' => true, 'example' => '9010'], + ], + [ + 'name' => 'LogRequestId', + 'in' => 'query', + 'schema' => ['title' => '特征比对时的RequestId。', 'description' => '特征比对时的RequestId。', 'type' => 'string', 'required' => true, 'example' => 'F7AC05FF-EDE7-5C2B-B9AE-33D6DF4178BA'], ], ], 'responses' => [ @@ -10128,81 +9821,92 @@ 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'Id of the request', - 'type' => 'string', - 'example' => '872951C9-7755-5FA1-AACD-7F9375A6D27A', + 'RequestId' => ['title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => 'BBD41FBF-E75C-551A-92FA-CAD654AA006F'], + 'ReportsOfFeatureDiff' => [ + 'title' => '特征比对报表。', + 'description' => '特征比对报表。', + 'type' => 'array', + 'items' => [ + 'title' => '', + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'LogUserId' => ['title' => '用户ID。', 'description' => '用户ID。', 'type' => 'string', 'example' => '1010'], + 'LogItemId' => ['title' => '物品ID。', 'description' => '物品ID。', 'type' => 'string', 'example' => '9010'], + 'LogRequestId' => ['title' => '请求ID。', 'description' => '请求ID。', 'type' => 'string', 'example' => 'F7AC05FF-EDE7-5C2B-B9AE-33D6DF4178BA'], + 'FeatureName' => ['title' => '特征名称。', 'description' => '特征名称。', 'type' => 'string', 'example' => 'gender'], + 'OfflineValue' => ['title' => '离线值。', 'description' => '离线值。', 'type' => 'string', 'example' => 'male'], + 'OnlineValue' => ['title' => '在线值。', 'description' => '在线值。', 'type' => 'string', 'example' => 'male'], + ], + ], ], + 'DataPath' => ['description' => '数据路径。', 'type' => 'string', 'example' => 'https://********'], + 'OssPath' => ['description' => 'OSS路径。', 'type' => 'string', 'example' => 'oss://********'], ], ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"BBD41FBF-E75C-551A-92FA-CAD654AA006F\\",\\n \\"ReportsOfFeatureDiff\\": [\\n {\\n \\"LogUserId\\": \\"1010\\",\\n \\"LogItemId\\": \\"9010\\",\\n \\"LogRequestId\\": \\"F7AC05FF-EDE7-5C2B-B9AE-33D6DF4178BA\\",\\n \\"FeatureName\\": \\"gender\\",\\n \\"OfflineValue\\": \\"male\\",\\n \\"OnlineValue\\": \\"male\\"\\n }\\n ],\\n \\"DataPath\\": \\"https://********\\",\\n \\"OssPath\\": \\"oss://********\\"\\n}","type":"json"}]', + 'title' => '获取特征一致性检查任务的特征报表', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'pairec:ListFeatureConsistencyCheckJobFeatureReports', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIRecService', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"872951C9-7755-5FA1-AACD-7F9375A6D27A\\"\\n}","type":"json"}]', - 'title' => '下线实验', ], - 'PushAllExperiment' => [ - 'summary' => '对于效果较优且稳定的实验，可对该实验进行推全。对某个实验推全后，该实验所属的实验组将结束生命周期，不再支持继续实验。平台会生成一个新的实验组，被推全的实验将在该实验组下占有全额的流量。', - 'path' => '/api/v1/experiments/{ExperimentId}/action/pushall', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'ListFeatureConsistencyCheckJobScoreReports' => [ + 'summary' => '获取特征一致性检查任务分数报表。', + 'path' => '/api/v1/featureconsistencycheck/jobs/{FeatureConsistencyCheckJobId}/scorereports', + 'methods' => ['get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], - 'operationType' => 'readAndWrite', + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'none', + 'operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATURElearnN0NAWV', - ], + 'abilityTreeNodes' => ['FEATURElearnN0NAWV'], ], 'parameters' => [ [ - 'name' => 'ExperimentId', + 'name' => 'FeatureConsistencyCheckJobId', 'in' => 'path', - 'schema' => [ - 'title' => '实验ID。', - 'description' => '实验ID，可通过接口ListExperiments获取。', - 'type' => 'string', - 'required' => true, - 'example' => '3', - ], + 'schema' => ['title' => '特征一致性检查任务报表ID。', 'description' => '特征一致性检查任务报表ID。特征一致性检查任务ID。如何获取任务ID，请参见[ListFeatureConsistencyCheckJobs](~~2557561~~)。', 'type' => 'string', 'required' => true, 'example' => '3'], ], [ - 'name' => 'body', - 'in' => 'body', + 'name' => 'InstanceId', + 'in' => 'query', + 'schema' => ['title' => '实例ID。', 'description' => '实例ID。如何获取实例ID，请参见[ListInstances](~~2411819~~)。', 'type' => 'string', 'required' => false, 'example' => 'pairec-cn-********'], + ], + [ + 'name' => 'ExcludeRequestIds', + 'in' => 'query', 'style' => 'json', 'schema' => [ - 'description' => '请求body。', - 'type' => 'object', - 'properties' => [ - 'InstanceId' => [ - 'title' => '实例ID。', - 'description' => '实例ID，可通过接口ListInstances获取。', - 'type' => 'string', - 'required' => false, - 'example' => 'pairec-cn-abcdefg1234', - ], - ], + 'title' => '特征比对时排除的RequestId。', + 'description' => '特征比对时排除的RequestId列表。', + 'type' => 'array', + 'items' => ['description' => '请求ID。', 'type' => 'string', 'required' => false, 'example' => '728C5E01-ABF6-5AA8-B9FC-B3BA05DECC77'], 'required' => false, ], ], @@ -10214,83 +9918,118 @@ 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'Id of the request', - 'type' => 'string', - 'example' => '74D958EF-3598-56FA-8296-FF1575CE43DF', + 'RequestId' => ['title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => 'F0AB6527-093F-5C44-B3BD-42C8C210C619'], + 'ReportsOfScoreDiff' => [ + 'title' => '分数比对报表。', + 'description' => '分数比对报表。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'LogUserId' => ['title' => '用户ID。', 'description' => '用户ID。', 'type' => 'string', 'example' => '3'], + 'LogItemId' => ['title' => '物品ID。', 'description' => '物品ID。', 'type' => 'string', 'example' => '4'], + 'LogRequestId' => ['title' => '请求ID。', 'description' => '请求ID。', 'type' => 'string', 'example' => '323'], + 'ScoreDiff' => ['title' => '分数差值。', 'description' => '分数差值。', 'type' => 'string', 'example' => '0.00000234'], + 'ScoreDiffDetail' => ['title' => '分数比对详细。', 'description' => '分数比对详细。', 'type' => 'string', 'example' => '{}'], + ], + 'description' => '', + ], ], + 'DataPath' => ['title' => '数据路径。', 'description' => '数据路径。', 'type' => 'string', 'example' => 'http://*******'], + 'OssPath' => ['title' => 'oss路径。', 'description' => 'oss路径。', 'type' => 'string', 'example' => 'oss://********'], ], ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"F0AB6527-093F-5C44-B3BD-42C8C210C619\\",\\n \\"ReportsOfScoreDiff\\": [\\n {\\n \\"LogUserId\\": \\"3\\",\\n \\"LogItemId\\": \\"4\\",\\n \\"LogRequestId\\": \\"323\\",\\n \\"ScoreDiff\\": \\"0.00000234\\",\\n \\"ScoreDiffDetail\\": \\"{}\\"\\n }\\n ],\\n \\"DataPath\\": \\"http://*******\\",\\n \\"OssPath\\": \\"oss://********\\"\\n}","type":"json"}]', + 'title' => '获取特征一致性检查任务分数报表', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'pairec:ListFeatureConsistencyCheckJobScoreReports', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIRecService', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"74D958EF-3598-56FA-8296-FF1575CE43DF\\"\\n}","type":"json"}]', - 'title' => '推全实验', ], - 'OnlineExperiment' => [ - 'summary' => '将指定实验发布上线。', - 'path' => '/api/v1/experiments/{ExperimentId}/action/online', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'ListFeatureConsistencyCheckJobs' => [ + 'summary' => '获取特征一致性检查任务列表。', + 'path' => '/api/v1/featureconsistencycheck/jobs', + 'methods' => ['get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], - 'operationType' => 'readAndWrite', + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'none', + 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATURElearnN0NAWV', - ], + 'abilityTreeNodes' => ['FEATURElearnN0NAWV'], ], 'parameters' => [ [ - 'name' => 'ExperimentId', - 'in' => 'path', - 'schema' => [ - 'title' => '实验ID。', - 'description' => '实验ID，可通过接口ListExperiments获取。', - 'type' => 'string', - 'required' => true, - 'example' => '3', - ], + 'name' => 'InstanceId', + 'in' => 'query', + 'schema' => ['title' => '实例ID。', 'description' => '实例ID。如何获取实例ID，请参见[ListInstances](~~2411819~~)。', 'type' => 'string', 'required' => true, 'example' => 'pairec-cn-********'], ], [ - 'name' => 'body', - 'in' => 'body', - 'style' => 'json', - 'schema' => [ - 'description' => '请求body。', - 'type' => 'object', - 'properties' => [ - 'InstanceId' => [ - 'title' => '实例ID。', - 'description' => '实例ID，可通过接口ListInstances获取。', - 'type' => 'string', - 'required' => false, - 'example' => 'pairec-cn-abcdefg1234', - ], - ], - 'required' => false, - ], + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => ['title' => '页码。', 'description' => '页码。', 'type' => 'string', 'required' => false, 'example' => '1'], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => ['title' => '页大小。', 'description' => '页大小。', 'type' => 'string', 'required' => false, 'example' => '10'], + ], + [ + 'name' => 'SortBy', + 'in' => 'query', + 'schema' => ['title' => '排序依据。'."\n" + .'● GmtCreateTime-创建时间。'."\n" + .'● GmtModifiedTime-更新时间。', 'description' => '排序依据：'."\n" + .'- GmtCreateTime：按创建时间。'."\n" + .'- GmtModifiedTime：按更新时间。', 'type' => 'string', 'required' => false, 'example' => 'GmtCreateTime'], + ], + [ + 'name' => 'Order', + 'in' => 'query', + 'schema' => ['title' => '排序方式。'."\n" + .'● ASC-升序。'."\n" + .'● DESC-降序。', 'description' => '排序方式：'."\n" + .'- ASC：升序。'."\n" + .'- DESC：降序。', 'type' => 'string', 'required' => false, 'example' => 'ASC'], + ], + [ + 'name' => 'Status', + 'in' => 'query', + 'schema' => ['title' => '任务状态。'."\n" + .'● ToRun-待运行。'."\n" + .'● Running-运行中。'."\n" + .'● Success-成功。'."\n" + .'● Failure-失败。'."\n" + .'● Stopped-停止/已取消。', 'description' => '任务状态。取值如下：'."\n" + .'- ToRun：待运行。'."\n" + .'- Running：运行中。'."\n" + .'- Success：成功。'."\n" + .'- Failure：失败。'."\n" + .'- Stopped：停止或已取消。', 'type' => 'string', 'required' => false, 'example' => 'Running'], ], ], 'responses' => [ @@ -10300,110 +10039,101 @@ 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'Id of the request', - 'type' => 'string', - 'example' => '6CF1E160-3F36-5E73-A170-C75504F05BBC', + 'RequestId' => ['title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => 'A04CB8C0-E74A-5E83-BC61-64D153574EC7'], + 'TotalCount' => ['title' => '总个数。', 'description' => '总个数。', 'type' => 'string', 'example' => '10'], + 'FeatureConsistencyCheckJobs' => [ + 'title' => '特征一致性检查任务列表。', + 'description' => '特征一致性检查任务列表。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'FeatureConsistencyCheckJobId' => ['title' => '特征一致性检查任务ID。', 'description' => '特征一致性检查任务ID。', 'type' => 'string', 'example' => '4'], + 'FeatureConsistencyCheckJobConfigId' => ['title' => '特征一致性检查配置ID。', 'description' => '特征一致性检查配置ID。', 'type' => 'string', 'example' => '5'], + 'FeatureConsistencyCheckJobConfigName' => ['title' => '特征一致性检查任务配置名称。', 'description' => '特征一致性检查任务配置名称。', 'type' => 'string', 'example' => 'feature_consistency_check_1'], + 'GmtStartTime' => ['title' => '开始时间。', 'description' => '开始时间。', 'type' => 'string', 'example' => '2021-12-15T23:24:33.132+08:00'], + 'GmtEndTime' => ['title' => '结束时间。', 'description' => '结束时间。', 'type' => 'string', 'example' => '2021-12-15T23:24:33.132+08:00'], + 'Status' => ['title' => '任务状态。'."\n" + .'● ToRun-待运行。'."\n" + .'● Running-运行中。'."\n" + .'● Success-成功。'."\n" + .'● Failure-失败。'."\n" + .'● Terminated-停止/已取消。', 'description' => '任务状态。可能值为：'."\n" + .'- ToRun：待运行。'."\n" + .'- Running：运行中。'."\n" + .'- Success：成功。'."\n" + .'- Failure：失败。'."\n" + .'- Stopped：停止或已取消。', 'type' => 'string', 'example' => 'Running'], + 'Config' => ['title' => '配置信息。', 'description' => '配置信息。', 'type' => 'string', 'example' => '{}'], + 'Logs' => [ + 'title' => '日志信息。', + 'description' => '日志信息。', + 'type' => 'array', + 'items' => ['description' => '日志。', 'type' => 'string', 'example' => '2022/09/26 02:16:24 INFO: job status: Created'], + ], + ], + 'description' => '', + ], ], ], ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"A04CB8C0-E74A-5E83-BC61-64D153574EC7\\",\\n \\"TotalCount\\": \\"10\\",\\n \\"FeatureConsistencyCheckJobs\\": [\\n {\\n \\"FeatureConsistencyCheckJobId\\": \\"4\\",\\n \\"FeatureConsistencyCheckJobConfigId\\": \\"5\\",\\n \\"FeatureConsistencyCheckJobConfigName\\": \\"feature_consistency_check_1\\",\\n \\"GmtStartTime\\": \\"2021-12-15T23:24:33.132+08:00\\",\\n \\"GmtEndTime\\": \\"2021-12-15T23:24:33.132+08:00\\",\\n \\"Status\\": \\"Running\\",\\n \\"Config\\": \\"{}\\",\\n \\"Logs\\": [\\n \\"2022/09/26 02:16:24 INFO: job status: Created\\"\\n ]\\n }\\n ]\\n}","type":"json"}]', + 'title' => '获取特征一致性检查任务列表', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'pairec:ListFeatureConsistencyCheckJobs', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIRecService', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"6CF1E160-3F36-5E73-A170-C75504F05BBC\\"\\n}","type":"json"}]', - 'title' => '上线实验', ], - 'CreateParam' => [ - 'summary' => '创建一个参数。通过对参数进行管理，无需修改引擎配置、发布变更，即可对服务读取的变量进行修改，提高灵活性。', - 'path' => '/api/v1/params', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'ListInstanceResourceSchemas' => [ + 'path' => '/api/v1/instances/{InstanceId}/resources/{ResourceId}/schemas', + 'methods' => ['get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], - 'operationType' => 'write', + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'create', + 'operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATURElearnN0NAWV', - ], + 'abilityTreeNodes' => ['FEATURElearnN0NAWV'], ], 'parameters' => [ [ - 'name' => 'body', - 'in' => 'body', - 'style' => 'json', - 'schema' => [ - 'description' => '请求body。', - 'type' => 'object', - 'properties' => [ - 'SceneId' => [ - 'title' => '场景ID。', - 'description' => '场景ID，可通过接口ListScenes获取。', - 'type' => 'string', - 'required' => false, - 'example' => '4', - ], - 'Name' => [ - 'title' => '参数名称。', - 'description' => '参数名称。', - 'type' => 'string', - 'required' => false, - 'example' => 'home', - ], - 'Value' => [ - 'title' => '参数值。', - 'description' => '参数值。', - 'type' => 'string', - 'required' => false, - 'example' => 'house', - ], - 'Environment' => [ - 'title' => '参数所属的环境。'."\n" - .'● Daily-日常环境'."\n" - .'● Pre-预发环境'."\n" - .'● Prod-生产环境', - 'description' => '参数所属的环境。'."\n" - .'● Daily-日常环境'."\n" - .'● Pre-预发环境'."\n" - .'● Prod-生产环境', - 'type' => 'string', - 'required' => false, - 'example' => 'Daily', - ], - 'InstanceId' => [ - 'title' => '实例ID。', - 'description' => '实例ID，可通过接口ListInstances获取。', - 'type' => 'string', - 'required' => false, - 'example' => 'pairec-cn-abcdefg1234', - ], - 'Type' => [ - 'type' => 'string', - 'required' => false, - ], - ], - 'required' => false, - ], + 'name' => 'InstanceId', + 'in' => 'path', + 'schema' => ['description' => '实例ID。', 'type' => 'string', 'required' => false, 'example' => 'featureStore-cn-test1'], + ], + [ + 'name' => 'ResourceId', + 'in' => 'path', + 'schema' => ['description' => '资源ID。', 'type' => 'string', 'required' => false, 'example' => '3'], + ], + [ + 'name' => 'SchemaName', + 'in' => 'query', + 'schema' => ['description' => 'schema名称前缀匹配过滤。', 'type' => 'string', 'required' => false, 'example' => 'default'], ], ], 'responses' => [ @@ -10413,82 +10143,69 @@ 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'Id of the request', - 'type' => 'string', - 'example' => 'F8F613A9-DF1C-551A-88E1-397A3981A785', - ], - 'ParamId' => [ - 'title' => '参数ID。', - 'description' => '参数ID。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '4', + 'RequestId' => ['title' => 'Id of the request', 'description' => '请求id。', 'type' => 'string', 'example' => '728C5E01-ABF6-5AA8-B9FC-B3BA05DECC77'], + 'TotalCount' => ['description' => '总个数。', 'type' => 'integer', 'format' => 'int64', 'example' => '10'], + 'Schemas' => [ + 'description' => 'schema列表。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'SchemaName' => ['description' => 'schema名称。', 'type' => 'string', 'example' => 'default'], + ], + 'description' => '', + ], ], ], ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '获取实例资源下的Schema', + 'summary' => '此API用于查询指定实例和资源下的所有Schema信息。', + 'description' => '## 请求说明'."\n" + .'通过提供实例ID（InstanceId）和资源ID（ResourceId），可以获取该实例资源下的所有Schema列表。可选参数SchemaName支持根据名称前缀进行过滤，以更精确地定位所需的Schema。'."\n", + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"F8F613A9-DF1C-551A-88E1-397A3981A785\\",\\n \\"ParamId\\": 4\\n}","type":"json"}]', - 'title' => '创建参数', + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"728C5E01-ABF6-5AA8-B9FC-B3BA05DECC77\\",\\n \\"TotalCount\\": 10,\\n \\"Schemas\\": [\\n {\\n \\"SchemaName\\": \\"default\\"\\n }\\n ]\\n}","type":"json"}]', ], - 'DeleteParam' => [ - 'summary' => '删除指定参数。', - 'path' => '/api/v1/params/{ParamId}', - 'methods' => [ - 'delete', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'ListInstanceResourceTables' => [ + 'path' => '/api/v1/instances/{InstanceId}/resources/{ResourceId}/tables', + 'methods' => ['get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], - 'operationType' => 'write', + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'delete', + 'operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATURElearnN0NAWV', - ], + 'abilityTreeNodes' => ['FEATURElearnN0NAWV'], ], 'parameters' => [ [ - 'name' => 'ParamId', + 'name' => 'InstanceId', 'in' => 'path', - 'schema' => [ - 'title' => '参数ID。', - 'description' => '参数ID，可通过接口ListParams获取。', - 'type' => 'string', - 'required' => false, - 'example' => '3', - ], + 'schema' => ['description' => '实例ID。'."\n", 'type' => 'string', 'required' => false, 'example' => 'pairec-cn-xxx'], ], [ - 'name' => 'InstanceId', + 'name' => 'ResourceId', + 'in' => 'path', + 'schema' => ['description' => '数据源ID。'."\n", 'type' => 'string', 'required' => false, 'example' => 'reso-*********'], + ], + [ + 'name' => 'MaxcomputeSchema', 'in' => 'query', - 'schema' => [ - 'title' => '实例ID。', - 'description' => '实例ID，可通过接口ListInstances获取。', - 'type' => 'string', - 'required' => false, - 'example' => 'pairec-cn-abcdefg1234', - ], + 'schema' => ['description' => 'maxcompute 的 schema'."\n", 'type' => 'string', 'required' => false, 'example' => 'jackal'], ], ], 'responses' => [ @@ -10498,91 +10215,143 @@ 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'Id of the request', - 'type' => 'string', - 'example' => 'F0AB6527-093F-5C44-B3BD-42C8C210C619', + 'RequestId' => ['title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => '01D22D08-BA20-5F35-8302-99115F288220'], + 'TotalCount' => ['description' => '总个数。', 'type' => 'string', 'example' => '30'], + 'Tables' => [ + 'description' => '数据表列表。', + 'type' => 'array', + 'items' => [ + 'description' => '数据表详细信息。', + 'type' => 'object', + 'properties' => [ + 'TableName' => ['description' => '表名。', 'type' => 'string', 'example' => 'table-1'], + ], + ], ], ], ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '获取实例资源下数据表列表', + 'summary' => '此API用于查询指定实例和数据源下的所有数据表。', + 'description' => '## 请求说明'."\n" + .'通过提供实例ID（InstanceId）和数据源ID（ResourceId），您可以获取该数据源下的所有数据表列表。可选参数`MaxcomputeSchema`允许您指定maxcompute的schema以进一步筛选结果。'."\n", + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"F0AB6527-093F-5C44-B3BD-42C8C210C619\\"\\n}","type":"json"}]', - 'title' => '删除参数', + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"01D22D08-BA20-5F35-8302-99115F288220\\",\\n \\"TotalCount\\": \\"30\\",\\n \\"Tables\\": [\\n {\\n \\"TableName\\": \\"table-1\\"\\n }\\n ]\\n}","type":"json"}]', ], - 'UpdateParam' => [ - 'summary' => '更新指定参数的信息，例如更新参数的值。', - 'path' => '/api/v1/params/{ParamId}', - 'methods' => [ - 'put', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'ListInstanceResources' => [ + 'summary' => '获取实例下配置的资源列表。', + 'path' => '/api/v1/instances/{InstanceId}/resources', + 'methods' => ['get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], - 'operationType' => 'readAndWrite', + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'update', + 'operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATURElearnN0NAWV', - ], + 'abilityTreeNodes' => ['FEATURElearnN0NAWV'], ], 'parameters' => [ [ - 'name' => 'ParamId', + 'name' => 'InstanceId', 'in' => 'path', - 'schema' => [ - 'title' => '参数ID。', - 'description' => '参数ID，可通过接口ListParams获取。', - 'type' => 'string', - 'required' => false, - 'example' => '3', - ], + 'schema' => ['description' => '实例ID，可通过接口[ListInstances](~~2411819~~)获取。', 'type' => 'string', 'required' => true, 'example' => 'pairec-cn-test1'], ], [ - 'name' => 'body', - 'in' => 'body', - 'style' => 'json', - 'schema' => [ - 'title' => '请求body。', - 'description' => '请求body。', - 'type' => 'object', - 'properties' => [ - 'Value' => [ - 'title' => '参数值。', - 'description' => '参数值。', - 'type' => 'string', - 'required' => false, - 'example' => 'house', - ], - 'InstanceId' => [ - 'title' => '实例ID。', - 'description' => '实例ID，可通过接口ListInstances获取。', - 'type' => 'string', - 'required' => false, - 'example' => 'pairec-cn-abcdefg1234', - ], - ], - 'required' => false, - ], + 'name' => 'Category', + 'in' => 'query', + 'schema' => ['description' => '资源类别'."\n" + ."\n" + .'- DataManagement'."\n" + ."\n" + .'- Engine'."\n" + ."\n" + .'- Monitor', 'type' => 'string', 'required' => false, 'example' => 'DataManagement'], + ], + [ + 'name' => 'Group', + 'in' => 'query', + 'schema' => ['description' => '资源分组。'."\n" + ."\n" + .'当资源类别为DataManagement时，资源分组有：'."\n" + ."\n" + .'- storage'."\n" + ."\n" + .'- modelpipeline'."\n" + ."\n" + .'- datastorage'."\n" + ."\n" + .'- modeltrain'."\n" + ."\n" + .'当资源类别为Engine时，资源分组有：'."\n" + ."\n" + .'- feature'."\n" + ."\n" + .'- predict'."\n" + ."\n" + .'- recall'."\n" + ."\n" + .'- recengine'."\n" + ."\n" + .'当资源类别为Monitor时，资源分组有：'."\n" + ."\n" + .'- logs'."\n" + ."\n" + .'- logsback'."\n" + ."\n" + .'- coldstart'."\n" + ."\n" + .'- deploy', 'type' => 'string', 'required' => false, 'example' => 'storage'], + ], + [ + 'name' => 'Type', + 'in' => 'query', + 'schema' => ['description' => '资源类型过滤。'."\n" + ."\n" + .'- Hologres'."\n" + ."\n" + .'- EAS'."\n" + ."\n" + .'- BE'."\n" + ."\n" + .'- Rec'."\n" + ."\n" + .'- Platform'."\n" + ."\n" + .'- SLS'."\n" + ."\n" + .'- DataHub'."\n" + ."\n" + .'- Kafka'."\n" + ."\n" + .'- Flinkvvp'."\n" + ."\n" + .'- ACR'."\n" + ."\n" + .'- OSS'."\n" + ."\n" + .'- DataWorks'."\n" + ."\n" + .'- PAI'."\n" + ."\n" + .'- MaxCompute'."\n" + ."\n" + .'- GraphCompute'."\n" + ."\n" + .'- Redis', 'type' => 'string', 'required' => false, 'example' => 'OSS'], ], ], 'responses' => [ @@ -10592,136 +10361,180 @@ 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'Id of the request', - 'type' => 'string', - 'example' => 'BBD41FBF-E75C-551A-92FA-CAD654AA006F', + 'RequestId' => ['title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => '9763624B-5FBB-5E3A-9193-B1ADB554CEAE'], + 'TotalCount' => ['description' => '总个数。', 'type' => 'integer', 'format' => 'int64', 'example' => '10'], + 'Resources' => [ + 'description' => '资源对象的列表。', + 'type' => 'array', + 'items' => [ + 'description' => '资源信息。', + 'type' => 'object', + 'properties' => [ + 'ResourceId' => ['description' => '资源ID。', 'type' => 'string', 'example' => 'reso-2s416t***'."\n"], + 'Category' => ['description' => '资源类别'."\n" + ."\n" + .'- DataManagement'."\n" + ."\n" + .'- Engine'."\n" + ."\n" + .'- Monitor', 'type' => 'string', 'example' => 'DataManagement'], + 'Group' => ['description' => '资源分组。'."\n" + ."\n" + .'当资源类别为DataManagement时，资源分组有：'."\n" + ."\n" + .'- storage'."\n" + ."\n" + .'- modelpipeline'."\n" + ."\n" + .'- datastorage'."\n" + ."\n" + .'- modeltrain'."\n" + ."\n" + .'当资源类别为Engine时，资源分组有：'."\n" + ."\n" + .'- feature'."\n" + ."\n" + .'- predict'."\n" + ."\n" + .'- recall'."\n" + ."\n" + .'- recengine'."\n" + ."\n" + .'当资源类别为Monitor时，资源分组有：'."\n" + ."\n" + .'- logs'."\n" + ."\n" + .'- logsback'."\n" + ."\n" + .'- coldstart'."\n" + ."\n" + .'- deploy', 'type' => 'string', 'example' => 'storage'], + 'Type' => ['description' => '资源类型'."\n" + ."\n" + .'- Hologres'."\n" + ."\n" + .'- EAS'."\n" + ."\n" + .'- BE'."\n" + ."\n" + .'- Rec'."\n" + ."\n" + .'- Platform'."\n" + ."\n" + .'- SLS'."\n" + ."\n" + .'- DataHub'."\n" + ."\n" + .'- Kafka'."\n" + ."\n" + .'- Flinkvvp'."\n" + ."\n" + .'- ACR'."\n" + ."\n" + .'- OSS'."\n" + ."\n" + .'- DataWorks'."\n" + ."\n" + .'- PAI'."\n" + ."\n" + .'- MaxCompute'."\n" + ."\n" + .'- GraphCompute'."\n" + ."\n" + .'- Redis', 'type' => 'string', 'example' => 'OSS'], + 'Uri' => ['description' => '资源地址。', 'type' => 'string', 'example' => 'bucket-test-123'], + 'Config' => ['description' => '资源的配置信息。', 'type' => 'string', 'example' => '{}'], + 'GmtCreateAt' => ['description' => '创建时间。', 'type' => 'string', 'example' => '2020-10-13 17:34:52'."\n"], + 'GmtModifiedAt' => ['description' => '更新时间。', 'type' => 'string', 'example' => '2020-10-13 17:34:52'."\n"], + ], + ], ], ], ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"9763624B-5FBB-5E3A-9193-B1ADB554CEAE\\",\\n \\"TotalCount\\": 10,\\n \\"Resources\\": [\\n {\\n \\"ResourceId\\": \\"reso-2s416t***\\\\n\\",\\n \\"Category\\": \\"DataManagement\\",\\n \\"Group\\": \\"storage\\",\\n \\"Type\\": \\"OSS\\",\\n \\"Uri\\": \\"bucket-test-123\\",\\n \\"Config\\": \\"{}\\",\\n \\"GmtCreateAt\\": \\"2020-10-13 17:34:52\\\\n\\",\\n \\"GmtModifiedAt\\": \\"2020-10-13 17:34:52\\\\n\\"\\n }\\n ]\\n}","type":"json"}]', + 'title' => '获取资源列表', + 'changeSet' => [ + ['createdAt' => '2024-02-22T03:35:44.000Z', 'description' => '请求参数发生变更'], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"BBD41FBF-E75C-551A-92FA-CAD654AA006F\\"\\n}","type":"json"}]', - 'title' => '更新参数', - ], - 'ListParams' => [ - 'summary' => '获取参数列表。', - 'path' => '/api/v1/params', - 'methods' => [ - 'get', + 'flowControl' => [ + 'flowControlList' => [], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'pairec:ListInstanceResources', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIRecService', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], ], + ], + 'ListInstances' => [ + 'summary' => '获取PAIRec实例的列表。', + 'path' => '/api/v1/instances', + 'methods' => ['get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'list', + 'operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATURElearnN0NAWV', - ], + 'abilityTreeCode' => '163069', + 'abilityTreeNodes' => ['FEATURElearnN0NAWV'], ], 'parameters' => [ [ - 'name' => 'SceneId', + 'name' => 'InstanceId', 'in' => 'query', - 'schema' => [ - 'title' => '场景ID。', - 'description' => '场景ID，可通过接口ListScenes获取。', - 'type' => 'string', - 'required' => true, - 'example' => '3', - ], + 'schema' => ['title' => '实例Id模糊匹配过滤。', 'description' => '实例ID模糊匹配过滤。', 'type' => 'string', 'required' => false, 'example' => 'pairec-test1'], ], [ - 'name' => 'Name', + 'name' => 'SortBy', 'in' => 'query', - 'schema' => [ - 'title' => '参数名称。', - 'description' => '参数名称。', - 'type' => 'string', - 'required' => false, - 'example' => 'home', - ], + 'schema' => ['title' => '排序依据。', 'description' => '排序依据。', 'type' => 'string', 'required' => false, 'example' => 'Type'], ], [ - 'name' => 'Environment', + 'name' => 'Order', 'in' => 'query', - 'schema' => [ - 'title' => '参数所属的环境。'."\n" - .'● Daily-日常环境'."\n" - .'● Pre-预发环境'."\n" - .'● Prod-生产环境', - 'description' => '参数所属的环境。'."\n" - ."\n" - .'- Daily：日常环境'."\n" - .'- Pre：预发环境'."\n" - .'- Prod：生产环境', - 'type' => 'string', - 'required' => false, - 'example' => 'Daily', - ], + 'schema' => ['title' => '排序方式。', 'description' => '排序方式。', 'type' => 'string', 'required' => false, 'example' => 'Desc'], ], [ 'name' => 'PageNumber', 'in' => 'query', - 'schema' => [ - 'title' => '页码。', - 'description' => '页码。', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', - ], + 'schema' => ['title' => '页大小。', 'description' => '页大小。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1'], ], [ 'name' => 'PageSize', 'in' => 'query', - 'schema' => [ - 'title' => '页大小。', - 'description' => '页大小。', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '50', - ], + 'schema' => ['title' => '页码。', 'description' => '页码。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '50'], ], [ - 'name' => 'InstanceId', - 'in' => 'query', - 'schema' => [ - 'title' => '实例ID。', - 'description' => '实例ID，可通过接口ListInstances获取。', - 'type' => 'string', - 'required' => true, - 'example' => 'pairec-cn-abcdefg1234', - ], - ], - [ - 'name' => 'Encrypted', + 'name' => 'Type', 'in' => 'query', - 'schema' => [ - 'type' => 'boolean', - 'required' => false, - ], + 'schema' => ['title' => '实例类型。'."\n" + .'● basic-基础版'."\n" + .'● highleve-升级版'."\n" + .'● advance-进阶版'."\n" + .'● standard-标准版', 'description' => '实例类型。'."\n" + .'- basic-基础版'."\n" + .'- highleve-升级版'."\n" + .'- advance-进阶版'."\n" + .'- standard-标准版', 'type' => 'string', 'required' => false, 'example' => 'basic'], ], ], 'responses' => [ @@ -10731,166 +10544,188 @@ 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'Id of the request', - 'type' => 'string', - 'example' => 'A2D07551-38DA-531E-9B22-877D1D86A579', - ], - 'TotalCount' => [ - 'title' => '列表内元素总数。', - 'description' => '列表内元素总数。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '10', - ], - 'Params' => [ - 'title' => '参数列表。', - 'description' => '参数列表。', + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'BDB621CB-A81E-5D39-8793-39A365CBCC74'], + 'Instances' => [ + 'description' => '实例列表。', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ - 'ParamId' => [ - 'title' => '参数ID。', - 'description' => '参数ID。', - 'type' => 'string', - 'example' => '4', - ], - 'Name' => [ - 'title' => '参数名称。', - 'description' => '参数名称。', - 'type' => 'string', - 'example' => 'home', - ], - 'Value' => [ - 'title' => '参数值。', - 'description' => '参数值。', - 'type' => 'string', - 'example' => 'house', - ], - 'Environment' => [ - 'title' => '参数所属的环境。'."\n" - .'● Daily-日常环境'."\n" - .'● Prepub-预发环境'."\n" - .'● Product-生产环境', - 'description' => '参数所属的环境。'."\n" - ."\n" - .'- Daily：日常环境'."\n" - .'- Prepub：预发环境'."\n" - .'- Product：生产环境', - 'type' => 'string', - 'example' => 'Daily', + 'InstanceId' => ['title' => '实例id。', 'description' => '实例ID。', 'type' => 'string', 'example' => 'pairec-test1'], + 'Type' => ['title' => '实例类型。'."\n" + .'● basic-基础版'."\n" + .'● highleve-升级版'."\n" + .'● advance-进阶版'."\n" + .'● standard-标准版', 'description' => '实例类型。'."\n" + .'- basic-基础版'."\n" + .'- highleve-升级版'."\n" + .'- advance-进阶版'."\n" + .'- standard-标准版', 'type' => 'string', 'example' => 'basic'], + 'Status' => ['title' => '实例状态。'."\n" + .'● Initializing-初始化中'."\n" + .'● Stopped-停止服务'."\n" + .'● Running-运行中', 'description' => '实例状态。'."\n" + .'- Initializing-初始化中'."\n" + .'- Stopped-停止服务'."\n" + .'- Running-运行中', 'type' => 'string', 'example' => 'Initializing'], + 'RegionId' => ['title' => '区域ID。'."\n" + .'● cn-shenzhen - 深圳'."\n" + .'● cn-hangzhou - 杭州'."\n" + .'● cn-beijing - 北京'."\n" + .'● cn-shanghai - 上海', 'description' => '区域ID。'."\n" + .'- cn-shenzhen-深圳'."\n" + .'- cn-hangzhou- 杭州'."\n" + .'- cn-beijing - 北京'."\n" + .'- cn-shanghai- 上海', 'type' => 'string', 'example' => 'cn-shenzhen'], + 'GmtCreateTime' => ['title' => '实例创建时间。', 'description' => '实例创建时间。', 'type' => 'string', 'example' => '2022-10-13 17:34:52.0'], + 'GmtModifiedTime' => ['title' => '实例更新时间。', 'description' => '实例更新时间。', 'type' => 'string', 'example' => '2022-11-05 09:02:30.0'], + 'ExpiredTime' => ['title' => '实例过期时间。', 'description' => '实例过期时间。', 'type' => 'string', 'example' => '2022-12-14 00:00:00.0'], + 'CommodityCode' => ['title' => '实例所属的商品code。', 'description' => '实例所属的商品code。', 'type' => 'string', 'example' => 'airec_developers_public_cn'], + 'ChargeType' => ['title' => '实例的付费类型，目前仅支持Subscription（预付费）。', 'description' => '实例的付费类型，目前仅支持Subscription（预付费）。', 'type' => 'string', 'example' => 'Subscription'], + 'Config' => [ + 'title' => '实例配置。', + 'description' => '实例配置。', + 'type' => 'object', + 'properties' => [ + 'Engines' => [ + 'title' => '服务引擎列表。', + 'description' => '服务引擎列表。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'ComponentCode' => ['title' => '组件代码。', 'description' => '组件代码。', 'type' => 'string', 'example' => 'feature'], + 'Type' => ['title' => '组件类型。', 'description' => '组件类型。', 'type' => 'string', 'example' => 'Hologres'], + 'Meta' => ['title' => '元数据。', 'description' => '元数据。', 'type' => 'object'], + ], + 'description' => '', + ], + ], + 'Monitors' => [ + 'title' => '配套功能列表。', + 'description' => '配套功能列表。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'ComponentCode' => ['title' => '组件代码。', 'description' => '组件代码。', 'type' => 'string', 'example' => 'featuresets'], + 'Type' => ['title' => '组件类型。', 'description' => '组件类型。', 'type' => 'string', 'example' => 'Platform'], + 'Meta' => ['title' => '元数据。', 'description' => '元数据。', 'type' => 'object'], + ], + 'description' => '', + ], + ], + 'DataManagements' => [ + 'title' => '建模环境列表。', + 'description' => '建模环境列表。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'ComponentCode' => ['title' => '组件代码。', 'description' => '组件代码。', 'type' => 'string', 'example' => 'storage'], + 'Type' => ['title' => '组件类型。', 'description' => '组件类型。', 'type' => 'string', 'example' => 'OSS'], + 'Meta' => ['title' => '元数据。', 'description' => '元数据。', 'type' => 'object'], + ], + 'description' => '', + ], + ], + ], ], - 'GmtModifiedTime' => [ - 'title' => '更新时间。', - 'description' => '更新时间。', - 'type' => 'string', - 'example' => '2021-12-15T23:24:33.132+08:00', + 'OperatingTool' => [ + 'description' => '运营工具相关配置。', + 'type' => 'object', + 'properties' => [ + 'IsEnable' => ['description' => '实例是不是启用了运营工具，取值：'."\n" + .'- true 开启'."\n" + .'- false 未开启', 'type' => 'boolean', 'example' => 'true'], + ], ], ], + 'description' => '', ], ], + 'TotalCount' => ['title' => '列表内元素总数。', 'description' => '列表内元素总数。', 'type' => 'integer', 'format' => 'int32', 'example' => '7'], ], ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"BDB621CB-A81E-5D39-8793-39A365CBCC74\\",\\n \\"Instances\\": [\\n {\\n \\"InstanceId\\": \\"pairec-test1\\",\\n \\"Type\\": \\"basic\\",\\n \\"Status\\": \\"Initializing\\",\\n \\"RegionId\\": \\"cn-shenzhen\\",\\n \\"GmtCreateTime\\": \\"2022-10-13 17:34:52.0\\",\\n \\"GmtModifiedTime\\": \\"2022-11-05 09:02:30.0\\",\\n \\"ExpiredTime\\": \\"2022-12-14 00:00:00.0\\",\\n \\"CommodityCode\\": \\"airec_developers_public_cn\\",\\n \\"ChargeType\\": \\"Subscription\\",\\n \\"Config\\": {\\n \\"Engines\\": [\\n {\\n \\"ComponentCode\\": \\"feature\\",\\n \\"Type\\": \\"Hologres\\",\\n \\"Meta\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n }\\n }\\n ],\\n \\"Monitors\\": [\\n {\\n \\"ComponentCode\\": \\"featuresets\\",\\n \\"Type\\": \\"Platform\\",\\n \\"Meta\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n }\\n }\\n ],\\n \\"DataManagements\\": [\\n {\\n \\"ComponentCode\\": \\"storage\\",\\n \\"Type\\": \\"OSS\\",\\n \\"Meta\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n }\\n }\\n ]\\n },\\n \\"OperatingTool\\": {\\n \\"IsEnable\\": true\\n }\\n }\\n ],\\n \\"TotalCount\\": 7\\n}","type":"json"}]', + 'title' => '获取实例列表', + 'changeSet' => [ + ['createdAt' => '2024-08-05T08:37:23.000Z', 'description' => '响应参数发生变更'], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"A2D07551-38DA-531E-9B22-877D1D86A579\\",\\n \\"TotalCount\\": 10,\\n \\"Params\\": [\\n {\\n \\"ParamId\\": \\"4\\",\\n \\"Name\\": \\"home\\",\\n \\"Value\\": \\"house\\",\\n \\"Environment\\": \\"Daily\\",\\n \\"GmtModifiedTime\\": \\"2021-12-15T23:24:33.132+08:00\\"\\n }\\n ]\\n}","type":"json"}]', - 'title' => '获取参数列表', - ], - 'CreateCrowd' => [ - 'summary' => '创建一个人群，用于表示用户群体。', - 'path' => '/api/v1/crowds', - 'methods' => [ - 'post', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListInstances'], + ], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'pairec:ListInstances', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIRecService', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], ], + ], + 'ListLaboratories' => [ + 'summary' => '获取某个场景下的实验室列表。', + 'path' => '/api/v1/laboratories', + 'methods' => ['get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], - 'operationType' => 'write', + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'create', + 'operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATURElearnN0NAWV', - ], + 'abilityTreeNodes' => ['FEATURElearnN0NAWV'], ], 'parameters' => [ [ - 'name' => 'body', - 'in' => 'body', - 'style' => 'json', - 'schema' => [ - 'title' => '请求body。', - 'description' => '请求body。', - 'type' => 'object', - 'properties' => [ - 'InstanceId' => [ - 'title' => '实例ID。', - 'description' => '实例ID，可通过接口ListInstances获取。', - 'type' => 'string', - 'required' => true, - 'example' => 'pairec-cn-abcdefg1234', - ], - 'Name' => [ - 'title' => '人群名称。', - 'description' => '人群名称。', - 'type' => 'string', - 'required' => true, - 'example' => 'xx人群', - ], - 'Description' => [ - 'title' => '人群描述。', - 'description' => '人群描述。', - 'type' => 'string', - 'required' => true, - 'example' => 'This is a test.', - ], - 'Label' => [ - 'title' => '人群标签。', - 'description' => '人群标签。', - 'type' => 'string', - 'required' => false, - 'example' => 'os=android', - ], - 'Source' => [ - 'title' => '人群来源。'."\n" - .'● ManualInput-手工输入'."\n" - .'● UploadFile-文件上传', - 'description' => '人群来源。'."\n" - .'● ManualInput-手工输入'."\n" - .'● UploadFile-文件上传', - 'type' => 'string', - 'required' => false, - 'example' => 'ManualInput', - ], - 'Users' => [ - 'title' => '人群中包含的用户，多个用户间用逗号隔开。', - 'description' => '人群中包含的用户，多个用户间用逗号隔开。', - 'type' => 'string', - 'required' => false, - 'example' => 'user1,user2,user3', - ], - ], - 'required' => false, - ], + 'name' => 'Environment', + 'in' => 'query', + 'schema' => ['title' => '实验室所属的环境。'."\n" + .'● Daily-日常环境'."\n" + .'● Pre-预发环境'."\n" + .'● Prod-生产环境', 'description' => '实验室所属的环境。'."\n" + ."\n" + .'- Daily：日常环境'."\n" + .'- Pre：预发环境'."\n" + .'- Prod：生产环境', 'type' => 'string', 'required' => false, 'example' => 'Daily'], + ], + [ + 'name' => 'SceneId', + 'in' => 'query', + 'schema' => ['title' => '场景ID。', 'description' => '场景ID，可通过接口ListScenes获取。', 'type' => 'string', 'required' => true, 'example' => '3'], + ], + [ + 'name' => 'Status', + 'in' => 'query', + 'schema' => ['title' => '状态。'."\n" + .'● Offline-未上线。'."\n" + .'● Online-已上线。', 'description' => '状态。'."\n" + ."\n" + .'- Offline：未上线'."\n" + .'- Online：已上线', 'type' => 'string', 'required' => false, 'example' => 'Offline'], + ], + [ + 'name' => 'InstanceId', + 'in' => 'query', + 'schema' => ['title' => '实例ID。', 'description' => '实例ID，可通过接口ListInstances获取。', 'type' => 'string', 'required' => true, 'example' => 'pairec-test1'], ], ], 'responses' => [ @@ -10900,108 +10735,112 @@ 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'Id of the request', - 'type' => 'string', - 'example' => '59CE7EC6-F268-5D71-9215-32922CC50D72', - ], - 'CrowdId' => [ - 'title' => '人群ID。', - 'description' => '人群ID。', - 'type' => 'string', - 'example' => '3', + 'RequestId' => ['title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => '1C0898E5-9220-5443-B2D9-445FF0688215'], + 'TotalCount' => ['title' => '列表内元素总数。', 'description' => '列表内元素总数。', 'type' => 'integer', 'format' => 'int64', 'example' => '10'], + 'Laboratories' => [ + 'title' => '实验室列表。', + 'description' => '实验室列表。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'LaboratoryId' => ['title' => '实验室ID。', 'description' => '实验室ID。', 'type' => 'string', 'example' => '3'], + 'SceneId' => ['title' => '场景ID。', 'description' => '场景ID。', 'type' => 'string', 'example' => '3'], + 'Name' => ['title' => '实验室名称。', 'description' => '实验室名称。', 'type' => 'string', 'example' => 'laboratory1'], + 'Description' => ['title' => '实验室描述。', 'description' => '实验室描述。', 'type' => 'string', 'example' => 'This is a test.'], + 'DebugUsers' => ['title' => '调试用户。', 'description' => '调试用户。', 'type' => 'string', 'example' => 'user1,user2,user3'], + 'DebugCrowdId' => ['title' => '调试人群ID。', 'description' => '调试人群ID。', 'type' => 'string', 'example' => '3'], + 'BucketCount' => ['title' => '分桶数量。', 'description' => '分桶数量。', 'type' => 'integer', 'format' => 'int32', 'example' => '100'], + 'Buckets' => ['title' => '分配桶号。', 'description' => '分配桶号。', 'type' => 'string', 'example' => '1,2,3,10-20'], + 'BucketType' => ['title' => '分桶方式。'."\n" + .'● Uid-UID分桶（默认）'."\n" + .'● UidHash-UID哈希'."\n" + .'● Filter-过滤条件分桶', 'description' => '分桶方式。'."\n" + ."\n" + .'- Uid-UID：分桶（默认）'."\n" + .'- UidHash：UID哈希'."\n" + .'- Filter：过滤条件分桶', 'type' => 'string', 'example' => 'Filter'], + 'Filter' => ['title' => '过滤条件。', 'description' => '过滤条件。', 'type' => 'string', 'example' => 'filter=xxx'], + 'Environment' => ['title' => '运行环境'."\n" + .'● Daily-日常环境'."\n" + .'● Pre-预发环境'."\n" + .'● Prod-生产环境', 'description' => '运行环境'."\n" + ."\n" + .'- Daily：日常环境'."\n" + .'- Pre：预发环境'."\n" + .'- Prod：生产环境', 'type' => 'string', 'example' => 'Daily'], + 'Type' => ['title' => '实验室类型'."\n" + .'● Base'."\n" + .'● NonBase', 'description' => '实验室类型'."\n" + ."\n" + .'- Base'."\n" + .'- NonBase', 'type' => 'string', 'example' => 'Base'], + 'Status' => ['title' => '状态。'."\n" + .'● Offline-未上线。'."\n" + .'● Online-已上线。', 'description' => '状态。'."\n" + ."\n" + .'- Offline：未上线'."\n" + .'- Online：已上线', 'type' => 'string', 'example' => 'Offline'], + 'CrowdId' => ['title' => '人群ID。', 'description' => '人群ID。', 'type' => 'string', 'example' => '3'], + ], + 'description' => '', + ], ], ], ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '获取实验室列表', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'pairec:ListLaboratories', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIRecService', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"59CE7EC6-F268-5D71-9215-32922CC50D72\\",\\n \\"CrowdId\\": \\"3\\"\\n}","type":"json"}]', - 'title' => '创建人群', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1C0898E5-9220-5443-B2D9-445FF0688215\\",\\n \\"TotalCount\\": 10,\\n \\"Laboratories\\": [\\n {\\n \\"LaboratoryId\\": \\"3\\",\\n \\"SceneId\\": \\"3\\",\\n \\"Name\\": \\"laboratory1\\",\\n \\"Description\\": \\"This is a test.\\",\\n \\"DebugUsers\\": \\"user1,user2,user3\\",\\n \\"DebugCrowdId\\": \\"3\\",\\n \\"BucketCount\\": 100,\\n \\"Buckets\\": \\"1,2,3,10-20\\",\\n \\"BucketType\\": \\"Filter\\",\\n \\"Filter\\": \\"filter=xxx\\",\\n \\"Environment\\": \\"Daily\\",\\n \\"Type\\": \\"Base\\",\\n \\"Status\\": \\"Offline\\",\\n \\"CrowdId\\": \\"3\\"\\n }\\n ]\\n}","type":"json"}]', ], - 'CreateSubCrowd' => [ - 'summary' => '在指定人群下创建子人群。', - 'path' => '/api/v1/crowds/{CrowdId}/subcrowds', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'ListLayers' => [ + 'path' => '/api/v1/layers', + 'methods' => ['get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], - 'operationType' => 'write', + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'create', + 'operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATURElearnN0NAWV', - ], + 'abilityTreeCode' => '183174', + 'abilityTreeNodes' => ['FEATURElearnN0NAWV'], ], 'parameters' => [ [ - 'name' => 'CrowdId', - 'in' => 'path', - 'schema' => [ - 'title' => '人群ID。', - 'description' => '人群ID，可通过接口ListCrowds获取。', - 'type' => 'string', - 'required' => true, - 'example' => '3', - ], + 'name' => 'LaboratoryId', + 'in' => 'query', + 'schema' => ['title' => '实验室ID。', 'description' => '实验室ID，可通过接口ListLaboratories获取。', 'type' => 'string', 'required' => true, 'example' => '3'], ], [ - 'name' => 'body', - 'in' => 'body', - 'style' => 'json', - 'schema' => [ - 'title' => '请求body。', - 'description' => '请求body。', - 'type' => 'object', - 'properties' => [ - 'Source' => [ - 'title' => '人群来源。'."\n" - .'● ManualInput-手工输入'."\n" - .'● UploadFile-文件上传', - 'description' => '人群来源。'."\n" - .'● ManualInput-手工输入'."\n" - .'● UploadFile-文件上传', - 'type' => 'string', - 'required' => true, - 'example' => 'ManualInput', - ], - 'Users' => [ - 'title' => '人群中包含的用户，多个用户间用逗号隔开。', - 'description' => '人群中包含的用户，多个用户间用逗号隔开。', - 'type' => 'string', - 'required' => true, - 'example' => 'user1,user2,user3', - ], - 'InstanceId' => [ - 'title' => '实例ID。', - 'description' => '实例ID，可通过接口ListInstances获取。', - 'type' => 'string', - 'required' => true, - 'example' => 'pairec-test1', - ], - ], - 'required' => false, - ], + 'name' => 'InstanceId', + 'in' => 'query', + 'schema' => ['title' => '实例ID。', 'description' => '实例ID，可通过接口ListInstances获取。', 'type' => 'string', 'required' => true, 'example' => 'pairec-cn-abcdefg1234'], ], ], 'responses' => [ @@ -11011,81 +10850,115 @@ 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'Id of the request', - 'type' => 'string', - 'example' => '9763624B-5FBB-5E3A-9193-B1ADB554CEAE', - ], - 'SubCrowdId' => [ - 'title' => '子人群ID。', - 'description' => '子人群ID。', - 'type' => 'string', - 'example' => '3', + 'RequestId' => ['title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => '518C64F6-DFF7-11ED-85B0-00163E14B3D1'], + 'TotalCount' => ['title' => '列表内元素总数。', 'description' => '列表内元素总数。', 'type' => 'integer', 'format' => 'int64', 'example' => '10'], + 'Layers' => [ + 'title' => '层列表。', + 'description' => '层列表。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'LayerId' => ['title' => '层ID。', 'description' => '层ID。', 'type' => 'string', 'example' => '3'], + 'LaboratoryId' => ['title' => '实验室ID。', 'description' => '实验室ID。', 'type' => 'string', 'example' => '3'], + 'SceneId' => ['title' => '场景ID。', 'description' => '场景ID。', 'type' => 'string', 'example' => '3'], + 'Name' => ['title' => '层名称。', 'description' => '层名称。', 'type' => 'string', 'example' => 'layer1'], + 'Description' => ['title' => '层描述。', 'description' => '层描述。', 'type' => 'string', 'example' => 'This is a test.'], + 'ResidualFlow' => ['description' => '当前实验层剩余的流量。', 'type' => 'integer', 'format' => 'int64', 'example' => '10'], + 'GmtCreateTime' => ['description' => '创建时间。', 'type' => 'string', 'example' => '2024-05-30T02:02:28.000Z'], + ], + 'description' => '', + ], ], ], ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '获取层列表', + 'summary' => '获取某个实验室下的层列表。', + 'changeSet' => [ + ['createdAt' => '2024-03-20T06:05:19.000Z', 'description' => '响应参数发生变更'], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"9763624B-5FBB-5E3A-9193-B1ADB554CEAE\\",\\n \\"SubCrowdId\\": \\"3\\"\\n}","type":"json"}]', - 'title' => '创建子人群', - ], - 'DeleteCrowd' => [ - 'summary' => '删除指定人群。', - 'path' => '/api/v1/crowds/{CrowdId}', - 'methods' => [ - 'delete', + 'flowControl' => [ + 'flowControlList' => [], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'pairec:ListLayers', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIRecService', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"518C64F6-DFF7-11ED-85B0-00163E14B3D1\\",\\n \\"TotalCount\\": 10,\\n \\"Layers\\": [\\n {\\n \\"LayerId\\": \\"3\\",\\n \\"LaboratoryId\\": \\"3\\",\\n \\"SceneId\\": \\"3\\",\\n \\"Name\\": \\"layer1\\",\\n \\"Description\\": \\"This is a test.\\",\\n \\"ResidualFlow\\": 10,\\n \\"GmtCreateTime\\": \\"2024-05-30T02:02:28.000Z\\"\\n }\\n ]\\n}","type":"json"}]', + ], + 'ListParams' => [ + 'path' => '/api/v1/params', + 'methods' => ['get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], - 'operationType' => 'write', + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'delete', + 'operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATURElearnN0NAWV', - ], + 'abilityTreeNodes' => ['FEATURElearnN0NAWV'], ], 'parameters' => [ [ - 'name' => 'CrowdId', - 'in' => 'path', - 'schema' => [ - 'title' => '人群ID。', - 'description' => '人群ID，可通过接口ListCrowds获取。', - 'type' => 'string', - 'required' => true, - 'example' => '3', - ], + 'name' => 'SceneId', + 'in' => 'query', + 'schema' => ['title' => '场景ID。', 'description' => '场景ID，可通过接口ListScenes获取。', 'type' => 'string', 'required' => true, 'example' => '3'], + ], + [ + 'name' => 'Name', + 'in' => 'query', + 'schema' => ['title' => '参数名称。', 'description' => '参数名称。', 'type' => 'string', 'required' => false, 'example' => 'home'], + ], + [ + 'name' => 'Environment', + 'in' => 'query', + 'schema' => ['title' => '参数所属的环境。'."\n" + .'● Daily-日常环境'."\n" + .'● Pre-预发环境'."\n" + .'● Prod-生产环境', 'description' => '参数所属的环境。'."\n" + ."\n" + .'- Daily：日常环境'."\n" + .'- Pre：预发环境'."\n" + .'- Prod：生产环境', 'type' => 'string', 'required' => false, 'example' => 'Daily'], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => ['title' => '页码。', 'description' => '页码。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1'], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => ['title' => '页大小。', 'description' => '页大小。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '50'], ], [ 'name' => 'InstanceId', 'in' => 'query', - 'schema' => [ - 'title' => '实例ID。', - 'description' => '实例ID，可通过接口ListInstances获取。', - 'type' => 'string', - 'required' => true, - 'example' => 'pairec-cn-abcdefg1234', - ], + 'schema' => ['title' => '实例ID。', 'description' => '实例ID，可通过接口ListInstances获取。', 'type' => 'string', 'required' => true, 'example' => 'pairec-cn-abcdefg1234'], + ], + [ + 'name' => 'Encrypted', + 'in' => 'query', + 'schema' => ['type' => 'boolean', 'required' => false, 'description' => ''], ], ], 'responses' => [ @@ -11095,86 +10968,125 @@ 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'Id of the request', - 'type' => 'string', - 'example' => 'A04CB8C0-E74A-5E83-BC61-64D153574EC7', + 'RequestId' => ['title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => 'A2D07551-38DA-531E-9B22-877D1D86A579'], + 'TotalCount' => ['title' => '列表内元素总数。', 'description' => '列表内元素总数。', 'type' => 'integer', 'format' => 'int64', 'example' => '10'], + 'Params' => [ + 'title' => '参数列表。', + 'description' => '参数列表。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'ParamId' => ['title' => '参数ID。', 'description' => '参数ID。', 'type' => 'string', 'example' => '4'], + 'Name' => ['title' => '参数名称。', 'description' => '参数名称。', 'type' => 'string', 'example' => 'home'], + 'Value' => ['title' => '参数值。', 'description' => '参数值。', 'type' => 'string', 'example' => 'house'], + 'Environment' => ['title' => '参数所属的环境。'."\n" + .'● Daily-日常环境'."\n" + .'● Prepub-预发环境'."\n" + .'● Product-生产环境', 'description' => '参数所属的环境。'."\n" + ."\n" + .'- Daily：日常环境'."\n" + .'- Prepub：预发环境'."\n" + .'- Product：生产环境', 'type' => 'string', 'example' => 'Daily'], + 'GmtModifiedTime' => ['title' => '更新时间。', 'description' => '更新时间。', 'type' => 'string', 'example' => '2021-12-15T23:24:33.132+08:00'], + ], + 'description' => '', + ], ], ], ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '获取参数列表', + 'summary' => '获取参数列表。', + 'changeSet' => [ + ['createdAt' => '2025-07-02T01:39:45.000Z', 'description' => '请求参数发生变更'], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"A04CB8C0-E74A-5E83-BC61-64D153574EC7\\"\\n}","type":"json"}]', - 'title' => '删除人群', - ], - 'DeleteSubCrowd' => [ - 'summary' => '删除指定子人群。', - 'path' => '/api/v1/crowds/{CrowdId}/subcrowds/{SubCrowdId}', - 'methods' => [ - 'delete', + 'flowControl' => [ + 'flowControlList' => [], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'pairec:ListParams', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIRecService', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"A2D07551-38DA-531E-9B22-877D1D86A579\\",\\n \\"TotalCount\\": 10,\\n \\"Params\\": [\\n {\\n \\"ParamId\\": \\"4\\",\\n \\"Name\\": \\"home\\",\\n \\"Value\\": \\"house\\",\\n \\"Environment\\": \\"Daily\\",\\n \\"GmtModifiedTime\\": \\"2021-12-15T23:24:33.132+08:00\\"\\n }\\n ]\\n}","type":"json"}]', + ], + 'ListRecallManagementJobs' => [ + 'summary' => '查询指定条件下的召回管理任务列表。', + 'path' => '/api/v1/recallmanagementjobs', + 'methods' => ['get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], - 'operationType' => 'write', + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'delete', + 'operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATURElearnN0NAWV', - ], + 'abilityTreeNodes' => ['FEATURElearnN0NAWV'], ], 'parameters' => [ [ - 'name' => 'CrowdId', - 'in' => 'path', - 'schema' => [ - 'title' => '人群ID。', - 'description' => '人群ID，可通过接口ListCrowds获取。', - 'type' => 'string', - 'required' => true, - 'example' => '3', - ], + 'name' => 'InstanceId', + 'in' => 'query', + 'schema' => ['description' => '**实例 ID。**'."\n", 'type' => 'string', 'required' => false, 'example' => 'pairec-test1'], ], [ - 'name' => 'SubCrowdId', - 'in' => 'path', - 'schema' => [ - 'title' => '子人群ID。', - 'description' => '子人群ID，可通过接口ListSubCrowds获取。', - 'type' => 'string', - 'required' => true, - 'example' => '3', - ], + 'name' => 'Type', + 'in' => 'query', + 'schema' => ['description' => '**任务类型**'."\n", 'type' => 'string', 'required' => false, 'example' => 'Table'], ], [ - 'name' => 'InstanceId', + 'name' => 'Condition', 'in' => 'query', - 'schema' => [ - 'title' => '实例ID。', - 'description' => '实例ID，可通过接口ListInstances获取。', - 'type' => 'string', - 'required' => true, - 'example' => 'pairec-cn-abcdefg1234', - ], + 'style' => 'flat', + 'schema' => ['description' => '**过滤条件**，目前仅有Table类型的过滤条件，如：`{"RecallManagementTableId":"1"}`'."\n", 'type' => 'object', 'required' => false, 'example' => '{"RecallManagementTableId":"1"}'], + ], + [ + 'name' => 'SortBy', + 'in' => 'query', + 'schema' => ['description' => '**排序依据**。`GmtCreateTime`-创建时间。`GmtModifiedTime`-更新时间。'."\n", 'type' => 'string', 'required' => false, 'example' => 'GmtCreateTime'], + ], + [ + 'name' => 'Order', + 'in' => 'query', + 'schema' => ['description' => '**排序方式**。`ASC`-升序。`DESC`-降序。'."\n", 'type' => 'string', 'required' => false, 'example' => 'ASC'], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => ['description' => '**页码。**'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1'], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => ['description' => '页大小。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10'], + ], + [ + 'name' => 'MaxResults', + 'in' => 'query', + 'schema' => ['description' => '暂不生效。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '0'], + ], + [ + 'name' => 'NextToken', + 'in' => 'query', + 'schema' => ['description' => '暂不生效。', 'type' => 'string', 'required' => false, 'example' => '""'], ], ], 'responses' => [ @@ -11184,97 +11096,126 @@ 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'Id of the request', - 'type' => 'string', - 'example' => 'EE97D06A-2AA0-5AD9-B6CF-8A267924D691', + 'RequestId' => ['title' => 'Id of the request', 'description' => '请求id。', 'type' => 'string', 'example' => '728C5E01-ABF6-5AA8-B9FC-B3BA05DECC77'], + 'TotalCount' => ['description' => '总个数。', 'type' => 'string', 'example' => '30'], + 'RecallManagementJobs' => [ + 'description' => '同步任务列表。'."\n", + 'type' => 'array', + 'items' => [ + 'description' => '同步任务详情。', + 'type' => 'object', + 'properties' => [ + 'RecallManagementJobId' => ['description' => '同步任务ID。'."\n", 'type' => 'string', 'example' => '1'], + 'RecallManagerTableInfo' => [ + 'description' => '废弃。', + 'type' => 'object', + 'properties' => [ + 'RecallManagementTableVersionId' => ['description' => '废弃。', 'type' => 'string', 'example' => '2'], + 'DataVersion' => ['description' => '废弃。', 'type' => 'string', 'example' => 'ds=20250701'], + 'SourceTableRowCount' => ['description' => '废弃。', 'type' => 'string', 'example' => '100'], + 'SourceTableDataSize' => ['description' => '废弃。', 'type' => 'string', 'example' => '1000'], + ], + ], + 'Status' => ['description' => '状态，枚举值：`Init`：初始化。`Running`：运行中`Success`：成功`Failed`：失败'."\n", 'type' => 'string', 'example' => 'Running'], + 'StartTime' => ['description' => '任务开始时间。', 'type' => 'string', 'example' => '2025-01-28T10:00:00Z'], + 'EndTime' => ['description' => '任务结束时间。', 'type' => 'string', 'example' => '2025-03-28T10:24Z'], + 'RecallManagementTableInfo' => [ + 'description' => '召回管理表任务信息。', + 'type' => 'object', + 'properties' => [ + 'RecallManagementTableVersionId' => ['description' => '表版本 ID。', 'type' => 'string', 'example' => '2'], + 'DataVersion' => ['description' => '数据版本号。', 'type' => 'string', 'example' => 'ds=20250701'], + 'SourceTableRowCount' => ['description' => '源表数据行数。', 'type' => 'string', 'example' => '100'], + 'SourceTableDataSize' => ['description' => '源表数据大小。', 'type' => 'string', 'example' => '100'], + ], + ], + ], + ], ], + 'NextToken' => ['description' => '暂不生效。', 'type' => 'string', 'example' => '""'], + 'MaxResults' => ['description' => '暂不生效。', 'type' => 'integer', 'format' => 'int32', 'example' => '0'], ], ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '获取召回管理任务列表', + 'description' => '## 请求说明'."\n" + .'- 本接口用于获取召回管理任务的列表信息。'."\n" + .'- `InstanceId` 和 `Type` 是必填参数，其他为可选参数。'."\n" + .'- `Condition` 参数支持对特定表类型的过滤条件进行设置，例如通过 `RecallManagementTableId` 进行筛选。'."\n" + .'- 可以使用 `SortBy` 和 `Order` 参数来控制返回结果的排序方式，默认按照创建时间升序排列。'."\n" + .'- 分页功能通过 `PageNumber` 和 `PageSize` 参数实现，其中 `PageNumber` 默认值为1，`PageSize` 默认值为10。'."\n" + .'- 返回的数据中包含每个召回管理任务的基本信息及其状态等详细内容。'."\n", + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'pairec:ListRecallManagementJobs', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIRecService', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"EE97D06A-2AA0-5AD9-B6CF-8A267924D691\\"\\n}","type":"json"}]', - 'title' => '删除子人群', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"728C5E01-ABF6-5AA8-B9FC-B3BA05DECC77\\",\\n \\"TotalCount\\": \\"30\\",\\n \\"RecallManagementJobs\\": [\\n {\\n \\"RecallManagementJobId\\": \\"1\\",\\n \\"RecallManagerTableInfo\\": {\\n \\"RecallManagementTableVersionId\\": \\"2\\",\\n \\"DataVersion\\": \\"ds=20250701\\",\\n \\"SourceTableRowCount\\": \\"100\\",\\n \\"SourceTableDataSize\\": \\"1000\\"\\n },\\n \\"Status\\": \\"Running\\",\\n \\"StartTime\\": \\"2025-01-28T10:00:00Z\\",\\n \\"EndTime\\": \\"2025-03-28T10:24Z\\",\\n \\"RecallManagementTableInfo\\": {\\n \\"RecallManagementTableVersionId\\": \\"2\\",\\n \\"DataVersion\\": \\"ds=20250701\\",\\n \\"SourceTableRowCount\\": \\"100\\",\\n \\"SourceTableDataSize\\": \\"100\\"\\n }\\n }\\n ],\\n \\"NextToken\\": \\"\\\\\\"\\\\\\"\\",\\n \\"MaxResults\\": 0\\n}","type":"json"}]', ], - 'UpdateCrowd' => [ - 'summary' => '更新指定人群信息，例如更新人群的名称、描述。', - 'path' => '/api/v1/crowds/{CrowdId}', - 'methods' => [ - 'put', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'ListRecallManagementServiceVersions' => [ + 'summary' => '获取指定召回管理服务下的所有版本信息。', + 'path' => '/api/v1/recallmanagementservices/{RecallManagementServiceId}/versions', + 'methods' => ['get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], - 'operationType' => 'readAndWrite', + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'update', + 'operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATURElearnN0NAWV', - ], + 'abilityTreeNodes' => ['FEATURElearnN0NAWV'], ], 'parameters' => [ [ - 'name' => 'body', - 'in' => 'body', - 'style' => 'json', - 'schema' => [ - 'description' => '请求body。', - 'type' => 'object', - 'properties' => [ - 'Name' => [ - 'title' => '人群名称。', - 'description' => '人群名称。', - 'type' => 'string', - 'required' => true, - 'example' => 'xx人群', - ], - 'Description' => [ - 'title' => '人群描述。', - 'description' => '人群描述。', - 'type' => 'string', - 'required' => true, - 'example' => 'This is a test.', - ], - 'InstanceId' => [ - 'title' => '实例ID。', - 'description' => '实例ID，可通过接口ListInstances获取。', - 'type' => 'string', - 'required' => true, - 'example' => 'pairec-test1', - ], - ], - 'required' => false, - ], + 'name' => 'RecallManagementServiceId', + 'in' => 'path', + 'schema' => ['description' => '数据表ID。'."\n", 'type' => 'string', 'required' => false, 'example' => '3'], ], [ - 'name' => 'CrowdId', - 'in' => 'path', - 'schema' => [ - 'title' => '人群ID。', - 'description' => '人群ID，可通过接口ListCrowds获取。', - 'type' => 'string', - 'required' => true, - 'example' => '3', - ], + 'name' => 'InstanceId', + 'in' => 'query', + 'schema' => ['description' => '实例ID。'."\n", 'type' => 'string', 'required' => false, 'example' => 'pairec-cn-test123'], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => ['description' => '页码。'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1'], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => ['description' => '页大小。'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '50'], + ], + [ + 'name' => 'SortBy', + 'in' => 'query', + 'schema' => ['description' => '排序依据。GmtCreateTime-创建时间。GmtModifiedTime-更新时间。'."\n", 'type' => 'string', 'required' => false, 'example' => 'GmtCreateTime'], + ], + [ + 'name' => 'Order', + 'in' => 'query', + 'schema' => ['description' => '排序方式。ASC-升序。DESC-降序。'."\n", 'type' => 'string', 'required' => false, 'example' => 'ASC'], ], ], 'responses' => [ @@ -11284,64 +11225,112 @@ 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'Id of the request', - 'type' => 'string', - 'example' => '8C27790E-CCA5-56BB-BA17-646295DEC0A2', + 'RequestId' => ['title' => 'Id of the request', 'description' => '请求id。'."\n", 'type' => 'string', 'example' => '728C5E01-ABF6-5AA8-B9FC-B3BA05DECC77'], + 'TotalCount' => ['description' => '返回总个数。', 'type' => 'string', 'example' => '30'], + 'RecallManagementServiceVersions' => [ + 'description' => '召回管理服务版本列表。', + 'type' => 'array', + 'items' => [ + 'description' => '召回管理服务版本详情。', + 'type' => 'object', + 'properties' => [ + 'RecallManagementServiceVersionId' => ['description' => '召回管理服务版本ID。', 'type' => 'string', 'example' => '1'], + 'Name' => ['description' => '召回管理服务版本名称。'."\n", 'type' => 'string', 'example' => 'version-1'], + 'IsEffective' => ['title' => '版本是否生效。', 'description' => '版本是否生效。', 'type' => 'boolean'], + 'GmtCreateTime' => ['description' => '创建时间。'."\n", 'type' => 'string', 'example' => '2021-12-15T23:24:33.132+08:00'], + 'GmtModifiedTime' => ['description' => '更新时间。'."\n", 'type' => 'string', 'example' => '2021-12-15T23:24:33.132+08:00'], + ], + ], ], ], ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '召回管理服务版本列表', + 'description' => '## 请求说明'."\n" + .'通过此API，您可以查询特定召回管理服务的所有版本详情，包括版本ID、名称、是否生效状态以及创建和修改时间等信息。请确保提供正确的`RecallManagementServiceId`与`InstanceId`以获取准确的数据。'."\n" + ."\n" + .'- `PageNumber` 和 `PageSize` 参数用于分页控制，默认从第一页开始，每页显示50条记录。'."\n" + .'- 使用 `SortBy` 参数可按创建时间或更新时间对结果进行排序，默认按照创建时间升序排列。'."\n" + .'- `Order` 参数定义了排序方式，支持升序（ASC）和降序（DESC）两种模式。'."\n", + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'pairec:ListRecallManagementServiceVersions', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIRecService', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"8C27790E-CCA5-56BB-BA17-646295DEC0A2\\"\\n}","type":"json"}]', - 'title' => '更新人群', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"728C5E01-ABF6-5AA8-B9FC-B3BA05DECC77\\",\\n \\"TotalCount\\": \\"30\\",\\n \\"RecallManagementServiceVersions\\": [\\n {\\n \\"RecallManagementServiceVersionId\\": \\"1\\",\\n \\"Name\\": \\"version-1\\",\\n \\"IsEffective\\": true,\\n \\"GmtCreateTime\\": \\"2021-12-15T23:24:33.132+08:00\\",\\n \\"GmtModifiedTime\\": \\"2021-12-15T23:24:33.132+08:00\\"\\n }\\n ]\\n}","type":"json"}]', ], - 'ListCrowds' => [ - 'summary' => '获取人群列表。', - 'path' => '/api/v1/crowds', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'ListRecallManagementServices' => [ + 'path' => '/api/v1/recallmanagementservices', + 'methods' => ['get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATURElearnN0NAWV', - ], + 'abilityTreeNodes' => ['FEATURElearnN0NAWV'], ], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'query', - 'schema' => [ - 'title' => '实例ID。', - 'description' => '实例ID，可通过接口ListInstances获取。', - 'type' => 'string', - 'required' => true, - 'example' => 'pairec-cn-abcdefg1234', - ], + 'schema' => ['description' => '**实例ID。**'."\n", 'type' => 'string', 'required' => false, 'example' => 'pairec-cn-test123'], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => ['description' => '**页码。**'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1'], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => ['description' => '**页大小。**'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '50'], + ], + [ + 'name' => 'SortBy', + 'in' => 'query', + 'schema' => ['description' => '**排序依据。** '."\n" + .'- GmtCreateTime-创建时间。'."\n" + .'- GmtModifiedTime-更新时间。'."\n", 'type' => 'string', 'required' => false, 'example' => 'GmtCreateTime'], + ], + [ + 'name' => 'Order', + 'in' => 'query', + 'schema' => ['description' => '**排序方式。** '."\n" + .'- ASC-升序。'."\n" + .'- DESC-降序。'."\n", 'type' => 'string', 'required' => false, 'example' => 'ASC'], + ], + [ + 'name' => 'MaxResults', + 'in' => 'query', + 'schema' => ['description' => '暂不生效。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '""'], + ], + [ + 'name' => 'NextToken', + 'in' => 'query', + 'schema' => ['description' => '暂不生效。', 'type' => 'string', 'required' => false, 'example' => '0'], ], ], 'responses' => [ @@ -11351,145 +11340,100 @@ 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'Id of the request', - 'type' => 'string', - 'example' => '9763624B-5FBB-5E3A-9193-B1ADB554CEAE', - ], - 'TotalCount' => [ - 'title' => '列表内元素总数。', - 'description' => '列表内元素总数。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '10', - ], - 'Crowds' => [ - 'title' => '人群列表。', - 'description' => '人群列表。', + 'RequestId' => ['title' => 'Id of the request', 'description' => '请求id。'."\n", 'type' => 'string', 'example' => '728C5E01-ABF6-5AA8-B9FC-B3BA05DECC77'], + 'TotalCount' => ['description' => '总个数。'."\n", 'type' => 'string', 'example' => '10'], + 'RecallManagementServices' => [ + 'description' => '召回管理服务列表。', 'type' => 'array', 'items' => [ + 'description' => '召回管理服务详情。', 'type' => 'object', 'properties' => [ - 'CrowdId' => [ - 'title' => '人群ID。', - 'description' => '人群ID。', - 'type' => 'string', - 'example' => '3', - ], - 'Name' => [ - 'title' => '人群名称。', - 'description' => '人群名称。', - 'type' => 'string', - 'example' => 'crowd1', - ], - 'Description' => [ - 'title' => '人群描述。', - 'description' => '人群描述。', - 'type' => 'string', - 'example' => 'This is a test.', - ], - 'Label' => [ - 'title' => '人群标签。', - 'description' => '人群标签。', - 'type' => 'string', - 'example' => 'os=android', - ], - 'Source' => [ - 'title' => '人群来源。'."\n" - .'● ManualInput-手工输入'."\n" - .'● UploadFile-文件上传', - 'description' => '人群来源。'."\n" - ."\n" - .'- ManualInput：手工输入'."\n" - .'- UploadFile：文件上传', - 'type' => 'string', - 'example' => 'ManualInput', - ], - 'Quantity' => [ - 'title' => '数量。', - 'description' => '数量。', - 'type' => 'string', - 'example' => '10', - ], - 'Users' => [ - 'title' => '人群内包含的用户，多个用户间以逗号隔开。', - 'description' => '人群内包含的用户，多个用户间以逗号隔开。', - 'type' => 'string', - 'example' => 'user1,user2', - ], - 'GmtCreateTime' => [ - 'title' => '人群创建时间。', - 'description' => '人群创建时间。', - 'type' => 'string', - 'example' => '2021-12-15T23:24:33.132+08:00', - ], + 'RecallManagementServiceId' => ['description' => '召回管理服务ID。'."\n", 'type' => 'string', 'example' => '3'], + 'Name' => ['description' => '召回管理服务名称。'."\n", 'type' => 'string', 'example' => 'hot_group_recall'], + 'Description' => ['description' => '召回管理服务描述。'."\n", 'type' => 'string', 'example' => 'this is a test recall'], + 'CurrentRecallManagementServiceVersionId' => ['description' => '当前生效的召回管理服务版本ID。'."\n", 'type' => 'string', 'example' => '1'], + 'CurrentRecallManagementServiceVersionName' => ['description' => '当前生效的召回管理服务版本名称。'."\n", 'type' => 'string', 'example' => 'version-1'], + 'Status' => ['description' => '状态，枚举值：'."\n" + .'- Online：在线。'."\n" + .'- Offline：离线。'."\n", 'type' => 'string', 'example' => 'Online'], + 'GmtCreateTime' => ['description' => '创建时间。'."\n", 'type' => 'string', 'example' => '2021-12-15T23:24:33.132+08:00'], + 'GmtModifiedTime' => ['description' => '更新时间。'."\n", 'type' => 'string', 'example' => '2021-12-15T23:24:33.132+08:00'], ], ], ], + 'NextToken' => ['description' => '暂不生效。', 'type' => 'string', 'example' => '""'], + 'MaxResults' => ['description' => '暂不生效。', 'type' => 'integer', 'format' => 'int32', 'example' => '0'], ], ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '获取召回管理服务列表', + 'summary' => '此API用于查询指定实例下的召回管理服务列表。', + 'description' => '## 请求说明'."\n" + .'通过调用`ListRecallManagementServices`接口，您可以根据给定的参数（如InstanceId, PageNumber, PageSize等）来获取特定实例下的召回管理服务列表。支持按照创建时间或更新时间进行排序，并且可以选择升序或降序展示结果。'."\n" + ."\n" + .'- **InstanceId** 是必填项，用来指定要查询的服务属于哪个实例。'."\n" + .'- 分页参数**PageNumber**和**PageSize**允许您控制返回数据的数量及从哪一页开始显示，默认情况下会返回第一页的数据。'."\n" + .'- 使用**SortBy**与**Order**参数可以自定义列表的排序方式。'."\n", + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"9763624B-5FBB-5E3A-9193-B1ADB554CEAE\\",\\n \\"TotalCount\\": 10,\\n \\"Crowds\\": [\\n {\\n \\"CrowdId\\": \\"3\\",\\n \\"Name\\": \\"crowd1\\",\\n \\"Description\\": \\"This is a test.\\",\\n \\"Label\\": \\"os=android\\",\\n \\"Source\\": \\"ManualInput\\",\\n \\"Quantity\\": \\"10\\",\\n \\"Users\\": \\"user1,user2\\",\\n \\"GmtCreateTime\\": \\"2021-12-15T23:24:33.132+08:00\\"\\n }\\n ]\\n}","type":"json"}]', - 'title' => '获取人群列表', + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"728C5E01-ABF6-5AA8-B9FC-B3BA05DECC77\\",\\n \\"TotalCount\\": \\"10\\",\\n \\"RecallManagementServices\\": [\\n {\\n \\"RecallManagementServiceId\\": \\"3\\",\\n \\"Name\\": \\"hot_group_recall\\",\\n \\"Description\\": \\"this is a test recall\\",\\n \\"CurrentRecallManagementServiceVersionId\\": \\"1\\",\\n \\"CurrentRecallManagementServiceVersionName\\": \\"version-1\\",\\n \\"Status\\": \\"Online\\",\\n \\"GmtCreateTime\\": \\"2021-12-15T23:24:33.132+08:00\\",\\n \\"GmtModifiedTime\\": \\"2021-12-15T23:24:33.132+08:00\\"\\n }\\n ],\\n \\"NextToken\\": \\"\\\\\\"\\\\\\"\\",\\n \\"MaxResults\\": 0\\n}","type":"json"}]', ], - 'ListCrowdUsers' => [ - 'summary' => '获取指定人群所包含的所有用户，包括人群下的子人群内的用户。', - 'path' => '/api/v1/crowds/{CrowdId}/users', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'ListRecallManagementTableVersions' => [ + 'summary' => '此API用于查询指定召回管理表的所有版本信息。', + 'path' => '/api/v1/recallmanagementtables/{RecallManagementTableId}/versions', + 'methods' => ['get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'list', + 'operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATURElearnN0NAWV', - ], + 'abilityTreeNodes' => ['FEATURElearnN0NAWV'], ], 'parameters' => [ [ - 'name' => 'CrowdId', + 'name' => 'RecallManagementTableId', 'in' => 'path', - 'schema' => [ - 'title' => '人群ID。', - 'description' => '人群ID，可通过接口ListCrowds获取。', - 'type' => 'string', - 'required' => true, - 'example' => '1', - ], + 'schema' => ['description' => '表ID。'."\n", 'type' => 'string', 'required' => true, 'example' => '1'], ], [ 'name' => 'InstanceId', 'in' => 'query', - 'schema' => [ - 'title' => '实例ID。', - 'description' => '实例ID，可通过接口ListInstances获取。', - 'type' => 'string', - 'required' => true, - 'example' => 'pairec-cn-abcdefg1234', - ], + 'schema' => ['description' => '实例ID。'."\n", 'type' => 'string', 'required' => true, 'example' => 'pairec-1324***'], + ], + [ + 'name' => 'SortBy', + 'in' => 'query', + 'schema' => ['description' => '排序依据。`GmtCreateTime`-创建时间。`GmtModifiedTime`-更新时间。'."\n", 'type' => 'string', 'required' => false, 'example' => 'GmtCreateTime'], + ], + [ + 'name' => 'Order', + 'in' => 'query', + 'schema' => ['description' => '排序方式。`ASC`-升序。`DESC`-降序。'."\n", 'type' => 'string', 'required' => false, 'example' => 'ASC'], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => ['description' => '页码。'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1'], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => ['description' => '页大小。'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10'], ], ], 'responses' => [ @@ -11499,92 +11443,111 @@ 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'Id of the request', - 'type' => 'string', - 'example' => 'F0AB6527-093F-5C44-B3BD-42C8C210C619', - ], - 'TotalCount' => [ - 'title' => '列表内元素总个数。', - 'description' => '列表内元素总个数。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '3', - ], - 'Users' => [ - 'title' => '用户列表。', - 'description' => '用户列表。', + 'RequestId' => ['title' => 'Id of the request', 'description' => '请求id。'."\n", 'type' => 'string', 'example' => '728C5E01-ABF6-5AA8-B9FC-B3BA05DECC77'], + 'TotalCount' => ['description' => '总个数'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '10'], + 'RecallManagementTableVersions' => [ + 'description' => '召回管理表列表。'."\n", 'type' => 'array', 'items' => [ - 'description' => '用户ID。', - 'type' => 'string', - 'example' => 'user1', + 'type' => 'object', + 'properties' => [ + 'RecallManagementTableVersionId' => ['description' => '版本ID。'."\n", 'type' => 'string', 'example' => '202507010000'], + 'EffectiveTime' => ['description' => '生效时间。'."\n", 'type' => 'string', 'example' => '2021-12-15T23:24:33.132'], + 'DataVersion' => ['description' => '数据版本。'."\n", 'type' => 'string', 'example' => 'ds=20250701'], + 'SourceTableRowCount' => ['description' => '源数据表行数。'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '100'], + 'SourceTableDataSize' => ['description' => '源数据表数据大小。'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1000'], + 'Status' => ['description' => '状态，枚举值：'."\n" + .'- Online：在线。'."\n" + .'- Offline：离线。'."\n", 'type' => 'string', 'example' => 'Online'], + 'PublishStartTime' => ['description' => '同步开始时间。'."\n", 'type' => 'string', 'example' => '2021-12-15T22:24:33.132'], + 'PublishEndTime' => ['description' => '同步结束时间。'."\n", 'type' => 'string', 'example' => '2021-12-15T23:24:33.132'], + ], + 'description' => '', ], ], ], ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"F0AB6527-093F-5C44-B3BD-42C8C210C619\\",\\n \\"TotalCount\\": 3,\\n \\"Users\\": [\\n \\"user1\\"\\n ]\\n}","type":"json"}]', - 'title' => '获取人群下用户列表', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '获取召回管理表版本列表', + 'description' => '## 请求说明'."\n" + .'- 通过提供`RecallManagementTableId`和`InstanceId`，可以获取特定召回管理表的版本历史。'."\n" + .'- 使用`SortBy`参数可以根据创建时间或更新时间对结果进行排序，默认按照创建时间升序排列。'."\n" + .'- `PageNumber`与`PageSize`参数支持分页查询功能，允许用户控制返回数据的数量及查看的具体页码。'."\n" + .'- 如果不指定`Order`参数，则默认按升序排列结果。'."\n", + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"728C5E01-ABF6-5AA8-B9FC-B3BA05DECC77\\",\\n \\"TotalCount\\": 10,\\n \\"RecallManagementTableVersions\\": [\\n {\\n \\"RecallManagementTableVersionId\\": \\"202507010000\\",\\n \\"EffectiveTime\\": \\"2021-12-15T23:24:33.132\\",\\n \\"DataVersion\\": \\"ds=20250701\\",\\n \\"SourceTableRowCount\\": 100,\\n \\"SourceTableDataSize\\": 1000,\\n \\"Status\\": \\"Online\\",\\n \\"PublishStartTime\\": \\"2021-12-15T22:24:33.132\\",\\n \\"PublishEndTime\\": \\"2021-12-15T23:24:33.132\\"\\n }\\n ]\\n}","type":"json"}]', ], - 'ListSubCrowds' => [ - 'summary' => '获取指定人群下的子人群列表。', - 'path' => '/api/v1/crowds/{CrowdId}/subcrowds', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'ListRecallManagementTables' => [ + 'summary' => '查询指定实例下的召回管理表信息，支持分页和排序。', + 'path' => '/api/v1/recallmanagementtables', + 'methods' => ['get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATURElearnN0NAWV', - ], + 'abilityTreeNodes' => ['FEATURElearnN0NAWV'], ], 'parameters' => [ [ - 'name' => 'CrowdId', - 'in' => 'path', - 'schema' => [ - 'title' => '人群ID。', - 'description' => '人群ID，可通过接口ListCrowds获取。', - 'type' => 'string', - 'required' => true, - 'example' => '3', - ], + 'name' => 'InstanceId', + 'in' => 'query', + 'schema' => ['description' => '实例ID。'."\n", 'type' => 'string', 'required' => true, 'example' => 'pairec-cn-test123'], ], [ - 'name' => 'InstanceId', + 'name' => 'Name', 'in' => 'query', - 'schema' => [ - 'title' => '实例ID。', - 'description' => '实例ID，可通过接口ListInstances获取。', - 'type' => 'string', - 'required' => true, - 'example' => 'pairec-cn-abcdefg1234', - ], + 'schema' => ['description' => '表名称。'."\n", 'type' => 'string', 'required' => false, 'example' => 'table-1'], + ], + [ + 'name' => 'Type', + 'in' => 'query', + 'schema' => ['description' => '表类型，枚举值：`X2I`：U2I 召回或 I2I 召回；`Vector`：向量召回；`Ramdom`：随机召回'."\n", 'type' => 'string', 'required' => false, 'example' => 'X2I'], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => ['description' => '页码。'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1'], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => ['description' => '页大小。'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10'], + ], + [ + 'name' => 'SortBy', + 'in' => 'query', + 'schema' => ['description' => '排序依据。`GmtCreateTime`-创建时间。`GmtModifiedTime`-更新时间。'."\n", 'type' => 'string', 'required' => false, 'example' => 'GmtCreateTime'], + ], + [ + 'name' => 'Order', + 'in' => 'query', + 'schema' => ['description' => '排序方式。ASC-升序。DESC-降序。'."\n", 'type' => 'string', 'required' => false, 'example' => 'ASC'], + ], + [ + 'name' => 'NextToken', + 'in' => 'query', + 'schema' => ['description' => '暂不生效。', 'type' => 'string', 'required' => false, 'example' => '""'], + ], + [ + 'name' => 'MaxResults', + 'in' => 'query', + 'schema' => ['description' => '暂不生效。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '0'], ], ], 'responses' => [ @@ -11594,138 +11557,82 @@ 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'Id of the request', - 'type' => 'string', - 'example' => 'C5AEB79E-FAA4-5DCE-8CD7-1CAF549ECC3E', - ], - 'TotalCount' => [ - 'title' => '列表内元素总数。', - 'description' => '列表内元素总数。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '10', - ], - 'SubCrowds' => [ - 'title' => '子人群列表。', - 'description' => '子人群列表。', + 'RequestId' => ['title' => 'Id of the request', 'description' => '请求id。'."\n", 'type' => 'string', 'example' => '728C5E01-ABF6-5AA8-B9FC-B3BA05DECC77'], + 'TotalCount' => ['description' => '总个数。'."\n", 'type' => 'string', 'example' => '30'], + 'RecallManagementTables' => [ + 'description' => '召回管理表列表。'."\n", 'type' => 'array', 'items' => [ + 'description' => '召回管理表详情。', 'type' => 'object', 'properties' => [ - 'SubCrowdId' => [ - 'title' => '子人群ID。', - 'description' => '子人群ID。', - 'type' => 'string', - 'example' => '3', - ], - 'Source' => [ - 'title' => '人群来源。'."\n" - .'● ManualInput-手工输入'."\n" - .'● UploadFile-文件上传', - 'description' => '人群来源。'."\n" - .'● ManualInput-手工输入'."\n" - .'● UploadFile-文件上传', - 'type' => 'string', - 'example' => 'ManualInput', - ], - 'Users' => [ - 'title' => '人群分组中的用户。', - 'description' => '人群分组中的用户。', - 'type' => 'string', - 'example' => 'user1,user2', - ], - 'Quantity' => [ - 'title' => '人群分组所含的用户量。', - 'description' => '人群分组所含的用户量。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '2', - ], - 'GmtCreateTime' => [ - 'title' => '创建时间。', - 'description' => '创建时间。', - 'type' => 'string', - 'example' => '2021-12-15T23:24:33.132+08:00', - ], + 'RecallManagementTableId' => ['description' => '数据表ID。'."\n", 'type' => 'string', 'example' => '3'], + 'Name' => ['description' => '数据表名。'."\n", 'type' => 'string', 'example' => 'table-123'], + 'Description' => ['description' => '数据表备注。'."\n", 'type' => 'string', 'example' => 'this is a test'], + 'Type' => ['description' => '表类型。'."\n", 'type' => 'string', 'example' => 'Recall'], + 'RecallType' => ['description' => '表的召回类型。'."\n", 'type' => 'string', 'example' => 'X2I'], + 'DataSource' => ['description' => '数据源。'."\n", 'type' => 'string', 'example' => 'Api'], + 'MaxcomputeProjectName' => ['description' => 'maxcompute项目名。'."\n", 'type' => 'string', 'example' => 'test'], + 'MaxcomputeTableName' => ['description' => 'maxcompute中表名。'."\n", 'type' => 'string', 'example' => 'table-1'], + 'CanDelete' => ['description' => '表是否可以被删除。'."\n", 'type' => 'boolean', 'example' => 'false'], + 'IndexVersionId' => ['description' => '索引版本Id。'."\n", 'type' => 'string', 'example' => '20250701'], + 'IndexEffectiveTime' => ['description' => '索引生效时间'."\n", 'type' => 'string', 'example' => '2021-12-15T23:24:33.132+08:00'], + 'GmtCreateTime' => ['description' => '创建时间。'."\n", 'type' => 'string', 'example' => '2021-12-15T23:24:33.132+08:00'], + 'GmtModifiedTime' => ['description' => '更新时间。'."\n", 'type' => 'string', 'example' => '2021-12-15T23:24:33.132+08:00'], + 'MaxcomputeSchema' => ['description' => 'maxcompute schema。'."\n", 'type' => 'string', 'example' => 'default'], + 'PartitionFields' => ['description' => '表的分区字段。', 'type' => 'string', 'example' => 'dt'], ], ], ], + 'NextToken' => ['description' => '暂不生效。', 'type' => 'string', 'example' => '""'], + 'MaxResults' => ['description' => '暂不生效。', 'type' => 'integer', 'format' => 'int32', 'example' => '0'], ], ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '获取召回管理表列表', + 'description' => '## 请求说明'."\n" + .'- **InstanceId** 是必填参数，用于指定要查询的实例。'."\n" + .'- 可以通过 **Name** 和 **Type** 参数来过滤特定名称或类型的召回管理表。'."\n" + .'- 分页功能由 **PageNumber** 和 **PageSize** 控制，默认从第一页开始，每页显示50条记录。'."\n" + .'- 支持按创建时间（GmtCreateTime）或更新时间（GmtModifiedTime）进行排序，排序方式可选升序（ASC）或降序（DESC）。'."\n", + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"C5AEB79E-FAA4-5DCE-8CD7-1CAF549ECC3E\\",\\n \\"TotalCount\\": 10,\\n \\"SubCrowds\\": [\\n {\\n \\"SubCrowdId\\": \\"3\\",\\n \\"Source\\": \\"ManualInput\\",\\n \\"Users\\": \\"user1,user2\\",\\n \\"Quantity\\": 2,\\n \\"GmtCreateTime\\": \\"2021-12-15T23:24:33.132+08:00\\"\\n }\\n ]\\n}","type":"json"}]', - 'title' => '获取子人群列表', + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"728C5E01-ABF6-5AA8-B9FC-B3BA05DECC77\\",\\n \\"TotalCount\\": \\"30\\",\\n \\"RecallManagementTables\\": [\\n {\\n \\"RecallManagementTableId\\": \\"3\\",\\n \\"Name\\": \\"table-123\\",\\n \\"Description\\": \\"this is a test\\",\\n \\"Type\\": \\"Recall\\",\\n \\"RecallType\\": \\"X2I\\",\\n \\"DataSource\\": \\"Api\\",\\n \\"MaxcomputeProjectName\\": \\"test\\",\\n \\"MaxcomputeTableName\\": \\"table-1\\",\\n \\"CanDelete\\": false,\\n \\"IndexVersionId\\": \\"20250701\\",\\n \\"IndexEffectiveTime\\": \\"2021-12-15T23:24:33.132+08:00\\",\\n \\"GmtCreateTime\\": \\"2021-12-15T23:24:33.132+08:00\\",\\n \\"GmtModifiedTime\\": \\"2021-12-15T23:24:33.132+08:00\\",\\n \\"MaxcomputeSchema\\": \\"default\\",\\n \\"PartitionFields\\": \\"dt\\"\\n }\\n ],\\n \\"NextToken\\": \\"\\\\\\"\\\\\\"\\",\\n \\"MaxResults\\": 0\\n}","type":"json"}]', ], - 'GetSubCrowd' => [ - 'summary' => '获取指定子人群的详细信息。', - 'path' => '/api/v1/crowds/{CrowdId}/subcrowds/{SubCrowdId}', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'ListScenes' => [ + 'path' => '/api/v1/scenes', + 'methods' => ['get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'get', + 'operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATURElearnN0NAWV', - ], + 'abilityTreeNodes' => ['FEATURElearnN0NAWV'], ], 'parameters' => [ [ - 'name' => 'CrowdId', - 'in' => 'path', - 'schema' => [ - 'title' => '人群ID。', - 'description' => '人群ID，可通过接口ListCrowds获取。', - 'type' => 'string', - 'required' => true, - 'example' => '3', - ], - ], - [ - 'name' => 'SubCrowdId', - 'in' => 'path', - 'schema' => [ - 'title' => '子人群ID。', - 'description' => '子人群ID，可通过接口ListSubCrowds获取。', - 'type' => 'string', - 'required' => true, - 'example' => '4', - ], + 'name' => 'InstanceId', + 'in' => 'query', + 'schema' => ['title' => '实例ID。', 'description' => '实例ID，可通过接口ListInstances获取。', 'type' => 'string', 'required' => false, 'example' => 'pairec-cn-abcdefg1234'], ], [ - 'name' => 'InstanceId', + 'name' => 'Name', 'in' => 'query', - 'schema' => [ - 'title' => '实例ID。', - 'description' => '实例ID，可通过接口ListInstances获取。', - 'type' => 'string', - 'required' => true, - 'example' => 'pairec-cn-abcdefg1234', - ], + 'schema' => ['title' => '场景名称过滤。', 'description' => '场景名称过滤。', 'type' => 'string', 'required' => false, 'example' => 'scene1'], ], ], 'responses' => [ @@ -11735,329 +11642,207 @@ 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'Id of the request', - 'type' => 'string', - 'example' => '01D22D08-BA20-5F35-8302-99115F288220', - ], - 'Source' => [ - 'title' => '人群来源。'."\n" - .'● ManualInput-手工输入'."\n" - .'● UploadFile-文件上传', - 'description' => '人群来源。'."\n" - .'● ManualInput-手工输入'."\n" - .'● UploadFile-文件上传', - 'type' => 'string', - 'example' => 'ManualInput', - ], - 'Users' => [ - 'title' => '人群分组中的用户。', - 'description' => '人群分组中的用户。', - 'type' => 'string', - 'example' => 'user1,user2', - ], - 'Quantity' => [ - 'title' => '人群分组所含的用户量。', - 'description' => '人群分组所含的用户量。', - 'type' => 'string', - 'example' => '3', - ], - 'GmtCreateTime' => [ - 'title' => '人群创建时间。', - 'description' => '人群创建时间。', - 'type' => 'string', - 'example' => '2021-12-15T23:24:33.132+08:00', + 'RequestId' => ['title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => 'B8987BF7-6028-5B17-80E0-251B7BD67BBA'], + 'TotalCount' => ['description' => '列表内元素数量总和。', 'type' => 'integer', 'format' => 'int64', 'example' => '10'], + 'Scenes' => [ + 'title' => '场景列表。', + 'description' => '场景列表。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'SceneId' => ['title' => '场景ID。', 'description' => '场景ID。', 'type' => 'string', 'example' => '3'], + 'Name' => ['title' => '场景名称。', 'description' => '场景名称。', 'type' => 'string', 'example' => 'scene1'], + 'Description' => ['title' => '场景描述。', 'description' => '场景描述。', 'type' => 'string', 'example' => 'This is a test.'], + 'Flows' => [ + 'title' => '流量列表。', + 'description' => '流量列表。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'FlowName' => ['title' => '流量名称。', 'description' => '流量名称。', 'type' => 'string', 'example' => '流量1'], + 'FlowCode' => ['title' => '流量编码。', 'description' => '流量编码。', 'type' => 'string', 'example' => 'liuliang1'], + ], + 'description' => '', + ], + ], + ], + 'description' => '', + ], ], ], ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '获取场景列表', + 'summary' => '获取场景列表。', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'pairec:ListScenes', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIRecService', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"01D22D08-BA20-5F35-8302-99115F288220\\",\\n \\"Source\\": \\"ManualInput\\",\\n \\"Users\\": \\"user1,user2\\",\\n \\"Quantity\\": \\"3\\",\\n \\"GmtCreateTime\\": \\"2021-12-15T23:24:33.132+08:00\\"\\n}","type":"json"}]', - 'title' => '获取子人群详细信息', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"B8987BF7-6028-5B17-80E0-251B7BD67BBA\\",\\n \\"TotalCount\\": 10,\\n \\"Scenes\\": [\\n {\\n \\"SceneId\\": \\"3\\",\\n \\"Name\\": \\"scene1\\",\\n \\"Description\\": \\"This is a test.\\",\\n \\"Flows\\": [\\n {\\n \\"FlowName\\": \\"流量1\\",\\n \\"FlowCode\\": \\"liuliang1\\"\\n }\\n ]\\n }\\n ]\\n}","type":"json"}]', ], - 'UpdateTableMeta' => [ - 'summary' => '更新数据表。', - 'path' => '/api/v1/tablemetas/{TableMetaId}', - 'methods' => [ - 'put', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'ListSubCrowds' => [ + 'summary' => '获取指定人群下的子人群列表。', + 'path' => '/api/v1/crowds/{CrowdId}/subcrowds', + 'methods' => ['get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], - 'operationType' => 'readAndWrite', + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'update', + 'operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATURElearnN0NAWV', - ], + 'abilityTreeNodes' => ['FEATURElearnN0NAWV'], ], 'parameters' => [ [ - 'name' => 'TableMetaId', + 'name' => 'CrowdId', 'in' => 'path', - 'schema' => [ - 'description' => '数据表ID。', - 'type' => 'string', - 'required' => true, - 'example' => '1', - ], + 'schema' => ['title' => '人群ID。', 'description' => '人群ID，可通过接口ListCrowds获取。', 'type' => 'string', 'required' => true, 'example' => '3'], ], [ - 'name' => 'body', - 'in' => 'body', - 'style' => 'json', + 'name' => 'InstanceId', + 'in' => 'query', + 'schema' => ['title' => '实例ID。', 'description' => '实例ID，可通过接口ListInstances获取。', 'type' => 'string', 'required' => true, 'example' => 'pairec-cn-abcdefg1234'], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => '请求体参数。', + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'Name' => [ - 'description' => '数据表名称。', - 'type' => 'string', - 'required' => true, - 'example' => 'table_test', - ], - 'ResourceId' => [ - 'description' => '资源ID，可通过[ListInstanceResource](~~2672886~~)获取。', - 'type' => 'string', - 'required' => true, - 'example' => 'reso-2s416t***', - ], - 'TableName' => [ - 'description' => '数据库中的表名。', - 'type' => 'string', - 'required' => true, - 'example' => 'table_mysql', - ], - 'Module' => [ - 'description' => '数据表模块。'."\n" - ."\n" - .'- ABTest：实验数据表。'."\n" - ."\n" - .'- ExperimentTool：实验工具表。'."\n" - ."\n" - .'- DataDiagnosis：数据诊断', - 'type' => 'string', - 'required' => true, - 'example' => 'ABTest', - ], - 'InstanceId' => [ - 'description' => '实例ID，可通过接口[ListInstances](~~2411819~~)获取。', - 'type' => 'string', - 'required' => true, - 'example' => 'pairec-cn-test1', - ], - 'Fields' => [ - 'description' => '表字段列表。', + 'RequestId' => ['title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => 'C5AEB79E-FAA4-5DCE-8CD7-1CAF549ECC3E'], + 'TotalCount' => ['title' => '列表内元素总数。', 'description' => '列表内元素总数。', 'type' => 'integer', 'format' => 'int64', 'example' => '10'], + 'SubCrowds' => [ + 'title' => '子人群列表。', + 'description' => '子人群列表。', 'type' => 'array', 'items' => [ - 'description' => '字段信息。', 'type' => 'object', 'properties' => [ - 'Name' => [ - 'description' => '字段名。', - 'type' => 'string', - 'required' => true, - 'example' => 'name', - ], - 'Meaning' => [ - 'description' => '字段含义。', - 'type' => 'string', - 'required' => true, - 'example' => '名称字段', - ], - 'Type' => [ - 'description' => '字段类型。', - 'type' => 'string', - 'required' => true, - 'example' => 'BIGINT', - ], - 'IsDimensionField' => [ - 'description' => '是否是维度字段。', - 'type' => 'boolean', - 'required' => true, - 'example' => 'false', - ], - 'DataType' => [ - 'description' => '字段的数据类型。', - 'type' => 'string', - 'required' => false, - 'enumValueTitles' => [ - 'number' => '数字', - 'image' => '图片', - 'text' => '文本', - 'video' => '视频', - 'primary_key' => '主键', - 'url' => '超链接', - ], - 'example' => 'primary_key', - ], - 'IsPartitionField' => [ - 'description' => '是否为分区字段。', - 'type' => 'string', - 'required' => true, - 'example' => 'true', - ], + 'SubCrowdId' => ['title' => '子人群ID。', 'description' => '子人群ID。', 'type' => 'string', 'example' => '3'], + 'Source' => ['title' => '人群来源。'."\n" + .'● ManualInput-手工输入'."\n" + .'● UploadFile-文件上传', 'description' => '人群来源。'."\n" + .'● ManualInput-手工输入'."\n" + .'● UploadFile-文件上传', 'type' => 'string', 'example' => 'ManualInput'], + 'Users' => ['title' => '人群分组中的用户。', 'description' => '人群分组中的用户。', 'type' => 'string', 'example' => 'user1,user2'], + 'Quantity' => ['title' => '人群分组所含的用户量。', 'description' => '人群分组所含的用户量。', 'type' => 'integer', 'format' => 'int32', 'example' => '2'], + 'GmtCreateTime' => ['title' => '创建时间。', 'description' => '创建时间。', 'type' => 'string', 'example' => '2021-12-15T23:24:33.132+08:00'], ], - 'required' => false, + 'description' => '', ], - 'required' => true, - ], - 'Description' => [ - 'description' => '表的描述信息。', - 'type' => 'string', - 'required' => false, - 'example' => 'this is a test table', ], ], - 'required' => false, ], ], ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response', - 'type' => 'object', - 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => '请求ID。', - 'type' => 'string', - 'example' => '728C5E01-ABF6-5AA8-B9FC-B3BA05DECC77', - ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"C5AEB79E-FAA4-5DCE-8CD7-1CAF549ECC3E\\",\\n \\"TotalCount\\": 10,\\n \\"SubCrowds\\": [\\n {\\n \\"SubCrowdId\\": \\"3\\",\\n \\"Source\\": \\"ManualInput\\",\\n \\"Users\\": \\"user1,user2\\",\\n \\"Quantity\\": 2,\\n \\"GmtCreateTime\\": \\"2021-12-15T23:24:33.132+08:00\\"\\n }\\n ]\\n}","type":"json"}]', + 'title' => '获取子人群列表', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'pairec:ListSubCrowds', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIRecService', 'resourceType' => '全部资源', 'arn' => '*'], ], ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"728C5E01-ABF6-5AA8-B9FC-B3BA05DECC77\\"\\n}","type":"json"}]', - 'title' => '更新数据表', ], 'ListTableMetas' => [ 'summary' => '获取数据表列表。', 'path' => '/api/v1/tablemetas', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'methods' => ['get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATURElearnN0NAWV', - ], + 'abilityTreeNodes' => ['FEATURElearnN0NAWV'], ], 'parameters' => [ [ 'name' => 'Type', 'in' => 'query', - 'schema' => [ - 'description' => '数据表类型。'."\n" - ."\n" - .'- MaxCompute'."\n" - ."\n" - .'- Hologres', - 'type' => 'string', - 'required' => false, - 'example' => 'MaxCompute', - ], + 'schema' => ['description' => '数据表类型。'."\n" + ."\n" + .'- MaxCompute'."\n" + ."\n" + .'- Hologres', 'type' => 'string', 'required' => false, 'example' => 'MaxCompute'], ], [ 'name' => 'Name', 'in' => 'query', - 'schema' => [ - 'description' => '表名称过滤。', - 'type' => 'string', - 'required' => false, - 'example' => 'test1', - ], + 'schema' => ['description' => '表名称过滤。', 'type' => 'string', 'required' => false, 'example' => 'test1'], ], [ 'name' => 'Module', 'in' => 'query', - 'schema' => [ - 'description' => '数据表模块。'."\n" - ."\n" - .'- ABTest：实验数据表'."\n" - ."\n" - .'- ExperimentTool：实验工具表'."\n" - ."\n" - .'- DataDiagnosis：数据诊断', - 'type' => 'string', - 'required' => true, - 'example' => 'ABTest', - ], + 'schema' => ['description' => '数据表模块。'."\n" + ."\n" + .'- ABTest：实验数据表'."\n" + ."\n" + .'- ExperimentTool：实验工具表'."\n" + ."\n" + .'- DataDiagnosis：数据诊断', 'type' => 'string', 'required' => true, 'example' => 'ABTest'], ], [ 'name' => 'PageNumber', 'in' => 'query', - 'schema' => [ - 'description' => '页码。', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', - ], + 'schema' => ['description' => '页码。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1'], ], [ 'name' => 'PageSize', 'in' => 'query', - 'schema' => [ - 'description' => '页大小。', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '10', - ], + 'schema' => ['description' => '页大小。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10'], ], [ 'name' => 'InstanceId', 'in' => 'query', - 'schema' => [ - 'description' => '实例ID，可通过接口[ListInstances](~~2411819~~)获取。', - 'type' => 'string', - 'required' => true, - 'example' => 'pairec-cn-test1', - ], + 'schema' => ['description' => '实例ID，可通过接口[ListInstances](~~2411819~~)获取。', 'type' => 'string', 'required' => true, 'example' => 'pairec-cn-test1'], ], ], 'responses' => [ @@ -12067,18 +11852,8 @@ 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => '请求ID。', - 'type' => 'string', - 'example' => '728C5E01-ABF6-5AA8-B9FC-B3BA05DECC77', - ], - 'TotalCount' => [ - 'description' => '总个数。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '20', - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => '728C5E01-ABF6-5AA8-B9FC-B3BA05DECC77'], + 'TotalCount' => ['description' => '总个数。', 'type' => 'integer', 'format' => 'int64', 'example' => '20'], 'TableMetas' => [ 'description' => '数据表列表。', 'type' => 'array', @@ -12086,71 +11861,27 @@ 'description' => '数据表信息。', 'type' => 'object', 'properties' => [ - 'TableMetaId' => [ - 'description' => '数据表ID。', - 'type' => 'string', - 'example' => '3', - ], - 'Name' => [ - 'description' => '数据表名称。', - 'type' => 'string', - 'example' => 'test_table', - ], - 'Description' => [ - 'description' => '数据表描述。', - 'type' => 'string', - 'example' => 'this is a test table', - ], - 'ResourceId' => [ - 'description' => '资源ID。', - 'type' => 'string', - 'example' => 'reso-2s416t***', - ], - 'TableName' => [ - 'description' => '数据库中的表名。', - 'type' => 'string', - 'example' => 'table_mysql', - ], - 'Type' => [ - 'description' => '数据表类型。'."\n" - ."\n" - .'- MaxCompute'."\n" - ."\n" - .'- Hologres', - 'type' => 'string', - 'example' => 'MaxCompute', - ], - 'Module' => [ - 'description' => '数据表模块'."\n" - ."\n" - .'- ABTest：实验数据表'."\n" - ."\n" - .'- ExperimentTool：实验工具表'."\n" - ."\n" - .'- DataDiagnosis：数据诊断', - 'type' => 'string', - 'example' => 'ABTest', - ], - 'CanDelete' => [ - 'description' => '是否可以删除，如果表在其他地方正在被引用，则返回false。', - 'type' => 'boolean', - 'example' => 'true', - ], - 'GmtCreateTime' => [ - 'description' => '创建时间。', - 'type' => 'string', - 'example' => '2021-12-12 12:24:33', - ], - 'GmtModifiedTime' => [ - 'description' => '更新时间。', - 'type' => 'string', - 'example' => '2021-12-12 12:24:33', - ], - 'GmtImportedTime' => [ - 'description' => '字段导入时间。', - 'type' => 'string', - 'example' => 'imprecation', - ], + 'TableMetaId' => ['description' => '数据表ID。', 'type' => 'string', 'example' => '3'], + 'Name' => ['description' => '数据表名称。', 'type' => 'string', 'example' => 'test_table'], + 'Description' => ['description' => '数据表描述。', 'type' => 'string', 'example' => 'this is a test table'], + 'ResourceId' => ['description' => '资源ID。', 'type' => 'string', 'example' => 'reso-2s416t***'], + 'TableName' => ['description' => '数据库中的表名。', 'type' => 'string', 'example' => 'table_mysql'], + 'Type' => ['description' => '数据表类型。'."\n" + ."\n" + .'- MaxCompute'."\n" + ."\n" + .'- Hologres', 'type' => 'string', 'example' => 'MaxCompute'], + 'Module' => ['description' => '数据表模块'."\n" + ."\n" + .'- ABTest：实验数据表'."\n" + ."\n" + .'- ExperimentTool：实验工具表'."\n" + ."\n" + .'- DataDiagnosis：数据诊断', 'type' => 'string', 'example' => 'ABTest'], + 'CanDelete' => ['description' => '是否可以删除，如果表在其他地方正在被引用，则返回false。', 'type' => 'boolean', 'example' => 'true'], + 'GmtCreateTime' => ['description' => '创建时间。', 'type' => 'string', 'example' => '2021-12-12 12:24:33'], + 'GmtModifiedTime' => ['description' => '更新时间。', 'type' => 'string', 'example' => '2021-12-12 12:24:33'], + 'GmtImportedTime' => ['description' => '字段导入时间。', 'type' => 'string', 'example' => 'imprecation'], 'Fields' => [ 'description' => '表的字段列表。', 'type' => 'array', @@ -12158,39 +11889,17 @@ 'description' => '字段信息。', 'type' => 'object', 'properties' => [ - 'Name' => [ - 'description' => '字段名称。', - 'type' => 'string', - 'example' => 'gender', - ], - 'Meaning' => [ - 'description' => '字段含义。', - 'type' => 'string', - 'example' => 'the gender of people', - ], - 'Type' => [ - 'description' => '字段类型。', - 'type' => 'string', - 'example' => 'BIGINT', - ], - 'IsDimensionField' => [ - 'description' => '是否是维度字段。', - 'type' => 'boolean', - 'example' => 'false', - ], + 'Name' => ['description' => '字段名称。', 'type' => 'string', 'example' => 'gender'], + 'Meaning' => ['description' => '字段含义。', 'type' => 'string', 'example' => 'the gender of people'], + 'Type' => ['description' => '字段类型。', 'type' => 'string', 'example' => 'BIGINT'], + 'IsDimensionField' => ['description' => '是否是维度字段。', 'type' => 'boolean', 'example' => 'false'], ], ], ], - 'Url' => [ - 'description' => '如果是MaxCompute表，此处为数据地图的表的链接。', - 'type' => 'string', - 'example' => 'https://dmc-xxx.com/dm/table/xxx', - ], - 'Config' => [ - 'description' => '数据表的一些额外的配置。', - 'type' => 'string', - 'example' => '{"table_type":"item"}', - ], + 'Url' => ['description' => '如果是MaxCompute表，此处为数据地图的表的链接。', 'type' => 'string', 'example' => 'https://dmc-xxx.com/dm/table/xxx'], + 'Config' => ['description' => '数据表的一些额外的配置。', 'type' => 'string', 'example' => '{"table_type":"item"}'], + 'ResourceType' => ['title' => '资源类型', 'type' => 'string', 'example' => 'Maxcompute'], + 'ResourceUri' => ['title' => '资源地址', 'type' => 'string', 'example' => 'test'], ], ], ], @@ -12198,63 +11907,94 @@ ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"728C5E01-ABF6-5AA8-B9FC-B3BA05DECC77\\",\\n \\"TotalCount\\": 20,\\n \\"TableMetas\\": [\\n {\\n \\"TableMetaId\\": \\"3\\",\\n \\"Name\\": \\"test_table\\",\\n \\"Description\\": \\"this is a test table\\",\\n \\"ResourceId\\": \\"reso-2s416t***\\",\\n \\"TableName\\": \\"table_mysql\\",\\n \\"Type\\": \\"MaxCompute\\",\\n \\"Module\\": \\"ABTest\\",\\n \\"CanDelete\\": true,\\n \\"GmtCreateTime\\": \\"2021-12-12 12:24:33\\",\\n \\"GmtModifiedTime\\": \\"2021-12-12 12:24:33\\",\\n \\"GmtImportedTime\\": \\"imprecation\\",\\n \\"Fields\\": [\\n {\\n \\"Name\\": \\"gender\\",\\n \\"Meaning\\": \\"the gender of people\\",\\n \\"Type\\": \\"BIGINT\\",\\n \\"IsDimensionField\\": false\\n }\\n ],\\n \\"Url\\": \\"https://dmc-xxx.com/dm/table/xxx\\",\\n \\"Config\\": \\"{\\\\\\"table_type\\\\\\":\\\\\\"item\\\\\\"}\\"\\n }\\n ]\\n}","type":"json"}]', + 'staticInfo' => ['returnType' => 'synchronous'], 'title' => '获取数据表列表', - ], - 'GetTableMeta' => [ - 'summary' => '获取数据表详细信息。', - 'path' => '/api/v1/tablemetas/{TableMetaId}', - 'methods' => [ - 'get', + 'changeSet' => [ + ['createdAt' => '2024-02-22T03:35:43.000Z', 'description' => '请求参数发生变更、响应参数发生变更'], ], - 'schemes' => [ - 'http', - 'https', + 'flowControl' => [ + 'flowControlList' => [], ], + 'ramActions' => [ + [ + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'pairec:ListTableMetas', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIRecService', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"728C5E01-ABF6-5AA8-B9FC-B3BA05DECC77\\",\\n \\"TotalCount\\": 20,\\n \\"TableMetas\\": [\\n {\\n \\"TableMetaId\\": \\"3\\",\\n \\"Name\\": \\"test_table\\",\\n \\"Description\\": \\"this is a test table\\",\\n \\"ResourceId\\": \\"reso-2s416t***\\",\\n \\"TableName\\": \\"table_mysql\\",\\n \\"Type\\": \\"MaxCompute\\",\\n \\"Module\\": \\"ABTest\\",\\n \\"CanDelete\\": true,\\n \\"GmtCreateTime\\": \\"2021-12-12 12:24:33\\",\\n \\"GmtModifiedTime\\": \\"2021-12-12 12:24:33\\",\\n \\"GmtImportedTime\\": \\"imprecation\\",\\n \\"Fields\\": [\\n {\\n \\"Name\\": \\"gender\\",\\n \\"Meaning\\": \\"the gender of people\\",\\n \\"Type\\": \\"BIGINT\\",\\n \\"IsDimensionField\\": false\\n }\\n ],\\n \\"Url\\": \\"https://dmc-xxx.com/dm/table/xxx\\",\\n \\"Config\\": \\"{\\\\\\"table_type\\\\\\":\\\\\\"item\\\\\\"}\\",\\n \\"ResourceType\\": \\"Maxcompute\\",\\n \\"ResourceUri\\": \\"test\\"\\n }\\n ]\\n}","type":"json"}]', + ], + 'ListTrafficControlTargetTrafficHistory' => [ + 'path' => '/api/v1/trafficcontroltargets/{TrafficControlTargetId}/traffichistories', + 'methods' => ['get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], - 'operationType' => 'read', + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'get', + 'operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATURElearnN0NAWV', - ], + 'abilityTreeCode' => '220605', + 'abilityTreeNodes' => ['FEATURElearnN0NAWV'], ], 'parameters' => [ [ - 'name' => 'TableMetaId', + 'name' => 'TrafficControlTargetId', 'in' => 'path', - 'schema' => [ - 'description' => '数据表ID。', - 'type' => 'string', - 'required' => true, - 'example' => '2', - ], + 'schema' => ['description' => '流量调控目标ID。'."\n", 'type' => 'string', 'required' => false, 'example' => '2'], + ], + [ + 'name' => 'Environment', + 'in' => 'query', + 'schema' => ['description' => '参数所属的环境。Daily-日常环境 Pre-预发环境 Prod-生产环境'."\n", 'type' => 'string', 'required' => false, 'example' => 'Pre'], + ], + [ + 'name' => 'StartTime', + 'in' => 'query', + 'schema' => ['description' => '开始时间', 'type' => 'string', 'required' => false, 'example' => '2024-01-01 13:13:20'], + ], + [ + 'name' => 'EndTime', + 'in' => 'query', + 'schema' => ['description' => '结束时间'."\n", 'type' => 'string', 'required' => false, 'example' => '2024-01-10 13:13:20'], + ], + [ + 'name' => 'Threshold', + 'in' => 'query', + 'schema' => ['description' => '阈值'."\n", 'type' => 'string', 'required' => false, 'example' => '20'], + ], + [ + 'name' => 'ExperimentId', + 'in' => 'query', + 'schema' => ['description' => '实验ID。'."\n", 'type' => 'string', 'required' => false, 'example' => 'ER_All'], + ], + [ + 'name' => 'ExperimentGroupId', + 'in' => 'query', + 'schema' => ['description' => '实验组ID。'."\n", 'type' => 'string', 'required' => false, 'example' => '2'], + ], + [ + 'name' => 'ItemId', + 'in' => 'query', + 'schema' => ['description' => '物品ID。'."\n", 'type' => 'string', 'required' => false, 'example' => '1001'], ], [ 'name' => 'InstanceId', 'in' => 'query', - 'schema' => [ - 'description' => '实例ID，可通过接口[ListInstances](~~2411819~~)获取。', - 'type' => 'string', - 'required' => true, - 'example' => '实例ID pairec-cn-test1', - ], + 'schema' => ['description' => '实例ID。'."\n", 'type' => 'string', 'required' => false, 'example' => 'pairec-1324***'], ], ], 'responses' => [ @@ -12264,178 +12004,164 @@ 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => '请求ID。', - 'type' => 'string', - 'example' => '28C5E01-ABF6-5AA8-B9FC-B3BA05DECC77', - ], - 'Name' => [ - 'description' => '数据表名称。', - 'type' => 'string', - 'example' => 'test_table', - ], - 'Description' => [ - 'description' => '数据表描述。', - 'type' => 'string', - 'example' => 'this is a test table', - ], - 'ResourceId' => [ - 'description' => '资源ID。', - 'type' => 'string', - 'example' => 'reso-wkgo***', - ], - 'TableName' => [ - 'description' => '数据库中的表名.', - 'type' => 'string', - 'example' => 'table_mysql', - ], - 'Type' => [ - 'description' => '数据表类型。'."\n" - ."\n" - .'- MaxCompute'."\n" - ."\n" - .'- Hologres', - 'type' => 'string', - 'example' => 'MaxCompute', - ], - 'Module' => [ - 'description' => '数据表模块。'."\n" - ."\n" - .'- ABTest-实验数据表。'."\n" - ."\n" - .'- ExperimentTool-实验工具表。'."\n" - ."\n" - .'- DataDiagnosis-数据诊断', - 'type' => 'string', - 'example' => 'ABTest', - ], - 'CanDelete' => [ - 'description' => '是否可以删除，如果表在其他地方正在被引用，则返回 false。', - 'type' => 'boolean', - 'example' => 'false', - ], - 'GmtCreateTime' => [ - 'description' => '创建时间。', - 'type' => 'string', - 'example' => '2021-12-15:24:33', - ], - 'GmtModifiedTime' => [ - 'description' => '更新时间。', - 'type' => 'string', - 'example' => '2021-12-15:24:33', - ], - 'Fields' => [ - 'description' => '表的字段列表。', + 'RequestId' => ['title' => 'Id of the request', 'description' => '请求id。'."\n", 'type' => 'string', 'example' => '728C5E01-ABF6-5AA8-B9FC-B3BA05DECC77'], + 'TotalCount' => ['description' => '总个数。'."\n", 'type' => 'string', 'example' => '10'], + 'TrafficControlTaskTrafficHistories' => [ + 'description' => '流量调控历史记录。', 'type' => 'array', 'items' => [ - 'description' => '字段信息。', + 'description' => '流量调控历史详情。', 'type' => 'object', 'properties' => [ - 'Name' => [ - 'description' => '字段名称。', - 'type' => 'string', - 'example' => 'gender', - ], - 'Meaning' => [ - 'description' => '字段含义。', - 'type' => 'string', - 'example' => 'the gender of people', - ], - 'Type' => [ - 'description' => '字段类型。', - 'type' => 'string', - 'example' => 'BIGINT', - ], - 'IsDimensionField' => [ - 'description' => '是否是维度字段。', - 'type' => 'boolean', - 'example' => 'false', - ], + 'RecordTime' => ['description' => '行为表中的时间，截止到当前的时间'."\n", 'type' => 'string', 'example' => '2023-10-10 10:10:58'], + 'ItemId' => ['description' => '物品ID。'."\n", 'type' => 'string', 'example' => '1001'], + 'ExperimentId' => ['description' => '实验ID。'."\n", 'type' => 'string', 'example' => 'E1'], + 'TrafficControlTargetTraffic' => ['description' => '流量调控目标的实际流量'."\n", 'type' => 'number', 'format' => 'double', 'example' => '20'], + 'TrafficControlTargetAimTraffic' => ['description' => '流量调控目标的目标流量'."\n", 'type' => 'number', 'format' => 'double', 'example' => '30'], + 'TrafficControlTaskTraffic' => ['description' => '流量调控任务的整体流量'."\n", 'type' => 'number', 'format' => 'double', 'example' => '60'], ], ], ], - 'Url' => [ - 'description' => '如果是MaxCompute表，此字段为数据地图的表的链接，否则为空。', - 'type' => 'string', - 'example' => 'https://dmc-xxx.com/dm/table/xxx'."\n", - ], - 'TableMetaId' => [ - 'description' => '数据表ID。', - 'type' => 'string', - 'example' => '3', - ], - 'GmtImportedTime' => [ - 'description' => '字段导入时间。', - 'type' => 'string', - 'example' => '2021-12-15T23:24:33.132+08:00', - ], - 'Config' => [ - 'description' => '数据表的一些额外的配置。', - 'type' => 'string', - 'example' => '{"table_type":"item"}', - ], ], ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"28C5E01-ABF6-5AA8-B9FC-B3BA05DECC77\\",\\n \\"Name\\": \\"test_table\\",\\n \\"Description\\": \\"this is a test table\\",\\n \\"ResourceId\\": \\"reso-wkgo***\\",\\n \\"TableName\\": \\"table_mysql\\",\\n \\"Type\\": \\"MaxCompute\\",\\n \\"Module\\": \\"ABTest\\",\\n \\"CanDelete\\": false,\\n \\"GmtCreateTime\\": \\"2021-12-15:24:33\\",\\n \\"GmtModifiedTime\\": \\"2021-12-15:24:33\\",\\n \\"Fields\\": [\\n {\\n \\"Name\\": \\"gender\\",\\n \\"Meaning\\": \\"the gender of people\\",\\n \\"Type\\": \\"BIGINT\\",\\n \\"IsDimensionField\\": false\\n }\\n ],\\n \\"Url\\": \\"https://dmc-xxx.com/dm/table/xxx\\\\n\\",\\n \\"TableMetaId\\": \\"3\\",\\n \\"GmtImportedTime\\": \\"2021-12-15T23:24:33.132+08:00\\",\\n \\"Config\\": \\"{\\\\\\"table_type\\\\\\":\\\\\\"item\\\\\\"}\\"\\n}","type":"json"}]', - 'title' => '获取数据表', + 'title' => '获取流量调控任务历史', + 'summary' => '查询指定流量调控目标的历史流量变更记录。', + 'description' => '## 请求说明'."\n" + .'- `TrafficControlTargetId`、`InstanceId` 和 `Environment` 是必填参数。'."\n" + .'- `StartTime` 和 `EndTime` 可以用来限制查询的时间范围，格式为 `YYYY-MM-DD HH:MM:SS`。'."\n" + .'- `Threshold` 参数用于设置阈值，但不是必选。'."\n" + .'- `ExperimentId` 和 `ExperimentGroupId` 用于过滤特定实验或实验组的数据。'."\n" + .'- `ItemId` 用于过滤特定物品的流量数据。'."\n" + .'- 当前支持的环境包括：Daily（日常环境）、Pre（预发环境）和 Prod（生产环境）。'."\n", + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"728C5E01-ABF6-5AA8-B9FC-B3BA05DECC77\\",\\n \\"TotalCount\\": \\"10\\",\\n \\"TrafficControlTaskTrafficHistories\\": [\\n {\\n \\"RecordTime\\": \\"2023-10-10 10:10:58\\",\\n \\"ItemId\\": \\"1001\\",\\n \\"ExperimentId\\": \\"E1\\",\\n \\"TrafficControlTargetTraffic\\": 20,\\n \\"TrafficControlTargetAimTraffic\\": 30,\\n \\"TrafficControlTaskTraffic\\": 60\\n }\\n ]\\n}","type":"json"}]', ], - 'DeleteTableMeta' => [ - 'summary' => '删除数据表。', - 'path' => '/api/v1/tablemetas/{TableMetaId}', - 'methods' => [ - 'delete', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'ListTrafficControlTasks' => [ + 'summary' => '查询指定条件下的流量调控任务信息。', + 'path' => '/api/v1/trafficcontroltasks', + 'methods' => ['get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], - 'operationType' => 'write', + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'delete', + 'operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATURElearnN0NAWV', - ], + 'abilityTreeCode' => '220400', + 'abilityTreeNodes' => ['FEATURElearnN0NAWV'], ], 'parameters' => [ [ - 'name' => 'TableMetaId', - 'in' => 'path', - 'schema' => [ - 'description' => '数据表ID。', - 'type' => 'string', - 'required' => true, - 'example' => '2', - ], + 'name' => 'Name', + 'in' => 'query', + 'schema' => ['description' => '流量调控任务名称。', 'type' => 'string', 'required' => false, 'example' => 'task_1'], + ], + [ + 'name' => 'TrafficControlTaskId', + 'in' => 'query', + 'schema' => ['description' => '流量调控任务ID。', 'type' => 'string', 'required' => false, 'example' => '1'], + ], + [ + 'name' => 'SceneId', + 'in' => 'query', + 'schema' => ['description' => '场景ID，来源于[ListScenes](~~2402581~~)接口。', 'type' => 'string', 'required' => false, 'example' => '1'], + ], + [ + 'name' => 'Environment', + 'in' => 'query', + 'schema' => ['description' => '运行环境。'."\n" + ."\n" + .'- Daily-日常环境。'."\n" + ."\n" + .'- Pre-预发环境。'."\n" + ."\n" + .'- Prod-生产环境。', 'type' => 'string', 'required' => false, 'example' => 'Pre'], + ], + [ + 'name' => 'Status', + 'in' => 'query', + 'schema' => ['description' => '状态。'."\n" + ."\n" + .'- NotRunning：未运行。'."\n" + ."\n" + .'- Ready：待运行。'."\n" + ."\n" + .'- Running：运行中。'."\n" + ."\n" + .'- Finished：已结束。', 'type' => 'string', 'required' => false, 'example' => 'Running'], + ], + [ + 'name' => 'Version', + 'in' => 'query', + 'schema' => ['description' => '版本。'."\n" + ."\n" + .'- Latest：最新版本，默认值'."\n" + ."\n" + .'- Released：已发布版本', 'type' => 'string', 'required' => false, 'example' => 'Latest'], + ], + [ + 'name' => 'ControlTargetFilter', + 'in' => 'query', + 'schema' => ['description' => '过滤流量调控目标。'."\n" + ."\n" + .'- All：返回所有。'."\n" + ."\n" + .'- Valid：返回有效的（开始结束时间段内是开启状态的）。'."\n" + ."\n" + .'- None：不返回。', 'type' => 'string', 'required' => false, 'example' => 'All'], + ], + [ + 'name' => 'SortBy', + 'in' => 'query', + 'schema' => ['description' => '排序依据。'."\n" + .'- GmtCreateTime：按创建时间排序。'."\n" + .'- GmtModifiedTime-按更新时间排序。', 'type' => 'string', 'required' => false, 'example' => 'GmtCreateTime'], + ], + [ + 'name' => 'Order', + 'in' => 'query', + 'schema' => ['description' => '排序方式，取值：'."\n" + ."\n" + .'- ASC：升序。'."\n" + .'- DESC：降序。', 'type' => 'string', 'required' => false, 'example' => 'ASC'], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => ['description' => '分页数，从1开始，默认为1。', 'type' => 'string', 'required' => false, 'example' => '1'], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => ['description' => '每页记录数。默认值为10。', 'type' => 'string', 'required' => false, 'example' => '10'], + ], + [ + 'name' => 'All', + 'in' => 'query', + 'schema' => ['description' => '是否返回所有数据(不分页)。', 'type' => 'boolean', 'required' => false, 'example' => 'false'], ], [ 'name' => 'InstanceId', 'in' => 'query', - 'schema' => [ - 'description' => '实例ID，可通过接口[ListInstances](~~2411819~~)获取。', - 'type' => 'string', - 'required' => true, - 'example' => '实例ID pairec-cn-test1', - ], + 'schema' => ['description' => '实例ID，可通过接口[ListInstances](https://icms.alibaba-inc.com/content/learn/pai?l=1&m=16768&n=4300782)获取。', 'type' => 'string', 'required' => false, 'example' => 'pairec-cn-********'], ], ], 'responses' => [ @@ -12445,160 +12171,181 @@ 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => '请求ID。', - 'type' => 'string', - 'example' => '728C5E01-ABF6-5AA8-B9FC-B3BA05DECC77', + 'RequestId' => ['title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => '3AAA45F6-0798-5461-9360-81D133823CE7'], + 'TotalCount' => ['description' => '列表内元素总数。', 'type' => 'string', 'example' => '20'], + 'TrafficControlTasks' => [ + 'description' => '流量调控任务列表。', + 'type' => 'array', + 'items' => [ + 'description' => '流量调控任务详情。', + 'type' => 'object', + 'properties' => [ + 'TrafficControlTaskId' => ['description' => '流量调控任务ID。', 'type' => 'string', 'example' => '1'], + 'Name' => ['description' => '流量调控名称。', 'type' => 'string', 'example' => 'task_1'], + 'Description' => ['description' => '流量调控描述。', 'type' => 'string', 'example' => 'this is a test task'], + 'SceneId' => ['description' => '场景ID，可通过接口ListScenes获取。', 'type' => 'string', 'example' => '4'], + 'SceneName' => ['description' => '场景名称。', 'type' => 'string', 'example' => 'home_feed'], + 'ProductStatus' => ['description' => '生产环境状态。', 'type' => 'string', 'example' => 'Runnning'], + 'PrepubStatus' => ['description' => '预发环境状态。', 'type' => 'string', 'example' => 'Runnning'], + 'ExecutionTime' => ['description' => '执行时间.'."\n" + ."\n" + .'- Permanent：永久执行。'."\n" + ."\n" + .'- TimeRange: 指定时间范围。选择此参数时，需要指定 StartTime 和 EndTime。', 'type' => 'string', 'example' => 'Permanent'], + 'StartTime' => ['description' => '开始时间。', 'type' => 'string', 'example' => '2024-03-25'], + 'EndTime' => ['description' => '结束时间。', 'type' => 'string', 'example' => '2024-04-25'], + 'BehaviorTableMetaId' => ['description' => '行为表表ID。', 'type' => 'string', 'example' => '1'], + 'UserTableMetaId' => ['description' => '用户表表ID。', 'type' => 'string', 'example' => '2'], + 'ItemTableMetaId' => ['description' => '物品表表ID。', 'type' => 'string', 'example' => '3'], + 'UserConditionType' => ['description' => '干预人群条件类型。', 'type' => 'string', 'example' => 'Array'], + 'UserConditionArray' => ['description' => '干预人群数组格式条件。', 'type' => 'string', 'example' => '[{"field":"gender","option":"=","value":"male"}]'], + 'UserConditionExpress' => ['description' => '干预人群表达式格式条件。', 'type' => 'string', 'example' => 'age<=30&&(3<=level<=6)&&gender=male'], + 'StatisBehaviorConditionType' => ['description' => '行为统计条件类型。', 'type' => 'string', 'example' => 'Array'], + 'StatisBehaviorConditionArray' => ['description' => '行为统计数组格式条件。', 'type' => 'string', 'example' => '[{"field":"click","option":"<=","value":"30"}]'], + 'StatisBahaviorConditionExpress' => ['description' => '行为统计表达式格式。', 'type' => 'string', 'example' => 'event=click'], + 'ControlType' => ['description' => '调控类型。', 'type' => 'string', 'example' => 'Percent'], + 'ControlGranularity' => ['description' => '调控粒度。', 'type' => 'string', 'example' => 'Global'], + 'ControlLogic' => ['description' => '调控逻辑。', 'type' => 'string', 'example' => 'Guaranteed'], + 'ItemConditionType' => ['description' => '物品条件类型。', 'type' => 'string', 'example' => 'Array'], + 'ItemConditionArray' => ['description' => '物品条件，设置数组格式条件。', 'type' => 'string', 'example' => '[{"field":"status","option":"=","value":"1"}]'], + 'ItemConditionExpress' => ['description' => '物品条件，设置表达式格式条件。', 'type' => 'string', 'example' => 'status=1'], + 'GmtCreateTime' => ['description' => '创建时间。', 'type' => 'string', 'example' => '2024-03-25T06:04:28.441Z'], + 'GmtModifiedTime' => ['description' => '更新时间。', 'type' => 'string', 'example' => '2024-03-25T06:04:28.441Z'], + 'TrafficControlTargets' => [ + 'description' => '流量调控目标列表。', + 'type' => 'array', + 'items' => [ + 'description' => '流量调控目标详情。', + 'type' => 'object', + 'properties' => [ + 'TrafficControlTargetId' => ['description' => '流量调控目标ID。'."\n", 'type' => 'string', 'example' => '1'], + 'Name' => ['description' => '调控目标。', 'type' => 'string', 'example' => 'target-1'], + 'StartTime' => ['description' => '开始时间。', 'type' => 'string', 'example' => '2024-03-25'], + 'EndTime' => ['description' => '结束时间。', 'type' => 'string', 'example' => '2024-04-25'], + 'ItemConditionType' => ['description' => '物品条件类型。', 'type' => 'string', 'example' => 'Array'], + 'ItemConditionArray' => ['description' => '物品条件，设置数组格式条件。', 'type' => 'string', 'example' => '[{"field":"status","option":"=","value":"1"}]'], + 'ItemConditionExpress' => ['description' => '物品条件，设置表达式格式条件。', 'type' => 'string', 'example' => 'status=1'], + 'Event' => ['description' => '调控目标事件。', 'type' => 'string', 'example' => 'click'], + 'Value' => ['description' => '调控目标值。', 'type' => 'number', 'format' => 'float', 'example' => '30'], + 'StatisPeriod' => ['description' => '统计周期。', 'type' => 'string', 'example' => 'Daily'], + 'ToleranceValue' => ['description' => '调控目标容错范围。', 'type' => 'integer', 'format' => 'int64', 'example' => '10'], + 'RecallName' => ['description' => '召回策略名称。', 'type' => 'string', 'example' => 'recall-1'], + 'Status' => ['description' => '状态。', 'type' => 'string', 'example' => 'Opened'], + 'GmtCreateTime' => ['description' => '创建时间。', 'type' => 'string', 'example' => '2025-06-03T15:08:10.58+08:00'], + 'GmtModifiedTime' => ['description' => '更新时间。', 'type' => 'string', 'example' => '2025-11-21T16:26:58.57+08:00'], + 'SplitParts' => [ + 'description' => '分割点详情。', + 'type' => 'object', + 'properties' => [ + 'TimePoints' => [ + 'description' => '时间分割点列表。', + 'type' => 'array', + 'items' => ['description' => '时间点。', 'type' => 'integer', 'format' => 'int64', 'example' => '10'], + ], + 'SetValues' => [ + 'description' => '目标值分割点列表。', + 'type' => 'array', + 'items' => ['description' => '目标值分割具体值。', 'type' => 'integer', 'format' => 'int64', 'example' => '3'], + ], + ], + ], + 'NewProductRegulation' => ['description' => '是否是新品召回。', 'type' => 'boolean', 'example' => 'false'], + 'TrafficControlTaskId' => ['description' => '流量调控任务ID。', 'type' => 'string', 'example' => '1'], + ], + ], + ], + 'EverPublished' => ['description' => '是否已发布。', 'type' => 'boolean', 'example' => 'false'], + 'ServiceId' => ['description' => '服务ID。', 'type' => 'string', 'example' => '1'], + 'PreExperimentIds' => ['description' => '预发实验ID列表。', 'type' => 'string', 'example' => '1,2'], + 'ProdExperimentIds' => ['description' => '生产试验列表。', 'type' => 'string', 'example' => '6,7'], + 'FlinkResourceId' => ['description' => 'Flink资源ID。', 'type' => 'string', 'example' => 'resource-xxx'], + 'FlinkResourceName' => ['description' => 'Flink资源名称。', 'type' => 'string', 'example' => 'flink_test'], + 'StatisBehaviorConditionExpress' => ['description' => '行为表达式。', 'type' => 'string', 'example' => 'event=exposure'], + 'EffectiveSceneIds' => [ + 'description' => '有效服务ID列表。', + 'type' => 'array', + 'items' => ['description' => '有效服务ID。', 'type' => 'integer', 'format' => 'int32', 'example' => '4'], + ], + 'EffectiveSceneNames' => [ + 'description' => '生效场景名称列表。', + 'type' => 'array', + 'items' => ['description' => '生效场景名称。', 'type' => 'integer', 'format' => 'int32', 'example' => 'home_feed'], + ], + 'ServiceIds' => [ + 'description' => '绑定的引擎服务ID列表。', + 'type' => 'array', + 'items' => ['description' => '引擎服务 ID。', 'type' => 'string', 'example' => '4'], + ], + 'EffectiveSceneNameList' => [ + 'description' => '生效场景列表。', + 'type' => 'array', + 'items' => ['description' => '生效场景。', 'type' => 'string', 'example' => 'home_feed'], + ], + 'ServiceIdList' => [ + 'description' => '服务ID列表。', + 'type' => 'array', + 'items' => ['description' => '服务ID。', 'type' => 'integer', 'format' => 'int32', 'example' => '3'], + ], + ], + ], ], ], ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"728C5E01-ABF6-5AA8-B9FC-B3BA05DECC77\\"\\n}","type":"json"}]', - 'title' => '删除数据表', + 'title' => '获取流量调控任务列表', + 'description' => '## 请求说明'."\n" + .'- 该API用于获取符合特定条件的流量调控任务列表。'."\n" + .'- 用户可以通过提供不同的查询参数来过滤和排序返回的任务列表。'."\n" + .'- 支持分页查询，也可以选择一次性返回所有数据（不分页）。'."\n" + .'- 注意：`InstanceId` 是必填项，其他参数均为可选项，根据实际需求填写以获得更精确的结果。'."\n", + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"3AAA45F6-0798-5461-9360-81D133823CE7\\",\\n \\"TotalCount\\": \\"20\\",\\n \\"TrafficControlTasks\\": [\\n {\\n \\"TrafficControlTaskId\\": \\"1\\",\\n \\"Name\\": \\"task_1\\",\\n \\"Description\\": \\"this is a test task\\",\\n \\"SceneId\\": \\"4\\",\\n \\"SceneName\\": \\"home_feed\\",\\n \\"ProductStatus\\": \\"Runnning\\",\\n \\"PrepubStatus\\": \\"Runnning\\",\\n \\"ExecutionTime\\": \\"Permanent\\",\\n \\"StartTime\\": \\"2024-03-25\\",\\n \\"EndTime\\": \\"2024-04-25\\",\\n \\"BehaviorTableMetaId\\": \\"1\\",\\n \\"UserTableMetaId\\": \\"2\\",\\n \\"ItemTableMetaId\\": \\"3\\",\\n \\"UserConditionType\\": \\"Array\\",\\n \\"UserConditionArray\\": \\"[{\\\\\\"field\\\\\\":\\\\\\"gender\\\\\\",\\\\\\"option\\\\\\":\\\\\\"=\\\\\\",\\\\\\"value\\\\\\":\\\\\\"male\\\\\\"}]\\",\\n \\"UserConditionExpress\\": \\"age<=30&&(3<=level<=6)&&gender=male\\",\\n \\"StatisBehaviorConditionType\\": \\"Array\\",\\n \\"StatisBehaviorConditionArray\\": \\"[{\\\\\\"field\\\\\\":\\\\\\"click\\\\\\",\\\\\\"option\\\\\\":\\\\\\"<=\\\\\\",\\\\\\"value\\\\\\":\\\\\\"30\\\\\\"}]\\",\\n \\"StatisBahaviorConditionExpress\\": \\"event=click\\",\\n \\"ControlType\\": \\"Percent\\",\\n \\"ControlGranularity\\": \\"Global\\",\\n \\"ControlLogic\\": \\"Guaranteed\\",\\n \\"ItemConditionType\\": \\"Array\\",\\n \\"ItemConditionArray\\": \\"[{\\\\\\"field\\\\\\":\\\\\\"status\\\\\\",\\\\\\"option\\\\\\":\\\\\\"=\\\\\\",\\\\\\"value\\\\\\":\\\\\\"1\\\\\\"}]\\",\\n \\"ItemConditionExpress\\": \\"status=1\\",\\n \\"GmtCreateTime\\": \\"2024-03-25T06:04:28.441Z\\",\\n \\"GmtModifiedTime\\": \\"2024-03-25T06:04:28.441Z\\",\\n \\"TrafficControlTargets\\": [\\n {\\n \\"TrafficControlTargetId\\": \\"1\\",\\n \\"Name\\": \\"target-1\\",\\n \\"StartTime\\": \\"2024-03-25\\",\\n \\"EndTime\\": \\"2024-04-25\\",\\n \\"ItemConditionType\\": \\"Array\\",\\n \\"ItemConditionArray\\": \\"[{\\\\\\"field\\\\\\":\\\\\\"status\\\\\\",\\\\\\"option\\\\\\":\\\\\\"=\\\\\\",\\\\\\"value\\\\\\":\\\\\\"1\\\\\\"}]\\",\\n \\"ItemConditionExpress\\": \\"status=1\\",\\n \\"Event\\": \\"click\\",\\n \\"Value\\": 30,\\n \\"StatisPeriod\\": \\"Daily\\",\\n \\"ToleranceValue\\": 10,\\n \\"RecallName\\": \\"recall-1\\",\\n \\"Status\\": \\"Opened\\",\\n \\"GmtCreateTime\\": \\"2025-06-03T15:08:10.58+08:00\\",\\n \\"GmtModifiedTime\\": \\"2025-11-21T16:26:58.57+08:00\\",\\n \\"SplitParts\\": {\\n \\"TimePoints\\": [\\n 10\\n ],\\n \\"SetValues\\": [\\n 3\\n ]\\n },\\n \\"NewProductRegulation\\": false,\\n \\"TrafficControlTaskId\\": \\"1\\"\\n }\\n ],\\n \\"EverPublished\\": false,\\n \\"ServiceId\\": \\"1\\",\\n \\"PreExperimentIds\\": \\"1,2\\",\\n \\"ProdExperimentIds\\": \\"6,7\\",\\n \\"FlinkResourceId\\": \\"resource-xxx\\",\\n \\"FlinkResourceName\\": \\"flink_test\\",\\n \\"StatisBehaviorConditionExpress\\": \\"event=exposure\\",\\n \\"EffectiveSceneIds\\": [\\n 4\\n ],\\n \\"EffectiveSceneNames\\": [\\n 0\\n ],\\n \\"ServiceIds\\": [\\n \\"4\\"\\n ],\\n \\"EffectiveSceneNameList\\": [\\n \\"home_feed\\"\\n ],\\n \\"ServiceIdList\\": [\\n 3\\n ]\\n }\\n ]\\n}","type":"json"}]', ], - 'CreateTableMeta' => [ - 'summary' => '创建数据表。', - 'path' => '/api/v1/tablemetas', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'OfflineExperiment' => [ + 'summary' => '将指定实验下线。', + 'path' => '/api/v1/experiments/{ExperimentId}/action/offline', + 'methods' => ['post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], - 'operationType' => 'write', + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'create', + 'operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATURElearnN0NAWV', - ], + 'abilityTreeNodes' => ['FEATURElearnN0NAWV'], ], 'parameters' => [ [ + 'name' => 'ExperimentId', + 'in' => 'path', + 'schema' => ['title' => '实验ID。', 'description' => '实验ID，实验ID可通过接口ListExperiments获取。', 'type' => 'string', 'required' => true, 'example' => '3'], + ], + [ 'name' => 'body', 'in' => 'body', 'style' => 'json', 'schema' => [ - 'description' => '请求体参数。', + 'description' => '请求body。', 'type' => 'object', 'properties' => [ - 'Name' => [ - 'description' => '数据表名称。', - 'type' => 'string', - 'required' => true, - 'example' => 'table_test', - ], - 'ResourceId' => [ - 'description' => '资源 ID，可通过ListInstanceResources获取。', - 'type' => 'string', - 'required' => true, - 'example' => 'reso-2s416t146ffjc3yefx', - ], - 'TableName' => [ - 'description' => '数据库中的表名。', - 'type' => 'string', - 'required' => true, - 'example' => 'table_mysql', - ], - 'Module' => [ - 'description' => '表的模块。'."\n" - ."\n" - .'- ABTest-实验数据表。'."\n" - ."\n" - .'- ExperimentTool-实验工具表。'."\n" - ."\n" - .'- DataDiagnosis-数据诊断', - 'type' => 'string', - 'required' => true, - 'example' => 'ABTest', - ], - 'InstanceId' => [ - 'description' => '实例ID，可通过接口[ListInstances](~~2411819~~)获取。', - 'type' => 'string', - 'required' => true, - 'example' => 'pairec-cn-test123', - ], - 'Fields' => [ - 'description' => '字段列表。', - 'type' => 'array', - 'items' => [ - 'description' => '字段信息。', - 'type' => 'object', - 'properties' => [ - 'Name' => [ - 'description' => '字段名称。', - 'type' => 'string', - 'required' => true, - 'example' => 'gender', - ], - 'Meaning' => [ - 'description' => '字段含义。', - 'type' => 'string', - 'required' => true, - 'example' => 'this is gender of people', - ], - 'Type' => [ - 'description' => '字段类型。', - 'type' => 'string', - 'required' => true, - 'example' => 'BIGINT', - ], - 'IsDimensionField' => [ - 'description' => '是否是维度字段。', - 'type' => 'boolean', - 'required' => true, - 'example' => 'false', - ], - 'DataType' => [ - 'description' => '字段的数据类型。', - 'type' => 'string', - 'required' => false, - 'enumValueTitles' => [ - 'number' => '数字', - 'image' => '图片', - 'text' => '文本', - 'video' => '视频', - 'primary_key' => '主键', - 'url' => '超链接', - ], - 'example' => 'primary_key', - ], - 'IsPartitionField' => [ - 'description' => '是否为分区字段。', - 'type' => 'string', - 'required' => true, - 'example' => 'true', - ], - ], - 'required' => false, - ], - 'required' => true, - ], - 'Description' => [ - 'description' => '数据表描述。', - 'type' => 'string', - 'required' => true, - 'example' => 'this is a test table', - ], + 'InstanceId' => ['title' => '实例ID。', 'description' => '实例ID，可通过接口ListInstances获取。', 'type' => 'string', 'required' => true, 'example' => 'pairec-cn-abcdefg1234'], ], 'required' => false, ], @@ -12611,172 +12358,68 @@ 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => '请求ID。', - 'type' => 'string', - 'example' => '728C5E01-ABF6-5AA8-B9FC-B3BA05DECC77', - ], - 'TableMetaId' => [ - 'description' => '数据表ID。', - 'type' => 'string', - 'example' => '2', - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => '872951C9-7755-5FA1-AACD-7F9375A6D27A'], ], ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"872951C9-7755-5FA1-AACD-7F9375A6D27A\\"\\n}","type":"json"}]', + 'title' => '下线实验', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'pairec:OfflineExperiment', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIRecService', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"728C5E01-ABF6-5AA8-B9FC-B3BA05DECC77\\",\\n \\"TableMetaId\\": \\"2\\"\\n}","type":"json"}]', - 'title' => '创建数据表', ], - 'UpdateABMetric' => [ - 'summary' => '更新AB实验指标。', - 'path' => '/api/v1/abmetrics/{ABMetricId}', - 'methods' => [ - 'put', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'OfflineExperimentGroup' => [ + 'summary' => '下线指定实验组。', + 'path' => '/api/v1/experimentgroups/{ExperimentGroupId}/action/offline', + 'methods' => ['post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'update', + 'operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATURElearnN0NAWV', - ], + 'abilityTreeNodes' => ['FEATURElearnN0NAWV'], ], 'parameters' => [ [ - 'name' => 'ABMetricId', + 'name' => 'ExperimentGroupId', 'in' => 'path', - 'schema' => [ - 'description' => 'AB指标ID。', - 'type' => 'string', - 'required' => true, - 'example' => '1', - ], + 'schema' => ['title' => '实验组ID。', 'description' => '实验组ID，可通过接口ListExperimentGroups获取。', 'type' => 'string', 'required' => true, 'example' => '3'], ], [ 'name' => 'body', 'in' => 'body', 'style' => 'json', 'schema' => [ - 'description' => '请求体参数。', + 'title' => '请求body。', + 'description' => '请求body。', 'type' => 'object', 'properties' => [ - 'Name' => [ - 'description' => '指标名称。', - 'type' => 'string', - 'required' => true, - 'example' => 'pv', - ], - 'Description' => [ - 'description' => '指标描述。', - 'type' => 'string', - 'required' => true, - 'example' => 'pv 指标', - ], - 'SceneId' => [ - 'description' => '场景ID，可通过接口[ListScenes](~~2402581~~)获取。', - 'type' => 'string', - 'required' => true, - 'example' => '1', - ], - 'Type' => [ - 'description' => '指标类型。'."\n" - ."\n" - .'- Single-单一指标。'."\n" - ."\n" - .'- Derived-衍生指标。', - 'type' => 'string', - 'required' => true, - 'example' => 'Single', - ], - 'Realtime' => [ - 'description' => '是否为实时指标。'."\n" - ."\n" - .'- true-是。'."\n" - ."\n" - .'- false-否。', - 'type' => 'boolean', - 'required' => true, - 'example' => 'false', - ], - 'TableMetaId' => [ - 'description' => '数据表ID，可以通过ListTableMetas获取。', - 'type' => 'string', - 'required' => true, - 'example' => '2', - ], - 'ResultResourceId' => [ - 'description' => '写回数据表的数据源的ID，可以通过ListInstanceResources获取。', - 'type' => 'string', - 'required' => false, - 'example' => '3', - ], - 'Definition' => [ - 'description' => '指标定义。', - 'type' => 'string', - 'required' => true, - 'example' => 'sum(click_cnt)', - ], - 'StatisticsCycle' => [ - 'description' => '统计周期。', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', - ], - 'LeftMetricId' => [ - 'description' => '衍生指标的左指标ID。', - 'type' => 'string', - 'required' => false, - 'example' => '2', - ], - 'RightMetricId' => [ - 'description' => '衍生指标的右指标ID。', - 'type' => 'string', - 'required' => false, - 'example' => '3', - ], - 'Operator' => [ - 'description' => '衍生指标计算的操作符。'."\n" - ."\n" - .'- Plus-加'."\n" - ."\n" - .'- Minus-减'."\n" - ."\n" - .'- Multiplication-乘'."\n" - ."\n" - .'- Division-除', - 'type' => 'string', - 'required' => false, - 'example' => 'Division', - ], - 'InstanceId' => [ - 'description' => '实例ID，可通过接口[ListInstances](~~2411819~~)获取。', - 'type' => 'string', - 'required' => true, - 'example' => 'pairec-cn-test123', - ], + 'InstanceId' => ['title' => '实例ID。', 'description' => '实例ID。', 'type' => 'string', 'required' => true, 'example' => 'pairec-cn-abcdefg1234'."\n"], ], 'required' => false, ], @@ -12789,157 +12432,68 @@ 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => '请求ID。', - 'type' => 'string', - 'example' => '6CF1E160-3F36-5E73-A170-C75504F05BBC', - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => '518C64F6-DFF7-11ED-85B0-00163E14B3D1'], ], ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"518C64F6-DFF7-11ED-85B0-00163E14B3D1\\"\\n}","type":"json"}]', + 'title' => '下线实验组', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'pairec:OfflineExperimentGroup', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIRecService', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"6CF1E160-3F36-5E73-A170-C75504F05BBC\\"\\n}","type":"json"}]', - 'title' => '更新AB指标', ], - 'CreateABMetric' => [ - 'summary' => '创建AB实验指标。', - 'path' => '/api/v1/abmetrics', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'OfflineLaboratory' => [ + 'summary' => '将指定实验室下线。', + 'path' => '/api/v1/laboratories/{LaboratoryId}/action/offline', + 'methods' => ['post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'create', + 'operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATURElearnN0NAWV', - ], + 'abilityTreeNodes' => ['FEATURElearnN0NAWV'], ], 'parameters' => [ [ + 'name' => 'LaboratoryId', + 'in' => 'path', + 'schema' => ['title' => '实验室ID。', 'description' => '实验室ID，可通过接口ListLaboratories获取。', 'type' => 'string', 'required' => true, 'example' => '3'], + ], + [ 'name' => 'body', 'in' => 'body', 'style' => 'json', 'schema' => [ - 'description' => '请求体参数。', + 'title' => '请求body。', + 'description' => '请求body。', 'type' => 'object', 'properties' => [ - 'Name' => [ - 'description' => '指标名称。', - 'type' => 'string', - 'required' => true, - 'example' => 'pv', - ], - 'Description' => [ - 'description' => '指标描述。', - 'type' => 'string', - 'required' => true, - 'example' => 'pv指标', - ], - 'SceneId' => [ - 'description' => '场景ID，可通过接口[ListScenes](~~2402581~~)获取。', - 'type' => 'string', - 'required' => true, - 'example' => '1', - ], - 'Type' => [ - 'description' => '指标类型。'."\n" - ."\n" - .'- Single-单一指标。'."\n" - ."\n" - .'- Derived-衍生指标。', - 'type' => 'string', - 'required' => true, - 'example' => 'Single', - ], - 'Realtime' => [ - 'description' => '是否为实时指标。'."\n" - ."\n" - .'- true-是。'."\n" - ."\n" - .'- false-否。', - 'type' => 'boolean', - 'required' => true, - 'example' => 'false', - ], - 'TableMetaId' => [ - 'description' => '数据表ID，可通过ListTableMetas获取。', - 'type' => 'string', - 'required' => true, - 'example' => '2', - ], - 'ResultResourceId' => [ - 'description' => '写回数据表的数据源的ID，可以通过ListInstanceResources获取。', - 'type' => 'string', - 'required' => false, - 'example' => '3', - ], - 'Definition' => [ - 'description' => '指标定义。', - 'type' => 'string', - 'required' => true, - 'example' => 'sum(click_cnt)', - ], - 'StatisticsCycle' => [ - 'description' => '统计周期。', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', - ], - 'LeftMetricId' => [ - 'description' => '衍生指标的左指标ID。', - 'type' => 'string', - 'required' => false, - 'example' => '2', - ], - 'RightMetricId' => [ - 'description' => '衍生指标的右指标ID。', - 'type' => 'string', - 'required' => false, - 'example' => '3', - ], - 'Operator' => [ - 'description' => '衍生指标计算的操作符。'."\n" - ."\n" - .'- Plus-加'."\n" - ."\n" - .'- Minus-减'."\n" - ."\n" - .'- Multiplication-乘'."\n" - ."\n" - .'- Division-除', - 'type' => 'string', - 'required' => false, - 'example' => 'Division', - ], - 'InstanceId' => [ - 'description' => '实例ID，可从接口[ListInstances](~~2411819~~)获取。', - 'type' => 'string', - 'required' => true, - 'example' => 'pairec-cn-test1', - ], + 'InstanceId' => ['title' => '实例ID。', 'description' => '实例ID，可通过接口ListInstances获取。', 'type' => 'string', 'required' => true, 'example' => 'pairec-cn-abcdefg1234'], ], 'required' => false, ], @@ -12952,143 +12506,136 @@ 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => '请求ID。', - 'type' => 'string', - 'example' => 'F7AC05FF-EDE7-5C2B-B9AE-33D6DF4178BA', - ], - 'ABMetricId' => [ - 'description' => 'AB指标ID。', - 'type' => 'string', - 'example' => '1', - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => '59CE7EC6-F268-5D71-9215-32922CC50D72'], ], ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"59CE7EC6-F268-5D71-9215-32922CC50D72\\"\\n}","type":"json"}]', + 'title' => '下线实验室', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'pairec:OfflineLaboratory', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIRecService', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"F7AC05FF-EDE7-5C2B-B9AE-33D6DF4178BA\\",\\n \\"ABMetricId\\": \\"1\\"\\n}","type":"json"}]', - 'title' => '创建AB指标', ], - 'ListABMetrics' => [ - 'summary' => '获取AB实验指标列表。', - 'path' => '/api/v1/abmetrics', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'OfflineRecallManagementService' => [ + 'path' => '/api/v1/recallmanagementservices/{RecallManagementServiceId}/action/offline', + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], - 'operationType' => 'read', + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'list', + 'operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATURElearnN0NAWV', - ], + 'abilityTreeNodes' => ['FEATURElearnN0NAWV'], ], 'parameters' => [ [ - 'name' => 'Type', - 'in' => 'query', - 'schema' => [ - 'description' => '指标类型过滤。'."\n" - ."\n" - .'- Single-单一指标。'."\n" - ."\n" - .'- Derived-衍生指标。', - 'type' => 'string', - 'required' => false, - 'example' => 'Single', - ], - ], - [ - 'name' => 'Realtime', - 'in' => 'query', - 'schema' => [ - 'description' => '是否指标实时类型过滤。', - 'type' => 'boolean', - 'required' => false, - 'example' => 'false', - ], - ], - [ - 'name' => 'PageNumber', - 'in' => 'query', - 'schema' => [ - 'description' => '页码。', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', - ], + 'name' => 'RecallManagementServiceId', + 'in' => 'path', + 'schema' => ['description' => '召回管理服务ID。'."\n", 'type' => 'string', 'required' => false, 'example' => '3'], ], [ - 'name' => 'PageSize', - 'in' => 'query', + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', 'schema' => [ - 'description' => '页大小。', - 'type' => 'integer', - 'format' => 'int32', + 'description' => '请求body。', + 'type' => 'object', + 'properties' => [ + 'InstanceId' => ['description' => '实例ID。'."\n", 'type' => 'string', 'required' => false, 'example' => 'pairec-cn-test123'], + ], 'required' => false, - 'example' => '10', ], ], - [ - 'name' => 'Name', - 'in' => 'query', + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => '名称过滤。', - 'type' => 'string', - 'required' => false, - 'example' => 'home', + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => '728C5E01-ABF6-5AA8-B9FC-B3BA05DECC77'], + ], ], ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '下线召回管理服务', + 'summary' => '用于将指定的召回管理服务设置为离线状态。', + 'description' => '## 请求说明'."\n" + .'通过此API，您可以将特定的召回管理服务设置为离线状态。请确保提供的`RecallManagementServiceId`和`InstanceId`准确无误，以避免错误操作。'."\n" + ."\n" + .'- **重要提示**：一旦某个召回管理服务被设置为离线状态，它将不再处理新的请求，直到再次被激活。'."\n" + ."\n" + .'- 确保在执行此操作前已经备份了所有必要的数据或配置，以防需要恢复到当前状态。'."\n", + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"728C5E01-ABF6-5AA8-B9FC-B3BA05DECC77\\"\\n}","type":"json"}]', + ], + 'OnlineExperiment' => [ + 'summary' => '将指定实验发布上线。', + 'path' => '/api/v1/experiments/{ExperimentId}/action/online', + 'methods' => ['post'], + 'schemes' => ['http', 'https'], + 'security' => [ [ - 'name' => 'TableMetaId', - 'in' => 'query', - 'schema' => [ - 'description' => '数据表ID，可通过ListTableMetas获取。', - 'type' => 'string', - 'required' => false, - 'example' => '1', - ], + 'AK' => [], ], + ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATURElearnN0NAWV'], + ], + 'parameters' => [ [ - 'name' => 'InstanceId', - 'in' => 'query', - 'schema' => [ - 'description' => '实例ID，可通过接口[ListInstances](~~2411819~~)获取。', - 'type' => 'string', - 'required' => true, - 'example' => 'pairec-cn-test1', - ], + 'name' => 'ExperimentId', + 'in' => 'path', + 'schema' => ['title' => '实验ID。', 'description' => '实验ID，可通过接口ListExperiments获取。', 'type' => 'string', 'required' => true, 'example' => '3'], ], [ - 'name' => 'SceneId', - 'in' => 'query', + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', 'schema' => [ - 'description' => '场景ID，来源于[ListScenes](~~2402581~~)接口。', - 'type' => 'string', + 'description' => '请求body。', + 'type' => 'object', + 'properties' => [ + 'InstanceId' => ['title' => '实例ID。', 'description' => '实例ID，可通过接口ListInstances获取。', 'type' => 'string', 'required' => false, 'example' => 'pairec-cn-abcdefg1234'], + ], 'required' => false, - 'example' => '1', ], ], ], @@ -13099,180 +12646,69 @@ 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => '请求ID。', - 'type' => 'string', - 'example' => 'F7AC05FF-EDE7-5C2B-B9AE-33D6DF4178BA', - ], - 'TotalCount' => [ - 'description' => '总个数。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '10', - ], - 'ABMetrics' => [ - 'description' => 'AB指标列表。', - 'type' => 'array', - 'items' => [ - 'description' => 'AB指标信息。', - 'type' => 'object', - 'properties' => [ - 'ABMetricId' => [ - 'description' => 'AB指标ID。', - 'type' => 'string', - 'example' => '1', - ], - 'Name' => [ - 'description' => '指标名称。', - 'type' => 'string', - 'example' => 'pv', - ], - 'Description' => [ - 'description' => '指标描述。', - 'type' => 'string', - 'example' => 'pv指标', - ], - 'SceneId' => [ - 'description' => '场景ID。', - 'type' => 'string', - 'example' => '1', - ], - 'SceneName' => [ - 'description' => '场景名称', - 'type' => 'string', - 'example' => 'home_feed', - ], - 'Type' => [ - 'description' => '指标类型。'."\n" - ."\n" - .'- Single-单一指标。'."\n" - ."\n" - .'- Derived-衍生指标。', - 'type' => 'string', - 'example' => 'Single', - ], - 'Realtime' => [ - 'description' => '是否为实时指标。'."\n" - ."\n" - .'- true-是。'."\n" - ."\n" - .'- false-否。', - 'type' => 'string', - 'example' => 'false', - ], - 'TableMetaId' => [ - 'description' => '数据表ID。', - 'type' => 'string', - 'example' => '1', - ], - 'ResultTableMetaId' => [ - 'description' => '数据写回到的数据表ID。', - 'type' => 'string', - 'example' => '2', - ], - 'ResultResourceId' => [ - 'description' => '写回数据表的数据源的ID。', - 'type' => 'string', - 'example' => '3', - ], - 'Definition' => [ - 'description' => '指标定义。', - 'type' => 'string', - 'example' => 'sum(click_cnt)', - ], - 'StatisticsCycle' => [ - 'description' => '统计周期。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'LeftMetricId' => [ - 'description' => '衍生指标的左指标ID。', - 'type' => 'string', - 'example' => '3', - ], - 'RightMetricId' => [ - 'description' => '衍生指标的右指标ID。', - 'type' => 'string', - 'example' => '2', - ], - 'Operator' => [ - 'description' => '衍生指标计算的操作符。'."\n" - ."\n" - .'- Plus-加'."\n" - ."\n" - .'- Minus-减'."\n" - ."\n" - .'- Multiplication-乘'."\n" - ."\n" - .'- Division-除', - 'type' => 'string', - 'example' => 'Division', - ], - ], - ], - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => '6CF1E160-3F36-5E73-A170-C75504F05BBC'], ], ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"6CF1E160-3F36-5E73-A170-C75504F05BBC\\"\\n}","type":"json"}]', + 'title' => '上线实验', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'pairec:OnlineExperiment', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIRecService', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"F7AC05FF-EDE7-5C2B-B9AE-33D6DF4178BA\\",\\n \\"TotalCount\\": 10,\\n \\"ABMetrics\\": [\\n {\\n \\"ABMetricId\\": \\"1\\",\\n \\"Name\\": \\"pv\\",\\n \\"Description\\": \\"pv指标\\",\\n \\"SceneId\\": \\"1\\",\\n \\"SceneName\\": \\"home_feed\\",\\n \\"Type\\": \\"Single\\",\\n \\"Realtime\\": \\"false\\",\\n \\"TableMetaId\\": \\"1\\",\\n \\"ResultTableMetaId\\": \\"2\\",\\n \\"ResultResourceId\\": \\"3\\",\\n \\"Definition\\": \\"sum(click_cnt)\\",\\n \\"StatisticsCycle\\": 1,\\n \\"LeftMetricId\\": \\"3\\",\\n \\"RightMetricId\\": \\"2\\",\\n \\"Operator\\": \\"Division\\"\\n }\\n ]\\n}","type":"json"}]', - 'title' => '获取AB指标列表', ], - 'GetABMetric' => [ - 'summary' => '获取AB实验指标详细信息。', - 'path' => '/api/v1/abmetrics/{ABMetricId}', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'OnlineExperimentGroup' => [ + 'summary' => '上线指定实验组。', + 'path' => '/api/v1/experimentgroups/{ExperimentGroupId}/action/online', + 'methods' => ['post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], - 'operationType' => 'read', + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'get', + 'operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATURElearnN0NAWV', - ], + 'abilityTreeNodes' => ['FEATURElearnN0NAWV'], ], 'parameters' => [ [ - 'name' => 'ABMetricId', + 'name' => 'ExperimentGroupId', 'in' => 'path', - 'schema' => [ - 'description' => 'AB指标ID。', - 'type' => 'string', - 'required' => true, - 'example' => '1', - ], + 'schema' => ['title' => '实验组ID。', 'description' => '实验组ID，可通过接口ListExperimentGroups获取。', 'type' => 'string', 'required' => true, 'example' => '3'], ], [ - 'name' => 'InstanceId', - 'in' => 'query', + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', 'schema' => [ - 'description' => '实例ID，可通过接口[ListInstances](~~2411819~~)获取。', - 'type' => 'string', - 'required' => true, - 'example' => 'pairec-cn-test1', + 'description' => '请求body。', + 'type' => 'object', + 'properties' => [ + 'InstanceId' => ['title' => '实例ID。', 'description' => '实例ID，可通过接口ListInstances获取。', 'type' => 'string', 'required' => true, 'example' => 'pairec-cn-abcdefg1234'."\n"], + ], + 'required' => false, ], ], ], @@ -13283,159 +12719,69 @@ 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => '请求ID。', - 'type' => 'string', - 'example' => '728C5E01-ABF6-5AA8-B9FC-B3BA05DECC77', - ], - 'Name' => [ - 'description' => '指标名称。', - 'type' => 'string', - 'example' => 'pv', - ], - 'Description' => [ - 'description' => '指标描述。', - 'type' => 'string', - 'example' => '页面访问次数', - ], - 'SceneId' => [ - 'description' => '场景ID。', - 'type' => 'string', - 'example' => '1', - ], - 'SceneName' => [ - 'description' => '场景名称。', - 'type' => 'string', - 'example' => 'home_feed', - ], - 'Type' => [ - 'description' => '指标类型。'."\n" - ."\n" - .'- Single-单一指标。'."\n" - ."\n" - .'- Derived-衍生指标。', - 'type' => 'string', - 'example' => 'Single', - ], - 'Realtime' => [ - 'description' => '是否为实时指标。'."\n" - ."\n" - .'- true-是。'."\n" - ."\n" - .'- false-否。', - 'type' => 'string', - 'example' => 'false', - ], - 'TableMetaId' => [ - 'description' => '来源数据表ID。', - 'type' => 'string', - 'example' => '2', - ], - 'ResultTableMetaId' => [ - 'description' => '数据写回到的数据表ID。', - 'type' => 'string', - 'example' => '3', - ], - 'ResultResourceId' => [ - 'description' => '写回数据表的数据源的ID。', - 'type' => 'string', - 'example' => '5', - ], - 'Definition' => [ - 'description' => '指标定义。', - 'type' => 'string', - 'example' => 'sum(click_cnt)', - ], - 'StatisticsCycle' => [ - 'description' => '统计周期。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'LeftMetricId' => [ - 'description' => '衍生指标的左指标ID。', - 'type' => 'string', - 'example' => '3', - ], - 'RightMetricId' => [ - 'description' => '衍生指标的右指标ID。', - 'type' => 'string', - 'example' => '2', - ], - 'Operator' => [ - 'description' => '衍生指标计算的操作符。'."\n" - ."\n" - .'- Plus-加'."\n" - ."\n" - .'- Minus-减'."\n" - ."\n" - .'- Multiplication-乘'."\n" - ."\n" - .'- Division-除', - 'type' => 'string', - 'example' => 'Division', - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => '47F761ED-BE4E-51A6-B678-78E1490DF313'], ], ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"47F761ED-BE4E-51A6-B678-78E1490DF313\\"\\n}","type":"json"}]', + 'title' => '上线实验组', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'pairec:OnlineExperimentGroup', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIRecService', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"728C5E01-ABF6-5AA8-B9FC-B3BA05DECC77\\",\\n \\"Name\\": \\"pv\\",\\n \\"Description\\": \\"页面访问次数\\",\\n \\"SceneId\\": \\"1\\",\\n \\"SceneName\\": \\"home_feed\\",\\n \\"Type\\": \\"Single\\",\\n \\"Realtime\\": \\"false\\",\\n \\"TableMetaId\\": \\"2\\",\\n \\"ResultTableMetaId\\": \\"3\\",\\n \\"ResultResourceId\\": \\"5\\",\\n \\"Definition\\": \\"sum(click_cnt)\\",\\n \\"StatisticsCycle\\": 1,\\n \\"LeftMetricId\\": \\"3\\",\\n \\"RightMetricId\\": \\"2\\",\\n \\"Operator\\": \\"Division\\"\\n}","type":"json"}]', - 'title' => '获取AB指标详细信息', ], - 'DeleteABMetric' => [ - 'summary' => '删除指定AB实验指标。', - 'path' => '/api/v1/abmetrics/{ABMetricId}', - 'methods' => [ - 'delete', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'OnlineLaboratory' => [ + 'summary' => '将指定实验室进行发布上线，以开展实验分析。', + 'path' => '/api/v1/laboratories/{LaboratoryId}/action/online', + 'methods' => ['post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'delete', + 'operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATURElearnN0NAWV', - ], + 'abilityTreeNodes' => ['FEATURElearnN0NAWV'], ], 'parameters' => [ [ - 'name' => 'ABMetricId', + 'name' => 'LaboratoryId', 'in' => 'path', - 'schema' => [ - 'description' => 'AB指标ID。', - 'type' => 'string', - 'required' => true, - 'example' => '1', - ], + 'schema' => ['title' => '实验室ID。', 'description' => '实验室ID，可通过接口ListLaboratories获取。', 'type' => 'string', 'required' => true, 'example' => '3'], ], [ - 'name' => 'InstanceId', - 'in' => 'query', + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', 'schema' => [ - 'description' => '实例ID，可通过接口[ListInstances](~~2411819~~)获取。', - 'type' => 'string', - 'required' => true, - 'example' => 'pairec-cn-test1', + 'description' => '请求body。', + 'type' => 'object', + 'properties' => [ + 'InstanceId' => ['title' => '实例ID。', 'description' => '实例ID，可通过接口ListInstances获取。', 'type' => 'string', 'required' => true, 'example' => 'pairec-test1'], + ], + 'required' => false, ], ], ], @@ -13446,142 +12792,66 @@ 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => '请求ID。', - 'type' => 'string', - 'example' => '728C5E01-ABF6-5AA8-B9FC-B3BA05DECC77', - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => '8C27790E-CCA5-56BB-BA17-646295DEC0A2'], ], ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"8C27790E-CCA5-56BB-BA17-646295DEC0A2\\"\\n}","type":"json"}]', + 'title' => '上线实验室', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'pairec:OnlineLaboratory', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIRecService', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"728C5E01-ABF6-5AA8-B9FC-B3BA05DECC77\\"\\n}","type":"json"}]', - 'title' => '删除AB指标', ], - 'ReportABMetricGroup' => [ - 'summary' => '查询指标组的报表。', - 'path' => '/api/v1/abmetricgroups/{ABMetricGroupId}/action/report', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'OnlineRecallManagementService' => [ + 'path' => '/api/v1/recallmanagementservices/{RecallManagementServiceId}/action/online', + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], - 'operationType' => 'read', + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATURElearnN0NAWV', - ], + 'abilityTreeNodes' => ['FEATURElearnN0NAWV'], ], 'parameters' => [ [ - 'name' => 'ABMetricGroupId', + 'name' => 'RecallManagementServiceId', 'in' => 'path', - 'schema' => [ - 'description' => '指标组ID。', - 'type' => 'string', - 'required' => true, - 'example' => '1', - ], + 'schema' => ['description' => '召回管理服务ID。'."\n", 'type' => 'string', 'required' => false, 'example' => '3'], ], [ 'name' => 'body', 'in' => 'body', 'style' => 'json', 'schema' => [ - 'description' => '请求体参数。', + 'description' => '请求Body。', 'type' => 'object', 'properties' => [ - 'InstanceId' => [ - 'description' => '实例ID，可通过接口[ListInstances](~~2411819~~)获取。', - 'type' => 'string', - 'required' => true, - 'example' => 'pairec-cn-test1', - ], - 'ReportType' => [ - 'description' => '报表类型。'."\n" - ."\n" - .'- Realtime-实时报表'."\n" - ."\n" - .'- Offline-离线报表'."\n" - ."\n" - .'- Market-大盘报表', - 'type' => 'string', - 'required' => true, - 'example' => 'Offline', - ], - 'SceneId' => [ - 'description' => '场景ID，可通过[ListScenes](~~2402581~~)获取。', - 'type' => 'string', - 'required' => false, - 'example' => '1', - ], - 'ExperimentGroupId' => [ - 'description' => '实验组ID，可通过接口[ListExperimentGroups](~~2402573~~)获取（离线、实时报表需要）。', - 'type' => 'string', - 'required' => false, - 'example' => '3', - ], - 'ExperimentIds' => [ - 'description' => '实验ID列表，可通过[ListExperiments](~~2402582~~)获取。', - 'type' => 'string', - 'required' => true, - 'example' => '3,4,5', - ], - 'BaseExperimentId' => [ - 'description' => '基准实验ID。', - 'type' => 'string', - 'required' => true, - 'example' => '3', - ], - 'TimeStatisticsMethod' => [ - 'description' => '统计时间类型（实时报表需要）。'."\n" - ."\n" - .'- Hour-按小时统计。'."\n" - ."\n" - .'- Day-从当日0点开始累加。', - 'type' => 'string', - 'required' => false, - 'example' => 'Hour', - ], - 'DimensionFields' => [ - 'description' => '维度字段。', - 'type' => 'string', - 'required' => false, - 'example' => '{"gender":"man"}', - ], - 'StartDate' => [ - 'description' => '开始日期。', - 'type' => 'string', - 'required' => false, - 'example' => '2021-07-01', - ], - 'EndDate' => [ - 'description' => '结束日期。', - 'type' => 'string', - 'required' => false, - 'example' => '2021-07-01', - ], + 'InstanceId' => ['description' => '实例ID。'."\n", 'type' => 'string', 'required' => false, 'example' => 'pairec-cn-test123'], ], 'required' => false, ], @@ -13594,130 +12864,42 @@ 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => '请求ID。', - 'type' => 'string', - 'example' => '59CE7EC6-F268-5D71-9215-32922CC50D72', - ], - 'ExperimentReport' => [ - 'description' => '实验报表。', - 'type' => 'object', - 'additionalProperties' => [ - 'type' => 'object', - 'properties' => [ - 'Baseline' => [ - 'type' => 'boolean', - 'description' => '是否是基准实验数据。', - 'example' => 'true', - ], - 'MetricResults' => [ - 'type' => 'object', - 'additionalProperties' => [ - 'type' => 'object', - 'additionalProperties' => [ - 'type' => 'object', - 'properties' => [ - 'ExpId' => [ - 'type' => 'string', - 'description' => '实验ID。', - 'example' => '2', - ], - 'ExpName' => [ - 'type' => 'string', - 'example' => 'test实验', - 'description' => '实验名称。', - ], - 'MetricName' => [ - 'type' => 'string', - 'example' => 'pv', - 'description' => '指标名称。', - ], - 'MetricValue' => [ - 'type' => 'string', - 'example' => '100', - 'description' => '指标值。', - ], - 'DimensionValue' => [ - 'type' => 'string', - 'example' => 'ALL', - 'description' => '维度值。', - ], - 'Date' => [ - 'type' => 'string', - 'example' => '20230206', - 'description' => '日期。', - ], - 'PercentDiff' => [ - 'type' => 'string', - 'description' => '相较于base的增长率。', - 'example' => '0.1', - ], - 'PercentDiffStr' => [ - 'type' => 'string', - 'description' => '相较于base的增长率（string 类型）。', - 'example' => '"0.1"', - ], - ], - 'description' => '指标结果。', - ], - 'description' => '指标结果。', - ], - 'description' => '指标结果。', - ], - ], - 'description' => '报表信息。', - ], - ], - 'GroupDimension' => [ - 'description' => '维度字段。', - 'type' => 'array', - 'items' => [ - 'description' => '维度信息。', - 'type' => 'string', - 'example' => '["all"]', - ], - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => '请求id。'."\n", 'type' => 'string', 'example' => '728C5E01-ABF6-5AA8-B9FC-B3BA05DECC77'], ], ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '上线召回管理服务', + 'summary' => '用于将指定的召回管理服务上线。', + 'description' => '## 请求说明'."\n" + .'该API允许用户通过提供召回管理服务ID和实例ID，来启动或重新激活一个召回管理服务。请确保提供的`RecallManagementServiceId`和`InstanceId`是正确的，并且您拥有足够的权限执行此操作。'."\n", + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"59CE7EC6-F268-5D71-9215-32922CC50D72\\",\\n \\"ExperimentReport\\": {\\n \\"key\\": {\\n \\"Baseline\\": true,\\n \\"MetricResults\\": {\\n \\"key\\": {\\n \\"key\\": {\\n \\"ExpId\\": \\"2\\",\\n \\"ExpName\\": \\"test实验\\",\\n \\"MetricName\\": \\"pv\\",\\n \\"MetricValue\\": \\"100\\",\\n \\"DimensionValue\\": \\"ALL\\",\\n \\"Date\\": \\"20230206\\",\\n \\"PercentDiff\\": \\"0.1\\",\\n \\"PercentDiffStr\\": \\"\\\\\\"0.1\\\\\\"\\"\\n }\\n }\\n }\\n }\\n },\\n \\"GroupDimension\\": [\\n \\"[\\\\\\"all\\\\\\"]\\"\\n ]\\n}","type":"json"}]', - 'title' => '查询指标组报表', + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"728C5E01-ABF6-5AA8-B9FC-B3BA05DECC77\\"\\n}","type":"json"}]', ], - 'UpdateABMetricGroup' => [ - 'summary' => '更新AB实验指标组。', - 'path' => '/api/v1/abmetricgroups/{ABMetricGroupId}', - 'methods' => [ - 'put', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'PublishRecallManagementTable' => [ + 'summary' => '将MaxCompute表同步到召回引擎中，支持分区发布和模式选择。', + 'path' => '/api/v1/recallmanagementtables/{RecallManagementTableId}/action/publish', + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'update', + 'operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATURElearnN0NAWV', - ], + 'abilityTreeNodes' => ['FEATURElearnN0NAWV'], ], 'parameters' => [ [ @@ -13725,58 +12907,34 @@ 'in' => 'body', 'style' => 'json', 'schema' => [ - 'description' => '请求体参数。', + 'description' => '请求Body。', 'type' => 'object', 'properties' => [ - 'Name' => [ - 'description' => '指标组名称。', - 'type' => 'string', - 'required' => true, - 'example' => 'visits', - ], - 'SceneId' => [ - 'description' => '场景ID，可通过接口[ListScenes](~~2402581~~)获取。', - 'type' => 'string', - 'required' => true, - 'example' => '1', - ], - 'Description' => [ - 'description' => '指标组描述。', - 'type' => 'string', - 'required' => true, - 'example' => '访问量相关指标', - ], - 'ABMetricIds' => [ - 'description' => 'AB实验指标ID列表，逗号分隔。', - 'type' => 'string', - 'required' => true, - 'example' => '1,2', - ], - 'InstanceId' => [ - 'description' => '实例ID，可从接口[ListInstances](~~2411819~~)获取。', - 'type' => 'string', - 'required' => true, - 'example' => 'pairec-cn-test1', + 'InstanceId' => ['description' => '**实例ID。**'."\n", 'type' => 'string', 'required' => true, 'example' => 'pairec-test1'], + 'Partition' => [ + 'description' => '发布表的分区。', + 'type' => 'object', + 'required' => false, + 'additionalProperties' => ['type' => 'string', 'example' => '{"ds":"20250711"}', 'description' => '分区信息。'], ], - 'Realtime' => [ - 'description' => '是否为实时指标组。', - 'type' => 'boolean', - 'required' => true, - 'example' => 'false', + 'SkipThresholdCheck' => ['description' => '**同步表时，是否跳过阈值检查**'."\n", 'type' => 'boolean', 'required' => false, 'example' => 'false'], + 'Mode' => ['description' => '**同步表的模式枚举值**：'."\n" + .'- `Merge`：聚合。'."\n", 'type' => 'string', 'required' => false, 'example' => 'Merge'], + 'Partitions' => [ + 'title' => '分区信息。', + 'description' => '发布表的分区。', + 'type' => 'object', + 'required' => false, + 'additionalProperties' => ['title' => '分区值。', 'description' => '分区值。', 'type' => 'string', 'example' => '{"ds":"20250711"}'], ], ], 'required' => false, ], ], [ - 'name' => 'ABMetricGroupId', + 'name' => 'RecallManagementTableId', 'in' => 'path', - 'schema' => [ - 'description' => '指标组ID。', - 'type' => 'string', - 'required' => true, - 'example' => '1', - ], + 'schema' => ['description' => '表Id'."\n", 'type' => 'string', 'required' => false, 'example' => '3'], ], ], 'responses' => [ @@ -13786,98 +12944,70 @@ 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => '请求ID。', - 'type' => 'string', - 'example' => '74D958EF-3598-56FA-8296-FF1575CE43DF', - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => '请求ID。'."\n", 'type' => 'string', 'example' => '728C5E01-ABF6-5AA8-B9FC-B3BA05DECC77'], + 'RecallManagementJobId' => ['description' => '召回管理任务ID。'."\n", 'type' => 'string', 'example' => '1'], ], ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '同步召回管理表', + 'description' => '## 请求说明'."\n" + .'该API用于将指定的MaxCompute表同步至召回引擎，并允许用户指定发布的表分区、是否跳过阈值检查以及同步模式（聚合或覆盖）。请确保在请求体中正确填写实例ID及表ID，在路径参数中提供正确的`RecallManagementTableId`。如果需要指定特定的表分区进行发布，请通过`Partitions`字段以键值对形式给出。此外，还可以选择是否跳过数据量阈值检查以及设置同步模式。'."\n", + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'pairec:PublishRecallManagementTable', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIRecService', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"74D958EF-3598-56FA-8296-FF1575CE43DF\\"\\n}","type":"json"}]', - 'title' => '更新指标组', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"728C5E01-ABF6-5AA8-B9FC-B3BA05DECC77\\",\\n \\"RecallManagementJobId\\": \\"1\\"\\n}","type":"json"}]', ], - 'CreateABMetricGroup' => [ - 'summary' => '创建AB实验指标组。', - 'path' => '/api/v1/abmetricgroups', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'PushAllExperiment' => [ + 'summary' => '对于效果较优且稳定的实验，可对该实验进行推全。对某个实验推全后，该实验所属的实验组将结束生命周期，不再支持继续实验。平台会生成一个新的实验组，被推全的实验将在该实验组下占有全额的流量。', + 'path' => '/api/v1/experiments/{ExperimentId}/action/pushall', + 'methods' => ['post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'create', + 'operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATURElearnN0NAWV', - ], + 'abilityTreeNodes' => ['FEATURElearnN0NAWV'], ], 'parameters' => [ [ + 'name' => 'ExperimentId', + 'in' => 'path', + 'schema' => ['title' => '实验ID。', 'description' => '实验ID，可通过接口ListExperiments获取。', 'type' => 'string', 'required' => true, 'example' => '3'], + ], + [ 'name' => 'body', 'in' => 'body', 'style' => 'json', 'schema' => [ - 'description' => '请求体参数。', + 'description' => '请求body。', 'type' => 'object', 'properties' => [ - 'Name' => [ - 'description' => '指标组名称。', - 'type' => 'string', - 'required' => true, - 'example' => 'visits', - ], - 'SceneId' => [ - 'description' => '场景ID，可通过接口[ListScenes](~~2402581~~)获取。', - 'type' => 'string', - 'required' => true, - 'example' => '1', - ], - 'Description' => [ - 'description' => '指标组描述。', - 'type' => 'string', - 'required' => true, - 'example' => '访问量相关指标', - ], - 'ABMetricIds' => [ - 'description' => 'AB实验指标ID列表，逗号分隔。', - 'type' => 'string', - 'required' => true, - 'example' => '1,2', - ], - 'InstanceId' => [ - 'description' => '实例ID，可通过接口[ListInstances](~~2411819~~)获取。', - 'type' => 'string', - 'required' => true, - 'example' => 'pairec-cn-test1', - ], - 'Realtime' => [ - 'description' => '是否为实时指标组。', - 'type' => 'boolean', - 'required' => true, - 'example' => 'false', - ], + 'InstanceId' => ['title' => '实例ID。', 'description' => '实例ID，可通过接口ListInstances获取。', 'type' => 'string', 'required' => false, 'example' => 'pairec-cn-abcdefg1234'], ], 'required' => false, ], @@ -13890,136 +13020,163 @@ 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => '请求ID。', - 'type' => 'string', - 'example' => 'E15A1443-7917-5BE0-AE70-25538ECF398D', - ], - 'ABMetricGroupId' => [ - 'description' => '指标组ID。', - 'type' => 'string', - 'example' => '1', - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => '74D958EF-3598-56FA-8296-FF1575CE43DF'], ], ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"74D958EF-3598-56FA-8296-FF1575CE43DF\\"\\n}","type":"json"}]', + 'title' => '推全实验', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'pairec:PushAllExperiment', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIRecService', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"E15A1443-7917-5BE0-AE70-25538ECF398D\\",\\n \\"ABMetricGroupId\\": \\"1\\"\\n}","type":"json"}]', - 'title' => '创建指标组', ], - 'ListABMetricGroups' => [ - 'summary' => '获取AB实验指标组列表。', - 'path' => '/api/v1/abmetricgroups', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'QueryDataDiagnosisStatistics' => [ + 'summary' => '获取指定数据诊断在某时间范围内的统计信息。', + 'path' => '/api/v1/datadiagnoses/{DataDiagnosisId}/statistics/action/query', + 'methods' => ['post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], - 'operationType' => 'read', + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'list', + 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATURElearnN0NAWV', - ], + 'abilityTreeNodes' => ['FEATURElearnN0NAWV'], ], 'parameters' => [ [ - 'name' => 'SceneId', - 'in' => 'query', - 'schema' => [ - 'description' => '场景ID，可通过接口[ListScenes]((~~2402581~~))获取。', - 'type' => 'string', - 'required' => false, - 'example' => '1', - ], + 'name' => 'DataDiagnosisId', + 'in' => 'path', + 'schema' => ['description' => '数据诊断ID。'."\n", 'type' => 'string', 'required' => true, 'example' => '1'], ], [ 'name' => 'InstanceId', 'in' => 'query', - 'schema' => [ - 'description' => '实例ID，可通过接口[ListInstances](~~2411819~~)获取。', - 'type' => 'string', - 'required' => true, - 'example' => 'pairec-cn-test1', - ], + 'schema' => ['description' => '实例ID。'."\n", 'type' => 'string', 'required' => false, 'example' => 'learn-pairec-xxx'], ], [ - 'name' => 'PageNumber', + 'name' => 'StartDate', 'in' => 'query', - 'schema' => [ - 'description' => '页码。', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', - ], + 'schema' => ['description' => '开始日期。', 'type' => 'string', 'required' => false, 'example' => '2023-08-01'], ], [ - 'name' => 'PageSize', + 'name' => 'EndDate', 'in' => 'query', - 'schema' => [ - 'description' => '页大小。', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '10', - ], + 'schema' => ['description' => '结束日期。', 'type' => 'string', 'required' => false, 'example' => '2023-08-08'], ], [ - 'name' => 'Realtime', + 'name' => 'RemainRateType', 'in' => 'query', + 'schema' => ['description' => '留存率报表类型。'."\n" + ."\n" + .'- Period-周期报表。', 'type' => 'string', 'required' => false, 'example' => 'Period'], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => '指标组实时类型过滤', - 'type' => 'boolean', - 'required' => false, - 'example' => 'false', + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['title' => 'Id of the request', 'description' => '请求ID。'."\n", 'type' => 'string', 'example' => '728C5E01-ABF6-5AA8-B9FC-B3BA05DECC77'], + 'Statistics' => [ + 'description' => '数据诊断任务列表。', + 'type' => 'object', + 'properties' => [ + 'FailedDates' => [ + 'description' => '任务失败的日期列表。', + 'type' => 'array', + 'items' => ['description' => '任务失败日期。', 'type' => 'string', 'example' => '20230802'], + ], + 'NoDataDates' => [ + 'description' => '缺失任务的日期列表。', + 'type' => 'array', + 'items' => ['description' => '缺失任务的日期。', 'type' => 'string', 'example' => '20230802'], + ], + ], + ], + ], ], ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '数据诊断统计查询', + 'description' => '## 请求说明'."\n" + .'- `DataDiagnosisId` 是必填项，用于指定要查询的数据诊断任务。'."\n" + .'- `InstanceId` 也是必填参数，用来标识具体的实例。'."\n" + .'- `StartDate` 和 `EndDate` 分别表示统计的起始和结束日期，格式为 YYYY-MM-DD。'."\n" + .'- `RemainRateType` 参数是可选的，如果提供，则可以指定留存率报表类型，默认值为 \'Period\' 表示周期报表。'."\n" + .'- 返回结果中包含请求ID (`RequestId`) 以及统计数据对象 (`Statistics`)，其中列出了任务失败的日期列表 (`FailedDates`) 和缺失任务的日期列表 (`NoDataDates`)。'."\n", + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"728C5E01-ABF6-5AA8-B9FC-B3BA05DECC77\\",\\n \\"Statistics\\": {\\n \\"FailedDates\\": [\\n \\"20230802\\"\\n ],\\n \\"NoDataDates\\": [\\n \\"20230802\\"\\n ]\\n }\\n}","type":"json"}]', + ], + 'QueryRecallManagementTableRecords' => [ + 'path' => '/api/v1/recallmanagementtables/{RecallManagementTableId}/queryrecords', + 'methods' => ['get'], + 'schemes' => ['https'], + 'security' => [ [ - 'name' => 'SortBy', + 'AK' => [], + ], + ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATURElearnN0NAWV'], + ], + 'parameters' => [ + [ + 'name' => 'RecallManagementTableId', + 'in' => 'path', + 'schema' => ['description' => '表ID。'."\n", 'type' => 'string', 'required' => false, 'example' => '3'], + ], + [ + 'name' => 'InstanceId', 'in' => 'query', - 'schema' => [ - 'description' => '排序依据，取值：'."\n" - ."\n" - .'- GmtCreateTime：创建时间。'."\n" - .'- GmtModifiedTime：更新时间。', - 'type' => 'string', - 'required' => false, - 'example' => 'GmtCreateTime', - ], + 'schema' => ['description' => '实例ID。'."\n", 'type' => 'string', 'required' => false, 'example' => 'pairec-cn-test123'], ], [ - 'name' => 'Order', + 'name' => 'PrimaryKeys', 'in' => 'query', - 'schema' => [ - 'description' => '排序方式，取值：'."\n" - ."\n" - .'- ASC：升序。'."\n" - .'- DESC：降序。', - 'type' => 'string', - 'required' => false, - 'example' => 'ASC', - ], + 'schema' => ['description' => '查询主键'."\n", 'type' => 'string', 'format' => 'byte', 'required' => false, 'example' => '["1001","1002"]'], + ], + [ + 'name' => 'RecallManagementTableVersionId', + 'in' => 'query', + 'schema' => ['description' => '召回管理表的版本ID。默认为当前发布版本'."\n", 'type' => 'string', 'required' => false, 'example' => '1'], ], ], 'responses' => [ @@ -14029,129 +13186,72 @@ 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => '请求ID。', - 'type' => 'string', - 'example' => 'E15A1443-7917-5BE0-AE70-25538ECF398D', - ], - 'TotalCount' => [ - 'description' => '总个数。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '10', - ], - 'ABMetricGroups' => [ - 'description' => 'AB指标组列表。', + 'RequestId' => ['title' => 'Id of the request', 'description' => '请求id。'."\n", 'type' => 'string', 'example' => '7D59453C-48AA-5FC5-8848-2D373BD1A17F'], + 'Records' => [ + 'description' => '数据列表。', 'type' => 'array', 'items' => [ - 'description' => 'AB指标组信息。', + 'description' => '数据表字段。', 'type' => 'object', - 'properties' => [ - 'ABMetricGroupId' => [ - 'description' => '指标组ID。', - 'type' => 'string', - 'example' => '1', - ], - 'Name' => [ - 'description' => '指标组名称。', - 'type' => 'string', - 'example' => 'visits', - ], - 'SceneId' => [ - 'description' => '场景ID。', - 'type' => 'string', - 'example' => '1', - ], - 'Description' => [ - 'description' => '指标组描述。', - 'type' => 'string', - 'example' => '访问量相关指标', - ], - 'Owner' => [ - 'description' => '负责人。', - 'type' => 'string', - 'example' => '2799614***', - ], - 'ABMetricIds' => [ - 'description' => 'AB实验指标ID列表，逗号分隔。', - 'type' => 'string', - 'example' => '1,2', - ], - 'ABMetricNames' => [ - 'description' => 'AB实验指标名称列表，逗号分隔。', - 'type' => 'string', - 'example' => 'pv,uv', - ], - 'Realtime' => [ - 'description' => '是否为实时指标组。', - 'type' => 'boolean', - 'example' => 'false', - ], - ], + 'additionalProperties' => ['type' => 'any', 'description' => '数据表值。', 'example' => '""'], ], ], ], ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '查询召回管理表数据', + 'summary' => '获取指定召回管理表中的记录列表。', + 'description' => '## 请求说明'."\n" + .'本API用于根据给定的主键从特定的召回管理表中检索数据记录。请确保提供的`InstanceId`和`RecallManagementTableId`是有效的，并且`PrimaryKeys`列表不为空。如果指定了`RecallManagementTableVersionId`，则返回该版本的数据；否则，默认使用当前发布的版本。'."\n", + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"E15A1443-7917-5BE0-AE70-25538ECF398D\\",\\n \\"TotalCount\\": 10,\\n \\"ABMetricGroups\\": [\\n {\\n \\"ABMetricGroupId\\": \\"1\\",\\n \\"Name\\": \\"visits\\",\\n \\"SceneId\\": \\"1\\",\\n \\"Description\\": \\"访问量相关指标\\",\\n \\"Owner\\": \\"2799614***\\",\\n \\"ABMetricIds\\": \\"1,2\\",\\n \\"ABMetricNames\\": \\"pv,uv\\",\\n \\"Realtime\\": false\\n }\\n ]\\n}","type":"json"}]', - 'title' => '获取指标组列表', + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"7D59453C-48AA-5FC5-8848-2D373BD1A17F\\",\\n \\"Records\\": [\\n {\\n \\"key\\": \\"\\\\\\"\\\\\\"\\"\\n }\\n ]\\n}","type":"json"}]', ], - 'GetABMetricGroup' => [ - 'summary' => '获取AB实验指标组详细信息。', - 'path' => '/api/v1/abmetricgroups/{ABMetricGroupId}', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'QueryTrafficControlTargetItemReportDetail' => [ + 'path' => '/api/v1/trafficcontroltargets/{TrafficControlTargetId}/itemcontrolreportdetail', + 'methods' => ['get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'get', + 'operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATURElearnN0NAWV', - ], + 'abilityTreeCode' => '254723', + 'abilityTreeNodes' => ['FEATURElearnVYA4L9'], ], 'parameters' => [ [ - 'name' => 'ABMetricGroupId', + 'name' => 'TrafficControlTargetId', 'in' => 'path', - 'schema' => [ - 'description' => '指标组ID。', - 'type' => 'string', - 'required' => true, - 'example' => '1', - ], + 'schema' => ['description' => '调控目标ID。'."\n", 'type' => 'string', 'required' => true, 'example' => '1'], ], [ 'name' => 'InstanceId', 'in' => 'query', - 'schema' => [ - 'description' => '实例ID，可通过接口[ListInstances](~~2411819~~)获取。', - 'type' => 'string', - 'required' => true, - 'example' => 'pairec-cn-test1', - ], + 'schema' => ['description' => '实例ID。'."\n", 'type' => 'string', 'required' => true, 'example' => 'pairec_123****'], + ], + [ + 'name' => 'Environment', + 'in' => 'query', + 'schema' => ['description' => '所属的环境。Daily-日常环境Pre-预发环境Prod-生产环境'."\n", 'type' => 'string', 'required' => true, 'example' => 'Pre'], + ], + [ + 'name' => 'Date', + 'in' => 'query', + 'schema' => ['description' => '报表的日期'."\n", 'type' => 'string', 'required' => false, 'example' => '2024-01-01'], ], ], 'responses' => [ @@ -14161,108 +13261,100 @@ 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => '请求ID。', - 'type' => 'string', - 'example' => '01D22D08-BA20-5F35-8302-99115F288220', - ], - 'Name' => [ - 'description' => '指标组名称。', - 'type' => 'string', - 'example' => 'visits', - ], - 'SceneId' => [ - 'description' => '场景ID，来源于[ListScenes](https://icms.alibaba-inc.com/content/learn/pai?l=1&m=16768&n=4298955)接口。', - 'type' => 'string', - 'example' => '1', - ], - 'Description' => [ - 'description' => '指标组描述。', - 'type' => 'string', - 'example' => '访问量相关指标', - ], - 'Owner' => [ - 'description' => '负责人。', - 'type' => 'string', - 'example' => '2799614***'."\n", - ], - 'ABMetricIds' => [ - 'description' => 'AB实验指标ID列表，逗号分隔。', - 'type' => 'string', - 'example' => '1,2', - ], - 'ABMetricNames' => [ - 'description' => 'AB实验指标名称列表，逗号分隔。', - 'type' => 'string', - 'example' => 'pv,uv', - ], - 'Realtime' => [ - 'description' => '是否为实时指标组。', - 'type' => 'boolean', - 'example' => 'false', + 'RequestId' => ['title' => 'Id of the request', 'description' => '请求id。'."\n", 'type' => 'string', 'example' => '728C5E01-ABF6-5AA8-B9FC-B3BA05DECC77'], + 'TrafficControlTargetItemReportDetail' => [ + 'description' => 'item调控详情'."\n", + 'type' => 'object', + 'properties' => [ + 'ItemControlTopReportDetails' => [ + 'description' => 'item调控前100详情列表。', + 'type' => 'array', + 'items' => [ + 'description' => 'item调控前100详情。', + 'type' => 'object', + 'properties' => [ + 'ItemId' => ['description' => '物品ID。'."\n", 'type' => 'string', 'example' => '398734'], + 'TargetTraffic' => ['description' => '实际流量。', 'type' => 'integer', 'format' => 'int64', 'example' => '20'], + 'TargetProgress' => ['description' => '完成进度'."\n", 'type' => 'string', 'example' => '49%'], + 'Features' => [ + 'description' => '调控目标中限定的KV值'."\n", + 'type' => 'object', + 'additionalProperties' => ['type' => 'any', 'description' => '特征名称。', 'example' => 'age'], + ], + ], + ], + ], + 'ItemControlTailReportDetails' => [ + 'description' => 'item调控后100详情列表。', + 'type' => 'array', + 'items' => [ + 'description' => 'item调控后100详情。', + 'type' => 'object', + 'properties' => [ + 'ItemId' => ['description' => '物品ID。'."\n", 'type' => 'string', 'example' => '794872809896'], + 'TargetTraffic' => ['description' => '实际流量。', 'type' => 'integer', 'format' => 'int64', 'example' => '20'], + 'TargetProgress' => ['description' => '完成进度'."\n", 'type' => 'string', 'example' => '49%'], + 'Features' => [ + 'description' => '调控目标中限定的KV值'."\n", + 'type' => 'object', + 'additionalProperties' => ['type' => 'any', 'description' => '特征名称。', 'example' => 'age'], + ], + ], + ], + ], + ], ], ], ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '查询流量调控目标单品详情', + 'summary' => '获取指定日期内特定环境下的流量调控目标单品调控详情。', + 'description' => '## 请求说明'."\n" + .'本API用于查询给定调控目标在指定日期、实例ID及环境下的单品调控详情，包括调控前后各前100项物品的流量情况及其特征信息。请确保提供的`TrafficControlTargetId`、`InstanceId`以及`Environment`参数准确无误，并且`Date`格式正确（YYYY-MM-DD）。注意，虽然`Date`标记为非必填，但为了获得有意义的结果，建议总是提供具体的日期值。'."\n", + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"01D22D08-BA20-5F35-8302-99115F288220\\",\\n \\"Name\\": \\"visits\\",\\n \\"SceneId\\": \\"1\\",\\n \\"Description\\": \\"访问量相关指标\\",\\n \\"Owner\\": \\"2799614***\\\\n\\",\\n \\"ABMetricIds\\": \\"1,2\\",\\n \\"ABMetricNames\\": \\"pv,uv\\",\\n \\"Realtime\\": false\\n}","type":"json"}]', - 'title' => '获取指标组详细信息', + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"728C5E01-ABF6-5AA8-B9FC-B3BA05DECC77\\",\\n \\"TrafficControlTargetItemReportDetail\\": {\\n \\"ItemControlTopReportDetails\\": [\\n {\\n \\"ItemId\\": \\"398734\\",\\n \\"TargetTraffic\\": 20,\\n \\"TargetProgress\\": \\"49%\\",\\n \\"Features\\": {\\n \\"key\\": \\"age\\"\\n }\\n }\\n ],\\n \\"ItemControlTailReportDetails\\": [\\n {\\n \\"ItemId\\": \\"794872809896\\",\\n \\"TargetTraffic\\": 20,\\n \\"TargetProgress\\": \\"49%\\",\\n \\"Features\\": {\\n \\"key\\": \\"age\\"\\n }\\n }\\n ]\\n }\\n}","type":"json"}]', ], - 'DeleteABMetricGroup' => [ - 'summary' => '删除AB实验指标组。', - 'path' => '/api/v1/abmetricgroups/{ABMetricGroupId}', - 'methods' => [ - 'delete', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'QueryTrafficControlTaskDeployResult' => [ + 'summary' => '获取指定流量调控任务在特定环境下的部署状态和相关信息。', + 'path' => '/api/v1/trafficcontroltasks/{TrafficControlTaskId}/action/queryresult', + 'methods' => ['get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], - 'operationType' => 'write', + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'delete', + 'operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATURElearnN0NAWV', - ], + 'abilityTreeNodes' => ['FEATURElearnN0NAWV'], ], 'parameters' => [ [ - 'name' => 'ABMetricGroupId', + 'name' => 'TrafficControlTaskId', 'in' => 'path', - 'schema' => [ - 'description' => '指标组ID。', - 'type' => 'string', - 'required' => true, - 'example' => '1', - ], + 'schema' => ['description' => '流量调控 ID'."\n", 'type' => 'string', 'required' => false, 'example' => '1'], ], [ 'name' => 'InstanceId', 'in' => 'query', - 'schema' => [ - 'description' => '实例ID，可通过接口[ListInstances](~~2411819~~)获取。', - 'type' => 'string', - 'required' => true, - 'example' => 'pairec-cn-test1', - ], + 'schema' => ['description' => '实例ID。'."\n", 'type' => 'string', 'required' => false, 'example' => 'pairec_123****'], + ], + [ + 'name' => 'Environment', + 'in' => 'query', + 'schema' => ['description' => '所属的环境。Daily-日常环境Pre-预发环境Prod-生产环境'."\n", 'type' => 'string', 'required' => false, 'example' => 'Daily'], ], ], 'responses' => [ @@ -14272,197 +13364,129 @@ 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => '请求ID。', - 'type' => 'string', - 'example' => 'BDB621CB-A81E-5D39-8793-39A365CBCC74', - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => '请求id。'."\n", 'type' => 'string', 'example' => '728C5E01-ABF6-5AA8-B9FC-B3BA05DECC77'], + 'TrafficControlTaskId' => ['description' => '流量调控任务ID。'."\n", 'type' => 'string', 'example' => '3'], + 'DraftStatus' => ['description' => '推送草稿至Flink的状态，枚举值：'."\n" + .'- `Failed`：失败。'."\n" + .'- `Running`：运行中'."\n" + .'- `Success`：成功。'."\n", 'type' => 'string', 'example' => 'Success'], + 'DraftMessage' => ['description' => '推送草稿至Flink的信息'."\n", 'type' => 'string', 'example' => 'push draft success'], + 'DeployStatus' => ['description' => '部署草稿的状态，枚举值：'."\n" + .'- `Failed`：失败。'."\n" + .'- `Running`：运行中。'."\n" + .'- `Success`：成功。'."\n", 'type' => 'string', 'example' => 'Success'], + 'DeployMessage' => ['description' => 'flink 平台部署操作的信息。'."\n", 'type' => 'string', 'example' => 'deploy job draft success'], + 'StartStatus' => ['description' => '启动Flink任务状态，枚举值：'."\n" + .'- `Failed`：失败。'."\n" + .'- `Running`：运行中。'."\n" + .'- `Success`：成功。'."\n", 'type' => 'string', 'example' => 'Success'], + 'StartMessage' => ['description' => '启动flink任务信息。'."\n", 'type' => 'string', 'example' => 'start job success'], + 'PrepareStatus' => ['description' => '准备阶段的状态：'."\n" + .'- `Failed`：失败。'."\n" + .'- `Running`：运行中'."\n" + .'- `Success`：成功。'."\n", 'type' => 'string', 'example' => 'Success'], + 'PrepareMessage' => ['description' => '准备阶段信息。', 'type' => 'string', 'example' => 'success'], + 'StopStatus' => ['title' => '停止状态。', 'description' => '停止状态。', 'type' => 'string', 'example' => 'Success'], + 'StopMessage' => ['title' => '停止详情。', 'description' => '停止详情。', 'type' => 'string', 'example' => '""'], ], ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '查询流量调控任务部署结果', + 'description' => '## 请求说明'."\n" + .'通过此API，您可以查询特定`TrafficControlTaskId`的流量调控任务在给定实例ID和环境下的部署结果。请确保提供的`InstanceId`与您的账户相关联，并且`Environment`参数值符合预期（Daily-日常环境, Pre-预发环境, Prod-生产环境）。所有请求参数均为必填项。'."\n", + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'pairec:QueryTrafficControlTaskDeployResult', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIRecService', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"BDB621CB-A81E-5D39-8793-39A365CBCC74\\"\\n}","type":"json"}]', - 'title' => '删除指标组', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"728C5E01-ABF6-5AA8-B9FC-B3BA05DECC77\\",\\n \\"TrafficControlTaskId\\": \\"3\\",\\n \\"DraftStatus\\": \\"Success\\",\\n \\"DraftMessage\\": \\"push draft success\\",\\n \\"DeployStatus\\": \\"Success\\",\\n \\"DeployMessage\\": \\"deploy job draft success\\",\\n \\"StartStatus\\": \\"Success\\",\\n \\"StartMessage\\": \\"start job success\\",\\n \\"PrepareStatus\\": \\"Success\\",\\n \\"PrepareMessage\\": \\"success\\",\\n \\"StopStatus\\": \\"Success\\",\\n \\"StopMessage\\": \\"\\\\\\"\\\\\\"\\"\\n}","type":"json"}]', ], - 'ListCalculationJobs' => [ - 'summary' => '获取计算任务列表。', - 'path' => '/api/v1/calculationjobs', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'QueryTrafficControlTaskItemReport' => [ + 'path' => '/api/v1/trafficcontroltasks/{TrafficControlTaskId}/action/queryitemreport', + 'methods' => ['get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'list', + 'operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATURElearnN0NAWV', - ], + 'abilityTreeCode' => '254719', + 'abilityTreeNodes' => ['FEATURElearnVYA4L9'], ], 'parameters' => [ [ - 'name' => 'PageNumber', - 'in' => 'query', - 'schema' => [ - 'description' => '页码。', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', - ], + 'name' => 'TrafficControlTaskId', + 'in' => 'path', + 'schema' => ['description' => '调控任务ID。'."\n", 'type' => 'string', 'required' => true, 'example' => '1'], ], [ - 'name' => 'PageSize', + 'name' => 'InstanceId', 'in' => 'query', - 'schema' => [ - 'description' => '页大小。', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '10', - ], + 'schema' => ['description' => '实例ID。'."\n", 'type' => 'string', 'required' => true, 'example' => 'pairec_123****'], ], [ - 'name' => 'InstanceId', + 'name' => 'Environment', 'in' => 'query', - 'schema' => [ - 'description' => '实例ID，可通过接口[ListInstances](~~2411819~~)获取。', - 'type' => 'string', - 'required' => true, - 'example' => 'pairec-cn-test1', - ], + 'schema' => ['description' => '所属的环境。Daily-日常环境 Pre-预发环境 Prod-生产环境'."\n", 'type' => 'string', 'required' => true, 'example' => 'Pre'], ], [ - 'name' => 'SceneId', + 'name' => 'StartTime', 'in' => 'query', - 'schema' => [ - 'description' => '场景ID，可通过[ListScenes](~~2402581~~)接口获取。', - 'type' => 'string', - 'required' => true, - 'example' => '1', - ], + 'schema' => ['description' => '开始时间'."\n", 'type' => 'string', 'required' => true, 'example' => '2024-01-01 10:30:00'], ], [ - 'name' => 'Status', + 'name' => 'EndTime', 'in' => 'query', - 'schema' => [ - 'description' => '状态。'."\n" - ."\n" - .'- Success-成功'."\n" - ."\n" - .'- Failure-失败'."\n" - ."\n" - .'- Initializing-初始化中'."\n" - ."\n" - .'- Running-运行中', - 'type' => 'string', - 'required' => false, - 'example' => 'Success', - ], + 'schema' => ['description' => '结束时间'."\n", 'type' => 'string', 'required' => true, 'example' => '2024-01-02 10:30:00'], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', - 'description' => 'Schema of Response', + 'description' => '返回数据'."\n", 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => '请求ID。', - 'type' => 'string', - 'example' => 'F7AC05FF-EDE7-5C2B-B9AE-33D6DF4178BA', - ], - 'TotalCount' => [ - 'description' => '列表内元素总数。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '10', - ], - 'CalculationJobs' => [ - 'description' => '计算任务列表。', + 'RequestId' => ['title' => 'Id of the request', 'description' => '请求id。'."\n", 'type' => 'string', 'example' => '728C5E01-ABF6-5AA8-B9FC-B3BA05DECC77'], + 'TrafficControlTaskItemReports' => [ + 'description' => '单品调控报表列表。', 'type' => 'array', 'items' => [ - 'description' => '计算任务信息。', + 'description' => '调控详情。', 'type' => 'object', 'properties' => [ - 'CalculationJobId' => [ - 'description' => '计算任务ID。', - 'type' => 'string', - 'example' => '2', - ], - 'ABMetricName' => [ - 'description' => 'AB指标名称。', - 'type' => 'string', - 'example' => 'pv', - ], - 'Status' => [ - 'description' => '任务状态。'."\n" - ."\n" - .'- Success-成功'."\n" - ."\n" - .'- Failure-失败'."\n" - ."\n" - .'- Initializing-初始化中'."\n" - ."\n" - .'- Running-运行中', - 'type' => 'string', - 'example' => 'Success', - ], - 'JobMessage' => [ - 'description' => '任务信息。', - 'type' => 'array', - 'items' => [ - 'description' => '任务信息。', - 'type' => 'string', - 'example' => 'success', - ], - ], - 'Config' => [ - 'description' => '任务配置。', - 'type' => 'string', - 'example' => '{}', - ], - 'GmtRanTime' => [ - 'description' => '运行时间。', - 'type' => 'string', - 'example' => '2021-12-15T23:24:33.132+08:00', - ], - 'BizDate' => [ - 'description' => '业务时间。', - 'type' => 'string', - 'example' => '2021-12-15', - ], - 'JobSource' => [ - 'description' => '任务来源。'."\n" - ."\n" - .'- CronOffline-离线定时任务'."\n" - ."\n" - .'- DataRerun-数据重跑任务', - 'type' => 'string', - 'example' => 'CronOffline', - ], + 'TrafficControlTargetId' => ['description' => '调控目标ID。'."\n", 'type' => 'string', 'example' => '3'], + 'TrafficControlTargetName' => ['description' => '调控目标名称。'."\n", 'type' => 'string', 'example' => 'item-1'], + 'OughtItemControlNum' => ['description' => '应调控物品数量'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '10'], + 'OughtItemControlTraffic' => ['description' => '应调控物品流量'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1000'], + 'ActualItemControlNum' => ['description' => '实际调控物品数量'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '4'], + 'ActualItemControlTraffic' => ['description' => '实际调控物品流量'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '500'], + 'DoneItemControlNum' => ['description' => '已达成目标物品数'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '6'], + 'ItemControlNumPercentage' => ['description' => '调控物品数量占比'."\n", 'type' => 'string', 'example' => '10%'], + 'ItemControlTrafficPercentage' => ['description' => '调控物品流量占比'."\n", 'type' => 'string', 'example' => '20%'], + 'DoneItemControlPercentage' => ['description' => '已达成目标的物品数占比'."\n", 'type' => 'string', 'example' => '20%'], ], ], ], @@ -14470,62 +13494,62 @@ ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"F7AC05FF-EDE7-5C2B-B9AE-33D6DF4178BA\\",\\n \\"TotalCount\\": 10,\\n \\"CalculationJobs\\": [\\n {\\n \\"CalculationJobId\\": \\"2\\",\\n \\"ABMetricName\\": \\"pv\\",\\n \\"Status\\": \\"Success\\",\\n \\"JobMessage\\": [\\n \\"success\\"\\n ],\\n \\"Config\\": \\"{}\\",\\n \\"GmtRanTime\\": \\"2021-12-15T23:24:33.132+08:00\\",\\n \\"BizDate\\": \\"2021-12-15\\",\\n \\"JobSource\\": \\"CronOffline\\"\\n }\\n ]\\n}","type":"json"}]', - 'title' => '获取计算任务列表', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '查询流量调控任务单品报表', + 'summary' => '用于获取指定流量调控任务下的单品调控详情报表。', + 'description' => '## 请求说明'."\n" + .'- 本API用于查询特定流量调控任务在给定时间范围内的单品调控效果。'."\n" + .'- `TrafficControlTaskId` 是唯一标识一个流量调控任务的ID。'."\n" + .'- `InstanceId` 指定了执行该任务的具体实例。'."\n" + .'- `Environment` 参数定义了任务运行的环境，支持三种选项：Daily（日常环境）、Pre（预发环境）和Prod（生产环境）。'."\n" + .'- `StartTime` 和 `EndTime` 分别代表查询报告的时间段起始点与结束点，格式为"YYYY-MM-DD HH:MM:SS"。'."\n" + .'- 确保提供的开始时间和结束时间是合理的，并且属于同一个自然日或连续的自然日内。'."\n", + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"728C5E01-ABF6-5AA8-B9FC-B3BA05DECC77\\",\\n \\"TrafficControlTaskItemReports\\": [\\n {\\n \\"TrafficControlTargetId\\": \\"3\\",\\n \\"TrafficControlTargetName\\": \\"item-1\\",\\n \\"OughtItemControlNum\\": 10,\\n \\"OughtItemControlTraffic\\": 1000,\\n \\"ActualItemControlNum\\": 4,\\n \\"ActualItemControlTraffic\\": 500,\\n \\"DoneItemControlNum\\": 6,\\n \\"ItemControlNumPercentage\\": \\"10%\\",\\n \\"ItemControlTrafficPercentage\\": \\"20%\\",\\n \\"DoneItemControlPercentage\\": \\"20%\\"\\n }\\n ]\\n}","type":"json"}]', ], - 'GetCalculationJob' => [ - 'summary' => '获取指定计算任务详细信息。', - 'path' => '/api/v1/calculationjobs/{CalculationJobId}', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'ReleaseTrafficControlTask' => [ + 'summary' => '用于发布指定实例和环境下的流量调控任务。', + 'path' => '/api/v1/trafficcontroltasks/{TrafficControlTaskId}/action/release', + 'methods' => ['post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], - 'operationType' => 'read', + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'get', + 'operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATURElearnN0NAWV', - ], + 'abilityTreeCode' => '220413', + 'abilityTreeNodes' => ['FEATURElearnN0NAWV'], ], 'parameters' => [ [ - 'name' => 'CalculationJobId', + 'name' => 'TrafficControlTaskId', 'in' => 'path', - 'schema' => [ - 'description' => '计算任务ID。', - 'type' => 'string', - 'required' => true, - 'example' => '1', - ], + 'schema' => ['description' => '流量调控 ID'."\n", 'type' => 'string', 'required' => false, 'example' => '1'], ], [ - 'name' => 'InstanceId', - 'in' => 'query', + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', 'schema' => [ - 'description' => '实例ID，可通过接口[ListInstances](~~2411819~~)获取。', - 'type' => 'string', - 'required' => true, - 'example' => 'pairec-cn-test1', + 'description' => '请求Body。', + 'type' => 'object', + 'properties' => [ + 'InstanceId' => ['description' => '实例ID。'."\n", 'type' => 'string', 'required' => false, 'example' => 'pairec_123****'], + 'Environment' => ['description' => '所属的环境。Daily-日常环境Pre-预发环境Prod-生产环境'."\n", 'type' => 'string', 'required' => false, 'example' => 'Daily'], + ], + 'required' => false, ], ], ], @@ -14536,111 +13560,55 @@ 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => '请求ID。', - 'type' => 'string', - 'example' => '7D59453C-48AA-5FC5-8848-2D373BD1A17F', - ], - 'ABMetricId' => [ - 'description' => 'AB指标ID。', - 'type' => 'string', - 'example' => '1', - ], - 'ABMetricName' => [ - 'description' => 'AB指标名称。', - 'type' => 'string', - 'example' => 'pv', - ], - 'Status' => [ - 'description' => '状态。'."\n" - ."\n" - .'- Success-成功'."\n" - ."\n" - .'- Failure-失败'."\n" - ."\n" - .'- Initializing-初始化中'."\n" - ."\n" - .'- Running-运行中', - 'type' => 'string', - 'example' => 'Success', - ], - 'JobMessage' => [ - 'description' => '任务信息。', - 'type' => 'array', - 'items' => [ - 'description' => '任务信息。', - 'type' => 'string', - 'example' => 'success', - ], - ], - 'Config' => [ - 'description' => '任务配置。', - 'type' => 'string', - 'example' => '{}', - ], - 'GmtRanTime' => [ - 'description' => '运行时间。', - 'type' => 'string', - 'example' => '2021-12-15T23:24:33.132+08:00', - ], - 'BizDate' => [ - 'description' => '业务时间。', - 'type' => 'string', - 'example' => '2021-12-15', - ], - 'JobSource' => [ - 'description' => '任务来源。'."\n" - ."\n" - .'- CronOffline-离线定时任务'."\n" - ."\n" - .'- DataRerun-数据重跑任务', - 'type' => 'string', - 'example' => 'CronOffline', - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => '请求id。'."\n", 'type' => 'string', 'example' => '728C5E01-ABF6-5AA8-B9FC-B3BA05DECC77'], ], ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '发布流量调控任务', + 'description' => '## 请求说明'."\n" + .'通过此API，您可以针对特定的实例ID及环境（日常、预发或生产）发布流量调控任务。请确保在请求中正确填写`TrafficControlTaskId`、`InstanceId`以及`Environment`参数值。'."\n" + ."\n" + .'- `TrafficControlTaskId`：需要发布的流量调控任务的唯一标识符。'."\n" + .'- `InstanceId`：目标实例的ID，该实例将应用此次流量调控设置。'."\n" + .'- `Environment`：指定执行流量调控任务的环境类型，支持三种选项之一：Daily（日常）、Pre（预发）、Prod（生产）。根据实际需求选择合适的环境进行操作。'."\n" + ."\n" + .'注意：只有当所有必填字段均被正确提供时，请求才会成功处理并返回相应的RequestId作为响应的一部分。'."\n", + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"7D59453C-48AA-5FC5-8848-2D373BD1A17F\\",\\n \\"ABMetricId\\": \\"1\\",\\n \\"ABMetricName\\": \\"pv\\",\\n \\"Status\\": \\"Success\\",\\n \\"JobMessage\\": [\\n \\"success\\"\\n ],\\n \\"Config\\": \\"{}\\",\\n \\"GmtRanTime\\": \\"2021-12-15T23:24:33.132+08:00\\",\\n \\"BizDate\\": \\"2021-12-15\\",\\n \\"JobSource\\": \\"CronOffline\\"\\n}","type":"json"}]', - 'title' => '获取计算任务', + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"728C5E01-ABF6-5AA8-B9FC-B3BA05DECC77\\"\\n}","type":"json"}]', ], - 'CreateCalculationJobs' => [ - 'summary' => '批量创建计算任务。', - 'path' => '/api/v1/batch/calculationjobs/create', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'ReportABMetricGroup' => [ + 'summary' => '查询指标组的报表。', + 'path' => '/api/v1/abmetricgroups/{ABMetricGroupId}/action/report', + 'methods' => ['post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], - 'operationType' => 'write', + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'create', + 'operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATURElearnN0NAWV', - ], + 'abilityTreeNodes' => ['FEATURElearnN0NAWV'], ], 'parameters' => [ [ + 'name' => 'ABMetricGroupId', + 'in' => 'path', + 'schema' => ['description' => '指标组ID。', 'type' => 'string', 'required' => true, 'example' => '1'], + ], + [ 'name' => 'body', 'in' => 'body', 'style' => 'json', @@ -14648,30 +13616,26 @@ 'description' => '请求体参数。', 'type' => 'object', 'properties' => [ - 'ABMetricIds' => [ - 'description' => 'AB实验指标ID列表，使用逗号分隔。', - 'type' => 'string', - 'required' => true, - 'example' => '2,3,4', - ], - 'StartDate' => [ - 'description' => '开始日期。', - 'type' => 'string', - 'required' => true, - 'example' => '2023-01-01', - ], - 'EndDate' => [ - 'description' => '结束日期。', - 'type' => 'string', - 'required' => true, - 'example' => '2023-01-03', - ], - 'InstanceId' => [ - 'description' => '实例ID，可从接口[ListInstances](~~2411819~~)获取。', - 'type' => 'string', - 'required' => true, - 'example' => 'pairec-cn-test1', - ], + 'InstanceId' => ['description' => '实例ID，可通过接口[ListInstances](~~2411819~~)获取。', 'type' => 'string', 'required' => true, 'example' => 'pairec-cn-test1'], + 'ReportType' => ['description' => '报表类型。'."\n" + ."\n" + .'- Realtime-实时报表'."\n" + ."\n" + .'- Offline-离线报表'."\n" + ."\n" + .'- Market-大盘报表', 'type' => 'string', 'required' => true, 'example' => 'Offline'], + 'SceneId' => ['description' => '场景ID，可通过[ListScenes](~~2402581~~)获取。', 'type' => 'string', 'required' => false, 'example' => '1'], + 'ExperimentGroupId' => ['description' => '实验组ID，可通过接口[ListExperimentGroups](~~2402573~~)获取（离线、实时报表需要）。', 'type' => 'string', 'required' => false, 'example' => '3'], + 'ExperimentIds' => ['description' => '实验ID列表，可通过[ListExperiments](~~2402582~~)获取。', 'type' => 'string', 'required' => true, 'example' => '3,4,5'], + 'BaseExperimentId' => ['description' => '基准实验ID。', 'type' => 'string', 'required' => true, 'example' => '3'], + 'TimeStatisticsMethod' => ['description' => '统计时间类型（实时报表需要）。'."\n" + ."\n" + .'- Hour-按小时统计。'."\n" + ."\n" + .'- Day-从当日0点开始累加。', 'type' => 'string', 'required' => false, 'example' => 'Hour'], + 'DimensionFields' => ['description' => '维度字段。', 'type' => 'string', 'required' => false, 'example' => '{"gender":"man"}'], + 'StartDate' => ['description' => '开始日期。', 'type' => 'string', 'required' => false, 'example' => '2021-07-01'], + 'EndDate' => ['description' => '结束日期。', 'type' => 'string', 'required' => false, 'example' => '2021-07-01'], ], 'required' => false, ], @@ -14684,65 +13648,98 @@ 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => '请求ID。', - 'type' => 'string', - 'example' => '8C27790E-CCA5-56BB-BA17-646295DEC0A2', + 'RequestId' => ['title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => '59CE7EC6-F268-5D71-9215-32922CC50D72'], + 'ExperimentReport' => [ + 'description' => '实验报表。', + 'type' => 'object', + 'additionalProperties' => [ + 'type' => 'object', + 'properties' => [ + 'Baseline' => ['type' => 'boolean', 'description' => '是否是基准实验数据。', 'example' => 'true'], + 'MetricResults' => [ + 'type' => 'object', + 'additionalProperties' => [ + 'type' => 'object', + 'additionalProperties' => [ + 'type' => 'object', + 'properties' => [ + 'ExpId' => ['type' => 'string', 'description' => '实验ID。', 'example' => '2'], + 'ExpName' => ['type' => 'string', 'example' => 'test实验', 'description' => '实验名称。'], + 'MetricName' => ['type' => 'string', 'example' => 'pv', 'description' => '指标名称。'], + 'MetricValue' => ['type' => 'string', 'example' => '100', 'description' => '指标值。'], + 'DimensionValue' => ['type' => 'string', 'example' => 'ALL', 'description' => '维度值。'], + 'Date' => ['type' => 'string', 'example' => '20230206', 'description' => '日期。'], + 'PercentDiff' => ['type' => 'string', 'description' => '相较于base的增长率。', 'example' => '0.1'], + 'PercentDiffStr' => ['type' => 'string', 'description' => '相较于base的增长率（string 类型）。', 'example' => '"0.1"'], + ], + 'description' => '指标结果。', + ], + 'description' => '指标结果。', + ], + 'description' => '指标结果。', + ], + ], + 'description' => '报表信息。', + ], ], - 'CalculationJobIds' => [ - 'description' => '计算任务ID列表。', + 'GroupDimension' => [ + 'description' => '维度字段。', 'type' => 'array', - 'items' => [ - 'description' => 'ID列表。', - 'type' => 'string', - 'example' => '["12","13","14"]', - ], + 'items' => ['description' => '维度信息。', 'type' => 'string', 'example' => '["all"]'], ], ], ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"59CE7EC6-F268-5D71-9215-32922CC50D72\\",\\n \\"ExperimentReport\\": {\\n \\"key\\": {\\n \\"Baseline\\": true,\\n \\"MetricResults\\": {\\n \\"key\\": {\\n \\"key\\": {\\n \\"ExpId\\": \\"2\\",\\n \\"ExpName\\": \\"test实验\\",\\n \\"MetricName\\": \\"pv\\",\\n \\"MetricValue\\": \\"100\\",\\n \\"DimensionValue\\": \\"ALL\\",\\n \\"Date\\": \\"20230206\\",\\n \\"PercentDiff\\": \\"0.1\\",\\n \\"PercentDiffStr\\": \\"\\\\\\"0.1\\\\\\"\\"\\n }\\n }\\n }\\n }\\n },\\n \\"GroupDimension\\": [\\n \\"[\\\\\\"all\\\\\\"]\\"\\n ]\\n}","type":"json"}]', + 'title' => '查询指标组报表', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'pairec:ReportABMetricGroup', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIRecService', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"8C27790E-CCA5-56BB-BA17-646295DEC0A2\\",\\n \\"CalculationJobIds\\": [\\n \\"[\\\\\\"12\\\\\\",\\\\\\"13\\\\\\",\\\\\\"14\\\\\\"]\\"\\n ]\\n}","type":"json"}]', - 'title' => '创建计算任务', ], - 'CreateFeatureConsistencyCheckJobConfig' => [ - 'summary' => '创建特征一致性检查任务配置。', - 'path' => '/api/v1/featureconsistencycheck/jobconfigs', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'SplitTrafficControlTarget' => [ + 'summary' => '拆分流量调控各个时间段的目标值。', + 'path' => '/api/v1/trafficcontroltargets/{TrafficControlTargetId}/action/split', + 'methods' => ['post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'create', + 'operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeCode' => '193262', - 'abilityTreeNodes' => [ - 'FEATURElearnN0NAWV', - ], + 'abilityTreeCode' => '220603', + 'abilityTreeNodes' => ['FEATURElearnN0NAWV'], ], 'parameters' => [ [ + 'name' => 'TrafficControlTargetId', + 'in' => 'path', + 'schema' => ['description' => '流量调控目标ID。', 'type' => 'string', 'required' => false, 'example' => '1'], + ], + [ 'name' => 'body', 'in' => 'body', 'style' => 'json', @@ -14750,293 +13747,28 @@ 'description' => '请求Body。', 'type' => 'object', 'properties' => [ - 'InstanceId' => [ - 'title' => '实例ID。', - 'description' => '实例ID。如何获取实例ID，请参见[ListInstances](~~2411819~~)。', - 'type' => 'string', - 'required' => true, - 'example' => 'pairec-cn-********', - ], - 'Name' => [ - 'title' => '特征一致性检查名称。', - 'description' => '特征一致性检查名称。', - 'type' => 'string', - 'required' => true, - 'example' => 'feature_consistency_check1', - ], - 'SceneId' => [ - 'title' => '场景ID。', - 'description' => '场景ID。', - 'type' => 'string', - 'required' => true, - 'example' => '3', - ], - 'SampleRate' => [ - 'title' => '采样比例（0-1）。', - 'description' => '采样比例（0-1）。', - 'type' => 'number', - 'format' => 'double', - 'required' => true, - 'example' => '0.89', - ], - 'FeatureLandingResourceId' => [ - 'title' => '数据回落数据源ID。', - 'description' => '数据回落数据源ID。', - 'type' => 'string', - 'required' => true, - 'example' => 'reso-********', - ], - 'EasServiceName' => [ - 'title' => 'PAI-EAS服务名称。', - 'description' => 'PAI-EAS服务名称。如何获取服务名称，请参见[ListServices](~~412109~~)。', - 'type' => 'string', - 'required' => true, - 'example' => 'service_123', - ], - 'FgJsonFileName' => [ - 'title' => 'fg_json文件名称。', - 'description' => 'fg_json文件名称。', - 'type' => 'string', - 'required' => true, - 'example' => 'file.json', - ], - 'UserTable' => [ - 'title' => 'user表名。', - 'description' => 'user表名。', - 'type' => 'string', - 'required' => false, - 'example' => 'user_table', - ], - 'UserIdField' => [ - 'title' => 'user_id字段名。', - 'description' => 'user_id字段名。', - 'type' => 'string', - 'required' => false, - 'example' => 'user_id', - ], - 'UserTablePartitionField' => [ - 'title' => 'user表分区字段。', - 'description' => 'user表分区字段。', - 'type' => 'string', - 'required' => false, - 'example' => 'ds', - ], - 'UserTablePartitionFieldFormat' => [ - 'title' => 'user表分区字段格式。'."\n" - .'● yyyymmdd'."\n" - .'● yyyy-mm-dd', - 'description' => 'user表分区字段格式。'."\n" - .'- yyyymmdd'."\n" - .'- yyyy-mm-dd', - 'type' => 'string', - 'required' => false, - 'example' => 'yyyymmdd', - ], - 'ItemTable' => [ - 'title' => 'item表名。', - 'description' => 'item表名。', - 'type' => 'string', - 'required' => false, - 'example' => 'item_table', - ], - 'ItemIdField' => [ - 'title' => 'item_id字段名。', - 'description' => 'item_id字段名。', - 'type' => 'string', - 'required' => false, - 'example' => 'item_id', - ], - 'ItemTablePartitionField' => [ - 'title' => 'item表分区字段。', - 'description' => 'item表分区字段。', - 'type' => 'string', - 'required' => false, - 'example' => 'ds', - ], - 'ItemTablePartitionFieldFormat' => [ - 'title' => 'item表分区字段格式。'."\n" - .'● yyyymmdd'."\n" - .'● yyyy-mm-dd', - 'description' => 'item表分区字段格式。'."\n" - .'- yyyymmdd'."\n" - .'- yyyy-mm-dd', - 'type' => 'string', - 'required' => false, - 'example' => 'yyyymmdd', - ], - 'CompareFeature' => [ - 'title' => '是否需要特征比对。', - 'description' => '是否需要特征比对。', - 'type' => 'boolean', - 'required' => true, - 'example' => 'true', - ], - 'GenerateZip' => [ - 'title' => '是否需要生成zip包。', - 'description' => '是否需要生成zip包。', - 'type' => 'boolean', - 'required' => true, - 'example' => 'true', - ], - 'ServiceId' => [ - 'title' => '服务ID。', - 'description' => '服务ID。', - 'type' => 'string', - 'required' => true, - 'example' => '4', - ], - 'WorkflowName' => [ - 'title' => '工作流名称。', - 'description' => '工作流名称。', - 'type' => 'string', - 'required' => false, - 'example' => 'work_flow_1', - ], - 'OssResourceId' => [ - 'title' => 'OSS数据源ID。', - 'description' => 'OSS数据源ID。', - 'type' => 'string', - 'required' => false, - 'example' => 'reso-********', - ], - 'EasyRecVersion' => [ - 'title' => 'EasyRec版本。', - 'description' => 'EasyRec版本。', - 'type' => 'string', - 'required' => false, - 'example' => '1.3.60', - ], - 'EasyRecPackagePath' => [ - 'title' => 'EasyRec包路径。', - 'description' => 'EasyRec包所在的OSS Bucket路径。', - 'type' => 'string', - 'required' => false, - 'example' => 'oss://*******', - ], - 'FgJarVersion' => [ - 'title' => 'fg_jar版本。', - 'description' => 'fg_jar版本。', - 'type' => 'string', - 'required' => false, - 'example' => '1.0.0', - ], - 'FeaturePriority' => [ - 'title' => '特征优先级，多个特征通过逗号分开。', - 'description' => '特征优先级，多个特征通过半角逗号（,）分开。', - 'type' => 'string', - 'required' => false, - 'example' => 'feature1,feature2,feature3', - ], - 'FeatureDisplayExclude' => [ - 'title' => '特征展示过滤，多个特征通过逗号分开。', - 'description' => '特征展示过滤，多个特征通过半角逗号（,）分开。', - 'type' => 'string', - 'required' => false, - 'example' => 'feature1,feature2', - ], - 'UseFeatureStore' => [ - 'description' => '是否需要使用feature store，取值：'."\n" - ."\n" - .'- true：使用feature store，此时FeatureStoreProjectId、FeatureStoreProjectName、FeatureStoreModelId、FeatureStoreUserId、FeatureStoreItemId为必填项。'."\n" - .'- false：不使用feature store，此时UserTable、UserIdField、UserTablePartitionField、UserTablePartitionFieldFormat、ItemTable、ItemIdField、ItemTablePartitionField、ItemTablePartitionFieldFormat为必填项。', - 'type' => 'boolean', - 'required' => true, - 'example' => 'true', - 'default' => 'false', - ], - 'FeatureStoreProjectName' => [ - 'description' => 'feature store项目名称。', - 'type' => 'string', - 'required' => false, - 'example' => 'project-1', - ], - 'FeatureStoreModelId' => [ - 'description' => 'feature store model ID。', - 'type' => 'string', - 'required' => false, - 'example' => '2', - ], - 'FeatureStoreUserId' => [ - 'description' => 'feature store user侧主键。', - 'type' => 'string', - 'required' => false, - 'example' => 'user', - ], - 'FeatureStoreItemId' => [ - 'description' => 'feature store item侧主键。', - 'type' => 'string', - 'required' => false, - 'example' => 'item', - ], - 'FeatureStoreSeqFeatureView' => [ - 'description' => '序列特征中item特征所在的特征视图的名字。', - 'type' => 'string', - 'required' => false, - 'example' => 'item-1', - ], - 'FeatureStoreProjectId' => [ - 'description' => 'feature store项目ID。', - 'type' => 'string', - 'required' => false, - 'example' => 'prj-01', - ], - 'WorkspaceId' => [ - 'type' => 'string', - 'required' => false, - ], - 'VpcId' => [ - 'type' => 'string', - 'required' => false, - ], - 'SwitchId' => [ - 'type' => 'string', - 'required' => false, - ], - 'SecurityGroupId' => [ - 'type' => 'string', - 'required' => false, - ], - 'DefaultRoute' => [ - 'type' => 'string', - 'required' => false, - ], - 'DatasetId' => [ - 'type' => 'string', - 'required' => false, - ], - 'DatasetType' => [ - 'type' => 'string', - 'required' => false, - ], - 'DatasetUri' => [ - 'type' => 'string', - 'required' => false, - ], - 'DatasetMountPath' => [ - 'type' => 'string', - 'required' => false, - ], - 'DatasetName' => [ - 'type' => 'string', - 'required' => false, - ], - 'PredictWorkerCount' => [ - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - ], - 'PredictWorkerCpu' => [ - 'type' => 'integer', - 'format' => 'int32', + 'Environment' => ['description' => '运行环境：'."\n" + ."\n" + .'- Pre-预发环境。'."\n" + ."\n" + .'- Prod-生产环境。', 'type' => 'string', 'required' => false, 'example' => 'Prod'], + 'InstanceId' => ['description' => '实例ID。如何获取实例ID，请参见[ListInstances](~~2411819~~)。', 'type' => 'string', 'required' => false, 'example' => 'learn-pairec-xxx'], + 'TimePoints' => [ + 'description' => '时间分割点。', + 'type' => 'array', + 'items' => ['description' => '时间分割点，单位分钟。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '30'], 'required' => false, ], - 'PredictWorkerMemory' => [ - 'type' => 'integer', - 'format' => 'int32', + 'SetValues' => [ + 'description' => '目标值分割点。', + 'type' => 'array', + 'items' => ['description' => '目标值分割点的具体值。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '3'], 'required' => false, ], - 'ResourceConfig' => [ - 'type' => 'string', + 'SetPoints' => [ + 'description' => '废弃参数。', + 'type' => 'array', + 'items' => ['description' => '废弃参数。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '0'], 'required' => false, ], ], @@ -15051,61 +13783,60 @@ 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => '请求ID。', - 'type' => 'string', - 'example' => 'E15A1443-7917-5BE0-AE70-25538ECF398D', - ], - 'FeatureConsistencyCheckJobConfigId' => [ - 'title' => '特征一致性检查配置ID。', - 'description' => '特征一致性检查配置ID。', - 'type' => 'string', - 'example' => '4', - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => 'Id of the request。', 'type' => 'string', 'example' => 'F8F613A9-DF1C-551A-88E1-397A3981A785'], ], ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"F8F613A9-DF1C-551A-88E1-397A3981A785\\"\\n}","type":"json"}]', + 'title' => '分隔流量调控的目标值', + 'description' => '删除某个引擎配置。', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'pairec:SplitTrafficControlTarget', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIRecService', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"E15A1443-7917-5BE0-AE70-25538ECF398D\\",\\n \\"FeatureConsistencyCheckJobConfigId\\": \\"4\\"\\n}","type":"json"}]', - 'title' => '创建特征一致性检查任务配置', ], - 'CreateFeatureConsistencyCheckJob' => [ - 'summary' => '创建特征一致性检查任务。', - 'path' => '/api/v1/featureconsistencycheck/jobs', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'StartTrafficControlTarget' => [ + 'path' => '/api/v1/trafficcontroltargets/{TrafficControlTargetId}/action/start', + 'methods' => ['post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'create', + 'operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATURElearnN0NAWV', - ], + 'abilityTreeCode' => '220598', + 'abilityTreeNodes' => ['FEATURElearnN0NAWV'], ], 'parameters' => [ [ + 'name' => 'TrafficControlTargetId', + 'in' => 'path', + 'schema' => ['description' => '流量调控目标 ID', 'type' => 'string', 'required' => false, 'example' => '1'], + ], + [ 'name' => 'body', 'in' => 'body', 'style' => 'json', @@ -15113,40 +13844,7 @@ 'description' => '请求Body。', 'type' => 'object', 'properties' => [ - 'InstanceId' => [ - 'title' => '实例ID。', - 'description' => '实例ID。如何获取实例ID，请参见[ListInstances](~~2411819~~)。', - 'type' => 'string', - 'required' => true, - 'example' => 'pairec-cn-********', - ], - 'FeatureConsistencyCheckJobConfigId' => [ - 'title' => '特征一致性检查任务配置ID。', - 'description' => '特征一致性检查任务配置ID。如何获取配置ID，请参见[ListFeatureConsistencyCheckJobConfigs](~~2557567~~)。', - 'type' => 'string', - 'required' => true, - 'example' => '3', - ], - 'Environment' => [ - 'title' => '运行环境。'."\n" - .'● Daily-日常环境'."\n" - .'● Pre-预发环境'."\n" - .'● Prod-生产环境', - 'description' => '运行环境：'."\n" - .'- Daily：日常环境'."\n" - .'- Pre：预发环境'."\n" - .'- Prod：生产环境', - 'type' => 'string', - 'required' => true, - 'example' => 'Pre', - ], - 'SamplingDuration' => [ - 'description' => '采样运行时长（单位：分钟）。', - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'example' => '10', - ], + 'InstanceId' => ['description' => '实例ID。', 'type' => 'string', 'required' => false, 'example' => 'pairec-1324***'], ], 'required' => false, ], @@ -15159,71 +13857,48 @@ 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => '请求ID。', - 'type' => 'string', - 'example' => '7D59453C-48AA-5FC5-8848-2D373BD1A17F', - ], - 'FeatureConsistencyCheckJobId' => [ - 'title' => '特征一致性检查任务ID。', - 'description' => '特征一致性检查任务ID。', - 'type' => 'string', - 'example' => '4', - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => '请求id。', 'type' => 'string', 'example' => '728C5E01-ABF6-5AA8-B9FC-B3BA05DECC77'], ], ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '开启流量调控任务', + 'summary' => '此API用于启动指定ID的流量调控任务。', + 'description' => '## 请求说明'."\n" + .'通过调用此接口，用户可以基于提供的`TrafficControlTargetId`和`InstanceId`来激活一个特定的流量调控任务。请确保在请求中正确填写这两个参数值，以避免操作失败。'."\n", + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"7D59453C-48AA-5FC5-8848-2D373BD1A17F\\",\\n \\"FeatureConsistencyCheckJobId\\": \\"4\\"\\n}","type":"json"}]', - 'title' => '创建特征一致性检查任务', + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"728C5E01-ABF6-5AA8-B9FC-B3BA05DECC77\\"\\n}","type":"json"}]', ], - 'UpdateFeatureConsistencyCheckJobConfig' => [ - 'summary' => '更新特征一致性检查任务配置详细信息，例如更新名称。', - 'path' => '/api/v1/featureconsistencycheck/jobconfigs/{FeatureConsistencyCheckJobConfigId}', - 'methods' => [ - 'put', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'StartTrafficControlTask' => [ + 'path' => '/api/v1/trafficcontroltasks/{TrafficControlTaskId}/action/start', + 'methods' => ['post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], - 'operationType' => 'readAndWrite', + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'update', + 'operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeCode' => '193282', - 'abilityTreeNodes' => [ - 'FEATURElearnN0NAWV', - ], + 'abilityTreeCode' => '220409', + 'abilityTreeNodes' => ['FEATURElearnN0NAWV'], ], 'parameters' => [ [ - 'name' => 'FeatureConsistencyCheckJobConfigId', + 'name' => 'TrafficControlTaskId', 'in' => 'path', - 'schema' => [ - 'title' => '特征一致性检查配置ID。', - 'description' => '特征一致性检查配置ID。如何获取配置ID，请参见[ListFeatureConsistencyCheckJobConfigs](~~2557567~~)。', - 'type' => 'string', - 'required' => true, - 'example' => '3', - ], + 'schema' => ['description' => '流量调控 ID'."\n", 'type' => 'string', 'required' => true, 'example' => '1'], ], [ 'name' => 'body', @@ -15233,277 +13908,8 @@ 'description' => '请求Body。', 'type' => 'object', 'properties' => [ - 'InstanceId' => [ - 'title' => '实例ID，可从接口ListInstances获取。', - 'description' => '实例ID。如何获取实例ID，请参见[ListInstances](~~2411819~~)。', - 'type' => 'string', - 'required' => true, - 'example' => 'pairec-cn-********', - ], - 'Name' => [ - 'title' => '特征一致性检查名称。', - 'description' => '特征一致性检查名称。', - 'type' => 'string', - 'required' => true, - 'example' => 'feature_consistency_check1', - ], - 'SceneId' => [ - 'title' => '场景ID。', - 'description' => '场景ID。', - 'type' => 'string', - 'required' => true, - 'example' => '3', - ], - 'SampleRate' => [ - 'title' => '采样比例（0-1）。', - 'description' => '采样比例（0-1）。', - 'type' => 'number', - 'format' => 'double', - 'required' => true, - 'example' => '0.89', - ], - 'FeatureLandingResourceId' => [ - 'title' => '数据回落数据源ID。', - 'description' => '数据回落数据源ID。', - 'type' => 'string', - 'required' => true, - 'example' => 'reso-********', - ], - 'EasServiceName' => [ - 'title' => 'PAI-EAS服务名称。', - 'description' => 'PAI-EAS服务名称。', - 'type' => 'string', - 'required' => true, - 'example' => 'service_123', - ], - 'FgJsonFileName' => [ - 'title' => 'fg_json文件名称。', - 'description' => 'fg_json文件名称。', - 'type' => 'string', - 'required' => true, - 'example' => 'file.json', - ], - 'UserTable' => [ - 'title' => 'user表名。', - 'description' => 'user表名。', - 'type' => 'string', - 'required' => true, - 'example' => 'user_table', - ], - 'UserIdField' => [ - 'title' => 'user_id字段名。', - 'description' => 'user_id字段名。', - 'type' => 'string', - 'required' => true, - 'example' => 'user_id', - ], - 'UserTablePartitionField' => [ - 'title' => 'user表分区字段。', - 'description' => 'user表分区字段。', - 'type' => 'string', - 'required' => true, - 'example' => 'ds', - ], - 'UserTablePartitionFieldFormat' => [ - 'title' => 'user表分区字段格式。'."\n" - .'● yyyymmdd'."\n" - .'● yyyy-mm-dd', - 'description' => 'user表分区字段格式。'."\n" - .'- yyyymmdd'."\n" - .'- yyyy-mm-dd', - 'type' => 'string', - 'required' => true, - 'example' => 'yyyymmdd', - ], - 'ItemTable' => [ - 'title' => 'item表名。', - 'description' => 'item表名。', - 'type' => 'string', - 'required' => true, - 'example' => 'item_table', - ], - 'ItemIdField' => [ - 'title' => 'item_id字段名。', - 'description' => 'item_id字段名。', - 'type' => 'string', - 'required' => true, - 'example' => 'item_id', - ], - 'ItemTablePartitionField' => [ - 'title' => 'item表分区字段。', - 'description' => 'item表分区字段。', - 'type' => 'string', - 'required' => true, - 'example' => 'ds', - ], - 'ItemTablePartitionFieldFormat' => [ - 'title' => 'item表分区字段格式。'."\n" - .'● yyyymmdd'."\n" - .'● yyyy-mm-dd', - 'description' => 'item表分区字段格式：'."\n" - .'- yyyymmdd'."\n" - .'- yyyy-mm-dd', - 'type' => 'string', - 'required' => true, - 'example' => 'yyyymmdd', - ], - 'CompareFeature' => [ - 'title' => '是否需要特征比对。', - 'description' => '是否需要特征比对。', - 'type' => 'boolean', - 'required' => true, - 'example' => 'true', - ], - 'GenerateZip' => [ - 'title' => '是否需要生成zip包。', - 'description' => '是否需要生成zip包。', - 'type' => 'boolean', - 'required' => true, - 'example' => 'true', - ], - 'ServiceId' => [ - 'title' => '服务ID。', - 'description' => '服务ID。', - 'type' => 'string', - 'required' => false, - 'example' => '4', - ], - 'WorkflowName' => [ - 'title' => '工作流名称。', - 'description' => '工作流名称。', - 'type' => 'string', - 'required' => false, - 'example' => 'work_flow_1', - ], - 'OssResourceId' => [ - 'title' => 'OSS数据源ID。', - 'description' => 'OSS数据源ID。', - 'type' => 'string', - 'required' => false, - 'example' => 'reso-********', - ], - 'EasyRecVersion' => [ - 'title' => 'EasyRec版本。', - 'description' => 'EasyRec版本。', - 'type' => 'string', - 'required' => false, - 'example' => '1.3.60', - ], - 'EasyRecPackagePath' => [ - 'title' => 'EasyRec包路径。', - 'description' => 'EasyRec包路径。', - 'type' => 'string', - 'required' => false, - 'example' => 'oss://********', - ], - 'FgJarVersion' => [ - 'title' => 'fg_jar版本。', - 'description' => 'fg_jar版本。', - 'type' => 'string', - 'required' => false, - 'example' => '1.0.0', - ], - 'FeaturePriority' => [ - 'title' => '特征优先级，多个特征通过逗号分开。', - 'description' => '特征优先级，多个特征通过半角逗号（,）分开，表示哪些特征优先从user表读取，若user表为空，则从行为表查询。', - 'type' => 'string', - 'required' => false, - 'example' => 'feature1,feature2,feature3', - ], - 'FeatureDisplayExclude' => [ - 'title' => '特征展示过滤，多个特征通过逗号分开。', - 'description' => '特征展示过滤，多个特征通过半角逗号（,）分开。', - 'type' => 'string', - 'required' => false, - 'example' => 'feature1,feature2', - ], - 'IsUseFeatureStore' => [ - 'type' => 'boolean', - 'required' => false, - ], - 'FeatureStoreProjectName' => [ - 'type' => 'string', - 'required' => false, - ], - 'FeatureStoreModelId' => [ - 'type' => 'string', - 'required' => false, - ], - 'FeatureStoreUserId' => [ - 'type' => 'string', - 'required' => false, - ], - 'FeatureStoreItemId' => [ - 'type' => 'string', - 'required' => false, - ], - 'FeatureStoreSeqFeatureView' => [ - 'type' => 'string', - 'required' => false, - ], - 'FeatureStoreProjectId' => [ - 'type' => 'string', - 'required' => false, - ], - 'WorkspaceId' => [ - 'type' => 'string', - 'required' => false, - ], - 'VpcId' => [ - 'type' => 'string', - 'required' => false, - ], - 'SwitchId' => [ - 'type' => 'string', - 'required' => false, - ], - 'SecurityGroupId' => [ - 'type' => 'string', - 'required' => false, - ], - 'DefaultRoute' => [ - 'type' => 'string', - 'required' => false, - ], - 'DatasetId' => [ - 'type' => 'string', - 'required' => false, - ], - 'DatasetType' => [ - 'type' => 'string', - 'required' => false, - ], - 'DatasetUri' => [ - 'type' => 'string', - 'required' => false, - ], - 'DatasetMountPath' => [ - 'type' => 'string', - 'required' => false, - ], - 'DatasetName' => [ - 'type' => 'string', - 'required' => false, - ], - 'PredictWorkerCount' => [ - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - ], - 'PredictWorkerCpu' => [ - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - ], - 'PredictWorkerMemory' => [ - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - ], - 'ResourceConfig' => [ - 'type' => 'string', - 'required' => false, - ], + 'InstanceId' => ['description' => '实例ID'."\n", 'type' => 'string', 'required' => false, 'example' => 'pairec-123***'], + 'Environment' => ['description' => '所属的环境。Daily-日常环境 Pre-预发环境 Prod-生产环境'."\n", 'type' => 'string', 'required' => false, 'example' => 'Pre'], ], 'required' => false, ], @@ -15516,116 +13922,141 @@ 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => '请求ID。', - 'type' => 'string', - 'example' => 'A04CB8C0-E74A-5E83-BC61-64D153574EC7', - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => '请求id。'."\n", 'type' => 'string', 'example' => '728C5E01-ABF6-5AA8-B9FC-B3BA05DECC77'], ], ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"A04CB8C0-E74A-5E83-BC61-64D153574EC7\\"\\n}","type":"json"}]', - 'title' => '更新特征一致性检查任务配置', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '开启流量调控任务', + 'summary' => '用于启动指定ID的流量调控任务，适用于不同环境下的实例。', + 'description' => '## 请求说明'."\n" + .'- 该API用于开启特定`TrafficControlTaskId`标识的流量调控任务。'."\n" + .'- `InstanceId`指定了要操作的具体实例。'."\n" + .'- `Environment`参数定义了执行此操作的目标环境（日常、预发或生产）。'."\n" + .'- 确保在调用前已正确设置所有必需参数，特别是`TrafficControlTaskId`必须存在于系统中。'."\n", + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"728C5E01-ABF6-5AA8-B9FC-B3BA05DECC77\\"\\n}","type":"json"}]', ], - 'ListFeatureConsistencyCheckJobConfigs' => [ - 'summary' => '获取特征一致性检查任务配置列表。', - 'path' => '/api/v1/featureconsistencycheck/jobconfigs', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'StopTrafficControlFlinkTask' => [ + 'path' => '/api/v1/trafficcontroltasks/{TrafficControlTaskId}/action/stopflink', + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], - 'operationType' => 'read', + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'list', + 'operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeCode' => '193273', - 'abilityTreeNodes' => [ - 'FEATURElearnN0NAWV', - ], + 'abilityTreeNodes' => ['FEATURElearnN0NAWV'], ], 'parameters' => [ [ - 'name' => 'InstanceId', - 'in' => 'query', - 'schema' => [ - 'title' => '实例ID。', - 'description' => '实例ID。如何获取实例ID，请参见[ListInstances](~~2411819~~)。', - 'type' => 'string', - 'required' => true, - 'example' => 'pairec-cn-********', - ], + 'name' => 'TrafficControlTaskId', + 'in' => 'path', + 'schema' => ['description' => '流量调控 ID。', 'type' => 'string', 'required' => false, 'example' => '1'], ], [ - 'name' => 'PageNumber', - 'in' => 'query', + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', 'schema' => [ - 'title' => '页码。', - 'description' => '页码。起始值为1，默认值为1。', - 'type' => 'string', + 'description' => '请求Body。', + 'type' => 'object', + 'properties' => [ + 'InstanceId' => ['description' => '实例ID。', 'type' => 'string', 'required' => false, 'example' => 'pairec_123****'], + 'Environment' => [ + 'description' => '所属的环境。 '."\n" + ."\n" + .'- Daily：日常环境。'."\n" + ."\n" + .'- Pre：预发环境。'."\n" + ."\n" + .'- Prod：生产环境。', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => ['Prod' => '生产', 'Daily' => '日常', 'Pre' => '预发'], + 'example' => 'Daily', + ], + ], 'required' => false, - 'example' => '1', + 'example' => '{}', ], ], - [ - 'name' => 'PageSize', - 'in' => 'query', + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'title' => '页大小。', - 'description' => '页大小。', - 'type' => 'string', - 'required' => false, - 'example' => '10', + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['title' => 'Id of the request', 'description' => '请求Id。', 'type' => 'string', 'example' => '728C5E01-ABF6-5AA8-B9FC-B3BA05DECC77'], + ], ], ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '停止流量调控Flink任务', + 'summary' => '用于停止指定ID的流量调控Flink任务。', + 'description' => '## 请求说明'."\n" + .'通过此API，您可以根据提供的`TrafficControlTaskId`来停止一个特定的流量调控Flink任务。请确保您已经准备好正确的`InstanceId`以及该实例所属的环境（Daily-日常环境, Pre-预发环境, Prod-生产环境）。在请求体中必须包含这些信息以便正确执行操作。'."\n", + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"728C5E01-ABF6-5AA8-B9FC-B3BA05DECC77\\"\\n}","type":"json"}]', + ], + 'StopTrafficControlTarget' => [ + 'summary' => '此API用于停止指定的流量调控目标。', + 'path' => '/api/v1/trafficcontroltargets/{TrafficControlTargetId}/action/stop', + 'methods' => ['post'], + 'schemes' => ['http', 'https'], + 'security' => [ [ - 'name' => 'SortBy', - 'in' => 'query', - 'schema' => [ - 'title' => '排序依据。'."\n" - .'GmtCreateTime-创建时间。'."\n" - .'GmtModifiedTime-更新时间。', - 'description' => '排序依据。'."\n" - .'- GmtCreateTime：按创建时间排序。'."\n" - .'- GmtModifiedTime：按更新时间排序。', - 'type' => 'string', - 'required' => false, - 'example' => 'GmtCreateTime', - ], + 'AK' => [], ], + ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '220602', + 'abilityTreeNodes' => ['FEATURElearnN0NAWV'], + ], + 'parameters' => [ [ - 'name' => 'Order', - 'in' => 'query', + 'name' => 'TrafficControlTargetId', + 'in' => 'path', + 'schema' => ['description' => '流量调控目标 ID', 'type' => 'string', 'required' => false, 'example' => '1'], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', 'schema' => [ - 'title' => '排序方式。'."\n" - .'● ASC-升序。'."\n" - .'● DESC-降序。', - 'description' => '排序方式。'."\n" - .'- ASC：升序。'."\n" - .'- DESC：降序。', - 'type' => 'string', + 'description' => '请求Body。', + 'type' => 'object', + 'properties' => [ + 'InstanceId' => ['description' => '实例ID。', 'type' => 'string', 'required' => false, 'example' => 'pairec-1324***'], + ], 'required' => false, - 'example' => 'ASC', ], ], ], @@ -15636,398 +14067,67 @@ 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => '请求ID。', - 'type' => 'string', - 'example' => 'FCF741D8-9C30-578E-807F-B935487DB34A', - ], - 'TotalCount' => [ - 'title' => '总个数。', - 'description' => '总个数。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '10', - ], - 'FeatureConsistencyCheckConfigs' => [ - 'title' => '特征一致性检查列表。', - 'description' => '特征一致性检查列表。', - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'FeatureConsistencyCheckJobConfigId' => [ - 'title' => '特征一致性检查配置ID。', - 'description' => '特征一致性检查配置ID。', - 'type' => 'string', - 'example' => '3', - ], - 'Name' => [ - 'title' => '特征一致性检查配置名称。', - 'description' => '特征一致性检查配置名称。', - 'type' => 'string', - 'example' => 'feature_consistency_check1', - ], - 'SceneId' => [ - 'title' => '场景ID。', - 'description' => '场景ID。', - 'type' => 'string', - 'example' => '3', - ], - 'SceneName' => [ - 'title' => '场景名称。', - 'description' => '场景名称。', - 'type' => 'string', - 'example' => 'scene1', - ], - 'Status' => [ - 'title' => '状态。'."\n" - .'● Editable-可编辑的。'."\n" - .'● Uneditable-不可编辑的。', - 'description' => '状态。可能值为：'."\n" - .'- Editable：可编辑的。'."\n" - .'- Uneditable：不可编辑的。', - 'type' => 'string', - 'example' => 'Editable', - ], - 'CompareFeature' => [ - 'title' => '是否开启特征比对。', - 'description' => '是否开启特征比对。', - 'type' => 'boolean', - 'example' => 'true', - ], - 'LatestJobId' => [ - 'title' => '基于该配置最近一次创建的任务ID。', - 'description' => '基于该配置最近一次创建的任务ID。', - 'type' => 'string', - 'example' => '3', - ], - 'LatestJobGmtSamplingStartTime' => [ - 'title' => '最近一次创建的任务的开始时间。', - 'description' => '最近一次创建的任务的开始时间。', - 'type' => 'string', - 'example' => '2021-12-15T23:24:33.132+08:00', - ], - 'LatestJobGmtSamplingEndTime' => [ - 'title' => '最近一次创建的任务的结束时间。', - 'description' => '最近一次创建的任务的结束时间。', - 'type' => 'string', - 'example' => '2021-12-15T23:24:33.132+08:00', - ], - 'SampleRate' => [ - 'title' => '采样比例（0-1）。', - 'description' => '采样比例（0-1）。', - 'type' => 'string', - 'example' => '0.89', - ], - 'FeatureLandingResourceId' => [ - 'title' => '数据回落数据源ID。', - 'description' => '数据回落数据源ID。', - 'type' => 'string', - 'example' => 'reso-********', - ], - 'FeatureLandingResourceUri' => [ - 'title' => '数据回落数据源地址。', - 'description' => '数据回落数据源地址。', - 'type' => 'string', - 'example' => 'mc_project_1', - ], - 'EasServiceName' => [ - 'title' => 'EAS服务名称。', - 'description' => 'EAS服务名称。', - 'type' => 'string', - 'example' => 'eas_service_1', - ], - 'FgJsonFileName' => [ - 'title' => 'fg_json文件名称。', - 'description' => 'fg_json文件名称。', - 'type' => 'string', - 'example' => 'file.json', - ], - 'UserTable' => [ - 'title' => 'user表名。', - 'description' => 'user表名。', - 'type' => 'string', - 'example' => 'user_table', - ], - 'UserIdField' => [ - 'title' => 'user_id字段名。', - 'description' => 'user_id字段名。', - 'type' => 'string', - 'example' => 'user_id', - ], - 'UserTablePartitionField' => [ - 'title' => 'user表分区字段。', - 'description' => 'user表分区字段。', - 'type' => 'string', - 'example' => 'ds', - ], - 'UserTablePartitionFieldFormat' => [ - 'title' => 'user表分区字段格式。'."\n" - .'● yyyymmdd'."\n" - .'● yyyy-mm-dd', - 'description' => 'user表分区字段格式：'."\n" - .'- yyyymmdd'."\n" - .'- yyyy-mm-dd', - 'type' => 'string', - 'example' => 'yyyymmdd', - ], - 'ItemTable' => [ - 'title' => 'item表名。', - 'description' => 'item表名。', - 'type' => 'string', - 'example' => 'item_table', - ], - 'ItemIdField' => [ - 'title' => 'item_id字段名。', - 'description' => 'item_id字段名。', - 'type' => 'string', - 'example' => 'item_id', - ], - 'ItemTablePartitionField' => [ - 'title' => 'item表分区字段。', - 'description' => 'item表分区字段。', - 'type' => 'string', - 'example' => 'ds', - ], - 'ItemTablePartitionFieldFormat' => [ - 'title' => 'item表分区字段格式。'."\n" - .'● yyyymmdd'."\n" - .'● yyyy-mm-dd', - 'description' => 'item表分区字段格式：'."\n" - .'- yyyymmdd'."\n" - .'- yyyy-mm-dd', - 'type' => 'string', - 'example' => 'yyyymmdd', - ], - 'GenerateZip' => [ - 'title' => '是否需要生成zip包。', - 'description' => '是否需要生成zip包。', - 'type' => 'boolean', - 'example' => 'true', - ], - 'ServiceId' => [ - 'title' => '服务ID。', - 'description' => '服务ID。', - 'type' => 'string', - 'example' => '4', - ], - 'ServiceName' => [ - 'title' => '服务名称。', - 'description' => '服务名称。', - 'type' => 'string', - 'example' => 'service1', - ], - 'WorkflowName' => [ - 'title' => '工作流名称。', - 'description' => '工作流名称。', - 'type' => 'string', - 'example' => 'work_flow_1', - ], - 'OssResourceId' => [ - 'title' => 'OSS数据源ID。', - 'description' => 'OSS数据源ID。', - 'type' => 'string', - 'example' => 'reso-********', - ], - 'OssBucket' => [ - 'title' => 'OSS bucket名称。', - 'description' => 'OSS bucket名称。', - 'type' => 'string', - 'example' => 'oss_bucket_1', - ], - 'EasyRecVersion' => [ - 'title' => 'EasyRec版本。', - 'description' => 'EasyRec版本。', - 'type' => 'string', - 'example' => '1.3.60', - ], - 'EasyRecPackagePath' => [ - 'title' => 'EasyRec包路径。', - 'description' => 'EasyRec包路径。', - 'type' => 'string', - 'example' => 'oss://*******', - ], - 'FgJarVersion' => [ - 'title' => 'fg_jar版本。', - 'description' => 'fg_jar版本。', - 'type' => 'string', - 'example' => '1.0.0', - ], - 'FeaturePriority' => [ - 'title' => '特征优先级，多个特征通过逗号分开。', - 'description' => '特征优先级，多个特征通过半角逗号（,）分开，表示哪些特征优先从user表读取，若user表为空，则从行为表查询。', - 'type' => 'string', - 'example' => 'feature1,feature2,feature3', - ], - 'FeatureDisplayExclude' => [ - 'title' => '特征展示过滤，多个特征通过逗号分开。', - 'description' => '特征展示过滤，多个特征通过半角逗号（,）分开。', - 'type' => 'string', - 'example' => 'feature1,feature2', - ], - 'GmtCreateTime' => [ - 'title' => '创建时间。', - 'description' => '创建时间。', - 'type' => 'string', - 'example' => '2021-12-15T23:24:33.132+08:00', - ], - 'GmtModifiedTime' => [ - 'title' => '更新时间。', - 'description' => '更新时间。', - 'type' => 'string', - 'example' => '2021-12-15T23:24:33.132+08:00', - ], - 'UseFeatureStore' => [ - 'description' => '是否使用feature store，取值：'."\n" - ."\n" - .'- true：使用，此时返回FeatureStoreProjectId、FeatureStoreProjectName、FeatureStoreModelId、FeatureStoreUserId、FeatureStoreItemId。'."\n" - .'- false：不使用，此时返回UserTable、UserIdField、UserTablePartitionField、UserTablePartitionFieldFormat、ItemTable、ItemIdField、ItemTablePartitionField、ItemTablePartitionFieldFormat。', - 'type' => 'string', - 'example' => 'true', - ], - 'FeatureStoreProjectName' => [ - 'description' => 'feature store项目名称。', - 'type' => 'string', - 'example' => 'project-1', - ], - 'FeatureStoreModelId' => [ - 'description' => 'feature store model ID。', - 'type' => 'string', - 'example' => '2'."\n", - ], - 'FeatureStoreUserId' => [ - 'description' => 'feature store user侧主键。', - 'type' => 'string', - 'example' => 'user', - ], - 'FeatureStoreItemId' => [ - 'description' => 'feature store item侧主键。', - 'type' => 'string', - 'example' => 'item', - ], - 'FeatureStoreSeqFeatureView' => [ - 'description' => '序列特征中item特征所在的特征视图的名字。', - 'type' => 'string', - 'example' => 'item-1', - ], - 'FeatureStoreProjectId' => [ - 'description' => 'feature store项目ID。', - 'type' => 'string', - 'example' => 'prj-01', - ], - 'WorkspaceId' => [ - 'type' => 'string', - ], - 'VpcId' => [ - 'type' => 'string', - ], - 'SwitchId' => [ - 'type' => 'string', - ], - 'SecurityGroupId' => [ - 'type' => 'string', - ], - 'DefaultRoute' => [ - 'type' => 'string', - ], - 'DatasetId' => [ - 'type' => 'string', - ], - 'DatasetType' => [ - 'type' => 'string', - ], - 'DatasetUri' => [ - 'type' => 'string', - ], - 'DatasetMountPath' => [ - 'type' => 'string', - ], - 'DatasetName' => [ - 'type' => 'string', - ], - 'PredictWorkerCount' => [ - 'type' => 'integer', - 'format' => 'int32', - ], - 'PredictWorkerCpu' => [ - 'type' => 'integer', - 'format' => 'int32', - ], - 'PredictWorkerMemory' => [ - 'type' => 'integer', - 'format' => 'int32', - ], - 'ResourceConfig' => [ - 'type' => 'string', - ], - ], - ], - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => '请求id。', 'type' => 'string', 'example' => '728C5E01-ABF6-5AA8-B9FC-B3BA05DECC77'], ], ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '停止流量调控目标', + 'description' => '## 请求说明'."\n" + .'通过调用此接口，您可以根据提供的`TrafficControlTargetId`和`InstanceId`来停止一个正在进行中的流量调控任务。请确保您提供的参数值准确无误，以避免操作错误的目标或实例。'."\n", + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"FCF741D8-9C30-578E-807F-B935487DB34A\\",\\n \\"TotalCount\\": 10,\\n \\"FeatureConsistencyCheckConfigs\\": [\\n {\\n \\"FeatureConsistencyCheckJobConfigId\\": \\"3\\",\\n \\"Name\\": \\"feature_consistency_check1\\",\\n \\"SceneId\\": \\"3\\",\\n \\"SceneName\\": \\"scene1\\",\\n \\"Status\\": \\"Editable\\",\\n \\"CompareFeature\\": true,\\n \\"LatestJobId\\": \\"3\\",\\n \\"LatestJobGmtSamplingStartTime\\": \\"2021-12-15T23:24:33.132+08:00\\",\\n \\"LatestJobGmtSamplingEndTime\\": \\"2021-12-15T23:24:33.132+08:00\\",\\n \\"SampleRate\\": \\"0.89\\",\\n \\"FeatureLandingResourceId\\": \\"reso-********\\",\\n \\"FeatureLandingResourceUri\\": \\"mc_project_1\\",\\n \\"EasServiceName\\": \\"eas_service_1\\",\\n \\"FgJsonFileName\\": \\"file.json\\",\\n \\"UserTable\\": \\"user_table\\",\\n \\"UserIdField\\": \\"user_id\\",\\n \\"UserTablePartitionField\\": \\"ds\\",\\n \\"UserTablePartitionFieldFormat\\": \\"yyyymmdd\\",\\n \\"ItemTable\\": \\"item_table\\",\\n \\"ItemIdField\\": \\"item_id\\",\\n \\"ItemTablePartitionField\\": \\"ds\\",\\n \\"ItemTablePartitionFieldFormat\\": \\"yyyymmdd\\",\\n \\"GenerateZip\\": true,\\n \\"ServiceId\\": \\"4\\",\\n \\"ServiceName\\": \\"service1\\",\\n \\"WorkflowName\\": \\"work_flow_1\\",\\n \\"OssResourceId\\": \\"reso-********\\",\\n \\"OssBucket\\": \\"oss_bucket_1\\",\\n \\"EasyRecVersion\\": \\"1.3.60\\",\\n \\"EasyRecPackagePath\\": \\"oss://*******\\",\\n \\"FgJarVersion\\": \\"1.0.0\\",\\n \\"FeaturePriority\\": \\"feature1,feature2,feature3\\",\\n \\"FeatureDisplayExclude\\": \\"feature1,feature2\\",\\n \\"GmtCreateTime\\": \\"2021-12-15T23:24:33.132+08:00\\",\\n \\"GmtModifiedTime\\": \\"2021-12-15T23:24:33.132+08:00\\",\\n \\"UseFeatureStore\\": \\"true\\",\\n \\"FeatureStoreProjectName\\": \\"project-1\\",\\n \\"FeatureStoreModelId\\": \\"2\\\\n\\",\\n \\"FeatureStoreUserId\\": \\"user\\",\\n \\"FeatureStoreItemId\\": \\"item\\",\\n \\"FeatureStoreSeqFeatureView\\": \\"item-1\\",\\n \\"FeatureStoreProjectId\\": \\"prj-01\\",\\n \\"WorkspaceId\\": \\"\\",\\n \\"VpcId\\": \\"\\",\\n \\"SwitchId\\": \\"\\",\\n \\"SecurityGroupId\\": \\"\\",\\n \\"DefaultRoute\\": \\"\\",\\n \\"DatasetId\\": \\"\\",\\n \\"DatasetType\\": \\"\\",\\n \\"DatasetUri\\": \\"\\",\\n \\"DatasetMountPath\\": \\"\\",\\n \\"DatasetName\\": \\"\\",\\n \\"PredictWorkerCount\\": 0,\\n \\"PredictWorkerCpu\\": 0,\\n \\"PredictWorkerMemory\\": 0,\\n \\"ResourceConfig\\": \\"\\"\\n }\\n ]\\n}","type":"json"}]', - 'title' => '获取特征一致性检查任务配置列表', + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"728C5E01-ABF6-5AA8-B9FC-B3BA05DECC77\\"\\n}","type":"json"}]', ], - 'GetFeatureConsistencyCheckJobConfig' => [ - 'summary' => '获取特征一致性检查任务配置详情。', - 'path' => '/api/v1/featureconsistencycheck/jobconfigs/{FeatureConsistencyCheckJobConfigId}', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'StopTrafficControlTask' => [ + 'summary' => '用于停止指定实例和环境下的流量调控任务。', + 'path' => '/api/v1/trafficcontroltasks/{TrafficControlTaskId}/action/stop', + 'methods' => ['post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], - 'operationType' => 'read', + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'get', + 'operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeCode' => '193280', - 'abilityTreeNodes' => [ - 'FEATURElearnN0NAWV', - ], + 'abilityTreeCode' => '220411', + 'abilityTreeNodes' => ['FEATURElearnN0NAWV'], ], 'parameters' => [ [ - 'name' => 'FeatureConsistencyCheckJobConfigId', + 'name' => 'TrafficControlTaskId', 'in' => 'path', + 'schema' => ['description' => '流量调控 ID'."\n", 'type' => 'string', 'required' => false, 'example' => '1'], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', 'schema' => [ - 'title' => '特征一致性检查配置ID。', - 'description' => '特征一致性检查配置ID。如何获取配置ID，请参见[ListFeatureConsistencyCheckJobConfigs](~~2557567~~)。', - 'type' => 'string', - 'required' => true, - 'example' => '3', + 'description' => '请求Body。', + 'type' => 'object', + 'properties' => [ + 'InstanceId' => ['description' => '实例ID。'."\n", 'type' => 'string', 'required' => false, 'example' => 'pairec_123****'], + 'Environment' => ['description' => '所属的环境。Daily-日常环境Pre-预发环境Prod-生产环境'."\n", 'type' => 'string', 'required' => false, 'example' => 'Daily'], + ], + 'required' => false, ], ], [ - 'name' => 'InstanceId', + 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'title' => '实例ID，可从接口ListInstances获取。', - 'description' => '实例ID。如何获取实例ID，请参见[ListInstances](~~2411819~~)。', - 'type' => 'string', - 'required' => true, - 'example' => 'pairec-cn-********', - ], + 'schema' => ['description' => '地域ID。', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou'], ], ], 'responses' => [ @@ -16037,435 +14137,140 @@ 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => '请求ID。', - 'type' => 'string', - 'example' => '728C5E01-ABF6-5AA8-B9FC-B3BA05DECC77', - ], - 'Name' => [ - 'title' => '特征一致性检查配置名称。', - 'description' => '特征一致性检查配置名称。', - 'type' => 'string', - 'example' => 'feature_consistency_check1', - ], - 'SceneId' => [ - 'title' => '场景ID。', - 'description' => '场景ID。', - 'type' => 'string', - 'example' => '3', - ], - 'SceneName' => [ - 'title' => '场景名称。', - 'description' => '场景名称。', - 'type' => 'string', - 'example' => 'scene1', - ], - 'Status' => [ - 'title' => '状态。'."\n" - .'● Editable-可编辑的。'."\n" - .'● Uneditable-不可编辑的。', - 'description' => '状态。可能值为：'."\n" - .'- Editable：可编辑的。'."\n" - .'- Uneditable：不可编辑的。', - 'type' => 'string', - 'example' => 'Editable', - ], - 'CompareFeature' => [ - 'title' => '是否开启特征比对。', - 'description' => '是否开启特征比对。', - 'type' => 'boolean', - 'example' => 'true', - ], - 'LatestJobId' => [ - 'title' => '基于该配置最近一次创建的任务ID。', - 'description' => '基于该配置最近一次创建的任务ID。', - 'type' => 'string', - 'example' => '3', - ], - 'LatestJobGmtSamplingStartTime' => [ - 'title' => '最近一次创建的任务的开始时间。', - 'description' => '最近一次创建的任务的开始时间。', - 'type' => 'string', - 'example' => '2021-12-15T23:24:33.132+08:00', - ], - 'LatestJobGmtSamplingEndTime' => [ - 'title' => '最近一次创建的任务的结束时间。', - 'description' => '最近一次创建的任务的结束时间。', - 'type' => 'string', - 'example' => '2021-12-15T23:24:33.132+08:00', - ], - 'SampleRate' => [ - 'title' => '采样比例（0-1）。', - 'description' => '采样比例（0-1）。', - 'type' => 'string', - 'example' => '0.89', - ], - 'FeatureLandingResourceId' => [ - 'title' => '数据回落数据源ID。', - 'description' => '数据回落数据源ID。', - 'type' => 'string', - 'example' => 'reso-********', - ], - 'FeatureLandingResourceUri' => [ - 'title' => '数据回落数据源地址。', - 'description' => '数据回落数据源地址。', - 'type' => 'string', - 'example' => 'mc_project_1', - ], - 'EasServiceName' => [ - 'title' => 'EAS服务名称。', - 'description' => 'EAS服务名称。', - 'type' => 'string', - 'example' => 'eas_service_1', - ], - 'FgJsonFileName' => [ - 'title' => 'fg_json文件名称。', - 'description' => 'fg_json文件名称。', - 'type' => 'string', - 'example' => 'file.json', - ], - 'UserTable' => [ - 'title' => 'user表名。', - 'description' => 'user表名。', - 'type' => 'string', - 'example' => 'user_table', - ], - 'UserIdField' => [ - 'title' => 'user_id字段名。', - 'description' => 'user_id字段名。', - 'type' => 'string', - 'example' => 'user_id', - ], - 'UserTablePartitionField' => [ - 'title' => 'user表分区字段。', - 'description' => 'user表分区字段。', - 'type' => 'string', - 'example' => 'ds', - ], - 'UserTablePartitionFieldFormat' => [ - 'title' => 'user表分区字段格式。'."\n" - .'● yyyymmdd'."\n" - .'● yyyy-mm-dd', - 'description' => 'user表分区字段格式：'."\n" - .'- yyyymmdd'."\n" - .'- yyyy-mm-dd', - 'type' => 'string', - 'example' => 'yyyymmdd', - ], - 'ItemTable' => [ - 'title' => 'item表名。', - 'description' => 'item表名。', - 'type' => 'string', - 'example' => 'item_table', - ], - 'ItemIdField' => [ - 'title' => 'item_id字段名。', - 'description' => 'item_id字段名。', - 'type' => 'string', - 'example' => 'item_id', - ], - 'ItemTablePartitionField' => [ - 'title' => 'item表分区字段。', - 'description' => 'item表分区字段。', - 'type' => 'string', - 'example' => 'ds', - ], - 'ItemTablePartitionFieldFormat' => [ - 'title' => 'item表分区字段格式。'."\n" - .'● yyyymmdd'."\n" - .'● yyyy-mm-dd', - 'description' => 'item表分区字段格式：'."\n" - .'- yyyymmdd'."\n" - .'- yyyy-mm-dd', - 'type' => 'string', - 'example' => 'yyyymmdd', - ], - 'GenerateZip' => [ - 'title' => '是否需要生成zip包。', - 'description' => '是否需要生成zip包。', - 'type' => 'boolean', - 'example' => 'true', - ], - 'ServiceId' => [ - 'title' => '服务ID。', - 'description' => '服务ID。', - 'type' => 'string', - 'example' => '4', - ], - 'ServiceName' => [ - 'title' => '服务名称。', - 'description' => '服务名称。', - 'type' => 'string', - 'example' => 'service1', - ], - 'WorkflowName' => [ - 'title' => '工作流名称。', - 'description' => '工作流名称。', - 'type' => 'string', - 'example' => 'work_flow_1', - ], - 'OssResourceId' => [ - 'title' => 'OSS数据源ID。', - 'description' => 'OSS数据源ID。', - 'type' => 'string', - 'example' => 'reso-********', - ], - 'OssBucket' => [ - 'title' => 'OSS bucket名称。', - 'description' => 'OSS bucket名称。', - 'type' => 'string', - 'example' => 'oss_bucket_1', - ], - 'EasyRecVersion' => [ - 'title' => 'EasyRec版本。', - 'description' => 'EasyRec版本。', - 'type' => 'string', - 'example' => '1.3.60', - ], - 'EasyRecPackagePath' => [ - 'title' => 'EasyRec包路径。', - 'description' => 'EasyRec包路径。', - 'type' => 'string', - 'example' => 'oss://*******', - ], - 'FgJarVersion' => [ - 'title' => 'fg_jar版本。', - 'description' => 'fg_jar版本。', - 'type' => 'string', - 'example' => '1.0.0', - ], - 'FeaturePriority' => [ - 'title' => '特征优先级，多个特征通过逗号分开。', - 'description' => '特征优先级，多个特征通过半角逗号（,）分开。', - 'type' => 'string', - 'example' => 'feature1,feature2,feature3', - ], - 'FeatureDisplayExclude' => [ - 'title' => '特征展示过滤，多个特征通过逗号分开。', - 'description' => '特征展示过滤，多个特征通过半角逗号（,）分开。', - 'type' => 'string', - 'example' => 'feature1,feature2', - ], - 'GmtCreateTime' => [ - 'title' => '创建时间。', - 'description' => '创建时间。', - 'type' => 'string', - 'example' => '2021-12-15T23:24:33.132+08:00', - ], - 'GmtModifiedTime' => [ - 'title' => '更新时间。', - 'description' => '更新时间。', - 'type' => 'string', - 'example' => '2021-12-15T23:24:33.132+08:00', - ], - 'UseFeatureStore' => [ - 'description' => '是否需要使用feature store，取值：'."\n" - ."\n" - .'- true：使用，此时返回FeatureStoreProjectId、FeatureStoreProjectName、FeatureStoreModelId、FeatureStoreUserId、FeatureStoreItemId。'."\n" - .'- false：不使用，此时UserTable、UserIdField、UserTablePartitionField、UserTablePartitionFieldFormat、ItemTable、ItemIdField、ItemTablePartitionField、ItemTablePartitionFieldFormat为必填项。', - 'type' => 'boolean', - 'example' => 'true', - ], - 'FeatureStoreProjectName' => [ - 'description' => 'feature store项目名称。', - 'type' => 'string', - 'example' => 'project-1', - ], - 'FeatureStoreModelId' => [ - 'description' => 'feature store model ID。', - 'type' => 'string', - 'example' => '2', - ], - 'FeatureStoreUserId' => [ - 'description' => 'feature store user侧主键。', - 'type' => 'string', - 'example' => 'user', - ], - 'FeatureStoreItemId' => [ - 'description' => 'feature store item侧主键。', - 'type' => 'string', - 'example' => 'item', - ], - 'FeatureStoreSeqFeatureView' => [ - 'description' => '序列特征中item特征所在的特征视图的名字。', - 'type' => 'string', - 'example' => 'item-1', - ], - 'FeatureStoreProjectId' => [ - 'description' => 'feature store项目ID', - 'type' => 'string', - 'example' => 'prj-01', - ], - 'WorkspaceId' => [ - 'type' => 'string', - ], - 'VpcId' => [ - 'type' => 'string', - ], - 'SwitchId' => [ - 'type' => 'string', - ], - 'SecurityGroupId' => [ - 'type' => 'string', - ], - 'DefaultRoute' => [ - 'type' => 'string', - ], - 'DatasetId' => [ - 'type' => 'string', - ], - 'DatasetType' => [ - 'type' => 'string', - ], - 'DatasetUri' => [ - 'type' => 'string', - ], - 'DatasetMountPath' => [ - 'type' => 'string', - ], - 'DatasetName' => [ - 'type' => 'string', - ], - 'PredictWorkerCount' => [ - 'type' => 'integer', - 'format' => 'int32', - ], - 'PredictWorkerCpu' => [ - 'type' => 'integer', - 'format' => 'int32', - ], - 'PredictWorkerMemory' => [ - 'type' => 'integer', - 'format' => 'int32', - ], - 'ResourceConfig' => [ - 'type' => 'string', - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => '请求id。'."\n", 'type' => 'string', 'example' => '728C5E01-ABF6-5AA8-B9FC-B3BA05DECC77'], ], ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"728C5E01-ABF6-5AA8-B9FC-B3BA05DECC77\\",\\n \\"Name\\": \\"feature_consistency_check1\\",\\n \\"SceneId\\": \\"3\\",\\n \\"SceneName\\": \\"scene1\\",\\n \\"Status\\": \\"Editable\\",\\n \\"CompareFeature\\": true,\\n \\"LatestJobId\\": \\"3\\",\\n \\"LatestJobGmtSamplingStartTime\\": \\"2021-12-15T23:24:33.132+08:00\\",\\n \\"LatestJobGmtSamplingEndTime\\": \\"2021-12-15T23:24:33.132+08:00\\",\\n \\"SampleRate\\": \\"0.89\\",\\n \\"FeatureLandingResourceId\\": \\"reso-********\\",\\n \\"FeatureLandingResourceUri\\": \\"mc_project_1\\",\\n \\"EasServiceName\\": \\"eas_service_1\\",\\n \\"FgJsonFileName\\": \\"file.json\\",\\n \\"UserTable\\": \\"user_table\\",\\n \\"UserIdField\\": \\"user_id\\",\\n \\"UserTablePartitionField\\": \\"ds\\",\\n \\"UserTablePartitionFieldFormat\\": \\"yyyymmdd\\",\\n \\"ItemTable\\": \\"item_table\\",\\n \\"ItemIdField\\": \\"item_id\\",\\n \\"ItemTablePartitionField\\": \\"ds\\",\\n \\"ItemTablePartitionFieldFormat\\": \\"yyyymmdd\\",\\n \\"GenerateZip\\": true,\\n \\"ServiceId\\": \\"4\\",\\n \\"ServiceName\\": \\"service1\\",\\n \\"WorkflowName\\": \\"work_flow_1\\",\\n \\"OssResourceId\\": \\"reso-********\\",\\n \\"OssBucket\\": \\"oss_bucket_1\\",\\n \\"EasyRecVersion\\": \\"1.3.60\\",\\n \\"EasyRecPackagePath\\": \\"oss://*******\\",\\n \\"FgJarVersion\\": \\"1.0.0\\",\\n \\"FeaturePriority\\": \\"feature1,feature2,feature3\\",\\n \\"FeatureDisplayExclude\\": \\"feature1,feature2\\",\\n \\"GmtCreateTime\\": \\"2021-12-15T23:24:33.132+08:00\\",\\n \\"GmtModifiedTime\\": \\"2021-12-15T23:24:33.132+08:00\\",\\n \\"UseFeatureStore\\": true,\\n \\"FeatureStoreProjectName\\": \\"project-1\\",\\n \\"FeatureStoreModelId\\": \\"2\\",\\n \\"FeatureStoreUserId\\": \\"user\\",\\n \\"FeatureStoreItemId\\": \\"item\\",\\n \\"FeatureStoreSeqFeatureView\\": \\"item-1\\",\\n \\"FeatureStoreProjectId\\": \\"prj-01\\",\\n \\"WorkspaceId\\": \\"\\",\\n \\"VpcId\\": \\"\\",\\n \\"SwitchId\\": \\"\\",\\n \\"SecurityGroupId\\": \\"\\",\\n \\"DefaultRoute\\": \\"\\",\\n \\"DatasetId\\": \\"\\",\\n \\"DatasetType\\": \\"\\",\\n \\"DatasetUri\\": \\"\\",\\n \\"DatasetMountPath\\": \\"\\",\\n \\"DatasetName\\": \\"\\",\\n \\"PredictWorkerCount\\": 0,\\n \\"PredictWorkerCpu\\": 0,\\n \\"PredictWorkerMemory\\": 0,\\n \\"ResourceConfig\\": \\"\\"\\n}","type":"json"}]', - 'title' => '获取特征一致性检查任务配置详情', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '停止流量调控任务', + 'description' => '## 请求说明'."\n" + .'- 该API用于停止特定`TrafficControlTaskId`标识的流量调控任务。'."\n" + .'- `InstanceId`和`Environment`是必需参数，分别指定了要操作的实例ID以及所属环境（日常、预发或生产）。'."\n" + .'- 确保在调用此接口前已经获取了正确的`TrafficControlTaskId`，否则可能会导致请求失败。'."\n", + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"728C5E01-ABF6-5AA8-B9FC-B3BA05DECC77\\"\\n}","type":"json"}]', ], - 'ListFeatureConsistencyCheckJobs' => [ - 'summary' => '获取特征一致性检查任务列表。', - 'path' => '/api/v1/featureconsistencycheck/jobs', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'SyncFeatureConsistencyCheckJobReplayLog' => [ + 'path' => '/api/v1/featureconsistencycheck/jobs/action/syncreplaylog', + 'methods' => ['post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], - 'operationType' => 'read', + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'get', + 'operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATURElearnN0NAWV', - ], + 'abilityTreeNodes' => ['FEATURElearnN0NAWV'], ], 'parameters' => [ [ - 'name' => 'InstanceId', - 'in' => 'query', + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', 'schema' => [ - 'title' => '实例ID。', - 'description' => '实例ID。如何获取实例ID，请参见[ListInstances](~~2411819~~)。', - 'type' => 'string', - 'required' => true, - 'example' => 'pairec-cn-********', + 'description' => '请求Body。', + 'type' => 'object', + 'properties' => [ + 'FeatureConsistencyCheckJobConfigId' => ['title' => '特征一致性检查任务配置ID，可从接口ListFeatureConsistencyCheckJobConfigs获取。', 'description' => '特征一致性检查任务配置ID。如何获取配置ID，请参见[ListFeatureConsistencyCheckJobConfigs](~~2557567~~)。', 'type' => 'string', 'required' => true, 'example' => '3'], + 'InstanceId' => ['title' => '实例ID，可从接口ListInstances获取。', 'description' => '实例ID。如何获取实例ID，请参见[ListInstances](~~2411819~~)。', 'type' => 'string', 'required' => true, 'example' => 'pairec-cn-********'], + 'LogUserId' => ['title' => '日志中用户ID。', 'description' => '日志中用户ID。', 'type' => 'string', 'required' => true, 'example' => '1010'], + 'LogItemId' => ['title' => '日志中物品ID。', 'description' => '日志中物品ID。', 'type' => 'string', 'required' => true, 'example' => '9010'], + 'LogRequestId' => ['title' => '日志中请求ID。', 'description' => '日志中请求ID。', 'type' => 'string', 'required' => true, 'example' => '728C5E01-ABF6-5AA8-B9FC-B3BA05DECC77'], + 'SceneName' => ['title' => '场景名称。', 'description' => '场景名称。', 'type' => 'string', 'required' => true, 'example' => 'video-feed'], + 'LogRequestTime' => ['title' => '日志请求时间。', 'description' => '日志请求时间（UNIX纪元时间戳）。', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1693900981465'], + 'GeneratedFeatures' => ['title' => '生成特征。', 'description' => '生成特征。', 'type' => 'string', 'required' => true, 'example' => 'week_day:1 | userid:3 | itemid:9001 | cate:cat1 | click_5_seq__cate:cat1'], + 'ContextFeatures' => ['title' => '上下文特征。', 'description' => '上下文特征。', 'type' => 'string', 'required' => true, 'example' => '[{\\"Value\\":{\\"FloatFeature\\":0.1}}]'], + 'RawFeatures' => ['title' => '原始特征。', 'description' => '原始特征。', 'type' => 'string', 'required' => true, 'example' => 'author__kv_city_expr_cnt_15d：北京市 | tem__min_age_15d:28'], + ], + 'required' => false, ], ], - [ - 'name' => 'PageNumber', - 'in' => 'query', + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'title' => '页码。', - 'description' => '页码。', - 'type' => 'string', - 'required' => false, - 'example' => '1', + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => 'C7D0B48F-0105-52B9-B60A-FA7606E2234D'], + ], ], ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '同步特征一致性检查任务重放日志', + 'summary' => '同步特征一致性检查任务重放日志。', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'SyncFeatureConsistencyCheckJobReplayLog'], + ], + ], + 'ramActions' => [ [ - 'name' => 'PageSize', - 'in' => 'query', - 'schema' => [ - 'title' => '页大小。', - 'description' => '页大小。', - 'type' => 'string', - 'required' => false, - 'example' => '10', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'pairec:SyncFeatureConsistencyCheckJobReplayLog', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIRecService', 'resourceType' => '全部资源', 'arn' => '*'], + ], ], ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"C7D0B48F-0105-52B9-B60A-FA7606E2234D\\"\\n}","type":"json"}]', + ], + 'TerminateFeatureConsistencyCheckJob' => [ + 'summary' => '取消指定特征一致性检查正在运行中的任务。', + 'path' => '/api/v1/featureconsistencycheck/jobs/{FeatureConsistencyCheckJobId}/action/terminate', + 'methods' => ['post'], + 'schemes' => ['http', 'https'], + 'security' => [ [ - 'name' => 'SortBy', - 'in' => 'query', - 'schema' => [ - 'title' => '排序依据。'."\n" - .'● GmtCreateTime-创建时间。'."\n" - .'● GmtModifiedTime-更新时间。', - 'description' => '排序依据：'."\n" - .'- GmtCreateTime：按创建时间。'."\n" - .'- GmtModifiedTime：按更新时间。', - 'type' => 'string', - 'required' => false, - 'example' => 'GmtCreateTime', - ], + 'AK' => [], ], + ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATURElearnN0NAWV'], + ], + 'parameters' => [ [ - 'name' => 'Order', - 'in' => 'query', - 'schema' => [ - 'title' => '排序方式。'."\n" - .'● ASC-升序。'."\n" - .'● DESC-降序。', - 'description' => '排序方式：'."\n" - .'- ASC：升序。'."\n" - .'- DESC：降序。', - 'type' => 'string', - 'required' => false, - 'example' => 'ASC', - ], + 'name' => 'FeatureConsistencyCheckJobId', + 'in' => 'path', + 'schema' => ['title' => '特征一致性检查任务ID。', 'description' => '特征一致性检查任务ID。如何获取任务ID，请参见[ListFeatureConsistencyCheckJobs](~~2557571~~)。', 'type' => 'string', 'required' => true, 'example' => '3'], ], [ - 'name' => 'Status', - 'in' => 'query', + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', 'schema' => [ - 'title' => '任务状态。'."\n" - .'● ToRun-待运行。'."\n" - .'● Running-运行中。'."\n" - .'● Success-成功。'."\n" - .'● Failure-失败。'."\n" - .'● Stopped-停止/已取消。', - 'description' => '任务状态。取值如下：'."\n" - .'- ToRun：待运行。'."\n" - .'- Running：运行中。'."\n" - .'- Success：成功。'."\n" - .'- Failure：失败。'."\n" - .'- Stopped：停止或已取消。', - 'type' => 'string', + 'description' => '请求Body。', + 'type' => 'object', + 'properties' => [ + 'InstanceId' => ['title' => '实例ID，可从接口ListInstances获取。', 'description' => '实例ID。如何获取实例ID，请参见[ListInstances](~~2411819~~)。', 'type' => 'string', 'required' => true, 'example' => 'pairec-cn-********'], + ], 'required' => false, - 'example' => 'Running', ], ], ], @@ -16476,152 +14281,102 @@ 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => '请求ID。', - 'type' => 'string', - 'example' => 'A04CB8C0-E74A-5E83-BC61-64D153574EC7', - ], - 'TotalCount' => [ - 'title' => '总个数。', - 'description' => '总个数。', - 'type' => 'string', - 'example' => '10', - ], - 'FeatureConsistencyCheckJobs' => [ - 'title' => '特征一致性检查任务列表。', - 'description' => '特征一致性检查任务列表。', - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'FeatureConsistencyCheckJobId' => [ - 'title' => '特征一致性检查任务ID。', - 'description' => '特征一致性检查任务ID。', - 'type' => 'string', - 'example' => '4', - ], - 'FeatureConsistencyCheckJobConfigId' => [ - 'title' => '特征一致性检查配置ID。', - 'description' => '特征一致性检查配置ID。', - 'type' => 'string', - 'example' => '5', - ], - 'FeatureConsistencyCheckJobConfigName' => [ - 'title' => '特征一致性检查任务配置名称。', - 'description' => '特征一致性检查任务配置名称。', - 'type' => 'string', - 'example' => 'feature_consistency_check_1', - ], - 'GmtStartTime' => [ - 'title' => '开始时间。', - 'description' => '开始时间。', - 'type' => 'string', - 'example' => '2021-12-15T23:24:33.132+08:00', - ], - 'GmtEndTime' => [ - 'title' => '结束时间。', - 'description' => '结束时间。', - 'type' => 'string', - 'example' => '2021-12-15T23:24:33.132+08:00', - ], - 'Status' => [ - 'title' => '任务状态。'."\n" - .'● ToRun-待运行。'."\n" - .'● Running-运行中。'."\n" - .'● Success-成功。'."\n" - .'● Failure-失败。'."\n" - .'● Terminated-停止/已取消。', - 'description' => '任务状态。可能值为：'."\n" - .'- ToRun：待运行。'."\n" - .'- Running：运行中。'."\n" - .'- Success：成功。'."\n" - .'- Failure：失败。'."\n" - .'- Stopped：停止或已取消。', - 'type' => 'string', - 'example' => 'Running', - ], - 'Config' => [ - 'title' => '配置信息。', - 'description' => '配置信息。', - 'type' => 'string', - 'example' => '{}', - ], - 'Logs' => [ - 'title' => '日志信息。', - 'description' => '日志信息。', - 'type' => 'array', - 'items' => [ - 'description' => '日志。', - 'type' => 'string', - 'example' => '2022/09/26 02:16:24 INFO: job status: Created', - ], - ], - ], - ], - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => 'A6C01890-54CA-5C49-BC91-AD85A98E4A98'], ], ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"A6C01890-54CA-5C49-BC91-AD85A98E4A98\\"\\n}","type":"json"}]', + 'title' => '取消指定特征一致性检查正在运行中的任务', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'pairec:TerminateFeatureConsistencyCheckJob', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIRecService', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"A04CB8C0-E74A-5E83-BC61-64D153574EC7\\",\\n \\"TotalCount\\": \\"10\\",\\n \\"FeatureConsistencyCheckJobs\\": [\\n {\\n \\"FeatureConsistencyCheckJobId\\": \\"4\\",\\n \\"FeatureConsistencyCheckJobConfigId\\": \\"5\\",\\n \\"FeatureConsistencyCheckJobConfigName\\": \\"feature_consistency_check_1\\",\\n \\"GmtStartTime\\": \\"2021-12-15T23:24:33.132+08:00\\",\\n \\"GmtEndTime\\": \\"2021-12-15T23:24:33.132+08:00\\",\\n \\"Status\\": \\"Running\\",\\n \\"Config\\": \\"{}\\",\\n \\"Logs\\": [\\n \\"2022/09/26 02:16:24 INFO: job status: Created\\"\\n ]\\n }\\n ]\\n}","type":"json"}]', - 'title' => '获取特征一致性检查任务列表', ], - 'GetFeatureConsistencyCheckJob' => [ - 'summary' => '获取特征一致性检查任务详情。', - 'path' => '/api/v1/featureconsistencycheck/jobs/{FeatureConsistencyCheckJobId}', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'UpdateABMetric' => [ + 'summary' => '用于修改已存在的AB测试实验指标配置。', + 'path' => '/api/v1/abmetrics/{ABMetricId}', + 'methods' => ['put'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], - 'operationType' => 'read', + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'get', + 'operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATURElearnN0NAWV', - ], + 'abilityTreeNodes' => ['FEATURElearnN0NAWV'], ], 'parameters' => [ [ - 'name' => 'FeatureConsistencyCheckJobId', + 'name' => 'ABMetricId', 'in' => 'path', - 'schema' => [ - 'title' => '特征一致性检查任务ID。', - 'description' => '特征一致性检查任务ID。如何获取任务ID，请参见[ListFeatureConsistencyCheckJobs](~~2557571~~)。', - 'type' => 'string', - 'required' => false, - 'example' => '4', - ], + 'schema' => ['description' => 'AB指标ID。', 'type' => 'string', 'required' => true, 'example' => '1'], ], [ - 'name' => 'InstanceId', - 'in' => 'query', + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', 'schema' => [ - 'title' => '实例ID。', - 'description' => '实例ID。如何获取实例ID，请参见[ListInstances](~~2411819~~)。', - 'type' => 'string', + 'description' => '请求体参数。', + 'type' => 'object', + 'properties' => [ + 'Name' => ['description' => '指标名称。', 'type' => 'string', 'required' => true, 'example' => 'pv'], + 'Description' => ['description' => '指标描述。', 'type' => 'string', 'required' => true, 'example' => 'pv 指标'], + 'SceneId' => ['description' => '场景ID，可通过接口[ListScenes](~~2402581~~)获取。', 'type' => 'string', 'required' => true, 'example' => '1'], + 'Type' => ['description' => '指标类型。'."\n" + ."\n" + .'- Single-单一指标。'."\n" + ."\n" + .'- Derived-衍生指标。', 'type' => 'string', 'required' => true, 'example' => 'Single'], + 'Realtime' => ['description' => '是否为实时指标。'."\n" + ."\n" + .'- true-是。'."\n" + ."\n" + .'- false-否。', 'type' => 'boolean', 'required' => true, 'example' => 'false'], + 'TableMetaId' => ['description' => '数据表ID，可以通过ListTableMetas获取。', 'type' => 'string', 'required' => true, 'example' => '2'], + 'ResultResourceId' => ['description' => '写回数据表的数据源的ID，可以通过ListInstanceResources获取。', 'type' => 'string', 'required' => false, 'example' => '3'], + 'Definition' => ['description' => '指标定义。', 'type' => 'string', 'required' => true, 'example' => 'sum(click_cnt)'], + 'StatisticsCycle' => ['description' => '统计周期。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1'], + 'LeftMetricId' => ['description' => '衍生指标的左指标ID。', 'type' => 'string', 'required' => false, 'example' => '2'], + 'RightMetricId' => ['description' => '衍生指标的右指标ID。', 'type' => 'string', 'required' => false, 'example' => '3'], + 'Operator' => ['description' => '衍生指标计算的操作符。'."\n" + ."\n" + .'- Plus-加'."\n" + ."\n" + .'- Minus-减'."\n" + ."\n" + .'- Multiplication-乘'."\n" + ."\n" + .'- Division-除', 'type' => 'string', 'required' => false, 'example' => 'Division'], + 'InstanceId' => ['description' => '实例ID，可通过接口[ListInstances](~~2411819~~)获取。', 'type' => 'string', 'required' => true, 'example' => 'pairec-cn-test123'], + 'NeedSignificance' => ['title' => '是否计算显著性。', 'description' => '是否计算显著性'."\n", 'type' => 'boolean', 'required' => false, 'example' => 'True'], + 'AggregationByUser' => ['title' => '计算显著性时，是否按照用户维度来计算。一共有两种逻辑，一种是按用户，一种是按样本。', 'description' => '计算显著性时，是否按照用户维度来计算。一共有两种逻辑，一种是按用户，一种是按样本。'."\n", 'type' => 'boolean', 'required' => false, 'example' => 'True'], + 'Numerator' => ['title' => '当进行显著性计算时，计算的分子。', 'description' => '当进行显著性计算时，计算的分子。'."\n", 'type' => 'string', 'required' => false, 'example' => 'click'], + 'Denominator' => ['title' => '当进行显著性计算时，计算的分母。', 'description' => '当进行显著性计算时，计算的分母。'."\n", 'type' => 'string', 'required' => false, 'example' => 'pv'], + 'IsBinomialDistribution' => ['title' => '当指标类型是衍生指标时，当前指标是否符合二项分布，是的话会二项式分布计算指标的均值和方差。', 'description' => '当指标类型是衍生指标时，当前指标是否符合二项分布，是的话会二项式分布计算指标的均值和方差'."\n", 'type' => 'boolean', 'required' => false, 'example' => 'False'], + ], 'required' => false, - 'example' => 'pairec-cn-********', ], ], ], @@ -16632,165 +14387,164 @@ 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => '请求ID。', - 'type' => 'string', - 'example' => 'A04CB8C0-E74A-5E83-BC61-64D153574EC7', - ], - 'FeatureConsistencyCheckJobConfigId' => [ - 'title' => '特征一致性检查配置ID。', - 'description' => '特征一致性检查配置ID。', - 'type' => 'string', - 'example' => '5', - ], - 'FeatureConsistencyCheckJobConfigName' => [ - 'title' => '特征一致性检查任务配置名称。', - 'description' => '特征一致性检查任务配置名称。', - 'type' => 'string', - 'example' => 'feature_consistency_check_1', - ], - 'GmtStartTime' => [ - 'title' => '开始时间。', - 'description' => '开始时间。', - 'type' => 'string', - 'example' => '2021-12-15T23:24:33.132+08:00', - ], - 'GmtEndTime' => [ - 'title' => '结束时间。', - 'description' => '结束时间。', - 'type' => 'string', - 'example' => '2021-12-15T23:24:33.132+08:00', - ], - 'Status' => [ - 'title' => '任务状态。'."\n" - .'● ToRun-待运行。'."\n" - .'● Running-运行中。'."\n" - .'● Success-成功。'."\n" - .'● Failure-失败。'."\n" - .'● Terminated-停止/已取消。', - 'description' => '任务状态。可能值为：'."\n" - .'- ToRun：待运行。'."\n" - .'- Running：运行中。'."\n" - .'- Success：成功。'."\n" - .'- Failure：失败。'."\n" - .'- Terminated：停止或已取消。', - 'type' => 'string', - 'example' => 'Running', - ], - 'Config' => [ - 'title' => '配置信息。', - 'description' => '配置信息。', - 'type' => 'string', - 'example' => '{}', - ], - 'Logs' => [ - 'title' => '日志信息。', - 'description' => '日志信息。', - 'type' => 'array', - 'items' => [ - 'description' => '日志。', - 'type' => 'string', - 'example' => '2023-02-21 14:28:04 INFO: epoch [1][745/127291]tlr: 2.925e-05, eta: 2 days, 2:11:04, iter_time: 1.682, data_load_time: 0.997, memory: 12898, loss: 1.3768', - ], - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => '6CF1E160-3F36-5E73-A170-C75504F05BBC'], ], ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"6CF1E160-3F36-5E73-A170-C75504F05BBC\\"\\n}","type":"json"}]', + 'title' => '更新AB测试指标', + 'description' => '## 请求说明'."\n" + .'本API允许用户更新指定的AB测试指标的相关属性，包括是否需要计算显著性、聚合方式等。请确保在调用此接口前已经获取了正确的`ABMetricId`。'."\n" + ."\n" + .'- `NeedSignificance`: 指定是否对当前指标进行显著性分析，默认为`false`。'."\n" + .'- `AggregationByUser`: 当选择计算显著性时，决定是按用户还是按样本来聚合数据，默认为`false`（即按样本）。'."\n" + .'- `Numerator` 和 `Denominator`: 在执行显著性计算时分别代表分子和分母的具体定义。'."\n" + .'- `IsBinomialDistribution`: 仅当处理衍生指标时有效，表明该指标是否遵循二项分布规律，这将影响到后续的数据处理逻辑。'."\n" + ."\n" + .'注意：并非所有字段都需要同时提供；只有那些希望更改其值的参数才需包含在请求体中。'."\n", + 'changeSet' => [ + ['createdAt' => '2024-02-22T03:35:42.000Z', 'description' => '请求参数发生变更'], + ], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'pairec:UpdateABMetric', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIRecService', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"A04CB8C0-E74A-5E83-BC61-64D153574EC7\\",\\n \\"FeatureConsistencyCheckJobConfigId\\": \\"5\\",\\n \\"FeatureConsistencyCheckJobConfigName\\": \\"feature_consistency_check_1\\",\\n \\"GmtStartTime\\": \\"2021-12-15T23:24:33.132+08:00\\",\\n \\"GmtEndTime\\": \\"2021-12-15T23:24:33.132+08:00\\",\\n \\"Status\\": \\"Running\\",\\n \\"Config\\": \\"{}\\",\\n \\"Logs\\": [\\n \\"2023-02-21 14:28:04 INFO: epoch [1][745/127291]tlr: 2.925e-05, eta: 2 days, 2:11:04, iter_time: 1.682, data_load_time: 0.997, memory: 12898, loss: 1.3768\\"\\n ]\\n}","type":"json"}]', - 'title' => '获取特征一致性检查任务详情', ], - 'ListFeatureConsistencyCheckJobFeatureReports' => [ - 'summary' => '获取特征一致性检查任务的特征报表。', - 'path' => '/api/v1/featureconsistencycheck/jobs/{FeatureConsistencyCheckJobId}/featurereports', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'UpdateABMetricGroup' => [ + 'summary' => '更新AB实验指标组。', + 'path' => '/api/v1/abmetricgroups/{ABMetricGroupId}', + 'methods' => ['put'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], - 'operationType' => 'read', + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'list', + 'operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATURElearnN0NAWV', - ], + 'abilityTreeNodes' => ['FEATURElearnN0NAWV'], ], 'parameters' => [ [ - 'name' => 'FeatureConsistencyCheckJobId', - 'in' => 'path', + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', 'schema' => [ - 'title' => '特征一致性检查任务ID。', - 'description' => '特征一致性检查任务ID。如何获取任务ID，请参见[ListFeatureConsistencyCheckJobs](~~2557571~~)。', - 'type' => 'string', - 'required' => true, - 'example' => '3', + 'description' => '请求体参数。', + 'type' => 'object', + 'properties' => [ + 'Name' => ['description' => '指标组名称。', 'type' => 'string', 'required' => true, 'example' => 'visits'], + 'SceneId' => ['description' => '场景ID，可通过接口[ListScenes](~~2402581~~)获取。', 'type' => 'string', 'required' => true, 'example' => '1'], + 'Description' => ['description' => '指标组描述。', 'type' => 'string', 'required' => true, 'example' => '访问量相关指标'], + 'ABMetricIds' => ['description' => 'AB实验指标ID列表，逗号分隔。', 'type' => 'string', 'required' => true, 'example' => '1,2'], + 'InstanceId' => ['description' => '实例ID，可从接口[ListInstances](~~2411819~~)获取。', 'type' => 'string', 'required' => true, 'example' => 'pairec-cn-test1'], + 'Realtime' => ['description' => '是否为实时指标组。', 'type' => 'boolean', 'required' => true, 'example' => 'false'], + ], + 'required' => false, ], ], [ - 'name' => 'InstanceId', - 'in' => 'query', + 'name' => 'ABMetricGroupId', + 'in' => 'path', + 'schema' => ['description' => '指标组ID。', 'type' => 'string', 'required' => true, 'example' => '1'], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'title' => '实例ID。', - 'description' => '实例ID。如何获取实例ID，请参见[ListInstances](~~2411819~~)。', - 'type' => 'string', - 'required' => true, - 'example' => 'pairec-cn-********', + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => '74D958EF-3598-56FA-8296-FF1575CE43DF'], + ], ], ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"74D958EF-3598-56FA-8296-FF1575CE43DF\\"\\n}","type":"json"}]', + 'title' => '更新指标组', + 'changeSet' => [ + ['createdAt' => '2024-02-22T03:35:41.000Z', 'description' => '请求参数发生变更'], + ], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ [ - 'name' => 'LogUserId', - 'in' => 'query', - 'schema' => [ - 'title' => '特征比对时的UserId。', - 'description' => '特征比对时的UserId。', - 'type' => 'string', - 'required' => true, - 'example' => '1010', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'pairec:UpdateABMetricGroup', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIRecService', 'resourceType' => '全部资源', 'arn' => '*'], + ], ], ], + ], + ], + 'UpdateCrowd' => [ + 'summary' => '更新指定人群信息，例如更新人群的名称、描述。', + 'path' => '/api/v1/crowds/{CrowdId}', + 'methods' => ['put'], + 'schemes' => ['http', 'https'], + 'security' => [ [ - 'name' => 'LogItemId', - 'in' => 'query', - 'schema' => [ - 'title' => '特征比对时的ItemId。', - 'description' => '特征比对时的ItemId。', - 'type' => 'string', - 'required' => true, - 'example' => '9010', - ], + 'AK' => [], ], + ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATURElearnN0NAWV'], + ], + 'parameters' => [ [ - 'name' => 'LogRequestId', - 'in' => 'query', + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', 'schema' => [ - 'title' => '特征比对时的RequestId。', - 'description' => '特征比对时的RequestId。', - 'type' => 'string', - 'required' => true, - 'example' => 'F7AC05FF-EDE7-5C2B-B9AE-33D6DF4178BA', + 'description' => '请求body。', + 'type' => 'object', + 'properties' => [ + 'Name' => ['title' => '人群名称。', 'description' => '人群名称。', 'type' => 'string', 'required' => true, 'example' => 'xx人群'], + 'Description' => ['title' => '人群描述。', 'description' => '人群描述。', 'type' => 'string', 'required' => true, 'example' => 'This is a test.'], + 'InstanceId' => ['title' => '实例ID。', 'description' => '实例ID，可通过接口ListInstances获取。', 'type' => 'string', 'required' => true, 'example' => 'pairec-test1'], + ], + 'required' => false, ], ], + [ + 'name' => 'CrowdId', + 'in' => 'path', + 'schema' => ['title' => '人群ID。', 'description' => '人群ID，可通过接口ListCrowds获取。', 'type' => 'string', 'required' => true, 'example' => '3'], + ], ], 'responses' => [ 200 => [ @@ -16799,147 +14553,87 @@ 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => '请求ID。', - 'type' => 'string', - 'example' => 'BBD41FBF-E75C-551A-92FA-CAD654AA006F', - ], - 'ReportsOfFeatureDiff' => [ - 'title' => '特征比对报表。', - 'description' => '特征比对报表。', - 'type' => 'array', - 'items' => [ - 'title' => '', - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'LogUserId' => [ - 'title' => '用户ID。', - 'description' => '用户ID。', - 'type' => 'string', - 'example' => '1010', - ], - 'LogItemId' => [ - 'title' => '物品ID。', - 'description' => '物品ID。', - 'type' => 'string', - 'example' => '9010', - ], - 'LogRequestId' => [ - 'title' => '请求ID。', - 'description' => '请求ID。', - 'type' => 'string', - 'example' => 'F7AC05FF-EDE7-5C2B-B9AE-33D6DF4178BA', - ], - 'FeatureName' => [ - 'title' => '特征名称。', - 'description' => '特征名称。', - 'type' => 'string', - 'example' => 'gender', - ], - 'OfflineValue' => [ - 'title' => '离线值。', - 'description' => '离线值。', - 'type' => 'string', - 'example' => 'male', - ], - 'OnlineValue' => [ - 'title' => '在线值。', - 'description' => '在线值。', - 'type' => 'string', - 'example' => 'male', - ], - ], - ], - ], - 'DataPath' => [ - 'description' => '数据路径。', - 'type' => 'string', - 'example' => 'https://********', - ], - 'OssPath' => [ - 'description' => 'OSS路径。', - 'type' => 'string', - 'example' => 'oss://********', - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => '8C27790E-CCA5-56BB-BA17-646295DEC0A2'], ], ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"8C27790E-CCA5-56BB-BA17-646295DEC0A2\\"\\n}","type":"json"}]', + 'title' => '更新人群', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'pairec:UpdateCrowd', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIRecService', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"BBD41FBF-E75C-551A-92FA-CAD654AA006F\\",\\n \\"ReportsOfFeatureDiff\\": [\\n {\\n \\"LogUserId\\": \\"1010\\",\\n \\"LogItemId\\": \\"9010\\",\\n \\"LogRequestId\\": \\"F7AC05FF-EDE7-5C2B-B9AE-33D6DF4178BA\\",\\n \\"FeatureName\\": \\"gender\\",\\n \\"OfflineValue\\": \\"male\\",\\n \\"OnlineValue\\": \\"male\\"\\n }\\n ],\\n \\"DataPath\\": \\"https://********\\",\\n \\"OssPath\\": \\"oss://********\\"\\n}","type":"json"}]', - 'title' => '获取特征一致性检查任务的特征报表', ], - 'ListFeatureConsistencyCheckJobScoreReports' => [ - 'summary' => '获取特征一致性检查任务分数报表。', - 'path' => '/api/v1/featureconsistencycheck/jobs/{FeatureConsistencyCheckJobId}/scorereports', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'UpdateDataDiagnosis' => [ + 'path' => '/api/v1/datadiagnoses/{DataDiagnosisId}', + 'methods' => ['put'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], - 'operationType' => 'read', + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'list', + 'operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATURElearnN0NAWV', - ], + 'abilityTreeNodes' => ['FEATURElearnN0NAWV'], ], 'parameters' => [ [ - 'name' => 'FeatureConsistencyCheckJobId', + 'name' => 'DataDiagnosisId', 'in' => 'path', - 'schema' => [ - 'title' => '特征一致性检查任务报表ID。', - 'description' => '特征一致性检查任务报表ID。特征一致性检查任务ID。如何获取任务ID，请参见[ListFeatureConsistencyCheckJobs](~~2557561~~)。', - 'type' => 'string', - 'required' => true, - 'example' => '3', - ], - ], - [ - 'name' => 'InstanceId', - 'in' => 'query', - 'schema' => [ - 'title' => '实例ID。', - 'description' => '实例ID。如何获取实例ID，请参见[ListInstances](~~2411819~~)。', - 'type' => 'string', - 'required' => false, - 'example' => 'pairec-cn-********', - ], + 'schema' => ['description' => '数据诊断ID。'."\n", 'type' => 'string', 'required' => true, 'example' => '3'], ], [ - 'name' => 'ExcludeRequestIds', - 'in' => 'query', + 'name' => 'body', + 'in' => 'body', 'style' => 'json', 'schema' => [ - 'title' => '特征比对时排除的RequestId。', - 'description' => '特征比对时排除的RequestId列表。', - 'type' => 'array', - 'items' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'required' => false, - 'example' => '728C5E01-ABF6-5AA8-B9FC-B3BA05DECC77', + 'description' => '请求Body。', + 'type' => 'object', + 'properties' => [ + 'InstanceId' => ['description' => '实例ID。'."\n", 'type' => 'string', 'required' => true, 'example' => 'learn-pairec-xxx'], + 'Name' => ['description' => '数据诊断任务配置名称。'."\n", 'type' => 'string', 'required' => true, 'example' => 'data_diagnosis_job1'], + 'Type' => ['description' => '数据诊断任务类型。'."\n" + ."\n" + .'- ChangeRate：物品/用户变化率分析。'."\n" + ."\n" + .'- PreferenceStatisticsCycle：用户偏好统计周期分析。'."\n" + ."\n" + .'- JoinTables：两表关联分析。'."\n" + ."\n" + .'- BaseStatistics：基础统计分析。'."\n" + ."\n" + .'- AbnormalBehavior：异常行为分析。', 'type' => 'string', 'required' => true, 'example' => 'ChangeRate'], + 'TableMetaId' => ['description' => '数据表ID。'."\n", 'type' => 'string', 'required' => false, 'example' => '3'], + 'LeftTableMetaId' => ['description' => '左数据表ID。'."\n", 'type' => 'string', 'required' => false, 'example' => '4'], + 'RightTableMetaId' => ['description' => '右数据表ID。'."\n", 'type' => 'string', 'required' => false, 'example' => '5'], + 'PartitionField' => ['description' => '分区字段。'."\n", 'type' => 'string', 'required' => false, 'example' => 'dt'], + 'LeftTablePartitionField' => ['description' => '左表分区字段。'."\n", 'type' => 'string', 'required' => false, 'example' => 'dt'], + 'RightTablePartitionField' => ['description' => '右表分区字段。'."\n", 'type' => 'string', 'required' => false, 'example' => 'dt'], + 'Config' => ['description' => '数据诊断任务配置内容。若Type=ChangeRate，则需包含：分析字段（AnalysisField）、分区字段格式（PartitionFieldFormat）若Type=PreferenceStatisticsCycle，则需包含：用户ID字段（UserIdField）、单日留存率统计周期（RemainDays）、曾现率统计周期（EverAppearedDays）、周期留存率统计周期（RemainRatePeriods）、分区字段格式（PartitionFieldFormat）若Type=JoinTables，则需包含左表分析字段（LeftTableAnalysisField)、右表分析字段（RightTableAnalysisField)、左表JOIN字段（LeftJoinField）、右表JOIN字段（RightJoinField）、展示用抽样数量（SampleQuantity）、左表分区字段格式（LeftTablePartitionFieldFormat）、右表分区字段格式（RightTablePartitionFieldFormat）若Type=BaseStatistics，则需包含：Tag字段（TagField）、Tag字段分隔符(TagFieldSeparator)、kv字段(KVField)、kv字段分隔符(KVFieldSeparator)、kv对分隔符(KVPairSeparator)、Text字段（TextField）、数据百分位分布（Quantiles）、字符串类型默认值（DefaultValueOfString）、字符串类型空值字段（NullStringField）、分区字段格式（PartitionFieldFormat）若Type=AbnormalBehavior，则需包含：用户ID字段（UserId）、物品ID字段（ItemId）、行为字段(EventField)、上游行为取值(UpStreamBehavior)、下游行为取值(DownstreamBehavior)、分桶数量(NumericHistogramBins)、分区字段格式（PartitionFieldFormat）'."\n", 'type' => 'string', 'required' => true, 'example' => '{"AnalysisField":"userid","PartitionFieldFormat":"yyyymmdd"}'], + 'CycleTime' => ['description' => '周期运行时间（若该字段为空，则不进行周期运行）。'."\n", 'type' => 'string', 'required' => false, 'example' => '08:00'], + 'TopNQuantity' => ['description' => 'topN数量。'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '10'], ], 'required' => false, ], @@ -16952,132 +14646,81 @@ 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => '请求ID。', - 'type' => 'string', - 'example' => 'F0AB6527-093F-5C44-B3BD-42C8C210C619', - ], - 'ReportsOfScoreDiff' => [ - 'title' => '分数比对报表。', - 'description' => '分数比对报表。', - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'LogUserId' => [ - 'title' => '用户ID。', - 'description' => '用户ID。', - 'type' => 'string', - 'example' => '3', - ], - 'LogItemId' => [ - 'title' => '物品ID。', - 'description' => '物品ID。', - 'type' => 'string', - 'example' => '4', - ], - 'LogRequestId' => [ - 'title' => '请求ID。', - 'description' => '请求ID。', - 'type' => 'string', - 'example' => '323', - ], - 'ScoreDiff' => [ - 'title' => '分数差值。', - 'description' => '分数差值。', - 'type' => 'string', - 'example' => '0.00000234', - ], - 'ScoreDiffDetail' => [ - 'title' => '分数比对详细。', - 'description' => '分数比对详细。', - 'type' => 'string', - 'example' => '{}', - ], - ], - ], - ], - 'DataPath' => [ - 'title' => '数据路径。', - 'description' => '数据路径。', - 'type' => 'string', - 'example' => 'http://*******', - ], - 'OssPath' => [ - 'title' => 'oss路径。', - 'description' => 'oss路径。', - 'type' => 'string', - 'example' => 'oss://********', - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => '请求ID。'."\n", 'type' => 'string', 'example' => '728C5E01-ABF6-5AA8-B9FC-B3BA05DECC77'], ], ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"F0AB6527-093F-5C44-B3BD-42C8C210C619\\",\\n \\"ReportsOfScoreDiff\\": [\\n {\\n \\"LogUserId\\": \\"3\\",\\n \\"LogItemId\\": \\"4\\",\\n \\"LogRequestId\\": \\"323\\",\\n \\"ScoreDiff\\": \\"0.00000234\\",\\n \\"ScoreDiffDetail\\": \\"{}\\"\\n }\\n ],\\n \\"DataPath\\": \\"http://*******\\",\\n \\"OssPath\\": \\"oss://********\\"\\n}","type":"json"}]', - 'title' => '获取特征一致性检查任务分数报表', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '更新数据诊断信息', + 'summary' => '用于更新指定的数据诊断任务配置信息。', + 'description' => '## 请求说明'."\n" + .'本API允许用户更新已存在的数据诊断任务的配置信息，包括但不限于实例ID、任务名称、任务类型及具体配置内容等。请确保在请求体中提供正确的`DataDiagnosisId`以定位到需要更新的具体任务，并根据所选的任务类型（Type）准确填写相应的配置参数（Config）。对于周期性运行的任务，请通过`CycleTime`字段设置期望的执行时间；若不希望任务周期性运行，则可省略此字段。'."\n" + ."\n\n" + .'## 注意事项'."\n" + .'- `DataDiagnosisId` 是路径参数，必须提供且唯一标识一个数据诊断任务。'."\n" + .'- 根据不同的`Type`值，`Config`字段的内容结构会有所不同，请参照文档示例进行配置。'."\n" + .'- 如果不需要周期性运行任务，可以省略`CycleTime`字段。'."\n" + .'- 当更新涉及表关联分析（JoinTables）时，请确保正确填写左右表的相关信息，包括`LeftTableMetaId`、`RightTableMetaId`等。'."\n" + .'- 对于所有类型的数据诊断任务，`InstanceId`、`Name`和`Type`都是必填项。'."\n", + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"728C5E01-ABF6-5AA8-B9FC-B3BA05DECC77\\"\\n}","type":"json"}]', ], - 'CloneFeatureConsistencyCheckJobConfig' => [ - 'summary' => '克隆特征一致性检查任务配置。', - 'path' => '/api/v1/featureconsistencycheck/jobconfigs/{SourceFeatureConsistencyCheckJobConfigId}/action/clone', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'UpdateEngineConfig' => [ + 'summary' => '对某个引擎配置进行更新。', + 'path' => '/api/v1/engineconfigs/{EngineConfigId}', + 'methods' => ['put'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'none', + 'operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATURElearnN0NAWV', - ], + 'abilityTreeCode' => '180246', + 'abilityTreeNodes' => ['FEATURElearnN0NAWV'], ], 'parameters' => [ [ - 'name' => 'SourceFeatureConsistencyCheckJobConfigId', + 'name' => 'EngineConfigId', 'in' => 'path', - 'schema' => [ - 'title' => '特征一致性检查配置ID。', - 'description' => '特征一致性检查配置ID。如何获取配置ID，请参见[ListFeatureConsistencyCheckJobConfigs](~~2557567~~)。', - 'type' => 'string', - 'required' => true, - 'example' => '3', - ], + 'schema' => ['description' => '引擎配置ID。', 'type' => 'string', 'required' => false, 'example' => '3'], ], [ 'name' => 'body', 'in' => 'body', 'style' => 'json', 'schema' => [ - 'description' => '请求Body。', + 'description' => '请求body。', 'type' => 'object', 'properties' => [ - 'InstanceId' => [ - 'title' => '实例ID。', - 'description' => '实例ID。如何获取实例ID，请参见[ListInstances](~~2411819~~)。', - 'type' => 'string', - 'required' => true, - 'example' => 'pairec-cn-********', - ], + 'Name' => ['description' => '引擎配置名称。', 'type' => 'string', 'required' => false, 'example' => 'engine_config_v1'], + 'ConfigValue' => ['description' => '引擎配置的内容。', 'type' => 'string', 'required' => false, 'example' => '{'."\n" + .' "ListenConf": {'."\n" + .' "HttpAddr": "",'."\n" + .' "HttpPort": 8000'."\n" + .' }'."\n" + .'}'], + 'Environment' => ['description' => '运行环境。'."\n" + ."\n" + .'- Daily-日常环境。'."\n" + ."\n" + .'- Pre-预发环境。'."\n" + ."\n" + .'- Prod-生产环境。', 'type' => 'string', 'required' => false, 'example' => 'Pre'], + 'InstanceId' => ['description' => '实例ID。如何获取实例ID，请参见[ListInstances](~~2411819~~)。', 'type' => 'string', 'required' => false, 'example' => 'pairec-cn-***test'], + 'Description' => ['type' => 'string', 'required' => false, 'description' => ''], ], 'required' => false, ], @@ -17090,90 +14733,84 @@ 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => '请求ID。', - 'type' => 'string', - 'example' => '74D958EF-3598-56FA-8296-FF1575CE43DF', - ], - 'FeatureConsistencyCheckId' => [ - 'title' => '克隆后新的特征一致性检查配置ID。', - 'description' => '克隆后新的特征一致性检查配置ID。', - 'type' => 'string', - 'example' => '4', - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => 'F8F613A9-DF1C-551A-88E1-397A3981A785'], ], ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"F8F613A9-DF1C-551A-88E1-397A3981A785\\"\\n}","type":"json"}]', + 'title' => '更新引擎配置', + 'changeSet' => [ + ['createdAt' => '2024-12-27T08:56:39.000Z', 'description' => '请求参数发生变更'], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"74D958EF-3598-56FA-8296-FF1575CE43DF\\",\\n \\"FeatureConsistencyCheckId\\": \\"4\\"\\n}","type":"json"}]', - 'title' => '克隆特征一致性检查任务配置', - ], - 'TerminateFeatureConsistencyCheckJob' => [ - 'summary' => '取消指定特征一致性检查正在运行中的任务。', - 'path' => '/api/v1/featureconsistencycheck/jobs/{FeatureConsistencyCheckJobId}/action/terminate', - 'methods' => [ - 'post', + 'flowControl' => [ + 'flowControlList' => [], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'pairec:UpdateEngineConfig', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIRecService', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], ], + ], + 'UpdateExperiment' => [ + 'summary' => '更新指定实验的信息，例如更新实验的名称。', + 'path' => '/api/v1/experiments/{ExperimentId}', + 'methods' => ['put'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'none', + 'operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATURElearnN0NAWV', - ], + 'abilityTreeNodes' => ['FEATURElearnN0NAWV'], ], 'parameters' => [ [ - 'name' => 'FeatureConsistencyCheckJobId', - 'in' => 'path', - 'schema' => [ - 'title' => '特征一致性检查任务ID。', - 'description' => '特征一致性检查任务ID。如何获取任务ID，请参见[ListFeatureConsistencyCheckJobs](~~2557571~~)。', - 'type' => 'string', - 'required' => true, - 'example' => '3', - ], - ], - [ 'name' => 'body', 'in' => 'body', 'style' => 'json', 'schema' => [ - 'description' => '请求Body。', + 'description' => '请求body。', 'type' => 'object', 'properties' => [ - 'InstanceId' => [ - 'title' => '实例ID，可从接口ListInstances获取。', - 'description' => '实例ID。如何获取实例ID，请参见[ListInstances](~~2411819~~)。', - 'type' => 'string', - 'required' => true, - 'example' => 'pairec-cn-********', - ], + 'InstanceId' => ['title' => '实例ID。', 'description' => '实例ID，可通过接口ListInstances获取。', 'type' => 'string', 'required' => true, 'example' => 'pairec-cn-abcdefg1234'], + 'Name' => ['title' => '实验名称。', 'description' => '实验名称。', 'type' => 'string', 'required' => true, 'example' => 'experiment_test'], + 'Description' => ['title' => '实验描述。', 'description' => '实验描述。', 'type' => 'string', 'required' => true, 'example' => 'This is a test.'], + 'Type' => ['title' => '实验类型。'."\n" + .'● Baseline-基准实验。'."\n" + .'● Normal-普通实验。', 'description' => '实验类型。'."\n" + .'● Baseline-基准实验。'."\n" + .'● Normal-普通实验。', 'type' => 'string', 'required' => true, 'example' => 'Baseline'], + 'FlowPercent' => ['title' => '流量分配百分比。', 'description' => '流量分配百分比。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '100'], + 'DebugUsers' => ['title' => '调试用户。', 'description' => '调试用户（需为阿里云账户主账号/子账号uid），多个用户需通过逗号作间隔。', 'type' => 'string', 'required' => false, 'example' => '1124512470******,1124512471******,1124512472******'], + 'DebugCrowdId' => ['title' => '调试人群ID。', 'description' => '调试人群ID，可通过接口ListCrowds获取。', 'type' => 'string', 'required' => false, 'example' => '3'], + 'Config' => ['title' => '实验配置。', 'description' => '实验配置。', 'type' => 'string', 'required' => false, 'example' => '{"RankBy": "Score"}'], ], 'required' => false, ], ], + [ + 'name' => 'ExperimentId', + 'in' => 'path', + 'schema' => ['title' => '实验ID。', 'description' => '实验ID，可通过接口ListExperiments获取。', 'type' => 'string', 'required' => true, 'example' => '3'], + ], ], 'responses' => [ 200 => [ @@ -17182,137 +14819,91 @@ 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => '请求ID。', - 'type' => 'string', - 'example' => 'A6C01890-54CA-5C49-BC91-AD85A98E4A98', - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => 'A760D972-1475-58C0-BBB3-92B5FB08904F'], ], ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"A760D972-1475-58C0-BBB3-92B5FB08904F\\"\\n}","type":"json"}]', + 'title' => '更新实验', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'pairec:UpdateExperiment', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIRecService', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"A6C01890-54CA-5C49-BC91-AD85A98E4A98\\"\\n}","type":"json"}]', - 'title' => '取消指定特征一致性检查正在运行中的任务', ], - 'BackflowFeatureConsistencyCheckJobData' => [ - 'summary' => '对指定特征一致性检查任务配置下，最近一次创建的任务进行数据回流。', - 'path' => '/api/v1/featureconsistencycheck/jobs/action/backflowdata', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'UpdateExperimentGroup' => [ + 'summary' => '更新指定实验组的信息，例如更新实验组的名称、描述。', + 'path' => '/api/v1/experimentgroups/{ExperimentGroupId}', + 'methods' => ['put'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], - 'operationType' => 'readAndWrite', + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'none', + 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATURElearnN0NAWV', - ], + 'abilityTreeCode' => '183398', + 'abilityTreeNodes' => ['FEATURElearnN0NAWV'], ], 'parameters' => [ [ + 'name' => 'ExperimentGroupId', + 'in' => 'path', + 'schema' => ['description' => '实验组ID，可通过接口ListExperimentGroups获取。', 'type' => 'string', 'required' => true, 'example' => '3'], + ], + [ 'name' => 'body', 'in' => 'body', 'style' => 'json', 'schema' => [ - 'description' => '请求Body。', + 'title' => '请求body。', + 'description' => '请求body。', 'type' => 'object', 'properties' => [ - 'FeatureConsistencyCheckJobConfigId' => [ - 'title' => '特征一致性检查任务配置ID，可从接口ListFeatureConsistencyCheckJobConfigs获取。', - 'description' => '特征一致性检查任务配置ID。如何获取配置ID，请参见[ListFeatureConsistencyCheckJobConfigs](~~2557567~~)。', - 'type' => 'string', - 'required' => true, - 'example' => '4', - ], - 'InstanceId' => [ - 'title' => '实例ID，可从接口ListInstances获取。', - 'description' => '实例ID。如何获取实例ID，请参见[ListInstances](~~2411819~~)。', - 'type' => 'string', - 'required' => true, - 'example' => 'pairec-cn-********', - ], - 'LogUserId' => [ - 'title' => '日志中用户ID。', - 'description' => '日志中用户ID。', - 'type' => 'string', - 'required' => true, - 'example' => '1010', - ], - 'LogItemId' => [ - 'title' => '日志中物品ID。', - 'description' => '日志中物品ID。', - 'type' => 'string', - 'required' => true, - 'example' => '9010', - ], - 'LogRequestId' => [ - 'title' => '日志请求ID。', - 'description' => '日志请求ID。', - 'type' => 'string', - 'required' => true, - 'example' => '728C5E01-ABF6-5AA8-B9FC-B3BA05DECC77', - ], - 'SceneName' => [ - 'title' => '场景名称。', - 'description' => '场景名称。', - 'type' => 'string', - 'required' => true, - 'example' => 'video-feed', - ], - 'Scores' => [ - 'title' => '分数。', - 'description' => '分数。', - 'type' => 'string', - 'required' => true, - 'example' => '[\\"{\\\\\\"dbmtl_probs_is_valid_play\\\\\\":0.00032182207107543945,\\\\\\"dbmtl_y_play_time\\\\\\":0.0043269748210906982}\\"]', - ], - 'UserFeatures' => [ - 'title' => '用户特征。', - 'description' => '用户特征。', - 'type' => 'string', - 'required' => true, - 'example' => '{\\"userid\\":{\\"value\\":1010,\\"type\\":\\"string\\"},\\"click_5_seq\\":{\\"value\\":\\"9001;9002;9003;9004;9005\\",\\"type\\":\\"string\\"}}', - ], - 'ItemFeatures' => [ - 'title' => '物品特征。', - 'description' => '物品特征。', - 'type' => 'string', - 'required' => true, - 'example' => '[\\"{\\\\\\"itemid\\\\\\":{\\\\\\"value\\\\\\":1010,\\\\\\"type\\\\\\":\\\\\\"string\\\\\\"}}\\"]', - ], - 'LogRequestTime' => [ - 'title' => '日志请求时间。', - 'description' => '日志请求时间（UNIX纪元时间戳）。', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '1693900981465', - ], - 'ServiceName' => [ - 'type' => 'string', - 'required' => false, - ], + 'LayerId' => ['title' => '层ID。', 'description' => '层ID，可通过接口ListLayers获取。', 'type' => 'string', 'required' => true, 'example' => '3'], + 'Name' => ['title' => '实验组名称。', 'description' => '实验组名称。', 'type' => 'string', 'required' => true, 'example' => 'experiment_group1'], + 'Description' => ['title' => '实验组描述。', 'description' => '实验组描述。', 'type' => 'string', 'required' => true, 'example' => 'This is a test.'], + 'DebugUsers' => ['title' => '调试用户。', 'description' => '调试用户（需为阿里云账户主账号/子账号uid），多个用户需通过逗号作间隔。', 'type' => 'string', 'required' => false, 'example' => 'user1,user2,user3'], + 'DebugCrowdId' => ['title' => '调试人群ID。', 'description' => '调试人群ID，可通过接口ListCrowds获取。', 'type' => 'string', 'required' => false, 'example' => '3'], + 'NeedAA' => ['title' => '是否需要AA实验组。', 'description' => '是否需要AA实验组。', 'type' => 'boolean', 'required' => false, 'example' => 'true'], + 'Filter' => ['title' => '人群定向指定的过滤条件。', 'description' => '人群定向指定的过滤条件。', 'type' => 'string', 'required' => false, 'example' => 'gender=male'], + 'CrowdId' => ['title' => '人群定向的指定人群ID。', 'description' => '人群定向的指定人群ID，可通过接口ListCrowds获取。', 'type' => 'string', 'required' => false, 'example' => '3'], + 'DistributionType' => ['title' => '分流方式。'."\n" + .'● UserId-用户ID'."\n" + .'● TimeDuration-时段', 'description' => '分流方式。'."\n" + .'● UserId-用户ID'."\n" + .'● TimeDuration-时段', 'type' => 'string', 'required' => false, 'example' => 'UserId'], + 'DistributionTimeDuration' => ['title' => '分流时段。', 'description' => '分流时段。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '3'], + 'Config' => ['title' => '实验组配置。', 'description' => '实验组配置。', 'type' => 'string', 'required' => false, 'example' => '{"RankBy": "Score"}'], + 'ReservcedBuckets' => ['title' => '预留桶号。', 'description' => '预留桶号。', 'type' => 'string', 'required' => false, 'example' => '1,2,3'], + 'InstanceId' => ['title' => '实例ID。', 'description' => '实例ID，可通过接口ListInstances获取。', 'type' => 'string', 'required' => true, 'example' => 'pairec-cn-abcdefg1234'], + 'CrowdTargetType' => ['description' => '实验组流量定向的类型，可能的取值包括：'."\n" + .'* All 所有的流量'."\n" + .'* Filter 使用过滤条件的流量'."\n" + .'* CrowdId 通过指定人群ID'."\n" + .'* Random 按照百分比随机流量', 'type' => 'string', 'required' => false, 'example' => 'All'], + 'RandomFlow' => ['description' => '当实验组流量定向的类型是Random时，使用随机流量匹配这个实验组，可能的取值范围是 0 - 100。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '20'], ], 'required' => false, ], @@ -17325,55 +14916,62 @@ 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => '请求ID。', - 'type' => 'string', - 'example' => 'BDB621CB-A81E-5D39-8793-39A365CBCC74', - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => 'F7AC05FF-EDE7-5C2B-B9AE-33D6DF4178BA'], ], ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"F7AC05FF-EDE7-5C2B-B9AE-33D6DF4178BA\\"\\n}","type":"json"}]', + 'title' => '更新实验组', + 'changeSet' => [ + ['createdAt' => '2024-03-20T06:05:19.000Z', 'description' => '请求参数发生变更'], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"BDB621CB-A81E-5D39-8793-39A365CBCC74\\"\\n}","type":"json"}]', - 'title' => '特征一致性检查数据回流', - ], - 'SyncFeatureConsistencyCheckJobReplayLog' => [ - 'summary' => '同步特征一致性检查任务重放日志。', - 'path' => '/api/v1/featureconsistencycheck/jobs/action/syncreplaylog', - 'methods' => [ - 'post', + 'flowControl' => [ + 'flowControlList' => [], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'pairec:UpdateExperimentGroup', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIRecService', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], ], + ], + 'UpdateFeatureConsistencyCheckJobConfig' => [ + 'summary' => '更新特征一致性检查任务配置详细信息，例如更新名称。', + 'path' => '/api/v1/featureconsistencycheck/jobconfigs/{FeatureConsistencyCheckJobConfigId}', + 'methods' => ['put'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'none', + 'operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATURElearnN0NAWV', - ], + 'abilityTreeCode' => '193282', + 'abilityTreeNodes' => ['FEATURElearnN0NAWV'], ], 'parameters' => [ [ + 'name' => 'FeatureConsistencyCheckJobConfigId', + 'in' => 'path', + 'schema' => ['title' => '特征一致性检查配置ID。', 'description' => '特征一致性检查配置ID。如何获取配置ID，请参见[ListFeatureConsistencyCheckJobConfigs](~~2557567~~)。', 'type' => 'string', 'required' => true, 'example' => '3'], + ], + [ 'name' => 'body', 'in' => 'body', 'style' => 'json', @@ -17381,77 +14979,63 @@ 'description' => '请求Body。', 'type' => 'object', 'properties' => [ - 'FeatureConsistencyCheckJobConfigId' => [ - 'title' => '特征一致性检查任务配置ID，可从接口ListFeatureConsistencyCheckJobConfigs获取。', - 'description' => '特征一致性检查任务配置ID。如何获取配置ID，请参见[ListFeatureConsistencyCheckJobConfigs](~~2557567~~)。', - 'type' => 'string', - 'required' => true, - 'example' => '3', - ], - 'InstanceId' => [ - 'title' => '实例ID，可从接口ListInstances获取。', - 'description' => '实例ID。如何获取实例ID，请参见[ListInstances](~~2411819~~)。', - 'type' => 'string', - 'required' => true, - 'example' => 'pairec-cn-********', - ], - 'LogUserId' => [ - 'title' => '日志中用户ID。', - 'description' => '日志中用户ID。', - 'type' => 'string', - 'required' => true, - 'example' => '1010', - ], - 'LogItemId' => [ - 'title' => '日志中物品ID。', - 'description' => '日志中物品ID。', - 'type' => 'string', - 'required' => true, - 'example' => '9010', - ], - 'LogRequestId' => [ - 'title' => '日志中请求ID。', - 'description' => '日志中请求ID。', - 'type' => 'string', - 'required' => true, - 'example' => '728C5E01-ABF6-5AA8-B9FC-B3BA05DECC77', - ], - 'SceneName' => [ - 'title' => '场景名称。', - 'description' => '场景名称。', - 'type' => 'string', - 'required' => true, - 'example' => 'video-feed', - ], - 'LogRequestTime' => [ - 'title' => '日志请求时间。', - 'description' => '日志请求时间（UNIX纪元时间戳）。', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '1693900981465', - ], - 'GeneratedFeatures' => [ - 'title' => '生成特征。', - 'description' => '生成特征。', - 'type' => 'string', - 'required' => true, - 'example' => 'week_day:1 | userid:3 | itemid:9001 | cate:cat1 | click_5_seq__cate:cat1', - ], - 'ContextFeatures' => [ - 'title' => '上下文特征。', - 'description' => '上下文特征。', - 'type' => 'string', - 'required' => true, - 'example' => '[{\\"Value\\":{\\"FloatFeature\\":0.1}}]', - ], - 'RawFeatures' => [ - 'title' => '原始特征。', - 'description' => '原始特征。', - 'type' => 'string', - 'required' => true, - 'example' => 'author__kv_city_expr_cnt_15d：北京市 | tem__min_age_15d:28', - ], + 'InstanceId' => ['title' => '实例ID，可从接口ListInstances获取。', 'description' => '实例ID。如何获取实例ID，请参见[ListInstances](~~2411819~~)。', 'type' => 'string', 'required' => true, 'example' => 'pairec-cn-********'], + 'Name' => ['title' => '特征一致性检查名称。', 'description' => '特征一致性检查名称。', 'type' => 'string', 'required' => true, 'example' => 'feature_consistency_check1'], + 'SceneId' => ['title' => '场景ID。', 'description' => '场景ID。', 'type' => 'string', 'required' => true, 'example' => '3'], + 'SampleRate' => ['title' => '采样比例（0-1）。', 'description' => '采样比例（0-1）。', 'type' => 'number', 'format' => 'double', 'required' => true, 'example' => '0.89'], + 'FeatureLandingResourceId' => ['title' => '数据回落数据源ID。', 'description' => '数据回落数据源ID。', 'type' => 'string', 'required' => true, 'example' => 'reso-********'], + 'MaxcomputeSchema' => ['title' => 'maxcompute schema', 'description' => 'maxcompute schema'."\n", 'type' => 'string', 'required' => false, 'example' => 'default'], + 'EasServiceName' => ['title' => 'PAI-EAS服务名称。', 'description' => 'PAI-EAS服务名称。', 'type' => 'string', 'required' => true, 'example' => 'service_123'], + 'FgJsonFileName' => ['title' => 'fg_json文件名称。', 'description' => 'fg_json文件名称。', 'type' => 'string', 'required' => true, 'example' => 'file.json'], + 'UserTable' => ['title' => 'user表名。', 'description' => 'user表名。', 'type' => 'string', 'required' => true, 'example' => 'user_table'], + 'UserIdField' => ['title' => 'user_id字段名。', 'description' => 'user_id字段名。', 'type' => 'string', 'required' => true, 'example' => 'user_id'], + 'UserTablePartitionField' => ['title' => 'user表分区字段。', 'description' => 'user表分区字段。', 'type' => 'string', 'required' => true, 'example' => 'ds'], + 'UserTablePartitionFieldFormat' => ['title' => 'user表分区字段格式。'."\n" + .'● yyyymmdd'."\n" + .'● yyyy-mm-dd', 'description' => 'user表分区字段格式。'."\n" + .'- yyyymmdd'."\n" + .'- yyyy-mm-dd', 'type' => 'string', 'required' => true, 'example' => 'yyyymmdd'], + 'ItemTable' => ['title' => 'item表名。', 'description' => 'item表名。', 'type' => 'string', 'required' => true, 'example' => 'item_table'], + 'ItemIdField' => ['title' => 'item_id字段名。', 'description' => 'item_id字段名。', 'type' => 'string', 'required' => true, 'example' => 'item_id'], + 'ItemTablePartitionField' => ['title' => 'item表分区字段。', 'description' => 'item表分区字段。', 'type' => 'string', 'required' => true, 'example' => 'ds'], + 'ItemTablePartitionFieldFormat' => ['title' => 'item表分区字段格式。'."\n" + .'● yyyymmdd'."\n" + .'● yyyy-mm-dd', 'description' => 'item表分区字段格式：'."\n" + .'- yyyymmdd'."\n" + .'- yyyy-mm-dd', 'type' => 'string', 'required' => true, 'example' => 'yyyymmdd'], + 'CompareFeature' => ['title' => '是否需要特征比对。', 'description' => '是否需要特征比对。', 'type' => 'boolean', 'required' => true, 'example' => 'true'], + 'GenerateZip' => ['title' => '是否需要生成zip包。', 'description' => '是否需要生成zip包。', 'type' => 'boolean', 'required' => true, 'example' => 'true'], + 'ServiceId' => ['title' => '服务ID。', 'description' => '服务ID。', 'type' => 'string', 'required' => false, 'example' => '4'], + 'WorkflowName' => ['title' => '工作流名称。', 'description' => '工作流名称。', 'type' => 'string', 'required' => false, 'example' => 'work_flow_1'], + 'OssResourceId' => ['title' => 'OSS数据源ID。', 'description' => 'OSS数据源ID。', 'type' => 'string', 'required' => false, 'example' => 'reso-********'], + 'EasyRecVersion' => ['title' => 'EasyRec版本。', 'description' => 'EasyRec版本。', 'type' => 'string', 'required' => false, 'example' => '1.3.60'], + 'EasyRecPackagePath' => ['title' => 'EasyRec包路径。', 'description' => 'EasyRec包路径。', 'type' => 'string', 'required' => false, 'example' => 'oss://********'], + 'FgJarVersion' => ['title' => 'fg_jar版本。', 'description' => 'fg_jar版本。', 'type' => 'string', 'required' => false, 'example' => '1.0.0'], + 'FeaturePriority' => ['title' => '特征优先级，多个特征通过逗号分开。', 'description' => '特征优先级，多个特征通过半角逗号（,）分开，表示哪些特征优先从user表读取，若user表为空，则从行为表查询。', 'type' => 'string', 'required' => false, 'example' => 'feature1,feature2,feature3'], + 'FeatureDisplayExclude' => ['title' => '特征展示过滤，多个特征通过逗号分开。', 'description' => '特征展示过滤，多个特征通过半角逗号（,）分开。', 'type' => 'string', 'required' => false, 'example' => 'feature1,feature2'], + 'IsUseFeatureStore' => ['title' => '是否是用 feature store。', 'description' => '是否是用 feature store。', 'type' => 'boolean', 'required' => false], + 'FeatureStoreProjectName' => ['title' => 'feature store 项目名称。', 'description' => 'feature store 项目名称'."\n", 'type' => 'string', 'required' => false, 'example' => 'project-1'], + 'FeatureStoreModelId' => ['title' => 'feature store model id。', 'description' => 'feature store model id'."\n", 'type' => 'string', 'required' => false, 'example' => '2'], + 'FeatureStoreUserId' => ['title' => 'feature store user 侧主键。', 'description' => 'feature store user 侧主键'."\n", 'type' => 'string', 'required' => false, 'example' => 'user'], + 'FeatureStoreItemId' => ['title' => 'feature store item 侧主键。', 'description' => 'feature store item 侧主键'."\n", 'type' => 'string', 'required' => false, 'example' => 'item'], + 'FeatureStoreSeqFeatureView' => ['title' => '序列特征中item特征所在的特征视图的名字。', 'description' => '序列特征中item特征所在的特征视图的名字'."\n", 'type' => 'string', 'required' => false, 'example' => 'seq_item_view'], + 'FeatureStoreProjectId' => ['title' => 'feature store 的项目 id。', 'description' => 'feature store 的 project id'."\n", 'type' => 'string', 'required' => false, 'example' => '1'], + 'WorkspaceId' => ['title' => 'PAI工作空间ID。', 'description' => 'PAI工作空间ID。'."\n", 'type' => 'string', 'required' => false, 'example' => '34597***'], + 'VpcId' => ['title' => 'VpcID。', 'description' => 'VpcID。'."\n", 'type' => 'string', 'required' => false, 'example' => 'vpc-xxx'], + 'SwitchId' => ['title' => '交换机ID。', 'description' => '交换机ID。'."\n", 'type' => 'string', 'required' => false, 'example' => 'vsw-xxx'], + 'SecurityGroupId' => ['title' => '安全组ID。', 'description' => '安全组ID。'."\n", 'type' => 'string', 'required' => false, 'example' => 'sg-xxx'], + 'DefaultRoute' => ['title' => '默认网关：'."\n" + .'● Eth0: 公共网关。'."\n" + .'● Eth1：专有网关。', 'description' => '默认网关：Eth0: 公共网关。Eth1：专有网关。'."\n", 'type' => 'string', 'required' => false, 'example' => 'Eth0'], + 'DatasetId' => ['title' => '数据集ID。', 'description' => '数据集ID。'."\n", 'type' => 'string', 'required' => false, 'example' => 'd-xxx'], + 'DatasetType' => ['title' => '数据集类型。', 'description' => '数据集类型。'."\n", 'type' => 'string', 'required' => false, 'example' => 'OSS'], + 'DatasetUri' => ['title' => '数据集的 Uri。', 'description' => '数据集的 Uri。'."\n", 'type' => 'string', 'required' => false, 'example' => 'oss://xxxx'], + 'DatasetMountPath' => ['title' => '数据集的挂载路径。', 'description' => '数据集的挂载路径。'."\n", 'type' => 'string', 'required' => false, 'example' => '/mnt/data/'], + 'DatasetName' => ['title' => '数据集名称。', 'description' => '数据集名称。'."\n", 'type' => 'string', 'required' => false, 'example' => 'dateset-test'], + 'PredictWorkerCount' => ['title' => '执行预测脚本时worker数量。', 'description' => '执行预测脚本时worker数量'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1'], + 'PredictWorkerCpu' => ['title' => '执行预测脚本时worker的 cpu。', 'description' => '执行预测脚本时worker的 cpu'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '4'], + 'PredictWorkerMemory' => ['title' => '执行预测脚本时worker内存。', 'description' => '执行预测脚本时worker内存'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '32000(32G)'], + 'ResourceConfig' => ['title' => '资源配置。', 'description' => '资源配置'."\n", 'type' => 'string', 'required' => false, 'example' => '{}'], ], 'required' => false, ], @@ -17464,73 +15048,89 @@ 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => '请求ID。', - 'type' => 'string', - 'example' => 'C7D0B48F-0105-52B9-B60A-FA7606E2234D', - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => 'A04CB8C0-E74A-5E83-BC61-64D153574EC7'], ], ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"A04CB8C0-E74A-5E83-BC61-64D153574EC7\\"\\n}","type":"json"}]', + 'title' => '更新特征一致性检查任务配置', + 'description' => '## 请求说明'."\n" + ."\n" + .'本API允许用户更新一个已存在的特征一致性检查任务的配置信息。通过提供新的配置参数，可以修改包括实例ID、名称、场景ID等在内的多个属性。请确保在请求中包含所有必选参数，并根据需要选择性地提供可选参数。'."\n" + ."\n" + .'- **FeatureConsistencyCheckJobConfigId** 是路径参数，用于指定要更新的具体特征一致性检查任务。'."\n" + .'- 所有其他参数均位于请求体中，其中部分为必选参数（如InstanceId, Name等），其余为可选参数。'."\n" + .'- 特别注意`SampleRate`应为0到1之间的浮点数，表示采样比例。'."\n" + .'- 如果使用了`FeatureStore`相关功能，请确保正确设置`IsUseFeatureStore`标志以及相关的`FeatureStore*`字段。'."\n" + .'- 对于涉及网络配置的部分（如VpcId, SwitchId等），请确保提供的值与您的阿里云环境相匹配。'."\n", + 'changeSet' => [ + ['createdAt' => '2025-06-04T10:10:20.000Z', 'description' => '请求参数发生变更'], + ['createdAt' => '2024-12-10T06:00:28.000Z', 'description' => '请求参数发生变更'], + ['createdAt' => '2024-11-12T09:17:26.000Z', 'description' => '请求参数发生变更'], + ['createdAt' => '2024-02-22T03:35:43.000Z', 'description' => '请求参数发生变更'], + ], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'pairec:UpdateFeatureConsistencyCheckJobConfig', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIRecService', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"C7D0B48F-0105-52B9-B60A-FA7606E2234D\\"\\n}","type":"json"}]', - 'title' => '同步特征一致性检查任务重放日志', ], - 'DeleteEngineConfig' => [ - 'summary' => '删除某个引擎配置。', - 'path' => '/api/v1/engineconfigs/{EngineConfigId}', - 'methods' => [ - 'delete', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'UpdateInstanceResource' => [ + 'summary' => '更新指定实例下指定资源的信息。', + 'path' => '/api/v1/instances/{InstanceId}/resources/{ResourceId}', + 'methods' => ['put'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'none', + 'operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeCode' => '180292', - 'abilityTreeNodes' => [ - 'FEATURElearnN0NAWV', - ], + 'abilityTreeNodes' => ['FEATURElearnN0NAWV'], ], 'parameters' => [ [ - 'name' => 'EngineConfigId', + 'name' => 'InstanceId', 'in' => 'path', - 'schema' => [ - 'description' => '引擎配置ID。', - 'type' => 'string', - 'required' => false, - 'example' => '21', - ], + 'schema' => ['description' => '实例ID，可通过接口[ListInstances](~~2411819~~)获取。', 'type' => 'string', 'required' => true, 'example' => 'pairec-cn-test1'], ], [ - 'name' => 'InstanceId', - 'in' => 'query', + 'name' => 'ResourceId', + 'in' => 'path', + 'schema' => ['description' => '资源ID。', 'type' => 'string', 'required' => true, 'example' => 'reso-2s416t***'], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', 'schema' => [ - 'description' => '实例ID。如何获取实例ID，请参见[ListInstances](~~2411819~~)。', - 'type' => 'string', + 'description' => '请求结构体。', + 'type' => 'object', + 'properties' => [ + 'Uri' => ['description' => '资源地址。', 'type' => 'string', 'required' => false, 'example' => 'bucket-test-123'], + 'Config' => ['description' => '资源配置信息。', 'type' => 'string', 'required' => false, 'example' => '{}'], + ], 'required' => false, - 'example' => 'pairec-cn-***test1', ], ], ], @@ -17541,113 +15141,96 @@ 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => '请求ID。', - 'type' => 'string', - 'example' => 'F7AC05FF-EDE7-5C2B-B9AE-33D6DF4178BA', - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => '3AAA45F6-0798-5461-9360-81D133823CE7'], ], ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"3AAA45F6-0798-5461-9360-81D133823CE7\\"\\n}","type":"json"}]', + 'title' => '更新资源信息', + 'changeSet' => [ + ['createdAt' => '2024-02-22T03:35:44.000Z', 'description' => '请求参数发生变更'], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"F7AC05FF-EDE7-5C2B-B9AE-33D6DF4178BA\\"\\n}","type":"json"}]', - 'title' => '删除引擎配置', - 'description' => '删除某个引擎配置。', - ], - 'UpdateEngineConfig' => [ - 'summary' => '对某个引擎配置进行更新。', - 'path' => '/api/v1/engineconfigs/{EngineConfigId}', - 'methods' => [ - 'put', + 'flowControl' => [ + 'flowControlList' => [], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'pairec:UpdateInstanceResource', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIRecService', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], ], + ], + 'UpdateLaboratory' => [ + 'summary' => '更新实验室信息，例如更新实验室的名称。', + 'path' => '/api/v1/laboratories/{LaboratoryId}', + 'methods' => ['put'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeCode' => '180246', - 'abilityTreeNodes' => [ - 'FEATURElearnN0NAWV', - ], + 'abilityTreeNodes' => ['FEATURElearnN0NAWV'], ], 'parameters' => [ [ - 'name' => 'EngineConfigId', + 'name' => 'LaboratoryId', 'in' => 'path', - 'schema' => [ - 'description' => '引擎配置ID。', - 'type' => 'string', - 'required' => false, - 'example' => '3', - ], + 'schema' => ['title' => '实验室ID。', 'description' => '实验室ID，可通过接口ListLaboratories获取。', 'type' => 'string', 'required' => true, 'example' => '3'], ], [ 'name' => 'body', 'in' => 'body', 'style' => 'json', 'schema' => [ + 'title' => '请求body。', 'description' => '请求body。', 'type' => 'object', 'properties' => [ - 'Name' => [ - 'description' => '引擎配置名称。', - 'type' => 'string', - 'required' => false, - 'example' => 'engine_config_v1', - ], - 'ConfigValue' => [ - 'description' => '引擎配置的内容。', - 'type' => 'string', - 'required' => false, - 'example' => '{'."\n" - .' "ListenConf": {'."\n" - .' "HttpAddr": "",'."\n" - .' "HttpPort": 8000'."\n" - .' }'."\n" - .'}', - ], - 'Environment' => [ - 'description' => '运行环境。'."\n" - ."\n" - .'- Daily-日常环境。'."\n" - ."\n" - .'- Pre-预发环境。'."\n" - ."\n" - .'- Prod-生产环境。', - 'type' => 'string', - 'required' => false, - 'example' => 'Pre', - ], - 'InstanceId' => [ - 'description' => '实例ID。如何获取实例ID，请参见[ListInstances](~~2411819~~)。', - 'type' => 'string', - 'required' => false, - 'example' => 'pairec-cn-***test', - ], - 'Description' => [ - 'type' => 'string', - 'required' => false, - ], + 'Name' => ['title' => '实验室名称。', 'description' => '实验室名称。', 'type' => 'string', 'required' => true, 'example' => 'laboratory1'], + 'Description' => ['title' => '实验室介绍。', 'description' => '实验室介绍。', 'type' => 'string', 'required' => false, 'example' => 'This is a test.'], + 'DebugUsers' => ['title' => '调试用户。', 'description' => '调试用户（需为阿里云账户主账号/子账号uid），多个用户需通过逗号作间隔。', 'type' => 'string', 'required' => false, 'example' => '1124512470******,1124512471******,1124512472******'], + 'DebugCrowdId' => ['title' => '调试人群ID。', 'description' => '调试人群ID。', 'type' => 'string', 'required' => false, 'example' => '3'], + 'BucketCount' => ['title' => '分桶数量。', 'description' => '分桶数量。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '24'], + 'Buckets' => ['title' => '分配桶号。', 'description' => '分配桶号。', 'type' => 'string', 'required' => false, 'example' => '1,2,3,10-20'], + 'BucketType' => ['title' => '分桶方式。'."\n" + .'● Uid-UID分桶（默认）'."\n" + .'● UidHash-UID哈希'."\n" + .'● Filter-过滤条件分桶', 'description' => '分桶方式。'."\n" + .'● Uid-UID分桶（默认）'."\n" + .'● UidHash-UID哈希'."\n" + .'● Filter-过滤条件分桶', 'type' => 'string', 'required' => true, 'example' => 'Filter'], + 'Filter' => ['title' => '过滤条件。', 'description' => '过滤条件。', 'type' => 'string', 'required' => false, 'example' => 'filter=xxx'], + 'Type' => ['title' => '实验室类型。'."\n" + .'● Base'."\n" + .'● NonBase', 'description' => '实验室类型。'."\n" + .'● Base'."\n" + .'● NonBase', 'type' => 'string', 'required' => true, 'example' => 'Base'], + 'InstanceId' => ['title' => '实例ID。', 'description' => '实例ID，可通过接口ListInstances获取。', 'type' => 'string', 'required' => true, 'example' => 'pairec-test1'], + 'Environment' => ['title' => '运行环境'."\n" + .'● Daily-日常环境'."\n" + .'● Pre-预发环境'."\n" + .'● Prod-生产环境', 'description' => '运行环境'."\n" + .'● Daily-日常环境'."\n" + .'● Pre-预发环境'."\n" + .'● Prod-生产环境', 'type' => 'string', 'required' => false, 'example' => 'Daily'], ], 'required' => false, ], @@ -17660,137 +15243,147 @@ 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => '请求ID。', - 'type' => 'string', - 'example' => 'F8F613A9-DF1C-551A-88E1-397A3981A785', - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => 'A04CB8C0-E74A-5E83-BC61-64D153574EC7'], ], ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"A04CB8C0-E74A-5E83-BC61-64D153574EC7\\"\\n}","type":"json"}]', + 'title' => '更新实验室', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'pairec:UpdateLaboratory', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIRecService', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"F8F613A9-DF1C-551A-88E1-397A3981A785\\"\\n}","type":"json"}]', - 'title' => '更新引擎配置', ], - 'ListEngineConfigs' => [ - 'summary' => '获取引擎配置列表。', - 'path' => '/api/v1/engineconfigs', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'UpdateLayer' => [ + 'summary' => '更新指定层的信息，例如更新层的名称、描述。', + 'path' => '/api/v1/layers/{LayerId}', + 'methods' => ['put'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], - 'operationType' => 'read', + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'list', + 'operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeCode' => '180248', - 'abilityTreeNodes' => [ - 'FEATURElearnN0NAWV', - ], + 'abilityTreeNodes' => ['FEATURElearnN0NAWV'], ], 'parameters' => [ [ - 'name' => 'Environment', - 'in' => 'query', - 'schema' => [ - 'description' => '运行环境。'."\n" - ."\n" - .'- Daily：日常环境。'."\n" - ."\n" - .'- Pre：预发环境。'."\n" - ."\n" - .'- Prod：生产环境。', - 'type' => 'string', - 'required' => false, - 'example' => 'Pre', - ], + 'name' => 'LayerId', + 'in' => 'path', + 'schema' => ['description' => '层ID，可通过接口ListLayers获取。', 'type' => 'string', 'required' => true, 'example' => '3'], ], [ - 'name' => 'Status', - 'in' => 'query', + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', 'schema' => [ - 'description' => '状态过滤。'."\n" - ."\n" - .'- Released：已发布。'."\n" - ."\n" - .'- Unreleased：未发布。', - 'type' => 'string', + 'title' => '请求body。', + 'description' => '请求body。', + 'type' => 'object', + 'properties' => [ + 'InstanceId' => ['title' => '实例ID。', 'description' => '实例ID，可通过接口ListInstances获取。', 'type' => 'string', 'required' => true, 'example' => 'pairec-test1'], + 'Name' => ['title' => '层名称。', 'description' => '层名称。', 'type' => 'string', 'required' => true, 'example' => 'layer1'], + 'Description' => ['title' => '层描述。', 'description' => '层描述。', 'type' => 'string', 'required' => true, 'example' => 'This is a test.'], + ], 'required' => false, - 'example' => 'Released', ], ], - [ - 'name' => 'Name', - 'in' => 'query', + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => '引擎配置名称。', - 'type' => 'string', - 'required' => false, - 'example' => 'engine_config_v1', + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => '0EA9215E-EC21-53AB-B8D9-D3DEA90D040A'], + ], ], ], - [ - 'name' => 'PageNumber', - 'in' => 'query', - 'schema' => [ - 'description' => '页码。', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0EA9215E-EC21-53AB-B8D9-D3DEA90D040A\\"\\n}","type":"json"}]', + 'title' => '更新层', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'pairec:UpdateLayer', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIRecService', 'resourceType' => '全部资源', 'arn' => '*'], + ], ], ], + ], + ], + 'UpdateParam' => [ + 'summary' => '更新指定参数的信息，例如更新参数的值。', + 'path' => '/api/v1/params/{ParamId}', + 'methods' => ['put'], + 'schemes' => ['http', 'https'], + 'security' => [ [ - 'name' => 'PageSize', - 'in' => 'query', - 'schema' => [ - 'description' => '分页的大小。', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '10', - ], + 'AK' => [], ], + ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATURElearnN0NAWV'], + ], + 'parameters' => [ [ - 'name' => 'Version', - 'in' => 'query', - 'schema' => [ - 'description' => '版本过滤。'."\n" - ."\n" - .'latest：最近一次更新的版本。', - 'type' => 'string', - 'required' => false, - 'example' => 'latest', - ], + 'name' => 'ParamId', + 'in' => 'path', + 'schema' => ['title' => '参数ID。', 'description' => '参数ID，可通过接口ListParams获取。', 'type' => 'string', 'required' => false, 'example' => '3'], ], [ - 'name' => 'InstanceId', - 'in' => 'query', + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', 'schema' => [ - 'description' => '实例ID，可通过接口[ListInstances](~~2411819~~)获取。', - 'type' => 'string', - 'required' => true, - 'example' => 'pairec-cn-***test', + 'title' => '请求body。', + 'description' => '请求body。', + 'type' => 'object', + 'properties' => [ + 'Value' => ['title' => '参数值。', 'description' => '参数值。', 'type' => 'string', 'required' => false, 'example' => 'house'], + 'InstanceId' => ['title' => '实例ID。', 'description' => '实例ID，可通过接口ListInstances获取。', 'type' => 'string', 'required' => false, 'example' => 'pairec-cn-abcdefg1234'], + ], + 'required' => false, ], ], ], @@ -17801,146 +15394,152 @@ 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => '请求ID。', - 'type' => 'string', - 'example' => '74D958EF-3598-56FA-8296-FF1575CE43DF', - ], - 'TotalCount' => [ - 'description' => '列表内元素总数。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '10', - ], - 'EngineConfigs' => [ - 'description' => '引擎配置列表。', + 'RequestId' => ['title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => 'BBD41FBF-E75C-551A-92FA-CAD654AA006F'], + ], + ], + ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"BBD41FBF-E75C-551A-92FA-CAD654AA006F\\"\\n}","type":"json"}]', + 'title' => '更新参数', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'pairec:UpdateParam', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIRecService', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + ], + ], + 'UpdateRecallManagementConfig' => [ + 'path' => '/api/v1/recallmanagementconfigs', + 'methods' => ['put'], + 'schemes' => ['https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATURElearnN0NAWV'], + ], + 'parameters' => [ + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', + 'schema' => [ + 'description' => '请求Body。', + 'type' => 'object', + 'properties' => [ + 'InstanceId' => ['description' => '**实例ID**'."\n", 'type' => 'string', 'required' => false, 'example' => '1'], + 'Password' => ['description' => '**密码**'."\n", 'type' => 'string', 'required' => false, 'example' => '12345'], + 'NetworkConfigs' => [ + 'description' => '**网络配置**'."\n", 'type' => 'array', 'items' => [ + 'description' => '网络配置详情。', 'type' => 'object', 'properties' => [ - 'EngineConfigId' => [ - 'description' => '引擎配置Id。', - 'type' => 'string', - 'example' => '2', - ], - 'Name' => [ - 'description' => '引擎配置名称。', - 'type' => 'string', - 'example' => 'engine_config_v1', - ], - 'ConfigValue' => [ - 'description' => '引擎配置的内容。', - 'type' => 'string', - 'example' => '{}', - ], - 'Environment' => [ - 'description' => '运行环境。'."\n" - ."\n" - .'- Daily：日常环境。'."\n" - ."\n" - .'- Pre：预发环境。'."\n" - ."\n" - .'- Prod：生产环境。', - 'type' => 'string', - 'example' => 'Pre', - ], - 'Version' => [ - 'description' => '当前发布的/最近更新的版本对应的版本号。', - 'type' => 'string', - 'example' => '20230509161300', - ], - 'Status' => [ - 'description' => '状态。'."\n" - ."\n" - .'- Released：已发布。'."\n" - ."\n" - .'- UnReleased：未发布。', - 'type' => 'string', - 'example' => 'Released', - ], - 'GmtCreateTime' => [ - 'description' => '创建时间。', - 'type' => 'string', - 'example' => '2023-08-07T01:43:42Z', - ], - 'GmtModifiedTime' => [ - 'description' => '更新时间。', - 'type' => 'string', - 'example' => '2023-08-27T12:00:00Z', - ], - 'GmtReleasedTime' => [ - 'description' => '发布时间。', - 'type' => 'string', - 'example' => '2023-08-29 12:00:00', - ], - 'Description' => [ - 'type' => 'string', + 'VpcId' => ['description' => '**交换机ID。**'."\n", 'type' => 'string', 'required' => false, 'example' => 'vpc-xxx'], + 'VswitchIds' => [ + 'description' => '可用区和交换机ID信息。'."\n", + 'type' => 'object', + 'required' => false, + 'additionalProperties' => ['type' => 'string', 'example' => 'vsw-xxx', 'description' => '交换机信息。'], + 'example' => 'cn-hangzhou', ], ], + 'required' => false, ], + 'required' => false, ], ], + 'required' => false, ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"74D958EF-3598-56FA-8296-FF1575CE43DF\\",\\n \\"TotalCount\\": 10,\\n \\"EngineConfigs\\": [\\n {\\n \\"EngineConfigId\\": \\"2\\",\\n \\"Name\\": \\"engine_config_v1\\",\\n \\"ConfigValue\\": \\"{}\\",\\n \\"Environment\\": \\"Pre\\",\\n \\"Version\\": \\"20230509161300\\",\\n \\"Status\\": \\"Released\\",\\n \\"GmtCreateTime\\": \\"2023-08-07T01:43:42Z\\",\\n \\"GmtModifiedTime\\": \\"2023-08-27T12:00:00Z\\",\\n \\"GmtReleasedTime\\": \\"2023-08-29 12:00:00\\",\\n \\"Description\\": \\"\\"\\n }\\n ]\\n}","type":"json"}]', - 'title' => '获取引擎配置列表', - ], - 'GetEngineConfig' => [ - 'summary' => '获取引擎配置详情。', - 'path' => '/api/v1/engineconfigs/{EngineConfigId}', - 'methods' => [ - 'get', + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['title' => 'Id of the request', 'description' => '请求id。'."\n", 'type' => 'string', 'example' => '728C5E01-ABF6-5AA8-B9FC-B3BA05DECC77'], + ], + ], + ], ], - 'schemes' => [ - 'http', - 'https', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '更新召回管理配置', + 'summary' => '用于更新召回管理的初始化配置，包括实例ID、密码及网络配置等信息。', + 'description' => '## 请求说明'."\n" + .'- `InstanceId` 是必填项，用于指定要更新配置的实例。'."\n" + .'- `Password` 和 `NetworkConfigs` 为可选项，根据实际需求选择性提供。'."\n" + .'- 在 `NetworkConfigs` 中，可以进一步指定 VPC ID (`VpcId`) 和可用区与交换机ID映射(`VswitchIds`)来配置网络设置。'."\n" + .'- 注意：敏感信息如密码在传输过程中应确保安全。'."\n", + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"728C5E01-ABF6-5AA8-B9FC-B3BA05DECC77\\"\\n}","type":"json"}]', + ], + 'UpdateRecallManagementService' => [ + 'summary' => '用于更新指定召回管理服务的信息，包括实例ID和描述。', + 'path' => '/api/v1/recallmanagementservices/{RecallManagementServiceId}', + 'methods' => ['put'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], - 'operationType' => 'read', + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'get', + 'operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeCode' => '180249', - 'abilityTreeNodes' => [ - 'FEATURElearnN0NAWV', - ], + 'abilityTreeNodes' => ['FEATURElearnN0NAWV'], ], 'parameters' => [ [ - 'name' => 'EngineConfigId', + 'name' => 'RecallManagementServiceId', 'in' => 'path', - 'schema' => [ - 'description' => '引擎配置ID。', - 'type' => 'string', - 'required' => false, - 'example' => '9', - ], + 'schema' => ['description' => '召回管理服务ID。'."\n", 'type' => 'string', 'required' => false, 'example' => '3'], ], [ - 'name' => 'InstanceId', - 'in' => 'query', + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', 'schema' => [ - 'description' => '实例ID，可通过接口[ListInstances](~~2411819~~)获取。', - 'type' => 'string', + 'description' => '请求Body。', + 'type' => 'object', + 'properties' => [ + 'InstanceId' => ['description' => '实例ID。'."\n", 'type' => 'string', 'required' => false, 'example' => 'pairec-cn-test123'], + 'Description' => ['description' => '召回管理服务描述。'."\n", 'type' => 'string', 'required' => false, 'example' => 'reso-2s416t146ffjc3yefx'], + ], 'required' => false, - 'example' => 'pairec-cn-***test', ], ], ], @@ -17951,143 +15550,173 @@ 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => '请求ID。', - 'type' => 'string', - 'example' => '59CE7EC6-F268-5D71-9215-32922CC50D72', - ], - 'Name' => [ - 'description' => '引擎配置名称。', - 'type' => 'string', - 'example' => 'engine_config_v1', - ], - 'ConfigValue' => [ - 'description' => '引擎配置的内容。', - 'type' => 'string', - 'example' => '{}', - ], - 'Environment' => [ - 'description' => '运行环境。'."\n" - ."\n" - .'- Daily-日常环境。'."\n" - ."\n" - .'- Pre-预发环境。'."\n" - ."\n" - .'- Prod-生产环境。', - 'type' => 'string', - 'example' => 'Pre', - ], - 'Status' => [ - 'description' => 'Released 状态。'."\n" - ."\n" - .'- Released-已发布。'."\n" - ."\n" - .'- UnReleased-未发布。', - 'type' => 'string', - 'example' => 'Released', - ], - 'GmtCreateTime' => [ - 'description' => '创建时间。', - 'type' => 'string', - 'example' => '2024-01-03T02:28:00.000Z', - ], - 'GmtModifiedTime' => [ - 'description' => '更新时间。', - 'type' => 'string', - 'example' => '2024-08-27T12:00:00Z', - ], - 'GmtReleasedTime' => [ - 'description' => '发布时间。', - 'type' => 'string', - 'example' => '2024-01-03 02:28:00', - ], - 'Description' => [ - 'type' => 'string', - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => '请求id。'."\n", 'type' => 'string', 'example' => '728C5E01-ABF6-5AA8-B9FC-B3BA05DECC77'], ], ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '更新召回管理服务', + 'description' => '## 请求说明'."\n" + .'本API允许用户通过提供召回管理服务ID来更新特定召回管理服务的实例ID及描述信息。请确保在请求体中正确填写`InstanceId`与`Description`字段。'."\n" + ."\n" + .'- **RecallManagementServiceId**：需要更新的召回管理服务的唯一标识符。'."\n" + .'- **InstanceId**：关联到此召回管理服务的实例ID。'."\n" + .'- **Description**：对召回管理服务的新描述。'."\n" + ."\n" + .'注意：所有必填项都必须准确无误地提供，否则可能导致更新失败。'."\n", + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"59CE7EC6-F268-5D71-9215-32922CC50D72\\",\\n \\"Name\\": \\"engine_config_v1\\",\\n \\"ConfigValue\\": \\"{}\\",\\n \\"Environment\\": \\"Pre\\",\\n \\"Status\\": \\"Released\\",\\n \\"GmtCreateTime\\": \\"2024-01-03T02:28:00.000Z\\",\\n \\"GmtModifiedTime\\": \\"2024-08-27T12:00:00Z\\",\\n \\"GmtReleasedTime\\": \\"2024-01-03 02:28:00\\",\\n \\"Description\\": \\"\\"\\n}","type":"json"}]', - 'title' => '获取引擎配置详情', + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"728C5E01-ABF6-5AA8-B9FC-B3BA05DECC77\\"\\n}","type":"json"}]', ], - 'CreateEngineConfig' => [ - 'summary' => '创建引擎配置。', - 'path' => '/api/v1/engineconfigs', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'UpdateRecallManagementServiceVersionConfig' => [ + 'path' => '/api/v1/recallmanagementservices/{RecallManagementServiceId}/versions/{RecallManagementServiceVersionId}/configs/{RecallManagementServiceVersionConfigId}', + 'methods' => ['put'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'create', + 'operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeCode' => '180238', - 'abilityTreeNodes' => [ - 'FEATURElearnN0NAWV', - ], + 'abilityTreeNodes' => ['FEATURElearnN0NAWV'], ], 'parameters' => [ [ + 'name' => 'RecallManagementServiceId', + 'in' => 'path', + 'schema' => ['description' => '召回管理服务ID。'."\n", 'type' => 'string', 'required' => false, 'example' => '3'], + ], + [ + 'name' => 'RecallManagementServiceVersionId', + 'in' => 'path', + 'schema' => ['description' => '召回管理服务版本ID。'."\n", 'type' => 'string', 'required' => false, 'example' => '2'], + ], + [ + 'name' => 'RecallManagementServiceVersionConfigId', + 'in' => 'path', + 'schema' => ['description' => '召回管理服务版本配置ID。'."\n", 'type' => 'string', 'required' => false, 'example' => '3'], + ], + [ 'name' => 'body', 'in' => 'body', 'style' => 'json', 'schema' => [ - 'description' => '请求body。', + 'description' => '请求Body', 'type' => 'object', 'properties' => [ - 'Name' => [ - 'description' => '引擎配置名称。', - 'type' => 'string', - 'required' => false, - 'example' => 'engine_config_v1', - ], - 'ConfigValue' => [ - 'description' => '引擎配置的内容。', - 'type' => 'string', - 'required' => false, - 'example' => '{}', - ], - 'Environment' => [ - 'description' => '运行环境。'."\n" - ."\n" - .'- Daily：日常环境。'."\n" - ."\n" - .'- Pre：预发环境。'."\n" - ."\n" - .'- Prod：生产环境。', - 'type' => 'string', - 'required' => false, - 'example' => 'Pre', - ], - 'InstanceId' => [ - 'description' => '实例ID，可从接口[ListInstances](~~2411819~~)获取。', - 'type' => 'string', + 'InstanceId' => ['description' => '实例ID。'."\n", 'type' => 'string', 'required' => false, 'example' => 'pairec-cn-test123'], + 'ConfigType' => ['description' => '召回管理版本配置类型。枚举值：Recall：召回配置。Merge：归并配置。'."\n", 'type' => 'string', 'required' => false, 'example' => 'Recall'], + 'RecallConfig' => [ + 'description' => '召回配置。'."\n", + 'type' => 'object', + 'properties' => [ + 'Name' => ['description' => '召回名称。'."\n", 'type' => 'string', 'required' => false, 'example' => 'etrec'], + 'Description' => ['description' => '召回描述。'."\n", 'type' => 'string', 'required' => false, 'example' => 'this is etrec recall'], + 'Priority' => ['description' => '优先级。数字越小，优先级越高'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '2'], + 'RecallType' => ['description' => '召回类型。'."\n", 'type' => 'string', 'required' => false, 'example' => 'X2I'], + 'RecallManagementTableId' => ['description' => '召回管理表ID。'."\n", 'type' => 'string', 'required' => false, 'example' => '1'], + 'UserVectorRecallManagementTableId' => ['description' => '用户向量召回表ID。'."\n", 'type' => 'string', 'required' => false, 'example' => '3'], + 'UserVectorField' => ['description' => '用户向量字段。'."\n", 'type' => 'string', 'required' => false, 'example' => 'user_embedding'], + 'ItemVectorRecallManagementTableId' => ['description' => '物品向量召回表ID。'."\n", 'type' => 'string', 'required' => false, 'example' => '2'], + 'ItemVectorField' => ['description' => '物品向量字段。'."\n", 'type' => 'string', 'required' => false, 'example' => 'item_embedding'], + 'ItemConditionArray' => ['title' => '物品条件数据格式。', 'description' => '物品条件数据格式。', 'type' => 'string', 'required' => false, 'example' => '["type":"equal"]'], + 'ItemConditionExpression' => ['title' => '物品条件表达式。', 'description' => '物品条件表达式。', 'type' => 'string', 'required' => false, 'example' => 'age>20'], + 'SortFields' => ['description' => '排序字段。', 'type' => 'string', 'required' => false, 'example' => 'name'], + 'Operators' => [ + 'description' => '算子列表。'."\n", + 'type' => 'array', + 'items' => [ + 'description' => '算子详情。', + 'type' => 'object', + 'properties' => [ + 'OperatorType' => ['title' => '算子类型。', 'description' => '算子类型。', 'type' => 'string', 'required' => false, 'example' => 'Filter'], + 'TriggerConfig' => [ + 'description' => 'Trigger算子的配置。'."\n", + 'type' => 'object', + 'properties' => [ + 'Field' => ['description' => '字段名称。'."\n", 'type' => 'string', 'required' => false, 'example' => 'user_id'], + 'IsRandSort' => ['title' => '是否随机排序。', 'description' => '是否随机排序。', 'type' => 'boolean', 'required' => false, 'example' => 'false'], + 'SortField' => ['description' => '排序字段。'."\n", 'type' => 'string', 'required' => false, 'example' => 'create_time'], + 'FieldQuantityLimit' => ['description' => '字段数量限制。'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '20'], + ], + 'required' => false, + ], + 'FilterConfig' => [ + 'description' => '过滤算子的配置。'."\n", + 'type' => 'object', + 'properties' => [ + 'Experession' => ['description' => '过滤表达式。', 'type' => 'string', 'required' => false, 'example' => 'age>20'], + ], + 'required' => false, + ], + 'FeatureConfig' => [ + 'description' => '特征算子的配置。'."\n", + 'type' => 'object', + 'properties' => [ + 'Name' => ['description' => '特征名称。'."\n", 'type' => 'string', 'required' => false, 'example' => 'city'], + 'Type' => ['description' => '特征类型。'."\n", 'type' => 'string', 'required' => false, 'example' => 'string'], + 'Expression' => ['description' => '特征表达式。'."\n", 'type' => 'string', 'required' => false, 'example' => 'category=3'], + ], + 'required' => false, + ], + 'JoinConfig' => [ + 'description' => 'Join算子的配置。'."\n", + 'type' => 'object', + 'properties' => [ + 'Field' => ['description' => 'Join字段。'."\n", 'type' => 'string', 'required' => false, 'example' => 'item_id'], + 'RecallManagementTableId' => ['description' => 'Join表ID。'."\n", 'type' => 'string', 'required' => false, 'example' => '3'], + 'OutputFields' => [ + 'title' => '返回字段。', + 'description' => '返回字段。', + 'type' => 'array', + 'items' => ['title' => '返回字段的值。', 'description' => '返回字段的值。', 'type' => 'string', 'required' => false, 'example' => 'age'], + 'required' => false, + ], + ], + 'required' => false, + ], + ], + 'required' => false, + ], + 'required' => false, + ], + 'ExtendedConfig' => ['description' => '额外配置，方便以后功能扩展。'."\n", 'type' => 'string', 'required' => false, 'example' => '{"":""}'], + ], 'required' => false, - 'example' => 'pairec-cn-***test', ], - 'Description' => [ - 'type' => 'string', + 'MergeConfig' => [ + 'description' => '归并配置。'."\n", + 'type' => 'object', + 'properties' => [ + 'RecallManagementServiceVersionConfigId' => ['title' => '召回管理服务版本配置ID。', 'description' => '召回管理服务版本配置ID。', 'type' => 'string', 'required' => false, 'example' => '4'], + 'MergeType' => ['description' => '归并类型，枚举值：Weight：权重Alternate：交替'."\n", 'type' => 'string', 'required' => false, 'example' => 'Weight'], + 'FilterRecallManagementTableIds' => [ + 'description' => '过滤表ID。'."\n", + 'type' => 'array', + 'items' => ['description' => '过滤表ID列表。', 'type' => 'string', 'required' => false, 'example' => '3'], + 'required' => false, + ], + 'ItemRecallManagementTableId' => ['description' => '物品表ID。'."\n", 'type' => 'string', 'required' => false, 'example' => '2'], + 'ItemTableFields' => [ + 'description' => '物品表输出字段。'."\n", + 'type' => 'array', + 'items' => ['description' => '物品表输出字段列表。', 'type' => 'string', 'required' => false, 'example' => 'item_id'], + 'required' => false, + ], + 'FilterExpression' => ['description' => '过滤表达式。', 'type' => 'string', 'required' => false, 'example' => 'age>20'], + 'ExtendedConfig' => ['description' => '归并配置的一些额外配置，方便以后功能扩展。'."\n", 'type' => 'string', 'required' => false, 'example' => '{"":""}'], + ], 'required' => false, ], ], @@ -18102,104 +15731,86 @@ 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => '请求ID。', - 'type' => 'string', - 'example' => 'E15A1443-7917-5BE0-AE70-25538ECF398D', - ], - 'EngineConfigId' => [ - 'description' => '引擎配置ID。', - 'type' => 'string', - 'example' => '1', - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => '请求id。'."\n", 'type' => 'string', 'example' => '728C5E01-ABF6-5AA8-B9FC-B3BA05DECC77'], ], ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '更新召回管理服务版本配置', + 'summary' => '用于更新指定召回管理服务版本的配置信息。', + 'description' => '## 请求说明'."\n" + .'本API允许用户更新特定召回管理服务版本下的配置详情，包括召回配置和归并配置等。请确保在请求中提供正确的`InstanceId`以及需要更新的具体配置内容。注意，部分字段可能为必填项，请参考具体参数描述。'."\n", + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"E15A1443-7917-5BE0-AE70-25538ECF398D\\",\\n \\"EngineConfigId\\": \\"1\\"\\n}","type":"json"}]', - 'title' => '创建引擎配置', + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"728C5E01-ABF6-5AA8-B9FC-B3BA05DECC77\\"\\n}","type":"json"}]', ], - 'CloneEngineConfig' => [ - 'summary' => '克隆引擎配置。', - 'path' => '/api/v1/engineconfigs/{EngineConfigId}/action/clone', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'UpdateRecallManagementTable' => [ + 'summary' => '用于更新指定ID的召回管理表的相关配置信息。', + 'path' => '/api/v1/recallmanagementtables/{RecallManagementTableId}', + 'methods' => ['put'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'none', + 'operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeCode' => '180296', - 'abilityTreeNodes' => [ - 'FEATURElearnN0NAWV', - ], + 'abilityTreeNodes' => ['FEATURElearnN0NAWV'], ], 'parameters' => [ [ - 'name' => 'EngineConfigId', + 'name' => 'RecallManagementTableId', 'in' => 'path', - 'schema' => [ - 'description' => '引擎配置ID。', - 'type' => 'string', - 'required' => false, - 'example' => '1', - ], + 'schema' => ['description' => '表ID。'."\n", 'type' => 'string', 'required' => true, 'example' => '3'], ], [ 'name' => 'body', 'in' => 'body', 'style' => 'json', 'schema' => [ - 'description' => '请求body。', + 'description' => '请求Body。', 'type' => 'object', 'properties' => [ - 'ConfigValue' => [ - 'description' => '引擎配置的内容。', - 'type' => 'string', - 'required' => false, - 'example' => '{}', - ], - 'InstanceId' => [ - 'description' => '实例ID。如何获取实例ID，请参见[ListInstances](~~2411819~~)。', - 'type' => 'string', - 'required' => false, - 'example' => 'pairec-cn-********', - ], - 'Environment' => [ - 'description' => '运行环境。'."\n" - ."\n" - .'- Daily：日常环境。'."\n" - ."\n" - .'- Pre：预发环境。'."\n" - ."\n" - .'- Prod：生产环境。', - 'type' => 'string', - 'required' => false, - 'example' => 'Pre', - ], - 'Description' => [ - 'type' => 'string', + 'InstanceId' => ['description' => '实例ID。'."\n", 'type' => 'string', 'required' => true, 'example' => 'pairec-cn-test123'], + 'EnableRowCountFluctuationThreshold' => ['description' => '是否启动表数据条目波动阈值'."\n", 'type' => 'boolean', 'required' => false, 'example' => 'true'], + 'MinRowCountFluctuationThreshold' => ['description' => '表数据条目波动阈值最小值'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10'], + 'MaxRowCountFluctuationThreshold' => ['description' => '表数据条目波动阈值最大值'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '100'], + 'EnableDataSizeFluctuationThreshold' => ['description' => '是否启动表大小波动阈值'."\n", 'type' => 'boolean', 'required' => false, 'example' => 'true'], + 'MinDataSizeFluctuationThreshold' => ['description' => '表大小波动阈值最小值'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10'], + 'MaxDataSizeFluctuationThreshold' => ['description' => '表大小波动阈值最大值'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '100'], + 'IndexVersionId' => ['description' => '表的版本Id。'."\n", 'type' => 'string', 'required' => false, 'example' => '20250701'], + 'Fields' => [ + 'description' => '字段列表。'."\n", + 'type' => 'object', + 'properties' => [ + 'Name' => ['description' => '字段名称。'."\n", 'type' => 'string', 'required' => false, 'example' => 'age'], + 'Type' => ['description' => '字段类型。'."\n", 'type' => 'string', 'required' => false, 'example' => 'STRING(全大写)'], + 'Attributes' => [ + 'description' => '枚举值：'."\n" + .'- Primary：主键字段'."\n" + .'- Item：物品字段'."\n" + .'- Score：召回分字段'."\n" + .'- Vector：向量字段'."\n" + .'- Index：索引字段'."\n" + .'字段属性。'."\n", + 'type' => 'array', + 'items' => ['description' => '字段属性。', 'type' => 'string', 'required' => false, 'example' => 'Primary'], + 'required' => false, + ], + 'VectorDimension' => ['description' => '向量维度。'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '32'], + 'VectorMetricType' => ['description' => '向量指标类型。'."\n", 'type' => 'string', 'required' => false, 'example' => 'L2'], + ], 'required' => false, ], ], @@ -18211,81 +15822,84 @@ 200 => [ 'schema' => [ 'title' => 'Schema of Response', - 'description' => 'Schema of Response', + 'description' => '请求id。'."\n", 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => '请求ID。', - 'type' => 'string', - 'example' => 'A04CB8C0-E74A-5E83-BC61-64D153574EC7', - ], - 'EngineConfigId' => [ - 'description' => '引擎配置ID。', - 'type' => 'string', - 'example' => '2', - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => '请求id。'."\n", 'type' => 'string', 'example' => '728C5E01-ABF6-5AA8-B9FC-B3BA05DECC77'], ], ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"A04CB8C0-E74A-5E83-BC61-64D153574EC7\\",\\n \\"EngineConfigId\\": \\"2\\"\\n}","type":"json"}]', - 'title' => '克隆引擎配置', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '更新召回管理数据表', + 'description' => '## 请求说明'."\n" + .'- 本API允许用户通过提供特定的`RecallManagementTableId`来更新对应的召回管理表的信息。'."\n" + .'- 用户可以设置是否启用行数或数据大小波动阈值，并定义这些阈值的具体范围。'."\n" + .'- 支持对表中的字段进行添加或修改，包括字段名称、类型以及相关属性等。'."\n" + .'- `InstanceId`是必需参数，用来标识具体的实例。'."\n" + .'- 对于向量相关的字段，还可以指定向量维度和度量类型。'."\n" + .'- 注意：在请求体中提供的所有非必填参数将根据实际需要选择性地更新到目标表中。'."\n", + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"728C5E01-ABF6-5AA8-B9FC-B3BA05DECC77\\"\\n}","type":"json"}]', ], - 'ApplyEngineConfig' => [ - 'summary' => '发布引擎配置。', - 'path' => '/api/v1/engineconfigs/{EngineConfigId}/action/apply', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'UpdateScene' => [ + 'summary' => '更新场景信息，例如更新场景的名称、描述。', + 'path' => '/api/v1/scenes/{SceneId}', + 'methods' => ['put'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'none', + 'operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeCode' => '180295', - 'abilityTreeNodes' => [ - 'FEATURElearnN0NAWV', - ], + 'abilityTreeNodes' => ['FEATURElearnN0NAWV'], ], 'parameters' => [ [ - 'name' => 'EngineConfigId', + 'name' => 'SceneId', 'in' => 'path', - 'schema' => [ - 'description' => '引擎配置ID。', - 'type' => 'string', - 'required' => false, - 'example' => '2', - ], + 'schema' => ['description' => '场景ID，可通过接口ListScenes获取。', 'type' => 'string', 'required' => false, 'example' => '3'], ], [ - 'name' => 'InstanceId', - 'in' => 'query', + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', 'schema' => [ - 'description' => '实例ID，可通过接口[ListInstances](~~2411819~~)获取。', - 'type' => 'string', + 'description' => '请求body。', + 'type' => 'object', + 'properties' => [ + 'Name' => ['title' => '场景名称。', 'description' => '场景名称。', 'type' => 'string', 'required' => false, 'example' => 'scene1'], + 'Description' => ['title' => '场景描述。', 'description' => '场景描述。', 'type' => 'string', 'required' => false, 'example' => 'This is a test.'], + 'InstanceId' => ['title' => '实例ID。', 'description' => '实例ID，可通过接口ListInstances获取。', 'type' => 'string', 'required' => false, 'example' => 'pairec-cn-abcdefg1234'], + 'Flows' => [ + 'title' => '流量列表。', + 'description' => '流量列表。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'FlowName' => ['title' => '流量名称。', 'description' => '流量名称。', 'type' => 'string', 'required' => false, 'example' => '流量1'], + 'FlowCode' => ['title' => '流量编码。', 'description' => '流量编码。', 'type' => 'string', 'required' => false, 'example' => 'liuliang1'], + ], + 'required' => false, + 'description' => '', + ], + 'required' => false, + ], + ], 'required' => false, - 'example' => 'pairec-cn-***test', ], ], ], @@ -18296,72 +15910,104 @@ 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => '请求ID。', - 'type' => 'string', - 'example' => 'F8F613A9-DF1C-551A-88E1-397A3981A785', - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => 'FC17887E-3C82-5096-8AA6-F4C2E7417245'], ], ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"FC17887E-3C82-5096-8AA6-F4C2E7417245\\"\\n}","type":"json"}]', + 'title' => '更新场景', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'pairec:UpdateScene', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIRecService', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"F8F613A9-DF1C-551A-88E1-397A3981A785\\"\\n}","type":"json"}]', - 'title' => '发布引擎配置', ], - 'GetService' => [ - 'summary' => '获取服务详情。', - 'path' => '/api/v1/services/{ServiceId}', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'UpdateTableMeta' => [ + 'summary' => '更新数据表。', + 'path' => '/api/v1/tablemetas/{TableMetaId}', + 'methods' => ['put'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], - 'operationType' => 'read', + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'get', + 'operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATURElearnN0NAWV', - ], + 'abilityTreeNodes' => ['FEATURElearnN0NAWV'], ], 'parameters' => [ [ - 'name' => 'ServiceId', + 'name' => 'TableMetaId', 'in' => 'path', - 'schema' => [ - 'description' => '服务ID。', - 'type' => 'string', - 'required' => false, - 'example' => '1', - ], + 'schema' => ['description' => '数据表ID。', 'type' => 'string', 'required' => true, 'example' => '1'], ], [ - 'name' => 'InstanceId', - 'in' => 'query', + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', 'schema' => [ - 'description' => '实例ID，可通过接口[ListInstances](~~2411819~~)获取。', - 'type' => 'string', + 'description' => '请求体参数。', + 'type' => 'object', + 'properties' => [ + 'Name' => ['description' => '数据表名称。', 'type' => 'string', 'required' => true, 'example' => 'table_test'], + 'ResourceId' => ['description' => '资源ID，可通过[ListInstanceResource](~~2672886~~)获取。', 'type' => 'string', 'required' => true, 'example' => 'reso-2s416t***'], + 'TableName' => ['description' => '数据库中的表名。', 'type' => 'string', 'required' => true, 'example' => 'table_mysql'], + 'Module' => ['description' => '数据表模块。'."\n" + ."\n" + .'- ABTest：实验数据表。'."\n" + ."\n" + .'- ExperimentTool：实验工具表。'."\n" + ."\n" + .'- DataDiagnosis：数据诊断', 'type' => 'string', 'required' => true, 'example' => 'ABTest'], + 'InstanceId' => ['description' => '实例ID，可通过接口[ListInstances](~~2411819~~)获取。', 'type' => 'string', 'required' => true, 'example' => 'pairec-cn-test1'], + 'Fields' => [ + 'description' => '表字段列表。', + 'type' => 'array', + 'items' => [ + 'description' => '字段信息。', + 'type' => 'object', + 'properties' => [ + 'Name' => ['description' => '字段名。', 'type' => 'string', 'required' => true, 'example' => 'name'], + 'Meaning' => ['description' => '字段含义。', 'type' => 'string', 'required' => true, 'example' => '名称字段'], + 'Type' => ['description' => '字段类型。', 'type' => 'string', 'required' => true, 'example' => 'BIGINT'], + 'IsDimensionField' => ['description' => '是否是维度字段。', 'type' => 'boolean', 'required' => true, 'example' => 'false'], + 'DataType' => [ + 'description' => '字段的数据类型。', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => ['number' => '数字', 'image' => '图片', 'text' => '文本', 'video' => '视频', 'primary_key' => '主键', 'url' => '超链接'], + 'example' => 'primary_key', + ], + 'IsPartitionField' => ['description' => '是否为分区字段。', 'type' => 'string', 'required' => true, 'example' => 'true'], + ], + 'required' => false, + ], + 'required' => true, + ], + 'Description' => ['description' => '表的描述信息。', 'type' => 'string', 'required' => false, 'example' => 'this is a test table'], + ], 'required' => false, - 'example' => 'pairec-test-xxx', ], ], ], @@ -18372,180 +16018,89 @@ 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => '请求ID。', - 'type' => 'string', - 'example' => 'D75C43DC-3D3A-5CC8-9AAC-8C77306C433B', - ], - 'Name' => [ - 'description' => '服务名称。', - 'type' => 'string', - 'example' => 'test_rec', - ], - 'Description' => [ - 'description' => '服务描述。', - 'type' => 'string', - 'example' => 'this is a test rec engine', - ], - 'Region' => [ - 'description' => '服务部署的Region。', - 'type' => 'string', - 'example' => 'cn-beijing', - ], - 'EngineConfigId' => [ - 'description' => '引擎配置ID。', - 'type' => 'string', - 'example' => '3', - ], - 'ImageName' => [ - 'description' => '镜像名称。', - 'type' => 'string', - 'example' => 'registry-vpc.cn-beijing.aliyuncs.com/***/***', - ], - 'ImageAuth' => [ - 'description' => '镜像密钥。', - 'type' => 'string', - 'example' => '********', - ], - 'ServiceResourceUri' => [ - 'description' => '发布服务所使用的资源地址（如EAS的资源组名）。', - 'type' => 'string', - 'example' => 'eas-resource-xxx', - ], - 'ServiceConfig' => [ - 'description' => '发布服务所用的配置（如EAS的服务配置）。', - 'type' => 'string', - 'example' => '{"Port":8080}', - ], - 'GmtReleasedTime' => [ - 'description' => '最近一次（生产）发布时间。', - 'type' => 'string', - 'example' => '2021-12-15T23:24:33.132+08:00', - ], - 'LatestProdReleaseOrder' => [ - 'description' => '最近一次生产发布记录。', - 'type' => 'object', - 'properties' => [ - 'ReleaseOrderId' => [ - 'description' => '发布单ID。', - 'type' => 'string', - 'example' => '3', - ], - 'Topic' => [ - 'description' => '发布标题。', - 'type' => 'string', - 'example' => 'update version', - ], - 'Content' => [ - 'description' => '发布内容。', - 'type' => 'string', - 'example' => 'update golang version to 1.22', - ], - 'ImageVersion' => [ - 'description' => '镜像版本。', - 'type' => 'string', - 'example' => '2.0.0', - ], - 'Releaser' => [ - 'description' => '发布人（包含RAM账号的名称、uid）。', - 'type' => 'string', - 'example' => 'E-xxx.xxx-@xxx.onaliyun.com', - ], - 'ReleaseInfo' => [ - 'description' => '发布信息。', - 'type' => 'string', - 'example' => '{'."\n" - .' "Pre": {'."\n" - .' "Status": "Released",'."\n" - .' "GmtReleasedTime" : "2021-12-15T23:24:33.132+08:00",'."\n" - .' },'."\n" - .' "Prod": {'."\n" - .' "Status": "Released",'."\n" - .' "GmtReleasedTime" : "2021-12-15T23:24:33.132+08:00",'."\n" - .' }'."\n" - .'}', - ], - ], - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => '728C5E01-ABF6-5AA8-B9FC-B3BA05DECC77'], ], ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"728C5E01-ABF6-5AA8-B9FC-B3BA05DECC77\\"\\n}","type":"json"}]', + 'title' => '更新数据表', + 'changeSet' => [ + ['createdAt' => '2024-02-22T03:35:43.000Z', 'description' => '请求参数发生变更'], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"D75C43DC-3D3A-5CC8-9AAC-8C77306C433B\\",\\n \\"Name\\": \\"test_rec\\",\\n \\"Description\\": \\"this is a test rec engine\\",\\n \\"Region\\": \\"cn-beijing\\",\\n \\"EngineConfigId\\": \\"3\\",\\n \\"ImageName\\": \\"registry-vpc.cn-beijing.aliyuncs.com/***/***\\",\\n \\"ImageAuth\\": \\"********\\",\\n \\"ServiceResourceUri\\": \\"eas-resource-xxx\\",\\n \\"ServiceConfig\\": \\"{\\\\\\"Port\\\\\\":8080}\\",\\n \\"GmtReleasedTime\\": \\"2021-12-15T23:24:33.132+08:00\\",\\n \\"LatestProdReleaseOrder\\": {\\n \\"ReleaseOrderId\\": \\"3\\",\\n \\"Topic\\": \\"update version\\",\\n \\"Content\\": \\"update golang version to 1.22\\",\\n \\"ImageVersion\\": \\"2.0.0\\",\\n \\"Releaser\\": \\"E-xxx.xxx-@xxx.onaliyun.com\\",\\n \\"ReleaseInfo\\": \\"{\\\\n\\\\t\\\\\\"Pre\\\\\\": {\\\\n \\\\\\"Status\\\\\\": \\\\\\"Released\\\\\\",\\\\n \\\\\\"GmtReleasedTime\\\\\\" : \\\\\\"2021-12-15T23:24:33.132+08:00\\\\\\",\\\\n },\\\\n \\\\\\"Prod\\\\\\": {\\\\n \\\\\\"Status\\\\\\": \\\\\\"Released\\\\\\",\\\\n \\\\\\"GmtReleasedTime\\\\\\" : \\\\\\"2021-12-15T23:24:33.132+08:00\\\\\\",\\\\n }\\\\n}\\"\\n }\\n}","type":"json"}]', - 'title' => '获取服务详情', - ], - 'GetTrafficControlTaskTraffic' => [ - 'summary' => '获取调控任务上报的流量', - 'path' => '/api/v1/trafficcontroltasks/{TrafficControlTaskId}/trafficinfo', - 'methods' => [ - 'get', + 'flowControl' => [ + 'flowControlList' => [], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'pairec:UpdateTableMeta', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIRecService', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], ], + ], + 'UpdateTrafficControlTarget' => [ + 'path' => '/api/v1/trafficcontroltargets/{TrafficControlTargetId}', + 'methods' => ['put'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], - 'operationType' => 'read', + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'none', + 'operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeCode' => '220416', - 'abilityTreeNodes' => [ - 'FEATURElearnN0NAWV', - ], + 'abilityTreeCode' => '220595', + 'abilityTreeNodes' => ['FEATURElearnN0NAWV'], ], 'parameters' => [ [ - 'name' => 'TrafficControlTaskId', + 'name' => 'TrafficControlTargetId', 'in' => 'path', - 'schema' => [ - 'description' => '流量调控任务ID。', - 'type' => 'string', - 'required' => false, - 'example' => '1', - ], + 'schema' => ['description' => '流量调控目标ID。'."\n", 'type' => 'string', 'required' => false, 'example' => '1'], ], [ - 'name' => 'InstanceId', - 'in' => 'query', + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', 'schema' => [ - 'description' => '实例ID。如何获取实例ID，请参见[ListInstances](~~2411819~~)。', - 'type' => 'string', + 'description' => '请求Body。', + 'type' => 'object', + 'properties' => [ + 'Name' => ['description' => '流量调控目标名称'."\n", 'type' => 'string', 'required' => false, 'example' => 'target-1'], + 'StartTime' => ['description' => '调控目标开始时间'."\n", 'type' => 'string', 'required' => false, 'example' => '2024-03-25'], + 'EndTime' => ['description' => '调控目标结束时间'."\n", 'type' => 'string', 'required' => false, 'example' => '2024-04-25'], + 'ItemConditionType' => ['description' => '物品调控的条件类型'."\n", 'type' => 'string', 'required' => false, 'example' => 'Array'], + 'ItemConditionArray' => ['description' => '物品条件，设置数组格式条件'."\n", 'type' => 'string', 'required' => false, 'example' => '[{"field":"status","option":"=","value":"1"}]'], + 'ItemConditionExpress' => ['description' => '物品条件，设置表达式格式条件'."\n", 'type' => 'string', 'required' => false, 'example' => 'status=1'], + 'Event' => ['description' => '调控目标事件'."\n", 'type' => 'string', 'required' => false, 'example' => 'click'], + 'Value' => ['description' => '调控目标值'."\n", 'type' => 'number', 'format' => 'float', 'required' => false, 'example' => '30'], + 'StatisPeriod' => ['description' => '统计周期'."\n", 'type' => 'string', 'required' => false, 'example' => 'Daily'], + 'ToleranceValue' => ['description' => '调控目标容错范围'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '10'], + 'RecallName' => ['description' => '召回策略名称'."\n", 'type' => 'string', 'required' => false, 'example' => 'recall-1'], + 'Status' => ['description' => '调控目标状态'."\n", 'type' => 'string', 'required' => false, 'example' => 'Opened'], + 'NewProductRegulation' => ['description' => '是否是新品调控'."\n", 'type' => 'boolean', 'required' => false, 'example' => 'false'], + ], 'required' => false, - 'example' => 'pairec-test-xxx', ], ], [ - 'name' => 'Environment', + 'name' => 'new-param-3', 'in' => 'query', - 'schema' => [ - 'description' => '运行环境。'."\n" - ."\n" - .'- Daily-日常环境。'."\n" - ."\n" - .'- Pre-预发环境。'."\n" - ."\n" - .'- Prod-生产环境。', - 'type' => 'string', - 'required' => false, - 'example' => 'Pre', - ], + 'schema' => ['description' => '无效参数。', 'type' => 'string', 'required' => false, 'example' => 'null'], ], ], 'responses' => [ @@ -18555,119 +16110,54 @@ 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => '请求ID。', - 'type' => 'string', - 'example' => '6CF1E160-3F36-5E73-A170-C75504F05BBC', - ], - 'TrafficControlTaskTrafficInfo' => [ - 'description' => '上报的关于流量调控的数据详情。', - 'type' => 'object', - 'properties' => [ - 'TaskTraffics' => [ - 'description' => '上报的调控任务的流量数据。', - 'type' => 'object', - 'additionalProperties' => [ - 'type' => 'object', - 'properties' => [ - 'Traffic' => [ - 'type' => 'number', - 'format' => 'double', - 'description' => '对应调控任务的真实上报流量。', - 'example' => '100', - ], - ], - 'description' => '数据是Map结构，Key为实验ID。', - ], - ], - 'TargetTraffics' => [ - 'description' => '上报的调控目标的真实流量数据，此处是数组结构。', - 'type' => 'array', - 'items' => [ - 'description' => '上报的调控目标的真实流量数据。', - 'type' => 'object', - 'properties' => [ - 'TrafficContorlTargetId' => [ - 'type' => 'string', - ], - 'Data' => [ - 'description' => '上报的此调控目标的详细数据信息。', - 'type' => 'object', - 'additionalProperties' => [ - 'type' => 'object', - 'properties' => [ - 'Traffic' => [ - 'type' => 'number', - 'format' => 'double', - 'description' => '上报的调控目标的真实流量。', - 'example' => '80', - ], - 'RecordTime' => [ - 'type' => 'integer', - 'format' => 'int64', - ], - ], - 'description' => '数据是Map结构，Key为实验ID。', - ], - ], - ], - ], - ], - ], - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => '请求id。'."\n", 'type' => 'string', 'example' => '728C5E01-ABF6-5AA8-B9FC-B3BA05DECC77'], ], ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"6CF1E160-3F36-5E73-A170-C75504F05BBC\\",\\n \\"TrafficControlTaskTrafficInfo\\": {\\n \\"TaskTraffics\\": {\\n \\"key\\": {\\n \\"Traffic\\": 100\\n }\\n },\\n \\"TargetTraffics\\": [\\n {\\n \\"TrafficControlTargetId\\": \\"\\",\\n \\"Data\\": {\\n \\"key\\": {\\n \\"Traffic\\": 80,\\n \\"RecorfTime\\": 0\\n }\\n }\\n }\\n ]\\n }\\n}","type":"json"}]', - 'title' => '获取调控任务上报流量', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '更新流量调控目标', + 'summary' => '用于修改已有的流量调控目标配置，包括调控时间、条件及目标值等。', + 'description' => '## 请求说明'."\n" + .'- 本接口允许用户更新指定ID的流量调控目标。'."\n" + .'- `TrafficControlTargetId` 是路径参数，必须提供具体的流量调控目标ID。'."\n" + .'- `ItemConditionType` 定义了物品调控条件的形式，支持数组(`Array`)或表达式(`Expression`)两种格式；根据所选类型，相应地填写`ItemConditionArray`或`ItemConditionExpress`字段。'."\n" + .'- 如果设置了`NewProductRegulation`为`true`，则表示该调控规则特别针对新品进行调整。'."\n" + .'- `StatisPeriod` 可选项包括按天(`Daily`)和按小时(`Hour`)统计，默认情况下可能采用系统预设值。'."\n" + .'- 确保提供的`StartTime`与`EndTime`之间的时间间隔合理，并且符合业务需求。'."\n", + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"728C5E01-ABF6-5AA8-B9FC-B3BA05DECC77\\"\\n}","type":"json"}]', ], - 'SplitTrafficControlTarget' => [ - 'summary' => '拆分流量调控各个时间段的目标值。', - 'path' => '/api/v1/trafficcontroltargets/{TrafficControlTargetId}/action/split', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'UpdateTrafficControlTask' => [ + 'summary' => '用于更新指定的流量调控任务，包括其配置和目标。', + 'path' => '/api/v1/trafficcontroltasks/{TrafficControlTaskId}', + 'methods' => ['put'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'none', + 'operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeCode' => '220603', - 'abilityTreeNodes' => [ - 'FEATURElearnN0NAWV', - ], + 'abilityTreeCode' => '220407', + 'abilityTreeNodes' => ['FEATURElearnN0NAWV'], ], 'parameters' => [ [ - 'name' => 'TrafficControlTargetId', + 'name' => 'TrafficControlTaskId', 'in' => 'path', - 'schema' => [ - 'description' => '流量调控目标ID。', - 'type' => 'string', - 'required' => false, - 'example' => '1', - ], + 'schema' => ['description' => '流量调控任务ID。'."\n", 'type' => 'string', 'required' => false, 'example' => '1'], ], [ 'name' => 'body', @@ -18677,55 +16167,158 @@ 'description' => '请求Body。', 'type' => 'object', 'properties' => [ - 'Environment' => [ - 'description' => '运行环境：'."\n" - ."\n" - .'- Pre-预发环境。'."\n" - ."\n" - .'- Prod-生产环境。', - 'type' => 'string', - 'required' => false, - 'example' => 'Prod', - ], - 'InstanceId' => [ - 'description' => '实例ID。如何获取实例ID，请参见[ListInstances](~~2411819~~)。', - 'type' => 'string', - 'required' => false, - 'example' => 'learn-pairec-xxx', - ], - 'TimePoints' => [ - 'description' => '时间分割点。', + 'Name' => ['description' => '流量调控计划名称。'."\n", 'type' => 'string', 'required' => false, 'example' => 'plan-1'], + 'Description' => ['description' => '流量调控计划备注。'."\n", 'type' => 'string', 'required' => false, 'example' => 'this is a test'], + 'SceneId' => ['description' => '场景 ID。', 'type' => 'string', 'required' => false, 'example' => '1'], + 'ExecutionTime' => ['description' => '执行时间 枚举值：`Permanent`：永久执行 `TimeRange`: 指定时间范围。选择此参数时，需要指定 `StartTime` 和 `EndTime`。'."\n", 'type' => 'string', 'required' => false, 'example' => 'Permanent'], + 'StartTime' => ['description' => '开始时间。', 'type' => 'string', 'required' => false, 'example' => '2024-03-25'], + 'EndTime' => ['description' => '结束时间。', 'type' => 'string', 'required' => false, 'example' => '2024-04-25'], + 'BehaviorTableMetaId' => ['description' => '行为表ID。', 'type' => 'string', 'required' => false, 'example' => '1'], + 'UserTableMetaId' => ['description' => '用户表ID。', 'type' => 'string', 'required' => false, 'example' => '2'], + 'ItemTableMetaId' => ['description' => '物品表ID。', 'type' => 'string', 'required' => false, 'example' => '3'], + 'UserConditionType' => ['description' => '干预人群条件类型。', 'type' => 'string', 'required' => false, 'example' => 'Array'], + 'UserConditionArray' => ['description' => '干预人群，设置数组格式条件。', 'type' => 'string', 'required' => false, 'example' => '[{"field":"gender","option":"=","value":"male"}]'], + 'UserConditionExpress' => ['description' => '干预人群，设置表达式格式条件。', 'type' => 'string', 'required' => false, 'example' => 'age<=30&&(3<=level<=6)&&gender=male'], + 'StatisBehaviorConditionType' => ['description' => '统计行为条件类型。', 'type' => 'string', 'required' => false, 'example' => 'Array'], + 'StatisBaeaviorConditionArray' => ['description' => '统计行为条件数组格式。', 'type' => 'string', 'required' => false, 'example' => 'click=exposure'], + 'StatisBehaviorConditionExpress' => ['description' => '统计行为表达式格式条件。', 'type' => 'string', 'required' => false, 'example' => 'click=30'], + 'ControlType' => ['description' => '调控类型。', 'type' => 'string', 'required' => false, 'example' => 'Percent'], + 'ControlGranularity' => ['description' => '调控粒度。', 'type' => 'string', 'required' => false, 'example' => 'Global'], + 'ControlLogic' => ['description' => '调控逻辑。', 'type' => 'string', 'required' => false, 'example' => 'Guaranteed'], + 'ItemConditionType' => ['description' => '物品条件类型。', 'type' => 'string', 'required' => false, 'example' => 'Array'], + 'ItemConditionArray' => ['description' => '物品条件，设置数组格式条件。', 'type' => 'string', 'required' => false, 'example' => '[{"field":"status","option":"=","value":"1"}]'], + 'ItemConditionExpress' => ['description' => '物品条件，设置表达式格式条件。', 'type' => 'string', 'required' => false, 'example' => 'status=1'], + 'InstanceId' => ['description' => '实例ID。'."\n", 'type' => 'string', 'required' => false, 'example' => 'pairec-1324***'], + 'TrafficControlTargets' => [ + 'description' => '流量调控目标列表。'."\n", 'type' => 'array', 'items' => [ - 'description' => '时间分割点，单位分钟。', - 'type' => 'integer', - 'format' => 'int64', + 'description' => '流量调控目标详情。', + 'type' => 'object', + 'properties' => [ + 'Name' => ['description' => '流量调控目标名称。', 'type' => 'string', 'required' => false, 'example' => 'target-1'], + 'StartTime' => ['description' => '调控目标开始时间'."\n", 'type' => 'string', 'required' => false, 'example' => '2026-02-10T09:16:03.893+08:00'], + 'EndTime' => ['description' => '结束时间。', 'type' => 'string', 'required' => false, 'example' => '2026-02-06T18:02:57.487556956+08:00'], + 'ItemConditionType' => ['description' => '物品条件类型。', 'type' => 'string', 'required' => false, 'example' => 'Array'], + 'ItemConditionArray' => ['description' => '物品条件，设置数组格式条件'."\n", 'type' => 'string', 'required' => false, 'example' => '[{"field":"status","option":"=","value":"1"}]'], + 'ItemConditionExpress' => ['description' => '物品条件，设置表达式格式条件。', 'type' => 'string', 'required' => false, 'example' => 'age>20'], + 'Event' => ['description' => '调控目标事件。', 'type' => 'string', 'required' => false, 'example' => 'exposure'], + 'Value' => ['description' => '调控目标值。', 'type' => 'number', 'format' => 'float', 'required' => false, 'example' => '30'], + 'StatisPeriod' => ['description' => '统计周期。', 'type' => 'string', 'required' => false, 'example' => '1'], + 'ToleranceValue' => ['description' => '调控目标容错范围。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '10'], + 'NewProductRegulation' => ['description' => '是否是新品召回。', 'type' => 'boolean', 'required' => false, 'example' => 'false'], + 'RecallName' => ['description' => '召回策略名称。', 'type' => 'string', 'required' => false, 'example' => 'hot_recall'], + 'Status' => ['description' => '状态。', 'type' => 'string', 'required' => false, 'example' => 'Enable'], + ], 'required' => false, - 'example' => '30', ], 'required' => false, ], - 'SetValues' => [ - 'description' => '目标值分割点。', + 'ServiceId' => ['description' => '服务ID。', 'type' => 'string', 'required' => false, 'example' => '4'], + 'PreExperimentIds' => ['description' => '预发实验ID列表。', 'type' => 'string', 'required' => false, 'example' => '3,4'], + 'ProdExperimentIds' => ['description' => '生产试验列表。', 'type' => 'string', 'required' => false, 'example' => '1,2'], + 'FlinkResourceId' => ['description' => 'Flink资源ID。', 'type' => 'string', 'required' => false, 'example' => 'resource-xxx'], + 'EffectiveSceneIds' => [ + 'description' => '有效服务ID列表。', 'type' => 'array', - 'items' => [ - 'description' => '目标值分割点的具体值。', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '3', - ], + 'items' => ['description' => '有效服务ID列表。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '4'], 'required' => false, ], - 'SetPoints' => [ - 'description' => '废弃参数。', + 'ServiceIds' => [ + 'description' => '绑定的引擎服务ID列表。', + 'type' => 'array', + 'items' => ['description' => '绑定的引擎服务ID列表。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '3'], + 'required' => false, + ], + 'StatisBehaviorConditionArray' => ['description' => '行为统计数组格式条件。', 'type' => 'string', 'required' => false, 'example' => 'click=exposure'], + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => '6CF1E160-3F36-5E73-A170-C75504F05BBC'], + ], + ], + ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'title' => '更新流量调控任务', + 'description' => '## 请求说明'."\n" + .'- 本API用于更新已存在的流量调控任务。'."\n" + .'- 当`ExecutionTime`设置为`TimeRange`时，必须同时提供`StartTime`和`EndTime`。'."\n" + .'- `TrafficControlTargets`数组中每个元素代表一个具体的流量调控目标，需要确保每个目标的时间范围、条件类型等信息完整且合理。'."\n" + .'- 如果设置了`UserConditionType`或`ItemConditionType`为`Expression`，则相应的表达式字段（如`UserConditionExpress`）不能为空。'."\n" + .'- `ServiceIds`与`EffectiveSceneIds`均为可选参数，但若使用，则需保证提供的ID列表格式正确。'."\n" + .'- 特别注意：在更新过程中，请确保所有必填项均已被正确填写，否则可能导致请求失败。'."\n", + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"6CF1E160-3F36-5E73-A170-C75504F05BBC\\"\\n}","type":"json"}]', + ], + 'UpdateTrafficControlTaskTraffic' => [ + 'path' => '/api/v1/trafficcontroltasks/{TrafficControlTaskId}/action/traffic', + 'methods' => ['post'], + 'schemes' => ['http', 'https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '220415', + 'abilityTreeNodes' => ['FEATURElearnN0NAWV'], + ], + 'parameters' => [ + [ + 'name' => 'TrafficControlTaskId', + 'in' => 'path', + 'schema' => ['description' => '流量调控任务ID。'."\n", 'type' => 'string', 'required' => false, 'example' => '1'], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', + 'schema' => [ + 'description' => '请求Body。', + 'type' => 'object', + 'properties' => [ + 'InstanceId' => ['description' => '实例ID。'."\n", 'type' => 'string', 'required' => false, 'example' => 'learn-pairec-cn-xxx'], + 'Environment' => ['description' => '所属的环境。Daily-日常环境Pre-预发环境Prod-生产环境'."\n", 'type' => 'string', 'required' => false, 'example' => 'Daily'], + 'Traffics' => [ + 'description' => '上报的流量信息列表。', 'type' => 'array', 'items' => [ - 'description' => '废弃参数。', - 'type' => 'integer', - 'format' => 'int64', + 'description' => '上报的流量详情。', + 'type' => 'object', + 'properties' => [ + 'TrafficControlTargetId' => ['description' => '流量调控目标ID。'."\n", 'type' => 'string', 'required' => false, 'example' => '1'], + 'RecordTime' => ['description' => '行为日志中的时间，表示截止当前的日志'."\n", 'type' => 'string', 'required' => false, 'example' => '2024-01-01T02:05:06.111Z'], + 'ItemOrExperimentId' => ['description' => '流量对象是 item 或者是实验item1 或者是 ER_ALL(全局) 或 L1_EG1_E1 格式'."\n", 'type' => 'string', 'required' => false, 'example' => 'item1'], + 'TrafficControlTargetTraffic' => ['description' => '流量调控目标的实际流量'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '100000'], + 'TrafficControlTargetAimTraffic' => ['description' => '流量调控目标的目标流量'."\n", 'type' => 'number', 'format' => 'double', 'required' => false, 'example' => '10.0'], + 'TrafficControlTaskTraffic' => ['description' => '流量调控计划下的整体流量'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1000000'], + ], 'required' => false, - 'example' => '0', ], 'required' => false, ], @@ -18733,6 +16326,11 @@ 'required' => false, ], ], + [ + 'name' => 'new-param-3', + 'in' => 'query', + 'schema' => ['description' => '无效参数，请忽略。', 'type' => 'string', 'required' => false, 'example' => 'null'], + ], ], 'responses' => [ 200 => [ @@ -18741,64 +16339,2272 @@ 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'Id of the request。', - 'type' => 'string', - 'example' => 'F8F613A9-DF1C-551A-88E1-397A3981A785', - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => '请求id。'."\n", 'type' => 'string', 'example' => '728C5E01-ABF6-5AA8-B9FC-B3BA05DECC77'], ], ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '更新流量调控任务流量', + 'summary' => '用于更新指定流量调控任务的流量参数，包括目标流量和实际流量等。', + 'description' => '## 请求说明'."\n" + .'本API允许用户更新特定流量调控任务下的流量配置，包括但不限于流量调控目标ID、记录时间、目标流量及整体流量等信息。请确保提供的`TrafficControlTaskId`有效且属于当前用户权限范围内。此外，`Traffics`数组中的每个对象都必须包含必要的字段以保证请求的成功处理。'."\n", + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"F8F613A9-DF1C-551A-88E1-397A3981A785\\"\\n}","type":"json"}]', - 'title' => '分隔流量调控的目标值', - 'description' => '删除某个引擎配置。', + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"728C5E01-ABF6-5AA8-B9FC-B3BA05DECC77\\"\\n}","type":"json"}]', ], ], 'endpoints' => [ + ['regionId' => 'cn-beijing', 'regionName' => '华北2（北京）', 'areaId' => 'asiaPacific', 'areaName' => '亚太', 'public' => 'pairecservice.cn-beijing.aliyuncs.com', 'endpoint' => 'pairecservice.cn-beijing.aliyuncs.com', 'vpc' => 'pairecservice-vpc.cn-beijing.aliyuncs.com'], + ['regionId' => 'cn-hangzhou', 'regionName' => '华东1（杭州）', 'areaId' => 'asiaPacific', 'areaName' => '亚太', 'public' => 'pairecservice.cn-hangzhou.aliyuncs.com', 'endpoint' => 'pairecservice.cn-hangzhou.aliyuncs.com', 'vpc' => 'pairecservice-vpc.cn-hangzhou.aliyuncs.com'], + ['regionId' => 'cn-shanghai', 'regionName' => '华东2（上海）', 'areaId' => 'asiaPacific', 'areaName' => '亚太', 'public' => 'pairecservice.cn-shanghai.aliyuncs.com', 'endpoint' => 'pairecservice.cn-shanghai.aliyuncs.com', 'vpc' => 'pairecservice-vpc.cn-shanghai.aliyuncs.com'], + ['regionId' => 'cn-shenzhen', 'regionName' => '华南1（深圳）', 'areaId' => 'asiaPacific', 'areaName' => '亚太', 'public' => 'pairecservice.cn-shenzhen.aliyuncs.com', 'endpoint' => 'pairecservice.cn-shenzhen.aliyuncs.com', 'vpc' => 'pairecservice-vpc.cn-shenzhen.aliyuncs.com'], + ], + 'errorCodes' => [], + 'changeSet' => [ [ - 'regionId' => 'cn-beijing', - 'endpoint' => 'pairecservice.cn-beijing.aliyuncs.com', + 'apis' => [ + ['description' => '请求参数发生变更', 'api' => 'CreateFeatureConsistencyCheckJobConfig'], + ['description' => '响应参数发生变更', 'api' => 'GetFeatureConsistencyCheckJobConfig'], + ['description' => '响应参数发生变更', 'api' => 'ListFeatureConsistencyCheckJobConfigs'], + ['description' => '请求参数发生变更', 'api' => 'UpdateFeatureConsistencyCheckJobConfig'], + ], + 'createdAt' => '2024-12-10T06:00:46.000Z', + 'description' => '', ], [ - 'regionId' => 'cn-hangzhou', - 'endpoint' => 'pairecservice.cn-hangzhou.aliyuncs.com', + 'apis' => [ + ['description' => '请求参数发生变更', 'api' => 'CreateFeatureConsistencyCheckJobConfig'], + ['description' => '响应参数发生变更', 'api' => 'GetFeatureConsistencyCheckJobConfig'], + ['description' => '响应参数发生变更', 'api' => 'ListFeatureConsistencyCheckJobConfigs'], + ['description' => '请求参数发生变更', 'api' => 'UpdateFeatureConsistencyCheckJobConfig'], + ], + 'createdAt' => '2024-11-12T09:17:53.000Z', + 'description' => '', ], [ - 'regionId' => 'cn-shanghai', - 'endpoint' => 'pairecservice.cn-shanghai.aliyuncs.com', + 'apis' => [ + ['description' => '响应参数发生变更', 'api' => 'GetInstance'], + ['description' => '响应参数发生变更', 'api' => 'ListInstances'], + ], + 'createdAt' => '2024-08-05T08:37:38.000Z', + 'description' => '', ], [ - 'regionId' => 'cn-shenzhen', - 'endpoint' => 'pairecservice.cn-shenzhen.aliyuncs.com', + 'apis' => [ + ['description' => '请求参数发生变更', 'api' => 'ListExperimentGroups'], + ], + 'createdAt' => '2024-06-25T02:53:02.000Z', + 'description' => '', ], [ - 'regionId' => 'cn-hongkong', - 'endpoint' => 'pairecservice.cn-hongkong.aliyuncs.com', + 'apis' => [ + ['description' => '请求参数发生变更', 'api' => 'CreateExperimentGroup'], + ['description' => '响应参数发生变更', 'api' => 'GetExperimentGroup'], + ['description' => '响应参数发生变更', 'api' => 'GetLayer'], + ['description' => '请求参数发生变更、响应参数发生变更', 'api' => 'ListExperimentGroups'], + ['description' => '响应参数发生变更', 'api' => 'ListLayers'], + ['description' => '请求参数发生变更', 'api' => 'UpdateExperimentGroup'], + ], + 'createdAt' => '2024-03-20T06:05:34.000Z', + 'description' => '', ], [ - 'regionId' => 'ap-southeast-1', - 'endpoint' => 'pairecservice.ap-southeast-1.aliyuncs.com', + 'apis' => [ + ['description' => '响应参数发生变更', 'api' => 'GetTableMeta'], + ], + 'createdAt' => '2024-02-22T08:16:07.000Z', + 'description' => '', ], [ - 'regionId' => 'us-east-1', - 'endpoint' => 'pairecservice.us-east-1.aliyuncs.com', + 'apis' => [ + ['description' => '请求参数发生变更', 'api' => 'CheckInstanceResources'], + ['description' => '请求参数发生变更', 'api' => 'CreateABMetric'], + ['description' => '请求参数发生变更', 'api' => 'CreateABMetricGroup'], + ['description' => '请求参数发生变更', 'api' => 'CreateCalculationJobs'], + ['description' => '请求参数发生变更', 'api' => 'CreateFeatureConsistencyCheckJob'], + ['description' => '请求参数发生变更', 'api' => 'CreateFeatureConsistencyCheckJobConfig'], + ['description' => '请求参数发生变更', 'api' => 'CreateInstanceResource'], + ['description' => '请求参数发生变更', 'api' => 'CreateTableMeta'], + ['description' => '请求参数发生变更', 'api' => 'DeleteABMetric'], + ['description' => '请求参数发生变更', 'api' => 'DeleteABMetricGroup'], + ], + 'createdAt' => '2024-02-22T03:35:59.000Z', + 'description' => '', ], [ - 'regionId' => 'us-west-1', - 'endpoint' => 'pairecservice.us-west-1.aliyuncs.com', + 'apis' => [ + ['description' => '请求参数发生变更', 'api' => 'CloneExperiment'], + ], + 'createdAt' => '2023-09-14T01:51:03.000Z', + 'description' => '', ], - [ - 'regionId' => 'ap-southeast-5', - 'endpoint' => 'pairecservice.ap-southeast-5.aliyuncs.com', + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '-1', 'countWindow' => 1, 'regionId' => '*'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListInstances'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetInstance'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'BackflowFeatureConsistencyCheckJobData'], + ['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'SyncFeatureConsistencyCheckJobReplayLog'], ], - [ - 'regionId' => 'eu-central-1', - 'endpoint' => 'pairecservice.eu-central-1.aliyuncs.com', + ], + 'ram' => [ + 'productCode' => 'PAIRecService', + 'productName' => '人工智能平台 PAI', + 'ramCodes' => ['pairec'], + 'ramLevel' => '操作级', + 'ramConditions' => [], + 'ramActions' => [ + [ + 'apiName' => 'QueryDataDiagnosisStatistics', + 'description' => '数据诊断统计查询', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'pairec:QueryDataDiagnosisStatistics', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIRecService', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'UpdateExperimentGroup', + 'description' => '更新实验组', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'pairec:UpdateExperimentGroup', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIRecService', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'ListABMetricGroups', + 'description' => '获取指标组列表', + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'pairec:ListABMetricGroups', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIRecService', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'CreateDataDiagnosisJobs', + 'description' => '创建数据诊断任务', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'pairec:CreateDataDiagnosisJobs', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIRecService', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'UpdateTrafficControlTask', + 'description' => '更新流量调控任务', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'pairec:UpdateTrafficControlTask', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIRecService', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'StartTrafficControlTarget', + 'description' => '开启流量调控任务', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'pairec:StartTrafficControlTarget', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIRecService', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'CreateRecallManagementConfig', + 'description' => '创建召回管理配置', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'pairec:CreateRecallManagementConfig', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIRecService', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'CreateInstanceResource', + 'description' => '创建配置资源', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'pairec:CreateInstanceResource', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIRecService', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'CreateCrowd', + 'description' => '创建人群', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'pairec:CreateCrowd', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIRecService', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'ListTrafficControlTasks', + 'description' => '获取流量调控任务列表', + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'pairec:ListTrafficControlTasks', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIRecService', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'GetRecallManagementServiceVersion', + 'description' => '获取召回管理服务版本详情', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'pairec:GetRecallManagementServiceVersion', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIRecService', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'OfflineRecallManagementService', + 'description' => '下线召回管理服务', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'pairec:OfflineRecallManagementService', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIRecService', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'UpdateLayer', + 'description' => '更新层', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'pairec:UpdateLayer', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIRecService', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'GetABMetric', + 'description' => '获取AB指标详细信息', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'pairec:GetABMetric', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIRecService', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'DeleteExperiment', + 'description' => '删除实验', + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'pairec:DeleteExperiment', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIRecService', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'CreateScene', + 'description' => '创建场景', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'pairec:CreateScene', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIRecService', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'OnlineExperimentGroup', + 'description' => '上线实验组', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'pairec:OnlineExperimentGroup', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIRecService', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'GetTableMeta', + 'description' => '获取数据表', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'pairec:GetTableMeta', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIRecService', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'CloneFeatureConsistencyCheckJobConfig', + 'description' => '克隆特征一致性检查任务配置', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'pairec:CloneFeatureConsistencyCheckJobConfig', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIRecService', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'DeleteLaboratory', + 'description' => '删除实验室', + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'pairec:DeleteLaboratory', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIRecService', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'CreateDataDiagnosis', + 'description' => '创建数据诊断任务', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'pairec:CreateDataDiagnosis', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIRecService', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'GetInstanceResource', + 'description' => '获取资源详细信息', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'pairec:GetInstanceResource', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIRecService', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'QueryRecallManagementTableRecords', + 'description' => '查询召回管理表数据', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'pairec:QueryRecallManagementTableRecords', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIRecService', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'ListInstanceResourceSchemas', + 'description' => '获取实例资源下的Schema', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'pairec:ListInstanceResourceSchemas', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIRecService', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'GetLaboratory', + 'description' => '获取实验室详细信息', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'pairec:GetLaboratory', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIRecService', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'SyncFeatureConsistencyCheckJobReplayLog', + 'description' => '同步特征一致性检查任务重放日志', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'pairec:SyncFeatureConsistencyCheckJobReplayLog', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIRecService', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'ListDataDiagnosisReports', + 'description' => '获取数据诊断报告', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'pairec:ListDataDiagnosisReports', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIRecService', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'CreateRecallManagementTable', + 'description' => '创建召回管理表', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'pairec:CreateRecallManagementTable', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIRecService', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'CreateExperiment', + 'description' => '创建实验', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'pairec:CreateExperiment', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIRecService', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'DeleteDataDiagnosis', + 'description' => '删除数据诊断', + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'pairec:DeleteDataDiagnosis', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIRecService', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'DeleteRecallManagementService', + 'description' => '删除召回管理服务', + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'pairec:DeleteRecallManagementService', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIRecService', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'DeleteInstanceResource', + 'description' => '删除资源配置', + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'pairec:DeleteInstanceResource', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIRecService', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'CreateFeatureConsistencyCheckJobConfig', + 'description' => '创建特征一致性检查任务配置', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'pairec:CreateFeatureConsistencyCheckJobConfig', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIRecService', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'CloneEngineConfig', + 'description' => '克隆引擎配置', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'pairec:CloneEngineConfig', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIRecService', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'CloneLaboratory', + 'description' => '克隆实验室', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'pairec:CloneLaboratory', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIRecService', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'CreateExperimentGroup', + 'description' => '创建实验组', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'pairec:CreateExperimentGroup', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIRecService', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'UpdateFeatureConsistencyCheckJobConfig', + 'description' => '更新特征一致性检查任务配置', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'pairec:UpdateFeatureConsistencyCheckJobConfig', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIRecService', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'OfflineExperimentGroup', + 'description' => '下线实验组', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'pairec:OfflineExperimentGroup', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIRecService', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'UpdateRecallManagementService', + 'description' => '更新召回管理服务', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'pairec:UpdateRecallManagementService', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIRecService', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'CloneTrafficControlTask', + 'description' => '克隆流量调控任务', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'pairec:CloneTrafficControlTask', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIRecService', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'ListRecallManagementTableVersions', + 'description' => '获取召回管理表版本列表', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'pairec:ListRecallManagementTableVersions', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIRecService', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'PublishRecallManagementTable', + 'description' => '同步召回管理表', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'pairec:PublishRecallManagementTable', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIRecService', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'DeleteTrafficControlTask', + 'description' => '删除流量调控任务', + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'pairec:DeleteTrafficControlTask', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIRecService', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'CreateTrafficControlTarget', + 'description' => '创建流量调控目标', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'pairec:CreateTrafficControlTarget', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIRecService', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'DeleteExperimentGroup', + 'description' => '删除实验组', + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'pairec:DeleteExperimentGroup', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIRecService', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'UpdateExperiment', + 'description' => '更新实验', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'pairec:UpdateExperiment', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIRecService', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'CreateFeatureConsistencyCheckJob', + 'description' => '创建特征一致性检查任务', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'pairec:CreateFeatureConsistencyCheckJob', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIRecService', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'DeleteSubCrowd', + 'description' => '删除子人群', + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'pairec:DeleteSubCrowd', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIRecService', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'ListRecallManagementServices', + 'description' => '获取召回管理服务列表', + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'pairec:ListRecallManagementServices', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIRecService', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'UpdateDataDiagnosis', + 'description' => '更新数据诊断信息', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'pairec:UpdateDataDiagnosis', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIRecService', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'DeleteParam', + 'description' => '删除参数', + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'pairec:DeleteParam', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIRecService', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'ChatConversation', + 'description' => '发送对话消息', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'pairec:ChatConversation', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIRecService', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'ReportABMetricGroup', + 'description' => '查询指标组报表', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'pairec:ReportABMetricGroup', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIRecService', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'GetRecallManagementTable', + 'description' => '获取召回管理数据表详情', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'pairec:GetRecallManagementTable', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIRecService', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'DeleteRecallManagementServiceVersion', + 'description' => '删除召回管理服务版本', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'pairec:DeleteRecallManagementServiceVersion', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIRecService', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'GetTrafficControlTask', + 'description' => '获取流量调控任务详情', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'pairec:GetTrafficControlTask', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIRecService', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'ListExperimentGroups', + 'description' => '获取实验组列表', + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'pairec:ListExperimentGroups', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIRecService', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'OnlineExperiment', + 'description' => '上线实验', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'pairec:OnlineExperiment', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIRecService', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'ListSubCrowds', + 'description' => '获取子人群列表', + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'pairec:ListSubCrowds', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIRecService', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'UpdateABMetricGroup', + 'description' => '更新指标组', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'pairec:UpdateABMetricGroup', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIRecService', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'CreateParam', + 'description' => '创建参数', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'pairec:CreateParam', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIRecService', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'OnlineLaboratory', + 'description' => '上线实验室', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'pairec:OnlineLaboratory', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIRecService', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'UpdateEngineConfig', + 'description' => '更新引擎配置', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'pairec:UpdateEngineConfig', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIRecService', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'ListRecallManagementJobs', + 'description' => '获取召回管理任务列表', + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'pairec:ListRecallManagementJobs', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIRecService', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'ListInstances', + 'description' => '获取实例列表', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'pairec:ListInstances', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIRecService', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'GetRecallManagementService', + 'description' => '获取召回管理服务详情', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'pairec:GetRecallManagementService', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIRecService', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'OnlineRecallManagementService', + 'description' => '上线召回管理服务', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'pairec:OnlineRecallManagementService', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIRecService', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'CreateABMetricGroup', + 'description' => '创建指标组', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'pairec:CreateABMetricGroup', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIRecService', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'CreateABMetric', + 'description' => '创建AB指标', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'pairec:CreateABMetric', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIRecService', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'GetTrafficControlTarget', + 'description' => '获取流量调控目标详情', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'pairec:GetTrafficControlTarget', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIRecService', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'DeleteABMetricGroup', + 'description' => '删除指标组', + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'pairec:DeleteABMetricGroup', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIRecService', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'DeleteTableMeta', + 'description' => '删除数据表', + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'pairec:DeleteTableMeta', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIRecService', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'StopTrafficControlTask', + 'description' => '停止流量调控任务', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'pairec:StopTrafficControlTask', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIRecService', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'GetExperiment', + 'description' => '获取实验详细信息', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'pairec:GetExperiment', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIRecService', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'ListEngineConfigs', + 'description' => '获取引擎配置列表', + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'pairec:ListEngineConfigs', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIRecService', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'CreateLayer', + 'description' => '创建层', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'pairec:CreateLayer', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIRecService', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'DeleteABMetric', + 'description' => '删除AB指标', + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'pairec:DeleteABMetric', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIRecService', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'UpdateLaboratory', + 'description' => '更新实验室', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'pairec:UpdateLaboratory', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIRecService', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'GetTrafficControlTaskTraffic', + 'description' => '获取流量调控任务详情', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'pairec:GetTrafficControlTaskTraffic', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIRecService', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'QueryTrafficControlTargetItemReportDetail', + 'description' => '查询流量调控目标单品详情', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'pairec:QueryTrafficControlTargetItemReportDetail', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIRecService', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'ReleaseTrafficControlTask', + 'description' => '发布流量调控任务', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'pairec:ReleaseTrafficControlTask', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIRecService', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'UpdateInstanceResource', + 'description' => '更新资源信息', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'pairec:UpdateInstanceResource', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIRecService', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'ChangeRecallManagementServiceVersion', + 'description' => '更改召回管理服务版本', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'pairec:ChangeRecallManagementServiceVersion', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIRecService', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'UpdateABMetric', + 'description' => '更新AB指标', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'pairec:UpdateABMetric', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIRecService', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'DeleteScene', + 'description' => '删除场景', + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'pairec:DeleteScene', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIRecService', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'GetLayer', + 'description' => '获取层详细信息', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'pairec:GetLayer', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIRecService', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'GetInstance', + 'description' => '获取实例详细信息', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'pairec:GetInstance', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIRecService', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'CreateRecallManagementServiceVersion', + 'description' => '创建召回管理服务版本', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'pairec:CreateRecallManagementServiceVersion', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIRecService', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'GetRecallManagementServiceVersionConfig', + 'description' => '获取召回管理服务版本配置', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'pairec:GetRecallManagementServiceVersionConfig', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIRecService', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'QueryTrafficControlTaskDeployResult', + 'description' => '查询流量调控任务部署结果', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'pairec:QueryTrafficControlTaskDeployResult', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIRecService', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'UpdateTableMeta', + 'description' => '更新数据表', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'pairec:UpdateTableMeta', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIRecService', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'QueryTrafficControlTaskItemReport', + 'description' => '查询流量调控任务单品报表', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'pairec:QueryTrafficControlTaskItemReport', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIRecService', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'ListInstanceResources', + 'description' => '获取资源列表', + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'pairec:ListInstanceResources', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIRecService', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'ListScenes', + 'description' => '获取场景列表', + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'pairec:ListScenes', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIRecService', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'DeleteLayer', + 'description' => '删除层', + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'pairec:DeleteLayer', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIRecService', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'DeleteTrafficControlTarget', + 'description' => '删除流量调控目标', + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'pairec:DeleteTrafficControlTarget', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIRecService', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'UpdateRecallManagementConfig', + 'description' => '更新召回管理配置', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'pairec:UpdateRecallManagementConfig', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIRecService', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'GetFeatureConsistencyCheckJob', + 'description' => '获取特征一致性检查任务详情', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'pairec:GetFeatureConsistencyCheckJob', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIRecService', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'ListFeatureConsistencyCheckJobs', + 'description' => '获取特征一致性检查任务列表', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'pairec:ListFeatureConsistencyCheckJobs', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIRecService', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'ListInstanceResourceTables', + 'description' => '获取实例资源下数据表列表', + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'pairec:ListInstanceResourceTables', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIRecService', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'GetDataDiagnosis', + 'description' => '获取数据诊断详情', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'pairec:GetDataDiagnosis', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIRecService', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'DeleteCrowd', + 'description' => '删除人群', + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'pairec:DeleteCrowd', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIRecService', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'ListCrowdUsers', + 'description' => '获取人群下用户列表', + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'pairec:ListCrowdUsers', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIRecService', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'CreateTableMeta', + 'description' => '创建数据表', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'pairec:CreateTableMeta', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIRecService', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'UpdateTrafficControlTarget', + 'description' => '更新流量调控目标', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'pairec:UpdateTrafficControlTarget', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIRecService', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'ExportRecallManagementTable', + 'description' => '导出召回管理数据表', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'pairec:ExportRecallManagementTable', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIRecService', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'ListParams', + 'description' => '获取参数列表', + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'pairec:ListParams', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIRecService', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'OfflineLaboratory', + 'description' => '下线实验室', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'pairec:OfflineLaboratory', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIRecService', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'CheckTrafficControlTaskExpression', + 'description' => '检查流量调控任务表达式', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'pairec:CheckTrafficControlTaskExpression', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIRecService', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'BackflowFeatureConsistencyCheckJobData', + 'description' => '特征一致性检查数据回流', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'pairec:BackflowFeatureConsistencyCheckJobData', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIRecService', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'ListFeatureConsistencyCheckJobFeatureReports', + 'description' => '获取特征一致性检查任务的特征报表', + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'pairec:ListFeatureConsistencyCheckJobFeatureReports', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIRecService', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'ListLayers', + 'description' => '获取层列表', + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'pairec:ListLayers', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIRecService', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'CreateTrafficControlTask', + 'description' => '创建流量调控任务', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'pairec:CreateTrafficControlTask', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIRecService', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'UpdateParam', + 'description' => '更新参数', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'pairec:UpdateParam', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIRecService', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'ListRecallManagementTables', + 'description' => '获取召回管理表列表', + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'pairec:ListRecallManagementTables', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIRecService', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'UpdateCrowd', + 'description' => '更新人群', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'pairec:UpdateCrowd', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIRecService', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'ListABMetrics', + 'description' => '获取AB指标列表', + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'pairec:ListABMetrics', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIRecService', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'ApplyEngineConfig', + 'description' => '发布引擎配置', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'pairec:ApplyEngineConfig', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIRecService', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'TerminateFeatureConsistencyCheckJob', + 'description' => '取消指定特征一致性检查正在运行中的任务', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'pairec:TerminateFeatureConsistencyCheckJob', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIRecService', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'GetSubCrowd', + 'description' => '获取子人群详细信息', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'pairec:GetSubCrowd', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIRecService', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'GetScene', + 'description' => '获取场景详细信息', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'pairec:GetScene', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIRecService', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'ListTableMetas', + 'description' => '获取数据表列表', + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'pairec:ListTableMetas', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIRecService', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'ListDataDiagnosisJobs', + 'description' => '获取数据诊断任务列表', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'pairec:ListDataDiagnosisJobs', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIRecService', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'GetService', + 'description' => '获取服务详情', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'pairec:GetService', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIRecService', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'GetExperimentGroup', + 'description' => '获取实验组详细信息', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'pairec:GetExperimentGroup', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIRecService', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'CheckInstanceResources', + 'description' => '检查资源状态', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'pairec:CheckInstanceResources', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIRecService', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'ListCalculationJobs', + 'description' => '获取计算任务列表', + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'pairec:ListCalculationJobs', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIRecService', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'CreateSubCrowd', + 'description' => '创建子人群', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'pairec:CreateSubCrowd', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIRecService', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'DeleteRecallManagementServiceVersionConfig', + 'description' => '删除召回管理服务版本配置', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'pairec:DeleteRecallManagementServiceVersionConfig', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIRecService', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'PushAllExperiment', + 'description' => '推全实验', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'pairec:PushAllExperiment', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIRecService', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'CreateRecallManagementService', + 'description' => '创建召回管理服务', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'pairec:CreateRecallManagementService', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIRecService', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'OfflineExperiment', + 'description' => '下线实验', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'pairec:OfflineExperiment', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIRecService', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'GetRecallManagementJob', + 'description' => '获取召回管理任务详情', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'pairec:GetRecallManagementJob', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIRecService', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'CloneExperimentGroup', + 'description' => '克隆实验组', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'pairec:CloneExperimentGroup', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIRecService', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'CreateRecallManagementServiceVersionConfig', + 'description' => '创建召回管理服务版本配置', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'pairec:CreateRecallManagementServiceVersionConfig', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIRecService', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'GetRecallManagementConfig', + 'description' => '获取召回管理配置', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'pairec:GetRecallManagementConfig', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIRecService', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'GenerateAlgorithmCustomizationScript', + 'description' => '部署算法定制', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'pairec:GenerateAlgorithmCustomizationScript', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIRecService', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'ListFeatureConsistencyCheckJobConfigs', + 'description' => '获取特征一致性检查任务配置列表', + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'pairec:ListFeatureConsistencyCheckJobConfigs', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIRecService', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'UpdateScene', + 'description' => '更新场景', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'pairec:UpdateScene', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIRecService', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'DeleteEngineConfig', + 'description' => '删除引擎配置', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'pairec:DeleteEngineConfig', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIRecService', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'CreateLaboratory', + 'description' => '创建实验室', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'pairec:CreateLaboratory', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIRecService', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'CreateEngineConfig', + 'description' => '创建引擎配置', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'pairec:CreateEngineConfig', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIRecService', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'ListTrafficControlTargetTrafficHistory', + 'description' => '获取流量调控任务历史', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'pairec:ListTrafficControlTargetTrafficHistory', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIRecService', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'GenerateTrafficControlTaskCode', + 'description' => '生成流量调控任务代码', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'pairec:GenerateTrafficControlTaskCode', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIRecService', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'DeployTrafficControlTaskCode', + 'description' => '部署流量调控任务代码', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'pairec:DeployTrafficControlTaskCode', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIRecService', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'UpdateRecallManagementServiceVersionConfig', + 'description' => '更新召回管理服务版本配置', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'pairec:UpdateRecallManagementServiceVersionConfig', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIRecService', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'GetCalculationJob', + 'description' => '获取计算任务', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'pairec:GetCalculationJob', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIRecService', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'StartTrafficControlTask', + 'description' => '开启流量调控任务', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'pairec:StartTrafficControlTask', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIRecService', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'ListLaboratories', + 'description' => '获取实验室列表', + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'pairec:ListLaboratories', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIRecService', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'ListFeatureConsistencyCheckJobScoreReports', + 'description' => '获取特征一致性检查任务分数报表', + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'pairec:ListFeatureConsistencyCheckJobScoreReports', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIRecService', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'DeleteRecallManagementTable', + 'description' => '删除召回管理数据表', + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'pairec:DeleteRecallManagementTable', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIRecService', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'ListCrowds', + 'description' => '获取人群列表', + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'pairec:ListCrowds', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIRecService', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'GetInstanceResourceTable', + 'description' => '获取资源下表信息', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'pairec:GetInstanceResourceTable', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIRecService', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'UpdateTrafficControlTaskTraffic', + 'description' => '更新流量调控任务流量', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'pairec:UpdateTrafficControlTaskTraffic', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIRecService', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'UpdateRecallManagementTable', + 'description' => '更新召回管理数据表', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'pairec:UpdateRecallManagementTable', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIRecService', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'ListRecallManagementServiceVersions', + 'description' => '召回管理服务版本列表', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'pairec:ListRecallManagementServiceVersions', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIRecService', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'GetFeatureConsistencyCheckJobConfig', + 'description' => '获取特征一致性检查任务配置详情', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'pairec:GetFeatureConsistencyCheckJobConfig', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIRecService', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'StopTrafficControlTarget', + 'description' => '停止流量调控目标', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'pairec:StopTrafficControlTarget', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIRecService', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'SplitTrafficControlTarget', + 'description' => '分隔流量调控的目标值', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'pairec:SplitTrafficControlTarget', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIRecService', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'CloneExperiment', + 'description' => '克隆实验', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'pairec:CloneExperiment', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIRecService', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'GetABMetricGroup', + 'description' => '获取指标组详细信息', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'pairec:GetABMetricGroup', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIRecService', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'CreateCalculationJobs', + 'description' => '创建计算任务', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'pairec:CreateCalculationJobs', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIRecService', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'ListDataDiagnoses', + 'description' => '获取数据诊断列表', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'pairec:ListDataDiagnoses', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIRecService', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'ListExperiments', + 'description' => '获取实验列表', + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'pairec:ListExperiments', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIRecService', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'GetEngineConfig', + 'description' => '获取引擎配置详情', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'pairec:GetEngineConfig', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIRecService', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], ], + 'resourceTypes' => [], ], ]; |