summaryrefslogtreecommitdiff
path: root/data/en_us/searchengine/2021-10-25
diff options
context:
space:
mode:
authorZhineng Li <im@zhineng.li>2026-07-12 17:11:17 +0800
committerZhineng Li <im@zhineng.li>2026-07-12 17:11:17 +0800
commit1c7f908ce09f98fdcbf79ed2a8ae21be60eaa634 (patch)
tree5f0857666365b7e40cdaa3733ebe1f3ba9e13c67 /data/en_us/searchengine/2021-10-25
parent7347bac4ab7e136157fc94777e6cf87ef9e08599 (diff)
downloadafterglow-metadata-full-1c7f908ce09f98fdcbf79ed2a8ae21be60eaa634.tar.gz
afterglow-metadata-full-1c7f908ce09f98fdcbf79ed2a8ae21be60eaa634.zip
update APIs 20260712
Diffstat (limited to 'data/en_us/searchengine/2021-10-25')
-rw-r--r--data/en_us/searchengine/2021-10-25/api-docs.php28436
1 files changed, 13110 insertions, 15326 deletions
diff --git a/data/en_us/searchengine/2021-10-25/api-docs.php b/data/en_us/searchengine/2021-10-25/api-docs.php
index 36de72d..7db1d4e 100644
--- a/data/en_us/searchengine/2021-10-25/api-docs.php
+++ b/data/en_us/searchengine/2021-10-25/api-docs.php
@@ -1,713 +1,368 @@
<?php return [
'version' => '1.0',
- 'info' => [
- 'style' => 'ROA',
- 'product' => 'searchengine',
- 'version' => '2021-10-25',
- ],
+ 'info' => ['style' => 'ROA', 'product' => 'searchengine', 'version' => '2021-10-25'],
'directories' => [
[
- 'id' => 169788,
- 'title' => 'The instance details',
+ 'children' => ['CreatePublicUrl', 'DeletePublicUrl', 'ModifyPublicUrlIpList', 'ModifyPassword'],
'type' => 'directory',
- 'children' => [
- 'ChangeResourceGroup',
- 'TagResources',
- 'UntagResources',
- 'ListTagResources',
- 'CreatePublicUrl',
- 'DeletePublicUrl',
- 'ModifyPublicUrlIpList',
- 'CreateInstance',
- 'DeleteInstance',
- 'UpdateInstance',
- 'ModifyPassword',
- 'ListInstances',
- 'GetInstance',
- 'ListInstanceSpecs',
- ],
+ 'title' => 'Instances',
],
[
- 'id' => 169802,
- 'title' => 'The configuration center',
- 'type' => 'directory',
'children' => [
[
- 'id' => 169803,
- 'title' => 'Online table configuration',
+ 'children' => ['GetIndexOnlineStrategy', 'ModifyIndexOnlineStrategy', 'ListOnlineConfigs'],
'type' => 'directory',
- 'children' => [
- 'GetIndexOnlineStrategy',
- 'ModifyIndexOnlineStrategy',
- 'ModifyOnlineConfig',
- 'ListOnlineConfigs',
- ],
+ 'title' => 'Online table configuration',
],
[
- 'id' => 169783,
- 'title' => 'Index structure',
+ 'children' => ['ModifyIndex', 'StartIndex', 'StopIndex', 'BuildIndex', 'PublishIndexVersion', 'ListIndexes', 'RecoverIndex'],
'type' => 'directory',
- 'children' => [
- 'ModifyIndex',
- 'StartIndex',
- 'StopIndex',
- 'CreateIndex',
- 'BuildIndex',
- 'DeleteIndexVersion',
- 'DeleteIndex',
- 'ModifyIndexVersion',
- 'ModifyFile',
- 'PublishIndexVersion',
- 'ModifyIndexPartition',
- 'GetIndex',
- 'GetIndexVersion',
- 'GetFile',
- 'ListIndexes',
- 'RecoverIndex',
- ],
- ],
- [
- 'id' => 169816,
- 'title' => 'Advanced Configuration',
+ 'title' => 'Index structure',
+ ],
+ [
+ 'children' => ['CreateConfigDir', 'DeleteConfigDir', 'ModifyAdvanceConfig', 'ModifyAdvanceConfigFile', 'PublishAdvanceConfig', 'GetAdvanceConfig', 'GetAdvanceConfigFile', 'ListAdvanceConfigs'],
'type' => 'directory',
- 'children' => [
- 'CreateConfigDir',
- 'CreateConfigFile',
- 'DeleteConfigDir',
- 'DeleteConfigFile',
- 'ModifyAdvanceConfig',
- 'DeleteAdvanceConfig',
- 'ModifyAdvanceConfigFile',
- 'PublishAdvanceConfig',
- 'GetAdvanceConfig',
- 'GetAdvanceConfigFile',
- 'ListAdvanceConfigDir',
- 'ListAdvanceConfigs',
- ],
- ],
- [
- 'id' => 169824,
- 'title' => 'Data source configuration',
+ 'title' => 'Advanced configuration',
+ ],
+ [
+ 'children' => ['ModifyDataSourceDeploy', 'ListDateSourceGenerations', 'GetDataSourceDeploy'],
'type' => 'directory',
- 'children' => [
- 'ListSchemas',
- 'ModifyDataSourceDeploy',
- 'CreateDataSource',
- 'DeleteDataSource',
- 'GetDataSource',
- 'ListDataSources',
- 'ListDataSourceSchemas',
- 'ListDateSourceGenerations',
- 'GetDataSourceDeploy',
- ],
+ 'title' => 'Datasource config',
],
],
+ 'type' => 'directory',
+ 'title' => 'Configuration center',
],
[
- 'id' => 194030,
- 'title' => 'Operation and Maintenance Center',
- 'type' => 'directory',
'children' => [
[
- 'id' => 193382,
- 'title' => 'SQL development',
- 'type' => 'directory',
- 'children' => [
- 'CloneSqlInstance',
- 'CreateFolder',
- 'CreateSqlInstance',
- 'DeleteSqlInstance',
- 'ExecuteSqlInstance',
- 'GetDatabaseSchema',
- 'GetSqlInstance',
- 'ListDatabases',
- 'UpdateSqlInstanceContent',
- 'UpdateSqlInstanceName',
- 'UpdateSqlInstanceParams',
- 'DeleteFolder',
- 'RenameFolder',
- ],
- ],
- [
- 'id' => 169800,
- 'title' => 'Change history',
+ 'children' => ['CloneSqlInstance', 'DeleteSqlInstance', 'ExecuteSqlInstance', 'GetDatabaseSchema', 'UpdateSqlInstanceContent', 'UpdateSqlInstanceName', 'UpdateSqlInstanceParams', 'RenameFolder'],
'type' => 'directory',
- 'children' => [
- 'ListTasks',
- 'ListClusterTasks',
- 'ListDataSourceTasks',
- 'StopTask',
- 'ForceSwitch',
- ],
+ 'title' => 'SQL development',
],
[
- 'id' => 194031,
- 'title' => 'Log Management',
+ 'children' => ['ListLogs'],
'type' => 'directory',
- 'children' => [
- 'ListLogs',
- ],
+ 'title' => 'Log management',
],
[
- 'id' => 169796,
- 'title' => 'Deployment Management',
+ 'children' => ['ModifyNodeConfig', 'GetNodeConfig'],
'type' => 'directory',
- 'children' => [
- 'ModifyNodeConfig',
- 'GetDeployGraph',
- 'GetNodeConfig',
- ],
+ 'title' => 'Deployment management',
],
[
- 'id' => 169794,
- 'title' => 'Operation and Maintenance Management',
+ 'children' => ['ListIndexRecoverRecords', 'ListPausePolicys', 'ModifyPausePolicy', 'ModifyClusterDesc', 'ModifyClusterOfflineConfig', 'GetCluster', 'GetClusterRunTimeInfo', 'ListClusterNames'],
'type' => 'directory',
- 'children' => [
- 'ListIndexRecoverRecords',
- 'ListPausePolicys',
- 'ModifyPausePolicy',
- 'CreateCluster',
- 'RemoveCluster',
- 'ModifyClusterDesc',
- 'ModifyClusterOfflineConfig',
- 'ModifyClusterOnlineConfig',
- 'GetCluster',
- 'GetClusterRunTimeInfo',
- 'ListClusterNames',
- 'ListClusters',
- ],
+ 'title' => 'Operations management',
],
],
+ 'type' => 'directory',
+ 'title' => 'O&M center',
],
[
- 'id' => 191973,
- 'title' => 'Table Management',
- 'type' => 'directory',
'children' => [
[
- 'id' => 193711,
- 'title' => 'Table Alias Management',
+ 'children' => ['ModifyAlias'],
'type' => 'directory',
- 'children' => [
- 'ModifyAlias',
- 'ListAliases',
- 'DeleteAlias',
- 'CreateAlias',
- ],
+ 'title' => 'Table alias management',
],
'CreateTable',
'ModifyTable',
- 'GetTable',
- 'ListTables',
'DeleteTable',
'Reindex',
'ListTableGenerations',
'GetTableGeneration',
],
+ 'type' => 'directory',
+ 'title' => 'Table management',
],
[
- 'id' => 180946,
- 'title' => 'Other',
- 'type' => 'directory',
'children' => [
- 'ListPostQueryResult',
- 'ListRestQueryResult',
- 'ListVectorQueryResult',
- 'PushDocuments',
- 'DescribeRegions',
- 'ListQueryResult',
- 'DeleteModel',
- 'ModifyModel',
- 'DebugModel',
- 'GetModel',
- 'ListModels',
- 'CreateModel',
- 'ModifySearcherReplica',
+ 'ListPostQueryResult', 'ListRestQueryResult', 'ListVectorQueryResult', 'PushDocuments', 'ModifyModel', 'DebugModel', 'GetModel', 'ListModels', 'ModifySearcherReplica', 'ChangeResourceGroup', 'CreateAlias', 'CreateCluster', 'CreateConfigFile', 'CreateDataSource', 'CreateFolder', 'CreateIndex', 'CreateInstance', 'CreateModel', 'CreateSqlInstance', 'DeleteAdvanceConfig',
+ 'DeleteAlias', 'DeleteConfigFile', 'DeleteDataSource', 'DeleteFolder', 'DeleteIndex', 'DeleteIndexVersion', 'DeleteInstance', 'DeleteModel', 'DescribeRegions', 'ForceSwitch', 'GetDataSource', 'GetDeployGraph', 'GetFile', 'GetIndex', 'GetIndexVersion', 'GetInstance', 'GetSqlInstance', 'GetTable', 'ListAdvanceConfigDir', 'ListAliases',
+ 'ListClusterTasks', 'ListClusters', 'ListDataSourceSchemas', 'ListDataSourceTasks', 'ListDataSources', 'ListDatabases', 'ListInstanceSpecs', 'ListInstances', 'ListQueryResult', 'ListSchemas', 'ListTables', 'ListTagResources', 'ListTasks', 'ModifyClusterOnlineConfig', 'ModifyFile', 'ModifyIndexPartition', 'ModifyIndexVersion', 'ModifyOnlineConfig', 'RemoveCluster', 'StopTask',
+ 'TagResources', 'UntagResources', 'UpdateInstance',
],
+ 'type' => 'directory',
+ 'title' => 'Others',
],
],
'components' => [
'schemas' => [],
],
'apis' => [
- 'ChangeResourceGroup' => [
- 'summary' => '更换实例资源组',
- 'path' => '/openapi/ha3/instances/{instanceId}/actions/change-resource-group',
- 'methods' => [
- 'post',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
+ 'BuildIndex' => [
+ 'summary' => 'Rebuilds an index.',
+ 'path' => '/openapi/ha3/instances/{instanceId}/actions/build-index',
+ 'methods' => ['post'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
- 'consumes' => [],
- 'produces' => [],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'update',
+ 'riskType' => 'none',
+ 'chargeType' => 'free',
+ 'abilityTreeCode' => '104671',
+ 'abilityTreeNodes' => ['FEATUREopensearchD5N27K'],
],
'parameters' => [
[
'name' => 'instanceId',
'in' => 'path',
- 'schema' => [
- 'description' => 'The instance ID.'."\n",
- 'type' => 'string',
- 'required' => false,
- 'example' => 'ha-cn-pl32rf0****',
- ],
+ 'schema' => ['title' => '', 'description' => 'The ID of the instance.', 'type' => 'string', 'required' => true, 'example' => 'ha-cn-pl32rf0****'],
],
[
'name' => 'body',
'in' => 'body',
'style' => 'json',
'schema' => [
- 'description' => 'The request body.'."\n",
+ 'description' => 'A JSON string. For more information, see the following details.',
'type' => 'object',
'properties' => [
- 'newResourceGroupId' => [
- 'title' => '新资源组id',
- 'description' => 'new resource group id',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'rg-acfmxr3gs*****',
- ],
- 'resourceType' => [
- 'title' => '资源类型',
- 'description' => 'The resource type.'."\n",
- 'type' => 'string',
- 'required' => false,
- 'example' => 'instance',
- ],
+ 'dataSourceName' => ['title' => '', 'description' => 'The name of the data source.', 'type' => 'string', 'required' => false, 'example' => 'ha-cn-pl32rf0****_test_api'],
+ 'domain' => ['title' => '', 'description' => 'The data center of the data source.', 'type' => 'string', 'required' => false, 'example' => 'sz_vpc_domain_1'],
+ 'dataSourceType' => ['title' => '', 'description' => 'The type of the data source.', 'type' => 'string', 'required' => false, 'example' => 'odps'],
+ 'partition' => ['title' => '', 'description' => 'Required if dataSourceType is set to odps.', 'type' => 'string', 'required' => false, 'example' => 'ds=20201010'],
+ 'dataTimeSec' => ['title' => '', 'description' => 'The UNIX timestamp in seconds. This parameter is an integer. This parameter is required if data is pushed to the data source using an API.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1640867288'],
+ 'buildMode' => ['title' => '', 'description' => 'The method to rebuild the index. Valid values: api and indexRecover.', 'type' => 'string', 'required' => false, 'example' => 'api'],
+ 'generation' => ['title' => '', 'description' => 'The backfill ID.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '160131146'],
+ 'tag' => ['type' => 'string', 'description' => 'The tag of the Data Lake Formation (DLF) data source.', 'required' => false, 'title' => '', 'example' => 'test'],
+ 'path' => ['type' => 'string', 'description' => 'The relative path.', 'required' => false, 'title' => '', 'example' => '/test/dir'],
],
'required' => false,
+ 'example' => '{}',
+ 'title' => '',
],
],
],
'responses' => [
200 => [
'schema' => [
- 'title' => 'Schema of Response',
+ 'title' => '',
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
- 'requestId' => [
- 'title' => 'Id of the request',
- 'description' => 'Id of the request',
- 'type' => 'string',
- 'example' => '10D5E615-69F7-5F49-B850-00169ADE513C',
- ],
+ 'requestId' => ['title' => '', 'description' => 'The ID of the request.', 'type' => 'string', 'example' => '407BFD91-DE7D-50BA-8F88-CDE52A3B5E46'],
+ 'result' => ['title' => '', 'description' => 'The returned result.', 'type' => 'object', 'example' => '{}'],
],
+ 'example' => '',
],
],
+ 500 => [],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"10D5E615-69F7-5F49-B850-00169ADE513C\\"\\n}","type":"json"}]',
- 'title' => 'ChangeResourceGroup',
- ],
- 'TagResources' => [
- 'summary' => '打标签接口',
- 'path' => '/openapi/ha3/resource-tags',
- 'methods' => [
- 'post',
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"407BFD91-DE7D-50BA-8F88-CDE52A3B5E46\\",\\n \\"result\\": {}\\n}","type":"json"}]',
+ 'title' => 'BuildIndex',
+ 'description' => '## Method'."\n"
+ ."\n"
+ .'```'."\n"
+ .'POST'."\n"
+ .'```'."\n"
+ ."\n"
+ .'## URI'."\n"
+ ."\n"
+ .'```'."\n"
+ .'/openapi/ha3/instances/{instanceId}/actions/build-index'."\n"
+ .'```',
+ 'requestParamsDescription' => '## Request examples'."\n"
+ ."\n"
+ .'```'."\n"
+ .'POST /openapi/ha3/instances/ha3_instance_name/actions/build-index'."\n"
+ .'```'."\n"
+ ."\n"
+ .'```'."\n"
+ .' {'."\n"
+ .' "dataSourceName": "my_data_source",'."\n"
+ .' "domain": "test", // The data source deployment.'."\n"
+ .' "indexes": ['."\n"
+ .' "index1",'."\n"
+ .' "index2"'."\n"
+ .' ],'."\n"
+ .' "dataSourceType": "odps", // Required. Valid values: odps and swift.'."\n"
+ .' "partition": "20201010", // Required if dataSourceType is set to odps.'."\n"
+ .' "dataTimeSec": 1640867288 // The UNIX timestamp in seconds. This parameter is an integer. Required if data is pushed to the data source using an API.'."\n"
+ .' }'."\n"
+ .'```'."\n"
+ ."\n"
+ .'```'."\n"
+ .'{'."\n"
+ .' "dataSourceName": "my_data_source",'."\n"
+ .' "domain": "test", // The data source deployment.'."\n"
+ .' "indexes": ['."\n"
+ .' "index1",'."\n"
+ .' "index2"'."\n"
+ .' ],'."\n"
+ .' "dataSourceType": "swift", // Required. Valid values: odps and swift.'."\n"
+ .' "partition": "20201010", // Required if dataSourceType is set to odps.'."\n"
+ .' "dataTimeSec": 1640867288 // The UNIX timestamp in seconds. This parameter is an integer. Required if data is pushed to the data source using an API.'."\n"
+ .' }'."\n"
+ .'```',
+ 'responseParamsDescription' => '## Response examples'."\n"
+ ."\n"
+ .'Sample success response'."\n"
+ ."\n"
+ .'```'."\n"
+ .'{'."\n"
+ .' "requestId": "0A6EB64B-B4C8-CF02-810F-E660812972FF",'."\n"
+ .' "result": []'."\n"
+ .'}'."\n"
+ .'```'."\n"
+ ."\n"
+ .'For more information, see [Response structure](~~464322~~).',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'BuildIndex'],
+ ],
],
- 'schemes' => [
- 'http',
- 'https',
+ 'ramActions' => [
+ [
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'searchengine:BuildIndex',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SearchEngine', 'resourceType' => 'Instance', 'arn' => 'acs:searchengine:{#regionId}:{#accountId}:instance/{#InstanceId}'],
+ ],
+ ],
+ ],
],
+ ],
+ 'ChangeResourceGroup' => [
+ 'summary' => 'Changes the resource group of an instance.',
+ 'path' => '/openapi/ha3/instances/{instanceId}/actions/change-resource-group',
+ 'methods' => ['post'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
- 'produces' => [
- 'application/json',
- ],
- 'operationType' => 'readAndWrite',
+ 'consumes' => [],
+ 'produces' => [],
+ 'operationType' => 'read',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'update',
- 'abilityTreeCode' => '166280',
- 'abilityTreeNodes' => [
- 'FEATUREopensearchJB31XH',
- ],
- ],
+ 'systemTags' => ['operationType' => 'update'],
'parameters' => [
[
+ 'name' => 'instanceId',
+ 'in' => 'path',
+ 'schema' => ['description' => 'The instance ID.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => 'ha-cn-pl32rf0****'],
+ ],
+ [
'name' => 'body',
'in' => 'body',
'style' => 'json',
'schema' => [
- 'description' => '',
+ 'description' => 'The request body.',
'type' => 'object',
'properties' => [
- 'resourceType' => [
- 'title' => '资源类型',
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'instance',
- ],
- 'resourceId' => [
- 'title' => '资源ID,最多 50个子项',
- 'description' => '',
- 'type' => 'array',
- 'items' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'es-cn-i7m2u6o2*******',
- ],
- 'required' => true,
- ],
- 'tag' => [
- 'title' => '对应新增标签列表，最多包含20个子项',
- 'description' => '',
- 'type' => 'array',
- 'items' => [
- 'description' => '',
- 'type' => 'object',
- 'properties' => [
- 'key' => [
- 'title' => '标签键',
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'opensearch',
- ],
- 'value' => [
- 'title' => '标签值',
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'opensearch',
- ],
- ],
- 'required' => false,
- ],
- 'required' => true,
- ],
+ 'newResourceGroupId' => ['title' => '', 'description' => 'The ID of the new resource group.', 'type' => 'string', 'required' => false, 'example' => 'rg-acfmxr3gs*****'],
+ 'resourceType' => ['title' => '', 'description' => 'The resource type.', 'type' => 'string', 'required' => false, 'example' => 'instance'],
],
'required' => false,
+ 'title' => '',
+ 'example' => '',
],
],
],
'responses' => [
200 => [
'schema' => [
+ 'title' => '',
+ 'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
- 'requestId' => [
- 'title' => '请求id',
- 'description' => '',
- 'type' => 'string',
- 'example' => 'E7B7D598-B080-5C8E-AA35-D43EC0D5F886',
- ],
+ 'requestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '10D5E615-69F7-5F49-B850-00169ADE513C'],
],
+ 'example' => '',
],
],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"E7B7D598-B080-5C8E-AA35-D43EC0D5F886\\"\\n}","type":"json"}]',
- ],
- 'UntagResources' => [
- 'summary' => '删标签接口。',
- 'path' => '/openapi/ha3/resource-tags',
- 'methods' => [
- 'delete',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
- 'security' => [
- [
- 'AK' => [],
- ],
- ],
- 'produces' => [
- 'application/json',
- ],
- 'operationType' => 'readAndWrite',
- 'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'delete',
- 'abilityTreeCode' => '166296',
- 'abilityTreeNodes' => [
- 'FEATUREopensearchJB31XH',
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"10D5E615-69F7-5F49-B850-00169ADE513C\\"\\n}","type":"json"}]',
+ 'title' => 'ChangeResourceGroup',
+ 'description' => '### Method'."\n"
+ ."\n"
+ .'```java'."\n"
+ .'POST'."\n"
+ .'```'."\n"
+ ."\n"
+ .'### URI'."\n"
+ ."\n"
+ .'```java'."\n"
+ .'/openapi/ha3/instances/{instanceId}/actions/change-resource-group'."\n"
+ .'```',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ChangeResourceGroup'],
],
],
- 'parameters' => [
- [
- 'name' => 'resourceType',
- 'in' => 'query',
- 'schema' => [
- 'title' => '资源类型',
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'instance',
- ],
- ],
+ 'ramActions' => [
[
- 'name' => 'resourceId',
- 'in' => 'query',
- 'style' => 'json',
- 'schema' => [
- 'title' => '资源ID,最多 50个子项',
- 'description' => '',
- 'type' => 'array',
- 'items' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'es-cn-i7m2u6o2*******',
- ],
- 'required' => true,
- ],
- ],
- [
- 'name' => 'tagKey',
- 'in' => 'query',
- 'style' => 'json',
- 'schema' => [
- 'title' => '对应标签键列表，最多包含20个子项',
- 'description' => '',
- 'type' => 'array',
- 'items' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'opensearch',
- ],
- 'required' => false,
- ],
- ],
- [
- 'name' => 'all',
- 'in' => 'query',
- 'schema' => [
- 'title' => '是否全部删除，只针对tags为空时有效。取值范围： true false True False 默认是 false',
- 'description' => '',
- 'type' => 'boolean',
- 'required' => false,
- 'example' => 'true',
- ],
- ],
- ],
- 'responses' => [
- 200 => [
- 'schema' => [
- 'type' => 'object',
- 'properties' => [
- 'tequestId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'E7B7D598-B080-5C8E-AA35-D43EC0D5F886'."\n",
- ],
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'searchengine:ChangeResourceGroup',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SearchEngine', 'resourceType' => 'Instance', 'arn' => 'acs:searchengine:{#regionId}:{#accountId}:instance/{#InstanceId}'],
],
],
],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"tequestId\\": \\"E7B7D598-B080-5C8E-AA35-D43EC0D5F886\\\\n\\"\\n}","type":"json"}]',
],
- 'ListTagResources' => [
- 'summary' => '查标签接口',
- 'path' => '/openapi/ha3/resource-tags',
- 'methods' => [
- 'get',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
+ 'CloneSqlInstance' => [
+ 'path' => '/openapi/ha3/instances/{instanceId}/sql-studio/databases/{database}/sql-instances/{sqlInstanceId}/actions/clone',
+ 'methods' => ['post'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
- 'produces' => [
- 'application/json',
- ],
- 'operationType' => 'read',
+ 'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
- 'operationType' => 'list',
- 'abilityTreeCode' => '166297',
- 'abilityTreeNodes' => [
- 'FEATUREopensearch0AT3OG',
- 'FEATUREopensearchJB31XH',
- ],
+ 'operationType' => 'create',
+ 'abilityTreeCode' => '139625',
+ 'abilityTreeNodes' => ['FEATUREopensearch95VJR4'],
],
'parameters' => [
[
- 'name' => 'resourceType',
- 'in' => 'query',
- 'schema' => [
- 'title' => '资源类型',
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'instance',
- ],
+ 'name' => 'instanceId',
+ 'in' => 'path',
+ 'schema' => ['description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'example' => 'ha-cn-pl32rf0****', 'title' => ''],
],
[
- 'name' => 'resourceId',
- 'in' => 'query',
- 'style' => 'json',
- 'schema' => [
- 'title' => '资源ID,最多 50个子项',
- 'description' => '',
- 'type' => 'array',
- 'items' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'es-cn-i7m2u6o2*******'."\n",
- ],
- 'required' => false,
- ],
+ 'name' => 'database',
+ 'in' => 'path',
+ 'schema' => ['description' => 'The database name.', 'type' => 'string', 'required' => true, 'example' => 'general', 'title' => ''],
],
[
- 'name' => 'tag',
- 'in' => 'query',
- 'style' => 'json',
- 'schema' => [
- 'title' => '对应新增标签列表，最多包含20个子项',
- 'description' => '',
- 'type' => 'array',
- 'items' => [
- 'description' => '',
- 'type' => 'object',
- 'properties' => [
- 'key' => [
- 'title' => '标签键',
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'opensearch',
- ],
- 'value' => [
- 'title' => '标签值',
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'opensearch',
- ],
- ],
- 'required' => false,
- ],
- 'required' => false,
- ],
+ 'name' => 'sqlInstanceId',
+ 'in' => 'path',
+ 'schema' => ['description' => 'The SQL instance ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1', 'title' => ''],
],
[
- 'name' => 'nextToken',
- 'in' => 'query',
- 'schema' => [
- 'title' => '下一个查询开始Token',
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => '600********33',
- ],
- ],
- ],
- 'responses' => [
- 200 => [
+ 'name' => 'body',
+ 'in' => 'body',
+ 'style' => 'json',
'schema' => [
+ 'description' => 'The request body.',
'type' => 'object',
'properties' => [
- 'requestId' => [
- 'title' => '请求id',
- 'description' => '',
- 'type' => 'string',
- 'example' => '2AE63638-5420-56DC-BF59-37D8174039A0',
- ],
- 'nextToken' => [
- 'title' => '下一个查询开始Token',
- 'description' => '',
- 'type' => 'string',
- 'example' => 'b56*******de4a7eca',
- ],
- 'tagResources' => [
- 'title' => '资源列表',
- 'description' => '',
- 'type' => 'array',
- 'items' => [
- 'description' => '',
- 'type' => 'object',
- 'properties' => [
- 'tagKey' => [
- 'title' => '标签键',
- 'description' => '',
- 'type' => 'string',
- 'example' => 'opensearch',
- ],
- 'tagValue' => [
- 'title' => '标签值',
- 'description' => '',
- 'type' => 'string',
- 'example' => 'opensearch',
- ],
- 'resourceId' => [
- 'title' => '资源ID',
- 'description' => '',
- 'type' => 'string',
- 'example' => 'rmq-cn-jeo3mn55j01',
- ],
- 'resourceType' => [
- 'title' => '资源类型',
- 'description' => '',
- 'type' => 'string',
- 'example' => 'instance',
- ],
- ],
- ],
- ],
+ 'targetFolderId' => ['description' => 'The ID of the target folder.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1', 'title' => ''],
+ 'name' => ['description' => 'The name.', 'type' => 'string', 'required' => true, 'example' => 'test', 'title' => ''],
],
- ],
- ],
- ],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"2AE63638-5420-56DC-BF59-37D8174039A0\\",\\n \\"nextToken\\": \\"b56*******de4a7eca\\",\\n \\"tagResources\\": [\\n {\\n \\"tagKey\\": \\"opensearch\\",\\n \\"tagValue\\": \\"opensearch\\",\\n \\"resourceId\\": \\"rmq-cn-jeo3mn55j01\\",\\n \\"resourceType\\": \\"instance\\"\\n }\\n ]\\n}","type":"json"}]',
- ],
- 'CreatePublicUrl' => [
- 'summary' => 'Creates a public endpoint.',
- 'path' => '/openapi/ha3/instances/{instanceId}/public-url',
- 'methods' => [
- 'post',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
- 'security' => [
- [
- 'AK' => [],
- ],
- ],
- 'operationType' => 'write',
- 'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'create',
- 'abilityTreeCode' => '171289',
- 'abilityTreeNodes' => [
- 'FEATUREopensearch0AT3OG',
- 'FEATUREopensearchJB31XH',
- ],
- ],
- 'parameters' => [
- [
- 'name' => 'instanceId',
- 'in' => 'path',
- 'schema' => [
- 'description' => 'The instance ID.'."\n",
- 'type' => 'string',
- 'required' => true,
- 'example' => 'ha-cn-pl32rf0js04',
+ 'required' => false,
+ 'title' => '',
+ 'example' => '',
],
],
],
@@ -716,100 +371,70 @@
'schema' => [
'type' => 'object',
'properties' => [
- 'requestId' => [
- 'title' => 'id of request',
- 'description' => 'The request ID.'."\n",
- 'type' => 'string',
- 'example' => '022F36C7-9FB4-5D67-BEBC-3D14B0984463',
- ],
+ 'requestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '10D5E615-69F7-5F49-B850-00169ADE513C'],
'result' => [
- 'title' => 'Map',
- 'description' => 'The result.'."\n",
+ 'title' => '',
+ 'description' => 'The returned result.',
'type' => 'object',
- 'example' => '{}',
+ 'properties' => [
+ 'id' => ['description' => 'The primary key ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => ''],
+ 'gmtCreate' => ['description' => 'The creation time.', 'type' => 'string', 'example' => '1719221186114', 'title' => ''],
+ 'gmtModified' => ['description' => 'The modification time.', 'type' => 'string', 'example' => '1719221186114', 'title' => ''],
+ 'name' => ['description' => 'The name of the SQL instance.', 'type' => 'string', 'example' => 'general', 'title' => ''],
+ 'parent' => ['description' => 'The parent task ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => ''],
+ 'isDir' => ['description' => 'Indicates whether this is a directory. Valid values: - true: yes. - false: no.', 'type' => 'integer', 'format' => 'int32', 'example' => 'True', 'title' => ''],
+ 'type' => ['title' => '', 'description' => 'table, instance, template, function', 'type' => 'string', 'example' => 'instance'],
+ 'instanceId' => ['description' => 'The instance ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '-cn-pl32rf0****', 'title' => ''],
+ 'templateId' => ['description' => 'The template ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => ''],
+ ],
+ 'example' => '',
],
],
'description' => '',
+ 'title' => '',
+ 'example' => '',
],
],
500 => [],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"022F36C7-9FB4-5D67-BEBC-3D14B0984463\\",\\n \\"result\\": {}\\n}","type":"json"}]',
- 'title' => 'CreatePublicUrl',
- ],
- 'DeletePublicUrl' => [
- 'summary' => 'Deletes a public endpoint.',
- 'path' => '/openapi/ha3/instances/{instanceId}/public-url',
- 'methods' => [
- 'delete',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
- 'security' => [
- [
- 'AK' => [],
- ],
- ],
- 'operationType' => 'write',
- 'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'delete',
- 'abilityTreeCode' => '171290',
- 'abilityTreeNodes' => [
- 'FEATUREopensearch0AT3OG',
- 'FEATUREopensearchJB31XH',
+ 'title' => 'Clone SQL Instance',
+ 'summary' => 'Clones an SQL instance.',
+ 'description' => '### Method'."\n"
+ ."\n"
+ .'```java'."\n"
+ .'POST'."\n"
+ .'```'."\n"
+ ."\n"
+ .'### URI'."\n"
+ ."\n"
+ .'```java'."\n"
+ .'/openapi/ha3/instances/{instanceId}/sql-studio/databases/{database}/sql-instances/{sqlInstanceId}/actions/clone'."\n"
+ .'```',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CloneSqlInstance'],
],
],
- 'parameters' => [
+ 'ramActions' => [
[
- 'name' => 'instanceId',
- 'in' => 'path',
- 'schema' => [
- 'description' => 'The instance ID.'."\n",
- 'type' => 'string',
- 'required' => true,
- 'example' => 'ha-cn-tl32m2c4u01',
- ],
- ],
- ],
- 'responses' => [
- 200 => [
- 'schema' => [
- 'type' => 'object',
- 'properties' => [
- 'requestId' => [
- 'title' => 'id of request',
- 'description' => 'The request ID.'."\n",
- 'type' => 'string',
- 'example' => 'F43E8AB4-419C-5F4C-90D6-615590DFAA3C',
- ],
- 'result' => [
- 'title' => 'Map',
- 'description' => 'The result.'."\n",
- 'type' => 'object',
- 'example' => '{}',
- ],
+ 'operationType' => 'create',
+ 'ramAction' => [
+ 'action' => 'searchengine:CloneSqlInstance',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SearchEngine', 'resourceType' => 'Instance', 'arn' => 'acs:searchengine:{#regionId}:{#accountId}:instance/{#instanceId}'],
],
- 'description' => '',
],
],
- 500 => [],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"F43E8AB4-419C-5F4C-90D6-615590DFAA3C\\",\\n \\"result\\": {}\\n}","type":"json"}]',
- 'title' => 'DeletePublicUrl',
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"10D5E615-69F7-5F49-B850-00169ADE513C\\",\\n \\"result\\": {\\n \\"id\\": 1,\\n \\"gmtCreate\\": \\"1719221186114\\",\\n \\"gmtModified\\": \\"1719221186114\\",\\n \\"name\\": \\"general\\",\\n \\"parent\\": 1,\\n \\"isDir\\": 0,\\n \\"type\\": \\"instance\\",\\n \\"instanceId\\": 0,\\n \\"templateId\\": 1\\n }\\n}","type":"json"}]',
],
- 'ModifyPublicUrlIpList' => [
- 'summary' => '修改公网域名访问白名单',
- 'path' => '/openapi/ha3/instances/{instanceId}/public-url-ip-list',
- 'methods' => [
- 'put',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
+ 'CreateAlias' => [
+ 'path' => '/openapi/ha3/instances/{instanceId}/aliases',
+ 'methods' => ['post'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
@@ -818,37 +443,35 @@
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
- 'operationType' => 'update',
- 'abilityTreeCode' => '171291',
- 'abilityTreeNodes' => [
- 'FEATUREopensearch0AT3OG',
- 'FEATUREopensearchJB31XH',
- ],
+ 'operationType' => 'create',
+ 'abilityTreeCode' => '223193',
+ 'abilityTreeNodes' => ['FEATUREopensearchGTRUN8'],
],
'parameters' => [
[
'name' => 'instanceId',
'in' => 'path',
- 'schema' => [
- 'description' => 'The instance ID.'."\n",
- 'type' => 'string',
- 'required' => true,
- 'example' => 'ha-cn-0ju2rq6610a',
- ],
+ 'schema' => ['description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'example' => 'ha-cn-pl32rf0****', 'title' => ''],
+ ],
+ [
+ 'name' => 'newMode',
+ 'in' => 'query',
+ 'schema' => ['description' => 'Specifies whether the new version of the console page is used.', 'type' => 'boolean', 'required' => false, 'default' => 'true', 'example' => 'true', 'title' => ''],
],
[
'name' => 'body',
'in' => 'body',
'style' => 'json',
'schema' => [
- 'description' => 'The request body.'."\n",
+ 'description' => 'The request body parameters.',
'type' => 'object',
- 'required' => false,
- 'additionalProperties' => [
- 'type' => 'string',
- 'example' => '12.0.0.1,0.0.0.0/0',
- 'description' => 'The IP addresses in the whitelist. Separate multiple IP addresses with commas (,).'."\n",
+ 'properties' => [
+ 'alias' => ['title' => '', 'description' => 'The alias.', 'type' => 'string', 'required' => false, 'example' => 'test'],
+ 'index' => ['title' => '', 'description' => 'The associated index.', 'type' => 'string', 'required' => false, 'example' => 'index'],
],
+ 'required' => false,
+ 'title' => '',
+ 'example' => '',
],
],
],
@@ -857,212 +480,183 @@
'schema' => [
'type' => 'object',
'properties' => [
- 'requestId' => [
- 'title' => 'id of request',
- 'description' => 'The request ID.'."\n",
- 'type' => 'string',
- 'example' => 'E45380E8-994A-5402-9806-F114B3295FCF',
- ],
- 'result' => [
- 'title' => 'Map',
- 'description' => 'The result.'."\n",
- 'type' => 'object',
- 'example' => '{}',
- ],
+ 'requestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '10D5E615-69F7-5F49-B850-00169ADE513C'],
+ 'result' => ['title' => '', 'description' => 'The returned result.', 'type' => 'object', 'example' => '{}'],
],
'description' => '',
+ 'title' => '',
+ 'example' => '',
],
],
500 => [],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"E45380E8-994A-5402-9806-F114B3295FCF\\",\\n \\"result\\": {}\\n}","type":"json"}]',
- 'title' => 'ModifyPublicUrlIpList',
- ],
- 'CreateInstance' => [
- 'summary' => 'Creates a Havenask instance.',
- 'path' => '/openapi/ha3/instances',
- 'methods' => [
- 'post',
- ],
- 'schemes' => [
- 'http',
- 'https',
+ 'title' => 'Create an alias',
+ 'summary' => 'Creates an alias.',
+ 'description' => '### Method'."\n"
+ ."\n"
+ .'```java'."\n"
+ .'POST'."\n"
+ .'```'."\n"
+ ."\n"
+ .'### URI'."\n"
+ ."\n"
+ .'```java'."\n"
+ .'/openapi/ha3/instances/{instanceId}/aliases'."\n"
+ .'```.',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'create',
+ 'ramAction' => [
+ 'action' => 'searchengine:CreateAlias',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SearchEngine', 'resourceType' => 'Instance', 'arn' => 'acs:searchengine:{#regionId}:{#accountId}:instance/{#InstanceId}'],
+ ],
+ ],
+ ],
],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"10D5E615-69F7-5F49-B850-00169ADE513C\\",\\n \\"result\\": {}\\n}","type":"json"}]',
+ ],
+ 'CreateCluster' => [
+ 'summary' => 'Add a cluster.',
+ 'path' => '/openapi/ha3/instances/{instanceId}/clusters',
+ 'methods' => ['post'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
- 'operationType' => 'write',
+ 'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'create',
- 'riskType' => 'none',
- 'chargeType' => 'paid',
- 'abilityTreeCode' => '136888',
- 'abilityTreeNodes' => [
- 'FEATUREopensearchXLGC1X',
- 'FEATUREopensearchCH6TQD',
- ],
- 'tenantRelevance' => 'publicInformation',
+ 'abilityTreeCode' => '104657',
+ 'abilityTreeNodes' => ['FEATUREopensearchA6GC80'],
],
'parameters' => [
[
+ 'name' => 'instanceId',
+ 'in' => 'path',
+ 'schema' => ['description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'example' => 'ha-cn-pl32rf0****', 'title' => ''],
+ ],
+ [
'name' => 'body',
'in' => 'body',
'style' => 'json',
'schema' => [
- 'description' => 'The request body.'."\n",
+ 'description' => 'The request body parameters.',
'type' => 'object',
'properties' => [
- 'chargeType' => [
- 'description' => 'The billing method of the instance. Valid values: PREPAY: subscription. If you set this parameter to PREPAY, make sure that your Alibaba Cloud account supports balance payment or credit card payment. Otherwise, the system returns the InvalidPayMethod error message. If you set this parameter to PREPAY, you must also specify paymentInfo. POSTPAY: pay-as-you-go. This billing method is not supported.'."\n",
- 'type' => 'string',
- 'required' => false,
- 'example' => '""',
- ],
- 'components' => [
- 'description' => 'The information about the instance specification.'."\n",
- 'type' => 'array',
- 'items' => [
- 'description' => '',
- 'type' => 'object',
- 'properties' => [
- 'code' => [
- 'description' => 'The code of the specification, which must be consistent with the value that you specify on the buy page.'."\n",
- 'type' => 'string',
- 'required' => false,
- 'example' => '""',
- ],
- 'value' => [
- 'description' => 'The value of the specification.'."\n",
- 'type' => 'string',
- 'required' => false,
- 'example' => '""',
- ],
- ],
- 'required' => false,
+ 'name' => ['title' => '', 'description' => 'The cluster name.', 'type' => 'string', 'required' => false, 'example' => 'hz_pre_vpc_domain_1'],
+ 'description' => ['title' => '', 'description' => 'The cluster description.', 'type' => 'string', 'required' => false, 'example' => 'Custom description'],
+ 'queryNode' => [
+ 'title' => '',
+ 'description' => 'The details of the query node.',
+ 'type' => 'object',
+ 'properties' => [
+ 'number' => ['title' => '', 'description' => 'The number of query nodes.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '2'],
],
'required' => false,
+ 'example' => '',
],
- 'order' => [
- 'description' => 'The billing information.'."\n",
+ 'dataNode' => [
+ 'title' => '',
+ 'description' => 'The details of the data node.',
'type' => 'object',
'properties' => [
- 'autoRenew' => [
- 'description' => 'Specifies whether to enable auto-renewal. Valid values: true and false.'."\n",
- 'type' => 'boolean',
- 'required' => false,
- 'example' => 'true',
- ],
- 'duration' => [
- 'description' => 'The billing duration. Valid values: 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, and 12.'."\n",
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => false,
- 'example' => '29',
- ],
- 'pricingCycle' => [
- 'description' => 'The unit of the billing duration. Valid values: Month and Year.'."\n",
- 'type' => 'string',
- 'required' => false,
- 'example' => '""',
- ],
+ 'number' => ['title' => '', 'description' => 'The number of data nodes.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '2'],
+ 'partition' => ['description' => 'The number of partitions.', 'type' => 'string', 'required' => false, 'example' => '2', 'title' => ''],
],
'required' => false,
+ 'example' => '',
],
- 'tags' => [
- 'type' => 'array',
- 'items' => [
- 'type' => 'object',
- 'properties' => [
- 'key' => [
- 'type' => 'string',
- ],
- 'value' => [
- 'type' => 'string',
- ],
- ],
- ],
- ],
- 'resourceGroupId' => [
- 'type' => 'string',
- ],
+ 'autoLoad' => ['title' => '', 'description' => 'Specifies whether to automatically mount the cluster.', 'type' => 'boolean', 'required' => false, 'example' => 'true'],
],
'required' => false,
'example' => '{}',
+ 'title' => '',
],
],
],
'responses' => [
200 => [
'schema' => [
- 'title' => 'Schema of Response',
- 'description' => 'The response parameters.'."\n",
'type' => 'object',
'properties' => [
- 'requestId' => [
- 'title' => 'Id of the request',
- 'description' => 'The ID of the request'."\n",
- 'type' => 'string',
- 'example' => 'D39EE0F1-D7EF-5F46-B781-6BF4185308B0',
- ],
- 'result' => [
- 'description' => 'The results returned.'."\n",
- 'type' => 'object',
- 'properties' => [
- 'instanceId' => [
- 'description' => 'The instance ID.'."\n",
- 'type' => 'string',
- 'example' => 'ha-cn-2r42ppr7901',
- ],
- ],
- ],
+ 'requestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '10D5E615-69F7-5F49-B850-00169ADE513C'],
+ 'result' => ['title' => '', 'description' => 'The returned result.', 'type' => 'object', 'example' => '{}'],
],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
],
- '5XX' => [],
+ 500 => [],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"D39EE0F1-D7EF-5F46-B781-6BF4185308B0\\",\\n \\"result\\": {\\n \\"instanceId\\": \\"ha-cn-pl32rf0****\\"\\n }\\n}","type":"json"}]',
- 'title' => 'CreateInstance',
- 'description' => '### [](#)Method'."\n"
+ 'title' => 'Add a cluster',
+ 'description' => '### Method'."\n"
."\n"
- .'`POST`'."\n"
+ .'```java'."\n"
+ .'POST'."\n"
+ .'```'."\n"
."\n"
- .'### [](#uri)URI'."\n"
+ .'### URI'."\n"
."\n"
- .'`/api/instances?dryRun=false`'."\n",
- 'responseParamsDescription' => '### [](#)Sample responses'."\n"
+ .'```java'."\n"
+ .'/openapi/ha3/instances/{instanceId}/clusters'."\n"
+ .'```',
+ 'requestParamsDescription' => '### Sample requests'."\n"
."\n"
- .'**Sample success responses**'."\n"
+ .'`POST/openapi/ha3/instances/ha3_instance_id/clusters`'."\n"
."\n"
.' {'."\n"
- .' "requestId": "90D6B8F5-FE97-4509-9AAB-367836C51818",'."\n"
- .' "result": {'."\n"
- .' "instanceId": "deeprec-cn-xxxxxx1"'."\n"
- .' }'."\n"
- .' }'."\n"
- ."\n"
- .'**Sample error responses**'."\n"
+ .' "name":"cluster1",'."\n"
+ .' "queryNode": {'."\n"
+ .' "number": 1'."\n"
+ .' },'."\n"
+ .' "dataNode": {'."\n"
+ .' "number": 2'."\n"
+ .' },'."\n"
+ .' "description":"The description of the cluster",'."\n"
+ .' "autoLoad":true'."\n"
+ .' }',
+ 'responseParamsDescription' => '### Sample responses'."\n"
."\n"
.' {'."\n"
- .' "requestId": "90D6B8F5-FE97-4509-9AAB-367836C51818",'."\n"
- .' "code": "InternalServerError",'."\n"
- .' "message":"internal server error"'."\n"
+ .' "requestId": "0A6EB64B-B4C8-CF02-810F-E660812972FF",'."\n"
+ .' "result": []'."\n"
.' }'."\n"
."\n"
- .'For more information, see [Response structure](~~465311~~).'."\n",
- ],
- 'DeleteInstance' => [
- 'summary' => 'Deletes a specified instance.',
- 'path' => '/openapi/ha3/instances/{instanceId}',
- 'methods' => [
- 'delete',
+ .'For more information, see <props="china">[Response structure](https://help.aliyun.com/zh/open-search/retrieval-engine-edition/data-structure-1/)</props><props="intl">[Response structure](https://www.alibabacloud.com/help/zh/open-search/response-struct)</props>',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
],
- 'schemes' => [
- 'http',
- 'https',
+ 'ramActions' => [
+ [
+ 'operationType' => 'create',
+ 'ramAction' => [
+ 'action' => 'searchengine:CreateCluster',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SearchEngine', 'resourceType' => 'Instance', 'arn' => 'acs:searchengine:{#regionId}:{#accountId}:instance/{#InstanceId}'],
+ ],
+ ],
+ ],
],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"10D5E615-69F7-5F49-B850-00169ADE513C\\",\\n \\"result\\": {}\\n}","type":"json"}]',
+ ],
+ 'CreateConfigDir' => [
+ 'path' => '/openapi/ha3/instances/{instanceId}/advanced-configs/{configName}/dir',
+ 'methods' => ['post'],
+ 'schemes' => ['https', 'http'],
'security' => [
[
'AK' => [],
@@ -1070,107 +664,86 @@
],
'operationType' => 'write',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'delete',
- ],
+ 'systemTags' => [],
'parameters' => [
[
'name' => 'instanceId',
'in' => 'path',
- 'schema' => [
- 'title' => '实例 ID。',
- 'description' => 'The instance ID.'."\n",
- 'type' => 'string',
- 'required' => true,
- 'example' => 'ha-cn-7pp2m0ozr01',
- ],
+ 'schema' => ['description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'example' => 'ha-cn-pl32rf0****', 'title' => ''],
],
- ],
- 'responses' => [
- 200 => [
+ [
+ 'name' => 'configName',
+ 'in' => 'path',
+ 'schema' => ['description' => 'The configuration name.', 'type' => 'string', 'required' => true, 'example' => 'ha-cn-pl32rf0****@ha-cn-pl32rf0****_test_api@test_api@index_config_edit', 'title' => ''],
+ ],
+ [
+ 'name' => 'body',
+ 'in' => 'body',
+ 'style' => 'json',
'schema' => [
- 'title' => 'Schema of Response',
- 'description' => 'Schema of Response'."\n",
+ 'description' => 'The request body parameters.',
'type' => 'object',
'properties' => [
- 'requestId' => [
- 'title' => 'Id of the request',
- 'description' => 'The ID of the request'."\n",
- 'type' => 'string',
- 'example' => 'E45380E8-994A-5402-9806-F114B3295FCF',
- ],
- 'result' => [
- 'description' => 'The result returned'."\n",
- 'type' => 'object',
- 'example' => '{}',
- ],
+ 'dirName' => ['title' => '', 'description' => 'The directory name.', 'type' => 'string', 'required' => false, 'example' => '/clusters'],
+ 'parentFullPath' => ['title' => '', 'description' => 'The parent file path.', 'type' => 'string', 'required' => false, 'example' => '/'],
],
+ 'required' => false,
+ 'title' => '',
+ 'example' => '',
],
],
- 500 => [
+ ],
+ 'responses' => [
+ 200 => [
'schema' => [
'type' => 'object',
'properties' => [
- 'requestId' => [
- 'type' => 'string',
- ],
- 'message' => [
- 'type' => 'string',
- ],
- 'code' => [
- 'type' => 'string',
- ],
+ 'requestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => 'E7B7D598-B080-5C8E-AA35-D43EC0D5F886'],
+ 'result' => ['title' => '', 'description' => 'The returned result.', 'type' => 'object', 'example' => '{}'],
],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
],
+ 500 => [],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"E45380E8-994A-5402-9806-F114B3295FCF\\",\\n \\"result\\": {}\\n}","type":"json"}]',
- 'title' => 'DeleteInstance',
+ 'title' => 'Create a file directory in an advanced configuration',
+ 'summary' => 'Creates a file directory in an advanced configuration.',
'description' => '### Method'."\n"
."\n"
- .'`DELETE`'."\n"
- ."\n"
- .'### URI'."\n"
- ."\n"
- .'`/openapi/ha3/instances/{instanceId}`'."\n",
- 'requestParamsDescription' => '### Sample requests'."\n"
- ."\n"
- .'**Change the instance name**'."\n"
- ."\n"
- .'`DELETE /openapi/ha3/instances/ha3-cn-xxxxxx`'."\n",
- 'responseParamsDescription' => '### [](#)Sample responses'."\n"
- ."\n"
- .'**Sample success responses**'."\n"
- ."\n"
- .' {'."\n"
- .' "result": { },'."\n"
- .' "requestId": "90D6B8F5-FE97-4509-9AAB-367836C51818"'."\n"
- .' }'."\n"
- ."\n"
- .'**Sample error responses**'."\n"
- ."\n"
+ .'```java'."\n"
+ .'POST'."\n"
.'```'."\n"
."\n"
- .'{'."\n"
- .' "requestId": "BD1EA715-DF6F-06C2-004C-C1FA0D3A9820",'."\n"
- .' "httpCode": 404,'."\n"
- .' "code": "App.NotFound",'."\n"
- .' "message": "App not found"'."\n"
- .'}'."\n"
- .'```'."\n"
+ .'### URI'."\n"
."\n"
- .'For more information, see [Response structure](~~465311~~).'."\n",
- ],
- 'UpdateInstance' => [
- 'summary' => 'Modifies the configuration of a specified instance.',
- 'path' => '/openapi/ha3/instances/{instanceId}',
- 'methods' => [
- 'put',
- ],
- 'schemes' => [
- 'http',
- 'https',
+ .'```java'."\n"
+ .'/openapi/ha3/instances/{instanceId}/advanced-configs/{configName}/dir'."\n"
+ .'```.',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => '',
+ 'ramAction' => [
+ 'action' => 'searchengine:CreateConfigDir',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SearchEngine', 'resourceType' => 'Instance', 'arn' => 'acs:searchengine:{#regionId}:{#accountId}:instance/{#InstanceId}'],
+ ],
+ ],
+ ],
],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"E7B7D598-B080-5C8E-AA35-D43EC0D5F886\\",\\n \\"result\\": {}\\n}","type":"json"}]',
+ ],
+ 'CreateConfigFile' => [
+ 'path' => '/openapi/ha3/instances/{instanceId}/advanced-configs/{configName}/file',
+ 'methods' => ['post'],
+ 'schemes' => ['https', 'http'],
'security' => [
[
'AK' => [],
@@ -1178,1471 +751,613 @@
],
'operationType' => 'write',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'update',
- ],
+ 'systemTags' => [],
'parameters' => [
[
'name' => 'instanceId',
'in' => 'path',
- 'schema' => [
- 'description' => 'The instance ID.'."\n",
- 'type' => 'string',
- 'required' => false,
- 'example' => 'ha-cn-2r42mu9xi01',
- ],
+ 'schema' => ['description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'example' => 'ha-cn-pl32rf0****', 'title' => ''],
+ ],
+ [
+ 'name' => 'configName',
+ 'in' => 'path',
+ 'schema' => ['description' => 'The configuration name.', 'type' => 'string', 'required' => true, 'example' => 'ha-cn-pl32rf0****@ha-cn-pl32rf0****_test_api@test_api@index_config_edit', 'title' => ''],
],
[
'name' => 'body',
'in' => 'body',
'style' => 'json',
'schema' => [
- 'description' => 'The request body.'."\n",
+ 'description' => 'The request body parameters.',
'type' => 'object',
'properties' => [
- 'components' => [
- 'title' => '配额信息，与description不能同时更新。',
- 'description' => 'The information about the instance specification.'."\n",
- 'type' => 'array',
- 'items' => [
- 'description' => 'The request body.'."\n",
- 'type' => 'object',
- 'properties' => [
- 'code' => [
- 'description' => 'The code of the specification, which must be consistent with the value that you specify on the buy page.'."\n",
- 'type' => 'string',
- 'required' => false,
- 'example' => '200',
- ],
- 'value' => [
- 'description' => 'The value of the specification.'."\n",
- 'type' => 'string',
- 'required' => false,
- 'example' => '""',
- ],
- ],
- 'required' => false,
- ],
- 'required' => false,
- ],
- 'orderType' => [
- 'title' => '订单类型，与description不能同时传递。',
- 'description' => 'The type of the order. Valid values: UPGRADE and DOWNGRADE. UPGRADE upgrades the instance specifications. DOWNGRADE: downgrades the instance specifications.'."\n",
- 'type' => 'string',
- 'required' => false,
- 'example' => '""',
- ],
- 'description' => [
- 'title' => '更新实例描述信息，与components及orderType字段不能同时更新。',
- 'description' => 'The description of the instance.'."\n",
- 'type' => 'string',
- 'required' => false,
- 'example' => '""',
- ],
+ 'fileName' => ['title' => '', 'description' => 'The directory name.', 'type' => 'string', 'required' => false, 'example' => '/schemas/device_event_xt_schema.json'],
+ 'parentFullPath' => ['title' => '', 'description' => 'The parent file path.', 'type' => 'string', 'required' => false, 'example' => '/'],
+ 'ossPath' => ['title' => '', 'description' => 'The OSS storage address.', 'type' => 'string', 'required' => false, 'example' => 'oss://xxx/xxxx/xxx'],
],
'required' => false,
- 'example' => '{}',
+ 'title' => '',
+ 'example' => '',
],
],
],
'responses' => [
200 => [
- 'headers' => [],
'schema' => [
- 'title' => 'Schema of Response',
- 'description' => 'The response parameters.'."\n",
'type' => 'object',
'properties' => [
- 'result' => [
- 'description' => 'The results returned.'."\n",
- 'type' => 'object',
- 'properties' => [
- 'description' => [
- 'title' => '实例描述',
- 'description' => 'The description of the instance'."\n",
- 'type' => 'string',
- 'example' => 'Test instance'."\n",
- ],
- 'resourceGroupId' => [
- 'title' => '资源组ID',
- 'description' => 'The ID of the resource group.'."\n",
- 'type' => 'string',
- 'example' => 'rg-aeky6hthboewpuy',
- ],
- 'expiredTime' => [
- 'title' => '到期时间',
- 'description' => 'The time when the instance expires'."\n",
- 'type' => 'string',
- 'example' => '2019-01-06T16:00:00.0',
- ],
- 'commodityCode' => [
- 'title' => '商品code',
- 'description' => 'The commodity code of the instance.'."\n",
- 'type' => 'string',
- 'example' => 'ha3-code',
- ],
- 'status' => [
- 'title' => '状态',
- 'description' => 'The instance status.'."\n",
- 'type' => 'string',
- 'example' => 'Running',
- ],
- 'instanceId' => [
- 'title' => '资源一级ID',
- 'description' => 'The instance ID.'."\n",
- 'type' => 'string',
- 'example' => 'ha-cn-0ju2s170b03',
- ],
- 'createTime' => [
- 'title' => '创建时间',
- 'description' => 'The time when the instance was created'."\n",
- 'type' => 'string',
- 'example' => '2018-12-06T11:17:49.0',
- ],
- 'lockMode' => [
- 'title' => '锁定状态',
- 'description' => 'The lock status'."\n",
- 'type' => 'string',
- 'example' => 'Unlock',
- ],
- 'chargeType' => [
- 'title' => '付费类型',
- 'description' => 'The billing method.'."\n",
- 'type' => 'string',
- 'example' => 'PrePaid',
- ],
- 'updateTime' => [
- 'title' => '更新时间',
- 'description' => 'The time when the instance was last updated'."\n",
- 'type' => 'string',
- 'example' => '2018-12-06T11:17:49.0',
- ],
- 'inDebt' => [
- 'title' => '是否欠费',
- 'description' => 'Indicates whether an overdue payment is involved'."\n",
- 'type' => 'boolean',
- 'example' => 'false',
- ],
- ],
- ],
- 'requestId' => [
- 'title' => 'Id of the request',
- 'description' => 'The ID of the request'."\n",
- 'type' => 'string',
- 'example' => '90D6B8F5-FE97-4509-9AAB-367836C51818',
- ],
+ 'requestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => 'FE03180A-0E29-5474-8A86-33F0683294A4'],
+ 'result' => ['title' => '', 'description' => 'The returned result.', 'type' => 'object', 'example' => '{}'],
],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
],
500 => [],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"result\\": {\\n \\"description\\": \\"测试实例\\",\\n \\"resourceGroupId\\": \\"ha-cn-pl32rf0****\\",\\n \\"expiredTime\\": \\"2019-01-06T16:00:00.0\\",\\n \\"commodityCode\\": \\"opensearch_ha3post_public_cn\\",\\n \\"status\\": \\"READY\\",\\n \\"instanceId\\": \\"ha-cn-pl32rf0****\\",\\n \\"createTime\\": \\"2018-12-06T11:17:49.0\\",\\n \\"lockMode\\": \\"Unlock\\",\\n \\"chargeType\\": \\"POSTPAY\\",\\n \\"updateTime\\": \\"2018-12-06T11:17:49.0\\",\\n \\"inDebt\\": false\\n },\\n \\"requestId\\": \\"90D6B8F5-FE97-4509-9AAB-367836C51818\\"\\n}","type":"json"}]',
- 'title' => 'UpdateInstance',
+ 'title' => 'Create a file with advanced configurations',
+ 'summary' => 'Creates a file with advanced configurations.',
'description' => '### Method'."\n"
."\n"
- .'`PUT`'."\n"
+ .'```java'."\n"
+ .'POST'."\n"
+ .'```'."\n"
."\n"
.'### URI'."\n"
."\n"
- .'`/openapi/ha3/instances/{instanceId}`'."\n",
- 'extraInfo' => '### Example'."\n"
- ."\n"
- .'**Sample requests**'."\n"
- ."\n"
- .'`PUT /openapi/ha3/instances/ha-cn-xxxxxx`'."\n"
- ."\n"
- .' {'."\n"
- .' "description": "the new description"'."\n"
- .' }'."\n"
- .' or'."\n"
- .' {'."\n"
- .' "resourceGroupId": "the new resourceGroupId"'."\n"
- .' }'."\n"
- ."\n"
- .'**Sample responses**'."\n"
- ."\n"
- .'Success responses'."\n"
- ."\n"
- .' {'."\n"
- .' "result": {'."\n"
- .' "instanceId": "airec-cn-o400whm78004",'."\n"
- .' "description": "airec-cn-o400whm78004",'."\n"
- .' "status": "Running",'."\n"
- .' "chargeType": "PrePaid",'."\n"
- .' "commodityCode": "airecpre",'."\n"
- .' "createTime": "2018-12-06T11:17:49.0",'."\n"
- .' "updateTime": "2018-12-06T11:17:49.0",'."\n"
- .' "expiredTime": "2019-01-06T16:00:00.0",'."\n"
- .' "resourceGroupId": "rg-abcdefg",'."\n"
- .' "lockMode": "Unlock",'."\n"
- .' "inDebt": false,'."\n"
- .' "spec": {'."\n"
- .' "password": "passwd",'."\n"
- .' "searchResource": {'."\n"
- .' "disk": 50,'."\n"
- .' "mem": 8,'."\n"
- .' "cpu": 2,'."\n"
- .' "nodeCount": 2'."\n"
- .' },'."\n"
- .' "instanceName": "testInstance",'."\n"
- .' "vSwitchId": "vswitch_id_xxx",'."\n"
- .' "vpcId": "vpc_id_xxx",'."\n"
- .' "qrsResource": {'."\n"
- .' "disk": 50,'."\n"
- .' "mem": 8,'."\n"
- .' "cpu": 2,'."\n"
- .' "nodeCount": 2'."\n"
- .' },'."\n"
- .' "region": "cn-hangzhou",'."\n"
- .' "userName": "user"'."\n"
- .' },'."\n"
- .' "status": {'."\n"
- .' "phase": "PENDING",'."\n"
- .' "instancePhase": "INIT",'."\n"
- .' "createSuccess": false'."\n"
- .' }'."\n"
- .' },'."\n"
- .' "requestId": "90D6B8F5-FE97-4509-9AAB-367836C51818"'."\n"
- .' }'."\n"
- ."\n"
- .'For more information, see [Response struct](~~464322~~).',
- ],
- 'ModifyPassword' => [
- 'summary' => 'Changes the password of an instance.',
- 'path' => '/openapi/ha3/instances/{instanceId}/password',
- 'methods' => [
- 'put',
- ],
- 'schemes' => [
- 'http',
- 'https',
+ .'```java'."\n"
+ .'/openapi/ha3/instances/{instanceId}/advanced-configs/{configName}/file'."\n"
+ .'```.',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => '',
+ 'ramAction' => [
+ 'action' => 'searchengine:CreateConfigFile',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SearchEngine', 'resourceType' => 'Instance', 'arn' => 'acs:searchengine:{#regionId}:{#accountId}:instance/{#InstanceId}'],
+ ],
+ ],
+ ],
],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"FE03180A-0E29-5474-8A86-33F0683294A4\\",\\n \\"result\\": {}\\n}","type":"json"}]',
+ ],
+ 'CreateDataSource' => [
+ 'summary' => 'Creates a data source.',
+ 'path' => '/openapi/ha3/instances/{instanceId}/data-sources',
+ 'methods' => ['post'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
- 'operationType' => 'write',
+ 'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
- 'operationType' => 'update',
+ 'operationType' => 'create',
+ 'abilityTreeCode' => '104719',
+ 'abilityTreeNodes' => ['FEATUREopensearchVHEWK3'],
],
'parameters' => [
[
'name' => 'instanceId',
'in' => 'path',
- 'schema' => [
- 'description' => 'The instance ID.'."\n",
- 'type' => 'string',
- 'required' => true,
- 'example' => 'ha-cn-7pp2pcna701',
- ],
+ 'schema' => ['description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'example' => 'ha-cn-pl32rf0****', 'title' => ''],
+ ],
+ [
+ 'name' => 'dryRun',
+ 'in' => 'query',
+ 'schema' => ['description' => 'Specifies whether to perform a dry run (only validates whether the data source is valid). Valid values:'."\n"
+ .'- true: performs a dry run.'."\n"
+ .'- false: does not perform a dry run.', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'title' => ''],
],
[
'name' => 'body',
'in' => 'body',
'style' => 'json',
'schema' => [
- 'description' => 'The request body.'."\n",
+ 'description' => 'The request struct.',
'type' => 'object',
'properties' => [
- 'username' => [
- 'description' => 'The username.'."\n",
- 'type' => 'string',
+ 'name' => ['title' => '', 'description' => 'The name of the data source.', 'type' => 'string', 'required' => false, 'example' => 'ha-cn-pl32rf0****_test_api'],
+ 'type' => ['title' => '', 'description' => 'The type of the data source. Valid values: odps, oss, and swift.', 'type' => 'string', 'required' => false, 'example' => 'odps'],
+ 'domain' => ['title' => '', 'description' => 'The data center where the data source resides.', 'type' => 'string', 'required' => false, 'example' => 'vpc_hz_domain_1'],
+ 'config' => [
+ 'title' => '',
+ 'description' => 'The configuration information.',
+ 'type' => 'object',
+ 'properties' => [
+ 'endpoint' => ['title' => '', 'description' => 'The endpoint of the ODPS data source or the OSS data source.', 'type' => 'string', 'required' => false, 'example' => 'http://service.cn-hangzhou.maxcompute.aliyun-inc.com/api'],
+ 'accessKey' => ['description' => 'The AccessKey ID of the ODPS data source.', 'type' => 'string', 'required' => false, 'example' => 'L***p', 'title' => ''],
+ 'accessSecret' => ['description' => 'The AccessKey secret of the ODPS data source.', 'type' => 'string', 'required' => false, 'example' => '5**9a6', 'title' => ''],
+ 'project' => ['description' => 'The project name of the ODPS data source.', 'type' => 'string', 'required' => false, 'example' => 'kubenest', 'title' => ''],
+ 'partition' => ['description' => 'The ODPS partition.', 'type' => 'string', 'required' => false, 'example' => 'ds=20220713', 'title' => ''],
+ 'table' => ['title' => '', 'description' => 'The ODPS table name.', 'type' => 'string', 'required' => false, 'example' => 'item'],
+ 'namespace' => ['title' => '', 'description' => 'The namespace.', 'type' => 'string', 'required' => false, 'example' => 'aegis-ops'],
+ 'path' => ['title' => '', 'description' => 'The HDFS file path.', 'type' => 'string', 'required' => false, 'example' => 'test-hdfs-path'."\n"],
+ 'ossPath' => ['title' => '', 'description' => 'The OSS file path.', 'type' => 'string', 'required' => false, 'example' => '/opensearch/search'],
+ 'bucket' => ['description' => 'oss bucket', 'type' => 'string', 'required' => false, 'example' => 'opensearch', 'title' => ''],
+ 'catalog' => ['type' => 'string', 'description' => '', 'required' => false, 'title' => '', 'example' => ''],
+ 'database' => ['type' => 'string', 'description' => '', 'required' => false, 'title' => '', 'example' => ''],
+ 'tag' => ['type' => 'string', 'description' => '', 'required' => false, 'title' => '', 'example' => ''],
+ ],
'required' => false,
- 'example' => '"username"',
+ 'example' => '',
],
- 'password' => [
- 'description' => 'The password.'."\n",
- 'type' => 'string',
+ 'saroConfig' => [
+ 'title' => '',
+ 'description' => 'The Saro datasource config.',
+ 'type' => 'object',
+ 'properties' => [
+ 'namespace' => ['description' => 'The namespace of the Saro data source.', 'type' => 'string', 'required' => false, 'example' => 'igraph-cn-x0r3e3abe02', 'title' => ''],
+ 'tableName' => ['description' => 'The Saro data table name.', 'type' => 'string', 'required' => false, 'example' => 'index_hdfs', 'title' => ''],
+ ],
'required' => false,
- 'example' => '******************************',
+ 'example' => '',
],
+ 'autoBuildIndex' => ['title' => '', 'description' => 'Specifies whether to automatically rebuild indexes.', 'type' => 'boolean', 'required' => false, 'example' => 'true'],
],
'required' => false,
'example' => '{}',
+ 'title' => '',
],
],
],
'responses' => [
200 => [
'schema' => [
- 'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
- 'requestId' => [
- 'title' => 'id of request',
- 'description' => 'The ID of the request'."\n",
- 'type' => 'string',
- 'example' => '407BFD91-DE7D-50BA-8F88-CDE52A3B5E46',
- ],
- 'result' => [
- 'title' => 'Map',
- 'description' => 'The result'."\n",
- 'type' => 'object',
- 'example' => '{}',
- ],
+ 'requestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '10D5E615-69F7-5F49-B850-00169ADE513C'],
+ 'result' => ['title' => '', 'description' => 'The returned result.', 'type' => 'object', 'example' => '{}'],
],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
],
- 500 => [],
+ '5XX' => [],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"407BFD91-DE7D-50BA-8F88-CDE52A3B5E46\\",\\n \\"result\\": {}\\n}","type":"json"}]',
- 'title' => 'ModifyPassword',
+ 'title' => 'Create a data source',
'description' => '### Method'."\n"
."\n"
- .'`PUT`'."\n"
+ .'```java'."\n"
+ .'POST'."\n"
+ .'```'."\n"
."\n"
.'### URI'."\n"
."\n"
- .'`/openapi/ha3/instances/{instanceId}/password`'."\n",
- 'responseParamsDescription' => '### [](#)Description of response parameters'."\n"
+ .'```java'."\n"
+ .'/openapi/ha3/instances/{instanceId}/data-sources'."\n"
+ .'```.',
+ 'requestParamsDescription' => '## Request example'."\n"
+ .'```'."\n"
+ .'POST /openapi/ha3/instances/ha3_instances_id/data-sources'."\n"
."\n"
- .'For more information, see [Response structure](~~465311~~).'."\n",
- ],
- 'ListInstances' => [
- 'summary' => 'Queries a list of instances.',
- 'path' => '/openapi/ha3/instances',
- 'methods' => [
- 'get',
- ],
- 'schemes' => [
- 'http',
- 'https',
+ .'{'."\n"
+ .' "name": "data_source_name",'."\n"
+ .' "type": "odps",'."\n"
+ .' "config":{'."\n"
+ .' "accessKey": "xxx",'."\n"
+ .' "accessSecret": "xxxs",'."\n"
+ .' "project":"xxxx",'."\n"
+ .' "table":"xxx",'."\n"
+ .' "partition":"xxxx"'."\n"
+ .' },'."\n"
+ .' "autoBuildIndex": true'."\n"
+ .'}'."\n"
+ .'```.',
+ 'responseParamsDescription' => '## Response example'."\n"
+ .'### Success response'."\n"
+ .'```json'."\n"
+ .'{'."\n"
+ .' "requestId": "0A6EB64B-B4C8-CF02-810F-E660812972FF",'."\n"
+ .' "result": []'."\n"
+ .'}'."\n"
+ .'```'."\n"
+ .'### Error response'."\n"
+ .'```'."\n"
+ .'{'."\n"
+ .' "requestId": "0A6EB64B-B4C8-CF02-810F-E660812972FF",'."\n"
+ .' "result": {'."\n"
+ .' "success": false,'."\n"
+ .' "data": "some error message"'."\n"
+ .' }'."\n"
+ .'}'."\n"
+ .'```'."\n"
+ .'For more information, see [Response struct](~~465311~~).',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateDataSource'],
+ ],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'create',
+ 'ramAction' => [
+ 'action' => 'searchengine:CreateDataSource',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SearchEngine', 'resourceType' => 'Instance', 'arn' => 'acs:searchengine:{#regionId}:{#accountId}:instance/{#InstanceId}'],
+ ],
+ ],
+ ],
],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"10D5E615-69F7-5F49-B850-00169ADE513C\\",\\n \\"result\\": {}\\n}","type":"json"}]',
+ ],
+ 'CreateFolder' => [
+ 'path' => '/openapi/ha3/instances/{instanceId}/sql-studio/databases/{database}/folders',
+ 'methods' => ['post'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
- 'operationType' => 'read',
+ 'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
- 'operationType' => 'get',
- 'abilityTreeCode' => '102492',
- 'abilityTreeNodes' => [
- 'FEATUREopensearch0AT3OG',
- 'FEATUREopensearchJB31XH',
- ],
+ 'operationType' => 'create',
+ 'abilityTreeCode' => '138808',
+ 'abilityTreeNodes' => ['FEATUREopensearch95VJR4'],
],
'parameters' => [
[
- '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',
- ],
- ],
- [
- 'name' => 'pageSize',
- 'in' => 'query',
- 'schema' => [
- 'description' => 'The number of entries to return on each page. Valid values: 1 to 50. Default value: 10.'."\n",
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'example' => '10',
- ],
- ],
- [
'name' => 'instanceId',
- 'in' => 'query',
- 'schema' => [
- 'description' => 'The instance ID.'."\n",
- 'type' => 'string',
- 'required' => false,
- 'example' => 'ha-cn-83570439y0n',
- ],
- ],
- [
- 'name' => 'description',
- 'in' => 'query',
- 'schema' => [
- 'description' => 'The description of the instance. You can use this description to filter instances. Fuzzy match is supported.'."\n",
- 'type' => 'string',
- 'required' => false,
- 'example' => 'Havenask instance'."\n",
- ],
- ],
- [
- 'name' => 'resourceGroupId',
- 'in' => 'query',
- 'schema' => [
- 'description' => 'The ID of the resource group to which the instance belongs.'."\n",
- 'type' => 'string',
- 'required' => false,
- 'example' => 'rg-aekzgpiswzbksdi',
- ],
+ 'in' => 'path',
+ 'schema' => ['description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'example' => 'ha-cn-pl32rf0****', 'title' => ''],
],
[
- 'name' => 'edition',
- 'in' => 'query',
- 'schema' => [
- 'description' => 'The instance type. Valid values: vector: OpenSearch Vector Search Edition instance. engine: OpenSearch Retrieval Engine Edition instance.'."\n",
- 'type' => 'string',
- 'required' => false,
- 'example' => 'vector',
- ],
+ 'name' => 'database',
+ 'in' => 'path',
+ 'schema' => ['description' => 'The database name.', 'type' => 'string', 'required' => true, 'example' => 'general', 'title' => ''],
],
[
- 'name' => 'tags',
- 'in' => 'query',
+ 'name' => 'body',
+ 'in' => 'body',
'style' => 'json',
'schema' => [
- 'description' => 'The tags of the instance.'."\n",
- 'type' => 'array',
- 'items' => [
- 'description' => '',
- 'type' => 'object',
- 'properties' => [
- 'key' => [
- 'description' => 'The tag key.'."\n",
- 'type' => 'string',
- 'required' => false,
- 'example' => 'backup',
- ],
- 'value' => [
- 'description' => 'The tag value.'."\n",
- 'type' => 'string',
- 'required' => false,
- 'example' => 'oboms-disk',
- ],
- ],
- 'required' => false,
+ 'description' => 'The request body parameters.',
+ 'type' => 'object',
+ 'properties' => [
+ 'name' => ['description' => 'The folder name.', 'type' => 'string', 'required' => true, 'example' => 'gist_qc', 'title' => ''],
+ 'parent' => ['description' => 'The parent category ID (required). If left empty, the default value is 1.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1', 'title' => ''],
+ 'type' => ['title' => '', 'description' => 'table, instance, template, function', 'type' => 'string', 'required' => true, 'example' => 'instance'],
],
'required' => false,
- ],
- ],
- [
- 'name' => 'catalog',
- 'in' => 'query',
- 'schema' => [
- 'type' => 'string',
- ],
- ],
- [
- 'name' => 'database',
- 'in' => 'query',
- 'schema' => [
- 'type' => 'string',
- ],
- ],
- [
- 'name' => 'table',
- 'in' => 'query',
- 'schema' => [
- 'type' => 'string',
- ],
- ],
- [
- 'name' => 'dataSourceType',
- 'in' => 'query',
- 'schema' => [
- 'type' => 'string',
+ 'title' => '',
+ 'example' => '',
],
],
],
'responses' => [
200 => [
'schema' => [
- 'title' => 'Schema of Response',
- 'description' => 'The response parameters.'."\n",
'type' => 'object',
'properties' => [
+ 'requestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => 'E7B7D598-B080-5C8E-AA35-D43EC0D5F886'],
'result' => [
- 'description' => 'The results returned.'."\n",
- 'type' => 'array',
- 'items' => [
- 'title' => 'InstanceItemType',
- 'description' => 'InstanceItemType'."\n",
- 'type' => 'object',
- 'properties' => [
- 'description' => [
- 'title' => '实例描述',
- 'description' => 'The description of the instance.'."\n",
- 'type' => 'string',
- 'example' => 'Emergency test'."\n",
- ],
- 'resourceGroupId' => [
- 'title' => '资源组ID',
- 'description' => 'The ID of the resource group.'."\n",
- 'type' => 'string',
- 'example' => 'rg-aekzgpiswzbksdi',
- ],
- 'expiredTime' => [
- 'title' => '到期时间',
- 'description' => 'The time when the instance expires.'."\n",
- 'type' => 'string',
- 'example' => '1634885083',
- ],
- 'commodityCode' => [
- 'title' => '商品code',
- 'description' => 'The commodity code of the instance.'."\n",
- 'type' => 'string',
- 'example' => '""',
- ],
- 'status' => [
- 'title' => '状态',
- 'description' => 'The instance status.'."\n",
- 'type' => 'string',
- 'example' => '2',
- ],
- 'instanceId' => [
- 'title' => '资源一级ID',
- 'description' => 'The instance ID.'."\n",
- 'type' => 'string',
- 'example' => 'ha-cn-2r42n8oh001',
- ],
- 'createTime' => [
- 'title' => '创建时间',
- 'description' => 'The time when the instance was created.'."\n",
- 'type' => 'string',
- 'example' => '2022-06-04T02:03:21Z',
- ],
- 'lockMode' => [
- 'title' => '锁定状态',
- 'description' => 'The lock state of the instance.'."\n",
- 'type' => 'string',
- 'example' => 'Unlock',
- ],
- 'chargeType' => [
- 'title' => '付费类型',
- 'description' => 'The billing method.'."\n",
- 'type' => 'string',
- 'example' => 'PrePaid',
- ],
- 'updateTime' => [
- 'title' => '更新时间',
- 'description' => 'The time when the instance was updated.'."\n",
- 'type' => 'string',
- 'example' => '2018-12-06T11:17:49.0',
- ],
- 'inDebt' => [
- 'title' => '是否欠费',
- 'description' => 'Indicates whether an overdue payment is involved.'."\n",
- 'type' => 'boolean',
- 'example' => 'false',
- ],
- 'network' => [
- 'description' => 'The network information of the instance.'."\n",
- 'type' => 'object',
- 'properties' => [
- 'vSwitchId' => [
- 'description' => 'The vSwitch ID.'."\n",
- 'type' => 'string',
- 'example' => 'vsw-bp11ldcf59q2nbwkqgj6z',
- ],
- 'vpcId' => [
- 'description' => 'The ID of the virtual private cloud (VPC) in which the instance is deployed.'."\n",
- 'type' => 'string',
- 'example' => 'vpc-wz9axk41d9vffoc79x0oe',
- ],
- 'endpoint' => [
- 'description' => 'The instance endpoint.'."\n",
- 'type' => 'string',
- 'example' => '""',
- ],
- 'publicEndpoint' => [
- 'type' => 'string',
- ],
- 'allow' => [
- 'type' => 'string',
- ],
- ],
- ],
- 'tags' => [
- 'description' => 'The tags of the instance.'."\n",
- 'type' => 'array',
- 'items' => [
- 'description' => '',
- 'type' => 'object',
- 'properties' => [
- 'key' => [
- 'description' => 'The tag key.'."\n",
- 'type' => 'string',
- 'example' => 'env',
- ],
- 'value' => [
- 'description' => 'The tag value.'."\n",
- 'type' => 'string',
- 'example' => 'oboms-disk',
- ],
- ],
- ],
- ],
- 'edition' => [
- 'type' => 'string',
- ],
- 'userName' => [
- 'type' => 'string',
- ],
- 'version' => [
- 'type' => 'string',
- ],
- 'noQrs' => [
- 'type' => 'boolean',
- ],
- 'spec' => [
- 'type' => 'object',
- 'properties' => [
- 'qrsResource' => [
- 'type' => 'object',
- 'properties' => [
- 'category' => [
- 'type' => 'string',
- ],
- 'cpu' => [
- 'type' => 'integer',
- 'format' => 'int32',
- ],
- 'mem' => [
- 'type' => 'integer',
- 'format' => 'int32',
- ],
- 'disk' => [
- 'type' => 'integer',
- 'format' => 'int32',
- ],
- 'nodeCount' => [
- 'type' => 'integer',
- 'format' => 'int32',
- ],
- ],
- ],
- 'searchResource' => [
- 'type' => 'object',
- 'properties' => [
- 'category' => [
- 'type' => 'string',
- ],
- 'cpu' => [
- 'type' => 'integer',
- 'format' => 'int32',
- ],
- 'mem' => [
- 'type' => 'integer',
- 'format' => 'int32',
- ],
- 'disk' => [
- 'type' => 'integer',
- 'format' => 'int32',
- ],
- 'nodeCount' => [
- 'type' => 'integer',
- 'format' => 'int32',
- ],
- ],
- ],
- ],
- ],
- 'dataSourceDetails' => [
- 'type' => 'array',
- 'items' => [
- 'type' => 'object',
- 'properties' => [
- 'indexName' => [
- 'type' => 'string',
- ],
- 'type' => [
- 'type' => 'string',
- ],
- 'config' => [
- 'type' => 'object',
- 'properties' => [
- 'endpoint' => [
- 'type' => 'string',
- ],
- 'accessKey' => [
- 'type' => 'string',
- ],
- 'project' => [
- 'type' => 'string',
- ],
- 'partition' => [
- 'type' => 'string',
- ],
- 'table' => [
- 'type' => 'string',
- ],
- 'namespace' => [
- 'type' => 'string',
- ],
- 'path' => [
- 'type' => 'string',
- ],
- 'ossPath' => [
- 'type' => 'string',
- ],
- 'bucket' => [
- 'type' => 'string',
- ],
- 'catalog' => [
- 'type' => 'string',
- ],
- 'database' => [
- 'type' => 'string',
- ],
- 'tag' => [
- 'type' => 'string',
- ],
- ],
- ],
- ],
- ],
- ],
- ],
+ 'title' => '',
+ 'description' => 'The returned result.',
+ 'type' => 'object',
+ 'properties' => [
+ 'id' => ['description' => 'The folder ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '25030', 'title' => ''],
+ 'gmtCreate' => ['description' => 'The creation time.', 'type' => 'string', 'example' => '1719221186114', 'title' => ''],
+ 'gmtModified' => ['description' => 'The update time.', 'type' => 'string', 'example' => '1719221186114', 'title' => ''],
+ 'name' => ['description' => 'The name.', 'type' => 'string', 'example' => 'test', 'title' => ''],
+ 'parent' => ['description' => 'The parent level ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '-1', 'title' => ''],
+ 'isDir' => ['description' => 'Indicates whether the entry is a folder. Valid values:'."\n"
+ .'- true: The entry is a folder.'."\n"
+ .'- false: The entry is not a folder.', 'type' => 'integer', 'format' => 'int32', 'example' => 'True', 'title' => ''],
+ 'type' => ['title' => '', 'description' => 'table, instance, template, function', 'type' => 'string', 'example' => 'instance'],
+ 'instanceId' => ['description' => 'The instance ID.', 'type' => 'integer', 'format' => 'int64', 'example' => 'ha-cn-pl32rf0****', 'title' => ''],
+ 'templateId' => ['description' => 'The template ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => ''],
],
- ],
- 'totalCount' => [
- 'title' => '总记录数。',
- 'description' => 'The total number of entries returned'."\n",
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '5',
- ],
- 'requestId' => [
- 'title' => 'Id of the request',
- 'description' => 'The ID of the request'."\n",
- 'type' => 'string',
- 'example' => '89B968E6-1E41-58DF-BB25-5F98ECC759CE',
- ],
- ],
- ],
- ],
- 500 => [
- 'schema' => [
- 'type' => 'object',
- 'properties' => [
- 'requestId' => [
- 'type' => 'string',
- ],
- 'message' => [
- 'type' => 'string',
- ],
- 'code' => [
- 'type' => 'string',
+ 'example' => '',
],
],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
],
+ 500 => [],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"result\\": [\\n {\\n \\"description\\": \\"test\\",\\n \\"resourceGroupId\\": \\"ha-cn-pl32rf0****\\",\\n \\"expiredTime\\": \\"1634885083\\",\\n \\"commodityCode\\": \\"opensearch_ha3post_public_cn\\",\\n \\"status\\": \\"READY\\",\\n \\"instanceId\\": \\"ha-cn-pl32rf0****\\",\\n \\"createTime\\": \\"2022-06-04T02:03:21Z\\",\\n \\"lockMode\\": \\"Unlock\\",\\n \\"chargeType\\": \\"POSTPAY\\",\\n \\"updateTime\\": \\"2018-12-06T11:17:49.0\\",\\n \\"inDebt\\": false,\\n \\"network\\": {\\n \\"vSwitchId\\": \\"vsw-bp11ldcf59q2n****\\",\\n \\"vpcId\\": \\"vpc-wz9axk41d9vff****\\",\\n \\"endpoint\\": \\"ha-cn-35t3r****.ha.aliyuncs.com\\",\\n \\"publicEndpoint\\": \\"ha-cn-35t3ni****.public.ha.aliyuncs.com\\",\\n \\"allow\\": \\"127.0.0.1\\"\\n },\\n \\"tags\\": [\\n {\\n \\"key\\": \\"opensearch\\",\\n \\"value\\": \\"opensearch\\"\\n }\\n ],\\n \\"edition\\": \\"vector\\",\\n \\"userName\\": \\"admin\\",\\n \\"version\\": \\"ha3_3.10.0\\",\\n \\"noQrs\\": false,\\n \\"spec\\": {\\n \\"qrsResource\\": {\\n \\"category\\": \\"local_ssd\\",\\n \\"cpu\\": 1,\\n \\"mem\\": 10,\\n \\"disk\\": 100,\\n \\"nodeCount\\": 3\\n },\\n \\"searchResource\\": {\\n \\"category\\": \\"local_ssd\\",\\n \\"cpu\\": 1,\\n \\"mem\\": 10,\\n \\"disk\\": 100,\\n \\"nodeCount\\": 3\\n }\\n },\\n \\"dataSourceDetails\\": [\\n {\\n \\"indexName\\": \\"\\",\\n \\"type\\": \\"\\",\\n \\"config\\": {\\n \\"endpoint\\": \\"\\",\\n \\"accessKey\\": \\"\\",\\n \\"project\\": \\"\\",\\n \\"partition\\": \\"\\",\\n \\"table\\": \\"\\",\\n \\"namespace\\": \\"\\",\\n \\"path\\": \\"\\",\\n \\"ossPath\\": \\"\\",\\n \\"bucket\\": \\"\\",\\n \\"catalog\\": \\"\\",\\n \\"database\\": \\"\\",\\n \\"tag\\": \\"\\"\\n }\\n }\\n ]\\n }\\n ],\\n \\"totalCount\\": 5,\\n \\"requestId\\": \\"89B968E6-1E41-58DF-BB25-5F98ECC759CE\\"\\n}","type":"json"}]',
- 'title' => 'ListInstances',
- 'description' => '### [](#)Method'."\n"
- ."\n"
- .'`GET`'."\n"
- ."\n"
- .'### [](#uri)URI'."\n"
- ."\n"
- .'`/openapi/ha3/instances`'."\n",
- 'requestParamsDescription' => '|Parameter|Type|Required|Description|'."\n"
- .'|---|---|---|---|'."\n"
- .'|status|String|No|The status of the instance. You can filter instances by status. Valid values: Running, Ready, Initializing,Starting|'."\n"
- .'|expiredTime|Long|No|The time when the instance expires. The value of this parameter must be accurate to the second. Only instances whose expiration time is greater than the value of this parameter will be returned. The instances that have already expired will not be returned.|'."\n"
- ."\n"
- .'### Example'."\n"
- ."\n"
- .'**Sample requests**'."\n"
- ."\n"
- .'`GET /openapi/ha3/instances?name=test&#x26;instanceId=abc&#x26;page=1&#x26;size=10`',
- 'responseParamsDescription' => '### Sample responses'."\n"
- ."\n"
- .'**Sample success responses**'."\n"
+ 'title' => 'Create a folder',
+ 'summary' => 'Creates a folder.',
+ 'description' => '### Method'."\n"
."\n"
- .' {'."\n"
- .' "requestId": "90D6B8F5-FE97-4509-9AAB-367836C51818",'."\n"
- .' "result": ['."\n"
- .' {'."\n"
- .' "instanceId": "igraph-cn-xxxxxx1",'."\n"
- .' "spec": {'."\n"
- .' "password": "passwd",'."\n"
- .' "searchResource": {'."\n"
- .' "disk": 50,'."\n"
- .' "mem": 8,'."\n"
- .' "cpu": 2,'."\n"
- .' "nodeCount": 2'."\n"
- .' },'."\n"
- .' "instanceName": "testInstance",'."\n"
- .' "vSwitchId": "vswitch_id_xxx",'."\n"
- .' "vpcId": "vpc_id_xxx",'."\n"
- .' "qrsResource": {'."\n"
- .' "disk": 50,'."\n"
- .' "mem": 8,'."\n"
- .' "cpu": 2,'."\n"
- .' "nodeCount": 2'."\n"
- .' },'."\n"
- .' "region": "cn-hangzhou",'."\n"
- .' "userName": "user"'."\n"
- .' },'."\n"
- .' "status": {'."\n"
- .' "phase": "PENDING",'."\n"
- .' "instancePhase": "INIT",'."\n"
- .' "createSuccess": false'."\n"
- .' }'."\n"
- .' },'."\n"
- .' {'."\n"
- .' "instanceId": "igraph-cn-xxxxxx2",'."\n"
- .' "spec": {'."\n"
- .' "password": "passwd",'."\n"
- .' "searchResource": {'."\n"
- .' "disk": 50,'."\n"
- .' "mem": 8,'."\n"
- .' "cpu": 2,'."\n"
- .' "nodeCount": 2'."\n"
- .' },'."\n"
- .' "instanceName": "testInstance",'."\n"
- .' "vSwitchId": "vswitch_id_xxx",'."\n"
- .' "vpcId": "vpc_id_xxx",'."\n"
- .' "qrsResource": {'."\n"
- .' "disk": 50,'."\n"
- .' "mem": 8,'."\n"
- .' "cpu": 2,'."\n"
- .' "nodeCount": 2'."\n"
- .' },'."\n"
- .' "region": "cn-hangzhou",'."\n"
- .' "userName": "user"'."\n"
- .' },'."\n"
- .' "status": {'."\n"
- .' "phase": "PENDING",'."\n"
- .' "instancePhase": "INIT",'."\n"
- .' "createSuccess": false'."\n"
- .' }'."\n"
- .' }'."\n"
- .' ],'."\n"
- .' "totalCount": 20'."\n"
- .' }'."\n"
+ .'```java'."\n"
+ .'POST'."\n"
+ .'```'."\n"
."\n"
- .'**Sample error responses**'."\n"
+ .'### URI'."\n"
."\n"
- .' {'."\n"
- .' "requestId": "BD1EA715-DF6F-06C2-004C-C1FA0D3A9820",'."\n"
- .' "httpCode": 404,'."\n"
- .' "code": "App.NotFound",'."\n"
- .' "message": "App not found"'."\n"
- .' }'."\n",
- ],
- 'GetInstance' => [
- 'summary' => 'Queries the details of an instance based on the instance ID.',
- 'path' => '/openapi/ha3/instances/{instanceId}',
- 'methods' => [
- 'get',
- ],
- 'schemes' => [
- 'http',
- 'https',
+ .'```java'."\n"
+ .'/openapi/ha3/instances/{instanceId}/sql-studio/databases/{database}/folders'."\n"
+ .'```.',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateFolder'],
+ ],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'create',
+ 'ramAction' => [
+ 'action' => 'searchengine:CreateFolder',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SearchEngine', 'resourceType' => 'Folder', 'arn' => 'acs:searchengine:{#regionId}:{#accountId}:instance/{#InstanceId}'],
+ ],
+ ],
+ ],
],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"E7B7D598-B080-5C8E-AA35-D43EC0D5F886\\",\\n \\"result\\": {\\n \\"id\\": 25030,\\n \\"gmtCreate\\": \\"1719221186114\\",\\n \\"gmtModified\\": \\"1719221186114\\",\\n \\"name\\": \\"test\\",\\n \\"parent\\": -1,\\n \\"isDir\\": 0,\\n \\"type\\": \\"instance\\",\\n \\"instanceId\\": 0,\\n \\"templateId\\": 1\\n }\\n}","type":"json"}]',
+ ],
+ 'CreateIndex' => [
+ 'summary' => 'Creates an index.',
+ 'path' => '/openapi/ha3/instances/{instanceId}/indexes',
+ 'methods' => ['post'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
- 'operationType' => 'read',
+ 'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
- 'operationType' => 'get',
+ 'operationType' => 'create',
'riskType' => 'none',
'chargeType' => 'free',
- 'abilityTreeCode' => '102489',
- 'abilityTreeNodes' => [
- 'FEATUREopensearch0AT3OG',
- 'FEATUREopensearchJB31XH',
- ],
+ 'abilityTreeCode' => '104691',
+ 'abilityTreeNodes' => ['FEATUREopensearchVHEWK3'],
],
'parameters' => [
[
'name' => 'instanceId',
'in' => 'path',
- 'schema' => [
- 'title' => '实例 ID。',
- 'description' => 'The instance ID.'."\n",
- 'type' => 'string',
- 'required' => true,
- 'example' => 'ha-cn-7pp2pcna701',
- ],
+ 'schema' => ['description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'ha-cn-2r42ppr****'],
],
- ],
- 'responses' => [
- 200 => [
+ [
+ 'name' => 'body',
+ 'in' => 'body',
+ 'style' => 'json',
'schema' => [
- 'title' => 'Schema of Response',
- 'description' => 'Schema of Response'."\n",
+ 'description' => 'The request body.',
'type' => 'object',
'properties' => [
- 'result' => [
- 'description' => 'Response parameters'."\n",
+ 'name' => ['title' => '', 'description' => 'The name of the index.', 'type' => 'string', 'required' => false, 'example' => 'index_1'],
+ 'dataSource' => ['title' => '', 'description' => 'The name of the data source.', 'type' => 'string', 'required' => false, 'example' => 'ha-cn-35t3n1y****_index_1'],
+ 'domain' => ['title' => '', 'description' => 'The data center of the data source.', 'type' => 'string', 'required' => false, 'example' => 'vpc_hz_domain_1'],
+ 'content' => ['title' => '', 'description' => 'The index schema.', 'type' => 'string', 'required' => false, 'example' => '{\\"summarys\\":{\\"summary_fields\\":[\\"id\\"]},\\"indexs\\":[{\\"index_name\\":\\"index_id\\",\\"index_type\\":\\"PRIMARYKEY64\\",\\"index_fields\\":\\"id\\",\\"has_primary_key_attribute\\":true,\\"is_primary_key_sorted\\":false}],\\"attributes\\":[\\"id\\"],\\"fields\\":[{\\"field_name\\":\\"id\\",\\"field_type\\":\\"UINT16\\"}],\\"table_name\\":\\"index_2\\"}'],
+ 'partition' => ['title' => '', 'description' => 'The number of data shards.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '2'],
+ 'dataSourceInfo' => [
+ 'description' => 'Information about the data source. This parameter is required for new versions of Vector Search Edition.',
'type' => 'object',
'properties' => [
- 'description' => [
- 'title' => '实例描述',
- 'description' => 'The description of the instance.'."\n",
- 'type' => 'string',
- 'example' => 'ha3_test',
- ],
- 'resourceGroupId' => [
- 'title' => '资源组ID',
- 'description' => 'The ID of the resource group.'."\n",
- 'type' => 'string',
- 'example' => 'rg-aekzjvw24el5lma',
- ],
- 'expiredTime' => [
- 'title' => '到期时间',
- 'description' => 'The time when the instance expires.'."\n",
- 'type' => 'string',
- 'example' => '1634609702',
- ],
- 'commodityCode' => [
- 'title' => '商品code',
- 'description' => 'The commodity code of the instance.'."\n",
- 'type' => 'string',
- 'example' => 'commodityCode',
- ],
- 'instanceId' => [
- 'title' => '资源一级ID',
- 'description' => 'The instance ID.'."\n",
- 'type' => 'string',
- 'example' => 'ha-cn-7mz2qsgq301',
- ],
- 'createTime' => [
- 'title' => '创建时间',
- 'description' => 'The time when the instance was created.'."\n",
- 'type' => 'string',
- 'example' => '2022-06-17T02:01:26Z',
- ],
- 'lockMode' => [
- 'title' => '锁定状态',
- 'description' => 'The lock status.'."\n",
- 'type' => 'string',
- 'example' => 'Unlock',
- ],
- 'chargeType' => [
- 'title' => '付费类型',
- 'description' => 'The billing method.'."\n",
- 'type' => 'string',
- 'example' => 'POSYPAY',
- ],
- 'updateTime' => [
- 'title' => '更新时间',
- 'description' => 'The time when the instance was updated.'."\n",
- 'type' => 'string',
- 'example' => '1634609702',
- ],
- 'inDebt' => [
- 'title' => '是否欠费',
- 'description' => 'Indicates whether an overdue payment is involved.'."\n",
- 'type' => 'boolean',
- 'example' => 'false',
- ],
- 'status' => [
- 'description' => 'The status of the instance. Valid values:'."\n"
- ."\n"
- .'* INIT: being initialized'."\n"
- .'* WAIT_CONFIG: to be configured'."\n"
- .'* CONFIG_UPDATING: configuration taking effect'."\n"
- .'* READY: normal'."\n",
- 'type' => 'string',
- 'example' => 'INIT',
- ],
- 'tags' => [
- 'description' => 'The tags of the instance.'."\n",
- 'type' => 'array',
- 'items' => [
- 'description' => '',
- 'type' => 'object',
- 'properties' => [
- 'key' => [
- 'description' => 'The tag key.'."\n",
- 'type' => 'string',
- 'example' => 'env',
- ],
- 'value' => [
- 'description' => 'The tag value.'."\n",
- 'type' => 'string',
- 'example' => 'prod',
- ],
- ],
- ],
- ],
- 'edition' => [
- 'description' => 'The edition of the instance. Valid values: vector and engine.'."\n",
- 'type' => 'string',
- 'example' => 'vector',
- ],
- 'userName' => [
- 'description' => 'The username.'."\n",
- 'type' => 'string',
- 'example' => 'admin',
- ],
- 'version' => [
- 'description' => 'The version of the engine.'."\n",
- 'type' => 'string',
- 'example' => 'ha3_3.10.0',
- ],
- 'bsVersion' => [
- 'type' => 'string',
- ],
- 'noQrs' => [
- 'description' => 'Specifies whether the instance has only one node.'."\n",
- 'type' => 'boolean',
- 'example' => 'false',
- ],
- 'newMode' => [
- 'description' => 'Specifies whether the instance is of the new version.'."\n",
- 'type' => 'boolean',
- 'example' => 'true',
- ],
- 'network' => [
- 'description' => 'The network information of the instance.'."\n",
+ 'dataTimeSec' => ['description' => 'The UNIX timestamp for incremental data.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'title' => '', 'example' => '1709715164'],
+ 'processPartitionCount' => ['description' => 'The number of resources for data updates.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'title' => '', 'example' => '4'],
+ 'name' => ['description' => 'The name of the data source.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => 'ha-cn-35t3n1y****_index_1'],
+ 'type' => ['description' => 'The type of the data source. Valid values:'."\n"
+ ."\n"
+ .'- odps'."\n"
+ ."\n"
+ .'- swift'."\n"
+ ."\n"
+ .'- saro'."\n"
+ ."\n"
+ .'- oss', 'type' => 'string', 'required' => false, 'title' => '', 'example' => 'odps'],
+ 'domain' => ['description' => 'The offline data center.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => 'vpc_hz_domain_1'."\n"],
+ 'config' => [
+ 'description' => 'ODPS-related configurations.',
'type' => 'object',
'properties' => [
- 'vSwitchId' => [
- 'description' => 'The vSwitch ID.'."\n",
- 'type' => 'string',
- 'example' => 'vsw-bp11ldcf59q2n****'."\n",
- ],
- 'vpcId' => [
- 'description' => 'The VPC ID.'."\n",
- 'type' => 'string',
- 'example' => 'vpc-wz9axk41d9vff****'."\n",
- ],
- 'endpoint' => [
- 'description' => 'The instance endpoint.'."\n",
- 'type' => 'string',
- 'example' => 'ha-cn-35t3r****.ha.aliyuncs.com'."\n",
- ],
- 'publicEndpoint' => [
- 'description' => 'The public endpoint.'."\n",
- 'type' => 'string',
- 'example' => 'ha-cn-35t3ni****.public.ha.aliyuncs.com'."\n",
- ],
- 'allow' => [
- 'description' => 'The public domain name whitelist.'."\n",
- 'type' => 'string',
- 'example' => '127.0.0.1'."\n",
- ],
+ 'endpoint' => ['description' => 'The endpoint of the ODPS or OSS data source.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => 'https://oss-cn-hangzhou.aliyuncs.com'],
+ 'accessKey' => ['description' => 'The AccessKey ID of the ODPS data source.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => 'L***p'],
+ 'accessSecret' => ['description' => 'The AccessKey secret of the ODPS data source.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => '5**9a6'],
+ 'project' => ['description' => 'The name of the ODPS project.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => 'bbt_algo_pai'],
+ 'partition' => ['description' => 'This parameter is required if the data source type is ODPS.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => 'ds=20230114'],
+ 'table' => ['description' => 'The name of the table.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => 'bbt_rec_swing_u2i2i_score_be_v1'],
+ 'namespace' => ['description' => 'The namespace.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => 'test-namespace'],
+ 'path' => ['description' => 'The path of the HDFS data source.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => 'test-hdfs-path'],
+ 'ossPath' => ['description' => 'The path of the OSS file.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => '/opensearch/oss.json'],
+ 'bucket' => ['description' => 'The OSS bucket.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => 'test-bucket'],
+ 'format' => ['type' => 'string', 'description' => 'The format of the OSS file.'."\n"
+ ."\n"
+ .'- ha3'."\n"
+ ."\n"
+ .'- json', 'required' => false, 'title' => '', 'example' => 'ha3'],
+ 'catalog' => ['type' => 'string', 'description' => 'The data catalog ID of the DLF data source.', 'required' => false, 'title' => '', 'example' => 'test-catalog'],
+ 'database' => ['type' => 'string', 'description' => 'The database of the DLF data source.', 'required' => false, 'title' => '', 'example' => 'test-database'],
+ 'tag' => ['type' => 'string', 'description' => 'The tag of the DLF data source.', 'required' => false, 'title' => '', 'example' => 'test-tag'],
+ 'tableFormat' => ['type' => 'string', 'description' => 'The table format of the DLF data source.', 'required' => false, 'title' => '', 'example' => 'paimon'."\n"
+ .'lance'."\n"
+ .'object'],
],
+ 'required' => false,
+ 'title' => '',
+ 'example' => '',
],
- 'spec' => [
- 'description' => 'The node specifications.'."\n",
+ 'saroConfig' => [
+ 'description' => 'The configuration of the Saro data source.',
'type' => 'object',
'properties' => [
- 'qrsResource' => [
- 'description' => 'The QRS worker specifications.'."\n",
- 'type' => 'object',
- 'properties' => [
- 'category' => [
- 'description' => 'The category. Valid values: local_ssd, SSD, and cloud.'."\n",
- 'type' => 'string',
- 'example' => 'local_ssd',
- ],
- 'cpu' => [
- 'description' => 'The number of vCPUs.'."\n",
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '2',
- ],
- 'mem' => [
- 'description' => 'The memory of the instance. Unit: GB.'."\n",
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '10',
- ],
- 'disk' => [
- 'description' => 'The storage capacity. Unit: GB.'."\n",
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '100',
- ],
- 'nodeCount' => [
- 'description' => 'The number of nodes.'."\n",
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '1',
- ],
- ],
- ],
- 'searchResource' => [
- 'description' => 'The searcher worker specifications.'."\n",
- 'type' => 'object',
- 'properties' => [
- 'category' => [
- 'description' => 'The category. Valid values: local_ssd, SSD, and cloud.'."\n",
- 'type' => 'string',
- 'example' => 'local_ssd',
- ],
- 'cpu' => [
- 'description' => 'The number of vCPUs.'."\n",
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '2',
- ],
- 'mem' => [
- 'description' => 'The memory of the instance. Unit: GB.'."\n",
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '10',
- ],
- 'disk' => [
- 'description' => 'The storage capacity. Unit: GB.'."\n",
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '100',
- ],
- 'nodeCount' => [
- 'description' => 'The number of nodes.'."\n",
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '1',
- ],
- ],
- ],
+ 'namespace' => ['description' => 'The namespace of the Saro data source. This feature is available only for internal use.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => 'test'],
+ 'tableName' => ['description' => 'The name of the Saro data table. This feature is available only for internal use.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => 'tableA'],
],
+ 'required' => false,
+ 'title' => '',
+ 'example' => '',
],
- 'zoneCount' => [
- 'type' => 'integer',
- 'format' => 'int32',
- ],
+ 'autoBuildIndex' => ['description' => 'Specifies whether to automatically trigger a full indexing.', 'type' => 'boolean', 'required' => false, 'title' => '', 'example' => 'true'],
+ 'processParallelNum' => ['description' => 'The concurrency for full data processing.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'title' => '', 'example' => '2'],
+ 'scene' => ['type' => 'string', 'title' => '', 'description' => 'The template type.', 'required' => false, 'example' => 'videoSearcher'],
],
+ 'required' => false,
+ 'title' => '',
+ 'example' => '',
],
- 'requestId' => [
- 'title' => 'Id of the request',
- 'description' => 'The request ID.'."\n",
- 'type' => 'string',
- 'example' => 'E7B7D598-B080-5C8E-AA35-D43EC0D5F886',
- ],
+ 'extend' => ['description' => 'The extended field configuration.'."\n"
+ ."\n"
+ .'- key: The field type. Valid values: \\`vector\\` (vector field), \\`embeding\\` (field that requires embedding), and \\`description\\` (description field).'."\n"
+ ."\n"
+ .'- value: The name of the field in the schema, such as \\`\\["field\\_name"]\\`.', 'type' => 'object', 'required' => false, 'title' => '', 'example' => '{'."\n"
+ .' "vector":'."\n"
+ .' ['."\n"
+ .' "source_image_vector"'."\n"
+ .' ],'."\n"
+ .' "embeding":'."\n"
+ .' ['."\n"
+ .' "source_image"'."\n"
+ .' ],'."\n"
+ .' "description":'."\n"
+ .' []'."\n"
+ .' }'],
+ 'buildParallelNum' => ['description' => 'The concurrency for full index building.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'title' => '', 'example' => '2'],
+ 'mergeParallelNum' => ['description' => 'The concurrency for full index merging.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'title' => '', 'example' => '2'],
],
- ],
- ],
- 500 => [],
- ],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"result\\": {\\n \\"description\\": \\"test\\",\\n \\"resourceGroupId\\": \\"rg-aekzjvw24****\\",\\n \\"expiredTime\\": \\"024-05-21 16:49:31.0\\",\\n \\"commodityCode\\": \\"opensearch_ha3post_public_cn\\",\\n \\"instanceId\\": \\"ha-cn-pl32rf0****\\",\\n \\"createTime\\": \\"2022-06-17T02:01:26Z\\",\\n \\"lockMode\\": \\"Unlock\\",\\n \\"chargeType\\": \\"POSYPAY\\",\\n \\"updateTime\\": \\"024-05-21 16:49:31.0\\",\\n \\"inDebt\\": false,\\n \\"status\\": \\"INIT\\",\\n \\"tags\\": [\\n {\\n \\"key\\": \\"opensearch\\",\\n \\"value\\": \\"opensearch\\"\\n }\\n ],\\n \\"edition\\": \\"vector\\",\\n \\"userName\\": \\"admin\\",\\n \\"version\\": \\"ha3_3.10.0\\",\\n \\"bsVersion\\": \\"bs_3.13.2\\",\\n \\"noQrs\\": false,\\n \\"newMode\\": true,\\n \\"network\\": {\\n \\"vSwitchId\\": \\"vsw-bp11ldcf59q2n****\\\\n\\",\\n \\"vpcId\\": \\"vpc-wz9axk41d9vff****\\\\n\\",\\n \\"endpoint\\": \\"ha-cn-35t3r****.ha.aliyuncs.com\\\\n\\",\\n \\"publicEndpoint\\": \\"ha-cn-35t3ni****.public.ha.aliyuncs.com\\\\n\\",\\n \\"allow\\": \\"127.0.0.1\\\\n\\"\\n },\\n \\"spec\\": {\\n \\"qrsResource\\": {\\n \\"category\\": \\"local_ssd\\",\\n \\"cpu\\": 2,\\n \\"mem\\": 10,\\n \\"disk\\": 100,\\n \\"nodeCount\\": 1\\n },\\n \\"searchResource\\": {\\n \\"category\\": \\"local_ssd\\",\\n \\"cpu\\": 2,\\n \\"mem\\": 10,\\n \\"disk\\": 100,\\n \\"nodeCount\\": 1\\n }\\n },\\n \\"zoneCount\\": 1\\n },\\n \\"requestId\\": \\"E7B7D598-B080-5C8E-AA35-D43EC0D5F886\\"\\n}","type":"json"}]',
- 'title' => 'GetInstance',
- 'description' => '### [](#)Method'."\n"
- ."\n"
- .'```java'."\n"
- .'GET'."\n"
- .'```'."\n"
- ."\n"
- .'### [](#uri)URI'."\n"
- ."\n"
- .'```java'."\n"
- .'/openapi/ha3/instances/{instanceId}'."\n"
- .'```'."\n",
- 'requestParamsDescription' => '### Sample requests'."\n"
- ."\n"
- .'`GET /openapi/ha3/instances/ha3-cn-xxxxxx`'."\n",
- 'responseParamsDescription' => '### [](#)Sample responses'."\n"
- ."\n"
- .'**Sample success response**'."\n"
- ."\n"
- .' {'."\n"
- .' "result":'."\n"
- .' {'."\n"
- .' "inDebt": false,'."\n"
- .' "lockMode": "Unlock",'."\n"
- .' "trFreeUrl": "",'."\n"
- .' "chargeType": "POSTPAY",'."\n"
- .' "edition": "vector",'."\n"
- .' "description": "ha-cn-vkl3rgrfc01",'."\n"
- .' "updateTime": "2024-05-30 10:52:00.0",'."\n"
- .' "userName": "admin",'."\n"
- .' "version": "vector_service_1.2.2",'."\n"
- .' "spec":'."\n"
- .' {'."\n"
- .' "qrsResource":'."\n"
- .' {'."\n"
- .' "category": "local_ssd",'."\n"
- .' "cpu": 2,'."\n"
- .' "mem": 8,'."\n"
- .' "disk": 100,'."\n"
- .' "nodeCount": 0'."\n"
- .' },'."\n"
- .' "searchResource":'."\n"
- .' {'."\n"
- .' "category": "local_ssd",'."\n"
- .' "cpu": 2,'."\n"
- .' "mem": 16,'."\n"
- .' "disk": 100,'."\n"
- .' "nodeCount": 1'."\n"
- .' }'."\n"
- .' },'."\n"
- .' "network":'."\n"
- .' {'."\n"
- .' "vSwitchId": "vsw-bp16qw5mbrzx66lv4n0m2",'."\n"
- .' "vpcId": "vpc-bp1956duqqe2lm2lvqjf1",'."\n"
- .' "endpoint": "ha-cn-vkl3rgrfc01.ha.aliyuncs.com"'."\n"
- .' },'."\n"
- .' "tags":'."\n"
- .' ['."\n"
- .' {'."\n"
- .' "value": "rg-acfmv2hk2jpsxia",'."\n"
- .' "key": "acs:rm:rgId"'."\n"
- .' }'."\n"
- .' ],'."\n"
- .' "noQrs": true,'."\n"
- .' "instanceId": "ha-cn-vkl3rgrfc01",'."\n"
- .' "createTime": "2024-05-30 10:50:33.0",'."\n"
- .' "commodityCode": "opensearch_ha3post_public_cn",'."\n"
- .' "resourceGroupId": "rg-acfmv2hk2jpsxia",'."\n"
- .' "newMode": true,'."\n"
- .' "status": "READY"'."\n"
- .' },'."\n"
- .' "requestId": "B916FBC8-DF19-1D12-A72F-61AFFDD871AD"'."\n"
- .' }'."\n"
- ."\n"
- .'**Sample error response**'."\n"
- ."\n"
- .' {'."\n"
- .' "requestId": "BD1EA715-DF6F-06C2-004C-C1FA0D3A9820",'."\n"
- .' "httpCode": 404,'."\n"
- .' "code": "App.NotFound",'."\n"
- .' "message": "App not found"'."\n"
- .' }'."\n",
- ],
- 'ListInstanceSpecs' => [
- 'summary' => 'Queries the specifications of an instance.',
- 'path' => '/openapi/ha3/instances/{instanceId}/specs',
- 'methods' => [
- 'get',
- ],
- 'schemes' => [
- 'https',
- 'http',
- ],
- 'security' => [
- [
- 'AK' => [],
- ],
- ],
- 'operationType' => 'read',
- 'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'get',
- ],
- 'parameters' => [
- [
- 'name' => 'instanceId',
- 'in' => 'path',
- 'schema' => [
- 'description' => 'The instance ID.'."\n",
- 'type' => 'string',
- 'required' => true,
- 'example' => 'ha-cn-2r42ostoc01',
+ 'required' => false,
+ 'example' => '{}',
+ 'title' => '',
],
],
[
- 'name' => 'type',
+ 'name' => 'dryRun',
'in' => 'query',
- 'schema' => [
- 'title' => '节点类型 (qrs: 查询节点, search: 数据节点, index: 索引节点, cluster: 集群)',
- 'description' => 'The node type. Valid values:'."\n"
- ."\n"
- .'* qrs: Query Result Searcher (QRS) Worker'."\n"
- .'* search: Searcher Worker'."\n"
- .'* index: index node'."\n"
- .'* cluster: cluster'."\n",
- 'type' => 'string',
- 'required' => true,
- 'example' => 'search',
- ],
+ 'schema' => ['description' => 'Specifies whether to perform a dry run. A dry run only checks whether the data source is valid. Valid values:'."\n"
+ ."\n"
+ .'- true'."\n"
+ ."\n"
+ .'- false', 'type' => 'boolean', 'required' => false, 'title' => '', 'example' => 'true'],
],
],
'responses' => [
200 => [
'schema' => [
- 'description' => 'The response parameters.'."\n",
+ 'description' => 'The response that is returned.',
'type' => 'object',
'properties' => [
- 'requestId' => [
- 'title' => 'id of request',
- 'description' => 'The request ID.'."\n",
- 'type' => 'string',
- 'example' => '10D5E615-69F7-5F49-B850-00169ADE513C',
- ],
- 'result' => [
- 'title' => 'List',
- 'description' => 'The instance types.'."\n",
- 'type' => 'array',
- 'items' => [
- 'description' => 'A list of instance specifications'."\n",
- 'type' => 'object',
- 'properties' => [
- 'cpu' => [
- 'title' => '单位：核数',
- 'description' => 'The number of vCPUs.'."\n",
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '1',
- ],
- 'mem' => [
- 'title' => '单位G',
- 'description' => 'The memory of the instance. Unit: GB.'."\n",
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '4',
- ],
- 'minDisk' => [
- 'title' => '单数据节点存储空间最小值',
- 'description' => 'The minimum storage of a single data node. Unit: GB.'."\n",
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '100',
- ],
- 'maxDisk' => [
- 'title' => '单数据节点存储空间最大值',
- 'description' => 'The maximum storage of a single data node. Unit: GB.'."\n",
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '600',
- ],
- ],
- ],
- ],
+ 'requestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '407BFD91-DE7D-50BA-8F88-CDE52A3B5E46'],
+ 'result' => ['title' => '', 'description' => 'The result of the request.', 'type' => 'object', 'example' => '{}'],
],
+ 'title' => '',
+ 'example' => '',
],
],
500 => [],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"10D5E615-69F7-5F49-B850-00169ADE513C\\",\\n \\"result\\": [\\n {\\n \\"cpu\\": 1,\\n \\"mem\\": 16,\\n \\"minDisk\\": 100,\\n \\"maxDisk\\": 600\\n }\\n ]\\n}","type":"json"}]',
- 'title' => 'ListInstanceSpecs',
+ 'eventInfo' => [
+ 'enable' => false,
+ 'eventNames' => [],
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"407BFD91-DE7D-50BA-8F88-CDE52A3B5E46\\",\\n \\"result\\": {}\\n}","type":"json"}]',
+ 'title' => 'CreateIndex',
'description' => '### Method'."\n"
."\n"
- .'`GET`'."\n"
+ .'```java'."\n"
+ .'POST'."\n"
+ .'```'."\n"
."\n"
.'### URI'."\n"
."\n"
- .'`/openapi/ha3/instances/{instanceId}/specs?type=qrs`'."\n",
- 'requestParamsDescription' => '### Sample requests'."\n"
+ .'```java'."\n"
+ .'/openapi/ha3/instances/{instanceId}/indexes'."\n"
+ .'```',
+ 'requestParamsDescription' => '### Request example'."\n"
."\n"
- .'`GET /openapi/ha3/instances/ha3_instance_name/specs`'."\n",
- 'responseParamsDescription' => '### Sample responses'."\n"
+ .'```java'."\n"
+ .'POST /openapi/ha3/instances/ose-test1/indexes'."\n"
+ .'```'."\n"
."\n"
+ .'```java'."\n"
+ .'{'."\n"
+ .' "name": "index_1",'."\n"
+ .' "dataSource": "ha-cn-3********0d_index_1",'."\n"
+ .' "content": "",'."\n"
+ .' "extend":'."\n"
.' {'."\n"
- .' "requestId": "e1eef569-1ff7-4bf8-acf7-1cecca9894ce",'."\n"
- .' "result": ['."\n"
+ .' "vector":'."\n"
+ .' ['."\n"
+ .' "source_image_vector"'."\n"
+ .' ],'."\n"
+ .' "embeding":'."\n"
+ .' ['."\n"
+ .' "source_image"'."\n"
+ .' ],'."\n"
+ .' "description":'."\n"
+ .' []'."\n"
+ .' },'."\n"
+ .' "partition": 1,'."\n"
+ .' "dataSourceInfo":'."\n"
+ .' {'."\n"
+ .' "type": "odps",'."\n"
+ .' "processPartitionCount": 2,'."\n"
+ .' "autoBuildIndex": true,'."\n"
+ .' "config":'."\n"
.' {'."\n"
- .' "cpu": 1'."\n"
- .' "mem": 2,'."\n"
- .' "disk": 100'."\n"
+ .' "endpoint": "http://service.cn-hangzhou.maxcompute.aliyun.com/api",'."\n"
+ .' "project": "odps_project",'."\n"
+ .' "accessKey": "ak",'."\n"
+ .' "accessSecret": "as",'."\n"
+ .' "table": "odps_table",'."\n"
+ .' "partition": "ds=*******"'."\n"
.' },'."\n"
- .' {'."\n"
- .' "cpu": 2'."\n"
- .' "mem": 4,'."\n"
- .' "disk": 100 '."\n"
- .' } '."\n"
- .' ]'."\n"
- .' }'."\n",
- ],
- 'GetIndexOnlineStrategy' => [
- 'summary' => 'Queries the online effective policy of an index.',
- 'path' => '/openapi/ha3/instances/{instanceId}/data-sources/{dataSourceName}/deploys/{deployName}/indexes/{indexName}/online-strategy',
- 'methods' => [
- 'get',
- ],
- 'schemes' => [
- 'https',
- 'http',
- ],
- 'security' => [
- [
- 'AK' => [],
+ .' "saroConfig":'."\n"
+ .' {},'."\n"
+ .' "dataTimeSec": 1709715164'."\n"
+ .' }'."\n"
+ .'}'."\n"
+ .'```',
+ 'responseParamsDescription' => '### Response example'."\n"
+ ."\n"
+ .'Successful response'."\n"
+ ."\n"
+ .'```java'."\n"
+ .'{'."\n"
+ .' "requestId": "0A6EB64B-B4C8-CF02-810F-E660812972FF",'."\n"
+ .' "result": {}'."\n"
+ .'}'."\n"
+ .'```'."\n"
+ ."\n"
+ .'For more information, see [Response structure](~~465311~~).',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateIndex'],
],
],
- 'operationType' => 'read',
- 'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'get',
- ],
- 'parameters' => [
+ 'ramActions' => [
[
- 'name' => 'instanceId',
- 'in' => 'path',
- 'schema' => [
- 'description' => 'The instance ID.'."\n",
- 'type' => 'string',
- 'required' => true,
- 'example' => 'ha-cn-7mz2iv7sq01',
- ],
- ],
- [
- 'name' => 'dataSourceName',
- 'in' => 'path',
- 'schema' => [
- 'description' => 'The name of the data source.'."\n",
- 'type' => 'string',
- 'required' => true,
- 'example' => 'ha-cn-0ju2rps6c08_api_test',
- ],
- ],
- [
- 'name' => 'deployName',
- 'in' => 'path',
- 'schema' => [
- 'description' => 'The name of the data center in which the data source is deployed.'."\n",
- 'type' => 'string',
- 'required' => true,
- 'example' => 'vpc_hz_domain_1',
- ],
- ],
- [
- 'name' => 'indexName',
- 'in' => 'path',
- 'schema' => [
- 'description' => 'The index name.'."\n",
- 'type' => 'string',
- 'required' => true,
- 'example' => 'test_api',
- ],
- ],
- ],
- 'responses' => [
- 200 => [
- 'headers' => [],
- 'schema' => [
- 'type' => 'object',
- 'properties' => [
- 'requestId' => [
- 'title' => 'id of request',
- 'description' => 'The request ID.'."\n",
- 'type' => 'string',
- 'example' => 'FE03180A-0E29-5474-8A86-33F0683294A4',
- ],
- 'result' => [
- 'title' => 'IndexOnlineStrategy',
- 'description' => 'The result.'."\n",
- 'type' => 'object',
- 'properties' => [
- 'changeRate' => [
- 'title' => '索引变化率',
- 'description' => 'The index change rate.'."\n",
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '20',
- ],
- ],
- ],
+ 'operationType' => 'create',
+ 'ramAction' => [
+ 'action' => 'searchengine:CreateIndex',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SearchEngine', 'resourceType' => 'Instance', 'arn' => 'acs:searchengine:{#regionId}:{#accountId}:instance/{#InstanceId}'],
],
- 'description' => '',
],
],
- 500 => [],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"FE03180A-0E29-5474-8A86-33F0683294A4\\",\\n \\"result\\": {\\n \\"changeRate\\": 20\\n }\\n}","type":"json"}]',
- 'title' => 'GetIndexOnlineStrategy',
],
- 'ModifyIndexOnlineStrategy' => [
- 'summary' => 'Modifies the online policy of an index.',
- 'path' => '/openapi/ha3/instances/{instanceId}/data-sources/{dataSourceName}/deploys/{deployName}/indexes/{indexName}/online-strategy',
- 'methods' => [
- 'put',
- ],
- 'schemes' => [
- 'https',
- 'http',
- ],
+ 'CreateInstance' => [
+ 'summary' => 'Creates a Wentian engine instance.',
+ 'path' => '/openapi/ha3/instances',
+ 'methods' => ['post'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
@@ -2650,966 +1365,350 @@
],
'operationType' => 'write',
'deprecated' => false,
- 'systemTags' => [],
+ 'systemTags' => [
+ 'operationType' => 'create',
+ 'riskType' => 'none',
+ 'chargeType' => 'paid',
+ 'abilityTreeCode' => '136888',
+ 'abilityTreeNodes' => ['FEATUREopensearchXLGC1X', 'FEATUREopensearchCH6TQD'],
+ 'tenantRelevance' => 'publicInformation',
+ ],
'parameters' => [
[
- 'name' => 'instanceId',
- 'in' => 'path',
- 'schema' => [
- 'description' => 'The instance ID.'."\n",
- 'type' => 'string',
- 'required' => true,
- 'example' => 'ha-cn-0ju2rps6c08',
- ],
- ],
- [
- 'name' => 'dataSourceName',
- 'in' => 'path',
- 'schema' => [
- 'description' => 'The name of the data source.'."\n",
- 'type' => 'string',
- 'required' => true,
- 'example' => 'ha-cn-0ju2rps6c08_api_test',
- ],
- ],
- [
- 'name' => 'deployName',
- 'in' => 'path',
- 'schema' => [
- 'description' => 'The name of the data center in which the data source is deployed.'."\n",
- 'type' => 'string',
- 'required' => true,
- 'example' => 'vpc_hz_domain_1',
- ],
- ],
- [
- 'name' => 'indexName',
- 'in' => 'path',
- 'schema' => [
- 'description' => 'The index name.'."\n",
- 'type' => 'string',
- 'required' => true,
- 'example' => 'test_tusou_v2',
- ],
- ],
- [
'name' => 'body',
'in' => 'body',
'style' => 'json',
'schema' => [
- 'description' => 'The request body.'."\n",
+ 'description' => 'The request struct.',
'type' => 'object',
'properties' => [
- 'changeRate' => [
- 'title' => '索引变化率',
- 'description' => 'The index change rate.'."\n",
- 'type' => 'integer',
- 'format' => 'int32',
+ 'chargeType' => ['description' => 'The billing method of the instance. Valid values: PREPAY: subscription. If you select this billing method, make sure that your account supports balance payment or credit payment. Otherwise, the InvalidPayMethod error is returned. You must also specify the paymentInfo parameter. POSTPAY: pay-as-you-go (currently not supported).', 'type' => 'string', 'required' => false, 'example' => 'PREPAY', 'title' => ''],
+ 'components' => [
+ 'description' => 'The list of specification information related to the instance.',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'The list of specification information related to the instance.',
+ 'type' => 'object',
+ 'properties' => [
+ 'code' => ['description' => 'The specification code, which is consistent with the sales parameters.', 'type' => 'string', 'required' => false, 'example' => 'searcherdocsize', 'title' => ''],
+ 'value' => ['description' => 'The data entered in the control.', 'type' => 'string', 'required' => false, 'example' => '200', 'title' => ''],
+ ],
+ 'required' => false,
+ 'title' => '',
+ 'example' => '',
+ ],
'required' => false,
- 'example' => '20',
- ],
- ],
- 'required' => false,
- ],
- ],
- ],
- 'responses' => [
- 200 => [
- 'headers' => [],
- 'schema' => [
- 'type' => 'object',
- 'properties' => [
- 'requestId' => [
- 'title' => 'id of request',
- 'description' => 'The request ID.'."\n",
- 'type' => 'string',
- 'example' => '10D5E615-69F7-5F49-B850-00169ADE513C',
+ 'title' => '',
+ 'example' => '',
],
- 'result' => [
- 'title' => 'Map',
- 'description' => 'The result.'."\n",
+ 'order' => [
+ 'description' => 'The payment information.',
'type' => 'object',
- 'example' => '{}',
+ 'properties' => [
+ 'autoRenew' => ['description' => 'Specifies whether to enable auto-renewal. Valid values: true and false.', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'title' => ''],
+ 'duration' => ['description' => 'The billing cycle. Valid values: 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, and 12.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '29', 'title' => ''],
+ 'pricingCycle' => ['description' => 'The unit of the billing cycle. Valid values: Month and Year.', 'type' => 'string', 'required' => false, 'example' => 'Month', 'title' => ''],
+ ],
+ 'required' => false,
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'tags' => [
+ 'type' => 'array',
+ 'items' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'key' => ['type' => 'string', 'description' => '', 'required' => false, 'title' => '', 'example' => ''],
+ 'value' => ['type' => 'string', 'description' => '', 'required' => false, 'title' => '', 'example' => ''],
+ ],
+ 'required' => false,
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'required' => false,
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
+ 'resourceGroupId' => ['type' => 'string', 'description' => '', 'required' => false, 'title' => '', 'example' => ''],
],
- 'description' => '',
- ],
- ],
- 500 => [],
- ],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"10D5E615-69F7-5F49-B850-00169ADE513C\\",\\n \\"result\\": {}\\n}","type":"json"}]',
- 'title' => 'ModifyIndexOnlineStrategy',
- ],
- 'ModifyOnlineConfig' => [
- 'path' => '/openapi/ha3/instances/{instanceId}/node/{nodeName}/online-configs/{indexName}',
- 'methods' => [
- 'put',
- ],
- 'schemes' => [
- 'https',
- 'http',
- ],
- 'security' => [
- [
- 'AK' => [],
- ],
- ],
- 'operationType' => 'write',
- 'deprecated' => false,
- 'systemTags' => [],
- 'parameters' => [
- [
- 'name' => 'instanceId',
- 'in' => 'path',
- 'schema' => [
- 'description' => 'The instance ID.'."\n",
- 'type' => 'string',
- 'required' => true,
- 'example' => 'ha-cn-7mz2ougaw02',
- ],
- ],
- [
- 'name' => 'nodeName',
- 'in' => 'path',
- 'schema' => [
- 'description' => 'The node name.'."\n",
- 'type' => 'string',
- 'required' => true,
- 'example' => 'general',
- ],
- ],
- [
- 'name' => 'indexName',
- 'in' => 'path',
- 'schema' => [
- 'description' => 'The index name.'."\n",
- 'type' => 'string',
- 'required' => true,
- 'example' => 'adsfasd',
- ],
- ],
- [
- 'name' => 'body',
- 'in' => 'body',
- 'style' => 'json',
- 'schema' => [
- 'description' => 'The request body.'."\n",
- 'type' => 'object',
'required' => false,
- 'additionalProperties' => [
- 'type' => 'string',
- 'description' => 'The request body.'."\n",
- 'example' => '{}',
- ],
+ 'example' => '{}',
+ 'title' => '',
],
],
],
'responses' => [
200 => [
'schema' => [
+ 'title' => '',
+ 'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
- 'requestId' => [
- 'title' => 'id of request',
- 'description' => 'id of request',
- 'type' => 'string',
- 'example' => '2AE63638-5420-56DC-BF59-37D8174039A0',
- ],
+ 'requestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => 'D39EE0F1-D7EF-5F46-B781-6BF4185308B0'],
'result' => [
- 'title' => 'Map',
- 'description' => 'Map',
+ 'description' => 'The returned result.',
'type' => 'object',
- 'example' => '{}',
+ 'properties' => [
+ 'instanceId' => ['description' => 'The instance ID.', 'type' => 'string', 'example' => 'ha-cn-pl32rf0****', 'title' => ''],
+ ],
+ 'title' => '',
+ 'example' => '',
],
],
+ 'example' => '',
],
],
- 500 => [],
+ '5XX' => [],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"2AE63638-5420-56DC-BF59-37D8174039A0\\",\\n \\"result\\": {}\\n}","type":"json"}]',
- 'title' => 'ModifyOnlineConfig',
- 'summary' => 'Modifies online configurations.',
+ 'title' => 'Create an instance',
'description' => '### Method'."\n"
."\n"
.'```java'."\n"
- .'put'."\n"
+ .'POST'."\n"
.'```'."\n"
."\n"
.'### URI'."\n"
."\n"
.'```java'."\n"
- .'/openapi/ha3/instances/{instanceId}/node/{nodeName}/online-configs/{indexName}'."\n"
- .'```'."\n",
- 'requestParamsDescription' => '### Sample requests'."\n"
+ .'/openapi/ha3/instances'."\n"
+ .'```.',
+ 'responseParamsDescription' => '### Response examples'."\n"
+ .'**Success response example**'."\n"
."\n"
- .''."\n"
- ."\n"
- .'```java'."\n"
- .'PUT /openapi/ha3/instances/ha-test1/node/ihome_searcher/online-configs'."\n"
.'```'."\n"
- ."\n"
- .''."\n"
- ."\n"
- .'```java'."\n"
.'{'."\n"
- .''."\n"
- .' "content": "xxxx",'."\n"
- .''."\n"
- .' "suezAdminName": "xxxx"'."\n"
- .''."\n"
+ .' "requestId": "90D6B8F5-FE97-4509-9AAB-367836C51818",'."\n"
+ .' "result": {'."\n"
+ .' "instanceId": "deeprec-cn-xxxxxx1"'."\n"
+ .' }'."\n"
.'}'."\n"
- .'```'."\n",
- 'responseParamsDescription' => '### [](#)Sample requests'."\n"
- ."\n"
- .'```java'."\n"
- .'PUT /openapi/ha3/instances/ha-test1/node/ihome_searcher/online-configs'."\n"
.'```'."\n"
."\n"
- .'```java'."\n"
+ .'**Error response example**'."\n"
+ ."\n"
+ .'```'."\n"
.'{'."\n"
- .' '."\n"
- .' "content": "xxxx",'."\n"
- .' '."\n"
- .' "suezAdminName": "xxxx"'."\n"
- .' '."\n"
+ .' "requestId": "90D6B8F5-FE97-4509-9AAB-367836C51818",'."\n"
+ .' "code": "InternalServerError",'."\n"
+ .' "message":"internal server error"'."\n"
.'}'."\n"
.'```'."\n"
- ."\n"
- .'For more information, see [Response structure](~~465311~~).'."\n",
- ],
- 'ListOnlineConfigs' => [
- 'path' => '/openapi/ha3/instances/{instanceId}/node/{nodeName}/online-configs',
- 'methods' => [
- 'get',
- ],
- 'schemes' => [
- 'https',
- 'http',
- ],
- 'security' => [
- [
- 'AK' => [],
- ],
- ],
- 'operationType' => 'read',
- 'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'list',
- ],
- 'parameters' => [
- [
- 'name' => 'instanceId',
- 'in' => 'path',
- 'schema' => [
- 'description' => 'The instance ID.'."\n",
- 'type' => 'string',
- 'required' => true,
- 'example' => 'ha-cn-0ju2s170b03',
- ],
- ],
- [
- 'name' => 'nodeName',
- 'in' => 'path',
- 'schema' => [
- 'description' => 'The name of the Query Result Searcher (QRS) worker.'."\n",
- 'type' => 'string',
- 'required' => true,
- 'example' => 'ha-cn-2r42ostoc01_qrs',
- ],
- ],
- [
- 'name' => 'domain',
- 'in' => 'query',
- 'schema' => [
- 'description' => 'The name of the domain'."\n",
- 'type' => 'string',
- 'required' => true,
- 'example' => 'sz_vpc_domain_1',
- ],
- ],
- ],
- 'responses' => [
- 200 => [
- 'schema' => [
- 'type' => 'object',
- 'properties' => [
- 'requestId' => [
- 'title' => 'id of request',
- 'description' => 'id of request'."\n",
- 'type' => 'string',
- 'example' => 'E45380E8-994A-5402-9806-F114B3295FCF',
- ],
- 'result' => [
- 'title' => 'List',
- 'description' => 'List'."\n",
- 'type' => 'array',
- 'items' => [
- 'description' => 'The list of configuration results'."\n",
- 'type' => 'object',
- 'properties' => [
- 'indexName' => [
- 'description' => 'The name of the index'."\n",
- 'type' => 'string',
- 'example' => 'generation',
- ],
- 'config' => [
- 'description' => 'The configuration information'."\n",
- 'type' => 'string',
- 'example' => '{\\"specItems\\":[{\\"specKey\\":\\"YQ_KEYWORD_NUMBER_PLUS\\",\\"value\\":\\"1\\"}]}',
- ],
- ],
- ],
- ],
+ .'For more information, see [Response struct](~~465311~~).',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '3', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateInstance'],
+ ],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'create',
+ 'ramAction' => [
+ 'action' => 'searchengine:CreateInstance',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SearchEngine', 'resourceType' => 'Instance', 'arn' => 'acs:searchengine:{#regionId}:{#accountId}:instance/*'],
],
- 'description' => '',
],
],
- 500 => [],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"E45380E8-994A-5402-9806-F114B3295FCF\\",\\n \\"result\\": [\\n {\\n \\"indexName\\": \\"generation\\",\\n \\"config\\": \\"{\\\\\\\\\\\\\\"specItems\\\\\\\\\\\\\\":[{\\\\\\\\\\\\\\"specKey\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"YQ_KEYWORD_NUMBER_PLUS\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"value\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"1\\\\\\\\\\\\\\"}]}\\"\\n }\\n ]\\n}","type":"json"}]',
- 'title' => 'ListOnlineConfigs',
- 'summary' => 'Queries the details of an online configuration.',
- 'description' => '### Method'."\n"
- ."\n"
- .'```java'."\n"
- .'GET'."\n"
- .'```'."\n"
- ."\n"
- .'### URI'."\n"
- ."\n"
- .'```java'."\n"
- .'/openapi/ha3/instances/{instanceId}/node/{nodeName}/online-configs?domain={domain}'."\n"
- .'```'."\n",
- 'requestParamsDescription' => '\\### Sample requests'."\n"
- ."\n"
- .'```java'."\n"
- .'GET /openapi/ha3/instances/ha-test1/node/ihome_searcher/online-configs?domain=pre_ea120'."\n"
- .'```'."\n",
- 'responseParamsDescription' => '### Sample responses'."\n"
- ."\n"
- .'Success responses '."\n"
- ."\n"
- .'```java'."\n"
- .'{'."\n"
- .''."\n"
- .' "requestId": "e1eef569-1ff7-4bf8-acf7-1cecca9894ce",'."\n"
- .''."\n"
- .' "result": ['."\n"
- .''."\n"
- .' {'."\n"
- .''."\n"
- .' "indexName": "nm_algo_dense_weights",'."\n"
- .''."\n"
- .' "config": "{\\"realtime\\":false,\\"cluster_config\\":{\\"table_name\\":\\"nm_algo_dense_weights\\"},\\"online_index_config\\":{\\"online_keep_version_count\\":3,\\"build_config\\":{\\"build_total_memory\\":1024},\\"max_realtime_memory_use\\":1024,\\"load_config\\":[{\\"file_patterns\\":[\\".*\\"],\\"load_strategy\\":\\"mmap\\",\\"load_strategy_param\\":{\\"slice\\":409600,\\"lock\\":true,\\"interval\\":2}},{\\"file_patterns\\":[\\".*\\"],\\"load_strategy\\":\\"mmap\\",\\"load_strategy_param\\":{\\"slice\\":409600,\\"lock\\":true,\\"interval\\":2}},{\\"file_patterns\\":[\\"/summary/data\\"],\\"load_strategy\\":\\"cache\\",\\"load_strategy_param\\":{\\"direct_io\\":true,\\"cache_size\\":512}},{\\"warmup_strategy\\":\\"none\\",\\"file_patterns\\":[\\".*\\"],\\"load_strategy\\":\\"mmap\\",\\"load_strategy_param\\":{\\"lock\\":false}}]},\\"build_option_config\\":{\\"async_queue_size\\":1000,\\"max_recover_time\\":10,\\"async_build\\":true}}"'."\n"
- .''."\n"
- .' },'."\n"
- .''."\n"
- .' {'."\n"
- .''."\n"
- .' "indexName": "search4_mj_mos_item_index",'."\n"
- .''."\n"
- .' "config": "{\\"realtime\\":true,\\"cluster_config\\":{\\"table_name\\":\\"search4_mj_mos_item_index\\"},\\"online_index_config\\":{\\"online_keep_version_count\\":3,\\"build_config\\":{\\"build_total_memory\\":4096},\\"max_realtime_memory_use\\":8192,\\"load_config\\":[{\\"warmup_strategy\\":\\"sequential\\",\\"file_patterns\\":[\\"_INDEX_\\"],\\"load_strategy\\":\\"mmap\\",\\"name\\":\\"_INDEX_\\",\\"load_strategy_param\\":{\\"lock\\":true}},{\\"warmup_strategy\\":\\"none\\",\\"file_patterns\\":[\\"_SUMMARY_\\"],\\"load_strategy\\":\\"mmap\\",\\"name\\":\\"_SUMMARY_\\",\\"load_strategy_param\\":{\\"lock\\":true}},{\\"warmup_strategy\\":\\"sequential\\",\\"file_patterns\\":[\\"_ATTRIBUTE_\\"],\\"load_strategy\\":\\"mmap\\",\\"name\\":\\"_ATTRIBUTE_\\",\\"load_strategy_param\\":{\\"lock\\":true}}],\\"speedup_primary_key_reader\\":true},\\"build_option_config\\":{\\"async_queue_size\\":10000,\\"max_recover_time\\":10,\\"async_build\\":true}}"'."\n"
- .''."\n"
- .' },'."\n"
- .''."\n"
- .' {'."\n"
- .''."\n"
- .' "indexName": "nm_algo_search_retrieval_item_index",'."\n"
- .''."\n"
- .' "config": "{\\"realtime\\":true,\\"cluster_config\\":{\\"table_name\\":\\"nm_algo_search_retrieval_item_index\\"},\\"online_index_config\\":{\\"online_keep_version_count\\":3,\\"build_config\\":{\\"build_total_memory\\":4096},\\"max_realtime_memory_use\\":8192,\\"load_config\\":[{\\"warmup_strategy\\":\\"sequential\\",\\"file_patterns\\":[\\"_INDEX_\\"],\\"load_strategy\\":\\"mmap\\",\\"name\\":\\"_INDEX_\\",\\"load_strategy_param\\":{\\"lock\\":true}},{\\"warmup_strategy\\":\\"none\\",\\"file_patterns\\":[\\"_SUMMARY_\\"],\\"load_strategy\\":\\"mmap\\",\\"name\\":\\"_SUMMARY_\\",\\"load_strategy_param\\":{\\"lock\\":true}},{\\"warmup_strategy\\":\\"sequential\\",\\"file_patterns\\":[\\"_ATTRIBUTE_\\"],\\"load_strategy\\":\\"mmap\\",\\"name\\":\\"_ATTRIBUTE_\\",\\"load_strategy_param\\":{\\"lock\\":true}}],\\"speedup_primary_key_reader\\":true},\\"build_option_config\\":{\\"async_queue_size\\":10000,\\"max_recover_time\\":10,\\"async_build\\":true}}"'."\n"
- .''."\n"
- .' } '."\n"
- .''."\n"
- .' ]'."\n"
- .''."\n"
- .'}'."\n"
- .'```'."\n",
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"D39EE0F1-D7EF-5F46-B781-6BF4185308B0\\",\\n \\"result\\": {\\n \\"instanceId\\": \\"ha-cn-pl32rf0****\\"\\n }\\n}","type":"json"}]',
],
- 'ModifyIndex' => [
- 'summary' => '编辑索引表',
- 'path' => '/openapi/ha3/instances/{instanceId}/indexes/{indexName}',
- 'methods' => [
- 'put',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
+ 'CreateModel' => [
+ 'summary' => 'Creates a model.',
+ 'path' => '/openapi/ha3/instances/{instanceId}/models',
+ 'methods' => ['post'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
- 'operationType' => 'readAndWrite',
+ 'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
- 'operationType' => 'update',
+ 'operationType' => 'create',
'riskType' => 'none',
'chargeType' => 'free',
- 'abilityTreeCode' => '186780',
- 'abilityTreeNodes' => [
- 'FEATUREopensearchVHEWK3',
- ],
+ 'abilityTreeNodes' => ['FEATUREopensearchGTRUN8'],
],
'parameters' => [
[
'name' => 'instanceId',
'in' => 'path',
- 'schema' => [
- 'description' => 'The instance ID.'."\n",
- 'type' => 'string',
- 'required' => true,
- 'example' => 'ha-cn-0ju2rq6610a',
- ],
- ],
- [
- 'name' => 'indexName',
- 'in' => 'path',
- 'schema' => [
- 'description' => 'The index name.'."\n",
- 'type' => 'string',
- 'required' => true,
- 'example' => 'test_api',
- ],
+ 'schema' => ['title' => '', 'description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'example' => 'ha-cn-pl32rf0****'],
],
[
'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',
- 'default' => 'false',
- ],
+ 'schema' => ['title' => '', 'description' => 'Specifies whether to perform only a dry run. The default value is false.', 'type' => 'string', 'required' => false, 'example' => 'true'],
],
[
'name' => 'body',
'in' => 'body',
'style' => 'json',
'schema' => [
- 'description' => 'The request body.'."\n",
+ 'description' => 'The request body.',
'type' => 'object',
'properties' => [
- 'dataSourceInfo' => [
- 'description' => 'The information about the data source, which is required for the new version of OpenSearch Vector Search Edition.'."\n",
+ 'name' => ['description' => 'The model name.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'test'],
+ 'content' => [
+ 'description' => 'The model details.',
'type' => 'object',
'properties' => [
- 'buildMode' => [
- 'title' => '索引重建方式 (api: API方式推送数据源, indexRecover: 从索引中恢复数据源)',
- 'description' => 'The reindexing method. Valid values: api: API data source. indexRecover: data recovery by using indexing.'."\n",
- 'type' => 'string',
- 'required' => false,
- 'example' => 'api',
- ],
- 'generation' => [
- 'title' => '从索引中恢复数据源，dump表的generation',
- 'description' => 'The ID of the index version from which data is restored.'."\n",
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => false,
- 'example' => '4',
- ],
- 'dataTimeSec' => [
- 'title' => '追增量时间戳',
- 'description' => 'The start timestamp from which incremental data is retrieved.'."\n",
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'example' => '1709715164',
- ],
- 'processPartitionCount' => [
- 'title' => '数据更新资源数',
- 'description' => 'The number of resources used for data update.'."\n",
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'example' => '4',
- ],
- 'name' => [
- 'title' => '数据源名',
- 'description' => 'The name of the data source.'."\n",
- 'type' => 'string',
- 'required' => false,
- 'example' => 'ha-cn-35t3n1yuj0d_index_1',
- ],
- 'type' => [
- 'title' => '数据源类型 (odps, swift, saro, oss, unKnow)',
- 'description' => 'The type of the data source. Valid values: odps, swift, saro, oss, and unKnow.'."\n",
- 'type' => 'string',
- 'required' => false,
- 'example' => 'odps',
- ],
- 'domain' => [
- 'title' => '离线部署',
- 'description' => 'The offline deployment name of the data source.'."\n",
- 'type' => 'string',
- 'required' => false,
- 'example' => 'vpc_hz_domain_1'."\n",
- ],
- 'config' => [
- 'title' => 'odps 数据源配置',
- 'description' => 'The configurations of the MaxCompute data source.'."\n",
- 'type' => 'object',
- 'properties' => [
- 'endpoint' => [
- 'title' => 'odps相关',
- 'description' => 'The endpoint of the MaxCompute data source.'."\n",
- 'type' => 'string',
- 'required' => false,
- 'example' => 'http://service.cn-hangzhou.maxcompute.aliyun-inc.com/api',
- ],
- 'accessKey' => [
- 'description' => 'The AccessKey ID of the MaxCompute data source.'."\n",
- 'type' => 'string',
- 'required' => false,
- 'example' => 'L***p',
- ],
- 'accessSecret' => [
- 'description' => 'The AccessKey secret of the MaxCompute data source.'."\n",
- 'type' => 'string',
- 'required' => false,
- 'example' => '5**9a6',
- ],
- 'project' => [
- 'description' => 'The name of the MaxCompute project that is used as the data source.'."\n",
- 'type' => 'string',
- 'required' => false,
- 'example' => 'bbt_algo_pai',
- ],
- 'partition' => [
- 'description' => 'The partition in the MaxCompute table. Example: ds=20180102.'."\n",
- 'type' => 'string',
- 'required' => false,
- 'example' => 'ds=20230114',
- ],
- 'table' => [
- 'title' => 'saro、odps相关',
- 'description' => 'The name of the MaxCompute table that is used as the data source.'."\n",
- 'type' => 'string',
- 'required' => false,
- 'example' => 'item',
- ],
- 'namespace' => [
- 'title' => 'saro相关',
- 'description' => 'The namespace. This parameter is applicable to the SARO data source used in the intranet of Alibaba Group.'."\n",
- 'type' => 'string',
- 'required' => false,
- 'example' => 'test-namespace',
- ],
- 'path' => [
- 'title' => 'hdfs相关',
- 'description' => 'The file path in the Apsara File Storage for HDFS file system.'."\n",
- 'type' => 'string',
- 'required' => false,
- 'example' => 'test-hdfs-path',
- ],
- 'ossPath' => [
- 'title' => 'oss数据源相关',
- 'description' => 'The Object Storage Service (OSS) path.'."\n",
- 'type' => 'string',
- 'required' => false,
- 'example' => '/opensearch/oss.json',
- ],
- 'bucket' => [
- 'description' => 'The name of the OSS bucket.'."\n",
- 'type' => 'string',
- 'required' => false,
- 'example' => 'test-bucket',
- ],
- 'format' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'ha3',
- ],
- 'catalog' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'test-catalog',
- ],
- 'database' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'test-database',
- ],
- 'tag' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'test-tag',
- ],
- 'tableFormat' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'paimon'."\n"
- .'lance'."\n"
- .'object',
- ],
- ],
- 'required' => false,
- ],
- 'saroConfig' => [
- 'title' => 'saro数据源配置',
- 'description' => 'The configurations of the SARO data source.'."\n",
+ 'modelType' => ['description' => 'The model type.'."\n"
+ ."\n"
+ .'- a. Text embedding: text\\_embedding'."\n"
+ ."\n"
+ .'- b. Text sparse embedding: text\\_sparse\\_embedding'."\n"
+ ."\n"
+ .'- c. Image embedding: image\\_embedding'."\n"
+ ."\n"
+ .'- d. Image content analysis: image\\_analyze', 'type' => 'string', 'required' => false, 'title' => '', 'example' => 'text_embedding'],
+ 'dimension' => ['title' => '', 'description' => 'The dimension of the model. This parameter is required if \\`modelType\\` is \\`text\\_embedding\\` or \\`image\\_embedding\\`.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '128'],
+ 'url' => ['description' => 'The endpoint of the model service.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => 'http://***.platform-cn-shanghai.opensearch.aliyuncs.com/v3/openapi/workspaces/default/text-embedding/ops-text-embedding-001'],
+ 'method' => ['description' => 'The HTTP method to access the model service. Supported methods: PUT and POST.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => 'POST'],
+ 'request' => [
+ 'description' => 'The model request body.',
'type' => 'object',
'properties' => [
- 'namespace' => [
- 'description' => 'The namespace to which the SARO data source belongs.'."\n",
- 'type' => 'string',
+ 'header' => [
+ 'description' => 'The HTTP header for accessing the model service.',
+ 'type' => 'object',
+ 'properties' => [
+ 'Authorization' => ['description' => 'The authentication information. Format: Bearer access\\_token', 'type' => 'string', 'required' => false, 'title' => '', 'example' => 'Bearer OS-v0********6vvs'],
+ 'Content-Type' => ['description' => 'The content type of the HTTP request.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => 'application/json'],
+ ],
'required' => false,
- 'example' => 'flink-test-fjx-default',
+ 'title' => '',
+ 'example' => '',
],
- 'tableName' => [
- 'description' => 'The name of the SARO table.'."\n",
- 'type' => 'string',
+ 'urlParams' => [
+ 'description' => 'The parameters in the URL. Some model services require that parameters are passed in the URL.',
+ 'type' => 'object',
+ 'properties' => [
+ 'build' => ['description' => 'The parameters passed during index building.', 'type' => 'object', 'required' => false, 'title' => '', 'example' => 'key: value'],
+ 'search' => ['description' => 'The parameters passed during a query.', 'type' => 'object', 'required' => false, 'title' => '', 'example' => 'key: value'],
+ ],
'required' => false,
- 'example' => 'device_event_shy_summary_',
- ],
- ],
- 'required' => false,
- ],
- 'autoBuildIndex' => [
- 'title' => '是否开启自动全量',
- 'description' => 'Specifies whether to enable the automatic full indexing feature.'."\n",
- 'type' => 'boolean',
- 'required' => false,
- 'example' => 'true',
- ],
- 'processParallelNum' => [
- 'description' => 'The maximum number of full indexes that can be concurrently processed.'."\n",
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'example' => '2',
- ],
- 'partition' => [
- 'title' => 'odps数据源进行索引重建选择的数据分区',
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'ds=20230114',
- ],
- 'ossDataPath' => [
- 'title' => 'oss数据源进行索引重建时选择的文件地址',
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => '/opensearch/oss.json',
- ],
- ],
- 'required' => false,
- ],
- 'description' => [
- 'description' => 'The description of the data source.'."\n",
- 'type' => 'string',
- 'required' => false,
- 'example' => 'test',
- ],
- 'content' => [
- 'title' => '文件内容',
- 'description' => 'The file content.'."\n",
- 'type' => 'string',
- 'required' => false,
- 'example' => '{\\"summarys\\":{\\"summary_fields\\":[\\"id\\"]},\\"indexs\\":[{\\"index_name\\":\\"index_id\\",\\"index_type\\":\\"PRIMARYKEY64\\",\\"index_fields\\":\\"id\\",\\"has_primary_key_attribute\\":true,\\"is_primary_key_sorted\\":false}],\\"attributes\\":[\\"id\\"],\\"fields\\":[{\\"field_name\\":\\"id\\",\\"field_type\\":\\"UINT16\\"}],\\"table_name\\":\\"index_2\\"}',
- ],
- 'partition' => [
- 'title' => '数据分片',
- 'description' => 'The number of shards.'."\n",
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'example' => '2',
- ],
- 'dataSource' => [
- 'title' => '数据源',
- 'description' => 'The name of the data source.'."\n",
- 'type' => 'string',
- 'required' => false,
- 'example' => 'ha-cn-35t3n1yuj0d_index_1',
- ],
- 'domain' => [
- 'title' => '数据源部署',
- 'description' => 'The name of the data center in which the data source is deployed.'."\n",
- 'type' => 'string',
- 'required' => false,
- 'example' => 'vpc_hz_domain_1',
- ],
- 'buildParallelNum' => [
- 'description' => 'The maximum number of full indexes that can be concurrently built.'."\n",
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'example' => '2',
- ],
- 'mergeParallelNum' => [
- 'description' => 'The maximum number of full indexes that can be concurrently merged.'."\n",
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'example' => '2',
- ],
- 'cluster' => [
- 'description' => 'The cluster information.'."\n",
- 'type' => 'object',
- 'required' => false,
- 'additionalProperties' => [
- 'type' => 'object',
- 'additionalProperties' => [
- 'type' => 'object',
- 'properties' => [
- 'value' => [
- 'type' => 'string',
- 'description' => 'The variable.'."\n",
- 'example' => 'partition',
- ],
- 'description' => [
- 'type' => 'string',
- 'description' => 'The description of the variable.'."\n",
- 'example' => 'test',
- ],
- 'disableModify' => [
- 'type' => 'boolean',
- 'example' => 'true',
- 'description' => 'Specifies whether the variable is not allowed to be modified.'."\n",
- ],
- 'isModify' => [
- 'type' => 'boolean',
- 'example' => 'false',
- 'description' => 'Specifies whether the variable is modified.'."\n",
- ],
- 'type' => [
- 'type' => 'string',
- 'example' => 'NORMAL',
- 'description' => 'The variable type. Valid values: NORMAL: common variable. FUNCTION: function variable.'."\n",
+ 'title' => '',
+ 'example' => '',
],
- ],
- 'description' => 'The content to be modified in the configuration file.'."\n",
- ],
- 'description' => 'The cluster information.'."\n",
- ],
- ],
- 'clusterConfigName' => [
- 'description' => 'The name of the configuration file.'."\n",
- 'type' => 'string',
- 'required' => false,
- 'example' => 'ha-cn-35t3r02iq03@ha-cn-35t3r02iq03_test_api@hz_pre_vpc_domain_1@test_api@index_config_v1',
- ],
- 'config' => [
- 'description' => 'The information about the offline configuration.'."\n",
- 'type' => 'object',
- 'required' => false,
- 'additionalProperties' => [
- 'type' => 'object',
- 'properties' => [
- 'desc' => [
- 'type' => 'string',
- 'required' => false,
- 'example' => 'test',
- 'description' => 'The description of the offline configuration.'."\n",
- ],
- 'files' => [
- 'type' => 'array',
- 'items' => [
+ 'parameters' => [
+ 'description' => 'If the parameters in the request body are different for the build and search phases, define them in this parameter.',
'type' => 'object',
'properties' => [
- 'operateType' => [
- 'type' => 'string',
- 'required' => false,
- 'example' => 'UPDATE',
- 'description' => 'The operation type. Valid values: UPDATE and DELETE. Default value: UPDATE.'."\n",
- ],
- 'parentFullPath' => [
- 'type' => 'string',
- 'required' => false,
- 'example' => '/',
- 'description' => 'The path of the parent directory.'."\n",
- ],
- 'fileName' => [
- 'type' => 'string',
- 'required' => false,
- 'description' => 'The file name.'."\n",
- 'example' => '/intervene_dict/example.dict',
- ],
- 'config' => [
+ 'build' => [
+ 'description' => 'The parameters for the index building phase.',
'type' => 'object',
'properties' => [
- 'content' => [
- 'type' => 'string',
- 'required' => false,
- 'example' => '$dictContent',
- 'description' => 'The file content.'."\n",
- ],
- 'variables' => [
- 'type' => 'object',
- 'required' => false,
- 'additionalProperties' => [
- 'type' => 'object',
- 'properties' => [
- 'description' => [
- 'type' => 'string',
- 'required' => false,
- 'example' => 'test',
- 'description' => 'The description of the variable.'."\n",
- ],
- 'disableModify' => [
- 'type' => 'boolean',
- 'required' => false,
- 'description' => 'Specifies whether the variable is not allowed to be modified.'."\n",
- 'example' => 'true',
- ],
- 'isModify' => [
- 'type' => 'boolean',
- 'required' => false,
- 'example' => 'false',
- 'description' => 'Specifies whether the variable is modified.'."\n",
- ],
- 'type' => [
- 'type' => 'string',
- 'required' => false,
- 'example' => 'NORMAL',
- 'description' => 'The variable type. Valid values: NORMAL: common variable. FUNCTION: function variable.'."\n",
- ],
- 'value' => [
- 'type' => 'string',
- 'required' => false,
- 'example' => 'test',
- 'description' => 'The variable value.'."\n",
- ],
- ],
- 'description' => 'The variable information.'."\n",
- ],
- 'description' => 'The variables.'."\n",
- ],
+ 'input_type' => ['description' => 'The input type.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => 'query'],
],
'required' => false,
- 'description' => 'The configuration to be modified.'."\n",
+ 'title' => '',
+ 'example' => '',
],
- 'dirName' => [
- 'type' => 'string',
+ 'search' => [
+ 'description' => 'The parameters for the query phase.',
+ 'type' => 'object',
+ 'properties' => [
+ 'input_type' => ['description' => 'The input type.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => 'document'],
+ ],
'required' => false,
- 'description' => 'The directory name.'."\n",
- 'example' => '/test',
+ 'title' => '',
+ 'example' => '',
],
],
'required' => false,
+ 'title' => '',
+ 'example' => '',
],
- 'required' => false,
- 'description' => 'The files to be modified.'."\n",
+ 'requestBody' => ['description' => 'The template string for the request body.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => '{\\"input\\": [\\"%{input}\\"], \\"input_type\\": \\"%{input_type}\\"}'],
+ ],
+ 'required' => false,
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'response' => [
+ 'description' => 'The configuration for parsing the response. Use JSONPath format.',
+ 'type' => 'object',
+ 'properties' => [
+ 'embeddings' => ['description' => 'The JSONPath expression to extract embeddings from the response.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => '$.result.embeddings[*].embedding'],
],
+ 'required' => false,
+ 'title' => '',
+ 'example' => '',
],
- 'description' => 'The offline configuration.'."\n",
],
- ],
- 'pushMode' => [
- 'description' => 'The push mode of the configuration. By default, only the configuration is pushed.'."\n",
- 'type' => 'string',
'required' => false,
- 'example' => 'PUSH_ONLY',
- ],
- 'extend' => [
- 'description' => '',
- 'type' => 'object',
- 'required' => false,
- 'example' => '{'."\n"
- .' "vector":'."\n"
- .' ['."\n"
- .' "source_image_vector"'."\n"
- .' ],'."\n"
- .' "embeding":'."\n"
- .' ['."\n"
- .' "source_image"'."\n"
- .' ],'."\n"
- .' "description":'."\n"
- .' []'."\n"
- .' }',
+ 'title' => '',
+ 'example' => '',
],
],
'required' => false,
+ 'title' => '',
+ 'example' => '',
],
],
],
'responses' => [
200 => [
'schema' => [
+ 'title' => '',
+ 'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
- 'requestId' => [
- 'title' => 'id of request',
- 'description' => 'The request ID.'."\n",
- 'type' => 'string',
- 'example' => '93A9E542-8CF8-5BA6-99AB-94C0FE520429',
- ],
- 'result' => [
- 'title' => 'Object',
- 'description' => 'The result.'."\n",
- 'type' => 'any',
- 'example' => '{}',
- ],
+ 'requestId' => ['title' => '', 'description' => 'Id of the request', 'type' => 'string', 'example' => '022F36C7-9FB4-5D67-BEBC-3D14B0984463'],
],
- 'description' => '',
+ 'example' => '',
],
],
- 500 => [],
],
- 'eventInfo' => [
- 'enable' => false,
- 'eventNames' => [],
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"022F36C7-9FB4-5D67-BEBC-3D14B0984463\\"\\n}","type":"json"}]',
+ 'title' => 'CreateModel',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'create',
+ 'ramAction' => [
+ 'action' => 'searchengine:CreateModel',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SearchEngine', 'resourceType' => 'Instance', 'arn' => 'acs:searchengine:{#regionId}:{#accountId}:instance/{#InstanceId}'],
+ ],
+ ],
+ ],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"93A9E542-8CF8-5BA6-99AB-94C0FE520429\\",\\n \\"result\\": \\"{}\\"\\n}","type":"json"}]',
- 'title' => 'ModifyIndex',
],
- 'StartIndex' => [
- 'path' => '/openapi/ha3/instances/{instanceId}/indexes/{indexName}/startIndex',
- 'methods' => [
- 'post',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
+ 'CreatePublicUrl' => [
+ 'path' => '/openapi/ha3/instances/{instanceId}/public-url',
+ 'methods' => ['post'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
- 'operationType' => 'read',
+ 'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
- 'operationType' => 'update',
- 'abilityTreeCode' => '187010',
- 'abilityTreeNodes' => [
- 'FEATUREopensearchJ3PXKB',
- ],
+ 'operationType' => 'create',
+ 'abilityTreeCode' => '171289',
+ 'abilityTreeNodes' => ['FEATUREopensearch0AT3OG', 'FEATUREopensearchJB31XH'],
],
'parameters' => [
[
'name' => 'instanceId',
'in' => 'path',
- 'schema' => [
- 'description' => 'The instance ID.'."\n",
- 'type' => 'string',
- 'required' => true,
- 'example' => 'ha-cn-7e22rgfyb01',
- ],
- ],
- [
- 'name' => 'indexName',
- 'in' => 'path',
- 'schema' => [
- 'description' => 'The index name.'."\n",
- 'type' => 'string',
- 'required' => true,
- 'example' => 'table_se_index',
- ],
+ 'schema' => ['description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'example' => 'ha-cn-pl32rf0****', 'title' => ''],
],
],
'responses' => [
@@ -3617,420 +1716,363 @@
'schema' => [
'type' => 'object',
'properties' => [
- 'requestId' => [
- 'title' => 'id of request',
- 'description' => 'The request ID.'."\n",
- 'type' => 'string',
- 'example' => 'D39EE0F1-D7EF-5F46-B781-6BF4185308B0',
- ],
- 'result' => [
- 'title' => 'Map',
- 'description' => 'The index map.'."\n",
- 'type' => 'object',
- 'example' => '{}',
- ],
+ 'requestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '022F36C7-9FB4-5D67-BEBC-3D14B0984463'],
+ 'result' => ['title' => '', 'description' => 'The returned result.', 'type' => 'object', 'example' => '{}'],
],
'description' => '',
+ 'title' => '',
+ 'example' => '',
],
],
500 => [],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"D39EE0F1-D7EF-5F46-B781-6BF4185308B0\\",\\n \\"result\\": {}\\n}","type":"json"}]',
- 'title' => 'StartIndex',
- ],
- 'StopIndex' => [
- 'path' => '/openapi/ha3/instances/{instanceId}/indexes/{indexName}/stopIndex',
- 'methods' => [
- 'post',
- ],
- 'schemes' => [
- 'http',
- 'https',
+ 'title' => 'Enable public domain name',
+ 'summary' => 'Enables the public domain name.',
+ 'description' => '### Method'."\n"
+ ."\n"
+ .'```java'."\n"
+ .'POST'."\n"
+ .'```'."\n"
+ ."\n"
+ .'### URI'."\n"
+ ."\n"
+ .'```java'."\n"
+ .'/openapi/ha3/instances/{instanceId}/public-url'."\n"
+ .'```.',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreatePublicUrl'],
+ ],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'create',
+ 'ramAction' => [
+ 'action' => 'searchengine:CreatePublicUrl',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SearchEngine', 'resourceType' => 'Instance', 'arn' => 'acs:searchengine:{#regionId}:{#accountId}:instance/{#InstanceId}'],
+ ],
+ ],
+ ],
],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"022F36C7-9FB4-5D67-BEBC-3D14B0984463\\",\\n \\"result\\": {}\\n}","type":"json"}]',
+ ],
+ 'CreateSqlInstance' => [
+ 'path' => '/openapi/ha3/instances/{instanceId}/sql-studio/databases/{database}/sql-instances',
+ 'methods' => ['post'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
- 'operationType' => 'read',
+ 'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
- 'operationType' => 'update',
- 'abilityTreeCode' => '187011',
- 'abilityTreeNodes' => [
- 'FEATUREopensearchJ3PXKB',
- ],
+ 'operationType' => 'create',
+ 'abilityTreeCode' => '139624',
+ 'abilityTreeNodes' => ['FEATUREopensearch95VJR4'],
],
'parameters' => [
[
'name' => 'instanceId',
'in' => 'path',
- 'schema' => [
- 'description' => 'The instance ID.'."\n",
- 'type' => 'string',
- 'required' => true,
- 'example' => 'ha-cn-0ju2rps6c08',
- ],
+ 'schema' => ['description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'example' => 'ha-cn-pl32rf0****', 'title' => ''],
],
[
- 'name' => 'indexName',
+ 'name' => 'database',
'in' => 'path',
+ 'schema' => ['description' => 'The database name.', 'type' => 'string', 'required' => true, 'example' => 'general', 'title' => ''],
+ ],
+ [
+ 'name' => 'body',
+ 'in' => 'body',
+ 'style' => 'json',
'schema' => [
- 'description' => 'The index name.'."\n",
- 'type' => 'string',
- 'required' => true,
- 'example' => 'test_api',
+ 'description' => 'The request body parameters.',
+ 'type' => 'object',
+ 'properties' => [
+ 'name' => ['description' => 'The SQL instance name.', 'type' => 'string', 'required' => true, 'example' => 'test', 'title' => ''],
+ 'parent' => ['description' => 'The unique identifier of the parent work item.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '-1', 'title' => ''],
+ ],
+ 'required' => false,
+ 'title' => '',
+ 'example' => '',
],
],
],
'responses' => [
200 => [
+ 'headers' => [],
'schema' => [
'type' => 'object',
'properties' => [
- 'requestId' => [
- 'title' => 'id of request',
- 'description' => 'The request ID.'."\n",
- 'type' => 'string',
- 'example' => 'E7B7D598-B080-5C8E-AA35-D43EC0D5F886',
- ],
+ 'requestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => 'B43CD1BB-ABD7-59C5-B89A-6E5F6FE60A84'],
'result' => [
- 'title' => 'Map',
- 'description' => 'The index map.'."\n",
+ 'title' => '',
+ 'description' => 'The returned result.',
'type' => 'object',
- 'example' => '{}',
+ 'properties' => [
+ 'id' => ['description' => 'The primary key ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '22', 'title' => ''],
+ 'gmtCreate' => ['description' => 'The creation time.', 'type' => 'string', 'example' => '1719220182844', 'title' => ''],
+ 'gmtModified' => ['description' => 'The modification time.', 'type' => 'string', 'example' => '1719220182844', 'title' => ''],
+ 'name' => ['description' => 'The SQL instance name.', 'type' => 'string', 'example' => 'test', 'title' => ''],
+ 'parent' => ['description' => 'The parent task ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '-1', 'title' => ''],
+ 'isDir' => ['description' => 'Indicates whether the item is a directory. Valid values:'."\n"
+ .'- true: The item is a directory.'."\n"
+ .'- false: The item is not a directory.', 'type' => 'integer', 'format' => 'int32', 'example' => 'true', 'title' => ''],
+ 'type' => ['title' => '', 'description' => 'table, instance, template, function', 'type' => 'string', 'example' => 'instance'],
+ 'instanceId' => ['description' => 'The instance ID.', 'type' => 'integer', 'format' => 'int64', 'example' => 'ha-cn-pl32rf0****', 'title' => ''],
+ 'templateId' => ['description' => 'The ID of the template to which the instance belongs.', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => ''],
+ ],
+ 'example' => '',
],
],
'description' => '',
+ 'title' => '',
+ 'example' => '',
],
],
500 => [],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"E7B7D598-B080-5C8E-AA35-D43EC0D5F886\\",\\n \\"result\\": {}\\n}","type":"json"}]',
- 'title' => 'StopIndex',
- ],
- 'CreateIndex' => [
- 'summary' => 'Creates an index.',
- 'path' => '/openapi/ha3/instances/{instanceId}/indexes',
- 'methods' => [
- 'post',
- ],
- 'schemes' => [
- 'http',
- 'https',
+ 'title' => 'Create an SQL instance',
+ 'summary' => 'Creates an SQL instance.',
+ 'description' => '### Method'."\n"
+ ."\n"
+ .'```java'."\n"
+ .'POST'."\n"
+ .'```'."\n"
+ ."\n"
+ .'### URI'."\n"
+ ."\n"
+ .'```java'."\n"
+ .'/openapi/ha3/instances/{instanceId}/sql-studio/databases/{database}/sql-instances'."\n"
+ .'```.',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateSqlInstance'],
+ ],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'create',
+ 'ramAction' => [
+ 'action' => 'searchengine:CreateSqlInstance',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SearchEngine', 'resourceType' => 'Instance', 'arn' => 'acs:searchengine:{#regionId}:{#accountId}:instance/{#instanceId}'],
+ ],
+ ],
+ ],
],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"B43CD1BB-ABD7-59C5-B89A-6E5F6FE60A84\\",\\n \\"result\\": {\\n \\"id\\": 22,\\n \\"gmtCreate\\": \\"1719220182844\\",\\n \\"gmtModified\\": \\"1719220182844\\",\\n \\"name\\": \\"test\\",\\n \\"parent\\": -1,\\n \\"isDir\\": 0,\\n \\"type\\": \\"instance\\",\\n \\"instanceId\\": 0,\\n \\"templateId\\": 1\\n }\\n}","type":"json"}]',
+ ],
+ 'CreateTable' => [
+ 'summary' => 'Creates an index table.',
+ 'path' => '/openapi/ha3/instances/{instanceId}/tables',
+ 'methods' => ['post'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
- 'operationType' => 'readAndWrite',
+ 'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
'operationType' => 'create',
'riskType' => 'none',
'chargeType' => 'free',
- 'abilityTreeCode' => '104691',
- 'abilityTreeNodes' => [
- 'FEATUREopensearchVHEWK3',
- ],
+ 'abilityTreeCode' => '218772',
+ 'abilityTreeNodes' => ['FEATUREopensearchGTRUN8'],
],
'parameters' => [
[
'name' => 'instanceId',
'in' => 'path',
- 'schema' => [
- 'description' => 'The instance ID.'."\n",
- 'type' => 'string',
- 'required' => true,
- 'example' => 'ha-cn-2r42ppr7901',
- ],
+ 'schema' => ['description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'example' => 'ha-cn-pl32rf0****', 'title' => ''],
+ ],
+ [
+ 'name' => 'dryRun',
+ 'in' => 'query',
+ 'schema' => ['description' => 'Specifies whether to perform a dry run (only validates whether the data source is valid). Valid values:'."\n"
+ .'- true: performs a dry run.'."\n"
+ .'- false: does not perform a dry run.', 'type' => 'boolean', 'default' => 'false', 'required' => false, 'example' => 'true', 'title' => ''],
],
[
'name' => 'body',
'in' => 'body',
'style' => 'json',
'schema' => [
- 'description' => 'The request body.'."\n",
+ 'description' => 'body',
'type' => 'object',
'properties' => [
- 'name' => [
- 'title' => '名称',
- 'description' => 'The index name.'."\n",
- 'type' => 'string',
- 'required' => false,
- 'example' => 'ha-cn-zvp2qr1sk01_qrs',
- ],
+ 'name' => ['title' => '', 'description' => 'The index name.', 'type' => 'string', 'required' => false, 'example' => 'api_index_1'],
+ 'dataProcessorCount' => ['title' => '', 'description' => 'The number of data update resources.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1'],
+ 'partitionCount' => ['title' => '', 'description' => 'The number of data shards.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1'],
'dataSource' => [
- 'title' => '数据源',
- 'description' => 'The name of the data source.'."\n",
- 'type' => 'string',
- 'required' => false,
- 'example' => 'test1',
- ],
- 'domain' => [
- 'title' => '数据源的部署',
- 'description' => 'The data center in which the data source is deployed.'."\n",
- 'type' => 'string',
- 'required' => false,
- 'example' => 'vpc_hz_domain_1',
- ],
- 'content' => [
- 'title' => '文件内容',
- 'description' => 'The index schema.'."\n",
- 'type' => 'string',
- 'required' => false,
- 'example' => '{\\"summarys\\":{\\"summary_fields\\":[\\"id\\"]},\\"indexs\\":[{\\"index_name\\":\\"index_id\\",\\"index_type\\":\\"PRIMARYKEY64\\",\\"index_fields\\":\\"id\\",\\"has_primary_key_attribute\\":true,\\"is_primary_key_sorted\\":false}],\\"attributes\\":[\\"id\\"],\\"fields\\":[{\\"field_name\\":\\"id\\",\\"field_type\\":\\"UINT16\\"}],\\"table_name\\":\\"index_2\\"}',
- ],
- 'partition' => [
- 'title' => '数据分片',
- 'description' => 'The number of data shards.'."\n",
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'example' => '20211202',
- ],
- 'dataSourceInfo' => [
- 'description' => 'The information about the data source. This parameter is required for an OpenSearch Vector Search Edition instance of the new version.'."\n",
+ 'title' => '',
+ 'description' => 'The datasource config.',
'type' => 'object',
'properties' => [
- 'dataTimeSec' => [
- 'description' => 'The start timestamp from which incremental data is retrieved.'."\n",
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'example' => '1709715164',
- ],
- 'processPartitionCount' => [
- 'description' => 'The number of resources used for data update.'."\n",
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'example' => '4',
- ],
- 'name' => [
- 'description' => 'The name of the data source.'."\n",
- 'type' => 'string',
- 'required' => false,
- 'example' => 'ha-cn-35t3n1yuj0d_index_1',
- ],
- 'type' => [
- 'description' => 'The type of the data source. Valid values:'."\n"
- ."\n"
- .'* odps'."\n"
- .'* swift'."\n"
- .'* saro'."\n"
- .'* oss'."\n",
- 'type' => 'string',
- 'required' => false,
- 'example' => 'odps',
- ],
- 'domain' => [
- 'description' => 'The data center in which the data source is deployed.'."\n",
- 'type' => 'string',
- 'required' => false,
- 'example' => 'vpc_hz_domain_1'."\n",
- ],
+ 'type' => ['title' => '', 'description' => 'The data source type. Only odps, swift, and oss are supported. Valid values: odps, swift, saro, oss, and unKnow.', 'type' => 'string', 'required' => false, 'example' => 'odps'],
+ 'dataTimeSec' => ['title' => '', 'description' => 'The timestamp for incremental data tracking.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1715160176'],
+ 'autoBuildIndex' => ['title' => '', 'description' => 'Specifies whether auto index rebuilding is enabled.', 'type' => 'boolean', 'required' => false, 'example' => 'true'],
'config' => [
- 'description' => 'The information about the MaxCompute data source.'."\n",
- 'type' => 'object',
- 'properties' => [
- 'endpoint' => [
- 'description' => 'The endpoint of the MaxCompute or Object Storage Service (OSS) data source.'."\n",
- 'type' => 'string',
- 'required' => false,
- 'example' => 'https://oss-cn-hangzhou.aliyuncs.com',
- ],
- 'accessKey' => [
- 'description' => 'The AccessKey ID of the MaxCompute data source.'."\n",
- 'type' => 'string',
- 'required' => false,
- 'example' => 'L***p',
- ],
- 'accessSecret' => [
- 'description' => 'The AccessKey secret of the MaxCompute data source.'."\n",
- 'type' => 'string',
- 'required' => false,
- 'example' => '5**9a6',
- ],
- 'project' => [
- 'description' => 'The name of the MaxCompute project that is used as the data source.'."\n",
- 'type' => 'string',
- 'required' => false,
- 'example' => 'bbt_algo_pai',
- ],
- 'partition' => [
- 'description' => 'The partition in the MaxCompute table. This parameter is required if type is set to odps.'."\n",
- 'type' => 'string',
- 'required' => false,
- 'example' => 'ds=20230114',
- ],
- 'table' => [
- 'description' => 'The table name.'."\n",
- 'type' => 'string',
- 'required' => false,
- 'example' => 'bbt_rec_swing_u2i2i_score_be_v1',
- ],
- 'namespace' => [
- 'description' => 'The namespace name.'."\n",
- 'type' => 'string',
- 'required' => false,
- 'example' => 'test-namespace',
- ],
- 'path' => [
- 'description' => 'The path of the Apsara File Storage for HDFS data source.'."\n",
- 'type' => 'string',
- 'required' => false,
- 'example' => 'test-hdfs-path',
- ],
- 'ossPath' => [
- 'description' => 'The path of the OSS object.'."\n",
- 'type' => 'string',
- 'required' => false,
- 'example' => '/opensearch/oss.json',
- ],
- 'bucket' => [
- 'description' => 'The name of the OSS bucket.'."\n",
- 'type' => 'string',
- 'required' => false,
- 'example' => 'test-bucket',
- ],
- 'format' => [
- 'type' => 'string',
- ],
- 'catalog' => [
- 'type' => 'string',
- ],
- 'database' => [
- 'type' => 'string',
- ],
- 'tag' => [
- 'type' => 'string',
- ],
- 'tableFormat' => [
- 'type' => 'string',
- ],
- ],
- 'required' => false,
- ],
- 'saroConfig' => [
- 'description' => 'The configurations of the SARO data source.'."\n",
+ 'title' => '',
+ 'description' => 'The datasource config.',
'type' => 'object',
'properties' => [
- 'namespace' => [
- 'description' => 'The namespace of the SARO data source.'."\n",
- 'type' => 'string',
- 'required' => false,
- 'example' => 'flink-test-fjx-default',
- ],
- 'tableName' => [
- 'description' => 'The name of the SARO table.'."\n",
- 'type' => 'string',
- 'required' => false,
- 'example' => 'device_event_shy_summary_',
- ],
+ 'endpoint' => ['title' => '', 'description' => 'The access endpoint.', 'type' => 'string', 'required' => false, 'example' => 'http://service.cn-hangzhou.maxcompute.aliyun-inc.com/api'],
+ 'accessKey' => ['description' => 'The AccessKey ID of the ODPS data source.', 'type' => 'string', 'required' => false, 'example' => 'L***p', 'title' => ''],
+ 'accessSecret' => ['description' => 'The AccessKey secret of the ODPS data source.', 'type' => 'string', 'required' => false, 'example' => '5**9a6', 'title' => ''],
+ 'project' => ['description' => 'The project name of the ODPS data source.', 'type' => 'string', 'required' => false, 'example' => 'test_project', 'title' => ''],
+ 'partition' => ['description' => 'The partition. This parameter is required when the data source is ODPS.', 'type' => 'string', 'required' => false, 'example' => 'ds=20220713', 'title' => ''],
+ 'table' => ['title' => '', 'description' => 'The table name of the ODPS or DLF data source.', 'type' => 'string', 'required' => false, 'example' => 'test56'],
+ 'path' => ['description' => 'The relative path.', 'type' => 'string', 'required' => false, 'example' => '/test', 'title' => ''],
+ 'ossPath' => ['title' => '', 'description' => 'The OSS data source path.', 'type' => 'string', 'required' => false, 'example' => '/opensearch/test.txt'],
+ 'bucket' => ['description' => 'oss bucket', 'type' => 'string', 'required' => false, 'example' => 'test-bucket', 'title' => ''],
+ 'catalog' => ['description' => 'The catalog name of the DLF data source.', 'type' => 'string', 'required' => false, 'example' => 'test_catalog', 'title' => ''],
+ 'database' => ['description' => 'The database of the DLF data source.', 'type' => 'string', 'required' => false, 'example' => 'opensearch_db', 'title' => ''],
+ 'tag' => ['description' => 'The tag of the DLF data source.', 'type' => 'string', 'required' => false, 'example' => 'test', 'title' => ''],
+ 'tableFormat' => ['description' => 'The table format of the DLF data source.', 'type' => 'string', 'required' => false, 'example' => 'paimon'."\n"
+ .'lance'."\n"
+ .'object', 'title' => ''],
+ 'format' => ['title' => '', 'description' => 'The file format type.', 'type' => 'string', 'required' => false, 'example' => 'ha3'."\n"
+ .'json'],
],
'required' => false,
- ],
- 'autoBuildIndex' => [
- 'description' => 'Specifies whether to enable automatic full indexing.'."\n",
- 'type' => 'boolean',
- 'required' => false,
- 'example' => 'true',
- ],
- 'processParallelNum' => [
- 'description' => 'The maximum number of full indexes that can be concurrently processed.'."\n",
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'example' => '2',
- ],
- 'scene' => [
- 'title' => '场景模版',
- 'type' => 'string',
+ 'example' => '',
],
],
'required' => false,
+ 'example' => '',
],
- 'extend' => [
- 'description' => 'The extended content of the field configuration. key specifies the vector field and the field that requires embedding.'."\n",
+ 'rawSchema' => ['title' => '', 'description' => 'The raw schema. If you specify this parameter, the value is used directly as the HA3 schema structure without manual assembly.', 'type' => 'string', 'required' => false, 'example' => '{}'],
+ 'primaryKey' => ['title' => '', 'description' => 'The primary key field.', 'type' => 'string', 'required' => false, 'example' => 'id'],
+ 'fieldSchema' => [
+ 'title' => '',
+ 'description' => 'The field schema. The key is the field name.',
'type' => 'object',
'required' => false,
- 'example' => '{'."\n"
- .' "vector":'."\n"
- .' ['."\n"
- .' "source_image_vector"'."\n"
- .' ],'."\n"
- .' "embeding":'."\n"
- .' ['."\n"
- .' "source_image"'."\n"
- .' ],'."\n"
- .' "description":'."\n"
- .' []'."\n"
- .' }',
+ 'additionalProperties' => ['description' => 'map结构', 'type' => 'string', 'example' => '{'."\n"
+ .' "id": "INT64",'."\n"
+ .' "source_image": "STRING",'."\n"
+ .' "namespace": "INT64",'."\n"
+ .' "source_image_vector": "MULTI_FLOAT"'."\n"
+ .'}', 'title' => ''],
+ 'example' => '',
],
- 'buildParallelNum' => [
- 'description' => 'The maximum number of full indexes that can be concurrently built.'."\n",
- 'type' => 'integer',
- 'format' => 'int32',
+ 'vectorIndex' => [
+ 'title' => '',
+ 'description' => 'The index structure.',
+ 'type' => 'array',
+ 'items' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'indexName' => ['title' => '', 'description' => 'The index structure name.', 'type' => 'string', 'required' => false, 'example' => 'test_index'],
+ 'vectorField' => ['title' => '', 'description' => 'The vector field.', 'type' => 'string', 'required' => false, 'example' => 'source_image_vector'],
+ 'sparseIndexField' => ['title' => '', 'description' => 'The sparse vector index field.', 'type' => 'string', 'required' => false, 'example' => 'sparse_indices'],
+ 'sparseValueField' => ['title' => '', 'description' => 'The sparse vector value field.', 'type' => 'string', 'required' => false, 'example' => 'sparse_values'],
+ 'dimension' => ['title' => '', 'description' => 'The vector dimensions.', 'type' => 'string', 'required' => false, 'example' => '128'],
+ 'vectorIndexType' => ['title' => '', 'description' => 'The vector index algorithm.', 'type' => 'string', 'required' => false, 'example' => 'Qc'],
+ 'distanceType' => ['title' => '', 'description' => 'The distance type.', 'type' => 'string', 'required' => false, 'example' => 'SquaredEuclidean'],
+ 'namespace' => ['title' => '', 'description' => 'The namespace field.', 'type' => 'string', 'required' => false, 'example' => 'namespace'],
+ 'advanceParams' => [
+ 'title' => '',
+ 'description' => 'The index structure configuration.',
+ 'type' => 'object',
+ 'properties' => [
+ 'buildIndexParams' => ['title' => '', 'description' => 'The index building parameters.', 'type' => 'string', 'required' => false, 'example' => '{}'],
+ 'searchIndexParams' => ['title' => '', 'description' => 'The index search parameters.', 'type' => 'string', 'required' => false, 'example' => '{}'],
+ 'minScanDocCnt' => ['title' => '', 'description' => 'The minimum number of candidate documents for recall.', 'type' => 'string', 'required' => false, 'example' => '20000'],
+ 'linearBuildThreshold' => ['title' => '', 'description' => 'The threshold for linear building.', 'type' => 'string', 'required' => false, 'example' => '5000'],
+ ],
+ 'required' => false,
+ 'example' => '',
+ ],
+ ],
+ 'required' => false,
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
+ ],
'required' => false,
- 'example' => '2',
+ 'example' => '',
],
- 'mergeParallelNum' => [
- 'description' => 'The maximum number of full indexes that can be concurrently merged.'."\n",
- 'type' => 'integer',
- 'format' => 'int32',
+ 'dataProcessConfig' => [
+ 'title' => '',
+ 'description' => 'The field processing configuration.',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'The details of the field processing configuration.',
+ 'type' => 'object',
+ 'properties' => [
+ 'operator' => ['title' => '', 'description' => 'The field processing method. Valid values:'."\n"
+ .'- copy: copies the source field to the destination field.'."\n"
+ .'- vectorize: vectorizes the source field by using a model and stores the vector in the destination field.', 'type' => 'string', 'required' => false, 'example' => 'vectorize'],
+ 'dstField' => ['title' => '', 'description' => 'The destination field.', 'type' => 'string', 'required' => false, 'example' => 'source_image_vector'],
+ 'srcField' => ['title' => '', 'description' => 'The source field.', 'type' => 'string', 'required' => false, 'example' => 'source_image'],
+ 'params' => [
+ 'title' => '',
+ 'description' => 'The model configuration.',
+ 'type' => 'object',
+ 'properties' => [
+ 'vectorModel' => ['title' => '', 'description' => 'The vectorization model.', 'type' => 'string', 'required' => false, 'example' => 'clip'],
+ 'vectorModal' => ['title' => '', 'description' => 'The data type.', 'type' => 'string', 'required' => false, 'example' => 'image'],
+ 'srcFieldConfig' => [
+ 'title' => '',
+ 'description' => 'The vectorization information source.',
+ 'type' => 'object',
+ 'properties' => [
+ 'ossEndpoint' => ['description' => 'The OSS region endpoint.', 'type' => 'string', 'required' => false, 'example' => 'oss-cn-hangzhou-internal.aliyuncs.com', 'title' => ''],
+ 'ossBucket' => ['description' => 'OSSBucket', 'type' => 'string', 'required' => false, 'example' => 'test-bucket', 'title' => ''],
+ 'uid' => ['description' => 'The Alibaba Cloud account ID.', 'type' => 'string', 'required' => false, 'example' => '1062017779051424', 'title' => ''],
+ ],
+ 'required' => false,
+ 'example' => '',
+ ],
+ ],
+ 'required' => false,
+ 'example' => '',
+ ],
+ ],
+ 'required' => false,
+ 'title' => '',
+ 'example' => '',
+ ],
'required' => false,
- 'example' => '2',
+ 'example' => '',
],
+ 'scene' => ['title' => '', 'description' => 'The template type.', 'type' => 'string', 'required' => false, 'example' => 'videoSearcher'],
],
'required' => false,
- 'example' => '{}',
- ],
- ],
- [
- 'name' => 'dryRun',
- 'in' => 'query',
- 'schema' => [
- 'description' => 'Specifies whether to perform only a dry run, without performing the actual request. The system only checks the validity of the data source. Valid values:'."\n"
- ."\n"
- .'* true'."\n"
- .'* false'."\n",
- 'type' => 'boolean',
- 'required' => false,
- 'example' => 'true',
+ 'title' => '',
+ 'example' => '',
],
],
],
'responses' => [
200 => [
'schema' => [
- 'description' => 'The results returned.'."\n",
'type' => 'object',
'properties' => [
- 'requestId' => [
- 'title' => 'id of request',
- 'description' => 'The request ID.'."\n",
- 'type' => 'string',
- 'example' => '407BFD91-DE7D-50BA-8F88-CDE52A3B5E46',
- ],
- 'result' => [
- 'title' => 'Map',
- 'description' => 'The results returned.'."\n",
- 'type' => 'object',
- 'example' => '{}',
- ],
+ 'requestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '2AE63638-5420-56DC-BF59-37D8174039A0'],
+ 'result' => ['title' => '', 'description' => 'The returned result.', 'type' => 'object', 'example' => '{}'],
],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
],
500 => [],
],
- 'eventInfo' => [
- 'enable' => false,
- 'eventNames' => [],
- ],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"407BFD91-DE7D-50BA-8F88-CDE52A3B5E46\\",\\n \\"result\\": {}\\n}","type":"json"}]',
- 'title' => 'CreateIndex',
+ 'title' => 'Create an index table',
'description' => '### Method'."\n"
."\n"
.'```java'."\n"
@@ -4040,52 +2082,64 @@
.'### URI'."\n"
."\n"
.'```java'."\n"
- .'/openapi/ha3/instances/{instanceId}/indexes'."\n"
- .'```'."\n",
- 'requestParamsDescription' => '## Sample requests'."\n"
+ .'/openapi/ha3/instances/{instanceId}/tables'."\n"
+ .'```.',
+ 'requestParamsDescription' => '### Request example'."\n"
."\n"
- .'```java'."\n"
- .'POST /openapi/ha3/instances/ose-test1/indexes'."\n"
- .'```'."\n"
- ."\n"
- .'```java'."\n"
- .'{'."\n"
- .'​'."\n"
- .' "name": "aaa",'."\n"
- .''."\n"
- .' "dataSource": "beixuan_test",'."\n"
- .''."\n"
- .' "domain": "test", // Specifies where the data source is deployed.'."\n"
.''."\n"
- .' "content": "",'."\n"
- .''."\n"
- .' "partition": 2'."\n"
- .''."\n"
- .'}'."\n"
- .'```',
- 'responseParamsDescription' => '### Sample responses'."\n"
."\n"
- .'Success responses'."\n"
+ .'```java'."\n"
+ .'POST /openapi/ha3/instances/{instanceId}/tables'."\n"
+ .'```'."\n"
+ .'><notice>This example lists only the simplest parameters. For more custom parameters, refer to the request parameters.></notice>'."\n"
."\n"
.'```java'."\n"
.'{'."\n"
- .' "requestId": "0A6EB64B-B4C8-CF02-810F-E660812972FF",'."\n"
- .' "result": {}'."\n"
+ .' "name": "api",'."\n"
+ .' "partitionCount": 1,'."\n"
+ .' "primaryKey": "id",'."\n"
+ .' "fieldSchema": {'."\n"
+ .' "id": "INT64",'."\n"
+ .' "source_image": "STRING",'."\n"
+ .' "namespace": "STRING",'."\n"
+ .' "source_image_vector": "MULTI_FLOAT"'."\n"
+ .' },'."\n"
+ .' "vectorIndex": ['."\n"
+ .' {'."\n"
+ .' "indexName": "test_index_1",'."\n"
+ .' "vectorField": "source_image_vector",'."\n"
+ .' "vectorIndexType": "HNSW",'."\n"
+ .' "dimension": "512",'."\n"
+ .' "distanceType": "InnerProduct"'."\n"
+ .' }'."\n"
+ .' ]'."\n"
.'}'."\n"
.'```'."\n"
- ."\n"
- .'For more information, see [Response struct](~~464322~~).',
- ],
- 'BuildIndex' => [
- 'summary' => 'Triggers reindexing.',
- 'path' => '/openapi/ha3/instances/{instanceId}/actions/build-index',
- 'methods' => [
- 'post',
- ],
- 'schemes' => [
- 'http',
- 'https',
+ .'For more information, refer to [Response structure](~~465311~~)<details>.',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'create',
+ 'ramAction' => [
+ 'action' => 'searchengine:CreateTable',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SearchEngine', 'resourceType' => 'Instance', 'arn' => 'acs:searchengine:{#regionId}:{#accountId}:instance/{#InstanceId}'],
+ ],
+ ],
+ ],
],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"2AE63638-5420-56DC-BF59-37D8174039A0\\",\\n \\"result\\": {}\\n}","type":"json"}]',
+ ],
+ 'DebugModel' => [
+ 'summary' => 'Debugs a model.',
+ 'path' => '/openapi/ha3/instances/{instanceId}/models/{modelName}/actions/debug',
+ 'methods' => ['post'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
@@ -4094,207 +2148,82 @@
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
- 'operationType' => 'update',
+ 'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
- 'abilityTreeCode' => '104671',
- 'abilityTreeNodes' => [
- 'FEATUREopensearchD5N27K',
- ],
+ 'abilityTreeNodes' => ['FEATUREopensearchGTRUN8'],
],
'parameters' => [
[
'name' => 'instanceId',
'in' => 'path',
- 'schema' => [
- 'title' => '实例ID',
- 'description' => 'The instance ID.'."\n",
- 'type' => 'string',
- 'required' => true,
- 'example' => 'ha-cn-7mz2iv7sq01',
- ],
+ 'schema' => ['title' => '', 'description' => 'The instance ID.', 'type' => 'string', 'required' => false, 'example' => 'ha-cn-pl32rf0****'],
+ ],
+ [
+ 'name' => 'modelName',
+ 'in' => 'path',
+ 'schema' => ['title' => '', 'description' => 'The name of the model.', 'type' => 'string', 'required' => false, 'example' => 'test'],
+ ],
+ [
+ 'name' => 'isOnline',
+ 'in' => 'query',
+ 'schema' => ['title' => '', 'description' => 'Specifies whether to perform an online query. Set this parameter to true to use the search configuration. Set this parameter to false to use the build configuration.', 'type' => 'string', 'required' => false, 'example' => 'true'],
],
[
'name' => 'body',
'in' => 'body',
'style' => 'json',
'schema' => [
- 'description' => 'The request body, which is a JSON string. For more information, see the following parameters.'."\n",
+ 'description' => 'The request body.',
'type' => 'object',
'properties' => [
- 'dataSourceName' => [
- 'title' => '数据源名',
- 'description' => 'The name of the data source.'."\n",
- 'type' => 'string',
- 'required' => false,
- 'example' => 'my_data_source',
- ],
- 'domain' => [
- 'title' => '数据源部署',
- 'description' => 'The data center in which the data source is deployed.'."\n",
- 'type' => 'string',
- 'required' => false,
- 'example' => 'test',
- ],
- 'dataSourceType' => [
- 'title' => '数据源类型 (odps: maxComputer, swift: swift, unKnow)',
- 'description' => 'The type of the data source.'."\n",
- 'type' => 'string',
- 'required' => false,
- 'example' => 'swift',
- ],
- 'partition' => [
- 'title' => '数据源的可用分区',
- 'description' => 'The partition in the MaxCompute table. This parameter is required if type is set to odps.'."\n",
- 'type' => 'string',
- 'required' => false,
- 'example' => '20201010',
- ],
- 'dataTimeSec' => [
- 'title' => 'API推送数据源的数据时间',
- 'description' => 'The timestamp in seconds. The value must be of the INTEGER type. This parameter is required if you specify an API data source.'."\n",
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'example' => '1640867288',
- ],
- 'buildMode' => [
- 'title' => '索引重建方式 (API: API方式推送数据源, RECOVER_INDEX: 从索引中恢复数据源)',
- 'description' => 'The reindexing method. Valid values: api: API data source. indexRecover: data recovery by using indexing.'."\n",
- 'type' => 'string',
- 'required' => false,
- 'example' => 'indexRecover',
- ],
- 'generation' => [
- 'title' => '从索引中恢复数据源，dump表的generation',
- 'description' => 'The data restoration version.'."\n",
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => false,
- 'example' => '160131146',
- ],
- 'tag' => [
- 'type' => 'string',
- ],
- 'path' => [
- 'type' => 'string',
- ],
+ 'input' => ['title' => '', 'description' => 'The input of the model.', 'type' => 'string', 'required' => false, 'example' => 'test'],
],
'required' => false,
- 'example' => '{}',
+ 'title' => '',
+ 'example' => '',
],
],
],
'responses' => [
200 => [
'schema' => [
- 'title' => 'Schema of Response',
- 'description' => 'Schema of Response'."\n",
+ 'title' => '',
+ 'description' => 'The response schema.',
'type' => 'object',
'properties' => [
- 'requestId' => [
- 'title' => 'id of request',
- 'description' => 'id of request'."\n",
- 'type' => 'string',
- 'example' => '407BFD91-DE7D-50BA-8F88-CDE52A3B5E46',
- ],
- 'result' => [
- 'title' => '集群列表',
- 'description' => 'The list of clusters'."\n",
- 'type' => 'object',
- 'example' => '{}',
- ],
+ 'requestId' => ['title' => '', 'description' => 'The ID of the request.', 'type' => 'string', 'example' => 'E7B7D598-B080-5C8E-AA35-D43EC0D5F886'],
],
+ 'example' => '',
],
],
- 500 => [],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"407BFD91-DE7D-50BA-8F88-CDE52A3B5E46\\",\\n \\"result\\": {}\\n}","type":"json"}]',
- 'title' => 'BuildIndex',
- 'description' => '## Method'."\n"
- ."\n"
- .' POST'."\n"
- ."\n"
- .'## URI'."\n"
- ."\n"
- .' /openapi/ha3/instances/{instanceId}/actions/build-index'."\n",
- 'requestParamsDescription' => '## Sample requests'."\n"
- ."\n"
- .''."\n"
- ."\n"
- .' POST /openapi/ha3/instances/ha3_instance_name/actions/build-index'."\n"
- ."\n"
- .'​ '."\n"
- ."\n"
- .' {'."\n"
- .' '."\n"
- .' "dataSourceName": "my_data_source",'."\n"
- .' '."\n"
- .' "domain": "test", // Specifies where the data source is deployed.'."\n"
- .' '."\n"
- .' "indexes": ['."\n"
- .' '."\n"
- .' "index1",'."\n"
- .' '."\n"
- .' "index2"'."\n"
- .' '."\n"
- .' ],'."\n"
- .' ​'."\n"
- .' "dataSourceType": "odps", // Set this parameter to odps or swift. This parameter is required.'."\n"
- .' '."\n"
- .' "partition": "20201010", // This parameter is required for the odps data source.'."\n"
- .' '."\n"
- .' "dataTimeSec": 1640867288 // The timestamp in seconds. It is of the INT type. This parameter is required for the API-pushed data source.'."\n"
- .' '."\n"
- .' }'."\n"
- ."\n"
- .' ​  ​ '."\n"
- ."\n"
- .' {'."\n"
- .' '."\n"
- .' "dataSourceName": "my_data_source",'."\n"
- .' '."\n"
- .' "domain": "test", // Specifies where the data source is deployed.'."\n"
- .' '."\n"
- .' "indexes": ['."\n"
- .' '."\n"
- .' "index1",'."\n"
- .' '."\n"
- .' "index2"'."\n"
- .' '."\n"
- .' ],'."\n"
- .' '."\n"
- .' "dataSourceType": "swift", // Set this parameter to odps or swift. This parameter is required.'."\n"
- .' '."\n"
- .' "partition": "20201010", // This parameter is required for the odps data source.'."\n"
- .' '."\n"
- .' "dataTimeSec": 1640867288 // The timestamp in seconds. It is of the INT type. This parameter is required for the API-pushed data source.'."\n"
- .' ​'."\n"
- .' }'."\n"
- ."\n"
- .' ​'."\n",
- 'responseParamsDescription' => '## [](#)Sample responses'."\n"
- ."\n"
- .'Sample success responses '."\n"
- ."\n"
- .' {'."\n"
- .' '."\n"
- .' "requestId": "0A6EB64B-B4C8-CF02-810F-E660812972FF",'."\n"
- .' '."\n"
- .' "result": []'."\n"
- .' '."\n"
- .' }',
- ],
- 'DeleteIndexVersion' => [
- 'summary' => 'Deletes the version of an index.',
- 'path' => '/openapi/ha3/instances/{instanceId}/indexes/{indexName}/versions/{versionName}',
- 'methods' => [
- 'delete',
- ],
- 'schemes' => [
- 'http',
- 'https',
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"E7B7D598-B080-5C8E-AA35-D43EC0D5F886\\"\\n}","type":"json"}]',
+ 'title' => 'DebugModel',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'searchengine:DebugModel',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SearchEngine', 'resourceType' => 'Instance', 'arn' => 'acs:searchengine:{#regionId}:{#accountId}:instance/{#InstanceId}'],
+ ],
+ ],
+ ],
],
+ ],
+ 'DeleteAdvanceConfig' => [
+ 'summary' => 'Deletes the details about advanced configurations.',
+ 'path' => '/openapi/ha3/instances/{instanceId}/advanced-configs/{configName}',
+ 'methods' => ['delete'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
@@ -4307,447 +2236,264 @@
[
'name' => 'instanceId',
'in' => 'path',
- 'schema' => [
- 'title' => '实例ID',
- 'description' => 'The instance ID.'."\n",
- 'type' => 'string',
- 'required' => true,
- 'example' => 'ha-cn-0ju2rrogr01',
- ],
- ],
- [
- 'name' => 'indexName',
- 'in' => 'path',
- 'schema' => [
- 'title' => '索引名称',
- 'description' => 'The index name.'."\n",
- 'type' => 'string',
- 'required' => true,
- 'example' => 'generation',
- ],
+ 'schema' => ['title' => '', 'description' => 'The instance ID.'."\n", 'type' => 'string', 'required' => true, 'example' => 'ha-cn-pl32rf0****'],
],
[
- 'name' => 'versionName',
+ 'name' => 'configName',
'in' => 'path',
- 'schema' => [
- 'title' => '版本名称',
- 'description' => 'The name of the version.'."\n",
- 'type' => 'string',
- 'required' => true,
- 'example' => 'ha-cn-pl32rf0js04@ha-cn-pl32rf0js04_shenzhen_test_01@sz_vpc_domain_1@api_test@index_config_v1',
- ],
+ 'schema' => ['title' => '', 'description' => 'The configuration name.'."\n", 'type' => 'string', 'required' => false, 'example' => 'ha-cn-pl32rf0****_offline_adv_v1'],
],
],
'responses' => [
200 => [
'schema' => [
- 'title' => 'Schema of Response',
- 'description' => 'Schema of Response'."\n",
+ 'title' => '',
+ 'description' => 'The schema of the response parameter.'."\n",
'type' => 'object',
'properties' => [
- 'requestId' => [
- 'title' => 'id of request',
- 'description' => 'id of request'."\n",
- 'type' => 'string',
- 'example' => '022F36C7-9FB4-5D67-BEBC-3D14B0984463',
- ],
- 'result' => [
- 'title' => '结果',
- 'description' => 'The result'."\n",
- 'type' => 'object',
- 'example' => '{}',
- ],
+ 'requestId' => ['title' => '', 'description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => 'E7B7D598-B080-5C8E-AA35-D43EC0D5F886'],
+ 'result' => ['title' => '', 'description' => 'The result.'."\n", 'type' => 'object', 'example' => '{}'],
],
+ 'example' => '',
],
],
500 => [],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"022F36C7-9FB4-5D67-BEBC-3D14B0984463\\",\\n \\"result\\": {}\\n}","type":"json"}]',
- 'title' => 'DeleteIndexVersion',
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"E7B7D598-B080-5C8E-AA35-D43EC0D5F886\\",\\n \\"result\\": {}\\n}","type":"json"}]',
+ 'title' => 'DeleteAdvanceConfig',
'description' => '## Method'."\n"
."\n"
.' DELETE'."\n"
."\n"
.'## URI'."\n"
."\n"
- .' /openapi/ha3/instances/{instanceId}/indexes/{indexName}/versions/{versionName}'."\n",
+ .' /openapi/ha3/instances/{instanceId}/advanced-configs/{configName}'."\n",
'requestParamsDescription' => '## Sample requests'."\n"
."\n"
.''."\n"
."\n"
- .' DELETE /openapi/ha3/instances/ose-test1/indexes/my_index/versions/version1'."\n",
- 'responseParamsDescription' => '## [](#)Sample responses'."\n"
+ .' DELETE /openapi/ha3/instances/ose-test1/advanced-configs/my_config_name'."\n",
+ 'responseParamsDescription' => '## Sample responses'."\n"
."\n"
- .'Sample success responses'."\n"
+ .'Sample success responses '."\n"
."\n"
.' {'."\n"
- .' '."\n"
- .' "requestId": "65911539-5a8b-4bce-96a5-4d608900dc46",'."\n"
- .' '."\n"
+ .' '."\n"
+ .' "requestId": "e1eef569-1ff7-4bf8-acf7-1cecca9894ce",'."\n"
+ .' '."\n"
.' "result": []'."\n"
- .' '."\n"
+ .' '."\n"
.' }'."\n"
."\n"
.'For more information, see [Response structure](~~465311~~).'."\n",
- ],
- 'DeleteIndex' => [
- 'summary' => 'Deletes an index.',
- 'path' => '/openapi/ha3/instances/{instanceId}/indexes/{indexName}',
- 'methods' => [
- 'delete',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteAdvanceConfig'],
+ ],
],
- 'schemes' => [
- 'http',
- 'https',
+ 'ramActions' => [
+ [
+ 'operationType' => '',
+ 'ramAction' => [
+ 'action' => 'searchengine:DeleteAdvanceConfig',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SearchEngine', 'resourceType' => 'Instance', 'arn' => 'acs:searchengine:{#regionId}:{#accountId}:instance/{#InstanceId}'],
+ ],
+ ],
+ ],
],
+ ],
+ 'DeleteAlias' => [
+ 'path' => '/openapi/ha3/instances/{instanceId}/aliases/{alias}',
+ 'methods' => ['delete'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
- 'operationType' => 'read',
+ 'operationType' => 'write',
'deprecated' => false,
- 'systemTags' => [],
+ 'systemTags' => [
+ 'operationType' => 'delete',
+ 'abilityTreeCode' => '223196',
+ 'abilityTreeNodes' => ['FEATUREopensearchGTRUN8'],
+ ],
'parameters' => [
[
'name' => 'instanceId',
'in' => 'path',
- 'schema' => [
- 'title' => '实例ID',
- 'description' => 'The instance ID.'."\n",
- 'type' => 'string',
- 'required' => true,
- 'example' => 'ha-cn-2r42p5oi202',
- ],
+ 'schema' => ['description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'example' => 'ha-cn-pl32rf0****', 'title' => ''],
],
[
- 'name' => 'indexName',
+ 'name' => 'alias',
'in' => 'path',
- 'schema' => [
- 'title' => '索引名称',
- 'description' => 'The index name.'."\n",
- 'type' => 'string',
- 'required' => true,
- 'example' => 'generation',
- ],
- ],
- [
- 'name' => 'dataSource',
- 'in' => 'query',
- 'schema' => [
- 'title' => '数据源',
- 'description' => 'The data source.'."\n",
- 'type' => 'string',
- 'required' => true,
- 'example' => 'ha-cn-pl32rf0js04_test',
- ],
- ],
- [
- 'name' => 'deleteDataSource',
- 'in' => 'query',
- 'schema' => [
- 'description' => 'Specifies whether to delete the data source.'."\n",
- 'type' => 'boolean',
- 'required' => false,
- 'example' => 'true',
- ],
+ 'schema' => ['description' => 'The alias.', 'type' => 'string', 'required' => true, 'example' => 'test', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
- 'title' => 'Schema of Response',
- 'description' => 'Schema of Response'."\n",
'type' => 'object',
'properties' => [
- 'requestId' => [
- 'title' => 'id of request',
- 'description' => 'id of request'."\n",
- 'type' => 'string',
- 'example' => '022F36C7-9FB4-5D67-BEBC-3D14B0984463',
- ],
- 'result' => [
- 'title' => '索引信息',
- 'description' => 'The information about the index'."\n",
- 'type' => 'object',
- 'example' => '{}',
- ],
+ 'requestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => 'FE03180A-0E29-5474-8A86-33F0683294A4'],
+ 'result' => ['title' => '', 'description' => 'The returned result.', 'type' => 'object', 'example' => '{}'],
],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
],
500 => [],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"022F36C7-9FB4-5D67-BEBC-3D14B0984463\\",\\n \\"result\\": {}\\n}","type":"json"}]',
- 'title' => 'DeleteIndex',
- 'description' => '## Method'."\n"
- ."\n"
- .' DELETE'."\n"
- ."\n"
- .'## URI'."\n"
- ."\n"
- .' /openapi/ha3/instances/{instanceId}/indexes/{indexName}?dataSource=xxx'."\n",
- 'requestParamsDescription' => '## Sample requests'."\n"
- ."\n"
- .''."\n"
- ."\n"
- .' DELETE /openapi/ha3/instances/ose-test1/indexes/my_index?dataSource=xxx'."\n",
- 'responseParamsDescription' => '## Sample responses'."\n"
+ 'title' => 'Delete an alias',
+ 'summary' => 'Deletes an alias.',
+ 'description' => '### Method'."\n"
."\n"
- .'Success responses '."\n"
+ .'```java'."\n"
+ .'DELETE'."\n"
+ .'```'."\n"
."\n"
- .' {'."\n"
- .' '."\n"
- .' "requestId": "65911539-5a8b-4bce-96a5-4d608900dc46",'."\n"
- .' '."\n"
- .' "result": []'."\n"
- .' '."\n"
- .' }'."\n"
+ .'### URI'."\n"
."\n"
- .'For more information, see [Response struct](~~464322~~).',
- ],
- 'ModifyIndexVersion' => [
- 'summary' => 'Modifies the index version of a cluster (an index version rollback).',
- 'path' => '/openapi/ha3/instances/{instanceId}/clusters/{clusterName}/index-version',
- 'methods' => [
- 'put',
- ],
- 'schemes' => [
- 'http',
- 'https',
+ .'```java'."\n"
+ .'/openapi/ha3/instances/{instanceId}/aliases/{alias}'."\n"
+ .'```.',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'delete',
+ 'ramAction' => [
+ 'action' => 'searchengine:DeleteAlias',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SearchEngine', 'resourceType' => 'Instance', 'arn' => 'acs:searchengine:{#regionId}:{#accountId}:instance/{#InstanceId}'],
+ ],
+ ],
+ ],
],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"FE03180A-0E29-5474-8A86-33F0683294A4\\",\\n \\"result\\": {}\\n}","type":"json"}]',
+ ],
+ 'DeleteConfigDir' => [
+ 'path' => '/openapi/ha3/instances/{instanceId}/advanced-configs/{configName}/dir',
+ 'methods' => ['delete'],
+ 'schemes' => ['https', 'http'],
'security' => [
[
'AK' => [],
],
],
- 'operationType' => 'read',
+ 'operationType' => 'write',
'deprecated' => false,
'systemTags' => [],
'parameters' => [
[
'name' => 'instanceId',
'in' => 'path',
- 'schema' => [
- 'description' => 'The instance ID.'."\n",
- 'type' => 'string',
- 'required' => true,
- 'example' => 'ha-cn-7mz2j2off06',
- ],
+ 'schema' => ['description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'example' => 'ha-cn-pl32rf0****', 'title' => ''],
],
[
- 'name' => 'clusterName',
+ 'name' => 'configName',
'in' => 'path',
- 'schema' => [
- 'description' => 'The name of the cluster.'."\n",
- 'type' => 'string',
- 'required' => false,
- 'example' => 'vpc_hz_domain_2',
- ],
+ 'schema' => ['description' => 'The configuration name.', 'type' => 'string', 'required' => true, 'example' => 'ha-cn-pl32rf0****@ha-cn-pl32rf0****_test_api@test_api@index_config_edit', 'title' => ''],
],
[
- 'name' => 'body',
- 'in' => 'body',
- 'style' => 'json',
- 'schema' => [
- 'description' => 'The request body.'."\n",
- 'type' => 'array',
- 'items' => [
- 'description' => 'The keyword used to search for a version. Fuzzy match is supported.'."\n",
- 'type' => 'object',
- 'properties' => [
- 'indexName' => [
- 'title' => '索引名称',
- 'description' => 'The index name.'."\n",
- 'type' => 'string',
- 'required' => false,
- 'example' => 'main_index',
- ],
- 'version' => [
- 'title' => '索引版本',
- 'description' => 'The index version.'."\n",
- 'type' => 'string',
- 'required' => false,
- 'example' => '1',
- ],
- 'buildDeployId' => [
- 'title' => '产出索引的离线部署',
- 'description' => 'The deployment ID of the data source.'."\n",
- 'type' => 'string',
- 'required' => false,
- 'example' => '277',
- ],
- ],
- 'required' => false,
- ],
- 'required' => false,
- 'example' => '{}',
- ],
+ 'name' => 'dirName',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The folder name.', 'type' => 'string', 'required' => true, 'example' => '/clusters', 'title' => ''],
+ ],
+ [
+ 'name' => 'parentFullPath',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The path of the parent folder.', 'type' => 'string', 'required' => true, 'example' => '/', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
- 'description' => 'Schema of Response'."\n",
'type' => 'object',
'properties' => [
- 'requestId' => [
- 'title' => 'id of request',
- 'description' => 'id of request'."\n",
- 'type' => 'string',
- 'example' => 'F43E8AB4-419C-5F4C-90D6-615590DFAA3C',
- ],
- 'result' => [
- 'title' => 'Map',
- 'description' => 'result'."\n",
- 'type' => 'object',
- 'example' => '{}',
- ],
+ 'requestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => 'F43E8AB4-419C-5F4C-90D6-615590DFAA3C'],
+ 'result' => ['title' => '', 'description' => 'The returned result.', 'type' => 'object', 'example' => '{}'],
],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
],
500 => [],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"F43E8AB4-419C-5F4C-90D6-615590DFAA3C\\",\\n \\"result\\": {}\\n}","type":"json"}]',
- 'title' => 'ModifyIndexVersion',
- 'description' => '## [](#)Method'."\n"
- ."\n"
- .' PUT'."\n"
- ."\n"
- .'## [](#uri)URI'."\n"
- ."\n"
- .' /openapi/ha3/instances/{instanceId}/clusters/{clusterName}/index-version'."\n",
- 'requestParamsDescription' => '## Sample requests'."\n"
- ."\n"
- .''."\n"
- ."\n"
- .' PUT /openapi/ha3/instances/ha3_instance_nameclusters/test_cluster/index-version'."\n"
- ."\n"
- .''."\n"
- ."\n"
- .' ['."\n"
- .' '."\n"
- .' {'."\n"
- .' '."\n"
- .' "indexName": "index1",'."\n"
- .' '."\n"
- .' "version": "123456",'."\n"
- .' '."\n"
- .' "buildDeployId": "20201010"'."\n"
- .' '."\n"
- .' },'."\n"
- .' '."\n"
- .' {'."\n"
- .' '."\n"
- .' "indexName": "index1",'."\n"
- .' '."\n"
- .' "version": "123456",'."\n"
- .' '."\n"
- .' "buildDeployId": "20201010"'."\n"
- .' '."\n"
- .' }'."\n"
- .' '."\n"
- .' ]'."\n"
- .' '."\n",
- 'responseParamsDescription' => '## [](#)Sample responses'."\n"
+ 'title' => 'Delete an advanced configuration folder',
+ 'summary' => 'Deletes an advanced configuration folder.',
+ 'description' => '### Method'."\n"
."\n"
- .'Sample success responses'."\n"
+ .'```java'."\n"
+ .'DELETE'."\n"
+ .'```'."\n"
."\n"
- .' {'."\n"
- .' '."\n"
- .' "requestId": "0A6EB64B-B4C8-CF02-810F-E660812972FF",'."\n"
- .' '."\n"
- .' "result":[]'."\n"
- .' '."\n"
- .' }'."\n"
+ .'### URI'."\n"
."\n"
- .'For more information, see [Response structure](~~465311~~).'."\n",
- ],
- 'ModifyFile' => [
- 'summary' => 'Modifies a file.',
- 'path' => '/openapi/ha3/instances/{instanceId}/indexes/{indexName}/versions/{versionName}/file',
- 'methods' => [
- 'put',
- ],
- 'schemes' => [
- 'http',
- 'https',
+ .'```java'."\n"
+ .'/openapi/ha3/instances/{instanceId}/advanced-configs/{configName}/dir'."\n"
+ .'```.',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => '',
+ 'ramAction' => [
+ 'action' => 'searchengine:DeleteConfigDir',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SearchEngine', 'resourceType' => 'Instance', 'arn' => 'acs:searchengine:{#regionId}:{#accountId}:instance/{#InstanceId}'],
+ ],
+ ],
+ ],
],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"F43E8AB4-419C-5F4C-90D6-615590DFAA3C\\",\\n \\"result\\": {}\\n}","type":"json"}]',
+ ],
+ 'DeleteConfigFile' => [
+ 'path' => '/openapi/ha3/instances/{instanceId}/advanced-configs/{configName}/file',
+ 'methods' => ['delete'],
+ 'schemes' => ['https', 'http'],
'security' => [
[
'AK' => [],
],
],
- 'operationType' => 'read',
+ 'operationType' => 'write',
'deprecated' => false,
'systemTags' => [],
'parameters' => [
[
'name' => 'instanceId',
'in' => 'path',
- 'schema' => [
- 'description' => 'The instance ID.'."\n",
- 'type' => 'string',
- 'required' => true,
- 'example' => 'ha-cn-i7m2ne76e02',
- ],
- ],
- [
- 'name' => 'indexName',
- 'in' => 'path',
- 'schema' => [
- 'description' => 'The index name.'."\n",
- 'type' => 'string',
- 'required' => true,
- 'example' => 'automobile_vector',
- ],
+ 'schema' => ['description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'example' => 'ha-cn-pl32rf0****', 'title' => ''],
],
[
- 'name' => 'versionName',
+ 'name' => 'configName',
'in' => 'path',
- 'schema' => [
- 'description' => 'The version name.'."\n",
- 'type' => 'string',
- 'required' => true,
- 'example' => 'ha-cn-tl32m2c4u01@ha-cn-tl32m2c4u01_00@bj_vpc_domain_1@automobile_vector@index_config_edit',
- ],
+ 'schema' => ['description' => 'The configuration name.', 'type' => 'string', 'required' => true, 'example' => 'ha-cn-pl32rf0****@ha-cn-pl32rf0****_test_api@test_api@index_config_edit', 'title' => ''],
],
[
'name' => 'fileName',
'in' => 'query',
- 'schema' => [
- 'description' => 'The name of the file in the full path'."\n",
- 'type' => 'string',
- 'required' => true,
- 'example' => '/schemas/generation_schema.json',
- ],
+ 'schema' => ['description' => 'The file name.', 'type' => 'string', 'required' => true, 'example' => '/schemas/automobile_vector_schema.json', 'title' => ''],
],
[
- 'name' => 'body',
- 'in' => 'body',
- 'style' => 'json',
- 'schema' => [
- 'description' => 'The request body.'."\n",
- 'type' => 'object',
- 'properties' => [
- 'content' => [
- 'title' => '文件内容',
- 'description' => 'The file content.'."\n",
- 'type' => 'string',
- 'required' => false,
- 'example' => '""',
- ],
- 'partition' => [
- 'title' => '数据分片',
- 'description' => 'The number of shards.'."\n",
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'example' => 'ds=20220713',
- ],
- ],
- 'required' => false,
- 'example' => '{\\"desc\\":\\"new version\\"}',
- ],
+ 'name' => 'parentFullPath',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The path of the parent directory.', 'type' => 'string', 'required' => true, 'example' => '/', 'title' => ''],
],
],
'responses' => [
@@ -4755,66 +2501,53 @@
'schema' => [
'type' => 'object',
'properties' => [
- 'requestId' => [
- 'title' => 'id of request',
- 'description' => 'id of request'."\n",
- 'type' => 'string',
- 'example' => '89B968E6-1E41-58DF-BB25-5F98ECC759CE',
- ],
- 'result' => [
- 'title' => 'Map',
- 'description' => 'The information about the index'."\n",
- 'type' => 'object',
- 'example' => '{}',
- ],
+ 'requestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '10D5E615-69F7-5F49-B850-00169ADE513C'],
+ 'result' => ['title' => '', 'description' => 'The returned result.', 'type' => 'object', 'example' => '{}'],
],
- 'description' => 'Schema of Response'."\n",
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
],
500 => [],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"89B968E6-1E41-58DF-BB25-5F98ECC759CE\\",\\n \\"result\\": {}\\n}","type":"json"}]',
- 'title' => 'ModifyFile',
- 'description' => '## Method'."\n"
- ."\n"
- .' PUT'."\n"
- ."\n"
- .'## URI'."\n"
- ."\n"
- .' /openapi/ha3/instances/{instanceId}/indexes/{indexName}/versions/{versionName}/file?fileName=/root/test.txt'."\n",
- 'requestParamsDescription' => '## Sample requests'."\n"
+ 'title' => 'Delete an advanced configuration file',
+ 'summary' => 'Deletes an advanced configuration file.',
+ 'description' => '### Method'."\n"
."\n"
- .' PUT /openapi/ha3/instances/ose-test1/indexes/index1/versions/version1?fileName=/root/test.txt'."\n"
- .' '."\n"
- .' {'."\n"
- .' '."\n"
- .' "partition": 1,'."\n"
- .' '."\n"
- .' "content": ""'."\n"
- .' '."\n"
- .' }'."\n",
- 'responseParamsDescription' => '## [](#)Sample responses'."\n"
+ .'```java'."\n"
+ .'DELETE'."\n"
+ .'```'."\n"
."\n"
- .'Sample success responses'."\n"
+ .'### URI'."\n"
."\n"
- .' {'."\n"
- .' '."\n"
- .' "requestId": "e1eef569-1ff7-4bf8-acf7-1cecca9894ce",'."\n"
- .' '."\n"
- .' "result": {}'."\n"
- .' '."\n"
- .' }'."\n",
- ],
- 'PublishIndexVersion' => [
- 'summary' => 'Publishes a specified index version.',
- 'path' => '/openapi/ha3/instances/{instanceId}/indexes/{indexName}/actions/publish',
- 'methods' => [
- 'post',
- ],
- 'schemes' => [
- 'http',
- 'https',
+ .'```java'."\n"
+ .'/openapi/ha3/instances/{instanceId}/advanced-configs/{configName}/file'."\n"
+ .'```.',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => '',
+ 'ramAction' => [
+ 'action' => 'searchengine:DeleteConfigFile',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SearchEngine', 'resourceType' => 'Instance', 'arn' => 'acs:searchengine:{#regionId}:{#accountId}:instance/{#InstanceId}'],
+ ],
+ ],
+ ],
],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"10D5E615-69F7-5F49-B850-00169ADE513C\\",\\n \\"result\\": {}\\n}","type":"json"}]',
+ ],
+ 'DeleteDataSource' => [
+ 'summary' => 'Deletes a specified data source.',
+ 'path' => '/openapi/ha3/instances/{instanceId}/data-sources/{dataSourceName}',
+ 'methods' => ['delete'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
@@ -4827,298 +2560,104 @@
[
'name' => 'instanceId',
'in' => 'path',
- 'schema' => [
- 'description' => 'The instance ID.'."\n",
- 'type' => 'string',
- 'required' => true,
- 'example' => 'ha-cn-tl32m2c4u01',
- ],
+ 'schema' => ['title' => '', 'description' => 'The instance ID.'."\n", 'type' => 'string', 'required' => true, 'example' => 'ha-cn-pl32rf0****'],
],
[
- 'name' => 'indexName',
+ 'name' => 'dataSourceName',
'in' => 'path',
- 'schema' => [
- 'description' => 'The index name.'."\n",
- 'type' => 'string',
- 'required' => true,
- 'example' => 'automobile_2d',
- ],
- ],
- [
- 'name' => 'body',
- 'in' => 'body',
- 'style' => 'json',
- 'schema' => [
- 'description' => 'The request body.'."\n",
- 'type' => 'object',
- 'required' => false,
- 'example' => '{}',
- ],
+ 'schema' => ['title' => '', 'description' => 'The name of the data source.'."\n", 'type' => 'string', 'required' => true, 'example' => 'ha-cn-pl32rf0****_test_api'],
],
],
'responses' => [
200 => [
'schema' => [
+ 'title' => '',
'description' => 'Schema of Response'."\n",
'type' => 'object',
'properties' => [
- 'requestId' => [
- 'title' => 'id of request',
- 'description' => 'id of request'."\n",
- 'type' => 'string',
- 'example' => 'E45380E8-994A-5402-9806-F114B3295FCF',
- ],
- 'result' => [
- 'title' => 'Map',
- 'description' => 'The information about the index'."\n",
- 'type' => 'object',
- 'example' => '{}',
- ],
+ 'requestId' => ['title' => '', 'description' => 'The ID of the request'."\n", 'type' => 'string', 'example' => '10D5E615-69F7-5F49-B850-00169ADE513C'],
+ 'result' => ['title' => '', 'description' => 'The result returned'."\n", 'type' => 'object', 'example' => '{}'],
],
+ 'example' => '',
],
],
500 => [],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"E45380E8-994A-5402-9806-F114B3295FCF\\",\\n \\"result\\": {}\\n}","type":"json"}]',
- 'title' => 'PublishIndexVersion',
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"10D5E615-69F7-5F49-B850-00169ADE513C\\",\\n \\"result\\": {}\\n}","type":"json"}]',
+ 'title' => 'DeleteDataSource',
'description' => '## Method'."\n"
."\n"
- .' POST'."\n"
+ .'`DELETE`'."\n"
."\n"
.'## URI'."\n"
."\n"
- .' /openapi/ha3/instances/{instanceId}/indexes/{indexName}/actions/publish'."\n",
+ .'`/openapi/ha3/instances/{instanceId}/data-sources/{dataSourceName}`'."\n",
'requestParamsDescription' => '## Sample requests'."\n"
."\n"
- .''."\n"
- ."\n"
- .' POST /openapi/ha3/instances/ose-test1/indexes/my_index/actions/publish'."\n"
- ."\n"
- .''."\n"
- ."\n"
- .' {'."\n"
- .' '."\n"
- .' "desc": "new version",'."\n"
- .' '."\n"
- .' "dataSource": "test1",'."\n"
- .' '."\n"
- .' "domain": "test_domain"'."\n"
- .' '."\n"
- .' }'."\n",
+ .'`DELETE /openapi/ha3/instances/ha3_instances_id/data-sources/my_dataSource`'."\n",
'responseParamsDescription' => '## [](#)Sample responses'."\n"
."\n"
- .'Sample success responses'."\n"
+ .'### [](#)Sample success responses'."\n"
."\n"
- .' {'."\n"
- .' '."\n"
- .' "requestId": "65911539-5a8b-4bce-96a5-4d608900dc46",'."\n"
- .' '."\n"
- .' "result": []'."\n"
- .' '."\n"
- .' }'."\n"
+ .'```json'."\n"
+ .'{'."\n"
+ .' "requestId": "0A6EB64B-B4C8-CF02-810F-E660812972FF",'."\n"
+ .' "result": []'."\n"
+ .'}'."\n"
+ .'```'."\n"
."\n"
.'For more information, see [Response structure](~~465311~~).'."\n",
- ],
- 'ModifyIndexPartition' => [
- 'summary' => 'Modifies the information about index partitions.',
- 'path' => '/openapi/ha3/instances/{instanceId}/index-partition',
- 'methods' => [
- 'put',
- ],
- 'schemes' => [
- 'https',
- 'http',
- ],
- 'security' => [
- [
- 'AK' => [],
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteDataSource'],
],
],
- 'operationType' => 'write',
- 'deprecated' => false,
- 'systemTags' => [],
- 'parameters' => [
- [
- 'name' => 'instanceId',
- 'in' => 'path',
- 'schema' => [
- 'description' => 'The instance ID.'."\n",
- 'type' => 'string',
- 'required' => true,
- 'example' => 'ha-cn-7mz2ttxta01',
- ],
- ],
+ 'ramActions' => [
[
- 'name' => 'body',
- 'in' => 'body',
- 'style' => 'json',
- 'schema' => [
- 'description' => 'The request body.'."\n",
- 'type' => 'object',
- 'properties' => [
- 'dataSourceName' => [
- 'title' => '数据源名称',
- 'description' => 'The name of the data source.'."\n",
- 'type' => 'string',
- 'required' => false,
- 'example' => 'test1',
- ],
- 'generation' => [
- 'title' => 'generation 主键',
- 'description' => 'The primary key.'."\n",
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => false,
- 'example' => '1633293829',
- ],
- 'domainName' => [
- 'title' => '机房',
- 'description' => 'The data center.'."\n",
- 'type' => 'string',
- 'required' => false,
- 'example' => 'pre_domain_1',
- ],
- 'indexInfos' => [
- 'title' => '索引分片信息',
- 'description' => 'The index information.'."\n",
- 'type' => 'array',
- 'items' => [
- 'description' => 'The information about each index.'."\n",
- 'type' => 'object',
- 'properties' => [
- 'indexName' => [
- 'title' => '索引名称',
- 'description' => 'The index name.'."\n",
- 'type' => 'string',
- 'required' => false,
- 'example' => 'atest2',
- ],
- 'partitionCount' => [
- 'title' => '分片数',
- 'description' => 'The number of shards.'."\n",
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'example' => '3',
- ],
- 'parallelNum' => [
- 'title' => '并发数，默认是 1',
- 'description' => 'The concurrency. Default value: 1.'."\n",
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'example' => '1',
- ],
- ],
- 'required' => false,
- ],
- 'required' => false,
- ],
- ],
- 'required' => false,
- ],
- ],
- ],
- 'responses' => [
- 200 => [
- 'schema' => [
- 'type' => 'object',
- 'properties' => [
- 'requestId' => [
- 'title' => 'id of request',
- 'description' => 'id of request'."\n",
- 'type' => 'string',
- 'example' => '93A9E542-8CF8-5BA6-99AB-94C0FE520429',
- ],
- 'result' => [
- 'title' => 'Map',
- 'description' => 'Map'."\n",
- 'type' => 'object',
- 'example' => '[]',
- ],
+ 'operationType' => '',
+ 'ramAction' => [
+ 'action' => 'searchengine:DeleteDataSource',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SearchEngine', 'resourceType' => 'Instance', 'arn' => 'acs:searchengine:{#regionId}:{#accountId}:instance/{#InstanceId}'],
],
- 'description' => '',
],
],
- 500 => [],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"93A9E542-8CF8-5BA6-99AB-94C0FE520429\\",\\n \\"result\\": []\\n}","type":"json"}]',
- 'title' => 'ModifyIndexPartition',
- 'description' => '### Method'."\n"
- ."\n"
- .'`PUT`'."\n"
- ."\n"
- .'### URI'."\n"
- ."\n"
- .'`/openapi/ha3/instances/{instanceId}/index-partition`'."\n",
- 'requestParamsDescription' => '### Example'."\n"
- ."\n"
- .'`PUT /openapi/ha3/instances/{instanceId}/index-partition`'."\n"
- ."\n"
- .' {'."\n"
- .' "dataSourceName":"ha-cn-pl32n3bi904_d",'."\n"
- .' "domainName":"pre_domain_1",'."\n"
- .' "generation":"1633293829",'."\n"
- .' "indexInfos":['."\n"
- .' {'."\n"
- .' "indexName":"atest2",'."\n"
- .' "partitionCount":2'."\n"
- .' }'."\n"
- .' ]'."\n"
- .' }'."\n",
- 'responseParamsDescription' => '### [](#)Sample responses'."\n"
- ."\n"
- .' {'."\n"
- .' "requestId": "0A6EB64B-B4C8-CF02-810F-E660812972FF",'."\n"
- .' "result": []'."\n"
- .' }'."\n"
- ."\n"
- .'For more information, see [Response structure](~~465311~~).'."\n",
],
- 'GetIndex' => [
- 'summary' => 'Queries the information about an index version.',
- 'path' => '/openapi/ha3/instances/{instanceId}/indexes/{indexName}',
- 'methods' => [
- 'get',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
+ 'DeleteFolder' => [
+ 'path' => '/openapi/ha3/instances/{instanceId}/sql-studio/databases/{database}/folders/{folderId}',
+ 'methods' => ['delete'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
- 'operationType' => 'read',
+ 'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
- 'operationType' => 'get',
- 'abilityTreeCode' => '104685',
- 'abilityTreeNodes' => [
- 'FEATUREopensearchJB31XH',
- ],
+ 'operationType' => 'delete',
+ 'abilityTreeCode' => '138810',
+ 'abilityTreeNodes' => ['FEATUREopensearch95VJR4'],
],
'parameters' => [
[
'name' => 'instanceId',
'in' => 'path',
- 'schema' => [
- 'description' => 'The instance ID.'."\n",
- 'type' => 'string',
- 'required' => true,
- 'example' => 'ha-cn-8ed2j834u03',
- ],
+ 'schema' => ['description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'ha-cn-pl32rf0****'],
],
[
- 'name' => 'indexName',
+ 'name' => 'database',
'in' => 'path',
- 'schema' => [
- 'description' => 'The index name.'."\n",
- 'type' => 'string',
- 'required' => true,
- 'example' => 'index_jiayi_text',
- ],
+ 'schema' => ['description' => 'The database name.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'general'],
+ ],
+ [
+ 'name' => 'folderId',
+ 'in' => 'path',
+ 'schema' => ['description' => 'The folder ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'title' => '', 'example' => '-1'],
],
],
'responses' => [
@@ -5126,713 +2665,70 @@
'schema' => [
'type' => 'object',
'properties' => [
- 'requestId' => [
- 'title' => 'id of request',
- 'description' => 'The request ID.'."\n",
- 'type' => 'string',
- 'example' => '4FB0325E-8C37-5525-96AC-0333523170A3',
- ],
+ 'requestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '022F36C7-9FB4-5D67-BEBC-3D14B0984463'],
'result' => [
- 'title' => 'IndexConfig',
- 'description' => 'The index information.'."\n",
+ 'title' => '',
+ 'description' => 'The returned result.',
'type' => 'object',
'properties' => [
- 'name' => [
- 'title' => '配置名称',
- 'description' => 'The index name.'."\n",
- 'type' => 'string',
- 'example' => 'general',
- ],
- 'versions' => [
- 'title' => '版本列表',
- 'description' => 'The information about the versions.'."\n",
- 'type' => 'array',
- 'items' => [
- 'description' => '',
- 'type' => 'object',
- 'properties' => [
- 'desc' => [
- 'title' => '描述',
- 'description' => 'The description of the version.'."\n",
- 'type' => 'string',
- 'example' => 'close alarm, by 3.9.2 hotfix workflow',
- ],
- 'files' => [
- 'title' => '文件名列表',
- 'description' => 'The information about the files.'."\n",
- 'type' => 'array',
- 'items' => [
- 'description' => '',
- 'type' => 'object',
- 'properties' => [
- 'fullPathName' => [
- 'description' => 'The full path of the file.'."\n",
- 'type' => 'string',
- 'example' => '" "',
- ],
- 'isDir' => [
- 'description' => 'Indicates whether the file is a directory.'."\n",
- 'type' => 'boolean',
- 'example' => 'True',
- ],
- 'isTemplate' => [
- 'description' => 'Indicates whether the file is a template.'."\n",
- 'type' => 'boolean',
- 'example' => 'True',
- ],
- 'name' => [
- 'description' => 'The file name.'."\n",
- 'type' => 'string',
- 'example' => 'qrs.json',
- ],
- ],
- ],
- ],
- 'name' => [
- 'title' => '版本名',
- 'description' => 'The version name.'."\n",
- 'type' => 'string',
- 'example' => 'ha-cn-7pp2ngv4s02_qrs',
- ],
- 'status' => [
- 'title' => 'drafting、used、unused (drafting: 草稿, used: 线上使用, unused:未使用, trash: 删除中)',
- 'description' => 'The status of the index version. Valid values:'."\n"
- ."\n"
- .'* NEW: The index version is created.'."\n"
- .'* PUBLISH: The index version is normal.'."\n"
- .'* IN_USE: The index version is in use.'."\n"
- .'* NOT_USE: The index version is not used.'."\n"
- .'* STOP_USE: The index version is being stopped.'."\n"
- .'* RESTORE_USE: The index version is being restored.'."\n"
- .'* FAIL: The index version failed to be created.'."\n",
- 'type' => 'string',
- 'example' => '2',
- ],
- 'updateTime' => [
- 'title' => '更新时间',
- 'description' => 'The time when the index version was updated.'."\n",
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '" "',
- ],
- 'versionId' => [
- 'title' => '版本id (edit版本为null)',
- 'description' => 'The version ID.'."\n",
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '1',
- ],
- ],
- ],
- ],
- 'dataSource' => [
- 'title' => '数据源',
- 'description' => 'The name of the data source.'."\n",
- 'type' => 'string',
- 'example' => 'ha-cn-tl32nd2nq01_00',
- ],
- 'domain' => [
- 'title' => '数据源的部署名',
- 'description' => 'The deployment name of the index.'."\n",
- 'type' => 'string',
- 'example' => 'sz_vpc_domain_1',
- ],
- 'indexStatus' => [
- 'title' => '表状态 (NEW, PUBLISH, IN_USE: 召回引擎版创建成功后为正常状态, NOT_USE, STOP_USE,RESTORE_USE)',
- 'description' => 'The status of the index version. Valid values:'."\n"
- ."\n"
- .'* NEW: The index version is created.'."\n"
- .'* PUBLISH: The index version is normal.'."\n"
- .'* IN_USE: The index version is in use.'."\n"
- .'* NOT_USE: The index version is not used.'."\n"
- .'* STOP_USE: The index version is being stopped.'."\n"
- .'* RESTORE_USE: The index version is being restored.'."\n"
- .'* FAIL: The index version failed to be created.'."\n",
- 'type' => 'string',
- 'example' => 'IN_USE',
- ],
- 'content' => [
- 'title' => '文件内容',
- 'description' => 'The file content.'."\n",
- 'type' => 'string',
- 'example' => '{"summarys":{"parameter":{"file_compressor":"zstd"},"summary_fields":["id"]},"file_compress":[{"name":"file_compressor","type":"zstd"},{"name":"no_compressor","type":""}],"indexs":[{"index_fields":"name","index_name":"ids","index_type":"STRING"},{"has_primary_key_attribute":true,"index_fields":"id","is_primary_key_sorted":false,"index_name":"id","index_type":"PRIMARYKEY64"}],"attributes":[{"file_compress":"no_compressor","field_name":"id"}],"fields":[{"user_defined_param":{},"compress_type":"uniq","field_type":"STRING","field_name":"id"},{"compress_type":"uniq","field_type":"STRING","field_name":"name"}],"table_name":"api"}',
- ],
- 'partition' => [
- 'title' => '数据分片',
- 'description' => 'The number of shards.'."\n",
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '2',
- ],
- 'fullVersion' => [
- 'title' => '数据版本',
- 'description' => 'The data version.'."\n",
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '1688523414',
- ],
- 'fullUpdateTime' => [
- 'title' => '全量切换时间',
- 'description' => 'The time when full data in the index was last updated.'."\n",
- 'type' => 'string',
- 'example' => '2024-06-20 08:52:54',
- ],
- 'incUpdateTime' => [
- 'title' => '增量更新时间',
- 'description' => 'The time when incremental data in the index was last updated.'."\n",
- 'type' => 'string',
- 'example' => '2024-06-20 08:52:54',
- ],
- 'indexSize' => [
- 'title' => '索引大小',
- 'description' => 'The index size.'."\n",
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '4689',
- ],
- 'description' => [
- 'title' => '备注',
- 'description' => 'The description of the index version.'."\n",
- 'type' => 'string',
- 'example' => 'test index',
- ],
- 'dataSourceInfo' => [
- 'title' => '数据源相关信息',
- 'description' => 'The information about the data source.'."\n",
- 'type' => 'object',
- 'properties' => [
- 'processPartitionCount' => [
- 'title' => '数据更新资源数',
- 'description' => 'The number of resources used for data update.'."\n",
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '2',
- ],
- 'name' => [
- 'title' => '数据源名',
- 'description' => 'The name of the data source.'."\n",
- 'type' => 'string',
- 'example' => 'ha-cn-pl32rf0****_test_api'."\n",
- ],
- 'type' => [
- 'title' => '数据源类型 (odps, swift, saro, oss, unKnow)',
- 'description' => 'The type of the data source. Valid values: odps, swift, saro, oss, and unKnow.'."\n",
- 'type' => 'string',
- 'example' => 'odps',
- ],
- 'domain' => [
- 'title' => '离线部署',
- 'description' => 'The data center in which the data source is deployed.'."\n",
- 'type' => 'string',
- 'example' => 'vpc_hz_domain_1',
- ],
- 'config' => [
- 'title' => 'odps 数据源配置',
- 'description' => 'The configuration of MaxCompute data sources.'."\n",
- 'type' => 'object',
- 'properties' => [
- 'endpoint' => [
- 'title' => 'odps相关',
- 'description' => 'The endpoint of the MaxCompute data source.'."\n",
- 'type' => 'string',
- 'example' => 'http://service.cn-hangzhou.maxcompute.aliyun-inc.com/api',
- ],
- 'accessKey' => [
- 'description' => 'The AccessKey ID of the MaxCompute data source.'."\n",
- 'type' => 'string',
- 'example' => 'L***p',
- ],
- 'accessSecret' => [
- 'description' => 'The AccessKey secret of the MaxCompute data source.'."\n",
- 'type' => 'string',
- 'example' => '5**9a6',
- ],
- 'project' => [
- 'description' => 'The name of the MaxCompute project that is used as the data source.'."\n",
- 'type' => 'string',
- 'example' => 'tisplus_dev',
- ],
- 'partition' => [
- 'description' => 'The partition in the MaxCompute table. Example: ds=20180102.'."\n",
- 'type' => 'string',
- 'example' => 'ds=20220713',
- ],
- 'table' => [
- 'title' => 'saro、odps相关',
- 'description' => 'The name of the MaxCompute table that is used as the data source.'."\n",
- 'type' => 'string',
- 'example' => 'dump_odps_demo',
- ],
- 'namespace' => [
- 'title' => 'saro相关',
- 'description' => 'The namespace. This parameter is applicable to the SARO data source used in the intranet of Alibaba Group.'."\n",
- 'type' => 'string',
- 'example' => 'TEST_dump_demo_sj_na61hunbu2_share_holo',
- ],
- 'path' => [
- 'title' => 'hdfs相关',
- 'description' => 'The file path in the Apsara File Storage for HDFS file system.'."\n",
- 'type' => 'string',
- 'example' => 'http://test_opensearch/sift_oss_test.data',
- ],
- 'ossPath' => [
- 'title' => 'oss数据源相关',
- 'description' => 'The Object Storage Service (OSS) path.'."\n",
- 'type' => 'string',
- 'example' => '/test_opensearch/sift_oss_test.data',
- ],
- 'bucket' => [
- 'description' => 'The name of the OSS bucket.'."\n",
- 'type' => 'string',
- 'example' => 'ha3test-oss',
- ],
- 'format' => [
- 'type' => 'string',
- ],
- 'catalog' => [
- 'type' => 'string',
- ],
- 'database' => [
- 'type' => 'string',
- ],
- 'tag' => [
- 'type' => 'string',
- ],
- ],
- ],
- 'saroConfig' => [
- 'title' => 'saro数据源配置',
- 'description' => 'The configurations of the SARO data source.'."\n",
- 'type' => 'object',
- 'properties' => [
- 'namespace' => [
- 'description' => 'The namespace of the SARO data source.'."\n",
- 'type' => 'string',
- 'example' => 'TEST_dump_demo_sj_na61hunbu2_share_holo',
- ],
- 'tableName' => [
- 'description' => 'The name of the SARO table.'."\n",
- 'type' => 'string',
- 'example' => 'llm',
- ],
- ],
- ],
- 'autoBuildIndex' => [
- 'title' => '是否开启自动全量',
- 'description' => 'Indicates whether the automatic full indexing feature is enabled.'."\n",
- 'type' => 'boolean',
- 'example' => 'true',
- ],
- 'processParallelNum' => [
- 'description' => 'The maximum number of full indexes that can be concurrently processed.'."\n",
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '2',
- ],
- ],
- ],
- 'createTime' => [
- 'type' => 'string',
- ],
- 'updateTime' => [
- 'type' => 'string',
- ],
- 'cluster' => [
- 'description' => 'The cluster information.'."\n",
- 'type' => 'object',
- 'additionalProperties' => [
- 'type' => 'object',
- 'properties' => [
- 'buildParallelNum' => [
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '2',
- 'description' => 'The maximum number of full indexes that can be concurrently built.'."\n",
- ],
- 'mergeParallelNum' => [
- 'type' => 'integer',
- 'format' => 'int32',
- 'description' => 'The maximum number of full indexes that can be concurrently merged.'."\n",
- 'example' => '2',
- ],
- ],
- 'description' => 'The cluster information.'."\n",
- ],
- ],
- 'config' => [
- 'description' => 'The configuration information.'."\n",
- 'type' => 'object',
- 'additionalProperties' => [
- 'type' => 'object',
- 'additionalProperties' => [
- 'type' => 'object',
- 'properties' => [
- 'name' => [
- 'type' => 'string',
- 'example' => "\n"
- .'ha-cn-pl32rf0****_offline_adv_v1',
- 'description' => 'The configuration name.'."\n",
- ],
- 'updateTime' => [
- 'type' => 'string',
- 'description' => 'The time when the configuration was updated.'."\n",
- 'example' => '1716258634000',
- ],
- 'desc' => [
- 'type' => 'string',
- 'description' => 'The description of the advanced configuration.'."\n",
- 'example' => 'Description'."\n",
- ],
- ],
- 'description' => 'The information about the child configuration item.'."\n",
- ],
- 'description' => 'The configuration information.'."\n",
- ],
- ],
- 'configWhenBuild' => [
- 'description' => 'The configuration that takes effect next time.'."\n",
- 'type' => 'object',
- 'additionalProperties' => [
- 'type' => 'object',
- 'additionalProperties' => [
- 'type' => 'object',
- 'properties' => [
- 'name' => [
- 'type' => 'string',
- 'description' => 'The configuration name.'."\n",
- 'example' => "\n"
- .'ha-cn-pl32rf0****_offline_adv_v1',
- ],
- 'updateTime' => [
- 'type' => 'string',
- 'example' => '1716258634000',
- 'description' => 'The time when the configuration was updated.'."\n",
- ],
- 'desc' => [
- 'type' => 'string',
- 'description' => 'The description of the advanced configuration.'."\n",
- 'example' => 'Description'."\n",
- ],
- ],
- 'description' => 'The child configuration item that takes effect next time.'."\n",
- ],
- 'description' => 'The configuration that takes effect next time.'."\n",
- ],
- ],
- 'extend' => [
- 'description' => 'Extended information'."\n",
+ 'result' => [
+ 'description' => 'The returned result.',
'type' => 'object',
- 'additionalProperties' => [
- 'type' => 'array',
- 'items' => [
- 'type' => 'string',
- 'description' => 'Extended information'."\n",
- 'example' => 'Extended information'."\n",
- ],
- 'description' => 'Extended information'."\n",
- ],
+ 'additionalProperties' => ['type' => 'string', 'description' => 'The deletion result.', 'title' => '', 'example' => '{}'],
+ 'title' => '',
+ 'example' => '',
],
+ 'requestId' => ['description' => 'The request ID.', 'type' => 'string', 'title' => '', 'example' => '022F36C7-9FB4-5D67-BEBC-3D14B0984463'],
],
+ 'example' => '',
],
],
'description' => '',
+ 'title' => '',
+ 'example' => '',
],
],
- '5xx' => [
- 'schema' => [
- 'type' => 'object',
- 'properties' => [
- 'requestId' => [
- 'type' => 'string',
- ],
- 'message' => [
- 'type' => 'string',
- ],
- 'code' => [
- 'type' => 'string',
- ],
- ],
- ],
- ],
+ 500 => [],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"4FB0325E-8C37-5525-96AC-0333523170A3\\",\\n \\"result\\": {\\n \\"name\\": \\"test_api\\",\\n \\"versions\\": [\\n {\\n \\"desc\\": \\"Index Note\\",\\n \\"files\\": [\\n {\\n \\"fullPathName\\": \\"/qrs.json\\\\n\\",\\n \\"isDir\\": true,\\n \\"isTemplate\\": true,\\n \\"name\\": \\"qrs.json\\"\\n }\\n ],\\n \\"name\\": \\"test\\",\\n \\"status\\": \\"PUBLISH\\",\\n \\"updateTime\\": 1718846192,\\n \\"versionId\\": 1\\n }\\n ],\\n \\"dataSource\\": \\"ha-cn-pl32rf0****_test_api\\\\n\\",\\n \\"domain\\": \\"sz_vpc_domain_1\\",\\n \\"indexStatus\\": \\"IN_USE\\",\\n \\"content\\": \\"{\\\\\\"summarys\\\\\\":{\\\\\\"parameter\\\\\\":{\\\\\\"file_compressor\\\\\\":\\\\\\"zstd\\\\\\"},\\\\\\"summary_fields\\\\\\":[\\\\\\"id\\\\\\"]},\\\\\\"file_compress\\\\\\":[{\\\\\\"name\\\\\\":\\\\\\"file_compressor\\\\\\",\\\\\\"type\\\\\\":\\\\\\"zstd\\\\\\"},{\\\\\\"name\\\\\\":\\\\\\"no_compressor\\\\\\",\\\\\\"type\\\\\\":\\\\\\"\\\\\\"}],\\\\\\"indexs\\\\\\":[{\\\\\\"index_fields\\\\\\":\\\\\\"name\\\\\\",\\\\\\"index_name\\\\\\":\\\\\\"ids\\\\\\",\\\\\\"index_type\\\\\\":\\\\\\"STRING\\\\\\"},{\\\\\\"has_primary_key_attribute\\\\\\":true,\\\\\\"index_fields\\\\\\":\\\\\\"id\\\\\\",\\\\\\"is_primary_key_sorted\\\\\\":false,\\\\\\"index_name\\\\\\":\\\\\\"id\\\\\\",\\\\\\"index_type\\\\\\":\\\\\\"PRIMARYKEY64\\\\\\"}],\\\\\\"attributes\\\\\\":[{\\\\\\"file_compress\\\\\\":\\\\\\"no_compressor\\\\\\",\\\\\\"field_name\\\\\\":\\\\\\"id\\\\\\"}],\\\\\\"fields\\\\\\":[{\\\\\\"user_defined_param\\\\\\":{},\\\\\\"compress_type\\\\\\":\\\\\\"uniq\\\\\\",\\\\\\"field_type\\\\\\":\\\\\\"STRING\\\\\\",\\\\\\"field_name\\\\\\":\\\\\\"id\\\\\\"},{\\\\\\"compress_type\\\\\\":\\\\\\"uniq\\\\\\",\\\\\\"field_type\\\\\\":\\\\\\"STRING\\\\\\",\\\\\\"field_name\\\\\\":\\\\\\"name\\\\\\"}],\\\\\\"table_name\\\\\\":\\\\\\"api\\\\\\"}\\",\\n \\"partition\\": 2,\\n \\"fullVersion\\": 1688523414,\\n \\"fullUpdateTime\\": \\"2024-06-20 08:52:54\\",\\n \\"incUpdateTime\\": \\"2024-06-20 08:52:54\\",\\n \\"indexSize\\": 4689,\\n \\"description\\": \\"note\\",\\n \\"dataSourceInfo\\": {\\n \\"processPartitionCount\\": 2,\\n \\"name\\": \\"ha-cn-pl32rf0****_test_api\\\\n\\",\\n \\"type\\": \\"odps\\",\\n \\"domain\\": \\"vpc_hz_domain_1\\",\\n \\"config\\": {\\n \\"endpoint\\": \\"http://service.cn-hangzhou.maxcompute.aliyun-inc.com/api\\",\\n \\"accessKey\\": \\"L***p\\",\\n \\"accessSecret\\": \\"5**9a6\\",\\n \\"project\\": \\"tisplus_dev\\",\\n \\"partition\\": \\"ds=20220713\\",\\n \\"table\\": \\"dump_odps_demo\\",\\n \\"namespace\\": \\"TEST_dump_demo_sj_na61hunbu2_share_holo\\",\\n \\"path\\": \\"http://test_opensearch/sift_oss_test.data\\",\\n \\"ossPath\\": \\"/test_opensearch/sift_oss_test.data\\",\\n \\"bucket\\": \\"ha3test-oss\\",\\n \\"format\\": \\"ha3\\",\\n \\"catalog\\": \\"clg-paimon-21cc136237a6457f8618f5f82d116d7e\\",\\n \\"database\\": \\"dlf_test\\",\\n \\"tag\\": \\"test_tag\\"\\n },\\n \\"saroConfig\\": {\\n \\"namespace\\": \\"TEST_dump_demo_sj_na61hunbu2_share_holo\\",\\n \\"tableName\\": \\"llm\\"\\n },\\n \\"autoBuildIndex\\": true,\\n \\"processParallelNum\\": 2\\n },\\n \\"createTime\\": \\"2024-05-21 16:05:26\\",\\n \\"updateTime\\": \\"2024-05-21 16:05:26\\",\\n \\"cluster\\": {\\n \\"key\\": {\\n \\"buildParallelNum\\": 2,\\n \\"mergeParallelNum\\": 2\\n }\\n },\\n \\"config\\": {\\n \\"key\\": {\\n \\"key\\": {\\n \\"name\\": \\"\\\\nha-cn-pl32rf0****_offline_adv_v1\\",\\n \\"updateTime\\": \\"1716258634000\\",\\n \\"desc\\": \\"Note Information\\"\\n }\\n }\\n },\\n \\"configWhenBuild\\": {\\n \\"key\\": {\\n \\"key\\": {\\n \\"name\\": \\"\\\\nha-cn-pl32rf0****_offline_adv_v1\\",\\n \\"updateTime\\": \\"1716258634000\\",\\n \\"desc\\": \\"Note Information\\"\\n }\\n }\\n },\\n \\"extend\\": {\\n \\"key\\": [\\n \\"Extended Information\\"\\n ]\\n }\\n }\\n}","type":"json"}]',
- 'title' => 'GetIndex',
- 'description' => '## [](#)Method'."\n"
- ."\n"
- .' GET'."\n"
- ."\n"
- .'## [](#uri)URI'."\n"
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"022F36C7-9FB4-5D67-BEBC-3D14B0984463\\",\\n \\"result\\": {\\n \\"result\\": {\\n \\"key\\": \\"{}\\"\\n },\\n \\"requestId\\": \\"022F36C7-9FB4-5D67-BEBC-3D14B0984463\\"\\n }\\n}","type":"json"}]',
+ 'title' => 'DeleteFolder',
+ 'summary' => 'Deletes a folder.',
+ 'description' => '### Method'."\n"
."\n"
- .' /openapi/ha3/instances/{instanceId}/indexes/{indexName}'."\n",
- 'responseParamsDescription' => '## [](#)Sample responses'."\n"
+ .'```java'."\n"
+ .'DELETE'."\n"
+ .'```'."\n"
."\n"
- .'Sample success response'."\n"
+ .'### URI'."\n"
."\n"
- .' {'."\n"
- .' "requestId": "e1eef569-1ff7-4bf8-acf7-1cecca9894ce",'."\n"
- .' "result": {'."\n"
- .' "name": "index-name",'."\n"
- .' "dataSource": "ha-cn-xxx-index-name",'."\n"
- .' "domain": "test", // The name of the data source.'."\n"
- .' "partition": 2,'."\n"
- .' "indexStatus": "IN_USE",'."\n"
- .' "content": "{\\n\\t\\"summarys\\":{\\n\\t\\t\\"parameter\\":{\\n\\t\\t\\t\\"file_compressor\\":\\"zstd\\"\\n\\t\\t},\\n\\t\\t\\"summary_fields\\":[\\n\\t\\t\\t\\"id\\"\\n\\t\\t]\\n\\t},\\n\\t\\"file_compress\\":[\\n\\t\\t{\\n\\t\\t\\t\\"name\\":\\"file_compressor\\",\\n\\t\\t\\t\\"type\\":\\"zstd\\"\\n\\t\\t},\\n\\t\\t{\\n\\t\\t\\t\\"name\\":\\"no_compressor\\",\\n\\t\\t\\t\\"type\\":\\"\\"\\n\\t\\t}\\n\\t],\\n\\t\\"indexs\\":[\\n\\t\\t{\\n\\t\\t\\t\\"index_fields\\":\\"name\\",\\n\\t\\t\\t\\"index_name\\":\\"ids\\",\\n\\t\\t\\t\\"index_type\\":\\"STRING\\"\\n\\t\\t},\\n\\t\\t{\\n\\t\\t\\t\\"has_primary_key_attribute\\":true,\\n\\t\\t\\t\\"index_fields\\":\\"id\\",\\n\\t\\t\\t\\"is_primary_key_sorted\\":false,\\n\\t\\t\\t\\"index_name\\":\\"id\\",\\n\\t\\t\\t\\"index_type\\":\\"PRIMARYKEY64\\"\\n\\t\\t}\\n\\t],\\n\\t\\"attributes\\":[\\n\\t\\t{\\n\\t\\t\\t\\"file_compress\\":\\"no_compressor\\",\\n\\t\\t\\t\\"field_name\\":\\"id\\"\\n\\t\\t}\\n\\t],\\n\\t\\"fields\\":[\\n\\t\\t{\\n\\t\\t\\t\\"user_defined_param\\":{},\\n\\t\\t\\t\\"compress_type\\":\\"uniq\\",\\n\\t\\t\\t\\"field_type\\":\\"STRING\\",\\n\\t\\t\\t\\"field_name\\":\\"id\\"\\n\\t\\t},\\n\\t\\t{\\n\\t\\t\\t\\"compress_type\\":\\"uniq\\",\\n\\t\\t\\t\\"field_type\\":\\"STRING\\",\\n\\t\\t\\t\\"field_name\\":\\"name\\"\\n\\t\\t}\\n\\t],\\n\\t\\"table_name\\":\\"api\\"\\n}",'."\n"
- .' "extend": {'."\n"
- .' "vector": ['."\n"
- .' "vector"'."\n"
- .' ],'."\n"
- .' "embeding": ['."\n"
- .' "id"'."\n"
- .' ],'."\n"
- .' "description": ['."\n"
- .' "{\\"feild2\\":\\"Note 2\\"}",'."\n"
- .' "{\\"feild3\\":\\"Note 3\\"}"'."\n"
- .' ]'."\n"
- .' },'."\n"
- .' "cluster": {'."\n"
- .' "build_parallel_num": "2",'."\n"
- .' "merge_parallel_num": "2"'."\n"
- .' },'."\n"
- .' "dataSourceInfo": {'."\n"
- .' "type": "odps",'."\n"
- .' "dataSource": "ha-cn-xxx-index-name",'."\n"
- .' "processPartitionCount": 2,'."\n"
- .' "domain": "test",'."\n"
- .' "autoBuildIndex": true,'."\n"
- .' "config": {'."\n"
- .' "project": "tisplus_dev",'."\n"
- .' "table": "tisplus_one_key_build_station_template_table_test",'."\n"
- .' "partition": "ds=12345",'."\n"
- .' "accesskeyId": "root",'."\n"
- .' "accesskeySecret": "root123",'."\n"
- .' "endpoint": "http://service.cn-hangzhou.maxcompute.aliyun-inc.com/api"'."\n"
- .' },'."\n"
- .' "saroConfig": {'."\n"
- .' "namespace": "TEST_dump_demo_sj_na61hunbu2_share_holo",'."\n"
- .' "tableName": "dump_odps_demo"'."\n"
- .' },'."\n"
- .' "processParallelNum": 2,'."\n"
- .' "swiftConfig":{'."\n"
- .' "topic":"ha-cn-xxx-index-name"'."\n"
- .' }'."\n"
- .' },'."\n"
- .' "config": {'."\n"
- .' "OFFLINE_DICT": {'."\n"
- .' "name": "ha-cn-finxmo71065_offline_dict_v2",'."\n"
- .' "updateTime": 1709259817000,'."\n"
- .' "desc": "Description"'."\n"
- .' },'."\n"
- .' "OFFLINE_TABLE": {'."\n"
- .' "name": "ha-cn-finxmo71065_table_ha-cn-finxmo71065_test_saro_v2",'."\n"
- .' "updateTime": 1709261682000,'."\n"
- .' "desc": "Description"'."\n"
- .' },'."\n"
- .' "OFFLINE_COMMON": {'."\n"
- .' "name": "ha-cn-finxmo71065_offline_adv_v2",'."\n"
- .' "updateTime": 1709259817000,'."\n"
- .' "desc": "Description"'."\n"
- .' },'."\n"
- .' "OFFLINE_PLUGIN": {'."\n"
- .' "name": "ha-cn-finxmo71065_offline_plugin_v2",'."\n"
- .' "updateTime": 1709259817000,'."\n"
- .' "desc": "Description"'."\n"
- .' },'."\n"
- .' "OFFLINE_INDEX": {'."\n"
- .' "name": "ha-cn-finxmo71065@ha-cn-finxmo71065_test_saro@test_saro@index_config_v2",'."\n"
- .' "updateTime": 1709259817000,'."\n"
- .' "desc": "Description"'."\n"
- .' }'."\n"
- .' },'."\n"
- .' "configWhenBuild": {'."\n"
- .' "OFFLINE_DICT": {'."\n"
- .' "name": "ha-cn-finxmo71065_offline_dict_v2",'."\n"
- .' "updateTime": 1709259817000,'."\n"
- .' "desc": "Description"'."\n"
- .' },'."\n"
- .' "OFFLINE_TABLE": {'."\n"
- .' "name": "ha-cn-finxmo71065_table_ha-cn-finxmo71065_test_saro_v2",'."\n"
- .' "updateTime": 1709261682000,'."\n"
- .' "desc": "Description"'."\n"
- .' },'."\n"
- .' "OFFLINE_COMMON": {'."\n"
- .' "name": "ha-cn-finxmo71065_offline_adv_v2",'."\n"
- .' "updateTime": 1709259817000,'."\n"
- .' "desc": "Description"'."\n"
- .' },'."\n"
- .' "OFFLINE_PLUGIN": {'."\n"
- .' "name": "ha-cn-finxmo71065_offline_plugin_v2",'."\n"
- .' "updateTime": 1709259817000,'."\n"
- .' "desc": "Description"'."\n"
- .' },'."\n"
- .' "OFFLINE_INDEX": {'."\n"
- .' "name": "ha-cn-finxmo71065@ha-cn-finxmo71065_test_saro@test_saro@index_config_v2",'."\n"
- .' "updateTime": 1709259817000,'."\n"
- .' "desc": "Description"'."\n"
- .' }'."\n"
- .' }'."\n"
- .' }'."\n",
- ],
- 'GetIndexVersion' => [
- 'summary' => 'Queries the information about index versions that the current index version can be rolled back to.',
- 'path' => '/openapi/ha3/instances/{instanceId}/clusters/{clusterName}/index-version',
- 'methods' => [
- 'get',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
- 'security' => [
- [
- 'AK' => [],
+ .'```java'."\n"
+ .'/openapi/ha3/instances/{instanceId}/sql-studio/databases/{database}/folders/{folderId}'."\n"
+ .'```',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteFolder'],
],
],
- 'operationType' => 'read',
- 'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'get',
- ],
- 'parameters' => [
- [
- 'name' => 'instanceId',
- 'in' => 'path',
- 'schema' => [
- 'description' => 'The instance ID.'."\n",
- 'type' => 'string',
- 'required' => true,
- 'example' => 'ha-cn-2r42ostoc01',
- ],
- ],
+ 'ramActions' => [
[
- 'name' => 'clusterName',
- 'in' => 'path',
- 'schema' => [
- 'description' => 'The name of the cluster'."\n",
- 'type' => 'string',
- 'required' => true,
- 'example' => 'vpc_hz_domain_1',
- ],
- ],
- ],
- 'responses' => [
- 200 => [
- 'schema' => [
- 'description' => 'The response parameters.'."\n",
- 'type' => 'object',
- 'properties' => [
- 'requestId' => [
- 'title' => 'id of request',
- 'description' => 'id of request'."\n",
- 'type' => 'string',
- 'example' => 'E7B7D598-B080-5C8E-AA35-D43EC0D5F886',
- ],
- 'result' => [
- 'title' => 'ClusterIndexVersion',
- 'description' => 'The clusters.'."\n",
- 'type' => 'object',
- 'properties' => [
- 'cluster' => [
- 'description' => 'The cluster name.'."\n",
- 'type' => 'string',
- 'example' => 'ayoss-cn-zhangjiakou-b',
- ],
- 'indexVersions' => [
- 'description' => 'The index versions.'."\n",
- 'type' => 'array',
- 'items' => [
- 'description' => 'The list of index versions'."\n",
- 'type' => 'object',
- 'properties' => [
- 'indexName' => [
- 'description' => 'The name of the index table.'."\n",
- 'type' => 'string',
- 'example' => 'table4',
- ],
- 'versions' => [
- 'description' => 'The index versions.'."\n",
- 'type' => 'array',
- 'items' => [
- 'description' => 'The index version.'."\n",
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '1',
- ],
- ],
- 'buildDeployId' => [
- 'description' => 'The ID of the offline deployment.'."\n",
- 'type' => 'string',
- 'example' => '" "',
- ],
- 'currentVersion' => [
- 'description' => 'The current online version number.'."\n",
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '1',
- ],
- ],
- ],
- ],
- ],
- ],
+ 'operationType' => 'delete',
+ 'ramAction' => [
+ 'action' => 'searchengine:DeleteFolder',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SearchEngine', 'resourceType' => 'Folder', 'arn' => 'acs:searchengine:{#regionId}:{#accountId}:instance/{#InstanceId}'],
],
],
],
- 500 => [],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"E7B7D598-B080-5C8E-AA35-D43EC0D5F886\\",\\n \\"result\\": {\\n \\"cluster\\": \\"hz_pre_vpc_domain_1\\",\\n \\"indexVersions\\": [\\n {\\n \\"indexName\\": \\"test_api\\",\\n \\"versions\\": [\\n 1630353700\\n ],\\n \\"buildDeployId\\": \\"2648\\",\\n \\"currentVersion\\": 1\\n }\\n ]\\n }\\n}","type":"json"}]',
- 'title' => 'GetIndexVersion',
- 'description' => '## Method'."\n"
- ."\n"
- .' GET'."\n"
- ."\n"
- .'## URI'."\n"
- ."\n"
- .' /openapi/ha3/instances/{instanceId}/clusters/{clusterName}/index-version'."\n",
- 'requestParamsDescription' => '## Examples'."\n"
- ."\n"
- .'Sample requests'."\n"
- ."\n"
- .' GET /openapi/ha3/instances/ha3_instance_id_1/clusters/cluster1/index-version'."\n",
- 'responseParamsDescription' => '## Sample responses'."\n"
- ."\n"
- .'Success responses'."\n"
- ."\n"
- .' {'."\n"
- .' "requestId": "e1eef569-1ff7-4bf8-acf7-1cecca9894ce",'."\n"
- .' "result": {'."\n"
- .' "cluster": "ea119cloud",'."\n"
- .' "indexVersions": ['."\n"
- .' {'."\n"
- .' "versions": ['."\n"
- .' 1630527077,'."\n"
- .' 1630440554'."\n"
- .' ],'."\n"
- .' "currentVersion":1630527077,'."\n"
- .' "indexName": "ihome_lapp_content_filter_param_index",'."\n"
- .' "buildDeployId": "2837"'."\n"
- .' },'."\n"
- .' {'."\n"
- .' "versions": ['."\n"
- .' 1630353700'."\n"
- .' ],'."\n"
- .' "currentVersion":1630353700, '."\n"
- .' "indexName": "ihome_lapp_case_tab_filter",'."\n"
- .' "buildDeployId": "2829"'."\n"
- .' }'."\n"
- .' ]'."\n"
- .' }'."\n"
- .' }'."\n",
],
- 'GetFile' => [
- 'summary' => 'Queries the details of an index table version.',
- 'path' => '/openapi/ha3/instances/{instanceId}/indexes/{indexName}/versions/{versionName}/file',
- 'methods' => [
- 'get',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
+ 'DeleteIndex' => [
+ 'summary' => 'Deletes an index.',
+ 'path' => '/openapi/ha3/instances/{instanceId}/indexes/{indexName}',
+ 'methods' => ['delete'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
@@ -5840,171 +2736,96 @@
],
'operationType' => 'read',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'get',
- 'abilityTreeCode' => '104689',
- 'abilityTreeNodes' => [
- 'FEATUREopensearch8WJIRU',
- ],
- ],
+ 'systemTags' => [],
'parameters' => [
[
'name' => 'instanceId',
'in' => 'path',
- 'schema' => [
- 'title' => '实例ID',
- 'description' => 'The instance ID.'."\n",
- 'type' => 'string',
- 'required' => true,
- 'example' => 'ha-cn-i7m2rpzm605',
- ],
+ 'schema' => ['title' => '', 'description' => 'The instance ID.'."\n", 'type' => 'string', 'required' => true, 'example' => 'ha-cn-pl32rf0****'],
],
[
'name' => 'indexName',
'in' => 'path',
- 'schema' => [
- 'title' => '索引名称',
- 'description' => 'The index name.'."\n",
- 'type' => 'string',
- 'required' => true,
- 'example' => 'ecmon_table_index_test',
- ],
+ 'schema' => ['title' => '', 'description' => 'The index name.'."\n", 'type' => 'string', 'required' => true, 'example' => 'test_api'],
],
[
- 'name' => 'versionName',
- 'in' => 'path',
- 'schema' => [
- 'title' => '版本名称',
- 'description' => 'The version name.'."\n",
- 'type' => 'string',
- 'required' => true,
- 'example' => 'ha-cn-tl32nd2nq01@ha-cn-tl32nd2nq01_00@bj_vpc_domain_1@point_cloud_3d@index_config_edit',
- ],
+ 'name' => 'dataSource',
+ 'in' => 'query',
+ 'schema' => ['title' => '', 'description' => 'The data source.'."\n", 'type' => 'string', 'required' => true, 'example' => 'ha-cn-pl32rf0****_ test_api'],
],
[
- 'name' => 'fileName',
+ 'name' => 'deleteDataSource',
'in' => 'query',
- 'schema' => [
- 'title' => '文件全路径名称',
- 'description' => 'The name of the file in full path'."\n",
- 'type' => 'string',
- 'required' => true,
- 'example' => '/schemas/automobile_vector_schema.json',
- ],
+ 'schema' => ['description' => 'Specifies whether to delete the data source.'."\n", 'type' => 'boolean', 'required' => false, 'example' => 'true', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
- 'title' => 'Schema of Response',
+ 'title' => '',
'description' => 'Schema of Response'."\n",
'type' => 'object',
'properties' => [
- 'requestId' => [
- 'title' => 'id of request',
- 'description' => 'The request ID.'."\n",
- 'type' => 'string',
- 'example' => '2AE63638-5420-56DC-BF59-37D8174039A0',
- ],
- 'result' => [
- 'title' => '索引信息',
- 'description' => 'The index information.'."\n",
- 'type' => 'object',
- 'properties' => [
- 'name' => [
- 'title' => '文件名称',
- 'description' => 'The file name.'."\n",
- 'type' => 'string',
- 'example' => 'ha-cn-2r42ostoc01_qrs',
- ],
- 'fullPathName' => [
- 'title' => '全路径名称',
- 'description' => 'The full path of the file.'."\n",
- 'type' => 'string',
- 'example' => '""',
- ],
- 'dataSource' => [
- 'title' => '数据源',
- 'description' => 'The data source.'."\n",
- 'type' => 'string',
- 'example' => 'ha-cn-2r42p5oi202_xijie_test',
- ],
- 'partition' => [
- 'title' => '分片数',
- 'description' => 'The number of shards.'."\n",
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => 'ds=20210828',
- ],
- 'isDir' => [
- 'title' => '是否为目录',
- 'description' => 'Indicates whether the file is a directory.'."\n",
- 'type' => 'boolean',
- 'example' => 'True',
- ],
- 'content' => [
- 'title' => '内容',
- 'description' => 'The file content.'."\n",
- 'type' => 'string',
- 'example' => 'None',
- ],
- 'extend' => [
- 'type' => 'object',
- 'additionalProperties' => [
- 'type' => 'array',
- 'items' => [
- 'type' => 'string',
- 'description' => 'Extended information',
- ],
- 'description' => 'Extended information'."\n",
- ],
- 'description' => 'Extended information',
- ],
- ],
- ],
+ 'requestId' => ['title' => '', 'description' => 'id of request'."\n", 'type' => 'string', 'example' => '022F36C7-9FB4-5D67-BEBC-3D14B0984463'],
+ 'result' => ['title' => '', 'description' => 'The information about the index'."\n", 'type' => 'object', 'example' => '{}'],
],
+ 'example' => '',
],
],
500 => [],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"2AE63638-5420-56DC-BF59-37D8174039A0\\",\\n \\"result\\": {\\n \\"name\\": \\"testFile\\",\\n \\"fullPathName\\": \\"/schema.json\\",\\n \\"dataSource\\": \\"ha-cn-pl32rf0****_test_api\\",\\n \\"partition\\": 2,\\n \\"isDir\\": true,\\n \\"content\\": \\"{\\\\\\"summarys\\\\\\":{\\\\\\"parameter\\\\\\":{\\\\\\"file_compressor\\\\\\":\\\\\\"zstd\\\\\\"},\\\\\\"summary_fields\\\\\\":[\\\\\\"id\\\\\\"]},\\\\\\"file_compress\\\\\\":[{\\\\\\"name\\\\\\":\\\\\\"file_compressor\\\\\\",\\\\\\"type\\\\\\":\\\\\\"zstd\\\\\\"},{\\\\\\"name\\\\\\":\\\\\\"no_compressor\\\\\\",\\\\\\"type\\\\\\":\\\\\\"\\\\\\"}],\\\\\\"indexs\\\\\\":[{\\\\\\"index_fields\\\\\\":\\\\\\"name\\\\\\",\\\\\\"index_name\\\\\\":\\\\\\"ids\\\\\\",\\\\\\"index_type\\\\\\":\\\\\\"STRING\\\\\\"},{\\\\\\"has_primary_key_attribute\\\\\\":true,\\\\\\"index_fields\\\\\\":\\\\\\"id\\\\\\",\\\\\\"is_primary_key_sorted\\\\\\":false,\\\\\\"index_name\\\\\\":\\\\\\"id\\\\\\",\\\\\\"index_type\\\\\\":\\\\\\"PRIMARYKEY64\\\\\\"}],\\\\\\"attributes\\\\\\":[{\\\\\\"file_compress\\\\\\":\\\\\\"no_compressor\\\\\\",\\\\\\"field_name\\\\\\":\\\\\\"id\\\\\\"}],\\\\\\"fields\\\\\\":[{\\\\\\"user_defined_param\\\\\\":{},\\\\\\"compress_type\\\\\\":\\\\\\"uniq\\\\\\",\\\\\\"field_type\\\\\\":\\\\\\"STRING\\\\\\",\\\\\\"field_name\\\\\\":\\\\\\"id\\\\\\"},{\\\\\\"compress_type\\\\\\":\\\\\\"uniq\\\\\\",\\\\\\"field_type\\\\\\":\\\\\\"STRING\\\\\\",\\\\\\"field_name\\\\\\":\\\\\\"name\\\\\\"}],\\\\\\"table_name\\\\\\":\\\\\\"api\\\\\\"}\\",\\n \\"extend\\": {\\n \\"key\\": [\\n \\"\\"\\n ]\\n }\\n }\\n}","type":"json"}]',
- 'title' => 'GetFile',
- 'description' => '## [](#)Method'."\n"
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"022F36C7-9FB4-5D67-BEBC-3D14B0984463\\",\\n \\"result\\": {}\\n}","type":"json"}]',
+ 'title' => 'DeleteIndex',
+ 'description' => '## Method'."\n"
."\n"
- .' GET'."\n"
+ .' DELETE'."\n"
."\n"
- .'## [](#uri)URI'."\n"
+ .'## URI'."\n"
."\n"
- .' /openapi/ha3/instances/{instanceId}/indexes/{indexName}/versions/{versionName}/file'."\n",
+ .' /openapi/ha3/instances/{instanceId}/indexes/{indexName}?dataSource=xxx'."\n",
'requestParamsDescription' => '## Sample requests'."\n"
."\n"
- .' GET /openapi/ha3/instances/ose-test1/indexes/index1/versions/version1?fileName=/root/test.txt'."\n",
+ .''."\n"
+ ."\n"
+ .' DELETE /openapi/ha3/instances/ose-test1/indexes/my_index?dataSource=xxx'."\n",
'responseParamsDescription' => '## Sample responses'."\n"
."\n"
- .'Success responses'."\n"
+ .'Success responses '."\n"
."\n"
.' {'."\n"
- .' "requestId": "e1eef569-1ff7-4bf8-acf7-1cecca9894ce",'."\n"
- .' "result": {'."\n"
- .' "name":"version1", // The file name'."\n"
- .' "fullPathName": "/root/version1", // The name of the full path'."\n"
- .' "dataSource": "odps1", // The data source'."\n"
- .' "partition": 1, // The number of shards'."\n"
- .' "isDir": false, // Indicates whether it is a directory.'."\n"
- .' "content": ""'."\n"
- .' }'."\n"
- .' }'."\n",
- ],
- 'ListIndexes' => [
- 'summary' => 'Obtains the index list.',
- 'path' => '/openapi/ha3/instances/{instanceId}/indexes',
- 'methods' => [
- 'get',
+ .' '."\n"
+ .' "requestId": "65911539-5a8b-4bce-96a5-4d608900dc46",'."\n"
+ .' '."\n"
+ .' "result": []'."\n"
+ .' '."\n"
+ .' }'."\n"
+ ."\n"
+ .'For more information, see [Response struct](~~464322~~).',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteIndex'],
+ ],
],
- 'schemes' => [
- 'http',
- 'https',
+ 'ramActions' => [
+ [
+ 'operationType' => '',
+ 'ramAction' => [
+ 'action' => 'searchengine:DeleteIndex',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SearchEngine', 'resourceType' => 'Instance', 'arn' => 'acs:searchengine:{#regionId}:{#accountId}:instance/{#InstanceId}'],
+ ],
+ ],
+ ],
],
+ ],
+ 'DeleteIndexVersion' => [
+ 'summary' => 'Deletes the version of an index.',
+ 'path' => '/openapi/ha3/instances/{instanceId}/indexes/{indexName}/versions/{versionName}',
+ 'methods' => ['delete'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
@@ -6012,429 +2833,91 @@
],
'operationType' => 'read',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'list',
- 'abilityTreeCode' => '104683',
- 'abilityTreeNodes' => [
- 'FEATUREopensearchA944AC',
- 'FEATUREopensearchS8X6T8',
- ],
- ],
+ 'systemTags' => [],
'parameters' => [
[
'name' => 'instanceId',
'in' => 'path',
- 'schema' => [
- 'description' => 'The instance ID.'."\n",
- 'type' => 'string',
- 'required' => true,
- 'example' => 'ha-cn-2r42ostoc01',
- ],
- ],
- [
- 'name' => 'newMode',
- 'in' => 'query',
- 'schema' => [
- 'description' => 'Specifies whether the OpenSearch Vector Search Edition instance is of the new version.'."\n",
- 'type' => 'boolean',
- 'required' => false,
- 'example' => 'true',
- ],
+ 'schema' => ['title' => '', 'description' => 'The instance ID.'."\n", 'type' => 'string', 'required' => true, 'example' => 'ha-cn-pl32rf0****'],
],
[
- 'name' => 'catalog',
- 'in' => 'query',
- 'schema' => [
- 'type' => 'string',
- ],
- ],
- [
- 'name' => 'database',
- 'in' => 'query',
- 'schema' => [
- 'type' => 'string',
- ],
+ 'name' => 'indexName',
+ 'in' => 'path',
+ 'schema' => ['title' => '', 'description' => 'The index name.'."\n", 'type' => 'string', 'required' => true, 'example' => 'test_api'],
],
[
- 'name' => 'table',
- 'in' => 'query',
- 'schema' => [
- 'type' => 'string',
- ],
+ 'name' => 'versionName',
+ 'in' => 'path',
+ 'schema' => ['title' => '', 'description' => 'The name of the version.'."\n", 'type' => 'string', 'required' => true, 'example' => 'ha-cn-pl32rf0****@ha-cn-pl32rf0****_shenzhen_test_01@sz_vpc_domain_1@api_test@index_config_v1'],
],
],
'responses' => [
200 => [
'schema' => [
- 'description' => 'The response parameters.'."\n",
+ 'title' => '',
+ 'description' => 'Schema of Response'."\n",
'type' => 'object',
'properties' => [
- 'requestId' => [
- 'title' => 'id of request',
- 'description' => 'The request ID.'."\n",
- 'type' => 'string',
- 'example' => '4FB0325E-8C37-5525-96AC-0333523170A3',
- ],
- 'result' => [
- 'title' => 'List',
- 'description' => 'The details of indexes.'."\n",
- 'type' => 'array',
- 'items' => [
- 'description' => 'The list of index details.'."\n",
- 'type' => 'object',
- 'properties' => [
- 'name' => [
- 'title' => '配置名称',
- 'description' => 'The index name.'."\n",
- 'type' => 'string',
- 'example' => 'general',
- ],
- 'versions' => [
- 'title' => '版本列表',
- 'description' => 'The index versions.'."\n",
- 'type' => 'array',
- 'items' => [
- 'description' => 'The version of the index.'."\n",
- 'type' => 'object',
- 'properties' => [
- 'desc' => [
- 'title' => '描述',
- 'description' => 'The description of the index version.'."\n",
- 'type' => 'string',
- 'example' => 'close alarm, by 3.9.2 hotfix workflow',
- ],
- 'files' => [
- 'title' => '文件名列表',
- 'description' => 'The files.'."\n",
- 'type' => 'array',
- 'items' => [
- 'description' => 'The version information.'."\n",
- 'type' => 'object',
- 'properties' => [
- 'fullPathName' => [
- 'description' => 'The full path of the file.'."\n",
- 'type' => 'string',
- 'example' => '" "',
- ],
- 'isDir' => [
- 'description' => 'Indicates whether the file is a directory.'."\n",
- 'type' => 'boolean',
- 'example' => 'True',
- ],
- 'isTemplate' => [
- 'description' => 'Indicates whether the file is a template.'."\n",
- 'type' => 'boolean',
- 'example' => 'True',
- ],
- 'name' => [
- 'description' => 'The file name.'."\n",
- 'type' => 'string',
- 'example' => 'ha-cn-7mz2iv7sq01_qrs',
- ],
- ],
- ],
- ],
- 'name' => [
- 'title' => '版本名',
- 'description' => 'The name of the index version.'."\n",
- 'type' => 'string',
- 'example' => 'ha-cn-7pp2ngv4s02_qrs',
- ],
- 'status' => [
- 'title' => 'drafting、used、unused (drafting: 草稿, used: 线上使用,unused: 未使用, trash: 删除中)',
- 'description' => 'The status of the index version. Valid values:'."\n"
- ."\n"
- .'* NEW: The index version is created.'."\n"
- .'* PUBLISH: The index version is normal.'."\n"
- .'* IN_USE: The index version is in use.'."\n"
- .'* NOT_USE: The index version is not used.'."\n"
- .'* STOP_USE: The index version is being stopped.'."\n"
- .'* RESTORE_USE: The index version is being restored.'."\n"
- .'* FAIL: The index version failed to be created.'."\n",
- 'type' => 'string',
- 'example' => '2',
- ],
- 'updateTime' => [
- 'title' => '更新时间',
- 'description' => 'The time when the index version was updated.'."\n",
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '" "',
- ],
- 'versionId' => [
- 'title' => '版本id (edit版本为null)',
- 'description' => 'The ID of the index version. If the index version is modified, the returned value is null.'."\n",
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '1',
- ],
- ],
- ],
- ],
- 'dataSource' => [
- 'title' => '数据源',
- 'description' => 'The name of the data source.'."\n",
- 'type' => 'string',
- 'example' => 'ha-cn-7mz2kvu2c01_table4',
- ],
- 'domain' => [
- 'title' => '数据源的部署名',
- 'description' => 'The deployment name of the index.'."\n",
- 'type' => 'string',
- 'example' => 'test',
- ],
- 'indexStatus' => [
- 'title' => '表状态 (NEW, PUBLISH, IN_USE: 召回引擎版创建成功后为正常状态, NOT_USE, STOP_USE,RESTORE_USE)',
- 'description' => 'The index ststus. Valid values: NEW and PUBLISH.'."\n",
- 'type' => 'string',
- 'example' => '" "',
- ],
- 'content' => [
- 'title' => '文件内容',
- 'description' => 'The index schema, which is a JSON string.'."\n",
- 'type' => 'string',
- 'example' => '{"summarys":{"parameter":{"file_compressor":"zstd"},"summary_fields":["id"]},"file_compress":[{"name":"file_compressor","type":"zstd"},{"name":"no_compressor","type":""}],"indexs":[{"index_fields":"name","index_name":"ids","index_type":"STRING"},{"has_primary_key_attribute":true,"index_fields":"id","is_primary_key_sorted":false,"index_name":"id","index_type":"PRIMARYKEY64"}],"attributes":[{"file_compress":"no_compressor","field_name":"id"}],"fields":[{"user_defined_param":{},"compress_type":"uniq","field_type":"STRING","field_name":"id"},{"compress_type":"uniq","field_type":"STRING","field_name":"name"}],"table_name":"api"}',
- ],
- 'partition' => [
- 'title' => '数据分片',
- 'description' => 'The number of shards.'."\n",
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '2',
- ],
- 'fullVersion' => [
- 'title' => '数据版本',
- 'description' => 'The full version of the index.'."\n",
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '1688523414',
- ],
- 'fullUpdateTime' => [
- 'title' => '全量切换时间',
- 'description' => 'The time when full data in the index was last updated.'."\n",
- 'type' => 'string',
- 'example' => '2023-07-05 10:40:38',
- ],
- 'incUpdateTime' => [
- 'title' => '增量更新时间',
- 'description' => 'The time when incremental data in the index was last updated.'."\n",
- 'type' => 'string',
- 'example' => '2023-07-05 10:58:33',
- ],
- 'indexSize' => [
- 'title' => '索引大小',
- 'description' => 'The index size.'."\n",
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '4689',
- ],
- 'description' => [
- 'title' => '备注',
- 'description' => 'The description.'."\n",
- 'type' => 'string',
- 'example' => 'Description'."\n",
- ],
- 'dataSourceInfo' => [
- 'title' => '数据源相关信息',
- 'description' => 'The information about the data source.'."\n",
- 'type' => 'object',
- 'properties' => [
- 'processPartitionCount' => [
- 'title' => '数据更新资源数',
- 'description' => 'The number of resources used for data update.'."\n",
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '2',
- ],
- 'name' => [
- 'title' => '数据源名',
- 'description' => 'The name of the data source.'."\n",
- 'type' => 'string',
- 'example' => 'index1',
- ],
- 'type' => [
- 'title' => '数据源类型 (odps, swift, saro, oss, unKnow)',
- 'description' => 'The type of the data source. Valid values: odps, swift, saro, oss, and unKnow.'."\n",
- 'type' => 'string',
- 'example' => 'odps',
- ],
- 'domain' => [
- 'title' => '离线部署',
- 'description' => 'The data center in which the data source is deployed.'."\n",
- 'type' => 'string',
- 'example' => 'test',
- ],
- 'config' => [
- 'title' => 'odps 数据源配置',
- 'description' => 'The configuration of MaxCompute data sources.'."\n",
- 'type' => 'object',
- 'properties' => [
- 'endpoint' => [
- 'title' => 'odps相关',
- 'description' => 'The endpoint of the MaxCompute data source.'."\n",
- 'type' => 'string',
- 'example' => 'http://service.cn-hangzhou.maxcompute.aliyun-inc.com/api',
- ],
- 'accessKey' => [
- 'description' => 'The AccessKey ID of the MaxCompute data source.'."\n",
- 'type' => 'string',
- 'example' => 'root',
- ],
- 'accessSecret' => [
- 'description' => 'The AccessKey secret of the MaxCompute data source.'."\n",
- 'type' => 'string',
- 'example' => 'root123',
- ],
- 'project' => [
- 'description' => 'The name of the MaxCompute project that is used as the data source.'."\n",
- 'type' => 'string',
- 'example' => 'tisplus_dev',
- ],
- 'partition' => [
- 'description' => 'The shard name.'."\n",
- 'type' => 'string',
- 'example' => 'ds=12345',
- ],
- 'table' => [
- 'title' => 'saro、odps相关',
- 'description' => 'The name of the MaxCompute table that is used as the data source.'."\n",
- 'type' => 'string',
- 'example' => 'dump_odps_demo',
- ],
- 'namespace' => [
- 'title' => 'saro相关',
- 'description' => 'The namespace. This parameter is applicable to the SARO data source used in the intranet of Alibaba Group.'."\n",
- 'type' => 'string',
- 'example' => 'TEST_dump_demo_sj_na61hunbu2_share_holo',
- ],
- 'path' => [
- 'title' => 'hdfs相关',
- 'description' => 'The file path in the Apsara File Storage for HDFS file system.'."\n",
- 'type' => 'string',
- 'example' => 'http://test_opensearch/sift_oss_test.data',
- ],
- 'ossPath' => [
- 'title' => 'oss数据源相关',
- 'description' => 'The Object Storage Service (OSS) path.'."\n",
- 'type' => 'string',
- 'example' => '/test_opensearch/sift_oss_test.data',
- ],
- 'bucket' => [
- 'description' => 'The OSS bucket.'."\n",
- 'type' => 'string',
- 'example' => 'ha3test-oss',
- ],
- 'format' => [
- 'type' => 'string',
- ],
- 'catalog' => [
- 'type' => 'string',
- ],
- 'database' => [
- 'type' => 'string',
- ],
- 'tag' => [
- 'type' => 'string',
- ],
- ],
- ],
- 'saroConfig' => [
- 'title' => 'saro数据源配置',
- 'description' => 'The configurations of the SARO data source.'."\n",
- 'type' => 'object',
- 'properties' => [
- 'namespace' => [
- 'description' => 'The namespace of the SARO data source.'."\n",
- 'type' => 'string',
- 'example' => 'TEST_dump_demo_sj_na61hunbu2_share_holo',
- ],
- 'tableName' => [
- 'description' => 'The name of the SARO table.'."\n",
- 'type' => 'string',
- 'example' => 'dump_odps_demo',
- ],
- ],
- ],
- 'autoBuildIndex' => [
- 'title' => '是否开启自动全量',
- 'description' => 'Indicates whether the automatic full indexing feature is enabled.'."\n",
- 'type' => 'boolean',
- 'example' => 'true',
- ],
- ],
- ],
- 'createTime' => [
- 'type' => 'string',
- ],
- 'updateTime' => [
- 'type' => 'string',
- ],
- ],
- ],
- ],
+ 'requestId' => ['title' => '', 'description' => 'id of request'."\n", 'type' => 'string', 'example' => '022F36C7-9FB4-5D67-BEBC-3D14B0984463'],
+ 'result' => ['title' => '', 'description' => 'The result'."\n", 'type' => 'object', 'example' => '{}'],
],
+ 'example' => '',
],
],
500 => [],
],
- 'eventInfo' => [
- 'enable' => false,
- 'eventNames' => [],
- ],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"4FB0325E-8C37-5525-96AC-0333523170A3\\",\\n \\"result\\": [\\n {\\n \\"name\\": \\"general\\",\\n \\"versions\\": [\\n {\\n \\"desc\\": \\"Index Note\\",\\n \\"files\\": [\\n {\\n \\"fullPathName\\": \\"/qrs.json\\\\n\\",\\n \\"isDir\\": true,\\n \\"isTemplate\\": true,\\n \\"name\\": \\"qrs.json\\\\n\\"\\n }\\n ],\\n \\"name\\": \\"test\\",\\n \\"status\\": \\"PUBLISH\\",\\n \\"updateTime\\": 0,\\n \\"versionId\\": 1\\n }\\n ],\\n \\"dataSource\\": \\"ha-cn-pl32rf0****_test_api\\",\\n \\"domain\\": \\"vpc_hz_domain_1\\",\\n \\"indexStatus\\": \\"PUBLISH\\",\\n \\"content\\": \\"{\\\\\\"summarys\\\\\\":{\\\\\\"parameter\\\\\\":{\\\\\\"file_compressor\\\\\\":\\\\\\"zstd\\\\\\"},\\\\\\"summary_fields\\\\\\":[\\\\\\"id\\\\\\"]},\\\\\\"file_compress\\\\\\":[{\\\\\\"name\\\\\\":\\\\\\"file_compressor\\\\\\",\\\\\\"type\\\\\\":\\\\\\"zstd\\\\\\"},{\\\\\\"name\\\\\\":\\\\\\"no_compressor\\\\\\",\\\\\\"type\\\\\\":\\\\\\"\\\\\\"}],\\\\\\"indexs\\\\\\":[{\\\\\\"index_fields\\\\\\":\\\\\\"name\\\\\\",\\\\\\"index_name\\\\\\":\\\\\\"ids\\\\\\",\\\\\\"index_type\\\\\\":\\\\\\"STRING\\\\\\"},{\\\\\\"has_primary_key_attribute\\\\\\":true,\\\\\\"index_fields\\\\\\":\\\\\\"id\\\\\\",\\\\\\"is_primary_key_sorted\\\\\\":false,\\\\\\"index_name\\\\\\":\\\\\\"id\\\\\\",\\\\\\"index_type\\\\\\":\\\\\\"PRIMARYKEY64\\\\\\"}],\\\\\\"attributes\\\\\\":[{\\\\\\"file_compress\\\\\\":\\\\\\"no_compressor\\\\\\",\\\\\\"field_name\\\\\\":\\\\\\"id\\\\\\"}],\\\\\\"fields\\\\\\":[{\\\\\\"user_defined_param\\\\\\":{},\\\\\\"compress_type\\\\\\":\\\\\\"uniq\\\\\\",\\\\\\"field_type\\\\\\":\\\\\\"STRING\\\\\\",\\\\\\"field_name\\\\\\":\\\\\\"id\\\\\\"},{\\\\\\"compress_type\\\\\\":\\\\\\"uniq\\\\\\",\\\\\\"field_type\\\\\\":\\\\\\"STRING\\\\\\",\\\\\\"field_name\\\\\\":\\\\\\"name\\\\\\"}],\\\\\\"table_name\\\\\\":\\\\\\"api\\\\\\"}\\",\\n \\"partition\\": 2,\\n \\"fullVersion\\": 1688523414,\\n \\"fullUpdateTime\\": \\"2023-07-05 10:40:38\\",\\n \\"incUpdateTime\\": \\"2023-07-05 10:58:33\\",\\n \\"indexSize\\": 4689,\\n \\"description\\": \\"note\\",\\n \\"dataSourceInfo\\": {\\n \\"processPartitionCount\\": 2,\\n \\"name\\": \\"ha-cn-pl32rf0****_test_api\\",\\n \\"type\\": \\"odps\\",\\n \\"domain\\": \\"vpc_hz_domain_2\\",\\n \\"config\\": {\\n \\"endpoint\\": \\"http://service.cn-hangzhou.maxcompute.aliyun-inc.com/api\\",\\n \\"accessKey\\": \\"L***p\\",\\n \\"accessSecret\\": \\"5**9a6\\",\\n \\"project\\": \\"tisplus_dev\\",\\n \\"partition\\": \\"ds=20231220\\",\\n \\"table\\": \\"dump_odps_demo\\",\\n \\"namespace\\": \\"TEST_dump_demo_sj_na61hunbu2_share_holo\\",\\n \\"path\\": \\"http://test_opensearch/sift_oss_test.data\\",\\n \\"ossPath\\": \\"/test_opensearch/sift_oss_test.data\\",\\n \\"bucket\\": \\"ha3test-oss\\",\\n \\"format\\": \\"ha3\\",\\n \\"catalog\\": \\"clg-paimon-21cc136237a6457f8618f5f82d116d7e\\",\\n \\"database\\": \\"dlf_test\\",\\n \\"tag\\": \\"test_tag\\"\\n },\\n \\"saroConfig\\": {\\n \\"namespace\\": \\"TEST_dump_demo_sj_na61hunbu2_share_holo\\",\\n \\"tableName\\": \\"dump_odps_demo\\"\\n },\\n \\"autoBuildIndex\\": true\\n },\\n \\"createTime\\": \\"2024-05-21 16:05:26\\",\\n \\"updateTime\\": \\"2024-05-21 16:05:26\\"\\n }\\n ]\\n}","type":"json"}]',
- 'title' => 'ListIndexes',
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"022F36C7-9FB4-5D67-BEBC-3D14B0984463\\",\\n \\"result\\": {}\\n}","type":"json"}]',
+ 'title' => 'DeleteIndexVersion',
'description' => '## Method'."\n"
."\n"
- .' GET'."\n"
+ .' DELETE'."\n"
."\n"
.'## URI'."\n"
."\n"
- .' /openapi/ha3/instances/{instanceId}/indexes'."\n",
+ .' /openapi/ha3/instances/{instanceId}/indexes/{indexName}/versions/{versionName}'."\n",
'requestParamsDescription' => '## Sample requests'."\n"
."\n"
.''."\n"
."\n"
- .' GET /openapi/ha3/instances/ose-test1/indexes'."\n",
- 'responseParamsDescription' => '## Sample responses'."\n"
+ .' DELETE /openapi/ha3/instances/ose-test1/indexes/my_index/versions/version1'."\n",
+ 'responseParamsDescription' => '## [](#)Sample responses'."\n"
."\n"
- .'Success responses '."\n"
+ .'Sample success responses'."\n"
."\n"
.' {'."\n"
- .' '."\n"
- .' "requestId": "38b079f1-7846-4226-8c90-3e2644b5c52b",'."\n"
- .' '."\n"
- .' "result": ['."\n"
- .' '."\n"
- .' {'."\n"
- .' '."\n"
- .' "name": "index1",'."\n"
- .' '."\n"
- .' "dataSource": "test_yyds_data1",'."\n"
- .' '."\n"
- .' },'."\n"
- .' '."\n"
- .' {'."\n"
- .' '."\n"
- .' "name": "index1",'."\n"
- .' '."\n"
- .' "dataSource": "test_yyds_data1",'."\n"
- .' '."\n"
- .' }'."\n"
- .' '."\n"
- .' ]'."\n"
- .' '."\n"
- .' }'."\n",
- ],
- 'RecoverIndex' => [
- 'summary' => 'Restores data from an index.',
- 'path' => '/openapi/ha3/instances/{instanceId}/recover-index',
- 'methods' => [
- 'post',
+ .' '."\n"
+ .' "requestId": "65911539-5a8b-4bce-96a5-4d608900dc46",'."\n"
+ .' '."\n"
+ .' "result": []'."\n"
+ .' '."\n"
+ .' }'."\n"
+ ."\n"
+ .'For more information, see [Response structure](~~465311~~).'."\n",
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteIndexVersion'],
+ ],
],
- 'schemes' => [
- 'http',
- 'https',
+ 'ramActions' => [
+ [
+ 'operationType' => '',
+ 'ramAction' => [
+ 'action' => 'searchengine:DeleteIndexVersion',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SearchEngine', 'resourceType' => 'Instance', 'arn' => 'acs:searchengine:{#regionId}:{#accountId}:instance/{#InstanceId}'],
+ ],
+ ],
+ ],
],
+ ],
+ 'DeleteInstance' => [
+ 'summary' => 'Deletes a specified instance.',
+ 'path' => '/openapi/ha3/instances/{instanceId}',
+ 'methods' => ['delete'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
@@ -6442,209 +2925,102 @@
],
'operationType' => 'write',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'update',
- 'abilityTreeCode' => '144320',
- 'abilityTreeNodes' => [
- 'FEATUREopensearchVHEWK3',
- ],
- ],
+ 'systemTags' => ['operationType' => 'delete'],
'parameters' => [
[
'name' => 'instanceId',
'in' => 'path',
- 'schema' => [
- 'description' => 'The instance ID.'."\n",
- 'type' => 'string',
- 'required' => true,
- 'example' => 'ha-cn-zvp2jlr2g03',
- ],
+ 'schema' => ['title' => '', 'description' => 'The instance ID.'."\n", 'type' => 'string', 'required' => true, 'example' => 'ha-cn-pl32rf0****'],
],
- [
- 'name' => 'body',
- 'in' => 'body',
- 'style' => 'json',
+ ],
+ 'responses' => [
+ 200 => [
'schema' => [
- 'description' => 'The request body.'."\n",
+ 'title' => '',
+ 'description' => 'Schema of Response'."\n",
'type' => 'object',
'properties' => [
- 'dataSourceName' => [
- 'title' => '数据源名称',
- 'description' => 'The name of the data source.'."\n",
- 'type' => 'string',
- 'required' => false,
- 'example' => 'ha-cn-pl32rf0js04_odps_first',
- ],
- 'indexName' => [
- 'title' => '索引名称',
- 'description' => 'The index name.'."\n",
- 'type' => 'string',
- 'required' => false,
- 'example' => 'main_index',
- ],
- 'generation' => [
- 'title' => 'generation',
- 'description' => 'The ID of the full index version.'."\n",
- 'type' => 'string',
- 'required' => false,
- 'example' => '1653018575',
- ],
- 'buildDeployId' => [
- 'title' => 'buildDeployId',
- 'description' => 'The deployment ID of the data source.'."\n",
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'example' => '277',
- ],
+ 'requestId' => ['title' => '', 'description' => 'The ID of the request'."\n", 'type' => 'string', 'example' => 'E45380E8-994A-5402-9806-F114B3295FCF'],
+ 'result' => ['description' => 'The result returned'."\n", 'type' => 'object', 'example' => '{}', 'title' => ''],
],
- 'required' => false,
+ 'example' => '',
],
],
- ],
- 'responses' => [
- 200 => [
+ 500 => [
'schema' => [
'type' => 'object',
'properties' => [
- 'requestId' => [
- 'title' => 'id of request',
- 'description' => 'The ID of the request.',
- 'type' => 'string',
- 'example' => '10D5E615-69F7-5F49-B850-00169ADE513C',
- ],
- 'result' => [
- 'title' => 'Map',
- 'description' => 'The result returned by data search.',
- 'type' => 'object',
- 'example' => '{}',
- ],
+ 'requestId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''],
+ 'message' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''],
+ 'code' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''],
],
'description' => '',
+ 'title' => '',
+ 'example' => '',
],
],
- 500 => [],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"10D5E615-69F7-5F49-B850-00169ADE513C\\",\\n \\"result\\": {}\\n}","type":"json"}]',
- 'title' => 'RecoverIndex',
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"E45380E8-994A-5402-9806-F114B3295FCF\\",\\n \\"result\\": {}\\n}","type":"json"}]',
+ 'title' => 'DeleteInstance',
'description' => '### Method'."\n"
."\n"
- .'`POST`'."\n"
+ .'`DELETE`'."\n"
."\n"
.'### URI'."\n"
."\n"
- .'`/openapi/ha3/instances/{instanceId}/recover-index`'."\n",
+ .'`/openapi/ha3/instances/{instanceId}`'."\n",
'requestParamsDescription' => '### Sample requests'."\n"
."\n"
- .'`POST /openapi/ha3/instances/ha3_instances_id/recover-index`'."\n"
+ .'**Change the instance name**'."\n"
+ ."\n"
+ .'`DELETE /openapi/ha3/instances/ha3-cn-xxxxxx`'."\n",
+ 'responseParamsDescription' => '### [](#)Sample responses'."\n"
+ ."\n"
+ .'**Sample success responses**'."\n"
."\n"
.' {'."\n"
- .' "generation": "1653018575",'."\n"
- .' "dataSourceName":"test_yyds_data1",'."\n"
- .' "buildDeployId":277,'."\n"
- .' "indexName":"index_1"'."\n"
- .' }'."\n",
- ],
- 'CreateConfigDir' => [
- 'path' => '/openapi/ha3/instances/{instanceId}/advanced-configs/{configName}/dir',
- 'methods' => [
- 'post',
- ],
- 'schemes' => [
- 'https',
- 'http',
- ],
- 'security' => [
- [
- 'AK' => [],
+ .' "result": { },'."\n"
+ .' "requestId": "90D6B8F5-FE97-4509-9AAB-367836C51818"'."\n"
+ .' }'."\n"
+ ."\n"
+ .'**Sample error responses**'."\n"
+ ."\n"
+ .'```'."\n"
+ ."\n"
+ .'{'."\n"
+ .' "requestId": "BD1EA715-DF6F-06C2-004C-C1FA0D3A9820",'."\n"
+ .' "httpCode": 404,'."\n"
+ .' "code": "App.NotFound",'."\n"
+ .' "message": "App not found"'."\n"
+ .'}'."\n"
+ .'```'."\n"
+ ."\n"
+ .'For more information, see [Response structure](~~465311~~).'."\n",
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteInstance'],
],
],
- 'operationType' => 'write',
- 'deprecated' => false,
- 'systemTags' => [],
- 'parameters' => [
- [
- 'name' => 'instanceId',
- 'in' => 'path',
- 'schema' => [
- 'description' => 'The instance ID.'."\n",
- 'type' => 'string',
- 'required' => true,
- 'example' => 'ha-cn-7mz2iv7sq01',
- ],
- ],
+ 'ramActions' => [
[
- 'name' => 'configName',
- 'in' => 'path',
- 'schema' => [
- 'description' => 'The configuration name.'."\n",
- 'type' => 'string',
- 'required' => true,
- 'example' => 'ha-cn-w6lr44sf3kx@ha-cn-w6lr44sf3kx_kevintest@kevintest@index_config_edit',
- ],
- ],
- [
- 'name' => 'body',
- 'in' => 'body',
- 'style' => 'json',
- 'schema' => [
- 'description' => 'The request body.'."\n",
- 'type' => 'object',
- 'properties' => [
- 'dirName' => [
- 'title' => '目录名称',
- 'description' => 'The directory name.'."\n",
- 'type' => 'string',
- 'required' => false,
- 'example' => '/clusters',
- ],
- 'parentFullPath' => [
- 'title' => '上级文件路径',
- 'description' => 'The path of the parent directory.'."\n",
- 'type' => 'string',
- 'required' => false,
- 'example' => '/',
- ],
- ],
- 'required' => false,
- ],
- ],
- ],
- 'responses' => [
- 200 => [
- 'schema' => [
- 'type' => 'object',
- 'properties' => [
- 'requestId' => [
- 'title' => 'id of request',
- 'description' => 'The request ID.'."\n",
- 'type' => 'string',
- 'example' => 'E7B7D598-B080-5C8E-AA35-D43EC0D5F886',
- ],
- 'result' => [
- 'title' => 'Map',
- 'description' => 'The result.'."\n",
- 'type' => 'object',
- 'example' => '{}',
- ],
+ 'operationType' => 'delete',
+ 'ramAction' => [
+ 'action' => 'searchengine:DeleteInstance',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SearchEngine', 'resourceType' => 'Instance', 'arn' => 'acs:searchengine:{#regionId}:{#accountId}:instance/{#InstanceId}'],
],
- 'description' => '',
],
],
- 500 => [],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"E7B7D598-B080-5C8E-AA35-D43EC0D5F886\\",\\n \\"result\\": {}\\n}","type":"json"}]',
- 'title' => 'Create Advanced configuration file directories',
],
- 'CreateConfigFile' => [
- 'path' => '/openapi/ha3/instances/{instanceId}/advanced-configs/{configName}/file',
- 'methods' => [
- 'post',
- ],
- 'schemes' => [
- 'https',
- 'http',
- ],
+ 'DeleteModel' => [
+ 'summary' => 'Deletes a model.',
+ 'path' => '/openapi/ha3/instances/{instanceId}/models/{modelName}',
+ 'methods' => ['delete'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
@@ -6652,97 +3028,63 @@
],
'operationType' => 'write',
'deprecated' => false,
- 'systemTags' => [],
+ 'systemTags' => [
+ 'operationType' => 'delete',
+ 'riskType' => 'none',
+ 'chargeType' => 'free',
+ 'abilityTreeNodes' => ['FEATUREopensearchGTRUN8'],
+ ],
'parameters' => [
[
'name' => 'instanceId',
'in' => 'path',
- 'schema' => [
- 'description' => 'The instance ID.'."\n",
- 'type' => 'string',
- 'required' => true,
- 'example' => 'ha-cn-2r42ostoc01',
- ],
+ 'schema' => ['title' => '', 'description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'example' => 'ha-cn-pl32rf0****'],
],
[
- 'name' => 'configName',
+ 'name' => 'modelName',
'in' => 'path',
- 'schema' => [
- 'description' => 'The configuration name.'."\n",
- 'type' => 'string',
- 'required' => true,
- 'example' => 'ha-cn-wuz014xlq5o_table_ha-cn-wuz014xlq5o_test_api_edit',
- ],
+ 'schema' => ['title' => '', 'description' => 'The name of the model.', 'type' => 'string', 'required' => true, 'example' => 'test'],
],
- [
- 'name' => 'body',
- 'in' => 'body',
- 'style' => 'json',
+ ],
+ 'responses' => [
+ 200 => [
'schema' => [
- 'description' => 'The request body.'."\n",
+ 'title' => '',
+ 'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
- 'fileName' => [
- 'title' => '目录名称',
- 'description' => 'The name of the directory.'."\n",
- 'type' => 'string',
- 'required' => false,
- 'example' => '/schemas/device_event_xt_schema.json',
- ],
- 'parentFullPath' => [
- 'title' => '上级文件路径',
- 'description' => 'The path of the parent directory.'."\n",
- 'type' => 'string',
- 'required' => false,
- 'example' => '/',
- ],
- 'ossPath' => [
- 'title' => 'oss存储地址',
- 'description' => 'The Object Storage Service (OSS) URL of the file.'."\n",
- 'type' => 'string',
- 'required' => false,
- 'example' => 'oss://xxx/xxxx/xxx',
- ],
+ 'requestId' => ['title' => '', 'description' => 'Id of the request', 'type' => 'string', 'example' => '022F36C7-9FB4-5D67-BEBC-3D14B0984463'],
],
- 'required' => false,
+ 'example' => '',
],
],
],
- 'responses' => [
- 200 => [
- 'schema' => [
- 'type' => 'object',
- 'properties' => [
- 'requestId' => [
- 'title' => 'id of request',
- 'description' => 'The request ID.'."\n",
- 'type' => 'string',
- 'example' => 'FE03180A-0E29-5474-8A86-33F0683294A4',
- ],
- 'result' => [
- 'title' => 'Map',
- 'description' => 'The result.'."\n",
- 'type' => 'object',
- 'example' => '{}',
- ],
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"022F36C7-9FB4-5D67-BEBC-3D14B0984463\\"\\n}","type":"json"}]',
+ 'title' => 'DeleteModel',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'delete',
+ 'ramAction' => [
+ 'action' => 'searchengine:DeleteModel',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SearchEngine', 'resourceType' => 'Instance', 'arn' => 'acs:searchengine:{#regionId}:{#accountId}:instance/{#InstanceId}'],
],
- 'description' => '',
],
],
- 500 => [],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"FE03180A-0E29-5474-8A86-33F0683294A4\\",\\n \\"result\\": {}\\n}","type":"json"}]',
- 'title' => 'CreateConfigFile',
],
- 'DeleteConfigDir' => [
- 'path' => '/openapi/ha3/instances/{instanceId}/advanced-configs/{configName}/dir',
- 'methods' => [
- 'delete',
- ],
- 'schemes' => [
- 'https',
- 'http',
- ],
+ 'DeletePublicUrl' => [
+ 'summary' => 'Deletes a public domain name.',
+ 'path' => '/openapi/ha3/instances/{instanceId}/public-url',
+ 'methods' => ['delete'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
@@ -6750,47 +3092,16 @@
],
'operationType' => 'write',
'deprecated' => false,
- 'systemTags' => [],
+ 'systemTags' => [
+ 'operationType' => 'delete',
+ 'abilityTreeCode' => '171290',
+ 'abilityTreeNodes' => ['FEATUREopensearch0AT3OG', 'FEATUREopensearchJB31XH'],
+ ],
'parameters' => [
[
'name' => 'instanceId',
'in' => 'path',
- 'schema' => [
- 'description' => 'The instance ID.'."\n",
- 'type' => 'string',
- 'required' => true,
- 'example' => 'ha-cn-18qug6zlc1r',
- ],
- ],
- [
- 'name' => 'configName',
- 'in' => 'path',
- 'schema' => [
- 'description' => 'The configuration name.'."\n",
- 'type' => 'string',
- 'required' => true,
- 'example' => 'ha-cn-wuz014xlq5o_table_ha-cn-wuz014xlq5o_test_api_edit',
- ],
- ],
- [
- 'name' => 'dirName',
- 'in' => 'query',
- 'schema' => [
- 'description' => 'The directory name.'."\n",
- 'type' => 'string',
- 'required' => true,
- 'example' => '/clusters',
- ],
- ],
- [
- 'name' => 'parentFullPath',
- 'in' => 'query',
- 'schema' => [
- 'description' => 'The path of the parent directory.'."\n",
- 'type' => 'string',
- 'required' => true,
- 'example' => '/',
- ],
+ 'schema' => ['description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'example' => 'ha-cn-pl32rf0****', 'title' => ''],
],
],
'responses' => [
@@ -6798,36 +3109,53 @@
'schema' => [
'type' => 'object',
'properties' => [
- 'requestId' => [
- 'title' => 'id of request',
- 'description' => 'The request ID.'."\n",
- 'type' => 'string',
- 'example' => 'F43E8AB4-419C-5F4C-90D6-615590DFAA3C',
- ],
- 'result' => [
- 'title' => 'Map',
- 'description' => 'The result.'."\n",
- 'type' => 'object',
- 'example' => '{}',
- ],
+ 'requestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => 'F43E8AB4-419C-5F4C-90D6-615590DFAA3C'],
+ 'result' => ['title' => '', 'description' => 'The returned result.', 'type' => 'object', 'example' => '{}'],
],
'description' => '',
+ 'title' => '',
+ 'example' => '',
],
],
500 => [],
],
+ 'title' => 'Delete a public domain name',
+ 'description' => '### Method'."\n"
+ ."\n"
+ .'```java'."\n"
+ .'DELETE'."\n"
+ .'```'."\n"
+ ."\n"
+ .'### URI'."\n"
+ ."\n"
+ .'```java'."\n"
+ .'/openapi/ha3/instances/{instanceId}/public-url'."\n"
+ .'```.',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeletePublicUrl'],
+ ],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'delete',
+ 'ramAction' => [
+ 'action' => 'searchengine:DeletePublicUrl',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SearchEngine', 'resourceType' => 'Instance', 'arn' => 'acs:searchengine:{#regionId}:{#accountId}:instance/{#InstanceId}'],
+ ],
+ ],
+ ],
+ ],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"F43E8AB4-419C-5F4C-90D6-615590DFAA3C\\",\\n \\"result\\": {}\\n}","type":"json"}]',
- 'title' => 'DeleteConfigDir',
],
- 'DeleteConfigFile' => [
- 'path' => '/openapi/ha3/instances/{instanceId}/advanced-configs/{configName}/file',
- 'methods' => [
- 'delete',
- ],
- 'schemes' => [
- 'https',
- 'http',
- ],
+ 'DeleteSqlInstance' => [
+ 'path' => '/openapi/ha3/instances/{instanceId}/sql-studio/databases/{database}/sql-instances/{sqlInstanceId}',
+ 'methods' => ['delete'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
@@ -6835,47 +3163,26 @@
],
'operationType' => 'write',
'deprecated' => false,
- 'systemTags' => [],
+ 'systemTags' => [
+ 'operationType' => 'delete',
+ 'abilityTreeCode' => '139626',
+ 'abilityTreeNodes' => ['FEATUREopensearch95VJR4'],
+ ],
'parameters' => [
[
'name' => 'instanceId',
'in' => 'path',
- 'schema' => [
- 'description' => 'The instance ID.'."\n",
- 'type' => 'string',
- 'required' => true,
- 'example' => 'ha-cn-2r42ostoc01',
- ],
+ 'schema' => ['description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'ha-cn-pl32rf0****'],
],
[
- 'name' => 'configName',
+ 'name' => 'database',
'in' => 'path',
- 'schema' => [
- 'description' => 'The configuration name.'."\n",
- 'type' => 'string',
- 'required' => true,
- 'example' => 'ha-cn-lbj39bhay03@ha-cn-lbj39bhay03_api_data@vpc_sh_domain_1@api_index@index_config_edit',
- ],
+ 'schema' => ['description' => 'The database name.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'general'],
],
[
- 'name' => 'fileName',
- 'in' => 'query',
- 'schema' => [
- 'description' => 'The file name.'."\n",
- 'type' => 'string',
- 'required' => true,
- 'example' => '/schemas/automobile_vector_schema.json',
- ],
- ],
- [
- 'name' => 'parentFullPath',
- 'in' => 'query',
- 'schema' => [
- 'description' => 'The path of the parent directory.'."\n",
- 'type' => 'string',
- 'required' => true,
- 'example' => '/',
- ],
+ 'name' => 'sqlInstanceId',
+ 'in' => 'path',
+ 'schema' => ['description' => 'The SQL instance ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'title' => '', 'example' => '1'],
],
],
'responses' => [
@@ -6883,36 +3190,70 @@
'schema' => [
'type' => 'object',
'properties' => [
- 'requestId' => [
- 'title' => 'id of request',
- 'description' => 'The request ID.'."\n",
- 'type' => 'string',
- 'example' => '10D5E615-69F7-5F49-B850-00169ADE513C',
- ],
+ 'requestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '2AE63638-5420-56DC-BF59-37D8174039A0'],
'result' => [
- 'title' => 'Map',
- 'description' => 'The result.'."\n",
+ 'title' => '',
+ 'description' => 'The returned data.',
'type' => 'object',
- 'example' => '{}',
+ 'properties' => [
+ 'result' => [
+ 'description' => 'The returned data.',
+ 'type' => 'object',
+ 'additionalProperties' => ['type' => 'string', 'description' => 'The returned data.', 'title' => '', 'example' => '{}'],
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'requestId' => ['description' => 'The request ID.', 'type' => 'string', 'title' => '', 'example' => '2AE63638-5420-56DC-BF59-37D8174039A0'],
+ ],
+ 'example' => '',
],
],
'description' => '',
+ 'title' => '',
+ 'example' => '',
],
],
500 => [],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"10D5E615-69F7-5F49-B850-00169ADE513C\\",\\n \\"result\\": {}\\n}","type":"json"}]',
- 'title' => 'DeleteConfigFile',
- ],
- 'ModifyAdvanceConfig' => [
- 'path' => '/openapi/ha3/instances/{instanceId}/advanced-configs/{configName}',
- 'methods' => [
- 'put',
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"2AE63638-5420-56DC-BF59-37D8174039A0\\",\\n \\"result\\": {\\n \\"result\\": {\\n \\"key\\": \\"{}\\"\\n },\\n \\"requestId\\": \\"2AE63638-5420-56DC-BF59-37D8174039A0\\"\\n }\\n}","type":"json"}]',
+ 'title' => 'DeleteSqlInstance',
+ 'summary' => 'Deletes an SQL instance.',
+ 'description' => '### Method'."\n"
+ ."\n"
+ .'```java'."\n"
+ .'DELETE'."\n"
+ .'```'."\n"
+ ."\n"
+ .'### URI'."\n"
+ ."\n"
+ .'```java'."\n"
+ .'/openapi/ha3/instances/{instanceId}/sql-studio/databases/{database}/sql-instances/{sqlInstanceId}'."\n"
+ .'```',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteSqlInstance'],
+ ],
],
- 'schemes' => [
- 'http',
- 'https',
+ 'ramActions' => [
+ [
+ 'operationType' => 'delete',
+ 'ramAction' => [
+ 'action' => 'searchengine:DeleteSqlInstance',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SearchEngine', 'resourceType' => 'SqlInstance', 'arn' => 'acs:searchengine:{#regionId}:{#accountId}:instance/{#InstanceId}'],
+ ],
+ ],
+ ],
],
+ ],
+ 'DeleteTable' => [
+ 'summary' => 'Delete an index table.',
+ 'path' => '/openapi/ha3/instances/{instanceId}/tables/{tableName}',
+ 'methods' => ['delete'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
@@ -6921,128 +3262,20 @@
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
- 'operationType' => 'update',
- 'abilityTreeCode' => '173716',
- 'abilityTreeNodes' => [
- 'FEATUREopensearch8WJIRU',
- ],
+ 'operationType' => 'delete',
+ 'abilityTreeCode' => '218775',
+ 'abilityTreeNodes' => ['FEATUREopensearchGTRUN8'],
],
'parameters' => [
[
'name' => 'instanceId',
'in' => 'path',
- 'schema' => [
- 'description' => 'The instance ID.'."\n",
- 'type' => 'string',
- 'required' => true,
- 'example' => 'ha-cn-tl32m2c4u01',
- ],
+ 'schema' => ['description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'example' => 'ha-cn-pl32rf0****', 'title' => ''],
],
[
- 'name' => 'configName',
+ 'name' => 'tableName',
'in' => 'path',
- 'schema' => [
- 'description' => 'The name of the advanced configuration.'."\n",
- 'type' => 'string',
- 'required' => true,
- 'example' => 'ha-cn-18qug6zlc1r_offline_adv_edit',
- ],
- ],
- [
- 'name' => 'body',
- 'in' => 'body',
- 'style' => 'json',
- 'schema' => [
- 'description' => 'The request body.'."\n",
- 'type' => 'object',
- 'properties' => [
- 'name' => [
- 'title' => '配置名称',
- 'description' => 'The name of the advanced configuration.'."\n",
- 'type' => 'string',
- 'required' => false,
- 'example' => 'ha-cn-zvp2qr1sk01_qrs',
- ],
- 'status' => [
- 'title' => '配置状态 (drafting: 草稿, used: 线上使用, unused: 未使用, trash: 删除中)',
- 'description' => 'The status of the advanced configuration. Valid values: drafting: The advanced configuration is in the draft state. used: The advanced configuration is being used. unused: The advanced configuration is not used. trash: The advanced configuration is being deleted.'."\n",
- 'type' => 'string',
- 'required' => false,
- 'example' => 'used',
- ],
- 'updateTime' => [
- 'title' => '更新时间',
- 'description' => 'The time when the advanced configuration was updated.'."\n",
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => false,
- 'example' => '2024-02-27T07:50:55Z',
- ],
- 'desc' => [
- 'title' => '高级配置描述信息',
- 'description' => 'The description of the advanced configuration.'."\n",
- 'type' => 'string',
- 'required' => false,
- 'example' => 'test',
- ],
- 'files' => [
- 'title' => '文件名列表',
- 'description' => 'The files.'."\n",
- 'type' => 'array',
- 'items' => [
- 'description' => '',
- 'type' => 'object',
- 'properties' => [
- 'name' => [
- 'title' => '节点名称',
- 'description' => 'The node name.'."\n",
- 'type' => 'string',
- 'required' => false,
- 'example' => 'general',
- ],
- 'fullPathName' => [
- 'title' => '全路径名称',
- 'description' => 'The full path of the file.'."\n",
- 'type' => 'string',
- 'required' => false,
- 'example' => '/cluster.json',
- ],
- 'isDir' => [
- 'title' => '是否是目录',
- 'description' => 'Specifies whether the file is a directory.'."\n",
- 'type' => 'boolean',
- 'required' => false,
- 'example' => 'true',
- ],
- 'isTemplate' => [
- 'title' => '是否是模板',
- 'description' => 'Specifies whether the file is a template.'."\n",
- 'type' => 'boolean',
- 'required' => false,
- 'example' => 'true',
- ],
- ],
- 'required' => false,
- ],
- 'required' => false,
- ],
- 'content' => [
- 'title' => '配置内容 http，git 请求时不为空',
- 'description' => 'The content of the advanced configuration that is returned.'."\n",
- 'type' => 'string',
- 'required' => false,
- 'example' => '""',
- ],
- 'contentType' => [
- 'title' => '配置内容的类型 (FILE, GIT, HTTP, ODPS)',
- 'description' => 'The type of the configuration content. Valid values: FILE, GIT, HTTP, and ODPS.'."\n",
- 'type' => 'string',
- 'required' => false,
- 'example' => 'FILE',
- ],
- ],
- 'required' => false,
- ],
+ 'schema' => ['description' => 'The name of the index table.', 'type' => 'string', 'required' => true, 'example' => 'test_summary', 'title' => ''],
],
],
'responses' => [
@@ -7050,566 +3283,447 @@
'schema' => [
'type' => 'object',
'properties' => [
- 'requestId' => [
- 'title' => 'id of request',
- 'description' => 'The request ID.'."\n",
- 'type' => 'string',
- 'example' => '2AE63638-5420-56DC-BF59-37D8174039A0',
- ],
- 'result' => [
- 'title' => 'Map',
- 'description' => 'The result.'."\n",
- 'type' => 'object',
- 'example' => '{}',
- ],
+ 'requestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => 'E7B7D598-B080-5C8E-AA35-D43EC0D5F886'],
+ 'result' => ['title' => '', 'description' => 'The returned result.', 'type' => 'object', 'example' => '{}'],
],
'description' => '',
+ 'title' => '',
+ 'example' => '',
],
],
500 => [],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"2AE63638-5420-56DC-BF59-37D8174039A0\\",\\n \\"result\\": {}\\n}","type":"json"}]',
- 'title' => 'ModifyAdvanceConfig',
- ],
- 'DeleteAdvanceConfig' => [
- 'summary' => 'Deletes the details about advanced configurations.',
- 'path' => '/openapi/ha3/instances/{instanceId}/advanced-configs/{configName}',
- 'methods' => [
- 'delete',
- ],
- 'schemes' => [
- 'http',
- 'https',
+ 'title' => 'Delete Index Table',
+ 'description' => '### Method'."\n"
+ ."\n"
+ .'```java'."\n"
+ .'DELETE'."\n"
+ .'```'."\n"
+ ."\n"
+ .'### URI'."\n"
+ ."\n"
+ .'```java'."\n"
+ .'/openapi/ha3/instances/{instanceId}/tables/{tableName}'."\n"
+ .'```',
+ 'requestParamsDescription' => '### Request Example'."\n"
+ ."\n\n"
+ ."\n"
+ .'```java'."\n"
+ .'DELETE /openapi/ha3/instances/{instanceId}/tables/{tableName}'."\n"
+ .'```',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'delete',
+ 'ramAction' => [
+ 'action' => 'searchengine:DeleteTable',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SearchEngine', 'resourceType' => 'Instance', 'arn' => 'acs:searchengine:{#regionId}:{#accountId}:instance/{#InstanceId}'],
+ ],
+ ],
+ ],
],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"E7B7D598-B080-5C8E-AA35-D43EC0D5F886\\",\\n \\"result\\": {}\\n}","type":"json"}]',
+ ],
+ 'DescribeRegions' => [
+ 'path' => '/openapi/ha3/regions',
+ 'methods' => ['get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
+ 'consumes' => ['application/json'],
+ 'produces' => ['application/json'],
'operationType' => 'read',
- 'deprecated' => false,
- 'systemTags' => [],
+ 'systemTags' => [
+ 'operationType' => 'none',
+ 'abilityTreeCode' => '180430',
+ 'abilityTreeNodes' => ['FEATUREopensearch0AT3OG', 'FEATUREopensearchJB31XH'],
+ ],
'parameters' => [
[
- 'name' => 'instanceId',
- 'in' => 'path',
- 'schema' => [
- 'title' => '实例ID',
- 'description' => 'The instance ID.'."\n",
- 'type' => 'string',
- 'required' => true,
- 'example' => 'ha-cn-0ju2rps6c08',
- ],
- ],
- [
- 'name' => 'configName',
- 'in' => 'path',
- 'schema' => [
- 'title' => '配置名称',
- 'description' => 'The configuration name.'."\n",
- 'type' => 'string',
- 'required' => false,
- 'example' => 'ha-cn-0ju2rps6c08_offline_adv_v1',
- ],
+ 'name' => 'acceptLanguage',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The language of the response. Default value: zh-cn.', 'type' => 'string', 'required' => false, 'example' => 'zh-cn', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
- 'title' => 'Schema of Response',
- 'description' => 'The schema of the response parameter.'."\n",
'type' => 'object',
'properties' => [
- 'requestId' => [
- 'title' => 'id of request',
- 'description' => 'The ID of the request.'."\n",
- 'type' => 'string',
- 'example' => 'E7B7D598-B080-5C8E-AA35-D43EC0D5F886',
- ],
+ 'requestId' => ['description' => 'id of request', 'type' => 'string', 'example' => 'E7B7D598-B080-5C8E-AA35-D43EC0D5F886', 'title' => ''],
'result' => [
- 'title' => '结果',
- 'description' => 'The result.'."\n",
- 'type' => 'object',
- 'example' => '{}',
+ 'description' => 'The result.',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'The result.',
+ 'type' => 'object',
+ 'properties' => [
+ 'localName' => ['description' => 'The name of the region.', 'type' => 'string', 'example' => 'China (Hangzhou)', 'title' => ''],
+ 'endpoint' => ['description' => 'The endpoint of the region.', 'type' => 'string', 'example' => 'endpoint', 'title' => ''],
+ 'regionId' => ['description' => 'The ID of the region. Valid values:'."\n"
+ ."\n"
+ .'cn-hangzhou: China (Hangzhou)'."\n"
+ ."\n"
+ .'cn-shanghai: China (Shanghai)'."\n"
+ ."\n"
+ .'cn-qingdao: China (Qingdao)'."\n"
+ ."\n"
+ .'cn-beijing: China (Beijing)'."\n"
+ ."\n"
+ .'cn-zhangjiakou: China (Zhangjiakou)'."\n"
+ ."\n"
+ .'cn-shenzhen: China (Shenzhen)'."\n"
+ ."\n"
+ .'ap-southeast-1: Singapore (Singapore)'."\n"
+ ."\n"
+ .'cn-internal: Internal Center'."\n"
+ ."\n"
+ .'cn-zhangbei-in: Internal Center (Zhangjiakou)'."\n"
+ ."\n"
+ .'us-west-1-in: Internal Center (US)'."\n"
+ ."\n"
+ .'rus-west-1-in: Internal Center (Russia)'."\n"
+ ."\n"
+ .'cn-daily: Daily Environment'."\n"
+ ."\n"
+ .'cn-test: Joint Debugging'."\n"
+ ."\n"
+ .'pre-hangzhou: China (Hangzhou)-Staging', 'type' => 'string', 'example' => 'cn-hangzhou', 'title' => ''],
+ ],
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'title' => '',
+ 'example' => '',
],
],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
],
- 500 => [],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"E7B7D598-B080-5C8E-AA35-D43EC0D5F886\\",\\n \\"result\\": {}\\n}","type":"json"}]',
- 'title' => 'DeleteAdvanceConfig',
- 'description' => '## Method'."\n"
- ."\n"
- .' DELETE'."\n"
- ."\n"
- .'## URI'."\n"
- ."\n"
- .' /openapi/ha3/instances/{instanceId}/advanced-configs/{configName}'."\n",
- 'requestParamsDescription' => '## Sample requests'."\n"
- ."\n"
- .''."\n"
- ."\n"
- .' DELETE /openapi/ha3/instances/ose-test1/advanced-configs/my_config_name'."\n",
- 'responseParamsDescription' => '## Sample responses'."\n"
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"E7B7D598-B080-5C8E-AA35-D43EC0D5F886\\",\\n \\"result\\": [\\n {\\n \\"localName\\": \\"China (Hangzhou)\\",\\n \\"endpoint\\": \\"endpoint\\",\\n \\"regionId\\": \\"cn-hangzhou\\"\\n }\\n ]\\n}","type":"json"}]',
+ 'title' => 'DescribeRegions',
+ 'summary' => 'Queries available regions.',
+ 'description' => '### Method'."\n"
."\n"
- .'Sample success responses '."\n"
+ .'```java'."\n"
+ .'GET'."\n"
+ .'```'."\n"
."\n"
- .' {'."\n"
- .' '."\n"
- .' "requestId": "e1eef569-1ff7-4bf8-acf7-1cecca9894ce",'."\n"
- .' '."\n"
- .' "result": []'."\n"
- .' '."\n"
- .' }'."\n"
+ .'### URI'."\n"
."\n"
- .'For more information, see [Response structure](~~465311~~).'."\n",
- ],
- 'ModifyAdvanceConfigFile' => [
- 'summary' => 'Modifies the advanced configurations.',
- 'path' => '/openapi/ha3/instances/{instanceId}/advanced-configs/{configName}/file',
- 'methods' => [
- 'put',
- ],
- 'schemes' => [
- 'http',
- 'https',
+ .'```java'."\n"
+ .'/openapi/ha3/regions'."\n"
+ .'```',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
],
+ 'ramActions' => [],
+ ],
+ 'ExecuteSqlInstance' => [
+ 'path' => '/openapi/ha3/instances/{instanceId}/sql-studio/databases/{database}/sql-instances/{sqlInstanceId}/actions/execution',
+ 'methods' => ['post'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
- 'operationType' => 'read',
+ 'operationType' => 'write',
'deprecated' => false,
- 'systemTags' => [],
+ 'systemTags' => [
+ 'operationType' => 'create',
+ 'abilityTreeCode' => '139115',
+ 'abilityTreeNodes' => ['FEATUREopensearch95VJR4'],
+ ],
'parameters' => [
[
'name' => 'instanceId',
'in' => 'path',
- 'schema' => [
- 'description' => 'The instance ID.'."\n",
- 'type' => 'string',
- 'required' => true,
- 'example' => 'ha-cn-2r42ostoc01',
- ],
+ 'schema' => ['description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'example' => 'ha-cn-pl32rf0****', 'title' => ''],
],
[
- 'name' => 'configName',
+ 'name' => 'database',
'in' => 'path',
- 'schema' => [
- 'description' => 'The configuration name.'."\n",
- 'type' => 'string',
- 'required' => true,
- 'example' => 'ha-cn-zvp2ou1h801_online_config_edit',
- ],
+ 'schema' => ['description' => 'The database name.', 'type' => 'string', 'required' => true, 'example' => 'general', 'title' => ''],
],
[
- 'name' => 'fileName',
- 'in' => 'query',
- 'schema' => [
- 'description' => 'The name of the file.'."\n",
- 'type' => 'string',
- 'required' => true,
- 'example' => '/qrs.json',
- ],
+ 'name' => 'sqlInstanceId',
+ 'in' => 'path',
+ 'schema' => ['description' => 'The SQL instance ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1', 'title' => ''],
],
[
'name' => 'body',
'in' => 'body',
'style' => 'json',
'schema' => [
- 'description' => 'The request body.'."\n",
+ 'description' => 'The request body parameters.',
'type' => 'object',
'properties' => [
- 'content' => [
- 'title' => '文件内容--词典配置',
- 'description' => 'The file content.'."\n",
- 'type' => 'string',
+ 'content' => ['description' => 'The SQL content.', 'type' => 'string', 'required' => true, 'example' => 'select * from test', 'title' => ''],
+ 'kvpair' => [
+ 'description' => 'The key-value struct.',
+ 'type' => 'object',
'required' => false,
- 'example' => '"ha3"',
+ 'additionalProperties' => ['description' => 'The key-value struct.', 'type' => 'any', 'example' => '{'."\n"
+ .' "trace": "INFO",'."\n"
+ .' "databaseName": "general",'."\n"
+ .' "iquan.plan.cache.enable": true,'."\n"
+ .' "iquan.plan.prepare.level": "jni.post.optimize",'."\n"
+ .' "urlencode_data": false,'."\n"
+ .' "formatType": "string",'."\n"
+ .' "timeout": 1000'."\n"
+ .'}', 'title' => ''],
+ 'title' => '',
+ 'example' => '',
],
- 'variables' => [
- 'title' => '变量值--在线配置',
- 'description' => 'The variables.'."\n",
+ 'dynamicParam' => [
+ 'description' => 'The dynamic parameters.',
'type' => 'object',
'required' => false,
- 'additionalProperties' => [
- 'type' => 'object',
- 'properties' => [
- 'disableModify' => [
- 'type' => 'boolean',
- 'required' => false,
- 'description' => 'Specifies whether the variable is not allowed to be modified.'."\n",
- 'example' => 'false',
- ],
- 'isModify' => [
- 'type' => 'boolean',
- 'required' => false,
- 'description' => 'Specifies whether the variable is modified.'."\n",
- 'example' => 'false',
- ],
- 'value' => [
- 'type' => 'string',
- 'required' => false,
- 'example' => '""',
- 'description' => 'The variable value.'."\n",
- ],
- 'description' => [
- 'type' => 'string',
- 'required' => false,
- 'description' => 'The description of the variable.'."\n",
- 'example' => '""',
- ],
- 'templateValue' => [
- 'type' => 'string',
- 'required' => false,
- 'description' => 'The template value of the variable.'."\n",
- 'example' => '""',
- ],
- 'type' => [
- 'title' => 'NORMAL, FUNCTION',
- 'description' => 'The variable type. Valid values:'."\n"
- ."\n"
- .'* NORMAL: common variable'."\n"
- .'* FUNCTION: function variable'."\n",
- 'type' => 'string',
- 'required' => false,
- 'example' => 'NORMAL',
- ],
- 'funcValue' => [
- 'type' => 'object',
- 'properties' => [
- 'funcClassName' => [
- 'type' => 'string',
- 'required' => false,
- 'example' => '""',
- 'description' => 'The class name of the function variable.'."\n",
- ],
- 'template' => [
- 'type' => 'string',
- 'required' => false,
- 'description' => 'The template of the function variable.'."\n",
- 'example' => '""',
- ],
- ],
- 'required' => false,
- 'description' => 'The function variables.'."\n",
- ],
- ],
- 'description' => 'The variable information.'."\n",
- ],
+ 'additionalProperties' => ['description' => 'The dynamic extension parameters.', 'type' => 'any', 'example' => '{'."\n"
+ .' "trace": "INFO",'."\n"
+ .' "databaseName": "general",'."\n"
+ .' "iquan.plan.cache.enable": true,'."\n"
+ .' "iquan.plan.prepare.level": "jni.post.optimize",'."\n"
+ .' "urlencode_data": false,'."\n"
+ .' "formatType": "string",'."\n"
+ .' "timeout": 1000'."\n"
+ .'}', 'title' => ''],
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'staticParam' => [
+ 'description' => 'The static parameters.',
+ 'type' => 'object',
+ 'required' => false,
+ 'additionalProperties' => ['description' => 'The static parameters.', 'type' => 'any', 'example' => '{'."\n"
+ .' "trace": "INFO",'."\n"
+ .' "databaseName": "general",'."\n"
+ .' "iquan.plan.cache.enable": true,'."\n"
+ .' "iquan.plan.prepare.level": "jni.post.optimize",'."\n"
+ .' "urlencode_data": false,'."\n"
+ .' "formatType": "string",'."\n"
+ .' "timeout": 1000'."\n"
+ .'}', 'title' => ''],
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'domain' => ['description' => 'The data source server room.', 'type' => 'string', 'required' => false, 'example' => 'vpc_hz_domain_1', 'title' => ''],
+ 'params' => [
+ 'description' => 'The SQL execution parameters.',
+ 'type' => 'object',
+ 'required' => false,
+ 'additionalProperties' => ['description' => 'The SQL execution parameters.', 'type' => 'any', 'example' => '{'."\n"
+ .' "trace": "INFO",'."\n"
+ .' "databaseName": "general",'."\n"
+ .' "iquan.plan.cache.enable": true,'."\n"
+ .' "iquan.plan.prepare.level": "jni.post.optimize",'."\n"
+ .' "urlencode_data": false,'."\n"
+ .' "formatType": "string",'."\n"
+ .' "timeout": 1000'."\n"
+ .'}', 'title' => ''],
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'combineParam' => [
+ 'description' => 'The combined parameters.',
+ 'type' => 'object',
+ 'required' => false,
+ 'additionalProperties' => ['description' => 'The combined parameters.', 'type' => 'any', 'example' => '{'."\n"
+ .' "trace": "INFO",'."\n"
+ .' "databaseName": "general",'."\n"
+ .' "iquan.plan.cache.enable": true,'."\n"
+ .' "iquan.plan.prepare.level": "jni.post.optimize",'."\n"
+ .' "urlencode_data": false,'."\n"
+ .' "formatType": "string",'."\n"
+ .' "timeout": 1000'."\n"
+ .'}', 'title' => ''],
+ 'title' => '',
+ 'example' => '',
],
],
'required' => false,
- 'example' => '{}',
+ 'title' => '',
+ 'example' => '',
],
],
],
'responses' => [
200 => [
'schema' => [
- 'description' => 'Schema of Response'."\n",
'type' => 'object',
'properties' => [
- 'requestId' => [
- 'title' => 'id of request',
- 'description' => 'id of request'."\n",
- 'type' => 'string',
- 'example' => '93A9E542-8CF8-5BA6-99AB-94C0FE520429',
- ],
+ 'requestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => 'FE03180A-0E29-5474-8A86-33F0683294A4'],
'result' => [
- 'title' => 'Map',
- 'description' => 'The result.'."\n",
+ 'title' => '',
+ 'description' => 'The returned result.',
'type' => 'object',
- 'example' => '{}',
+ 'properties' => [
+ 'id' => ['description' => 'The primary key ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '22', 'title' => ''],
+ 'gmtCreate' => ['description' => 'The creation time.', 'type' => 'string', 'example' => '1719221186114', 'title' => ''],
+ 'gmtModified' => ['description' => 'The modification time.', 'type' => 'string', 'example' => '1719220182844', 'title' => ''],
+ 'name' => ['description' => 'The name.', 'type' => 'string', 'example' => 'test', 'title' => ''],
+ 'parent' => ['description' => 'The parent task ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '-1', 'title' => ''],
+ 'isDir' => ['description' => 'Indicates whether the entry is a directory. Valid values:'."\n"
+ .'- true: The entry is a directory.'."\n"
+ .'- false: The entry is not a directory.', 'type' => 'integer', 'format' => 'int32', 'example' => 'true', 'title' => ''],
+ 'type' => ['title' => '', 'description' => 'table, instance, template, function', 'type' => 'string', 'example' => 'instance'],
+ 'instanceId' => ['description' => 'The instance ID.', 'type' => 'integer', 'format' => 'int64', 'example' => 'ha-cn-pl32rf0****', 'title' => ''],
+ 'templateId' => ['description' => 'The template ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => ''],
+ ],
+ 'example' => '',
],
],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
],
500 => [],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"93A9E542-8CF8-5BA6-99AB-94C0FE520429\\",\\n \\"result\\": {}\\n}","type":"json"}]',
- 'title' => 'ModifyAdvanceConfigFile',
- 'description' => '## Method'."\n"
- ."\n"
- .' put'."\n"
- ."\n"
- .'## URI'."\n"
- ."\n"
- .' /openapi/ha3/instances/{instanceId}/advanced-configs/{configName}/file?fileName={fileName}'."\n",
- 'requestParamsDescription' => '## Sample requests'."\n"
- ."\n"
- .''."\n"
- ."\n"
- .' PUT /openapi/ha3/instances/{instanceId}/advancedConfigs/{configName}/file?fileName=/root/test.txt'."\n"
- ."\n"
- .''."\n"
- ."\n"
- .' {'."\n"
- .' '."\n"
- .' "content": "",'."\n"
- .' '."\n"
- .' "variables": {'."\n"
- .' '."\n"
- .' "qrs_connection_timeout": {'."\n"
- .' '."\n"
- .' "description": "",'."\n"
- .' '."\n"
- .' "disableModify": false,'."\n"
- .' '."\n"
- .' "isModify": true,'."\n"
- .' '."\n"
- .' "type": "NORMAL",'."\n"
- .' '."\n"
- .' "value": "800"'."\n"
- .' '."\n"
- .' }'."\n"
- .' '."\n"
- .' }'."\n"
- .' '."\n"
- .' }'."\n",
- 'responseParamsDescription' => '## [](#)Sample responses'."\n"
+ 'title' => 'Execute a SQL instance',
+ 'summary' => 'Executes a SQL instance.',
+ 'description' => '### Method'."\n"
."\n"
- .'Sample success responses'."\n"
+ .'```java'."\n"
+ .'POST'."\n"
+ .'```'."\n"
."\n"
- .' {'."\n"
- .' '."\n"
- .' "requestId": "65911539-5a8b-4bce-96a5-4d608900dc46",'."\n"
- .' '."\n"
- .' "result": []'."\n"
- .' '."\n"
- .' }'."\n"
+ .'### URI'."\n"
."\n"
- .'For more information, see [Response structure](~~465311~~).'."\n",
- ],
- 'PublishAdvanceConfig' => [
- 'summary' => 'Publishes a version of advanced configurations.',
- 'path' => '/openapi/ha3/instances/{instanceId}/advanced-configs/{configName}/actions/publish',
- 'methods' => [
- 'post',
+ .'```java'."\n"
+ .'/openapi/ha3/instances/{instanceId}/sql-studio/databases/{database}/sql-instances/{sqlInstanceId}/actions/execution'."\n"
+ .'```',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ExecuteSqlInstance'],
+ ],
],
- 'schemes' => [
- 'http',
- 'https',
+ 'ramActions' => [
+ [
+ 'operationType' => 'create',
+ 'ramAction' => [
+ 'action' => 'searchengine:ExecuteSqlInstance',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SearchEngine', 'resourceType' => 'Instance', 'arn' => 'acs:searchengine:{#regionId}:{#accountId}:instance/{#instanceId}'],
+ ],
+ ],
+ ],
],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"FE03180A-0E29-5474-8A86-33F0683294A4\\",\\n \\"result\\": {\\n \\"id\\": 22,\\n \\"gmtCreate\\": \\"1719221186114\\",\\n \\"gmtModified\\": \\"1719220182844\\",\\n \\"name\\": \\"test\\",\\n \\"parent\\": -1,\\n \\"isDir\\": 0,\\n \\"type\\": \\"instance\\",\\n \\"instanceId\\": 0,\\n \\"templateId\\": 1\\n }\\n}","type":"json"}]',
+ ],
+ 'ForceSwitch' => [
+ 'summary' => 'Performs a forced switchover.',
+ 'path' => '/openapi/ha3/instances/{instanceId}/force-switch/{fsmId}',
+ 'methods' => ['put'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
- 'operationType' => 'read',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'update',
- 'abilityTreeCode' => '104708',
- 'abilityTreeNodes' => [
- 'FEATUREopensearchA6GC80',
- ],
- ],
+ 'systemTags' => [],
'parameters' => [
[
'name' => 'instanceId',
'in' => 'path',
- 'schema' => [
- 'description' => 'The instance ID.'."\n",
- 'type' => 'string',
- 'required' => true,
- 'example' => 'ha-cn-7e22rof5304',
- ],
+ 'schema' => ['description' => 'The instance ID.'."\n", 'type' => 'string', 'required' => true, 'example' => 'ha-cn-pl32rf0****', 'title' => ''],
],
[
- 'name' => 'configName',
+ 'name' => 'fsmId',
'in' => 'path',
- 'schema' => [
- 'description' => 'The configuration name.'."\n",
- 'type' => 'string',
- 'required' => true,
- 'example' => 'ha-cn-0ju2rrogr01_online_config_v3',
- ],
- ],
- [
- 'name' => 'body',
- 'in' => 'body',
- 'style' => 'json',
- 'schema' => [
- 'description' => 'The request body.'."\n",
- 'type' => 'object',
- 'properties' => [
- 'desc' => [
- 'description' => 'The description of the advanced configuration.'."\n",
- 'type' => 'string',
- 'required' => false,
- 'example' => 'Custom configuration'."\n",
- ],
- 'files' => [
- 'description' => 'The files.'."\n",
- 'type' => 'array',
- 'items' => [
- 'description' => '',
- 'type' => 'object',
- 'properties' => [
- 'ossPath' => [
- 'description' => 'The path of the Object Storage Service (OSS) object.'."\n",
- 'type' => 'string',
- 'required' => false,
- 'example' => 'oss://opensearch/test.json',
- ],
- 'operateType' => [
- 'description' => 'The operation type. Valid values: UPDATE and DELETE. Default value: UPDATE.'."\n",
- 'type' => 'string',
- 'required' => false,
- 'example' => 'UPDATE',
- ],
- 'parentFullPath' => [
- 'description' => 'The path of the parent directory.'."\n",
- 'type' => 'string',
- 'required' => false,
- 'example' => '/',
- ],
- 'fileName' => [
- 'description' => 'The file name.'."\n",
- 'type' => 'string',
- 'required' => false,
- 'example' => 'vector_question_schema.json',
- ],
- 'dirName' => [
- 'description' => 'The directory name.'."\n",
- 'type' => 'string',
- 'required' => false,
- 'example' => '/clusters',
- ],
- 'config' => [
- 'description' => 'The information about the advanced configuration.'."\n",
- 'type' => 'object',
- 'properties' => [
- 'content' => [
- 'description' => 'The file content.'."\n",
- 'type' => 'string',
- 'required' => false,
- 'example' => "\n"
- .'{\\"url\\":\\"http://xxxxxx.aliyuncs.com/outnet_hz/packages/xxxxx/opensearch_offline_plugins_xxxxx.tar\\"}',
- ],
- 'variables' => [
- 'description' => 'The variables.'."\n",
- 'type' => 'object',
- 'required' => false,
- 'additionalProperties' => [
- 'type' => 'object',
- 'properties' => [
- 'description' => [
- 'type' => 'string',
- 'required' => false,
- 'description' => 'The description of the variable.'."\n",
- 'example' => 'Custom variable'."\n",
- ],
- 'disableModify' => [
- 'type' => 'boolean',
- 'required' => false,
- 'example' => 'true',
- 'description' => 'Specifies whether the variable is not allowed to be modified.'."\n",
- ],
- 'isModify' => [
- 'type' => 'boolean',
- 'required' => false,
- 'description' => 'Specifies whether the variable is modified.'."\n",
- 'example' => 'true',
- ],
- 'type' => [
- 'type' => 'string',
- 'required' => false,
- 'example' => 'NORMAL',
- 'description' => 'The variable type. Valid values: NORMAL: common variable. FUNCTION: function variable.'."\n",
- ],
- 'value' => [
- 'type' => 'string',
- 'required' => false,
- 'example' => 'test',
- 'description' => 'The variable value.'."\n",
- ],
- ],
- 'description' => 'The variable.'."\n",
- ],
- ],
- ],
- 'required' => false,
- ],
- ],
- 'required' => false,
- ],
- 'required' => false,
- ],
- ],
- 'required' => false,
- 'example' => '{\\"desc\\":\\"new version\\"}',
- ],
+ 'schema' => ['description' => 'The task ID.'."\n", 'type' => 'string', 'required' => true, 'example' => 'tisplus_opensearch@datasource_flow_fsm@186541059855****-ha-cn-pl32rf0****_api2@bj_vpc_domain_1@null@MANUAL-ha-cn-pl32rf0****_api2@164972986****@028315', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
- 'description' => 'Schema of Response',
+ 'title' => '',
+ 'description' => 'The response parameters.'."\n",
'type' => 'object',
'properties' => [
- 'requestId' => [
- 'title' => 'id of request',
- 'description' => 'The ID of the request'."\n",
- 'type' => 'string',
- 'example' => '10D5E615-69F7-5F49-B850-00169ADE513C',
- ],
- 'result' => [
- 'title' => 'Map',
- 'description' => 'The result returned'."\n",
- 'type' => 'object',
- 'example' => '{}',
- ],
+ 'requestId' => ['title' => '', 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '0B1FF998-BB8D-5182-BFC0-E471AA77095A'],
+ 'result' => ['title' => '', 'description' => 'The index information.'."\n", 'type' => 'object', 'example' => '{}'],
],
+ 'example' => '',
],
],
500 => [],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"10D5E615-69F7-5F49-B850-00169ADE513C\\",\\n \\"result\\": {}\\n}","type":"json"}]',
- 'title' => 'PublishAdvanceConfig',
- 'description' => '## Method'."\n"
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"0B1FF998-BB8D-5182-BFC0-E471AA77095A\\",\\n \\"result\\": {}\\n}","type":"json"}]',
+ 'title' => 'ForceSwitch',
+ 'description' => '### [](#)Method'."\n"
."\n"
- .'~~~'."\n"
- .'POST'."\n"
- .'~~~'."\n"
+ .'```java'."\n"
+ .'PUT'."\n"
+ .'```'."\n"
."\n"
- .'## URI'."\n"
+ .'### [](#uri)URI'."\n"
."\n"
- .'~~~'."\n"
- .'/openapi/ha3/instances/{instanceId}/advanced-configs/{configName}/actions/publish'."\n"
- .'~~~',
- 'requestParamsDescription' => '~~~'."\n"
- .'POST /openapi/ha3/instances/ose-test1/advanced-configs/test/actions/publish'."\n"
+ .'```java'."\n"
+ .'/openapi/ha3/instances/{instanceId}/force-switch/{fsmId}'."\n"
+ .'```'."\n",
+ 'requestParamsDescription' => '### [](#)Sample requests'."\n"
."\n"
- .'{'."\n"
- .' "desc": "new version"'."\n"
- .'}'."\n"
- .'~~~',
- 'responseParamsDescription' => '## [](#)Sample responses'."\n"
+ .'```java'."\n"
+ .'PUT /openapi/ha3/instances/{instanceId}/force-switch/tisplus_opensearch@add_index_config@106201777905****-ha-cn-0ju2i0e****_mx1228@null@index_11@null@164128272****@607017'."\n"
+ .'```'."\n",
+ 'responseParamsDescription' => '### Sample responses'."\n"
."\n"
- .'### [](#)Sample success responses'."\n"
+ .'Success responses '."\n"
."\n"
- .'```json'."\n"
+ .'```java'."\n"
.'{'."\n"
- .' "requestId": "65911539-5a8b-4bce-96a5-4d608900dc46",'."\n"
- .' "result": {}'."\n"
+ .''."\n"
+ .' "requestId": "0A6EB64B-B4C8-CF02-810F-E660812972FF",'."\n"
+ .''."\n"
+ .' "result": []'."\n"
+ .''."\n"
.'}'."\n"
.'```'."\n"
."\n"
- .'For more information, see [Response structure](~~465311~~).'."\n",
+ .'For more information, see [Response struct](~~464322~~).',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ForceSwitch'],
+ ],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => '',
+ 'ramAction' => [
+ 'action' => 'searchengine:ForceSwitch',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SearchEngine', 'resourceType' => 'Instance', 'arn' => 'acs:searchengine:{#regionId}:{#accountId}:instance/{#InstanceId}'],
+ ],
+ ],
+ ],
+ ],
],
'GetAdvanceConfig' => [
'path' => '/openapi/ha3/instances/{instanceId}/advanced-configs/{configName}',
- 'methods' => [
- 'get',
- ],
- 'schemes' => [
- 'https',
- 'http',
- ],
+ 'methods' => ['get'],
+ 'schemes' => ['https', 'http'],
'security' => [
[
'AK' => [],
@@ -7617,194 +3731,160 @@
],
'operationType' => 'read',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'get',
- ],
+ 'systemTags' => ['operationType' => 'get'],
'parameters' => [
[
'name' => 'instanceId',
'in' => 'path',
- 'schema' => [
- 'description' => 'The instance ID.'."\n",
- 'type' => 'string',
- 'required' => true,
- 'example' => 'ha-cn-18qug6zlc1r',
- ],
+ 'schema' => ['description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'example' => 'ha-cn-pl32rf0****', 'title' => ''],
],
[
'name' => 'type',
'in' => 'query',
- 'schema' => [
- 'title' => 'ONLINE: 在线配置, ONLINE_CAVA, ONLINE_PLUGIN, ONLINE_QUERY, OFFLINE_DICT: 离线配置, OFFLINE_TABLE, OFFLINE_COMMON, OFFLINE_PLUGIN, OFFLINE_INDEX',
- 'description' => '* The type of the advanced configuration. Valid values: -ONLINE: online configuration'."\n"
- .'* \\-ONLINE_CAVA: online Cava configuration'."\n"
- .'* \\-ONLINE_PLUGIN: online plug-in configuration'."\n"
- .'* \\-ONLINE_QUERY: query configuration'."\n"
- .'* \\-OFFLINE_DICT: offline dictionary configuration'."\n"
- .'* \\-OFFLINE_TABLE: offline table configuration'."\n"
- .'* \\-OFFLINE_COMMON: offline configuration'."\n"
- .'* \\-OFFLINE_PLUGIN: offline plug-in configuration'."\n"
- .'* \\-OFFLINE_INDEX: index configuration'."\n",
- 'type' => 'string',
- 'required' => false,
- 'example' => 'ONLINE',
- 'default' => 'OFFLINE_DICT',
- ],
+ 'schema' => ['description' => '- The type of the advanced configuration. Valid values: -ONLINE: online configuration'."\n"
+ ."\n"
+ .'- -ONLINE\\_CAVA: online Cava configuration'."\n"
+ ."\n"
+ .'- -ONLINE\\_PLUGIN: online plug-in configuration'."\n"
+ ."\n"
+ .'- -ONLINE\\_QUERY: query configuration'."\n"
+ ."\n"
+ .'- -OFFLINE\\_DICT: offline dictionary configuration'."\n"
+ ."\n"
+ .'- -OFFLINE\\_TABLE: offline table configuration'."\n"
+ ."\n"
+ .'- -OFFLINE\\_COMMON: offline configuration'."\n"
+ ."\n"
+ .'- -OFFLINE\\_PLUGIN: offline plug-in configuration'."\n"
+ ."\n"
+ .'- -OFFLINE\\_INDEX: index configuration', 'type' => 'string', 'default' => 'OFFLINE_DICT', 'title' => '', 'required' => false, 'example' => 'ONLINE'],
],
[
'name' => 'configName',
'in' => 'path',
- 'schema' => [
- 'description' => 'The name of the advanced configuration.'."\n",
- 'type' => 'string',
- 'required' => true,
- 'example' => 'ha-cn-18qug6zlc1r_offline_adv_edit',
- ],
+ 'schema' => ['description' => 'The name of the advanced configuration.', 'type' => 'string', 'required' => true, 'example' => "\n"
+ .'ha-cn-pl32rf0****_offline_adv_edit', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
- 'description' => 'The response parameters.'."\n",
+ 'description' => 'The response parameters.',
'type' => 'object',
'properties' => [
- 'requestId' => [
- 'title' => 'id of request',
- 'description' => 'The ID of the request.'."\n",
- 'type' => 'string',
- 'example' => 'E45380E8-994A-5402-9806-F114B3295FCF',
- ],
+ 'requestId' => ['title' => '', 'description' => 'The ID of the request.', 'type' => 'string', 'example' => 'E45380E8-994A-5402-9806-F114B3295FCF'],
'result' => [
- 'title' => 'AdvanceConfig',
- 'description' => 'The result.'."\n",
+ 'title' => '',
+ 'description' => 'The result.',
'type' => 'object',
'properties' => [
- 'updateTime' => [
- 'title' => '更新时间',
- 'description' => 'The time when the advanced configuration was updated.'."\n",
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '""',
- ],
- 'desc' => [
- 'title' => '高级配置描述信息',
- 'description' => 'The description of the advanced configuration.'."\n",
- 'type' => 'string',
- 'example' => 'close alarm, chiji id 37080',
- ],
+ 'updateTime' => ['description' => 'The time when the advanced configuration was updated.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '2024-05-21 16:05:26'],
+ 'desc' => ['description' => 'The description of the advanced configuration.', 'type' => 'string', 'example' => 'Custom remarks', 'title' => ''],
'files' => [
- 'title' => '文件名列表',
- 'description' => 'The files.'."\n",
+ 'title' => '',
+ 'description' => 'The files.',
'type' => 'array',
'items' => [
- 'description' => 'An array of files.'."\n",
+ 'description' => 'An array of files.',
'type' => 'object',
'properties' => [
- 'name' => [
- 'description' => 'The file name.'."\n",
- 'type' => 'string',
- 'example' => 'ha-cn-2r42ostoc01_qrs',
- ],
- 'fullPathName' => [
- 'description' => 'The file path.'."\n",
- 'type' => 'string',
- 'example' => '""',
- ],
- 'isDir' => [
- 'description' => 'Indicates whether the file is a directory.'."\n",
- 'type' => 'boolean',
- 'example' => 'True',
- ],
- 'isTemplate' => [
- 'description' => 'Indicates whether the file is a container.'."\n",
- 'type' => 'boolean',
- 'example' => 'True',
- ],
+ 'name' => ['description' => 'The file name.', 'type' => 'string', 'example' => 'ha-cn-pl32rf0****_qrs', 'title' => ''],
+ 'fullPathName' => ['description' => 'The file path.', 'type' => 'string', 'example' => '/cluster', 'title' => ''],
+ 'isDir' => ['description' => 'Indicates whether the file is a directory.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
+ 'isTemplate' => ['description' => 'Indicates whether the file is a container.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
],
+ 'title' => '',
+ 'example' => '',
],
+ 'example' => '',
],
- 'content' => [
- 'title' => '配置内容 http，git 请求时不为空',
- 'description' => 'The content of the advanced configuration that is returned.'."\n",
- 'type' => 'string',
- 'example' => '{\\"url\\":\\"http://xxxxxx.aliyuncs.com/outnet_hz/packages/xxxxx/opensearch_offline_plugins_xxxxx.tar\\"}',
- ],
- 'contentType' => [
- 'title' => '配置内容的类型 (FILE, GIT, HTTP, ODPS)',
- 'description' => 'The type of the configuration content. Valid values: FILE, GIT, HTTP, and ODPS.'."\n",
- 'type' => 'string',
- 'example' => 'FILE',
- ],
- 'name' => [
- 'title' => '配置名称',
- 'description' => 'The name of the advanced configuration.'."\n",
- 'type' => 'string',
- 'example' => 'ha-cn-0ju2s170b03_qrs',
- ],
- 'status' => [
- 'title' => '配置状态 (drafting: 草稿, used: 线上使用, unused: 未使用, trash: 删除中)',
- 'description' => 'The status of the advanced configuration. Valid values: drafting: The advanced configuration is in the draft state. used: The advanced configuration is being used. unused: The advanced configuration is not used. trash: The advanced configuration is being deleted.'."\n",
- 'type' => 'string',
- 'example' => '0,1,3,6,8',
- ],
+ 'content' => ['description' => 'The content of the advanced configuration that is returned.', 'type' => 'string', 'title' => '', 'example' => '{\\"url\\":\\"http://xxxxxx.aliyuncs.com/outnet_hz/packages/xxxxx/opensearch_offline_plugins_xxxxx.tar\\"}'],
+ 'contentType' => ['description' => 'The type of the configuration content. Valid values: FILE, GIT, HTTP, and ODPS.', 'type' => 'string', 'title' => '', 'example' => 'FILE'],
+ 'name' => ['description' => 'The name of the advanced configuration.', 'type' => 'string', 'title' => '', 'example' => 'my_index'],
+ 'status' => ['description' => 'The status of the advanced configuration. Valid values: drafting: The advanced configuration is in the draft state. used: The advanced configuration is being used. unused: The advanced configuration is not used. trash: The advanced configuration is being deleted.', 'type' => 'string', 'title' => '', 'example' => 'used'],
],
+ 'example' => '',
],
],
+ 'title' => '',
+ 'example' => '',
],
],
500 => [],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"E45380E8-994A-5402-9806-F114B3295FCF\\",\\n \\"result\\": {\\n \\"updateTime\\": 0,\\n \\"desc\\": \\"自定义备注信息\\",\\n \\"files\\": [\\n {\\n \\"name\\": \\"ha-cn-pl32rf0****_qrs\\",\\n \\"fullPathName\\": \\"/cluster\\",\\n \\"isDir\\": true,\\n \\"isTemplate\\": true\\n }\\n ],\\n \\"content\\": \\"{\\\\\\\\\\\\\\"url\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"http://xxxxxx.aliyuncs.com/outnet_hz/packages/xxxxx/opensearch_offline_plugins_xxxxx.tar\\\\\\\\\\\\\\"}\\",\\n \\"contentType\\": \\"FILE\\",\\n \\"name\\": \\"my_index\\",\\n \\"status\\": \\"used\\"\\n }\\n}","type":"json"}]',
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"E45380E8-994A-5402-9806-F114B3295FCF\\",\\n \\"result\\": {\\n \\"updateTime\\": 0,\\n \\"desc\\": \\"Custom remarks\\",\\n \\"files\\": [\\n {\\n \\"name\\": \\"ha-cn-pl32rf0****_qrs\\",\\n \\"fullPathName\\": \\"/cluster\\",\\n \\"isDir\\": true,\\n \\"isTemplate\\": true\\n }\\n ],\\n \\"content\\": \\"{\\\\\\\\\\\\\\"url\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"http://xxxxxx.aliyuncs.com/outnet_hz/packages/xxxxx/opensearch_offline_plugins_xxxxx.tar\\\\\\\\\\\\\\"}\\",\\n \\"contentType\\": \\"FILE\\",\\n \\"name\\": \\"my_index\\",\\n \\"status\\": \\"used\\"\\n }\\n}","type":"json"}]',
'title' => 'GetAdvanceConfig',
'summary' => 'Queries the information about an advanced configuration.',
'description' => '## Method'."\n"
."\n"
- .' GET'."\n"
+ .'```'."\n"
+ .'GET'."\n"
+ .'```'."\n"
."\n"
.'## URI'."\n"
."\n"
- .' /openapi/ha3/instances/{instanceId}/advanced-configs/{configName}'."\n",
+ .'```'."\n"
+ .'/openapi/ha3/instances/{instanceId}/advanced-configs/{configName}'."\n"
+ .'```',
'requestParamsDescription' => '## Sample requests'."\n"
."\n"
- .' GET /openapi/ha3/instances/ose-test1/advanced-configs/my_config_name'."\n",
+ .'```'."\n"
+ .'GET /openapi/ha3/instances/ose-test1/advanced-configs/my_config_name'."\n"
+ .'```',
'responseParamsDescription' => '## Sample responses'."\n"
."\n"
.'Success responses'."\n"
."\n"
- .' {'."\n"
- .' "requestId": "e1eef569-1ff7-4bf8-acf7-1cecca9894ce",'."\n"
- .' "result": {'."\n"
- .' "name": "my_index",'."\n"
- .' "status": "drafting",'."\n"
- .' "updateTime": 1631070464000,'."\n"
- .' "desc":"test",'."\n"
- .' "files": ['."\n"
- .' {'."\n"
- .' "fullPathName": "/",'."\n"
- .' "isDir": true,'."\n"
- .' "isTemplate": true,'."\n"
- .' "name": "cava"'."\n"
- .' },'."\n"
- .' {'."\n"
- .' "fullPathName": "/",'."\n"
- .' "isDir": true,'."\n"
- .' "isTemplate": true,'."\n"
- .' "name": "cava"'."\n"
- .' }'."\n"
- .' ] '."\n"
+ .'```'."\n"
+ .'{'."\n"
+ .' "requestId": "e1eef569-1ff7-4bf8-acf7-1cecca9894ce",'."\n"
+ .' "result": {'."\n"
+ .' "name": "my_index",'."\n"
+ .' "status": "drafting",'."\n"
+ .' "updateTime": 1631070464000,'."\n"
+ .' "desc":"test",'."\n"
+ .' "files": ['."\n"
+ .' {'."\n"
+ .' "fullPathName": "/",'."\n"
+ .' "isDir": true,'."\n"
+ .' "isTemplate": true,'."\n"
+ .' "name": "cava"'."\n"
+ .' },'."\n"
+ .' {'."\n"
+ .' "fullPathName": "/",'."\n"
+ .' "isDir": true,'."\n"
+ .' "isTemplate": true,'."\n"
+ .' "name": "cava"'."\n"
.' }'."\n"
- .' }'."\n",
+ .' ] '."\n"
+ .' }'."\n"
+ .'}'."\n"
+ .'```',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetAdvanceConfig'],
+ ],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'searchengine:GetAdvanceConfig',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SearchEngine', 'resourceType' => 'Instance', 'arn' => 'acs:searchengine:{#regionId}:{#accountId}:instance/{#InstanceId}'],
+ ],
+ ],
+ ],
+ ],
],
'GetAdvanceConfigFile' => [
'summary' => 'Queries the information about an advanced configuration file.',
'path' => '/openapi/ha3/instances/{instanceId}/advanced-configs/{configName}/file',
- 'methods' => [
- 'get',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
+ 'methods' => ['get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
@@ -7812,71 +3892,43 @@
],
'operationType' => 'read',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'get',
- ],
+ 'systemTags' => ['operationType' => 'get'],
'parameters' => [
[
'name' => 'instanceId',
'in' => 'path',
- 'schema' => [
- 'title' => '实例ID',
- 'description' => 'The instance ID.'."\n",
- 'type' => 'string',
- 'required' => true,
- 'example' => 'ha-cn-2r42ostoc01',
- ],
+ 'schema' => ['description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'ha-cn-pl32rf0****'],
],
[
'name' => 'configName',
'in' => 'path',
- 'schema' => [
- 'title' => '配置名称',
- 'description' => 'The name of the advanced configuration.'."\n",
- 'type' => 'string',
- 'required' => true,
- 'example' => 'ha-cn-7pp2pcna701_online_config_v5',
- ],
+ 'schema' => ['description' => 'The name of the advanced configuration.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'ha-cn-pl32rf0****_online_config_v5'],
],
[
'name' => 'fileName',
'in' => 'query',
- 'schema' => [
- 'title' => '文件名称',
- 'description' => 'The name of the file'."\n",
- 'type' => 'string',
- 'required' => true,
- 'example' => '/intervene_dict/chn_ecommerce_general.dict',
- ],
+ 'schema' => ['description' => 'The name of the file', 'type' => 'string', 'required' => true, 'title' => '', 'example' => '/intervene_dict/chn_ecommerce_general.dict'],
],
],
'responses' => [
200 => [
'schema' => [
- 'title' => 'Schema of Response',
- 'description' => 'The response parameters.'."\n",
+ 'title' => '',
+ 'description' => 'The response parameters.',
'type' => 'object',
'properties' => [
- 'requestId' => [
- 'title' => 'id of request',
- 'description' => 'id of request'."\n",
- 'type' => 'string',
- 'example' => '10D5E615-69F7-5F49-B850-00169ADE513C',
- ],
+ 'requestId' => ['title' => '', 'description' => 'id of request', 'type' => 'string', 'example' => '10D5E615-69F7-5F49-B850-00169ADE513C'],
'result' => [
- 'title' => '结果',
- 'description' => 'The result.'."\n",
+ 'title' => '',
+ 'description' => 'The result.',
'type' => 'object',
'properties' => [
- 'content' => [
- 'title' => '文件内容',
- 'description' => 'The file content.'."\n",
- 'type' => 'string',
- 'example' => '{"summarys":{"parameter":{"file_compressor":"zstd"},"summary_fields":["id"]},"file_compress":[{"name":"file_compressor","type":"zstd"},{"name":"no_compressor","type":""}],"indexs":[{"index_fields":"name","index_name":"ids","index_type":"STRING"},{"has_primary_key_attribute":true,"index_fields":"id","is_primary_key_sorted":false,"index_name":"id","index_type":"PRIMARYKEY64"}],"attributes":[{"file_compress":"no_compressor","field_name":"id"}],"fields":[{"user_defined_param":{},"compress_type":"uniq","field_type":"STRING","field_name":"id"},{"compress_type":"uniq","field_type":"STRING","field_name":"name"}],"table_name":"api"}',
- ],
+ 'content' => ['description' => 'The file content.', 'type' => 'string', 'title' => '', 'example' => '{\\"url\\":\\"http://xxxxxx.aliyuncs.com/outnet_hz/packages/xxxxx/opensearch_offline_plugins_xxxxx.tar\\"}'],
],
+ 'example' => '',
],
],
+ 'example' => '',
],
],
500 => [],
@@ -7885,26 +3937,140 @@
'title' => 'GetAdvanceConfigFile',
'description' => '## Method'."\n"
."\n"
- .' GET'."\n"
+ .'```'."\n"
+ .'GET'."\n"
+ .'```'."\n"
."\n"
.'## URI'."\n"
."\n"
- .' /openapi/ha3/instances/{instanceId}/advanced-configs/{configName}/file?fileName={fileName}'."\n",
+ .'```'."\n"
+ .'/openapi/ha3/instances/{instanceId}/advanced-configs/{configName}/file?fileName={fileName}'."\n"
+ .'```',
'requestParamsDescription' => '## Sample requests'."\n"
."\n"
.''."\n"
."\n"
- .' GET /openapi/ha3/instances/ose-test1/advanced-configs/my_config_name?fileName=/root/test.txt'."\n",
- ],
- 'ListAdvanceConfigDir' => [
- 'path' => '/openapi/ha3/instances/{instanceId}/advanced-configs/{configName}/dir',
- 'methods' => [
- 'get',
+ .'```'."\n"
+ .'GET /openapi/ha3/instances/ose-test1/advanced-configs/my_config_name?fileName=/root/test.txt'."\n"
+ .'```',
+ 'responseParamsDescription' => '## ResponseExample'."\n"
+ ."\n"
+ .'Correct response '."\n"
+ ."\n"
+ .'```'."\n"
+ .'{'."\n"
+ .''."\n"
+ .' "requestId": "0A6EB64B-B4C8-CF02-810F-E660812972FF",'."\n"
+ .''."\n"
+ .' "result": {'."\n"
+ .''."\n"
+ .' "content": "",'."\n"
+ .''."\n"
+ .' "variables": {'."\n"
+ .''."\n"
+ .' "qrs_request_compress_type": {'."\n"
+ .''."\n"
+ .' "description": "",'."\n"
+ .''."\n"
+ .' "disableModify": false,'."\n"
+ .''."\n"
+ .' "isModify": false,'."\n"
+ .''."\n"
+ .' "type": "NORMAL",'."\n"
+ .''."\n"
+ .' "value": "z_speed_compress"'."\n"
+ .''."\n"
+ .' },'."\n"
+ .''."\n"
+ .' "qrs_connection_timeout": {'."\n"
+ .''."\n"
+ .' "description": "",'."\n"
+ .''."\n"
+ .' "disableModify": false,'."\n"
+ .''."\n"
+ .' "isModify": true,'."\n"
+ .''."\n"
+ .' "type": "NORMAL",'."\n"
+ .''."\n"
+ .' "value": "800"'."\n"
+ .''."\n"
+ .' },'."\n"
+ .''."\n"
+ .' "qrs_return_hits_limit": {'."\n"
+ .''."\n"
+ .' "description": "",'."\n"
+ .''."\n"
+ .' "disableModify": false,'."\n"
+ .''."\n"
+ .' "isModify": false,'."\n"
+ .''."\n"
+ .' "type": "NORMAL",'."\n"
+ .''."\n"
+ .' "value": "5000"'."\n"
+ .''."\n"
+ .' },'."\n"
+ .''."\n"
+ .' "primary_table_name": {'."\n"
+ .''."\n"
+ .' "disableModify": false,'."\n"
+ .''."\n"
+ .' "funcValue": {'."\n"
+ .''."\n"
+ .' "funcClassName": "com.taobao.search.moss.resource.api.plugin.config.function.impl.MainOnlineTableFunction"'."\n"
+ .''."\n"
+ .' },'."\n"
+ .''."\n"
+ .' "isModify": false,'."\n"
+ .''."\n"
+ .' "type": "FUNCTION",'."\n"
+ .''."\n"
+ .' "value": "$primary_table_name"'."\n"
+ .''."\n"
+ .' },'."\n"
+ .''."\n"
+ .' "__cluster_name": {'."\n"
+ .''."\n"
+ .' "disableModify": false,'."\n"
+ .''."\n"
+ .' "isModify": true,'."\n"
+ .''."\n"
+ .' "type": "NORMAL",'."\n"
+ .''."\n"
+ .' "value": "general"'."\n"
+ .''."\n"
+ .' }'."\n"
+ .''."\n"
+ .' }'."\n"
+ .''."\n"
+ .' }'."\n"
+ .''."\n"
+ .'}'."\n"
+ .'```',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetAdvanceConfigFile'],
+ ],
],
- 'schemes' => [
- 'https',
- 'http',
+ 'ramActions' => [
+ [
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'searchengine:GetAdvanceConfigFile',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SearchEngine', 'resourceType' => 'Instance', 'arn' => 'acs:searchengine:{#regionId}:{#accountId}:instance/{#InstanceId}'],
+ ],
+ ],
+ ],
],
+ ],
+ 'GetCluster' => [
+ 'summary' => 'Query a cluster.',
+ 'path' => '/openapi/ha3/instances/{instanceId}/clusters/{clusterName}',
+ 'methods' => ['get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
@@ -7913,128 +4079,160 @@
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
- 'operationType' => 'list',
+ 'operationType' => 'get',
+ 'abilityTreeCode' => '104163',
+ 'abilityTreeNodes' => ['FEATUREopensearch5EAGY5'],
],
'parameters' => [
[
'name' => 'instanceId',
'in' => 'path',
- 'schema' => [
- 'description' => 'The instance ID.'."\n",
- 'type' => 'string',
- 'required' => true,
- 'example' => 'ha-cn-tl32n3iu801',
- ],
+ 'schema' => ['description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'ha-cn-pl32rf0****'],
],
[
- 'name' => 'configName',
+ 'name' => 'clusterName',
'in' => 'path',
- 'schema' => [
- 'description' => 'The configuration name.'."\n",
- 'type' => 'string',
- 'required' => true,
- 'example' => 'ha-cn-2r42ostoc01_online_config_v3',
- ],
- ],
- [
- 'name' => 'dirName',
- 'in' => 'query',
- 'schema' => [
- 'description' => 'The name of the directory'."\n",
- 'type' => 'string',
- 'required' => true,
- 'example' => '/zones/general',
- ],
+ 'schema' => ['description' => 'The name of the cluster', 'type' => 'string', 'title' => '', 'required' => false, 'example' => 'bj_vpc_domain_2'],
],
],
'responses' => [
200 => [
'schema' => [
+ 'title' => '',
+ 'description' => 'The response parameters.',
'type' => 'object',
'properties' => [
- 'requestId' => [
- 'title' => 'id of request',
- 'description' => 'The ID of the request.'."\n",
- 'type' => 'string',
- 'example' => '2AE63638-5420-56DC-BF59-37D8174039A0',
- ],
+ 'requestId' => ['title' => '', 'description' => 'The ID of the request.', 'type' => 'string', 'example' => 'E7B7D598-B080-5C8E-AA35-D43EC0D5F886'],
'result' => [
- 'title' => 'List',
- 'description' => 'The advanced configuration files.'."\n",
- 'type' => 'array',
- 'items' => [
- 'description' => 'The result returned.'."\n",
- 'type' => 'object',
- 'properties' => [
- 'name' => [
- 'description' => 'The cluster name.'."\n",
- 'type' => 'string',
- 'example' => 'file_name_1',
- ],
- 'fullPathName' => [
- 'description' => 'The absolute path in which the file is stored.'."\n",
- 'type' => 'string',
- 'example' => '"/path/wpd/nae"',
+ 'title' => '',
+ 'description' => 'The clusters.',
+ 'type' => 'object',
+ 'properties' => [
+ 'name' => ['description' => 'The cluster name.', 'type' => 'string', 'title' => '', 'example' => 'bj_vpc_domain_2'],
+ 'description' => ['description' => 'The description of the cluster.', 'type' => 'string', 'example' => 'Custom description', 'title' => ''],
+ 'currentAdvanceConfigVersion' => ['description' => 'The effective advanced configuration version.', 'type' => 'string', 'title' => '', 'example' => 'ha-cn-pl32rf0****_offline_adv_v1'],
+ 'latestAdvanceConfigVersion' => ['description' => 'The latest advanced configuration version.', 'type' => 'string', 'title' => '', 'example' => 'ha-cn-pl32rf0****_offline_adv_v1'],
+ 'currentOnlineConfigVersion' => ['description' => 'The effective online configuration version.', 'type' => 'string', 'title' => '', 'example' => 'ha-cn-pl32rf0****_online_adv_v1'],
+ 'latestOnlineConfigVersion' => ['description' => 'The latest online configuration version.', 'type' => 'string', 'title' => '', 'example' => 'ha-cn-pl32rf0****_online_adv_v1'],
+ 'configUpdateTime' => ['description' => 'The time when the cluster was updated.', 'type' => 'string', 'title' => '', 'example' => '2021-08-09 00:01:02'],
+ 'status' => ['description' => 'The creation status of the cluster. Valid values: NEW and PUBLISH. NEW indicates that the cluster is being created. PUBLISH indicates that the cluster is created.', 'type' => 'string', 'example' => 'NEW', 'title' => ''],
+ 'queryNode' => [
+ 'description' => 'The specifications of Query Result Searcher (QRS) workers.',
+ 'type' => 'object',
+ 'properties' => [
+ 'name' => ['description' => 'The name of the QRS worker.', 'type' => 'string', 'title' => '', 'example' => 'ha-cn-pl32rf0****_qrs'],
+ 'number' => ['description' => 'The number of nodes.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''],
+ 'partition' => ['description' => 'The number of replicas.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '2'],
],
- 'isDir' => [
- 'description' => 'Indicates whether the file is a directory. Valid values: true and false.'."\n",
- 'type' => 'boolean',
- 'example' => 'true',
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'dataNode' => [
+ 'description' => 'The specifications of Searcher workers.',
+ 'type' => 'object',
+ 'properties' => [
+ 'name' => ['description' => 'The name of the Searcher worker.', 'type' => 'string', 'title' => '', 'example' => 'general'],
+ 'number' => ['description' => 'The number of replicas.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''],
+ 'partition' => ['description' => 'The number of partitions.', 'type' => 'integer', 'format' => 'int32', 'example' => '2', 'title' => ''],
],
- 'isTemplate' => [
- 'description' => 'Indicates whether the file is a template. Valid values: **true** and **false**.'."\n",
- 'type' => 'boolean',
- 'example' => 'true',
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'createTime' => ['description' => 'The time when the cluster was created.', 'type' => 'string', 'example' => '2024-05-21 16:05:26', 'title' => ''],
+ 'config' => [
+ 'description' => 'The configuration information.',
+ 'type' => 'object',
+ 'additionalProperties' => [
+ 'type' => 'object',
+ 'additionalProperties' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'name' => ['description' => 'The configuration name.', 'type' => 'string', 'example' => 'ha-cn-pl32rf0****_offline_adv_v1'."\n", 'title' => ''],
+ 'updateTime' => ['description' => 'The time when the configuration was updated.', 'type' => 'string', 'example' => '2024-05-21 16:05:26', 'title' => ''],
+ 'desc' => ['description' => 'The description of the configuration.', 'type' => 'string', 'example' => '自定义描述', 'title' => ''],
+ ],
+ 'description' => 'The information about the child configuration item.',
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'description' => 'The information about child configuration items.',
+ 'title' => '',
+ 'example' => '',
],
+ 'title' => '',
+ 'example' => '',
],
],
+ 'example' => '',
],
],
- 'description' => '',
+ 'example' => '',
],
],
500 => [],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"2AE63638-5420-56DC-BF59-37D8174039A0\\",\\n \\"result\\": [\\n {\\n \\"name\\": \\"hz_pre_vpc_domain_1\\",\\n \\"fullPathName\\": \\"/path/wpd/nae\\",\\n \\"isDir\\": true,\\n \\"isTemplate\\": true\\n }\\n ]\\n}","type":"json"}]',
- 'title' => 'ListAdvanceConfigDir',
- 'summary' => 'Queries the files in an advanced configuration directory.',
- 'description' => '## Method'."\n"
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"E7B7D598-B080-5C8E-AA35-D43EC0D5F886\\",\\n \\"result\\": {\\n \\"name\\": \\"bj_vpc_domain_2\\",\\n \\"description\\": \\"Custom description\\",\\n \\"currentAdvanceConfigVersion\\": \\"ha-cn-pl32rf0****_offline_adv_v1\\",\\n \\"latestAdvanceConfigVersion\\": \\"ha-cn-pl32rf0****_offline_adv_v1\\",\\n \\"currentOnlineConfigVersion\\": \\"ha-cn-pl32rf0****_online_adv_v1\\",\\n \\"latestOnlineConfigVersion\\": \\"ha-cn-pl32rf0****_online_adv_v1\\",\\n \\"configUpdateTime\\": \\"2021-08-09 00:01:02\\",\\n \\"status\\": \\"NEW\\",\\n \\"queryNode\\": {\\n \\"name\\": \\"ha-cn-pl32rf0****_qrs\\",\\n \\"number\\": 1,\\n \\"partition\\": 2\\n },\\n \\"dataNode\\": {\\n \\"name\\": \\"general\\",\\n \\"number\\": 1,\\n \\"partition\\": 2\\n },\\n \\"createTime\\": \\"2024-05-21 16:05:26\\",\\n \\"config\\": {\\n \\"key\\": {\\n \\"key\\": {\\n \\"name\\": \\"ha-cn-pl32rf0****_offline_adv_v1\\\\n\\",\\n \\"updateTime\\": \\"2024-05-21 16:05:26\\",\\n \\"desc\\": \\"自定义描述\\"\\n }\\n }\\n }\\n }\\n}","type":"json"}]',
+ 'title' => 'GetCluster',
+ 'description' => '### Method'."\n"
."\n"
.'`GET`'."\n"
."\n"
- .'## URI'."\n"
- ."\n"
- .'`/openapi/ha3/instances/{instanceId}/advanced-configs/{configName}/dir?dirName={dirName}`'."\n",
- 'requestParamsDescription' => '## Sample requests'."\n"
+ .'### URI'."\n"
."\n"
- .'`GET /openapi/ha3/instances/ose-test1/advanced-configs`'."\n",
- 'responseParamsDescription' => '## Sample responses'."\n"
+ .'`/openapi/ha3/instance/{instanceId}/clusters/{clusterName}`',
+ 'requestParamsDescription' => '### Sample requests'."\n"
."\n"
- .'### Success responses'."\n"
+ .'`GET /openapi/ha3/instance/ha_name_example/clusters/my_cluster`',
+ 'responseParamsDescription' => '### Sample responses'."\n"
."\n"
- .'```json'."\n"
+ .'```'."\n"
.'{'."\n"
- .' "requestId": "0A6EB64B-B4C8-CF02-810F-E660812972FF",'."\n"
- .' "result": ['."\n"
- .' {'."\n"
- .' "name": "file_name_1",'."\n"
- .' "fullPathName": "/path/wpd/nae",'."\n"
- .' "isDir": true,'."\n"
- .' "isTemplate": true'."\n"
- .' }'."\n"
- .' ]'."\n"
+ .' "requestId": "e1eef569-1ff7-4bf8-acf7-1cecca9894ce",'."\n"
+ .' "result": {'."\n"
+ .' "name": "cluster1",'."\n"
+ .' "configUpdateTime": "2021-08-09 00:01:02",'."\n"
+ .' "CurrentAdvanceConfigVersion": "test_yyds_data1",'."\n"
+ .' "lastestAdvanceConfigVersion": "test_yyds_data1",'."\n"
+ .' "currentOnlineConfigVersion": "test_yyds_data1",'."\n"
+ .' "lastestOnlineConfigVersion": "test_yyds_data1", '."\n"
+ .' "description": "airecpre",'."\n"
+ .' "queryNode": {'."\n"
+ .' "name":"ha-cn-0ju2iimcu07_qrs",'."\n"
+ .' "number": 1'."\n"
+ .' },'."\n"
+ .' "dataNode": {'."\n"
+ .' "name":"general",'."\n"
+ .' "number": 2,'."\n"
+ .' "partition": 1'."\n"
+ .' } '."\n"
+ .' }'."\n"
.'}'."\n"
- .'```'."\n",
- ],
- 'ListAdvanceConfigs' => [
- 'path' => '/openapi/ha3/instances/{instanceId}/advanced-configs',
- 'methods' => [
- 'get',
+ .'```',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetCluster'],
+ ],
],
- 'schemes' => [
- 'http',
- 'https',
+ 'ramActions' => [
+ [
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'searchengine:GetCluster',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SearchEngine', 'resourceType' => 'Instance', 'arn' => 'acs:searchengine:{#regionId}:{#accountId}:instance/{#InstanceId}'],
+ ],
+ ],
+ ],
],
+ ],
+ 'GetClusterRunTimeInfo' => [
+ 'summary' => 'Queries the runtime information about a specified cluster.',
+ 'path' => '/openapi/ha3/instances/{instanceId}/cluster-run-time-info',
+ 'methods' => ['get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
@@ -8042,212 +4240,348 @@
],
'operationType' => 'read',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'list',
- 'abilityTreeCode' => '104702',
- 'abilityTreeNodes' => [
- 'FEATUREopensearchA6GC80',
- ],
- ],
+ 'systemTags' => ['operationType' => 'get'],
'parameters' => [
[
'name' => 'instanceId',
'in' => 'path',
- 'schema' => [
- 'description' => 'The instance ID.'."\n",
- 'type' => 'string',
- 'required' => true,
- 'example' => 'ha-cn-pl32rf0js04',
- ],
- ],
- [
- 'name' => 'type',
- 'in' => 'query',
- 'schema' => [
- 'title' => 'ONLINE: 在线配置, ONLINE_CAVA, ONLINE_PLUGIN, ONLINE_QUERY, OFFLINE_DICT: 离线配置, OFFLINE_TABLE, OFFLINE_COMMON, OFFLINE_PLUGIN, OFFLINE_INDEX',
- 'description' => 'The type of advanced configurations that you want to query. Valid values: - online -offline (default)'."\n",
- 'type' => 'string',
- 'required' => false,
- 'example' => 'online',
- 'default' => 'OFFLINE_DICT',
- ],
- ],
- [
- 'name' => 'dataSourceName',
- 'in' => 'query',
- 'schema' => [
- 'description' => 'The name of the data source.'."\n",
- 'type' => 'string',
- 'required' => false,
- 'example' => 'ha-cn-pl32rf0****_test_api'."\n",
- ],
- ],
- [
- 'name' => 'indexName',
- 'in' => 'query',
- 'schema' => [
- 'description' => 'The index name.'."\n",
- 'type' => 'string',
- 'required' => false,
- 'example' => 'test_api',
- ],
- ],
- [
- 'name' => 'newMode',
- 'in' => 'query',
- 'schema' => [
- 'description' => 'Specifies whether the OpenSearch Vector Search Edition instance is of the new version.'."\n",
- 'type' => 'boolean',
- 'required' => false,
- 'example' => 'true',
- ],
- ],
- [
- 'name' => 'pageNumber',
- 'in' => 'query',
- 'schema' => [
- 'type' => 'string',
- ],
- ],
- [
- 'name' => 'pageSize',
- 'in' => 'query',
- 'schema' => [
- 'type' => 'string',
- ],
+ 'schema' => ['description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'ha-cn-pl32rf0****'."\n"],
],
],
'responses' => [
200 => [
'schema' => [
- 'description' => 'The response parameters.'."\n",
+ 'title' => '',
+ 'description' => 'The results returned.',
'type' => 'object',
'properties' => [
- 'requestId' => [
- 'title' => 'id of request',
- 'description' => 'The ID of the request.',
- 'type' => 'string',
- 'example' => '4FB0325E-8C37-5525-96AC-0333523170A3',
- ],
+ 'requestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => 'E45380E8-994A-5402-9806-F114B3295FCF'],
'result' => [
- 'title' => 'List',
- 'description' => 'The advanced configurations.'."\n",
+ 'title' => '',
+ 'description' => 'The result.',
'type' => 'array',
'items' => [
- 'description' => 'The result returned.',
+ 'description' => 'The runtime information of the cluster.',
'type' => 'object',
'properties' => [
- 'updateTime' => [
- 'title' => '更新时间',
- 'description' => 'The time when the advanced configuration was updated.'."\n",
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '1631070464000',
- ],
- 'desc' => [
- 'title' => '高级配置描述信息',
- 'description' => 'The description of the advanced configuration.'."\n",
- 'type' => 'string',
- 'example' => 'test',
+ 'clusterName' => ['description' => 'The cluster name.', 'type' => 'string', 'title' => '', 'example' => 'vpc_hz_domain_1'],
+ 'queryNode' => [
+ 'title' => '',
+ 'description' => 'The information about the Query Result Searcher (QRS) workers.',
+ 'type' => 'object',
+ 'properties' => [
+ 'serviceStatus' => [
+ 'title' => '',
+ 'description' => 'The service status of the QRS worker.',
+ 'type' => 'object',
+ 'properties' => [
+ 'name' => ['description' => 'The cluster name.', 'type' => 'string', 'example' => 'vpc_hz_domain_1'."\n", 'title' => ''],
+ 'totalSize' => ['description' => 'The total number of QRS workers in the cluster.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '100'],
+ 'doneSize' => ['description' => 'The number of processed QRS workers in the cluster.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '100'],
+ 'donePercent' => ['description' => 'The process progress of QRS workers in the cluster. Unit: percentage.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '100'],
+ ],
+ 'example' => '',
+ ],
+ 'configStatusList' => [
+ 'description' => 'The configuration status.',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => '',
+ 'type' => 'object',
+ 'properties' => [
+ 'configUpdateTime' => ['description' => 'The time when the configuration was last updated.', 'type' => 'string', 'example' => '2024-05-21 16:05:26', 'title' => ''],
+ 'name' => ['description' => 'The cluster name.', 'type' => 'string', 'example' => 'vpc_hz_domain_1'."\n", 'title' => ''],
+ 'totalSize' => ['description' => 'The total number of QRS workers in the cluster.', 'type' => 'integer', 'format' => 'int32', 'example' => '6', 'title' => ''],
+ 'doneSize' => ['description' => 'The number of processed QRS workers in the cluster.', 'type' => 'integer', 'format' => 'int32', 'example' => '100', 'title' => ''],
+ 'donePercent' => ['description' => 'The process progress of QRS workers in the cluster. Unit: percentage.', 'type' => 'integer', 'format' => 'int32', 'example' => '100', 'title' => ''],
+ ],
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'title' => '',
+ 'example' => '',
+ ],
+ ],
+ 'example' => '',
],
- 'files' => [
- 'title' => '文件名列表',
- 'description' => 'The files.'."\n",
+ 'dataNodes' => [
+ 'title' => '',
+ 'description' => 'The information about the Searcher workers.',
'type' => 'array',
'items' => [
- 'description' => 'The information about files.',
+ 'description' => 'The information about the cluster node.',
'type' => 'object',
'properties' => [
- 'name' => [
- 'description' => 'The file name.'."\n",
- 'type' => 'string',
- 'example' => 'file_name_1',
- ],
- 'fullPathName' => [
- 'description' => 'The absolute path in which the file is stored.'."\n",
- 'type' => 'string',
- 'example' => '/path/wpd/nae',
+ 'dataStatusList' => [
+ 'description' => 'The data of the Searcher worker.',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => '',
+ 'type' => 'object',
+ 'properties' => [
+ 'docSize' => ['description' => 'The storage capacity. Unit: GB.', 'type' => 'integer', 'format' => 'int32', 'example' => '2', 'title' => ''],
+ 'fullVersion' => ['description' => 'The time when the full index version was generated.', 'type' => 'integer', 'format' => 'int64', 'example' => '1718846192', 'title' => ''],
+ 'incVersion' => ['description' => 'The time when the incremental index version was generated.', 'type' => 'integer', 'format' => 'int64', 'example' => '1718846192', 'title' => ''],
+ 'incUpdateTime' => ['description' => 'The time when incremental data in the index was last updated.', 'type' => 'string', 'example' => '2024-05-21 16:05:26', 'title' => ''],
+ 'fullUpdateTime' => ['description' => 'The time when full data in the index was last updated.', 'type' => 'string', 'example' => '2024-05-21 16:05:26', 'title' => ''],
+ 'indexConfigInfo' => [
+ 'description' => 'The information about the index configuration.',
+ 'type' => 'object',
+ 'properties' => [
+ 'configMetaName' => ['description' => 'The name of the index configuration.', 'type' => 'string', 'example' => 'index_meta_name', 'title' => ''],
+ 'version' => ['description' => 'The version of the index template.', 'type' => 'integer', 'format' => 'int64', 'example' => '1.0.0', 'title' => ''],
+ ],
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'advanceConfigInfo' => [
+ 'description' => 'The information about the advanced configuration.',
+ 'type' => 'object',
+ 'properties' => [
+ 'configMetaName' => ['description' => 'The name of the index configuration.', 'type' => 'string', 'example' => 'index_meta_name', 'title' => ''],
+ 'version' => ['description' => 'The version number.', 'type' => 'integer', 'format' => 'int64', 'example' => '1.0', 'title' => ''],
+ ],
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'lackMemWorker' => [
+ 'description' => 'The name of the worker that failed due to insufficient memory.',
+ 'type' => 'array',
+ 'items' => ['description' => 'The name of the failed worker.', 'type' => 'string', 'example' => 'test-fail-worker'."\n", 'title' => ''],
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'deployFailedWorker' => [
+ 'description' => 'The name of the worker that failed due to a deployment failure.',
+ 'type' => 'array',
+ 'items' => ['description' => 'The name of the failed worker.', 'type' => 'string', 'example' => 'test-fail-worker'."\n", 'title' => ''],
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'lackDiskWorker' => [
+ 'description' => 'The name of the worker that failed due to insufficient disks.',
+ 'type' => 'array',
+ 'items' => ['description' => 'The name of the failed worker.', 'type' => 'string', 'example' => 'test-fail-worker', 'title' => ''],
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'errorMsg' => ['description' => 'The error message.', 'type' => 'string', 'example' => '0A3B1C48006A6C0905F6375F4821EB50', 'title' => ''],
+ 'indexSize' => ['description' => 'The index size.', 'type' => 'integer', 'format' => 'int64', 'example' => '100', 'title' => ''],
+ 'name' => ['description' => 'The name of the QRS worker.', 'type' => 'string', 'example' => 'ha-cn-pl32rf0****_qrs', 'title' => ''],
+ 'totalSize' => ['description' => 'The total number of QRS workers in the cluster.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''],
+ 'doneSize' => ['description' => 'The number of processed QRS workers in the cluster.', 'type' => 'integer', 'format' => 'int32', 'example' => '100', 'title' => ''],
+ 'donePercent' => ['description' => 'The configuration progress. Unit: percentage.', 'type' => 'integer', 'format' => 'int32', 'example' => '100', 'title' => ''],
+ ],
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'title' => '',
+ 'example' => '',
],
- 'isDir' => [
- 'description' => 'Indicates whether the file is a directory. Valid values: true and false.'."\n",
- 'type' => 'boolean',
- 'example' => 'true',
+ 'serviceStatus' => [
+ 'description' => 'The service status of the QRS worker.',
+ 'type' => 'object',
+ 'properties' => [
+ 'name' => ['description' => 'The name of the QRS worker.', 'type' => 'string', 'example' => 'ha-cn-pl32rf0****_qrs', 'title' => ''],
+ 'totalSize' => ['description' => 'The total number of QRS workers in the cluster.', 'type' => 'integer', 'format' => 'int32', 'example' => '100', 'title' => ''],
+ 'doneSize' => ['description' => 'The number of processed QRS workers in the cluster.', 'type' => 'integer', 'format' => 'int32', 'example' => '100', 'title' => ''],
+ 'donePercent' => ['description' => 'The process progress of QRS workers in the cluster. Unit: percentage.', 'type' => 'integer', 'format' => 'int32', 'example' => '100', 'title' => ''],
+ ],
+ 'title' => '',
+ 'example' => '',
],
- 'isTemplate' => [
- 'description' => 'Indicates whether the file is a template. Valid values: true and false.'."\n",
- 'type' => 'boolean',
- 'example' => 'true',
+ 'configStatusList' => [
+ 'description' => 'The configuration status.',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'The response body.',
+ 'type' => 'object',
+ 'properties' => [
+ 'configUpdateTime' => ['description' => 'The time when the configuration was last updated.', 'type' => 'string', 'example' => '2024-05-21 16:05:26', 'title' => ''],
+ 'name' => ['description' => 'The cluster name.', 'type' => 'string', 'example' => 'test_0704', 'title' => ''],
+ 'totalSize' => ['description' => 'The total number of Searcher workers in the cluster.', 'type' => 'integer', 'format' => 'int32', 'example' => '0', 'title' => ''],
+ 'doneSize' => ['description' => 'The number of processed Searcher workers in the cluster.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''],
+ 'donePercent' => ['description' => 'The configuration progress. Unit: percentage.', 'type' => 'integer', 'format' => 'int32', 'example' => '100', 'title' => ''],
+ ],
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'title' => '',
+ 'example' => '',
],
],
+ 'title' => '',
+ 'example' => '',
],
- ],
- 'content' => [
- 'title' => '配置内容 http，git 请求时不为空',
- 'description' => 'The content of the advanced configuration that is returned.'."\n",
- 'type' => 'string',
- 'example' => '{\\"url\\":\\"http://xxxxxx.aliyuncs.com/outnet_hz/packages/xxxxx/opensearch_offline_plugins_xxxxx.tar\\"}',
- ],
- 'contentType' => [
- 'title' => '配置内容的类型 (FILE, GIT, HTTP, ODPS)',
- 'description' => 'The type of the configuration content. Valid values: FILE, GIT, HTTP, and ODPS.'."\n",
- 'type' => 'string',
- 'example' => 'FILE',
- ],
- 'name' => [
- 'title' => '配置名称',
- 'description' => 'The name of the advanced configuration.'."\n",
- 'type' => 'string',
- 'example' => 'my_index',
- ],
- 'status' => [
- 'title' => '配置状态 (drafting: 草稿, used: 线上使用, unused: 未使用, trash: 删除中)',
- 'description' => 'The status of the advanced configuration. Valid values: drafting: The advanced configuration is in the draft state. used: The advanced configuration is being used. unused: The advanced configuration is not used. trash: The advanced configuration is being deleted.'."\n",
- 'type' => 'string',
- 'example' => 'drafting',
- ],
- 'creator' => [
- 'description' => 'The Alibaba Cloud account ID of the user who created the advanced configuration.'."\n",
- 'type' => 'string',
- 'example' => '123456',
- ],
- 'advanceConfigType' => [
- 'description' => '* The type of the advanced configuration. Valid values: -ONLINE: online configuration'."\n"
- .'* \\-ONLINE_CAVA: online Cava configuration'."\n"
- .'* \\-ONLINE_PLUGIN: online plug-in configuration'."\n"
- .'* \\-ONLINE_QUERY: query configuration'."\n"
- .'* \\-OFFLINE_DICT: offline dictionary configuration'."\n"
- .'* \\-OFFLINE_TABLE: offline table configuration'."\n"
- .'* \\-OFFLINE_COMMON: offline configuration'."\n"
- .'* \\-OFFLINE_PLUGIN: offline plug-in configuration'."\n"
- .'* \\-OFFLINE_INDEX: index configuration'."\n",
- 'type' => 'string',
- 'example' => 'ONLINE',
+ 'example' => '',
],
],
+ 'title' => '',
+ 'example' => '',
],
+ 'example' => '',
],
],
+ 'example' => '',
],
],
500 => [],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"4FB0325E-8C37-5525-96AC-0333523170A3\\",\\n \\"result\\": [\\n {\\n \\"updateTime\\": 1631070464000,\\n \\"desc\\": \\"Custom Description\\",\\n \\"files\\": [\\n {\\n \\"name\\": \\"file_name_1\\",\\n \\"fullPathName\\": \\"/path/wpd/nae\\",\\n \\"isDir\\": true,\\n \\"isTemplate\\": true\\n }\\n ],\\n \\"content\\": \\"{\\\\\\\\\\\\\\"url\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"http://xxxxxx.aliyuncs.com/outnet_hz/packages/xxxxx/opensearch_offline_plugins_xxxxx.tar\\\\\\\\\\\\\\"}\\",\\n \\"contentType\\": \\"FILE\\",\\n \\"name\\": \\"my_index\\",\\n \\"status\\": \\"drafting\\",\\n \\"creator\\": \\"123456\\",\\n \\"advanceConfigType\\": \\"ONLINE\\"\\n }\\n ]\\n}","type":"json"}]',
- 'title' => 'ListAdvanceConfigs',
- 'summary' => 'Obtains a list of advanced configurations.',
- 'description' => '## Sample requests'."\n"
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"E45380E8-994A-5402-9806-F114B3295FCF\\",\\n \\"result\\": [\\n {\\n \\"clusterName\\": \\"vpc_hz_domain_1\\",\\n \\"queryNode\\": {\\n \\"serviceStatus\\": {\\n \\"name\\": \\"vpc_hz_domain_1\\\\n\\",\\n \\"totalSize\\": 100,\\n \\"doneSize\\": 100,\\n \\"donePercent\\": 100\\n },\\n \\"configStatusList\\": [\\n {\\n \\"configUpdateTime\\": \\"2024-05-21 16:05:26\\",\\n \\"name\\": \\"vpc_hz_domain_1\\\\n\\",\\n \\"totalSize\\": 6,\\n \\"doneSize\\": 100,\\n \\"donePercent\\": 100\\n }\\n ]\\n },\\n \\"dataNodes\\": [\\n {\\n \\"dataStatusList\\": [\\n {\\n \\"docSize\\": 2,\\n \\"fullVersion\\": 1718846192,\\n \\"incVersion\\": 1718846192,\\n \\"incUpdateTime\\": \\"2024-05-21 16:05:26\\",\\n \\"fullUpdateTime\\": \\"2024-05-21 16:05:26\\",\\n \\"indexConfigInfo\\": {\\n \\"configMetaName\\": \\"index_meta_name\\",\\n \\"version\\": 0\\n },\\n \\"advanceConfigInfo\\": {\\n \\"configMetaName\\": \\"index_meta_name\\",\\n \\"version\\": 1\\n },\\n \\"lackMemWorker\\": [\\n \\"test-fail-worker\\\\n\\"\\n ],\\n \\"deployFailedWorker\\": [\\n \\"test-fail-worker\\\\n\\"\\n ],\\n \\"lackDiskWorker\\": [\\n \\"test-fail-worker\\"\\n ],\\n \\"errorMsg\\": \\"0A3B1C48006A6C0905F6375F4821EB50\\",\\n \\"indexSize\\": 100,\\n \\"name\\": \\"ha-cn-pl32rf0****_qrs\\",\\n \\"totalSize\\": 1,\\n \\"doneSize\\": 100,\\n \\"donePercent\\": 100\\n }\\n ],\\n \\"serviceStatus\\": {\\n \\"name\\": \\"ha-cn-pl32rf0****_qrs\\",\\n \\"totalSize\\": 100,\\n \\"doneSize\\": 100,\\n \\"donePercent\\": 100\\n },\\n \\"configStatusList\\": [\\n {\\n \\"configUpdateTime\\": \\"2024-05-21 16:05:26\\",\\n \\"name\\": \\"test_0704\\",\\n \\"totalSize\\": 0,\\n \\"doneSize\\": 1,\\n \\"donePercent\\": 100\\n }\\n ]\\n }\\n ]\\n }\\n ]\\n}","type":"json"}]',
+ 'title' => 'GetClusterRunTimeInfo',
+ 'description' => '### Method'."\n"
."\n"
- .'`GET /openapi/ha3/instances/ose-test1/advanced-configs`',
- ],
- 'ListSchemas' => [
- 'summary' => '通过数据源配置获取schema信息',
- 'path' => '/openapi/ha3/instances/{instanceId}/schemas',
- 'methods' => [
- 'get',
+ .'GET'."\n"
+ ."\n"
+ .'### URI'."\n"
+ ."\n"
+ .'/openapi/ha3/instances/{instanceId}/cluster-run-time-info',
+ 'requestParamsDescription' => '### Sample requests'."\n"
+ ."\n"
+ .'`GET /openapi/ha3/instances/ose-test1/cluster-run-time-info`',
+ 'responseParamsDescription' => '### ResponseExample'."\n"
+ ."\n"
+ .'Correct response'."\n"
+ ."\n"
+ .'```java'."\n"
+ .'{'."\n"
+ .' "requestId": "38b079f1-7846-4226-8c90-3e2644b5c52b",'."\n"
+ .' "result": ['."\n"
+ .' {'."\n"
+ .' "clusterName": "",'."\n"
+ .' "queryNode": {'."\n"
+ .' "serviceStatus": {'."\n"
+ .' "name": "service_name",'."\n"
+ .' "totalSize": 1,'."\n"
+ .' "doneSize": 1,'."\n"
+ .' "donePercent": 100'."\n"
+ .' },'."\n"
+ .' "configStatusList": ['."\n"
+ .' {'."\n"
+ .' "name": "default",'."\n"
+ .' "totalSize": 1,'."\n"
+ .' "doneSize": 1,'."\n"
+ .' "donePercent": 100,'."\n"
+ .' "configUpdateTime": ""'."\n"
+ .' }'."\n"
+ .' ]'."\n"
+ .' },'."\n"
+ .' "dataNodes": ['."\n"
+ .' {'."\n"
+ .' "serviceStatus": {'."\n"
+ .' "name": "service_name",'."\n"
+ .' "totalSize": 1,'."\n"
+ .' "doneSize": 1,'."\n"
+ .' "donePercent": 100'."\n"
+ .' },'."\n"
+ .' "configStatusList": ['."\n"
+ .' {'."\n"
+ .' "name": "default",'."\n"
+ .' "totalSize": 1,'."\n"
+ .' "doneSize": 1,'."\n"
+ .' "donePercent": 100,'."\n"
+ .' "configUpdateTime": ""'."\n"
+ .' }'."\n"
+ .' ],'."\n"
+ .' "dataStatusList": ['."\n"
+ .' {'."\n"
+ .' "name": "index1",'."\n"
+ .' "totalSize": 1,'."\n"
+ .' "doneSize": 1,'."\n"
+ .' "donePercent": 100,'."\n"
+ .' "docSize": 123423,'."\n"
+ .' "fullVersion": 123423,'."\n"
+ .' "incVersion": 123423,'."\n"
+ .' "incUpdateTime": "",'."\n"
+ .' "fullUpdateTime": "",'."\n"
+ .' "indexConfigInfo": {'."\n"
+ .' "configMetaName": "index_meta_name",'."\n"
+ .' "version": 13241234'."\n"
+ .' },'."\n"
+ .' "advanceConfigInfo": {'."\n"
+ .' "configMetaName": "advance_meta_name",'."\n"
+ .' "version": 13241234'."\n"
+ .' },'."\n"
+ .' "lackMemWorker": ['."\n"
+ .' "worker1",'."\n"
+ .' "worker2"'."\n"
+ .' ],'."\n"
+ .' "deployFailedWorker": ['."\n"
+ .' "worker3",'."\n"
+ .' "worker4"'."\n"
+ .' ],'."\n"
+ .' "lackDiskWorker": ['."\n"
+ .' "worker5",'."\n"
+ .' "worker6"'."\n"
+ .' ],'."\n"
+ .' "errorMsg": "lackMemWorker/deployFailedWorker/lackDiskWorker"'."\n"
+ .' },'."\n"
+ .' {'."\n"
+ .' "name": "index1",'."\n"
+ .' "totalSize": 1,'."\n"
+ .' "doneSize": 1,'."\n"
+ .' "donePercent": 100,'."\n"
+ .' "docSize": 123423,'."\n"
+ .' "fullVersion": 123423,'."\n"
+ .' "incVersion": 123423,'."\n"
+ .' "incUpdateTime": "",'."\n"
+ .' "fullUpdateTime": "",'."\n"
+ .' "indexConfigInfo": {'."\n"
+ .' "configMetaName": "index_meta_name",'."\n"
+ .' "version": 13241234'."\n"
+ .' },'."\n"
+ .' "advanceConfigInfo": {'."\n"
+ .' "configMetaName": "advance_meta_name",'."\n"
+ .' "version": 13241234'."\n"
+ .' },'."\n"
+ .' "lackMemWorker": ['."\n"
+ .' "worker1",'."\n"
+ .' "worker2"'."\n"
+ .' ],'."\n"
+ .' "deployFailedWorker": ['."\n"
+ .' "worker3",'."\n"
+ .' "worker4"'."\n"
+ .' ],'."\n"
+ .' "lackDiskWorker": ['."\n"
+ .' "worker5",'."\n"
+ .' "worker6"'."\n"
+ .' ],'."\n"
+ .' "errorMsg": "lackMemWorker/deployFailedWorker/lackDiskWorker"'."\n"
+ .' }'."\n"
+ .' ]'."\n"
+ .' }'."\n"
+ .' ]'."\n"
+ .' }'."\n"
+ .' ]'."\n"
+ .'}'."\n"
+ .'```',
+ 'extraInfo' => "\n"
+ ."\n",
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetClusterRunTimeInfo'],
+ ],
],
- 'schemes' => [
- 'http',
- 'https',
+ 'ramActions' => [
+ [
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'searchengine:GetClusterRunTimeInfo',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SearchEngine', 'resourceType' => 'Instance', 'arn' => 'acs:searchengine:{#regionId}:{#accountId}:instance/{#InstanceId}'],
+ ],
+ ],
+ ],
],
+ ],
+ 'GetDataSource' => [
+ 'summary' => 'Obtains a data source.',
+ 'path' => '/openapi/ha3/instances/{instanceId}/data-sources/{dataSourceName}',
+ 'methods' => ['get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
@@ -8255,699 +4589,336 @@
],
'operationType' => 'read',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'list',
- 'abilityTreeCode' => '186763',
- 'abilityTreeNodes' => [
- 'FEATUREopensearchVHEWK3',
- ],
- ],
+ 'systemTags' => ['operationType' => 'get'],
'parameters' => [
[
- 'name' => 'type',
- 'in' => 'query',
- 'schema' => [
- 'title' => 'odps, swift, saro, oss, unKnow',
- 'description' => 'The type of the data source. Valid values: odps, swift, saro, oss, and unKnow.'."\n",
- 'type' => 'string',
- 'required' => true,
- 'example' => 'odps',
- ],
- ],
- [
- 'name' => 'endpoint',
- 'in' => 'query',
- 'schema' => [
- 'description' => 'The endpoint of the MaxCompute data source.'."\n",
- 'type' => 'string',
- 'required' => false,
- 'example' => 'http://service.cn-hangzhou.maxcompute.aliyun-inc.com/api',
- ],
- ],
- [
- 'name' => 'accessKey',
- 'in' => 'query',
- 'schema' => [
- 'description' => 'The AccessKey ID of the MaxCompute data source.'."\n",
- 'type' => 'string',
- 'required' => false,
- 'example' => 'ak',
- ],
- ],
- [
- 'name' => 'accessSecret',
- 'in' => 'query',
- 'schema' => [
- 'description' => 'The AccessKey secret of the MaxCompute data source.'."\n",
- 'type' => 'string',
- 'required' => false,
- 'example' => 'as',
- ],
- ],
- [
- 'name' => 'project',
- 'in' => 'query',
- 'schema' => [
- 'description' => 'The name of the MaxCompute project that is used as the data source.'."\n",
- 'type' => 'string',
- 'required' => false,
- 'example' => 'start-flask-v3-obcc',
- ],
- ],
- [
- 'name' => 'partition',
- 'in' => 'query',
- 'schema' => [
- 'description' => 'The shard name.'."\n",
- 'type' => 'string',
- 'required' => false,
- 'example' => 'dt=20230520',
- ],
- ],
- [
- 'name' => 'table',
- 'in' => 'query',
- 'schema' => [
- 'description' => 'The name of the MaxCompute table that is used as the data source.'."\n",
- 'type' => 'string',
- 'required' => false,
- 'example' => 'item',
- ],
- ],
- [
- 'name' => 'namespace',
- 'in' => 'query',
- 'schema' => [
- 'description' => 'The namespace of the SARO data source.'."\n",
- 'type' => 'string',
- 'required' => false,
- 'example' => 'igraph-cn-tl32wnrhi04',
- ],
+ 'name' => 'instanceId',
+ 'in' => 'path',
+ 'schema' => ['description' => 'The instance ID.', 'type' => 'string', 'required' => false, 'example' => 'ha-cn-pl32rf0****', 'title' => ''],
],
[
- 'name' => 'instanceId',
+ 'name' => 'dataSourceName',
'in' => 'path',
- 'schema' => [
- 'description' => 'The instance ID.'."\n",
- 'type' => 'string',
- 'required' => true,
- 'example' => 'ha-cn-0ju2rq6610a',
- ],
+ 'schema' => ['description' => 'The name of the data source.', 'type' => 'string', 'required' => false, 'example' => 'ha-cn-pl32rf0****_test_api', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
+ 'description' => 'The response parameters.',
'type' => 'object',
'properties' => [
- 'requestId' => [
- 'title' => 'id of request',
- 'description' => 'The request ID.'."\n",
- 'type' => 'string',
- 'example' => 'FE03180A-0E29-5474-8A86-33F0683294A4',
- ],
+ 'requestId' => ['title' => '', 'description' => 'Id of the request', 'type' => 'string', 'example' => 'FE03180A-0E29-5474-8A86-33F0683294A4'],
'result' => [
- 'title' => 'Object',
- 'description' => 'The result.'."\n",
- 'type' => 'any',
- 'example' => '{}',
+ 'title' => '',
+ 'description' => 'The information about the data source.',
+ 'type' => 'object',
+ 'properties' => [
+ 'name' => ['description' => 'The name of the data source.', 'type' => 'string', 'title' => '', 'example' => 'ha-cn-pl32rf0****_test_api'],
+ 'type' => ['description' => 'The type of the data source', 'type' => 'string', 'title' => '', 'example' => 'odps'],
+ 'domain' => ['description' => 'The data center where the data source is deployed in offline mode', 'type' => 'string', 'title' => '', 'example' => 'vpc_hz_domain_1'],
+ 'indexes' => [
+ 'title' => '',
+ 'description' => 'The list of index information',
+ 'type' => 'array',
+ 'items' => ['description' => 'The index table', 'type' => 'string', 'example' => 'index1', 'title' => ''],
+ 'example' => '',
+ ],
+ 'lastFulTime' => ['description' => 'The time when the full data of the data source was last queried.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '1718787219'],
+ 'status' => ['description' => 'The status of the data source. Valid values: new: The data source is being created. publish: The data source is in the normal state. trash: The data source is being deleted.', 'type' => 'string', 'title' => '', 'example' => 'new'],
+ ],
+ 'example' => '',
],
],
- 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
],
500 => [],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"FE03180A-0E29-5474-8A86-33F0683294A4\\",\\n \\"result\\": \\"{}\\"\\n}","type":"json"}]',
- 'title' => 'ListSchemas',
- ],
- 'ModifyDataSourceDeploy' => [
- 'summary' => '修改数据源部署信息',
- 'path' => '/openapi/ha3/instances/{instanceId}/data-sources/{dataSourceName}/deploys/{deployName}',
- 'methods' => [
- 'put',
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"FE03180A-0E29-5474-8A86-33F0683294A4\\",\\n \\"result\\": {\\n \\"name\\": \\"ha-cn-pl32rf0****_test_api\\",\\n \\"type\\": \\"odps\\",\\n \\"domain\\": \\"vpc_hz_domain_1\\",\\n \\"indexes\\": [\\n \\"index1\\"\\n ],\\n \\"lastFulTime\\": 1718787219,\\n \\"status\\": \\"new\\"\\n }\\n}","type":"json"}]',
+ 'title' => 'GetDataSource',
+ 'description' => '### Method'."\n"
+ ."\n"
+ .'`GET`'."\n"
+ ."\n"
+ .'### URI'."\n"
+ ."\n"
+ .'`/openapi/ha3/instances/{instanceId}/data-sources/{dataSourceName}`',
+ 'requestParamsDescription' => '### Sample requests'."\n"
+ ."\n"
+ .'`GET /openapi/ha3/instances/ha3_instances_id/data-sources/my_data_source`',
+ 'responseParamsDescription' => '### ResponseExample'."\n"
+ ."\n"
+ .'```'."\n"
+ .'{'."\n"
+ .' "requestId": "0A6EB64B-B4C8-CF02-810F-E660812972FF",'."\n"
+ .' "result": {'."\n"
+ .' "name": "data_source_name",'."\n"
+ .' "type": "odps",'."\n"
+ .' "domain": "test", // Offline deployment '."\n"
+ .' "indexes": ['."\n"
+ .' "index1",'."\n"
+ .' "index2"'."\n"
+ .' ],'."\n"
+ .' "partitions": ['."\n"
+ .' "ds=2020",'."\n"
+ .' "ds=2021"'."\n"
+ .' ],'."\n"
+ .' "lastFulTime": 1628502036000,'."\n"
+ .' "config":{'."\n"
+ .' "accessKey": "xxx",'."\n"
+ .' "accessSecret": "xxxs",'."\n"
+ .' "project":"xxxx",'."\n"
+ .' "table":"xxx",'."\n"
+ .' "partition":"xxxx"'."\n"
+ .' },'."\n"
+ .' "autoBuildIndex": true,'."\n"
+ .' "status": "new" // new: Createin; publish: normal; trash: Deletein'."\n"
+ .' '."\n"
+ .' }'."\n"
+ .'}'."\n"
+ .'```',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetDataSource'],
+ ],
],
- 'schemes' => [
- 'http',
- 'https',
+ 'ramActions' => [
+ [
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'searchengine:GetDataSource',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SearchEngine', 'resourceType' => 'Instance', 'arn' => 'acs:searchengine:{#regionId}:{#accountId}:instance/{#InstanceId}'],
+ ],
+ ],
+ ],
],
+ ],
+ 'GetDataSourceDeploy' => [
+ 'summary' => 'Retrieves the deployment information for a data source.',
+ 'path' => '/openapi/ha3/instances/{instanceId}/data-sources/{dataSourceName}/deploys/{deployName}',
+ 'methods' => ['get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
- 'operationType' => 'write',
+ 'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
- 'operationType' => 'update',
- 'riskType' => 'none',
- 'chargeType' => 'free',
- 'abilityTreeCode' => '159954',
- 'abilityTreeNodes' => [
- 'FEATUREopensearchVHEWK3',
- ],
+ 'operationType' => 'get',
+ 'abilityTreeCode' => '159951',
+ 'abilityTreeNodes' => ['FEATUREopensearchA944AC', 'FEATUREopensearchS8X6T8'],
],
'parameters' => [
[
'name' => 'instanceId',
'in' => 'path',
- 'schema' => [
- 'description' => 'The cluster ID.'."\n",
- 'type' => 'string',
- 'required' => true,
- 'example' => 'ha-cn-0ju2rps6c08',
- ],
+ 'schema' => ['description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'ha-cn-pl32rf0****'],
],
[
'name' => 'deployName',
'in' => 'path',
- 'schema' => [
- 'description' => 'The name of the data center.'."\n",
- 'type' => 'string',
- 'required' => true,
- 'example' => 'vpc_hz_domain_1',
- ],
+ 'schema' => ['description' => 'The data center.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'vpc_hz_domain_1'],
],
[
'name' => 'dataSourceName',
'in' => 'path',
- 'schema' => [
- 'description' => 'The name of the data source.'."\n",
- 'type' => 'string',
- 'required' => true,
- 'example' => 'ha-cn-0ju2rps6c08_api_test',
- ],
- ],
- [
- 'name' => 'generationId',
- 'in' => 'query',
- 'schema' => [
- 'description' => 'The ID of the full index version.'."\n",
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => false,
- 'example' => '1708674867',
- ],
- ],
- [
- 'name' => 'dryRun',
- 'in' => 'query',
- 'schema' => [
- 'description' => 'Specifies whether to perform only a dry run, without performing the actual request. The system only checks the validity of the data source. Valid values: true and false.'."\n",
- 'type' => 'boolean',
- 'required' => false,
- 'example' => 'true',
- 'default' => 'false',
- ],
+ 'schema' => ['description' => 'The name of the data source.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'ha-cn-pl32rf0****_test_api'],
],
- [
- 'name' => 'body',
- 'in' => 'body',
- 'style' => 'json',
+ ],
+ 'responses' => [
+ 200 => [
'schema' => [
- 'description' => 'The request body.'."\n",
'type' => 'object',
'properties' => [
- 'storage' => [
- 'description' => 'The information about the data source.'."\n",
- 'type' => 'object',
- 'properties' => [
- 'endpoint' => [
- 'title' => 'odps相关',
- 'description' => 'The endpoint of the MaxCompute data source.'."\n",
- 'type' => 'string',
- 'required' => false,
- 'example' => 'http://service.cn-hangzhou.maxcompute.aliyun-inc.com/api',
- ],
- 'accessKey' => [
- 'description' => 'The AccessKey ID of the MaxCompute data source.'."\n",
- 'type' => 'string',
- 'required' => false,
- 'example' => 'ak',
- ],
- 'accessSecret' => [
- 'description' => 'The AccessKey secret of the MaxCompute data source.'."\n",
- 'type' => 'string',
- 'required' => false,
- 'example' => 'as',
- ],
- 'project' => [
- 'description' => 'The name of the MaxCompute project that is used as the data source.'."\n",
- 'type' => 'string',
- 'required' => false,
- 'example' => 'kubenest',
- ],
- 'partition' => [
- 'description' => 'The partition in the MaxCompute table.'."\n",
- 'type' => 'string',
- 'required' => false,
- 'example' => 'ds=20220713',
- ],
- 'table' => [
- 'title' => 'saro、odps相关',
- 'description' => 'The name of the MaxCompute table that is used as the data source.'."\n",
- 'type' => 'string',
- 'required' => false,
- 'example' => 'item',
- ],
- 'namespace' => [
- 'title' => 'saro相关',
- 'description' => 'The namespace. This parameter is applicable to the SARO data source used in the intranet of Alibaba Group.'."\n",
- 'type' => 'string',
- 'required' => false,
- 'example' => 'dp-dev',
- ],
- 'path' => [
- 'title' => 'hdfs相关',
- 'description' => 'The file path in the Apsara File Storage for HDFS file system.'."\n",
- 'type' => 'string',
- 'required' => false,
- 'example' => '/ude_jobs/iflow_offline_data_access',
- ],
- 'ossPath' => [
- 'title' => 'oss数据源相关',
- 'description' => 'The Object Storage Service (OSS) path.'."\n",
- 'type' => 'string',
- 'required' => false,
- 'example' => '/opensearch',
- ],
- 'bucket' => [
- 'description' => 'The name of the OSS bucket.'."\n",
- 'type' => 'string',
- 'required' => false,
- 'example' => 'test-bucket',
- ],
- 'catalog' => [
- 'type' => 'string',
- ],
- 'database' => [
- 'type' => 'string',
- ],
- 'tag' => [
- 'type' => 'string',
- ],
- 'tableFormat' => [
- 'type' => 'string',
- ],
- ],
- 'required' => false,
- ],
- 'autoBuildIndex' => [
- 'title' => '是否开启自动全量',
- 'description' => 'Specifies whether to enable the automatic full indexing feature.'."\n",
- 'type' => 'boolean',
- 'required' => false,
- 'example' => 'true',
- ],
- 'processor' => [
- 'description' => 'The parameters of the process.'."\n",
- 'type' => 'object',
- 'properties' => [
- 'args' => [
- 'title' => '进程启动参数',
- 'description' => 'The startup parameters of the process.'."\n",
- 'type' => 'string',
- 'required' => false,
- 'example' => '{}',
- ],
- 'resource' => [
- 'title' => '资源信息',
- 'description' => 'The resource information.'."\n",
- 'type' => 'string',
- 'required' => false,
- 'example' => '{}',
- ],
- ],
- 'required' => false,
- ],
- 'extend' => [
- 'description' => 'The extended information.'."\n",
+ 'requestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '2AE63638-5420-56DC-BF59-37D8174039A0'],
+ 'result' => [
+ 'title' => '',
+ 'description' => 'The returned result.',
'type' => 'object',
'properties' => [
- 'saro' => [
- 'description' => 'The information about the SARO data source. This parameter is applicable to the SARO data source used in the intranet of Alibaba Group.'."\n",
+ 'storage' => [
+ 'description' => 'The data source information.',
'type' => 'object',
'properties' => [
- 'path' => [
- 'description' => 'The path of the SARO data source.'."\n",
- 'type' => 'string',
- 'required' => false,
- 'example' => '/',
- ],
- 'version' => [
- 'description' => 'The version number of the SARO data source.'."\n",
- 'type' => 'string',
- 'required' => false,
- 'example' => '1',
- ],
+ 'endpoint' => ['title' => '', 'description' => 'The endpoint of the MaxCompute data source.', 'type' => 'string', 'example' => 'http://service.cn-hangzhou.maxcompute.aliyun-inc.com/api'],
+ 'accessKey' => ['description' => 'The AccessKey ID of the MaxCompute data source.', 'type' => 'string', 'title' => '', 'example' => 'L***p'],
+ 'accessSecret' => ['description' => 'The AccessKey secret of the MaxCompute data source.', 'type' => 'string', 'title' => '', 'example' => '5**9a6'],
+ 'project' => ['description' => 'The name of the MaxCompute project.', 'type' => 'string', 'title' => '', 'example' => 'wireless_1688_personal_rec'],
+ 'partition' => ['description' => 'The partition of the MaxCompute data source. For example: ds=20180102', 'type' => 'string', 'title' => '', 'example' => 'ds=20220926'],
+ 'table' => ['title' => '', 'description' => 'The name of the table in the SARO or MaxCompute data source.', 'type' => 'string', 'example' => 'behavior'],
+ 'namespace' => ['title' => '', 'description' => 'Information related to SARO.', 'type' => 'string', 'example' => 'lazada-campaign-flink'],
+ 'path' => ['title' => '', 'description' => 'Information related to HDFS.', 'type' => 'string', 'example' => '/beiming_xobject/dwd_xobjectsandbox__list_create_action_by_new/'],
+ 'ossPath' => ['title' => '', 'description' => 'Information related to the OSS data source.', 'type' => 'string', 'example' => '/opensearch/test.json'],
+ 'bucket' => ['description' => 'The OSS bucket.', 'type' => 'string', 'title' => '', 'example' => 'test-oss-bucket'],
+ 'catalog' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''],
+ 'database' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''],
+ 'tag' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''],
],
- 'required' => false,
+ 'title' => '',
+ 'example' => '',
],
- 'hdfs' => [
- 'description' => 'The information about the Apsara File Storage for HDFS data source.'."\n",
+ 'autoBuildIndex' => ['title' => '', 'description' => 'Indicates whether automatic full indexing is enabled.', 'type' => 'boolean', 'example' => 'true'],
+ 'processor' => [
+ 'description' => 'The processor parameters.',
'type' => 'object',
'properties' => [
- 'path' => [
- 'description' => 'The path of the Apsara File Storage for HDFS data source.'."\n",
- 'type' => 'string',
- 'required' => false,
- 'example' => 'ymsh-service/src/main/java/cn/ymsh/util/jd',
- ],
+ 'args' => ['title' => '', 'description' => 'The startup parameters for the process.', 'type' => 'string', 'example' => '{'."\n"
+ .' "processInfos": [],'."\n"
+ .' "groupId": "opensearch",'."\n"
+ .' "containerConfigs": [],'."\n"
+ .' "priority": {'."\n"
+ .' "minor_priority": 0,'."\n"
+ .' "major_priority": 64'."\n"
+ .' }'."\n"
+ .'}'],
+ 'resource' => ['title' => '', 'description' => 'The resource information.', 'type' => 'string', 'example' => '[{'."\n"
+ .' "_bs_role": "processor.*.inc",'."\n"
+ .' "priority": {'."\n"
+ .' "major_priority": 32,'."\n"
+ .' "minor_priority": 0'."\n"
+ .' },'."\n"
+ .' "slotResources": [{'."\n"
+ .' "slotResources": [{'."\n"
+ .' "amount": 200,'."\n"
+ .' "name": "cpu"'."\n"
+ .' }, {'."\n"
+ .' "amount": 8192,'."\n"
+ .' "name": "mem"'."\n"
+ .' }, {'."\n"
+ .' "amount": 0,'."\n"
+ .' "name": "T4"'."\n"
+ .' }, {'."\n"
+ .' "amount": 10,'."\n"
+ .' "type": "SCALAR",'."\n"
+ .' "name": "disk_ratio_9999"'."\n"
+ .' }, {'."\n"
+ .' "amount": 20480,'."\n"
+ .' "type": "SCALAR",'."\n"
+ .' "name": "disk_size_9999"'."\n"
+ .' }]'."\n"
+ .' }]'."\n"
+ .'}]'],
],
- 'required' => false,
+ 'title' => '',
+ 'example' => '',
],
- 'odps' => [
- 'description' => 'The information about the MaxCompute data source.'."\n",
+ 'extend' => [
+ 'description' => 'The extended content of the field configuration. The key can be \\`vector\\` for vector fields or \\`embedding\\` for fields that require embedding.',
'type' => 'object',
'properties' => [
- 'partitions' => [
- 'description' => 'The partitions in the MaxCompute table.'."\n",
+ 'saro' => [
+ 'description' => 'The information about the SARO data source.',
'type' => 'object',
- 'required' => false,
- 'additionalProperties' => [
- 'type' => 'string',
- 'description' => 'The partition in the MaxCompute table.'."\n",
- 'example' => 'ds=20230824',
+ 'properties' => [
+ 'path' => ['description' => 'The path of the HDFS data source.', 'type' => 'string', 'title' => '', 'example' => 'dist-dmj-job/src/main/java'],
+ 'version' => ['description' => 'The version number.', 'type' => 'string', 'title' => '', 'example' => '0.6.0'],
],
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'hdfs' => [
+ 'description' => 'The HDFS information.',
+ 'type' => 'object',
+ 'properties' => [
+ 'path' => ['description' => 'The path of the HDFS data source.', 'type' => 'string', 'title' => '', 'example' => 'dist-dmj-job/src/main/java'],
+ ],
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'odps' => [
+ 'description' => 'The information about the MaxCompute data source.',
+ 'type' => 'object',
+ 'properties' => [
+ 'partitions' => [
+ 'description' => 'The partition information of the data source.',
+ 'type' => 'object',
+ 'additionalProperties' => ['type' => 'string', 'description' => 'The partition information of the data source.', 'title' => '', 'example' => 'ds=20220926'],
+ 'title' => '',
+ 'example' => '',
+ ],
+ ],
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'oss' => [
+ 'description' => 'The OSS information.',
+ 'type' => 'object',
+ 'properties' => [
+ 'path' => ['description' => 'The path of the OSS data source.', 'type' => 'string', 'title' => '', 'example' => 'oss://opensearch'],
+ ],
+ 'title' => '',
+ 'example' => '',
],
],
- 'required' => false,
+ 'title' => '',
+ 'example' => '',
],
- 'oss' => [
- 'description' => 'The information about the OSS data source.'."\n",
+ 'swift' => [
+ 'title' => '',
+ 'description' => 'The information about incremental data from Swift.',
'type' => 'object',
'properties' => [
- 'path' => [
- 'description' => 'The path of the OSS data source.'."\n",
- 'type' => 'string',
- 'required' => false,
- 'example' => 'oss://test',
- ],
+ 'zk' => ['description' => 'The ZooKeeper service.', 'type' => 'string', 'title' => '', 'example' => 'test-zk'],
+ 'topic' => ['description' => 'The topic.', 'type' => 'string', 'title' => '', 'example' => 'ha-cn-pl32rf0****_test_api'],
],
- 'required' => false,
- ],
- ],
- 'required' => false,
- ],
- 'swift' => [
- 'title' => '增量swift信息',
- 'description' => 'The information about the incremental data source Swift.'."\n",
- 'type' => 'object',
- 'properties' => [
- 'zk' => [
- 'description' => 'zk'."\n",
- 'type' => 'string',
- 'required' => false,
- 'example' => 'zk',
- ],
- 'topic' => [
- 'description' => 'The topic.'."\n",
- 'type' => 'string',
- 'required' => false,
- 'example' => 'ha-cn-0ju2rps6c08_api',
+ 'example' => '',
],
],
- 'required' => false,
- ],
- ],
- 'required' => false,
- ],
- ],
- ],
- 'responses' => [
- 200 => [
- 'schema' => [
- 'type' => 'object',
- 'properties' => [
- 'requestId' => [
- 'title' => 'id of request',
- 'description' => 'The request ID.'."\n",
- 'type' => 'string',
- 'example' => '93A9E542-8CF8-5BA6-99AB-94C0FE520429',
- ],
- 'result' => [
- 'title' => 'Map',
- 'description' => 'The result.'."\n",
- 'type' => 'object',
- 'example' => '{}',
+ 'example' => '',
],
],
'description' => '',
+ 'title' => '',
+ 'example' => '',
],
],
500 => [],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"93A9E542-8CF8-5BA6-99AB-94C0FE520429\\",\\n \\"result\\": {}\\n}","type":"json"}]',
- 'title' => 'ModifyDataSourceDeploy',
- ],
- 'CreateDataSource' => [
- 'summary' => 'Creates data sources.',
- 'path' => '/openapi/ha3/instances/{instanceId}/data-sources',
- 'methods' => [
- 'post',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
- 'security' => [
- [
- 'AK' => [],
- ],
- ],
- 'operationType' => 'read',
- 'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'create',
- 'abilityTreeCode' => '104719',
- 'abilityTreeNodes' => [
- 'FEATUREopensearchVHEWK3',
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"2AE63638-5420-56DC-BF59-37D8174039A0\\",\\n \\"result\\": {\\n \\"storage\\": {\\n \\"endpoint\\": \\"http://service.cn-hangzhou.maxcompute.aliyun-inc.com/api\\",\\n \\"accessKey\\": \\"L***p\\",\\n \\"accessSecret\\": \\"5**9a6\\",\\n \\"project\\": \\"wireless_1688_personal_rec\\",\\n \\"partition\\": \\"ds=20220926\\",\\n \\"table\\": \\"behavior\\",\\n \\"namespace\\": \\"lazada-campaign-flink\\",\\n \\"path\\": \\"/beiming_xobject/dwd_xobjectsandbox__list_create_action_by_new/\\",\\n \\"ossPath\\": \\"/opensearch/test.json\\",\\n \\"bucket\\": \\"test-oss-bucket\\",\\n \\"catalog\\": \\"\\",\\n \\"database\\": \\"\\",\\n \\"tag\\": \\"\\"\\n },\\n \\"autoBuildIndex\\": true,\\n \\"processor\\": {\\n \\"args\\": \\"{\\\\n\\\\t\\\\\\"processInfos\\\\\\": [],\\\\n\\\\t\\\\\\"groupId\\\\\\": \\\\\\"opensearch\\\\\\",\\\\n\\\\t\\\\\\"containerConfigs\\\\\\": [],\\\\n\\\\t\\\\\\"priority\\\\\\": {\\\\n\\\\t\\\\t\\\\\\"minor_priority\\\\\\": 0,\\\\n\\\\t\\\\t\\\\\\"major_priority\\\\\\": 64\\\\n\\\\t}\\\\n}\\",\\n \\"resource\\": \\"[{\\\\n\\\\t\\\\\\"_bs_role\\\\\\": \\\\\\"processor.*.inc\\\\\\",\\\\n\\\\t\\\\\\"priority\\\\\\": {\\\\n\\\\t\\\\t\\\\\\"major_priority\\\\\\": 32,\\\\n\\\\t\\\\t\\\\\\"minor_priority\\\\\\": 0\\\\n\\\\t},\\\\n\\\\t\\\\\\"slotResources\\\\\\": [{\\\\n\\\\t\\\\t\\\\\\"slotResources\\\\\\": [{\\\\n\\\\t\\\\t\\\\t\\\\\\"amount\\\\\\": 200,\\\\n\\\\t\\\\t\\\\t\\\\\\"name\\\\\\": \\\\\\"cpu\\\\\\"\\\\n\\\\t\\\\t}, {\\\\n\\\\t\\\\t\\\\t\\\\\\"amount\\\\\\": 8192,\\\\n\\\\t\\\\t\\\\t\\\\\\"name\\\\\\": \\\\\\"mem\\\\\\"\\\\n\\\\t\\\\t}, {\\\\n\\\\t\\\\t\\\\t\\\\\\"amount\\\\\\": 0,\\\\n\\\\t\\\\t\\\\t\\\\\\"name\\\\\\": \\\\\\"T4\\\\\\"\\\\n\\\\t\\\\t}, {\\\\n\\\\t\\\\t\\\\t\\\\\\"amount\\\\\\": 10,\\\\n\\\\t\\\\t\\\\t\\\\\\"type\\\\\\": \\\\\\"SCALAR\\\\\\",\\\\n\\\\t\\\\t\\\\t\\\\\\"name\\\\\\": \\\\\\"disk_ratio_9999\\\\\\"\\\\n\\\\t\\\\t}, {\\\\n\\\\t\\\\t\\\\t\\\\\\"amount\\\\\\": 20480,\\\\n\\\\t\\\\t\\\\t\\\\\\"type\\\\\\": \\\\\\"SCALAR\\\\\\",\\\\n\\\\t\\\\t\\\\t\\\\\\"name\\\\\\": \\\\\\"disk_size_9999\\\\\\"\\\\n\\\\t\\\\t}]\\\\n\\\\t}]\\\\n}]\\"\\n },\\n \\"extend\\": {\\n \\"saro\\": {\\n \\"path\\": \\"dist-dmj-job/src/main/java\\",\\n \\"version\\": \\"0.6.0\\"\\n },\\n \\"hdfs\\": {\\n \\"path\\": \\"dist-dmj-job/src/main/java\\"\\n },\\n \\"odps\\": {\\n \\"partitions\\": {\\n \\"key\\": \\"ds=20220926\\"\\n }\\n },\\n \\"oss\\": {\\n \\"path\\": \\"oss://opensearch\\"\\n }\\n },\\n \\"swift\\": {\\n \\"zk\\": \\"test-zk\\",\\n \\"topic\\": \\"ha-cn-pl32rf0****_test_api\\"\\n }\\n }\\n}","type":"json"}]',
+ 'title' => 'GetDataSourceDeploy',
+ 'description' => '### Method'."\n"
+ ."\n"
+ .'```java'."\n"
+ .'GET'."\n"
+ .'```'."\n"
+ ."\n"
+ .'### URI'."\n"
+ ."\n"
+ .'```java'."\n"
+ .'/openapi/ha3/instances/{instanceId}/data-sources/{dataSourceName}/deploys/{deployName}'."\n"
+ .'```',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetDataSourceDeploy'],
],
],
- 'parameters' => [
- [
- 'name' => 'instanceId',
- 'in' => 'path',
- 'schema' => [
- 'description' => 'The instance ID.'."\n",
- 'type' => 'string',
- 'required' => true,
- 'example' => 'ha-cn-7e22rgfyb01',
- 'title' => '## Sample responses'."\n"
- ."\n"
- .'### Success responses'."\n"
- ."\n"
- .'```json'."\n"
- .'{'."\n"
- .' "requestId": "0A6EB64B-B4C8-CF02-810F-E660812972FF",'."\n"
- .' "result": []'."\n"
- .'}'."\n"
- .'```'."\n"
- ."\n"
- .'### Error responses'."\n"
- ."\n"
- .' {'."\n"
- .' "requestId": "0A6EB64B-B4C8-CF02-810F-E660812972FF",'."\n"
- .' "result": {'."\n"
- .' "success": false,'."\n"
- .' "data": "some error message"'."\n"
- .' }'."\n"
- .' }'."\n"
- ."\n"
- .'For more information, see [Response struct](~~449578~~).'."\n",
- ],
- ],
+ 'ramActions' => [
[
- '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' => 'body',
- 'in' => 'body',
- 'style' => 'json',
- 'schema' => [
- 'description' => 'The request body.'."\n",
- 'type' => 'object',
- 'properties' => [
- 'name' => [
- 'title' => '数据源名',
- 'description' => 'The name of the data source.'."\n",
- 'type' => 'string',
- 'required' => false,
- 'example' => 'ha-cn-pl32rf0****_test_api',
- ],
- 'type' => [
- 'title' => '数据源类型 (odps, swift, saro, oss, unKnow)',
- 'description' => 'The type of the data source. Valid values: odps, oss, and swift.'."\n",
- 'type' => 'string',
- 'required' => false,
- 'example' => 'odps',
- ],
- 'domain' => [
- 'title' => '离线部署',
- 'description' => 'The data center in which the data source is deployed.'."\n",
- 'type' => 'string',
- 'required' => false,
- 'example' => 'vpc_hz_domain_1',
- ],
- 'config' => [
- 'title' => 'odps 数据源配置',
- 'description' => 'The configuration information.'."\n",
- 'type' => 'object',
- 'properties' => [
- 'endpoint' => [
- 'title' => 'odps相关',
- 'description' => 'The endpoint of the MaxCompute or Object Storage Service (OSS) data source.'."\n",
- 'type' => 'string',
- 'required' => false,
- 'example' => 'http://service.cn-hangzhou.maxcompute.aliyun-inc.com/api',
- ],
- 'accessKey' => [
- 'description' => 'The AccessKey ID of the MaxCompute data source.'."\n",
- 'type' => 'string',
- 'required' => false,
- 'example' => 'L***p',
- ],
- 'accessSecret' => [
- 'description' => 'The AccessKey secret of the MaxCompute data source.'."\n",
- 'type' => 'string',
- 'required' => false,
- 'example' => '5**9a6',
- ],
- 'project' => [
- 'description' => 'The name of the MaxCompute project that is used as the data source.'."\n",
- 'type' => 'string',
- 'required' => false,
- 'example' => 'kubenest',
- ],
- 'partition' => [
- 'description' => 'The partition in the MaxCompute table.'."\n",
- 'type' => 'string',
- 'required' => false,
- 'example' => 'ds=20220713',
- ],
- 'table' => [
- 'title' => 'saro、odps相关',
- 'description' => 'The name of the MaxCompute table that is used as the data source.'."\n",
- 'type' => 'string',
- 'required' => false,
- 'example' => 'item',
- ],
- 'namespace' => [
- 'title' => 'saro相关',
- 'description' => 'The namespace.'."\n",
- 'type' => 'string',
- 'required' => false,
- 'example' => 'aegis-ops',
- ],
- 'path' => [
- 'title' => 'hdfs相关',
- 'description' => 'The file path in the Apsara File Storage for HDFS file system.'."\n",
- 'type' => 'string',
- 'required' => false,
- 'example' => 'test-hdfs-path'."\n",
- ],
- 'ossPath' => [
- 'title' => 'oss数据源相关',
- 'description' => 'The path of the OSS object.'."\n",
- 'type' => 'string',
- 'required' => false,
- 'example' => '/opensearch/search',
- ],
- 'bucket' => [
- 'description' => 'The name of the OSS bucket.'."\n",
- 'type' => 'string',
- 'required' => false,
- 'example' => 'opensearch',
- ],
- 'catalog' => [
- 'type' => 'string',
- ],
- 'database' => [
- 'type' => 'string',
- ],
- 'tag' => [
- 'type' => 'string',
- ],
- ],
- 'required' => false,
- ],
- 'saroConfig' => [
- 'title' => 'saro数据源配置',
- 'description' => 'The configurations of the SARO data source.'."\n",
- 'type' => 'object',
- 'properties' => [
- 'namespace' => [
- 'description' => 'The namespace of the SARO data source.'."\n",
- 'type' => 'string',
- 'required' => false,
- 'example' => 'igraph-cn-x0r3e3abe02',
- ],
- 'tableName' => [
- 'description' => 'The name of the SARO table.'."\n",
- 'type' => 'string',
- 'required' => false,
- 'example' => 'index_hdfs',
- ],
- ],
- 'required' => false,
- ],
- 'autoBuildIndex' => [
- 'title' => '是否开启自动全量',
- 'description' => 'Specifies whether to automatically rebuild the index.'."\n",
- 'type' => 'boolean',
- 'required' => false,
- 'example' => 'true',
- ],
- ],
- 'required' => false,
- 'example' => '{}',
- ],
- ],
- ],
- 'responses' => [
- 200 => [
- 'schema' => [
- 'type' => 'object',
- 'properties' => [
- 'requestId' => [
- 'title' => 'id of request',
- 'description' => 'The ID of the request.'."\n",
- 'type' => 'string',
- 'example' => '10D5E615-69F7-5F49-B850-00169ADE513C',
- ],
- 'result' => [
- 'title' => 'Map',
- 'description' => 'The returned results.'."\n",
- 'type' => 'object',
- 'example' => '{}',
- ],
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'searchengine:GetDataSourceDeploy',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SearchEngine', 'resourceType' => 'Instance', 'arn' => 'acs:searchengine:{#regionId}:{#accountId}:instance/{#instanceId}'],
],
- 'description' => 'The response parameters.'."\n",
- 'title' => 'Schema of Response',
],
],
- '5XX' => [],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"10D5E615-69F7-5F49-B850-00169ADE513C\\",\\n \\"result\\": {}\\n}","type":"json"}]',
- 'title' => 'CreateDataSource',
],
- 'DeleteDataSource' => [
- 'summary' => 'Deletes a specified data source.',
- 'path' => '/openapi/ha3/instances/{instanceId}/data-sources/{dataSourceName}',
- 'methods' => [
- 'delete',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
+ 'GetDatabaseSchema' => [
+ 'path' => '/openapi/ha3/instances/{instanceId}/sql-studio/databases/{database}/tables/{tableName}/schema',
+ 'methods' => ['get'],
+ 'schemes' => ['https', 'http'],
'security' => [
[
'AK' => [],
@@ -8955,324 +4926,96 @@
],
'operationType' => 'read',
'deprecated' => false,
- 'systemTags' => [],
+ 'systemTags' => ['operationType' => 'get'],
'parameters' => [
[
'name' => 'instanceId',
'in' => 'path',
- 'schema' => [
- 'title' => '实例ID',
- 'description' => 'The instance ID.'."\n",
- 'type' => 'string',
- 'required' => true,
- 'example' => 'ha-cn-0ju2rps6c08',
- ],
- ],
- [
- 'name' => 'dataSourceName',
- 'in' => 'path',
- 'schema' => [
- 'title' => '数据源名称',
- 'description' => 'The name of the data source.'."\n",
- 'type' => 'string',
- 'required' => true,
- 'example' => 'ha-cn-0ju2rps6c08_api_test',
- ],
- ],
- ],
- 'responses' => [
- 200 => [
- 'schema' => [
- 'title' => 'Schema of Response',
- 'description' => 'Schema of Response'."\n",
- 'type' => 'object',
- 'properties' => [
- 'requestId' => [
- 'title' => 'id of request',
- 'description' => 'The ID of the request'."\n",
- 'type' => 'string',
- 'example' => '10D5E615-69F7-5F49-B850-00169ADE513C',
- ],
- 'result' => [
- 'title' => '索引信息',
- 'description' => 'The result returned'."\n",
- 'type' => 'object',
- 'example' => '{}',
- ],
- ],
- ],
+ 'schema' => ['description' => 'The ID of the instance.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'ha-cn-pl32rf0****'],
],
- 500 => [],
- ],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"10D5E615-69F7-5F49-B850-00169ADE513C\\",\\n \\"result\\": {}\\n}","type":"json"}]',
- 'title' => 'DeleteDataSource',
- 'description' => '## Method'."\n"
- ."\n"
- .'`DELETE`'."\n"
- ."\n"
- .'## URI'."\n"
- ."\n"
- .'`/openapi/ha3/instances/{instanceId}/data-sources/{dataSourceName}`'."\n",
- 'requestParamsDescription' => '## Sample requests'."\n"
- ."\n"
- .'`DELETE /openapi/ha3/instances/ha3_instances_id/data-sources/my_dataSource`'."\n",
- 'responseParamsDescription' => '## [](#)Sample responses'."\n"
- ."\n"
- .'### [](#)Sample success responses'."\n"
- ."\n"
- .'```json'."\n"
- .'{'."\n"
- .' "requestId": "0A6EB64B-B4C8-CF02-810F-E660812972FF",'."\n"
- .' "result": []'."\n"
- .'}'."\n"
- .'```'."\n"
- ."\n"
- .'For more information, see [Response structure](~~465311~~).'."\n",
- ],
- 'GetDataSource' => [
- 'summary' => 'Obtains a data source.',
- 'path' => '/openapi/ha3/instances/{instanceId}/data-sources/{dataSourceName}',
- 'methods' => [
- 'get',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
- 'security' => [
[
- 'AK' => [],
- ],
- ],
- 'operationType' => 'read',
- 'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'get',
- ],
- 'parameters' => [
- [
- 'name' => 'instanceId',
+ 'name' => 'database',
'in' => 'path',
- 'schema' => [
- 'description' => 'The instance ID.'."\n",
- 'type' => 'string',
- 'required' => false,
- 'example' => 'ha-cn-2r42ostoc01',
- ],
+ 'schema' => ['description' => 'The name of the database.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'general'],
],
[
- 'name' => 'dataSourceName',
+ 'name' => 'tableName',
'in' => 'path',
- 'schema' => [
- 'description' => 'The name of the data source.'."\n",
- 'type' => 'string',
- 'required' => false,
- 'example' => 'ha-cn-2r42ostoc01_people_info',
- ],
+ 'schema' => ['description' => 'The name of the table.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'graph_index_summary_'],
],
],
'responses' => [
200 => [
'schema' => [
- 'description' => 'The response parameters.'."\n",
'type' => 'object',
'properties' => [
- 'requestId' => [
- 'title' => 'id of request',
- 'description' => 'Id of the request'."\n",
- 'type' => 'string',
- 'example' => 'FE03180A-0E29-5474-8A86-33F0683294A4',
- ],
+ 'requestId' => ['title' => '', 'description' => 'The ID of the request.', 'type' => 'string', 'example' => '022F36C7-9FB4-5D67-BEBC-3D14B0984463'],
'result' => [
- 'title' => 'DataSource',
- 'description' => 'The information about the data source.'."\n",
- 'type' => 'object',
- 'properties' => [
- 'name' => [
- 'title' => '数据源名',
- 'description' => 'The name of the data source.'."\n",
- 'type' => 'string',
- 'example' => 'my_index',
- ],
- 'type' => [
- 'title' => '数据源类型 (odps, swift, saro, oss, unKnow)',
- 'description' => 'The type of the data source'."\n",
- 'type' => 'string',
- 'example' => 'odps',
- ],
- 'domain' => [
- 'title' => '离线部署',
- 'description' => 'The data center where the data source is deployed in offline mode'."\n",
- 'type' => 'string',
- 'example' => 'vpc_hz_domain_1',
- ],
- 'indexes' => [
- 'title' => '数据源产出的index',
- 'description' => 'The list of index information'."\n",
- 'type' => 'array',
- 'items' => [
- 'description' => 'The index table'."\n",
- 'type' => 'string',
- 'example' => 'index1',
- ],
- ],
- 'lastFulTime' => [
- 'title' => '上一次全量时间',
- 'description' => 'The time when the full data of the data source was last queried.'."\n",
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '1718787219',
- ],
- 'status' => [
- 'title' => '表状态 (NEW, PUBLISH, TRASH)',
- 'description' => 'The status of the data source. Valid values: new: The data source is being created. publish: The data source is in the normal state. trash: The data source is being deleted.'."\n",
- 'type' => 'string',
- 'example' => 'NEW',
- ],
+ 'title' => '',
+ 'description' => 'The result.',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'The result.',
+ 'type' => 'object',
+ 'properties' => [
+ 'fieldName' => ['description' => 'The name of the field.', 'type' => 'string', 'title' => '', 'example' => 'id'],
+ 'fieldType' => ['description' => 'The type of the field.', 'type' => 'string', 'title' => '', 'example' => 'STRING'],
+ 'indexName' => ['description' => 'The name of the index.', 'type' => 'string', 'title' => '', 'example' => 'test_tusou_v2'],
+ 'indexType' => ['description' => 'The type of the index.', 'type' => 'string', 'title' => '', 'example' => 'NUMBER'],
+ 'fieldTypeDetail' => ['description' => 'The details of the field type.', 'type' => 'object', 'title' => '', 'example' => 'FT_UINT64'],
+ ],
+ 'title' => '',
+ 'example' => '',
],
+ 'example' => '',
],
],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
],
500 => [],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"FE03180A-0E29-5474-8A86-33F0683294A4\\",\\n \\"result\\": {\\n \\"name\\": \\"ha-cn-pl32rf0****_test_api\\",\\n \\"type\\": \\"odps\\",\\n \\"domain\\": \\"vpc_hz_domain_1\\",\\n \\"indexes\\": [\\n \\"index1\\"\\n ],\\n \\"lastFulTime\\": 1718787219,\\n \\"status\\": \\"new\\"\\n }\\n}","type":"json"}]',
- 'title' => 'GetDataSource',
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"022F36C7-9FB4-5D67-BEBC-3D14B0984463\\",\\n \\"result\\": [\\n {\\n \\"fieldName\\": \\"id\\",\\n \\"fieldType\\": \\"STRING\\",\\n \\"indexName\\": \\"test_tusou_v2\\",\\n \\"indexType\\": \\"NUMBER\\",\\n \\"fieldTypeDetail\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n }\\n }\\n ]\\n}","type":"json"}]',
+ 'title' => 'GetDatabaseSchema',
+ 'summary' => 'Retrieves the schema of a database.',
'description' => '### Method'."\n"
."\n"
- .'`GET`'."\n"
+ .'```java'."\n"
+ .'GET'."\n"
+ .'```'."\n"
."\n"
.'### URI'."\n"
."\n"
- .'`/openapi/ha3/instances/{instanceId}/data-sources/{dataSourceName}`'."\n",
- 'requestParamsDescription' => '### Sample requests'."\n"
- ."\n"
- .'`GET /openapi/ha3/instances/ha3_instances_id/data-sources/my_data_source`'."\n",
- ],
- 'ListDataSources' => [
- 'summary' => 'Obtains the list of data sources.',
- 'path' => '/openapi/ha3/instances/{instanceId}/data-sources',
- 'methods' => [
- 'get',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
- 'security' => [
- [
- 'AK' => [],
+ .'```java'."\n"
+ .'/openapi/ha3/instances/{instanceId}/sql-studio/databases/{database}/tables/{tableName}/schema'."\n"
+ .'```',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetDatabaseSchema'],
],
],
- 'operationType' => 'read',
- 'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'list',
- ],
- 'parameters' => [
+ 'ramActions' => [
[
- 'name' => 'instanceId',
- 'in' => 'path',
- 'schema' => [
- 'description' => 'The instance ID.'."\n",
- 'type' => 'string',
- 'required' => true,
- 'example' => 'ha-cn-2r42ostoc01',
- ],
- ],
- ],
- 'responses' => [
- 200 => [
- 'schema' => [
- 'description' => 'The response parameters.'."\n",
- 'type' => 'object',
- 'properties' => [
- 'requestId' => [
- 'title' => 'id of request',
- 'description' => 'The ID of the request.'."\n",
- 'type' => 'string',
- 'example' => '93A9E542-8CF8-5BA6-99AB-94C0FE520429',
- ],
- 'result' => [
- 'title' => 'List',
- 'description' => 'The results returned.'."\n",
- 'type' => 'array',
- 'items' => [
- 'description' => 'The list of data source information.'."\n",
- 'type' => 'object',
- 'properties' => [
- 'name' => [
- 'title' => '数据源名',
- 'description' => 'The name of the data source.'."\n",
- 'type' => 'string',
- 'example' => 'data_source_name',
- ],
- 'type' => [
- 'title' => '数据源类型 (odps, swift, saro, oss, unKnow)',
- 'description' => 'The type of the data source.'."\n",
- 'type' => 'string',
- 'example' => 'odps',
- ],
- 'domain' => [
- 'title' => '离线部署',
- 'description' => 'The data center in which the data source is deployed.'."\n",
- 'type' => 'string',
- 'example' => 'test',
- ],
- 'indexes' => [
- 'title' => '数据源产出的index',
- 'description' => 'The indexes.'."\n",
- 'type' => 'array',
- 'items' => [
- 'description' => 'The index of the data source.'."\n",
- 'type' => 'string',
- 'example' => 'index1',
- ],
- ],
- 'lastFulTime' => [
- 'title' => '上一次全量时间',
- 'description' => 'The time when the full data of the data source was last queried.'."\n",
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '1718787785',
- ],
- 'status' => [
- 'title' => '表状态 (NEW, PUBLISH, TRASH)',
- 'description' => 'The status of the data source. Valid values: new: The data source is being created. publish: The data source is in the normal state. trash: The data source is being deleted.'."\n",
- 'type' => 'string',
- 'example' => 'new',
- ],
- ],
- ],
- ],
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'searchengine:GetDatabaseSchema',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SearchEngine', 'resourceType' => 'Instance', 'arn' => 'acs:searchengine:{#regionId}:{#accountId}:instance/{#instanceId}'],
],
],
],
- 500 => [],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"93A9E542-8CF8-5BA6-99AB-94C0FE520429\\",\\n \\"result\\": [\\n {\\n \\"name\\": \\"ha-cn-pl32rf0****_test_api\\",\\n \\"type\\": \\"odps\\",\\n \\"domain\\": \\"vpc_hz_domain_1\\",\\n \\"indexes\\": [\\n \\"index1\\"\\n ],\\n \\"lastFulTime\\": 1718787785,\\n \\"status\\": \\"new\\"\\n }\\n ]\\n}","type":"json"}]',
- 'title' => 'ListDataSources',
- 'description' => '## Method'."\n"
- ."\n"
- .'`GET`'."\n"
- ."\n"
- .'## URI'."\n"
- ."\n"
- .'`/openapi/ha3/instances/{instanceId}/data-sources`'."\n",
- 'requestParamsDescription' => '## Sample requests'."\n"
- ."\n"
- .'`GET /openapi/ha3/instances/ha3_instances_id/data-sources`'."\n",
],
- 'ListDataSourceSchemas' => [
- 'summary' => 'Queries the schema information about a data source.',
- 'path' => '/openapi/ha3/instances/{instanceId}/data-sources/{dataSourceName}/schemas',
- 'methods' => [
- 'get',
- ],
- 'schemes' => [
- 'https',
- 'http',
- ],
+ 'GetDeployGraph' => [
+ 'summary' => 'Displays the overview of the deployment.',
+ 'path' => '/openapi/ha3/instances/{instanceId}/deploy-graph',
+ 'methods' => ['get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
@@ -9280,175 +5023,441 @@
],
'operationType' => 'read',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'list',
- ],
+ 'systemTags' => ['operationType' => 'get'],
'parameters' => [
[
'name' => 'instanceId',
'in' => 'path',
- 'schema' => [
- 'description' => 'The instance ID.'."\n",
- 'type' => 'string',
- 'required' => true,
- 'example' => 'ha-cn-zvp2s4l8f02',
- ],
- ],
- [
- 'name' => 'dataSourceName',
- 'in' => 'path',
- 'schema' => [
- 'description' => 'The name of the data source.'."\n",
- 'type' => 'string',
- 'required' => true,
- 'example' => 'ha-cn-2r42ostoc01_ecom_table_test',
- ],
+ 'schema' => ['description' => 'The instance ID.'."\n", 'type' => 'string', 'required' => false, 'example' => 'ha-cn-pl32rf0****', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
- 'description' => 'The results returned.'."\n",
'type' => 'object',
'properties' => [
- 'requestId' => [
- 'title' => 'id of request',
- 'description' => 'The ID of the request.'."\n",
- 'type' => 'string',
- 'example' => '022F36C7-9FB4-5D67-BEBC-3D14B0984463',
- ],
+ 'requestId' => ['title' => '', 'description' => 'Id of the request'."\n", 'type' => 'string', 'example' => 'E7B7D598-B080-5C8E-AA35-D43EC0D5F886'],
'result' => [
- 'title' => 'List',
+ 'title' => '',
'description' => 'The results returned.'."\n",
- 'type' => 'array',
- 'items' => [
- 'description' => 'The schema information.'."\n",
- 'type' => 'object',
- 'properties' => [
- 'name' => [
- 'title' => '字段名称',
- 'description' => 'The field name.'."\n",
- 'type' => 'string',
- 'example' => 'test',
- ],
- 'custom' => [
- 'title' => '是否自定义字段',
- 'description' => 'Indicates whether the field is a custom field. Valid values: **true** and **false**.'."\n",
- 'type' => 'boolean',
- 'example' => 'false',
- ],
- 'type' => [
- 'title' => '字段类型',
- 'description' => 'The field type.'."\n",
- 'type' => 'string',
- 'example' => 'STRING',
- ],
- 'attribute' => [
- 'description' => 'Indicates whether the field is an attribute field. Valid values: **true** and **false**.'."\n",
- 'type' => 'boolean',
- 'example' => 'false',
- ],
- 'summary' => [
- 'title' => '可展示',
- 'description' => 'Indicates whether the field can be displayed. Valid values: **true** and **false**.'."\n",
- 'type' => 'boolean',
- 'example' => 'false',
- ],
- 'primaryKey' => [
- 'title' => '主键',
- 'description' => 'The primary key field.'."\n",
- 'type' => 'object',
- 'properties' => [
- 'isPrimaryKey' => [
- 'description' => 'Indicates whether the field is the primary key. Valid values: **true** and **false**.'."\n",
- 'type' => 'boolean',
- 'example' => 'false',
+ 'type' => 'object',
+ 'properties' => [
+ 'graph' => [
+ 'description' => 'The deployment information.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'onlineMaster' => [
+ 'title' => '',
+ 'description' => 'The metadata of online clusters.'."\n",
+ 'type' => 'array',
+ 'items' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'id' => ['description' => 'The ID of the data center.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => ''],
+ 'name' => ['description' => 'The name of the online cluster.'."\n", 'type' => 'string', 'example' => ' '."\n"
+ .'ha-cn-pl32rf0****_hz_pre_vpc_domain_1', 'title' => ''],
+ 'domainName' => ['description' => 'The name of the data center.'."\n", 'type' => 'string', 'example' => 'hz_pre_vpc_domain_1', 'title' => ''],
+ 'hippoId' => ['description' => 'The resource ID.'."\n", 'type' => 'string', 'example' => '5377', 'title' => ''],
+ ],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'example' => '',
+ ],
+ 'zoneMetas' => [
+ 'title' => '',
+ 'description' => 'The zone metadata.'."\n",
+ 'type' => 'array',
+ 'items' => [
+ 'description' => '',
+ 'type' => 'object',
+ 'properties' => [
+ 'name' => ['description' => 'The name of the Query Result Searcher (QRS) worker.'."\n", 'type' => 'string', 'example' => 'ha-cn-pl32rf0****_qrs', 'title' => ''],
+ 'tag' => ['description' => 'The tag.'."\n", 'type' => 'string', 'example' => ' '."\n"
+ .'ha-cn-pl32rf0****_qrs_hz_pre_vpc_domain_1', 'title' => ''],
+ 'suezAdminName' => ['description' => 'The name of the service that is used to manage the relationships between online clusters and indexes.'."\n", 'type' => 'string', 'example' => ' '."\n"
+ .'ha-cn-pl32rf0****_hz_pre_vpc_domain_1', 'title' => ''],
+ 'type' => ['description' => 'The node type.'."\n", 'type' => 'string', 'example' => 'qrs', 'title' => ''],
+ 'domainInfo' => ['description' => 'The name of the data center.'."\n", 'type' => 'string', 'example' => 'hz_pre_vpc_domain_1', 'title' => ''],
+ ],
+ 'title' => '',
+ 'example' => '',
],
- 'hasPrimaryKeyAttribute' => [
- 'description' => 'Indicates whether the field has the primary key attribute. Valid values: **true** and **false**.'."\n",
- 'type' => 'boolean',
- 'example' => 'false',
+ 'example' => '',
+ ],
+ 'tableMetas' => [
+ 'title' => '',
+ 'description' => 'The metadata of data sources.'."\n",
+ 'type' => 'array',
+ 'items' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'tableDeployId' => ['description' => 'The deployment ID of the table.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '2177', 'title' => ''],
+ 'name' => ['description' => 'The name of the data source.'."\n", 'type' => 'string', 'example' => 'ha-cn-pl32rf0****_test_api', 'title' => ''],
+ 'tag' => ['description' => 'The tag.'."\n", 'type' => 'string', 'example' => 'ha-cn-pl32rf0****_test_api_hz_pre_vpc_domain_1', 'title' => ''],
+ 'domainName' => ['description' => 'The name of the data center.'."\n", 'type' => 'string', 'example' => 'hz_pre_vpc_domain_1', 'title' => ''],
+ 'buildDeployId' => ['description' => 'The ID of the offline deployment.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => ''],
+ 'type' => ['description' => 'The type of the data source.'."\n", 'type' => 'string', 'example' => 'odps', 'title' => ''],
+ ],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
- 'isPrimaryKeySorted' => [
- 'description' => 'Indicates whether the field can be sorted. Valid values: **true** and **false**.'."\n",
- 'type' => 'boolean',
- 'example' => 'false',
+ 'example' => '',
+ ],
+ 'indexMetas' => [
+ 'title' => '',
+ 'description' => 'The index metadata.'."\n",
+ 'type' => 'array',
+ 'items' => [
+ 'description' => '',
+ 'type' => 'object',
+ 'properties' => [
+ 'name' => ['description' => 'The index name.'."\n", 'type' => 'string', 'example' => 'test_api', 'title' => ''],
+ 'tag' => ['description' => 'The tag.'."\n", 'type' => 'string', 'example' => 'test_api_hz_pre_vpc_domain_1', 'title' => ''],
+ 'domainName' => ['description' => 'The name of the data center.'."\n", 'type' => 'string', 'example' => 'hz_pre_vpc_domain_1', 'title' => ''],
+ 'tableDeployId' => ['description' => 'The deployment ID of the table.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '2409', 'title' => ''],
+ 'tableName' => ['description' => 'The name of the data source.'."\n", 'type' => 'string', 'example' => 'ha-cn-pl32rf0****_test_api', 'title' => ''],
+ 'zoneName' => ['description' => 'The name of the QRS worker.'."\n", 'type' => 'string', 'example' => 'ha-cn-pl32rf0****_qrs', 'title' => ''],
+ ],
+ 'title' => '',
+ 'example' => '',
],
+ 'example' => '',
+ ],
+ 'zoneIndexRelation' => [
+ 'title' => '',
+ 'description' => 'The association relationships between zones and indexes.'."\n",
+ 'type' => 'object',
+ 'additionalProperties' => [
+ 'type' => 'array',
+ 'items' => ['type' => 'string', 'example' => 'general_hz_pre_vpc_domain_1', 'description' => 'The cluster associated with the indexes.'."\n", 'title' => ''],
+ 'description' => 'The association relationships between zones and indexes.'."\n",
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'example' => '',
+ ],
+ 'tableIndexRelation' => [
+ 'title' => '',
+ 'description' => 'The association relationships between data sources and indexes.'."\n",
+ 'type' => 'object',
+ 'additionalProperties' => [
+ 'type' => 'array',
+ 'items' => ['type' => 'string', 'example' => 'test_api_hz_pre_vpc_domain_1', 'description' => 'The table associated with the indexes.'."\n", 'title' => ''],
+ 'description' => 'The association relationships between data sources and indexes.'."\n",
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'example' => '',
],
],
- 'addIndex' => [
- 'title' => '是否添加了index属性',
- 'description' => 'Indicates whether the field has the index attribute. Valid values: **true** and **false**.'."\n",
- 'type' => 'boolean',
- 'example' => 'false',
- ],
+ 'title' => '',
+ 'example' => '',
],
],
+ 'example' => '{}',
],
],
+ 'description' => 'The response parameters.'."\n",
+ 'title' => '',
+ 'example' => '',
],
],
500 => [],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"022F36C7-9FB4-5D67-BEBC-3D14B0984463\\",\\n \\"result\\": [\\n {\\n \\"name\\": \\"id\\",\\n \\"custom\\": false,\\n \\"type\\": \\"STRING\\",\\n \\"attribute\\": false,\\n \\"summary\\": false,\\n \\"primaryKey\\": {\\n \\"isPrimaryKey\\": false,\\n \\"hasPrimaryKeyAttribute\\": false,\\n \\"isPrimaryKeySorted\\": false\\n },\\n \\"addIndex\\": false\\n }\\n ]\\n}","type":"json"}]',
- 'title' => 'ListDataSourceSchemas',
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"E7B7D598-B080-5C8E-AA35-D43EC0D5F886\\",\\n \\"result\\": {\\n \\"graph\\": {\\n \\"onlineMaster\\": [\\n {\\n \\"id\\": 1,\\n \\"name\\": \\"\\\\t\\\\nha-cn-pl32rf0****_hz_pre_vpc_domain_1\\",\\n \\"domainName\\": \\"hz_pre_vpc_domain_1\\",\\n \\"hippoId\\": \\"5377\\"\\n }\\n ],\\n \\"zoneMetas\\": [\\n {\\n \\"name\\": \\"ha-cn-pl32rf0****_qrs\\",\\n \\"tag\\": \\"\\\\t\\\\nha-cn-pl32rf0****_qrs_hz_pre_vpc_domain_1\\",\\n \\"suezAdminName\\": \\"\\\\t\\\\nha-cn-pl32rf0****_hz_pre_vpc_domain_1\\",\\n \\"type\\": \\"qrs\\",\\n \\"domainInfo\\": \\"hz_pre_vpc_domain_1\\"\\n }\\n ],\\n \\"tableMetas\\": [\\n {\\n \\"tableDeployId\\": 2177,\\n \\"name\\": \\"ha-cn-pl32rf0****_test_api\\",\\n \\"tag\\": \\"ha-cn-pl32rf0****_test_api_hz_pre_vpc_domain_1\\",\\n \\"domainName\\": \\"hz_pre_vpc_domain_1\\",\\n \\"buildDeployId\\": 1,\\n \\"type\\": \\"odps\\"\\n }\\n ],\\n \\"indexMetas\\": [\\n {\\n \\"name\\": \\"test_api\\",\\n \\"tag\\": \\"test_api_hz_pre_vpc_domain_1\\",\\n \\"domainName\\": \\"hz_pre_vpc_domain_1\\",\\n \\"tableDeployId\\": 2409,\\n \\"tableName\\": \\"ha-cn-pl32rf0****_test_api\\",\\n \\"zoneName\\": \\"ha-cn-pl32rf0****_qrs\\"\\n }\\n ],\\n \\"zoneIndexRelation\\": {\\n \\"key\\": [\\n \\"general_hz_pre_vpc_domain_1\\"\\n ]\\n },\\n \\"tableIndexRelation\\": {\\n \\"key\\": [\\n \\"test_api_hz_pre_vpc_domain_1\\"\\n ]\\n }\\n }\\n }\\n}","type":"json"}]',
+ 'title' => 'GetDeployGraph',
'description' => '## Method'."\n"
."\n"
- .'`GET`'."\n"
+ .'GET'."\n"
."\n"
.'## URI'."\n"
."\n"
- .'`/openapi/ha3/instances/{instanceId}/data-sources/{dataSourceName}/schemas`'."\n",
- 'requestParamsDescription' => '## Sample requests'."\n"
+ .'```java'."\n"
+ .'/openapi/ha3/instances/{instanceId}/deploy-graph'."\n"
+ .'```'."\n",
+ 'requestParamsDescription' => '### Sample requests'."\n"
."\n"
- .'`GET /openapi/ha3/instances/ha3_instances_id/data-sources/my_data_source/schemas`'."\n",
- 'responseParamsDescription' => '## Sample responses'."\n"
+ .'```java'."\n"
."\n"
- .'### Success responses'."\n"
+ .'GET /openapi/ha3/instances/{instanceId}/deploy-graph'."\n"
+ .'```'."\n",
+ 'responseParamsDescription' => '### Sample responses'."\n"
."\n"
- .'```json'."\n"
+ .'Success responses '."\n"
+ ."\n"
+ .'```java'."\n"
.'{'."\n"
+ .''."\n"
.' "requestId": "0A6EB64B-B4C8-CF02-810F-E660812972FF",'."\n"
- .' "result":['."\n"
- .' {'."\n"
- .' "summary": false,'."\n"
- .' "custom": false,'."\n"
- .' "addIndex": false,'."\n"
- .' "type": "INT64",'."\n"
- .' "name": "id",'."\n"
- .' "attribute": false,'."\n"
- .' "primaryKey": {'."\n"
- .' "hasPrimaryKeyAttribute": false,'."\n"
- .' "primaryKeySorted": false,'."\n"
- .' "primaryKey": false'."\n"
- .' }'."\n"
+ .''."\n"
+ .' "result": {'."\n"
+ .''."\n"
+ .' "app": {'."\n"
+ .''."\n"
+ .' "creator": "74087",'."\n"
+ .''."\n"
+ .' "gmtModified": 1628151698000,'."\n"
+ .''."\n"
+ .' "groupId": 596,'."\n"
+ .''."\n"
+ .' "platformType": "tisplus",'."\n"
+ .''."\n"
+ .' "description": "qrs",'."\n"
+ .''."\n"
+ .' "gmtCreate": 1628151698000,'."\n"
+ .''."\n"
+ .' "isActive": 0,'."\n"
+ .''."\n"
+ .' "type": "online_group",'."\n"
+ .''."\n"
+ .' "appStatus": 0,'."\n"
+ .''."\n"
+ .' "procStatus": 0,'."\n"
+ .''."\n"
+ .' "isDeleted": 0,'."\n"
+ .''."\n"
+ .' "name": "search4TestPlugin",'."\n"
+ .''."\n"
+ .' "id": 5171'."\n"
+ .''."\n"
.' },'."\n"
- .' {'."\n"
- .' "summary": false,'."\n"
- .' "custom": false,'."\n"
- .' "addIndex": false,'."\n"
- .' "type": "STRING",'."\n"
- .' "name": "fb_boolean",'."\n"
- .' "attribute": false,'."\n"
- .' "primaryKey": {'."\n"
- .' "hasPrimaryKeyAttribute": false,'."\n"
- .' "primaryKeySorted": false,'."\n"
- .' "primaryKey": false'."\n"
+ .''."\n"
+ .' "hippos": [],'."\n"
+ .''."\n"
+ .' "appGroupName": "biz",'."\n"
+ .''."\n"
+ .' "name": "search4TestPlugin",'."\n"
+ .''."\n"
+ .' "availableDeploys": ['."\n"
+ .''."\n"
+ .' {'."\n"
+ .''."\n"
+ .' "gmtModified": 1594193012000,'."\n"
+ .''."\n"
+ .' "virtualDomainList": "6,7,8",'."\n"
+ .''."\n"
+ .' "platformType": "[\\"tisplus\\",\\"tisplus_khronos\\",\\"tisplus_dingtalk\\"]",'."\n"
+ .''."\n"
+ .' "description": "pre_et2",'."\n"
+ .''."\n"
+ .' "groups": "",'."\n"
+ .''."\n"
+ .' "gmtCreate": 1565752477000,'."\n"
+ .''."\n"
+ .' "type": "INNET",'."\n"
+ .''."\n"
+ .' "modules": "[\\"online\\"]",'."\n"
+ .''."\n"
+ .' "foundationDetailList": "15,16,17,18,19,20,21,22,23,24,25,26,27,28,29,94",'."\n"
+ .''."\n"
+ .' "name": "pre_et2",'."\n"
+ .''."\n"
+ .' "hippoId": "hippo_et2_7u",'."\n"
+ .''."\n"
+ .' "id": 5'."\n"
+ .''."\n"
+ .' },'."\n"
+ .''."\n"
+ .' {'."\n"
+ .''."\n"
+ .' "gmtModified": 1571642223000,'."\n"
+ .''."\n"
+ .' "platformType": "[\\"tisplus\\"]",'."\n"
+ .''."\n"
+ .' "description": "oc27",'."\n"
+ .''."\n"
+ .' "groups": "",'."\n"
+ .''."\n"
+ .' "gmtCreate": 1571642223000,'."\n"
+ .''."\n"
+ .' "type": "INNET",'."\n"
+ .''."\n"
+ .' "modules": "[\\"online\\"]",'."\n"
+ .''."\n"
+ .' "foundationDetailList": "67,68,69,70,71,72,73,74,75,76,77,78,79",'."\n"
+ .''."\n"
+ .' "name": "oc27_pre",'."\n"
+ .''."\n"
+ .' "hippoId": "hippo_7u_oc27",'."\n"
+ .''."\n"
+ .' "id": 15'."\n"
+ .''."\n"
.' }'."\n"
- .' }'."\n"
- .' ]'."\n"
- .'}'."\n"
- .'```'."\n",
- ],
- 'ListDateSourceGenerations' => [
- 'path' => '/openapi/ha3/instances/{instanceId}/data-sources/{dataSourceName}/generations',
- 'methods' => [
- 'get',
+ .''."\n"
+ .' ],'."\n"
+ .''."\n"
+ .' "graph": {'."\n"
+ .''."\n"
+ .' "zoneMetas": ['."\n"
+ .''."\n"
+ .' {'."\n"
+ .''."\n"
+ .' "suezAdminName": "search4TestPlugin_pre",'."\n"
+ .''."\n"
+ .' "zoneMetaId": 8509,'."\n"
+ .''."\n"
+ .' "domainInfo": "pre",'."\n"
+ .''."\n"
+ .' "mainZone": true,'."\n"
+ .''."\n"
+ .' "name": "search4TestPlugin_qrs",'."\n"
+ .''."\n"
+ .' "zoneId": 11379,'."\n"
+ .''."\n"
+ .' "tag": "search4TestPlugin_qrs_pre",'."\n"
+ .''."\n"
+ .' "clusterId": 5265,'."\n"
+ .''."\n"
+ .' "type": "qrs"'."\n"
+ .''."\n"
+ .' },'."\n"
+ .''."\n"
+ .' {'."\n"
+ .''."\n"
+ .' "suezAdminName": "search4TestPlugin_pre",'."\n"
+ .''."\n"
+ .' "zoneMetaId": 8510,'."\n"
+ .''."\n"
+ .' "domainInfo": "pre",'."\n"
+ .''."\n"
+ .' "mainZone": true,'."\n"
+ .''."\n"
+ .' "name": "test_searcher",'."\n"
+ .''."\n"
+ .' "zoneId": 11380,'."\n"
+ .''."\n"
+ .' "tag": "test_searcher_pre",'."\n"
+ .''."\n"
+ .' "clusterId": 5265,'."\n"
+ .''."\n"
+ .' "type": "searcher"'."\n"
+ .''."\n"
+ .' }'."\n"
+ .''."\n"
+ .' ],'."\n"
+ .''."\n"
+ .' "tableIndexRelation": {'."\n"
+ .''."\n"
+ .' "product_sku_pre_ea120": ['."\n"
+ .''."\n"
+ .' "product_sku_pre_ea120"'."\n"
+ .''."\n"
+ .' ]'."\n"
+ .''."\n"
+ .' },'."\n"
+ .''."\n"
+ .' "onlineMaster": ['."\n"
+ .''."\n"
+ .' {'."\n"
+ .''."\n"
+ .' "appId": 5171,'."\n"
+ .''."\n"
+ .' "domainId": 1,'."\n"
+ .''."\n"
+ .' "domainName": "pre",'."\n"
+ .''."\n"
+ .' "gmtCreate": 1628561292000,'."\n"
+ .''."\n"
+ .' "gmtModified": 1628562498000,'."\n"
+ .''."\n"
+ .' "hippoGroupId": "20",'."\n"
+ .''."\n"
+ .' "id": 5265,'."\n"
+ .''."\n"
+ .' "monitorStatus": 1,'."\n"
+ .''."\n"
+ .' "name": "search4TestPlugin_pre",'."\n"
+ .''."\n"
+ .' "processorInfoId": 27789,'."\n"
+ .''."\n"
+ .' "zkAddr": ""'."\n"
+ .''."\n"
+ .' }'."\n"
+ .''."\n"
+ .' ],'."\n"
+ .''."\n"
+ .' "indexMetas": ['."\n"
+ .''."\n"
+ .' {'."\n"
+ .''."\n"
+ .' "tableDeployId": 7366,'."\n"
+ .''."\n"
+ .' "zoneMetaId": 8510,'."\n"
+ .''."\n"
+ .' "domainName": "pre_ea120",'."\n"
+ .''."\n"
+ .' "name": "product_sku",'."\n"
+ .''."\n"
+ .' "tableId": 6866,'."\n"
+ .''."\n"
+ .' "tag": "product_sku_pre_ea120",'."\n"
+ .''."\n"
+ .' "zoneName": "test_searcher",'."\n"
+ .''."\n"
+ .' "tableName": "product_sku"'."\n"
+ .''."\n"
+ .' }'."\n"
+ .''."\n"
+ .' ],'."\n"
+ .''."\n"
+ .' "offlineMaster": ['."\n"
+ .''."\n"
+ .' {'."\n"
+ .''."\n"
+ .' "appId": 5214,'."\n"
+ .''."\n"
+ .' "domainId": 18,'."\n"
+ .''."\n"
+ .' "domainName": "pre_ea120",'."\n"
+ .''."\n"
+ .' "gmtCreate": 1628501863000,'."\n"
+ .''."\n"
+ .' "gmtModified": 1628501863000,'."\n"
+ .''."\n"
+ .' "id": 3751,'."\n"
+ .''."\n"
+ .' "isPublic": 2,'."\n"
+ .''."\n"
+ .' "monitorStatus": 1,'."\n"
+ .''."\n"
+ .' "name": "search4_multi_biz_bs",'."\n"
+ .''."\n"
+ .' "platformType": "tisplus",'."\n"
+ .''."\n"
+ .' "processorInfoId": 27755,'."\n"
+ .''."\n"
+ .' "zkAddr": ""'."\n"
+ .''."\n"
+ .' }'."\n"
+ .'```',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetDeployGraph'],
+ ],
],
- 'schemes' => [
- 'https',
- 'http',
+ 'ramActions' => [
+ [
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'searchengine:GetDeployGraph',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SearchEngine', 'resourceType' => 'Instance', 'arn' => 'acs:searchengine:{#regionId}:{#accountId}:instance/{#InstanceId}'],
+ ],
+ ],
+ ],
],
+ ],
+ 'GetFile' => [
+ 'summary' => 'Retrieves the details of an index version.',
+ 'path' => '/openapi/ha3/instances/{instanceId}/indexes/{indexName}/versions/{versionName}/file',
+ 'methods' => ['get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
@@ -9457,157 +5466,133 @@
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
- 'operationType' => 'list',
+ 'operationType' => 'get',
+ 'abilityTreeCode' => '104689',
+ 'abilityTreeNodes' => ['FEATUREopensearch8WJIRU'],
],
'parameters' => [
[
'name' => 'instanceId',
'in' => 'path',
- 'schema' => [
- 'description' => 'The instance ID.'."\n",
- 'type' => 'string',
- 'required' => true,
- 'example' => 'ha-cn-7mz2ttxta01',
- ],
+ 'schema' => ['description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'ha-cn-pl32rf0****'],
],
[
- 'name' => 'dataSourceName',
+ 'name' => 'indexName',
'in' => 'path',
- 'schema' => [
- 'description' => 'The name of the data source.'."\n",
- 'type' => 'string',
- 'required' => true,
- 'example' => 'ha-cn-0ju2s170b03_test_api2',
- ],
+ 'schema' => ['description' => 'The index name.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'test_api'],
],
[
- 'name' => 'validStatus',
- 'in' => 'query',
- 'schema' => [
- 'description' => 'Specifies the index versions to be returned. Valid values:'."\n"
- ."\n"
- .'1. true (default): returns the index versions that are complete and not expired.'."\n"
- .'2. false: returns all index versions.'."\n",
- 'type' => 'boolean',
- 'required' => false,
- 'example' => 'true',
- 'default' => 'true',
- ],
+ 'name' => 'versionName',
+ 'in' => 'path',
+ 'schema' => ['description' => 'The version name.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'ha-cn-pl32rf0****@ha-cn-pl32rf0****_test_api@bj_vpc_domain_1@point_cloud_3d@index_config_edit'],
],
[
- 'name' => 'domainName',
+ 'name' => 'fileName',
'in' => 'query',
- 'schema' => [
- 'description' => 'The data center where the data source is deployed.'."\n",
- 'type' => 'string',
- 'required' => true,
- 'example' => 'bj_vpc_domain_1',
- ],
+ 'schema' => ['description' => 'The full path of the file.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => '/schemas/automobile_vector_schema.json'],
],
],
'responses' => [
200 => [
'schema' => [
+ 'title' => '',
+ 'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
- 'requestId' => [
- 'title' => 'id of request',
- 'description' => 'id of request'."\n",
- 'type' => 'string',
- 'example' => '022F36C7-9FB4-5D67-BEBC-3D14B0984463',
- ],
+ 'requestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '2AE63638-5420-56DC-BF59-37D8174039A0'],
'result' => [
- 'title' => 'List',
- 'description' => 'List'."\n",
- 'type' => 'array',
- 'items' => [
- 'description' => 'The result returned.'."\n",
- 'type' => 'object',
- 'properties' => [
- 'generation' => [
- 'title' => 'generation 主键',
- 'description' => 'The ID of the full index version.'."\n",
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '1626143930',
- ],
- 'createTime' => [
- 'title' => '全量时间',
- 'description' => 'The timestamp that was generated when the index building was started.'."\n",
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '1626143673',
- ],
- 'status' => [
- 'title' => '数据状态',
- 'description' => 'The status of the index version.'."\n",
- 'type' => 'string',
- 'example' => 'STOPPED',
- ],
- 'buildDeployId' => [
- 'title' => 'buildDeployId',
- 'description' => 'The ID of the offline deployment.'."\n",
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '122',
- ],
- 'partition' => [
- 'title' => '数据描述',
- 'description' => 'The shards of the index version. The value is a key-value pair in which the key indicates the index name and the value indicates the number of shards. The number of value shards.'."\n",
- 'type' => 'object',
- 'additionalProperties' => [
- 'type' => 'integer',
- 'format' => 'int32',
- 'description' => 'The number of shards.'."\n",
- 'example' => '1',
- ],
- ],
- 'timestamp' => [
- 'title' => '时间戳',
- 'description' => 'The start timestamp from which incremental data is retrieved.'."\n",
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '1626143673',
- ],
- 'dataDumpRoot' => [
- 'title' => 'dump表索引文件存储地址',
- 'description' => 'The path of the dumped index in the Apsara File Storage for HDFS file system.'."\n",
- 'type' => 'string',
- 'example' => '""',
+ 'title' => '',
+ 'description' => 'The index information.',
+ 'type' => 'object',
+ 'properties' => [
+ 'name' => ['description' => 'The file name.', 'type' => 'string', 'title' => '', 'example' => 'testFile'],
+ 'fullPathName' => ['description' => 'The full path of the file.', 'type' => 'string', 'title' => '', 'example' => '/schema.json'],
+ 'dataSource' => ['description' => 'The data source.', 'type' => 'string', 'title' => '', 'example' => 'ha-cn-pl32rf0****_test_api'],
+ 'partition' => ['description' => 'The number of shards.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '2'],
+ 'isDir' => ['description' => 'Indicates whether the path points to a directory.', 'type' => 'boolean', 'title' => '', 'example' => 'true'],
+ 'content' => ['description' => 'The content of the file.', 'type' => 'string', 'title' => '', 'example' => '{"summarys":{"parameter":{"file_compressor":"zstd"},"summary_fields":["id"]},"file_compress":[{"name":"file_compressor","type":"zstd"},{"name":"no_compressor","type":""}],"indexs":[{"index_fields":"name","index_name":"ids","index_type":"STRING"},{"has_primary_key_attribute":true,"index_fields":"id","is_primary_key_sorted":false,"index_name":"id","index_type":"PRIMARYKEY64"}],"attributes":[{"file_compress":"no_compressor","field_name":"id"}],"fields":[{"user_defined_param":{},"compress_type":"uniq","field_type":"STRING","field_name":"id"},{"compress_type":"uniq","field_type":"STRING","field_name":"name"}],"table_name":"api"}'],
+ 'extend' => [
+ 'type' => 'object',
+ 'additionalProperties' => [
+ 'type' => 'array',
+ 'items' => ['description' => 'The extended information.', 'type' => 'string', 'title' => '', 'example' => ''],
+ 'description' => 'The extended information.',
+ 'title' => '',
+ 'example' => '',
],
+ 'description' => 'The extended information.',
+ 'title' => '',
+ 'example' => '',
],
],
+ 'example' => '',
],
],
- 'description' => '',
+ 'example' => '',
],
],
500 => [],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"022F36C7-9FB4-5D67-BEBC-3D14B0984463\\",\\n \\"result\\": [\\n {\\n \\"generation\\": 1626143930,\\n \\"createTime\\": 1626143673,\\n \\"status\\": \\"STOPPED\\",\\n \\"buildDeployId\\": 122,\\n \\"partition\\": {\\n \\"key\\": 1\\n },\\n \\"timestamp\\": 1626143673,\\n \\"dataDumpRoot\\": \\"hdfs://opensearch/dump.json\\"\\n }\\n ]\\n}","type":"json"}]',
- 'title' => 'ListDateSourceGenerations',
- 'summary' => 'Queries the historical index versions of a data source.',
- 'description' => '### Method'."\n"
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"2AE63638-5420-56DC-BF59-37D8174039A0\\",\\n \\"result\\": {\\n \\"name\\": \\"testFile\\",\\n \\"fullPathName\\": \\"/schema.json\\",\\n \\"dataSource\\": \\"ha-cn-pl32rf0****_test_api\\",\\n \\"partition\\": 2,\\n \\"isDir\\": true,\\n \\"content\\": \\"{\\\\\\"summarys\\\\\\":{\\\\\\"parameter\\\\\\":{\\\\\\"file_compressor\\\\\\":\\\\\\"zstd\\\\\\"},\\\\\\"summary_fields\\\\\\":[\\\\\\"id\\\\\\"]},\\\\\\"file_compress\\\\\\":[{\\\\\\"name\\\\\\":\\\\\\"file_compressor\\\\\\",\\\\\\"type\\\\\\":\\\\\\"zstd\\\\\\"},{\\\\\\"name\\\\\\":\\\\\\"no_compressor\\\\\\",\\\\\\"type\\\\\\":\\\\\\"\\\\\\"}],\\\\\\"indexs\\\\\\":[{\\\\\\"index_fields\\\\\\":\\\\\\"name\\\\\\",\\\\\\"index_name\\\\\\":\\\\\\"ids\\\\\\",\\\\\\"index_type\\\\\\":\\\\\\"STRING\\\\\\"},{\\\\\\"has_primary_key_attribute\\\\\\":true,\\\\\\"index_fields\\\\\\":\\\\\\"id\\\\\\",\\\\\\"is_primary_key_sorted\\\\\\":false,\\\\\\"index_name\\\\\\":\\\\\\"id\\\\\\",\\\\\\"index_type\\\\\\":\\\\\\"PRIMARYKEY64\\\\\\"}],\\\\\\"attributes\\\\\\":[{\\\\\\"file_compress\\\\\\":\\\\\\"no_compressor\\\\\\",\\\\\\"field_name\\\\\\":\\\\\\"id\\\\\\"}],\\\\\\"fields\\\\\\":[{\\\\\\"user_defined_param\\\\\\":{},\\\\\\"compress_type\\\\\\":\\\\\\"uniq\\\\\\",\\\\\\"field_type\\\\\\":\\\\\\"STRING\\\\\\",\\\\\\"field_name\\\\\\":\\\\\\"id\\\\\\"},{\\\\\\"compress_type\\\\\\":\\\\\\"uniq\\\\\\",\\\\\\"field_type\\\\\\":\\\\\\"STRING\\\\\\",\\\\\\"field_name\\\\\\":\\\\\\"name\\\\\\"}],\\\\\\"table_name\\\\\\":\\\\\\"api\\\\\\"}\\",\\n \\"extend\\": {\\n \\"key\\": [\\n \\"\\"\\n ]\\n }\\n }\\n}","type":"json"}]',
+ 'title' => 'GetFile',
+ 'description' => '## Method'."\n"
."\n"
- .'`GET`'."\n"
+ .'```'."\n"
+ .'GET'."\n"
+ .'```'."\n"
."\n"
- .'### URI'."\n"
+ .'## URI'."\n"
."\n"
- .'`/openapi/ha3/instances/{instanceId}/data-sources/{dataSourceName}/generations?domainName={domainName}`'."\n",
- 'requestParamsDescription' => '### Sample requests'."\n"
+ .'```'."\n"
+ .'/openapi/ha3/instances/{instanceId}/indexes/{indexName}/versions/{versionName}/file'."\n"
+ .'```',
+ 'requestParamsDescription' => '## Request example'."\n"
."\n"
- .'`GET /openapi/ha3/instances/ha3_instances_id/data-sources/my_data_source/generations??domainName=pre_domain_1`'."\n",
- ],
- 'GetDataSourceDeploy' => [
- 'summary' => '获取数据源部署信息',
- 'path' => '/openapi/ha3/instances/{instanceId}/data-sources/{dataSourceName}/deploys/{deployName}',
- 'methods' => [
- 'get',
+ .'```'."\n"
+ .'GET /openapi/ha3/instances/ose-test1/indexes/index1/versions/version1?fileName=/root/test.txt'."\n"
+ .'```',
+ 'responseParamsDescription' => '## Response example'."\n"
+ ."\n"
+ .'Successful response'."\n"
+ ."\n"
+ .'```'."\n"
+ .'{'."\n"
+ .' "requestId": "e1eef569-1ff7-4bf8-acf7-1cecca9894ce",'."\n"
+ .' "result": {'."\n"
+ .' "name":"version1", // The file name'."\n"
+ .' "fullPathName": "/root/version1", // The full path of the file'."\n"
+ .' "dataSource": "odps1", // The data source'."\n"
+ .' "partition": 1, // The shard'."\n"
+ .' "isDir": false, // Indicates whether the path points to a directory'."\n"
+ .' "content": ""'."\n"
+ .' }'."\n"
+ .'}'."\n"
+ .'```',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetFile'],
+ ],
],
- 'schemes' => [
- 'http',
- 'https',
+ 'ramActions' => [
+ [
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'searchengine:GetFile',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SearchEngine', 'resourceType' => 'Instance', 'arn' => 'acs:searchengine:{#regionId}:{#accountId}:instance/{#InstanceId}'],
+ ],
+ ],
+ ],
],
+ ],
+ 'GetIndex' => [
+ 'summary' => 'Retrieves the details of an index table version.',
+ 'path' => '/openapi/ha3/instances/{instanceId}/indexes/{indexName}',
+ 'methods' => ['get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
@@ -9617,42 +5602,19 @@
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
- 'abilityTreeCode' => '159951',
- 'abilityTreeNodes' => [
- 'FEATUREopensearchA944AC',
- 'FEATUREopensearchS8X6T8',
- ],
+ 'abilityTreeCode' => '104685',
+ 'abilityTreeNodes' => ['FEATUREopensearchJB31XH'],
],
'parameters' => [
[
'name' => 'instanceId',
'in' => 'path',
- 'schema' => [
- 'description' => 'The instance ID.'."\n",
- 'type' => 'string',
- 'required' => true,
- 'example' => 'ha-cn-uax37kni501',
- ],
- ],
- [
- 'name' => 'deployName',
- 'in' => 'path',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'vpc_hz_domain_1',
- ],
+ 'schema' => ['description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'ha-cn-pl32rf0****'],
],
[
- 'name' => 'dataSourceName',
+ 'name' => 'indexName',
'in' => 'path',
- 'schema' => [
- 'description' => 'The name of the data source.'."\n",
- 'type' => 'string',
- 'required' => true,
- 'example' => 'ha-cn-9lb34d9ee01_image_embedding',
- ],
+ 'schema' => ['description' => 'The index name.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'test_api'],
],
],
'responses' => [
@@ -9660,982 +5622,1077 @@
'schema' => [
'type' => 'object',
'properties' => [
- 'requestId' => [
- 'title' => 'id of request',
- 'description' => 'requestId',
- 'type' => 'string',
- 'example' => '2AE63638-5420-56DC-BF59-37D8174039A0',
- ],
+ 'requestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '4FB0325E-8C37-5525-96AC-0333523170A3'],
'result' => [
- 'title' => 'Deploy',
- 'description' => 'The result.'."\n",
+ 'title' => '',
+ 'description' => 'The index information.',
'type' => 'object',
'properties' => [
- 'storage' => [
- 'description' => 'The information about the data source.'."\n",
- 'type' => 'object',
- 'properties' => [
- 'endpoint' => [
- 'title' => 'odps相关',
- 'description' => 'The endpoint of the MaxCompute data source.'."\n",
- 'type' => 'string',
- 'example' => 'http://service.cn-hangzhou.maxcompute.aliyun-inc.com/api',
- ],
- 'accessKey' => [
- 'description' => 'The AccessKey ID of the MaxCompute data source.'."\n",
- 'type' => 'string',
- 'example' => 'ak',
- ],
- 'accessSecret' => [
- 'description' => 'The AccessKey secret of the MaxCompute data source.'."\n",
- 'type' => 'string',
- 'example' => 'as',
- ],
- 'project' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'wireless_1688_personal_rec',
- ],
- 'partition' => [
- 'description' => 'The partition in the MaxCompute table. Example: ds=20180102.'."\n",
- 'type' => 'string',
- 'example' => 'ds=20220926',
- ],
- 'table' => [
- 'title' => 'saro、odps相关',
- 'description' => '',
- 'type' => 'string',
- 'example' => 'behavior',
- ],
- 'namespace' => [
- 'title' => 'saro相关',
- 'description' => '',
- 'type' => 'string',
- 'example' => 'lazada-campaign-flink',
- ],
- 'path' => [
- 'title' => 'hdfs相关',
- 'description' => '',
- 'type' => 'string',
- 'example' => '/beiming_xobject/dwd_xobjectsandbox__list_create_action_by_new/',
- ],
- 'ossPath' => [
- 'title' => 'oss数据源相关',
- 'description' => 'The Object Storage Service (OSS) path.'."\n",
- 'type' => 'string',
- 'example' => 'oss://opensearch',
- ],
- 'bucket' => [
- 'description' => 'The name of the OSS bucket.'."\n",
- 'type' => 'string',
- 'example' => 'antsys-miniapp-chongwen-static',
- ],
- 'catalog' => [
- 'type' => 'string',
- ],
- 'database' => [
- 'type' => 'string',
- ],
- 'tag' => [
- 'type' => 'string',
- ],
- ],
- ],
- 'autoBuildIndex' => [
- 'title' => '是否开启自动全量',
- 'description' => '',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
- 'processor' => [
- 'description' => 'The parameters of the process.'."\n",
- 'type' => 'object',
- 'properties' => [
- 'args' => [
- 'title' => '进程启动参数',
- 'description' => 'The startup parameters of the process.'."\n",
- 'type' => 'string',
- 'example' => '{}',
- ],
- 'resource' => [
- 'title' => '资源信息',
- 'description' => 'The resource information.'."\n",
- 'type' => 'string',
- 'example' => '{}',
+ 'name' => ['title' => '', 'description' => 'The index name.', 'type' => 'string', 'example' => 'test_api'],
+ 'versions' => [
+ 'title' => '',
+ 'description' => 'The version information.',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'The data version information.',
+ 'type' => 'object',
+ 'properties' => [
+ 'desc' => ['title' => '', 'description' => 'The description.', 'type' => 'string', 'example' => 'Index Note'],
+ 'files' => [
+ 'title' => '',
+ 'description' => 'The location.',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'The version details.',
+ 'type' => 'object',
+ 'properties' => [
+ 'fullPathName' => ['description' => 'The full path.', 'type' => 'string', 'title' => '', 'example' => '/qrs.json'."\n"],
+ 'isDir' => ['description' => 'Indicates whether the path points to a directory.', 'type' => 'boolean', 'title' => '', 'example' => 'true'],
+ 'isTemplate' => ['description' => 'Indicates whether the path is a template.', 'type' => 'boolean', 'title' => '', 'example' => 'true'],
+ 'name' => ['description' => 'The file name.', 'type' => 'string', 'title' => '', 'example' => 'qrs.json'],
+ ],
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'example' => '',
+ ],
+ 'name' => ['title' => '', 'description' => 'The version name.', 'type' => 'string', 'example' => 'test'],
+ 'status' => ['title' => '', 'description' => 'The status.'."\n"
+ ."\n"
+ .'- NEW: Created.'."\n"
+ ."\n"
+ .'- PUBLISH: Normal.'."\n"
+ ."\n"
+ .'- IN\\_USE: In use.'."\n"
+ ."\n"
+ .'- NOT\\_USE: Not in use.'."\n"
+ ."\n"
+ .'- STOP\\_USE: Stopping.'."\n"
+ ."\n"
+ .'- RESTORE\\_USE: Resuming.'."\n"
+ ."\n"
+ .'- FAIL: Failed.', 'type' => 'string', 'example' => 'PUBLISH'],
+ 'updateTime' => ['title' => '', 'description' => 'The time when the version was updated.', 'type' => 'integer', 'format' => 'int64', 'example' => '1718846192'],
+ 'versionId' => ['title' => '', 'description' => 'The version ID.', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
],
+ 'title' => '',
+ 'example' => '',
],
+ 'example' => '',
],
- 'extend' => [
- 'description' => '',
+ 'dataSource' => ['title' => '', 'description' => 'The data source.', 'type' => 'string', 'example' => 'ha-cn-pl32rf0****_test_api'."\n"],
+ 'domain' => ['title' => '', 'description' => 'The deployment name of the data source.', 'type' => 'string', 'example' => 'sz_vpc_domain_1'],
+ 'indexStatus' => ['title' => '', 'description' => 'The status.'."\n"
+ ."\n"
+ .'- NEW: Created.'."\n"
+ ."\n"
+ .'- PUBLISH: Normal.'."\n"
+ ."\n"
+ .'- IN\\_USE: In use.'."\n"
+ ."\n"
+ .'- NOT\\_USE: Not in use.'."\n"
+ ."\n"
+ .'- STOP\\_USE: Stopping.'."\n"
+ ."\n"
+ .'- RESTORE\\_USE: Resuming.'."\n"
+ ."\n"
+ .'- FAIL: Failed.', 'type' => 'string', 'example' => 'IN_USE'],
+ 'content' => ['title' => '', 'description' => 'The content of the file.', 'type' => 'string', 'example' => '{"summarys":{"parameter":{"file_compressor":"zstd"},"summary_fields":["id"]},"file_compress":[{"name":"file_compressor","type":"zstd"},{"name":"no_compressor","type":""}],"indexs":[{"index_fields":"name","index_name":"ids","index_type":"STRING"},{"has_primary_key_attribute":true,"index_fields":"id","is_primary_key_sorted":false,"index_name":"id","index_type":"PRIMARYKEY64"}],"attributes":[{"file_compress":"no_compressor","field_name":"id"}],"fields":[{"user_defined_param":{},"compress_type":"uniq","field_type":"STRING","field_name":"id"},{"compress_type":"uniq","field_type":"STRING","field_name":"name"}],"table_name":"api"}'],
+ 'partition' => ['title' => '', 'description' => 'The data shard.', 'type' => 'integer', 'format' => 'int32', 'example' => '2'],
+ 'fullVersion' => ['title' => '', 'description' => 'The data version.', 'type' => 'integer', 'format' => 'int64', 'example' => '1688523414'],
+ 'fullUpdateTime' => ['title' => '', 'description' => 'The time of the last full switchover.', 'type' => 'string', 'example' => '2024-06-20 08:52:54'],
+ 'incUpdateTime' => ['title' => '', 'description' => 'The time of the last incremental update.', 'type' => 'string', 'example' => '2024-06-20 08:52:54'],
+ 'indexSize' => ['title' => '', 'description' => 'The index size.', 'type' => 'integer', 'format' => 'int64', 'example' => '4689'],
+ 'description' => ['title' => '', 'description' => 'The note.', 'type' => 'string', 'example' => 'note'],
+ 'dataSourceInfo' => [
+ 'title' => '',
+ 'description' => 'The information about the data source.',
'type' => 'object',
'properties' => [
- 'saro' => [
- 'description' => '',
+ 'processPartitionCount' => ['title' => '', 'description' => 'The number of resources for data updates.', 'type' => 'integer', 'format' => 'int32', 'example' => '2'],
+ 'name' => ['title' => '', 'description' => 'The name of the data source.', 'type' => 'string', 'example' => 'ha-cn-pl32rf0****_test_api'."\n"],
+ 'type' => ['title' => '', 'description' => 'The type of the data source. Valid values: odps, swift, saro, oss, and unKnow.', 'type' => 'string', 'example' => 'odps'],
+ 'domain' => ['title' => '', 'description' => 'The offline deployment.', 'type' => 'string', 'example' => 'vpc_hz_domain_1'],
+ 'config' => [
+ 'title' => '',
+ 'description' => 'The configurations of the ODPS data source.',
'type' => 'object',
'properties' => [
- 'path' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'dist-dmj-job/src/main/java',
- ],
- 'version' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '0.6.0',
- ],
+ 'endpoint' => ['title' => '', 'description' => 'Information related to ODPS.', 'type' => 'string', 'example' => 'http://service.cn-hangzhou.maxcompute.aliyun-inc.com/api'],
+ 'accessKey' => ['description' => 'The AccessKey ID for the ODPS data source.', 'type' => 'string', 'title' => '', 'example' => 'L***p'],
+ 'accessSecret' => ['description' => 'The AccessKey secret for the ODPS data source.', 'type' => 'string', 'title' => '', 'example' => '5**9a6'],
+ 'project' => ['description' => 'The name of the ODPS project.', 'type' => 'string', 'title' => '', 'example' => 'tisplus_dev'],
+ 'partition' => ['description' => 'The ODPS partition. Example: ds=20180102', 'type' => 'string', 'title' => '', 'example' => 'ds=20220713'],
+ 'table' => ['title' => '', 'description' => 'Information related to saro and ODPS.', 'type' => 'string', 'example' => 'dump_odps_demo'],
+ 'namespace' => ['title' => '', 'description' => 'Information related to saro.', 'type' => 'string', 'example' => 'TEST_dump_demo_sj_na61hunbu2_share_holo'],
+ 'path' => ['title' => '', 'description' => 'Information related to HDFS.', 'type' => 'string', 'example' => 'http://test_opensearch/sift_oss_test.data'],
+ 'ossPath' => ['title' => '', 'description' => 'Information related to the OSS data source.', 'type' => 'string', 'example' => '/test_opensearch/sift_oss_test.data'],
+ 'bucket' => ['description' => 'The name of the bucket.', 'type' => 'string', 'title' => '', 'example' => 'ha3test-oss'],
+ 'format' => ['type' => 'string', 'description' => 'The file format of the data in OSS.'."\n"
+ ."\n"
+ .'- ha3'."\n"
+ ."\n"
+ .'- json', 'title' => '', 'example' => 'ha3'],
+ 'catalog' => ['type' => 'string', 'description' => 'The data catalog ID of the DLF data source.', 'title' => '', 'example' => 'clg-paimon-21cc136237a6457f8618f5f82d116d7e'],
+ 'database' => ['type' => 'string', 'description' => 'The database of the DLF data source.', 'title' => '', 'example' => 'dlf_test'],
+ 'tag' => ['type' => 'string', 'description' => 'The tag of the DLF data source.', 'title' => '', 'example' => 'test_tag'],
],
+ 'example' => '',
],
- 'hdfs' => [
- 'description' => '',
+ 'saroConfig' => [
+ 'title' => '',
+ 'description' => 'The configurations of the saro data source.',
'type' => 'object',
'properties' => [
- 'path' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'dist-dmj-job/src/main/java',
- ],
+ 'namespace' => ['description' => 'The namespace of the saro data source.', 'type' => 'string', 'title' => '', 'example' => 'TEST_dump_demo_sj_na61hunbu2_share_holo'],
+ 'tableName' => ['description' => 'The name of the saro data table.', 'type' => 'string', 'title' => '', 'example' => 'llm'],
],
+ 'example' => '',
],
- 'odps' => [
- 'description' => '',
+ 'autoBuildIndex' => ['title' => '', 'description' => 'Indicates whether automatic full indexing is enabled.', 'type' => 'boolean', 'example' => 'true'],
+ 'processParallelNum' => ['description' => 'The concurrency for full processing.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '2'],
+ ],
+ 'example' => '',
+ ],
+ 'createTime' => ['type' => 'string', 'description' => 'The time when the index was created.', 'title' => '', 'example' => '2024-05-21 16:05:26'],
+ 'updateTime' => ['type' => 'string', 'description' => 'The time when the index was updated.', 'title' => '', 'example' => '2024-05-21 16:05:26'],
+ 'cluster' => [
+ 'description' => 'The cluster information.',
+ 'type' => 'object',
+ 'additionalProperties' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'buildParallelNum' => ['type' => 'integer', 'format' => 'int32', 'description' => 'The concurrency for full indexing.', 'title' => '', 'example' => '2'],
+ 'mergeParallelNum' => ['type' => 'integer', 'format' => 'int32', 'description' => 'The concurrency for full merging.', 'title' => '', 'example' => '2'],
+ ],
+ 'description' => 'The cluster information.',
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'config' => [
+ 'description' => 'The configuration information.',
+ 'type' => 'object',
+ 'additionalProperties' => [
+ 'type' => 'object',
+ 'additionalProperties' => [
'type' => 'object',
'properties' => [
- 'partitions' => [
- 'description' => '',
- 'type' => 'object',
- 'additionalProperties' => [
- 'type' => 'string',
- 'example' => 'ds=20220926',
- 'description' => '',
- ],
- ],
+ 'name' => ['type' => 'string', 'description' => 'The configuration name.'."\n", 'title' => '', 'example' => "\n"
+ .'ha-cn-pl32rf0****_offline_adv_v1'],
+ 'updateTime' => ['type' => 'string', 'description' => 'The time when the configuration was updated.'."\n", 'title' => '', 'example' => '1716258634000'],
+ 'desc' => ['type' => 'string', 'description' => 'The description of the advanced configuration.'."\n", 'title' => '', 'example' => 'Note Information'],
],
+ 'description' => 'The information about the child configuration item.'."\n",
+ 'title' => '',
+ 'example' => '',
],
- 'oss' => [
- 'description' => '',
+ 'description' => 'The configuration information.',
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'configWhenBuild' => [
+ 'description' => 'The configuration that will take effect for the next indexing.',
+ 'type' => 'object',
+ 'additionalProperties' => [
+ 'type' => 'object',
+ 'additionalProperties' => [
'type' => 'object',
'properties' => [
- 'path' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'oss://opensearch',
- ],
+ 'name' => ['type' => 'string', 'description' => 'The configuration name.'."\n", 'title' => '', 'example' => "\n"
+ .'ha-cn-pl32rf0****_offline_adv_v1'],
+ 'updateTime' => ['type' => 'string', 'description' => 'The time when the configuration was updated.'."\n", 'title' => '', 'example' => '1716258634000'],
+ 'desc' => ['type' => 'string', 'description' => 'The description of the advanced configuration.'."\n", 'title' => '', 'example' => 'Note Information'],
],
+ 'description' => 'The child configuration item that takes effect next time.'."\n",
+ 'title' => '',
+ 'example' => '',
],
+ 'description' => 'The configuration that will take effect for the next indexing.',
+ 'title' => '',
+ 'example' => '',
],
+ 'title' => '',
+ 'example' => '',
],
- 'swift' => [
- 'title' => '增量swift信息',
- 'description' => 'The information about the incremental data source Swift.'."\n",
+ 'extend' => [
+ 'description' => 'The extended information.',
'type' => 'object',
- 'properties' => [
- 'zk' => [
- 'description' => 'zk'."\n",
- 'type' => 'string',
- 'example' => 'zk',
- ],
- 'topic' => [
- 'description' => 'The topic.'."\n",
- 'type' => 'string',
- 'example' => 'topic',
- ],
+ 'additionalProperties' => [
+ 'type' => 'array',
+ 'items' => ['type' => 'string', 'description' => 'Extended information'."\n", 'title' => '', 'example' => 'Extended Information'],
+ 'description' => 'The extended information.',
+ 'title' => '',
+ 'example' => '',
],
+ 'title' => '',
+ 'example' => '',
],
],
+ 'example' => '',
],
],
'description' => '',
+ 'title' => '',
+ 'example' => '',
],
],
- 500 => [],
- ],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"2AE63638-5420-56DC-BF59-37D8174039A0\\",\\n \\"result\\": {\\n \\"storage\\": {\\n \\"endpoint\\": \\"http://service.cn-hangzhou.maxcompute.aliyun-inc.com/api\\",\\n \\"accessKey\\": \\"L***p\\",\\n \\"accessSecret\\": \\"5**9a6\\",\\n \\"project\\": \\"wireless_1688_personal_rec\\",\\n \\"partition\\": \\"ds=20220926\\",\\n \\"table\\": \\"behavior\\",\\n \\"namespace\\": \\"lazada-campaign-flink\\",\\n \\"path\\": \\"/beiming_xobject/dwd_xobjectsandbox__list_create_action_by_new/\\",\\n \\"ossPath\\": \\"/opensearch/test.json\\",\\n \\"bucket\\": \\"test-oss-bucket\\",\\n \\"catalog\\": \\"\\",\\n \\"database\\": \\"\\",\\n \\"tag\\": \\"\\"\\n },\\n \\"autoBuildIndex\\": true,\\n \\"processor\\": {\\n \\"args\\": \\"{\\\\n\\\\t\\\\\\"processInfos\\\\\\": [],\\\\n\\\\t\\\\\\"groupId\\\\\\": \\\\\\"opensearch\\\\\\",\\\\n\\\\t\\\\\\"containerConfigs\\\\\\": [],\\\\n\\\\t\\\\\\"priority\\\\\\": {\\\\n\\\\t\\\\t\\\\\\"minor_priority\\\\\\": 0,\\\\n\\\\t\\\\t\\\\\\"major_priority\\\\\\": 64\\\\n\\\\t}\\\\n}\\",\\n \\"resource\\": \\"[{\\\\n\\\\t\\\\\\"_bs_role\\\\\\": \\\\\\"processor.*.inc\\\\\\",\\\\n\\\\t\\\\\\"priority\\\\\\": {\\\\n\\\\t\\\\t\\\\\\"major_priority\\\\\\": 32,\\\\n\\\\t\\\\t\\\\\\"minor_priority\\\\\\": 0\\\\n\\\\t},\\\\n\\\\t\\\\\\"slotResources\\\\\\": [{\\\\n\\\\t\\\\t\\\\\\"slotResources\\\\\\": [{\\\\n\\\\t\\\\t\\\\t\\\\\\"amount\\\\\\": 200,\\\\n\\\\t\\\\t\\\\t\\\\\\"name\\\\\\": \\\\\\"cpu\\\\\\"\\\\n\\\\t\\\\t}, {\\\\n\\\\t\\\\t\\\\t\\\\\\"amount\\\\\\": 8192,\\\\n\\\\t\\\\t\\\\t\\\\\\"name\\\\\\": \\\\\\"mem\\\\\\"\\\\n\\\\t\\\\t}, {\\\\n\\\\t\\\\t\\\\t\\\\\\"amount\\\\\\": 0,\\\\n\\\\t\\\\t\\\\t\\\\\\"name\\\\\\": \\\\\\"T4\\\\\\"\\\\n\\\\t\\\\t}, {\\\\n\\\\t\\\\t\\\\t\\\\\\"amount\\\\\\": 10,\\\\n\\\\t\\\\t\\\\t\\\\\\"type\\\\\\": \\\\\\"SCALAR\\\\\\",\\\\n\\\\t\\\\t\\\\t\\\\\\"name\\\\\\": \\\\\\"disk_ratio_9999\\\\\\"\\\\n\\\\t\\\\t}, {\\\\n\\\\t\\\\t\\\\t\\\\\\"amount\\\\\\": 20480,\\\\n\\\\t\\\\t\\\\t\\\\\\"type\\\\\\": \\\\\\"SCALAR\\\\\\",\\\\n\\\\t\\\\t\\\\t\\\\\\"name\\\\\\": \\\\\\"disk_size_9999\\\\\\"\\\\n\\\\t\\\\t}]\\\\n\\\\t}]\\\\n}]\\"\\n },\\n \\"extend\\": {\\n \\"saro\\": {\\n \\"path\\": \\"dist-dmj-job/src/main/java\\",\\n \\"version\\": \\"0.6.0\\"\\n },\\n \\"hdfs\\": {\\n \\"path\\": \\"dist-dmj-job/src/main/java\\"\\n },\\n \\"odps\\": {\\n \\"partitions\\": {\\n \\"key\\": \\"ds=20220926\\"\\n }\\n },\\n \\"oss\\": {\\n \\"path\\": \\"oss://opensearch\\"\\n }\\n },\\n \\"swift\\": {\\n \\"zk\\": \\"test-zk\\",\\n \\"topic\\": \\"ha-cn-pl32rf0****_test_api\\"\\n }\\n }\\n}","type":"json"}]',
- 'title' => 'GetDataSourceDeploy',
- ],
- 'CloneSqlInstance' => [
- 'path' => '/openapi/ha3/instances/{instanceId}/sql-studio/databases/{database}/sql-instances/{sqlInstanceId}/actions/clone',
- 'methods' => [
- 'post',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
- 'security' => [
- [
- 'AK' => [],
- ],
- ],
- 'operationType' => 'write',
- 'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'create',
- 'abilityTreeCode' => '139625',
- 'abilityTreeNodes' => [
- 'FEATUREopensearch95VJR4',
- ],
- ],
- 'parameters' => [
- [
- 'name' => 'instanceId',
- 'in' => 'path',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'ha-cn-pl32rf0****',
- ],
- ],
- [
- 'name' => 'database',
- 'in' => 'path',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'general',
- ],
- ],
- [
- 'name' => 'sqlInstanceId',
- 'in' => 'path',
- 'schema' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => true,
- 'example' => '1',
- ],
- ],
- [
- 'name' => 'body',
- 'in' => 'body',
- 'style' => 'json',
+ '5xx' => [
'schema' => [
- 'description' => '',
'type' => 'object',
'properties' => [
- 'targetFolderId' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => true,
- 'example' => '1',
- ],
- 'name' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'test',
- ],
+ 'requestId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''],
+ 'message' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''],
+ 'code' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''],
],
- 'required' => false,
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
],
],
- 'responses' => [
- 200 => [
- 'schema' => [
- 'type' => 'object',
- 'properties' => [
- 'requestId' => [
- 'title' => 'id of request',
- 'description' => 'id of request',
- 'type' => 'string',
- 'example' => '10D5E615-69F7-5F49-B850-00169ADE513C',
- ],
- 'result' => [
- 'title' => 'NodeVO',
- 'description' => 'NodeVO',
- 'type' => 'object',
- 'properties' => [
- 'id' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '1',
- ],
- 'gmtCreate' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '1719221186114',
- ],
- 'gmtModified' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '1719221186114',
- ],
- 'name' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'general',
- ],
- 'parent' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '1',
- ],
- 'isDir' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => 'True',
- ],
- 'type' => [
- 'title' => 'table, instance, template, function',
- 'description' => 'table, instance, template, function',
- 'type' => 'string',
- 'example' => 'instance',
- ],
- 'instanceId' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '-cn-pl32rf0****',
- ],
- 'templateId' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '1',
- ],
- ],
- ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"4FB0325E-8C37-5525-96AC-0333523170A3\\",\\n \\"result\\": {\\n \\"name\\": \\"test_api\\",\\n \\"versions\\": [\\n {\\n \\"desc\\": \\"Index Note\\",\\n \\"files\\": [\\n {\\n \\"fullPathName\\": \\"/qrs.json\\\\n\\",\\n \\"isDir\\": true,\\n \\"isTemplate\\": true,\\n \\"name\\": \\"qrs.json\\"\\n }\\n ],\\n \\"name\\": \\"test\\",\\n \\"status\\": \\"PUBLISH\\",\\n \\"updateTime\\": 1718846192,\\n \\"versionId\\": 1\\n }\\n ],\\n \\"dataSource\\": \\"ha-cn-pl32rf0****_test_api\\\\n\\",\\n \\"domain\\": \\"sz_vpc_domain_1\\",\\n \\"indexStatus\\": \\"IN_USE\\",\\n \\"content\\": \\"{\\\\\\"summarys\\\\\\":{\\\\\\"parameter\\\\\\":{\\\\\\"file_compressor\\\\\\":\\\\\\"zstd\\\\\\"},\\\\\\"summary_fields\\\\\\":[\\\\\\"id\\\\\\"]},\\\\\\"file_compress\\\\\\":[{\\\\\\"name\\\\\\":\\\\\\"file_compressor\\\\\\",\\\\\\"type\\\\\\":\\\\\\"zstd\\\\\\"},{\\\\\\"name\\\\\\":\\\\\\"no_compressor\\\\\\",\\\\\\"type\\\\\\":\\\\\\"\\\\\\"}],\\\\\\"indexs\\\\\\":[{\\\\\\"index_fields\\\\\\":\\\\\\"name\\\\\\",\\\\\\"index_name\\\\\\":\\\\\\"ids\\\\\\",\\\\\\"index_type\\\\\\":\\\\\\"STRING\\\\\\"},{\\\\\\"has_primary_key_attribute\\\\\\":true,\\\\\\"index_fields\\\\\\":\\\\\\"id\\\\\\",\\\\\\"is_primary_key_sorted\\\\\\":false,\\\\\\"index_name\\\\\\":\\\\\\"id\\\\\\",\\\\\\"index_type\\\\\\":\\\\\\"PRIMARYKEY64\\\\\\"}],\\\\\\"attributes\\\\\\":[{\\\\\\"file_compress\\\\\\":\\\\\\"no_compressor\\\\\\",\\\\\\"field_name\\\\\\":\\\\\\"id\\\\\\"}],\\\\\\"fields\\\\\\":[{\\\\\\"user_defined_param\\\\\\":{},\\\\\\"compress_type\\\\\\":\\\\\\"uniq\\\\\\",\\\\\\"field_type\\\\\\":\\\\\\"STRING\\\\\\",\\\\\\"field_name\\\\\\":\\\\\\"id\\\\\\"},{\\\\\\"compress_type\\\\\\":\\\\\\"uniq\\\\\\",\\\\\\"field_type\\\\\\":\\\\\\"STRING\\\\\\",\\\\\\"field_name\\\\\\":\\\\\\"name\\\\\\"}],\\\\\\"table_name\\\\\\":\\\\\\"api\\\\\\"}\\",\\n \\"partition\\": 2,\\n \\"fullVersion\\": 1688523414,\\n \\"fullUpdateTime\\": \\"2024-06-20 08:52:54\\",\\n \\"incUpdateTime\\": \\"2024-06-20 08:52:54\\",\\n \\"indexSize\\": 4689,\\n \\"description\\": \\"note\\",\\n \\"dataSourceInfo\\": {\\n \\"processPartitionCount\\": 2,\\n \\"name\\": \\"ha-cn-pl32rf0****_test_api\\\\n\\",\\n \\"type\\": \\"odps\\",\\n \\"domain\\": \\"vpc_hz_domain_1\\",\\n \\"config\\": {\\n \\"endpoint\\": \\"http://service.cn-hangzhou.maxcompute.aliyun-inc.com/api\\",\\n \\"accessKey\\": \\"L***p\\",\\n \\"accessSecret\\": \\"5**9a6\\",\\n \\"project\\": \\"tisplus_dev\\",\\n \\"partition\\": \\"ds=20220713\\",\\n \\"table\\": \\"dump_odps_demo\\",\\n \\"namespace\\": \\"TEST_dump_demo_sj_na61hunbu2_share_holo\\",\\n \\"path\\": \\"http://test_opensearch/sift_oss_test.data\\",\\n \\"ossPath\\": \\"/test_opensearch/sift_oss_test.data\\",\\n \\"bucket\\": \\"ha3test-oss\\",\\n \\"format\\": \\"ha3\\",\\n \\"catalog\\": \\"clg-paimon-21cc136237a6457f8618f5f82d116d7e\\",\\n \\"database\\": \\"dlf_test\\",\\n \\"tag\\": \\"test_tag\\"\\n },\\n \\"saroConfig\\": {\\n \\"namespace\\": \\"TEST_dump_demo_sj_na61hunbu2_share_holo\\",\\n \\"tableName\\": \\"llm\\"\\n },\\n \\"autoBuildIndex\\": true,\\n \\"processParallelNum\\": 2\\n },\\n \\"createTime\\": \\"2024-05-21 16:05:26\\",\\n \\"updateTime\\": \\"2024-05-21 16:05:26\\",\\n \\"cluster\\": {\\n \\"key\\": {\\n \\"buildParallelNum\\": 2,\\n \\"mergeParallelNum\\": 2\\n }\\n },\\n \\"config\\": {\\n \\"key\\": {\\n \\"key\\": {\\n \\"name\\": \\"\\\\nha-cn-pl32rf0****_offline_adv_v1\\",\\n \\"updateTime\\": \\"1716258634000\\",\\n \\"desc\\": \\"Note Information\\"\\n }\\n }\\n },\\n \\"configWhenBuild\\": {\\n \\"key\\": {\\n \\"key\\": {\\n \\"name\\": \\"\\\\nha-cn-pl32rf0****_offline_adv_v1\\",\\n \\"updateTime\\": \\"1716258634000\\",\\n \\"desc\\": \\"Note Information\\"\\n }\\n }\\n },\\n \\"extend\\": {\\n \\"key\\": [\\n \\"Extended Information\\"\\n ]\\n }\\n }\\n}","type":"json"}]',
+ 'title' => 'GetIndex',
+ 'description' => '## Method'."\n"
+ ."\n"
+ .'```'."\n"
+ .'GET'."\n"
+ .'```'."\n"
+ ."\n"
+ .'## URI'."\n"
+ ."\n"
+ .'```'."\n"
+ .'/openapi/ha3/instances/{instanceId}/indexes/{indexName}'."\n"
+ .'```',
+ 'requestParamsDescription' => '## Request examples'."\n"
+ ."\n"
+ .'```'."\n"
+ .'GET /openapi/ha3/instances/ose-test1/indexes/index1?dataSource=xxx'."\n"
+ .'```',
+ 'responseParamsDescription' => '## Response examples'."\n"
+ ."\n"
+ .'Example of a successful response'."\n"
+ ."\n"
+ .'```'."\n"
+ .'{'."\n"
+ .' "requestId": "e1eef569-1ff7-4bf8-acf7-1cecca9894ce",'."\n"
+ .' "result": {'."\n"
+ .' "name": "index-name",'."\n"
+ .' "dataSource": "ha-cn-xxx-index-name",'."\n"
+ .' "domain": "test", // The deployment name of the data source'."\n"
+ .' "partition": 2,'."\n"
+ .' "indexStatus": "IN_USE",'."\n"
+ .' "content": "{\\n\\t\\"summarys\\":{\\n\\t\\t\\"parameter\\":{\\n\\t\\t\\t\\"file_compressor\\":\\"zstd\\"\\n\\t\\t},\\n\\t\\t\\"summary_fields\\":[\\n\\t\\t\\t\\"id\\"\\n\\t\\t]\\n\\t},\\n\\t\\"file_compress\\":[\\n\\t\\t{\\n\\t\\t\\t\\"name\\":\\"file_compressor\\",\\n\\t\\t\\t\\"type\\":\\"zstd\\"\\n\\t\\t},\\n\\t\\t{\\n\\t\\t\\t\\"name\\":\\"no_compressor\\",\\n\\t\\t\\t\\"type\\":\\"\\"\\n\\t\\t}\\n\\t],\\n\\t\\"indexs\\":[\\n\\t\\t{\\n\\t\\t\\t\\"index_fields\\":\\"name\\",\\n\\t\\t\\t\\"index_name\\":\\"ids\\",\\n\\t\\t\\t\\"index_type\\":\\"STRING\\"\\n\\t\\t},\\n\\t\\t{\\n\\t\\t\\t\\"has_primary_key_attribute\\":true,\\n\\t\\t\\t\\"index_fields\\":\\"id\\",\\n\\t\\t\\t\\"is_primary_key_sorted\\":false,\\n\\t\\t\\t\\"index_name\\":\\"id\\",\\n\\t\\t\\t\\"index_type\\":\\"PRIMARYKEY64\\"\\n\\t\\t}\\n\\t],\\n\\t\\"attributes\\":[\\n\\t\\t{\\n\\t\\t\\t\\"file_compress\\":\\"no_compressor\\",\\n\\t\\t\\t\\"field_name\\":\\"id\\"\\n\\t\\t}\\n\\t],\\n\\t\\"fields\\":[\\n\\t\\t{\\n\\t\\t\\t\\"user_defined_param\\":{},\\n\\t\\t\\t\\"compress_type\\":\\"uniq\\",\\n\\t\\t\\t\\"field_type\\":\\"STRING\\",\\n\\t\\t\\t\\"field_name\\":\\"id\\"\\n\\t\\t},\\n\\t\\t{\\n\\t\\t\\t\\"compress_type\\":\\"uniq\\",\\n\\t\\t\\t\\"field_type\\":\\"STRING\\",\\n\\t\\t\\t\\"field_name\\":\\"name\\"\\n\\t\\t}\\n\\t],\\n\\t\\"table_name\\":\\"api\\"\\n}",'."\n"
+ .' "extend": {'."\n"
+ .' "vector": ['."\n"
+ .' "vector"'."\n"
+ .' ],'."\n"
+ .' "embeding": ['."\n"
+ .' "id"'."\n"
+ .' ],'."\n"
+ .' "description": ['."\n"
+ .' "{\\"feild2\\":\\"Note 2\\"}",'."\n"
+ .' "{\\"feild3\\":\\"Note 3\\"}"'."\n"
+ .' ]'."\n"
+ .' },'."\n"
+ .' "cluster": {'."\n"
+ .' "build_parallel_num": "2",'."\n"
+ .' "merge_parallel_num": "2"'."\n"
+ .' },'."\n"
+ .' "dataSourceInfo": {'."\n"
+ .' "type": "odps",'."\n"
+ .' "dataSource": "ha-cn-xxx-index-name",'."\n"
+ .' "processPartitionCount": 2,'."\n"
+ .' "domain": "test",'."\n"
+ .' "autoBuildIndex": true,'."\n"
+ .' "config": {'."\n"
+ .' "project": "tisplus_dev",'."\n"
+ .' "table": "tisplus_one_key_build_station_template_table_test",'."\n"
+ .' "partition": "ds=12345",'."\n"
+ .' "accesskeyId": "root",'."\n"
+ .' "accesskeySecret": "root123",'."\n"
+ .' "endpoint": "http://service.cn-hangzhou.maxcompute.aliyun-inc.com/api"'."\n"
+ .' },'."\n"
+ .' "saroConfig": {'."\n"
+ .' "namespace": "TEST_dump_demo_sj_na61hunbu2_share_holo",'."\n"
+ .' "tableName": "dump_odps_demo"'."\n"
+ .' },'."\n"
+ .' "processParallelNum": 2,'."\n"
+ .' "swiftConfig":{'."\n"
+ .' "topic":"ha-cn-xxx-index-name"'."\n"
+ .' }'."\n"
+ .' },'."\n"
+ .' "config": {'."\n"
+ .' "OFFLINE_DICT": {'."\n"
+ .' "name": "ha-cn-finxmo71065_offline_dict_v2",'."\n"
+ .' "updateTime": 1709259817000,'."\n"
+ .' "desc": "Description"'."\n"
+ .' },'."\n"
+ .' "OFFLINE_TABLE": {'."\n"
+ .' "name": "ha-cn-finxmo71065_table_ha-cn-finxmo71065_test_saro_v2",'."\n"
+ .' "updateTime": 1709261682000,'."\n"
+ .' "desc": "Description"'."\n"
+ .' },'."\n"
+ .' "OFFLINE_COMMON": {'."\n"
+ .' "name": "ha-cn-finxmo71065_offline_adv_v2",'."\n"
+ .' "updateTime": 1709259817000,'."\n"
+ .' "desc": "Description"'."\n"
+ .' },'."\n"
+ .' "OFFLINE_PLUGIN": {'."\n"
+ .' "name": "ha-cn-finxmo71065_offline_plugin_v2",'."\n"
+ .' "updateTime": 1709259817000,'."\n"
+ .' "desc": "Description"'."\n"
+ .' },'."\n"
+ .' "OFFLINE_INDEX": {'."\n"
+ .' "name": "ha-cn-finxmo71065@ha-cn-finxmo71065_test_saro@test_saro@index_config_v2",'."\n"
+ .' "updateTime": 1709259817000,'."\n"
+ .' "desc": "Description"'."\n"
+ .' }'."\n"
+ .' },'."\n"
+ .' "configWhenBuild": {'."\n"
+ .' "OFFLINE_DICT": {'."\n"
+ .' "name": "ha-cn-finxmo71065_offline_dict_v2",'."\n"
+ .' "updateTime": 1709259817000,'."\n"
+ .' "desc": "Description"'."\n"
+ .' },'."\n"
+ .' "OFFLINE_TABLE": {'."\n"
+ .' "name": "ha-cn-finxmo71065_table_ha-cn-finxmo71065_test_saro_v2",'."\n"
+ .' "updateTime": 1709261682000,'."\n"
+ .' "desc": "Description"'."\n"
+ .' },'."\n"
+ .' "OFFLINE_COMMON": {'."\n"
+ .' "name": "ha-cn-finxmo71065_offline_adv_v2",'."\n"
+ .' "updateTime": 1709259817000,'."\n"
+ .' "desc": "Description"'."\n"
+ .' },'."\n"
+ .' "OFFLINE_PLUGIN": {'."\n"
+ .' "name": "ha-cn-finxmo71065_offline_plugin_v2",'."\n"
+ .' "updateTime": 1709259817000,'."\n"
+ .' "desc": "Description"'."\n"
+ .' },'."\n"
+ .' "OFFLINE_INDEX": {'."\n"
+ .' "name": "ha-cn-finxmo71065@ha-cn-finxmo71065_test_saro@test_saro@index_config_v2",'."\n"
+ .' "updateTime": 1709259817000,'."\n"
+ .' "desc": "Description"'."\n"
+ .' }'."\n"
+ .' }'."\n"
+ .' }'."\n"
+ .'```',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetIndex'],
+ ],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'searchengine:GetIndex',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SearchEngine', 'resourceType' => 'Instance', 'arn' => 'acs:searchengine:{#regionId}:{#accountId}:instance/{#InstanceId}'],
],
],
],
- 500 => [],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"10D5E615-69F7-5F49-B850-00169ADE513C\\",\\n \\"result\\": {\\n \\"id\\": 1,\\n \\"gmtCreate\\": \\"1719221186114\\",\\n \\"gmtModified\\": \\"1719221186114\\",\\n \\"name\\": \\"general\\",\\n \\"parent\\": 1,\\n \\"isDir\\": 0,\\n \\"type\\": \\"instance\\",\\n \\"instanceId\\": 0,\\n \\"templateId\\": 1\\n }\\n}","type":"json"}]',
- 'title' => 'CloneSqlInstance',
- 'summary' => 'Clones an SQL instance.',
],
- 'CreateFolder' => [
- 'path' => '/openapi/ha3/instances/{instanceId}/sql-studio/databases/{database}/folders',
- 'methods' => [
- 'post',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
+ 'GetIndexOnlineStrategy' => [
+ 'summary' => 'Queries the online effective policy of an index.',
+ 'path' => '/openapi/ha3/instances/{instanceId}/data-sources/{dataSourceName}/deploys/{deployName}/indexes/{indexName}/online-strategy',
+ 'methods' => ['get'],
+ 'schemes' => ['https', 'http'],
'security' => [
[
'AK' => [],
],
],
- 'operationType' => 'write',
+ 'operationType' => 'read',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'create',
- 'abilityTreeCode' => '138808',
- 'abilityTreeNodes' => [
- 'FEATUREopensearch95VJR4',
- ],
- ],
+ 'systemTags' => ['operationType' => 'get'],
'parameters' => [
[
'name' => 'instanceId',
'in' => 'path',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'ha-cn-pl32rf0****',
- ],
+ 'schema' => ['description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'example' => 'ha-cn-pl32rf0****', 'title' => ''],
],
[
- 'name' => 'database',
+ 'name' => 'dataSourceName',
'in' => 'path',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'general',
- ],
+ 'schema' => ['description' => 'The name of the data source.', 'type' => 'string', 'required' => true, 'example' => 'ha-cn-pl32rf0****_api_test', 'title' => ''],
],
[
- 'name' => 'body',
- 'in' => 'body',
- 'style' => 'json',
- 'schema' => [
- 'description' => '',
- 'type' => 'object',
- 'properties' => [
- 'name' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'gist_qc',
- ],
- 'parent' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => true,
- 'example' => '1',
- ],
- 'type' => [
- 'title' => 'table, instance, template, function',
- 'description' => 'table, instance, template, function',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'instance',
- ],
- ],
- 'required' => false,
- ],
+ 'name' => 'deployName',
+ 'in' => 'path',
+ 'schema' => ['description' => 'The name of the data center in which the data source is deployed.', 'type' => 'string', 'required' => true, 'example' => 'vpc_hz_domain_1', 'title' => ''],
+ ],
+ [
+ 'name' => 'indexName',
+ 'in' => 'path',
+ 'schema' => ['description' => 'The index name.', 'type' => 'string', 'required' => true, 'example' => 'test_api', 'title' => ''],
],
],
'responses' => [
200 => [
+ 'headers' => [],
'schema' => [
'type' => 'object',
'properties' => [
- 'requestId' => [
- 'title' => 'id of request',
- 'description' => 'id of request',
- 'type' => 'string',
- 'example' => 'E7B7D598-B080-5C8E-AA35-D43EC0D5F886',
- ],
+ 'requestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => 'FE03180A-0E29-5474-8A86-33F0683294A4'],
'result' => [
- 'title' => 'NodeVO',
- 'description' => 'NodeVO',
+ 'title' => '',
+ 'description' => 'The result.',
'type' => 'object',
'properties' => [
- 'id' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '25030',
- ],
- 'gmtCreate' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '1719221186114',
- ],
- 'gmtModified' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '1719221186114',
- ],
- 'name' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'test',
- ],
- 'parent' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '-1',
- ],
- 'isDir' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => 'True',
- ],
- 'type' => [
- 'title' => 'table, instance, template, function',
- 'description' => 'table, instance, template, function',
- 'type' => 'string',
- 'example' => 'instance',
- ],
- 'instanceId' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => 'ha-cn-pl32rf0****',
- ],
- 'templateId' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '1',
- ],
+ 'changeRate' => ['description' => 'The index change rate.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '20'],
],
+ 'example' => '',
],
],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
],
500 => [],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"E7B7D598-B080-5C8E-AA35-D43EC0D5F886\\",\\n \\"result\\": {\\n \\"id\\": 25030,\\n \\"gmtCreate\\": \\"1719221186114\\",\\n \\"gmtModified\\": \\"1719221186114\\",\\n \\"name\\": \\"test\\",\\n \\"parent\\": -1,\\n \\"isDir\\": 0,\\n \\"type\\": \\"instance\\",\\n \\"instanceId\\": 0,\\n \\"templateId\\": 1\\n }\\n}","type":"json"}]',
- 'title' => 'CreateFolder',
- 'summary' => 'Creates a folder.',
- ],
- 'CreateSqlInstance' => [
- 'path' => '/openapi/ha3/instances/{instanceId}/sql-studio/databases/{database}/sql-instances',
- 'methods' => [
- 'post',
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"FE03180A-0E29-5474-8A86-33F0683294A4\\",\\n \\"result\\": {\\n \\"changeRate\\": 20\\n }\\n}","type":"json"}]',
+ 'title' => 'GetIndexOnlineStrategy',
+ 'description' => '### Method'."\n"
+ ."\n"
+ .'```java'."\n"
+ .'GET'."\n"
+ .'```'."\n"
+ ."\n"
+ .'### URI'."\n"
+ ."\n"
+ .'```java'."\n"
+ .'/openapi/ha3/instances/{instanceId}/data-sources/{dataSourceName}/deploys/{deployName}/indexes/{indexName}/online-strategy'."\n"
+ .'```',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetIndexOnlineStrategy'],
+ ],
],
- 'schemes' => [
- 'http',
- 'https',
+ 'ramActions' => [
+ [
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'searchengine:GetIndexOnlineStrategy',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SearchEngine', 'resourceType' => 'Instance', 'arn' => 'acs:searchengine:{#regionId}:{#accountId}:instance/{#instanceId}'],
+ ],
+ ],
+ ],
],
+ ],
+ 'GetIndexVersion' => [
+ 'summary' => 'Queries the information about index versions that the current index version can be rolled back to.',
+ 'path' => '/openapi/ha3/instances/{instanceId}/clusters/{clusterName}/index-version',
+ 'methods' => ['get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
- 'operationType' => 'write',
+ 'operationType' => 'read',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'create',
- 'abilityTreeCode' => '139624',
- 'abilityTreeNodes' => [
- 'FEATUREopensearch95VJR4',
- ],
- ],
+ 'systemTags' => ['operationType' => 'get'],
'parameters' => [
[
'name' => 'instanceId',
'in' => 'path',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'ha-cn-pl32rf0****',
- ],
+ 'schema' => ['description' => 'The instance ID.'."\n", 'type' => 'string', 'required' => true, 'example' => 'ha-cn-pl32rf0****', 'title' => ''],
],
[
- 'name' => 'database',
+ 'name' => 'clusterName',
'in' => 'path',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'general',
- ],
- ],
- [
- 'name' => 'body',
- 'in' => 'body',
- 'style' => 'json',
- 'schema' => [
- 'description' => '',
- 'type' => 'object',
- 'properties' => [
- 'name' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'test',
- ],
- 'parent' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => true,
- 'example' => '-1',
- ],
- ],
- 'required' => false,
- ],
+ 'schema' => ['description' => 'The name of the cluster'."\n", 'type' => 'string', 'required' => true, 'example' => 'vpc_hz_domain_1', 'title' => ''],
],
],
'responses' => [
200 => [
- 'headers' => [],
'schema' => [
+ 'description' => 'The response parameters.'."\n",
'type' => 'object',
'properties' => [
- 'requestId' => [
- 'title' => 'id of request',
- 'description' => 'id of request',
- 'type' => 'string',
- 'example' => 'B43CD1BB-ABD7-59C5-B89A-6E5F6FE60A84',
- ],
+ 'requestId' => ['title' => '', 'description' => 'id of request'."\n", 'type' => 'string', 'example' => 'E7B7D598-B080-5C8E-AA35-D43EC0D5F886'],
'result' => [
- 'title' => 'NodeVO',
- 'description' => 'NodeVO',
+ 'title' => '',
+ 'description' => 'The clusters.'."\n",
'type' => 'object',
'properties' => [
- 'id' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '22',
- ],
- 'gmtCreate' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '1719220182844',
- ],
- 'gmtModified' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '1719220182844',
- ],
- 'name' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'test',
- ],
- 'parent' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '-1',
- ],
- 'isDir' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => 'true',
- ],
- 'type' => [
- 'title' => 'table, instance, template, function',
- 'description' => 'table, instance, template, function',
- 'type' => 'string',
- 'example' => 'instance',
- ],
- 'instanceId' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => 'ha-cn-pl32rf0****',
- ],
- 'templateId' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '1',
+ 'cluster' => ['description' => 'The cluster name.'."\n", 'type' => 'string', 'example' => 'hz_pre_vpc_domain_1', 'title' => ''],
+ 'indexVersions' => [
+ 'description' => 'The index versions.'."\n",
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'The list of index versions'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'indexName' => ['description' => 'The name of the index table.'."\n", 'type' => 'string', 'example' => 'test_api', 'title' => ''],
+ 'versions' => [
+ 'description' => 'The index versions.'."\n",
+ 'type' => 'array',
+ 'items' => ['description' => 'The index version.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1630353700', 'title' => ''],
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'buildDeployId' => ['description' => 'The ID of the offline deployment.'."\n", 'type' => 'string', 'example' => '2648', 'title' => ''],
+ 'currentVersion' => ['description' => 'The current online version number.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => ''],
+ ],
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'title' => '',
+ 'example' => '',
],
],
+ 'example' => '',
],
],
+ 'title' => '',
+ 'example' => '',
],
],
500 => [],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"B43CD1BB-ABD7-59C5-B89A-6E5F6FE60A84\\",\\n \\"result\\": {\\n \\"id\\": 22,\\n \\"gmtCreate\\": \\"1719220182844\\",\\n \\"gmtModified\\": \\"1719220182844\\",\\n \\"name\\": \\"test\\",\\n \\"parent\\": -1,\\n \\"isDir\\": 0,\\n \\"type\\": \\"instance\\",\\n \\"instanceId\\": 0,\\n \\"templateId\\": 1\\n }\\n}","type":"json"}]',
- 'title' => 'CreateSqlInstance',
- 'summary' => 'Creates an SQL instance.',
- ],
- 'DeleteSqlInstance' => [
- 'path' => '/openapi/ha3/instances/{instanceId}/sql-studio/databases/{database}/sql-instances/{sqlInstanceId}',
- 'methods' => [
- 'delete',
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"E7B7D598-B080-5C8E-AA35-D43EC0D5F886\\",\\n \\"result\\": {\\n \\"cluster\\": \\"hz_pre_vpc_domain_1\\",\\n \\"indexVersions\\": [\\n {\\n \\"indexName\\": \\"test_api\\",\\n \\"versions\\": [\\n 1630353700\\n ],\\n \\"buildDeployId\\": \\"2648\\",\\n \\"currentVersion\\": 1\\n }\\n ]\\n }\\n}","type":"json"}]',
+ 'title' => 'GetIndexVersion',
+ 'description' => '## Method'."\n"
+ ."\n"
+ .' GET'."\n"
+ ."\n"
+ .'## URI'."\n"
+ ."\n"
+ .' /openapi/ha3/instances/{instanceId}/clusters/{clusterName}/index-version'."\n",
+ 'requestParamsDescription' => '## Examples'."\n"
+ ."\n"
+ .'Sample requests'."\n"
+ ."\n"
+ .' GET /openapi/ha3/instances/ha3_instance_id_1/clusters/cluster1/index-version'."\n",
+ 'responseParamsDescription' => '## Sample responses'."\n"
+ ."\n"
+ .'Success responses'."\n"
+ ."\n"
+ .' {'."\n"
+ .' "requestId": "e1eef569-1ff7-4bf8-acf7-1cecca9894ce",'."\n"
+ .' "result": {'."\n"
+ .' "cluster": "ea119cloud",'."\n"
+ .' "indexVersions": ['."\n"
+ .' {'."\n"
+ .' "versions": ['."\n"
+ .' 1630527077,'."\n"
+ .' 1630440554'."\n"
+ .' ],'."\n"
+ .' "currentVersion":1630527077,'."\n"
+ .' "indexName": "ihome_lapp_content_filter_param_index",'."\n"
+ .' "buildDeployId": "2837"'."\n"
+ .' },'."\n"
+ .' {'."\n"
+ .' "versions": ['."\n"
+ .' 1630353700'."\n"
+ .' ],'."\n"
+ .' "currentVersion":1630353700, '."\n"
+ .' "indexName": "ihome_lapp_case_tab_filter",'."\n"
+ .' "buildDeployId": "2829"'."\n"
+ .' }'."\n"
+ .' ]'."\n"
+ .' }'."\n"
+ .' }'."\n",
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetIndexVersion'],
+ ],
],
- 'schemes' => [
- 'http',
- 'https',
+ 'ramActions' => [
+ [
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'searchengine:GetIndexVersion',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SearchEngine', 'resourceType' => 'Instance', 'arn' => 'acs:searchengine:{#regionId}:{#accountId}:instance/{#InstanceId}'],
+ ],
+ ],
+ ],
],
+ ],
+ 'GetInstance' => [
+ 'summary' => 'Retrieves the details of an instance by its ID.',
+ 'path' => '/openapi/ha3/instances/{instanceId}',
+ 'methods' => ['get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
- 'operationType' => 'write',
+ 'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
- 'operationType' => 'delete',
- 'abilityTreeCode' => '139626',
- 'abilityTreeNodes' => [
- 'FEATUREopensearch95VJR4',
- ],
+ 'operationType' => 'get',
+ 'riskType' => 'none',
+ 'chargeType' => 'free',
+ 'abilityTreeCode' => '102489',
+ 'abilityTreeNodes' => ['FEATUREopensearch0AT3OG', 'FEATUREopensearchJB31XH'],
],
'parameters' => [
[
'name' => 'instanceId',
'in' => 'path',
- 'schema' => [
- 'description' => 'The instance ID.'."\n",
- 'type' => 'string',
- 'required' => true,
- 'example' => 'ha-cn-pl32rf0****',
- ],
- ],
- [
- 'name' => 'database',
- 'in' => 'path',
- 'schema' => [
- 'description' => 'database name',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'general',
- ],
- ],
- [
- 'name' => 'sqlInstanceId',
- 'in' => 'path',
- 'schema' => [
- 'description' => 'sqlInstanceId',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => true,
- 'example' => '1',
- ],
+ 'schema' => ['description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'ha-cn-pl32rf0****'],
],
],
'responses' => [
200 => [
'schema' => [
+ 'title' => '',
+ 'description' => 'The response schema.',
'type' => 'object',
'properties' => [
- 'requestId' => [
- 'title' => 'id of request',
- 'description' => 'id of request',
- 'type' => 'string',
- 'example' => '2AE63638-5420-56DC-BF59-37D8174039A0',
- ],
'result' => [
- 'title' => 'Response<Map<String, String>>',
- 'description' => 'Response<Map<String, String>>',
+ 'description' => 'The returned result.',
'type' => 'object',
'properties' => [
- 'result' => [
- 'description' => 'The result.'."\n",
+ 'description' => ['description' => 'The description of the instance.', 'type' => 'string', 'title' => '', 'example' => 'test'],
+ 'resourceGroupId' => ['description' => 'The resource group ID.', 'type' => 'string', 'title' => '', 'example' => 'rg-aekzjvw24****'],
+ 'expiredTime' => ['description' => 'The expiration time.', 'type' => 'string', 'title' => '', 'example' => '024-05-21 16:49:31.0'],
+ 'commodityCode' => ['description' => 'The commodity code.', 'type' => 'string', 'title' => '', 'example' => 'opensearch_ha3post_public_cn'],
+ 'instanceId' => ['description' => 'The instance ID.', 'type' => 'string', 'title' => '', 'example' => 'ha-cn-pl32rf0****'],
+ 'createTime' => ['description' => 'The time when the instance was created.', 'type' => 'string', 'title' => '', 'example' => '2022-06-17T02:01:26Z'],
+ 'lockMode' => ['description' => 'The lock status.', 'type' => 'string', 'title' => '', 'example' => 'Unlock'],
+ 'chargeType' => ['description' => 'The billing method.', 'type' => 'string', 'title' => '', 'example' => 'POSYPAY'],
+ 'updateTime' => ['description' => 'The time when the instance was last updated.', 'type' => 'string', 'title' => '', 'example' => '024-05-21 16:49:31.0'],
+ 'inDebt' => ['description' => 'Indicates whether the payment for the instance is overdue.', 'type' => 'boolean', 'title' => '', 'example' => 'false'],
+ 'status' => ['description' => 'The status of the instance.'."\n"
+ ."\n"
+ .'- INIT: The instance is being initialized.'."\n"
+ ."\n"
+ .'- WAIT\\_CONFIG: The instance is pending configuration.'."\n"
+ ."\n"
+ .'- CONFIG\\_UPDATING: The configuration is being applied.'."\n"
+ ."\n"
+ .'- READY: The instance is running.', 'type' => 'string', 'example' => 'INIT', 'title' => ''],
+ 'tags' => [
+ 'description' => 'The tags.',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'The tag.',
+ 'type' => 'object',
+ 'properties' => [
+ 'key' => ['description' => 'The tag key.', 'type' => 'string', 'example' => 'opensearch', 'title' => ''],
+ 'value' => ['description' => 'The tag value.', 'type' => 'string', 'example' => 'opensearch', 'title' => ''],
+ ],
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'edition' => ['description' => 'The edition of the instance. Valid values: - vector: Vector Search Edition - engine: Recall Engine Edition', 'type' => 'string', 'example' => 'vector', 'title' => ''],
+ 'userName' => ['description' => 'The username.', 'type' => 'string', 'example' => 'admin', 'title' => ''],
+ 'version' => ['description' => 'The engine version number.', 'type' => 'string', 'example' => 'ha3_3.10.0', 'title' => ''],
+ 'bsVersion' => ['description' => 'The BS version number.', 'type' => 'string', 'example' => 'bs_3.13.2', 'title' => ''],
+ 'noQrs' => ['description' => 'Indicates whether the instance is a standalone instance.', 'type' => 'boolean', 'example' => 'false', 'title' => ''],
+ 'newMode' => ['description' => 'Indicates whether the new version of the console is used.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
+ 'network' => [
+ 'description' => 'The network information of the search engine instance.',
'type' => 'object',
- 'additionalProperties' => [
- 'type' => 'string',
- 'example' => '{}',
- 'description' => 'The result.',
+ 'properties' => [
+ 'vSwitchId' => ['description' => 'The ID of the virtual switch.', 'type' => 'string', 'example' => 'vsw-bp11ldcf59q2n****'."\n", 'title' => ''],
+ 'vpcId' => ['description' => 'The ID of the VPC.', 'type' => 'string', 'example' => 'vpc-wz9axk41d9vff****'."\n", 'title' => ''],
+ 'endpoint' => ['description' => 'The gateway endpoint.', 'type' => 'string', 'example' => 'ha-cn-35t3r****.ha.aliyuncs.com'."\n", 'title' => ''],
+ 'publicEndpoint' => ['description' => 'The public domain name.', 'type' => 'string', 'example' => 'ha-cn-35t3ni****.public.ha.aliyuncs.com'."\n", 'title' => ''],
+ 'allow' => ['description' => 'The whitelist for the public domain name.', 'type' => 'string', 'example' => '127.0.0.1'."\n", 'title' => ''],
],
+ 'title' => '',
+ 'example' => '',
],
- 'requestId' => [
- 'description' => 'id of request'."\n",
- 'type' => 'string',
- 'example' => '2AE63638-5420-56DC-BF59-37D8174039A0',
+ 'spec' => [
+ 'description' => 'The node specifications.',
+ 'type' => 'object',
+ 'properties' => [
+ 'qrsResource' => [
+ 'description' => 'The specifications of the query node.',
+ 'type' => 'object',
+ 'properties' => [
+ 'category' => ['description' => 'The type of the instance. The value local\\_ssd indicates the local SSD type, and the value cloud indicates the disk type.', 'type' => 'string', 'example' => 'local_ssd', 'title' => ''],
+ 'cpu' => ['description' => 'The number of CPU cores.', 'type' => 'integer', 'format' => 'int32', 'example' => '2', 'title' => ''],
+ 'mem' => ['description' => 'The memory size in GB.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''],
+ 'disk' => ['description' => 'The storage space of the node in GB.', 'type' => 'integer', 'format' => 'int32', 'example' => '100', 'title' => ''],
+ 'nodeCount' => ['description' => 'The number of nodes.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''],
+ ],
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'searchResource' => [
+ 'description' => 'The specifications of the data node.',
+ 'type' => 'object',
+ 'properties' => [
+ 'category' => ['description' => 'The machine type. Valid values:', 'type' => 'string', 'example' => 'local_ssd', 'title' => ''],
+ 'cpu' => ['description' => 'The number of CPU cores.', 'type' => 'integer', 'format' => 'int32', 'example' => '2', 'title' => ''],
+ 'mem' => ['description' => 'The memory size in GB.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''],
+ 'disk' => ['description' => 'The storage space of the node in GB.', 'type' => 'integer', 'format' => 'int32', 'example' => '100', 'title' => ''],
+ 'nodeCount' => ['description' => 'The number of nodes.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''],
+ ],
+ 'title' => '',
+ 'example' => '',
+ ],
+ ],
+ 'title' => '',
+ 'example' => '',
],
+ 'zoneCount' => ['description' => 'The number of zones.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''],
],
+ 'title' => '',
+ 'example' => '',
],
+ 'requestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => 'E7B7D598-B080-5C8E-AA35-D43EC0D5F886'],
],
+ 'example' => '',
],
],
500 => [],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"2AE63638-5420-56DC-BF59-37D8174039A0\\",\\n \\"result\\": {\\n \\"result\\": {\\n \\"key\\": \\"{}\\"\\n },\\n \\"requestId\\": \\"2AE63638-5420-56DC-BF59-37D8174039A0\\"\\n }\\n}","type":"json"}]',
- 'title' => 'DeleteSqlInstance',
- ],
- 'ExecuteSqlInstance' => [
- 'path' => '/openapi/ha3/instances/{instanceId}/sql-studio/databases/{database}/sql-instances/{sqlInstanceId}/actions/execution',
- 'methods' => [
- 'post',
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"result\\": {\\n \\"description\\": \\"test\\",\\n \\"resourceGroupId\\": \\"rg-aekzjvw24****\\",\\n \\"expiredTime\\": \\"024-05-21 16:49:31.0\\",\\n \\"commodityCode\\": \\"opensearch_ha3post_public_cn\\",\\n \\"instanceId\\": \\"ha-cn-pl32rf0****\\",\\n \\"createTime\\": \\"2022-06-17T02:01:26Z\\",\\n \\"lockMode\\": \\"Unlock\\",\\n \\"chargeType\\": \\"POSYPAY\\",\\n \\"updateTime\\": \\"024-05-21 16:49:31.0\\",\\n \\"inDebt\\": false,\\n \\"status\\": \\"INIT\\",\\n \\"tags\\": [\\n {\\n \\"key\\": \\"opensearch\\",\\n \\"value\\": \\"opensearch\\"\\n }\\n ],\\n \\"edition\\": \\"vector\\",\\n \\"userName\\": \\"admin\\",\\n \\"version\\": \\"ha3_3.10.0\\",\\n \\"bsVersion\\": \\"bs_3.13.2\\",\\n \\"noQrs\\": false,\\n \\"newMode\\": true,\\n \\"network\\": {\\n \\"vSwitchId\\": \\"vsw-bp11ldcf59q2n****\\\\n\\",\\n \\"vpcId\\": \\"vpc-wz9axk41d9vff****\\\\n\\",\\n \\"endpoint\\": \\"ha-cn-35t3r****.ha.aliyuncs.com\\\\n\\",\\n \\"publicEndpoint\\": \\"ha-cn-35t3ni****.public.ha.aliyuncs.com\\\\n\\",\\n \\"allow\\": \\"127.0.0.1\\\\n\\"\\n },\\n \\"spec\\": {\\n \\"qrsResource\\": {\\n \\"category\\": \\"local_ssd\\",\\n \\"cpu\\": 2,\\n \\"mem\\": 10,\\n \\"disk\\": 100,\\n \\"nodeCount\\": 1\\n },\\n \\"searchResource\\": {\\n \\"category\\": \\"local_ssd\\",\\n \\"cpu\\": 2,\\n \\"mem\\": 10,\\n \\"disk\\": 100,\\n \\"nodeCount\\": 1\\n }\\n },\\n \\"zoneCount\\": 1\\n },\\n \\"requestId\\": \\"E7B7D598-B080-5C8E-AA35-D43EC0D5F886\\"\\n}","type":"json"}]',
+ 'title' => 'GetInstance',
+ 'description' => '### Method'."\n"
+ ."\n"
+ .'```java'."\n"
+ .'GET'."\n"
+ .'```'."\n"
+ ."\n"
+ .'### URI'."\n"
+ ."\n"
+ .'```java'."\n"
+ .'/openapi/ha3/instances/{instanceId}'."\n"
+ .'```',
+ 'requestParamsDescription' => '### Request example'."\n"
+ ."\n"
+ .'`GET /openapi/ha3/instances/ha3-cn-xxxxxx`',
+ 'responseParamsDescription' => '### Response examples'."\n"
+ ."\n"
+ .'**Successful response example**'."\n"
+ ."\n"
+ .'```'."\n"
+ .'{'."\n"
+ .' "result":'."\n"
+ .' {'."\n"
+ .' "inDebt": false,'."\n"
+ .' "lockMode": "Unlock",'."\n"
+ .' "trFreeUrl": "",'."\n"
+ .' "chargeType": "POSTPAY",'."\n"
+ .' "edition": "vector",'."\n"
+ .' "description": "ha-cn-vkl3rgrfc01",'."\n"
+ .' "updateTime": "2024-05-30 10:52:00.0",'."\n"
+ .' "userName": "admin",'."\n"
+ .' "version": "vector_service_1.2.2",'."\n"
+ .' "spec":'."\n"
+ .' {'."\n"
+ .' "qrsResource":'."\n"
+ .' {'."\n"
+ .' "category": "local_ssd",'."\n"
+ .' "cpu": 2,'."\n"
+ .' "mem": 8,'."\n"
+ .' "disk": 100,'."\n"
+ .' "nodeCount": 0'."\n"
+ .' },'."\n"
+ .' "searchResource":'."\n"
+ .' {'."\n"
+ .' "category": "local_ssd",'."\n"
+ .' "cpu": 2,'."\n"
+ .' "mem": 16,'."\n"
+ .' "disk": 100,'."\n"
+ .' "nodeCount": 1'."\n"
+ .' }'."\n"
+ .' },'."\n"
+ .' "network":'."\n"
+ .' {'."\n"
+ .' "vSwitchId": "vsw-bp16qw5mbrzx66lv4n0m2",'."\n"
+ .' "vpcId": "vpc-bp1956duqqe2lm2lvqjf1",'."\n"
+ .' "endpoint": "ha-cn-vkl3rgrfc01.ha.aliyuncs.com"'."\n"
+ .' },'."\n"
+ .' "tags":'."\n"
+ .' ['."\n"
+ .' {'."\n"
+ .' "value": "rg-acfmv2hk2jpsxia",'."\n"
+ .' "key": "acs:rm:rgId"'."\n"
+ .' }'."\n"
+ .' ],'."\n"
+ .' "noQrs": true,'."\n"
+ .' "instanceId": "ha-cn-vkl3rgrfc01",'."\n"
+ .' "createTime": "2024-05-30 10:50:33.0",'."\n"
+ .' "commodityCode": "opensearch_ha3post_public_cn",'."\n"
+ .' "resourceGroupId": "rg-acfmv2hk2jpsxia",'."\n"
+ .' "newMode": true,'."\n"
+ .' "status": "READY"'."\n"
+ .' },'."\n"
+ .' "requestId": "B916FBC8-DF19-1D12-A72F-61AFFDD871AD"'."\n"
+ .'}'."\n"
+ .'```'."\n"
+ ."\n"
+ .'**Error response example**'."\n"
+ ."\n"
+ .'```'."\n"
+ .'{'."\n"
+ .' "requestId": "BD1EA715-DF6F-06C2-004C-C1FA0D3A9820",'."\n"
+ .' "httpCode": 404,'."\n"
+ .' "code": "App.NotFound",'."\n"
+ .' "message": "App not found"'."\n"
+ .'}'."\n"
+ .'```',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetInstance'],
+ ],
],
- 'schemes' => [
- 'http',
- 'https',
+ 'ramActions' => [
+ [
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'searchengine:GetInstance',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SearchEngine', 'resourceType' => 'Instance', 'arn' => 'acs:searchengine:{#regionId}:{#accountId}:instance/{#InstanceId}'],
+ ],
+ ],
+ ],
],
+ ],
+ 'GetModel' => [
+ 'summary' => 'Queries the detailed configuration of a specific model by instance ID and model name.',
+ 'description' => '## Request description'."\n"
+ ."\n"
+ .'- This API retrieves the details of a specific model in an instance, such as its model type, URL, and status.'."\n"
+ ."\n"
+ .'- Ensure that the provided `instanceId` and `modelName` are valid. Otherwise, an error is returned or the resource cannot be found.'."\n"
+ ."\n"
+ .'- The response includes the model content, such as request headers and parameters. It also contains the creation and update times. This information helps you understand the model\'s configuration and its current status.',
+ 'path' => '/openapi/ha3/instances/{instanceId}/models/{modelName}',
+ 'methods' => ['get'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
- 'operationType' => 'write',
+ 'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
- 'operationType' => 'create',
- 'abilityTreeCode' => '139115',
- 'abilityTreeNodes' => [
- 'FEATUREopensearch95VJR4',
- ],
+ 'operationType' => 'get',
+ 'riskType' => 'none',
+ 'chargeType' => 'free',
+ 'abilityTreeNodes' => ['FEATUREopensearchGTRUN8'],
],
'parameters' => [
[
'name' => 'instanceId',
'in' => 'path',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'ha-cn-pl32rf0****',
- ],
- ],
- [
- 'name' => 'database',
- 'in' => 'path',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'general',
- ],
+ 'schema' => ['description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'example' => 'ha-cn-pl32rf0****', 'title' => ''],
],
[
- 'name' => 'sqlInstanceId',
+ 'name' => 'modelName',
'in' => 'path',
- 'schema' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => true,
- 'example' => '1',
- ],
- ],
- [
- 'name' => 'body',
- 'in' => 'body',
- 'style' => 'json',
- 'schema' => [
- 'description' => '',
- 'type' => 'object',
- 'properties' => [
- 'content' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'select * from test',
- ],
- 'kvpair' => [
- 'description' => '',
- 'type' => 'object',
- 'required' => false,
- 'additionalProperties' => [
- 'type' => 'any',
- 'example' => '{'."\n"
- .' "trace": "INFO",'."\n"
- .' "databaseName": "general",'."\n"
- .' "iquan.plan.cache.enable": true,'."\n"
- .' "iquan.plan.prepare.level": "jni.post.optimize",'."\n"
- .' "urlencode_data": false,'."\n"
- .' "formatType": "string",'."\n"
- .' "timeout": 1000'."\n"
- .' }',
- 'description' => '',
- ],
- ],
- 'dynamicParam' => [
- 'description' => '',
- 'type' => 'object',
- 'required' => false,
- 'additionalProperties' => [
- 'type' => 'any',
- 'description' => '',
- 'example' => '{}',
- ],
- ],
- 'staticParam' => [
- 'description' => '',
- 'type' => 'object',
- 'required' => false,
- 'additionalProperties' => [
- 'type' => 'any',
- 'example' => '{}',
- 'description' => '',
- ],
- ],
- 'domain' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'vpc_hz_domain_1',
- ],
- 'params' => [
- 'description' => '',
- 'type' => 'object',
- 'required' => false,
- 'additionalProperties' => [
- 'type' => 'any',
- 'description' => '',
- 'example' => '{}',
- ],
- ],
- 'combineParam' => [
- 'description' => '',
- 'type' => 'object',
- 'required' => false,
- 'additionalProperties' => [
- 'type' => 'any',
- 'example' => '{}',
- 'description' => '',
- ],
- ],
- ],
- 'required' => false,
- ],
+ 'schema' => ['description' => 'The model name.', 'type' => 'string', 'required' => true, 'example' => 'test', 'title' => ''],
],
],
'responses' => [
200 => [
+ 'description' => '查询成功',
'schema' => [
+ 'title' => '',
+ 'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
- 'requestId' => [
- 'title' => 'id of request',
- 'description' => 'id of request',
- 'type' => 'string',
- 'example' => 'FE03180A-0E29-5474-8A86-33F0683294A4',
- ],
+ 'requestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '38b079f1-7846-4226-8c90-3e2644b5c52b', 'title' => ''],
'result' => [
- 'title' => 'NodeVO',
- 'description' => 'NodeVO',
+ 'title' => '',
+ 'description' => 'The model configuration.',
'type' => 'object',
'properties' => [
- 'id' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '22',
- ],
- 'gmtCreate' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '1719221186114',
- ],
- 'gmtModified' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '1719220182844',
- ],
- 'name' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'test',
- ],
- 'parent' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '-1',
- ],
- 'isDir' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => 'true',
- ],
+ 'name' => ['description' => 'The model name.', 'type' => 'string', 'title' => '', 'example' => 'test'],
'type' => [
- 'title' => 'table, instance, template, function',
- 'description' => 'table, instance, template, function',
+ 'description' => 'The model type.'."\n"
+ ."\n"
+ .'- a. Text embedding: text\\_embedding'."\n"
+ ."\n"
+ .'- b. Text sparse embedding: text\\_sparse\\_embedding'."\n"
+ ."\n"
+ .'- c. Image embedding: image\\_embedding'."\n"
+ ."\n"
+ .'- d. Image content analysis: image\\_analyze',
+ 'enumValueTitles' => ['text_embedding' => 'Text embedding', 'image_embedding' => 'Image embedding', 'image_analyze' => 'Image content analysis', 'text_sparse_embedding' => 'Text sparse embedding'],
'type' => 'string',
- 'example' => 'instance',
+ 'enum' => ['text_embedding'],
+ 'title' => '',
+ 'example' => 'text_embedding',
],
- 'instanceId' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => 'ha-cn-pl32rf0****',
+ 'url' => ['description' => 'The model\'s access URL.', 'type' => 'string', 'title' => '', 'example' => 'http://***.platform-cn-shanghai.opensearch.aliyuncs.com/v3/openapi/workspaces/default/text-embedding/ops-text-embedding-001'],
+ 'status' => [
+ 'description' => 'The model status.'."\n"
+ ."\n"
+ .'- ok: Normal'."\n"
+ ."\n"
+ .'- error: Abnormal',
+ 'type' => 'string',
+ 'enum' => ['ok', 'error'],
+ 'title' => '',
+ 'example' => 'ok',
],
- 'templateId' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '1',
+ 'dimension' => ['description' => 'The model dimension.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '128'],
+ 'content' => [
+ 'title' => '',
+ 'description' => 'The model configuration.',
+ 'type' => 'object',
+ 'properties' => [
+ 'modelName' => ['description' => 'The model name.', 'type' => 'string', 'title' => '', 'example' => 'test'],
+ 'modelType' => [
+ 'description' => 'The model type.'."\n"
+ ."\n"
+ .'- a. Text embedding: text\\_embedding'."\n"
+ ."\n"
+ .'- b. Text sparse embedding: text\\_sparse\\_embedding'."\n"
+ ."\n"
+ .'- c. Image embedding: image\\_embedding'."\n"
+ ."\n"
+ .'- d. Image content analysis: image\\_analyze',
+ 'enumValueTitles' => [],
+ 'type' => 'string',
+ 'enum' => ['text_embedding'],
+ 'title' => '',
+ 'example' => 'text_embedding',
+ ],
+ 'url' => ['description' => 'The model service endpoint.', 'type' => 'string', 'title' => '', 'example' => 'http://***.platform-cn-shanghai.opensearch.aliyuncs.com/v3/openapi/workspaces/default/text-embedding/ops-text-embedding-001'],
+ 'method' => ['description' => 'The HTTP method to access the model service. PUT and POST are supported.', 'type' => 'string', 'title' => '', 'example' => 'POST'],
+ 'request' => [
+ 'title' => '',
+ 'description' => 'The request configuration.',
+ 'type' => 'object',
+ 'properties' => [
+ 'header' => [
+ 'title' => '',
+ 'description' => 'The HTTP request header.',
+ 'type' => 'object',
+ 'properties' => [
+ 'Authorization' => ['description' => 'Authentication information. The format is Bearer access\\_token.', 'type' => 'string', 'title' => '', 'example' => 'Bearer OS-v0********6vvs'."\n"],
+ 'Content-Type' => ['description' => 'The HTTP request\'s content type.', 'type' => 'string', 'title' => '', 'example' => 'application/json'."\n"],
+ ],
+ 'example' => '',
+ ],
+ 'urlParams' => [
+ 'title' => '',
+ 'description' => 'URL parameters. Some model services require you to pass parameters in the URL.',
+ 'type' => 'object',
+ 'properties' => [
+ 'build' => ['description' => 'Parameters passed during index building.', 'type' => 'object', 'example' => 'key: value'."\n", 'title' => ''],
+ 'search' => ['description' => 'Parameters passed during a query.', 'type' => 'object', 'example' => 'key: value', 'title' => ''],
+ ],
+ 'example' => '',
+ ],
+ 'requestBody' => ['description' => 'The request body\'s template string.', 'type' => 'string', 'title' => '', 'example' => '{\\"input\\": [\\"%{input}\\"], \\"input_type\\": \\"%{input_type}\\"}'."\n"],
+ 'parameters' => [
+ 'title' => '',
+ 'description' => 'Define parameters here if they differ between the build and search phases.',
+ 'type' => 'object',
+ 'properties' => [
+ 'build' => [
+ 'title' => '',
+ 'description' => 'Parameters for the index building phase.',
+ 'type' => 'object',
+ 'properties' => [
+ 'input_type' => [
+ 'description' => 'The input type.',
+ 'type' => 'string',
+ 'enum' => ['document'],
+ 'title' => '',
+ 'example' => 'query'."\n",
+ ],
+ ],
+ 'example' => '',
+ ],
+ 'search' => [
+ 'title' => '',
+ 'description' => 'Parameters for the query phase.',
+ 'type' => 'object',
+ 'properties' => [
+ 'input_type' => [
+ 'description' => 'The input type.',
+ 'type' => 'string',
+ 'enum' => ['query'],
+ 'title' => '',
+ 'example' => 'document'."\n",
+ ],
+ ],
+ 'example' => '',
+ ],
+ ],
+ 'example' => '',
+ ],
+ ],
+ 'example' => '',
+ ],
+ 'response' => [
+ 'description' => 'The method to parse the result. This is described in JSONPath format.',
+ 'type' => 'object',
+ 'properties' => [
+ 'embeddings' => ['description' => 'The method to parse the result. This is described in JSONPath format.', 'type' => 'string', 'example' => '$.result.embeddings[*].embedding'."\n", 'title' => ''],
+ ],
+ 'title' => '',
+ 'example' => '',
+ ],
+ ],
+ 'example' => '',
],
+ 'createTime' => ['description' => 'The creation time.', 'type' => 'string', 'title' => '', 'example' => '2024-05-21 16:05:26'],
+ 'updateTime' => ['description' => 'The update time.', 'type' => 'string', 'title' => '', 'example' => '2024-05-21 16:05:26'],
],
+ 'example' => '',
],
],
+ 'example' => '',
],
],
- 500 => [],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"FE03180A-0E29-5474-8A86-33F0683294A4\\",\\n \\"result\\": {\\n \\"id\\": 22,\\n \\"gmtCreate\\": \\"1719221186114\\",\\n \\"gmtModified\\": \\"1719220182844\\",\\n \\"name\\": \\"test\\",\\n \\"parent\\": -1,\\n \\"isDir\\": 0,\\n \\"type\\": \\"instance\\",\\n \\"instanceId\\": 0,\\n \\"templateId\\": 1\\n }\\n}","type":"json"}]',
- 'title' => 'ExecuteSqlInstance',
- 'summary' => 'Executes an SQL instance.',
- ],
- 'GetDatabaseSchema' => [
- 'path' => '/openapi/ha3/instances/{instanceId}/sql-studio/databases/{database}/tables/{tableName}/schema',
- 'methods' => [
- 'get',
- ],
- 'schemes' => [
- 'https',
- 'http',
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"38b079f1-7846-4226-8c90-3e2644b5c52b\\",\\n \\"result\\": {\\n \\"name\\": \\"test\\",\\n \\"type\\": \\"text_embedding\\",\\n \\"url\\": \\"http://***.platform-cn-shanghai.opensearch.aliyuncs.com/v3/openapi/workspaces/default/text-embedding/ops-text-embedding-001\\",\\n \\"status\\": \\"ok\\",\\n \\"dimension\\": 128,\\n \\"content\\": {\\n \\"modelName\\": \\"test\\",\\n \\"modelType\\": \\"text_embedding\\",\\n \\"url\\": \\"http://***.platform-cn-shanghai.opensearch.aliyuncs.com/v3/openapi/workspaces/default/text-embedding/ops-text-embedding-001\\",\\n \\"method\\": \\"POST\\",\\n \\"request\\": {\\n \\"header\\": {\\n \\"Authorization\\": \\"Bearer OS-v0********6vvs\\\\n\\",\\n \\"Content-Type\\": \\"application/json\\\\n\\"\\n },\\n \\"urlParams\\": {\\n \\"build\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n },\\n \\"search\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n }\\n },\\n \\"requestBody\\": \\"{\\\\\\\\\\\\\\"input\\\\\\\\\\\\\\": [\\\\\\\\\\\\\\"%{input}\\\\\\\\\\\\\\"], \\\\\\\\\\\\\\"input_type\\\\\\\\\\\\\\": \\\\\\\\\\\\\\"%{input_type}\\\\\\\\\\\\\\"}\\\\n\\",\\n \\"parameters\\": {\\n \\"build\\": {\\n \\"input_type\\": \\"query\\\\n\\"\\n },\\n \\"search\\": {\\n \\"input_type\\": \\"document\\\\n\\"\\n }\\n }\\n },\\n \\"response\\": {\\n \\"embeddings\\": \\"$.result.embeddings[*].embedding\\\\n\\"\\n }\\n },\\n \\"createTime\\": \\"2024-05-21 16:05:26\\",\\n \\"updateTime\\": \\"2024-05-21 16:05:26\\"\\n }\\n}","type":"json"}]',
+ 'title' => 'GetModel',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'searchengine:GetModel',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SearchEngine', 'resourceType' => 'Instance', 'arn' => 'acs:searchengine:{#regionId}:{#accountId}:instance/{#InstanceId}'],
+ ],
+ ],
+ ],
],
+ ],
+ 'GetNodeConfig' => [
+ 'path' => '/openapi/ha3/instances/{instanceId}/node-config',
+ 'methods' => ['get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
@@ -10645,37 +6702,34 @@
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
+ 'abilityTreeCode' => '104681',
+ 'abilityTreeNodes' => ['FEATUREopensearchIQC42D'],
],
'parameters' => [
[
'name' => 'instanceId',
'in' => 'path',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'ha-cn-pl32rf0****',
- ],
+ 'schema' => ['description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'example' => 'ha-cn-pl32rf0****', 'title' => ''],
],
[
- 'name' => 'database',
- 'in' => 'path',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'general',
- ],
+ 'name' => 'type',
+ 'in' => 'query',
+ 'schema' => ['title' => '', 'description' => 'The node type. Valid values:'."\n"
+ ."\n"
+ .'- qrs: query node'."\n"
+ .'- search: data node'."\n"
+ .'- index: index node'."\n"
+ .'- cluster: cluster.', 'type' => 'string', 'required' => false, 'example' => 'index'],
],
[
- 'name' => 'tableName',
- 'in' => 'path',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'graph_index_summary_',
- ],
+ 'name' => 'name',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The node name.', 'type' => 'string', 'required' => false, 'example' => 'ha-cn-30174dhoz53_qrs', 'title' => ''],
+ ],
+ [
+ 'name' => 'clusterName',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The cluster name.', 'type' => 'string', 'required' => false, 'example' => 'vpc_sh_domain_2', 'title' => ''],
],
],
'responses' => [
@@ -10683,66 +6737,98 @@
'schema' => [
'type' => 'object',
'properties' => [
- 'requestId' => [
- 'title' => 'id of request',
- 'description' => 'id of request',
- 'type' => 'string',
- 'example' => '022F36C7-9FB4-5D67-BEBC-3D14B0984463',
- ],
+ 'requestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '2AE63638-5420-56DC-BF59-37D8174039A0'],
'result' => [
- 'title' => 'List',
- 'description' => 'List',
- 'type' => 'array',
- 'items' => [
- 'description' => '',
- 'type' => 'object',
- 'properties' => [
- 'fieldName' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'id',
- ],
- 'fieldType' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'STRING',
- ],
- 'indexName' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'test_tusou_v2',
- ],
- 'indexType' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'NUMBER',
- ],
- 'fieldTypeDetail' => [
- 'description' => '',
- 'type' => 'object',
- 'example' => 'FT_UINT64',
- ],
- ],
+ 'title' => '',
+ 'description' => 'The returned result.',
+ 'type' => 'object',
+ 'properties' => [
+ 'dataFragmentNumber' => ['title' => '', 'description' => 'The number of data shards.', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
+ 'dataDuplicateNumber' => ['title' => '', 'description' => 'The number of data replicas.', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
+ 'minServicePercent' => ['title' => '', 'description' => 'The minimum service percentage.', 'type' => 'integer', 'format' => 'int32', 'example' => '50'],
+ 'published' => ['title' => '', 'description' => 'Indicates whether the cluster is mounted.', 'type' => 'boolean', 'example' => 'true'],
+ 'active' => ['title' => '', 'description' => 'Indicates whether the index is active online.', 'type' => 'boolean', 'example' => 'true'],
+ 'flowRatio' => ['description' => 'The traffic ratio.', 'type' => 'integer', 'format' => 'int32', 'example' => '100', 'title' => ''],
],
+ 'example' => '',
],
],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
],
500 => [],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"022F36C7-9FB4-5D67-BEBC-3D14B0984463\\",\\n \\"result\\": [\\n {\\n \\"fieldName\\": \\"id\\",\\n \\"fieldType\\": \\"STRING\\",\\n \\"indexName\\": \\"test_tusou_v2\\",\\n \\"indexType\\": \\"NUMBER\\",\\n \\"fieldTypeDetail\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n }\\n }\\n ]\\n}","type":"json"}]',
- 'title' => 'GetDatabaseSchema',
- 'summary' => 'Queries the schema of a database.',
+ 'title' => 'Retrieve node configuration information',
+ 'summary' => 'Retrieves the configuration information of a node.',
+ 'description' => '### Method'."\n"
+ ."\n"
+ .'```java'."\n"
+ .'GET'."\n"
+ .'```'."\n"
+ ."\n"
+ .'### URI'."\n"
+ ."\n"
+ .'```java'."\n"
+ .'/openapi/ha3/instances/{instanceId}/node-config'."\n"
+ .'```.',
+ 'requestParamsDescription' => '### Request example'."\n"
+ ."\n"
+ .'```java'."\n"
+ .'GET /openapi/ha3/instances/{instanceId}/node-config?type=qrs&name=test&'."\n"
+ .'```.',
+ 'responseParamsDescription' => "\n"
+ ."\n\n"
+ .'### Response example'."\n"
+ .'Successful response'."\n"
+ .''."\n"
+ .'```java'."\n"
+ .'{'."\n"
+ .''."\n"
+ .' "requestId": "0A6EB64B-B4C8-CF02-810F-E660812972FF",'."\n"
+ .''."\n"
+ .' "result": {'."\n"
+ .''."\n"
+ .' "dataFragmentNumber":1,'."\n"
+ .''."\n"
+ .' "dataDuplicateNumber":1,'."\n"
+ .''."\n"
+ .' "minServicePercent":20,'."\n"
+ .''."\n"
+ .' "published":true,'."\n"
+ .''."\n"
+ .' "active": true // Indicates whether the index is active online.'."\n"
+ .''."\n"
+ .' }'."\n"
+ .''."\n"
+ .'}'."\n"
+ .'```.',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetNodeConfig'],
+ ],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'searchengine:GetNodeConfig',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SearchEngine', 'resourceType' => 'Instance', 'arn' => 'acs:searchengine:{#regionId}:{#accountId}:instance/{#InstanceId}'],
+ ],
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"2AE63638-5420-56DC-BF59-37D8174039A0\\",\\n \\"result\\": {\\n \\"dataFragmentNumber\\": 1,\\n \\"dataDuplicateNumber\\": 1,\\n \\"minServicePercent\\": 50,\\n \\"published\\": true,\\n \\"active\\": true,\\n \\"flowRatio\\": 100\\n }\\n}","type":"json"}]',
],
'GetSqlInstance' => [
'path' => '/openapi/ha3/instances/{instanceId}/sql-studio/databases/{database}/sql-instances/{sqlInstanceId}',
- 'methods' => [
- 'get',
- ],
- 'schemes' => [
- 'https',
- 'http',
- ],
+ 'methods' => ['get'],
+ 'schemes' => ['https', 'http'],
'security' => [
[
'AK' => [],
@@ -10750,52 +6836,27 @@
],
'operationType' => 'read',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'get',
- ],
+ 'systemTags' => ['operationType' => 'get'],
'parameters' => [
[
'name' => 'instanceId',
'in' => 'path',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'ha-cn-pl32rf0****',
- ],
+ 'schema' => ['description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'example' => 'ha-cn-pl32rf0****', 'title' => ''],
],
[
'name' => 'database',
'in' => 'path',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'general',
- ],
+ 'schema' => ['description' => 'The database name.', 'type' => 'string', 'required' => true, 'example' => 'general', 'title' => ''],
],
[
'name' => 'sqlInstanceId',
'in' => 'path',
- 'schema' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => true,
- 'example' => '5978',
- ],
+ 'schema' => ['description' => 'The SQL instance ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '5978', 'title' => ''],
],
[
'name' => 'version',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => false,
- 'example' => '1',
- 'default' => '0',
- ],
+ 'schema' => ['description' => 'The instance version.', 'type' => 'integer', 'format' => 'int64', 'default' => '0', 'required' => false, 'example' => '1', 'title' => ''],
],
],
'responses' => [
@@ -10803,100 +6864,73 @@
'schema' => [
'type' => 'object',
'properties' => [
- 'requestId' => [
- 'title' => 'id of request',
- 'description' => 'id of request',
- 'type' => 'string',
- 'example' => '10D5E615-69F7-5F49-B850-00169ADE513C',
- ],
+ 'requestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '10D5E615-69F7-5F49-B850-00169ADE513C'],
'result' => [
- 'title' => 'InstanceVersionVO',
- 'description' => 'InstanceVersionVO',
+ 'title' => '',
+ 'description' => 'The returned result.',
'type' => 'object',
'properties' => [
- 'gmtCreate' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '1719220182844',
- ],
- 'gmtModified' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '1719221186114',
- ],
- 'instanceId' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => 'ha-cn-pl32rf0****',
- ],
- 'version' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '1',
- ],
- 'comment' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'init version',
- ],
- 'relatedTemplateId' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '1',
- ],
- 'content' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'select * from test',
- ],
- 'kvpairs' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '{\\"trace\\":\\"INFO\\",\\"databaseName\\":\\"general\\",\\"iquan.plan.cache.enable\\":true,\\"iquan.plan.prepare.level\\":\\"jni.post.optimize\\",\\"urlencode_data\\":false,\\"formatType\\":\\"string\\",\\"timeout\\":1000}',
- ],
- 'dynamicParams' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '{\\"trace\\":\\"INFO\\",\\"databaseName\\":\\"general\\",\\"iquan.plan.cache.enable\\":true,\\"iquan.plan.prepare.level\\":\\"jni.post.optimize\\",\\"urlencode_data\\":false,\\"formatType\\":\\"string\\",\\"timeout\\":1000}',
- ],
- 'templateParams' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '{\\"trace\\":\\"INFO\\",\\"databaseName\\":\\"general\\",\\"iquan.plan.cache.enable\\":true,\\"iquan.plan.prepare.level\\":\\"jni.post.optimize\\",\\"urlencode_data\\":false,\\"formatType\\":\\"string\\",\\"timeout\\":1000}',
- ],
- 'staticParams' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '{\\"trace\\":\\"INFO\\",\\"databaseName\\":\\"general\\",\\"iquan.plan.cache.enable\\":true,\\"iquan.plan.prepare.level\\":\\"jni.post.optimize\\",\\"urlencode_data\\":false,\\"formatType\\":\\"string\\",\\"timeout\\":1000}',
- ],
- 'combineParams' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '{\\"trace\\":\\"INFO\\",\\"databaseName\\":\\"general\\",\\"iquan.plan.cache.enable\\":true,\\"iquan.plan.prepare.level\\":\\"jni.post.optimize\\",\\"urlencode_data\\":false,\\"formatType\\":\\"string\\",\\"timeout\\":1000}',
- ],
+ 'gmtCreate' => ['description' => 'The creation time.', 'type' => 'string', 'example' => '1719220182844', 'title' => ''],
+ 'gmtModified' => ['description' => 'The modification time.', 'type' => 'string', 'example' => '1719221186114', 'title' => ''],
+ 'instanceId' => ['description' => 'The instance ID.', 'type' => 'integer', 'format' => 'int64', 'example' => 'ha-cn-pl32rf0****', 'title' => ''],
+ 'version' => ['description' => 'The version number.', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => ''],
+ 'comment' => ['description' => 'The remarks.', 'type' => 'string', 'example' => 'init version', 'title' => ''],
+ 'relatedTemplateId' => ['description' => 'The template ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => ''],
+ 'content' => ['description' => 'The SQL content.', 'type' => 'string', 'example' => 'select * from test', 'title' => ''],
+ 'kvpairs' => ['description' => 'The key-value pair parsing result.', 'type' => 'string', 'example' => '{\\"trace\\":\\"INFO\\",\\"databaseName\\":\\"general\\",\\"iquan.plan.cache.enable\\":true,\\"iquan.plan.prepare.level\\":\\"jni.post.optimize\\",\\"urlencode_data\\":false,\\"formatType\\":\\"string\\",\\"timeout\\":1000}', 'title' => ''],
+ 'dynamicParams' => ['description' => 'The dynamic extension parameters.', 'type' => 'string', 'example' => '{\\"trace\\":\\"INFO\\",\\"databaseName\\":\\"general\\",\\"iquan.plan.cache.enable\\":true,\\"iquan.plan.prepare.level\\":\\"jni.post.optimize\\",\\"urlencode_data\\":false,\\"formatType\\":\\"string\\",\\"timeout\\":1000}', 'title' => ''],
+ 'templateParams' => ['description' => 'The template parameters.', 'type' => 'string', 'example' => '{\\"trace\\":\\"INFO\\",\\"databaseName\\":\\"general\\",\\"iquan.plan.cache.enable\\":true,\\"iquan.plan.prepare.level\\":\\"jni.post.optimize\\",\\"urlencode_data\\":false,\\"formatType\\":\\"string\\",\\"timeout\\":1000}', 'title' => ''],
+ 'staticParams' => ['description' => 'The static parameters.', 'type' => 'string', 'example' => '{\\"trace\\":\\"INFO\\",\\"databaseName\\":\\"general\\",\\"iquan.plan.cache.enable\\":true,\\"iquan.plan.prepare.level\\":\\"jni.post.optimize\\",\\"urlencode_data\\":false,\\"formatType\\":\\"string\\",\\"timeout\\":1000}', 'title' => ''],
+ 'combineParams' => ['description' => 'The combined parameters.', 'type' => 'string', 'example' => '{\\"trace\\":\\"INFO\\",\\"databaseName\\":\\"general\\",\\"iquan.plan.cache.enable\\":true,\\"iquan.plan.prepare.level\\":\\"jni.post.optimize\\",\\"urlencode_data\\":false,\\"formatType\\":\\"string\\",\\"timeout\\":1000}', 'title' => ''],
],
+ 'example' => '',
],
],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
],
500 => [],
],
+ 'title' => 'Retrieve SQL instance information',
+ 'summary' => 'Retrieves SQL instance information.',
+ 'description' => '### Method'."\n"
+ ."\n"
+ .'```java'."\n"
+ .'GET'."\n"
+ .'```'."\n"
+ ."\n"
+ .'### URI'."\n"
+ ."\n"
+ .'```java'."\n"
+ .'/openapi/ha3/instances/{instanceId}/sql-studio/databases/{database}/sql-instances/{sqlInstanceId}'."\n"
+ .'```.',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetSqlInstance'],
+ ],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'searchengine:GetSqlInstance',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SearchEngine', 'resourceType' => 'Instance', 'arn' => 'acs:searchengine:{#regionId}:{#accountId}:instance/{#instanceId}'],
+ ],
+ ],
+ ],
+ ],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"10D5E615-69F7-5F49-B850-00169ADE513C\\",\\n \\"result\\": {\\n \\"gmtCreate\\": \\"1719220182844\\",\\n \\"gmtModified\\": \\"1719221186114\\",\\n \\"instanceId\\": 0,\\n \\"version\\": 1,\\n \\"comment\\": \\"init version\\",\\n \\"relatedTemplateId\\": 1,\\n \\"content\\": \\"select * from test\\",\\n \\"kvpairs\\": \\"{\\\\\\\\\\\\\\"trace\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"INFO\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"databaseName\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"general\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"iquan.plan.cache.enable\\\\\\\\\\\\\\":true,\\\\\\\\\\\\\\"iquan.plan.prepare.level\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"jni.post.optimize\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"urlencode_data\\\\\\\\\\\\\\":false,\\\\\\\\\\\\\\"formatType\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"string\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"timeout\\\\\\\\\\\\\\":1000}\\",\\n \\"dynamicParams\\": \\"{\\\\\\\\\\\\\\"trace\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"INFO\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"databaseName\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"general\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"iquan.plan.cache.enable\\\\\\\\\\\\\\":true,\\\\\\\\\\\\\\"iquan.plan.prepare.level\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"jni.post.optimize\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"urlencode_data\\\\\\\\\\\\\\":false,\\\\\\\\\\\\\\"formatType\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"string\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"timeout\\\\\\\\\\\\\\":1000}\\",\\n \\"templateParams\\": \\"{\\\\\\\\\\\\\\"trace\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"INFO\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"databaseName\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"general\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"iquan.plan.cache.enable\\\\\\\\\\\\\\":true,\\\\\\\\\\\\\\"iquan.plan.prepare.level\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"jni.post.optimize\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"urlencode_data\\\\\\\\\\\\\\":false,\\\\\\\\\\\\\\"formatType\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"string\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"timeout\\\\\\\\\\\\\\":1000}\\",\\n \\"staticParams\\": \\"{\\\\\\\\\\\\\\"trace\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"INFO\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"databaseName\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"general\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"iquan.plan.cache.enable\\\\\\\\\\\\\\":true,\\\\\\\\\\\\\\"iquan.plan.prepare.level\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"jni.post.optimize\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"urlencode_data\\\\\\\\\\\\\\":false,\\\\\\\\\\\\\\"formatType\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"string\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"timeout\\\\\\\\\\\\\\":1000}\\",\\n \\"combineParams\\": \\"{\\\\\\\\\\\\\\"trace\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"INFO\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"databaseName\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"general\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"iquan.plan.cache.enable\\\\\\\\\\\\\\":true,\\\\\\\\\\\\\\"iquan.plan.prepare.level\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"jni.post.optimize\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"urlencode_data\\\\\\\\\\\\\\":false,\\\\\\\\\\\\\\"formatType\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"string\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"timeout\\\\\\\\\\\\\\":1000}\\"\\n }\\n}","type":"json"}]',
- 'title' => 'GetSqlInstance',
- 'summary' => 'Queries the information about an SQL instance.',
],
- 'ListDatabases' => [
- 'path' => '/openapi/ha3/instances/{instanceId}/sql-studio/databases',
- 'methods' => [
- 'get',
- ],
- 'schemes' => [
- 'https',
- 'http',
- ],
+ 'GetTable' => [
+ 'path' => '/openapi/ha3/instances/{instanceId}/tables/{tableName}',
+ 'methods' => ['get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
@@ -10905,18 +6939,20 @@
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
- 'operationType' => 'list',
+ 'operationType' => 'get',
+ 'abilityTreeCode' => '218774',
+ 'abilityTreeNodes' => ['FEATUREopensearchGTRUN8'],
],
'parameters' => [
[
'name' => 'instanceId',
'in' => 'path',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'ha-cn-pl32rf0****',
- ],
+ 'schema' => ['description' => 'Instance ID', 'type' => 'string', 'required' => true, 'example' => 'ha-cn-pl32rf0****', 'title' => ''],
+ ],
+ [
+ 'name' => 'tableName',
+ 'in' => 'path',
+ 'schema' => ['description' => 'Index table name', 'type' => 'string', 'required' => true, 'example' => 'test_summary', 'title' => ''],
],
],
'responses' => [
@@ -10924,319 +6960,219 @@
'schema' => [
'type' => 'object',
'properties' => [
- 'requestId' => [
- 'title' => 'id of request',
- 'description' => 'id of request',
- 'type' => 'string',
- 'example' => 'E45380E8-994A-5402-9806-F114B3295FCF',
- ],
+ 'requestId' => ['title' => '', 'description' => 'Request ID.', 'type' => 'string', 'example' => '2AE63638-5420-56DC-BF59-37D8174039A0'],
'result' => [
- 'title' => 'NodeTreeVO',
- 'description' => 'NodeTreeVO',
+ 'title' => '',
+ 'description' => 'Response result',
'type' => 'object',
'properties' => [
- 'databases' => [
- 'description' => '',
+ 'name' => ['title' => '', 'description' => 'Index name', 'type' => 'string', 'example' => 'test_oss'],
+ 'status' => ['title' => '', 'description' => 'Index table status (NEW, PUBLISH, IN_USE: normal status after the recall engine version is created successfully, NOT_USE, STOP_USE, RESTORE_USE, FAIL: status when a new version of the vector retrieval version fails to create an index for the first time)', 'type' => 'string', 'example' => 'IN_USE'],
+ 'dataProcessorCount' => ['title' => '', 'description' => 'Number of data update resources', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
+ 'partitionCount' => ['title' => '', 'description' => 'Number of data shards', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
+ 'dataSource' => [
+ 'title' => '',
+ 'description' => 'Data source configuration',
+ 'type' => 'object',
+ 'properties' => [
+ 'type' => ['title' => '', 'description' => 'Data source type: only supports three types: odps, swift, and oss (odps, swift, saro, oss, unKnow)', 'type' => 'string', 'example' => 'odps'],
+ 'dataTimeSec' => ['title' => '', 'description' => 'Incremental data timestamp', 'type' => 'integer', 'format' => 'int32', 'example' => '1715160176'],
+ 'autoBuildIndex' => ['title' => '', 'description' => 'Whether to automatically rebuild the index', 'type' => 'boolean', 'example' => 'true'],
+ 'config' => [
+ 'title' => '',
+ 'description' => 'Data source configuration',
+ 'type' => 'object',
+ 'properties' => [
+ 'endpoint' => ['title' => '', 'description' => 'ODPS-related', 'type' => 'string', 'example' => 'http://service.cn-hangzhou.maxcompute.aliyun-inc.com/api'],
+ 'accessKey' => ['description' => 'AK', 'type' => 'string', 'example' => 'ak', 'title' => ''],
+ 'accessSecret' => ['description' => 'AS', 'type' => 'string', 'example' => 'as', 'title' => ''],
+ 'project' => ['description' => 'ODPS data source project name', 'type' => 'string', 'example' => 'dp_pdm_marketing_prod', 'title' => ''],
+ 'partition' => ['description' => 'Partition information', 'type' => 'string', 'example' => 'ds=20220808', 'title' => ''],
+ 'table' => ['title' => '', 'description' => 'saro/ODPS data source table name', 'type' => 'string', 'example' => 'test_add'],
+ 'namespace' => ['title' => '', 'description' => 'saro-related', 'type' => 'string', 'example' => 'namespace'],
+ 'path' => ['title' => '', 'description' => 'HDFS-related', 'type' => 'string', 'example' => 'vendor/sebastian/comparator/src/exceptions'],
+ 'ossPath' => ['title' => '', 'description' => 'OSS file path', 'type' => 'string', 'example' => '/opensearch_index_data/sift_oss_test.data'],
+ 'bucket' => ['description' => 'OSS namespace', 'type' => 'string', 'example' => 'heytea-ops-oss', 'title' => ''],
+ ],
+ 'example' => '',
+ ],
+ ],
+ 'example' => '',
+ ],
+ 'rawSchema' => ['title' => '', 'description' => 'If the user provides rawSchema, it is used directly as the HA3 schema structure without manual assembly', 'type' => 'string', 'example' => '{}'],
+ 'primaryKey' => ['title' => '', 'description' => 'Primary key field', 'type' => 'string', 'example' => 'id'],
+ 'fieldSchema' => [
+ 'title' => '',
+ 'description' => 'Field map collection, key: field name, value: field type',
+ 'type' => 'object',
+ 'additionalProperties' => ['description' => 'id', 'type' => 'string', 'example' => 'INT64', 'title' => ''],
+ 'example' => '',
+ ],
+ 'vectorIndex' => [
+ 'title' => '',
+ 'description' => 'Index structure',
'type' => 'array',
'items' => [
- 'description' => '',
'type' => 'object',
'properties' => [
- 'database' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'general',
- ],
- 'sqlInstances' => [
- 'description' => '',
- 'type' => 'array',
- 'items' => [
- 'description' => '',
- 'type' => 'object',
- 'properties' => [
- 'id' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '12190',
- ],
- 'name' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'general',
- ],
- 'type' => [
- 'title' => 'table, instance, template, function',
- 'description' => 'table, instance, template, function',
- 'type' => 'string',
- 'example' => 'instance',
- ],
- 'parent' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '-1',
- ],
- 'children' => [
- 'description' => '',
- 'type' => 'array',
- 'items' => [
- 'description' => '',
- 'type' => 'any',
- 'example' => '1',
- ],
- ],
- 'isDir' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => 'true',
- ],
- 'instanceId' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '1',
- ],
- 'templateId' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '1',
- ],
- ],
- ],
- ],
- 'templates' => [
- 'description' => '',
- 'type' => 'array',
- 'items' => [
- 'description' => '',
- 'type' => 'object',
- 'properties' => [
- 'id' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '1',
- ],
- 'name' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'c26_schema',
- ],
- 'type' => [
- 'title' => 'table, instance, template, function',
- 'description' => 'table, instance, template, function',
- 'type' => 'string',
- 'example' => 'template',
- ],
- 'parent' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '-1',
- ],
- 'children' => [
- 'description' => '',
- 'type' => 'array',
- 'items' => [
- 'description' => '',
- 'type' => 'any',
- 'example' => '1',
- ],
- ],
- 'isDir' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => 'true',
- ],
- 'instanceId' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '1',
- ],
- 'templateId' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '1',
- ],
- ],
+ 'indexName' => ['title' => '', 'description' => 'Index structure name', 'type' => 'string', 'example' => 'test_odps'],
+ 'vectorField' => ['title' => '', 'description' => 'Vector field', 'type' => 'string', 'example' => 'source_image_vector'],
+ 'sparseIndexField' => ['title' => '', 'description' => 'Sparse vector index field', 'type' => 'string', 'example' => 'sparse_indices'],
+ 'sparseValueField' => ['title' => '', 'description' => 'Sparse vector value field', 'type' => 'string', 'example' => 'sparse_values'],
+ 'dimension' => ['title' => '', 'description' => 'Vector dimension', 'type' => 'string', 'example' => '128'],
+ 'vectorIndexType' => ['title' => '', 'description' => 'Vector index algorithm', 'type' => 'string', 'example' => 'Qc'],
+ 'distanceType' => ['title' => '', 'description' => 'Distance type', 'type' => 'string', 'example' => 'SquaredEuclidean'],
+ 'namespace' => ['title' => '', 'description' => 'Namespace field', 'type' => 'string', 'example' => 'namespace'],
+ 'advanceParams' => [
+ 'title' => '',
+ 'description' => 'Index structure configuration',
+ 'type' => 'object',
+ 'properties' => [
+ 'buildIndexParams' => ['title' => '', 'description' => 'Index building parameters', 'type' => 'string', 'example' => '{'."\n"
+ .' "proxima.qc.builder.quantizer_class": "Int8QuantizerConverter",'."\n"
+ .' "proxima.qc.builder.quantize_by_centroid": true,'."\n"
+ .' "proxima.qc.builder.optimizer_class": "BruteForceBuilder",'."\n"
+ .' "proxima.qc.builder.thread_count": 10,'."\n"
+ .' "proxima.qc.builder.optimizer_params": {'."\n"
+ .' "proxima.linear.builder.column_major_order": true'."\n"
+ .' },'."\n"
+ .' "proxima.qc.builder.store_original_features": false,'."\n"
+ .' "proxima.qc.builder.train_sample_count": 3000000,'."\n"
+ .' "proxima.qc.builder.train_sample_ratio": 0.5'."\n"
+ .'}'],
+ 'searchIndexParams' => ['title' => '', 'description' => 'Index search parameters', 'type' => 'string', 'example' => '{"proxima.qc.searcher.scan_ratio":0.01}'],
+ 'minScanDocCnt' => ['title' => '', 'description' => 'Minimum number of recall candidates', 'type' => 'string', 'example' => '20000'],
+ 'linearBuildThreshold' => ['title' => '', 'description' => 'Linear build threshold', 'type' => 'string', 'example' => '5000'],
],
+ 'example' => '',
],
- 'functions' => [
- 'description' => '',
+ ],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'example' => '',
+ ],
+ 'dataProcessConfig' => [
+ 'title' => '',
+ 'description' => 'Field processing configuration',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'Field processing configuration',
+ 'type' => 'object',
+ 'properties' => [
+ 'operator' => ['title' => '', 'description' => 'Field processing method (copy: copies the source field to the target field, vectorize: vectorizes the source field using a model and stores the vector in the target field)', 'type' => 'string', 'example' => 'vectorize'],
+ 'dstField' => ['title' => '', 'description' => 'Target field', 'type' => 'string', 'example' => 'source_image_vector'],
+ 'srcField' => ['title' => '', 'description' => 'Source field', 'type' => 'string', 'example' => 'source_image'],
+ 'params' => [
+ 'title' => '',
+ 'description' => 'Model configuration information',
'type' => 'object',
- 'additionalProperties' => [
- 'type' => 'array',
- 'items' => [
+ 'properties' => [
+ 'vectorModel' => ['title' => '', 'description' => 'Vectorization model', 'type' => 'string', 'example' => 'clip'],
+ 'vectorModal' => ['title' => '', 'description' => 'Data type', 'type' => 'string', 'example' => 'image'],
+ 'srcFieldConfig' => [
+ 'title' => '',
+ 'description' => 'Vectorization information source',
'type' => 'object',
'properties' => [
- 'name' => [
- 'type' => 'string',
- 'example' => 'test',
- 'description' => '',
- ],
- 'signatures' => [
- 'type' => 'string',
- 'description' => '',
- 'example' => 'gfasdds2****2wfrkv',
- ],
- ],
- 'description' => '',
- ],
- 'description' => '',
- ],
- ],
- 'tables' => [
- 'description' => '',
- 'type' => 'array',
- 'items' => [
- 'description' => '',
- 'type' => 'object',
- 'properties' => [
- 'id' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '56',
- ],
- 'name' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'general',
- ],
- 'type' => [
- 'title' => 'table, instance, template, function',
- 'description' => 'table, instance, template, function',
- 'type' => 'string',
- 'example' => 'table',
- ],
- 'parent' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '-1',
- ],
- 'children' => [
- 'description' => '',
- 'type' => 'array',
- 'items' => [
- 'description' => '',
- 'type' => 'any',
- 'example' => '1',
- ],
- ],
- 'isDir' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => 'true',
- ],
- 'instanceId' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '1',
- ],
- 'templateId' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '1',
+ 'ossEndpoint' => ['description' => 'OSS region endpoint.', 'type' => 'string', 'example' => 'oss-cn-hangzhou-internal.aliyuncs.com'."\n", 'title' => ''],
+ 'ossBucket' => ['description' => 'OSS Bucket', 'type' => 'string', 'example' => 'test', 'title' => ''],
+ 'uid' => ['description' => 'Cloud account ID', 'type' => 'string', 'example' => 'uid', 'title' => ''],
],
+ 'example' => '',
],
],
+ 'example' => '',
],
],
+ 'title' => '',
+ 'example' => '',
],
+ 'example' => '',
],
],
+ 'example' => '',
],
],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
],
500 => [],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"E45380E8-994A-5402-9806-F114B3295FCF\\",\\n \\"result\\": {\\n \\"databases\\": [\\n {\\n \\"database\\": \\"general\\",\\n \\"sqlInstances\\": [\\n {\\n \\"id\\": 12190,\\n \\"name\\": \\"general\\",\\n \\"type\\": \\"instance\\",\\n \\"parent\\": -1,\\n \\"children\\": [\\n \\"1\\"\\n ],\\n \\"isDir\\": 0,\\n \\"instanceId\\": 1,\\n \\"templateId\\": 1\\n }\\n ],\\n \\"templates\\": [\\n {\\n \\"id\\": 1,\\n \\"name\\": \\"c26_schema\\",\\n \\"type\\": \\"template\\",\\n \\"parent\\": -1,\\n \\"children\\": [\\n \\"1\\"\\n ],\\n \\"isDir\\": 0,\\n \\"instanceId\\": 1,\\n \\"templateId\\": 1\\n }\\n ],\\n \\"functions\\": {\\n \\"key\\": [\\n {\\n \\"name\\": \\"test\\",\\n \\"signatures\\": \\"gfasdds2****2wfrkv\\"\\n }\\n ]\\n },\\n \\"tables\\": [\\n {\\n \\"id\\": 56,\\n \\"name\\": \\"general\\",\\n \\"type\\": \\"table\\",\\n \\"parent\\": -1,\\n \\"children\\": [\\n \\"1\\"\\n ],\\n \\"isDir\\": 0,\\n \\"instanceId\\": 1,\\n \\"templateId\\": 1\\n }\\n ]\\n }\\n ]\\n }\\n}","type":"json"}]',
- 'title' => 'ListDatabases',
- 'summary' => 'Queries a list of databases.',
- ],
- 'UpdateSqlInstanceContent' => [
- 'path' => '/openapi/ha3/instances/{instanceId}/sql-studio/databases/{database}/sql-instances/{sqlInstanceId}/content',
- 'methods' => [
- 'put',
- ],
- 'schemes' => [
- 'http',
- 'https',
+ 'title' => 'Get Index Table Information',
+ 'summary' => 'Get index table information.',
+ 'description' => '### Method'."\n"
+ ."\n"
+ .'```java'."\n"
+ .'GET'."\n"
+ .'```'."\n"
+ ."\n"
+ .'### URI'."\n"
+ ."\n"
+ .'```java'."\n"
+ .'/openapi/ha3/instances/{instanceId}/tables/{tableName}'."\n"
+ .'```',
+ 'requestParamsDescription' => '### Request Example'."\n"
+ ."\n"
+ .''."\n"
+ ."\n"
+ .'```java'."\n"
+ .'GET /openapi/ha3/instances/{instanceId}/tables/{tableName}'."\n"
+ .'```',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'searchengine:GetTable',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SearchEngine', 'resourceType' => 'Instance', 'arn' => 'acs:searchengine:{#regionId}:{#accountId}:instance/{#InstanceId}'],
+ ],
+ ],
+ ],
],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"2AE63638-5420-56DC-BF59-37D8174039A0\\",\\n \\"result\\": {\\n \\"name\\": \\"test_oss\\",\\n \\"status\\": \\"IN_USE\\",\\n \\"dataProcessorCount\\": 1,\\n \\"partitionCount\\": 1,\\n \\"dataSource\\": {\\n \\"type\\": \\"odps\\",\\n \\"dataTimeSec\\": 1715160176,\\n \\"autoBuildIndex\\": true,\\n \\"config\\": {\\n \\"endpoint\\": \\"http://service.cn-hangzhou.maxcompute.aliyun-inc.com/api\\",\\n \\"accessKey\\": \\"ak\\",\\n \\"accessSecret\\": \\"as\\",\\n \\"project\\": \\"dp_pdm_marketing_prod\\",\\n \\"partition\\": \\"ds=20220808\\",\\n \\"table\\": \\"test_add\\",\\n \\"namespace\\": \\"namespace\\",\\n \\"path\\": \\"vendor/sebastian/comparator/src/exceptions\\",\\n \\"ossPath\\": \\"/opensearch_index_data/sift_oss_test.data\\",\\n \\"bucket\\": \\"heytea-ops-oss\\"\\n }\\n },\\n \\"rawSchema\\": \\"{}\\",\\n \\"primaryKey\\": \\"id\\",\\n \\"fieldSchema\\": {\\n \\"key\\": \\"INT64\\"\\n },\\n \\"vectorIndex\\": [\\n {\\n \\"indexName\\": \\"test_odps\\",\\n \\"vectorField\\": \\"source_image_vector\\",\\n \\"sparseIndexField\\": \\"sparse_indices\\",\\n \\"sparseValueField\\": \\"sparse_values\\",\\n \\"dimension\\": \\"128\\",\\n \\"vectorIndexType\\": \\"Qc\\",\\n \\"distanceType\\": \\"SquaredEuclidean\\",\\n \\"namespace\\": \\"namespace\\",\\n \\"advanceParams\\": {\\n \\"buildIndexParams\\": \\"{\\\\n \\\\\\"proxima.qc.builder.quantizer_class\\\\\\": \\\\\\"Int8QuantizerConverter\\\\\\",\\\\n \\\\\\"proxima.qc.builder.quantize_by_centroid\\\\\\": true,\\\\n \\\\\\"proxima.qc.builder.optimizer_class\\\\\\": \\\\\\"BruteForceBuilder\\\\\\",\\\\n \\\\\\"proxima.qc.builder.thread_count\\\\\\": 10,\\\\n \\\\\\"proxima.qc.builder.optimizer_params\\\\\\": {\\\\n \\\\\\"proxima.linear.builder.column_major_order\\\\\\": true\\\\n },\\\\n \\\\\\"proxima.qc.builder.store_original_features\\\\\\": false,\\\\n \\\\\\"proxima.qc.builder.train_sample_count\\\\\\": 3000000,\\\\n \\\\\\"proxima.qc.builder.train_sample_ratio\\\\\\": 0.5\\\\n}\\",\\n \\"searchIndexParams\\": \\"{\\\\\\"proxima.qc.searcher.scan_ratio\\\\\\":0.01}\\",\\n \\"minScanDocCnt\\": \\"20000\\",\\n \\"linearBuildThreshold\\": \\"5000\\"\\n }\\n }\\n ],\\n \\"dataProcessConfig\\": [\\n {\\n \\"operator\\": \\"vectorize\\",\\n \\"dstField\\": \\"source_image_vector\\",\\n \\"srcField\\": \\"source_image\\",\\n \\"params\\": {\\n \\"vectorModel\\": \\"clip\\",\\n \\"vectorModal\\": \\"image\\",\\n \\"srcFieldConfig\\": {\\n \\"ossEndpoint\\": \\"oss-cn-hangzhou-internal.aliyuncs.com\\\\n\\",\\n \\"ossBucket\\": \\"test\\",\\n \\"uid\\": \\"uid\\"\\n }\\n }\\n }\\n ]\\n }\\n}","type":"json"}]',
+ ],
+ 'GetTableGeneration' => [
+ 'summary' => 'Queries the status of an index version based on the ID of the full index version.',
+ 'path' => '/openapi/ha3/instances/{instanceId}/tables/{tableName}/index_versions/{generationId}',
+ 'methods' => ['get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
- 'operationType' => 'write',
+ 'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
- 'operationType' => 'update',
- 'abilityTreeCode' => '139112',
- 'abilityTreeNodes' => [
- 'FEATUREopensearch95VJR4',
- ],
+ 'operationType' => 'get',
+ 'abilityTreeCode' => '218780',
+ 'abilityTreeNodes' => ['FEATUREopensearchGTRUN8'],
],
'parameters' => [
[
'name' => 'instanceId',
'in' => 'path',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'ha-cn-pl32rf0****',
- ],
+ 'schema' => ['description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'example' => 'ha-cn-pl32rf0****', 'title' => ''],
],
[
- 'name' => 'database',
+ 'name' => 'tableName',
'in' => 'path',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'general',
- ],
+ 'schema' => ['description' => 'The name of the table.', 'type' => 'string', 'required' => true, 'example' => 'test_summary', 'title' => ''],
],
[
- 'name' => 'sqlInstanceId',
+ 'name' => 'generationId',
'in' => 'path',
- 'schema' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => true,
- 'example' => '5975',
- ],
- ],
- [
- 'name' => 'body',
- 'in' => 'body',
- 'style' => 'json',
- 'schema' => [
- 'description' => '',
- 'type' => 'object',
- 'properties' => [
- 'content' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'select * from test',
- ],
- ],
- 'required' => false,
- ],
+ 'schema' => ['description' => 'The ID of the full index version.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1708674867', 'title' => ''],
],
],
'responses' => [
@@ -11244,163 +7180,88 @@
'schema' => [
'type' => 'object',
'properties' => [
- 'requestId' => [
- 'title' => 'id of request',
- 'description' => 'id of request',
- 'type' => 'string',
- 'example' => 'E45380E8-994A-5402-9806-F114B3295FCF',
- ],
+ 'requestId' => ['title' => '', 'description' => 'requestId', 'type' => 'string', 'example' => 'E7B7D598-B080-5C8E-AA35-D43EC0D5F886'],
'result' => [
- 'title' => 'InstanceVersionVO',
- 'description' => 'InstanceVersionVO',
+ 'title' => '',
+ 'description' => 'The result returned.',
'type' => 'object',
'properties' => [
- 'gmtCreate' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '1719221186114',
- ],
- 'gmtModified' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '1719221186114',
- ],
- 'instanceId' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '1',
- ],
- 'version' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '1',
- ],
- 'comment' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '',
- ],
- 'relatedTemplateId' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '1',
- ],
- 'content' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'select * from test',
- ],
- 'kvpairs' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '{\\"trace\\":\\"INFO\\",\\"databaseName\\":\\"general\\",\\"iquan.plan.cache.enable\\":true,\\"iquan.plan.prepare.level\\":\\"jni.post.optimize\\",\\"urlencode_data\\":false,\\"formatType\\":\\"string\\",\\"timeout\\":1000}',
- ],
- 'dynamicParams' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '{\\"trace\\":\\"INFO\\",\\"databaseName\\":\\"general\\",\\"iquan.plan.cache.enable\\":true,\\"iquan.plan.prepare.level\\":\\"jni.post.optimize\\",\\"urlencode_data\\":false,\\"formatType\\":\\"string\\",\\"timeout\\":1000}',
- ],
- 'templateParams' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '{\\"trace\\":\\"INFO\\",\\"databaseName\\":\\"general\\",\\"iquan.plan.cache.enable\\":true,\\"iquan.plan.prepare.level\\":\\"jni.post.optimize\\",\\"urlencode_data\\":false,\\"formatType\\":\\"string\\",\\"timeout\\":1000}',
- ],
- 'staticParams' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '{\\"trace\\":\\"INFO\\",\\"databaseName\\":\\"general\\",\\"iquan.plan.cache.enable\\":true,\\"iquan.plan.prepare.level\\":\\"jni.post.optimize\\",\\"urlencode_data\\":false,\\"formatType\\":\\"string\\",\\"timeout\\":1000}',
- ],
- 'combineParams' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '{\\"trace\\":\\"INFO\\",\\"databaseName\\":\\"general\\",\\"iquan.plan.cache.enable\\":true,\\"iquan.plan.prepare.level\\":\\"jni.post.optimize\\",\\"urlencode_data\\":false,\\"formatType\\":\\"string\\",\\"timeout\\":1000}',
- ],
+ 'generationId' => ['description' => 'generationId', 'type' => 'integer', 'format' => 'int64', 'example' => '1708674867', 'title' => ''],
+ 'status' => ['title' => '', 'description' => 'starting, building, ready, stopped, failed', 'type' => 'string', 'example' => 'ready'],
],
+ 'example' => '',
],
],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
],
500 => [],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"E45380E8-994A-5402-9806-F114B3295FCF\\",\\n \\"result\\": {\\n \\"gmtCreate\\": \\"1719221186114\\",\\n \\"gmtModified\\": \\"1719221186114\\",\\n \\"instanceId\\": 1,\\n \\"version\\": 1,\\n \\"comment\\": \\"Confirm and Execute\\",\\n \\"relatedTemplateId\\": 1,\\n \\"content\\": \\"select * from test\\",\\n \\"kvpairs\\": \\"{\\\\\\\\\\\\\\"trace\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"INFO\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"databaseName\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"general\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"iquan.plan.cache.enable\\\\\\\\\\\\\\":true,\\\\\\\\\\\\\\"iquan.plan.prepare.level\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"jni.post.optimize\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"urlencode_data\\\\\\\\\\\\\\":false,\\\\\\\\\\\\\\"formatType\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"string\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"timeout\\\\\\\\\\\\\\":1000}\\",\\n \\"dynamicParams\\": \\"{\\\\\\\\\\\\\\"trace\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"INFO\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"databaseName\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"general\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"iquan.plan.cache.enable\\\\\\\\\\\\\\":true,\\\\\\\\\\\\\\"iquan.plan.prepare.level\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"jni.post.optimize\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"urlencode_data\\\\\\\\\\\\\\":false,\\\\\\\\\\\\\\"formatType\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"string\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"timeout\\\\\\\\\\\\\\":1000}\\",\\n \\"templateParams\\": \\"{\\\\\\\\\\\\\\"trace\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"INFO\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"databaseName\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"general\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"iquan.plan.cache.enable\\\\\\\\\\\\\\":true,\\\\\\\\\\\\\\"iquan.plan.prepare.level\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"jni.post.optimize\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"urlencode_data\\\\\\\\\\\\\\":false,\\\\\\\\\\\\\\"formatType\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"string\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"timeout\\\\\\\\\\\\\\":1000}\\",\\n \\"staticParams\\": \\"{\\\\\\\\\\\\\\"trace\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"INFO\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"databaseName\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"general\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"iquan.plan.cache.enable\\\\\\\\\\\\\\":true,\\\\\\\\\\\\\\"iquan.plan.prepare.level\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"jni.post.optimize\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"urlencode_data\\\\\\\\\\\\\\":false,\\\\\\\\\\\\\\"formatType\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"string\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"timeout\\\\\\\\\\\\\\":1000}\\",\\n \\"combineParams\\": \\"{\\\\\\\\\\\\\\"trace\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"INFO\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"databaseName\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"general\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"iquan.plan.cache.enable\\\\\\\\\\\\\\":true,\\\\\\\\\\\\\\"iquan.plan.prepare.level\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"jni.post.optimize\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"urlencode_data\\\\\\\\\\\\\\":false,\\\\\\\\\\\\\\"formatType\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"string\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"timeout\\\\\\\\\\\\\\":1000}\\"\\n }\\n}","type":"json"}]',
- 'title' => 'UpdateSqlInstanceContent',
- 'summary' => 'Modifies the content of an SQL instance.',
- ],
- 'UpdateSqlInstanceName' => [
- 'path' => '/openapi/ha3/instances/{instanceId}/sql-studio/databases/{database}/sql-instances/{sqlInstanceId}/name',
- 'methods' => [
- 'put',
- ],
- 'schemes' => [
- 'http',
- 'https',
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"E7B7D598-B080-5C8E-AA35-D43EC0D5F886\\",\\n \\"result\\": {\\n \\"generationId\\": 1708674867,\\n \\"status\\": \\"ready\\"\\n }\\n}","type":"json"}]',
+ 'title' => 'GetTableGeneration',
+ 'description' => '### Method'."\n"
+ ."\n"
+ .'```java'."\n"
+ .'GET'."\n"
+ .'```'."\n"
+ ."\n"
+ .'### URI'."\n"
+ ."\n"
+ .'```java'."\n"
+ .'/openapi/ha3/instances/{instanceId}/tables/{tableName}/index_versions/{generationId}'."\n"
+ .'```',
+ 'requestParamsDescription' => '### [](#)Sample requests'."\n"
+ ."\n"
+ .'```java'."\n"
+ .'GET /openapi/ha3/instances/{instanceId}/tables/{tableName}/index_versions/{generationId}'."\n"
+ .'```',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'searchengine:GetTableGeneration',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SearchEngine', 'resourceType' => 'Instance', 'arn' => 'acs:searchengine:{#regionId}:{#accountId}:instance/{#InstanceId}'],
+ ],
+ ],
+ ],
],
+ ],
+ 'ListAdvanceConfigDir' => [
+ 'path' => '/openapi/ha3/instances/{instanceId}/advanced-configs/{configName}/dir',
+ 'methods' => ['get'],
+ 'schemes' => ['https', 'http'],
'security' => [
[
'AK' => [],
],
],
- 'operationType' => 'write',
+ 'operationType' => 'read',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'update',
- 'abilityTreeCode' => '139114',
- 'abilityTreeNodes' => [
- 'FEATUREopensearch95VJR4',
- ],
- ],
+ 'systemTags' => ['operationType' => 'list'],
'parameters' => [
[
'name' => 'instanceId',
'in' => 'path',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'ha-cn-pl32rf0****',
- ],
- ],
- [
- 'name' => 'database',
- 'in' => 'path',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'general',
- ],
+ 'schema' => ['description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'example' => 'ha-cn-pl32rf0****', 'title' => ''],
],
[
- 'name' => 'sqlInstanceId',
+ 'name' => 'configName',
'in' => 'path',
- 'schema' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => true,
- 'example' => '1',
- ],
+ 'schema' => ['description' => 'The configuration name.', 'type' => 'string', 'required' => true, 'example' => 'ha-cn-pl32rf0****_online_config_v3', 'title' => ''],
],
[
- 'name' => 'body',
- 'in' => 'body',
- 'style' => 'json',
- 'schema' => [
- 'description' => '',
- 'type' => 'object',
- 'properties' => [
- 'name' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'test',
- ],
- ],
- 'required' => false,
- ],
+ 'name' => 'dirName',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The directory name.', 'type' => 'string', 'required' => true, 'example' => '/zones/general', 'title' => ''],
],
],
'responses' => [
@@ -11408,381 +7269,314 @@
'schema' => [
'type' => 'object',
'properties' => [
- 'requestId' => [
- 'title' => 'id of request',
- 'description' => 'id of request',
- 'type' => 'string',
- 'example' => 'E7B7D598-B080-5C8E-AA35-D43EC0D5F886',
- ],
+ 'requestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '2AE63638-5420-56DC-BF59-37D8174039A0'],
'result' => [
- 'title' => 'NodeVO',
- 'description' => 'NodeVO',
- 'type' => 'object',
- 'properties' => [
- 'id' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '22',
- ],
- 'gmtCreate' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '1719220182844',
- ],
- 'gmtModified' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '1719221186114',
- ],
- 'name' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'general',
- ],
- 'parent' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '-1',
- ],
- 'isDir' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => 'true',
- ],
- 'type' => [
- 'title' => 'table, instance, template, function',
- 'description' => 'table, instance, template, function',
- 'type' => 'string',
- 'example' => 'instance',
- ],
- 'instanceId' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '1',
- ],
- 'templateId' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '1',
+ 'title' => '',
+ 'description' => 'The returned result.',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'The list of advanced configuration files.',
+ 'type' => 'object',
+ 'properties' => [
+ 'name' => ['description' => 'The cluster name.', 'type' => 'string', 'example' => 'hz_pre_vpc_domain_1', 'title' => ''],
+ 'fullPathName' => ['description' => 'The full path.', 'type' => 'string', 'example' => '/path/wpd/nae', 'title' => ''],
+ 'isDir' => ['description' => 'Indicates whether the entry is a directory. Valid values: - true: The entry is a directory. - false: The entry is not a directory.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
+ 'isTemplate' => ['description' => 'Indicates whether the entry is a template. Valid values: - **true**: The entry is a template. - **false**: The entry is not a template.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
],
+ 'title' => '',
+ 'example' => '',
],
+ 'example' => '',
],
],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
],
500 => [],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"E7B7D598-B080-5C8E-AA35-D43EC0D5F886\\",\\n \\"result\\": {\\n \\"id\\": 22,\\n \\"gmtCreate\\": \\"1719220182844\\",\\n \\"gmtModified\\": \\"1719221186114\\",\\n \\"name\\": \\"general\\",\\n \\"parent\\": -1,\\n \\"isDir\\": 0,\\n \\"type\\": \\"instance\\",\\n \\"instanceId\\": 1,\\n \\"templateId\\": 1\\n }\\n}","type":"json"}]',
- 'title' => 'UpdateSqlInstanceName',
- 'summary' => 'Modifies the name of an SQL instance.',
- ],
- 'UpdateSqlInstanceParams' => [
- 'path' => '/openapi/ha3/instances/{instanceId}/sql-studio/databases/{database}/sql-instances/{sqlInstanceId}/params',
- 'methods' => [
- 'put',
- ],
- 'schemes' => [
- 'http',
- 'https',
+ 'title' => 'Retrieve the list of files in an advanced configuration directory',
+ 'summary' => 'Retrieves the list of files in an advanced configuration directory.',
+ 'description' => '### Method'."\n"
+ ."\n"
+ .'```java'."\n"
+ .'GET'."\n"
+ .'```'."\n"
+ ."\n"
+ .'### URI'."\n"
+ ."\n"
+ .'```java'."\n"
+ .'/openapi/ha3/instances/{instanceId}/advanced-configs/{configName}/dir?dirName={dirName}'."\n"
+ .'```.',
+ 'requestParamsDescription' => '## Request example'."\n"
+ .'`GET /openapi/ha3/instances/ose-test1/advanced-configs`.',
+ 'responseParamsDescription' => '## Response example'."\n"
+ .'### Successful response'."\n"
+ .'```json'."\n"
+ .'{'."\n"
+ .' "requestId": "0A6EB64B-B4C8-CF02-810F-E660812972FF",'."\n"
+ .' "result": ['."\n"
+ .' {'."\n"
+ .' "name": "file_name_1",'."\n"
+ .' "fullPathName": "/path/wpd/nae",'."\n"
+ .' "isDir": true,'."\n"
+ .' "isTemplate": true'."\n"
+ .' }'."\n"
+ .' ]'."\n"
+ .'}'."\n"
+ .'```.',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListAdvanceConfigDir'],
+ ],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'list',
+ 'ramAction' => [
+ 'action' => 'searchengine:ListAdvanceConfigDir',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SearchEngine', 'resourceType' => 'Instance', 'arn' => 'acs:searchengine:{#regionId}:{#accountId}:instance/{#instanceId}'],
+ ],
+ ],
+ ],
],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"2AE63638-5420-56DC-BF59-37D8174039A0\\",\\n \\"result\\": [\\n {\\n \\"name\\": \\"hz_pre_vpc_domain_1\\",\\n \\"fullPathName\\": \\"/path/wpd/nae\\",\\n \\"isDir\\": true,\\n \\"isTemplate\\": true\\n }\\n ]\\n}","type":"json"}]',
+ ],
+ 'ListAdvanceConfigs' => [
+ 'path' => '/openapi/ha3/instances/{instanceId}/advanced-configs',
+ 'methods' => ['get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
- 'operationType' => 'write',
+ 'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
- 'operationType' => 'update',
- 'abilityTreeCode' => '139113',
- 'abilityTreeNodes' => [
- 'FEATUREopensearch95VJR4',
- ],
+ 'operationType' => 'list',
+ 'abilityTreeCode' => '104702',
+ 'abilityTreeNodes' => ['FEATUREopensearchA6GC80'],
],
'parameters' => [
[
'name' => 'instanceId',
'in' => 'path',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'ha-cn-pl32rf0****',
- ],
+ 'schema' => ['description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'ha-cn-pl32rf0****'],
],
[
- 'name' => 'database',
- 'in' => 'path',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'general',
- ],
+ 'name' => 'type',
+ 'in' => 'query',
+ 'schema' => ['title' => '', 'description' => 'The type of the advanced configuration. Valid values:'."\n"
+ .'\\- online'."\n"
+ .'\\- offline (default)', 'type' => 'string', 'required' => false, 'default' => 'OFFLINE_DICT', 'example' => 'online'],
],
[
- 'name' => 'sqlInstanceId',
- 'in' => 'path',
- 'schema' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => true,
- 'example' => '1',
- ],
+ 'name' => 'dataSourceName',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The data source name.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => 'ha-cn-pl32rf0****_test_api'."\n"],
],
[
- 'name' => 'body',
- 'in' => 'body',
- 'style' => 'json',
- 'schema' => [
- 'description' => '',
- 'type' => 'object',
- 'properties' => [
- 'kvpair' => [
- 'description' => '',
- 'type' => 'object',
- 'required' => false,
- 'additionalProperties' => [
- 'type' => 'any',
- 'example' => '{'."\n"
- .' "trace": "INFO",'."\n"
- .' "databaseName": "general",'."\n"
- .' "iquan.plan.cache.enable": true,'."\n"
- .' "iquan.plan.prepare.level": "jni.post.optimize",'."\n"
- .' "urlencode_data": false,'."\n"
- .' "formatType": "string",'."\n"
- .' "timeout": 1000'."\n"
- .'}',
- 'description' => '',
- ],
- ],
- 'dynamicParam' => [
- 'description' => '',
- 'type' => 'object',
- 'required' => false,
- 'additionalProperties' => [
- 'type' => 'any',
- 'description' => '',
- 'example' => '{'."\n"
- .' "trace": "INFO",'."\n"
- .' "databaseName": "general",'."\n"
- .' "iquan.plan.cache.enable": true,'."\n"
- .' "iquan.plan.prepare.level": "jni.post.optimize",'."\n"
- .' "urlencode_data": false,'."\n"
- .' "formatType": "string",'."\n"
- .' "timeout": 1000'."\n"
- .'}',
- ],
- ],
- 'staticParam' => [
- 'description' => '',
- 'type' => 'object',
- 'required' => false,
- 'additionalProperties' => [
- 'type' => 'any',
- 'example' => '{'."\n"
- .' "trace": "INFO",'."\n"
- .' "databaseName": "general",'."\n"
- .' "iquan.plan.cache.enable": true,'."\n"
- .' "iquan.plan.prepare.level": "jni.post.optimize",'."\n"
- .' "urlencode_data": false,'."\n"
- .' "formatType": "string",'."\n"
- .' "timeout": 1000'."\n"
- .'}',
- 'description' => '',
- ],
- ],
- 'params' => [
- 'description' => '',
- 'type' => 'object',
- 'required' => false,
- 'additionalProperties' => [
- 'type' => 'any',
- 'description' => '',
- 'example' => '{'."\n"
- .' "trace": "INFO",'."\n"
- .' "databaseName": "general",'."\n"
- .' "iquan.plan.cache.enable": true,'."\n"
- .' "iquan.plan.prepare.level": "jni.post.optimize",'."\n"
- .' "urlencode_data": false,'."\n"
- .' "formatType": "string",'."\n"
- .' "timeout": 1000'."\n"
- .'}',
- ],
- ],
- 'combineParam' => [
- 'description' => '',
- 'type' => 'object',
- 'required' => false,
- 'additionalProperties' => [
- 'type' => 'any',
- 'example' => '{'."\n"
- .' "trace": "INFO",'."\n"
- .' "databaseName": "general",'."\n"
- .' "iquan.plan.cache.enable": true,'."\n"
- .' "iquan.plan.prepare.level": "jni.post.optimize",'."\n"
- .' "urlencode_data": false,'."\n"
- .' "formatType": "string",'."\n"
- .' "timeout": 1000'."\n"
- .'}',
- 'description' => '',
- ],
- ],
- ],
- 'required' => false,
- ],
+ 'name' => 'indexName',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The index name.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => 'test_api'],
+ ],
+ [
+ 'name' => 'newMode',
+ 'in' => 'query',
+ 'schema' => ['description' => 'Specifies whether to use the new version of the page.', 'type' => 'boolean', 'required' => false, 'title' => '', 'example' => 'true'],
+ ],
+ [
+ 'name' => 'pageNumber',
+ 'in' => 'query',
+ 'schema' => ['type' => 'string', 'description' => 'The page number. The default value is 1.', 'required' => false, 'title' => '', 'example' => '1'],
+ ],
+ [
+ 'name' => 'pageSize',
+ 'in' => 'query',
+ 'schema' => ['type' => 'string', 'description' => 'The number of entries to return on each page. The default value is 10.', 'required' => false, 'title' => '', 'example' => '10'],
],
],
'responses' => [
200 => [
'schema' => [
+ 'description' => 'The response parameters.'."\n",
'type' => 'object',
'properties' => [
- 'requestId' => [
- 'title' => 'id of request',
- 'description' => 'id of request',
- 'type' => 'string',
- 'example' => '022F36C7-9FB4-5D67-BEBC-3D14B0984463',
- ],
+ 'requestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '4FB0325E-8C37-5525-96AC-0333523170A3'],
'result' => [
- 'title' => 'InstanceVersionVO',
- 'description' => 'InstanceVersionVO',
- 'type' => 'object',
- 'properties' => [
- 'gmtCreate' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '1719221186114',
- ],
- 'gmtModified' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '1719220182844',
- ],
- 'instanceId' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '1',
- ],
- 'version' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '1',
- ],
- 'comment' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '',
- ],
- 'relatedTemplateId' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '1',
- ],
- 'content' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'select * from test',
- ],
- 'kvpairs' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '{\\"trace\\":\\"INFO\\",\\"databaseName\\":\\"general\\",\\"iquan.plan.cache.enable\\":true,\\"iquan.plan.prepare.level\\":\\"jni.post.optimize\\",\\"urlencode_data\\":false,\\"formatType\\":\\"string\\",\\"timeout\\":1000}',
- ],
- 'dynamicParams' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '{\\"trace\\":\\"INFO\\",\\"databaseName\\":\\"general\\",\\"iquan.plan.cache.enable\\":true,\\"iquan.plan.prepare.level\\":\\"jni.post.optimize\\",\\"urlencode_data\\":false,\\"formatType\\":\\"string\\",\\"timeout\\":1000}',
- ],
- 'templateParams' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '{\\"trace\\":\\"INFO\\",\\"databaseName\\":\\"general\\",\\"iquan.plan.cache.enable\\":true,\\"iquan.plan.prepare.level\\":\\"jni.post.optimize\\",\\"urlencode_data\\":false,\\"formatType\\":\\"string\\",\\"timeout\\":1000}',
- ],
- 'staticParams' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '{\\"trace\\":\\"INFO\\",\\"databaseName\\":\\"general\\",\\"iquan.plan.cache.enable\\":true,\\"iquan.plan.prepare.level\\":\\"jni.post.optimize\\",\\"urlencode_data\\":false,\\"formatType\\":\\"string\\",\\"timeout\\":1000}',
- ],
- 'combineParams' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '{\\"trace\\":\\"INFO\\",\\"databaseName\\":\\"general\\",\\"iquan.plan.cache.enable\\":true,\\"iquan.plan.prepare.level\\":\\"jni.post.optimize\\",\\"urlencode_data\\":false,\\"formatType\\":\\"string\\",\\"timeout\\":1000}',
+ 'title' => '',
+ 'description' => 'The returned result.',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'A list of advanced configurations.',
+ 'type' => 'object',
+ 'properties' => [
+ 'updateTime' => ['title' => '', 'description' => 'The update time.', 'type' => 'integer', 'format' => 'int64', 'example' => '1631070464000'],
+ 'desc' => ['title' => '', 'description' => 'The description.', 'type' => 'string', 'example' => 'Custom Description'],
+ 'files' => [
+ 'title' => '',
+ 'description' => 'A list of files.',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'The file information.',
+ 'type' => 'object',
+ 'properties' => [
+ 'name' => ['description' => 'The file name.', 'type' => 'string', 'title' => '', 'example' => 'file_name_1'],
+ 'fullPathName' => ['description' => 'The absolute path.', 'type' => 'string', 'title' => '', 'example' => '/path/wpd/nae'],
+ 'isDir' => ['description' => 'Specifies whether the file is a directory. Valid values:'."\n"
+ .'\\- \\`true\\`'."\n"
+ .'\\- \\`false\\`', 'type' => 'boolean', 'title' => '', 'example' => 'true'],
+ 'isTemplate' => ['description' => 'Specifies whether the file is a template. Valid values:'."\n"
+ .'\\- \\`true\\`'."\n"
+ .'\\- \\`false\\`', 'type' => 'boolean', 'title' => '', 'example' => 'true'],
+ ],
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'example' => '',
+ ],
+ 'content' => ['title' => '', 'description' => 'The configuration content. This parameter is returned for HTTP and Git requests.', 'type' => 'string', 'example' => '{\\"url\\":\\"http://xxxxxx.aliyuncs.com/outnet_hz/packages/xxxxx/opensearch_offline_plugins_xxxxx.tar\\"}'],
+ 'contentType' => ['title' => '', 'description' => 'The type of the configuration content. Valid values: FILE, GIT, HTTP, and ODPS.', 'type' => 'string', 'example' => 'FILE'],
+ 'name' => ['title' => '', 'description' => 'The name of the advanced configuration.', 'type' => 'string', 'example' => 'my_index'],
+ 'status' => ['title' => '', 'description' => 'The status of the advanced configuration. Valid values:'."\n"
+ .'\\- \\`drafting\\`: The configuration is a draft.'."\n"
+ .'\\- \\`used\\`: The configuration is in use.'."\n"
+ .'\\- \\`unused\\`: The configuration is not in use.'."\n"
+ .'\\- \\`trash\\`: The configuration is being deleted.', 'type' => 'string', 'example' => 'drafting'],
+ 'creator' => ['description' => 'The ID of the user who created the configuration.', 'type' => 'string', 'title' => '', 'example' => '123456'],
+ 'advanceConfigType' => ['description' => '- ONLINE: online configuration'."\n"
+ ."\n"
+ .'- ONLINE\\_CAVA: online Cava configuration'."\n"
+ ."\n"
+ .'- ONLINE\\_PLUGIN: online plugin'."\n"
+ ."\n"
+ .'- ONLINE\\_QUERY: query configuration'."\n"
+ ."\n"
+ .'- OFFLINE\\_DICT: offline dictionary configuration'."\n"
+ ."\n"
+ .'- OFFLINE\\_TABLE: offline table configuration'."\n"
+ ."\n"
+ .'- OFFLINE\\_COMMON: common offline configuration'."\n"
+ ."\n"
+ .'- OFFLINE\\_PLUGIN: offline plugin'."\n"
+ ."\n"
+ .'- OFFLINE\\_INDEX: index configuration', 'type' => 'string', 'title' => '', 'example' => 'ONLINE'],
],
+ 'title' => '',
+ 'example' => '',
],
+ 'example' => '',
],
],
+ 'title' => '',
+ 'example' => '',
],
],
500 => [],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"022F36C7-9FB4-5D67-BEBC-3D14B0984463\\",\\n \\"result\\": {\\n \\"gmtCreate\\": \\"1719221186114\\",\\n \\"gmtModified\\": \\"1719220182844\\",\\n \\"instanceId\\": 1,\\n \\"version\\": 1,\\n \\"comment\\": \\"Confirm and Execute\\",\\n \\"relatedTemplateId\\": 1,\\n \\"content\\": \\"select * from test\\",\\n \\"kvpairs\\": \\"{\\\\\\\\\\\\\\"trace\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"INFO\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"databaseName\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"general\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"iquan.plan.cache.enable\\\\\\\\\\\\\\":true,\\\\\\\\\\\\\\"iquan.plan.prepare.level\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"jni.post.optimize\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"urlencode_data\\\\\\\\\\\\\\":false,\\\\\\\\\\\\\\"formatType\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"string\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"timeout\\\\\\\\\\\\\\":1000}\\",\\n \\"dynamicParams\\": \\"{\\\\\\\\\\\\\\"trace\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"INFO\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"databaseName\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"general\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"iquan.plan.cache.enable\\\\\\\\\\\\\\":true,\\\\\\\\\\\\\\"iquan.plan.prepare.level\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"jni.post.optimize\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"urlencode_data\\\\\\\\\\\\\\":false,\\\\\\\\\\\\\\"formatType\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"string\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"timeout\\\\\\\\\\\\\\":1000}\\",\\n \\"templateParams\\": \\"{\\\\\\\\\\\\\\"trace\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"INFO\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"databaseName\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"general\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"iquan.plan.cache.enable\\\\\\\\\\\\\\":true,\\\\\\\\\\\\\\"iquan.plan.prepare.level\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"jni.post.optimize\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"urlencode_data\\\\\\\\\\\\\\":false,\\\\\\\\\\\\\\"formatType\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"string\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"timeout\\\\\\\\\\\\\\":1000}\\",\\n \\"staticParams\\": \\"{\\\\\\\\\\\\\\"trace\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"INFO\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"databaseName\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"general\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"iquan.plan.cache.enable\\\\\\\\\\\\\\":true,\\\\\\\\\\\\\\"iquan.plan.prepare.level\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"jni.post.optimize\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"urlencode_data\\\\\\\\\\\\\\":false,\\\\\\\\\\\\\\"formatType\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"string\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"timeout\\\\\\\\\\\\\\":1000}\\",\\n \\"combineParams\\": \\"{\\\\\\\\\\\\\\"trace\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"INFO\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"databaseName\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"general\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"iquan.plan.cache.enable\\\\\\\\\\\\\\":true,\\\\\\\\\\\\\\"iquan.plan.prepare.level\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"jni.post.optimize\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"urlencode_data\\\\\\\\\\\\\\":false,\\\\\\\\\\\\\\"formatType\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"string\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"timeout\\\\\\\\\\\\\\":1000}\\"\\n }\\n}","type":"json"}]',
- 'title' => 'UpdateSqlInstanceParams',
- 'summary' => 'Modifies the parameters of an SQL instance.',
- ],
- 'DeleteFolder' => [
- 'path' => '/openapi/ha3/instances/{instanceId}/sql-studio/databases/{database}/folders/{folderId}',
- 'methods' => [
- 'delete',
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"4FB0325E-8C37-5525-96AC-0333523170A3\\",\\n \\"result\\": [\\n {\\n \\"updateTime\\": 1631070464000,\\n \\"desc\\": \\"Custom Description\\",\\n \\"files\\": [\\n {\\n \\"name\\": \\"file_name_1\\",\\n \\"fullPathName\\": \\"/path/wpd/nae\\",\\n \\"isDir\\": true,\\n \\"isTemplate\\": true\\n }\\n ],\\n \\"content\\": \\"{\\\\\\\\\\\\\\"url\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"http://xxxxxx.aliyuncs.com/outnet_hz/packages/xxxxx/opensearch_offline_plugins_xxxxx.tar\\\\\\\\\\\\\\"}\\",\\n \\"contentType\\": \\"FILE\\",\\n \\"name\\": \\"my_index\\",\\n \\"status\\": \\"drafting\\",\\n \\"creator\\": \\"123456\\",\\n \\"advanceConfigType\\": \\"ONLINE\\"\\n }\\n ]\\n}","type":"json"}]',
+ 'title' => 'ListAdvanceConfigs',
+ 'summary' => 'Retrieves a list of advanced configurations.',
+ 'description' => '### Method'."\n"
+ ."\n"
+ .'```java'."\n"
+ .'GET'."\n"
+ .'```'."\n"
+ ."\n"
+ .'### URI'."\n"
+ ."\n"
+ .'```java'."\n"
+ .'/openapi/ha3/instances/{instanceId}/advanced-configs?type=online'."\n"
+ .'```',
+ 'requestParamsDescription' => '## Request example'."\n"
+ ."\n"
+ .'`GET /openapi/ha3/instances/ose-test1/advanced-configs`',
+ 'responseParamsDescription' => '## Response example'."\n"
+ ."\n"
+ .'### Successful response'."\n"
+ ."\n"
+ .'```json'."\n"
+ .'{'."\n"
+ .' "requestId": "0A6EB64B-B4C8-CF02-810F-E660812972FF",'."\n"
+ .' "result": ['."\n"
+ .' {'."\n"
+ .' "name": "my_index",'."\n"
+ .' "status": "drafting",'."\n"
+ .' "updateTime": 1631070464000,'."\n"
+ .' "desc":"test",'."\n"
+ .' "files":['."\n"
+ .' {'."\n"
+ .' "name": "file_name_1",'."\n"
+ .' "fullPathName": "/path/wpd/nae",'."\n"
+ .' "isDir": true,'."\n"
+ .' "isTemplate": true'."\n"
+ .' }'."\n"
+ .' ]'."\n"
+ .' },'."\n"
+ .' {'."\n"
+ .' "name": "my_index2",'."\n"
+ .' "status": "drafting",'."\n"
+ .' "updateTime": 1631070464000,'."\n"
+ .' "desc":"test",'."\n"
+ .' "files":['."\n"
+ .' {'."\n"
+ .' "name": "file_name_1",'."\n"
+ .' "fullPathName": "/path/wpd/nae",'."\n"
+ .' "isDir": true,'."\n"
+ .' "isTemplate": true'."\n"
+ .' }'."\n"
+ .' ]'."\n"
+ .' }'."\n"
+ .' ]'."\n"
+ .'}'."\n"
+ .'```',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListAdvanceConfigs'],
+ ],
],
- 'schemes' => [
- 'http',
- 'https',
+ 'ramActions' => [
+ [
+ 'operationType' => 'list',
+ 'ramAction' => [
+ 'action' => 'searchengine:ListAdvanceConfigs',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SearchEngine', 'resourceType' => 'Instance', 'arn' => 'acs:searchengine:{#regionId}:{#accountId}:instance/{#InstanceId}'],
+ ],
+ ],
+ ],
],
+ ],
+ 'ListAliases' => [
+ 'path' => '/openapi/ha3/instances/{instanceId}/aliases',
+ 'methods' => ['get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
- 'operationType' => 'write',
+ 'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
- 'operationType' => 'delete',
- 'abilityTreeCode' => '138810',
- 'abilityTreeNodes' => [
- 'FEATUREopensearch95VJR4',
- ],
+ 'operationType' => 'list',
+ 'abilityTreeCode' => '223195',
+ 'abilityTreeNodes' => ['FEATUREopensearchGTRUN8'],
],
'parameters' => [
[
'name' => 'instanceId',
'in' => 'path',
- 'schema' => [
- 'description' => 'The instance ID.'."\n",
- 'type' => 'string',
- 'required' => true,
- 'example' => 'ha-cn-pl32rf0****',
- ],
- ],
- [
- 'name' => 'database',
- 'in' => 'path',
- 'schema' => [
- 'description' => 'database name',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'general',
- ],
- ],
- [
- 'name' => 'folderId',
- 'in' => 'path',
- 'schema' => [
- 'description' => 'folder id',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => true,
- 'example' => '-1',
- ],
+ 'schema' => ['description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'ha-cn-pl32rf0****'],
],
],
'responses' => [
@@ -11790,295 +7584,179 @@
'schema' => [
'type' => 'object',
'properties' => [
- 'requestId' => [
- 'title' => 'id of request',
- 'description' => 'id of request',
- 'type' => 'string',
- 'example' => '022F36C7-9FB4-5D67-BEBC-3D14B0984463',
- ],
+ 'requestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '10D5E615-69F7-5F49-B850-00169ADE513C'],
'result' => [
- 'title' => 'Response<Map<String, String>>',
- 'description' => 'Response<Map<String, String>>',
- 'type' => 'object',
- 'properties' => [
- 'result' => [
- 'description' => 'The result'."\n",
- 'type' => 'object',
- 'additionalProperties' => [
- 'type' => 'string',
- 'example' => '{}',
- 'description' => 'The result.'."\n",
- ],
- ],
- 'requestId' => [
- 'description' => 'The request ID.'."\n",
- 'type' => 'string',
- 'example' => '022F36C7-9FB4-5D67-BEBC-3D14B0984463',
+ 'title' => '',
+ 'description' => 'The result.',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'The result.',
+ 'type' => 'object',
+ 'properties' => [
+ 'alias' => ['title' => '', 'description' => 'The alias.', 'type' => 'string', 'example' => 'test'],
+ 'index' => ['title' => '', 'description' => 'The associated index.', 'type' => 'string', 'example' => 'index'],
],
+ 'title' => '',
+ 'example' => '',
],
+ 'example' => '',
],
],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
],
500 => [],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"022F36C7-9FB4-5D67-BEBC-3D14B0984463\\",\\n \\"result\\": {\\n \\"result\\": {\\n \\"key\\": \\"{}\\"\\n },\\n \\"requestId\\": \\"022F36C7-9FB4-5D67-BEBC-3D14B0984463\\"\\n }\\n}","type":"json"}]',
- 'title' => 'DeleteFolder',
- ],
- 'RenameFolder' => [
- 'path' => '/openapi/ha3/instances/{instanceId}/sql-studio/databases/{database}/folders/{folderId}/name',
- 'methods' => [
- 'put',
- ],
- 'schemes' => [
- 'http',
- 'https',
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"10D5E615-69F7-5F49-B850-00169ADE513C\\",\\n \\"result\\": [\\n {\\n \\"alias\\": \\"test\\",\\n \\"index\\": \\"index\\"\\n }\\n ]\\n}","type":"json"}]',
+ 'title' => 'ListAliases',
+ 'summary' => 'Lists table aliases.',
+ 'description' => '### Method'."\n"
+ ."\n"
+ .'```java'."\n"
+ .'GET'."\n"
+ .'```'."\n"
+ ."\n"
+ .'### URI'."\n"
+ ."\n"
+ .'```java'."\n"
+ .'/openapi/ha3/instances/{instanceId}/aliases'."\n"
+ .'```',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'list',
+ 'ramAction' => [
+ 'action' => 'searchengine:ListAliases',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SearchEngine', 'resourceType' => 'Instance', 'arn' => 'acs:searchengine:{#regionId}:{#accountId}:instance/{#InstanceId}'],
+ ],
+ ],
+ ],
],
+ ],
+ 'ListClusterNames' => [
+ 'summary' => 'Queries cluster names.',
+ 'path' => '/openapi/ha3/cluster-names',
+ 'methods' => ['get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
- 'operationType' => 'write',
+ 'operationType' => 'read',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'update',
- 'abilityTreeCode' => '138809',
- 'abilityTreeNodes' => [
- 'FEATUREopensearch95VJR4',
- ],
- ],
- 'parameters' => [
- [
- 'name' => 'instanceId',
- 'in' => 'path',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'ha-cn-pl32rf0****',
- ],
- ],
- [
- 'name' => 'database',
- 'in' => 'path',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'general',
- ],
- ],
- [
- 'name' => 'folderId',
- 'in' => 'path',
- 'schema' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => true,
- 'example' => '-1',
- ],
- ],
- [
- 'name' => 'body',
- 'in' => 'body',
- 'style' => 'json',
- 'schema' => [
- 'description' => '',
- 'type' => 'object',
- 'properties' => [
- 'name' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'test',
- ],
- ],
- 'required' => false,
- ],
- ],
- ],
+ 'systemTags' => ['operationType' => 'list'],
+ 'parameters' => [],
'responses' => [
200 => [
'schema' => [
+ 'description' => 'The response parameters.',
'type' => 'object',
'properties' => [
- 'requestId' => [
- 'title' => 'id of request',
- 'description' => 'id of request',
- 'type' => 'string',
- 'example' => '10D5E615-69F7-5F49-B850-00169ADE513C',
- ],
+ 'requestId' => ['title' => '', 'description' => 'id of request', 'type' => 'string', 'example' => 'F6E3D968-529C-5C40-AFDD-133A8B8FD930'],
'result' => [
- 'title' => 'NodeVO',
- 'description' => 'NodeVO',
+ 'title' => '',
+ 'description' => 'The result set.',
'type' => 'object',
'properties' => [
- 'id' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '1',
- ],
- 'gmtCreate' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '1719221186114',
- ],
- 'gmtModified' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '1719221186114',
- ],
- 'name' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'test',
- ],
- 'parent' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '-1',
- ],
- 'isDir' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => 'True',
- ],
- 'type' => [
- 'title' => 'table, instance, template, function',
- 'description' => 'table, instance, template, function',
- 'type' => 'string',
- 'example' => 'template',
- ],
- 'instanceId' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '1',
- ],
- 'templateId' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '1',
- ],
+ 'name' => ['description' => 'The cluster name.', 'type' => 'string', 'title' => '', 'example' => 'hz_pre_vpc_domain_1'],
+ 'description' => ['description' => 'The description of the cluster.', 'type' => 'string', 'example' => 'Custom description', 'title' => ''],
+ 'id' => ['description' => 'The cluster ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '25030', 'title' => ''],
],
+ 'example' => '',
],
],
+ 'title' => '',
+ 'example' => '',
],
],
500 => [],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"10D5E615-69F7-5F49-B850-00169ADE513C\\",\\n \\"result\\": {\\n \\"id\\": 1,\\n \\"gmtCreate\\": \\"1719221186114\\",\\n \\"gmtModified\\": \\"1719221186114\\",\\n \\"name\\": \\"test\\",\\n \\"parent\\": -1,\\n \\"isDir\\": 0,\\n \\"type\\": \\"template\\",\\n \\"instanceId\\": 1,\\n \\"templateId\\": 1\\n }\\n}","type":"json"}]',
- 'title' => 'RenameFolder',
- 'summary' => 'Modifies the name of a folder.',
- ],
- 'ListTasks' => [
- 'summary' => '获取集群任务列表（数据源+集群）',
- 'path' => '/openapi/ha3/instances/{instanceId}/tasks',
- 'methods' => [
- 'get',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
- 'security' => [
- [
- 'AK' => [],
- ],
- ],
- 'consumes' => [
- 'application/json',
- ],
- 'produces' => [
- 'application/json',
- ],
- 'operationType' => 'read',
- 'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'none',
- 'riskType' => 'none',
- 'chargeType' => 'free',
- 'abilityTreeCode' => '211712',
- 'abilityTreeNodes' => [
- 'FEATUREopensearchW54CZ4',
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"F6E3D968-529C-5C40-AFDD-133A8B8FD930\\",\\n \\"result\\": {\\n \\"name\\": \\"hz_pre_vpc_domain_1\\",\\n \\"description\\": \\"Custom description\\",\\n \\"id\\": 25030\\n }\\n}","type":"json"}]',
+ 'title' => 'ListClusterNames',
+ 'description' => '### Method'."\n"
+ ."\n"
+ .'GET'."\n"
+ ."\n"
+ .'### URI'."\n"
+ ."\n"
+ .'/openapi/ha3/instances/{instanceId}/cluster-names',
+ 'requestParamsDescription' => '### Sample requests'."\n"
+ ."\n"
+ .'```java'."\n"
+ .'GET /openapi/ha3/instances/ha3_instance_name/cluster-names'."\n"
+ .'```',
+ 'responseParamsDescription' => '### Sample responses'."\n"
+ ."\n"
+ .'Success responses'."\n"
+ ."\n"
+ .'```java'."\n"
+ .'{'."\n"
+ .' "requestId": "e1eef569-1ff7-4bf8-acf7-1cecca9894ce",'."\n"
+ .' "result": ['."\n"
+ .' {'."\n"
+ .' "name":"pre",'."\n"
+ .' "description":"pre",'."\n"
+ .' "id": 1,'."\n"
+ .' }'."\n"
+ .' ]'."\n"
+ .'}'."\n"
+ .'```',
+ 'extraInfo' => '## 示例'."\n"
+ ."\n"
+ .'### 请求示例'."\n"
+ ."\n"
+ .'```java'."\n"
+ .'GET /openapi/ha3/instances/ha3_instance_name/cluster-names'."\n"
+ .'```'."\n"
+ .'###返回示例'."\n"
+ .'正确返回'."\n"
+ ."\n"
+ .'```java'."\n"
+ .'{'."\n"
+ .' "requestId": "e1eef569-1ff7-4bf8-acf7-1cecca9894ce",'."\n"
+ .' "result": ['."\n"
+ .' {'."\n"
+ .' "name":"pre",'."\n"
+ .' "description":"pre机房",'."\n"
+ .' "id": 1,'."\n"
+ .' }'."\n"
+ .' ]'."\n"
+ .'}'."\n"
+ .'```',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListClusterNames'],
],
],
- 'parameters' => [
- [
- 'name' => 'instanceId',
- 'in' => 'path',
- 'schema' => [
- 'description' => 'The instance ID.'."\n",
- 'type' => 'string',
- 'required' => true,
- 'example' => 'ha-cn-tl32n3iu801',
- ],
- ],
- [
- 'name' => 'start',
- 'in' => 'query',
- 'schema' => [
- 'description' => 'The timestamp that indicates the beginning of the time range to query.'."\n",
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => false,
- 'example' => '1687238865434',
- ],
- ],
+ 'ramActions' => [
[
- 'name' => 'end',
- 'in' => 'query',
- 'schema' => [
- 'description' => 'The timestamp that indicates the end of the time range to query.'."\n",
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => false,
- 'example' => '1690423741577',
- ],
- ],
- ],
- 'responses' => [
- 200 => [
- 'schema' => [
- 'type' => 'object',
- 'properties' => [
- 'requestId' => [
- 'title' => 'id of request',
- 'description' => 'The request ID.'."\n",
- 'type' => 'string',
- 'example' => 'D39EE0F1-D7EF-5F46-B781-6BF4185308B0',
- ],
- 'result' => [
- 'title' => 'Object',
- 'description' => 'The result.'."\n",
- 'type' => 'any',
- 'example' => '{}',
- ],
+ 'operationType' => 'list',
+ 'ramAction' => [
+ 'action' => 'searchengine:ListClusterNames',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SearchEngine', 'resourceType' => 'Instance', 'arn' => 'acs:searchengine:{#regionId}:{#accountId}:instance/{#InstanceId}'],
],
- 'description' => '',
],
],
- 500 => [],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"D39EE0F1-D7EF-5F46-B781-6BF4185308B0\\",\\n \\"result\\": \\"{}\\"\\n}","type":"json"}]',
- 'title' => 'ListTasks',
],
'ListClusterTasks' => [
'summary' => 'Queries cluster tasks.',
'path' => '/openapi/ha3/instances/{instanceId}/cluster-tasks',
- 'methods' => [
- 'get',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
+ 'methods' => ['get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
@@ -12086,160 +7764,91 @@
],
'operationType' => 'read',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'list',
- ],
+ 'systemTags' => ['operationType' => 'list'],
'parameters' => [
[
'name' => 'instanceId',
'in' => 'path',
- 'schema' => [
- 'title' => '实例ID',
- 'description' => 'The instance ID.'."\n",
- 'type' => 'string',
- 'required' => true,
- 'example' => 'ha-cn-i7m2roiy504',
- ],
+ 'schema' => ['title' => '', 'description' => 'The instance ID.'."\n", 'type' => 'string', 'required' => true, 'example' => 'ha-cn-pl32rf0****'],
],
],
'responses' => [
200 => [
'schema' => [
- 'title' => 'Schema of Response',
+ 'title' => '',
'description' => 'The response parameters.'."\n",
'type' => 'object',
'properties' => [
- 'requestId' => [
- 'title' => 'id of request',
- 'description' => 'id of request'."\n",
- 'type' => 'string',
- 'example' => 'CC5EC8FA-5C0D-56AF-BEF4-6FCCEABD0511',
- ],
+ 'requestId' => ['title' => '', 'description' => 'id of request'."\n", 'type' => 'string', 'example' => 'CC5EC8FA-5C0D-56AF-BEF4-6FCCEABD0511'],
'result' => [
- 'title' => '索引信息',
+ 'title' => '',
'description' => 'The index information.'."\n",
'type' => 'array',
'items' => [
'description' => 'The information about the cluster list.'."\n",
'type' => 'object',
'properties' => [
- 'groupType' => [
- 'title' => '变更分组类型',
- 'description' => 'The change group type.'."\n",
- 'type' => 'string',
- 'example' => '" "',
- ],
- 'fsmId' => [
- 'title' => 'fsmId',
- 'description' => 'The ID of the finite state machine (FSM).'."\n",
- 'type' => 'string',
- 'example' => 'tisplus_opensearch@datasource_flow_fsm@1865410598556969-ha-cn-zvp2ljiwe01_api2@bj_vpc_domain_1@null@MANUAL-ha-cn-zvp2ljiwe01_api2@1649729867698@028315',
- ],
- 'name' => [
- 'title' => '卡片的名字',
- 'description' => 'The card name.'."\n",
- 'type' => 'string',
- 'example' => 'ha-cn-pl32rf0js04_qrs',
- ],
- 'time' => [
- 'title' => '卡片的时间戳',
- 'description' => 'The timestamp of the card.'."\n",
- 'type' => 'string',
- 'example' => '1657610520',
- ],
- 'type' => [
- 'title' => '卡片的类型',
- 'description' => 'The card type.'."\n",
- 'type' => 'string',
- 'example' => 'qrs',
- ],
- 'user' => [
- 'title' => '触发生成fsm流程的用户',
- 'description' => 'The user who triggered the generation of the FSM process.'."\n",
- 'type' => 'string',
- 'example' => '" "',
- ],
- 'status' => [
- 'title' => 'FSM整体状态',
- 'description' => 'The FSM status.'."\n",
- 'type' => 'string',
- 'example' => 'onlyPublished',
- ],
- 'extraAttribute' => [
- 'title' => '卡片的额外属性',
- 'description' => 'The additional attributes of the card.'."\n",
- 'type' => 'string',
- 'example' => '" "',
- ],
- 'field3' => [
- 'title' => '创建状态机时透传的field3字段',
- 'description' => 'The field3 field that was passed when the FSM was created.'."\n",
- 'type' => 'string',
- 'example' => '" "',
- ],
+ 'groupType' => ['title' => '', 'description' => 'The change group type.'."\n", 'type' => 'string', 'example' => 'Table_Update'],
+ 'fsmId' => ['title' => '', 'description' => 'The ID of the finite state machine (FSM).'."\n", 'type' => 'string', 'example' => 'tisplus_opensearch@datasource_flow_fsm@1865410598556969-ha-cn-pl32rf0****_api2@bj_vpc_domain_1@null@MANUAL-ha-cn-pl32rf0****_api2@1649729867698@028315'],
+ 'name' => ['title' => '', 'description' => 'The card name.'."\n", 'type' => 'string', 'example' => 'ha-cn-pl32rf0****_qrs'],
+ 'time' => ['title' => '', 'description' => 'The timestamp of the card.'."\n", 'type' => 'string', 'example' => '1657610520'],
+ 'type' => ['title' => '', 'description' => 'The card type.'."\n", 'type' => 'string', 'example' => 'mra_table_config_trace_fsm'],
+ 'user' => ['title' => '', 'description' => 'The user who triggered the generation of the FSM process.'."\n", 'type' => 'string', 'example' => 'admin'],
+ 'status' => ['title' => '', 'description' => 'The FSM status.'."\n", 'type' => 'string', 'example' => 'onlyPublished'],
+ 'extraAttribute' => ['title' => '', 'description' => 'The additional attributes of the card.'."\n", 'type' => 'string', 'example' => '{'."\n"
+ .' "consoleVersion": "",'."\n"
+ .' "domain": "hz_pre_vpc_domain_1",'."\n"
+ .' "configType": "offline"'."\n"
+ .'}'],
+ 'field3' => ['title' => '', 'description' => 'The field3 field that was passed when the FSM was created.'."\n", 'type' => 'string', 'example' => '{'."\n"
+ .' "ha-cn-pl32rf0****_offline_adv": 1,'."\n"
+ .' "ha-cn-pl32rf0****_offline_plugin": 1,'."\n"
+ .' "ha-cn-pl32rf0****_table_ha-cn-35t3r02iq03_test_api": 1,'."\n"
+ .' "ha-cn-pl32rf0****@ha-cn-pl32rf0****_test_api@hz_pre_vpc_domain_1@test_api@index_config": 1,'."\n"
+ .' "ha-cn-pl32rf0****_offline_dict": 1'."\n"
+ .'}'],
'tags' => [
- 'title' => '进度条的状态标签',
+ 'title' => '',
'description' => 'The tags of the progress bar.'."\n",
'type' => 'array',
'items' => [
'description' => 'The tag.'."\n",
'type' => 'object',
'properties' => [
- 'tagLevel' => [
- 'title' => '展示tag的等级',
- 'description' => 'The tag level.'."\n",
- 'type' => 'string',
- 'example' => '" "',
- ],
- 'msg' => [
- 'title' => '展示tag内容',
- 'description' => 'The tag content.'."\n",
- 'type' => 'string',
- 'example' => 'succeed in handling request',
- ],
+ 'tagLevel' => ['title' => '', 'description' => 'The tag level.'."\n", 'type' => 'string', 'example' => '1'],
+ 'msg' => ['title' => '', 'description' => 'The tag content.'."\n", 'type' => 'string', 'example' => 'test-tag'],
],
+ 'title' => '',
+ 'example' => '',
],
+ 'example' => '',
],
'taskNodes' => [
- 'title' => '任务信息',
+ 'title' => '',
'description' => 'The task information.'."\n",
'type' => 'array',
'items' => [
'description' => 'The information about the nodes of the task.'."\n",
'type' => 'object',
'properties' => [
- 'name' => [
- 'title' => '任务名称',
- 'description' => 'The task name.'."\n",
- 'type' => 'string',
- 'example' => 'general',
- ],
- 'index' => [
- 'title' => '此任务的序号',
- 'description' => 'The ordinal number of the task.'."\n",
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '100',
- ],
- 'finishDate' => [
- 'title' => '完成日期',
- 'description' => 'The time when the task was complete.'."\n",
- 'type' => 'string',
- 'example' => '" "',
- ],
- 'status' => [
- 'title' => '任务状态',
- 'description' => 'The task status.'."\n",
- 'type' => 'string',
- 'example' => '2',
- ],
+ 'name' => ['title' => '', 'description' => 'The task name.'."\n", 'type' => 'string', 'example' => 'publish config version'],
+ 'index' => ['title' => '', 'description' => 'The ordinal number of the task.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '4'],
+ 'finishDate' => ['title' => '', 'description' => 'The time when the task was complete.'."\n", 'type' => 'string', 'example' => '2024-06-17 18:40:48'],
+ 'status' => ['title' => '', 'description' => 'The task status.'."\n", 'type' => 'string', 'example' => 'SUCCESS'],
],
+ 'title' => '',
+ 'example' => '',
],
+ 'example' => '',
],
],
+ 'title' => '',
+ 'example' => '',
],
+ 'example' => '',
],
],
+ 'example' => '',
],
],
500 => [],
@@ -12405,17 +8014,30 @@
.' }'."\n"
.' ]'."\n"
.'```'."\n",
- ],
- 'ListDataSourceTasks' => [
- 'summary' => 'Displays data source tasks.',
- 'path' => '/openapi/ha3/instances/{instanceId}/data-source-tasks',
- 'methods' => [
- 'get',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListClusterTasks'],
+ ],
],
- 'schemes' => [
- 'http',
- 'https',
+ 'ramActions' => [
+ [
+ 'operationType' => 'list',
+ 'ramAction' => [
+ 'action' => 'searchengine:ListClusterTasks',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SearchEngine', 'resourceType' => 'Instance', 'arn' => 'acs:searchengine:{#regionId}:{#accountId}:instance/{#InstanceId}'],
+ ],
+ ],
+ ],
],
+ ],
+ 'ListClusters' => [
+ 'path' => '/openapi/ha3/instances/{instanceId}/clusters',
+ 'methods' => ['get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
@@ -12425,158 +8047,423 @@
'deprecated' => false,
'systemTags' => [
'operationType' => 'list',
+ 'abilityTreeCode' => '103715',
+ 'abilityTreeNodes' => ['FEATUREopensearch5EAGY5'],
],
'parameters' => [
[
'name' => 'instanceId',
'in' => 'path',
+ 'schema' => ['description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'example' => 'ha-cn-pl32rf0****', 'title' => ''],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
'schema' => [
- 'title' => '实例ID',
- 'description' => 'The instance ID.'."\n",
- 'type' => 'string',
- 'required' => true,
- 'example' => 'ha-cn-7e22rof5304',
+ 'description' => 'The response parameters.',
+ 'type' => 'object',
+ 'properties' => [
+ 'requestId' => ['title' => '', 'description' => 'id of request', 'type' => 'string', 'example' => 'F43E8AB4-419C-5F4C-90D6-615590DFAA3C'],
+ 'result' => [
+ 'title' => '',
+ 'description' => 'The clusters.',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'The list of clusters.',
+ 'type' => 'object',
+ 'properties' => [
+ 'name' => ['description' => 'The cluster name.', 'type' => 'string', 'title' => '', 'example' => 'hz_pre_vpc_domain_1'],
+ 'description' => ['description' => 'The description of the cluster.', 'type' => 'string', 'example' => 'Custom description', 'title' => ''],
+ 'currentAdvanceConfigVersion' => ['description' => 'The effective advanced configuration version.', 'type' => 'string', 'title' => '', 'example' => 'ha-cn-pl32rf0****_offline_adv_v1'],
+ 'latestAdvanceConfigVersion' => ['description' => 'The latest advanced configuration version.', 'type' => 'string', 'title' => '', 'example' => 'ha-cn-pl32rf0****_offline_adv_v1'],
+ 'currentOnlineConfigVersion' => ['description' => 'The effective online configuration version.', 'type' => 'string', 'title' => '', 'example' => 'ha-cn-pl32rf0****_offline_adv_v1'],
+ 'latestOnlineConfigVersion' => ['description' => 'The latest online configuration version.', 'type' => 'string', 'title' => '', 'example' => 'ha-cn-pl32rf0****_offline_adv_v1'],
+ 'currentOnlineQueryConfigVersion' => ['description' => 'The effective query configuration version.', 'type' => 'string', 'title' => '', 'example' => 'ha-cn-pl32rf0****_offline_adv_v1'],
+ 'latestOnlineQueryConfigVersion' => ['description' => 'The latest query configuration version.', 'type' => 'string', 'title' => '', 'example' => 'ha-cn-pl32rf0****_offline_adv_v1'],
+ 'currentOfflineDictConfigVersion' => ['description' => 'The effective dictionary configuration version.', 'type' => 'string', 'title' => '', 'example' => 'ha-cn-pl32rf0****_offline_adv_v1'],
+ 'latestOfflineDictConfigVersion' => ['description' => 'The latest dictionary configuration version.', 'type' => 'string', 'title' => '', 'example' => 'ha-cn-pl32rf0****_offline_adv_v1'],
+ 'configUpdateTime' => ['description' => 'The time when the configuration was updated.', 'type' => 'string', 'title' => '', 'example' => '2024-05-21 16:05:26'],
+ 'status' => ['description' => 'The cluster status. Valid values: running: The cluster is running. starting: The cluster is being started. stopping: The cluster is being stopped. stopped: The cluster is stopped.', 'type' => 'string', 'example' => 'running', 'title' => ''],
+ 'queryNode' => [
+ 'title' => '',
+ 'description' => 'The information about Query Result Searcher (QRS) workers.',
+ 'type' => 'object',
+ 'properties' => [
+ 'name' => ['description' => 'The name of the QRS worker.', 'type' => 'string', 'title' => '', 'example' => 'ha-cn-pl32rf0****_qrs'],
+ 'number' => ['description' => 'The number of QRS workers.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '1'],
+ 'partition' => ['description' => 'The ID of the partition that is stored on the QRS worker.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '1'],
+ ],
+ 'example' => '',
+ ],
+ 'dataNode' => [
+ 'title' => '',
+ 'description' => 'The information about Searcher workers.',
+ 'type' => 'object',
+ 'properties' => [
+ 'name' => ['description' => 'The name of the Searcher worker.', 'type' => 'string', 'title' => '', 'example' => 'general'],
+ 'number' => ['description' => 'The number of Searcher workers.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '1'],
+ 'partition' => ['description' => 'The ID of the partition that is stored on the Searcher worker.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '1'],
+ ],
+ 'example' => '',
+ ],
+ 'createTime' => ['description' => 'The time when the cluster was created.', 'type' => 'string', 'example' => '2024-05-21 16:05:26', 'title' => ''],
+ 'config' => [
+ 'description' => 'The configuration information.',
+ 'type' => 'object',
+ 'additionalProperties' => [
+ 'type' => 'object',
+ 'additionalProperties' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'name' => ['description' => 'The configuration name.', 'type' => 'string', 'example' => 'ha-cn-pl32rf0****_offline_adv_v1', 'title' => ''],
+ 'updateTime' => ['description' => 'The time when the configuration was updated.', 'type' => 'string', 'example' => '2024-05-21 16:05:26', 'title' => ''],
+ 'desc' => ['description' => 'The description of the configuration.', 'type' => 'string', 'example' => '自定义描述', 'title' => ''],
+ ],
+ 'description' => 'The information about child configuration items.',
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'description' => 'The configuration information.',
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'title' => '',
+ 'example' => '',
+ ],
+ ],
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'example' => '',
+ ],
+ ],
+ 'title' => '',
+ 'example' => '',
],
],
+ 500 => [],
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"F43E8AB4-419C-5F4C-90D6-615590DFAA3C\\",\\n \\"result\\": [\\n {\\n \\"name\\": \\"hz_pre_vpc_domain_1\\",\\n \\"description\\": \\"Custom description\\",\\n \\"currentAdvanceConfigVersion\\": \\"ha-cn-pl32rf0****_offline_adv_v1\\",\\n \\"latestAdvanceConfigVersion\\": \\"ha-cn-pl32rf0****_offline_adv_v1\\",\\n \\"currentOnlineConfigVersion\\": \\"ha-cn-pl32rf0****_offline_adv_v1\\",\\n \\"latestOnlineConfigVersion\\": \\"ha-cn-pl32rf0****_offline_adv_v1\\",\\n \\"currentOnlineQueryConfigVersion\\": \\"ha-cn-pl32rf0****_offline_adv_v1\\",\\n \\"latestOnlineQueryConfigVersion\\": \\"ha-cn-pl32rf0****_offline_adv_v1\\",\\n \\"currentOfflineDictConfigVersion\\": \\"ha-cn-pl32rf0****_offline_adv_v1\\",\\n \\"latestOfflineDictConfigVersion\\": \\"ha-cn-pl32rf0****_offline_adv_v1\\",\\n \\"configUpdateTime\\": \\"2024-05-21 16:05:26\\",\\n \\"status\\": \\"running\\",\\n \\"queryNode\\": {\\n \\"name\\": \\"ha-cn-pl32rf0****_qrs\\",\\n \\"number\\": 1,\\n \\"partition\\": 1\\n },\\n \\"dataNode\\": {\\n \\"name\\": \\"general\\",\\n \\"number\\": 1,\\n \\"partition\\": 1\\n },\\n \\"createTime\\": \\"2024-05-21 16:05:26\\",\\n \\"config\\": {\\n \\"key\\": {\\n \\"key\\": {\\n \\"name\\": \\"ha-cn-pl32rf0****_offline_adv_v1\\",\\n \\"updateTime\\": \\"2024-05-21 16:05:26\\",\\n \\"desc\\": \\"自定义描述\\"\\n }\\n }\\n }\\n }\\n ]\\n}","type":"json"}]',
+ 'title' => 'ListClusters',
+ 'summary' => 'Queries clusters.',
+ 'description' => '### Method'."\n"
+ ."\n"
+ .'```java'."\n"
+ .'GET'."\n"
+ .'```'."\n"
+ ."\n"
+ .'### URI'."\n"
+ ."\n"
+ .'```java'."\n"
+ .'/openapi/ha3/instances/{instanceId}/clusters'."\n"
+ .'```',
+ 'requestParamsDescription' => '### Sample requests'."\n"
+ ."\n"
+ .'```java'."\n"
+ .'GET /openapi/ha3/instances/ha3_instance_name/clusters'."\n"
+ .'```',
+ 'responseParamsDescription' => '### ResponseExample'."\n"
+ ."\n"
+ .'Correct response'."\n"
+ ."\n"
+ .'```java'."\n"
+ .'{'."\n"
+ .' "requestId": "e1eef569-1ff7-4bf8-acf7-1cecca9894ce",'."\n"
+ .' "result": ['."\n"
+ .' {'."\n"
+ .' "name": "cluster1",'."\n"
+ .' "configUpdateTime": "2021-08-09 00:01:02",'."\n"
+ .' "currentAdvanceConfigVersion": "test_yyds_data1",'."\n"
+ .' "lastestAdvanceConfigVersion": "test_yyds_data1",'."\n"
+ .' "currentOnlineConfigVersion": "test_yyds_data1",'."\n"
+ .' "lastestOnlineConfigVersion": "test_yyds_data1", '."\n"
+ .' "description": "airecpre",'."\n"
+ .' "queryNode": {'."\n"
+ .' "number": 1'."\n"
+ .' },'."\n"
+ .' "dataNode": {'."\n"
+ .' "number": 2,'."\n"
+ .' "partition": 1'."\n"
+ .' }, '."\n"
+ .' },'."\n"
+ .' {'."\n"
+ .' "name": "cluster2",'."\n"
+ .' "configUpdateTime": "2021-08-09 00:01:02",'."\n"
+ .' "currentAdvanceConfigVersion": "test_yyds_data2",'."\n"
+ .' "lastestAdvanceConfigVersion": "test_yyds_data2",'."\n"
+ .' "currentOnlineConfigVersion": "test_yyds_data1",'."\n"
+ .' "lastestOnlineConfigVersion": "test_yyds_data1", '."\n"
+ .' "description": "this is descrition",'."\n"
+ .' "queryNode": {'."\n"
+ .' "number": 1'."\n"
+ .' },'."\n"
+ .' "dataNode": {'."\n"
+ .' "number": 2,'."\n"
+ .' "partition": 1'."\n"
+ .' }'."\n"
+ .' }'."\n"
+ .' ]'."\n"
+ .'}'."\n"
+ .'```',
+ 'extraInfo' => "\n"
+ ."\n\n"
+ ."\n",
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListClusters'],
+ ],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'list',
+ 'ramAction' => [
+ 'action' => 'searchengine:ListClusters',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SearchEngine', 'resourceType' => 'Instance', 'arn' => 'acs:searchengine:{#regionId}:{#accountId}:instance/{#InstanceId}'],
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'ListDataSourceSchemas' => [
+ 'summary' => 'Queries the schema information about a data source.',
+ 'path' => '/openapi/ha3/instances/{instanceId}/data-sources/{dataSourceName}/schemas',
+ 'methods' => ['get'],
+ 'schemes' => ['https', 'http'],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'read',
+ 'deprecated' => false,
+ 'systemTags' => ['operationType' => 'list'],
+ 'parameters' => [
+ [
+ 'name' => 'instanceId',
+ 'in' => 'path',
+ 'schema' => ['description' => 'The instance ID.'."\n", 'type' => 'string', 'required' => true, 'example' => 'ha-cn-pl32rf0****', 'title' => ''],
+ ],
+ [
+ 'name' => 'dataSourceName',
+ 'in' => 'path',
+ 'schema' => ['description' => 'The name of the data source.'."\n", 'type' => 'string', 'required' => true, 'example' => 'ha-cn-pl32rf0****_test_api', 'title' => ''],
+ ],
],
'responses' => [
200 => [
'schema' => [
- 'title' => 'Schema of Response',
- 'description' => 'The response parameters.'."\n",
+ 'description' => 'The results returned.'."\n",
'type' => 'object',
'properties' => [
- 'requestId' => [
- 'title' => 'id of request',
- 'description' => 'id of request'."\n",
- 'type' => 'string',
- 'example' => 'CC5EC8FA-5C0D-56AF-BEF4-6FCCEABD0511',
+ 'requestId' => ['title' => '', 'description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => '022F36C7-9FB4-5D67-BEBC-3D14B0984463'],
+ 'result' => [
+ 'title' => '',
+ 'description' => 'The results returned.'."\n",
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'The schema information.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'name' => ['title' => '', 'description' => 'The field name.'."\n", 'type' => 'string', 'example' => 'id'],
+ 'custom' => ['title' => '', 'description' => 'Indicates whether the field is a custom field. Valid values: **true** and **false**.'."\n", 'type' => 'boolean', 'example' => 'false'],
+ 'type' => ['title' => '', 'description' => 'The field type.'."\n", 'type' => 'string', 'example' => 'STRING'],
+ 'attribute' => ['description' => 'Indicates whether the field is an attribute field. Valid values: **true** and **false**.'."\n", 'type' => 'boolean', 'example' => 'false', 'title' => ''],
+ 'summary' => ['title' => '', 'description' => 'Indicates whether the field can be displayed. Valid values: **true** and **false**.'."\n", 'type' => 'boolean', 'example' => 'false'],
+ 'primaryKey' => [
+ 'title' => '',
+ 'description' => 'The primary key field.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'isPrimaryKey' => ['description' => 'Indicates whether the field is the primary key. Valid values: **true** and **false**.'."\n", 'type' => 'boolean', 'example' => 'false', 'title' => ''],
+ 'hasPrimaryKeyAttribute' => ['description' => 'Indicates whether the field has the primary key attribute. Valid values: **true** and **false**.'."\n", 'type' => 'boolean', 'example' => 'false', 'title' => ''],
+ 'isPrimaryKeySorted' => ['description' => 'Indicates whether the field can be sorted. Valid values: **true** and **false**.'."\n", 'type' => 'boolean', 'example' => 'false', 'title' => ''],
+ ],
+ 'example' => '',
+ ],
+ 'addIndex' => ['title' => '', 'description' => 'Indicates whether the field has the index attribute. Valid values: **true** and **false**.'."\n", 'type' => 'boolean', 'example' => 'false'],
+ ],
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'example' => '',
],
+ ],
+ 'title' => '',
+ 'example' => '',
+ ],
+ ],
+ 500 => [],
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"022F36C7-9FB4-5D67-BEBC-3D14B0984463\\",\\n \\"result\\": [\\n {\\n \\"name\\": \\"id\\",\\n \\"custom\\": false,\\n \\"type\\": \\"STRING\\",\\n \\"attribute\\": false,\\n \\"summary\\": false,\\n \\"primaryKey\\": {\\n \\"isPrimaryKey\\": false,\\n \\"hasPrimaryKeyAttribute\\": false,\\n \\"isPrimaryKeySorted\\": false\\n },\\n \\"addIndex\\": false\\n }\\n ]\\n}","type":"json"}]',
+ 'title' => 'ListDataSourceSchemas',
+ 'description' => '## Method'."\n"
+ ."\n"
+ .'`GET`'."\n"
+ ."\n"
+ .'## URI'."\n"
+ ."\n"
+ .'`/openapi/ha3/instances/{instanceId}/data-sources/{dataSourceName}/schemas`'."\n",
+ 'requestParamsDescription' => '## Sample requests'."\n"
+ ."\n"
+ .'`GET /openapi/ha3/instances/ha3_instances_id/data-sources/my_data_source/schemas`'."\n",
+ 'responseParamsDescription' => '## Sample responses'."\n"
+ ."\n"
+ .'### Success responses'."\n"
+ ."\n"
+ .'```json'."\n"
+ .'{'."\n"
+ .' "requestId": "0A6EB64B-B4C8-CF02-810F-E660812972FF",'."\n"
+ .' "result":['."\n"
+ .' {'."\n"
+ .' "summary": false,'."\n"
+ .' "custom": false,'."\n"
+ .' "addIndex": false,'."\n"
+ .' "type": "INT64",'."\n"
+ .' "name": "id",'."\n"
+ .' "attribute": false,'."\n"
+ .' "primaryKey": {'."\n"
+ .' "hasPrimaryKeyAttribute": false,'."\n"
+ .' "primaryKeySorted": false,'."\n"
+ .' "primaryKey": false'."\n"
+ .' }'."\n"
+ .' },'."\n"
+ .' {'."\n"
+ .' "summary": false,'."\n"
+ .' "custom": false,'."\n"
+ .' "addIndex": false,'."\n"
+ .' "type": "STRING",'."\n"
+ .' "name": "fb_boolean",'."\n"
+ .' "attribute": false,'."\n"
+ .' "primaryKey": {'."\n"
+ .' "hasPrimaryKeyAttribute": false,'."\n"
+ .' "primaryKeySorted": false,'."\n"
+ .' "primaryKey": false'."\n"
+ .' }'."\n"
+ .' }'."\n"
+ .' ]'."\n"
+ .'}'."\n"
+ .'```'."\n",
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListDataSourceSchemas'],
+ ],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'list',
+ 'ramAction' => [
+ 'action' => 'searchengine:ListDataSourceSchemas',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SearchEngine', 'resourceType' => 'Instance', 'arn' => 'acs:searchengine:{#regionId}:{#accountId}:instance/{#instanceId}'],
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'ListDataSourceTasks' => [
+ 'summary' => 'Displays data source tasks.',
+ 'path' => '/openapi/ha3/instances/{instanceId}/data-source-tasks',
+ 'methods' => ['get'],
+ 'schemes' => ['http', 'https'],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'read',
+ 'deprecated' => false,
+ 'systemTags' => ['operationType' => 'list'],
+ 'parameters' => [
+ [
+ 'name' => 'instanceId',
+ 'in' => 'path',
+ 'schema' => ['title' => '', 'description' => 'The instance ID.'."\n", 'type' => 'string', 'required' => true, 'example' => 'ha-cn-pl32rf0****'],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'title' => '',
+ 'description' => 'The response parameters.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'requestId' => ['title' => '', 'description' => 'id of request'."\n", 'type' => 'string', 'example' => 'CC5EC8FA-5C0D-56AF-BEF4-6FCCEABD0511'],
'result' => [
- 'title' => '索引信息',
+ 'title' => '',
'description' => 'The index information.'."\n",
'type' => 'array',
'items' => [
'description' => 'The result returned by data search.'."\n",
'type' => 'object',
'properties' => [
- 'groupType' => [
- 'title' => '变更分组类型',
- 'description' => 'The change group type.'."\n",
- 'type' => 'string',
- 'example' => '" "',
- ],
- 'fsmId' => [
- 'title' => 'fsmId',
- 'description' => 'The ID of the finite state machine (FSM).'."\n",
- 'type' => 'string',
- 'example' => 'tisplus_opensearch@datasource_flow_fsm@1062017779051424-ha-cn-2r42ostoc01_ecom_table@vpc_hz_domain_1@null@MANUAL-ha-cn-2r42ostoc01_ecom_table@1655974525756@006754',
- ],
- 'name' => [
- 'title' => '卡片的名字',
- 'description' => 'The card name.'."\n",
- 'type' => 'string',
- 'example' => 'general',
- ],
- 'time' => [
- 'title' => '卡片的时间戳',
- 'description' => 'The timestamp of the card.'."\n",
- 'type' => 'string',
- 'example' => '1646279473',
- ],
- 'type' => [
- 'title' => '卡片的类型',
- 'description' => 'The card type.'."\n",
- 'type' => 'string',
- 'example' => 'search',
- ],
- 'user' => [
- 'title' => '触发生成fsm流程的用户',
- 'description' => 'The user who triggered the generation of the FSM process.'."\n",
- 'type' => 'string',
- 'example' => '""',
- ],
- 'status' => [
- 'title' => 'FSM整体状态',
- 'description' => 'The FSM status.'."\n",
- 'type' => 'string',
- 'example' => '2',
- ],
- 'extraAttribute' => [
- 'title' => '卡片的额外属性',
- 'description' => 'The additional attributes of the card.'."\n",
- 'type' => 'string',
- 'example' => '""',
- ],
- 'field3' => [
- 'title' => '创建状态机时透传的field3字段',
- 'description' => 'The field3 field that was passed when the FSM was created.'."\n",
- 'type' => 'string',
- 'example' => '""',
- ],
+ 'groupType' => ['title' => '', 'description' => 'The change group type.'."\n", 'type' => 'string', 'example' => 'Table_Update'],
+ 'fsmId' => ['title' => '', 'description' => 'The ID of the finite state machine (FSM).'."\n", 'type' => 'string', 'example' => 'tisplus_opensearch@datasource_flow_fsm@1865410598556969-ha-cn-pl32rf0****_api2@bj_vpc_domain_1@null@MANUAL-ha-cn-pl32rf0****_api2@1649729867698@028315'],
+ 'name' => ['title' => '', 'description' => 'The card name.'."\n", 'type' => 'string', 'example' => 'ha-cn-pl32rf0****_qrs'."\n"],
+ 'time' => ['title' => '', 'description' => 'The timestamp of the card.'."\n", 'type' => 'string', 'example' => '1646279473'],
+ 'type' => ['title' => '', 'description' => 'The card type.'."\n", 'type' => 'string', 'example' => 'mra_table_config_trace_fsm'."\n"],
+ 'user' => ['title' => '', 'description' => 'The user who triggered the generation of the FSM process.'."\n", 'type' => 'string', 'example' => 'admin'],
+ 'status' => ['title' => '', 'description' => 'The FSM status.'."\n", 'type' => 'string', 'example' => 'onlyPublished'],
+ 'extraAttribute' => ['title' => '', 'description' => 'The additional attributes of the card.'."\n", 'type' => 'string', 'example' => '{'."\n"
+ .' "consoleVersion": "",'."\n"
+ .' "domain": "hz_pre_vpc_domain_1",'."\n"
+ .' "configType": "offline"'."\n"
+ .'}'],
+ 'field3' => ['title' => '', 'description' => 'The field3 field that was passed when the FSM was created.'."\n", 'type' => 'string', 'example' => '{'."\n"
+ .' "ha-cn-pl32rf0****_offline_adv": 1,'."\n"
+ .' "ha-cn-pl32rf0****_offline_plugin": 1,'."\n"
+ .' "ha-cn-pl32rf0****_table_ha-cn-35t3r02iq03_test_api": 1,'."\n"
+ .' "ha-cn-pl32rf0****@ha-cn-pl32rf0****_test_api@hz_pre_vpc_domain_1@test_api@index_config": 1,'."\n"
+ .' "ha-cn-pl32rf0****_offline_dict": 1'."\n"
+ .'}'."\n"],
'tags' => [
- 'title' => '进度条的状态标签',
+ 'title' => '',
'description' => 'The tags of the progress bar.'."\n",
'type' => 'array',
'items' => [
'description' => 'The tag of the data source.'."\n",
'type' => 'object',
'properties' => [
- 'tagLevel' => [
- 'title' => '展示tag的等级',
- 'description' => 'The tag level.'."\n",
- 'type' => 'string',
- 'example' => '""',
- ],
- 'msg' => [
- 'title' => '展示tag内容',
- 'description' => 'The tag content.'."\n",
- 'type' => 'string',
- 'example' => 'succeed in handling request',
- ],
+ 'tagLevel' => ['title' => '', 'description' => 'The tag level.'."\n", 'type' => 'string', 'example' => '1'],
+ 'msg' => ['title' => '', 'description' => 'The tag content.'."\n", 'type' => 'string', 'example' => 'test-tag'],
],
+ 'title' => '',
+ 'example' => '',
],
+ 'example' => '',
],
'taskNodes' => [
- 'title' => '任务信息',
+ 'title' => '',
'description' => 'The task information.'."\n",
'type' => 'array',
'items' => [
'description' => 'The information about the nodes of the task.'."\n",
'type' => 'object',
'properties' => [
- 'name' => [
- 'title' => '任务名称',
- 'description' => 'The task name.'."\n",
- 'type' => 'string',
- 'example' => 'ha-cn-7pp2ngv4s02_qrs',
- ],
- 'index' => [
- 'title' => '此任务的序号',
- 'description' => 'The ordinal number of the task.'."\n",
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '100',
- ],
- 'finishDate' => [
- 'title' => '完成日期',
- 'description' => 'The time when the task was complete.'."\n",
- 'type' => 'string',
- 'example' => '""',
- ],
- 'status' => [
- 'title' => '任务状态',
- 'description' => 'The task status.'."\n",
- 'type' => 'string',
- 'example' => 'onlyPublished',
- ],
+ 'name' => ['title' => '', 'description' => 'The task name.'."\n", 'type' => 'string', 'example' => 'publish config version'."\n"],
+ 'index' => ['title' => '', 'description' => 'The ordinal number of the task.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '4'],
+ 'finishDate' => ['title' => '', 'description' => 'The time when the task was complete.'."\n", 'type' => 'string', 'example' => '2024-06-17 18:40:48'."\n"],
+ 'status' => ['title' => '', 'description' => 'The task status.'."\n", 'type' => 'string', 'example' => 'SUCCESS'],
],
+ 'title' => '',
+ 'example' => '',
],
+ 'example' => '',
],
],
+ 'title' => '',
+ 'example' => '',
],
+ 'example' => '',
],
],
+ 'example' => '',
],
],
500 => [],
@@ -12741,211 +8628,513 @@
.' }'."\n"
.' ]'."\n"
.'```'."\n",
- ],
- 'StopTask' => [
- 'summary' => 'Stops an FSM task.',
- 'path' => '/openapi/ha3/instances/{instanceId}/stop-task/{fsmId}',
- 'methods' => [
- 'put',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListDataSourceTasks'],
+ ],
],
- 'schemes' => [
- 'http',
- 'https',
+ 'ramActions' => [
+ [
+ 'operationType' => 'list',
+ 'ramAction' => [
+ 'action' => 'searchengine:ListDataSourceTasks',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SearchEngine', 'resourceType' => 'Instance', 'arn' => 'acs:searchengine:{#regionId}:{#accountId}:instance/{#InstanceId}'],
+ ],
+ ],
+ ],
],
+ ],
+ 'ListDataSources' => [
+ 'summary' => 'Obtains the list of data sources.',
+ 'path' => '/openapi/ha3/instances/{instanceId}/data-sources',
+ 'methods' => ['get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
- 'operationType' => 'write',
+ 'operationType' => 'read',
'deprecated' => false,
- 'systemTags' => [],
+ 'systemTags' => ['operationType' => 'list'],
'parameters' => [
[
'name' => 'instanceId',
'in' => 'path',
+ 'schema' => ['description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'example' => 'ha-cn-pl32rf0****', 'title' => ''],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
'schema' => [
- 'description' => 'The instance ID.'."\n",
- 'type' => 'string',
- 'required' => true,
- 'example' => 'ha-cn-7mz2nx41h01',
+ 'description' => 'The response parameters.',
+ 'type' => 'object',
+ 'properties' => [
+ 'requestId' => ['title' => '', 'description' => 'The ID of the request.', 'type' => 'string', 'example' => '93A9E542-8CF8-5BA6-99AB-94C0FE520429'],
+ 'result' => [
+ 'title' => '',
+ 'description' => 'The results returned.',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'The list of data source information.',
+ 'type' => 'object',
+ 'properties' => [
+ 'name' => ['description' => 'The name of the data source.', 'type' => 'string', 'title' => '', 'example' => 'ha-cn-pl32rf0****_test_api'],
+ 'type' => ['description' => 'The type of the data source.', 'type' => 'string', 'title' => '', 'example' => 'odps'],
+ 'domain' => ['description' => 'The data center in which the data source is deployed.', 'type' => 'string', 'title' => '', 'example' => 'vpc_hz_domain_1'],
+ 'indexes' => [
+ 'title' => '',
+ 'description' => 'The indexes.',
+ 'type' => 'array',
+ 'items' => ['description' => 'The index of the data source.', 'type' => 'string', 'example' => 'index1', 'title' => ''],
+ 'example' => '',
+ ],
+ 'lastFulTime' => ['description' => 'The time when the full data of the data source was last queried.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '1718787785'],
+ 'status' => ['description' => 'The status of the data source. Valid values: new: The data source is being created. publish: The data source is in the normal state. trash: The data source is being deleted.', 'type' => 'string', 'title' => '', 'example' => 'new'],
+ ],
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'example' => '',
+ ],
+ ],
+ 'title' => '',
+ 'example' => '',
+ ],
+ ],
+ 500 => [],
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"93A9E542-8CF8-5BA6-99AB-94C0FE520429\\",\\n \\"result\\": [\\n {\\n \\"name\\": \\"ha-cn-pl32rf0****_test_api\\",\\n \\"type\\": \\"odps\\",\\n \\"domain\\": \\"vpc_hz_domain_1\\",\\n \\"indexes\\": [\\n \\"index1\\"\\n ],\\n \\"lastFulTime\\": 1718787785,\\n \\"status\\": \\"new\\"\\n }\\n ]\\n}","type":"json"}]',
+ 'title' => 'ListDataSources',
+ 'description' => '## Method'."\n"
+ ."\n"
+ .'`GET`'."\n"
+ ."\n"
+ .'## URI'."\n"
+ ."\n"
+ .'`/openapi/ha3/instances/{instanceId}/data-sources`',
+ 'requestParamsDescription' => '## Sample requests'."\n"
+ ."\n"
+ .'`GET /openapi/ha3/instances/ha3_instances_id/data-sources`',
+ 'responseParamsDescription' => '## ResponseExample'."\n"
+ ."\n"
+ .'### Correct response'."\n"
+ ."\n"
+ .'```json'."\n"
+ .'{'."\n"
+ .' "requestId": "0A6EB64B-B4C8-CF02-810F-E660812972FF",'."\n"
+ .' "result": ['."\n"
+ .' {'."\n"
+ .' "name": "data_source_name",'."\n"
+ .' "type": "odps",'."\n"
+ .' "domain": "test", // Offline deployment'."\n"
+ .' "indexes": ['."\n"
+ .' "index1",'."\n"
+ .' "index2"'."\n"
+ .' ],'."\n"
+ .' "partitions": ['."\n"
+ .' "ds=2020"'."\n"
+ .' "ds=2021"'."\n"
+ .' ],'."\n"
+ .' "lastFullTime": 1628502036000,'."\n"
+ .' "config":{'."\n"
+ .' "accessKey": "xxx",'."\n"
+ .' "accessSecret": "xxxs",'."\n"
+ .' "project":"xxxx",'."\n"
+ .' "table":"xxx",'."\n"
+ .' "partition":"xxxx"'."\n"
+ .' },'."\n"
+ .' "autoBuildIndex": true,'."\n"
+ .' "status": "new" // new: Createin; publish: normal; trash: Deletein'."\n"
+ .' },'."\n"
+ .' {'."\n"
+ .' "name": "data_source_name",'."\n"
+ .' "type": "odps",'."\n"
+ .' "domain": "test", // Offline deployment '."\n"
+ .' "indexes": ['."\n"
+ .' "index1",'."\n"
+ .' "index2"'."\n"
+ .' ],'."\n"
+ .' "partitions": ['."\n"
+ .' "ds=2020"'."\n"
+ .' "ds=2021"'."\n"
+ .' ],'."\n"
+ .' "lastFullTime": 1628502036000,'."\n"
+ .' "config":{'."\n"
+ .' "accessKey": "xxx",'."\n"
+ .' "accessSecret": "xxxs",'."\n"
+ .' "project":"xxxx",'."\n"
+ .' "table":"xxx",'."\n"
+ .' "partition":"xxxx"'."\n"
+ .' },'."\n"
+ .' "autoBuildIndex": true,'."\n"
+ .' "status": "new" // new: Createin; publish: normal; trash: Deletein'."\n"
+ .' }'."\n"
+ .' ]'."\n"
+ .'}'."\n"
+ .'```',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'list',
+ 'ramAction' => [
+ 'action' => 'searchengine:ListDataSources',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SearchEngine', 'resourceType' => 'Instance', 'arn' => 'acs:searchengine:{#regionId}:{#accountId}:instance/{#InstanceId}'],
+ ],
],
],
+ ],
+ ],
+ 'ListDatabases' => [
+ 'path' => '/openapi/ha3/instances/{instanceId}/sql-studio/databases',
+ 'methods' => ['get'],
+ 'schemes' => ['https', 'http'],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'read',
+ 'deprecated' => false,
+ 'systemTags' => ['operationType' => 'list'],
+ 'parameters' => [
[
- 'name' => 'fsmId',
+ 'name' => 'instanceId',
'in' => 'path',
- 'schema' => [
- 'description' => 'The ID of the finite state machine (FSM).'."\n",
- 'type' => 'string',
- 'required' => true,
- 'example' => 'tisplus_opensearch@datasource_flow_fsm@1865410598556969-ha-cn-0ju2rrogr01_test_api_2@sz_vpc_domain_1@null@MANUAL-ha-cn-0ju2rrogr01_test_api_2@1657511220772@165343',
- ],
+ 'schema' => ['description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'ha-cn-pl32rf0****'],
],
],
'responses' => [
200 => [
'schema' => [
- 'title' => 'Schema of Response',
- 'description' => 'Schema of Response'."\n",
'type' => 'object',
'properties' => [
- 'requestId' => [
- 'title' => 'id of request',
- 'description' => 'id of request'."\n",
- 'type' => 'string',
- 'example' => 'FE03180A-0E29-5474-8A86-33F0683294A4',
- ],
+ 'requestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => 'E45380E8-994A-5402-9806-F114B3295FCF'],
'result' => [
- 'title' => '索引信息',
- 'description' => 'The information about the index'."\n",
+ 'title' => '',
+ 'description' => 'The returned result.',
'type' => 'object',
- 'example' => '{}',
+ 'properties' => [
+ 'databases' => [
+ 'description' => 'A list of databases.',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'A list of databases.',
+ 'type' => 'object',
+ 'properties' => [
+ 'database' => ['description' => 'The name of the database.', 'type' => 'string', 'title' => '', 'example' => 'general'],
+ 'sqlInstances' => [
+ 'description' => 'The information about the SQL instances.',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'The information about the SQL instances.',
+ 'type' => 'object',
+ 'properties' => [
+ 'id' => ['description' => 'The primary key ID.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '12190'],
+ 'name' => ['description' => 'The name of the SQL instance.', 'type' => 'string', 'title' => '', 'example' => 'general'],
+ 'type' => ['title' => '', 'description' => 'table, instance, template, function', 'type' => 'string', 'example' => 'instance'],
+ 'parent' => ['description' => 'The ID of the parent node.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '-1'],
+ 'children' => [
+ 'description' => 'The information about the subdirectories.',
+ 'type' => 'array',
+ 'items' => ['description' => 'The information about the subdirectories.', 'type' => 'any', 'title' => '', 'example' => '1'],
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'isDir' => ['description' => 'Indicates whether the item is a folder. A value of 1 indicates that the item is a folder. A value of 0 indicates that it is not a folder.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => 'true'],
+ 'instanceId' => ['description' => 'The instance ID.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '1'],
+ 'templateId' => ['description' => 'The template ID.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '1'],
+ ],
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'templates' => [
+ 'description' => 'The information about the templates.',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'The information about the template.',
+ 'type' => 'object',
+ 'properties' => [
+ 'id' => ['description' => 'The primary key ID.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '1'],
+ 'name' => ['description' => 'The name of the template.', 'type' => 'string', 'title' => '', 'example' => 'c26_schema'],
+ 'type' => ['title' => '', 'description' => 'table, instance, template, function', 'type' => 'string', 'example' => 'template'],
+ 'parent' => ['description' => 'The ID of the parent node.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '-1'],
+ 'children' => [
+ 'description' => 'The information about the subdirectories.',
+ 'type' => 'array',
+ 'items' => ['description' => 'The information about the subdirectories.', 'type' => 'any', 'title' => '', 'example' => '1'],
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'isDir' => ['description' => 'Indicates whether the item is a folder. A value of 1 indicates that the item is a folder. A value of 0 indicates that it is not a folder.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => 'true'],
+ 'instanceId' => ['description' => 'The instance ID.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '1'],
+ 'templateId' => ['description' => 'The template ID.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '1'],
+ ],
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'functions' => [
+ 'description' => 'The information about the functions.',
+ 'type' => 'object',
+ 'additionalProperties' => [
+ 'type' => 'array',
+ 'items' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'name' => ['type' => 'string', 'description' => 'The name of the function.', 'title' => '', 'example' => 'test'],
+ 'signatures' => ['type' => 'string', 'description' => 'The signature.', 'title' => '', 'example' => 'gfasdds2****2wfrkv'],
+ ],
+ 'description' => 'The information about the functions.',
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'description' => 'The information about the functions.',
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'tables' => [
+ 'description' => 'The information about the tables.',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'The information about the tables.',
+ 'type' => 'object',
+ 'properties' => [
+ 'id' => ['description' => 'The primary key ID.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '56'],
+ 'name' => ['description' => 'The name of the table.', 'type' => 'string', 'title' => '', 'example' => 'general'],
+ 'type' => ['title' => '', 'description' => 'table, instance, template, function', 'type' => 'string', 'example' => 'table'],
+ 'parent' => ['description' => 'The ID of the parent node.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '-1'],
+ 'children' => [
+ 'description' => 'The information about the subdirectories.',
+ 'type' => 'array',
+ 'items' => ['description' => 'The information about the subdirectories.', 'type' => 'any', 'title' => '', 'example' => '1'],
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'isDir' => ['description' => 'Indicates whether the item is a folder. A value of 1 indicates that the item is a folder. A value of 0 indicates that it is not a folder.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => 'true'],
+ 'instanceId' => ['description' => 'The instance ID.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '1'],
+ 'templateId' => ['description' => 'The template ID.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '1'],
+ ],
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'title' => '',
+ 'example' => '',
+ ],
+ ],
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'title' => '',
+ 'example' => '',
+ ],
+ ],
+ 'example' => '',
],
],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
],
500 => [],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"FE03180A-0E29-5474-8A86-33F0683294A4\\",\\n \\"result\\": {}\\n}","type":"json"}]',
- 'title' => 'StopTask',
- 'description' => '### [](#)Method'."\n"
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"E45380E8-994A-5402-9806-F114B3295FCF\\",\\n \\"result\\": {\\n \\"databases\\": [\\n {\\n \\"database\\": \\"general\\",\\n \\"sqlInstances\\": [\\n {\\n \\"id\\": 12190,\\n \\"name\\": \\"general\\",\\n \\"type\\": \\"instance\\",\\n \\"parent\\": -1,\\n \\"children\\": [\\n \\"1\\"\\n ],\\n \\"isDir\\": 0,\\n \\"instanceId\\": 1,\\n \\"templateId\\": 1\\n }\\n ],\\n \\"templates\\": [\\n {\\n \\"id\\": 1,\\n \\"name\\": \\"c26_schema\\",\\n \\"type\\": \\"template\\",\\n \\"parent\\": -1,\\n \\"children\\": [\\n \\"1\\"\\n ],\\n \\"isDir\\": 0,\\n \\"instanceId\\": 1,\\n \\"templateId\\": 1\\n }\\n ],\\n \\"functions\\": {\\n \\"key\\": [\\n {\\n \\"name\\": \\"test\\",\\n \\"signatures\\": \\"gfasdds2****2wfrkv\\"\\n }\\n ]\\n },\\n \\"tables\\": [\\n {\\n \\"id\\": 56,\\n \\"name\\": \\"general\\",\\n \\"type\\": \\"table\\",\\n \\"parent\\": -1,\\n \\"children\\": [\\n \\"1\\"\\n ],\\n \\"isDir\\": 0,\\n \\"instanceId\\": 1,\\n \\"templateId\\": 1\\n }\\n ]\\n }\\n ]\\n }\\n}","type":"json"}]',
+ 'title' => 'ListDatabases',
+ 'summary' => 'Lists the existing databases.',
+ 'description' => '### Method'."\n"
."\n"
.'```java'."\n"
- .'PUT'."\n"
+ .'GET'."\n"
.'```'."\n"
."\n"
- .'### [](#uri)URI'."\n"
- ."\n"
- .'```java'."\n"
- .'/openapi/ha3/instances/{instanceId}/stop-task/{fsmId}'."\n"
- .'```'."\n",
- 'requestParamsDescription' => '### Sample requests'."\n"
- ."\n"
- .'```java'."\n"
- .'PUT /openapi/ha3/instances/{instanceId}/stop-task/tisplus_opensearch@add_index_config@1062017779051424-ha-cn-0ju2i0e5z01_mx1228@null@index_11@null@1641282725526@607017'."\n"
- .'```'."\n",
- 'responseParamsDescription' => '### [](#)Sample responses'."\n"
- ."\n"
- .'Sample success responses'."\n"
+ .'### URI'."\n"
."\n"
.'```java'."\n"
- .'{'."\n"
- .' '."\n"
- .' "requestId": "0A6EB64B-B4C8-CF02-810F-E660812972FF",'."\n"
- .' '."\n"
- .' "result": []'."\n"
- .' '."\n"
- .'}'."\n"
- .'```'."\n"
- ."\n"
- .'For more information, see [Response structure](~~465311~~).'."\n",
- ],
- 'ForceSwitch' => [
- 'summary' => 'Performs a forced switchover.',
- 'path' => '/openapi/ha3/instances/{instanceId}/force-switch/{fsmId}',
- 'methods' => [
- 'put',
+ .'/openapi/ha3/instances/{instanceId}/sql-studio/databases'."\n"
+ .'```',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListDatabases'],
+ ],
],
- 'schemes' => [
- 'http',
- 'https',
+ 'ramActions' => [
+ [
+ 'operationType' => 'list',
+ 'ramAction' => [
+ 'action' => 'searchengine:ListDatabases',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SearchEngine', 'resourceType' => 'Instance', 'arn' => 'acs:searchengine:{#regionId}:{#accountId}:instance/{#instanceId}'],
+ ],
+ ],
+ ],
],
+ ],
+ 'ListDateSourceGenerations' => [
+ 'path' => '/openapi/ha3/instances/{instanceId}/data-sources/{dataSourceName}/generations',
+ 'methods' => ['get'],
+ 'schemes' => ['https', 'http'],
'security' => [
[
'AK' => [],
],
],
+ 'operationType' => 'read',
'deprecated' => false,
- 'systemTags' => [],
+ 'systemTags' => ['operationType' => 'list'],
'parameters' => [
[
'name' => 'instanceId',
'in' => 'path',
- 'schema' => [
- 'description' => 'The instance ID.'."\n",
- 'type' => 'string',
- 'required' => true,
- 'example' => 'ha-cn-tl32m2c4u01',
- ],
+ 'schema' => ['description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'example' => 'ha-cn-pl32rf0****', 'title' => ''],
],
[
- 'name' => 'fsmId',
+ 'name' => 'dataSourceName',
'in' => 'path',
- 'schema' => [
- 'description' => 'The task ID.'."\n",
- 'type' => 'string',
- 'required' => true,
- 'example' => 'tisplus_opensearch@roll_index_fsm@ha-cn-0ju2je4zj01@bj_vpc_domain_2@null@bj_vpc_domain_2_general_odps_false@1644312508597@934743',
- ],
+ 'schema' => ['description' => 'The name of the data source.', 'type' => 'string', 'required' => true, 'example' => 'ha-cn-pl32rf0****_test_api', 'title' => ''],
+ ],
+ [
+ 'name' => 'validStatus',
+ 'in' => 'query',
+ 'schema' => ['description' => 'Specifies the index versions to be returned. Valid values:'."\n"
+ ."\n"
+ .'1. true (default): returns the index versions that are complete and not expired.'."\n"
+ ."\n"
+ .'2. false: returns all index versions.', 'type' => 'boolean', 'default' => 'true', 'required' => false, 'example' => 'true', 'title' => ''],
+ ],
+ [
+ 'name' => 'domainName',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The data center where the data source is deployed.', 'type' => 'string', 'required' => true, 'example' => 'bj_vpc_domain_1', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
- 'title' => 'Schema of Response',
- 'description' => 'The response parameters.'."\n",
'type' => 'object',
'properties' => [
- 'requestId' => [
- 'title' => 'id of request',
- 'description' => 'The request ID.'."\n",
- 'type' => 'string',
- 'example' => '0B1FF998-BB8D-5182-BFC0-E471AA77095A',
- ],
+ 'requestId' => ['title' => '', 'description' => 'id of request', 'type' => 'string', 'example' => '022F36C7-9FB4-5D67-BEBC-3D14B0984463'],
'result' => [
- 'title' => '索引信息',
- 'description' => 'The index information.'."\n",
- 'type' => 'object',
- 'example' => '{}',
+ 'title' => '',
+ 'description' => 'List',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'The result returned.',
+ 'type' => 'object',
+ 'properties' => [
+ 'generation' => ['description' => 'The ID of the full index version.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '1626143930'],
+ 'createTime' => ['description' => 'The timestamp that was generated when the index building was started.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '1626143673'],
+ 'status' => ['description' => 'The status of the index version.', 'type' => 'string', 'title' => '', 'example' => 'STOPPED'],
+ 'buildDeployId' => ['title' => '', 'description' => 'The ID of the offline deployment.', 'type' => 'integer', 'format' => 'int32', 'example' => '122'],
+ 'partition' => [
+ 'title' => '',
+ 'description' => 'The shards of the index version. The value is a key-value pair in which the key indicates the index name and the value indicates the number of shards. The number of value shards.',
+ 'type' => 'object',
+ 'additionalProperties' => ['description' => 'The number of shards.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''],
+ 'example' => '',
+ ],
+ 'timestamp' => ['description' => 'The start timestamp from which incremental data is retrieved.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '1626143673'],
+ 'dataDumpRoot' => ['description' => 'The path of the dumped index in the Apsara File Storage for HDFS file system.', 'type' => 'string', 'title' => '', 'example' => 'hdfs://opensearch/dump.json'],
+ ],
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'example' => '',
],
],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
],
500 => [],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"0B1FF998-BB8D-5182-BFC0-E471AA77095A\\",\\n \\"result\\": {}\\n}","type":"json"}]',
- 'title' => 'ForceSwitch',
- 'description' => '### [](#)Method'."\n"
- ."\n"
- .'```java'."\n"
- .'PUT'."\n"
- .'```'."\n"
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"022F36C7-9FB4-5D67-BEBC-3D14B0984463\\",\\n \\"result\\": [\\n {\\n \\"generation\\": 1626143930,\\n \\"createTime\\": 1626143673,\\n \\"status\\": \\"STOPPED\\",\\n \\"buildDeployId\\": 122,\\n \\"partition\\": {\\n \\"key\\": 1\\n },\\n \\"timestamp\\": 1626143673,\\n \\"dataDumpRoot\\": \\"hdfs://opensearch/dump.json\\"\\n }\\n ]\\n}","type":"json"}]',
+ 'title' => 'ListDateSourceGenerations',
+ 'summary' => 'Queries the historical index versions of a data source.',
+ 'description' => '### Method'."\n"
."\n"
- .'### [](#uri)URI'."\n"
+ .'`GET`'."\n"
."\n"
- .'```java'."\n"
- .'/openapi/ha3/instances/{instanceId}/force-switch/{fsmId}'."\n"
- .'```'."\n",
- 'requestParamsDescription' => '### [](#)Sample requests'."\n"
+ .'### URI'."\n"
."\n"
- .'```java'."\n"
- .'PUT /openapi/ha3/instances/{instanceId}/force-switch/tisplus_opensearch@add_index_config@106201777905****-ha-cn-0ju2i0e****_mx1228@null@index_11@null@164128272****@607017'."\n"
- .'```'."\n",
- 'responseParamsDescription' => '### Sample responses'."\n"
+ .'`/openapi/ha3/instances/{instanceId}/data-sources/{dataSourceName}/generations?domainName={domainName}`',
+ 'requestParamsDescription' => '### Sample requests'."\n"
."\n"
- .'Success responses '."\n"
+ .'`GET /openapi/ha3/instances/ha3_instances_id/data-sources/my_data_source/generations??domainName=pre_domain_1`',
+ 'responseParamsDescription' => '### ResponseExample'."\n"
."\n"
- .'```java'."\n"
+ .'```'."\n"
.'{'."\n"
- .''."\n"
.' "requestId": "0A6EB64B-B4C8-CF02-810F-E660812972FF",'."\n"
- .''."\n"
- .' "result": []'."\n"
- .''."\n"
+ .' "result": ['."\n"
+ .' {'."\n"
+ .' "generationId":1626143930,'."\n"
+ .' "timestamp":16261436737,'."\n"
+ .' "createTime":1626143673,'."\n"
+ .' "status":"STOPPED",'."\n"
+ .' "partition":{'."\n"
+ .' "index1":1'."\n"
+ .' },'."\n"
+ .' "buildDeployId":122'."\n"
+ .' },{'."\n"
+ .' "generationId":1626143930,'."\n"
+ .' "timestamp":16261435453,'."\n"
+ .' "createTime":1626143673,'."\n"
+ .' "status":"STOPPED",'."\n"
+ .' "partition":{'."\n"
+ .' "index1":1'."\n"
+ .' },'."\n"
+ .' "buildDeployId":122'."\n"
+ .' }'."\n"
+ .' ]'."\n"
.'}'."\n"
- .'```'."\n"
- ."\n"
- .'For more information, see [Response struct](~~464322~~).',
- ],
- 'ListLogs' => [
- 'path' => '/openapi/ha3/instances/{instanceId}/logs',
- 'methods' => [
- 'get',
+ .'```',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListDateSourceGenerations'],
+ ],
],
- 'schemes' => [
- 'http',
- 'https',
+ 'ramActions' => [
+ [
+ 'operationType' => 'list',
+ 'ramAction' => [
+ 'action' => 'searchengine:ListDateSourceGenerations',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SearchEngine', 'resourceType' => 'Instance', 'arn' => 'acs:searchengine:{#regionId}:{#accountId}:instance/{#instanceId}'],
+ ],
+ ],
+ ],
],
+ ],
+ 'ListIndexRecoverRecords' => [
+ 'path' => '/openapi/ha3/instances/{instanceId}/indexes/{indexName}/actions/list-recover-records',
+ 'methods' => ['get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
@@ -12955,136 +9144,334 @@
'deprecated' => false,
'systemTags' => [
'operationType' => 'list',
- 'abilityTreeCode' => '223197',
- 'abilityTreeNodes' => [
- 'FEATUREopensearch0AT3OG',
- ],
+ 'abilityTreeCode' => '218752',
+ 'abilityTreeNodes' => ['FEATUREopensearchSLLBIN'],
],
'parameters' => [
[
+ 'name' => 'indexName',
+ 'in' => 'path',
+ 'schema' => ['description' => 'The index name.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'test_api'],
+ ],
+ [
'name' => 'instanceId',
'in' => 'path',
+ 'schema' => ['description' => 'The instance ID.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => 'ha-cn-pl32rf0****'],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
'schema' => [
- 'description' => 'The instance ID.'."\n",
- 'type' => 'string',
- 'required' => true,
- 'example' => 'ha-cn-i7m2roiy504',
+ 'type' => 'object',
+ 'properties' => [
+ 'generationId' => ['description' => 'The full index version.', 'type' => 'string', 'title' => '', 'example' => '1708674867'],
+ 'desc' => ['description' => 'The description.', 'type' => 'string', 'title' => '', 'example' => 'Custom Configuration'],
+ 'finishedTime' => ['description' => 'The time when the publish was completed.', 'type' => 'string', 'title' => '', 'example' => '2024-06-07 16:43:00'],
+ ],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
],
- [
- 'name' => 'type',
- 'in' => 'query',
- 'schema' => [
- 'title' => 'select: 查询日志, push: 写入日志',
- 'description' => '-push -select',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'push',
- 'default' => 'select',
+ 500 => [],
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"generationId\\": \\"1708674867\\",\\n \\"desc\\": \\"Custom Configuration\\",\\n \\"finishedTime\\": \\"2024-06-07 16:43:00\\"\\n}","type":"json"}]',
+ 'title' => 'ListIndexRecoverRecords',
+ 'summary' => 'Lists data recovery records.',
+ 'description' => '### Method'."\n"
+ ."\n"
+ .'```java'."\n"
+ .'GET'."\n"
+ .'```'."\n"
+ ."\n"
+ .'### URI'."\n"
+ ."\n"
+ .'```java'."\n"
+ .'/openapi/ha3/instances/{instanceId}/indexes/{indexName}/actions/list-recover-records'."\n"
+ .'```',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'list',
+ 'ramAction' => [
+ 'action' => 'searchengine:ListIndexRecoverRecords',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SearchEngine', 'resourceType' => 'Instance', 'arn' => 'acs:searchengine:{#regionId}:{#accountId}:instance/{#InstanceId}'],
+ ],
],
],
+ ],
+ ],
+ 'ListIndexes' => [
+ 'summary' => 'Retrieves a list of indexes.',
+ 'path' => '/openapi/ha3/instances/{instanceId}/indexes',
+ 'methods' => ['get'],
+ 'schemes' => ['http', 'https'],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'read',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'list',
+ 'abilityTreeCode' => '104683',
+ 'abilityTreeNodes' => ['FEATUREopensearchA944AC', 'FEATUREopensearchS8X6T8'],
+ ],
+ 'parameters' => [
[
- 'name' => 'pageNum',
- 'in' => 'query',
- 'schema' => [
- 'description' => 'The number of entries per num. Default value: 1.',
- 'type' => 'string',
- 'required' => false,
- 'example' => '1',
- ],
+ 'name' => 'instanceId',
+ 'in' => 'path',
+ 'schema' => ['description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'ha-cn-2r42ost****'],
],
[
- 'name' => 'pageSize',
+ 'name' => 'newMode',
'in' => 'query',
- 'schema' => [
- 'description' => 'The number of entries per page. Default value: 10.'."\n",
- 'type' => 'string',
- 'required' => false,
- 'example' => '10',
- ],
+ 'schema' => ['description' => 'Specifies whether to use the new version of the console page.', 'type' => 'boolean', 'required' => false, 'title' => '', 'example' => 'true'],
],
[
- 'name' => 'startTime',
+ 'name' => 'catalog',
'in' => 'query',
- 'schema' => [
- 'description' => 'The start time. The value is a timestamp in seconds.'."\n",
- 'type' => 'string',
- 'required' => false,
- 'example' => '1706340600',
- ],
+ 'schema' => ['type' => 'string', 'description' => 'The ID of the data catalog for the Data Lake Formation (DLF) data source.', 'required' => false, 'title' => '', 'example' => 'clg-paimon-765e9e2d43ab4fccbf095853a661eafc'],
],
[
- 'name' => 'endTime',
+ 'name' => 'database',
'in' => 'query',
- 'schema' => [
- 'description' => 'The end tim. The value is a timestamp in seconds.',
- 'type' => 'string',
- 'required' => false,
- 'example' => '1710432000',
- ],
+ 'schema' => ['type' => 'string', 'description' => 'The database of the DLF data source.', 'required' => false, 'title' => '', 'example' => 'dlf_test'],
],
[
- 'name' => 'query',
+ 'name' => 'table',
'in' => 'query',
- 'schema' => [
- 'description' => 'The query statement'."\n",
- 'type' => 'string',
- 'required' => false,
- 'example' => 'status: 200 AND totalTime > 0.01',
- ],
+ 'schema' => ['type' => 'string', 'description' => 'The data table of the DLF data source.', 'required' => false, 'title' => '', 'example' => 'rag'],
],
],
'responses' => [
200 => [
'schema' => [
+ 'description' => 'The returned result.',
'type' => 'object',
'properties' => [
- 'requestId' => [
- 'title' => 'id of request',
- 'description' => 'id of request',
- 'type' => 'string',
- 'example' => '022F36C7-9FB4-5D67-BEBC-3D14B0984463',
- ],
+ 'requestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '4FB0325E-8C37-5525-96AC-0333523170A3'],
'result' => [
- 'title' => 'ListResult',
- 'description' => 'ListResult',
- 'type' => 'object',
- 'properties' => [
- 'result' => [
- 'description' => 'The result.'."\n",
- 'type' => 'array',
- 'items' => [
- 'description' => 'query result',
- 'type' => 'any',
- 'example' => '[{"requestTime":"2024-07-02T16:06:57+08:00","totalTime":"0.003","requestId":"6d63e7a9b58a04827cfxxxxx","host":"ha-cn-xxx.ha.aliyuncs.com","requestUri":"/vector-service/fetch","status":"200"}]',
+ 'title' => '',
+ 'description' => 'The list of index details.',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'The list of index details.',
+ 'type' => 'object',
+ 'properties' => [
+ 'name' => ['title' => '', 'description' => 'The index name.', 'type' => 'string', 'example' => 'general'],
+ 'versions' => [
+ 'title' => '',
+ 'description' => 'The list of versions.',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'The information about the index version.',
+ 'type' => 'object',
+ 'properties' => [
+ 'desc' => ['title' => '', 'description' => 'The description.', 'type' => 'string', 'example' => 'Index Note'],
+ 'files' => [
+ 'title' => '',
+ 'description' => 'The list of file names.',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'The version information.',
+ 'type' => 'object',
+ 'properties' => [
+ 'fullPathName' => ['description' => 'The name of the folder after a full-text index is created.', 'type' => 'string', 'title' => '', 'example' => '/qrs.json'."\n"],
+ 'isDir' => ['description' => 'Indicates whether a folder exists.', 'type' => 'boolean', 'title' => '', 'example' => 'true'],
+ 'isTemplate' => ['description' => 'Indicates whether the file is a template.', 'type' => 'boolean', 'title' => '', 'example' => 'true'],
+ 'name' => ['description' => 'The file name.', 'type' => 'string', 'title' => '', 'example' => 'qrs.json'."\n"],
+ ],
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'example' => '',
+ ],
+ 'name' => ['title' => '', 'description' => 'The version name.', 'type' => 'string', 'example' => 'test'],
+ 'status' => ['title' => '', 'description' => 'The status.'."\n"
+ ."\n"
+ .'- NEW: The index is being created.'."\n"
+ ."\n"
+ .'- PUBLISH: The index is in the Normal state.'."\n"
+ ."\n"
+ .'- IN\\_USE: The index is in use.'."\n"
+ ."\n"
+ .'- NOT\\_USE: The index is not in use.'."\n"
+ ."\n"
+ .'- STOP\\_USE: The index is being stopped.'."\n"
+ ."\n"
+ .'- RESTORE\\_USE: The index is being resumed.'."\n"
+ ."\n"
+ .'- FAIL: The index failed.', 'type' => 'string', 'example' => 'PUBLISH'],
+ 'updateTime' => ['title' => '', 'description' => 'The update time.', 'type' => 'integer', 'format' => 'int64', 'example' => '2024-06-20 08:52:54'],
+ 'versionId' => ['title' => '', 'description' => 'The version ID. This parameter is null for an edit version.', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
+ ],
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'example' => '',
],
+ 'dataSource' => ['title' => '', 'description' => 'The data source.', 'type' => 'string', 'example' => 'ha-cn-pl32rf0****_test_api'],
+ 'domain' => ['title' => '', 'description' => 'The deployment name of the data source.', 'type' => 'string', 'example' => 'vpc_hz_domain_1'],
+ 'indexStatus' => ['title' => '', 'description' => 'NEW, PUBLISH', 'type' => 'string', 'example' => 'PUBLISH'],
+ 'content' => ['title' => '', 'description' => 'The schema in the JSON format.', 'type' => 'string', 'example' => '{"summarys":{"parameter":{"file_compressor":"zstd"},"summary_fields":["id"]},"file_compress":[{"name":"file_compressor","type":"zstd"},{"name":"no_compressor","type":""}],"indexs":[{"index_fields":"name","index_name":"ids","index_type":"STRING"},{"has_primary_key_attribute":true,"index_fields":"id","is_primary_key_sorted":false,"index_name":"id","index_type":"PRIMARYKEY64"}],"attributes":[{"file_compress":"no_compressor","field_name":"id"}],"fields":[{"user_defined_param":{},"compress_type":"uniq","field_type":"STRING","field_name":"id"},{"compress_type":"uniq","field_type":"STRING","field_name":"name"}],"table_name":"api"}'],
+ 'partition' => ['title' => '', 'description' => 'The number of data shards.', 'type' => 'integer', 'format' => 'int32', 'example' => '2'],
+ 'fullVersion' => ['title' => '', 'description' => 'The full version, which is the index version.', 'type' => 'integer', 'format' => 'int64', 'example' => '1688523414'],
+ 'fullUpdateTime' => ['title' => '', 'description' => 'The time when the full index was switched.', 'type' => 'string', 'example' => '2023-07-05 10:40:38'],
+ 'incUpdateTime' => ['title' => '', 'description' => 'The time of the incremental update.', 'type' => 'string', 'example' => '2023-07-05 10:58:33'],
+ 'indexSize' => ['title' => '', 'description' => 'The index size.', 'type' => 'integer', 'format' => 'int64', 'example' => '4689'],
+ 'description' => ['title' => '', 'description' => 'The description.', 'type' => 'string', 'example' => 'note'],
+ 'dataSourceInfo' => [
+ 'title' => '',
+ 'description' => 'The information about the data source.',
+ 'type' => 'object',
+ 'properties' => [
+ 'processPartitionCount' => ['title' => '', 'description' => 'The number of resources for data updates.', 'type' => 'integer', 'format' => 'int32', 'example' => '2'],
+ 'name' => ['title' => '', 'description' => 'The data source name.', 'type' => 'string', 'example' => 'ha-cn-pl32rf0****_test_api'],
+ 'type' => ['title' => '', 'description' => 'The type of the data source. Valid values: odps (MaxCompute), swift, saro, oss (Object Storage Service), and unKnow.', 'type' => 'string', 'example' => 'odps'],
+ 'domain' => ['title' => '', 'description' => 'The offline deployment.', 'type' => 'string', 'example' => 'vpc_hz_domain_2'],
+ 'config' => [
+ 'title' => '',
+ 'description' => 'The configurations of the MaxCompute data source.',
+ 'type' => 'object',
+ 'properties' => [
+ 'endpoint' => ['title' => '', 'description' => 'Information about the MaxCompute data source.', 'type' => 'string', 'example' => 'http://service.cn-hangzhou.maxcompute.aliyun-inc.com/api'],
+ 'accessKey' => ['description' => 'The AccessKey ID of the MaxCompute data source.', 'type' => 'string', 'title' => '', 'example' => 'L***p'],
+ 'accessSecret' => ['description' => 'The AccessKey secret of the MaxCompute data source.', 'type' => 'string', 'title' => '', 'example' => '5**9a6'],
+ 'project' => ['description' => 'The name of the MaxCompute project.', 'type' => 'string', 'title' => '', 'example' => 'tisplus_dev'],
+ 'partition' => ['description' => 'The data partition.', 'type' => 'string', 'title' => '', 'example' => 'ds=20231220'],
+ 'table' => ['title' => '', 'description' => 'Information about the saro or MaxCompute data source.', 'type' => 'string', 'example' => 'dump_odps_demo'],
+ 'namespace' => ['title' => '', 'description' => 'Information about the saro data source.', 'type' => 'string', 'example' => 'TEST_dump_demo_sj_na61hunbu2_share_holo'],
+ 'path' => ['title' => '', 'description' => 'Information about the Hadoop Distributed File System (HDFS) data source.', 'type' => 'string', 'example' => 'http://test_opensearch/sift_oss_test.data'],
+ 'ossPath' => ['title' => '', 'description' => 'Information about the OSS data source.', 'type' => 'string', 'example' => '/test_opensearch/sift_oss_test.data'],
+ 'bucket' => ['description' => 'The OSS bucket.', 'type' => 'string', 'title' => '', 'example' => 'ha3test-oss'],
+ 'format' => ['type' => 'string', 'description' => 'The file format for OSS.'."\n"
+ ."\n"
+ .'- ha3'."\n"
+ ."\n"
+ .'- json', 'title' => '', 'example' => 'ha3'],
+ 'catalog' => ['type' => 'string', 'description' => 'The ID of the data catalog for the DLF data source.', 'title' => '', 'example' => 'clg-paimon-21cc136237a6457f8618f5f82d116d7e'],
+ 'database' => ['type' => 'string', 'description' => 'The database name of the DLF data source.', 'title' => '', 'example' => 'dlf_test'],
+ 'tag' => ['type' => 'string', 'description' => 'The tag of the DLF data source.', 'title' => '', 'example' => 'test_tag'],
+ ],
+ 'example' => '',
+ ],
+ 'saroConfig' => [
+ 'title' => '',
+ 'description' => 'The configurations of the saro data source.',
+ 'type' => 'object',
+ 'properties' => [
+ 'namespace' => ['description' => 'The namespace of the saro data source.', 'type' => 'string', 'title' => '', 'example' => 'TEST_dump_demo_sj_na61hunbu2_share_holo'],
+ 'tableName' => ['description' => 'The name of the saro data table.', 'type' => 'string', 'title' => '', 'example' => 'dump_odps_demo'],
+ ],
+ 'example' => '',
+ ],
+ 'autoBuildIndex' => ['title' => '', 'description' => 'Indicates whether to automatically build a full index.', 'type' => 'boolean', 'example' => 'true'],
+ ],
+ 'example' => '',
+ ],
+ 'createTime' => ['type' => 'string', 'description' => 'The creation time.', 'title' => '', 'example' => '2024-05-21 16:05:26'],
+ 'updateTime' => ['type' => 'string', 'description' => 'The update time.', 'title' => '', 'example' => '2024-05-21 16:05:26'],
],
- 'totalCount' => [
- 'description' => 'The total number of entries returned'."\n",
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '5',
- ],
+ 'title' => '',
+ 'example' => '',
],
+ 'example' => '',
],
],
+ 'title' => '',
+ 'example' => '',
],
],
500 => [],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"022F36C7-9FB4-5D67-BEBC-3D14B0984463\\",\\n \\"result\\": {\\n \\"result\\": [\\n \\"[{\\\\\\"requestTime\\\\\\":\\\\\\"2024-07-02T16:06:57+08:00\\\\\\",\\\\\\"totalTime\\\\\\":\\\\\\"0.003\\\\\\",\\\\\\"requestId\\\\\\":\\\\\\"6d63e7a9b58a04827cfxxxxx\\\\\\",\\\\\\"host\\\\\\":\\\\\\"ha-cn-xxx.ha.aliyuncs.com\\\\\\",\\\\\\"requestUri\\\\\\":\\\\\\"/vector-service/fetch\\\\\\",\\\\\\"status\\\\\\":\\\\\\"200\\\\\\"}]\\"\\n ],\\n \\"totalCount\\": 5\\n }\\n}","type":"json"}]',
- 'title' => 'ListLogs',
- ],
- 'ModifyNodeConfig' => [
- 'summary' => 'Modifies the configurations of a node.',
- 'path' => '/openapi/ha3/instances/{instanceId}/node-config',
- 'methods' => [
- 'put',
+ 'eventInfo' => [
+ 'enable' => false,
+ 'eventNames' => [],
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"4FB0325E-8C37-5525-96AC-0333523170A3\\",\\n \\"result\\": [\\n {\\n \\"name\\": \\"general\\",\\n \\"versions\\": [\\n {\\n \\"desc\\": \\"Index Note\\",\\n \\"files\\": [\\n {\\n \\"fullPathName\\": \\"/qrs.json\\\\n\\",\\n \\"isDir\\": true,\\n \\"isTemplate\\": true,\\n \\"name\\": \\"qrs.json\\\\n\\"\\n }\\n ],\\n \\"name\\": \\"test\\",\\n \\"status\\": \\"PUBLISH\\",\\n \\"updateTime\\": 0,\\n \\"versionId\\": 1\\n }\\n ],\\n \\"dataSource\\": \\"ha-cn-pl32rf0****_test_api\\",\\n \\"domain\\": \\"vpc_hz_domain_1\\",\\n \\"indexStatus\\": \\"PUBLISH\\",\\n \\"content\\": \\"{\\\\\\"summarys\\\\\\":{\\\\\\"parameter\\\\\\":{\\\\\\"file_compressor\\\\\\":\\\\\\"zstd\\\\\\"},\\\\\\"summary_fields\\\\\\":[\\\\\\"id\\\\\\"]},\\\\\\"file_compress\\\\\\":[{\\\\\\"name\\\\\\":\\\\\\"file_compressor\\\\\\",\\\\\\"type\\\\\\":\\\\\\"zstd\\\\\\"},{\\\\\\"name\\\\\\":\\\\\\"no_compressor\\\\\\",\\\\\\"type\\\\\\":\\\\\\"\\\\\\"}],\\\\\\"indexs\\\\\\":[{\\\\\\"index_fields\\\\\\":\\\\\\"name\\\\\\",\\\\\\"index_name\\\\\\":\\\\\\"ids\\\\\\",\\\\\\"index_type\\\\\\":\\\\\\"STRING\\\\\\"},{\\\\\\"has_primary_key_attribute\\\\\\":true,\\\\\\"index_fields\\\\\\":\\\\\\"id\\\\\\",\\\\\\"is_primary_key_sorted\\\\\\":false,\\\\\\"index_name\\\\\\":\\\\\\"id\\\\\\",\\\\\\"index_type\\\\\\":\\\\\\"PRIMARYKEY64\\\\\\"}],\\\\\\"attributes\\\\\\":[{\\\\\\"file_compress\\\\\\":\\\\\\"no_compressor\\\\\\",\\\\\\"field_name\\\\\\":\\\\\\"id\\\\\\"}],\\\\\\"fields\\\\\\":[{\\\\\\"user_defined_param\\\\\\":{},\\\\\\"compress_type\\\\\\":\\\\\\"uniq\\\\\\",\\\\\\"field_type\\\\\\":\\\\\\"STRING\\\\\\",\\\\\\"field_name\\\\\\":\\\\\\"id\\\\\\"},{\\\\\\"compress_type\\\\\\":\\\\\\"uniq\\\\\\",\\\\\\"field_type\\\\\\":\\\\\\"STRING\\\\\\",\\\\\\"field_name\\\\\\":\\\\\\"name\\\\\\"}],\\\\\\"table_name\\\\\\":\\\\\\"api\\\\\\"}\\",\\n \\"partition\\": 2,\\n \\"fullVersion\\": 1688523414,\\n \\"fullUpdateTime\\": \\"2023-07-05 10:40:38\\",\\n \\"incUpdateTime\\": \\"2023-07-05 10:58:33\\",\\n \\"indexSize\\": 4689,\\n \\"description\\": \\"note\\",\\n \\"dataSourceInfo\\": {\\n \\"processPartitionCount\\": 2,\\n \\"name\\": \\"ha-cn-pl32rf0****_test_api\\",\\n \\"type\\": \\"odps\\",\\n \\"domain\\": \\"vpc_hz_domain_2\\",\\n \\"config\\": {\\n \\"endpoint\\": \\"http://service.cn-hangzhou.maxcompute.aliyun-inc.com/api\\",\\n \\"accessKey\\": \\"L***p\\",\\n \\"accessSecret\\": \\"5**9a6\\",\\n \\"project\\": \\"tisplus_dev\\",\\n \\"partition\\": \\"ds=20231220\\",\\n \\"table\\": \\"dump_odps_demo\\",\\n \\"namespace\\": \\"TEST_dump_demo_sj_na61hunbu2_share_holo\\",\\n \\"path\\": \\"http://test_opensearch/sift_oss_test.data\\",\\n \\"ossPath\\": \\"/test_opensearch/sift_oss_test.data\\",\\n \\"bucket\\": \\"ha3test-oss\\",\\n \\"format\\": \\"ha3\\",\\n \\"catalog\\": \\"clg-paimon-21cc136237a6457f8618f5f82d116d7e\\",\\n \\"database\\": \\"dlf_test\\",\\n \\"tag\\": \\"test_tag\\"\\n },\\n \\"saroConfig\\": {\\n \\"namespace\\": \\"TEST_dump_demo_sj_na61hunbu2_share_holo\\",\\n \\"tableName\\": \\"dump_odps_demo\\"\\n },\\n \\"autoBuildIndex\\": true\\n },\\n \\"createTime\\": \\"2024-05-21 16:05:26\\",\\n \\"updateTime\\": \\"2024-05-21 16:05:26\\"\\n }\\n ]\\n}","type":"json"}]',
+ 'title' => 'ListIndexes',
+ 'description' => '## Method'."\n"
+ ."\n"
+ .'```'."\n"
+ .'GET'."\n"
+ .'```'."\n"
+ ."\n"
+ .'## URI'."\n"
+ ."\n"
+ .'```'."\n"
+ .'/openapi/ha3/instances/{instanceId}/indexes'."\n"
+ .'```',
+ 'requestParamsDescription' => '## Sample request'."\n"
+ ."\n"
+ .''."\n"
+ ."\n"
+ .'```'."\n"
+ .'GET /openapi/ha3/instances/ose-test1/indexes'."\n"
+ .'```',
+ 'responseParamsDescription' => '## Sample responses'."\n"
+ ."\n"
+ .'Sample success response'."\n"
+ ."\n"
+ .'```'."\n"
+ .'{'."\n"
+ .''."\n"
+ .' "requestId": "38b079f1-7846-4226-8c90-3e2644b5c52b",'."\n"
+ .''."\n"
+ .' "result": ['."\n"
+ .''."\n"
+ .' {'."\n"
+ .''."\n"
+ .' "name": "index1",'."\n"
+ .''."\n"
+ .' "dataSource": "test_yyds_data1",'."\n"
+ .''."\n"
+ .' },'."\n"
+ .''."\n"
+ .' {'."\n"
+ .''."\n"
+ .' "name": "index1",'."\n"
+ .''."\n"
+ .' "dataSource": "test_yyds_data1",'."\n"
+ .''."\n"
+ .' }'."\n"
+ .''."\n"
+ .' ]'."\n"
+ .''."\n"
+ .'}'."\n"
+ .'```',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListIndexes'],
+ ],
],
- 'schemes' => [
- 'http',
- 'https',
+ 'ramActions' => [
+ [
+ 'operationType' => 'list',
+ 'ramAction' => [
+ 'action' => 'searchengine:ListIndexes',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SearchEngine', 'resourceType' => 'Instance', 'arn' => 'acs:searchengine:{#regionId}:{#accountId}:instance/{#InstanceId}'],
+ ],
+ ],
+ ],
],
+ ],
+ 'ListInstanceSpecs' => [
+ 'summary' => 'Queries the specifications of an instance.',
+ 'path' => '/openapi/ha3/instances/{instanceId}/specs',
+ 'methods' => ['get'],
+ 'schemes' => ['https', 'http'],
'security' => [
[
'AK' => [],
@@ -13092,216 +9479,474 @@
],
'operationType' => 'read',
'deprecated' => false,
- 'systemTags' => [
- 'abilityTreeCode' => '114152',
- 'abilityTreeNodes' => [
- 'FEATUREopensearchIQC42D',
- ],
- ],
+ 'systemTags' => ['operationType' => 'get'],
'parameters' => [
[
'name' => 'instanceId',
'in' => 'path',
- 'schema' => [
- 'description' => 'The instance ID.'."\n",
- 'type' => 'string',
- 'required' => true,
- 'example' => 'ha-cn-2r42p5oi202',
- 'title' => '',
- ],
+ 'schema' => ['description' => 'The instance ID.'."\n", 'type' => 'string', 'required' => true, 'example' => 'ha-cn-pl32rf0****', 'title' => ''],
],
[
'name' => 'type',
'in' => 'query',
+ 'schema' => ['title' => '', 'description' => 'The node type. Valid values:'."\n"
+ ."\n"
+ .'* qrs: Query Result Searcher (QRS) Worker'."\n"
+ .'* search: Searcher Worker'."\n"
+ .'* index: index node'."\n"
+ .'* cluster: cluster'."\n", 'type' => 'string', 'required' => true, 'example' => 'search'],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
'schema' => [
- 'title' => 'qrs: 查询节点, search: 数据节点, index: 索引节点, cluster: 集群',
- 'description' => 'The type of the algorithm. Valid values:'."\n"
- ."\n"
- .'* pop: a popularity model.'."\n"
- .'* cp: a category prediction model.'."\n"
- .'* hot: a top search model.'."\n"
- .'* hint: a hint model.'."\n"
- .'* suggest: a drop-down suggestions model.'."\n",
- 'type' => 'string',
- 'required' => true,
- 'example' => '" "',
+ 'description' => 'The response parameters.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'requestId' => ['title' => '', 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '10D5E615-69F7-5F49-B850-00169ADE513C'],
+ 'result' => [
+ 'title' => '',
+ 'description' => 'The instance types.'."\n",
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'A list of instance specifications'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'cpu' => ['title' => '', 'description' => 'The number of vCPUs.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
+ 'mem' => ['title' => '', 'description' => 'The memory of the instance. Unit: GB.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '16'],
+ 'minDisk' => ['title' => '', 'description' => 'The minimum storage of a single data node. Unit: GB.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '100'],
+ 'maxDisk' => ['title' => '', 'description' => 'The maximum storage of a single data node. Unit: GB.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '600'],
+ ],
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'example' => '',
+ ],
+ ],
+ 'title' => '',
+ 'example' => '',
],
],
+ 500 => [],
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"10D5E615-69F7-5F49-B850-00169ADE513C\\",\\n \\"result\\": [\\n {\\n \\"cpu\\": 1,\\n \\"mem\\": 16,\\n \\"minDisk\\": 100,\\n \\"maxDisk\\": 600\\n }\\n ]\\n}","type":"json"}]',
+ 'title' => 'ListInstanceSpecs',
+ 'description' => '### Method'."\n"
+ ."\n"
+ .'`GET`'."\n"
+ ."\n"
+ .'### URI'."\n"
+ ."\n"
+ .'`/openapi/ha3/instances/{instanceId}/specs?type=qrs`'."\n",
+ 'requestParamsDescription' => '### Sample requests'."\n"
+ ."\n"
+ .'`GET /openapi/ha3/instances/ha3_instance_name/specs`'."\n",
+ 'responseParamsDescription' => '### Sample responses'."\n"
+ ."\n"
+ .' {'."\n"
+ .' "requestId": "e1eef569-1ff7-4bf8-acf7-1cecca9894ce",'."\n"
+ .' "result": ['."\n"
+ .' {'."\n"
+ .' "cpu": 1'."\n"
+ .' "mem": 2,'."\n"
+ .' "disk": 100'."\n"
+ .' },'."\n"
+ .' {'."\n"
+ .' "cpu": 2'."\n"
+ .' "mem": 4,'."\n"
+ .' "disk": 100 '."\n"
+ .' } '."\n"
+ .' ]'."\n"
+ .' }'."\n",
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListInstanceSpecs'],
+ ],
+ ],
+ 'ramActions' => [
[
- 'name' => 'name',
- 'in' => 'query',
- 'schema' => [
- 'description' => 'The name of the configuration before the modification.'."\n",
- 'type' => 'string',
- 'required' => true,
- 'example' => 'ha-cn-zvp2iv9a401_qrs',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'searchengine:ListInstanceSpecs',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SearchEngine', 'resourceType' => 'Instance', 'arn' => 'acs:searchengine:{#regionId}:{#accountId}:instance/{#instanceId}'],
+ ],
],
],
+ ],
+ ],
+ 'ListInstances' => [
+ 'summary' => 'Retrieves a list of instances.',
+ 'path' => '/openapi/ha3/instances',
+ 'methods' => ['get'],
+ 'schemes' => ['http', 'https'],
+ 'security' => [
[
- 'name' => 'clusterName',
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'read',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'get',
+ 'abilityTreeCode' => '102492',
+ 'abilityTreeNodes' => ['FEATUREopensearch0AT3OG', 'FEATUREopensearchJB31XH'],
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'pageNumber',
'in' => 'query',
- 'schema' => [
- 'description' => 'The name of the cluster.'."\n",
- 'type' => 'string',
- 'required' => false,
- 'example' => 'vpc_sh_domain_2',
- ],
+ 'schema' => ['description' => 'The page number. The default value is 1.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'title' => '', 'example' => '1'],
],
[
- 'name' => 'dataSourceName',
+ 'name' => 'pageSize',
'in' => 'query',
- 'schema' => [
- 'description' => 'The name of the data source. Valid values: -search: search for data. -not_search: do not search for data.'."\n",
- 'type' => 'string',
- 'required' => false,
- 'example' => 'ha-cn-2r42ostoc01_0704',
- ],
+ 'schema' => ['description' => 'The number of entries to return on each page. The default value is 10. The value must be in the range of 1 to 50.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'title' => '', 'example' => '10'],
],
[
- 'name' => 'body',
- 'in' => 'body',
+ 'name' => 'instanceId',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The ID of the instance.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => 'ha-cn-pl32rf0****'],
+ ],
+ [
+ 'name' => 'description',
+ 'in' => 'query',
+ 'schema' => ['description' => 'Filters instances by description. Fuzzy matching is supported.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => 'searchengine instance'],
+ ],
+ [
+ 'name' => 'resourceGroupId',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The ID of the resource group.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => 'rg-aekzgpiswzbksdi'],
+ ],
+ [
+ 'name' => 'edition',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The edition of the instance. Valid values: vector (Vector Search Edition) and engine (Retrieval Engine Edition).', 'type' => 'string', 'required' => false, 'title' => '', 'example' => 'vector'],
+ ],
+ [
+ 'name' => 'tags',
+ 'in' => 'query',
'style' => 'json',
'schema' => [
- 'description' => 'The request body.'."\n",
- 'type' => 'object',
- 'properties' => [
- 'dataFragmentNumber' => [
- 'title' => '数据分片数',
- 'description' => 'The number of data shards.'."\n",
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'example' => '1',
- ],
- 'dataDuplicateNumber' => [
- 'title' => '数据副本数',
- 'description' => 'The number of data replicas.'."\n",
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'example' => '1',
- ],
- 'minServicePercent' => [
- 'title' => '最小服务比例',
- 'description' => 'The minimum service ratio.'."\n",
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'example' => '10',
- ],
- 'published' => [
- 'title' => '集群是否挂载',
- 'description' => 'Specifies whether to mount the cluster.'."\n",
- 'type' => 'boolean',
- 'required' => false,
- 'example' => 'true',
- ],
- 'active' => [
- 'title' => '在线生效（索引是否从在线下掉）',
- 'description' => 'Specifies whether to enable the index.'."\n",
- 'type' => 'boolean',
- 'required' => false,
- 'example' => 'true',
- ],
- 'flowRatio' => [
- 'description' => 'The traffic percentage.'."\n",
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'example' => '-100',
+ 'description' => 'The tags.',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'The tags of the instance.',
+ 'type' => 'object',
+ 'properties' => [
+ 'key' => ['description' => 'The tag key.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => 'opensearch'],
+ 'value' => ['description' => 'The tag value.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => 'opensearch'],
],
+ 'required' => false,
+ 'title' => '',
+ 'example' => '',
],
'required' => false,
- 'example' => '{\\"desc\\":\\"new version\\"}',
+ 'title' => '',
+ 'example' => '',
],
],
+ [
+ 'name' => 'catalog',
+ 'in' => 'query',
+ 'schema' => ['type' => 'string', 'required' => false, 'description' => '', 'title' => '', 'example' => ''],
+ ],
+ [
+ 'name' => 'database',
+ 'in' => 'query',
+ 'schema' => ['type' => 'string', 'required' => false, 'description' => '', 'title' => '', 'example' => ''],
+ ],
+ [
+ 'name' => 'table',
+ 'in' => 'query',
+ 'schema' => ['type' => 'string', 'required' => false, 'description' => '', 'title' => '', 'example' => ''],
+ ],
+ [
+ 'name' => 'dataSourceType',
+ 'in' => 'query',
+ 'schema' => ['type' => 'string', 'required' => false, 'description' => '', 'title' => '', 'example' => ''],
+ ],
],
'responses' => [
200 => [
'schema' => [
+ 'title' => '',
+ 'description' => 'The response schema.',
'type' => 'object',
'properties' => [
- 'requestId' => [
- 'title' => 'id of request',
- 'description' => 'id of request'."\n",
- 'type' => 'string',
- 'example' => 'D39EE0F1-D7EF-5F46-B781-6BF4185308B0',
- ],
'result' => [
- 'title' => 'Map',
- 'description' => 'The information about the index'."\n",
- 'type' => 'object',
- 'example' => '{}',
+ 'description' => 'The returned result.',
+ 'type' => 'array',
+ 'items' => [
+ 'title' => '',
+ 'description' => 'The details of the instance.',
+ 'type' => 'object',
+ 'properties' => [
+ 'description' => ['title' => '', 'description' => 'The description of the instance.', 'type' => 'string', 'example' => 'test'],
+ 'resourceGroupId' => ['title' => '', 'description' => 'The ID of the resource group.', 'type' => 'string', 'example' => 'ha-cn-pl32rf0****'],
+ 'expiredTime' => ['title' => '', 'description' => 'The expiration time.', 'type' => 'string', 'example' => '1634885083'],
+ 'commodityCode' => ['title' => '', 'description' => 'The commodity code.', 'type' => 'string', 'example' => 'opensearch_ha3post_public_cn'],
+ 'status' => ['title' => '', 'description' => 'The status of the instance.', 'type' => 'string', 'example' => 'READY'],
+ 'instanceId' => ['title' => '', 'description' => 'The ID of the instance.', 'type' => 'string', 'example' => 'ha-cn-pl32rf0****'],
+ 'createTime' => ['title' => '', 'description' => 'The time when the instance was created.', 'type' => 'string', 'example' => '2022-06-04T02:03:21Z'],
+ 'lockMode' => ['title' => '', 'description' => 'The lock status.', 'type' => 'string', 'example' => 'Unlock'],
+ 'chargeType' => ['title' => '', 'description' => 'The billing method.', 'type' => 'string', 'example' => 'POSTPAY'],
+ 'updateTime' => ['title' => '', 'description' => 'The time when the instance was last updated.', 'type' => 'string', 'example' => '2018-12-06T11:17:49.0'],
+ 'inDebt' => ['title' => '', 'description' => 'Indicates whether the instance has an overdue payment.', 'type' => 'boolean', 'example' => 'false'],
+ 'network' => [
+ 'description' => 'The network information of the search engine instance.',
+ 'type' => 'object',
+ 'properties' => [
+ 'vSwitchId' => ['description' => 'The ID of the virtual switch.', 'type' => 'string', 'title' => '', 'example' => 'vsw-bp11ldcf59q2n****'],
+ 'vpcId' => ['description' => 'The ID of the virtual private cloud (VPC).', 'type' => 'string', 'title' => '', 'example' => 'vpc-wz9axk41d9vff****'],
+ 'endpoint' => ['description' => 'The gateway endpoint.', 'type' => 'string', 'title' => '', 'example' => 'ha-cn-35t3r****.ha.aliyuncs.com'],
+ 'publicEndpoint' => ['type' => 'string', 'description' => 'The public domain name.', 'title' => '', 'example' => 'ha-cn-35t3ni****.public.ha.aliyuncs.com'],
+ 'allow' => ['type' => 'string', 'description' => 'The whitelist for the public domain name.', 'title' => '', 'example' => '127.0.0.1'],
+ ],
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'tags' => [
+ 'description' => 'The tags.',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'The tags.',
+ 'type' => 'object',
+ 'properties' => [
+ 'key' => ['description' => 'The tag key.', 'type' => 'string', 'title' => '', 'example' => 'opensearch'],
+ 'value' => ['description' => 'The tag value.', 'type' => 'string', 'title' => '', 'example' => 'opensearch'],
+ ],
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'edition' => ['type' => 'string', 'description' => 'The edition of the instance.vector: Vector Search Editionengine: Retrieval Engine Edition', 'title' => '', 'example' => 'vector'],
+ 'userName' => ['type' => 'string', 'description' => 'The username.', 'title' => '', 'example' => 'admin'],
+ 'version' => ['type' => 'string', 'description' => 'The version of the engine.', 'title' => '', 'example' => 'ha3_3.10.0'],
+ 'noQrs' => ['type' => 'boolean', 'description' => 'Indicates whether the instance is a standalone instance.', 'title' => '', 'example' => 'false'],
+ 'spec' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'qrsResource' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'category' => ['type' => 'string', 'description' => 'The instance type. Valid values:local\\_ssd: local solid-state drive (SSD)cloud: disk', 'title' => '', 'example' => 'local_ssd'],
+ 'cpu' => ['type' => 'integer', 'format' => 'int32', 'description' => 'The number of CPU cores.', 'title' => '', 'example' => '1'],
+ 'mem' => ['type' => 'integer', 'format' => 'int32', 'description' => 'The memory size in GB.', 'title' => '', 'example' => '10'],
+ 'disk' => ['type' => 'integer', 'format' => 'int32', 'description' => 'The storage space of the node in GB.', 'title' => '', 'example' => '100'],
+ 'nodeCount' => ['type' => 'integer', 'format' => 'int32', 'description' => 'The number of nodes.', 'title' => '', 'example' => '3'],
+ ],
+ 'description' => 'The specifications of the query nodes.',
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'searchResource' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'category' => ['type' => 'string', 'description' => 'The instance type. Valid values:local\\_ssd: local SSDcloud: disk', 'title' => '', 'example' => 'local_ssd'],
+ 'cpu' => ['type' => 'integer', 'format' => 'int32', 'description' => 'The number of CPU cores.', 'title' => '', 'example' => '1'],
+ 'mem' => ['type' => 'integer', 'format' => 'int32', 'description' => 'The memory size in GB.', 'title' => '', 'example' => '10'],
+ 'disk' => ['type' => 'integer', 'format' => 'int32', 'description' => 'The storage space of the node in GB.', 'title' => '', 'example' => '100'],
+ 'nodeCount' => ['type' => 'integer', 'format' => 'int32', 'description' => 'The number of nodes.', 'title' => '', 'example' => '3'],
+ ],
+ 'description' => 'The specifications of the data nodes.',
+ 'title' => '',
+ 'example' => '',
+ ],
+ ],
+ 'description' => 'The specifications of the nodes.',
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'dataSourceDetails' => [
+ 'type' => 'array',
+ 'items' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'indexName' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''],
+ 'type' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''],
+ 'config' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'endpoint' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''],
+ 'accessKey' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''],
+ 'project' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''],
+ 'partition' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''],
+ 'table' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''],
+ 'namespace' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''],
+ 'path' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''],
+ 'ossPath' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''],
+ 'bucket' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''],
+ 'catalog' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''],
+ 'database' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''],
+ 'tag' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''],
+ ],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
+ ],
+ ],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
+ ],
+ ],
+ 'example' => '',
+ ],
+ 'title' => '',
+ 'example' => '',
],
+ 'totalCount' => ['title' => '', 'description' => 'The total number of entries.', 'type' => 'integer', 'format' => 'int32', 'example' => '5'],
+ 'requestId' => ['title' => '', 'description' => 'The ID of the request.', 'type' => 'string', 'example' => '89B968E6-1E41-58DF-BB25-5F98ECC759CE'],
],
- 'description' => 'Schema of Response'."\n",
- 'title' => 'Schema of Response',
+ 'example' => '',
+ ],
+ ],
+ 500 => [
+ 'schema' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'requestId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''],
+ 'message' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''],
+ 'code' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''],
+ ],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
],
- 500 => [],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"D39EE0F1-D7EF-5F46-B781-6BF4185308B0\\",\\n \\"result\\": {}\\n}","type":"json"}]',
- 'title' => 'ModifyNodeConfig',
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"result\\": [\\n {\\n \\"description\\": \\"test\\",\\n \\"resourceGroupId\\": \\"ha-cn-pl32rf0****\\",\\n \\"expiredTime\\": \\"1634885083\\",\\n \\"commodityCode\\": \\"opensearch_ha3post_public_cn\\",\\n \\"status\\": \\"READY\\",\\n \\"instanceId\\": \\"ha-cn-pl32rf0****\\",\\n \\"createTime\\": \\"2022-06-04T02:03:21Z\\",\\n \\"lockMode\\": \\"Unlock\\",\\n \\"chargeType\\": \\"POSTPAY\\",\\n \\"updateTime\\": \\"2018-12-06T11:17:49.0\\",\\n \\"inDebt\\": false,\\n \\"network\\": {\\n \\"vSwitchId\\": \\"vsw-bp11ldcf59q2n****\\",\\n \\"vpcId\\": \\"vpc-wz9axk41d9vff****\\",\\n \\"endpoint\\": \\"ha-cn-35t3r****.ha.aliyuncs.com\\",\\n \\"publicEndpoint\\": \\"ha-cn-35t3ni****.public.ha.aliyuncs.com\\",\\n \\"allow\\": \\"127.0.0.1\\"\\n },\\n \\"tags\\": [\\n {\\n \\"key\\": \\"opensearch\\",\\n \\"value\\": \\"opensearch\\"\\n }\\n ],\\n \\"edition\\": \\"vector\\",\\n \\"userName\\": \\"admin\\",\\n \\"version\\": \\"ha3_3.10.0\\",\\n \\"noQrs\\": false,\\n \\"spec\\": {\\n \\"qrsResource\\": {\\n \\"category\\": \\"local_ssd\\",\\n \\"cpu\\": 1,\\n \\"mem\\": 10,\\n \\"disk\\": 100,\\n \\"nodeCount\\": 3\\n },\\n \\"searchResource\\": {\\n \\"category\\": \\"local_ssd\\",\\n \\"cpu\\": 1,\\n \\"mem\\": 10,\\n \\"disk\\": 100,\\n \\"nodeCount\\": 3\\n }\\n },\\n \\"dataSourceDetails\\": [\\n {\\n \\"indexName\\": \\"\\",\\n \\"type\\": \\"\\",\\n \\"config\\": {\\n \\"endpoint\\": \\"\\",\\n \\"accessKey\\": \\"\\",\\n \\"project\\": \\"\\",\\n \\"partition\\": \\"\\",\\n \\"table\\": \\"\\",\\n \\"namespace\\": \\"\\",\\n \\"path\\": \\"\\",\\n \\"ossPath\\": \\"\\",\\n \\"bucket\\": \\"\\",\\n \\"catalog\\": \\"\\",\\n \\"database\\": \\"\\",\\n \\"tag\\": \\"\\"\\n }\\n }\\n ]\\n }\\n ],\\n \\"totalCount\\": 5,\\n \\"requestId\\": \\"89B968E6-1E41-58DF-BB25-5F98ECC759CE\\"\\n}","type":"json"}]',
+ 'title' => 'ListInstances',
'description' => '### Method'."\n"
."\n"
.'```java'."\n"
- .'PUT'."\n"
+ .'GET'."\n"
.'```'."\n"
."\n"
.'### URI'."\n"
."\n"
.'```java'."\n"
- .'/openapi/ha3/instances/{instanceId}/node-config?type=qrs&name=test'."\n"
- .'```'."\n",
- 'requestParamsDescription' => '### Sample requests'."\n"
+ .'/openapi/ha3/instances'."\n"
+ .'```',
+ 'requestParamsDescription' => '| Parameter | Type | Required | Description |'."\n"
+ .'| ----------- | ------ | -------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |'."\n"
+ .'| status | String | No | Filters instances by status. Valid values: Running, Ready, Initializing, and Starting. |'."\n"
+ .'| expiredTime | Long | No | A UNIX timestamp in seconds. This parameter is used to filter instances by expiration time. If the value is greater than the current time, instances that are about to expire are returned. Expired instances are not included. |'."\n"
."\n"
- .'```java'."\n"
- .'PUT /openapi/ha3/instances/{instanceId}/node-config?type=qrs&name=test'."\n"
- .'```'."\n"
+ .'### Example'."\n"
."\n"
- .''."\n"
+ .'**Sample request**'."\n"
."\n"
- .'```java'."\n"
- .'{'."\n"
- .''."\n"
- .' "dataFragmentNumber":1,// The query node and data node'."\n"
- .''."\n"
- .' "dataDuplicateNumber":1,// The query node and data node'."\n"
- .''."\n"
- .' "minServicePercent":20,// The query node and data node'."\n"
- .''."\n"
- .' "published":true,// The cluster'."\n"
- .''."\n"
- .' "active": true //index'."\n"
- .''."\n"
- .'}'."\n"
- .'```'."\n",
+ .'`GET /openapi/ha3/instances?name=test&instanceId=abc&page=1&size=10`',
'responseParamsDescription' => '### Sample responses'."\n"
."\n"
- .'Success responses '."\n"
+ .'**Sample success response**'."\n"
."\n"
- .'```java'."\n"
+ .'```'."\n"
.'{'."\n"
- .''."\n"
- .' "requestId": "0A6EB64B-B4C8-CF02-810F-E660812972FF",'."\n"
- .''."\n"
- .' "result": []'."\n"
- .''."\n"
+ .' "result":'."\n"
+ .' ['."\n"
+ .' {'."\n"
+ .' "inDebt": false,'."\n"
+ .' "lockMode": "Unlock",'."\n"
+ .' "trFreeUrl": "",'."\n"
+ .' "chargeType": "POSTPAY",'."\n"
+ .' "edition": "engine",'."\n"
+ .' "description": "test",'."\n"
+ .' "updateTime": "2024-05-06 14:08:24.0",'."\n"
+ .' "userName": "admin",'."\n"
+ .' "version": "ha3_3.10.0",'."\n"
+ .' "spec":'."\n"
+ .' {'."\n"
+ .' "qrsResource":'."\n"
+ .' {'."\n"
+ .' "category": "local_ssd",'."\n"
+ .' "cpu": 2,'."\n"
+ .' "mem": 8,'."\n"
+ .' "disk": 100,'."\n"
+ .' "nodeCount": 5'."\n"
+ .' },'."\n"
+ .' "searchResource":'."\n"
+ .' {'."\n"
+ .' "category": "local_ssd",'."\n"
+ .' "cpu": 2,'."\n"
+ .' "mem": 16,'."\n"
+ .' "disk": 100,'."\n"
+ .' "nodeCount": 4'."\n"
+ .' }'."\n"
+ .' },'."\n"
+ .' "network":'."\n"
+ .' {'."\n"
+ .' "vSwitchId": "vsw-bp179zkffzyva26ua8xil",'."\n"
+ .' "vpcId": "vpc-bp1956duqqe2lm2lvqjf1",'."\n"
+ .' "endpoint": "ha-cn-35t3ni61z06.ha.aliyuncs.com",'."\n"
+ .' "publicEndpoint": "ha-cn-35t3ni61z06.public.ha.aliyuncs.com",'."\n"
+ .' "allow": "127.0.0.1"'."\n"
+ .' },'."\n"
+ .' "tags":'."\n"
+ .' ['."\n"
+ .' {'."\n"
+ .' "value": "rg-acfmv2hk2jpsxia",'."\n"
+ .' "key": "acs:rm:rgId"'."\n"
+ .' }'."\n"
+ .' ],'."\n"
+ .' "noQrs": false,'."\n"
+ .' "instanceId": "ha-cn-35t3ni61z06",'."\n"
+ .' "createTime": "2024-03-14 10:49:32.0",'."\n"
+ .' "commodityCode": "opensearch_ha3post_public_cn",'."\n"
+ .' "resourceGroupId": "rg-acfmv2hk2jpsxia",'."\n"
+ .' "status": "READY"'."\n"
+ .' }'."\n"
+ .' ],'."\n"
+ .' "requestId": "949FDF5E-6FF6-13B9-A196-59B25F143B7F",'."\n"
+ .' "totalCount": 1'."\n"
.'}'."\n"
.'```'."\n"
."\n"
- .'For more information, see [Response struct](https://www.alibabacloud.com/help/en/open-search/vector-search-edition/response-structure).',
- ],
- 'GetDeployGraph' => [
- 'summary' => 'Displays the overview of the deployment.',
- 'path' => '/openapi/ha3/instances/{instanceId}/deploy-graph',
- 'methods' => [
- 'get',
+ .'**Sample error response**'."\n"
+ ."\n"
+ .'```'."\n"
+ .'{'."\n"
+ .' "requestId": "BD1EA715-DF6F-06C2-004C-C1FA0D3A9820",'."\n"
+ .' "httpCode": 404,'."\n"
+ .' "code": "App.NotFound",'."\n"
+ .' "message": "App not found"'."\n"
+ .'}'."\n"
+ .'```',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListInstances'],
+ ],
],
- 'schemes' => [
- 'http',
- 'https',
+ 'ramActions' => [
+ [
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'searchengine:ListInstances',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SearchEngine', 'resourceType' => 'Instance', 'arn' => 'acs:searchengine:{#regionId}:{#accountId}:instance/*'],
+ ],
+ ],
+ ],
],
+ ],
+ 'ListLogs' => [
+ 'path' => '/openapi/ha3/instances/{instanceId}/logs',
+ 'methods' => ['get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
@@ -13310,252 +9955,396 @@
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
- 'operationType' => 'get',
+ 'operationType' => 'list',
+ 'abilityTreeCode' => '223197',
+ 'abilityTreeNodes' => ['FEATUREopensearch0AT3OG'],
],
'parameters' => [
[
'name' => 'instanceId',
'in' => 'path',
+ 'schema' => ['description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'ha-cn-i7m2roiy504'],
+ ],
+ [
+ 'name' => 'type',
+ 'in' => 'query',
+ 'schema' => ['title' => '', 'description' => 'The log type. Valid values: \\`select\\` (query logs) and \\`push\\` (write logs).', 'type' => 'string', 'required' => false, 'default' => 'select', 'example' => 'push'],
+ ],
+ [
+ 'name' => 'pageNum',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The page number. The default value is 1.', 'type' => 'string', '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' => 'string', 'required' => false, 'title' => '', 'example' => '10'],
+ ],
+ [
+ 'name' => 'startTime',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The start of the time range to query. This is a UNIX timestamp in seconds.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => '1706340600'],
+ ],
+ [
+ 'name' => 'endTime',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The end of the time range to query. This is a UNIX timestamp in seconds.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => '1710432000'],
+ ],
+ [
+ 'name' => 'query',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The search statement.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => 'status: 200 AND totalTime > 0.01'],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
'schema' => [
- 'description' => 'The instance ID.'."\n",
- 'type' => 'string',
- 'required' => false,
- 'example' => 'ha-cn-7pp2pcna701',
+ 'type' => 'object',
+ 'properties' => [
+ 'requestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '022F36C7-9FB4-5D67-BEBC-3D14B0984463'],
+ 'result' => [
+ 'title' => '',
+ 'description' => 'The returned result.',
+ 'type' => 'object',
+ 'properties' => [
+ 'result' => [
+ 'description' => 'The result set.',
+ 'type' => 'array',
+ 'items' => ['description' => 'The log information.', 'type' => 'any', 'title' => '', 'example' => '[{"requestTime":"2024-07-02T16:06:57+08:00","totalTime":"0.003","requestId":"6d63e7a9b58a04827cfxxxxx","host":"ha-cn-xxx.ha.aliyuncs.com","requestUri":"/vector-service/fetch","status":"200"}]'],
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'totalCount' => ['description' => 'The total number of records.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '5'],
+ ],
+ 'example' => '',
+ ],
+ ],
+ 'description' => '',
'title' => '',
+ 'example' => '',
],
],
+ 500 => [],
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"022F36C7-9FB4-5D67-BEBC-3D14B0984463\\",\\n \\"result\\": {\\n \\"result\\": [\\n \\"[{\\\\\\"requestTime\\\\\\":\\\\\\"2024-07-02T16:06:57+08:00\\\\\\",\\\\\\"totalTime\\\\\\":\\\\\\"0.003\\\\\\",\\\\\\"requestId\\\\\\":\\\\\\"6d63e7a9b58a04827cfxxxxx\\\\\\",\\\\\\"host\\\\\\":\\\\\\"ha-cn-xxx.ha.aliyuncs.com\\\\\\",\\\\\\"requestUri\\\\\\":\\\\\\"/vector-service/fetch\\\\\\",\\\\\\"status\\\\\\":\\\\\\"200\\\\\\"}]\\"\\n ],\\n \\"totalCount\\": 5\\n }\\n}","type":"json"}]',
+ 'title' => 'ListLogs',
+ 'summary' => 'Queries the logs of an instance.',
+ 'description' => '### Method'."\n"
+ ."\n"
+ .'```java'."\n"
+ .'GET'."\n"
+ .'```'."\n"
+ ."\n"
+ .'### URI'."\n"
+ ."\n"
+ .'```java'."\n"
+ .'/openapi/ha3/instances/{instanceId}/logs'."\n"
+ .'```',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'list',
+ 'ramAction' => [
+ 'action' => 'searchengine:ListLogs',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SearchEngine', 'resourceType' => 'Instance', 'arn' => 'acs:searchengine:{#regionId}:{#accountId}:instance/{#InstanceId}'],
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'ListModels' => [
+ 'path' => '/openapi/ha3/instances/{instanceId}/models',
+ 'methods' => ['get'],
+ 'schemes' => ['https'],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'read',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'list',
+ 'riskType' => 'none',
+ 'chargeType' => 'free',
+ 'abilityTreeNodes' => ['FEATUREopensearchGTRUN8'],
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'instanceId',
+ 'in' => 'path',
+ 'schema' => ['title' => '', 'description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'example' => 'ha-cn-test'],
+ ],
+ [
+ 'name' => 'name',
+ 'in' => 'query',
+ 'schema' => ['title' => '', 'description' => 'The model name.', 'type' => 'string', 'required' => false, 'example' => 'test1'],
+ ],
+ [
+ 'name' => 'type',
+ 'in' => 'query',
+ 'schema' => ['title' => '', 'description' => 'The model type.', 'type' => 'string', 'required' => false, 'example' => 'text_embedding'],
+ ],
+ [
+ 'name' => 'pageNumber',
+ 'in' => 'query',
+ 'schema' => ['title' => '', 'description' => 'The page number. Default value: 1.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1'],
+ ],
+ [
+ 'name' => 'pageSize',
+ 'in' => 'query',
+ 'schema' => ['title' => '', 'description' => 'The number of entries per page. Default value: 10.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10'],
+ ],
],
'responses' => [
200 => [
'schema' => [
+ 'title' => '',
+ 'description' => 'The response includes the request ID and a model list. Each element in the model list contains detailed model information such as name, type, URL, and status.',
'type' => 'object',
'properties' => [
- 'requestId' => [
- 'title' => 'id of request',
- 'description' => 'Id of the request'."\n",
- 'type' => 'string',
- 'example' => 'E7B7D598-B080-5C8E-AA35-D43EC0D5F886',
- ],
+ 'requestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '38b079f1-7846-4226-8c90-3e2644b5c52b'],
+ 'totalCount' => ['title' => '', 'description' => 'The total number of entries.', 'type' => 'integer', 'format' => 'int32', 'example' => '14'],
'result' => [
- 'title' => 'DeployGraph',
- 'description' => 'The results returned.'."\n",
- 'type' => 'object',
- 'properties' => [
- 'graph' => [
- 'description' => 'The deployment information.'."\n",
- 'type' => 'object',
- 'properties' => [
- 'onlineMaster' => [
- 'title' => '在线集群元信息',
- 'description' => 'The metadata of online clusters.'."\n",
- 'type' => 'array',
- 'items' => [
- 'type' => 'object',
- 'properties' => [
- 'id' => [
- 'description' => 'The ID of the data center.'."\n",
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '1',
- ],
- 'name' => [
- 'description' => 'The name of the online cluster.'."\n",
- 'type' => 'string',
- 'example' => ' '."\n"
- .'ha-cn-pl32rf0****_hz_pre_vpc_domain_1',
- ],
- 'domainName' => [
- 'description' => 'The name of the data center.'."\n",
- 'type' => 'string',
- 'example' => 'hz_pre_vpc_domain_1',
- ],
- 'hippoId' => [
- 'description' => 'The resource ID.'."\n",
- 'type' => 'string',
- 'example' => '5377',
- ],
- ],
- ],
- ],
- 'zoneMetas' => [
- 'title' => 'zone元信息',
- 'description' => 'The zone metadata.'."\n",
- 'type' => 'array',
- 'items' => [
- 'description' => '',
- 'type' => 'object',
- 'properties' => [
- 'name' => [
- 'description' => 'The name of the Query Result Searcher (QRS) worker.'."\n",
- 'type' => 'string',
- 'example' => 'ha-cn-pl32rf0****_qrs',
- ],
- 'tag' => [
- 'description' => 'The tag.'."\n",
- 'type' => 'string',
- 'example' => ' '."\n"
- .'ha-cn-pl32rf0****_qrs_hz_pre_vpc_domain_1',
- ],
- 'suezAdminName' => [
- 'description' => 'The name of the service that is used to manage the relationships between online clusters and indexes.'."\n",
- 'type' => 'string',
- 'example' => ' '."\n"
- .'ha-cn-pl32rf0****_hz_pre_vpc_domain_1',
- ],
- 'type' => [
- 'description' => 'The node type.'."\n",
- 'type' => 'string',
- 'example' => 'qrs',
- ],
- 'domainInfo' => [
- 'description' => 'The name of the data center.'."\n",
- 'type' => 'string',
- 'example' => 'hz_pre_vpc_domain_1',
- ],
- ],
- ],
- ],
- 'tableMetas' => [
- 'title' => '数据源元信息',
- 'description' => 'The metadata of data sources.'."\n",
- 'type' => 'array',
- 'items' => [
+ 'title' => '',
+ 'description' => 'The model list. For more information, see Model.',
+ 'type' => 'array',
+ 'items' => [
+ 'title' => '',
+ 'description' => 'The model information.',
+ 'type' => 'object',
+ 'properties' => [
+ 'name' => ['title' => '', 'description' => 'The model name.', 'type' => 'string', 'example' => 'test'],
+ 'type' => ['title' => '', 'description' => 'The model type.'."\n"
+ ."\n"
+ .'- a. Text embedding: text_embedding'."\n"
+ .'- b. Text sparse embedding: text_sparse_embedding'."\n"
+ .'- c. Image embedding: image_embedding'."\n"
+ .'- d. Image content analysis: image_analyze.', 'type' => 'string', 'example' => 'text_embedding'],
+ 'url' => ['title' => '', 'description' => 'The access URL of the model service.', 'type' => 'string', 'example' => 'http://***.platform-cn-shanghai.opensearch.aliyuncs.com/v3/openapi/workspaces/default/text-embedding/ops-text-embedding-001'],
+ 'status' => [
+ 'title' => '',
+ 'description' => 'The model status. Valid values:'."\n"
+ .' * ok: The model is available.'."\n"
+ .' * forbidden: The model is unavailable.',
+ 'type' => 'string',
+ 'enum' => ['ok', 'forbidden'],
+ 'example' => 'ok',
+ ],
+ 'dimension' => ['title' => '', 'description' => 'The dimension of the model.', 'type' => 'integer', 'format' => 'int32', 'example' => '128'],
+ 'content' => [
+ 'title' => '',
+ 'description' => 'The content information of the model.',
+ 'type' => 'object',
+ 'properties' => [
+ 'modelName' => ['title' => '', 'description' => 'The model name.', 'type' => 'string', 'example' => 'test'],
+ 'modelType' => ['title' => '', 'description' => 'The model type.'."\n"
+ ."\n"
+ .'- a. Text embedding: text_embedding'."\n"
+ .'- b. Text sparse embedding: text_sparse_embedding'."\n"
+ .'- c. Image embedding: image_embedding'."\n"
+ .'- d. Image content analysis: image_analyze.', 'type' => 'string', 'example' => 'text_embedding'],
+ 'url' => ['title' => '', 'description' => 'The access URL of the model service.', 'type' => 'string', 'example' => 'http://***.platform-cn-shanghai.opensearch.aliyuncs.com/v3/openapi/workspaces/default/text-embedding/ops-text-embedding-001'],
+ 'method' => ['title' => '', 'description' => 'The HTTP method for accessing the model service. PUT and POST are supported.', 'type' => 'string', 'example' => 'POST'],
+ 'request' => [
+ 'title' => '',
+ 'description' => 'The request configuration information.',
'type' => 'object',
'properties' => [
- 'tableDeployId' => [
- 'description' => 'The deployment ID of the table.'."\n",
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '2177',
- ],
- 'name' => [
- 'description' => 'The name of the data source.'."\n",
- 'type' => 'string',
- 'example' => 'ha-cn-pl32rf0****_test_api',
- ],
- 'tag' => [
- 'description' => 'The tag.'."\n",
- 'type' => 'string',
- 'example' => 'ha-cn-pl32rf0****_test_api_hz_pre_vpc_domain_1',
- ],
- 'domainName' => [
- 'description' => 'The name of the data center.'."\n",
- 'type' => 'string',
- 'example' => 'hz_pre_vpc_domain_1',
+ 'header' => [
+ 'title' => '',
+ 'description' => 'The HTTP header for accessing the model service.',
+ 'type' => 'object',
+ 'properties' => [
+ 'Authorization' => ['title' => '', 'description' => 'The authentication information. Format: Bearer access_token.', 'type' => 'string', 'example' => 'Bearer OS-v0********6vvs'."\n"],
+ 'Content-Type' => ['title' => '', 'description' => 'The HTTP request content type.', 'type' => 'string', 'example' => 'application/json'."\n"],
+ ],
+ 'example' => '',
],
- 'buildDeployId' => [
- 'description' => 'The ID of the offline deployment.'."\n",
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '1',
+ 'urlParams' => [
+ 'title' => '',
+ 'description' => 'The parameters in the URL. Some model services require parameters to be passed through the URL.',
+ 'type' => 'object',
+ 'properties' => [
+ 'build' => ['title' => '', 'description' => 'The parameters passed during index building.', 'type' => 'object', 'example' => 'key: value'],
+ 'search' => ['title' => '', 'description' => 'The parameters passed during queries.', 'type' => 'object', 'example' => 'key: value'],
+ ],
+ 'example' => '',
],
- 'type' => [
- 'description' => 'The type of the data source.'."\n",
- 'type' => 'string',
- 'example' => 'odps',
+ 'requestBody' => ['title' => '', 'description' => 'The template string of the request body.', 'type' => 'string', 'example' => '{\\"input\\": [\\"%{input}\\"], \\"input_type\\": \\"%{input_type}\\"}'],
+ 'parameters' => [
+ 'title' => '',
+ 'description' => 'The parameters that need to be differentiated between the build and search phases in the body. Define them in this parameter.',
+ 'type' => 'object',
+ 'properties' => [
+ 'build' => [
+ 'title' => '',
+ 'description' => 'The parameters for the index building phase.',
+ 'type' => 'object',
+ 'properties' => [
+ 'input_type' => [
+ 'title' => '',
+ 'description' => 'The input type.',
+ 'type' => 'string',
+ 'enum' => ['document'],
+ 'example' => 'query'."\n",
+ ],
+ ],
+ 'example' => '',
+ ],
+ 'search' => [
+ 'title' => '',
+ 'description' => 'The parameters for the query phase.',
+ 'type' => 'object',
+ 'properties' => [
+ 'input_type' => [
+ 'title' => '',
+ 'description' => 'The input type.',
+ 'type' => 'string',
+ 'enum' => ['query'],
+ 'example' => 'document'."\n",
+ ],
+ ],
+ 'example' => '',
+ ],
+ ],
+ 'example' => '',
],
],
+ 'example' => '',
],
- ],
- 'indexMetas' => [
- 'title' => '索引元信息',
- 'description' => 'The index metadata.'."\n",
- 'type' => 'array',
- 'items' => [
- 'description' => '',
+ 'response' => [
+ 'description' => 'Specifies how to parse the result information, described in JSON path format.',
'type' => 'object',
'properties' => [
- 'name' => [
- 'description' => 'The index name.'."\n",
- 'type' => 'string',
- 'example' => 'test_api',
- ],
- 'tag' => [
- 'description' => 'The tag.'."\n",
- 'type' => 'string',
- 'example' => 'test_api_hz_pre_vpc_domain_1',
- ],
- 'domainName' => [
- 'description' => 'The name of the data center.'."\n",
- 'type' => 'string',
- 'example' => 'hz_pre_vpc_domain_1',
- ],
- 'tableDeployId' => [
- 'description' => 'The deployment ID of the table.'."\n",
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '2409',
- ],
- 'tableName' => [
- 'description' => 'The name of the data source.'."\n",
- 'type' => 'string',
- 'example' => 'ha-cn-pl32rf0****_test_api',
- ],
- 'zoneName' => [
- 'description' => 'The name of the QRS worker.'."\n",
- 'type' => 'string',
- 'example' => 'ha-cn-pl32rf0****_qrs',
- ],
- ],
- ],
- ],
- 'zoneIndexRelation' => [
- 'title' => 'zone和索引关联关系',
- 'description' => 'The association relationships between zones and indexes.'."\n",
- 'type' => 'object',
- 'additionalProperties' => [
- 'type' => 'array',
- 'items' => [
- 'type' => 'string',
- 'example' => 'general_hz_pre_vpc_domain_1',
- 'description' => 'The cluster associated with the indexes.'."\n",
+ 'embeddings' => ['description' => 'Specifies how to parse the result information, described in JSON path format.', 'type' => 'string', 'example' => '$.result.embeddings[*].embedding'."\n", 'title' => ''],
],
- 'description' => 'The association relationships between zones and indexes.'."\n",
- ],
- ],
- 'tableIndexRelation' => [
- 'title' => '数据源和索引关联关系',
- 'description' => 'The association relationships between data sources and indexes.'."\n",
- 'type' => 'object',
- 'additionalProperties' => [
- 'type' => 'array',
- 'items' => [
- 'type' => 'string',
- 'example' => 'test_api_hz_pre_vpc_domain_1',
- 'description' => 'The table associated with the indexes.'."\n",
- ],
- 'description' => 'The association relationships between data sources and indexes.'."\n",
+ 'title' => '',
+ 'example' => '',
],
],
+ 'example' => '',
],
+ 'createTime' => ['title' => '', 'description' => 'The creation time.', 'type' => 'string', 'example' => '2024-05-21 16:05:26'],
+ 'updateTime' => ['title' => '', 'description' => 'The last modification time.', 'type' => 'string', 'example' => '2024-05-21 16:05:26'],
],
+ 'example' => '',
],
- 'example' => '{}',
+ 'example' => '',
],
],
- 'description' => 'The response parameters.'."\n",
- 'title' => 'Schema of Response',
+ 'example' => '',
+ ],
+ ],
+ ],
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'title' => 'List models',
+ 'summary' => 'Queries a list of models that meet specified conditions by instance ID.',
+ 'description' => '## Operation description'."\n"
+ .'This API operation retrieves a list of models from a specified instance. You can filter results by model name, type, and pagination parameters. Provide the instance ID as a path parameter. Other filter conditions are optional query parameters.',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'list',
+ 'ramAction' => [
+ 'action' => 'searchengine:ListModels',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SearchEngine', 'resourceType' => 'Instance', 'arn' => 'acs:searchengine:{#regionId}:{#accountId}:instance/{#InstanceId}'],
+ ],
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"38b079f1-7846-4226-8c90-3e2644b5c52b\\",\\n \\"totalCount\\": 14,\\n \\"result\\": [\\n {\\n \\"name\\": \\"test\\",\\n \\"type\\": \\"text_embedding\\",\\n \\"url\\": \\"http://***.platform-cn-shanghai.opensearch.aliyuncs.com/v3/openapi/workspaces/default/text-embedding/ops-text-embedding-001\\",\\n \\"status\\": \\"ok\\",\\n \\"dimension\\": 128,\\n \\"content\\": {\\n \\"modelName\\": \\"test\\",\\n \\"modelType\\": \\"text_embedding\\",\\n \\"url\\": \\"http://***.platform-cn-shanghai.opensearch.aliyuncs.com/v3/openapi/workspaces/default/text-embedding/ops-text-embedding-001\\",\\n \\"method\\": \\"POST\\",\\n \\"request\\": {\\n \\"header\\": {\\n \\"Authorization\\": \\"Bearer OS-v0********6vvs\\\\n\\",\\n \\"Content-Type\\": \\"application/json\\\\n\\"\\n },\\n \\"urlParams\\": {\\n \\"build\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n },\\n \\"search\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n }\\n },\\n \\"requestBody\\": \\"{\\\\\\\\\\\\\\"input\\\\\\\\\\\\\\": [\\\\\\\\\\\\\\"%{input}\\\\\\\\\\\\\\"], \\\\\\\\\\\\\\"input_type\\\\\\\\\\\\\\": \\\\\\\\\\\\\\"%{input_type}\\\\\\\\\\\\\\"}\\",\\n \\"parameters\\": {\\n \\"build\\": {\\n \\"input_type\\": \\"query\\\\n\\"\\n },\\n \\"search\\": {\\n \\"input_type\\": \\"document\\\\n\\"\\n }\\n }\\n },\\n \\"response\\": {\\n \\"embeddings\\": \\"$.result.embeddings[*].embedding\\\\n\\"\\n }\\n },\\n \\"createTime\\": \\"2024-05-21 16:05:26\\",\\n \\"updateTime\\": \\"2024-05-21 16:05:26\\"\\n }\\n ]\\n}","type":"json"}]',
+ ],
+ 'ListOnlineConfigs' => [
+ 'path' => '/openapi/ha3/instances/{instanceId}/node/{nodeName}/online-configs',
+ 'methods' => ['get'],
+ 'schemes' => ['https', 'http'],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'read',
+ 'deprecated' => false,
+ 'systemTags' => ['operationType' => 'list'],
+ 'parameters' => [
+ [
+ 'name' => 'instanceId',
+ 'in' => 'path',
+ 'schema' => ['description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'example' => 'ha-cn-pl32rf0****', 'title' => ''],
+ ],
+ [
+ 'name' => 'nodeName',
+ 'in' => 'path',
+ 'schema' => ['description' => 'The name of the Query Result Searcher (QRS) worker.', 'type' => 'string', 'required' => true, 'example' => 'ha-cn-pl32rf0****_qrs', 'title' => ''],
+ ],
+ [
+ 'name' => 'domain',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The name of the domain', 'type' => 'string', 'required' => true, 'example' => 'sz_vpc_domain_1', 'title' => ''],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'requestId' => ['title' => '', 'description' => 'id of request', 'type' => 'string', 'example' => 'E45380E8-994A-5402-9806-F114B3295FCF'],
+ 'result' => [
+ 'title' => '',
+ 'description' => 'List',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'The list of configuration results',
+ 'type' => 'object',
+ 'properties' => [
+ 'indexName' => ['description' => 'The name of the index', 'type' => 'string', 'example' => 'generation', 'title' => ''],
+ 'config' => ['description' => 'The configuration information', 'type' => 'string', 'example' => '{\\"specItems\\":[{\\"specKey\\":\\"YQ_KEYWORD_NUMBER_PLUS\\",\\"value\\":\\"1\\"}]}', 'title' => ''],
+ ],
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'example' => '',
+ ],
+ ],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
],
500 => [],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"E7B7D598-B080-5C8E-AA35-D43EC0D5F886\\",\\n \\"result\\": {\\n \\"graph\\": {\\n \\"onlineMaster\\": [\\n {\\n \\"id\\": 1,\\n \\"name\\": \\"\\\\t\\\\nha-cn-pl32rf0****_hz_pre_vpc_domain_1\\",\\n \\"domainName\\": \\"hz_pre_vpc_domain_1\\",\\n \\"hippoId\\": \\"5377\\"\\n }\\n ],\\n \\"zoneMetas\\": [\\n {\\n \\"name\\": \\"ha-cn-pl32rf0****_qrs\\",\\n \\"tag\\": \\"\\\\t\\\\nha-cn-pl32rf0****_qrs_hz_pre_vpc_domain_1\\",\\n \\"suezAdminName\\": \\"\\\\t\\\\nha-cn-pl32rf0****_hz_pre_vpc_domain_1\\",\\n \\"type\\": \\"qrs\\",\\n \\"domainInfo\\": \\"hz_pre_vpc_domain_1\\"\\n }\\n ],\\n \\"tableMetas\\": [\\n {\\n \\"tableDeployId\\": 2177,\\n \\"name\\": \\"ha-cn-pl32rf0****_test_api\\",\\n \\"tag\\": \\"ha-cn-pl32rf0****_test_api_hz_pre_vpc_domain_1\\",\\n \\"domainName\\": \\"hz_pre_vpc_domain_1\\",\\n \\"buildDeployId\\": 1,\\n \\"type\\": \\"odps\\"\\n }\\n ],\\n \\"indexMetas\\": [\\n {\\n \\"name\\": \\"test_api\\",\\n \\"tag\\": \\"test_api_hz_pre_vpc_domain_1\\",\\n \\"domainName\\": \\"hz_pre_vpc_domain_1\\",\\n \\"tableDeployId\\": 2409,\\n \\"tableName\\": \\"ha-cn-pl32rf0****_test_api\\",\\n \\"zoneName\\": \\"ha-cn-pl32rf0****_qrs\\"\\n }\\n ],\\n \\"zoneIndexRelation\\": {\\n \\"key\\": [\\n \\"general_hz_pre_vpc_domain_1\\"\\n ]\\n },\\n \\"tableIndexRelation\\": {\\n \\"key\\": [\\n \\"test_api_hz_pre_vpc_domain_1\\"\\n ]\\n }\\n }\\n }\\n}","type":"json"}]',
- 'title' => 'GetDeployGraph',
- 'description' => '## Method'."\n"
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"E45380E8-994A-5402-9806-F114B3295FCF\\",\\n \\"result\\": [\\n {\\n \\"indexName\\": \\"generation\\",\\n \\"config\\": \\"{\\\\\\\\\\\\\\"specItems\\\\\\\\\\\\\\":[{\\\\\\\\\\\\\\"specKey\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"YQ_KEYWORD_NUMBER_PLUS\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"value\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"1\\\\\\\\\\\\\\"}]}\\"\\n }\\n ]\\n}","type":"json"}]',
+ 'title' => 'ListOnlineConfigs',
+ 'summary' => 'Query an online configuration.',
+ 'description' => '### Method'."\n"
."\n"
+ .'```java'."\n"
.'GET'."\n"
+ .'```'."\n"
."\n"
- .'## URI'."\n"
+ .'### URI'."\n"
."\n"
.'```java'."\n"
- .'/openapi/ha3/instances/{instanceId}/deploy-graph'."\n"
- .'```'."\n",
- 'requestParamsDescription' => '### Sample requests'."\n"
+ .'/openapi/ha3/instances/{instanceId}/node/{nodeName}/online-configs?domain={domain}'."\n"
+ .'```',
+ 'requestParamsDescription' => '\\### Sample requests'."\n"
."\n"
.'```java'."\n"
- ."\n"
- .'GET /openapi/ha3/instances/{instanceId}/deploy-graph'."\n"
- .'```'."\n",
+ .'GET /openapi/ha3/instances/ha-test1/node/ihome_searcher/online-configs?domain=pre_ea120'."\n"
+ .'```',
'responseParamsDescription' => '### Sample responses'."\n"
."\n"
.'Success responses '."\n"
@@ -13563,259 +10352,62 @@
.'```java'."\n"
.'{'."\n"
.''."\n"
- .' "requestId": "0A6EB64B-B4C8-CF02-810F-E660812972FF",'."\n"
- .''."\n"
- .' "result": {'."\n"
- .''."\n"
- .' "app": {'."\n"
- .''."\n"
- .' "creator": "74087",'."\n"
- .''."\n"
- .' "gmtModified": 1628151698000,'."\n"
- .''."\n"
- .' "groupId": 596,'."\n"
- .''."\n"
- .' "platformType": "tisplus",'."\n"
- .''."\n"
- .' "description": "qrs",'."\n"
- .''."\n"
- .' "gmtCreate": 1628151698000,'."\n"
- .''."\n"
- .' "isActive": 0,'."\n"
- .''."\n"
- .' "type": "online_group",'."\n"
- .''."\n"
- .' "appStatus": 0,'."\n"
- .''."\n"
- .' "procStatus": 0,'."\n"
- .''."\n"
- .' "isDeleted": 0,'."\n"
- .''."\n"
- .' "name": "search4TestPlugin",'."\n"
- .''."\n"
- .' "id": 5171'."\n"
- .''."\n"
- .' },'."\n"
- .''."\n"
- .' "hippos": [],'."\n"
- .''."\n"
- .' "appGroupName": "biz",'."\n"
- .''."\n"
- .' "name": "search4TestPlugin",'."\n"
+ .' "requestId": "e1eef569-1ff7-4bf8-acf7-1cecca9894ce",'."\n"
.''."\n"
- .' "availableDeploys": ['."\n"
+ .' "result": ['."\n"
.''."\n"
.' {'."\n"
.''."\n"
- .' "gmtModified": 1594193012000,'."\n"
- .''."\n"
- .' "virtualDomainList": "6,7,8",'."\n"
- .''."\n"
- .' "platformType": "[\\"tisplus\\",\\"tisplus_khronos\\",\\"tisplus_dingtalk\\"]",'."\n"
- .''."\n"
- .' "description": "pre_et2",'."\n"
- .''."\n"
- .' "groups": "",'."\n"
- .''."\n"
- .' "gmtCreate": 1565752477000,'."\n"
- .''."\n"
- .' "type": "INNET",'."\n"
- .''."\n"
- .' "modules": "[\\"online\\"]",'."\n"
- .''."\n"
- .' "foundationDetailList": "15,16,17,18,19,20,21,22,23,24,25,26,27,28,29,94",'."\n"
- .''."\n"
- .' "name": "pre_et2",'."\n"
- .''."\n"
- .' "hippoId": "hippo_et2_7u",'."\n"
+ .' "indexName": "nm_algo_dense_weights",'."\n"
.''."\n"
- .' "id": 5'."\n"
+ .' "config": "{\\"realtime\\":false,\\"cluster_config\\":{\\"table_name\\":\\"nm_algo_dense_weights\\"},\\"online_index_config\\":{\\"online_keep_version_count\\":3,\\"build_config\\":{\\"build_total_memory\\":1024},\\"max_realtime_memory_use\\":1024,\\"load_config\\":[{\\"file_patterns\\":[\\".*\\"],\\"load_strategy\\":\\"mmap\\",\\"load_strategy_param\\":{\\"slice\\":409600,\\"lock\\":true,\\"interval\\":2}},{\\"file_patterns\\":[\\".*\\"],\\"load_strategy\\":\\"mmap\\",\\"load_strategy_param\\":{\\"slice\\":409600,\\"lock\\":true,\\"interval\\":2}},{\\"file_patterns\\":[\\"/summary/data\\"],\\"load_strategy\\":\\"cache\\",\\"load_strategy_param\\":{\\"direct_io\\":true,\\"cache_size\\":512}},{\\"warmup_strategy\\":\\"none\\",\\"file_patterns\\":[\\".*\\"],\\"load_strategy\\":\\"mmap\\",\\"load_strategy_param\\":{\\"lock\\":false}}]},\\"build_option_config\\":{\\"async_queue_size\\":1000,\\"max_recover_time\\":10,\\"async_build\\":true}}"'."\n"
.''."\n"
.' },'."\n"
.''."\n"
.' {'."\n"
.''."\n"
- .' "gmtModified": 1571642223000,'."\n"
- .''."\n"
- .' "platformType": "[\\"tisplus\\"]",'."\n"
- .''."\n"
- .' "description": "oc27",'."\n"
- .''."\n"
- .' "groups": "",'."\n"
- .''."\n"
- .' "gmtCreate": 1571642223000,'."\n"
- .''."\n"
- .' "type": "INNET",'."\n"
- .''."\n"
- .' "modules": "[\\"online\\"]",'."\n"
- .''."\n"
- .' "foundationDetailList": "67,68,69,70,71,72,73,74,75,76,77,78,79",'."\n"
- .''."\n"
- .' "name": "oc27_pre",'."\n"
- .''."\n"
- .' "hippoId": "hippo_7u_oc27",'."\n"
- .''."\n"
- .' "id": 15'."\n"
- .''."\n"
- .' }'."\n"
- .''."\n"
- .' ],'."\n"
- .''."\n"
- .' "graph": {'."\n"
- .''."\n"
- .' "zoneMetas": ['."\n"
- .''."\n"
- .' {'."\n"
- .''."\n"
- .' "suezAdminName": "search4TestPlugin_pre",'."\n"
- .''."\n"
- .' "zoneMetaId": 8509,'."\n"
- .''."\n"
- .' "domainInfo": "pre",'."\n"
- .''."\n"
- .' "mainZone": true,'."\n"
- .''."\n"
- .' "name": "search4TestPlugin_qrs",'."\n"
- .''."\n"
- .' "zoneId": 11379,'."\n"
- .''."\n"
- .' "tag": "search4TestPlugin_qrs_pre",'."\n"
- .''."\n"
- .' "clusterId": 5265,'."\n"
- .''."\n"
- .' "type": "qrs"'."\n"
- .''."\n"
- .' },'."\n"
- .''."\n"
- .' {'."\n"
- .''."\n"
- .' "suezAdminName": "search4TestPlugin_pre",'."\n"
- .''."\n"
- .' "zoneMetaId": 8510,'."\n"
- .''."\n"
- .' "domainInfo": "pre",'."\n"
- .''."\n"
- .' "mainZone": true,'."\n"
- .''."\n"
- .' "name": "test_searcher",'."\n"
- .''."\n"
- .' "zoneId": 11380,'."\n"
- .''."\n"
- .' "tag": "test_searcher_pre",'."\n"
- .''."\n"
- .' "clusterId": 5265,'."\n"
- .''."\n"
- .' "type": "searcher"'."\n"
- .''."\n"
- .' }'."\n"
- .''."\n"
- .' ],'."\n"
- .''."\n"
- .' "tableIndexRelation": {'."\n"
- .''."\n"
- .' "product_sku_pre_ea120": ['."\n"
- .''."\n"
- .' "product_sku_pre_ea120"'."\n"
+ .' "indexName": "search4_mj_mos_item_index",'."\n"
.''."\n"
- .' ]'."\n"
+ .' "config": "{\\"realtime\\":true,\\"cluster_config\\":{\\"table_name\\":\\"search4_mj_mos_item_index\\"},\\"online_index_config\\":{\\"online_keep_version_count\\":3,\\"build_config\\":{\\"build_total_memory\\":4096},\\"max_realtime_memory_use\\":8192,\\"load_config\\":[{\\"warmup_strategy\\":\\"sequential\\",\\"file_patterns\\":[\\"_INDEX_\\"],\\"load_strategy\\":\\"mmap\\",\\"name\\":\\"_INDEX_\\",\\"load_strategy_param\\":{\\"lock\\":true}},{\\"warmup_strategy\\":\\"none\\",\\"file_patterns\\":[\\"_SUMMARY_\\"],\\"load_strategy\\":\\"mmap\\",\\"name\\":\\"_SUMMARY_\\",\\"load_strategy_param\\":{\\"lock\\":true}},{\\"warmup_strategy\\":\\"sequential\\",\\"file_patterns\\":[\\"_ATTRIBUTE_\\"],\\"load_strategy\\":\\"mmap\\",\\"name\\":\\"_ATTRIBUTE_\\",\\"load_strategy_param\\":{\\"lock\\":true}}],\\"speedup_primary_key_reader\\":true},\\"build_option_config\\":{\\"async_queue_size\\":10000,\\"max_recover_time\\":10,\\"async_build\\":true}}"'."\n"
.''."\n"
.' },'."\n"
.''."\n"
- .' "onlineMaster": ['."\n"
- .''."\n"
- .' {'."\n"
- .''."\n"
- .' "appId": 5171,'."\n"
- .''."\n"
- .' "domainId": 1,'."\n"
- .''."\n"
- .' "domainName": "pre",'."\n"
- .''."\n"
- .' "gmtCreate": 1628561292000,'."\n"
- .''."\n"
- .' "gmtModified": 1628562498000,'."\n"
- .''."\n"
- .' "hippoGroupId": "20",'."\n"
- .''."\n"
- .' "id": 5265,'."\n"
- .''."\n"
- .' "monitorStatus": 1,'."\n"
- .''."\n"
- .' "name": "search4TestPlugin_pre",'."\n"
- .''."\n"
- .' "processorInfoId": 27789,'."\n"
- .''."\n"
- .' "zkAddr": ""'."\n"
- .''."\n"
- .' }'."\n"
- .''."\n"
- .' ],'."\n"
- .''."\n"
- .' "indexMetas": ['."\n"
- .''."\n"
- .' {'."\n"
- .''."\n"
- .' "tableDeployId": 7366,'."\n"
- .''."\n"
- .' "zoneMetaId": 8510,'."\n"
- .''."\n"
- .' "domainName": "pre_ea120",'."\n"
- .''."\n"
- .' "name": "product_sku",'."\n"
- .''."\n"
- .' "tableId": 6866,'."\n"
- .''."\n"
- .' "tag": "product_sku_pre_ea120",'."\n"
- .''."\n"
- .' "zoneName": "test_searcher",'."\n"
- .''."\n"
- .' "tableName": "product_sku"'."\n"
- .''."\n"
- .' }'."\n"
- .''."\n"
- .' ],'."\n"
- .''."\n"
- .' "offlineMaster": ['."\n"
- .''."\n"
- .' {'."\n"
- .''."\n"
- .' "appId": 5214,'."\n"
- .''."\n"
- .' "domainId": 18,'."\n"
- .''."\n"
- .' "domainName": "pre_ea120",'."\n"
- .''."\n"
- .' "gmtCreate": 1628501863000,'."\n"
- .''."\n"
- .' "gmtModified": 1628501863000,'."\n"
- .''."\n"
- .' "id": 3751,'."\n"
- .''."\n"
- .' "isPublic": 2,'."\n"
- .''."\n"
- .' "monitorStatus": 1,'."\n"
+ .' {'."\n"
.''."\n"
- .' "name": "search4_multi_biz_bs",'."\n"
+ .' "indexName": "nm_algo_search_retrieval_item_index",'."\n"
.''."\n"
- .' "platformType": "tisplus",'."\n"
+ .' "config": "{\\"realtime\\":true,\\"cluster_config\\":{\\"table_name\\":\\"nm_algo_search_retrieval_item_index\\"},\\"online_index_config\\":{\\"online_keep_version_count\\":3,\\"build_config\\":{\\"build_total_memory\\":4096},\\"max_realtime_memory_use\\":8192,\\"load_config\\":[{\\"warmup_strategy\\":\\"sequential\\",\\"file_patterns\\":[\\"_INDEX_\\"],\\"load_strategy\\":\\"mmap\\",\\"name\\":\\"_INDEX_\\",\\"load_strategy_param\\":{\\"lock\\":true}},{\\"warmup_strategy\\":\\"none\\",\\"file_patterns\\":[\\"_SUMMARY_\\"],\\"load_strategy\\":\\"mmap\\",\\"name\\":\\"_SUMMARY_\\",\\"load_strategy_param\\":{\\"lock\\":true}},{\\"warmup_strategy\\":\\"sequential\\",\\"file_patterns\\":[\\"_ATTRIBUTE_\\"],\\"load_strategy\\":\\"mmap\\",\\"name\\":\\"_ATTRIBUTE_\\",\\"load_strategy_param\\":{\\"lock\\":true}}],\\"speedup_primary_key_reader\\":true},\\"build_option_config\\":{\\"async_queue_size\\":10000,\\"max_recover_time\\":10,\\"async_build\\":true}}"'."\n"
.''."\n"
- .' "processorInfoId": 27755,'."\n"
+ .' } '."\n"
.''."\n"
- .' "zkAddr": ""'."\n"
+ .' ]'."\n"
.''."\n"
- .' }'."\n"
+ .'}'."\n"
.'```',
- ],
- 'GetNodeConfig' => [
- 'summary' => 'Gets the configuration information of a node.',
- 'path' => '/openapi/ha3/instances/{instanceId}/node-config',
- 'methods' => [
- 'get',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListOnlineConfigs'],
+ ],
],
- 'schemes' => [
- 'http',
- 'https',
+ 'ramActions' => [
+ [
+ 'operationType' => 'list',
+ 'ramAction' => [
+ 'action' => 'searchengine:ListOnlineConfigs',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SearchEngine', 'resourceType' => 'Instance', 'arn' => 'acs:searchengine:{#regionId}:{#accountId}:instance/{#instanceId}'],
+ ],
+ ],
+ ],
],
+ ],
+ 'ListPausePolicys' => [
+ 'path' => '/openapi/ha3/instances/{instanceId}/pause-policies',
+ 'methods' => ['get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
@@ -13824,135 +10416,265 @@
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
- 'operationType' => 'get',
- 'abilityTreeCode' => '104681',
- 'abilityTreeNodes' => [
- 'FEATUREopensearchIQC42D',
- ],
+ 'operationType' => 'list',
+ 'abilityTreeCode' => '178009',
+ 'abilityTreeNodes' => ['FEATUREopensearch5EAGY5'],
],
'parameters' => [
[
'name' => 'instanceId',
'in' => 'path',
+ 'schema' => ['description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'ha-cn-pl32rf0****'],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
'schema' => [
- 'description' => 'The instance ID.'."\n",
- 'type' => 'string',
- 'required' => true,
- 'example' => 'ha-cn-0ju2rewdi02',
+ 'type' => 'object',
+ 'properties' => [
+ 'requestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '2AE63638-5420-56DC-BF59-37D8174039A0'],
+ 'result' => [
+ 'title' => '',
+ 'description' => 'The returned result.',
+ 'type' => 'object',
+ 'additionalProperties' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'pauseAll' => ['title' => '', 'description' => 'Specifies whether to pause deployments to all destinations.', 'type' => 'boolean', 'example' => 'true'],
+ 'pauseIndex' => ['title' => '', 'description' => 'Specifies whether to pause deployments of new full indexes.', 'type' => 'boolean', 'example' => 'true'],
+ 'pauseIndexBatch' => ['title' => '', 'description' => 'Specifies whether to pause deployments of incremental batches.', 'type' => 'boolean', 'example' => 'true'],
+ 'pauseBiz' => ['title' => '', 'description' => 'Specifies whether to pause configuration deployments.', 'type' => 'boolean', 'example' => 'true'],
+ 'pauseRuntime' => ['title' => '', 'description' => 'Specifies whether to pause real-time incremental updates.', 'type' => 'boolean', 'example' => 'true'],
+ ],
+ 'description' => 'The returned result.',
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'example' => '',
+ ],
+ ],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
+ ],
+ ],
+ 500 => [],
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"2AE63638-5420-56DC-BF59-37D8174039A0\\",\\n \\"result\\": {\\n \\"key\\": {\\n \\"pauseAll\\": true,\\n \\"pauseIndex\\": true,\\n \\"pauseIndexBatch\\": true,\\n \\"pauseBiz\\": true,\\n \\"pauseRuntime\\": true\\n }\\n }\\n}","type":"json"}]',
+ 'title' => 'ListPausePolicys',
+ 'summary' => 'Queries pause policies.',
+ 'description' => '### Method'."\n"
+ ."\n"
+ .'```java'."\n"
+ .'GET'."\n"
+ .'```'."\n"
+ ."\n"
+ .'### URI'."\n"
+ ."\n"
+ .'```java'."\n"
+ .'/openapi/ha3/instances/{instanceId}/pause-policies'."\n"
+ .'```',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListPausePolicys'],
+ ],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'list',
+ 'ramAction' => [
+ 'action' => 'searchengine:ListPausePolicys',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SearchEngine', 'resourceType' => 'Instance', 'arn' => 'acs:searchengine:{#regionId}:{#accountId}:instance/{#InstanceId}'],
+ ],
],
],
+ ],
+ ],
+ 'ListPostQueryResult' => [
+ 'summary' => 'Retrieves the results of a search test for a Retrieval-Augmented Generation Edition instance by sending a POST request.',
+ 'path' => '/openapi/ha3/instances/{instanceId}/query',
+ 'methods' => ['post'],
+ 'schemes' => ['http', 'https'],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'read',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'list',
+ 'riskType' => 'none',
+ 'chargeType' => 'free',
+ 'abilityTreeCode' => '205312',
+ 'abilityTreeNodes' => ['FEATUREopensearchO9FNU6'],
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'instanceId',
+ 'in' => 'path',
+ 'schema' => ['description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'ha-cn-pl32rf0****'],
+ ],
[
'name' => 'type',
'in' => 'query',
+ 'schema' => ['title' => '', 'description' => 'sql: SQL query. ha3: HA3 query.', 'type' => 'string', 'required' => false, 'default' => 'sql', 'example' => 'ha3'],
+ ],
+ [
+ 'name' => 'body',
+ 'in' => 'body',
+ 'style' => 'json',
+ 'schema' => ['description' => 'The request structure.', 'type' => 'object', 'required' => false, 'title' => '', 'example' => '{"assemblyQuery":"query=id:1&&cluster=general&&config=start:0,hit:10,format:json"}'],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
'schema' => [
- 'title' => 'qrs: 查询节点, search: 数据节点, index: 索引节点, cluster: 集群',
- 'description' => 'The node type. Valid values:'."\n"
- ."\n"
- .'* qrs: Query Result Searcher (QRS) worker'."\n"
- .'* search: Search worker'."\n"
- .'* index: index'."\n"
- .'* cluster: cluster'."\n",
- 'type' => 'string',
- 'required' => false,
- 'example' => 'index',
+ 'type' => 'object',
+ 'properties' => [
+ 'requestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '022F36C7-9FB4-5D67-BEBC-3D14B0984463'],
+ 'result' => ['title' => '', 'description' => 'The returned result.', 'type' => 'any', 'example' => '{}'],
+ ],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
],
+ 500 => [],
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"022F36C7-9FB4-5D67-BEBC-3D14B0984463\\",\\n \\"result\\": \\"{}\\"\\n}","type":"json"}]',
+ 'title' => 'ListPostQueryResult',
+ 'description' => '### Method'."\n"
+ ."\n"
+ .'```java'."\n"
+ .'POST'."\n"
+ .'```'."\n"
+ ."\n"
+ .'### URI'."\n"
+ ."\n"
+ .'```java'."\n"
+ .'/openapi/ha3/instances/{instanceId}/query'."\n"
+ .'```',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'list',
+ 'ramAction' => [
+ 'action' => 'searchengine:ListPostQueryResult',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SearchEngine', 'resourceType' => 'Instance', 'arn' => 'acs:searchengine:{#regionId}:{#accountId}:instance/{#InstanceId}'],
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'ListQueryResult' => [
+ 'summary' => 'Queries the query result.',
+ 'path' => '/openapi/ha3/instances/{instanceId}/query',
+ 'methods' => ['get'],
+ 'schemes' => ['http', 'https'],
+ 'security' => [
[
- 'name' => 'name',
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'read',
+ 'deprecated' => false,
+ 'systemTags' => ['operationType' => 'get'],
+ 'parameters' => [
+ [
+ 'name' => 'instanceId',
+ 'in' => 'path',
+ 'schema' => ['title' => '', 'description' => 'The instance ID.'."\n", 'type' => 'string', 'required' => true, 'example' => 'ha-cn-pl32rf0****'],
+ ],
+ [
+ 'name' => 'query',
'in' => 'query',
- 'schema' => [
- 'description' => 'The node name.'."\n",
- 'type' => 'string',
- 'required' => false,
- 'example' => 'ha-cn-30174dhoz53_qrs',
- ],
+ 'schema' => ['description' => 'The query statement'."\n", 'type' => 'string', 'required' => false, 'example' => 'query%3D1%26%26config%3Dstart%3A0%2Chit%3A10%2Cformat%3Ajson%26%26cluster%3Dgeneral', 'title' => ''],
],
[
- 'name' => 'clusterName',
+ 'name' => 'sql',
'in' => 'query',
- 'schema' => [
- 'description' => 'The name of the cluster'."\n",
- 'type' => 'string',
- 'required' => false,
- 'example' => 'vpc_sh_domain_2',
- ],
+ 'schema' => ['description' => 'The SQL statement that is executed in the query'."\n", 'type' => 'string', 'required' => false, 'example' => 'query%3Dselect%20max(content_id)%20from%20generation', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
- 'description' => 'The response parameters.'."\n",
+ 'title' => '',
+ 'description' => 'Schema of Response'."\n",
'type' => 'object',
'properties' => [
- 'requestId' => [
- 'title' => 'id of request',
- 'description' => 'Id of the request',
- 'type' => 'string',
- 'example' => '2AE63638-5420-56DC-BF59-37D8174039A0',
- ],
- 'result' => [
- 'title' => 'NodeConfig',
- 'description' => 'The result set.'."\n",
- 'type' => 'object',
- 'properties' => [
- 'dataFragmentNumber' => [
- 'title' => '数据分片数',
- 'description' => 'The number of data shards.'."\n",
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '2',
- ],
- 'dataDuplicateNumber' => [
- 'title' => '数据副本数',
- 'description' => 'The number of data replicas.'."\n",
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '2',
- ],
- 'minServicePercent' => [
- 'title' => '最小服务比例',
- 'description' => 'The minimum service ratio.'."\n",
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '100',
- ],
- 'published' => [
- 'title' => '集群是否挂载',
- 'description' => 'Indicates whether the cluster is mounted.'."\n",
- 'type' => 'boolean',
- 'example' => 'true'."\n",
- ],
- 'active' => [
- 'title' => '在线生效（索引是否从在线下掉）',
- 'description' => 'Indicates whether the index is effective online.'."\n",
- 'type' => 'boolean',
- 'example' => '1',
- ],
- 'flowRatio' => [
- 'description' => 'The traffic percentage.'."\n",
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '0',
- ],
- ],
- ],
+ 'requestId' => ['title' => '', 'description' => 'The ID of the request'."\n", 'type' => 'string', 'example' => '9E5BCFAA-98B3-51D0-9188-B1BC07589337'],
],
+ 'example' => '',
],
],
500 => [],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"2AE63638-5420-56DC-BF59-37D8174039A0\\",\\n \\"result\\": {\\n \\"dataFragmentNumber\\": 1,\\n \\"dataDuplicateNumber\\": 1,\\n \\"minServicePercent\\": 50,\\n \\"published\\": true,\\n \\"active\\": true,\\n \\"flowRatio\\": 100\\n }\\n}","type":"json"}]',
- 'title' => 'GetNodeConfig',
- ],
- 'ListIndexRecoverRecords' => [
- 'path' => '/openapi/ha3/instances/{instanceId}/indexes/{indexName}/actions/list-recover-records',
- 'methods' => [
- 'get',
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"9E5BCFAA-98B3-51D0-9188-B1BC07589337\\"\\n}","type":"json"}]',
+ 'title' => 'ListQueryResult',
+ 'description' => '### [](#)Method'."\n"
+ ."\n"
+ .'`GET`'."\n"
+ ."\n"
+ .'### [](#uri)URI'."\n"
+ ."\n"
+ .'`/openapi/ha3/instances/{instanceId}/query?query=xxxx`'."\n",
+ 'responseParamsDescription' => '|Field|Type|Description|'."\n"
+ .'|---|---|---|'."\n"
+ .'|requestId|String|The ID of the request.|'."\n"
+ .'|result|String|The string returned by the Havenask engine. It can be in a JSON or an xmsql format.',
+ 'extraInfo' => '### Example'."\n"
+ ."\n"
+ .'**Sample requests**'."\n"
+ ."\n"
+ .' sql: GET /openapi/ha3/instances/ha3_instances_id/query?sql=query%3Dselect+%2A+from+mx_index1217'."\n"
+ ."\n"
+ .' query: GET /openapi/ha3/instances/ha3_instances_id/query?query=config%3Dhit%3A4%2Cformat%3Ajson%2Cfetch_summary_type%3Apk%2Cqrs_chain%3Asearch%26%26query%3Did%3A8148508889615505646%26%26cluster%3Dgeneral'."\n"
+ ."\n"
+ .'**Sample responses**'."\n"
+ ."\n"
+ .'Success responses'."\n"
+ ."\n"
+ .' {'."\n"
+ .' "requestId": "0A6EB64B-B4C8-CF02-810F-E660812972FF",'."\n"
+ .' "result": {}'."\n"
+ .' }'."\n",
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListQueryResult'],
+ ],
],
- 'schemes' => [
- 'http',
- 'https',
+ 'ramActions' => [
+ [
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'searchengine:ListQueryResult',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SearchEngine', 'resourceType' => 'Instance', 'arn' => 'acs:searchengine:{#regionId}:{#accountId}:instance/{#InstanceId}'],
+ ],
+ ],
+ ],
],
+ ],
+ 'ListRestQueryResult' => [
+ 'summary' => 'Retrieves the test results of a REST search query for a Retrieval Engine Edition instance.',
+ 'path' => '/openapi/ha3/instances/{instanceId}/rest-query',
+ 'methods' => ['post'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
@@ -13962,30 +10684,31 @@
'deprecated' => false,
'systemTags' => [
'operationType' => 'list',
- 'abilityTreeCode' => '218752',
- 'abilityTreeNodes' => [
- 'FEATUREopensearchSLLBIN',
- ],
+ 'riskType' => 'none',
+ 'chargeType' => 'free',
+ 'abilityTreeCode' => '171180',
+ 'abilityTreeNodes' => ['FEATUREopensearchO9FNU6'],
],
'parameters' => [
[
- 'name' => 'indexName',
+ 'name' => 'instanceId',
'in' => 'path',
- 'schema' => [
- 'description' => 'The index name.'."\n",
- 'type' => 'string',
- 'required' => true,
- 'example' => 'index_jiayi_text',
- ],
+ 'schema' => ['description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'ha-cn-pl32rf0****'],
],
[
- 'name' => 'instanceId',
- 'in' => 'path',
+ 'name' => 'body',
+ 'in' => 'body',
+ 'style' => 'json',
'schema' => [
- 'description' => 'The instance ID.'."\n",
- 'type' => 'string',
+ 'description' => 'The request structure.',
+ 'type' => 'object',
+ 'properties' => [
+ 'indexName' => ['title' => '', 'description' => 'The name of the index table.', 'type' => 'string', 'required' => false, 'example' => 'main_index'],
+ 'query' => ['title' => '', 'description' => 'The REST query.', 'type' => 'object', 'required' => false, 'example' => 'query%3Drelation_id%3A%221151274675_2%22%26%26cluster%3Dgeneral%26%26config%3Dstart%3A0%2Chit%3A10%2Cformat%3Ajson'],
+ ],
'required' => false,
- 'example' => 'ha-cn-i7m2rpzm605',
+ 'title' => '',
+ 'example' => '',
],
],
],
@@ -13994,39 +10717,54 @@
'schema' => [
'type' => 'object',
'properties' => [
- 'generationId' => [
- 'description' => 'The ID of the full index version.'."\n",
- 'type' => 'string',
- 'example' => '1708674867',
- ],
- 'desc' => [
- 'description' => 'The description.'."\n",
- 'type' => 'string',
- 'example' => 'test',
- ],
- 'finishedTime' => [
- 'description' => 'The time when the index version was published.'."\n",
- 'type' => 'string',
- 'example' => '2024-06-07 16:43:00',
- ],
+ 'requestId' => ['title' => '', 'description' => 'The ID of the request.', 'type' => 'string', 'example' => 'F43E8AB4-419C-5F4C-90D6-615590DFAA3C'],
+ 'result' => ['title' => '', 'description' => 'The returned result.', 'type' => 'any', 'example' => '{}'],
],
'description' => '',
+ 'title' => '',
+ 'example' => '',
],
],
500 => [],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"generationId\\": \\"1708674867\\",\\n \\"desc\\": \\"Custom Configuration\\",\\n \\"finishedTime\\": \\"2024-06-07 16:43:00\\"\\n}","type":"json"}]',
- 'title' => 'ListIndexRecoverRecords',
- ],
- 'ListPausePolicys' => [
- 'path' => '/openapi/ha3/instances/{instanceId}/pause-policies',
- 'methods' => [
- 'get',
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"F43E8AB4-419C-5F4C-90D6-615590DFAA3C\\",\\n \\"result\\": \\"{}\\"\\n}","type":"json"}]',
+ 'title' => 'ListRestQueryResult',
+ 'description' => '### Method'."\n"
+ ."\n"
+ .'```java'."\n"
+ .'POST'."\n"
+ .'```'."\n"
+ ."\n"
+ .'### URI'."\n"
+ ."\n"
+ .'```java'."\n"
+ .'/openapi/ha3/instances/{instanceId}/rest-query'."\n"
+ .'```',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListRestQueryResult'],
+ ],
],
- 'schemes' => [
- 'http',
- 'https',
+ 'ramActions' => [
+ [
+ 'operationType' => 'list',
+ 'ramAction' => [
+ 'action' => 'searchengine:ListRestQueryResult',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SearchEngine', 'resourceType' => 'Instance', 'arn' => 'acs:searchengine:{#regionId}:{#accountId}:instance/{#InstanceId}'],
+ ],
+ ],
+ ],
],
+ ],
+ 'ListSchemas' => [
+ 'summary' => 'Retrieves a list of schemas based on a data synchronization configuration.',
+ 'path' => '/openapi/ha3/instances/{instanceId}/schemas',
+ 'methods' => ['get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
@@ -14036,206 +10774,510 @@
'deprecated' => false,
'systemTags' => [
'operationType' => 'list',
- 'abilityTreeCode' => '178009',
- 'abilityTreeNodes' => [
- 'FEATUREopensearch5EAGY5',
- ],
+ 'abilityTreeCode' => '186763',
+ 'abilityTreeNodes' => ['FEATUREopensearchVHEWK3'],
],
'parameters' => [
[
+ 'name' => 'type',
+ 'in' => 'query',
+ 'schema' => ['title' => '', 'description' => 'odps, swift, saro, oss, unknown', 'type' => 'string', 'required' => true, 'example' => 'odps'],
+ ],
+ [
+ 'name' => 'endpoint',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The endpoint of the ODPS data source.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => 'http://service.cn-hangzhou.maxcompute.aliyun-inc.com/api'],
+ ],
+ [
+ 'name' => 'accessKey',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The AccessKey ID of the ODPS data source.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => 'L***p'],
+ ],
+ [
+ 'name' => 'accessSecret',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The alias of an ODPS data source.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => '5**9a6'],
+ ],
+ [
+ 'name' => 'project',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The name of the ODPS data source project.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => 'sec_odps'],
+ ],
+ [
+ 'name' => 'partition',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The data partition.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => 'dt=20230520'],
+ ],
+ [
+ 'name' => 'table',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The name of the table in the Saro or ODPS data source.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => 'item'],
+ ],
+ [
+ 'name' => 'namespace',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The namespace of the Saro data source.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => 'imm'],
+ ],
+ [
'name' => 'instanceId',
'in' => 'path',
+ 'schema' => ['description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'ha-cn-pl32rf0****'],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
'schema' => [
- 'description' => 'The instance ID.'."\n",
- 'type' => 'string',
- 'required' => true,
- 'example' => 'ha-cn-i7m2roiy504',
+ 'type' => 'object',
+ 'properties' => [
+ 'requestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => 'FE03180A-0E29-5474-8A86-33F0683294A4'],
+ 'result' => ['title' => '', 'description' => 'The response data.', 'type' => 'any', 'example' => '{}'],
+ ],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
],
+ 500 => [],
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"FE03180A-0E29-5474-8A86-33F0683294A4\\",\\n \\"result\\": \\"{}\\"\\n}","type":"json"}]',
+ 'title' => 'ListSchemas',
+ 'description' => '### Method'."\n"
+ ."\n"
+ .'```java'."\n"
+ .'GET'."\n"
+ .'```'."\n"
+ ."\n"
+ .'### URI'."\n"
+ ."\n"
+ .'```java'."\n"
+ .'/openapi/ha3/instances/{instanceId}/schemas'."\n"
+ .'```',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'list',
+ 'ramAction' => [
+ 'action' => 'searchengine:ListSchemas',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SearchEngine', 'resourceType' => 'Instance', 'arn' => 'acs:searchengine:{#regionId}:{#accountId}:instance/{#InstanceId}'],
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'ListTableGenerations' => [
+ 'summary' => 'Queries a list of index versions.',
+ 'path' => '/openapi/ha3/instances/{instanceId}/tables/{tableName}/index_versions',
+ 'methods' => ['get'],
+ 'schemes' => ['http', 'https'],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'read',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'list',
+ 'abilityTreeCode' => '218778',
+ 'abilityTreeNodes' => ['FEATUREopensearchGTRUN8'],
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'instanceId',
+ 'in' => 'path',
+ 'schema' => ['description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'example' => 'ha-cn-pl32rf0****', 'title' => ''],
+ ],
+ [
+ 'name' => 'tableName',
+ 'in' => 'path',
+ 'schema' => ['description' => 'The name of the table.', 'type' => 'string', 'required' => true, 'example' => 'test_summary', 'title' => ''],
+ ],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
- 'requestId' => [
- 'title' => 'id of request',
- 'description' => 'The request ID.'."\n",
- 'type' => 'string',
- 'example' => '2AE63638-5420-56DC-BF59-37D8174039A0',
- ],
+ 'requestId' => ['title' => '', 'description' => 'requestId', 'type' => 'string', 'example' => 'F6E3D968-529C-5C40-AFDD-133A8B8FD930'],
'result' => [
- 'title' => 'Map',
- 'description' => 'The result.'."\n",
- 'type' => 'object',
- 'additionalProperties' => [
+ 'title' => '',
+ 'description' => 'The result.',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => '',
'type' => 'object',
'properties' => [
- 'pauseAll' => [
- 'title' => '暂停全部目标下发',
- 'description' => 'Indicates whether all pushes are suspended.'."\n",
- 'type' => 'boolean',
- 'example' => 'true',
- ],
- 'pauseIndex' => [
- 'title' => '暂停新的全量版本下发',
- 'description' => 'Indicates whether the push is suspended for the new full index version.'."\n",
- 'type' => 'boolean',
- 'example' => 'true',
- ],
- 'pauseIndexBatch' => [
- 'title' => '暂停批次增量下发',
- 'description' => 'Indicates whether the push is suspended for the incremental indexes.'."\n",
- 'type' => 'boolean',
- 'example' => 'true',
- ],
- 'pauseBiz' => [
- 'title' => '暂停配置下发',
- 'description' => 'Indicates whether the push is suspended for the configuration.'."\n",
- 'type' => 'boolean',
- 'example' => 'true',
- ],
- 'pauseRuntime' => [
- 'title' => '暂停实时增量',
- 'description' => 'Indicates whether the push is suspended for the real-time incremental indexes.'."\n",
- 'type' => 'boolean',
- 'example' => 'true',
- ],
+ 'generationId' => ['description' => 'The ID of the full index version.', 'type' => 'integer', 'format' => 'int64', 'example' => '1708674867', 'title' => ''],
],
- 'description' => 'The results returned.'."\n",
+ 'title' => '',
+ 'example' => '',
],
+ 'example' => '',
],
],
'description' => '',
+ 'title' => '',
+ 'example' => '',
],
],
500 => [],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"2AE63638-5420-56DC-BF59-37D8174039A0\\",\\n \\"result\\": {\\n \\"key\\": {\\n \\"pauseAll\\": true,\\n \\"pauseIndex\\": true,\\n \\"pauseIndexBatch\\": true,\\n \\"pauseBiz\\": true,\\n \\"pauseRuntime\\": true\\n }\\n }\\n}","type":"json"}]',
- 'title' => 'ListPausePolicys',
- ],
- 'ModifyPausePolicy' => [
- 'path' => '/openapi/ha3/instances/{instanceId}/pause-policies',
- 'methods' => [
- 'put',
- ],
- 'schemes' => [
- 'http',
- 'https',
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"F6E3D968-529C-5C40-AFDD-133A8B8FD930\\",\\n \\"result\\": [\\n {\\n \\"generationId\\": 1708674867\\n }\\n ]\\n}","type":"json"}]',
+ 'title' => 'ListTableGenerations',
+ 'description' => '### Method'."\n"
+ ."\n"
+ .'```java'."\n"
+ .'GET'."\n"
+ .'```'."\n"
+ ."\n"
+ .'### URI'."\n"
+ ."\n"
+ .'```java'."\n"
+ .'/openapi/ha3/instances/{instanceId}/tables/{tableName}/index_versions'."\n"
+ .'```',
+ 'requestParamsDescription' => '### [](#)Sample requests'."\n"
+ ."\n"
+ .'```java'."\n"
+ .'GET /v2/instances/{instanceId}/tables/{tableName}/index_versions'."\n"
+ .'```',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'list',
+ 'ramAction' => [
+ 'action' => 'searchengine:ListTableGenerations',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SearchEngine', 'resourceType' => 'Instance', 'arn' => 'acs:searchengine:{#regionId}:{#accountId}:instance/{#InstanceId}'],
+ ],
+ ],
+ ],
],
+ ],
+ 'ListTables' => [
+ 'summary' => 'Queries a list of index tables.',
+ 'path' => '/openapi/ha3/instances/{instanceId}/tables',
+ 'methods' => ['get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
- 'operationType' => 'write',
+ 'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
- 'operationType' => 'update',
- 'abilityTreeCode' => '178006',
- 'abilityTreeNodes' => [
- 'FEATUREopensearch0Z9KDD',
- ],
+ 'operationType' => 'list',
+ 'abilityTreeCode' => '218776',
+ 'abilityTreeNodes' => ['FEATUREopensearchGTRUN8'],
],
'parameters' => [
[
'name' => 'instanceId',
'in' => 'path',
+ 'schema' => ['description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'example' => 'ha-cn-pl32rf0****', 'title' => ''],
+ ],
+ [
+ 'name' => 'newMode',
+ 'in' => 'query',
+ 'schema' => ['description' => 'Specifies whether the OpenSearch Vector Search Edition instance is of the new version.', 'type' => 'boolean', 'default' => 'true', 'required' => false, 'example' => 'true', 'title' => ''],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
'schema' => [
- 'description' => 'The instance ID.'."\n",
- 'type' => 'string',
- 'required' => true,
- 'example' => 'ha-cn-zvp2jlr2g03',
+ 'type' => 'object',
+ 'properties' => [
+ 'requestId' => ['title' => '', 'description' => 'requestId', 'type' => 'string', 'example' => '10D5E615-69F7-5F49-B850-00169ADE513C'],
+ 'result' => [
+ 'title' => '',
+ 'description' => 'The result.',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => '',
+ 'type' => 'object',
+ 'properties' => [
+ 'name' => ['description' => 'The index name.', 'type' => 'string', 'title' => '', 'example' => 'es_test_1b'],
+ 'indexStatus' => ['description' => 'The state of the index table. Valid values: NEW, PUBLISH, IN\\_USE, NOT\\_USE, STOP\\_USE, RESTORE\\_USE, and FAIL. After an index is created in an OpenSearch Retrieval Engine Edition instance, the index enters the IN\\_USE state. If the first full index fails to be created in an OpenSearch Vector Search Edition instance of the new version, the index is in the FAIL state.', 'type' => 'string', 'title' => '', 'example' => 'IN_USE'],
+ 'status' => ['description' => 'The state of the index table. Valid values: NEW, PUBLISH, IN\\_USE, NOT\\_USE, STOP\\_USE, RESTORE\\_USE, and FAIL. After an index is created in an OpenSearch Retrieval Engine Edition instance, the index enters the IN\\_USE state. If the first full index fails to be created in an OpenSearch Vector Search Edition instance of the new version, the index is in the FAIL state.', 'type' => 'string', 'title' => '', 'example' => 'IN_USE'],
+ ],
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'example' => '',
+ ],
+ ],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
],
+ 500 => [],
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"10D5E615-69F7-5F49-B850-00169ADE513C\\",\\n \\"result\\": [\\n {\\n \\"name\\": \\"es_test_1b\\",\\n \\"indexStatus\\": \\"IN_USE\\",\\n \\"status\\": \\"IN_USE\\"\\n }\\n ]\\n}","type":"json"}]',
+ 'title' => 'ListTables',
+ 'description' => '### Method'."\n"
+ ."\n"
+ .'```java'."\n"
+ .'GET'."\n"
+ .'```'."\n"
+ ."\n"
+ .'### URI'."\n"
+ ."\n"
+ .'```java'."\n"
+ .'/openapi/ha3/instances/{instanceId}/tables'."\n"
+ .'```',
+ 'requestParamsDescription' => '### [](#)Sample requests'."\n"
+ ."\n"
+ .'```java'."\n"
+ .'GET /openapi/ha3/instances/{instanceId}/tables'."\n"
+ .'```',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'list',
+ 'ramAction' => [
+ 'action' => 'searchengine:ListTables',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SearchEngine', 'resourceType' => 'Instance', 'arn' => 'acs:searchengine:{#regionId}:{#accountId}:instance/{#InstanceId}'],
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'ListTagResources' => [
+ 'summary' => 'Queries the tags attached to one or more resources.',
+ 'path' => '/openapi/ha3/resource-tags',
+ 'methods' => ['get'],
+ 'schemes' => ['http', 'https'],
+ 'security' => [
[
- 'name' => 'body',
- 'in' => 'body',
+ 'AK' => [],
+ ],
+ ],
+ 'produces' => ['application/json'],
+ 'operationType' => 'read',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'list',
+ 'abilityTreeCode' => '166297',
+ 'abilityTreeNodes' => ['FEATUREopensearch0AT3OG', 'FEATUREopensearchJB31XH'],
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'resourceType',
+ 'in' => 'query',
+ 'schema' => ['title' => '', 'description' => 'The resource type.', 'type' => 'string', 'required' => true, 'example' => 'instance'],
+ ],
+ [
+ 'name' => 'resourceId',
+ 'in' => 'query',
'style' => 'json',
'schema' => [
- 'description' => 'The request body.'."\n",
- 'type' => 'object',
+ 'title' => '',
+ 'description' => 'The IDs of the resources. You can specify up to 50 resource IDs.',
+ 'type' => 'array',
+ 'items' => ['description' => 'The ID of a resource.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => 'es-cn-i7m2u6o2*******'."\n"],
'required' => false,
- 'additionalProperties' => [
+ 'example' => '',
+ ],
+ ],
+ [
+ 'name' => 'tag',
+ 'in' => 'query',
+ 'style' => 'json',
+ 'schema' => [
+ 'title' => '',
+ 'description' => 'A list of up to 20 tags to add.',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'A tag.',
'type' => 'object',
'properties' => [
- 'pauseAll' => [
- 'title' => '暂停全部目标下发',
- 'description' => 'Specifies whether to suspend all pushes.'."\n",
- 'type' => 'boolean',
- 'required' => false,
- 'example' => 'true',
- ],
- 'pauseIndex' => [
- 'title' => '暂停新的全量版本下发',
- 'description' => 'Specifies whether to suspend the push for the new full index version.'."\n",
- 'type' => 'boolean',
- 'required' => false,
- 'example' => 'true',
- ],
- 'pauseIndexBatch' => [
- 'title' => '暂停批次增量下发',
- 'description' => 'Specifies whether to suspend the push for the incremental indexes.'."\n",
- 'type' => 'boolean',
- 'required' => false,
- 'example' => 'true',
- ],
- 'pauseBiz' => [
- 'title' => '暂停配置下发',
- 'description' => 'Specifies whether to suspend the push for the configuration.'."\n",
- 'type' => 'boolean',
- 'required' => false,
- 'example' => 'true',
- ],
- 'pauseRuntime' => [
- 'title' => '暂停实时增量',
- 'description' => 'Specifies whether to suspend the push for the real-time incremental indexes.'."\n",
- 'type' => 'boolean',
- 'required' => false,
- 'example' => 'true',
- ],
+ 'key' => ['title' => '', 'description' => 'The key of the tag.', 'type' => 'string', 'required' => false, 'example' => 'opensearch'],
+ 'value' => ['title' => '', 'description' => 'The value of the tag.', 'type' => 'string', 'required' => false, 'example' => 'opensearch'],
],
- 'description' => 'The request body.'."\n",
+ 'required' => false,
+ 'title' => '',
+ 'example' => '',
],
+ 'required' => false,
+ 'example' => '',
],
],
+ [
+ 'name' => 'nextToken',
+ 'in' => 'query',
+ 'schema' => ['title' => '', 'description' => 'The token that is used to retrieve the next page of results.', 'type' => 'string', 'required' => false, 'example' => '600********33'],
+ ],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
- 'requestId' => [
- 'title' => 'id of request',
- 'description' => 'The request ID.'."\n",
- 'type' => 'string',
- 'example' => '0B1FF998-BB8D-5182-BFC0-E471AA77095A',
- ],
- 'result' => [
- 'title' => 'Map',
- 'description' => 'The result.'."\n",
- 'type' => 'object',
- 'example' => '{}',
+ 'requestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '2AE63638-5420-56DC-BF59-37D8174039A0'],
+ 'nextToken' => ['title' => '', 'description' => 'The token that is used to retrieve the next page of results.', 'type' => 'string', 'example' => 'b56*******de4a7eca'],
+ 'tagResources' => [
+ 'title' => '',
+ 'description' => 'The list of resources.',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'The resource to which the tags are attached.',
+ 'type' => 'object',
+ 'properties' => [
+ 'tagKey' => ['title' => '', 'description' => 'The tag key.', 'type' => 'string', 'example' => 'opensearch'],
+ 'tagValue' => ['title' => '', 'description' => 'The tag value.', 'type' => 'string', 'example' => 'opensearch'],
+ 'resourceId' => ['title' => '', 'description' => 'The resource ID.', 'type' => 'string', 'example' => 'rmq-cn-jeo3mn55j01'],
+ 'resourceType' => ['title' => '', 'description' => 'The resource type.', 'type' => 'string', 'example' => 'instance'],
+ ],
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'example' => '',
],
],
'description' => '',
+ 'title' => '',
+ 'example' => '',
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"2AE63638-5420-56DC-BF59-37D8174039A0\\",\\n \\"nextToken\\": \\"b56*******de4a7eca\\",\\n \\"tagResources\\": [\\n {\\n \\"tagKey\\": \\"opensearch\\",\\n \\"tagValue\\": \\"opensearch\\",\\n \\"resourceId\\": \\"rmq-cn-jeo3mn55j01\\",\\n \\"resourceType\\": \\"instance\\"\\n }\\n ]\\n}","type":"json"}]',
+ 'title' => 'ListTagResources',
+ 'description' => '### Method'."\n"
+ ."\n"
+ .'```java'."\n"
+ .'GET'."\n"
+ .'```'."\n"
+ ."\n"
+ .'### URI'."\n"
+ ."\n"
+ .'```java'."\n"
+ .'/openapi/ha3/resource-tags'."\n"
+ .'```',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'list',
+ 'ramAction' => [
+ 'action' => 'searchengine:ListTagResources',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SearchEngine', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
],
],
- 500 => [],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"0B1FF998-BB8D-5182-BFC0-E471AA77095A\\",\\n \\"result\\": {}\\n}","type":"json"}]',
- 'title' => 'ModifyPausePolicy',
],
- 'CreateCluster' => [
- 'summary' => 'Creates a cluster.',
- 'path' => '/openapi/ha3/instances/{instanceId}/clusters',
- 'methods' => [
- 'post',
+ 'ListTasks' => [
+ 'summary' => 'Retrieves the change history for an instance.',
+ 'path' => '/openapi/ha3/instances/{instanceId}/tasks',
+ 'methods' => ['get'],
+ 'schemes' => ['http', 'https'],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'consumes' => ['application/json'],
+ 'produces' => ['application/json'],
+ 'operationType' => 'read',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'none',
+ 'riskType' => 'none',
+ 'chargeType' => 'free',
+ 'abilityTreeCode' => '211712',
+ 'abilityTreeNodes' => ['FEATUREopensearchW54CZ4'],
],
- 'schemes' => [
- 'http',
- 'https',
+ 'parameters' => [
+ [
+ 'name' => 'instanceId',
+ 'in' => 'path',
+ 'schema' => ['description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'ha-cn-ha-cn-pl32rf0****'],
+ ],
+ [
+ 'name' => 'start',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The start time.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'title' => '', 'example' => '1718846192'],
+ ],
+ [
+ 'name' => 'end',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The end time.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'title' => '', 'example' => '1718846192'],
+ ],
],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'requestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => 'D39EE0F1-D7EF-5F46-B781-6BF4185308B0'],
+ 'result' => ['title' => '', 'description' => 'The returned result.', 'type' => 'any', 'example' => '{}'],
+ ],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
+ ],
+ ],
+ 500 => [],
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"D39EE0F1-D7EF-5F46-B781-6BF4185308B0\\",\\n \\"result\\": \\"{}\\"\\n}","type":"json"}]',
+ 'title' => 'ListTasks',
+ 'description' => '### Method'."\n"
+ ."\n"
+ .'```java'."\n"
+ .'GET'."\n"
+ .'```'."\n"
+ ."\n"
+ .'### URI'."\n"
+ ."\n"
+ .'```java'."\n"
+ .'/openapi/ha3/instances/{instanceId}/tasks'."\n"
+ .'```',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'none',
+ 'ramAction' => [
+ 'action' => 'searchengine:ListTasks',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SearchEngine', 'resourceType' => 'Instance', 'arn' => 'acs:searchengine:{#regionId}:{#accountId}:instance/{#InstanceId}'],
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'ListVectorQueryResult' => [
+ 'summary' => 'Retrieves the results of a vector query test in Vector Search Edition.',
+ 'path' => '/openapi/ha3/instances/{instanceId}/vector-query',
+ 'methods' => ['post'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
@@ -14244,93 +11286,151 @@
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
- 'operationType' => 'create',
- 'abilityTreeCode' => '104657',
- 'abilityTreeNodes' => [
- 'FEATUREopensearchA6GC80',
- ],
+ 'operationType' => 'list',
+ 'riskType' => 'none',
+ 'chargeType' => 'free',
+ 'abilityTreeCode' => '194016',
+ 'abilityTreeNodes' => ['FEATUREopensearchYR63E7'],
],
'parameters' => [
[
'name' => 'instanceId',
'in' => 'path',
+ 'schema' => ['description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'ha-cn-pl32rf0****'],
+ ],
+ [
+ 'name' => 'path',
+ 'in' => 'query',
+ 'schema' => ['type' => 'string', 'required' => false, 'description' => '', 'title' => '', 'example' => ''],
+ ],
+ [
+ 'name' => 'queryType',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The query type. Valid values: vector, primary\\_key, and vector\\_text.', 'type' => 'string', 'required' => false, 'default' => 'vector', 'title' => '', 'example' => 'primary_key'],
+ ],
+ [
+ 'name' => 'vectorQueryType',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The vector query type. Valid values: vector, image, and text.', 'type' => 'string', 'required' => false, 'default' => 'vector', 'title' => '', 'example' => 'image'],
+ ],
+ [
+ 'name' => 'body',
+ 'in' => 'body',
+ 'style' => 'json',
+ 'schema' => ['description' => 'The request body.', 'type' => 'object', 'required' => false, 'title' => '', 'example' => '{"tableName":"api","ids":["1"]}'],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
'schema' => [
- 'description' => 'The instance ID.'."\n",
- 'type' => 'string',
- 'required' => true,
- 'example' => 'ha-cn-0ju2k3qer02',
+ 'type' => 'object',
+ 'properties' => [
+ 'requestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '022F36C7-9FB4-5D67-BEBC-3D14B0984463'],
+ 'result' => ['title' => '', 'description' => 'The returned result.', 'type' => 'any', 'example' => '{}'],
+ ],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
+ ],
+ ],
+ 500 => [],
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"022F36C7-9FB4-5D67-BEBC-3D14B0984463\\",\\n \\"result\\": \\"{}\\"\\n}","type":"json"}]',
+ 'title' => 'ListVectorQueryResult',
+ 'description' => '### Method'."\n"
+ ."\n"
+ .'```java'."\n"
+ .'POST'."\n"
+ .'```'."\n"
+ ."\n"
+ .'### URI'."\n"
+ ."\n"
+ .'```java'."\n"
+ .'/openapi/ha3/instances/{instanceId}/vector-query'."\n"
+ .'```',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'list',
+ 'ramAction' => [
+ 'action' => 'searchengine:ListVectorQueryResult',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SearchEngine', 'resourceType' => 'Instance', 'arn' => 'acs:searchengine:{#regionId}:{#accountId}:instance/{#InstanceId}'],
+ ],
],
],
+ ],
+ ],
+ 'ModifyAdvanceConfig' => [
+ 'path' => '/openapi/ha3/instances/{instanceId}/advanced-configs/{configName}',
+ 'methods' => ['put'],
+ 'schemes' => ['http', 'https'],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'write',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'update',
+ 'abilityTreeCode' => '173716',
+ 'abilityTreeNodes' => ['FEATUREopensearch8WJIRU'],
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'instanceId',
+ 'in' => 'path',
+ 'schema' => ['description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'ha-cn-pl32rf0****'],
+ ],
+ [
+ 'name' => 'configName',
+ 'in' => 'path',
+ 'schema' => ['description' => 'The name of the configuration.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'ha-cn-pl32rf0****_offline_adv_edit'],
+ ],
[
'name' => 'body',
'in' => 'body',
'style' => 'json',
'schema' => [
- 'description' => 'The request body.'."\n",
+ 'description' => 'The request body.',
'type' => 'object',
'properties' => [
- 'name' => [
- 'title' => '集群名称',
- 'description' => 'The cluster name.'."\n",
- 'type' => 'string',
- 'required' => false,
- 'example' => 'ha-cn-zvp2qr1sk01_qrs',
- ],
- 'description' => [
- 'title' => '集群描述',
- 'description' => 'The description of the cluster.'."\n",
- 'type' => 'string',
- 'required' => false,
- 'example' => '"ha-tets"',
- ],
- 'queryNode' => [
- 'title' => '查询节点配置',
- 'description' => 'The details of the Query Result Searcher (QRS) workers.'."\n",
- 'type' => 'object',
- 'properties' => [
- 'number' => [
- 'title' => '节点数量',
- 'description' => 'The number of QRS workers.'."\n",
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'example' => '2',
- ],
- ],
- 'required' => false,
- ],
- 'dataNode' => [
- 'title' => '数据节点配置',
- 'description' => 'The details of the Searcher workers.'."\n",
- 'type' => 'object',
- 'properties' => [
- 'number' => [
- 'title' => '节点数量',
- 'description' => 'The number of Searcher workers.'."\n",
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'example' => '2',
- ],
- 'partition' => [
- 'description' => 'The number of shards.'."\n",
- 'type' => 'string',
- 'required' => false,
- 'example' => '2',
+ 'name' => ['title' => '', 'description' => 'The name of the configuration.', 'type' => 'string', 'required' => false, 'example' => 'ha-cn-pl32rf0****_offline_adv_edit'."\n"],
+ 'status' => ['title' => '', 'description' => 'The status of the configuration. Valid values: drafting, used, unused, and trash.', 'type' => 'string', 'required' => false, 'example' => 'used'],
+ 'updateTime' => ['title' => '', 'description' => 'The time when the configuration was updated.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '2024-02-27T07:50:55Z'],
+ 'desc' => ['title' => '', 'description' => 'The description of the advanced configuration.', 'type' => 'string', 'required' => false, 'example' => 'Custom Configuration'],
+ 'files' => [
+ 'title' => '',
+ 'description' => 'The list of files.',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'The file information.',
+ 'type' => 'object',
+ 'properties' => [
+ 'name' => ['title' => '', 'description' => 'The node name.', 'type' => 'string', 'required' => false, 'example' => 'general'],
+ 'fullPathName' => ['title' => '', 'description' => 'The full path of the file.', 'type' => 'string', 'required' => false, 'example' => '/cluster.json'],
+ 'isDir' => ['title' => '', 'description' => 'Indicates whether the path specifies a directory.', 'type' => 'boolean', 'required' => false, 'example' => 'true'],
+ 'isTemplate' => ['title' => '', 'description' => 'Indicates whether the file is a template.', 'type' => 'boolean', 'required' => false, 'example' => 'true'],
],
+ 'required' => false,
+ 'title' => '',
+ 'example' => '',
],
'required' => false,
+ 'example' => '',
],
- 'autoLoad' => [
- 'title' => '添加完成后是否自动挂载',
- 'description' => 'Specifies whether to enable automatic connection.'."\n",
- 'type' => 'boolean',
- 'required' => false,
- 'example' => 'true',
- ],
+ 'content' => ['title' => '', 'description' => 'The content of the configuration. This parameter is not empty for HTTP and Git requests.', 'type' => 'string', 'required' => false, 'example' => '{\\"url\\":\\"http://xxxxxx.aliyuncs.com/outnet_hz/packages/xxxxx/opensearch_offline_plugins_xxxxx.tar\\"}'],
+ 'contentType' => ['title' => '', 'description' => 'The type of the configuration content. Valid values: FILE, GIT, HTTP, and ODPS.', 'type' => 'string', 'required' => false, 'example' => 'FILE'],
],
'required' => false,
- 'example' => '{}',
+ 'title' => '',
+ 'example' => '',
],
],
],
@@ -14339,65 +11439,54 @@
'schema' => [
'type' => 'object',
'properties' => [
- 'requestId' => [
- 'title' => 'id of request',
- 'description' => 'The request ID.'."\n",
- 'type' => 'string',
- 'example' => '10D5E615-69F7-5F49-B850-00169ADE513C',
- ],
- 'result' => [
- 'title' => 'Map',
- 'description' => 'The result.'."\n",
- 'type' => 'object',
- 'example' => '{}',
- ],
+ 'requestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '2AE63638-5420-56DC-BF59-37D8174039A0'],
+ 'result' => ['title' => '', 'description' => 'The returned result.', 'type' => 'object', 'example' => '{}'],
],
- 'description' => 'The results returned.'."\n",
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
],
500 => [],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"10D5E615-69F7-5F49-B850-00169ADE513C\\",\\n \\"result\\": {}\\n}","type":"json"}]',
- 'title' => 'CreateCluster',
- 'description' => '### [](#method)Method'."\n"
- ."\n"
- .'`POST`'."\n"
- ."\n"
- .'### [](#uri)URI'."\n"
- ."\n"
- .'`/openapi/ha3/instances/{instanceId}/clusters`'."\n",
- 'requestParamsDescription' => '### [](#sample-requests)Sample requests'."\n"
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"2AE63638-5420-56DC-BF59-37D8174039A0\\",\\n \\"result\\": {}\\n}","type":"json"}]',
+ 'title' => 'ModifyAdvanceConfig',
+ 'summary' => 'Modifies the content of HTTP or Git files.',
+ 'description' => '### Method'."\n"
."\n"
- .'`POST/openapi/ha3/instances/ha3_instance_id/clusters`'."\n"
+ .'```java'."\n"
+ .'PUT'."\n"
+ .'```'."\n"
."\n"
- .' {'."\n"
- .' "name":"cluster1",'."\n"
- .' "queryNode": {'."\n"
- .' "number": 1'."\n"
- .' },'."\n"
- .' "dataNode": {'."\n"
- .' "number": 2'."\n"
- .' },'."\n"
- .' "description":"The description of the cluster",'."\n"
- .' "autoLoad":true'."\n"
- .' }'."\n",
- 'responseParamsDescription' => '### [](#sample-responses)Sample responses'."\n"
+ .'### URI'."\n"
."\n"
- .' {'."\n"
- .' "requestId": "0A6EB64B-B4C8-CF02-810F-E660812972FF",'."\n"
- .' "result": []'."\n"
- .' }',
- ],
- 'RemoveCluster' => [
- 'summary' => 'Deletes a cluster.',
- 'path' => '/openapi/ha3/instances/{instanceId}/clusters/{clusterName}',
- 'methods' => [
- 'delete',
+ .'```java'."\n"
+ .'/openapi/ha3/instances/{instanceId}/advanced-configs/{configName}'."\n"
+ .'```',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ModifyAdvanceConfig'],
+ ],
],
- 'schemes' => [
- 'http',
- 'https',
+ 'ramActions' => [
+ [
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'searchengine:ModifyAdvanceConfig',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SearchEngine', 'resourceType' => 'Instance', 'arn' => 'acs:searchengine:{#regionId}:{#accountId}:instance/{#InstanceId}'],
+ ],
+ ],
+ ],
],
+ ],
+ 'ModifyAdvanceConfigFile' => [
+ 'path' => '/openapi/ha3/instances/{instanceId}/advanced-configs/{configName}/file',
+ 'methods' => ['put'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
@@ -14410,95 +11499,265 @@
[
'name' => 'instanceId',
'in' => 'path',
- 'schema' => [
- 'title' => '实例ID',
- 'description' => 'The instance ID.'."\n",
- 'type' => 'string',
- 'required' => true,
- 'example' => 'ha-cn-7mz2iv7sq01',
- ],
+ 'schema' => ['description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'example' => 'ha-cn-pl32rf0****', 'title' => ''],
],
[
- 'name' => 'clusterName',
+ 'name' => 'configName',
'in' => 'path',
+ 'schema' => ['description' => 'The configuration name.', 'type' => 'string', 'required' => true, 'example' => 'ha-cn-pl32rf0****_online_config_edit', 'title' => ''],
+ ],
+ [
+ 'name' => 'fileName',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The file name.', 'type' => 'string', 'required' => true, 'example' => '/qrs.json', 'title' => ''],
+ ],
+ [
+ 'name' => 'body',
+ 'in' => 'body',
+ 'style' => 'json',
'schema' => [
- 'title' => '集群名称',
- 'description' => 'The name of the cluster'."\n",
- 'type' => 'string',
+ 'description' => 'The request body parameters.',
+ 'type' => 'object',
+ 'properties' => [
+ 'content' => ['title' => '', 'description' => 'The file content.', 'type' => 'string', 'required' => false, 'example' => '{\\"url\\":\\"http://xxxxxx.aliyuncs.com/outnet_hz/packages/xxxxx/opensearch_offline_plugins_xxxxx.tar\\"}'],
+ 'variables' => [
+ 'title' => '',
+ 'description' => 'The list of variables.',
+ 'type' => 'object',
+ 'required' => false,
+ 'additionalProperties' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'disableModify' => ['description' => 'Specifies whether modification is not allowed.', 'type' => 'boolean', 'required' => false, 'example' => 'false', 'title' => ''],
+ 'isModify' => ['description' => 'Indicates whether the variable has been modified.', 'type' => 'boolean', 'required' => false, 'example' => 'false', 'title' => ''],
+ 'value' => ['description' => 'The variable value.', 'type' => 'string', 'required' => false, 'example' => 'qrs_connection_timeout', 'title' => ''],
+ 'description' => ['description' => 'The description.', 'type' => 'string', 'required' => false, 'example' => '超时时间', 'title' => ''],
+ 'templateValue' => ['description' => 'The template value.', 'type' => 'string', 'required' => false, 'example' => '800', 'title' => ''],
+ 'type' => ['title' => '', 'description' => 'The type. Valid values:'."\n"
+ .'- NORMAL: normal variable'."\n"
+ .'- FUNCTION: function variable', 'type' => 'string', 'required' => false, 'example' => 'NORMAL'],
+ 'funcValue' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'funcClassName' => ['description' => 'The method class name.', 'type' => 'string', 'required' => false, 'example' => 'ModifyFile', 'title' => ''],
+ 'template' => ['description' => 'The template.', 'type' => 'string', 'required' => false, 'example' => 'test-template', 'title' => ''],
+ ],
+ 'required' => false,
+ 'description' => 'The function variable.',
+ 'title' => '',
+ 'example' => '',
+ ],
+ ],
+ 'description' => 'The child variable information.',
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'example' => '',
+ ],
+ ],
'required' => false,
- 'example' => 'bj_vpc_domain_2',
+ 'example' => '{}',
+ 'title' => '',
],
],
],
'responses' => [
200 => [
'schema' => [
- 'title' => 'Schema of Response',
- 'description' => 'Schema of Response'."\n",
'type' => 'object',
'properties' => [
- 'requestId' => [
- 'title' => 'id of request',
- 'description' => 'id of request'."\n",
- 'type' => 'string',
- 'example' => 'E45380E8-994A-5402-9806-F114B3295FCF',
- ],
- 'result' => [
- 'title' => '结果',
- 'description' => 'The result'."\n",
- 'type' => 'object',
- 'example' => '{}',
- ],
+ 'requestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '93A9E542-8CF8-5BA6-99AB-94C0FE520429'],
+ 'result' => ['title' => '', 'description' => 'The returned result.', 'type' => 'object', 'example' => '{}'],
],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
],
500 => [],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"E45380E8-994A-5402-9806-F114B3295FCF\\",\\n \\"result\\": {}\\n}","type":"json"}]',
- 'title' => 'RemoveCluster',
- 'description' => '### Method'."\n"
+ 'title' => 'Modify a dictionary',
+ 'summary' => 'Modifies a dictionary.',
+ 'description' => '## Method'."\n"
."\n"
- .'```java'."\n"
- .'DELETE'."\n"
+ .'```'."\n"
+ .'PUT'."\n"
.'```'."\n"
."\n"
- .'### URI'."\n"
+ .'## URI'."\n"
."\n"
- .'```java'."\n"
- .'/openapi/ha3/instances/{instanceId}/clusters/{clusterName}'."\n"
- .'```'."\n",
- 'requestParamsDescription' => '### Sample requests'."\n"
+ .'```'."\n"
+ .'/openapi/ha3/instances/{instanceId}/advanced-configs/{configName}/file'."\n"
+ .'```',
+ 'requestParamsDescription' => "\n"
."\n"
- .'```java'."\n"
+ .'## Request example'."\n"
."\n"
- .'DELETE /openapi/ha3/instances/ha3_instance_name/clusters/my_cluster_name'."\n"
- .'```'."\n",
- 'responseParamsDescription' => '### [](#)Sample responses'."\n"
+ .''."\n"
."\n"
- .'Sample success responses'."\n"
+ .'```'."\n"
+ .'PUT /openapi/ha3/instances/{instanceId}/advancedConfigs/{configName}/file?fileName=/root/test.txt'."\n"
+ .'```'."\n"
."\n"
- .'```java'."\n"
+ .''."\n"
+ ."\n"
+ .'```'."\n"
.'{'."\n"
- .' '."\n"
- .' "requestId": "0A6EB64B-B4C8-CF02-810F-E660812972FF",'."\n"
- .' '."\n"
+ .''."\n"
+ .' "content": "",'."\n"
+ .''."\n"
+ .' "variables": {'."\n"
+ .''."\n"
+ .' "qrs_connection_timeout": {'."\n"
+ .''."\n"
+ .' "description": "",'."\n"
+ .''."\n"
+ .' "disableModify": false,'."\n"
+ .''."\n"
+ .' "isModify": true,'."\n"
+ .''."\n"
+ .' "type": "NORMAL",'."\n"
+ .''."\n"
+ .' "value": "800"'."\n"
+ .''."\n"
+ .' }'."\n"
+ .''."\n"
+ .' }'."\n"
+ .''."\n"
+ .'}'."\n"
+ .'```',
+ 'responseParamsDescription' => '## Response example'."\n"
+ ."\n"
+ .'Successful response'."\n"
+ .''."\n"
+ ."\n"
+ .'```'."\n"
+ .'{'."\n"
+ .''."\n"
+ .' "requestId": "65911539-5a8b-4bce-96a5-4d608900dc46",'."\n"
+ .''."\n"
.' "result": []'."\n"
- .' '."\n"
+ .''."\n"
.'}'."\n"
.'```'."\n"
+ .'For more information, see [Response structure](~~465311~~).',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ModifyAdvanceConfigFile'],
+ ],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => '',
+ 'ramAction' => [
+ 'action' => 'searchengine:ModifyAdvanceConfigFile',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SearchEngine', 'resourceType' => 'Instance', 'arn' => 'acs:searchengine:{#regionId}:{#accountId}:instance/{#InstanceId}'],
+ ],
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"93A9E542-8CF8-5BA6-99AB-94C0FE520429\\",\\n \\"result\\": {}\\n}","type":"json"}]',
+ ],
+ 'ModifyAlias' => [
+ 'path' => '/openapi/ha3/instances/{instanceId}/aliases/{alias}',
+ 'methods' => ['put'],
+ 'schemes' => ['http', 'https'],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'write',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'update',
+ 'abilityTreeCode' => '223194',
+ 'abilityTreeNodes' => ['FEATUREopensearchGTRUN8'],
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'instanceId',
+ 'in' => 'path',
+ 'schema' => ['description' => 'The ID of the instance.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'ha-cn-0ju2re****'],
+ ],
+ [
+ 'name' => 'alias',
+ 'in' => 'path',
+ 'schema' => ['description' => 'The alias.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'test'],
+ ],
+ [
+ 'name' => 'body',
+ 'in' => 'body',
+ 'style' => 'json',
+ 'schema' => [
+ 'description' => 'The request structure.',
+ 'type' => 'object',
+ 'properties' => [
+ 'alias' => ['title' => '', 'description' => 'The alias.', 'type' => 'string', 'required' => false, 'example' => 'test'],
+ 'index' => ['title' => '', 'description' => 'The index to associate with the alias.', 'type' => 'string', 'required' => false, 'example' => 'index'],
+ ],
+ 'required' => false,
+ 'title' => '',
+ 'example' => '',
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'requestId' => ['title' => '', 'description' => 'The ID of the request.', 'type' => 'string', 'example' => 'F6E3D968-529C-5C40-AFDD-133A8B8FD930'],
+ 'result' => ['title' => '', 'description' => 'The returned result.', 'type' => 'object', 'example' => '{}'],
+ ],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
+ ],
+ ],
+ 500 => [],
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"F6E3D968-529C-5C40-AFDD-133A8B8FD930\\",\\n \\"result\\": {}\\n}","type":"json"}]',
+ 'title' => 'ModifyAlias',
+ 'summary' => 'Modifies a table alias.',
+ 'description' => '### Method'."\n"
+ ."\n"
+ .'```java'."\n"
+ .'PUT'."\n"
+ .'```'."\n"
."\n"
- .'For more information, see [Response structure](~~465311~~).'."\n",
+ .'### URI'."\n"
+ ."\n"
+ .'```java'."\n"
+ .'/openapi/ha3/instances/{instanceId}/aliases/{alias}'."\n"
+ .'```',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'searchengine:ModifyAlias',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SearchEngine', 'resourceType' => 'Instance', 'arn' => 'acs:searchengine:{#regionId}:{#accountId}:instance/{#InstanceId}'],
+ ],
+ ],
+ ],
+ ],
],
'ModifyClusterDesc' => [
'summary' => 'Modifies the description of a specified cluster.',
'path' => '/openapi/ha3/instances/{instanceId}/clusters/{clusterName}/desc',
- 'methods' => [
- 'put',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
+ 'methods' => ['put'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
@@ -14511,54 +11770,33 @@
[
'name' => 'instanceId',
'in' => 'path',
- 'schema' => [
- 'description' => 'The instance ID.'."\n",
- 'type' => 'string',
- 'required' => true,
- 'example' => 'ha-cn-c4d2rq7nt04',
- ],
+ 'schema' => ['description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'example' => 'ha-cn-pl32rf0****', 'title' => ''],
],
[
'name' => 'clusterName',
'in' => 'path',
- 'schema' => [
- 'description' => 'The name of the cluster'."\n",
- 'type' => 'string',
- 'required' => true,
- 'example' => 'sz_vpc_domain_1',
- ],
+ 'schema' => ['description' => 'The name of the cluster', 'type' => 'string', 'required' => true, 'example' => 'sz_vpc_domain_1', 'title' => ''],
],
[
'name' => 'body',
'in' => 'body',
'style' => 'json',
- 'schema' => [
- 'description' => 'The request body.'."\n",
- 'type' => 'object',
- 'required' => false,
- 'example' => '{}',
- ],
+ 'schema' => ['description' => 'The request body.', 'type' => 'object', 'example' => '{'."\n"
+ .'    "description": "Custom description"'."\n"
+ .'}', 'required' => false, 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
- 'description' => 'The response parameters.'."\n",
+ 'description' => 'The response parameters.',
'type' => 'object',
'properties' => [
- 'requestId' => [
- 'title' => 'id of request',
- 'description' => 'The ID of the request'."\n",
- 'type' => 'string',
- 'example' => 'D39EE0F1-D7EF-5F46-B781-6BF4185308B0',
- ],
- 'result' => [
- 'title' => 'Map',
- 'description' => 'The result.'."\n",
- 'type' => 'object',
- 'example' => '{}',
- ],
+ 'requestId' => ['title' => '', 'description' => 'The ID of the request', 'type' => 'string', 'example' => 'D39EE0F1-D7EF-5F46-B781-6BF4185308B0'],
+ 'result' => ['title' => '', 'description' => 'The result.', 'type' => 'object', 'example' => '{}'],
],
+ 'title' => '',
+ 'example' => '',
],
],
500 => [],
@@ -14571,10 +11809,10 @@
."\n"
.'### [](#uri)URI'."\n"
."\n"
- .'`/openapi/ha3/instances/{instanceId}/clusters/{clusterName}/desc`'."\n",
- 'requestParamsDescription' => '|Parameter|Required|Type|Description|'."\n"
- .'|---|---|---|---|'."\n"
- .'|description|Yes|String|The description of the cluster|'."\n"
+ .'`/openapi/ha3/instances/{instanceId}/clusters/{clusterName}/desc`',
+ 'requestParamsDescription' => '| Parameter | Required | Type | Description |'."\n"
+ .'| ----------- | -------- | ------ | ------------------------------ |'."\n"
+ .'| description | Yes | String | The description of the cluster |'."\n"
."\n"
.'### Sample requests'."\n"
."\n"
@@ -14587,23 +11825,39 @@
.'```',
'responseParamsDescription' => '### [](#)Sample responses'."\n"
."\n"
- .' {'."\n"
- .' "requestId": "0A6EB64B-B4C8-CF02-810F-E660812972FF",'."\n"
- .' "result": []'."\n"
- .' }'."\n"
+ .'```'."\n"
+ .'{'."\n"
+ .' "requestId": "0A6EB64B-B4C8-CF02-810F-E660812972FF",'."\n"
+ .' "result": []'."\n"
+ .'}'."\n"
+ .'```'."\n"
."\n"
- .'For more information, see [Response structure](~~465311~~).'."\n",
+ .'For more information, see [Response structure](~~465311~~).',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ModifyClusterDesc'],
+ ],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => '',
+ 'ramAction' => [
+ 'action' => 'searchengine:ModifyClusterDesc',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SearchEngine', 'resourceType' => 'Instance', 'arn' => 'acs:searchengine:{#regionId}:{#accountId}:instance/{#InstanceId}'],
+ ],
+ ],
+ ],
+ ],
],
'ModifyClusterOfflineConfig' => [
'summary' => 'Modifies the configuration information of a cluster.',
'path' => '/openapi/ha3/instances/{instanceId}/cluster-offline-config',
- 'methods' => [
- 'put',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
+ 'methods' => ['put'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
@@ -14614,125 +11868,56 @@
'systemTags' => [
'operationType' => 'update',
'abilityTreeCode' => '104631',
- 'abilityTreeNodes' => [
- 'FEATUREopensearchA6GC80',
- ],
+ 'abilityTreeNodes' => ['FEATUREopensearchA6GC80'],
],
'parameters' => [
[
'name' => 'instanceId',
'in' => 'path',
- 'schema' => [
- 'description' => 'The instance ID.'."\n",
- 'type' => 'string',
- 'required' => true,
- 'example' => 'ha-cn-7mz2oy0bg01',
- 'title' => '',
- ],
+ 'schema' => ['description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'example' => 'ha-cn-pl32rf0****', 'title' => ''],
],
[
'name' => 'body',
'in' => 'body',
'style' => 'json',
'schema' => [
- 'description' => 'The request body.'."\n",
+ 'description' => 'The request body.',
'type' => 'object',
'properties' => [
- 'dataSourceName' => [
- 'description' => 'The name of the data source.'."\n",
- 'type' => 'string',
- 'required' => false,
- 'example' => 'test1',
- ],
- 'dataSourceType' => [
- 'title' => '数据源类型 (odps: maxComputer, swift: swift, unKnow)',
- 'description' => 'The type of the data source. Valid values: odps: MaxCompute. swift: Swift. unKnow: unknown type.'."\n",
- 'type' => 'string',
- 'required' => false,
- 'example' => 'maxComputer',
- ],
- 'domain' => [
- 'title' => '离线部署',
- 'description' => 'The data center in which the data source is deployed.'."\n",
- 'type' => 'string',
- 'required' => false,
- 'example' => 'vpc_hz_domain_1',
- ],
+ 'dataSourceName' => ['description' => 'The name of the data source.', 'type' => 'string', 'required' => false, 'example' => 'ha-cn-pl32rf0****_test_api', 'title' => ''],
+ 'dataSourceType' => ['description' => 'The type of the data source. Valid values: odps: MaxCompute. swift: Swift. unKnow: unknown type.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => 'odps'],
+ 'domain' => ['description' => 'The data center in which the data source is deployed.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => 'vpc_hz_domain_1'],
'config' => [
- 'title' => 'key:配置名称',
- 'description' => 'The configuration name, which is stored as a key.'."\n",
+ 'title' => '',
+ 'description' => 'The configuration name, which is stored as a key.',
'type' => 'object',
'required' => false,
- 'additionalProperties' => [
- 'type' => 'integer',
- 'format' => 'int32',
- 'description' => 'The configuration version, which is stored as a value.'."\n",
- 'example' => '1',
- ],
- ],
- 'partition' => [
- 'title' => '对于odps数据源触发全量时必传',
- 'description' => 'This parameter is required when index building for full data in a MaxCompute data source is triggered.'."\n",
- 'type' => 'string',
- 'required' => false,
- 'example' => '20211202',
- ],
- 'dataTimeSec' => [
- 'title' => '对于api推送数据源触发全量时必传',
- 'description' => 'This parameter is required when index building by using API data sources is triggered.'."\n",
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'example' => '1640867288',
- ],
- 'buildMode' => [
- 'title' => '索引重建方式 (api: API方式推送数据源, indexRecover: 从索引中恢复数据源)',
- 'description' => 'The reindexing method. Valid values: api: API data source. indexRecover: data recovery by using indexing.'."\n",
- 'type' => 'string',
- 'required' => false,
- 'example' => 'indexRecover',
- ],
- 'generation' => [
- 'title' => '从索引中恢复数据源，dump表的generation',
- 'description' => 'The ID of the full index version.'."\n",
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => false,
- 'example' => '160142641',
- ],
- 'pushMode' => [
- 'title' => '推送方式：PUSH_ONLY（仅推送配置）、PUSH_GENERATION （指定generation）、TRIGGER_BUILD(推送配置并做全量)',
- 'description' => 'The push mode of the configuration. By default, only the configuration is pushed.'."\n",
- 'type' => 'string',
- 'required' => false,
- 'example' => 'PUSH_ONLY',
+ 'additionalProperties' => ['description' => 'The configuration version, which is stored as a value.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''],
+ 'example' => '',
],
+ 'partition' => ['description' => 'This parameter is required when index building for full data in a MaxCompute data source is triggered.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => 'ds=20211202'],
+ 'dataTimeSec' => ['description' => 'This parameter is required when index building by using API data sources is triggered.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'required' => false, 'example' => '1640867288'],
+ 'buildMode' => ['description' => 'The reindexing method. Valid values: api: API data source. indexRecover: data recovery by using indexing.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => 'indexRecover'],
+ 'generation' => ['description' => 'The ID of the full index version.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'required' => false, 'example' => '160142641'],
+ 'pushMode' => ['description' => 'The push mode of the configuration. By default, only the configuration is pushed.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => 'PUSH_ONLY'],
],
'required' => false,
'example' => '{}',
+ 'title' => '',
],
],
],
'responses' => [
200 => [
'schema' => [
- 'description' => 'Schema of Response'."\n",
+ 'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
- 'requestId' => [
- 'title' => 'id of request',
- 'description' => 'The ID of the request'."\n",
- 'type' => 'string',
- 'example' => 'E7B7D598-B080-5C8E-AA35-D43EC0D5F886',
- ],
- 'result' => [
- 'title' => 'Map',
- 'description' => 'The result'."\n",
- 'type' => 'object',
- 'example' => '{}',
- ],
+ 'requestId' => ['title' => '', 'description' => 'The ID of the request', 'type' => 'string', 'example' => 'E7B7D598-B080-5C8E-AA35-D43EC0D5F886'],
+ 'result' => ['title' => '', 'description' => 'The result', 'type' => 'object', 'example' => '{}'],
],
- 'title' => 'Schema of Response',
+ 'title' => '',
+ 'example' => '',
],
],
500 => [],
@@ -14741,19 +11926,21 @@
'title' => 'ModifyClusterOfflineConfig',
'description' => '## Request syntax'."\n"
."\n"
- .' PUT /openapi/ha3/instances/{instanceId}/cluster-offline-config'."\n",
- 'requestParamsDescription' => '|Parameter|Required|Type|Description|'."\n"
- .'|---|---|---|---|'."\n"
- .'|dataSource|Yes|String|The name of the data source.|'."\n"
- .'|domain|Yes|String|The domain where the data source is deployed.|'."\n"
- .'|indexes|Yes|Object|The description of the index structure.|'."\n"
- .'|advancedConfigVersionId|Yes|Integer|The ID of the advanced configuration version.|'."\n"
- .'|triggerBuild|Yes|boolean|If this parameter is set to true, the configuration is pushed and reindexing is triggered. If this parameter is set to false, the configuration takes effect after the next reindexing.|'."\n"
- .'|buildMode|No|Integer|The mode of reindexing. api indicates the default mode, and indexRecover indicates that the data source is restored by using the index. This parameter is required only when the data source is of the HDFS type.|'."\n"
- .'|generation|No|Long|The data restoration version.|'."\n"
- .'|partition|No|String|The data partition of the data source selected for reindexing. This parameter is required when reindexing is triggered for the odps data source.|'."\n"
- .'|dataTimeSec|No|Integer|The time when reindexing is triggered for the API-pushed data source. The value of this parameter must be accurate to the second. This parameter is required when reindexing is triggered for the API-pushed data source.|'."\n"
- .'|dataSourceType|No|Enum|This parameter is required when the triggerBuild parameter is set to true. Valid values: odps and swift.|'."\n"
+ .'```'."\n"
+ .'PUT /openapi/ha3/instances/{instanceId}/cluster-offline-config'."\n"
+ .'```',
+ 'requestParamsDescription' => '| Parameter | Required | Type | Description |'."\n"
+ .'| ----------------------- | -------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |'."\n"
+ .'| dataSource | Yes | String | The name of the data source. |'."\n"
+ .'| domain | Yes | String | The domain where the data source is deployed. |'."\n"
+ .'| indexes | Yes | Object | The description of the index structure. |'."\n"
+ .'| advancedConfigVersionId | Yes | Integer | The ID of the advanced configuration version. |'."\n"
+ .'| triggerBuild | Yes | boolean | If this parameter is set to true, the configuration is pushed and reindexing is triggered. If this parameter is set to false, the configuration takes effect after the next reindexing. |'."\n"
+ .'| buildMode | No | Integer | The mode of reindexing. api indicates the default mode, and indexRecover indicates that the data source is restored by using the index. This parameter is required only when the data source is of the HDFS type. |'."\n"
+ .'| generation | No | Long | The data restoration version. |'."\n"
+ .'| partition | No | String | The data partition of the data source selected for reindexing. This parameter is required when reindexing is triggered for the odps data source. |'."\n"
+ .'| dataTimeSec | No | Integer | The time when reindexing is triggered for the API-pushed data source. The value of this parameter must be accurate to the second. This parameter is required when reindexing is triggered for the API-pushed data source. |'."\n"
+ .'| dataSourceType | No | Enum | This parameter is required when the triggerBuild parameter is set to true. Valid values: odps and swift. |'."\n"
."\n"
.'### Sample requests'."\n"
."\n"
@@ -14781,17 +11968,41 @@
.' '."\n"
.'}'."\n"
.'```',
+ 'responseParamsDescription' => '### ResponseExample'."\n"
+ ."\n"
+ .'```'."\n"
+ .'{'."\n"
+ .' "requestId": "0A6EB64B-B4C8-CF02-810F-E660812972FF",'."\n"
+ .' "result": []'."\n"
+ .'}'."\n"
+ .'```'."\n"
+ ."\n"
+ .'For details, refer to[Response structure](~~465311~~)',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ModifyClusterOfflineConfig'],
+ ],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'searchengine:ModifyClusterOfflineConfig',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SearchEngine', 'resourceType' => 'Instance', 'arn' => 'acs:searchengine:{#regionId}:{#accountId}:instance/{#InstanceId}'],
+ ],
+ ],
+ ],
+ ],
],
'ModifyClusterOnlineConfig' => [
'summary' => 'Modifies the online configuration of a cluster.',
'path' => '/openapi/ha3/instances/{instanceId}/cluster-online-config',
- 'methods' => [
- 'put',
- ],
- 'schemes' => [
- 'https',
- 'http',
- ],
+ 'methods' => ['put'],
+ 'schemes' => ['https', 'http'],
'security' => [
[
'AK' => [],
@@ -14804,12 +12015,7 @@
[
'name' => 'instanceId',
'in' => 'path',
- 'schema' => [
- 'description' => 'The instance ID.'."\n",
- 'type' => 'string',
- 'required' => true,
- 'example' => 'ha-cn-7mz2ougaw02',
- ],
+ 'schema' => ['description' => 'The instance ID.'."\n", 'type' => 'string', 'required' => true, 'example' => 'ha-cn-pl32rf0****', 'title' => ''],
],
[
'name' => 'body',
@@ -14820,33 +12026,27 @@
'type' => 'object',
'properties' => [
'config' => [
- 'title' => 'key:配置名称',
+ 'title' => '',
'description' => 'The configuration information.'."\n",
'type' => 'object',
'required' => false,
- 'additionalProperties' => [
- 'type' => 'integer',
- 'format' => 'int32',
- 'description' => 'The version number of the configuration.'."\n",
- 'example' => '2',
- ],
+ 'additionalProperties' => ['type' => 'integer', 'format' => 'int32', 'description' => 'The version number of the configuration.'."\n", 'example' => '2', 'title' => ''],
+ 'example' => '',
],
'clusters' => [
- 'title' => '集群信息',
+ 'title' => '',
'description' => 'The cluster information.'."\n",
'type' => 'array',
- 'items' => [
- 'description' => 'The clusters.'."\n",
- 'type' => 'string',
- 'required' => false,
- 'example' => '['."\n"
- .' "hz_pre_vpc_domain_1"'."\n"
- .' ]',
- ],
+ 'items' => ['description' => 'The clusters.'."\n", 'type' => 'string', 'required' => false, 'example' => '['."\n"
+ .' "hz_pre_vpc_domain_1"'."\n"
+ .']', 'title' => ''],
'required' => false,
+ 'example' => '',
],
],
'required' => false,
+ 'title' => '',
+ 'example' => '',
],
],
],
@@ -14856,19 +12056,11 @@
'description' => '{}',
'type' => 'object',
'properties' => [
- 'requestId' => [
- 'title' => 'id of request',
- 'description' => 'The ID of the request'."\n",
- 'type' => 'string',
- 'example' => 'E7B7D598-B080-5C8E-AA35-D43EC0D5F886',
- ],
- 'result' => [
- 'title' => 'Map',
- 'description' => 'Map',
- 'type' => 'object',
- 'example' => '{}',
- ],
+ 'requestId' => ['title' => '', 'description' => 'The ID of the request'."\n", 'type' => 'string', 'example' => 'E7B7D598-B080-5C8E-AA35-D43EC0D5F886'],
+ 'result' => ['title' => '', 'description' => 'Map', 'type' => 'object', 'example' => '{}'],
],
+ 'title' => '',
+ 'example' => '',
],
],
500 => [],
@@ -14900,721 +12092,897 @@
.' }'."\n"
."\n"
.'**For more information, see [Response structure](~~465311~~)**.'."\n",
- ],
- 'GetCluster' => [
- 'summary' => 'Queries the details of a cluster.',
- 'path' => '/openapi/ha3/instances/{instanceId}/clusters/{clusterName}',
- 'methods' => [
- 'get',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ModifyClusterOnlineConfig'],
+ ],
],
- 'schemes' => [
- 'http',
- 'https',
+ 'ramActions' => [
+ [
+ 'operationType' => '',
+ 'ramAction' => [
+ 'action' => 'searchengine:ModifyClusterOnlineConfig',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SearchEngine', 'resourceType' => 'Instance', 'arn' => 'acs:searchengine:{#regionId}:{#accountId}:instance/{#instanceId}'],
+ ],
+ ],
+ ],
],
+ ],
+ 'ModifyDataSourceDeploy' => [
+ 'path' => '/openapi/ha3/instances/{instanceId}/data-sources/{dataSourceName}/deploys/{deployName}',
+ 'methods' => ['put'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
- 'operationType' => 'read',
+ 'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
- 'operationType' => 'get',
- 'abilityTreeCode' => '104163',
- 'abilityTreeNodes' => [
- 'FEATUREopensearch5EAGY5',
- ],
+ 'operationType' => 'update',
+ 'riskType' => 'none',
+ 'chargeType' => 'free',
+ 'abilityTreeCode' => '159954',
+ 'abilityTreeNodes' => ['FEATUREopensearchVHEWK3'],
],
'parameters' => [
[
'name' => 'instanceId',
'in' => 'path',
- 'schema' => [
- 'title' => '实例ID',
- 'description' => 'The instance ID.'."\n",
- 'type' => 'string',
- 'required' => true,
- 'example' => 'ha-cn-0ju2rq6610a',
- ],
+ 'schema' => ['description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'example' => 'ha-cn-pl32rf0****', 'title' => ''],
],
[
- 'name' => 'clusterName',
+ 'name' => 'deployName',
'in' => 'path',
- 'schema' => [
- 'title' => '集群名称',
- 'description' => 'The name of the cluster'."\n",
- 'type' => 'string',
- 'required' => false,
- 'example' => 'bj_vpc_domain_2',
- ],
+ 'schema' => ['description' => 'The data center.', 'type' => 'string', 'required' => true, 'example' => 'vpc_hz_domain_1', 'title' => ''],
],
- ],
- 'responses' => [
- 200 => [
+ [
+ 'name' => 'dataSourceName',
+ 'in' => 'path',
+ 'schema' => ['description' => 'The name of the data source.', 'type' => 'string', 'required' => true, 'example' => 'ha-cn-pl32rf0****_test_api', 'title' => ''],
+ ],
+ [
+ 'name' => 'generationId',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The full index version.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1708674867', 'title' => ''],
+ ],
+ [
+ 'name' => 'dryRun',
+ 'in' => 'query',
+ 'schema' => ['description' => 'Specifies whether to perform a dry run (only validates whether the data source is valid). Valid values:'."\n"
+ .'- true: performs a dry run.'."\n"
+ .'- false: does not perform a dry run.', 'type' => 'boolean', 'required' => false, 'default' => 'false', 'example' => 'true', 'title' => ''],
+ ],
+ [
+ 'name' => 'body',
+ 'in' => 'body',
+ 'style' => 'json',
'schema' => [
- 'title' => 'Schema of Response',
- 'description' => 'The response parameters.'."\n",
+ 'description' => 'The request body parameters.',
'type' => 'object',
'properties' => [
- 'requestId' => [
- 'title' => 'id of request',
- 'description' => 'The ID of the request.'."\n",
- 'type' => 'string',
- 'example' => 'E7B7D598-B080-5C8E-AA35-D43EC0D5F886',
+ 'storage' => [
+ 'description' => 'The data source information.',
+ 'type' => 'object',
+ 'properties' => [
+ 'endpoint' => ['title' => '', 'description' => 'odps endpoint', 'type' => 'string', 'required' => false, 'example' => 'http://service.cn-hangzhou.maxcompute.aliyun-inc.com/api'],
+ 'accessKey' => ['description' => 'The AccessKey ID of the ODPS data source.', 'type' => 'string', 'required' => false, 'example' => 'L***p', 'title' => ''],
+ 'accessSecret' => ['description' => 'The AccessKey secret of the ODPS data source.', 'type' => 'string', 'required' => false, 'example' => '5**9a6', 'title' => ''],
+ 'project' => ['description' => 'The project name of the ODPS data source.', 'type' => 'string', 'required' => false, 'example' => 'kubenest', 'title' => ''],
+ 'partition' => ['description' => 'The partition information.', 'type' => 'string', 'required' => false, 'example' => 'ds=20220713', 'title' => ''],
+ 'table' => ['title' => '', 'description' => 'The table name. This parameter is related to Saro or ODPS.', 'type' => 'string', 'required' => false, 'example' => 'item'],
+ 'namespace' => ['title' => '', 'description' => 'The namespace. This parameter is related to Saro.', 'type' => 'string', 'required' => false, 'example' => 'dp-dev'],
+ 'path' => ['title' => '', 'description' => 'The path. This parameter is related to HDFS.', 'type' => 'string', 'required' => false, 'example' => '/ude_jobs/iflow_offline_data_access'],
+ 'ossPath' => ['title' => '', 'description' => 'The path. This parameter is related to the OSS data source.', 'type' => 'string', 'required' => false, 'example' => '/opensearch'],
+ 'bucket' => ['description' => 'The bucket name.', 'type' => 'string', 'required' => false, 'example' => 'test-bucket', 'title' => ''],
+ 'catalog' => ['description' => 'The data catalog name of the DLF data source.', 'type' => 'string', 'required' => false, 'example' => 'test-catalog', 'title' => ''],
+ 'database' => ['description' => 'The database of the DLF data source.', 'type' => 'string', 'required' => false, 'example' => 'test-database', 'title' => ''],
+ 'tag' => ['description' => 'The tag of the DLF data source.', 'type' => 'string', 'required' => false, 'example' => 'test', 'title' => ''],
+ 'tableFormat' => ['description' => 'The table format of the DLF data source.', 'type' => 'string', 'required' => false, 'example' => 'paimon'."\n"
+ .'lance'."\n"
+ .'object', 'title' => ''],
+ ],
+ 'required' => false,
+ 'title' => '',
+ 'example' => '',
],
- 'result' => [
- 'title' => '集群列表',
- 'description' => 'The clusters.'."\n",
+ 'autoBuildIndex' => ['title' => '', 'description' => 'Specifies whether to enable automatic full indexing.', 'type' => 'boolean', 'required' => false, 'example' => 'true'],
+ 'processor' => [
+ 'description' => 'The process parameters.',
'type' => 'object',
'properties' => [
- 'name' => [
- 'title' => '集群名称',
- 'description' => 'The cluster name.'."\n",
- 'type' => 'string',
- 'example' => 'general',
- ],
- 'description' => [
- 'title' => '集群描述',
- 'description' => 'The description of the cluster.'."\n",
- 'type' => 'string',
- 'example' => 'fzz_test',
- ],
- 'currentAdvanceConfigVersion' => [
- 'title' => '高级配置生效版本',
- 'description' => 'The effective advanced configuration version.'."\n",
- 'type' => 'string',
- 'example' => 'test_yyds_data1',
- ],
- 'latestAdvanceConfigVersion' => [
- 'title' => '高级配置最新版本',
- 'description' => 'The latest advanced configuration version.'."\n",
- 'type' => 'string',
- 'example' => 'test_yyds_data1',
- ],
- 'currentOnlineConfigVersion' => [
- 'title' => '在线配置生效版本',
- 'description' => 'The effective online configuration version.'."\n",
- 'type' => 'string',
- 'example' => 'test_yyds_data1',
- ],
- 'latestOnlineConfigVersion' => [
- 'title' => '在线配置最新版本',
- 'description' => 'The latest online configuration version.'."\n",
- 'type' => 'string',
- 'example' => 'test_yyds_data1',
- ],
- 'configUpdateTime' => [
- 'title' => '集群更新时间',
- 'description' => 'The time when the cluster was updated.'."\n",
- 'type' => 'string',
- 'example' => '2021-08-09 00:01:02',
- ],
- 'status' => [
- 'description' => 'The creation status of the cluster. Valid values: NEW and PUBLISH. NEW indicates that the cluster is being created. PUBLISH indicates that the cluster is created.'."\n",
- 'type' => 'string',
- 'example' => 'NEW',
- ],
- 'queryNode' => [
- 'description' => 'The specifications of Query Result Searcher (QRS) workers.'."\n",
+ 'args' => ['title' => '', 'description' => 'The process startup parameters.', 'type' => 'string', 'required' => false, 'example' => '{'."\n"
+ .' "processInfos": [],'."\n"
+ .' "groupId": "opensearch",'."\n"
+ .' "containerConfigs": [],'."\n"
+ .' "priority": {'."\n"
+ .' "minor_priority": 0,'."\n"
+ .' "major_priority": 64'."\n"
+ .' }'."\n"
+ .'}'],
+ 'resource' => ['title' => '', 'description' => 'The resource information.', 'type' => 'string', 'required' => false, 'example' => '[{'."\n"
+ .' "_bs_role": "processor.*.inc",'."\n"
+ .' "priority": {'."\n"
+ .' "major_priority": 32,'."\n"
+ .' "minor_priority": 0'."\n"
+ .' },'."\n"
+ .' "slotResources": [{'."\n"
+ .' "slotResources": [{'."\n"
+ .' "amount": 200,'."\n"
+ .' "name": "cpu"'."\n"
+ .' }, {'."\n"
+ .' "amount": 8192,'."\n"
+ .' "name": "mem"'."\n"
+ .' }, {'."\n"
+ .' "amount": 0,'."\n"
+ .' "name": "T4"'."\n"
+ .' }, {'."\n"
+ .' "amount": 10,'."\n"
+ .' "type": "SCALAR",'."\n"
+ .' "name": "disk_ratio_9999"'."\n"
+ .' }, {'."\n"
+ .' "amount": 20480,'."\n"
+ .' "type": "SCALAR",'."\n"
+ .' "name": "disk_size_9999"'."\n"
+ .' }]'."\n"
+ .' }]'."\n"
+ .'}]'],
+ ],
+ 'required' => false,
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'extend' => [
+ 'description' => 'The extended information.',
+ 'type' => 'object',
+ 'properties' => [
+ 'saro' => [
+ 'description' => 'The Saro data source information.',
'type' => 'object',
'properties' => [
- 'name' => [
- 'title' => '节点名称',
- 'description' => 'The name of the QRS worker.'."\n",
- 'type' => 'string',
- 'example' => 'test',
- ],
- 'number' => [
- 'description' => 'The number of nodes.'."\n",
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '1',
- ],
- 'partition' => [
- 'title' => '副本数量',
- 'description' => 'The number of replicas.'."\n",
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '2',
- ],
+ 'path' => ['description' => 'The path.', 'type' => 'string', 'required' => false, 'example' => '/', 'title' => ''],
+ 'version' => ['description' => 'The version number.', 'type' => 'string', 'required' => false, 'example' => '1', 'title' => ''],
],
+ 'required' => false,
+ 'title' => '',
+ 'example' => '',
],
- 'dataNode' => [
- 'description' => 'The specifications of Searcher workers.'."\n",
+ 'hdfs' => [
+ 'description' => 'The HDFS information.',
'type' => 'object',
'properties' => [
- 'name' => [
- 'title' => '节点名称',
- 'description' => 'The name of the Searcher worker.'."\n",
- 'type' => 'string',
- 'example' => 'test',
- ],
- 'number' => [
- 'description' => 'The number of replicas.'."\n",
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '1',
- ],
- 'partition' => [
- 'description' => 'The number of partitions.'."\n",
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '2',
- ],
+ 'path' => ['description' => 'The HDFS data source path.', 'type' => 'string', 'required' => false, 'example' => 'ymsh-service/src/main/java/cn/ymsh/util/jd', 'title' => ''],
],
+ 'required' => false,
+ 'title' => '',
+ 'example' => '',
],
- 'createTime' => [
- 'description' => 'The time when the cluster was created.'."\n",
- 'type' => 'string',
- 'example' => '2024-05-21 16:05:26',
- ],
- 'config' => [
- 'description' => 'The configuration information.'."\n",
+ 'odps' => [
+ 'description' => 'The ODPS data source information.',
'type' => 'object',
- 'additionalProperties' => [
- 'type' => 'object',
- 'additionalProperties' => [
+ 'properties' => [
+ 'partitions' => [
+ 'description' => 'The partition information of the data source.',
'type' => 'object',
- 'properties' => [
- 'name' => [
- 'type' => 'string',
- 'example' => 'ha-cn-pl32rf0****_offline_adv_v1'."\n",
- 'description' => 'The configuration name.'."\n",
- ],
- 'updateTime' => [
- 'type' => 'string',
- 'description' => 'The time when the configuration was updated.'."\n",
- 'example' => '2024-05-21 16:05:26',
- ],
- 'desc' => [
- 'type' => 'string',
- 'description' => 'The description of the configuration.'."\n",
- 'example' => 'Custom description'."\n",
- ],
- ],
- 'description' => 'The information about the child configuration item.'."\n",
+ 'required' => false,
+ 'additionalProperties' => ['description' => '数据源的分区信息', 'type' => 'string', 'example' => 'ds=20230824', 'title' => ''],
+ 'title' => '',
+ 'example' => '',
],
- 'description' => 'The information about child configuration items.'."\n",
],
+ 'required' => false,
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'oss' => [
+ 'description' => 'The OSS information.',
+ 'type' => 'object',
+ 'properties' => [
+ 'path' => ['description' => 'The OSS data source path.', 'type' => 'string', 'required' => false, 'example' => 'oss://test', 'title' => ''],
+ ],
+ 'required' => false,
+ 'title' => '',
+ 'example' => '',
],
],
+ 'required' => false,
+ 'title' => '',
+ 'example' => '',
],
+ 'swift' => [
+ 'title' => '',
+ 'description' => 'The incremental Swift information.',
+ 'type' => 'object',
+ 'properties' => [
+ 'zk' => ['description' => 'zk', 'type' => 'string', 'required' => false, 'example' => 'zk', 'title' => ''],
+ 'topic' => ['description' => 'topic', 'type' => 'string', 'required' => false, 'example' => 'ha-cn-pl32rf0****_test_api', 'title' => ''],
+ ],
+ 'required' => false,
+ 'example' => '',
+ ],
+ ],
+ 'required' => false,
+ 'title' => '',
+ 'example' => '',
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'requestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '93A9E542-8CF8-5BA6-99AB-94C0FE520429'],
+ 'result' => ['title' => '', 'description' => 'The returned result.', 'type' => 'object', 'example' => '{}'],
],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
],
500 => [],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"E7B7D598-B080-5C8E-AA35-D43EC0D5F886\\",\\n \\"result\\": {\\n \\"name\\": \\"bj_vpc_domain_2\\",\\n \\"description\\": \\"自定义描述\\",\\n \\"currentAdvanceConfigVersion\\": \\"ha-cn-pl32rf0****_offline_adv_v1\\",\\n \\"latestAdvanceConfigVersion\\": \\"ha-cn-pl32rf0****_offline_adv_v1\\",\\n \\"currentOnlineConfigVersion\\": \\"ha-cn-pl32rf0****_online_adv_v1\\",\\n \\"latestOnlineConfigVersion\\": \\"ha-cn-pl32rf0****_online_adv_v1\\",\\n \\"configUpdateTime\\": \\"2021-08-09 00:01:02\\",\\n \\"status\\": \\"NEW\\",\\n \\"queryNode\\": {\\n \\"name\\": \\"ha-cn-pl32rf0****_qrs\\",\\n \\"number\\": 1,\\n \\"partition\\": 2\\n },\\n \\"dataNode\\": {\\n \\"name\\": \\"general\\",\\n \\"number\\": 1,\\n \\"partition\\": 2\\n },\\n \\"createTime\\": \\"2024-05-21 16:05:26\\",\\n \\"config\\": {\\n \\"key\\": {\\n \\"key\\": {\\n \\"name\\": \\"ha-cn-pl32rf0****_offline_adv_v1\\\\n\\",\\n \\"updateTime\\": \\"2024-05-21 16:05:26\\",\\n \\"desc\\": \\"自定义描述\\"\\n }\\n }\\n }\\n }\\n}","type":"json"}]',
- 'title' => 'GetCluster',
+ 'title' => 'Modify data source deployment information',
+ 'summary' => 'Modifies the deployment information of a data source.',
'description' => '### Method'."\n"
."\n"
- .'`GET`'."\n"
+ .'```java'."\n"
+ .'PUT'."\n"
+ .'```'."\n"
."\n"
.'### URI'."\n"
."\n"
- .'`/openapi/ha3/instance/{instanceId}/clusters/{clusterName}`'."\n",
- 'requestParamsDescription' => '### Sample requests'."\n"
+ .'```java'."\n"
+ .'/openapi/ha3/instances/{instanceId}/data-sources/{dataSourceName}/deploys/{deployName}'."\n"
+ .'```.',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ModifyDataSourceDeploy'],
+ ],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'searchengine:ModifyDataSourceDeploy',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SearchEngine', 'resourceType' => 'Instance', 'arn' => 'acs:searchengine:{#regionId}:{#accountId}:instance/{#instanceId}'],
+ ],
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"93A9E542-8CF8-5BA6-99AB-94C0FE520429\\",\\n \\"result\\": {}\\n}","type":"json"}]',
+ ],
+ 'ModifyFile' => [
+ 'summary' => 'Modifies a file.',
+ 'path' => '/openapi/ha3/instances/{instanceId}/indexes/{indexName}/versions/{versionName}/file',
+ 'methods' => ['put'],
+ 'schemes' => ['http', 'https'],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'read',
+ 'deprecated' => false,
+ 'systemTags' => [],
+ 'parameters' => [
+ [
+ 'name' => 'instanceId',
+ 'in' => 'path',
+ 'schema' => ['description' => 'The instance ID.'."\n", 'type' => 'string', 'required' => true, 'example' => 'ha-cn-pl32rf0****', 'title' => ''],
+ ],
+ [
+ 'name' => 'indexName',
+ 'in' => 'path',
+ 'schema' => ['description' => 'The index name.'."\n", 'type' => 'string', 'required' => true, 'example' => 'test_api', 'title' => ''],
+ ],
+ [
+ 'name' => 'versionName',
+ 'in' => 'path',
+ 'schema' => ['description' => 'The version name.'."\n", 'type' => 'string', 'required' => true, 'example' => 'ha-cn-pl32rf0****_online_config_v1', 'title' => ''],
+ ],
+ [
+ 'name' => 'fileName',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The name of the file in the full path'."\n", 'type' => 'string', 'required' => true, 'example' => '/schemas/generation_schema.json', 'title' => ''],
+ ],
+ [
+ 'name' => 'body',
+ 'in' => 'body',
+ 'style' => 'json',
+ 'schema' => [
+ 'description' => 'The request body.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'content' => ['title' => '', 'description' => 'The file content.'."\n", 'type' => 'string', 'required' => false, 'example' => '{\\"partition\\":1}'],
+ 'partition' => ['title' => '', 'description' => 'The number of shards.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1'],
+ ],
+ 'required' => false,
+ 'example' => '{\\"desc\\":\\"new version\\"}',
+ 'title' => '',
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'requestId' => ['title' => '', 'description' => 'id of request'."\n", 'type' => 'string', 'example' => '89B968E6-1E41-58DF-BB25-5F98ECC759CE'],
+ 'result' => ['title' => '', 'description' => 'The information about the index'."\n", 'type' => 'object', 'example' => '{}'],
+ ],
+ 'description' => 'Schema of Response'."\n",
+ 'title' => '',
+ 'example' => '',
+ ],
+ ],
+ 500 => [],
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"89B968E6-1E41-58DF-BB25-5F98ECC759CE\\",\\n \\"result\\": {}\\n}","type":"json"}]',
+ 'title' => 'ModifyFile',
+ 'description' => '## Method'."\n"
."\n"
- .'`GET /openapi/ha3/instance/ha_name_example/clusters/my_cluster`'."\n",
- 'responseParamsDescription' => '### Sample responses'."\n"
+ .' PUT'."\n"
."\n"
+ .'## URI'."\n"
+ ."\n"
+ .' /openapi/ha3/instances/{instanceId}/indexes/{indexName}/versions/{versionName}/file?fileName=/root/test.txt'."\n",
+ 'requestParamsDescription' => '## Sample requests'."\n"
+ ."\n"
+ .' PUT /openapi/ha3/instances/ose-test1/indexes/index1/versions/version1?fileName=/root/test.txt'."\n"
+ .' '."\n"
.' {'."\n"
+ .' '."\n"
+ .' "partition": 1,'."\n"
+ .' '."\n"
+ .' "content": ""'."\n"
+ .' '."\n"
+ .' }'."\n",
+ 'responseParamsDescription' => '## [](#)Sample responses'."\n"
+ ."\n"
+ .'Sample success responses'."\n"
+ ."\n"
+ .' {'."\n"
+ .' '."\n"
.' "requestId": "e1eef569-1ff7-4bf8-acf7-1cecca9894ce",'."\n"
- .' "result": {'."\n"
- .' "name": "cluster1",'."\n"
- .' "configUpdateTime": "2021-08-09 00:01:02",'."\n"
- .' "CurrentAdvanceConfigVersion": "test_yyds_data1",'."\n"
- .' "lastestAdvanceConfigVersion": "test_yyds_data1",'."\n"
- .' "currentOnlineConfigVersion": "test_yyds_data1",'."\n"
- .' "lastestOnlineConfigVersion": "test_yyds_data1", '."\n"
- .' "description": "airecpre",'."\n"
- .' "queryNode": {'."\n"
- .' "name":"ha-cn-0ju2iimcu07_qrs",'."\n"
- .' "number": 1'."\n"
- .' },'."\n"
- .' "dataNode": {'."\n"
- .' "name":"general",'."\n"
- .' "number": 2,'."\n"
- .' "partition": 1'."\n"
- .' } '."\n"
- .' }'."\n"
- .' }',
- ],
- 'GetClusterRunTimeInfo' => [
- 'summary' => 'Queries the runtime information about a specified cluster.',
- 'path' => '/openapi/ha3/instances/{instanceId}/cluster-run-time-info',
- 'methods' => [
- 'get',
+ .' '."\n"
+ .' "result": {}'."\n"
+ .' '."\n"
+ .' }'."\n",
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ModifyFile'],
+ ],
],
- 'schemes' => [
- 'http',
- 'https',
+ 'ramActions' => [
+ [
+ 'operationType' => '',
+ 'ramAction' => [
+ 'action' => 'searchengine:ModifyFile',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SearchEngine', 'resourceType' => 'Instance', 'arn' => 'acs:searchengine:{#regionId}:{#accountId}:instance/{#InstanceId}'],
+ ],
+ ],
+ ],
],
+ ],
+ 'ModifyIndex' => [
+ 'path' => '/openapi/ha3/instances/{instanceId}/indexes/{indexName}',
+ 'methods' => ['put'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
- 'operationType' => 'read',
+ 'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
- 'operationType' => 'get',
+ 'operationType' => 'update',
+ 'riskType' => 'none',
+ 'chargeType' => 'free',
+ 'abilityTreeCode' => '186780',
+ 'abilityTreeNodes' => ['FEATUREopensearchVHEWK3'],
],
'parameters' => [
[
'name' => 'instanceId',
'in' => 'path',
- 'schema' => [
- 'title' => '实例 ID',
- 'description' => 'The instance ID.'."\n",
- 'type' => 'string',
- 'required' => true,
- 'example' => 'ha-cn-2r42ncw4102',
- ],
+ 'schema' => ['description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'example' => 'ha-cn-pl32rf0****', 'title' => ''],
],
- ],
- 'responses' => [
- 200 => [
+ [
+ 'name' => 'indexName',
+ 'in' => 'path',
+ 'schema' => ['description' => 'The index name.', 'type' => 'string', 'required' => true, 'example' => 'test_api', 'title' => ''],
+ ],
+ [
+ 'name' => 'dryRun',
+ 'in' => 'query',
+ 'schema' => ['description' => 'Specifies whether to only validate the input parameters without performing the actual operation. Default value: false.'."\n"
+ ."\n"
+ .'Valid values:'."\n"
+ ."\n"
+ .'- **true**: Only validates the parameter validity.'."\n"
+ ."\n"
+ .'- **false**: Validates the parameter validity and creates the attribution configuration.', 'type' => 'boolean', 'default' => 'false', 'required' => false, 'example' => 'true', 'title' => ''],
+ ],
+ [
+ 'name' => 'body',
+ 'in' => 'body',
+ 'style' => 'json',
'schema' => [
- 'title' => 'Schema of Response',
- 'description' => 'The results returned.'."\n",
+ 'description' => 'The request body parameters.',
'type' => 'object',
'properties' => [
- 'requestId' => [
- 'title' => 'Id of the request',
- 'description' => 'The request ID.'."\n",
- 'type' => 'string',
- 'example' => 'E45380E8-994A-5402-9806-F114B3295FCF',
+ 'dataSourceInfo' => [
+ 'description' => 'The data source information. This parameter is required for the new version of AISearch.',
+ 'type' => 'object',
+ 'properties' => [
+ 'buildMode' => ['title' => '', 'description' => 'The index rebuild mode. Valid values: api (push data source through API) and indexRecover (recover data source from the index).', 'type' => 'string', 'required' => false, 'example' => 'api'],
+ 'generation' => ['title' => '', 'description' => 'The generation of the dump table when recovering the data source from the index.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1718698593'],
+ 'dataTimeSec' => ['title' => '', 'description' => 'The timestamp for incremental data tracking.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1709715164'],
+ 'processPartitionCount' => ['title' => '', 'description' => 'The number of resources for data updates.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '4'],
+ 'name' => ['title' => '', 'description' => 'The data source name.', 'type' => 'string', 'required' => false, 'example' => 'ha-cn-pl32rf0****_index_1'],
+ 'type' => ['title' => '', 'description' => 'The data source type. Valid values: odps, swift, saro, oss, and unKnow.', 'type' => 'string', 'required' => false, 'example' => 'odps'],
+ 'domain' => ['title' => '', 'description' => 'The offline deployment.', 'type' => 'string', 'required' => false, 'example' => 'vpc_hz_domain_1'."\n"],
+ 'config' => [
+ 'title' => '',
+ 'description' => 'The ODPS datasource config.',
+ 'type' => 'object',
+ 'properties' => [
+ 'endpoint' => ['title' => '', 'description' => 'The ODPS endpoint.', 'type' => 'string', 'required' => false, 'example' => 'http://service.cn-hangzhou.maxcompute.aliyun-inc.com/api'],
+ 'accessKey' => ['description' => 'The AccessKey ID of the ODPS data source.', 'type' => 'string', 'required' => false, 'example' => 'L***p', 'title' => ''],
+ 'accessSecret' => ['description' => 'The AccessKey secret of the ODPS data source.', 'type' => 'string', 'required' => false, 'example' => '5**9a6', 'title' => ''],
+ 'project' => ['description' => 'The ODPS data source project name.', 'type' => 'string', 'required' => false, 'example' => 'bbt_algo_pai', 'title' => ''],
+ 'partition' => ['description' => 'The ODPS partition. Example: ds=20180102.', 'type' => 'string', 'required' => false, 'example' => 'ds=20230114', 'title' => ''],
+ 'table' => ['title' => '', 'description' => 'The table name for saro or ODPS data sources.', 'type' => 'string', 'required' => false, 'example' => 'item'],
+ 'namespace' => ['title' => '', 'description' => 'The namespace for saro data sources.', 'type' => 'string', 'required' => false, 'example' => 'test-namespace'],
+ 'path' => ['title' => '', 'description' => 'The path for HDFS data sources.', 'type' => 'string', 'required' => false, 'example' => 'test-hdfs-path'],
+ 'ossPath' => ['title' => '', 'description' => 'The path for OSS data sources.', 'type' => 'string', 'required' => false, 'example' => '/opensearch/oss.json'],
+ 'bucket' => ['description' => 'The OSS bucket.', 'type' => 'string', 'required' => false, 'example' => 'test-bucket', 'title' => ''],
+ 'format' => ['description' => 'The OSS file format type. Valid values:'."\n"
+ .'- ha3'."\n"
+ .'- json.', 'type' => 'string', 'required' => false, 'example' => 'ha3', 'title' => ''],
+ 'catalog' => ['description' => 'The data catalog ID for DLF data sources.', 'type' => 'string', 'required' => false, 'example' => 'test-catalog', 'title' => ''],
+ 'database' => ['description' => 'The database for DLF data sources.', 'type' => 'string', 'required' => false, 'example' => 'test-database', 'title' => ''],
+ 'tag' => ['description' => 'The tag for DLF data sources.', 'type' => 'string', 'required' => false, 'example' => 'test-tag', 'title' => ''],
+ 'tableFormat' => ['description' => 'The table format for DLF data sources.', 'type' => 'string', 'required' => false, 'example' => 'paimon'."\n"
+ .'lance'."\n"
+ .'object', 'title' => ''],
+ ],
+ 'required' => false,
+ 'example' => '',
+ ],
+ 'saroConfig' => [
+ 'title' => '',
+ 'description' => 'The saro datasource config.',
+ 'type' => 'object',
+ 'properties' => [
+ 'namespace' => ['description' => 'The namespace of the saro data source.', 'type' => 'string', 'required' => false, 'example' => 'flink-test-fjx-default', 'title' => ''],
+ 'tableName' => ['description' => 'The saro data table name.', 'type' => 'string', 'required' => false, 'example' => 'device_event_shy_summary_', 'title' => ''],
+ ],
+ 'required' => false,
+ 'example' => '',
+ ],
+ 'autoBuildIndex' => ['title' => '', 'description' => 'Specifies whether to enable automatic full indexing.', 'type' => 'boolean', 'required' => false, 'example' => 'true'],
+ 'processParallelNum' => ['description' => 'The number of concurrent full-indexing processes.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '2', 'title' => ''],
+ 'partition' => ['title' => '', 'description' => 'The ODPS data source partition. This parameter is required when the data source type is ODPS.', 'type' => 'string', 'required' => false, 'example' => 'ds=20230114'],
+ 'ossDataPath' => ['title' => '', 'description' => 'The file path selected for index rebuilding from an OSS data source.', 'type' => 'string', 'required' => false, 'example' => '/opensearch/oss.json'],
+ ],
+ 'required' => false,
+ 'title' => '',
+ 'example' => '',
],
- 'result' => [
- 'title' => '结果集',
- 'description' => 'The result.'."\n",
- 'type' => 'array',
- 'items' => [
- 'description' => 'The runtime information of the cluster.'."\n",
+ 'description' => ['description' => 'The description.', 'type' => 'string', 'required' => false, 'example' => '"test"', 'title' => ''],
+ 'content' => ['title' => '', 'description' => 'The file content.', 'type' => 'string', 'required' => false, 'example' => '{\\"summarys\\":{\\"summary_fields\\":[\\"id\\"]},\\"indexs\\":[{\\"index_name\\":\\"index_id\\",\\"index_type\\":\\"PRIMARYKEY64\\",\\"index_fields\\":\\"id\\",\\"has_primary_key_attribute\\":true,\\"is_primary_key_sorted\\":false}],\\"attributes\\":[\\"id\\"],\\"fields\\":[{\\"field_name\\":\\"id\\",\\"field_type\\":\\"UINT16\\"}],\\"table_name\\":\\"index_2\\"}'],
+ 'partition' => ['title' => '', 'description' => 'The data partition.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '2'],
+ 'dataSource' => ['title' => '', 'description' => 'The data source.', 'type' => 'string', 'required' => false, 'example' => 'ha-cn-pl32rf0****_index_1'],
+ 'domain' => ['title' => '', 'description' => 'The data source deployment.', 'type' => 'string', 'required' => false, 'example' => 'vpc_hz_domain_1'],
+ 'buildParallelNum' => ['description' => 'The number of concurrent full-indexing build threads.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '2', 'title' => ''],
+ 'mergeParallelNum' => ['description' => 'The number of concurrent full-indexing merge threads.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '2', 'title' => ''],
+ 'cluster' => [
+ 'description' => 'The cluster information.',
+ 'type' => 'object',
+ 'required' => false,
+ 'additionalProperties' => [
'type' => 'object',
- 'properties' => [
- 'clusterName' => [
- 'title' => '集群名称',
- 'description' => 'The cluster name.'."\n",
- 'type' => 'string',
- 'example' => 'vpc_hz_domain_1',
- ],
- 'queryNode' => [
- 'title' => '查询结点信息',
- 'description' => 'The information about the Query Result Searcher (QRS) workers.'."\n",
- 'type' => 'object',
- 'properties' => [
- 'serviceStatus' => [
- 'title' => '服务状态',
- 'description' => 'The service status of the QRS worker.'."\n",
- 'type' => 'object',
- 'properties' => [
- 'name' => [
- 'description' => 'The cluster name.'."\n",
- 'type' => 'string',
- 'example' => 'ha-cn-c4d2rq7nt04_qrs',
- ],
- 'totalSize' => [
- 'title' => '总大小',
- 'description' => 'The total number of QRS workers in the cluster.'."\n",
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '100',
- ],
- 'doneSize' => [
- 'title' => '完成大小',
- 'description' => 'The number of processed QRS workers in the cluster.'."\n",
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '100',
- ],
- 'donePercent' => [
- 'title' => '进度',
- 'description' => 'The process progress of QRS workers in the cluster. Unit: percentage.'."\n",
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '100',
- ],
- ],
- ],
- 'configStatusList' => [
- 'description' => 'The configuration status.'."\n",
- 'type' => 'array',
- 'items' => [
- 'description' => '',
- 'type' => 'object',
- 'properties' => [
- 'configUpdateTime' => [
- 'description' => 'The time when the configuration was last updated.'."\n",
- 'type' => 'string',
- 'example' => '" "',
- ],
- 'name' => [
- 'description' => 'The cluster name.'."\n",
- 'type' => 'string',
- 'example' => 'ha-cn-zvp2qr1sk01_qrs',
- ],
- 'totalSize' => [
- 'description' => 'The total number of QRS workers in the cluster.'."\n",
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '6',
- ],
- 'doneSize' => [
- 'description' => 'The number of processed QRS workers in the cluster.'."\n",
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '100',
- ],
- 'donePercent' => [
- 'description' => 'The process progress of QRS workers in the cluster. Unit: percentage.'."\n",
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '100',
- ],
- ],
- ],
- ],
- ],
+ 'additionalProperties' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'value' => ['description' => 'Variable', 'type' => 'string', 'example' => 'partition', 'title' => ''],
+ 'description' => ['description' => 'Description', 'type' => 'string', 'example' => 'Custom Variable', 'title' => ''],
+ 'disableModify' => ['description' => 'Whether the user can modify this', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
+ 'isModify' => ['description' => 'Whether this has been modified', 'type' => 'boolean', 'example' => 'false', 'title' => ''],
+ 'type' => ['description' => 'Normal variable: NORMAL, function variable: FUNCTION', 'type' => 'string', 'example' => 'NORMAL', 'title' => ''],
],
- 'dataNodes' => [
- 'title' => '数据结点信息',
- 'description' => 'The information about the Searcher workers.'."\n",
+ 'description' => 'Content updates for cluster.json',
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'description' => 'Cluster information',
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'clusterConfigName' => ['description' => 'The cluster.json file name.', 'type' => 'string', 'required' => false, 'example' => 'ha-cn-pl32rf0****@a-cn-pl32rf0****_test_api@hz_pre_vpc_domain_1@test_api@index_config_v1', 'title' => ''],
+ 'config' => [
+ 'description' => 'The offline configuration information.',
+ 'type' => 'object',
+ 'required' => false,
+ 'additionalProperties' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'desc' => ['description' => 'Remarks', 'type' => 'string', 'required' => false, 'example' => 'test', 'title' => ''],
+ 'files' => [
'type' => 'array',
'items' => [
- 'description' => 'The information about the cluster node.'."\n",
'type' => 'object',
'properties' => [
- 'dataStatusList' => [
- 'description' => 'The data of the Searcher worker.'."\n",
- 'type' => 'array',
- 'items' => [
- 'description' => '',
- 'type' => 'object',
- 'properties' => [
- 'docSize' => [
- 'description' => 'The storage capacity. Unit: GB.'."\n",
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '2',
- ],
- 'fullVersion' => [
- 'description' => 'The time when the full index version was generated.'."\n",
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '123423',
- ],
- 'incVersion' => [
- 'description' => 'The time when the incremental index version was generated.'."\n",
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '123423',
- ],
- 'incUpdateTime' => [
- 'description' => 'The time when incremental data in the index was last updated.'."\n",
- 'type' => 'string',
- 'example' => '""',
- ],
- 'fullUpdateTime' => [
- 'description' => 'The time when full data in the index was last updated.'."\n",
- 'type' => 'string',
- 'example' => '" "',
- ],
- 'indexConfigInfo' => [
- 'description' => 'The information about the index configuration.'."\n",
- 'type' => 'object',
- 'properties' => [
- 'configMetaName' => [
- 'description' => 'The name of the index configuration.'."\n",
- 'type' => 'string',
- 'example' => 'index_meta_name',
- ],
- 'version' => [
- 'description' => 'The version of the index template.'."\n",
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '1.0.0',
- ],
- ],
- ],
- 'advanceConfigInfo' => [
- 'description' => 'The information about the advanced configuration.'."\n",
+ 'operateType' => ['description' => 'Operation type. Valid values: UPDATE (update) and DELETE (delete). Default value: UPDATE.', 'type' => 'string', 'required' => false, 'example' => 'UPDATE', 'title' => ''],
+ 'parentFullPath' => ['description' => 'The path of the parent directory', 'type' => 'string', 'required' => false, 'example' => '/', 'title' => ''],
+ 'fileName' => ['description' => 'File name', 'type' => 'string', 'required' => false, 'example' => '/intervene_dict/analyzer.dict', 'title' => ''],
+ 'config' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'content' => ['description' => 'File content for dictionary configuration', 'type' => 'string', 'required' => false, 'example' => '$dictContent', 'title' => ''],
+ 'variables' => [
+ 'type' => 'object',
+ 'required' => false,
+ 'additionalProperties' => [
'type' => 'object',
'properties' => [
- 'configMetaName' => [
- 'description' => 'The name of the index configuration.'."\n",
- 'type' => 'string',
- 'example' => 'index_meta_name',
- ],
- 'version' => [
- 'description' => 'The version number.'."\n",
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '1.0',
- ],
- ],
- ],
- 'lackMemWorker' => [
- 'description' => 'The name of the worker that failed due to insufficient memory.'."\n",
- 'type' => 'array',
- 'items' => [
- 'description' => 'The name of the failed worker.'."\n",
- 'type' => 'string',
- 'example' => '""',
- ],
- ],
- 'deployFailedWorker' => [
- 'description' => 'The name of the worker that failed due to a deployment failure.'."\n",
- 'type' => 'array',
- 'items' => [
- 'description' => 'The name of the failed worker.'."\n",
- 'type' => 'string',
- 'example' => '""',
+ 'description' => ['description' => 'Description', 'type' => 'string', 'required' => false, 'example' => 'test', 'title' => ''],
+ 'disableModify' => ['description' => 'Whether the user can modify this', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'title' => ''],
+ 'isModify' => ['description' => 'Whether this has been modified', 'type' => 'boolean', 'required' => false, 'example' => 'false', 'title' => ''],
+ 'type' => ['description' => 'Normal variable: NORMAL, function variable: FUNCTION', 'type' => 'string', 'required' => false, 'example' => 'NORMAL', 'title' => ''],
+ 'value' => ['description' => 'Variable', 'type' => 'string', 'required' => false, 'example' => 'test', 'title' => ''],
],
+ 'description' => 'Variable information',
+ 'title' => '',
+ 'example' => '',
],
- 'lackDiskWorker' => [
- 'description' => 'The name of the worker that failed due to insufficient disks.'."\n",
- 'type' => 'array',
- 'items' => [
- 'description' => 'The name of the failed worker.'."\n",
- 'type' => 'string',
- 'example' => '""',
- ],
- ],
- 'errorMsg' => [
- 'description' => 'The error message.'."\n",
- 'type' => 'string',
- 'example' => '0A3B1C48006A6C0905F6375F4821EB50',
- ],
- 'indexSize' => [
- 'description' => 'The index size.'."\n",
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '100',
- ],
- 'name' => [
- 'description' => 'The name of the QRS worker.'."\n",
- 'type' => 'string',
- 'example' => 'ha-cn-c4d2rq7nt04_qrs',
- ],
- 'totalSize' => [
- 'description' => 'The total number of QRS workers in the cluster.'."\n",
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '1',
- ],
- 'doneSize' => [
- 'description' => 'The number of processed QRS workers in the cluster.'."\n",
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '100',
- ],
- 'donePercent' => [
- 'description' => 'The configuration progress. Unit: percentage.'."\n",
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '100',
- ],
- ],
- ],
- ],
- 'serviceStatus' => [
- 'description' => 'The service status of the QRS worker.'."\n",
- 'type' => 'object',
- 'properties' => [
- 'name' => [
- 'description' => 'The name of the QRS worker.'."\n",
- 'type' => 'string',
- 'example' => 'ha-cn-0ju2s170b03_qrs',
- ],
- 'totalSize' => [
- 'description' => 'The total number of QRS workers in the cluster.'."\n",
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '100',
- ],
- 'doneSize' => [
- 'description' => 'The number of processed QRS workers in the cluster.'."\n",
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '100',
- ],
- 'donePercent' => [
- 'description' => 'The process progress of QRS workers in the cluster. Unit: percentage.'."\n",
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '100',
- ],
- ],
- ],
- 'configStatusList' => [
- 'description' => 'The configuration status.'."\n",
- 'type' => 'array',
- 'items' => [
- 'description' => 'The response body.'."\n",
- 'type' => 'object',
- 'properties' => [
- 'configUpdateTime' => [
- 'description' => 'The time when the configuration was last updated.'."\n",
- 'type' => 'string',
- 'example' => '""',
- ],
- 'name' => [
- 'description' => 'The cluster name.'."\n",
- 'type' => 'string',
- 'example' => 'test_0704',
- ],
- 'totalSize' => [
- 'description' => 'The total number of Searcher workers in the cluster.'."\n",
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '0',
- ],
- 'doneSize' => [
- 'description' => 'The number of processed Searcher workers in the cluster.'."\n",
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '1',
- ],
- 'donePercent' => [
- 'description' => 'The configuration progress. Unit: percentage.'."\n",
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '100',
- ],
+ 'description' => 'Variable',
+ 'title' => '',
+ 'example' => '',
],
],
+ 'required' => false,
+ 'description' => 'The configuration for this update',
+ 'title' => '',
+ 'example' => '',
],
+ 'dirName' => ['description' => 'Directory name', 'type' => 'string', 'required' => false, 'example' => '/test', 'title' => ''],
],
+ 'required' => false,
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
+ 'required' => false,
+ 'description' => 'List of modified files',
+ 'title' => '',
+ 'example' => '',
],
],
+ 'description' => 'Offline configuration',
+ 'title' => '',
+ 'example' => '',
],
+ 'title' => '',
+ 'example' => '',
],
+ 'pushMode' => ['description' => 'The push configuration mode. Default value: push configuration only.', 'type' => 'string', 'required' => false, 'example' => 'PUSH_ONLY', 'title' => ''],
+ 'extend' => ['description' => 'The extended content for field configurations. key: vector (vector field), embeding (field requiring embedding), or description (remarks field). value: ["schema field name"].', 'type' => 'object', 'required' => false, 'example' => '{'."\n"
+ .' "vector":'."\n"
+ .' ['."\n"
+ .' "source_image_vector"'."\n"
+ .' ],'."\n"
+ .' "embeding":'."\n"
+ .' ['."\n"
+ .' "source_image"'."\n"
+ .' ],'."\n"
+ .' "description":'."\n"
+ .' []'."\n"
+ .' }', 'title' => ''],
],
+ 'required' => false,
+ 'title' => '',
+ 'example' => '',
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'requestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '93A9E542-8CF8-5BA6-99AB-94C0FE520429'],
+ 'result' => ['title' => '', 'description' => 'The returned result.', 'type' => 'any', 'example' => '{}'],
+ ],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
],
500 => [],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"E45380E8-994A-5402-9806-F114B3295FCF\\",\\n \\"result\\": [\\n {\\n \\"clusterName\\": \\"vpc_hz_domain_1\\",\\n \\"queryNode\\": {\\n \\"serviceStatus\\": {\\n \\"name\\": \\"vpc_hz_domain_1\\\\n\\",\\n \\"totalSize\\": 100,\\n \\"doneSize\\": 100,\\n \\"donePercent\\": 100\\n },\\n \\"configStatusList\\": [\\n {\\n \\"configUpdateTime\\": \\"2024-05-21 16:05:26\\",\\n \\"name\\": \\"vpc_hz_domain_1\\\\n\\",\\n \\"totalSize\\": 6,\\n \\"doneSize\\": 100,\\n \\"donePercent\\": 100\\n }\\n ]\\n },\\n \\"dataNodes\\": [\\n {\\n \\"dataStatusList\\": [\\n {\\n \\"docSize\\": 2,\\n \\"fullVersion\\": 1718846192,\\n \\"incVersion\\": 1718846192,\\n \\"incUpdateTime\\": \\"2024-05-21 16:05:26\\",\\n \\"fullUpdateTime\\": \\"2024-05-21 16:05:26\\",\\n \\"indexConfigInfo\\": {\\n \\"configMetaName\\": \\"index_meta_name\\",\\n \\"version\\": 0\\n },\\n \\"advanceConfigInfo\\": {\\n \\"configMetaName\\": \\"index_meta_name\\",\\n \\"version\\": 1\\n },\\n \\"lackMemWorker\\": [\\n \\"test-fail-worker\\\\n\\"\\n ],\\n \\"deployFailedWorker\\": [\\n \\"test-fail-worker\\\\n\\"\\n ],\\n \\"lackDiskWorker\\": [\\n \\"test-fail-worker\\"\\n ],\\n \\"errorMsg\\": \\"0A3B1C48006A6C0905F6375F4821EB50\\",\\n \\"indexSize\\": 100,\\n \\"name\\": \\"ha-cn-pl32rf0****_qrs\\",\\n \\"totalSize\\": 1,\\n \\"doneSize\\": 100,\\n \\"donePercent\\": 100\\n }\\n ],\\n \\"serviceStatus\\": {\\n \\"name\\": \\"ha-cn-pl32rf0****_qrs\\",\\n \\"totalSize\\": 100,\\n \\"doneSize\\": 100,\\n \\"donePercent\\": 100\\n },\\n \\"configStatusList\\": [\\n {\\n \\"configUpdateTime\\": \\"2024-05-21 16:05:26\\",\\n \\"name\\": \\"test_0704\\",\\n \\"totalSize\\": 0,\\n \\"doneSize\\": 1,\\n \\"donePercent\\": 100\\n }\\n ]\\n }\\n ]\\n }\\n ]\\n}","type":"json"}]',
- 'title' => 'GetClusterRunTimeInfo',
+ 'eventInfo' => [
+ 'enable' => false,
+ 'eventNames' => [],
+ ],
+ 'title' => 'Modify an index',
+ 'summary' => 'Modifies an index.',
'description' => '### Method'."\n"
."\n"
- .'GET'."\n"
+ .'```java'."\n"
+ .'PUT'."\n"
+ .'```'."\n"
."\n"
.'### URI'."\n"
."\n"
- .'/openapi/ha3/instances/{instanceId}/cluster-run-time-info'."\n",
- 'requestParamsDescription' => '### Sample requests'."\n"
- ."\n"
- .'`GET /openapi/ha3/instances/ose-test1/cluster-run-time-info`'."\n",
- 'extraInfo' => "\n"
- ."\n",
- ],
- 'ListClusterNames' => [
- 'summary' => 'Queries cluster names.',
- 'path' => '/openapi/ha3/cluster-names',
- 'methods' => [
- 'get',
- ],
- 'schemes' => [
- 'http',
- 'https',
+ .'```java'."\n"
+ .'/openapi/ha3/instances/{instanceId}/indexes/{indexName}'."\n"
+ .'```.',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'searchengine:ModifyIndex',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SearchEngine', 'resourceType' => 'Instance', 'arn' => 'acs:searchengine:{#regionId}:{#accountId}:instance/{#InstanceId}'],
+ ],
+ ],
+ ],
],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"93A9E542-8CF8-5BA6-99AB-94C0FE520429\\",\\n \\"result\\": \\"{}\\"\\n}","type":"json"}]',
+ ],
+ 'ModifyIndexOnlineStrategy' => [
+ 'summary' => 'Modifies the online policy of an index.',
+ 'path' => '/openapi/ha3/instances/{instanceId}/data-sources/{dataSourceName}/deploys/{deployName}/indexes/{indexName}/online-strategy',
+ 'methods' => ['put'],
+ 'schemes' => ['https', 'http'],
'security' => [
[
'AK' => [],
],
],
- 'operationType' => 'read',
+ 'operationType' => 'write',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'list',
+ 'systemTags' => [],
+ 'parameters' => [
+ [
+ 'name' => 'instanceId',
+ 'in' => 'path',
+ 'schema' => ['description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'example' => 'ha-cn-pl32rf0****', 'title' => ''],
+ ],
+ [
+ 'name' => 'dataSourceName',
+ 'in' => 'path',
+ 'schema' => ['description' => 'The name of the data source.', 'type' => 'string', 'required' => true, 'example' => 'ha-cn-pl32rf0****_api_test', 'title' => ''],
+ ],
+ [
+ 'name' => 'deployName',
+ 'in' => 'path',
+ 'schema' => ['description' => 'The name of the data center in which the data source is deployed.', 'type' => 'string', 'required' => true, 'example' => 'vpc_hz_domain_1', 'title' => ''],
+ ],
+ [
+ 'name' => 'indexName',
+ 'in' => 'path',
+ 'schema' => ['description' => 'The index name.', 'type' => 'string', 'required' => true, 'example' => 'test_tusou_v2', 'title' => ''],
+ ],
+ [
+ 'name' => 'body',
+ 'in' => 'body',
+ 'style' => 'json',
+ 'schema' => [
+ 'description' => 'The request body.',
+ 'type' => 'object',
+ 'properties' => [
+ 'changeRate' => ['description' => 'The index change rate.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'required' => false, 'example' => '20'],
+ ],
+ 'required' => false,
+ 'title' => '',
+ 'example' => '',
+ ],
+ ],
],
- 'parameters' => [],
'responses' => [
200 => [
+ 'headers' => [],
'schema' => [
- 'description' => 'The response parameters.'."\n",
'type' => 'object',
'properties' => [
- 'requestId' => [
- 'title' => 'id of request',
- 'description' => 'id of request'."\n",
- 'type' => 'string',
- 'example' => 'F6E3D968-529C-5C40-AFDD-133A8B8FD930',
- ],
- 'result' => [
- 'title' => 'ClusterNameInfo',
- 'description' => 'The result set.'."\n",
- 'type' => 'object',
- 'properties' => [
- 'name' => [
- 'title' => '集群名称',
- 'description' => 'The cluster name.'."\n",
- 'type' => 'string',
- 'example' => 'my_index',
- ],
- 'description' => [
- 'title' => '集群描述',
- 'description' => 'The description of the cluster.'."\n",
- 'type' => 'string',
- 'example' => 'ha3_test',
- ],
- 'id' => [
- 'description' => 'The cluster ID.'."\n",
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '25030',
+ 'requestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '10D5E615-69F7-5F49-B850-00169ADE513C'],
+ 'result' => ['title' => '', 'description' => 'The result.', 'type' => 'object', 'example' => '{}'],
+ ],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
+ ],
+ ],
+ 500 => [],
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"10D5E615-69F7-5F49-B850-00169ADE513C\\",\\n \\"result\\": {}\\n}","type":"json"}]',
+ 'title' => 'ModifyIndexOnlineStrategy',
+ 'description' => '### Method'."\n"
+ ."\n"
+ .'```java'."\n"
+ .'PUT'."\n"
+ .'```'."\n"
+ ."\n"
+ .'### URI'."\n"
+ ."\n"
+ .'```java'."\n"
+ .'/openapi/ha3/instances/{instanceId}/data-sources/{dataSourceName}/deploys/{deployName}/indexes/{indexName}/online-strategy'."\n"
+ .'```',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ModifyIndexOnlineStrategy'],
+ ],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => '',
+ 'ramAction' => [
+ 'action' => 'searchengine:ModifyIndexOnlineStrategy',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SearchEngine', 'resourceType' => 'Instance', 'arn' => 'acs:searchengine:{#regionId}:{#accountId}:instance/{#instanceId}'],
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'ModifyIndexPartition' => [
+ 'summary' => 'Modifies the information about index partitions.',
+ 'path' => '/openapi/ha3/instances/{instanceId}/index-partition',
+ 'methods' => ['put'],
+ 'schemes' => ['https', 'http'],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'write',
+ 'deprecated' => false,
+ 'systemTags' => [],
+ 'parameters' => [
+ [
+ 'name' => 'instanceId',
+ 'in' => 'path',
+ 'schema' => ['description' => 'The instance ID.'."\n", 'type' => 'string', 'required' => true, 'example' => 'ha-cn-pl32rf0****', 'title' => ''],
+ ],
+ [
+ 'name' => 'body',
+ 'in' => 'body',
+ 'style' => 'json',
+ 'schema' => [
+ 'description' => 'The request body.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'dataSourceName' => ['title' => '', 'description' => 'The name of the data source.'."\n", 'type' => 'string', 'required' => false, 'example' => 'ha-cn-pl32rf0****_test_api'],
+ 'generation' => ['title' => '', 'description' => 'The primary key.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1633293829'],
+ 'domainName' => ['title' => '', 'description' => 'The data center.'."\n", 'type' => 'string', 'required' => false, 'example' => 'sz_vpc_domain_1'],
+ 'indexInfos' => [
+ 'title' => '',
+ 'description' => 'The index information.'."\n",
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'The information about each index.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'indexName' => ['title' => '', 'description' => 'The index name.'."\n", 'type' => 'string', 'required' => false, 'example' => 'test_api'],
+ 'partitionCount' => ['title' => '', 'description' => 'The number of shards.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '3'],
+ 'parallelNum' => ['title' => '', 'description' => 'The concurrency. Default value: 1.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1'],
],
+ 'required' => false,
+ 'title' => '',
+ 'example' => '',
],
+ 'required' => false,
+ 'example' => '',
],
],
+ 'required' => false,
+ 'title' => '',
+ 'example' => '',
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'requestId' => ['title' => '', 'description' => 'id of request'."\n", 'type' => 'string', 'example' => '93A9E542-8CF8-5BA6-99AB-94C0FE520429'],
+ 'result' => ['title' => '', 'description' => 'Map'."\n", 'type' => 'object', 'example' => '[]'],
+ ],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
],
500 => [],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"F6E3D968-529C-5C40-AFDD-133A8B8FD930\\",\\n \\"result\\": {\\n \\"name\\": \\"hz_pre_vpc_domain_1\\",\\n \\"description\\": \\"自定义描述\\",\\n \\"id\\": 25030\\n }\\n}","type":"json"}]',
- 'title' => 'ListClusterNames',
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"93A9E542-8CF8-5BA6-99AB-94C0FE520429\\",\\n \\"result\\": []\\n}","type":"json"}]',
+ 'title' => 'ModifyIndexPartition',
'description' => '### Method'."\n"
."\n"
- .'GET'."\n"
+ .'`PUT`'."\n"
."\n"
.'### URI'."\n"
."\n"
- .'/openapi/ha3/instances/{instanceId}/cluster-names'."\n",
- 'requestParamsDescription' => '### Sample requests'."\n"
+ .'`/openapi/ha3/instances/{instanceId}/index-partition`'."\n",
+ 'requestParamsDescription' => '### Example'."\n"
."\n"
- .'```java'."\n"
- .'GET /openapi/ha3/instances/ha3_instance_name/cluster-names'."\n"
- .'```'."\n",
- 'responseParamsDescription' => '### Sample responses'."\n"
+ .'`PUT /openapi/ha3/instances/{instanceId}/index-partition`'."\n"
."\n"
- .'Success responses'."\n"
+ .' {'."\n"
+ .' "dataSourceName":"ha-cn-pl32n3bi904_d",'."\n"
+ .' "domainName":"pre_domain_1",'."\n"
+ .' "generation":"1633293829",'."\n"
+ .' "indexInfos":['."\n"
+ .' {'."\n"
+ .' "indexName":"atest2",'."\n"
+ .' "partitionCount":2'."\n"
+ .' }'."\n"
+ .' ]'."\n"
+ .' }'."\n",
+ 'responseParamsDescription' => '### [](#)Sample responses'."\n"
."\n"
- .'```java'."\n"
- .'{'."\n"
- .' "requestId": "e1eef569-1ff7-4bf8-acf7-1cecca9894ce",'."\n"
- .' "result": ['."\n"
.' {'."\n"
- .' "name":"pre",'."\n"
- .' "description":"pre",'."\n"
- .' "id": 1,'."\n"
+ .' "requestId": "0A6EB64B-B4C8-CF02-810F-E660812972FF",'."\n"
+ .' "result": []'."\n"
.' }'."\n"
- .' ]'."\n"
- .'}'."\n"
- .'```'."\n",
- ],
- 'ListClusters' => [
- 'path' => '/openapi/ha3/instances/{instanceId}/clusters',
- 'methods' => [
- 'get',
+ ."\n"
+ .'For more information, see [Response structure](~~465311~~).'."\n",
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ModifyIndexPartition'],
+ ],
],
- 'schemes' => [
- 'http',
- 'https',
+ 'ramActions' => [
+ [
+ 'operationType' => '',
+ 'ramAction' => [
+ 'action' => 'searchengine:ModifyIndexPartition',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SearchEngine', 'resourceType' => 'Instance', 'arn' => 'acs:searchengine:{#regionId}:{#accountId}:instance/{#instanceId}'],
+ ],
+ ],
+ ],
],
+ ],
+ 'ModifyIndexVersion' => [
+ 'summary' => 'Modifies the index version of a cluster (an index version rollback).',
+ 'path' => '/openapi/ha3/instances/{instanceId}/clusters/{clusterName}/index-version',
+ 'methods' => ['put'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
@@ -15622,22 +12990,39 @@
],
'operationType' => 'read',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'list',
- 'abilityTreeCode' => '103715',
- 'abilityTreeNodes' => [
- 'FEATUREopensearch5EAGY5',
- ],
- ],
+ 'systemTags' => [],
'parameters' => [
[
'name' => 'instanceId',
'in' => 'path',
+ 'schema' => ['description' => 'The instance ID.'."\n", 'type' => 'string', 'required' => true, 'example' => 'ha-cn-pl32rf0****', 'title' => ''],
+ ],
+ [
+ 'name' => 'clusterName',
+ 'in' => 'path',
+ 'schema' => ['description' => 'The name of the cluster.'."\n", 'type' => 'string', 'required' => false, 'example' => 'vpc_hz_domain_2', 'title' => ''],
+ ],
+ [
+ 'name' => 'body',
+ 'in' => 'body',
+ 'style' => 'json',
'schema' => [
- 'description' => 'The instance ID.'."\n",
- 'type' => 'string',
- 'required' => true,
- 'example' => 'ha-cn-zvp2jlr2g03',
+ 'description' => 'The request body.'."\n",
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'The keyword used to search for a version. Fuzzy match is supported.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'indexName' => ['title' => '', 'description' => 'The index name.'."\n", 'type' => 'string', 'required' => false, 'example' => 'main_index'],
+ 'version' => ['title' => '', 'description' => 'The index version.'."\n", 'type' => 'string', 'required' => false, 'example' => '1'],
+ 'buildDeployId' => ['title' => '', 'description' => 'The deployment ID of the data source.'."\n", 'type' => 'string', 'required' => false, 'example' => '277'],
+ ],
+ 'required' => false,
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'required' => false,
+ 'example' => '{}',
'title' => '',
],
],
@@ -15645,223 +13030,438 @@
'responses' => [
200 => [
'schema' => [
- 'description' => 'The response parameters.'."\n",
+ 'description' => 'Schema of Response'."\n",
'type' => 'object',
'properties' => [
- 'requestId' => [
- 'title' => 'id of request',
- 'description' => 'id of request'."\n",
- 'type' => 'string',
- 'example' => 'F43E8AB4-419C-5F4C-90D6-615590DFAA3C',
- ],
- 'result' => [
- 'title' => 'List',
- 'description' => 'The clusters.'."\n",
- 'type' => 'array',
- 'items' => [
- 'description' => 'The list of clusters.'."\n",
- 'type' => 'object',
- 'properties' => [
- 'name' => [
- 'title' => '集群名称(对应后端domainName)',
- 'description' => 'The cluster name.'."\n",
- 'type' => 'string',
- 'example' => 'ha-cn-7pp2pcna701_qrs',
- ],
- 'description' => [
- 'title' => '集群描述',
- 'description' => 'The description of the cluster.'."\n",
- 'type' => 'string',
- 'example' => 'fzz_test',
- ],
- 'currentAdvanceConfigVersion' => [
- 'title' => '高级配置生效版本',
- 'description' => 'The effective advanced configuration version.'."\n",
- 'type' => 'string',
- 'example' => '" "',
- ],
- 'latestAdvanceConfigVersion' => [
- 'title' => '高级配置最新版本',
- 'description' => 'The latest advanced configuration version.'."\n",
- 'type' => 'string',
- 'example' => '" "',
- ],
- 'currentOnlineConfigVersion' => [
- 'title' => '在线配置生效版本',
- 'description' => 'The effective online configuration version.'."\n",
- 'type' => 'string',
- 'example' => '" "',
- ],
- 'latestOnlineConfigVersion' => [
- 'title' => '在线配置最新版本',
- 'description' => 'The latest online configuration version.'."\n",
- 'type' => 'string',
- 'example' => '" "',
- ],
- 'currentOnlineQueryConfigVersion' => [
- 'title' => '查询配置生效版本',
- 'description' => 'The effective query configuration version.'."\n",
- 'type' => 'string',
- 'example' => 'ha-cn-pl32rf0****_offline_adv_v1',
- ],
- 'latestOnlineQueryConfigVersion' => [
- 'title' => '查询配置最新版本',
- 'description' => 'The latest query configuration version.'."\n",
- 'type' => 'string',
- 'example' => 'ha-cn-pl32rf0****_offline_adv_v1',
- ],
- 'currentOfflineDictConfigVersion' => [
- 'title' => '词典配置生效版本',
- 'description' => 'The effective dictionary configuration version.'."\n",
- 'type' => 'string',
- 'example' => 'ha-cn-pl32rf0****_offline_adv_v1',
- ],
- 'latestOfflineDictConfigVersion' => [
- 'title' => '词典配置最新版本',
- 'description' => 'The latest dictionary configuration version.'."\n",
- 'type' => 'string',
- 'example' => 'ha-cn-pl32rf0****_offline_adv_v1',
- ],
- 'configUpdateTime' => [
- 'title' => '配置更新时间',
- 'description' => 'The time when the configuration was updated.'."\n",
- 'type' => 'string',
- 'example' => '" "',
- ],
- 'status' => [
- 'description' => 'The cluster status. Valid values: running: The cluster is running. starting: The cluster is being started. stopping: The cluster is being stopped. stopped: The cluster is stopped.'."\n",
- 'type' => 'string',
- 'example' => '"starting"',
- ],
- 'queryNode' => [
- 'title' => '查询节点',
- 'description' => 'The information about Query Result Searcher (QRS) workers.'."\n",
- 'type' => 'object',
- 'properties' => [
- 'name' => [
- 'title' => '节点名称',
- 'description' => 'The name of the QRS worker.'."\n",
- 'type' => 'string',
- 'example' => 'test_0704',
- ],
- 'number' => [
- 'title' => '节点数量',
- 'description' => 'The number of QRS workers.'."\n",
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '1',
- ],
- 'partition' => [
- 'title' => '副本数量',
- 'description' => 'The ID of the partition that is stored on the QRS worker.'."\n",
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => 'dt=20211216',
- ],
- ],
- ],
- 'dataNode' => [
- 'title' => '数据节点',
- 'description' => 'The information about Searcher workers.'."\n",
- 'type' => 'object',
- 'properties' => [
- 'name' => [
- 'title' => '节点名称',
- 'description' => 'The name of the Searcher worker.'."\n",
- 'type' => 'string',
- 'example' => 'ha-cn-8ed2k7brm05_qrs',
- ],
- 'number' => [
- 'title' => '节点数量',
- 'description' => 'The number of Searcher workers.'."\n",
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '1',
- ],
- 'partition' => [
- 'title' => '副本数量',
- 'description' => 'The ID of the partition that is stored on the Searcher worker.'."\n",
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => 'dt=20220216',
+ 'requestId' => ['title' => '', 'description' => 'id of request'."\n", 'type' => 'string', 'example' => 'F43E8AB4-419C-5F4C-90D6-615590DFAA3C'],
+ 'result' => ['title' => '', 'description' => 'result'."\n", 'type' => 'object', 'example' => '{}'],
+ ],
+ 'title' => '',
+ 'example' => '',
+ ],
+ ],
+ 500 => [],
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"F43E8AB4-419C-5F4C-90D6-615590DFAA3C\\",\\n \\"result\\": {}\\n}","type":"json"}]',
+ 'title' => 'ModifyIndexVersion',
+ 'description' => '## [](#)Method'."\n"
+ ."\n"
+ .' PUT'."\n"
+ ."\n"
+ .'## [](#uri)URI'."\n"
+ ."\n"
+ .' /openapi/ha3/instances/{instanceId}/clusters/{clusterName}/index-version'."\n",
+ 'requestParamsDescription' => '## Sample requests'."\n"
+ ."\n"
+ .''."\n"
+ ."\n"
+ .' PUT /openapi/ha3/instances/ha3_instance_nameclusters/test_cluster/index-version'."\n"
+ ."\n"
+ .''."\n"
+ ."\n"
+ .' ['."\n"
+ .' '."\n"
+ .' {'."\n"
+ .' '."\n"
+ .' "indexName": "index1",'."\n"
+ .' '."\n"
+ .' "version": "123456",'."\n"
+ .' '."\n"
+ .' "buildDeployId": "20201010"'."\n"
+ .' '."\n"
+ .' },'."\n"
+ .' '."\n"
+ .' {'."\n"
+ .' '."\n"
+ .' "indexName": "index1",'."\n"
+ .' '."\n"
+ .' "version": "123456",'."\n"
+ .' '."\n"
+ .' "buildDeployId": "20201010"'."\n"
+ .' '."\n"
+ .' }'."\n"
+ .' '."\n"
+ .' ]'."\n"
+ .' '."\n",
+ 'responseParamsDescription' => '## [](#)Sample responses'."\n"
+ ."\n"
+ .'Sample success responses'."\n"
+ ."\n"
+ .' {'."\n"
+ .' '."\n"
+ .' "requestId": "0A6EB64B-B4C8-CF02-810F-E660812972FF",'."\n"
+ .' '."\n"
+ .' "result":[]'."\n"
+ .' '."\n"
+ .' }'."\n"
+ ."\n"
+ .'For more information, see [Response structure](~~465311~~).'."\n",
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ModifyIndexVersion'],
+ ],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => '',
+ 'ramAction' => [
+ 'action' => 'searchengine:ModifyIndexVersion',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SearchEngine', 'resourceType' => 'Instance', 'arn' => 'acs:searchengine:{#regionId}:{#accountId}:instance/{#InstanceId}'],
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'ModifyModel' => [
+ 'summary' => 'Modifies the details and status of a model.',
+ 'path' => '/openapi/ha3/instances/{instanceId}/models/{modelName}',
+ 'methods' => ['put'],
+ 'schemes' => ['https'],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'write',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'update',
+ 'riskType' => 'none',
+ 'chargeType' => 'free',
+ 'abilityTreeNodes' => ['FEATUREopensearchGTRUN8'],
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'instanceId',
+ 'in' => 'path',
+ 'schema' => ['title' => '', 'description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'example' => 'ha-cn-pl32rf0****'],
+ ],
+ [
+ 'name' => 'modelName',
+ 'in' => 'path',
+ 'schema' => ['title' => '', 'description' => 'The model name.', 'type' => 'string', 'required' => true, 'example' => 'test'],
+ ],
+ [
+ 'name' => 'dryRun',
+ 'in' => 'query',
+ 'schema' => ['title' => '', 'description' => 'Specifies whether to perform only a check. The default value is false.', 'type' => 'string', 'required' => false, 'example' => 'true'],
+ ],
+ [
+ 'name' => 'body',
+ 'in' => 'body',
+ 'style' => 'json',
+ 'schema' => [
+ 'description' => 'The request body.',
+ 'type' => 'object',
+ 'properties' => [
+ 'content' => [
+ 'description' => 'The model details.',
+ 'type' => 'object',
+ 'properties' => [
+ 'method' => ['description' => 'The HTTP method to access the model service. Valid values are PUT and POST.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => 'POST'."\n"
+ ."\n"],
+ 'modelType' => ['description' => 'The model type.'."\n"
+ ."\n"
+ .'- Text embedding: text\\_embedding'."\n"
+ ."\n"
+ .'- Text sparse embedding: text\\_sparse\\_embedding'."\n"
+ ."\n"
+ .'- Image embedding: image\\_embedding'."\n"
+ ."\n"
+ .'- Image content parsing: image\\_analyze', 'type' => 'string', 'required' => false, 'title' => '', 'example' => 'text_embedding'],
+ 'dimension' => ['title' => '', 'description' => 'The dimension of the model.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '128'],
+ 'request' => [
+ 'description' => 'The model request body.',
+ 'type' => 'object',
+ 'properties' => [
+ 'header' => [
+ 'description' => 'The HTTP header to access the model service.',
+ 'type' => 'object',
+ 'properties' => [
+ 'Authorization' => ['description' => 'The authentication information. Format: Bearer access\\_token', 'type' => 'string', 'required' => false, 'title' => '', 'example' => 'Bearer OS-v0********6vvs'."\n"],
+ 'Content-Type' => ['description' => 'The content type of the HTTP request.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => 'application/json'."\n"],
],
+ 'required' => false,
+ 'title' => '',
+ 'example' => '',
],
- ],
- 'createTime' => [
- 'description' => 'The time when the cluster was created.'."\n",
- 'type' => 'string',
- 'example' => '2024-05-21 16:05:26',
- ],
- 'config' => [
- 'description' => 'The configuration information.'."\n",
- 'type' => 'object',
- 'additionalProperties' => [
+ 'parameters' => [
+ 'description' => 'Specifies parameters that are different for the build and search phases.',
'type' => 'object',
- 'additionalProperties' => [
- 'type' => 'object',
- 'properties' => [
- 'name' => [
- 'type' => 'string',
- 'example' => 'ha-cn-pl32rf0****_offline_adv_v1',
- 'description' => 'The configuration name.'."\n",
- ],
- 'updateTime' => [
- 'type' => 'string',
- 'description' => 'The time when the configuration was updated.'."\n",
- 'example' => '2024-05-21 16:05:26',
+ 'properties' => [
+ 'build' => [
+ 'description' => 'The parameters for the index building phase.',
+ 'type' => 'object',
+ 'properties' => [
+ 'input_type' => ['description' => 'The input type.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => 'query'."\n"],
],
- 'desc' => [
- 'type' => 'string',
- 'description' => 'The description of the configuration.'."\n",
- 'example' => '',
+ 'required' => false,
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'search' => [
+ 'description' => 'The parameters for the query phase.',
+ 'type' => 'object',
+ 'properties' => [
+ 'input_type' => ['description' => 'The input type.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => 'document'."\n"],
],
+ 'required' => false,
+ 'title' => '',
+ 'example' => '',
],
- 'description' => 'The information about child configuration items.'."\n",
],
- 'description' => 'The configuration information.'."\n",
+ 'required' => false,
+ 'title' => '',
+ 'example' => '',
],
+ 'requestBody' => ['description' => 'The template string for the request body.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => '{\\"input\\": [\\"%{input}\\"], \\"input_type\\": \\"%{input_type}\\"}'."\n"],
+ 'urlParams' => [
+ 'description' => 'The parameters in the URL. Some model services require parameters to be passed in the URL.',
+ 'type' => 'object',
+ 'properties' => [
+ 'build' => ['description' => 'The parameters for the index building phase.', 'type' => 'object', 'required' => false, 'title' => '', 'example' => 'key: value'."\n"
+ ."\n"],
+ 'search' => ['description' => 'The parameters for the query phase.', 'type' => 'object', 'required' => false, 'title' => '', 'example' => 'key: value'."\n"
+ ."\n"],
+ ],
+ 'required' => false,
+ 'title' => '',
+ 'example' => '',
+ ],
+ ],
+ 'required' => false,
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'response' => [
+ 'description' => 'The JSONPath expression used to parse the result.',
+ 'type' => 'object',
+ 'properties' => [
+ 'embeddings' => ['description' => 'The JSONPath expression used to parse the embeddings from the result.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => '$.result.embeddings[*].embedding'."\n"],
],
+ 'required' => false,
+ 'title' => '',
+ 'example' => '',
],
+ 'url' => ['description' => 'The endpoint of the model service.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => 'http://***.platform-cn-shanghai.opensearch.aliyuncs.com/v3/openapi/workspaces/default/text-embedding/ops-text-embedding-001'],
],
+ 'required' => false,
+ 'title' => '',
+ 'example' => '',
],
+ 'status' => ['description' => 'The model status.'."\n"
+ ."\n"
+ .'- ok: The model is active.'."\n"
+ ."\n"
+ .'- forbidden: The model is unavailable.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => 'ok'],
],
- 'title' => 'Schema of Response',
+ 'required' => false,
+ 'title' => '',
+ 'example' => '',
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'title' => '',
+ 'description' => 'The response schema.',
+ 'type' => 'object',
+ 'properties' => [
+ 'requestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => 'D39EE0F1-D7EF-5F46-B781-6BF4185308B0'],
+ ],
+ 'example' => '',
+ ],
+ ],
+ ],
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"D39EE0F1-D7EF-5F46-B781-6BF4185308B0\\"\\n}","type":"json"}]',
+ 'title' => 'ModifyModel',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'searchengine:ModifyModel',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SearchEngine', 'resourceType' => 'Instance', 'arn' => 'acs:searchengine:{#regionId}:{#accountId}:instance/{#InstanceId}'],
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'ModifyNodeConfig' => [
+ 'summary' => 'Modify a node.',
+ 'path' => '/openapi/ha3/instances/{instanceId}/node-config',
+ 'methods' => ['put'],
+ 'schemes' => ['http', 'https'],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'read',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'abilityTreeCode' => '114152',
+ 'abilityTreeNodes' => ['FEATUREopensearchIQC42D'],
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'instanceId',
+ 'in' => 'path',
+ 'schema' => ['description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'example' => 'ha-cn-pl32rf0****', 'title' => ''],
+ ],
+ [
+ 'name' => 'type',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The type of the algorithm. Valid values:'."\n"
+ ."\n"
+ .'- pop: a popularity model.'."\n"
+ ."\n"
+ .'- cp: a category prediction model.'."\n"
+ ."\n"
+ .'- hot: a top search model.'."\n"
+ ."\n"
+ .'- hint: a hint model.'."\n"
+ ."\n"
+ .'- suggest: a drop-down suggestions model.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'hot'],
+ ],
+ [
+ 'name' => 'name',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The name of the configuration before the modification.', 'type' => 'string', 'required' => true, 'example' => 'ha-cn-pl32rf0****_qrs', 'title' => ''],
+ ],
+ [
+ 'name' => 'clusterName',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The name of the cluster.', 'type' => 'string', 'required' => false, 'example' => 'vpc_sh_domain_2', 'title' => ''],
+ ],
+ [
+ 'name' => 'dataSourceName',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The name of the data source. Valid values: -search: search for data. -not\\_search: do not search for data.', 'type' => 'string', 'required' => false, 'example' => 'search', 'title' => ''],
+ ],
+ [
+ 'name' => 'body',
+ 'in' => 'body',
+ 'style' => 'json',
+ 'schema' => [
+ 'description' => 'The request body.',
+ 'type' => 'object',
+ 'properties' => [
+ 'dataFragmentNumber' => ['description' => 'The number of data shards.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'required' => false, 'example' => '1'],
+ 'dataDuplicateNumber' => ['description' => 'The number of data replicas.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'required' => false, 'example' => '1'],
+ 'minServicePercent' => ['description' => 'The minimum service ratio.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'required' => false, 'example' => '10'],
+ 'published' => ['description' => 'Specifies whether to mount the cluster.', 'type' => 'boolean', 'title' => '', 'required' => false, 'example' => 'true'],
+ 'active' => ['description' => 'Specifies whether to enable the index.', 'type' => 'boolean', 'title' => '', 'required' => false, 'example' => 'true'],
+ 'flowRatio' => ['description' => 'The traffic percentage.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '100', 'title' => ''],
+ ],
+ 'required' => false,
+ 'example' => '{\\"desc\\":\\"new version\\"}',
+ 'title' => '',
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'requestId' => ['title' => '', 'description' => 'id of request', 'type' => 'string', 'example' => 'D39EE0F1-D7EF-5F46-B781-6BF4185308B0'],
+ 'result' => ['title' => '', 'description' => 'The information about the index', 'type' => 'object', 'example' => '{}'],
+ ],
+ 'description' => 'Schema of Response',
+ 'title' => '',
+ 'example' => '',
],
],
500 => [],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"F43E8AB4-419C-5F4C-90D6-615590DFAA3C\\",\\n \\"result\\": [\\n {\\n \\"name\\": \\"hz_pre_vpc_domain_1\\",\\n \\"description\\": \\"自定义描述\\",\\n \\"currentAdvanceConfigVersion\\": \\"ha-cn-pl32rf0****_offline_adv_v1\\",\\n \\"latestAdvanceConfigVersion\\": \\"ha-cn-pl32rf0****_offline_adv_v1\\",\\n \\"currentOnlineConfigVersion\\": \\"ha-cn-pl32rf0****_offline_adv_v1\\",\\n \\"latestOnlineConfigVersion\\": \\"ha-cn-pl32rf0****_offline_adv_v1\\",\\n \\"currentOnlineQueryConfigVersion\\": \\"ha-cn-pl32rf0****_offline_adv_v1\\",\\n \\"latestOnlineQueryConfigVersion\\": \\"ha-cn-pl32rf0****_offline_adv_v1\\",\\n \\"currentOfflineDictConfigVersion\\": \\"ha-cn-pl32rf0****_offline_adv_v1\\",\\n \\"latestOfflineDictConfigVersion\\": \\"ha-cn-pl32rf0****_offline_adv_v1\\",\\n \\"configUpdateTime\\": \\"2024-05-21 16:05:26\\",\\n \\"status\\": \\"running\\",\\n \\"queryNode\\": {\\n \\"name\\": \\"ha-cn-pl32rf0****_qrs\\",\\n \\"number\\": 1,\\n \\"partition\\": 1\\n },\\n \\"dataNode\\": {\\n \\"name\\": \\"general\\",\\n \\"number\\": 1,\\n \\"partition\\": 1\\n },\\n \\"createTime\\": \\"2024-05-21 16:05:26\\",\\n \\"config\\": {\\n \\"key\\": {\\n \\"key\\": {\\n \\"name\\": \\"ha-cn-pl32rf0****_offline_adv_v1\\",\\n \\"updateTime\\": \\"2024-05-21 16:05:26\\",\\n \\"desc\\": \\"自定义描述\\"\\n }\\n }\\n }\\n }\\n ]\\n}","type":"json"}]',
- 'title' => 'ListClusters',
- 'summary' => 'Queries clusters.',
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"D39EE0F1-D7EF-5F46-B781-6BF4185308B0\\",\\n \\"result\\": {}\\n}","type":"json"}]',
+ 'title' => 'ModifyNodeConfig',
'description' => '### Method'."\n"
."\n"
.'```java'."\n"
- .'GET'."\n"
+ .'PUT'."\n"
.'```'."\n"
."\n"
.'### URI'."\n"
."\n"
.'```java'."\n"
- .'/openapi/ha3/instances/{instanceId}/clusters'."\n"
- .'```'."\n",
+ .'/openapi/ha3/instances/{instanceId}/node-config?type=qrs&name=test'."\n"
+ .'```',
'requestParamsDescription' => '### Sample requests'."\n"
."\n"
.'```java'."\n"
- .'GET /openapi/ha3/instances/ha3_instance_name/clusters'."\n"
- .'```'."\n",
- 'extraInfo' => "\n"
- ."\n\n"
- ."\n",
- ],
- 'ModifyAlias' => [
- 'path' => '/openapi/ha3/instances/{instanceId}/aliases/{alias}',
- 'methods' => [
- 'put',
+ .'PUT /openapi/ha3/instances/{instanceId}/node-config?type=qrs&name=test'."\n"
+ .'```'."\n"
+ ."\n"
+ .''."\n"
+ ."\n"
+ .'```java'."\n"
+ .'{'."\n"
+ .''."\n"
+ .' "dataFragmentNumber":1,// The query node and data node'."\n"
+ .''."\n"
+ .' "dataDuplicateNumber":1,// The query node and data node'."\n"
+ .''."\n"
+ .' "minServicePercent":20,// The query node and data node'."\n"
+ .''."\n"
+ .' "published":true,// The cluster'."\n"
+ .''."\n"
+ .' "active": true //index'."\n"
+ .''."\n"
+ .'}'."\n"
+ .'```',
+ 'responseParamsDescription' => '### Sample responses'."\n"
+ ."\n"
+ .'Success responses '."\n"
+ ."\n"
+ .'```java'."\n"
+ .'{'."\n"
+ .''."\n"
+ .' "requestId": "0A6EB64B-B4C8-CF02-810F-E660812972FF",'."\n"
+ .''."\n"
+ .' "result": []'."\n"
+ .''."\n"
+ .'}'."\n"
+ .'```'."\n"
+ ."\n"
+ .'For more information, see [Response struct](https://www.alibabacloud.com/help/en/open-search/vector-search-edition/response-structure).',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ModifyNodeConfig'],
+ ],
],
- 'schemes' => [
- 'http',
- 'https',
+ 'ramActions' => [
+ [
+ 'operationType' => '',
+ 'ramAction' => [
+ 'action' => 'searchengine:ModifyNodeConfig',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SearchEngine', 'resourceType' => 'Instance', 'arn' => 'acs:searchengine:{#regionId}:{#accountId}:instance/{#InstanceId}'],
+ ],
+ ],
+ ],
],
+ ],
+ 'ModifyOnlineConfig' => [
+ 'path' => '/openapi/ha3/instances/{instanceId}/node/{nodeName}/online-configs/{indexName}',
+ 'methods' => ['put'],
+ 'schemes' => ['https', 'http'],
'security' => [
[
'AK' => [],
@@ -15869,33 +13469,22 @@
],
'operationType' => 'write',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'update',
- 'abilityTreeCode' => '223194',
- 'abilityTreeNodes' => [
- 'FEATUREopensearchGTRUN8',
- ],
- ],
+ 'systemTags' => [],
'parameters' => [
[
'name' => 'instanceId',
'in' => 'path',
- 'schema' => [
- 'description' => 'The instance ID.'."\n",
- 'type' => 'string',
- 'required' => true,
- 'example' => 'ha-cn-0ju2re****',
- ],
+ 'schema' => ['description' => 'The instance ID.'."\n", 'type' => 'string', 'required' => true, 'example' => 'ha-cn-pl32rf0****', 'title' => ''],
],
[
- 'name' => 'alias',
+ 'name' => 'nodeName',
'in' => 'path',
- 'schema' => [
- 'description' => 'alias name',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'test',
- ],
+ 'schema' => ['description' => 'The node name.'."\n", 'type' => 'string', 'required' => true, 'example' => 'general', 'title' => ''],
+ ],
+ [
+ 'name' => 'indexName',
+ 'in' => 'path',
+ 'schema' => ['description' => 'The index name.'."\n", 'type' => 'string', 'required' => true, 'example' => 'test_api', 'title' => ''],
],
[
'name' => 'body',
@@ -15904,23 +13493,10 @@
'schema' => [
'description' => 'The request body.'."\n",
'type' => 'object',
- 'properties' => [
- 'alias' => [
- 'title' => '别名',
- 'description' => 'alias name',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'test',
- ],
- 'index' => [
- 'title' => '关联索引',
- 'description' => 'index name',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'index',
- ],
- ],
'required' => false,
+ 'additionalProperties' => ['type' => 'string', 'description' => 'The request body.'."\n", 'example' => '{}', 'title' => ''],
+ 'title' => '',
+ 'example' => '',
],
],
],
@@ -15929,58 +13505,119 @@
'schema' => [
'type' => 'object',
'properties' => [
- 'requestId' => [
- 'title' => 'id of request',
- 'description' => 'id of request',
- 'type' => 'string',
- 'example' => 'F6E3D968-529C-5C40-AFDD-133A8B8FD930',
- ],
- 'result' => [
- 'title' => 'Map',
- 'description' => 'Map',
- 'type' => 'object',
- 'example' => '{}',
- ],
+ 'requestId' => ['title' => '', 'description' => 'id of request', 'type' => 'string', 'example' => '2AE63638-5420-56DC-BF59-37D8174039A0'],
+ 'result' => ['title' => '', 'description' => 'Map', 'type' => 'object', 'example' => '{}'],
],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
],
500 => [],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"F6E3D968-529C-5C40-AFDD-133A8B8FD930\\",\\n \\"result\\": {}\\n}","type":"json"}]',
- 'title' => 'ModifyAlias',
- ],
- 'ListAliases' => [
- 'path' => '/openapi/ha3/instances/{instanceId}/aliases',
- 'methods' => [
- 'get',
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"2AE63638-5420-56DC-BF59-37D8174039A0\\",\\n \\"result\\": {}\\n}","type":"json"}]',
+ 'title' => 'ModifyOnlineConfig',
+ 'summary' => 'Modifies online configurations.',
+ 'description' => '### Method'."\n"
+ ."\n"
+ .'```java'."\n"
+ .'put'."\n"
+ .'```'."\n"
+ ."\n"
+ .'### URI'."\n"
+ ."\n"
+ .'```java'."\n"
+ .'/openapi/ha3/instances/{instanceId}/node/{nodeName}/online-configs/{indexName}'."\n"
+ .'```'."\n",
+ 'requestParamsDescription' => '### Sample requests'."\n"
+ ."\n"
+ .''."\n"
+ ."\n"
+ .'```java'."\n"
+ .'PUT /openapi/ha3/instances/ha-test1/node/ihome_searcher/online-configs'."\n"
+ .'```'."\n"
+ ."\n"
+ .''."\n"
+ ."\n"
+ .'```java'."\n"
+ .'{'."\n"
+ .''."\n"
+ .' "content": "xxxx",'."\n"
+ .''."\n"
+ .' "suezAdminName": "xxxx"'."\n"
+ .''."\n"
+ .'}'."\n"
+ .'```'."\n",
+ 'responseParamsDescription' => '### [](#)Sample requests'."\n"
+ ."\n"
+ .'```java'."\n"
+ .'PUT /openapi/ha3/instances/ha-test1/node/ihome_searcher/online-configs'."\n"
+ .'```'."\n"
+ ."\n"
+ .'```java'."\n"
+ .'{'."\n"
+ .' '."\n"
+ .' "content": "xxxx",'."\n"
+ .' '."\n"
+ .' "suezAdminName": "xxxx"'."\n"
+ .' '."\n"
+ .'}'."\n"
+ .'```'."\n"
+ ."\n"
+ .'For more information, see [Response structure](~~465311~~).'."\n",
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ModifyOnlineConfig'],
+ ],
],
- 'schemes' => [
- 'http',
- 'https',
+ 'ramActions' => [
+ [
+ 'operationType' => '',
+ 'ramAction' => [
+ 'action' => 'searchengine:ModifyOnlineConfig',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SearchEngine', 'resourceType' => 'Instance', 'arn' => 'acs:searchengine:{#regionId}:{#accountId}:instance/{#InstanceId}'],
+ ],
+ ],
+ ],
],
+ ],
+ 'ModifyPassword' => [
+ 'summary' => 'Modifies the password of an instance.',
+ 'path' => '/openapi/ha3/instances/{instanceId}/password',
+ 'methods' => ['put'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
- 'operationType' => 'read',
+ 'operationType' => 'write',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'list',
- 'abilityTreeCode' => '223195',
- 'abilityTreeNodes' => [
- 'FEATUREopensearchGTRUN8',
- ],
- ],
+ 'systemTags' => ['operationType' => 'update'],
'parameters' => [
[
'name' => 'instanceId',
'in' => 'path',
+ 'schema' => ['description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'example' => 'ha-cn-pl32rf0****', 'title' => ''],
+ ],
+ [
+ 'name' => 'body',
+ 'in' => 'body',
+ 'style' => 'json',
'schema' => [
- 'description' => 'The instance ID.'."\n",
- 'type' => 'string',
- 'required' => true,
- 'example' => 'ha-cn-pl32rf0****',
+ 'description' => 'The request body for modifying the password.',
+ 'type' => 'object',
+ 'properties' => [
+ 'username' => ['description' => 'The username.', 'type' => 'string', 'required' => false, 'example' => 'testUserName', 'title' => ''],
+ 'password' => ['description' => 'The password.', 'type' => 'string', 'required' => false, 'example' => 'testPassword', 'title' => ''],
+ ],
+ 'required' => false,
+ 'example' => '{}',
+ 'title' => '',
],
],
],
@@ -15989,52 +13626,64 @@
'schema' => [
'type' => 'object',
'properties' => [
- 'requestId' => [
- 'title' => 'id of request',
- 'description' => 'id of request',
- 'type' => 'string',
- 'example' => '10D5E615-69F7-5F49-B850-00169ADE513C',
- ],
- 'result' => [
- 'title' => 'List',
- 'description' => 'List',
- 'type' => 'array',
- 'items' => [
- 'description' => 'The results returned.'."\n",
- 'type' => 'object',
- 'properties' => [
- 'alias' => [
- 'title' => '别名',
- 'description' => 'alias name',
- 'type' => 'string',
- 'example' => 'test',
- ],
- 'index' => [
- 'title' => '关联索引',
- 'description' => 'index name',
- 'type' => 'string',
- 'example' => 'index',
- ],
- ],
- ],
- ],
+ 'requestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '407BFD91-DE7D-50BA-8F88-CDE52A3B5E46'],
+ 'result' => ['title' => '', 'description' => 'The returned result.', 'type' => 'object', 'example' => '{}'],
],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
],
500 => [],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"10D5E615-69F7-5F49-B850-00169ADE513C\\",\\n \\"result\\": [\\n {\\n \\"alias\\": \\"test\\",\\n \\"index\\": \\"index\\"\\n }\\n ]\\n}","type":"json"}]',
- 'title' => 'ListAliases',
- ],
- 'DeleteAlias' => [
- 'path' => '/openapi/ha3/instances/{instanceId}/aliases/{alias}',
- 'methods' => [
- 'delete',
- ],
- 'schemes' => [
- 'http',
- 'https',
+ 'title' => 'Modify instance password',
+ 'description' => '### Method'."\n"
+ ."\n"
+ .'```java'."\n"
+ .'PUT'."\n"
+ .'```'."\n"
+ ."\n"
+ .'### URI'."\n"
+ ."\n"
+ .'```java'."\n"
+ .'/openapi/ha3/instances/{instanceId}/password'."\n"
+ .'```.',
+ 'requestParamsDescription' => '### Request example'."\n"
+ .'`PUT /openapi/ha3/instances/{instanceId}/password`'."\n"
+ ."\n"
+ .'### Request body example'."\n"
+ ."\n"
+ .'```'."\n"
+ .'{'."\n"
+ .' "userName":"my_user_name",'."\n"
+ .' "password":"newPassword" '."\n"
+ .'}'."\n"
+ .'```.',
+ 'responseParamsDescription' => '### Response parameters description'."\n"
+ .'For more information, see [Response structure](~~465311~~).',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'searchengine:ModifyPassword',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SearchEngine', 'resourceType' => 'Instance', 'arn' => 'acs:searchengine:{#regionId}:{#accountId}:instance/{#InstanceId}'],
+ ],
+ ],
+ ],
],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"407BFD91-DE7D-50BA-8F88-CDE52A3B5E46\\",\\n \\"result\\": {}\\n}","type":"json"}]',
+ ],
+ 'ModifyPausePolicy' => [
+ 'path' => '/openapi/ha3/instances/{instanceId}/pause-policies',
+ 'methods' => ['put'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
@@ -16043,31 +13692,39 @@
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
- 'operationType' => 'delete',
- 'abilityTreeCode' => '223196',
- 'abilityTreeNodes' => [
- 'FEATUREopensearchGTRUN8',
- ],
+ 'operationType' => 'update',
+ 'abilityTreeCode' => '178006',
+ 'abilityTreeNodes' => ['FEATUREopensearch0Z9KDD'],
],
'parameters' => [
[
'name' => 'instanceId',
'in' => 'path',
- 'schema' => [
- 'description' => 'The instance ID.'."\n",
- 'type' => 'string',
- 'required' => true,
- 'example' => 'ha-cn-pl32rf0****',
- ],
+ 'schema' => ['description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'ha-cn-pl32rf0****'],
],
[
- 'name' => 'alias',
- 'in' => 'path',
+ 'name' => 'body',
+ 'in' => 'body',
+ 'style' => 'json',
'schema' => [
- 'description' => 'alias',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'test',
+ 'description' => 'The request body.',
+ 'type' => 'object',
+ 'required' => false,
+ 'additionalProperties' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'pauseAll' => ['title' => '', 'description' => 'Pauses all deployments.', 'type' => 'boolean', 'required' => false, 'example' => 'true'],
+ 'pauseIndex' => ['title' => '', 'description' => 'Pauses the deployment of new full index versions.', 'type' => 'boolean', 'required' => false, 'example' => 'true'],
+ 'pauseIndexBatch' => ['title' => '', 'description' => 'Pauses the deployment of incremental batches.', 'type' => 'boolean', 'required' => false, 'example' => 'true'],
+ 'pauseBiz' => ['title' => '', 'description' => 'Pauses configuration deployments.', 'type' => 'boolean', 'required' => false, 'example' => 'true'],
+ 'pauseRuntime' => ['title' => '', 'description' => 'Pauses real-time incremental updates.', 'type' => 'boolean', 'required' => false, 'example' => 'true'],
+ ],
+ 'description' => 'The request body.',
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'title' => '',
+ 'example' => '',
],
],
],
@@ -16076,35 +13733,55 @@
'schema' => [
'type' => 'object',
'properties' => [
- 'requestId' => [
- 'title' => 'id of request',
- 'description' => 'id of request',
- 'type' => 'string',
- 'example' => 'FE03180A-0E29-5474-8A86-33F0683294A4',
- ],
- 'result' => [
- 'title' => 'Map',
- 'description' => 'Map',
- 'type' => 'object',
- 'example' => '{}',
- ],
+ 'requestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '0B1FF998-BB8D-5182-BFC0-E471AA77095A'],
+ 'result' => ['title' => '', 'description' => 'The returned data.', 'type' => 'object', 'example' => '{}'],
],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
],
500 => [],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"FE03180A-0E29-5474-8A86-33F0683294A4\\",\\n \\"result\\": {}\\n}","type":"json"}]',
- 'title' => 'DeleteAlias',
- ],
- 'CreateAlias' => [
- 'path' => '/openapi/ha3/instances/{instanceId}/aliases',
- 'methods' => [
- 'post',
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"0B1FF998-BB8D-5182-BFC0-E471AA77095A\\",\\n \\"result\\": {}\\n}","type":"json"}]',
+ 'title' => 'ModifyPausePolicy',
+ 'summary' => 'Modifies the pause policy.',
+ 'description' => '### Method'."\n"
+ ."\n"
+ .'```java'."\n"
+ .'PUT'."\n"
+ .'```'."\n"
+ ."\n"
+ .'### URI'."\n"
+ ."\n"
+ .'```java'."\n"
+ .'/openapi/ha3/instances/{instanceId}/pause-policies'."\n"
+ .'```',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ModifyPausePolicy'],
+ ],
],
- 'schemes' => [
- 'http',
- 'https',
+ 'ramActions' => [
+ [
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'searchengine:ModifyPausePolicy',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SearchEngine', 'resourceType' => 'Instance', 'arn' => 'acs:searchengine:{#regionId}:{#accountId}:instance/{#InstanceId}'],
+ ],
+ ],
+ ],
],
+ ],
+ 'ModifyPublicUrlIpList' => [
+ 'summary' => 'Modifies the public domain name whitelist.',
+ 'path' => '/openapi/ha3/instances/{instanceId}/public-url-ip-list',
+ 'methods' => ['put'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
@@ -16113,96 +13790,165 @@
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
- 'operationType' => 'create',
- 'abilityTreeCode' => '223193',
- 'abilityTreeNodes' => [
- 'FEATUREopensearchGTRUN8',
- ],
+ 'operationType' => 'update',
+ 'abilityTreeCode' => '171291',
+ 'abilityTreeNodes' => ['FEATUREopensearch0AT3OG', 'FEATUREopensearchJB31XH'],
],
'parameters' => [
[
'name' => 'instanceId',
'in' => 'path',
- 'schema' => [
- 'description' => 'The instance ID.'."\n",
- 'type' => 'string',
- 'required' => true,
- 'example' => 'ha-cn-pl32rf0****',
- ],
+ 'schema' => ['description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'example' => 'ha-cn-pl32rf0****', 'title' => ''],
],
[
- 'name' => 'newMode',
- 'in' => 'query',
+ 'name' => 'body',
+ 'in' => 'body',
+ 'style' => 'json',
'schema' => [
- 'description' => 'Specifies whether the OpenSearch Vector Search Edition instance is of the new version.'."\n",
- 'type' => 'boolean',
+ 'description' => 'The request body. Key: publicUrlAllow.',
+ 'type' => 'object',
'required' => false,
- 'example' => 'true',
- 'default' => 'true',
+ 'additionalProperties' => ['description' => 'The value: whitelist entries, separated by commas.', 'type' => 'string', 'example' => '47.100.XX.XX,140.205.XX.XX', 'title' => ''],
+ 'title' => '',
+ 'example' => '',
],
],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'requestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => 'E45380E8-994A-5402-9806-F114B3295FCF'],
+ 'result' => ['title' => '', 'description' => 'The returned result.', 'type' => 'object', 'example' => '{}'],
+ ],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
+ ],
+ ],
+ 500 => [],
+ ],
+ 'title' => 'Modify public domain name whitelist',
+ 'description' => '### Method'."\n"
+ ."\n"
+ .'```java'."\n"
+ .'PUT'."\n"
+ .'```'."\n"
+ ."\n"
+ .'### URI'."\n"
+ ."\n"
+ .'```java'."\n"
+ .'/openapi/ha3/instances/{instanceId}/public-url-ip-list'."\n"
+ .'```',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ModifyPublicUrlIpList'],
+ ],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'searchengine:ModifyPublicUrlIpList',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SearchEngine', 'resourceType' => 'Instance', 'arn' => 'acs:searchengine:{#regionId}:{#accountId}:instance/{#InstanceId}'],
+ ],
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"E45380E8-994A-5402-9806-F114B3295FCF\\",\\n \\"result\\": {}\\n}","type":"json"}]',
+ ],
+ 'ModifySearcherReplica' => [
+ 'summary' => 'Modifies the number of replicas or shards for data nodes in an instance.',
+ 'description' => '## Request description'."\n"
+ ."\n"
+ .'This API lets you modify the number of replicas or shards for data nodes in a specific instance. When you make a request, provide the instance ID. In the request body, specify the number of replicas (`replica`) or shards (`partition`). These parameters are optional, but you must specify at least one of them to update the instance.',
+ 'path' => '/openapi/ha3/instances/{instanceId}/replica',
+ 'methods' => ['put'],
+ 'schemes' => ['https'],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'consumes' => ['application/json'],
+ 'produces' => ['application/json'],
+ 'operationType' => 'write',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'update',
+ 'riskType' => 'none',
+ 'chargeType' => 'free',
+ 'abilityTreeNodes' => ['FEATUREopensearch5EAGY5'],
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'instanceId',
+ 'in' => 'path',
+ 'schema' => ['title' => '', 'description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'example' => 'ha-cn-test'],
+ ],
[
'name' => 'body',
'in' => 'body',
'style' => 'json',
'schema' => [
- 'description' => 'The request body.'."\n",
+ 'description' => 'The request body.',
'type' => 'object',
'properties' => [
- 'alias' => [
- 'title' => '别名',
- 'description' => 'alias name',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'test',
- ],
- 'index' => [
- 'title' => '关联索引',
- 'description' => 'index name',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'index',
- ],
+ 'replica' => ['title' => '', 'description' => 'The number of replicas for a data node.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '2'],
+ 'partition' => ['title' => '', 'description' => 'The number of shards for a data node.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '2'],
],
'required' => false,
+ 'title' => '',
+ 'example' => '',
],
],
],
'responses' => [
200 => [
+ 'description' => '修改成功',
'schema' => [
+ 'title' => '',
+ 'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
- 'requestId' => [
- 'title' => 'id of request',
- 'description' => 'id of request',
- 'type' => 'string',
- 'example' => '10D5E615-69F7-5F49-B850-00169ADE513C',
- ],
- 'result' => [
- 'title' => 'Map',
- 'description' => 'Map',
- 'type' => 'object',
- 'example' => '{}',
- ],
+ 'requestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => 'e1eef569-1ff7-4bf8-acf7-1cecca9894ce'],
+ 'result' => ['title' => '', 'description' => 'The result of the operation. This object is empty in the current version.', 'type' => 'object', 'example' => ''],
],
+ 'example' => '',
],
],
- 500 => [],
- ],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"10D5E615-69F7-5F49-B850-00169ADE513C\\",\\n \\"result\\": {}\\n}","type":"json"}]',
- 'title' => 'CreateAlias',
- ],
- 'CreateTable' => [
- 'summary' => 'Creates an index table.',
- 'path' => '/openapi/ha3/instances/{instanceId}/tables',
- 'methods' => [
- 'post',
],
- 'schemes' => [
- 'http',
- 'https',
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"e1eef569-1ff7-4bf8-acf7-1cecca9894ce\\",\\n \\"result\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n }\\n}","type":"json"}]',
+ 'title' => 'ModifySearcherReplica',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'searchengine:ModifySearcherReplica',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SearchEngine', 'resourceType' => 'Instance', 'arn' => 'acs:searchengine:{#regionId}:{#accountId}:instance/{#InstanceId}'],
+ ],
+ ],
+ ],
],
+ ],
+ 'ModifyTable' => [
+ 'summary' => 'Modifies an index table.',
+ 'path' => '/openapi/ha3/instances/{instanceId}/tables/{tableName}',
+ 'methods' => ['put'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
@@ -16211,400 +13957,176 @@
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
- 'operationType' => 'create',
+ 'operationType' => 'update',
'riskType' => 'none',
'chargeType' => 'free',
- 'abilityTreeCode' => '218772',
- 'abilityTreeNodes' => [
- 'FEATUREopensearchGTRUN8',
- ],
+ 'abilityTreeCode' => '218773',
+ 'abilityTreeNodes' => ['FEATUREopensearchGTRUN8'],
],
'parameters' => [
[
'name' => 'instanceId',
'in' => 'path',
- 'schema' => [
- 'description' => 'The instance ID.'."\n",
- 'type' => 'string',
- 'required' => true,
- 'example' => 'ha-cn-tl32n3iu801',
- ],
+ 'schema' => ['description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'example' => 'ha-cn-pl32rf0****', 'title' => ''],
+ ],
+ [
+ 'name' => 'tableName',
+ 'in' => 'path',
+ 'schema' => ['description' => 'The name of the index table.', 'type' => 'string', 'required' => true, 'example' => 'index_hdfs', 'title' => ''],
],
[
'name' => 'dryRun',
'in' => 'query',
- 'schema' => [
- 'description' => 'Specifies whether to perform only a dry run, without performing the actual request. The system only checks the validity of the data source. Valid values:'."\n"
- ."\n"
- .'* true'."\n"
- .'* false'."\n",
- 'type' => 'boolean',
- 'required' => false,
- 'example' => 'true',
- 'default' => 'false',
- ],
+ 'schema' => ['description' => 'Specifies whether to perform a dry run (only validates whether the data source is valid). Valid values:'."\n"
+ .'- true: performs a dry run.'."\n"
+ .'- false: does not perform a dry run.', 'type' => 'boolean', 'default' => 'false', 'required' => false, 'example' => 'true', 'title' => ''],
],
[
'name' => 'body',
'in' => 'body',
'style' => 'json',
'schema' => [
- 'description' => 'The request body.'."\n",
+ 'description' => 'The request body parameters.',
'type' => 'object',
'properties' => [
- 'name' => [
- 'title' => '索引名',
- 'description' => 'The index name.'."\n",
- 'type' => 'string',
- 'required' => false,
- 'example' => 'index_1',
- ],
- 'dataProcessorCount' => [
- 'title' => '数据更新资源数',
- 'description' => 'The number of resources used for data update.'."\n",
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'example' => '1',
- ],
- 'partitionCount' => [
- 'title' => '数据分片数',
- 'description' => 'The number of data shards.'."\n",
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'example' => '1',
- ],
+ 'partitionCount' => ['title' => '', 'description' => 'The number of data shards.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1'],
'dataSource' => [
- 'title' => '数据源配置',
- 'description' => 'The configurations of the data source.'."\n",
+ 'title' => '',
+ 'description' => 'The datasource config.',
'type' => 'object',
'properties' => [
- 'type' => [
- 'title' => '数据源类型: 仅支持odps、swift、oss三种类型 (odps, swift, saro, oss, unKnow)',
- 'description' => 'The data source type. Valid values: odps, swift, and oss.'."\n",
- 'type' => 'string',
- 'required' => false,
- 'example' => 'odps',
- ],
- 'dataTimeSec' => [
- 'title' => '追增量时间戳',
- 'description' => 'The start timestamp from which incremental data is retrieved.'."\n",
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'example' => '1715160176',
- ],
- 'autoBuildIndex' => [
- 'title' => '是否自动索引重建',
- 'description' => 'Specifies whether to automatically rebuild the index.'."\n",
- 'type' => 'boolean',
- 'required' => false,
- 'example' => 'true',
- ],
+ 'dataTimeSec' => ['title' => '', 'description' => 'The timestamp for incremental data tracking.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1715160176'],
+ 'autoBuildIndex' => ['title' => '', 'description' => 'Indicates whether auto index rebuilding is enabled.', 'type' => 'boolean', 'required' => false, 'example' => 'true'],
'config' => [
- 'title' => '数据源配置',
- 'description' => 'The configurations of the data source.'."\n",
+ 'title' => '',
+ 'description' => 'The datasource config.',
'type' => 'object',
'properties' => [
- 'endpoint' => [
- 'title' => 'odps相关',
- 'description' => 'The endpoint of the MaxCompute data source.'."\n",
- 'type' => 'string',
- 'required' => false,
- 'example' => 'http://service.cn-hangzhou.maxcompute.aliyun-inc.com/api',
- ],
- 'accessKey' => [
- 'description' => 'The AccessKey ID of the MaxCompute data source.'."\n",
- 'type' => 'string',
- 'required' => false,
- 'example' => 'ak',
- ],
- 'accessSecret' => [
- 'description' => 'The AccessKey secret of the MaxCompute data source.'."\n",
- 'type' => 'string',
- 'required' => false,
- 'example' => 'as',
- ],
- 'project' => [
- 'description' => 'The name of the MaxCompute project that is used as the data source.'."\n",
- 'type' => 'string',
- 'required' => false,
- 'example' => 'project_20210220122847_3218',
- ],
- 'partition' => [
- 'description' => 'The partition in the MaxCompute table. This parameter is required if type is set to odps.'."\n",
- 'type' => 'string',
- 'required' => false,
- 'example' => 'ds=20220713',
- ],
- 'table' => [
- 'title' => 'saro、odps相关',
- 'description' => 'The name of the MaxCompute table that is used as the data source.'."\n",
- 'type' => 'string',
- 'required' => false,
- 'example' => 'test56',
- ],
- 'path' => [
- 'type' => 'string',
- ],
- 'ossPath' => [
- 'title' => 'oss数据源相关',
- 'description' => 'The Object Storage Service (OSS) path.'."\n",
- 'type' => 'string',
- 'required' => false,
- 'example' => 'oss://opensearch',
- ],
- 'bucket' => [
- 'description' => 'The OSS bucket.'."\n",
- 'type' => 'string',
- 'required' => false,
- 'example' => 'antsys-flytest-ci',
- ],
- 'catalog' => [
- 'type' => 'string',
- ],
- 'database' => [
- 'type' => 'string',
- ],
- 'tag' => [
- 'type' => 'string',
- ],
- 'tableFormat' => [
- 'type' => 'string',
- ],
- 'format' => [
- 'title' => '文件格式类型（oss和dlf复用这个字段），默认为ha3类型',
- 'type' => 'string',
- ],
+ 'endpoint' => ['title' => '', 'description' => 'The access endpoint.', 'type' => 'string', 'required' => false, 'example' => 'http://service.cn-hangzhou.maxcompute.aliyun-inc.com/api'],
+ 'accessKey' => ['description' => 'The AccessKey ID of the ODPS data source.', 'type' => 'string', 'required' => false, 'example' => 'L***p', 'title' => ''],
+ 'accessSecret' => ['description' => 'The AccessKey secret of the ODPS data source.', 'type' => 'string', 'required' => false, 'example' => '5**9a6', 'title' => ''],
+ 'project' => ['description' => 'The project name of the ODPS data source.', 'type' => 'string', 'required' => false, 'example' => 'test_project', 'title' => ''],
+ 'partition' => ['description' => 'The partition information.', 'type' => 'string', 'required' => false, 'example' => 'ds=20231220', 'title' => ''],
+ 'table' => ['title' => '', 'description' => 'The table name of the ODPS or DLF data source.', 'type' => 'string', 'required' => false, 'example' => 'behavior'],
+ 'ossPath' => ['title' => '', 'description' => 'The OSS file path.', 'type' => 'string', 'required' => false, 'example' => '/opensearch/test.txt'],
+ 'bucket' => ['description' => 'oss bucket', 'type' => 'string', 'required' => false, 'example' => 'test_bucket', 'title' => ''],
+ 'catalog' => ['description' => 'The catalog name of the DLF data source.', 'type' => 'string', 'required' => false, 'example' => 'test_catalog', 'title' => ''],
+ 'database' => ['description' => 'The database of the DLF data source.', 'type' => 'string', 'required' => false, 'example' => 'opensearch_db', 'title' => ''],
+ 'tag' => ['description' => 'The tag of the DLF data source.', 'type' => 'string', 'required' => false, 'example' => 'test', 'title' => ''],
+ 'tableFormat' => ['description' => 'The table format of the DLF data source.', 'type' => 'string', 'required' => false, 'example' => 'paimon'."\n"
+ .'lance'."\n"
+ .'object', 'title' => ''],
+ 'path' => ['description' => 'The relative path.', 'type' => 'string', 'required' => false, 'example' => '/test', 'title' => ''],
+ 'format' => ['description' => 'The file format type.', 'type' => 'string', 'required' => false, 'example' => 'ha3'."\n"
+ .'json', 'title' => ''],
],
'required' => false,
+ 'example' => '',
],
],
'required' => false,
+ 'example' => '',
],
- 'rawSchema' => [
- 'title' => '如果用户传了rawSchema，则直接使用rawSchema作为ha3 schema结构，不用手动拼装',
- 'description' => 'The instance schema. If this parameter is specified, the parameters about the index are not required.'."\n",
- 'type' => 'string',
- 'required' => false,
- 'example' => '{}',
- ],
- 'primaryKey' => [
- 'title' => '主键字段',
- 'description' => 'The primary key field.'."\n",
- 'type' => 'string',
- 'required' => false,
- 'example' => 'id',
- ],
+ 'rawSchema' => ['title' => '', 'description' => 'If rawSchema is provided, it is used directly as the HA3 schema structure without manual assembly.', 'type' => 'string', 'required' => false, 'example' => '{}'],
+ 'primaryKey' => ['title' => '', 'description' => 'The primary key field.', 'type' => 'string', 'required' => false, 'example' => 'id'],
'fieldSchema' => [
- 'title' => 'key: 字段名',
- 'description' => 'The fields.'."\n",
+ 'title' => '',
+ 'description' => 'The field map collection.',
'type' => 'object',
'required' => false,
- 'additionalProperties' => [
- 'type' => 'string',
- 'example' => "\n"
- .' "id": "INT64",'."\n"
- .' "source_image": "STRING",'."\n"
- .' "namespace": "INT64",'."\n"
- .' "source_image_vector": "MULTI_FLOAT"'."\n"
- .' }',
- 'description' => 'The field. The value is a key-value pair in which the key specifies the field name and value specifies the field type.'."\n",
- ],
+ 'additionalProperties' => ['description' => 'key: field name. value: field type.', 'type' => 'string', 'example' => '{'."\n"
+ .' "id": "INT64",'."\n"
+ .' "source_image": "STRING",'."\n"
+ .' "namespace": "INT64",'."\n"
+ .' "source_image_vector": "MULTI_FLOAT"'."\n"
+ .'}', 'title' => ''],
+ 'example' => '',
],
'vectorIndex' => [
- 'title' => '索引结构',
- 'description' => 'The index schema.'."\n",
+ 'title' => '',
+ 'description' => 'The index structure.',
'type' => 'array',
'items' => [
+ 'description' => 'The details of the index structure.',
'type' => 'object',
'properties' => [
- 'indexName' => [
- 'title' => '索引结构名称',
- 'description' => 'The name of the index schema.'."\n",
- 'type' => 'string',
- 'required' => false,
- 'example' => 'case_index',
- ],
- 'vectorField' => [
- 'title' => '向量字段',
- 'description' => 'The vector field.'."\n",
- 'type' => 'string',
- 'required' => false,
- 'example' => 'source_image_vector',
- ],
- 'sparseIndexField' => [
- 'title' => '稀疏向量下标字段',
- 'description' => 'The field that stores the indexes of the elements in sparse vectors.'."\n",
- 'type' => 'string',
- 'required' => false,
- 'example' => 'sparse_indices',
- ],
- 'sparseValueField' => [
- 'title' => '稀疏向量值字段',
- 'description' => 'The field that stores the elements in sparse vectors.'."\n",
- 'type' => 'string',
- 'required' => false,
- 'example' => 'sparse_values',
- ],
- 'dimension' => [
- 'title' => '向量维度',
- 'description' => 'The dimension of the vector.'."\n",
- 'type' => 'string',
- 'required' => false,
- 'example' => '128',
- ],
- 'vectorIndexType' => [
- 'title' => '向量索引算法',
- 'description' => 'The vector retrieval algorithm.'."\n",
- 'type' => 'string',
- 'required' => false,
- 'example' => 'Qc',
- ],
- 'distanceType' => [
- 'title' => '距离类型',
- 'description' => 'The distance type.'."\n",
- 'type' => 'string',
- 'required' => false,
- 'example' => 'SquaredEuclidean',
- ],
- 'namespace' => [
- 'title' => '命名空间字段',
- 'description' => 'The namespace field.'."\n",
- 'type' => 'string',
- 'required' => false,
- 'example' => 'namespace',
- ],
+ 'indexName' => ['title' => '', 'description' => 'The name of the index structure.', 'type' => 'string', 'required' => false, 'example' => 'test_index'],
+ 'vectorField' => ['title' => '', 'description' => 'The vector field.', 'type' => 'string', 'required' => false, 'example' => 'source_image_vector'],
+ 'sparseIndexField' => ['title' => '', 'description' => 'The sparse vector index field.', 'type' => 'string', 'required' => false, 'example' => 'sparse_indices'],
+ 'sparseValueField' => ['title' => '', 'description' => 'The sparse vector value field.', 'type' => 'string', 'required' => false, 'example' => 'sparse_values'],
+ 'dimension' => ['title' => '', 'description' => 'The vector dimensions.', 'type' => 'string', 'required' => false, 'example' => '128'],
+ 'vectorIndexType' => ['title' => '', 'description' => 'The vector index algorithm.', 'type' => 'string', 'required' => false, 'example' => 'Qc'],
+ 'distanceType' => ['title' => '', 'description' => 'The distance type.', 'type' => 'string', 'required' => false, 'example' => 'SquaredEuclidean'],
+ 'namespace' => ['title' => '', 'description' => 'The namespace field.', 'type' => 'string', 'required' => false, 'example' => 'namespace'],
'advanceParams' => [
- 'title' => '索引结构配置',
- 'description' => 'The configurations of the index schema.'."\n",
+ 'title' => '',
+ 'description' => 'The index structure configuration.',
'type' => 'object',
'properties' => [
- 'buildIndexParams' => [
- 'title' => '索引构建参数',
- 'description' => 'The index building parameters.'."\n",
- 'type' => 'string',
- 'required' => false,
- 'example' => '{}',
- ],
- 'searchIndexParams' => [
- 'title' => '索引检索参数',
- 'description' => 'The index retrieval parameters.'."\n",
- 'type' => 'string',
- 'required' => false,
- 'example' => '{}',
- ],
- 'minScanDocCnt' => [
- 'title' => '召回候选集的个数最小值',
- 'description' => 'The minimum number of retrieved candidate sets.'."\n",
- 'type' => 'string',
- 'required' => false,
- 'example' => '20000',
- ],
- 'linearBuildThreshold' => [
- 'title' => '线性构建的阈值',
- 'description' => 'The threshold for linear building.'."\n",
- 'type' => 'string',
- 'required' => false,
- 'example' => '5000',
- ],
+ 'buildIndexParams' => ['title' => '', 'description' => 'The index building parameters.', 'type' => 'string', 'required' => false, 'example' => '{}'],
+ 'searchIndexParams' => ['title' => '', 'description' => 'The index search parameters.', 'type' => 'string', 'required' => false, 'example' => '{}'],
+ 'minScanDocCnt' => ['title' => '', 'description' => 'The minimum number of candidate documents for recall.', 'type' => 'string', 'required' => false, 'example' => '20000'],
+ 'linearBuildThreshold' => ['title' => '', 'description' => 'The threshold for linear building.', 'type' => 'string', 'required' => false, 'example' => '5000'],
],
'required' => false,
+ 'example' => '',
],
],
'required' => false,
+ 'title' => '',
+ 'example' => '',
],
'required' => false,
+ 'example' => '',
],
'dataProcessConfig' => [
- 'title' => '字段处理配置',
- 'description' => 'The configurations about field processing.'."\n",
+ 'title' => '',
+ 'description' => 'The field processing configuration.',
'type' => 'array',
'items' => [
- 'description' => '',
+ 'description' => 'The details of the field processing configuration.',
'type' => 'object',
'properties' => [
- 'operator' => [
- 'title' => '字段处理方式 (copy: 将源字段拷贝至目标字段, vectorize: 使用模型对源字段进行向量化，向量存储在目标字段中)',
- 'description' => 'The method used to process the field. Valid values: copy and vectorize. A value of copy specifies that the value of the source field is copied to the destination field. A value of vectorize specifies that the value of the source field is vectorized by a vectorization model and the output vector is stored in the destination field.'."\n",
- 'type' => 'string',
- 'required' => false,
- 'example' => 'vectorize',
- ],
- 'dstField' => [
- 'title' => '目标字段',
- 'description' => 'The destination field.'."\n",
- 'type' => 'string',
- 'required' => false,
- 'example' => 'source_image_vector',
- ],
- 'srcField' => [
- 'title' => '源字段',
- 'description' => 'The source field.'."\n",
- 'type' => 'string',
- 'required' => false,
- 'example' => 'source_image',
- ],
+ 'operator' => ['title' => '', 'description' => 'The field processing method. Valid values:'."\n"
+ .'- copy: copies the source field to the destination field.'."\n"
+ .'- vectorize: vectorizes the source field by using a model and stores the vector in the destination field.', 'type' => 'string', 'required' => false, 'example' => 'vectorize'],
+ 'dstField' => ['title' => '', 'description' => 'The destination field.', 'type' => 'string', 'required' => false, 'example' => 'source_image_vector'],
+ 'srcField' => ['title' => '', 'description' => 'The source field.', 'type' => 'string', 'required' => false, 'example' => 'source_image'],
'params' => [
- 'title' => '配置模型信息',
- 'description' => 'The information about the model.'."\n",
+ 'title' => '',
+ 'description' => 'The model configuration information.',
'type' => 'object',
'properties' => [
- 'vectorModel' => [
- 'title' => '向量化模型',
- 'description' => 'The vectorization model.'."\n",
- 'type' => 'string',
- 'required' => false,
- 'example' => 'clip',
- ],
- 'vectorModal' => [
- 'title' => '数据类型',
- 'description' => 'The data type.'."\n",
- 'type' => 'string',
- 'required' => false,
- 'example' => 'image',
- ],
+ 'vectorModel' => ['title' => '', 'description' => 'The vectorization model.', 'type' => 'string', 'required' => false, 'example' => 'clip'],
+ 'vectorModal' => ['title' => '', 'description' => 'The data type.', 'type' => 'string', 'required' => false, 'example' => 'image'],
'srcFieldConfig' => [
- 'title' => '向量化信息来源',
- 'description' => 'The source of the data to be vectorized.'."\n",
+ 'title' => '',
+ 'description' => 'The vectorization information source.',
'type' => 'object',
'properties' => [
- 'ossEndpoint' => [
- 'description' => 'The OSS endpoint.'."\n",
- 'type' => 'string',
- 'required' => false,
- 'example' => 'oss-cn-hangzhou-internal.aliyuncs.com',
- ],
- 'ossBucket' => [
- 'description' => 'The OSS bucket.'."\n",
- 'type' => 'string',
- 'required' => false,
- 'example' => 'test',
- ],
- 'uid' => [
- 'description' => 'The ID of the Alibaba Cloud account.'."\n",
- 'type' => 'string',
- 'required' => false,
- 'example' => 'uid',
- ],
+ 'ossEndpoint' => ['description' => 'The OSS region endpoint.', 'type' => 'string', 'required' => false, 'example' => 'oss-cn-hangzhou-internal.aliyuncs.com'."\n", 'title' => ''],
+ 'ossBucket' => ['description' => 'The OSS bucket name.', 'type' => 'string', 'required' => false, 'example' => 'test-bucket', 'title' => ''],
+ 'uid' => ['description' => 'The Alibaba Cloud account ID.', 'type' => 'string', 'required' => false, 'example' => '1062017779051424', 'title' => ''],
],
'required' => false,
+ 'example' => '',
],
],
'required' => false,
+ 'example' => '',
],
],
'required' => false,
+ 'title' => '',
+ 'example' => '',
],
'required' => false,
- ],
- 'scene' => [
- 'title' => '场景模版',
- 'type' => 'string',
+ 'example' => '',
],
],
'required' => false,
+ 'title' => '',
+ 'example' => '',
],
],
],
@@ -16613,36 +14135,40 @@
'schema' => [
'type' => 'object',
'properties' => [
- 'requestId' => [
- 'title' => 'id of request',
- 'description' => 'id of request',
- 'type' => 'string',
- 'example' => '2AE63638-5420-56DC-BF59-37D8174039A0',
- ],
- 'result' => [
- 'title' => 'Map',
- 'description' => 'Map',
- 'type' => 'object',
- 'example' => '{}',
- ],
+ 'requestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => 'FE03180A-0E29-5474-8A86-33F0683294A4'],
+ 'result' => ['title' => '', 'description' => 'The returned result.', 'type' => 'object', 'example' => '{}'],
],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
],
500 => [],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"2AE63638-5420-56DC-BF59-37D8174039A0\\",\\n \\"result\\": {}\\n}","type":"json"}]',
- 'title' => 'CreateTable',
- 'requestParamsDescription' => '### [](#)Sample requests'."\n"
+ 'title' => 'Modify an index table',
+ 'description' => '### Method'."\n"
."\n"
.'```java'."\n"
- .'POST /openapi/ha3/instances/{instanceId}/tables'."\n"
+ .'PUT'."\n"
.'```'."\n"
."\n"
- .'> In this sample code, only some request parameters are used. For more information about custom parameters, see the "Request parameters" section of this topic.'."\n"
+ .'### URI'."\n"
+ ."\n"
+ .'```java'."\n"
+ .'/openapi/ha3/instances/{instanceId}/tables/{tableName}'."\n"
+ .'```',
+ 'requestParamsDescription' => '### Request example'."\n"
+ ."\n"
+ .''."\n"
+ ."\n"
+ .'```java'."\n"
+ .'PUT /openapi/ha3/instances/{instanceId}/tables/{tableName}'."\n"
+ .'```'."\n"
+ ."\n"
+ .'><notice>This example lists only the simplest parameters. For more custom parameters, see the request parameters.></notice>'."\n"
."\n"
.'```java'."\n"
.'{'."\n"
- .' "name": "api",'."\n"
.' "partitionCount": 1,'."\n"
.' "primaryKey": "id",'."\n"
.' "fieldSchema": {'."\n"
@@ -16662,405 +14188,124 @@
.' ]'."\n"
.'}'."\n"
.'```'."\n"
- ."\n"
- .'For more information, see [Response structure](~~465311~~).'."\n",
- ],
- 'ModifyTable' => [
- 'summary' => 'Modifies an index table.',
- 'path' => '/openapi/ha3/instances/{instanceId}/tables/{tableName}',
- 'methods' => [
- 'put',
- ],
- 'schemes' => [
- 'http',
- 'https',
+ .'For more information, see [Response struct](~~465311~~).',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'searchengine:ModifyTable',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SearchEngine', 'resourceType' => 'Instance', 'arn' => 'acs:searchengine:{#regionId}:{#accountId}:instance/{#InstanceId}'],
+ ],
+ ],
+ ],
],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"FE03180A-0E29-5474-8A86-33F0683294A4\\",\\n \\"result\\": {}\\n}","type":"json"}]',
+ 'translator' => 'machine',
+ ],
+ 'PublishAdvanceConfig' => [
+ 'path' => '/openapi/ha3/instances/{instanceId}/advanced-configs/{configName}/actions/publish',
+ 'methods' => ['post'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
- 'operationType' => 'write',
+ 'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'update',
- 'riskType' => 'none',
- 'chargeType' => 'free',
- 'abilityTreeCode' => '218773',
- 'abilityTreeNodes' => [
- 'FEATUREopensearchGTRUN8',
- ],
+ 'abilityTreeCode' => '104708',
+ 'abilityTreeNodes' => ['FEATUREopensearchA6GC80'],
],
'parameters' => [
[
'name' => 'instanceId',
'in' => 'path',
- 'schema' => [
- 'description' => 'The instance ID.'."\n",
- 'type' => 'string',
- 'required' => true,
- 'example' => 'ha-cn-tl32n3iu801',
- ],
+ 'schema' => ['description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'example' => 'ha-cn-pl32rf0****', 'title' => ''],
],
[
- 'name' => 'tableName',
+ 'name' => 'configName',
'in' => 'path',
- 'schema' => [
- 'description' => 'The name of the table.'."\n",
- 'type' => 'string',
- 'required' => true,
- 'example' => 'index_hdfs',
- ],
- ],
- [
- 'name' => 'dryRun',
- 'in' => 'query',
- 'schema' => [
- 'description' => 'Specifies whether to perform only a dry run, without performing the actual request. The system only checks the validity of the data source. Valid values:'."\n"
- ."\n"
- .'* true'."\n"
- .'* false'."\n",
- 'type' => 'boolean',
- 'required' => false,
- 'example' => 'true',
- 'default' => 'false',
- ],
+ 'schema' => ['description' => 'The configuration name.', 'type' => 'string', 'required' => true, 'example' => 'ha-cn-pl32rf0****_online_config_v3', 'title' => ''],
],
[
'name' => 'body',
'in' => 'body',
'style' => 'json',
'schema' => [
- 'description' => 'The request body.'."\n",
+ 'description' => 'The request struct.',
'type' => 'object',
'properties' => [
- 'partitionCount' => [
- 'title' => '数据分片数',
- 'description' => 'The number of data shards.'."\n",
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'example' => '1',
- ],
- 'dataSource' => [
- 'title' => '数据源配置',
- 'description' => 'The configurations of the data source.'."\n",
- 'type' => 'object',
- 'properties' => [
- 'dataTimeSec' => [
- 'title' => '追增量时间戳',
- 'description' => 'The start timestamp from which incremental data is retrieved.'."\n",
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'example' => '1715160176',
- ],
- 'autoBuildIndex' => [
- 'title' => '是否自动索引重建',
- 'description' => 'Specifies whether to automatically rebuild the index.'."\n",
- 'type' => 'boolean',
- 'required' => false,
- 'example' => 'true',
- ],
- 'config' => [
- 'title' => '数据源配置',
- 'description' => 'The configurations of the data source.'."\n",
- 'type' => 'object',
- 'properties' => [
- 'endpoint' => [
- 'title' => 'odps相关',
- 'description' => 'The endpoint of the MaxCompute data source.'."\n",
- 'type' => 'string',
- 'required' => false,
- 'example' => 'http://service.cn-hangzhou.maxcompute.aliyun-inc.com/api',
- ],
- 'accessKey' => [
- 'description' => 'The AccessKey ID of the MaxCompute data source.'."\n",
- 'type' => 'string',
- 'required' => false,
- 'example' => 'AK',
- ],
- 'accessSecret' => [
- 'description' => 'The AccessKey secret of the MaxCompute data source.'."\n",
- 'type' => 'string',
- 'required' => false,
- 'example' => 'AS',
- ],
- 'project' => [
- 'description' => 'The name of the MaxCompute project that is used as the data source.'."\n",
- 'type' => 'string',
- 'required' => false,
- 'example' => 'yw_dw_rpt',
- ],
- 'partition' => [
- 'description' => 'The partition in the MaxCompute table.'."\n",
- 'type' => 'string',
- 'required' => false,
- 'example' => 'ds=20231220',
- ],
- 'table' => [
- 'title' => 'saro、odps相关',
- 'description' => 'The name of the MaxCompute table that is used as the data source.'."\n",
- 'type' => 'string',
- 'required' => false,
- 'example' => 'behavior',
- ],
- 'ossPath' => [
- 'title' => 'oss数据源相关',
- 'description' => 'The path of the Object Storage Service (OSS) object.'."\n",
- 'type' => 'string',
- 'required' => false,
- 'example' => 'oss://opensearch',
- ],
- 'bucket' => [
- 'description' => 'The name of the OSS bucket.'."\n",
- 'type' => 'string',
- 'required' => false,
- 'example' => 'antsys-shujiang-osstest',
- ],
- 'catalog' => [
- 'type' => 'string',
- ],
- 'database' => [
- 'type' => 'string',
- ],
- 'tag' => [
- 'type' => 'string',
- ],
- 'tableFormat' => [
- 'type' => 'string',
- ],
- 'path' => [
- 'type' => 'string',
- ],
- 'format' => [
- 'type' => 'string',
- ],
- ],
- 'required' => false,
- ],
- ],
- 'required' => false,
- ],
- 'rawSchema' => [
- 'title' => '如果用户传了rawSchema，则直接使用rawSchema作为ha3 schema结构，不用手动拼装',
- 'description' => 'The instance schema. If this parameter is specified, the parameters about the index are not required.'."\n",
- 'type' => 'string',
- 'required' => false,
- 'example' => '{}',
- ],
- 'primaryKey' => [
- 'title' => '主键字段',
- 'description' => 'The primary key field.'."\n",
- 'type' => 'string',
- 'required' => false,
- 'example' => 'id',
- ],
- 'fieldSchema' => [
- 'title' => 'key: 字段名',
- 'description' => 'The fields.'."\n",
- 'type' => 'object',
- 'required' => false,
- 'additionalProperties' => [
- 'type' => 'string',
- 'description' => 'The field. The value is a key-value pair in which the key represents the field name and value represents the field type.'."\n",
- 'example' => '{'."\n"
- .' "id": "INT64",'."\n"
- .' "source_image": "STRING",'."\n"
- .' "namespace": "INT64",'."\n"
- .' "source_image_vector": "MULTI_FLOAT"'."\n"
- .' }',
- ],
- ],
- 'vectorIndex' => [
- 'title' => '索引结构',
- 'description' => 'The index schema.'."\n",
- 'type' => 'array',
- 'items' => [
- 'description' => '',
- 'type' => 'object',
- 'properties' => [
- 'indexName' => [
- 'title' => '索引结构名称',
- 'description' => 'The name of the index schema.'."\n",
- 'type' => 'string',
- 'required' => false,
- 'example' => 'test_api',
- ],
- 'vectorField' => [
- 'title' => '向量字段',
- 'description' => 'The vector field.'."\n",
- 'type' => 'string',
- 'required' => false,
- 'example' => 'source_image_vector',
- ],
- 'sparseIndexField' => [
- 'title' => '稀疏向量下标字段',
- 'description' => 'The field that stores the indexes of the elements in sparse vectors.'."\n",
- 'type' => 'string',
- 'required' => false,
- 'example' => 'sparse_indices',
- ],
- 'sparseValueField' => [
- 'title' => '稀疏向量值字段',
- 'description' => 'The field that stores the elements in sparse vectors.'."\n",
- 'type' => 'string',
- 'required' => false,
- 'example' => 'sparse_values',
- ],
- 'dimension' => [
- 'title' => '向量维度',
- 'description' => 'The dimension of the vector.'."\n",
- 'type' => 'string',
- 'required' => false,
- 'example' => '128',
- ],
- 'vectorIndexType' => [
- 'title' => '向量索引算法',
- 'description' => 'The vector retrieval algorithm.'."\n",
- 'type' => 'string',
- 'required' => false,
- 'example' => 'Qc',
- ],
- 'distanceType' => [
- 'title' => '距离类型',
- 'description' => 'The distance type.'."\n",
- 'type' => 'string',
- 'required' => false,
- 'example' => 'SquaredEuclidean',
- ],
- 'namespace' => [
- 'title' => '命名空间字段',
- 'description' => 'The namespace field.'."\n",
- 'type' => 'string',
- 'required' => false,
- 'example' => 'namespace',
- ],
- 'advanceParams' => [
- 'title' => '索引结构配置',
- 'description' => 'The configurations of the index schema.'."\n",
- 'type' => 'object',
- 'properties' => [
- 'buildIndexParams' => [
- 'title' => '索引构建参数',
- 'description' => 'The index building parameters.'."\n",
- 'type' => 'string',
- 'required' => false,
- 'example' => '{}',
- ],
- 'searchIndexParams' => [
- 'title' => '索引检索参数',
- 'description' => 'The index retrieval parameters.'."\n",
- 'type' => 'string',
- 'required' => false,
- 'example' => '{}',
- ],
- 'minScanDocCnt' => [
- 'title' => '召回候选集的个数最小值',
- 'description' => 'The minimum number of retrieved candidate sets.'."\n",
- 'type' => 'string',
- 'required' => false,
- 'example' => '20000',
- ],
- 'linearBuildThreshold' => [
- 'title' => '线性构建的阈值',
- 'description' => 'The threshold for linear building.'."\n",
- 'type' => 'string',
- 'required' => false,
- 'example' => '5000',
- ],
- ],
- 'required' => false,
- ],
- ],
- 'required' => false,
- ],
- 'required' => false,
- ],
- 'dataProcessConfig' => [
- 'title' => '字段处理配置',
- 'description' => 'The configurations about field processing.'."\n",
+ 'desc' => ['description' => 'The description of the advanced configuration.', 'type' => 'string', 'required' => false, 'example' => 'Custom configuration', 'title' => ''],
+ 'files' => [
+ 'description' => 'The file information.',
'type' => 'array',
'items' => [
- 'description' => '',
+ 'description' => 'The file information.',
'type' => 'object',
'properties' => [
- 'operator' => [
- 'title' => '字段处理方式 (copy: 将源字段拷贝至目标字段, vectorize: 使用模型对源字段进行向量化，向量存储在目标字段中)',
- 'description' => 'The method used to process the field. Valid values: copy and vectorize. A value of copy specifies that the value of the source field is copied to the destination field. A value of vectorize specifies that the value of the source field is vectorized by a vectorization model and the output vector is stored in the destination field.'."\n",
- 'type' => 'string',
- 'required' => false,
- 'example' => 'vectorize',
- ],
- 'dstField' => [
- 'title' => '目标字段',
- 'description' => 'The destination field.'."\n",
- 'type' => 'string',
- 'required' => false,
- 'example' => 'source_image_vector',
- ],
- 'srcField' => [
- 'title' => '源字段',
- 'description' => 'The source field.'."\n",
- 'type' => 'string',
- 'required' => false,
- 'example' => 'source_image',
- ],
- 'params' => [
- 'title' => '配置模型信息',
- 'description' => 'The information about the model.'."\n",
+ 'ossPath' => ['description' => 'The OSS file path.', 'type' => 'string', 'required' => false, 'example' => 'oss://opensearch/test.json', 'title' => ''],
+ 'operateType' => ['description' => 'The operation type. Valid values:'."\n"
+ ."\n"
+ .'- UPDATE: updates the file.'."\n"
+ .'- DELETE: deletes the file.'."\n"
+ ."\n"
+ .'Default value: UPDATE.', 'type' => 'string', 'required' => false, 'example' => 'UPDATE', 'title' => ''],
+ 'parentFullPath' => ['description' => 'The parent file path.', 'type' => 'string', 'required' => false, 'example' => '/', 'title' => ''],
+ 'fileName' => ['description' => 'The file name.', 'type' => 'string', 'required' => false, 'example' => 'vector_question_schema.json', 'title' => ''],
+ 'dirName' => ['description' => 'The folder name.', 'type' => 'string', 'required' => false, 'example' => '/clusters', 'title' => ''],
+ 'config' => [
+ 'description' => 'The advanced configuration information.',
'type' => 'object',
'properties' => [
- 'vectorModel' => [
- 'title' => '向量化模型',
- 'description' => 'The vectorization model.'."\n",
- 'type' => 'string',
- 'required' => false,
- 'example' => 'clip',
- ],
- 'vectorModal' => [
- 'title' => '数据类型',
- 'description' => 'The data type.'."\n",
- 'type' => 'string',
- 'required' => false,
- 'example' => 'image',
- ],
- 'srcFieldConfig' => [
- 'title' => '向量化信息来源',
- 'description' => 'The source of the data to be vectorized.'."\n",
+ 'content' => ['description' => 'The file content.', 'type' => 'string', 'required' => false, 'example' => "\n"
+ .'{\\"url\\":\\"http://xxxxxx.aliyuncs.com/outnet_hz/packages/xxxxx/opensearch_offline_plugins_xxxxx.tar\\"}', 'title' => ''],
+ 'variables' => [
+ 'description' => 'The variable list.',
'type' => 'object',
- 'properties' => [
- 'ossEndpoint' => [
- 'description' => 'The OSS endpoint.'."\n",
- 'type' => 'string',
- 'required' => false,
- 'example' => 'oss-cn-hangzhou-internal.aliyuncs.com'."\n",
- ],
- 'ossBucket' => [
- 'description' => 'The name of the OSS bucket.'."\n",
- 'type' => 'string',
- 'required' => false,
- 'example' => 'test',
- ],
- 'uid' => [
- 'description' => 'The ID of the Alibaba Cloud account.'."\n",
- 'type' => 'string',
- 'required' => false,
- 'example' => 'uid',
+ 'required' => false,
+ 'additionalProperties' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'description' => ['description' => '变量描述', 'type' => 'string', 'required' => false, 'example' => '自定义变量', 'title' => ''],
+ 'disableModify' => ['description' => '是否可被用户修改', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'title' => ''],
+ 'isModify' => ['description' => '变量是否被修改过', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'title' => ''],
+ 'type' => ['description' => '类型：普通变量-NORMAL； function变量-FUNCTION', 'type' => 'string', 'required' => false, 'example' => 'NORMAL', 'title' => ''],
+ 'value' => ['description' => '变量值', 'type' => 'string', 'required' => false, 'example' => 'test', 'title' => ''],
],
+ 'description' => '变量',
+ 'title' => '',
+ 'example' => '',
],
- 'required' => false,
+ 'title' => '',
+ 'example' => '',
],
],
'required' => false,
+ 'title' => '',
+ 'example' => '',
],
],
'required' => false,
+ 'title' => '',
+ 'example' => '',
],
'required' => false,
+ 'title' => '',
+ 'example' => '',
],
],
'required' => false,
+ 'example' => '{\\"desc\\":\\"new version\\"}',
+ 'title' => '',
],
],
],
@@ -17069,67 +14314,72 @@
'schema' => [
'type' => 'object',
'properties' => [
- 'requestId' => [
- 'title' => 'id of request',
- 'description' => 'id of request',
- 'type' => 'string',
- 'example' => 'FE03180A-0E29-5474-8A86-33F0683294A4',
- ],
- 'result' => [
- 'title' => 'Map',
- 'description' => 'Map',
- 'type' => 'object',
- 'example' => '{}',
- ],
+ 'requestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '10D5E615-69F7-5F49-B850-00169ADE513C'],
+ 'result' => ['title' => '', 'description' => 'The returned result.', 'type' => 'object', 'example' => '{}'],
],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
],
500 => [],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"FE03180A-0E29-5474-8A86-33F0683294A4\\",\\n \\"result\\": {}\\n}","type":"json"}]',
- 'title' => 'ModifyTable',
- 'requestParamsDescription' => '### [](#)Sample requests'."\n"
+ 'title' => 'Publish an advanced version',
+ 'summary' => 'Publishes an advanced version.',
+ 'description' => '### Method'."\n"
."\n"
.'```java'."\n"
- .'PUT /openapi/ha3/instances/{instanceId}/tables/{tableName}'."\n"
+ .'POST'."\n"
.'```'."\n"
."\n"
- .'> In this sample code, only some request parameters are used. For more information about custom parameters, see the "Request parameters" section of this topic.'."\n"
+ .'### URI'."\n"
."\n"
.'```java'."\n"
+ .'/openapi/ha3/instances/{instanceId}/advanced-configs/{configName}/actions/publish'."\n"
+ .'```.',
+ 'requestParamsDescription' => '## Request example'."\n"
+ .'```'."\n"
+ .'POST /openapi/ha3/instances/ose-test1/advanced-configs/test/actions/publish'."\n"
+ ."\n"
.'{'."\n"
- .' "partitionCount": 1,'."\n"
- .' "primaryKey": "id",'."\n"
- .' "fieldSchema": {'."\n"
- .' "id": "INT64",'."\n"
- .' "source_image": "STRING",'."\n"
- .' "namespace": "STRING",'."\n"
- .' "source_image_vector": "MULTI_FLOAT"'."\n"
- .' },'."\n"
- .' "vectorIndex": ['."\n"
- .' {'."\n"
- .' "indexName": "test_index_1",'."\n"
- .' "vectorField": "source_image_vector",'."\n"
- .' "vectorIndexType": "HNSW",'."\n"
- .' "dimension": "512",'."\n"
- .' "distanceType": "InnerProduct"'."\n"
- .' }'."\n"
- .' ]'."\n"
+ .' "desc": "new version"'."\n"
+ .'}'."\n"
+ .'```.',
+ 'responseParamsDescription' => '## Response example'."\n"
+ .'### Success response'."\n"
+ .'```json'."\n"
+ .'{'."\n"
+ .' "requestId": "65911539-5a8b-4bce-96a5-4d608900dc46",'."\n"
+ .' "result": {}'."\n"
.'}'."\n"
.'```'."\n"
- ."\n"
- .'For more information, see [Response structure](~~465311~~).'."\n",
- ],
- 'GetTable' => [
- 'summary' => 'Queries the information about an index table.',
- 'path' => '/openapi/ha3/instances/{instanceId}/tables/{tableName}',
- 'methods' => [
- 'get',
- ],
- 'schemes' => [
- 'http',
- 'https',
+ .'For more information, see [Response struct](~~465311~~).',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'PublishAdvanceConfig'],
+ ],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'searchengine:PublishAdvanceConfig',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SearchEngine', 'resourceType' => 'Instance', 'arn' => 'acs:searchengine:{#regionId}:{#accountId}:instance/{#InstanceId}'],
+ ],
+ ],
+ ],
],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"10D5E615-69F7-5F49-B850-00169ADE513C\\",\\n \\"result\\": {}\\n}","type":"json"}]',
+ ],
+ 'PublishIndexVersion' => [
+ 'summary' => 'Publishes a specified index version.',
+ 'path' => '/openapi/ha3/instances/{instanceId}/indexes/{indexName}/actions/publish',
+ 'methods' => ['post'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
@@ -17137,478 +14387,206 @@
],
'operationType' => 'read',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'get',
- 'abilityTreeCode' => '218774',
- 'abilityTreeNodes' => [
- 'FEATUREopensearchGTRUN8',
- ],
- ],
+ 'systemTags' => [],
'parameters' => [
[
'name' => 'instanceId',
'in' => 'path',
- 'schema' => [
- 'description' => 'The instance ID.'."\n",
- 'type' => 'string',
- 'required' => true,
- 'example' => 'ha-cn-0ju2k3qer02',
- ],
+ 'schema' => ['description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'example' => 'ha-cn-pl32rf0****', 'title' => ''],
],
[
- 'name' => 'tableName',
+ 'name' => 'indexName',
'in' => 'path',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'test_summary',
- ],
+ 'schema' => ['description' => 'The index name.', 'type' => 'string', 'required' => true, 'example' => 'test_api', 'title' => ''],
+ ],
+ [
+ 'name' => 'body',
+ 'in' => 'body',
+ 'style' => 'json',
+ 'schema' => ['description' => 'The request body.', 'type' => 'object', 'example' => '{'."\n"
+ .'"dataSource": "ha-cn-pl32rf0****_test_api",'."\n"
+ .'"desc": "Remarks"'."\n"
+ .'}', 'required' => false, 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
+ 'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
- 'requestId' => [
- 'title' => 'id of request',
- 'description' => 'requestId',
- 'type' => 'string',
- 'example' => '2AE63638-5420-56DC-BF59-37D8174039A0',
- ],
- 'result' => [
- 'title' => 'IndexConfigV2',
- 'description' => 'The results returned.'."\n",
- 'type' => 'object',
- 'properties' => [
- 'name' => [
- 'title' => '索引名',
- 'description' => '',
- 'type' => 'string',
- 'example' => 'test_oss',
- ],
- 'status' => [
- 'title' => '索引表状态 (NEW, PUBLISH, IN_USE: 召回引擎版创建成功后为正常状态, NOT_USE, STOP_USE, RESTORE_USE, FAIL: 向量检索版新版本首次创建索引失败状态)',
- 'description' => 'The state of the index table. Valid values: NEW, PUBLISH, IN_USE, NOT_USE, STOP_USE, RESTORE_USE, and FAIL. After an index is created in an OpenSearch Retrieval Engine Edition instance, the index enters the IN_USE state. If the first full index fails to be created in an OpenSearch Vector Search Edition instance of the new version, the index is in the FAIL state.'."\n",
- 'type' => 'string',
- 'example' => 'IN_USE',
- ],
- 'dataProcessorCount' => [
- 'title' => '数据更新资源数',
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '1',
- ],
- 'partitionCount' => [
- 'title' => '数据分片数',
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '1',
- ],
- 'dataSource' => [
- 'title' => '数据源配置',
- 'description' => '',
- 'type' => 'object',
- 'properties' => [
- 'type' => [
- 'title' => '数据源类型: 仅支持odps、swift、oss三种类型 (odps, swift, saro, oss, unKnow)',
- 'description' => '',
- 'type' => 'string',
- 'example' => 'odps',
- ],
- 'dataTimeSec' => [
- 'title' => '追增量时间戳',
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '1715160176',
- ],
- 'autoBuildIndex' => [
- 'title' => '是否自动索引重建',
- 'description' => '',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
- 'config' => [
- 'title' => '数据源配置',
- 'description' => '',
- 'type' => 'object',
- 'properties' => [
- 'endpoint' => [
- 'title' => 'odps相关',
- 'description' => '',
- 'type' => 'string',
- 'example' => 'http://service.cn-hangzhou.maxcompute.aliyun-inc.com/api',
- ],
- 'accessKey' => [
- 'description' => 'AK',
- 'type' => 'string',
- 'example' => 'ak',
- ],
- 'accessSecret' => [
- 'description' => 'AS',
- 'type' => 'string',
- 'example' => 'as',
- ],
- 'project' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'dp_pdm_marketing_prod',
- ],
- 'partition' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'ds=20220808',
- ],
- 'table' => [
- 'title' => 'saro、odps相关',
- 'description' => '',
- 'type' => 'string',
- 'example' => 'test_add',
- ],
- 'namespace' => [
- 'title' => 'saro相关',
- 'description' => '',
- 'type' => 'string',
- 'example' => 'namespace',
- ],
- 'path' => [
- 'title' => 'hdfs相关',
- 'description' => '',
- 'type' => 'string',
- 'example' => 'vendor/sebastian/comparator/src/exceptions',
- ],
- 'ossPath' => [
- 'title' => 'oss数据源相关',
- 'description' => '',
- 'type' => 'string',
- 'example' => '/opensearch_index_data/sift_oss_test.data',
- ],
- 'bucket' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'heytea-ops-oss',
- ],
- ],
- ],
- ],
- ],
- 'rawSchema' => [
- 'title' => '如果用户传了rawSchema，则直接使用rawSchema作为ha3 schema结构，不用手动拼装',
- 'description' => '',
- 'type' => 'string',
- 'example' => '{}',
- ],
- 'primaryKey' => [
- 'title' => '主键字段',
- 'description' => '',
- 'type' => 'string',
- 'example' => 'id',
- ],
- 'fieldSchema' => [
- 'title' => 'key: 字段名',
- 'description' => 'The field. The value is a key-value pair in which the key indicates the field name and value indicates the field type.'."\n",
- 'type' => 'object',
- 'additionalProperties' => [
- 'type' => 'string',
- 'description' => 'id'."\n",
- 'example' => '{'."\n"
- .' "id": "INT64",'."\n"
- .' "source_image": "STRING",'."\n"
- .' "namespace": "INT64",'."\n"
- .' "source_image_vector": "MULTI_FLOAT"'."\n"
- .' }'."\n",
- ],
- ],
- 'vectorIndex' => [
- 'title' => '索引结构',
- 'description' => 'The index schema.'."\n",
- 'type' => 'array',
- 'items' => [
- 'type' => 'object',
- 'properties' => [
- 'indexName' => [
- 'title' => '索引结构名称',
- 'description' => 'The name of the index schema.'."\n",
- 'type' => 'string',
- 'example' => 'test_odps',
- ],
- 'vectorField' => [
- 'title' => '向量字段',
- 'description' => 'The vector field.'."\n",
- 'type' => 'string',
- 'example' => 'source_image_vector',
- ],
- 'sparseIndexField' => [
- 'title' => '稀疏向量下标字段',
- 'description' => 'The field that stores the indexes of the elements in sparse vectors.'."\n",
- 'type' => 'string',
- 'example' => 'sparse_indices',
- ],
- 'sparseValueField' => [
- 'title' => '稀疏向量值字段',
- 'description' => 'The field that stores the elements in sparse vectors.'."\n",
- 'type' => 'string',
- 'example' => 'sparse_values',
- ],
- 'dimension' => [
- 'title' => '向量维度',
- 'description' => 'The dimension of the vector.'."\n",
- 'type' => 'string',
- 'example' => '128',
- ],
- 'vectorIndexType' => [
- 'title' => '向量索引算法',
- 'description' => 'The vector retrieval algorithm.'."\n",
- 'type' => 'string',
- 'example' => 'Qc',
- ],
- 'distanceType' => [
- 'title' => '距离类型',
- 'description' => 'The distance type.'."\n",
- 'type' => 'string',
- 'example' => 'SquaredEuclidean',
- ],
- 'namespace' => [
- 'title' => '命名空间字段',
- 'description' => 'The namespace field.'."\n",
- 'type' => 'string',
- 'example' => 'namespace',
- ],
- 'advanceParams' => [
- 'title' => '索引结构配置',
- 'description' => 'The configurations of the index schema.'."\n",
- 'type' => 'object',
- 'properties' => [
- 'buildIndexParams' => [
- 'title' => '索引构建参数',
- 'description' => 'The index building parameters.'."\n",
- 'type' => 'string',
- 'example' => '{}',
- ],
- 'searchIndexParams' => [
- 'title' => '索引检索参数',
- 'description' => 'The index retrieval parameters.'."\n",
- 'type' => 'string',
- 'example' => '{}',
- ],
- 'minScanDocCnt' => [
- 'title' => '召回候选集的个数最小值',
- 'description' => 'The minimum number of retrieved candidate sets.'."\n",
- 'type' => 'string',
- 'example' => '20000',
- ],
- 'linearBuildThreshold' => [
- 'title' => '线性构建的阈值',
- 'description' => 'The threshold for linear building.'."\n",
- 'type' => 'string',
- 'example' => '5000',
- ],
- ],
- ],
- ],
- ],
- ],
- 'dataProcessConfig' => [
- 'title' => '字段处理配置',
- 'description' => 'The configurations about field processing.'."\n",
- 'type' => 'array',
- 'items' => [
- 'description' => '',
- 'type' => 'object',
- 'properties' => [
- 'operator' => [
- 'title' => '字段处理方式 (copy: 将源字段拷贝至目标字段, vectorize: 使用模型对源字段进行向量化，向量存储在目标字段中)',
- 'description' => 'The method used to process the field. Valid values: copy and vectorize. A value of copy indicates that the value of the source field is copied to the destination field. A value of vectorize indicates that the value of the source field is vectorized by a vectorization model and the output vector is stored in the destination field.'."\n",
- 'type' => 'string',
- 'example' => 'vectorize',
- ],
- 'dstField' => [
- 'title' => '目标字段',
- 'description' => 'The destination field.'."\n",
- 'type' => 'string',
- 'example' => 'source_image_vector',
- ],
- 'srcField' => [
- 'title' => '源字段',
- 'description' => 'The source field.'."\n",
- 'type' => 'string',
- 'example' => 'source_image',
- ],
- 'params' => [
- 'title' => '配置模型信息',
- 'description' => 'The information about the model.'."\n",
- 'type' => 'object',
- 'properties' => [
- 'vectorModel' => [
- 'title' => '向量化模型',
- 'description' => 'The vectorization model.'."\n",
- 'type' => 'string',
- 'example' => 'clip',
- ],
- 'vectorModal' => [
- 'title' => '数据类型',
- 'description' => 'The data type.'."\n",
- 'type' => 'string',
- 'example' => 'image',
- ],
- 'srcFieldConfig' => [
- 'title' => '向量化信息来源',
- 'description' => 'The source of the data to be vectorized.'."\n",
- 'type' => 'object',
- 'properties' => [
- 'ossEndpoint' => [
- 'description' => 'The Object Storage Service (OSS) endpoint.'."\n",
- 'type' => 'string',
- 'example' => 'oss-cn-hangzhou-internal.aliyuncs.com'."\n",
- ],
- 'ossBucket' => [
- 'description' => 'OSS Bucket'."\n",
- 'type' => 'string',
- 'example' => 'test',
- ],
- 'uid' => [
- 'description' => 'The ID of the Alibaba Cloud account.'."\n",
- 'type' => 'string',
- 'example' => 'uid',
- ],
- ],
- ],
- ],
- ],
- ],
- ],
- ],
- ],
- ],
+ 'requestId' => ['title' => '', 'description' => 'id of request', 'type' => 'string', 'example' => 'E45380E8-994A-5402-9806-F114B3295FCF'],
+ 'result' => ['title' => '', 'description' => 'The information about the index', 'type' => 'object', 'example' => '{}'],
],
- 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
],
500 => [],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"2AE63638-5420-56DC-BF59-37D8174039A0\\",\\n \\"result\\": {\\n \\"name\\": \\"test_oss\\",\\n \\"status\\": \\"IN_USE\\",\\n \\"dataProcessorCount\\": 1,\\n \\"partitionCount\\": 1,\\n \\"dataSource\\": {\\n \\"type\\": \\"odps\\",\\n \\"dataTimeSec\\": 1715160176,\\n \\"autoBuildIndex\\": true,\\n \\"config\\": {\\n \\"endpoint\\": \\"http://service.cn-hangzhou.maxcompute.aliyun-inc.com/api\\",\\n \\"accessKey\\": \\"ak\\",\\n \\"accessSecret\\": \\"as\\",\\n \\"project\\": \\"dp_pdm_marketing_prod\\",\\n \\"partition\\": \\"ds=20220808\\",\\n \\"table\\": \\"test_add\\",\\n \\"namespace\\": \\"namespace\\",\\n \\"path\\": \\"vendor/sebastian/comparator/src/exceptions\\",\\n \\"ossPath\\": \\"/opensearch_index_data/sift_oss_test.data\\",\\n \\"bucket\\": \\"heytea-ops-oss\\"\\n }\\n },\\n \\"rawSchema\\": \\"{}\\",\\n \\"primaryKey\\": \\"id\\",\\n \\"fieldSchema\\": {\\n \\"key\\": \\"INT64\\"\\n },\\n \\"vectorIndex\\": [\\n {\\n \\"indexName\\": \\"test_odps\\",\\n \\"vectorField\\": \\"source_image_vector\\",\\n \\"sparseIndexField\\": \\"sparse_indices\\",\\n \\"sparseValueField\\": \\"sparse_values\\",\\n \\"dimension\\": \\"128\\",\\n \\"vectorIndexType\\": \\"Qc\\",\\n \\"distanceType\\": \\"SquaredEuclidean\\",\\n \\"namespace\\": \\"namespace\\",\\n \\"advanceParams\\": {\\n \\"buildIndexParams\\": \\"{\\\\n \\\\\\"proxima.qc.builder.quantizer_class\\\\\\": \\\\\\"Int8QuantizerConverter\\\\\\",\\\\n \\\\\\"proxima.qc.builder.quantize_by_centroid\\\\\\": true,\\\\n \\\\\\"proxima.qc.builder.optimizer_class\\\\\\": \\\\\\"BruteForceBuilder\\\\\\",\\\\n \\\\\\"proxima.qc.builder.thread_count\\\\\\": 10,\\\\n \\\\\\"proxima.qc.builder.optimizer_params\\\\\\": {\\\\n \\\\\\"proxima.linear.builder.column_major_order\\\\\\": true\\\\n },\\\\n \\\\\\"proxima.qc.builder.store_original_features\\\\\\": false,\\\\n \\\\\\"proxima.qc.builder.train_sample_count\\\\\\": 3000000,\\\\n \\\\\\"proxima.qc.builder.train_sample_ratio\\\\\\": 0.5\\\\n}\\",\\n \\"searchIndexParams\\": \\"{\\\\\\"proxima.qc.searcher.scan_ratio\\\\\\":0.01}\\",\\n \\"minScanDocCnt\\": \\"20000\\",\\n \\"linearBuildThreshold\\": \\"5000\\"\\n }\\n }\\n ],\\n \\"dataProcessConfig\\": [\\n {\\n \\"operator\\": \\"vectorize\\",\\n \\"dstField\\": \\"source_image_vector\\",\\n \\"srcField\\": \\"source_image\\",\\n \\"params\\": {\\n \\"vectorModel\\": \\"clip\\",\\n \\"vectorModal\\": \\"image\\",\\n \\"srcFieldConfig\\": {\\n \\"ossEndpoint\\": \\"oss-cn-hangzhou-internal.aliyuncs.com\\\\n\\",\\n \\"ossBucket\\": \\"test\\",\\n \\"uid\\": \\"uid\\"\\n }\\n }\\n }\\n ]\\n }\\n}","type":"json"}]',
- 'title' => 'GetTable',
- 'requestParamsDescription' => '### [](#)Sample requests'."\n"
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"E45380E8-994A-5402-9806-F114B3295FCF\\",\\n \\"result\\": {}\\n}","type":"json"}]',
+ 'title' => 'PublishIndexVersion',
+ 'description' => '## Method'."\n"
."\n"
- .'```java'."\n"
- .'GET /openapi/ha3/instances/{instanceId}/tables/{tableName}'."\n"
- .'```'."\n",
- ],
- 'ListTables' => [
- 'summary' => 'Queries a list of index tables.',
- 'path' => '/openapi/ha3/instances/{instanceId}/tables',
- 'methods' => [
- 'get',
+ .'```'."\n"
+ .'POST'."\n"
+ .'```'."\n"
+ ."\n"
+ .'## URI'."\n"
+ ."\n"
+ .'```'."\n"
+ .'/openapi/ha3/instances/{instanceId}/indexes/{indexName}/actions/publish'."\n"
+ .'```',
+ 'requestParamsDescription' => '## Sample requests'."\n"
+ ."\n"
+ .''."\n"
+ ."\n"
+ .'```'."\n"
+ .'POST /openapi/ha3/instances/ose-test1/indexes/my_index/actions/publish'."\n"
+ .'```'."\n"
+ ."\n"
+ .''."\n"
+ ."\n"
+ .'```'."\n"
+ .'{'."\n"
+ .''."\n"
+ .' "desc": "new version",'."\n"
+ .''."\n"
+ .' "dataSource": "test1",'."\n"
+ .''."\n"
+ .' "domain": "test_domain"'."\n"
+ .''."\n"
+ .'}'."\n"
+ .'```',
+ 'responseParamsDescription' => '## [](#)Sample responses'."\n"
+ ."\n"
+ .'Sample success responses'."\n"
+ ."\n"
+ .'```'."\n"
+ .'{'."\n"
+ .' '."\n"
+ .' "requestId": "65911539-5a8b-4bce-96a5-4d608900dc46",'."\n"
+ .' '."\n"
+ .' "result": []'."\n"
+ .' '."\n"
+ .'}'."\n"
+ .'```'."\n"
+ ."\n"
+ .'For more information, see [Response structure](~~465311~~).',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'PublishIndexVersion'],
+ ],
],
- 'schemes' => [
- 'http',
- 'https',
+ 'ramActions' => [
+ [
+ 'operationType' => '',
+ 'ramAction' => [
+ 'action' => 'searchengine:PublishIndexVersion',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SearchEngine', 'resourceType' => 'Instance', 'arn' => 'acs:searchengine:{#regionId}:{#accountId}:instance/{#InstanceId}'],
+ ],
+ ],
+ ],
],
+ ],
+ 'PushDocuments' => [
+ 'path' => '/openapi/ha3/instances/{instanceId}/data-sources/{dataSourceName}/actions/bulk',
+ 'methods' => ['post'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
- 'operationType' => 'read',
+ 'operationType' => 'write',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'list',
- 'abilityTreeCode' => '218776',
- 'abilityTreeNodes' => [
- 'FEATUREopensearchGTRUN8',
- ],
- ],
+ 'systemTags' => [],
'parameters' => [
[
'name' => 'instanceId',
'in' => 'path',
- 'schema' => [
- 'description' => 'The instance ID.'."\n",
- 'type' => 'string',
- 'required' => true,
- 'example' => 'ha-cn-0ju2rewdi02',
- ],
+ 'schema' => ['description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'ha-cn-pl32rf0****'],
],
[
- 'name' => 'newMode',
- 'in' => 'query',
+ 'name' => 'dataSourceName',
+ 'in' => 'path',
+ 'schema' => ['description' => 'The name of the data source.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'ha-cn-pl32rf0****_ecom_table_test'],
+ ],
+ [
+ 'name' => 'body',
+ 'in' => 'body',
+ 'style' => 'json',
'schema' => [
- 'description' => 'Specifies whether the OpenSearch Vector Search Edition instance is of the new version.'."\n",
- 'type' => 'boolean',
+ 'description' => 'The request body parameters.',
+ 'type' => 'array',
+ 'items' => ['description' => 'The request body.', 'type' => 'any', 'required' => false, 'title' => '', 'example' => '[{"cmd":"add","fields":{"id":"1","vt":[0.1]}}]'],
'required' => false,
- 'example' => 'true',
- 'default' => 'true',
+ 'title' => '',
+ 'example' => '',
],
],
+ [
+ 'name' => 'pkField',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The primary key field.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => 'id'],
+ ],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
- 'requestId' => [
- 'title' => 'id of request',
- 'description' => 'requestId',
- 'type' => 'string',
- 'example' => '10D5E615-69F7-5F49-B850-00169ADE513C',
- ],
- 'result' => [
- 'title' => 'List',
- 'description' => 'The result.'."\n",
- 'type' => 'array',
- 'items' => [
- 'description' => '',
- 'type' => 'object',
- 'properties' => [
- 'name' => [
- 'title' => '索引名',
- 'description' => 'The index name.'."\n",
- 'type' => 'string',
- 'example' => 'es_test_1b',
- ],
- 'indexStatus' => [
- 'title' => '索引表状态 (NEW, PUBLISH, IN_USE: 召回引擎版创建成功后为正常状态, NOT_USE, STOP_USE, RESTORE_USE, FAIL: 向量检索版新版本首次创建索引失败状态)',
- 'description' => 'The state of the index table. Valid values: NEW, PUBLISH, IN_USE, NOT_USE, STOP_USE, RESTORE_USE, and FAIL. After an index is created in an OpenSearch Retrieval Engine Edition instance, the index enters the IN_USE state. If the first full index fails to be created in an OpenSearch Vector Search Edition instance of the new version, the index is in the FAIL state.'."\n",
- 'type' => 'string',
- 'example' => 'IN_USE',
- ],
- 'status' => [
- 'title' => '索引表状态 (NEW, PUBLISH, IN_USE: 召回引擎版创建成功后为正常状态, NOT_USE, STOP_USE, RESTORE_USE, FAIL: 向量检索版新版本首次创建索引失败状态)',
- 'description' => 'The state of the index table. Valid values: NEW, PUBLISH, IN_USE, NOT_USE, STOP_USE, RESTORE_USE, and FAIL. After an index is created in an OpenSearch Retrieval Engine Edition instance, the index enters the IN_USE state. If the first full index fails to be created in an OpenSearch Vector Search Edition instance of the new version, the index is in the FAIL state.'."\n",
- 'type' => 'string',
- 'example' => 'IN_USE',
- ],
- ],
- ],
- ],
+ 'requestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '2AE63638-5420-56DC-BF59-37D8174039A0'],
+ 'result' => ['title' => '', 'description' => 'The returned result.', 'type' => 'object', 'example' => '{}'],
],
'description' => '',
+ 'title' => '',
+ 'example' => '',
],
],
500 => [],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"10D5E615-69F7-5F49-B850-00169ADE513C\\",\\n \\"result\\": [\\n {\\n \\"name\\": \\"es_test_1b\\",\\n \\"indexStatus\\": \\"IN_USE\\",\\n \\"status\\": \\"IN_USE\\"\\n }\\n ]\\n}","type":"json"}]',
- 'title' => 'ListTables',
- 'requestParamsDescription' => '### [](#)Sample requests'."\n"
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"2AE63638-5420-56DC-BF59-37D8174039A0\\",\\n \\"result\\": {}\\n}","type":"json"}]',
+ 'title' => 'PushDocuments',
+ 'summary' => 'Pushes documents.',
+ 'description' => '### Method'."\n"
."\n"
.'```java'."\n"
- .'GET /openapi/ha3/instances/{instanceId}/tables'."\n"
- .'```'."\n",
- ],
- 'DeleteTable' => [
- 'summary' => 'Deletes an index table.',
- 'path' => '/openapi/ha3/instances/{instanceId}/tables/{tableName}',
- 'methods' => [
- 'delete',
- ],
- 'schemes' => [
- 'http',
- 'https',
+ .'POST'."\n"
+ .'```'."\n"
+ ."\n"
+ .'### URI'."\n"
+ ."\n"
+ .'```java'."\n"
+ .'/openapi/ha3/instances/{instanceId}/data-sources/{dataSourceName}/actions/bulk'."\n"
+ .'```',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => '',
+ 'ramAction' => [
+ 'action' => 'searchengine:PushDocuments',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SearchEngine', 'resourceType' => 'Instance', 'arn' => 'acs:searchengine:{#regionId}:{#accountId}:instance/{#InstanceId}'],
+ ],
+ ],
+ ],
],
+ ],
+ 'RecoverIndex' => [
+ 'summary' => 'Restores data from an index.',
+ 'path' => '/openapi/ha3/instances/{instanceId}/recover-index',
+ 'methods' => ['post'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
@@ -17617,31 +14595,32 @@
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
- 'operationType' => 'delete',
- 'abilityTreeCode' => '218775',
- 'abilityTreeNodes' => [
- 'FEATUREopensearchGTRUN8',
- ],
+ 'operationType' => 'update',
+ 'abilityTreeCode' => '144320',
+ 'abilityTreeNodes' => ['FEATUREopensearchVHEWK3'],
],
'parameters' => [
[
'name' => 'instanceId',
'in' => 'path',
- 'schema' => [
- 'description' => 'The instance ID.'."\n",
- 'type' => 'string',
- 'required' => true,
- 'example' => 'ha-cn-7e22rgfyb01',
- ],
+ 'schema' => ['description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'example' => 'ha-cn-pl32rf0****', 'title' => ''],
],
[
- 'name' => 'tableName',
- 'in' => 'path',
+ 'name' => 'body',
+ 'in' => 'body',
+ 'style' => 'json',
'schema' => [
- 'description' => 'The name of the table.'."\n",
- 'type' => 'string',
- 'required' => true,
- 'example' => 'test_summary',
+ 'description' => 'The request body.',
+ 'type' => 'object',
+ 'properties' => [
+ 'dataSourceName' => ['description' => 'The name of the data source.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => 'ha-cn-pl32rf0****_test_api'],
+ 'indexName' => ['description' => 'The index name.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => 'test_api'],
+ 'generation' => ['title' => '', 'description' => 'The ID of the full index version.', 'type' => 'string', 'required' => false, 'example' => '1653018575'],
+ 'buildDeployId' => ['title' => '', 'description' => 'The deployment ID of the data source.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '277'],
+ ],
+ 'required' => false,
+ 'title' => '',
+ 'example' => '',
],
],
],
@@ -17650,42 +14629,72 @@
'schema' => [
'type' => 'object',
'properties' => [
- 'requestId' => [
- 'title' => 'id of request',
- 'description' => 'requestId',
- 'type' => 'string',
- 'example' => 'E7B7D598-B080-5C8E-AA35-D43EC0D5F886',
- ],
- 'result' => [
- 'title' => 'Map',
- 'description' => 'Map',
- 'type' => 'object',
- 'example' => '{}',
- ],
+ 'requestId' => ['title' => '', 'description' => 'The ID of the request.', 'type' => 'string', 'example' => '10D5E615-69F7-5F49-B850-00169ADE513C'],
+ 'result' => ['title' => '', 'description' => 'The result returned by data search.', 'type' => 'object', 'example' => '{}'],
],
'description' => '',
+ 'title' => '',
+ 'example' => '',
],
],
500 => [],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"E7B7D598-B080-5C8E-AA35-D43EC0D5F886\\",\\n \\"result\\": {}\\n}","type":"json"}]',
- 'title' => 'DeleteTable',
- 'requestParamsDescription' => '### [](#)Sample requests'."\n"
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"10D5E615-69F7-5F49-B850-00169ADE513C\\",\\n \\"result\\": {}\\n}","type":"json"}]',
+ 'title' => 'RecoverIndex',
+ 'description' => '### Method'."\n"
."\n"
- .'```java'."\n"
- .'DELETE /openapi/ha3/instances/{instanceId}/tables/{tableName}'."\n"
- .'```'."\n",
+ .'`POST`'."\n"
+ ."\n"
+ .'### URI'."\n"
+ ."\n"
+ .'`/openapi/ha3/instances/{instanceId}/recover-index`',
+ 'requestParamsDescription' => '### Sample requests'."\n"
+ ."\n"
+ .'`POST /openapi/ha3/instances/ha3_instances_id/recover-index`'."\n"
+ ."\n"
+ .'```'."\n"
+ .'{'."\n"
+ .' "generation": "1653018575",'."\n"
+ .' "dataSourceName":"test_yyds_data1",'."\n"
+ .' "buildDeployId":277,'."\n"
+ .' "indexName":"index_1"'."\n"
+ .'}'."\n"
+ .'```',
+ 'responseParamsDescription' => '### ResponseExample'."\n"
+ ."\n"
+ .'```'."\n"
+ .'{'."\n"
+ .' "requestId": "0A6EB64B-B4C8-CF02-810F-E660812972FF",'."\n"
+ .' "result": []'."\n"
+ .'}'."\n"
+ .'```'."\n"
+ ."\n"
+ .'For details, refer to[Response structure](~~465311~~)',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'RecoverIndex'],
+ ],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'searchengine:RecoverIndex',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SearchEngine', 'resourceType' => 'Instance', 'arn' => 'acs:searchengine:{#regionId}:{#accountId}:instance/{#InstanceId}'],
+ ],
+ ],
+ ],
+ ],
],
'Reindex' => [
'summary' => 'Rebuilds an index.',
'path' => '/openapi/ha3/instances/{instanceId}/tables/{tableName}/reindex',
- 'methods' => [
- 'post',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
+ 'methods' => ['post'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
@@ -17696,60 +14705,34 @@
'systemTags' => [
'operationType' => 'update',
'abilityTreeCode' => '218777',
- 'abilityTreeNodes' => [
- 'FEATUREopensearchD5N27K',
- ],
+ 'abilityTreeNodes' => ['FEATUREopensearchD5N27K'],
],
'parameters' => [
[
'name' => 'instanceId',
'in' => 'path',
- 'schema' => [
- 'description' => 'The instance ID.'."\n",
- 'type' => 'string',
- 'required' => true,
- 'example' => 'ha-cn-2r42ppr7901',
- ],
+ 'schema' => ['description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'example' => 'ha-cn-pl32rf0****', 'title' => ''],
],
[
'name' => 'tableName',
'in' => 'path',
- 'schema' => [
- 'description' => 'The name of the table.'."\n",
- 'type' => 'string',
- 'required' => true,
- 'example' => 'test_summary',
- ],
+ 'schema' => ['description' => 'The name of the index table.', 'type' => 'string', 'required' => true, 'example' => 'test_summary', 'title' => ''],
],
[
'name' => 'body',
'in' => 'body',
'style' => 'json',
'schema' => [
- 'description' => 'The request body.'."\n",
+ 'description' => 'A JSON-formatted string. For more information, see the following details.',
'type' => 'object',
'properties' => [
- 'dataTimeSec' => [
- 'description' => 'The timestamp in seconds. The value must be of the INTEGER type. This parameter is required if you specify an API data source.',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'example' => '1640867288',
- ],
- 'partition' => [
- 'description' => 'The partition in the MaxCompute table. This parameter is required if type is set to odps.'."\n",
- 'type' => 'string',
- 'required' => false,
- 'example' => 'ds=20220713',
- ],
- 'ossDataPath' => [
- 'description' => 'oss data path',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'oss://opensearch',
- ],
+ 'dataTimeSec' => ['description' => 'The timestamp in seconds. This parameter is of the INT type. This parameter is required when the data source uses API push.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1640867288', 'title' => ''],
+ 'partition' => ['description' => 'The partition. This parameter is required when the data source is MaxCompute.', 'type' => 'string', 'required' => false, 'example' => 'ds=20220713', 'title' => ''],
+ 'ossDataPath' => ['description' => 'The OSS file path.', 'type' => 'string', 'required' => false, 'example' => 'oss://opensearch', 'title' => ''],
],
'required' => false,
+ 'title' => '',
+ 'example' => '',
],
],
],
@@ -17758,41 +14741,59 @@
'schema' => [
'type' => 'object',
'properties' => [
- 'requestId' => [
- 'title' => 'id of request',
- 'description' => 'requestId',
- 'type' => 'string',
- 'example' => '10D5E615-69F7-5F49-B850-00169ADE513C',
- ],
- 'result' => [
- 'title' => 'Map',
- 'description' => 'Map',
- 'type' => 'object',
- 'example' => '{}',
- ],
+ 'requestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '10D5E615-69F7-5F49-B850-00169ADE513C'],
+ 'result' => ['title' => '', 'description' => 'The returned result.', 'type' => 'object', 'example' => '{}'],
],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
],
500 => [],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"10D5E615-69F7-5F49-B850-00169ADE513C\\",\\n \\"result\\": {}\\n}","type":"json"}]',
- 'title' => 'Reindex',
- 'requestParamsDescription' => '### [](#)Sample requests'."\n"
+ 'title' => 'Rebuild an index',
+ 'description' => '### Method'."\n"
+ ."\n"
+ .'```java'."\n"
+ .'POST'."\n"
+ .'```'."\n"
+ ."\n"
+ .'### URI'."\n"
+ ."\n"
+ .'```java'."\n"
+ .'/openapi/ha3/instances/{instanceId}/tables/{tableName}/reindex'."\n"
+ .'```.',
+ 'requestParamsDescription' => '### Request example'."\n"
+ ."\n"
+ .''."\n"
."\n"
.'```java'."\n"
.'POST /openapi/ha3/instances/{instanceId}/tables/{tableName}/reindex'."\n"
- .'```'."\n",
- ],
- 'ListTableGenerations' => [
- 'summary' => 'Queries a list of index versions.',
- 'path' => '/openapi/ha3/instances/{instanceId}/tables/{tableName}/index_versions',
- 'methods' => [
- 'get',
- ],
- 'schemes' => [
- 'http',
- 'https',
+ .'```.',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'searchengine:Reindex',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SearchEngine', 'resourceType' => 'Instance', 'arn' => 'acs:searchengine:{#regionId}:{#accountId}:instance/{#InstanceId}'],
+ ],
+ ],
+ ],
],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"10D5E615-69F7-5F49-B850-00169ADE513C\\",\\n \\"result\\": {}\\n}","type":"json"}]',
+ ],
+ 'RemoveCluster' => [
+ 'summary' => 'Deletes a cluster.',
+ 'path' => '/openapi/ha3/instances/{instanceId}/clusters/{clusterName}',
+ 'methods' => ['delete'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
@@ -17800,131 +14801,133 @@
],
'operationType' => 'read',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'list',
- 'abilityTreeCode' => '218778',
- 'abilityTreeNodes' => [
- 'FEATUREopensearchGTRUN8',
- ],
- ],
+ 'systemTags' => [],
'parameters' => [
[
'name' => 'instanceId',
'in' => 'path',
- 'schema' => [
- 'description' => 'The instance ID.'."\n",
- 'type' => 'string',
- 'required' => true,
- 'example' => 'ha-cn-tl32n3iu801',
- ],
+ 'schema' => ['title' => '', 'description' => 'The instance ID.'."\n", 'type' => 'string', 'required' => true, 'example' => 'ha-cn-pl32rf0****'],
],
[
- 'name' => 'tableName',
+ 'name' => 'clusterName',
'in' => 'path',
- 'schema' => [
- 'description' => 'The name of the table.'."\n",
- 'type' => 'string',
- 'required' => true,
- 'example' => 'test_summary',
- ],
+ 'schema' => ['title' => '', 'description' => 'The name of the cluster'."\n", 'type' => 'string', 'required' => false, 'example' => 'bj_vpc_domain_2'],
],
],
'responses' => [
200 => [
'schema' => [
+ 'title' => '',
+ 'description' => 'Schema of Response'."\n",
'type' => 'object',
'properties' => [
- 'requestId' => [
- 'title' => 'id of request',
- 'description' => 'requestId',
- 'type' => 'string',
- 'example' => 'F6E3D968-529C-5C40-AFDD-133A8B8FD930',
- ],
- 'result' => [
- 'title' => 'List',
- 'description' => 'The result.'."\n",
- 'type' => 'array',
- 'items' => [
- 'description' => '',
- 'type' => 'object',
- 'properties' => [
- 'generationId' => [
- 'description' => 'The ID of the full index version.'."\n",
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '1708674867',
- ],
- ],
- ],
- ],
+ 'requestId' => ['title' => '', 'description' => 'id of request'."\n", 'type' => 'string', 'example' => 'E45380E8-994A-5402-9806-F114B3295FCF'],
+ 'result' => ['title' => '', 'description' => 'The result'."\n", 'type' => 'object', 'example' => '{}'],
],
- 'description' => '',
+ 'example' => '',
],
],
500 => [],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"F6E3D968-529C-5C40-AFDD-133A8B8FD930\\",\\n \\"result\\": [\\n {\\n \\"generationId\\": 1708674867\\n }\\n ]\\n}","type":"json"}]',
- 'title' => 'ListTableGenerations',
- 'requestParamsDescription' => '### [](#)Sample requests'."\n"
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"E45380E8-994A-5402-9806-F114B3295FCF\\",\\n \\"result\\": {}\\n}","type":"json"}]',
+ 'title' => 'RemoveCluster',
+ 'description' => '### Method'."\n"
."\n"
.'```java'."\n"
- .'GET /v2/instances/{instanceId}/tables/{tableName}/index_versions'."\n"
+ .'DELETE'."\n"
+ .'```'."\n"
+ ."\n"
+ .'### URI'."\n"
+ ."\n"
+ .'```java'."\n"
+ .'/openapi/ha3/instances/{instanceId}/clusters/{clusterName}'."\n"
.'```'."\n",
- ],
- 'GetTableGeneration' => [
- 'summary' => 'Queries the status of an index version based on the ID of the full index version.',
- 'path' => '/openapi/ha3/instances/{instanceId}/tables/{tableName}/index_versions/{generationId}',
- 'methods' => [
- 'get',
+ 'requestParamsDescription' => '### Sample requests'."\n"
+ ."\n"
+ .'```java'."\n"
+ ."\n"
+ .'DELETE /openapi/ha3/instances/ha3_instance_name/clusters/my_cluster_name'."\n"
+ .'```'."\n",
+ 'responseParamsDescription' => '### [](#)Sample responses'."\n"
+ ."\n"
+ .'Sample success responses'."\n"
+ ."\n"
+ .'```java'."\n"
+ .'{'."\n"
+ .' '."\n"
+ .' "requestId": "0A6EB64B-B4C8-CF02-810F-E660812972FF",'."\n"
+ .' '."\n"
+ .' "result": []'."\n"
+ .' '."\n"
+ .'}'."\n"
+ .'```'."\n"
+ ."\n"
+ .'For more information, see [Response structure](~~465311~~).'."\n",
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'RemoveCluster'],
+ ],
],
- 'schemes' => [
- 'http',
- 'https',
+ 'ramActions' => [
+ [
+ 'operationType' => '',
+ 'ramAction' => [
+ 'action' => 'searchengine:RemoveCluster',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SearchEngine', 'resourceType' => 'Instance', 'arn' => 'acs:searchengine:{#regionId}:{#accountId}:instance/{#InstanceId}'],
+ ],
+ ],
+ ],
],
+ ],
+ 'RenameFolder' => [
+ 'path' => '/openapi/ha3/instances/{instanceId}/sql-studio/databases/{database}/folders/{folderId}/name',
+ 'methods' => ['put'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
- 'operationType' => 'read',
+ 'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
- 'operationType' => 'get',
- 'abilityTreeCode' => '218780',
- 'abilityTreeNodes' => [
- 'FEATUREopensearchGTRUN8',
- ],
+ 'operationType' => 'update',
+ 'abilityTreeCode' => '138809',
+ 'abilityTreeNodes' => ['FEATUREopensearch95VJR4'],
],
'parameters' => [
[
'name' => 'instanceId',
'in' => 'path',
- 'schema' => [
- 'description' => 'The instance ID.'."\n",
- 'type' => 'string',
- 'required' => true,
- 'example' => 'ha-cn-pl32rf0js04',
- ],
+ 'schema' => ['description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'ha-cn-pl32rf0****'],
],
[
- 'name' => 'tableName',
+ 'name' => 'database',
'in' => 'path',
- 'schema' => [
- 'description' => 'The name of the table.'."\n",
- 'type' => 'string',
- 'required' => true,
- 'example' => 'test_summary',
- ],
+ 'schema' => ['description' => 'The database name.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'general'],
],
[
- 'name' => 'generationId',
+ 'name' => 'folderId',
'in' => 'path',
+ 'schema' => ['description' => 'The folder ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'title' => '', 'example' => '-1'],
+ ],
+ [
+ 'name' => 'body',
+ 'in' => 'body',
+ 'style' => 'json',
'schema' => [
- 'description' => 'The ID of the full index version.'."\n",
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => true,
- 'example' => '1708674867',
+ 'description' => 'The request body.',
+ 'type' => 'object',
+ 'properties' => [
+ 'name' => ['description' => 'The folder name.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'test'],
+ ],
+ 'required' => false,
+ 'title' => '',
+ 'example' => '',
],
],
],
@@ -17933,54 +14936,70 @@
'schema' => [
'type' => 'object',
'properties' => [
- 'requestId' => [
- 'title' => 'id of request',
- 'description' => 'requestId',
- 'type' => 'string',
- 'example' => 'E7B7D598-B080-5C8E-AA35-D43EC0D5F886',
- ],
+ 'requestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '10D5E615-69F7-5F49-B850-00169ADE513C'],
'result' => [
- 'title' => 'IndexGeneration',
- 'description' => 'The result returned.'."\n",
+ 'title' => '',
+ 'description' => 'The returned data.',
'type' => 'object',
'properties' => [
- 'generationId' => [
- 'description' => 'generationId',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '1708674867',
- ],
- 'status' => [
- 'title' => 'starting, building, ready, stopped, failed',
- 'description' => 'starting, building, ready, stopped, failed',
- 'type' => 'string',
- 'example' => 'ready',
- ],
+ 'id' => ['description' => 'The primary key ID.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '1'],
+ 'gmtCreate' => ['description' => 'The time when the folder was created.', 'type' => 'string', 'title' => '', 'example' => '1719221186114'],
+ 'gmtModified' => ['description' => 'The time when the folder was last modified.', 'type' => 'string', 'title' => '', 'example' => '1719221186114'],
+ 'name' => ['description' => 'The name of the folder.', 'type' => 'string', 'title' => '', 'example' => 'test'],
+ 'parent' => ['description' => 'The ID of the parent folder.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '-1'],
+ 'isDir' => ['description' => 'Indicates whether the item is a folder. Valid values: \\`true\\` and \\`false\\`.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => 'True'],
+ 'type' => ['title' => '', 'description' => 'The type of the item. Valid values: \\`table\\`, \\`instance\\`, \\`template\\`, and \\`function\\`.', 'type' => 'string', 'example' => 'template'],
+ 'instanceId' => ['description' => 'The instance ID.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '1'],
+ 'templateId' => ['description' => 'The template ID.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '1'],
],
+ 'example' => '',
],
],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
],
500 => [],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"E7B7D598-B080-5C8E-AA35-D43EC0D5F886\\",\\n \\"result\\": {\\n \\"generationId\\": 1708674867,\\n \\"status\\": \\"ready\\"\\n }\\n}","type":"json"}]',
- 'title' => 'GetTableGeneration',
- 'requestParamsDescription' => '### [](#)Sample requests'."\n"
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"10D5E615-69F7-5F49-B850-00169ADE513C\\",\\n \\"result\\": {\\n \\"id\\": 1,\\n \\"gmtCreate\\": \\"1719221186114\\",\\n \\"gmtModified\\": \\"1719221186114\\",\\n \\"name\\": \\"test\\",\\n \\"parent\\": -1,\\n \\"isDir\\": 0,\\n \\"type\\": \\"template\\",\\n \\"instanceId\\": 1,\\n \\"templateId\\": 1\\n }\\n}","type":"json"}]',
+ 'title' => 'RenameFolder',
+ 'summary' => 'Renames a folder.',
+ 'description' => '### Method'."\n"
."\n"
.'```java'."\n"
- .'GET /openapi/ha3/instances/{instanceId}/tables/{tableName}/index_versions/{generationId}'."\n"
- .'```'."\n",
- ],
- 'ListPostQueryResult' => [
- 'summary' => '召回引擎版使用POST请求获取搜索测试结果',
- 'path' => '/openapi/ha3/instances/{instanceId}/query',
- 'methods' => [
- 'post',
+ .'PUT'."\n"
+ .'```'."\n"
+ ."\n"
+ .'### URI'."\n"
+ ."\n"
+ .'```java'."\n"
+ .'/openapi/ha3/instances/{instanceId}/sql-studio/databases/{database}/folders/{folderId}/name'."\n"
+ .'```',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'RenameFolder'],
+ ],
],
- 'schemes' => [
- 'http',
- 'https',
+ 'ramActions' => [
+ [
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'searchengine:RenameFolder',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SearchEngine', 'resourceType' => 'Folder', 'arn' => 'acs:searchengine:{#regionId}:{#accountId}:instance/{#InstanceId}'],
+ ],
+ ],
+ ],
],
+ ],
+ 'StartIndex' => [
+ 'path' => '/openapi/ha3/instances/{instanceId}/indexes/{indexName}/startIndex',
+ 'methods' => ['post'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
@@ -17989,47 +15008,20 @@
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
- 'operationType' => 'list',
- 'riskType' => 'none',
- 'chargeType' => 'free',
- 'abilityTreeCode' => '205312',
- 'abilityTreeNodes' => [
- 'FEATUREopensearchO9FNU6',
- ],
+ 'operationType' => 'update',
+ 'abilityTreeCode' => '187010',
+ 'abilityTreeNodes' => ['FEATUREopensearchJ3PXKB'],
],
'parameters' => [
[
'name' => 'instanceId',
'in' => 'path',
- 'schema' => [
- 'description' => 'The instance ID.'."\n",
- 'type' => 'string',
- 'required' => true,
- 'example' => 'ha-cn-2r42ppr7901',
- ],
+ 'schema' => ['description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'ha-cn-pl32rf0****'],
],
[
- 'name' => 'type',
- 'in' => 'query',
- 'schema' => [
- 'title' => 'sql: sql查询, ha3: ha3查询',
- 'description' => 'The query type. Valid values: sql: SQL query. ha3: Havenask query.'."\n",
- 'type' => 'string',
- 'required' => false,
- 'example' => 'ha3',
- 'default' => 'sql',
- ],
- ],
- [
- 'name' => 'body',
- 'in' => 'body',
- 'style' => 'json',
- 'schema' => [
- 'description' => 'The request body.'."\n",
- 'type' => 'object',
- 'required' => false,
- 'example' => '{}',
- ],
+ 'name' => 'indexName',
+ 'in' => 'path',
+ 'schema' => ['description' => 'The index name.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'test_api'],
],
],
'responses' => [
@@ -18037,37 +15029,52 @@
'schema' => [
'type' => 'object',
'properties' => [
- 'requestId' => [
- 'title' => 'id of request',
- 'description' => 'The request ID.'."\n",
- 'type' => 'string',
- 'example' => '022F36C7-9FB4-5D67-BEBC-3D14B0984463',
- ],
- 'result' => [
- 'title' => 'Object',
- 'description' => 'The result.'."\n",
- 'type' => 'any',
- 'example' => '{}',
- ],
+ 'requestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => 'D39EE0F1-D7EF-5F46-B781-6BF4185308B0'],
+ 'result' => ['title' => '', 'description' => 'The returned result.', 'type' => 'object', 'example' => '{}'],
],
'description' => '',
+ 'title' => '',
+ 'example' => '',
],
],
500 => [],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"022F36C7-9FB4-5D67-BEBC-3D14B0984463\\",\\n \\"result\\": \\"{}\\"\\n}","type":"json"}]',
- 'title' => 'ListPostQueryResult',
- ],
- 'ListRestQueryResult' => [
- 'summary' => '召回引擎版获取rest查询搜索测试结果',
- 'path' => '/openapi/ha3/instances/{instanceId}/rest-query',
- 'methods' => [
- 'post',
- ],
- 'schemes' => [
- 'http',
- 'https',
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"D39EE0F1-D7EF-5F46-B781-6BF4185308B0\\",\\n \\"result\\": {}\\n}","type":"json"}]',
+ 'title' => 'StartIndex',
+ 'summary' => 'Resumes an index.',
+ 'description' => '### Method'."\n"
+ ."\n"
+ .'```java'."\n"
+ .'POST'."\n"
+ .'```'."\n"
+ ."\n"
+ .'### URI'."\n"
+ ."\n"
+ .'```java'."\n"
+ .'/openapi/ha3/instances/{instanceId}/indexes/{indexName}/startIndex'."\n"
+ .'```',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'searchengine:StartIndex',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SearchEngine', 'resourceType' => 'Instance', 'arn' => 'acs:searchengine:{#regionId}:{#accountId}:instance/{#InstanceId}'],
+ ],
+ ],
+ ],
],
+ ],
+ 'StopIndex' => [
+ 'path' => '/openapi/ha3/instances/{instanceId}/indexes/{indexName}/stopIndex',
+ 'methods' => ['post'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
@@ -18076,50 +15083,20 @@
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
- 'operationType' => 'list',
- 'riskType' => 'none',
- 'chargeType' => 'free',
- 'abilityTreeCode' => '171180',
- 'abilityTreeNodes' => [
- 'FEATUREopensearchO9FNU6',
- ],
+ 'operationType' => 'update',
+ 'abilityTreeCode' => '187011',
+ 'abilityTreeNodes' => ['FEATUREopensearchJ3PXKB'],
],
'parameters' => [
[
'name' => 'instanceId',
'in' => 'path',
- 'schema' => [
- 'description' => 'The instance ID.'."\n",
- 'type' => 'string',
- 'required' => true,
- 'example' => 'ha-cn-tl32n3iu801',
- ],
+ 'schema' => ['description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'ha-cn-pl32rf0****'],
],
[
- 'name' => 'body',
- 'in' => 'body',
- 'style' => 'json',
- 'schema' => [
- 'description' => 'The request body.'."\n",
- 'type' => 'object',
- 'properties' => [
- 'indexName' => [
- 'title' => '索引表名',
- 'description' => 'The name of the index table.'."\n",
- 'type' => 'string',
- 'required' => false,
- 'example' => 'main_index',
- ],
- 'query' => [
- 'title' => 'rest查询语句',
- 'description' => 'The rest query statement.'."\n",
- 'type' => 'object',
- 'required' => false,
- 'example' => 'query%3Drelation_id%3A%221151274675_2%22%26%26cluster%3Dgeneral%26%26config%3Dstart%3A0%2Chit%3A10%2Cformat%3Ajson',
- ],
- ],
- 'required' => false,
- ],
+ 'name' => 'indexName',
+ 'in' => 'path',
+ 'schema' => ['description' => 'The index name.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'test_api'],
],
],
'responses' => [
@@ -18127,102 +15104,199 @@
'schema' => [
'type' => 'object',
'properties' => [
- 'requestId' => [
- 'title' => 'id of request',
- 'description' => 'The request ID.'."\n",
- 'type' => 'string',
- 'example' => 'F43E8AB4-419C-5F4C-90D6-615590DFAA3C',
- ],
- 'result' => [
- 'title' => 'Object',
- 'description' => 'The result.'."\n",
- 'type' => 'any',
- 'example' => '{}',
- ],
+ 'requestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => 'E7B7D598-B080-5C8E-AA35-D43EC0D5F886'],
+ 'result' => ['title' => '', 'description' => 'The returned result.', 'type' => 'object', 'example' => '{}'],
],
'description' => '',
+ 'title' => '',
+ 'example' => '',
],
],
500 => [],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"F43E8AB4-419C-5F4C-90D6-615590DFAA3C\\",\\n \\"result\\": \\"{}\\"\\n}","type":"json"}]',
- 'title' => 'ListRestQueryResult',
- ],
- 'ListVectorQueryResult' => [
- 'summary' => '向量检索版获取向量查询搜索测试结果',
- 'path' => '/openapi/ha3/instances/{instanceId}/vector-query',
- 'methods' => [
- 'post',
- ],
- 'schemes' => [
- 'http',
- 'https',
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"E7B7D598-B080-5C8E-AA35-D43EC0D5F886\\",\\n \\"result\\": {}\\n}","type":"json"}]',
+ 'title' => 'StopIndex',
+ 'summary' => 'Stops an index.',
+ 'description' => '### Method'."\n"
+ ."\n"
+ .'```java'."\n"
+ .'POST'."\n"
+ .'```'."\n"
+ ."\n"
+ .'### URI'."\n"
+ ."\n"
+ .'```java'."\n"
+ .'/openapi/ha3/instances/{instanceId}/indexes/{indexName}/stopIndex'."\n"
+ .'```',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'searchengine:StopIndex',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SearchEngine', 'resourceType' => 'Instance', 'arn' => 'acs:searchengine:{#regionId}:{#accountId}:instance/{#InstanceId}'],
+ ],
+ ],
+ ],
],
+ ],
+ 'StopTask' => [
+ 'summary' => 'Stops an FSM task.',
+ 'path' => '/openapi/ha3/instances/{instanceId}/stop-task/{fsmId}',
+ 'methods' => ['put'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
- 'operationType' => 'read',
+ 'operationType' => 'write',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'list',
- 'riskType' => 'none',
- 'chargeType' => 'free',
- 'abilityTreeCode' => '194016',
- 'abilityTreeNodes' => [
- 'FEATUREopensearchYR63E7',
- ],
- ],
+ 'systemTags' => [],
'parameters' => [
[
'name' => 'instanceId',
'in' => 'path',
- 'schema' => [
- 'description' => 'The instance ID.'."\n",
- 'type' => 'string',
- 'required' => true,
- 'example' => 'ha-cn-0ju2rps6c08',
- ],
+ 'schema' => ['description' => 'The instance ID.'."\n", 'type' => 'string', 'required' => true, 'example' => 'ha-cn-pl32rf0****', 'title' => ''],
],
[
- 'name' => 'path',
- 'in' => 'query',
+ 'name' => 'fsmId',
+ 'in' => 'path',
+ 'schema' => ['description' => 'The ID of the finite state machine (FSM).'."\n", 'type' => 'string', 'required' => true, 'example' => 'tisplus_opensearch@datasource_flow_fsm@1865410598556969-ha-cn-pl32rf0****_api2@bj_vpc_domain_1@null@MANUAL-ha-cn-pl32rf0****_api2@1649729867698@028315', 'title' => ''],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
'schema' => [
- 'type' => 'string',
+ 'title' => '',
+ 'description' => 'Schema of Response'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'requestId' => ['title' => '', 'description' => 'id of request'."\n", 'type' => 'string', 'example' => 'FE03180A-0E29-5474-8A86-33F0683294A4'],
+ 'result' => ['title' => '', 'description' => 'The information about the index'."\n", 'type' => 'object', 'example' => '{}'],
+ ],
+ 'example' => '',
],
],
+ 500 => [],
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"FE03180A-0E29-5474-8A86-33F0683294A4\\",\\n \\"result\\": {}\\n}","type":"json"}]',
+ 'title' => 'StopTask',
+ 'description' => '### [](#)Method'."\n"
+ ."\n"
+ .'```java'."\n"
+ .'PUT'."\n"
+ .'```'."\n"
+ ."\n"
+ .'### [](#uri)URI'."\n"
+ ."\n"
+ .'```java'."\n"
+ .'/openapi/ha3/instances/{instanceId}/stop-task/{fsmId}'."\n"
+ .'```'."\n",
+ 'requestParamsDescription' => '### Sample requests'."\n"
+ ."\n"
+ .'```java'."\n"
+ .'PUT /openapi/ha3/instances/{instanceId}/stop-task/tisplus_opensearch@add_index_config@1062017779051424-ha-cn-0ju2i0e5z01_mx1228@null@index_11@null@1641282725526@607017'."\n"
+ .'```'."\n",
+ 'responseParamsDescription' => '### [](#)Sample responses'."\n"
+ ."\n"
+ .'Sample success responses'."\n"
+ ."\n"
+ .'```java'."\n"
+ .'{'."\n"
+ .' '."\n"
+ .' "requestId": "0A6EB64B-B4C8-CF02-810F-E660812972FF",'."\n"
+ .' '."\n"
+ .' "result": []'."\n"
+ .' '."\n"
+ .'}'."\n"
+ .'```'."\n"
+ ."\n"
+ .'For more information, see [Response structure](~~465311~~).'."\n",
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'StopTask'],
+ ],
+ ],
+ 'ramActions' => [
[
- 'name' => 'queryType',
- 'in' => 'query',
- 'schema' => [
- 'description' => 'The query type. Valid values: vector, primary_key, and vector_text.'."\n",
- 'type' => 'string',
- 'required' => false,
- 'example' => 'primary_key',
- 'default' => 'vector',
+ 'operationType' => '',
+ 'ramAction' => [
+ 'action' => 'searchengine:StopTask',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SearchEngine', 'resourceType' => 'Instance', 'arn' => 'acs:searchengine:{#regionId}:{#accountId}:instance/{#InstanceId}'],
+ ],
],
],
+ ],
+ ],
+ 'TagResources' => [
+ 'summary' => 'Adds or updates tags for multiple resources.',
+ 'path' => '/openapi/ha3/resource-tags',
+ 'methods' => ['post'],
+ 'schemes' => ['http', 'https'],
+ 'security' => [
[
- 'name' => 'vectorQueryType',
- 'in' => 'query',
- 'schema' => [
- 'description' => 'The vector query type. Valid values: vector, image, and text.'."\n",
- 'type' => 'string',
- 'required' => false,
- 'example' => 'image',
- 'default' => 'vector',
- ],
+ 'AK' => [],
],
+ ],
+ 'produces' => ['application/json'],
+ 'operationType' => 'readAndWrite',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'update',
+ 'abilityTreeCode' => '166280',
+ 'abilityTreeNodes' => ['FEATUREopensearchJB31XH'],
+ ],
+ 'parameters' => [
[
'name' => 'body',
'in' => 'body',
'style' => 'json',
'schema' => [
- 'description' => 'The request body.'."\n",
+ 'description' => 'The request body.',
'type' => 'object',
+ 'properties' => [
+ 'resourceType' => ['title' => '', 'description' => 'The resource type.', 'type' => 'string', 'required' => true, 'example' => 'instance'],
+ 'resourceId' => [
+ 'title' => '',
+ 'description' => 'The IDs of the resources. You can specify up to 50 IDs.',
+ 'type' => 'array',
+ 'items' => ['description' => 'The ID of the resource.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => 'es-cn-i7m2u6o2*******'],
+ 'required' => true,
+ 'example' => '',
+ ],
+ 'tag' => [
+ 'title' => '',
+ 'description' => 'The tags to add. You can specify a maximum of 20 tags.',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'The tag.',
+ 'type' => 'object',
+ 'properties' => [
+ 'key' => ['title' => '', 'description' => 'The tag key.', 'type' => 'string', 'required' => false, 'example' => 'opensearch'],
+ 'value' => ['title' => '', 'description' => 'The tag value.', 'type' => 'string', 'required' => false, 'example' => 'opensearch'],
+ ],
+ 'required' => false,
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'required' => true,
+ 'example' => '',
+ ],
+ ],
'required' => false,
- 'example' => '{}',
+ 'title' => '',
+ 'example' => '',
],
],
],
@@ -18231,90 +15305,99 @@
'schema' => [
'type' => 'object',
'properties' => [
- 'requestId' => [
- 'title' => 'id of request',
- 'description' => 'The request ID.'."\n",
- 'type' => 'string',
- 'example' => '022F36C7-9FB4-5D67-BEBC-3D14B0984463',
- ],
- 'result' => [
- 'title' => 'Object',
- 'description' => 'The result.'."\n",
- 'type' => 'any',
- 'example' => '{}',
- ],
+ 'requestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => 'E7B7D598-B080-5C8E-AA35-D43EC0D5F886'],
],
'description' => '',
+ 'title' => '',
+ 'example' => '',
],
],
- 500 => [],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"022F36C7-9FB4-5D67-BEBC-3D14B0984463\\",\\n \\"result\\": \\"{}\\"\\n}","type":"json"}]',
- 'title' => 'ListVectorQueryResult',
- ],
- 'PushDocuments' => [
- 'path' => '/openapi/ha3/instances/{instanceId}/data-sources/{dataSourceName}/actions/bulk',
- 'methods' => [
- 'post',
- ],
- 'schemes' => [
- 'http',
- 'https',
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"E7B7D598-B080-5C8E-AA35-D43EC0D5F886\\"\\n}","type":"json"}]',
+ 'title' => 'TagResources',
+ 'description' => '### Method'."\n"
+ ."\n"
+ .'```java'."\n"
+ .'POST'."\n"
+ .'```'."\n"
+ ."\n"
+ .'### URI'."\n"
+ ."\n"
+ .'```java'."\n"
+ .'/openapi/ha3/resource-tags'."\n"
+ .'```',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'searchengine:TagResources',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SearchEngine', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
],
+ ],
+ 'UntagResources' => [
+ 'summary' => 'Removes tags from a batch of resources.',
+ 'path' => '/openapi/ha3/resource-tags',
+ 'methods' => ['delete'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
- 'operationType' => 'write',
+ 'produces' => ['application/json'],
+ 'operationType' => 'readAndWrite',
'deprecated' => false,
- 'systemTags' => [],
+ 'systemTags' => [
+ 'operationType' => 'delete',
+ 'abilityTreeCode' => '166296',
+ 'abilityTreeNodes' => ['FEATUREopensearchJB31XH'],
+ ],
'parameters' => [
[
- 'name' => 'instanceId',
- 'in' => 'path',
- 'schema' => [
- 'description' => 'The instance ID.'."\n",
- 'type' => 'string',
- 'required' => true,
- 'example' => 'ha-cn-7mz2iv7sq01',
- ],
+ 'name' => 'resourceType',
+ 'in' => 'query',
+ 'schema' => ['title' => '', 'description' => 'The resource type.', 'type' => 'string', 'required' => true, 'example' => 'instance'],
],
[
- 'name' => 'dataSourceName',
- 'in' => 'path',
+ 'name' => 'resourceId',
+ 'in' => 'query',
+ 'style' => 'json',
'schema' => [
- 'description' => 'The name of the data source.'."\n",
- 'type' => 'string',
+ 'title' => '',
+ 'description' => 'The IDs of the resources. You can specify up to 50 resource IDs.',
+ 'type' => 'array',
+ 'items' => ['description' => 'The resource ID.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => 'es-cn-i7m2u6o2*******'],
'required' => true,
- 'example' => 'ha-cn-2r42ostoc01_ecom_table_test',
+ 'example' => '',
],
],
[
- 'name' => 'body',
- 'in' => 'body',
+ 'name' => 'tagKey',
+ 'in' => 'query',
'style' => 'json',
'schema' => [
- 'description' => 'The request body.'."\n",
+ 'title' => '',
+ 'description' => 'The list of tag keys. You can include up to 20 tag keys.',
'type' => 'array',
- 'items' => [
- 'description' => 'The request body.'."\n",
- 'type' => 'any',
- 'required' => false,
- 'example' => '{}',
- ],
+ 'items' => ['description' => 'The tag key.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => 'opensearch'],
'required' => false,
+ 'example' => '',
],
],
[
- 'name' => 'pkField',
+ 'name' => 'all',
'in' => 'query',
- 'schema' => [
- 'description' => 'The primary key field.'."\n",
- 'type' => 'string',
- 'required' => false,
- 'example' => 'id',
- ],
+ 'schema' => ['title' => '', 'description' => 'Specifies whether to remove all tags. This parameter is valid only when the \\`tagKey\\` parameter is empty. Valid values: \\`true\\` and \\`false\\`. The default value is \\`false\\`.', 'type' => 'boolean', 'required' => false, 'example' => 'true'],
],
],
'responses' => [
@@ -18322,249 +15405,225 @@
'schema' => [
'type' => 'object',
'properties' => [
- 'requestId' => [
- 'title' => 'id of request',
- 'description' => 'The request ID.'."\n",
- 'type' => 'string',
- 'example' => '2AE63638-5420-56DC-BF59-37D8174039A0',
- ],
- 'result' => [
- 'title' => 'Map',
- 'description' => 'The result.'."\n",
- 'type' => 'object',
- 'example' => '{}',
- ],
+ 'tequestId' => ['description' => 'The request ID.', 'type' => 'string', 'title' => '', 'example' => 'E7B7D598-B080-5C8E-AA35-D43EC0D5F886'."\n"],
],
'description' => '',
+ 'title' => '',
+ 'example' => '',
],
],
- 500 => [],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"2AE63638-5420-56DC-BF59-37D8174039A0\\",\\n \\"result\\": {}\\n}","type":"json"}]',
- 'title' => 'PushDocuments',
- ],
- 'DescribeRegions' => [
- 'path' => '/openapi/ha3/regions',
- 'methods' => [
- 'get',
- ],
- 'schemes' => [
- 'http',
- 'https',
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"tequestId\\": \\"E7B7D598-B080-5C8E-AA35-D43EC0D5F886\\\\n\\"\\n}","type":"json"}]',
+ 'title' => 'UntagResources',
+ 'description' => '### Method'."\n"
+ ."\n"
+ .'```java'."\n"
+ .'DELETE'."\n"
+ .'```'."\n"
+ ."\n"
+ .'### URI'."\n"
+ ."\n"
+ .'```java'."\n"
+ .'/openapi/ha3/resource-tags'."\n"
+ .'```',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'delete',
+ 'ramAction' => [
+ 'action' => 'searchengine:UntagResources',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SearchEngine', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
],
+ ],
+ 'UpdateInstance' => [
+ 'summary' => 'Modifies the configuration of a specified instance.',
+ 'path' => '/openapi/ha3/instances/{instanceId}',
+ 'methods' => ['put'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
- 'consumes' => [
- 'application/json',
- ],
- 'produces' => [
- 'application/json',
- ],
- 'operationType' => 'read',
- 'systemTags' => [
- 'operationType' => 'none',
- 'abilityTreeCode' => '180430',
- 'abilityTreeNodes' => [
- 'FEATUREopensearch0AT3OG',
- 'FEATUREopensearchJB31XH',
- ],
- ],
+ 'operationType' => 'write',
+ 'deprecated' => false,
+ 'systemTags' => ['operationType' => 'update'],
'parameters' => [
[
- 'name' => 'acceptLanguage',
- 'in' => 'query',
- 'schema' => [
- 'description' => 'The language of the response. Default value: zh-cn.'."\n",
- 'type' => 'string',
- 'required' => false,
- 'example' => 'zh-cn',
- ],
+ 'name' => 'instanceId',
+ 'in' => 'path',
+ 'schema' => ['description' => 'The instance ID.', 'type' => 'string', 'required' => false, 'example' => 'ha-cn-pl32rf0****', 'title' => ''],
],
- ],
- 'responses' => [
- 200 => [
+ [
+ 'name' => 'body',
+ 'in' => 'body',
+ 'style' => 'json',
'schema' => [
+ 'description' => 'The request body.',
'type' => 'object',
'properties' => [
- 'requestId' => [
- 'description' => 'id of request'."\n",
- 'type' => 'string',
- 'example' => 'E7B7D598-B080-5C8E-AA35-D43EC0D5F886',
- ],
- 'result' => [
- 'description' => 'The result.'."\n",
+ 'components' => [
+ 'title' => '',
+ 'description' => 'The information about the instance specification.',
'type' => 'array',
'items' => [
- 'description' => 'The result.'."\n",
+ 'description' => 'The request body.',
'type' => 'object',
'properties' => [
- 'localName' => [
- 'description' => 'The name of the region.'."\n",
- 'type' => 'string',
- 'example' => 'China (Hangzhou)',
- ],
- 'endpoint' => [
- 'description' => 'The endpoint of the region.'."\n",
- 'type' => 'string',
- 'example' => 'endpoint',
- ],
- 'regionId' => [
- 'description' => 'The ID of the region. Valid values:'."\n"
- ."\n"
- .'cn-hangzhou: China (Hangzhou)'."\n"
- ."\n"
- .'cn-shanghai: China (Shanghai)'."\n"
- ."\n"
- .'cn-qingdao: China (Qingdao)'."\n"
- ."\n"
- .'cn-beijing: China (Beijing)'."\n"
- ."\n"
- .'cn-zhangjiakou: China (Zhangjiakou)'."\n"
- ."\n"
- .'cn-shenzhen: China (Shenzhen)'."\n"
- ."\n"
- .'ap-southeast-1: Singapore (Singapore)'."\n"
- ."\n"
- .'cn-internal: Internal Center'."\n"
- ."\n"
- .'cn-zhangbei-in: Internal Center (Zhangjiakou)'."\n"
- ."\n"
- .'us-west-1-in: Internal Center (US)'."\n"
- ."\n"
- .'rus-west-1-in: Internal Center (Russia)'."\n"
- ."\n"
- .'cn-daily: Daily Environment'."\n"
- ."\n"
- .'cn-test: Joint Debugging'."\n"
- ."\n"
- .'pre-hangzhou: China (Hangzhou)-Staging'."\n",
- 'type' => 'string',
- 'example' => 'cn-hangzhou',
- ],
+ 'code' => ['description' => 'The code of the specification, which must be consistent with the value that you specify on the buy page.', 'type' => 'string', 'required' => false, 'example' => 'searcherdocsizesum', 'title' => ''],
+ 'value' => ['description' => 'The value of the specification.', 'type' => 'string', 'required' => false, 'example' => '200', 'title' => ''],
],
+ 'required' => false,
+ 'title' => '',
+ 'example' => '',
],
+ 'required' => false,
+ 'example' => '',
],
+ 'orderType' => ['description' => 'The type of the order. Valid values: UPGRADE and DOWNGRADE. UPGRADE upgrades the instance specifications. DOWNGRADE: downgrades the instance specifications.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => 'UPGRAGE'],
+ 'description' => ['description' => 'The description of the instance.', 'type' => 'string', 'example' => 'Instance description', 'title' => '', 'required' => false],
],
- ],
- ],
- ],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"E7B7D598-B080-5C8E-AA35-D43EC0D5F886\\",\\n \\"result\\": [\\n {\\n \\"localName\\": \\"China (Hangzhou)\\",\\n \\"endpoint\\": \\"endpoint\\",\\n \\"regionId\\": \\"cn-hangzhou\\"\\n }\\n ]\\n}","type":"json"}]',
- 'title' => 'DescribeRegions',
- 'summary' => 'Queries available regions.',
- ],
- 'ListQueryResult' => [
- 'summary' => 'Queries the query result.',
- 'path' => '/openapi/ha3/instances/{instanceId}/query',
- 'methods' => [
- 'get',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
- 'security' => [
- [
- 'AK' => [],
- ],
- ],
- 'operationType' => 'read',
- 'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'get',
- ],
- 'parameters' => [
- [
- 'name' => 'instanceId',
- 'in' => 'path',
- 'schema' => [
- 'title' => '实例ID',
- 'description' => 'The instance ID.'."\n",
- 'type' => 'string',
- 'required' => true,
- 'example' => 'ha-cn-i7m2olkw201',
- ],
- ],
- [
- 'name' => 'query',
- 'in' => 'query',
- 'schema' => [
- 'description' => 'The query statement'."\n",
- 'type' => 'string',
'required' => false,
- 'example' => 'query%3D1%26%26config%3Dstart%3A0%2Chit%3A10%2Cformat%3Ajson%26%26cluster%3Dgeneral',
- ],
- ],
- [
- 'name' => 'sql',
- 'in' => 'query',
- 'schema' => [
- 'description' => 'The SQL statement that is executed in the query'."\n",
- 'type' => 'string',
- 'required' => false,
- 'example' => 'query%3Dselect%20max(content_id)%20from%20generation',
+ 'example' => '{}',
+ 'title' => '',
],
],
],
'responses' => [
200 => [
+ 'headers' => [],
'schema' => [
- 'title' => 'Schema of Response',
- 'description' => 'Schema of Response'."\n",
+ 'title' => '',
+ 'description' => 'The response parameters.',
'type' => 'object',
'properties' => [
- 'requestId' => [
- 'title' => 'Id of the request',
- 'description' => 'The ID of the request'."\n",
- 'type' => 'string',
- 'example' => '9E5BCFAA-98B3-51D0-9188-B1BC07589337',
+ 'result' => [
+ 'description' => 'The results returned.',
+ 'type' => 'object',
+ 'properties' => [
+ 'description' => ['description' => 'The description of the instance', 'type' => 'string', 'example' => 'Test instance', 'title' => ''],
+ 'resourceGroupId' => ['description' => 'The ID of the resource group.', 'type' => 'string', 'title' => '', 'example' => 'ha-cn-pl32rf0****'],
+ 'expiredTime' => ['description' => 'The time when the instance expires', 'type' => 'string', 'title' => '', 'example' => '2019-01-06T16:00:00.0'],
+ 'commodityCode' => ['description' => 'The commodity code of the instance.', 'type' => 'string', 'title' => '', 'example' => 'opensearch_ha3post_public_cn'],
+ 'status' => ['description' => 'The instance status.', 'type' => 'string', 'title' => '', 'example' => 'READY'],
+ 'instanceId' => ['description' => 'The instance ID.', 'type' => 'string', 'title' => '', 'example' => 'ha-cn-pl32rf0****'],
+ 'createTime' => ['description' => 'The time when the instance was created', 'type' => 'string', 'title' => '', 'example' => '2018-12-06T11:17:49.0'],
+ 'lockMode' => ['description' => 'The lock status', 'type' => 'string', 'title' => '', 'example' => 'Unlock'],
+ 'chargeType' => ['description' => 'The billing method.', 'type' => 'string', 'title' => '', 'example' => 'POSTPAY'],
+ 'updateTime' => ['description' => 'The time when the instance was last updated', 'type' => 'string', 'title' => '', 'example' => '2018-12-06T11:17:49.0'],
+ 'inDebt' => ['description' => 'Indicates whether an overdue payment is involved', 'type' => 'boolean', 'title' => '', 'example' => 'false'],
+ ],
+ 'title' => '',
+ 'example' => '',
],
+ 'requestId' => ['title' => '', 'description' => 'The ID of the request', 'type' => 'string', 'example' => '90D6B8F5-FE97-4509-9AAB-367836C51818'],
],
+ 'example' => '',
],
],
500 => [],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"9E5BCFAA-98B3-51D0-9188-B1BC07589337\\"\\n}","type":"json"}]',
- 'title' => 'ListQueryResult',
- 'description' => '### [](#)Method'."\n"
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"result\\": {\\n \\"description\\": \\"Test instance\\",\\n \\"resourceGroupId\\": \\"ha-cn-pl32rf0****\\",\\n \\"expiredTime\\": \\"2019-01-06T16:00:00.0\\",\\n \\"commodityCode\\": \\"opensearch_ha3post_public_cn\\",\\n \\"status\\": \\"READY\\",\\n \\"instanceId\\": \\"ha-cn-pl32rf0****\\",\\n \\"createTime\\": \\"2018-12-06T11:17:49.0\\",\\n \\"lockMode\\": \\"Unlock\\",\\n \\"chargeType\\": \\"POSTPAY\\",\\n \\"updateTime\\": \\"2018-12-06T11:17:49.0\\",\\n \\"inDebt\\": false\\n },\\n \\"requestId\\": \\"90D6B8F5-FE97-4509-9AAB-367836C51818\\"\\n}","type":"json"}]',
+ 'title' => 'UpdateInstance',
+ 'description' => '### Method'."\n"
."\n"
- .'`GET`'."\n"
+ .'`PUT`'."\n"
."\n"
- .'### [](#uri)URI'."\n"
+ .'### URI'."\n"
."\n"
- .'`/openapi/ha3/instances/{instanceId}/query?query=xxxx`'."\n",
- 'responseParamsDescription' => '|Field|Type|Description|'."\n"
- .'|---|---|---|'."\n"
- .'|requestId|String|The ID of the request.|'."\n"
- .'|result|String|The string returned by the Havenask engine. It can be in a JSON or an xmsql format.',
+ .'`/openapi/ha3/instances/{instanceId}`',
'extraInfo' => '### Example'."\n"
."\n"
.'**Sample requests**'."\n"
."\n"
- .' sql: GET /openapi/ha3/instances/ha3_instances_id/query?sql=query%3Dselect+%2A+from+mx_index1217'."\n"
+ .'`PUT /openapi/ha3/instances/ha-cn-xxxxxx`'."\n"
."\n"
- .' query: GET /openapi/ha3/instances/ha3_instances_id/query?query=config%3Dhit%3A4%2Cformat%3Ajson%2Cfetch_summary_type%3Apk%2Cqrs_chain%3Asearch%26%26query%3Did%3A8148508889615505646%26%26cluster%3Dgeneral'."\n"
+ .' {'."\n"
+ .' "description": "the new description"'."\n"
+ .' }'."\n"
+ .' or'."\n"
+ .' {'."\n"
+ .' "resourceGroupId": "the new resourceGroupId"'."\n"
+ .' }'."\n"
."\n"
.'**Sample responses**'."\n"
."\n"
.'Success responses'."\n"
."\n"
.' {'."\n"
- .' "requestId": "0A6EB64B-B4C8-CF02-810F-E660812972FF",'."\n"
- .' "result": {}'."\n"
- .' }'."\n",
- ],
- 'DeleteModel' => [
- 'summary' => '删除模型',
- 'path' => '/openapi/ha3/instances/{instanceId}/models/{modelName}',
- 'methods' => [
- 'delete',
- ],
- 'schemes' => [
- 'https',
+ .' "result": {'."\n"
+ .' "instanceId": "airec-cn-o400whm78004",'."\n"
+ .' "description": "airec-cn-o400whm78004",'."\n"
+ .' "status": "Running",'."\n"
+ .' "chargeType": "PrePaid",'."\n"
+ .' "commodityCode": "airecpre",'."\n"
+ .' "createTime": "2018-12-06T11:17:49.0",'."\n"
+ .' "updateTime": "2018-12-06T11:17:49.0",'."\n"
+ .' "expiredTime": "2019-01-06T16:00:00.0",'."\n"
+ .' "resourceGroupId": "rg-abcdefg",'."\n"
+ .' "lockMode": "Unlock",'."\n"
+ .' "inDebt": false,'."\n"
+ .' "spec": {'."\n"
+ .' "password": "passwd",'."\n"
+ .' "searchResource": {'."\n"
+ .' "disk": 50,'."\n"
+ .' "mem": 8,'."\n"
+ .' "cpu": 2,'."\n"
+ .' "nodeCount": 2'."\n"
+ .' },'."\n"
+ .' "instanceName": "testInstance",'."\n"
+ .' "vSwitchId": "vswitch_id_xxx",'."\n"
+ .' "vpcId": "vpc_id_xxx",'."\n"
+ .' "qrsResource": {'."\n"
+ .' "disk": 50,'."\n"
+ .' "mem": 8,'."\n"
+ .' "cpu": 2,'."\n"
+ .' "nodeCount": 2'."\n"
+ .' },'."\n"
+ .' "region": "cn-hangzhou",'."\n"
+ .' "userName": "user"'."\n"
+ .' },'."\n"
+ .' "status": {'."\n"
+ .' "phase": "PENDING",'."\n"
+ .' "instancePhase": "INIT",'."\n"
+ .' "createSuccess": false'."\n"
+ .' }'."\n"
+ .' },'."\n"
+ .' "requestId": "90D6B8F5-FE97-4509-9AAB-367836C51818"'."\n"
+ .' }'."\n"
+ ."\n"
+ .'For more information, see [Response struct](~~464322~~).',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'searchengine:UpdateInstance',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SearchEngine', 'resourceType' => 'Instance', 'arn' => 'acs:searchengine:{#regionId}:{#accountId}:instance/{#InstanceId}'],
+ ],
+ ],
+ ],
],
+ ],
+ 'UpdateSqlInstanceContent' => [
+ 'path' => '/openapi/ha3/instances/{instanceId}/sql-studio/databases/{database}/sql-instances/{sqlInstanceId}/content',
+ 'methods' => ['put'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
@@ -18573,68 +15632,114 @@
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
- 'operationType' => 'delete',
- 'riskType' => 'none',
- 'chargeType' => 'free',
- 'abilityTreeNodes' => [
- 'FEATUREopensearchGTRUN8',
- ],
+ 'operationType' => 'update',
+ 'abilityTreeCode' => '139112',
+ 'abilityTreeNodes' => ['FEATUREopensearch95VJR4'],
],
'parameters' => [
[
'name' => 'instanceId',
'in' => 'path',
- 'schema' => [
- 'title' => '实例ID',
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'ha-cn-pl32rf0****',
- ],
+ 'schema' => ['description' => 'The ID of the instance.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'ha-cn-pl32rf0****'],
],
[
- 'name' => 'modelName',
+ 'name' => 'database',
+ 'in' => 'path',
+ 'schema' => ['description' => 'The name of the database.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'general'],
+ ],
+ [
+ 'name' => 'sqlInstanceId',
'in' => 'path',
+ 'schema' => ['description' => 'The ID of the SQL instance.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'title' => '', 'example' => '5975'],
+ ],
+ [
+ 'name' => 'body',
+ 'in' => 'body',
+ 'style' => 'json',
'schema' => [
- 'title' => '模型的名称',
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'test',
+ 'description' => 'The request body.',
+ 'type' => 'object',
+ 'properties' => [
+ 'content' => ['description' => 'The SQL content.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'select * from test'],
+ ],
+ 'required' => false,
+ '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' => '022F36C7-9FB4-5D67-BEBC-3D14B0984463',
+ 'requestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => 'E45380E8-994A-5402-9806-F114B3295FCF'],
+ 'result' => [
+ 'title' => '',
+ 'description' => 'The data returned.',
+ 'type' => 'object',
+ 'properties' => [
+ 'gmtCreate' => ['description' => 'The time when the instance was created.', 'type' => 'string', 'title' => '', 'example' => '1719221186114'],
+ 'gmtModified' => ['description' => 'The time when the instance was last modified.', 'type' => 'string', 'title' => '', 'example' => '1719221186114'],
+ 'instanceId' => ['description' => 'The ID of the instance.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '1'],
+ 'version' => ['description' => 'The version number.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '1'],
+ 'comment' => ['description' => 'The comments.', 'type' => 'string', 'title' => '', 'example' => 'Confirm and Execute'],
+ 'relatedTemplateId' => ['description' => 'The ID of the related template.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '1'],
+ 'content' => ['description' => 'The SQL content.', 'type' => 'string', 'title' => '', 'example' => 'select * from test'],
+ 'kvpairs' => ['description' => 'The parameters in the key-value pairs.', 'type' => 'string', 'title' => '', 'example' => '{\\"trace\\":\\"INFO\\",\\"databaseName\\":\\"general\\",\\"iquan.plan.cache.enable\\":true,\\"iquan.plan.prepare.level\\":\\"jni.post.optimize\\",\\"urlencode_data\\":false,\\"formatType\\":\\"string\\",\\"timeout\\":1000}'],
+ 'dynamicParams' => ['description' => 'The dynamic parameters.', 'type' => 'string', 'title' => '', 'example' => '{\\"trace\\":\\"INFO\\",\\"databaseName\\":\\"general\\",\\"iquan.plan.cache.enable\\":true,\\"iquan.plan.prepare.level\\":\\"jni.post.optimize\\",\\"urlencode_data\\":false,\\"formatType\\":\\"string\\",\\"timeout\\":1000}'],
+ 'templateParams' => ['description' => 'The template parameters.', 'type' => 'string', 'title' => '', 'example' => '{\\"trace\\":\\"INFO\\",\\"databaseName\\":\\"general\\",\\"iquan.plan.cache.enable\\":true,\\"iquan.plan.prepare.level\\":\\"jni.post.optimize\\",\\"urlencode_data\\":false,\\"formatType\\":\\"string\\",\\"timeout\\":1000}'],
+ 'staticParams' => ['description' => 'The static parameters.', 'type' => 'string', 'title' => '', 'example' => '{\\"trace\\":\\"INFO\\",\\"databaseName\\":\\"general\\",\\"iquan.plan.cache.enable\\":true,\\"iquan.plan.prepare.level\\":\\"jni.post.optimize\\",\\"urlencode_data\\":false,\\"formatType\\":\\"string\\",\\"timeout\\":1000}'],
+ 'combineParams' => ['description' => 'The combined parameters.', 'type' => 'string', 'title' => '', 'example' => '{\\"trace\\":\\"INFO\\",\\"databaseName\\":\\"general\\",\\"iquan.plan.cache.enable\\":true,\\"iquan.plan.prepare.level\\":\\"jni.post.optimize\\",\\"urlencode_data\\":false,\\"formatType\\":\\"string\\",\\"timeout\\":1000}'],
+ ],
+ 'example' => '',
],
],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
],
+ 500 => [],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
- ],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"022F36C7-9FB4-5D67-BEBC-3D14B0984463\\"\\n}","type":"json"}]',
- ],
- 'ModifyModel' => [
- 'summary' => '修改模型详情，修改模型状态',
- 'path' => '/openapi/ha3/instances/{instanceId}/models/{modelName}',
- 'methods' => [
- 'put',
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"E45380E8-994A-5402-9806-F114B3295FCF\\",\\n \\"result\\": {\\n \\"gmtCreate\\": \\"1719221186114\\",\\n \\"gmtModified\\": \\"1719221186114\\",\\n \\"instanceId\\": 1,\\n \\"version\\": 1,\\n \\"comment\\": \\"Confirm and Execute\\",\\n \\"relatedTemplateId\\": 1,\\n \\"content\\": \\"select * from test\\",\\n \\"kvpairs\\": \\"{\\\\\\\\\\\\\\"trace\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"INFO\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"databaseName\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"general\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"iquan.plan.cache.enable\\\\\\\\\\\\\\":true,\\\\\\\\\\\\\\"iquan.plan.prepare.level\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"jni.post.optimize\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"urlencode_data\\\\\\\\\\\\\\":false,\\\\\\\\\\\\\\"formatType\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"string\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"timeout\\\\\\\\\\\\\\":1000}\\",\\n \\"dynamicParams\\": \\"{\\\\\\\\\\\\\\"trace\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"INFO\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"databaseName\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"general\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"iquan.plan.cache.enable\\\\\\\\\\\\\\":true,\\\\\\\\\\\\\\"iquan.plan.prepare.level\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"jni.post.optimize\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"urlencode_data\\\\\\\\\\\\\\":false,\\\\\\\\\\\\\\"formatType\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"string\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"timeout\\\\\\\\\\\\\\":1000}\\",\\n \\"templateParams\\": \\"{\\\\\\\\\\\\\\"trace\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"INFO\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"databaseName\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"general\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"iquan.plan.cache.enable\\\\\\\\\\\\\\":true,\\\\\\\\\\\\\\"iquan.plan.prepare.level\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"jni.post.optimize\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"urlencode_data\\\\\\\\\\\\\\":false,\\\\\\\\\\\\\\"formatType\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"string\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"timeout\\\\\\\\\\\\\\":1000}\\",\\n \\"staticParams\\": \\"{\\\\\\\\\\\\\\"trace\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"INFO\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"databaseName\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"general\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"iquan.plan.cache.enable\\\\\\\\\\\\\\":true,\\\\\\\\\\\\\\"iquan.plan.prepare.level\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"jni.post.optimize\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"urlencode_data\\\\\\\\\\\\\\":false,\\\\\\\\\\\\\\"formatType\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"string\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"timeout\\\\\\\\\\\\\\":1000}\\",\\n \\"combineParams\\": \\"{\\\\\\\\\\\\\\"trace\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"INFO\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"databaseName\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"general\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"iquan.plan.cache.enable\\\\\\\\\\\\\\":true,\\\\\\\\\\\\\\"iquan.plan.prepare.level\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"jni.post.optimize\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"urlencode_data\\\\\\\\\\\\\\":false,\\\\\\\\\\\\\\"formatType\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"string\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"timeout\\\\\\\\\\\\\\":1000}\\"\\n }\\n}","type":"json"}]',
+ 'title' => 'UpdateSqlInstanceContent',
+ 'summary' => 'Updates the content of an SQL instance.',
+ 'description' => '### Method'."\n"
+ ."\n"
+ .'```java'."\n"
+ .'PUT'."\n"
+ .'```'."\n"
+ ."\n"
+ .'### URI'."\n"
+ ."\n"
+ .'```java'."\n"
+ .'/openapi/ha3/instances/{instanceId}/sql-studio/databases/{database}/sql-instances/{sqlInstanceId}/content'."\n"
+ .'```',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateSqlInstanceContent'],
+ ],
],
- 'schemes' => [
- 'https',
+ 'ramActions' => [
+ [
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'searchengine:UpdateSqlInstanceContent',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SearchEngine', 'resourceType' => 'Instance', 'arn' => 'acs:searchengine:{#regionId}:{#accountId}:instance/{#instanceId}'],
+ ],
+ ],
+ ],
],
+ ],
+ 'UpdateSqlInstanceName' => [
+ 'path' => '/openapi/ha3/instances/{instanceId}/sql-studio/databases/{database}/sql-instances/{sqlInstanceId}/name',
+ 'methods' => ['put'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
@@ -18644,1258 +15749,1937 @@
'deprecated' => false,
'systemTags' => [
'operationType' => 'update',
- 'riskType' => 'none',
- 'chargeType' => 'free',
- 'abilityTreeNodes' => [
- 'FEATUREopensearchGTRUN8',
- ],
+ 'abilityTreeCode' => '139114',
+ 'abilityTreeNodes' => ['FEATUREopensearch95VJR4'],
],
'parameters' => [
[
'name' => 'instanceId',
'in' => 'path',
- 'schema' => [
- 'title' => '实例ID',
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'ha-cn-pl32rf0****',
- ],
+ 'schema' => ['description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'ha-cn-pl32rf0****'],
],
[
- 'name' => 'modelName',
+ 'name' => 'database',
'in' => 'path',
- 'schema' => [
- 'title' => '模型名称',
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'test',
- ],
+ 'schema' => ['description' => 'The database name.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'general'],
],
[
- 'name' => 'dryRun',
- 'in' => 'query',
- 'schema' => [
- 'title' => '是否仅执行校验，默认为False。',
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'true',
- ],
+ 'name' => 'sqlInstanceId',
+ 'in' => 'path',
+ 'schema' => ['description' => 'The SQL instance ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'title' => '', 'example' => '1'],
],
[
'name' => 'body',
'in' => 'body',
'style' => 'json',
'schema' => [
- 'description' => '',
+ 'description' => 'The request body.',
'type' => 'object',
'properties' => [
- 'content' => [
- 'description' => '',
- 'type' => 'object',
- 'properties' => [
- 'method' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'POST'."\n"
- ."\n",
- ],
- 'modelType' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'text_embedding',
- ],
- 'dimension' => [
- 'title' => '模型的维度',
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'example' => '128',
- ],
- 'request' => [
- 'description' => '',
- 'type' => 'object',
- 'properties' => [
- 'header' => [
- 'description' => '',
- 'type' => 'object',
- 'properties' => [
- 'Authorization' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'Bearer OS-v0********6vvs'."\n",
- ],
- 'Content-Type' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'application/json'."\n",
- ],
- ],
- 'required' => false,
- ],
- 'parameters' => [
- 'description' => '',
- 'type' => 'object',
- 'properties' => [
- 'build' => [
- 'description' => '',
- 'type' => 'object',
- 'properties' => [
- 'input_type' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'query'."\n",
- ],
- ],
- 'required' => false,
- ],
- 'search' => [
- 'description' => '',
- 'type' => 'object',
- 'properties' => [
- 'input_type' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'document'."\n",
- ],
- ],
- 'required' => false,
- ],
- ],
- 'required' => false,
- ],
- 'requestBody' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => '{\\"input\\": [\\"%{input}\\"], \\"input_type\\": \\"%{input_type}\\"}'."\n",
- ],
- 'urlParams' => [
- 'description' => '',
- 'type' => 'object',
- 'properties' => [
- 'build' => [
- 'description' => '',
- 'type' => 'object',
- 'required' => false,
- 'example' => 'key: value'."\n"
- ."\n",
- ],
- 'search' => [
- 'description' => '',
- 'type' => 'object',
- 'required' => false,
- 'example' => 'key: value'."\n"
- ."\n",
- ],
- ],
- 'required' => false,
- ],
- ],
- 'required' => false,
- ],
- 'response' => [
- 'description' => '',
- 'type' => 'object',
- 'properties' => [
- 'embeddings' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => '$.result.embeddings[*].embedding'."\n",
- ],
- ],
- 'required' => false,
- ],
- 'url' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'http://***.platform-cn-shanghai.opensearch.aliyuncs.com/v3/openapi/workspaces/default/text-embedding/ops-text-embedding-001',
- ],
- ],
- 'required' => false,
- ],
- 'status' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'ok',
- ],
+ 'name' => ['description' => 'The name of the SQL instance.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'test'],
],
'required' => false,
+ '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' => 'D39EE0F1-D7EF-5F46-B781-6BF4185308B0',
+ 'requestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => 'E7B7D598-B080-5C8E-AA35-D43EC0D5F886'],
+ 'result' => [
+ 'title' => '',
+ 'description' => 'The result of the request.',
+ 'type' => 'object',
+ 'properties' => [
+ 'id' => ['description' => 'The primary key ID.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '22'],
+ 'gmtCreate' => ['description' => 'The time when the instance was created.', 'type' => 'string', 'title' => '', 'example' => '1719220182844'],
+ 'gmtModified' => ['description' => 'The time when the instance was last modified.', 'type' => 'string', 'title' => '', 'example' => '1719221186114'],
+ 'name' => ['description' => 'The name of the SQL instance.', 'type' => 'string', 'title' => '', 'example' => 'general'],
+ 'parent' => ['description' => 'The parent task ID.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '-1'],
+ 'isDir' => ['description' => 'Indicates whether the item is a folder. A value of 1 indicates a folder. A value of 0 indicates that the item is not a folder.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => 'true'],
+ 'type' => ['title' => '', 'description' => 'The type of the item. Valid values: table, instance, template, and function.', 'type' => 'string', 'example' => 'instance'],
+ 'instanceId' => ['description' => 'The instance ID.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '1'],
+ 'templateId' => ['description' => 'The template ID.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '1'],
+ ],
+ 'example' => '',
],
],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
],
+ 500 => [],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
- ],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"D39EE0F1-D7EF-5F46-B781-6BF4185308B0\\"\\n}","type":"json"}]',
- ],
- 'DebugModel' => [
- 'summary' => '调试模型',
- 'path' => '/openapi/ha3/instances/{instanceId}/models/{modelName}/actions/debug',
- 'methods' => [
- 'post',
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"E7B7D598-B080-5C8E-AA35-D43EC0D5F886\\",\\n \\"result\\": {\\n \\"id\\": 22,\\n \\"gmtCreate\\": \\"1719220182844\\",\\n \\"gmtModified\\": \\"1719221186114\\",\\n \\"name\\": \\"general\\",\\n \\"parent\\": -1,\\n \\"isDir\\": 0,\\n \\"type\\": \\"instance\\",\\n \\"instanceId\\": 1,\\n \\"templateId\\": 1\\n }\\n}","type":"json"}]',
+ 'title' => 'UpdateSqlInstanceName',
+ 'summary' => 'Updates the name of an SQL instance.',
+ 'description' => '### Method'."\n"
+ ."\n"
+ .'```java'."\n"
+ .'PUT'."\n"
+ .'```'."\n"
+ ."\n"
+ .'### URI'."\n"
+ ."\n"
+ .'```java'."\n"
+ .'/openapi/ha3/instances/{instanceId}/sql-studio/databases/{database}/sql-instances/{sqlInstanceId}/name'."\n"
+ .'```',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateSqlInstanceName'],
+ ],
],
- 'schemes' => [
- 'https',
+ 'ramActions' => [
+ [
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'searchengine:UpdateSqlInstanceName',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SearchEngine', 'resourceType' => 'SqlInstance', 'arn' => 'acs:searchengine:{#regionId}:{#accountId}:instance/{#InstanceId}'],
+ ],
+ ],
+ ],
],
+ ],
+ 'UpdateSqlInstanceParams' => [
+ 'path' => '/openapi/ha3/instances/{instanceId}/sql-studio/databases/{database}/sql-instances/{sqlInstanceId}/params',
+ 'methods' => ['put'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
- 'operationType' => 'read',
+ 'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
- 'operationType' => 'get',
- 'riskType' => 'none',
- 'chargeType' => 'free',
- 'abilityTreeNodes' => [
- 'FEATUREopensearchGTRUN8',
- ],
+ 'operationType' => 'update',
+ 'abilityTreeCode' => '139113',
+ 'abilityTreeNodes' => ['FEATUREopensearch95VJR4'],
],
'parameters' => [
[
'name' => 'instanceId',
'in' => 'path',
- 'schema' => [
- 'title' => '实例ID',
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'ha-cn-pl32rf0****',
- ],
+ 'schema' => ['description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'ha-cn-pl32rf0****'],
],
[
- 'name' => 'modelName',
+ 'name' => 'database',
'in' => 'path',
- 'schema' => [
- 'title' => '模型的名称',
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'test',
- ],
+ 'schema' => ['description' => 'The database name.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'general'],
],
[
- 'name' => 'isOnline',
- 'in' => 'query',
- 'schema' => [
- 'title' => '是否在线查询，为true时使用search配置，false时使用build配置',
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'true',
- ],
+ 'name' => 'sqlInstanceId',
+ 'in' => 'path',
+ 'schema' => ['description' => 'The SQL instance ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'title' => '', 'example' => '1'],
],
[
'name' => 'body',
'in' => 'body',
'style' => 'json',
'schema' => [
- 'description' => '',
+ 'description' => 'The request body.',
'type' => 'object',
'properties' => [
- 'input' => [
- 'title' => '模型输入',
- 'description' => '',
- 'type' => 'string',
+ 'kvpair' => [
+ 'description' => 'The key-value (KV) configuration of the instance.',
+ 'type' => 'object',
+ 'required' => false,
+ 'additionalProperties' => ['type' => 'any', 'description' => 'The key-value (KV) configuration of the instance.', 'title' => '', 'example' => '{'."\n"
+ .' "trace": "INFO",'."\n"
+ .' "databaseName": "general",'."\n"
+ .' "iquan.plan.cache.enable": true,'."\n"
+ .' "iquan.plan.prepare.level": "jni.post.optimize",'."\n"
+ .' "urlencode_data": false,'."\n"
+ .' "formatType": "string",'."\n"
+ .' "timeout": 1000'."\n"
+ .'}'],
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'dynamicParam' => [
+ 'description' => 'The dynamic parameters.',
+ 'type' => 'object',
+ 'required' => false,
+ 'additionalProperties' => ['type' => 'any', 'description' => 'The dynamic parameters.', 'title' => '', 'example' => '{'."\n"
+ .' "trace": "INFO",'."\n"
+ .' "databaseName": "general",'."\n"
+ .' "iquan.plan.cache.enable": true,'."\n"
+ .' "iquan.plan.prepare.level": "jni.post.optimize",'."\n"
+ .' "urlencode_data": false,'."\n"
+ .' "formatType": "string",'."\n"
+ .' "timeout": 1000'."\n"
+ .'}'],
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'staticParam' => [
+ 'description' => 'The static parameters.',
+ 'type' => 'object',
+ 'required' => false,
+ 'additionalProperties' => ['type' => 'any', 'description' => 'The static parameters.', 'title' => '', 'example' => '{'."\n"
+ .' "trace": "INFO",'."\n"
+ .' "databaseName": "general",'."\n"
+ .' "iquan.plan.cache.enable": true,'."\n"
+ .' "iquan.plan.prepare.level": "jni.post.optimize",'."\n"
+ .' "urlencode_data": false,'."\n"
+ .' "formatType": "string",'."\n"
+ .' "timeout": 1000'."\n"
+ .'}'],
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'params' => [
+ 'description' => 'The parameters to modify.',
+ 'type' => 'object',
'required' => false,
+ 'additionalProperties' => ['type' => 'any', 'description' => 'The parameters to modify.', 'title' => '', 'example' => '{'."\n"
+ .' "trace": "INFO",'."\n"
+ .' "databaseName": "general",'."\n"
+ .' "iquan.plan.cache.enable": true,'."\n"
+ .' "iquan.plan.prepare.level": "jni.post.optimize",'."\n"
+ .' "urlencode_data": false,'."\n"
+ .' "formatType": "string",'."\n"
+ .' "timeout": 1000'."\n"
+ .'}'],
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'combineParam' => [
+ 'description' => 'The combined parameters.',
+ 'type' => 'object',
+ 'required' => false,
+ 'additionalProperties' => ['type' => 'any', 'description' => 'The combined parameters.', 'title' => '', 'example' => '{'."\n"
+ .' "trace": "INFO",'."\n"
+ .' "databaseName": "general",'."\n"
+ .' "iquan.plan.cache.enable": true,'."\n"
+ .' "iquan.plan.prepare.level": "jni.post.optimize",'."\n"
+ .' "urlencode_data": false,'."\n"
+ .' "formatType": "string",'."\n"
+ .' "timeout": 1000'."\n"
+ .'}'],
+ 'title' => '',
'example' => '',
],
],
'required' => false,
+ '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' => 'E7B7D598-B080-5C8E-AA35-D43EC0D5F886',
+ 'requestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '022F36C7-9FB4-5D67-BEBC-3D14B0984463'],
+ 'result' => [
+ 'title' => '',
+ 'description' => 'The returned result.',
+ 'type' => 'object',
+ 'properties' => [
+ 'gmtCreate' => ['description' => 'The time when the instance was created.', 'type' => 'string', 'title' => '', 'example' => '1719221186114'],
+ 'gmtModified' => ['description' => 'The time when the instance was last modified.', 'type' => 'string', 'title' => '', 'example' => '1719220182844'],
+ 'instanceId' => ['description' => 'The instance ID.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '1'],
+ 'version' => ['description' => 'The version number.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '1'],
+ 'comment' => ['description' => 'The comments.', 'type' => 'string', 'title' => '', 'example' => 'Confirm and Execute'],
+ 'relatedTemplateId' => ['description' => 'The template ID.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '1'],
+ 'content' => ['description' => 'The content.', 'type' => 'string', 'title' => '', 'example' => 'select * from test'],
+ 'kvpairs' => ['description' => 'The KV parameters.', 'type' => 'string', 'title' => '', 'example' => '{\\"trace\\":\\"INFO\\",\\"databaseName\\":\\"general\\",\\"iquan.plan.cache.enable\\":true,\\"iquan.plan.prepare.level\\":\\"jni.post.optimize\\",\\"urlencode_data\\":false,\\"formatType\\":\\"string\\",\\"timeout\\":1000}'],
+ 'dynamicParams' => ['description' => 'The dynamic parameters.', 'type' => 'string', 'title' => '', 'example' => '{\\"trace\\":\\"INFO\\",\\"databaseName\\":\\"general\\",\\"iquan.plan.cache.enable\\":true,\\"iquan.plan.prepare.level\\":\\"jni.post.optimize\\",\\"urlencode_data\\":false,\\"formatType\\":\\"string\\",\\"timeout\\":1000}'],
+ 'templateParams' => ['description' => 'The template parameters.', 'type' => 'string', 'title' => '', 'example' => '{\\"trace\\":\\"INFO\\",\\"databaseName\\":\\"general\\",\\"iquan.plan.cache.enable\\":true,\\"iquan.plan.prepare.level\\":\\"jni.post.optimize\\",\\"urlencode_data\\":false,\\"formatType\\":\\"string\\",\\"timeout\\":1000}'],
+ 'staticParams' => ['description' => 'The static parameters.', 'type' => 'string', 'title' => '', 'example' => '{\\"trace\\":\\"INFO\\",\\"databaseName\\":\\"general\\",\\"iquan.plan.cache.enable\\":true,\\"iquan.plan.prepare.level\\":\\"jni.post.optimize\\",\\"urlencode_data\\":false,\\"formatType\\":\\"string\\",\\"timeout\\":1000}'],
+ 'combineParams' => ['description' => 'The combined parameters.', 'type' => 'string', 'title' => '', 'example' => '{\\"trace\\":\\"INFO\\",\\"databaseName\\":\\"general\\",\\"iquan.plan.cache.enable\\":true,\\"iquan.plan.prepare.level\\":\\"jni.post.optimize\\",\\"urlencode_data\\":false,\\"formatType\\":\\"string\\",\\"timeout\\":1000}'],
+ ],
+ 'example' => '',
],
],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
],
+ 500 => [],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"022F36C7-9FB4-5D67-BEBC-3D14B0984463\\",\\n \\"result\\": {\\n \\"gmtCreate\\": \\"1719221186114\\",\\n \\"gmtModified\\": \\"1719220182844\\",\\n \\"instanceId\\": 1,\\n \\"version\\": 1,\\n \\"comment\\": \\"Confirm and Execute\\",\\n \\"relatedTemplateId\\": 1,\\n \\"content\\": \\"select * from test\\",\\n \\"kvpairs\\": \\"{\\\\\\\\\\\\\\"trace\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"INFO\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"databaseName\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"general\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"iquan.plan.cache.enable\\\\\\\\\\\\\\":true,\\\\\\\\\\\\\\"iquan.plan.prepare.level\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"jni.post.optimize\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"urlencode_data\\\\\\\\\\\\\\":false,\\\\\\\\\\\\\\"formatType\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"string\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"timeout\\\\\\\\\\\\\\":1000}\\",\\n \\"dynamicParams\\": \\"{\\\\\\\\\\\\\\"trace\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"INFO\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"databaseName\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"general\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"iquan.plan.cache.enable\\\\\\\\\\\\\\":true,\\\\\\\\\\\\\\"iquan.plan.prepare.level\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"jni.post.optimize\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"urlencode_data\\\\\\\\\\\\\\":false,\\\\\\\\\\\\\\"formatType\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"string\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"timeout\\\\\\\\\\\\\\":1000}\\",\\n \\"templateParams\\": \\"{\\\\\\\\\\\\\\"trace\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"INFO\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"databaseName\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"general\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"iquan.plan.cache.enable\\\\\\\\\\\\\\":true,\\\\\\\\\\\\\\"iquan.plan.prepare.level\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"jni.post.optimize\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"urlencode_data\\\\\\\\\\\\\\":false,\\\\\\\\\\\\\\"formatType\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"string\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"timeout\\\\\\\\\\\\\\":1000}\\",\\n \\"staticParams\\": \\"{\\\\\\\\\\\\\\"trace\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"INFO\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"databaseName\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"general\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"iquan.plan.cache.enable\\\\\\\\\\\\\\":true,\\\\\\\\\\\\\\"iquan.plan.prepare.level\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"jni.post.optimize\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"urlencode_data\\\\\\\\\\\\\\":false,\\\\\\\\\\\\\\"formatType\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"string\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"timeout\\\\\\\\\\\\\\":1000}\\",\\n \\"combineParams\\": \\"{\\\\\\\\\\\\\\"trace\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"INFO\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"databaseName\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"general\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"iquan.plan.cache.enable\\\\\\\\\\\\\\":true,\\\\\\\\\\\\\\"iquan.plan.prepare.level\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"jni.post.optimize\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"urlencode_data\\\\\\\\\\\\\\":false,\\\\\\\\\\\\\\"formatType\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"string\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"timeout\\\\\\\\\\\\\\":1000}\\"\\n }\\n}","type":"json"}]',
+ 'title' => 'UpdateSqlInstanceParams',
+ 'summary' => 'Updates the parameters of an SQL instance.',
+ 'description' => '### Method'."\n"
+ ."\n"
+ .'```java'."\n"
+ .'PUT'."\n"
+ .'```'."\n"
+ ."\n"
+ .'### URI'."\n"
+ ."\n"
+ .'```java'."\n"
+ .'/openapi/ha3/instances/{instanceId}/sql-studio/databases/{database}/sql-instances/{sqlInstanceId}/params'."\n"
+ .'```',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateSqlInstanceParams'],
+ ],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'searchengine:UpdateSqlInstanceParams',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SearchEngine', 'resourceType' => 'Instance', 'arn' => 'acs:searchengine:{#regionId}:{#accountId}:instance/{#instanceId}'],
+ ],
+ ],
+ ],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"E7B7D598-B080-5C8E-AA35-D43EC0D5F886\\"\\n}","type":"json"}]',
],
- 'GetModel' => [
- 'summary' => '通过实例ID和模型名称查询特定模型的详细配置信息。',
- 'description' => '## 请求说明'."\n"
- .'- 该API用于获取指定实例下的特定模型的详细信息，包括模型类型、URL、状态等。'."\n"
- .'- 确保提供的`instanceId`和`modelName`是有效的，否则可能返回错误或找不到资源。'."\n"
- .'- 返回的数据结构中包含了模型的内容（如请求头、参数等）以及创建和更新时间，有助于了解模型的具体配置及其最新状态。'."\n",
- 'path' => '/openapi/ha3/instances/{instanceId}/models/{modelName}',
- 'methods' => [
- 'get',
+ ],
+ 'endpoints' => [
+ ['regionId' => 'ap-southeast-1', 'regionName' => 'Singapore', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'searchengine.ap-southeast-1.aliyuncs.com', 'endpoint' => 'searchengine.ap-southeast-1.aliyuncs.com', 'vpc' => 'searchengine-vpc.ap-southeast-1.aliyuncs.com'],
+ ['regionId' => 'cn-beijing', 'regionName' => 'China (Beijing)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'searchengine.cn-beijing.aliyuncs.com', 'endpoint' => 'searchengine.cn-beijing.aliyuncs.com', 'vpc' => 'searchengine-vpc.cn-beijing.aliyuncs.com'],
+ ['regionId' => 'cn-hangzhou', 'regionName' => 'China (Hangzhou)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'searchengine.cn-hangzhou.aliyuncs.com', 'endpoint' => 'searchengine.cn-hangzhou.aliyuncs.com', 'vpc' => 'searchengine-vpc.cn-hangzhou.aliyuncs.com'],
+ ['regionId' => 'cn-shanghai', 'regionName' => 'China (Shanghai)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'searchengine.cn-shanghai.aliyuncs.com', 'endpoint' => 'searchengine.cn-shanghai.aliyuncs.com', 'vpc' => 'searchengine-vpc.cn-shanghai.aliyuncs.com'],
+ ['regionId' => 'cn-shenzhen', 'regionName' => 'China (Shenzhen)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'searchengine.cn-shenzhen.aliyuncs.com', 'endpoint' => 'searchengine.cn-shenzhen.aliyuncs.com', 'vpc' => 'searchengine-vpc.cn-shenzhen.aliyuncs.com'],
+ ['regionId' => 'cn-hongkong', 'regionName' => 'China (Hong Kong)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'searchengine.cn-hongkong.aliyuncs.com', 'endpoint' => 'searchengine.cn-hongkong.aliyuncs.com', 'vpc' => ''],
+ ['regionId' => 'cn-zhangjiakou', 'regionName' => 'China (Zhangjiakou)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'searchengine.cn-zhangjiakou.aliyuncs.com', 'endpoint' => 'searchengine.cn-zhangjiakou.aliyuncs.com', 'vpc' => ''],
+ ['regionId' => 'eu-central-1', 'regionName' => 'Germany (Frankfurt)', 'areaId' => 'europeAmerica', 'areaName' => 'Europe & Americas', 'public' => 'searchengine.eu-central-1.aliyuncs.com', 'endpoint' => 'searchengine.eu-central-1.aliyuncs.com', 'vpc' => ''],
+ ],
+ 'errorCodes' => [
+ ['code' => 'ClusterConflict', 'message' => 'cluster conflict', 'http_code' => 400, 'description' => 'A cluster conflict occurred.'],
+ ['code' => 'ClusterInitializing', 'message' => 'cluster initializing', 'http_code' => 400, 'description' => 'The cluster is being initialized.'],
+ ['code' => 'ClusterMinCount', 'message' => 'cluster min count', 'http_code' => 400, 'description' => 'The number of clusters must meet the least requirement.'],
+ ['code' => 'ClusterNoIndex', 'message' => 'cluster has not index', 'http_code' => 400, 'description' => 'No indexes have been loaded to the cluster.'],
+ ['code' => 'ClusterNotExist', 'message' => 'cluster not exist', 'http_code' => 400, 'description' => 'The cluster is not found.'],
+ ['code' => 'ConfigInUse', 'message' => 'config in use', 'http_code' => 400, 'description' => 'The configuration is in use.'],
+ ['code' => 'ConfigPublishTaskRunning', 'message' => 'config publish task running', 'http_code' => 400, 'description' => 'A configuration publish task is in progress.'],
+ ['code' => 'DataNodeNotEnough', 'message' => 'data node not enough', 'http_code' => 400, 'description' => 'Insufficient data nodes.'],
+ ['code' => 'DataSourceConflict', 'message' => 'data source conflict', 'http_code' => 400, 'description' => 'A data source conflict occurred.'],
+ ['code' => 'DataSourceCreating', 'message' => 'data source creating', 'http_code' => 400, 'description' => 'A process for creating data sources is still in progress.'],
+ ['code' => 'DataSourceExceed', 'message' => 'data source exceed', 'http_code' => 400, 'description' => 'The data source has exceeded the limit.'],
+ ['code' => 'DataSourceHasExist', 'message' => 'data source has exist', 'http_code' => 400, 'description' => 'The data source already exists.'],
+ ['code' => 'DataSourceIndexCreating', 'message' => 'data source index creating', 'http_code' => 400, 'description' => 'A process of creating indexes for the data source is still in progress.'],
+ ['code' => 'DataSourceInfoInvalid', 'message' => 'data source info invalid', 'http_code' => 400, 'description' => 'Invalid data source information.'],
+ ['code' => 'DataSourceNameInvalid', 'message' => 'data source name invalid', 'http_code' => 400, 'description' => 'Invalid data source name.'],
+ ['code' => 'DataSourceNotExist', 'message' => 'data source not exist', 'http_code' => 400, 'description' => 'The data source is not found.'],
+ ['code' => 'DataSourcePartitionNotExist', 'message' => 'data source partition not exist', 'http_code' => 400, 'description' => 'The data source partition is not found.'],
+ ['code' => 'FetchTisBackendError', 'message' => 'fetch tis backend error', 'http_code' => 400, 'description' => 'A backend error occurred while obtaining tis.'],
+ ['code' => 'FetchTisNotExistError', 'message' => 'fetch tis not exist error', 'http_code' => 400, 'description' => 'tis is not found.'],
+ ['code' => 'FileNotExist', 'message' => 'file not exist', 'http_code' => 400, 'description' => 'The file is not found.'],
+ ['code' => 'ha3.DownGradeForbiddenLessNode', 'message' => 'down grade forbidden less node', 'http_code' => 400, 'description' => 'At least one node must be retained after scale-down.'],
+ ['code' => 'ha3.DownGradeForbiddenWhenBuildIndex', 'message' => 'down grade forbidden when build index', 'http_code' => 400, 'description' => 'Scale-down is not allowed while an index is being created.'],
+ ['code' => 'ha3.DownGradeForbiddenWhenUpdating', 'message' => 'down grade forbidden when updating', 'http_code' => 400, 'description' => 'Scale-down is not allowed while an update is in progress.'],
+ ['code' => 'ha3.DownGradeInvalidSpec', 'message' => 'down grade invalid spec', 'http_code' => 400, 'description' => 'The specifications after scale-down are invalid.'],
+ ['code' => 'ha3.InstanceExit', 'message' => 'Instance exit', 'http_code' => 400, 'description' => 'The instance is not found.'],
+ ['code' => 'ha3.InstanceNotExit', 'message' => 'instance not exit', 'http_code' => 400, 'description' => 'The instance is not found.'],
+ ['code' => 'ha3.InvalidContainerSpec', 'message' => 'Invalid containerSpec', 'http_code' => 400, 'description' => 'Invalid configuration.'],
+ ['code' => 'ha3.InvalidOrderType', 'message' => 'invalid order type', 'http_code' => 400, 'description' => 'Invalid order type.'],
+ ['code' => 'ha3.UpgradeInvalidSpec', 'message' => 'upgrade spec is invalid', 'http_code' => 400, 'description' => 'The specifications after scale-up are invalid.'],
+ ['code' => 'ha3.VpcEmpty', 'message' => 'vpc Empty', 'http_code' => 400, 'description' => 'A VPC must be specified.'],
+ ['code' => 'IndexAlreadyExist', 'message' => 'index alredy exist', 'http_code' => 400, 'description' => 'The index already exists.'],
+ ['code' => 'IndexExceed', 'message' => 'index exceed', 'http_code' => 400, 'description' => 'The maximum number of indexes for data sources has been exceeded.'],
+ ['code' => 'IndexInUse', 'message' => 'index in use', 'http_code' => 400, 'description' => 'The index is in use.'],
+ ['code' => 'IndexSchemaInvalid', 'message' => 'index schema invalid', 'http_code' => 400, 'description' => 'Invalid index schema.'],
+ ['code' => 'InstanceInit', 'message' => 'instance is initing', 'http_code' => 400, 'description' => 'The instance is being created.'],
+ ['code' => 'InstanceNotExist', 'message' => 'instance not exit', 'http_code' => 400, 'description' => 'The instance is not found.'],
+ ['code' => 'InternalServerError', 'message' => 'internal server error', 'http_code' => 400, 'description' => 'An internal server error occurred.'],
+ ['code' => 'InvalidDataSourceType', 'message' => 'data source type is invalid', 'http_code' => 400, 'description' => 'Invalid data source type.'],
+ ['code' => 'InvalidOrder', 'message' => 'invalid order', 'http_code' => 400, 'description' => 'Invalid order.'],
+ ['code' => 'InvalidParameter', 'message' => 'invalid parameter', 'http_code' => 400, 'description' => 'Invalid parameter.'],
+ ['code' => 'InvalidParameter', 'message' => 'invalid parameter.', 'http_code' => 400, 'description' => 'invalid parameter.'],
+ ['code' => 'InvalidRequestParameter', 'message' => 'invalid request parameter', 'http_code' => 400, 'description' => 'Invalid request parameter.'],
+ ['code' => 'LackDataNode', 'message' => 'lack data node', 'http_code' => 400, 'description' => 'Insufficient data node resources.'],
+ ['code' => 'LackQueryNode', 'message' => 'lack query node', 'http_code' => 400, 'description' => 'Insufficient search node resources.'],
+ ['code' => 'NodeNotExist', 'message' => 'node not exist', 'http_code' => 400, 'description' => 'The node is not found.'],
+ ['code' => 'NoExistCluster', 'message' => 'no exist cluster', 'http_code' => 400, 'description' => 'No clusters exist.'],
+ ['code' => 'QueryNodeNotExist', 'message' => 'query node not exist', 'http_code' => 400, 'description' => 'The search node is not found.'],
+ ['code' => 'QuerySearchEngineError', 'message' => 'query search engine error', 'http_code' => 400, 'description' => 'An error occurred while querying the search engine.'],
+ ['code' => 'UserNotExist', 'message' => 'user not exist', 'http_code' => 400, 'description' => 'The user is not found.'],
+ ],
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetIndexOnlineStrategy'],
+ ['threshold' => '-1', 'countWindow' => 1, 'regionId' => '*'],
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateSqlInstanceParams'],
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListDataSourceTasks'],
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteFolder'],
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateSqlInstance'],
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ModifyPausePolicy'],
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteSqlInstance'],
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListAdvanceConfigDir'],
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetNodeConfig'],
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListClusterNames'],
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ModifyClusterOfflineConfig'],
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ModifyDataSourceDeploy'],
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ModifyOnlineConfig'],
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ModifyIndexOnlineStrategy'],
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListQueryResult'],
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateSqlInstanceContent'],
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetIndex'],
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetDataSourceDeploy'],
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListAdvanceConfigs'],
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetClusterRunTimeInfo'],
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetDeployGraph'],
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListOnlineConfigs'],
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListClusterTasks'],
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListClusters'],
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListRestQueryResult'],
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListDataSourceSchemas'],
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ExecuteSqlInstance'],
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetFile'],
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteDataSource'],
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ModifyAdvanceConfig'],
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'RemoveCluster'],
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteIndexVersion'],
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateFolder'],
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetAdvanceConfigFile'],
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetSqlInstance'],
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'RenameFolder'],
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'RecoverIndex'],
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ChangeResourceGroup'],
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetCluster'],
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ModifyIndexPartition'],
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteInstance'],
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ModifyPublicUrlIpList'],
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetDataSource'],
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ModifyIndexVersion'],
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteAdvanceConfig'],
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ModifyFile'],
+ ['threshold' => '3', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateInstance'],
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListDatabases'],
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteIndex'],
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListInstances'],
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListPausePolicys'],
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateSqlInstanceName'],
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'PublishIndexVersion'],
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ModifyClusterOnlineConfig'],
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CloneSqlInstance'],
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'BuildIndex'],
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetAdvanceConfig'],
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetInstance'],
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListIndexes'],
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListInstanceSpecs'],
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetDatabaseSchema'],
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeletePublicUrl'],
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateDataSource'],
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateIndex'],
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'StopTask'],
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ModifyNodeConfig'],
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListDateSourceGenerations'],
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetIndexVersion'],
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreatePublicUrl'],
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ModifyClusterDesc'],
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ModifyAdvanceConfigFile'],
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'PublishAdvanceConfig'],
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ForceSwitch'],
+ ],
+ ],
+ 'ram' => [
+ 'productCode' => 'SearchEngine',
+ 'productName' => 'Open Search',
+ 'ramCodes' => ['searchengine'],
+ 'ramLevel' => 'RESOURCE',
+ 'ramConditions' => [],
+ 'ramActions' => [
+ [
+ 'apiName' => 'GetDataSourceDeploy',
+ 'description' => '',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'searchengine:GetDataSourceDeploy',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SearchEngine', 'resourceType' => 'Instance', 'arn' => 'acs:searchengine:{#regionId}:{#accountId}:instance/{#instanceId}'],
+ ],
+ ],
],
- 'schemes' => [
- 'https',
+ [
+ 'apiName' => 'CreateConfigFile',
+ 'description' => '',
+ 'operationType' => '',
+ 'ramAction' => [
+ 'action' => 'searchengine:CreateConfigFile',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SearchEngine', 'resourceType' => 'Instance', 'arn' => 'acs:searchengine:{#regionId}:{#accountId}:instance/{#InstanceId}'],
+ ],
+ ],
],
- 'security' => [
- [
- 'AK' => [],
+ [
+ 'apiName' => 'CreateFolder',
+ 'description' => '',
+ 'operationType' => 'create',
+ 'ramAction' => [
+ 'action' => 'searchengine:CreateFolder',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SearchEngine', 'resourceType' => 'Folder', 'arn' => 'acs:searchengine:{#regionId}:{#accountId}:instance/{#InstanceId}'],
+ ],
],
],
- 'operationType' => 'read',
- 'deprecated' => false,
- 'systemTags' => [
+ [
+ 'apiName' => 'UpdateSqlInstanceContent',
+ 'description' => '',
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'searchengine:UpdateSqlInstanceContent',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SearchEngine', 'resourceType' => 'Instance', 'arn' => 'acs:searchengine:{#regionId}:{#accountId}:instance/{#instanceId}'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'ModifyPassword',
+ 'description' => '',
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'searchengine:ModifyPassword',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SearchEngine', 'resourceType' => 'Instance', 'arn' => 'acs:searchengine:{#regionId}:{#accountId}:instance/{#InstanceId}'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'GetNodeConfig',
+ 'description' => '',
'operationType' => 'get',
- 'riskType' => 'none',
- 'chargeType' => 'free',
- 'abilityTreeNodes' => [
- 'FEATUREopensearchGTRUN8',
+ 'ramAction' => [
+ 'action' => 'searchengine:GetNodeConfig',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SearchEngine', 'resourceType' => 'Instance', 'arn' => 'acs:searchengine:{#regionId}:{#accountId}:instance/{#InstanceId}'],
+ ],
],
],
- 'parameters' => [
- [
- 'name' => 'instanceId',
- 'in' => 'path',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'ha-cn-pl32rf0****',
+ [
+ 'apiName' => 'DeleteModel',
+ 'description' => '',
+ 'operationType' => 'delete',
+ 'ramAction' => [
+ 'action' => 'searchengine:DeleteModel',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SearchEngine', 'resourceType' => 'Instance', 'arn' => 'acs:searchengine:{#regionId}:{#accountId}:instance/{#InstanceId}'],
],
],
- [
- 'name' => 'modelName',
- 'in' => 'path',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'test',
+ ],
+ [
+ 'apiName' => 'ListInstanceSpecs',
+ 'description' => '',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'searchengine:ListInstanceSpecs',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SearchEngine', 'resourceType' => 'Instance', 'arn' => 'acs:searchengine:{#regionId}:{#accountId}:instance/{#instanceId}'],
],
],
],
- 'responses' => [
- 200 => [
- 'description' => '查询成功',
- 'schema' => [
- 'title' => 'Schema of Response',
- 'description' => 'Schema of Response',
- 'type' => 'object',
- 'properties' => [
- 'requestId' => [
- 'title' => '请求ID'."\n",
- 'description' => '',
- 'type' => 'string',
- 'example' => '38b079f1-7846-4226-8c90-3e2644b5c52b',
- ],
- 'result' => [
- 'title' => '模型配置信息',
- 'description' => '',
- 'type' => 'object',
- 'properties' => [
- 'name' => [
- 'title' => '模型名称',
- 'description' => '',
- 'type' => 'string',
- 'example' => 'test',
- ],
- 'type' => [
- 'title' => '模型类型。'."\n"
- .' * text_embedding: 文本嵌入模型',
- 'description' => '',
- 'type' => 'string',
- 'enumValueTitles' => [
- 'text_embedding' => '',
- 'image_embedding' => '',
- 'image_analyze' => '',
- 'text_sparse_embedding' => '',
- ],
- 'example' => 'text_embedding',
- 'enum' => [
- 'text_embedding',
- ],
- ],
- 'url' => [
- 'title' => '模型访问URL',
- 'description' => '',
- 'type' => 'string',
- 'example' => 'http://***.platform-cn-shanghai.opensearch.aliyuncs.com/v3/openapi/workspaces/default/text-embedding/ops-text-embedding-001',
- ],
- 'status' => [
- 'title' => '模型状态。'."\n"
- .' * ok: 模型正常'."\n"
- .' * error: 模型异常',
- 'description' => '',
- 'type' => 'string',
- 'example' => 'ok',
- 'enum' => [
- 'ok',
- 'error',
- ],
- ],
- 'dimension' => [
- 'title' => '模型的维度',
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '128',
- ],
- 'content' => [
- 'title' => '模型配置信息',
- 'description' => '',
- 'type' => 'object',
- 'properties' => [
- 'modelName' => [
- 'title' => '模型名称',
- 'description' => '',
- 'type' => 'string',
- 'example' => 'test',
- ],
- 'modelType' => [
- 'title' => '模型类型。'."\n"
- .' * text_embedding: 文本嵌入模型',
- 'description' => '',
- 'type' => 'string',
- 'enumValueTitles' => [],
- 'example' => 'text_embedding',
- 'enum' => [
- 'text_embedding',
- ],
- ],
- 'url' => [
- 'title' => '模型访问URL',
- 'description' => '',
- 'type' => 'string',
- 'example' => 'http://***.platform-cn-shanghai.opensearch.aliyuncs.com/v3/openapi/workspaces/default/text-embedding/ops-text-embedding-001',
- ],
- 'method' => [
- 'title' => '请求方法',
- 'description' => '',
- 'type' => 'string',
- 'example' => 'POST',
- ],
- 'request' => [
- 'title' => '请求配置信息',
- 'description' => '',
- 'type' => 'object',
- 'properties' => [
- 'header' => [
- 'title' => 'HTTP请求头',
- 'description' => '',
- 'type' => 'object',
- 'properties' => [
- 'Authorization' => [
- 'title' => '授权令牌',
- 'description' => '',
- 'type' => 'string',
- 'example' => 'Bearer OS-v0********6vvs'."\n",
- ],
- 'Content-Type' => [
- 'title' => '内容类型',
- 'description' => '',
- 'type' => 'string',
- 'example' => 'application/json'."\n",
- ],
- ],
- ],
- 'urlParams' => [
- 'title' => 'URL参数',
- 'description' => '',
- 'type' => 'object',
- 'properties' => [
- 'build' => [
- 'description' => '',
- 'type' => 'object',
- 'example' => 'key: value'."\n",
- ],
- 'search' => [
- 'description' => '',
- 'type' => 'object',
- 'example' => 'key: value',
- ],
- ],
- ],
- 'requestBody' => [
- 'title' => '请求体模板',
- 'description' => '',
- 'type' => 'string',
- 'example' => '{\\"input\\": [\\"%{input}\\"], \\"input_type\\": \\"%{input_type}\\"}'."\n",
- ],
- 'parameters' => [
- 'title' => '请求参数',
- 'description' => '',
- 'type' => 'object',
- 'properties' => [
- 'build' => [
- 'title' => '构建时的请求参数',
- 'description' => '',
- 'type' => 'object',
- 'properties' => [
- 'input_type' => [
- 'title' => '输入类型。'."\n"
- .' * document: 文档',
- 'description' => '',
- 'type' => 'string',
- 'example' => 'query'."\n",
- 'enum' => [
- 'document',
- ],
- ],
- ],
- ],
- 'search' => [
- 'title' => '搜索时的请求参数',
- 'description' => '',
- 'type' => 'object',
- 'properties' => [
- 'input_type' => [
- 'title' => '输入类型。'."\n"
- .' * query: 查询',
- 'description' => '',
- 'type' => 'string',
- 'example' => 'document'."\n",
- 'enum' => [
- 'query',
- ],
- ],
- ],
- ],
- ],
- ],
- ],
- ],
- 'response' => [
- 'description' => '',
- 'type' => 'object',
- 'properties' => [
- 'embeddings' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '$.result.embeddings[*].embedding'."\n",
- ],
- ],
- ],
- ],
- ],
- 'createTime' => [
- 'title' => '创建时间',
- 'description' => '',
- 'type' => 'string',
- 'example' => '2024-05-21 16:05:26',
- ],
- 'updateTime' => [
- 'title' => '修改时间',
- 'description' => '',
- 'type' => 'string',
- 'example' => '2024-05-21 16:05:26',
- ],
- ],
- ],
- ],
+ [
+ 'apiName' => 'ListLogs',
+ 'description' => '',
+ 'operationType' => 'list',
+ 'ramAction' => [
+ 'action' => 'searchengine:ListLogs',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SearchEngine', 'resourceType' => 'Instance', 'arn' => 'acs:searchengine:{#regionId}:{#accountId}:instance/{#InstanceId}'],
],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
+ [
+ 'apiName' => 'ModifySearcherReplica',
+ 'description' => '',
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'searchengine:ModifySearcherReplica',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SearchEngine', 'resourceType' => 'Instance', 'arn' => 'acs:searchengine:{#regionId}:{#accountId}:instance/{#InstanceId}'],
+ ],
+ ],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"38b079f1-7846-4226-8c90-3e2644b5c52b\\",\\n \\"result\\": {\\n \\"name\\": \\"test\\",\\n \\"type\\": \\"text_embedding\\",\\n \\"url\\": \\"http://***.platform-cn-shanghai.opensearch.aliyuncs.com/v3/openapi/workspaces/default/text-embedding/ops-text-embedding-001\\",\\n \\"status\\": \\"ok\\",\\n \\"dimension\\": 128,\\n \\"content\\": {\\n \\"modelName\\": \\"test\\",\\n \\"modelType\\": \\"text_embedding\\",\\n \\"url\\": \\"http://***.platform-cn-shanghai.opensearch.aliyuncs.com/v3/openapi/workspaces/default/text-embedding/ops-text-embedding-001\\",\\n \\"method\\": \\"POST\\",\\n \\"request\\": {\\n \\"header\\": {\\n \\"Authorization\\": \\"Bearer OS-v0********6vvs\\\\n\\",\\n \\"Content-Type\\": \\"application/json\\\\n\\"\\n },\\n \\"urlParams\\": {\\n \\"build\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n },\\n \\"search\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n }\\n },\\n \\"requestBody\\": \\"{\\\\\\\\\\\\\\"input\\\\\\\\\\\\\\": [\\\\\\\\\\\\\\"%{input}\\\\\\\\\\\\\\"], \\\\\\\\\\\\\\"input_type\\\\\\\\\\\\\\": \\\\\\\\\\\\\\"%{input_type}\\\\\\\\\\\\\\"}\\\\n\\",\\n \\"parameters\\": {\\n \\"build\\": {\\n \\"input_type\\": \\"query\\\\n\\"\\n },\\n \\"search\\": {\\n \\"input_type\\": \\"document\\\\n\\"\\n }\\n }\\n },\\n \\"response\\": {\\n \\"embeddings\\": \\"$.result.embeddings[*].embedding\\\\n\\"\\n }\\n },\\n \\"createTime\\": \\"2024-05-21 16:05:26\\",\\n \\"updateTime\\": \\"2024-05-21 16:05:26\\"\\n }\\n}","type":"json"}]',
- ],
- 'ListModels' => [
- 'summary' => '通过实例ID查询指定条件下的模型列表。',
- 'description' => '## 请求说明'."\n"
- .'本API用于从指定实例中获取模型列表，支持通过模型名称、类型以及分页参数进行筛选。请求时需提供实例ID作为路径参数，其他筛选条件为可选的查询参数。'."\n",
- 'path' => '/openapi/ha3/instances/{instanceId}/models',
- 'methods' => [
- 'get',
+ [
+ 'apiName' => 'ForceSwitch',
+ 'description' => '',
+ 'operationType' => '',
+ 'ramAction' => [
+ 'action' => 'searchengine:ForceSwitch',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SearchEngine', 'resourceType' => 'Instance', 'arn' => 'acs:searchengine:{#regionId}:{#accountId}:instance/{#InstanceId}'],
+ ],
+ ],
],
- 'schemes' => [
- 'https',
+ [
+ 'apiName' => 'ListDateSourceGenerations',
+ 'description' => '',
+ 'operationType' => 'list',
+ 'ramAction' => [
+ 'action' => 'searchengine:ListDateSourceGenerations',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SearchEngine', 'resourceType' => 'Instance', 'arn' => 'acs:searchengine:{#regionId}:{#accountId}:instance/{#instanceId}'],
+ ],
+ ],
],
- 'security' => [
- [
- 'AK' => [],
+ [
+ 'apiName' => 'DeleteAdvanceConfig',
+ 'description' => '',
+ 'operationType' => '',
+ 'ramAction' => [
+ 'action' => 'searchengine:DeleteAdvanceConfig',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SearchEngine', 'resourceType' => 'Instance', 'arn' => 'acs:searchengine:{#regionId}:{#accountId}:instance/{#InstanceId}'],
+ ],
],
],
- 'operationType' => 'read',
- 'deprecated' => false,
- 'systemTags' => [
+ [
+ 'apiName' => 'ListAdvanceConfigs',
+ 'description' => '',
'operationType' => 'list',
- 'riskType' => 'none',
- 'chargeType' => 'free',
- 'abilityTreeNodes' => [
- 'FEATUREopensearchGTRUN8',
+ 'ramAction' => [
+ 'action' => 'searchengine:ListAdvanceConfigs',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SearchEngine', 'resourceType' => 'Instance', 'arn' => 'acs:searchengine:{#regionId}:{#accountId}:instance/{#InstanceId}'],
+ ],
],
],
- 'parameters' => [
- [
- 'name' => 'instanceId',
- 'in' => 'path',
- 'schema' => [
- 'title' => '实例ID'."\n",
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'ha-cn-test',
+ [
+ 'apiName' => 'GetAdvanceConfigFile',
+ 'description' => '',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'searchengine:GetAdvanceConfigFile',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SearchEngine', 'resourceType' => 'Instance', 'arn' => 'acs:searchengine:{#regionId}:{#accountId}:instance/{#InstanceId}'],
],
],
- [
- 'name' => 'name',
- 'in' => 'query',
- 'schema' => [
- 'title' => '模型名称'."\n",
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'test1',
+ ],
+ [
+ 'apiName' => 'DeleteTable',
+ 'description' => '',
+ 'operationType' => 'delete',
+ 'ramAction' => [
+ 'action' => 'searchengine:DeleteTable',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SearchEngine', 'resourceType' => 'Instance', 'arn' => 'acs:searchengine:{#regionId}:{#accountId}:instance/{#InstanceId}'],
],
],
- [
- 'name' => 'type',
- 'in' => 'query',
- 'schema' => [
- 'title' => '模型类别'."\n",
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'text_embedding',
+ ],
+ [
+ 'apiName' => 'ModifyDataSourceDeploy',
+ 'description' => '',
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'searchengine:ModifyDataSourceDeploy',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SearchEngine', 'resourceType' => 'Instance', 'arn' => 'acs:searchengine:{#regionId}:{#accountId}:instance/{#instanceId}'],
],
],
- [
- 'name' => 'pageNumber',
- 'in' => 'query',
- 'schema' => [
- 'title' => '页数，默认为1'."\n",
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'example' => '1',
+ ],
+ [
+ 'apiName' => 'ModifyAlias',
+ 'description' => '',
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'searchengine:ModifyAlias',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SearchEngine', 'resourceType' => 'Instance', 'arn' => 'acs:searchengine:{#regionId}:{#accountId}:instance/{#InstanceId}'],
],
],
- [
- 'name' => 'pageSize',
- 'in' => 'query',
- 'schema' => [
- 'title' => '每页显示条数，默认为10'."\n",
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'example' => '10',
+ ],
+ [
+ 'apiName' => 'DeleteConfigDir',
+ 'description' => '',
+ 'operationType' => '',
+ 'ramAction' => [
+ 'action' => 'searchengine:DeleteConfigDir',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SearchEngine', 'resourceType' => 'Instance', 'arn' => 'acs:searchengine:{#regionId}:{#accountId}:instance/{#InstanceId}'],
],
],
],
- 'responses' => [
- 200 => [
- 'description' => '查询成功',
- 'schema' => [
- 'title' => '返回参数包括请求ID和模型列表，其中模型列表中的每个元素包含模型的详细信息如名称、类型、URL、状态等。'."\n",
- 'description' => '',
- 'type' => 'object',
- 'properties' => [
- 'requestId' => [
- 'title' => '请求ID'."\n",
- 'description' => '',
- 'type' => 'string',
- 'example' => '38b079f1-7846-4226-8c90-3e2644b5c52b',
- ],
- 'totalCount' => [
- 'title' => '总数'."\n",
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '14',
- ],
- 'result' => [
- 'title' => '模型列表参考：Model'."\n",
- 'description' => '',
- 'type' => 'array',
- 'items' => [
- 'title' => '模型信息',
- 'description' => '',
- 'type' => 'object',
- 'properties' => [
- 'name' => [
- 'title' => '模型名称',
- 'description' => '',
- 'type' => 'string',
- 'example' => 'test',
- ],
- 'type' => [
- 'title' => '模型类别',
- 'description' => '',
- 'type' => 'string',
- 'example' => 'text_embedding',
- ],
- 'url' => [
- 'title' => '模型访问地址',
- 'description' => '',
- 'type' => 'string',
- 'example' => 'http://***.platform-cn-shanghai.opensearch.aliyuncs.com/v3/openapi/workspaces/default/text-embedding/ops-text-embedding-001',
- ],
- 'status' => [
- 'title' => '模型状态。'."\n"
- .' * ok: 模型可用'."\n"
- .' * forbidden: 模型不可用',
- 'description' => '',
- 'type' => 'string',
- 'example' => 'ok',
- 'enum' => [
- 'ok',
- 'forbidden',
- ],
- ],
- 'dimension' => [
- 'title' => '模型的维度',
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '128',
- ],
- 'content' => [
- 'title' => '模型的内容信息',
- 'description' => '',
- 'type' => 'object',
- 'properties' => [
- 'modelName' => [
- 'title' => '模型名称',
- 'description' => '',
- 'type' => 'string',
- 'example' => 'test',
- ],
- 'modelType' => [
- 'title' => '模型类型',
- 'description' => '',
- 'type' => 'string',
- 'example' => 'text_embedding',
- ],
- 'url' => [
- 'title' => '模型访问地址',
- 'description' => '',
- 'type' => 'string',
- 'example' => 'http://***.platform-cn-shanghai.opensearch.aliyuncs.com/v3/openapi/workspaces/default/text-embedding/ops-text-embedding-001',
- ],
- 'method' => [
- 'title' => '请求方法',
- 'description' => '',
- 'type' => 'string',
- 'example' => 'POST',
- ],
- 'request' => [
- 'title' => '请求配置信息',
- 'description' => '',
- 'type' => 'object',
- 'properties' => [
- 'header' => [
- 'title' => '请求头信息',
- 'description' => '',
- 'type' => 'object',
- 'properties' => [
- 'Authorization' => [
- 'title' => '认证信息',
- 'description' => '',
- 'type' => 'string',
- 'example' => 'Bearer OS-v0********6vvs'."\n",
- ],
- 'Content-Type' => [
- 'title' => '内容类型',
- 'description' => '',
- 'type' => 'string',
- 'example' => 'application/json'."\n",
- ],
- ],
- ],
- 'urlParams' => [
- 'title' => 'URL参数',
- 'description' => '',
- 'type' => 'object',
- 'properties' => [
- 'build' => [
- 'title' => '构建时的URL参数',
- 'description' => '',
- 'type' => 'object',
- 'example' => 'key: value',
- ],
- 'search' => [
- 'title' => '搜索时的URL参数',
- 'description' => '',
- 'type' => 'object',
- 'example' => 'key: value',
- ],
- ],
- ],
- 'requestBody' => [
- 'title' => '请求体模板',
- 'description' => '',
- 'type' => 'string',
- 'example' => '{\\"input\\": [\\"%{input}\\"], \\"input_type\\": \\"%{input_type}\\"}',
- ],
- 'parameters' => [
- 'title' => '请求参数',
- 'description' => '',
- 'type' => 'object',
- 'properties' => [
- 'build' => [
- 'title' => '构建时的请求参数',
- 'description' => '',
- 'type' => 'object',
- 'properties' => [
- 'input_type' => [
- 'title' => '输入类型。'."\n"
- .' * document: 文档类型',
- 'description' => '',
- 'type' => 'string',
- 'example' => 'query'."\n",
- 'enum' => [
- 'document',
- ],
- ],
- ],
- ],
- 'search' => [
- 'title' => '搜索时的请求参数',
- 'description' => '',
- 'type' => 'object',
- 'properties' => [
- 'input_type' => [
- 'title' => '输入类型。'."\n"
- .' * query: 查询类型',
- 'description' => '',
- 'type' => 'string',
- 'example' => 'document'."\n",
- 'enum' => [
- 'query',
- ],
- ],
- ],
- ],
- ],
- ],
- ],
- ],
- 'response' => [
- 'description' => '',
- 'type' => 'object',
- 'properties' => [
- 'embeddings' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '$.result.embeddings[*].embedding'."\n",
- ],
- ],
- ],
- ],
- ],
- 'createTime' => [
- 'title' => '创建时间',
- 'description' => '',
- 'type' => 'string',
- 'example' => '2024-05-21 16:05:26',
- ],
- 'updateTime' => [
- 'title' => '修改时间',
- 'description' => '',
- 'type' => 'string',
- 'example' => '2024-05-21 16:05:26',
- ],
- ],
- ],
- ],
- ],
+ [
+ 'apiName' => 'GetIndex',
+ 'description' => '',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'searchengine:GetIndex',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SearchEngine', 'resourceType' => 'Instance', 'arn' => 'acs:searchengine:{#regionId}:{#accountId}:instance/{#InstanceId}'],
],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
+ [
+ 'apiName' => 'ListDataSources',
+ 'description' => '',
+ 'operationType' => 'list',
+ 'ramAction' => [
+ 'action' => 'searchengine:ListDataSources',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SearchEngine', 'resourceType' => 'Instance', 'arn' => 'acs:searchengine:{#regionId}:{#accountId}:instance/{#InstanceId}'],
+ ],
+ ],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"38b079f1-7846-4226-8c90-3e2644b5c52b\\",\\n \\"totalCount\\": 14,\\n \\"result\\": [\\n {\\n \\"name\\": \\"test\\",\\n \\"type\\": \\"text_embedding\\",\\n \\"url\\": \\"http://***.platform-cn-shanghai.opensearch.aliyuncs.com/v3/openapi/workspaces/default/text-embedding/ops-text-embedding-001\\",\\n \\"status\\": \\"ok\\",\\n \\"dimension\\": 128,\\n \\"content\\": {\\n \\"modelName\\": \\"test\\",\\n \\"modelType\\": \\"text_embedding\\",\\n \\"url\\": \\"http://***.platform-cn-shanghai.opensearch.aliyuncs.com/v3/openapi/workspaces/default/text-embedding/ops-text-embedding-001\\",\\n \\"method\\": \\"POST\\",\\n \\"request\\": {\\n \\"header\\": {\\n \\"Authorization\\": \\"Bearer OS-v0********6vvs\\\\n\\",\\n \\"Content-Type\\": \\"application/json\\\\n\\"\\n },\\n \\"urlParams\\": {\\n \\"build\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n },\\n \\"search\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n }\\n },\\n \\"requestBody\\": \\"{\\\\\\\\\\\\\\"input\\\\\\\\\\\\\\": [\\\\\\\\\\\\\\"%{input}\\\\\\\\\\\\\\"], \\\\\\\\\\\\\\"input_type\\\\\\\\\\\\\\": \\\\\\\\\\\\\\"%{input_type}\\\\\\\\\\\\\\"}\\",\\n \\"parameters\\": {\\n \\"build\\": {\\n \\"input_type\\": \\"query\\\\n\\"\\n },\\n \\"search\\": {\\n \\"input_type\\": \\"document\\\\n\\"\\n }\\n }\\n },\\n \\"response\\": {\\n \\"embeddings\\": \\"$.result.embeddings[*].embedding\\\\n\\"\\n }\\n },\\n \\"createTime\\": \\"2024-05-21 16:05:26\\",\\n \\"updateTime\\": \\"2024-05-21 16:05:26\\"\\n }\\n ]\\n}","type":"json"}]',
- ],
- 'CreateModel' => [
- 'summary' => '创建模型信息',
- 'path' => '/openapi/ha3/instances/{instanceId}/models',
- 'methods' => [
- 'post',
+ [
+ 'apiName' => 'DeleteIndexVersion',
+ 'description' => '',
+ 'operationType' => '',
+ 'ramAction' => [
+ 'action' => 'searchengine:DeleteIndexVersion',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SearchEngine', 'resourceType' => 'Instance', 'arn' => 'acs:searchengine:{#regionId}:{#accountId}:instance/{#InstanceId}'],
+ ],
+ ],
],
- 'schemes' => [
- 'https',
+ [
+ 'apiName' => 'TagResources',
+ 'description' => '',
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'searchengine:TagResources',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SearchEngine', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
],
- 'security' => [
- [
- 'AK' => [],
+ [
+ 'apiName' => 'RenameFolder',
+ 'description' => '',
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'searchengine:RenameFolder',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SearchEngine', 'resourceType' => 'Folder', 'arn' => 'acs:searchengine:{#regionId}:{#accountId}:instance/{#InstanceId}'],
+ ],
],
],
- 'operationType' => 'write',
- 'deprecated' => false,
- 'systemTags' => [
+ [
+ 'apiName' => 'ModifyAdvanceConfig',
+ 'description' => '',
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'searchengine:ModifyAdvanceConfig',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SearchEngine', 'resourceType' => 'Instance', 'arn' => 'acs:searchengine:{#regionId}:{#accountId}:instance/{#InstanceId}'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'GetInstance',
+ 'description' => '',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'searchengine:GetInstance',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SearchEngine', 'resourceType' => 'Instance', 'arn' => 'acs:searchengine:{#regionId}:{#accountId}:instance/{#InstanceId}'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'GetIndexOnlineStrategy',
+ 'description' => '',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'searchengine:GetIndexOnlineStrategy',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SearchEngine', 'resourceType' => 'Instance', 'arn' => 'acs:searchengine:{#regionId}:{#accountId}:instance/{#instanceId}'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'ListAdvanceConfigDir',
+ 'description' => '',
+ 'operationType' => 'list',
+ 'ramAction' => [
+ 'action' => 'searchengine:ListAdvanceConfigDir',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SearchEngine', 'resourceType' => 'Instance', 'arn' => 'acs:searchengine:{#regionId}:{#accountId}:instance/{#instanceId}'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'ModifyModel',
+ 'description' => '',
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'searchengine:ModifyModel',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SearchEngine', 'resourceType' => 'Instance', 'arn' => 'acs:searchengine:{#regionId}:{#accountId}:instance/{#InstanceId}'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'DeletePublicUrl',
+ 'description' => '',
+ 'operationType' => 'delete',
+ 'ramAction' => [
+ 'action' => 'searchengine:DeletePublicUrl',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SearchEngine', 'resourceType' => 'Instance', 'arn' => 'acs:searchengine:{#regionId}:{#accountId}:instance/{#InstanceId}'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'GetClusterRunTimeInfo',
+ 'description' => '',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'searchengine:GetClusterRunTimeInfo',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SearchEngine', 'resourceType' => 'Instance', 'arn' => 'acs:searchengine:{#regionId}:{#accountId}:instance/{#InstanceId}'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'StartIndex',
+ 'description' => '',
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'searchengine:StartIndex',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SearchEngine', 'resourceType' => 'Instance', 'arn' => 'acs:searchengine:{#regionId}:{#accountId}:instance/{#InstanceId}'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'DeleteIndex',
+ 'description' => '',
+ 'operationType' => '',
+ 'ramAction' => [
+ 'action' => 'searchengine:DeleteIndex',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SearchEngine', 'resourceType' => 'Instance', 'arn' => 'acs:searchengine:{#regionId}:{#accountId}:instance/{#InstanceId}'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'GetTable',
+ 'description' => '',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'searchengine:GetTable',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SearchEngine', 'resourceType' => 'Instance', 'arn' => 'acs:searchengine:{#regionId}:{#accountId}:instance/{#InstanceId}'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'ModifyFile',
+ 'description' => '',
+ 'operationType' => '',
+ 'ramAction' => [
+ 'action' => 'searchengine:ModifyFile',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SearchEngine', 'resourceType' => 'Instance', 'arn' => 'acs:searchengine:{#regionId}:{#accountId}:instance/{#InstanceId}'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'ModifyIndex',
+ 'description' => '',
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'searchengine:ModifyIndex',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SearchEngine', 'resourceType' => 'Instance', 'arn' => 'acs:searchengine:{#regionId}:{#accountId}:instance/{#InstanceId}'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'GetDeployGraph',
+ 'description' => '',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'searchengine:GetDeployGraph',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SearchEngine', 'resourceType' => 'Instance', 'arn' => 'acs:searchengine:{#regionId}:{#accountId}:instance/{#InstanceId}'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'CreateModel',
+ 'description' => '',
'operationType' => 'create',
- 'riskType' => 'none',
- 'chargeType' => 'free',
- 'abilityTreeNodes' => [
- 'FEATUREopensearchGTRUN8',
+ 'ramAction' => [
+ 'action' => 'searchengine:CreateModel',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SearchEngine', 'resourceType' => 'Instance', 'arn' => 'acs:searchengine:{#regionId}:{#accountId}:instance/{#InstanceId}'],
+ ],
],
],
- 'parameters' => [
- [
- 'name' => 'instanceId',
- 'in' => 'path',
- 'schema' => [
- 'title' => '实例ID',
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'ha-cn-pl32rf0****',
+ [
+ 'apiName' => 'UpdateSqlInstanceName',
+ 'description' => '',
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'searchengine:UpdateSqlInstanceName',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SearchEngine', 'resourceType' => 'SqlInstance', 'arn' => 'acs:searchengine:{#regionId}:{#accountId}:instance/{#InstanceId}'],
],
],
- [
- 'name' => 'dryRun',
- 'in' => 'query',
- 'schema' => [
- 'title' => '是否仅执行校验，默认为False。',
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'true',
+ ],
+ [
+ 'apiName' => 'ListDataSourceTasks',
+ 'description' => '',
+ 'operationType' => 'list',
+ 'ramAction' => [
+ 'action' => 'searchengine:ListDataSourceTasks',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SearchEngine', 'resourceType' => 'Instance', 'arn' => 'acs:searchengine:{#regionId}:{#accountId}:instance/{#InstanceId}'],
],
],
- [
- 'name' => 'body',
- 'in' => 'body',
- 'style' => 'json',
- 'schema' => [
- 'description' => '',
- 'type' => 'object',
- 'properties' => [
- 'name' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'test',
- ],
- 'content' => [
- 'description' => '',
- 'type' => 'object',
- 'properties' => [
- 'modelType' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'text_embedding',
- ],
- 'dimension' => [
- 'title' => '模型的维度',
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'example' => '128',
- ],
- 'url' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'http://***.platform-cn-shanghai.opensearch.aliyuncs.com/v3/openapi/workspaces/default/text-embedding/ops-text-embedding-001',
- ],
- 'method' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'POST',
- ],
- 'request' => [
- 'description' => '',
- 'type' => 'object',
- 'properties' => [
- 'header' => [
- 'description' => '',
- 'type' => 'object',
- 'properties' => [
- 'Authorization' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'Bearer OS-v0********6vvs',
- ],
- 'Content-Type' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'application/json',
- ],
- ],
- 'required' => false,
- ],
- 'urlParams' => [
- 'description' => '',
- 'type' => 'object',
- 'properties' => [
- 'build' => [
- 'description' => '',
- 'type' => 'object',
- 'required' => false,
- 'example' => 'key: value',
- ],
- 'search' => [
- 'description' => '',
- 'type' => 'object',
- 'required' => false,
- 'example' => 'key: value',
- ],
- ],
- 'required' => false,
- ],
- 'parameters' => [
- 'description' => '',
- 'type' => 'object',
- 'properties' => [
- 'build' => [
- 'description' => '',
- 'type' => 'object',
- 'properties' => [
- 'input_type' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'query',
- ],
- ],
- 'required' => false,
- ],
- 'search' => [
- 'description' => '',
- 'type' => 'object',
- 'properties' => [
- 'input_type' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'document',
- ],
- ],
- 'required' => false,
- ],
- ],
- 'required' => false,
- ],
- 'requestBody' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => '{\\"input\\": [\\"%{input}\\"], \\"input_type\\": \\"%{input_type}\\"}',
- ],
- ],
- 'required' => false,
- ],
- 'response' => [
- 'description' => '',
- 'type' => 'object',
- 'properties' => [
- 'embeddings' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => '$.result.embeddings[*].embedding',
- ],
- ],
- 'required' => false,
- ],
- ],
- 'required' => false,
- ],
- ],
- 'required' => false,
+ ],
+ [
+ 'apiName' => 'StopTask',
+ 'description' => '',
+ 'operationType' => '',
+ 'ramAction' => [
+ 'action' => 'searchengine:StopTask',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SearchEngine', 'resourceType' => 'Instance', 'arn' => 'acs:searchengine:{#regionId}:{#accountId}:instance/{#InstanceId}'],
],
],
],
- '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' => '022F36C7-9FB4-5D67-BEBC-3D14B0984463',
- ],
- ],
+ [
+ 'apiName' => 'GetIndexVersion',
+ 'description' => '',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'searchengine:GetIndexVersion',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SearchEngine', 'resourceType' => 'Instance', 'arn' => 'acs:searchengine:{#regionId}:{#accountId}:instance/{#InstanceId}'],
],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
+ [
+ 'apiName' => 'ModifyOnlineConfig',
+ 'description' => '',
+ 'operationType' => '',
+ 'ramAction' => [
+ 'action' => 'searchengine:ModifyOnlineConfig',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SearchEngine', 'resourceType' => 'Instance', 'arn' => 'acs:searchengine:{#regionId}:{#accountId}:instance/{#InstanceId}'],
+ ],
+ ],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"022F36C7-9FB4-5D67-BEBC-3D14B0984463\\"\\n}","type":"json"}]',
- ],
- 'ModifySearcherReplica' => [
- 'summary' => '通过指定实例ID来修改数据节点的副本或分片数量。',
- 'description' => '## 请求说明'."\n"
- .'本API允许用户修改特定实例下的数据节点副本数或分片数。请求时，需提供实例ID，并在请求体中指定要修改的`replica`（副本数）或`partition`（分片数）。请注意，这两个参数都是可选的，但至少需要提供其中一个以执行更新操作。'."\n",
- 'path' => '/openapi/ha3/instances/{instanceId}/replica',
- 'methods' => [
- 'put',
+ [
+ 'apiName' => 'UpdateInstance',
+ 'description' => '',
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'searchengine:UpdateInstance',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SearchEngine', 'resourceType' => 'Instance', 'arn' => 'acs:searchengine:{#regionId}:{#accountId}:instance/{#InstanceId}'],
+ ],
+ ],
],
- 'schemes' => [
- 'https',
+ [
+ 'apiName' => 'GetTableGeneration',
+ 'description' => '',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'searchengine:GetTableGeneration',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SearchEngine', 'resourceType' => 'Instance', 'arn' => 'acs:searchengine:{#regionId}:{#accountId}:instance/{#InstanceId}'],
+ ],
+ ],
],
- 'security' => [
- [
- 'AK' => [],
+ [
+ 'apiName' => 'ModifyClusterOfflineConfig',
+ 'description' => '',
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'searchengine:ModifyClusterOfflineConfig',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SearchEngine', 'resourceType' => 'Instance', 'arn' => 'acs:searchengine:{#regionId}:{#accountId}:instance/{#InstanceId}'],
+ ],
],
],
- 'consumes' => [
- 'application/json',
+ [
+ 'apiName' => 'CreateTable',
+ 'description' => '',
+ 'operationType' => 'create',
+ 'ramAction' => [
+ 'action' => 'searchengine:CreateTable',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SearchEngine', 'resourceType' => 'Instance', 'arn' => 'acs:searchengine:{#regionId}:{#accountId}:instance/{#InstanceId}'],
+ ],
+ ],
],
- 'produces' => [
- 'application/json',
+ [
+ 'apiName' => 'ListOnlineConfigs',
+ 'description' => '',
+ 'operationType' => 'list',
+ 'ramAction' => [
+ 'action' => 'searchengine:ListOnlineConfigs',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SearchEngine', 'resourceType' => 'Instance', 'arn' => 'acs:searchengine:{#regionId}:{#accountId}:instance/{#instanceId}'],
+ ],
+ ],
],
- 'operationType' => 'write',
- 'deprecated' => false,
- 'systemTags' => [
+ [
+ 'apiName' => 'ListRestQueryResult',
+ 'description' => '',
+ 'operationType' => 'list',
+ 'ramAction' => [
+ 'action' => 'searchengine:ListRestQueryResult',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SearchEngine', 'resourceType' => 'Instance', 'arn' => 'acs:searchengine:{#regionId}:{#accountId}:instance/{#InstanceId}'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'ModifyIndexVersion',
+ 'description' => '',
+ 'operationType' => '',
+ 'ramAction' => [
+ 'action' => 'searchengine:ModifyIndexVersion',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SearchEngine', 'resourceType' => 'Instance', 'arn' => 'acs:searchengine:{#regionId}:{#accountId}:instance/{#InstanceId}'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'DeleteFolder',
+ 'description' => '',
+ 'operationType' => 'delete',
+ 'ramAction' => [
+ 'action' => 'searchengine:DeleteFolder',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SearchEngine', 'resourceType' => 'Folder', 'arn' => 'acs:searchengine:{#regionId}:{#accountId}:instance/{#InstanceId}'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'ModifyNodeConfig',
+ 'description' => '',
+ 'operationType' => '',
+ 'ramAction' => [
+ 'action' => 'searchengine:ModifyNodeConfig',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SearchEngine', 'resourceType' => 'Instance', 'arn' => 'acs:searchengine:{#regionId}:{#accountId}:instance/{#InstanceId}'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'DeleteAlias',
+ 'description' => '',
+ 'operationType' => 'delete',
+ 'ramAction' => [
+ 'action' => 'searchengine:DeleteAlias',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SearchEngine', 'resourceType' => 'Instance', 'arn' => 'acs:searchengine:{#regionId}:{#accountId}:instance/{#InstanceId}'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'ListInstances',
+ 'description' => '',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'searchengine:ListInstances',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SearchEngine', 'resourceType' => 'Instance', 'arn' => 'acs:searchengine:{#regionId}:{#accountId}:instance/*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'ListClusters',
+ 'description' => '',
+ 'operationType' => 'list',
+ 'ramAction' => [
+ 'action' => 'searchengine:ListClusters',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SearchEngine', 'resourceType' => 'Instance', 'arn' => 'acs:searchengine:{#regionId}:{#accountId}:instance/{#InstanceId}'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'DeleteSqlInstance',
+ 'description' => '',
+ 'operationType' => 'delete',
+ 'ramAction' => [
+ 'action' => 'searchengine:DeleteSqlInstance',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SearchEngine', 'resourceType' => 'SqlInstance', 'arn' => 'acs:searchengine:{#regionId}:{#accountId}:instance/{#InstanceId}'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'ListIndexes',
+ 'description' => '',
+ 'operationType' => 'list',
+ 'ramAction' => [
+ 'action' => 'searchengine:ListIndexes',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SearchEngine', 'resourceType' => 'Instance', 'arn' => 'acs:searchengine:{#regionId}:{#accountId}:instance/{#InstanceId}'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'ListPausePolicys',
+ 'description' => '',
+ 'operationType' => 'list',
+ 'ramAction' => [
+ 'action' => 'searchengine:ListPausePolicys',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SearchEngine', 'resourceType' => 'Instance', 'arn' => 'acs:searchengine:{#regionId}:{#accountId}:instance/{#InstanceId}'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'PublishAdvanceConfig',
+ 'description' => '',
'operationType' => 'update',
- 'riskType' => 'none',
- 'chargeType' => 'free',
- 'abilityTreeNodes' => [
- 'FEATUREopensearch5EAGY5',
+ 'ramAction' => [
+ 'action' => 'searchengine:PublishAdvanceConfig',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SearchEngine', 'resourceType' => 'Instance', 'arn' => 'acs:searchengine:{#regionId}:{#accountId}:instance/{#InstanceId}'],
+ ],
],
],
- 'parameters' => [
- [
- 'name' => 'instanceId',
- 'in' => 'path',
- 'schema' => [
- 'title' => '实例ID'."\n",
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'ha-cn-test',
+ [
+ 'apiName' => 'DeleteDataSource',
+ 'description' => '',
+ 'operationType' => '',
+ 'ramAction' => [
+ 'action' => 'searchengine:DeleteDataSource',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SearchEngine', 'resourceType' => 'Instance', 'arn' => 'acs:searchengine:{#regionId}:{#accountId}:instance/{#InstanceId}'],
],
],
- [
- 'name' => 'body',
- 'in' => 'body',
- 'style' => 'json',
- 'schema' => [
- 'description' => '',
- 'type' => 'object',
- 'properties' => [
- 'replica' => [
- 'title' => '数据节点副本数'."\n",
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'example' => '2',
- ],
- 'partition' => [
- 'title' => '数据节点分片数'."\n",
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'example' => '2',
- ],
- ],
- 'required' => false,
+ ],
+ [
+ 'apiName' => 'Reindex',
+ 'description' => '',
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'searchengine:Reindex',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SearchEngine', 'resourceType' => 'Instance', 'arn' => 'acs:searchengine:{#regionId}:{#accountId}:instance/{#InstanceId}'],
],
],
],
- 'responses' => [
- 200 => [
- 'description' => '修改成功',
- 'schema' => [
- 'title' => 'Schema of Response',
- 'description' => 'Schema of Response',
- 'type' => 'object',
- 'properties' => [
- 'requestId' => [
- 'title' => '请求ID'."\n",
- 'description' => '',
- 'type' => 'string',
- 'example' => 'e1eef569-1ff7-4bf8-acf7-1cecca9894ce',
- ],
- 'result' => [
- 'title' => '操作的结果对象，当前版本下该对象为空。',
- 'description' => '',
- 'type' => 'object',
- ],
- ],
+ [
+ 'apiName' => 'CreateSqlInstance',
+ 'description' => '',
+ 'operationType' => 'create',
+ 'ramAction' => [
+ 'action' => 'searchengine:CreateSqlInstance',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SearchEngine', 'resourceType' => 'Instance', 'arn' => 'acs:searchengine:{#regionId}:{#accountId}:instance/{#instanceId}'],
],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
+ [
+ 'apiName' => 'ListTableGenerations',
+ 'description' => '',
+ 'operationType' => 'list',
+ 'ramAction' => [
+ 'action' => 'searchengine:ListTableGenerations',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SearchEngine', 'resourceType' => 'Instance', 'arn' => 'acs:searchengine:{#regionId}:{#accountId}:instance/{#InstanceId}'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'GetCluster',
+ 'description' => '',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'searchengine:GetCluster',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SearchEngine', 'resourceType' => 'Instance', 'arn' => 'acs:searchengine:{#regionId}:{#accountId}:instance/{#InstanceId}'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'ModifyAdvanceConfigFile',
+ 'description' => '',
+ 'operationType' => '',
+ 'ramAction' => [
+ 'action' => 'searchengine:ModifyAdvanceConfigFile',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SearchEngine', 'resourceType' => 'Instance', 'arn' => 'acs:searchengine:{#regionId}:{#accountId}:instance/{#InstanceId}'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'ListAliases',
+ 'description' => '',
+ 'operationType' => 'list',
+ 'ramAction' => [
+ 'action' => 'searchengine:ListAliases',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SearchEngine', 'resourceType' => 'Instance', 'arn' => 'acs:searchengine:{#regionId}:{#accountId}:instance/{#InstanceId}'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'ListVectorQueryResult',
+ 'description' => '',
+ 'operationType' => 'list',
+ 'ramAction' => [
+ 'action' => 'searchengine:ListVectorQueryResult',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SearchEngine', 'resourceType' => 'Instance', 'arn' => 'acs:searchengine:{#regionId}:{#accountId}:instance/{#InstanceId}'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'ListTables',
+ 'description' => '',
+ 'operationType' => 'list',
+ 'ramAction' => [
+ 'action' => 'searchengine:ListTables',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SearchEngine', 'resourceType' => 'Instance', 'arn' => 'acs:searchengine:{#regionId}:{#accountId}:instance/{#InstanceId}'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'ListSchemas',
+ 'description' => '',
+ 'operationType' => 'list',
+ 'ramAction' => [
+ 'action' => 'searchengine:ListSchemas',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SearchEngine', 'resourceType' => 'Instance', 'arn' => 'acs:searchengine:{#regionId}:{#accountId}:instance/{#InstanceId}'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'RemoveCluster',
+ 'description' => '',
+ 'operationType' => '',
+ 'ramAction' => [
+ 'action' => 'searchengine:RemoveCluster',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SearchEngine', 'resourceType' => 'Instance', 'arn' => 'acs:searchengine:{#regionId}:{#accountId}:instance/{#InstanceId}'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'CreateAlias',
+ 'description' => '',
+ 'operationType' => 'create',
+ 'ramAction' => [
+ 'action' => 'searchengine:CreateAlias',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SearchEngine', 'resourceType' => 'Instance', 'arn' => 'acs:searchengine:{#regionId}:{#accountId}:instance/{#InstanceId}'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'UpdateSqlInstanceParams',
+ 'description' => '',
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'searchengine:UpdateSqlInstanceParams',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SearchEngine', 'resourceType' => 'Instance', 'arn' => 'acs:searchengine:{#regionId}:{#accountId}:instance/{#instanceId}'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'ListQueryResult',
+ 'description' => '',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'searchengine:ListQueryResult',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SearchEngine', 'resourceType' => 'Instance', 'arn' => 'acs:searchengine:{#regionId}:{#accountId}:instance/{#InstanceId}'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'TransformPlan',
+ 'description' => '',
+ 'operationType' => 'create',
+ 'ramAction' => [
+ 'action' => 'searchengine:TransformPlan',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SearchEngine', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'BuildIndex',
+ 'description' => '',
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'searchengine:BuildIndex',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SearchEngine', 'resourceType' => 'Instance', 'arn' => 'acs:searchengine:{#regionId}:{#accountId}:instance/{#InstanceId}'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'CreateDataSource',
+ 'description' => '',
+ 'operationType' => 'create',
+ 'ramAction' => [
+ 'action' => 'searchengine:CreateDataSource',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SearchEngine', 'resourceType' => 'Instance', 'arn' => 'acs:searchengine:{#regionId}:{#accountId}:instance/{#InstanceId}'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'ModifyClusterOnlineConfig',
+ 'description' => '',
+ 'operationType' => '',
+ 'ramAction' => [
+ 'action' => 'searchengine:ModifyClusterOnlineConfig',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SearchEngine', 'resourceType' => 'Instance', 'arn' => 'acs:searchengine:{#regionId}:{#accountId}:instance/{#instanceId}'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'ModifyTable',
+ 'description' => '',
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'searchengine:ModifyTable',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SearchEngine', 'resourceType' => 'Instance', 'arn' => 'acs:searchengine:{#regionId}:{#accountId}:instance/{#InstanceId}'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'CreateCluster',
+ 'description' => '',
+ 'operationType' => 'create',
+ 'ramAction' => [
+ 'action' => 'searchengine:CreateCluster',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SearchEngine', 'resourceType' => 'Instance', 'arn' => 'acs:searchengine:{#regionId}:{#accountId}:instance/{#InstanceId}'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'ListTagResources',
+ 'description' => '',
+ 'operationType' => 'list',
+ 'ramAction' => [
+ 'action' => 'searchengine:ListTagResources',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SearchEngine', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'ListIndexRecoverRecords',
+ 'description' => '',
+ 'operationType' => 'list',
+ 'ramAction' => [
+ 'action' => 'searchengine:ListIndexRecoverRecords',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SearchEngine', 'resourceType' => 'Instance', 'arn' => 'acs:searchengine:{#regionId}:{#accountId}:instance/{#InstanceId}'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'ListClusterTasks',
+ 'description' => '',
+ 'operationType' => 'list',
+ 'ramAction' => [
+ 'action' => 'searchengine:ListClusterTasks',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SearchEngine', 'resourceType' => 'Instance', 'arn' => 'acs:searchengine:{#regionId}:{#accountId}:instance/{#InstanceId}'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'DebugModel',
+ 'description' => '',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'searchengine:DebugModel',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SearchEngine', 'resourceType' => 'Instance', 'arn' => 'acs:searchengine:{#regionId}:{#accountId}:instance/{#InstanceId}'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'RecoverIndex',
+ 'description' => '',
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'searchengine:RecoverIndex',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SearchEngine', 'resourceType' => 'Instance', 'arn' => 'acs:searchengine:{#regionId}:{#accountId}:instance/{#InstanceId}'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'DeleteConfigFile',
+ 'description' => '',
+ 'operationType' => '',
+ 'ramAction' => [
+ 'action' => 'searchengine:DeleteConfigFile',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SearchEngine', 'resourceType' => 'Instance', 'arn' => 'acs:searchengine:{#regionId}:{#accountId}:instance/{#InstanceId}'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'ListClusterNames',
+ 'description' => '',
+ 'operationType' => 'list',
+ 'ramAction' => [
+ 'action' => 'searchengine:ListClusterNames',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SearchEngine', 'resourceType' => 'Instance', 'arn' => 'acs:searchengine:{#regionId}:{#accountId}:instance/{#InstanceId}'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'UntagResources',
+ 'description' => '',
+ 'operationType' => 'delete',
+ 'ramAction' => [
+ 'action' => 'searchengine:UntagResources',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SearchEngine', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'PublishIndexVersion',
+ 'description' => '',
+ 'operationType' => '',
+ 'ramAction' => [
+ 'action' => 'searchengine:PublishIndexVersion',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SearchEngine', 'resourceType' => 'Instance', 'arn' => 'acs:searchengine:{#regionId}:{#accountId}:instance/{#InstanceId}'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'ListDatabases',
+ 'description' => '',
+ 'operationType' => 'list',
+ 'ramAction' => [
+ 'action' => 'searchengine:ListDatabases',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SearchEngine', 'resourceType' => 'Instance', 'arn' => 'acs:searchengine:{#regionId}:{#accountId}:instance/{#instanceId}'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'ModifyIndexPartition',
+ 'description' => '',
+ 'operationType' => '',
+ 'ramAction' => [
+ 'action' => 'searchengine:ModifyIndexPartition',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SearchEngine', 'resourceType' => 'Instance', 'arn' => 'acs:searchengine:{#regionId}:{#accountId}:instance/{#instanceId}'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'ListDataSourceSchemas',
+ 'description' => '',
+ 'operationType' => 'list',
+ 'ramAction' => [
+ 'action' => 'searchengine:ListDataSourceSchemas',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SearchEngine', 'resourceType' => 'Instance', 'arn' => 'acs:searchengine:{#regionId}:{#accountId}:instance/{#instanceId}'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'CreateInstance',
+ 'description' => '',
+ 'operationType' => 'create',
+ 'ramAction' => [
+ 'action' => 'searchengine:CreateInstance',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SearchEngine', 'resourceType' => 'Instance', 'arn' => 'acs:searchengine:{#regionId}:{#accountId}:instance/*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'ModifyClusterDesc',
+ 'description' => '',
+ 'operationType' => '',
+ 'ramAction' => [
+ 'action' => 'searchengine:ModifyClusterDesc',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SearchEngine', 'resourceType' => 'Instance', 'arn' => 'acs:searchengine:{#regionId}:{#accountId}:instance/{#InstanceId}'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'ListTasks',
+ 'description' => '',
+ 'operationType' => 'none',
+ 'ramAction' => [
+ 'action' => 'searchengine:ListTasks',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SearchEngine', 'resourceType' => 'Instance', 'arn' => 'acs:searchengine:{#regionId}:{#accountId}:instance/{#InstanceId}'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'ExecuteSqlInstance',
+ 'description' => '',
+ 'operationType' => 'create',
+ 'ramAction' => [
+ 'action' => 'searchengine:ExecuteSqlInstance',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SearchEngine', 'resourceType' => 'Instance', 'arn' => 'acs:searchengine:{#regionId}:{#accountId}:instance/{#instanceId}'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'GetSqlInstance',
+ 'description' => '',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'searchengine:GetSqlInstance',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SearchEngine', 'resourceType' => 'Instance', 'arn' => 'acs:searchengine:{#regionId}:{#accountId}:instance/{#instanceId}'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'CreatePublicUrl',
+ 'description' => '',
+ 'operationType' => 'create',
+ 'ramAction' => [
+ 'action' => 'searchengine:CreatePublicUrl',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SearchEngine', 'resourceType' => 'Instance', 'arn' => 'acs:searchengine:{#regionId}:{#accountId}:instance/{#InstanceId}'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'GetModel',
+ 'description' => '',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'searchengine:GetModel',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SearchEngine', 'resourceType' => 'Instance', 'arn' => 'acs:searchengine:{#regionId}:{#accountId}:instance/{#InstanceId}'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'ModifyPublicUrlIpList',
+ 'description' => '',
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'searchengine:ModifyPublicUrlIpList',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SearchEngine', 'resourceType' => 'Instance', 'arn' => 'acs:searchengine:{#regionId}:{#accountId}:instance/{#InstanceId}'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'GetDataSource',
+ 'description' => '',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'searchengine:GetDataSource',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SearchEngine', 'resourceType' => 'Instance', 'arn' => 'acs:searchengine:{#regionId}:{#accountId}:instance/{#InstanceId}'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'GetAdvanceConfig',
+ 'description' => '',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'searchengine:GetAdvanceConfig',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SearchEngine', 'resourceType' => 'Instance', 'arn' => 'acs:searchengine:{#regionId}:{#accountId}:instance/{#InstanceId}'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'CloneSqlInstance',
+ 'description' => '',
+ 'operationType' => 'create',
+ 'ramAction' => [
+ 'action' => 'searchengine:CloneSqlInstance',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SearchEngine', 'resourceType' => 'Instance', 'arn' => 'acs:searchengine:{#regionId}:{#accountId}:instance/{#instanceId}'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'GetFile',
+ 'description' => '',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'searchengine:GetFile',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SearchEngine', 'resourceType' => 'Instance', 'arn' => 'acs:searchengine:{#regionId}:{#accountId}:instance/{#InstanceId}'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'PushDocuments',
+ 'description' => '',
+ 'operationType' => '',
+ 'ramAction' => [
+ 'action' => 'searchengine:PushDocuments',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SearchEngine', 'resourceType' => 'Instance', 'arn' => 'acs:searchengine:{#regionId}:{#accountId}:instance/{#InstanceId}'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'ListModels',
+ 'description' => '',
+ 'operationType' => 'list',
+ 'ramAction' => [
+ 'action' => 'searchengine:ListModels',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SearchEngine', 'resourceType' => 'Instance', 'arn' => 'acs:searchengine:{#regionId}:{#accountId}:instance/{#InstanceId}'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'GetDatabaseSchema',
+ 'description' => '',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'searchengine:GetDatabaseSchema',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SearchEngine', 'resourceType' => 'Instance', 'arn' => 'acs:searchengine:{#regionId}:{#accountId}:instance/{#instanceId}'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'ModifyPausePolicy',
+ 'description' => '',
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'searchengine:ModifyPausePolicy',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SearchEngine', 'resourceType' => 'Instance', 'arn' => 'acs:searchengine:{#regionId}:{#accountId}:instance/{#InstanceId}'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'StopIndex',
+ 'description' => '',
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'searchengine:StopIndex',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SearchEngine', 'resourceType' => 'Instance', 'arn' => 'acs:searchengine:{#regionId}:{#accountId}:instance/{#InstanceId}'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'ModifyIndexOnlineStrategy',
+ 'description' => '',
+ 'operationType' => '',
+ 'ramAction' => [
+ 'action' => 'searchengine:ModifyIndexOnlineStrategy',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SearchEngine', 'resourceType' => 'Instance', 'arn' => 'acs:searchengine:{#regionId}:{#accountId}:instance/{#instanceId}'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'CreateIndex',
+ 'description' => '',
+ 'operationType' => 'create',
+ 'ramAction' => [
+ 'action' => 'searchengine:CreateIndex',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SearchEngine', 'resourceType' => 'Instance', 'arn' => 'acs:searchengine:{#regionId}:{#accountId}:instance/{#InstanceId}'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'ListPostQueryResult',
+ 'description' => '',
+ 'operationType' => 'list',
+ 'ramAction' => [
+ 'action' => 'searchengine:ListPostQueryResult',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SearchEngine', 'resourceType' => 'Instance', 'arn' => 'acs:searchengine:{#regionId}:{#accountId}:instance/{#InstanceId}'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'ChangeResourceGroup',
+ 'description' => '',
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'searchengine:ChangeResourceGroup',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SearchEngine', 'resourceType' => 'Instance', 'arn' => 'acs:searchengine:{#regionId}:{#accountId}:instance/{#InstanceId}'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'CreateConfigDir',
+ 'description' => '',
+ 'operationType' => '',
+ 'ramAction' => [
+ 'action' => 'searchengine:CreateConfigDir',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SearchEngine', 'resourceType' => 'Instance', 'arn' => 'acs:searchengine:{#regionId}:{#accountId}:instance/{#InstanceId}'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'DeleteInstance',
+ 'description' => '',
+ 'operationType' => 'delete',
+ 'ramAction' => [
+ 'action' => 'searchengine:DeleteInstance',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SearchEngine', 'resourceType' => 'Instance', 'arn' => 'acs:searchengine:{#regionId}:{#accountId}:instance/{#InstanceId}'],
+ ],
+ ],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"e1eef569-1ff7-4bf8-acf7-1cecca9894ce\\",\\n \\"result\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n }\\n}","type":"json"}]',
- ],
- ],
- 'endpoints' => [
- [
- 'regionId' => 'ap-southeast-1',
- 'endpoint' => 'searchengine.ap-southeast-1.aliyuncs.com',
- ],
- [
- 'regionId' => 'cn-beijing',
- 'endpoint' => 'searchengine.cn-beijing.aliyuncs.com',
- ],
- [
- 'regionId' => 'cn-hangzhou',
- 'endpoint' => 'searchengine.cn-hangzhou.aliyuncs.com',
- ],
- [
- 'regionId' => 'cn-shanghai',
- 'endpoint' => 'searchengine.cn-shanghai.aliyuncs.com',
- ],
- [
- 'regionId' => 'cn-shenzhen',
- 'endpoint' => 'searchengine.cn-shenzhen.aliyuncs.com',
- ],
- [
- 'regionId' => 'cn-hongkong',
- 'endpoint' => 'searchengine.cn-hongkong.aliyuncs.com',
- ],
- [
- 'regionId' => 'cn-zhangjiakou',
- 'endpoint' => 'searchengine.cn-zhangjiakou.aliyuncs.com',
],
- [
- 'regionId' => 'eu-central-1',
- 'endpoint' => 'searchengine.eu-central-1.aliyuncs.com',
+ 'resourceTypes' => [
+ ['validationType' => 'always', 'resourceType' => 'Instance', 'arn' => 'acs:searchengine:{#regionId}:{#accountId}:instance/{#instanceId}'],
+ ['validationType' => 'always', 'resourceType' => 'Folder', 'arn' => 'acs:searchengine:{#regionId}:{#accountId}:instance/{#InstanceId}'],
+ ['validationType' => 'always', 'resourceType' => 'Instance', 'arn' => 'acs:searchengine:{#regionId}:{#accountId}:instance/*'],
+ ['validationType' => 'always', 'resourceType' => 'SqlInstance', 'arn' => 'acs:searchengine:{#regionId}:{#accountId}:instance/{#InstanceId}'],
],
],
];
generated by cgit v1.2.3 (git 2.46.0) at 2026-07-12 18:57:40 +0000