From 1c7f908ce09f98fdcbf79ed2a8ae21be60eaa634 Mon Sep 17 00:00:00 2001 From: Zhineng Li Date: Sun, 12 Jul 2026 17:11:17 +0800 Subject: update APIs 20260712 --- data/en_us/opensearch/2017-12-25/api-docs.php | 32593 +++++++++++------------- 1 file changed, 14569 insertions(+), 18024 deletions(-) (limited to 'data/en_us/opensearch/2017-12-25') diff --git a/data/en_us/opensearch/2017-12-25/api-docs.php b/data/en_us/opensearch/2017-12-25/api-docs.php index c947db9..5fb165d 100644 --- a/data/en_us/opensearch/2017-12-25/api-docs.php +++ b/data/en_us/opensearch/2017-12-25/api-docs.php @@ -1,523 +1,478 @@ '1.0', - 'info' => [ - 'style' => 'ROA', - 'product' => 'OpenSearch', - 'version' => '2017-12-25', - ], + 'info' => ['style' => 'ROA', 'product' => 'OpenSearch', 'version' => '2017-12-25'], 'directories' => [ [ - 'id' => 170735, - 'title' => 'Application instance', - 'type' => 'directory', 'children' => [ [ - 'id' => 170736, - 'title' => 'Application Management', + 'children' => ['DescribeAppGroup', 'RenewAppGroup', 'CreateAppGroup', 'ModifyAppGroup', 'ModifyAppGroupQuota', 'UpdateAppGroupDeleteProtection', 'RemoveAppGroup', 'ListAppGroups'], 'type' => 'directory', - 'children' => [ - 'RenewAppGroup', - 'CreateAppGroup', - 'ModifyAppGroup', - 'ModifyAppGroupQuota', - 'RemoveAppGroup', - 'ListAppGroups', - ], + 'title' => 'Application management', ], [ - 'id' => 170744, - 'title' => 'Application Version', + 'children' => ['CreateApp', 'RemoveApp', 'DescribeApps', 'DescribeApp'], 'type' => 'directory', - 'children' => [ - 'CreateApp', - 'RemoveApp', - 'DescribeApps', - 'DescribeApp', - 'DescribeAppStatistics', - ], + 'title' => 'Application versions', ], ], + 'type' => 'directory', + 'title' => 'Application instances', ], [ - 'id' => 170894, - 'title' => 'Instance surrounding', - 'type' => 'directory', 'children' => [ [ - 'id' => 170895, - 'title' => 'Custom analyzer', + 'children' => ['ListUserAnalyzers', 'CreateUserAnalyzer', 'DescribeUserAnalyzer', 'ListUserAnalyzerEntries', 'PushUserAnalyzerEntries'], 'type' => 'directory', - 'children' => [ - 'ListUserAnalyzers', - 'CreateUserAnalyzer', - 'DescribeUserAnalyzer', - 'RemoveUserAnalyzer', - 'ListUserAnalyzerEntries', - 'PushUserAnalyzerEntries', - ], + 'title' => 'Custom analyzers', ], [ - 'id' => 170905, - 'title' => 'ABTest', - 'type' => 'directory', 'children' => [ [ - 'id' => 170906, - 'title' => 'Experimental scene', + 'children' => ['CreateABTestScene', 'DescribeABTestScene', 'UpdateABTestScene', 'DeleteABTestScene'], 'type' => 'directory', - 'children' => [ - 'ListABTestScenes', - 'CreateABTestScene', - 'DescribeABTestScene', - 'UpdateABTestScene', - 'DeleteABTestScene', - ], + 'title' => 'Experiment scenarios', ], [ - 'id' => 170976, - 'title' => 'The experimental group', + 'children' => ['ListABTestGroups', 'CreateABTestGroup', 'DeleteABTestGroup', 'DescribeABTestGroup', 'UpdateABTestGroup'], 'type' => 'directory', - 'children' => [ - 'ListABTestGroups', - 'CreateABTestGroup', - 'DeleteABTestGroup', - 'DescribeABTestGroup', - 'UpdateABTestGroup', - ], + 'title' => 'Experiment groups', ], [ - 'id' => 170977, - 'title' => 'Experiment', + 'children' => ['CreateABTestExperiment', 'DescribeABTestExperiment', 'UpdateABTestExperiment', 'DeleteABTestExperiment'], 'type' => 'directory', - 'children' => [ - 'ListABTestExperiments', - 'CreateABTestExperiment', - 'DescribeABTestExperiment', - 'UpdateABTestExperiment', - 'DeleteABTestExperiment', - ], + 'title' => 'Experiments', ], [ - 'id' => 170978, - 'title' => 'Whitelist', + 'children' => ['ListABTestFixedFlowDividers', 'UpdateABTestFixedFlowDividers'], 'type' => 'directory', - 'children' => [ - 'ListABTestFixedFlowDividers', - 'UpdateABTestFixedFlowDividers', - ], + 'title' => 'Whitelists', ], ], + 'type' => 'directory', + 'title' => 'ABTest', ], [ - 'id' => 170979, - 'title' => 'The crude row expression', + 'children' => ['CreateFirstRank', 'DescribeFirstRank', 'RemoveFirstRank', 'ModifyFirstRank'], 'type' => 'directory', - 'children' => [ - 'ListFirstRanks', - 'CreateFirstRank', - 'DescribeFirstRank', - 'RemoveFirstRank', - 'ModifyFirstRank', - ], + 'title' => 'Rough sort expressions', ], [ - 'id' => 170980, - 'title' => 'Fine row expression', + 'children' => ['ListSecondRanks', 'CreateSecondRank', 'DescribeSecondRank', 'ModifySecondRank', 'RemoveSecondRank'], 'type' => 'directory', - 'children' => [ - 'ListSecondRanks', - 'CreateSecondRank', - 'DescribeSecondRank', - 'ModifySecondRank', - 'RemoveSecondRank', - ], + 'title' => 'Fine sort expressions', ], [ - 'id' => 170981, - 'title' => 'Query analyzer', + 'children' => ['ListQueryProcessors', 'ModifyQueryProcessor', 'RemoveQueryProcessor', 'DescribeQueryProcessor', 'ListQueryProcessorNers', 'ListQueryProcessorAnalyzerResults'], 'type' => 'directory', - 'children' => [ - 'ListQueryProcessors', - 'CreateQueryProcessor', - 'ModifyQueryProcessor', - 'RemoveQueryProcessor', - 'DescribeQueryProcessor', - 'ListQueryProcessorNers', - 'ListQueryProcessorAnalyzerResults', - ], + 'title' => 'Query analyzers', ], [ - 'id' => 170982, - 'title' => 'Intervention Dictionary', + 'children' => ['ListInterventionDictionaries', 'CreateInterventionDictionary', 'DescribeInterventionDictionary', 'RemoveInterventionDictionary', 'ListInterventionDictionaryEntries', 'PushInterventionDictionaryEntries', 'ListInterventionDictionaryRelatedEntities', 'ListInterventionDictionaryNerResults'], 'type' => 'directory', - 'children' => [ - 'ListInterventionDictionaries', - 'CreateInterventionDictionary', - 'DescribeInterventionDictionary', - 'RemoveInterventionDictionary', - 'ListInterventionDictionaryEntries', - 'PushInterventionDictionaryEntries', - 'ListInterventionDictionaryRelatedEntities', - 'ListInterventionDictionaryNerResults', - ], + 'title' => 'Intervention dictionaries', ], [ - 'id' => 170983, - 'title' => 'The Master', + 'children' => ['EnableSlowQuery', 'DisableSlowQuery', 'DescribeSlowQueryStatus', 'StartSlowQueryAnalyzer', 'ListSlowQueryQueries', 'ListSlowQueryCategories'], 'type' => 'directory', - 'children' => [ - 'EnableSlowQuery', - 'DisableSlowQuery', - 'DescribeSlowQueryStatus', - 'StartSlowQueryAnalyzer', - 'ListSlowQueryQueries', - 'ListSlowQueryCategories', - ], + 'title' => 'Optimization master', ], [ - 'id' => 170984, - 'title' => 'Quota approval', + 'children' => ['ListQuotaReviewTasks'], 'type' => 'directory', - 'children' => [ - 'ListQuotaReviewTasks', - ], + 'title' => 'Quota approval', ], [ - 'id' => 170985, - 'title' => 'Scheduled Tasks', + 'children' => ['ListScheduledTasks', 'CreateScheduledTask', 'DescribeScheduledTask', 'ModifyScheduledTask', 'RemoveScheduledTask'], 'type' => 'directory', - 'children' => [ - 'ListScheduledTasks', - 'CreateScheduledTask', - 'DescribeScheduledTask', - 'ModifyScheduledTask', - 'RemoveScheduledTask', - ], + 'title' => 'Scheduled tasks', ], [ - 'id' => 170986, - 'title' => 'Search Strategy', + 'children' => ['ListSortExpressions'], 'type' => 'directory', - 'children' => [ - 'ListSortExpressions', - ], + 'title' => 'Search policies', ], [ - 'id' => 170987, - 'title' => 'ElasticSearch Engine instance', + 'children' => ['UnbindEsInstance', 'BindEsInstance', 'BindESUserAnalyzer', 'UnbindESUserAnalyzer'], 'type' => 'directory', - 'children' => [ - 'UnbindEsInstance', - 'BindEsInstance', - 'BindESUserAnalyzer', - 'UnbindESUserAnalyzer', - ], + 'title' => 'Elasticsearch engine instances', ], [ - 'id' => 170988, - 'title' => 'The current process flow', + 'children' => ['ListProceedings'], 'type' => 'directory', - 'children' => [ - 'ListProceedings', - ], + 'title' => 'Current processing flows', ], [ - 'id' => 170989, - 'title' => 'Statistics', + 'children' => ['ListStatisticLogs', 'ListStatisticReport'], 'type' => 'directory', - 'children' => [ - 'ListStatisticLogs', - 'ListStatisticReport', - ], + 'title' => 'Statistics', ], [ - 'id' => 175840, - 'title' => 'cava script', + 'children' => ['ListSortScripts', 'UpdateSortScript', 'ReleaseSortScript', 'GetSortScriptFile', 'GetSortScript', 'GetScriptFileNames', 'DeleteSortScriptFile', 'DeleteSortScript', 'CreateSortScript', 'CompileSortScript'], 'type' => 'directory', - 'children' => [ - 'UpdateSortScript', - 'SaveSortScriptFile', - 'ReleaseSortScript', - 'GetSortScriptFile', - 'GetSortScript', - 'GetScriptFileNames', - 'DeleteSortScriptFile', - 'DeleteSortScript', - 'CreateSortScript', - 'CompileSortScript', - ], + 'title' => 'Cava scripts', ], [ - 'id' => 175844, - 'title' => 'Query the throttling policies', + 'children' => ['UpdateSearchStrategy', 'RemoveSearchStrategy', 'ListSearchStrategies', 'GetSearchStrategy', 'CreateSearchStrategy'], 'type' => 'directory', - 'children' => [ - 'UpdateSearchStrategy', - 'RemoveSearchStrategy', - 'ListSearchStrategies', - 'GetSearchStrategy', - 'CreateSearchStrategy', - ], + 'title' => 'Query policies', ], ], + 'type' => 'directory', + 'title' => 'Instance peripherals', ], [ - 'id' => 170990, - 'title' => 'Version surrounding', - 'type' => 'directory', 'children' => [ [ - 'id' => 170991, - 'title' => 'By default fields', + 'children' => ['UpdateFetchFields'], 'type' => 'directory', - 'children' => [ - 'UpdateFetchFields', - ], + 'title' => 'Default display fields', ], [ - 'id' => 170992, - 'title' => 'A summary of search results and', + 'children' => ['UpdateSummaries'], 'type' => 'directory', - 'children' => [ - 'UpdateSummaries', - ], + 'title' => 'Search result summaries', ], ], + 'type' => 'directory', + 'title' => 'Version peripherals', ], [ - 'id' => 170993, - 'title' => 'Algorithm surrounding', + 'children' => ['CreateFunctionResource', 'GetFunctionCurrentVersion', 'GetFunctionVersion', 'GetFunctionDefaultInstance', 'UpdateFunctionDefaultInstance', 'ListFunctionTasks', 'GetFunctionTask', 'DeleteFunctionTask', 'CreateFunctionTask', 'ListFunctionInstances', 'GetFunctionInstance', 'DeleteFunctionInstance', 'UpdateFunctionInstance', 'GetFunctionResource', 'ListFunctionResources', 'DeleteFunctionResource', 'UpdateFunctionResource', 'CreateFunctionInstance'], 'type' => 'directory', - 'children' => [ - 'CreateFunctionResource', - 'GetFunctionCurrentVersion', - 'GetFunctionVersion', - 'GetFunctionDefaultInstance', - 'UpdateFunctionDefaultInstance', - 'ListFunctionTasks', - 'GetFunctionTask', - 'DeleteFunctionTask', - 'CreateFunctionTask', - 'ListFunctionInstances', - 'GetFunctionInstance', - 'DeleteFunctionInstance', - 'UpdateFunctionInstance', - 'CreateFunctionInstance', - ], + 'title' => 'Algorithm peripherals', ], [ - 'id' => 170783, - 'title' => 'Others', + 'children' => ['ValidateDataSources', 'ListDataSourceTables', 'ListDataSourceTableFields', 'GetDomain', 'DescribeRegions'], 'type' => 'directory', - 'children' => [ - 'DescribeAppGroup', - 'ValidateDataSources', - 'ReplaceAppGroupCommodityCode', - 'ListSortScripts', - 'ListDataSourceTables', - 'ListDataSourceTableFields', - 'GetDomain', - 'GenerateMergedTable', - 'DescribeRegions', - ], + 'title' => 'Others (documents not in the directory)', ], [ - 'id' => 170995, - 'title' => 'other', + 'children' => ['DescribeDataCollction', 'ListDataCollections', 'RemoveDataCollection', 'UntagResources', 'ListTagResources', 'TagResources', 'CreateAppGroupCredentials', 'CreateQueryProcessor', 'DescribeAppStatistics', 'GenerateMergedTable', 'ListABTestExperiments', 'ListABTestScenes', 'ListFirstRanks', 'RemoveUserAnalyzer', 'ReplaceAppGroupCommodityCode', 'SaveSortScriptFile'], 'type' => 'directory', - 'children' => [ - 'DescribeDataCollction', - 'ListDataCollections', - 'RemoveDataCollection', - 'UntagResources', - 'ListTagResources', - 'TagResources', - 'GetFunctionResource', - 'ListFunctionResources', - 'DeleteFunctionResource', - 'UpdateFunctionResource', - 'CreateAppGroupCredentials', - ], + 'title' => 'Others', ], ], 'components' => [ 'schemas' => [ 'ABTestExperiment' => [ 'title' => '', - 'description' => '', - 'visibility' => 'Public', + 'description' => 'The A/B testing experiment.', 'type' => 'object', 'properties' => [ - 'name' => [ - 'title' => '', - 'description' => '', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'my_test', - 'backendName' => 'name', - ], - 'traffic' => [ - 'title' => '', - 'description' => '', - 'visibility' => 'Public', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '10', - 'backendName' => 'traffic', - ], - 'serialNumber' => [ - 'title' => '', - 'description' => '', - 'visibility' => 'Public', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '85373', - 'backendName' => 'serialNumber', - ], - 'online' => [ - 'title' => '', - 'description' => '', - 'visibility' => 'Public', - 'type' => 'boolean', - 'example' => 'false', - 'backendName' => 'online', - ], + 'name' => ['title' => '', 'description' => 'The alias of the experiment.', 'type' => 'string', 'example' => 'my_test', 'visibility' => 'Public', 'backendName' => 'name'], + 'traffic' => ['title' => '', 'description' => 'The percentage of traffic for experiment bucketing. Valid values: 0 to 100.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'visibility' => 'Public', 'backendName' => 'traffic'], + 'serialNumber' => ['title' => '', 'description' => 'The serial number of the experiment. This number is automatically generated by Hyperspace.', 'type' => 'integer', 'format' => 'int32', 'example' => '85373', 'visibility' => 'Public', 'backendName' => 'serialNumber'], + 'online' => ['title' => '', 'description' => 'The status of the experiment.'."\n" + ."\n" + .'- true: The experiment is online.'."\n" + ."\n" + .'- false: The experiment is offline.', 'type' => 'boolean', 'example' => 'false', 'visibility' => 'Public', 'backendName' => 'online'], 'params' => [ 'title' => '', - 'description' => '', - 'visibility' => 'Public', + 'description' => 'The parameters of the experiment.', 'type' => 'object', - 'additionalProperties' => [ - 'description' => '', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => '{'."\n" - .' "firstFormulaName": "default"'."\n" - .' }', - ], + 'additionalProperties' => ['description' => 'The parameter items.'."\n" + ."\n" + .'- firstFormulaName: The name of the rough sort.'."\n" + ."\n" + .'- formulaName: The name of the fine sort.'."\n" + ."\n" + .'- qpChainName: The name of the query analysis.'."\n" + ."\n" + .'- catePredictModel: The name of the category prediction model.', 'type' => 'string', 'example' => '{'."\n" + .' "firstFormulaName": "default"'."\n" + .' }', 'title' => '', 'visibility' => 'Public'], + 'example' => '', + 'visibility' => 'Public', 'backendName' => 'params', ], ], + 'example' => '', + 'visibility' => 'Public', ], 'ABTestGroup' => [ 'title' => '', 'description' => 'The information about an A/B test group.'."\n", - 'visibility' => 'Public', 'type' => 'object', 'properties' => [ - 'name' => [ - 'title' => '', - 'description' => 'The alias of the test group.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => '“kevin_test”', - 'backendName' => 'name', - ], - 'status' => [ - 'title' => '', - 'description' => 'The status of the test group. Valid values:'."\n" - ."\n" - .'* 0: not in effect'."\n" - .'* 1: in effect'."\n", - 'visibility' => 'Public', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - 'backendName' => 'status', - ], + 'name' => ['title' => '', 'description' => 'The alias of the test group.'."\n", 'type' => 'string', 'example' => '“kevin_test”', 'visibility' => 'Public', 'backendName' => 'name'], + 'status' => ['title' => '', 'description' => 'The status of the test group. Valid values:'."\n" + ."\n" + .'* 0: not in effect'."\n" + .'* 1: in effect'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'visibility' => 'Public', 'backendName' => 'status'], ], + 'visibility' => 'Public', + 'example' => '', ], 'ABTestScene' => [ 'title' => '', 'description' => 'The information about an A/B test scene.'."\n", - 'visibility' => 'Public', 'type' => 'object', 'properties' => [ - 'name' => [ - 'title' => '', - 'description' => 'The alias of the test scenario.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'test', - 'backendName' => 'name', - ], + 'name' => ['title' => '', 'description' => 'The alias of the test scenario.'."\n", 'type' => 'string', 'example' => 'test'], 'values' => [ 'title' => '', 'description' => 'The ID of the test scenario'."\n", - 'visibility' => 'Public', + 'type' => 'array', + 'items' => ['description' => 'The indicators of the test scenarios.'."\n", 'type' => 'string', 'example' => 'test', 'title' => ''], + 'example' => '', + ], + 'status' => ['title' => '', 'description' => 'The status of the test scenario. Valid values:'."\n" + ."\n" + .'* 0: not in effect'."\n" + .'* 1: in effect'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '0'], + ], + 'example' => '', + ], + 'DataSource' => [ + 'title' => '数据源配置', + 'type' => 'object', + 'properties' => [ + 'tableName' => ['title' => '数据源配置标识', 'type' => 'string'], + 'type' => ['title' => '数据源类型', 'type' => 'string'], + 'fields' => [ + 'title' => '数据源表字段 => 应用表字段映射', 'type' => 'array', 'items' => [ - 'description' => 'The indicators of the test scenarios.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'test', - 'extendType' => 'true', + 'type' => 'object', + 'additionalProperties' => ['type' => 'string'], ], - 'backendName' => 'values', ], - 'status' => [ - 'title' => '', - 'description' => 'The status of the test scenario. Valid values:'."\n" - ."\n" - .'* 0: not in effect'."\n" - .'* 1: in effect'."\n", - 'visibility' => 'Public', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '0', - 'backendName' => 'status', + 'plugins' => [ + 'title' => '数据源插件', + 'type' => 'object', + 'additionalProperties' => [ + 'type' => 'object', + 'properties' => [ + 'name' => ['title' => '插件名称', 'type' => 'string'], + 'fromFields' => ['title' => '数据来源字段', 'type' => 'string'], + 'parameters' => [ + 'title' => '插件参数', + 'type' => 'object', + 'additionalProperties' => ['type' => 'string'], + ], + ], + ], ], + 'keyField' => ['title' => '主键', 'type' => 'string'], + 'schemaName' => ['title' => '宽表名称', 'type' => 'string'], + 'parameters' => ['title' => '数据源信息', 'type' => 'object'], + ], + ], + 'FirstRank' => [ + 'title' => '粗排表达式配置', + 'type' => 'object', + 'properties' => [ + 'type' => ['title' => '表达式类型 (STRUCT, STRING)', 'type' => 'string'], + 'name' => ['title' => '名称', 'type' => 'string'], + 'description' => ['title' => '描述', 'type' => 'string'], + 'active' => ['title' => '是否是默认表达式', 'type' => 'boolean'], + 'meta' => ['title' => '表达式信息', 'type' => 'any'], ], ], 'PrepayOrderInfo' => [ 'title' => '', 'description' => 'The information about the subscription order.'."\n", - 'visibility' => 'public', 'type' => 'object', 'properties' => [ - 'duration' => [ - 'title' => '', - 'description' => 'The subscription duration.'."\n", - 'visibility' => 'public', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - 'backendName' => 'duration', + 'duration' => ['title' => '', 'description' => 'The subscription duration.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'visibility' => 'Public', 'backendName' => 'duration'], + 'pricingCycle' => ['title' => '', 'description' => 'The billing cycle. Valid values:'."\n" + ."\n" + .'* Year'."\n" + .'* Month'."\n", 'type' => 'string', 'example' => 'Year', 'visibility' => 'Public', 'backendName' => 'pricingCycle'], + 'autoRenew' => ['title' => '', 'description' => 'Specifies whether to enable auto-renewal for the instance.'."\n", 'type' => 'boolean', 'example' => 'false', 'visibility' => 'Public', 'backendName' => 'autoRenew'], + ], + 'visibility' => 'Public', + 'example' => '', + ], + 'Proceeding' => [ + 'type' => 'object', + 'properties' => [ + 'progress' => ['type' => 'number', 'format' => 'float', 'description' => '', 'title' => '', 'example' => ''], + 'type' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'status' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'subTasks' => ['$ref' => '#/components/schemas/Proceeding', 'description' => '', 'title' => '', 'example' => ''], + 'detail' => ['type' => 'object', 'description' => '', 'title' => '', 'example' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'Quota' => [ + 'title' => '版本配额', + 'type' => 'object', + 'properties' => [ + 'docSize' => ['title' => '存储容量 (单位:GB)', 'type' => 'integer', 'format' => 'int32'], + 'computeResource' => ['title' => '计算资源 (单位:LCU)', 'type' => 'integer', 'format' => 'int32'], + 'spec' => ['title' => '规格', 'type' => 'string'], + 'orderType' => ['title' => '变配类型', 'type' => 'string'], + ], + ], + 'ScheduledTask' => [ + 'title' => '定时任务', + 'description' => '定时任务', + 'type' => 'object', + 'properties' => [ + 'type' => ['title' => '任务类型', 'type' => 'string'], + 'cron' => ['title' => '时间表达式', 'type' => 'string'], + 'enabled' => ['title' => '是否执行', 'type' => 'boolean'], + 'version' => ['title' => '待删除版本号', 'type' => 'string'], + 'forkedAppId' => ['title' => '上一个版本id', 'type' => 'string'], + 'autoSwitch' => ['title' => '是否自动切换上线', 'type' => 'boolean'], + 'permanent' => ['title' => '是否持久化', 'type' => 'boolean'], + 'runNow' => ['title' => '是否立即执行', 'type' => 'boolean'], + 'filter' => [ + 'title' => '清理配置', + 'type' => 'object', + 'properties' => [ + 'field' => ['title' => '过滤字段名称', 'type' => 'string'], + 'days' => ['title' => '保留天数', 'type' => 'integer', 'format' => 'int32'], + 'unit' => ['title' => '时间单位', 'type' => 'string'], + 'expression' => ['title' => '表达式', 'type' => 'string'], + ], ], - 'pricingCycle' => [ - 'title' => '', - 'description' => 'The billing cycle. Valid values:'."\n" - ."\n" - .'* Year'."\n" - .'* Month'."\n", - 'visibility' => 'public', - 'type' => 'string', - 'example' => 'Year', - 'backendName' => 'pricingCycle', + ], + ], + 'Schema' => [ + 'title' => '应用结构', + 'type' => 'object', + 'properties' => [ + 'tables' => [ + 'title' => '用户数据表', + 'type' => 'object', + 'additionalProperties' => [ + 'type' => 'object', + 'properties' => [ + 'name' => ['title' => '表名称', 'type' => 'string'], + 'primaryTable' => ['title' => '是否是主表', 'type' => 'boolean'], + 'fields' => [ + 'title' => '字段清单', + 'type' => 'object', + 'additionalProperties' => [ + 'type' => 'object', + 'properties' => [ + 'name' => ['title' => '字段名称', 'type' => 'string'], + 'primaryKey' => ['title' => '是否是主键', 'type' => 'boolean'], + 'type' => ['title' => '字段类型 (INT, INT_ARRAY, FLOAT, FLOAT_ARRAY, DOUBLE, DOUBLE_ARRAY, TEXT, SHORT_TEXT, LITERAL, LITERAL_ARRAY, GEO_POINT, TIMESTAMP)', 'type' => 'string'], + 'joinWith' => [ + 'title' => '外表链接的数据表集合', + 'type' => 'array', + 'items' => ['type' => 'string'], + ], + 'label' => ['title' => '字段标签', 'type' => 'string'], + ], + ], + ], + ], + ], ], - 'autoRenew' => [ - 'title' => '', - 'description' => 'Specifies whether to enable auto-renewal for the instance.'."\n", - 'visibility' => 'public', - 'type' => 'boolean', - 'example' => 'false', - 'backendName' => 'autoRenew', + 'indexes' => [ + 'title' => '索引配置', + 'type' => 'object', + 'properties' => [ + 'searchFields' => [ + 'title' => '索引字段', + 'type' => 'object', + 'additionalProperties' => [ + 'type' => 'object', + 'properties' => [ + 'analyzer' => ['title' => '分析器名称', 'type' => 'string'], + 'analyzerType' => ['title' => '分析器类型 (AUTO, MODEL, SYSTEM, USER)', 'type' => 'string'], + 'analyzerGeneration' => ['title' => '模型定制分析器Generation', 'type' => 'string'], + 'fields' => [ + 'title' => '索引字段集合', + 'type' => 'array', + 'items' => ['type' => 'string'], + ], + 'label' => ['title' => '索引标签', 'type' => 'string'], + ], + ], + ], + 'filterFields' => [ + 'title' => '属性字段集合', + 'type' => 'array', + 'items' => ['type' => 'string'], + ], + ], + ], + 'routeField' => ['title' => '一级分列字段名称', 'type' => 'string'], + 'routeFieldValues' => [ + 'title' => '一级分列字段热点值清单（配置后启用“二级分列”）', + 'type' => 'array', + 'items' => ['type' => 'string'], + ], + 'secondRouteField' => ['title' => '二级分列字段名称（当且仅当配置有`routeFieldValues`时生效，默认使用宽表主键）', 'type' => 'string'], + 'ttlField' => [ + 'title' => '文档清理配置', + 'type' => 'object', + 'properties' => [ + 'name' => ['title' => '文档时间字段', 'type' => 'string'], + 'ttl' => ['title' => '存活时间（毫秒）', 'type' => 'integer', 'format' => 'int64'], + ], + ], + 'indexSortConfig' => [ + 'title' => '倒排索引配置', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'field' => ['title' => '字段', 'type' => 'string'], + 'direction' => ['title' => '排序方式ASC, DESC', 'type' => 'string'], + ], + ], + ], + 'name' => ['title' => '宽表表名', 'type' => 'string'], + ], + ], + 'SearchStrategy' => [ + 'title' => '查询策略', + 'description' => '查询策略', + 'type' => 'object', + 'properties' => [ + 'name' => ['title' => '策略名称', 'type' => 'string'], + 'description' => ['title' => '策略描述', 'type' => 'string'], + 'searchConfigs' => [ + 'title' => '查询策略', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'queryType' => ['title' => '查询类型', 'type' => 'string', 'example' => 'keyword: 关键字查询 vector: 向量查询'], + 'firstRankName' => ['title' => '基础排序名称', 'type' => 'string'], + 'secondRankName' => ['title' => '业务排序名称', 'type' => 'string'], + 'mergeProportion' => ['title' => '参与综合排序的比例', 'type' => 'integer', 'format' => 'int32'], + ], + ], + ], + 'mergeConfig' => [ + 'title' => '归并排序配置', + 'type' => 'object', + 'properties' => [ + 'rankName' => ['title' => '归并排序名称', 'type' => 'string'], + 'docCount' => ['title' => '归并排序文档数', 'type' => 'integer', 'format' => 'int32'], + ], ], + 'isDefault' => ['title' => '是否设置默认', 'type' => 'boolean'], + ], + ], + 'SecondRank' => [ + 'title' => '精排表达式配置', + 'type' => 'object', + 'properties' => [ + 'meta' => ['title' => '表达式', 'type' => 'any'], + 'name' => ['title' => '名称', 'type' => 'string'], + 'description' => ['title' => '描述', 'type' => 'string'], + 'active' => ['title' => '是否是默认表达式', 'type' => 'boolean'], ], ], ], ], 'apis' => [ - 'RenewAppGroup' => [ - 'summary' => 'Renews an application. This operation is not available now. You must renew an application in the OpenSearch console.', - 'path' => '/v4/openapi/app-groups/{appGroupIdentity}/actions/renew', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'BindESUserAnalyzer' => [ + 'summary' => 'Binds a custom analyzer to an Elasticsearch instance.', + 'path' => '/v4/openapi/app-groups/{appGroupIdentity}/es/{esInstanceId}/actions/bind-analyzer', + 'methods' => ['post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -526,108 +481,85 @@ 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'update', + 'operationType' => 'none', 'riskType' => 'none', - 'chargeType' => 'paid', - 'abilityTreeNodes' => [ - 'FEATUREopensearch447AAX', - ], + 'chargeType' => 'free', + 'abilityTreeCode' => '55141', + 'abilityTreeNodes' => ['FEATUREopensearch447AAX'], ], 'parameters' => [ [ 'name' => 'appGroupIdentity', 'in' => 'path', - 'schema' => [ - 'description' => 'The name of the application.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'my_app', - ], + 'schema' => ['description' => 'The name of the application.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'title' => '', 'example' => '130187460'], ], [ - 'name' => 'clientToken', - 'in' => 'query', - 'schema' => [ - 'description' => 'The client token that is used to ensure the idempotence of the request.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '74db41d8cd3c784209093aa76afbe89e', - ], + 'name' => 'esInstanceId', + 'in' => 'path', + 'schema' => ['description' => 'The ID of the instance.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'title' => '', 'example' => 'es-cn-zvp2g952l000v5uxp'], ], [ 'name' => 'body', 'in' => 'body', - 'schema' => [ - 'description' => 'The renewal request body.'."\n", - 'required' => false, - '$ref' => '#/components/schemas/PrepayOrderInfo', - ], + 'schema' => ['description' => 'The request body.', 'type' => 'any', 'required' => false, 'title' => '', 'example' => '{'."\n" + .' "name": "kevintest-analyzer"'."\n" + .'}'], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'description' => 'The response body.'."\n", + 'description' => 'The response body.', 'type' => 'object', 'properties' => [ - 'requestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => 'D77D0DAF-790D-F5F5-A9C0-133738165014', - ], - 'result' => [ - 'description' => 'Indicates whether the application was renewed.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], + 'result' => ['description' => 'The custom analyzer.', 'type' => 'object', 'title' => '', 'example' => '[]'], + 'requestId' => ['description' => 'The ID of the request.', 'type' => 'string', 'title' => '', 'example' => '3AD34CAD-9603-5251-AFF5-3916C848A1D3'], ], 'example' => '{}', + 'title' => '', ], ], '5XX' => [ 'schema' => [ 'type' => 'object', 'properties' => [ - 'code' => [ - 'type' => 'string', - ], - 'message' => [ - 'type' => 'string', - ], - 'requestId' => [ - 'type' => 'string', - ], - 'httpCode' => [ - 'type' => 'integer', - 'format' => 'int32', - ], + 'code' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'message' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'requestId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'httpCode' => ['type' => 'integer', 'format' => 'int32', 'description' => '', 'title' => '', 'example' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"requestId\\": \\"D77D0DAF-790D-F5F5-A9C0-133738165014\\",\\n \\"result\\": true\\n}","errorExample":""},{"type":"xml","example":"D77D0DAF-790D-F5F5-A9C0-133738165014\\n","errorExample":""}]', - 'title' => 'RenewAppGroup', - 'requestParamsDescription' => '**Optional parameters**'."\n" - ."\n" - .'|Parameter|Type|Description|'."\n" - .'|---|---|---|'."\n" - .'|duration|Integer|The renewal duration. Default value: 1.Valid values:\\- \\[1,2\\]. Unit: year.\\- \\[1,9\\]. Unit: month.|'."\n" - .'|pricingCycle|String|The unit of the renewal duration.Valid values:\\- Year\\- Month|'."\n" - .'|autoRenew|boolean|Specifies whether to enable auto-renewal. Default value: false.Valid values:\\- false\\- true|', - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', - ], - 'CreateAppGroup' => [ - 'summary' => 'Creates an OpenSearch application.', - 'path' => '/v4/openapi/app-groups', - 'methods' => [ - 'post', + 'title' => 'BindESUserAnalyzer', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'opensearch:ModifyAppGroup', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'OpenSearch', 'resourceType' => 'AppGroup', 'arn' => 'acs:opensearch:{#regionId}:{#accountId}:app-groups/{#AppGroupId}'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"result\\": [],\\n \\"requestId\\": \\"3AD34CAD-9603-5251-AFF5-3916C848A1D3\\"\\n}","type":"json"}]', + 'translator' => 'manual', + ], + 'BindEsInstance' => [ + 'summary' => 'Binds an Elasticsearch instance as a dependency.', + 'path' => '/v4/openapi/app-groups/{appGroupIdentity}/actions/bind-es-instance', + 'methods' => ['post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -636,677 +568,171 @@ 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'create', + 'operationType' => 'none', 'riskType' => 'none', - 'chargeType' => 'paid', - 'abilityTreeCode' => '55147', - 'abilityTreeNodes' => [ - 'FEATUREopensearch2ESE2N', - 'FEATUREopensearchG9QGQK', - 'FEATUREopensearchO36CPI', - ], + 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATUREopensearchQZGKV9'], ], 'parameters' => [ + [ + 'name' => 'appGroupIdentity', + 'in' => 'path', + 'schema' => ['description' => 'The name of the application.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'title' => '', 'example' => 'my_app_group_name'], + ], [ 'name' => 'body', 'in' => 'body', 'style' => 'json', - 'schema' => [ - 'description' => 'The request body.'."\n", - 'type' => 'object', - 'properties' => [ - 'name' => [ - 'description' => 'The name of the application.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'jmbon_analyzer', - ], - 'chargeType' => [ - 'description' => 'The billing method. Valid values:'."\n" - ."\n" - .'* POSTPAY: pay-as-you-go'."\n" - .'* PREPAY: subscription'."\n", - 'type' => 'string', - 'required' => false, - 'enumValueTitles' => [], - 'example' => 'POSTPAY', - ], - 'type' => [ - 'description' => 'The type of the application. Valid values:'."\n" - ."\n" - .'* standard'."\n" - .'* enhanced'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'enhanced', - ], - 'resourceGroupId' => [ - 'description' => 'The ID of the resource group to which the instance belongs.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'rg-acfm2ij6pwxsvua', - ], - 'tags' => [ - 'description' => 'The tags.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The tag.'."\n", - 'type' => 'object', - 'properties' => [ - 'key' => [ - 'description' => 'The tag key.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'a', - ], - 'value' => [ - 'description' => 'The tag value.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '1', - ], - ], - 'required' => false, - ], - 'required' => false, - ], - 'quota' => [ - 'description' => 'The quota.'."\n", - 'type' => 'object', - 'properties' => [ - 'docSize' => [ - 'description' => 'The storage capacity. Unit: GB.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', - ], - 'computeResource' => [ - 'description' => 'The computing resources. Unit: logical computing unit (LCU).'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '20', - ], - 'spec' => [ - 'description' => 'The specifications. Valid values:'."\n" - ."\n" - .'* opensearch.share.junior: basic'."\n" - .'* opensearch.share.common: shared general-purpose'."\n" - .'* opensearch.share.compute: shared computing'."\n" - .'* opensearch.share.storage: shared storage'."\n" - .'* opensearch.private.common: exclusive general-purpose'."\n" - .'* opensearch.private.compute: exclusive computing'."\n" - .'* opensearch.private.storage: exclusive storage'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'opensearch.share.common', - ], - ], - 'required' => false, - ], - ], - 'required' => false, - ], + 'schema' => ['type' => 'object', 'required' => false, 'description' => 'The request body.', 'title' => '', 'example' => '{'."\n" + .' "esInstanceId": "es-cn-abcde"'."\n" + .'}'], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'description' => 'The rsponse body.'."\n", + 'description' => 'The response body.', 'type' => 'object', 'properties' => [ - 'requestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '766CF6DB-CA02-3E12-7CBA-6AC21FC978FD', - ], - 'result' => [ - 'description' => 'None'."\n", - 'type' => 'object', - 'properties' => [ - 'created' => [ - 'description' => 'The timestamp when the application was created.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1590139542', - ], - 'currentVersion' => [ - 'description' => 'The ID of the current online version.'."\n", - 'type' => 'string', - 'example' => '100302903', - ], - 'lockMode' => [ - 'description' => 'The lock state. Valid values:'."\n" - ."\n" - .'* Unlock: The instance is unlocked.'."\n" - .'* LockByExpiration: The instance is automatically locked after it expires.'."\n" - .'* ManualLock: The instance is manually locked.'."\n", - 'type' => 'string', - 'example' => 'Unlock', - ], - 'updated' => [ - 'description' => 'The timestamp when the application was last modified.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1590978265', - ], - 'id' => [ - 'description' => 'The application ID.'."\n", - 'type' => 'string', - 'example' => '100302881', - ], - 'chargeType' => [ - 'description' => 'The billing method. Valid values:'."\n" - ."\n" - .'* POSTPAY: pay-as-you-go.'."\n" - .'* PREPAY: subscription.'."\n", - 'type' => 'string', - 'example' => 'POSTPAY', - ], - 'hasPendingQuotaReviewTask' => [ - 'description' => 'The approval state of the quotas. Valid values:'."\n" - ."\n" - .'* 0: The application is in service.'."\n" - .'* 1: The quotas are being reviewed.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '0', - ], - 'name' => [ - 'description' => 'The name of the application.'."\n", - 'type' => 'string', - 'example' => 'lsh_test_1', - ], - 'instanceId' => [ - 'description' => 'The ID of the instance.'."\n", - 'type' => 'string', - 'example' => '-', - ], - 'chargingWay' => [ - 'description' => 'The type of billing. Valid values:'."\n" - ."\n" - .'* 1: computing resources.'."\n" - .'* 2: queries per second (QPS).'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'type' => [ - 'description' => 'The type of the application. Valid values:'."\n" - ."\n" - .'* standard: a standard edition application.'."\n" - .'* advance: an advanced edition which is of an old version. New version is not supported for this edition.'."\n" - .'* enhanced: an advanced edition application of a new version.'."\n", - 'type' => 'string', - 'example' => 'enhanced', - ], - 'status' => [ - 'description' => 'The status of the application. Valid values:'."\n" - ."\n" - .'* producing: The application is being created.'."\n" - .'* review_pending: The application is being reviewed.'."\n" - .'* config_pending: The application is to be configured.'."\n" - .'* normal: The application is in service.'."\n" - .'* frozen: The application is frozen.'."\n", - 'type' => 'string', - 'example' => 'normal', - ], - 'projectId' => [ - 'description' => 'The name of the A/B test group.'."\n", - 'type' => 'string', - 'example' => '-', - ], - 'switchedTime' => [ - 'description' => 'The timestamp when the current online version was published.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1590486386', - ], - 'commodityCode' => [ - 'description' => 'The commodity code.'."\n", - 'type' => 'string', - 'example' => 'opensearch', - ], - 'expireOn' => [ - 'description' => 'The expiration time.'."\n", - 'type' => 'string', - 'example' => '-', - ], - 'domain' => [ - 'description' => 'The type of the industry. Valid values:'."\n" - ."\n" - .'* GENERAL'."\n" - .'* ECOMMERCE'."\n" - .'* IT_CONTENT'."\n", - 'type' => 'string', - 'example' => 'GENERAL', - ], - 'description' => [ - 'description' => 'The description of the application.'."\n", - 'type' => 'string', - 'example' => '-', - ], - 'produced' => [ - 'description' => 'Indicates whether the application is created. Valid values:'."\n" - ."\n" - .'* 0: The application is being created.'."\n" - .'* 1: The application is created.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'quota' => [ - 'description' => 'The information about the quotas of the application.'."\n", - 'type' => 'object', - 'properties' => [ - 'spec' => [ - 'description' => 'The specifications. Valid values:'."\n" - ."\n" - .'* opensearch.share.junior: basic.'."\n" - .'* opensearch.share.common: shared general-purpose.'."\n" - .'* opensearch.share.compute: shared computing.'."\n" - .'* opensearch.share.storage: shared storage.'."\n" - .'* opensearch.private.common: exclusive general-purpose.'."\n" - .'* opensearch.private.compute: exclusive computing.'."\n" - .'* opensearch.private.storage: exclusive storage.'."\n", - 'type' => 'string', - 'example' => 'opensearch.share.common', - ], - 'docSize' => [ - 'description' => 'The storage capacity. Unit: GB.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'computeResource' => [ - 'description' => 'The computing resources. Unit: logical computing units (LCUs).'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '20', - ], - ], - ], - 'engineType' => [ - 'description' => 'The engine type.'."\n", - 'type' => 'string', - 'example' => 'ha3', - ], - ], - ], + 'result' => ['description' => 'The result.', 'type' => 'object', 'title' => '', 'example' => '{}'], + 'requestId' => ['description' => 'The ID of the request.', 'type' => 'string', 'title' => '', 'example' => 'F5099063-6B86-F398-D843-905F9EFB683A'], ], + 'example' => '{}', + 'title' => '', ], ], '5XX' => [ 'schema' => [ 'type' => 'object', 'properties' => [ - 'code' => [ - 'type' => 'string', - ], - 'message' => [ - 'type' => 'string', - ], - 'requestId' => [ - 'type' => 'string', - ], - 'httpCode' => [ - 'type' => 'integer', - 'format' => 'int32', - ], + 'code' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'message' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'requestId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'httpCode' => ['type' => 'integer', 'format' => 'int32', 'description' => '', 'title' => '', 'example' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"requestId\\": \\"766CF6DB-CA02-3E12-7CBA-6AC21FC978FD\\",\\n \\"result\\": {\\n \\"created\\": 1590139542,\\n \\"currentVersion\\": \\"100302903\\",\\n \\"lockMode\\": \\"Unlock\\",\\n \\"updated\\": 1590978265,\\n \\"id\\": \\"100302881\\",\\n \\"chargeType\\": \\"POSTPAY\\",\\n \\"hasPendingQuotaReviewTask\\": 0,\\n \\"name\\": \\"lsh_test_1\\",\\n \\"instanceId\\": \\"-\\",\\n \\"chargingWay\\": 1,\\n \\"type\\": \\"enhanced\\",\\n \\"status\\": \\"normal\\",\\n \\"projectId\\": \\"-\\",\\n \\"switchedTime\\": 1590486386,\\n \\"commodityCode\\": \\"opensearch\\",\\n \\"expireOn\\": \\"-\\",\\n \\"domain\\": \\"GENERAL\\",\\n \\"description\\": \\"-\\",\\n \\"produced\\": 1,\\n \\"quota\\": {\\n \\"spec\\": \\"opensearch.share.common\\",\\n \\"docSize\\": 1,\\n \\"computeResource\\": 20\\n },\\n \\"engineType\\": \\"ha3\\"\\n }\\n}","errorExample":""},{"type":"xml","example":"766CF6DB-CA02-3E12-7CBA-6AC21FC978FD","errorExample":""}]', - 'title' => 'CreateAppGroup', - 'requestParamsDescription' => '**Request body**'."\n" - ."\n" - .'|Parameter|Type|Required|Example|Description|'."\n" - .'|---|---|---|---|---|'."\n" - .'|name|String|Yes|"my\\_app"|The name of the application.|'."\n" - .'|type|String|Yes|"standard"|The type of the application.Valid values: standardand enhanced.|'."\n" - .'|quota|Object|Yes||The quota information about the application. For more information, see [Quota](~~170001~~).|'."\n" - .'|chargeType|String|No|"POSTPAY"|The billing method.Valid values: POSTPAYand PREPAY.|'."\n" - .'|order|Object|No|{"duration": 1,"pricingCycle": "Year"}|The information about the subscription period.|'."\n" - .'|order.duration|Integer|\\--|1|The subscription duration. The minimum value is no less than 0.|'."\n" - .'|order.pricingCycle|String|\\--|"Year"|The unit of the subscription duration.YearMonth.|'."\n" - .'|order.autoRenew|Boolean|No|true|Specifies whether to enable auto-renewal. This parameter takes effect only when the chargeType parameter is set to PREPAY. Valid values:true.false (the default value).|', - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', - ], - 'ModifyAppGroup' => [ - 'summary' => 'Modifies the properties of an OpenSearch application or sets the online version of an OpenSearch application.', - 'path' => '/v4/openapi/app-groups/{appGroupIdentity}', - 'methods' => [ - 'put', + 'title' => 'BindEsInstance', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'opensearch:BindEsInstance', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'OpenSearch', 'resourceType' => 'AppGroup', 'arn' => 'acs:opensearch:{#regionId}:{#accountId}:app-groups/{#AppGroupId}'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"result\\": {},\\n \\"requestId\\": \\"F5099063-6B86-F398-D843-905F9EFB683A\\"\\n}","type":"json"}]', + 'translator' => 'manual', + ], + 'CompileSortScript' => [ + 'summary' => 'Compiles a sort script.', + 'path' => '/v4/openapi/app-groups/{appGroupIdentity}/apps/{appVersionId}/sort-scripts/{scriptName}/actions/compiling', + 'methods' => ['post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'write', + 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeCode' => '55236', - 'abilityTreeNodes' => [ - 'FEATUREopensearchGVH0IN', - 'FEATUREopensearch447AAX', - 'FEATUREopensearch5OZOSP', - ], + 'abilityTreeNodes' => ['FEATUREopensearchN8M8WS'], ], 'parameters' => [ [ 'name' => 'appGroupIdentity', 'in' => 'path', + 'schema' => ['description' => 'The name or ID of the application.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'title' => '', 'example' => 'search'], + ], + [ + 'name' => 'scriptName', + 'in' => 'path', + 'schema' => ['description' => 'The name of the script.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'title' => '', 'example' => 'script'], + ], + [ + 'name' => 'appVersionId', + 'in' => 'path', + 'schema' => ['description' => 'The ID of the application version.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => '130196473'], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => 'The name of the application.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'my_app_group_name', + 'type' => 'object', + 'properties' => [ + 'requestId' => ['description' => 'The unique ID of the request.', 'type' => 'string', 'title' => '', 'example' => 'ABCDEFGH'], + ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], - [ - 'name' => 'body', - 'in' => 'body', - 'style' => 'json', + '5XX' => [ 'schema' => [ - 'description' => 'The request parameters for the operation.'."\n", 'type' => 'object', 'properties' => [ - 'description' => [ - 'description' => 'The description of the application.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '"test"', - ], - 'currentVersion' => [ - 'description' => 'The online version of the application.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '1223232', - ], - 'domain' => [ - 'description' => 'The type of the industry. Valid values:'."\n" - ."\n" - .'* general: general.'."\n" - .'* ecommerce: e-commerce.'."\n" - .'* education: education.'."\n" - .'* esports: electronic sports.'."\n" - .'* community: content community.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '"ecommerce"', - ], - 'resourceGroupId' => [ - 'description' => 'The ID of the resource group to which the instance belongs.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'rg-****', - ], + 'code' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'message' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'requestId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'httpCode' => ['type' => 'integer', 'format' => 'int32', 'description' => '', 'title' => '', 'example' => ''], ], - 'required' => false, + 'description' => '', + 'title' => '', + 'example' => '', ], ], + ], + 'title' => 'CompileSortScript', + 'responseParamsDescription' => '```'."\n" + .'Error response'."\n" + .'{'."\n" + .' "requestId" : "ABCDEFGH",'."\n" + .' "code":"InvalidAppStatus",'."\n" + .' "message":"invalid app status.",'."\n" + .' "httpCode":400'."\n" + .'}'."\n" + .'```', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ [ - 'name' => 'dryRun', - 'in' => 'query', - 'schema' => [ - 'description' => 'Specifies whether to verify the application before modification. Valid values: true and false.'."\n", - 'type' => 'boolean', - 'required' => false, - 'example' => 'true', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'opensearch:WriteSortScript', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'OpenSearch', 'resourceType' => 'App', 'arn' => 'acs:opensearch:{#regionId}:{#accountId}:apps/{#AppGroupId}'], + ], ], ], ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'description' => 'The response body.', - 'type' => 'object', - 'properties' => [ - 'requestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => 'D77D0DAF-790D-F5F5-A9C0-133738165014', - ], - 'result' => [ - 'description' => 'Response parameters'."\n", - 'type' => 'object', - 'properties' => [ - 'created' => [ - 'description' => 'The timestamp when the application was created.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1590139524', - ], - 'currentVersion' => [ - 'description' => 'The ID of the current online version.'."\n", - 'type' => 'string', - 'example' => '100302903', - ], - 'lockMode' => [ - 'description' => 'The lock status. Valid values:'."\n" - ."\n" - .'* Unlock: The instance is unlocked.'."\n" - .'* LockByExpiration: The instance is automatically locked after it expires.'."\n" - .'* ManualLock: The instance is manually locked.'."\n", - 'type' => 'string', - 'example' => 'Unlock', - ], - 'updated' => [ - 'description' => 'The timestamp when the application was last modified.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1590978265', - ], - 'id' => [ - 'description' => 'The application ID.'."\n", - 'type' => 'string', - 'example' => '100302881', - ], - 'chargeType' => [ - 'description' => 'The billing method. Valid values:'."\n" - ."\n" - .'* POSTPAY: pay-as-you-go.'."\n" - .'* PREPAY: subscription.'."\n", - 'type' => 'string', - 'example' => 'POSTPAY', - ], - 'hasPendingQuotaReviewTask' => [ - 'description' => 'The approval status of the quotas. Valid values:'."\n" - ."\n" - .'* 0: normal.'."\n" - .'* 1: being approved.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '0', - ], - 'name' => [ - 'description' => 'The name of the application.'."\n", - 'type' => 'string', - 'example' => 'lsh_test_1', - ], - 'instanceId' => [ - 'description' => 'The instance ID.'."\n", - 'type' => 'string', - 'example' => '10030288', - ], - 'chargingWay' => [ - 'description' => 'The billable item. Valid values:'."\n" - ."\n" - .'* 1: computing resources.'."\n" - .'* 2: QPS.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'type' => [ - 'description' => 'The type of the application. Valid values:'."\n" - ."\n" - .'* standard: a standard edition application.'."\n" - .'* advance: an advanced edition application of an old version. New versions are not supported for this edition.'."\n" - .'* enhanced: an advanced edition application of a new version.'."\n", - 'type' => 'string', - 'example' => 'enhanced', - ], - 'status' => [ - 'description' => 'The state of the application. Valid values:'."\n" - ."\n" - .'* producing: being produced.'."\n" - .'* review_pending: being approved.'."\n" - .'* config_pending: to be configured.'."\n" - .'* normal: normal.'."\n" - .'* frozen: frozen.'."\n", - 'type' => 'string', - 'example' => 'normal', - ], - 'projectId' => [ - 'description' => 'The name of the A/B test group.'."\n", - 'type' => 'string', - 'example' => '1', - ], - 'switchedTime' => [ - 'description' => 'The timestamp when the current online version was published.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1590486386', - ], - 'commodityCode' => [ - 'description' => 'The code of the commodity.'."\n", - 'type' => 'string', - 'example' => 'opensearch', - ], - 'expireOn' => [ - 'description' => 'The time when the application expired.'."\n", - 'type' => 'string', - 'example' => '1', - ], - 'domain' => [ - 'description' => 'The type of the industry. Valid values:'."\n" - ."\n" - .'* GENERAL: general.'."\n" - .'* ECOMMERCE: e-commerce.'."\n" - .'* IT_CONTENT: IT content.'."\n", - 'type' => 'string', - 'example' => 'GENERAL', - ], - 'description' => [ - 'description' => 'The description of the application.'."\n", - 'type' => 'string', - 'example' => '1', - ], - 'produced' => [ - 'description' => 'Indicates whether the order is complete. Valid values:'."\n" - ."\n" - .'* 0: The order is in progress.'."\n" - .'* 1: The order is complete.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'quota' => [ - 'description' => 'The information about the quotas of the application.'."\n", - 'type' => 'object', - 'properties' => [ - 'spec' => [ - 'description' => 'The specifications. Valid values:'."\n" - ."\n" - .'* opensearch.share.junior: basic.'."\n" - .'* opensearch.share.common: shared general-purpose.'."\n" - .'* opensearch.share.compute: shared computing.'."\n" - .'* opensearch.share.storage: shared storage.'."\n" - .'* opensearch.private.common: exclusive general-purpose.'."\n" - .'* opensearch.private.compute: exclusive computing.'."\n" - .'* opensearch.private.storage: exclusive storage.'."\n", - 'type' => 'string', - 'example' => 'opensearch.share.common', - ], - 'docSize' => [ - 'description' => 'The storage capacity. Unit: GB.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'computeResource' => [ - 'description' => 'The computing resources. Unit: logical computing unit (LCU).'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '20', - ], - ], - 'example' => '{}', - ], - 'engineType' => [ - 'description' => 'The engine type.'."\n", - 'type' => 'string', - 'example' => 'ha3', - ], - 'resourceGroupId' => [ - 'description' => 'The ID of the resource group to which the instance belongs.'."\n", - 'type' => 'string', - 'example' => 'rg-acfmoiyerh6nzly', - ], - ], - 'example' => '{}', - ], - ], - 'example' => '{}', - ], - ], - '5XX' => [ - 'schema' => [ - 'type' => 'object', - 'properties' => [ - 'code' => [ - 'type' => 'string', - ], - 'message' => [ - 'type' => 'string', - ], - 'requestId' => [ - 'type' => 'string', - ], - 'httpCode' => [ - 'type' => 'integer', - 'format' => 'int32', - ], - ], - ], - ], - ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"requestId\\": \\"D77D0DAF-790D-F5F5-A9C0-133738165014\\",\\n \\"result\\": {\\n \\"created\\": 159013954,\\n \\"currentVersion\\": \\"100302903\\",\\n \\"lockMode\\": \\"Unlock\\",\\n \\"updated\\": 1590978265,\\n \\"id\\": \\"100302881\\",\\n \\"chargeType\\": \\"POSTPAY\\",\\n \\"hasPendingQuotaReviewTask\\": 0,\\n \\"name\\": \\"lsh_test_1\\",\\n \\"instanceId\\": \\"10030288\\",\\n \\"chargingWay\\": 1,\\n \\"type\\": \\"enhanced\\",\\n \\"status\\": \\"normal\\",\\n \\"projectId\\": \\"1\\",\\n \\"switchedTime\\": 1590486386,\\n \\"commodityCode\\": \\"opensearch\\",\\n \\"expireOn\\": \\"1\\",\\n \\"domain\\": \\"GENERAL\\",\\n \\"description\\": \\"1\\",\\n \\"produced\\": 1,\\n \\"quota\\": {\\n \\"spec\\": \\"opensearch.share.common\\",\\n \\"docSize\\": 1,\\n \\"computeResource\\": 20\\n },\\n \\"engineType\\": \\"ha3\\",\\n \\"resourceGroupId\\": \\"rg-acfmoiyerh6nzly\\"\\n }\\n}","errorExample":""},{"type":"xml","example":"0A6EB64B-B4C8-CF02-810F-E660812972FF\\n\\n 110116134\\n os_function_test_v1\\n 110116134\\n 0\\n \\n 1\\n 20\\n opensearch.share.common\\n \\n 1\\n enhanced\\n \\n POSTPAY\\n \\n \\n opensearch\\n \\n 0\\n 0\\n 0\\n opensearch-demo\\n 1\\n 0\\n 0\\n 1575442875\\n 1578916076\\n normal\\n Unlock\\n","errorExample":""}]', - 'title' => 'ModifyAppGroup', - 'requestParamsDescription' => '**Request body**'."\n" - ."\n" - .'|Parameter|Type|Required|Example|Description|'."\n" - .'|---|---|---|---|---|'."\n" - .'|chargingWay|Integer|No|1|The billing type. Valid values:1: computing resources.2: queries per second (QPS).|'."\n" - .'|description|String|No|"my\\_first\\_app"|The description of the application.|'."\n" - .'|currentVersion|Integer|No|12345678|The ID of the application version.|'."\n" - ."\n\n" - .'Note: The currentVersion parameter takes effect if all fields are included in the request. In this case, this operation preferentially configures the online version of the application.', - 'responseParamsDescription' => ' ', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"ABCDEFGH\\"\\n}","type":"json"}]', + 'translator' => 'manual', ], - 'ModifyAppGroupQuota' => [ - 'summary' => 'Modifies the quotas of an OpenSearch application.', - 'path' => '/v4/openapi/app-groups/{appGroupIdentity}/quota', - 'methods' => [ - 'put', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'CreateABTestExperiment' => [ + 'path' => '/v4/openapi/app-groups/{appGroupIdentity}/scenes/{sceneId}/groups/{groupId}/experiments', + 'methods' => ['post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -1315,323 +741,165 @@ 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'update', + 'operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeCode' => '55237', - 'abilityTreeNodes' => [ - 'FEATUREopensearchGVH0IN', - 'FEATUREopensearch447AAX', - 'FEATUREopensearch5OZOSP', - ], + 'abilityTreeNodes' => ['FEATUREopensearchE07IML'], ], 'parameters' => [ [ 'name' => 'appGroupIdentity', 'in' => 'path', - 'schema' => [ - 'description' => 'The name of the application'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'my_app_group_name', - ], + 'schema' => ['description' => 'The application name.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'title' => '', 'example' => 'my_app_group_name'], ], [ - 'name' => 'clientToken', - 'in' => 'query', - 'schema' => [ - 'title' => '用于保证请求的幂等性。由客户端生成该参数值，要保证在不同请求间唯一，最大不超过64个ASCII字符。', - 'type' => 'string', - ], + 'name' => 'sceneId', + 'in' => 'path', + 'schema' => ['description' => 'The scenario ID.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true, 'maximum' => '999999999', 'minimum' => '-1', 'title' => '', 'example' => '20404'], + ], + [ + 'name' => 'groupId', + 'in' => 'path', + 'schema' => ['description' => 'The group ID.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true, 'maximum' => '999999999', 'minimum' => '-1', 'title' => '', 'example' => '13467'], ], [ 'name' => 'dryRun', 'in' => 'query', - 'schema' => [ - 'description' => 'Specifies whether to check the validity of input parameters. Default value: false.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* **true**: checks only the validity of input parameters.'."\n" - .'* **false**: checks the validity of input parameters and creates an attribution configuration.'."\n", - 'type' => 'boolean', - 'required' => false, - 'example' => 'false', - ], + 'schema' => ['description' => 'Specifies whether to perform a dry run. The default value is false. Valid values:'."\n" + ."\n" + .'Valid values:'."\n" + ."\n" + .'- **true**: The system checks the validity of the request parameters.'."\n" + ."\n" + .'- **false**: The system checks the validity of the request parameters and creates the experiment.', 'type' => 'boolean', 'required' => false, 'title' => '', 'example' => 'false'], ], [ 'name' => 'body', 'in' => 'body', - 'schema' => [ - 'description' => 'The request body.'."\n", - 'required' => false, - '$ref' => '#/components/schemas/Quota', - ], + 'schema' => ['description' => 'The request body.', 'required' => false, '$ref' => '#/components/schemas/ABTestExperiment', 'title' => '', 'example' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'description' => 'The rsponse body.'."\n", 'type' => 'object', 'properties' => [ - 'requestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '0A6EB64B-B4C8-CF02-810F-E660812972FF', - ], + 'requestId' => ['description' => 'The request ID.', 'type' => 'string', 'title' => '', 'example' => 'D77D0DAF-790D-F5F5-A9C0-133738165014'], 'result' => [ - 'description' => 'The information about the application.'."\n", + 'description' => 'The experiment details.', 'type' => 'object', 'properties' => [ - 'created' => [ - 'description' => 'The timestamp when the application was created.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1590139542', - ], - 'currentVersion' => [ - 'description' => 'The ID of the current online version.'."\n", - 'type' => 'string', - 'example' => '100302903', - ], - 'type' => [ - 'description' => 'The type of the application. Valid values:'."\n" - ."\n" - .'* standard: a standard edition application.'."\n" - .'* advance: an advanced edition application of an old version. New versions are not supported for this edition.'."\n" - .'* enhanced: an advanced edition application of a new version.'."\n", - 'type' => 'string', - 'example' => 'enhanced', - ], - 'chargingWay' => [ - 'description' => 'The billable item. Valid values:'."\n" - ."\n" - .'* 1: computing resources.'."\n" - .'* 2: queries per second (QPS).'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'lockMode' => [ - 'description' => 'The lock state. Valid values:'."\n" - ."\n" - .'* Unlock: The instance is unlocked.'."\n" - .'* LockByExpiration: The instance is automatically locked after it expires.'."\n" - .'* ManualLock: The instance is manually locked.'."\n", - 'type' => 'string', - 'example' => 'Unlock', - ], - 'status' => [ - 'description' => 'The state of the application. Valid values:'."\n" - ."\n" - .'* producing: The application is being created.'."\n" - .'* review_pending: The application is being reviewed.'."\n" - .'* config_pending: The application is to be configured.'."\n" - .'* normal: The application is in service.'."\n" - .'* frozen: The application is frozen.'."\n", - 'type' => 'string', - 'example' => 'normal', - ], - 'updated' => [ - 'description' => 'The timestamp when the application was last modified.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1590978265', - ], - 'chargeType' => [ - 'description' => 'The billing method. Valid values:'."\n" - ."\n" - .'* POSTPAY: pay-as-you-go.'."\n" - .'* PREPAY: subscription.'."\n", - 'type' => 'string', - 'example' => 'POSTPAY', - ], - 'id' => [ - 'description' => 'The application ID.'."\n", - 'type' => 'string', - 'example' => '100302881', - ], - 'hasPendingQuotaReviewTask' => [ - 'description' => 'The approval state of the quotas. Valid values:'."\n" - ."\n" - .'* 0: The application is in service.'."\n" - .'* 1: The quotas are being reviewed.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '0', - ], - 'projectId' => [ - 'description' => 'The name of the A/B test group.'."\n", - 'type' => 'string', - 'example' => '1000', - ], - 'commodityCode' => [ - 'description' => 'The commodity code.'."\n", - 'type' => 'string', - 'example' => 'opensearch', - ], - 'switchedTime' => [ - 'description' => 'The timestamp when the current online version was published.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1590486386', - ], - 'expireOn' => [ - 'description' => 'The time when the application expired.'."\n", - 'type' => 'string', - 'example' => ' 1', - ], - 'description' => [ - 'description' => 'The description of the application.'."\n", - 'type' => 'string', - 'example' => ' 1', - ], - 'produced' => [ - 'description' => 'Indicates whether the application is created. Valid values:'."\n" - ."\n" - .'* 0: The application is being created.'."\n" - .'* 1: The application is created.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'name' => [ - 'description' => 'The name of the application'."\n", - 'type' => 'string', - 'example' => 'lsh_test_1', - ], - 'instanceId' => [ - 'description' => 'The instance ID.'."\n", - 'type' => 'string', - 'example' => '1', - ], - 'quota' => [ - 'description' => 'The information about the quotas of the application.'."\n", - 'type' => 'object', - 'properties' => [ - 'spec' => [ - 'description' => 'The specifications. Valid values:'."\n" - ."\n" - .'* opensearch.share.junior: basic.'."\n" - .'* opensearch.share.common: shared general-purpose.'."\n" - .'* opensearch.share.compute: shared computing.'."\n" - .'* opensearch.share.storage: shared storage.'."\n" - .'* opensearch.private.common: exclusive general-purpose.'."\n" - .'* opensearch.private.compute: exclusive computing.'."\n" - .'* opensearch.private.storage: exclusive storage.'."\n", - 'type' => 'string', - 'example' => 'opensearch.share.common', - ], - 'docSize' => [ - 'description' => 'The storage capacity. Unit: GB.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'computeResource' => [ - 'description' => 'The computing resources. Unit: logical computing unit (LCU).'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '20', - ], - ], - ], - 'engineType' => [ - 'description' => 'The engine type.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* ha3: ha3.'."\n", - 'type' => 'string', - 'enumValueTitles' => [ - 'ha3' => 'ha3', - ], - 'example' => 'ha3', - ], - 'resourceGroupId' => [ - 'description' => 'The ID of the resource group to which the instance belongs.'."\n", - 'type' => 'string', - 'example' => 'rg-acfmoiyerh6nzly', - ], + 'created' => ['description' => 'The time when the experiment was created.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '0'], + 'params' => ['description' => 'The experiment parameters.', 'type' => 'object', 'title' => '', 'example' => '{"firstFormulaName": "default"}'], + 'traffic' => ['description' => 'The percentage of traffic that is routed to the experiment.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '30'], + 'online' => ['description' => 'The status of the experiment.'."\n" + ."\n" + .'- true: The experiment is in effect.'."\n" + ."\n" + .'- false: The experiment is not in effect.', 'type' => 'boolean', 'title' => '', 'example' => 'true'], + 'name' => ['description' => 'The experiment alias.', 'type' => 'string', 'title' => '', 'example' => 'test3'], + 'updated' => ['description' => 'The time when the experiment was last modified.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '1589017861'], + 'id' => ['description' => 'The experiment ID.', 'type' => 'string', 'title' => '', 'example' => '12889'], ], + 'title' => '', + 'example' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], '5XX' => [ 'schema' => [ 'type' => 'object', 'properties' => [ - 'code' => [ - 'type' => 'string', - ], - 'message' => [ - 'type' => 'string', - ], - 'requestId' => [ - 'type' => 'string', - ], - 'httpCode' => [ - 'type' => 'integer', - 'format' => 'int32', - ], + 'code' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'message' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'requestId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'httpCode' => ['type' => 'integer', 'format' => 'int32', 'description' => '', 'title' => '', 'example' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"requestId\\": \\"0A6EB64B-B4C8-CF02-810F-E660812972FF\\",\\n \\"result\\": {\\n \\"created\\": 1590139542,\\n \\"currentVersion\\": \\"100302903\\",\\n \\"type\\": \\"enhanced\\",\\n \\"chargingWay\\": 1,\\n \\"lockMode\\": \\"Unlock\\",\\n \\"status\\": \\"normal\\",\\n \\"updated\\": 1590978265,\\n \\"chargeType\\": \\"POSTPAY\\",\\n \\"id\\": \\"100302881\\",\\n \\"hasPendingQuotaReviewTask\\": 0,\\n \\"projectId\\": \\"1000\\",\\n \\"commodityCode\\": \\"opensearch\\",\\n \\"switchedTime\\": 1590486386,\\n \\"expireOn\\": \\" 1\\",\\n \\"description\\": \\" 1\\",\\n \\"produced\\": 1,\\n \\"name\\": \\"lsh_test_1\\",\\n \\"instanceId\\": \\"1\\",\\n \\"quota\\": {\\n \\"spec\\": \\"opensearch.share.common\\",\\n \\"docSize\\": 1,\\n \\"computeResource\\": 20\\n },\\n \\"engineType\\": \\"ha3\\",\\n \\"resourceGroupId\\": \\"rg-acfmoiyerh6nzly\\"\\n }\\n}","errorExample":""},{"type":"xml","example":"0A6EB64B-B4C8-CF02-810F-E660812972FF\\n\\n 110116134\\n os_function_test_v1\\n 110116134\\n 0\\n \\n 1\\n 20\\n opensearch.share.common\\n \\n 1\\n enhanced\\n \\n POSTPAY\\n \\n \\n opensearch\\n \\n 0\\n 0\\n 0\\n \\n 1\\n 0\\n 0\\n 1575442875\\n 1578916076\\n normal\\n Unlock\\n","errorExample":""}]', - 'title' => 'ModifyAppGroupQuota', + 'title' => 'CreateABTestExperiment', + 'summary' => 'Creates an experiment.', 'requestParamsDescription' => '**Request body**'."\n" ."\n" - .'|Parameter|Type|Required|Example|Description|'."\n" - .'|---|---|---|---|---|'."\n" - .'|docSize|Integer|Yes|1|The storage capacity (Unit: GB). Shared general-purpose (1 to 300 GB).|'."\n" - .'|computeResource|Integer|Yes|20|The computing resources (unit: LCUs). Shared general-purpose (20 to 5000 LCUs).|'."\n" - .'|spec|String|Yes|"opensearch.share.common"|The specifications.|'."\n" - .'|orderType|String|No|"UPGRADE"|The type of specification change. Valid values:UPGRADE: specification upgradeDOWNGRADE: specification downgrade|'."\n" - ."\n" - .'For more information, see [Quota](~~170001~~).', + .'| Parameter | Type | Required | Example | Description |'."\n" + .'| --------- | ------- | -------- | ------------------------------- | -------------------------------------------------------------------------------------- |'."\n" + .'| name | String | Yes | "my_test" | The experiment name. |'."\n" + .'| traffic | Integer | Yes | 30 | The percentage of traffic to route to the experiment. |'."\n" + .'| online | Boolean | Yes | true | Specifies whether the experiment is in effect. |'."\n" + .'| params | Object | Yes | {"firstFormulaName": "default"} | The experiment configuration. For more information, see [ABTestExperiment](~~173617~~) |', 'responseParamsDescription' => ' ', - ], - 'RemoveAppGroup' => [ - 'summary' => 'Deletes an OpenSearch application.', - 'path' => '/v4/openapi/app-groups/{appGroupIdentity}', - 'methods' => [ - 'delete', + 'extraInfo' => ' ', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'opensearch:CreateApp', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'OpenSearch', 'resourceType' => 'AbTestExperiment', 'arn' => 'acs:opensearch:{#regionId}:{#accountId}:apps/{#AppGroupId}'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"D77D0DAF-790D-F5F5-A9C0-133738165014\\",\\n \\"result\\": {\\n \\"created\\": 0,\\n \\"params\\": {\\n \\"firstFormulaName\\": \\"default\\"\\n },\\n \\"traffic\\": 30,\\n \\"online\\": true,\\n \\"name\\": \\"test3\\",\\n \\"updated\\": 1589017861,\\n \\"id\\": \\"12889\\"\\n }\\n}","type":"json"}]', + 'translator' => 'manual', + ], + 'CreateABTestGroup' => [ + 'path' => '/v4/openapi/app-groups/{appGroupIdentity}/scenes/{sceneId}/groups', + 'methods' => ['post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'write', + 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'delete', + 'operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREopensearch447AAX', - 'FEATUREopensearch5OZOSP', - ], + 'abilityTreeNodes' => ['FEATUREopensearchE07IML'], ], 'parameters' => [ [ 'name' => 'appGroupIdentity', 'in' => 'path', - 'schema' => [ - 'description' => 'The name of the application'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '121001650', - ], + 'schema' => ['description' => 'The name of the application.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'title' => '', 'example' => 'my_app_group_name'], + ], + [ + 'name' => 'sceneId', + 'in' => 'path', + 'schema' => ['description' => 'The scenario ID.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '999999999', 'minimum' => '-1', 'title' => '', 'example' => '20404'], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'schema' => ['description' => 'The request body. For more information, see [ABTestGroup](~~178935~~).', 'required' => false, '$ref' => '#/components/schemas/ABTestGroup', 'title' => '', 'example' => ''], + ], + [ + 'name' => 'dryRun', + 'in' => 'query', + 'schema' => ['description' => 'Specifies whether to check the validity of the input parameters. The default value is false.'."\n" + ."\n" + .'Valid values:'."\n" + ."\n" + .'- **true**: checks only the validity of the input parameters.'."\n" + ."\n" + .'- **false**: checks the validity of the input parameters and creates an attribution configuration.', 'type' => 'boolean', 'required' => false, 'title' => '', 'example' => 'true'], ], ], 'responses' => [ @@ -1639,454 +907,203 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'requestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '3AA29D02-54F3-8569-F71A-90E1B7BE4E7E', - ], + 'requestId' => ['description' => 'The request ID.', 'type' => 'string', 'title' => '', 'example' => 'D77D0DAF-790D-F5F5-A9C0-133738165014'], 'result' => [ - 'description' => 'The returned results.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The returned result.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '[]', - ], - ], + 'description' => 'The returned results.', + 'type' => 'object', + 'properties' => [ + 'created' => ['description' => 'The time when the experiment group was created.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '1588839490'], + 'status' => ['description' => 'The status of the experiment group.'."\n" + ."\n" + .'- 0: Inactive'."\n" + ."\n" + .'- 1: Active', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '1'], + 'updated' => ['description' => 'The time when the experiment group was last updated.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '1588839490'], + 'name' => ['description' => 'The alias of the group.', 'type' => 'string', 'title' => '', 'example' => 'Group_2020-5-7_15:23:3'], + 'id' => ['description' => 'The ID of the group.', 'type' => 'string', 'title' => '', 'example' => '13466'], + ], + 'title' => '', + 'example' => '', + ], ], 'description' => '', + 'title' => '', + 'example' => '', ], ], '5XX' => [ 'schema' => [ 'type' => 'object', 'properties' => [ - 'code' => [ - 'type' => 'string', - ], - 'message' => [ - 'type' => 'string', - ], - 'requestId' => [ - 'type' => 'string', - ], - 'httpCode' => [ - 'type' => 'integer', - 'format' => 'int32', - ], + 'code' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'message' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'requestId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'httpCode' => ['type' => 'integer', 'format' => 'int32', 'description' => '', 'title' => '', 'example' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"3AA29D02-54F3-8569-F71A-90E1B7BE4E7E\\",\\n \\"result\\": [\\n 0\\n ]\\n}","type":"json"}]', - 'title' => 'RemoveAppGroup', - 'description' => 'You can delete only pay-as-you-go applications. You cannot delete subscription applications.'."\n", - ], - 'ListAppGroups' => [ - 'summary' => 'Queries a list of OpenSearch applications.', - 'path' => '/v4/openapi/app-groups', - 'methods' => [ - 'get', + 'title' => 'CreateABTestGroup', + 'summary' => 'Creates an experiment group.', + 'requestParamsDescription' => '**Request body**'."\n" + ."\n" + .'| Parameter | Type | Required | Example | Description |'."\n" + .'| --------- | ------ | -------- | ------------ | --------------------------------- |'."\n" + .'| name | String | Yes | "kevintest3" | The name of the experiment group. |', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'opensearch:CreateApp', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'OpenSearch', 'resourceType' => 'AbTestGroup', 'arn' => 'acs:opensearch:{#regionId}:{#accountId}:apps/{#AppGroupId}'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"D77D0DAF-790D-F5F5-A9C0-133738165014\\",\\n \\"result\\": {\\n \\"created\\": 1588839490,\\n \\"status\\": 1,\\n \\"updated\\": 1588839490,\\n \\"name\\": \\"Group_2020-5-7_15:23:3\\",\\n \\"id\\": \\"13466\\"\\n }\\n}","type":"json"}]', + 'translator' => 'manual', + ], + 'CreateABTestScene' => [ + 'summary' => 'Creates an experiment scenario.', + 'path' => '/v4/openapi/app-groups/{appGroupIdentity}/scenes', + 'methods' => ['post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', + 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'list', + 'operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeCode' => '55205', - 'abilityTreeNodes' => [ - 'FEATUREopensearchGVH0IN', - 'FEATUREopensearch447AAX', - 'FEATUREopensearch5OZOSP', - ], + 'abilityTreeNodes' => ['FEATUREopensearchE07IML'], ], 'parameters' => [ [ - 'name' => 'pageNumber', - 'in' => 'query', - 'schema' => [ - 'description' => 'The page number. Default value: 1.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', - ], - ], - [ - 'name' => 'pageSize', - 'in' => 'query', - 'schema' => [ - 'description' => 'The number of entries per page. Default value: 10.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '10', - ], - ], - [ - 'name' => 'instanceId', - 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the instance. Exact match is used.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'ops-cn-xxxx', - ], - ], - [ - 'name' => 'name', - 'in' => 'query', - 'schema' => [ - 'description' => 'The name of the application.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'my_name', - ], - ], - [ - 'name' => 'type', - 'in' => 'query', - 'schema' => [ - 'description' => 'The type of the application. Valid values:'."\n" - ."\n" - .'* standard: a High-performance Search Edition application.'."\n" - .'* enhanced: an Industry Algorithm Edition application.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'standard', - ], - ], - [ - 'name' => 'sortBy', - 'in' => 'query', - 'schema' => [ - 'description' => 'The method based on which applications are sorted. Valid values:'."\n" - ."\n" - .'* 0: sorts applications in descending order by creation time.'."\n" - .'* 1: sorts applications in descending order by modification time.'."\n" - ."\n" - .'Default value: 0.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '0', - ], + 'name' => 'appGroupIdentity', + 'in' => 'path', + 'schema' => ['description' => 'The name of the application group.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'title' => '', 'example' => 'my_app_group_name'], ], [ - 'name' => 'resourceGroupId', - 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the resource group.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '"110123123"', - ], + 'name' => 'body', + 'in' => 'body', + 'schema' => ['description' => 'The A/B test scene. For more information, see [ABTestScene](~~173618~~).', 'required' => false, '$ref' => '#/components/schemas/ABTestScene', 'title' => '', 'example' => ''], ], [ - 'name' => 'tags', + 'name' => 'dryRun', 'in' => 'query', - 'style' => 'json', - 'schema' => [ - 'description' => 'The tags.'."\n", - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'key' => [ - 'description' => 'The tag key.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'foo', - ], - 'value' => [ - 'description' => 'The tag value.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'bar', - ], - ], - 'required' => false, - 'description' => 'The tag dictionary. ', - ], - 'required' => false, - ], + 'schema' => ['description' => 'Specifies whether to validate only the request parameters. The default value is false.'."\n" + ."\n" + .'Values:'."\n" + ."\n" + .'- **true**: Validates only the request parameters.'."\n" + ."\n" + .'- **false**: Validates the request parameters and creates the attribution configuration.', 'type' => 'boolean', 'required' => false, 'title' => '', 'example' => 'false'], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'description' => 'The response body.'."\n", 'type' => 'object', 'properties' => [ - 'totalCount' => [ - 'description' => 'The total number of entries returned.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'requestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '0A6EB64B-B4C8-CF02-810F-E660812972FF', - ], + 'requestId' => ['description' => 'The request ID.', 'type' => 'string', 'title' => '', 'example' => 'D77D0DAF-790D-F5F5-A9C0-133738165014'], 'result' => [ - 'description' => 'The information about the application.'."\n" - ."\n" - .'For more information, see [AppGroup](~~170000~~).'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The result body.'."\n", - 'type' => 'object', - 'properties' => [ - 'created' => [ - 'description' => 'The timestamp when the application was created.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1575442875', - ], - 'currentVersion' => [ - 'description' => 'The ID of the current online version.'."\n", - 'type' => 'string', - 'example' => '110116134', - ], - 'lockMode' => [ - 'description' => 'The lock state. Valid values:'."\n" - ."\n" - .'* Unlock: The instance is unlocked.'."\n" - .'* LockByExpiration: The instance is automatically locked after it expires.'."\n" - .'* ManualLock: The instance is manually locked.'."\n", - 'type' => 'string', - 'example' => 'Unlock', - ], - 'updated' => [ - 'description' => 'The timestamp when the application was last updated.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1578916076', - ], - 'id' => [ - 'description' => 'The application ID.'."\n", - 'type' => 'string', - 'example' => '110116134', - ], - 'chargeType' => [ - 'description' => 'The billing method. Valid values:'."\n" - ."\n" - .'* POSTPAY: pay-as-you-go.'."\n" - .'* PREPAY: subscription.'."\n", - 'type' => 'string', - 'example' => 'POSTPAY', - ], - 'hasPendingQuotaReviewTask' => [ - 'description' => 'The approval state of the quotas. Valid values:'."\n" - ."\n" - .'* 0: The application is in service.'."\n" - .'* 1: The quotas are being reviewed.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '0', - ], - 'name' => [ - 'description' => 'The application name.'."\n", - 'type' => 'string', - 'example' => 'os_function_test_v1', - ], - 'instanceId' => [ - 'description' => 'The instance ID.'."\n", - 'type' => 'string', - 'example' => '"xxx"', - ], - 'chargingWay' => [ - 'description' => 'The billable item. Valid values:'."\n" - ."\n" - .'* 1: computing resources.'."\n" - .'* 2: queries per second (QPS).'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'type' => [ - 'description' => 'The type of the application. Valid values:'."\n" - ."\n" - .'* standard: a High-performance Search Edition application.'."\n" - .'* enhanced: an Industry Algorithm Edition application.', - 'type' => 'string', - 'example' => 'enhanced', - ], - 'status' => [ - 'description' => 'The state of the application. Valid values:'."\n" - ."\n" - .'* producing: The application is being created.'."\n" - .'* review_pending: The application is being reviewed.'."\n" - .'* config_pending: The application is to be configured.'."\n" - .'* normal: The application is in service.'."\n" - .'* frozen: The application is frozen.'."\n", - 'type' => 'string', - 'example' => 'normal', - ], - 'projectId' => [ - 'description' => 'The name of the A/B test group.'."\n", - 'type' => 'string', - 'example' => '"xxx"', - ], - 'switchedTime' => [ - 'description' => 'The timestamp when the current online version was published.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '0', - ], - 'commodityCode' => [ - 'description' => 'The commodity code.'."\n", - 'type' => 'string', - 'example' => 'opensearch', - ], - 'expireOn' => [ - 'description' => 'The time when the application expired.'."\n", - 'type' => 'string', - 'example' => '"xxx"', - ], - 'domain' => [ - 'description' => 'The industry of the application.'."\n", - 'type' => 'string', - 'example' => '""', - ], - 'description' => [ - 'description' => 'The description of the application.'."\n", - 'type' => 'string', - 'example' => '"xxx"', - ], - 'produced' => [ - 'description' => 'Indicates whether the application is created. Valid values:'."\n" - ."\n" - .'* 0: The application is being created.'."\n" - .'* 1: The application is created.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'lockedByExpiration' => [ - 'description' => 'Indicates whether the instance is automatically locked after it expires.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '0', - ], - 'quota' => [ - 'description' => 'The information about the quotas of the application. For more information, see [Quota](~~170001~~).'."\n", - 'type' => 'object', - 'properties' => [ - 'spec' => [ - 'description' => 'The specifications. Valid values:'."\n" - ."\n" - .'* opensearch.share.junior: basic.'."\n" - .'* opensearch.share.common: shared general-purpose.'."\n" - .'* opensearch.share.compute: shared computing.'."\n" - .'* opensearch.share.storage: shared storage.'."\n" - .'* opensearch.private.common: exclusive general-purpose.'."\n" - .'* opensearch.private.compute: exclusive computing.'."\n" - .'* opensearch.private.storage: exclusive storage.'."\n", - 'type' => 'string', - 'example' => 'opensearch.share.common', - ], - 'docSize' => [ - 'description' => 'The storage capacity. Unit: GB.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'computeResource' => [ - 'description' => 'The computing resources. Unit: logical computing unit (LCU).'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '20', - ], - ], - 'example' => '{}', - ], - 'tags' => [ - 'description' => 'The application tags.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The tag dictionary.', - 'type' => 'object', - 'properties' => [ - 'key' => [ - 'description' => 'The tag key.'."\n", - 'type' => 'string', - 'example' => 'foo', - ], - 'value' => [ - 'description' => 'The tag value.'."\n", - 'type' => 'string', - 'example' => 'bar', - ], - ], - ], - ], - 'engineType' => [ - 'description' => 'The engine type.'."\n", - 'type' => 'string', - 'example' => 'ha3', - ], + 'description' => 'The result of the request.', + 'type' => 'object', + 'properties' => [ + 'created' => ['description' => 'The time when the scene was created.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '0'], + 'status' => ['description' => 'The status of the scene. Valid values:'."\n" + ."\n" + .'- 0: disabled'."\n" + ."\n" + .'- 1: enabled', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '1'], + 'updated' => ['description' => 'The time when the scene was last updated.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '1589012351'], + 'name' => ['description' => 'The name of the group.', 'type' => 'string', 'title' => '', 'example' => 'kevintest_2020-5-7_15:21:48'], + 'id' => ['description' => 'The ID of the group.', 'type' => 'string', 'title' => '', 'example' => '20405'], + 'values' => [ + 'description' => 'The IDs of the scenes.', + 'type' => 'array', + 'items' => ['description' => 'The ID of a scene.', 'type' => 'string', 'title' => '', 'example' => '[ "kevintest" ]'], + 'title' => '', + 'example' => '', ], - 'example' => '{}', ], - 'example' => '[]', + 'title' => '', + 'example' => '', ], ], - 'example' => '{}', + 'description' => '', + 'title' => '', + 'example' => '', ], ], '5XX' => [ 'schema' => [ 'type' => 'object', 'properties' => [ - 'code' => [ - 'type' => 'string', - ], - 'message' => [ - 'type' => 'string', - ], - 'requestId' => [ - 'type' => 'string', - ], - 'httpCode' => [ - 'type' => 'integer', - 'format' => 'int32', - ], + 'code' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'message' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'requestId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'httpCode' => ['type' => 'integer', 'format' => 'int32', 'description' => '', 'title' => '', 'example' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"totalCount\\": 1,\\n \\"requestId\\": \\"0A6EB64B-B4C8-CF02-810F-E660812972FF\\",\\n \\"result\\": [\\n {\\n \\"created\\": 1575442875,\\n \\"currentVersion\\": \\"110116134\\",\\n \\"lockMode\\": \\"Unlock\\",\\n \\"updated\\": 1578916076,\\n \\"id\\": \\"110116134\\",\\n \\"chargeType\\": \\"POSTPAY\\",\\n \\"hasPendingQuotaReviewTask\\": 0,\\n \\"name\\": \\"os_function_test_v1\\",\\n \\"instanceId\\": \\"\\\\\\"xxx\\\\\\"\\",\\n \\"chargingWay\\": 1,\\n \\"type\\": \\"enhanced\\",\\n \\"status\\": \\"normal\\",\\n \\"projectId\\": \\"\\\\\\"xxx\\\\\\"\\",\\n \\"switchedTime\\": 0,\\n \\"commodityCode\\": \\"opensearch\\",\\n \\"expireOn\\": \\"\\\\\\"xxx\\\\\\"\\",\\n \\"domain\\": \\"\\\\\\"\\\\\\"\\",\\n \\"description\\": \\"\\\\\\"xxx\\\\\\"\\",\\n \\"produced\\": 1,\\n \\"lockedByExpiration\\": 0,\\n \\"quota\\": {\\n \\"spec\\": \\"opensearch.share.common\\",\\n \\"docSize\\": 1,\\n \\"computeResource\\": 20\\n },\\n \\"tags\\": [\\n {\\n \\"key\\": \\"foo\\",\\n \\"value\\": \\"bar\\"\\n }\\n ],\\n \\"engineType\\": \\"ha3\\"\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"0A6EB64B-B4C8-CF02-810F-E660812972FF\\n1\\n\\n 110116134\\n os_function_test_v1\\n 110116134\\n 0\\n \\n 1\\n 20\\n opensearch.share.common\\n \\n 1\\n enhanced\\n \\n POSTPAY\\n \\n \\n opensearch\\n \\n 0\\n 0\\n 0\\n \\n 1\\n 0\\n 0\\n 1575442875\\n 1578916076\\n normal\\n Unlock\\n","errorExample":""}]', - 'title' => 'ListAppGroups', - 'description' => '* This operation allows you to query applications by application name, instance ID, and application type.'."\n" - .'* This operation allows you to sort the applications based on their creation time.'."\n" - .'* This operation supports the parameters for paging.'."\n", - 'requestParamsDescription' => ' ', + 'title' => 'CreateABTestScene', + 'requestParamsDescription' => '**Request body**'."\n" + ."\n" + .'| Parameter | Type | Required | Example | Description |'."\n" + .'| --------- | ------- | -------- | ------------- | -------------------------------------------------------------------------------------------------- |'."\n" + .'| name | String | Yes | "kevintest22" | The name of the scene. |'."\n" + .'| status | Integer | No | 0 | The status of the scene. Valid values: 0: The experiment is stopped. 1: The experiment is running. |'."\n" + .'| created | Integer | No | 1589012351 | The time when the scene was created. |'."\n" + .'| updated | Integer | No | 1589012351 | The time when the scene was last updated. |'."\n" + .'| values[] | String | No | "kevintest22" | The ID of the scene. |', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'opensearch:CreateApp', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'OpenSearch', 'resourceType' => 'ABTestScenes', 'arn' => 'acs:opensearch:{#regionId}:{#accountId}:app-groups{#AppGroupId}'], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"D77D0DAF-790D-F5F5-A9C0-133738165014\\",\\n \\"result\\": {\\n \\"created\\": 0,\\n \\"status\\": 1,\\n \\"updated\\": 1589012351,\\n \\"name\\": \\"kevintest_2020-5-7_15:21:48\\",\\n \\"id\\": \\"20405\\",\\n \\"values\\": [\\n \\"[ \\\\\\"kevintest\\\\\\" ]\\"\\n ]\\n }\\n}","type":"json"}]', + 'translator' => 'manual', ], 'CreateApp' => [ - 'summary' => 'Creates a version for an OpenSearch application.', + 'summary' => 'Creates a new version of an OpenSearch application.', 'path' => '/v4/openapi/app-groups/{appGroupIdentity}/apps', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'methods' => ['post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -2099,803 +1116,552 @@ 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '55146', - 'abilityTreeNodes' => [ - 'FEATUREopensearch2ESE2N', - 'FEATUREopensearchG9QGQK', - 'FEATUREopensearchO36CPI', - ], + 'abilityTreeNodes' => ['FEATUREopensearch2ESE2N', 'FEATUREopensearchG9QGQK', 'FEATUREopensearchO36CPI'], ], 'parameters' => [ [ 'name' => 'appGroupIdentity', 'in' => 'path', - 'schema' => [ - 'description' => 'The name of the application'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'my_app_group_name', - ], + 'schema' => ['description' => 'The name of the application.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'my_app_group_name', 'title' => ''], ], [ 'name' => 'dryRun', 'in' => 'query', - 'schema' => [ - 'description' => 'Specifies whether to perform a dry run. This parameter is only used to check whether the data source is valid. Valid values: true and false.'."\n", - 'type' => 'boolean', - 'required' => false, - 'example' => 'true', - ], + 'schema' => ['description' => 'Specifies whether to perform a dry run. A dry run checks the validity of the data source but does not create the application. Valid values: true and false.', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'title' => ''], ], [ 'name' => 'body', 'in' => 'body', 'style' => 'json', 'schema' => [ - 'description' => 'The request body.'."\n", + 'description' => 'The request body.', 'type' => 'object', 'properties' => [ - 'autoSwitch' => [ - 'description' => 'Specifies whether to automatically switch the created version to an online version. Valid values:'."\n" - ."\n" - .'* true'."\n" - .'* false'."\n", - 'type' => 'boolean', - 'required' => false, - 'example' => 'false', - ], - 'networkType' => [ - 'description' => 'The zone identifier. Valid values:'."\n" - ."\n" - .'* vpc'."\n" - .'* oxs'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'vpc', - ], - 'description' => [ - 'description' => 'The version description.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '"Version description"'."\n", - ], + 'autoSwitch' => ['description' => 'Specifies whether to automatically set the new version as the online version after it is created.'."\n" + ."\n" + .'- true'."\n" + ."\n" + .'- false', 'type' => 'boolean', 'required' => false, 'example' => 'false', 'title' => ''], + 'networkType' => ['description' => 'The network type. Valid values:'."\n" + ."\n" + .'- vpc'."\n" + ."\n" + .'- oxs', 'type' => 'string', 'required' => false, 'example' => 'vpc', 'title' => ''], + 'description' => ['description' => 'The description of the version.', 'type' => 'string', 'example' => '"version description"', 'required' => false, 'title' => ''], 'schema' => [ - 'description' => 'The single-table schema.'."\n", + 'description' => 'The schema of the single-table application.', 'type' => 'object', 'properties' => [ - 'tables' => [ - 'description' => 'The table schema.'."\n", + 'tables' => ['description' => 'The table schema.', 'type' => 'object', 'required' => false, 'example' => '{'."\n" + .' "primaryTable": true,'."\n" + .' "name": "main",'."\n" + .' "fields": {'."\n" + .' "id": {'."\n" + .' "name": "id",'."\n" + .' "type": "LITERAL",'."\n" + .' "primaryKey": true'."\n" + .' },'."\n" + .' "title": {'."\n" + .' "name": "title",'."\n" + .' "type": "TEXT",'."\n" + .' "primaryKey": false'."\n" + .' },'."\n" + .' "buy": {'."\n" + .' "name": "buy",'."\n" + .' "type": "INT",'."\n" + .' "primaryKey": false'."\n" + .' },'."\n" + .' "cate_id": {'."\n" + .' "name": "cate_id",'."\n" + .' "type": "INT",'."\n" + .' "primaryKey": false'."\n" + .' },'."\n" + .' "cate_name": {'."\n" + .' "name": "cate_name",'."\n" + .' "type": "LITERAL",'."\n" + .' "primaryKey": false'."\n" + .' }'."\n" + .' }'."\n" + .'}', 'title' => ''], + 'indexes' => [ + 'description' => 'The index schema.', 'type' => 'object', + 'properties' => [ + 'filterFields' => [ + 'description' => 'The attribute fields.', + 'type' => 'array', + 'items' => ['description' => 'The attribute field.', 'type' => 'string', 'required' => false, 'example' => 'id', 'title' => ''], + 'required' => false, + 'title' => '', + 'example' => '', + ], + 'searchFields' => ['description' => 'The index fields.', 'type' => 'object', 'required' => false, 'example' => '{'."\n" + .' "fields": ["title"],'."\n" + .' "analyzer": "chn_standard"'."\n" + .'}', 'title' => ''], + ], 'required' => false, - 'example' => '{'."\n" - .' "primaryTable": true,'."\n" - .' "name": "main",'."\n" - .' "fields": {'."\n" - .' "id": {'."\n" - .' "name": "id",'."\n" - .' "type": "LITERAL",'."\n" - .' "primaryKey": true'."\n" - .' },'."\n" - .' "title": {'."\n" - .' "name": "title",'."\n" - .' "type": "TEXT",'."\n" - .' "primaryKey": false'."\n" - .' },'."\n" - .' "buy": {'."\n" - .' "name": "buy",'."\n" - .' "type": "INT",'."\n" - .' "primaryKey": false'."\n" - .' },'."\n" - .' "cate_id": {'."\n" - .' "name": "cate_id",'."\n" - .' "type": "INT",'."\n" - .' "primaryKey": false'."\n" - .' },'."\n" - .' "cate_name": {'."\n" - .' "name": "cate_name",'."\n" - .' "type": "LITERAL",'."\n" - .' "primaryKey": false'."\n" - .' }'."\n" - .' }'."\n" - .'}', - ], - 'indexes' => [ - 'description' => 'The index schema.'."\n", - 'type' => 'object', - 'properties' => [ - 'filterFields' => [ - 'description' => 'The attribute fields.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The attribute field.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'id', - ], - 'required' => false, - ], - 'searchFields' => [ - 'description' => 'The index fields.'."\n", - 'type' => 'object', - 'required' => false, - 'example' => '{'."\n" - .' "fields": ["title"],'."\n" - .' "analyzer": "chn_standard"'."\n" - .'}', - ], - ], - 'required' => false, - ], - 'routeField' => [ - 'description' => 'The name of the level-1 routing field.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'field1', + 'title' => '', + 'example' => '', ], + 'routeField' => ['description' => 'The name of the level-1 routing field.', 'type' => 'string', 'required' => false, 'example' => 'field1', 'title' => ''], 'routeFieldValues' => [ - 'description' => 'The hot values of the level-1 routing field. After you configure this parameter, level-2 routing is enabled.'."\n", + 'description' => 'The list of hotspot values for the level-1 routing field. After you configure this parameter, level-2 routing is enabled.', 'type' => 'array', - 'items' => [ - 'description' => 'The hot value of the level-1 routing field.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'routeFieldValues', - ], + 'items' => ['description' => 'The hotspot value of the level-1 routing field.', 'type' => 'string', 'required' => false, 'example' => 'routeFieldValues', 'title' => ''], 'required' => false, + 'title' => '', + 'example' => '', ], - 'secondRouteField' => [ - 'description' => 'The name of the level-2 routing field. This parameter takes effect only when the `routeFieldValues` parameter is configured. By default, the wide-table primary key field is used as the level-2 routing field.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'field2', - ], + 'secondRouteField' => ['description' => 'The name of the level-2 routing field. This parameter takes effect only when `routeFieldValues` is configured. By default, the primary key of the wide table is used.', 'type' => 'string', 'required' => false, 'example' => 'field2', 'title' => ''], 'ttlField' => [ - 'description' => 'The document clearing configurations.'."\n", + 'description' => 'The document expiration configuration.', 'type' => 'object', 'properties' => [ - 'name' => [ - 'description' => 'The name of the document time field.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'text1', - ], - 'ttl' => [ - 'description' => 'The TTL. Unit: milliseconds.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '1000', - ], + 'name' => ['description' => 'The document time field.', 'type' => 'string', 'required' => false, 'example' => 'text1', 'title' => ''], + 'ttl' => ['description' => 'The time to live (TTL), in milliseconds.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1000', 'title' => ''], ], 'required' => false, + 'title' => '', + 'example' => '', ], 'indexSortConfig' => [ - 'description' => 'The sort configurations.'."\n", + 'description' => 'The inverted index configurations.', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ - 'field' => [ - 'description' => 'The sort field.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'field1', - ], - 'direction' => [ - 'description' => 'The sort method.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'ASC;'."\n" - .'DESC;', - ], + 'field' => ['description' => 'The sort field.', 'type' => 'string', 'required' => false, 'example' => 'field1', 'title' => ''], + 'direction' => ['description' => 'The sort order.', 'type' => 'string', 'required' => false, 'example' => 'ASC;'."\n" + .'DESC;', 'title' => ''], ], 'required' => false, 'description' => '', - 'title' => '倒排索引配置', + 'title' => '', + 'example' => '', ], 'required' => false, + 'title' => '', + 'example' => '', ], - 'name' => [ - 'description' => 'The name of the wide table.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'table_name', - ], + 'name' => ['description' => 'The name of the wide table.', 'type' => 'string', 'required' => false, 'example' => 'table_name', 'title' => ''], ], 'required' => false, + 'title' => '', + 'example' => '', ], 'schemas' => [ - 'description' => 'The multi-table schema.'."\n", + 'description' => 'The schema of the multi-table application.', 'type' => 'array', 'items' => [ - 'description' => 'The single-table schema.'."\n", + 'description' => 'The schema of the single-table application.', 'type' => 'object', 'properties' => [ - 'tables' => [ - 'description' => 'The table schema.'."\n", - 'type' => 'object', - 'required' => false, - 'example' => '{'."\n" - .' "primaryTable": true,'."\n" - .' "name": "main",'."\n" - .' "fields": {'."\n" - .' "id": {'."\n" - .' "name": "id",'."\n" - .' "type": "LITERAL",'."\n" - .' "primaryKey": true'."\n" - .' },'."\n" - .' "title": {'."\n" - .' "name": "title",'."\n" - .' "type": "TEXT",'."\n" - .' "primaryKey": false'."\n" - .' },'."\n" - .' "buy": {'."\n" - .' "name": "buy",'."\n" - .' "type": "INT",'."\n" - .' "primaryKey": false'."\n" - .' },'."\n" - .' "cate_id": {'."\n" - .' "name": "cate_id",'."\n" - .' "type": "INT",'."\n" - .' "primaryKey": false'."\n" - .' },'."\n" - .' "cate_name": {'."\n" - .' "name": "cate_name",'."\n" - .' "type": "LITERAL",'."\n" - .' "primaryKey": false'."\n" - .' }'."\n" - .' }'."\n" - .'}', - ], + 'tables' => ['description' => 'The table schema.', 'type' => 'object', 'required' => false, 'example' => '{'."\n" + .' "primaryTable": true,'."\n" + .' "name": "main",'."\n" + .' "fields": {'."\n" + .' "id": {'."\n" + .' "name": "id",'."\n" + .' "type": "LITERAL",'."\n" + .' "primaryKey": true'."\n" + .' },'."\n" + .' "title": {'."\n" + .' "name": "title",'."\n" + .' "type": "TEXT",'."\n" + .' "primaryKey": false'."\n" + .' },'."\n" + .' "buy": {'."\n" + .' "name": "buy",'."\n" + .' "type": "INT",'."\n" + .' "primaryKey": false'."\n" + .' },'."\n" + .' "cate_id": {'."\n" + .' "name": "cate_id",'."\n" + .' "type": "INT",'."\n" + .' "primaryKey": false'."\n" + .' },'."\n" + .' "cate_name": {'."\n" + .' "name": "cate_name",'."\n" + .' "type": "LITERAL",'."\n" + .' "primaryKey": false'."\n" + .' }'."\n" + .' }'."\n" + .'}', 'title' => ''], 'indexes' => [ - 'description' => 'The index schema.'."\n", + 'description' => 'The index schema.', 'type' => 'object', 'properties' => [ 'filterFields' => [ - 'description' => 'The attribute fields.'."\n", + 'description' => 'The attribute fields.', 'type' => 'array', - 'items' => [ - 'description' => 'The attribute field.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'id', - ], + 'items' => ['description' => 'The attribute field.', 'type' => 'string', 'required' => false, 'example' => 'id', 'title' => ''], 'required' => false, + 'title' => '', + 'example' => '', ], - 'searchFields' => [ - 'description' => 'The index fields.'."\n", - 'type' => 'object', - 'required' => false, - 'example' => '{'."\n" - .' "fields": ["title"],'."\n" - .' "analyzer": "chn_standard"'."\n" - .'}', - ], + 'searchFields' => ['description' => 'The index fields.', 'type' => 'object', 'required' => false, 'example' => '{'."\n" + .' "fields": ["title"],'."\n" + .' "analyzer": "chn_standard"'."\n" + .'}', 'title' => ''], ], 'required' => false, + 'title' => '', + 'example' => '', ], - 'routeField' => [ - 'description' => 'The name of the level-1 routing field.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'field1', - ], + 'routeField' => ['description' => 'The name of the level-1 routing field.', 'type' => 'string', 'required' => false, 'example' => 'field1', 'title' => ''], 'routeFieldValues' => [ - 'description' => 'The hot values of the level-1 routing field. After you configure this parameter, level-2 routing is enabled.'."\n", + 'description' => 'The list of hotspot values for the level-1 routing field. After you configure this parameter, level-2 routing is enabled.', 'type' => 'array', - 'items' => [ - 'description' => 'The hot value of the level-1 routing field.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'routeFieldValues'."\n", - ], - 'required' => false, - ], - 'secondRouteField' => [ - 'description' => 'The name of the level-2 routing field. This parameter takes effect only when the routeFieldValues parameter is configured. By default, the wide-table primary key field is used as the level-2 routing field.'."\n", - 'type' => 'string', + 'items' => ['description' => 'The hotspot value of the level-1 routing field.', 'type' => 'string', 'required' => false, 'example' => 'routeFieldValues'."\n", 'title' => ''], 'required' => false, - 'example' => 'field2', + 'title' => '', + 'example' => '', ], + 'secondRouteField' => ['description' => 'The name of the level-2 routing field. This parameter takes effect only when routeFieldValues is configured. By default, the primary key of the wide table is used.', 'type' => 'string', 'required' => false, 'example' => 'field2', 'title' => ''], 'ttlField' => [ - 'description' => 'The document clearing configurations.'."\n", + 'description' => 'The document expiration configuration.', 'type' => 'object', 'properties' => [ - 'name' => [ - 'description' => 'The name of the document time field.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'text1', - ], - 'ttl' => [ - 'description' => 'The TTL. Unit: milliseconds.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '1000', - ], + 'name' => ['description' => 'The document time field.', 'type' => 'string', 'required' => false, 'example' => 'text1', 'title' => ''], + 'ttl' => ['description' => 'The time to live (TTL), in milliseconds.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1000', 'title' => ''], ], 'required' => false, + 'title' => '', + 'example' => '', ], 'indexSortConfig' => [ - 'description' => 'The sort configurations.'."\n", + 'description' => 'The inverted index configurations.', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ - 'field' => [ - 'description' => 'The sort field.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'field1', - ], - 'direction' => [ - 'description' => 'The sort method.'."\n" - ."\n" - .'* ASC'."\n" - .'* DESC'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'DESC', - ], + 'field' => ['description' => 'The sort field.', 'type' => 'string', 'required' => false, 'example' => 'field1', 'title' => ''], + 'direction' => ['description' => 'The sort order.'."\n" + ."\n" + .'- ASC'."\n" + ."\n" + .'- DESC', 'type' => 'string', 'required' => false, 'example' => 'DESC', 'title' => ''], ], 'required' => false, 'description' => '', - 'title' => '倒排索引配置', + 'title' => '', + 'example' => '', ], 'required' => false, 'title' => '', + 'example' => '', ], - 'name' => [ - 'description' => 'The name of the wide table.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'table_name', - ], + 'name' => ['description' => 'The name of the wide table.', 'type' => 'string', 'required' => false, 'example' => 'table_name', 'title' => ''], ], 'required' => false, + 'title' => '', + 'example' => '', ], 'required' => false, + 'title' => '', + 'example' => '', ], 'firstRanks' => [ - 'description' => 'The configurations of rough sort.'."\n", + 'description' => 'The rough sort configurations.', 'type' => 'array', 'items' => [ - 'description' => 'The configurations of rough sort.'."\n", + 'description' => 'The rough sort configurations.', 'type' => 'object', 'properties' => [ - 'type' => [ - 'description' => 'The expression type. Valid values:'."\n" - ."\n" - .'* STRUCT: The content of the expression is a structure.'."\n" - .'* STRING (default): You can configure a custom formula.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'STRING', - ], - 'name' => [ - 'description' => 'The name of the rough sort expression.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'test', - ], - 'description' => [ - 'description' => 'The description.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'Description'."\n", - ], - 'active' => [ - 'description' => 'Specifies whether the expression is the default one.'."\n", - 'type' => 'boolean', - 'required' => false, - 'example' => 'False', - ], - 'meta' => [ - 'description' => 'The information about the expression. The information can be of the array or string type.'."\n", - 'type' => 'any', - 'required' => false, - 'example' => 'String :"random()*100+now()";'."\n" - .'Array: ['."\n" - .' {'."\n" - .' "attribute": "static_bm25()",'."\n" - .' "arg": "",'."\n" - .' "weight": 10'."\n" - .' }'."\n" - .' ]', - ], + 'type' => ['description' => 'The type of the expression.'."\n" + ."\n" + .'- STRUCT: structured expression.'."\n" + ."\n" + .'- STRING: custom formula. This is the default value.', 'type' => 'string', 'required' => false, 'example' => 'STRING', 'title' => ''], + 'name' => ['description' => 'The name of the rough sort expression.', 'type' => 'string', 'required' => false, 'example' => 'test', 'title' => ''], + 'description' => ['description' => 'The description.', 'type' => 'string', 'example' => 'Description', 'required' => false, 'title' => ''], + 'active' => ['description' => 'Specifies whether the expression is the default one.', 'type' => 'boolean', 'required' => false, 'example' => 'False', 'title' => ''], + 'meta' => ['description' => 'The details of the expression. The value can be an array or a string.', 'type' => 'any', 'required' => false, 'example' => 'String :"random()*100+now()"；'."\n" + .'Array: ['."\n" + .' {'."\n" + .' "attribute": "static_bm25()",'."\n" + .' "arg": "",'."\n" + .' "weight": 10'."\n" + .' }'."\n" + .' ]', 'title' => ''], ], 'required' => false, + 'title' => '', + 'example' => '', ], 'required' => false, + 'title' => '', + 'example' => '', ], 'secondRanks' => [ - 'description' => 'The configurations of fine sort.'."\n", + 'description' => 'The fine sort configurations.', 'type' => 'array', 'items' => [ - 'description' => 'The configurations of fine sort.'."\n", + 'description' => 'The fine sort configurations.', 'type' => 'object', 'properties' => [ - 'meta' => [ - 'description' => 'The fine sort expression. You can define an expression that contains fields, feature functions, and mathematical functions to implement complex sort logic.'."\n", - 'type' => 'any', - 'required' => false, - 'example' => '"cate_id > 0 and cate_id < 1000"', - ], - 'name' => [ - 'description' => 'The name of the fine sort expression.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'default', - ], - 'description' => [ - 'description' => 'The description.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'Description'."\n", - ], - 'active' => [ - 'description' => 'Specifies whether the expression is the default one.'."\n", - 'type' => 'boolean', - 'required' => false, - 'example' => 'False', - ], + 'meta' => ['description' => 'The fine sort expression. You can write an expression that contains fields, feature functions, and mathematical functions to implement complex sort logic.', 'type' => 'any', 'required' => false, 'example' => '"cate_id > 0 and cate_id < 1000"', 'title' => ''], + 'name' => ['description' => 'The name of the fine sort expression.', 'type' => 'string', 'required' => false, 'example' => 'default', 'title' => ''], + 'description' => ['description' => 'The description.', 'type' => 'string', 'required' => false, 'example' => '描述', 'title' => ''], + 'active' => ['description' => 'Specifies whether the expression is the default one.', 'type' => 'boolean', 'required' => false, 'example' => 'False', 'title' => ''], ], 'required' => false, + 'title' => '', + 'example' => '', ], 'required' => false, + 'title' => '', + 'example' => '', ], 'dataSources' => [ - 'description' => 'The configurations of data sources.'."\n", + 'description' => 'The data source configurations.', 'type' => 'array', 'items' => [ - 'description' => 'The configurations of the data source.'."\n", + 'description' => 'The data source configurations.', 'type' => 'object', 'properties' => [ - 'tableName' => [ - 'description' => 'The name of the table in the application.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'main', - ], - 'type' => [ - 'description' => 'The type of the data source. Valid values:'."\n" - ."\n" - .'* rds'."\n" - .'* odps'."\n" - .'* opensearch'."\n" - .'* polardb'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'rds', - ], + 'tableName' => ['description' => 'The name of the application table.', 'type' => 'string', 'required' => false, 'example' => 'main', 'title' => ''], + 'type' => ['description' => 'The type of the data source.'."\n" + ."\n" + .'- rds'."\n" + ."\n" + .'- odps'."\n" + ."\n" + .'- opensearch'."\n" + ."\n" + .'- polardb', 'type' => 'string', 'required' => false, 'example' => 'rds', 'title' => ''], 'fields' => [ - 'description' => 'The information about field mappings.'."\n", + 'description' => 'The information about field mappings.', 'type' => 'array', - 'items' => [ - 'description' => 'The information about field mappings.'."\n", - 'type' => 'object', - 'required' => false, - 'example' => '{'."\n" - .' "id": "id"'."\n" - .' }', - ], - 'required' => false, - ], - 'plugins' => [ - 'description' => 'The plug-ins that are used for data processing.'."\n" - ."\n" - .'name:'."\n" - ."\n" - .'* JsonKeyValueExtractor'."\n" - .'* MultiValueSpliter'."\n" - .'* KeyValueExtractor'."\n" - .'* StringCatenateExtractor'."\n" - .'* HTMLTagRemover'."\n" - ."\n" - .'parameters:'."\n" - ."\n" - .'* JsonKeyValueExtractor'."\n" - .'* MultiValueSpliter'."\n" - .'* KeyValueExtractor'."\n" - .'* StringCatenateExtractor'."\n" - .'* HTMLTagRemover'."\n", - 'type' => 'object', - 'required' => false, - 'example' => '{'."\n" - .' "name": "JsonKeyValueExtractor",'."\n" - .' "parameters": {'."\n" - .' "key": "my_field"'."\n" - .'}'."\n" - .'}', - ], - 'keyField' => [ - 'description' => 'The primary key.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'id', - ], - 'schemaName' => [ - 'description' => 'The name of the wide table.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'table_name', - ], - 'parameters' => [ - 'description' => 'The information about the data source.'."\n", - 'type' => 'object', + 'items' => ['description' => 'The information about field mappings.', 'type' => 'object', 'required' => false, 'example' => '{'."\n" + .' "id": "id"'."\n" + .' }', 'title' => ''], 'required' => false, - 'example' => '{'."\n" - .' "instanceId": "rds-instance-id",'."\n" - .' "dbName": "my_db",'."\n" - .' "dbTableName": "my_table",'."\n" - .' "dbUser": "my",'."\n" - .' "dbPassword": "my_passwd",'."\n" - .' "filter":"",'."\n" - .' "autoSync": true'."\n" - .'}', + 'title' => '', + 'example' => '', ], + 'plugins' => ['description' => 'The data processing plugins for fields.'."\n" + ."\n" + .'Plugin name (name):'."\n" + ."\n" + .'- JsonKeyValueExtractor'."\n" + ."\n" + .'- MultiValueSpliter'."\n" + ."\n" + .'- KeyValueExtractor'."\n" + ."\n" + .'- StringCatenateExtractor'."\n" + ."\n" + .'- HTMLTagRemover'."\n" + ."\n" + .'Plugin parameters (parameters):'."\n" + ."\n" + .'- JsonKeyValueExtractor'."\n" + ."\n" + .'- MultiValueSpliter'."\n" + ."\n" + .'- KeyValueExtractor'."\n" + ."\n" + .'- StringCatenateExtractor'."\n" + ."\n" + .'- HTMLTagRemover', 'type' => 'object', 'required' => false, 'example' => '{'."\n" + .' "name": "JsonKeyValueExtractor",'."\n" + .' "parameters": {'."\n" + .' "key": "my_field"'."\n" + .'}'."\n" + .'}', 'title' => ''], + 'keyField' => ['description' => 'The primary key.', 'type' => 'string', 'required' => false, 'example' => 'id', 'title' => ''], + 'schemaName' => ['description' => 'The name of the wide table.', 'type' => 'string', 'required' => false, 'example' => 'table_name', 'title' => ''], + 'parameters' => ['description' => 'The information about the data source.', 'type' => 'object', 'required' => false, 'example' => '{'."\n" + .' "instanceId": "rds-instance-id",'."\n" + .' "dbName": "my_db",'."\n" + .' "dbTableName": "my_table",'."\n" + .' "dbUser": "my",'."\n" + .' "dbPassword": "my_passwd",'."\n" + .' "filter":"",'."\n" + .' "autoSync": true'."\n" + .'}', 'title' => ''], ], 'required' => false, + 'title' => '', + 'example' => '', ], 'required' => false, + 'title' => '', + 'example' => '', ], 'summaries' => [ - 'description' => 'The summary configurations of search results.'."\n", + 'description' => 'The search result summary settings.', 'type' => 'array', 'items' => [ - 'description' => 'The summary configurations of search results.'."\n", + 'description' => 'The search result summary settings.', 'type' => 'object', 'properties' => [ - 'name' => [ - 'description' => 'The group name.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'default', - ], + 'name' => ['description' => 'The group name.', 'type' => 'string', 'required' => false, 'example' => 'default', 'title' => ''], 'meta' => [ - 'description' => 'The collection of summary configurations.'."\n", + 'description' => 'The summary configurations.', 'type' => 'array', 'items' => [ - 'description' => 'The summary configurations.'."\n", + 'description' => 'The summary configuration.', 'type' => 'object', 'properties' => [ - 'field' => [ - 'description' => 'The field.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'field1', - ], - 'len' => [ - 'description' => 'The length of the segment. Valid values: 1 to 300.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '50', - ], - 'element' => [ - 'description' => 'The element that is used for highlighting.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'em', - ], - 'ellipsis' => [ - 'description' => 'The connector that is used to connect segments.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '...', - ], - 'snippet' => [ - 'description' => 'The number of segments. Valid values: 1 to 5.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '1', - ], + 'field' => ['description' => 'The field.', 'type' => 'string', 'required' => false, 'example' => 'field1', 'title' => ''], + 'len' => ['description' => 'The length of the snippet. The value must be in the range of \\[1, 300].', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '50', 'title' => ''], + 'element' => ['description' => 'The HTML tag for highlight.', 'type' => 'string', 'required' => false, 'example' => 'em', 'title' => ''], + 'ellipsis' => ['description' => 'The string used to connect snippets.', 'type' => 'string', 'required' => false, 'example' => '...', 'title' => ''], + 'snippet' => ['description' => 'The number of snippets. The value must be in the range of \\[1, 5].', 'type' => 'string', 'required' => false, 'example' => '1', 'title' => ''], ], 'required' => false, + 'title' => '', + 'example' => '', ], 'required' => false, + 'title' => '', + 'example' => '', ], ], 'required' => false, + 'title' => '', + 'example' => '', ], 'required' => false, + 'title' => '', + 'example' => '', ], 'fetchFields' => [ - 'description' => 'The default display fields.'."\n", + 'description' => 'The default display fields.', 'type' => 'array', - 'items' => [ - 'description' => 'The field.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'field1', - ], + 'items' => ['description' => 'The field.', 'type' => 'string', 'required' => false, 'example' => 'field1', 'title' => ''], 'required' => false, + 'title' => '', + 'example' => '', ], 'queryProcessors' => [ - 'description' => 'The query intent understanding configurations.'."\n", + 'description' => 'The intention recognition configurations.', 'type' => 'array', 'items' => [ - 'description' => 'The query intent understanding configurations.'."\n", + 'description' => 'The intention recognition configurations.', 'type' => 'object', 'properties' => [ - 'name' => [ - 'description' => 'The rule name.'."\n", - 'type' => 'string', + 'name' => ['description' => 'The rule name.', 'type' => 'string', 'required' => false, 'example' => 'name', 'title' => ''], + 'domain' => ['description' => 'The industry. Valid values:'."\n" + ."\n" + .'- GENERAL: general'."\n" + ."\n" + .'- ECOMMERCE: e-commerce'."\n" + ."\n" + .'- IT\\_CONTENT: IT content', 'type' => 'string', 'required' => false, 'example' => 'ECOMMERCE', 'title' => ''], + 'category' => ['description' => 'The industry category.', 'type' => 'string', 'required' => false, 'example' => '""', 'title' => ''], + 'processors' => [ + 'description' => 'The features that are included.', + 'type' => 'array', + 'items' => ['description' => 'The features that are included.', 'type' => 'object', 'required' => false, 'example' => '{'."\n" + .'"name": "stop_word", "useSystemDictionary": true,'."\n" + .'"interventionDictionary": "my_dict",'."\n" + .' "ignoreSpace": true'."\n" + .'}', 'title' => ''], 'required' => false, - 'example' => 'name', + 'title' => '', + 'example' => '', ], - 'domain' => [ - 'description' => 'The industry type. Valid values:'."\n" - ."\n" - .'* GENERAL'."\n" - .'* ECOMMERCE'."\n" - .'* IT_CONTENT'."\n", - 'type' => 'string', + 'indexes' => [ + 'description' => 'The indexes of the application.', + 'type' => 'array', + 'items' => ['description' => 'The application index.', 'type' => 'string', 'required' => false, 'example' => 'default', 'title' => ''], 'required' => false, - 'example' => 'ECOMMERCE', - ], - 'category' => [ - 'description' => 'The industry category.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '""', - ], - 'processors' => [ - 'description' => 'The features.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The feature.'."\n", - 'type' => 'object', - 'required' => false, - 'example' => '{'."\n" - .'"name": "stop_word", "useSystemDictionary": true,'."\n" - .'"interventionDictionary": "my_dict",'."\n" - .' "ignoreSpace": true'."\n" - .'}', - ], - 'required' => false, - ], - 'indexes' => [ - 'description' => 'The index range.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The index.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'default', - ], - 'required' => false, - ], - 'active' => [ - 'description' => 'Specifies whether the rule is the default one.'."\n", - 'type' => 'boolean', - 'required' => false, - 'example' => 'True', + 'title' => '', + 'example' => '', ], + 'active' => ['description' => 'Specifies whether the rule is the default one.', 'type' => 'boolean', 'required' => false, 'example' => 'True', 'title' => ''], ], 'required' => false, + 'title' => '', + 'example' => '', ], 'required' => false, + 'title' => '', + 'example' => '', ], 'cluster' => [ - 'description' => 'The capability opening configurations.'."\n", + 'description' => 'The feature configurations.', 'type' => 'object', 'properties' => [ - 'maxTimeoutMS' => [ - 'description' => 'The timeout period. Unit: milliseconds.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '750', - ], - 'maxQueryClauseLength' => [ - 'description' => 'The maximum length of the query clause.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1024', - ], - 'textSparseEmbeddingModel' => [ - 'title' => '用于指定LLM应用版本使用的稀疏向量模型', - 'type' => 'string', - 'example' => 'ops-text-sparse-embedding-001', - ], - 'textEmbeddingModel' => [ - 'title' => '用于指定LLM应用版本使用的文本向量化模型', - 'type' => 'string', - 'example' => 'ops-text-embedding-002', - ], + 'maxTimeoutMS' => ['description' => 'The timeout period for the cluster, in milliseconds.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '750', 'title' => ''], + 'maxQueryClauseLength' => ['description' => 'The maximum length of the query clause.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1024', 'title' => ''], + 'textSparseEmbeddingModel' => ['type' => 'string', 'example' => 'ops-text-sparse-embedding-001', 'description' => '', 'title' => ''], + 'textEmbeddingModel' => ['type' => 'string', 'example' => 'ops-text-embedding-002', 'description' => '', 'title' => ''], 'chunkModels' => [ - 'title' => '切片方式', 'type' => 'array', - 'items' => [ - 'title' => '切片方式配置项', - 'type' => 'object', - ], + 'items' => ['type' => 'object', 'description' => '', 'title' => '', 'example' => ''], + 'description' => '', + 'title' => '', + 'example' => '', ], 'imageContentRecognizerModels' => [ - 'title' => '图片内容识别的模型', 'type' => 'array', - 'items' => [ - 'title' => '图片内容识别的模型配置项', - 'type' => 'object', - ], - ], - 'graphRag' => [ - 'title' => 'GraphRAG集成配置', - 'type' => 'object', + 'items' => ['type' => 'object', 'description' => '', 'title' => '', 'example' => ''], + 'description' => '', + 'title' => '', + 'example' => '', ], + 'graphRag' => ['type' => 'object', 'description' => '', 'title' => '', 'example' => ''], 'vectorIndexConfigs' => [ - 'title' => '独享型向量索引高级配置', 'type' => 'array', - 'items' => [ - 'title' => '独享型向量索引高级配置配置项', - 'type' => 'object', - ], + 'items' => ['type' => 'object', 'description' => '', 'title' => '', 'example' => ''], + 'description' => '', + 'title' => '', + 'example' => '', ], ], 'required' => false, + 'title' => '', + 'example' => '', ], 'domain' => [ - 'description' => 'The industry model module.'."\n", + 'description' => 'The industry model.', 'type' => 'object', 'properties' => [ - 'name' => [ - 'description' => 'The industry type.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'ecommerce', - ], - 'category' => [ - 'description' => 'The industry category.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'general', - ], - 'functions' => [ - 'description' => 'The selected feature category. Valid values:'."\n" - ."\n" - .'* qp: query analysis'."\n" - .'* algo: sort policy'."\n" - .'* service: service'."\n", - 'type' => 'object', - 'required' => false, - 'example' => '{"qp":["spellcheck"],"algo":["pop"],"service":["suggest"]}', - ], + 'name' => ['description' => 'The industry.', 'type' => 'string', 'required' => false, 'example' => 'ecommerce', 'title' => ''], + 'category' => ['description' => 'The industry category.', 'type' => 'string', 'required' => false, 'example' => 'general', 'title' => ''], + 'functions' => ['description' => 'The selected features.'."\n" + ."\n" + .'- qp: query analysis'."\n" + ."\n" + .'- algo: sort policy'."\n" + ."\n" + .'- service: ancillary service', 'type' => 'object', 'required' => false, 'example' => '{"qp":["spellcheck"],"algo":["pop"],"service":["suggest"]}', 'title' => ''], ], 'required' => false, + 'title' => '', + 'example' => '', ], - 'realtimeShared' => [ - 'title' => '是否共享实时流', - 'type' => 'boolean', - ], + 'realtimeShared' => ['type' => 'boolean', 'description' => '', 'title' => '', 'example' => ''], 'interpretations' => [ - 'title' => 'LLM表字段描述', 'type' => 'array', - 'items' => [ - 'title' => 'LLM表字段描述', - 'type' => 'object', - ], + 'items' => ['type' => 'object', 'description' => '', 'title' => '', 'example' => ''], + 'description' => '', + 'title' => '', + 'example' => '', ], 'prompts' => [ - 'title' => 'prompt配置', 'type' => 'array', - 'items' => [ - 'title' => '请求体中第一个提示内容', - 'type' => 'object', - ], + 'items' => ['type' => 'object', 'description' => '', 'title' => '', 'example' => ''], + 'description' => '', + 'title' => '', + 'example' => '', ], 'configItems' => [ - 'title' => '请求体中的配置项列表', 'type' => 'array', - 'items' => [ - 'title' => '配置项列表中的第一个元素', - 'type' => 'object', - ], + 'items' => ['type' => 'object', 'description' => '', 'title' => '', 'example' => ''], + 'description' => '', + 'title' => '', + 'example' => '', ], ], 'required' => false, + 'title' => '', + 'example' => '', ], ], ], @@ -2904,867 +1670,686 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'requestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => 'ABCDEFG', - ], + 'requestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'ABCDEFG', 'title' => ''], 'result' => [ - 'description' => 'The response parameters.'."\n", + 'description' => 'The response data.', 'type' => 'object', 'properties' => [ - 'id' => [ - 'description' => 'The application ID.'."\n", - 'type' => 'string', - 'example' => '12888', - ], - 'isCurrent' => [ - 'description' => 'Indicates whether the version is an online version.'."\n", - 'type' => 'boolean', - 'example' => '12333', - ], - 'clusterName' => [ - 'description' => 'The name of the cluster.'."\n", - 'type' => 'string', - 'example' => 'vpc_sh_domain_1', - 'deprecated' => true, - ], - 'type' => [ - 'description' => 'The type of the application. Valid values:'."\n" - ."\n" - .'* standard'."\n" - .'* enhanced'."\n", - 'type' => 'string', - 'example' => 'standard', - ], - 'description' => [ - 'description' => 'The description of the application.'."\n", - 'type' => 'string', - 'example' => 'My application'."\n", - ], - 'status' => [ - 'description' => 'The status of the application. Valid values:'."\n" - ."\n" - .'* OK'."\n" - .'* STOPPED'."\n" - .'* FROZEN'."\n" - .'* INITIALIZING'."\n" - .'* UNAVAILABLE'."\n" - .'* DATA_WAITING'."\n" - .'* DATA_PREPARING'."\n", - 'type' => 'string', - 'example' => 'OK', - ], + 'id' => ['description' => 'The application ID.', 'type' => 'string', 'example' => '12888', 'title' => ''], + 'isCurrent' => ['description' => 'Indicates whether the version is the online version.', 'type' => 'boolean', 'example' => '12333', 'title' => ''], + 'clusterName' => ['description' => 'The name of the cluster.', 'type' => 'string', 'deprecated' => true, 'example' => 'vpc_sh_domain_1', 'title' => ''], + 'type' => ['description' => 'The application type.'."\n" + ."\n" + .'- standard: Standard Edition'."\n" + ."\n" + .'- enhanced: Premium Edition', 'type' => 'string', 'example' => 'standard', 'title' => ''], + 'description' => ['description' => 'The application description.', 'type' => 'string', 'example' => 'My application', 'title' => ''], + 'status' => ['description' => 'The application status.'."\n" + ."\n" + .'- OK'."\n" + ."\n" + .'- STOPPED: The application is paused.'."\n" + ."\n" + .'- FROZEN: The application is frozen.'."\n" + ."\n" + .'- INITIALIZING: The version is being initialized.'."\n" + ."\n" + .'- UNAVAILABLE: The version is invalid.'."\n" + ."\n" + .'- DATA\\_WAITING: The system is waiting for data initialization.'."\n" + ."\n" + .'- DATA\\_PREPARING: Data is being initialized.', 'type' => 'string', 'example' => 'OK', 'title' => ''], 'schema' => [ - 'description' => 'The single-table schema.'."\n", + 'description' => 'The schema of the single-table application.', 'type' => 'object', 'properties' => [ - 'tables' => [ - 'description' => 'The table schema.'."\n", - 'type' => 'object', - 'example' => '{'."\n" - .' "primaryTable": true,'."\n" - .' "name": "main",'."\n" - .' "fields": {'."\n" - .' "id": {'."\n" - .' "name": "id",'."\n" - .' "type": "LITERAL",'."\n" - .' "primaryKey": true'."\n" - .' },'."\n" - .' "title": {'."\n" - .' "name": "title",'."\n" - .' "type": "TEXT",'."\n" - .' "primaryKey": false'."\n" - .' },'."\n" - .' "buy": {'."\n" - .' "name": "buy",'."\n" - .' "type": "INT",'."\n" - .' "primaryKey": false'."\n" - .' },'."\n" - .' "cate_id": {'."\n" - .' "name": "cate_id",'."\n" - .' "type": "INT",'."\n" - .' "primaryKey": false'."\n" - .' },'."\n" - .' "cate_name": {'."\n" - .' "name": "cate_name",'."\n" - .' "type": "LITERAL",'."\n" - .' "primaryKey": false'."\n" - .' }'."\n" - .' }'."\n" - .'}', - ], + 'tables' => ['description' => 'The table schema.', 'type' => 'object', 'example' => '{'."\n" + .' "primaryTable": true,'."\n" + .' "name": "main",'."\n" + .' "fields": {'."\n" + .' "id": {'."\n" + .' "name": "id",'."\n" + .' "type": "LITERAL",'."\n" + .' "primaryKey": true'."\n" + .' },'."\n" + .' "title": {'."\n" + .' "name": "title",'."\n" + .' "type": "TEXT",'."\n" + .' "primaryKey": false'."\n" + .' },'."\n" + .' "buy": {'."\n" + .' "name": "buy",'."\n" + .' "type": "INT",'."\n" + .' "primaryKey": false'."\n" + .' },'."\n" + .' "cate_id": {'."\n" + .' "name": "cate_id",'."\n" + .' "type": "INT",'."\n" + .' "primaryKey": false'."\n" + .' },'."\n" + .' "cate_name": {'."\n" + .' "name": "cate_name",'."\n" + .' "type": "LITERAL",'."\n" + .' "primaryKey": false'."\n" + .' }'."\n" + .' }'."\n" + .'}', 'title' => ''], 'indexes' => [ - 'description' => 'The index schema.'."\n", + 'description' => 'The index schema.', 'type' => 'object', 'properties' => [ 'filterFields' => [ - 'description' => 'The attribute fields.'."\n", + 'description' => 'The attribute fields.', 'type' => 'array', - 'items' => [ - 'description' => 'The attribute field.'."\n", - 'type' => 'string', - 'example' => 'id', - ], - ], - 'searchFields' => [ - 'description' => 'The index fields.'."\n", - 'type' => 'object', - 'example' => '{'."\n" - .' "fields": ["title"],'."\n" - .' "analyzer": "chn_standard"'."\n" - .'}', + 'items' => ['description' => 'The attribute field.', 'type' => 'string', 'example' => 'id', 'title' => ''], + 'title' => '', + 'example' => '', ], + 'searchFields' => ['description' => 'The index fields.', 'type' => 'object', 'example' => '{'."\n" + .' "fields": ["title"],'."\n" + .' "analyzer": "chn_standard"'."\n" + .'}', 'title' => ''], ], + 'title' => '', + 'example' => '', ], - 'routeField' => [ - 'description' => 'The name of the level-1 routing field.'."\n", - 'type' => 'string', - 'example' => 'field1', - ], + 'routeField' => ['description' => 'The name of the level-1 routing field.', 'type' => 'string', 'example' => 'field1', 'title' => ''], 'routeFieldValues' => [ - 'description' => 'The name of the level-2 routing field. This parameter takes effect only when the routeFieldValues parameter is configured. By default, the wide-table primary key field is used as the level-2 routing field.'."\n", + 'description' => 'The name of the level-2 routing field. This parameter takes effect only when routeFieldValues is configured. By default, the primary key of the wide table is used.', 'type' => 'array', - 'items' => [ - 'description' => 'The hot value of the level-1 routing field.'."\n", - 'type' => 'string', - 'example' => 'routeFieldValues', - ], - ], - 'secondRouteField' => [ - 'description' => 'The name of the level-2 routing field. This parameter takes effect only when the routeFieldValues parameter is configured. By default, the wide-table primary key field is used as the level-2 routing field.'."\n", - 'type' => 'string', - 'example' => 'field2'."\n", + 'items' => ['description' => 'The hotspot value of the level-1 routing field.', 'type' => 'string', 'example' => 'routeFieldValues', 'title' => ''], + 'title' => '', + 'example' => '', ], + 'secondRouteField' => ['description' => 'The name of the level-2 routing field. This parameter takes effect only when routeFieldValues is configured. By default, the primary key of the wide table is used.', 'type' => 'string', 'example' => 'field2'."\n", 'title' => ''], 'ttlField' => [ - 'description' => 'The document clearing configurations.'."\n", + 'description' => 'The document expiration configuration.', 'type' => 'object', 'properties' => [ - 'name' => [ - 'description' => 'The name of the document time field.'."\n", - 'type' => 'string', - 'example' => 'text1'."\n", - ], - 'ttl' => [ - 'description' => 'The TTL. Unit: milliseconds.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1000', - ], + 'name' => ['description' => 'The document time field.', 'type' => 'string', 'example' => 'text1'."\n", 'title' => ''], + 'ttl' => ['description' => 'The time to live (TTL), in milliseconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '1000', 'title' => ''], ], + 'title' => '', + 'example' => '', ], 'indexSortConfig' => [ - 'description' => 'The sort configurations.'."\n", + 'description' => 'The inverted index configurations.', 'type' => 'array', 'items' => [ - 'description' => 'The sort configurations.'."\n", + 'description' => 'The inverted index configuration.', 'type' => 'object', 'properties' => [ - 'field' => [ - 'description' => 'The sort field.'."\n", - 'type' => 'string', - 'example' => 'field1', - ], - 'direction' => [ - 'description' => 'The sort method. Valid values:'."\n" - ."\n" - .'* ASC'."\n" - .'* DESC'."\n", - 'type' => 'string', - 'example' => 'DESC', - ], + 'field' => ['description' => 'The sort field.', 'type' => 'string', 'example' => 'field1', 'title' => ''], + 'direction' => ['description' => 'The sort order.'."\n" + ."\n" + .'- ASC'."\n" + ."\n" + .'- DESC', 'type' => 'string', 'example' => 'DESC', 'title' => ''], ], + 'title' => '', + 'example' => '', ], + 'title' => '', + 'example' => '', ], - 'name' => [ - 'description' => 'The name of the wide table.'."\n", - 'type' => 'string', - 'example' => 'test', - ], + 'name' => ['description' => 'The name of the wide table.', 'type' => 'string', 'example' => 'test', 'title' => ''], ], + 'title' => '', + 'example' => '', ], - 'progressPercent' => [ - 'description' => 'The percentage for the data import progress.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '100', - ], + 'progressPercent' => ['description' => 'The data import progress, in percentage.', 'type' => 'integer', 'format' => 'int32', 'example' => '100', 'title' => ''], 'fetchFields' => [ - 'description' => 'The default display fields.'."\n", + 'description' => 'The default display fields.', 'type' => 'array', - 'items' => [ - 'description' => 'The default display fields.'."\n", - 'type' => 'string', - 'example' => 'field1', - ], + 'items' => ['description' => 'The default display field.', 'type' => 'string', 'example' => 'field1', 'title' => ''], + 'title' => '', + 'example' => '', ], 'domain' => [ - 'description' => 'The industry model module.'."\n", + 'description' => 'The industry model.', 'type' => 'object', 'properties' => [ - 'category' => [ - 'description' => 'The industry category.'."\n", - 'type' => 'string', - 'example' => '-', - ], - 'name' => [ - 'description' => 'The industry type. Valid values:'."\n" - ."\n" - .'* GENERAL'."\n" - .'* ECOMMERCE'."\n" - .'* IT_CONTENT'."\n", - 'type' => 'string', - 'example' => 'GENERAL', - ], + 'category' => ['description' => 'The industry category.', 'type' => 'string', 'example' => '-', 'title' => ''], + 'name' => ['description' => 'The industry. Valid values:'."\n" + ."\n" + .'- GENERAL'."\n" + ."\n" + .'- ECOMMERCE'."\n" + ."\n" + .'- IT\\_CONTENT', 'type' => 'string', 'example' => 'GENERAL', 'title' => ''], 'functions' => [ - 'description' => 'The selected features.'."\n", + 'description' => 'The selected features.', 'type' => 'object', 'properties' => [ 'service' => [ - 'description' => 'The features of the service category.'."\n", + 'description' => 'The ancillary service features.', 'type' => 'array', - 'items' => [ - 'description' => 'The feature of the service category.'."\n", - 'type' => 'string', - 'example' => 'suggest'."\n" - ."\n", - ], + 'items' => ['description' => 'The ancillary service features.', 'type' => 'string', 'example' => 'suggest'."\n" + ."\n", 'title' => ''], + 'title' => '', + 'example' => '', ], 'qp' => [ - 'description' => 'The features of the query analysis category.'."\n", + 'description' => 'The query analysis features.', 'type' => 'array', - 'items' => [ - 'description' => 'The feature of the query analysis category.'."\n", - 'type' => 'string', - 'example' => 'spellcheck', - ], + 'items' => ['description' => 'The query analysis features.', 'type' => 'string', 'example' => 'spellcheck', 'title' => ''], + 'title' => '', + 'example' => '', ], 'algo' => [ - 'description' => 'The features of the sort policy category.'."\n", + 'description' => 'The sort policy features.', 'type' => 'array', - 'items' => [ - 'description' => 'The feature of the sort policy category.'."\n", - 'type' => 'string', - 'example' => 'pop', - ], + 'items' => ['description' => 'The sort policy features.', 'type' => 'string', 'example' => 'pop', 'title' => ''], + 'title' => '', + 'example' => '', ], ], + 'title' => '', + 'example' => '', ], ], + 'title' => '', + 'example' => '', ], 'schemas' => [ - 'description' => 'The multi-table schema.'."\n", + 'description' => 'The schema of the multi-table application.', 'type' => 'array', 'items' => [ - 'description' => 'The schema.'."\n", + 'description' => 'The application schema.', 'type' => 'object', 'properties' => [ - 'tables' => [ - 'description' => 'The table schema.'."\n", - 'type' => 'object', - 'example' => '{'."\n" - .' "primaryTable": true,'."\n" - .' "name": "main",'."\n" - .' "fields": {'."\n" - .' "id": {'."\n" - .' "name": "id",'."\n" - .' "type": "LITERAL",'."\n" - .' "primaryKey": true'."\n" - .' },'."\n" - .' "title": {'."\n" - .' "name": "title",'."\n" - .' "type": "TEXT",'."\n" - .' "primaryKey": false'."\n" - .' },'."\n" - .' "buy": {'."\n" - .' "name": "buy",'."\n" - .' "type": "INT",'."\n" - .' "primaryKey": false'."\n" - .' },'."\n" - .' "cate_id": {'."\n" - .' "name": "cate_id",'."\n" - .' "type": "INT",'."\n" - .' "primaryKey": false'."\n" - .' },'."\n" - .' "cate_name": {'."\n" - .' "name": "cate_name",'."\n" - .' "type": "LITERAL",'."\n" - .' "primaryKey": false'."\n" - .' }'."\n" - .' }'."\n" - .'}', - ], + 'tables' => ['description' => 'The table schema.', 'type' => 'object', 'example' => '{'."\n" + .' "primaryTable": true,'."\n" + .' "name": "main",'."\n" + .' "fields": {'."\n" + .' "id": {'."\n" + .' "name": "id",'."\n" + .' "type": "LITERAL",'."\n" + .' "primaryKey": true'."\n" + .' },'."\n" + .' "title": {'."\n" + .' "name": "title",'."\n" + .' "type": "TEXT",'."\n" + .' "primaryKey": false'."\n" + .' },'."\n" + .' "buy": {'."\n" + .' "name": "buy",'."\n" + .' "type": "INT",'."\n" + .' "primaryKey": false'."\n" + .' },'."\n" + .' "cate_id": {'."\n" + .' "name": "cate_id",'."\n" + .' "type": "INT",'."\n" + .' "primaryKey": false'."\n" + .' },'."\n" + .' "cate_name": {'."\n" + .' "name": "cate_name",'."\n" + .' "type": "LITERAL",'."\n" + .' "primaryKey": false'."\n" + .' }'."\n" + .' }'."\n" + .'}', 'title' => ''], 'indexes' => [ - 'description' => 'The index schema.'."\n", + 'description' => 'The index schema.', 'type' => 'object', 'properties' => [ 'filterFields' => [ - 'description' => 'The attribute fields.'."\n", + 'description' => 'The attribute fields.', 'type' => 'array', - 'items' => [ - 'description' => 'The attribute field.'."\n", - 'type' => 'string', - 'example' => 'field1', - ], - ], - 'searchFields' => [ - 'description' => 'The index fields.'."\n", - 'type' => 'object', - 'example' => '{'."\n" - .' "fields": ["title"],'."\n" - .' "analyzer": "chn_standard"'."\n" - .'}'."\n", + 'items' => ['description' => 'The attribute field.', 'type' => 'string', 'example' => 'field1', 'title' => ''], + 'title' => '', + 'example' => '', ], + 'searchFields' => ['description' => 'The index fields.', 'type' => 'object', 'example' => '{'."\n" + .' "fields": ["title"],'."\n" + .' "analyzer": "chn_standard"'."\n" + .'}'."\n", 'title' => ''], ], + 'title' => '', + 'example' => '', ], - 'routeField' => [ - 'description' => 'The name of the level-1 routing field.'."\n", - 'type' => 'string', - 'example' => 'field1'."\n", - ], + 'routeField' => ['description' => 'The name of the level-1 routing field.', 'type' => 'string', 'example' => 'field1'."\n", 'title' => ''], 'routeFieldValues' => [ - 'description' => 'The hot values of the level-1 routing field. After you configure this parameter, level-2 routing is enabled.'."\n", + 'description' => 'The list of hotspot values for the level-1 routing field. After you configure this parameter, level-2 routing is enabled.', 'type' => 'array', - 'items' => [ - 'description' => 'The hot value of the level-1 routing field.'."\n", - 'type' => 'string', - 'example' => 'routeFieldValues', - ], - ], - 'secondRouteField' => [ - 'description' => 'The name of the level-2 routing field. This parameter takes effect only when the routeFieldValues parameter is configured. By default, the wide-table primary key field is used as the level-2 routing field.'."\n", - 'type' => 'string', - 'example' => 'field2', + 'items' => ['description' => 'The hotspot value of the level-1 routing field.', 'type' => 'string', 'example' => 'routeFieldValues', 'title' => ''], + 'title' => '', + 'example' => '', ], + 'secondRouteField' => ['description' => 'The name of the level-2 routing field. This parameter takes effect only when routeFieldValues is configured. By default, the primary key of the wide table is used.', 'type' => 'string', 'example' => 'field2', 'title' => ''], 'ttlField' => [ - 'description' => 'The document clearing configurations.'."\n", + 'description' => 'The document expiration configuration.', 'type' => 'object', 'properties' => [ - 'name' => [ - 'description' => 'The name of the document time field.'."\n", - 'type' => 'string', - 'example' => 'fIeld1', - ], - 'ttl' => [ - 'description' => 'The TTL. Unit: milliseconds.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1000', - ], + 'name' => ['description' => 'The document time field.', 'type' => 'string', 'example' => 'fIeld1', 'title' => ''], + 'ttl' => ['description' => 'The time to live (TTL), in milliseconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '1000', 'title' => ''], ], + 'title' => '', + 'example' => '', ], 'indexSortConfig' => [ - 'description' => 'The sort configurations.'."\n", + 'description' => 'The inverted index configuration.', 'type' => 'array', 'items' => [ - 'description' => 'The sort configurations.'."\n", + 'description' => 'The inverted index configuration.', 'type' => 'object', 'properties' => [ - 'field' => [ - 'description' => 'The sort field.'."\n", - 'type' => 'string', - 'example' => 'fIeld1', - ], - 'direction' => [ - 'description' => 'The sort method. Valid values:'."\n" - ."\n" - .'* ASC'."\n" - .'* DESC'."\n", - 'type' => 'string', - 'example' => 'DESC', - ], + 'field' => ['description' => 'The sort field.', 'type' => 'string', 'example' => 'fIeld1', 'title' => ''], + 'direction' => ['description' => 'The sort order.'."\n" + ."\n" + .'- ASC'."\n" + ."\n" + .'- DESC', 'type' => 'string', 'example' => 'DESC', 'title' => ''], ], + 'title' => '', + 'example' => '', ], + 'title' => '', + 'example' => '', ], - 'name' => [ - 'description' => 'The name of the wide table.'."\n", - 'type' => 'string', - 'example' => 'main', - ], + 'name' => ['description' => 'The name of the wide table.', 'type' => 'string', 'example' => 'main', 'title' => ''], ], + 'title' => '', + 'example' => '', ], + 'title' => '', + 'example' => '', ], 'firstRanks' => [ - 'description' => 'The configurations of rough sort.'."\n", + 'description' => 'The rough sort configurations.', 'type' => 'array', 'items' => [ - 'description' => 'The configurations of rough sort.'."\n", + 'description' => 'The rough sort configurations.', 'type' => 'object', 'properties' => [ - 'type' => [ - 'description' => 'The expression type. Valid values:'."\n" - ."\n" - .'STRUCT: The content of the expression is a structure. STRING (default): You can configure a custom formula.'."\n", - 'type' => 'string', - 'example' => 'STRING', - ], - 'name' => [ - 'description' => 'The name of the rough sort expression.'."\n", - 'type' => 'string', - 'example' => 'test', - ], - 'description' => [ - 'description' => 'The description.'."\n", - 'type' => 'string', - 'example' => 'Description'."\n", - ], - 'active' => [ - 'description' => 'Indicates whether the expression is the default one.'."\n", - 'type' => 'boolean', - 'example' => 'False', - ], - 'meta' => [ - 'description' => 'The information about the expression. The information can be of the array or string type.'."\n", - 'type' => 'any', - 'example' => 'String :"random()*100+now()";'."\n" - .'Array: ['."\n" - .' {'."\n" - .' "attribute": "static_bm25()",'."\n" - .' "arg": "",'."\n" - .' "weight": 10'."\n" - .' }'."\n" - .' ]', - ], + 'type' => ['description' => 'The type of the expression. Valid values: \\`STRUCT\\`: a structured expression. \\`STRING\\`: a custom formula. Default value: \\`STRING\\`.'."\n" + ."\n" + .'STRUCT: The content of the expression is a structure. STRING (default): custom formula.', 'type' => 'string', 'example' => 'STRING', 'title' => ''], + 'name' => ['description' => 'The name of the rough sort expression.', 'type' => 'string', 'example' => 'test', 'title' => ''], + 'description' => ['description' => 'The description.', 'type' => 'string', 'example' => '描述', 'title' => ''], + 'active' => ['description' => 'Specifies whether the expression is the default one.', 'type' => 'boolean', 'example' => 'False', 'title' => ''], + 'meta' => ['description' => 'The details of the expression. The value can be an array or a string.', 'type' => 'any', 'example' => 'String :"random()*100+now()"；'."\n" + .'Array: ['."\n" + .' {'."\n" + .' "attribute": "static_bm25()",'."\n" + .' "arg": "",'."\n" + .' "weight": 10'."\n" + .' }'."\n" + .' ]', 'title' => ''], ], + 'title' => '', + 'example' => '', ], + 'title' => '', + 'example' => '', ], 'secondRanks' => [ - 'description' => 'The configurations of fine sort.'."\n", + 'description' => 'The fine sort configurations.', 'type' => 'array', 'items' => [ - 'description' => 'The configurations of fine sort.'."\n", + 'description' => 'The fine sort configuration.', 'type' => 'object', 'properties' => [ - 'meta' => [ - 'description' => 'The fine sort expression. You can define an expression that contains fields, feature functions, and mathematical functions to implement complex sort logic.'."\n", - 'type' => 'any', - 'example' => '"cate_id > 0 and cate_id < 1000"'."\n", - ], - 'name' => [ - 'description' => 'The name of the fine sort expression.'."\n", - 'type' => 'string', - 'example' => 'default'."\n", - ], - 'description' => [ - 'description' => 'The description.'."\n", - 'type' => 'string', - 'example' => 'default'."\n", - ], - 'active' => [ - 'description' => 'Indicates whether the expression is the default one.'."\n", - 'type' => 'boolean', - 'example' => 'False', - ], + 'meta' => ['description' => 'The fine sort expression. You can write an expression that contains fields, feature functions, and mathematical functions to implement complex sort logic.', 'type' => 'any', 'example' => '"cate_id > 0 and cate_id < 1000"'."\n", 'title' => ''], + 'name' => ['description' => 'The name of the fine sort expression.', 'type' => 'string', 'example' => 'default'."\n", 'title' => ''], + 'description' => ['description' => 'The description.', 'type' => 'string', 'example' => 'default'."\n", 'title' => ''], + 'active' => ['description' => 'Specifies whether the expression is the default one.', 'type' => 'boolean', 'example' => 'False', 'title' => ''], ], + 'title' => '', + 'example' => '', ], + 'title' => '', + 'example' => '', ], 'dataSources' => [ - 'description' => 'The configurations of the data sources.'."\n", + 'description' => 'The data source configurations.', 'type' => 'array', 'items' => [ - 'description' => 'The configurations of the data source.'."\n", + 'description' => 'The data source configurations.', 'type' => 'object', 'properties' => [ - 'tableName' => [ - 'description' => 'The name of the table in the application.'."\n", - 'type' => 'string', - 'example' => 'main', - ], - 'type' => [ - 'description' => 'The type of the data source. Valid values:'."\n" - ."\n" - .'* rds'."\n" - .'* odps'."\n" - .'* opensearch'."\n" - .'* polardb'."\n", - 'type' => 'string', - 'example' => 'rds', - ], + 'tableName' => ['description' => 'The name of the application table.', 'type' => 'string', 'example' => 'main', 'title' => ''], + 'type' => ['description' => 'The type of the data source.'."\n" + ."\n" + .'- rds'."\n" + ."\n" + .'- odps'."\n" + ."\n" + .'- opensearch'."\n" + ."\n" + .'- polardb', 'type' => 'string', 'example' => 'rds', 'title' => ''], 'fields' => [ - 'description' => 'The information about field mappings.'."\n", + 'description' => 'The information about field mappings.', 'type' => 'array', - 'items' => [ - 'description' => 'The information about field mappings.'."\n", - 'type' => 'object', - 'example' => '{'."\n" - .' "id": "id"'."\n" - .' }'."\n", - ], - ], - 'plugins' => [ - 'description' => 'The plug-ins that are used for data processing.'."\n" - ."\n" - .'name:'."\n" - ."\n" - .'* JsonKeyValueExtractor'."\n" - .'* MultiValueSpliter'."\n" - .'* KeyValueExtractor'."\n" - .'* StringCatenateExtractor'."\n" - .'* HTMLTagRemover'."\n" - ."\n" - .'parameters:'."\n" - ."\n" - .'* JsonKeyValueExtractor'."\n" - .'* MultiValueSpliter'."\n" - .'* KeyValueExtractor'."\n" - .'* StringCatenateExtractor'."\n" - .'* HTMLTagRemover'."\n", - 'type' => 'object', - 'example' => '{'."\n" - .' "name": "JsonKeyValueExtractor",'."\n" - .' "parameters": {'."\n" - .' "key": "my_field"'."\n" - .'}'."\n" - .'}', - ], - 'keyField' => [ - 'description' => 'The primary key.'."\n", - 'type' => 'string', - 'example' => 'id', - ], - 'schemaName' => [ - 'description' => 'The name of the wide table.'."\n", - 'type' => 'string', - 'example' => 'table_name', - ], - 'parameters' => [ - 'description' => 'The information about the data source.'."\n", - 'type' => 'object', - 'example' => '{'."\n" - .' "instanceId": "rds-instance-id",'."\n" - .' "dbName": "my_db",'."\n" - .' "dbTableName": "my_table",'."\n" - .' "dbUser": "my",'."\n" - .' "dbPassword": "my_passwd",'."\n" - .' "filter":"",'."\n" - .' "autoSync": true'."\n" - .'}'."\n", + 'items' => ['description' => 'The information about field mappings.', 'type' => 'object', 'example' => '{'."\n" + .' "id": "id"'."\n" + .' }'."\n", 'title' => ''], + 'title' => '', + 'example' => '', ], + 'plugins' => ['description' => 'The data processing plugins for fields.'."\n" + ."\n" + .'Plugin name (name):'."\n" + ."\n" + .'- JsonKeyValueExtractor'."\n" + ."\n" + .'- MultiValueSpliter'."\n" + ."\n" + .'- KeyValueExtractor'."\n" + ."\n" + .'- StringCatenateExtractor'."\n" + ."\n" + .'- HTMLTagRemover'."\n" + ."\n" + .'Plugin parameters (parameters):'."\n" + ."\n" + .'- JsonKeyValueExtractor'."\n" + ."\n" + .'- MultiValueSpliter'."\n" + ."\n" + .'- KeyValueExtractor'."\n" + ."\n" + .'- StringCatenateExtractor'."\n" + ."\n" + .'- HTMLTagRemover', 'type' => 'object', 'example' => '{'."\n" + .' "name": "JsonKeyValueExtractor",'."\n" + .' "parameters": {'."\n" + .' "key": "my_field"'."\n" + .'}'."\n" + .'}', 'title' => ''], + 'keyField' => ['description' => 'The primary key.', 'type' => 'string', 'example' => 'id', 'title' => ''], + 'schemaName' => ['description' => 'The name of the wide table.', 'type' => 'string', 'example' => 'table_name', 'title' => ''], + 'parameters' => ['description' => 'The information about the data source.', 'type' => 'object', 'example' => '{'."\n" + .' "instanceId": "rds-instance-id",'."\n" + .' "dbName": "my_db",'."\n" + .' "dbTableName": "my_table",'."\n" + .' "dbUser": "my",'."\n" + .' "dbPassword": "my_passwd",'."\n" + .' "filter":"",'."\n" + .' "autoSync": true'."\n" + .'}'."\n", 'title' => ''], ], + 'title' => '', + 'example' => '', ], + 'title' => '', + 'example' => '', ], 'summaries' => [ - 'description' => 'The summary configurations of search results.'."\n", + 'description' => 'The search result summary settings.', 'type' => 'array', 'items' => [ - 'description' => 'The summary configurations of search results.'."\n", + 'description' => 'The search result summary settings.', 'type' => 'object', 'properties' => [ - 'name' => [ - 'description' => 'The group name.'."\n", - 'type' => 'string', - 'example' => 'fefault', - ], + 'name' => ['description' => 'The group name.', 'type' => 'string', 'example' => 'fefault', 'title' => ''], 'meta' => [ - 'description' => 'The collection of summary configurations.'."\n", + 'description' => 'The summary configurations.', 'type' => 'array', 'items' => [ - 'description' => 'The summary configurations.'."\n", + 'description' => 'The summary configuration.', 'type' => 'object', 'properties' => [ - 'field' => [ - 'description' => 'The field.'."\n", - 'type' => 'string', - 'example' => 'field1', - ], - 'len' => [ - 'description' => 'The length of the segment. Valid values: 1 to 300.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '50', - ], - 'element' => [ - 'description' => 'The element that is used for highlighting.'."\n", - 'type' => 'string', - 'example' => 'em', - ], - 'ellipsis' => [ - 'description' => 'The connector that is used to connect segments.'."\n", - 'type' => 'string', - 'example' => '...', - ], - 'snippet' => [ - 'description' => 'The number of segments. Valid values: 1 to 5.'."\n", - 'type' => 'string', - 'example' => '5', - ], + 'field' => ['description' => 'The field.', 'type' => 'string', 'example' => 'field1', 'title' => ''], + 'len' => ['description' => 'The length of the snippet. The value must be in the range of \\[1, 300].', 'type' => 'integer', 'format' => 'int32', 'example' => '50', 'title' => ''], + 'element' => ['description' => 'The HTML tag for highlight.', 'type' => 'string', 'example' => 'em', 'title' => ''], + 'ellipsis' => ['description' => 'The string used to connect snippets.', 'type' => 'string', 'example' => '...', 'title' => ''], + 'snippet' => ['description' => 'The number of snippets. The value must be in the range of \\[1, 5].', 'type' => 'string', 'example' => '5', 'title' => ''], ], + 'title' => '', + 'example' => '', ], + 'title' => '', + 'example' => '', ], ], + 'title' => '', + 'example' => '', ], + 'title' => '', + 'example' => '', ], 'queryProcessors' => [ - 'description' => 'The query intent understanding configurations.'."\n", + 'description' => 'The intention recognition configurations.', 'type' => 'array', 'items' => [ - 'description' => 'The query intent understanding configurations.'."\n", + 'description' => 'The intention recognition configurations.', 'type' => 'object', 'properties' => [ - 'name' => [ - 'description' => 'The rule name.'."\n", - 'type' => 'string', - 'example' => 'test', - ], - 'domain' => [ - 'description' => 'The industry type. Valid values:'."\n" - ."\n" - .'* GENERAL'."\n" - .'* ECOMMERCE'."\n" - .'* IT_CONTENT'."\n", - 'type' => 'string', - 'example' => 'GENERAL', - ], - 'category' => [ - 'description' => 'The industry category.'."\n", - 'type' => 'string', - 'example' => '""', - ], + 'name' => ['description' => 'The rule name.', 'type' => 'string', 'example' => 'test', 'title' => ''], + 'domain' => ['description' => 'The industry. Valid values:'."\n" + ."\n" + .'- GENERAL: general'."\n" + ."\n" + .'- ECOMMERCE: e-commerce'."\n" + ."\n" + .'- IT\\_CONTENT: IT content', 'type' => 'string', 'example' => 'GENERAL', 'title' => ''], + 'category' => ['description' => 'The industry category.', 'type' => 'string', 'example' => '""', 'title' => ''], 'processors' => [ - 'description' => 'The features.'."\n", + 'description' => 'The features that are included.', 'type' => 'array', - 'items' => [ - 'description' => 'The feature.'."\n", - 'type' => 'object', - 'example' => '{'."\n" - .'"name": "stop_word", "useSystemDictionary": true,'."\n" - .'"interventionDictionary": "my_dict",'."\n" - .' "ignoreSpace": true'."\n" - .'}', - ], + 'items' => ['description' => 'The features that are included.', 'type' => 'object', 'example' => '{'."\n" + .'"name": "stop_word", "useSystemDictionary": true,'."\n" + .'"interventionDictionary": "my_dict",'."\n" + .' "ignoreSpace": true'."\n" + .'}', 'title' => ''], + 'title' => '', + 'example' => '', ], 'indexes' => [ - 'description' => 'The index range.'."\n", + 'description' => 'The indexes of the application.', 'type' => 'array', - 'items' => [ - 'description' => 'The index.'."\n", - 'type' => 'string', - 'example' => 'id', - ], - ], - 'active' => [ - 'description' => 'Indicates whether the rule is the default one.'."\n", - 'type' => 'boolean', - 'example' => 'False', + 'items' => ['description' => 'The application index.', 'type' => 'string', 'example' => 'id', 'title' => ''], + 'title' => '', + 'example' => '', ], + 'active' => ['description' => 'Specifies whether the rule is the default one.', 'type' => 'boolean', 'example' => 'False', 'title' => ''], ], + 'title' => '', + 'example' => '', ], + 'title' => '', + 'example' => '', ], 'cluster' => [ - 'description' => 'The capability opening configurations.'."\n", + 'description' => 'The feature configurations.', 'type' => 'object', 'properties' => [ - 'maxTimeoutMS' => [ - 'description' => 'The timeout period. Unit: milliseconds.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '750', - ], - 'maxQueryClauseLength' => [ - 'description' => 'The maximum length of the query clause.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1024', - ], - 'textEmbeddingModel' => [ - 'title' => '用于指定LLM应用版本使用的文本向量化模型', - 'type' => 'string', - ], - 'textSparseEmbeddingModel' => [ - 'title' => '用于指定LLM应用版本使用的稀疏向量模型', - 'type' => 'string', - ], + 'maxTimeoutMS' => ['description' => 'The timeout period for the cluster, in milliseconds.', 'type' => 'integer', 'format' => 'int32', 'example' => '750', 'title' => ''], + 'maxQueryClauseLength' => ['description' => 'The maximum length of the query clause.', 'type' => 'integer', 'format' => 'int32', 'example' => '1024', 'title' => ''], + 'textEmbeddingModel' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'textSparseEmbeddingModel' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], 'chunkModels' => [ - 'title' => '用于指定LLM应用版本使用的切片方式', 'type' => 'array', - 'items' => [ - 'title' => '切片方式配置项', - 'type' => 'object', - ], + 'items' => ['type' => 'object', 'description' => '', 'title' => '', 'example' => ''], + 'description' => '', + 'title' => '', + 'example' => '', ], 'imageContentRecognizerModels' => [ - 'title' => '用于指定LLM应用版本使用的图片内容识别的模型', 'type' => 'array', - 'items' => [ - 'title' => '图片内容识别的模型配置项', - 'type' => 'object', - ], - ], - 'graphRag' => [ - 'title' => '用于指定LLM应用版本使用的GraphRAG集成配置', - 'type' => 'object', + 'items' => ['type' => 'object', 'description' => '', 'title' => '', 'example' => ''], + 'description' => '', + 'title' => '', + 'example' => '', ], + 'graphRag' => ['type' => 'object', 'description' => '', 'title' => '', 'example' => ''], 'vectorIndexConfigs' => [ - 'title' => '独享型向量索引高级配置', 'type' => 'array', - 'items' => [ - 'title' => '独享型向量索引高级配置配置项', - 'type' => 'object', - ], + 'items' => ['type' => 'object', 'description' => '', 'title' => '', 'example' => ''], + 'description' => '', + 'title' => '', + 'example' => '', ], ], + 'title' => '', + 'example' => '', ], 'prompts' => [ - 'description' => 'The prompt configurations'."\n", + 'description' => 'The prompt configurations.', 'type' => 'array', - 'items' => [ - 'description' => 'The prompt configurations'."\n", - 'type' => 'object', - 'example' => '{ "name" : "prompt_name", "isDefault" : false, "description":"Description", "prompt" : { "parameters" : \\[ { "name" : "docs", "value" : "The way in which the content of documents is concatenated, such as \'\\
\\n${doc}\\n\\
\\n." } ], "messages":\\[ { "role" : "role_name: specifies whether to specify only system, user, or assistant or specify a custom value.", "content" : "The content of the prompt configured by the user. ${parameter_key} can be used to specify the content that you want to dynamically replace. For more information about replacement rules, see the following instructions." } ] } }'."\n", - ], + 'items' => ['description' => 'The prompt configuration.', 'type' => 'object', 'example' => '{'."\n" + .' "name" : "prompt_name",'."\n" + .' "isDefault" : false,'."\n" + .' "description":"描述",'."\n" + .' "prompt" : {'."\n" + .' "parameters" : ['."\n" + .' {'."\n" + .' "name" : "docs",'."\n" + .' "value" : "doc内容的拼接方式，比如现在的 qwen的 \'
\\n${doc}\\n
\\n"'."\n" + .' }'."\n" + .' ],'."\n" + .' "messages":['."\n" + .' {'."\n" + .' "role" : "role_name，这里是否需要限定只能是 system, user, assistant，还是可以让用户随意填写",'."\n" + .' "content" : "用户设置的prompt内容，里面可以使用 ${parameter_key} 来表示期望动态替换的内容，具体替换规则参考下面说明"'."\n" + .' }'."\n" + .' ]'."\n" + .' }'."\n" + .' }', 'title' => ''], + 'title' => '', + 'example' => '', ], 'quota' => [ - 'description' => 'The quota.'."\n", + 'description' => 'The quota of the version.', 'type' => 'object', 'properties' => [ - 'qps' => [ - 'description' => 'The search request.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '5', - ], - 'computeResource' => [ - 'description' => 'The computing resources.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '20', - ], - 'docSize' => [ - 'description' => 'The storage capacity.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'spec' => [ - 'description' => 'The specifications. Valid values:'."\n" - ."\n" - .'* opensearch.share.junior: basic'."\n" - .'* opensearch.share.common: shared general-purpose'."\n" - .'* opensearch.share.compute: shared computing'."\n" - .'* opensearch.share.storage: shared storage'."\n" - .'* opensearch.private.common: exclusive general-purpose'."\n" - .'* opensearch.private.compute: exclusive computing'."\n" - .'* opensearch.private.storage: exclusive storage'."\n", - 'type' => 'string', - 'example' => 'opensearch.share.common', - ], - 'usedQps' => [ - 'title' => '已使用的QPS', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '100', - ], - 'usedDocSize' => [ - 'title' => '已使用的文档存储空间', - 'type' => 'number', - 'format' => 'double', - 'example' => '1024', - ], - 'usedComputeResource' => [ - 'title' => '已使用的计算资源配额', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '100', - ], + 'qps' => ['description' => 'The queries per second (QPS).', 'type' => 'integer', 'format' => 'int32', 'example' => '5', 'title' => ''], + 'computeResource' => ['description' => 'The compute resources.', 'type' => 'integer', 'format' => 'int32', 'example' => '20', 'title' => ''], + 'docSize' => ['description' => 'The storage capacity.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'spec' => ['description' => 'The instance specifications. Valid values:'."\n" + ."\n" + .'- opensearch.share.junior: Starter Edition'."\n" + ."\n" + .'- opensearch.share.common: Shared General-purpose'."\n" + ."\n" + .'- opensearch.share.compute: Shared Compute-optimized'."\n" + ."\n" + .'- opensearch.share.storage: Shared Storage-optimized'."\n" + ."\n" + .'- opensearch.private.common: Exclusive General-purpose'."\n" + ."\n" + .'- opensearch.private.compute: Exclusive Compute-optimized'."\n" + ."\n" + .'- opensearch.private.storage: Exclusive Storage-optimized', 'type' => 'string', 'example' => 'opensearch.share.common', 'title' => ''], + 'usedQps' => ['type' => 'integer', 'format' => 'int32', 'example' => '100', 'description' => '', 'title' => ''], + 'usedDocSize' => ['type' => 'number', 'format' => 'double', 'example' => '1024', 'description' => '', 'title' => ''], + 'usedComputeResource' => ['type' => 'integer', 'format' => 'int32', 'example' => '100', 'description' => '', 'title' => ''], ], + 'title' => '', + 'example' => '', ], 'interpretations' => [ - 'description' => 'The descriptions of the LLM table fields.'."\n", + 'description' => 'The descriptions of the large language model (LLM) table fields.', + 'items' => ['type' => 'object', 'description' => '', 'title' => '', 'example' => ''], 'type' => 'array', - 'example' => '{ "name": "longyu_llm\\_1", "schemas": \\[], "interpretations": \\[ { "table": "table1", "fields": \\[ { "name": "field1", "interpretation": "Title" }, { "name": "field2", "interpretation": "Number" } ] } ] }'."\n", - 'title' => 'LLM表字段描述', - 'items' => [ - 'title' => 'LLM表字段描述', - 'type' => 'object', - ], + 'example' => '{'."\n" + .'    "name": "longyu_llm_1",'."\n" + .'    "schemas": [],'."\n" + .'    "interpretations": ['."\n" + .'        {'."\n" + .'            "table": "table1",'."\n" + .'            "fields": ['."\n" + .'                {'."\n" + .'                    "name": "field1",'."\n" + .'                    "interpretation": " title"'."\n" + .'                },'."\n" + .'                {'."\n" + .'                    "name": "field2",'."\n" + .'                    "interpretation": " ID"'."\n" + .'                }'."\n" + .'            ]'."\n" + .'        }'."\n" + .'    ]'."\n" + .'}', + 'title' => '', ], 'configItems' => [ - 'title' => '配置项列表', 'type' => 'array', - 'items' => [ - 'title' => '配置项列表中的第一个元素', - 'type' => 'object', - ], - ], - 'updated' => [ - 'title' => '变更时间', - 'type' => 'integer', - 'format' => 'int64', - ], - 'created' => [ - 'title' => '创建时间', - 'type' => 'integer', - 'format' => 'int64', - ], - 'switchTime' => [ - 'title' => '切换上线时间', - 'type' => 'integer', - 'format' => 'int64', + 'items' => ['type' => 'object', 'description' => '', 'title' => '', 'example' => ''], + 'description' => '', + 'title' => '', + 'example' => '', ], + 'updated' => ['type' => 'integer', 'format' => 'int64', 'description' => '', 'title' => '', 'example' => ''], + 'created' => ['type' => 'integer', 'format' => 'int64', 'description' => '', 'title' => '', 'example' => ''], + 'switchTime' => ['type' => 'integer', 'format' => 'int64', 'description' => '', 'title' => '', 'example' => ''], ], 'example' => '{}', + 'title' => '', ], ], 'description' => '', - 'title' => '根节点或根目录', + 'title' => '', + 'example' => '', ], ], '5XX' => [ 'schema' => [ 'type' => 'object', 'properties' => [ - 'code' => [ - 'type' => 'string', - ], - 'message' => [ - 'type' => 'string', - ], - 'requestId' => [ - 'type' => 'string', - ], - 'httpCode' => [ - 'type' => 'integer', - 'format' => 'int32', - ], + 'code' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'message' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'requestId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'httpCode' => ['type' => 'integer', 'format' => 'int32', 'description' => '', 'title' => '', 'example' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"requestId\\": \\"ABCDEFG\\",\\n \\"result\\": {\\n \\"id\\": \\"12888\\",\\n \\"isCurrent\\": true,\\n \\"clusterName\\": \\"vpc_sh_domain_1\\",\\n \\"type\\": \\"standard\\",\\n \\"description\\": \\"我的应用\\",\\n \\"status\\": \\"OK\\",\\n \\"schema\\": {\\n \\"tables\\": {\\n \\"primaryTable\\": true,\\n \\"name\\": \\"main\\",\\n \\"fields\\": {\\n \\"id\\": {\\n \\"name\\": \\"id\\",\\n \\"type\\": \\"LITERAL\\",\\n \\"primaryKey\\": true\\n },\\n \\"title\\": {\\n \\"name\\": \\"title\\",\\n \\"type\\": \\"TEXT\\",\\n \\"primaryKey\\": false\\n },\\n \\"buy\\": {\\n \\"name\\": \\"buy\\",\\n \\"type\\": \\"INT\\",\\n \\"primaryKey\\": false\\n },\\n \\"cate_id\\": {\\n \\"name\\": \\"cate_id\\",\\n \\"type\\": \\"INT\\",\\n \\"primaryKey\\": false\\n },\\n \\"cate_name\\": {\\n \\"name\\": \\"cate_name\\",\\n \\"type\\": \\"LITERAL\\",\\n \\"primaryKey\\": false\\n }\\n }\\n },\\n \\"indexes\\": {\\n \\"filterFields\\": [\\n \\"id\\"\\n ],\\n \\"searchFields\\": {\\n \\"fields\\": [\\n \\"title\\"\\n ],\\n \\"analyzer\\": \\"chn_standard\\"\\n }\\n },\\n \\"routeField\\": \\"field1\\",\\n \\"routeFieldValues\\": [\\n \\"routeFieldValues\\"\\n ],\\n \\"secondRouteField\\": \\"field2\\\\n\\",\\n \\"ttlField\\": {\\n \\"name\\": \\"text1\\\\n\\",\\n \\"ttl\\": 1000\\n },\\n \\"indexSortConfig\\": [\\n {\\n \\"field\\": \\"field1\\",\\n \\"direction\\": \\"DESC\\"\\n }\\n ],\\n \\"name\\": \\"test\\"\\n },\\n \\"progressPercent\\": 100,\\n \\"fetchFields\\": [\\n \\"field1\\"\\n ],\\n \\"domain\\": {\\n \\"category\\": \\"-\\",\\n \\"name\\": \\"GENERAL\\",\\n \\"functions\\": {\\n \\"service\\": [\\n \\"suggest\\\\n\\\\n\\"\\n ],\\n \\"qp\\": [\\n \\"spellcheck\\"\\n ],\\n \\"algo\\": [\\n \\"pop\\"\\n ]\\n }\\n },\\n \\"schemas\\": [\\n {\\n \\"tables\\": {\\n \\"primaryTable\\": true,\\n \\"name\\": \\"main\\",\\n \\"fields\\": {\\n \\"id\\": {\\n \\"name\\": \\"id\\",\\n \\"type\\": \\"LITERAL\\",\\n \\"primaryKey\\": true\\n },\\n \\"title\\": {\\n \\"name\\": \\"title\\",\\n \\"type\\": \\"TEXT\\",\\n \\"primaryKey\\": false\\n },\\n \\"buy\\": {\\n \\"name\\": \\"buy\\",\\n \\"type\\": \\"INT\\",\\n \\"primaryKey\\": false\\n },\\n \\"cate_id\\": {\\n \\"name\\": \\"cate_id\\",\\n \\"type\\": \\"INT\\",\\n \\"primaryKey\\": false\\n },\\n \\"cate_name\\": {\\n \\"name\\": \\"cate_name\\",\\n \\"type\\": \\"LITERAL\\",\\n \\"primaryKey\\": false\\n }\\n }\\n },\\n \\"indexes\\": {\\n \\"filterFields\\": [\\n \\"field1\\"\\n ],\\n \\"searchFields\\": {\\n \\"fields\\": [\\n \\"title\\"\\n ],\\n \\"analyzer\\": \\"chn_standard\\"\\n }\\n },\\n \\"routeField\\": \\"field1\\\\n\\",\\n \\"routeFieldValues\\": [\\n \\"routeFieldValues\\"\\n ],\\n \\"secondRouteField\\": \\"field2\\",\\n \\"ttlField\\": {\\n \\"name\\": \\"fIeld1\\",\\n \\"ttl\\": 1000\\n },\\n \\"indexSortConfig\\": [\\n {\\n \\"field\\": \\"fIeld1\\",\\n \\"direction\\": \\"DESC\\"\\n }\\n ],\\n \\"name\\": \\"main\\"\\n }\\n ],\\n \\"firstRanks\\": [\\n {\\n \\"type\\": \\"STRING\\",\\n \\"name\\": \\"test\\",\\n \\"description\\": \\"描述\\",\\n \\"active\\": true,\\n \\"meta\\": \\"String :\\\\\\"random()*100+now()\\\\\\"；\\\\nArray: [\\\\n {\\\\n \\\\\\"attribute\\\\\\": \\\\\\"static_bm25()\\\\\\",\\\\n \\\\\\"arg\\\\\\": \\\\\\"\\\\\\",\\\\n \\\\\\"weight\\\\\\": 10\\\\n }\\\\n ]\\"\\n }\\n ],\\n \\"secondRanks\\": [\\n {\\n \\"meta\\": \\"\\\\\\"cate_id > 0 and cate_id < 1000\\\\\\"\\\\n\\",\\n \\"name\\": \\"default\\\\n\\",\\n \\"description\\": \\"default\\\\n\\",\\n \\"active\\": true\\n }\\n ],\\n \\"dataSources\\": [\\n {\\n \\"tableName\\": \\"main\\",\\n \\"type\\": \\"rds\\",\\n \\"fields\\": [\\n {\\n \\"id\\": \\"id\\"\\n }\\n ],\\n \\"plugins\\": {\\n \\"name\\": \\"JsonKeyValueExtractor\\",\\n \\"parameters\\": {\\n \\"key\\": \\"my_field\\"\\n }\\n },\\n \\"keyField\\": \\"id\\",\\n \\"schemaName\\": \\"table_name\\",\\n \\"parameters\\": {\\n \\"instanceId\\": \\"rds-instance-id\\",\\n \\"dbName\\": \\"my_db\\",\\n \\"dbTableName\\": \\"my_table\\",\\n \\"dbUser\\": \\"my\\",\\n \\"dbPassword\\": \\"my_passwd\\",\\n \\"filter\\": \\"\\",\\n \\"autoSync\\": true\\n }\\n }\\n ],\\n \\"summaries\\": [\\n {\\n \\"name\\": \\"fefault\\",\\n \\"meta\\": [\\n {\\n \\"field\\": \\"field1\\",\\n \\"len\\": 50,\\n \\"element\\": \\"em\\",\\n \\"ellipsis\\": \\"...\\",\\n \\"snippet\\": \\"5\\"\\n }\\n ]\\n }\\n ],\\n \\"queryProcessors\\": [\\n {\\n \\"name\\": \\"test\\",\\n \\"domain\\": \\"GENERAL\\",\\n \\"category\\": \\"\\\\\\"\\\\\\"\\",\\n \\"processors\\": [\\n {\\n \\"name\\": \\"stop_word\\",\\n \\"useSystemDictionary\\": true,\\n \\"interventionDictionary\\": \\"my_dict\\",\\n \\"ignoreSpace\\": true\\n }\\n ],\\n \\"indexes\\": [\\n \\"id\\"\\n ],\\n \\"active\\": true\\n }\\n ],\\n \\"cluster\\": {\\n \\"maxTimeoutMS\\": 750,\\n \\"maxQueryClauseLength\\": 1024,\\n \\"textEmbeddingModel\\": \\"\\",\\n \\"textSparseEmbeddingModel\\": \\"\\",\\n \\"chunkModels\\": [\\n {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n }\\n ],\\n \\"imageContentRecognizerModels\\": [\\n {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n }\\n ],\\n \\"graphRag\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n },\\n \\"vectorIndexConfigs\\": [\\n {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n }\\n ]\\n },\\n \\"prompts\\": [\\n {\\n \\"name\\": \\"prompt_name\\",\\n \\"isDefault\\": false,\\n \\"description\\": \\"描述\\",\\n \\"prompt\\": {\\n \\"parameters\\": [\\n {\\n \\"name\\": \\"docs\\",\\n \\"value\\": \\"doc内容的拼接方式，比如现在的 qwen的 \'
\\\\n${doc}\\\\n
\\\\n\\"\\n }\\n ],\\n \\"messages\\": [\\n {\\n \\"role\\": \\"role_name，这里是否需要限定只能是 system, user, assistant，还是可以让用户随意填写\\",\\n \\"content\\": \\"用户设置的prompt内容，里面可以使用 ${parameter_key} 来表示期望动态替换的内容，具体替换规则参考下面说明\\"\\n }\\n ]\\n }\\n }\\n ],\\n \\"quota\\": {\\n \\"qps\\": 5,\\n \\"computeResource\\": 20,\\n \\"docSize\\": 1,\\n \\"spec\\": \\"opensearch.share.common\\",\\n \\"usedQps\\": 100,\\n \\"usedDocSize\\": 1024,\\n \\"usedComputeResource\\": 100\\n },\\n \\"interpretations\\": [\\n {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n }\\n ],\\n \\"configItems\\": [\\n {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n }\\n ],\\n \\"updated\\": 0,\\n \\"created\\": 0,\\n \\"switchTime\\": 0\\n }\\n}","errorExample":""},{"type":"xml","example":"8664F6B7-9DD8-096A-FA3E-EBEE199EB94C\\n\\n 123456\\n \\n initializing\\n id\\n title\\n buy\\n cate_id\\n cate_name\\n enhanced\\n \\n \\n
\\n main\\n true\\n \\n \\n id\\n LITERAL\\n true\\n \\n \\n <name>title</name>\\n <type>TEXT</type>\\n <primaryKey>false</primaryKey>\\n \\n \\n buy\\n INT\\n false\\n \\n \\n cate_id\\n INT\\n false\\n \\n \\n cate_name\\n LITERAL\\n false\\n \\n \\n
\\n \\n \\n \\n \\n id\\n \\n \\n title\\n chn_standard\\n \\n \\n cate_name\\n \\n \\n id\\n buy\\n cate_id\\n cate_name\\n \\n \\n 0\\n 0\\n 0\\n","errorExample":""}]', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"ABCDEFG\\",\\n \\"result\\": {\\n \\"id\\": \\"12888\\",\\n \\"isCurrent\\": true,\\n \\"clusterName\\": \\"vpc_sh_domain_1\\",\\n \\"type\\": \\"standard\\",\\n \\"description\\": \\"My application\\",\\n \\"status\\": \\"OK\\",\\n \\"schema\\": {\\n \\"tables\\": {\\n \\"primaryTable\\": true,\\n \\"name\\": \\"main\\",\\n \\"fields\\": {\\n \\"id\\": {\\n \\"name\\": \\"id\\",\\n \\"type\\": \\"LITERAL\\",\\n \\"primaryKey\\": true\\n },\\n \\"title\\": {\\n \\"name\\": \\"title\\",\\n \\"type\\": \\"TEXT\\",\\n \\"primaryKey\\": false\\n },\\n \\"buy\\": {\\n \\"name\\": \\"buy\\",\\n \\"type\\": \\"INT\\",\\n \\"primaryKey\\": false\\n },\\n \\"cate_id\\": {\\n \\"name\\": \\"cate_id\\",\\n \\"type\\": \\"INT\\",\\n \\"primaryKey\\": false\\n },\\n \\"cate_name\\": {\\n \\"name\\": \\"cate_name\\",\\n \\"type\\": \\"LITERAL\\",\\n \\"primaryKey\\": false\\n }\\n }\\n },\\n \\"indexes\\": {\\n \\"filterFields\\": [\\n \\"id\\"\\n ],\\n \\"searchFields\\": {\\n \\"fields\\": [\\n \\"title\\"\\n ],\\n \\"analyzer\\": \\"chn_standard\\"\\n }\\n },\\n \\"routeField\\": \\"field1\\",\\n \\"routeFieldValues\\": [\\n \\"routeFieldValues\\"\\n ],\\n \\"secondRouteField\\": \\"field2\\\\n\\",\\n \\"ttlField\\": {\\n \\"name\\": \\"text1\\\\n\\",\\n \\"ttl\\": 1000\\n },\\n \\"indexSortConfig\\": [\\n {\\n \\"field\\": \\"field1\\",\\n \\"direction\\": \\"DESC\\"\\n }\\n ],\\n \\"name\\": \\"test\\"\\n },\\n \\"progressPercent\\": 100,\\n \\"fetchFields\\": [\\n \\"field1\\"\\n ],\\n \\"domain\\": {\\n \\"category\\": \\"-\\",\\n \\"name\\": \\"GENERAL\\",\\n \\"functions\\": {\\n \\"service\\": [\\n \\"suggest\\\\n\\\\n\\"\\n ],\\n \\"qp\\": [\\n \\"spellcheck\\"\\n ],\\n \\"algo\\": [\\n \\"pop\\"\\n ]\\n }\\n },\\n \\"schemas\\": [\\n {\\n \\"tables\\": {\\n \\"primaryTable\\": true,\\n \\"name\\": \\"main\\",\\n \\"fields\\": {\\n \\"id\\": {\\n \\"name\\": \\"id\\",\\n \\"type\\": \\"LITERAL\\",\\n \\"primaryKey\\": true\\n },\\n \\"title\\": {\\n \\"name\\": \\"title\\",\\n \\"type\\": \\"TEXT\\",\\n \\"primaryKey\\": false\\n },\\n \\"buy\\": {\\n \\"name\\": \\"buy\\",\\n \\"type\\": \\"INT\\",\\n \\"primaryKey\\": false\\n },\\n \\"cate_id\\": {\\n \\"name\\": \\"cate_id\\",\\n \\"type\\": \\"INT\\",\\n \\"primaryKey\\": false\\n },\\n \\"cate_name\\": {\\n \\"name\\": \\"cate_name\\",\\n \\"type\\": \\"LITERAL\\",\\n \\"primaryKey\\": false\\n }\\n }\\n },\\n \\"indexes\\": {\\n \\"filterFields\\": [\\n \\"field1\\"\\n ],\\n \\"searchFields\\": {\\n \\"fields\\": [\\n \\"title\\"\\n ],\\n \\"analyzer\\": \\"chn_standard\\"\\n }\\n },\\n \\"routeField\\": \\"field1\\\\n\\",\\n \\"routeFieldValues\\": [\\n \\"routeFieldValues\\"\\n ],\\n \\"secondRouteField\\": \\"field2\\",\\n \\"ttlField\\": {\\n \\"name\\": \\"fIeld1\\",\\n \\"ttl\\": 1000\\n },\\n \\"indexSortConfig\\": [\\n {\\n \\"field\\": \\"fIeld1\\",\\n \\"direction\\": \\"DESC\\"\\n }\\n ],\\n \\"name\\": \\"main\\"\\n }\\n ],\\n \\"firstRanks\\": [\\n {\\n \\"type\\": \\"STRING\\",\\n \\"name\\": \\"test\\",\\n \\"description\\": \\"描述\\",\\n \\"active\\": true,\\n \\"meta\\": \\"String :\\\\\\"random()*100+now()\\\\\\"；\\\\nArray: [\\\\n {\\\\n \\\\\\"attribute\\\\\\": \\\\\\"static_bm25()\\\\\\",\\\\n \\\\\\"arg\\\\\\": \\\\\\"\\\\\\",\\\\n \\\\\\"weight\\\\\\": 10\\\\n }\\\\n ]\\"\\n }\\n ],\\n \\"secondRanks\\": [\\n {\\n \\"meta\\": \\"\\\\\\"cate_id > 0 and cate_id < 1000\\\\\\"\\\\n\\",\\n \\"name\\": \\"default\\\\n\\",\\n \\"description\\": \\"default\\\\n\\",\\n \\"active\\": true\\n }\\n ],\\n \\"dataSources\\": [\\n {\\n \\"tableName\\": \\"main\\",\\n \\"type\\": \\"rds\\",\\n \\"fields\\": [\\n {\\n \\"id\\": \\"id\\"\\n }\\n ],\\n \\"plugins\\": {\\n \\"name\\": \\"JsonKeyValueExtractor\\",\\n \\"parameters\\": {\\n \\"key\\": \\"my_field\\"\\n }\\n },\\n \\"keyField\\": \\"id\\",\\n \\"schemaName\\": \\"table_name\\",\\n \\"parameters\\": {\\n \\"instanceId\\": \\"rds-instance-id\\",\\n \\"dbName\\": \\"my_db\\",\\n \\"dbTableName\\": \\"my_table\\",\\n \\"dbUser\\": \\"my\\",\\n \\"dbPassword\\": \\"my_passwd\\",\\n \\"filter\\": \\"\\",\\n \\"autoSync\\": true\\n }\\n }\\n ],\\n \\"summaries\\": [\\n {\\n \\"name\\": \\"fefault\\",\\n \\"meta\\": [\\n {\\n \\"field\\": \\"field1\\",\\n \\"len\\": 50,\\n \\"element\\": \\"em\\",\\n \\"ellipsis\\": \\"...\\",\\n \\"snippet\\": \\"5\\"\\n }\\n ]\\n }\\n ],\\n \\"queryProcessors\\": [\\n {\\n \\"name\\": \\"test\\",\\n \\"domain\\": \\"GENERAL\\",\\n \\"category\\": \\"\\\\\\"\\\\\\"\\",\\n \\"processors\\": [\\n {\\n \\"name\\": \\"stop_word\\",\\n \\"useSystemDictionary\\": true,\\n \\"interventionDictionary\\": \\"my_dict\\",\\n \\"ignoreSpace\\": true\\n }\\n ],\\n \\"indexes\\": [\\n \\"id\\"\\n ],\\n \\"active\\": true\\n }\\n ],\\n \\"cluster\\": {\\n \\"maxTimeoutMS\\": 750,\\n \\"maxQueryClauseLength\\": 1024,\\n \\"textEmbeddingModel\\": \\"\\",\\n \\"textSparseEmbeddingModel\\": \\"\\",\\n \\"chunkModels\\": [\\n {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n }\\n ],\\n \\"imageContentRecognizerModels\\": [\\n {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n }\\n ],\\n \\"graphRag\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n },\\n \\"vectorIndexConfigs\\": [\\n {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n }\\n ]\\n },\\n \\"prompts\\": [\\n {\\n \\"name\\": \\"prompt_name\\",\\n \\"isDefault\\": false,\\n \\"description\\": \\"描述\\",\\n \\"prompt\\": {\\n \\"parameters\\": [\\n {\\n \\"name\\": \\"docs\\",\\n \\"value\\": \\"doc内容的拼接方式，比如现在的 qwen的 \'
\\\\n${doc}\\\\n
\\\\n\\"\\n }\\n ],\\n \\"messages\\": [\\n {\\n \\"role\\": \\"role_name，这里是否需要限定只能是 system, user, assistant，还是可以让用户随意填写\\",\\n \\"content\\": \\"用户设置的prompt内容，里面可以使用 ${parameter_key} 来表示期望动态替换的内容，具体替换规则参考下面说明\\"\\n }\\n ]\\n }\\n }\\n ],\\n \\"quota\\": {\\n \\"qps\\": 5,\\n \\"computeResource\\": 20,\\n \\"docSize\\": 1,\\n \\"spec\\": \\"opensearch.share.common\\",\\n \\"usedQps\\": 100,\\n \\"usedDocSize\\": 1024,\\n \\"usedComputeResource\\": 100\\n },\\n \\"interpretations\\": [\\n {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n }\\n ],\\n \\"configItems\\": [\\n {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n }\\n ],\\n \\"updated\\": 0,\\n \\"created\\": 0,\\n \\"switchTime\\": 0\\n }\\n}","type":"json"}]', 'title' => 'CreateApp', - 'description' => '* When you create a standard application, a new version of the application is created if the specified application name already exists.'."\n" - .'* When you create a version of an existing application, you must specify the autoSwitch and realtimeShared parameters.'."\n" - .'* When you create a version of an existing application, the value of the quota parameter is the same as that of the quota parameter in the previous version of the application.'."\n" - .'* When you create a version of an existing application, the modification of the value of the quota parameter does not take effect.'."\n", + 'description' => '- If a Standard Edition application with the same name already exists, a new version is created.'."\n" + ."\n" + .'- The autoSwitch and realtimeShared parameters are required to create a new version.'."\n" + ."\n" + .'- The quota for the new version is automatically inherited from the previous version.'."\n" + ."\n" + .'- You cannot modify the quota when you create the new version.', 'requestParamsDescription' => '**Request body**'."\n" ."\n" - .'|Parameter|Type|Required|Example|Description|'."\n" - .'|---|---|---|---|---|'."\n" - .'|type|String|Yes|"standard"|The type of the application. Valid values:standard: standard edition.enhanced: advanced edition.|'."\n" - .'|schema|Object|Yes||The schema of the application.For more information, see [Schema](~~170003~~).|'."\n" - .'|fetchFields|Array|Yes|\\["id", "name"\\]|The default display fields.|'."\n" - .'|realtimeShared|Boolean|Yes|false|Specifies whether to synchronize real-time data between the online and offline versions of the application.|'."\n" - .'|autoSwitch|Boolean|Yes|false|Specifies whether to automatically publish the new version of the application.|'."\n" - .'|description|String|No|"demo"|The description of the application.|'."\n" - .'|quota|Object|No||The quota information about the application.For more information, see [Quota](~~170001~~).|'."\n" - .'|dataSources\\[\\]|Object|No||The information about each data source.For more information, see [DataSource](~~170005~~).|'."\n" - .'|firstRanks\\[\\]|Object|No||The information about each rough sort expression.For more information, see [FirstRank](~~170007~~).|'."\n" - .'|secondRanks\\[\\]|Object|No||The information about each fine sort expression.For more information, see [SecondRank](~~170008~~).|'."\n" - .'|queryProcessors\\[\\]|Object|No||The information about each query analysis rule.For more information, see [QueryProcessor](~~170014~~).|'."\n" - .'|summaries\\[\\]|Object|No||The settings of search result summaries.For more information, see [Summary](~~170016~~).|', + .'| Parameter | Type | Required | Example | Description |'."\n" + .'| ------------------ | ------- | -------- | --------------- | --------------------------------------------------------------------------------------------------------- |'."\n" + .'| type | String | Yes | "standard" | The application type.
- \\`standard\\`: Standard Edition
- \\`enhanced\\`: Premium Edition |'."\n" + .'| schema | Object | Yes | | The schema of the application version.
For more information, see [Schema](~~170003~~) |'."\n" + .'| fetchFields | Array | Yes | \\["id", "name"] | The default display fields. |'."\n" + .'| realtimeShared | Boolean | Yes | false | Specifies whether to share the real-time stream. |'."\n" + .'| autoSwitch | Boolean | Yes | false | Specifies whether to automatically set the version as the online version. |'."\n" + .'| description | String | No | "demo" | The description. |'."\n" + .'| quota | Object | No | | The quota of the application version.
For more information, see [Quota](~~170001~~) |'."\n" + .'| dataSources\\[] | Object | No | | The details of the data sources.
For more information, see [DataSource](~~170005~~) |'."\n" + .'| firstRanks\\[] | Object | No | | The details of the rough sort expressions.
For more information, see [FirstRank](~~170007~~) |'."\n" + .'| secondRanks\\[] | Object | No | | The details of the fine sort expressions.
For more information, see [SecondRank](~~170008~~) |'."\n" + .'| queryProcessors\\[] | Object | No | | The details of the intention recognition rules.
For more information, see [QueryProcessor](~~170014~~) |'."\n" + .'| summaries\\[] | Object | No | | The search result summary settings.
For more information, see [Summary](~~170016~~) |', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', - ], - 'RemoveApp' => [ - 'summary' => 'Deletes a version of an OpenSearch application.', - 'path' => '/v4/openapi/app-groups/{appGroupIdentity}/apps/{appId}', - 'methods' => [ - 'delete', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'opensearch:CreateApp', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'OpenSearch', 'resourceType' => 'App', 'arn' => 'acs:opensearch:{#regionId}:{#accountId}:app-groups/{#AppGroupId}'], + ], + ], + ], ], + 'translator' => 'manual', + ], + 'CreateAppGroup' => [ + 'summary' => 'Creates an OpenSearch application.', + 'path' => '/v4/openapi/app-groups', + 'methods' => ['post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -3773,128 +2358,379 @@ 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'delete', + 'operationType' => 'create', 'riskType' => 'none', - 'chargeType' => 'free', - 'abilityTreeCode' => '55248', - 'abilityTreeNodes' => [ - 'FEATUREopensearchGVH0IN', - 'FEATUREopensearch447AAX', - 'FEATUREopensearch5OZOSP', - ], + 'chargeType' => 'paid', + 'abilityTreeCode' => '55147', + 'abilityTreeNodes' => ['FEATUREopensearch2ESE2N', 'FEATUREopensearchG9QGQK', 'FEATUREopensearchO36CPI'], ], 'parameters' => [ [ - 'name' => 'appGroupIdentity', - 'in' => 'path', - 'schema' => [ - 'description' => 'The name or ID of the application.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '“my_app_group_name”', - ], - ], - [ - 'name' => 'appId', - 'in' => 'path', - 'schema' => [ - 'description' => 'The ID of the version.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'docRequired' => true, - 'example' => '110116134', - ], - ], - ], - 'responses' => [ - 200 => [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', 'schema' => [ + 'description' => 'The request body.', 'type' => 'object', 'properties' => [ - 'requestId' => [ - 'description' => 'The request ID.'."\n", + 'name' => ['description' => 'The name of the application.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => 'jmbon_analyzer'], + 'chargeType' => [ + 'description' => 'The billing method. Valid values:'."\n" + ."\n" + .'- POSTPAY: pay-as-you-go'."\n" + ."\n" + .'- PREPAY: subscription', 'type' => 'string', - 'example' => '33477D76-C380-2D84-A4AD-043F52876CB1', + 'required' => false, + 'enumValueTitles' => [], + 'title' => '', + 'example' => 'POSTPAY', ], - 'result' => [ - 'description' => 'The return result.', + 'type' => ['description' => 'The application type. Valid values:'."\n" + ."\n" + .'- standard: Standard Edition'."\n" + ."\n" + .'- enhanced: Premium Edition', 'type' => 'string', 'required' => false, 'title' => '', 'example' => 'enhanced'], + 'resourceGroupId' => ['description' => 'The ID of the resource group to which the instance belongs.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => 'rg-acfm2ij6pwxsvua'], + 'tags' => [ + 'description' => 'The tags.', 'type' => 'array', 'items' => [ - 'description' => 'The return result.', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '""', + 'description' => 'The tag object.', + 'type' => 'object', + 'properties' => [ + 'key' => ['description' => 'The tag key.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => 'a'], + 'value' => ['description' => 'The tag value.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => '1'], + ], + 'required' => false, + 'title' => '', + 'example' => '', + ], + 'required' => false, + 'title' => '', + 'example' => '', + ], + 'quota' => [ + 'description' => 'The quota.', + 'type' => 'object', + 'properties' => [ + 'docSize' => ['description' => 'The storage capacity. Unit: GB.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'title' => '', 'example' => '1'], + 'computeResource' => ['description' => 'The computing resources. Unit: logical computing unit (LCU).', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'title' => '', 'example' => '20'], + 'spec' => ['description' => 'The specifications. Valid values:'."\n" + ."\n" + .'- opensearch.share.junior: basic'."\n" + ."\n" + .'- opensearch.share.common: shared general-purpose'."\n" + ."\n" + .'- opensearch.share.compute: shared compute-optimized'."\n" + ."\n" + .'- opensearch.share.storage: shared storage-optimized'."\n" + ."\n" + .'- opensearch.private.common: exclusive general-purpose'."\n" + ."\n" + .'- opensearch.private.compute: exclusive compute-optimized'."\n" + ."\n" + .'- opensearch.private.storage: exclusive storage-optimized', 'type' => 'string', 'required' => false, 'title' => '', 'example' => 'opensearch.share.common'], ], + 'required' => false, + 'title' => '', + 'example' => '', ], ], - 'description' => '', - ], + 'required' => false, + 'title' => '', + 'example' => '', + ], ], - '5XX' => [ + ], + 'responses' => [ + 200 => [ 'schema' => [ + 'description' => 'The response body.', 'type' => 'object', 'properties' => [ - 'code' => [ - 'type' => 'string', - ], - 'message' => [ - 'type' => 'string', - ], - 'requestId' => [ - 'type' => 'string', - ], - 'httpCode' => [ - 'type' => 'integer', - 'format' => 'int32', + 'requestId' => ['description' => 'The request ID.', 'type' => 'string', 'title' => '', 'example' => '766CF6DB-CA02-3E12-7CBA-6AC21FC978FD'], + 'result' => [ + 'description' => 'This parameter is left empty.', + 'type' => 'object', + 'properties' => [ + 'created' => ['description' => 'The timestamp when the application was created.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '1590139542'], + 'currentVersion' => ['description' => 'The ID of the current online version.', 'type' => 'string', 'title' => '', 'example' => '100302903'], + 'lockMode' => ['description' => 'The lock state. Valid values:'."\n" + ."\n" + .'- Unlock: The instance is unlocked.'."\n" + ."\n" + .'- LockByExpiration: The instance is automatically locked after it expires.'."\n" + ."\n" + .'- ManualLock: The instance is manually locked.', 'type' => 'string', 'title' => '', 'example' => 'Unlock'], + 'updated' => ['description' => 'The timestamp when the application was last modified.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '1590978265'], + 'id' => ['description' => 'The application ID.', 'type' => 'string', 'title' => '', 'example' => '100302881'], + 'chargeType' => ['description' => 'The billing method. Valid values:'."\n" + ."\n" + .'- POSTPAY: pay-as-you-go'."\n" + ."\n" + .'- PREPAY: subscription', 'type' => 'string', 'title' => '', 'example' => 'POSTPAY'], + 'hasPendingQuotaReviewTask' => ['description' => 'The approval status of the quota. Valid values:'."\n" + ."\n" + .'- 0: The application is running as normal.'."\n" + ."\n" + .'- 1: The quota change is under review.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '0'], + 'name' => ['description' => 'The name of the application.', 'type' => 'string', 'title' => '', 'example' => 'lsh_test_1'], + 'instanceId' => ['description' => 'The instance ID.', 'type' => 'string', 'title' => '', 'example' => '-'], + 'chargingWay' => ['description' => 'The billing type. Valid values:'."\n" + ."\n" + .'- 1: computing resources'."\n" + ."\n" + .'- 2: queries per second (QPS)', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '1'], + 'type' => ['description' => 'The application type. Valid values:'."\n" + ."\n" + .'- standard: Standard Edition'."\n" + ."\n" + .'- advance: an old version of Premium Edition. You cannot create new applications of this type.'."\n" + ."\n" + .'- enhanced: a new version of Premium Edition', 'type' => 'string', 'title' => '', 'example' => 'enhanced'], + 'status' => ['description' => 'The application status. Valid values:'."\n" + ."\n" + .'- producing: The application is being created.'."\n" + ."\n" + .'- review\\_pending: The application is under review.'."\n" + ."\n" + .'- config\\_pending: The application is pending configuration.'."\n" + ."\n" + .'- normal: The application is running as normal.'."\n" + ."\n" + .'- frozen: The application is frozen.', 'type' => 'string', 'title' => '', 'example' => 'normal'], + 'projectId' => ['description' => 'The name of the A/B test project.', 'type' => 'string', 'title' => '', 'example' => '-'], + 'switchedTime' => ['description' => 'The timestamp when the current online version was published.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '1590486386'], + 'commodityCode' => ['description' => 'The commodity code.', 'type' => 'string', 'title' => '', 'example' => 'opensearch'], + 'expireOn' => ['description' => 'The expiration time.', 'type' => 'string', 'title' => '', 'example' => '-'], + 'domain' => ['description' => 'The industry type. Valid values:'."\n" + ."\n" + .'- GENERAL'."\n" + ."\n" + .'- ECOMMERCE'."\n" + ."\n" + .'- IT\\_CONTENT', 'type' => 'string', 'title' => '', 'example' => 'GENERAL'], + 'description' => ['description' => 'The description of the application.', 'type' => 'string', 'title' => '', 'example' => '-'], + 'produced' => ['description' => 'Indicates whether the application is created. Valid values:'."\n" + ."\n" + .'- 0: The application is being created.'."\n" + ."\n" + .'- 1: The application is created.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '1'], + 'quota' => [ + 'description' => 'The quota information for the application.', + 'type' => 'object', + 'properties' => [ + 'spec' => ['description' => 'The specifications. Valid values:'."\n" + ."\n" + .'- opensearch.share.junior: basic'."\n" + ."\n" + .'- opensearch.share.common: shared general-purpose'."\n" + ."\n" + .'- opensearch.share.compute: shared compute-optimized'."\n" + ."\n" + .'- opensearch.share.storage: shared storage-optimized'."\n" + ."\n" + .'- opensearch.private.common: exclusive general-purpose'."\n" + ."\n" + .'- opensearch.private.compute: exclusive compute-optimized'."\n" + ."\n" + .'- opensearch.private.storage: exclusive storage-optimized', 'type' => 'string', 'title' => '', 'example' => 'opensearch.share.common'], + 'docSize' => ['description' => 'The storage capacity. Unit: GB.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '1'], + 'computeResource' => ['description' => 'The computing resources. Unit: LCU.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '20'], + ], + 'title' => '', + 'example' => '', + ], + 'engineType' => ['description' => 'The engine type.', 'type' => 'string', 'title' => '', 'example' => 'ha3'], + ], + 'title' => '', + 'example' => '', ], ], + 'title' => '', + 'example' => '', + ], + ], + '5XX' => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'code' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'message' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'requestId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'httpCode' => ['type' => 'integer', 'format' => 'int32', 'description' => '', 'title' => '', 'example' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"33477D76-C380-2D84-A4AD-043F52876CB1\\",\\n \\"result\\": [\\n 0\\n ]\\n}","type":"json"}]', - 'title' => 'RemoveApp', + 'title' => 'CreateAppGroup', + 'requestParamsDescription' => '**Request body**'."\n" + ."\n" + .'| Parameter | Type | Required | Example | Description |'."\n" + .'| ------------------ | ------- | -------- | -------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |'."\n" + .'| name | String | Yes | "my_app" | The name of the application. |'."\n" + .'| type | String | Yes | "standard" | The application type.
Valid values:- standard: Standard Edition- enhanced: Premium Edition |'."\n" + .'| quota | Object | Yes | | The quota information for the application.
For more information, see [Quota](~~170001~~) |'."\n" + .'| chargeType | String | No | "POSTPAY" | The billing method.
Valid values:- POSTPAY: pay-as-you-go (default)- PREPAY: subscription |'."\n" + .'| order | Object | No | {"duration": 1,"pricingCycle": "Year"} | The subscription details. |'."\n" + .'| order.duration | Integer | \\-- | 1 | The subscription duration.
The minimum value is 0. |'."\n" + .'| order.pricingCycle | String | \\-- | "Year" | The unit of the subscription duration.
Valid values:- Year- Month |'."\n" + .'| order.autoRenew | Boolean | No | true | Specifies whether to enable auto-renewal. This parameter is valid only when the chargeType parameter is set to PREPAY. Valid values:* true: Auto-renewal is enabled.
* false: Auto-renewal is disabled. (Default) |', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'opensearch:CreateAppGroup', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'OpenSearch', 'resourceType' => 'AppGroup', 'arn' => 'acs:opensearch:{#regionId}:{#accountId}:app-groups/*'], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"766CF6DB-CA02-3E12-7CBA-6AC21FC978FD\\",\\n \\"result\\": {\\n \\"created\\": 1590139542,\\n \\"currentVersion\\": \\"100302903\\",\\n \\"lockMode\\": \\"Unlock\\",\\n \\"updated\\": 1590978265,\\n \\"id\\": \\"100302881\\",\\n \\"chargeType\\": \\"POSTPAY\\",\\n \\"hasPendingQuotaReviewTask\\": 0,\\n \\"name\\": \\"lsh_test_1\\",\\n \\"instanceId\\": \\"-\\",\\n \\"chargingWay\\": 1,\\n \\"type\\": \\"enhanced\\",\\n \\"status\\": \\"normal\\",\\n \\"projectId\\": \\"-\\",\\n \\"switchedTime\\": 1590486386,\\n \\"commodityCode\\": \\"opensearch\\",\\n \\"expireOn\\": \\"-\\",\\n \\"domain\\": \\"GENERAL\\",\\n \\"description\\": \\"-\\",\\n \\"produced\\": 1,\\n \\"quota\\": {\\n \\"spec\\": \\"opensearch.share.common\\",\\n \\"docSize\\": 1,\\n \\"computeResource\\": 20\\n },\\n \\"engineType\\": \\"ha3\\"\\n }\\n}","type":"json"}]', + 'translator' => 'manual', ], - 'DescribeApps' => [ - 'summary' => 'Queries the version list of an OpenSearch application.', - 'path' => '/v4/openapi/app-groups/{appGroupIdentity}/apps', - 'methods' => [ - 'get', + 'CreateAppGroupCredentials' => [ + 'path' => '/v4/openapi/app-groups/{appGroupIdentity}/credentials', + 'methods' => ['post'], + 'schemes' => ['http', 'https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'abilityTreeCode' => '228583', + 'abilityTreeNodes' => ['FEATUREopensearch1AJKH0'], + ], + 'parameters' => [ + [ + 'name' => 'dryRun', + 'in' => 'query', + 'schema' => ['description' => 'Specifies whether to perform a dry run. In a dry run, the system checks the request parameters but does not execute the operation.', 'type' => 'boolean', 'required' => false, 'title' => '', 'example' => ''], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', + 'schema' => [ + 'description' => 'The request body, which contains information such as the credential type.', + 'type' => 'object', + 'properties' => [ + 'type' => ['description' => 'The credential type, such as \\`api-key\\`, \\`account\\`, \\`invoke-key\\`, or \\`api-token\\`. To create an API key, set this parameter to \\`api-token\\`.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => 'api-token'], + ], + 'required' => false, + 'title' => '', + 'example' => '', + ], + ], + [ + 'name' => 'appGroupIdentity', + 'in' => 'path', + 'schema' => ['description' => 'The identity of the application group.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'app_group_123'], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => '', + 'description' => 'The structure of a successful response.', + 'type' => 'object', + 'properties' => [ + 'requestId' => ['title' => '', 'description' => 'The unique ID of the request.', 'type' => 'string', 'example' => '1-2-3-4'], + 'result' => [ + 'description' => 'The details of the operation result.', + 'type' => 'object', + 'properties' => [ + 'appGroupId' => ['description' => 'The ID of the application group.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => 'app_group_123'], + 'type' => ['description' => 'The credential type.', 'type' => 'string', 'title' => '', 'example' => 'api-token'], + 'enabled' => ['description' => 'Indicates whether the credential is enabled.', 'type' => 'boolean', 'title' => '', 'example' => ''], + 'token' => ['description' => 'The generated credential token.', 'type' => 'string', 'title' => '', 'example' => 'generated_token_string'], + ], + 'title' => '', + 'example' => '', + ], + ], + 'example' => '', + ], + ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'CreateAppGroupCredentials', + 'summary' => 'Creates access credentials for a specified application group. This operation supports a dry run to preview the results.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'opensearch:WriteAppGroupCredential', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'OpenSearch', 'resourceType' => 'AppGroupCredential', 'arn' => 'acs:opensearch:{#regionId}:{#accountId}:appGroup/{#AppGroupId}'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"1-2-3-4\\",\\n \\"result\\": {\\n \\"appGroupId\\": 0,\\n \\"type\\": \\"api-token\\",\\n \\"enabled\\": false,\\n \\"token\\": \\"generated_token_string\\"\\n }\\n}","type":"json"}]', + 'translator' => 'manual', + ], + 'CreateFirstRank' => [ + 'summary' => 'Creates a rough sort expression for a version of an OpenSearch application. If you set `dryRun` to true, this operation validates the specified rough sort expression. By default, the value of `dryRun` is `false`.', + 'path' => '/v4/openapi/app-groups/{appGroupIdentity}/apps/{appId}/first-ranks', + 'methods' => ['post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', + 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'list', + 'operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeCode' => '55172', - 'abilityTreeNodes' => [ - 'FEATUREopensearchGVH0IN', - 'FEATUREopensearch447AAX', - 'FEATUREopensearch5OZOSP', - ], + 'abilityTreeNodes' => ['FEATUREopensearchN8M8WS', 'FEATUREopensearchH8SRT8'], ], 'parameters' => [ + [ + 'name' => 'dryRun', + 'in' => 'query', + 'schema' => ['description' => 'Specifies whether to perform a dry run.', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'title' => ''], + ], [ 'name' => 'appGroupIdentity', 'in' => 'path', - 'schema' => [ - 'description' => 'my_app_group_name'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'my_app_group_name', - ], + 'schema' => ['description' => 'The name of the application.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'my_app_group_name', 'title' => ''], + ], + [ + 'name' => 'appId', + 'in' => 'path', + 'schema' => ['description' => 'The version number of the application.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true, 'example' => '110157886', 'title' => ''], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'schema' => ['description' => 'The request body, which contains the information about the rough sort expression.', '$ref' => '#/components/schemas/FirstRank', 'required' => false, 'title' => '', 'example' => ''], ], ], 'responses' => [ @@ -3902,1665 +2738,654 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'requestId' => [ - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => '77CAA411-0010-4DB9-82E2-1C384E590AFF', - ], + 'requestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '0A6EB64B-B4C8-CF02-810F-E660812972FF', 'title' => ''], 'result' => [ - 'description' => 'The response parameters.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The version information. For more information, see [App](~~170002~~).'."\n", - 'type' => 'object', - 'properties' => [ - 'id' => [ - 'description' => 'The group ID.'."\n", - 'type' => 'string', - 'example' => '100302881', - ], - 'isCurrent' => [ - 'description' => 'Indicates whether the version is an online version.'."\n", - 'type' => 'boolean', - 'example' => '12333', - ], - 'clusterName' => [ - 'description' => 'The cluster name.'."\n", - 'type' => 'string', - 'example' => 'vpc_sh_domain_1', - ], - 'autoSwitch' => [ - 'description' => 'Indicates whether the version is automatically switched to an online version.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'type' => [ - 'description' => 'The type of the application. Valid values:'."\n" - ."\n" - .'* standard: a standard edition application.'."\n" - .'* advance: an advanced edition application of an old version. New versions are not supported for this edition.'."\n" - .'* enhanced: an advanced edition application of a new version.'."\n", - 'type' => 'string', - 'example' => 'enhanced', - ], - 'description' => [ - 'description' => 'The description.'."\n", - 'type' => 'string', - 'example' => '""', - ], - 'status' => [ - 'description' => 'The status of the version. Valid values:'."\n" - ."\n" - .'* ok: The version is normal.'."\n" - .'* stopped: The version is suspended.'."\n" - .'* frozen: The version is frozen.'."\n" - .'* initializing: The version is being initialized.'."\n" - .'* unavailable: The version is invalid.'."\n" - .'* data_waiting: Data is to be initialized.'."\n" - .'* data_preparing: Data is being initialized.'."\n", - 'type' => 'string', - 'example' => 'normal', - ], - 'schema' => [ - 'description' => 'The application schema.'."\n", - 'type' => 'object', - 'properties' => [ - 'tables' => [ - 'description' => 'The table schema.'."\n", - 'type' => 'object', - ], - 'indexes' => [ - 'description' => 'The index schema.'."\n", - 'type' => 'object', - 'properties' => [ - 'filterFields' => [ - 'description' => 'The attribute fields.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The attribute field.'."\n", - 'type' => 'string', - 'example' => 'id', - ], - ], - 'searchFields' => [ - 'description' => 'The index fields.'."\n", - 'type' => 'object', - ], - ], - ], - 'routeField' => [ - 'description' => 'The level-1 routing field.'."\n", - 'type' => 'string', - 'example' => 'field1', - ], - 'routeFieldValues' => [ - 'description' => 'The hot values of the level-1 routing field.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The hot value of the level-1 routing field.'."\n", - 'type' => 'string', - 'example' => 'routeFieldValues', - ], - ], - 'secondRouteField' => [ - 'description' => 'The level-2 routing field. This parameter is returned if the routeFieldValues parameter is returned. By default, the wide-table primary key field is used as the level-2 routing field.'."\n", - 'type' => 'string', - 'example' => 'field2'."\n", - ], - 'ttlField' => [ - 'description' => 'The document clearing configurations.'."\n", - 'type' => 'object', - 'properties' => [ - 'name' => [ - 'description' => 'The document clearing field.'."\n", - 'type' => 'string', - 'example' => 'text1'."\n", - ], - 'ttl' => [ - 'description' => 'The TTL. Unit: milliseconds.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1000', - ], - ], - ], - 'indexSortConfig' => [ - 'description' => 'The sort configurations.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The sort configurations.'."\n", - 'type' => 'object', - 'properties' => [ - 'field' => [ - 'description' => 'The sort field.'."\n", - 'type' => 'string', - 'example' => 'field1', - ], - 'direction' => [ - 'description' => 'The sort method. Valid values:'."\n" - ."\n" - .'* ASC'."\n" - .'* DESC'."\n", - 'type' => 'string', - 'example' => 'DESC', - ], - ], - ], - ], - 'name' => [ - 'description' => 'The name of the wide table.'."\n", - 'type' => 'string', - 'example' => 'test', - ], - ], - ], - 'progressPercent' => [ - 'description' => 'The progress of data import, in percentage. For example, a value of 83 indicates 83%.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '100', - ], - 'fetchFields' => [ - 'description' => 'The default display fields.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The default display field.'."\n", - 'type' => 'string', - 'example' => '{}', - ], - ], - 'quota' => [ - 'description' => 'The quota information.'."\n", + 'description' => 'The information about the rough sort expression.', + 'type' => 'object', + 'properties' => [ + 'active' => ['description' => 'Indicates whether the expression is the default one.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'name' => ['description' => 'The name of the expression.', 'type' => 'string', 'example' => 'default', 'title' => ''], + 'meta' => [ + 'description' => 'The content of the expression.', + 'type' => 'array', + 'items' => [ 'type' => 'object', 'properties' => [ - 'spec' => [ - 'description' => 'The specifications. Valid values:'."\n" - ."\n" - .'* opensearch.share.junior: basic'."\n" - .'* opensearch.share.common: shared general-purpose'."\n" - .'* opensearch.share.compute: shared computing'."\n" - .'* opensearch.share.storage: shared storage'."\n" - .'* opensearch.private.common: exclusive general-purpose'."\n" - .'* opensearch.private.compute: exclusive computing'."\n" - .'* opensearch.private.storage: exclusive storage'."\n", - 'type' => 'string', - 'example' => 'opensearch.share.common', - ], - 'qps' => [ - 'description' => 'The number of search requests per second. You are charged based on the number of search requests per second in the earlier billing model.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '5', - ], - 'docSize' => [ - 'description' => 'The storage capacity. Unit: GB.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'computeResource' => [ - 'description' => 'The computing resources. Unit: logical computing unit (LCU).'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '20', - ], - ], - ], - 'domain' => [ - 'description' => 'The type of the industry. Valid values:'."\n" - ."\n" - .'* GENERAL'."\n" - .'* ECOMMERCE'."\n" - .'* IT_CONTENT'."\n", - 'type' => 'object', - 'properties' => [ - 'category' => [ - 'description' => 'The type of the edition. Valid values: standard, advance, and enhanced. A value of standard indicates a standard edition. A value of advance indicates an advanced edition which is of an old version. New version is not supported for this edition. A value of enhanced indicates an advanced edition which is of a new version.'."\n", - 'type' => 'string', - 'example' => '-', - ], - 'name' => [ - 'description' => 'The name (in English).'."\n", - 'type' => 'string', - 'example' => 'test', - ], - 'functions' => [ - 'description' => 'The search results.'."\n", - 'type' => 'object', - 'properties' => [ - 'service' => [ - 'description' => 'Feature 1.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'Feature 1.'."\n", - 'type' => 'string', - 'example' => '-', - ], - ], - 'qp' => [ - 'description' => 'Information 1.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'Information 1.'."\n", - 'type' => 'string', - 'example' => 'spellcheck', - ], - ], - 'algo' => [ - 'description' => 'Structure 1.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'Structure 1.'."\n", - 'type' => 'string', - 'example' => 'pop', - ], - ], - ], - ], - ], - ], - 'schemas' => [ - 'description' => 'The single-table schema.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The single-table schema.'."\n", - 'type' => 'object', - 'properties' => [ - 'tables' => [ - 'description' => 'The table schema.'."\n", - 'type' => 'object', - ], - 'indexes' => [ - 'description' => 'The index schema.'."\n", - 'type' => 'object', - 'properties' => [ - 'filterFields' => [ - 'description' => 'The attribute fields.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The attribute field.'."\n", - 'type' => 'string', - 'example' => 'field1', - ], - ], - 'searchFields' => [ - 'description' => 'The index fields.'."\n", - 'type' => 'object', - ], - ], - ], - 'routeField' => [ - 'description' => 'The level-1 routing field.'."\n", - 'type' => 'string', - 'example' => 'field1'."\n", - ], - 'routeFieldValues' => [ - 'description' => 'The hot values of the level-1 routing field.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The hot value of the level-1 routing field.'."\n", - 'type' => 'string', - 'example' => 'routeFieldValues', - ], - ], - 'secondRouteField' => [ - 'description' => 'The level-2 routing field. This parameter is returned if the routeFieldValues parameter is returned. By default, the wide-table primary key field is used as the level-2 routing field.'."\n", - 'type' => 'string', - 'example' => 'field2', - ], - 'ttlField' => [ - 'description' => 'The document clearing configurations.'."\n", - 'type' => 'object', - 'properties' => [ - 'name' => [ - 'description' => 'The document time field.'."\n", - 'type' => 'string', - 'example' => 'fIeld1', - ], - 'ttl' => [ - 'description' => 'The TTL. Unit: milliseconds.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1000', - ], - ], - ], - 'indexSortConfig' => [ - 'description' => 'The sort configurations.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The sort configurations.'."\n", - 'type' => 'object', - 'properties' => [ - 'field' => [ - 'description' => 'The sort field.'."\n", - 'type' => 'string', - 'example' => 'fIeld1', - ], - 'direction' => [ - 'description' => 'The sort method. Valid values:'."\n" - ."\n" - .'* ASC'."\n" - .'* DESC'."\n", - 'type' => 'string', - 'example' => 'DESC', - ], - ], - ], - ], - 'name' => [ - 'description' => 'The name of the wide table.'."\n", - 'type' => 'string', - 'example' => 'main', - ], - ], - ], - ], - 'firstRanks' => [ - 'description' => 'The configurations of rough sort.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The configurations of rough sort.'."\n", - 'type' => 'object', - 'properties' => [ - 'type' => [ - 'description' => 'The expression type. Valid values:'."\n" - ."\n" - .'STRUCT: The content of the expression is a structure. STRING (default): a custom formula.'."\n", - 'type' => 'string', - 'example' => 'STRING', - ], - 'name' => [ - 'description' => 'The name of the rough sort expression.'."\n", - 'type' => 'string', - 'example' => 'test', - ], - 'description' => [ - 'description' => 'The description.'."\n", - 'type' => 'string', - 'example' => 'Description'."\n", - ], - 'active' => [ - 'description' => 'Indicates whether the expression is the default one.'."\n", - 'type' => 'boolean', - 'example' => 'False', - ], - 'meta' => [ - 'description' => 'The information about the expression. The information is displayed in the array or string format.'."\n", - 'type' => 'any', - 'example' => 'String :"random()*100+now()";'."\n" - .'Array: ['."\n" - .' {'."\n" - .' "attribute": "static_bm25()",'."\n" - .' "arg": "",'."\n" - .' "weight": 10'."\n" - .' }'."\n" - .' ]', - ], - ], - ], - ], - 'secondRanks' => [ - 'description' => 'The configurations of fine sort.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The configurations of fine sort.'."\n", - 'type' => 'object', - 'properties' => [ - 'meta' => [ - 'description' => 'The fine sort expression. You can define an expression that consists of fields, feature functions, and mathematical functions to implement complex sort logic.'."\n", - 'type' => 'any', - 'example' => '"cate_id > 0 and cate_id < 1000"'."\n", - ], - 'name' => [ - 'description' => 'The name of the fine sort expression.'."\n", - 'type' => 'string', - 'example' => 'default'."\n", - ], - 'description' => [ - 'description' => 'The description.'."\n", - 'type' => 'string', - 'example' => 'Description'."\n", - ], - 'active' => [ - 'description' => 'Indicates whether the expression is the default one.'."\n", - 'type' => 'boolean', - 'example' => 'False', - ], - ], - ], - ], - 'dataSources' => [ - 'description' => 'The configurations of data sources.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The configurations of the data source.'."\n", - 'type' => 'object', - 'properties' => [ - 'tableName' => [ - 'description' => 'The name of the table in the application.'."\n", - 'type' => 'string', - 'example' => 'main', - ], - 'type' => [ - 'description' => 'The type of the data source. Valid values:'."\n" - ."\n" - .'* rds'."\n" - .'* odps'."\n" - .'* opensearch'."\n" - .'* polardb'."\n", - 'type' => 'string', - 'example' => 'rds', - ], - 'fields' => [ - 'description' => 'The information about field mappings.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The information about field mappings.'."\n", - 'type' => 'object', - ], - ], - 'plugins' => [ - 'description' => 'The plug-ins that are used for data processing.'."\n" - ."\n" - .'name:'."\n" - ."\n" - .'* JsonKeyValueExtractor'."\n" - .'* MultiValueSpliter'."\n" - .'* KeyValueExtractor'."\n" - .'* StringCatenateExtractor'."\n" - .'* HTMLTagRemover'."\n" - ."\n" - .'parameters:'."\n" - ."\n" - .'* JsonKeyValueExtractor'."\n" - .'* MultiValueSpliter'."\n" - .'* KeyValueExtractor'."\n" - .'* StringCatenateExtractor'."\n" - .'* HTMLTagRemover'."\n", - 'type' => 'object', - ], - 'keyField' => [ - 'description' => 'The primary key.'."\n", - 'type' => 'string', - 'example' => 'id', - ], - 'schemaName' => [ - 'description' => 'The name of the wide table.'."\n", - 'type' => 'string', - 'example' => 'name', - ], - 'parameters' => [ - 'description' => 'The information about the data source.'."\n", - 'type' => 'object', - ], - ], - ], - ], - 'summaries' => [ - 'description' => 'The search result summary configurations.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The search result summary configurations.'."\n", - 'type' => 'object', - 'properties' => [ - 'name' => [ - 'description' => 'The group name.'."\n", - 'type' => 'string', - 'example' => 'fefault', - ], - 'meta' => [ - 'description' => 'The summary configurations.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The summary configurations.'."\n", - 'type' => 'object', - 'properties' => [ - 'field' => [ - 'description' => 'The field.'."\n", - 'type' => 'string', - 'example' => 'field1', - ], - 'len' => [ - 'description' => 'The length of the segment. Valid values: 1 to 300.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '50', - ], - 'element' => [ - 'description' => 'The element that is used for highlighting.'."\n", - 'type' => 'string', - 'example' => 'em', - ], - 'ellipsis' => [ - 'description' => 'The connector that is used to connect segments.'."\n", - 'type' => 'string', - 'example' => '...', - ], - 'snippet' => [ - 'description' => 'The number of segments. Valid values: 1 to 5.'."\n", - 'type' => 'string', - 'example' => '5', - ], - ], - ], - ], - ], - ], - ], - 'queryProcessors' => [ - 'description' => 'The query intent understanding configurations.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The query intent understanding configurations.'."\n", - 'type' => 'object', - 'properties' => [ - 'name' => [ - 'description' => 'The rule name.'."\n", - 'type' => 'string', - 'example' => 'test', - ], - 'domain' => [ - 'description' => 'The type of the industry. Valid values:'."\n" - ."\n" - .'* GENERAL'."\n" - .'* ECOMMERCE'."\n" - .'* IT_CONTENT'."\n", - 'type' => 'string', - 'example' => 'GENERAL', - ], - 'category' => [ - 'description' => 'The industry category.'."\n", - 'type' => 'string', - 'example' => '""', - ], - 'processors' => [ - 'description' => 'The features.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The feature.'."\n", - 'type' => 'object', - ], - ], - 'indexes' => [ - 'description' => 'The indexes.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The index.'."\n", - 'type' => 'string', - 'example' => 'default', - ], - ], - 'active' => [ - 'description' => 'Indicates whether the rule is the default one.'."\n", - 'type' => 'boolean', - 'example' => 'False', - ], - ], - ], - ], - 'cluster' => [ - 'description' => 'The capability opening configurations.'."\n", - 'type' => 'object', - 'properties' => [ - 'maxTimeoutMS' => [ - 'description' => 'The timeout period. Unit: milliseconds.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '750', - ], - 'maxQueryClauseLength' => [ - 'description' => 'The maximum length of the query clause.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1024', - ], - ], - ], - 'interpretations' => [ - 'description' => 'The field model.'."\n", - 'type' => 'object', - ], - 'prompts' => [ - 'description' => 'The prompt configurations.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The prompt configurations.'."\n", - 'type' => 'object', + 'arg' => ['description' => 'The parameters that are used by a function in the expression.', 'type' => 'string', 'example' => '1', 'title' => ''], + 'attribute' => ['description' => 'The attribute, feature functions, or field to be searched for.', 'type' => 'string', 'example' => 'static_bm25()', 'title' => ''], + 'weight' => ['description' => 'The weight.'."\n" + .'Valid values: \\[-100000, 100000]. The value cannot be 0.', 'type' => 'number', 'format' => 'float', 'example' => '10', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], + 'title' => '', + 'example' => '', ], - 'example' => '{}', ], + 'title' => '', + 'example' => '', ], ], 'description' => '', + 'title' => '', + 'example' => '', ], ], '5XX' => [ 'schema' => [ 'type' => 'object', 'properties' => [ - 'code' => [ - 'type' => 'string', - ], - 'message' => [ - 'type' => 'string', - ], - 'requestId' => [ - 'type' => 'string', - ], - 'httpCode' => [ - 'type' => 'integer', - 'format' => 'int32', - ], + 'code' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'requestId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'message' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"requestId\\": \\"77CAA411-0010-4DB9-82E2-1C384E590AFF\\",\\n \\"result\\": [\\n {\\n \\"id\\": \\"100302881\\",\\n \\"isCurrent\\": true,\\n \\"clusterName\\": \\"vpc_sh_domain_1\\",\\n \\"autoSwitch\\": true,\\n \\"type\\": \\"enhanced\\",\\n \\"description\\": \\"\\\\\\"\\\\\\"\\",\\n \\"status\\": \\"normal\\",\\n \\"schema\\": {\\n \\"tables\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n },\\n \\"indexes\\": {\\n \\"filterFields\\": [\\n \\"id\\"\\n ],\\n \\"searchFields\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n }\\n },\\n \\"routeField\\": \\"field1\\",\\n \\"routeFieldValues\\": [\\n \\"routeFieldValues\\"\\n ],\\n \\"secondRouteField\\": \\"field2\\\\n\\",\\n \\"ttlField\\": {\\n \\"name\\": \\"text1\\\\n\\",\\n \\"ttl\\": 1000\\n },\\n \\"indexSortConfig\\": [\\n {\\n \\"field\\": \\"field1\\",\\n \\"direction\\": \\"DESC\\"\\n }\\n ],\\n \\"name\\": \\"test\\"\\n },\\n \\"progressPercent\\": 100,\\n \\"fetchFields\\": [\\n \\"{}\\"\\n ],\\n \\"quota\\": {\\n \\"spec\\": \\"opensearch.share.common\\",\\n \\"qps\\": 5,\\n \\"docSize\\": 1,\\n \\"computeResource\\": 20\\n },\\n \\"domain\\": {\\n \\"category\\": \\"-\\",\\n \\"name\\": \\"test\\",\\n \\"functions\\": {\\n \\"service\\": [\\n \\"-\\"\\n ],\\n \\"qp\\": [\\n \\"spellcheck\\"\\n ],\\n \\"algo\\": [\\n \\"pop\\"\\n ]\\n }\\n },\\n \\"schemas\\": [\\n {\\n \\"tables\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n },\\n \\"indexes\\": {\\n \\"filterFields\\": [\\n \\"field1\\"\\n ],\\n \\"searchFields\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n }\\n },\\n \\"routeField\\": \\"field1\\\\n\\",\\n \\"routeFieldValues\\": [\\n \\"routeFieldValues\\"\\n ],\\n \\"secondRouteField\\": \\"field2\\",\\n \\"ttlField\\": {\\n \\"name\\": \\"fIeld1\\",\\n \\"ttl\\": 1000\\n },\\n \\"indexSortConfig\\": [\\n {\\n \\"field\\": \\"fIeld1\\",\\n \\"direction\\": \\"DESC\\"\\n }\\n ],\\n \\"name\\": \\"main\\"\\n }\\n ],\\n \\"firstRanks\\": [\\n {\\n \\"type\\": \\"STRING\\",\\n \\"name\\": \\"test\\",\\n \\"description\\": \\"描述\\",\\n \\"active\\": true,\\n \\"meta\\": \\"String :\\\\\\"random()*100+now()\\\\\\"；\\\\nArray: [\\\\n {\\\\n \\\\\\"attribute\\\\\\": \\\\\\"static_bm25()\\\\\\",\\\\n \\\\\\"arg\\\\\\": \\\\\\"\\\\\\",\\\\n \\\\\\"weight\\\\\\": 10\\\\n }\\\\n ]\\"\\n }\\n ],\\n \\"secondRanks\\": [\\n {\\n \\"meta\\": \\"\\\\\\"cate_id > 0 and cate_id < 1000\\\\\\"\\\\n\\",\\n \\"name\\": \\"default\\\\n\\",\\n \\"description\\": \\"描述\\",\\n \\"active\\": true\\n }\\n ],\\n \\"dataSources\\": [\\n {\\n \\"tableName\\": \\"main\\",\\n \\"type\\": \\"rds\\",\\n \\"fields\\": [\\n {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n }\\n ],\\n \\"plugins\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n },\\n \\"keyField\\": \\"id\\",\\n \\"schemaName\\": \\"name\\",\\n \\"parameters\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n }\\n }\\n ],\\n \\"summaries\\": [\\n {\\n \\"name\\": \\"fefault\\",\\n \\"meta\\": [\\n {\\n \\"field\\": \\"field1\\",\\n \\"len\\": 50,\\n \\"element\\": \\"em\\",\\n \\"ellipsis\\": \\"...\\",\\n \\"snippet\\": \\"5\\"\\n }\\n ]\\n }\\n ],\\n \\"queryProcessors\\": [\\n {\\n \\"name\\": \\"test\\",\\n \\"domain\\": \\"GENERAL\\",\\n \\"category\\": \\"\\\\\\"\\\\\\"\\",\\n \\"processors\\": [\\n {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n }\\n ],\\n \\"indexes\\": [\\n \\"default\\"\\n ],\\n \\"active\\": true\\n }\\n ],\\n \\"cluster\\": {\\n \\"maxTimeoutMS\\": 750,\\n \\"maxQueryClauseLength\\": 1024\\n },\\n \\"interpretations\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n },\\n \\"prompts\\": [\\n {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n }\\n ]\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"71AB199D-8F00-5E69-BDC6-2829553D9BBC\\n\\n 123123321\\n \\n \\n 1650264344\\n 1650264631\\n standard\\n ok\\n 100\\n \\n 1\\n 1\\n 0\\n opensearch.share.common\\n 0\\n 0\\n 0\\n \\n \\n \\n \\n test\\n true\\n \\n \\n description\\n false\\n LITERAL\\n \\n \\n id\\n true\\n INT\\n \\n \\n \\n \\n \\n \\n \\n description\\n \\n \\n id\\n \\n \\n id\\n description\\n \\n \\n id\\n description\\n \\n default\\n sys default\\n true\\n 1650264343\\n 1650264343\\n STRUCT\\n \\n static_bm25()\\n \\n 1\\n \\n \\n \\n default\\n sys default\\n true\\n 1650264343\\n 1650264343\\n \\n true\\n \\n 1645520103\\n false\\n\\n\\n 121305419\\n \\n \\n 1645519817\\n 1645520103\\n standard\\n ok\\n 100\\n \\n 1\\n 1\\n 0\\n opensearch.share.common\\n 0\\n 0\\n 0\\n \\n \\n \\n \\n test\\n true\\n \\n \\n description\\n false\\n LITERAL\\n \\n \\n id\\n true\\n INT\\n \\n \\n \\n \\n \\n \\n \\n description\\n \\n \\n id\\n \\n \\n id\\n description\\n \\n \\n id\\n description\\n \\n default\\n sys default\\n true\\n 1645519817\\n 1645519817\\n STRUCT\\n \\n static_bm25()\\n \\n 1\\n \\n \\n \\n default\\n sys default\\n true\\n 1645519817\\n 1645519817\\n \\n true\\n \\n 1645520103\\n true\\n","errorExample":""}]', - 'title' => 'DescribeApps', - 'description' => '* When you create a standard application, a new version of the application is created if the specified application name already exists.'."\n" - .'* When you create a version of an existing application, you must specify the autoSwitch and realtimeShared parameters.'."\n" - .'* When you create a version of an existing application, the value of the quota parameter is the same as that of the quota parameter in the previous version of the application.'."\n" - .'* When you create a version of an existing application, the modification of the value of the quota parameter does not take effect.'."\n", - 'requestParamsDescription' => ' ', + 'title' => 'CreateFirstRank', + 'requestParamsDescription' => '**Request body**'."\n" + ."\n" + .'| Parameter | Type | Required | Example | Description |'."\n" + .'| ----------- | --------------- | -------- | --------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------- |'."\n" + .'| name | String | Yes | "test" | The name of the expression. |'."\n" + .'| type | String | Yes | "STRUCT" | The type of the expression. Valid values:
\\- STRUCT: The expression is a structure. This is the default value.
\\- STRING: The expression is a custom formula. |'."\n" + .'| meta | Array or String | Yes | | The content of the expression. |'."\n" + .'| description | String | No | "my_test" | The description of the expression. |'."\n" + .'| active | Boolean | No | true | Specifies whether the expression is the default one. |', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', - ], - 'DescribeApp' => [ - 'summary' => 'Queries the information about a version of an OpenSearch application.', - 'path' => '/v4/openapi/app-groups/{appGroupIdentity}/apps/{appId}', - 'methods' => [ - 'get', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'opensearch:WriteFirstRank', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'OpenSearch', 'resourceType' => 'FirstRank', 'arn' => 'acs:opensearch:{#regionId}:{#accountId}:apps/{#AppGroupId}'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"0A6EB64B-B4C8-CF02-810F-E660812972FF\\",\\n \\"result\\": {\\n \\"active\\": true,\\n \\"name\\": \\"default\\",\\n \\"meta\\": [\\n {\\n \\"arg\\": \\"1\\",\\n \\"attribute\\": \\"static_bm25()\\",\\n \\"weight\\": 10\\n }\\n ]\\n }\\n}","type":"json"}]', + 'translator' => 'manual', + ], + 'CreateFunctionInstance' => [ + 'summary' => 'Creates an algorithm instance of a feature.', + 'path' => '/v4/openapi/app-groups/{appGroupIdentity}/functions/{functionName}/instances', + 'methods' => ['post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'get', + 'operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeCode' => '55168', - 'abilityTreeNodes' => [ - 'FEATUREopensearchGVH0IN', - 'FEATUREopensearch447AAX', - 'FEATUREopensearch5OZOSP', - ], + 'abilityTreeCode' => '100229', + 'abilityTreeNodes' => ['FEATUREopensearch3QPM0K', 'FEATUREopensearchUIICM8', 'FEATUREopensearchZAE4HR'], ], 'parameters' => [ [ - 'name' => 'appGroupIdentity', - 'in' => 'path', - 'schema' => [ - 'description' => 'The name of the application'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'my_app_group_name', - ], - ], - [ - 'name' => 'appId', - 'in' => 'path', - 'schema' => [ - 'description' => 'The version ID.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'docRequired' => true, - 'example' => '110116134', - ], - ], - ], - 'responses' => [ - 200 => [ + 'name' => 'Body', + 'in' => 'body', + 'style' => 'json', 'schema' => [ - 'description' => 'The response body.'."\n", + 'title' => '', + 'description' => 'The request body.', 'type' => 'object', 'properties' => [ - 'requestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '33477D76-C380-1D84-A4AD-043F52876CB1', + 'instanceName' => ['description' => 'The instance name. The name must be 1 to 30 characters in length and can contain letters, digits, and underscores (\\_). The name is case-sensitive and must start with a letter.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'ctr_test'], + 'modelType' => ['description' => 'The model type. The value varies based on the model.'."\n" + ."\n" + .'- Click-through rate (CTR) model: tf\\_checkpoint'."\n" + ."\n" + .'- Popularity model: pop'."\n" + ."\n" + .'- Category model: offline\\_inference'."\n" + ."\n" + .'- Hotword model: offline\\_inference'."\n" + ."\n" + .'- Hint model: offline\\_inference'."\n" + ."\n" + .'- Hotword model for real-time top searches: near\\_realtime'."\n" + ."\n" + .'- Personalized hint model: near\\_realtime'."\n" + ."\n" + .'- Drop-down suggestion model: offline\\_inference'."\n" + ."\n" + .'- Tokenization model: text'."\n" + ."\n" + .'- Term weight model: tf\\_checkpoint'."\n" + ."\n" + .'- Synonym model: offline\\_inference', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'tf_checkpoint'], + 'functionType' => ['description' => 'The feature type.'."\n" + ."\n" + .'- Default value: PAAS. Training is required before you can use the feature.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => 'PAAS'], + 'description' => ['description' => 'The description.', 'type' => 'string', 'example' => 'Test instance', 'title' => '', 'required' => false], + 'createParameters' => [ + 'title' => '', + 'description' => 'The parameters used to create the instance.', + 'type' => 'array', + 'items' => [ + 'description' => 'The parameter body.', + 'type' => 'object', + 'properties' => [ + 'name' => ['description' => 'The parameter name.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => 'title_field'], + 'value' => ['description' => 'The parameter value.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => 'title'], + ], + 'required' => false, + 'example' => '{ "name": "title_field", "value": "title" }', + 'title' => '', + ], + 'required' => false, + 'example' => '[ { "name": "param1", "value": "val1" } ]', ], - 'result' => [ - 'description' => 'The version information.'."\n", + 'usageParameters' => [ + 'title' => '', + 'description' => 'The parameters used to use the instance.', + 'type' => 'array', + 'items' => [ + 'description' => 'The parameters that are used online, such as the blacklist and whitelist.', + 'type' => 'object', + 'properties' => [ + 'name' => ['description' => 'The parameter name.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => 'allow_dict_id'], + 'value' => ['description' => 'The parameter value.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => '123'], + ], + 'required' => false, + 'title' => '', + 'example' => '', + ], + 'required' => false, + 'example' => '', + ], + 'cron' => ['description' => 'The CRON expression used to schedule periodic training, in the format of Minutes Hours DayofMonth Month DayofWeek. The default value is empty, which specifies that no periodic training is performed. A value of 0 for DayofWeek specifies Sunday.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => '0 0 ? * 0,1,2,3,4,5,6'], + ], + 'required' => false, + 'docRequired' => true, + 'example' => '{ "instanceName": "ctr_test", "modelType": "tf_checkpoint", "createParameters": [ { "name": "title_field", "value": "title" }, { "name": "description_field", "value": "" }, { "name": "tags_field", "value": "" }, { "name": "id_field", "value": "item_id" }, { "name": "category_field", "value": "cate" } ], "description": "测试实例", }', + ], + ], + [ + 'name' => 'appGroupIdentity', + 'in' => 'path', + 'schema' => ['description' => 'The name of the application.', 'type' => 'string', 'required' => true, 'example' => 'my_app_group_name', 'title' => ''], + ], + [ + 'name' => 'functionName', + 'in' => 'path', + 'schema' => ['description' => 'The feature name. Valid values:'."\n" + ."\n" + .'- ctr: CTR model.'."\n" + ."\n" + .'- pop: popularity model.'."\n" + ."\n" + .'- category: category model.'."\n" + ."\n" + .'- hot: hotword model.'."\n" + ."\n" + .'- hint: hint model.'."\n" + ."\n" + .'- suggest: drop-down suggestion model.'."\n" + ."\n" + .'- analyzer: tokenization model.'."\n" + ."\n" + .'- termweight: term weight model.'."\n" + ."\n" + .'- synonym: synonym model.', 'type' => 'string', 'required' => true, 'example' => 'ctr', 'title' => ''], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => 'The parameter body.', + 'type' => 'object', + 'properties' => [ + 'Status' => ['description' => 'The status of the request.', 'type' => 'string', 'example' => 'OK', 'title' => ''], + 'HttpCode' => ['description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int64', 'example' => '200', 'title' => ''], + 'RequestId' => ['description' => 'The ID of the request.', 'type' => 'string', 'example' => '98724351-D6B2-5D8A-B089-7FFD1821A7E9', 'title' => ''], + 'Message' => ['description' => 'The error message. If no error occurs, this parameter is left empty.', 'type' => 'string', 'example' => 'version not exist.', 'title' => ''], + 'Code' => ['description' => 'The error code.', 'type' => 'string', 'example' => 'Version.NotExist', 'title' => ''], + 'Latency' => ['description' => 'The time consumed for the request, in milliseconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '123', 'title' => ''], + ], + 'example' => '{ "status" : "OK", "requestId" : "", "httpCode": 200, "code": "", "message": "", "latency" : 123, "result" : { } }', + 'title' => '', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Status\\": \\"OK\\",\\n \\"HttpCode\\": 200,\\n \\"RequestId\\": \\"98724351-D6B2-5D8A-B089-7FFD1821A7E9\\",\\n \\"Message\\": \\"version not exist.\\",\\n \\"Code\\": \\"Version.NotExist\\",\\n \\"Latency\\": 123\\n}","type":"json"}]', + 'title' => 'CreateFunctionInstance', + 'description' => 'You can call the [GetFunctionCurrentVersion](~~421377~~) operation to query the latest version of a feature. The response of the operation includes the createParameters parameter that is used to create an algorithm instance, the usageParameters parameter, and the requirements for setting these parameters.', + 'requestParamsDescription' => '### Sample requests (In this example, the functionName parameter is set to ctr.)'."\n" + ."\n" + .'```'."\n" + .'POST /v4/openapi/app-groups/my-app/functions/ctr/instances'."\n" + .'{'."\n" + .' "instanceName": "my_ctr",'."\n" + .' "modelType": "tf_checkpoint",'."\n" + .' "functionType": "PAAS",'."\n" + .' "cron": "0 0 ? * 0,1,3,5",'."\n" + .' "description": "",'."\n" + .' "createParameters": ['."\n" + .' {'."\n" + .' "name": "id_field",'."\n" + .' "value": "id"'."\n" + .' },'."\n" + .' {'."\n" + .' "name": "title_field",'."\n" + .' "value": "title"'."\n" + .' }'."\n" + .' ],'."\n" + .' "usageParameters": []'."\n" + .'}'."\n" + .'```'."\n" + ."\n" + .'### Sample requests (In this example, the functionName parameter is set to hot.)'."\n" + ."\n" + .'```'."\n" + .'POST /v4/openapi/app-groups/my-app/functions/hot/instances'."\n" + .'{'."\n" + .' "instanceName":"my_hot",'."\n" + .' "modelType":"offline_inference",'."\n" + .' "functionType":"PAAS",'."\n" + .' "createParameters":['."\n" + .' {'."\n" + .' "name":"filter",'."\n" + .' "value":"biz_type != 1"'."\n" + .' }'."\n" + .' ],'."\n" + .' "usageParameters": ['."\n" + .' {'."\n" + .' "name":"allow_dict_id",'."\n" + .' "value":"123"'."\n" + .' },'."\n" + .' {'."\n" + .' "name":"deny_dict_id",'."\n" + .' "value":"456"'."\n" + .' }'."\n" + .' ],'."\n" + .' "cron":"12 4 ? * 1,2,3,4,5,6,0"'."\n" + .'}'."\n" + .'```', + 'responseParamsDescription' => '### Sample success responses'."\n" + ."\n" + .'```'."\n" + .'{'."\n" + .' "status" : "OK",'."\n" + .' "requestId" : "98724351-D6B2-5D8A-B089-7FFD1821A7E9",'."\n" + .' "httpCode": 200,'."\n" + .' "code": "",'."\n" + .' "message": "",'."\n" + .' "latency" : 123,'."\n" + .' "result" : {}'."\n" + .'}'."\n" + .'```', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateFunctionInstance'], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'opensearch:WriteFunction', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'OpenSearch', 'resourceType' => 'FunctionInstance', 'arn' => 'acs:opensearch:{#regionId}:{#accountId}:apps/{#AppGroupId}'], + ], + ], + ], + ], + 'translator' => 'manual', + ], + 'CreateFunctionResource' => [ + 'path' => '/v4/openapi/app-groups/{appGroupIdentity}/functions/{functionName}/resources', + 'methods' => ['post'], + 'schemes' => ['http', 'https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'appGroupIdentity', + 'in' => 'path', + 'schema' => ['title' => '', 'description' => 'The ID or name of the application group.', 'type' => 'string', 'required' => true, 'example' => 'my_app_group_name'], + ], + [ + 'name' => 'functionName', + 'in' => 'path', + 'schema' => ['title' => '', 'description' => 'The name of the feature.', 'type' => 'string', 'required' => true, 'example' => 'rank'], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', + 'schema' => [ + 'description' => 'The request body.', + 'type' => 'object', + 'properties' => [ + 'Data' => [ + 'description' => 'The resource data. Its structure depends on the \\`ResourceType\\` value.', 'type' => 'object', 'properties' => [ - 'id' => [ - 'description' => 'The version ID.'."\n", - 'type' => 'string', - 'example' => '100303063', - ], - 'isCurrent' => [ - 'description' => 'Indices whether the version is an online version.'."\n", - 'type' => 'boolean', - 'example' => 'True', - ], - 'clusterName' => [ - 'description' => 'The cluster name.'."\n", - 'type' => 'string', - 'example' => '-', - ], - 'autoSwitch' => [ - 'description' => 'Indicates whether the version is automatically switched to an online version.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'type' => [ - 'description' => 'The edition type. Valid values:'."\n" - ."\n" - .'* standard: a standard edition application.'."\n" - .'* advance: an advanced edition application of an old version. New versions are not supported for this edition.'."\n" - .'* enhanced: an advanced edition application of a new version.'."\n", - 'type' => 'string', - 'example' => 'enhanced', - ], - 'description' => [ - 'description' => 'The description of the version.'."\n", - 'type' => 'string', - 'example' => '-', - ], - 'status' => [ - 'description' => 'The status of the version. Valid values:'."\n" - ."\n" - .'* ok: The version is normal.'."\n" - .'* stopped: The version is suspended.'."\n" - .'* frozen: The version is frozen.'."\n" - .'* initializing: The version is being initialized.'."\n" - .'* unavailable: The version is invalid.'."\n" - .'* data_waiting: Data is to be initialized.'."\n" - .'* data_preparing: Data is being initialized.'."\n", - 'type' => 'string', - 'example' => 'ok', - ], - 'schema' => [ - 'description' => 'The schema of the application.'."\n", - 'type' => 'object', - 'properties' => [ - 'tables' => [ - 'description' => 'The table schema.'."\n", - 'type' => 'object', - 'example' => '{'."\n" - .' "primaryTable": true,'."\n" - .' "name": "main",'."\n" - .' "fields": {'."\n" - .' "id": {'."\n" - .' "name": "id",'."\n" - .' "type": "LITERAL",'."\n" - .' "primaryKey": true'."\n" - .' },'."\n" - .' "title": {'."\n" - .' "name": "title",'."\n" - .' "type": "TEXT",'."\n" - .' "primaryKey": false'."\n" - .' },'."\n" - .' "buy": {'."\n" - .' "name": "buy",'."\n" - .' "type": "INT",'."\n" - .' "primaryKey": false'."\n" - .' },'."\n" - .' "cate_id": {'."\n" - .' "name": "cate_id",'."\n" - .' "type": "INT",'."\n" - .' "primaryKey": false'."\n" - .' },'."\n" - .' "cate_name": {'."\n" - .' "name": "cate_name",'."\n" - .' "type": "LITERAL",'."\n" - .' "primaryKey": false'."\n" - .' }'."\n" - .' }'."\n" - .'}', - ], - 'indexes' => [ - 'description' => 'The index schema.'."\n", - 'type' => 'object', - 'properties' => [ - 'filterFields' => [ - 'description' => 'The attribute fields.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The attribute field.'."\n", - 'type' => 'string', - 'example' => 'id', - ], - ], - 'searchFields' => [ - 'description' => 'The index fields.'."\n", - 'type' => 'object', - 'example' => '{'."\n" - .' "fields": ["title"],'."\n" - .' "analyzer": "chn_standard"'."\n" - .'}', - ], - ], - ], - 'routeField' => [ - 'description' => 'The name of the level-1 routing field.'."\n", - 'type' => 'string', - 'example' => 'field1', - ], - 'routeFieldValues' => [ - 'description' => 'The hot values of the level-1 routing field.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The hot value of the level-1 routing field.'."\n", + 'Content' => ['description' => 'The file content. Use this for \\`raw\\_file\\` resources.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => '"abc"'], + 'Generators' => [ + 'description' => 'A list of feature generators. Use this for \\`feature\\_generator\\` resources.', + 'type' => 'array', + 'items' => [ + 'description' => 'The details of the feature generator.', + 'type' => 'object', + 'properties' => [ + 'Generator' => [ + 'description' => 'The type of the feature generator.', 'type' => 'string', - 'example' => 'routeFieldValues', - ], - ], - 'secondRouteField' => [ - 'description' => 'The name of the level-2 routing field. This parameter takes effect only when the routeFieldValues parameter is configured. By default, the wide-table primary key field is used as the level-2 routing field.'."\n", - 'type' => 'string', - 'example' => 'field2'."\n", - ], - 'ttlField' => [ - 'description' => 'The document clearing configurations.'."\n", - 'type' => 'object', - 'properties' => [ - 'name' => [ - 'description' => 'The document time field.'."\n", - 'type' => 'string', - 'example' => 'text1'."\n", - ], - 'ttl' => [ - 'description' => 'The TTL. Unit: milliseconds.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1000', - ], + 'required' => false, + 'enumValueTitles' => ['lookup' => 'lookup', 'sequence' => 'sequence', 'overlap' => 'overlap', 'raw' => 'raw', 'combo' => 'combo', 'id' => 'id'], + 'title' => '', + 'example' => 'id', ], - ], - 'indexSortConfig' => [ - 'description' => 'The sort configurations.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The sort configurations.'."\n", + 'Input' => [ + 'description' => 'The input.', 'type' => 'object', 'properties' => [ - 'field' => [ - 'description' => 'The sort field.'."\n", - 'type' => 'string', - 'example' => 'field1', - ], - 'direction' => [ - 'description' => 'The sort method. Valid values:'."\n" - ."\n" - .'* ASC'."\n" - .'* DESC'."\n", - 'type' => 'string', - 'example' => 'DESC', + 'Features' => [ + 'description' => 'The list of input features.', + 'type' => 'array', + 'items' => [ + 'description' => 'An input feature.', + 'type' => 'object', + 'properties' => [ + 'Name' => ['description' => 'The name of the feature.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => 'system_item_id'], + 'Type' => [ + 'description' => 'The type of the feature.', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => ['item' => 'item', 'user' => 'user'], + 'title' => '', + 'example' => 'item', + ], + ], + 'required' => false, + 'title' => '', + 'example' => '', + ], + 'required' => false, + 'title' => '', + 'example' => '', ], ], + 'required' => false, + 'title' => '', + 'example' => '', ], + 'Output' => ['description' => 'The name of the output feature.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => 'item_id_feature'], ], - 'name' => [ - 'description' => 'The name of the wide table.'."\n", - 'type' => 'string', - 'example' => 'test', - ], - ], - 'example' => '{}', - ], - 'progressPercent' => [ - 'description' => 'The progress of data import, in percentage. For example, a value of 83 indicates 83%.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '100', - ], - 'fetchFields' => [ - 'description' => 'The default display fields.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The default display fields.'."\n", - 'type' => 'string', - 'example' => '{}', - ], - 'example' => '[]', - ], - 'quota' => [ - 'description' => 'The quota information.'."\n", - 'type' => 'object', - 'properties' => [ - 'spec' => [ - 'description' => 'The specifications. Valid values:'."\n" - ."\n" - .'* opensearch.share.junior: basic'."\n" - .'* opensearch.share.common: shared general-purpose'."\n" - .'* opensearch.share.compute: shared computing'."\n" - .'* opensearch.share.storage: shared storage'."\n" - .'* opensearch.private.common: exclusive general-purpose'."\n" - .'* opensearch.private.compute: exclusive computing'."\n" - .'* opensearch.private.storage: exclusive storage'."\n", - 'type' => 'string', - 'example' => 'opensearch.share.common', - ], - 'qps' => [ - 'description' => 'The number of search requests per second. You are charged based on the number of search requests per second in the earlier billing model.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '5', - ], - 'docSize' => [ - 'description' => 'The storage capacity. Unit: GB.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'computeResource' => [ - 'description' => 'The computing resources. Unit: logical computing unit (LCU).'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '20', - ], - ], - 'example' => '{}', - ], - 'domain' => [ - 'description' => 'The industry type. Valid values:'."\n" - ."\n" - .'* GENERAL'."\n" - .'* ECOMMERCE'."\n" - .'* IT_CONTENT'."\n", - 'type' => 'object', - 'properties' => [ - 'category' => [ - 'description' => 'The type of the edition. Valid values: standard, advance, and enhanced. A value of standard indicates a standard edition. A value of advance indicates an advanced edition which is of an old version. New version is not supported for this edition. A value of enhanced indicates an advanced edition which is of a new version.'."\n", - 'type' => 'string', - 'example' => '-', - ], - 'name' => [ - 'description' => 'The name (in English).'."\n", - 'type' => 'string', - 'example' => 'test', - ], - 'functions' => [ - 'description' => 'The search results.'."\n", - 'type' => 'object', - 'properties' => [ - 'service' => [ - 'description' => 'The description of each feature.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'Feature 1.'."\n", - 'type' => 'string', - 'example' => '-', - ], - 'example' => '[]', - ], - 'qp' => [ - 'description' => 'The information about the layout.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'Information 1.'."\n", - 'type' => 'string', - 'example' => '-', - ], - 'example' => '[]', - ], - 'algo' => [ - 'description' => 'The structure of the algorithm.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'Structure 1.'."\n", - 'type' => 'string', - 'example' => '-', - ], - 'example' => '[]', - ], - ], - 'example' => '{}', - ], - ], - 'example' => 'GENERAL', - ], - 'schemas' => [ - 'description' => 'The multi-table schema.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The single-table schema.'."\n", - 'type' => 'object', - 'properties' => [ - 'tables' => [ - 'description' => 'The table schema.'."\n", - 'type' => 'object', - 'example' => '{'."\n" - .' "primaryTable": true,'."\n" - .' "name": "main",'."\n" - .' "fields": {'."\n" - .' "id": {'."\n" - .' "name": "id",'."\n" - .' "type": "LITERAL",'."\n" - .' "primaryKey": true'."\n" - .' },'."\n" - .' "title": {'."\n" - .' "name": "title",'."\n" - .' "type": "TEXT",'."\n" - .' "primaryKey": false'."\n" - .' },'."\n" - .' "buy": {'."\n" - .' "name": "buy",'."\n" - .' "type": "INT",'."\n" - .' "primaryKey": false'."\n" - .' },'."\n" - .' "cate_id": {'."\n" - .' "name": "cate_id",'."\n" - .' "type": "INT",'."\n" - .' "primaryKey": false'."\n" - .' },'."\n" - .' "cate_name": {'."\n" - .' "name": "cate_name",'."\n" - .' "type": "LITERAL",'."\n" - .' "primaryKey": false'."\n" - .' }'."\n" - .' }'."\n" - .'}', - ], - 'indexes' => [ - 'description' => 'The index schema.'."\n", - 'type' => 'object', - 'properties' => [ - 'filterFields' => [ - 'description' => 'The attribute fields.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The attribute field.'."\n", - 'type' => 'string', - 'example' => 'field1', - ], - ], - 'searchFields' => [ - 'description' => 'The index fields.'."\n", - 'type' => 'object', - 'example' => '{'."\n" - .' "fields": ["title"],'."\n" - .' "analyzer": "chn_standard"'."\n" - .'}'."\n", - ], - ], - ], - 'routeField' => [ - 'description' => 'The name of the level-1 routing field.'."\n", - 'type' => 'string', - 'example' => 'field1'."\n", - ], - 'routeFieldValues' => [ - 'description' => 'The hot values of the level-1 routing field.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The hot value of the level-1 routing field.'."\n", - 'type' => 'string', - 'example' => 'routeFieldValues', - ], - ], - 'secondRouteField' => [ - 'description' => 'The name of the level-2 routing field. This parameter takes effect only when the routeFieldValues parameter is configured. By default, the wide-table primary key field is used as the level-2 routing field.'."\n", - 'type' => 'string', - 'example' => 'field2', - ], - 'ttlField' => [ - 'description' => 'The document clearing configurations.'."\n", - 'type' => 'object', - 'properties' => [ - 'name' => [ - 'description' => 'The document time field.'."\n", - 'type' => 'string', - 'example' => 'fIeld1', - ], - 'ttl' => [ - 'description' => 'The TTL. Unit: milliseconds.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1000', - ], - ], - ], - 'indexSortConfig' => [ - 'description' => 'The sort configurations.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The sort configurations.'."\n", - 'type' => 'object', - 'properties' => [ - 'field' => [ - 'description' => 'The sort field.'."\n", - 'type' => 'string', - 'example' => 'fIeld1', - ], - 'direction' => [ - 'description' => 'The sort method. Valid values:'."\n" - ."\n" - .'* ASC'."\n" - .'* DESC'."\n", - 'type' => 'string', - 'example' => 'DESC', - ], - ], - ], - ], - 'name' => [ - 'description' => 'The name of the wide table.'."\n", - 'type' => 'string', - 'example' => 'main', - ], - ], - ], - ], - 'firstRanks' => [ - 'description' => 'The configurations of rough sort.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The configurations of rough sort.'."\n", - 'type' => 'object', - 'properties' => [ - 'type' => [ - 'description' => 'The expression type. Valid values:'."\n" - ."\n" - .'STRUCT: The content of the expression is a structure. STRING (default): custom formula.'."\n", - 'type' => 'string', - 'example' => 'STRING', - ], - 'name' => [ - 'description' => 'The name of the rough sort expression.'."\n", - 'type' => 'string', - 'example' => 'test', - ], - 'description' => [ - 'description' => 'The description.'."\n", - 'type' => 'string', - 'example' => 'abc', - ], - 'active' => [ - 'description' => 'Indicates whether the expression is the default one.'."\n", - 'type' => 'boolean', - 'example' => 'False', - ], - 'meta' => [ - 'description' => 'The information about the expression. The information can be of the array or string type.'."\n", - 'type' => 'any', - 'example' => 'String :"random()*100+now()";'."\n" - .'Array: ['."\n" - .' {'."\n" - .' "attribute": "static_bm25()",'."\n" - .' "arg": "",'."\n" - .' "weight": 10'."\n" - .' }'."\n" - .' ]', - ], - ], - ], - ], - 'secondRanks' => [ - 'description' => 'The configurations of fine sort.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The configurations of fine sort.'."\n", - 'type' => 'object', - 'properties' => [ - 'meta' => [ - 'description' => 'The fine sort expression. You can define an expression that contains fields, feature functions, and mathematical functions to implement complex sort logic.'."\n", - 'type' => 'any', - 'example' => '"cate_id > 0 and cate_id < 1000"'."\n", - ], - 'name' => [ - 'description' => 'The name of the fine sort expression.'."\n", - 'type' => 'string', - 'example' => 'default'."\n", - ], - 'description' => [ - 'description' => 'The description.'."\n", - 'type' => 'string', - 'example' => 'Description', - ], - 'active' => [ - 'description' => 'Indicates whether the expression is the default one.'."\n", - 'type' => 'boolean', - 'example' => 'False', - ], - ], - ], - ], - 'dataSources' => [ - 'description' => 'The configurations of the data sources.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The configurations of the data source.'."\n", - 'type' => 'object', - 'properties' => [ - 'tableName' => [ - 'description' => 'The name of the table in the application.'."\n", - 'type' => 'string', - 'example' => 'main', - ], - 'type' => [ - 'description' => 'The type of the data source. Valid values:'."\n" - ."\n" - .'* rds'."\n" - .'* odps'."\n" - .'* opensearch'."\n" - .'* polardb'."\n", - 'type' => 'string', - 'example' => 'rds', - ], - 'fields' => [ - 'description' => 'The information about field mappings.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The information about field mappings.'."\n", - 'type' => 'object', - 'example' => '{'."\n" - .' "id": "id"'."\n" - .' }'."\n", - ], - ], - 'plugins' => [ - 'description' => 'The plug-ins that are used for data processing.'."\n" - ."\n" - .'name:'."\n" - ."\n" - .'* JsonKeyValueExtractor'."\n" - .'* MultiValueSpliter'."\n" - .'* KeyValueExtractor'."\n" - .'* StringCatenateExtractor'."\n" - .'* HTMLTagRemover'."\n" - ."\n" - .'parameters:'."\n" - ."\n" - .'* JsonKeyValueExtractor'."\n" - .'* MultiValueSpliter'."\n" - .'* KeyValueExtractor'."\n" - .'* StringCatenateExtractor'."\n" - .'* HTMLTagRemover'."\n", - 'type' => 'object', - 'example' => '{'."\n" - .' "name": "JsonKeyValueExtractor",'."\n" - .' "parameters": {'."\n" - .' "key": "my_field"'."\n" - .'}'."\n" - .'}', - ], - 'keyField' => [ - 'description' => 'The primary key.'."\n", - 'type' => 'string', - 'example' => 'id', - ], - 'schemaName' => [ - 'description' => 'The name of the wide table.'."\n", - 'type' => 'string', - 'example' => 'name', - ], - 'parameters' => [ - 'description' => 'The information about the data source.'."\n", - 'type' => 'object', - 'example' => '{'."\n" - .' "instanceId": "rds-instance-id",'."\n" - .' "dbName": "my_db",'."\n" - .' "dbTableName": "my_table",'."\n" - .' "dbUser": "my",'."\n" - .' "dbPassword": "my_passwd",'."\n" - .' "filter":"",'."\n" - .' "autoSync": true'."\n" - .'}'."\n", - ], - ], - ], - ], - 'summaries' => [ - 'description' => 'The summary configurations of search results.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The summary configurations of search results.'."\n", - 'type' => 'object', - 'properties' => [ - 'name' => [ - 'description' => 'The group name.'."\n", - 'type' => 'string', - 'example' => 'default', - ], - 'meta' => [ - 'description' => 'The summary configurations.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The summary configurations.'."\n", - 'type' => 'object', - 'properties' => [ - 'field' => [ - 'description' => 'The field.'."\n", - 'type' => 'string', - 'example' => 'field1', - ], - 'len' => [ - 'description' => 'The length of the segment. Valid values: 1 to 300.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '50', - ], - 'element' => [ - 'description' => 'The element that is used for highlighting.'."\n", - 'type' => 'string', - 'example' => 'em', - ], - 'ellipsis' => [ - 'description' => 'The connector that is used to connect segments.'."\n", - 'type' => 'string', - 'example' => '...', - ], - 'snippet' => [ - 'description' => 'The number of segments. Valid values: 1 to 5.'."\n", - 'type' => 'string', - 'example' => '5', - ], - ], - ], - ], - ], - ], - ], - 'queryProcessors' => [ - 'description' => 'The query intent understanding configurations.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The query intent understanding configurations.'."\n", - 'type' => 'object', - 'properties' => [ - 'name' => [ - 'description' => 'The rule name.'."\n", - 'type' => 'string', - 'example' => 'test', - ], - 'domain' => [ - 'description' => 'The industry type. Valid values:'."\n" - ."\n" - .'* GENERAL'."\n" - .'* ECOMMERCE'."\n" - .'* IT_CONTENT'."\n", - 'type' => 'string', - 'example' => 'GENERAL', - ], - 'category' => [ - 'description' => 'The industry category.'."\n", - 'type' => 'string', - 'example' => '""', - ], - 'processors' => [ - 'description' => 'The features.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The features.'."\n", - 'type' => 'object', - 'example' => '{'."\n" - .'"name": "stop_word", "useSystemDictionary": true,'."\n" - .'"interventionDictionary": "my_dict",'."\n" - .' "ignoreSpace": true'."\n" - .'}', - ], - ], - 'indexes' => [ - 'description' => 'Then index range.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The index.'."\n", - 'type' => 'string', - 'example' => 'default', - ], - ], - 'active' => [ - 'description' => 'Indicates whether the rule is the default one.'."\n", - 'type' => 'boolean', - 'example' => 'False', - ], - ], - ], - ], - 'cluster' => [ - 'description' => 'The capability opening configurations.'."\n", - 'type' => 'object', - 'properties' => [ - 'maxTimeoutMS' => [ - 'description' => 'The timeout period. Unit: milliseconds.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '750', - ], - 'maxQueryClauseLength' => [ - 'description' => 'The maximum length of the query clause.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1024', - ], - ], - ], - 'interpretations' => [ - 'description' => 'The industry model module.'."\n", - 'type' => 'object', - 'example' => '\\[ { "table": "table1", "fields": \\[ { "name": "field1", "interpretation": "Title" }, { "name": "field2", "interpretation": "Number" } ] } ]'."\n", - ], - 'prompts' => [ - 'description' => 'The prompt configurations.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The prompt configurations.'."\n", - 'type' => 'object', - 'example' => '{ "parameters" : \\[ { "name" : "docs", "value" : "The way in which the content of documents is concatenated, such as \'\\
\\n${doc}\\n\\
\\n." } ], "messages":\\[ { "role" : "role_name: specifies whether to specify only system, user, or assistant or specify a custom value.", "content" : "The content of the prompt configured by the user. ${parameter_key} can be used to specify the content that you want to dynamically replace. For more information about replacement rules, see the following instructions." } ] }'."\n", + 'required' => false, + 'title' => '', + 'example' => '', ], + 'required' => false, + 'title' => '', + 'example' => '', ], ], - 'example' => '{}', + 'required' => false, + 'title' => '', + 'example' => '', + ], + 'Description' => ['description' => 'The description of the resource.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => '""'], + 'ResourceName' => ['description' => 'The name of the resource.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => 'fg_jsoon'], + 'ResourceType' => [ + 'description' => 'The type of the resource.', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => ['feature_generator' => 'feature\\_generator', 'raw_file' => 'raw\\_file'], + 'title' => '', + 'example' => 'feature_generator', ], ], - 'example' => '{}', + 'required' => false, + 'docRequired' => true, + 'title' => '', + 'example' => '', ], ], - '5XX' => [ + ], + 'responses' => [ + 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ - 'code' => [ - 'type' => 'string', - ], - 'message' => [ - 'type' => 'string', - ], - 'requestId' => [ - 'type' => 'string', - ], - 'httpCode' => [ - 'type' => 'integer', - 'format' => 'int32', - ], + 'Status' => ['description' => 'The status of the request.'."\n" + ."\n" + .'- OK: The request was successful.'."\n" + ."\n" + .'- FAIL: The request failed.', 'type' => 'string', 'title' => '', 'example' => 'OK'], + 'HttpCode' => ['description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '200'], + 'RequestId' => ['description' => 'The ID of the request.', 'type' => 'string', 'title' => '', 'example' => 'A4D487A9-A456-5AA5-A9C6-B7BF2889CF74'], + 'Message' => ['description' => 'The returned message.', 'type' => 'string', 'title' => '', 'example' => '""'], + 'Code' => ['description' => 'The error code. This is empty if the request succeeds.', 'type' => 'string', 'title' => '', 'example' => '""'], + 'Latency' => ['description' => 'The request processing time in milliseconds.', 'type' => 'number', 'format' => 'double', 'title' => '', 'example' => '123'], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"requestId\\": \\"33477D76-C380-1D84-A4AD-043F52876CB1\\",\\n \\"result\\": {\\n \\"id\\": \\"100303063\\",\\n \\"isCurrent\\": true,\\n \\"clusterName\\": \\"-\\",\\n \\"autoSwitch\\": true,\\n \\"type\\": \\"enhanced\\",\\n \\"description\\": \\"-\\",\\n \\"status\\": \\"ok\\",\\n \\"schema\\": {\\n \\"tables\\": {\\n \\"primaryTable\\": true,\\n \\"name\\": \\"main\\",\\n \\"fields\\": {\\n \\"id\\": {\\n \\"name\\": \\"id\\",\\n \\"type\\": \\"LITERAL\\",\\n \\"primaryKey\\": true\\n },\\n \\"title\\": {\\n \\"name\\": \\"title\\",\\n \\"type\\": \\"TEXT\\",\\n \\"primaryKey\\": false\\n },\\n \\"buy\\": {\\n \\"name\\": \\"buy\\",\\n \\"type\\": \\"INT\\",\\n \\"primaryKey\\": false\\n },\\n \\"cate_id\\": {\\n \\"name\\": \\"cate_id\\",\\n \\"type\\": \\"INT\\",\\n \\"primaryKey\\": false\\n },\\n \\"cate_name\\": {\\n \\"name\\": \\"cate_name\\",\\n \\"type\\": \\"LITERAL\\",\\n \\"primaryKey\\": false\\n }\\n }\\n },\\n \\"indexes\\": {\\n \\"filterFields\\": [\\n \\"id\\"\\n ],\\n \\"searchFields\\": {\\n \\"fields\\": [\\n \\"title\\"\\n ],\\n \\"analyzer\\": \\"chn_standard\\"\\n }\\n },\\n \\"routeField\\": \\"field1\\",\\n \\"routeFieldValues\\": [\\n \\"routeFieldValues\\"\\n ],\\n \\"secondRouteField\\": \\"field2\\\\n\\",\\n \\"ttlField\\": {\\n \\"name\\": \\"text1\\\\n\\",\\n \\"ttl\\": 1000\\n },\\n \\"indexSortConfig\\": [\\n {\\n \\"field\\": \\"field1\\",\\n \\"direction\\": \\"DESC\\"\\n }\\n ],\\n \\"name\\": \\"test\\"\\n },\\n \\"progressPercent\\": 100,\\n \\"fetchFields\\": [\\n \\"{}\\"\\n ],\\n \\"quota\\": {\\n \\"spec\\": \\"opensearch.share.common\\",\\n \\"qps\\": 5,\\n \\"docSize\\": 1,\\n \\"computeResource\\": 20\\n },\\n \\"domain\\": {\\n \\"category\\": \\"-\\",\\n \\"name\\": \\"test\\",\\n \\"functions\\": {\\n \\"service\\": [\\n \\"-\\"\\n ],\\n \\"qp\\": [\\n \\"-\\"\\n ],\\n \\"algo\\": [\\n \\"-\\"\\n ]\\n }\\n },\\n \\"schemas\\": [\\n {\\n \\"tables\\": {\\n \\"primaryTable\\": true,\\n \\"name\\": \\"main\\",\\n \\"fields\\": {\\n \\"id\\": {\\n \\"name\\": \\"id\\",\\n \\"type\\": \\"LITERAL\\",\\n \\"primaryKey\\": true\\n },\\n \\"title\\": {\\n \\"name\\": \\"title\\",\\n \\"type\\": \\"TEXT\\",\\n \\"primaryKey\\": false\\n },\\n \\"buy\\": {\\n \\"name\\": \\"buy\\",\\n \\"type\\": \\"INT\\",\\n \\"primaryKey\\": false\\n },\\n \\"cate_id\\": {\\n \\"name\\": \\"cate_id\\",\\n \\"type\\": \\"INT\\",\\n \\"primaryKey\\": false\\n },\\n \\"cate_name\\": {\\n \\"name\\": \\"cate_name\\",\\n \\"type\\": \\"LITERAL\\",\\n \\"primaryKey\\": false\\n }\\n }\\n },\\n \\"indexes\\": {\\n \\"filterFields\\": [\\n \\"field1\\"\\n ],\\n \\"searchFields\\": {\\n \\"fields\\": [\\n \\"title\\"\\n ],\\n \\"analyzer\\": \\"chn_standard\\"\\n }\\n },\\n \\"routeField\\": \\"field1\\\\n\\",\\n \\"routeFieldValues\\": [\\n \\"routeFieldValues\\"\\n ],\\n \\"secondRouteField\\": \\"field2\\",\\n \\"ttlField\\": {\\n \\"name\\": \\"fIeld1\\",\\n \\"ttl\\": 1000\\n },\\n \\"indexSortConfig\\": [\\n {\\n \\"field\\": \\"fIeld1\\",\\n \\"direction\\": \\"DESC\\"\\n }\\n ],\\n \\"name\\": \\"main\\"\\n }\\n ],\\n \\"firstRanks\\": [\\n {\\n \\"type\\": \\"STRING\\",\\n \\"name\\": \\"test\\",\\n \\"description\\": \\"描述\\",\\n \\"active\\": true,\\n \\"meta\\": \\"String :\\\\\\"random()*100+now()\\\\\\"；\\\\nArray: [\\\\n {\\\\n \\\\\\"attribute\\\\\\": \\\\\\"static_bm25()\\\\\\",\\\\n \\\\\\"arg\\\\\\": \\\\\\"\\\\\\",\\\\n \\\\\\"weight\\\\\\": 10\\\\n }\\\\n ]\\"\\n }\\n ],\\n \\"secondRanks\\": [\\n {\\n \\"meta\\": \\"\\\\\\"cate_id > 0 and cate_id < 1000\\\\\\"\\\\n\\",\\n \\"name\\": \\"default\\\\n\\",\\n \\"description\\": \\"描述\\",\\n \\"active\\": true\\n }\\n ],\\n \\"dataSources\\": [\\n {\\n \\"tableName\\": \\"main\\",\\n \\"type\\": \\"rds\\",\\n \\"fields\\": [\\n {\\n \\"id\\": \\"id\\"\\n }\\n ],\\n \\"plugins\\": {\\n \\"name\\": \\"JsonKeyValueExtractor\\",\\n \\"parameters\\": {\\n \\"key\\": \\"my_field\\"\\n }\\n },\\n \\"keyField\\": \\"id\\",\\n \\"schemaName\\": \\"name\\",\\n \\"parameters\\": {\\n \\"instanceId\\": \\"rds-instance-id\\",\\n \\"dbName\\": \\"my_db\\",\\n \\"dbTableName\\": \\"my_table\\",\\n \\"dbUser\\": \\"my\\",\\n \\"dbPassword\\": \\"my_passwd\\",\\n \\"filter\\": \\"\\",\\n \\"autoSync\\": true\\n }\\n }\\n ],\\n \\"summaries\\": [\\n {\\n \\"name\\": \\"default\\",\\n \\"meta\\": [\\n {\\n \\"field\\": \\"field1\\",\\n \\"len\\": 50,\\n \\"element\\": \\"em\\",\\n \\"ellipsis\\": \\"...\\",\\n \\"snippet\\": \\"5\\"\\n }\\n ]\\n }\\n ],\\n \\"queryProcessors\\": [\\n {\\n \\"name\\": \\"test\\",\\n \\"domain\\": \\"GENERAL\\",\\n \\"category\\": \\"\\\\\\"\\\\\\"\\",\\n \\"processors\\": [\\n {\\n \\"name\\": \\"stop_word\\",\\n \\"useSystemDictionary\\": true,\\n \\"interventionDictionary\\": \\"my_dict\\",\\n \\"ignoreSpace\\": true\\n }\\n ],\\n \\"indexes\\": [\\n \\"default\\"\\n ],\\n \\"active\\": true\\n }\\n ],\\n \\"cluster\\": {\\n \\"maxTimeoutMS\\": 750,\\n \\"maxQueryClauseLength\\": 1024\\n },\\n \\"interpretations\\": [\\n {\\n \\"table\\": \\"table1\\",\\n \\"fields\\": [\\n {\\n \\"name\\": \\"field1\\",\\n \\"interpretation\\": \\"标题\\"\\n },\\n {\\n \\"name\\": \\"field2\\",\\n \\"interpretation\\": \\"编号\\"\\n }\\n ]\\n }\\n ],\\n \\"prompts\\": [\\n {\\n \\"parameters\\": [\\n {\\n \\"name\\": \\"docs\\",\\n \\"value\\": \\"doc内容的拼接方式，比如现在的 qwen的 \'
\\\\n${doc}\\\\n
\\\\n\\"\\n }\\n ],\\n \\"messages\\": [\\n {\\n \\"role\\": \\"role_name，这里是否需要限定只能是 system, user, assistant，还是可以让用户随意填写\\",\\n \\"content\\": \\"用户设置的prompt内容，里面可以使用 ${parameter_key} 来表示期望动态替换的内容，具体替换规则参考下面说明\\"\\n }\\n ]\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"33477D76-C380-1D84-A4AD-043F52876CB1\\n\\n 100303063\\n \\n ok\\n id\\n title\\n buy\\n cate_id\\n cate_name\\n enhanced\\n \\n \\n
\\n true\\n main\\n \\n \\n id\\n LITERAL\\n true\\n \\n \\n <name>title</name>\\n <type>TEXT</type>\\n <primaryKey>false</primaryKey>\\n \\n \\n buy\\n INT\\n false\\n \\n \\n cate_id\\n INT\\n false\\n \\n \\n cate_name\\n LITERAL\\n false\\n \\n \\n
\\n \\n \\n \\n \\n id\\n \\n \\n title\\n chn_standard\\n \\n \\n buy\\n \\n \\n id\\n buy\\n cate_id\\n cate_name\\n \\n \\n 0\\n \\n \\n default\\n \\n false\\n STRUCT\\n \\n static_bm25()\\n \\n 1\\n \\n 0\\n 0\\n \\n \\n 887857\\n first_rank_lsh_1\\n \\n true\\n STRUCT\\n \\n static_bm25()\\n \\n 10\\n \\n \\n exact_match_boost()\\n \\n 20\\n \\n \\n buy\\n \\n 30\\n \\n 1590977140\\n 1590977140\\n \\n \\n -1\\n default\\n \\n true\\n \\n 0\\n 0\\n \\n \\n default\\n \\n title\\n 50\\n em\\n ...\\n 1\\n \\n \\n 1590977140\\n \\n sum_lsh_test_1\\n true\\n default\\n \\n true\\n \\n stop_word\\n \\n \\n true\\n \\n spell_check\\n \\n \\n true\\n \\n term_weighting\\n \\n \\n true\\n \\n synonym\\n \\n GENERAL\\n 1590977142\\n 1590977142\\n \\n 100\\n","errorExample":""}]', - 'title' => 'DescribeApp', - 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', - 'translator' => 'machine', - ], - 'DescribeAppStatistics' => [ - 'summary' => 'Queries the statistics about a version of an OpenSearch application.', - 'path' => '/v4/openapi/app-groups/{appGroupIdentity}/apps/{appId}/statistics', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'http', - 'https', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'CreateFunctionResource', + 'summary' => 'Creates an algorithm resource for a specified feature.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateFunctionResource'], + ], ], - 'security' => [ + 'ramActions' => [ [ - 'AK' => [], + 'operationType' => '', + 'ramAction' => [ + 'action' => 'opensearch:WriteFunction', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'OpenSearch', 'resourceType' => 'FunctionResource', 'arn' => 'acs:opensearch:{#regionId}:{#accountId}:apps/{#AppGroupId}'], + ], + ], ], ], - 'operationType' => 'read', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - 'riskType' => 'none', - 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREopensearch447AAX', - 'FEATUREopensearchXLGC1X', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Status\\": \\"OK\\",\\n \\"HttpCode\\": 200,\\n \\"RequestId\\": \\"A4D487A9-A456-5AA5-A9C6-B7BF2889CF74\\",\\n \\"Message\\": \\"\\\\\\"\\\\\\"\\",\\n \\"Code\\": \\"\\\\\\"\\\\\\"\\",\\n \\"Latency\\": 123\\n}","type":"json"}]', + 'translator' => 'manual', + ], + 'CreateFunctionTask' => [ + 'summary' => 'Starts a training task.', + 'path' => '/v4/openapi/app-groups/{appGroupIdentity}/functions/{functionName}/instances/{instanceName}/tasks', + 'methods' => ['post'], + 'schemes' => ['http', 'https'], + 'security' => [ + [ + 'AK' => [], ], ], + 'produces' => ['application/json'], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'create'], 'parameters' => [ [ 'name' => 'appGroupIdentity', 'in' => 'path', - 'schema' => [ - 'description' => 'The name of the application.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'my_app_group_name', - ], + 'schema' => ['description' => 'The name of the application.', 'type' => 'string', 'required' => true, 'example' => 'app_group_name', 'title' => ''], ], [ - 'name' => 'appId', + 'name' => 'functionName', 'in' => 'path', - 'schema' => [ - 'description' => 'The version number of the application.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '110157886', - ], + 'schema' => ['description' => 'The name of the feature.', 'type' => 'string', 'required' => true, 'example' => 'ctr', 'title' => ''], + ], + [ + 'name' => 'instanceName', + 'in' => 'path', + 'schema' => ['description' => 'The name of the instance.', 'type' => 'string', 'required' => true, 'example' => 'ctr_test', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ + 'description' => 'The response body.', 'type' => 'object', 'properties' => [ - 'result' => [ - 'description' => 'The statistics.'."\n", - 'type' => 'object', - 'example' => '{}', - ], - 'requestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '76FC45F1-4167-D3CD-6737-4F97BA503FA0', - ], + 'Status' => ['description' => 'The request status.', 'type' => 'string', 'example' => 'OK', 'title' => ''], + 'HttpCode' => ['description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int64', 'example' => '200', 'title' => ''], + 'RequestId' => ['description' => 'The ID of the request.', 'type' => 'string', 'example' => '1638157990724', 'title' => ''], + 'Message' => ['description' => 'The error message.', 'type' => 'string', 'example' => 'success', 'title' => ''], + 'Code' => ['description' => 'The error code.', 'type' => 'string', 'example' => 'Task.IsRunning', 'title' => ''], + 'Latency' => ['description' => 'The time consumed for the request, in milliseconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '123', 'title' => ''], ], - 'description' => '', + 'example' => '{ "status" : "OK", "requestId" : "", "httpCode": 200, "code": "", "message": "", "latency" : 123, "result" : {}, }', + 'title' => '', ], ], - '5XX' => [ - 'schema' => [ - 'type' => 'object', - 'properties' => [ - 'code' => [ - 'type' => 'string', - ], - 'message' => [ - 'type' => 'string', - ], - 'requestId' => [ - 'type' => 'string', - ], - 'httpCode' => [ - 'type' => 'integer', - 'format' => 'int32', - ], + ], + 'title' => 'CreateFunctionTask', + 'requestParamsDescription' => '### Examples'."\n" + ."\n" + .'`POST /v4/openapi/app-groups/my-app/functions/ctr/instances/ctr_test/task`', + 'responseParamsDescription' => '### Sample responses'."\n" + ."\n" + .'```'."\n" + .'{'."\n" + .' "status" : "OK",'."\n" + .' "requestId" : "",'."\n" + .' "httpCode": 200,'."\n" + .' "code": "",'."\n" + .' "message": "",'."\n" + .' "latency" : 123,'."\n" + .' "result" : {},'."\n" + .'}'."\n" + .'```', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateFunctionTask'], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'opensearch:WriteFunction', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'OpenSearch', 'resourceType' => 'FunctionTask', 'arn' => 'acs:opensearch:{#regionId}:{#accountId}:apps/{#AppGroupId}'], ], ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"result\\": {},\\n \\"requestId\\": \\"76FC45F1-4167-D3CD-6737-4F97BA503FA0\\"\\n}","errorExample":""},{"type":"xml","example":"76FC45F1-4167-D3CD-6737-4F97BA503FA0\\n\\n 5002\\n 168\\n 1582522280\\n \\n \\n 0.000002\\n 1\\n false\\n \\n
2222
\\n \\n \\n \\n 0\\n 0\\n false\\n \\n \\n 0\\n 20\\n false\\n 1.0306227624786388\\n \\n opensearch.share.common\\n \\n
168
\\n \\n main\\n \\n","errorExample":""}]', - 'title' => 'DescribeAppStatistics', - 'requestParamsDescription' => ' ', - 'responseParamsDescription' => '**Statistical results**'."\n" - ."\n" - .'|Parameter|Type|Description|'."\n" - .'|---|---|---|'."\n" - .'|result.pv|Integer|The number of requests.|'."\n" - .'|result.docCount|Integer|The number of documents.|'."\n" - .'|result.docLastUpdated|String|The timestamp when the document was last updated.|'."\n" - .'|result.quota|Object|The statistics about the quotas.|'."\n" - .'|result.quota.instance|Object|The statistics about the instance.|'."\n" - .'|result.quota.instance.used|Float|The used quota. Unit: LCUs.|'."\n" - .'|result.quota.instance.quota|Integer|The quota capacity. Unit:GB.|'."\n" - .'|result.quota.instance.outOfLimit|Boolean|Indicates whether the quotas are exceeded.|'."\n" - .'|result.quota.instance.tables|Object|The statistics used by each data table. The key name is the name of the table, and the value is the used capacity.|'."\n" - .'|result.quota.qps|Object|The statistics about the quota of queries per second (QPS).|'."\n" - .'|result.quota.qps.used|Float|The used quota of QPS.|'."\n" - .'|result.quota.qps.quota|Integer|The total quota of QPS.|'."\n" - .'|result.quota.qps.outOfLimit|Boolean|Indicates whether the quotas are exceeded.|'."\n" - .'|result.quota.qps.tables|Array|\\--|'."\n" - .'|result.quota.computeResource|Object|The statistics about the quota of computing resources.|'."\n" - .'|result.quota.computeResource.used|Float|The used computing resources. Unit: LCUs.|'."\n" - .'|result.quota.computeResource.quota|Integer|The quota of computing resources. Unit: GB.|'."\n" - .'|result.quota.computeResource.outOfLimit|Boolean|Indicates whether the quotas are exceeded.|'."\n" - .'|result.quota.computeResource.dailyPeak|Float|The maximum amount of computing resources used. Unit: LCUs.|'."\n" - .'|result.quota.spec|String|The specifications of the application. Valid values:opensearch.share.junior: basicopensearch.share.common: shared general-purposeopensearch.share.compute: shared computingopensearch.share.storage: shared storageopensearch.private.common: exclusive general-purposeopensearch.private.compute: exclusive computingopensearch.private.storage: exclusive storage|'."\n" - .'|result.quota.docCount|Object|The statistics of the document number. The key indicates the name of the table. The value indicates the used quotas.|'."\n" - .'|result.quota.mainTable|String|The name of the primary table.|', - 'extraInfo' => ' ', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Status\\": \\"OK\\",\\n \\"HttpCode\\": 200,\\n \\"RequestId\\": \\"1638157990724\\",\\n \\"Message\\": \\"success\\",\\n \\"Code\\": \\"Task.IsRunning\\",\\n \\"Latency\\": 123\\n}","type":"json"}]', + 'translator' => 'manual', ], - 'ListUserAnalyzers' => [ - 'summary' => 'Queries the custom analyzers that belong to the current account.', - 'path' => '/v4/openapi/user-analyzers', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'CreateInterventionDictionary' => [ + 'summary' => 'Creates an intervention dictionary.', + 'path' => '/v4/openapi/intervention-dictionaries', + 'methods' => ['post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', + 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'list', + 'operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREopensearchUIICM8', - 'FEATUREopensearchNCXKUT', - ], + 'abilityTreeNodes' => ['FEATUREopensearchNCXKUT', 'FEATUREopensearchUIICM8'], ], 'parameters' => [ [ - 'name' => 'pageNumber', + 'name' => 'dryRun', 'in' => 'query', - 'schema' => [ - 'description' => 'The number of the page to return. Default value: 1.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'maximum' => '999999999', - 'minimum' => '-1', - 'example' => '1', - ], + 'schema' => ['description' => 'Specifies whether to perform a dry run. The default value is false.'."\n" + ."\n" + .'Valid values:'."\n" + ."\n" + .'- **true**: Validates the request parameters but does not create the intervention dictionary.'."\n" + ."\n" + .'- **false**: Validates the request parameters and creates the intervention dictionary.', 'type' => 'boolean', 'required' => false, 'title' => '', 'example' => 'false'], ], [ - 'name' => 'pageSize', - 'in' => 'query', + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', 'schema' => [ - 'description' => 'The number of entries to return on each page. Default value: 10.'."\n", - 'type' => 'integer', - 'format' => 'int32', + 'description' => 'The request body.', + 'type' => 'object', + 'properties' => [ + 'name' => ['description' => 'The name of the intervention dictionary.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => 'ner_dict_ec'], + 'type' => ['description' => 'The type of the intervention dictionary. Valid values:'."\n" + ."\n" + .'- stopword: an intervention dictionary for stop word filtering.'."\n" + ."\n" + .'- synonym: an intervention dictionary for synonym configuration.'."\n" + ."\n" + .'- correction: an intervention dictionary for spelling correction.'."\n" + ."\n" + .'- category\\_prediction: an intervention dictionary for category prediction.'."\n" + ."\n" + .'- ner: an intervention dictionary for Named Entity Recognition (NER).'."\n" + ."\n" + .'- term\\_weighting: an intervention dictionary for term weight analysis.'."\n" + ."\n" + .'- suggest\\_allowlist: a drop-down suggestion whitelist.'."\n" + ."\n" + .'- suggest\\_denylist: a drop-down suggestion blacklist.'."\n" + ."\n" + .'- hot\\_allowlist: a top search whitelist.'."\n" + ."\n" + .'- hot\\_denylist: a top search blacklist.'."\n" + ."\n" + .'- hint\\_allowlist: a hint whitelist.'."\n" + ."\n" + .'- hint\\_denylist: a hint blacklist.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => 'ner'], + 'analyzerType' => ['description' => 'The type of the analyzer. Valid values:'."\n" + ."\n" + .'- MODEL: a model-based custom analyzer.'."\n" + ."\n" + .'- SYSTEM: a system analyzer.'."\n" + ."\n" + .'- USER: a custom analyzer.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => 'SYSTEM'], + ], 'required' => false, - 'maximum' => '999999999', - 'minimum' => '-1', - 'example' => '10', + 'title' => '', + 'example' => '', ], ], ], @@ -5569,165 +3394,102 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'totalCount' => [ - 'description' => 'The total number.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'requestId' => [ - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => '0A6EB64B-B4C8-CF02-810F-E660812972FF', - ], + 'requestId' => ['description' => 'The request ID.', 'type' => 'string', 'title' => '', 'example' => '80326EFE-485F-46E7-B291-5A1DD08D2198'], 'result' => [ - 'description' => 'The custom analyzer.'."\n" - ."\n" - .'For more information, see [UserAnalyzer](~~178934~~).'."\n", - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'created' => [ - 'description' => 'The timestamp when the application was created.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1588054131', - ], - 'available' => [ - 'description' => 'Indicates whether the application is available.'."\n", - 'type' => 'boolean', - 'example' => 'false', - ], - 'name' => [ - 'description' => 'The name of the custom analyzer.'."\n", - 'type' => 'string', - 'example' => 'kevin_test2', - ], - 'updated' => [ - 'description' => 'The timestamp when the application was last updated.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1588054131', - ], - 'id' => [ - 'description' => 'The ID of the custom analyzer.'."\n", - 'type' => 'string', - 'example' => '1234', - ], - 'business' => [ - 'description' => 'The basic analyzer. Valid values:'."\n" - ."\n" - .'* chn_standard: [a common analyzer in Chinese](~~179424~~)'."\n" - .'* chn_scene_name: an analyzer for person names in Chinese'."\n" - .'* chn_ecommerce: [an analyzer for E-commerce in Chinese](~~179424~~)'."\n" - .'* chn_it_content: [an analyzer for IT content in Chinese](~~179424~~)'."\n" - .'* en_min: a small-granularity analyzer in English'."\n" - .'* th_standard: a common analyzer in Thai'."\n" - .'* th_ecommerce: an analyzer for E-commerce in Thai'."\n" - .'* vn_standard: a common analyzer in Vietnamese'."\n" - .'* chn_community_it: an analyzer for IT community content in Chinese'."\n" - .'* chn_ecommerce_general: a common analyzer for the E-commerce industry in Chinese'."\n" - .'* chn_esports_general: a common analyzer for the gaming industry in Chinese'."\n" - .'* chn_edu_question: an analyzer for question search of the education industry in Chinese'."\n", - 'type' => 'string', - 'example' => 'chn_standard', - ], - 'dicts' => [ - 'description' => 'The dictionaries that are used by the custom analyzer.'."\n" - ."\n" - .'For more information, see [UserDict](~~178933~~).'."\n", - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'created' => [ - 'description' => 'The timestamp when the application was created.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1588054131', - ], - 'entriesCount' => [ - 'description' => 'The number of intervention entries.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '-1', - ], - 'type' => [ - 'description' => 'The type. Valid value:'."\n" - ."\n" - .'* segment'."\n", - 'type' => 'string', - 'example' => 'segment', - ], - 'entriesLimit' => [ - 'description' => 'The maximum number of intervention entries that can be created in the dictionary.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '4', - ], - 'available' => [ - 'description' => 'Indicates whether the application is available.'."\n", - 'type' => 'boolean', - 'example' => 'false', - ], - 'updated' => [ - 'description' => 'The timestamp when the application was last updated.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1588054131', - ], - 'id' => [ - 'description' => 'The ID of the dictionary.'."\n", - 'type' => 'string', - 'example' => '123', - ], - ], - ], - ], - ], + 'description' => 'The details of the intervention dictionary.', + 'type' => 'object', + 'properties' => [ + 'created' => ['description' => 'The time when the dictionary was created.', 'type' => 'string', 'title' => '', 'example' => '1591086323'], + 'analyzer' => ['description' => 'The custom analyzer.', 'type' => 'string', 'title' => '', 'example' => 'dianshang'], + 'updated' => ['description' => 'The time when the intervention dictionary was last updated.', 'type' => 'string', 'title' => '', 'example' => '1591086323'], + 'type' => ['description' => 'The type of the intervention dictionary. Valid values:'."\n" + ."\n" + .'- stopword: an intervention dictionary for stop word filtering.'."\n" + ."\n" + .'- synonym: an intervention dictionary for synonym configuration.'."\n" + ."\n" + .'- correction: an intervention dictionary for spelling correction.'."\n" + ."\n" + .'- category\\_prediction: an intervention dictionary for category prediction.'."\n" + ."\n" + .'- ner: an intervention dictionary for Named Entity Recognition (NER).'."\n" + ."\n" + .'- term\\_weighting: an intervention dictionary for term weight analysis.'."\n" + ."\n" + .'- suggest\\_allowlist: a drop-down suggestion whitelist.'."\n" + ."\n" + .'- suggest\\_denylist: a drop-down suggestion blacklist.'."\n" + ."\n" + .'- hot\\_allowlist: a top search whitelist.'."\n" + ."\n" + .'- hot\\_denylist: a top search blacklist.'."\n" + ."\n" + .'- hint\\_allowlist: a hint whitelist.'."\n" + ."\n" + .'- hint\\_denylist: a hint blacklist.', 'type' => 'string', 'title' => '', 'example' => 'ner'], + 'name' => ['description' => 'The name of the dictionary.', 'type' => 'string', 'title' => '', 'example' => 'testb'], ], + 'title' => '', + 'example' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], '5XX' => [ 'schema' => [ 'type' => 'object', 'properties' => [ - 'code' => [ - 'type' => 'string', - ], - 'message' => [ - 'type' => 'string', - ], - 'requestId' => [ - 'type' => 'string', - ], - 'httpCode' => [ - 'type' => 'integer', - 'format' => 'int32', - ], + 'code' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'requestId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'message' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'httpCode' => ['type' => 'integer', 'format' => 'int32', 'description' => '', 'title' => '', 'example' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"totalCount\\": 1,\\n \\"requestId\\": \\"0A6EB64B-B4C8-CF02-810F-E660812972FF\\",\\n \\"result\\": [\\n {\\n \\"created\\": 1588054131,\\n \\"available\\": false,\\n \\"name\\": \\"kevin_test2\\",\\n \\"updated\\": 1588054131,\\n \\"id\\": \\"1234\\",\\n \\"business\\": \\"chn_standard\\",\\n \\"dicts\\": [\\n {\\n \\"created\\": 1588054131,\\n \\"entriesCount\\": -1,\\n \\"type\\": \\"segment\\",\\n \\"entriesLimit\\": 4,\\n \\"available\\": false,\\n \\"updated\\": 1588054131,\\n \\"id\\": \\"123\\"\\n }\\n ]\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"0A6EB64B-B4C8-CF02-810F-E660812972FF\\n1\\n\\n 1234\\n kevin_test2\\n chn_standard\\n \\n 123\\n segment\\n 4\\n -1\\n false\\n 1588054131\\n 1588054131\\n \\n true\\n 1588054131\\n 1588054131\\n","errorExample":""}]', - 'title' => 'ListUserAnalyzers', - 'requestParamsDescription' => ' ', + 'title' => 'CreateInterventionDictionary', + 'requestParamsDescription' => '**Request body**'."\n" + ."\n" + .'| Parameter | Type | Required | Example | Description |'."\n" + .'| ------------ | ------ | -------- | ------------- | ---------------------------------------------------------------------------------------------------- |'."\n" + .'| name | String | Yes | "my_dict" | The name of the intervention dictionary. |'."\n" + .'| type | String | Yes | "ner" | The type of the intervention dictionary. |'."\n" + .'| analyzer | String | No | "my_analyzer" | The name of the custom analyzer.
This parameter is required if you set the type parameter to ner. |'."\n" + .'| analyzerType | String | No | "SYSTEM" | The type of the analyzer. |'."\n" + ."\n" + .'For more information, see [InterventionDictionary](~~173608~~).', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', - ], - 'CreateUserAnalyzer' => [ - 'summary' => 'Create a custom analyzer.', - 'path' => '/v4/openapi/user-analyzers', - 'methods' => [ - 'post', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'opensearch:WriteInterventionDictionary', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'OpenSearch', 'resourceType' => 'InterventionDictionary', 'arn' => 'acs:opensearch:{#regionId}:{#accountId}:intervention-dictionaries/*'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"80326EFE-485F-46E7-B291-5A1DD08D2198\\",\\n \\"result\\": {\\n \\"created\\": \\"1591086323\\",\\n \\"analyzer\\": \\"dianshang\\",\\n \\"updated\\": \\"1591086323\\",\\n \\"type\\": \\"ner\\",\\n \\"name\\": \\"testb\\"\\n }\\n}","type":"json"}]', + 'translator' => 'manual', + ], + 'CreateQueryProcessor' => [ + 'path' => '/v4/openapi/app-groups/{appGroupIdentity}/apps/{appId}/query-processors', + 'methods' => ['post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -5739,70 +3501,28 @@ 'operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREopensearchUIICM8', - 'FEATUREopensearchNCXKUT', - ], + 'abilityTreeNodes' => ['FEATUREopensearchNCXKUT', 'FEATUREopensearchUIICM8'], ], 'parameters' => [ [ - 'name' => 'body', - 'in' => 'body', - 'style' => 'json', - 'schema' => [ - 'description' => 'The request body.', - 'type' => 'object', - 'properties' => [ - 'name' => [ - 'title' => '名称', - 'description' => 'The analyzer name.', - 'type' => 'string', - 'required' => false, - 'example' => 'jmbon_analyzer', - ], - 'business' => [ - 'title' => '基础分词器', - 'description' => 'The basic analyzer.', - 'type' => 'string', - 'required' => false, - 'example' => 'chn_standard', - ], - 'businessType' => [ - 'title' => '基础分词器类型 (AUTO, MODEL, SYSTEM, USER)', - 'description' => 'The basic analyzer type. Valid values: AUTO, MODEL, SYSTEM, and USER.', - 'type' => 'string', - 'required' => false, - 'example' => 'AUTO', - ], - 'type' => [ - 'title' => '引擎类型 (HA3, ES)', - 'description' => 'The engine type. Valid values: HA3 and ES.', - 'type' => 'string', - 'required' => false, - 'example' => 'HA3', - ], - 'businessAppGroupId' => [ - 'description' => 'The application ID of the custom analyzer.', - 'type' => 'string', - 'required' => false, - 'example' => '110123123', - ], - ], - 'required' => false, - ], + 'name' => 'appGroupIdentity', + 'in' => 'path', + 'schema' => ['description' => 'The name of the application.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'my_app_group_name', 'title' => ''], + ], + [ + 'name' => 'appId', + 'in' => 'path', + 'schema' => ['description' => 'The version number of the application.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true, 'example' => '110157886', 'title' => ''], ], [ 'name' => 'dryRun', 'in' => 'query', - 'schema' => [ - 'description' => 'Specifies whether to perform only a dry run, without performing the actual request. Default value: false.'."\n" - .'Valid values:'."\n" - .'* **true**'."\n" - .'* **false**', - 'type' => 'boolean', - 'required' => false, - 'example' => 'false', - ], + 'schema' => ['description' => 'Specifies whether to perform a dry run.'."\n", 'type' => 'boolean', 'required' => false, 'example' => 'true', 'title' => ''], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'schema' => ['description' => 'The request body.'."\n", 'type' => 'any', 'required' => false, 'example' => '{}', 'title' => ''], ], ], 'responses' => [ @@ -5810,91 +3530,122 @@ 'schema' => [ 'type' => 'object', 'properties' => [ + 'requestId' => ['description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '0A6EB64B-B4C8-CF02-810F-E660812972FF', 'title' => ''], 'result' => [ - 'description' => 'The custom analyzer.', + 'description' => 'The information about the query analysis rule.'."\n", 'type' => 'object', - 'example' => '{}', - ], - 'RequestId' => [ - 'description' => 'The ID of the request.', - 'type' => 'string', - 'example' => '98724351-D6B2-5D8A-B089-7FFD1821A7E9', + 'properties' => [ + 'created' => ['description' => 'The time when the query analysis rule was created.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1587398402', 'title' => ''], + 'active' => ['description' => 'Indicates whether the query analysis rule is the default one.'."\n", 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'updated' => ['description' => 'The time when the query analysis rule was last modified.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1587398402', 'title' => ''], + 'name' => ['description' => 'The name of the query analysis rule.'."\n", 'type' => 'string', 'example' => 'query_filter', 'title' => ''], + 'domain' => ['description' => 'The type of the industry to which the query analysis rule was applied. Valid values:'."\n" + ."\n" + .'* GENERAL: general.'."\n" + .'* ECOMMERCE: e-commerce.'."\n" + .'* IT_CONTENT: IT content.'."\n", 'type' => 'string', 'example' => 'GENERAL', 'title' => ''], + 'indexes' => [ + 'description' => 'The indexes to which the query analysis rule was applied.'."\n", + 'type' => 'array', + 'items' => ['description' => 'The indexes to which the query analysis rule was applied.'."\n", 'type' => 'string', 'example' => '"default"', 'title' => ''], + 'title' => '', + 'example' => '', + ], + 'processors' => [ + 'description' => 'The features that are used in the query analysis rule.'."\n" + ."\n" + .'For more information, see [QueryProcessor](~~170014~~).'."\n", + 'type' => 'array', + 'items' => ['description' => 'The features that are used in the query analysis rule.'."\n", 'type' => 'object', 'example' => '{}', 'title' => ''], + 'title' => '', + 'example' => '', + ], + ], + 'title' => '', + 'example' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], '5XX' => [ 'schema' => [ 'type' => 'object', 'properties' => [ - 'code' => [ - 'type' => 'string', - ], - 'message' => [ - 'type' => 'string', - ], - 'requestId' => [ - 'type' => 'string', - ], - 'httpCode' => [ - 'type' => 'integer', - 'format' => 'int32', - ], + 'code' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'message' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'requestId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'httpCode' => ['type' => 'integer', 'format' => 'int32', 'description' => '', 'title' => '', 'example' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"result\\": {},\\n \\"RequestId\\": \\"98724351-D6B2-5D8A-B089-7FFD1821A7E9\\"\\n}","type":"json"}]', - 'title' => 'Create Custom Analyzer', - 'translator' => 'machine', - ], - 'DescribeUserAnalyzer' => [ - 'summary' => '获取自定义分析器详情', - 'path' => '/v4/openapi/user-analyzers/{name}', - 'methods' => [ - 'get', + 'title' => 'CreateQueryProcessor', + 'summary' => 'Creates a query analysis rule. If you set dryRun to true, this operation checks the specified query analysis rule. By default, the value of dryRun is false if you do not set this parameter.', + 'requestParamsDescription' => '**Request body**'."\n" + ."\n" + .'|Parameter|Type|Required|Example|Description|'."\n" + .'|---|---|---|---|---|'."\n" + .'|name|String|Yes|"test"|The name of the query analysis rule.|'."\n" + .'|processors\\[\\]|Object|Yes|N/A|The query analysis rule.For more information, see [QueryProcessor](~~170014~~).|'."\n" + .'|domain|String|No|"GENERAL"|The type of the industry to which the query analysis rule applies. Valid values:GENERAL: general.ECOMMERCE: e-commerce.IT\\_CONTENT: IT content.|'."\n" + .'|indexes|Array|No|\\["default"\\]|The indexes to which the query analysis rule applies.|'."\n" + .'|active|Boolean|No|true|Specifies whether to enable the query analysis rule.|'."\n" + ."\n\n" + .'For more information, see [QueryProcessor](~~170014~~).', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'opensearch:WriteQueryProcessor', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'OpenSearch', 'resourceType' => 'QueryProcessor', 'arn' => 'acs:opensearch:{#regionId}:{#accountId}:apps/{#AppGroupId}'], + ], + ], + ], ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"requestId\\": \\"0A6EB64B-B4C8-CF02-810F-E660812972FF\\",\\n \\"result\\": {\\n \\"created\\": 1587398402,\\n \\"active\\": true,\\n \\"updated\\": 1587398402,\\n \\"name\\": \\"query_filter\\",\\n \\"domain\\": \\"GENERAL\\",\\n \\"indexes\\": [\\n \\"\\\\\\"default\\\\\\"\\"\\n ],\\n \\"processors\\": [\\n {}\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"0A6EB64B-B4C8-CF02-810F-E660812972FF\\n\\n query_filter\\n true\\n default\\n \\n synonym\\n true\\n \\n \\n stop_word\\n true\\n 980\\n \\n GENERAL\\n 1587398402\\n 1587398402\\n","errorExample":""}]', + ], + 'CreateScheduledTask' => [ + 'path' => '/v4/openapi/app-groups/{appGroupIdentity}/scheduled-tasks', + 'methods' => ['post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', + 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'get', + 'operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREopensearchUIICM8', - ], + 'abilityTreeNodes' => ['FEATUREopensearch447AAX', 'FEATUREopensearch5OZOSP'], ], 'parameters' => [ [ - 'name' => 'name', + 'name' => 'appGroupIdentity', 'in' => 'path', - 'schema' => [ - 'description' => 'The name of the analyzer.', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'kevin_test', - ], + 'schema' => ['description' => 'The name of the application.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'title' => '', 'example' => 'my_app_group_name'], ], [ - 'name' => 'with', - 'in' => 'query', - 'schema' => [ - 'description' => 'The Associated information,output properties based on hierarchy.'."\n" - .'* **all**: Outputs associated app information', - 'type' => 'string', - 'required' => false, - 'example' => 'all', - ], + 'name' => 'body', + 'in' => 'body', + 'schema' => ['description' => 'The request body.', 'required' => false, '$ref' => '#/components/schemas/ScheduledTask', 'title' => '', 'example' => ''], ], ], 'responses' => [ @@ -5902,53 +3653,72 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'result' => [ - 'description' => 'The details of the custom analyzer.'."\n", - 'type' => 'object', - 'example' => '{}', - ], - 'requestId' => [ - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => 'FFAEF396-10EF-53C7-1F51-518853880729', - ], + 'result' => ['description' => 'The information about the scheduled task. For more information, see [ScheduledTask](~~173610~~).', 'type' => 'object', 'title' => '', 'example' => '{}'], + 'requestId' => ['description' => 'The ID of the request.', 'type' => 'string', 'title' => '', 'example' => 'ABCDEFGH'], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], '5XX' => [ 'schema' => [ 'type' => 'object', 'properties' => [ - 'code' => [ - 'type' => 'string', - ], - 'message' => [ - 'type' => 'string', - ], - 'requestId' => [ - 'type' => 'string', - ], - 'httpCode' => [ - 'type' => 'integer', - 'format' => 'int32', - ], + 'code' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'message' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'requestId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'httpCode' => ['type' => 'integer', 'format' => 'int32', 'description' => '', 'title' => '', 'example' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"result\\": {},\\n \\"requestId\\": \\"FFAEF396-10EF-53C7-1F51-518853880729\\"\\n}","errorExample":""},{"type":"xml","example":"FFAEF396-10EF-53C7-1F51-518853880729\\n\\n 1234\\n kevin_test\\n chn_it_content\\n true\\n \\n 100298352\\n test_srn_mysql\\n \\n \\n 123\\n segment\\n \\n add\\n kevintest\\n kevin test\\n 1536690285\\n 1537348987\\n ACTIVE\\n true\\n \\n \\n add\\n abcd\\n abcd\\n 1536690285\\n 1537348987\\n ACTIVE\\n true\\n \\n 4\\n 2\\n true\\n 1584702214\\n 1584702214\\n \\n 1584702212\\n 1584702212\\n","errorExample":""}]', - 'title' => 'DescribeUserAnalyzer', - ], - 'RemoveUserAnalyzer' => [ - 'summary' => 'Deletes a custom analyzer.', - 'path' => '/v4/openapi/user-analyzers/{name}', - 'methods' => [ - 'delete', + 'title' => 'CreateScheduledTask', + 'summary' => 'Creates a scheduled task for an OpenSearch application.', + 'requestParamsDescription' => '**Request body**'."\n" + ."\n" + .'| Parameter | Type | Required | Example | Description |'."\n" + .'| ------------ | ------- | -------- | --------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |'."\n" + .'| type | String | Yes | "wipe" | The type of the scheduled task.
\\- wipe: data scrubbing
\\- fork: data import and reindexing
\\- reindex: reindexing
\\- clear: data clearing |'."\n" + .'| cron | String | Yes | "10 20 * * 1,2,3,4,5" | The configuration of the scheduled task.
For more information, see [cron field in ScheduledTask](~~173611~~) |'."\n" + .'| enabled | Boolean | Yes | true | Specifies whether to enable the scheduled task. |'."\n" + .'| appStrategy | String | No | delete-idle | The policy for creating a new version.
\\- delete-idle: If two versions exist, the inactive version is deleted before a new version is created.
\\- need-slot: If only one version exists, a new version is created. |'."\n" + .'| filter | Object | No | | The conditions that are used to clear data. |'."\n" + .'| filter.days | Integer | Yes | 7 | The number of days after which the data expires.
Valid values: [7, 180]. |'."\n" + .'| filter.unit | String | Yes | "s" | The unit of the expiration time.
\\- s: seconds
\\- ms: milliseconds |'."\n" + .'| filter.field | String | No | "cate_id" | The field that is used to determine data expiration. |'."\n" + .'| runNow | Boolean | No | false | Specifies whether to run the task immediately. Default value: false. |'."\n" + .'| permanent | Boolean | No | true | Specifies whether the task is permanent. Default value: true. |', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'opensearch:CreateScheduledTask', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'OpenSearch', 'resourceType' => 'ScheduledTask', 'arn' => 'acs:opensearch:{#regionId}:{#accountId}:app-groups/{#AppGroupId}'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"result\\": {},\\n \\"requestId\\": \\"ABCDEFGH\\"\\n}","type":"json"}]', + 'translator' => 'manual', + ], + 'CreateSearchStrategy' => [ + 'summary' => 'Creates a search strategy.', + 'path' => '/v4/openapi/app-groups/{appGroupIdentity}/apps/{appId}/search-strategies', + 'methods' => ['post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -5957,144 +3727,113 @@ 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'delete', + 'operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREopensearchUIICM8', - ], + 'abilityTreeNodes' => ['FEATUREopensearchBNTDZX'], ], 'parameters' => [ [ - 'name' => 'name', + 'name' => 'appGroupIdentity', 'in' => 'path', - 'schema' => [ - 'description' => 'The name of the analyzer'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '“kevin_test”', - ], + 'schema' => ['description' => 'The name of the application.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'title' => '', 'example' => '"my_app"'], + ], + [ + 'name' => 'appId', + 'in' => 'path', + 'schema' => ['description' => 'The version number.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'title' => '', 'example' => '1234'], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'schema' => ['description' => 'The search strategy.', 'required' => false, '$ref' => '#/components/schemas/SearchStrategy', 'title' => '', 'example' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ + 'description' => 'The response body.', 'type' => 'object', 'properties' => [ - 'result' => [ - 'description' => 'The result set. This parameter is not returned if the request is successful.'."\n", - 'type' => 'object', - 'example' => '[]', - ], - 'requestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => 'D77D0DAF-790D-F5F5-A9C0-133738165014', - ], + 'requestId' => ['description' => 'The ID of the request.', 'type' => 'string', 'title' => '', 'example' => '"abc123"'], ], - 'description' => '', + 'title' => '', + 'example' => '', ], ], '5XX' => [ 'schema' => [ 'type' => 'object', 'properties' => [ - 'code' => [ - 'type' => 'string', - ], - 'message' => [ - 'type' => 'string', - ], - 'requestId' => [ - 'type' => 'string', - ], - 'httpCode' => [ - 'type' => 'integer', - 'format' => 'int32', - ], + 'code' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'message' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'requestId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'httpCode' => ['type' => 'integer', 'format' => 'int32', 'description' => '', 'title' => '', 'example' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"result\\": [],\\n \\"requestId\\": \\"D77D0DAF-790D-F5F5-A9C0-133738165014\\"\\n}","errorExample":""},{"type":"xml","example":"D77D0DAF-790D-F5F5-A9C0-133738165014","errorExample":""}]', - 'title' => 'RemoveUserAnalyzer', - 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', - ], - 'ListUserAnalyzerEntries' => [ - 'summary' => 'Queries the entries of a custom analyzer.', - 'path' => '/v4/openapi/user-analyzers/{name}/entries', - 'methods' => [ - 'get', + 'title' => 'CreateSearchStrategy', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'opensearch:WriteSearchStrategy', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'OpenSearch', 'resourceType' => 'SearchStrategy', 'arn' => 'acs:opensearch:{#regionId}:{#accountId}:apps/{#AppGroupId}'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"\\\\\\"abc123\\\\\\"\\"\\n}","type":"json"}]', + 'translator' => 'manual', + ], + 'CreateSecondRank' => [ + 'path' => '/v4/openapi/app-groups/{appGroupIdentity}/apps/{appId}/second-ranks', + 'methods' => ['post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', + 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'list', + 'operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREopensearchUIICM8', - ], + 'abilityTreeNodes' => ['FEATUREopensearchN8M8WS', 'FEATUREopensearchJUWEG4'], ], 'parameters' => [ [ - 'name' => 'name', + 'name' => 'appGroupIdentity', 'in' => 'path', - 'schema' => [ - 'description' => 'The name of the analyzer.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'kevin_test', - ], + 'schema' => ['description' => 'The name of the application group.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'my_app_group_name', 'title' => ''], ], [ - 'name' => 'word', - 'in' => 'query', - 'schema' => [ - 'description' => 'The key to be used to query entries.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'kevintest', - ], + 'name' => 'appId', + 'in' => 'path', + 'schema' => ['description' => 'The ID of the application version.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true, 'example' => '110157886', 'title' => ''], ], [ - 'name' => 'pageNumber', + 'name' => 'dryRun', 'in' => 'query', - 'schema' => [ - 'description' => 'The page number. Default value: 1.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'maximum' => '999999999', - 'minimum' => '-1', - 'example' => '1', - ], + 'schema' => ['description' => 'Specifies whether to perform a dry run.', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'title' => ''], ], [ - 'name' => 'pageSize', - 'in' => 'query', - 'schema' => [ - 'description' => 'The number of entries per page. Default value: 10.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'maximum' => '999999999', - 'minimum' => '-1', - 'example' => '10', - ], + 'name' => 'body', + 'in' => 'body', + 'schema' => ['description' => 'The request body. For more information, see [SecondRank](~~170008~~).', '$ref' => '#/components/schemas/SecondRank', 'required' => false, 'title' => '', 'example' => ''], ], ], 'responses' => [ @@ -6102,54 +3841,68 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'result' => [ - 'description' => 'The entries of the custom analyzer. For more information, see [UserAnalyzerEntry](https://www.alibabacloud.com/help/en/open-search/industry-algorithm-edition/useranalyzerentry).', - 'type' => 'object', - 'example' => '[]', - ], - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '516A02B7-2167-8D92-12D0-B639A2A0F3C5', - ], + 'result' => ['description' => 'The information about the fine-sort expression.', 'type' => 'object', 'example' => '{}', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'ABCDEFGH', 'title' => ''], ], 'description' => '', + 'title' => '', + 'example' => '', ], ], '5XX' => [ 'schema' => [ 'type' => 'object', 'properties' => [ - 'code' => [ - 'type' => 'string', - ], - 'message' => [ - 'type' => 'string', - ], - 'requestId' => [ - 'type' => 'string', - ], - 'httpCode' => [ - 'type' => 'integer', - 'format' => 'int32', - ], + 'code' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'message' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'requestId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'httpCode' => ['type' => 'integer', 'format' => 'int32', 'description' => '', 'title' => '', 'example' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"result\\": [\\n {\\n \\"cmd\\": \\"add\\",\\n \\"key\\": \\"kevintest\\",\\n \\"value\\": \\"kevin test\\",\\n \\"created\\": 1536690285,\\n \\"updated\\": 1537348987,\\n \\"status\\": \\"ACTIVE\\",\\n \\"splitEnabled\\": true\\n }\\n ],\\n \\"RequestId\\": \\"516A02B7-2167-8D92-12D0-B639A2A0F3C5\\"\\n}","type":"json"}]', - 'title' => 'ListUserAnalyzerEntries', - ], - 'PushUserAnalyzerEntries' => [ - 'summary' => 'Accepts the changes in the entries of a custom analyzer.', - 'path' => '/v4/openapi/user-analyzers/{name}/entries/actions/bulk', - 'methods' => [ - 'post', + 'title' => 'CreateSecondRank', + 'summary' => 'Creates a fine sort expression for a version of an OpenSearch application. If you set the dryRun parameter to true, this operation validates the specified fine sort expression. The default value of this parameter is false.', + 'requestParamsDescription' => '**Request body**'."\n" + ."\n" + .'| Field | Type | Required | Example | Description |'."\n" + .'| ----------- | ------- | -------- | ---------- | ---------------------------------------------------- |'."\n" + .'| name | String | No | "test" | The name of the expression. |'."\n" + .'| meta | String | No | "random()" | The content of the expression. |'."\n" + .'| description | String | No | "my_test" | The description of the expression. |'."\n" + .'| active | Boolean | No | true | Specifies whether the expression is the default one. |'."\n" + ."\n" + .'For more information, see [SecondRank](~~170008~~).
', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'opensearch:WriteSecondRank', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'OpenSearch', 'resourceType' => 'SecondRank', 'arn' => 'acs:opensearch:{#regionId}:{#accountId}:apps/{#AppGroupId}'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"result\\": {},\\n \\"RequestId\\": \\"ABCDEFGH\\"\\n}","type":"json"}]', + 'translator' => 'manual', + ], + 'CreateSortScript' => [ + 'summary' => 'Creates a sort script.', + 'path' => '/v4/openapi/app-groups/{appGroupIdentity}/apps/{appVersionId}/sort-scripts', + 'methods' => ['post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -6158,88 +3911,38 @@ 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'update', + 'operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREopensearchUIICM8', - ], + 'abilityTreeNodes' => ['FEATUREopensearchN8M8WS'], ], 'parameters' => [ [ - 'name' => 'name', + 'name' => 'appGroupIdentity', 'in' => 'path', - 'schema' => [ - 'description' => 'The name of the analyzer.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '“kevin_test”', - ], + 'schema' => ['description' => 'The name or ID of the application.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'search', 'title' => ''], ], [ - 'name' => 'dryRun', - 'in' => 'query', - 'schema' => [ - 'description' => 'Specifies whether to perform a dry run. This parameter is only used to check whether the data source is valid. Valid values: true and false.'."\n", - 'type' => 'boolean', - 'required' => false, - 'example' => 'true', - ], + 'name' => 'appVersionId', + 'in' => 'path', + 'schema' => ['description' => 'The ID of the report in the application.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '1234567', 'title' => ''], ], [ 'name' => 'body', 'in' => 'body', 'style' => 'json', 'schema' => [ - 'description' => 'The request body.'."\n", + 'description' => 'The request body.', 'type' => 'object', 'properties' => [ - 'entries' => [ - 'description' => 'The entries of the custom analyzer.'."\n", - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'cmd' => [ - 'description' => 'The operation to be performed on the entries.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* add'."\n" - .'* delete'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '"add"', - ], - 'key' => [ - 'description' => 'The key to be used to query entries.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '"testvalue"', - ], - 'value' => [ - 'description' => 'The analysis result.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '"test value"', - ], - 'splitEnabled' => [ - 'description' => 'Specifies whether to further analyze the terms that are generated after the search query is analyzed.'."\n" - ."\n" - .'Default value: true.'."\n", - 'type' => 'boolean', - 'required' => false, - 'example' => 'true', - ], - ], - 'required' => false, - ], - 'required' => false, - 'maxItems' => 100, - ], + 'scriptName' => ['description' => 'The name of the script.', 'type' => 'string', 'required' => false, 'example' => 'rank_cava_20230606_v7', 'title' => ''], + 'type' => ['description' => 'The type of the script. Only cava\\_script is supported.', 'type' => 'string', 'required' => false, 'example' => 'cava_script'."\n", 'title' => ''], + 'scope' => ['description' => 'The applicable scope of the script.', 'type' => 'string', 'required' => false, 'example' => 'second_rank', 'title' => ''], + 'description' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], ], 'required' => false, + 'title' => '', + 'example' => '', ], ], ], @@ -6248,186 +3951,177 @@ 'schema' => [ 'type' => 'object', 'properties' => [ + 'requestId' => ['description' => 'The unique ID of the request.', 'type' => 'string', 'example' => 'ABCDEFGH', 'title' => ''], 'result' => [ - 'description' => 'The result returned.'."\n", + 'description' => 'The returned result.', 'type' => 'object', - 'example' => '{}', - ], - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => 'D77D0DAF-790D-F5F5-A9C0-133738165014', + 'properties' => [ + 'scriptName' => ['description' => 'The name of the script.', 'type' => 'string', 'example' => 'rank_cava_20230606_v7'."\n", 'title' => ''], + 'type' => ['description' => 'The type of the script.', 'type' => 'string', 'example' => 'cava_script', 'title' => ''], + 'scope' => ['description' => 'The applicable scope of the script.', 'type' => 'string', 'example' => 'second_rank', 'title' => ''], + ], + 'title' => '', + 'example' => '', ], ], 'description' => '', + 'title' => '', + 'example' => '', ], ], '5XX' => [ 'schema' => [ 'type' => 'object', 'properties' => [ - 'code' => [ - 'type' => 'string', - ], - 'message' => [ - 'type' => 'string', - ], - 'requestId' => [ - 'type' => 'string', - ], - 'httpCode' => [ - 'type' => 'integer', - 'format' => 'int32', - ], + 'code' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'message' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'requestId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'httpCode' => ['type' => 'integer', 'format' => 'int32', 'description' => '', 'title' => '', 'example' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"result\\": [],\\n \\"RequestId\\": \\"D77D0DAF-790D-F5F5-A9C0-133738165014\\"\\n}","type":"json"}]', - 'title' => 'PushUserAnalyzerEntries', - 'requestParamsDescription' => 'Note: Use lowercase letters when you add intervention entries.'."\n", - ], - 'ListABTestScenes' => [ - 'summary' => 'Queries test scenarios.', - 'path' => '/v4/openapi/app-groups/{appGroupIdentity}/scenes', - 'methods' => [ - 'get', + 'title' => 'CreateSortScript', + 'requestParamsDescription' => '**Request parameters**'."\n" + ."\n" + .'| Name | Type | Required | Description |'."\n" + .'| ------------ | ---- | -------- | ----------------------------------------- |'."\n" + .'| scriptParams | Map | Yes | The parameters of the script to register. |'."\n" + ."\n" + .'**scriptParams**'."\n" + ."\n" + .'| Name | Type | Required | Description |'."\n" + .'| ---------- | ------ | -------- | ------------------------------------------------------------------ |'."\n" + .'| scriptName | String | Yes | The name of the script. |'."\n" + .'| type | String | Yes | The type of the script. Only cava_script is supported. |'."\n" + .'| scope | String | Yes | The applicable scope of the script. Only second_rank is supported. |', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'opensearch:WriteSortScript', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'OpenSearch', 'resourceType' => 'App', 'arn' => 'acs:opensearch:{#regionId}:{#accountId}:apps/{#AppGroupId}'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"ABCDEFGH\\",\\n \\"result\\": {\\n \\"scriptName\\": \\"rank_cava_20230606_v7\\\\n\\",\\n \\"type\\": \\"cava_script\\",\\n \\"scope\\": \\"second_rank\\"\\n }\\n}","type":"json"}]', + 'translator' => 'manual', + ], + 'CreateUserAnalyzer' => [ + 'summary' => 'Creates a custom analyzer.', + 'path' => '/v4/openapi/user-analyzers', + 'methods' => ['post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', + 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'list', + 'operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREopensearchE07IML', - ], + 'abilityTreeNodes' => ['FEATUREopensearchUIICM8', 'FEATUREopensearchNCXKUT'], ], 'parameters' => [ [ - 'name' => 'appGroupIdentity', - 'in' => 'path', + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', 'schema' => [ - 'description' => 'The name of the application'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'my_app_group_name', + 'description' => 'The request body.', + 'type' => 'object', + 'properties' => [ + 'name' => ['title' => '', 'description' => 'The name of the analyzer.', 'type' => 'string', 'required' => false, 'example' => 'jmbon_analyzer'], + 'business' => ['title' => '', 'description' => 'The name of the basic analyzer.', 'type' => 'string', 'example' => 'Chinese - general analysis', 'required' => false], + 'businessType' => ['title' => '', 'description' => 'The type of the basic analyzer. Valid values: AUTO, MODEL, SYSTEM, and USER.', 'type' => 'string', 'required' => false, 'example' => 'AUTO'], + 'type' => ['title' => '', 'description' => 'The engine type. Valid values: HA3 and ES.', 'type' => 'string', 'required' => false, 'example' => 'HA3'], + 'businessAppGroupId' => ['description' => 'The application ID for the custom model-based analyzer.', 'type' => 'string', 'required' => false, 'example' => '110123123', 'title' => ''], + ], + 'required' => false, + 'title' => '', + 'example' => '', ], ], + [ + 'name' => 'dryRun', + 'in' => 'query', + 'schema' => ['description' => 'Specifies whether to perform a dry run. Valid values:'."\n" + ."\n" + .'- true: sends a check request without creating the analyzer. The system checks the AccessKey, RAM user authorization, and required parameters.'."\n" + ."\n" + .'- false (default): sends a regular request to create the analyzer.', 'type' => 'boolean', 'required' => false, 'example' => 'false', 'title' => ''], + ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ - 'requestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => 'D77D0DAF-790D-F5F5-A9C0-133738165014', - ], - 'result' => [ - 'description' => 'The details of the test scenario.'."\n" - ."\n" - .'For more information, see [ABTestScene](~~173618~~).'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The returned data.'."\n", - 'type' => 'object', - 'properties' => [ - 'created' => [ - 'description' => 'The time when the test group was created.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1588836130', - ], - 'status' => [ - 'description' => 'The status of the test group. Valid values:'."\n" - ."\n" - .'* 0: not in effect'."\n" - .'* 1: in effect'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'updated' => [ - 'description' => 'The time when the test group was last updated.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1588836129', - ], - 'name' => [ - 'description' => 'The alias of the test group.'."\n", - 'type' => 'string', - 'example' => 'kevintest_2020-5-7_15:21:482', - ], - 'id' => [ - 'description' => 'The ID of the test group.'."\n", - 'type' => 'string', - 'example' => '20404', - ], - 'values' => [ - 'description' => 'The name of the test scenario.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The list of scenarios.'."\n", - 'type' => 'string', - 'example' => '["kevintest2"]', - ], - ], - ], - ], - ], + 'result' => ['description' => 'The returned result.', 'type' => 'object', 'example' => '{}', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '98724351-D6B2-5D8A-B089-7FFD1821A7E9', 'title' => ''], ], 'description' => '', + 'title' => '', + 'example' => '', ], ], '5XX' => [ 'schema' => [ 'type' => 'object', 'properties' => [ - 'code' => [ - 'type' => 'string', - ], - 'message' => [ - 'type' => 'string', - ], - 'requestId' => [ - 'type' => 'string', - ], - 'httpCode' => [ - 'type' => 'integer', - 'format' => 'int32', - ], + 'code' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'message' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'requestId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'httpCode' => ['type' => 'integer', 'format' => 'int32', 'description' => '', 'title' => '', 'example' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"requestId\\": \\"D77D0DAF-790D-F5F5-A9C0-133738165014\\",\\n \\"result\\": [\\n {\\n \\"created\\": 1588836130,\\n \\"status\\": 1,\\n \\"updated\\": 1588836129,\\n \\"name\\": \\"kevintest_2020-5-7_15:21:482\\",\\n \\"id\\": \\"20404\\",\\n \\"values\\": [\\n \\"[\\\\\\"kevintest2\\\\\\"]\\"\\n ]\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"D77D0DAF-790D-F5F5-A9C0-133738165014\\n\\n 20404\\n kevintest_2020-5-7_15:21:482\\n 1\\n 1588836130\\n 1588836129\\n kevintest2\\n","errorExample":""}]', - 'title' => 'ListABTestScenes', - 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', - ], - 'CreateABTestScene' => [ - 'summary' => 'Creates an scenario.', - 'path' => '/v4/openapi/app-groups/{appGroupIdentity}/scenes', - 'methods' => [ - 'post', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"result\\": {},\\n \\"RequestId\\": \\"98724351-D6B2-5D8A-B089-7FFD1821A7E9\\"\\n}","type":"json"}]', + 'title' => 'Create Custom Analyzer', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'opensearch:CreateUserAnalyzer', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'OpenSearch', 'resourceType' => 'Analyzer', 'arn' => 'acs:opensearch:{#regionId}:{#accountId}:user-analyzers/*'], + ], + ], + ], ], + 'translator' => 'manual', + ], + 'DeleteABTestExperiment' => [ + 'summary' => 'Deletes an experiment.', + 'path' => '/v4/openapi/app-groups/{appGroupIdentity}/scenes/{sceneId}/groups/{groupId}/experiments/{experimentId}', + 'methods' => ['delete'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -6436,48 +4130,31 @@ 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'create', + 'operationType' => 'delete', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREopensearchE07IML', - ], + 'abilityTreeNodes' => ['FEATUREopensearchE07IML'], ], 'parameters' => [ [ 'name' => 'appGroupIdentity', 'in' => 'path', - 'schema' => [ - 'description' => 'The name of the application'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'my_app_group_name', - ], + 'schema' => ['description' => 'The name of the application.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'title' => '', 'example' => 'my_app_group_name'], ], [ - 'name' => 'body', - 'in' => 'body', - 'schema' => [ - 'description' => 'The ABTest scenario. For more information, see [ABTestScene](~~173618~~)'."\n", - 'required' => false, - '$ref' => '#/components/schemas/ABTestScene', - ], + 'name' => 'sceneId', + 'in' => 'path', + 'schema' => ['description' => 'The ID of the scenario.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true, 'maximum' => '999999999', 'minimum' => '-1', 'title' => '', 'example' => '20404'], ], [ - 'name' => 'dryRun', - 'in' => 'query', - 'schema' => [ - 'description' => 'Specifies whether to check the validity of input parameters. Default value: false.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* **true**: checks only the validity of input parameters.'."\n" - .'* **false**: checks the validity of input parameters and creates an attribution configuration.'."\n", - 'type' => 'boolean', - 'required' => false, - 'example' => 'false', - ], + 'name' => 'groupId', + 'in' => 'path', + 'schema' => ['description' => 'The ID of the group.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true, 'maximum' => '999999999', 'minimum' => '-1', 'title' => '', 'example' => '13467'], + ], + [ + 'name' => 'experimentId', + 'in' => 'path', + 'schema' => ['description' => 'The ID of the experiment.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true, 'maximum' => '999999999', 'minimum' => '-1', 'title' => '', 'example' => '12889'], ], ], 'responses' => [ @@ -6485,146 +4162,85 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'requestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => 'D77D0DAF-790D-F5F5-A9C0-133738165014', - ], - 'result' => [ - 'description' => 'The returned data.'."\n", - 'type' => 'object', - 'properties' => [ - 'created' => [ - 'description' => 'The time when the test scenario was created.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '0', - ], - 'status' => [ - 'description' => 'The status. Valid values:'."\n" - ."\n" - .'* 0: not in effect'."\n" - .'* 1: in effect'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'updated' => [ - 'description' => 'The time when the test scenario was last updated.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1589012351', - ], - 'name' => [ - 'description' => 'The name of the A/B test group.'."\n", - 'type' => 'string', - 'example' => 'kevintest_2020-5-7_15:21:48', - ], - 'id' => [ - 'description' => 'The ID of the test group.'."\n", - 'type' => 'string', - 'example' => '20405', - ], - 'values' => [ - 'description' => 'The ID of the test scenario'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The ID of the test scenario'."\n", - 'type' => 'string', - 'example' => '[ "kevintest" ]', - ], - ], - ], - ], + 'result' => ['description' => 'The returned data.', 'type' => 'object', 'title' => '', 'example' => '{}'], + 'requestId' => ['description' => 'The request ID.', 'type' => 'string', 'title' => '', 'example' => 'ABCDEFGH'], ], 'description' => '', + 'title' => '', + 'example' => '', ], ], '5XX' => [ 'schema' => [ 'type' => 'object', 'properties' => [ - 'code' => [ - 'type' => 'string', - ], - 'message' => [ - 'type' => 'string', - ], - 'requestId' => [ - 'type' => 'string', - ], - 'httpCode' => [ - 'type' => 'integer', - 'format' => 'int32', - ], + 'code' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'message' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'requestId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'httpCode' => ['type' => 'integer', 'format' => 'int32', 'description' => '', 'title' => '', 'example' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"requestId\\": \\"D77D0DAF-790D-F5F5-A9C0-133738165014\\",\\n \\"result\\": {\\n \\"created\\": 0,\\n \\"status\\": 1,\\n \\"updated\\": 1589012351,\\n \\"name\\": \\"kevintest_2020-5-7_15:21:48\\",\\n \\"id\\": \\"20405\\",\\n \\"values\\": [\\n \\"[ \\\\\\"kevintest\\\\\\" ]\\"\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"D77D0DAF-790D-F5F5-A9C0-133738165014\\n\\n 20405\\n kevintest_2020-5-7_15:21:48\\n 1\\n 1589012351\\n 1589012351\\n kevintest\\n","errorExample":""}]', - 'title' => 'CreateABTestScene', - 'requestParamsDescription' => '**Request body**'."\n" - ."\n" - .'|Parameter|Type|Required|Example|Description|'."\n" - .'|---|---|---|---|---|'."\n" - .'|name|String|Yes|"kevintest22"|The name of the test scenario.|'."\n" - .'|status|Integer|No|0|The status of the scenario. Valid values:- 0: The test is stopped.- 1: The test is started.|'."\n" - .'|created|Integer|No|1589012351|The time when the test scenario was created.|'."\n" - .'|updated|Integer|No|1589012351|The time when the test scenario was last updated.|'."\n" - .'|values\\[\\]|String|No|"kevintest22"|The ID of the test scenario|', + 'title' => 'DeleteABTestExperiment', + 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', - ], - 'DescribeABTestScene' => [ - 'summary' => 'Queries the information about an A/B test scenario.', - 'path' => '/v4/openapi/app-groups/{appGroupIdentity}/scenes/{sceneId}', - 'methods' => [ - 'get', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'opensearch:DeleteApp', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'OpenSearch', 'resourceType' => 'AbTestExperiment', 'arn' => 'acs:opensearch:{#regionId}:{#accountId}:apps/{#AppGroupId}'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"result\\": {},\\n \\"requestId\\": \\"ABCDEFGH\\"\\n}","type":"json"}]', + 'translator' => 'manual', + ], + 'DeleteABTestGroup' => [ + 'path' => '/v4/openapi/app-groups/{appGroupIdentity}/scenes/{sceneId}/groups/{groupId}', + 'methods' => ['delete'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', + 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'get', + 'operationType' => 'delete', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREopensearchE07IML', - ], + 'abilityTreeNodes' => ['FEATUREopensearchE07IML'], ], 'parameters' => [ [ 'name' => 'appGroupIdentity', 'in' => 'path', - 'schema' => [ - 'description' => 'The name or ID of the application.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'my_app_group_name', - ], + 'schema' => ['description' => 'The application name.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'title' => '', 'example' => 'my_app_group_name'], ], [ 'name' => 'sceneId', 'in' => 'path', - 'schema' => [ - 'description' => 'The ID of the test scenario.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'docRequired' => true, - 'maximum' => '999999999', - 'minimum' => '-1', - 'example' => '20404', - ], + 'schema' => ['description' => 'The scenario ID.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true, 'maximum' => '999999999', 'minimum' => '-1', 'title' => '', 'example' => '20404'], + ], + [ + 'name' => 'groupId', + 'in' => 'path', + 'schema' => ['description' => 'The group ID.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true, 'maximum' => '999999999', 'minimum' => '-1', 'title' => '', 'example' => '13467'], ], ], 'responses' => [ @@ -6632,95 +4248,56 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'requestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => 'D77D0DAF-790D-F5F5-A9C0-133738165014', - ], - 'result' => [ - 'description' => 'The details of the test scenario.'."\n", - 'type' => 'object', - 'properties' => [ - 'created' => [ - 'description' => 'The time when the test scenario was created.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1596527691', - ], - 'status' => [ - 'description' => 'The status of the test scenario. Valid values:'."\n" - ."\n" - .'* 0: The test is stopped.'."\n" - .'* 1: The test is started.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '0', - ], - 'updated' => [ - 'description' => 'The time when the test was last modified.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1596527691', - ], - 'name' => [ - 'description' => 'The name of the test scenario.'."\n", - 'type' => 'string', - 'example' => 'test', - ], - 'id' => [ - 'description' => 'The ID of the test scenario.'."\n", - 'type' => 'string', - 'example' => '20614', - ], - 'values' => [ - 'description' => 'The indicators of the test scenarios.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The indicator of the test scenario.'."\n", - 'type' => 'string', - 'example' => 'test', - ], - ], - ], - ], + 'result' => ['description' => 'The return result.', 'type' => 'object', 'title' => '', 'example' => '{}'], + 'requestId' => ['description' => 'The ID of the request.', 'type' => 'string', 'title' => '', 'example' => 'ABCDEFGH'], ], 'description' => '', + 'title' => '', + 'example' => '', ], ], '5XX' => [ 'schema' => [ 'type' => 'object', 'properties' => [ - 'code' => [ - 'type' => 'string', - ], - 'message' => [ - 'type' => 'string', - ], - 'requestId' => [ - 'type' => 'string', - ], - 'httpCode' => [ - 'type' => 'integer', - 'format' => 'int32', - ], + 'code' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'message' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'requestId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'httpCode' => ['type' => 'integer', 'format' => 'int32', 'description' => '', 'title' => '', 'example' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"D77D0DAF-790D-F5F5-A9C0-133738165014\\",\\n \\"result\\": {\\n \\"created\\": 1596527691,\\n \\"status\\": 0,\\n \\"updated\\": 1596527691,\\n \\"name\\": \\"\\\\\\"test\\\\\\"\\",\\n \\"id\\": \\"20614\\",\\n \\"values\\": [\\n \\"test\\"\\n ]\\n }\\n}","type":"json"}]', - 'title' => 'DescribeABTestScene', - ], - 'UpdateABTestScene' => [ - 'summary' => 'Modifies an A/B test scenario.', - 'path' => '/v4/openapi/app-groups/{appGroupIdentity}/scenes/{sceneId}', - 'methods' => [ - 'put', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"result\\": {},\\n \\"requestId\\": \\"ABCDEFGH\\"\\n}","type":"json"}]', + 'title' => 'DeleteABTestGroup', + 'summary' => 'Deletes an A/B test group.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'opensearch:DeleteApp', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'OpenSearch', 'resourceType' => 'AbTestGroup', 'arn' => 'acs:opensearch:{#regionId}:{#accountId}:apps/{#AppGroupId}'], + ], + ], + ], ], + 'translator' => 'manual', + ], + 'DeleteABTestScene' => [ + 'summary' => 'Deletes an A/B test scenario.', + 'path' => '/v4/openapi/app-groups/{appGroupIdentity}/scenes/{sceneId}', + 'methods' => ['delete'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -6729,299 +4306,190 @@ 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'update', + 'operationType' => 'delete', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREopensearchE07IML', - ], + 'abilityTreeNodes' => ['FEATUREopensearchE07IML'], ], 'parameters' => [ [ 'name' => 'appGroupIdentity', 'in' => 'path', - 'schema' => [ - 'description' => 'The name of the application.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '“my_app_group_name”', - ], + 'schema' => ['description' => 'The name or ID of the application.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'title' => '', 'example' => 'my_app_group_name'], ], [ 'name' => 'sceneId', 'in' => 'path', - 'schema' => [ - 'description' => 'The ID of the test scenario.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'docRequired' => true, - 'maximum' => '999999999', - 'minimum' => '-1', - 'example' => '20404', - ], - ], - [ - 'name' => 'body', - 'in' => 'body', - 'schema' => [ - 'description' => 'The request body.'."\n", - 'required' => false, - '$ref' => '#/components/schemas/ABTestScene', - ], - ], - [ - 'name' => 'dryRun', - 'in' => 'query', - 'schema' => [ - 'description' => 'Specifies whether to perform a dry run. This parameter is only used to check whether the data source is valid. Valid values: true and false.'."\n", - 'type' => 'boolean', - 'required' => false, - 'example' => 'true', - ], + 'schema' => ['description' => 'The test scenario ID.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true, 'maximum' => '999999999', 'minimum' => '-1', 'title' => '', 'example' => '20404'], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'description' => 'The response body.'."\n", 'type' => 'object', 'properties' => [ - 'requestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => 'D77D0DAF-790D-F5F5-A9C0-133738165014', - ], - 'result' => [ - 'description' => 'The details of the test scenario. For more information, see [ABTestScene](~~173618~~).'."\n", - 'type' => 'object', - 'properties' => [ - 'created' => [ - 'description' => 'The time when the test scenario was created.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1596527691', - ], - 'params' => [ - 'description' => 'The parameters of the A/B test.'."\n", - 'type' => 'object', - 'example' => '{}', - ], - 'traffic' => [ - 'description' => 'The percentage of traffic that is allocated to the A/B test. Valid values: 0 to 100.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '111', - ], - 'online' => [ - 'description' => 'The status of the test. Valid values:'."\n" - ."\n" - .'* true: The test is started.'."\n" - .'* false: The test is stopped.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'name' => [ - 'description' => 'The name of the test scenario.'."\n", - 'type' => 'string', - 'example' => 'kevintest22', - ], - 'updated' => [ - 'description' => 'The time when the test scenario was last modified.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1596527691', - ], - 'id' => [ - 'description' => 'The ID of the test scenario.'."\n", - 'type' => 'string', - 'example' => '20614', - ], - ], - 'example' => '{}', - ], + 'result' => ['description' => 'The returned results.', 'type' => 'object', 'title' => '', 'example' => '[]'], + 'requestId' => ['description' => 'The request ID.', 'type' => 'string', 'title' => '', 'example' => '5C1C1C45-C64A-AD30-565F-140871D57E5E'], ], - 'example' => '{}', + 'description' => '', + 'title' => '', + 'example' => '', ], ], '5XX' => [ 'schema' => [ 'type' => 'object', 'properties' => [ - 'code' => [ - 'type' => 'string', - ], - 'message' => [ - 'type' => 'string', - ], - 'requestId' => [ - 'type' => 'string', - ], - 'httpCode' => [ - 'type' => 'integer', - 'format' => 'int32', - ], + 'code' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'message' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'requestId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'httpCode' => ['type' => 'integer', 'format' => 'int32', 'description' => '', 'title' => '', 'example' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"requestId\\": \\"D77D0DAF-790D-F5F5-A9C0-133738165014\\",\\n \\"result\\": {\\n \\"created\\": 1596527691,\\n \\"params\\": {},\\n \\"traffic\\": 111,\\n \\"online\\": true,\\n \\"name\\": \\"kevintest22\\",\\n \\"updated\\": 1596527691,\\n \\"id\\": \\"20614\\"\\n }\\n}","errorExample":""},{"type":"xml","example":"D77D0DAF-790D-F5F5-A9C0-133738165014\\n\\n 20405\\n kevintest22\\n 1\\n 1589012351\\n 1589012351\\n kevintest22\\n","errorExample":""}]', - 'title' => 'UpdateABTestScene', - 'requestParamsDescription' => '**Request body**'."\n" - ."\n" - .'|Parameter|Type|Required|Example|Description|'."\n" - .'|---|---|---|---|---|'."\n" - .'|name|String|Yes|"kevintest22"|The name of the test scenario.|'."\n" - .'|values\\[\\]|String|Yes|"kevintest22"|The indicator of the test scenario.|', - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', - ], - 'DeleteABTestScene' => [ - 'summary' => 'Deletes an A/B test scenario.', - 'path' => '/v4/openapi/app-groups/{appGroupIdentity}/scenes/{sceneId}', - 'methods' => [ - 'delete', + 'title' => 'DeleteABTestScene', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'opensearch:DeleteApp', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'OpenSearch', 'resourceType' => 'AbTestScene', 'arn' => 'acs:opensearch:{#regionId}:{#accountId}:apps/{#AppGroupId}'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"result\\": [],\\n \\"requestId\\": \\"5C1C1C45-C64A-AD30-565F-140871D57E5E\\"\\n}","type":"json"}]', + 'translator' => 'manual', + ], + 'DeleteFunctionInstance' => [ + 'path' => '/v4/openapi/app-groups/{appGroupIdentity}/functions/{functionName}/instances/{instanceName}', + 'methods' => ['delete'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], + 'consumes' => [], + 'produces' => ['application/json'], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'delete', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREopensearchE07IML', - ], + 'abilityTreeNodes' => ['FEATUREopensearch3QPM0K', 'FEATUREopensearchN8M8WS', 'FEATUREopensearchZAE4HR'], ], 'parameters' => [ [ 'name' => 'appGroupIdentity', 'in' => 'path', - 'schema' => [ - 'description' => 'The name or ID of the application.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'my_app_group_name', - ], + 'schema' => ['title' => '', 'description' => 'The name of the application.', 'type' => 'string', 'required' => true, 'example' => '“my_app_group_name”'], ], [ - 'name' => 'sceneId', + 'name' => 'functionName', 'in' => 'path', - 'schema' => [ - 'description' => 'The test scenario ID.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'docRequired' => true, - 'maximum' => '999999999', - 'minimum' => '-1', - 'example' => '20404', - ], + 'schema' => ['title' => '', 'description' => 'The name of the feature.', 'type' => 'string', 'required' => true, 'example' => '"ctr"'], + ], + [ + 'name' => 'instanceName', + 'in' => 'path', + 'schema' => ['title' => '', 'description' => 'The name of the instance.', 'type' => 'string', 'required' => true, 'example' => '"ctr_test"'], ], ], 'responses' => [ 200 => [ 'schema' => [ + 'description' => 'The result of the request.', 'type' => 'object', 'properties' => [ - 'result' => [ - 'description' => 'The returned results.'."\n", - 'type' => 'object', - 'example' => '{}', - ], - 'requestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => 'ABCDEFGH', - ], + 'Status' => ['description' => 'The status of the request.'."\n" + ."\n" + .'- OK: The request is successful.'."\n" + ."\n" + .'- FAIL: The request fails.', 'type' => 'string', 'title' => '', 'example' => '"OK"'], + 'HttpCode' => ['description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '200'], + 'RequestId' => ['description' => 'The ID of the request.', 'type' => 'string', 'title' => '', 'example' => '"1081EB05-473C-5BF4-95BE-6D7CAD5E2213"'], + 'Message' => ['description' => 'The error message. This parameter is empty if the request is successful.', 'type' => 'string', 'title' => '', 'example' => '"instance not exist."'], + 'Code' => ['description' => 'The error code. This parameter is empty if the request is successful.', 'type' => 'string', 'title' => '', 'example' => '"Instance.NotExist"'], + 'Latency' => ['description' => 'The request latency, in milliseconds.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '10'], ], - 'description' => '', + 'example' => '{}', + 'title' => '', ], ], - '5XX' => [ - 'schema' => [ - 'type' => 'object', - 'properties' => [ - 'code' => [ - 'type' => 'string', - ], - 'message' => [ - 'type' => 'string', - ], - 'requestId' => [ - 'type' => 'string', - ], - 'httpCode' => [ - 'type' => 'integer', - 'format' => 'int32', - ], + ], + 'title' => 'DeleteFunctionInstance', + 'summary' => 'Deletes an algorithm instance. Before you delete an instance, ensure that it is not in use to prevent service interruptions.', + 'requestParamsDescription' => '### Example'."\n" + ."\n" + .'`DELETE /v4/openapi/app-groups/my-app/functions/ctr/instances/ctr_test`', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteFunctionInstance'], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'opensearch:WriteFunction', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'OpenSearch', 'resourceType' => 'FunctionInstance', 'arn' => 'acs:opensearch:{#regionId}:{#accountId}:apps/{#AppGroupId}'], + ['validationType' => 'always', 'product' => 'OpenSearch', 'resourceType' => 'Instance', 'arn' => 'acs:opensearch:{#regionId}:{#accountId}:apps/{#AppGroupId}'], ], ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"result\\": [],\\n \\"requestId\\": \\"5C1C1C45-C64A-AD30-565F-140871D57E5E\\"\\n}","type":"json"}]', - 'title' => 'DeleteABTestScene', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Status\\": \\"\\\\\\"OK\\\\\\"\\",\\n \\"HttpCode\\": 200,\\n \\"RequestId\\": \\"\\\\\\"1081EB05-473C-5BF4-95BE-6D7CAD5E2213\\\\\\"\\",\\n \\"Message\\": \\"\\\\\\"instance not exist.\\\\\\"\\",\\n \\"Code\\": \\"\\\\\\"Instance.NotExist\\\\\\"\\",\\n \\"Latency\\": 10\\n}","type":"json"}]', + 'translator' => 'manual', ], - 'ListABTestGroups' => [ - 'summary' => '获取实验组清单', - 'path' => '/v4/openapi/app-groups/{appGroupIdentity}/scenes/{sceneId}/groups', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'DeleteFunctionResource' => [ + 'path' => '/v4/openapi/app-groups/{appGroupIdentity}/functions/{functionName}/resources/{resourceName}', + 'methods' => ['delete'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', + 'produces' => ['application/json'], + 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'list', - 'riskType' => 'none', - 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREopensearchE07IML', - ], + 'operationType' => 'delete', + 'abilityTreeCode' => '173355', + 'abilityTreeNodes' => ['FEATUREopensearchBQB5UI'], ], 'parameters' => [ [ 'name' => 'appGroupIdentity', 'in' => 'path', - 'schema' => [ - 'description' => 'The application name.', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => ' “my_app_group_name”', - ], + 'schema' => ['title' => '', 'description' => 'The ID of the application.', 'type' => 'string', 'required' => true, 'example' => 'my_app_group_name'], ], [ - 'name' => 'sceneId', + 'name' => 'functionName', 'in' => 'path', - 'schema' => [ - 'description' => 'The scenario ID.', - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'docRequired' => true, - 'maximum' => '999999999', - 'minimum' => '-1', - 'example' => '20404', - ], + 'schema' => ['title' => '', 'description' => 'The name of the feature.', 'type' => 'string', 'required' => true, 'example' => 'rank'], + ], + [ + 'name' => 'resourceName', + 'in' => 'path', + 'schema' => ['title' => '', 'description' => 'The name of the resource.', 'type' => 'string', 'required' => true, 'example' => 'fg_json'], ], ], 'responses' => [ @@ -7029,250 +4497,141 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'requestId' => [ - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => 'D77D0DAF-790D-F5F5-A9C0-133738165014', - ], - 'result' => [ - 'description' => 'The test groups.'."\n" - ."\n" - .'For more information, see [ABTestGroup](~~178935~~).'."\n", - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'created' => [ - 'description' => 'The time when the test group was created.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1588839490', - ], - 'status' => [ - 'description' => 'The status of the test group. Valid values:'."\n" - ."\n" - .'* 0: not in effect'."\n" - .'* 1: in effect'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'updated' => [ - 'description' => 'The time when the test group was last modified.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1588839490', - ], - 'name' => [ - 'description' => 'The name of the test group.'."\n", - 'type' => 'string', - 'example' => 'Group_2020-5-7_15:23:3', - ], - 'id' => [ - 'description' => 'The ID of the test group.'."\n", - 'type' => 'string', - 'example' => '13466', - ], - ], - ], - ], + 'Status' => ['description' => 'The status of the request.'."\n" + ."\n" + .'- OK: The request is successful.'."\n" + ."\n" + .'- FAIL: The request failed.', 'type' => 'string', 'title' => '', 'example' => 'OK'], + 'HttpCode' => ['description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '200'], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'title' => '', 'example' => 'A4D487A9-A456-5AA5-A9C6-B7BF2889CF74'], + 'Message' => ['description' => 'The error message.', 'type' => 'string', 'title' => '', 'example' => '""'], + 'Code' => ['description' => 'The error code. This parameter is empty if no error occurred.', 'type' => 'string', 'title' => '', 'example' => '""'], + 'Latency' => ['description' => 'The request latency. Unit: milliseconds.', 'type' => 'number', 'format' => 'double', 'title' => '', 'example' => '123'], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], - '5XX' => [ - 'schema' => [ - 'type' => 'object', - 'properties' => [ - 'code' => [ - 'type' => 'string', - ], - 'message' => [ - 'type' => 'string', - ], - 'requestId' => [ - 'type' => 'string', - ], - 'httpCode' => [ - 'type' => 'integer', - 'format' => 'int32', - ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'DeleteFunctionResource', + 'summary' => 'Deletes a specified algorithm resource.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteFunctionResource'], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'opensearch:WriteFunction', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'OpenSearch', 'resourceType' => 'FunctionResource', 'arn' => 'acs:opensearch:{#regionId}:{#accountId}:apps/{#AppGroupId}'], ], ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"requestId\\": \\"D77D0DAF-790D-F5F5-A9C0-133738165014\\",\\n \\"result\\": [\\n {\\n \\"created\\": 1588839490,\\n \\"status\\": 1,\\n \\"updated\\": 1588839490,\\n \\"name\\": \\"Group_2020-5-7_15:23:3\\",\\n \\"id\\": \\"13466\\"\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"D77D0DAF-790D-F5F5-A9C0-133738165014\\n\\n 13466\\n Group_2020-5-7_15:23:3\\n 1\\n 1588839490\\n 1588839490\\n","errorExample":""}]', - 'title' => 'ListABTestGroups', - 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Status\\": \\"OK\\",\\n \\"HttpCode\\": 200,\\n \\"RequestId\\": \\"A4D487A9-A456-5AA5-A9C6-B7BF2889CF74\\",\\n \\"Message\\": \\"\\\\\\"\\\\\\"\\",\\n \\"Code\\": \\"\\\\\\"\\\\\\"\\",\\n \\"Latency\\": 123\\n}","type":"json"}]', + 'translator' => 'manual', ], - 'CreateABTestGroup' => [ - 'summary' => 'Creates a test group.', - 'path' => '/v4/openapi/app-groups/{appGroupIdentity}/scenes/{sceneId}/groups', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'DeleteFunctionTask' => [ + 'path' => '/v4/openapi/app-groups/{appGroupIdentity}/functions/{functionName}/instances/{instanceName}/tasks/{generation}', + 'methods' => ['delete'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', + 'operationType' => 'write', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'create', - 'riskType' => 'none', - 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREopensearchE07IML', - ], - ], + 'systemTags' => ['operationType' => 'delete'], 'parameters' => [ [ 'name' => 'appGroupIdentity', 'in' => 'path', - 'schema' => [ - 'description' => 'The name of the application.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'my_app_group_name', - ], + 'schema' => ['title' => '', 'description' => 'The name of the application.', 'type' => 'string', 'required' => true, 'example' => 'my_app_group_name'], ], [ - 'name' => 'sceneId', + 'name' => 'functionName', 'in' => 'path', - 'schema' => [ - 'description' => 'The scenario ID.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'maximum' => '999999999', - 'minimum' => '-1', - 'example' => '20404', - ], + 'schema' => ['title' => '', 'description' => 'The name of the feature.', 'type' => 'string', 'required' => true, 'example' => 'ctr'], ], [ - 'name' => 'body', - 'in' => 'body', - 'schema' => [ - 'description' => 'The request body. For more information, see [ABTestGroup](~~178935~~).'."\n", - 'required' => false, - '$ref' => '#/components/schemas/ABTestGroup', - ], + 'name' => 'instanceName', + 'in' => 'path', + 'schema' => ['title' => '', 'description' => 'The name of the instance.', 'type' => 'string', 'required' => true, 'example' => 'ctr_test'], ], [ - 'name' => 'dryRun', - 'in' => 'query', - 'schema' => [ - 'description' => 'Specifies whether to check the validity of input parameters. Default value: false.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* **true**: checks only the validity of input parameters.'."\n" - .'* **false**: checks the validity of input parameters and creates an attribution configuration.'."\n", - 'type' => 'boolean', - 'required' => false, - 'example' => 'true', - ], + 'name' => 'generation', + 'in' => 'path', + 'schema' => ['title' => '', 'description' => 'The number of iterations.', 'type' => 'string', 'required' => true, 'example' => '1'], ], ], 'responses' => [ 200 => [ 'schema' => [ + 'description' => 'The schema of the response.', 'type' => 'object', 'properties' => [ - 'requestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => 'D77D0DAF-790D-F5F5-A9C0-133738165014', - ], - 'result' => [ - 'description' => 'The returned results.'."\n", - 'type' => 'object', - 'properties' => [ - 'created' => [ - 'description' => 'The time when the test group was created.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1588839490', - ], - 'status' => [ - 'description' => 'The status of the test group.'."\n" - ."\n" - .'* 0: not in effect'."\n" - .'* 1: in effect'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'updated' => [ - 'description' => 'The time when the test group was last updated.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1588839490', - ], - 'name' => [ - 'description' => 'The alias of the test group.'."\n", - 'type' => 'string', - 'example' => 'Group_2020-5-7_15:23:3', - ], - 'id' => [ - 'description' => 'The ID of the test group.'."\n", - 'type' => 'string', - 'example' => '13466', - ], - ], - ], + 'Status' => ['description' => 'The status of the request.', 'type' => 'string', 'title' => '', 'example' => 'OK'], + 'HttpCode' => ['description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '200'], + 'RequestId' => ['description' => 'The ID of the request.', 'type' => 'string', 'title' => '', 'example' => '"1081EB05-473C-5BF4-95BE-6D7CAD5E2213"'], + 'Message' => ['description' => 'The error message.', 'type' => 'string', 'title' => '', 'example' => 'operation success'], + 'Code' => ['description' => 'The error code. If no error occurs, this parameter is left empty.', 'type' => 'string', 'title' => '', 'example' => 'Task.UnableDelete'], + 'Latency' => ['description' => 'The time consumed for the request, in milliseconds.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '123'], ], - 'description' => '', + 'title' => '', + 'example' => '', ], ], - '5XX' => [ - 'schema' => [ - 'type' => 'object', - 'properties' => [ - 'code' => [ - 'type' => 'string', - ], - 'message' => [ - 'type' => 'string', - ], - 'requestId' => [ - 'type' => 'string', - ], - 'httpCode' => [ - 'type' => 'integer', - 'format' => 'int32', - ], + ], + 'title' => 'DeleteFunctionTask', + 'summary' => 'Deletes a training record. A training record that is in progress cannot be deleted.', + 'responseParamsDescription' => '### Sample success responses'."\n" + ."\n" + .'```'."\n" + .'{'."\n" + .' "status": "OK",'."\n" + .' "requestId": "",'."\n" + .' "httpCode": 200,'."\n" + .' "code": "",'."\n" + .' "message": "",'."\n" + .' "latency": 123,'."\n" + .' "result": {}'."\n" + .'}'."\n" + .'```', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteFunctionTask'], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'opensearch:WriteFunction', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'OpenSearch', 'resourceType' => 'FunctionTask', 'arn' => 'acs:opensearch:{#regionId}:{#accountId}:apps/{#AppGroupId}'], ], ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"requestId\\": \\"D77D0DAF-790D-F5F5-A9C0-133738165014\\",\\n \\"result\\": {\\n \\"created\\": 1588839490,\\n \\"status\\": 1,\\n \\"updated\\": 1588839490,\\n \\"name\\": \\"Group_2020-5-7_15:23:3\\",\\n \\"id\\": \\"13466\\"\\n }\\n}","errorExample":""},{"type":"xml","example":"\\n 1588839490\\n Group_2020-5-7_15:23:3\\n 13466\\n 1588839490\\n 1\\n\\nD77D0DAF-790D-F5F5-A9C0-133738165014","errorExample":""}]', - 'title' => 'CreateABTestGroup', - 'requestParamsDescription' => '**Request body**'."\n" - ."\n" - .'|Parameter|Type|Required|Example|Description|'."\n" - .'|---|---|---|---|---|'."\n" - .'|name|String|Yes|"kevintest3"|The name of the test group.|', - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Status\\": \\"OK\\",\\n \\"HttpCode\\": 200,\\n \\"RequestId\\": \\"\\\\\\"1081EB05-473C-5BF4-95BE-6D7CAD5E2213\\\\\\"\\",\\n \\"Message\\": \\"operation success\\",\\n \\"Code\\": \\"Task.UnableDelete\\",\\n \\"Latency\\": 123\\n}","type":"json"}]', + 'translator' => 'manual', ], - 'DeleteABTestGroup' => [ - 'summary' => '删除实验组', - 'path' => '/v4/openapi/app-groups/{appGroupIdentity}/scenes/{sceneId}/groups/{groupId}', - 'methods' => [ - 'delete', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'DeleteSortScript' => [ + 'path' => '/v4/openapi/app-groups/{appGroupIdentity}/apps/{appVersionId}/sort-scripts/{scriptName}', + 'methods' => ['delete'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -7284,49 +4643,23 @@ 'operationType' => 'delete', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREopensearchE07IML', - ], + 'abilityTreeNodes' => ['FEATUREopensearchN8M8WS'], ], 'parameters' => [ [ 'name' => 'appGroupIdentity', 'in' => 'path', - 'schema' => [ - 'description' => 'The application name.', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'my_app_group_name', - ], + 'schema' => ['description' => 'The name or ID of the application.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'title' => '', 'example' => 'search'], ], [ - 'name' => 'sceneId', + 'name' => 'scriptName', 'in' => 'path', - 'schema' => [ - 'description' => 'The scenario ID.', - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'docRequired' => true, - 'maximum' => '999999999', - 'minimum' => '-1', - 'example' => '20404', - ], + 'schema' => ['description' => 'The name of the script.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'title' => '', 'example' => 'cava'], ], [ - 'name' => 'groupId', + 'name' => 'appVersionId', 'in' => 'path', - 'schema' => [ - 'description' => 'The group ID.', - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'docRequired' => true, - 'maximum' => '999999999', - 'minimum' => '-1', - 'example' => '13467', - ], + 'schema' => ['description' => 'The ID of the application version.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'title' => '', 'example' => '1234567'], ], ], 'responses' => [ @@ -7334,107 +4667,96 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'result' => [ - 'description' => 'The return result.'."\n", - 'type' => 'object', - 'example' => '{}', - ], - 'requestId' => [ - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => 'ABCDEFGH', - ], + 'requestId' => ['description' => 'The ID of the request.', 'type' => 'string', 'title' => '', 'example' => 'ABCDEFGH'], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], '5XX' => [ 'schema' => [ 'type' => 'object', 'properties' => [ - 'code' => [ - 'type' => 'string', - ], - 'message' => [ - 'type' => 'string', - ], - 'requestId' => [ - 'type' => 'string', - ], - 'httpCode' => [ - 'type' => 'integer', - 'format' => 'int32', - ], + 'code' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'message' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'requestId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'httpCode' => ['type' => 'integer', 'format' => 'int32', 'description' => '', 'title' => '', 'example' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"result\\": {},\\n \\"requestId\\": \\"ABCDEFGH\\"\\n}","errorExample":""},{"type":"xml","example":"D77D0DAF-790D-F5F5-A9C0-133738165014","errorExample":""}]', - 'title' => 'DeleteABTestGroup', - ], - 'DescribeABTestGroup' => [ - 'summary' => 'Queries the details of a test group.', - 'path' => '/v4/openapi/app-groups/{appGroupIdentity}/scenes/{sceneId}/groups/{groupId}', - 'methods' => [ - 'get', + 'title' => 'DeleteSortScript', + 'summary' => 'Deletes a sort script.', + 'responseParamsDescription' => '```'."\n" + .'Error response'."\n" + .'{'."\n" + .' "requestId" : "ABCDEFGH"'."\n" + .' "code":"InvalidAppStatus",'."\n" + .' "message":"invalid app status.",'."\n" + .' "httpCode":400'."\n" + .'}'."\n" + .'```', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'opensearch:WriteSortScript', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'OpenSearch', 'resourceType' => 'App', 'arn' => 'acs:opensearch:{#regionId}:{#accountId}:apps/{#AppGroupId}'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"ABCDEFGH\\"\\n}","type":"json"}]', + 'translator' => 'manual', + ], + 'DeleteSortScriptFile' => [ + 'path' => '/v4/openapi/app-groups/{appGroupIdentity}/apps/{appVersionId}/sort-scripts/{scriptName}/files/src/{fileName}', + 'methods' => ['delete'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', + 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'get', + 'operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREopensearchE07IML', - ], + 'abilityTreeNodes' => ['FEATUREopensearchN8M8WS'], ], 'parameters' => [ [ 'name' => 'appGroupIdentity', 'in' => 'path', - 'schema' => [ - 'description' => 'The name of the application'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'my_app_group_name', - ], + 'schema' => ['description' => 'The application name.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'title' => '', 'example' => 'search'], ], [ - 'name' => 'sceneId', + 'name' => 'appVersionId', 'in' => 'path', - 'schema' => [ - 'description' => 'The scenario ID.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'docRequired' => true, - 'maximum' => '999999999', - 'minimum' => '-1', - 'example' => '20404', - ], + 'schema' => ['description' => 'The version ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'title' => '', 'example' => '1234567'], ], [ - 'name' => 'groupId', + 'name' => 'scriptName', 'in' => 'path', - 'schema' => [ - 'description' => 'The ID of the test group.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'docRequired' => true, - 'maximum' => '999999999', - 'minimum' => '-1', - 'example' => '13467', - ], + 'schema' => ['description' => 'The script name.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'title' => '', 'example' => 'cava'], + ], + [ + 'name' => 'fileName', + 'in' => 'path', + 'schema' => ['description' => 'The name of the script file to delete.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'title' => '', 'example' => 'cavafile'], ], ], 'responses' => [ @@ -7442,166 +4764,91 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'requestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => 'D77D0DAF-790D-F5F5-A9C0-133738165014', - ], - 'result' => [ - 'description' => 'The details of the test group.'."\n", - 'type' => 'object', - 'properties' => [ - 'created' => [ - 'description' => 'The time when the test group was created.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1588839490', - ], - 'status' => [ - 'description' => 'The status of the test group. Valid values:'."\n" - ."\n" - .'* 0: not in effect'."\n" - .'* 1: in effect'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'updated' => [ - 'description' => 'The time when the test group was last updated.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1588839490', - ], - 'name' => [ - 'description' => 'The alias of the test group.'."\n", - 'type' => 'string', - 'example' => 'Group_2020-5-7_15:23:3', - ], - 'id' => [ - 'description' => 'The ID of the test group.'."\n", - 'type' => 'string', - 'example' => '13466', - ], - ], - ], + 'requestId' => ['description' => 'The request ID.', 'type' => 'string', 'title' => '', 'example' => 'ABCDEFGH'], ], 'description' => '', + 'title' => '', + 'example' => '', ], ], '5XX' => [ 'schema' => [ 'type' => 'object', 'properties' => [ - 'code' => [ - 'type' => 'string', - ], - 'message' => [ - 'type' => 'string', - ], - 'requestId' => [ - 'type' => 'string', - ], - 'httpCode' => [ - 'type' => 'integer', - 'format' => 'int32', - ], + 'code' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'message' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'requestId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'httpCode' => ['type' => 'integer', 'format' => 'int32', 'description' => '', 'title' => '', 'example' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"requestId\\": \\"D77D0DAF-790D-F5F5-A9C0-133738165014\\",\\n \\"result\\": {\\n \\"created\\": 1588839490,\\n \\"status\\": 1,\\n \\"updated\\": 1588839490,\\n \\"name\\": \\"Group_2020-5-7_15:23:3\\",\\n \\"id\\": \\"13466\\"\\n }\\n}","errorExample":""},{"type":"xml","example":"D77D0DAF-790D-F5F5-A9C0-133738165014\\n\\n 13466\\n Group_2020-5-7_15:23:3\\n 1\\n 1588839490\\n 1588839490\\n","errorExample":""}]', - 'title' => 'DescribeABTestGroup', + 'title' => 'DeleteSortScriptFile', + 'summary' => 'Deletes a script file.', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', - ], - 'UpdateABTestGroup' => [ - 'summary' => 'Modifies a test group.', - 'path' => '/v4/openapi/app-groups/{appGroupIdentity}/scenes/{sceneId}/groups/{groupId}', - 'methods' => [ - 'put', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'opensearch:WriteSortScript', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'OpenSearch', 'resourceType' => 'App', 'arn' => 'acs:opensearch:{#regionId}:{#accountId}:apps/{#AppGroupId}'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"ABCDEFGH\\"\\n}","type":"json"}]', + 'translator' => 'manual', + ], + 'DescribeABTestExperiment' => [ + 'summary' => 'Retrieves the details of an experiment.', + 'path' => '/v4/openapi/app-groups/{appGroupIdentity}/scenes/{sceneId}/groups/{groupId}/experiments/{experimentId}', + 'methods' => ['get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'write', + 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'update', + 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeCode' => '55268', - 'abilityTreeNodes' => [ - 'FEATUREopensearchE07IML', - ], + 'abilityTreeNodes' => ['FEATUREopensearchE07IML'], ], 'parameters' => [ [ 'name' => 'appGroupIdentity', 'in' => 'path', - 'schema' => [ - 'description' => 'The name of the application.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '“my_app_group_name”', - ], + 'schema' => ['description' => 'The application name.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'title' => '', 'example' => 'my_app_group_name'], ], [ 'name' => 'sceneId', 'in' => 'path', - 'schema' => [ - 'description' => 'The scenario ID.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'docRequired' => true, - 'maximum' => '999999999', - 'minimum' => '-1', - 'example' => '20404', - ], + 'schema' => ['description' => 'The scenario ID.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true, 'maximum' => '999999999', 'minimum' => '-1', 'title' => '', 'example' => '20404'], ], [ 'name' => 'groupId', 'in' => 'path', - 'schema' => [ - 'description' => 'The ID of the test group.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'docRequired' => true, - 'maximum' => '999999999', - 'minimum' => '-1', - 'example' => '13467', - ], - ], - [ - 'name' => 'body', - 'in' => 'body', - 'schema' => [ - 'description' => 'The request body. For more information, see [ABTestGroup](~~178935~~).'."\n", - 'required' => false, - '$ref' => '#/components/schemas/ABTestGroup', - ], + 'schema' => ['description' => 'The group ID.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true, 'maximum' => '999999999', 'minimum' => '-1', 'title' => '', 'example' => '13467'], ], [ - 'name' => 'dryRun', - 'in' => 'query', - 'schema' => [ - 'description' => 'Specifies whether to perform only a dry run, without performing the actual request. Valid values:'."\n" - ."\n" - .'* true: performs only a dry run. No endpoint is created. The system checks whether your AccessKey is valid, whether Resource Access Management (RAM) users are authorized, and whether the required parameters are set.'."\n" - .'* false (default): creates an endpoint immediately.'."\n", - 'type' => 'boolean', - 'required' => false, - 'example' => 'true', - ], + 'name' => 'experimentId', + 'in' => 'path', + 'schema' => ['description' => 'The experiment ID.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true, 'maximum' => '999999999', 'minimum' => '-1', 'title' => '', 'example' => '12889'], ], ], 'responses' => [ @@ -7609,93 +4856,84 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'requestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '\'\'1111\'\'', - ], + 'requestId' => ['description' => 'The request ID.', 'type' => 'string', 'title' => '', 'example' => 'D77D0DAF-790D-F5F5-A9C0-133738165014'], 'result' => [ - 'description' => 'The details of the test group.'."\n", + 'description' => 'The details of the experiment.', 'type' => 'object', 'properties' => [ - 'created' => [ - 'description' => 'The time when the test group was created.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1588839490', - ], - 'status' => [ - 'description' => 'The status of the test group. Valid values:'."\n" - ."\n" - .'* 0: not in effect'."\n" - .'* 1: in effect'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'updated' => [ - 'description' => 'The time when the test group was last updated.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1588839490', - ], - 'name' => [ - 'description' => 'The alias of the test group.'."\n", - 'type' => 'string', - 'example' => 'Group_2020-5-7_15:23:3', - ], - 'id' => [ - 'description' => 'The ID of the test group.'."\n", - 'type' => 'string', - 'example' => '13466', + 'created' => ['description' => 'The time when the experiment was created.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '1588842080'], + 'traffic' => ['description' => 'The percentage of traffic for the experiment bucketing.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '30'], + 'online' => ['description' => 'The status of the experiment.'."\n" + ."\n" + .'- true: The experiment is online.'."\n" + ."\n" + .'- false: The experiment is offline.', 'type' => 'boolean', 'title' => '', 'example' => 'true'], + 'name' => ['description' => 'The alias of the experiment.', 'type' => 'string', 'title' => '', 'example' => 'test1'], + 'updated' => ['description' => 'The time when the experiment was last modified.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '1588842080'], + 'id' => ['description' => 'The experiment ID.', 'type' => 'string', 'title' => '', 'example' => '12888'], + 'params' => [ + 'description' => 'The experiment parameters.', + 'type' => 'object', + 'properties' => [ + 'first_formula_name' => ['description' => 'The name of the coarse-grained ranking policy.', 'type' => 'string', 'title' => '', 'example' => 'default'], + ], + 'title' => '', + 'example' => '', ], ], + 'title' => '', + 'example' => '', ], ], 'description' => '', + 'title' => '', + 'example' => '', ], ], '5XX' => [ 'schema' => [ 'type' => 'object', 'properties' => [ - 'code' => [ - 'type' => 'string', - ], - 'message' => [ - 'type' => 'string', - ], - 'requestId' => [ - 'type' => 'string', - ], - 'httpCode' => [ - 'type' => 'integer', - 'format' => 'int32', - ], + 'code' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'message' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'requestId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'httpCode' => ['type' => 'integer', 'format' => 'int32', 'description' => '', 'title' => '', 'example' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"requestId\\": \\"\'\'1111\'\'\\",\\n \\"result\\": {\\n \\"created\\": 1588839490,\\n \\"status\\": 1,\\n \\"updated\\": 1588839490,\\n \\"name\\": \\"Group_2020-5-7_15:23:3\\",\\n \\"id\\": \\"13466\\"\\n }\\n}","errorExample":""},{"type":"xml","example":"D77D0DAF-790D-F5F5-A9C0-133738165014\\n\\n 13467\\n kevintestgroup222\\n 1\\n 1589016325\\n 1589016544\\n","errorExample":""}]', - 'title' => 'UpdateABTestGroup', - 'requestParamsDescription' => '**Request body**'."\n" - ."\n" - .'|Parameter|Type|Required|Example|Description|'."\n" - .'|---|---|---|---|---|'."\n" - .'|name|String|Yes|"kevintest3"|The name of the test group.|', + 'title' => 'DescribeABTestExperiment', + 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', - ], - 'ListABTestExperiments' => [ - 'summary' => 'Queries a list of experiments.', - 'path' => '/v4/openapi/app-groups/{appGroupIdentity}/scenes/{sceneId}/groups/{groupId}/experiments', - 'methods' => [ - 'get', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'opensearch:DescribeApp', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'OpenSearch', 'resourceType' => 'AbTestExperiment', 'arn' => 'acs:opensearch:{#regionId}:{#accountId}:apps/{#AppGroupId}'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"D77D0DAF-790D-F5F5-A9C0-133738165014\\",\\n \\"result\\": {\\n \\"created\\": 1588842080,\\n \\"traffic\\": 30,\\n \\"online\\": true,\\n \\"name\\": \\"test1\\",\\n \\"updated\\": 1588842080,\\n \\"id\\": \\"12888\\",\\n \\"params\\": {\\n \\"first_formula_name\\": \\"default\\"\\n }\\n }\\n}","type":"json"}]', + 'translator' => 'manual', + ], + 'DescribeABTestGroup' => [ + 'summary' => 'Retrieves the details of an A/B test group.', + 'path' => '/v4/openapi/app-groups/{appGroupIdentity}/scenes/{sceneId}/groups/{groupId}', + 'methods' => ['get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -7704,52 +4942,26 @@ 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'list', + 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREopensearchE07IML', - ], + 'abilityTreeNodes' => ['FEATUREopensearchE07IML'], ], 'parameters' => [ [ 'name' => 'appGroupIdentity', 'in' => 'path', - 'schema' => [ - 'description' => 'The application name.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '“my_app_group_name”', - ], + 'schema' => ['description' => 'The name of the application.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'title' => '', 'example' => 'my_app_group_name'], ], [ 'name' => 'sceneId', 'in' => 'path', - 'schema' => [ - 'description' => 'The scenario ID.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'docRequired' => true, - 'maximum' => '999999999', - 'minimum' => '-1', - 'example' => '13467', - ], + 'schema' => ['description' => 'The ID of the scene.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true, 'maximum' => '999999999', 'minimum' => '-1', 'title' => '', 'example' => '20404'], ], [ 'name' => 'groupId', 'in' => 'path', - 'schema' => [ - 'description' => 'The group ID.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'docRequired' => true, - 'maximum' => '999999999', - 'minimum' => '-1', - 'example' => '20404', - ], + 'schema' => ['description' => 'The ID of the group.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true, 'maximum' => '999999999', 'minimum' => '-1', 'title' => '', 'example' => '13467'], ], ], 'responses' => [ @@ -7757,178 +4969,97 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'requestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => 'D77D0DAF-790D-F5F5-A9C0-133738165014', - ], + 'requestId' => ['description' => 'The ID of the request.', 'type' => 'string', 'title' => '', 'example' => 'D77D0DAF-790D-F5F5-A9C0-133738165014'], 'result' => [ - 'description' => 'The experiment details.\\'."\n" - .'For more information, see [ABTestExperiment](~~173617~~).'."\n", - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'created' => [ - 'description' => 'The time when the experiment was created.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1588842080', - ], - 'params' => [ - 'description' => 'The experiment parameters.'."\n", - 'type' => 'object', - 'example' => '1', - ], - 'traffic' => [ - 'description' => 'The percentage of traffic that is routed to the experiment.'."\n" - ."\n" - .'Valid values: \\[0,100]'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '30', - ], - 'online' => [ - 'description' => 'Indicates whether the experiment is in effect. Valid values:'."\n" - ."\n" - .'* true'."\n" - .'* false'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'name' => [ - 'description' => 'The group alias.'."\n", - 'type' => 'string', - 'example' => 'test1', - ], - 'updated' => [ - 'description' => 'The time when the experiment was last modified.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1588842080', - ], - 'id' => [ - 'description' => 'The experiment ID.'."\n", - 'type' => 'string', - 'example' => '12888', - ], - ], + 'description' => 'The A/B test group.', + 'type' => 'object', + 'properties' => [ + 'created' => ['description' => 'The time when the group was created.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '1588839490'], + 'status' => ['description' => 'The status of the group.'."\n" + ."\n" + .'- 0: Inactive'."\n" + ."\n" + .'- 1: Active', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '1'], + 'updated' => ['description' => 'The time when the group was last modified.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '1588839490'], + 'name' => ['description' => 'The alias of the group.', 'type' => 'string', 'title' => '', 'example' => 'Group_2020-5-7_15:23:3'], + 'id' => ['description' => 'The ID of the group.', 'type' => 'string', 'title' => '', 'example' => '13466'], ], + 'title' => '', + 'example' => '', ], ], 'description' => '', + 'title' => '', + 'example' => '', ], ], '5XX' => [ 'schema' => [ 'type' => 'object', 'properties' => [ - 'code' => [ - 'type' => 'string', - ], - 'message' => [ - 'type' => 'string', - ], - 'requestId' => [ - 'type' => 'string', - ], - 'httpCode' => [ - 'type' => 'integer', - 'format' => 'int32', - ], + 'code' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'message' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'requestId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'httpCode' => ['type' => 'integer', 'format' => 'int32', 'description' => '', 'title' => '', 'example' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"requestId\\": \\"D77D0DAF-790D-F5F5-A9C0-133738165014\\",\\n \\"result\\": [\\n {\\n \\"created\\": 1588842080,\\n \\"params\\": 1,\\n \\"traffic\\": 30,\\n \\"online\\": true,\\n \\"name\\": \\"test1\\",\\n \\"updated\\": 1588842080,\\n \\"id\\": \\"12888\\"\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"D77D0DAF-790D-F5F5-A9C0-133738165014\\n\\n 12888\\n test1\\n \\n default\\n \\n 1588842080\\n 1588842080\\n true\\n 30\\n","errorExample":""}]', - 'title' => 'ListABTestExperiments', + 'title' => 'DescribeABTestGroup', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', - ], - 'CreateABTestExperiment' => [ - 'summary' => 'Creates an experiment.', - 'path' => '/v4/openapi/app-groups/{appGroupIdentity}/scenes/{sceneId}/groups/{groupId}/experiments', - 'methods' => [ - 'post', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'opensearch:DescribeApp', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'OpenSearch', 'resourceType' => 'AbTestGroup', 'arn' => 'acs:opensearch:{#regionId}:{#accountId}:apps/{#AppGroupId}'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"D77D0DAF-790D-F5F5-A9C0-133738165014\\",\\n \\"result\\": {\\n \\"created\\": 1588839490,\\n \\"status\\": 1,\\n \\"updated\\": 1588839490,\\n \\"name\\": \\"Group_2020-5-7_15:23:3\\",\\n \\"id\\": \\"13466\\"\\n }\\n}","type":"json"}]', + 'translator' => 'manual', + ], + 'DescribeABTestScene' => [ + 'summary' => 'Query an A/B test scenario.', + 'path' => '/v4/openapi/app-groups/{appGroupIdentity}/scenes/{sceneId}', + 'methods' => ['get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'write', + 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'create', + 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREopensearchE07IML', - ], + 'abilityTreeNodes' => ['FEATUREopensearchE07IML'], ], 'parameters' => [ [ 'name' => 'appGroupIdentity', 'in' => 'path', - 'schema' => [ - 'description' => 'The application name.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'my_app_group_name', - ], + 'schema' => ['description' => 'The name or ID of the application.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'my_app_group_name', 'title' => ''], ], [ 'name' => 'sceneId', 'in' => 'path', - 'schema' => [ - 'description' => 'The scenario ID.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'docRequired' => true, - 'maximum' => '999999999', - 'minimum' => '-1', - 'example' => '20404', - ], - ], - [ - 'name' => 'groupId', - 'in' => 'path', - 'schema' => [ - 'description' => 'The group ID.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'docRequired' => true, - 'maximum' => '999999999', - 'minimum' => '-1', - 'example' => '13467', - ], - ], - [ - 'name' => 'dryRun', - 'in' => 'query', - 'schema' => [ - 'description' => 'Specifies whether to perform a dry run. This parameter is only used to check whether the data source is valid. Valid values: true and false.'."\n", - 'type' => 'boolean', - 'required' => false, - 'example' => 'false', - ], - ], - [ - 'name' => 'body', - 'in' => 'body', - 'schema' => [ - 'description' => 'The request body.'."\n", - 'required' => false, - '$ref' => '#/components/schemas/ABTestExperiment', - ], + 'schema' => ['description' => 'The ID of the test scenario.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true, 'maximum' => '999999999', 'minimum' => '-1', 'example' => '20404', 'title' => ''], ], ], 'responses' => [ @@ -7936,106 +5067,78 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'requestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => 'D77D0DAF-790D-F5F5-A9C0-133738165014', - ], + 'requestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'D77D0DAF-790D-F5F5-A9C0-133738165014', 'title' => ''], 'result' => [ - 'description' => 'The experiment details.'."\n", + 'description' => 'The details of the test scenario.', 'type' => 'object', 'properties' => [ - 'created' => [ - 'description' => 'The time when the experiment was created.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '0', - ], - 'params' => [ - 'description' => 'The experiment parameters.'."\n", - 'type' => 'object', - 'example' => '{"firstFormulaName": "default"}', - ], - 'traffic' => [ - 'description' => 'The percentage of traffic that is routed to the experiment.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '30', - ], - 'online' => [ - 'description' => 'Indicates whether the experiment is in effect. Valid values:'."\n" - ."\n" - .'* true'."\n" - .'* false'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'name' => [ - 'description' => 'The experiment alias.'."\n", - 'type' => 'string', - 'example' => 'test3', - ], - 'updated' => [ - 'description' => 'The time when the experiment was last modified.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1589017861', - ], - 'id' => [ - 'description' => 'The experiment ID.'."\n", - 'type' => 'string', - 'example' => '12889', + 'created' => ['description' => 'The time when the test scenario was created.', 'type' => 'integer', 'format' => 'int32', 'example' => '1596527691', 'title' => ''], + 'status' => ['description' => 'The status of the test scenario. Valid values:'."\n" + ."\n" + .'- 0: The test is stopped.'."\n" + ."\n" + .'- 1: The test is running.', 'type' => 'integer', 'format' => 'int32', 'example' => '0', 'title' => ''], + 'updated' => ['description' => 'The time when the test was last modified.', 'type' => 'integer', 'format' => 'int32', 'example' => '1596527691', 'title' => ''], + 'name' => ['description' => 'The alias of the test scenario.', 'type' => 'string', 'example' => '"test"', 'title' => ''], + 'id' => ['description' => 'The ID of the test scenario.', 'type' => 'string', 'example' => '20614', 'title' => ''], + 'values' => [ + 'description' => 'The identifiers of the test scenario.', + 'type' => 'array', + 'items' => ['description' => 'An identifier for the test scenario.', 'type' => 'string', 'example' => 'test', 'title' => ''], + 'title' => '', + 'example' => '', ], ], + 'title' => '', + 'example' => '', ], ], 'description' => '', + 'title' => '', + 'example' => '', ], ], '5XX' => [ 'schema' => [ 'type' => 'object', 'properties' => [ - 'code' => [ - 'type' => 'string', - ], - 'message' => [ - 'type' => 'string', - ], - 'requestId' => [ - 'type' => 'string', - ], - 'httpCode' => [ - 'type' => 'integer', - 'format' => 'int32', - ], + 'code' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'message' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'requestId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'httpCode' => ['type' => 'integer', 'format' => 'int32', 'description' => '', 'title' => '', 'example' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"requestId\\": \\"D77D0DAF-790D-F5F5-A9C0-133738165014\\",\\n \\"result\\": {\\n \\"created\\": 0,\\n \\"params\\": {\\n \\"firstFormulaName\\": \\"default\\"\\n },\\n \\"traffic\\": 30,\\n \\"online\\": true,\\n \\"name\\": \\"test3\\",\\n \\"updated\\": 1589017861,\\n \\"id\\": \\"12889\\"\\n }\\n}","errorExample":""},{"type":"xml","example":"\\n 0\\n test3\\n true\\n 12889\\n \\n default\\n \\n 1589017861\\n 30\\n\\nD77D0DAF-790D-F5F5-A9C0-133738165014","errorExample":""}]', - 'title' => 'CreateABTestExperiment', - 'requestParamsDescription' => '**Request body**'."\n" - ."\n" - .'|Parameter|Type|Required|Example|Description|'."\n" - .'|---|---|---|---|---|'."\n" - .'|name|String|Yes|"my\\_test"|The experiment name.|'."\n" - .'|traffic|Integer|Yes|30|The traffic that is routed to the experiment.|'."\n" - .'|online|Boolean|Yes|true|Specifies whether the experiment is in effect.|'."\n" - .'|params|Object|Yes|{"firstFormulaName": "default"}|The experiment configurations. For more information, see [ABTestExperiment](~~173617~~).|', - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', - ], - 'DescribeABTestExperiment' => [ - 'summary' => '获取实验详情', - 'path' => '/v4/openapi/app-groups/{appGroupIdentity}/scenes/{sceneId}/groups/{groupId}/experiments/{experimentId}', - 'methods' => [ - 'get', + 'title' => 'DescribeABTestScene', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'opensearch:DescribeApp', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'OpenSearch', 'resourceType' => 'AbTestScene', 'arn' => 'acs:opensearch:{#regionId}:{#accountId}:apps/{#AppGroupId}'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"D77D0DAF-790D-F5F5-A9C0-133738165014\\",\\n \\"result\\": {\\n \\"created\\": 1596527691,\\n \\"status\\": 0,\\n \\"updated\\": 1596527691,\\n \\"name\\": \\"\\\\\\"test\\\\\\"\\",\\n \\"id\\": \\"20614\\",\\n \\"values\\": [\\n \\"test\\"\\n ]\\n }\\n}","type":"json"}]', + 'translator' => 'manual', + ], + 'DescribeApp' => [ + 'summary' => 'Queries the information about a version of an OpenSearch application.', + 'path' => '/v4/openapi/app-groups/{appGroupIdentity}/apps/{appId}', + 'methods' => ['get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -8047,258 +5150,958 @@ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREopensearchE07IML', - ], + 'abilityTreeCode' => '55168', + 'abilityTreeNodes' => ['FEATUREopensearchGVH0IN', 'FEATUREopensearch447AAX', 'FEATUREopensearch5OZOSP'], ], 'parameters' => [ [ 'name' => 'appGroupIdentity', 'in' => 'path', - 'schema' => [ - 'description' => 'The application name.', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'my_app_group_name', - ], - ], - [ - 'name' => 'sceneId', - 'in' => 'path', - 'schema' => [ - 'description' => 'The scenario ID.', - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'docRequired' => true, - 'maximum' => '999999999', - 'minimum' => '-1', - 'example' => '20404', - ], - ], - [ - 'name' => 'groupId', - 'in' => 'path', - 'schema' => [ - 'description' => 'The group ID.', - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'docRequired' => true, - 'maximum' => '999999999', - 'minimum' => '-1', - 'example' => '13467', - ], + 'schema' => ['description' => 'The name of the application', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'my_app_group_name', 'title' => ''], ], [ - 'name' => 'experimentId', + 'name' => 'appId', 'in' => 'path', - 'schema' => [ - 'description' => 'The experiment ID', - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'docRequired' => true, - 'maximum' => '999999999', - 'minimum' => '-1', - 'example' => '12889', - ], + 'schema' => ['description' => 'The version ID.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true, 'example' => '110116134', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ + 'description' => 'The response body.', 'type' => 'object', 'properties' => [ - 'requestId' => [ - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => 'D77D0DAF-790D-F5F5-A9C0-133738165014', - ], + 'requestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '33477D76-C380-1D84-A4AD-043F52876CB1', 'title' => ''], 'result' => [ - 'description' => 'The details of the test.'."\n", + 'description' => 'The version information.', 'type' => 'object', 'properties' => [ - 'created' => [ - 'description' => 'The time when the test was created.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1588842080', - ], - 'traffic' => [ - 'description' => 'The percentage of traffic that is routed to the test.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '30', - ], - 'online' => [ - 'description' => 'The status of the test. Valid values:'."\n" - ."\n" - .'* true: in effect'."\n" - .'* false: not in effect'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'name' => [ - 'description' => 'The name of the test.'."\n", - 'type' => 'string', - 'example' => 'test1', - ], - 'updated' => [ - 'description' => 'The time when the test was last modified.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1588842080', - ], - 'id' => [ - 'description' => 'The ID of the test.'."\n", - 'type' => 'string', - 'example' => '12888', - ], - 'params' => [ - 'description' => 'The parameters of the test.'."\n", + 'id' => ['description' => 'The version ID.', 'type' => 'string', 'example' => '100303063', 'title' => ''], + 'isCurrent' => ['description' => 'Indices whether the version is an online version.', 'type' => 'boolean', 'example' => 'True', 'title' => ''], + 'clusterName' => ['description' => 'The cluster name.', 'type' => 'string', 'example' => '-', 'title' => ''], + 'autoSwitch' => ['description' => 'Indicates whether the version is automatically switched to an online version.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'type' => ['description' => 'The edition type. Valid values:'."\n" + ."\n" + .'- standard: a standard edition application.'."\n" + ."\n" + .'- advance: an advanced edition application of an old version. New versions are not supported for this edition.'."\n" + ."\n" + .'- enhanced: an advanced edition application of a new version.', 'type' => 'string', 'example' => 'enhanced', 'title' => ''], + 'description' => ['description' => 'The description of the version.', 'type' => 'string', 'example' => '-', 'title' => ''], + 'status' => ['description' => 'The status of the version. Valid values:'."\n" + ."\n" + .'- ok: The version is normal.'."\n" + ."\n" + .'- stopped: The version is suspended.'."\n" + ."\n" + .'- frozen: The version is frozen.'."\n" + ."\n" + .'- initializing: The version is being initialized.'."\n" + ."\n" + .'- unavailable: The version is invalid.'."\n" + ."\n" + .'- data\\_waiting: Data is to be initialized.'."\n" + ."\n" + .'- data\\_preparing: Data is being initialized.', 'type' => 'string', 'example' => 'ok', 'title' => ''], + 'schema' => [ + 'description' => 'The schema of the application.', 'type' => 'object', 'properties' => [ - 'first_formula_name' => [ - 'description' => 'The name of the rough sort policy.'."\n", - 'type' => 'string', - 'example' => 'default', - ], - ], - ], - ], - ], - ], - ], - ], - '5XX' => [ - 'schema' => [ - 'type' => 'object', - 'properties' => [ - 'code' => [ - 'type' => 'string', - ], - 'message' => [ - 'type' => 'string', - ], - 'requestId' => [ - 'type' => 'string', - ], - 'httpCode' => [ - 'type' => 'integer', - 'format' => 'int32', + 'tables' => ['description' => 'The table schema.', 'type' => 'object', 'example' => '{'."\n" + .' "primaryTable": true,'."\n" + .' "name": "main",'."\n" + .' "fields": {'."\n" + .' "id": {'."\n" + .' "name": "id",'."\n" + .' "type": "LITERAL",'."\n" + .' "primaryKey": true'."\n" + .' },'."\n" + .' "title": {'."\n" + .' "name": "title",'."\n" + .' "type": "TEXT",'."\n" + .' "primaryKey": false'."\n" + .' },'."\n" + .' "buy": {'."\n" + .' "name": "buy",'."\n" + .' "type": "INT",'."\n" + .' "primaryKey": false'."\n" + .' },'."\n" + .' "cate_id": {'."\n" + .' "name": "cate_id",'."\n" + .' "type": "INT",'."\n" + .' "primaryKey": false'."\n" + .' },'."\n" + .' "cate_name": {'."\n" + .' "name": "cate_name",'."\n" + .' "type": "LITERAL",'."\n" + .' "primaryKey": false'."\n" + .' }'."\n" + .' }'."\n" + .'}', 'title' => ''], + 'indexes' => [ + 'description' => 'The index schema.', + 'type' => 'object', + 'properties' => [ + 'filterFields' => [ + 'description' => 'The attribute fields.', + 'type' => 'array', + 'items' => ['description' => 'The attribute field.', 'type' => 'string', 'example' => 'id', 'title' => ''], + 'title' => '', + 'example' => '', + ], + 'searchFields' => ['description' => 'The index fields.', 'type' => 'object', 'example' => '{'."\n" + .' "fields": ["title"],'."\n" + .' "analyzer": "chn_standard"'."\n" + .'}', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'routeField' => ['description' => 'The name of the level-1 routing field.', 'type' => 'string', 'example' => 'field1', 'title' => ''], + 'routeFieldValues' => [ + 'description' => 'The hot values of the level-1 routing field.', + 'type' => 'array', + 'items' => ['description' => 'The hot value of the level-1 routing field.', 'type' => 'string', 'example' => 'routeFieldValues', 'title' => ''], + 'title' => '', + 'example' => '', + ], + 'secondRouteField' => ['description' => 'The name of the level-2 routing field. This parameter takes effect only when the routeFieldValues parameter is configured. By default, the wide-table primary key field is used as the level-2 routing field.', 'type' => 'string', 'example' => 'field2'."\n", 'title' => ''], + 'ttlField' => [ + 'description' => 'The document clearing configurations.', + 'type' => 'object', + 'properties' => [ + 'name' => ['description' => 'The document time field.', 'type' => 'string', 'example' => 'text1'."\n", 'title' => ''], + 'ttl' => ['description' => 'The TTL. Unit: milliseconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '1000', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'indexSortConfig' => [ + 'description' => 'The sort configurations.', + 'type' => 'array', + 'items' => [ + 'description' => 'The sort configurations.', + 'type' => 'object', + 'properties' => [ + 'field' => ['description' => 'The sort field.', 'type' => 'string', 'example' => 'field1', 'title' => ''], + 'direction' => ['description' => 'The sort method. Valid values:'."\n" + ."\n" + .'- ASC'."\n" + ."\n" + .'- DESC', 'type' => 'string', 'example' => 'DESC', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + 'name' => ['description' => 'The name of the wide table.', 'type' => 'string', 'example' => 'test', 'title' => ''], + ], + 'example' => '{}', + 'title' => '', + ], + 'progressPercent' => ['description' => 'The progress of data import, in percentage. For example, a value of 83 indicates 83%.', 'type' => 'integer', 'format' => 'int32', 'example' => '100', 'title' => ''], + 'fetchFields' => [ + 'description' => 'The default display fields.', + 'type' => 'array', + 'items' => ['description' => 'The default display fields.', 'type' => 'string', 'example' => '{}', 'title' => ''], + 'example' => '[]', + 'title' => '', + ], + 'quota' => [ + 'description' => 'The quota information.', + 'type' => 'object', + 'properties' => [ + 'spec' => ['description' => 'The specifications. Valid values:'."\n" + ."\n" + .'- opensearch.share.junior: basic'."\n" + ."\n" + .'- opensearch.share.common: shared general-purpose'."\n" + ."\n" + .'- opensearch.share.compute: shared computing'."\n" + ."\n" + .'- opensearch.share.storage: shared storage'."\n" + ."\n" + .'- opensearch.private.common: exclusive general-purpose'."\n" + ."\n" + .'- opensearch.private.compute: exclusive computing'."\n" + ."\n" + .'- opensearch.private.storage: exclusive storage', 'type' => 'string', 'example' => 'opensearch.share.common', 'title' => ''], + 'qps' => ['description' => 'The number of search requests per second. You are charged based on the number of search requests per second in the earlier billing model.', 'type' => 'integer', 'format' => 'int32', 'example' => '5', 'title' => ''], + 'docSize' => ['description' => 'The storage capacity. Unit: GB.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'computeResource' => ['description' => 'The computing resources. Unit: logical computing unit (LCU).', 'type' => 'integer', 'format' => 'int32', 'example' => '20', 'title' => ''], + ], + 'example' => '{}', + 'title' => '', + ], + 'domain' => [ + 'description' => 'The industry type. Valid values:'."\n" + ."\n" + .'- GENERAL'."\n" + ."\n" + .'- ECOMMERCE'."\n" + ."\n" + .'- IT\\_CONTENT', + 'type' => 'object', + 'properties' => [ + 'category' => ['description' => 'The type of the edition. Valid values: standard, advance, and enhanced. A value of standard indicates a standard edition. A value of advance indicates an advanced edition which is of an old version. New version is not supported for this edition. A value of enhanced indicates an advanced edition which is of a new version.', 'type' => 'string', 'example' => '-', 'title' => ''], + 'name' => ['description' => 'The name (in English).', 'type' => 'string', 'example' => 'test', 'title' => ''], + 'functions' => [ + 'description' => 'The search results.', + 'type' => 'object', + 'properties' => [ + 'service' => [ + 'description' => 'The description of each feature.', + 'type' => 'array', + 'items' => ['description' => 'Feature 1.', 'type' => 'string', 'example' => '-', 'title' => ''], + 'example' => '[]', + 'title' => '', + ], + 'qp' => [ + 'description' => 'The information about the layout.', + 'type' => 'array', + 'items' => ['description' => 'Information 1.', 'type' => 'string', 'example' => '-', 'title' => ''], + 'example' => '[]', + 'title' => '', + ], + 'algo' => [ + 'description' => 'The structure of the algorithm.', + 'type' => 'array', + 'items' => ['description' => 'Structure 1.', 'type' => 'string', 'example' => '-', 'title' => ''], + 'example' => '[]', + 'title' => '', + ], + ], + 'example' => '{}', + 'title' => '', + ], + ], + 'example' => 'GENERAL', + 'title' => '', + ], + 'schemas' => [ + 'description' => 'The multi-table schema.', + 'type' => 'array', + 'items' => [ + 'description' => 'The single-table schema.', + 'type' => 'object', + 'properties' => [ + 'tables' => ['description' => 'The table schema.', 'type' => 'object', 'example' => '{'."\n" + .' "primaryTable": true,'."\n" + .' "name": "main",'."\n" + .' "fields": {'."\n" + .' "id": {'."\n" + .' "name": "id",'."\n" + .' "type": "LITERAL",'."\n" + .' "primaryKey": true'."\n" + .' },'."\n" + .' "title": {'."\n" + .' "name": "title",'."\n" + .' "type": "TEXT",'."\n" + .' "primaryKey": false'."\n" + .' },'."\n" + .' "buy": {'."\n" + .' "name": "buy",'."\n" + .' "type": "INT",'."\n" + .' "primaryKey": false'."\n" + .' },'."\n" + .' "cate_id": {'."\n" + .' "name": "cate_id",'."\n" + .' "type": "INT",'."\n" + .' "primaryKey": false'."\n" + .' },'."\n" + .' "cate_name": {'."\n" + .' "name": "cate_name",'."\n" + .' "type": "LITERAL",'."\n" + .' "primaryKey": false'."\n" + .' }'."\n" + .' }'."\n" + .'}', 'title' => ''], + 'indexes' => [ + 'description' => 'The index schema.', + 'type' => 'object', + 'properties' => [ + 'filterFields' => [ + 'description' => 'The attribute fields.', + 'type' => 'array', + 'items' => ['description' => 'The attribute field.', 'type' => 'string', 'example' => 'field1', 'title' => ''], + 'title' => '', + 'example' => '', + ], + 'searchFields' => ['description' => 'The index fields.', 'type' => 'object', 'example' => '{'."\n" + .' "fields": ["title"],'."\n" + .' "analyzer": "chn_standard"'."\n" + .'}'."\n", 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'routeField' => ['description' => 'The name of the level-1 routing field.', 'type' => 'string', 'example' => 'field1'."\n", 'title' => ''], + 'routeFieldValues' => [ + 'description' => 'The hot values of the level-1 routing field.', + 'type' => 'array', + 'items' => ['description' => 'The hot value of the level-1 routing field.', 'type' => 'string', 'example' => 'routeFieldValues', 'title' => ''], + 'title' => '', + 'example' => '', + ], + 'secondRouteField' => ['description' => 'The name of the level-2 routing field. This parameter takes effect only when the routeFieldValues parameter is configured. By default, the wide-table primary key field is used as the level-2 routing field.', 'type' => 'string', 'example' => 'field2', 'title' => ''], + 'ttlField' => [ + 'description' => 'The document clearing configurations.', + 'type' => 'object', + 'properties' => [ + 'name' => ['description' => 'The document time field.', 'type' => 'string', 'example' => 'fIeld1', 'title' => ''], + 'ttl' => ['description' => 'The TTL. Unit: milliseconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '1000', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'indexSortConfig' => [ + 'description' => 'The sort configurations.', + 'type' => 'array', + 'items' => [ + 'description' => 'The sort configurations.', + 'type' => 'object', + 'properties' => [ + 'field' => ['description' => 'The sort field.', 'type' => 'string', 'example' => 'fIeld1', 'title' => ''], + 'direction' => ['description' => 'The sort method. Valid values:'."\n" + ."\n" + .'- ASC'."\n" + ."\n" + .'- DESC', 'type' => 'string', 'example' => 'DESC', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + 'name' => ['description' => 'The name of the wide table.', 'type' => 'string', 'example' => 'main', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + 'firstRanks' => [ + 'description' => 'The configurations of rough sort.', + 'type' => 'array', + 'items' => [ + 'description' => 'The configurations of rough sort.', + 'type' => 'object', + 'properties' => [ + 'type' => ['description' => 'The expression type. Valid values:'."\n" + ."\n" + .'STRUCT: The content of the expression is a structure. STRING (default): custom formula.', 'type' => 'string', 'example' => 'STRING', 'title' => ''], + 'name' => ['description' => 'The name of the rough sort expression.', 'type' => 'string', 'example' => 'test', 'title' => ''], + 'description' => ['description' => 'The description.', 'type' => 'string', 'example' => 'Description', 'title' => ''], + 'active' => ['description' => 'Indicates whether the expression is the default one.', 'type' => 'boolean', 'example' => 'False', 'title' => ''], + 'meta' => ['description' => 'The information about the expression. The information can be of the array or string type.', 'type' => 'any', 'example' => 'String :"random()*100+now()"；'."\n" + .'Array: ['."\n" + .' {'."\n" + .' "attribute": "static_bm25()",'."\n" + .' "arg": "",'."\n" + .' "weight": 10'."\n" + .' }'."\n" + .' ]', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + 'secondRanks' => [ + 'description' => 'The configurations of fine sort.', + 'type' => 'array', + 'items' => [ + 'description' => 'The configurations of fine sort.', + 'type' => 'object', + 'properties' => [ + 'meta' => ['description' => 'The fine sort expression. You can define an expression that contains fields, feature functions, and mathematical functions to implement complex sort logic.', 'type' => 'any', 'example' => '"cate_id > 0 and cate_id < 1000"'."\n", 'title' => ''], + 'name' => ['description' => 'The name of the fine sort expression.', 'type' => 'string', 'example' => 'default'."\n", 'title' => ''], + 'description' => ['description' => 'The description.', 'type' => 'string', 'example' => '描述', 'title' => ''], + 'active' => ['description' => 'Indicates whether the expression is the default one.', 'type' => 'boolean', 'example' => 'False', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + 'dataSources' => [ + 'description' => 'The configurations of the data sources.', + 'type' => 'array', + 'items' => [ + 'description' => 'The configurations of the data source.', + 'type' => 'object', + 'properties' => [ + 'tableName' => ['description' => 'The name of the table in the application.', 'type' => 'string', 'example' => 'main', 'title' => ''], + 'type' => ['description' => 'The type of the data source. Valid values:'."\n" + ."\n" + .'- rds'."\n" + ."\n" + .'- odps'."\n" + ."\n" + .'- opensearch'."\n" + ."\n" + .'- polardb', 'type' => 'string', 'example' => 'rds', 'title' => ''], + 'fields' => [ + 'description' => 'The information about field mappings.', + 'type' => 'array', + 'items' => ['description' => 'The information about field mappings.', 'type' => 'object', 'example' => '{'."\n" + .' "id": "id"'."\n" + .' }'."\n", 'title' => ''], + 'title' => '', + 'example' => '', + ], + 'plugins' => ['description' => 'The plug-ins that are used for data processing.'."\n" + ."\n" + .'name:'."\n" + ."\n" + .'- JsonKeyValueExtractor'."\n" + ."\n" + .'- MultiValueSpliter'."\n" + ."\n" + .'- KeyValueExtractor'."\n" + ."\n" + .'- StringCatenateExtractor'."\n" + ."\n" + .'- HTMLTagRemover'."\n" + ."\n" + .'parameters:'."\n" + ."\n" + .'- JsonKeyValueExtractor'."\n" + ."\n" + .'- MultiValueSpliter'."\n" + ."\n" + .'- KeyValueExtractor'."\n" + ."\n" + .'- StringCatenateExtractor'."\n" + ."\n" + .'- HTMLTagRemover', 'type' => 'object', 'example' => '{'."\n" + .' "name": "JsonKeyValueExtractor",'."\n" + .' "parameters": {'."\n" + .' "key": "my_field"'."\n" + .'}'."\n" + .'}', 'title' => ''], + 'keyField' => ['description' => 'The primary key.', 'type' => 'string', 'example' => 'id', 'title' => ''], + 'schemaName' => ['description' => 'The name of the wide table.', 'type' => 'string', 'example' => 'name', 'title' => ''], + 'parameters' => ['description' => 'The information about the data source.', 'type' => 'object', 'example' => '{'."\n" + .' "instanceId": "rds-instance-id",'."\n" + .' "dbName": "my_db",'."\n" + .' "dbTableName": "my_table",'."\n" + .' "dbUser": "my",'."\n" + .' "dbPassword": "my_passwd",'."\n" + .' "filter":"",'."\n" + .' "autoSync": true'."\n" + .'}'."\n", 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + 'summaries' => [ + 'description' => 'The summary configurations of search results.', + 'type' => 'array', + 'items' => [ + 'description' => 'The summary configurations of search results.', + 'type' => 'object', + 'properties' => [ + 'name' => ['description' => 'The group name.', 'type' => 'string', 'example' => 'default', 'title' => ''], + 'meta' => [ + 'description' => 'The summary configurations.', + 'type' => 'array', + 'items' => [ + 'description' => 'The summary configurations.', + 'type' => 'object', + 'properties' => [ + 'field' => ['description' => 'The field.', 'type' => 'string', 'example' => 'field1', 'title' => ''], + 'len' => ['description' => 'The length of the segment. Valid values: 1 to 300.', 'type' => 'integer', 'format' => 'int32', 'example' => '50', 'title' => ''], + 'element' => ['description' => 'The element that is used for highlighting.', 'type' => 'string', 'example' => 'em', 'title' => ''], + 'ellipsis' => ['description' => 'The connector that is used to connect segments.', 'type' => 'string', 'example' => '...', 'title' => ''], + 'snippet' => ['description' => 'The number of segments. Valid values: 1 to 5.', 'type' => 'string', 'example' => '5', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + 'queryProcessors' => [ + 'description' => 'The query intent understanding configurations.', + 'type' => 'array', + 'items' => [ + 'description' => 'The query intent understanding configurations.', + 'type' => 'object', + 'properties' => [ + 'name' => ['description' => 'The rule name.', 'type' => 'string', 'example' => 'test', 'title' => ''], + 'domain' => ['description' => 'The industry type. Valid values:'."\n" + ."\n" + .'- GENERAL'."\n" + ."\n" + .'- ECOMMERCE'."\n" + ."\n" + .'- IT\\_CONTENT', 'type' => 'string', 'example' => 'GENERAL', 'title' => ''], + 'category' => ['description' => 'The industry category.', 'type' => 'string', 'example' => '""', 'title' => ''], + 'processors' => [ + 'description' => 'The features.', + 'type' => 'array', + 'items' => ['description' => 'The features.', 'type' => 'object', 'example' => '{'."\n" + .'"name": "stop_word", "useSystemDictionary": true,'."\n" + .'"interventionDictionary": "my_dict",'."\n" + .' "ignoreSpace": true'."\n" + .'}', 'title' => ''], + 'title' => '', + 'example' => '', + ], + 'indexes' => [ + 'description' => 'Then index range.', + 'type' => 'array', + 'items' => ['description' => 'The index.', 'type' => 'string', 'example' => 'default', 'title' => ''], + 'title' => '', + 'example' => '', + ], + 'active' => ['description' => 'Indicates whether the rule is the default one.', 'type' => 'boolean', 'example' => 'False', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + 'cluster' => [ + 'description' => 'The capability opening configurations.', + 'type' => 'object', + 'properties' => [ + 'maxTimeoutMS' => ['description' => 'The timeout period. Unit: milliseconds.', 'type' => 'integer', 'format' => 'int32', 'example' => '750', 'title' => ''], + 'maxQueryClauseLength' => ['description' => 'The maximum length of the query clause.', 'type' => 'integer', 'format' => 'int32', 'example' => '1024', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'interpretations' => ['description' => 'The industry model module.', 'type' => 'object', 'example' => '['."\n" + .'    {'."\n" + .'        "table": "table1",'."\n" + .'        "fields": ['."\n" + .'            {'."\n" + .'                "name": "field1",'."\n" + .'                "interpretation": " title"'."\n" + .'            },'."\n" + .'            {'."\n" + .'                "name": "field2",'."\n" + .'                "interpretation": " ID"'."\n" + .'            }'."\n" + .'        ]'."\n" + .'    }'."\n" + .']', 'title' => ''], + 'prompts' => [ + 'description' => 'The prompt configurations.', + 'type' => 'array', + 'items' => ['description' => 'The prompt configurations.', 'type' => 'object', 'example' => '{'."\n" + .' "parameters" : ['."\n" + .' {'."\n" + .' "name" : "docs",'."\n" + .' "value" : "doc内容的拼接方式，比如现在的 qwen的 \'
\\n${doc}\\n
\\n"'."\n" + .' }'."\n" + .' ],'."\n" + .' "messages":['."\n" + .' {'."\n" + .' "role" : "role_name，这里是否需要限定只能是 system, user, assistant，还是可以让用户随意填写",'."\n" + .' "content" : "用户设置的prompt内容，里面可以使用 ${parameter_key} 来表示期望动态替换的内容，具体替换规则参考下面说明"'."\n" + .' }'."\n" + .' ]'."\n" + .' }', 'title' => ''], + 'title' => '', + 'example' => '{'."\n" + .' "parameters" : ['."\n" + .' {'."\n" + .' "name" : "docs",'."\n" + .' "value" : "The concatenation method for doc content. For example, the current qwen format: \'
\\n${doc}\\n
\\n"'."\n" + .' }'."\n" + .' ],'."\n" + .' "messages":['."\n" + .' {'."\n" + .' "role" : "role_name. Whether this should be limited to system, user, or assistant, or allow custom values",'."\n" + .' "content" : "User-defined prompt content. Use ${parameter_key} to indicate dynamically replaced content. See the rules below for details"'."\n" + .' }'."\n" + .' ]'."\n" + .' }', + ], + ], + 'example' => '{}', + 'title' => '', ], ], + 'example' => '{}', + 'title' => '', + ], + ], + '5XX' => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'code' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'message' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'requestId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'httpCode' => ['type' => 'integer', 'format' => 'int32', 'description' => '', 'title' => '', 'example' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"requestId\\": \\"D77D0DAF-790D-F5F5-A9C0-133738165014\\",\\n \\"result\\": {\\n \\"created\\": 1588842080,\\n \\"traffic\\": 30,\\n \\"online\\": true,\\n \\"name\\": \\"test1\\",\\n \\"updated\\": 1588842080,\\n \\"id\\": \\"12888\\",\\n \\"params\\": {\\n \\"first_formula_name\\": \\"default\\"\\n }\\n }\\n}","errorExample":""},{"type":"xml","example":"D77D0DAF-790D-F5F5-A9C0-133738165014\\n\\n 12888\\n test1\\n \\n default\\n \\n 1588842080\\n 1588842080\\n true\\n 30\\n","errorExample":""}]', - 'title' => 'DescribeABTestExperiment', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"33477D76-C380-1D84-A4AD-043F52876CB1\\",\\n \\"result\\": {\\n \\"id\\": \\"100303063\\",\\n \\"isCurrent\\": true,\\n \\"clusterName\\": \\"-\\",\\n \\"autoSwitch\\": true,\\n \\"type\\": \\"enhanced\\",\\n \\"description\\": \\"-\\",\\n \\"status\\": \\"ok\\",\\n \\"schema\\": {\\n \\"tables\\": {\\n \\"primaryTable\\": true,\\n \\"name\\": \\"main\\",\\n \\"fields\\": {\\n \\"id\\": {\\n \\"name\\": \\"id\\",\\n \\"type\\": \\"LITERAL\\",\\n \\"primaryKey\\": true\\n },\\n \\"title\\": {\\n \\"name\\": \\"title\\",\\n \\"type\\": \\"TEXT\\",\\n \\"primaryKey\\": false\\n },\\n \\"buy\\": {\\n \\"name\\": \\"buy\\",\\n \\"type\\": \\"INT\\",\\n \\"primaryKey\\": false\\n },\\n \\"cate_id\\": {\\n \\"name\\": \\"cate_id\\",\\n \\"type\\": \\"INT\\",\\n \\"primaryKey\\": false\\n },\\n \\"cate_name\\": {\\n \\"name\\": \\"cate_name\\",\\n \\"type\\": \\"LITERAL\\",\\n \\"primaryKey\\": false\\n }\\n }\\n },\\n \\"indexes\\": {\\n \\"filterFields\\": [\\n \\"id\\"\\n ],\\n \\"searchFields\\": {\\n \\"fields\\": [\\n \\"title\\"\\n ],\\n \\"analyzer\\": \\"chn_standard\\"\\n }\\n },\\n \\"routeField\\": \\"field1\\",\\n \\"routeFieldValues\\": [\\n \\"routeFieldValues\\"\\n ],\\n \\"secondRouteField\\": \\"field2\\\\n\\",\\n \\"ttlField\\": {\\n \\"name\\": \\"text1\\\\n\\",\\n \\"ttl\\": 1000\\n },\\n \\"indexSortConfig\\": [\\n {\\n \\"field\\": \\"field1\\",\\n \\"direction\\": \\"DESC\\"\\n }\\n ],\\n \\"name\\": \\"test\\"\\n },\\n \\"progressPercent\\": 100,\\n \\"fetchFields\\": [\\n \\"{}\\"\\n ],\\n \\"quota\\": {\\n \\"spec\\": \\"opensearch.share.common\\",\\n \\"qps\\": 5,\\n \\"docSize\\": 1,\\n \\"computeResource\\": 20\\n },\\n \\"domain\\": {\\n \\"category\\": \\"-\\",\\n \\"name\\": \\"test\\",\\n \\"functions\\": {\\n \\"service\\": [\\n \\"-\\"\\n ],\\n \\"qp\\": [\\n \\"-\\"\\n ],\\n \\"algo\\": [\\n \\"-\\"\\n ]\\n }\\n },\\n \\"schemas\\": [\\n {\\n \\"tables\\": {\\n \\"primaryTable\\": true,\\n \\"name\\": \\"main\\",\\n \\"fields\\": {\\n \\"id\\": {\\n \\"name\\": \\"id\\",\\n \\"type\\": \\"LITERAL\\",\\n \\"primaryKey\\": true\\n },\\n \\"title\\": {\\n \\"name\\": \\"title\\",\\n \\"type\\": \\"TEXT\\",\\n \\"primaryKey\\": false\\n },\\n \\"buy\\": {\\n \\"name\\": \\"buy\\",\\n \\"type\\": \\"INT\\",\\n \\"primaryKey\\": false\\n },\\n \\"cate_id\\": {\\n \\"name\\": \\"cate_id\\",\\n \\"type\\": \\"INT\\",\\n \\"primaryKey\\": false\\n },\\n \\"cate_name\\": {\\n \\"name\\": \\"cate_name\\",\\n \\"type\\": \\"LITERAL\\",\\n \\"primaryKey\\": false\\n }\\n }\\n },\\n \\"indexes\\": {\\n \\"filterFields\\": [\\n \\"field1\\"\\n ],\\n \\"searchFields\\": {\\n \\"fields\\": [\\n \\"title\\"\\n ],\\n \\"analyzer\\": \\"chn_standard\\"\\n }\\n },\\n \\"routeField\\": \\"field1\\\\n\\",\\n \\"routeFieldValues\\": [\\n \\"routeFieldValues\\"\\n ],\\n \\"secondRouteField\\": \\"field2\\",\\n \\"ttlField\\": {\\n \\"name\\": \\"fIeld1\\",\\n \\"ttl\\": 1000\\n },\\n \\"indexSortConfig\\": [\\n {\\n \\"field\\": \\"fIeld1\\",\\n \\"direction\\": \\"DESC\\"\\n }\\n ],\\n \\"name\\": \\"main\\"\\n }\\n ],\\n \\"firstRanks\\": [\\n {\\n \\"type\\": \\"STRING\\",\\n \\"name\\": \\"test\\",\\n \\"description\\": \\"Description\\",\\n \\"active\\": true,\\n \\"meta\\": \\"String :\\\\\\"random()*100+now()\\\\\\"；\\\\nArray: [\\\\n {\\\\n \\\\\\"attribute\\\\\\": \\\\\\"static_bm25()\\\\\\",\\\\n \\\\\\"arg\\\\\\": \\\\\\"\\\\\\",\\\\n \\\\\\"weight\\\\\\": 10\\\\n }\\\\n ]\\"\\n }\\n ],\\n \\"secondRanks\\": [\\n {\\n \\"meta\\": \\"\\\\\\"cate_id > 0 and cate_id < 1000\\\\\\"\\\\n\\",\\n \\"name\\": \\"default\\\\n\\",\\n \\"description\\": \\"描述\\",\\n \\"active\\": true\\n }\\n ],\\n \\"dataSources\\": [\\n {\\n \\"tableName\\": \\"main\\",\\n \\"type\\": \\"rds\\",\\n \\"fields\\": [\\n {\\n \\"id\\": \\"id\\"\\n }\\n ],\\n \\"plugins\\": {\\n \\"name\\": \\"JsonKeyValueExtractor\\",\\n \\"parameters\\": {\\n \\"key\\": \\"my_field\\"\\n }\\n },\\n \\"keyField\\": \\"id\\",\\n \\"schemaName\\": \\"name\\",\\n \\"parameters\\": {\\n \\"instanceId\\": \\"rds-instance-id\\",\\n \\"dbName\\": \\"my_db\\",\\n \\"dbTableName\\": \\"my_table\\",\\n \\"dbUser\\": \\"my\\",\\n \\"dbPassword\\": \\"my_passwd\\",\\n \\"filter\\": \\"\\",\\n \\"autoSync\\": true\\n }\\n }\\n ],\\n \\"summaries\\": [\\n {\\n \\"name\\": \\"default\\",\\n \\"meta\\": [\\n {\\n \\"field\\": \\"field1\\",\\n \\"len\\": 50,\\n \\"element\\": \\"em\\",\\n \\"ellipsis\\": \\"...\\",\\n \\"snippet\\": \\"5\\"\\n }\\n ]\\n }\\n ],\\n \\"queryProcessors\\": [\\n {\\n \\"name\\": \\"test\\",\\n \\"domain\\": \\"GENERAL\\",\\n \\"category\\": \\"\\\\\\"\\\\\\"\\",\\n \\"processors\\": [\\n {\\n \\"name\\": \\"stop_word\\",\\n \\"useSystemDictionary\\": true,\\n \\"interventionDictionary\\": \\"my_dict\\",\\n \\"ignoreSpace\\": true\\n }\\n ],\\n \\"indexes\\": [\\n \\"default\\"\\n ],\\n \\"active\\": true\\n }\\n ],\\n \\"cluster\\": {\\n \\"maxTimeoutMS\\": 750,\\n \\"maxQueryClauseLength\\": 1024\\n },\\n \\"interpretations\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n },\\n \\"prompts\\": [\\n {\\n \\"parameters\\": [\\n {\\n \\"name\\": \\"docs\\",\\n \\"value\\": \\"doc内容的拼接方式，比如现在的 qwen的 \'
\\\\n${doc}\\\\n
\\\\n\\"\\n }\\n ],\\n \\"messages\\": [\\n {\\n \\"role\\": \\"role_name，这里是否需要限定只能是 system, user, assistant，还是可以让用户随意填写\\",\\n \\"content\\": \\"用户设置的prompt内容，里面可以使用 ${parameter_key} 来表示期望动态替换的内容，具体替换规则参考下面说明\\"\\n }\\n ]\\n }\\n ]\\n }\\n}","type":"json"}]', + 'title' => 'DescribeApp', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', - ], - 'UpdateABTestExperiment' => [ - 'summary' => 'Modifies the parameters of an A/B test.', - 'path' => '/v4/openapi/app-groups/{appGroupIdentity}/scenes/{sceneId}/groups/{groupId}/experiments/{experimentId}', - 'methods' => [ - 'put', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'opensearch:DescribeApp', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'OpenSearch', 'resourceType' => 'App', 'arn' => 'acs:opensearch:{#regionId}:{#accountId}:app-groups/{#AppGroupId}'], + ], + ], + ], ], + 'translator' => 'manual', + ], + 'DescribeAppGroup' => [ + 'path' => '/v4/openapi/app-groups/{appGroupIdentity}', + 'methods' => ['get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'write', + 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'update', - 'riskType' => 'none', - 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREopensearchE07IML', - ], + 'operationType' => 'get', + 'abilityTreeCode' => '55169', + 'abilityTreeNodes' => ['FEATUREopensearchGVH0IN', 'FEATUREopensearch447AAX', 'FEATUREopensearch5OZOSP'], ], 'parameters' => [ [ 'name' => 'appGroupIdentity', 'in' => 'path', + 'schema' => ['description' => 'The application name.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'my_app_group_name', 'title' => ''], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => 'The name of the application.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '“my_app_group_name”', + 'type' => 'object', + 'properties' => [ + 'requestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '0A6EB64B-B4C8-CF02-810F-E660812972FF', 'title' => ''], + 'result' => [ + 'description' => 'The information about the application.', + 'type' => 'object', + 'properties' => [ + 'created' => ['description' => 'The timestamp when the application was created.', 'type' => 'integer', 'format' => 'int32', 'example' => '1575442875', 'title' => ''], + 'currentVersion' => ['description' => 'The ID of the current online version.', 'type' => 'string', 'example' => '110116134', 'title' => ''], + 'pendingSecondRankAlgoDeploymentId' => ['description' => 'The ID of the fine sort expression that is being created.', 'type' => 'integer', 'format' => 'int32', 'example' => '0', 'title' => ''], + 'lockMode' => ['description' => 'The lock state. Valid values:'."\n" + ."\n" + .'- Unlock: The instance is unlocked.'."\n" + ."\n" + .'- LockByExpiration: The instance is automatically locked after it expires.'."\n" + ."\n" + .'- ManualLock: The instance is manually locked.', 'type' => 'string', 'example' => 'Unlock', 'title' => ''], + 'updated' => ['description' => 'The timestamp when the application was last updated.', 'type' => 'integer', 'format' => 'int32', 'example' => '1578916076', 'title' => ''], + 'id' => ['description' => 'The application ID.', 'type' => 'string', 'example' => '110116134', 'title' => ''], + 'chargeType' => ['description' => 'The billing method. Valid values:'."\n" + ."\n" + .'- POSTPAY: pay-as-you-go.'."\n" + ."\n" + .'- PREPAY: subscription.', 'type' => 'string', 'example' => 'POSTPAY', 'title' => ''], + 'hasPendingQuotaReviewTask' => ['description' => 'The approval state of the quotas. Valid values:'."\n" + ."\n" + .'- 0: The application is in service.'."\n" + ."\n" + .'- 1: The quotas are being reviewed.', 'type' => 'integer', 'format' => 'int32', 'example' => '0', 'title' => ''], + 'secondRankAlgoDeploymentId' => ['description' => 'The ID of the created fine sort expression.', 'type' => 'integer', 'format' => 'int32', 'example' => '0', 'title' => ''], + 'name' => ['description' => 'The application name.', 'type' => 'string', 'example' => 'os_function_test_v1', 'title' => ''], + 'instanceId' => ['description' => 'The instance ID.', 'type' => 'string', 'example' => '-', 'title' => ''], + 'processingOrderId' => ['description' => 'The ID of the order that is not complete.', 'type' => 'string', 'example' => '-', 'title' => ''], + 'chargingWay' => ['description' => 'The billable item. Valid values:'."\n" + ."\n" + .'- 1: computing resources.'."\n" + ."\n" + .'- 2: queries per second (QPS).', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'type' => ['description' => 'The type of the application. Valid values:'."\n" + ."\n" + .'- standard: a High-performance Search Edition application.'."\n" + ."\n" + .'- enhanced: an Industry Algorithm Edition application.', 'type' => 'string', 'example' => 'enhanced', 'title' => ''], + 'status' => ['description' => 'The state of the application. Valid values:'."\n" + ."\n" + .'- producing: The application is being created.'."\n" + ."\n" + .'- review\\_pending: The application is being reviewed.'."\n" + ."\n" + .'- config\\_pending: The application is to be configured.'."\n" + ."\n" + .'- normal: The application is in service.'."\n" + ."\n" + .'- frozen: The application is frozen.', 'type' => 'string', 'example' => 'normal', 'title' => ''], + 'projectId' => ['description' => 'The name of the A/B test group.', 'type' => 'string', 'example' => '-', 'title' => ''], + 'switchedTime' => ['description' => 'The timestamp when the current online version was published.', 'type' => 'integer', 'format' => 'int32', 'example' => '0', 'title' => ''], + 'commodityCode' => ['description' => 'The commodity code.', 'type' => 'string', 'example' => 'opensearch', 'title' => ''], + 'expireOn' => ['description' => 'The expiration time.', 'type' => 'string', 'example' => '-', 'title' => ''], + 'domain' => ['description' => 'The industry of the application.', 'type' => 'string', 'example' => 'ecommerce', 'title' => ''], + 'description' => ['description' => 'The description of the application.', 'type' => 'string', 'example' => '-', 'title' => ''], + 'firstRankAlgoDeploymentId' => ['description' => 'The ID of the created rough sort expression.', 'type' => 'integer', 'format' => 'int32', 'example' => '0', 'title' => ''], + 'produced' => ['description' => 'Indicates whether the application is created. Valid values:'."\n" + ."\n" + .'- 0: The application is being created.'."\n" + ."\n" + .'- 1: The application is created.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'lockedByExpiration' => ['description' => 'Indicates whether the instance is automatically locked after it expires.', 'type' => 'integer', 'format' => 'int32', 'example' => '0', 'title' => ''], + 'quota' => [ + 'description' => 'The information about the quotas of the application.', + 'type' => 'object', + 'properties' => [ + 'spec' => ['description' => 'The specifications. Valid values:'."\n" + ."\n" + .'- opensearch.share.junior: basic.'."\n" + ."\n" + .'- opensearch.share.common: shared general-purpose.'."\n" + ."\n" + .'- opensearch.share.compute: shared computing.'."\n" + ."\n" + .'- opensearch.share.storage: shared storage.'."\n" + ."\n" + .'- opensearch.private.common: exclusive general-purpose.'."\n" + ."\n" + .'- opensearch.private.compute: exclusive computing.'."\n" + ."\n" + .'- opensearch.private.storage: exclusive storage.', 'type' => 'string', 'example' => 'opensearch.share.common', 'title' => ''], + 'docSize' => ['description' => 'The storage capacity. Unit: GB.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'computeResource' => ['description' => 'The computing resources. Unit: logical computing unit (LCU).', 'type' => 'integer', 'format' => 'int32', 'example' => '20', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'tags' => [ + 'description' => 'The application tags.', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'key' => ['description' => 'The tag key.', 'type' => 'string', 'example' => 'foo', 'title' => ''], + 'value' => ['description' => 'The tag value', 'type' => 'string', 'example' => 'bar', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + 'resourceGroupId' => ['description' => 'The ID of the resource group to which the network instance belongs.', 'type' => 'string', 'example' => 'rg-acfmoiyerh6nzly', 'title' => ''], + 'engineType' => ['description' => 'The engine type.', 'type' => 'string', 'example' => 'ha3', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], - [ - 'name' => 'sceneId', - 'in' => 'path', + '5XX' => [ 'schema' => [ - 'description' => 'The scenario ID.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'docRequired' => true, - 'maximum' => '999999999', - 'minimum' => '-1', - 'example' => '20404', + 'type' => 'object', + 'properties' => [ + 'code' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'message' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'requestId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'httpCode' => ['type' => 'integer', 'format' => 'int32', 'description' => '', 'title' => '', 'example' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], + ], + 'title' => 'DescribeAppGroup', + 'summary' => 'Query an OpenSearch application.', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ [ - 'name' => 'groupId', - 'in' => 'path', - 'schema' => [ - 'description' => 'The ID of the test group'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'docRequired' => true, - 'maximum' => '999999999', - 'minimum' => '-1', - 'example' => '13467', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'opensearch:DescribeAppGroup', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'OpenSearch', 'resourceType' => 'AppGroup', 'arn' => 'acs:opensearch:{#regionId}:{#accountId}:app-groups/{#AppGroupId}'], + ], ], ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"0A6EB64B-B4C8-CF02-810F-E660812972FF\\",\\n \\"result\\": {\\n \\"created\\": 1575442875,\\n \\"currentVersion\\": \\"110116134\\",\\n \\"pendingSecondRankAlgoDeploymentId\\": 0,\\n \\"lockMode\\": \\"Unlock\\",\\n \\"updated\\": 1578916076,\\n \\"id\\": \\"110116134\\",\\n \\"chargeType\\": \\"POSTPAY\\",\\n \\"hasPendingQuotaReviewTask\\": 0,\\n \\"secondRankAlgoDeploymentId\\": 0,\\n \\"name\\": \\"os_function_test_v1\\",\\n \\"instanceId\\": \\"-\\",\\n \\"processingOrderId\\": \\"-\\",\\n \\"chargingWay\\": 1,\\n \\"type\\": \\"enhanced\\",\\n \\"status\\": \\"normal\\",\\n \\"projectId\\": \\"-\\",\\n \\"switchedTime\\": 0,\\n \\"commodityCode\\": \\"opensearch\\",\\n \\"expireOn\\": \\"-\\",\\n \\"domain\\": \\"ecommerce\\",\\n \\"description\\": \\"-\\",\\n \\"firstRankAlgoDeploymentId\\": 0,\\n \\"produced\\": 1,\\n \\"lockedByExpiration\\": 0,\\n \\"quota\\": {\\n \\"spec\\": \\"opensearch.share.common\\",\\n \\"docSize\\": 1,\\n \\"computeResource\\": 20\\n },\\n \\"tags\\": [\\n {\\n \\"key\\": \\"foo\\",\\n \\"value\\": \\"bar\\"\\n }\\n ],\\n \\"resourceGroupId\\": \\"rg-acfmoiyerh6nzly\\",\\n \\"engineType\\": \\"ha3\\"\\n }\\n}","type":"json"}]', + 'translator' => 'manual', + ], + 'DescribeAppStatistics' => [ + 'summary' => 'Queries the statistics about a version of an OpenSearch application.', + 'path' => '/v4/openapi/app-groups/{appGroupIdentity}/apps/{appId}/statistics', + 'methods' => ['get'], + 'schemes' => ['http', 'https'], + 'security' => [ [ - 'name' => 'experimentId', + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATUREopensearch447AAX', 'FEATUREopensearchXLGC1X'], + ], + 'parameters' => [ + [ + 'name' => 'appGroupIdentity', 'in' => 'path', + 'schema' => ['description' => 'The name of the application.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'my_app_group_name', 'title' => ''], + ], + [ + 'name' => 'appId', + 'in' => 'path', + 'schema' => ['description' => 'The version number of the application.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '110157886', 'title' => ''], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => 'The test ID.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'docRequired' => true, - 'maximum' => '999999999', - 'minimum' => '-1', - 'example' => '12889', + 'type' => 'object', + 'properties' => [ + 'result' => ['description' => 'The statistics.'."\n", 'type' => 'object', 'example' => '{}', 'title' => ''], + 'requestId' => ['description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '76FC45F1-4167-D3CD-6737-4F97BA503FA0', 'title' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], - [ - 'name' => 'dryRun', - 'in' => 'query', + '5XX' => [ 'schema' => [ - 'description' => 'Specifies whether to perform only a dry run, without performing the actual request. Valid values:'."\n" - ."\n" - .'* true: performs only a dry run. No endpoint is created. The system checks whether your AccessKey is valid, whether Resource Access Management (RAM) users are authorized, and whether the required parameters are set.'."\n" - .'* false (default): creates an endpoint immediately.'."\n", - 'type' => 'boolean', - 'required' => false, - 'example' => 'true', + 'type' => 'object', + 'properties' => [ + 'code' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'message' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'requestId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'httpCode' => ['type' => 'integer', 'format' => 'int32', 'description' => '', 'title' => '', 'example' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + ], + ], + 'title' => 'DescribeAppStatistics', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => '**Statistical results**'."\n" + ."\n" + .'|Parameter|Type|Description|'."\n" + .'|---|---|---|'."\n" + .'|result.pv|Integer|The number of requests.|'."\n" + .'|result.docCount|Integer|The number of documents.|'."\n" + .'|result.docLastUpdated|String|The timestamp when the document was last updated.|'."\n" + .'|result.quota|Object|The statistics about the quotas.|'."\n" + .'|result.quota.instance|Object|The statistics about the instance.|'."\n" + .'|result.quota.instance.used|Float|The used quota. Unit: LCUs.|'."\n" + .'|result.quota.instance.quota|Integer|The quota capacity. Unit:GB.|'."\n" + .'|result.quota.instance.outOfLimit|Boolean|Indicates whether the quotas are exceeded.|'."\n" + .'|result.quota.instance.tables|Object|The statistics used by each data table. The key name is the name of the table, and the value is the used capacity.|'."\n" + .'|result.quota.qps|Object|The statistics about the quota of queries per second (QPS).|'."\n" + .'|result.quota.qps.used|Float|The used quota of QPS.|'."\n" + .'|result.quota.qps.quota|Integer|The total quota of QPS.|'."\n" + .'|result.quota.qps.outOfLimit|Boolean|Indicates whether the quotas are exceeded.|'."\n" + .'|result.quota.qps.tables|Array|\\--|'."\n" + .'|result.quota.computeResource|Object|The statistics about the quota of computing resources.|'."\n" + .'|result.quota.computeResource.used|Float|The used computing resources. Unit: LCUs.|'."\n" + .'|result.quota.computeResource.quota|Integer|The quota of computing resources. Unit: GB.|'."\n" + .'|result.quota.computeResource.outOfLimit|Boolean|Indicates whether the quotas are exceeded.|'."\n" + .'|result.quota.computeResource.dailyPeak|Float|The maximum amount of computing resources used. Unit: LCUs.|'."\n" + .'|result.quota.spec|String|The specifications of the application. Valid values:opensearch.share.junior: basicopensearch.share.common: shared general-purposeopensearch.share.compute: shared computingopensearch.share.storage: shared storageopensearch.private.common: exclusive general-purposeopensearch.private.compute: exclusive computingopensearch.private.storage: exclusive storage|'."\n" + .'|result.quota.docCount|Object|The statistics of the document number. The key indicates the name of the table. The value indicates the used quotas.|'."\n" + .'|result.quota.mainTable|String|The name of the primary table.|', + 'extraInfo' => ' ', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'opensearch:DescribeAppStatistics', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'OpenSearch', 'resourceType' => 'App', 'arn' => 'acs:opensearch:{#regionId}:{#accountId}:app-groups/{#AppGroupId}'], + ], ], ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"result\\": {},\\n \\"requestId\\": \\"76FC45F1-4167-D3CD-6737-4F97BA503FA0\\"\\n}","errorExample":""},{"type":"xml","example":"76FC45F1-4167-D3CD-6737-4F97BA503FA0\\n\\n 5002\\n 168\\n 1582522280\\n \\n \\n 0.000002\\n 1\\n false\\n \\n
2222
\\n \\n \\n \\n 0\\n 0\\n false\\n \\n \\n 0\\n 20\\n false\\n 1.0306227624786388\\n \\n opensearch.share.common\\n \\n
168
\\n \\n main\\n \\n","errorExample":""}]', + ], + 'DescribeApps' => [ + 'summary' => 'Queries the versions of an OpenSearch application.', + 'path' => '/v4/openapi/app-groups/{appGroupIdentity}/apps', + 'methods' => ['get'], + 'schemes' => ['http', 'https'], + 'security' => [ [ - 'name' => 'body', - 'in' => 'body', - 'schema' => [ - 'description' => 'The request body. For more information, see [ABTestExperiment](~~173617~~).'."\n", - 'required' => false, - '$ref' => '#/components/schemas/ABTestExperiment', - ], + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '55172', + 'abilityTreeNodes' => ['FEATUREopensearchGVH0IN', 'FEATUREopensearch447AAX', 'FEATUREopensearch5OZOSP'], + ], + 'parameters' => [ + [ + 'name' => 'appGroupIdentity', + 'in' => 'path', + 'schema' => ['description' => 'The name or ID of the application group.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'my_app_group_name', 'title' => ''], ], ], 'responses' => [ @@ -8306,447 +6109,536 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'requestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => 'D77D0DAF-790D-F5F5-A9C0-133738165014', - ], + 'requestId' => ['description' => 'The ID of the request.', 'type' => 'string', 'example' => '77CAA411-0010-4DB9-82E2-1C384E590AFF', 'title' => ''], 'result' => [ - 'description' => 'The details of the test.'."\n", - 'type' => 'object', - 'properties' => [ - 'created' => [ - 'description' => 'The time when the test was created.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1588842080', - ], - 'params' => [ - 'description' => 'The test parameters.'."\n", - 'type' => 'object', - 'example' => '{}', - ], - 'traffic' => [ - 'description' => 'The percentage of traffic that is routed to the test. Valid values: \\[0,100]'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '30', - ], - 'online' => [ - 'description' => 'Indicates whether the test is in effect. Valid values:'."\n" + 'description' => 'The response parameters.', + 'type' => 'array', + 'items' => [ + 'description' => 'The version information. For more information, see [App](~~170002~~).', + 'type' => 'object', + 'properties' => [ + 'id' => ['description' => 'The ID of the application.', 'type' => 'string', 'example' => '100302881', 'title' => ''], + 'isCurrent' => ['description' => 'Indicates whether the version is an online version.', 'type' => 'boolean', 'example' => '12333', 'title' => ''], + 'clusterName' => ['description' => 'The name of the cluster.', 'type' => 'string', 'example' => 'vpc_sh_domain_1', 'title' => ''], + 'autoSwitch' => ['description' => 'Indicates whether automatic switchover is enabled.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'type' => ['description' => 'The type of the application. Valid values:'."\n" ."\n" - .'* true'."\n" - .'* false'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'name' => [ - 'description' => 'The alias of the test.'."\n", - 'type' => 'string', - 'example' => 'test1', - ], - 'updated' => [ - 'description' => 'The time when the test was last modified.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1588842080', - ], - 'id' => [ - 'description' => 'The test ID.'."\n", - 'type' => 'string', - 'example' => '12888', + .'- standard: a Standard Edition application.'."\n" + ."\n" + .'- advance: an Advanced Edition application of an old version. This edition is not supported for new applications.'."\n" + ."\n" + .'- enhanced: a new version of Advanced Edition.', 'type' => 'string', 'example' => 'enhanced', 'title' => ''], + 'description' => ['description' => 'The description.', 'type' => 'string', 'example' => '""', 'title' => ''], + 'status' => ['description' => 'The status of the version. Valid values:'."\n" + ."\n" + .'- ok: The version is normal.'."\n" + ."\n" + .'- stopped: The version is paused.'."\n" + ."\n" + .'- frozen: The version is frozen.'."\n" + ."\n" + .'- initializing: The version is being initialized.'."\n" + ."\n" + .'- unavailable: The version is invalid.'."\n" + ."\n" + .'- data\\_waiting: Data is pending initialization.'."\n" + ."\n" + .'- data\\_preparing: Data is being initialized.', 'type' => 'string', 'example' => 'normal', 'title' => ''], + 'schema' => [ + 'description' => 'The application schema.', + 'type' => 'object', + 'properties' => [ + 'tables' => ['description' => 'The table schema.', 'type' => 'object', 'title' => '', 'example' => ''], + 'indexes' => [ + 'description' => 'The index schema.', + 'type' => 'object', + 'properties' => [ + 'filterFields' => [ + 'description' => 'The attribute fields.', + 'type' => 'array', + 'items' => ['description' => 'The attribute field.', 'type' => 'string', 'example' => 'id', 'title' => ''], + 'title' => '', + 'example' => '', + ], + 'searchFields' => ['description' => 'The index fields.', 'type' => 'object', 'title' => '', 'example' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'routeField' => ['description' => 'The level-1 routing field.', 'type' => 'string', 'example' => 'field1', 'title' => ''], + 'routeFieldValues' => [ + 'description' => 'The hot data values of the level-1 routing field.', + 'type' => 'array', + 'items' => ['description' => 'The hot data value of the level-1 routing field.', 'type' => 'string', 'example' => 'routeFieldValues', 'title' => ''], + 'title' => '', + 'example' => '', + ], + 'secondRouteField' => ['description' => 'The level-2 routing field. This parameter takes effect only if the routeFieldValues parameter is configured. By default, the primary key of the wide table is used as the level-2 routing field.', 'type' => 'string', 'example' => 'field2'."\n", 'title' => ''], + 'ttlField' => [ + 'description' => 'The document time-to-live (TTL) settings.', + 'type' => 'object', + 'properties' => [ + 'name' => ['description' => 'The document TTL field.', 'type' => 'string', 'example' => 'text1'."\n", 'title' => ''], + 'ttl' => ['description' => 'The time to live (TTL). Unit: milliseconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '1000', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'indexSortConfig' => [ + 'description' => 'The index sorting settings.', + 'type' => 'array', + 'items' => [ + 'description' => 'The index sorting settings.', + 'type' => 'object', + 'properties' => [ + 'field' => ['description' => 'The sort field.', 'type' => 'string', 'example' => 'field1', 'title' => ''], + 'direction' => ['description' => 'The sort order. Valid values:'."\n" + ."\n" + .'- ASC'."\n" + ."\n" + .'- DESC', 'type' => 'string', 'example' => 'DESC', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + 'name' => ['description' => 'The name of the wide table.', 'type' => 'string', 'example' => 'test', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'progressPercent' => ['description' => 'The progress of data import in percentage. For example, a value of 83 indicates 83%.', 'type' => 'integer', 'format' => 'int32', 'example' => '100', 'title' => ''], + 'fetchFields' => [ + 'description' => 'The default display fields.', + 'type' => 'array', + 'items' => ['description' => 'The default display field.', 'type' => 'string', 'example' => '{}', 'title' => ''], + 'title' => '', + 'example' => '', + ], + 'quota' => [ + 'description' => 'The quota information.', + 'type' => 'object', + 'properties' => [ + 'spec' => ['description' => 'The specifications. Valid values:'."\n" + ."\n" + .'- opensearch.share.junior: Basic'."\n" + ."\n" + .'- opensearch.share.common: Shared general-purpose'."\n" + ."\n" + .'- opensearch.share.compute: Shared compute-optimized'."\n" + ."\n" + .'- opensearch.share.storage: Shared storage-optimized'."\n" + ."\n" + .'- opensearch.private.common: Dedicated general-purpose'."\n" + ."\n" + .'- opensearch.private.compute: Dedicated compute-optimized'."\n" + ."\n" + .'- opensearch.private.storage: Dedicated storage-optimized', 'type' => 'string', 'example' => 'opensearch.share.common', 'title' => ''], + 'qps' => ['description' => 'The number of queries per second (QPS). This parameter is used in an earlier billing model.', 'type' => 'integer', 'format' => 'int32', 'example' => '5', 'title' => ''], + 'docSize' => ['description' => 'The storage capacity. Unit: GB.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'computeResource' => ['description' => 'The computing resources. Unit: logical compute unit (LCU).', 'type' => 'integer', 'format' => 'int32', 'example' => '20', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'domain' => [ + 'description' => 'The industry. Valid values:'."\n" + ."\n" + .'- GENERAL'."\n" + ."\n" + .'- ECOMMERCE'."\n" + ."\n" + .'- IT\\_CONTENT', + 'type' => 'object', + 'properties' => [ + 'category' => ['description' => 'The edition of the application. Valid values: standard (Standard Edition), advance (the legacy Premium Edition, which is not available for new applications), and enhanced (the new Premium Edition).', 'type' => 'string', 'example' => '-', 'title' => ''], + 'name' => ['description' => 'The name in English.', 'type' => 'string', 'example' => 'test', 'title' => ''], + 'functions' => [ + 'description' => 'The search features.', + 'type' => 'object', + 'properties' => [ + 'service' => [ + 'description' => 'The service features.', + 'type' => 'array', + 'items' => ['description' => 'The service feature.', 'type' => 'string', 'example' => '-', 'title' => ''], + 'title' => '', + 'example' => '', + ], + 'qp' => [ + 'description' => 'The query processing features.', + 'type' => 'array', + 'items' => ['description' => 'Information about the query processor.', 'type' => 'string', 'example' => 'spellcheck', 'title' => ''], + 'title' => '', + 'example' => '', + ], + 'algo' => [ + 'description' => 'Structure 1', + 'type' => 'array', + 'items' => ['description' => 'Structure 1', 'type' => 'string', 'example' => 'pop', 'title' => ''], + 'title' => '', + 'example' => '', + ], + ], + 'title' => '', + 'example' => '', + ], + ], + 'title' => '', + 'example' => '', + ], + 'schemas' => [ + 'description' => 'The schema of a non-partitioned table.', + 'type' => 'array', + 'items' => [ + 'description' => 'The schema of a non-partitioned table.', + 'type' => 'object', + 'properties' => [ + 'tables' => ['description' => 'The table schema.', 'type' => 'object', 'title' => '', 'example' => ''], + 'indexes' => [ + 'description' => 'The index schema.', + 'type' => 'object', + 'properties' => [ + 'filterFields' => [ + 'description' => 'The attribute fields.', + 'type' => 'array', + 'items' => ['description' => 'The attribute field.', 'type' => 'string', 'example' => 'field1', 'title' => ''], + 'title' => '', + 'example' => '', + ], + 'searchFields' => ['description' => 'The index fields.', 'type' => 'object', 'title' => '', 'example' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'routeField' => ['description' => 'The level-1 routing field.', 'type' => 'string', 'example' => 'field1'."\n", 'title' => ''], + 'routeFieldValues' => [ + 'description' => 'The hot data values of the level-1 routing field.', + 'type' => 'array', + 'items' => ['description' => 'The hot data value of the level-1 routing field.', 'type' => 'string', 'example' => 'routeFieldValues', 'title' => ''], + 'title' => '', + 'example' => '', + ], + 'secondRouteField' => ['description' => 'The level-2 routing field. This parameter takes effect only if the routeFieldValues parameter is configured. By default, the primary key of the wide table is used as the level-2 routing field.', 'type' => 'string', 'example' => 'field2', 'title' => ''], + 'ttlField' => [ + 'description' => 'The document TTL settings.', + 'type' => 'object', + 'properties' => [ + 'name' => ['description' => 'The document TTL field.', 'type' => 'string', 'example' => 'fIeld1', 'title' => ''], + 'ttl' => ['description' => 'The time to live (TTL). Unit: milliseconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '1000', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'indexSortConfig' => [ + 'description' => 'The index sorting settings.', + 'type' => 'array', + 'items' => [ + 'description' => 'The index sorting settings.', + 'type' => 'object', + 'properties' => [ + 'field' => ['description' => 'The sort field.', 'type' => 'string', 'example' => 'fIeld1', 'title' => ''], + 'direction' => ['description' => 'The sort order. Valid values:'."\n" + ."\n" + .'- ASC'."\n" + ."\n" + .'- DESC', 'type' => 'string', 'example' => 'DESC', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + 'name' => ['description' => 'The name of the wide table.', 'type' => 'string', 'example' => 'main', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + 'firstRanks' => [ + 'description' => 'The coarse-grained sorting settings.', + 'type' => 'array', + 'items' => [ + 'description' => 'The coarse-grained sorting settings.', + 'type' => 'object', + 'properties' => [ + 'type' => ['description' => 'The expression type. Valid values: STRUCT: a structured expression. STRING (default): a custom formula.'."\n" + ."\n" + .'STRUCT: The content of the expression is a structure. STRING (default): You can configure a custom formula.', 'type' => 'string', 'example' => 'STRING', 'title' => ''], + 'name' => ['description' => 'The name of the coarse-grained sorting expression.', 'type' => 'string', 'example' => 'test', 'title' => ''], + 'description' => ['description' => 'The description.', 'type' => 'string', 'example' => 'Description', 'title' => ''], + 'active' => ['description' => 'Indicates whether this is the default expression.', 'type' => 'boolean', 'example' => 'False', 'title' => ''], + 'meta' => ['description' => 'The expression, which can be an array or a string.', 'type' => 'any', 'example' => 'String :"random()*100+now()"；'."\n" + .'Array: ['."\n" + .' {'."\n" + .' "attribute": "static_bm25()",'."\n" + .' "arg": "",'."\n" + .' "weight": 10'."\n" + .' }'."\n" + .' ]', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + 'secondRanks' => [ + 'description' => 'The fine-grained sorting settings.', + 'type' => 'array', + 'items' => [ + 'description' => 'The fine-grained sorting settings.', + 'type' => 'object', + 'properties' => [ + 'meta' => ['description' => 'The fine-grained sorting expression. You can define an expression that consists of fields, feature functions, and mathematical functions to implement complex sorting logic.', 'type' => 'any', 'example' => '"cate_id > 0 and cate_id < 1000"'."\n", 'title' => ''], + 'name' => ['description' => 'The name of the fine-grained sorting expression.', 'type' => 'string', 'example' => 'default'."\n", 'title' => ''], + 'description' => ['description' => 'The description.', 'type' => 'string', 'example' => '描述', 'title' => ''], + 'active' => ['description' => 'Indicates whether this is the default expression.', 'type' => 'boolean', 'example' => 'False', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + 'dataSources' => [ + 'description' => 'The data source settings.', + 'type' => 'array', + 'items' => [ + 'description' => 'The data source settings.', + 'type' => 'object', + 'properties' => [ + 'tableName' => ['description' => 'The name of the table in the application.', 'type' => 'string', 'example' => 'main', 'title' => ''], + 'type' => ['description' => 'The type of the data source. Valid values:'."\n" + ."\n" + .'- rds'."\n" + ."\n" + .'- odps'."\n" + ."\n" + .'- opensearch'."\n" + ."\n" + .'- polardb', 'type' => 'string', 'example' => 'rds', 'title' => ''], + 'fields' => [ + 'description' => 'The field mappings.', + 'type' => 'array', + 'items' => ['description' => 'The field mappings.', 'type' => 'object', 'title' => '', 'example' => ''], + 'title' => '', + 'example' => '', + ], + 'plugins' => ['description' => 'The data processing plug-ins for fields.'."\n" + ."\n" + .'Plug-in name (name)'."\n" + ."\n" + .'- JsonKeyValueExtractor'."\n" + ."\n" + .'- MultiValueSpliter'."\n" + ."\n" + .'- KeyValueExtractor'."\n" + ."\n" + .'- StringCatenateExtractor'."\n" + ."\n" + .'- HTMLTagRemover'."\n" + ."\n" + .'Plug-in parameters (parameters):'."\n" + ."\n" + .'- JsonKeyValueExtractor'."\n" + ."\n" + .'- MultiValueSpliter'."\n" + ."\n" + .'- KeyValueExtractor'."\n" + ."\n" + .'- StringCatenateExtractor'."\n" + ."\n" + .'- HTMLTagRemover', 'type' => 'object', 'title' => '', 'example' => ''], + 'keyField' => ['description' => 'The primary key.', 'type' => 'string', 'example' => 'id', 'title' => ''], + 'schemaName' => ['description' => 'The name of the wide table.', 'type' => 'string', 'example' => 'name', 'title' => ''], + 'parameters' => ['description' => 'The data source parameters.', 'type' => 'object', 'title' => '', 'example' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + 'summaries' => [ + 'description' => 'The search result summary settings.', + 'type' => 'array', + 'items' => [ + 'description' => 'The search result summary settings.', + 'type' => 'object', + 'properties' => [ + 'name' => ['description' => 'The name of the summary group.', 'type' => 'string', 'example' => 'fefault', 'title' => ''], + 'meta' => [ + 'description' => 'The summary settings.', + 'type' => 'array', + 'items' => [ + 'description' => 'The summary settings.', + 'type' => 'object', + 'properties' => [ + 'field' => ['description' => 'The field.', 'type' => 'string', 'example' => 'field1', 'title' => ''], + 'len' => ['description' => 'The length of the segment. Valid values: 1 to 300.', 'type' => 'integer', 'format' => 'int32', 'example' => '50', 'title' => ''], + 'element' => ['description' => 'The HTML tag for highlighting.', 'type' => 'string', 'example' => 'em', 'title' => ''], + 'ellipsis' => ['description' => 'The connector that is used to connect segments.', 'type' => 'string', 'example' => '...', 'title' => ''], + 'snippet' => ['description' => 'The number of segments. Valid values: 1 to 5.', 'type' => 'string', 'example' => '5', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + 'queryProcessors' => [ + 'description' => 'The query analysis settings.', + 'type' => 'array', + 'items' => [ + 'description' => 'The query analysis settings.', + 'type' => 'object', + 'properties' => [ + 'name' => ['description' => 'The name of the query analysis rule.', 'type' => 'string', 'example' => 'test', 'title' => ''], + 'domain' => ['description' => 'The industry. Valid values:'."\n" + ."\n" + .'- GENERAL'."\n" + ."\n" + .'- ECOMMERCE'."\n" + ."\n" + .'- IT\\_CONTENT', 'type' => 'string', 'example' => 'GENERAL', 'title' => ''], + 'category' => ['description' => 'The industry category.', 'type' => 'string', 'example' => '""', 'title' => ''], + 'processors' => [ + 'description' => 'The features.', + 'type' => 'array', + 'items' => ['description' => 'The feature.', 'type' => 'object', 'title' => '', 'example' => ''], + 'title' => '', + 'example' => '', + ], + 'indexes' => [ + 'description' => 'The indexes.', + 'type' => 'array', + 'items' => ['description' => 'The index.', 'type' => 'string', 'example' => 'default', 'title' => ''], + 'title' => '', + 'example' => '', + ], + 'active' => ['description' => 'Indicates whether this is the default rule.', 'type' => 'boolean', 'example' => 'False', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + 'cluster' => [ + 'description' => 'The cluster settings.', + 'type' => 'object', + 'properties' => [ + 'maxTimeoutMS' => ['description' => 'The timeout period for the cluster. Unit: ms.', 'type' => 'integer', 'format' => 'int32', 'example' => '750', 'title' => ''], + 'maxQueryClauseLength' => ['description' => 'The maximum length of the query clause.', 'type' => 'integer', 'format' => 'int32', 'example' => '1024', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'interpretations' => ['description' => 'The Large Language Model (LLM) settings for fields.', 'type' => 'object', 'title' => '', 'example' => ''], + 'prompts' => [ + 'description' => 'The prompt settings.', + 'type' => 'array', + 'items' => ['description' => 'The prompt settings.', 'type' => 'object', 'title' => '', 'example' => ''], + 'title' => '', + 'example' => '', + ], ], + 'example' => '{}', + 'title' => '', ], + 'title' => '', + 'example' => '', ], ], 'description' => '', + 'title' => '', + 'example' => '', ], ], '5XX' => [ 'schema' => [ 'type' => 'object', 'properties' => [ - 'code' => [ - 'type' => 'string', - ], - 'message' => [ - 'type' => 'string', - ], - 'requestId' => [ - 'type' => 'string', - ], - 'httpCode' => [ - 'type' => 'integer', - 'format' => 'int32', - ], - ], - ], - ], - ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"requestId\\": \\"D77D0DAF-790D-F5F5-A9C0-133738165014\\",\\n \\"result\\": {\\n \\"created\\": 1588842080,\\n \\"params\\": {},\\n \\"traffic\\": 30,\\n \\"online\\": true,\\n \\"name\\": \\"test1\\",\\n \\"updated\\": 1588842080,\\n \\"id\\": \\"12888\\"\\n }\\n}","errorExample":""},{"type":"xml","example":"D77D0DAF-790D-F5F5-A9C0-133738165014\\n\\n 12889\\n test333\\n \\n default\\n \\n 1589017860\\n 1589018211\\n true\\n 40\\n","errorExample":""}]', - 'title' => 'UpdateABTestExperiment', - 'requestParamsDescription' => '**Request body**'."\n" - ."\n" - .'|Parameter|Type|Required|Example|Description|'."\n" - .'|---|---|---|---|---|'."\n" - .'|name|String|No|"my\\_test"|The name of the test.|'."\n" - .'|traffic|Integer|No|30|The traffic that is routed to the test.|'."\n" - .'|online|Boolean|No|true|Specifies whether the test is in effect.|'."\n" - .'|params|Object|No|{"firstFormulaName": "default"}|The test configurations.|', - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', - ], - 'DeleteABTestExperiment' => [ - 'summary' => 'Deletes a test.', - 'path' => '/v4/openapi/app-groups/{appGroupIdentity}/scenes/{sceneId}/groups/{groupId}/experiments/{experimentId}', - 'methods' => [ - 'delete', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'security' => [ - [ - 'AK' => [], - ], - ], - 'operationType' => 'write', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'delete', - 'riskType' => 'none', - 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREopensearchE07IML', - ], - ], - 'parameters' => [ - [ - 'name' => 'appGroupIdentity', - 'in' => 'path', - 'schema' => [ - 'description' => 'The name of the application'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'my_app_group_name', - ], - ], - [ - 'name' => 'sceneId', - 'in' => 'path', - 'schema' => [ - 'description' => 'The scenario ID.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'docRequired' => true, - 'maximum' => '999999999', - 'minimum' => '-1', - 'example' => '20404', - ], - ], - [ - 'name' => 'groupId', - 'in' => 'path', - 'schema' => [ - 'description' => 'The ID of the test group.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'docRequired' => true, - 'maximum' => '999999999', - 'minimum' => '-1', - 'example' => '13467', - ], - ], - [ - 'name' => 'experimentId', - 'in' => 'path', - 'schema' => [ - 'description' => 'The test ID.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'docRequired' => true, - 'maximum' => '999999999', - 'minimum' => '-1', - 'example' => '12889', - ], - ], - ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'type' => 'object', - 'properties' => [ - 'result' => [ - 'description' => 'The returned data.'."\n", - 'type' => 'object', - 'example' => '{}', - ], - 'requestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => 'ABCDEFGH', - ], + 'code' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'message' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'requestId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'httpCode' => ['type' => 'integer', 'format' => 'int32', 'description' => '', 'title' => '', 'example' => ''], ], 'description' => '', - ], - ], - '5XX' => [ - 'schema' => [ - 'type' => 'object', - 'properties' => [ - 'code' => [ - 'type' => 'string', - ], - 'message' => [ - 'type' => 'string', - ], - 'requestId' => [ - 'type' => 'string', - ], - 'httpCode' => [ - 'type' => 'integer', - 'format' => 'int32', - ], - ], + 'title' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"result\\": {},\\n \\"requestId\\": \\"ABCDEFGH\\"\\n}","errorExample":""},{"type":"xml","example":"D77D0DAF-790D-F5F5-A9C0-133738165014","errorExample":""}]', - 'title' => 'DeleteABTestExperiment', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"77CAA411-0010-4DB9-82E2-1C384E590AFF\\",\\n \\"result\\": [\\n {\\n \\"id\\": \\"100302881\\",\\n \\"isCurrent\\": true,\\n \\"clusterName\\": \\"vpc_sh_domain_1\\",\\n \\"autoSwitch\\": true,\\n \\"type\\": \\"enhanced\\",\\n \\"description\\": \\"\\\\\\"\\\\\\"\\",\\n \\"status\\": \\"normal\\",\\n \\"schema\\": {\\n \\"tables\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n },\\n \\"indexes\\": {\\n \\"filterFields\\": [\\n \\"id\\"\\n ],\\n \\"searchFields\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n }\\n },\\n \\"routeField\\": \\"field1\\",\\n \\"routeFieldValues\\": [\\n \\"routeFieldValues\\"\\n ],\\n \\"secondRouteField\\": \\"field2\\\\n\\",\\n \\"ttlField\\": {\\n \\"name\\": \\"text1\\\\n\\",\\n \\"ttl\\": 1000\\n },\\n \\"indexSortConfig\\": [\\n {\\n \\"field\\": \\"field1\\",\\n \\"direction\\": \\"DESC\\"\\n }\\n ],\\n \\"name\\": \\"test\\"\\n },\\n \\"progressPercent\\": 100,\\n \\"fetchFields\\": [\\n \\"{}\\"\\n ],\\n \\"quota\\": {\\n \\"spec\\": \\"opensearch.share.common\\",\\n \\"qps\\": 5,\\n \\"docSize\\": 1,\\n \\"computeResource\\": 20\\n },\\n \\"domain\\": {\\n \\"category\\": \\"-\\",\\n \\"name\\": \\"test\\",\\n \\"functions\\": {\\n \\"service\\": [\\n \\"-\\"\\n ],\\n \\"qp\\": [\\n \\"spellcheck\\"\\n ],\\n \\"algo\\": [\\n \\"pop\\"\\n ]\\n }\\n },\\n \\"schemas\\": [\\n {\\n \\"tables\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n },\\n \\"indexes\\": {\\n \\"filterFields\\": [\\n \\"field1\\"\\n ],\\n \\"searchFields\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n }\\n },\\n \\"routeField\\": \\"field1\\\\n\\",\\n \\"routeFieldValues\\": [\\n \\"routeFieldValues\\"\\n ],\\n \\"secondRouteField\\": \\"field2\\",\\n \\"ttlField\\": {\\n \\"name\\": \\"fIeld1\\",\\n \\"ttl\\": 1000\\n },\\n \\"indexSortConfig\\": [\\n {\\n \\"field\\": \\"fIeld1\\",\\n \\"direction\\": \\"DESC\\"\\n }\\n ],\\n \\"name\\": \\"main\\"\\n }\\n ],\\n \\"firstRanks\\": [\\n {\\n \\"type\\": \\"STRING\\",\\n \\"name\\": \\"test\\",\\n \\"description\\": \\"Description\\",\\n \\"active\\": true,\\n \\"meta\\": \\"String :\\\\\\"random()*100+now()\\\\\\"；\\\\nArray: [\\\\n {\\\\n \\\\\\"attribute\\\\\\": \\\\\\"static_bm25()\\\\\\",\\\\n \\\\\\"arg\\\\\\": \\\\\\"\\\\\\",\\\\n \\\\\\"weight\\\\\\": 10\\\\n }\\\\n ]\\"\\n }\\n ],\\n \\"secondRanks\\": [\\n {\\n \\"meta\\": \\"\\\\\\"cate_id > 0 and cate_id < 1000\\\\\\"\\\\n\\",\\n \\"name\\": \\"default\\\\n\\",\\n \\"description\\": \\"描述\\",\\n \\"active\\": true\\n }\\n ],\\n \\"dataSources\\": [\\n {\\n \\"tableName\\": \\"main\\",\\n \\"type\\": \\"rds\\",\\n \\"fields\\": [\\n {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n }\\n ],\\n \\"plugins\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n },\\n \\"keyField\\": \\"id\\",\\n \\"schemaName\\": \\"name\\",\\n \\"parameters\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n }\\n }\\n ],\\n \\"summaries\\": [\\n {\\n \\"name\\": \\"fefault\\",\\n \\"meta\\": [\\n {\\n \\"field\\": \\"field1\\",\\n \\"len\\": 50,\\n \\"element\\": \\"em\\",\\n \\"ellipsis\\": \\"...\\",\\n \\"snippet\\": \\"5\\"\\n }\\n ]\\n }\\n ],\\n \\"queryProcessors\\": [\\n {\\n \\"name\\": \\"test\\",\\n \\"domain\\": \\"GENERAL\\",\\n \\"category\\": \\"\\\\\\"\\\\\\"\\",\\n \\"processors\\": [\\n {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n }\\n ],\\n \\"indexes\\": [\\n \\"default\\"\\n ],\\n \\"active\\": true\\n }\\n ],\\n \\"cluster\\": {\\n \\"maxTimeoutMS\\": 750,\\n \\"maxQueryClauseLength\\": 1024\\n },\\n \\"interpretations\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n },\\n \\"prompts\\": [\\n {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n }\\n ]\\n }\\n ]\\n}","type":"json"}]', + 'title' => 'DescribeApps', + 'description' => '- If a Standard Edition application with the same name exists, a new version is created.'."\n" + ."\n" + .'- When you create a new version, the autoSwitch and realtimeShared parameters are required.'."\n" + ."\n" + .'- When you create a new version, the quota is inherited from the previous version.'."\n" + ."\n" + .'- When you create a new version, modifications to the quota do not take effect.', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', - ], - 'ListABTestFixedFlowDividers' => [ - 'summary' => 'Queries whitelists.', - 'path' => '/v4/openapi/app-groups/{appGroupIdentity}/scenes/{sceneId}/groups/{groupId}/experiments/{experimentId}/fixed-flow-dividers', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'security' => [ - [ - 'AK' => [], - ], - ], - 'operationType' => 'read', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'none', - 'riskType' => 'none', - 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREopensearchE07IML', - ], + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], - 'parameters' => [ - [ - 'name' => 'appGroupIdentity', - 'in' => 'path', - 'schema' => [ - 'description' => 'The name of the application'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '“my_app_group_name”', - ], - ], - [ - 'name' => 'sceneId', - 'in' => 'path', - 'schema' => [ - 'description' => 'The scenario ID.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'docRequired' => true, - 'maximum' => '999999999', - 'minimum' => '-1', - 'example' => '12889', - ], - ], - [ - 'name' => 'groupId', - 'in' => 'path', - 'schema' => [ - 'description' => 'The group ID'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'docRequired' => true, - 'maximum' => '999999999', - 'minimum' => '-1', - 'example' => '13467', - ], - ], + 'ramActions' => [ [ - 'name' => 'experimentId', - 'in' => 'path', - 'schema' => [ - 'description' => 'The test ID.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'docRequired' => true, - 'maximum' => '999999999', - 'minimum' => '-1', - 'example' => '20404', - ], - ], - ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'type' => 'object', - 'properties' => [ - 'requestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => 'D77D0DAF-790D-F5F5-A9C0-133738165014', - ], - 'result' => [ - 'type' => 'array', - 'items' => [ - 'description' => 'The whitelist'."\n", - 'type' => 'string', - 'example' => '[ "D77D0DAF", "133738165014" ]', - ], - 'description' => '', - ], - ], - 'description' => '', - ], - ], - '5XX' => [ - 'schema' => [ - 'type' => 'object', - 'properties' => [ - 'code' => [ - 'type' => 'string', - ], - 'message' => [ - 'type' => 'string', - ], - 'requestId' => [ - 'type' => 'string', - ], - 'httpCode' => [ - 'type' => 'integer', - 'format' => 'int32', - ], + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'opensearch:ListApp', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'OpenSearch', 'resourceType' => 'App', 'arn' => 'acs:opensearch:{#regionId}:{#accountId}:app-groups/{#AppGroupId}'], ], ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"requestId\\": \\"D77D0DAF-790D-F5F5-A9C0-133738165014\\",\\n \\"result\\": [\\n \\"[ \\\\\\"D77D0DAF\\\\\\", \\\\\\"133738165014\\\\\\" ]\\"\\n ]\\n}","errorExample":""},{"type":"xml","example":"D77D0DAF-790D-F5F5-A9C0-133738165014\\nD77D0DAF\\n133738165014","errorExample":""}]', - 'title' => 'ListABTestFixedFlowDividers', - 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', + 'translator' => 'manual', ], - 'UpdateABTestFixedFlowDividers' => [ - 'summary' => 'Modifies whitelists.', - 'path' => '/v4/openapi/app-groups/{appGroupIdentity}/scenes/{sceneId}/groups/{groupId}/experiments/{experimentId}/fixed-flow-dividers', - 'methods' => [ - 'put', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'security' => [ - [ - 'AK' => [], - ], - ], - 'operationType' => 'write', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'update', - 'riskType' => 'none', - 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREopensearchE07IML', - ], - ], - 'parameters' => [ - [ - 'name' => 'appGroupIdentity', - 'in' => 'path', - 'schema' => [ - 'description' => 'The name of the application.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '“my_app_group_name”', - ], - ], - [ - 'name' => 'sceneId', - 'in' => 'path', - 'schema' => [ - 'description' => 'The scenario ID.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'docRequired' => true, - 'maximum' => '999999999', - 'minimum' => '-1', - 'example' => '20404', - ], - ], - [ - 'name' => 'groupId', - 'in' => 'path', - 'schema' => [ - 'description' => 'The ID of the test group.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'docRequired' => true, - 'maximum' => '999999999', - 'minimum' => '-1', - 'example' => '13467', - ], + 'DescribeDataCollction' => [ + 'path' => '/v4/openapi/app-groups/{appGroupIdentity}/data-collections/{dataCollectionIdentity}', + 'methods' => ['get'], + 'schemes' => ['http', 'https'], + 'security' => [ + [ + 'AK' => [], ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'abilityTreeCode' => '55174', + 'abilityTreeNodes' => ['FEATUREopensearch4M1CGO'], + ], + 'parameters' => [ [ - 'name' => 'experimentId', + 'name' => 'appGroupIdentity', 'in' => 'path', - 'schema' => [ - 'description' => 'The test ID.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'docRequired' => true, - 'maximum' => '999999999', - 'minimum' => '-1', - 'example' => '12889', - ], + 'schema' => ['description' => 'The name of the application.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'title' => '', 'example' => 'my_app_group_name'], ], [ - 'name' => 'body', - 'in' => 'body', - 'style' => 'json', - 'schema' => [ - 'description' => 'The request body.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The whitelist that you want to update'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '"D77D0DAF" ', - ], - 'required' => false, - 'maxItems' => 100, - ], + 'name' => 'dataCollectionIdentity', + 'in' => 'path', + 'schema' => ['description' => 'The ID of the data collection.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'title' => '', 'example' => '286'], ], ], 'responses' => [ @@ -8754,65 +6646,100 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'requestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => 'D77D0DAF-790D-F5F5-A9C0-133738165014', - ], + 'requestId' => ['description' => 'The request ID.', 'type' => 'string', 'title' => '', 'example' => '72FAD77B-83F9-F393-BA8E-5834E2427BF8'], 'result' => [ - 'description' => 'The returned results.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The whitelist.'."\n", - 'type' => 'string', - 'example' => '[ "D77D0DAF", "133738165014" ]', + 'description' => 'The data collection information.', + 'type' => 'object', + 'properties' => [ + 'created' => ['description' => 'The time when the data collection was created.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '1581065837'], + 'dataCollectionType' => ['description' => 'The type of the data collection.'."\n" + ."\n" + .'- behavior: User behavior data.'."\n" + ."\n" + .'- item\\_info: Item information.'."\n" + ."\n" + .'- industry\\_specific: Industry-specific attributes.', 'type' => 'string', 'title' => '', 'example' => 'BEHAVIOR'], + 'type' => ['description' => 'The type of the data collection client.'."\n" + ."\n" + .'- server'."\n" + ."\n" + .'- web'."\n" + ."\n" + .'- app'."\n" + .' Only server is supported.', 'type' => 'string', 'title' => '', 'example' => 'server'], + 'industryName' => ['description' => 'The name of the industry.'."\n" + ."\n" + .'- general: General'."\n" + ."\n" + .'- ecommerce: E-commerce', 'type' => 'string', 'title' => '', 'example' => 'GENERAL'], + 'status' => ['description' => 'The status.'."\n" + ."\n" + .'- 0: The data collection is not enabled.'."\n" + ."\n" + .'- 1: The data collection is being enabled.'."\n" + ."\n" + .'- 2: The data collection is enabled.'."\n" + ."\n" + .'- 3: The data collection failed to be enabled.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '2'], + 'updated' => ['description' => 'The time when the data collection was last updated.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '1581065904'], + 'name' => ['description' => 'The name of the data collection.', 'type' => 'string', 'title' => '', 'example' => 'os_function_test_v1'], + 'sundialId' => ['description' => 'The ID of the sundial.', 'type' => 'string', 'title' => '', 'example' => '1755'], + 'id' => ['description' => 'The ID of the data collection.', 'type' => 'string', 'title' => '', 'example' => '286'], ], + 'title' => '', + 'example' => '', ], ], 'description' => '', + 'title' => '', + 'example' => '', ], ], '5XX' => [ 'schema' => [ 'type' => 'object', 'properties' => [ - 'code' => [ - 'type' => 'string', - ], - 'message' => [ - 'type' => 'string', - ], - 'requestId' => [ - 'type' => 'string', - ], - 'httpCode' => [ - 'type' => 'integer', - 'format' => 'int32', - ], + 'code' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'httpCode' => ['type' => 'integer', 'format' => 'int32', 'description' => '', 'title' => '', 'example' => ''], + 'requestId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'message' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"requestId\\": \\"D77D0DAF-790D-F5F5-A9C0-133738165014\\",\\n \\"result\\": [\\n \\"[ \\\\\\"D77D0DAF\\\\\\", \\\\\\"133738165014\\\\\\" ]\\"\\n ]\\n}","errorExample":""},{"type":"xml","example":"D77D0DAF-790D-F5F5-A9C0-133738165014\\nD77D0DAF\\n133738165014","errorExample":""}]', - 'title' => 'UpdateABTestFixedFlowDividers', - 'requestParamsDescription' => '**Request body**'."\n" - ."\n" - .'|Parameter|Type|Required|Example|Description|'."\n" - .'|---|---|---|---|---|'."\n" - .'|\\[\\]|String|Yes|"D77D0DAF"|The whitelist that you want to update.|', + 'title' => 'DescribeDataCollction', + 'summary' => 'Retrieves the details of a data collection for a specified application.', + 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', - ], - 'ListFirstRanks' => [ - 'summary' => 'Queries the rough sort expressions that are configured for a version of an OpenSearch application.', - 'path' => '/v4/openapi/app-groups/{appGroupIdentity}/apps/{appId}/first-ranks', - 'methods' => [ - 'get', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'opensearch:DescribeDataCollection', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'OpenSearch', 'resourceType' => 'DataCollection', 'arn' => 'acs:opensearch:{#regionId}:{#accountId}:apps/{#AppGroupId}'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"72FAD77B-83F9-F393-BA8E-5834E2427BF8\\",\\n \\"result\\": {\\n \\"created\\": 1581065837,\\n \\"dataCollectionType\\": \\"BEHAVIOR\\",\\n \\"type\\": \\"server\\",\\n \\"industryName\\": \\"GENERAL\\",\\n \\"status\\": 2,\\n \\"updated\\": 1581065904,\\n \\"name\\": \\"os_function_test_v1\\",\\n \\"sundialId\\": \\"1755\\",\\n \\"id\\": \\"286\\"\\n }\\n}","type":"json"}]', + 'translator' => 'manual', + ], + 'DescribeFirstRank' => [ + 'summary' => 'Queries the rough sort expression configured for an OpenSearch application version.', + 'path' => '/v4/openapi/app-groups/{appGroupIdentity}/apps/{appId}/first-ranks/{name}', + 'methods' => ['get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -8821,219 +6748,129 @@ 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'list', + 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREopensearchN8M8WS', - 'FEATUREopensearchH8SRT8', - ], + 'abilityTreeNodes' => ['FEATUREopensearchN8M8WS', 'FEATUREopensearchH8SRT8'], ], 'parameters' => [ [ 'name' => 'appGroupIdentity', 'in' => 'path', - 'schema' => [ - 'description' => 'The name of the application.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'my_app_group_name', - ], + 'schema' => ['description' => 'The name of the application.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'title' => '', 'example' => 'my_app_group_name'], ], [ 'name' => 'appId', 'in' => 'path', - 'schema' => [ - 'description' => 'The version number of the application.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'docRequired' => true, - 'example' => '110157886', - ], + 'schema' => ['description' => 'The version number of the application.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true, 'title' => '', 'example' => '110157886'], + ], + [ + 'name' => 'name', + 'in' => 'path', + 'schema' => ['description' => 'The name of the rough sort expression.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'title' => '', 'example' => 'test'], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'description' => 'The rsponse body.'."\n", 'type' => 'object', 'properties' => [ - 'requestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '0A6EB64B-B4C8-CF02-810F-E660812972FF', - ], + 'requestId' => ['description' => 'The request ID.', 'type' => 'string', 'title' => '', 'example' => '0A6EB64B-B4C8-CF02-810F-E660812972FF'], 'result' => [ - 'description' => 'The information about the rough sort expression.'."\n" - ."\n" - .'For more information, see [FirstRank](~~170007~~).'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The result body.'."\n", - 'type' => 'object', - 'properties' => [ - 'created' => [ - 'description' => 'The time when the expression was created.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '0', - ], - 'active' => [ - 'description' => 'Specifies whether to set the fine sort expression as the default sort expression.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'description' => [ - 'description' => 'Description'."\n", - 'type' => 'string', - 'example' => '""', - ], - 'updated' => [ - 'description' => 'The time when the expression was updated.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '0', - ], - 'name' => [ - 'description' => 'The name.'."\n", - 'type' => 'string', - 'example' => 'default', - ], - 'meta' => [ - 'description' => 'The information about the expression.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The message body'."\n", - 'type' => 'object', - 'properties' => [ - 'arg' => [ - 'description' => 'The parameters that are used by a function in the expression.'."\n" - ."\n" - .'For more information, see [Rough sort functions](~~180765~~).'."\n", - 'type' => 'string', - 'example' => '""', - ], - 'attribute' => [ - 'description' => 'The attribute, feature function, or field to be searched for.'."\n" - ."\n" - .'For more information about supported feature functions, see [Rough sort functions](~~180765~~).'."\n", - 'type' => 'string', - 'example' => 'static_bm25()', - ], - 'weight' => [ - 'description' => 'The weight. Valid values: -100000 to 100000. The value cannot be 0.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - ], - 'example' => '[]', + 'description' => 'The information about the rough sort expression.', + 'type' => 'object', + 'properties' => [ + 'description' => ['description' => 'The description of the expression.', 'type' => 'string', 'title' => '', 'example' => '-'], + 'active' => ['description' => 'Indicates whether the expression is the default one.', 'type' => 'boolean', 'title' => '', 'example' => 'false'], + 'name' => ['description' => 'The name of the expression.', 'type' => 'string', 'title' => '', 'example' => 'ar_wear_edit_time'], + 'meta' => [ + 'description' => 'The information about the expression.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'arg' => ['description' => 'The parameters that are used by a function in the expression.', 'type' => 'string', 'title' => '', 'example' => 'ar_edit_time'], + 'attribute' => ['description' => 'The attribute, scoring feature, or search field.', 'type' => 'string', 'title' => '', 'example' => 'timeliness_ms()'], + 'weight' => ['description' => 'The weight. Valid values: -100000 to 100000. The value cannot be 0.', 'type' => 'number', 'format' => 'float', 'title' => '', 'example' => '1'], ], - 'example' => '[]', + 'description' => '', + 'title' => '', + 'example' => '', ], + 'title' => '', + 'example' => '', ], - 'example' => '{}', ], - 'example' => '[]', + 'title' => '', + 'example' => '', ], ], - 'example' => '{}', + 'description' => '', + 'title' => '', + 'example' => '', ], ], '5XX' => [ 'schema' => [ 'type' => 'object', 'properties' => [ - 'code' => [ - 'type' => 'string', - ], - 'requestId' => [ - 'type' => 'string', - ], - 'message' => [ - 'type' => 'string', - ], - 'httpCode' => [ - 'type' => 'integer', - 'format' => 'int32', - ], + 'code' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'requestId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'message' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"requestId\\": \\"0A6EB64B-B4C8-CF02-810F-E660812972FF\\",\\n \\"result\\": [\\n {\\n \\"created\\": 0,\\n \\"active\\": true,\\n \\"description\\": \\"\\\\\\"\\\\\\"\\",\\n \\"updated\\": 0,\\n \\"name\\": \\"default\\",\\n \\"meta\\": [\\n {\\n \\"arg\\": \\"\\\\\\"\\\\\\"\\",\\n \\"attribute\\": \\"static_bm25()\\",\\n \\"weight\\": 1\\n }\\n ]\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"0A6EB64B-B4C8-CF02-810F-E660812972FF\\n\\n default\\n \\n true\\n STRUCT\\n \\n static_bm25()\\n \\n 1\\n \\n 0\\n 0\\n","errorExample":""}]', - 'title' => 'ListFirstRanks', - ], - 'CreateFirstRank' => [ - 'summary' => 'Creates a rough sort expression for a version of an OpenSearch application. If you set dryRun to true, this operation checks the specified rough sort expression. By default, the value of dryRun is false if you do not set this parameter.', - 'path' => '/v4/openapi/app-groups/{appGroupIdentity}/apps/{appId}/first-ranks', - 'methods' => [ - 'post', + 'title' => 'DescribeFirstRank', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'opensearch:DescribeFirstRank', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'OpenSearch', 'resourceType' => 'FirstRank', 'arn' => 'acs:opensearch:{#regionId}:{#accountId}:apps/{#AppGroupId}'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"0A6EB64B-B4C8-CF02-810F-E660812972FF\\",\\n \\"result\\": {\\n \\"description\\": \\"-\\",\\n \\"active\\": false,\\n \\"name\\": \\"ar_wear_edit_time\\",\\n \\"meta\\": [\\n {\\n \\"arg\\": \\"ar_edit_time\\",\\n \\"attribute\\": \\"timeliness_ms()\\",\\n \\"weight\\": 1\\n }\\n ]\\n }\\n}","type":"json"}]', + 'translator' => 'manual', + ], + 'DescribeInterventionDictionary' => [ + 'summary' => 'Retrieves the details of an intervention dictionary.', + 'path' => '/v4/openapi/intervention-dictionaries/{name}', + 'methods' => ['get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'write', + 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'create', + 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREopensearchN8M8WS', - 'FEATUREopensearchH8SRT8', - ], + 'abilityTreeNodes' => ['FEATUREopensearchNCXKUT', 'FEATUREopensearchUIICM8'], ], 'parameters' => [ [ - 'name' => 'dryRun', - 'in' => 'query', - 'schema' => [ - 'description' => 'Specifies whether to perform a dry run.'."\n", - 'type' => 'boolean', - 'required' => false, - 'example' => 'true', - ], - ], - [ - 'name' => 'appGroupIdentity', - 'in' => 'path', - 'schema' => [ - 'description' => 'The name of the application'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'my_app_group_name', - ], - ], - [ - 'name' => 'appId', + 'name' => 'name', 'in' => 'path', - 'schema' => [ - 'description' => 'The version number of the application.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'docRequired' => true, - 'example' => '110157886', - ], - ], - [ - 'name' => 'body', - 'in' => 'body', - 'schema' => [ - 'description' => 'The request body that contains the parameters of the rough sort expression.'."\n", - 'required' => false, - '$ref' => '#/components/schemas/FirstRank', - ], + 'schema' => ['description' => 'The name of the intervention dictionary.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'title' => '', 'example' => 'my_dict'], ], ], 'responses' => [ @@ -9041,97 +6878,77 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'requestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '0A6EB64B-B4C8-CF02-810F-E660812972FF', - ], + 'requestId' => ['description' => 'The request ID.', 'type' => 'string', 'title' => '', 'example' => 'D7CCF454-472A-030E-F254-604520B028AA'], 'result' => [ - 'description' => 'The information about the rough sort expression.'."\n", + 'description' => 'The details of the intervention dictionary.', 'type' => 'object', 'properties' => [ - 'active' => [ - 'description' => 'Indicates whether the expression is the default one.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'name' => [ - 'description' => 'The name of the expression.'."\n", - 'type' => 'string', - 'example' => 'default', - ], - 'meta' => [ - 'description' => 'The content of the expression.'."\n", - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'arg' => [ - 'description' => 'The parameters that are used by a function in the expression.'."\n", - 'type' => 'string', - 'example' => '1', - ], - 'attribute' => [ - 'description' => 'The attribute, feature functions, or field to be searched for.'."\n", - 'type' => 'string', - 'example' => 'static_bm25()', - ], - 'weight' => [ - 'description' => 'The weight. Valid values: \\[-100000,100000]. The value cannot be 0.'."\n", - 'type' => 'number', - 'format' => 'float', - 'example' => '10', - ], - ], - ], - ], + 'created' => ['description' => 'The time when the intervention dictionary was created.', 'type' => 'string', 'title' => '', 'example' => '1536233287'], + 'analyzer' => ['description' => 'The custom analyzer.', 'type' => 'string', 'title' => '', 'example' => '-'], + 'updated' => ['description' => 'The time when the intervention dictionary was updated.', 'type' => 'string', 'title' => '', 'example' => '1536233287'], + 'type' => ['description' => 'The type of the intervention dictionary.'."\n" + ."\n" + .'- stopword: an intervention dictionary for stop word filtering.'."\n" + ."\n" + .'- synonym: an intervention dictionary for synonym configuration.'."\n" + ."\n" + .'- correction: an intervention dictionary for spelling correction.'."\n" + ."\n" + .'- category\\_prediction: an intervention dictionary for category prediction.'."\n" + ."\n" + .'- ner: an intervention dictionary for Named Entity Recognition (NER).'."\n" + ."\n" + .'- term\\_weighting: an intervention dictionary for term weight analysis.', 'type' => 'string', 'title' => '', 'example' => 'category_prediction'], + 'name' => ['description' => 'The name of the intervention dictionary.', 'type' => 'string', 'title' => '', 'example' => 'test'], ], + 'title' => '', + 'example' => '', ], ], 'description' => '', + 'title' => '', + 'example' => '', ], ], '5XX' => [ 'schema' => [ 'type' => 'object', 'properties' => [ - 'code' => [ - 'type' => 'string', - ], - 'requestId' => [ - 'type' => 'string', - ], - 'message' => [ - 'type' => 'string', - ], + 'code' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'requestId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'message' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"requestId\\": \\"0A6EB64B-B4C8-CF02-810F-E660812972FF\\",\\n \\"result\\": {\\n \\"active\\": true,\\n \\"name\\": \\"default\\",\\n \\"meta\\": [\\n {\\n \\"arg\\": \\"1\\",\\n \\"attribute\\": \\"static_bm25()\\",\\n \\"weight\\": 10\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"0A6EB64B-B4C8-CF02-810F-E660812972FF\\n\\n general_default\\n \\n false\\n STRUCT\\n \\n static_bm25()\\n \\n 2\\n \\n \\n hot_score\\n \\n 0.000001\\n \\n 0\\n 0\\n","errorExample":""}]', - 'title' => 'CreateFirstRank', - 'requestParamsDescription' => '**Request body**'."\n" - ."\n" - .'|Parameter|Type|Required|Example|Description|'."\n" - .'|---|---|---|---|---|'."\n" - .'|name|String|Yes|"test"|The name of the expression.|'."\n" - .'|type|String|Yes|"STRUCT"|The type of the expression. Valid values:STRUCT: The content of the expression is a structure. This is the default value.STRING: The content of the expression is a custom formula.|'."\n" - .'|meta|Array or String|Yes||The content of the expression.|'."\n" - .'|description|String|No|"my\\_test"|The description of the expression.|'."\n" - .'|active|Boolean|No|true|Specifies whether the expression is the default one.|', - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', - ], - 'DescribeFirstRank' => [ - 'summary' => 'Queries a rough sort expression that is configured for an OpenSearch application version.', - 'path' => '/v4/openapi/app-groups/{appGroupIdentity}/apps/{appId}/first-ranks/{name}', - 'methods' => [ - 'get', + 'title' => 'DescribeInterventionDictionary', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'opensearch:DescribeInterventionDictionary', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'OpenSearch', 'resourceType' => 'InterventionDictionary', 'arn' => 'acs:opensearch:{#regionId}:{#accountId}:intervention-dictionaries/{#InterventionDictionaryId}'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"D7CCF454-472A-030E-F254-604520B028AA\\",\\n \\"result\\": {\\n \\"created\\": \\"1536233287\\",\\n \\"analyzer\\": \\"-\\",\\n \\"updated\\": \\"1536233287\\",\\n \\"type\\": \\"category_prediction\\",\\n \\"name\\": \\"test\\"\\n }\\n}","type":"json"}]', + 'translator' => 'manual', + ], + 'DescribeQueryProcessor' => [ + 'path' => '/v4/openapi/app-groups/{appGroupIdentity}/apps/{appId}/query-processors/{name}', + 'methods' => ['get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -9139,49 +6956,22 @@ ], 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - 'riskType' => 'none', - 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREopensearchN8M8WS', - 'FEATUREopensearchH8SRT8', - ], - ], + 'systemTags' => [], 'parameters' => [ [ 'name' => 'appGroupIdentity', 'in' => 'path', - 'schema' => [ - 'description' => 'The name of the application.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'my_app_group_name', - ], + 'schema' => ['description' => 'The name of the application.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'title' => '', 'example' => 'my_app_group_name'], ], [ 'name' => 'appId', 'in' => 'path', - 'schema' => [ - 'description' => 'The version number.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'docRequired' => true, - 'example' => '110157886', - ], + 'schema' => ['description' => 'The version number of the application.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true, 'title' => '', 'example' => '110157886'], ], [ 'name' => 'name', 'in' => 'path', - 'schema' => [ - 'description' => 'The name of the rough sort expression'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'test', - ], + 'schema' => ['description' => 'The name of the rule.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'title' => '', 'example' => 'test'], ], ], 'responses' => [ @@ -9189,313 +6979,186 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'requestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '0A6EB64B-B4C8-CF02-810F-E660812972FF', - ], + 'requestId' => ['description' => 'The ID of the request.', 'type' => 'string', 'title' => '', 'example' => '0A6EB64B-B4C8-CF02-810F-E660812972FF'], 'result' => [ - 'description' => 'The information about the rough sort expression.'."\n", + 'description' => 'The information about the query analysis rule.', 'type' => 'object', 'properties' => [ - 'description' => [ - 'description' => 'Description'."\n", - 'type' => 'string', - 'example' => '-', - ], - 'active' => [ - 'description' => 'Indicates whether the expression is the default one.'."\n", - 'type' => 'boolean', - 'example' => 'false', - ], - 'name' => [ - 'description' => 'Parameter'."\n", - 'type' => 'string', - 'example' => 'ar_wear_edit_time', + 'created' => ['description' => 'The time when the rule was created.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '1587398402'], + 'active' => ['description' => 'Indicates whether the rule is the default rule.', 'type' => 'boolean', 'title' => '', 'example' => 'true'], + 'updated' => ['description' => 'The time when the rule was last updated.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '1587398402'], + 'name' => ['description' => 'The name of the rule.', 'type' => 'string', 'title' => '', 'example' => 'test'], + 'domain' => ['description' => 'The industry type.'."\n" + ."\n" + .'- GENERAL: General'."\n" + ."\n" + .'- ECOMMERCE: E-commerce'."\n" + ."\n" + .'- IT\\_CONTENT: IT content', 'type' => 'string', 'title' => '', 'example' => 'GENERAL'], + 'indexes' => [ + 'type' => 'array', + 'items' => ['description' => 'The index of the application.', 'type' => 'string', 'title' => '', 'example' => 'default'], + 'description' => 'The indexes to which the query analysis rule applies.'."\n", + 'title' => '', + 'example' => '', ], - 'meta' => [ - 'description' => 'The information about the expression.'."\n", + 'processors' => [ 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'arg' => [ - 'description' => 'The parameters that are used by a function in the expression.'."\n", - 'type' => 'string', - 'example' => 'ar_edit_time', - ], - 'attribute' => [ - 'description' => 'The attribute, feature function, or field to be searched for.'."\n", - 'type' => 'string', - 'example' => 'timeliness_ms()', - ], - 'weight' => [ - 'description' => 'The weight. Valid values: -100000 to 100000. The value cannot be 0.'."\n", - 'type' => 'number', - 'format' => 'float', - 'example' => '1', - ], - ], - 'description' => '', - ], + 'items' => ['description' => 'The features included in the processor.', 'type' => 'object', 'title' => '', 'example' => '{}'], + 'description' => 'The features that are used in the query analysis rule.'."\n", + 'title' => '', + 'example' => '', ], ], + 'title' => '', + 'example' => '', ], ], 'description' => '', + 'title' => '', + 'example' => '', ], ], '5XX' => [ 'schema' => [ 'type' => 'object', 'properties' => [ - 'code' => [ - 'type' => 'string', - ], - 'requestId' => [ - 'type' => 'string', - ], - 'message' => [ - 'type' => 'string', - ], + 'code' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'message' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'requestId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'httpCode' => ['type' => 'integer', 'format' => 'int32', 'description' => '', 'title' => '', 'example' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"requestId\\": \\"0A6EB64B-B4C8-CF02-810F-E660812972FF\\",\\n \\"result\\": {\\n \\"description\\": \\"-\\",\\n \\"active\\": false,\\n \\"name\\": \\"ar_wear_edit_time\\",\\n \\"meta\\": [\\n {\\n \\"arg\\": \\"ar_edit_time\\",\\n \\"attribute\\": \\"timeliness_ms()\\",\\n \\"weight\\": 1\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"0A6EB64B-B4C8-CF02-810F-E660812972FF\\n\\n ar_wear_edit_time\\n STRUCT\\n \\n timeliness_ms()\\n ar_edit_time\\n 1\\n \\n \\n false\\n 0\\n 0\\n","errorExample":""}]', - 'title' => 'DescribeFirstRank', + 'title' => 'DescribeQueryProcessor', + 'summary' => 'Describes a query analysis rule for a version of an OpenSearch application.', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', - ], - 'RemoveFirstRank' => [ - 'summary' => 'Deletes a rough sort expression for a version of an OpenSearch application.', - 'path' => '/v4/openapi/app-groups/{appGroupIdentity}/apps/{appId}/first-ranks/{name}', - 'methods' => [ - 'delete', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => '', + 'ramAction' => [ + 'action' => 'opensearch:DescribeQueryProcessor', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'OpenSearch', 'resourceType' => 'QueryProcessor', 'arn' => 'acs:opensearch:{#regionId}:{#accountId}:apps/{#AppGroupId}'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"0A6EB64B-B4C8-CF02-810F-E660812972FF\\",\\n \\"result\\": {\\n \\"created\\": 1587398402,\\n \\"active\\": true,\\n \\"updated\\": 1587398402,\\n \\"name\\": \\"test\\",\\n \\"domain\\": \\"GENERAL\\",\\n \\"indexes\\": [\\n \\"default\\"\\n ],\\n \\"processors\\": [\\n {}\\n ]\\n }\\n}","type":"json"}]', + 'translator' => 'manual', + ], + 'DescribeRegions' => [ + 'path' => '/v4/openapi/regions', + 'methods' => ['get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'readAndWrite', + 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'delete', - 'riskType' => 'none', - 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREopensearchN8M8WS', - 'FEATUREopensearchH8SRT8', - ], - ], - 'parameters' => [ - [ - 'name' => 'appGroupIdentity', - 'in' => 'path', - 'schema' => [ - 'description' => 'The name of the application'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '“my_app_group_name”', - ], - ], - [ - 'name' => 'appId', - 'in' => 'path', - 'schema' => [ - 'description' => 'The version number of the application.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'docRequired' => true, - 'example' => '110157886', - ], - ], - [ - 'name' => 'name', - 'in' => 'path', - 'schema' => [ - 'description' => 'The name of the rough sort expression.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '“test”', - ], - ], + 'operationType' => 'get', + 'abilityTreeCode' => '55180', + 'abilityTreeNodes' => ['FEATUREopensearch447AAX'], ], + 'parameters' => [], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ - 'requestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => 'E676FAB6-A0AC-64D9-F9D7-D0D33C930CFF', - ], + 'requestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '3B7E42BD-1D63-2F6B-C8E0-41BACEA76EEB', 'title' => ''], 'result' => [ - 'description' => 'The information about the rough sort expression.'."\n", - 'type' => 'object', - 'properties' => [ - 'description' => [ - 'description' => 'Description'."\n", - 'type' => 'string', - 'example' => '""', - ], - 'active' => [ - 'description' => 'Specifies whether to set the fine sort expression as the default sort expression.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'name' => [ - 'description' => 'Parameter'."\n", - 'type' => 'string', - 'example' => 'default', - ], - 'meta' => [ - 'description' => 'The information about the expression.'."\n", - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'arg' => [ - 'description' => 'The parameters that are used by a function in the expression. For more information, see Rough sort functions.[](~~170007~~)'."\n", - 'type' => 'string', - 'example' => '""', - ], - 'attribute' => [ - 'description' => 'The attribute, which refers to the scoring feature or search field, For more information about supported feature functions, see Rough sort functions.[](~~170007~~)'."\n", - 'type' => 'string', - 'example' => 'static_bm25()', - ], - 'weight' => [ - 'description' => 'The weight. Valid values: -100000 to 100000. The value cannot be 0.'."\n", - 'type' => 'number', - 'format' => 'float', - 'example' => '10', - ], - ], - 'description' => '', - ], + 'description' => 'The result.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'endpoint' => ['description' => 'The endpoint.', 'type' => 'string', 'example' => 'opensearch.cn-hangzhou.aliyuncs.com', 'title' => ''], + 'regionId' => ['description' => 'The region ID.', 'type' => 'string', 'example' => 'cn-hangzhou', 'title' => ''], + 'localName' => ['description' => 'The region name.', 'type' => 'string', 'example' => '华东1（杭州）', 'title' => ''], + 'consoleUrl' => ['description' => 'The console URL.', 'type' => 'string', 'example' => 'https://opensearch-cn-hangzhou.console.aliyun.com', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], + 'title' => '', + 'example' => '', ], ], 'description' => '', + 'title' => '', + 'example' => '', ], ], '5XX' => [ 'schema' => [ 'type' => 'object', 'properties' => [ - 'code' => [ - 'type' => 'string', - ], - 'requestId' => [ - 'type' => 'string', - ], - 'message' => [ - 'type' => 'string', - ], - 'httpCode' => [ - 'type' => 'integer', - 'format' => 'int32', - ], + 'code' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'message' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'requestId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'httpCode' => ['type' => 'integer', 'format' => 'int32', 'description' => '', 'title' => '', 'example' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"requestId\\": \\"E676FAB6-A0AC-64D9-F9D7-D0D33C930CFF\\",\\n \\"result\\": {\\n \\"description\\": \\"\\\\\\"\\\\\\"\\",\\n \\"active\\": true,\\n \\"name\\": \\"default\\",\\n \\"meta\\": [\\n {\\n \\"arg\\": \\"\\\\\\"\\\\\\"\\",\\n \\"attribute\\": \\"static_bm25()\\",\\n \\"weight\\": 10\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"E676FAB6-A0AC-64D9-F9D7-D0D33C930CFF\\n\\n test2\\n \\n false\\n STRUCT\\n \\n timeliness()\\n hid\\n 1\\n \\n 1587708467\\n 1587708467\\n","errorExample":""}]', - 'title' => 'RemoveFirstRank', - 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', + 'title' => 'DescribeRegions', + 'summary' => 'Retrieves the endpoints for all regions.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"3B7E42BD-1D63-2F6B-C8E0-41BACEA76EEB\\",\\n \\"result\\": [\\n {\\n \\"endpoint\\": \\"opensearch.cn-hangzhou.aliyuncs.com\\",\\n \\"regionId\\": \\"cn-hangzhou\\",\\n \\"localName\\": \\"华东1（杭州）\\",\\n \\"consoleUrl\\": \\"https://opensearch-cn-hangzhou.console.aliyun.com\\"\\n }\\n ]\\n}","type":"json"}]', + 'translator' => 'manual', ], - 'ModifyFirstRank' => [ - 'summary' => 'Modifies a rough sort expression for an OpenSearch application. If you set dryRun to true, this operation checks the rough sort expression after the expression is modified. If you do not specify this parameter, false is used by default.', - 'path' => '/v4/openapi/app-groups/{appGroupIdentity}/apps/{appId}/first-ranks/{name}', - 'methods' => [ - 'put', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'DescribeScheduledTask' => [ + 'summary' => 'Query a scheduled task for an OpenSearch application.', + 'path' => '/v4/openapi/app-groups/{appGroupIdentity}/scheduled-tasks/{taskId}', + 'methods' => ['get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'write', + 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'update', + 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREopensearchN8M8WS', - 'FEATUREopensearchH8SRT8', - ], + 'abilityTreeNodes' => ['FEATUREopensearch447AAX', 'FEATUREopensearch5OZOSP'], ], 'parameters' => [ - [ - 'name' => 'dryRun', - 'in' => 'query', - 'schema' => [ - 'description' => 'Specifies whether the request is a dry run.'."\n", - 'type' => 'boolean', - 'required' => false, - 'example' => 'true', - ], - ], [ 'name' => 'appGroupIdentity', 'in' => 'path', - 'schema' => [ - 'description' => 'The name of the application.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'my_app_group_name', - ], - ], - [ - 'name' => 'appId', - 'in' => 'path', - 'schema' => [ - 'description' => 'The version number of the application.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'docRequired' => true, - 'example' => '110157886', - ], + 'schema' => ['description' => 'The name of the application.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'my_app_group_name', 'title' => ''], ], [ - 'name' => 'name', + 'name' => 'taskId', 'in' => 'path', - 'schema' => [ - 'description' => 'The name of the rough sort expression'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'test', - ], - ], - [ - 'name' => 'body', - 'in' => 'body', - 'schema' => [ - 'description' => 'The request body.'."\n", - 'required' => false, - '$ref' => '#/components/schemas/FirstRank', - ], + 'schema' => ['description' => 'The ID of the task.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '2f12c585-5873-11ea-974a-7cd30ad3e268', 'title' => ''], ], ], 'responses' => [ @@ -9503,107 +7166,55 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'requestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '0A6EB64B-B4C8-CF02-810F-E660812972FF', - ], - 'result' => [ - 'description' => 'The information about the rough sort expression.'."\n", - 'type' => 'object', - 'properties' => [ - 'description' => [ - 'description' => 'The description of the rough sort expression.'."\n", - 'type' => 'string', - 'example' => '1', - ], - 'active' => [ - 'description' => 'Indicates whether the expression is the default one.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'name' => [ - 'description' => 'The name of the expression.'."\n", - 'type' => 'string', - 'example' => 'default', - ], - 'meta' => [ - 'description' => 'The information about the expression.'."\n", - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'arg' => [ - 'description' => 'The parameters that are used by a function in the expression.'."\n", - 'type' => 'string', - 'example' => '“1 ”', - ], - 'attribute' => [ - 'description' => 'The attribute, feature function, or field to be searched for.'."\n", - 'type' => 'string', - 'example' => 'static_bm25()', - ], - 'weight' => [ - 'description' => 'The weight. Valid values: -100000 to 100000. The value cannot be 0.'."\n", - 'type' => 'number', - 'format' => 'float', - 'example' => '10', - ], - ], - ], - ], - ], - ], + 'result' => ['description' => 'The details of the scheduled task.', 'type' => 'object', 'example' => '{}', 'title' => ''], + 'requestId' => ['description' => 'The ID of the request.', 'type' => 'string', 'example' => '922DC0D9-31B5-45F9-47B7-37DC678D61A8', 'title' => ''], ], 'description' => '', + 'title' => '', + 'example' => '', ], ], '5XX' => [ 'schema' => [ 'type' => 'object', 'properties' => [ - 'code' => [ - 'type' => 'string', - ], - 'requestId' => [ - 'type' => 'string', - ], - 'message' => [ - 'type' => 'string', - ], - 'httpCode' => [ - 'type' => 'integer', - 'format' => 'int32', - ], + 'code' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'message' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'requestId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'httpCode' => ['type' => 'integer', 'format' => 'int32', 'description' => '', 'title' => '', 'example' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + ], + ], + 'title' => 'DescribeScheduledTask', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'opensearch:DescribeScheduledTask', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'OpenSearch', 'resourceType' => 'ScheduledTask', 'arn' => 'acs:opensearch:{#regionId}:{#accountId}:app-groups/{#AppGroupId}'], ], ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"requestId\\": \\"0A6EB64B-B4C8-CF02-810F-E660812972FF\\",\\n \\"result\\": {\\n \\"description\\": \\"1\\",\\n \\"active\\": true,\\n \\"name\\": \\"default\\",\\n \\"meta\\": [\\n {\\n \\"arg\\": \\"“1 ”\\",\\n \\"attribute\\": \\"static_bm25()\\",\\n \\"weight\\": 10\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"0A6EB64B-B4C8-CF02-810F-E660812972FF\\n\\n ar_wear_edit_time\\n STRUCT\\n \\n timeliness_ms()\\n ar_edit_time\\n 1\\n \\n \\n false\\n 0\\n 0\\n","errorExample":""}]', - 'title' => 'ModifyFirstRank', - 'requestParamsDescription' => '**Request body**'."\n" - ."\n" - .'|Field|Type|Required|Example|Description|'."\n" - .'|---|---|---|---|---|'."\n" - .'|type|String|Yes|"STRUCT"|The type of the expression.Valid values: STRUCT and STRING.A value of STRUCT indicates that the content of the expression is a structure. This is the default value. A value of STRING indicates that the content of the expression is a custom formula.|'."\n" - .'|meta|Array or string|Yes||The information about the expression.|'."\n" - .'|description|String|No|"my\\_test"|The description of the rough sort expression.|'."\n" - .'|active|Boolean|No|true|Specifies whether the expression is the default one.|'."\n" - ."\n" - .'For more information, see [FirstRank](~~170007~~).', - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"result\\": {},\\n \\"requestId\\": \\"922DC0D9-31B5-45F9-47B7-37DC678D61A8\\"\\n}","type":"json"}]', + 'translator' => 'manual', ], - 'ListSecondRanks' => [ - 'summary' => 'Queries the fine sort expressions that are configured for a version of an OpenSearch application.', - 'path' => '/v4/openapi/app-groups/{appGroupIdentity}/apps/{appId}/second-ranks', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'DescribeSecondRank' => [ + 'summary' => 'Queries the fine sort expression for a version of an OpenSearch application.', + 'path' => '/v4/openapi/app-groups/{appGroupIdentity}/apps/{appId}/second-ranks/{name}', + 'methods' => ['get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -9612,37 +7223,26 @@ 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'list', + 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREopensearchN8M8WS', - 'FEATUREopensearchJUWEG4', - ], + 'abilityTreeNodes' => ['FEATUREopensearchN8M8WS', 'FEATUREopensearchJUWEG4'], ], 'parameters' => [ [ 'name' => 'appGroupIdentity', 'in' => 'path', - 'schema' => [ - 'description' => 'The name of the application'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'my_app_group_name', - ], + 'schema' => ['description' => 'The name of the application group.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'title' => '', 'example' => 'my_app_group_name'], ], [ 'name' => 'appId', 'in' => 'path', - 'schema' => [ - 'description' => 'The version number of the application.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'docRequired' => true, - 'example' => '110157886', - ], + 'schema' => ['description' => 'The API version.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true, 'title' => '', 'example' => '110157886'], + ], + [ + 'name' => 'name', + 'in' => 'path', + 'schema' => ['description' => 'The name of the second-rank expression.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'title' => '', 'example' => 'test'], ], ], 'responses' => [ @@ -9650,181 +7250,99 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'totalCount' => [ - 'description' => 'The total number of entries returned.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'requestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '0A6EB64B-B4C8-CF02-810F-E660812972FF', - ], + 'requestId' => ['description' => 'The request ID.', 'type' => 'string', 'title' => '', 'example' => '0A6EB64B-B4C8-CF02-810F-E660812972FF'], 'result' => [ - 'description' => 'The information about the fine sort expression.'."\n" - ."\n" - .'For more information, see [SecondRank](~~170008~~).'."\n", - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'created' => [ - 'description' => 'The time when the expression was created.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '0', - ], - 'active' => [ - 'description' => 'Indicates whether the expression is the default one.'."\n", - 'type' => 'boolean', - 'example' => 'false', - ], - 'isDefault' => [ - 'description' => 'Indicates whether the expression is the default one. This parameter is displayed only in the response. Valid values:'."\n" - ."\n" - .'* true: the expression is the default one.'."\n" - .'* false: the expression is not the default one.'."\n", - 'type' => 'string', - 'example' => 'false', - ], - 'isSys' => [ - 'description' => 'Indicates whether the expression is a system expression. This parameter is displayed only in the response. Valid values:'."\n" - ."\n" - .'* true: The expression is a system expression.'."\n" - .'* false:The expression is not a system expression'."\n", - 'type' => 'string', - 'example' => 'true', - ], - 'description' => [ - 'description' => 'Description'."\n", - 'type' => 'string', - 'example' => '""', - ], - 'updated' => [ - 'description' => 'The time when the expression was updated.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1587052801', - ], - 'name' => [ - 'description' => 'Parameter'."\n", - 'type' => 'string', - 'example' => 'tests', - ], - 'meta' => [ - 'description' => 'The content of the fine sort expression. You can define an expression that consists of fields, feature functions, and mathematical functions to implement complex sort logic.'."\n", - 'type' => 'string', - 'example' => 'random()+now()', - ], - 'id' => [ - 'description' => 'The expression ID. This parameter is displayed only in the response.'."\n", - 'type' => 'string', - 'example' => '890473', - ], - ], - 'description' => '', + 'description' => 'The details of the second-rank expression.', + 'type' => 'object', + 'properties' => [ + 'created' => ['description' => 'The time when the expression was created.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '1587052801'], + 'active' => ['description' => 'Indicates whether the expression is active.', 'type' => 'boolean', 'title' => '', 'example' => 'true'], + 'isDefault' => ['description' => 'Indicates whether the expression is the default one. This parameter is returned only in the response.'."\n" + ."\n" + .'- true'."\n" + ."\n" + .'- false', 'type' => 'string', 'title' => '', 'example' => 'true'], + 'isSys' => ['description' => 'Indicates whether the expression is a system expression. This parameter is returned only in the response.'."\n" + ."\n" + .'- true'."\n" + ."\n" + .'- false', 'type' => 'string', 'title' => '', 'example' => 'false'], + 'description' => ['description' => 'The description.', 'type' => 'string', 'title' => '', 'example' => '-'], + 'updated' => ['description' => 'The time when the expression was updated.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '1587052801'], + 'name' => ['description' => 'The name of the expression.', 'type' => 'string', 'title' => '', 'example' => 'tests'], + 'meta' => ['description' => 'The second-rank expression. You can write an expression that contains fields, feature functions, and mathematical functions to implement complex sort logic.', 'type' => 'string', 'title' => '', 'example' => 'random()+now()'], + 'id' => ['description' => 'The ID of the expression. This parameter is returned only in the response.', 'type' => 'string', 'title' => '', 'example' => '89047'], ], + 'title' => '', + 'example' => '', ], ], 'description' => '', + 'title' => '', + 'example' => '', ], ], '5XX' => [ 'schema' => [ 'type' => 'object', 'properties' => [ - 'code' => [ - 'type' => 'string', - ], - 'message' => [ - 'type' => 'string', - ], - 'requestId' => [ - 'type' => 'string', - ], - 'httpCode' => [ - 'type' => 'integer', - 'format' => 'int32', - ], + 'code' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'message' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'requestId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'httpCode' => ['type' => 'integer', 'format' => 'int32', 'description' => '', 'title' => '', 'example' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"totalCount\\": 1,\\n \\"requestId\\": \\"0A6EB64B-B4C8-CF02-810F-E660812972FF\\",\\n \\"result\\": [\\n {\\n \\"created\\": 0,\\n \\"active\\": false,\\n \\"isDefault\\": \\"false\\",\\n \\"isSys\\": \\"true\\",\\n \\"description\\": \\"\\\\\\"\\\\\\"\\",\\n \\"updated\\": 1587052801,\\n \\"name\\": \\"tests\\",\\n \\"meta\\": \\"random()+now()\\",\\n \\"id\\": \\"890473\\"\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"0A6EB64B-B4C8-CF02-810F-E660812972FF\\n\\n default\\n \\n false\\n \\n 890473\\n 0\\n 0\\n false\\n true\\n\\n\\n tests\\n random()+now()\\n true\\n \\n 890474\\n 1587052801\\n 1587052801\\n true\\n false\\n\\n\\n test\\n query_term_count()\\n false\\n \\n 890475\\n 1587052801\\n 1587052801\\n false\\n false\\n\\n3","errorExample":""}]', - 'title' => 'ListSecondRanks', + 'title' => 'DescribeSecondRank', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', - ], - 'CreateSecondRank' => [ - 'summary' => 'Creates a fine sort expression for a version of an OpenSearch application. If you set dryRun to true, this operation checks the specified fine sort expression. The default value of dryRun is false if you do not set this parameter.', - 'path' => '/v4/openapi/app-groups/{appGroupIdentity}/apps/{appId}/second-ranks', - 'methods' => [ - 'post', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'opensearch:DescribeSecondRank', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'OpenSearch', 'resourceType' => 'SecondRank', 'arn' => 'acs:opensearch:{#regionId}:{#accountId}:apps/{#AppGroupId}'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"0A6EB64B-B4C8-CF02-810F-E660812972FF\\",\\n \\"result\\": {\\n \\"created\\": 1587052801,\\n \\"active\\": true,\\n \\"isDefault\\": \\"true\\",\\n \\"isSys\\": \\"false\\",\\n \\"description\\": \\"-\\",\\n \\"updated\\": 1587052801,\\n \\"name\\": \\"tests\\",\\n \\"meta\\": \\"random()+now()\\",\\n \\"id\\": \\"89047\\"\\n }\\n}","type":"json"}]', + 'translator' => 'manual', + ], + 'DescribeSlowQueryStatus' => [ + 'path' => '/v4/openapi/app-groups/{appGroupIdentity}/optimizers/slow-query', + 'methods' => ['get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'write', + 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'create', + 'operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREopensearchN8M8WS', - 'FEATUREopensearchJUWEG4', - ], + 'abilityTreeNodes' => ['FEATUREopensearchA0YLTY', 'FEATUREopensearch9TYTPZ'], ], 'parameters' => [ [ 'name' => 'appGroupIdentity', 'in' => 'path', - 'schema' => [ - 'description' => 'The name of the application.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'my_app_group_name', - ], - ], - [ - 'name' => 'appId', - 'in' => 'path', - 'schema' => [ - 'description' => 'The version number of the application.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'docRequired' => true, - 'example' => '110157886', - ], - ], - [ - 'name' => 'dryRun', - 'in' => 'query', - 'schema' => [ - 'description' => 'Specifies whether to perform a dry run.'."\n", - 'type' => 'boolean', - 'required' => false, - 'example' => 'true', - ], - ], - [ - 'name' => 'body', - 'in' => 'body', - 'schema' => [ - 'description' => 'The request body. For more information, see [SecondRank](~~170008~~).'."\n", - 'required' => false, - '$ref' => '#/components/schemas/SecondRank', - ], + 'schema' => ['description' => 'The application name.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'title' => '', 'example' => 'my_app_group_name'], ], ], 'responses' => [ @@ -9832,67 +7350,76 @@ 'schema' => [ 'type' => 'object', 'properties' => [ + 'requestId' => ['description' => 'The request ID.', 'type' => 'string', 'title' => '', 'example' => '5C1C1C45-C64A-AD30-565F-140871D57E5E'], 'result' => [ - 'description' => 'The information about the fine sort expression.'."\n", + 'description' => 'The result.', 'type' => 'object', - 'example' => '{}', - ], - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => 'ABCDEFGH', + 'properties' => [ + 'region' => ['description' => 'The region.'."\n" + ."\n" + .'- outer: Public network'."\n" + ."\n" + .'- internal: Internal network', 'type' => 'string', 'title' => '', 'example' => 'internal'], + 'status' => ['description' => 'The activation status.'."\n" + ."\n" + .'- enabled: Enabled'."\n" + ."\n" + .'- disabled: Disabled'."\n" + ."\n" + .'- n/a: Unknown', 'type' => 'string', 'title' => '', 'example' => 'disabled'], + 'appGroupId' => ['description' => 'The application ID.', 'type' => 'string', 'title' => '', 'example' => '100298370'], + ], + 'title' => '', + 'example' => '', ], ], 'description' => '', + 'title' => '', + 'example' => '', ], ], '5XX' => [ 'schema' => [ 'type' => 'object', 'properties' => [ - 'code' => [ - 'type' => 'string', - ], - 'message' => [ - 'type' => 'string', - ], - 'requestId' => [ - 'type' => 'string', - ], - 'httpCode' => [ - 'type' => 'integer', - 'format' => 'int32', - ], + 'code' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'message' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'requestId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'httpCode' => ['type' => 'integer', 'format' => 'int32', 'description' => '', 'title' => '', 'example' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"result\\": {},\\n \\"RequestId\\": \\"ABCDEFGH\\"\\n}","errorExample":""},{"type":"xml","example":"C5E2F73C-8241-81F8-3A62-65478C5A3111\\n\\n 89047\\n test_1\\n text_relevance(title)\\n true\\n 123\\n 1593679894\\n 1593679894\\n true\\n false\\n","errorExample":""}]', - 'title' => 'CreateSecondRank', - 'requestParamsDescription' => '**Request body**'."\n" - ."\n" - .'|Parameter|Type|Required|Example|Description|'."\n" - .'|---|---|---|---|---|'."\n" - .'|name|String|No|"test"|The name of the expression.|'."\n" - .'|meta|String|No|"random()"|The content of the expression.|'."\n" - .'|description|String|No|"my\\_test"|The description of the expression.|'."\n" - .'|active|Boolean|No|true|Specifies whether the expression is the default one.|'."\n" - ."\n" - .'For more information, see [SecondRank](~~170008~~) '."\n" - .'.', - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', - ], - 'DescribeSecondRank' => [ - 'summary' => 'Queries a fine sort expression that is configured for a version of an OpenSearch application.', - 'path' => '/v4/openapi/app-groups/{appGroupIdentity}/apps/{appId}/second-ranks/{name}', - 'methods' => [ - 'get', + 'title' => 'DescribeSlowQueryStatus', + 'summary' => 'Queries the status of the slow query feature.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'opensearch:DescribeSlowQueryStatus', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'OpenSearch', 'resourceType' => 'AppGroup', 'arn' => 'acs:opensearch:{#regionId}:{#accountId}:apps/{#AppGroupId}'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"5C1C1C45-C64A-AD30-565F-140871D57E5E\\",\\n \\"result\\": {\\n \\"region\\": \\"internal\\",\\n \\"status\\": \\"disabled\\",\\n \\"appGroupId\\": \\"100298370\\"\\n }\\n}","type":"json"}]', + 'translator' => 'manual', + ], + 'DescribeUserAnalyzer' => [ + 'summary' => 'Retrieves the details of a custom analyzer.', + 'path' => '/v4/openapi/user-analyzers/{name}', + 'methods' => ['get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -9904,157 +7431,150 @@ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREopensearchN8M8WS', - 'FEATUREopensearchJUWEG4', - ], + 'abilityTreeNodes' => ['FEATUREopensearchUIICM8'], ], 'parameters' => [ [ - 'name' => 'appGroupIdentity', + 'name' => 'name', 'in' => 'path', + 'schema' => ['description' => 'The name of the analyzer.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'title' => '', 'example' => 'kevin_test'], + ], + [ + 'name' => 'with', + 'in' => 'query', + 'schema' => ['description' => 'Specifies related information to return. The properties are returned based on the specified level.'."\n" + ."\n" + .'- all: Returns information about the associated application.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => 'all'], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => 'The name of the application'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'my_app_group_name', + 'type' => 'object', + 'properties' => [ + 'result' => ['description' => 'The details of the custom analyzer. For more information, see [UserAnalyzer](~~178934~~).', 'type' => 'object', 'title' => '', 'example' => '{}'], + 'requestId' => ['description' => 'The request ID.', 'type' => 'string', 'title' => '', 'example' => 'FFAEF396-10EF-53C7-1F51-518853880729'], + ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], - [ - 'name' => 'appId', - 'in' => 'path', + '5XX' => [ 'schema' => [ - 'description' => 'The version number of the application.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'docRequired' => true, - 'example' => '110157886', + 'type' => 'object', + 'properties' => [ + 'code' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'message' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'requestId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'httpCode' => ['type' => 'integer', 'format' => 'int32', 'description' => '', 'title' => '', 'example' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], + ], + 'title' => 'DescribeUserAnalyzer', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ [ - 'name' => 'name', - 'in' => 'path', - 'schema' => [ - 'description' => 'The name of the fine sort expression'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'test', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'opensearch:DescribeUserAnalyzer', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'OpenSearch', 'resourceType' => 'Analyzer', 'arn' => 'acs:opensearch:{#regionId}:{#accountId}:user-analyzers/{#AnalyzerId}'], + ], ], ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"result\\": {},\\n \\"requestId\\": \\"FFAEF396-10EF-53C7-1F51-518853880729\\"\\n}","type":"json"}]', + 'translator' => 'manual', + ], + 'DisableSlowQuery' => [ + 'path' => '/v4/openapi/app-groups/{appGroupIdentity}/optimizers/slow-query/actions/disable', + 'methods' => ['post'], + 'schemes' => ['http', 'https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATUREopensearchA0YLTY', 'FEATUREopensearch9TYTPZ'], + ], + 'parameters' => [ + [ + 'name' => 'appGroupIdentity', + 'in' => 'path', + 'schema' => ['description' => 'The name of the application.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'title' => '', 'example' => 'my_app_group_name'], + ], + ], 'responses' => [ 200 => [ - 'schema' => [ - 'type' => 'object', - 'properties' => [ - 'requestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '0A6EB64B-B4C8-CF02-810F-E660812972FF', - ], - 'result' => [ - 'description' => 'The information about the fine sort expression.'."\n", - 'type' => 'object', - 'properties' => [ - 'created' => [ - 'description' => 'The time when the expression was created.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1587052801', - ], - 'active' => [ - 'description' => 'Specifies whether to set the fine sort expression as the default sort expression.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'isDefault' => [ - 'description' => 'Indicates whether the expression is the default one. This parameter appears only in the response. Valid values:'."\n" - ."\n" - .'* true'."\n" - .'* false'."\n", - 'type' => 'string', - 'example' => 'true', - ], - 'isSys' => [ - 'description' => 'Indicates whether the expression is a system expression. This parameter appears only in the response. Valid values:'."\n" - ."\n" - .'* true'."\n" - .'* false'."\n", - 'type' => 'string', - 'example' => 'false', - ], - 'description' => [ - 'description' => 'Description'."\n", - 'type' => 'string', - 'example' => '-', - ], - 'updated' => [ - 'description' => 'The time when the expression was updated.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1587052801', - ], - 'name' => [ - 'description' => 'The name.'."\n", - 'type' => 'string', - 'example' => 'tests', - ], - 'meta' => [ - 'description' => 'The content of the fine sort expression. You can define an expression that consists of fields, feature functions, and mathematical functions to implement complex sort logic.'."\n", - 'type' => 'string', - 'example' => 'random()+now()', - ], - 'id' => [ - 'description' => 'The ID of the expression. This parameter appears only in the response.'."\n", - 'type' => 'string', - 'example' => '89047', - ], - ], - ], + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'result' => ['description' => 'The returned data.', 'type' => 'object', 'title' => '', 'example' => '{}'], + 'requestId' => ['description' => 'The request ID.', 'type' => 'string', 'title' => '', 'example' => '728E89C6-8673-D39B-39A1-5BA2B56D448F'], ], 'description' => '', + 'title' => '', + 'example' => '', ], ], '5XX' => [ 'schema' => [ 'type' => 'object', 'properties' => [ - 'code' => [ - 'type' => 'string', - ], - 'message' => [ - 'type' => 'string', - ], - 'requestId' => [ - 'type' => 'string', - ], - 'httpCode' => [ - 'type' => 'integer', - 'format' => 'int32', - ], + 'code' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'message' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'requestId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'httpCode' => ['type' => 'integer', 'format' => 'int32', 'description' => '', 'title' => '', 'example' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"requestId\\": \\"0A6EB64B-B4C8-CF02-810F-E660812972FF\\",\\n \\"result\\": {\\n \\"created\\": 1587052801,\\n \\"active\\": true,\\n \\"isDefault\\": \\"true\\",\\n \\"isSys\\": \\"false\\",\\n \\"description\\": \\"-\\",\\n \\"updated\\": 1587052801,\\n \\"name\\": \\"tests\\",\\n \\"meta\\": \\"random()+now()\\",\\n \\"id\\": \\"89047\\"\\n }\\n}","errorExample":""},{"type":"xml","example":"0A6EB64B-B4C8-CF02-810F-E660812972FF\\n\\n 89047\\n tests\\n random()+now()\\n true\\n \\n 1587052801\\n 1587052801\\n true\\n false\\n","errorExample":""}]', - 'title' => 'DescribeSecondRank', - 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', - ], - 'ModifySecondRank' => [ - 'summary' => 'Modifies a fine sort expression that is configured for a specific OpenSearch application version. If you set dryRun to true, the specified fine sort expression is checked after the expression is modified. By default, the value of dryRun is false if you do not specify this parameter.', - 'path' => '/v4/openapi/app-groups/{appGroupIdentity}/apps/{appId}/second-ranks/{name}', - 'methods' => [ - 'put', + 'title' => 'DisableSlowQuery', + 'summary' => 'Disables the slow query service for Search Diagnoser.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'opensearch:DisableSlowQuery', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'OpenSearch', 'resourceType' => 'AppGroup', 'arn' => 'acs:opensearch:{#regionId}:{#accountId}:apps/{#AppGroupId}'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"result\\": {},\\n \\"requestId\\": \\"728E89C6-8673-D39B-39A1-5BA2B56D448F\\"\\n}","type":"json"}]', + 'translator' => 'manual', + ], + 'EnableSlowQuery' => [ + 'summary' => 'Enables the slow query service for the optimizer.', + 'path' => '/v4/openapi/app-groups/{appGroupIdentity}/optimizers/slow-query/actions/enable', + 'methods' => ['post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -10063,237 +7583,217 @@ 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'update', + 'operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREopensearchN8M8WS', - 'FEATUREopensearchJUWEG4', - ], + 'abilityTreeNodes' => ['FEATUREopensearchA0YLTY', 'FEATUREopensearch9TYTPZ'], ], 'parameters' => [ [ 'name' => 'appGroupIdentity', 'in' => 'path', + 'schema' => ['description' => 'The application name.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'title' => '', 'example' => 'my_app_group_name'], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => 'The application name.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '“my_app_group_name”', + 'type' => 'object', + 'properties' => [ + 'result' => ['description' => 'The returned result.', 'type' => 'object', 'title' => '', 'example' => '{}'], + 'requestId' => ['description' => 'The request ID.', 'type' => 'string', 'title' => '', 'example' => '728E89C6-8673-D39B-39A1-5BA2B56D448F'], + ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], - [ - 'name' => 'appId', - 'in' => 'path', + '5XX' => [ 'schema' => [ - 'description' => 'The version number of the application.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'docRequired' => true, - 'example' => '110157886', + 'type' => 'object', + 'properties' => [ + 'code' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'message' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'requestId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'httpCode' => ['type' => 'integer', 'format' => 'int32', 'description' => '', 'title' => '', 'example' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], + ], + 'title' => 'EnableSlowQuery', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ [ - 'name' => 'name', - 'in' => 'path', - 'schema' => [ - 'description' => 'The name of the fine sort expression.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'true', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'opensearch:EnableSlowQuery', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'OpenSearch', 'resourceType' => 'AppGroup', 'arn' => 'acs:opensearch:{#regionId}:{#accountId}:apps/{#AppGroupId}'], + ], ], ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"result\\": {},\\n \\"requestId\\": \\"728E89C6-8673-D39B-39A1-5BA2B56D448F\\"\\n}","type":"json"}]', + 'translator' => 'manual', + ], + 'GenerateMergedTable' => [ + 'path' => '/v4/openapi/assist/schema/actions/merge', + 'methods' => ['post'], + 'schemes' => ['http', 'https'], + 'security' => [ [ - 'name' => 'dryRun', + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'get'], + 'parameters' => [ + [ + 'name' => 'spec', 'in' => 'query', - 'schema' => [ - 'description' => 'Specifies whether the request is a dry run.'."\n", - 'type' => 'boolean', - 'required' => false, - 'example' => 'true', - ], + 'schema' => ['description' => 'The specifications of the OpenSearch instance. This parameter is used to check whether the OpenSearch instance meets the special limits on an exclusive instance.'."\n" + ."\n" + .'Default value: opensearch.share.common.'."\n" + ."\n" + .'For more information, see the description of the spec field in the Quota topic.'."\n", 'type' => 'string', 'required' => false, 'example' => '"opensearch.share.common"', 'title' => ''], ], [ 'name' => 'body', 'in' => 'body', - 'schema' => [ - 'description' => 'The request parameters.'."\n", - 'required' => false, - '$ref' => '#/components/schemas/SecondRank', - ], + 'schema' => ['description' => 'The request body parameters.'."\n", 'required' => false, '$ref' => '#/components/schemas/Schema', 'title' => '', 'example' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ - 'requestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => 'C5E2F73C-8241-81F8-3A62-65478C5A3111', - ], + 'requestId' => ['description' => 'The request ID.'."\n", 'type' => 'string', 'example' => 'ABCDEFGH', 'title' => ''], 'result' => [ - 'description' => 'The information about the fine sort expression.'."\n", + 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ - 'created' => [ - 'description' => 'The time when the expression was created.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'active' => [ - 'description' => 'Indicates whether the expression is the default one.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'isDefault' => [ - 'description' => 'Indicates whether the expression is the default one. This parameter is displayed only in the response. Valid values:'."\n" - ."\n" - .'* true: the expression is the default one.'."\n" - .'* false: the expression is not the default one.'."\n", - 'type' => 'string', - 'example' => 'true', - ], - 'isSys' => [ - 'description' => 'Indicates whether the expression is a system expression. This parameter is displayed only in the response. Valid values:'."\n" - ."\n" - .'* true: The expression is a system expression.'."\n" - .'* false:The expression is not a system expression'."\n", - 'type' => 'string', - 'example' => 'false', - ], - 'description' => [ - 'description' => 'The description of the expression.'."\n", - 'type' => 'string', - 'example' => '"11"', - ], - 'updated' => [ - 'description' => 'The time when the expression was updated.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'name' => [ - 'description' => 'The expression name.'."\n", - 'type' => 'string', - 'example' => 'lsh_second_1', - ], - 'meta' => [ - 'description' => 'The content of the fine sort expression. You can define an expression that consists of fields, feature functions, and mathematical functions to implement complex sort logic.'."\n", - 'type' => 'string', - 'example' => 'cate_id > 0 and cate_id < 1000', - ], - 'id' => [ - 'description' => 'The expression ID. This parameter is displayed only in the response.'."\n", - 'type' => 'string', - 'example' => '890473', - ], + 'primaryKey' => ['description' => 'The primary key.'."\n", 'type' => 'string', 'example' => '-', 'title' => ''], + 'mergeTable' => ['description' => 'The wide table that is generated after the JOIN operation is performed on multiple tables.'."\n", 'type' => 'object', 'example' => '-', 'title' => ''], + 'fromTable' => ['description' => 'The tables on which the JOIN operation is performed.'."\n", 'type' => 'object', 'example' => '-', 'title' => ''], ], - 'example' => '{}', + 'title' => '', + 'example' => '', ], ], - 'example' => '{}', + 'description' => '', + 'title' => '', + 'example' => '', ], ], '5XX' => [ 'schema' => [ 'type' => 'object', 'properties' => [ - 'code' => [ - 'type' => 'string', - ], - 'message' => [ - 'type' => 'string', - ], - 'requestId' => [ - 'type' => 'string', - ], - 'httpCode' => [ - 'type' => 'integer', - 'format' => 'int32', - ], + 'code' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'message' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'requestId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'httpCode' => ['type' => 'integer', 'format' => 'int32', 'description' => '', 'title' => '', 'example' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"requestId\\": \\"C5E2F73C-8241-81F8-3A62-65478C5A3111\\",\\n \\"result\\": {\\n \\"created\\": 1,\\n \\"active\\": true,\\n \\"isDefault\\": \\"true\\",\\n \\"isSys\\": \\"false\\",\\n \\"description\\": \\"\\\\\\"11\\\\\\"\\",\\n \\"updated\\": 1,\\n \\"name\\": \\"lsh_second_1\\",\\n \\"meta\\": \\"cate_id > 0 and cate_id < 1000\\",\\n \\"id\\": \\"890473\\"\\n }\\n}","errorExample":""},{"type":"xml","example":"C5E2F73C-8241-81F8-3A62-65478C5A3111\\n\\n 890473\\n name_relevance\\n text_relevance(name)\\n true\\n 123\\n 1593679894\\n 1593679894\\n true\\n false\\n","errorExample":""}]', - 'title' => 'ModifySecondRank', + 'title' => 'GenerateMergedTable', + 'summary' => 'Queries the information about a wide table that is generated after a JOIN operation is performed on multiple tables.', 'requestParamsDescription' => '**Request body**'."\n" ."\n" .'|Parameter|Type|Required|Example|Description|'."\n" .'|---|---|---|---|---|'."\n" - .'|meta|String|No|"text\\_relevance(name)"|The content of the expression.|'."\n" - .'|description|String|No|"my\\_test"|The description of the expression.|'."\n" - .'|active|Boolean|No|true|Indicates whether the expression is the default one.|', - 'responseParamsDescription' => ' ', + .'|tables|Object|Yes||The table schema.|'."\n" + .'|indexes|Object|No||The index schema.|', + 'responseParamsDescription' => '**Response parameters**'."\n" + ."\n" + .'|Parameter|Type|Description|'."\n" + .'|---|---|---|'."\n" + .'|requestId|String|The request ID.|'."\n" + .'|result.mergeTable|Object|The wide table that is generated after the JOIN operation is performed on multiple tables. The key is the field name and the value is the field content.|'."\n" + .'|result.fromTable|Object|The information about the tables on which the JOIN operation is performed.|'."\n" + .'|result.fromTable.tables|Object|The information about the tables. The key is the table name and the value is the information about the table schema.|'."\n" + .'|result.fromTable.tables.\\*|Object|The key is the field name and the value is the field content.|'."\n" + .'|result.fromTable.master|String|The primary table.|'."\n" + .'|result.fromTable.level|Object|The information about table levels. The table level starts from 0.The key is the table name and the value is the table level.|'."\n" + .'|result.fromTable.joinMap|Object|The information about the external table. The key is the table name and the value is the information about the external table.|'."\n" + .'|result.fromTable.joinMap.\\*|Object|The information about the fields of the external table. The key is the field name and the value is the field content.|'."\n" + .'|result.primaryKey|String|The primary key field.|'."\n" + ."\n\n" + .'**TableFields**'."\n" + ."\n" + .'|Parameter|Type|Description|'."\n" + .'|---|---|---|'."\n" + .'|name|String|The name of the field.|'."\n" + .'|type|String|The type of the field. For more information, see [Fields in a data table](~~179404~~).|'."\n" + .'|isPk|String|Indicates whether the field is the primary key field. Valid values:0: The field is not the primary key field.1: The field is the primary key field.|'."\n" + .'|isMulti|Integer|Indicates whether the field is a multi-value field. Valid values:0: The field is not a multi-value field.1: The field is a multi-value field.|'."\n" + .'|isAttribute|Integer|Indicates whether the field is an attribute field. Valid values:0: The field is not an attribute field.1: The field is an attribute field.|'."\n" + ."\n\n" + .'**JoinMapFields**'."\n" + ."\n" + .'|Parameter|Type|Description|'."\n" + .'|---|---|---|'."\n" + .'|table|String|The name of the external table.|'."\n" + .'|key|String|The name of the primary key of the external table.|'."\n" + .'|join|Object|The extended fields of the external table.|', 'extraInfo' => ' ', - ], - 'RemoveSecondRank' => [ - 'summary' => 'Deletes a fine sort expression from a version of an OpenSearch application.', - 'path' => '/v4/openapi/app-groups/{appGroupIdentity}/apps/{appId}/second-ranks/{name}', - 'methods' => [ - 'delete', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '1', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GenerateMergedTable'], + ], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'opensearch:GenerateMergedTable', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'OpenSearch', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"requestId\\": \\"ABCDEFGH\\",\\n \\"result\\": {\\n \\"primaryKey\\": \\"-\\",\\n \\"mergeTable\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n },\\n \\"fromTable\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n }\\n }\\n}","errorExample":""},{"type":"xml","example":"8EF9C2DF-34C3-EDCF-6DEA-0445EE53DA20\\n\\n \\n \\n id\\n INT\\n 1\\n 0\\n 0\\n \\n \\n classid\\n INT\\n 0\\n 0\\n 0\\n \\n \\n <name>title</name>\\n <type>TEXT</type>\\n <isPk>0</isPk>\\n <isMulti>0</isMulti>\\n <isAttribute>0</isAttribute>\\n \\n \\n js\\n TEXT\\n 0\\n 0\\n 0\\n \\n \\n classid_1\\n INT\\n 0\\n 0\\n 0\\n \\n \\n infotags\\n TEXT\\n 0\\n 0\\n 0\\n \\n \\n \\n \\n \\n \\n id\\n INT\\n 1\\n 0\\n \\n \\n classid\\n INT\\n 0\\n 0\\n \\n \\n <name>title</name>\\n <type>TEXT</type>\\n <isPk>0</isPk>\\n <isMulti>0</isMulti>\\n \\n \\n js\\n TEXT\\n 0\\n 0\\n \\n \\n \\n \\n id_1\\n INT\\n 1\\n 0\\n \\n \\n classid_1\\n INT\\n 0\\n 0\\n \\n \\n infotags\\n TEXT\\n 0\\n 0\\n \\n \\n \\n phome_ecms_tuzhi\\n \\n 0\\n 1\\n \\n \\n \\n \\n phome_ecms_tuzhi_data_1
\\n id_1\\n \\n classid_1\\n infotags\\n \\n \\n \\n \\n \\n id\\n","errorExample":""}]', + ], + 'GetDomain' => [ + 'path' => '/v4/openapi/domains/{domainName}', + 'methods' => ['get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'write', + 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'delete', - 'riskType' => 'none', - 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREopensearchN8M8WS', - 'FEATUREopensearchJUWEG4', - ], - ], + 'systemTags' => ['operationType' => 'get'], 'parameters' => [ [ - 'name' => 'appGroupIdentity', - 'in' => 'path', - 'schema' => [ - 'description' => 'The name of the application'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '“my_app_group_name”', - ], - ], - [ - 'name' => 'appId', + 'name' => 'domainName', 'in' => 'path', - 'schema' => [ - 'description' => 'The version number'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'docRequired' => true, - 'example' => '110157886', - ], + 'schema' => ['description' => 'The industry type.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'title' => '', 'example' => 'ecommerce'], ], [ - 'name' => 'name', - 'in' => 'path', - 'schema' => [ - 'description' => 'The name of the fine sort expression.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '“tests”', - ], + 'name' => 'appGroupIdentity', + 'in' => 'query', + 'schema' => ['description' => 'The name or ID of the application.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'title' => '', 'example' => 'my_app_group_name'], ], ], 'responses' => [ @@ -10301,664 +7801,695 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'result' => [ - 'description' => 'The returned results.', - 'type' => 'object', - 'example' => '{}', - ], - 'requestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '0A6EB64B-B4C8-CF02-810F-E660812972FF', - ], + 'result' => ['description' => 'The returned result.', 'type' => 'object', 'title' => '', 'example' => '-'], + 'requestId' => ['description' => 'The request ID.', 'type' => 'string', 'title' => '', 'example' => '271D5762-32B7-5F0D-B97D-463EB67F1F3B'], ], 'description' => '', + 'title' => '', + 'example' => '', ], ], '5XX' => [ 'schema' => [ 'type' => 'object', 'properties' => [ - 'code' => [ - 'type' => 'string', - ], - 'message' => [ - 'type' => 'string', - ], - 'requestId' => [ - 'type' => 'string', - ], - 'httpCode' => [ - 'type' => 'integer', - 'format' => 'int32', - ], + 'code' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'message' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'requestId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'httpCode' => ['type' => 'integer', 'format' => 'int32', 'description' => '', 'title' => '', 'example' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"result\\": {},\\n \\"requestId\\": \\"0A6EB64B-B4C8-CF02-810F-E660812972FF\\"\\n}","errorExample":""},{"type":"xml","example":"0A6EB64B-B4C8-CF02-810F-E660812972FF","errorExample":""}]', - 'title' => 'RemoveSecondRank', - 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', - ], - 'ListQueryProcessors' => [ - 'summary' => 'Queries a list of query analysis rules that are configured for a version of an OpenSearch application.', - 'path' => '/v4/openapi/app-groups/{appGroupIdentity}/apps/{appId}/query-processors', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'http', - 'https', + 'title' => 'GetDomain', + 'summary' => 'Retrieves the industry type.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], - 'security' => [ + 'ramActions' => [ [ - 'AK' => [], + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'opensearch:GetDomain', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'OpenSearch', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], ], ], - 'operationType' => 'read', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'list', - 'riskType' => 'none', - 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREopensearchNCXKUT', - 'FEATUREopensearchUIICM8', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"result\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n },\\n \\"requestId\\": \\"271D5762-32B7-5F0D-B97D-463EB67F1F3B\\"\\n}","type":"json"}]', + 'translator' => 'manual', + ], + 'GetFunctionCurrentVersion' => [ + 'summary' => 'Retrieves the version information of the feature that is used to create an instance.', + 'path' => '/v4/openapi/functions/{functionName}/current-version', + 'methods' => ['get'], + 'schemes' => ['http', 'https'], + 'security' => [ + [ + 'AK' => [], ], ], + 'produces' => ['application/json'], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'get'], 'parameters' => [ [ - 'name' => 'appGroupIdentity', + 'name' => 'functionName', 'in' => 'path', + 'schema' => ['description' => 'The name of the feature. Valid values:'."\n" + ."\n" + .'- ctr: Click-through rate (CTR) model'."\n" + ."\n" + .'- pop: Popularity model'."\n" + ."\n" + .'- category: Category model'."\n" + ."\n" + .'- hot: Hotword model'."\n" + ."\n" + .'- hint: Hint model'."\n" + ."\n" + .'- suggest: Drop-down suggestion model'."\n" + ."\n" + .'- analyzer: Word segmentation model'."\n" + ."\n" + .'- termweight: Term weighting model', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'ctr'], + ], + [ + 'name' => 'modelType', + 'in' => 'query', 'schema' => [ - 'description' => 'The application name.'."\n", + 'description' => 'The model type. Different features correspond to different model types:'."\n" + ."\n" + .'- CTR model: tf\\_checkpoint'."\n" + ."\n" + .'- Popularity model: pop'."\n" + ."\n" + .'- Category model: offline\\_inference'."\n" + ."\n" + .'- Hotword model: offline\\_inference'."\n" + ."\n" + .'- Hint model: offline\\_inference'."\n" + ."\n" + .'- Drop-down suggestion model: offline\\_inference'."\n" + ."\n" + .'- Word segmentation model: text'."\n" + ."\n" + .'- Term weighting model: tf\\_checkpoint', 'type' => 'string', 'required' => true, - 'docRequired' => true, - 'example' => 'my_app_group_name', + 'enumValueTitles' => ['pop' => 'Popularity model', 'offline_inference' => 'Models for hotwords, hints, and category prediction.', 'tf_checkpoint' => 'Models for CTR and custom term weighting.', 'text' => 'Custom tokenization.'], + 'title' => '', + 'example' => 'tf_checkpoint', ], ], [ - 'name' => 'appId', - 'in' => 'path', + 'name' => 'functionType', + 'in' => 'query', + 'schema' => ['description' => 'The type of the feature. Valid values:'."\n" + ."\n" + .'- PAAS (default)'."\n" + ."\n" + .'- SAAS', 'type' => 'string', 'required' => false, 'title' => '', 'example' => 'PAAS'], + ], + [ + 'name' => 'domain', + 'in' => 'query', 'schema' => [ - 'description' => 'The application version number.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'docRequired' => true, - 'example' => '110157886', + 'description' => 'The industry. The default value is empty, which indicates the General-purpose Edition.', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => ['education' => 'Education', 'ecommerce' => 'E-commerce', 'community' => 'Content community'], + 'title' => '', + 'example' => 'ecommerce', ], ], [ - 'name' => 'isActive', + 'name' => 'category', 'in' => 'query', 'schema' => [ - 'description' => 'The scope of query analysis rules to be queried. Default value: 0. Valid values:'."\n" - ."\n" - .'* 0: queries all query analysis rules.'."\n" - .'* 1: queries the default query analysis rules.'."\n" - .'* 2: queries the query analysis rules that are not the default rules.'."\n", - 'type' => 'integer', - 'format' => 'int32', + 'description' => 'The category. The default value is empty.', + 'type' => 'string', 'required' => false, - 'example' => '0', + 'enumValueTitles' => ['general' => 'General', 'question' => 'Question-answering search for the education industry.', 'it' => 'IT content'], + 'title' => '', + 'example' => 'general', ], ], ], 'responses' => [ 200 => [ 'schema' => [ + 'description' => 'The response body.', 'type' => 'object', 'properties' => [ - 'requestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '0A6EB64B-B4C8-CF02-810F-E660812972FF', - ], - 'result' => [ - 'description' => 'The information about the query analysis rule.'."\n" - ."\n" - .'For more information, see [QueryProcessor](~~170014~~).'."\n", - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'created' => [ - 'description' => 'The time when the query analysis rule was created.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1587398402', - ], - 'active' => [ - 'description' => 'Indicates whether the query analysis rule is a default rule.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'updated' => [ - 'description' => 'The time when the query analysis rule was last modified.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1587398402', - ], - 'name' => [ - 'description' => 'The name of the query analysis rule.'."\n", - 'type' => 'string', - 'example' => 'ner', - ], - 'domain' => [ - 'description' => 'The type of the industry to which the query analysis rule is applied. Valid values:'."\n" - ."\n" - .'* GENERAL'."\n" - .'* ECOMMERCE'."\n" - .'* IT_CONTENT'."\n", - 'type' => 'string', - 'example' => 'GENERAL', - ], - 'indexes' => [ - 'description' => 'The indexes to which the query analysis rule is applied.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The indexes to which the query analysis rule is applied.'."\n", - 'type' => 'string', - 'example' => '[ "default" ]', + 'Status' => ['description' => 'The status of the request.', 'type' => 'string', 'title' => '', 'example' => 'OK'], + 'HttpCode' => ['description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '200'], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'title' => '', 'example' => '1638157479281'], + 'Message' => ['description' => 'The error message.', 'type' => 'string', 'title' => '', 'example' => 'version not exist.'], + 'Code' => ['description' => 'The error code.', 'type' => 'string', 'title' => '', 'example' => 'Version.NotExist'], + 'Result' => [ + 'description' => 'The returned result.', + 'type' => 'object', + 'properties' => [ + 'FunctionName' => ['description' => 'The name of the feature.', 'type' => 'string', 'title' => '', 'example' => 'ctr'], + 'FunctionType' => ['description' => 'The type of the feature. Valid values:'."\n" + ."\n" + .'- PAAS'."\n" + ."\n" + .'- SAAS', 'type' => 'string', 'title' => '', 'example' => 'PAAS'], + 'ModelType' => ['description' => 'The model type.', 'type' => 'string', 'title' => '', 'example' => 'tf_checkpoint'], + 'VersionConfig' => [ + 'description' => 'The configuration.', + 'type' => 'object', + 'properties' => [ + 'CreateParameters' => [ + 'description' => 'The parameters used to create an instance.', + 'type' => 'array', + 'items' => [ + 'description' => 'The parameter object.', + 'type' => 'object', + 'properties' => [ + 'Name' => ['description' => 'The name of the parameter.', 'type' => 'string', 'title' => '', 'example' => 'params1'], + 'Required' => ['description' => 'Specifies whether the parameter is required.', 'type' => 'string', 'title' => '', 'example' => 'true'], + ], + 'example' => '{ "name": "params1", "required": "true", "formItemProps": "{\\"required\\": true, \\"pattern?\\": \\"/^[a-zA-Z][a-zA-Z0-9_]{0,29}$/\\"}", "componentProps": "{\\"component\\": \\"Input\\", \\"attributes\\": {\\"defaultValue\\": \\"value1\\"}}" }', + 'title' => '', + ], + 'example' => '[ { "name": "params1", "required": "true", "formItemProps": "{\\"required\\": true, \\"pattern?\\": \\"/^[a-zA-Z][a-zA-Z0-9_]{0,29}$/\\"}", "componentProps": "{\\"component\\": \\"Input\\", \\"attributes\\": {\\"defaultValue\\": \\"value1\\"}}" } ]', + 'title' => '', ], - ], - 'processors' => [ - 'description' => 'The features that are used in the query analysis rule.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The feature that is used in the query analysis rule.'."\n" - ."\n" - .'For more information, see [Processor](~~170014~~).'."\n", - 'type' => 'object', + 'Depends' => [ + 'description' => 'A list of instance dependencies.', + 'type' => 'array', + 'items' => [ + 'description' => 'The parameter object.', + 'type' => 'object', + 'properties' => [ + 'Condition' => ['description' => 'The condition.', 'type' => 'string', 'title' => '', 'example' => '""'], + 'Dependency' => ['description' => 'The dependency.', 'type' => 'string', 'title' => '', 'example' => '""'], + 'Description' => ['description' => 'The description.', 'type' => 'string', 'title' => '', 'example' => '""'], + ], + 'example' => '{ "dependency": "依赖项", "condition": "条件", "description": "" }', + 'title' => '', + ], + 'example' => '[ { "dependency": "依赖项", "condition": "条件", "description": "" } ]', + 'title' => '', + ], + 'UsageParameters' => [ + 'description' => 'The parameters for using the instance online.', + 'type' => 'array', + 'items' => [ + 'description' => 'The parameter object.', + 'type' => 'object', + 'properties' => [ + 'Name' => ['description' => 'The name of the parameter.', 'type' => 'string', 'title' => '', 'example' => '""'], + 'Required' => ['description' => 'Specifies whether the parameter is required.', 'type' => 'string', 'title' => '', 'example' => '""'], + ], + 'example' => '{}', + 'title' => '', + ], 'example' => '[]', + 'title' => '', ], ], + 'example' => '{ "createParameters": [ { "name": "params1", "required": "true", "formItemProps": "{\\"required\\": true, \\"pattern?\\": \\"/^[a-zA-Z][a-zA-Z0-9_]{0,29}$/\\"}", "componentProps": "{\\"component\\": \\"Input\\", \\"attributes\\": {\\"defaultValue\\": \\"value1\\"}}" } ], "depends": [ { "dependency": "依赖项", "condition": "条件", "description": "" } ], "usageParameters": [] }', + 'title' => '', ], + 'VersionId' => ['description' => 'The version ID.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '101'], + 'VersionName' => ['description' => 'The version name.', 'type' => 'string', 'title' => '', 'example' => 'v1'], ], + 'example' => '{ "versionName": "v1", "versionId": 101, "functionName": "ctr", "modelType": "tf_checkpoint", "functionType": "PAAS", "versionConfig": { "createParameters": [ { "name": "params1", "required": "true", "formItemProps": "{\\"required\\": true, \\"pattern?\\": \\"/^[a-zA-Z][a-zA-Z0-9_]{0,29}$/\\"}", "componentProps": "{\\"component\\": \\"Input\\", \\"attributes\\": {\\"defaultValue\\": \\"value1\\"}}" } ], "depends": [ { "dependency": "依赖项", "condition": "条件", "description": "" } ], "usageParameters": [] } }', + 'title' => '', ], + 'Latency' => ['description' => 'The request latency in milliseconds (ms).', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '123'], ], - 'description' => '', + 'example' => '{ "status": "OK", "requestId": "", "httpCode": 200, "code": "", "message": "", "latency": 123, "result": { "versionName": "v1", "versionId": 101, "functionName": "ctr", "modelType": "tf_checkpoint", "functionType": "PAAS", "versionConfig": { "createParameters": [ { "name": "params1", "required": "true", "formItemProps": "{\\"required\\": true, \\"pattern?\\": \\"/^[a-zA-Z][a-zA-Z0-9_]{0,29}$/\\"}", "componentProps": "{\\"component\\": \\"Input\\", \\"attributes\\": {\\"defaultValue\\": \\"value1\\"}}" } ], "depends": [ { "dependency": "依赖项", "condition": "条件", "description": "" } ], "usageParameters": [] } } }', + 'title' => '', ], ], - '5XX' => [ - 'schema' => [ - 'type' => 'object', - 'properties' => [ - 'code' => [ - 'type' => 'string', - ], - 'message' => [ - 'type' => 'string', - ], - 'requestId' => [ - 'type' => 'string', - ], - 'httpCode' => [ - 'type' => 'integer', - 'format' => 'int32', - ], + ], + 'title' => 'GetFunctionCurrentVersion', + 'requestParamsDescription' => '### Sample request'."\n" + ."\n" + .'`GET /v4/openapi/functions/ctr/current-version?modelType=_checkpoint&functionType=PAAS&domain=ecommerce&category=general`', + 'responseParamsDescription' => '### Sample success response (hotword model)'."\n" + ."\n" + .'```'."\n" + .'{'."\n" + .' "status": "OK",'."\n" + .' "requestId": "165890826219877085621759",'."\n" + .' "latency": 0.049,'."\n" + .' "httpCode": 200,'."\n" + .' "code": "",'."\n" + .' "message": "",'."\n" + .' "result": {'."\n" + .' "versionId": 37,'."\n" + .' "versionName": "v2",'."\n" + .' "description": "",'."\n" + .' "status": "available",'."\n" + .' "functionName": "hot",'."\n" + .' "modelType": "offline_inference",'."\n" + .' "functionType": "PAAS",'."\n" + .' "versionConfig": {'."\n" + .' "createParameters": ['."\n" + .' {'."\n" + .' "name": "filter",'."\n" + .' "required": "false",'."\n" + .' "validations": "[{\\"preprocess\\": {\\"pattern\\": \\"(\\\\\\\\w+)\\\\\\\\s*(>=|<=|>|<|=|!=)\\\\\\\\s*(\\\\\\\\w+)\\", \\"type\\": \\"regex\\", \\"group\\": 1}, \\"params\\": {\\"data\\": [\\"user_id\\", \\"biz_type\\"], \\"type\\": \\"trival\\"}, \\"class\\": \\"EnumerateRule\\"}]",'."\n" + .' "value": "{\\"component\\":\\"Input\\",\\"attributes\\":{\\"defaultValue\\":\\"\\",\\"dataSource\\":\\"\\"}}",'."\n" + .' "valueSplit": ","'."\n" + .' }'."\n" + .' ],'."\n" + .' "usageParameters": ['."\n" + .' {'."\n" + .' "name": "allow_dict_id",'."\n" + .' "required": "false",'."\n" + .' "validations": "[{\\"params\\": {\\"restrictions\\": \\"type=hot_allowlist\\", \\"type\\": \\"passthrough\\", \\"dataSource\\": \\"dicts\\"}, \\"class\\": \\"EnumerateRule\\"}]",'."\n" + .' "value": "{\\"component\\":\\"Select\\",\\"attributes\\":{\\"defaultValue\\":\\"\\",\\"dataSource\\":\\"\\"}}"'."\n" + .' },'."\n" + .' {'."\n" + .' "name": "deny_dict_id",'."\n" + .' "required": "false",'."\n" + .' "validations": "[{\\"params\\": {\\"restrictions\\": \\"type=hot_denylist\\", \\"type\\": \\"passthrough\\", \\"dataSource\\": \\"dicts\\"}, \\"class\\": \\"EnumerateRule\\"}]",'."\n" + .' "value": "{\\"component\\":\\"Select\\",\\"attributes\\":{\\"defaultValue\\":\\"\\",\\"dataSource\\":\\"\\"}}"'."\n" + .' }'."\n" + .' ],'."\n" + .' "depends": ['."\n" + .' {'."\n" + .' "condition": "integrity_level >= 1",'."\n" + .' "dependency": "integrity_level",'."\n" + .' "description": "The data integrity level must be L1 or higher."'."\n" + .' }'."\n" + .' ],'."\n" + .' "deployment": "",'."\n" + .' "dagTemplate": "opensearch_hot_train"'."\n" + .' }'."\n" + .' }'."\n" + .'}'."\n" + .'```', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetFunctionCurrentVersion'], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'opensearch:DescribeFunction', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'OpenSearch', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"requestId\\": \\"0A6EB64B-B4C8-CF02-810F-E660812972FF\\",\\n \\"result\\": [\\n {\\n \\"created\\": 1587398402,\\n \\"active\\": true,\\n \\"updated\\": 1587398402,\\n \\"name\\": \\"ner\\",\\n \\"domain\\": \\"GENERAL\\",\\n \\"indexes\\": [\\n \\"[ \\\\\\"default\\\\\\" ]\\"\\n ],\\n \\"processors\\": [\\n []\\n ]\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"0A6EB64B-B4C8-CF02-810F-E660812972FF\\n\\n test\\n true\\n default\\n \\n true\\n ner\\n \\n \\n brand\\n HIGH\\n \\n \\n category\\n HIGH\\n \\n \\n material\\n MIDDLE\\n \\n \\n element\\n MIDDLE\\n \\n \\n style\\n MIDDLE\\n \\n \\n color\\n MIDDLE\\n \\n \\n function\\n MIDDLE\\n \\n \\n scenario\\n MIDDLE\\n \\n \\n people\\n MIDDLE\\n \\n \\n season\\n MIDDLE\\n \\n \\n model\\n MIDDLE\\n \\n \\n region\\n MIDDLE\\n \\n \\n name\\n MIDDLE\\n \\n \\n adjective\\n MIDDLE\\n \\n \\n category-modifier\\n MIDDLE\\n \\n \\n size\\n LOW\\n \\n \\n quality\\n LOW\\n \\n \\n suit\\n LOW\\n \\n \\n new-release\\n LOW\\n \\n \\n series\\n LOW\\n \\n \\n marketing\\n LOW\\n \\n \\n entertainment\\n LOW\\n \\n \\n organization\\n LOW\\n \\n \\n movie\\n LOW\\n \\n \\n game\\n LOW\\n \\n \\n number\\n LOW\\n \\n \\n unit\\n LOW\\n \\n \\n common\\n LOW\\n \\n \\n new-word\\n LOW\\n \\n \\n proper-noun\\n LOW\\n \\n \\n symbol\\n LOW\\n \\n \\n prefix\\n LOW\\n \\n \\n suffix\\n LOW\\n \\n \\n gift\\n LOW\\n \\n \\n negative\\n LOW\\n \\n \\n agent\\n LOW\\n \\n \\n \\n true\\n synonym\\n \\n \\n \\n true\\n term_weighting\\n \\n \\n \\n true\\n spell_check\\n \\n \\n \\n category_prediction\\n 60\\n 848\\n \\n GENERAL\\n 1587398402\\n 1587398402\\n","errorExample":""}]', - 'title' => 'ListQueryProcessors', - 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Status\\": \\"OK\\",\\n \\"HttpCode\\": 200,\\n \\"RequestId\\": \\"1638157479281\\",\\n \\"Message\\": \\"version not exist.\\",\\n \\"Code\\": \\"Version.NotExist\\",\\n \\"Result\\": {\\n \\"FunctionName\\": \\"ctr\\",\\n \\"FunctionType\\": \\"PAAS\\",\\n \\"ModelType\\": \\"tf_checkpoint\\",\\n \\"VersionConfig\\": {\\n \\"CreateParameters\\": [\\n {\\n \\"Name\\": \\"params1\\",\\n \\"Required\\": \\"true\\"\\n }\\n ],\\n \\"Depends\\": [\\n {\\n \\"Condition\\": \\"\\\\\\"\\\\\\"\\",\\n \\"Dependency\\": \\"\\\\\\"\\\\\\"\\",\\n \\"Description\\": \\"\\\\\\"\\\\\\"\\"\\n }\\n ],\\n \\"UsageParameters\\": [\\n {\\n \\"Name\\": \\"\\\\\\"\\\\\\"\\",\\n \\"Required\\": \\"\\\\\\"\\\\\\"\\"\\n }\\n ]\\n },\\n \\"VersionId\\": 101,\\n \\"VersionName\\": \\"v1\\"\\n },\\n \\"Latency\\": 123\\n}","type":"json"}]', + 'translator' => 'manual', ], - 'CreateQueryProcessor' => [ - 'summary' => 'Creates a query analysis rule. If you set dryRun to true, this operation checks the specified query analysis rule. By default, the value of dryRun is false if you do not set this parameter.', - 'path' => '/v4/openapi/app-groups/{appGroupIdentity}/apps/{appId}/query-processors', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'GetFunctionDefaultInstance' => [ + 'summary' => 'Queries the default algorithm instance for an application.', + 'path' => '/v4/openapi/app-groups/{appGroupIdentity}/functions/{functionName}/default-instance', + 'methods' => ['get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'write', + 'produces' => ['application/json'], + 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'create', + 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREopensearchNCXKUT', - 'FEATUREopensearchUIICM8', - ], + 'abilityTreeNodes' => ['FEATUREopensearchZAE4HR'], ], 'parameters' => [ [ 'name' => 'appGroupIdentity', 'in' => 'path', - 'schema' => [ - 'description' => 'The name of the application.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'my_app_group_name', - ], + 'schema' => ['description' => 'The name of the application.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'my_app_group_name'], ], [ - 'name' => 'appId', + 'name' => 'functionName', 'in' => 'path', - 'schema' => [ - 'description' => 'The version number of the application.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'docRequired' => true, - 'example' => '110157886', - ], - ], - [ - 'name' => 'dryRun', - 'in' => 'query', - 'schema' => [ - 'description' => 'Specifies whether to perform a dry run.'."\n", - 'type' => 'boolean', - 'required' => false, - 'example' => 'true', - ], - ], - [ - 'name' => 'body', - 'in' => 'body', - 'schema' => [ - 'description' => 'The request body.'."\n", - 'type' => 'any', - 'required' => false, - 'example' => '{}', - ], + 'schema' => ['description' => 'The name of the feature.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'ctr'], ], ], 'responses' => [ 200 => [ 'schema' => [ + 'description' => 'The response body.', 'type' => 'object', 'properties' => [ - 'requestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '0A6EB64B-B4C8-CF02-810F-E660812972FF', - ], - 'result' => [ - 'description' => 'The information about the query analysis rule.'."\n", + 'Status' => ['description' => 'The request status.', 'type' => 'string', 'title' => '', 'example' => 'OK'], + 'HttpCode' => ['description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '200'], + 'RequestId' => ['description' => 'The ID of the request.', 'type' => 'string', 'title' => '', 'example' => '062BA91F-A568-5779-8A5B-9E62C9BB3DC1'], + 'Message' => ['description' => 'The error message.', 'type' => 'string', 'title' => '', 'example' => 'default instance not set.'], + 'Code' => ['description' => 'The error code.', 'type' => 'string', 'title' => '', 'example' => 'DefaultInstance.NotExist'], + 'Result' => [ + 'description' => 'The result.', 'type' => 'object', 'properties' => [ - 'created' => [ - 'description' => 'The time when the query analysis rule was created.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1587398402', - ], - 'active' => [ - 'description' => 'Indicates whether the query analysis rule is the default one.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'updated' => [ - 'description' => 'The time when the query analysis rule was last modified.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1587398402', - ], - 'name' => [ - 'description' => 'The name of the query analysis rule.'."\n", - 'type' => 'string', - 'example' => 'query_filter', - ], - 'domain' => [ - 'description' => 'The type of the industry to which the query analysis rule was applied. Valid values:'."\n" - ."\n" - .'* GENERAL: general.'."\n" - .'* ECOMMERCE: e-commerce.'."\n" - .'* IT_CONTENT: IT content.'."\n", - 'type' => 'string', - 'example' => 'GENERAL', - ], - 'indexes' => [ - 'description' => 'The indexes to which the query analysis rule was applied.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The indexes to which the query analysis rule was applied.'."\n", - 'type' => 'string', - 'example' => '"default"', - ], - ], - 'processors' => [ - 'description' => 'The features that are used in the query analysis rule.'."\n" - ."\n" - .'For more information, see [QueryProcessor](~~170014~~).'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The features that are used in the query analysis rule.'."\n", - 'type' => 'object', - 'example' => '{}', - ], - ], + 'InstanceName' => ['description' => 'The default instance name.', 'type' => 'string', 'title' => '', 'example' => 'model1'], ], + 'example' => '{\'Pagination\': {\'TotalCount\': 0, \'PageNumber\': 1, \'PageSize\': 10}, \'AntConsortiums\': []}', + 'title' => '', ], + 'Latency' => ['description' => 'The default runtime.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '123'], + 'InstanceName' => ['title' => '', 'description' => 'The name of the instance.', 'type' => 'string', 'readOnly' => false, 'example' => 'sh-bp1oi31w1jn4ctdyv'], + 'FunctionName' => ['title' => '', 'description' => 'The name of the feature.', 'type' => 'string', 'readOnly' => true, 'example' => 'cdn_waf'], ], - 'description' => '', - ], - ], - '5XX' => [ - 'schema' => [ - 'type' => 'object', - 'properties' => [ - 'code' => [ - 'type' => 'string', - ], - 'message' => [ - 'type' => 'string', - ], - 'requestId' => [ - 'type' => 'string', - ], - 'httpCode' => [ - 'type' => 'integer', - 'format' => 'int32', - ], - ], - ], - ], - ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"requestId\\": \\"0A6EB64B-B4C8-CF02-810F-E660812972FF\\",\\n \\"result\\": {\\n \\"created\\": 1587398402,\\n \\"active\\": true,\\n \\"updated\\": 1587398402,\\n \\"name\\": \\"query_filter\\",\\n \\"domain\\": \\"GENERAL\\",\\n \\"indexes\\": [\\n \\"\\\\\\"default\\\\\\"\\"\\n ],\\n \\"processors\\": [\\n {}\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"0A6EB64B-B4C8-CF02-810F-E660812972FF\\n\\n query_filter\\n true\\n default\\n \\n synonym\\n true\\n \\n \\n stop_word\\n true\\n 980\\n \\n GENERAL\\n 1587398402\\n 1587398402\\n","errorExample":""}]', - 'title' => 'CreateQueryProcessor', - 'requestParamsDescription' => '**Request body**'."\n" - ."\n" - .'|Parameter|Type|Required|Example|Description|'."\n" - .'|---|---|---|---|---|'."\n" - .'|name|String|Yes|"test"|The name of the query analysis rule.|'."\n" - .'|processors\\[\\]|Object|Yes|N/A|The query analysis rule.For more information, see [QueryProcessor](~~170014~~).|'."\n" - .'|domain|String|No|"GENERAL"|The type of the industry to which the query analysis rule applies. Valid values:GENERAL: general.ECOMMERCE: e-commerce.IT\\_CONTENT: IT content.|'."\n" - .'|indexes|Array|No|\\["default"\\]|The indexes to which the query analysis rule applies.|'."\n" - .'|active|Boolean|No|true|Specifies whether to enable the query analysis rule.|'."\n" - ."\n\n" - .'For more information, see [QueryProcessor](~~170014~~).', - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', - ], - 'ModifyQueryProcessor' => [ - 'summary' => 'Modifies a query analysis rule for a specific application version. If you set dryRun to true, this operation checks the specified query analysis rule. By default, the value of dryRun is false if you do not specify this parameter.', - 'path' => '/v4/openapi/app-groups/{appGroupIdentity}/apps/{appId}/query-processors/{name}', - 'methods' => [ - 'put', + 'title' => '', + 'example' => '', + ], + ], + ], + 'title' => 'GetFunctionDefaultInstance', + 'requestParamsDescription' => '### Sample request'."\n" + ."\n" + .'`GET /v4/openapi/app-groups/my-app/functions/pop/default-instances`', + 'responseParamsDescription' => '### Sample responses'."\n" + ."\n" + .'```'."\n" + .'{'."\n" + .' "status": "OK",'."\n" + .' "requestId": "",'."\n" + .' "httpCode": 200,'."\n" + .' "code": "",'."\n" + .' "message": "",'."\n" + .' "latency": 123,'."\n" + .' "result": {'."\n" + .' "instanceName": "pop_test"'."\n" + .' }'."\n" + .'}'."\n" + .'```', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetFunctionDefaultInstance'], + ], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'opensearch:DescribeFunction', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'OpenSearch', 'resourceType' => 'FunctionDefaultInstance', 'arn' => 'acs:opensearch:{#regionId}:{#accountId}:apps/{#AppGroupId}'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Status\\": \\"OK\\",\\n \\"HttpCode\\": 200,\\n \\"RequestId\\": \\"062BA91F-A568-5779-8A5B-9E62C9BB3DC1\\",\\n \\"Message\\": \\"default instance not set.\\",\\n \\"Code\\": \\"DefaultInstance.NotExist\\",\\n \\"Result\\": {\\n \\"InstanceName\\": \\"model1\\"\\n },\\n \\"Latency\\": 123,\\n \\"InstanceName\\": \\"sh-bp1oi31w1jn4ctdyv\\",\\n \\"FunctionName\\": \\"cdn_waf\\"\\n}","type":"json"}]', + 'translator' => 'manual', + ], + 'GetFunctionInstance' => [ + 'summary' => 'Query an algorithm instance by instance name.', + 'path' => '/v4/openapi/app-groups/{appGroupIdentity}/functions/{functionName}/instances/{instanceName}', + 'methods' => ['get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'write', + 'consumes' => [], + 'produces' => ['application/json'], + 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'update', + 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREopensearchUIICM8', - 'FEATUREopensearchNCXKUT', - ], + 'abilityTreeNodes' => ['FEATUREopensearch3QPM0K', 'FEATUREopensearchN8M8WS', 'FEATUREopensearchZAE4HR'], ], 'parameters' => [ [ 'name' => 'appGroupIdentity', 'in' => 'path', - 'schema' => [ - 'description' => 'The application name.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '“my_app_group_name”', - ], + 'schema' => ['description' => 'The name of the application.', 'type' => 'string', 'required' => true, 'example' => '150057101', 'title' => ''], ], [ - 'name' => 'appId', + 'name' => 'functionName', 'in' => 'path', - 'schema' => [ - 'description' => 'The version number of the application.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'docRequired' => true, - 'example' => '110157886', - ], - ], - [ - 'name' => 'dryRun', - 'in' => 'query', - 'schema' => [ - 'description' => 'Specifies whether the request is a dry run.'."\n", - 'type' => 'boolean', - 'required' => false, - 'example' => 'true', - ], + 'schema' => ['description' => 'The name of the feature.', 'type' => 'string', 'required' => true, 'example' => 'ctr', 'title' => ''], ], [ - 'name' => 'name', + 'name' => 'instanceName', 'in' => 'path', - 'schema' => [ - 'description' => 'The name of the query analysis rule'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '“test”', - ], + 'schema' => ['description' => 'The name of the instance.', 'type' => 'string', 'required' => true, 'example' => 'ctr_test', 'title' => ''], ], [ - 'name' => 'body', - 'in' => 'body', - 'schema' => [ - 'description' => 'The request parameters.'."\n", - 'type' => 'any', - 'required' => false, - 'example' => '{'."\n" - .' "domain": "GENERAL",'."\n" - .' "category": "",'."\n" - .' "processors": ['."\n" - .' {'."\n" - .' "name": "synonym",'."\n" - .' "useSystemDictionary": true'."\n" - .' },'."\n" - .' {'."\n" - .' "name": "stop_word",'."\n" - .' "useSystemDictionary": true'."\n" - .' }'."\n" - .' ]'."\n" - .'}', - ], + 'name' => 'output', + 'in' => 'query', + 'schema' => ['description' => 'Specifies the richness of returned information. Valid values:'."\n" + ."\n" + .'- simple: displays only the basic information.'."\n" + ."\n" + .'- normal: displays information such as createParameters and cron. This is the default value.'."\n" + ."\n" + .'- detail: returns the details of the training task.', 'type' => 'string', 'required' => false, 'example' => 'detail', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'description' => 'The response parameters.'."\n", + 'description' => 'The response body.', 'type' => 'object', 'properties' => [ - 'requestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => 'D77D0DAF-790D-F5F5-A9C0-133738165014', - ], - 'result' => [ - 'description' => 'The information about the query analysis rule.'."\n", + 'Status' => ['description' => 'The status of the request.', 'type' => 'string', 'example' => 'OK', 'title' => ''], + 'HttpCode' => ['description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int64', 'example' => '200', 'title' => ''], + 'RequestId' => ['description' => 'The ID of the request.', 'type' => 'string', 'example' => '68ED4E1B-92B8-5821-A886-9C90686139EB', 'title' => ''], + 'Message' => ['description' => 'The error message.', 'type' => 'string', 'example' => 'instance not exist.', 'title' => ''], + 'Code' => ['description' => 'The error code. If no error occurs, this parameter is left empty.', 'type' => 'string', 'example' => 'Instance.NotExist', 'title' => ''], + 'Result' => [ + 'description' => 'The details of the instance.', 'type' => 'object', 'properties' => [ - 'created' => [ - 'description' => 'The time when the rule was created.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '0', - ], - 'active' => [ - 'description' => 'Indicates whether the query analysis rule is a default rule.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'updated' => [ - 'description' => 'The time when the rule was updated.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'name' => [ - 'description' => 'The name of the query analysis rule.'."\n", - 'type' => 'string', - 'example' => 'synonym', - ], - 'domain' => [ - 'description' => 'The type of the industry to which the query analysis rule is applied. Valid values:'."\n" - ."\n" - .'* GENERAL'."\n" - .'* ECOMMERCE'."\n" - .'* IT_CONTENT'."\n", - 'type' => 'string', - 'example' => 'GENERAL', + 'Belongs' => [ + 'description' => 'The information about the instance.', + 'type' => 'object', + 'properties' => [ + 'Category' => ['description' => 'The category.', 'type' => 'string', 'example' => 'general', 'title' => ''], + 'Domain' => ['description' => 'The industry.', 'type' => 'string', 'example' => 'ecommerce', 'title' => ''], + 'Language' => ['description' => 'The abbreviation of the language that applies.', 'type' => 'string', 'example' => 'zh', 'title' => ''], + ], + 'title' => '', + 'example' => '', ], - 'indexes' => [ - 'description' => 'The indexes to which the query analysis rule is applied.'."\n", + 'CreateParameters' => [ + 'description' => 'The parameters that are used to create the instance.', 'type' => 'array', 'items' => [ - 'description' => 'The indexes to which the query analysis rule is applied.'."\n", - 'type' => 'string', - 'example' => '[ "default" ]', + 'description' => 'The parameter body.', + 'type' => 'object', + 'properties' => [ + 'Name' => ['description' => 'The name of the parameter.', 'type' => 'string', 'example' => 'param1', 'title' => ''], + 'Value' => ['description' => 'The value of the parameter.', 'type' => 'string', 'example' => 'value1', 'title' => ''], + ], + 'title' => '', + 'example' => '', ], - 'example' => '["default"]', + 'title' => '', + 'example' => '', ], - 'processors' => [ - 'description' => 'The analysis rule.'."\n", + 'UsageParameters' => [ + 'description' => 'The parameters that are used.', 'type' => 'array', 'items' => [ - 'description' => 'The response parameters.'."\n", + 'description' => 'The parameter body.', 'type' => 'object', - 'example' => '[ "default" ]', + 'properties' => [ + 'Name' => ['description' => 'The name of the parameter.', 'type' => 'string', 'example' => 'use_param1', 'title' => ''], + 'Value' => ['description' => 'The value of the parameter.', 'type' => 'string', 'example' => 'value1', 'title' => ''], + ], + 'title' => '', + 'example' => '', ], - 'example' => '[]', + 'title' => '', + 'example' => '', + ], + 'CreateTime' => ['description' => 'The time when the task was created. Unit: milliseconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '1234', 'title' => ''], + 'Cron' => ['description' => 'The cron expression used to schedule training, in the format of (Minutes Hours DayofMonth Month DayofWeek). If the value is empty, it indicates that no periodic training is performed.', 'type' => 'string', 'example' => '0 3 ? * 0,1,3,5 (at 3 a.m. on Sunday, Monday, Wednesday, and Friday)', 'title' => ''], + 'Description' => ['description' => 'The description of the instance.', 'type' => 'string', 'example' => 'instance descriptions', 'title' => ''], + 'ExtendInfo' => ['description' => 'The extended information, which is a JSON string.', 'type' => 'string', 'example' => '{\\"dataReport\\":{},\\"errors\\":{}}', 'title' => ''], + 'FunctionName' => ['description' => 'The name of the feature.', 'type' => 'string', 'example' => 'ctr', 'title' => ''], + 'FunctionType' => ['description' => 'The type of the feature.', 'type' => 'string', 'example' => 'PAAS', 'title' => ''], + 'InstanceName' => ['description' => 'The name of the instance.', 'type' => 'string', 'example' => 'ctr_test', 'title' => ''], + 'ModelType' => ['description' => 'The type of the model.', 'type' => 'string', 'example' => 'tf_checkpoint', 'title' => ''], + 'Source' => ['description' => 'How the instance is created. Valid values:'."\n" + ."\n" + .'- user: The instance is created by user.'."\n" + ."\n" + .'- builtin: The instance is created by the system.', 'type' => 'string', 'example' => 'user', 'title' => ''], + 'Status' => ['description' => 'The status of the instance. Valid values:'."\n" + ."\n" + .'1. unavailable: No model is available. Models must be trained before you can use them.'."\n" + ."\n" + .'2. available: Models can be used.', 'type' => 'string', 'example' => 'available', 'title' => ''], + 'Task' => [ + 'description' => 'The information about the training task. This parameter is not displayed if no task is available.', + 'type' => 'object', + 'properties' => [ + 'DagStatus' => ['description' => 'The status of the task. Valid values:'."\n" + ."\n" + .'- success: succeeded'."\n" + ."\n" + .'- failed: failed'."\n" + ."\n" + .'- untrained: to be trained'."\n" + ."\n" + .'- pending: being scheduled'."\n" + ."\n" + .'- running: being trained', 'type' => 'string', 'example' => 'success', 'title' => ''], + 'LastRunTime' => ['description' => 'The time consumed for the most recent run, in milliseconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '1234', 'title' => ''], + ], + 'title' => '', + 'example' => '', ], + 'VersionId' => ['description' => 'The ID of the version.', 'type' => 'integer', 'format' => 'int64', 'example' => '101', 'title' => ''], ], 'example' => '{}', + 'title' => '', ], + 'Latency' => ['description' => 'The time consumed for the request, in milliseconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '123', 'title' => ''], ], 'example' => '{}', - ], - ], - '5XX' => [ - 'schema' => [ - 'type' => 'object', - 'properties' => [ - 'code' => [ - 'type' => 'string', - ], - 'message' => [ - 'type' => 'string', - ], - 'requestId' => [ - 'type' => 'string', - ], - 'httpCode' => [ - 'type' => 'integer', - 'format' => 'int32', - ], - ], + 'title' => '', ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"requestId\\": \\"D77D0DAF-790D-F5F5-A9C0-133738165014\\",\\n \\"result\\": {\\n \\"created\\": 0,\\n \\"active\\": true,\\n \\"updated\\": 1,\\n \\"name\\": \\"synonym\\",\\n \\"domain\\": \\"GENERAL\\",\\n \\"indexes\\": [\\n \\"[ \\\\\\"default\\\\\\" ]\\"\\n ],\\n \\"processors\\": [\\n [\\n \\"default\\"\\n ]\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"0A6EB64B-B4C8-CF02-810F-E660812972FF\\n\\n query_filter\\n true\\n default\\n \\n synonym\\n true\\n \\n \\n stop_word\\n true\\n \\n GENERAL\\n 1587398402\\n 1587398402\\n","errorExample":""}]', - 'title' => 'ModifyQueryProcessor', - 'requestParamsDescription' => '**Request body**'."\n" - ."\n" - .'|Parameter|Type|Required|Example|Description|'."\n" - .'|---|---|---|---|---|'."\n" - .'|domain|String|No|"GENERAL"|The type of the industry to which the query analysis rule applies. Valid values:GENERAL: General industryECOMMERCE: E-commerceIT\\_CONTENT: IT industry|'."\n" - .'|indexes|Array|No|\\["default"\\]|The indexes to which the query analysis rule applies.|'."\n" - .'|processors\\[\\]|Object|No||The query analysis rule.For more information, see [Processor](~~170014~~).|'."\n" - .'|active|Boolean|No|true|Specifies whether to enable the query analysis rule.|'."\n" + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Status\\": \\"OK\\",\\n \\"HttpCode\\": 200,\\n \\"RequestId\\": \\"68ED4E1B-92B8-5821-A886-9C90686139EB\\",\\n \\"Message\\": \\"instance not exist.\\",\\n \\"Code\\": \\"Instance.NotExist\\",\\n \\"Result\\": {\\n \\"Belongs\\": {\\n \\"Category\\": \\"general\\",\\n \\"Domain\\": \\"ecommerce\\",\\n \\"Language\\": \\"zh\\"\\n },\\n \\"CreateParameters\\": [\\n {\\n \\"Name\\": \\"param1\\",\\n \\"Value\\": \\"value1\\"\\n }\\n ],\\n \\"UsageParameters\\": [\\n {\\n \\"Name\\": \\"use_param1\\",\\n \\"Value\\": \\"value1\\"\\n }\\n ],\\n \\"CreateTime\\": 1234,\\n \\"Cron\\": \\"0 3 ? * 0,1,3,5 (at 3 a.m. on Sunday, Monday, Wednesday, and Friday)\\",\\n \\"Description\\": \\"instance descriptions\\",\\n \\"ExtendInfo\\": \\"{\\\\\\\\\\\\\\"dataReport\\\\\\\\\\\\\\":{},\\\\\\\\\\\\\\"errors\\\\\\\\\\\\\\":{}}\\",\\n \\"FunctionName\\": \\"ctr\\",\\n \\"FunctionType\\": \\"PAAS\\",\\n \\"InstanceName\\": \\"ctr_test\\",\\n \\"ModelType\\": \\"tf_checkpoint\\",\\n \\"Source\\": \\"user\\",\\n \\"Status\\": \\"available\\",\\n \\"Task\\": {\\n \\"DagStatus\\": \\"success\\",\\n \\"LastRunTime\\": 1234\\n },\\n \\"VersionId\\": 101\\n },\\n \\"Latency\\": 123\\n}","type":"json"}]', + 'title' => 'GetFunctionInstance', + 'requestParamsDescription' => '### Sample requests'."\n" ."\n" - .'For more information, see [QueryProcessor](~~170014~~).', - 'responseParamsDescription' => '**Response parameters**'."\n" + .'`GET /v4/openapi/app-groups/my-app/functions/ctr/instances/ctr_test?output=detail`', + 'responseParamsDescription' => '### Sample success responses'."\n" ."\n" - .'|Parameter|Type|Description|'."\n" - .'|---|---|---|'."\n" - .'|requestId|String|The request ID.|'."\n" - .'|result|Object|The information about the rule.For more information, see [QueryProcessor](~~170014~~).|', - 'extraInfo' => "\n", - ], - 'RemoveQueryProcessor' => [ - 'summary' => 'Deletes a query analysis rule for an OpenSearch application version.', - 'path' => '/v4/openapi/app-groups/{appGroupIdentity}/apps/{appId}/query-processors/{name}', - 'methods' => [ - 'delete', + .'```'."\n" + .'{'."\n" + .' "status": "OK",'."\n" + .' "requestId": "",'."\n" + .' "httpCode": 200,'."\n" + .' "code": "",'."\n" + .' "message": "",'."\n" + .' "latency": 123,'."\n" + .' "result": {'."\n" + .' "versionId": 100,'."\n" + .' "instanceName": "ctr_test",'."\n" + .' "functionName": "ctr",'."\n" + .' "functionType": "PAAS",'."\n" + .' "modelType": "tf_checkpoint",'."\n" + .' "Description": "test",'."\n" + .' "status": "available",'."\n" + .' "belongs": {'."\n" + .' "domain": "ecommerce",'."\n" + .' "category": "general",'."\n" + .' "language": "zh"'."\n" + .' },'."\n" + .' "createTime": 100010,'."\n" + .' "createParameters": ['."\n" + .' {'."\n" + .' "name": "param1",'."\n" + .' "value": "val1"'."\n" + .' }'."\n" + .' ],'."\n" + .' "usageParameters": ['."\n" + .' {'."\n" + .' "name": "use_param1",'."\n" + .' "value": "val1"'."\n" + .' }'."\n" + .' ],'."\n" + .' "extendInfo": "{\\"error\\":{},\\"dataReport\\":{}}",'."\n" + .' "cron": "",'."\n" + .' "task": {'."\n" + .' "dagStatus": "running",'."\n" + .' "progress": 30,'."\n" + .' "lastRunTime": 200020'."\n" + .' }'."\n" + .' }'."\n" + .'}'."\n" + .'```', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetFunctionInstance'], + ], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'opensearch:DescribeFunction', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'OpenSearch', 'resourceType' => 'FunctionInstance', 'arn' => 'acs:opensearch:{#regionId}:{#accountId}:apps/{#AppGroupId}'], + ], + ], + ], ], + 'translator' => 'manual', + ], + 'GetFunctionResource' => [ + 'summary' => 'Retrieves the specified algorithm resource.', + 'path' => '/v4/openapi/app-groups/{appGroupIdentity}/functions/{functionName}/resources/{resourceName}', + 'methods' => ['get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'write', + 'produces' => ['application/json'], + 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'delete', - 'riskType' => 'none', - 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREopensearchNCXKUT', - 'FEATUREopensearchUIICM8', - ], + 'operationType' => 'get', + 'abilityTreeCode' => '173353', + 'abilityTreeNodes' => ['FEATUREopensearchZAE4HR'], ], 'parameters' => [ [ 'name' => 'appGroupIdentity', 'in' => 'path', - 'schema' => [ - 'description' => 'The name of the application'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '“my_app_group_name”', - ], + 'schema' => ['title' => '', 'description' => 'The application ID.', 'type' => 'string', 'required' => true, 'example' => 'my_app_group_name'], ], [ - 'name' => 'appId', + 'name' => 'functionName', 'in' => 'path', - 'schema' => [ - 'description' => 'The version number'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'docRequired' => true, - 'example' => '110157886', - ], + 'schema' => ['title' => '', 'description' => 'The feature name.', 'type' => 'string', 'required' => true, 'example' => 'rank'], ], [ - 'name' => 'name', + 'name' => 'resourceName', 'in' => 'path', + 'schema' => ['title' => '', 'description' => 'The instance name.', 'type' => 'string', 'required' => true, 'example' => 'fg_json'], + ], + [ + 'name' => 'output', + 'in' => 'query', 'schema' => [ - 'description' => 'The name of the query analysis rule.'."\n", + 'title' => '', + 'description' => 'The output level.', 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '“test”', + 'required' => false, + 'enum' => ['simple', 'normal', 'detail'], + 'example' => 'detail', ], ], ], @@ -10967,325 +8498,426 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'result' => [ - 'description' => '\\--'."\n", - 'type' => 'string', - 'example' => '[]', - ], - 'requestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '0A6EB64B-B4C8-CF02-810F-E660812972FF', - ], - ], - 'description' => '', - ], - ], - '5XX' => [ - 'schema' => [ - 'type' => 'object', - 'properties' => [ - 'code' => [ - 'type' => 'string', - ], - 'message' => [ - 'type' => 'string', - ], - 'requestId' => [ - 'type' => 'string', - ], - 'httpCode' => [ - 'type' => 'integer', - 'format' => 'int32', + 'Status' => ['description' => 'The status code.'."\n" + ."\n" + .'- OK: The request was successful.'."\n" + ."\n" + .'- FAIL: The request failed.', 'type' => 'string', 'title' => '', 'example' => 'OK'], + 'HttpCode' => ['description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '200'], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'title' => '', 'example' => 'E215C843-0795-5293-AC9A-14FE0723E890'], + 'Message' => ['description' => 'The returned error message.', 'type' => 'string', 'title' => '', 'example' => 'Resource not exist.'], + 'Code' => ['description' => 'The returned error code. This is empty if no error occurred.', 'type' => 'string', 'title' => '', 'example' => 'Resource.NotExist'], + 'Result' => [ + 'description' => 'The returned result.', + 'type' => 'object', + 'properties' => [ + 'CreateTime' => ['description' => 'The time when the resource was created. Unit: milliseconds.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '1234'], + 'Data' => [ + 'description' => 'The resource data. The structure of the data varies based on the resourceType.', + 'type' => 'object', + 'properties' => [ + 'Content' => ['description' => 'The content of the file for a resource of the raw\\_file type.', 'type' => 'string', 'title' => '', 'example' => 'abc'], + 'Generators' => [ + 'description' => 'The list of feature generators for a resource of the feature\\_generator type.', + 'type' => 'array', + 'items' => [ + 'description' => 'The description of the feature generator.', + 'type' => 'object', + 'properties' => [ + 'Generator' => ['description' => 'The type of the feature generator.', 'type' => 'string', 'title' => '', 'example' => 'id'], + 'Input' => [ + 'description' => 'The input.', + 'type' => 'object', + 'properties' => [ + 'Features' => [ + 'description' => 'The list of input features.', + 'type' => 'array', + 'items' => [ + 'description' => 'The input feature.', + 'type' => 'object', + 'properties' => [ + 'Name' => ['description' => 'The feature name.', 'type' => 'string', 'title' => '', 'example' => 'system_item_id'], + 'Type' => ['description' => 'The feature type.', 'type' => 'string', 'title' => '', 'example' => 'item'], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + ], + 'title' => '', + 'example' => '', + ], + 'Output' => ['description' => 'The name of the output feature.', 'type' => 'string', 'title' => '', 'example' => 'output_feature_name'], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + ], + 'title' => '', + 'example' => '', + ], + 'Description' => ['description' => 'The description of the resource.', 'type' => 'string', 'title' => '', 'example' => '""'], + 'FunctionName' => ['description' => 'The feature name.', 'type' => 'string', 'title' => '', 'example' => 'rank'], + 'ModifyTime' => ['description' => 'The time when the resource was last modified. Unit: milliseconds.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '1234'], + 'ReferencedInstances' => [ + 'description' => 'The list of referenced algorithm instance names.', + 'type' => 'array', + 'items' => ['description' => 'The instance name.', 'type' => 'string', 'title' => '', 'example' => 'instance1'], + 'title' => '', + 'example' => '', + ], + 'ResourceName' => ['description' => 'The resource name.', 'type' => 'string', 'title' => '', 'example' => 'fg_json'], + 'ResourceType' => ['description' => 'The resource type.', 'type' => 'string', 'title' => '', 'example' => 'raw_file'], + ], + 'title' => '', + 'example' => '', ], + 'Latency' => ['description' => 'The time consumed by the API request. Unit: milliseconds.', 'type' => 'number', 'format' => 'double', 'title' => '', 'example' => '123'], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"result\\": \\"[]\\",\\n \\"requestId\\": \\"0A6EB64B-B4C8-CF02-810F-E660812972FF\\"\\n}","errorExample":""},{"type":"xml","example":"0A6EB64B-B4C8-CF02-810F-E660812972FF","errorExample":""}]', - 'title' => 'RemoveQueryProcessor', - 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', - ], - 'DescribeQueryProcessor' => [ - 'path' => '/v4/openapi/app-groups/{appGroupIdentity}/apps/{appId}/query-processors/{name}', - 'methods' => [ - 'get', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'GetFunctionResource', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetFunctionResource'], + ], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'opensearch:DescribeFunction', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'OpenSearch', 'resourceType' => 'FunctionResource', 'arn' => 'acs:opensearch:{#regionId}:{#accountId}:apps/{#AppGroupId}'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Status\\": \\"OK\\",\\n \\"HttpCode\\": 200,\\n \\"RequestId\\": \\"E215C843-0795-5293-AC9A-14FE0723E890\\",\\n \\"Message\\": \\"Resource not exist.\\",\\n \\"Code\\": \\"Resource.NotExist\\",\\n \\"Result\\": {\\n \\"CreateTime\\": 1234,\\n \\"Data\\": {\\n \\"Content\\": \\"abc\\",\\n \\"Generators\\": [\\n {\\n \\"Generator\\": \\"id\\",\\n \\"Input\\": {\\n \\"Features\\": [\\n {\\n \\"Name\\": \\"system_item_id\\",\\n \\"Type\\": \\"item\\"\\n }\\n ]\\n },\\n \\"Output\\": \\"output_feature_name\\"\\n }\\n ]\\n },\\n \\"Description\\": \\"\\\\\\"\\\\\\"\\",\\n \\"FunctionName\\": \\"rank\\",\\n \\"ModifyTime\\": 1234,\\n \\"ReferencedInstances\\": [\\n \\"instance1\\"\\n ],\\n \\"ResourceName\\": \\"fg_json\\",\\n \\"ResourceType\\": \\"raw_file\\"\\n },\\n \\"Latency\\": 123\\n}","type":"json"}]', + 'translator' => 'manual', + ], + 'GetFunctionTask' => [ + 'summary' => 'Queries the details of a training task.', + 'path' => '/v4/openapi/app-groups/{appGroupIdentity}/functions/{functionName}/instances/{instanceName}/tasks/{generation}', + 'methods' => ['get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], + 'produces' => ['application/json'], 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [], + 'systemTags' => ['operationType' => 'get'], 'parameters' => [ [ 'name' => 'appGroupIdentity', 'in' => 'path', - 'schema' => [ - 'description' => 'my_app_group_name'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'my_app_group_name', - ], + 'schema' => ['title' => '', 'description' => 'The name of the application.', 'type' => 'string', 'required' => true, 'example' => 'my_app_group_name'], ], [ - 'name' => 'appId', + 'name' => 'functionName', 'in' => 'path', - 'schema' => [ - 'description' => '110157886'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'docRequired' => true, - 'example' => '110157886', - ], + 'schema' => ['title' => '', 'description' => 'The name of the feature.', 'type' => 'string', 'required' => true, 'example' => 'ctr'], ], [ - 'name' => 'name', + 'name' => 'instanceName', 'in' => 'path', - 'schema' => [ - 'description' => 'test'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'test', - ], + 'schema' => ['title' => '', 'description' => 'The name of the instance.', 'type' => 'string', 'required' => true, 'example' => 'test_model_2'], + ], + [ + 'name' => 'generation', + 'in' => 'path', + 'schema' => ['title' => '', 'description' => 'The number of iterations.', 'type' => 'string', 'required' => true, 'example' => '1'], ], ], 'responses' => [ 200 => [ 'schema' => [ + 'description' => 'The schema of the response.', 'type' => 'object', 'properties' => [ - 'requestId' => [ - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => '0A6EB64B-B4C8-CF02-810F-E660812972FF', - ], - 'result' => [ - 'description' => 'The information about the query analysis rule.'."\n", + 'Status' => ['description' => 'The request status.', 'type' => 'string', 'title' => '', 'example' => 'OK'], + 'HttpCode' => ['description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '200'], + 'RequestId' => ['description' => 'The ID of the request.', 'type' => 'string', 'title' => '', 'example' => 'A4D487A9-A456-5AA5-A9C6-B7BF2889CF74'], + 'Message' => ['description' => 'The error message.', 'type' => 'string', 'title' => '', 'example' => 'operation success'], + 'Code' => ['description' => 'The error code.', 'type' => 'string', 'title' => '', 'example' => 'Task.NotExist'], + 'Result' => [ + 'description' => 'The result of the request.', 'type' => 'object', 'properties' => [ - 'created' => [ - 'description' => 'The time when the query analysis rule was created.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1587398402', - ], - 'active' => [ - 'description' => 'Indicates whether the query analysis rule is the default one.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'updated' => [ - 'description' => 'The time when the query analysis rule was last updated.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1587398402', - ], - 'name' => [ - 'description' => 'The name of the query analysis rule.'."\n", - 'type' => 'string', - 'example' => 'test', - ], - 'domain' => [ - 'description' => 'The type of the industry. Valid values:'."\n" - ."\n" - .'* GENERAL'."\n" - .'* ECOMMERCE'."\n" - .'* IT_CONTENT'."\n", - 'type' => 'string', - 'example' => 'GENERAL', - ], - 'indexes' => [ - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'default', - ], - 'description' => 'The indexes to which the query analysis rule applies.'."\n", - ], - 'processors' => [ - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'object', - 'example' => '{}', - ], - 'description' => 'The features that are used in the query analysis rule.'."\n", - ], + 'EndTime' => ['description' => 'The timestamp that indicates the end time of the task. Unit: milliseconds.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '1647213406267'], + 'ExtendInfo' => ['description' => 'The extended information, which is a JSON string.', 'type' => 'string', 'title' => '', 'example' => '{\\"recall\\":91,\\"errors\\":[]}'], + 'FunctionName' => ['description' => 'The name of the feature.', 'type' => 'string', 'title' => '', 'example' => 'ctr'], + 'Generation' => ['description' => 'The number of iterations.', 'type' => 'string', 'title' => '', 'example' => '1'], + 'Progress' => ['description' => 'The progress. 90 indicates 90%.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '90'], + 'RunId' => ['description' => 'The ID of the task.', 'type' => 'string', 'title' => '', 'example' => 'trigger__2021-03-05T12:18:41'], + 'StartTime' => ['description' => 'The timestamp that indicates the start time of the task. Unit: milliseconds.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '1647212220000'], + 'Status' => ['description' => 'The status of the task. Valid values:'."\n" + ."\n" + .'- success'."\n" + ."\n" + .'- failed'."\n" + ."\n" + .'- running', 'type' => 'string', 'title' => '', 'example' => 'success'], ], + 'title' => '', + 'example' => '', ], + 'Latency' => ['description' => 'The time consumed for the request, in milliseconds.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '123'], ], + 'title' => '', + 'example' => '', ], ], - '5XX' => [ - 'schema' => [ - 'type' => 'object', - 'properties' => [ - 'code' => [ - 'type' => 'string', - ], - 'message' => [ - 'type' => 'string', - ], - 'requestId' => [ - 'type' => 'string', - ], - 'httpCode' => [ - 'type' => 'integer', - 'format' => 'int32', - ], + ], + 'title' => 'GetFunctionTask', + 'requestParamsDescription' => '### Sample requests'."\n" + ."\n" + .'`GET /v4/openapi/app-groups/my-app/functions/ctr/instances/ctr_test/tasks/3`', + 'responseParamsDescription' => '### Sample success responses'."\n" + ."\n" + .'```'."\n" + .'{'."\n" + .' "status": "OK",'."\n" + .' "requestId": "",'."\n" + .' "httpCode": 200,'."\n" + .' "code": "",'."\n" + .' "message": "",'."\n" + .' "latency": 123,'."\n" + .' "result": {'."\n" + .' "functionName": "ctr",'."\n" + .' "progress": 100,'."\n" + .' "status": "success",'."\n" + .' "startTime": 100010,'."\n" + .' "endTime": 200020,'."\n" + .' "extendInfo": "{\\"recall\\":91,\\"errors\\":[]}",'."\n" + .' "runId": "trigger__2021-03-05T12:18:41",'."\n" + .' "generation": "3"'."\n" + .' }'."\n" + .'}'."\n" + .'```', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetFunctionTask'], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'opensearch:DescribeFunction', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'OpenSearch', 'resourceType' => 'FunctionTask', 'arn' => 'acs:opensearch:{#regionId}:{#accountId}:apps/{#AppGroupId}'], ], ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"requestId\\": \\"0A6EB64B-B4C8-CF02-810F-E660812972FF\\",\\n \\"result\\": {\\n \\"created\\": 1587398402,\\n \\"active\\": true,\\n \\"updated\\": 1587398402,\\n \\"name\\": \\"test\\",\\n \\"domain\\": \\"GENERAL\\",\\n \\"indexes\\": [\\n \\"default\\"\\n ],\\n \\"processors\\": [\\n \\"{}\\"\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"0A6EB64B-B4C8-CF02-810F-E660812972FF\\n\\n test\\n true\\n default\\n \\n true\\n ner\\n \\n \\n brand\\n HIGH\\n \\n \\n category\\n HIGH\\n \\n \\n material\\n MIDDLE\\n \\n \\n element\\n MIDDLE\\n \\n \\n style\\n MIDDLE\\n \\n \\n color\\n MIDDLE\\n \\n \\n function\\n MIDDLE\\n \\n \\n scenario\\n MIDDLE\\n \\n \\n people\\n MIDDLE\\n \\n \\n season\\n MIDDLE\\n \\n \\n model\\n MIDDLE\\n \\n \\n region\\n MIDDLE\\n \\n \\n name\\n MIDDLE\\n \\n \\n adjective\\n MIDDLE\\n \\n \\n category-modifier\\n MIDDLE\\n \\n \\n size\\n LOW\\n \\n \\n quality\\n LOW\\n \\n \\n suit\\n LOW\\n \\n \\n new-release\\n LOW\\n \\n \\n series\\n LOW\\n \\n \\n marketing\\n LOW\\n \\n \\n entertainment\\n LOW\\n \\n \\n organization\\n LOW\\n \\n \\n movie\\n LOW\\n \\n \\n game\\n LOW\\n \\n \\n number\\n LOW\\n \\n \\n unit\\n LOW\\n \\n \\n common\\n LOW\\n \\n \\n new-word\\n LOW\\n \\n \\n proper-noun\\n LOW\\n \\n \\n symbol\\n LOW\\n \\n \\n prefix\\n LOW\\n \\n \\n suffix\\n LOW\\n \\n \\n gift\\n LOW\\n \\n \\n negative\\n LOW\\n \\n \\n agent\\n LOW\\n \\n \\n \\n true\\n synonym\\n \\n \\n \\n true\\n term_weighting\\n \\n \\n \\n true\\n spell_check\\n \\n \\n \\n category_prediction\\n 60\\n 848\\n \\n GENERAL\\n 1587398402\\n 1587398402\\n","errorExample":""}]', - 'title' => 'DescribeQueryProcessor', - 'summary' => 'Queries the query analysis rule for a version of an OpenSearch application.', - 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Status\\": \\"OK\\",\\n \\"HttpCode\\": 200,\\n \\"RequestId\\": \\"A4D487A9-A456-5AA5-A9C6-B7BF2889CF74\\",\\n \\"Message\\": \\"operation success\\",\\n \\"Code\\": \\"Task.NotExist\\",\\n \\"Result\\": {\\n \\"EndTime\\": 1647213406267,\\n \\"ExtendInfo\\": \\"{\\\\\\\\\\\\\\"recall\\\\\\\\\\\\\\":91,\\\\\\\\\\\\\\"errors\\\\\\\\\\\\\\":[]}\\",\\n \\"FunctionName\\": \\"ctr\\",\\n \\"Generation\\": \\"1\\",\\n \\"Progress\\": 90,\\n \\"RunId\\": \\"trigger__2021-03-05T12:18:41\\",\\n \\"StartTime\\": 1647212220000,\\n \\"Status\\": \\"success\\"\\n },\\n \\"Latency\\": 123\\n}","type":"json"}]', + 'translator' => 'manual', ], - 'ListQueryProcessorNers' => [ - 'summary' => 'Queries the recommended priority settings of entity types for named entity recognition (NER).', - 'path' => '/v4/openapi/query-processor/ner/default-priorities', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'GetFunctionVersion' => [ + 'path' => '/v4/openapi/functions/{functionName}/versions/{versionId}', + 'methods' => ['get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], + 'produces' => ['application/json'], 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'none', - 'riskType' => 'none', - 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREopensearchUIICM8', - 'FEATUREopensearchNCXKUT', - ], - ], + 'systemTags' => ['operationType' => 'get'], 'parameters' => [ [ - 'name' => 'domain', - 'in' => 'query', - 'schema' => [ - 'description' => 'The type of the industry.'."\n" - ."\n" - .'* ECOMMERCE'."\n", - 'type' => 'string', - 'required' => false, - 'docRequired' => true, - 'example' => 'ECOMMERCE', - ], + 'name' => 'functionName', + 'in' => 'path', + 'schema' => ['description' => 'The name of the feature.', 'type' => 'string', 'required' => true, 'example' => 'ctr', 'title' => ''], + ], + [ + 'name' => 'versionId', + 'in' => 'path', + 'schema' => ['description' => 'The ID of the version.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '100', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ + 'description' => 'The response body.', 'type' => 'object', 'properties' => [ - 'requestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '0A6EB64B-B4C8-CF02-810F-E660812972FF', - ], - 'result' => [ - 'description' => 'The priority settings of entity types.'."\n" - ."\n" - .'For more information, see [Priority settings of entity types](~~173616~~).'."\n", - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'tag' => [ - 'description' => 'The internal name of the entity type.'."\n", - 'type' => 'string', - 'example' => 'brand', - ], - 'order' => [ - 'description' => 'The priority of an entity type among entity types that have the same priority level. A smaller value indicates a higher priority. Default value: 0.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'priority' => [ - 'description' => 'The priority level of the entity type. Valid values:'."\n" - ."\n" - .'* HIGH'."\n" - .'* MIDDLE'."\n" - .'* LOW'."\n", - 'type' => 'string', - 'example' => 'HIGH', - ], - 'label' => [ - 'description' => 'The name of the entity type.'."\n", - 'type' => 'string', - 'example' => 'brand', + 'Status' => ['description' => 'The request status.', 'type' => 'string', 'example' => 'OK', 'title' => ''], + 'HttpCode' => ['description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int64', 'example' => '200', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '1638157479281', 'title' => ''], + 'Message' => ['description' => 'The error message.', 'type' => 'string', 'example' => 'version not exist.', 'title' => ''], + 'Code' => ['description' => 'The error code.', 'type' => 'string', 'example' => 'Version.NotExist', 'title' => ''], + 'Result' => [ + 'description' => 'The result body.', + 'type' => 'object', + 'properties' => [ + 'FunctionName' => ['description' => 'The name of the feature.', 'type' => 'string', 'example' => 'ctr', 'title' => ''], + 'FunctionType' => ['description' => 'The type of the feature. Valid values:'."\n" + ."\n" + .'- PAAS'."\n" + ."\n" + .'- SAAS', 'type' => 'string', 'example' => 'PAAS', 'title' => ''], + 'ModelType' => ['description' => 'The type of the model.', 'type' => 'string', 'example' => 'tf_checkpoint', 'title' => ''], + 'VersionConfig' => [ + 'description' => 'The version configuration.', + 'type' => 'object', + 'properties' => [ + 'CreateParameters' => [ + 'description' => 'The parameters that are used to create the instance.', + 'type' => 'array', + 'items' => [ + 'description' => 'The parameter body.', + 'type' => 'object', + 'properties' => [ + 'Name' => ['description' => 'The name of the parameter.', 'type' => 'string', 'example' => 'params1', 'title' => ''], + 'Required' => ['description' => 'Indicates whether the parameter is required.', 'type' => 'string', 'example' => 'true', 'title' => ''], + ], + 'example' => '{}', + 'title' => '', + ], + 'example' => '[ { "name": "params1", "required": "true", "formItemProps": "{\\"required\\": true, \\"pattern?\\": \\"/^[a-zA-Z][a-zA-Z0-9_]{0,29}$/\\"}", "componentProps": "{\\"component\\": \\"Input\\", \\"attributes\\": {\\"defaultValue\\": \\"value1\\"}}" } ]', + 'title' => '', + ], + 'Depends' => [ + 'description' => 'The dependencies of the instance.', + 'type' => 'array', + 'items' => [ + 'description' => 'The parameter body.', + 'type' => 'object', + 'properties' => [ + 'Condition' => ['description' => 'The condition.', 'type' => 'string', 'example' => '""', 'title' => ''], + 'Dependency' => ['description' => 'The dependency.', 'type' => 'string', 'example' => '""', 'title' => ''], + 'Description' => ['description' => 'The description.', 'type' => 'string', 'example' => '""', 'title' => ''], + ], + 'example' => '{}', + 'title' => '', + ], + 'example' => '[ { "dependency": "依赖项", "condition": "条件", "description": "" } ]', + 'title' => '', + ], + 'UsageParameters' => [ + 'description' => 'The parameters that are used during online use of the instance.', + 'type' => 'array', + 'items' => [ + 'description' => 'The parameter body.', + 'type' => 'object', + 'properties' => [ + 'Name' => ['description' => 'The name of the parameter.', 'type' => 'string', 'example' => '""', 'title' => ''], + 'Required' => ['description' => 'Indicates whether the parameter is required.', 'type' => 'string', 'example' => '""', 'title' => ''], + ], + 'example' => '{}', + 'title' => '', + ], + 'example' => '[]', + 'title' => '', + ], ], + 'example' => '{ "createParameters": [ { "name": "params1", "required": "true", "formItemProps": "{\\"required\\": true, \\"pattern?\\": \\"/^[a-zA-Z][a-zA-Z0-9_]{0,29}$/\\"}", "componentProps": "{\\"component\\": \\"Input\\", \\"attributes\\": {\\"defaultValue\\": \\"value1\\"}}" } ], "depends": [ { "dependency": "依赖项", "condition": "条件", "description": "" } ], "usageParameters": [] }', + 'title' => '', ], - 'description' => 'The result'."\n", + 'VersionId' => ['description' => 'The ID of the version.', 'type' => 'integer', 'format' => 'int64', 'example' => '101', 'title' => ''], + 'VersionName' => ['description' => 'The name of the version.', 'type' => 'string', 'example' => 'v1', 'title' => ''], ], + 'example' => '[]', + 'title' => '', ], + 'Latency' => ['description' => 'The request latency.', 'type' => 'integer', 'format' => 'int64', 'example' => '123', 'title' => ''], ], - 'description' => '', + 'example' => '{}', + 'title' => '', ], ], - '5XX' => [ - 'schema' => [ - 'type' => 'object', - 'properties' => [ - 'code' => [ - 'type' => 'string', - ], - 'message' => [ - 'type' => 'string', - ], - 'requestId' => [ - 'type' => 'string', - ], - 'httpCode' => [ - 'type' => 'integer', - 'format' => 'int32', - ], + ], + 'title' => 'GetFunctionVersion', + 'summary' => 'Queries the information about a function version.', + 'requestParamsDescription' => '### Sample request'."\n" + ."\n" + .'`GET /v4/openapi/functions/ctr/version/101`', + 'responseParamsDescription' => '### Sample success response'."\n" + ."\n" + .'```'."\n" + .'{'."\n" + .' "status": "OK",'."\n" + .' "requestId": "",'."\n" + .' "httpCode": 200,'."\n" + .' "code": "",'."\n" + .' "message": "",'."\n" + .' "latency": 123,'."\n" + .' "result": {'."\n" + .' "versionName": "v1",'."\n" + .' "versionId": 101,'."\n" + .' "functionName": "ctr",'."\n" + .' "modelType": "tf_checkpoint",'."\n" + .' "functionType": "PAAS",'."\n" + .' "versionConfig": {'."\n" + .' "createParameters": ['."\n" + .' {'."\n" + .' "name": "params1",'."\n" + .' "required": "true",'."\n" + .' "formItemProps": "{\\"required\\": true, \\"pattern?\\": \\"/^[a-zA-Z][a-zA-Z0-9_]{0,29}$/\\"}",'."\n" + .' "componentProps": "{\\"component\\": \\"Input\\", \\"attributes\\": {\\"defaultValue\\": \\"value1\\"}}"'."\n" + .' }'."\n" + .' ],'."\n" + .' "depends": ['."\n" + .' {'."\n" + .' "dependency": "the dependency",'."\n" + .' "condition": "the condition",'."\n" + .' "description": ""'."\n" + .' }'."\n" + .' ],'."\n" + .' "usageParameters": []'."\n" + .' }'."\n" + .' }'."\n" + .'}'."\n" + .'```', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetFunctionVersion'], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'opensearch:DescribeFunction', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'OpenSearch', 'resourceType' => 'FunctionInstance', 'arn' => 'acs:opensearch:{#regionId}:{#accountId}:apps/{#AppGroupId}'], ], ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"requestId\\": \\"0A6EB64B-B4C8-CF02-810F-E660812972FF\\",\\n \\"result\\": [\\n {\\n \\"tag\\": \\"brand\\",\\n \\"order\\": 1,\\n \\"priority\\": \\"HIGH\\",\\n \\"label\\": \\"品牌\\"\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"0A6EB64B-B4C8-CF02-810F-E660812972FF\\n\\n brand\\n HIGH\\n 1\\n \\n\\n\\n category\\n HIGH\\n 2\\n \\n\\n\\n material\\n MIDDLE\\n 3\\n \\n\\n\\n element\\n MIDDLE\\n 4\\n \\n\\n\\n style\\n MIDDLE\\n 5\\n \\n\\n\\n color\\n MIDDLE\\n 6\\n \\n\\n\\n function\\n MIDDLE\\n 7\\n \\n\\n\\n scenario\\n MIDDLE\\n 8\\n \\n\\n\\n people\\n MIDDLE\\n 9\\n \\n\\n\\n season\\n MIDDLE\\n 10\\n \\n\\n\\n model\\n MIDDLE\\n 11\\n \\n\\n\\n region\\n MIDDLE\\n 12\\n \\n\\n\\n name\\n MIDDLE\\n 13\\n \\n\\n\\n adjective\\n MIDDLE\\n 14\\n \\n\\n\\n category-modifier\\n MIDDLE\\n 15\\n \\n\\n\\n size\\n LOW\\n 16\\n \\n\\n\\n quality\\n LOW\\n 17\\n \\n\\n\\n suit\\n LOW\\n 18\\n \\n\\n\\n new-release\\n LOW\\n 19\\n \\n\\n\\n series\\n LOW\\n 20\\n \\n\\n\\n marketing\\n LOW\\n 21\\n \\n\\n\\n entertainment\\n LOW\\n 22\\n \\n\\n\\n organization\\n LOW\\n 23\\n \\n\\n\\n movie\\n LOW\\n 24\\n \\n\\n\\n game\\n LOW\\n 25\\n \\n\\n\\n number\\n LOW\\n 26\\n \\n\\n\\n unit\\n LOW\\n 27\\n \\n\\n\\n common\\n LOW\\n 28\\n \\n\\n\\n new-word\\n LOW\\n 29\\n \\n\\n\\n proper-noun\\n LOW\\n 30\\n \\n\\n\\n symbol\\n LOW\\n 31\\n \\n\\n\\n prefix\\n LOW\\n 32\\n \\n\\n\\n suffix\\n LOW\\n 33\\n \\n\\n\\n gift\\n LOW\\n 34\\n \\n\\n\\n negative\\n LOW\\n 35\\n \\n\\n\\n agent\\n LOW\\n 36\\n \\n","errorExample":""}]', - 'title' => 'ListQueryProcessorNers', - 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Status\\": \\"OK\\",\\n \\"HttpCode\\": 200,\\n \\"RequestId\\": \\"1638157479281\\",\\n \\"Message\\": \\"version not exist.\\",\\n \\"Code\\": \\"Version.NotExist\\",\\n \\"Result\\": {\\n \\"FunctionName\\": \\"ctr\\",\\n \\"FunctionType\\": \\"PAAS\\",\\n \\"ModelType\\": \\"tf_checkpoint\\",\\n \\"VersionConfig\\": {\\n \\"CreateParameters\\": [\\n {\\n \\"Name\\": \\"params1\\",\\n \\"Required\\": \\"true\\"\\n }\\n ],\\n \\"Depends\\": [\\n {\\n \\"Condition\\": \\"\\\\\\"\\\\\\"\\",\\n \\"Dependency\\": \\"\\\\\\"\\\\\\"\\",\\n \\"Description\\": \\"\\\\\\"\\\\\\"\\"\\n }\\n ],\\n \\"UsageParameters\\": [\\n {\\n \\"Name\\": \\"\\\\\\"\\\\\\"\\",\\n \\"Required\\": \\"\\\\\\"\\\\\\"\\"\\n }\\n ]\\n },\\n \\"VersionId\\": 101,\\n \\"VersionName\\": \\"v1\\"\\n },\\n \\"Latency\\": 123\\n}","type":"json"}]', + 'translator' => 'manual', ], - 'ListQueryProcessorAnalyzerResults' => [ - 'summary' => 'Queries the results of a query analysis test. This API operation is available only to existing applications of OpenSearch Open Source Compatible Edition.', - 'path' => '/v4/openapi/app-groups/{appGroupIdentity}/apps/{appId}/query-processors/{name}/analyze', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'GetScriptFileNames' => [ + 'path' => '/v4/openapi/app-groups/{appGroupIdentity}/apps/{appVersionId}/sort-scripts/{scriptName}/file-names', + 'methods' => ['get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -11293,115 +8925,107 @@ ], 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'none', - 'riskType' => 'none', - 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREopensearchUIICM8', - 'FEATUREopensearchNCXKUT', - ], - ], + 'systemTags' => [], 'parameters' => [ [ - 'name' => 'appGroupIdentity', - 'in' => 'path', - 'schema' => [ - 'description' => 'The name of the application'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'my_app_group_name', - ], - ], - [ - 'name' => 'appId', + 'name' => 'appGroupIdentity', 'in' => 'path', - 'schema' => [ - 'description' => 'The version number.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '"110157886"', - ], + 'schema' => ['description' => 'The name or ID of the application.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'title' => '', 'example' => 'my_app'], ], [ - 'name' => 'name', + 'name' => 'appVersionId', 'in' => 'path', - 'schema' => [ - 'description' => 'The name of the test.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '"test"', - ], + 'schema' => ['description' => 'The ID of the application version.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'title' => '', 'example' => '123456'], ], [ - 'name' => 'text', - 'in' => 'query', - 'schema' => [ - 'description' => 'The text to be tested.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '"abcde"', - ], + 'name' => 'scriptName', + 'in' => 'path', + 'schema' => ['description' => 'The name of the script.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'title' => '', 'example' => 'file_names'], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'description' => 'The response body.'."\n", 'type' => 'object', 'properties' => [ + 'requestId' => ['description' => 'The unique identifier of the request.', 'type' => 'string', 'title' => '', 'example' => 'ABCDEFGH'], 'result' => [ - 'description' => 'The data returned.'."\n", - 'type' => 'object', - 'example' => '{}', - ], - 'RequestId' => [ - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => '98724351-D6B2-5D8A-B089-7FFD1821A7E9', + 'description' => 'The list of scripts.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'createTime' => ['description' => 'The time when the script was created.', 'type' => 'string', 'title' => '', 'example' => '2020-04-02 20:21:14'], + 'fileName' => ['description' => 'The name of the script file.', 'type' => 'string', 'title' => '', 'example' => 'my_cava_script.cava'], + 'modifyTime' => ['description' => 'The time when the script was last modified.', 'type' => 'string', 'title' => '', 'example' => '2020-04-02 21:21:14'], + 'pathName' => ['description' => 'The path of the script.', 'type' => 'string', 'title' => '', 'example' => 'src'], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', ], ], - 'example' => '{}', + 'description' => '', + 'title' => '', + 'example' => '', ], ], '5XX' => [ 'schema' => [ 'type' => 'object', 'properties' => [ - 'code' => [ - 'type' => 'string', - ], - 'message' => [ - 'type' => 'string', - ], - 'requestId' => [ - 'type' => 'string', - ], - 'httpCode' => [ - 'type' => 'integer', - 'format' => 'int32', - ], + 'code' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'message' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'requestId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'httpCode' => ['type' => 'integer', 'format' => 'int32', 'description' => '', 'title' => '', 'example' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"result\\": {},\\n \\"RequestId\\": \\"98724351-D6B2-5D8A-B089-7FFD1821A7E9\\"\\n}","type":"json"}]', - 'title' => 'ListQueryProcessorAnalyzerResults', - ], - 'ListInterventionDictionaries' => [ - 'summary' => '获取用户的干预词典列表', - 'path' => '/v4/openapi/intervention-dictionaries', - 'methods' => [ - 'get', + 'title' => 'GetScriptFileNames', + 'summary' => 'Retrieves the names of all files in a specified script for a specific application version.', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => '```'."\n" + .'Error response'."\n" + .'{'."\n" + .' "requestId" : "ABCDEFGH",'."\n" + .' "code":"ResourceNotFound",'."\n" + .' "message":"The specified script not found.",'."\n" + .' "httpCode":404'."\n" + .'}'."\n" + .'```', + 'extraInfo' => ' ', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => '', + 'ramAction' => [ + 'action' => 'opensearch:DescribeSortScript', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'OpenSearch', 'resourceType' => 'SortScript', 'arn' => 'acs:opensearch:{#regionId}:{#accountId}:apps/{#AppGroupId}'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"ABCDEFGH\\",\\n \\"result\\": [\\n {\\n \\"createTime\\": \\"2020-04-02 20:21:14\\",\\n \\"fileName\\": \\"my_cava_script.cava\\",\\n \\"modifyTime\\": \\"2020-04-02 21:21:14\\",\\n \\"pathName\\": \\"src\\"\\n }\\n ]\\n}","type":"json"}]', + 'translator' => 'manual', + ], + 'GetSearchStrategy' => [ + 'summary' => 'Retrieves the details of a query policy.', + 'path' => '/v4/openapi/app-groups/{appGroupIdentity}/apps/{appId}/search-strategies/{strategyName}', + 'methods' => ['get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -11410,53 +9034,26 @@ 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'list', + 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREopensearchUIICM8', - 'FEATUREopensearchNCXKUT', - ], + 'abilityTreeNodes' => ['FEATUREopensearchBNTDZX'], ], 'parameters' => [ [ - 'name' => 'pageSize', - 'in' => 'query', - 'schema' => [ - 'description' => 'The number of entries to return on each page. Default value: 10.', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '10', - ], + 'name' => 'appGroupIdentity', + 'in' => 'path', + 'schema' => ['description' => 'The ID of the application group.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'title' => '', 'example' => 'my_app_group_name'], ], [ - 'name' => 'pageNumber', - 'in' => 'query', - 'schema' => [ - 'description' => 'The number of the page to return. Default value: 1.', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', - ], + 'name' => 'appId', + 'in' => 'path', + 'schema' => ['description' => 'The application version.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'title' => '', 'example' => '110157886'], ], [ - 'name' => 'types', - 'in' => 'query', - 'schema' => [ - 'description' => 'The type of the intervention dictionary. Valid values:'."\n" - ."\n" - .'* stopword: an intervention dictionary for stop word filtering'."\n" - .'* synonym: an intervention dictionary for synonym configuration'."\n" - .'* correction: an intervention dictionary for spelling correction'."\n" - .'* category_prediction: an intervention dictionary for category prediction'."\n" - .'* ner: an intervention dictionary for named entity recognition (NER)'."\n" - .'* term_weighting: an intervention dictionary for term weight analysis', - 'type' => 'string', - 'required' => false, - 'example' => '["synonym"]', - ], + 'name' => 'strategyName', + 'in' => 'path', + 'schema' => ['description' => 'The policy name.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'title' => '', 'example' => 'default'], ], ], 'responses' => [ @@ -11464,185 +9061,104 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'totalCount' => [ - 'description' => 'The total number of entries returned.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '2', - ], - 'requestId' => [ - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => '0A6EB64B-B4C8-CF02-810F-E660812972FF', - ], - 'result' => [ - 'description' => 'The information about each intervention dictionary.'."\n" - ."\n" - .'For more information, see [InterventionDictionary](~~173608~~).'."\n", - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'created' => [ - 'description' => 'The time when the intervention dictionary was created.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1539158325', - ], - 'type' => [ - 'description' => 'The type of the intervention dictionary. Valid values:'."\n" - ."\n" - .'* stopword: an intervention dictionary for stop word filtering'."\n" - .'* synonym: an intervention dictionary for synonym configuration'."\n" - .'* correction: an intervention dictionary for spelling correction'."\n" - .'* category_prediction: an intervention dictionary for category prediction'."\n" - .'* ner: an intervention dictionary for named entity recognition (NER)'."\n" - .'* term_weighting: an intervention dictionary for term weight analysis'."\n", - 'type' => 'string', - 'example' => 'synonym', - ], - 'analyzer' => [ - 'description' => 'The custom analyzer.'."\n", - 'type' => 'string', - 'example' => '""', - ], - 'name' => [ - 'description' => 'The name of the intervention dictionary.'."\n", - 'type' => 'string', - 'example' => 'tongyici', - ], - 'updated' => [ - 'description' => 'The time when the intervention dictionary was last updated.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1539158313', - ], - 'id' => [ - 'description' => 'The ID of the intervention dictionary.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - ], - ], - ], + 'requestId' => ['description' => 'The request ID.', 'type' => 'string', 'title' => '', 'example' => '5C1C1C45-C64A-AD30-565F-140871D57E5E'], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], '5XX' => [ 'schema' => [ 'type' => 'object', 'properties' => [ - 'code' => [ - 'type' => 'string', - ], - 'requestId' => [ - 'type' => 'string', - ], - 'message' => [ - 'type' => 'string', - ], - 'httpCode' => [ - 'type' => 'integer', - 'format' => 'int32', - ], + 'code' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'message' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'requestId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'httpCode' => ['type' => 'integer', 'format' => 'int32', 'description' => '', 'title' => '', 'example' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"totalCount\\": 2,\\n \\"requestId\\": \\"0A6EB64B-B4C8-CF02-810F-E660812972FF\\",\\n \\"result\\": [\\n {\\n \\"created\\": 1539158325,\\n \\"type\\": \\"synonym\\",\\n \\"analyzer\\": \\"\\\\\\"\\\\\\"\\",\\n \\"name\\": \\"tongyici\\",\\n \\"updated\\": 1539158313,\\n \\"id\\": 1\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"0A6EB64B-B4C8-CF02-810F-E660812972FF\\n2\\n\\n 1\\n tongyici\\n synonym\\n \\n 1539158313\\n 1539158313\\n\\n\\n 2\\n tingyongci\\n stopword\\n \\n 1539158325\\n 1539158325\\n","errorExample":""}]', - 'title' => 'ListInterventionDictionaries', - 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', - ], - 'CreateInterventionDictionary' => [ - 'summary' => 'Create an intervention dictionary.', - 'path' => '/v4/openapi/intervention-dictionaries', - 'methods' => [ - 'post', + 'title' => 'GetSearchStrategy', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'opensearch:DescribeSearchStrategy', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'OpenSearch', 'resourceType' => 'SearchStrategy', 'arn' => 'acs:opensearch:{#regionId}:{#accountId}:apps/{#AppGroupId}'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"5C1C1C45-C64A-AD30-565F-140871D57E5E\\"\\n}","type":"json"}]', + 'translator' => 'manual', + ], + 'GetSortScript' => [ + 'path' => '/v4/openapi/app-groups/{appGroupIdentity}/apps/{appVersionId}/sort-scripts/{scriptName}', + 'methods' => ['get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'readAndWrite', + 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'create', + 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREopensearchNCXKUT', - 'FEATUREopensearchUIICM8', - ], + 'abilityTreeNodes' => ['FEATUREopensearchN8M8WS'], ], 'parameters' => [ [ - 'name' => 'dryRun', - 'in' => 'query', + 'name' => 'appGroupIdentity', + 'in' => 'path', 'schema' => [ - 'description' => 'Specifies whether to perform only a dry run, without performing the actual request. Default value: false.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* **true**'."\n" - .'* **false**'."\n", - 'type' => 'boolean', - 'required' => false, - 'example' => 'false', + 'description' => 'The name or ID of the application.', + 'enumValueTitles' => [], + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'my_app', + 'title' => '', ], ], [ - 'name' => 'body', - 'in' => 'body', - 'style' => 'json', + 'name' => 'scriptName', + 'in' => 'path', 'schema' => [ - 'description' => 'The request body.'."\n", - 'type' => 'object', - 'properties' => [ - 'name' => [ - 'description' => 'The name of the intervention dictionary.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'ner_dict_ec', - ], - 'type' => [ - 'description' => 'The type of the intervention dictionary. Valid values:'."\n" - ."\n" - .'* stopword: an intervention dictionary for stop word filtering.'."\n" - .'* synonym: an intervention dictionary for synonym configuration.'."\n" - .'* correction: an intervention dictionary for spelling correction.'."\n" - .'* category_prediction: an intervention dictionary for category prediction.'."\n" - .'* ner: an intervention dictionary for named entity recognition (NER).'."\n" - .'* term_weighting: an intervention dictionary for term weight analysis.'."\n" - .'* suggest_allowlist: a drop-down suggestion whitelist.'."\n" - .'* suggest_denylist: a drop-down suggestion blacklist.'."\n" - .'* hot_allowlist: a top search whitelist.'."\n" - .'* hot_denylist: a top search blacklist.'."\n" - .'* hint_allowlist: a hint whitelist.'."\n" - .'* hint_denylist: a hint blacklist.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'ner', - ], - 'analyzerType' => [ - 'description' => 'The type of the analyzer. Valid values:'."\n" - ."\n" - .'* MODEL: model-based custom analyzer.'."\n" - .'* SYSTEM: system analyzer.'."\n" - .'* USER: custom analyzer.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'SYSTEM', - ], - ], - 'required' => false, + 'description' => 'The name of the script.', + 'enumValueTitles' => [], + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'script1', + 'title' => '', + ], + ], + [ + 'name' => 'appVersionId', + 'in' => 'path', + 'schema' => [ + 'description' => 'The ID of the application version.', + 'enumValueTitles' => [], + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '160051478', + 'title' => '', ], ], ], @@ -11652,97 +9168,90 @@ 'type' => 'object', 'properties' => [ 'requestId' => [ - 'description' => 'The ID of the request.'."\n", + 'description' => 'The unique ID of the request.', + 'enumValueTitles' => [], 'type' => 'string', - 'example' => '80326EFE-485F-46E7-B291-5A1DD08D2198', + 'example' => 'ABCDEFGH', + 'title' => '', ], 'result' => [ - 'description' => 'The returned results.', + 'description' => 'The details of the script.', 'type' => 'object', 'properties' => [ - 'created' => [ - 'description' => 'The time when the test scenario was created.', - 'type' => 'string', - 'example' => '1591086323', - ], - 'analyzer' => [ - 'description' => 'The custom analyzer.', - 'type' => 'string', - 'example' => 'dianshang', - ], - 'updated' => [ - 'description' => 'The time when the intervention dictionary was last updated.', - 'type' => 'string', - 'example' => '1591086323', - ], + 'scope' => ['description' => 'The applicable scope of the script.', 'type' => 'string', 'example' => 'second_rank', 'title' => ''], + 'createTime' => ['description' => 'The time when the script was created.', 'type' => 'string', 'example' => '2020-04-02 20:21:14', 'title' => ''], + 'status' => ['description' => 'The status of the script. For more information, see the list of script statuses.', 'type' => 'string', 'example' => 'released', 'title' => ''], + 'modifyTime' => ['description' => 'The time when the script was last modified.', 'type' => 'string', 'example' => '2020-04-02 21:21:14', 'title' => ''], 'type' => [ - 'description' => 'The type of the intervention dictionary. Valid values:'."\n" - ."\n" - .'* stopword: an intervention dictionary for stop word filtering'."\n" - .'* synonym: an intervention dictionary for synonym configuration'."\n" - .'* correction: an intervention dictionary for spelling correction'."\n" - .'* category_prediction: an intervention dictionary for category prediction'."\n" - .'* ner: an intervention dictionary for named entity recognition (NER)'."\n" - .'* term_weighting: an intervention dictionary for term weight analysis'."\n", - 'type' => 'string', - 'example' => 'ner', - ], - 'name' => [ - 'description' => 'The name of the test group.'."\n", + 'description' => 'The type of the script.', + 'enumValueTitles' => [], 'type' => 'string', - 'example' => 'testb', + 'example' => 'cava_script', + 'title' => '', ], + 'scriptName' => ['description' => 'The name of the script.', 'type' => 'string', 'example' => 'rank_cava_20230606_v7'."\n", 'title' => ''], + 'description' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], ], + 'title' => '', + 'example' => '', ], ], + 'enumValueTitles' => [], + 'description' => '', + 'title' => '', + 'example' => '', ], ], '5XX' => [ 'schema' => [ 'type' => 'object', 'properties' => [ - 'code' => [ - 'type' => 'string', - ], - 'requestId' => [ - 'type' => 'string', - ], - 'message' => [ - 'type' => 'string', - ], - 'httpCode' => [ - 'type' => 'integer', - 'format' => 'int32', - ], + 'code' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'message' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'requestId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'httpCode' => ['type' => 'integer', 'format' => 'int32', 'description' => '', 'title' => '', 'example' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"requestId\\": \\"80326EFE-485F-46E7-B291-5A1DD08D2198\\",\\n \\"result\\": {\\n \\"created\\": \\"1591086323\\",\\n \\"analyzer\\": \\"dianshang\\",\\n \\"updated\\": \\"1591086323\\",\\n \\"type\\": \\"ner\\",\\n \\"name\\": \\"testb\\"\\n }\\n}","errorExample":""},{"type":"xml","example":"80326EFE-485F-46E7-B291-5A1DD08D2198\\n\\n dianshang\\n 1591086323\\n 1001\\n testb\\n ner\\n 1591086323\\n","errorExample":""}]', - 'title' => 'CreateInterventionDictionary', - 'requestParamsDescription' => '**Request body**'."\n" - ."\n" - .'|Parameter|Type|Required|Example|Description|'."\n" - .'|---|---|---|---|---|'."\n" - .'|name|String|Yes|"my\\_dict"|The name of the intervention dictionary.|'."\n" - .'|type|String|Yes|"ner"|The type of the intervention dictionary.|'."\n" - .'|analyzer|String|No|"my\\_analyzer"|The name of the custom analyzer. This parameter is required if type is set to ner.|'."\n" - .'|analyzerType|String|No|"SYSTEM"|The type of the analyzer.|'."\n" - ."\n\n" - .'For more information, see [InterventionDictionary](~~173608~~).', - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', - ], - 'DescribeInterventionDictionary' => [ - 'summary' => 'Queries the details of an intervention dictionary.', - 'path' => '/v4/openapi/intervention-dictionaries/{name}', - 'methods' => [ - 'get', + 'title' => 'GetSortScript', + 'summary' => 'Retrieves the details of a sort script.', + 'responseParamsDescription' => '```'."\n" + .'{'."\n" + .' "requestId" : "ABCDEFGH",'."\n" + .' "code":"ResourceNotFound",'."\n" + .' "message":"The specified script not found.",'."\n" + .' "httpCode":404'."\n" + .'}'."\n" + .'```', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'opensearch:DescribeSortScript', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'OpenSearch', 'resourceType' => 'App', 'arn' => 'acs:opensearch:{#regionId}:{#accountId}:apps/{#AppGroupId}'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"ABCDEFGH\\",\\n \\"result\\": {\\n \\"scope\\": \\"second_rank\\",\\n \\"createTime\\": \\"2020-04-02 20:21:14\\",\\n \\"status\\": \\"released\\",\\n \\"modifyTime\\": \\"2020-04-02 21:21:14\\",\\n \\"type\\": \\"cava_script\\",\\n \\"scriptName\\": \\"rank_cava_20230606_v7\\\\n\\",\\n \\"description\\": \\"\\"\\n }\\n}","type":"json"}]', + 'translator' => 'manual', + ], + 'GetSortScriptFile' => [ + 'summary' => 'Retrieves the content of a sort script.', + 'path' => '/v4/openapi/app-groups/{appGroupIdentity}/apps/{appVersionId}/sort-scripts/{scriptName}/files/src/{fileName}', + 'methods' => ['get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -11754,22 +9263,28 @@ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREopensearchNCXKUT', - 'FEATUREopensearchUIICM8', - ], + 'abilityTreeNodes' => ['FEATUREopensearchN8M8WS'], ], 'parameters' => [ [ - 'name' => 'name', + 'name' => 'appGroupIdentity', 'in' => 'path', - 'schema' => [ - 'description' => 'The name of the intervention dictionary.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'my_dict', - ], + 'schema' => ['description' => 'The name or ID of the application.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'title' => '', 'example' => 'my_app'], + ], + [ + 'name' => 'scriptName', + 'in' => 'path', + 'schema' => ['description' => 'The name of the script.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'title' => '', 'example' => 'UserScorer.cava'], + ], + [ + 'name' => 'appVersionId', + 'in' => 'path', + 'schema' => ['description' => 'The ID of the application version.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'title' => '', 'example' => '123456'], + ], + [ + 'name' => 'fileName', + 'in' => 'path', + 'schema' => ['description' => 'The name of the script file.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'title' => '', 'example' => 'script1'], ], ], 'responses' => [ @@ -11777,108 +9292,104 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'requestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => 'D7CCF454-472A-030E-F254-604520B028AA', - ], + 'requestId' => ['description' => 'The unique ID of the request.', 'type' => 'string', 'title' => '', 'example' => 'ABCDEFGH'], 'result' => [ - 'description' => 'The details about the intervention dictionary.'."\n", + 'description' => 'The content of the sort script.', 'type' => 'object', 'properties' => [ - 'created' => [ - 'description' => 'The time when the the intervention dictionary was created.'."\n", - 'type' => 'string', - 'example' => '1536233287', - ], - 'analyzer' => [ - 'description' => 'The custom analyzer.'."\n", - 'type' => 'string', - 'example' => '-', - ], - 'updated' => [ - 'description' => 'The time when the the intervention dictionary was modified.'."\n", - 'type' => 'string', - 'example' => '1536233287', - ], - 'type' => [ - 'description' => 'Type'."\n" - ."\n" - .'* stopword: an intervention dictionary for stop word filtering.'."\n" - .'* synonym: an intervention dictionary for synonym configuration.'."\n" - .'* correction: an intervention dictionary for spelling correction.'."\n" - .'* category_prediction: an intervention dictionary for category prediction.'."\n" - .'* ner: an intervention dictionary for named entity recognition.'."\n" - .'* term_weighting: an intervention dictionary for term weight analysis.'."\n", - 'type' => 'string', - 'example' => 'category_prediction', - ], - 'name' => [ - 'description' => 'The name of the the intervention dictionary.'."\n", - 'type' => 'string', - 'example' => 'test', - ], + 'content' => ['description' => 'The content of the script, Base64-encoded.', 'type' => 'string', 'title' => '', 'example' => 'YWJjZGVmZw=='], + 'createTime' => ['description' => 'The time when the script file was created.', 'type' => 'string', 'title' => '', 'example' => '2020-04-02 20:21:14'], + 'modifyTime' => ['description' => 'The time when the script file was last modified.', 'type' => 'string', 'title' => '', 'example' => '2020-04-02 21:21:14'], + 'version' => ['description' => 'The version of the script content.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '123456'], ], + 'title' => '', + 'example' => '', ], ], 'description' => '', + 'title' => '', + 'example' => '', ], ], '5XX' => [ 'schema' => [ 'type' => 'object', 'properties' => [ - 'code' => [ - 'type' => 'string', - ], - 'requestId' => [ - 'type' => 'string', - ], - 'message' => [ - 'type' => 'string', - ], + 'code' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'message' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'requestId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'httpCode' => ['type' => 'integer', 'format' => 'int32', 'description' => '', 'title' => '', 'example' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"requestId\\": \\"D7CCF454-472A-030E-F254-604520B028AA\\",\\n \\"result\\": {\\n \\"created\\": \\"1536233287\\",\\n \\"analyzer\\": \\"-\\",\\n \\"updated\\": \\"1536233287\\",\\n \\"type\\": \\"category_prediction\\",\\n \\"name\\": \\"test\\"\\n }\\n}","errorExample":""},{"type":"xml","example":"D7CCF454-472A-030E-F254-604520B028AA\\n\\n test\\n category_prediction\\n \\n 1536233287\\n 1536233287\\n","errorExample":""}]', - 'title' => 'DescribeInterventionDictionary', - ], - 'RemoveInterventionDictionary' => [ - 'summary' => 'Deletes an intervention dictionary.', - 'path' => '/v4/openapi/intervention-dictionaries/{name}', - 'methods' => [ - 'delete', + 'title' => 'GetSortScriptFile', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => '```'."\n" + .'Error response'."\n" + .'{'."\n" + .' "requestId" : "ABCDEFGH",'."\n" + .' "code":"ResourceNotFound",'."\n" + .' "message":"The specified script not found.",'."\n" + .' "httpCode":404'."\n" + .'}'."\n" + .'```', + 'extraInfo' => ' ', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'opensearch:DescribeSortScript', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'OpenSearch', 'resourceType' => 'SortScript', 'arn' => 'acs:opensearch:{#regionId}:{#accountId}:apps/{#AppGroupId}'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"ABCDEFGH\\",\\n \\"result\\": {\\n \\"content\\": \\"YWJjZGVmZw==\\",\\n \\"createTime\\": \\"2020-04-02 20:21:14\\",\\n \\"modifyTime\\": \\"2020-04-02 21:21:14\\",\\n \\"version\\": 123456\\n }\\n}","type":"json"}]', + 'translator' => 'manual', + ], + 'ListABTestExperiments' => [ + 'path' => '/v4/openapi/app-groups/{appGroupIdentity}/scenes/{sceneId}/groups/{groupId}/experiments', + 'methods' => ['get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'readAndWrite', + 'operationType' => 'read', + 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'delete', + 'operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREopensearchNCXKUT', - 'FEATUREopensearchUIICM8', - ], + 'abilityTreeNodes' => ['FEATUREopensearchE07IML'], ], 'parameters' => [ [ - 'name' => 'name', + 'name' => 'appGroupIdentity', 'in' => 'path', - 'schema' => [ - 'description' => 'The name of the intervention dictionary'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '“my_dict”', - ], + 'schema' => ['description' => 'The application name.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '“my_app_group_name”', 'title' => ''], + ], + [ + 'name' => 'sceneId', + 'in' => 'path', + 'schema' => ['description' => 'The scenario ID.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true, 'maximum' => '999999999', 'minimum' => '-1', 'example' => '13467', 'title' => ''], + ], + [ + 'name' => 'groupId', + 'in' => 'path', + 'schema' => ['description' => 'The group ID.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true, 'maximum' => '999999999', 'minimum' => '-1', 'example' => '20404', 'title' => ''], ], ], 'responses' => [ @@ -11886,89 +9397,84 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'requestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '06BBD41A-5F72-34E4-2DAF-E43B0526051D', - ], + 'requestId' => ['description' => 'The request ID.'."\n", 'type' => 'string', 'example' => 'D77D0DAF-790D-F5F5-A9C0-133738165014', 'title' => ''], 'result' => [ - 'description' => 'The information about the intervention dictionary.'."\n", - 'type' => 'object', - 'properties' => [ - 'created' => [ - 'description' => 'The time when the intervention dictionary was created.'."\n", - 'type' => 'string', - 'example' => '1539158313', - ], - 'analyzer' => [ - 'description' => 'The custom analyzer.'."\n", - 'type' => 'string', - 'example' => '""', - ], - 'updated' => [ - 'description' => 'The time when the the intervention dictionary was modified.'."\n", - 'type' => 'string', - 'example' => '1539158313', - ], - 'type' => [ - 'description' => 'Type'."\n" + 'description' => 'The experiment details.\\'."\n" + .'For more information, see [ABTestExperiment](~~173617~~).'."\n", + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'created' => ['description' => 'The time when the experiment was created.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1588842080', 'title' => ''], + 'params' => ['description' => 'The experiment parameters.'."\n", 'type' => 'object', 'example' => '1', 'title' => ''], + 'traffic' => ['description' => 'The percentage of traffic that is routed to the experiment.'."\n" ."\n" - .'* stopword: an intervention dictionary for stop word filtering.'."\n" - .'* synonym: an intervention dictionary for synonym configuration.'."\n" - .'* correction: an intervention dictionary for spelling correction.'."\n" - .'* category_prediction: an intervention dictionary for category prediction.'."\n" - .'* ner: an intervention dictionary for named entity recognition.'."\n" - .'* term_weighting: an intervention dictionary for term weight analysis.'."\n", - 'type' => 'string', - 'example' => 'synonym', - ], - 'name' => [ - 'description' => 'Parameter'."\n", - 'type' => 'string', - 'example' => 'tongyici', + .'Valid values: \\[0,100]'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '30', 'title' => ''], + 'online' => ['description' => 'Indicates whether the experiment is in effect. Valid values:'."\n" + ."\n" + .'* true'."\n" + .'* false'."\n", 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'name' => ['description' => 'The group alias.'."\n", 'type' => 'string', 'example' => 'test1', 'title' => ''], + 'updated' => ['description' => 'The time when the experiment was last modified.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1588842080', 'title' => ''], + 'id' => ['description' => 'The experiment ID.'."\n", 'type' => 'string', 'example' => '12888', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], + 'title' => '', + 'example' => '', ], ], 'description' => '', + 'title' => '', + 'example' => '', ], ], '5XX' => [ 'schema' => [ 'type' => 'object', 'properties' => [ - 'code' => [ - 'type' => 'string', - ], - 'requestId' => [ - 'type' => 'string', - ], - 'message' => [ - 'type' => 'string', - ], - 'httpCode' => [ - 'type' => 'integer', - 'format' => 'int32', - ], + 'code' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'message' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'requestId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'httpCode' => ['type' => 'integer', 'format' => 'int32', 'description' => '', 'title' => '', 'example' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"requestId\\": \\"06BBD41A-5F72-34E4-2DAF-E43B0526051D\\",\\n \\"result\\": {\\n \\"created\\": \\"1539158313\\",\\n \\"analyzer\\": \\"\\\\\\"\\\\\\"\\",\\n \\"updated\\": \\"1539158313\\",\\n \\"type\\": \\"synonym\\",\\n \\"name\\": \\"tongyici\\"\\n }\\n}","errorExample":""},{"type":"xml","example":"06BBD41A-5F72-34E4-2DAF-E43B0526051D\\n\\n 123\\n testb\\n ner\\n abc\\n 1587957529\\n 1587957529\\n","errorExample":""}]', - 'title' => 'RemoveInterventionDictionary', + 'title' => 'ListABTestExperiments', + 'summary' => 'Queries a list of experiments.', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', - ], - 'ListInterventionDictionaryEntries' => [ - 'summary' => 'Queries the intervention entries in an intervention dictionary.', - 'path' => '/v4/openapi/intervention-dictionaries/{name}/entries', - 'methods' => [ - 'get', + 'extraInfo' => ' ', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'opensearch:ListApp', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'OpenSearch', 'resourceType' => 'AbTestExperiment', 'arn' => 'acs:opensearch:{#regionId}:{#accountId}:apps/{#AppGroupId}'], + ], + ], + ], ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"requestId\\": \\"D77D0DAF-790D-F5F5-A9C0-133738165014\\",\\n \\"result\\": [\\n {\\n \\"created\\": 1588842080,\\n \\"params\\": 1,\\n \\"traffic\\": 30,\\n \\"online\\": true,\\n \\"name\\": \\"test1\\",\\n \\"updated\\": 1588842080,\\n \\"id\\": \\"12888\\"\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"D77D0DAF-790D-F5F5-A9C0-133738165014\\n\\n 12888\\n test1\\n \\n default\\n \\n 1588842080\\n 1588842080\\n true\\n 30\\n","errorExample":""}]', + ], + 'ListABTestFixedFlowDividers' => [ + 'summary' => 'Lists whitelists.', + 'path' => '/v4/openapi/app-groups/{appGroupIdentity}/scenes/{sceneId}/groups/{groupId}/experiments/{experimentId}/fixed-flow-dividers', + 'methods' => ['get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -11977,57 +9483,31 @@ 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'list', + 'operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREopensearch2ESE2N', - ], + 'abilityTreeNodes' => ['FEATUREopensearchE07IML'], ], 'parameters' => [ [ - 'name' => 'name', + 'name' => 'appGroupIdentity', 'in' => 'path', - 'schema' => [ - 'description' => 'The name of the intervention dictionary.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'my_dict', - ], + 'schema' => ['description' => 'The name of the application.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '“my_app_group_name”', 'title' => ''], ], [ - 'name' => 'word', - 'in' => 'query', - 'schema' => [ - 'description' => 'The intervention entry.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'test', - ], + 'name' => 'sceneId', + 'in' => 'path', + 'schema' => ['description' => 'The scenario ID.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true, 'maximum' => '999999999', 'minimum' => '-1', 'example' => '12889', 'title' => ''], ], [ - 'name' => 'pageNumber', - 'in' => 'query', - 'schema' => [ - 'description' => 'The page number. Default value: 1.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'docRequired' => false, - 'example' => '1', - ], + 'name' => 'groupId', + 'in' => 'path', + 'schema' => ['description' => 'The group ID.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true, 'maximum' => '999999999', 'minimum' => '-1', 'example' => '13467', 'title' => ''], ], [ - 'name' => 'pageSize', - 'in' => 'query', - 'schema' => [ - 'description' => 'The number of entries returned per page. Default value: 10.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '10', - ], + 'name' => 'experimentId', + 'in' => 'path', + 'schema' => ['description' => 'The experiment ID.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true, 'maximum' => '999999999', 'minimum' => '-1', 'example' => '20404', 'title' => ''], ], ], 'responses' => [ @@ -12035,237 +9515,87 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'totalCount' => [ - 'description' => 'The total number of entries returned.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '8', - ], - 'requestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '516A02B7-2167-8D92-12D0-B639A2A0F3C5', - ], + 'requestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'D77D0DAF-790D-F5F5-A9C0-133738165014', 'title' => ''], 'result' => [ - 'description' => 'The information about intervention entries.'."\n" - ."\n" - .'For more information, see [InterventionDictionaryEntry](~~173606~~).'."\n", 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'cmd' => [ - 'description' => 'The command. Valid values:'."\n" - ."\n" - .'* add'."\n" - .'* delete'."\n", - 'type' => 'string', - 'example' => 'add', - ], - 'created' => [ - 'description' => 'The timestamp when the intervention entry was created.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1536690285', - ], - 'word' => [ - 'description' => 'The intervention entry.'."\n", - 'type' => 'string', - 'example' => '\\u8fc7\\u513f', - ], - 'relevance' => [ - 'description' => 'The content of an intervention entry for category prediction. The field value consists of key-value pairs. The key in a key-value pair indicates the ID of the category. The value in a key-value pair indicates the relevance to the category. A value of 0 indicates irrelevant. A value of 1 indicates slightly relevant. A value of 2 indicates relevant. Example: {"2":1, "100":0}'."\n", - 'type' => 'object', - 'example' => ' { "100": "0", "200": "2" }', - ], - 'status' => [ - 'description' => 'The status of the intervention entry. Valid value:'."\n" - ."\n" - .'* ACTIVE: The intervention entry takes effect.'."\n", - 'type' => 'string', - 'example' => 'ACTIVE', - ], - 'updated' => [ - 'description' => 'The timestamp when the intervention entry was last updated.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1537348987', - ], - 'tokens' => [ - 'description' => 'The content of the intervention entry for term weight analysis.'."\n", - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'tag' => [ - 'description' => 'The internal name of the identified entity type. Valid values:'."\n" - ."\n" - .'* brand'."\n" - .'* category'."\n" - .'* material'."\n" - .'* element'."\n" - .'* style'."\n" - .'* color'."\n" - .'* function'."\n" - .'* scenario'."\n" - .'* people'."\n" - .'* season'."\n" - .'* model'."\n" - .'* region'."\n" - .'* name'."\n" - .'* adjective'."\n" - .'* category-modifier'."\n" - .'* size'."\n" - .'* quality'."\n" - .'* suit'."\n" - .'* new-release'."\n" - .'* series'."\n" - .'* marketing'."\n" - .'* entertainment'."\n" - .'* organization'."\n" - .'* movie'."\n" - .'* game'."\n" - .'* number'."\n" - .'* unit'."\n" - .'* common'."\n" - .'* new-word'."\n" - .'* proper-noun'."\n" - .'* symbol'."\n" - .'* prefix'."\n" - .'* suffix'."\n" - .'* gift'."\n" - .'* negative'."\n" - .'* agent'."\n", - 'type' => 'string', - 'example' => 'category', - ], - 'token' => [ - 'description' => 'The entity.'."\n", - 'type' => 'string', - 'example' => 'category', - ], - 'order' => [ - 'description' => 'The sequence number.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'tagLabel' => [ - 'description' => 'The description of the internal name of the identified entity type.'."\n", - 'type' => 'string', - 'example' => 'category', - ], - ], - 'description' => '', - ], - ], - ], - 'description' => '', - ], + 'items' => ['description' => 'The whitelist.', 'type' => 'string', 'example' => '[ "D77D0DAF", "133738165014" ]', 'title' => ''], + 'description' => '', + 'title' => '', + 'example' => '', ], ], 'description' => '', + 'title' => '', + 'example' => '', ], ], '5XX' => [ 'schema' => [ 'type' => 'object', 'properties' => [ - 'code' => [ - 'type' => 'string', - ], - 'requestId' => [ - 'type' => 'string', - ], - 'message' => [ - 'type' => 'string', - ], - 'httpCode' => [ - 'type' => 'integer', - 'format' => 'int32', - ], + 'code' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'message' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'requestId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'httpCode' => ['type' => 'integer', 'format' => 'int32', 'description' => '', 'title' => '', 'example' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"totalCount\\": 8,\\n \\"requestId\\": \\"516A02B7-2167-8D92-12D0-B639A2A0F3C5\\",\\n \\"result\\": [\\n {\\n \\"cmd\\": \\"add\\",\\n \\"created\\": 1536690285,\\n \\"word\\": \\"\\\\\\\\u8fc7\\\\\\\\u513f\\",\\n \\"relevance\\": {\\n \\"100\\": \\"0\\",\\n \\"200\\": \\"2\\"\\n },\\n \\"status\\": \\"ACTIVE\\",\\n \\"updated\\": 1537348987,\\n \\"tokens\\": [\\n {\\n \\"tag\\": \\"category\\",\\n \\"token\\": \\"本\\",\\n \\"order\\": 1,\\n \\"tagLabel\\": \\"品类\\"\\n }\\n ]\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"516A02B7-2167-8D92-12D0-B639A2A0F3C5\\n\\n add\\n 过儿\\n 1536690285\\n 1537348987\\n ACTIVE\\n \\n <100>0\\n <200>2\\n \\n\\n\\n add\\n 过\\n 1536690308\\n 1537349055\\n ACTIVE\\n \\n <200>2\\n \\n\\n\\n add\\n 苹\\n 1536683292\\n 1537220498\\n ACTIVE\\n \\n <12>1\\n \\n\\n\\n add\\n 吧\\n 1536690347\\n 1537220498\\n ACTIVE\\n \\n <100>2\\n <200>0\\n \\n\\n\\n add\\n 果\\n 1536690184\\n 1537220498\\n ACTIVE\\n \\n <100>2\\n \\n\\n\\n add\\n 裤子\\n 1537353071\\n 1537353074\\n ACTIVE\\n \\n <100>1\\n <200>2\\n \\n\\n\\n add\\n adfads\\n 1536690258\\n 1537220498\\n ACTIVE\\n \\n <1>1\\n <2>1\\n <3>1\\n \\n\\n\\n add\\n zvzcxv\\n 1536690537\\n 1537220498\\n ACTIVE\\n \\n <100>1\\n \\n\\n8","errorExample":""}]', - 'title' => 'ListInterventionDictionaryEntries', + 'title' => 'ListABTestFixedFlowDividers', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', - ], - 'PushInterventionDictionaryEntries' => [ - 'summary' => 'Accepts the changes in intervention entries.', - 'path' => '/v4/openapi/intervention-dictionaries/{name}/entries/actions/bulk', - 'methods' => [ - 'post', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'opensearch:ListApp', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'OpenSearch', 'resourceType' => 'AbTestExperiment', 'arn' => 'acs:opensearch:{#regionId}:{#accountId}:apps/{#AppGroupId}'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"D77D0DAF-790D-F5F5-A9C0-133738165014\\",\\n \\"result\\": [\\n \\"[ \\\\\\"D77D0DAF\\\\\\", \\\\\\"133738165014\\\\\\" ]\\"\\n ]\\n}","type":"json"}]', + 'translator' => 'manual', + ], + 'ListABTestGroups' => [ + 'summary' => 'Retrieves a list of test groups.', + 'path' => '/v4/openapi/app-groups/{appGroupIdentity}/scenes/{sceneId}/groups', + 'methods' => ['get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], - [ - 'APP' => [], - ], ], - 'operationType' => 'write', + 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'update', + 'operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREopensearchNCXKUT', - 'FEATUREopensearchUIICM8', - ], + 'abilityTreeNodes' => ['FEATUREopensearchE07IML'], ], 'parameters' => [ [ - 'name' => 'name', + 'name' => 'appGroupIdentity', 'in' => 'path', - 'schema' => [ - 'description' => 'The name of the intervention dictionary.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'my_dict', - ], - ], - [ - 'name' => 'dryRun', - 'in' => 'query', - 'schema' => [ - 'description' => 'Specifies whether to check the validity of input parameters. Default value: false.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* **true**: checks only the validity of input parameters.'."\n" - .'* **false**: checks the validity of input parameters and creates an attribution configuration.'."\n", - 'type' => 'boolean', - 'required' => false, - 'example' => 'false', - ], + 'schema' => ['description' => 'The application name.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'title' => '', 'example' => ' “my_app_group_name”'], ], [ - 'name' => 'body', - 'in' => 'body', - 'style' => 'json', - 'schema' => [ - 'description' => 'The request body.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The request body.'."\n", - 'type' => 'object', - 'required' => false, - 'example' => '', - ], - 'required' => false, - 'maxItems' => 100, - ], + 'name' => 'sceneId', + 'in' => 'path', + 'schema' => ['description' => 'The scenario ID.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true, 'maximum' => '999999999', 'minimum' => '-1', 'title' => '', 'example' => '20404'], ], ], 'responses' => [ @@ -12273,82 +9603,81 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'requestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => 'D77D0DAF-790D-F5F5-A9C0-133738165014', - ], + 'requestId' => ['description' => 'The request ID.', 'type' => 'string', 'title' => '', 'example' => 'D77D0DAF-790D-F5F5-A9C0-133738165014'], 'result' => [ - 'description' => 'The returned results.'."\n", + 'description' => 'The test groups.'."\n" + ."\n" + .'For more information, see [ABTestGroup](~~178935~~).', 'type' => 'array', 'items' => [ - 'description' => 'The returned result.'."\n", - 'type' => 'string', - 'example' => '[]', + 'type' => 'object', + 'properties' => [ + 'created' => ['description' => 'The time when the test group was created.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '1588839490'], + 'status' => ['description' => 'The status of the test group. Valid values:'."\n" + ."\n" + .'- 0: Not in effect'."\n" + ."\n" + .'- 1: In effect', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '1'], + 'updated' => ['description' => 'The time when the test group was last modified.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '1588839490'], + 'name' => ['description' => 'The name of the test group.', 'type' => 'string', 'title' => '', 'example' => 'Group_2020-5-7_15:23:3'], + 'id' => ['description' => 'The ID of the test group.', 'type' => 'string', 'title' => '', 'example' => '13466'], + ], + 'description' => '', + 'title' => '', + 'example' => '', ], + 'title' => '', + 'example' => '', ], ], 'description' => '', + 'title' => '', + 'example' => '', ], ], '5XX' => [ 'schema' => [ 'type' => 'object', 'properties' => [ - 'code' => [ - 'type' => 'string', - ], - 'requestId' => [ - 'type' => 'string', - ], - 'message' => [ - 'type' => 'string', - ], - 'httpCode' => [ - 'type' => 'integer', - 'format' => 'int32', - ], + 'code' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'message' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'requestId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'httpCode' => ['type' => 'integer', 'format' => 'int32', 'description' => '', 'title' => '', 'example' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"requestId\\": \\"D77D0DAF-790D-F5F5-A9C0-133738165014\\",\\n \\"result\\": [\\n \\"[]\\"\\n ]\\n}","errorExample":""},{"type":"xml","example":"D77D0DAF-790D-F5F5-A9C0-133738165014","errorExample":""}]', - 'title' => 'PushInterventionDictionaryEntries', - 'requestParamsDescription' => 'Common parameters of the **request body**'."\n" - ."\n" - .'|Parameter|Type|Required|Example|Description|'."\n" - .'|---|---|---|---|---|'."\n" - .'|\\[\\]|Object|Yes||The information about the intervention entry.|'."\n" - .'|\\[\\].cmd|String|Yes|"add"|The command. Valid values:adddelete|'."\n" - .'|\\[\\].word|String|Yes|"Alibaba Cloud"|The intervention entry.|'."\n" - ."\n" - .'Dictionary-specific parameters References:'."\n" - ."\n" - .'* [stopword: an intervention entry for stop word filtering](~~173606~~)'."\n" - .'* [synonym: an intervention entry for synonym configuration](~~173606~~)'."\n" - .'* [correction: an intervention entry for spelling correction](~~173606~~)'."\n" - .'* [term\\_weighting: an intervention dictionary for term weight analysis](~~173606~~)'."\n" - .'* [category\\_prediction: an intervention entry for category prediction](~~173606~~)'."\n" - .'* [ner: an intervention entry for named entity recognition (NER)](~~173606~~)'."\n" - .'* [suggest\\_allowlist: a drop-down suggestion whitelist](~~173606~~)'."\n" - .'* [suggest\\_denylist: a drop-down suggestion blacklist](~~173606~~)'."\n" - .'* [hot\\_allowlist: a top search whitelist](~~173606~~)'."\n" - .'* [hot\\_denylist: a top search blacklist](~~173606~~)'."\n" - .'* [hint\\_allowlist: a hint whitelist](~~173606~~)'."\n" - .'* [hint\\_denylist: a hint blacklist](~~173606~~)', + 'title' => 'ListABTestGroups', + 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', - ], - 'ListInterventionDictionaryRelatedEntities' => [ - 'summary' => 'Queries the resources that are associated with an intervention dictionary. If the intervention dictionary is referenced by query analysis rules, this operation returns all applications that use the intervention dictionary and the information about the query analysis rules.', - 'path' => '/v4/openapi/intervention-dictionaries/{name}/related', - 'methods' => [ - 'get', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'opensearch:ListApp', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'OpenSearch', 'resourceType' => 'AbTestGroup', 'arn' => 'acs:opensearch:{#regionId}:{#accountId}:apps/{#AppGroupId}'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"D77D0DAF-790D-F5F5-A9C0-133738165014\\",\\n \\"result\\": [\\n {\\n \\"created\\": 1588839490,\\n \\"status\\": 1,\\n \\"updated\\": 1588839490,\\n \\"name\\": \\"Group_2020-5-7_15:23:3\\",\\n \\"id\\": \\"13466\\"\\n }\\n ]\\n}","type":"json"}]', + 'translator' => 'manual', + ], + 'ListABTestScenes' => [ + 'path' => '/v4/openapi/app-groups/{appGroupIdentity}/scenes', + 'methods' => ['get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -12357,24 +9686,16 @@ 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'none', + 'operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREopensearchUIICM8', - ], + 'abilityTreeNodes' => ['FEATUREopensearchE07IML'], ], 'parameters' => [ [ - 'name' => 'name', + 'name' => 'appGroupIdentity', 'in' => 'path', - 'schema' => [ - 'description' => 'The name of the intervention dictionary.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'my_dict', - ], + 'schema' => ['description' => 'The name of the application'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'my_app_group_name', 'title' => ''], ], ], 'responses' => [ @@ -12382,64 +9703,88 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'requestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => 'D77D0DAF-790D-F5F5-A9C0-133738165014', - ], + 'requestId' => ['description' => 'The request ID.'."\n", 'type' => 'string', 'example' => 'D77D0DAF-790D-F5F5-A9C0-133738165014', 'title' => ''], 'result' => [ + 'description' => 'The details of the test scenario.'."\n" + ."\n" + .'For more information, see [ABTestScene](~~173618~~).'."\n", 'type' => 'array', 'items' => [ - 'description' => 'The information about each application and each query analysis rule. If no query analysis rule references the intervention dictionary, this value is empty.'."\n", + 'description' => 'The returned data.'."\n", 'type' => 'object', - 'example' => '[]', + 'properties' => [ + 'created' => ['description' => 'The time when the test group was created.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1588836130', 'title' => ''], + 'status' => ['description' => 'The status of the test group. Valid values:'."\n" + ."\n" + .'* 0: not in effect'."\n" + .'* 1: in effect'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'updated' => ['description' => 'The time when the test group was last updated.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1588836129', 'title' => ''], + 'name' => ['description' => 'The alias of the test group.'."\n", 'type' => 'string', 'example' => 'kevintest_2020-5-7_15:21:482', 'title' => ''], + 'id' => ['description' => 'The ID of the test group.'."\n", 'type' => 'string', 'example' => '20404', 'title' => ''], + 'values' => [ + 'description' => 'The name of the test scenario.'."\n", + 'type' => 'array', + 'items' => ['description' => 'The list of scenarios.'."\n", 'type' => 'string', 'example' => '["kevintest2"]', 'title' => ''], + 'title' => '', + 'example' => '', + ], + ], + 'title' => '', + 'example' => '', ], - 'description' => 'The returned results.', + 'title' => '', + 'example' => '', ], ], 'description' => '', + 'title' => '', + 'example' => '', ], ], '5XX' => [ 'schema' => [ 'type' => 'object', 'properties' => [ - 'code' => [ - 'type' => 'string', - ], - 'requestId' => [ - 'type' => 'string', - ], - 'message' => [ - 'type' => 'string', - ], - 'httpCode' => [ - 'type' => 'integer', - 'format' => 'int32', - ], + 'code' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'message' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'requestId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'httpCode' => ['type' => 'integer', 'format' => 'int32', 'description' => '', 'title' => '', 'example' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"requestId\\": \\"D77D0DAF-790D-F5F5-A9C0-133738165014\\",\\n \\"result\\": [\\n \\"[]\\"\\n ]\\n}","errorExample":""},{"type":"xml","example":"65956EC5-71B8-8A21-2F2E-FBE7E7292AD6\\n\\n test_srn_mysql\\n \\n it_content\\n true\\n short_text\\n text_pack\\n short_text_pack\\n \\n true\\n tst\\n stop_word\\n \\n \\n true\\n test_han_jiuduo_2\\n spell_check\\n \\n \\n true\\n test_han_tongyici\\n synonym\\n \\n \\n true\\n \\n term_weighting\\n \\n IT_CONTENT\\n 1585714793\\n 1591163738\\n \\n","errorExample":""}]', - 'title' => 'ListInterventionDictionaryRelatedEntities', + 'title' => 'ListABTestScenes', + 'summary' => 'Queries test scenarios.', 'requestParamsDescription' => ' ', - 'responseParamsDescription' => '|Parameter|Type|Description|'."\n" - .'|---|---|---|'."\n" - .'|result\\[\\].appGroup|String|The name of the application.|'."\n" - .'|result\\[\\].queryProcessor|Object|The information about the rule. For more information, see [QueryProcessor](~~170014~~).|', + 'responseParamsDescription' => ' ', 'extraInfo' => ' ', - ], - 'ListInterventionDictionaryNerResults' => [ - 'summary' => '获取实体识别结果', - 'path' => '/v4/openapi/intervention-dictionaries/{name}/ner-results', - 'methods' => [ - 'get', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'opensearch:ListApp', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'OpenSearch', 'resourceType' => 'AbTestScene', 'arn' => 'acs:opensearch:{#regionId}:{#accountId}:apps/{#AppGroupId}'], + ], + ], + ], ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"requestId\\": \\"D77D0DAF-790D-F5F5-A9C0-133738165014\\",\\n \\"result\\": [\\n {\\n \\"created\\": 1588836130,\\n \\"status\\": 1,\\n \\"updated\\": 1588836129,\\n \\"name\\": \\"kevintest_2020-5-7_15:21:482\\",\\n \\"id\\": \\"20404\\",\\n \\"values\\": [\\n \\"[\\\\\\"kevintest2\\\\\\"]\\"\\n ]\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"D77D0DAF-790D-F5F5-A9C0-133738165014\\n\\n 20404\\n kevintest_2020-5-7_15:21:482\\n 1\\n 1588836130\\n 1588836129\\n kevintest2\\n","errorExample":""}]', + ], + 'ListAppGroups' => [ + 'summary' => 'Queries a list of OpenSearch applications.', + 'path' => '/v4/openapi/app-groups', + 'methods' => ['get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -12448,184 +9793,281 @@ 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'none', + 'operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREopensearchUIICM8', - ], + 'abilityTreeCode' => '55205', + 'abilityTreeNodes' => ['FEATUREopensearchGVH0IN', 'FEATUREopensearch447AAX', 'FEATUREopensearch5OZOSP'], ], 'parameters' => [ + [ + 'name' => 'pageNumber', + 'in' => 'query', + 'schema' => ['description' => 'The page number. Default value: 1.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'title' => '', 'example' => '1'], + ], + [ + 'name' => 'pageSize', + 'in' => 'query', + 'schema' => ['description' => 'The number of entries to return on each page. Default value: 10.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'title' => '', 'example' => '10'], + ], + [ + 'name' => 'instanceId', + 'in' => 'query', + 'schema' => ['description' => 'The ID of the instance. An exact match is performed.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => 'ops-cn-xxxx'], + ], [ 'name' => 'name', - 'in' => 'path', - 'schema' => [ - 'description' => 'The dictionary name.', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'my_dict', - ], + 'in' => 'query', + 'schema' => ['description' => 'The application name.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => 'my_name'], ], [ - 'name' => 'query', + 'name' => 'type', + 'in' => 'query', + 'schema' => ['description' => 'The type of the application. Valid values:'."\n" + ."\n" + .'- standard: a Standard Edition application.'."\n" + ."\n" + .'- enhanced: a Premium Edition application.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => 'standard'], + ], + [ + 'name' => 'sortBy', + 'in' => 'query', + 'schema' => ['description' => 'The sort order. Valid values:'."\n" + ."\n" + .'- 0: Sorts applications by creation time in descending order.'."\n" + ."\n" + .'- 1: Sorts applications by modification time in descending order.'."\n" + ."\n" + .'Default value: 0.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'title' => '', 'example' => '0'], + ], + [ + 'name' => 'resourceGroupId', + 'in' => 'query', + 'schema' => ['description' => 'The ID of the resource group.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => '"110123123"'], + ], + [ + 'name' => 'tags', 'in' => 'query', + 'style' => 'json', 'schema' => [ - 'description' => 'Query keywords.', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '"hello world"', + 'description' => 'A list of tags.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'key' => ['description' => 'The tag key.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => 'foo'], + 'value' => ['description' => 'The tag value.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => 'bar'], + ], + 'required' => false, + 'description' => 'The tag dictionary. ', + 'title' => '', + 'example' => '', + ], + 'required' => false, + 'title' => '', + 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ + 'description' => 'The response body.', 'type' => 'object', 'properties' => [ - 'requestId' => [ - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => '8F780CA8-D4D4-2FFE-B8AC-42040822C554', - ], + 'totalCount' => ['description' => 'The total number of entries returned.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '1'], + 'requestId' => ['description' => 'The request ID.', 'type' => 'string', 'title' => '', 'example' => '0A6EB64B-B4C8-CF02-810F-E660812972FF'], 'result' => [ - 'description' => 'The NER result.'."\n" + 'description' => 'The applications.'."\n" ."\n" - .'For more information, see [InterventionDictionaryEntry](~~173606~~).'."\n", + .'For more information, see [AppGroup](~~170000~~).', 'type' => 'array', 'items' => [ + 'description' => 'The results.', 'type' => 'object', 'properties' => [ - 'tag' => [ - 'description' => 'The internal name of the identified entity type. Valid values:'."\n" - ."\n" - .'* brand'."\n" - .'* category'."\n" - .'* material'."\n" - .'* element'."\n" - .'* style'."\n" - .'* color'."\n" - .'* function'."\n" - .'* scenario'."\n" - .'* people'."\n" - .'* season'."\n" - .'* model'."\n" - .'* region'."\n" - .'* name'."\n" - .'* adjective'."\n" - .'* category-modifier'."\n" - .'* size'."\n" - .'* quality'."\n" - .'* suit'."\n" - .'* new-release'."\n" - .'* series'."\n" - .'* marketing'."\n" - .'* entertainment'."\n" - .'* organization'."\n" - .'* movie'."\n" - .'* game'."\n" - .'* number'."\n" - .'* unit'."\n" - .'* common'."\n" - .'* new-word'."\n" - .'* proper-noun'."\n" - .'* symbol'."\n" - .'* prefix'."\n" - .'* suffix'."\n" - .'* gift'."\n" - .'* negative'."\n" - .'* agent'."\n", - 'type' => 'string', - 'example' => 'category', - ], - 'token' => [ - 'description' => 'The entity.'."\n", - 'type' => 'string', - 'example' => 'eaa73f35-007a-4be7-88c7-37dca4a04ab7', - ], - 'order' => [ - 'description' => 'The sequence number.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', + 'created' => ['description' => 'The timestamp that indicates when the application was created.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '1575442875'], + 'currentVersion' => ['description' => 'The ID of the current online version.', 'type' => 'string', 'title' => '', 'example' => '110116134'], + 'lockMode' => ['description' => 'The lock status. Valid values:'."\n" + ."\n" + .'- Unlock: The instance is not locked.'."\n" + ."\n" + .'- LockByExpiration: The instance is automatically locked after it expires.'."\n" + ."\n" + .'- ManualLock: The instance is manually locked.', 'type' => 'string', 'title' => '', 'example' => 'Unlock'], + 'updated' => ['description' => 'The timestamp that indicates when the application was last updated.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '1578916076'], + 'id' => ['description' => 'The application ID.', 'type' => 'string', 'title' => '', 'example' => '110116134'], + 'chargeType' => ['description' => 'The billing method. Valid values:'."\n" + ."\n" + .'- POSTPAY: pay-as-you-go.'."\n" + ."\n" + .'- PREPAY: subscription.', 'type' => 'string', 'title' => '', 'example' => 'POSTPAY'], + 'hasPendingQuotaReviewTask' => ['description' => 'The quota approval status. Valid values:'."\n" + ."\n" + .'- 0: Normal'."\n" + ."\n" + .'- 1: Pending approval', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '0'], + 'name' => ['description' => 'The application name.', 'type' => 'string', 'title' => '', 'example' => 'os_function_test_v1'], + 'instanceId' => ['description' => 'The instance ID.', 'type' => 'string', 'title' => '', 'example' => '"xxx"'], + 'chargingWay' => ['description' => 'The billing method. Valid values:'."\n" + ."\n" + .'- 1: computing resources'."\n" + ."\n" + .'- 2: queries per second (QPS)', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '1'], + 'type' => ['description' => 'The type of the application. Valid values:'."\n" + ."\n" + .'- standard: a Standard Edition application.'."\n" + ."\n" + .'- enhanced: a Premium Edition application.', 'type' => 'string', 'title' => '', 'example' => 'enhanced'], + 'status' => ['description' => 'The status of the application. Valid values:'."\n" + ."\n" + .'- producing: The application is being created.'."\n" + ."\n" + .'- review\\_pending: The application is pending approval.'."\n" + ."\n" + .'- config\\_pending: The application is pending configuration.'."\n" + ."\n" + .'- normal: The application is running as normal.'."\n" + ."\n" + .'- frozen: The application is frozen.', 'type' => 'string', 'title' => '', 'example' => 'normal'], + 'projectId' => ['description' => 'The name of the A/B test project.', 'type' => 'string', 'title' => '', 'example' => '"xxx"'], + 'switchedTime' => ['description' => 'The timestamp that indicates when the current online version was published.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '0'], + 'commodityCode' => ['description' => 'The commodity code.', 'type' => 'string', 'title' => '', 'example' => 'opensearch'], + 'expireOn' => ['description' => 'The time when the application expires.', 'type' => 'string', 'title' => '', 'example' => '"xxx"'], + 'domain' => ['description' => 'The domain of the application group.', 'type' => 'string', 'title' => '', 'example' => '""'], + 'description' => ['description' => 'The description of the application.', 'type' => 'string', 'title' => '', 'example' => '"xxx"'], + 'produced' => ['description' => 'Indicates whether the application is created. Valid values:'."\n" + ."\n" + .'- 0: The application is being created.'."\n" + ."\n" + .'- 1: The application is created.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '1'], + 'lockedByExpiration' => ['description' => 'Indicates whether the instance is automatically locked after it expires.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '0'], + 'quota' => [ + 'description' => 'The quota information of the application.'."\n" + .'For more information, see [Quota](~~170001~~).', + 'type' => 'object', + 'properties' => [ + 'spec' => ['description' => 'The specifications. Valid values:'."\n" + ."\n" + .'- opensearch.share.junior: Basic'."\n" + ."\n" + .'- opensearch.share.common: Shared General-purpose'."\n" + ."\n" + .'- opensearch.share.compute: Shared Compute-optimized'."\n" + ."\n" + .'- opensearch.share.storage: Shared Storage-optimized'."\n" + ."\n" + .'- opensearch.private.common: Exclusive General-purpose'."\n" + ."\n" + .'- opensearch.private.compute: Exclusive Compute-optimized'."\n" + ."\n" + .'- opensearch.private.storage: Exclusive Storage-optimized', 'type' => 'string', 'title' => '', 'example' => 'opensearch.share.common'], + 'docSize' => ['description' => 'The storage capacity in GB.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '1'], + 'computeResource' => ['description' => 'The computing resources in logical compute units (LCUs).', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '20'], + ], + 'example' => '{}', + 'title' => '', ], - 'tagLabel' => [ - 'description' => 'The description of the internal name of the identified entity type.'."\n", - 'type' => 'string', - 'example' => 'category', + 'tags' => [ + 'description' => 'The tags of the application.', + 'type' => 'array', + 'items' => [ + 'description' => 'The tag.', + 'type' => 'object', + 'properties' => [ + 'key' => ['description' => 'The tag key.', 'type' => 'string', 'title' => '', 'example' => 'foo'], + 'value' => ['description' => 'The tag value.', 'type' => 'string', 'title' => '', 'example' => 'bar'], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', ], + 'engineType' => ['description' => 'The engine type.', 'type' => 'string', 'title' => '', 'example' => 'ha3'], ], - 'description' => 'The result'."\n", + 'example' => '{}', + 'title' => '', ], + 'example' => '[]', + 'title' => '', ], ], + 'example' => '{}', + 'title' => '', ], ], '5XX' => [ 'schema' => [ 'type' => 'object', 'properties' => [ - 'code' => [ - 'type' => 'string', - ], - 'requestId' => [ - 'type' => 'string', - ], - 'message' => [ - 'type' => 'string', - ], - 'httpCode' => [ - 'type' => 'integer', - 'format' => 'int32', - ], + 'code' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'message' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'requestId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'httpCode' => ['type' => 'integer', 'format' => 'int32', 'description' => '', 'title' => '', 'example' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"8F780CA8-D4D4-2FFE-B8AC-42040822C554\\",\\n \\"result\\": [\\n {\\n \\"tag\\": \\"category\\",\\n \\"token\\": \\"milk\\",\\n \\"order\\": 1,\\n \\"tagLabel\\": \\"品类\\"\\n }\\n ]\\n}","type":"json"}]', - 'title' => 'ListInterventionDictionaryNerResults', + 'title' => 'ListAppGroups', + 'description' => '- Filters applications by name, instance ID, and type.'."\n" + ."\n" + .'- Sorts applications by their creation time.'."\n" + ."\n" + .'- Supports paging.', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', - ], - 'EnableSlowQuery' => [ - 'summary' => 'Enables slow query optimization of Optimization Master.', - 'path' => '/v4/openapi/app-groups/{appGroupIdentity}/optimizers/slow-query/actions/enable', - 'methods' => [ - 'post', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], - 'schemes' => [ - 'http', - 'https', - ], - 'security' => [ + 'ramActions' => [ [ - 'AK' => [], + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'opensearch:ListAppGroup', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'OpenSearch', 'resourceType' => 'AppGroup', 'arn' => 'acs:opensearch:{#regionId}:{#accountId}:app-groups/*'], + ], + ], ], ], - 'operationType' => 'write', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'none', - 'riskType' => 'none', - 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREopensearchA0YLTY', - 'FEATUREopensearch9TYTPZ', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"totalCount\\": 1,\\n \\"requestId\\": \\"0A6EB64B-B4C8-CF02-810F-E660812972FF\\",\\n \\"result\\": [\\n {\\n \\"created\\": 1575442875,\\n \\"currentVersion\\": \\"110116134\\",\\n \\"lockMode\\": \\"Unlock\\",\\n \\"updated\\": 1578916076,\\n \\"id\\": \\"110116134\\",\\n \\"chargeType\\": \\"POSTPAY\\",\\n \\"hasPendingQuotaReviewTask\\": 0,\\n \\"name\\": \\"os_function_test_v1\\",\\n \\"instanceId\\": \\"\\\\\\"xxx\\\\\\"\\",\\n \\"chargingWay\\": 1,\\n \\"type\\": \\"enhanced\\",\\n \\"status\\": \\"normal\\",\\n \\"projectId\\": \\"\\\\\\"xxx\\\\\\"\\",\\n \\"switchedTime\\": 0,\\n \\"commodityCode\\": \\"opensearch\\",\\n \\"expireOn\\": \\"\\\\\\"xxx\\\\\\"\\",\\n \\"domain\\": \\"\\\\\\"\\\\\\"\\",\\n \\"description\\": \\"\\\\\\"xxx\\\\\\"\\",\\n \\"produced\\": 1,\\n \\"lockedByExpiration\\": 0,\\n \\"quota\\": {\\n \\"spec\\": \\"opensearch.share.common\\",\\n \\"docSize\\": 1,\\n \\"computeResource\\": 20\\n },\\n \\"tags\\": [\\n {\\n \\"key\\": \\"foo\\",\\n \\"value\\": \\"bar\\"\\n }\\n ],\\n \\"engineType\\": \\"ha3\\"\\n }\\n ]\\n}","type":"json"}]', + 'translator' => 'manual', + ], + 'ListDataCollections' => [ + 'path' => '/v4/openapi/app-groups/{appGroupIdentity}/data-collections', + 'methods' => ['get'], + 'schemes' => ['http', 'https'], + 'security' => [ + [ + 'AK' => [], ], ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'get'], 'parameters' => [ [ 'name' => 'appGroupIdentity', 'in' => 'path', - 'schema' => [ - 'description' => 'The name of the application'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'my_app_group_name', - ], + 'schema' => ['description' => 'The name of the application.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'title' => '', 'example' => 'my_app_group_name'], + ], + [ + 'name' => 'pageNumber', + 'in' => 'query', + 'schema' => ['description' => 'The page number. The default value is 1.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'title' => '', 'example' => '1'], + ], + [ + 'name' => 'pageSize', + 'in' => 'query', + 'schema' => ['description' => 'The number of entries to return on each page. The default value is 10.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'title' => '', 'example' => '10'], ], ], 'responses' => [ @@ -12633,135 +10075,218 @@ 'schema' => [ 'type' => 'object', 'properties' => [ + 'totalCount' => ['description' => 'The total number of entries.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '1'], + 'requestId' => ['description' => 'The ID of the request.', 'type' => 'string', 'title' => '', 'example' => '959D8782-B130-95EB-86CC-1F6ED447981F'], 'result' => [ - 'description' => 'The returned data.'."\n", - 'type' => 'object', - 'example' => '{}', - ], - 'requestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '728E89C6-8673-D39B-39A1-5BA2B56D448F', + 'description' => 'The data collection information.'."\n" + ."\n" + .'For more information, see [DataCollection](~~173605~~).', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'created' => ['description' => 'The time when the data collection was created.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '1581065837'], + 'dataCollectionType' => ['description' => 'The type of data collection.'."\n" + ."\n" + .'- behavior: User behavior data.'."\n" + ."\n" + .'- item\\_info: Item information.'."\n" + ."\n" + .'- industry\\_specific: Industry-specific attributes.', 'type' => 'string', 'title' => '', 'example' => 'BEHAVIOR'], + 'type' => ['description' => 'The type of the data collection client.'."\n" + ."\n" + .'- server'."\n" + ."\n" + .'- web'."\n" + ."\n" + .'- app'."\n" + ."\n" + .'Note: Only server is supported.', 'type' => 'string', 'title' => '', 'example' => 'server'], + 'industryName' => ['description' => 'The name of the industry.'."\n" + ."\n" + .'- general: General.'."\n" + ."\n" + .'- ecommerce: E-commerce.', 'type' => 'string', 'title' => '', 'example' => 'GENERAL'], + 'status' => ['description' => 'The status.'."\n" + ."\n" + .'- 0: Disabled.'."\n" + ."\n" + .'- 1: Enabling.'."\n" + ."\n" + .'- 2: Enabled.'."\n" + ."\n" + .'- 3: Failed.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '2'], + 'updated' => ['description' => 'The time when the data collection was last updated.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '1581065904'], + 'name' => ['description' => 'The name of the data collection.', 'type' => 'string', 'title' => '', 'example' => 'os_function_test_v1'], + 'sundialId' => ['description' => 'The ID of the sundial.', 'type' => 'string', 'title' => '', 'example' => '1755'], + 'id' => ['description' => 'The ID of the data collection.', 'type' => 'string', 'title' => '', 'example' => '286'], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', ], ], 'description' => '', + 'title' => '', + 'example' => '', ], ], '5XX' => [ 'schema' => [ 'type' => 'object', 'properties' => [ - 'code' => [ - 'type' => 'string', - ], - 'message' => [ - 'type' => 'string', - ], - 'requestId' => [ - 'type' => 'string', - ], - 'httpCode' => [ - 'type' => 'integer', - 'format' => 'int32', - ], + 'code' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'httpCode' => ['type' => 'integer', 'format' => 'int32', 'description' => '', 'title' => '', 'example' => ''], + 'requestId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'message' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"result\\": {},\\n \\"requestId\\": \\"728E89C6-8673-D39B-39A1-5BA2B56D448F\\"\\n}","errorExample":""},{"type":"xml","example":"728E89C6-8673-D39B-39A1-5BA2B56D448F\\n","errorExample":""}]', - 'title' => 'EnableSlowQuery', - ], - 'DisableSlowQuery' => [ - 'summary' => '禁用优化大师慢查询服务', - 'path' => '/v4/openapi/app-groups/{appGroupIdentity}/optimizers/slow-query/actions/disable', - 'methods' => [ - 'post', + 'title' => 'ListDataCollections', + 'summary' => 'Lists the data collections for an OpenSearch application.', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'opensearch:ListDataCollections', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'OpenSearch', 'resourceType' => 'DataCollection', 'arn' => 'acs:opensearch:{#regionId}:{#accountId}:apps/{#AppGroupId}'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"totalCount\\": 1,\\n \\"requestId\\": \\"959D8782-B130-95EB-86CC-1F6ED447981F\\",\\n \\"result\\": [\\n {\\n \\"created\\": 1581065837,\\n \\"dataCollectionType\\": \\"BEHAVIOR\\",\\n \\"type\\": \\"server\\",\\n \\"industryName\\": \\"GENERAL\\",\\n \\"status\\": 2,\\n \\"updated\\": 1581065904,\\n \\"name\\": \\"os_function_test_v1\\",\\n \\"sundialId\\": \\"1755\\",\\n \\"id\\": \\"286\\"\\n }\\n ]\\n}","type":"json"}]', + 'translator' => 'manual', + ], + 'ListDataSourceTableFields' => [ + 'path' => '/v4/openapi/assist/data-sources/{dataSourceType}/fields', + 'methods' => ['get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'write', + 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'none', - 'riskType' => 'none', - 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREopensearchA0YLTY', - 'FEATUREopensearch9TYTPZ', - ], - ], + 'systemTags' => ['operationType' => 'get'], 'parameters' => [ [ - 'name' => 'appGroupIdentity', + 'name' => 'dataSourceType', 'in' => 'path', 'schema' => [ - 'description' => 'my_app_group_name'."\n", + 'description' => 'The type of the data source.'."\n" + ."\n" + .'- rds'."\n" + ."\n" + .'- polardb'."\n" + ."\n" + .'- odps'."\n" + ."\n" + .'- mysql'."\n" + ."\n" + .'- drds', 'type' => 'string', 'required' => true, 'docRequired' => true, - 'example' => 'my_app_group_name', + 'enumValueTitles' => ['rds' => 'rds', 'mysql' => 'mysql', 'odps' => 'odps', 'saro' => 'saro', 'polardb' => 'polardb'], + 'title' => '', + 'example' => 'rds', ], ], + [ + 'name' => 'params', + 'in' => 'query', + 'schema' => ['description' => 'The parameters for the data source. The value must be a URL-encoded JSON string.'."\n" + ."\n" + .'The parameters vary based on the data source type. For more information, see:'."\n" + ."\n" + .'- [rds](~~170005~~)'."\n" + ."\n" + .'- [polardb](~~170005~~)'."\n" + ."\n" + .'- [odps](~~170005~~)'."\n" + ."\n" + .'- [mysql](~~173627~~)'."\n" + ."\n" + .'- [drds](~~173627~~)', 'type' => 'string', 'required' => true, 'docRequired' => true, 'title' => '', 'example' => '{}'], + ], + [ + 'name' => 'rawType', + 'in' => 'query', + 'schema' => ['description' => 'Specifies whether to return the original field types of the data source.', 'type' => 'boolean', 'required' => false, 'title' => '', 'example' => 'false'], + ], ], 'responses' => [ 200 => [ 'schema' => [ + 'description' => 'The response body.', 'type' => 'object', 'properties' => [ - 'result' => [ - 'description' => 'The return result.'."\n", - 'type' => 'object', - 'example' => '{}', - ], - 'requestId' => [ - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => '728E89C6-8673-D39B-39A1-5BA2B56D448F', - ], + 'result' => ['description' => 'The collection of fields from the data table.', 'type' => 'object', 'title' => '', 'example' => '{}'], + 'requestId' => ['description' => 'The ID of the request.', 'type' => 'string', 'title' => '', 'example' => '0A6EB64B-B4C8-CF02-810F-E660812972FF'], ], + 'example' => '{}', + 'title' => '', ], ], '5XX' => [ 'schema' => [ 'type' => 'object', 'properties' => [ - 'code' => [ - 'type' => 'string', - ], - 'message' => [ - 'type' => 'string', - ], - 'requestId' => [ - 'type' => 'string', - ], - 'httpCode' => [ - 'type' => 'integer', - 'format' => 'int32', - ], + 'code' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'message' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'requestId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'httpCode' => ['type' => 'integer', 'format' => 'int32', 'description' => '', 'title' => '', 'example' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"result\\": {},\\n \\"requestId\\": \\"728E89C6-8673-D39B-39A1-5BA2B56D448F\\"\\n}","errorExample":""},{"type":"xml","example":"728E89C6-8673-D39B-39A1-5BA2B56D448F\\n","errorExample":""}]', - 'title' => 'DisableSlowQuery', - ], - 'DescribeSlowQueryStatus' => [ - 'summary' => '获取优化大师慢查询开通状态', - 'path' => '/v4/openapi/app-groups/{appGroupIdentity}/optimizers/slow-query', - 'methods' => [ - 'get', + 'title' => 'ListDataSourceTableFields', + 'summary' => 'This internal API retrieves all fields from a specified data table.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'opensearch:ListDataSourceTableFields', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'OpenSearch', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"result\\": {},\\n \\"requestId\\": \\"0A6EB64B-B4C8-CF02-810F-E660812972FF\\"\\n}","type":"json"}]', + 'translator' => 'manual', + ], + 'ListDataSourceTables' => [ + 'path' => '/v4/openapi/assist/data-sources/{dataSourceType}/tables', + 'methods' => ['get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -12769,26 +10294,39 @@ ], 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'none', - 'riskType' => 'none', - 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREopensearchA0YLTY', - 'FEATUREopensearch9TYTPZ', - ], - ], + 'systemTags' => ['operationType' => 'get'], 'parameters' => [ [ - 'name' => 'appGroupIdentity', + 'name' => 'dataSourceType', 'in' => 'path', - 'schema' => [ - 'description' => 'my_app_group_name'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'my_app_group_name', - ], + 'schema' => ['description' => 'The data source type.'."\n" + ."\n" + .'- rds'."\n" + ."\n" + .'- polardb'."\n" + ."\n" + .'- odps'."\n" + ."\n" + .'- mysql'."\n" + ."\n" + .'- drds', 'type' => 'string', 'required' => true, 'docRequired' => true, 'title' => '', 'example' => 'rds'], + ], + [ + 'name' => 'params', + 'in' => 'query', + 'schema' => ['description' => 'The parameters for the data source. The value must be a URL-encoded JSON string.'."\n" + ."\n" + .'The parameters vary based on the data source type. For more information, see:'."\n" + ."\n" + .'- [rds](~~170005~~)'."\n" + ."\n" + .'- [polardb](~~170005~~)'."\n" + ."\n" + .'- [odps](~~170005~~)'."\n" + ."\n" + .'- [mysql](~~173627~~)'."\n" + ."\n" + .'- [drds](~~173627~~)', 'type' => 'string', 'required' => true, 'docRequired' => true, 'title' => '', 'example' => '-'], ], ], 'responses' => [ @@ -12796,621 +10334,782 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'requestId' => [ - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => '5C1C1C45-C64A-AD30-565F-140871D57E5E', - ], + 'requestId' => ['description' => 'The request ID.', 'type' => 'string', 'title' => '', 'example' => '0A6EB64B-B4C8-CF02-810F-E660812972FF'], 'result' => [ - 'description' => 'The return result.'."\n", - 'type' => 'object', - 'properties' => [ - 'region' => [ - 'description' => 'The network type of the slow query optimization service. Valid values:'."\n" - ."\n" - .'* outer: the Internet'."\n" - .'* internal: the internal network'."\n", - 'type' => 'string', - 'example' => 'internal', - ], - 'status' => [ - 'description' => 'The status of the slow query optimization service. Valid values:'."\n" - ."\n" - .'* enabled'."\n" - .'* disabled'."\n" - .'* n/a'."\n", - 'type' => 'string', - 'example' => 'disabled', - ], - 'appGroupId' => [ - 'description' => 'The ID of the application.'."\n", - 'type' => 'string', - 'example' => '100298370', - ], - ], + 'type' => 'array', + 'items' => ['description' => 'A collection of data source tables.', 'type' => 'string', 'title' => '', 'example' => '{}'], + 'description' => '', + 'title' => '', + 'example' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], '5XX' => [ 'schema' => [ 'type' => 'object', 'properties' => [ - 'code' => [ - 'type' => 'string', - ], - 'message' => [ - 'type' => 'string', - ], - 'requestId' => [ - 'type' => 'string', - ], - 'httpCode' => [ - 'type' => 'integer', - 'format' => 'int32', - ], + 'code' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'message' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'requestId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'httpCode' => ['type' => 'integer', 'format' => 'int32', 'description' => '', 'title' => '', 'example' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"requestId\\": \\"5C1C1C45-C64A-AD30-565F-140871D57E5E\\",\\n \\"result\\": {\\n \\"region\\": \\"internal\\",\\n \\"status\\": \\"disabled\\",\\n \\"appGroupId\\": \\"100298370\\"\\n }\\n}","errorExample":""},{"type":"xml","example":"5C1C1C45-C64A-AD30-565F-140871D57E5E\\n\\n internal\\n 100298370\\n disabled\\n","errorExample":""}]', - 'title' => 'DescribeSlowQueryStatus', - ], - 'StartSlowQueryAnalyzer' => [ - 'summary' => '立即进行慢查询分析', - 'path' => '/v4/openapi/app-groups/{appGroupIdentity}/optimizers/slow-query/actions/run', - 'methods' => [ - 'post', + 'title' => 'ListDataSourceTables', + 'summary' => 'Retrieves all data from a specified data source.', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'opensearch:ListDataSourceTables', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'OpenSearch', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"0A6EB64B-B4C8-CF02-810F-E660812972FF\\",\\n \\"result\\": [\\n \\"{}\\"\\n ]\\n}","type":"json"}]', + 'translator' => 'manual', + ], + 'ListFirstRanks' => [ + 'path' => '/v4/openapi/app-groups/{appGroupIdentity}/apps/{appId}/first-ranks', + 'methods' => ['get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'write', + 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'none', + 'operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREopensearchA0YLTY', - 'FEATUREopensearch9TYTPZ', - ], + 'abilityTreeNodes' => ['FEATUREopensearchN8M8WS', 'FEATUREopensearchH8SRT8'], ], 'parameters' => [ [ 'name' => 'appGroupIdentity', 'in' => 'path', - 'schema' => [ - 'description' => '"my_app_group_name"'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '“my_app_group_name”', - ], + 'schema' => ['description' => 'The name of the application.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'my_app_group_name', 'title' => ''], + ], + [ + 'name' => 'appId', + 'in' => 'path', + 'schema' => ['description' => 'The version number of the application.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true, 'example' => '110157886', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ + 'description' => 'The rsponse body.'."\n", 'type' => 'object', 'properties' => [ + 'requestId' => ['description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '0A6EB64B-B4C8-CF02-810F-E660812972FF', 'title' => ''], 'result' => [ - 'description' => 'N/A'."\n", - 'type' => 'object', - 'example' => '{}', - ], - 'requestId' => [ - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => 'D77D0DAF-790D-F5F5-A9C0-133738165014', + 'description' => 'The information about the rough sort expression.'."\n" + ."\n" + .'For more information, see [FirstRank](~~170007~~).'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The result body.'."\n", + 'type' => 'object', + 'properties' => [ + 'created' => ['description' => 'The time when the expression was created.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '0', 'title' => ''], + 'active' => ['description' => 'Specifies whether to set the fine sort expression as the default sort expression.'."\n", 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'description' => ['description' => 'Description'."\n", 'type' => 'string', 'example' => '""', 'title' => ''], + 'updated' => ['description' => 'The time when the expression was updated.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '0', 'title' => ''], + 'name' => ['description' => 'The name.'."\n", 'type' => 'string', 'example' => 'default', 'title' => ''], + 'meta' => [ + 'description' => 'The information about the expression.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The message body'."\n", + 'type' => 'object', + 'properties' => [ + 'arg' => ['description' => 'The parameters that are used by a function in the expression.'."\n" + ."\n" + .'For more information, see [Rough sort functions](~~180765~~).'."\n", 'type' => 'string', 'example' => '""', 'title' => ''], + 'attribute' => ['description' => 'The attribute, feature function, or field to be searched for.'."\n" + ."\n" + .'For more information about supported feature functions, see [Rough sort functions](~~180765~~).'."\n", 'type' => 'string', 'example' => 'static_bm25()', 'title' => ''], + 'weight' => ['description' => 'The weight. Valid values: -100000 to 100000. The value cannot be 0.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + ], + 'example' => '[]', + 'title' => '', + ], + 'example' => '[]', + 'title' => '', + ], + ], + 'example' => '{}', + 'title' => '', + ], + 'example' => '[]', + 'title' => '', ], ], - ], - ], - '5XX' => [ - 'schema' => [ - 'type' => 'object', - 'properties' => [ - 'code' => [ - 'type' => 'string', - ], - 'message' => [ - 'type' => 'string', - ], - 'requestId' => [ - 'type' => 'string', - ], - 'httpCode' => [ - 'type' => 'integer', - 'format' => 'int32', - ], + 'example' => '{}', + 'title' => '', + ], + ], + '5XX' => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'code' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'requestId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'message' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'httpCode' => ['type' => 'integer', 'format' => 'int32', 'description' => '', 'title' => '', 'example' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"result\\": {},\\n \\"requestId\\": \\"D77D0DAF-790D-F5F5-A9C0-133738165014\\"\\n}","errorExample":""},{"type":"xml","example":"D77D0DAF-790D-F5F5-A9C0-133738165014\\n","errorExample":""}]', - 'title' => 'StartSlowQueryAnalyzer', - 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', - ], - 'ListSlowQueryQueries' => [ - 'summary' => '列出优化大师慢查询Query清单', - 'path' => '/v4/openapi/app-groups/{appGroupIdentity}/optimizers/slow-query/categories/{categoryIndex}/queries', - 'methods' => [ - 'get', + 'title' => 'ListFirstRanks', + 'summary' => 'Queries the rough sort expressions that are configured for a version of an OpenSearch application.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'opensearch:ListFirstRank', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'OpenSearch', 'resourceType' => 'FirstRank', 'arn' => 'acs:opensearch:{#regionId}:{#accountId}:apps/{#AppGroupId}'], + ], + ], + ], ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"requestId\\": \\"0A6EB64B-B4C8-CF02-810F-E660812972FF\\",\\n \\"result\\": [\\n {\\n \\"created\\": 0,\\n \\"active\\": true,\\n \\"description\\": \\"\\\\\\"\\\\\\"\\",\\n \\"updated\\": 0,\\n \\"name\\": \\"default\\",\\n \\"meta\\": [\\n {\\n \\"arg\\": \\"\\\\\\"\\\\\\"\\",\\n \\"attribute\\": \\"static_bm25()\\",\\n \\"weight\\": 1\\n }\\n ]\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"0A6EB64B-B4C8-CF02-810F-E660812972FF\\n\\n default\\n \\n true\\n STRUCT\\n \\n static_bm25()\\n \\n 1\\n \\n 0\\n 0\\n","errorExample":""}]', + ], + 'ListFunctionInstances' => [ + 'summary' => 'Lists all instances that match the specified conditions.', + 'path' => '/v4/openapi/app-groups/{appGroupIdentity}/functions/{functionName}/instances', + 'methods' => ['get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], + 'produces' => ['application/json'], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'none', + 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREopensearchA0YLTY', - 'FEATUREopensearch9TYTPZ', - ], + 'abilityTreeNodes' => ['FEATUREopensearch3QPM0K', 'FEATUREopensearchN8M8WS', 'FEATUREopensearchZAE4HR'], ], 'parameters' => [ [ 'name' => 'appGroupIdentity', 'in' => 'path', - 'schema' => [ - 'description' => 'my_app_group_name'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'my_app_group_name', - ], + 'schema' => ['description' => 'The name of the application.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'app_group_name'], ], [ - 'name' => 'categoryIndex', + 'name' => 'functionName', 'in' => 'path', + 'schema' => ['description' => 'The name of the feature.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'ctr'], + ], + [ + 'name' => 'modelType', + 'in' => 'query', + 'schema' => ['description' => 'The type of the model.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => 'tf_checkpoint'], + ], + [ + 'name' => 'functionType', + 'in' => 'query', + 'schema' => ['description' => 'The type of the feature.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => '"PAAS"'], + ], + [ + 'name' => 'source', + 'in' => 'query', + 'schema' => ['description' => 'The source of the instance. Valid values:'."\n" + ."\n" + .'- builtin: The instance is created by the system.'."\n" + ."\n" + .'- user: The instance is created by the user. This is the default value.'."\n" + ."\n" + .'- all: All instances.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => 'user'], + ], + [ + 'name' => 'pageNumber', + 'in' => 'query', + 'schema' => ['description' => 'The page number. The default value is 1.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'required' => false, 'example' => '1'], + ], + [ + 'name' => 'pageSize', + 'in' => 'query', + 'schema' => ['description' => 'The number of entries per page. The default value is 10.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'required' => false, 'example' => '10'], + ], + [ + 'name' => 'output', + 'in' => 'query', 'schema' => [ - 'description' => '0'."\n", + 'description' => 'The level of detail for the returned information. Valid values:'."\n" + ."\n" + .'- normal: Displays information such as createParameters and cron. This is the default value.'."\n" + ."\n" + .'- simple: Displays only basic information.'."\n" + ."\n" + .'- detail: Returns the details of the training task.', + 'enumValueTitles' => [], 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '0', + 'title' => '', + 'required' => false, + 'example' => 'normal', ], ], ], 'responses' => [ 200 => [ 'schema' => [ + 'description' => 'The response body.', 'type' => 'object', 'properties' => [ - 'requestId' => [ - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => 'EB250CA0-ACFD-C5DE-17CD-01445BFE8AE5', - ], - 'result' => [ - 'description' => 'The return result.'."\n", - 'type' => 'object', - 'properties' => [ - 'index' => [ - 'description' => 'The ID of the optimization suggestion.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '0', - ], - 'appQuery' => [ - 'description' => 'The content of the optimization suggestion for the query.'."\n", - 'type' => 'string', - 'example' => 'no data', - ], - 'start' => [ - 'description' => 'The beginning of the time range that was queried.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1589986800', - ], - 'end' => [ - 'description' => 'The end of the time range that was queried.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1589990340', + 'Status' => ['description' => 'The status of the request.', 'type' => 'string', 'example' => '"OK"', 'title' => ''], + 'HttpCode' => ['description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int64', 'example' => '200', 'title' => ''], + 'TotalCount' => ['description' => 'The total number of entries.', 'type' => 'integer', 'format' => 'int64', 'example' => '2', 'title' => ''], + 'RequestId' => ['description' => 'The ID of the request.', 'type' => 'string', 'example' => 'A4D487A9-A456-5AA5-A9C6-B7BF2889CF74', 'title' => ''], + 'Message' => ['description' => 'The error message. This parameter is empty if the request is successful.', 'type' => 'string', 'example' => 'instance not exist.', 'title' => ''], + 'Code' => ['description' => 'The error code. This parameter is empty if the request is successful.', 'type' => 'string', 'example' => 'Instance.NotExist', 'title' => ''], + 'Result' => [ + 'description' => 'The list of instances.', + 'type' => 'array', + 'items' => [ + 'description' => 'The information about the instance.', + 'type' => 'object', + 'properties' => [ + 'Belongs' => [ + 'description' => 'The ownership information of the instance.', + 'type' => 'object', + 'properties' => [ + 'Category' => ['description' => 'The category.', 'type' => 'string', 'example' => '"general"', 'title' => ''], + 'Domain' => ['description' => 'The industry.', 'type' => 'string', 'example' => '"ecommerce"', 'title' => ''], + 'Language' => ['description' => 'The language code.', 'type' => 'string', 'example' => '"zh" ', 'title' => ''], + ], + 'example' => '{}', + 'title' => '', + ], + 'CreateParameters' => [ + 'description' => 'The list of parameters for the instance.', + 'type' => 'array', + 'items' => [ + 'description' => 'The parameter body.', + 'type' => 'object', + 'properties' => [ + 'Name' => ['description' => 'The name of the parameter.', 'type' => 'string', 'example' => '"param1"', 'title' => ''], + 'Value' => ['description' => 'The value of the parameter.', 'type' => 'string', 'example' => '"value1"', 'title' => ''], + ], + 'example' => '{}', + 'title' => '', + ], + 'example' => '[]', + 'title' => '', + ], + 'UsageParameters' => [ + 'description' => 'The list of parameters in use.', + 'type' => 'array', + 'items' => [ + 'description' => 'The parameter body.', + 'type' => 'object', + 'properties' => [ + 'Name' => ['description' => 'The name of the parameter.', 'type' => 'string', 'example' => 'use_param1', 'title' => ''], + 'Value' => ['description' => 'The value of the parameter.', 'type' => 'string', 'example' => 'value1', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + 'CreateTime' => ['description' => 'The time when the instance was created.', 'type' => 'integer', 'format' => 'int64', 'example' => '1234', 'title' => ''], + 'Cron' => ['description' => 'The training schedule. This is a cron expression in the format of Minutes Hours DayofMonth Month DayofWeek. If this parameter is empty, periodic training is not performed.', 'type' => 'string', 'example' => '0 3 ? * 0,1,3,5 (周日，周一，周三，周五凌晨3点)', 'title' => ''], + 'Description' => ['description' => 'The description.', 'type' => 'string', 'example' => '" "', 'title' => ''], + 'ExtendInfo' => ['description' => 'The extended information. This is a JSON string that contains information such as model evaluation results and error messages.', 'type' => 'string', 'example' => '"{\\"dataReport\\":{},\\"errors\\":{}}"', 'title' => ''], + 'FunctionName' => ['description' => 'The name of the feature.', 'type' => 'string', 'example' => '"ctr"', 'title' => ''], + 'FunctionType' => ['description' => 'The type of the feature.', 'type' => 'string', 'example' => '"PAAS"', 'title' => ''], + 'InstanceName' => ['description' => 'The name of the instance.', 'type' => 'string', 'example' => '"ctr_test"', 'title' => ''], + 'ModelType' => ['description' => 'The type of the model.', 'type' => 'string', 'example' => '"tf_checkpoint"', 'title' => ''], + 'Source' => ['description' => 'The source of the instance. Valid values:'."\n" + ."\n" + .'- user: The instance is created by the user.'."\n" + ."\n" + .'- builtin: The instance is created by the system.', 'type' => 'string', 'example' => '"user"', 'title' => ''], + 'Status' => ['description' => 'The status of the instance. Valid values:'."\n" + ."\n" + .'1. unavailable: No model is available. You must train a model before you can use the instance.'."\n" + ."\n" + .'2. available: The instance is available.', 'type' => 'string', 'example' => 'available', 'title' => ''], + 'VersionId' => ['description' => 'The version ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '123', 'title' => ''], ], + 'example' => '{}', + 'title' => '', ], + 'example' => '[]', + 'title' => '', ], + 'Latency' => ['description' => 'The request latency, in milliseconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '123', 'title' => ''], ], + 'title' => '', + 'example' => '', ], ], - '5XX' => [ - 'schema' => [ - 'type' => 'object', - 'properties' => [ - 'code' => [ - 'type' => 'string', - ], - 'message' => [ - 'type' => 'string', - ], - 'requestId' => [ - 'type' => 'string', - ], - 'httpCode' => [ - 'type' => 'integer', - 'format' => 'int32', - ], + ], + 'title' => 'ListFunctionInstances', + 'requestParamsDescription' => '### Examples'."\n" + ."\n" + .'`GET /v4/openapi/app-groups/my-app/functions/ctr/instances?source=all&output=simple`', + 'responseParamsDescription' => '### Sample success responses'."\n" + ."\n" + .'```'."\n" + .'{'."\n" + .' "status": "OK",'."\n" + .' "requestId": "A4D487A9-A456-5AA5-A9C6-B7BF2889CF74",'."\n" + .' "httpCode": 200,'."\n" + .' "code": "",'."\n" + .' "message": "",'."\n" + .' "latency": 123,'."\n" + .' "totalCount": 2,'."\n" + .' "result": ['."\n" + .' {'."\n" + .' "versionId": 100,'."\n" + .' "instanceName": "instance_1",'."\n" + .' "functionName": "hot",'."\n" + .' "functionType": "PAAS",'."\n" + .' "modelType": "offline_inference",'."\n" + .' "description": "",'."\n" + .' "status": "available",'."\n" + .' "belongs": {'."\n" + .' "domain": "ecommerce",'."\n" + .' "category": "general",'."\n" + .' "language": "zh"'."\n" + .' },'."\n" + .' "createTime": 100010,'."\n" + .' "source": "user"'."\n" + .' },'."\n" + .' {'."\n" + .' "versionId": 100,'."\n" + .' "instanceName": "instance_2",'."\n" + .' "functionName": "hot",'."\n" + .' "functionType": "PAAS",'."\n" + .' "modelType": "offline_inference",'."\n" + .' "description": "",'."\n" + .' "status": "available",'."\n" + .' "belongs": {'."\n" + .' "domain": "ecommerce",'."\n" + .' "category": "general",'."\n" + .' "language": "zh"'."\n" + .' },'."\n" + .' "createTime": 200020,'."\n" + .' "source": "user",'."\n" + .' "default": true'."\n" + .' }'."\n" + .' ]'."\n" + .'}'."\n" + .'```', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListFunctionInstances'], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'opensearch:DescribeFunction', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'OpenSearch', 'resourceType' => 'FunctionInstance', 'arn' => 'acs:opensearch:{#regionId}:{#accountId}:apps/{#AppGroupId}'], ], ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"requestId\\": \\"EB250CA0-ACFD-C5DE-17CD-01445BFE8AE5\\",\\n \\"result\\": {\\n \\"index\\": 0,\\n \\"appQuery\\": \\"no data\\",\\n \\"start\\": 1589986800,\\n \\"end\\": 1589990340\\n }\\n}","errorExample":""},{"type":"xml","example":"EB250CA0-ACFD-C5DE-17CD-01445BFE8AE5\\n\\n 1589986800\\n 1589990340\\n 0\\n no data\\n","errorExample":""}]', - 'title' => 'ListSlowQueryQueries', - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Status\\": \\"\\\\\\"OK\\\\\\"\\",\\n \\"HttpCode\\": 200,\\n \\"TotalCount\\": 2,\\n \\"RequestId\\": \\"A4D487A9-A456-5AA5-A9C6-B7BF2889CF74\\",\\n \\"Message\\": \\"instance not exist.\\",\\n \\"Code\\": \\"Instance.NotExist\\",\\n \\"Result\\": [\\n {\\n \\"Belongs\\": {\\n \\"Category\\": \\"\\\\\\"general\\\\\\"\\",\\n \\"Domain\\": \\"\\\\\\"ecommerce\\\\\\"\\",\\n \\"Language\\": \\"\\\\\\"zh\\\\\\"\\\\t\\"\\n },\\n \\"CreateParameters\\": [\\n {\\n \\"Name\\": \\"\\\\\\"param1\\\\\\"\\",\\n \\"Value\\": \\"\\\\\\"value1\\\\\\"\\"\\n }\\n ],\\n \\"UsageParameters\\": [\\n {\\n \\"Name\\": \\"use_param1\\",\\n \\"Value\\": \\"value1\\"\\n }\\n ],\\n \\"CreateTime\\": 1234,\\n \\"Cron\\": \\"0 3 ? * 0,1,3,5 (周日，周一，周三，周五凌晨3点)\\",\\n \\"Description\\": \\"\\\\\\" \\\\\\"\\",\\n \\"ExtendInfo\\": \\"\\\\\\"{\\\\\\\\\\\\\\"dataReport\\\\\\\\\\\\\\":{},\\\\\\\\\\\\\\"errors\\\\\\\\\\\\\\":{}}\\\\\\"\\",\\n \\"FunctionName\\": \\"\\\\\\"ctr\\\\\\"\\",\\n \\"FunctionType\\": \\"\\\\\\"PAAS\\\\\\"\\",\\n \\"InstanceName\\": \\"\\\\\\"ctr_test\\\\\\"\\",\\n \\"ModelType\\": \\"\\\\\\"tf_checkpoint\\\\\\"\\",\\n \\"Source\\": \\"\\\\\\"user\\\\\\"\\",\\n \\"Status\\": \\"available\\",\\n \\"VersionId\\": 123\\n }\\n ],\\n \\"Latency\\": 123\\n}","type":"json"}]', + 'translator' => 'manual', ], - 'ListSlowQueryCategories' => [ - 'summary' => 'Queries the suggestions that are provided by Optimization Master for slow queries.', - 'path' => '/v4/openapi/app-groups/{appGroupIdentity}/optimizers/slow-query/categories', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'ListFunctionResources' => [ + 'summary' => 'Lists the algorithm resources.', + 'path' => '/v4/openapi/app-groups/{appGroupIdentity}/functions/{functionName}/resources', + 'methods' => ['get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], + 'produces' => ['application/json'], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'none', - 'riskType' => 'none', - 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREopensearchA0YLTY', - 'FEATUREopensearch9TYTPZ', - ], + 'operationType' => 'list', + 'abilityTreeCode' => '173357', + 'abilityTreeNodes' => ['FEATUREopensearch447AAX'], ], 'parameters' => [ [ 'name' => 'appGroupIdentity', 'in' => 'path', + 'schema' => ['title' => '', 'description' => 'The application ID.', 'type' => 'string', 'required' => true, 'example' => 'my_app_group_name'], + ], + [ + 'name' => 'functionName', + 'in' => 'path', + 'schema' => ['title' => '', 'description' => 'The function name.', 'type' => 'string', 'required' => true, 'example' => 'rank'], + ], + [ + 'name' => 'resourceType', + 'in' => 'query', 'schema' => [ - 'description' => 'The name of the application'."\n", + 'title' => '', + 'description' => 'The resource type.', 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'my_app_group_name', + 'required' => false, + 'enumValueTitles' => ['feature_generator' => 'feature\\_generator', 'raw_file' => 'raw\\_file'], + 'example' => 'feature_generator', + ], + ], + [ + 'name' => 'output', + 'in' => 'query', + 'schema' => [ + 'title' => '', + 'description' => 'The output level.', + 'type' => 'string', + 'required' => false, + 'enum' => ['simple', 'normal', 'detail'], + 'example' => 'detail', ], ], + [ + 'name' => 'pageNumber', + 'in' => 'query', + 'schema' => ['title' => '', 'description' => 'The page number.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'default' => '1', 'example' => '1'], + ], + [ + 'name' => 'pageSize', + 'in' => 'query', + 'schema' => ['title' => '', 'description' => 'The page size.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'default' => '10', 'example' => '10'], + ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ - 'requestId' => [ - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => '4406F40B-A0A2-9D5D-531F-3B6936567584', - ], - 'result' => [ - 'description' => 'The data returned.'."\n", - 'type' => 'object', - 'properties' => [ - 'start' => [ - 'description' => 'The timestamp that indicates the beginning of the time range to query.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1589986800', - ], - 'analyzeStatus' => [ - 'description' => 'The status of the analysis. Valid values:'."\n" - ."\n" - .'* PENDING: preparing'."\n" - .'* SUCCESS: succeeded'."\n" - .'* RUNNING: running'."\n" - .'* FAILED: failed'."\n" - .'* N/A: unknown'."\n", - 'type' => 'string', - 'example' => '"PENDING"', - ], - 'end' => [ - 'description' => 'The timestamp that indicates the end of the time range to query.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1589990340', + 'Status' => ['description' => 'The request status. Valid values: OK and FAIL.', 'type' => 'string', 'title' => '', 'example' => 'OK'], + 'HttpCode' => ['description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '200'], + 'TotalCount' => ['description' => 'The total number of records that meet the requirements.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '2'], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'title' => '', 'example' => '"3A809095-C554-5CF5-8FCE-BE19D4673790"'], + 'Message' => ['description' => 'The returned error message.', 'type' => 'string', 'title' => '', 'example' => 'Invalid resource name.'], + 'Code' => ['description' => 'The returned error code. This parameter is empty if no error occurs.', 'type' => 'string', 'title' => '', 'example' => 'Resource.InvalidResourceName'], + 'Result' => [ + 'description' => 'The result.', + 'type' => 'array', + 'items' => [ + 'description' => 'The result body.', + 'type' => 'object', + 'properties' => [ + 'CreateTime' => ['description' => 'The time when the resource was created. Unit: milliseconds.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '1234'], + 'Data' => [ + 'description' => 'The resource data. The structure of the data varies based on the resourceType.', + 'type' => 'object', + 'properties' => [ + 'Content' => ['description' => 'The content of the file that corresponds to the raw\\_file resource.', 'type' => 'string', 'title' => '', 'example' => '"abc"'], + 'Generators' => [ + 'description' => 'The list of feature generators that correspond to the feature\\_generator resource.', + 'type' => 'array', + 'items' => [ + 'description' => 'The description of the feature generator.', + 'type' => 'object', + 'properties' => [ + 'Generator' => ['description' => 'The type of the feature generator.', 'type' => 'string', 'title' => '', 'example' => 'combo'], + 'Input' => [ + 'description' => 'The input.', + 'type' => 'object', + 'properties' => [ + 'Features' => [ + 'description' => 'The list of input features.', + 'type' => 'array', + 'items' => [ + 'description' => 'The input feature.', + 'type' => 'object', + 'properties' => [ + 'Name' => ['description' => 'The feature name.', 'type' => 'string', 'title' => '', 'example' => 'system_item_id'], + 'Type' => [ + 'description' => 'The feature type.', + 'type' => 'string', + 'enumValueTitles' => ['item' => 'item', 'user' => 'user'], + 'title' => '', + 'example' => 'item', + ], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + ], + 'title' => '', + 'example' => '', + ], + 'Output' => ['description' => 'The name of the output feature.', 'type' => 'string', 'title' => '', 'example' => 'feature1'], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + ], + 'title' => '', + 'example' => '', + ], + 'Description' => ['description' => 'The description of the resource.', 'type' => 'string', 'title' => '', 'example' => 'resource description'], + 'FunctionName' => ['description' => 'The function name.', 'type' => 'string', 'title' => '', 'example' => 'rank'], + 'ModifyTime' => ['description' => 'The time when the resource was last modified. Unit: milliseconds.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '1234'], + 'ReferencedInstances' => [ + 'description' => 'The names of the referenced algorithm instances.', + 'type' => 'array', + 'items' => ['description' => 'The instance name.', 'type' => 'string', 'title' => '', 'example' => 'rank_model1'], + 'title' => '', + 'example' => '', + ], + 'ResourceName' => ['description' => 'The resource name.', 'type' => 'string', 'title' => '', 'example' => 'fg_json'], + 'ResourceType' => ['description' => 'The resource type.', 'type' => 'string', 'title' => '', 'example' => 'feature_generator'], ], + 'title' => '', + 'example' => '', ], + 'title' => '', + 'example' => '', ], + 'Latency' => ['description' => 'The request latency. Unit: milliseconds.', 'type' => 'number', 'format' => 'double', 'title' => '', 'example' => '123'], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], - '5XX' => [ - 'schema' => [ - 'type' => 'object', - 'properties' => [ - 'code' => [ - 'type' => 'string', - ], - 'message' => [ - 'type' => 'string', - ], - 'requestId' => [ - 'type' => 'string', - ], - 'httpCode' => [ - 'type' => 'integer', - 'format' => 'int32', - ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'ListFunctionResources', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListFunctionResources'], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'opensearch:DescribeFunction', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'OpenSearch', 'resourceType' => 'FunctionResource', 'arn' => 'acs:opensearch:{#regionId}:{#accountId}:apps/{#AppGroupId}'], ], ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"requestId\\": \\"4406F40B-A0A2-9D5D-531F-3B6936567584\\",\\n \\"result\\": {\\n \\"start\\": 1589986800,\\n \\"analyzeStatus\\": \\"\\\\\\"PENDING\\\\\\"\\",\\n \\"end\\": 1589990340\\n }\\n}","errorExample":""},{"type":"xml","example":"4406F40B-A0A2-9D5D-531F-3B6936567584\\n\\n PENDING\\n 1589986800\\n 1589990340\\n","errorExample":""}]', - 'title' => 'ListSlowQueryCategories', - 'requestParamsDescription' => '**Sample requests**'."\n" - ."\n" - .'`GET /v4/openapi/app-groups/kevintest2/optimizers/slow-query/categories?end=1589990340&sort=max&start=1589986800`'."\n" - ."\n" - .'**Query parameters**'."\n" - ."\n" - .'|Parameter|Type|Required|Example|Description|'."\n" - .'|---|---|---|---|---|'."\n" - .'|start|Integer|Yes|1589986800|The timestamp that specifies the beginning of the time range to query. The time is accurate to seconds.|'."\n" - .'|end|Integer|Yes|1589990340|The timestamp that specifies the end of the time range to query. The time is accurate to seconds.|'."\n" - .'|sort|String|No|"max"|The sort type.
Valid values:
-max: the maximum value
-avg: the average value
-sum: the sum value
-queryProportion: the query proportion|', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Status\\": \\"OK\\",\\n \\"HttpCode\\": 200,\\n \\"TotalCount\\": 2,\\n \\"RequestId\\": \\"\\\\\\"3A809095-C554-5CF5-8FCE-BE19D4673790\\\\\\"\\",\\n \\"Message\\": \\"Invalid resource name.\\",\\n \\"Code\\": \\"Resource.InvalidResourceName\\",\\n \\"Result\\": [\\n {\\n \\"CreateTime\\": 1234,\\n \\"Data\\": {\\n \\"Content\\": \\"\\\\\\"abc\\\\\\"\\",\\n \\"Generators\\": [\\n {\\n \\"Generator\\": \\"combo\\",\\n \\"Input\\": {\\n \\"Features\\": [\\n {\\n \\"Name\\": \\"system_item_id\\",\\n \\"Type\\": \\"item\\"\\n }\\n ]\\n },\\n \\"Output\\": \\"feature1\\"\\n }\\n ]\\n },\\n \\"Description\\": \\"resource description\\",\\n \\"FunctionName\\": \\"rank\\",\\n \\"ModifyTime\\": 1234,\\n \\"ReferencedInstances\\": [\\n \\"rank_model1\\"\\n ],\\n \\"ResourceName\\": \\"fg_json\\",\\n \\"ResourceType\\": \\"feature_generator\\"\\n }\\n ],\\n \\"Latency\\": 123\\n}","type":"json"}]', + 'translator' => 'manual', ], - 'ListQuotaReviewTasks' => [ - 'summary' => 'Queries tickets that are submitted to apply for quotas for an OpenSearch application.', - 'path' => '/v4/openapi/app-groups/{appGroupIdentity}/quota-review-tasks', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'ListFunctionTasks' => [ + 'path' => '/v4/openapi/app-groups/{appGroupIdentity}/functions/{functionName}/instances/{instanceName}/tasks', + 'methods' => ['get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], + 'produces' => ['application/json'], 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'none', - 'riskType' => 'none', - 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREopensearch447AAX', - 'FEATUREopensearch5OZOSP', - ], - ], + 'systemTags' => ['operationType' => 'get'], 'parameters' => [ [ 'name' => 'appGroupIdentity', 'in' => 'path', - 'schema' => [ - 'description' => 'The application name.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '"my_app_name"', - ], + 'schema' => ['description' => 'The name of the application.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'app_group_name'], + ], + [ + 'name' => 'functionName', + 'in' => 'path', + 'schema' => ['description' => 'The name of the feature.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'ctr'], + ], + [ + 'name' => 'instanceName', + 'in' => 'path', + 'schema' => ['description' => 'The name of the instance.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'test_model_2'], + ], + [ + 'name' => 'status', + 'in' => 'query', + 'schema' => ['description' => 'The status of the task. Valid values:'."\n" + ."\n" + .'- success'."\n" + ."\n" + .'- failed'."\n" + ."\n" + .'- running', 'type' => 'string', 'required' => false, 'title' => '', 'example' => 'success'], + ], + [ + 'name' => 'startTime', + 'in' => 'query', + 'schema' => ['description' => 'Returns tasks that started after the specified time. The time is a UNIX timestamp in milliseconds.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'title' => '', 'example' => '1582214400'], + ], + [ + 'name' => 'endTime', + 'in' => 'query', + 'schema' => ['description' => 'Returns tasks that ended before the specified time. The time is a UNIX timestamp in milliseconds.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'title' => '', 'example' => '1582646399'], ], [ 'name' => 'pageNumber', 'in' => 'query', - 'schema' => [ - 'description' => 'The page number. Default value: 1.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', - ], + 'schema' => ['description' => 'The page number. Default value: 1.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'title' => '', 'example' => '1'], ], [ 'name' => 'pageSize', 'in' => 'query', - 'schema' => [ - 'description' => 'The number of entries to return on each page. Default value: 10.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '10', - ], + 'schema' => ['description' => 'The number of entries to return on each page. Default value: 1.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'title' => '', 'example' => '10'], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'description' => 'The response parameters.'."\n", + 'description' => 'The response body.', 'type' => 'object', 'properties' => [ - 'totalCount' => [ - 'description' => 'The total number of entries returned.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '500', - ], - 'requestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '"3351A21F-705B-508C-9450-DA65A681547F"', - ], - 'result' => [ - 'description' => 'The information about the tickets. For more information, see [QuotaReviewTask](~~173609~~).'."\n", + 'Status' => ['description' => 'The status of the request.', 'type' => 'string', 'title' => '', 'example' => '200'], + 'HttpCode' => ['description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '200'], + 'TotalCount' => ['description' => 'The total number of records that meet the requirements.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '2'], + 'RequestId' => ['description' => 'The ID of the request.', 'type' => 'string', 'title' => '', 'example' => '1638157479281'], + 'Message' => ['description' => 'The returned message.', 'type' => 'string', 'title' => '', 'example' => 'fail'], + 'Code' => ['description' => 'The error code.', 'type' => 'string', 'title' => '', 'example' => '200'], + 'Result' => [ + 'description' => 'The returned result.', 'type' => 'array', 'items' => [ - 'description' => '', + 'description' => 'The result body.', 'type' => 'object', 'properties' => [ - 'oldDocSize' => [ - 'description' => 'The original quota of storage capacity.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '900', - ], - 'pending' => [ - 'description' => 'Indicates whether the ticket is pending.'."\n", - 'type' => 'boolean', - 'example' => 'false', - ], - 'memo' => [ - 'description' => 'The remarks.'."\n", - 'type' => 'string', - 'example' => 'null', - ], - 'approved' => [ - 'description' => 'Indicates whether the ticket is approved.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'oldSpec' => [ - 'description' => 'The original specifications of the application.'."\n", - 'type' => 'string', - 'example' => '"opensearch.private.common"', - ], - 'oldComputeResource' => [ - 'description' => 'The original quota of computing resources.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '500', - ], - 'appGroupType' => [ - 'description' => 'The application type.'."\n", - 'type' => 'string', - 'example' => '"standard"', - ], - 'available' => [ - 'description' => 'Indicates whether the application is available.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'gmtCreate' => [ - 'description' => 'The time when the ticket was created.'."\n", - 'type' => 'string', - 'example' => '"2020-04-08T08:29:45+0000"', - ], - 'newSocSize' => [ - 'description' => 'The storage capacity quota that is applied for.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1100', - ], - 'id' => [ - 'description' => 'The ticket ID.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '142', - ], - 'appGroupId' => [ - 'description' => 'The application ID.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '120123456', - ], - 'newComputeResource' => [ - 'description' => 'The computing resource quota that is applied for.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '6000', - ], - 'appGroupName' => [ - 'description' => 'The application name.'."\n", - 'type' => 'string', - 'example' => '"td_test_os"', - ], - 'gmtModified' => [ - 'description' => 'The time when the ticket was last updated.'."\n", - 'type' => 'string', - 'example' => '"2020-04-08T08:36:36+0000"', - ], - 'newSpec' => [ - 'description' => 'The application specifications that are applied for.'."\n", - 'type' => 'string', - 'example' => '"opensearch.private.common"', - ], + 'EndTime' => ['description' => 'The time when the task ended. This is a UNIX timestamp in milliseconds. A value of 0 indicates that the task has not ended.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '100010'], + 'ExtendInfo' => ['description' => 'A JSON string that contains information such as model evaluation results and training errors.', 'type' => 'string', 'title' => '', 'example' => '{\\"recall\\":91,\\"errors\\":[]}'], + 'FunctionName' => ['description' => 'The name of the feature.', 'type' => 'string', 'title' => '', 'example' => 'ctr'], + 'Progress' => ['description' => 'The progress of the task. For example, a value of 90 indicates that the task is 90% complete.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '90'], + 'RunId' => ['description' => 'The ID of the task.', 'type' => 'string', 'title' => '', 'example' => 'trigger__2021-03-05T12:18:41'], + 'StartTime' => ['description' => 'The time when the task started. This is a UNIX timestamp in milliseconds.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '100010'], + 'Status' => ['description' => 'The status of the task.'."\n" + ."\n" + .'- success'."\n" + ."\n" + .'- failed'."\n" + ."\n" + .'- running', 'type' => 'string', 'title' => '', 'example' => 'success'], + 'Generation' => ['description' => 'The iteration number.', 'type' => 'string', 'title' => '', 'example' => '2'], ], - 'example' => '{}', + 'example' => '{ "functionName": "ctr", "progress": 100, "status": "success", "startTime": 100010, "endTime": 200020, "extendInfo": "{\\"recall\\":91,\\"errors\\":[]}", "runId": "trigger__2021-03-05T12:18:41" }', + 'title' => '', ], - 'example' => '[]', - ], - ], - ], - ], - '5XX' => [ - 'schema' => [ - 'type' => 'object', - 'properties' => [ - 'code' => [ - 'type' => 'string', - ], - 'httpCode' => [ - 'type' => 'integer', - 'format' => 'int32', - ], - 'requestId' => [ - 'type' => 'string', - ], - 'message' => [ - 'type' => 'string', + 'example' => '[ { "functionName": "ctr", "progress": 100, "status": "success", "startTime": 100010, "endTime": 200020, "extendInfo": "{\\"recall\\":91,\\"errors\\":[]}", "runId": "trigger__2021-03-05T12:18:41" } ]', + 'title' => '', ], + 'Latency' => ['description' => 'The time consumed by the request, in milliseconds.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '123'], ], + 'example' => '{ "status": "OK", "requestId": "", "httpCode": 200, "code": "", "message": "", "latency": 123, "totalCount": 1, "result": [ { "functionName": "ctr", "progress": 100, "status": "success", "startTime": 100010, "endTime": 200020, "extendInfo": "{\\"recall\\":91,\\"errors\\":[]}", "runId": "trigger__2021-03-05T12:18:41" } ] }', + 'title' => '', ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"totalCount\\": 500,\\n \\"requestId\\": \\"\\\\\\"3351A21F-705B-508C-9450-DA65A681547F\\\\\\"\\",\\n \\"result\\": [\\n {\\n \\"oldDocSize\\": 900,\\n \\"pending\\": false,\\n \\"memo\\": \\"null\\",\\n \\"approved\\": true,\\n \\"oldSpec\\": \\"\\\\\\"opensearch.private.common\\\\\\"\\",\\n \\"oldComputeResource\\": 500,\\n \\"appGroupType\\": \\"\\\\\\"standard\\\\\\"\\",\\n \\"available\\": true,\\n \\"gmtCreate\\": \\"\\\\\\"2020-04-08T08:29:45+0000\\\\\\"\\",\\n \\"newSocSize\\": 1100,\\n \\"id\\": 142,\\n \\"appGroupId\\": 120123456,\\n \\"newComputeResource\\": 6000,\\n \\"appGroupName\\": \\"\\\\\\"td_test_os\\\\\\"\\",\\n \\"gmtModified\\": \\"\\\\\\"2020-04-08T08:36:36+0000\\\\\\"\\",\\n \\"newSpec\\": \\"\\\\\\"opensearch.private.common\\\\\\"\\"\\n }\\n ]\\n}","type":"json"}]', - 'title' => 'ListQuotaReviewTasks', - 'requestParamsDescription' => 'Sample requests'."\n" + 'title' => 'ListFunctionTasks', + 'summary' => 'Queries the training tasks. The results are sorted in descending order by start time.', + 'requestParamsDescription' => '### Sample request'."\n" ."\n" - .' GET /v4/openapi/app-groups/demo/quota-review-tasks'."\n", - 'responseParamsDescription' => 'Sample responses'."\n" + .'`GET /v4/openapi/app-groups/my-app/functions/ctr/instances/ctr_test/tasks`', + 'responseParamsDescription' => '### Sample success response'."\n" ."\n" - .'```json'."\n" + .'```'."\n" .'{'."\n" - .' "id": 142,'."\n" - .' "appGroupId": 120577535,'."\n" - .' "appGroupName": "td_trade_order_os",'."\n" - .' "appGroupType": "standard",'."\n" - .' "oldSpec": "opensearch.private.common",'."\n" - .' "oldComputeResource": 500,'."\n" - .' "oldDocSize": 900,'."\n" - .' "newSpec": "opensearch.private.common",'."\n" - .' "newComputeResource": 6000,'."\n" - .' "newSocSize": 1100,'."\n" - .' "memo": null,'."\n" - .' "available": true,'."\n" - .' "pending": false,'."\n" - .' "approved": true,'."\n" - .' "gmtCreate": "2020-04-08T08:29:45+0000",'."\n" - .' "gmtModified": "2020-04-08T08:36:36+0000"'."\n" + .' "status": "OK",'."\n" + .' "requestId": "",'."\n" + .' "httpCode": 200,'."\n" + .' "code": "",'."\n" + .' "message": "",'."\n" + .' "latency": 123,'."\n" + .' "totalCount": 1,'."\n" + .' "result": ['."\n" + .' {'."\n" + .' "functionName": "ctr",'."\n" + .' "progress": 100,'."\n" + .' "status": "success",'."\n" + .' "startTime": 100010,'."\n" + .' "endTime": 200020,'."\n" + .' "extendInfo": "{\\"recall\\":91,\\"errors\\":[]}",'."\n" + .' "runId": "trigger__2021-03-05T12:18:41",'."\n" + .' "generation": "3"'."\n" + .' }'."\n" + .' ]'."\n" .'}'."\n" - .'```'."\n", - ], - 'ListScheduledTasks' => [ - 'summary' => 'Queries a list of scheduled tasks of an OpenSearch application.', - 'path' => '/v4/openapi/app-groups/{appGroupIdentity}/scheduled-tasks', - 'methods' => [ - 'get', + .'```', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListFunctionTasks'], + ], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'opensearch:DescribeFunction', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'OpenSearch', 'resourceType' => 'FunctionTask', 'arn' => 'acs:opensearch:{#regionId}:{#accountId}:apps/{#AppGroupId}'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Status\\": \\"200\\",\\n \\"HttpCode\\": 200,\\n \\"TotalCount\\": 2,\\n \\"RequestId\\": \\"1638157479281\\",\\n \\"Message\\": \\"fail\\",\\n \\"Code\\": \\"200\\",\\n \\"Result\\": [\\n {\\n \\"EndTime\\": 100010,\\n \\"ExtendInfo\\": \\"{\\\\\\\\\\\\\\"recall\\\\\\\\\\\\\\":91,\\\\\\\\\\\\\\"errors\\\\\\\\\\\\\\":[]}\\",\\n \\"FunctionName\\": \\"ctr\\",\\n \\"Progress\\": 90,\\n \\"RunId\\": \\"trigger__2021-03-05T12:18:41\\",\\n \\"StartTime\\": 100010,\\n \\"Status\\": \\"success\\",\\n \\"Generation\\": \\"2\\"\\n }\\n ],\\n \\"Latency\\": 123\\n}","type":"json"}]', + 'translator' => 'manual', + ], + 'ListInterventionDictionaries' => [ + 'summary' => 'Retrieves a list of intervention dictionaries.', + 'path' => '/v4/openapi/intervention-dictionaries', + 'methods' => ['get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -13422,59 +11121,35 @@ 'operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREopensearch447AAX', - 'FEATUREopensearch5OZOSP', - ], + 'abilityTreeNodes' => ['FEATUREopensearchUIICM8', 'FEATUREopensearchNCXKUT'], ], 'parameters' => [ [ - 'name' => 'appGroupIdentity', - 'in' => 'path', - 'schema' => [ - 'description' => 'The application name.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'my_app_group_name', - ], - ], - [ - 'name' => 'type', + 'name' => 'pageSize', 'in' => 'query', - 'schema' => [ - 'description' => 'The scheduled task type. Valid values:'."\n" - ."\n" - .'* wipe: data cleaning.'."\n" - .'* fork: reindexing.'."\n" - .'* check-status: application status check.'."\n" - .'* index: reindexing.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'wipe', - ], + 'schema' => ['description' => 'The number of entries to return on each page. The default value is 10.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'title' => '', 'example' => '10'], ], [ 'name' => 'pageNumber', 'in' => 'query', - 'schema' => [ - 'description' => 'The page number. Default value: 1.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', - ], + 'schema' => ['description' => 'The page number to return. The default value is 1.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'title' => '', 'example' => '1'], ], [ - 'name' => 'pageSize', + 'name' => 'types', 'in' => 'query', - 'schema' => [ - 'description' => 'The number of entries per page. Default value: 10.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '10', - ], + 'schema' => ['description' => 'The types of the intervention dictionaries. Format: urlencode(\\["synonym", "stopword"])'."\n" + ."\n" + .'- stopword: an intervention dictionary for stop word filtering'."\n" + ."\n" + .'- synonym: an intervention dictionary for synonym configuration'."\n" + ."\n" + .'- correction: an intervention dictionary for spelling correction'."\n" + ."\n" + .'- category\\_prediction: an intervention dictionary for category prediction'."\n" + ."\n" + .'- ner: an intervention dictionary for Named Entity Recognition (NER)'."\n" + ."\n" + .'- term\\_weighting: an intervention dictionary for term weight analysis', 'type' => 'string', 'required' => false, 'title' => '', 'example' => '["synonym"]'], ], ], 'responses' => [ @@ -13482,111 +11157,125 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'totalCount' => [ - 'description' => 'The total number of entries returned.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - ], - 'requestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '0A6EB64B-B4C8-CF02-810F-E660812972FF', - ], + 'totalCount' => ['description' => 'The total number of entries returned.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '2'], + 'requestId' => ['description' => 'The ID of the request.', 'type' => 'string', 'title' => '', 'example' => '0A6EB64B-B4C8-CF02-810F-E660812972FF'], 'result' => [ + 'description' => 'The information about each intervention dictionary.'."\n" + ."\n" + .'For more information, see [InterventionDictionary](~~173608~~).', 'type' => 'array', 'items' => [ - 'description' => 'The information about the scheduled task.'."\n" - ."\n" - .'For more information, see [ScheduledTask](~~173610~~).'."\n", 'type' => 'object', - 'example' => '[]', + 'properties' => [ + 'created' => ['description' => 'The time when the intervention dictionary was created.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '1539158325'], + 'type' => ['description' => 'The type of the intervention dictionary. Valid values:'."\n" + ."\n" + .'- stopword: an intervention dictionary for stop word filtering'."\n" + ."\n" + .'- synonym: an intervention dictionary for synonym configuration'."\n" + ."\n" + .'- correction: an intervention dictionary for spelling correction'."\n" + ."\n" + .'- category\\_prediction: an intervention dictionary for category prediction'."\n" + ."\n" + .'- ner: an intervention dictionary for Named Entity Recognition (NER)'."\n" + ."\n" + .'- term\\_weighting: an intervention dictionary for term weight analysis', 'type' => 'string', 'title' => '', 'example' => 'synonym'], + 'analyzer' => ['description' => 'The custom analyzer.', 'type' => 'string', 'title' => '', 'example' => '""'], + 'name' => ['description' => 'The name of the intervention dictionary.', 'type' => 'string', 'title' => '', 'example' => 'tongyici'], + 'updated' => ['description' => 'The time when the intervention dictionary was last updated.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '1539158313'], + 'id' => ['description' => 'The ID of the intervention dictionary.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '1'], + ], + 'description' => '', + 'title' => '', + 'example' => '', ], - 'description' => '', + 'title' => '', + 'example' => '', ], ], 'description' => '', + 'title' => '', + 'example' => '', ], ], '5XX' => [ 'schema' => [ 'type' => 'object', 'properties' => [ - 'code' => [ - 'type' => 'string', - ], - 'message' => [ - 'type' => 'string', - ], - 'requestId' => [ - 'type' => 'string', - ], - 'httpCode' => [ - 'type' => 'integer', - 'format' => 'int32', - ], + 'code' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'requestId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'message' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'httpCode' => ['type' => 'integer', 'format' => 'int32', 'description' => '', 'title' => '', 'example' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"totalCount\\": 1,\\n \\"requestId\\": \\"0A6EB64B-B4C8-CF02-810F-E660812972FF\\",\\n \\"result\\": [\\n []\\n ]\\n}","errorExample":""},{"type":"xml","example":"0A6EB64B-B4C8-CF02-810F-E660812972FF\\n1\\n\\n 2f12c585-5873-11ea-974a-7cd30ad3e268\\n 0\\n 3\\n \\n wipe\\n false\\n false\\n false\\n true\\n 1582706232\\n 1582706232\\n 0 0 * * 1,2,3,4,5,6,7\\n true\\n \\n 110091051\\n 2656\\n \\n \\n \\n 110091051\\n \\n \\n 2656\\n \\n \\n ctime\\n 30\\n s\\n \\n","errorExample":""}]', - 'title' => 'ListScheduledTasks', - 'requestParamsDescription' => '**Request parameters**'."\n" - ."\n" - .'|Parameter|Type|Required|Example|Description|'."\n" - .'|---|---|---|---|---|'."\n" - .'|id|String|No|"2f12c585-5873-11ea-974a-7cd30ad3e268"|The task ID.|'."\n" - .'|enabled|Boolean|No|true|Specifies whether the scheduled task is enabled.|'."\n" - .'|updated|Integer|No|1582706232|The timestamp when the scheduled task was last updated.|', + 'title' => 'ListInterventionDictionaries', + 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', - ], - 'CreateScheduledTask' => [ - 'summary' => 'Creates a scheduled task for an OpenSearch application.', - 'path' => '/v4/openapi/app-groups/{appGroupIdentity}/scheduled-tasks', - 'methods' => [ - 'post', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'opensearch:ListInterventionDictionaries', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'OpenSearch', 'resourceType' => 'InterventionDictionary', 'arn' => 'acs:opensearch:{#regionId}:{#accountId}:intervention-dictionaries/*'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"totalCount\\": 2,\\n \\"requestId\\": \\"0A6EB64B-B4C8-CF02-810F-E660812972FF\\",\\n \\"result\\": [\\n {\\n \\"created\\": 1539158325,\\n \\"type\\": \\"synonym\\",\\n \\"analyzer\\": \\"\\\\\\"\\\\\\"\\",\\n \\"name\\": \\"tongyici\\",\\n \\"updated\\": 1539158313,\\n \\"id\\": 1\\n }\\n ]\\n}","type":"json"}]', + 'translator' => 'manual', + ], + 'ListInterventionDictionaryEntries' => [ + 'summary' => 'Queries the intervention entries in an intervention dictionary.', + 'path' => '/v4/openapi/intervention-dictionaries/{name}/entries', + 'methods' => ['get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'write', + 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'create', + 'operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREopensearch447AAX', - 'FEATUREopensearch5OZOSP', - ], + 'abilityTreeNodes' => ['FEATUREopensearch2ESE2N'], ], 'parameters' => [ [ - 'name' => 'appGroupIdentity', + 'name' => 'name', 'in' => 'path', - 'schema' => [ - 'description' => 'The name of the application.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'my_app_group_name', - ], + 'schema' => ['description' => 'The name of the intervention dictionary.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'my_dict', 'title' => ''], + ], + [ + 'name' => 'word', + 'in' => 'query', + 'schema' => ['description' => 'The intervention entry.', 'type' => 'string', 'example' => 'Test', 'required' => false, 'title' => ''], ], [ - 'name' => 'body', - 'in' => 'body', - 'schema' => [ - 'description' => 'The request body.'."\n", - 'required' => false, - '$ref' => '#/components/schemas/ScheduledTask', - ], + 'name' => 'pageNumber', + 'in' => 'query', + 'schema' => ['description' => 'The page number. Default value: 1.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'docRequired' => false, 'example' => '1', 'title' => ''], + ], + [ + 'name' => 'pageSize', + 'in' => 'query', + 'schema' => ['description' => 'The number of entries returned per page. Default value: 10.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10', 'title' => ''], ], ], 'responses' => [ @@ -13594,70 +11283,176 @@ 'schema' => [ 'type' => 'object', 'properties' => [ + 'totalCount' => ['description' => 'The total number of entries returned.', 'type' => 'integer', 'format' => 'int32', 'example' => '8', 'title' => ''], + 'requestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '516A02B7-2167-8D92-12D0-B639A2A0F3C5', 'title' => ''], 'result' => [ - 'description' => 'For more information about a scheduled task, see [ScheduledTask](~~173610~~).'."\n", - 'type' => 'object', - 'example' => '{}', - ], - 'requestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => 'ABCDEFGH', + 'description' => 'The information about intervention entries.'."\n" + ."\n" + .'For more information, see [InterventionDictionaryEntry](~~173606~~).', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'cmd' => ['description' => 'The command. Valid values:'."\n" + ."\n" + .'- add'."\n" + ."\n" + .'- delete', 'type' => 'string', 'example' => 'add', 'title' => ''], + 'created' => ['description' => 'The timestamp when the intervention entry was created.', 'type' => 'integer', 'format' => 'int64', 'example' => '1536690285', 'title' => ''], + 'word' => ['description' => 'The intervention entry.', 'type' => 'string', 'example' => '\\u8fc7\\u513f', 'title' => ''], + 'relevance' => ['description' => 'The content of an intervention entry for category prediction. The field value consists of key-value pairs. The key in a key-value pair indicates the ID of the category. The value in a key-value pair indicates the relevance to the category. A value of 0 indicates irrelevant. A value of 1 indicates slightly relevant. A value of 2 indicates relevant. Example: {"2":1, "100":0}', 'type' => 'object', 'example' => ' { "100": "0", "200": "2" }', 'title' => ''], + 'status' => ['description' => 'The status of the intervention entry. Valid value:'."\n" + ."\n" + .'- ACTIVE: The intervention entry takes effect.', 'type' => 'string', 'example' => 'ACTIVE', 'title' => ''], + 'updated' => ['description' => 'The timestamp when the intervention entry was last updated.', 'type' => 'integer', 'format' => 'int64', 'example' => '1537348987', 'title' => ''], + 'tokens' => [ + 'description' => 'The content of the intervention entry for term weight analysis.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'tag' => ['description' => 'The internal name of the identified entity type. Valid values:'."\n" + ."\n" + .'- brand'."\n" + ."\n" + .'- category'."\n" + ."\n" + .'- material'."\n" + ."\n" + .'- element'."\n" + ."\n" + .'- style'."\n" + ."\n" + .'- color'."\n" + ."\n" + .'- function'."\n" + ."\n" + .'- scenario'."\n" + ."\n" + .'- people'."\n" + ."\n" + .'- season'."\n" + ."\n" + .'- model'."\n" + ."\n" + .'- region'."\n" + ."\n" + .'- name'."\n" + ."\n" + .'- adjective'."\n" + ."\n" + .'- category-modifier'."\n" + ."\n" + .'- size'."\n" + ."\n" + .'- quality'."\n" + ."\n" + .'- suit'."\n" + ."\n" + .'- new-release'."\n" + ."\n" + .'- series'."\n" + ."\n" + .'- marketing'."\n" + ."\n" + .'- entertainment'."\n" + ."\n" + .'- organization'."\n" + ."\n" + .'- movie'."\n" + ."\n" + .'- game'."\n" + ."\n" + .'- number'."\n" + ."\n" + .'- unit'."\n" + ."\n" + .'- common'."\n" + ."\n" + .'- new-word'."\n" + ."\n" + .'- proper-noun'."\n" + ."\n" + .'- symbol'."\n" + ."\n" + .'- prefix'."\n" + ."\n" + .'- suffix'."\n" + ."\n" + .'- gift'."\n" + ."\n" + .'- negative'."\n" + ."\n" + .'- agent', 'type' => 'string', 'example' => 'category', 'title' => ''], + 'token' => ['description' => 'The entity.', 'type' => 'string', 'example' => '本', 'title' => ''], + 'order' => ['description' => 'The sequence number.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'tagLabel' => ['description' => 'The description of the internal name of the identified entity type.', 'type' => 'string', 'example' => '品类', 'title' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', ], ], 'description' => '', + 'title' => '', + 'example' => '', ], ], '5XX' => [ 'schema' => [ 'type' => 'object', 'properties' => [ - 'code' => [ - 'type' => 'string', - ], - 'message' => [ - 'type' => 'string', - ], - 'requestId' => [ - 'type' => 'string', - ], - 'httpCode' => [ - 'type' => 'integer', - 'format' => 'int32', - ], + 'code' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'requestId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'message' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'httpCode' => ['type' => 'integer', 'format' => 'int32', 'description' => '', 'title' => '', 'example' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"result\\": {},\\n \\"requestId\\": \\"ABCDEFGH\\"\\n}","errorExample":""},{"type":"xml","example":"0BECF34E-125A-D35F-1E5D-ABB66B11FAB8\\n\\n cfd5ebe9-bcdd-11ea-a58d-98039b07e4ec\\n 0\\n 3\\n \\n wipe\\n false\\n false\\n false\\n true\\n 1593747144\\n 1593747144\\n 0 0 * * 1,2,3,4,5,6,7\\n true\\n \\n \\n \\n title\\n 30\\n s\\n \\n","errorExample":""}]', - 'title' => 'CreateScheduledTask', - 'requestParamsDescription' => '**Request body**'."\n" - ."\n" - .'|Parameter|Type|Required|Example|Description|'."\n" - .'|---|---|---|---|---|'."\n" - .'|type|String|Yes|"wipe"|The type of the scheduled task. Valid values:wipe: data scrubbingfork: data import and reindexingreindex: reindexingclear: data clearing|'."\n" - .'|cron|String|Yes|"10 20 \\* \\* 1,2,3,4,5"|The configuration of the scheduled task. For more information, see [cron field in ScheduledTask](~~173611~~).|'."\n" - .'|enabled|Boolean|Yes|true|Specify whether the scheduled task is enabled.|'."\n" - .'|appStrategy|String|No|delete-idle|The policy for creating a new version. Valid values:delete-idle: Two versions exist. Delete the non-online version first and then create a new version.need-slot: Only one version exists. Create a new version directly.|'."\n" - .'|filter|Object|No||The conditions that are used to delete data.|'."\n" - .'|filter.days|Integer|Yes|7|The remaining validity period.Valid values: \\[7,180\\]. Unit: days.|'."\n" - .'|filter.unit|String|Yes|"s"|The unit of the expiration time of the field. Valid values:s: secondsms: milliseconds|'."\n" - .'|filter.field|String|No|"cate\\_id"|The field that the task clears based on the expiration settings.|'."\n" - .'|runNow|Boolean|No|false|Specifies whether to immediately execute the task. Default value: false.|'."\n" - .'|permanent|Boolean|No|true|Specifies whether the scheduled task can always be executed. Default value: true.|', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"totalCount\\": 8,\\n \\"requestId\\": \\"516A02B7-2167-8D92-12D0-B639A2A0F3C5\\",\\n \\"result\\": [\\n {\\n \\"cmd\\": \\"add\\",\\n \\"created\\": 1536690285,\\n \\"word\\": \\"\\\\\\\\u8fc7\\\\\\\\u513f\\",\\n \\"relevance\\": {\\n \\"100\\": \\"0\\",\\n \\"200\\": \\"2\\"\\n },\\n \\"status\\": \\"ACTIVE\\",\\n \\"updated\\": 1537348987,\\n \\"tokens\\": [\\n {\\n \\"tag\\": \\"category\\",\\n \\"token\\": \\"本\\",\\n \\"order\\": 1,\\n \\"tagLabel\\": \\"品类\\"\\n }\\n ]\\n }\\n ]\\n}","type":"json"}]', + 'title' => 'ListInterventionDictionaryEntries', + 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', - ], - 'DescribeScheduledTask' => [ - 'summary' => '查看应用定时任务详情', - 'path' => '/v4/openapi/app-groups/{appGroupIdentity}/scheduled-tasks/{taskId}', - 'methods' => [ - 'get', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'opensearch:DescribeInterventionDictionary', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'OpenSearch', 'resourceType' => 'InterventionDictionary', 'arn' => 'acs:opensearch:{#regionId}:{#accountId}:intervention-dictionaries/{#InterventionDictionaryId}'], + ], + ], + ], ], + 'translator' => 'manual', + ], + 'ListInterventionDictionaryNerResults' => [ + 'summary' => 'Retrieves the Named Entity Recognition (NER) results.', + 'path' => '/v4/openapi/intervention-dictionaries/{name}/ner-results', + 'methods' => ['get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -13666,36 +11461,21 @@ 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'get', + 'operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREopensearch447AAX', - 'FEATUREopensearch5OZOSP', - ], + 'abilityTreeNodes' => ['FEATUREopensearchUIICM8'], ], 'parameters' => [ [ - 'name' => 'appGroupIdentity', + 'name' => 'name', 'in' => 'path', - 'schema' => [ - 'description' => 'The name of the application', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'my_app_group_name', - ], + 'schema' => ['description' => 'The name of the intervention dictionary.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'my_dict', 'title' => ''], ], [ - 'name' => 'taskId', - 'in' => 'path', - 'schema' => [ - 'description' => 'The ID of the task.', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '2f12c585-5873-11ea-974a-7cd30ad3e268', - ], + 'name' => 'query', + 'in' => 'query', + 'schema' => ['description' => 'The keyword to search for.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'soy milk', 'title' => ''], ], ], 'responses' => [ @@ -13703,101 +11483,167 @@ 'schema' => [ 'type' => 'object', 'properties' => [ + 'requestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '8F780CA8-D4D4-2FFE-B8AC-42040822C554', 'title' => ''], 'result' => [ - 'description' => 'The details of the scheduled task.'."\n", - 'type' => 'object', - 'example' => '{}', - ], - 'requestId' => [ - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => '922DC0D9-31B5-45F9-47B7-37DC678D61A8', + 'description' => 'The NER results.'."\n" + ."\n" + .'For more information, see [Named Entity Recognition (NER)](~~173606~~).', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'tag' => ['description' => 'The tag of the detected entity.'."\n" + ."\n" + .'- brand: Brand'."\n" + ."\n" + .'- category: Category'."\n" + ."\n" + .'- material: Material'."\n" + ."\n" + .'- element: Element'."\n" + ."\n" + .'- style: Style'."\n" + ."\n" + .'- color: Color'."\n" + ."\n" + .'- function: Function'."\n" + ."\n" + .'- scenario: Scenario'."\n" + ."\n" + .'- people: People'."\n" + ."\n" + .'- season: Season'."\n" + ."\n" + .'- model: Model'."\n" + ."\n" + .'- region: Region'."\n" + ."\n" + .'- name: Name'."\n" + ."\n" + .'- adjective: Adjective'."\n" + ."\n" + .'- category-modifier: Category modifier'."\n" + ."\n" + .'- size: Size'."\n" + ."\n" + .'- quality: Quality'."\n" + ."\n" + .'- suit: Suit'."\n" + ."\n" + .'- new-release: New release'."\n" + ."\n" + .'- series: Series'."\n" + ."\n" + .'- marketing: Marketing'."\n" + ."\n" + .'- entertainment: Entertainment'."\n" + ."\n" + .'- organization: Organization'."\n" + ."\n" + .'- movie: Movie'."\n" + ."\n" + .'- game: Game'."\n" + ."\n" + .'- number: Number'."\n" + ."\n" + .'- unit: Unit'."\n" + ."\n" + .'- common: Common word'."\n" + ."\n" + .'- new-word: New word'."\n" + ."\n" + .'- proper-noun: Proper noun'."\n" + ."\n" + .'- symbol: Symbol'."\n" + ."\n" + .'- prefix: Prefix'."\n" + ."\n" + .'- suffix: Suffix'."\n" + ."\n" + .'- gift: Gift'."\n" + ."\n" + .'- negative: Negative'."\n" + ."\n" + .'- agent: Agent', 'type' => 'string', 'example' => 'category', 'title' => ''], + 'token' => ['description' => 'The detected entity.', 'type' => 'string', 'example' => 'milk', 'title' => ''], + 'order' => ['description' => 'The ordinal number.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'tagLabel' => ['description' => 'The label of the tag.', 'type' => 'string', 'example' => '品类', 'title' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], '5XX' => [ 'schema' => [ 'type' => 'object', 'properties' => [ - 'code' => [ - 'type' => 'string', - ], - 'message' => [ - 'type' => 'string', - ], - 'requestId' => [ - 'type' => 'string', - ], - 'httpCode' => [ - 'type' => 'integer', - 'format' => 'int32', - ], + 'code' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'requestId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'message' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'httpCode' => ['type' => 'integer', 'format' => 'int32', 'description' => '', 'title' => '', 'example' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"result\\": {},\\n \\"requestId\\": \\"922DC0D9-31B5-45F9-47B7-37DC678D61A8\\"\\n}","errorExample":""},{"type":"xml","example":"922DC0D9-31B5-45F9-47B7-37DC678D61A8\\n\\n 2f12c585-5873-11ea-974a-7cd30ad3e268\\n 60\\n 0\\n 1593755495\\n wipe\\n true\\n false\\n false\\n false\\n 1593747144\\n 1593755504\\n 0 0 * * 1,2,3,4,5,6,7\\n true\\n \\n 110091051\\n 84\\n \\n 100304004\\n \\n 110091051\\n \\n \\n 84\\n \\n \\n title\\n 30\\n s\\n \\n","errorExample":""}]', - 'title' => 'DescribeScheduledTask', - ], - 'ModifyScheduledTask' => [ - 'summary' => 'Modifies a scheduled task.', - 'path' => '/v4/openapi/app-groups/{appGroupIdentity}/scheduled-tasks/{taskId}', - 'methods' => [ - 'put', + 'title' => 'ListInterventionDictionaryNerResults', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '3', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListInterventionDictionaryNerResults'], + ], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'opensearch:DescribeInterventionDictionary', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'OpenSearch', 'resourceType' => 'InterventionDictionary', 'arn' => 'acs:opensearch:{#regionId}:{#accountId}:intervention-dictionaries/{#InterventionDictionaryId}'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"8F780CA8-D4D4-2FFE-B8AC-42040822C554\\",\\n \\"result\\": [\\n {\\n \\"tag\\": \\"category\\",\\n \\"token\\": \\"milk\\",\\n \\"order\\": 1,\\n \\"tagLabel\\": \\"品类\\"\\n }\\n ]\\n}","type":"json"}]', + 'extraInfo' => ' ', + 'translator' => 'manual', + ], + 'ListInterventionDictionaryRelatedEntities' => [ + 'summary' => 'Queries the list of resources associated with an intervention dictionary. If a query processor (QP) references the dictionary, the operation returns all associated applications and information about the QP.', + 'path' => '/v4/openapi/intervention-dictionaries/{name}/related', + 'methods' => ['get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'write', + 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'update', + 'operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREopensearch447AAX', - 'FEATUREopensearch0AT3OG', - ], + 'abilityTreeNodes' => ['FEATUREopensearchUIICM8'], ], 'parameters' => [ [ - 'name' => 'appGroupIdentity', - 'in' => 'path', - 'schema' => [ - 'description' => 'The application name or ID.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '121414148', - ], - ], - [ - 'name' => 'taskId', + 'name' => 'name', 'in' => 'path', - 'schema' => [ - 'description' => 'The task ID.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '56e9c2e7-5a4d-481a-9f1b-b07da6909450', - ], - ], - [ - 'name' => 'body', - 'in' => 'body', - 'schema' => [ - 'description' => 'The request parameters.'."\n", - 'type' => 'any', - 'required' => false, - 'example' => 'The request parameters.'."\n", - ], + 'schema' => ['description' => 'The name of the intervention dictionary.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'title' => '', 'example' => 'my_dict'], ], ], 'responses' => [ @@ -13805,155 +11651,130 @@ 'schema' => [ 'type' => 'object', 'properties' => [ + 'requestId' => ['description' => 'The request ID.', 'type' => 'string', 'title' => '', 'example' => 'D77D0DAF-790D-F5F5-A9C0-133738165014'], 'result' => [ - 'description' => 'The information about the scheduled task.'."\n", - 'type' => 'object', - 'example' => 'Array', - ], - 'requestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => 'D77D0DAF-790D-F5F5-A9C0-133738165014', + 'type' => 'array', + 'items' => ['description' => 'The information about the applications and query processors. This parameter is empty if no results are returned.', 'type' => 'object', 'title' => '', 'example' => '[]'], + 'description' => 'The returned results.', + 'title' => '', + 'example' => '', ], ], 'description' => '', + 'title' => '', + 'example' => '', ], ], - '5XX' => [ - 'schema' => [ - 'type' => 'object', - 'properties' => [ - 'code' => [ - 'type' => 'string', - ], - 'message' => [ - 'type' => 'string', - ], - 'requestId' => [ - 'type' => 'string', - ], - 'httpCode' => [ - 'type' => 'integer', - 'format' => 'int32', - ], + '5XX' => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'code' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'requestId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'message' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'httpCode' => ['type' => 'integer', 'format' => 'int32', 'description' => '', 'title' => '', 'example' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"result\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n },\\n \\"requestId\\": \\"D77D0DAF-790D-F5F5-A9C0-133738165014\\"\\n}","type":"json"}]', - 'title' => 'ModifyScheduledTask', - ], - 'RemoveScheduledTask' => [ - 'summary' => 'Deletes a scheduled task of an OpenSearch application.', - 'path' => '/v4/openapi/app-groups/{appGroupIdentity}/scheduled-tasks/{taskId}', - 'methods' => [ - 'delete', + 'title' => 'ListInterventionDictionaryRelatedEntities', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => '| Parameter | Type | Description |'."\n" + .'| ----------------------- | ------ | ---------------------------------------------------------------------------------------------------- |'."\n" + .'| result[].appGroup | String | The name of the application. |'."\n" + .'| result[].queryProcessor | Object | The information about the query processor.
For more information, see [QueryProcessor](~~170014~~) |', + 'extraInfo' => ' ', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'opensearch:DescribeInterventionDictionary', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'OpenSearch', 'resourceType' => 'InterventionDictionary', 'arn' => 'acs:opensearch:{#regionId}:{#accountId}:intervention-dictionaries/{#InterventionDictionaryId}'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"D77D0DAF-790D-F5F5-A9C0-133738165014\\",\\n \\"result\\": [\\n []\\n ]\\n}","type":"json"}]', + 'translator' => 'manual', + ], + 'ListProceedings' => [ + 'summary' => 'Lists the current proceedings.', + 'path' => '/v4/openapi/app-groups/{appGroupIdentity}/proceedings', + 'methods' => ['get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'write', + 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'delete', + 'operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREopensearch447AAX', - 'FEATUREopensearch5OZOSP', - ], + 'abilityTreeNodes' => ['FEATUREopensearch447AAX', 'FEATUREopensearch5OZOSP'], ], 'parameters' => [ [ 'name' => 'appGroupIdentity', 'in' => 'path', - 'schema' => [ - 'description' => 'The name of the application.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '“my_app_group_name”', - ], + 'schema' => ['description' => 'The ID of the application group.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'title' => '', 'example' => '120677456'], ], [ - 'name' => 'taskId', - 'in' => 'path', - 'schema' => [ - 'description' => 'The task ID.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '“2f12c585-5873-11ea-974a-7cd30ad3e268”', - ], + 'name' => 'filterFinished', + 'in' => 'query', + 'schema' => ['description' => 'Specifies whether to return only completed proceedings.', 'type' => 'boolean', 'required' => false, 'title' => '', 'example' => 'true'], ], ], 'responses' => [ 200 => [ 'schema' => [ + 'title' => '', + 'description' => 'The response schema.', 'type' => 'object', 'properties' => [ - 'requestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '0A6EB64B-B4C8-CF02-810F-E660812972FF', - ], - 'result' => [ - 'description' => 'The returned results.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The result list that is returned. This parameter is not returned if the request is successful.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - ], + 'requestId' => ['title' => '', 'description' => 'The ID of the request.', 'type' => 'string', 'example' => 'F5099063-6B86-F398-D843-905F9EFB683A'], ], - 'description' => '', + 'example' => '{}', ], ], - '5XX' => [ - 'schema' => [ - 'type' => 'object', - 'properties' => [ - 'code' => [ - 'type' => 'string', - ], - 'message' => [ - 'type' => 'string', - ], - 'requestId' => [ - 'type' => 'string', - ], - 'httpCode' => [ - 'type' => 'integer', - 'format' => 'int32', - ], + ], + 'title' => 'ListProceedings', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'opensearch:ListProceedings', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'OpenSearch', 'resourceType' => 'AppGroup', 'arn' => 'acs:opensearch:{#regionId}:{#accountId}:app-groups/{#AppGroupId}'], ], ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"requestId\\": \\"0A6EB64B-B4C8-CF02-810F-E660812972FF\\",\\n \\"result\\": [\\n 1\\n ]\\n}","errorExample":""},{"type":"xml","example":"0A6EB64B-B4C8-CF02-810F-E660812972FF","errorExample":""}]', - 'title' => 'RemoveScheduledTask', - 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"F5099063-6B86-F398-D843-905F9EFB683A\\"\\n}","type":"json"}]', + 'translator' => 'manual', ], - 'ListSortExpressions' => [ - 'summary' => 'Queries a list of sort expressions that are configured for a version of an OpenSearch application.', - 'path' => '/v4/openapi/app-groups/{appGroupIdentity}/apps/{appId}/sort-expressions', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'ListQueryProcessorAnalyzerResults' => [ + 'path' => '/v4/openapi/app-groups/{appGroupIdentity}/apps/{appId}/query-processors/{name}/analyze', + 'methods' => ['get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -13962,162 +11783,108 @@ 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'list', + 'operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeCode' => '55229', - 'abilityTreeNodes' => [ - 'FEATUREopensearchN8M8WS', - ], + 'abilityTreeNodes' => ['FEATUREopensearchUIICM8', 'FEATUREopensearchNCXKUT'], ], 'parameters' => [ [ 'name' => 'appGroupIdentity', 'in' => 'path', - 'schema' => [ - 'description' => 'The application name.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'my_app_group_name', - ], + 'schema' => ['description' => 'The name of the application group.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'title' => '', 'example' => 'my_app_group_name'], ], [ 'name' => 'appId', 'in' => 'path', - 'schema' => [ - 'description' => 'The version ID.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'docRequired' => true, - 'maximum' => '999999999', - 'minimum' => '1', - 'example' => '110116134', - ], + 'schema' => ['description' => 'The version number of the application.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'title' => '', 'example' => '"110157886"'], + ], + [ + 'name' => 'name', + 'in' => 'path', + 'schema' => ['description' => 'The name of the rule.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'title' => '', 'example' => '"test"'], + ], + [ + 'name' => 'text', + 'in' => 'query', + 'schema' => ['description' => 'The text to test.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'title' => '', 'example' => '"abcde"'], ], ], 'responses' => [ 200 => [ 'schema' => [ + 'description' => 'The response body.', 'type' => 'object', 'properties' => [ - 'requestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => 'D77D0DAF-790D-F5F5-A9C0-133738165014', - ], - 'result' => [ - 'description' => 'The information about the rough sort or fine sort expressions that are returned.'."\n" - ."\n" - .'For more information, see [FirstRank](~~170007~~) and [SecondRank](~~170008~~).'."\n", - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'created' => [ - 'description' => 'The timestamp when the sort expression was created.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1655793690', - ], - 'active' => [ - 'description' => 'Indicates whether the expression is the default one.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'description' => [ - 'description' => 'The description of the sort expression.'."\n", - 'type' => 'string', - 'example' => '""', - ], - 'updated' => [ - 'description' => 'The timestamp when the sort expression was updated.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1655793690', - ], - 'name' => [ - 'description' => 'The name of the sort expression.'."\n", - 'type' => 'string', - 'example' => 'default', - ], - ], - ], - ], + 'result' => ['description' => 'The result of the request.', 'type' => 'object', 'title' => '', 'example' => '{}'], + 'RequestId' => ['description' => 'The ID of the request.', 'type' => 'string', 'title' => '', 'example' => '98724351-D6B2-5D8A-B089-7FFD1821A7E9'], ], - 'description' => '', + 'example' => '{}', + 'title' => '', ], ], '5XX' => [ 'schema' => [ 'type' => 'object', 'properties' => [ - 'code' => [ - 'type' => 'string', - ], - 'requestId' => [ - 'type' => 'string', - ], - 'message' => [ - 'type' => 'string', - ], - 'httpCode' => [ - 'type' => 'integer', - 'format' => 'int32', - ], + 'code' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'message' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'requestId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'httpCode' => ['type' => 'integer', 'format' => 'int32', 'description' => '', 'title' => '', 'example' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"requestId\\": \\"D77D0DAF-790D-F5F5-A9C0-133738165014\\",\\n \\"result\\": [\\n {\\n \\"created\\": 1655793690,\\n \\"active\\": true,\\n \\"description\\": \\"\\\\\\"\\\\\\"\\",\\n \\"updated\\": 1655793690,\\n \\"name\\": \\"default\\"\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"D77D0DAF-790D-F5F5-A9C0-133738165014\\n\\n default\\n \\n true\\n \\n static_bm25()\\n \\n 1\\n \\n 1655793690\\n 1655793690\\n\\n\\n default\\n \\n false\\n \\n 0\\n 0\\n false\\n true\\n\\n\\n tests\\n random()+now()\\n true\\n \\n 1587052801\\n 1587052801\\n true\\n false\\n\\n\\n test\\n query_term_count()\\n false\\n \\n 1587052801\\n 1587052801\\n false\\n false\\n\\n4","errorExample":""}]', - 'title' => 'ListSortExpressions', - 'requestParamsDescription' => '**Paging parameters**'."\n" - ."\n" - .'|Parameter|Type|Required|Example|Description|'."\n" - .'|---|---|---|---|---|'."\n" - .'|pageNumber|Integer|No|1|The page number. Default value: 1.|'."\n" - .'|pageSize|Integer|No|10|The number of entries per page. Default value: 10.|', - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', - ], - 'UnbindEsInstance' => [ - 'summary' => 'Unbinds an Elasticsearch instance from an OpenSearch application.', - 'path' => '/v4/openapi/app-groups/{appGroupIdentity}/actions/unbind-es-instance', - 'methods' => [ - 'post', + 'title' => 'ListQueryProcessorAnalyzerResults', + 'summary' => 'Tests the results of query analysis. This operation can be called only for existing applications of the Open Source-compatible Edition.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'opensearch:DescribeQueryProcessor', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'OpenSearch', 'resourceType' => 'QueryProcessor', 'arn' => 'acs:opensearch:{#regionId}:{#accountId}:apps/{#AppGroupId}'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"result\\": {},\\n \\"RequestId\\": \\"98724351-D6B2-5D8A-B089-7FFD1821A7E9\\"\\n}","type":"json"}]', + 'translator' => 'manual', + ], + 'ListQueryProcessorNers' => [ + 'summary' => 'Queries the recommended priority settings for entity types in Named Entity Recognition (NER).', + 'path' => '/v4/openapi/query-processor/ner/default-priorities', + 'methods' => ['get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'write', + 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeCode' => '55264', - 'abilityTreeNodes' => [ - 'FEATUREopensearchQZGKV9', - ], + 'abilityTreeNodes' => ['FEATUREopensearchUIICM8', 'FEATUREopensearchNCXKUT'], ], 'parameters' => [ [ - 'name' => 'appGroupIdentity', - 'in' => 'path', - 'schema' => [ - 'description' => 'The name of the application.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '"my_app_group_name"', - ], + 'name' => 'domain', + 'in' => 'query', + 'schema' => ['description' => 'The industry type.'."\n" + ."\n" + .'- ECOMMERCE: The e-commerce industry.', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'ECOMMERCE', 'title' => ''], ], ], 'responses' => [ @@ -14125,430 +11892,580 @@ 'schema' => [ 'type' => 'object', 'properties' => [ + 'requestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '0A6EB64B-B4C8-CF02-810F-E660812972FF', 'title' => ''], 'result' => [ - 'description' => 'The data returned.'."\n", - 'type' => 'object', - 'example' => '{}', - ], - 'requestId' => [ - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => '0A6EB64B-B4C8-CF02-810F-E660812972FF', + 'description' => 'The priority settings of entity types.'."\n" + ."\n" + .'For more information, see [Priority settings of entity types](~~173616~~).', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'tag' => ['description' => 'The internal name of the entity type.', 'type' => 'string', 'example' => 'brand', 'title' => ''], + 'order' => ['description' => 'The sort order within the same priority level. A smaller value indicates a higher priority. The default value is 0.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'priority' => ['description' => 'The priority level of the entity type. Valid values:'."\n" + ."\n" + .'- HIGH'."\n" + ."\n" + .'- MIDDLE'."\n" + ."\n" + .'- LOW', 'type' => 'string', 'example' => 'HIGH', 'title' => ''], + 'label' => ['description' => 'The name of the entity type.', 'type' => 'string', 'example' => 'brand', 'title' => ''], + ], + 'description' => 'The result'."\n", + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], '5XX' => [ 'schema' => [ 'type' => 'object', 'properties' => [ - 'code' => [ - 'type' => 'string', - ], - 'message' => [ - 'type' => 'string', - ], - 'requestId' => [ - 'type' => 'string', - ], - 'httpCode' => [ - 'type' => 'integer', - 'format' => 'int32', - ], + 'code' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'message' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'requestId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'httpCode' => ['type' => 'integer', 'format' => 'int32', 'description' => '', 'title' => '', 'example' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"result\\": {},\\n \\"requestId\\": \\"0A6EB64B-B4C8-CF02-810F-E660812972FF\\"\\n}","type":"json"}]', - 'title' => 'UnbindEsInstance', - ], - 'BindEsInstance' => [ - 'summary' => 'Binds an Elasticsearch instance.', - 'path' => '/v4/openapi/app-groups/{appGroupIdentity}/actions/bind-es-instance', - 'methods' => [ - 'post', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"0A6EB64B-B4C8-CF02-810F-E660812972FF\\",\\n \\"result\\": [\\n {\\n \\"tag\\": \\"brand\\",\\n \\"order\\": 1,\\n \\"priority\\": \\"HIGH\\",\\n \\"label\\": \\"brand\\"\\n }\\n ]\\n}","type":"json"}]', + 'title' => 'ListQueryProcessorNers', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'opensearch:ListQueryProcessorNers', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'OpenSearch', 'resourceType' => 'QueryProcessor', 'arn' => 'acs:opensearch:{#regionId}:{#accountId}:apps/*'], + ], + ], + ], ], + 'translator' => 'manual', + ], + 'ListQueryProcessors' => [ + 'summary' => 'Queries a list of query analysis rules configured for a specific version of an OpenSearch application.', + 'path' => '/v4/openapi/app-groups/{appGroupIdentity}/apps/{appId}/query-processors', + 'methods' => ['get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'write', + 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'none', + 'operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREopensearchQZGKV9', - ], + 'abilityTreeNodes' => ['FEATUREopensearchNCXKUT', 'FEATUREopensearchUIICM8'], ], 'parameters' => [ [ 'name' => 'appGroupIdentity', 'in' => 'path', - 'schema' => [ - 'description' => 'The name of the application.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'my_app_group_name', - ], + 'schema' => ['description' => 'The application name.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'title' => '', 'example' => 'my_app_group_name'], ], [ - 'name' => 'body', - 'in' => 'body', - 'style' => 'json', - 'schema' => [ - 'type' => 'object', - 'required' => false, - 'description' => 'The body of the request.'."\n", - 'example' => '{'."\n" - .' "esInstanceId": "es-cn-abcde"'."\n" - .'}', - ], + 'name' => 'appId', + 'in' => 'path', + 'schema' => ['description' => 'The application version number.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true, 'title' => '', 'example' => '110157886'], + ], + [ + 'name' => 'isActive', + 'in' => 'query', + 'schema' => ['description' => 'Specifies whether to return default rules. The default value is 0. Valid values:'."\n" + ."\n" + .'- 0: Returns all query analysis rules.'."\n" + ."\n" + .'- 1: Returns only default query analysis rules.'."\n" + ."\n" + .'- 2: Returns only non-default query analysis rules.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'title' => '', 'example' => '0'], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'description' => '', 'type' => 'object', 'properties' => [ + 'requestId' => ['description' => 'The request ID.', 'type' => 'string', 'title' => '', 'example' => '0A6EB64B-B4C8-CF02-810F-E660812972FF'], 'result' => [ - 'description' => 'The result'."\n", - 'type' => 'object', - 'example' => '[]', - ], - 'requestId' => [ - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => 'F5099063-6B86-F398-D843-905F9EFB683A', + 'description' => 'The information about the query analysis rules.'."\n" + ."\n" + .'For more information, see [QueryProcessor](~~170014~~).', + 'type' => 'array', + 'items' => [ + 'description' => 'The returned results.', + 'type' => 'object', + 'properties' => [ + 'created' => ['description' => 'The time when the query analysis rule was created.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '1587398402'], + 'active' => ['description' => 'Indicates whether the query analysis rule is a default rule.', 'type' => 'boolean', 'title' => '', 'example' => 'true'], + 'updated' => ['description' => 'The time when the query analysis rule was last modified.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '1587398402'], + 'name' => ['description' => 'The name of the query analysis rule.', 'type' => 'string', 'title' => '', 'example' => 'ner'], + 'domain' => ['description' => 'The industry to which the query analysis rule applies. Valid values:'."\n" + ."\n" + .'- GENERAL: General'."\n" + ."\n" + .'- ECOMMERCE: E-commerce'."\n" + ."\n" + .'- IT\\_CONTENT: IT content', 'type' => 'string', 'title' => '', 'example' => 'GENERAL'], + 'indexes' => [ + 'description' => 'The indexes to which the query analysis rule is applied.', + 'type' => 'array', + 'items' => ['description' => 'The indexes to which the query analysis rule is applied.', 'type' => 'string', 'title' => '', 'example' => '[ "default" ]'], + 'title' => '', + 'example' => '', + ], + 'processors' => [ + 'description' => 'The features that are used in the query analysis rule.', + 'type' => 'array', + 'items' => ['description' => 'The features that are used in the query analysis rule.'."\n" + ."\n" + .'For more information, see [Processor](~~170014~~).', 'type' => 'object', 'title' => '', 'example' => '[]'], + 'title' => '', + 'example' => '', + ], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', ], ], - 'example' => '{}', + 'description' => '', + 'title' => '', + 'example' => '', ], ], '5XX' => [ 'schema' => [ 'type' => 'object', 'properties' => [ - 'code' => [ - 'type' => 'string', - ], - 'message' => [ - 'type' => 'string', - ], - 'requestId' => [ - 'type' => 'string', - ], - 'httpCode' => [ - 'type' => 'integer', - 'format' => 'int32', - ], + 'code' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'message' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'requestId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'httpCode' => ['type' => 'integer', 'format' => 'int32', 'description' => '', 'title' => '', 'example' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"result\\": {},\\n \\"requestId\\": \\"F5099063-6B86-F398-D843-905F9EFB683A\\"\\n}","type":"json"}]', - 'title' => 'BindEsInstance', - ], - 'BindESUserAnalyzer' => [ - 'summary' => 'Binds a custom analyzer to an Elasticsearch instance.', - 'path' => '/v4/openapi/app-groups/{appGroupIdentity}/es/{esInstanceId}/actions/bind-analyzer', - 'methods' => [ - 'post', + 'title' => 'ListQueryProcessors', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'opensearch:ListQueryProcessor', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'OpenSearch', 'resourceType' => 'QueryProcessor', 'arn' => 'acs:opensearch:{#regionId}:{#accountId}:apps/{#AppGroupId}'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"0A6EB64B-B4C8-CF02-810F-E660812972FF\\",\\n \\"result\\": [\\n {\\n \\"created\\": 1587398402,\\n \\"active\\": true,\\n \\"updated\\": 1587398402,\\n \\"name\\": \\"ner\\",\\n \\"domain\\": \\"GENERAL\\",\\n \\"indexes\\": [\\n \\"[ \\\\\\"default\\\\\\" ]\\"\\n ],\\n \\"processors\\": [\\n []\\n ]\\n }\\n ]\\n}","type":"json"}]', + 'translator' => 'manual', + ], + 'ListQuotaReviewTasks' => [ + 'path' => '/v4/openapi/app-groups/{appGroupIdentity}/quota-review-tasks', + 'methods' => ['get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'write', + 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeCode' => '55141', - 'abilityTreeNodes' => [ - 'FEATUREopensearch447AAX', - ], + 'abilityTreeNodes' => ['FEATUREopensearch447AAX', 'FEATUREopensearch5OZOSP'], ], 'parameters' => [ [ 'name' => 'appGroupIdentity', 'in' => 'path', - 'schema' => [ - 'description' => 'The name of the application.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '130187460', - ], + 'schema' => ['description' => 'The name of the application group.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'title' => '', 'example' => '"my_app_name"'], ], [ - 'name' => 'esInstanceId', - 'in' => 'path', - 'schema' => [ - 'description' => 'The ID of the instance.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'es-cn-zvp2g952l000v5uxp', - ], + 'name' => 'pageNumber', + 'in' => 'query', + 'schema' => ['description' => 'The page number. The default value is 1.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'title' => '', 'example' => '1'], ], [ - 'name' => 'body', - 'in' => 'body', - 'schema' => [ - 'description' => 'The request parameters.'."\n", - 'type' => 'any', - 'required' => false, - 'example' => '{'."\n" - .' "name": "kevintest-analyzer"'."\n" - .'}', - ], + 'name' => 'pageSize', + 'in' => 'query', + 'schema' => ['description' => 'The number of entries to return on each page. The default value is 10.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'title' => '', 'example' => '10'], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'description' => 'The response body.'."\n", + 'description' => 'The response object.', 'type' => 'object', 'properties' => [ + 'totalCount' => ['description' => 'The total number of entries.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '500'], + 'requestId' => ['description' => 'The request ID.', 'type' => 'string', 'title' => '', 'example' => '"3351A21F-705B-508C-9450-DA65A681547F"'], 'result' => [ - 'description' => 'The custom analyzer.'."\n", - 'type' => 'object', + 'description' => 'The information about the approval tickets. For more information, see [QuotaReviewTask](~~173609~~).', + 'type' => 'array', + 'items' => [ + 'description' => 'The result object.', + 'type' => 'object', + 'properties' => [ + 'oldDocSize' => ['description' => 'The original storage capacity.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '900'], + 'pending' => ['description' => 'Indicates whether the task is pending.', 'type' => 'boolean', 'title' => '', 'example' => 'false'], + 'memo' => ['description' => 'The remarks.', 'type' => 'string', 'title' => '', 'example' => 'null'], + 'approved' => ['description' => 'Indicates whether the task is approved.', 'type' => 'boolean', 'title' => '', 'example' => 'true'], + 'oldSpec' => ['description' => 'The original specifications of the application.', 'type' => 'string', 'title' => '', 'example' => '"opensearch.private.common"'], + 'oldComputeResource' => ['description' => 'The original computing resource.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '500'], + 'appGroupType' => ['description' => 'The application type.', 'type' => 'string', 'title' => '', 'example' => '"standard"'], + 'available' => ['description' => 'Indicates whether the resource is active.', 'type' => 'boolean', 'title' => '', 'example' => 'true'], + 'gmtCreate' => ['description' => 'The time when the task was created.', 'type' => 'string', 'title' => '', 'example' => '"2020-04-08T08:29:45+0000"'], + 'newSocSize' => ['description' => 'The target storage capacity.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '1100'], + 'id' => ['description' => 'The ticket ID.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '142'], + 'appGroupId' => ['description' => 'The application ID.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '120123456'], + 'newComputeResource' => ['description' => 'The target computing resource.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '6000'], + 'appGroupName' => ['description' => 'The application name.', 'type' => 'string', 'title' => '', 'example' => '"td_test_os"'], + 'gmtModified' => ['description' => 'The time of the last modification.', 'type' => 'string', 'title' => '', 'example' => '"2020-04-08T08:36:36+0000"'], + 'newSpec' => ['description' => 'The new application specifications.', 'type' => 'string', 'title' => '', 'example' => '"opensearch.private.common"'], + ], + 'example' => '{}', + 'title' => '', + ], 'example' => '[]', - ], - 'requestId' => [ - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => '3AD34CAD-9603-5251-AFF5-3916C848A1D3', + 'title' => '', ], ], - 'example' => '{}', + 'title' => '', + 'example' => '', ], ], '5XX' => [ 'schema' => [ 'type' => 'object', 'properties' => [ - 'code' => [ - 'type' => 'string', - ], - 'message' => [ - 'type' => 'string', - ], - 'requestId' => [ - 'type' => 'string', - ], - 'httpCode' => [ - 'type' => 'integer', - 'format' => 'int32', - ], + 'code' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'httpCode' => ['type' => 'integer', 'format' => 'int32', 'description' => '', 'title' => '', 'example' => ''], + 'requestId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'message' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"result\\": [],\\n \\"requestId\\": \\"3AD34CAD-9603-5251-AFF5-3916C848A1D3\\"\\n}","type":"json"}]', - 'title' => 'BindESUserAnalyzer', - ], - 'UnbindESUserAnalyzer' => [ - 'summary' => 'Unbinds a custom analyzer from an Elasticsearch instance.', - 'path' => '/v4/openapi/app-groups/{appGroupIdentity}/es/{esInstanceId}/actions/unbind-analyzer', - 'methods' => [ - 'post', + 'title' => 'ListQuotaReviewTasks', + 'summary' => 'Lists the quota approval tickets for a specified OpenSearch application.', + 'requestParamsDescription' => 'Sample request:'."\n" + ."\n" + .'```'."\n" + .'GET /v4/openapi/app-groups/demo/quota-review-tasks'."\n" + .'```', + 'responseParamsDescription' => 'Sample response:'."\n" + ."\n" + .'```json'."\n" + .'{'."\n" + .' "id": 142,'."\n" + .' "appGroupId": 120577535,'."\n" + .' "appGroupName": "td_trade_order_os",'."\n" + .' "appGroupType": "standard",'."\n" + .' "oldSpec": "opensearch.private.common",'."\n" + .' "oldComputeResource": 500,'."\n" + .' "oldDocSize": 900,'."\n" + .' "newSpec": "opensearch.private.common",'."\n" + .' "newComputeResource": 6000,'."\n" + .' "newSocSize": 1100,'."\n" + .' "memo": null,'."\n" + .' "available": true,'."\n" + .' "pending": false,'."\n" + .' "approved": true,'."\n" + .' "gmtCreate": "2020-04-08T08:29:45+0000",'."\n" + .' "gmtModified": "2020-04-08T08:36:36+0000"'."\n" + .'}'."\n" + .'```', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'opensearch:DescribeApp', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'OpenSearch', 'resourceType' => 'AppGroup', 'arn' => 'acs:opensearch:{#regionId}:{#accountId}:apps/{#AppGroupId}'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"totalCount\\": 500,\\n \\"requestId\\": \\"\\\\\\"3351A21F-705B-508C-9450-DA65A681547F\\\\\\"\\",\\n \\"result\\": [\\n {\\n \\"oldDocSize\\": 900,\\n \\"pending\\": false,\\n \\"memo\\": \\"null\\",\\n \\"approved\\": true,\\n \\"oldSpec\\": \\"\\\\\\"opensearch.private.common\\\\\\"\\",\\n \\"oldComputeResource\\": 500,\\n \\"appGroupType\\": \\"\\\\\\"standard\\\\\\"\\",\\n \\"available\\": true,\\n \\"gmtCreate\\": \\"\\\\\\"2020-04-08T08:29:45+0000\\\\\\"\\",\\n \\"newSocSize\\": 1100,\\n \\"id\\": 142,\\n \\"appGroupId\\": 120123456,\\n \\"newComputeResource\\": 6000,\\n \\"appGroupName\\": \\"\\\\\\"td_test_os\\\\\\"\\",\\n \\"gmtModified\\": \\"\\\\\\"2020-04-08T08:36:36+0000\\\\\\"\\",\\n \\"newSpec\\": \\"\\\\\\"opensearch.private.common\\\\\\"\\"\\n }\\n ]\\n}","type":"json"}]', + 'translator' => 'manual', + ], + 'ListScheduledTasks' => [ + 'summary' => 'Queries a list of scheduled tasks for an OpenSearch application.', + 'path' => '/v4/openapi/app-groups/{appGroupIdentity}/scheduled-tasks', + 'methods' => ['get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'write', + 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'none', + 'operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREopensearch447AAX', - ], + 'abilityTreeNodes' => ['FEATUREopensearch447AAX', 'FEATUREopensearch5OZOSP'], ], 'parameters' => [ [ 'name' => 'appGroupIdentity', 'in' => 'path', - 'schema' => [ - 'description' => 'The name of the application.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'my_app_group_name', - ], + 'schema' => ['description' => 'The application name.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'my_app_group_name', 'title' => ''], ], [ - 'name' => 'esInstanceId', - 'in' => 'path', - 'schema' => [ - 'description' => 'The ID of the instance.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'es-cn-zvp2ff3iq000myzv7', - ], + 'name' => 'type', + 'in' => 'query', + 'schema' => ['description' => 'The type of the scheduled task. Valid values:'."\n" + ."\n" + .'- wipe: data cleaning'."\n" + ."\n" + .'- fork: reindexing'."\n" + ."\n" + .'- check-status: application status check'."\n" + ."\n" + .'- index: reindexing', 'type' => 'string', 'required' => false, 'example' => 'wipe', 'title' => ''], ], [ - 'name' => 'body', - 'in' => 'body', - 'schema' => [ - 'description' => 'The request parameters.'."\n", - 'type' => 'any', - 'required' => false, - 'example' => '{'."\n" - .' "name": "kevintest-analyzer"'."\n" - .'}', - ], + 'name' => 'pageNumber', + 'in' => 'query', + 'schema' => ['description' => 'The page number. Default value: 1.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'title' => ''], + ], + [ + 'name' => 'pageSize', + 'in' => 'query', + 'schema' => ['description' => 'The number of entries per page. Default value: 10.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'description' => 'The response body.'."\n", 'type' => 'object', 'properties' => [ + 'totalCount' => ['description' => 'The total number of entries returned.', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => ''], + 'requestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '0A6EB64B-B4C8-CF02-810F-E660812972FF', 'title' => ''], 'result' => [ - 'description' => 'The custom analyzer.'."\n", - 'type' => 'object', - 'example' => '[]', - ], - 'requestId' => [ - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => '0A6EB64B-B4C8-CF02-810F-E660812972FF', + 'type' => 'array', + 'items' => ['description' => 'The information about the scheduled task.'."\n" + ."\n" + .'For more information, see [ScheduledTask](~~173610~~).', 'type' => 'object', 'example' => '[]', 'title' => ''], + 'description' => '', + 'title' => '', + 'example' => '', ], ], - 'example' => '{}', + 'description' => '', + 'title' => '', + 'example' => '', ], ], '5XX' => [ 'schema' => [ 'type' => 'object', 'properties' => [ - 'code' => [ - 'type' => 'string', - ], - 'message' => [ - 'type' => 'string', - ], - 'requestId' => [ - 'type' => 'string', - ], - 'httpCode' => [ - 'type' => 'integer', - 'format' => 'int32', - ], + 'code' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'message' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'requestId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'httpCode' => ['type' => 'integer', 'format' => 'int32', 'description' => '', 'title' => '', 'example' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"result\\": [],\\n \\"requestId\\": \\"0A6EB64B-B4C8-CF02-810F-E660812972FF\\"\\n}","type":"json"}]', - 'title' => 'UnbindESUserAnalyzer', - 'description' => 'You can call this operation to unbind a custom analyzer from an Elasticsearch instance.'."\n", - ], - 'ListProceedings' => [ - 'summary' => '查看当前的处理流', - 'path' => '/v4/openapi/app-groups/{appGroupIdentity}/proceedings', - 'methods' => [ - 'get', + 'title' => 'ListScheduledTasks', + 'requestParamsDescription' => '**Query parameters**'."\n" + ."\n" + .'| Field | Type | Required | Example | Description |'."\n" + .'| ------- | ------- | -------- | -------------------------------------- | ------------------------------------------------------- |'."\n" + .'| id | String | No | "2f12c585-5873-11ea-974a-7cd30ad3e268" | The task ID. |'."\n" + .'| enabled | Boolean | No | true | Specifies whether the scheduled task is enabled. |'."\n" + .'| updated | Integer | No | 1582706232 | The timestamp when the scheduled task was last updated. |', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'opensearch:ListScheduledTask', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'OpenSearch', 'resourceType' => 'ScheduledTask', 'arn' => 'acs:opensearch:{#regionId}:{#accountId}:app-groups/{#AppGroupId}'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"totalCount\\": 1,\\n \\"requestId\\": \\"0A6EB64B-B4C8-CF02-810F-E660812972FF\\",\\n \\"result\\": [\\n []\\n ]\\n}","type":"json"}]', + 'translator' => 'manual', + ], + 'ListSearchStrategies' => [ + 'summary' => 'Retrieves the details of query policies.', + 'path' => '/v4/openapi/app-groups/{appGroupIdentity}/apps/{appId}/search-strategies', + 'methods' => ['get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'readAndWrite', + 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'none', + 'operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREopensearch447AAX', - 'FEATUREopensearch5OZOSP', - ], + 'abilityTreeNodes' => ['FEATUREopensearchBNTDZX'], ], 'parameters' => [ [ 'name' => 'appGroupIdentity', 'in' => 'path', - 'schema' => [ - 'description' => 'The ID of the application instance group.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '120677456', - ], + 'schema' => ['description' => 'The name of the application.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'title' => '', 'example' => '"my_app"'], ], [ - 'name' => 'filterFinished', - 'in' => 'query', - 'schema' => [ - 'description' => 'Specifies whether the filtering is complete.'."\n", - 'type' => 'boolean', - 'required' => false, - 'example' => 'true', - ], + 'name' => 'appId', + 'in' => 'path', + 'schema' => ['description' => 'The ID of the application version.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'title' => '', 'example' => '"110123456"'], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'The schema of the response.'."\n", + 'description' => 'The returned object.', 'type' => 'object', 'properties' => [ - 'requestId' => [ - 'title' => 'Id of the request', - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => 'F5099063-6B86-F398-D843-905F9EFB683A', - ], + 'requestId' => ['description' => 'The ID of the request.', 'type' => 'string', 'title' => '', 'example' => '9C6351F5-2E2E-5249-888B-88A74E1B8A65'], + ], + 'example' => '{}', + 'title' => '', + ], + ], + '5XX' => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'code' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'message' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'requestId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'httpCode' => ['type' => 'integer', 'format' => 'int32', 'description' => '', 'title' => '', 'example' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + ], + ], + 'title' => 'ListSearchStrategies', + 'responseParamsDescription' => 'The following is a sample result object:'."\n" + ."\n" + .'```json'."\n" + .'{'."\n" + .' "name": "test",'."\n" + .' "status": 1,'."\n" + .' "description": "",'."\n" + .' "updated": 12455,'."\n" + .' "searchConfigs": ['."\n" + .' {'."\n" + .' "queryType": "vector",'."\n" + .' "firstRankName": "",'."\n" + .' "secondRankName": "",'."\n" + .' "mergeProportion": 30'."\n" + .' },'."\n" + .' {'."\n" + .' "queryType": "keyword",'."\n" + .' "firstRankName": "",'."\n" + .' "secondName": "",'."\n" + .' "mergeProportion": 70'."\n" + .' }'."\n" + .' ],'."\n" + .' "mergeConfig": {'."\n" + .' "rankName": "",'."\n" + .' "docCount": 5000'."\n" + .' }'."\n" + .'}'."\n" + .'```', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'opensearch:DescribeSearchStrategy', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'OpenSearch', 'resourceType' => 'SearchStrategy', 'arn' => 'acs:opensearch:{#regionId}:{#accountId}:apps/{#AppGroupId}'], ], - 'example' => '{}', ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"F5099063-6B86-F398-D843-905F9EFB683A\\"\\n}","type":"json"}]', - 'title' => 'ListProceedings', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"9C6351F5-2E2E-5249-888B-88A74E1B8A65\\"\\n}","type":"json"}]', + 'translator' => 'manual', ], - 'ListStatisticLogs' => [ - 'summary' => 'Queries log statistics, such as application error logs, hotword rankings, and slow query logs.', - 'path' => '/v4/openapi/app-groups/{appGroupIdentity}/statistic-logs/{moduleName}', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'ListSecondRanks' => [ + 'summary' => 'Lists the fine sort expressions for a specific version of an OpenSearch application.', + 'path' => '/v4/openapi/app-groups/{appGroupIdentity}/apps/{appId}/second-ranks', + 'methods' => ['get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -14557,215 +12474,113 @@ 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'none', + 'operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREopensearch447AAX', - 'FEATUREopensearch5OZOSP', - ], + 'abilityTreeNodes' => ['FEATUREopensearchN8M8WS', 'FEATUREopensearchJUWEG4'], ], 'parameters' => [ [ 'name' => 'appGroupIdentity', 'in' => 'path', - 'schema' => [ - 'description' => 'The application name.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'app_group_name', - ], + 'schema' => ['description' => 'The name or ID of the application group.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'title' => '', 'example' => 'my_app_group_name'], ], [ - 'name' => 'moduleName', + 'name' => 'appId', 'in' => 'path', - 'schema' => [ - 'description' => 'The module name. Valid values:'."\n" - ."\n" - .'* hot: rankings of hotwords.'."\n" - .'* error: application error logs.'."\n" - .'* slow-log: slow query logs.'."\n" - ."\n" - .'Set the value to hot.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'hot', - ], - ], - [ - 'name' => 'startTime', - 'in' => 'query', - 'schema' => [ - 'description' => 'The beginning of the time range to query. The default value is the timestamp of 00:00:00 on the current day.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'maximum' => '9999999999', - 'minimum' => '0', - 'example' => '1582214400', - ], - ], - [ - 'name' => 'stopTime', - 'in' => 'query', - 'schema' => [ - 'description' => 'The end of the time range to query. The default value is the timestamp of 24:00:00 on the current day.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'maximum' => '9999999999', - 'minimum' => '0', - 'example' => '1682222400', - ], - ], - [ - 'name' => 'pageNumber', - 'in' => 'query', - 'schema' => [ - 'description' => 'The page number. Default value: 1.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'maximum' => '1000', - 'minimum' => '1', - 'example' => '1', - ], - ], - [ - 'name' => 'pageSize', - 'in' => 'query', - 'schema' => [ - 'description' => 'The number of entries per page. Default value: 10.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'maximum' => '10000', - 'minimum' => '1', - 'example' => '10', - ], - ], - [ - 'name' => 'query', - 'in' => 'query', - 'schema' => [ - 'description' => 'The content of the query clause.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '"default:\'OpenSearch\'"', - ], - ], - [ - 'name' => 'sortBy', - 'in' => 'query', - 'schema' => [ - 'description' => 'The content of the sort clause.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '"-id"', - ], - ], - [ - 'name' => 'distinct', - 'in' => 'query', - 'schema' => [ - 'description' => 'Specifies whether to use the distinct clause.'."\n", - 'type' => 'boolean', - 'required' => false, - 'example' => 'true', - ], - ], - [ - 'name' => 'columns', - 'in' => 'query', - 'schema' => [ - 'description' => 'The fields to query. Format: columns=wordsTopPv.'."\n" - ."\n" - .'For more information, see [Metrics in statistical reports](~~187665~~).'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'wordsTopPv', - ], + 'schema' => ['description' => 'The version number.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true, 'title' => '', 'example' => '110157886'], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ - 'totalCount' => [ - 'description' => 'The total number of entries returned.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - ], - 'requestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => 'F76ACE3D-E510-EE2C-B7B1-39B3136A61EE', - ], + 'totalCount' => ['description' => 'The total number of entries returned.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '1'], + 'requestId' => ['description' => 'The request ID.', 'type' => 'string', 'title' => '', 'example' => '0A6EB64B-B4C8-CF02-810F-E660812972FF'], 'result' => [ - 'description' => 'The returned result. For more information, see'."\n" + 'description' => 'A list of fine-sort expressions.'."\n" ."\n" - .'* [Parameters of hotwords rankings](~~421248~~).'."\n", + .'For more information, see [SecondRank](~~170008~~).', 'type' => 'array', 'items' => [ - 'description' => 'The returned result. For more information, see'."\n" - ."\n" - .'* [Parameters of hotwords rankings](~~187660~~).'."\n", 'type' => 'object', - 'example' => '[]', + 'properties' => [ + 'created' => ['description' => 'The time when the expression was created.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '0'], + 'active' => ['description' => 'Indicates whether the expression is active.', 'type' => 'boolean', 'title' => '', 'example' => 'false'], + 'isDefault' => ['description' => 'Indicates whether the expression is the default one. This parameter is displayed only in the response.'."\n" + ."\n" + .'- true: The expression is the default one.'."\n" + ."\n" + .'- false: The expression is not the default one.', 'type' => 'string', 'title' => '', 'example' => 'false'], + 'isSys' => ['description' => 'Indicates whether the expression is a system expression. This parameter is displayed only in the response.'."\n" + ."\n" + .'- true: The expression is a system expression.'."\n" + ."\n" + .'- false: The expression is not a system expression.', 'type' => 'string', 'title' => '', 'example' => 'true'], + 'description' => ['description' => 'The description of the expression.', 'type' => 'string', 'title' => '', 'example' => '""'], + 'updated' => ['description' => 'The time when the expression was updated.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '1587052801'], + 'name' => ['description' => 'The name of the expression.', 'type' => 'string', 'title' => '', 'example' => 'tests'], + 'meta' => ['description' => 'The content of the fine-sort expression. You can define an expression that consists of fields, feature functions, and mathematical functions to implement complex sort logic.', 'type' => 'string', 'title' => '', 'example' => 'random()+now()'], + 'id' => ['description' => 'The ID of the expression. This parameter is displayed only in the response.', 'type' => 'string', 'title' => '', 'example' => '890473'], + ], + 'description' => '', + 'title' => '', + 'example' => '', ], - 'example' => '[]', + 'title' => '', + 'example' => '', ], ], - 'example' => '{}', + 'description' => '', + 'title' => '', + 'example' => '', ], ], '5XX' => [ 'schema' => [ 'type' => 'object', 'properties' => [ - 'code' => [ - 'type' => 'string', - ], - 'message' => [ - 'type' => 'string', - ], - 'requestId' => [ - 'type' => 'string', - ], - 'httpCode' => [ - 'type' => 'integer', - 'format' => 'int32', - ], + 'code' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'message' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'requestId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'httpCode' => ['type' => 'integer', 'format' => 'int32', 'description' => '', 'title' => '', 'example' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"totalCount\\": 1,\\n \\"requestId\\": \\"F76ACE3D-E510-EE2C-B7B1-39B3136A61EE\\",\\n \\"result\\": [\\n [\\n {\\n \\"rawQuery\\": \\"淘宝\\",\\n \\"pv\\": 100\\n }\\n ]\\n ]\\n}","errorExample":""},{"type":"xml","example":"F76ACE3D-E510-EE2C-B7B1-39B3136A61EE\\n\\n 淘宝\\n 100\\n\\n1","errorExample":""}]', - 'title' => 'ListStatisticLogs', + 'title' => 'ListSecondRanks', 'requestParamsDescription' => ' ', - 'responseParamsDescription' => '**Parameters of hotwords rankings**'."\n" - ."\n" - .'|Parameter|Type|Description|'."\n" - .'|---|---|---|'."\n" - .'|rawQuery|String|The hotword.|'."\n" - .'|pv|Integer|The number of page views.|', + 'responseParamsDescription' => ' ', 'extraInfo' => ' ', - ], - 'ListStatisticReport' => [ - 'summary' => 'Queries statistical reports, such as application reports, drop-down suggestion reports, hotword shading reports, A/B test reports, and data quality reports.', - 'path' => '/v4/openapi/app-groups/{appGroupIdentity}/statistic-report/{moduleName}', - 'methods' => [ - 'get', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'opensearch:ListSecondRank', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'OpenSearch', 'resourceType' => 'SecondRank', 'arn' => 'acs:opensearch:{#regionId}:{#accountId}:apps/{#AppGroupId}'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"totalCount\\": 1,\\n \\"requestId\\": \\"0A6EB64B-B4C8-CF02-810F-E660812972FF\\",\\n \\"result\\": [\\n {\\n \\"created\\": 0,\\n \\"active\\": false,\\n \\"isDefault\\": \\"false\\",\\n \\"isSys\\": \\"true\\",\\n \\"description\\": \\"\\\\\\"\\\\\\"\\",\\n \\"updated\\": 1587052801,\\n \\"name\\": \\"tests\\",\\n \\"meta\\": \\"random()+now()\\",\\n \\"id\\": \\"890473\\"\\n }\\n ]\\n}","type":"json"}]', + 'translator' => 'manual', + ], + 'ListSlowQueryCategories' => [ + 'summary' => 'Lists the optimization suggestions for slow queries from Search Diagnosis.', + 'path' => '/v4/openapi/app-groups/{appGroupIdentity}/optimizers/slow-query/categories', + 'methods' => ['get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -14777,575 +12592,575 @@ 'operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREopensearchA9FOU5', - 'FEATUREopensearchAKNSFD', - ], + 'abilityTreeNodes' => ['FEATUREopensearchA0YLTY', 'FEATUREopensearch9TYTPZ'], ], 'parameters' => [ [ 'name' => 'appGroupIdentity', 'in' => 'path', - 'schema' => [ - 'description' => 'The name of the application'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'app_group_name', - ], - ], - [ - 'name' => 'moduleName', - 'in' => 'path', - 'schema' => [ - 'description' => 'The module name. Valid values:'."\n" - ."\n" - .'* app: Business operation report.'."\n" - .'* app-query: Business operation report> Query analysis metric.'."\n" - .'* abtest: A/B test report.'."\n" - .'* suggest: Drop-down suggestion report.'."\n" - .'* hot: Hotword report.'."\n" - .'* hint: Shading report'."\n" - .'* data-quality'."\n" - .'* es: Open-source compatible instance report'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'suggest', - ], + 'schema' => ['description' => 'The name of the application.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'title' => '', 'example' => 'my_app_group_name'], ], - [ - 'name' => 'startTime', - 'in' => 'query', + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => 'The start timestamp of the query. Unit: seconds.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'maximum' => '9999999999', - 'minimum' => '0', - 'example' => '1582214400', + 'type' => 'object', + 'properties' => [ + 'requestId' => ['description' => 'The request ID.', 'type' => 'string', 'title' => '', 'example' => '4406F40B-A0A2-9D5D-531F-3B6936567584'], + 'result' => [ + 'description' => 'The returned data.', + 'type' => 'object', + 'properties' => [ + 'start' => ['description' => 'The start timestamp.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '1589986800'], + 'analyzeStatus' => ['description' => 'The analysis status.'."\n" + ."\n" + .'- PENDING: The analysis is being prepared.'."\n" + ."\n" + .'- SUCCESS: The analysis is successful.'."\n" + ."\n" + .'- RUNNING: The analysis is in progress.'."\n" + ."\n" + .'- FAILED: The analysis failed.'."\n" + ."\n" + .'- N/A: The analysis status is unknown.', 'type' => 'string', 'title' => '', 'example' => '"PENDING"'], + 'end' => ['description' => 'The end timestamp.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '1589990340'], + ], + 'title' => '', + 'example' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], - [ - 'name' => 'endTime', - 'in' => 'query', + '5XX' => [ 'schema' => [ - 'description' => 'The end timestamp of the query. By default, the end time is the current time. Unit: seconds.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'maximum' => '9999999999', - 'minimum' => '0', - 'example' => '1582646399', + 'type' => 'object', + 'properties' => [ + 'code' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'message' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'requestId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'httpCode' => ['type' => 'integer', 'format' => 'int32', 'description' => '', 'title' => '', 'example' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], + ], + 'title' => 'ListSlowQueryCategories', + 'requestParamsDescription' => '**Request example**'."\n" + ."\n" + .'`GET /v4/openapi/app-groups/kevintest2/optimizers/slow-query/categories?end=1589990340&sort=max&start=1589986800`'."\n" + ."\n" + .'**Query parameters**'."\n" + ."\n" + .'| Parameter | Type | Required | Example | Description |'."\n" + .'| --------- | ------- | -------- | ---------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------- |'."\n" + .'| start | Integer | Yes | 1589986800 | The start of the time range to query. This is a UNIX timestamp and is accurate to the second. |'."\n" + .'| end | Integer | Yes | 1589990340 | The end of the time range to query. This is a UNIX timestamp and is accurate to the second. |'."\n" + .'| sort | String | No | "max" | The sorting method.Valid values:
\\- max: the maximum value
\\- avg: the average value
\\- sum: the total value
\\- queryProportion: the query proportion |', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ [ - 'name' => 'pageNumber', - 'in' => 'query', - 'schema' => [ - 'description' => 'The page number.'."\n" - ."\n" - .'Default value: 1.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'maximum' => '100', - 'minimum' => '1', - 'example' => '1', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'opensearch:ListSlowQueryCategories', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'OpenSearch', 'resourceType' => 'AppGroup', 'arn' => 'acs:opensearch:{#regionId}:{#accountId}:apps/{#AppGroupId}'], + ], ], ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"4406F40B-A0A2-9D5D-531F-3B6936567584\\",\\n \\"result\\": {\\n \\"start\\": 1589986800,\\n \\"analyzeStatus\\": \\"\\\\\\"PENDING\\\\\\"\\",\\n \\"end\\": 1589990340\\n }\\n}","type":"json"}]', + 'translator' => 'manual', + ], + 'ListSlowQueryQueries' => [ + 'path' => '/v4/openapi/app-groups/{appGroupIdentity}/optimizers/slow-query/categories/{categoryIndex}/queries', + 'methods' => ['get'], + 'schemes' => ['http', 'https'], + 'security' => [ [ - 'name' => 'pageSize', - 'in' => 'query', - 'schema' => [ - 'description' => 'The number of entries per page. Default value: 10.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'maximum' => '10000', - 'minimum' => '1', - 'example' => '10', - ], + 'AK' => [], ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATUREopensearchA0YLTY', 'FEATUREopensearch9TYTPZ'], + ], + 'parameters' => [ [ - 'name' => 'columns', - 'in' => 'query', - 'schema' => [ - 'description' => 'The fields to query. Set this parameter in the format of columns="pv,uv,ipv". For more information, see [Metrics of statistical reports](~~187665~~).', - 'type' => 'string', - 'required' => false, - 'example' => 'pv,uv', - ], + 'name' => 'appGroupIdentity', + 'in' => 'path', + 'schema' => ['description' => 'The name of the application.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'title' => '', 'example' => 'my_app_group_name'], ], [ - 'name' => 'query', - 'in' => 'query', - 'schema' => [ - 'description' => 'The query conditions. Set this parameter in the format of k1:v1,k2:v2. Valid values:'."\n" - ."\n" - .'* experimentSerialNumber: the globally unique sequence number of the test'."\n" - .'* sceneTag: the tag of the test scenario'."\n" - .'* bizType: the type of the business'."\n" - .'* modelId: the ID of the algorithm model'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'bizType:test,sceneTag:myTag', - ], + 'name' => 'categoryIndex', + 'in' => 'path', + 'schema' => ['description' => 'The ID of the optimization suggestion.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'title' => '', 'example' => '0'], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'description' => 'The rsponse body.'."\n", 'type' => 'object', 'properties' => [ - 'totalCount' => [ - 'description' => 'The total number of entries returned.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '43', - ], - 'requestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => 'F65C8BB2-C14F-5983-888B-41C4E082D3BC', - ], + 'requestId' => ['description' => 'The request ID.', 'type' => 'string', 'title' => '', 'example' => 'EB250CA0-ACFD-C5DE-17CD-01445BFE8AE5'], 'result' => [ - 'description' => 'The statistical reports. Valid values:'."\n" - ."\n" - .'* For more information about the metrics in data quality reports, see the Upload behavioral data section of [Data collection 2.0](~~131547~~).'."\n" - .'* For more information about the metrics in application and A/B test reports, see the Core metrics section of [Metrics of statistical reports](~~187665~~).'."\n" - .'* For more information about the metrics in query analysis reports, see the Query analysis metrics section of [Metrics of statistical reports](~~187665~~).'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The result body.'."\n", - 'type' => 'object', - 'example' => '{}', + 'description' => 'The result of the request.', + 'type' => 'object', + 'properties' => [ + 'index' => ['description' => 'The ID of the optimization suggestion.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '0'], + 'appQuery' => ['description' => 'The information about the optimization suggestion.', 'type' => 'string', 'title' => '', 'example' => 'no data'], + 'start' => ['description' => 'The start timestamp.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '1589986800'], + 'end' => ['description' => 'The end timestamp.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '1589990340'], ], - 'example' => '[]', + 'title' => '', + 'example' => '', ], ], - 'example' => '[]', + 'description' => '', + 'title' => '', + 'example' => '', ], ], '5XX' => [ 'schema' => [ 'type' => 'object', 'properties' => [ - 'code' => [ - 'type' => 'string', - ], - 'message' => [ - 'type' => 'string', - ], - 'requestId' => [ - 'type' => 'string', - ], - 'httpCode' => [ - 'type' => 'integer', - 'format' => 'int32', - ], + 'code' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'message' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'requestId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'httpCode' => ['type' => 'integer', 'format' => 'int32', 'description' => '', 'title' => '', 'example' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"totalCount\\": 43,\\n \\"requestId\\": \\"F65C8BB2-C14F-5983-888B-41C4E082D3BC\\",\\n \\"result\\": [\\n {}\\n ]\\n}","type":"json"}]', - 'title' => 'ListStatisticReport', - ], - 'UpdateSortScript' => [ - 'summary' => 'Modifies the description of a sort script.', - 'path' => '/v4/openapi/app-groups/{appGroupIdentity}/apps/{appVersionId}/sort-scripts/{scriptName}', - 'methods' => [ - 'put', + 'title' => 'ListSlowQueryQueries', + 'summary' => 'Lists the slow queries from the Query Optimizer.', + 'requestParamsDescription' => '**Query parameters**'."\n" + ."\n" + .'| Field | Type | Required | Example | Description |'."\n" + .'| ----- | ------- | -------- | ---------- | ---------------------------------------- |'."\n" + .'| start | Integer | Yes | 1589986800 | The start UNIX timestamp. Unit: seconds. |'."\n" + .'| end | Integer | Yes | 1589990340 | The end UNIX timestamp. Unit: seconds. |'."\n" + .'| size | Integer | No | 10 | The number of entries to return. |', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'opensearch:ListSlowQueryQueries', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'OpenSearch', 'resourceType' => 'AppGroup', 'arn' => 'acs:opensearch:{#regionId}:{#accountId}:apps/{#AppGroupId}'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"EB250CA0-ACFD-C5DE-17CD-01445BFE8AE5\\",\\n \\"result\\": {\\n \\"index\\": 0,\\n \\"appQuery\\": \\"no data\\",\\n \\"start\\": 1589986800,\\n \\"end\\": 1589990340\\n }\\n}","type":"json"}]', + 'translator' => 'manual', + ], + 'ListSortExpressions' => [ + 'path' => '/v4/openapi/app-groups/{appGroupIdentity}/apps/{appId}/sort-expressions', + 'methods' => ['get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'readAndWrite', + 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'update', + 'operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREopensearchN8M8WS', - ], + 'abilityTreeCode' => '55229', + 'abilityTreeNodes' => ['FEATUREopensearchN8M8WS'], ], 'parameters' => [ [ 'name' => 'appGroupIdentity', 'in' => 'path', - 'schema' => [ - 'description' => 'The name of the application or the ID of the application.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'my_app', - ], - ], - [ - 'name' => 'appVersionId', - 'in' => 'path', - 'schema' => [ - 'description' => 'The version number of the application.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '123456', - ], + 'schema' => ['description' => 'The application name.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'title' => '', 'example' => 'my_app_group_name'], ], [ - 'name' => 'scriptName', + 'name' => 'appId', 'in' => 'path', - 'schema' => [ - 'description' => 'The name of the script.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'test_cava', - ], - ], - [ - 'name' => 'body', - 'in' => 'body', - 'style' => 'json', - 'schema' => [ - 'title' => '请求体内容', - 'type' => 'object', - 'properties' => [ - 'description' => [ - 'title' => '脚本备注', - 'type' => 'string', - ], - ], - ], + 'schema' => ['description' => 'The version ID.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true, 'maximum' => '999999999', 'minimum' => '1', 'title' => '', 'example' => '110116134'], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'description' => 'The response body.'."\n", 'type' => 'object', 'properties' => [ - 'requestId' => [ - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => '9F165784-5507-5342-ABF3-545293F9808A', + 'requestId' => ['description' => 'The request ID.', 'type' => 'string', 'title' => '', 'example' => 'D77D0DAF-790D-F5F5-A9C0-133738165014'], + 'result' => [ + 'description' => 'The information about the rough sort or fine sort expressions.'."\n" + ."\n" + .'For more information, see [FirstRank](~~170007~~) and [SecondRank](~~170008~~).', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'created' => ['description' => 'The timestamp when the sort expression was created.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '1655793690'], + 'active' => ['description' => 'Indicates whether the expression is the default one.', 'type' => 'boolean', 'title' => '', 'example' => 'true'], + 'description' => ['description' => 'The description of the sort expression.', 'type' => 'string', 'title' => '', 'example' => '""'], + 'updated' => ['description' => 'The timestamp when the sort expression was updated.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '1655793690'], + 'name' => ['description' => 'The name of the sort expression.', 'type' => 'string', 'title' => '', 'example' => 'default'], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', ], ], - 'example' => '[]', + 'description' => '', + 'title' => '', + 'example' => '', ], ], '5XX' => [ 'schema' => [ 'type' => 'object', 'properties' => [ - 'code' => [ - 'type' => 'string', - ], - 'message' => [ - 'type' => 'string', - ], - 'requestId' => [ - 'type' => 'string', - ], - 'httpCode' => [ - 'type' => 'integer', - 'format' => 'int32', - ], + 'code' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'requestId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'message' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'httpCode' => ['type' => 'integer', 'format' => 'int32', 'description' => '', 'title' => '', 'example' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"9F165784-5507-5342-ABF3-545293F9808A\\"\\n}","type":"json"}]', - 'title' => 'UpdateSortScript', - 'description' => 'You can call this operation to modify the description of a sort script.'."\n", - 'responseParamsDescription' => '**Examples**'."\n" - ."\n" - .'Sample requests'."\n" - ."\n" - .' PUT /v4/openapi/app-groups/my_app/apps/123456/sort-scripts/test_cava'."\n" - .' {'."\n" - .' "description" : "just for test"'."\n" - .' }'."\n" - ."\n" - .'Sample success responses'."\n" - ."\n" - .'XML format'."\n" - ."\n" - .' ABCDEFGH'."\n" - ."\n" - .'JSON format'."\n" + 'title' => 'ListSortExpressions', + 'summary' => 'Lists the sort expressions that are configured for a version of an OpenSearch application.', + 'requestParamsDescription' => '**Query parameters**'."\n" ."\n" - .' {"requestId":"ABCDEFGH"}'."\n", - ], - 'SaveSortScriptFile' => [ - 'summary' => 'Uploads a sort script.', - 'path' => '/v4/openapi/app-groups/{appGroupIdentity}/apps/{appVersionId}/sort-scripts/{scriptName}/files/src/{fileName}', - 'methods' => [ - 'put', + .'| Parameter | Type | Required | Example | Description |'."\n" + .'| ---------- | ------- | -------- | ------- | ---------------------------------------------------------------------- |'."\n" + .'| pageNumber | Integer | No | 1 | The page number. The default value is 1. |'."\n" + .'| pageSize | Integer | No | 10 | The number of entries to return on each page. The default value is 10. |', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'opensearch:ListSortExpression', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'OpenSearch', 'resourceType' => 'FirstRank', 'arn' => 'acs:opensearch:{#regionId}:{#accountId}:apps/{#AppGroupId}'], + ['validationType' => 'always', 'product' => 'OpenSearch', 'resourceType' => 'SecondRank', 'arn' => 'acs:opensearch:{#regionId}:{#accountId}:apps/{#AppGroupId}'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"D77D0DAF-790D-F5F5-A9C0-133738165014\\",\\n \\"result\\": [\\n {\\n \\"created\\": 1655793690,\\n \\"active\\": true,\\n \\"description\\": \\"\\\\\\"\\\\\\"\\",\\n \\"updated\\": 1655793690,\\n \\"name\\": \\"default\\"\\n }\\n ]\\n}","type":"json"}]', + 'translator' => 'manual', + ], + 'ListSortScripts' => [ + 'summary' => 'Lists all sort scripts for a specified application version.', + 'path' => '/v4/openapi/app-groups/{appGroupIdentity}/apps/{appVersionId}/sort-scripts', + 'methods' => ['get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'write', + 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'update', + 'operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREopensearchN8M8WS', - ], + 'abilityTreeNodes' => ['FEATUREopensearchN8M8WS'], ], 'parameters' => [ [ 'name' => 'appGroupIdentity', 'in' => 'path', - 'schema' => [ - 'description' => 'The name or ID of the application.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '\'\'1111\'\'', - ], - ], - [ - 'name' => 'scriptName', - 'in' => 'path', - 'schema' => [ - 'description' => 'The name of the script whose content you want to update.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '\'\'11111\'\'', - ], + 'schema' => ['description' => 'The name or ID of the application.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'title' => '', 'example' => 'my_app'], ], [ 'name' => 'appVersionId', 'in' => 'path', - 'schema' => [ - 'description' => 'The version number of the application.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '\'\'111111\'\'', - ], - ], - [ - 'name' => 'fileName', - 'in' => 'path', - 'schema' => [ - 'description' => 'The file name.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '\'\'11111\'\'', - ], - ], - [ - 'name' => 'body', - 'in' => 'body', - 'style' => 'json', - 'schema' => [ - 'description' => 'The information about the script content.'."\n", - 'type' => 'object', - 'properties' => [ - 'content' => [ - 'description' => 'The script content that is encoded in the Base64 format.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '4769#0: *28194492991 a client request body is buffered to a temporary file /usr/local/webserver/openresty/nginx/client_body_temp/0000624474,', - ], - 'version' => [ - 'description' => 'The version number of the script content.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '2022-12-01', - ], - ], - 'required' => false, - ], + 'schema' => ['description' => 'The ID of the application version.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'title' => '', 'example' => '110142366'], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ - 'requestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => 'ABCDEFGH', + 'requestId' => ['description' => 'The unique ID of the request.', 'type' => 'string', 'title' => '', 'example' => 'ABCDEFGH'], + 'result' => [ + 'description' => 'The list of scripts.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'type' => ['description' => 'The type of the script.', 'type' => 'string', 'title' => '', 'example' => 'cava_script'], + 'scope' => ['description' => 'The applicable scope of the script.', 'type' => 'string', 'title' => '', 'example' => 'second_rank'], + 'createTime' => ['description' => 'The time when the script was created.', 'type' => 'string', 'title' => '', 'example' => '2020-04-02 20:21:14'], + 'status' => ['description' => 'The status of the script:'."\n" + ."\n" + .'- configurable: The script is created, but no file has been uploaded.'."\n" + ."\n" + .'- not compiled: The script has not been compiled.'."\n" + ."\n" + .'- compile failed: The script failed to be compiled.'."\n" + ."\n" + .'- compile successful: The script is compiled.'."\n" + ."\n" + .'- released: The script is published.', 'type' => 'string', 'title' => '', 'example' => 'released'], + 'modifyTime' => ['description' => 'The time when the script was last modified.', 'type' => 'string', 'title' => '', 'example' => '2020-04-02 21:21:14'], + 'scriptName' => ['description' => 'The name of the script.', 'type' => 'string', 'title' => '', 'example' => 'test'], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', ], ], - 'example' => '{}', + 'description' => '', + 'title' => '', + 'example' => '', ], ], '5XX' => [ 'schema' => [ 'type' => 'object', 'properties' => [ - 'code' => [ - 'type' => 'string', - ], - 'message' => [ - 'type' => 'string', - ], - 'requestId' => [ - 'type' => 'string', - ], - 'httpCode' => [ - 'type' => 'integer', - 'format' => 'int32', - ], + 'code' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'message' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'requestId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'httpCode' => ['type' => 'integer', 'format' => 'int32', 'description' => '', 'title' => '', 'example' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"requestId\\": \\"ABCDEFGH\\"\\n}","errorExample":""},{"type":"xml","example":"ABCDEFGH","errorExample":""}]', - 'title' => 'SaveSortScriptFile', - 'requestParamsDescription' => '## scriptContent'."\n" - ."\n" - .'|Parameter|Type|Required|Description|'."\n" - .'|---|---|---|---|'."\n" - .'|content|String|Yes|The script content that is encoded in the Base64 format.|'."\n" - .'|version|Integer|No|The version number of the script content. This version number is used to ensure that the script content is updated in order when the script content is concurrently updated by multiple users. Default value: the current time.|', + 'title' => 'ListSortScripts', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => '```'."\n" + .'Error response'."\n" + .'{'."\n" + .' "requestId" : "ABCDEFGH",'."\n" + .' "code":"InvalidAppSpec",'."\n" + .' "message":"The cava scripts only support the private spec app.",'."\n" + .' "httpCode":400'."\n" + .'}'."\n" + .'```', 'extraInfo' => ' ', - ], - 'ReleaseSortScript' => [ - 'summary' => '发布排序脚本', - 'path' => '/v4/openapi/app-groups/{appGroupIdentity}/apps/{appVersionId}/sort-scripts/{scriptName}/actions/release', - 'methods' => [ - 'post', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'opensearch:DescribeSortScript', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'OpenSearch', 'resourceType' => 'App', 'arn' => 'acs:opensearch:{#regionId}:{#accountId}:apps/{#AppGroupId}'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"ABCDEFGH\\",\\n \\"result\\": [\\n {\\n \\"type\\": \\"cava_script\\",\\n \\"scope\\": \\"second_rank\\",\\n \\"createTime\\": \\"2020-04-02 20:21:14\\",\\n \\"status\\": \\"released\\",\\n \\"modifyTime\\": \\"2020-04-02 21:21:14\\",\\n \\"scriptName\\": \\"test\\"\\n }\\n ]\\n}","type":"json"}]', + 'translator' => 'manual', + ], + 'ListStatisticLogs' => [ + 'summary' => 'Queries log statistics, such as application error logs, hotword rankings, and slow query logs.', + 'path' => '/v4/openapi/app-groups/{appGroupIdentity}/statistic-logs/{moduleName}', + 'methods' => ['get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'write', + 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'update', + 'operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREopensearchN8M8WS', + 'abilityTreeNodes' => ['FEATUREopensearch447AAX', 'FEATUREopensearch5OZOSP'], + ], + 'parameters' => [ + [ + 'name' => 'appGroupIdentity', + 'in' => 'path', + 'schema' => ['description' => 'The application name.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'app_group_name', 'title' => ''], + ], + [ + 'name' => 'moduleName', + 'in' => 'path', + 'schema' => ['description' => 'The module name. This is an enumeration.'."\n" + ."\n" + .'- hot: hotword rankings'."\n" + ."\n" + .'- error: application error logs'."\n" + ."\n" + .'- slow-log: slow query logs'."\n" + ."\n" + .'Currently, only hot is supported.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'hot', 'title' => ''], + ], + [ + 'name' => 'startTime', + 'in' => 'query', + 'schema' => ['description' => 'The start of the time range to query. The value must be a UNIX timestamp. The default value is the UNIX timestamp for 00:00:00 on the current day.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '9999999999', 'minimum' => '0', 'example' => '1582214400', 'title' => ''], + ], + [ + 'name' => 'stopTime', + 'in' => 'query', + 'schema' => ['description' => 'The end of the time range to query. The value must be a UNIX timestamp. The default value is the UNIX timestamp for 24:00:00 on the current day.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '9999999999', 'minimum' => '0', 'example' => '1682222400', 'title' => ''], + ], + [ + 'name' => 'pageNumber', + 'in' => 'query', + 'schema' => ['description' => 'The page number. The default value is 1.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '1000', 'minimum' => '1', 'example' => '1', 'title' => ''], + ], + [ + 'name' => 'pageSize', + 'in' => 'query', + 'schema' => ['description' => 'The number of entries to return on each page. The default value is 10.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '10000', 'minimum' => '1', 'example' => '10', 'title' => ''], ], - ], - 'parameters' => [ [ - 'name' => 'appGroupIdentity', - 'in' => 'path', - 'schema' => [ - 'description' => '\'\'1234\'\''."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '\'\'1234\'\'', - ], + 'name' => 'query', + 'in' => 'query', + 'schema' => ['description' => 'The content of the query clause.', 'type' => 'string', 'required' => false, 'example' => '"default:\'OpenSearch\'"', 'title' => ''], ], [ - 'name' => 'scriptName', - 'in' => 'path', - 'schema' => [ - 'description' => '\'\'test\'\''."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '\'\'test\'\'', - ], + 'name' => 'sortBy', + 'in' => 'query', + 'schema' => ['description' => 'The content of the sort clause.', 'type' => 'string', 'required' => false, 'example' => '"-id"', 'title' => ''], ], [ - 'name' => 'appVersionId', - 'in' => 'path', - 'schema' => [ - 'description' => '\'\'12345\'\''."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '\'\'12345\'\'', - ], + 'name' => 'distinct', + 'in' => 'query', + 'schema' => ['description' => 'Specifies whether to use the distinct clause.', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'title' => ''], + ], + [ + 'name' => 'columns', + 'in' => 'query', + 'schema' => ['description' => 'The fields to query. Format: columns=wordsTopPv.'."\n" + ."\n" + .'For more information, see [Metrics for query analysis](~~187665~~).', 'type' => 'string', 'required' => false, 'example' => 'wordsTopPv', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ + 'description' => 'The response body.', 'type' => 'object', 'properties' => [ - 'requestId' => [ - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => 'ABCDEFGH', - ], + 'totalCount' => ['description' => 'The total number of entries returned.', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => ''], + 'requestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'F76ACE3D-E510-EE2C-B7B1-39B3136A61EE', 'title' => ''], 'result' => [ - 'type' => 'object', - 'properties' => [ - 'version' => [ - 'type' => 'integer', - 'format' => 'int64', - ], - ], + 'description' => 'The returned data. For more information, see:'."\n" + ."\n" + .'- [Hotword rankings](~~421248~~)', + 'type' => 'array', + 'items' => ['description' => 'The returned data. For more information, see:'."\n" + ."\n" + .'- [Hotword rankings](~~187660~~)', 'type' => 'object', 'example' => '[ { "rawQuery":"淘宝", "pv":100 } ]', 'title' => ''], + 'example' => '[]', + 'title' => '', ], ], + 'example' => '{}', + 'title' => '', ], ], '5XX' => [ 'schema' => [ 'type' => 'object', 'properties' => [ - 'code' => [ - 'type' => 'string', - ], - 'message' => [ - 'type' => 'string', - ], - 'requestId' => [ - 'type' => 'string', - ], - 'httpCode' => [ - 'type' => 'integer', - 'format' => 'int32', - ], + 'code' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'message' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'requestId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'httpCode' => ['type' => 'integer', 'format' => 'int32', 'description' => '', 'title' => '', 'example' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"requestId\\": \\"ABCDEFGH\\"\\n}","errorExample":""},{"type":"xml","example":"ABCDEFGH","errorExample":""}]', - 'title' => 'ReleaseSortScript', + 'title' => 'ListStatisticLogs', 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', - ], - 'GetSortScriptFile' => [ - 'summary' => 'Queries the content of a sort script.', - 'path' => '/v4/openapi/app-groups/{appGroupIdentity}/apps/{appVersionId}/sort-scripts/{scriptName}/files/src/{fileName}', - 'methods' => [ - 'get', + 'responseParamsDescription' => '**hot: Hotword rankings**'."\n" + ."\n" + .'| Parameter | Type | Description |'."\n" + .'| --------- | ------- | ------------------------------- |'."\n" + .'| rawQuery | String | The hotword. |'."\n" + .'| pv | Integer | The number of page views (PVs). |', + 'extraInfo' => ' ', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'opensearch:ListStatisticLogs', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'OpenSearch', 'resourceType' => 'AppGroup', 'arn' => 'acs:opensearch:{#regionId}:{#accountId}:app-groups/{#AppGroupId}'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"totalCount\\": 1,\\n \\"requestId\\": \\"F76ACE3D-E510-EE2C-B7B1-39B3136A61EE\\",\\n \\"result\\": [\\n [\\n {\\n \\"rawQuery\\": \\"淘宝\\",\\n \\"pv\\": 100\\n }\\n ]\\n ]\\n}","type":"json"}]', + 'translator' => 'manual', + ], + 'ListStatisticReport' => [ + 'summary' => 'Queries statistical reports, such as application, drop-down suggestion, top search hint, A/B test, and data quality reports.', + 'path' => '/v4/openapi/app-groups/{appGroupIdentity}/statistic-report/{moduleName}', + 'methods' => ['get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -15354,291 +13169,265 @@ 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'get', + 'operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREopensearchN8M8WS', - ], + 'abilityTreeNodes' => ['FEATUREopensearchA9FOU5', 'FEATUREopensearchAKNSFD'], ], 'parameters' => [ [ 'name' => 'appGroupIdentity', 'in' => 'path', - 'schema' => [ - 'description' => 'The name or ID of the application.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'my_app', - ], + 'schema' => ['description' => 'The name of the application.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'title' => '', 'example' => 'app_group_name'], ], [ - 'name' => 'scriptName', + 'name' => 'moduleName', 'in' => 'path', - 'schema' => [ - 'description' => 'The name of the script.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'UserScorer.cava', - ], + 'schema' => ['description' => 'The name of the module. This is an enumeration. Valid values:'."\n" + ."\n" + .'- app: Operations report.'."\n" + ."\n" + .'- app-query: Operations report > Query analysis metrics.'."\n" + ."\n" + .'- abtest: A/B test report.'."\n" + ."\n" + .'- suggest: Drop-down suggestion report.'."\n" + ."\n" + .'- hot: Top search report.'."\n" + ."\n" + .'- hint: Hint report.'."\n" + ."\n" + .'- data-quality: Behavioral data. Paging parameters are not supported.'."\n" + ."\n" + .'- es: Report for an open source-compatible instance.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'title' => '', 'example' => 'suggest'], ], [ - 'name' => 'appVersionId', - 'in' => 'path', - 'schema' => [ - 'description' => 'The version ID of the application.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '123456', - ], + 'name' => 'startTime', + 'in' => 'query', + 'schema' => ['description' => 'The start timestamp, in seconds.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '9999999999', 'minimum' => '0', 'title' => '', 'example' => '1582214400'], ], [ - 'name' => 'fileName', - 'in' => 'path', - 'schema' => [ - 'description' => 'The name of the script file.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'script1', - ], + 'name' => 'endTime', + 'in' => 'query', + 'schema' => ['description' => 'The end timestamp, in seconds. The default value is the current timestamp.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '9999999999', 'minimum' => '0', 'title' => '', 'example' => '1582646399'], + ], + [ + 'name' => 'pageNumber', + 'in' => 'query', + 'schema' => ['description' => 'The page number.'."\n" + ."\n" + .'Default value: 1.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '100', 'minimum' => '1', 'title' => '', 'example' => '1'], + ], + [ + 'name' => 'pageSize', + 'in' => 'query', + 'schema' => ['description' => 'The number of entries to return on each page. Default value: 10.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '10000', 'minimum' => '1', 'title' => '', 'example' => '10'], + ], + [ + 'name' => 'columns', + 'in' => 'query', + 'schema' => ['description' => 'The fields to query. Specify the fields in the columns="pv,uv,ipv" format. For more information, see [Metrics of statistical reports](~~187665~~).', 'type' => 'string', 'required' => false, 'title' => '', 'example' => 'pv,uv'], + ], + [ + 'name' => 'query', + 'in' => 'query', + 'schema' => ['description' => 'The query conditions, in the k1:v1,k2:v2 format. Valid values:'."\n" + ."\n" + .'- experimentSerialNumber: the globally unique serial number of the experiment.'."\n" + ."\n" + .'- sceneTag: the tag of the scenario.'."\n" + ."\n" + .'- bizType: the business identity.'."\n" + ."\n" + .'- modelId: the ID of the algorithm model.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => 'bizType:test,sceneTag:myTag'], ], ], 'responses' => [ 200 => [ 'schema' => [ + 'description' => 'The response body.', 'type' => 'object', 'properties' => [ - 'requestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => 'ABCDEFGH', - ], + 'totalCount' => ['description' => 'The total number of entries.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '43'], + 'requestId' => ['description' => 'The request ID.', 'type' => 'string', 'title' => '', 'example' => 'F65C8BB2-C14F-5983-888B-41C4E082D3BC'], 'result' => [ - 'description' => 'The content of the sort script.'."\n", - 'type' => 'object', - 'properties' => [ - 'content' => [ - 'description' => 'The script content that is encoded in the Base64 format.'."\n", - 'type' => 'string', - 'example' => 'YWJjZGVmZw==', - ], - 'createTime' => [ - 'description' => 'The time when the script was created.'."\n", - 'type' => 'string', - 'example' => '2020-04-02 20:21:14', - ], - 'modifyTime' => [ - 'description' => 'The time when the script was last modified.'."\n", - 'type' => 'string', - 'example' => '2020-04-02 21:21:14', - ], - 'version' => [ - 'description' => 'The version of the script content.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '123456', - ], - ], + 'description' => 'The statistical reports.'."\n" + ."\n" + .'- For \\`data-quality\\` reports, see the "Upload behavioral data" section in [Data collection 2.0](~~131547~~).'."\n" + ."\n" + .'- For \\`app\\` and \\`abtest\\` reports, see the "Core metrics" section in [Metrics of statistical reports](~~187665~~).'."\n" + ."\n" + .'- For \\`app-query\\` reports, see the "Query analysis metrics" section in [Metrics of statistical reports](~~187665~~).', + 'type' => 'array', + 'items' => ['description' => 'The result body.', 'type' => 'object', 'title' => '', 'example' => '{}'], + 'example' => '[]', + 'title' => '', ], ], - 'description' => '', + 'example' => '[]', + 'title' => '', ], ], '5XX' => [ 'schema' => [ 'type' => 'object', 'properties' => [ - 'code' => [ - 'type' => 'string', - ], - 'message' => [ - 'type' => 'string', - ], - 'requestId' => [ - 'type' => 'string', - ], - 'httpCode' => [ - 'type' => 'integer', - 'format' => 'int32', - ], + 'code' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'message' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'requestId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'httpCode' => ['type' => 'integer', 'format' => 'int32', 'description' => '', 'title' => '', 'example' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"requestId\\": \\"ABCDEFGH\\",\\n \\"result\\": {\\n \\"content\\": \\"YWJjZGVmZw==\\",\\n \\"createTime\\": \\"2020-04-02 20:21:14\\",\\n \\"modifyTime\\": \\"2020-04-02 21:21:14\\",\\n \\"version\\": 123456\\n }\\n}","errorExample":""},{"type":"xml","example":"ABCDEFGH\\n\\n YWJjZGVmZw==\\n 123456\\n","errorExample":""}]', - 'title' => 'GetSortScriptFile', - 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' Error response{'."\n" - .' "requestId" : "ABCDEFGH",'."\n" - .' "code":"ResourceNotFound",'."\n" - .' "message":"The specified script not found.",'."\n" - .' "httpCode":404'."\n" - .' }'."\n", - 'extraInfo' => ' ', - ], - 'GetSortScript' => [ - 'summary' => 'Queries the details of a sort script.', - 'path' => '/v4/openapi/app-groups/{appGroupIdentity}/apps/{appVersionId}/sort-scripts/{scriptName}', - 'methods' => [ - 'get', + 'title' => 'ListStatisticReport', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'opensearch:ListStatisticReport', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'OpenSearch', 'resourceType' => 'AppGroup', 'arn' => 'acs:opensearch:{#regionId}:{#accountId}:app-groups/{#AppGroupId}'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"totalCount\\": 43,\\n \\"requestId\\": \\"F65C8BB2-C14F-5983-888B-41C4E082D3BC\\",\\n \\"result\\": [\\n {}\\n ]\\n}","type":"json"}]', + 'translator' => 'manual', + ], + 'ListTagResources' => [ + 'summary' => 'Queries the tags of specified resources.', + 'path' => '/v4/openapi/resource-tags', + 'methods' => ['get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], + 'produces' => ['application/json'], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', - 'riskType' => 'none', - 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREopensearchN8M8WS', - ], + 'abilityTreeCode' => '152935', + 'abilityTreeNodes' => ['FEATUREopensearchGVH0IN', 'FEATUREopensearch447AAX', 'FEATUREopensearch5OZOSP'], ], 'parameters' => [ [ - 'name' => 'appGroupIdentity', - 'in' => 'path', - 'schema' => [ - 'description' => 'The name or ID of the application.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'enumValueTitles' => [], - 'example' => 'my_app', - ], + 'name' => 'resourceType', + 'in' => 'query', + 'schema' => ['title' => '', 'description' => 'The resource type.', 'type' => 'string', 'required' => true, 'example' => 'BIGDATA'], ], [ - 'name' => 'scriptName', - 'in' => 'path', + 'name' => 'resourceId', + 'in' => 'query', + 'style' => 'json', 'schema' => [ - 'description' => 'The name of the script.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'enumValueTitles' => [], - 'example' => 'script1', + 'title' => '', + 'description' => 'The resource IDs. You can specify a maximum of 50 resource IDs.', + 'type' => 'array', + 'items' => ['description' => 'A list of resource IDs to query. You must specify this parameter or the \\`tag\\` parameter.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => 'i-bp185wwblwfvh1a1y1me'], + 'required' => false, + 'example' => '', ], ], [ - 'name' => 'appVersionId', - 'in' => 'path', - 'schema' => [ - 'description' => 'The version ID of the application.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'enumValueTitles' => [], - 'example' => '160051478', - ], - ], - ], - 'responses' => [ - 200 => [ + 'name' => 'tag', + 'in' => 'query', + 'style' => 'json', 'schema' => [ - 'type' => 'object', - 'properties' => [ - 'requestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'enumValueTitles' => [], - 'example' => 'ABCDEFGH', - ], - 'result' => [ - 'description' => 'The details of the script.'."\n", - 'type' => 'object', - 'properties' => [ - 'scope' => [ - 'description' => 'The sort phase to which the script applies.'."\n", - 'type' => 'string', - 'example' => 'second_rank', - ], - 'createTime' => [ - 'description' => 'The time when the script was created.'."\n", - 'type' => 'string', - 'example' => '2020-04-02 20:21:14', - ], - 'status' => [ - 'description' => 'The status of the script. For more information, see the description of the status response parameter in the ListSortScripts topic.'."\n", - 'type' => 'string', - 'example' => 'released', - ], - 'modifyTime' => [ - 'description' => 'The time when the script was last modified.'."\n", - 'type' => 'string', - 'example' => '2020-04-02 21:21:14', - ], - 'type' => [ - 'description' => 'The type of the script.', - 'type' => 'string', - 'enumValueTitles' => [], - 'example' => 'cava_script', - ], - 'scriptName' => [ - 'description' => 'The name of the script.'."\n", - 'type' => 'string', - 'example' => 'rank_cava_20230606_v7'."\n", - ], - 'description' => [ - 'title' => '脚本备注', - 'type' => 'string', - ], - ], + 'title' => '', + 'description' => 'The tags to query. The list can contain a maximum of 20 tags.', + 'type' => 'array', + 'items' => [ + 'description' => 'The internal English representation of the entity type.', + 'type' => 'object', + 'properties' => [ + 'key' => ['title' => '', 'description' => 'The tag key.', 'type' => 'string', 'required' => false, 'example' => 'bm'], + 'value' => ['title' => '', 'description' => 'The tag value.', 'type' => 'string', 'required' => false, 'example' => 'Uefi'], ], + 'required' => false, + 'title' => '', + 'example' => '', ], - 'enumValueTitles' => [], - 'description' => '', + 'required' => false, + 'example' => '', ], ], - '5XX' => [ + [ + 'name' => 'nextToken', + 'in' => 'query', + 'schema' => ['title' => '', 'description' => 'The token to start the next query.', 'type' => 'string', 'required' => false, 'example' => '60'], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ - 'code' => [ - 'type' => 'string', - ], - 'message' => [ - 'type' => 'string', - ], - 'requestId' => [ - 'type' => 'string', - ], - 'httpCode' => [ - 'type' => 'integer', - 'format' => 'int32', + 'requestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => 'D77D0DAF-790D-F5F5-A9C0-133738165014'], + 'nextToken' => ['title' => '', 'description' => 'The token to start the next query.', 'type' => 'string', 'example' => '20'], + 'result' => [ + 'title' => '', + 'description' => 'The list of resources.', + 'type' => 'array', + 'items' => [ + 'description' => 'The returned result.', + 'type' => 'object', + 'properties' => [ + 'tagKey' => ['title' => '', 'description' => 'The tag key.', 'type' => 'string', 'example' => 'GENIE_FUNCTION'], + 'tagValue' => ['title' => '', 'description' => 'The tag value.', 'type' => 'string', 'example' => 'ALLOW'], + 'resourceId' => ['title' => '', 'description' => 'The resource ID.', 'type' => 'string', 'example' => '54041'], + 'resourceType' => ['title' => '', 'description' => 'The resource type.', 'type' => 'string', 'example' => 'hostGroup'], + ], + 'title' => '', + 'example' => '', + ], + 'example' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"ABCDEFGH\\",\\n \\"result\\": {\\n \\"scope\\": \\"second_rank\\",\\n \\"createTime\\": \\"2020-04-02 20:21:14\\",\\n \\"status\\": \\"released\\",\\n \\"modifyTime\\": \\"2020-04-02 21:21:14\\",\\n \\"type\\": \\"cava_script\\",\\n \\"scriptName\\": \\"rank_cava_20230606_v7\\\\n\\",\\n \\"description\\": \\"\\"\\n }\\n}","type":"json"}]', - 'title' => 'GetSortScript', - 'responseParamsDescription' => ' Error response{'."\n" - .' "requestId" : "ABCDEFGH",'."\n" - .' "code":"ResourceNotFound",'."\n" - .' "message":"The specified script not found.",'."\n" - .' "httpCode":404'."\n" - .' }'."\n", - ], - 'GetScriptFileNames' => [ - 'path' => '/v4/openapi/app-groups/{appGroupIdentity}/apps/{appVersionId}/sort-scripts/{scriptName}/file-names', - 'methods' => [ - 'get', + 'title' => 'ListTagResources', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'opensearch:ListTagResources', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'OpenSearch', 'resourceType' => 'AppGroup', 'arn' => 'acs:opensearch:{#regionId}:{#accountId}:instance/{#AppGroupId}'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"D77D0DAF-790D-F5F5-A9C0-133738165014\\",\\n \\"nextToken\\": \\"20\\",\\n \\"result\\": [\\n {\\n \\"tagKey\\": \\"GENIE_FUNCTION\\",\\n \\"tagValue\\": \\"ALLOW\\",\\n \\"resourceId\\": \\"54041\\",\\n \\"resourceType\\": \\"hostGroup\\"\\n }\\n ]\\n}","type":"json"}]', + 'translator' => 'manual', + ], + 'ListUserAnalyzerEntries' => [ + 'summary' => 'Queries the entries of a custom analyzer.', + 'path' => '/v4/openapi/user-analyzers/{name}/entries', + 'methods' => ['get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -15646,40 +13435,32 @@ ], 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [], + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATUREopensearchUIICM8'], + ], 'parameters' => [ [ - 'name' => 'appGroupIdentity', + 'name' => 'name', 'in' => 'path', - 'schema' => [ - 'description' => 'my_app'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'my_app', - ], + 'schema' => ['description' => 'The name of the analyzer.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'title' => '', 'example' => '"kevin_test"'], ], [ - 'name' => 'appVersionId', - 'in' => 'path', - 'schema' => [ - 'description' => '123456'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '123456', - ], + 'name' => 'word', + 'in' => 'query', + 'schema' => ['description' => 'The entry key.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => '"kevintest"'], ], [ - 'name' => 'scriptName', - 'in' => 'path', - 'schema' => [ - 'description' => 'file_names'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'file_names', - ], + 'name' => 'pageNumber', + 'in' => 'query', + 'schema' => ['description' => 'The page number. The default value is 1.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '999999999', 'minimum' => '-1', 'title' => '', 'example' => '1'], + ], + [ + 'name' => 'pageSize', + 'in' => 'query', + 'schema' => ['description' => 'The number of entries to return on each page. The default value is 10.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '999999999', 'minimum' => '-1', 'title' => '', 'example' => '10'], ], ], 'responses' => [ @@ -15687,138 +13468,88 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'requestId' => [ - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => 'ABCDEFGH', - ], - 'result' => [ - 'description' => 'The files of the script.'."\n", - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'createTime' => [ - 'description' => 'The time when the script file was created.'."\n", - 'type' => 'string', - 'example' => '2020-04-02 20:21:14', - ], - 'fileName' => [ - 'description' => 'The name of the script file.'."\n", - 'type' => 'string', - 'example' => 'my_cava_script.cava', - ], - 'modifyTime' => [ - 'description' => 'The time when the script file was last modified.'."\n", - 'type' => 'string', - 'example' => '2020-04-02 21:21:14', - ], - 'pathName' => [ - 'description' => 'The path name of the script file.', - 'type' => 'string', - 'example' => 'src', - ], - ], - ], - ], + 'result' => ['description' => 'The entries of the custom analyzer. For more information, see UserAnalyzerEntry.', 'type' => 'object', 'title' => '', 'example' => '['."\n" + .'{'."\n" + .' "cmd": "add",'."\n" + .' "key": "kevintest",'."\n" + .' "value": "kevin test",'."\n" + .' "created": 1536690285,'."\n" + .' "updated": 1537348987,'."\n" + .' "status": "ACTIVE",'."\n" + .' "splitEnabled": true'."\n" + .'}'."\n" + .']'], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'title' => '', 'example' => '516A02B7-2167-8D92-12D0-B639A2A0F3C5'], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], '5XX' => [ 'schema' => [ 'type' => 'object', 'properties' => [ - 'code' => [ - 'type' => 'string', - ], - 'message' => [ - 'type' => 'string', - ], - 'requestId' => [ - 'type' => 'string', - ], - 'httpCode' => [ - 'type' => 'integer', - 'format' => 'int32', - ], + 'code' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'message' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'requestId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'httpCode' => ['type' => 'integer', 'format' => 'int32', 'description' => '', 'title' => '', 'example' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"requestId\\": \\"ABCDEFGH\\",\\n \\"result\\": [\\n {\\n \\"createTime\\": \\"2020-04-02 20:21:14\\",\\n \\"fileName\\": \\"my_cava_script.cava\\",\\n \\"modifyTime\\": \\"2020-04-02 21:21:14\\",\\n \\"pathName\\": \\"src\\"\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"ABCDEFGH\\n\\n my_cava_script.cava\\n src\\n 2020-04-02 20:21:14\\n 2020-04-02 21:21:14\\n","errorExample":""}]', - 'title' => 'GetScriptFileNames', - 'requestParamsDescription' => ' ', - 'extraInfo' => ' ', - ], - 'DeleteSortScriptFile' => [ - 'summary' => 'Deletes a script file.', - 'path' => '/v4/openapi/app-groups/{appGroupIdentity}/apps/{appVersionId}/sort-scripts/{scriptName}/files/src/{fileName}', - 'methods' => [ - 'delete', + 'title' => 'ListUserAnalyzerEntries', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'opensearch:DescribeUserAnalyzer', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'OpenSearch', 'resourceType' => 'Analyzer', 'arn' => 'acs:opensearch:{#regionId}:{#accountId}:user-analyzers/{#AnalyzerId}'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"result\\": [\\n {\\n \\"cmd\\": \\"add\\",\\n \\"key\\": \\"kevintest\\",\\n \\"value\\": \\"kevin test\\",\\n \\"created\\": 1536690285,\\n \\"updated\\": 1537348987,\\n \\"status\\": \\"ACTIVE\\",\\n \\"splitEnabled\\": true\\n }\\n ],\\n \\"RequestId\\": \\"516A02B7-2167-8D92-12D0-B639A2A0F3C5\\"\\n}","type":"json"}]', + 'translator' => 'manual', + ], + 'ListUserAnalyzers' => [ + 'summary' => 'Retrieves a list of custom analyzers for your account.', + 'path' => '/v4/openapi/user-analyzers', + 'methods' => ['get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'write', + 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'update', + 'operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREopensearchN8M8WS', - ], + 'abilityTreeNodes' => ['FEATUREopensearchUIICM8', 'FEATUREopensearchNCXKUT'], ], 'parameters' => [ [ - 'name' => 'appGroupIdentity', - 'in' => 'path', - 'schema' => [ - 'description' => 'The name of the application'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'search', - ], - ], - [ - 'name' => 'appVersionId', - 'in' => 'path', - 'schema' => [ - 'description' => 'The version ID.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '1234567', - ], - ], - [ - 'name' => 'scriptName', - 'in' => 'path', - 'schema' => [ - 'description' => 'The name of the script.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'cava', - ], + 'name' => 'pageNumber', + 'in' => 'query', + 'schema' => ['description' => 'The page number. The default value is 1.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '999999999', 'minimum' => '-1', 'title' => '', 'example' => '1'], ], [ - 'name' => 'fileName', - 'in' => 'path', - 'schema' => [ - 'description' => 'The name of the script file to delete.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'cavafile', - ], + 'name' => 'pageSize', + 'in' => 'query', + 'schema' => ['description' => 'The number of entries to return on each page. The default value is 10.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '999999999', 'minimum' => '-1', 'title' => '', 'example' => '10'], ], ], 'responses' => [ @@ -15826,53 +13557,129 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'requestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => 'ABCDEFGH', + 'totalCount' => ['description' => 'The total number of entries.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '1'], + 'requestId' => ['description' => 'The ID of the request.', 'type' => 'string', 'title' => '', 'example' => '0A6EB64B-B4C8-CF02-810F-E660812972FF'], + 'result' => [ + 'description' => 'The list of custom analyzers.'."\n" + ."\n" + .'For more information, see [UserAnalyzer](~~178934~~).', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'created' => ['description' => 'The timestamp when the analyzer was created.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '1588054131'], + 'available' => ['description' => 'Indicates whether the analyzer is available.', 'type' => 'boolean', 'title' => '', 'example' => 'false'], + 'name' => ['description' => 'The name of the custom analyzer.', 'type' => 'string', 'title' => '', 'example' => 'kevin_test2'], + 'updated' => ['description' => 'The timestamp when the analyzer was last updated.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '1588054131'], + 'id' => ['description' => 'The ID of the custom analyzer.', 'type' => 'string', 'title' => '', 'example' => '1234'], + 'business' => ['description' => 'The basic analyzer. Valid values:'."\n" + ."\n" + .'- chn\\_standard: [A general-purpose analyzer for Chinese](~~179424~~).'."\n" + ."\n" + .'- chn\\_scene\\_name: An analyzer for Chinese person names.'."\n" + ."\n" + .'- chn\\_ecommerce: [An analyzer for e-commerce in Chinese](~~179424~~).'."\n" + ."\n" + .'- chn\\_it\\_content: [An analyzer for IT content in Chinese](~~179424~~).'."\n" + ."\n" + .'- en\\_min: A fine-grained analyzer for English.'."\n" + ."\n" + .'- th\\_standard: A general-purpose analyzer for Thai.'."\n" + ."\n" + .'- th\\_ecommerce: An analyzer for e-commerce in Thai.'."\n" + ."\n" + .'- vn\\_standard: A general-purpose analyzer for Vietnamese.'."\n" + ."\n" + .'- chn\\_community\\_it: An analyzer for IT community content in Chinese.'."\n" + ."\n" + .'- chn\\_ecommerce\\_general: A general-purpose analyzer for the e-commerce industry in Chinese.'."\n" + ."\n" + .'- chn\\_esports\\_general: A general-purpose analyzer for the gaming industry in Chinese.'."\n" + ."\n" + .'- chn\\_edu\\_question: An analyzer for question-answering search in the education industry in Chinese.', 'type' => 'string', 'title' => '', 'example' => 'chn_standard'], + 'dicts' => [ + 'description' => 'The dictionaries that the custom analyzer uses.'."\n" + ."\n" + .'For more information, see [UserDict](~~178933~~).', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'created' => ['description' => 'The timestamp when the dictionary was created.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '1588054131'], + 'entriesCount' => ['description' => 'The number of entries.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '-1'], + 'type' => ['description' => 'The type of the dictionary. Valid value:'."\n" + ."\n" + .'- segment: A dictionary for word segmentation.', 'type' => 'string', 'title' => '', 'example' => 'segment'], + 'entriesLimit' => ['description' => 'The maximum number of entries in the dictionary.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '4'], + 'available' => ['description' => 'Indicates whether the dictionary is available.', 'type' => 'boolean', 'title' => '', 'example' => 'false'], + 'updated' => ['description' => 'The timestamp when the dictionary was last updated.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '1588054131'], + 'id' => ['description' => 'The ID of the dictionary.', 'type' => 'string', 'title' => '', 'example' => '123'], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', ], ], 'description' => '', + 'title' => '', + 'example' => '', ], ], '5XX' => [ 'schema' => [ 'type' => 'object', 'properties' => [ - 'code' => [ - 'type' => 'string', - ], - 'message' => [ - 'type' => 'string', - ], - 'requestId' => [ - 'type' => 'string', - ], - 'httpCode' => [ - 'type' => 'integer', - 'format' => 'int32', - ], + 'code' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'message' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'requestId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'httpCode' => ['type' => 'integer', 'format' => 'int32', 'description' => '', 'title' => '', 'example' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"requestId\\": \\"ABCDEFGH\\"\\n}","errorExample":""},{"type":"xml","example":"ABCDEFGH","errorExample":""}]', - 'title' => 'DeleteSortScriptFile', + 'title' => 'ListUserAnalyzers', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', - 'translator' => 'machine', - ], - 'DeleteSortScript' => [ - 'summary' => '删除排序脚本', - 'path' => '/v4/openapi/app-groups/{appGroupIdentity}/apps/{appVersionId}/sort-scripts/{scriptName}', - 'methods' => [ - 'delete', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'opensearch:ListUserAnalyzers', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'OpenSearch', 'resourceType' => 'Analyzer', 'arn' => 'acs:opensearch:{#regionId}:{#accountId}:user-analyzers/*'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"totalCount\\": 1,\\n \\"requestId\\": \\"0A6EB64B-B4C8-CF02-810F-E660812972FF\\",\\n \\"result\\": [\\n {\\n \\"created\\": 1588054131,\\n \\"available\\": false,\\n \\"name\\": \\"kevin_test2\\",\\n \\"updated\\": 1588054131,\\n \\"id\\": \\"1234\\",\\n \\"business\\": \\"chn_standard\\",\\n \\"dicts\\": [\\n {\\n \\"created\\": 1588054131,\\n \\"entriesCount\\": -1,\\n \\"type\\": \\"segment\\",\\n \\"entriesLimit\\": 4,\\n \\"available\\": false,\\n \\"updated\\": 1588054131,\\n \\"id\\": \\"123\\"\\n }\\n ]\\n }\\n ]\\n}","type":"json"}]', + 'translator' => 'manual', + ], + 'ModifyAppGroup' => [ + 'summary' => 'Modifies the properties of an OpenSearch application or sets its online version.', + 'path' => '/v4/openapi/app-groups/{appGroupIdentity}', + 'methods' => ['put'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -15881,95 +13688,213 @@ 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'delete', + 'operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREopensearchN8M8WS', - ], + 'abilityTreeCode' => '55236', + 'abilityTreeNodes' => ['FEATUREopensearchGVH0IN', 'FEATUREopensearch447AAX', 'FEATUREopensearch5OZOSP'], ], 'parameters' => [ [ 'name' => 'appGroupIdentity', 'in' => 'path', - 'schema' => [ - 'description' => 'search'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'search', - ], + 'schema' => ['description' => 'The name of the application.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'my_app_group_name', 'title' => ''], ], [ - 'name' => 'scriptName', - 'in' => 'path', + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', 'schema' => [ - 'description' => 'cava'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'cava', + 'description' => 'The request body.', + 'type' => 'object', + 'properties' => [ + 'description' => ['description' => 'The description of the application group.', 'type' => 'string', 'example' => '" instance description"', 'required' => false, 'title' => ''], + 'currentVersion' => ['description' => 'The online version of the application.', 'type' => 'string', 'required' => false, 'example' => '1223232', 'title' => ''], + 'domain' => ['description' => 'The industry. Valid values:'."\n" + ."\n" + .'- general: general.'."\n" + ."\n" + .'- ecommerce: e-commerce.'."\n" + ."\n" + .'- education: education.'."\n" + ."\n" + .'- esports: gaming.'."\n" + ."\n" + .'- community: content community.', 'type' => 'string', 'required' => false, 'example' => '"ecommerce"', 'title' => ''], + 'resourceGroupId' => ['description' => 'The ID of the resource group to which the instance belongs.', 'type' => 'string', 'required' => false, 'example' => 'rg-****', 'title' => ''], + ], + 'required' => false, + 'title' => '', + 'example' => '', ], ], [ - 'name' => 'appVersionId', - 'in' => 'path', - 'schema' => [ - 'description' => '1234567'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '1234567', - ], + 'name' => 'dryRun', + 'in' => 'query', + 'schema' => ['description' => 'Specifies whether to perform a dry run. Valid values: true and false.', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ + 'description' => 'The response body.', 'type' => 'object', 'properties' => [ - 'requestId' => [ - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => 'ABCDEFGH', + 'requestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'D77D0DAF-790D-F5F5-A9C0-133738165014', 'title' => ''], + 'result' => [ + 'description' => 'The returned data.', + 'type' => 'object', + 'properties' => [ + 'created' => ['description' => 'The UNIX timestamp when the application was created.', 'type' => 'integer', 'format' => 'int32', 'example' => '159013954', 'title' => ''], + 'currentVersion' => ['description' => 'The ID of the current online version.', 'type' => 'string', 'example' => '100302903', 'title' => ''], + 'lockMode' => ['description' => 'The lock mode of the instance. Valid values:'."\n" + ."\n" + .'- Unlock: The instance is not locked.'."\n" + ."\n" + .'- LockByExpiration: The instance is automatically locked after it expires.'."\n" + ."\n" + .'- ManualLock: The instance is manually locked.', 'type' => 'string', 'example' => 'Unlock', 'title' => ''], + 'updated' => ['description' => 'The UNIX timestamp when the application was last modified.', 'type' => 'integer', 'format' => 'int32', 'example' => '1590978265', 'title' => ''], + 'id' => ['description' => 'The application ID.', 'type' => 'string', 'example' => '100302881', 'title' => ''], + 'chargeType' => ['description' => 'The billing method. Valid values:'."\n" + ."\n" + .'- POSTPAY: pay-as-you-go.'."\n" + ."\n" + .'- PREPAY: subscription.', 'type' => 'string', 'example' => 'POSTPAY', 'title' => ''], + 'hasPendingQuotaReviewTask' => ['description' => 'The approval status of the quota. Valid values:'."\n" + ."\n" + .'- 0: normal.'."\n" + ."\n" + .'- 1: being approved.', 'type' => 'integer', 'format' => 'int32', 'example' => '0', 'title' => ''], + 'name' => ['description' => 'The name of the application.', 'type' => 'string', 'example' => 'lsh_test_1', 'title' => ''], + 'instanceId' => ['description' => 'The instance ID.', 'type' => 'string', 'example' => '10030288', 'title' => ''], + 'chargingWay' => ['description' => 'The billable item. Valid values:'."\n" + ."\n" + .'- 1: computing resources.'."\n" + ."\n" + .'- 2: QPS.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'type' => ['description' => 'The type of the application. Valid values:'."\n" + ."\n" + .'- standard: a Standard Edition application.'."\n" + ."\n" + .'- advance: an Advanced Edition application of an old version. New applications do not support this type.'."\n" + ."\n" + .'- enhanced: an Enhanced Edition application.', 'type' => 'string', 'example' => 'enhanced', 'title' => ''], + 'status' => ['description' => 'The status of the application. Valid values:'."\n" + ."\n" + .'- producing: The application is being created.'."\n" + ."\n" + .'- review\\_pending: The application is under review.'."\n" + ."\n" + .'- config\\_pending: The application requires configuration.'."\n" + ."\n" + .'- normal: The application is running.'."\n" + ."\n" + .'- frozen: The application is frozen.', 'type' => 'string', 'example' => 'normal', 'title' => ''], + 'projectId' => ['description' => 'The name of the A/B test project.', 'type' => 'string', 'example' => '1', 'title' => ''], + 'switchedTime' => ['description' => 'The UNIX timestamp when the current online version was published.', 'type' => 'integer', 'format' => 'int32', 'example' => '1590486386', 'title' => ''], + 'commodityCode' => ['description' => 'The commodity code.', 'type' => 'string', 'example' => 'opensearch', 'title' => ''], + 'expireOn' => ['description' => 'The expiration time.', 'type' => 'string', 'example' => '1', 'title' => ''], + 'domain' => ['description' => 'The industry. Valid values:'."\n" + ."\n" + .'- GENERAL: general.'."\n" + ."\n" + .'- ECOMMERCE: e-commerce.'."\n" + ."\n" + .'- IT\\_CONTENT: IT content.', 'type' => 'string', 'example' => 'GENERAL', 'title' => ''], + 'description' => ['description' => 'The description of the application.', 'type' => 'string', 'example' => '1', 'title' => ''], + 'produced' => ['description' => 'Indicates whether the application is created. Valid values:'."\n" + ."\n" + .'- 0: The application is being created.'."\n" + ."\n" + .'- 1: The application is created.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'quota' => [ + 'description' => 'The quota information of the application.', + 'type' => 'object', + 'properties' => [ + 'spec' => ['description' => 'The specifications. Valid values:'."\n" + ."\n" + .'- opensearch.share.junior: Basic'."\n" + ."\n" + .'- opensearch.share.common: Shared General-purpose'."\n" + ."\n" + .'- opensearch.share.compute: Shared Compute-optimized'."\n" + ."\n" + .'- opensearch.share.storage: Shared Storage-optimized'."\n" + ."\n" + .'- opensearch.private.common: Exclusive General-purpose'."\n" + ."\n" + .'- opensearch.private.compute: Exclusive Compute-optimized'."\n" + ."\n" + .'- opensearch.private.storage: Exclusive Storage-optimized', 'type' => 'string', 'example' => 'opensearch.share.common', 'title' => ''], + 'docSize' => ['description' => 'The storage capacity in GB.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'computeResource' => ['description' => 'The computing resources in logical compute units (LCUs).', 'type' => 'integer', 'format' => 'int32', 'example' => '20', 'title' => ''], + ], + 'example' => '{}', + 'title' => '', + ], + 'engineType' => ['description' => 'The engine type.', 'type' => 'string', 'example' => 'ha3', 'title' => ''], + 'resourceGroupId' => ['description' => 'The ID of the resource group to which the instance belongs.', 'type' => 'string', 'example' => 'rg-acfmoiyerh6nzly', 'title' => ''], + ], + 'example' => '{}', + 'title' => '', ], ], + 'example' => '{}', + 'title' => '', ], ], '5XX' => [ 'schema' => [ 'type' => 'object', 'properties' => [ - 'code' => [ - 'type' => 'string', - ], - 'message' => [ - 'type' => 'string', - ], - 'requestId' => [ - 'type' => 'string', - ], - 'httpCode' => [ - 'type' => 'integer', - 'format' => 'int32', - ], + 'code' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'message' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'requestId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'httpCode' => ['type' => 'integer', 'format' => 'int32', 'description' => '', 'title' => '', 'example' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"requestId\\": \\"ABCDEFGH\\"\\n}","errorExample":""},{"type":"xml","example":"ABCDEFGH","errorExample":""}]', - 'title' => 'DeleteSortScript', - ], - 'CreateSortScript' => [ - 'summary' => 'Creates a sort script.', - 'path' => '/v4/openapi/app-groups/{appGroupIdentity}/apps/{appVersionId}/sort-scripts', - 'methods' => [ - 'post', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"D77D0DAF-790D-F5F5-A9C0-133738165014\\",\\n \\"result\\": {\\n \\"created\\": 159013954,\\n \\"currentVersion\\": \\"100302903\\",\\n \\"lockMode\\": \\"Unlock\\",\\n \\"updated\\": 1590978265,\\n \\"id\\": \\"100302881\\",\\n \\"chargeType\\": \\"POSTPAY\\",\\n \\"hasPendingQuotaReviewTask\\": 0,\\n \\"name\\": \\"lsh_test_1\\",\\n \\"instanceId\\": \\"10030288\\",\\n \\"chargingWay\\": 1,\\n \\"type\\": \\"enhanced\\",\\n \\"status\\": \\"normal\\",\\n \\"projectId\\": \\"1\\",\\n \\"switchedTime\\": 1590486386,\\n \\"commodityCode\\": \\"opensearch\\",\\n \\"expireOn\\": \\"1\\",\\n \\"domain\\": \\"GENERAL\\",\\n \\"description\\": \\"1\\",\\n \\"produced\\": 1,\\n \\"quota\\": {\\n \\"spec\\": \\"opensearch.share.common\\",\\n \\"docSize\\": 1,\\n \\"computeResource\\": 20\\n },\\n \\"engineType\\": \\"ha3\\",\\n \\"resourceGroupId\\": \\"rg-acfmoiyerh6nzly\\"\\n }\\n}","type":"json"}]', + 'title' => 'ModifyAppGroup', + 'requestParamsDescription' => '**Request body**'."\n" + ."\n" + .'| Parameter | Type | Required | Example | Description |'."\n" + .'| -------------- | ------- | -------- | ---------------- | ------------------------------------------------------------------------------------- |'."\n" + .'| chargingWay | Integer | No | 1 | The billing model.
- 1: computing resources.
- 2: queries per second (QPS).
|'."\n" + .'| description | String | No | "my\\_first\\_app" | The description of the application. |'."\n" + .'| currentVersion | Integer | No | 12345678 | The ID of the application version. |'."\n" + ."\n" + .'Note: This operation prioritizes setting the online version of the application. If you include the \\`currentVersion\\` parameter in the request, other parameters are ignored.
', + 'responseParamsDescription' => ' ', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'opensearch:ModifyAppGroup', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'OpenSearch', 'resourceType' => 'AppGroup', 'arn' => 'acs:opensearch:{#regionId}:{#accountId}:app-groups/{#AppGroupId}'], + ], + ], + ], ], + 'translator' => 'manual', + ], + 'ModifyAppGroupQuota' => [ + 'summary' => 'Modifies the quota of an OpenSearch application.', + 'path' => '/v4/openapi/app-groups/{appGroupIdentity}/quota', + 'methods' => ['put'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -15978,202 +13903,239 @@ 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'create', + 'operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREopensearchN8M8WS', - ], + 'abilityTreeCode' => '55237', + 'abilityTreeNodes' => ['FEATUREopensearchGVH0IN', 'FEATUREopensearch447AAX', 'FEATUREopensearch5OZOSP'], ], 'parameters' => [ [ 'name' => 'appGroupIdentity', 'in' => 'path', - 'schema' => [ - 'description' => 'The application name or ID.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'search', - ], + 'schema' => ['description' => 'The name of the application.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'my_app_group_name', 'title' => ''], ], [ - 'name' => 'appVersionId', - 'in' => 'path', - 'schema' => [ - 'description' => 'The ID of the report in the application.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '1234567', - ], + 'name' => 'clientToken', + 'in' => 'query', + 'schema' => ['description' => 'A client token that is used to ensure the idempotence of the request. The client generates this value to make sure that it is unique among different requests. The value can be up to 64 ASCII characters in length.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => '74db41d8cd3c784209093aa76afbe89e'], + ], + [ + 'name' => 'dryRun', + 'in' => 'query', + 'schema' => ['description' => 'Specifies whether to perform a dry run. Default value: false.'."\n" + ."\n" + .'Valid values:'."\n" + ."\n" + .'- **true**: Validates the request parameters without creating the attribution configuration.'."\n" + ."\n" + .'- **false**: Validates the request parameters and creates the attribution configuration.', 'type' => 'boolean', 'required' => false, 'example' => 'false', 'title' => ''], ], [ 'name' => 'body', 'in' => 'body', - 'style' => 'json', - 'schema' => [ - 'description' => 'The request body.'."\n", - 'type' => 'object', - 'properties' => [ - 'scriptName' => [ - 'description' => 'The script name.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'rank_cava_20230606_v7', - ], - 'type' => [ - 'description' => 'The script type. Set the value to cava_script.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'cava_script'."\n", - ], - 'scope' => [ - 'description' => 'The sort phase to which the script applies.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'second_rank', - ], - 'description' => [ - 'title' => '脚本备注', - 'type' => 'string', - ], - ], - 'required' => false, - ], + 'schema' => ['description' => 'The request body.', '$ref' => '#/components/schemas/Quota', 'required' => false, 'title' => '', 'example' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ + 'description' => 'The response body.', 'type' => 'object', 'properties' => [ - 'requestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => 'ABCDEFGH', - ], + 'requestId' => ['description' => 'The ID of the request.', 'type' => 'string', 'example' => '0A6EB64B-B4C8-CF02-810F-E660812972FF', 'title' => ''], 'result' => [ - 'description' => 'The response parameters.'."\n", + 'description' => 'The information about the application.', 'type' => 'object', 'properties' => [ - 'scriptName' => [ - 'description' => 'The script name.'."\n", - 'type' => 'string', - 'example' => 'rank_cava_20230606_v7'."\n", - ], - 'type' => [ - 'description' => 'The script type.'."\n", - 'type' => 'string', - 'example' => 'cava_script', + 'created' => ['description' => 'The timestamp when the application was created.', 'type' => 'integer', 'format' => 'int32', 'example' => '1590139542', 'title' => ''], + 'currentVersion' => ['description' => 'The current online version.', 'type' => 'string', 'example' => '100302903', 'title' => ''], + 'type' => ['description' => 'The type of the application.'."\n" + ."\n" + .'- standard: Standard Edition'."\n" + ."\n" + .'- advance: an earlier version of Premium Edition. This type is not supported for new applications.'."\n" + ."\n" + .'- enhanced: a new version of Premium Edition.', 'type' => 'string', 'example' => 'enhanced', 'title' => ''], + 'chargingWay' => ['description' => 'The billing model.'."\n" + ."\n" + .'- 1: by compute resources'."\n" + ."\n" + .'- 2: by queries per second (QPS)', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'lockMode' => ['description' => 'The lock status.'."\n" + ."\n" + .'- Unlock: The application is not locked.'."\n" + ."\n" + .'- LockByExpiration: The application is automatically locked upon expiration.'."\n" + ."\n" + .'- ManualLock: The application is manually locked.', 'type' => 'string', 'example' => 'Unlock', 'title' => ''], + 'status' => ['description' => 'The status of the application.'."\n" + ."\n" + .'- producing: The application is being provisioned.'."\n" + ."\n" + .'- review\\_pending: The application is pending for review.'."\n" + ."\n" + .'- config\\_pending: The application is pending for configuration.'."\n" + ."\n" + .'- normal: The application is running as normal.'."\n" + ."\n" + .'- frozen: The application is frozen.', 'type' => 'string', 'example' => 'normal', 'title' => ''], + 'updated' => ['description' => 'The timestamp when the application was last updated.', 'type' => 'integer', 'format' => 'int32', 'example' => '1590978265', 'title' => ''], + 'chargeType' => ['description' => 'The billing method.'."\n" + ."\n" + .'- POSTPAY: pay-as-you-go'."\n" + ."\n" + .'- PREPAY: subscription', 'type' => 'string', 'example' => 'POSTPAY', 'title' => ''], + 'id' => ['description' => 'The ID of the application.', 'type' => 'string', 'example' => '100302881', 'title' => ''], + 'hasPendingQuotaReviewTask' => ['description' => 'Indicates whether a quota is pending for approval.'."\n" + ."\n" + .'- 0: No quota is pending for approval.'."\n" + ."\n" + .'- 1: A quota is pending for approval.', 'type' => 'integer', 'format' => 'int32', 'example' => '0', 'title' => ''], + 'projectId' => ['description' => 'The name of the A/B test project.', 'type' => 'string', 'example' => '1000', 'title' => ''], + 'commodityCode' => ['description' => 'The commodity code.', 'type' => 'string', 'example' => 'opensearch', 'title' => ''], + 'switchedTime' => ['description' => 'The timestamp when the online version was switched.', 'type' => 'integer', 'format' => 'int32', 'example' => '1590486386', 'title' => ''], + 'expireOn' => ['description' => 'The expiration time.', 'type' => 'string', 'example' => ' 1', 'title' => ''], + 'description' => ['description' => 'The description of the application.', 'type' => 'string', 'example' => ' 1', 'title' => ''], + 'produced' => ['description' => 'Indicates whether the application is provisioned.'."\n" + ."\n" + .'- 0: The application is being provisioned.'."\n" + ."\n" + .'- 1: The application is provisioned.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'name' => ['description' => 'The name of the application.', 'type' => 'string', 'example' => 'lsh_test_1', 'title' => ''], + 'instanceId' => ['description' => 'The ID of the instance.', 'type' => 'string', 'example' => '1', 'title' => ''], + 'quota' => [ + 'description' => 'The quota information of the application.', + 'type' => 'object', + 'properties' => [ + 'spec' => ['description' => 'The specifications.'."\n" + ."\n" + .'- opensearch.share.junior: Entry-level'."\n" + ."\n" + .'- opensearch.share.common: Shared General-purpose'."\n" + ."\n" + .'- opensearch.share.compute: Shared Compute-optimized'."\n" + ."\n" + .'- opensearch.share.storage: Shared Storage-optimized'."\n" + ."\n" + .'- opensearch.private.common: Dedicated General-purpose'."\n" + ."\n" + .'- opensearch.private.compute: Dedicated Compute-optimized'."\n" + ."\n" + .'- opensearch.private.storage: Dedicated Storage-optimized', 'type' => 'string', 'example' => 'opensearch.share.common', 'title' => ''], + 'docSize' => ['description' => 'The storage capacity in GB.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'computeResource' => ['description' => 'The compute resources in LCU.', 'type' => 'integer', 'format' => 'int32', 'example' => '20', 'title' => ''], + ], + 'title' => '', + 'example' => '', ], - 'scope' => [ - 'description' => 'The sort phase to which the script applies.'."\n", + 'engineType' => [ + 'description' => 'The engine type.', + 'enumValueTitles' => ['ha3' => 'ha3'], 'type' => 'string', - 'example' => 'second_rank', + 'example' => 'ha3', + 'title' => '', ], + 'resourceGroupId' => ['description' => 'The ID of the resource group to which the instance belongs.', 'type' => 'string', 'example' => 'rg-acfmoiyerh6nzly', 'title' => ''], ], + 'title' => '', + 'example' => '', ], ], - 'description' => '', + 'title' => '', + 'example' => '', ], ], '5XX' => [ 'schema' => [ 'type' => 'object', 'properties' => [ - 'code' => [ - 'type' => 'string', - ], - 'message' => [ - 'type' => 'string', - ], - 'requestId' => [ - 'type' => 'string', - ], - 'httpCode' => [ - 'type' => 'integer', - 'format' => 'int32', - ], + 'code' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'message' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'requestId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'httpCode' => ['type' => 'integer', 'format' => 'int32', 'description' => '', 'title' => '', 'example' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"requestId\\": \\"ABCDEFGH\\",\\n \\"result\\": {\\n \\"scriptName\\": \\"rank_cava_20230606_v7\\\\n\\",\\n \\"type\\": \\"cava_script\\",\\n \\"scope\\": \\"second_rank\\"\\n }\\n}","errorExample":""},{"type":"xml","example":"ABCDEFGH","errorExample":""}]', - 'title' => 'CreateSortScript', - 'requestParamsDescription' => '**Request parameters**'."\n" + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"0A6EB64B-B4C8-CF02-810F-E660812972FF\\",\\n \\"result\\": {\\n \\"created\\": 1590139542,\\n \\"currentVersion\\": \\"100302903\\",\\n \\"type\\": \\"enhanced\\",\\n \\"chargingWay\\": 1,\\n \\"lockMode\\": \\"Unlock\\",\\n \\"status\\": \\"normal\\",\\n \\"updated\\": 1590978265,\\n \\"chargeType\\": \\"POSTPAY\\",\\n \\"id\\": \\"100302881\\",\\n \\"hasPendingQuotaReviewTask\\": 0,\\n \\"projectId\\": \\"1000\\",\\n \\"commodityCode\\": \\"opensearch\\",\\n \\"switchedTime\\": 1590486386,\\n \\"expireOn\\": \\" 1\\",\\n \\"description\\": \\" 1\\",\\n \\"produced\\": 1,\\n \\"name\\": \\"lsh_test_1\\",\\n \\"instanceId\\": \\"1\\",\\n \\"quota\\": {\\n \\"spec\\": \\"opensearch.share.common\\",\\n \\"docSize\\": 1,\\n \\"computeResource\\": 20\\n },\\n \\"engineType\\": \\"ha3\\",\\n \\"resourceGroupId\\": \\"rg-acfmoiyerh6nzly\\"\\n }\\n}","type":"json"}]', + 'title' => 'ModifyAppGroupQuota', + 'requestParamsDescription' => '**Request body**
'."\n" ."\n" - .'|Parameter|Type|Required|Description|'."\n" - .'|---|---|---|---|'."\n" - .'|scriptParams|Map|Yes|The parameters of the script to register.|'."\n" - ."\n\n" - .'**scriptParams**'."\n" + .'| Field | Type | Required | Example | Description |'."\n" + .'| --------------- | ------- | -------- | ------------------------- | --------------------------------------------------------------------------------------------------------------------------------- |'."\n" + .'| docSize | Integer | Yes | 1 | The storage capacity in GB. For shared general-purpose instances, the value ranges from 1 to 300. |'."\n" + .'| computeResource | Integer | Yes | 20 | The compute resources in LCU. For shared general-purpose instances, the value ranges from 20 to 5,000. |'."\n" + .'| spec | String | Yes | "opensearch.share.common" | The specifications. |'."\n" + .'| orderType | String | No | "UPGRADE" | The type of the configuration change.
\\- UPGRADE: upgrades the specifications.
\\- DOWNGRADE: downgrades the specifications. |'."\n" ."\n" - .'|Parameter|Type|Required|Description|'."\n" - .'|---|---|---|---|'."\n" - .'|scriptName|String|Yes|The script name.|'."\n" - .'|type|String|Yes|The script type. Set the value to cava\\_script.|'."\n" - .'|scope|String|Yes|The sort phase to which the script applies. Set the value to second\\_rank.|', + .'For more information, see [Quota](~~170001~~).
', 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', - ], - 'CompileSortScript' => [ - 'summary' => 'Compiles a sort script.', - 'path' => '/v4/openapi/app-groups/{appGroupIdentity}/apps/{appVersionId}/sort-scripts/{scriptName}/actions/compiling', - 'methods' => [ - 'post', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'opensearch:ModifyAppGroup', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'OpenSearch', 'resourceType' => 'AppGroup', 'arn' => 'acs:opensearch:{#regionId}:{#accountId}:app-groups/{#AppGroupId}'], + ], + ], + ], ], + 'translator' => 'manual', + ], + 'ModifyFirstRank' => [ + 'summary' => 'Modifies the rough sort expression for an OpenSearch application version. If you set the dryRun parameter to true, this operation validates the modified rough sort expression. The default value of this parameter is false.', + 'path' => '/v4/openapi/app-groups/{appGroupIdentity}/apps/{appId}/first-ranks/{name}', + 'methods' => ['put'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'readAndWrite', + 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREopensearchN8M8WS', - ], + 'abilityTreeNodes' => ['FEATUREopensearchN8M8WS', 'FEATUREopensearchH8SRT8'], ], 'parameters' => [ + [ + 'name' => 'dryRun', + 'in' => 'query', + 'schema' => ['description' => 'Specifies whether to perform a dry run.', 'type' => 'boolean', 'required' => false, 'title' => '', 'example' => 'true'], + ], [ 'name' => 'appGroupIdentity', 'in' => 'path', - 'schema' => [ - 'description' => 'The name and ID of the application.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'search', - ], + 'schema' => ['description' => 'The name of the application group.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'title' => '', 'example' => 'my_app_group_name'], ], [ - 'name' => 'scriptName', + 'name' => 'appId', 'in' => 'path', - 'schema' => [ - 'description' => 'The name of the script.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'script', - ], + 'schema' => ['description' => 'The ID of the application version.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true, 'title' => '', 'example' => '110157886'], ], [ - 'name' => 'appVersionId', + 'name' => 'name', 'in' => 'path', - 'schema' => [ - 'description' => 'The version ID of the application.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '130196473', - ], + 'schema' => ['description' => 'The name of the rough sort expression.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'title' => '', 'example' => 'test'], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'schema' => ['description' => 'The request body.', 'required' => false, '$ref' => '#/components/schemas/FirstRank', 'title' => '', 'example' => ''], ], ], 'responses' => [ @@ -16181,56 +14143,93 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'requestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => 'ABCDEFGH', + 'requestId' => ['description' => 'The request ID.', 'type' => 'string', 'title' => '', 'example' => '0A6EB64B-B4C8-CF02-810F-E660812972FF'], + 'result' => [ + 'description' => 'Details about the rough sort expression.', + 'type' => 'object', + 'properties' => [ + 'description' => ['description' => 'The description.', 'type' => 'string', 'title' => '', 'example' => '1'], + 'active' => ['description' => 'Indicates whether the expression is the default one.', 'type' => 'boolean', 'title' => '', 'example' => 'true'], + 'name' => ['description' => 'The name of the resource.', 'type' => 'string', 'title' => '', 'example' => 'default'], + 'meta' => [ + 'description' => 'Details about the expression.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'arg' => ['description' => 'The parameters for a function in the expression.', 'type' => 'string', 'title' => '', 'example' => '“1 ”'], + 'attribute' => ['description' => 'The attribute, feature function, or search field.', 'type' => 'string', 'title' => '', 'example' => 'static_bm25()'], + 'weight' => ['description' => 'The weight. Valid values: -100000 to 100000. The value cannot be 0.', 'type' => 'number', 'format' => 'float', 'title' => '', 'example' => '10'], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + ], + 'title' => '', + 'example' => '', ], ], 'description' => '', + 'title' => '', + 'example' => '', ], ], '5XX' => [ 'schema' => [ 'type' => 'object', 'properties' => [ - 'code' => [ - 'type' => 'string', - ], - 'message' => [ - 'type' => 'string', - ], - 'requestId' => [ - 'type' => 'string', - ], - 'httpCode' => [ - 'type' => 'integer', - 'format' => 'int32', - ], + 'code' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'requestId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'message' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'httpCode' => ['type' => 'integer', 'format' => 'int32', 'description' => '', 'title' => '', 'example' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"ABCDEFGH\\"\\n}","type":"json"}]', - 'title' => 'CompileSortScript', - 'responseParamsDescription' => ' Error response'."\n" - .' {'."\n" - .' "requestId" : "ABCDEFGH",'."\n" - .' "code":"InvalidAppStatus",'."\n" - .' "message":"invalid app status.",'."\n" - .' "httpCode":400'."\n" - .' }'."\n", - ], - 'UpdateSearchStrategy' => [ - 'summary' => 'Modifies a query policy.', - 'path' => '/v4/openapi/app-groups/{appGroupIdentity}/apps/{appId}/search-strategies/{strategyName}', - 'methods' => [ - 'put', + 'title' => 'ModifyFirstRank', + 'requestParamsDescription' => '**Request body**'."\n" + ."\n" + .'| Field | Type | Required | Example | Description |'."\n" + .'| ----------- | --------------- | -------- | --------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------- |'."\n" + .'| type | String | Yes | "STRUCT" | The type of the expression. Valid values:
\\- STRUCT: The expression is a structure. This is the default value.
\\- STRING: The expression is a custom formula. |'."\n" + .'| meta | Array or String | Yes | | Details about the expression. |'."\n" + .'| description | String | No | "my_test" | A description of the rough sort expression. |'."\n" + .'| active | Boolean | No | true | Specifies whether the expression is the default one. |'."\n" + ."\n" + .'For more information, see [FirstRank](~~170007~~).', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'opensearch:WriteFirstRank', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'OpenSearch', 'resourceType' => 'FirstRank', 'arn' => 'acs:opensearch:{#regionId}:{#accountId}:apps/{#AppGroupId}'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"0A6EB64B-B4C8-CF02-810F-E660812972FF\\",\\n \\"result\\": {\\n \\"description\\": \\"1\\",\\n \\"active\\": true,\\n \\"name\\": \\"default\\",\\n \\"meta\\": [\\n {\\n \\"arg\\": \\"“1 ”\\",\\n \\"attribute\\": \\"static_bm25()\\",\\n \\"weight\\": 10\\n }\\n ]\\n }\\n}","type":"json"}]', + 'translator' => 'manual', + ], + 'ModifyQueryProcessor' => [ + 'path' => '/v4/openapi/app-groups/{appGroupIdentity}/apps/{appId}/query-processors/{name}', + 'methods' => ['put'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -16242,102 +14241,152 @@ 'operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREopensearchBNTDZX', - ], + 'abilityTreeNodes' => ['FEATUREopensearchUIICM8', 'FEATUREopensearchNCXKUT'], ], 'parameters' => [ [ 'name' => 'appGroupIdentity', 'in' => 'path', - 'schema' => [ - 'description' => 'The name of the application.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'group_name', - ], + 'schema' => ['description' => 'The name of the application.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'title' => '', 'example' => '“my_app_group_name”'], ], [ 'name' => 'appId', 'in' => 'path', - 'schema' => [ - 'description' => 'The version number.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '"110157886"', - ], + 'schema' => ['description' => 'The version number of the application.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true, 'title' => '', 'example' => '110157886'], ], [ - 'name' => 'strategyName', + 'name' => 'dryRun', + 'in' => 'query', + 'schema' => ['description' => 'Specifies whether to perform a dry run.', 'type' => 'boolean', 'required' => false, 'title' => '', 'example' => 'true'], + ], + [ + 'name' => 'name', 'in' => 'path', - 'schema' => [ - 'description' => 'The name of the policy.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'default', - ], + 'schema' => ['description' => 'The name of the rule.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'title' => '', 'example' => '“test”'], ], [ 'name' => 'body', 'in' => 'body', - 'schema' => [ - 'description' => 'The request body.'."\n", - 'required' => false, - '$ref' => '#/components/schemas/SearchStrategy', - ], + 'schema' => ['description' => 'The request body.', 'type' => 'any', 'required' => false, 'title' => '', 'example' => '{'."\n" + .' "domain": "GENERAL",'."\n" + .' "category": "",'."\n" + .' "processors": ['."\n" + .' {'."\n" + .' "name": "synonym",'."\n" + .' "useSystemDictionary": true'."\n" + .' },'."\n" + .' {'."\n" + .' "name": "stop_word",'."\n" + .' "useSystemDictionary": true'."\n" + .' }'."\n" + .' ]'."\n" + .'}'], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'description' => 'The response body.'."\n", + 'description' => 'The response body.', 'type' => 'object', 'properties' => [ - 'requestId' => [ - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => 'ABCDEFGH', + 'requestId' => ['description' => 'The request ID.', 'type' => 'string', 'title' => '', 'example' => 'D77D0DAF-790D-F5F5-A9C0-133738165014'], + 'result' => [ + 'description' => 'The information about the rule.', + 'type' => 'object', + 'properties' => [ + 'created' => ['description' => 'The time when the rule was created.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '0'], + 'active' => ['description' => 'Indicates whether the rule is a default rule.', 'type' => 'boolean', 'title' => '', 'example' => 'true'], + 'updated' => ['description' => 'The time when the rule was updated.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '1'], + 'name' => ['description' => 'The name of the rule.', 'type' => 'string', 'title' => '', 'example' => 'synonym'], + 'domain' => ['description' => 'The industry to which the query analysis rule applies. Valid values:'."\n" + ."\n" + .'- GENERAL: General'."\n" + ."\n" + .'- ECOMMERCE: E-commerce'."\n" + ."\n" + .'- IT\\_CONTENT: IT content', 'type' => 'string', 'title' => '', 'example' => 'GENERAL'], + 'indexes' => [ + 'description' => 'The indexes to which the query analysis rule applies.', + 'type' => 'array', + 'items' => ['description' => 'The indexes to which the query analysis rule applies.', 'type' => 'string', 'title' => '', 'example' => '[ "default" ]'], + 'example' => '["default"]', + 'title' => '', + ], + 'processors' => [ + 'description' => 'The analysis rule.', + 'type' => 'array', + 'items' => ['description' => 'The data returned in the response.', 'type' => 'object', 'title' => '', 'example' => '[ "default" ]'], + 'example' => '[]', + 'title' => '', + ], + ], + 'example' => '{}', + 'title' => '', ], ], + 'example' => '{}', + 'title' => '', ], ], '5XX' => [ 'schema' => [ 'type' => 'object', 'properties' => [ - 'code' => [ - 'type' => 'string', - ], - 'message' => [ - 'type' => 'string', - ], - 'requestId' => [ - 'type' => 'string', - ], - 'httpCode' => [ - 'type' => 'integer', - 'format' => 'int32', - ], + 'code' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'message' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'requestId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'httpCode' => ['type' => 'integer', 'format' => 'int32', 'description' => '', 'title' => '', 'example' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"ABCDEFGH\\"\\n}","type":"json"}]', - 'title' => 'UpdateSearchStrategy', - ], - 'RemoveSearchStrategy' => [ - 'summary' => 'Deletes a query policy.', - 'path' => '/v4/openapi/app-groups/{appGroupIdentity}/apps/{appId}/search-strategies/{strategyName}', - 'methods' => [ - 'delete', + 'title' => 'ModifyQueryProcessor', + 'summary' => 'Modifies a query analysis rule for a specific application version. If you set the dryRun parameter to true, this operation checks the specified query analysis rule. If you do not specify the dryRun parameter, the default value is false.', + 'requestParamsDescription' => '**Request body**'."\n" + ."\n" + .'| Parameter | Type | Required | Example | Description |'."\n" + .'| ------------ | ------- | -------- | ------------ | --------------------------------------------------------------------------------------------------------------------------------------------------- |'."\n" + .'| domain | String | No | "GENERAL" | The industry to which the query analysis rule applies.Valid values:
\\- GENERAL: General
\\- ECOMMERCE: E-commerce
\\- IT_CONTENT: IT content |'."\n" + .'| indexes | Array | No | \\["default"] | The indexes to which the query analysis rule applies. |'."\n" + .'| processors[] | Object | No | | The analysis rule.
For more information, see [Processor](~~170014~~) |'."\n" + .'| active | Boolean | No | true | Specifies whether to set the rule to active. |'."\n" + ."\n" + .'For more information, see [QueryProcessor](~~170014~~).
', + 'responseParamsDescription' => '**Response parameters**'."\n" + ."\n" + .'| Parameter | Type | Description |'."\n" + .'| --------- | ------ | ----------------------------------------------------------------------------------------- |'."\n" + .'| requestId | String | The request ID. |'."\n" + .'| result | Object | The information about the rule.
For more information, see [QueryProcessor](~~170014~~) |', + 'extraInfo' => "\n", + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'opensearch:WriteQueryProcessor', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'OpenSearch', 'resourceType' => 'QueryProcessor', 'arn' => 'acs:opensearch:{#regionId}:{#accountId}:apps/{#AppGroupId}'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"D77D0DAF-790D-F5F5-A9C0-133738165014\\",\\n \\"result\\": {\\n \\"created\\": 0,\\n \\"active\\": true,\\n \\"updated\\": 1,\\n \\"name\\": \\"synonym\\",\\n \\"domain\\": \\"GENERAL\\",\\n \\"indexes\\": [\\n \\"[ \\\\\\"default\\\\\\" ]\\"\\n ],\\n \\"processors\\": [\\n [\\n \\"default\\"\\n ]\\n ]\\n }\\n}","type":"json"}]', + 'translator' => 'manual', + ], + 'ModifyScheduledTask' => [ + 'summary' => 'Modifies a scheduled task.', + 'path' => '/v4/openapi/app-groups/{appGroupIdentity}/scheduled-tasks/{taskId}', + 'methods' => ['put'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -16346,260 +14395,271 @@ 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'delete', + 'operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREopensearchBNTDZX', - ], + 'abilityTreeNodes' => ['FEATUREopensearch447AAX', 'FEATUREopensearch0AT3OG'], ], 'parameters' => [ [ 'name' => 'appGroupIdentity', 'in' => 'path', - 'schema' => [ - 'description' => 'The name of the application.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'my_app_group_name', - ], + 'schema' => ['description' => 'The name or ID of the application.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'title' => '', 'example' => '121414148'], ], [ - 'name' => 'appId', + 'name' => 'taskId', 'in' => 'path', - 'schema' => [ - 'description' => 'The version number.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '110157886', - ], + 'schema' => ['description' => 'The task ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'title' => '', 'example' => '56e9c2e7-5a4d-481a-9f1b-b07da6909450'], ], [ - 'name' => 'strategyName', - 'in' => 'path', - 'schema' => [ - 'description' => 'The name of the policy.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'default', - ], + 'name' => 'body', + 'in' => 'body', + 'schema' => ['description' => 'The request parameters.', 'type' => 'any', 'required' => false, 'title' => '', 'example' => '{'."\n" + .' "cron": "0 0 * * 1,2,3,4,5,6,7",'."\n" + .' "enabled": true,'."\n" + .' "filter": {'."\n" + .' "field": "cat_id",'."\n" + .' "days": 30,'."\n" + .' "unit": "s"'."\n" + .' }'."\n" + .'}'], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'description' => 'The response body.'."\n", 'type' => 'object', 'properties' => [ - 'requestId' => [ - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => 'F5099063-6B86-F398-D843-905F9EFB683A', - ], + 'result' => ['description' => 'The information about the scheduled task.', 'type' => 'object', 'title' => '', 'example' => 'Array'], + 'requestId' => ['description' => 'The request ID.', 'type' => 'string', 'title' => '', 'example' => 'D77D0DAF-790D-F5F5-A9C0-133738165014'], ], - 'example' => '{}', + 'description' => '', + 'title' => '', + 'example' => '', ], ], '5XX' => [ 'schema' => [ 'type' => 'object', 'properties' => [ - 'code' => [ - 'type' => 'string', - ], - 'message' => [ - 'type' => 'string', - ], - 'requestId' => [ - 'type' => 'string', - ], - 'httpCode' => [ - 'type' => 'integer', - 'format' => 'int32', - ], + 'code' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'message' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'requestId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'httpCode' => ['type' => 'integer', 'format' => 'int32', 'description' => '', 'title' => '', 'example' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"F5099063-6B86-F398-D843-905F9EFB683A\\"\\n}","type":"json"}]', - 'title' => 'RemoveSearchStrategy', - ], - 'ListSearchStrategies' => [ - 'summary' => 'Queries the details of query policies.', - 'path' => '/v4/openapi/app-groups/{appGroupIdentity}/apps/{appId}/search-strategies', - 'methods' => [ - 'get', + 'title' => 'ModifyScheduledTask', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'opensearch:ModifyScheduledTask', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'OpenSearch', 'resourceType' => 'ScheduledTask', 'arn' => 'acs:opensearch:{#regionId}:{#accountId}:app-groups/{#AppGroupId}'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"result\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n },\\n \\"requestId\\": \\"D77D0DAF-790D-F5F5-A9C0-133738165014\\"\\n}","type":"json"}]', + 'translator' => 'manual', + ], + 'ModifySecondRank' => [ + 'summary' => 'Modifies a fine sort expression for an OpenSearch application version. If you set `dryRun` to `true`, the modified fine sort expression is validated. The `dryRun` parameter is `false` by default.', + 'path' => '/v4/openapi/app-groups/{appGroupIdentity}/apps/{appId}/second-ranks/{name}', + 'methods' => ['put'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', + 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'list', + 'operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREopensearchBNTDZX', - ], + 'abilityTreeNodes' => ['FEATUREopensearchN8M8WS', 'FEATUREopensearchJUWEG4'], ], 'parameters' => [ [ 'name' => 'appGroupIdentity', 'in' => 'path', - 'schema' => [ - 'description' => 'The name of the application.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '"my_app"', - ], + 'schema' => ['description' => 'The name of the application group.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'title' => '', 'example' => '“my_app_group_name”'], ], [ 'name' => 'appId', 'in' => 'path', - 'schema' => [ - 'description' => 'The ID of the version.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '"110123456"', - ], + 'schema' => ['description' => 'The version number.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true, 'title' => '', 'example' => '110157886'], + ], + [ + 'name' => 'name', + 'in' => 'path', + 'schema' => ['description' => 'The name of the fine sort expression.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'title' => '', 'example' => 'true'], + ], + [ + 'name' => 'dryRun', + 'in' => 'query', + 'schema' => ['description' => 'Specifies whether to perform a dry run.', 'type' => 'boolean', 'required' => false, 'title' => '', 'example' => 'true'], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'schema' => ['description' => 'The request body, which contains the fine sort information.', 'required' => false, '$ref' => '#/components/schemas/SecondRank', 'title' => '', 'example' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'description' => 'The data returned.'."\n", + 'description' => 'The response body.', 'type' => 'object', 'properties' => [ - 'requestId' => [ - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => '9C6351F5-2E2E-5249-888B-88A74E1B8A65', + 'requestId' => ['description' => 'The request ID.', 'type' => 'string', 'title' => '', 'example' => 'C5E2F73C-8241-81F8-3A62-65478C5A3111'], + 'result' => [ + 'description' => 'The information about the fine sort expression.', + 'type' => 'object', + 'properties' => [ + 'created' => ['description' => 'The time when the expression was created.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '1'], + 'active' => ['description' => 'Indicates whether the expression is the default one.', 'type' => 'boolean', 'title' => '', 'example' => 'true'], + 'isDefault' => ['description' => 'Indicates whether the expression is the default expression. This parameter is returned only in the response.'."\n" + ."\n" + .'- true: The expression is the default expression.'."\n" + ."\n" + .'- false: The expression is not the default expression.', 'type' => 'string', 'title' => '', 'example' => 'true'], + 'isSys' => ['description' => 'Indicates whether the expression is a system expression. This parameter is returned only in the response.'."\n" + ."\n" + .'- true: The expression is a system expression.'."\n" + ."\n" + .'- false: The expression is not a system expression.', 'type' => 'string', 'title' => '', 'example' => 'false'], + 'description' => ['description' => 'The description of the expression.', 'type' => 'string', 'title' => '', 'example' => '"11"'], + 'updated' => ['description' => 'The time when the expression was updated.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '1'], + 'name' => ['description' => 'The name of the expression.', 'type' => 'string', 'title' => '', 'example' => 'lsh_second_1'], + 'meta' => ['description' => 'The fine sort expression. You can create an expression that contains fields, scoring features, and mathematical functions to implement complex sorting logic.', 'type' => 'string', 'title' => '', 'example' => 'cate_id > 0 and cate_id < 1000'], + 'id' => ['description' => 'The ID of the expression. This parameter is returned only in the response.', 'type' => 'string', 'title' => '', 'example' => '890473'], + ], + 'example' => '{}', + 'title' => '', ], ], 'example' => '{}', - ], - ], - '5XX' => [ - 'schema' => [ - 'type' => 'object', - 'properties' => [ - 'code' => [ - 'type' => 'string', - ], - 'message' => [ - 'type' => 'string', - ], - 'requestId' => [ - 'type' => 'string', - ], - 'httpCode' => [ - 'type' => 'integer', - 'format' => 'int32', - ], - ], - ], - ], - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"9C6351F5-2E2E-5249-888B-88A74E1B8A65\\"\\n}","type":"json"}]', - 'title' => 'ListSearchStrategies', - 'responseParamsDescription' => 'Sample responses'."\n" - ."\n" - .'```json'."\n" - .'{'."\n" - .' "name": "test",'."\n" - .' "status": 1,'."\n" - .' "description": "",'."\n" - .' "updated": 12455,'."\n" - .' "searchConfigs": ['."\n" - .' {'."\n" - .' "queryType": "vector",'."\n" - .' "firstRankName": "",'."\n" - .' "secondRankName": "",'."\n" - .' "mergeProportion": 30'."\n" - .' },'."\n" - .' {'."\n" - .' "queryType": "keyword",'."\n" - .' "firstRankName": "",'."\n" - .' "secondName": "",'."\n" - .' "mergeProportion": 70'."\n" - .' }'."\n" - .' ],'."\n" - .' "mergeConfig": {'."\n" - .' "rankName": "",'."\n" - .' "docCount": 5000'."\n" - .' }'."\n" - .'}'."\n" - .'```'."\n", - ], - 'GetSearchStrategy' => [ - 'summary' => 'Queries the details of a query policy.', - 'path' => '/v4/openapi/app-groups/{appGroupIdentity}/apps/{appId}/search-strategies/{strategyName}', - 'methods' => [ - 'get', + 'title' => '', + ], + ], + '5XX' => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'code' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'message' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'requestId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'httpCode' => ['type' => 'integer', 'format' => 'int32', 'description' => '', 'title' => '', 'example' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + ], + ], + 'title' => 'ModifySecondRank', + 'requestParamsDescription' => '**Request body**'."\n" + ."\n" + .'| Parameter | Type | Required | Example | Description |'."\n" + .'| ----------- | ------- | -------- | ---------------------- | ----------------------------------------------------------- |'."\n" + .'| meta | String | No | "text_relevance(name)" | The content of the expression. |'."\n" + .'| description | String | No | "my_test" | The description of the expression. |'."\n" + .'| active | Boolean | No | true | Specifies whether the expression is the default expression. |', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'opensearch:WriteSecondRank', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'OpenSearch', 'resourceType' => 'SecondRank', 'arn' => 'acs:opensearch:{#regionId}:{#accountId}:apps/{#AppGroupId}'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"C5E2F73C-8241-81F8-3A62-65478C5A3111\\",\\n \\"result\\": {\\n \\"created\\": 1,\\n \\"active\\": true,\\n \\"isDefault\\": \\"true\\",\\n \\"isSys\\": \\"false\\",\\n \\"description\\": \\"\\\\\\"11\\\\\\"\\",\\n \\"updated\\": 1,\\n \\"name\\": \\"lsh_second_1\\",\\n \\"meta\\": \\"cate_id > 0 and cate_id < 1000\\",\\n \\"id\\": \\"890473\\"\\n }\\n}","type":"json"}]', + 'translator' => 'manual', + ], + 'PushInterventionDictionaryEntries' => [ + 'path' => '/v4/openapi/intervention-dictionaries/{name}/entries/actions/bulk', + 'methods' => ['post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], + [ + 'APP' => [], + ], ], - 'operationType' => 'read', + 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'get', + 'operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREopensearchBNTDZX', - ], + 'abilityTreeNodes' => ['FEATUREopensearchNCXKUT', 'FEATUREopensearchUIICM8'], ], 'parameters' => [ [ - 'name' => 'appGroupIdentity', + 'name' => 'name', 'in' => 'path', - 'schema' => [ - 'description' => 'The ID of the application.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'my_app_group_name', - ], + 'schema' => ['description' => 'The name of the intervention dictionary.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'my_dict', 'title' => ''], ], [ - 'name' => 'appId', - 'in' => 'path', - 'schema' => [ - 'description' => 'The version of the application.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '110157886', - ], + 'name' => 'dryRun', + 'in' => 'query', + 'schema' => ['description' => 'Specifies whether to validate the request parameters without creating the attribution configuration. The default value is false.'."\n" + ."\n" + .'Valid values:'."\n" + ."\n" + .'- **true**: Validates the request parameters only.'."\n" + ."\n" + .'- **false**: Validates the request parameters and creates the attribution configuration.', 'type' => 'boolean', 'required' => false, 'example' => 'false', 'title' => ''], ], [ - 'name' => 'strategyName', - 'in' => 'path', + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', 'schema' => [ - 'description' => 'The name of the policy.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'default', + 'description' => 'The request body.', + 'type' => 'array', + 'items' => ['description' => 'The request body.', 'type' => 'object', 'required' => false, 'example' => '{'."\n" + .' "cmd": "add",'."\n" + .' "word": "搜索",'."\n" + .' "created": 1536661485,'."\n" + .' "updated": 1537320187,'."\n" + .' "status": "ACTIVE",'."\n" + .' "relevance": {'."\n" + .' "100": "0",'."\n" + .' "200": "2"'."\n" + .' }'."\n" + .'}', 'title' => ''], + 'required' => false, + 'maxItems' => 100, + 'title' => '', + 'example' => '', ], ], ], @@ -16608,48 +14668,96 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'requestId' => [ - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => '5C1C1C45-C64A-AD30-565F-140871D57E5E', + 'requestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'D77D0DAF-790D-F5F5-A9C0-133738165014', 'title' => ''], + 'result' => [ + 'description' => 'The returned results.', + 'type' => 'array', + 'items' => ['description' => 'The returned result.', 'type' => 'string', 'example' => '[]', 'title' => ''], + 'title' => '', + 'example' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], '5XX' => [ 'schema' => [ 'type' => 'object', 'properties' => [ - 'code' => [ - 'type' => 'string', - ], - 'message' => [ - 'type' => 'string', - ], - 'requestId' => [ - 'type' => 'string', - ], - 'httpCode' => [ - 'type' => 'integer', - 'format' => 'int32', - ], + 'code' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'requestId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'message' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'httpCode' => ['type' => 'integer', 'format' => 'int32', 'description' => '', 'title' => '', 'example' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"5C1C1C45-C64A-AD30-565F-140871D57E5E\\"\\n}","type":"json"}]', - 'title' => 'GetSearchStrategy', - ], - 'CreateSearchStrategy' => [ - 'summary' => 'Creates a query policy.', - 'path' => '/v4/openapi/app-groups/{appGroupIdentity}/apps/{appId}/search-strategies', - 'methods' => [ - 'post', + 'title' => 'PushInterventionDictionaryEntries', + 'summary' => 'Applies changes to intervention dictionary entries.', + 'requestParamsDescription' => 'Common **request body** parameters'."\n" + ."\n" + .'| Field | Type | Required | Example | Description |'."\n" + .'| -------- | ------ | -------- | --------------- | ------------------------------------------------------------------------------------------------- |'."\n" + .'| \\[] | Object | Yes | | The information about the intervention entry. |'."\n" + .'| \\[].cmd | String | Yes | "add" | The command to perform. Valid values:
- add: adds an entry.
- delete: deletes an entry.
|'."\n" + .'| \\[].word | String | Yes | "Alibaba Cloud" | The intervention entry. |'."\n" + ."\n" + .'For more information about specific parameters, see the following documents:'."\n" + ."\n" + .'- [Stop words](~~173606~~)'."\n" + ."\n" + .'- [Synonyms](~~173606~~)'."\n" + ."\n" + .'- [Spelling correction](~~173606~~)'."\n" + ."\n" + .'- [Term weights](~~173606~~)'."\n" + ."\n" + .'- [Category prediction](~~173606~~)'."\n" + ."\n" + .'- [Named Entity Recognition (NER)](~~173606~~)'."\n" + ."\n" + .'- [Drop-down suggestion whitelist](~~173606~~)'."\n" + ."\n" + .'- [Drop-down suggestion blacklist](~~173606~~)'."\n" + ."\n" + .'- [Top search whitelist](~~173606~~)'."\n" + ."\n" + .'- [Top search blacklist](~~173606~~)'."\n" + ."\n" + .'- [Hint whitelist](~~173606~~)'."\n" + ."\n" + .'- [Hint blacklist](~~173606~~)', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'opensearch:WriteInterventionDictionary', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'OpenSearch', 'resourceType' => 'InterventionDictionary', 'arn' => 'acs:opensearch:{#regionId}:{#accountId}:intervention-dictionaries/{#InterventionDictionaryId}'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"D77D0DAF-790D-F5F5-A9C0-133738165014\\",\\n \\"result\\": [\\n \\"[]\\"\\n ]\\n}","type":"json"}]', + 'translator' => 'manual', + ], + 'PushUserAnalyzerEntries' => [ + 'path' => '/v4/openapi/user-analyzers/{name}/entries/actions/bulk', + 'methods' => ['post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -16658,94 +14766,121 @@ 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'create', + 'operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREopensearchBNTDZX', - ], + 'abilityTreeNodes' => ['FEATUREopensearchUIICM8'], ], 'parameters' => [ [ - 'name' => 'appGroupIdentity', + 'name' => 'name', 'in' => 'path', - 'schema' => [ - 'description' => 'The name of the application.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '"my_app"', - ], + 'schema' => ['description' => 'The name of the analyzer.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'title' => '', 'example' => '“kevin_test”'], ], [ - 'name' => 'appId', - 'in' => 'path', - 'schema' => [ - 'description' => 'The version number of the application.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '1234', - ], + 'name' => 'dryRun', + 'in' => 'query', + 'schema' => ['description' => 'Specifies whether to perform a dry run. This parameter is only used to check whether the data source is valid. Valid values: true and false.', 'type' => 'boolean', 'required' => false, 'title' => '', 'example' => 'true'], ], [ 'name' => 'body', 'in' => 'body', + 'style' => 'json', 'schema' => [ - 'description' => 'The query policy.'."\n", + 'description' => 'The request body.', + 'type' => 'object', + 'properties' => [ + 'entries' => [ + 'description' => 'The entries of the custom analyzer.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'cmd' => ['description' => 'The operation to perform on the entries.'."\n" + ."\n" + .'Valid values:'."\n" + ."\n" + .'- add'."\n" + ."\n" + .'- delete', 'type' => 'string', 'required' => false, 'title' => '', 'example' => '"add"'], + 'key' => ['description' => 'The key to be used to query entries.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => '"testvalue"'], + 'value' => ['description' => 'The analysis result.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => '"test value"'], + 'splitEnabled' => ['description' => 'Specifies whether to enable fine-grained splitting.'."\n" + ."\n" + .'Default: true', 'type' => 'boolean', 'required' => false, 'title' => '', 'example' => 'true'], + ], + 'required' => false, + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'required' => false, + 'maxItems' => 100, + 'title' => '', + 'example' => '', + ], + ], 'required' => false, - '$ref' => '#/components/schemas/SearchStrategy', + 'title' => '', + 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'description' => 'The response body.'."\n", 'type' => 'object', 'properties' => [ - 'requestId' => [ - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => '"abc123"', - ], + 'result' => ['description' => 'The result returned.', 'type' => 'object', 'title' => '', 'example' => '[]'], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'title' => '', 'example' => 'D77D0DAF-790D-F5F5-A9C0-133738165014'], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], '5XX' => [ 'schema' => [ 'type' => 'object', 'properties' => [ - 'code' => [ - 'type' => 'string', - ], - 'message' => [ - 'type' => 'string', - ], - 'requestId' => [ - 'type' => 'string', - ], - 'httpCode' => [ - 'type' => 'integer', - 'format' => 'int32', - ], + 'code' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'message' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'requestId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'httpCode' => ['type' => 'integer', 'format' => 'int32', 'description' => '', 'title' => '', 'example' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"\\\\\\"abc123\\\\\\"\\"\\n}","type":"json"}]', - 'title' => 'CreateSearchStrategy', - ], - 'UpdateFetchFields' => [ - 'summary' => 'Updates fetch fields. A dry run is supported.', - 'path' => '/v4/openapi/app-groups/{appGroupIdentity}/apps/{appId}/fetch-fields', - 'methods' => [ - 'put', + 'title' => 'PushUserAnalyzerEntries', + 'summary' => 'Applies changes to the entries of a custom analyzer.', + 'requestParamsDescription' => 'Note: Use lowercase letters for intervention entries.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'opensearch:WriteUserAnalyzer', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'OpenSearch', 'resourceType' => 'Analyzer', 'arn' => 'acs:opensearch:{#regionId}:{#accountId}:user-analyzers/{#AnalyzerId}'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"result\\": [],\\n \\"RequestId\\": \\"D77D0DAF-790D-F5F5-A9C0-133738165014\\"\\n}","type":"json"}]', + 'translator' => 'manual', + ], + 'ReleaseSortScript' => [ + 'path' => '/v4/openapi/app-groups/{appGroupIdentity}/apps/{appVersionId}/sort-scripts/{scriptName}/actions/release', + 'methods' => ['post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -16757,61 +14892,23 @@ 'operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREopensearchYVAV9H', - 'FEATUREopensearchBZ8NMO', - ], + 'abilityTreeNodes' => ['FEATUREopensearchN8M8WS'], ], 'parameters' => [ - [ - 'name' => 'dryRun', - 'in' => 'query', - 'schema' => [ - 'description' => 'Specifies whether the request is a dry run.'."\n", - 'type' => 'boolean', - 'required' => false, - 'example' => 'true', - ], - ], [ 'name' => 'appGroupIdentity', 'in' => 'path', - 'schema' => [ - 'description' => 'The name of the application'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '“my_app_group_name”', - ], + 'schema' => ['description' => 'The name or ID of the application.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '\'\'1234\'\'', 'title' => ''], ], [ - 'name' => 'appId', + 'name' => 'scriptName', 'in' => 'path', - 'schema' => [ - 'description' => 'The version number.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'docRequired' => true, - 'example' => '110157886', - ], + 'schema' => ['description' => 'The name of the script.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '\'\'test\'\'', 'title' => ''], ], [ - 'name' => 'body', - 'in' => 'body', - 'style' => 'json', - 'schema' => [ - 'description' => 'The request body.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The field array.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '\'["id", "name", "title"]\'', - ], - 'required' => false, - 'maxItems' => 100, - ], + 'name' => 'appVersionId', + 'in' => 'path', + 'schema' => ['description' => 'The ID of the application version.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '\'\'12345\'\'', 'title' => ''], ], ], 'responses' => [ @@ -16819,60 +14916,74 @@ 'schema' => [ 'type' => 'object', 'properties' => [ + 'requestId' => ['description' => 'The unique ID of the request.', 'type' => 'string', 'example' => 'ABCDEFGH', 'title' => ''], 'result' => [ - 'description' => 'Indicates whether the operation was successful.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'requestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => 'D77D0DAF-790D-F5F5-A9C0-133738165014', + 'type' => 'object', + 'properties' => [ + 'version' => ['type' => 'integer', 'format' => 'int64', 'description' => '', 'title' => '', 'example' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], 'description' => '', + 'title' => '', + 'example' => '', ], ], '5XX' => [ 'schema' => [ 'type' => 'object', 'properties' => [ - 'code' => [ - 'type' => 'string', - ], - 'httpCode' => [ - 'type' => 'integer', - 'format' => 'int32', - ], - 'requestId' => [ - 'type' => 'string', - ], - 'message' => [ - 'type' => 'string', - ], + 'code' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'message' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'requestId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'httpCode' => ['type' => 'integer', 'format' => 'int32', 'description' => '', 'title' => '', 'example' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"result\\": true,\\n \\"requestId\\": \\"D77D0DAF-790D-F5F5-A9C0-133738165014\\"\\n}","errorExample":""},{"type":"xml","example":"D77D0DAF-790D-F5F5-A9C0-133738165014\\ntrue","errorExample":""}]', - 'title' => 'UpdateFetchFields', - 'requestParamsDescription' => '**Request body**'."\n" - ."\n" - .'> You can specify the names of multiple display fields, such as id, name, and title, in the request body.'."\n", + 'title' => 'ReleaseSortScript', + 'summary' => 'Releases a sort script.', + 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', - 'translator' => 'machine', - ], - 'UpdateSummaries' => [ - 'summary' => 'Updates summaries. A dry run is supported.', - 'path' => '/v4/openapi/app-groups/{appGroupIdentity}/apps/{appId}/summaries', - 'methods' => [ - 'put', + 'extraInfo' => '**错误返回**'."\n" + ."\n" + .'{'."\n" + .' "requestId" : "ABCDEFGH"'."\n" + .' "code":"InvalidAppStatus",'."\n" + .' "message":"invalid app status.",'."\n" + .' "httpCode":400'."\n" + .'}', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'opensearch:WriteSortScript', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'OpenSearch', 'resourceType' => 'App', 'arn' => 'acs:opensearch:{#regionId}:{#accountId}:apps/{#AppGroupId}'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"ABCDEFGH\\",\\n \\"result\\": {\\n \\"version\\": 0\\n }\\n}","type":"json"}]', + 'translator' => 'manual', + ], + 'RemoveApp' => [ + 'summary' => 'Deletes a version of an OpenSearch application.', + 'path' => '/v4/openapi/app-groups/{appGroupIdentity}/apps/{appId}', + 'methods' => ['delete'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -16881,98 +14992,22 @@ 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'update', + 'operationType' => 'delete', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeCode' => '55273', - 'abilityTreeNodes' => [ - 'FEATUREopensearchYVAV9H', - 'FEATUREopensearchBZ8NMO', - ], + 'abilityTreeCode' => '55248', + 'abilityTreeNodes' => ['FEATUREopensearchGVH0IN', 'FEATUREopensearch447AAX', 'FEATUREopensearch5OZOSP'], ], 'parameters' => [ - [ - 'name' => 'dryRun', - 'in' => 'query', - 'schema' => [ - 'description' => 'Specifies whether the request is a dry run.'."\n", - 'type' => 'boolean', - 'required' => false, - 'example' => 'true', - ], - ], [ 'name' => 'appGroupIdentity', 'in' => 'path', - 'schema' => [ - 'description' => 'The name of the application.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '“my_app_group_name”', - ], + 'schema' => ['description' => 'The name or ID of the application group.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'title' => '', 'example' => '“my_app_group_name”'], ], [ 'name' => 'appId', 'in' => 'path', - 'schema' => [ - 'description' => 'The version number of the application.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'docRequired' => true, - 'example' => '10157886', - ], - ], - [ - 'name' => 'body', - 'in' => 'body', - 'style' => 'json', - 'schema' => [ - 'description' => 'The request body.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The request body.', - 'type' => 'object', - 'properties' => [ - 'field' => [ - 'description' => 'The field.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '"title"', - ], - 'len' => [ - 'description' => 'The length of a segment.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '50', - ], - 'element' => [ - 'description' => 'The HTML tag that is used to highlight terms in red.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '"em" ', - ], - 'ellipsis' => [ - 'description' => 'The connector that is used to connect segments.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '"..."', - ], - 'snippet' => [ - 'description' => 'The number of segments.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', - ], - ], - 'required' => false, - ], - 'required' => false, - 'maxItems' => 100, - ], + 'schema' => ['description' => 'The ID of the application version.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true, 'title' => '', 'example' => '110116134'], ], ], 'responses' => [ @@ -16980,1295 +15015,965 @@ 'schema' => [ 'type' => 'object', 'properties' => [ + 'requestId' => ['description' => 'The request ID.', 'type' => 'string', 'title' => '', 'example' => '33477D76-C380-2D84-A4AD-043F52876CB1'], 'result' => [ - 'description' => 'Indicates whether the request was successful.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'requestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '7A389E09-7964-5A2B-FE9D-F6CFA7162852', + 'description' => '—', + 'type' => 'array', + 'items' => ['description' => '—', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '[]'], + 'title' => '', + 'example' => '', ], ], 'description' => '', + 'title' => '', + 'example' => '', ], ], '5XX' => [ 'schema' => [ 'type' => 'object', 'properties' => [ - 'code' => [ - 'type' => 'string', - ], - 'httpCode' => [ - 'type' => 'integer', - 'format' => 'int32', - ], - 'requestId' => [ - 'type' => 'string', - ], - 'message' => [ - 'type' => 'string', - ], + 'code' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'message' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'requestId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'httpCode' => ['type' => 'integer', 'format' => 'int32', 'description' => '', 'title' => '', 'example' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"result\\": true,\\n \\"requestId\\": \\"7A389E09-7964-5A2B-FE9D-F6CFA7162852\\"\\n}","errorExample":""},{"type":"xml","example":"true\\n7A389E09-7964-5A2B-FE9D-F6CFA7162852","errorExample":""}]', - 'title' => 'UpdateSummaries', - 'requestParamsDescription' => '**Request body**'."\n" - ."\n" - .'|Field|Type|Required|Example|Description|'."\n" - .'|---|---|---|---|---|'."\n" - .'|\\[\\]|Object|Yes||The summary settings. For more information, see [Summary](~~170016~~).|'."\n" - .'|\\[\\].field|String|Yes|"title"|The field.|'."\n" - .'|\\[\\].len|Integer|Yes|50|The length of a segment.|'."\n" - .'|\\[\\].element|String|Yes|"em"|The HTML tag that is used to highlight terms in red.|'."\n" - .'|\\[\\].ellipsis|String|Yes|"..."|The connector that is used to connect segments.|'."\n" - .'|\\[\\].snippet|Integer|Yes|1|The number of segments.|', - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', - ], - 'CreateFunctionResource' => [ - 'summary' => 'Creates an algorithm resource for a specific feature.', - 'path' => '/v4/openapi/app-groups/{appGroupIdentity}/functions/{functionName}/resources', - 'methods' => [ - 'post', + 'title' => 'RemoveApp', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'opensearch:RemoveApp', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'OpenSearch', 'resourceType' => 'App', 'arn' => 'acs:opensearch:{#regionId}:{#accountId}:app-groups/{#AppGroupId}'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"33477D76-C380-2D84-A4AD-043F52876CB1\\",\\n \\"result\\": [\\n 0\\n ]\\n}","type":"json"}]', + 'translator' => 'machine', + ], + 'RemoveAppGroup' => [ + 'summary' => 'Deletes an OpenSearch application.', + 'path' => '/v4/openapi/app-groups/{appGroupIdentity}', + 'methods' => ['delete'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], 'operationType' => 'write', 'deprecated' => false, - 'systemTags' => [], + 'systemTags' => [ + 'operationType' => 'delete', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATUREopensearch447AAX', 'FEATUREopensearch5OZOSP'], + ], 'parameters' => [ [ 'name' => 'appGroupIdentity', 'in' => 'path', - 'schema' => [ - 'title' => '应用ID', - 'description' => 'The name of the application.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'my_app_group_name', - ], + 'schema' => ['description' => 'The name of the application.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'title' => '', 'example' => '121001650'], ], - [ - 'name' => 'functionName', - 'in' => 'path', + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'title' => '功能名称', - 'description' => 'The name of the feature.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'rank', + 'type' => 'object', + 'properties' => [ + 'requestId' => ['description' => 'The request ID.', 'type' => 'string', 'title' => '', 'example' => '3AA29D02-54F3-8569-F71A-90E1B7BE4E7E'], + 'result' => [ + 'description' => 'The returned results.', + 'type' => 'array', + 'items' => ['description' => 'The returned result.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '[]'], + 'title' => '', + 'example' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], - [ - 'name' => 'body', - 'in' => 'body', - 'style' => 'json', + '5XX' => [ 'schema' => [ - 'description' => 'The body of the request.'."\n", 'type' => 'object', 'properties' => [ - 'Data' => [ - 'description' => 'The resource data. The data structure varies with the resource type.'."\n", - 'type' => 'object', - 'properties' => [ - 'Content' => [ - 'description' => 'The content of the file that corresponds to a resource of the raw_file type.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '"abc"', - ], - 'Generators' => [ - 'description' => 'The feature generators that correspond to resources of the feature_generator type.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'Generator' => [ - 'description' => 'The type of the feature generator.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* lookup'."\n" - ."\n" - .' '."\n" - ."\n" - .' '."\n" - ."\n" - .' '."\n" - ."\n" - .'* sequence'."\n" - ."\n" - .' '."\n" - ."\n" - .' '."\n" - ."\n" - .' '."\n" - ."\n" - .'* overlap'."\n" - ."\n" - .' '."\n" - ."\n" - .' '."\n" - ."\n" - .' '."\n" - ."\n" - .'* raw'."\n" - ."\n" - .' '."\n" - ."\n" - .' '."\n" - ."\n" - .' '."\n" - ."\n" - .'* combo'."\n" - ."\n" - .' '."\n" - ."\n" - .' '."\n" - ."\n" - .' '."\n" - ."\n" - .'* id'."\n" - ."\n" - .' '."\n" - ."\n" - .' '."\n" - ."\n" - .' '."\n", - 'type' => 'string', - 'required' => false, - 'enumValueTitles' => [ - 'lookup' => 'lookup', - 'sequence' => 'sequence', - 'overlap' => 'overlap', - 'raw' => 'raw', - 'combo' => 'combo', - 'id' => 'id', - ], - 'example' => 'id', - ], - 'Input' => [ - 'description' => 'The input.'."\n", - 'type' => 'object', - 'properties' => [ - 'Features' => [ - 'description' => 'The input features.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'Name' => [ - 'description' => 'The name of the feature.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'system_item_id', - ], - 'Type' => [ - 'description' => 'The type of the feature.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* item'."\n" - ."\n" - .' '."\n" - ."\n" - .' '."\n" - ."\n" - .' '."\n" - ."\n" - .'* user'."\n" - ."\n" - .' '."\n" - ."\n" - .' '."\n" - ."\n" - .' '."\n", - 'type' => 'string', - 'required' => false, - 'enumValueTitles' => [ - 'item' => 'item', - 'user' => 'user', - ], - 'example' => 'item', - ], - ], - 'required' => false, - ], - 'required' => false, - ], - ], - 'required' => false, - ], - 'Output' => [ - 'description' => 'The name of the output feature.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'item_id_feature', - ], - ], - 'required' => false, - ], - 'required' => false, - ], - ], - 'required' => false, - ], - 'Description' => [ - 'description' => 'The description of the resource.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '""', - ], - 'ResourceName' => [ - 'description' => 'The name of the resource.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'fg_jsoon', - ], - 'ResourceType' => [ - 'description' => 'The resource type.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* feature_generator'."\n" - ."\n" - .' '."\n" - ."\n" - .' '."\n" - ."\n" - .' '."\n" - ."\n" - .'* raw_file'."\n" - ."\n" - .' '."\n" - ."\n" - .' '."\n" - ."\n" - .' '."\n", - 'type' => 'string', - 'required' => false, - 'enumValueTitles' => [ - 'feature_generator' => 'feature_generator', - 'raw_file' => 'raw_file', - ], - 'example' => 'feature_generator', - ], + 'code' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'message' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'requestId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'httpCode' => ['type' => 'integer', 'format' => 'int32', 'description' => '', 'title' => '', 'example' => ''], ], - 'required' => false, - 'docRequired' => true, + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], + 'title' => 'RemoveAppGroup', + 'description' => 'You can only delete pay-as-you-go applications. Subscription applications cannot be deleted.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'opensearch:RemoveAppGroup', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'OpenSearch', 'resourceType' => 'AppGroup', 'arn' => 'acs:opensearch:{#regionId}:{#accountId}:app-groups/{#AppGroupId}'], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"3AA29D02-54F3-8569-F71A-90E1B7BE4E7E\\",\\n \\"result\\": [\\n 0\\n ]\\n}","type":"json"}]', + 'translator' => 'manual', + ], + 'RemoveDataCollection' => [ + 'path' => '/v4/openapi/app-groups/{appGroupIdentity}/data-collections/{dataCollectionIdentity}', + 'methods' => ['delete'], + 'schemes' => ['http', 'https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + 'abilityTreeCode' => '55250', + 'abilityTreeNodes' => ['FEATUREopensearchAROC40'], + ], + 'parameters' => [ + [ + 'name' => 'appGroupIdentity', + 'in' => 'path', + 'schema' => ['description' => 'The application name.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'title' => '', 'example' => '“my_app_group_name”'], + ], + [ + 'name' => 'dataCollectionIdentity', + 'in' => 'path', + 'schema' => ['description' => 'The data collection ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'title' => '', 'example' => '286'], + ], + ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Status' => [ - 'description' => 'The status code. Valid values:'."\n" - ."\n" - .'* OK'."\n" - .'* FAIL'."\n", - 'type' => 'string', - 'example' => 'OK', - ], - 'HttpCode' => [ - 'description' => 'The HTTP status code returned.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '200', - ], - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => 'A4D487A9-A456-5AA5-A9C6-B7BF2889CF74', - ], - 'Message' => [ - 'description' => 'The error message returned.'."\n", - 'type' => 'string', - 'example' => '""', - ], - 'Code' => [ - 'description' => 'The error code. If no error occurs, this parameter is left empty.'."\n", - 'type' => 'string', - 'example' => '""', - ], - 'Latency' => [ - 'description' => 'The time consumed for the request. Unit: milliseconds.'."\n", - 'type' => 'number', - 'format' => 'double', - 'example' => '123', - ], + 'result' => ['description' => '—', 'type' => 'string', 'title' => '', 'example' => '{}'], + 'requestId' => ['description' => 'The request ID.', 'type' => 'string', 'title' => '', 'example' => 'D77D0DAF-790D-F5F5-A9C0-133738165014'], ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + ], + '5XX' => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'code' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'message' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'requestId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'httpCode' => ['type' => 'integer', 'format' => 'int32', 'description' => '', 'title' => '', 'example' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Status\\": \\"OK\\",\\n \\"HttpCode\\": 200,\\n \\"RequestId\\": \\"A4D487A9-A456-5AA5-A9C6-B7BF2889CF74\\",\\n \\"Message\\": \\"\\\\\\"\\\\\\"\\",\\n \\"Code\\": \\"\\\\\\"\\\\\\"\\",\\n \\"Latency\\": 123\\n}","type":"json"}]', - 'title' => 'CreateFunctionResource', - ], - 'GetFunctionCurrentVersion' => [ - 'summary' => 'Queries the version information about the current feature when you create an instance.', - 'path' => '/v4/openapi/functions/{functionName}/current-version', - 'methods' => [ - 'get', + 'title' => 'RemoveDataCollection', + 'summary' => 'Disables data collection.', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'opensearch:WriteDataCollection', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'OpenSearch', 'resourceType' => 'DataCollection', 'arn' => 'acs:opensearch:{#regionId}:{#accountId}:apps/{#AppGroupId}'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"result\\": \\"{}\\",\\n \\"requestId\\": \\"D77D0DAF-790D-F5F5-A9C0-133738165014\\"\\n}","type":"json"}]', + 'translator' => 'manual', + ], + 'RemoveFirstRank' => [ + 'summary' => 'Deletes the rough sort configuration of an OpenSearch application version.', + 'path' => '/v4/openapi/app-groups/{appGroupIdentity}/apps/{appId}/first-ranks/{name}', + 'methods' => ['delete'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'produces' => [ - 'application/json', - ], - 'operationType' => 'read', + 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'get', + 'operationType' => 'delete', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATUREopensearchN8M8WS', 'FEATUREopensearchH8SRT8'], ], 'parameters' => [ [ - 'name' => 'functionName', + 'name' => 'appGroupIdentity', 'in' => 'path', - 'schema' => [ - 'description' => 'The name of the feature. Valid values:'."\n" - ."\n" - .'* ctr: click-through rate (CTR) model'."\n" - .'* pop: popularity model'."\n" - .'* category: category model'."\n" - .'* hot: hotword model'."\n" - .'* hint: shading model'."\n" - .'* suggest: drop-down suggestion model'."\n" - .'* analyzer: word segmentation model'."\n" - .'* termweight: word weight model'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'ctr', - ], + 'schema' => ['description' => 'The name of the application group.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'title' => '', 'example' => '“my_app_group_name”'], ], [ - 'name' => 'modelType', - 'in' => 'query', - 'schema' => [ - 'description' => 'The type of the model. The following features correspond to different model types:'."\n" - ."\n" - .'* CTR model: tf_checkpoint'."\n" - .'* Popularity model: pop'."\n" - .'* Category model: offline_inference'."\n" - .'* Hotword model: offline_inference'."\n" - .'* Shading model: offline_inference'."\n" - .'* Drop-down suggestion model: offline_inference'."\n" - .'* Word segmentation model: text'."\n" - .'* Word weight model: tf_checkpoint'."\n", - 'type' => 'string', - 'required' => true, - 'enumValueTitles' => [ - 'pop' => '', - 'offline_inference' => '', - 'tf_checkpoint' => '', - 'text' => '', - ], - 'example' => 'tf_checkpoint', - ], + 'name' => 'appId', + 'in' => 'path', + 'schema' => ['description' => 'Specifies the version number.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true, 'title' => '', 'example' => '110157886'], ], [ - 'name' => 'functionType', - 'in' => 'query', + 'name' => 'name', + 'in' => 'path', + 'schema' => ['description' => 'The name of the rough sort expression.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'title' => '', 'example' => '“test”'], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => 'The type of the feature. Valid values:'."\n" - ."\n" - .'* PAAS. This is the default value.'."\n" - .'* SAAS.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'PAAS', + 'type' => 'object', + 'properties' => [ + 'requestId' => ['description' => 'The request ID.', 'type' => 'string', 'title' => '', 'example' => 'E676FAB6-A0AC-64D9-F9D7-D0D33C930CFF'], + 'result' => [ + 'description' => 'The details of the rough sort expression.', + 'type' => 'object', + 'properties' => [ + 'description' => ['description' => 'The description.', 'type' => 'string', 'title' => '', 'example' => '""'], + 'active' => ['description' => 'Indicates whether this is the default expression.', 'type' => 'boolean', 'title' => '', 'example' => 'true'], + 'name' => ['description' => 'The name of the resource.', 'type' => 'string', 'title' => '', 'example' => 'default'], + 'meta' => [ + 'description' => 'The details of the expression.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'arg' => ['description' => 'The parameters of the function in the expression. For more information, see [Rough sort](~~170007~~).', 'type' => 'string', 'title' => '', 'example' => '""'], + 'attribute' => ['description' => 'The attribute. This can be a scoring feature or a search field. For information about available scoring features, see [Rough sort](~~170007~~).', 'type' => 'string', 'title' => '', 'example' => 'static_bm25()'], + 'weight' => ['description' => 'The weight. Valid values: -100000 to 100000. The value cannot be 0.', 'type' => 'number', 'format' => 'float', 'title' => '', 'example' => '10'], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + ], + 'title' => '', + 'example' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], - [ - 'name' => 'domain', - 'in' => 'query', + '5XX' => [ 'schema' => [ - 'description' => 'The industry. By default, this parameter is left empty, which indicates General-purpose Edition.'."\n", - 'type' => 'string', - 'required' => false, - 'enumValueTitles' => [ - 'education' => '', - 'ecommerce' => '', - 'community' => '', + 'type' => 'object', + 'properties' => [ + 'code' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'requestId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'message' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'httpCode' => ['type' => 'integer', 'format' => 'int32', 'description' => '', 'title' => '', 'example' => ''], ], - 'example' => 'ecommerce', + 'description' => '', + 'title' => '', + 'example' => '', ], ], + ], + 'title' => 'RemoveFirstRank', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ [ - 'name' => 'category', - 'in' => 'query', - 'schema' => [ - 'description' => 'The category. By default, this parameter is left empty.'."\n", - 'type' => 'string', - 'required' => false, - 'enumValueTitles' => [ - 'general' => '', - 'question' => '', - 'it' => '', + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'opensearch:WriteFirstRank', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'OpenSearch', 'resourceType' => 'FirstRank', 'arn' => 'acs:opensearch:{#regionId}:{#accountId}:apps/{#AppGroupId}'], ], - 'example' => 'general', ], ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"E676FAB6-A0AC-64D9-F9D7-D0D33C930CFF\\",\\n \\"result\\": {\\n \\"description\\": \\"\\\\\\"\\\\\\"\\",\\n \\"active\\": true,\\n \\"name\\": \\"default\\",\\n \\"meta\\": [\\n {\\n \\"arg\\": \\"\\\\\\"\\\\\\"\\",\\n \\"attribute\\": \\"static_bm25()\\",\\n \\"weight\\": 10\\n }\\n ]\\n }\\n}","type":"json"}]', + 'translator' => 'manual', + ], + 'RemoveInterventionDictionary' => [ + 'summary' => 'Deletes an intervention dictionary.', + 'path' => '/v4/openapi/intervention-dictionaries/{name}', + 'methods' => ['delete'], + 'schemes' => ['http', 'https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'systemTags' => [ + 'operationType' => 'delete', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATUREopensearchNCXKUT', 'FEATUREopensearchUIICM8'], + ], + 'parameters' => [ + [ + 'name' => 'name', + 'in' => 'path', + 'schema' => ['description' => 'The name of the intervention dictionary.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => '“my_dict”'], + ], + ], 'responses' => [ 200 => [ 'schema' => [ - 'description' => 'The response body.'."\n", 'type' => 'object', 'properties' => [ - 'Status' => [ - 'description' => 'The status of the request.'."\n", - 'type' => 'string', - 'example' => 'OK', - ], - 'HttpCode' => [ - 'description' => 'The HTTP status code.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '200', - ], - 'RequestId' => [ - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => '1638157479281', - ], - 'Message' => [ - 'description' => 'The error message.'."\n", - 'type' => 'string', - 'example' => 'version not exist.', - ], - 'Code' => [ - 'description' => 'The error code.'."\n", - 'type' => 'string', - 'example' => 'Version.NotExist', - ], - 'Result' => [ - 'description' => 'The result of the request.'."\n", + 'requestId' => ['description' => 'The request ID.', 'type' => 'string', 'title' => '', 'example' => '06BBD41A-5F72-34E4-2DAF-E43B0526051D'], + 'result' => [ + 'description' => 'The details of the intervention dictionary.', 'type' => 'object', 'properties' => [ - 'FunctionName' => [ - 'description' => 'The name of the feature.'."\n", - 'type' => 'string', - 'example' => 'ctr', - ], - 'FunctionType' => [ - 'description' => 'The type of the feature. Valid values:'."\n" - ."\n" - .'* PAAS'."\n" - .'* SAAS'."\n", - 'type' => 'string', - 'example' => 'PAAS', - ], - 'ModelType' => [ - 'description' => 'The type of the model.'."\n", - 'type' => 'string', - 'example' => 'tf_checkpoint', - ], - 'VersionConfig' => [ - 'description' => 'The configuration information about the instance.'."\n", - 'type' => 'object', - 'properties' => [ - 'CreateParameters' => [ - 'description' => 'The parameters that are used to create the instance.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The parameter body.'."\n", - 'type' => 'object', - 'properties' => [ - 'Name' => [ - 'description' => 'The name of the parameter.'."\n", - 'type' => 'string', - 'example' => 'params1', - ], - 'Required' => [ - 'description' => 'Indicates whether the parameter is required.'."\n", - 'type' => 'string', - 'example' => 'true', - ], - ], - 'example' => '{ "name": "params1", "required": "true", "formItemProps": "{\\"required\\": true, \\"pattern?\\": \\"/^[a-zA-Z][a-zA-Z0-9_]{0,29}$/\\"}", "componentProps": "{\\"component\\": \\"Input\\", \\"attributes\\": {\\"defaultValue\\": \\"value1\\"}}" }', - ], - 'example' => '[ { "name": "params1", "required": "true", "formItemProps": "{\\"required\\": true, \\"pattern?\\": \\"/^[a-zA-Z][a-zA-Z0-9_]{0,29}$/\\"}", "componentProps": "{\\"component\\": \\"Input\\", \\"attributes\\": {\\"defaultValue\\": \\"value1\\"}}" } ]', - ], - 'Depends' => [ - 'description' => 'The dependencies of the instance.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The parameter body.'."\n", - 'type' => 'object', - 'properties' => [ - 'Condition' => [ - 'description' => 'The condition.'."\n", - 'type' => 'string', - 'example' => '""', - ], - 'Dependency' => [ - 'description' => 'The dependency.'."\n", - 'type' => 'string', - 'example' => '""', - ], - 'Description' => [ - 'description' => 'The description.'."\n", - 'type' => 'string', - 'example' => '""', - ], - ], - 'example' => '', - ], - 'example' => '', - ], - 'UsageParameters' => [ - 'description' => 'The parameters that are used to use the instance online.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The parameter body.'."\n", - 'type' => 'object', - 'properties' => [ - 'Name' => [ - 'description' => 'The name of the parameter.'."\n", - 'type' => 'string', - 'example' => '""', - ], - 'Required' => [ - 'description' => 'Indicates whether the parameter is required.'."\n", - 'type' => 'string', - 'example' => '""', - ], - ], - 'example' => '{}', - ], - 'example' => '[]', - ], - ], - 'example' => '', - ], - 'VersionId' => [ - 'description' => 'The ID of the version.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '101', - ], - 'VersionName' => [ - 'description' => 'The name of the version.'."\n", - 'type' => 'string', - 'example' => 'v1', - ], + 'created' => ['description' => 'The time when the intervention dictionary was created.', 'type' => 'string', 'title' => '', 'example' => '1539158313'], + 'analyzer' => ['description' => 'The custom analyzer.', 'type' => 'string', 'title' => '', 'example' => '""'], + 'updated' => ['description' => 'The time when the intervention dictionary was updated.', 'type' => 'string', 'title' => '', 'example' => '1539158313'], + 'type' => ['description' => 'The type of the dictionary. Valid values:'."\n" + ."\n" + .'- stopword: An intervention dictionary for stop words.'."\n" + ."\n" + .'- synonym: An intervention dictionary for synonyms.'."\n" + ."\n" + .'- correction: An intervention dictionary for spelling correction.'."\n" + ."\n" + .'- category\\_prediction: An intervention dictionary for category prediction.'."\n" + ."\n" + .'- ner: An intervention dictionary for Named Entity Recognition (NER).'."\n" + ."\n" + .'- term\\_weighting: An intervention dictionary for term weights.', 'type' => 'string', 'title' => '', 'example' => 'synonym'], + 'name' => ['description' => 'The name of the dictionary.', 'type' => 'string', 'title' => '', 'example' => 'tongyici'], ], + 'title' => '', 'example' => '', ], - 'Latency' => [ - 'description' => 'The time consumed for the request, in milliseconds.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '123', - ], ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + ], + '5XX' => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'code' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'requestId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'message' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'httpCode' => ['type' => 'integer', 'format' => 'int32', 'description' => '', 'title' => '', 'example' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + ], + ], + 'title' => 'RemoveInterventionDictionary', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'opensearch:WriteInterventionDictionary', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'OpenSearch', 'resourceType' => 'InterventionDictionary', 'arn' => 'acs:opensearch:{#regionId}:{#accountId}:intervention-dictionaries/{#InterventionDictionaryId}'], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"06BBD41A-5F72-34E4-2DAF-E43B0526051D\\",\\n \\"result\\": {\\n \\"created\\": \\"1539158313\\",\\n \\"analyzer\\": \\"\\\\\\"\\\\\\"\\",\\n \\"updated\\": \\"1539158313\\",\\n \\"type\\": \\"synonym\\",\\n \\"name\\": \\"tongyici\\"\\n }\\n}","type":"json"}]', + 'translator' => 'manual', + ], + 'RemoveQueryProcessor' => [ + 'summary' => 'Removes a query analysis rule from an OpenSearch application version.', + 'path' => '/v4/openapi/app-groups/{appGroupIdentity}/apps/{appId}/query-processors/{name}', + 'methods' => ['delete'], + 'schemes' => ['http', 'https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATUREopensearchNCXKUT', 'FEATUREopensearchUIICM8'], + ], + 'parameters' => [ + [ + 'name' => 'appGroupIdentity', + 'in' => 'path', + 'schema' => ['description' => 'The name of the application.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'title' => '', 'example' => '“my_app_group_name”'], + ], + [ + 'name' => 'appId', + 'in' => 'path', + 'schema' => ['description' => 'The version number.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true, 'title' => '', 'example' => '110157886'], + ], + [ + 'name' => 'name', + 'in' => 'path', + 'schema' => ['description' => 'The name of the rule.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'title' => '', 'example' => '“test”'], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'result' => ['description' => '\\--', 'type' => 'string', 'title' => '', 'example' => '[]'], + 'requestId' => ['description' => 'The request ID.', 'type' => 'string', 'title' => '', 'example' => '0A6EB64B-B4C8-CF02-810F-E660812972FF'], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + ], + '5XX' => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'code' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'message' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'requestId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'httpCode' => ['type' => 'integer', 'format' => 'int32', 'description' => '', 'title' => '', 'example' => ''], + ], + 'description' => '', + 'title' => '', 'example' => '', ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Status\\": \\"OK\\",\\n \\"HttpCode\\": 200,\\n \\"RequestId\\": \\"1638157479281\\",\\n \\"Message\\": \\"version not exist.\\",\\n \\"Code\\": \\"Version.NotExist\\",\\n \\"Result\\": {\\n \\"FunctionName\\": \\"ctr\\",\\n \\"FunctionType\\": \\"PAAS\\",\\n \\"ModelType\\": \\"tf_checkpoint\\",\\n \\"VersionConfig\\": {\\n \\"CreateParameters\\": [\\n {\\n \\"Name\\": \\"params1\\",\\n \\"Required\\": \\"true\\"\\n }\\n ],\\n \\"Depends\\": [\\n {\\n \\"Condition\\": \\"\\\\\\"\\\\\\"\\",\\n \\"Dependency\\": \\"\\\\\\"\\\\\\"\\",\\n \\"Description\\": \\"\\\\\\"\\\\\\"\\"\\n }\\n ],\\n \\"UsageParameters\\": [\\n {\\n \\"Name\\": \\"\\\\\\"\\\\\\"\\",\\n \\"Required\\": \\"\\\\\\"\\\\\\"\\"\\n }\\n ]\\n },\\n \\"VersionId\\": 101,\\n \\"VersionName\\": \\"v1\\"\\n },\\n \\"Latency\\": 123\\n}","type":"json"}]', - 'title' => 'GetFunctionCurrentVersion', - 'requestParamsDescription' => '### Sample requests'."\n" - ."\n" - .'`GET /v4/openapi/functions/ctr/current-version?modelType=_checkpoint&functionType=PAAS&domain=ecommerce&category=general`'."\n", - 'responseParamsDescription' => '### Sample success responses (In this example, hotword model is used.)'."\n" - ."\n" - .' {'."\n" - .' "status": "OK",'."\n" - .' "requestId": "165890826219877085621759",'."\n" - .' "latency": 0.049,'."\n" - .' "httpCode": 200,'."\n" - .' "code": "",'."\n" - .' "message": "",'."\n" - .' "result": {'."\n" - .' "versionId": 37,'."\n" - .' "versionName": "v2",'."\n" - .' "description": "",'."\n" - .' "status": "available",'."\n" - .' "functionName": "hot",'."\n" - .' "modelType": "offline_inference",'."\n" - .' "functionType": "PAAS",'."\n" - .' "versionConfig": {'."\n" - .' "createParameters": ['."\n" - .' {'."\n" - .' "name": "filter",'."\n" - .' "required": "false",'."\n" - .' "validations": "[{\\"preprocess\\": {\\"pattern\\": \\"(\\\\\\\\w+)\\\\\\\\s*(>=|<=|>|<|=|!=)\\\\\\\\s*(\\\\\\\\w+)\\", \\"type\\": \\"regex\\", \\"group\\": 1}, \\"params\\": {\\"data\\": [\\"user_id\\", \\"biz_type\\"], \\"type\\": \\"trival\\"}, \\"class\\": \\"EnumerateRule\\"}]",'."\n" - .' "value": "{\\"component\\":\\"Input\\",\\"attributes\\":{\\"defaultValue\\":\\"\\",\\"dataSource\\":\\"\\"}}",'."\n" - .' "valueSplit": ","'."\n" - .' }'."\n" - .' ],'."\n" - .' "usageParameters": ['."\n" - .' {'."\n" - .' "name": "allow_dict_id",'."\n" - .' "required": "false",'."\n" - .' "validations": "[{\\"params\\": {\\"restrictions\\": \\"type=hot_allowlist\\", \\"type\\": \\"passthrough\\", \\"dataSource\\": \\"dicts\\"}, \\"class\\": \\"EnumerateRule\\"}]",'."\n" - .' "value": "{\\"component\\":\\"Select\\",\\"attributes\\":{\\"defaultValue\\":\\"\\",\\"dataSource\\":\\"\\"}}"'."\n" - .' },'."\n" - .' {'."\n" - .' "name": "deny_dict_id",'."\n" - .' "required": "false",'."\n" - .' "validations": "[{\\"params\\": {\\"restrictions\\": \\"type=hot_denylist\\", \\"type\\": \\"passthrough\\", \\"dataSource\\": \\"dicts\\"}, \\"class\\": \\"EnumerateRule\\"}]",'."\n" - .' "value": "{\\"component\\":\\"Select\\",\\"attributes\\":{\\"defaultValue\\":\\"\\",\\"dataSource\\":\\"\\"}}"'."\n" - .' }'."\n" - .' ],'."\n" - .' "depends": ['."\n" - .' {'."\n" - .' "condition": "integrity_level >= 1",'."\n" - .' "dependency": "integrity_level",'."\n" - .' "description": "The level of the data integrity must be equal to or greater than 1."'."\n" - .' }'."\n" - .' ],'."\n" - .' "deployment": "",'."\n" - .' "dagTemplate": "opensearch_hot_train"'."\n" - .' }'."\n" - .' }'."\n" - .' }'."\n", - ], - 'GetFunctionVersion' => [ - 'summary' => 'Queries version information by version ID.', - 'path' => '/v4/openapi/functions/{functionName}/versions/{versionId}', - 'methods' => [ - 'get', + 'title' => 'RemoveQueryProcessor', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'opensearch:WriteQueryProqcessor', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'OpenSearch', 'resourceType' => 'QueryProcessor', 'arn' => 'acs:opensearch:{#regionId}:{#accountId}:apps/{#AppGroupId}'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"result\\": \\"[]\\",\\n \\"requestId\\": \\"0A6EB64B-B4C8-CF02-810F-E660812972FF\\"\\n}","type":"json"}]', + 'translator' => 'manual', + ], + 'RemoveScheduledTask' => [ + 'path' => '/v4/openapi/app-groups/{appGroupIdentity}/scheduled-tasks/{taskId}', + 'methods' => ['delete'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'produces' => [ - 'application/json', - ], - 'operationType' => 'read', + 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'get', + 'operationType' => 'delete', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATUREopensearch447AAX', 'FEATUREopensearch5OZOSP'], ], 'parameters' => [ [ - 'name' => 'functionName', + 'name' => 'appGroupIdentity', 'in' => 'path', - 'schema' => [ - 'description' => 'The name of the feature.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'ctr', - ], + 'schema' => ['description' => 'The name of the application.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'title' => '', 'example' => '“my_app_group_name”'], ], [ - 'name' => 'versionId', + 'name' => 'taskId', 'in' => 'path', - 'schema' => [ - 'description' => 'The ID of the version.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'example' => '100', - ], + 'schema' => ['description' => 'The task ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'title' => '', 'example' => '“2f12c585-5873-11ea-974a-7cd30ad3e268”'], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'description' => 'The response body.'."\n", 'type' => 'object', 'properties' => [ - 'Status' => [ - 'description' => 'The status of the request.'."\n", - 'type' => 'string', - 'example' => 'OK', - ], - 'HttpCode' => [ - 'description' => 'The HTTP status code.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '200', - ], - 'RequestId' => [ - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => '1638157479281', - ], - 'Message' => [ - 'description' => 'The error message.'."\n", - 'type' => 'string', - 'example' => 'version not exist.', - ], - 'Code' => [ - 'description' => 'The error code.'."\n", - 'type' => 'string', - 'example' => 'Version.NotExist', - ], - 'Result' => [ - 'description' => 'The result body.'."\n", - 'type' => 'object', - 'properties' => [ - 'FunctionName' => [ - 'description' => 'The name of the feature.'."\n", - 'type' => 'string', - 'example' => 'ctr', - ], - 'FunctionType' => [ - 'description' => 'The type of the feature. Valid values:'."\n" - ."\n" - .'* PAAS'."\n" - .'* SAAS'."\n", - 'type' => 'string', - 'example' => 'PAAS', - ], - 'ModelType' => [ - 'description' => 'The type of the model.'."\n", - 'type' => 'string', - 'example' => 'tf_checkpoint', - ], - 'VersionConfig' => [ - 'description' => 'The configuration information.'."\n", - 'type' => 'object', - 'properties' => [ - 'CreateParameters' => [ - 'description' => 'The parameters that are used to create the instance.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The parameter body.'."\n", - 'type' => 'object', - 'properties' => [ - 'Name' => [ - 'description' => 'The name of the parameter.'."\n", - 'type' => 'string', - 'example' => 'params1', - ], - 'Required' => [ - 'description' => 'Indicates whether the parameter is required.'."\n", - 'type' => 'string', - 'example' => 'true', - ], - ], - 'example' => '{}', - ], - 'example' => '[ { "name": "params1", "required": "true", "formItemProps": "{\\"required\\": true, \\"pattern?\\": \\"/^[a-zA-Z][a-zA-Z0-9_]{0,29}$/\\"}", "componentProps": "{\\"component\\": \\"Input\\", \\"attributes\\": {\\"defaultValue\\": \\"value1\\"}}" } ]', - ], - 'Depends' => [ - 'description' => 'The dependencies of the instance.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The parameter body.'."\n", - 'type' => 'object', - 'properties' => [ - 'Condition' => [ - 'description' => 'The condition.'."\n", - 'type' => 'string', - 'example' => '""', - ], - 'Dependency' => [ - 'description' => 'The dependency.'."\n", - 'type' => 'string', - 'example' => '""', - ], - 'Description' => [ - 'description' => 'The description.'."\n", - 'type' => 'string', - 'example' => '""', - ], - ], - 'example' => '{}', - ], - 'example' => '', - ], - 'UsageParameters' => [ - 'description' => 'The parameters that are used during online use of the instance.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The parameter body.'."\n", - 'type' => 'object', - 'properties' => [ - 'Name' => [ - 'description' => 'The name of the instance.'."\n", - 'type' => 'string', - 'example' => '""', - ], - 'Required' => [ - 'description' => 'Indicates whether the parameter is required.'."\n", - 'type' => 'string', - 'example' => '""', - ], - ], - 'example' => '{}', - ], - 'example' => '[]', - ], - ], - 'example' => '', - ], - 'VersionId' => [ - 'description' => 'The ID of the version.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '101', - ], - 'VersionName' => [ - 'description' => 'The name of the version.'."\n", - 'type' => 'string', - 'example' => 'v1', - ], - ], - 'example' => '[]', - ], - 'Latency' => [ - 'description' => 'The maximum duration for which a task can be executed.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '123', + 'requestId' => ['description' => 'The request ID.', 'type' => 'string', 'title' => '', 'example' => '0A6EB64B-B4C8-CF02-810F-E660812972FF'], + 'result' => [ + 'description' => 'The returned results.', + 'type' => 'array', + 'items' => ['description' => 'The list of results. This parameter is not returned on a successful request.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '1'], + 'title' => '', + 'example' => '', ], ], - 'example' => '{}', + 'description' => '', + 'title' => '', + 'example' => '', + ], + ], + '5XX' => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'code' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'message' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'requestId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'httpCode' => ['type' => 'integer', 'format' => 'int32', 'description' => '', 'title' => '', 'example' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Status\\": \\"OK\\",\\n \\"HttpCode\\": 200,\\n \\"RequestId\\": \\"1638157479281\\",\\n \\"Message\\": \\"version not exist.\\",\\n \\"Code\\": \\"Version.NotExist\\",\\n \\"Result\\": {\\n \\"FunctionName\\": \\"ctr\\",\\n \\"FunctionType\\": \\"PAAS\\",\\n \\"ModelType\\": \\"tf_checkpoint\\",\\n \\"VersionConfig\\": {\\n \\"CreateParameters\\": [\\n {\\n \\"Name\\": \\"params1\\",\\n \\"Required\\": \\"true\\"\\n }\\n ],\\n \\"Depends\\": [\\n {\\n \\"Condition\\": \\"\\\\\\"\\\\\\"\\",\\n \\"Dependency\\": \\"\\\\\\"\\\\\\"\\",\\n \\"Description\\": \\"\\\\\\"\\\\\\"\\"\\n }\\n ],\\n \\"UsageParameters\\": [\\n {\\n \\"Name\\": \\"\\\\\\"\\\\\\"\\",\\n \\"Required\\": \\"\\\\\\"\\\\\\"\\"\\n }\\n ]\\n },\\n \\"VersionId\\": 101,\\n \\"VersionName\\": \\"v1\\"\\n },\\n \\"Latency\\": 123\\n}","type":"json"}]', - 'title' => 'GetFunctionVersion', - 'requestParamsDescription' => '### Sample requests'."\n" - ."\n" - .'`GET /v4/openapi/functions/ctr/version/101`'."\n", - 'responseParamsDescription' => '### Sample success responses'."\n" - ."\n" - .' {'."\n" - .' "status": "OK",'."\n" - .' "requestId": "",'."\n" - .' "httpCode": 200,'."\n" - .' "code": "",'."\n" - .' "message": "",'."\n" - .' "latency": 123,'."\n" - .' "result": {'."\n" - .' "versionName": "v1",'."\n" - .' "versionId": 101,'."\n" - .' "functionName": "ctr",'."\n" - .' "modelType": "tf_checkpoint",'."\n" - .' "functionType": "PAAS",'."\n" - .' "versionConfig": {'."\n" - .' "createParameters": ['."\n" - .' {'."\n" - .' "name": "params1",'."\n" - .' "required": "true",'."\n" - .' "formItemProps": "{\\"required\\": true, \\"pattern?\\": \\"/^[a-zA-Z][a-zA-Z0-9_]{0,29}$/\\"}",'."\n" - .' "componentProps": "{\\"component\\": \\"Input\\", \\"attributes\\": {\\"defaultValue\\": \\"value1\\"}}"'."\n" - .' }'."\n" - .' ],'."\n" - .' "depends": ['."\n" - .' {'."\n" - .' "dependency": "the dependency",'."\n" - .' "condition": "the condition",'."\n" - .' "description": ""'."\n" - .' }'."\n" - .' ],'."\n" - .' "usageParameters": []'."\n" - .' }'."\n" - .' }'."\n" - .' }'."\n", - ], - 'GetFunctionDefaultInstance' => [ - 'summary' => 'Queries the algorithm instance that an application uses by default.', - 'path' => '/v4/openapi/app-groups/{appGroupIdentity}/functions/{functionName}/default-instance', - 'methods' => [ - 'get', + 'title' => 'RemoveScheduledTask', + 'summary' => 'Deletes a scheduled task from an OpenSearch application.', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'opensearch:DeleteApp', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'OpenSearch', 'resourceType' => 'ScheduledTask', 'arn' => 'acs:opensearch:{#regionId}:{#accountId}:app-groups/{#AppGroupId}'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"0A6EB64B-B4C8-CF02-810F-E660812972FF\\",\\n \\"result\\": [\\n 1\\n ]\\n}","type":"json"}]', + 'translator' => 'manual', + ], + 'RemoveSearchStrategy' => [ + 'summary' => 'Deletes a search strategy.', + 'path' => '/v4/openapi/app-groups/{appGroupIdentity}/apps/{appId}/search-strategies/{strategyName}', + 'methods' => ['delete'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'produces' => [ - 'application/json', - ], - 'operationType' => 'read', + 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'get', + 'operationType' => 'delete', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREopensearchZAE4HR', - ], + 'abilityTreeNodes' => ['FEATUREopensearchBNTDZX'], ], 'parameters' => [ [ 'name' => 'appGroupIdentity', 'in' => 'path', - 'schema' => [ - 'description' => 'The name of the application.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'my_app_group_name', - ], + 'schema' => ['description' => 'The name of the application.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'title' => '', 'example' => 'my_app_group_name'], ], [ - 'name' => 'functionName', + 'name' => 'appId', 'in' => 'path', - 'schema' => [ - 'description' => 'The name of the feature.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'ctr', - ], + 'schema' => ['description' => 'The version number.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'title' => '', 'example' => '110157886'], + ], + [ + 'name' => 'strategyName', + 'in' => 'path', + 'schema' => ['description' => 'The name of the strategy.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'title' => '', 'example' => 'default'], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'description' => 'The response body.'."\n", + 'description' => 'The response body.', 'type' => 'object', 'properties' => [ - 'Status' => [ - 'description' => 'The status of the request.'."\n", - 'type' => 'string', - 'example' => 'OK', - ], - 'HttpCode' => [ - 'description' => 'The HTTP status code.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '200', - ], - 'RequestId' => [ - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => '062BA91F-A568-5779-8A5B-9E62C9BB3DC1', - ], - 'Message' => [ - 'description' => 'The error message.'."\n", - 'type' => 'string', - 'example' => 'default instance not set.', - ], - 'Code' => [ - 'description' => 'The error code.'."\n", - 'type' => 'string', - 'example' => 'DefaultInstance.NotExist', - ], - 'Result' => [ - 'description' => 'The result of the request.'."\n", - 'type' => 'object', - 'properties' => [ - 'InstanceName' => [ - 'description' => 'The default instance name.'."\n", - 'type' => 'string', - 'example' => 'model1', - ], - ], - 'example' => '{\'Pagination\': {\'TotalCount\': 0, \'PageNumber\': 1, \'PageSize\': 10}, \'AntConsortiums\': []}', - ], - 'Latency' => [ - 'description' => 'The default running time.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '123', - ], - 'InstanceName' => [ - 'title' => '实例名称', - 'description' => 'The name of the instance.'."\n", - 'type' => 'string', - 'example' => 'sh-bp1oi31w1jn4ctdyv', - 'readOnly' => false, - ], - 'FunctionName' => [ - 'title' => '功能名称', - 'description' => 'The name of the feature.'."\n", - 'type' => 'string', - 'example' => 'cdn_waf', - 'readOnly' => true, - ], + 'requestId' => ['description' => 'The ID of the request.', 'type' => 'string', 'title' => '', 'example' => 'F5099063-6B86-F398-D843-905F9EFB683A'], + ], + 'example' => '{}', + 'title' => '', + ], + ], + '5XX' => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'code' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'message' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'requestId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'httpCode' => ['type' => 'integer', 'format' => 'int32', 'description' => '', 'title' => '', 'example' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + ], + ], + 'title' => 'RemoveSearchStrategy', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'opensearch:WriteSearchStrategy', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'OpenSearch', 'resourceType' => 'SearchStrategy', 'arn' => 'acs:opensearch:{#regionId}:{#accountId}:apps/{#AppGroupId}'], ], ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Status\\": \\"OK\\",\\n \\"HttpCode\\": 200,\\n \\"RequestId\\": \\"062BA91F-A568-5779-8A5B-9E62C9BB3DC1\\",\\n \\"Message\\": \\"default instance not set.\\",\\n \\"Code\\": \\"DefaultInstance.NotExist\\",\\n \\"Result\\": {\\n \\"InstanceName\\": \\"model1\\"\\n },\\n \\"Latency\\": 123,\\n \\"InstanceName\\": \\"sh-bp1oi31w1jn4ctdyv\\",\\n \\"FunctionName\\": \\"cdn_waf\\"\\n}","type":"json"}]', - 'title' => 'GetFunctionDefaultInstance', - 'requestParamsDescription' => '### Sample requests'."\n" - ."\n" - .'`GET /v4/openapi/app-groups/my-app/functions/pop/default-instances`'."\n", - 'responseParamsDescription' => '### Sample success responses'."\n" - ."\n" - .' {'."\n" - .' "status": "OK",'."\n" - .' "requestId": "",'."\n" - .' "httpCode": 200,'."\n" - .' "code": "",'."\n" - .' "message": "",'."\n" - .' "latency": 123,'."\n" - .' "result": {'."\n" - .' "instanceName": "pop_test"'."\n" - .' }'."\n" - .' }'."\n", + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"F5099063-6B86-F398-D843-905F9EFB683A\\"\\n}","type":"json"}]', + 'translator' => 'manual', ], - 'UpdateFunctionDefaultInstance' => [ - 'summary' => 'Sets the default algorithm instance used by the specified application. The new algorithm instance automatically overwrites the most recently set default instance. If no instance is set, the default instance is canceled.', - 'path' => '/v4/openapi/app-groups/{appGroupIdentity}/functions/{functionName}/default-instance', - 'methods' => [ - 'put', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'RemoveSecondRank' => [ + 'summary' => 'Deletes a fine sort expression from a version of an OpenSearch application.', + 'path' => '/v4/openapi/app-groups/{appGroupIdentity}/apps/{appId}/second-ranks/{name}', + 'methods' => ['delete'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'update', + 'operationType' => 'delete', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREopensearchZAE4HR', - ], + 'abilityTreeNodes' => ['FEATUREopensearchN8M8WS', 'FEATUREopensearchJUWEG4'], ], 'parameters' => [ [ - 'name' => 'Body', - 'in' => 'body', - 'style' => 'json', - 'schema' => [ - 'title' => 'body参数', - 'description' => 'The request parameters.'."\n", - 'type' => 'object', - 'properties' => [ - 'instanceName' => [ - 'title' => '实例名称', - 'description' => 'The name of the instance.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '"pop_test"', - ], - ], - 'required' => false, - 'docRequired' => true, - 'example' => '{}', - ], + 'name' => 'appGroupIdentity', + 'in' => 'path', + 'schema' => ['description' => 'The name of the application.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'title' => '', 'example' => '“my_app_group_name”'], ], [ - 'name' => 'appGroupIdentity', + 'name' => 'appId', 'in' => 'path', - 'schema' => [ - 'description' => 'The name of the application.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => '"app_group_name"', - ], + 'schema' => ['description' => 'The version number.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true, 'title' => '', 'example' => '110157886'], ], [ - 'name' => 'functionName', + 'name' => 'name', 'in' => 'path', - 'schema' => [ - 'description' => 'The name of the feature.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'pop', - ], + 'schema' => ['description' => 'The name of the fine sort expression.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'title' => '', 'example' => '“tests”'], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'description' => 'response'."\n", 'type' => 'object', 'properties' => [ - 'Status' => [ - 'description' => 'The status of the request.'."\n", - 'type' => 'string', - 'example' => 'OK', - ], - 'HttpCode' => [ - 'description' => 'The HTTP status code.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '200', - ], - 'RequestId' => [ - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => 'A4D487A9-A456-5AA5-A9C6-B7BF2889CF74', - ], - 'Message' => [ - 'description' => 'The error message.'."\n", - 'type' => 'string', - 'example' => 'success', - ], - 'Code' => [ - 'description' => 'The error code.'."\n", - 'type' => 'string', - 'example' => 'DefaultInstance.SetFail', - ], - 'Latency' => [ - 'description' => 'The time consumed for the request, in milliseconds.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '123', - ], + 'result' => ['description' => '—', 'type' => 'object', 'title' => '', 'example' => '{}'], + 'requestId' => ['description' => 'The request ID.', 'type' => 'string', 'title' => '', 'example' => '0A6EB64B-B4C8-CF02-810F-E660812972FF'], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + ], + '5XX' => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'code' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'message' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'requestId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'httpCode' => ['type' => 'integer', 'format' => 'int32', 'description' => '', 'title' => '', 'example' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Status\\": \\"OK\\",\\n \\"HttpCode\\": 200,\\n \\"RequestId\\": \\"A4D487A9-A456-5AA5-A9C6-B7BF2889CF74\\",\\n \\"Message\\": \\"success\\",\\n \\"Code\\": \\"DefaultInstance.SetFail\\",\\n \\"Latency\\": 123\\n}","type":"json"}]', - 'title' => 'UpdateFunctionDefaultInstance', - ], - 'ListFunctionTasks' => [ - 'summary' => 'Queries the training tasks. The returned results are sorted by start time in descending order.', - 'path' => '/v4/openapi/app-groups/{appGroupIdentity}/functions/{functionName}/instances/{instanceName}/tasks', - 'methods' => [ - 'get', + 'title' => 'RemoveSecondRank', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'opensearch:WriteSecondRank', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'OpenSearch', 'resourceType' => 'SecondRank', 'arn' => 'acs:opensearch:{#regionId}:{#accountId}:apps/{#AppGroupId}'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"result\\": {},\\n \\"requestId\\": \\"0A6EB64B-B4C8-CF02-810F-E660812972FF\\"\\n}","type":"json"}]', + 'translator' => 'manual', + ], + 'RemoveUserAnalyzer' => [ + 'summary' => 'Deletes a custom analyzer.', + 'path' => '/v4/openapi/user-analyzers/{name}', + 'methods' => ['delete'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'produces' => [ - 'application/json', - ], - 'operationType' => 'read', + 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'get', + 'operationType' => 'delete', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATUREopensearchUIICM8'], ], 'parameters' => [ [ - 'name' => 'appGroupIdentity', + 'name' => 'name', 'in' => 'path', + 'schema' => ['description' => 'The name of the analyzer'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '“kevin_test”', 'title' => ''], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => 'The name of the application.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'app_group_name', + 'type' => 'object', + 'properties' => [ + 'result' => ['description' => 'The result set. This parameter is not returned if the request is successful.'."\n", 'type' => 'object', 'example' => '[]', 'title' => ''], + 'requestId' => ['description' => 'The request ID.'."\n", 'type' => 'string', 'example' => 'D77D0DAF-790D-F5F5-A9C0-133738165014', 'title' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], - [ - 'name' => 'functionName', - 'in' => 'path', + '5XX' => [ 'schema' => [ - 'description' => 'The name of the feature.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'ctr', + 'type' => 'object', + 'properties' => [ + 'code' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'message' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'requestId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'httpCode' => ['type' => 'integer', 'format' => 'int32', 'description' => '', 'title' => '', 'example' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + ], + ], + 'title' => 'RemoveUserAnalyzer', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'opensearch:DeleteUserAnalyzer', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'OpenSearch', 'resourceType' => 'Analyzer', 'arn' => 'acs:opensearch:{#regionId}:{#accountId}:user-analyzers/{#AnalyzerId}'], + ], ], ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"result\\": [],\\n \\"requestId\\": \\"D77D0DAF-790D-F5F5-A9C0-133738165014\\"\\n}","errorExample":""},{"type":"xml","example":"D77D0DAF-790D-F5F5-A9C0-133738165014","errorExample":""}]', + ], + 'RenewAppGroup' => [ + 'summary' => 'Renews an application. This API operation is unavailable. To renew an application, use the OpenSearch console.', + 'path' => '/v4/openapi/app-groups/{appGroupIdentity}/actions/renew', + 'methods' => ['post'], + 'schemes' => ['http', 'https'], + 'security' => [ [ - 'name' => 'instanceName', + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'paid', + 'abilityTreeNodes' => ['FEATUREopensearch447AAX'], + ], + 'parameters' => [ + [ + 'name' => 'appGroupIdentity', 'in' => 'path', - 'schema' => [ - 'description' => 'The name of the instance.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'test_model_2', - ], + 'schema' => ['description' => 'The name of the application.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'title' => '', 'example' => 'my_app'], ], [ - 'name' => 'status', + 'name' => 'clientToken', 'in' => 'query', - 'schema' => [ - 'description' => 'The status of the task. Valid values:'."\n" - ."\n" - .'* success'."\n" - .'* failed'."\n" - .'* running'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'success', - ], + 'schema' => ['description' => 'The client token that is used to ensure the idempotence of the request.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => '74db41d8cd3c784209093aa76afbe89e'], ], [ - 'name' => 'startTime', - 'in' => 'query', + 'name' => 'body', + 'in' => 'body', + 'schema' => ['description' => 'The renewal request body.', 'required' => false, '$ref' => '#/components/schemas/PrepayOrderInfo', 'title' => '', 'example' => ''], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => 'The start time is greater than the specified time. Specify the time in the UNIX timestamp format. Unit: milliseconds.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '1582214400', + 'description' => 'The response body.', + 'type' => 'object', + 'properties' => [ + 'requestId' => ['description' => 'The request ID.', 'type' => 'string', 'title' => '', 'example' => 'D77D0DAF-790D-F5F5-A9C0-133738165014'], + 'result' => ['description' => 'Indicates whether the application was renewed.', 'type' => 'boolean', 'title' => '', 'example' => 'true'], + ], + 'example' => '{}', + 'title' => '', ], ], - [ - 'name' => 'endTime', - 'in' => 'query', + '5XX' => [ 'schema' => [ - 'description' => 'The end time is less than the specified time. Specify the time in the UNIX timestamp format. Unit: milliseconds.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '1582646399', + 'type' => 'object', + 'properties' => [ + 'code' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'message' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'requestId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'httpCode' => ['type' => 'integer', 'format' => 'int32', 'description' => '', 'title' => '', 'example' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], + ], + 'title' => 'RenewAppGroup', + 'requestParamsDescription' => '**Optional parameters**'."\n" + ."\n" + .'| Parameter | Type | Description |'."\n" + .'| ------------ | ------- | ------------------------------------------------------------------------------------------------------------------- |'."\n" + .'| duration | Integer | The renewal duration. The default value is 1.
Valid values:
\\- 1 to 2 (unit: year)
\\- 1 to 9 (unit: month) |'."\n" + .'| pricingCycle | String | The unit of the renewal duration.
Valid values:
\\- Year
\\- Month |'."\n" + .'| autoRenew | boolean | Specifies whether to enable auto-renewal. The default value is false.
Valid values:
\\- false
\\- true |', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ [ - 'name' => 'pageNumber', - 'in' => 'query', - 'schema' => [ - 'description' => 'The number of the page to return. Default value: 1.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'opensearch:UpdateApp', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'OpenSearch', 'resourceType' => 'AppGroup', 'arn' => 'acs:opensearch:{#regionId}:{#accountId}:apps/{#AppGroupId}'], + ], ], ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"D77D0DAF-790D-F5F5-A9C0-133738165014\\",\\n \\"result\\": true\\n}","type":"json"}]', + 'translator' => 'manual', + ], + 'ReplaceAppGroupCommodityCode' => [ + 'path' => '/v4/openapi/app-groups/{appGroupIdentity}/actions/to-instance-typed', + 'methods' => ['post'], + 'schemes' => ['http', 'https'], + 'security' => [ [ - 'name' => 'pageSize', - 'in' => 'query', - 'schema' => [ - 'description' => 'The number of entries to return on each page. Default value: 1.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '10', - ], + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'abilityTreeCode' => '55260', + 'abilityTreeNodes' => ['FEATUREopensearch3UFA61'], + ], + 'parameters' => [ + [ + 'name' => 'appGroupIdentity', + 'in' => 'path', + 'schema' => ['description' => 'The name of the application'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'my_app', 'title' => ''], ], ], 'responses' => [ @@ -18277,337 +15982,228 @@ 'description' => 'The response body.'."\n", 'type' => 'object', 'properties' => [ - 'Status' => [ - 'description' => 'The status of the request.'."\n", - 'type' => 'string', - 'example' => '200', - ], - 'HttpCode' => [ - 'description' => 'The HTTP status code.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '200', - ], - 'TotalCount' => [ - 'description' => 'The total number of records that meet the requirements.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '2', - ], - 'RequestId' => [ - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => '1638157479281', - ], - 'Message' => [ - 'description' => 'The error message.'."\n", - 'type' => 'string', - 'example' => 'fail', - ], - 'Code' => [ - 'description' => 'The error code.'."\n", - 'type' => 'string', - 'example' => '200', - ], - 'Result' => [ + 'requestId' => ['description' => 'The request ID.'."\n", 'type' => 'string', 'example' => 'AC5F78BA-66B9-545B-9CF1-8F542E682E1F', 'title' => ''], + 'result' => [ 'description' => 'The returned result.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The result body.'."\n", - 'type' => 'object', - 'properties' => [ - 'EndTime' => [ - 'description' => 'The timestamp that indicates the end time. Unit: milliseconds. 0 indicates that the task has not ended.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '100010', - ], - 'ExtendInfo' => [ - 'description' => 'The value is a JSON string. It includes model evaluation information and training error information.'."\n", - 'type' => 'string', - 'example' => '{\\"recall\\":91,\\"errors\\":[]}', - ], - 'FunctionName' => [ - 'description' => 'The name of the feature.'."\n", - 'type' => 'string', - 'example' => 'ctr', - ], - 'Progress' => [ - 'description' => 'The progress. 90 indicates 90%.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '90', - ], - 'RunId' => [ - 'description' => 'The ID of the task.'."\n", - 'type' => 'string', - 'example' => 'trigger__2021-03-05T12:18:41', - ], - 'StartTime' => [ - 'description' => 'The timestamp that indicates the start time. Unit: milliseconds.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '100010', - ], - 'Status' => [ - 'description' => 'The status of the task. Valid values:'."\n" - ."\n" - .'* success'."\n" - .'* failed'."\n" - .'* running'."\n", - 'type' => 'string', - 'example' => 'success', - ], - 'Generation' => [ - 'description' => 'The number of iterations.'."\n", - 'type' => 'string', - 'example' => '2', + 'type' => 'object', + 'properties' => [ + 'created' => ['description' => 'The timestamp when the application was created.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1588054131', 'title' => ''], + 'currentVersion' => ['description' => 'The ID of the current online version.'."\n", 'type' => 'string', 'example' => '100302903', 'title' => ''], + 'pendingSecondRankAlgoDeploymentId' => ['description' => 'The ID of the fine sort expression that is being created.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '0', 'title' => ''], + 'type' => ['description' => 'The type of the application.'."\n", 'type' => 'string', 'example' => '-', 'title' => ''], + 'chargingWay' => ['description' => 'The billing type. Valid values:'."\n" + ."\n" + .'* 1: computing resources.'."\n" + .'* 2: queries per second (QPS).'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'lockMode' => ['description' => 'The lock state. Valid values:'."\n" + ."\n" + .'* Unlock: The instance is unlocked.'."\n" + .'* LockByExpiration: The instance is automatically locked after it expires.'."\n" + .'* ManualLock: The instance is manually locked.'."\n", 'type' => 'string', 'example' => 'Unlock', 'title' => ''], + 'status' => ['description' => 'The status of the application.'."\n", 'type' => 'string', 'example' => 'normal', 'title' => ''], + 'updated' => ['description' => 'The timestamp when the application was updated.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1581065904', 'title' => ''], + 'chargeType' => ['description' => 'The billing method. Valid values:'."\n" + ."\n" + .'* POSTPAY: pay-as-you-go.'."\n" + .'* PREPAY: subscription.'."\n", 'type' => 'string', 'example' => 'POSTPAY', 'title' => ''], + 'id' => ['description' => 'The application ID.'."\n", 'type' => 'string', 'example' => '-', 'title' => ''], + 'hasPendingQuotaReviewTask' => ['description' => 'The approval state of the quotas. Valid values:'."\n" + ."\n" + .'* 0: The approval status is normal.'."\n" + .'* 1: The quotas are being approved.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '0', 'title' => ''], + 'projectId' => ['description' => 'The name of the A/B test group.'."\n", 'type' => 'string', 'example' => '-', 'title' => ''], + 'secondRankAlgoDeploymentId' => ['description' => 'The ID of the fine sort expression.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '0', 'title' => ''], + 'commodityCode' => ['description' => 'The code of the commodity.'."\n", 'type' => 'string', 'example' => 'opensearch', 'title' => ''], + 'switchedTime' => ['description' => 'The timestamp when the current online version was published.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1590486386', 'title' => ''], + 'expireOn' => ['description' => 'The expiration time.'."\n", 'type' => 'string', 'example' => '-', 'title' => ''], + 'description' => ['description' => 'The description of the application.'."\n", 'type' => 'string', 'example' => '""', 'title' => ''], + 'firstRankAlgoDeploymentId' => ['description' => 'The ID of the rough sort expression.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '0', 'title' => ''], + 'lockedByExpiration' => ['description' => 'Indicates whether the instance is automatically locked after it expires. Valid values:'."\n" + ."\n" + .'* 0: The instance is not automatically locked after it expires.'."\n" + .'* 1: The instance is automatically locked after it expires.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '0', 'title' => ''], + 'produced' => ['description' => 'Indicates whether the order is produced.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '0', 'title' => ''], + 'name' => ['description' => 'The name of the order.'."\n", 'type' => 'string', 'example' => '-', 'title' => ''], + 'processingOrderId' => ['description' => 'The ID of the order that is in progress.'."\n", 'type' => 'string', 'example' => '-', 'title' => ''], + 'instanceId' => ['description' => 'The instance ID.'."\n", 'type' => 'string', 'example' => '-', 'title' => ''], + 'versions' => [ + 'description' => 'The versions.'."\n", + 'type' => 'array', + 'items' => ['description' => 'The version.'."\n", 'type' => 'string', 'example' => '-', 'title' => ''], + 'title' => '', + 'example' => '', + ], + 'quota' => [ + 'description' => 'The configuration information.'."\n", + 'type' => 'object', + 'properties' => [ + 'spec' => ['description' => 'The specifications configured.'."\n", 'type' => 'string', 'example' => '-', 'title' => ''], + 'docSize' => ['description' => 'The storage capacity.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'computeResource' => ['description' => 'The number of computing resources configured.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '20', 'title' => ''], ], + 'title' => '', + 'example' => '', ], - 'example' => '{ "functionName": "ctr", "progress": 100, "status": "success", "startTime": 100010, "endTime": 200020, "extendInfo": "{\\"recall\\":91,\\"errors\\":[]}", "runId": "trigger__2021-03-05T12:18:41" }', ], - 'example' => '[ { "functionName": "ctr", "progress": 100, "status": "success", "startTime": 100010, "endTime": 200020, "extendInfo": "{\\"recall\\":91,\\"errors\\":[]}", "runId": "trigger__2021-03-05T12:18:41" } ]', - ], - 'Latency' => [ - 'description' => 'The time consumed for the request, in milliseconds.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '123', + 'example' => '{}', + 'title' => '', ], ], - 'example' => '{ "status": "OK", "requestId": "", "httpCode": 200, "code": "", "message": "", "latency": 123, "totalCount": 1, "result": [ { "functionName": "ctr", "progress": 100, "status": "success", "startTime": 100010, "endTime": 200020, "extendInfo": "{\\"recall\\":91,\\"errors\\":[]}", "runId": "trigger__2021-03-05T12:18:41" } ] }', + 'title' => '', + 'example' => '', + ], + ], + '5XX' => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'code' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'httpCode' => ['type' => 'integer', 'format' => 'int32', 'description' => '', 'title' => '', 'example' => ''], + 'requestId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'message' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Status\\": \\"200\\",\\n \\"HttpCode\\": 200,\\n \\"TotalCount\\": 2,\\n \\"RequestId\\": \\"1638157479281\\",\\n \\"Message\\": \\"fail\\",\\n \\"Code\\": \\"200\\",\\n \\"Result\\": [\\n {\\n \\"EndTime\\": 100010,\\n \\"ExtendInfo\\": \\"{\\\\\\\\\\\\\\"recall\\\\\\\\\\\\\\":91,\\\\\\\\\\\\\\"errors\\\\\\\\\\\\\\":[]}\\",\\n \\"FunctionName\\": \\"ctr\\",\\n \\"Progress\\": 90,\\n \\"RunId\\": \\"trigger__2021-03-05T12:18:41\\",\\n \\"StartTime\\": 100010,\\n \\"Status\\": \\"success\\",\\n \\"Generation\\": \\"2\\"\\n }\\n ],\\n \\"Latency\\": 123\\n}","type":"json"}]', - 'title' => 'ListFunctionTasks', - 'requestParamsDescription' => '### Sample requests'."\n" - ."\n" - .'`GET /v4/openapi/app-groups/my-app/functions/ctr/instances/ctr_test/tasks`'."\n", - 'responseParamsDescription' => '### Sample success responses'."\n" - ."\n" - .' {'."\n" - .' "status": "OK",'."\n" - .' "requestId": "",'."\n" - .' "httpCode": 200,'."\n" - .' "code": "",'."\n" - .' "message": "",'."\n" - .' "latency": 123,'."\n" - .' "totalCount": 1,'."\n" - .' "result": ['."\n" - .' {'."\n" - .' "functionName": "ctr",'."\n" - .' "progress": 100,'."\n" - .' "status": "success",'."\n" - .' "startTime": 100010,'."\n" - .' "endTime": 200020,'."\n" - .' "extendInfo": "{\\"recall\\":91,\\"errors\\":[]}",'."\n" - .' "runId": "trigger__2021-03-05T12:18:41",'."\n" - .' "generation": "3"'."\n" - .' }'."\n" - .' ]'."\n" - .' }'."\n", - ], - 'GetFunctionTask' => [ - 'summary' => 'Queries the details of a training task.', - 'path' => '/v4/openapi/app-groups/{appGroupIdentity}/functions/{functionName}/instances/{instanceName}/tasks/{generation}', - 'methods' => [ - 'get', + 'title' => 'ReplaceAppGroupCommodityCode', + 'summary' => 'Converts a service-based application to an instance-based application.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'opensearch:UpdateApp', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'OpenSearch', 'resourceType' => 'AppGroup', 'arn' => 'acs:opensearch:{#regionId}:{#accountId}:apps/{#appGroupIdentity}'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"AC5F78BA-66B9-545B-9CF1-8F542E682E1F\\",\\n \\"result\\": {\\n \\"created\\": 1588054131,\\n \\"currentVersion\\": \\"100302903\\",\\n \\"pendingSecondRankAlgoDeploymentId\\": 0,\\n \\"type\\": \\"-\\",\\n \\"chargingWay\\": 1,\\n \\"lockMode\\": \\"Unlock\\",\\n \\"status\\": \\"normal\\",\\n \\"updated\\": 1581065904,\\n \\"chargeType\\": \\"POSTPAY\\",\\n \\"id\\": \\"-\\",\\n \\"hasPendingQuotaReviewTask\\": 0,\\n \\"projectId\\": \\"-\\",\\n \\"secondRankAlgoDeploymentId\\": 0,\\n \\"commodityCode\\": \\"opensearch\\",\\n \\"switchedTime\\": 1590486386,\\n \\"expireOn\\": \\"-\\",\\n \\"description\\": \\"\\\\\\"\\\\\\"\\",\\n \\"firstRankAlgoDeploymentId\\": 0,\\n \\"lockedByExpiration\\": 0,\\n \\"produced\\": 0,\\n \\"name\\": \\"-\\",\\n \\"processingOrderId\\": \\"-\\",\\n \\"instanceId\\": \\"-\\",\\n \\"versions\\": [\\n \\"-\\"\\n ],\\n \\"quota\\": {\\n \\"spec\\": \\"-\\",\\n \\"docSize\\": 1,\\n \\"computeResource\\": 20\\n }\\n }\\n}","type":"json"}]', + ], + 'SaveSortScriptFile' => [ + 'summary' => 'Uploads a sort script.', + 'path' => '/v4/openapi/app-groups/{appGroupIdentity}/apps/{appVersionId}/sort-scripts/{scriptName}/files/src/{fileName}', + 'methods' => ['put'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'produces' => [ - 'application/json', - ], - 'operationType' => 'read', + 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'get', + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATUREopensearchN8M8WS'], ], 'parameters' => [ [ 'name' => 'appGroupIdentity', 'in' => 'path', - 'schema' => [ - 'title' => '应用名称', - 'description' => 'The name of the application.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'my_app_group_name', - ], + 'schema' => ['description' => 'The name or ID of the application.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '\'\'110123411\'\'', 'title' => ''], ], [ - 'name' => 'functionName', + 'name' => 'scriptName', 'in' => 'path', - 'schema' => [ - 'title' => '功能名称', - 'description' => 'The name of the feature.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'ctr', - ], + 'schema' => ['description' => 'The name of the script whose content you want to update.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '\'\'test1\'\'', 'title' => ''], ], [ - 'name' => 'instanceName', + 'name' => 'appVersionId', 'in' => 'path', - 'schema' => [ - 'title' => '实例名称', - 'description' => 'The name of the instance.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'test_model_2', - ], + 'schema' => ['description' => 'The version number of the application.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '\'\'110123111\'\'', 'title' => ''], ], [ - 'name' => 'generation', + 'name' => 'fileName', 'in' => 'path', + 'schema' => ['description' => 'The file name.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '\'\'file01\'\'', 'title' => ''], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', 'schema' => [ - 'title' => '迭代次数', - 'description' => 'The number of iterations.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => '1', + 'description' => 'The information about the script content.'."\n", + 'type' => 'object', + 'properties' => [ + 'content' => ['description' => 'The script content that is encoded in the Base64 format.'."\n", 'type' => 'string', 'required' => false, 'example' => '4769#0: *28194492991 a client request body is buffered to a temporary file /usr/local/webserver/openresty/nginx/client_body_temp/0000624474,', 'title' => ''], + 'version' => ['description' => 'The version number of the script content.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '2022-12-01', 'title' => ''], + ], + 'required' => false, + 'title' => '', + 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'description' => 'The schema of the response.'."\n", + 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ - 'Status' => [ - 'description' => 'The status of the request.'."\n", - 'type' => 'string', - 'example' => 'OK', - ], - 'HttpCode' => [ - 'description' => 'The HTTP status code.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '200', - ], - 'RequestId' => [ - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => 'A4D487A9-A456-5AA5-A9C6-B7BF2889CF74', - ], - 'Message' => [ - 'description' => 'The error message.'."\n", - 'type' => 'string', - 'example' => 'operation success', - ], - 'Code' => [ - 'description' => 'The error code.'."\n", - 'type' => 'string', - 'example' => 'Task.NotExist', - ], - 'Result' => [ - 'description' => 'The result of the request.'."\n", - 'type' => 'object', - 'properties' => [ - 'EndTime' => [ - 'description' => 'The timestamp that indicates the end time of the task. Unit: milliseconds.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1647213406267', - ], - 'ExtendInfo' => [ - 'description' => 'The extended information, which is a JSON string.'."\n", - 'type' => 'string', - 'example' => '{\\"recall\\":91,\\"errors\\":[]}', - ], - 'FunctionName' => [ - 'description' => 'The name of the feature.'."\n", - 'type' => 'string', - 'example' => 'ctr', - ], - 'Generation' => [ - 'description' => 'The number of iterations.'."\n", - 'type' => 'string', - 'example' => '1', - ], - 'Progress' => [ - 'description' => 'The progress. 90 indicates 90%.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '90', - ], - 'RunId' => [ - 'description' => 'The ID of the task.'."\n", - 'type' => 'string', - 'example' => 'trigger__2021-03-05T12:18:41', - ], - 'StartTime' => [ - 'description' => 'The timestamp that indicates the start time of the task. Unit: milliseconds.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1647212220000', - ], - 'Status' => [ - 'description' => 'The status of the task. Valid values:'."\n" - ."\n" - .'* success'."\n" - .'* failed'."\n" - .'* running'."\n", - 'type' => 'string', - 'example' => 'success', - ], - ], - ], - 'Latency' => [ - 'description' => 'The time consumed for the request, in milliseconds.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '123', - ], + 'requestId' => ['description' => 'The request ID.'."\n", 'type' => 'string', 'example' => 'ABCDEFGH', 'title' => ''], + ], + 'example' => '{}', + 'title' => '', + ], + ], + '5XX' => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'code' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'message' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'requestId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'httpCode' => ['type' => 'integer', 'format' => 'int32', 'description' => '', 'title' => '', 'example' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Status\\": \\"OK\\",\\n \\"HttpCode\\": 200,\\n \\"RequestId\\": \\"A4D487A9-A456-5AA5-A9C6-B7BF2889CF74\\",\\n \\"Message\\": \\"operation success\\",\\n \\"Code\\": \\"Task.NotExist\\",\\n \\"Result\\": {\\n \\"EndTime\\": 1647213406267,\\n \\"ExtendInfo\\": \\"{\\\\\\\\\\\\\\"recall\\\\\\\\\\\\\\":91,\\\\\\\\\\\\\\"errors\\\\\\\\\\\\\\":[]}\\",\\n \\"FunctionName\\": \\"ctr\\",\\n \\"Generation\\": \\"1\\",\\n \\"Progress\\": 90,\\n \\"RunId\\": \\"trigger__2021-03-05T12:18:41\\",\\n \\"StartTime\\": 1647212220000,\\n \\"Status\\": \\"success\\"\\n },\\n \\"Latency\\": 123\\n}","type":"json"}]', - 'title' => 'GetFunctionTask', - 'requestParamsDescription' => '### Sample requests'."\n" - ."\n" - .'`GET /v4/openapi/app-groups/my-app/functions/ctr/instances/ctr_test/tasks/3`'."\n", - 'responseParamsDescription' => '### Sample success responses'."\n" + 'title' => 'SaveSortScriptFile', + 'requestParamsDescription' => '## scriptContent'."\n" ."\n" - .' {'."\n" - .' "status": "OK",'."\n" - .' "requestId": "",'."\n" - .' "httpCode": 200,'."\n" - .' "code": "",'."\n" - .' "message": "",'."\n" - .' "latency": 123,'."\n" - .' "result": {'."\n" - .' "functionName": "ctr",'."\n" - .' "progress": 100,'."\n" - .' "status": "success",'."\n" - .' "startTime": 100010,'."\n" - .' "endTime": 200020,'."\n" - .' "extendInfo": "{\\"recall\\":91,\\"errors\\":[]}",'."\n" - .' "runId": "trigger__2021-03-05T12:18:41",'."\n" - .' "generation": "3"'."\n" - .' }'."\n" - .' }'."\n", - ], - 'DeleteFunctionTask' => [ - 'summary' => 'Deletes a training task. The training task in progress cannot be deleted.', - 'path' => '/v4/openapi/app-groups/{appGroupIdentity}/functions/{functionName}/instances/{instanceName}/tasks/{generation}', - 'methods' => [ - 'delete', + .'|Parameter|Type|Required|Description|'."\n" + .'|---|---|---|---|'."\n" + .'|content|String|Yes|The script content that is encoded in the Base64 format.|'."\n" + .'|version|Integer|No|The version number of the script content. This version number is used to ensure that the script content is updated in order when the script content is concurrently updated by multiple users. Default value: the current time.|', + 'extraInfo' => ' ', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'opensearch:WriteSortScript', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'OpenSearch', 'resourceType' => 'App', 'arn' => 'acs:opensearch:{#regionId}:{#accountId}:apps/{#AppGroupId}'], + ], + ], + ], ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"requestId\\": \\"ABCDEFGH\\"\\n}","errorExample":""},{"type":"xml","example":"ABCDEFGH","errorExample":""}]', + ], + 'StartSlowQueryAnalyzer' => [ + 'summary' => 'Starts a slow query analysis task.', + 'path' => '/v4/openapi/app-groups/{appGroupIdentity}/optimizers/slow-query/actions/run', + 'methods' => ['post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -18616,1579 +16212,934 @@ 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'delete', + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATUREopensearchA0YLTY', 'FEATUREopensearch9TYTPZ'], ], 'parameters' => [ [ 'name' => 'appGroupIdentity', 'in' => 'path', + 'schema' => ['description' => 'The name of the application.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'title' => '', 'example' => '“my_app_group_name”'], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'title' => '应用名称', - 'description' => 'The name of the application.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'my_app_group_name', + 'type' => 'object', + 'properties' => [ + 'result' => ['description' => '\\-', 'type' => 'object', 'title' => '', 'example' => '{}'], + 'requestId' => ['description' => 'The ID of the request.', 'type' => 'string', 'title' => '', 'example' => 'D77D0DAF-790D-F5F5-A9C0-133738165014'], + ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], - [ - 'name' => 'functionName', - 'in' => 'path', + '5XX' => [ 'schema' => [ - 'title' => '功能名称', - 'description' => 'The name of the feature.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'ctr', + 'type' => 'object', + 'properties' => [ + 'code' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'message' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'requestId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'httpCode' => ['type' => 'integer', 'format' => 'int32', 'description' => '', 'title' => '', 'example' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], + ], + 'title' => 'StartSlowQueryAnalyzer', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ [ - 'name' => 'instanceName', - 'in' => 'path', - 'schema' => [ - 'title' => '实例名称', - 'description' => 'The name of the instance.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'ctr_test', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'opensearch:StartSlowQueryAnalyzer', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'OpenSearch', 'resourceType' => 'AppGroup', 'arn' => 'acs:opensearch:{#regionId}:{#accountId}:apps/{#AppGroupId}'], + ], ], ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"result\\": {},\\n \\"requestId\\": \\"D77D0DAF-790D-F5F5-A9C0-133738165014\\"\\n}","type":"json"}]', + 'translator' => 'manual', + ], + 'TagResources' => [ + 'path' => '/v4/openapi/resource-tags', + 'methods' => ['post'], + 'schemes' => ['http', 'https'], + 'security' => [ [ - 'name' => 'generation', - 'in' => 'path', - 'schema' => [ - 'title' => '迭代次数', - 'description' => 'The number of iterations.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => '1', - ], + 'AK' => [], ], ], - 'responses' => [ - 200 => [ + 'produces' => ['application/json'], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'abilityTreeCode' => '152937', + 'abilityTreeNodes' => ['FEATUREopensearch447AAX'], + ], + 'parameters' => [ + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', 'schema' => [ - 'description' => 'The schema of the response.'."\n", + 'description' => 'The request parameters.', 'type' => 'object', 'properties' => [ - 'Status' => [ - 'description' => 'The status of the request.'."\n", - 'type' => 'string', - 'example' => 'OK', - ], - 'HttpCode' => [ - 'description' => 'The HTTP status code.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '200', - ], - 'RequestId' => [ - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => '"1081EB05-473C-5BF4-95BE-6D7CAD5E2213"', - ], - 'Message' => [ - 'description' => 'The error message.'."\n", - 'type' => 'string', - 'example' => 'operation success', - ], - 'Code' => [ - 'description' => 'The error code. If no error occurs, this parameter is left empty.'."\n", - 'type' => 'string', - 'example' => 'Task.UnableDelete', + 'resourceType' => ['title' => '', 'description' => 'The resource type.', 'type' => 'string', 'required' => true, 'example' => 'ProductVersion'], + 'resourceId' => [ + 'title' => '', + 'description' => 'The IDs of the resources. You can specify up to 50 resource IDs.', + 'type' => 'array', + 'items' => ['description' => 'The ID of the resource.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => '68968'], + 'required' => true, + 'example' => '', ], - 'Latency' => [ - 'description' => 'The time consumed for the request, in milliseconds.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '123', + 'tag' => [ + 'title' => '', + 'description' => 'The tags to add to the resources. You can add up to 20 tags.', + 'type' => 'array', + 'items' => [ + 'description' => 'The internal English representation of the entity type.', + 'type' => 'object', + 'properties' => [ + 'key' => ['title' => '', 'description' => 'The tag key.', 'type' => 'string', 'required' => false, 'example' => 'cloud_manage'], + 'value' => ['title' => '', 'description' => 'The tag value.', 'type' => 'string', 'required' => false, 'example' => '31261301'], + ], + 'required' => false, + 'title' => '', + 'example' => '', + ], + 'required' => true, + 'example' => '', ], ], + 'required' => false, + 'title' => '', + 'example' => '', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => 'The response body.', + 'type' => 'object', + 'properties' => [ + 'requestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => 'ABCDEFGH'], + ], + 'title' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Status\\": \\"OK\\",\\n \\"HttpCode\\": 200,\\n \\"RequestId\\": \\"\\\\\\"1081EB05-473C-5BF4-95BE-6D7CAD5E2213\\\\\\"\\",\\n \\"Message\\": \\"operation success\\",\\n \\"Code\\": \\"Task.UnableDelete\\",\\n \\"Latency\\": 123\\n}","type":"json"}]', - 'title' => 'DeleteFunctionTask', - 'responseParamsDescription' => '### Sample success responses'."\n" - ."\n" - .' {'."\n" - .' "status": "OK",'."\n" - .' "requestId": "",'."\n" - .' "httpCode": 200,'."\n" - .' "code": "",'."\n" - .' "message": "",'."\n" - .' "latency": 123,'."\n" - .' "result": {}'."\n" - .' }'."\n", - ], - 'CreateFunctionTask' => [ - 'summary' => 'Starts a training task for an algorithm instance.', - 'path' => '/v4/openapi/app-groups/{appGroupIdentity}/functions/{functionName}/instances/{instanceName}/tasks', - 'methods' => [ - 'post', + 'title' => 'TagResources', + 'summary' => 'Adds tags to resources.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'opensearch:TagResources', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'OpenSearch', 'resourceType' => 'AppGroup', 'arn' => 'acs:opensearch:{#regionId}:{#accountId}:instance/{#AppGroupId}'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"ABCDEFGH\\"\\n}","type":"json"}]', + 'translator' => 'manual', + ], + 'UnbindESUserAnalyzer' => [ + 'summary' => 'Detaches a custom analyzer from an Elasticsearch instance.', + 'path' => '/v4/openapi/app-groups/{appGroupIdentity}/es/{esInstanceId}/actions/unbind-analyzer', + 'methods' => ['post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'produces' => [ - 'application/json', - ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'create', + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATUREopensearch447AAX'], ], 'parameters' => [ [ 'name' => 'appGroupIdentity', 'in' => 'path', - 'schema' => [ - 'description' => 'The name of the application.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'app_group_name', - ], + 'schema' => ['description' => 'The name of the application.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'title' => '', 'example' => 'my_app_group_name'], ], [ - 'name' => 'functionName', + 'name' => 'esInstanceId', 'in' => 'path', - 'schema' => [ - 'description' => 'The name of the feature.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'ctr', - ], + 'schema' => ['description' => 'The ID of the instance.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'title' => '', 'example' => 'es-cn-zvp2ff3iq000myzv7'], ], [ - 'name' => 'instanceName', - 'in' => 'path', - 'schema' => [ - 'description' => 'The name of the instance.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'ctr_test', - ], + 'name' => 'body', + 'in' => 'body', + 'schema' => ['description' => 'The request body.', 'type' => 'any', 'required' => false, 'title' => '', 'example' => '{'."\n" + .' "name": "kevintest-analyzer"'."\n" + .'}'], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'description' => 'The response body.'."\n", + 'description' => 'The response body.', 'type' => 'object', 'properties' => [ - 'Status' => [ - 'description' => 'The status of the request.'."\n", - 'type' => 'string', - 'example' => 'OK', - ], - 'HttpCode' => [ - 'description' => 'The HTTP status code.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '200', - ], - 'RequestId' => [ - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => '1638157990724', - ], - 'Message' => [ - 'description' => 'The error message.'."\n", - 'type' => 'string', - 'example' => 'success', - ], - 'Code' => [ - 'description' => 'The error code.'."\n", - 'type' => 'string', - 'example' => 'Task.IsRunning', - ], - 'Latency' => [ - 'description' => 'The time consumed for the request, in milliseconds.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '123', - ], + 'result' => ['description' => 'The custom analyzer.', 'type' => 'object', 'title' => '', 'example' => '[]'], + 'requestId' => ['description' => 'The ID of the request.', 'type' => 'string', 'title' => '', 'example' => '0A6EB64B-B4C8-CF02-810F-E660812972FF'], ], - 'example' => '{ "status" : "OK", "requestId" : "", "httpCode": 200, "code": "", "message": "", "latency" : 123, "result" : {}, }', + 'example' => '{}', + 'title' => '', + ], + ], + '5XX' => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'code' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'message' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'requestId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'httpCode' => ['type' => 'integer', 'format' => 'int32', 'description' => '', 'title' => '', 'example' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Status\\": \\"OK\\",\\n \\"HttpCode\\": 200,\\n \\"RequestId\\": \\"1638157990724\\",\\n \\"Message\\": \\"success\\",\\n \\"Code\\": \\"Task.IsRunning\\",\\n \\"Latency\\": 123\\n}","type":"json"}]', - 'title' => 'CreateFunctionTask', - 'requestParamsDescription' => '### Sample requests'."\n" - ."\n" - .'`POST /v4/openapi/app-groups/my-app/functions/ctr/instances/ctr_test/task`'."\n", - 'responseParamsDescription' => '### Sample success responses'."\n" - ."\n" - .' {'."\n" - .' "status" : "OK",'."\n" - .' "requestId" : "",'."\n" - .' "httpCode": 200,'."\n" - .' "code": "",'."\n" - .' "message": "",'."\n" - .' "latency" : 123,'."\n" - .' "result" : {},'."\n" - .' }'."\n", - ], - 'ListFunctionInstances' => [ - 'summary' => 'Queries all algorithm instances of a user, which meet specified conditions.', - 'path' => '/v4/openapi/app-groups/{appGroupIdentity}/functions/{functionName}/instances', - 'methods' => [ - 'get', + 'title' => 'UnbindESUserAnalyzer', + 'description' => 'Use this operation to detach a custom analyzer from an Elasticsearch instance.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'opensearch:ModifyAppGroup', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'OpenSearch', 'resourceType' => 'AppGroup', 'arn' => 'acs:opensearch:{#regionId}:{#accountId}:app-groups/{#AppGroupId}'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"result\\": [],\\n \\"requestId\\": \\"0A6EB64B-B4C8-CF02-810F-E660812972FF\\"\\n}","type":"json"}]', + 'translator' => 'manual', + ], + 'UnbindEsInstance' => [ + 'summary' => 'Unbinds an Elasticsearch instance from an OpenSearch application.', + 'path' => '/v4/openapi/app-groups/{appGroupIdentity}/actions/unbind-es-instance', + 'methods' => ['post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'produces' => [ - 'application/json', - ], - 'operationType' => 'read', + 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'get', + 'operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREopensearch3QPM0K', - 'FEATUREopensearchN8M8WS', - 'FEATUREopensearchZAE4HR', - ], + 'abilityTreeCode' => '55264', + 'abilityTreeNodes' => ['FEATUREopensearchQZGKV9'], ], 'parameters' => [ [ 'name' => 'appGroupIdentity', 'in' => 'path', - 'schema' => [ - 'title' => '实例名称', - 'description' => 'The name of the application.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'app_group_name', - ], + 'schema' => ['description' => 'The name of the application.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'title' => '', 'example' => '"my_app_group_name"'], ], - [ - 'name' => 'functionName', - 'in' => 'path', + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'title' => '功能名称', - 'description' => 'The name of the feature.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'ctr', + 'type' => 'object', + 'properties' => [ + 'result' => ['description' => 'The data returned.', 'type' => 'object', 'title' => '', 'example' => '{}'], + 'requestId' => ['description' => 'The ID of the request.', 'type' => 'string', 'title' => '', 'example' => '0A6EB64B-B4C8-CF02-810F-E660812972FF'], + ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], - [ - 'name' => 'modelType', - 'in' => 'query', + '5XX' => [ 'schema' => [ - 'title' => '模型类型', - 'description' => 'The type of the model.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'tf_checkpoint', + 'type' => 'object', + 'properties' => [ + 'code' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'message' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'requestId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'httpCode' => ['type' => 'integer', 'format' => 'int32', 'description' => '', 'title' => '', 'example' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], + ], + 'title' => 'UnbindEsInstance', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ [ - 'name' => 'functionType', - 'in' => 'query', - 'schema' => [ - 'title' => '功能类型', - 'description' => 'The type of the feature.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '"PAAS"', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'opensearch:UnBindEsInstance', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'OpenSearch', 'resourceType' => 'AppGroup', 'arn' => 'acs:opensearch:{#regionId}:{#accountId}:app-groups/{#AppGroupId}'], + ], ], ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"result\\": {},\\n \\"requestId\\": \\"0A6EB64B-B4C8-CF02-810F-E660812972FF\\"\\n}","type":"json"}]', + 'translator' => 'manual', + ], + 'UntagResources' => [ + 'path' => '/v4/openapi/resource-tags', + 'methods' => ['delete'], + 'schemes' => ['http', 'https'], + 'security' => [ [ - 'name' => 'source', - 'in' => 'query', - 'schema' => [ - 'title' => '实例来源', - 'description' => 'How the instance is created. Valid values:'."\n" - ."\n" - .'* builtin: The instance is created by system.'."\n" - .'* user: The instance is created by user. This is the default value.'."\n" - .'* all: all instances'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'user', - ], + 'AK' => [], ], + ], + 'produces' => ['application/json'], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'abilityTreeCode' => '152938', + 'abilityTreeNodes' => ['FEATUREopensearch447AAX'], + ], + 'parameters' => [ [ - 'name' => 'pageNumber', + 'name' => 'resourceType', 'in' => 'query', - 'schema' => [ - 'title' => '页码', - 'description' => 'The number of the page to return. Default value: 1.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', - ], + 'schema' => ['title' => '', 'description' => 'The resource type.', 'type' => 'string', 'required' => true, 'example' => 'ProductVersion'], ], [ - 'name' => 'pageSize', + 'name' => 'resourceId', 'in' => 'query', + 'style' => 'json', 'schema' => [ - 'title' => '每页大小', - 'description' => 'The number of entries to return on each page. Default value: 10.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '10', + 'title' => '', + 'description' => 'The IDs of the resources. You can specify a maximum of 50 resource IDs.', + 'type' => 'array', + 'items' => ['description' => 'A list of resource IDs. You must specify at least one of \\`resourceId\\` or \\`tagKey\\`.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => '55111'], + 'required' => true, + 'example' => '', ], ], [ - 'name' => 'output', + 'name' => 'tagKey', 'in' => 'query', + 'style' => 'json', 'schema' => [ - 'title' => '返回信息的丰富度', - 'description' => 'The richness of the returned information. Valid values:'."\n" - ."\n" - .'* normal: displays information such as createParameters and cron. This is the default value.'."\n" - .'* simple: displays only the basic information.'."\n" - .'* detail: returns the details of the training task.'."\n", - 'type' => 'string', + 'title' => '', + 'description' => 'A list of tag keys. You can specify a maximum of 20 tag keys.', + 'type' => 'array', + 'items' => ['description' => 'The tag key.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => 'GENIE_FUNCTION'], 'required' => false, - 'enumValueTitles' => [], - 'example' => 'normal', + 'example' => '', ], - ], - ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'description' => 'The response body.'."\n", - 'type' => 'object', - 'properties' => [ - 'Status' => [ - 'description' => 'The status of the request.'."\n", - 'type' => 'string', - 'example' => '"OK"', - ], - 'HttpCode' => [ - 'description' => 'The HTTP status code.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '200', - ], - 'TotalCount' => [ - 'description' => 'The total number of entries returned.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '2', - ], - 'RequestId' => [ - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => 'A4D487A9-A456-5AA5-A9C6-B7BF2889CF74', - ], - 'Message' => [ - 'description' => 'The error message. If no error occurs, the parameter is left empty.'."\n", - 'type' => 'string', - 'example' => 'instance not exist.', - ], - 'Code' => [ - 'description' => 'The error code. If no error occurs, the parameter is left empty.'."\n", - 'type' => 'string', - 'example' => 'Instance.NotExist', - ], - 'Result' => [ - 'description' => 'The information about the instances.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The information about the instance.'."\n", - 'type' => 'object', - 'properties' => [ - 'Belongs' => [ - 'description' => ' The information about the instance.'."\n", - 'type' => 'object', - 'properties' => [ - 'Category' => [ - 'description' => 'The category.'."\n", - 'type' => 'string', - 'example' => '"general"', - ], - 'Domain' => [ - 'description' => 'The industry.'."\n", - 'type' => 'string', - 'example' => '"ecommerce"', - ], - 'Language' => [ - 'description' => 'The abbreviation of the language that applies.'."\n", - 'type' => 'string', - 'example' => '"zh" ', - ], - ], - 'example' => '{}', - ], - 'CreateParameters' => [ - 'description' => 'The parameters of the instance.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The parameter body.'."\n", - 'type' => 'object', - 'properties' => [ - 'Name' => [ - 'description' => 'The name of the parameter.'."\n", - 'type' => 'string', - 'example' => '"param1"', - ], - 'Value' => [ - 'description' => 'The value of the parameter.'."\n", - 'type' => 'string', - 'example' => '"value1"', - ], - ], - 'example' => '{}', - ], - 'example' => '[]', - ], - 'UsageParameters' => [ - 'description' => 'The parameters that are used.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The parameter body.'."\n", - 'type' => 'object', - 'properties' => [ - 'Name' => [ - 'description' => 'The name of the parameter.'."\n", - 'type' => 'string', - 'example' => 'use_param1', - ], - 'Value' => [ - 'description' => 'The value of the parameter.'."\n", - 'type' => 'string', - 'example' => 'value1', - ], - ], - ], - ], - 'CreateTime' => [ - 'description' => 'The time when the instance was created.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1234', - ], - 'Cron' => [ - 'description' => 'The cron expression used to schedule training, in the format of (Minutes Hours DayofMonth Month DayofWeek). If the value is empty, it indicates that no periodic training is performed.'."\n", - 'type' => 'string', - 'example' => '0 3 ? \\* 0,1,3,5 (at 3 a.m. on Sunday, Monday, Wednesday, and Friday)'."\n", - ], - 'Description' => [ - 'description' => 'The description.'."\n", - 'type' => 'string', - 'example' => '" "', - ], - 'ExtendInfo' => [ - 'description' => 'The extended information, which is a JSON string. It includes model evaluation information and error information.'."\n", - 'type' => 'string', - 'example' => '"{\\"dataReport\\":{},\\"errors\\":{}}"', - ], - 'FunctionName' => [ - 'description' => 'The name of the feature.'."\n", - 'type' => 'string', - 'example' => '"ctr"', - ], - 'FunctionType' => [ - 'description' => 'The type of the feature.'."\n", - 'type' => 'string', - 'example' => '"PAAS"', - ], - 'InstanceName' => [ - 'description' => 'The name of the instance.'."\n", - 'type' => 'string', - 'example' => '"ctr_test"', - ], - 'ModelType' => [ - 'description' => 'The type of the model.'."\n", - 'type' => 'string', - 'example' => '"tf_checkpoint"', - ], - 'Source' => [ - 'description' => 'How the instance is created. Valid values:'."\n" - ."\n" - .'* user: The instance is created by user.'."\n" - .'* builtin: The instance is created by system.'."\n", - 'type' => 'string', - 'example' => '"user"', - ], - 'Status' => [ - 'description' => 'The state of the instance. Valid values:'."\n" - ."\n" - .'1. unavailable: No model is available. Models must be trained before you can use them.'."\n" - .'2. available: Models can be used.'."\n", - 'type' => 'string', - 'example' => 'available', - ], - 'VersionId' => [ - 'description' => 'The ID of the version.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '123', - ], - ], - 'example' => '{}', - ], - 'example' => '[]', - ], - 'Latency' => [ - 'description' => 'The time consumed for the request, in milliseconds.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '123', - ], + ], + [ + 'name' => 'all', + 'in' => 'query', + 'schema' => ['title' => '', 'description' => 'Specifies whether to remove all tags from the resources. This parameter takes effect only if you do not specify \\`tagKey\\`. Valid values: \\`true\\` and \\`false\\`. Default value: \\`false\\`.', 'type' => 'boolean', 'required' => false, 'example' => 'true'], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => 'The response body.', + 'type' => 'object', + 'properties' => [ + 'tequestId' => ['description' => 'The request ID.', 'type' => 'string', 'title' => '', 'example' => '1-B-2-V'], ], + 'title' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Status\\": \\"\\\\\\"OK\\\\\\"\\",\\n \\"HttpCode\\": 200,\\n \\"TotalCount\\": 2,\\n \\"RequestId\\": \\"A4D487A9-A456-5AA5-A9C6-B7BF2889CF74\\",\\n \\"Message\\": \\"instance not exist.\\",\\n \\"Code\\": \\"Instance.NotExist\\",\\n \\"Result\\": [\\n {\\n \\"Belongs\\": {\\n \\"Category\\": \\"\\\\\\"general\\\\\\"\\",\\n \\"Domain\\": \\"\\\\\\"ecommerce\\\\\\"\\",\\n \\"Language\\": \\"\\\\\\"zh\\\\\\"\\\\t\\"\\n },\\n \\"CreateParameters\\": [\\n {\\n \\"Name\\": \\"\\\\\\"param1\\\\\\"\\",\\n \\"Value\\": \\"\\\\\\"value1\\\\\\"\\"\\n }\\n ],\\n \\"UsageParameters\\": [\\n {\\n \\"Name\\": \\"use_param1\\",\\n \\"Value\\": \\"value1\\"\\n }\\n ],\\n \\"CreateTime\\": 1234,\\n \\"Cron\\": \\"0 3 ? * 0,1,3,5 (周日，周一，周三，周五凌晨3点)\\",\\n \\"Description\\": \\"\\\\\\" \\\\\\"\\",\\n \\"ExtendInfo\\": \\"\\\\\\"{\\\\\\\\\\\\\\"dataReport\\\\\\\\\\\\\\":{},\\\\\\\\\\\\\\"errors\\\\\\\\\\\\\\":{}}\\\\\\"\\",\\n \\"FunctionName\\": \\"\\\\\\"ctr\\\\\\"\\",\\n \\"FunctionType\\": \\"\\\\\\"PAAS\\\\\\"\\",\\n \\"InstanceName\\": \\"\\\\\\"ctr_test\\\\\\"\\",\\n \\"ModelType\\": \\"\\\\\\"tf_checkpoint\\\\\\"\\",\\n \\"Source\\": \\"\\\\\\"user\\\\\\"\\",\\n \\"Status\\": \\"available\\",\\n \\"VersionId\\": 123\\n }\\n ],\\n \\"Latency\\": 123\\n}","type":"json"}]', - 'title' => 'ListFunctionInstances', - 'requestParamsDescription' => '### Sample requests'."\n" - ."\n" - .'`GET /v4/openapi/app-groups/my-app/functions/ctr/instances?source=all&output=simple`'."\n", - 'responseParamsDescription' => '### Sample success responses'."\n" - ."\n" - .' {'."\n" - .' "status": "OK",'."\n" - .' "requestId": "A4D487A9-A456-5AA5-A9C6-B7BF2889CF74",'."\n" - .' "httpCode": 200,'."\n" - .' "code": "",'."\n" - .' "message": "",'."\n" - .' "latency": 123,'."\n" - .' "totalCount": 2,'."\n" - .' "result": ['."\n" - .' {'."\n" - .' "versionId": 100,'."\n" - .' "instanceName": "instance_1",'."\n" - .' "functionName": "hot",'."\n" - .' "functionType": "PAAS",'."\n" - .' "modelType": "offline_inference",'."\n" - .' "description": "",'."\n" - .' "status": "available",'."\n" - .' "belongs": {'."\n" - .' "domain": "ecommerce",'."\n" - .' "category": "general",'."\n" - .' "language": "zh"'."\n" - .' },'."\n" - .' "createTime": 100010,'."\n" - .' "source": "user"'."\n" - .' },'."\n" - .' {'."\n" - .' "versionId": 100,'."\n" - .' "instanceName": "instance_2",'."\n" - .' "functionName": "hot",'."\n" - .' "functionType": "PAAS",'."\n" - .' "modelType": "offline_inference",'."\n" - .' "description": "",'."\n" - .' "status": "available",'."\n" - .' "belongs": {'."\n" - .' "domain": "ecommerce",'."\n" - .' "category": "general",'."\n" - .' "language": "zh"'."\n" - .' },'."\n" - .' "createTime": 200020,'."\n" - .' "source": "user",'."\n" - .' "default": true'."\n" - .' }'."\n" - .' ]'."\n" - .' }'."\n", - ], - 'GetFunctionInstance' => [ - 'summary' => 'Queries the details of an algorithm instance by instance name.', - 'path' => '/v4/openapi/app-groups/{appGroupIdentity}/functions/{functionName}/instances/{instanceName}', - 'methods' => [ - 'get', + 'title' => 'UntagResources', + 'summary' => 'Removes tags from resources.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'opensearch:UntagResources', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'OpenSearch', 'resourceType' => 'AppGroup', 'arn' => 'acs:opensearch:{#regionId}:{#accountId}:instance/{#AppGroupId}'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"tequestId\\": \\"1-B-2-V\\"\\n}","type":"json"}]', + 'translator' => 'manual', + ], + 'UpdateABTestExperiment' => [ + 'path' => '/v4/openapi/app-groups/{appGroupIdentity}/scenes/{sceneId}/groups/{groupId}/experiments/{experimentId}', + 'methods' => ['put'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [], - 'produces' => [ - 'application/json', - ], - 'operationType' => 'read', + 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'get', + 'operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREopensearch3QPM0K', - 'FEATUREopensearchN8M8WS', - 'FEATUREopensearchZAE4HR', - ], + 'abilityTreeNodes' => ['FEATUREopensearchE07IML'], ], 'parameters' => [ [ 'name' => 'appGroupIdentity', 'in' => 'path', - 'schema' => [ - 'description' => 'The name of the application.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => '150057101', - ], + 'schema' => ['description' => 'The name of the application.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'title' => '', 'example' => '“my_app_group_name”'], ], [ - 'name' => 'functionName', + 'name' => 'sceneId', 'in' => 'path', - 'schema' => [ - 'description' => 'The name of the feature.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'ctr', - ], + 'schema' => ['description' => 'The ID of the scene.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true, 'maximum' => '999999999', 'minimum' => '-1', 'title' => '', 'example' => '20404'], ], [ - 'name' => 'instanceName', + 'name' => 'groupId', 'in' => 'path', - 'schema' => [ - 'description' => 'The name of the instance.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'ctr_test', - ], + 'schema' => ['description' => 'The ID of the group.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true, 'maximum' => '999999999', 'minimum' => '-1', 'title' => '', 'example' => '13467'], ], [ - 'name' => 'output', + 'name' => 'experimentId', + 'in' => 'path', + 'schema' => ['description' => 'The ID of the experiment.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true, 'maximum' => '999999999', 'minimum' => '-1', 'title' => '', 'example' => '12889'], + ], + [ + 'name' => 'dryRun', 'in' => 'query', - 'schema' => [ - 'description' => 'Specifies the richness of returned information. Valid values:'."\n" - ."\n" - .'* simple: displays only the basic information.'."\n" - .'* normal: displays information such as createParameters and cron. This is the default value.'."\n" - .'* detail: returns the details of the training task.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'detail', - ], + 'schema' => ['description' => 'Specifies whether to perform a dry run. Valid values:'."\n" + ."\n" + .'- true: Performs a dry run. The system checks if your AccessKey is valid, if the Resource Access Management (RAM) user is authorized, and if all required parameters are specified. The request is not sent.'."\n" + ."\n" + .'- false (default): Sends the request to update the experiment.', 'type' => 'boolean', 'required' => false, 'title' => '', 'example' => 'true'], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'schema' => ['description' => 'The request body. For more information, see [ABTestExperiment](~~173617~~).', 'required' => false, '$ref' => '#/components/schemas/ABTestExperiment', 'title' => '', 'example' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'description' => 'The response body.'."\n", 'type' => 'object', 'properties' => [ - 'Status' => [ - 'description' => 'The status of the request.'."\n", - 'type' => 'string', - 'example' => 'OK', - ], - 'HttpCode' => [ - 'description' => 'The HTTP status code.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '200', - ], - 'RequestId' => [ - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => '68ED4E1B-92B8-5821-A886-9C90686139EB', - ], - 'Message' => [ - 'description' => 'The error message.'."\n", - 'type' => 'string', - 'example' => 'instance not exist.', - ], - 'Code' => [ - 'description' => 'The error code. If no error occurs, this parameter is left empty.'."\n", - 'type' => 'string', - 'example' => 'Instance.NotExist', - ], - 'Result' => [ - 'description' => 'The details of the instance.'."\n", + 'requestId' => ['description' => 'The ID of the request.', 'type' => 'string', 'title' => '', 'example' => 'D77D0DAF-790D-F5F5-A9C0-133738165014'], + 'result' => [ + 'description' => 'The details of the experiment.', 'type' => 'object', 'properties' => [ - 'Belongs' => [ - 'description' => 'The information about the instance.'."\n", - 'type' => 'object', - 'properties' => [ - 'Category' => [ - 'description' => 'The category.'."\n", - 'type' => 'string', - 'example' => 'general', - ], - 'Domain' => [ - 'description' => 'The industry.'."\n", - 'type' => 'string', - 'example' => 'ecommerce', - ], - 'Language' => [ - 'description' => 'The abbreviation of the language that applies.'."\n", - 'type' => 'string', - 'example' => 'zh'."\n", - ], - ], - ], - 'CreateParameters' => [ - 'description' => 'The parameters that are used to create the instance.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The parameter body.'."\n", - 'type' => 'object', - 'properties' => [ - 'Name' => [ - 'description' => 'The name of the parameter.'."\n", - 'type' => 'string', - 'example' => 'param1', - ], - 'Value' => [ - 'description' => 'The value of the parameter.'."\n", - 'type' => 'string', - 'example' => 'value1', - ], - ], - ], - ], - 'UsageParameters' => [ - 'description' => 'The parameters that are used.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The parameter body.'."\n", - 'type' => 'object', - 'properties' => [ - 'Name' => [ - 'description' => 'The name of the parameter.'."\n", - 'type' => 'string', - 'example' => 'use_param1', - ], - 'Value' => [ - 'description' => 'The value of the parameter.'."\n", - 'type' => 'string', - 'example' => 'value1', - ], - ], - ], - ], - 'CreateTime' => [ - 'description' => 'The time when the task was created. Unit: milliseconds.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1234', - ], - 'Cron' => [ - 'description' => 'The cron expression used to schedule training, in the format of (Minutes Hours DayofMonth Month DayofWeek). If the value is empty, it indicates that no periodic training is performed.'."\n", - 'type' => 'string', - 'example' => '0 3 ? \\* 0,1,3,5 (at 3 a.m. on Sunday, Monday, Wednesday, and Friday)'."\n", - ], - 'Description' => [ - 'description' => 'The description of the instance.'."\n", - 'type' => 'string', - 'example' => 'instance descriptions', - ], - 'ExtendInfo' => [ - 'description' => 'The extended information, which is a JSON string.'."\n", - 'type' => 'string', - 'example' => '{\\"dataReport\\":{},\\"errors\\":{}}', - ], - 'FunctionName' => [ - 'description' => 'The name of the feature.'."\n", - 'type' => 'string', - 'example' => 'ctr', - ], - 'FunctionType' => [ - 'description' => 'The type of the feature.'."\n", - 'type' => 'string', - 'example' => 'PAAS', - ], - 'InstanceName' => [ - 'description' => 'The name of the instance.'."\n", - 'type' => 'string', - 'example' => 'ctr_test', - ], - 'ModelType' => [ - 'description' => 'The type of the model.'."\n", - 'type' => 'string', - 'example' => 'tf_checkpoint', - ], - 'Source' => [ - 'description' => 'How the instance is created. Valid values:'."\n" - ."\n" - .'* user: The instance is created by user.'."\n" - .'* builtin: The instance is created by the system.'."\n", - 'type' => 'string', - 'example' => 'user', - ], - 'Status' => [ - 'description' => 'The status of the instance. Valid values:'."\n" - ."\n" - .'1. unavailable: No model is available. Models must be trained before you can use them.'."\n" - .'2. available: Models can be used.'."\n", - 'type' => 'string', - 'example' => 'available', - ], - 'Task' => [ - 'description' => 'The information about the training task. This parameter is not displayed if no task is available.'."\n", - 'type' => 'object', - 'properties' => [ - 'DagStatus' => [ - 'description' => 'The status of the task. Valid values:'."\n" - ."\n" - .'* success: succeeded'."\n" - .'* failed: failed'."\n" - .'* untrained: to be trained'."\n" - .'* pending: being scheduled'."\n" - .'* running: being trained'."\n", - 'type' => 'string', - 'example' => 'success', - ], - 'LastRunTime' => [ - 'description' => 'The time consumed for the most recent run, in milliseconds.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1234', - ], - ], - ], - 'VersionId' => [ - 'description' => 'The ID of the version.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '101', - ], + 'created' => ['description' => 'The time when the experiment was created.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '1588842080'], + 'params' => ['description' => 'The parameters of the experiment.', 'type' => 'object', 'title' => '', 'example' => '{}'], + 'traffic' => ['description' => 'The percentage of traffic allocated to the experiment. Valid values: 0 to 100.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '30'], + 'online' => ['description' => 'The status of the experiment.'."\n" + ."\n" + .'- true: The experiment is online.'."\n" + ."\n" + .'- false: The experiment is offline.', 'type' => 'boolean', 'title' => '', 'example' => 'true'], + 'name' => ['description' => 'The name of the experiment.', 'type' => 'string', 'title' => '', 'example' => 'test1'], + 'updated' => ['description' => 'The time when the experiment was last modified.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '1588842080'], + 'id' => ['description' => 'The ID of the experiment.', 'type' => 'string', 'title' => '', 'example' => '12888'], ], - 'example' => '{}', - ], - 'Latency' => [ - 'description' => 'The time consumed for the request, in milliseconds.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '123', + 'title' => '', + 'example' => '', ], ], - 'example' => '{}', + 'description' => '', + 'title' => '', + 'example' => '', + ], + ], + '5XX' => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'code' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'message' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'requestId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'httpCode' => ['type' => 'integer', 'format' => 'int32', 'description' => '', 'title' => '', 'example' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Status\\": \\"OK\\",\\n \\"HttpCode\\": 200,\\n \\"RequestId\\": \\"68ED4E1B-92B8-5821-A886-9C90686139EB\\",\\n \\"Message\\": \\"instance not exist.\\",\\n \\"Code\\": \\"Instance.NotExist\\",\\n \\"Result\\": {\\n \\"Belongs\\": {\\n \\"Category\\": \\"general\\",\\n \\"Domain\\": \\"ecommerce\\",\\n \\"Language\\": \\"zh（默认）\\"\\n },\\n \\"CreateParameters\\": [\\n {\\n \\"Name\\": \\"param1\\",\\n \\"Value\\": \\"value1\\"\\n }\\n ],\\n \\"UsageParameters\\": [\\n {\\n \\"Name\\": \\"use_param1\\",\\n \\"Value\\": \\"value1\\"\\n }\\n ],\\n \\"CreateTime\\": 1234,\\n \\"Cron\\": \\"0 3 ? * 0,1,3,5 (周日，周一，周三，周五凌晨3点)\\",\\n \\"Description\\": \\"instance descriptions\\",\\n \\"ExtendInfo\\": \\"{\\\\\\\\\\\\\\"dataReport\\\\\\\\\\\\\\":{},\\\\\\\\\\\\\\"errors\\\\\\\\\\\\\\":{}}\\",\\n \\"FunctionName\\": \\"ctr\\",\\n \\"FunctionType\\": \\"PAAS\\",\\n \\"InstanceName\\": \\"ctr_test\\",\\n \\"ModelType\\": \\"tf_checkpoint\\",\\n \\"Source\\": \\"user\\",\\n \\"Status\\": \\"available\\",\\n \\"Task\\": {\\n \\"DagStatus\\": \\"success\\",\\n \\"LastRunTime\\": 1234\\n },\\n \\"VersionId\\": 101\\n },\\n \\"Latency\\": 123\\n}","type":"json"}]', - 'title' => 'GetFunctionInstance', - 'requestParamsDescription' => '### Sample requests'."\n" - ."\n" - .'`GET /v4/openapi/app-groups/my-app/functions/ctr/instances/ctr_test?output=detail`'."\n", - 'responseParamsDescription' => '### Sample success responses'."\n" + 'title' => 'UpdateABTestExperiment', + 'summary' => 'Updates the parameters of an A/B test experiment.', + 'requestParamsDescription' => '**Request body**'."\n" ."\n" - .' {'."\n" - .' "status": "OK",'."\n" - .' "requestId": "",'."\n" - .' "httpCode": 200,'."\n" - .' "code": "",'."\n" - .' "message": "",'."\n" - .' "latency": 123,'."\n" - .' "result": {'."\n" - .' "versionId": 100,'."\n" - .' "instanceName": "ctr_test",'."\n" - .' "functionName": "ctr",'."\n" - .' "functionType": "PAAS",'."\n" - .' "modelType": "tf_checkpoint",'."\n" - .' "Description": "test",'."\n" - .' "status": "available",'."\n" - .' "belongs": {'."\n" - .' "domain": "ecommerce",'."\n" - .' "category": "general",'."\n" - .' "language": "zh"'."\n" - .' },'."\n" - .' "createTime": 100010,'."\n" - .' "createParameters": ['."\n" - .' {'."\n" - .' "name": "param1",'."\n" - .' "value": "val1"'."\n" - .' }'."\n" - .' ],'."\n" - .' "usageParameters": ['."\n" - .' {'."\n" - .' "name": "use_param1",'."\n" - .' "value": "val1"'."\n" - .' }'."\n" - .' ],'."\n" - .' "extendInfo": "{\\"error\\":{},\\"dataReport\\":{}}",'."\n" - .' "cron": "",'."\n" - .' "task": {'."\n" - .' "dagStatus": "running",'."\n" - .' "progress": 30,'."\n" - .' "lastRunTime": 200020'."\n" - .' }'."\n" - .' }'."\n" - .' }'."\n", - ], - 'DeleteFunctionInstance' => [ - 'summary' => 'Deletes an algorithm instance. Before you delete an instance, make sure that it is not in use to prevent service interruptions.', - 'path' => '/v4/openapi/app-groups/{appGroupIdentity}/functions/{functionName}/instances/{instanceName}', - 'methods' => [ - 'delete', + .'| Field | Type | Required | Example | Description |'."\n" + .'| ------- | ------- | -------- | ------------------------------- | ------------------------------------------------------ |'."\n" + .'| name | String | No | "my_test" | The name of the experiment. |'."\n" + .'| traffic | Integer | No | 30 | The percentage of traffic allocated to the experiment. |'."\n" + .'| online | Boolean | No | true | Specifies whether the experiment is online. |'."\n" + .'| params | Object | No | {"firstFormulaName": "default"} | The parameters for the experiment. |', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'opensearch:UpdateApp', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'OpenSearch', 'resourceType' => 'AbTestExperiment', 'arn' => 'acs:opensearch:{#regionId}:{#accountId}:apps/{#AppGroupId}'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"D77D0DAF-790D-F5F5-A9C0-133738165014\\",\\n \\"result\\": {\\n \\"created\\": 1588842080,\\n \\"params\\": {},\\n \\"traffic\\": 30,\\n \\"online\\": true,\\n \\"name\\": \\"test1\\",\\n \\"updated\\": 1588842080,\\n \\"id\\": \\"12888\\"\\n }\\n}","type":"json"}]', + 'translator' => 'manual', + ], + 'UpdateABTestFixedFlowDividers' => [ + 'summary' => 'Updates the whitelist data.', + 'path' => '/v4/openapi/app-groups/{appGroupIdentity}/scenes/{sceneId}/groups/{groupId}/experiments/{experimentId}/fixed-flow-dividers', + 'methods' => ['put'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [], - 'produces' => [ - 'application/json', - ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'delete', + 'operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREopensearch3QPM0K', - 'FEATUREopensearchN8M8WS', - 'FEATUREopensearchZAE4HR', - ], + 'abilityTreeNodes' => ['FEATUREopensearchE07IML'], ], 'parameters' => [ [ 'name' => 'appGroupIdentity', 'in' => 'path', - 'schema' => [ - 'title' => 'opensearch应用名', - 'description' => 'The name of the application.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => '“my_app_group_name”', - ], + 'schema' => ['description' => 'The name of the application.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'title' => '', 'example' => '“my_app_group_name”'], ], [ - 'name' => 'functionName', + 'name' => 'sceneId', 'in' => 'path', - 'schema' => [ - 'title' => '功能名称', - 'description' => 'The name of the feature.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => '"ctr"', - ], + 'schema' => ['description' => 'The scenario ID.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true, 'maximum' => '999999999', 'minimum' => '-1', 'title' => '', 'example' => '20404'], ], [ - 'name' => 'instanceName', + 'name' => 'groupId', + 'in' => 'path', + 'schema' => ['description' => 'The ID of the group.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true, 'maximum' => '999999999', 'minimum' => '-1', 'title' => '', 'example' => '13467'], + ], + [ + 'name' => 'experimentId', 'in' => 'path', + 'schema' => ['description' => 'The ID of the experiment.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true, 'maximum' => '999999999', 'minimum' => '-1', 'title' => '', 'example' => '12889'], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', 'schema' => [ - 'title' => '实例名称', - 'description' => 'The name of the instance.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => '"ctr_test"', + 'description' => 'The request body.', + 'type' => 'array', + 'items' => ['description' => 'Whitelist data.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => '"D77D0DAF" '], + 'required' => false, + 'maxItems' => 100, + 'title' => '', + 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'description' => 'The result of the request.'."\n", 'type' => 'object', 'properties' => [ - 'Status' => [ - 'description' => 'The status of the request. Valid values:'."\n" - ."\n" - .'* OK: The request is successful.'."\n" - .'* FAIL: The request fails.'."\n", - 'type' => 'string', - 'example' => '"OK"', - ], - 'HttpCode' => [ - 'description' => 'The HTTP status code.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '200', - ], - 'RequestId' => [ - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => '"1081EB05-473C-5BF4-95BE-6D7CAD5E2213"', - ], - 'Message' => [ - 'description' => 'The error message. If no error occurs, this parameter is left empty.'."\n", - 'type' => 'string', - 'example' => '"instance not exist."', - ], - 'Code' => [ - 'description' => 'The error code. If no error occurs, this parameter is left empty.'."\n", - 'type' => 'string', - 'example' => '"Instance.NotExist"', - ], - 'Latency' => [ - 'description' => 'The time consumed for the request, in milliseconds.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '10', - ], + 'requestId' => ['description' => 'The request ID.', 'type' => 'string', 'title' => '', 'example' => 'D77D0DAF-790D-F5F5-A9C0-133738165014'], + 'result' => [ + 'description' => 'The returned results.', + 'type' => 'array', + 'items' => ['description' => 'The whitelist.', 'type' => 'string', 'title' => '', 'example' => '[ "D77D0DAF", "133738165014" ]'], + 'title' => '', + 'example' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + ], + '5XX' => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'code' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'message' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'requestId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'httpCode' => ['type' => 'integer', 'format' => 'int32', 'description' => '', 'title' => '', 'example' => ''], ], - 'example' => '{}', + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Status\\": \\"\\\\\\"OK\\\\\\"\\",\\n \\"HttpCode\\": 200,\\n \\"RequestId\\": \\"\\\\\\"1081EB05-473C-5BF4-95BE-6D7CAD5E2213\\\\\\"\\",\\n \\"Message\\": \\"\\\\\\"instance not exist.\\\\\\"\\",\\n \\"Code\\": \\"\\\\\\"Instance.NotExist\\\\\\"\\",\\n \\"Latency\\": 10\\n}","type":"json"}]', - 'title' => 'DeleteFunctionInstance', - 'requestParamsDescription' => '### Sample requests'."\n" + 'title' => 'UpdateABTestFixedFlowDividers', + 'requestParamsDescription' => '**Request body**'."\n" ."\n" - .'`DELETE /v4/openapi/app-groups/my-app/functions/ctr/instances/ctr_test`'."\n", - ], - 'UpdateFunctionInstance' => [ - 'summary' => 'Updates an algorithm instance.', - 'path' => '/v4/openapi/app-groups/{appGroupIdentity}/functions/{functionName}/instances/{instanceName}', - 'methods' => [ - 'put', + .'| Parameter | Type | Required | Example | Description |'."\n" + .'| --------- | ------ | -------- | ---------- | --------------- |'."\n" + .'| \\[] | String | Yes | "D77D0DAF" | Whitelist data. |', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'opensearch:UpdateApp', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'OpenSearch', 'resourceType' => 'AbTestExperiment', 'arn' => 'acs:opensearch:{#regionId}:{#accountId}:apps/{#AppGroupId}'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"D77D0DAF-790D-F5F5-A9C0-133738165014\\",\\n \\"result\\": [\\n \\"[ \\\\\\"D77D0DAF\\\\\\", \\\\\\"133738165014\\\\\\" ]\\"\\n ]\\n}","type":"json"}]', + 'translator' => 'manual', + ], + 'UpdateABTestGroup' => [ + 'summary' => 'Modifies a test group.', + 'path' => '/v4/openapi/app-groups/{appGroupIdentity}/scenes/{sceneId}/groups/{groupId}', + 'methods' => ['put'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREopensearch3QPM0K', - 'FEATUREopensearchN8M8WS', - ], + 'abilityTreeCode' => '55268', + 'abilityTreeNodes' => ['FEATUREopensearchE07IML'], ], 'parameters' => [ - [ - 'name' => 'Body', - 'in' => 'body', - 'style' => 'json', - 'schema' => [ - 'title' => 'body参数', - 'description' => 'The parameter body.'."\n", - 'type' => 'object', - 'properties' => [ - 'cron' => [ - 'title' => '周期训练', - 'description' => 'The cron expression used to schedule periodic training, in the format of (Minutes Hours DayofMonth Month DayofWeek). The default value is empty, which indicates that no periodic training is performed. DayofWeek 0 indicates Sunday.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '"0 3 ? * 0,1,3,5"', - ], - 'createParameters' => [ - 'title' => '创建参数', - 'description' => 'The parameters that are used to create the instance.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The parameter body.'."\n", - 'type' => 'object', - 'properties' => [ - 'name' => [ - 'title' => '参数名称', - 'description' => 'The name of the parameter.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'title_field', - ], - 'value' => [ - 'title' => '参数值', - 'description' => 'The value of the parameter.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'title', - ], - ], - 'required' => false, - 'example' => '{}', - ], - 'required' => false, - 'example' => '{ "name": "title_field", "value": "title" }', - ], - 'usageParameters' => [ - 'title' => '使用参数', - 'description' => 'The parameters that are used.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The parameter body.'."\n", - 'type' => 'object', - 'properties' => [ - 'name' => [ - 'description' => 'The name of the parameter.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'allow_dict_id', - ], - 'value' => [ - 'description' => 'The value of the parameter.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '123', - ], - ], - 'required' => false, - ], - 'required' => false, - ], - 'description' => [ - 'title' => '实例描述', - 'description' => 'The description of the instance.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'test instance'."\n", - ], - ], - 'required' => false, - 'example' => '{}', - ], - ], [ 'name' => 'appGroupIdentity', 'in' => 'path', - 'schema' => [ - 'title' => 'opensearch应用名', - 'description' => 'The name of the application.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => '"app_group_name"', - ], + 'schema' => ['description' => 'The name of the application.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'title' => '', 'example' => '“my_app_group_name”'], ], [ - 'name' => 'functionName', + 'name' => 'sceneId', 'in' => 'path', - 'schema' => [ - 'title' => '功能名称', - 'description' => 'The name of the feature.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => '"ctr"', - ], + 'schema' => ['description' => 'The scenario ID.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true, 'maximum' => '999999999', 'minimum' => '-1', 'title' => '', 'example' => '20404'], ], [ - 'name' => 'instanceName', + 'name' => 'groupId', 'in' => 'path', - 'schema' => [ - 'title' => '实例名称', - 'description' => 'The name of the instance.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => '"ctr_test"', - ], + 'schema' => ['description' => 'The ID of the test group.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true, 'maximum' => '999999999', 'minimum' => '-1', 'title' => '', 'example' => '13467'], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'schema' => ['description' => 'The request body. For more information, see [ABTestGroup](~~178935~~).', 'required' => false, '$ref' => '#/components/schemas/ABTestGroup', 'title' => '', 'example' => ''], + ], + [ + 'name' => 'dryRun', + 'in' => 'query', + 'schema' => ['description' => 'Specifies whether to perform a dry run. Valid values:'."\n" + ."\n" + .'- true: Performs a dry run. The system checks if the AccessKey is valid, if the RAM user is authorized, and if all required parameters are specified. The test group is not updated.'."\n" + ."\n" + .'- false (default): Sends the request to update the test group.', 'type' => 'boolean', 'required' => false, 'title' => '', 'example' => 'true'], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'The schema of the response.'."\n", 'type' => 'object', 'properties' => [ - 'Status' => [ - 'description' => 'The status of the request. Valid values:'."\n" - ."\n" - .'* OK: The request was successful.'."\n" - .'* FAIL: The request failed.'."\n", - 'type' => 'string', - 'example' => 'OK', - ], - 'HttpCode' => [ - 'description' => 'The HTTP status code.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '200', - ], - 'RequestId' => [ - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => '"3A809095-C554-5CF5-8FCE-BE19D4673790"', - ], - 'Message' => [ - 'title' => '错误信息', - 'description' => 'The error message.'."\n", - 'type' => 'string', - 'example' => '"instance not exist."', - ], - 'Code' => [ - 'title' => '错误码', - 'description' => 'The error code.'."\n", - 'type' => 'string', - 'example' => '"Instance.NotExist"', - ], - 'Latency' => [ - 'title' => '耗时', - 'description' => 'The time consumed for the request, in milliseconds.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '10', + 'requestId' => ['description' => 'The request ID.', 'type' => 'string', 'title' => '', 'example' => '\'\'1111\'\''], + 'result' => [ + 'description' => 'The details of the test group.', + 'type' => 'object', + 'properties' => [ + 'created' => ['description' => 'The time when the test group was created.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '1588839490'], + 'status' => ['description' => 'The status of the test group. Valid values:'."\n" + ."\n" + .'- 0: inactive'."\n" + ."\n" + .'- 1: active', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '1'], + 'updated' => ['description' => 'The time when the test group was last updated.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '1588839490'], + 'name' => ['description' => 'The name of the test group.', 'type' => 'string', 'title' => '', 'example' => 'Group_2020-5-7_15:23:3'], + 'id' => ['description' => 'The ID of the test group.', 'type' => 'string', 'title' => '', 'example' => '13466'], + ], + 'title' => '', + 'example' => '', ], ], - 'example' => '{}', + 'description' => '', + 'title' => '', + 'example' => '', + ], + ], + '5XX' => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'code' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'message' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'requestId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'httpCode' => ['type' => 'integer', 'format' => 'int32', 'description' => '', 'title' => '', 'example' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Status\\": \\"OK\\",\\n \\"HttpCode\\": 200,\\n \\"RequestId\\": \\"\\\\\\"3A809095-C554-5CF5-8FCE-BE19D4673790\\\\\\"\\",\\n \\"Message\\": \\"\\\\\\"instance not exist.\\\\\\"\\",\\n \\"Code\\": \\"\\\\\\"Instance.NotExist\\\\\\"\\",\\n \\"Latency\\": 10\\n}","type":"json"}]', - 'title' => 'UpdateFunctionInstance', - 'requestParamsDescription' => '### Sample requests (Only the createParameters and cron parameters are updated.)'."\n" - ."\n" - .'`PUT /v4/openapi/app-groups/my-app/functions/ctr/instances/ctr_test`'."\n" + 'title' => 'UpdateABTestGroup', + 'requestParamsDescription' => '**Request body**'."\n" ."\n" - .' {'."\n" - .' "createParameters": ['."\n" - .' {'."\n" - .' "name": "param1",'."\n" - .' "value": "new value"'."\n" - .' }'."\n" - .' ],'."\n" - .' "cron": ""'."\n" - .' }'."\n", - ], - 'CreateFunctionInstance' => [ - 'summary' => 'Creates an algorithm instance of a feature.', - 'path' => '/v4/openapi/app-groups/{appGroupIdentity}/functions/{functionName}/instances', - 'methods' => [ - 'post', + .'| Parameter | Type | Required | Example | Description |'."\n" + .'| --------- | ------ | -------- | ------------ | --------------------------- |'."\n" + .'| name | String | Yes | "kevintest3" | The name of the test group. |', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'opensearch:UpdateApp', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'OpenSearch', 'resourceType' => 'AbTestGroup', 'arn' => 'acs:opensearch:{#regionId}:{#accountId}:apps/{#AppGroupId}'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"\'\'1111\'\'\\",\\n \\"result\\": {\\n \\"created\\": 1588839490,\\n \\"status\\": 1,\\n \\"updated\\": 1588839490,\\n \\"name\\": \\"Group_2020-5-7_15:23:3\\",\\n \\"id\\": \\"13466\\"\\n }\\n}","type":"json"}]', + 'translator' => 'manual', + ], + 'UpdateABTestScene' => [ + 'summary' => 'Modifies an experiment scenario.', + 'path' => '/v4/openapi/app-groups/{appGroupIdentity}/scenes/{sceneId}', + 'methods' => ['put'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'create', + 'operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeCode' => '100229', - 'abilityTreeNodes' => [ - 'FEATUREopensearch3QPM0K', - 'FEATUREopensearchUIICM8', - 'FEATUREopensearchZAE4HR', - ], + 'abilityTreeNodes' => ['FEATUREopensearchE07IML'], ], 'parameters' => [ - [ - 'name' => 'Body', - 'in' => 'body', - 'style' => 'json', - 'schema' => [ - 'title' => 'body参数', - 'description' => 'The request body.'."\n", - 'type' => 'object', - 'properties' => [ - 'instanceName' => [ - 'title' => '实例名称', - 'description' => 'The instance name. The name must be 1 to 30 characters in length and can contain letters, digits, and underscores (\\_). The name is case-sensitive and must start with a letter.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'ctr_test', - ], - 'modelType' => [ - 'title' => '模型类型', - 'description' => 'The model type. The value varies based on the model.'."\n" - ."\n" - .'* Click-through rate (CTR) model: tf_checkpoint'."\n" - .'* Popularity model: pop'."\n" - .'* Category model: offline_inference'."\n" - .'* Hotword model: offline_inference'."\n" - .'* Hint model: offline_inference'."\n" - .'* Hotword model for real-time top searches: near_realtime'."\n" - .'* Personalized hint model: near_realtime'."\n" - .'* Drop-down suggestion model: offline_inference'."\n" - .'* Tokenization model: text'."\n" - .'* Term weight model: tf_checkpoint'."\n" - .'* Synonym model: offline_inference'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'tf_checkpoint', - ], - 'functionType' => [ - 'title' => '功能类型', - 'description' => 'The feature type.'."\n" - ."\n" - .'* Default value: PAAS. Training is required before you can use the feature.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'PAAS', - ], - 'description' => [ - 'title' => '实例描述', - 'description' => 'The description.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'test instance'."\n", - ], - 'createParameters' => [ - 'title' => '创建参数', - 'description' => 'The parameters used to create the instance.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The parameter body.'."\n", - 'type' => 'object', - 'properties' => [ - 'name' => [ - 'title' => '参数名称', - 'description' => 'The parameter name.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'title_field', - ], - 'value' => [ - 'title' => '参数值', - 'description' => 'The parameter value.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'title', - ], - ], - 'required' => false, - 'example' => '{ "name": "title_field", "value": "title" }', - ], - 'required' => false, - 'example' => '[ { "name": "param1", "value": "val1" } ]', - ], - 'usageParameters' => [ - 'title' => '使用参数', - 'description' => 'The parameters used to use the instance.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The parameters that are used online, such as the blacklist and whitelist.'."\n", - 'type' => 'object', - 'properties' => [ - 'name' => [ - 'title' => '参数名称', - 'description' => 'The parameter name.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'allow_dict_id', - ], - 'value' => [ - 'title' => '参数值', - 'description' => 'The parameter value.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '123', - ], - ], - 'required' => false, - ], - 'required' => false, - ], - 'cron' => [ - 'title' => '周期训练', - 'description' => 'The CRON expression used to schedule periodic training, in the format of Minutes Hours DayofMonth Month DayofWeek. The default value is empty, which specifies that no periodic training is performed. A value of 0 for DayofWeek specifies Sunday.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '0 0 ? * 0,1,2,3,4,5,6', - ], - ], - 'required' => false, - 'docRequired' => true, - 'example' => '', - ], - ], [ 'name' => 'appGroupIdentity', 'in' => 'path', - 'schema' => [ - 'description' => 'The name of the application.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'my_app_group_name', - ], + 'schema' => ['description' => 'The name of the application.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'title' => '', 'example' => '“my_app_group_name”'], ], [ - 'name' => 'functionName', + 'name' => 'sceneId', 'in' => 'path', + 'schema' => ['description' => 'The ID of the scenario.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true, 'maximum' => '999999999', 'minimum' => '-1', 'title' => '', 'example' => '20404'], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'schema' => ['description' => 'The A/B test scenario.', 'required' => false, '$ref' => '#/components/schemas/ABTestScene', 'title' => '', 'example' => ''], + ], + [ + 'name' => 'dryRun', + 'in' => 'query', + 'schema' => ['description' => 'Specifies whether to perform a dry run. This parameter is used only to check whether the data source is valid. Valid values: true and false.', 'type' => 'boolean', 'required' => false, 'title' => '', 'example' => 'true'], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => 'The feature name. Valid values:'."\n" - ."\n" - .'* ctr: CTR model.'."\n" - .'* pop: popularity model.'."\n" - .'* category: category model.'."\n" - .'* hot: hotword model.'."\n" - .'* hint: hint model.'."\n" - .'* suggest: drop-down suggestion model.'."\n" - .'* analyzer: tokenization model.'."\n" - .'* termweight: term weight model.'."\n" - .'* synonym: synonym model.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'ctr', + 'description' => 'The response body.', + 'type' => 'object', + 'properties' => [ + 'requestId' => ['description' => 'The request ID.', 'type' => 'string', 'title' => '', 'example' => 'D77D0DAF-790D-F5F5-A9C0-133738165014'], + 'result' => [ + 'description' => 'The details of the A/B test scenario.'."\n" + .'For more information, see [ABTestScene](~~173618~~).', + 'type' => 'object', + 'properties' => [ + 'created' => ['description' => 'The time when the scenario was created.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '1596527691'], + 'params' => ['description' => 'The parameters of the experiment.', 'type' => 'object', 'title' => '', 'example' => '{}'], + 'traffic' => ['description' => 'The percentage of traffic that is allocated to the A/B test. Valid values: 0 to 100.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '111'], + 'online' => ['description' => 'The status of the test.'."\n" + ."\n" + .'- true: The test is started.'."\n" + ."\n" + .'- false: The test is stopped.', 'type' => 'boolean', 'title' => '', 'example' => 'true'], + 'name' => ['description' => 'The alias of the scenario.', 'type' => 'string', 'title' => '', 'example' => 'kevintest22'], + 'updated' => ['description' => 'The time when the scenario was last modified.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '1596527691'], + 'id' => ['description' => 'The ID of the scenario.', 'type' => 'string', 'title' => '', 'example' => '20614'], + ], + 'example' => '{}', + 'title' => '', + ], + ], + 'example' => '{}', + 'title' => '', ], ], - ], - 'responses' => [ - 200 => [ + '5XX' => [ 'schema' => [ - 'description' => 'The parameter body.'."\n", 'type' => 'object', 'properties' => [ - 'Status' => [ - 'description' => 'The status of the request.'."\n", - 'type' => 'string', - 'example' => 'OK', - ], - 'HttpCode' => [ - 'description' => 'The HTTP status code.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '200', - ], - 'RequestId' => [ - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => '98724351-D6B2-5D8A-B089-7FFD1821A7E9', - ], - 'Message' => [ - 'description' => 'The error message. If no error occurs, this parameter is left empty.'."\n", - 'type' => 'string', - 'example' => 'version not exist.', - ], - 'Code' => [ - 'description' => 'The error code.'."\n", - 'type' => 'string', - 'example' => 'Version.NotExist', - ], - 'Latency' => [ - 'description' => 'The time consumed for the request, in milliseconds.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '123', - ], + 'code' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'message' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'requestId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'httpCode' => ['type' => 'integer', 'format' => 'int32', 'description' => '', 'title' => '', 'example' => ''], ], - 'example' => '{ "status" : "OK", "requestId" : "", "httpCode": 200, "code": "", "message": "", "latency" : 123, "result" : { } }', + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Status\\": \\"OK\\",\\n \\"HttpCode\\": 200,\\n \\"RequestId\\": \\"98724351-D6B2-5D8A-B089-7FFD1821A7E9\\",\\n \\"Message\\": \\"version not exist.\\",\\n \\"Code\\": \\"Version.NotExist\\",\\n \\"Latency\\": 123\\n}","type":"json"}]', - 'title' => 'CreateFunctionInstance', - 'description' => 'You can call the [GetFunctionCurrentVersion](~~421377~~) operation to query the latest version of a feature. The response of the operation includes the createParameters parameter that is used to create an algorithm instance, the usageParameters parameter, and the requirements for setting these parameters.'."\n", - 'requestParamsDescription' => '### Sample requests (In this example, the functionName parameter is set to ctr.)'."\n" - ."\n" - .' POST /v4/openapi/app-groups/my-app/functions/ctr/instances'."\n" - .' {'."\n" - .' "instanceName": "my_ctr",'."\n" - .' "modelType": "tf_checkpoint",'."\n" - .' "functionType": "PAAS",'."\n" - .' "cron": "0 0 ? * 0,1,3,5",'."\n" - .' "description": "",'."\n" - .' "createParameters": ['."\n" - .' {'."\n" - .' "name": "id_field",'."\n" - .' "value": "id"'."\n" - .' },'."\n" - .' {'."\n" - .' "name": "title_field",'."\n" - .' "value": "title"'."\n" - .' }'."\n" - .' ],'."\n" - .' "usageParameters": []'."\n" - .' }'."\n" - ."\n" - .'### Sample requests (In this example, the functionName parameter is set to hot.)'."\n" - ."\n" - .' POST /v4/openapi/app-groups/my-app/functions/hot/instances'."\n" - .' {'."\n" - .' "instanceName":"my_hot",'."\n" - .' "modelType":"offline_inference",'."\n" - .' "functionType":"PAAS",'."\n" - .' "createParameters":['."\n" - .' {'."\n" - .' "name":"filter",'."\n" - .' "value":"biz_type != 1"'."\n" - .' }'."\n" - .' ],'."\n" - .' "usageParameters": ['."\n" - .' {'."\n" - .' "name":"allow_dict_id",'."\n" - .' "value":"123"'."\n" - .' },'."\n" - .' {'."\n" - .' "name":"deny_dict_id",'."\n" - .' "value":"456"'."\n" - .' }'."\n" - .' ],'."\n" - .' "cron":"12 4 ? * 1,2,3,4,5,6,0"'."\n" - .' }'."\n", - 'responseParamsDescription' => '### Sample success responses'."\n" + 'title' => 'UpdateABTestScene', + 'requestParamsDescription' => '**Request body**'."\n" ."\n" - .' {'."\n" - .' "status" : "OK",'."\n" - .' "requestId" : "98724351-D6B2-5D8A-B089-7FFD1821A7E9",'."\n" - .' "httpCode": 200,'."\n" - .' "code": "",'."\n" - .' "message": "",'."\n" - .' "latency" : 123,'."\n" - .' "result" : {}'."\n" - .' }'."\n", - ], - 'DescribeAppGroup' => [ - 'path' => '/v4/openapi/app-groups/{appGroupIdentity}', - 'methods' => [ - 'get', + .'| Parameter | Type | Required | Example | Description |'."\n" + .'| --------- | ------ | -------- | ------------- | ----------------------------- |'."\n" + .'| name | String | Yes | "kevintest22" | The alias of the scenario. |'."\n" + .'| values[] | String | Yes | "kevintest22" | The identity of the scenario. |', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'opensearch:UpdateApp', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'OpenSearch', 'resourceType' => 'AbTestScene', 'arn' => 'acs:opensearch:{#regionId}:{#accountId}:app-groups/{#AppGroupId}'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"D77D0DAF-790D-F5F5-A9C0-133738165014\\",\\n \\"result\\": {\\n \\"created\\": 1596527691,\\n \\"params\\": {},\\n \\"traffic\\": 111,\\n \\"online\\": true,\\n \\"name\\": \\"kevintest22\\",\\n \\"updated\\": 1596527691,\\n \\"id\\": \\"20614\\"\\n }\\n}","type":"json"}]', + 'translator' => 'manual', + ], + 'UpdateAppGroupDeleteProtection' => [ + 'path' => '/v4/openapi/app-groups/{appGroupIdentity}/delete-protection', + 'methods' => ['put'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'get', - 'abilityTreeCode' => '55169', - 'abilityTreeNodes' => [ - 'FEATUREopensearchGVH0IN', - 'FEATUREopensearch447AAX', - 'FEATUREopensearch5OZOSP', - ], + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATUREopensearchGVH0IN', 'FEATUREopensearch447AAX', 'FEATUREopensearch5OZOSP'], + 'tenantRelevance' => 'tenant', ], 'parameters' => [ [ 'name' => 'appGroupIdentity', 'in' => 'path', - 'schema' => [ - 'description' => 'The application name.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'my_app_group_name', - ], + 'schema' => ['description' => 'The name or ID of the application group.', 'type' => 'string', 'required' => false, 'example' => 'my_app_group_name', 'title' => ''], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', + 'schema' => ['description' => 'The request body.', 'type' => 'object', 'required' => false, 'example' => '{'."\n" + .' "deleteProtection": "on"'."\n" + .'}', 'title' => ''], ], ], 'responses' => [ @@ -20196,1111 +17147,806 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'requestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '0A6EB64B-B4C8-CF02-810F-E660812972FF', - ], + 'requestId' => ['description' => 'The request ID.', 'type' => 'string', 'title' => '', 'example' => '80326EFE-485F-46E7-B291-5A1DD08D2198'], 'result' => [ - 'description' => 'The information about the application.'."\n", 'type' => 'object', 'properties' => [ - 'created' => [ - 'description' => 'The timestamp when the application was created.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1575442875', - ], - 'currentVersion' => [ - 'description' => 'The ID of the current online version.'."\n", - 'type' => 'string', - 'example' => '110116134', - ], - 'pendingSecondRankAlgoDeploymentId' => [ - 'description' => 'The ID of the fine sort expression that is being created.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '0', - ], - 'lockMode' => [ - 'description' => 'The lock state. Valid values:'."\n" - ."\n" - .'* Unlock: The instance is unlocked.'."\n" - .'* LockByExpiration: The instance is automatically locked after it expires.'."\n" - .'* ManualLock: The instance is manually locked.'."\n", - 'type' => 'string', - 'example' => 'Unlock', - ], - 'updated' => [ - 'description' => 'The timestamp when the application was last updated.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1578916076', - ], - 'id' => [ - 'description' => 'The application ID.'."\n", - 'type' => 'string', - 'example' => '110116134', - ], - 'chargeType' => [ - 'description' => 'The billing method. Valid values:'."\n" - ."\n" - .'* POSTPAY: pay-as-you-go.'."\n" - .'* PREPAY: subscription.'."\n", - 'type' => 'string', - 'example' => 'POSTPAY', - ], - 'hasPendingQuotaReviewTask' => [ - 'description' => 'The approval state of the quotas. Valid values:'."\n" - ."\n" - .'* 0: The application is in service.'."\n" - .'* 1: The quotas are being reviewed.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '0', - ], - 'secondRankAlgoDeploymentId' => [ - 'description' => 'The ID of the created fine sort expression.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '0', - ], - 'name' => [ - 'description' => 'The application name.'."\n", - 'type' => 'string', - 'example' => 'os_function_test_v1', - ], - 'instanceId' => [ - 'description' => 'The instance ID.'."\n", - 'type' => 'string', - 'example' => '-', - ], - 'processingOrderId' => [ - 'description' => 'The ID of the order that is not complete.'."\n", - 'type' => 'string', - 'example' => '-', - ], - 'chargingWay' => [ - 'description' => 'The billable item. Valid values:'."\n" - ."\n" - .'* 1: computing resources.'."\n" - .'* 2: queries per second (QPS).'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'type' => [ - 'description' => 'The type of the application. Valid values:'."\n" - ."\n" - .'* standard: a High-performance Search Edition application.'."\n" - .'* enhanced: an Industry Algorithm Edition application.', - 'type' => 'string', - 'example' => 'enhanced', - ], - 'status' => [ - 'description' => 'The state of the application. Valid values:'."\n" - ."\n" - .'* producing: The application is being created.'."\n" - .'* review_pending: The application is being reviewed.'."\n" - .'* config_pending: The application is to be configured.'."\n" - .'* normal: The application is in service.'."\n" - .'* frozen: The application is frozen.'."\n", - 'type' => 'string', - 'example' => 'normal', - ], - 'projectId' => [ - 'description' => 'The name of the A/B test group.'."\n", - 'type' => 'string', - 'example' => '-', - ], - 'switchedTime' => [ - 'description' => 'The timestamp when the current online version was published.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '0', - ], - 'commodityCode' => [ - 'description' => 'The commodity code.'."\n", - 'type' => 'string', - 'example' => 'opensearch', - ], - 'expireOn' => [ - 'description' => 'The expiration time.'."\n", - 'type' => 'string', - 'example' => '-', - ], - 'domain' => [ - 'description' => 'The industry of the application.'."\n", - 'type' => 'string', - 'example' => 'ecommerce', - ], - 'description' => [ - 'description' => 'The description of the application.'."\n", - 'type' => 'string', - 'example' => '-', - ], - 'firstRankAlgoDeploymentId' => [ - 'description' => 'The ID of the created rough sort expression.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '0', - ], - 'produced' => [ - 'description' => 'Indicates whether the application is created. Valid values:'."\n" - ."\n" - .'* 0: The application is being created.'."\n" - .'* 1: The application is created.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'lockedByExpiration' => [ - 'description' => 'Indicates whether the instance is automatically locked after it expires.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '0', - ], - 'quota' => [ - 'description' => 'The information about the quotas of the application.'."\n", - 'type' => 'object', - 'properties' => [ - 'spec' => [ - 'description' => 'The specifications. Valid values:'."\n" - ."\n" - .'* opensearch.share.junior: basic.'."\n" - .'* opensearch.share.common: shared general-purpose.'."\n" - .'* opensearch.share.compute: shared computing.'."\n" - .'* opensearch.share.storage: shared storage.'."\n" - .'* opensearch.private.common: exclusive general-purpose.'."\n" - .'* opensearch.private.compute: exclusive computing.'."\n" - .'* opensearch.private.storage: exclusive storage.'."\n", - 'type' => 'string', - 'example' => 'opensearch.share.common', - ], - 'docSize' => [ - 'description' => 'The storage capacity. Unit: GB.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'computeResource' => [ - 'description' => 'The computing resources. Unit: logical computing unit (LCU).'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '20', - ], - ], - ], - 'tags' => [ - 'description' => 'The application tags.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'key' => [ - 'description' => 'The tag key.'."\n", - 'type' => 'string', - 'example' => 'foo', - ], - 'value' => [ - 'description' => 'The tag value'."\n", - 'type' => 'string', - 'example' => 'bar', - ], - ], - ], - ], - 'resourceGroupId' => [ - 'description' => 'The ID of the resource group to which the network instance belongs.'."\n", - 'type' => 'string', - 'example' => 'rg-acfmoiyerh6nzly', - ], - 'engineType' => [ - 'description' => 'The engine type.'."\n", - 'type' => 'string', - 'example' => 'ha3', - ], + 'instanceId' => ['description' => 'The instance ID.', 'type' => 'string', 'example' => 'ops-cn-m7r1ywo2h1b', 'title' => ''], ], + 'description' => 'The result.', + 'title' => '', + 'example' => '', ], ], - 'description' => '', + 'title' => '', + 'description' => 'The response object.', + 'example' => '', ], ], - '5XX' => [ - 'schema' => [ - 'type' => 'object', - 'properties' => [ - 'code' => [ - 'type' => 'string', - ], - 'message' => [ - 'type' => 'string', - ], - 'requestId' => [ - 'type' => 'string', - ], - 'httpCode' => [ - 'type' => 'integer', - 'format' => 'int32', - ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'UpdateAppGroupDeleteProtection', + 'summary' => 'Updates the delete protection status for an application group.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'opensearch:UpdateAppGroupDeleteProtection', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'OpenSearch', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"requestId\\": \\"0A6EB64B-B4C8-CF02-810F-E660812972FF\\",\\n \\"result\\": {\\n \\"created\\": 1575442875,\\n \\"currentVersion\\": \\"110116134\\",\\n \\"pendingSecondRankAlgoDeploymentId\\": 0,\\n \\"lockMode\\": \\"Unlock\\",\\n \\"updated\\": 1578916076,\\n \\"id\\": \\"110116134\\",\\n \\"chargeType\\": \\"POSTPAY\\",\\n \\"hasPendingQuotaReviewTask\\": 0,\\n \\"secondRankAlgoDeploymentId\\": 0,\\n \\"name\\": \\"os_function_test_v1\\",\\n \\"instanceId\\": \\"-\\",\\n \\"processingOrderId\\": \\"-\\",\\n \\"chargingWay\\": 1,\\n \\"type\\": \\"enhanced\\",\\n \\"status\\": \\"normal\\",\\n \\"projectId\\": \\"-\\",\\n \\"switchedTime\\": 0,\\n \\"commodityCode\\": \\"opensearch\\",\\n \\"expireOn\\": \\"-\\",\\n \\"domain\\": \\"ecommerce\\",\\n \\"description\\": \\"-\\",\\n \\"firstRankAlgoDeploymentId\\": 0,\\n \\"produced\\": 1,\\n \\"lockedByExpiration\\": 0,\\n \\"quota\\": {\\n \\"spec\\": \\"opensearch.share.common\\",\\n \\"docSize\\": 1,\\n \\"computeResource\\": 20\\n },\\n \\"tags\\": [\\n {\\n \\"key\\": \\"foo\\",\\n \\"value\\": \\"bar\\"\\n }\\n ],\\n \\"resourceGroupId\\": \\"rg-acfmoiyerh6nzly\\",\\n \\"engineType\\": \\"ha3\\"\\n }\\n}","errorExample":""},{"type":"xml","example":"0A6EB64B-B4C8-CF02-810F-E660812972FF\\n\\n 110116134\\n os_function_test_v1\\n 110116134\\n 0\\n \\n 1\\n 20\\n opensearch.share.common\\n \\n 1\\n enhanced\\n 100298792\\n \\n POSTPAY\\n \\n \\n opensearch\\n \\n 0\\n 0\\n 0\\n \\n 1\\n 0\\n 0\\n 1575442875\\n 1578916076\\n normal\\n Unlock\\n","errorExample":""}]', - 'title' => 'DescribeAppGroup', - 'summary' => 'Queries the details of an OpenSearch application.', - 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"80326EFE-485F-46E7-B291-5A1DD08D2198\\",\\n \\"result\\": {\\n \\"instanceId\\": \\"ops-cn-m7r1ywo2h1b\\"\\n }\\n}","type":"json"}]', + 'translator' => 'machine', ], - 'ValidateDataSources' => [ - 'summary' => 'Verifies data sources.', - 'path' => '/v4/openapi/assist/data-sources/validations', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'UpdateFetchFields' => [ + 'path' => '/v4/openapi/app-groups/{appGroupIdentity}/apps/{appId}/fetch-fields', + 'methods' => ['put'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], + 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'get', + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATUREopensearchYVAV9H', 'FEATUREopensearchBZ8NMO'], ], 'parameters' => [ + [ + 'name' => 'dryRun', + 'in' => 'query', + 'schema' => ['description' => 'Specifies whether the request is a dry run.', 'type' => 'boolean', 'required' => false, 'title' => '', 'example' => 'true'], + ], + [ + 'name' => 'appGroupIdentity', + 'in' => 'path', + 'schema' => ['description' => 'The name of the application group.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'title' => '', 'example' => '“my_app_group_name”'], + ], + [ + 'name' => 'appId', + 'in' => 'path', + 'schema' => ['description' => 'The ID of the application version.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true, 'title' => '', 'example' => '110157886'], + ], [ 'name' => 'body', 'in' => 'body', + 'style' => 'json', 'schema' => [ - 'description' => 'The request parameter. For more information, see [DataSource](~~170005~~).'."\n", + 'description' => 'The request body.', + 'type' => 'array', + 'items' => ['description' => 'The field array.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => '\'["id", "name", "title"]\''], 'required' => false, - '$ref' => '#/components/schemas/DataSource', + 'maxItems' => 100, + 'title' => '', + 'example' => '', ], ], ], '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' => '8FA2B338-AFDC-46B4-A132-B5487820C2BF', - ], - 'result' => [ - 'description' => 'The result returned.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The result that was returned.'."\n", - 'type' => 'object', - 'properties' => [ - 'code' => [ - 'description' => 'The code returned for the request.'."\n", - 'type' => 'string', - 'example' => 'SUCCEED', - ], - 'message' => [ - 'description' => 'The status of the execution.'."\n", - 'type' => 'string', - 'example' => 'successful', - ], - 'dataSource' => [ - 'description' => 'The data source.'."\n", - 'type' => 'object', - 'properties' => [ - 'tableName' => [ - 'description' => 'The name of the table.'."\n", - 'type' => 'string', - 'example' => 'user_activity_decision', - ], - 'type' => [ - 'description' => 'The type of the data source.', - 'type' => 'string', - 'example' => 'rds', - ], - 'parameters' => [ - 'description' => 'The parameters of the data source.', - 'type' => 'object', - 'example' => '{}', - ], - ], - 'example' => '{}', - ], - ], - 'example' => '{}', - ], - 'example' => '[]', - ], + 'result' => ['description' => 'Indicates whether the operation was successful.', 'type' => 'boolean', 'title' => '', 'example' => 'true'], + 'requestId' => ['description' => 'The request ID.', 'type' => 'string', 'title' => '', 'example' => 'D77D0DAF-790D-F5F5-A9C0-133738165014'], ], - 'example' => '{}', + 'description' => '', + 'title' => '', + 'example' => '', + ], + ], + '5XX' => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'code' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'httpCode' => ['type' => 'integer', 'format' => 'int32', 'description' => '', 'title' => '', 'example' => ''], + 'requestId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'message' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"8FA2B338-AFDC-46B4-A132-B5487820C2BF\\",\\n \\"result\\": [\\n {\\n \\"code\\": \\"SUCCEED\\",\\n \\"message\\": \\"校验成功\\",\\n \\"dataSource\\": {\\n \\"tableName\\": \\"user_activity_decision\\",\\n \\"type\\": \\"rds\\",\\n \\"parameters\\": {}\\n }\\n }\\n ]\\n}","type":"json"}]', - 'title' => 'ValidateDataSources', - ], - 'ReplaceAppGroupCommodityCode' => [ - 'path' => '/v4/openapi/app-groups/{appGroupIdentity}/actions/to-instance-typed', - 'methods' => [ - 'post', + 'title' => 'UpdateFetchFields', + 'summary' => 'This operation supports dry runs.', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'opensearch:UpdateApp', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'OpenSearch', 'resourceType' => 'App', 'arn' => 'acs:opensearch:{#regionId}:{#accountId}:apps/{#AppId}'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"result\\": true,\\n \\"requestId\\": \\"D77D0DAF-790D-F5F5-A9C0-133738165014\\"\\n}","type":"json"}]', + 'translator' => 'manual', + ], + 'UpdateFunctionDefaultInstance' => [ + 'summary' => 'Sets the default algorithm instance for the specified application. The new algorithm instance automatically overwrites the previously set default instance. If no instance is specified, the default instance is canceled.', + 'path' => '/v4/openapi/app-groups/{appGroupIdentity}/functions/{functionName}/default-instance', + 'methods' => ['put'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'none', - 'abilityTreeCode' => '55260', - 'abilityTreeNodes' => [ - 'FEATUREopensearch3UFA61', - ], + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATUREopensearchZAE4HR'], ], 'parameters' => [ [ - 'name' => 'appGroupIdentity', - 'in' => 'path', + 'name' => 'Body', + 'in' => 'body', + 'style' => 'json', 'schema' => [ - 'description' => 'The name of the application'."\n", - 'type' => 'string', - 'required' => true, + 'title' => '', + 'description' => 'The request body.', + 'type' => 'object', + 'properties' => [ + 'instanceName' => ['description' => 'The name of the instance.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => '"pop_test"'], + ], + 'required' => false, 'docRequired' => true, - 'example' => 'my_app', + 'example' => '{}', ], ], + [ + 'name' => 'appGroupIdentity', + 'in' => 'path', + 'schema' => ['description' => 'The name of the application.', 'type' => 'string', 'required' => true, 'example' => '"app_group_name"', 'title' => ''], + ], + [ + 'name' => 'functionName', + 'in' => 'path', + 'schema' => ['description' => 'The name of the function.', 'type' => 'string', 'required' => true, 'example' => 'pop', 'title' => ''], + ], ], 'responses' => [ 200 => [ 'schema' => [ - 'description' => 'The response body.'."\n", + 'description' => 'The response.', 'type' => 'object', 'properties' => [ - 'requestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => 'AC5F78BA-66B9-545B-9CF1-8F542E682E1F', - ], - 'result' => [ - 'description' => 'The returned result.'."\n", - 'type' => 'object', - 'properties' => [ - 'created' => [ - 'description' => 'The timestamp when the application was created.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1588054131', - ], - 'currentVersion' => [ - 'description' => 'The ID of the current online version.'."\n", - 'type' => 'string', - 'example' => '100302903', - ], - 'pendingSecondRankAlgoDeploymentId' => [ - 'description' => 'The ID of the fine sort expression that is being created.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '0', - ], - 'type' => [ - 'description' => 'The type of the application.'."\n", - 'type' => 'string', - 'example' => '-', - ], - 'chargingWay' => [ - 'description' => 'The billing type. Valid values:'."\n" - ."\n" - .'* 1: computing resources.'."\n" - .'* 2: queries per second (QPS).'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'lockMode' => [ - 'description' => 'The lock state. Valid values:'."\n" - ."\n" - .'* Unlock: The instance is unlocked.'."\n" - .'* LockByExpiration: The instance is automatically locked after it expires.'."\n" - .'* ManualLock: The instance is manually locked.'."\n", - 'type' => 'string', - 'example' => 'Unlock', - ], - 'status' => [ - 'description' => 'The status of the application.'."\n", - 'type' => 'string', - 'example' => 'normal', - ], - 'updated' => [ - 'description' => 'The timestamp when the application was updated.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1581065904', - ], - 'chargeType' => [ - 'description' => 'The billing method. Valid values:'."\n" - ."\n" - .'* POSTPAY: pay-as-you-go.'."\n" - .'* PREPAY: subscription.'."\n", - 'type' => 'string', - 'example' => 'POSTPAY', - ], - 'id' => [ - 'description' => 'The application ID.'."\n", - 'type' => 'string', - 'example' => '-', - ], - 'hasPendingQuotaReviewTask' => [ - 'description' => 'The approval state of the quotas. Valid values:'."\n" - ."\n" - .'* 0: The approval status is normal.'."\n" - .'* 1: The quotas are being approved.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '0', - ], - 'projectId' => [ - 'description' => 'The name of the A/B test group.'."\n", - 'type' => 'string', - 'example' => '-', - ], - 'secondRankAlgoDeploymentId' => [ - 'description' => 'The ID of the fine sort expression.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '0', - ], - 'commodityCode' => [ - 'description' => 'The code of the commodity.'."\n", - 'type' => 'string', - 'example' => 'opensearch', - ], - 'switchedTime' => [ - 'description' => 'The timestamp when the current online version was published.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1590486386', - ], - 'expireOn' => [ - 'description' => 'The expiration time.'."\n", - 'type' => 'string', - 'example' => '-', - ], - 'description' => [ - 'description' => 'The description of the application.'."\n", - 'type' => 'string', - 'example' => '""', - ], - 'firstRankAlgoDeploymentId' => [ - 'description' => 'The ID of the rough sort expression.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '0', - ], - 'lockedByExpiration' => [ - 'description' => 'Indicates whether the instance is automatically locked after it expires. Valid values:'."\n" - ."\n" - .'* 0: The instance is not automatically locked after it expires.'."\n" - .'* 1: The instance is automatically locked after it expires.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '0', - ], - 'produced' => [ - 'description' => 'Indicates whether the order is produced.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '0', - ], - 'name' => [ - 'description' => 'The name of the order.'."\n", - 'type' => 'string', - 'example' => '-', - ], - 'processingOrderId' => [ - 'description' => 'The ID of the order that is in progress.'."\n", - 'type' => 'string', - 'example' => '-', - ], - 'instanceId' => [ - 'description' => 'The instance ID.'."\n", - 'type' => 'string', - 'example' => '-', - ], - 'versions' => [ - 'description' => 'The versions.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The version.'."\n", - 'type' => 'string', - 'example' => '-', - ], - ], - 'quota' => [ - 'description' => 'The configuration information.'."\n", - 'type' => 'object', - 'properties' => [ - 'spec' => [ - 'description' => 'The specifications configured.'."\n", - 'type' => 'string', - 'example' => '-', - ], - 'docSize' => [ - 'description' => 'The storage capacity.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'computeResource' => [ - 'description' => 'The number of computing resources configured.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '20', - ], - ], - ], - ], - 'example' => '{}', - ], + 'Status' => ['description' => 'The request status.', 'type' => 'string', 'example' => 'OK', 'title' => ''], + 'HttpCode' => ['description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int64', 'example' => '200', 'title' => ''], + 'RequestId' => ['description' => 'The ID of the request.', 'type' => 'string', 'example' => 'A4D487A9-A456-5AA5-A9C6-B7BF2889CF74', 'title' => ''], + 'Message' => ['description' => 'The error message.', 'type' => 'string', 'example' => 'success', 'title' => ''], + 'Code' => ['description' => 'The error code.', 'type' => 'string', 'example' => 'DefaultInstance.SetFail', 'title' => ''], + 'Latency' => ['description' => 'The time consumed for the request, in milliseconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '123', 'title' => ''], ], + 'title' => '', + 'example' => '', ], ], - '5XX' => [ - 'schema' => [ - 'type' => 'object', - 'properties' => [ - 'code' => [ - 'type' => 'string', - ], - 'httpCode' => [ - 'type' => 'integer', - 'format' => 'int32', - ], - 'requestId' => [ - 'type' => 'string', - ], - 'message' => [ - 'type' => 'string', - ], + ], + 'title' => 'UpdateFunctionDefaultInstance', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateFunctionDefaultInstance'], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'opensearch:WriteFunction', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'OpenSearch', 'resourceType' => 'FunctionInstance', 'arn' => 'acs:opensearch:{#regionId}:{#accountId}:apps/{#AppGroupId}'], ], ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"AC5F78BA-66B9-545B-9CF1-8F542E682E1F\\",\\n \\"result\\": {\\n \\"created\\": 1588054131,\\n \\"currentVersion\\": \\"100302903\\",\\n \\"pendingSecondRankAlgoDeploymentId\\": 0,\\n \\"type\\": \\"-\\",\\n \\"chargingWay\\": 1,\\n \\"lockMode\\": \\"Unlock\\",\\n \\"status\\": \\"normal\\",\\n \\"updated\\": 1581065904,\\n \\"chargeType\\": \\"POSTPAY\\",\\n \\"id\\": \\"-\\",\\n \\"hasPendingQuotaReviewTask\\": 0,\\n \\"projectId\\": \\"-\\",\\n \\"secondRankAlgoDeploymentId\\": 0,\\n \\"commodityCode\\": \\"opensearch\\",\\n \\"switchedTime\\": 1590486386,\\n \\"expireOn\\": \\"-\\",\\n \\"description\\": \\"\\\\\\"\\\\\\"\\",\\n \\"firstRankAlgoDeploymentId\\": 0,\\n \\"lockedByExpiration\\": 0,\\n \\"produced\\": 0,\\n \\"name\\": \\"-\\",\\n \\"processingOrderId\\": \\"-\\",\\n \\"instanceId\\": \\"-\\",\\n \\"versions\\": [\\n \\"-\\"\\n ],\\n \\"quota\\": {\\n \\"spec\\": \\"-\\",\\n \\"docSize\\": 1,\\n \\"computeResource\\": 20\\n }\\n }\\n}","type":"json"}]', - 'title' => 'ReplaceAppGroupCommodityCode', - 'summary' => 'Converts a service-based application to an instance-based application.', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Status\\": \\"OK\\",\\n \\"HttpCode\\": 200,\\n \\"RequestId\\": \\"A4D487A9-A456-5AA5-A9C6-B7BF2889CF74\\",\\n \\"Message\\": \\"success\\",\\n \\"Code\\": \\"DefaultInstance.SetFail\\",\\n \\"Latency\\": 123\\n}","type":"json"}]', + 'translator' => 'manual', ], - 'ListSortScripts' => [ - 'summary' => 'Queries all sort scripts of an application version.', - 'path' => '/v4/openapi/app-groups/{appGroupIdentity}/apps/{appVersionId}/sort-scripts', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'UpdateFunctionInstance' => [ + 'summary' => 'Updates the configuration of a function instance.', + 'path' => '/v4/openapi/app-groups/{appGroupIdentity}/functions/{functionName}/instances/{instanceName}', + 'methods' => ['put'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'list', + 'operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREopensearchN8M8WS', - ], + 'abilityTreeNodes' => ['FEATUREopensearch3QPM0K', 'FEATUREopensearchN8M8WS'], ], 'parameters' => [ [ - 'name' => 'appGroupIdentity', - 'in' => 'path', - 'schema' => [ - 'description' => 'The name or ID of the application.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'my_app', - ], - ], - [ - 'name' => 'appVersionId', - 'in' => 'path', - 'schema' => [ - 'description' => 'The version ID of the application.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '110142366', - ], - ], - ], - 'responses' => [ - 200 => [ + 'name' => 'Body', + 'in' => 'body', + 'style' => 'json', 'schema' => [ + 'title' => '', + 'description' => 'The request body.', 'type' => 'object', 'properties' => [ - 'requestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => 'ABCDEFGH', + 'cron' => ['description' => 'The schedule for periodic training. The value must be a cron expression in the format of Minutes Hours DayofMonth Month DayofWeek. If you leave this parameter empty, periodic training is disabled by default. For DayofWeek, 0 indicates Sunday.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => '"0 3 ? * 0,1,3,5"'], + 'createParameters' => [ + 'title' => '', + 'description' => 'The list of creation parameters.', + 'type' => 'array', + 'items' => [ + 'description' => 'The parameter details.', + 'type' => 'object', + 'properties' => [ + 'name' => ['description' => 'The name of the parameter.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => 'title_field'], + 'value' => ['description' => 'The value of the parameter.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => 'title'], + ], + 'required' => false, + 'example' => '{}', + 'title' => '', + ], + 'required' => false, + 'example' => '{ "name": "title_field", "value": "title" }', ], - 'result' => [ - 'description' => 'The scripts.'."\n", + 'usageParameters' => [ + 'title' => '', + 'description' => 'The list of usage parameters.', 'type' => 'array', 'items' => [ + 'description' => 'The parameter details.', 'type' => 'object', 'properties' => [ - 'type' => [ - 'description' => 'The type of the script.'."\n", - 'type' => 'string', - 'example' => 'cava_script', - ], - 'scope' => [ - 'description' => 'The sort phase to which the script applies.'."\n", - 'type' => 'string', - 'example' => 'second_rank', - ], - 'createTime' => [ - 'description' => 'The time when the script was created.'."\n", - 'type' => 'string', - 'example' => '2020-04-02 20:21:14', - ], - 'status' => [ - 'description' => 'The status of the script. Valid values:'."\n" - ."\n" - .'* configurable: The script is created, but no script files are uploaded.'."\n" - .'* not compiled: The script is not compiled.'."\n" - .'* compile failed: The compilation of the script failed.'."\n" - .'* compile successful: The script is compiled.'."\n" - .'* released: The script is published.'."\n", - 'type' => 'string', - 'example' => 'released', - ], - 'modifyTime' => [ - 'description' => 'The time when the script was last modified.'."\n", - 'type' => 'string', - 'example' => '2020-04-02 21:21:14', - ], - 'scriptName' => [ - 'description' => 'The name of the script.'."\n", - 'type' => 'string', - 'example' => 'test', - ], + 'name' => ['description' => 'The name of the parameter.', 'type' => 'string', 'required' => false, 'example' => 'allow_dict_id', 'title' => ''], + 'value' => ['description' => 'The value of the parameter.', 'type' => 'string', 'required' => false, 'example' => '123', 'title' => ''], ], + 'required' => false, + 'title' => '', + 'example' => '', ], + 'required' => false, + 'example' => '', ], + 'description' => ['description' => 'The description of the instance.', 'type' => 'string', 'example' => 'Test instance', 'title' => '', 'required' => false], ], - 'description' => '', + 'required' => false, + 'example' => '{}', ], ], - '5XX' => [ + [ + 'name' => 'appGroupIdentity', + 'in' => 'path', + 'schema' => ['description' => 'The name of the OpenSearch application.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => '"app_group_name"'], + ], + [ + 'name' => 'functionName', + 'in' => 'path', + 'schema' => ['description' => 'The name of the feature.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => '"ctr"'], + ], + [ + 'name' => 'instanceName', + 'in' => 'path', + 'schema' => ['description' => 'The name of the instance.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => '"ctr_test"'], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ + 'title' => '', + 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'code' => [ - 'type' => 'string', - ], - 'message' => [ - 'type' => 'string', - ], - 'requestId' => [ - 'type' => 'string', - ], - 'httpCode' => [ - 'type' => 'integer', - 'format' => 'int32', - ], + 'Status' => ['description' => 'The request status.'."\n" + ."\n" + .'- ```'."\n" + .' OK: The request is successful.'."\n" + .' ```'."\n" + .'- ```'."\n" + .' FAIL: The request failed.'."\n" + .' ```', 'type' => 'string', 'example' => 'OK', 'title' => ''], + 'HttpCode' => ['description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int64', 'example' => '200', 'title' => ''], + 'RequestId' => ['description' => 'The ID of the request.', 'type' => 'string', 'example' => '"3A809095-C554-5CF5-8FCE-BE19D4673790"', 'title' => ''], + 'Message' => ['description' => 'The error message.', 'type' => 'string', 'title' => '', 'example' => '"instance not exist."'], + 'Code' => ['description' => 'The error code.', 'type' => 'string', 'title' => '', 'example' => '"Instance.NotExist"'], + 'Latency' => ['description' => 'The time consumed by the request. Unit: milliseconds (ms).', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '10'], ], + 'example' => '{}', ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"requestId\\": \\"ABCDEFGH\\",\\n \\"result\\": [\\n {\\n \\"type\\": \\"cava_script\\",\\n \\"scope\\": \\"second_rank\\",\\n \\"createTime\\": \\"2020-04-02 20:21:14\\",\\n \\"status\\": \\"released\\",\\n \\"modifyTime\\": \\"2020-04-02 21:21:14\\",\\n \\"scriptName\\": \\"test\\"\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"ABCDEFGH\\n\\n cava_script\\n second_rank\\n released\\n 2020-04-02 20:21:14\\n 2020-04-02 21:21:14\\n","errorExample":""}]', - 'title' => 'ListSortScripts', - 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' Error response'."\n" - .' {'."\n" - .' "requestId" : "ABCDEFGH",'."\n" - .' "code":"InvalidAppSpec",'."\n" - .' "message":"The cava scripts only support the private spec app.",'."\n" - .' "httpCode":400'."\n" - .' }'."\n", - 'extraInfo' => ' ', - ], - 'ListDataSourceTables' => [ - 'path' => '/v4/openapi/assist/data-sources/{dataSourceType}/tables', - 'methods' => [ - 'get', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Status\\": \\"OK\\",\\n \\"HttpCode\\": 200,\\n \\"RequestId\\": \\"\\\\\\"3A809095-C554-5CF5-8FCE-BE19D4673790\\\\\\"\\",\\n \\"Message\\": \\"\\\\\\"instance not exist.\\\\\\"\\",\\n \\"Code\\": \\"\\\\\\"Instance.NotExist\\\\\\"\\",\\n \\"Latency\\": 10\\n}","type":"json"}]', + 'title' => 'UpdateFunctionInstance', + 'requestParamsDescription' => '### Example: Update only createParameters and cron'."\n" + ."\n" + .'`PUT /v4/openapi/app-groups/my-app/functions/ctr/instances/ctr_test`'."\n" + ."\n" + .'```'."\n" + .'{'."\n" + .' "createParameters": ['."\n" + .' {'."\n" + .' "name": "param1",'."\n" + .' "value": "new value"'."\n" + .' }'."\n" + .' ],'."\n" + .' "cron": ""'."\n" + .'}'."\n" + .'```', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateFunctionInstance'], + ], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'opensearch:WriteFunction', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'OpenSearch', 'resourceType' => 'FunctionInstance', 'arn' => 'acs:opensearch:{#regionId}:{#accountId}:apps/{#AppGroupId}'], + ], + ], + ], ], + 'translator' => 'manual', + ], + 'UpdateFunctionResource' => [ + 'summary' => 'Updates an algorithm resource.', + 'path' => '/v4/openapi/app-groups/{appGroupIdentity}/functions/{functionName}/resources/{resourceName}', + 'methods' => ['put'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'get', + 'operationType' => 'update', + 'abilityTreeCode' => '173356', + 'abilityTreeNodes' => ['FEATUREopensearchUIICM8'], ], 'parameters' => [ [ - 'name' => 'dataSourceType', + 'name' => 'appGroupIdentity', 'in' => 'path', - 'schema' => [ - 'description' => 'The type of the data source. Valid values:'."\n" - ."\n" - .'* rds'."\n" - .'* polardb'."\n" - .'* odps'."\n" - .'* mysql'."\n" - .'* drds'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'rds', - ], + 'schema' => ['title' => '', 'description' => 'The ID of the application.', 'type' => 'string', 'required' => true, 'example' => 'my_app_group_name'], ], [ - 'name' => 'params', - 'in' => 'query', - 'schema' => [ - 'description' => 'The parameters of the data source. The value is a JSON string which must be encoded in the urlencode format.'."\n" - ."\n" - .'Different types of data sources use different parameters. For more information, see the following sections of the "DataSource" topic:'."\n" - ."\n" - .'* [rds](~~170005~~)'."\n" - .'* [polardb](~~170005~~)'."\n" - .'* [odps](~~170005~~)'."\n" - .'* [mysql](~~173627~~)'."\n" - .'* [drds](~~173627~~)'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '-', - ], + 'name' => 'functionName', + 'in' => 'path', + 'schema' => ['title' => '', 'description' => 'The name of the feature.', 'type' => 'string', 'required' => true, 'example' => 'rank'], ], - ], - 'responses' => [ - 200 => [ + [ + 'name' => 'resourceName', + 'in' => 'path', + 'schema' => ['title' => '', 'description' => 'The name of the resource.', 'type' => 'string', 'required' => true, 'example' => 'fg_json'], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', 'schema' => [ + 'description' => 'The request body.', 'type' => 'object', 'properties' => [ - 'requestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '0A6EB64B-B4C8-CF02-810F-E660812972FF', - ], - 'result' => [ - 'type' => 'array', - 'items' => [ - 'description' => 'The returned result.'."\n", - 'type' => 'string', - 'example' => '{}', + 'Data' => [ + 'description' => 'The data of the resource. The structure of this parameter varies based on the value of resourceType.', + 'type' => 'object', + 'properties' => [ + 'Content' => ['description' => 'The content of the file. This parameter is used for resources of the raw\\_file type.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => 'abc'], + 'Generators' => [ + 'description' => 'The list of feature generators. This parameter is used for resources of the feature\\_generator type.', + 'type' => 'array', + 'items' => [ + 'description' => 'A description of the feature generator.', + 'type' => 'object', + 'properties' => [ + 'Generator' => ['description' => 'The type of the feature generator.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => 'combo'], + 'Input' => [ + 'description' => 'The input.', + 'type' => 'object', + 'properties' => [ + 'Features' => [ + 'description' => 'A list of input features.', + 'type' => 'array', + 'items' => [ + 'description' => 'An input feature.', + 'type' => 'object', + 'properties' => [ + 'Name' => ['description' => 'The name of the feature.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => 'system_item_id'], + 'Type' => ['description' => 'The type of the feature.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => 'item'], + ], + 'required' => false, + 'title' => '', + 'example' => '', + ], + 'required' => false, + 'title' => '', + 'example' => '', + ], + ], + 'required' => false, + 'title' => '', + 'example' => '', + ], + 'Output' => ['description' => 'The name of the output feature.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => 'feature1'], + ], + 'required' => false, + 'title' => '', + 'example' => '', + ], + 'required' => false, + 'title' => '', + 'example' => '', + ], ], - 'description' => '', + 'required' => false, + 'title' => '', + 'example' => '', ], + 'Description' => ['description' => 'The description of the resource.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => 'updated description'], ], - 'description' => '', + 'required' => false, + 'title' => '', + 'example' => '', ], ], - '5XX' => [ + ], + 'responses' => [ + 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ - 'code' => [ - 'type' => 'string', - ], - 'message' => [ - 'type' => 'string', - ], - 'requestId' => [ - 'type' => 'string', - ], - 'httpCode' => [ - 'type' => 'integer', - 'format' => 'int32', - ], + 'Status' => ['description' => 'The status of the request.', 'type' => 'string', 'title' => '', 'example' => 'OK'], + 'HttpCode' => ['description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '200'], + 'RequestId' => ['description' => 'The ID of the request.', 'type' => 'string', 'title' => '', 'example' => '7E375703-5B12-5466-8B48-C4D01AE1291A'], + 'Message' => ['description' => 'The error message.', 'type' => 'string', 'title' => '', 'example' => 'Invalid request.'], + 'Code' => ['description' => 'The error code. This parameter is empty if the request is successful.', 'type' => 'string', 'title' => '', 'example' => 'InvalidRequest'], + 'Latency' => ['description' => 'The request latency. Unit: milliseconds.', 'type' => 'number', 'format' => 'double', 'title' => '', 'example' => '123'], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"requestId\\": \\"0A6EB64B-B4C8-CF02-810F-E660812972FF\\",\\n \\"result\\": [\\n \\"{}\\"\\n ]\\n}","errorExample":""},{"type":"xml","example":"0A6EB64B-B4C8-CF02-810F-E660812972FF\\ncate_test\\noffline_error\\nplugin\\nquota_test\\nsmoke\\nsmoke_1\\nsmoke_2\\nstudents","errorExample":""}]', - 'title' => 'ListDataSourceTables', - 'summary' => 'Obtains all data from a specified data source.', - 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', - ], - 'ListDataSourceTableFields' => [ - 'path' => '/v4/openapi/assist/data-sources/{dataSourceType}/fields', - 'methods' => [ - 'get', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'UpdateFunctionResource', + 'description' => 'Updates the information of a resource specified by its name. You can modify only the data and description of the resource.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateFunctionResource'], + ], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'opensearch:WriteFunction', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'OpenSearch', 'resourceType' => 'FunctionResource', 'arn' => 'acs:opensearch:{#regionId}:{#accountId}:apps/{#AppGroupId}'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Status\\": \\"OK\\",\\n \\"HttpCode\\": 200,\\n \\"RequestId\\": \\"7E375703-5B12-5466-8B48-C4D01AE1291A\\",\\n \\"Message\\": \\"Invalid request.\\",\\n \\"Code\\": \\"InvalidRequest\\",\\n \\"Latency\\": 123\\n}","type":"json"}]', + 'translator' => 'manual', + ], + 'UpdateSearchStrategy' => [ + 'summary' => 'This operation supports dry runs.', + 'path' => '/v4/openapi/app-groups/{appGroupIdentity}/apps/{appId}/search-strategies/{strategyName}', + 'methods' => ['put'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', + 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'get', + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATUREopensearchBNTDZX'], ], 'parameters' => [ [ - 'name' => 'dataSourceType', + 'name' => 'appGroupIdentity', 'in' => 'path', - 'schema' => [ - 'description' => 'The type of the data source. Valid values:'."\n" - ."\n" - .'* rds'."\n" - .'* polardb'."\n" - .'* odps'."\n" - .'* mysql'."\n" - .'* drds'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'enumValueTitles' => [ - 'rds' => 'rds', - 'mysql' => 'mysql', - 'odps' => 'odps', - 'saro' => 'saro', - 'polardb' => 'polardb', - ], - 'example' => 'rds', - ], + 'schema' => ['description' => 'The name of the application group.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'title' => '', 'example' => 'group_name'], ], [ - 'name' => 'params', - 'in' => 'query', - 'schema' => [ - 'description' => 'The parameters of the data source. The value of the params parameter is a JSON string. The value must be URL-encoded.'."\n" - ."\n" - .'Different types of data sources use different parameters. For more information, see the following sections of the "DataSource" topic:'."\n" - ."\n" - .'* [rds](~~170005~~)'."\n" - .'* [polardb](~~170005~~)'."\n" - .'* [odps](~~170005~~)'."\n" - .'* [mysql](~~173627~~)'."\n" - .'* [drds](~~173627~~)'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '{}', - ], + 'name' => 'appId', + 'in' => 'path', + 'schema' => ['description' => 'The version number.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'title' => '', 'example' => '"110157886"'], ], [ - 'name' => 'rawType', - 'in' => 'query', - 'schema' => [ - 'description' => 'Specifies whether to return the original field types of the data source.'."\n", - 'type' => 'boolean', - 'required' => false, - 'example' => 'false', - ], + 'name' => 'strategyName', + 'in' => 'path', + 'schema' => ['description' => 'The name of the policy.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'title' => '', 'example' => 'default'], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'schema' => ['description' => 'The search policy. For more information, see [SearchStrategy](~~2400242~~).', 'required' => false, '$ref' => '#/components/schemas/SearchStrategy', 'title' => '', 'example' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'description' => 'The response body.'."\n", + 'description' => 'The response body.', 'type' => 'object', 'properties' => [ - 'result' => [ - 'description' => 'The returned result.'."\n", - 'type' => 'object', - 'example' => '{}', - ], - 'requestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '0A6EB64B-B4C8-CF02-810F-E660812972FF', - ], + 'requestId' => ['description' => 'The request ID.', 'type' => 'string', 'title' => '', 'example' => 'ABCDEFGH'], ], - 'example' => '{}', + 'title' => '', + 'example' => '', ], ], '5XX' => [ 'schema' => [ 'type' => 'object', 'properties' => [ - 'code' => [ - 'type' => 'string', - ], - 'message' => [ - 'type' => 'string', - ], - 'requestId' => [ - 'type' => 'string', - ], - 'httpCode' => [ - 'type' => 'integer', - 'format' => 'int32', - ], + 'code' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'message' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'requestId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'httpCode' => ['type' => 'integer', 'format' => 'int32', 'description' => '', 'title' => '', 'example' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"result\\": {},\\n \\"requestId\\": \\"0A6EB64B-B4C8-CF02-810F-E660812972FF\\"\\n}","type":"json"}]', - 'title' => 'ListDataSourceTableFields', - 'summary' => 'Queries all fields in a table of a data source. This operation is for internal use only.', - ], - 'GetDomain' => [ - 'path' => '/v4/openapi/domains/{domainName}', - 'methods' => [ - 'get', + 'title' => 'UpdateSearchStrategy', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'opensearch:WriteSearchStrategy', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'OpenSearch', 'resourceType' => 'SearchStrategy', 'arn' => 'acs:opensearch:{#regionId}:{#accountId}:apps/{#AppGroupId}'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"ABCDEFGH\\"\\n}","type":"json"}]', + 'translator' => 'manual', + ], + 'UpdateSortScript' => [ + 'path' => '/v4/openapi/app-groups/{appGroupIdentity}/apps/{appVersionId}/sort-scripts/{scriptName}', + 'methods' => ['put'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', + 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'get', + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATUREopensearchN8M8WS'], ], 'parameters' => [ [ - 'name' => 'domainName', + 'name' => 'appGroupIdentity', 'in' => 'path', - 'schema' => [ - 'description' => 'The type of the industry.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '-', - ], + 'schema' => ['description' => 'The name or ID of the application.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'my_app', 'title' => ''], ], [ - 'name' => 'appGroupIdentity', - 'in' => 'query', + 'name' => 'appVersionId', + 'in' => 'path', + 'schema' => ['description' => 'The ID of the application version.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '123456', 'title' => ''], + ], + [ + 'name' => 'scriptName', + 'in' => 'path', + 'schema' => ['description' => 'The name of the script.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'test_cava', 'title' => ''], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', 'schema' => [ - 'description' => 'The name or ID of the application.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'my_app_group_name', + 'type' => 'object', + 'properties' => [ + 'description' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ + 'description' => 'The response body.', 'type' => 'object', 'properties' => [ - 'result' => [ - 'description' => 'The returned result.'."\n", - 'type' => 'object', - 'example' => '-', - ], - 'requestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => 'ABCDEFGH', - ], + 'requestId' => ['description' => 'The ID of the request.', 'type' => 'string', 'example' => '9F165784-5507-5342-ABF3-545293F9808A', 'title' => ''], ], - 'description' => '', + 'example' => '[]', + 'title' => '', ], ], '5XX' => [ 'schema' => [ 'type' => 'object', 'properties' => [ - 'code' => [ - 'type' => 'string', - ], - 'message' => [ - 'type' => 'string', - ], - 'requestId' => [ - 'type' => 'string', - ], - 'httpCode' => [ - 'type' => 'integer', - 'format' => 'int32', - ], + 'code' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'message' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'requestId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'httpCode' => ['type' => 'integer', 'format' => 'int32', 'description' => '', 'title' => '', 'example' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + ], + ], + 'title' => 'UpdateSortScript', + 'summary' => 'Modifies the description of a sort script.', + 'description' => 'Modifies the description of a sort script.', + 'responseParamsDescription' => '**Examples**'."\n" + ."\n" + .'Sample request'."\n" + ."\n" + .'```'."\n" + .'PUT /v4/openapi/app-groups/my_app/apps/123456/sort-scripts/test_cava'."\n" + .'{'."\n" + .' "description" : "just for test"'."\n" + .'}'."\n" + .'```'."\n" + ."\n" + .'Sample response'."\n" + ."\n" + .'XML format'."\n" + ."\n" + .'```'."\n" + .'ABCDEFGH'."\n" + .'```'."\n" + ."\n" + .'JSON format'."\n" + ."\n" + .'```'."\n" + .'{"requestId":"ABCDEFGH"}'."\n" + .'```', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'opensearch:WriteSortScript', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'OpenSearch', 'resourceType' => 'App', 'arn' => 'acs:opensearch:{#regionId}:{#accountId}:apps/{#AppGroupId}'], ], ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"result\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n },\\n \\"requestId\\": \\"271D5762-32B7-5F0D-B97D-463EB67F1F3B\\"\\n}","type":"json"}]', - 'title' => 'GetDomain', - 'summary' => 'Queries the type of an industry.', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"9F165784-5507-5342-ABF3-545293F9808A\\"\\n}","type":"json"}]', + 'translator' => 'manual', ], - 'GenerateMergedTable' => [ - 'path' => '/v4/openapi/assist/schema/actions/merge', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'UpdateSummaries' => [ + 'summary' => 'This operation supports dry runs.', + 'path' => '/v4/openapi/app-groups/{appGroupIdentity}/apps/{appId}/summaries', + 'methods' => ['put'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', + 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'get', + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '55273', + 'abilityTreeNodes' => ['FEATUREopensearchYVAV9H', 'FEATUREopensearchBZ8NMO'], ], 'parameters' => [ [ - 'name' => 'spec', + 'name' => 'dryRun', 'in' => 'query', - 'schema' => [ - 'description' => 'The specifications of the OpenSearch instance. This parameter is used to check whether the OpenSearch instance meets the special limits on an exclusive instance.'."\n" - ."\n" - .'Default value: opensearch.share.common.'."\n" - ."\n" - .'For more information, see the description of the spec field in the Quota topic.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '"opensearch.share.common"', - ], + 'schema' => ['description' => 'Specifies whether the request is a dry run.', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'title' => ''], + ], + [ + 'name' => 'appGroupIdentity', + 'in' => 'path', + 'schema' => ['description' => 'The name of the application.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '“my_app_group_name”', 'title' => ''], + ], + [ + 'name' => 'appId', + 'in' => 'path', + 'schema' => ['description' => 'The version number of the application.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true, 'example' => '10157886', 'title' => ''], ], [ 'name' => 'body', 'in' => 'body', + 'style' => 'json', 'schema' => [ - 'description' => 'The request body parameters.'."\n", + 'description' => 'The request body.', + 'type' => 'array', + 'items' => [ + 'description' => 'The request body.', + 'type' => 'object', + 'properties' => [ + 'field' => ['description' => 'The field.', 'type' => 'string', 'required' => false, 'example' => '"title"', 'title' => ''], + 'len' => ['description' => 'The length of a segment.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '50', 'title' => ''], + 'element' => ['description' => 'The HTML tag that is used to highlight terms in red.', 'type' => 'string', 'required' => false, 'example' => '"em" ', 'title' => ''], + 'ellipsis' => ['description' => 'The connector that is used to connect segments.', 'type' => 'string', 'required' => false, 'example' => '"..."', 'title' => ''], + 'snippet' => ['description' => 'The number of segments.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'title' => ''], + ], + 'required' => false, + 'title' => '', + 'example' => '', + ], 'required' => false, - '$ref' => '#/components/schemas/Schema', + 'maxItems' => 100, + 'title' => '', + 'example' => '', ], ], ], @@ -21309,2020 +17955,1919 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'requestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => 'ABCDEFGH', - ], - 'result' => [ - 'description' => 'The response parameters.'."\n", - 'type' => 'object', - 'properties' => [ - 'primaryKey' => [ - 'description' => 'The primary key.'."\n", - 'type' => 'string', - 'example' => '-', - ], - 'mergeTable' => [ - 'description' => 'The wide table that is generated after the JOIN operation is performed on multiple tables.'."\n", - 'type' => 'object', - 'example' => '-', - ], - 'fromTable' => [ - 'description' => 'The tables on which the JOIN operation is performed.'."\n", - 'type' => 'object', - 'example' => '-', - ], - ], - ], + 'result' => ['description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'requestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '7A389E09-7964-5A2B-FE9D-F6CFA7162852', 'title' => ''], ], 'description' => '', + 'title' => '', + 'example' => '', ], ], '5XX' => [ 'schema' => [ 'type' => 'object', 'properties' => [ - 'code' => [ - 'type' => 'string', - ], - 'message' => [ - 'type' => 'string', - ], - 'requestId' => [ - 'type' => 'string', - ], - 'httpCode' => [ - 'type' => 'integer', - 'format' => 'int32', - ], + 'code' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'httpCode' => ['type' => 'integer', 'format' => 'int32', 'description' => '', 'title' => '', 'example' => ''], + 'requestId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'message' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"requestId\\": \\"ABCDEFGH\\",\\n \\"result\\": {\\n \\"primaryKey\\": \\"-\\",\\n \\"mergeTable\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n },\\n \\"fromTable\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n }\\n }\\n}","errorExample":""},{"type":"xml","example":"8EF9C2DF-34C3-EDCF-6DEA-0445EE53DA20\\n\\n \\n \\n id\\n INT\\n 1\\n 0\\n 0\\n \\n \\n classid\\n INT\\n 0\\n 0\\n 0\\n \\n \\n <name>title</name>\\n <type>TEXT</type>\\n <isPk>0</isPk>\\n <isMulti>0</isMulti>\\n <isAttribute>0</isAttribute>\\n \\n \\n js\\n TEXT\\n 0\\n 0\\n 0\\n \\n \\n classid_1\\n INT\\n 0\\n 0\\n 0\\n \\n \\n infotags\\n TEXT\\n 0\\n 0\\n 0\\n \\n \\n \\n \\n \\n \\n id\\n INT\\n 1\\n 0\\n \\n \\n classid\\n INT\\n 0\\n 0\\n \\n \\n <name>title</name>\\n <type>TEXT</type>\\n <isPk>0</isPk>\\n <isMulti>0</isMulti>\\n \\n \\n js\\n TEXT\\n 0\\n 0\\n \\n \\n \\n \\n id_1\\n INT\\n 1\\n 0\\n \\n \\n classid_1\\n INT\\n 0\\n 0\\n \\n \\n infotags\\n TEXT\\n 0\\n 0\\n \\n \\n \\n phome_ecms_tuzhi\\n \\n 0\\n 1\\n \\n \\n \\n \\n phome_ecms_tuzhi_data_1
\\n id_1\\n \\n classid_1\\n infotags\\n \\n \\n \\n \\n \\n id\\n","errorExample":""}]', - 'title' => 'GenerateMergedTable', - 'summary' => 'Queries the information about a wide table that is generated after a JOIN operation is performed on multiple tables.', + 'title' => 'UpdateSummaries', 'requestParamsDescription' => '**Request body**'."\n" ."\n" - .'|Parameter|Type|Required|Example|Description|'."\n" - .'|---|---|---|---|---|'."\n" - .'|tables|Object|Yes||The table schema.|'."\n" - .'|indexes|Object|No||The index schema.|', - 'responseParamsDescription' => '**Response parameters**'."\n" - ."\n" - .'|Parameter|Type|Description|'."\n" - .'|---|---|---|'."\n" - .'|requestId|String|The request ID.|'."\n" - .'|result.mergeTable|Object|The wide table that is generated after the JOIN operation is performed on multiple tables. The key is the field name and the value is the field content.|'."\n" - .'|result.fromTable|Object|The information about the tables on which the JOIN operation is performed.|'."\n" - .'|result.fromTable.tables|Object|The information about the tables. The key is the table name and the value is the information about the table schema.|'."\n" - .'|result.fromTable.tables.\\*|Object|The key is the field name and the value is the field content.|'."\n" - .'|result.fromTable.master|String|The primary table.|'."\n" - .'|result.fromTable.level|Object|The information about table levels. The table level starts from 0.The key is the table name and the value is the table level.|'."\n" - .'|result.fromTable.joinMap|Object|The information about the external table. The key is the table name and the value is the information about the external table.|'."\n" - .'|result.fromTable.joinMap.\\*|Object|The information about the fields of the external table. The key is the field name and the value is the field content.|'."\n" - .'|result.primaryKey|String|The primary key field.|'."\n" - ."\n\n" - .'**TableFields**'."\n" - ."\n" - .'|Parameter|Type|Description|'."\n" - .'|---|---|---|'."\n" - .'|name|String|The name of the field.|'."\n" - .'|type|String|The type of the field. For more information, see [Fields in a data table](~~179404~~).|'."\n" - .'|isPk|String|Indicates whether the field is the primary key field. Valid values:0: The field is not the primary key field.1: The field is the primary key field.|'."\n" - .'|isMulti|Integer|Indicates whether the field is a multi-value field. Valid values:0: The field is not a multi-value field.1: The field is a multi-value field.|'."\n" - .'|isAttribute|Integer|Indicates whether the field is an attribute field. Valid values:0: The field is not an attribute field.1: The field is an attribute field.|'."\n" - ."\n\n" - .'**JoinMapFields**'."\n" - ."\n" - .'|Parameter|Type|Description|'."\n" - .'|---|---|---|'."\n" - .'|table|String|The name of the external table.|'."\n" - .'|key|String|The name of the primary key of the external table.|'."\n" - .'|join|Object|The extended fields of the external table.|', + .'| Field | Type | Required | Example | Description |'."\n" + .'| ------------ | ------- | -------- | ------- | ------------------------------------------------------------------------- |'."\n" + .'| \\[] | Object | Yes | | The summary settings.
For more information, see [Summary](~~170016~~). |'."\n" + .'| \\[].field | String | Yes | "title" | The field. |'."\n" + .'| \\[].len | Integer | Yes | 50 | The length of a segment. |'."\n" + .'| \\[].element | String | Yes | "em" | The HTML tag that is used to highlight terms. |'."\n" + .'| \\[].ellipsis | String | Yes | "..." | The connector that is used to connect segments. |'."\n" + .'| \\[].snippet | Integer | Yes | 1 | The number of segments. |', + 'responseParamsDescription' => ' ', 'extraInfo' => ' ', - ], - 'DescribeRegions' => [ - 'path' => '/v4/openapi/regions', - 'methods' => [ - 'get', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'opensearch:WriteSummary', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'OpenSearch', 'resourceType' => 'App', 'arn' => 'acs:opensearch:{#regionId}:{#accountId}:apps/{#AppId}'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"result\\": true,\\n \\"requestId\\": \\"7A389E09-7964-5A2B-FE9D-F6CFA7162852\\"\\n}","type":"json"}]', + 'translator' => 'manual', + ], + 'ValidateDataSources' => [ + 'summary' => 'Validates data sources.', + 'path' => '/v4/openapi/assist/data-sources/validations', + 'methods' => ['post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - 'abilityTreeCode' => '55180', - 'abilityTreeNodes' => [ - 'FEATUREopensearch447AAX', + 'systemTags' => ['operationType' => 'get'], + 'parameters' => [ + [ + 'name' => 'body', + 'in' => 'body', + 'schema' => ['description' => 'The request parameters. For more information, see [DataSource](~~170005~~).', '$ref' => '#/components/schemas/DataSource', 'required' => false, 'title' => '', 'example' => ''], ], ], - 'parameters' => [], 'responses' => [ 200 => [ 'schema' => [ + 'title' => '', + 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'requestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '3B7E42BD-1D63-2F6B-C8E0-41BACEA76EEB', - ], + 'requestId' => ['title' => '', 'description' => 'Id of the request', 'type' => 'string', 'example' => '8FA2B338-AFDC-46B4-A132-B5487820C2BF'], 'result' => [ - 'description' => 'The results returned.'."\n", + 'description' => 'The request results.', 'type' => 'array', 'items' => [ + 'description' => 'The result body.', 'type' => 'object', 'properties' => [ - 'endpoint' => [ - 'description' => 'The endpoint.'."\n", - 'type' => 'string', - 'example' => 'opensearch.cn-hangzhou.aliyuncs.com', - ], - 'regionId' => [ - 'description' => 'The region ID.'."\n", - 'type' => 'string', - 'example' => 'cn-hangzhou', - ], - 'localName' => [ - 'description' => 'The region name.'."\n", - 'type' => 'string', - 'example' => 'China (Hangzhou)'."\n", - ], - 'consoleUrl' => [ - 'description' => 'The console URL.'."\n", - 'type' => 'string', - 'example' => 'https://opensearch-cn-hangzhou.console.aliyun.com', + 'code' => ['description' => 'The status code.', 'type' => 'string', 'example' => 'SUCCEED', 'title' => ''], + 'message' => ['description' => 'The response message.', 'type' => 'string', 'example' => 'Validate succeeded', 'title' => ''], + 'dataSource' => [ + 'description' => 'The data source.', + 'type' => 'object', + 'properties' => [ + 'tableName' => ['description' => 'The table name.', 'type' => 'string', 'example' => 'user_activity_decision', 'title' => ''], + 'type' => ['description' => 'The data source type.', 'type' => 'string', 'example' => 'rds', 'title' => ''], + 'parameters' => ['description' => 'The parameter body.', 'type' => 'object', 'example' => '{}', 'title' => ''], + ], + 'example' => '{}', + 'title' => '', ], ], - 'description' => '', + 'example' => '{}', + 'title' => '', ], + 'example' => '[]', + 'title' => '', ], ], - 'description' => '', + 'example' => '{}', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"8FA2B338-AFDC-46B4-A132-B5487820C2BF\\",\\n \\"result\\": [\\n {\\n \\"code\\": \\"SUCCEED\\",\\n \\"message\\": \\"Validate succeeded\\",\\n \\"dataSource\\": {\\n \\"tableName\\": \\"user_activity_decision\\",\\n \\"type\\": \\"rds\\",\\n \\"parameters\\": {}\\n }\\n }\\n ]\\n}","type":"json"}]', + 'title' => 'ValidateDataSources', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ValidateDataSources'], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'opensearch:ValidateDataSources', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'OpenSearch', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + ], + 'translator' => 'manual', + ], + ], + 'endpoints' => [ + ['regionId' => 'ap-southeast-1', 'regionName' => 'Singapore', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'opensearch.ap-southeast-1.aliyuncs.com', 'endpoint' => 'opensearch.ap-southeast-1.aliyuncs.com', 'vpc' => ''], + ['regionId' => 'cn-beijing', 'regionName' => 'China (Beijing)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'opensearch.cn-beijing.aliyuncs.com', 'endpoint' => 'opensearch.cn-beijing.aliyuncs.com', 'vpc' => ''], + ['regionId' => 'cn-hangzhou', 'regionName' => 'China (Hangzhou)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'opensearch.cn-hangzhou.aliyuncs.com', 'endpoint' => 'opensearch.cn-hangzhou.aliyuncs.com', 'vpc' => ''], + ['regionId' => 'cn-hongkong', 'regionName' => 'China (Hong Kong)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'opensearch.cn-hongkong.aliyuncs.com', 'endpoint' => 'opensearch.cn-hongkong.aliyuncs.com', 'vpc' => 'opensearch-vpc.cn-hongkong.aliyuncs.com'], + ['regionId' => 'cn-qingdao', 'regionName' => 'China (Qingdao)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'opensearch.cn-qingdao.aliyuncs.com', 'endpoint' => 'opensearch.cn-qingdao.aliyuncs.com', 'vpc' => ''], + ['regionId' => 'cn-shanghai', 'regionName' => 'China (Shanghai)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'opensearch.cn-shanghai.aliyuncs.com', 'endpoint' => 'opensearch.cn-shanghai.aliyuncs.com', 'vpc' => ''], + ['regionId' => 'cn-shenzhen', 'regionName' => 'China (Shenzhen)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'opensearch.cn-shenzhen.aliyuncs.com', 'endpoint' => 'opensearch.cn-shenzhen.aliyuncs.com', 'vpc' => ''], + ['regionId' => 'cn-zhangjiakou', 'regionName' => 'China (Zhangjiakou)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'opensearch.cn-zhangjiakou.aliyuncs.com', 'endpoint' => 'opensearch.cn-zhangjiakou.aliyuncs.com', 'vpc' => ''], + ['regionId' => 'us-east-1', 'regionName' => 'US (Virginia)', 'areaId' => 'europeAmerica', 'areaName' => 'Europe & Americas', 'public' => 'opensearch.us-east-1.aliyuncs.com', 'endpoint' => 'opensearch.us-east-1.aliyuncs.com', 'vpc' => 'opensearch-vpc.us-east-1.aliyuncs.com'], + ['regionId' => 'eu-central-1', 'regionName' => 'Germany (Frankfurt)', 'areaId' => 'europeAmerica', 'areaName' => 'Europe & Americas', 'public' => 'opensearch.eu-central-1.aliyuncs.com', 'endpoint' => 'opensearch.eu-central-1.aliyuncs.com', 'vpc' => 'opensearch-vpc.eu-central-1.aliyuncs.com'], + ['regionId' => 'cn-north-2-gov-1', 'regionName' => 'Beijing Government Cloud', 'areaId' => 'industryCloud', 'areaName' => 'Industry Cloud', 'public' => 'opensearch.cn-north-2-gov-1.aliyuncs.com', 'endpoint' => 'opensearch.cn-north-2-gov-1.aliyuncs.com', 'vpc' => ''], + ], + 'errorCodes' => [], + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '-1', 'countWindow' => 1, 'regionId' => '*'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetFunctionTask'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteFunctionResource'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateFunctionInstance'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ValidateDataSources'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateFunctionDefaultInstance'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateFunctionTask'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteFunctionInstance'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateFunctionResource'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetFunctionVersion'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetFunctionInstance'], + ['threshold' => '1', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GenerateMergedTable'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateFunctionInstance'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateFunctionResource'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetFunctionResource'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteFunctionTask'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetFunctionCurrentVersion'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListFunctionResources'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListFunctionTasks'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetFunctionDefaultInstance'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListFunctionInstances'], + ['threshold' => '3', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListInterventionDictionaryNerResults'], + ], + ], + 'ram' => [ + 'productCode' => 'OpenSearch', + 'productName' => 'Open Search', + 'ramCodes' => ['opensearch'], + 'ramLevel' => 'SERVICE', + 'ramConditions' => [], + 'ramActions' => [ + [ + 'apiName' => 'GetFunctionTask', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'opensearch:DescribeFunction', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'OpenSearch', 'resourceType' => 'FunctionTask', 'arn' => 'acs:opensearch:{#regionId}:{#accountId}:apps/{#AppGroupId}'], + ], + ], + ], + [ + 'apiName' => 'ModifyAppGroupQuota', + 'description' => '', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'opensearch:ModifyAppGroup', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'OpenSearch', 'resourceType' => 'AppGroup', 'arn' => 'acs:opensearch:{#regionId}:{#accountId}:app-groups/{#AppGroupId}'], + ], + ], + ], + [ + 'apiName' => 'ListFunctionTasks', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'opensearch:DescribeFunction', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'OpenSearch', 'resourceType' => 'FunctionTask', 'arn' => 'acs:opensearch:{#regionId}:{#accountId}:apps/{#AppGroupId}'], + ], + ], + ], + [ + 'apiName' => 'DeleteFunctionResource', + 'description' => '', + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'opensearch:WriteFunction', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'OpenSearch', 'resourceType' => 'FunctionResource', 'arn' => 'acs:opensearch:{#regionId}:{#accountId}:apps/{#AppGroupId}'], + ], + ], + ], + [ + 'apiName' => 'UpdateABTestFixedFlowDividers', + 'description' => '', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'opensearch:UpdateApp', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'OpenSearch', 'resourceType' => 'AbTestExperiment', 'arn' => 'acs:opensearch:{#regionId}:{#accountId}:apps/{#AppGroupId}'], + ], + ], + ], + [ + 'apiName' => 'StartSlowQueryAnalyzer', + 'description' => '', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'opensearch:StartSlowQueryAnalyzer', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'OpenSearch', 'resourceType' => 'AppGroup', 'arn' => 'acs:opensearch:{#regionId}:{#accountId}:apps/{#AppGroupId}'], + ], + ], + ], + [ + 'apiName' => 'ModifySecondRank', + 'description' => '', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'opensearch:WriteSecondRank', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'OpenSearch', 'resourceType' => 'SecondRank', 'arn' => 'acs:opensearch:{#regionId}:{#accountId}:apps/{#AppGroupId}'], + ], + ], + ], + [ + 'apiName' => 'UpdateABTestExperiment', + 'description' => '', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'opensearch:UpdateApp', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'OpenSearch', 'resourceType' => 'AbTestExperiment', 'arn' => 'acs:opensearch:{#regionId}:{#accountId}:apps/{#AppGroupId}'], + ], + ], + ], + [ + 'apiName' => 'ListSecondRanks', + 'description' => '', + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'opensearch:ListSecondRank', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'OpenSearch', 'resourceType' => 'SecondRank', 'arn' => 'acs:opensearch:{#regionId}:{#accountId}:apps/{#AppGroupId}'], + ], + ], + ], + [ + 'apiName' => 'DescribeABTestGroup', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'opensearch:DescribeApp', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'OpenSearch', 'resourceType' => 'AbTestGroup', 'arn' => 'acs:opensearch:{#regionId}:{#accountId}:apps/{#AppGroupId}'], + ], + ], + ], + [ + 'apiName' => 'ListProceedings', + 'description' => '', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'opensearch:ListProceedings', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'OpenSearch', 'resourceType' => 'AppGroup', 'arn' => 'acs:opensearch:{#regionId}:{#accountId}:app-groups/{#AppGroupId}'], + ], + ], + ], + [ + 'apiName' => 'ListFunctionInstances', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'opensearch:DescribeFunction', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'OpenSearch', 'resourceType' => 'FunctionInstance', 'arn' => 'acs:opensearch:{#regionId}:{#accountId}:apps/{#AppGroupId}'], + ], + ], + ], + [ + 'apiName' => 'ListQueryProcessorAnalyzerResults', + 'description' => '', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'opensearch:DescribeQueryProcessor', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'OpenSearch', 'resourceType' => 'QueryProcessor', 'arn' => 'acs:opensearch:{#regionId}:{#accountId}:apps/{#AppGroupId}'], + ], + ], + ], + [ + 'apiName' => 'ListSortExpressions', + 'description' => '', + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'opensearch:ListSortExpression', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'OpenSearch', 'resourceType' => 'FirstRank', 'arn' => 'acs:opensearch:{#regionId}:{#accountId}:apps/{#AppGroupId}'], + ['validationType' => 'always', 'product' => 'OpenSearch', 'resourceType' => 'SecondRank', 'arn' => 'acs:opensearch:{#regionId}:{#accountId}:apps/{#AppGroupId}'], + ], + ], + ], + [ + 'apiName' => 'CreateSearchStrategy', + 'description' => '', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'opensearch:WriteSearchStrategy', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'OpenSearch', 'resourceType' => 'SearchStrategy', 'arn' => 'acs:opensearch:{#regionId}:{#accountId}:apps/{#AppGroupId}'], ], ], - '5XX' => [ - 'schema' => [ - 'type' => 'object', - 'properties' => [ - 'code' => [ - 'type' => 'string', - ], - 'message' => [ - 'type' => 'string', - ], - 'requestId' => [ - 'type' => 'string', - ], - 'httpCode' => [ - 'type' => 'integer', - 'format' => 'int32', - ], - ], + ], + [ + 'apiName' => 'CreateQueryProcessor', + 'description' => '', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'opensearch:WriteQueryProcessor', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'OpenSearch', 'resourceType' => 'QueryProcessor', 'arn' => 'acs:opensearch:{#regionId}:{#accountId}:apps/{#AppGroupId}'], ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"requestId\\": \\"3B7E42BD-1D63-2F6B-C8E0-41BACEA76EEB\\",\\n \\"result\\": [\\n {\\n \\"endpoint\\": \\"opensearch.cn-hangzhou.aliyuncs.com\\",\\n \\"regionId\\": \\"cn-hangzhou\\",\\n \\"localName\\": \\"华东1（杭州）\\",\\n \\"consoleUrl\\": \\"https://opensearch-cn-hangzhou.console.aliyun.com\\"\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"3B7E42BD-1D63-2F6B-C8E0-41BACEA76EEB\\n\\n cn-hangzhou\\n 华东1（杭州）\\n opensearch.cn-hangzhou.aliyuncs.com\\n https://opensearch-cn-hangzhou.console.aliyun.com\\n\\n\\n cn-shanghai\\n 华东2（上海）\\n opensearch.cn-shanghai.aliyuncs.com\\n https://opensearch-cn-shanghai.console.aliyun.com\\n\\n\\n cn-qingdao\\n 华北1（青岛）\\n opensearch.cn-qingdao.aliyuncs.com\\n https://opensearch-cn-qingdao.console.aliyun.com\\n\\n\\n cn-beijing\\n 华北2（北京）\\n opensearch.cn-beijing.aliyuncs.com\\n https://opensearch-cn-beijing.console.aliyun.com\\n\\n\\n cn-zhangjiakou\\n 华北3（张家口）\\n opensearch.cn-zhangjiakou.aliyuncs.com\\n https://opensearch-cn-zhangjiakou.console.aliyun.com\\n\\n\\n cn-shenzhen\\n 华南1（深圳）\\n opensearch.cn-shenzhen.aliyuncs.com\\n https://opensearch-cn-shenzhen.console.aliyun.com\\n\\n\\n ap-southeast-1\\n 新加坡\\n opensearch.ap-southeast-1.aliyuncs.com\\n https://opensearch-ap-southeast-1.console.aliyun.com\\n\\n\\n cn-internal\\n 内网1（中心）\\n opensearch.cn-zhangbei-center.aliyuncs.com\\n https://opensearch-cn-shanghai-in.console.aliyun.com\\n\\n\\n cn-zhangbei-in\\n 内网2（张北）\\n opensearch.cn-zhangbei-in.aliyuncs.com\\n https://opensearch-cn-zhangbei-in.console.aliyun.com\\n\\n\\n us-west-1-in\\n 内网3（美国）\\n opensearch.innet-us.aliyuncs.com\\n http://opensearch-us-in.console.aliyun.com\\n\\n\\n rus-west-1-in\\n 内网4（俄罗斯）\\n \\n https://opensearch-rg-ru-in.console.aliyun.com\\n\\n\\n cn-daily\\n 内网日常\\n opensearch.cn-daily.aliyuncs.com\\n https://opensearch-cn-daily.console.aliyun.com\\n\\n\\n pre-hangzhou\\n 杭州预发\\n opensearch.pre-hangzhou.aliyuncs.com\\n https://opensearch-pre-hangzhou.console.aliyun.com\\n","errorExample":""}]', - 'title' => 'DescribeRegions', - 'summary' => 'Queries the endpoints of all regions that support OpenSearch.', - ], - 'DescribeDataCollction' => [ - 'path' => '/v4/openapi/app-groups/{appGroupIdentity}/data-collections/{dataCollectionIdentity}', - 'methods' => [ - 'get', + [ + 'apiName' => 'ListInterventionDictionaryEntries', + 'description' => '', + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'opensearch:DescribeInterventionDictionary', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'OpenSearch', 'resourceType' => 'InterventionDictionary', 'arn' => 'acs:opensearch:{#regionId}:{#accountId}:intervention-dictionaries/{#InterventionDictionaryId}'], + ], + ], ], - 'schemes' => [ - 'http', - 'https', + [ + 'apiName' => 'CreateSortScript', + 'description' => '', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'opensearch:WriteSortScript', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'OpenSearch', 'resourceType' => 'App', 'arn' => 'acs:opensearch:{#regionId}:{#accountId}:apps/{#AppGroupId}'], + ], + ], ], - 'security' => [ - [ - 'AK' => [], + [ + 'apiName' => 'ListSlowQueryQueries', + 'description' => '', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'opensearch:ListSlowQueryQueries', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'OpenSearch', 'resourceType' => 'AppGroup', 'arn' => 'acs:opensearch:{#regionId}:{#accountId}:apps/{#AppGroupId}'], + ], ], ], - 'operationType' => 'read', - 'deprecated' => false, - 'systemTags' => [ + [ + 'apiName' => 'DescribeApps', + 'description' => '', + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'opensearch:ListApp', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'OpenSearch', 'resourceType' => 'App', 'arn' => 'acs:opensearch:{#regionId}:{#accountId}:app-groups/{#AppGroupId}'], + ], + ], + ], + [ + 'apiName' => 'DescribeABTestScene', + 'description' => '', 'operationType' => 'get', - 'abilityTreeCode' => '55174', - 'abilityTreeNodes' => [ - 'FEATUREopensearch4M1CGO', + 'ramAction' => [ + 'action' => 'opensearch:DescribeApp', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'OpenSearch', 'resourceType' => 'AbTestScene', 'arn' => 'acs:opensearch:{#regionId}:{#accountId}:apps/{#AppGroupId}'], + ], ], ], - 'parameters' => [ - [ - 'name' => 'appGroupIdentity', - 'in' => 'path', - 'schema' => [ - 'description' => 'The application name.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'my_app_group_name', + [ + 'apiName' => 'ListInterventionDictionaryNerResults', + 'description' => '', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'opensearch:DescribeInterventionDictionary', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'OpenSearch', 'resourceType' => 'InterventionDictionary', 'arn' => 'acs:opensearch:{#regionId}:{#accountId}:intervention-dictionaries/{#InterventionDictionaryId}'], ], ], - [ - 'name' => 'dataCollectionIdentity', - 'in' => 'path', - 'schema' => [ - 'description' => 'The ID of the data collection task.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '286', + ], + [ + 'apiName' => 'RemoveDataCollection', + 'description' => '', + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'opensearch:WriteDataCollection', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'OpenSearch', 'resourceType' => 'DataCollection', 'arn' => 'acs:opensearch:{#regionId}:{#accountId}:apps/{#AppGroupId}'], ], ], ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'type' => 'object', - 'properties' => [ - 'requestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '72FAD77B-83F9-F393-BA8E-5834E2427BF8', - ], - 'result' => [ - 'description' => 'The details of the data collection task.'."\n", - 'type' => 'object', - 'properties' => [ - 'created' => [ - 'description' => 'The time when the task was created.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1581065837', - ], - 'dataCollectionType' => [ - 'description' => 'The type of data collected. Valid values:'."\n" - ."\n" - .'* behavior: behavioral data.'."\n" - .'* item_info: project information.'."\n" - .'* industry_specific: industry-specific data.'."\n", - 'type' => 'string', - 'example' => 'BEHAVIOR', - ], - 'type' => [ - 'description' => 'The type of the source from which data was collected. Valid values:'."\n" - ."\n" - .'* server'."\n" - .'* web'."\n" - .'* app Note: Only server is supported.'."\n", - 'type' => 'string', - 'example' => 'server', - ], - 'industryName' => [ - 'description' => 'The industry name. Valid values:'."\n" - ."\n" - .'* general'."\n" - .'* ecommerce'."\n", - 'type' => 'string', - 'example' => 'GENERAL', - ], - 'status' => [ - 'description' => 'The status of the data collection feature. Valid values:'."\n" - ."\n" - .'* 0: The feature is disabled.'."\n" - .'* 1: The feature is being enabled.'."\n" - .'* 2: The feature is enabled.'."\n" - .'* 3: The feature failed to be enabled.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '2', - ], - 'updated' => [ - 'description' => 'The time when the data collection task was updated.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1581065904', - ], - 'name' => [ - 'description' => 'The name of the data collection task.'."\n", - 'type' => 'string', - 'example' => 'os_function_test_v1', - ], - 'sundialId' => [ - 'description' => 'The sundial ID.'."\n", - 'type' => 'string', - 'example' => '1755', - ], - 'id' => [ - 'description' => 'The ID of the data collection task.'."\n", - 'type' => 'string', - 'example' => '286', - ], - ], - ], - ], - 'description' => '', + [ + 'apiName' => 'CreateABTestScene', + 'description' => '', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'opensearch:CreateApp', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'OpenSearch', 'resourceType' => 'ABTestScenes', 'arn' => 'acs:opensearch:{#regionId}:{#accountId}:app-groups{#AppGroupId}'], ], ], - '5XX' => [ - 'schema' => [ - 'type' => 'object', - 'properties' => [ - 'code' => [ - 'type' => 'string', - ], - 'httpCode' => [ - 'type' => 'integer', - 'format' => 'int32', - ], - 'requestId' => [ - 'type' => 'string', - ], - 'message' => [ - 'type' => 'string', - ], - ], + ], + [ + 'apiName' => 'RemoveUserAnalyzer', + 'description' => '', + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'opensearch:DeleteUserAnalyzer', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'OpenSearch', 'resourceType' => 'Analyzer', 'arn' => 'acs:opensearch:{#regionId}:{#accountId}:user-analyzers/{#AnalyzerId}'], ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"requestId\\": \\"72FAD77B-83F9-F393-BA8E-5834E2427BF8\\",\\n \\"result\\": {\\n \\"created\\": 1581065837,\\n \\"dataCollectionType\\": \\"BEHAVIOR\\",\\n \\"type\\": \\"server\\",\\n \\"industryName\\": \\"GENERAL\\",\\n \\"status\\": 2,\\n \\"updated\\": 1581065904,\\n \\"name\\": \\"os_function_test_v1\\",\\n \\"sundialId\\": \\"1755\\",\\n \\"id\\": \\"286\\"\\n }\\n}","errorExample":""},{"type":"xml","example":"72FAD77B-83F9-F393-BA8E-5834E2427BF8\\n\\n 286\\n os_function_test_v1\\n server\\n 2\\n BEHAVIOR\\n GENERAL\\n 1581065837\\n 1581065904\\n 1755\\n","errorExample":""}]', - 'title' => 'DescribeDataCollction', - 'summary' => 'Queries the details of a data collection task of an application.', - 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', - ], - 'ListDataCollections' => [ - 'path' => '/v4/openapi/app-groups/{appGroupIdentity}/data-collections', - 'methods' => [ - 'get', + [ + 'apiName' => 'DescribeInterventionDictionary', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'opensearch:DescribeInterventionDictionary', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'OpenSearch', 'resourceType' => 'InterventionDictionary', 'arn' => 'acs:opensearch:{#regionId}:{#accountId}:intervention-dictionaries/{#InterventionDictionaryId}'], + ], + ], ], - 'schemes' => [ - 'http', - 'https', + [ + 'apiName' => 'ReleaseSortScript', + 'description' => '', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'opensearch:WriteSortScript', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'OpenSearch', 'resourceType' => 'App', 'arn' => 'acs:opensearch:{#regionId}:{#accountId}:apps/{#AppGroupId}'], + ], + ], ], - 'security' => [ - [ - 'AK' => [], + [ + 'apiName' => 'DescribeAppStatistics', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'opensearch:DescribeAppStatistics', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'OpenSearch', 'resourceType' => 'App', 'arn' => 'acs:opensearch:{#regionId}:{#accountId}:app-groups/{#AppGroupId}'], + ], ], ], - 'operationType' => 'read', - 'deprecated' => false, - 'systemTags' => [ + [ + 'apiName' => 'DescribeSecondRank', + 'description' => '', 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'opensearch:DescribeSecondRank', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'OpenSearch', 'resourceType' => 'SecondRank', 'arn' => 'acs:opensearch:{#regionId}:{#accountId}:apps/{#AppGroupId}'], + ], + ], ], - 'parameters' => [ - [ - 'name' => 'appGroupIdentity', - 'in' => 'path', - 'schema' => [ - 'description' => 'The name of the application.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'my_app_group_name', + [ + 'apiName' => 'UnbindESUserAnalyzer', + 'description' => '', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'opensearch:ModifyAppGroup', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'OpenSearch', 'resourceType' => 'AppGroup', 'arn' => 'acs:opensearch:{#regionId}:{#accountId}:app-groups/{#AppGroupId}'], ], ], - [ - 'name' => 'pageNumber', - 'in' => 'query', - 'schema' => [ - 'description' => 'The page number. Default value: 1.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', + ], + [ + 'apiName' => 'RemoveScheduledTask', + 'description' => '', + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'opensearch:DeleteApp', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'OpenSearch', 'resourceType' => 'ScheduledTask', 'arn' => 'acs:opensearch:{#regionId}:{#accountId}:app-groups/{#AppGroupId}'], ], ], - [ - 'name' => 'pageSize', - 'in' => 'query', - 'schema' => [ - 'description' => 'The number of entries per page. Default value: 10.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '10', + ], + [ + 'apiName' => 'UpdateABTestGroup', + 'description' => '', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'opensearch:UpdateApp', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'OpenSearch', 'resourceType' => 'AbTestGroup', 'arn' => 'acs:opensearch:{#regionId}:{#accountId}:apps/{#AppGroupId}'], ], ], ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'type' => 'object', - 'properties' => [ - 'totalCount' => [ - 'description' => 'The total number of entries returned.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'requestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '959D8782-B130-95EB-86CC-1F6ED447981F', - ], - 'result' => [ - 'description' => 'The details of the data collection task.'."\n" - ."\n" - .'For more information, see [DataCollection](~~173605~~).'."\n", - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'created' => [ - 'description' => 'The time when the task was created.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1581065837', - ], - 'dataCollectionType' => [ - 'description' => 'The type of data collected. Valid values:'."\n" - ."\n" - .'* behavior: behavioral data.'."\n" - .'* item_info: project information.'."\n" - .'* industry_specific: industry-specific data.'."\n", - 'type' => 'string', - 'example' => 'BEHAVIOR', - ], - 'type' => [ - 'description' => 'The type of the source from which data was collected. Valid values:'."\n" - ."\n" - .'* server'."\n" - .'* web'."\n" - .'* app'."\n" - ."\n" - .'Only server is supported.'."\n", - 'type' => 'string', - 'example' => 'server', - ], - 'industryName' => [ - 'description' => 'The industry name. Valid values:'."\n" - ."\n" - .'* general'."\n" - .'* ecommerce'."\n", - 'type' => 'string', - 'example' => 'GENERAL', - ], - 'status' => [ - 'description' => 'The status of the data collection feature. Valid values:'."\n" - ."\n" - .'* 0: The feature is disabled.'."\n" - .'* 1: The feature is being enabled.'."\n" - .'* 2: The feature is enabled.'."\n" - .'* 3: The feature failed to be enabled.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '2', - ], - 'updated' => [ - 'description' => 'The time when the data collection task was updated.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1581065904', - ], - 'name' => [ - 'description' => 'The name of the data collection task.'."\n", - 'type' => 'string', - 'example' => 'os_function_test_v1', - ], - 'sundialId' => [ - 'description' => 'The sundial ID.'."\n", - 'type' => 'string', - 'example' => '1755', - ], - 'id' => [ - 'description' => 'The data collection ID.'."\n", - 'type' => 'string', - 'example' => '286', - ], - ], - 'description' => '', - ], - ], - ], - 'description' => '', + [ + 'apiName' => 'ListABTestScenes', + 'description' => '', + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'opensearch:ListApp', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'OpenSearch', 'resourceType' => 'AbTestScene', 'arn' => 'acs:opensearch:{#regionId}:{#accountId}:apps/{#AppGroupId}'], ], ], - '5XX' => [ - 'schema' => [ - 'type' => 'object', - 'properties' => [ - 'code' => [ - 'type' => 'string', - ], - 'httpCode' => [ - 'type' => 'integer', - 'format' => 'int32', - ], - 'requestId' => [ - 'type' => 'string', - ], - 'message' => [ - 'type' => 'string', - ], - ], + ], + [ + 'apiName' => 'BindEsInstance', + 'description' => '', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'opensearch:BindEsInstance', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'OpenSearch', 'resourceType' => 'AppGroup', 'arn' => 'acs:opensearch:{#regionId}:{#accountId}:app-groups/{#AppGroupId}'], ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"totalCount\\": 1,\\n \\"requestId\\": \\"959D8782-B130-95EB-86CC-1F6ED447981F\\",\\n \\"result\\": [\\n {\\n \\"created\\": 1581065837,\\n \\"dataCollectionType\\": \\"BEHAVIOR\\",\\n \\"type\\": \\"server\\",\\n \\"industryName\\": \\"GENERAL\\",\\n \\"status\\": 2,\\n \\"updated\\": 1581065904,\\n \\"name\\": \\"os_function_test_v1\\",\\n \\"sundialId\\": \\"1755\\",\\n \\"id\\": \\"286\\"\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"959D8782-B130-95EB-86CC-1F6ED447981F\\n1\\n\\n 286\\n os_function_test_v1\\n server\\n 2\\n BEHAVIOR\\n GENERAL\\n 1581065837\\n 1581065904\\n 1755\\n","errorExample":""}]', - 'title' => 'ListDataCollections', - 'summary' => 'Queries the data collection tasks of an OpenSearch application.', - 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', - ], - 'RemoveDataCollection' => [ - 'path' => '/v4/openapi/app-groups/{appGroupIdentity}/data-collections/{dataCollectionIdentity}', - 'methods' => [ - 'delete', + [ + 'apiName' => 'ListScheduledTasks', + 'description' => '', + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'opensearch:ListScheduledTask', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'OpenSearch', 'resourceType' => 'ScheduledTask', 'arn' => 'acs:opensearch:{#regionId}:{#accountId}:app-groups/{#AppGroupId}'], + ], + ], + ], + [ + 'apiName' => 'UpdateFetchFields', + 'description' => '', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'opensearch:UpdateApp', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'OpenSearch', 'resourceType' => 'App', 'arn' => 'acs:opensearch:{#regionId}:{#accountId}:apps/{#AppId}'], + ], + ], ], - 'schemes' => [ - 'http', - 'https', + [ + 'apiName' => 'RenewAppGroup', + 'description' => '', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'opensearch:UpdateApp', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'OpenSearch', 'resourceType' => 'AppGroup', 'arn' => 'acs:opensearch:{#regionId}:{#accountId}:apps/{#AppGroupId}'], + ], + ], ], - 'security' => [ - [ - 'AK' => [], + [ + 'apiName' => 'GetDomain', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'opensearch:GetDomain', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'OpenSearch', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'PushInterventionDictionaryEntries', + 'description' => '', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'opensearch:WriteInterventionDictionary', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'OpenSearch', 'resourceType' => 'InterventionDictionary', 'arn' => 'acs:opensearch:{#regionId}:{#accountId}:intervention-dictionaries/{#InterventionDictionaryId}'], + ], ], ], - 'operationType' => 'write', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'delete', - 'abilityTreeCode' => '55250', - 'abilityTreeNodes' => [ - 'FEATUREopensearchAROC40', + [ + 'apiName' => 'UpdateABTestScene', + 'description' => '', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'opensearch:UpdateApp', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'OpenSearch', 'resourceType' => 'AbTestScene', 'arn' => 'acs:opensearch:{#regionId}:{#accountId}:app-groups/{#AppGroupId}'], + ], ], ], - 'parameters' => [ - [ - 'name' => 'appGroupIdentity', - 'in' => 'path', - 'schema' => [ - 'description' => 'The name of the application'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '“my_app_group_name”', + [ + 'apiName' => 'CreateSecondRank', + 'description' => '', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'opensearch:WriteSecondRank', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'OpenSearch', 'resourceType' => 'SecondRank', 'arn' => 'acs:opensearch:{#regionId}:{#accountId}:apps/{#AppGroupId}'], ], ], - [ - 'name' => 'dataCollectionIdentity', - 'in' => 'path', - 'schema' => [ - 'description' => 'The data collection ID.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '286', + ], + [ + 'apiName' => 'ListDataCollections', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'opensearch:ListDataCollections', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'OpenSearch', 'resourceType' => 'DataCollection', 'arn' => 'acs:opensearch:{#regionId}:{#accountId}:apps/{#AppGroupId}'], ], ], ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'type' => 'object', - 'properties' => [ - 'result' => [ - 'description' => '-', - 'type' => 'string', - 'example' => '{}', - ], - 'requestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => 'D77D0DAF-790D-F5F5-A9C0-133738165014', - ], - ], - 'description' => '', + [ + 'apiName' => 'GetScriptFileNames', + 'description' => '', + 'operationType' => '', + 'ramAction' => [ + 'action' => 'opensearch:DescribeSortScript', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'OpenSearch', 'resourceType' => 'SortScript', 'arn' => 'acs:opensearch:{#regionId}:{#accountId}:apps/{#AppGroupId}'], ], ], - '5XX' => [ - 'schema' => [ - 'type' => 'object', - 'properties' => [ - 'code' => [ - 'type' => 'string', - ], - 'message' => [ - 'type' => 'string', - ], - 'requestId' => [ - 'type' => 'string', - ], - 'httpCode' => [ - 'type' => 'integer', - 'format' => 'int32', - ], - ], + ], + [ + 'apiName' => 'DescribeABTestExperiment', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'opensearch:DescribeApp', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'OpenSearch', 'resourceType' => 'AbTestExperiment', 'arn' => 'acs:opensearch:{#regionId}:{#accountId}:apps/{#AppGroupId}'], ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"result\\": \\"{}\\",\\n \\"requestId\\": \\"D77D0DAF-790D-F5F5-A9C0-133738165014\\"\\n}","errorExample":""},{"type":"xml","example":"D77D0DAF-790D-F5F5-A9C0-133738165014\\n","errorExample":""}]', - 'title' => 'RemoveDataCollection', - 'summary' => 'Disables data collection.', - 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', - ], - 'UntagResources' => [ - 'summary' => 'Remove tags from resources.', - 'path' => '/v4/openapi/resource-tags', - 'methods' => [ - 'delete', + [ + 'apiName' => 'PushUserAnalyzerEntries', + 'description' => '', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'opensearch:WriteUserAnalyzer', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'OpenSearch', 'resourceType' => 'Analyzer', 'arn' => 'acs:opensearch:{#regionId}:{#accountId}:user-analyzers/{#AnalyzerId}'], + ], + ], ], - 'schemes' => [ - 'http', - 'https', + [ + 'apiName' => 'DescribeFirstRank', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'opensearch:DescribeFirstRank', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'OpenSearch', 'resourceType' => 'FirstRank', 'arn' => 'acs:opensearch:{#regionId}:{#accountId}:apps/{#AppGroupId}'], + ], + ], ], - 'security' => [ - [ - 'AK' => [], + [ + 'apiName' => 'DescribeSlowQueryStatus', + 'description' => '', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'opensearch:DescribeSlowQueryStatus', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'OpenSearch', 'resourceType' => 'AppGroup', 'arn' => 'acs:opensearch:{#regionId}:{#accountId}:apps/{#AppGroupId}'], + ], ], ], - 'produces' => [ - 'application/json', + [ + 'apiName' => 'DeleteFunctionInstance', + 'description' => '', + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'opensearch:WriteFunction', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'OpenSearch', 'resourceType' => 'FunctionInstance', 'arn' => 'acs:opensearch:{#regionId}:{#accountId}:apps/{#AppGroupId}'], + ['validationType' => 'always', 'product' => 'OpenSearch', 'resourceType' => 'Instance', 'arn' => 'acs:opensearch:{#regionId}:{#accountId}:apps/{#AppGroupId}'], + ], + ], ], - 'operationType' => 'readAndWrite', - 'deprecated' => false, - 'systemTags' => [ + [ + 'apiName' => 'UpdateSummaries', + 'description' => '', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'opensearch:WriteSummary', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'OpenSearch', 'resourceType' => 'App', 'arn' => 'acs:opensearch:{#regionId}:{#accountId}:apps/{#AppId}'], + ], + ], + ], + [ + 'apiName' => 'BindESUserAnalyzer', + 'description' => '', 'operationType' => 'none', - 'abilityTreeCode' => '152938', - 'abilityTreeNodes' => [ - 'FEATUREopensearch447AAX', + 'ramAction' => [ + 'action' => 'opensearch:ModifyAppGroup', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'OpenSearch', 'resourceType' => 'AppGroup', 'arn' => 'acs:opensearch:{#regionId}:{#accountId}:app-groups/{#AppGroupId}'], + ], ], ], - 'parameters' => [ - [ - 'name' => 'resourceType', - 'in' => 'query', - 'schema' => [ - 'title' => '资源类型', - 'description' => 'The resource type.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'ProductVersion', + [ + 'apiName' => 'CreateABTestExperiment', + 'description' => '', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'opensearch:CreateApp', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'OpenSearch', 'resourceType' => 'AbTestExperiment', 'arn' => 'acs:opensearch:{#regionId}:{#accountId}:apps/{#AppGroupId}'], ], ], - [ - 'name' => 'resourceId', - 'in' => 'query', - 'style' => 'json', - 'schema' => [ - 'title' => '资源ID,最多 50个子项', - 'description' => 'The resource IDs. You can specify a maximum number of 50 IDs.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The IDs of the resources that you want to query. You must configure at least one of the resourceId and tagKey parameters.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '55111', - ], - 'required' => true, + ], + [ + 'apiName' => 'DeleteFunctionTask', + 'description' => '', + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'opensearch:WriteFunction', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'OpenSearch', 'resourceType' => 'FunctionTask', 'arn' => 'acs:opensearch:{#regionId}:{#accountId}:apps/{#AppGroupId}'], ], ], - [ - 'name' => 'tagKey', - 'in' => 'query', - 'style' => 'json', - 'schema' => [ - 'title' => '对应标签键列表，最多包含20个子项', - 'description' => 'The keys of tags. You can specify a maximum number of 20 keys.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The key of a tag.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'GENIE_FUNCTION', - ], - 'required' => false, + ], + [ + 'apiName' => 'CreateFunctionTask', + 'description' => '', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'opensearch:WriteFunction', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'OpenSearch', 'resourceType' => 'FunctionTask', 'arn' => 'acs:opensearch:{#regionId}:{#accountId}:apps/{#AppGroupId}'], ], ], - [ - 'name' => 'all', - 'in' => 'query', - 'schema' => [ - 'title' => '是否全部删除，只针对tags为空时有效。取值范围： true false True False 默认是 false', - 'description' => 'Specifies whether to remove all tags from the specified one or more resources. This parameter takes effect only if the tagKey parameter is not specified. Valid values: true and false. Default value: false.'."\n", - 'type' => 'boolean', - 'required' => false, - 'example' => 'true', + ], + [ + 'apiName' => 'ListQueryProcessorNers', + 'description' => '', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'opensearch:ListQueryProcessorNers', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'OpenSearch', 'resourceType' => 'QueryProcessor', 'arn' => 'acs:opensearch:{#regionId}:{#accountId}:apps/*'], ], ], ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'description' => 'The response body.'."\n", - 'type' => 'object', - 'properties' => [ - 'tequestId' => [ - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => '1-A-0-B', - ], - ], + [ + 'apiName' => 'ListQuotaReviewTasks', + 'description' => '', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'opensearch:DescribeApp', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'OpenSearch', 'resourceType' => 'AppGroup', 'arn' => 'acs:opensearch:{#regionId}:{#accountId}:apps/{#AppGroupId}'], ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"tequestId\\": \\"1-B-2-V\\"\\n}","type":"json"}]', - 'title' => 'UntagResources', - ], - 'ListTagResources' => [ - 'summary' => 'Queries tagged resources.', - 'path' => '/v4/openapi/resource-tags', - 'methods' => [ - 'get', + [ + 'apiName' => 'UntagResources', + 'description' => '', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'opensearch:UntagResources', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'OpenSearch', 'resourceType' => 'AppGroup', 'arn' => 'acs:opensearch:{#regionId}:{#accountId}:instance/{#AppGroupId}'], + ], + ], ], - 'schemes' => [ - 'http', - 'https', + [ + 'apiName' => 'ModifyQueryProcessor', + 'description' => '', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'opensearch:WriteQueryProcessor', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'OpenSearch', 'resourceType' => 'QueryProcessor', 'arn' => 'acs:opensearch:{#regionId}:{#accountId}:apps/{#AppGroupId}'], + ], + ], ], - 'security' => [ - [ - 'AK' => [], + [ + 'apiName' => 'DescribeUserAnalyzer', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'opensearch:DescribeUserAnalyzer', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'OpenSearch', 'resourceType' => 'Analyzer', 'arn' => 'acs:opensearch:{#regionId}:{#accountId}:user-analyzers/{#AnalyzerId}'], + ], ], ], - 'produces' => [ - 'application/json', + [ + 'apiName' => 'ListSortScripts', + 'description' => '', + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'opensearch:DescribeSortScript', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'OpenSearch', 'resourceType' => 'App', 'arn' => 'acs:opensearch:{#regionId}:{#accountId}:apps/{#AppGroupId}'], + ], + ], ], - 'operationType' => 'read', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - 'abilityTreeCode' => '152935', - 'abilityTreeNodes' => [ - 'FEATUREopensearchGVH0IN', - 'FEATUREopensearch447AAX', - 'FEATUREopensearch5OZOSP', + [ + 'apiName' => 'RemoveQueryProcessor', + 'description' => '', + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'opensearch:WriteQueryProqcessor', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'OpenSearch', 'resourceType' => 'QueryProcessor', 'arn' => 'acs:opensearch:{#regionId}:{#accountId}:apps/{#AppGroupId}'], + ], ], ], - 'parameters' => [ - [ - 'name' => 'resourceType', - 'in' => 'query', - 'schema' => [ - 'title' => '资源类型', - 'description' => 'The resource type.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'BIGDATA', + [ + 'apiName' => 'DescribeDataCollction', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'opensearch:DescribeDataCollection', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'OpenSearch', 'resourceType' => 'DataCollection', 'arn' => 'acs:opensearch:{#regionId}:{#accountId}:apps/{#AppGroupId}'], ], ], - [ - 'name' => 'resourceId', - 'in' => 'query', - 'style' => 'json', - 'schema' => [ - 'title' => '资源ID,最多 50个子项', - 'description' => 'The resource IDs. You can specify a maximum number of 50 resource IDs.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The IDs of the resources that you want to query. You must configure at least one of the resourceId and tag parameters.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'i-bp185wwblwfvh1a1y1me', - ], - 'required' => false, + ], + [ + 'apiName' => 'GenerateMergedTable', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'opensearch:GenerateMergedTable', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'OpenSearch', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], - [ - 'name' => 'tag', - 'in' => 'query', - 'style' => 'json', - 'schema' => [ - 'title' => '对应新增标签列表，最多包含20个子项', - 'description' => 'The tags. You can specify a maximum number of 20 tags.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The internal name of the entity type.'."\n", - 'type' => 'object', - 'properties' => [ - 'key' => [ - 'title' => '标签键', - 'description' => 'The key of the tag.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'bm', - ], - 'value' => [ - 'title' => '标签值', - 'description' => 'The value of the tag.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'Uefi', - ], - ], - 'required' => false, - ], - 'required' => false, + ], + [ + 'apiName' => 'ListFunctionResources', + 'description' => '', + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'opensearch:DescribeFunction', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'OpenSearch', 'resourceType' => 'FunctionResource', 'arn' => 'acs:opensearch:{#regionId}:{#accountId}:apps/{#AppGroupId}'], ], ], - [ - 'name' => 'nextToken', - 'in' => 'query', - 'schema' => [ - 'title' => '下一个查询开始Token', - 'description' => 'The token that is used to retrieve the next page.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '60', + ], + [ + 'apiName' => 'SaveSortScriptFile', + 'description' => '', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'opensearch:WriteSortScript', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'OpenSearch', 'resourceType' => 'App', 'arn' => 'acs:opensearch:{#regionId}:{#accountId}:apps/{#AppGroupId}'], ], ], ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'type' => 'object', - 'properties' => [ - 'requestId' => [ - 'title' => '请求id', - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => 'D77D0DAF-790D-F5F5-A9C0-133738165014', - ], - 'nextToken' => [ - 'title' => '下一个查询开始Token', - 'description' => 'The token that is used to retrieve the next page.'."\n", - 'type' => 'string', - 'example' => '20', - ], - 'result' => [ - 'title' => '资源列表', - 'description' => 'The resources.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The result of the request.'."\n", - 'type' => 'object', - 'properties' => [ - 'tagKey' => [ - 'title' => '标签键', - 'description' => 'The key of the tag.'."\n", - 'type' => 'string', - 'example' => 'GENIE_FUNCTION', - ], - 'tagValue' => [ - 'title' => '标签值', - 'description' => 'The value of the tag.'."\n", - 'type' => 'string', - 'example' => 'ALLOW', - ], - 'resourceId' => [ - 'title' => '资源ID', - 'description' => 'The ID of the resource.'."\n", - 'type' => 'string', - 'example' => '54041', - ], - 'resourceType' => [ - 'title' => '资源类型', - 'description' => 'The resource type.'."\n", - 'type' => 'string', - 'example' => 'hostGroup', - ], - ], - ], - ], - ], + [ + 'apiName' => 'DeleteSortScriptFile', + 'description' => '', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'opensearch:WriteSortScript', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'OpenSearch', 'resourceType' => 'App', 'arn' => 'acs:opensearch:{#regionId}:{#accountId}:apps/{#AppGroupId}'], ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"D77D0DAF-790D-F5F5-A9C0-133738165014\\",\\n \\"nextToken\\": \\"20\\",\\n \\"result\\": [\\n {\\n \\"tagKey\\": \\"GENIE_FUNCTION\\",\\n \\"tagValue\\": \\"ALLOW\\",\\n \\"resourceId\\": \\"54041\\",\\n \\"resourceType\\": \\"hostGroup\\"\\n }\\n ]\\n}","type":"json"}]', - 'title' => 'ListTagResources', - ], - 'TagResources' => [ - 'summary' => 'Adds tags to resources.', - 'path' => '/v4/openapi/resource-tags', - 'methods' => [ - 'post', + [ + 'apiName' => 'UpdateSearchStrategy', + 'description' => '', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'opensearch:WriteSearchStrategy', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'OpenSearch', 'resourceType' => 'SearchStrategy', 'arn' => 'acs:opensearch:{#regionId}:{#accountId}:apps/{#AppGroupId}'], + ], + ], ], - 'schemes' => [ - 'http', - 'https', + [ + 'apiName' => 'ModifyAppGroup', + 'description' => '', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'opensearch:ModifyAppGroup', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'OpenSearch', 'resourceType' => 'AppGroup', 'arn' => 'acs:opensearch:{#regionId}:{#accountId}:app-groups/{#AppGroupId}'], + ], + ], ], - 'security' => [ - [ - 'AK' => [], + [ + 'apiName' => 'DisableSlowQuery', + 'description' => '', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'opensearch:DisableSlowQuery', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'OpenSearch', 'resourceType' => 'AppGroup', 'arn' => 'acs:opensearch:{#regionId}:{#accountId}:apps/{#AppGroupId}'], + ], + ], + ], + [ + 'apiName' => 'CreateFunctionResource', + 'description' => '', + 'operationType' => '', + 'ramAction' => [ + 'action' => 'opensearch:WriteFunction', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'OpenSearch', 'resourceType' => 'FunctionResource', 'arn' => 'acs:opensearch:{#regionId}:{#accountId}:apps/{#AppGroupId}'], + ], ], ], - 'produces' => [ - 'application/json', + [ + 'apiName' => 'ModifyFirstRank', + 'description' => '', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'opensearch:WriteFirstRank', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'OpenSearch', 'resourceType' => 'FirstRank', 'arn' => 'acs:opensearch:{#regionId}:{#accountId}:apps/{#AppGroupId}'], + ], + ], ], - 'operationType' => 'readAndWrite', - 'deprecated' => false, - 'systemTags' => [ + [ + 'apiName' => 'DeleteABTestExperiment', + 'description' => '', + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'opensearch:DeleteApp', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'OpenSearch', 'resourceType' => 'AbTestExperiment', 'arn' => 'acs:opensearch:{#regionId}:{#accountId}:apps/{#AppGroupId}'], + ], + ], + ], + [ + 'apiName' => 'DeleteSortScript', + 'description' => '', + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'opensearch:WriteSortScript', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'OpenSearch', 'resourceType' => 'App', 'arn' => 'acs:opensearch:{#regionId}:{#accountId}:apps/{#AppGroupId}'], + ], + ], + ], + [ + 'apiName' => 'EnableSlowQuery', + 'description' => '', 'operationType' => 'none', - 'abilityTreeCode' => '152937', - 'abilityTreeNodes' => [ - 'FEATUREopensearch447AAX', + 'ramAction' => [ + 'action' => 'opensearch:EnableSlowQuery', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'OpenSearch', 'resourceType' => 'AppGroup', 'arn' => 'acs:opensearch:{#regionId}:{#accountId}:apps/{#AppGroupId}'], + ], ], ], - 'parameters' => [ - [ - 'name' => 'body', - 'in' => 'body', - 'style' => 'json', - 'schema' => [ - 'description' => 'The request parameters.'."\n", - 'type' => 'object', - 'properties' => [ - 'resourceType' => [ - 'title' => '资源类型', - 'description' => 'The resource type.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'ProductVersion', - ], - 'resourceId' => [ - 'title' => '资源ID,最多 50个子项', - 'description' => 'The resource IDs. You can specify a maximum number of 50 resource IDs.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The ID of the resource.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '68968', - ], - 'required' => true, - ], - 'tag' => [ - 'title' => '对应新增标签列表，最多包含20个子项', - 'description' => 'The tags. You can specify a maximum number of 20 tags.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The internal name of the entity type.'."\n", - 'type' => 'object', - 'properties' => [ - 'key' => [ - 'title' => '标签键', - 'description' => 'The key of the tag.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'cloud_manage', - ], - 'value' => [ - 'title' => '标签值', - 'description' => 'The value of the tag.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '31261301', - ], - ], - 'required' => false, - ], - 'required' => true, - ], - ], - 'required' => false, + [ + 'apiName' => 'CreateApp', + 'description' => '', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'opensearch:CreateApp', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'OpenSearch', 'resourceType' => 'App', 'arn' => 'acs:opensearch:{#regionId}:{#accountId}:app-groups/{#AppGroupId}'], ], ], ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'description' => 'The response body.'."\n", - 'type' => 'object', - 'properties' => [ - 'requestId' => [ - 'title' => '请求id', - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => 'ABCDEFGH', - ], - ], + [ + 'apiName' => 'CreateFirstRank', + 'description' => '', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'opensearch:WriteFirstRank', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'OpenSearch', 'resourceType' => 'FirstRank', 'arn' => 'acs:opensearch:{#regionId}:{#accountId}:apps/{#AppGroupId}'], ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"ABCDEFGH\\"\\n}","type":"json"}]', - 'title' => 'TagResources', - ], - 'GetFunctionResource' => [ - 'summary' => 'Queries an algorithm resource.', - 'path' => '/v4/openapi/app-groups/{appGroupIdentity}/functions/{functionName}/resources/{resourceName}', - 'methods' => [ - 'get', + [ + 'apiName' => 'UpdateFunctionInstance', + 'description' => '', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'opensearch:WriteFunction', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'OpenSearch', 'resourceType' => 'FunctionInstance', 'arn' => 'acs:opensearch:{#regionId}:{#accountId}:apps/{#AppGroupId}'], + ], + ], ], - 'schemes' => [ - 'http', - 'https', + [ + 'apiName' => 'CompileSortScript', + 'description' => '', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'opensearch:WriteSortScript', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'OpenSearch', 'resourceType' => 'App', 'arn' => 'acs:opensearch:{#regionId}:{#accountId}:apps/{#AppGroupId}'], + ], + ], ], - 'security' => [ - [ - 'AK' => [], + [ + 'apiName' => 'GetSortScriptFile', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'opensearch:DescribeSortScript', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'OpenSearch', 'resourceType' => 'SortScript', 'arn' => 'acs:opensearch:{#regionId}:{#accountId}:apps/{#AppGroupId}'], + ], ], ], - 'produces' => [ - 'application/json', + [ + 'apiName' => 'ListStatisticLogs', + 'description' => '', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'opensearch:ListStatisticLogs', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'OpenSearch', 'resourceType' => 'AppGroup', 'arn' => 'acs:opensearch:{#regionId}:{#accountId}:app-groups/{#AppGroupId}'], + ], + ], ], - 'operationType' => 'read', - 'deprecated' => false, - 'systemTags' => [ + [ + 'apiName' => 'ListTagResources', + 'description' => '', 'operationType' => 'get', - 'abilityTreeCode' => '173353', - 'abilityTreeNodes' => [ - 'FEATUREopensearchZAE4HR', + 'ramAction' => [ + 'action' => 'opensearch:ListTagResources', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'OpenSearch', 'resourceType' => 'AppGroup', 'arn' => 'acs:opensearch:{#regionId}:{#accountId}:instance/{#AppGroupId}'], + ], ], ], - 'parameters' => [ - [ - 'name' => 'appGroupIdentity', - 'in' => 'path', - 'schema' => [ - 'title' => '应用ID', - 'description' => 'The ID of the application.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'my_app_group_name', + [ + 'apiName' => 'ListStatisticReport', + 'description' => '', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'opensearch:ListStatisticReport', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'OpenSearch', 'resourceType' => 'AppGroup', 'arn' => 'acs:opensearch:{#regionId}:{#accountId}:app-groups/{#AppGroupId}'], ], ], - [ - 'name' => 'functionName', - 'in' => 'path', - 'schema' => [ - 'title' => '功能名称', - 'description' => 'The name of the feature.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'rank', + ], + [ + 'apiName' => 'DescribeScheduledTask', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'opensearch:DescribeScheduledTask', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'OpenSearch', 'resourceType' => 'ScheduledTask', 'arn' => 'acs:opensearch:{#regionId}:{#accountId}:app-groups/{#AppGroupId}'], ], ], - [ - 'name' => 'resourceName', - 'in' => 'path', - 'schema' => [ - 'title' => '实例名称', - 'description' => 'The name of the instance.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'fg_json', + ], + [ + 'apiName' => 'DeleteABTestScene', + 'description' => '', + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'opensearch:DeleteApp', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'OpenSearch', 'resourceType' => 'AbTestScene', 'arn' => 'acs:opensearch:{#regionId}:{#accountId}:apps/{#AppGroupId}'], ], ], - [ - 'name' => 'output', - 'in' => 'query', - 'schema' => [ - 'title' => '输出等级', - 'description' => 'The output level.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* simple'."\n" - .'* normal'."\n" - .'* detail'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'detail', - 'enum' => [ - 'simple', - 'normal', - 'detail', - ], + ], + [ + 'apiName' => 'DeleteABTestGroup', + 'description' => '', + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'opensearch:DeleteApp', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'OpenSearch', 'resourceType' => 'AbTestGroup', 'arn' => 'acs:opensearch:{#regionId}:{#accountId}:apps/{#AppGroupId}'], ], ], ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'type' => 'object', - 'properties' => [ - 'Status' => [ - 'description' => 'The HTTP status code. Valid values:'."\n" - ."\n" - .'* OK'."\n" - .'* FAIL'."\n", - 'type' => 'string', - 'example' => 'OK', - ], - 'HttpCode' => [ - 'description' => 'The HTTP status code returned.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '200', - ], - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => 'E215C843-0795-5293-AC9A-14FE0723E890', - ], - 'Message' => [ - 'description' => 'The error message returned.'."\n", - 'type' => 'string', - 'example' => 'Resource not exist.', - ], - 'Code' => [ - 'description' => 'The error code returned. If no error occurs, this value is empty.'."\n", - 'type' => 'string', - 'example' => 'Resource.NotExist', - ], - 'Result' => [ - 'description' => 'The returned results.'."\n", - 'type' => 'object', - 'properties' => [ - 'CreateTime' => [ - 'description' => 'The time when the resource was created. Unit: milliseconds.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1234', - ], - 'Data' => [ - 'description' => 'The resource data. The data structure varies with the resource type.'."\n", - 'type' => 'object', - 'properties' => [ - 'Content' => [ - 'description' => 'The content of the file that corresponds to a resource of the raw_file type.'."\n", - 'type' => 'string', - 'example' => 'abc', - ], - 'Generators' => [ - 'description' => 'The feature generators that correspond to resources of the feature_generator type.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'Generator' => [ - 'description' => 'The type of the feature generator.'."\n", - 'type' => 'string', - 'example' => 'id', - ], - 'Input' => [ - 'description' => 'The input.'."\n", - 'type' => 'object', - 'properties' => [ - 'Features' => [ - 'description' => 'The input features.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'Name' => [ - 'description' => 'The name of the feature.'."\n", - 'type' => 'string', - 'example' => 'system_item_id', - ], - 'Type' => [ - 'description' => 'The type of the feature.'."\n", - 'type' => 'string', - 'example' => 'item', - ], - ], - ], - ], - ], - ], - 'Output' => [ - 'description' => 'The name of the output feature.'."\n", - 'type' => 'string', - 'example' => 'output_feature_name', - ], - ], - ], - ], - ], - ], - 'Description' => [ - 'description' => 'The description of the resource.'."\n", - 'type' => 'string', - 'example' => '""', - ], - 'FunctionName' => [ - 'description' => 'The name of the feature.'."\n", - 'type' => 'string', - 'example' => 'rank', - ], - 'ModifyTime' => [ - 'description' => 'The time when the resource was modified. Unit: milliseconds.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1234', - ], - 'ReferencedInstances' => [ - 'description' => 'The algorithm instances that are referenced.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The name of the instance.'."\n", - 'type' => 'string', - 'example' => 'instance1', - ], - ], - 'ResourceName' => [ - 'description' => 'The name of the resource.'."\n", - 'type' => 'string', - 'example' => 'fg_json', - ], - 'ResourceType' => [ - 'description' => 'The type of the resource.'."\n", - 'type' => 'string', - 'example' => 'raw_file', - ], - ], - ], - 'Latency' => [ - 'description' => 'The time consumed for the API request. Unit: milliseconds.'."\n", - 'type' => 'number', - 'format' => 'double', - 'example' => '123', - ], - ], - 'description' => '', + [ + 'apiName' => 'TagResources', + 'description' => '', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'opensearch:TagResources', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'OpenSearch', 'resourceType' => 'AppGroup', 'arn' => 'acs:opensearch:{#regionId}:{#accountId}:instance/{#AppGroupId}'], ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + [ + 'apiName' => 'ListSlowQueryCategories', + 'description' => '', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'opensearch:ListSlowQueryCategories', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'OpenSearch', 'resourceType' => 'AppGroup', 'arn' => 'acs:opensearch:{#regionId}:{#accountId}:apps/{#AppGroupId}'], + ], + ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Status\\": \\"OK\\",\\n \\"HttpCode\\": 200,\\n \\"RequestId\\": \\"E215C843-0795-5293-AC9A-14FE0723E890\\",\\n \\"Message\\": \\"Resource not exist.\\",\\n \\"Code\\": \\"Resource.NotExist\\",\\n \\"Result\\": {\\n \\"CreateTime\\": 1234,\\n \\"Data\\": {\\n \\"Content\\": \\"abc\\",\\n \\"Generators\\": [\\n {\\n \\"Generator\\": \\"id\\",\\n \\"Input\\": {\\n \\"Features\\": [\\n {\\n \\"Name\\": \\"system_item_id\\",\\n \\"Type\\": \\"item\\"\\n }\\n ]\\n },\\n \\"Output\\": \\"output_feature_name\\"\\n }\\n ]\\n },\\n \\"Description\\": \\"\\\\\\"\\\\\\"\\",\\n \\"FunctionName\\": \\"rank\\",\\n \\"ModifyTime\\": 1234,\\n \\"ReferencedInstances\\": [\\n \\"instance1\\"\\n ],\\n \\"ResourceName\\": \\"fg_json\\",\\n \\"ResourceType\\": \\"raw_file\\"\\n },\\n \\"Latency\\": 123\\n}","type":"json"}]', - 'title' => 'GetFunctionResource', - ], - 'ListFunctionResources' => [ - 'summary' => 'Queries algorithm resources.', - 'path' => '/v4/openapi/app-groups/{appGroupIdentity}/functions/{functionName}/resources', - 'methods' => [ - 'get', + [ + 'apiName' => 'GetFunctionInstance', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'opensearch:DescribeFunction', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'OpenSearch', 'resourceType' => 'FunctionInstance', 'arn' => 'acs:opensearch:{#regionId}:{#accountId}:apps/{#AppGroupId}'], + ], + ], + ], + [ + 'apiName' => 'CreateInterventionDictionary', + 'description' => '', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'opensearch:WriteInterventionDictionary', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'OpenSearch', 'resourceType' => 'InterventionDictionary', 'arn' => 'acs:opensearch:{#regionId}:{#accountId}:intervention-dictionaries/*'], + ], + ], ], - 'schemes' => [ - 'http', - 'https', + [ + 'apiName' => 'ListSearchStrategies', + 'description' => '', + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'opensearch:DescribeSearchStrategy', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'OpenSearch', 'resourceType' => 'SearchStrategy', 'arn' => 'acs:opensearch:{#regionId}:{#accountId}:apps/{#AppGroupId}'], + ], + ], ], - 'security' => [ - [ - 'AK' => [], + [ + 'apiName' => 'ListABTestGroups', + 'description' => '', + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'opensearch:ListApp', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'OpenSearch', 'resourceType' => 'AbTestGroup', 'arn' => 'acs:opensearch:{#regionId}:{#accountId}:apps/{#AppGroupId}'], + ], ], ], - 'produces' => [ - 'application/json', + [ + 'apiName' => 'GetFunctionCurrentVersion', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'opensearch:DescribeFunction', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'OpenSearch', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], ], - 'operationType' => 'read', - 'deprecated' => false, - 'systemTags' => [ + [ + 'apiName' => 'ListABTestExperiments', + 'description' => '', 'operationType' => 'list', - 'abilityTreeCode' => '173357', - 'abilityTreeNodes' => [ - 'FEATUREopensearch447AAX', + 'ramAction' => [ + 'action' => 'opensearch:ListApp', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'OpenSearch', 'resourceType' => 'AbTestExperiment', 'arn' => 'acs:opensearch:{#regionId}:{#accountId}:apps/{#AppGroupId}'], + ], ], ], - 'parameters' => [ - [ - 'name' => 'appGroupIdentity', - 'in' => 'path', - 'schema' => [ - 'title' => '应用ID', - 'description' => 'The application ID.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'my_app_group_name', + [ + 'apiName' => 'ListABTestFixedFlowDividers', + 'description' => '', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'opensearch:ListApp', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'OpenSearch', 'resourceType' => 'AbTestExperiment', 'arn' => 'acs:opensearch:{#regionId}:{#accountId}:apps/{#AppGroupId}'], ], ], - [ - 'name' => 'functionName', - 'in' => 'path', - 'schema' => [ - 'title' => '功能名称', - 'description' => 'The name of the feature.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'rank', + ], + [ + 'apiName' => 'CreateScheduledTask', + 'description' => '', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'opensearch:CreateScheduledTask', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'OpenSearch', 'resourceType' => 'ScheduledTask', 'arn' => 'acs:opensearch:{#regionId}:{#accountId}:app-groups/{#AppGroupId}'], ], ], - [ - 'name' => 'resourceType', - 'in' => 'query', - 'schema' => [ - 'title' => '资源类型', - 'description' => 'The type of the resource.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* feature_generator'."\n" - ."\n" - .' '."\n" - ."\n" - .' '."\n" - ."\n" - .' '."\n" - ."\n" - .'* raw_file'."\n" - ."\n" - .' '."\n" - ."\n" - .' '."\n" - ."\n" - .' '."\n", - 'type' => 'string', - 'required' => false, - 'enumValueTitles' => [ - 'feature_generator' => 'feature_generator', - 'raw_file' => 'raw_file', - ], - 'example' => 'feature_generator', + ], + [ + 'apiName' => 'ReplaceAppGroupCommodityCode', + 'description' => '', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'opensearch:UpdateApp', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'OpenSearch', 'resourceType' => 'AppGroup', 'arn' => 'acs:opensearch:{#regionId}:{#accountId}:apps/{#appGroupIdentity}'], ], ], - [ - 'name' => 'output', - 'in' => 'query', - 'schema' => [ - 'title' => '输出等级', - 'description' => 'The output level.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* simple'."\n" - .'* normal'."\n" - .'* detail'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'detail', - 'enum' => [ - 'simple', - 'normal', - 'detail', - ], + ], + [ + 'apiName' => 'ListUserAnalyzerEntries', + 'description' => '', + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'opensearch:DescribeUserAnalyzer', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'OpenSearch', 'resourceType' => 'Analyzer', 'arn' => 'acs:opensearch:{#regionId}:{#accountId}:user-analyzers/{#AnalyzerId}'], ], ], - [ - 'name' => 'pageNumber', - 'in' => 'query', - 'schema' => [ - 'title' => '页码', - 'description' => 'The page number.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', - 'default' => '1', + ], + [ + 'apiName' => 'UpdateAppGroupDeleteProtection', + 'description' => '', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'opensearch:UpdateAppGroupDeleteProtection', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'OpenSearch', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], - [ - 'name' => 'pageSize', - 'in' => 'query', - 'schema' => [ - 'title' => '分页大小', - 'description' => 'The number of entries returned per page.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '10', - 'default' => '10', + ], + [ + 'apiName' => 'ListDataSourceTables', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'opensearch:ListDataSourceTables', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'OpenSearch', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'type' => 'object', - 'properties' => [ - 'Status' => [ - 'description' => 'The status of the request. Valid values: OK and FAIL.'."\n", - 'type' => 'string', - 'example' => 'OK', - ], - 'HttpCode' => [ - 'description' => 'The HTTP status code returned.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '200', - ], - 'TotalCount' => [ - 'description' => 'The total number of records that meet the requirements.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '2', - ], - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '"3A809095-C554-5CF5-8FCE-BE19D4673790"', - ], - 'Message' => [ - 'description' => 'The error message returned.'."\n", - 'type' => 'string', - 'example' => 'Invalid resource name.', - ], - 'Code' => [ - 'description' => 'The error code returned. If no error occurs, this value is empty.'."\n", - 'type' => 'string', - 'example' => 'Resource.InvalidResourceName', - ], - 'Result' => [ - 'description' => 'The results returned.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'CreateTime' => [ - 'description' => 'The time when the resource was created. Unit: milliseconds.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1234', - ], - 'Data' => [ - 'description' => 'The resource data. The data structure varies with the resource type.'."\n", - 'type' => 'object', - 'properties' => [ - 'Content' => [ - 'description' => 'The content of the file that corresponds to a resource of the raw_file type.'."\n", - 'type' => 'string', - 'example' => '"abc"', - ], - 'Generators' => [ - 'description' => 'The feature generators that correspond to resources of the feature_generator type.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'Generator' => [ - 'description' => 'The type of the feature generator.'."\n", - 'type' => 'string', - 'example' => 'combo', - ], - 'Input' => [ - 'description' => 'The input.'."\n", - 'type' => 'object', - 'properties' => [ - 'Features' => [ - 'description' => 'The input features.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'Name' => [ - 'description' => 'The name of the feature.'."\n", - 'type' => 'string', - 'example' => 'system_item_id', - ], - 'Type' => [ - 'description' => 'The type of the feature.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* item'."\n" - ."\n" - .' '."\n" - ."\n" - .' '."\n" - ."\n" - .' '."\n" - ."\n" - .'* user'."\n" - ."\n" - .' '."\n" - ."\n" - .' '."\n" - ."\n" - .' '."\n", - 'type' => 'string', - 'enumValueTitles' => [ - 'item' => 'item', - 'user' => 'user', - ], - 'example' => 'item', - ], - ], - ], - ], - ], - ], - 'Output' => [ - 'description' => 'The name of the output feature.'."\n", - 'type' => 'string', - 'example' => 'feature1', - ], - ], - ], - ], - ], - ], - 'Description' => [ - 'description' => 'The description of the resource.'."\n", - 'type' => 'string', - 'example' => 'resource description', - ], - 'FunctionName' => [ - 'description' => 'The name of the feature.'."\n", - 'type' => 'string', - 'example' => 'rank', - ], - 'ModifyTime' => [ - 'description' => 'The time when the resource was modified. Unit: milliseconds.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1234', - ], - 'ReferencedInstances' => [ - 'description' => 'The algorithm instances that are referenced.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The name of the instance.'."\n", - 'type' => 'string', - 'example' => 'rank_model1', - ], - ], - 'ResourceName' => [ - 'description' => 'The name of the resource.'."\n", - 'type' => 'string', - 'example' => 'fg_json', - ], - 'ResourceType' => [ - 'description' => 'The type of the resource.'."\n", - 'type' => 'string', - 'example' => 'feature_generator', - ], - ], - ], - ], - 'Latency' => [ - 'description' => 'The amount of time consumed for the request. Unit: milliseconds.'."\n", - 'type' => 'number', - 'format' => 'double', - 'example' => '123', - ], - ], - 'description' => '', + [ + 'apiName' => 'CreateABTestGroup', + 'description' => '', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'opensearch:CreateApp', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'OpenSearch', 'resourceType' => 'AbTestGroup', 'arn' => 'acs:opensearch:{#regionId}:{#accountId}:apps/{#AppGroupId}'], ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Status\\": \\"OK\\",\\n \\"HttpCode\\": 200,\\n \\"TotalCount\\": 2,\\n \\"RequestId\\": \\"\\\\\\"3A809095-C554-5CF5-8FCE-BE19D4673790\\\\\\"\\",\\n \\"Message\\": \\"Invalid resource name.\\",\\n \\"Code\\": \\"Resource.InvalidResourceName\\",\\n \\"Result\\": [\\n {\\n \\"CreateTime\\": 1234,\\n \\"Data\\": {\\n \\"Content\\": \\"\\\\\\"abc\\\\\\"\\",\\n \\"Generators\\": [\\n {\\n \\"Generator\\": \\"combo\\",\\n \\"Input\\": {\\n \\"Features\\": [\\n {\\n \\"Name\\": \\"system_item_id\\",\\n \\"Type\\": \\"item\\"\\n }\\n ]\\n },\\n \\"Output\\": \\"feature1\\"\\n }\\n ]\\n },\\n \\"Description\\": \\"resource description\\",\\n \\"FunctionName\\": \\"rank\\",\\n \\"ModifyTime\\": 1234,\\n \\"ReferencedInstances\\": [\\n \\"rank_model1\\"\\n ],\\n \\"ResourceName\\": \\"fg_json\\",\\n \\"ResourceType\\": \\"feature_generator\\"\\n }\\n ],\\n \\"Latency\\": 123\\n}","type":"json"}]', - 'title' => 'ListFunctionResources', - ], - 'DeleteFunctionResource' => [ - 'summary' => 'Deletes an algorithm resource.', - 'path' => '/v4/openapi/app-groups/{appGroupIdentity}/functions/{functionName}/resources/{resourceName}', - 'methods' => [ - 'delete', + [ + 'apiName' => 'RemoveApp', + 'description' => '', + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'opensearch:RemoveApp', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'OpenSearch', 'resourceType' => 'App', 'arn' => 'acs:opensearch:{#regionId}:{#accountId}:app-groups/{#AppGroupId}'], + ], + ], ], - 'schemes' => [ - 'http', - 'https', + [ + 'apiName' => 'DescribeApp', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'opensearch:DescribeApp', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'OpenSearch', 'resourceType' => 'App', 'arn' => 'acs:opensearch:{#regionId}:{#accountId}:app-groups/{#AppGroupId}'], + ], + ], ], - 'security' => [ - [ - 'AK' => [], + [ + 'apiName' => 'ListDataSourceTableFields', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'opensearch:ListDataSourceTableFields', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'OpenSearch', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], - 'produces' => [ - 'application/json', + [ + 'apiName' => 'DescribeAppGroup', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'opensearch:DescribeAppGroup', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'OpenSearch', 'resourceType' => 'AppGroup', 'arn' => 'acs:opensearch:{#regionId}:{#accountId}:app-groups/{#AppGroupId}'], + ], + ], ], - 'operationType' => 'write', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'delete', - 'abilityTreeCode' => '173355', - 'abilityTreeNodes' => [ - 'FEATUREopensearchBQB5UI', + [ + 'apiName' => 'ValidateDataSources', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'opensearch:ValidateDataSources', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'OpenSearch', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], - 'parameters' => [ - [ - 'name' => 'appGroupIdentity', - 'in' => 'path', - 'schema' => [ - 'title' => '应用ID', - 'description' => 'The application ID.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'my_app_group_name', + [ + 'apiName' => 'GetFunctionResource', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'opensearch:DescribeFunction', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'OpenSearch', 'resourceType' => 'FunctionResource', 'arn' => 'acs:opensearch:{#regionId}:{#accountId}:apps/{#AppGroupId}'], ], ], - [ - 'name' => 'functionName', - 'in' => 'path', - 'schema' => [ - 'title' => '功能名称', - 'description' => 'The name of the feature.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'rank', + ], + [ + 'apiName' => 'ListInterventionDictionaries', + 'description' => '', + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'opensearch:ListInterventionDictionaries', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'OpenSearch', 'resourceType' => 'InterventionDictionary', 'arn' => 'acs:opensearch:{#regionId}:{#accountId}:intervention-dictionaries/*'], ], ], - [ - 'name' => 'resourceName', - 'in' => 'path', - 'schema' => [ - 'title' => '资源名称', - 'description' => 'The name of the resource.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'fg_json', + ], + [ + 'apiName' => 'CreateUserAnalyzer', + 'description' => '', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'opensearch:CreateUserAnalyzer', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'OpenSearch', 'resourceType' => 'Analyzer', 'arn' => 'acs:opensearch:{#regionId}:{#accountId}:user-analyzers/*'], ], ], ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'type' => 'object', - 'properties' => [ - 'Status' => [ - 'description' => 'The status code. Valid values:'."\n" - ."\n" - .'* OK'."\n" - .'* FAIL'."\n", - 'type' => 'string', - 'example' => 'OK', - ], - 'HttpCode' => [ - 'description' => 'The HTTP status code returned.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '200', - ], - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => 'A4D487A9-A456-5AA5-A9C6-B7BF2889CF74', - ], - 'Message' => [ - 'description' => 'The error message.'."\n", - 'type' => 'string', - 'example' => '""', - ], - 'Code' => [ - 'description' => 'The error code returned. If no error occurs, this value is empty.'."\n", - 'type' => 'string', - 'example' => '""', - ], - 'Latency' => [ - 'description' => 'The time consumed for the request. Unit: milliseconds.'."\n", - 'type' => 'number', - 'format' => 'double', - 'example' => '123', - ], - ], - 'description' => '', + [ + 'apiName' => 'RemoveInterventionDictionary', + 'description' => '', + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'opensearch:WriteInterventionDictionary', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'OpenSearch', 'resourceType' => 'InterventionDictionary', 'arn' => 'acs:opensearch:{#regionId}:{#accountId}:intervention-dictionaries/{#InterventionDictionaryId}'], ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + [ + 'apiName' => 'ListInterventionDictionaryRelatedEntities', + 'description' => '', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'opensearch:DescribeInterventionDictionary', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'OpenSearch', 'resourceType' => 'InterventionDictionary', 'arn' => 'acs:opensearch:{#regionId}:{#accountId}:intervention-dictionaries/{#InterventionDictionaryId}'], + ], + ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Status\\": \\"OK\\",\\n \\"HttpCode\\": 200,\\n \\"RequestId\\": \\"A4D487A9-A456-5AA5-A9C6-B7BF2889CF74\\",\\n \\"Message\\": \\"\\\\\\"\\\\\\"\\",\\n \\"Code\\": \\"\\\\\\"\\\\\\"\\",\\n \\"Latency\\": 123\\n}","type":"json"}]', - 'title' => 'DeleteFunctionResource', - ], - 'UpdateFunctionResource' => [ - 'summary' => 'Updates an algorithm resource.', - 'path' => '/v4/openapi/app-groups/{appGroupIdentity}/functions/{functionName}/resources/{resourceName}', - 'methods' => [ - 'put', + [ + 'apiName' => 'ListQueryProcessors', + 'description' => '', + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'opensearch:ListQueryProcessor', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'OpenSearch', 'resourceType' => 'QueryProcessor', 'arn' => 'acs:opensearch:{#regionId}:{#accountId}:apps/{#AppGroupId}'], + ], + ], ], - 'schemes' => [ - 'http', - 'https', + [ + 'apiName' => 'ListUserAnalyzers', + 'description' => '', + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'opensearch:ListUserAnalyzers', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'OpenSearch', 'resourceType' => 'Analyzer', 'arn' => 'acs:opensearch:{#regionId}:{#accountId}:user-analyzers/*'], + ], + ], ], - 'security' => [ - [ - 'AK' => [], + [ + 'apiName' => 'CreateFunctionInstance', + 'description' => '', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'opensearch:WriteFunction', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'OpenSearch', 'resourceType' => 'FunctionInstance', 'arn' => 'acs:opensearch:{#regionId}:{#accountId}:apps/{#AppGroupId}'], + ], ], ], - 'consumes' => [ - 'application/json', + [ + 'apiName' => 'UnbindEsInstance', + 'description' => '', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'opensearch:UnBindEsInstance', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'OpenSearch', 'resourceType' => 'AppGroup', 'arn' => 'acs:opensearch:{#regionId}:{#accountId}:app-groups/{#AppGroupId}'], + ], + ], ], - 'produces' => [ - 'application/json', + [ + 'apiName' => 'GetFunctionVersion', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'opensearch:DescribeFunction', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'OpenSearch', 'resourceType' => 'FunctionInstance', 'arn' => 'acs:opensearch:{#regionId}:{#accountId}:apps/{#AppGroupId}'], + ], + ], ], - 'operationType' => 'write', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'update', - 'abilityTreeCode' => '173356', - 'abilityTreeNodes' => [ - 'FEATUREopensearchUIICM8', + [ + 'apiName' => 'ListFirstRanks', + 'description' => '', + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'opensearch:ListFirstRank', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'OpenSearch', 'resourceType' => 'FirstRank', 'arn' => 'acs:opensearch:{#regionId}:{#accountId}:apps/{#AppGroupId}'], + ], ], ], - 'parameters' => [ - [ - 'name' => 'appGroupIdentity', - 'in' => 'path', - 'schema' => [ - 'title' => '应用ID', - 'description' => 'The application ID.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'my_app_group_name', + [ + 'apiName' => 'CreateAppGroup', + 'description' => '', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'opensearch:CreateAppGroup', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'OpenSearch', 'resourceType' => 'AppGroup', 'arn' => 'acs:opensearch:{#regionId}:{#accountId}:app-groups/*'], ], ], - [ - 'name' => 'functionName', - 'in' => 'path', - 'schema' => [ - 'title' => '功能名称', - 'description' => 'The name of the feature.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'rank', + ], + [ + 'apiName' => 'UpdateFunctionResource', + 'description' => '', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'opensearch:WriteFunction', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'OpenSearch', 'resourceType' => 'FunctionResource', 'arn' => 'acs:opensearch:{#regionId}:{#accountId}:apps/{#AppGroupId}'], ], ], - [ - 'name' => 'resourceName', - 'in' => 'path', - 'schema' => [ - 'title' => '资源名称', - 'description' => 'The name of the resource.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'fg_json', + ], + [ + 'apiName' => 'GetSearchStrategy', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'opensearch:DescribeSearchStrategy', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'OpenSearch', 'resourceType' => 'SearchStrategy', 'arn' => 'acs:opensearch:{#regionId}:{#accountId}:apps/{#AppGroupId}'], ], ], - [ - 'name' => 'body', - 'in' => 'body', - 'style' => 'json', - 'schema' => [ - 'description' => 'The body of the request.'."\n", - 'type' => 'object', - 'properties' => [ - 'Data' => [ - 'description' => 'The resource data. The data structure varies with the resource type.'."\n", - 'type' => 'object', - 'properties' => [ - 'Content' => [ - 'description' => 'The content of the file that corresponds to a resource of the raw_file type.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'abc', - ], - 'Generators' => [ - 'description' => 'The feature generators that correspond to resources of the feature_generator type.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'Generator' => [ - 'description' => 'The type of the feature generator.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'combo', - ], - 'Input' => [ - 'description' => 'The input.'."\n", - 'type' => 'object', - 'properties' => [ - 'Features' => [ - 'description' => 'The input features.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'Name' => [ - 'description' => 'The name of the feature.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'system_item_id', - ], - 'Type' => [ - 'description' => 'The type of the feature.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'item', - ], - ], - 'required' => false, - ], - 'required' => false, - ], - ], - 'required' => false, - ], - 'Output' => [ - 'description' => 'The name of the output feature.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'feature1', - ], - ], - 'required' => false, - ], - 'required' => false, - ], - ], - 'required' => false, - ], - 'Description' => [ - 'description' => 'The description of the resource.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'updated description', - ], - ], - 'required' => false, + ], + [ + 'apiName' => 'DescribeQueryProcessor', + 'description' => '', + 'operationType' => '', + 'ramAction' => [ + 'action' => 'opensearch:DescribeQueryProcessor', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'OpenSearch', 'resourceType' => 'QueryProcessor', 'arn' => 'acs:opensearch:{#regionId}:{#accountId}:apps/{#AppGroupId}'], ], ], ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'type' => 'object', - 'properties' => [ - 'Status' => [ - 'description' => 'The status of the request.'."\n", - 'type' => 'string', - 'example' => 'OK', - ], - 'HttpCode' => [ - 'description' => 'The HTTP status code returned.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '200', - ], - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '7E375703-5B12-5466-8B48-C4D01AE1291A', - ], - 'Message' => [ - 'description' => 'The error message returned.'."\n", - 'type' => 'string', - 'example' => 'Invalid request.', - ], - 'Code' => [ - 'description' => 'The error code. If no error occurs, this parameter is left empty.'."\n", - 'type' => 'string', - 'example' => 'InvalidRequest', - ], - 'Latency' => [ - 'description' => 'The time consumed for the request. Unit: milliseconds.'."\n", - 'type' => 'number', - 'format' => 'double', - 'example' => '123', - ], - ], - 'description' => '', + [ + 'apiName' => 'ModifyScheduledTask', + 'description' => '', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'opensearch:ModifyScheduledTask', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'OpenSearch', 'resourceType' => 'ScheduledTask', 'arn' => 'acs:opensearch:{#regionId}:{#accountId}:app-groups/{#AppGroupId}'], ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + [ + 'apiName' => 'UpdateFunctionDefaultInstance', + 'description' => '', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'opensearch:WriteFunction', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'OpenSearch', 'resourceType' => 'FunctionInstance', 'arn' => 'acs:opensearch:{#regionId}:{#accountId}:apps/{#AppGroupId}'], + ], + ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Status\\": \\"OK\\",\\n \\"HttpCode\\": 200,\\n \\"RequestId\\": \\"7E375703-5B12-5466-8B48-C4D01AE1291A\\",\\n \\"Message\\": \\"Invalid request.\\",\\n \\"Code\\": \\"InvalidRequest\\",\\n \\"Latency\\": 123\\n}","type":"json"}]', - 'title' => 'UpdateFunctionResource', - 'description' => 'You can call this operation to update the information about resources by resource name. You can modify only the values of data and description.'."\n", - ], - 'CreateAppGroupCredentials' => [ - 'path' => '/v4/openapi/app-groups/{appGroupIdentity}/credentials', - 'methods' => [ - 'post', + [ + 'apiName' => 'GetFunctionDefaultInstance', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'opensearch:DescribeFunction', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'OpenSearch', 'resourceType' => 'FunctionDefaultInstance', 'arn' => 'acs:opensearch:{#regionId}:{#accountId}:apps/{#AppGroupId}'], + ], + ], ], - 'schemes' => [ - 'http', - 'https', + [ + 'apiName' => 'RemoveAppGroup', + 'description' => '', + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'opensearch:RemoveAppGroup', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'OpenSearch', 'resourceType' => 'AppGroup', 'arn' => 'acs:opensearch:{#regionId}:{#accountId}:app-groups/{#AppGroupId}'], + ], + ], ], - 'security' => [ - [ - 'AK' => [], + [ + 'apiName' => 'RemoveFirstRank', + 'description' => '', + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'opensearch:WriteFirstRank', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'OpenSearch', 'resourceType' => 'FirstRank', 'arn' => 'acs:opensearch:{#regionId}:{#accountId}:apps/{#AppGroupId}'], + ], ], ], - 'operationType' => 'readAndWrite', - 'deprecated' => false, - 'systemTags' => [ + [ + 'apiName' => 'CreateAppGroupCredentials', + 'description' => '', 'operationType' => 'create', - 'abilityTreeCode' => '228583', - 'abilityTreeNodes' => [ - 'FEATUREopensearch1AJKH0', + 'ramAction' => [ + 'action' => 'opensearch:WriteAppGroupCredential', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'OpenSearch', 'resourceType' => 'AppGroupCredential', 'arn' => 'acs:opensearch:{#regionId}:{#accountId}:appGroup/{#AppGroupId}'], + ], ], ], - 'parameters' => [ - [ - 'name' => 'dryRun', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'boolean', - 'required' => false, + [ + 'apiName' => 'RemoveSearchStrategy', + 'description' => '', + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'opensearch:WriteSearchStrategy', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'OpenSearch', 'resourceType' => 'SearchStrategy', 'arn' => 'acs:opensearch:{#regionId}:{#accountId}:apps/{#AppGroupId}'], ], ], - [ - 'name' => 'body', - 'in' => 'body', - 'style' => 'json', - 'schema' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'type' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'api-token', - ], - ], - 'required' => false, + ], + [ + 'apiName' => 'GetSortScript', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'opensearch:DescribeSortScript', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'OpenSearch', 'resourceType' => 'App', 'arn' => 'acs:opensearch:{#regionId}:{#accountId}:apps/{#AppGroupId}'], ], ], - [ - 'name' => 'appGroupIdentity', - 'in' => 'path', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'app_group_123', + ], + [ + 'apiName' => 'ListAppGroups', + 'description' => '', + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'opensearch:ListAppGroup', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'OpenSearch', 'resourceType' => 'AppGroup', 'arn' => 'acs:opensearch:{#regionId}:{#accountId}:app-groups/*'], ], ], ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'title' => 'Schema of Response', - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'requestId' => [ - 'title' => 'Id of the request', - 'description' => '', - 'type' => 'string', - 'example' => '1-2-3-4', - ], - 'result' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'appGroupId' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => 'app_group_123', - ], - 'type' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'api-token', - ], - 'enabled' => [ - 'description' => '', - 'type' => 'boolean', - ], - 'token' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'generated_token_string', - ], - ], - ], - ], + [ + 'apiName' => 'RemoveSecondRank', + 'description' => '', + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'opensearch:WriteSecondRank', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'OpenSearch', 'resourceType' => 'SecondRank', 'arn' => 'acs:opensearch:{#regionId}:{#accountId}:apps/{#AppGroupId}'], ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + [ + 'apiName' => 'UpdateSortScript', + 'description' => '', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'opensearch:WriteSortScript', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'OpenSearch', 'resourceType' => 'App', 'arn' => 'acs:opensearch:{#regionId}:{#accountId}:apps/{#AppGroupId}'], + ], + ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"1-2-3-4\\",\\n \\"result\\": {\\n \\"appGroupId\\": 0,\\n \\"type\\": \\"api-token\\",\\n \\"enabled\\": true,\\n \\"token\\": \\"generated_token_string\\"\\n }\\n}","type":"json"}]', - 'title' => 'CreateAppGroupCredentials', - ], - ], - 'endpoints' => [ - [ - 'regionId' => 'cn-qingdao', - 'endpoint' => 'opensearch.cn-qingdao.aliyuncs.com', - ], - [ - 'regionId' => 'cn-beijing', - 'endpoint' => 'opensearch.cn-beijing.aliyuncs.com', - ], - [ - 'regionId' => 'cn-zhangjiakou', - 'endpoint' => 'opensearch.cn-zhangjiakou.aliyuncs.com', - ], - [ - 'regionId' => 'cn-hangzhou', - 'endpoint' => 'opensearch.cn-hangzhou.aliyuncs.com', - ], - [ - 'regionId' => 'cn-shanghai', - 'endpoint' => 'opensearch.cn-shanghai.aliyuncs.com', - ], - [ - 'regionId' => 'cn-shenzhen', - 'endpoint' => 'opensearch.cn-shenzhen.aliyuncs.com', - ], - [ - 'regionId' => 'cn-hongkong', - 'endpoint' => 'opensearch.cn-hongkong.aliyuncs.com', - ], - [ - 'regionId' => 'ap-southeast-1', - 'endpoint' => 'opensearch.ap-southeast-1.aliyuncs.com', - ], - [ - 'regionId' => 'ap-southeast-5', - 'endpoint' => 'opensearch.ap-southeast-5.aliyuncs.com', - ], - [ - 'regionId' => 'us-east-1', - 'endpoint' => 'opensearch.us-east-1.aliyuncs.com', ], - [ - 'regionId' => 'eu-central-1', - 'endpoint' => 'opensearch.eu-central-1.aliyuncs.com', + 'resourceTypes' => [ + ['validationType' => 'always', 'resourceType' => 'FunctionTask', 'arn' => 'acs:opensearch:{#regionId}:{#accountId}:apps/{#AppGroupId}'], + ['validationType' => 'always', 'resourceType' => 'AppGroup', 'arn' => 'acs:opensearch:{#regionId}:{#accountId}:app-groups/{#AppGroupId}'], + ['validationType' => 'always', 'resourceType' => 'FunctionResource', 'arn' => 'acs:opensearch:{#regionId}:{#accountId}:apps/{#AppGroupId}'], + ['validationType' => 'always', 'resourceType' => 'AbTestExperiment', 'arn' => 'acs:opensearch:{#regionId}:{#accountId}:apps/{#AppGroupId}'], + ['validationType' => 'always', 'resourceType' => 'AppGroup', 'arn' => 'acs:opensearch:{#regionId}:{#accountId}:apps/{#AppGroupId}'], + ['validationType' => 'always', 'resourceType' => 'SecondRank', 'arn' => 'acs:opensearch:{#regionId}:{#accountId}:apps/{#AppGroupId}'], + ['validationType' => 'always', 'resourceType' => 'AbTestGroup', 'arn' => 'acs:opensearch:{#regionId}:{#accountId}:apps/{#AppGroupId}'], + ['validationType' => 'always', 'resourceType' => 'FunctionInstance', 'arn' => 'acs:opensearch:{#regionId}:{#accountId}:apps/{#AppGroupId}'], + ['validationType' => 'always', 'resourceType' => 'QueryProcessor', 'arn' => 'acs:opensearch:{#regionId}:{#accountId}:apps/{#AppGroupId}'], + ['validationType' => 'always', 'resourceType' => 'FirstRank', 'arn' => 'acs:opensearch:{#regionId}:{#accountId}:apps/{#AppGroupId}'], + ['validationType' => 'always', 'resourceType' => 'SearchStrategy', 'arn' => 'acs:opensearch:{#regionId}:{#accountId}:apps/{#AppGroupId}'], + ['validationType' => 'always', 'resourceType' => 'InterventionDictionary', 'arn' => 'acs:opensearch:{#regionId}:{#accountId}:intervention-dictionaries/{#InterventionDictionaryId}'], + ['validationType' => 'always', 'resourceType' => 'App', 'arn' => 'acs:opensearch:{#regionId}:{#accountId}:apps/{#AppGroupId}'], + ['validationType' => 'always', 'resourceType' => 'App', 'arn' => 'acs:opensearch:{#regionId}:{#accountId}:app-groups/{#AppGroupId}'], + ['validationType' => 'always', 'resourceType' => 'AbTestScene', 'arn' => 'acs:opensearch:{#regionId}:{#accountId}:apps/{#AppGroupId}'], + ['validationType' => 'always', 'resourceType' => 'DataCollection', 'arn' => 'acs:opensearch:{#regionId}:{#accountId}:apps/{#AppGroupId}'], + ['validationType' => 'always', 'resourceType' => 'ABTestScenes', 'arn' => 'acs:opensearch:{#regionId}:{#accountId}:app-groups{#AppGroupId}'], + ['validationType' => 'always', 'resourceType' => 'Analyzer', 'arn' => 'acs:opensearch:{#regionId}:{#accountId}:user-analyzers/{#AnalyzerId}'], + ['validationType' => 'always', 'resourceType' => 'ScheduledTask', 'arn' => 'acs:opensearch:{#regionId}:{#accountId}:app-groups/{#AppGroupId}'], + ['validationType' => 'always', 'resourceType' => 'App', 'arn' => 'acs:opensearch:{#regionId}:{#accountId}:apps/{#AppId}'], + ['validationType' => 'always', 'resourceType' => 'AbTestScene', 'arn' => 'acs:opensearch:{#regionId}:{#accountId}:app-groups/{#AppGroupId}'], + ['validationType' => 'always', 'resourceType' => 'SortScript', 'arn' => 'acs:opensearch:{#regionId}:{#accountId}:apps/{#AppGroupId}'], + ['validationType' => 'always', 'resourceType' => 'Instance', 'arn' => 'acs:opensearch:{#regionId}:{#accountId}:apps/{#AppGroupId}'], + ['validationType' => 'always', 'resourceType' => 'QueryProcessor', 'arn' => 'acs:opensearch:{#regionId}:{#accountId}:apps/*'], + ['validationType' => 'always', 'resourceType' => 'AppGroup', 'arn' => 'acs:opensearch:{#regionId}:{#accountId}:instance/{#AppGroupId}'], + ['validationType' => 'always', 'resourceType' => 'InterventionDictionary', 'arn' => 'acs:opensearch:{#regionId}:{#accountId}:intervention-dictionaries/*'], + ['validationType' => 'always', 'resourceType' => 'FunctionInstance', 'arn' => 'acs:opensearch:{#regionId}:{#accountId}:functions/*'], + ['validationType' => 'always', 'resourceType' => 'AppGroup', 'arn' => 'acs:opensearch:{#regionId}:{#accountId}:apps/{#appGroupIdentity}'], + ['validationType' => 'always', 'resourceType' => 'Analyzer', 'arn' => 'acs:opensearch:{#regionId}:{#accountId}:user-analyzers/*'], + ['validationType' => 'always', 'resourceType' => 'AppGroup', 'arn' => 'acs:opensearch:{#regionId}:{#accountId}:app-groups/*'], + ['validationType' => 'always', 'resourceType' => 'FunctionDefaultInstance', 'arn' => 'acs:opensearch:{#regionId}:{#accountId}:apps/{#AppGroupId}'], + ['validationType' => 'always', 'resourceType' => 'AppGroupCredential', 'arn' => 'acs:opensearch:{#regionId}:{#accountId}:appGroup/{#AppGroupId}'], ], ], ]; -- cgit v1.2.3