diff options
Diffstat (limited to 'data/en_us/searchengine')
| -rw-r--r-- | data/en_us/searchengine/2021-10-25/api-docs.php | 19901 |
1 files changed, 19901 insertions, 0 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 new file mode 100644 index 0000000..36de72d --- /dev/null +++ b/data/en_us/searchengine/2021-10-25/api-docs.php @@ -0,0 +1,19901 @@ +<?php return [ + 'version' => '1.0', + 'info' => [ + 'style' => 'ROA', + 'product' => 'searchengine', + 'version' => '2021-10-25', + ], + 'directories' => [ + [ + 'id' => 169788, + 'title' => 'The instance details', + 'type' => 'directory', + 'children' => [ + 'ChangeResourceGroup', + 'TagResources', + 'UntagResources', + 'ListTagResources', + 'CreatePublicUrl', + 'DeletePublicUrl', + 'ModifyPublicUrlIpList', + 'CreateInstance', + 'DeleteInstance', + 'UpdateInstance', + 'ModifyPassword', + 'ListInstances', + 'GetInstance', + 'ListInstanceSpecs', + ], + ], + [ + 'id' => 169802, + 'title' => 'The configuration center', + 'type' => 'directory', + 'children' => [ + [ + 'id' => 169803, + 'title' => 'Online table configuration', + 'type' => 'directory', + 'children' => [ + 'GetIndexOnlineStrategy', + 'ModifyIndexOnlineStrategy', + 'ModifyOnlineConfig', + 'ListOnlineConfigs', + ], + ], + [ + 'id' => 169783, + 'title' => 'Index structure', + 'type' => 'directory', + 'children' => [ + 'ModifyIndex', + 'StartIndex', + 'StopIndex', + 'CreateIndex', + 'BuildIndex', + 'DeleteIndexVersion', + 'DeleteIndex', + 'ModifyIndexVersion', + 'ModifyFile', + 'PublishIndexVersion', + 'ModifyIndexPartition', + 'GetIndex', + 'GetIndexVersion', + 'GetFile', + 'ListIndexes', + 'RecoverIndex', + ], + ], + [ + 'id' => 169816, + 'title' => 'Advanced Configuration', + 'type' => 'directory', + 'children' => [ + 'CreateConfigDir', + 'CreateConfigFile', + 'DeleteConfigDir', + 'DeleteConfigFile', + 'ModifyAdvanceConfig', + 'DeleteAdvanceConfig', + 'ModifyAdvanceConfigFile', + 'PublishAdvanceConfig', + 'GetAdvanceConfig', + 'GetAdvanceConfigFile', + 'ListAdvanceConfigDir', + 'ListAdvanceConfigs', + ], + ], + [ + 'id' => 169824, + 'title' => 'Data source configuration', + 'type' => 'directory', + 'children' => [ + 'ListSchemas', + 'ModifyDataSourceDeploy', + 'CreateDataSource', + 'DeleteDataSource', + 'GetDataSource', + 'ListDataSources', + 'ListDataSourceSchemas', + 'ListDateSourceGenerations', + 'GetDataSourceDeploy', + ], + ], + ], + ], + [ + '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', + 'type' => 'directory', + 'children' => [ + 'ListTasks', + 'ListClusterTasks', + 'ListDataSourceTasks', + 'StopTask', + 'ForceSwitch', + ], + ], + [ + 'id' => 194031, + 'title' => 'Log Management', + 'type' => 'directory', + 'children' => [ + 'ListLogs', + ], + ], + [ + 'id' => 169796, + 'title' => 'Deployment Management', + 'type' => 'directory', + 'children' => [ + 'ModifyNodeConfig', + 'GetDeployGraph', + 'GetNodeConfig', + ], + ], + [ + 'id' => 169794, + 'title' => 'Operation and Maintenance Management', + 'type' => 'directory', + 'children' => [ + 'ListIndexRecoverRecords', + 'ListPausePolicys', + 'ModifyPausePolicy', + 'CreateCluster', + 'RemoveCluster', + 'ModifyClusterDesc', + 'ModifyClusterOfflineConfig', + 'ModifyClusterOnlineConfig', + 'GetCluster', + 'GetClusterRunTimeInfo', + 'ListClusterNames', + 'ListClusters', + ], + ], + ], + ], + [ + 'id' => 191973, + 'title' => 'Table Management', + 'type' => 'directory', + 'children' => [ + [ + 'id' => 193711, + 'title' => 'Table Alias Management', + 'type' => 'directory', + 'children' => [ + 'ModifyAlias', + 'ListAliases', + 'DeleteAlias', + 'CreateAlias', + ], + ], + 'CreateTable', + 'ModifyTable', + 'GetTable', + 'ListTables', + 'DeleteTable', + 'Reindex', + 'ListTableGenerations', + 'GetTableGeneration', + ], + ], + [ + 'id' => 180946, + 'title' => 'Other', + 'type' => 'directory', + 'children' => [ + 'ListPostQueryResult', + 'ListRestQueryResult', + 'ListVectorQueryResult', + 'PushDocuments', + 'DescribeRegions', + 'ListQueryResult', + 'DeleteModel', + 'ModifyModel', + 'DebugModel', + 'GetModel', + 'ListModels', + 'CreateModel', + 'ModifySearcherReplica', + ], + ], + ], + 'components' => [ + 'schemas' => [], + ], + 'apis' => [ + 'ChangeResourceGroup' => [ + 'summary' => '更换实例资源组', + 'path' => '/openapi/ha3/instances/{instanceId}/actions/change-resource-group', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [], + 'produces' => [], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + ], + 'parameters' => [ + [ + 'name' => 'instanceId', + 'in' => 'path', + 'schema' => [ + 'description' => 'The instance ID.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'ha-cn-pl32rf0****', + ], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', + 'schema' => [ + 'description' => 'The request body.'."\n", + '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', + ], + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'title' => 'Id of the request', + 'description' => 'Id of the request', + 'type' => 'string', + 'example' => '10D5E615-69F7-5F49-B850-00169ADE513C', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"10D5E615-69F7-5F49-B850-00169ADE513C\\"\\n}","type":"json"}]', + 'title' => 'ChangeResourceGroup', + ], + 'TagResources' => [ + 'summary' => '打标签接口', + 'path' => '/openapi/ha3/resource-tags', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'abilityTreeCode' => '166280', + 'abilityTreeNodes' => [ + 'FEATUREopensearchJB31XH', + ], + ], + 'parameters' => [ + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', + 'schema' => [ + 'description' => '', + '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, + ], + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'title' => '请求id', + 'description' => '', + 'type' => 'string', + 'example' => 'E7B7D598-B080-5C8E-AA35-D43EC0D5F886', + ], + ], + ], + ], + ], + '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', + ], + ], + 'parameters' => [ + [ + 'name' => 'resourceType', + 'in' => 'query', + 'schema' => [ + 'title' => '资源类型', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'instance', + ], + ], + [ + '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", + ], + ], + ], + ], + ], + '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', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'abilityTreeCode' => '166297', + 'abilityTreeNodes' => [ + 'FEATUREopensearch0AT3OG', + 'FEATUREopensearchJB31XH', + ], + ], + 'parameters' => [ + [ + 'name' => 'resourceType', + 'in' => 'query', + 'schema' => [ + 'title' => '资源类型', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'instance', + ], + ], + [ + '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' => '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' => 'nextToken', + 'in' => 'query', + 'schema' => [ + 'title' => '下一个查询开始Token', + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '600********33', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + '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', + ], + ], + ], + ], + ], + ], + ], + ], + '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', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'title' => 'id of request', + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => '022F36C7-9FB4-5D67-BEBC-3D14B0984463', + ], + 'result' => [ + 'title' => 'Map', + 'description' => 'The result.'."\n", + 'type' => 'object', + 'example' => '{}', + ], + ], + 'description' => '', + ], + ], + 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', + ], + ], + 'parameters' => [ + [ + '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' => '{}', + ], + ], + 'description' => '', + ], + ], + 500 => [], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"F43E8AB4-419C-5F4C-90D6-615590DFAA3C\\",\\n \\"result\\": {}\\n}","type":"json"}]', + 'title' => 'DeletePublicUrl', + ], + 'ModifyPublicUrlIpList' => [ + 'summary' => '修改公网域名访问白名单', + 'path' => '/openapi/ha3/instances/{instanceId}/public-url-ip-list', + 'methods' => [ + 'put', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + '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-0ju2rq6610a', + ], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', + 'schema' => [ + 'description' => 'The request body.'."\n", + '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", + ], + ], + ], + ], + 'responses' => [ + 200 => [ + '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' => '{}', + ], + ], + 'description' => '', + ], + ], + 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', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'paid', + 'abilityTreeCode' => '136888', + 'abilityTreeNodes' => [ + 'FEATUREopensearchXLGC1X', + 'FEATUREopensearchCH6TQD', + ], + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', + 'schema' => [ + 'description' => 'The request body.'."\n", + '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, + ], + 'required' => false, + ], + 'order' => [ + 'description' => 'The billing information.'."\n", + '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' => '""', + ], + ], + 'required' => false, + ], + 'tags' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'key' => [ + 'type' => 'string', + ], + 'value' => [ + 'type' => 'string', + ], + ], + ], + ], + 'resourceGroupId' => [ + 'type' => 'string', + ], + ], + 'required' => false, + 'example' => '{}', + ], + ], + ], + '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', + ], + ], + ], + ], + ], + ], + '5XX' => [], + ], + '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" + ."\n" + .'`POST`'."\n" + ."\n" + .'### [](#uri)URI'."\n" + ."\n" + .'`/api/instances?dryRun=false`'."\n", + 'responseParamsDescription' => '### [](#)Sample responses'."\n" + ."\n" + .'**Sample success responses**'."\n" + ."\n" + .' {'."\n" + .' "requestId": "90D6B8F5-FE97-4509-9AAB-367836C51818",'."\n" + .' "result": {'."\n" + .' "instanceId": "deeprec-cn-xxxxxx1"'."\n" + .' }'."\n" + .' }'."\n" + ."\n" + .'**Sample error responses**'."\n" + ."\n" + .' {'."\n" + .' "requestId": "90D6B8F5-FE97-4509-9AAB-367836C51818",'."\n" + .' "code": "InternalServerError",'."\n" + .' "message":"internal server error"'."\n" + .' }'."\n" + ."\n" + .'For more information, see [Response structure](~~465311~~).'."\n", + ], + 'DeleteInstance' => [ + 'summary' => 'Deletes a specified instance.', + 'path' => '/openapi/ha3/instances/{instanceId}', + 'methods' => [ + 'delete', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + ], + 'parameters' => [ + [ + 'name' => 'instanceId', + 'in' => 'path', + 'schema' => [ + 'title' => '实例 ID。', + 'description' => 'The instance ID.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'ha-cn-7pp2m0ozr01', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response'."\n", + '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' => '{}', + ], + ], + ], + ], + 500 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'type' => 'string', + ], + 'message' => [ + 'type' => 'string', + ], + 'code' => [ + 'type' => 'string', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"E45380E8-994A-5402-9806-F114B3295FCF\\",\\n \\"result\\": {}\\n}","type":"json"}]', + 'title' => 'DeleteInstance', + '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" + .'```'."\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", + ], + 'UpdateInstance' => [ + 'summary' => 'Modifies the configuration of a specified instance.', + 'path' => '/openapi/ha3/instances/{instanceId}', + 'methods' => [ + 'put', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + ], + 'parameters' => [ + [ + 'name' => 'instanceId', + 'in' => 'path', + 'schema' => [ + 'description' => 'The instance ID.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'ha-cn-2r42mu9xi01', + ], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', + 'schema' => [ + 'description' => 'The request body.'."\n", + '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' => '""', + ], + ], + 'required' => false, + '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', + ], + ], + ], + ], + 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', + 'description' => '### Method'."\n" + ."\n" + .'`PUT`'."\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', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + ], + 'parameters' => [ + [ + 'name' => 'instanceId', + 'in' => 'path', + 'schema' => [ + 'description' => 'The instance ID.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'ha-cn-7pp2pcna701', + ], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', + 'schema' => [ + 'description' => 'The request body.'."\n", + 'type' => 'object', + 'properties' => [ + 'username' => [ + 'description' => 'The username.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '"username"', + ], + 'password' => [ + 'description' => 'The password.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '******************************', + ], + ], + 'required' => false, + 'example' => '{}', + ], + ], + ], + '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' => '{}', + ], + ], + ], + ], + 500 => [], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"407BFD91-DE7D-50BA-8F88-CDE52A3B5E46\\",\\n \\"result\\": {}\\n}","type":"json"}]', + 'title' => 'ModifyPassword', + 'description' => '### Method'."\n" + ."\n" + .'`PUT`'."\n" + ."\n" + .'### URI'."\n" + ."\n" + .'`/openapi/ha3/instances/{instanceId}/password`'."\n", + 'responseParamsDescription' => '### [](#)Description of response parameters'."\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', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'abilityTreeCode' => '102492', + 'abilityTreeNodes' => [ + 'FEATUREopensearch0AT3OG', + 'FEATUREopensearchJB31XH', + ], + ], + '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', + ], + ], + [ + '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' => 'tags', + 'in' => 'query', + '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, + ], + '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', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'The response parameters.'."\n", + 'type' => 'object', + 'properties' => [ + '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', + ], + ], + ], + ], + ], + ], + ], + ], + ], + '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', + ], + ], + ], + ], + ], + '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&instanceId=abc&page=1&size=10`', + 'responseParamsDescription' => '### Sample responses'."\n" + ."\n" + .'**Sample success responses**'."\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" + ."\n" + .'**Sample error responses**'."\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', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '102489', + 'abilityTreeNodes' => [ + 'FEATUREopensearch0AT3OG', + 'FEATUREopensearchJB31XH', + ], + ], + 'parameters' => [ + [ + 'name' => 'instanceId', + 'in' => 'path', + 'schema' => [ + 'title' => '实例 ID。', + 'description' => 'The instance ID.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'ha-cn-7pp2pcna701', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response'."\n", + 'type' => 'object', + 'properties' => [ + 'result' => [ + 'description' => 'Response parameters'."\n", + '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", + '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", + ], + ], + ], + 'spec' => [ + 'description' => 'The node specifications.'."\n", + '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', + ], + ], + ], + ], + ], + 'zoneCount' => [ + 'type' => 'integer', + 'format' => 'int32', + ], + ], + ], + 'requestId' => [ + 'title' => 'Id of the request', + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => 'E7B7D598-B080-5C8E-AA35-D43EC0D5F886', + ], + ], + ], + ], + 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', + ], + ], + [ + 'name' => 'type', + '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', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => 'The response parameters.'."\n", + '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', + ], + ], + ], + ], + ], + ], + ], + 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", + ], + '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' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + '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', + ], + ], + ], + ], + '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', + ], + '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-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", + 'type' => 'object', + 'properties' => [ + 'changeRate' => [ + 'title' => '索引变化率', + 'description' => 'The index change rate.'."\n", + 'type' => 'integer', + 'format' => 'int32', + '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', + ], + 'result' => [ + 'title' => 'Map', + 'description' => 'The result.'."\n", + 'type' => 'object', + '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' => '{}', + ], + ], + ], + ], + 'responses' => [ + 200 => [ + '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' => '{}', + ], + ], + ], + ], + 500 => [], + ], + '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", + ], + '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\\"}]}', + ], + ], + ], + ], + ], + '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", + ], + 'ModifyIndex' => [ + 'summary' => '编辑索引表', + 'path' => '/openapi/ha3/instances/{instanceId}/indexes/{indexName}', + 'methods' => [ + 'put', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '186780', + 'abilityTreeNodes' => [ + 'FEATUREopensearchVHEWK3', + ], + ], + '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', + ], + ], + [ + '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', + ], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', + 'schema' => [ + 'description' => 'The request body.'."\n", + 'type' => 'object', + 'properties' => [ + 'dataSourceInfo' => [ + 'description' => 'The information about the data source, which is required for the new version of OpenSearch Vector Search Edition.'."\n", + '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", + 'type' => 'object', + 'properties' => [ + 'namespace' => [ + 'description' => 'The namespace to which the SARO data source belongs.'."\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_', + ], + ], + '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", + ], + ], + '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' => [ + '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' => [ + '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", + ], + ], + 'required' => false, + 'description' => 'The configuration to be modified.'."\n", + ], + 'dirName' => [ + 'type' => 'string', + 'required' => false, + 'description' => 'The directory name.'."\n", + 'example' => '/test', + ], + ], + 'required' => false, + ], + 'required' => false, + 'description' => 'The files to be modified.'."\n", + ], + ], + '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" + .' }', + ], + ], + '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' => 'Object', + 'description' => 'The result.'."\n", + 'type' => 'any', + 'example' => '{}', + ], + ], + 'description' => '', + ], + ], + 500 => [], + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + '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', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'abilityTreeCode' => '187010', + 'abilityTreeNodes' => [ + 'FEATUREopensearchJ3PXKB', + ], + ], + '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', + ], + ], + ], + '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' => 'Map', + 'description' => 'The index map.'."\n", + 'type' => 'object', + 'example' => '{}', + ], + ], + 'description' => '', + ], + ], + 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', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'abilityTreeCode' => '187011', + 'abilityTreeNodes' => [ + 'FEATUREopensearchJ3PXKB', + ], + ], + 'parameters' => [ + [ + 'name' => 'instanceId', + 'in' => 'path', + 'schema' => [ + 'description' => 'The instance ID.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'ha-cn-0ju2rps6c08', + ], + ], + [ + 'name' => 'indexName', + 'in' => 'path', + 'schema' => [ + 'description' => 'The index name.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'test_api', + ], + ], + ], + '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 index map.'."\n", + 'type' => 'object', + 'example' => '{}', + ], + ], + 'description' => '', + ], + ], + 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', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '104691', + 'abilityTreeNodes' => [ + 'FEATUREopensearchVHEWK3', + ], + ], + 'parameters' => [ + [ + 'name' => 'instanceId', + 'in' => 'path', + 'schema' => [ + 'description' => 'The instance ID.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'ha-cn-2r42ppr7901', + ], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', + 'schema' => [ + 'description' => 'The request body.'."\n", + 'type' => 'object', + 'properties' => [ + 'name' => [ + 'title' => '名称', + 'description' => 'The index name.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'ha-cn-zvp2qr1sk01_qrs', + ], + '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", + '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", + ], + '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", + '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_', + ], + ], + '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', + ], + ], + 'required' => false, + ], + 'extend' => [ + 'description' => 'The extended content of the field configuration. key specifies the vector field and the field that requires embedding.'."\n", + 'type' => 'object', + 'required' => false, + 'example' => '{'."\n" + .' "vector":'."\n" + .' ['."\n" + .' "source_image_vector"'."\n" + .' ],'."\n" + .' "embeding":'."\n" + .' ['."\n" + .' "source_image"'."\n" + .' ],'."\n" + .' "description":'."\n" + .' []'."\n" + .' }', + ], + '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', + ], + ], + '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', + ], + ], + ], + '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' => '{}', + ], + ], + ], + ], + 500 => [], + ], + '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" + .'```java'."\n" + .'POST'."\n" + .'```'."\n" + ."\n" + .'### URI'."\n" + ."\n" + .'```java'."\n" + .'/openapi/ha3/instances/{instanceId}/indexes'."\n" + .'```'."\n", + 'requestParamsDescription' => '## Sample requests'."\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" + ."\n" + .'```java'."\n" + .'{'."\n" + .' "requestId": "0A6EB64B-B4C8-CF02-810F-E660812972FF",'."\n" + .' "result": {}'."\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', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '104671', + 'abilityTreeNodes' => [ + 'FEATUREopensearchD5N27K', + ], + ], + 'parameters' => [ + [ + 'name' => 'instanceId', + 'in' => 'path', + 'schema' => [ + 'title' => '实例ID', + 'description' => 'The instance ID.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'ha-cn-7mz2iv7sq01', + ], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', + 'schema' => [ + 'description' => 'The request body, which is a JSON string. For more information, see the following parameters.'."\n", + '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', + ], + ], + 'required' => false, + 'example' => '{}', + ], + ], + ], + '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' => '407BFD91-DE7D-50BA-8F88-CDE52A3B5E46', + ], + 'result' => [ + 'title' => '集群列表', + 'description' => 'The list of clusters'."\n", + 'type' => 'object', + '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', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + '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', + ], + ], + [ + 'name' => 'versionName', + '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', + ], + ], + ], + '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 result'."\n", + 'type' => 'object', + 'example' => '{}', + ], + ], + ], + ], + 500 => [], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"022F36C7-9FB4-5D67-BEBC-3D14B0984463\\",\\n \\"result\\": {}\\n}","type":"json"}]', + 'title' => 'DeleteIndexVersion', + 'description' => '## Method'."\n" + ."\n" + .' DELETE'."\n" + ."\n" + .'## URI'."\n" + ."\n" + .' /openapi/ha3/instances/{instanceId}/indexes/{indexName}/versions/{versionName}'."\n", + 'requestParamsDescription' => '## Sample requests'."\n" + ."\n" + .''."\n" + ."\n" + .' DELETE /openapi/ha3/instances/ose-test1/indexes/my_index/versions/version1'."\n", + 'responseParamsDescription' => '## [](#)Sample responses'."\n" + ."\n" + .'Sample success responses'."\n" + ."\n" + .' {'."\n" + .' '."\n" + .' "requestId": "65911539-5a8b-4bce-96a5-4d608900dc46",'."\n" + .' '."\n" + .' "result": []'."\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', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'instanceId', + 'in' => 'path', + 'schema' => [ + 'title' => '实例ID', + 'description' => 'The instance ID.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'ha-cn-2r42p5oi202', + ], + ], + [ + 'name' => 'indexName', + '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', + ], + ], + ], + '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' => '{}', + ], + ], + ], + ], + 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" + ."\n" + .'Success responses '."\n" + ."\n" + .' {'."\n" + .' '."\n" + .' "requestId": "65911539-5a8b-4bce-96a5-4d608900dc46",'."\n" + .' '."\n" + .' "result": []'."\n" + .' '."\n" + .' }'."\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', + ], + '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-7mz2j2off06', + ], + ], + [ + 'name' => 'clusterName', + 'in' => 'path', + 'schema' => [ + 'description' => 'The name of the cluster.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'vpc_hz_domain_2', + ], + ], + [ + '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' => '{}', + ], + ], + ], + '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' => '{}', + ], + ], + ], + ], + 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", + ], + '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-i7m2ne76e02', + ], + ], + [ + 'name' => 'indexName', + 'in' => 'path', + 'schema' => [ + 'description' => 'The index name.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'automobile_vector', + ], + ], + [ + 'name' => 'versionName', + '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', + ], + ], + [ + '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', + ], + ], + [ + '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\\"}', + ], + ], + ], + 'responses' => [ + 200 => [ + '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' => '{}', + ], + ], + 'description' => 'Schema of Response'."\n", + ], + ], + 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" + ."\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" + .' '."\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', + ], + '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-tl32m2c4u01', + ], + ], + [ + 'name' => 'indexName', + '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' => '{}', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + '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' => '{}', + ], + ], + ], + ], + 500 => [], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"E45380E8-994A-5402-9806-F114B3295FCF\\",\\n \\"result\\": {}\\n}","type":"json"}]', + 'title' => 'PublishIndexVersion', + 'description' => '## Method'."\n" + ."\n" + .' POST'."\n" + ."\n" + .'## URI'."\n" + ."\n" + .' /openapi/ha3/instances/{instanceId}/indexes/{indexName}/actions/publish'."\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", + 'responseParamsDescription' => '## [](#)Sample responses'."\n" + ."\n" + .'Sample success responses'."\n" + ."\n" + .' {'."\n" + .' '."\n" + .' "requestId": "65911539-5a8b-4bce-96a5-4d608900dc46",'."\n" + .' '."\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' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'instanceId', + 'in' => 'path', + 'schema' => [ + 'description' => 'The instance ID.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'ha-cn-7mz2ttxta01', + ], + ], + [ + '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' => '[]', + ], + ], + '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', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'abilityTreeCode' => '104685', + 'abilityTreeNodes' => [ + 'FEATUREopensearchJB31XH', + ], + ], + 'parameters' => [ + [ + 'name' => 'instanceId', + 'in' => 'path', + 'schema' => [ + 'description' => 'The instance ID.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'ha-cn-8ed2j834u03', + ], + ], + [ + 'name' => 'indexName', + 'in' => 'path', + 'schema' => [ + 'description' => 'The index name.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'index_jiayi_text', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'title' => 'id of request', + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => '4FB0325E-8C37-5525-96AC-0333523170A3', + ], + 'result' => [ + 'title' => 'IndexConfig', + 'description' => 'The index information.'."\n", + '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", + 'type' => 'object', + 'additionalProperties' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'string', + 'description' => 'Extended information'."\n", + 'example' => 'Extended information'."\n", + ], + 'description' => 'Extended information'."\n", + ], + ], + ], + ], + ], + 'description' => '', + ], + ], + '5xx' => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'type' => 'string', + ], + 'message' => [ + 'type' => 'string', + ], + 'code' => [ + 'type' => 'string', + ], + ], + ], + ], + ], + '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" + ."\n" + .' /openapi/ha3/instances/{instanceId}/indexes/{indexName}'."\n", + 'responseParamsDescription' => '## [](#)Sample responses'."\n" + ."\n" + .'Sample success response'."\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' => [], + ], + ], + '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', + ], + ], + [ + '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', + ], + ], + ], + ], + ], + ], + ], + ], + ], + 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', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'abilityTreeCode' => '104689', + 'abilityTreeNodes' => [ + 'FEATUREopensearch8WJIRU', + ], + ], + 'parameters' => [ + [ + 'name' => 'instanceId', + 'in' => 'path', + 'schema' => [ + 'title' => '实例ID', + 'description' => 'The instance ID.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'ha-cn-i7m2rpzm605', + ], + ], + [ + 'name' => 'indexName', + 'in' => 'path', + 'schema' => [ + 'title' => '索引名称', + 'description' => 'The index name.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'ecmon_table_index_test', + ], + ], + [ + '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' => 'fileName', + 'in' => 'query', + 'schema' => [ + 'title' => '文件全路径名称', + 'description' => 'The name of the file in full path'."\n", + 'type' => 'string', + 'required' => true, + 'example' => '/schemas/automobile_vector_schema.json', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + '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', + ], + ], + ], + ], + ], + ], + 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" + ."\n" + .' GET'."\n" + ."\n" + .'## [](#uri)URI'."\n" + ."\n" + .' /openapi/ha3/instances/{instanceId}/indexes/{indexName}/versions/{versionName}/file'."\n", + 'requestParamsDescription' => '## Sample requests'."\n" + ."\n" + .' GET /openapi/ha3/instances/ose-test1/indexes/index1/versions/version1?fileName=/root/test.txt'."\n", + 'responseParamsDescription' => '## Sample responses'."\n" + ."\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', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'abilityTreeCode' => '104683', + 'abilityTreeNodes' => [ + 'FEATUREopensearchA944AC', + 'FEATUREopensearchS8X6T8', + ], + ], + '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', + ], + ], + [ + 'name' => 'catalog', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + ], + ], + [ + 'name' => 'database', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + ], + ], + [ + 'name' => 'table', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => 'The response parameters.'."\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', + ], + ], + ], + ], + ], + ], + ], + 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', + 'description' => '## Method'."\n" + ."\n" + .' GET'."\n" + ."\n" + .'## URI'."\n" + ."\n" + .' /openapi/ha3/instances/{instanceId}/indexes'."\n", + 'requestParamsDescription' => '## Sample requests'."\n" + ."\n" + .''."\n" + ."\n" + .' GET /openapi/ha3/instances/ose-test1/indexes'."\n", + 'responseParamsDescription' => '## Sample responses'."\n" + ."\n" + .'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', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'abilityTreeCode' => '144320', + 'abilityTreeNodes' => [ + 'FEATUREopensearchVHEWK3', + ], + ], + 'parameters' => [ + [ + 'name' => 'instanceId', + 'in' => 'path', + 'schema' => [ + 'description' => 'The instance ID.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'ha-cn-zvp2jlr2g03', + ], + ], + [ + '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-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', + ], + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + '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' => '{}', + ], + ], + 'description' => '', + ], + ], + 500 => [], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"10D5E615-69F7-5F49-B850-00169ADE513C\\",\\n \\"result\\": {}\\n}","type":"json"}]', + 'title' => 'RecoverIndex', + 'description' => '### Method'."\n" + ."\n" + .'`POST`'."\n" + ."\n" + .'### URI'."\n" + ."\n" + .'`/openapi/ha3/instances/{instanceId}/recover-index`'."\n", + 'requestParamsDescription' => '### Sample requests'."\n" + ."\n" + .'`POST /openapi/ha3/instances/ha3_instances_id/recover-index`'."\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' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'instanceId', + 'in' => 'path', + 'schema' => [ + 'description' => 'The instance ID.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'ha-cn-7mz2iv7sq01', + ], + ], + [ + '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' => '{}', + ], + ], + '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', + ], + '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-2r42ostoc01', + ], + ], + [ + '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' => 'body', + 'in' => 'body', + 'style' => 'json', + 'schema' => [ + 'description' => 'The request body.'."\n", + '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', + ], + ], + 'required' => false, + ], + ], + ], + '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' => '{}', + ], + ], + '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', + ], + '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-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' => '/', + ], + ], + ], + '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' => '{}', + ], + ], + 'description' => '', + ], + ], + 500 => [], + ], + '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', + ], + '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-2r42ostoc01', + ], + ], + [ + 'name' => 'configName', + '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', + ], + ], + [ + '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' => '/', + ], + ], + ], + 'responses' => [ + 200 => [ + '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' => '{}', + ], + ], + 'description' => '', + ], + ], + 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', + ], + '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.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'ha-cn-tl32m2c4u01', + ], + ], + [ + 'name' => 'configName', + '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, + ], + ], + ], + 'responses' => [ + 200 => [ + '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' => '{}', + ], + ], + 'description' => '', + ], + ], + 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', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [], + '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', + ], + ], + ], + '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', + ], + 'result' => [ + 'title' => '结果', + 'description' => 'The result.'."\n", + 'type' => 'object', + '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" + ."\n" + .'Sample success responses '."\n" + ."\n" + .' {'."\n" + .' '."\n" + .' "requestId": "e1eef569-1ff7-4bf8-acf7-1cecca9894ce",'."\n" + .' '."\n" + .' "result": []'."\n" + .' '."\n" + .' }'."\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', + ], + '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-2r42ostoc01', + ], + ], + [ + 'name' => 'configName', + 'in' => 'path', + 'schema' => [ + 'description' => 'The configuration name.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'ha-cn-zvp2ou1h801_online_config_edit', + ], + ], + [ + 'name' => 'fileName', + 'in' => 'query', + 'schema' => [ + 'description' => 'The name of the file.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => '/qrs.json', + ], + ], + [ + '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' => '"ha3"', + ], + 'variables' => [ + 'title' => '变量值--在线配置', + 'description' => 'The variables.'."\n", + '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", + ], + ], + ], + 'required' => false, + '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', + ], + 'result' => [ + 'title' => 'Map', + 'description' => 'The result.'."\n", + 'type' => 'object', + '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" + ."\n" + .'Sample success responses'."\n" + ."\n" + .' {'."\n" + .' '."\n" + .' "requestId": "65911539-5a8b-4bce-96a5-4d608900dc46",'."\n" + .' '."\n" + .' "result": []'."\n" + .' '."\n" + .' }'."\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', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'abilityTreeCode' => '104708', + 'abilityTreeNodes' => [ + 'FEATUREopensearchA6GC80', + ], + ], + 'parameters' => [ + [ + 'name' => 'instanceId', + 'in' => 'path', + 'schema' => [ + 'description' => 'The instance ID.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'ha-cn-7e22rof5304', + ], + ], + [ + 'name' => 'configName', + '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\\"}', + ], + ], + ], + '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' => '10D5E615-69F7-5F49-B850-00169ADE513C', + ], + 'result' => [ + 'title' => 'Map', + 'description' => 'The result returned'."\n", + 'type' => 'object', + 'example' => '{}', + ], + ], + ], + ], + 500 => [], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"10D5E615-69F7-5F49-B850-00169ADE513C\\",\\n \\"result\\": {}\\n}","type":"json"}]', + 'title' => 'PublishAdvanceConfig', + 'description' => '## Method'."\n" + ."\n" + .'~~~'."\n" + .'POST'."\n" + .'~~~'."\n" + ."\n" + .'## 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" + ."\n" + .'{'."\n" + .' "desc": "new version"'."\n" + .'}'."\n" + .'~~~', + 'responseParamsDescription' => '## [](#)Sample responses'."\n" + ."\n" + .'### [](#)Sample success responses'."\n" + ."\n" + .'```json'."\n" + .'{'."\n" + .' "requestId": "65911539-5a8b-4bce-96a5-4d608900dc46",'."\n" + .' "result": {}'."\n" + .'}'."\n" + .'```'."\n" + ."\n" + .'For more information, see [Response structure](~~465311~~).'."\n", + ], + 'GetAdvanceConfig' => [ + 'path' => '/openapi/ha3/instances/{instanceId}/advanced-configs/{configName}', + '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-18qug6zlc1r', + ], + ], + [ + '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', + ], + ], + [ + 'name' => 'configName', + 'in' => 'path', + 'schema' => [ + 'description' => 'The name of the advanced configuration.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'ha-cn-18qug6zlc1r_offline_adv_edit', + ], + ], + ], + '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' => 'E45380E8-994A-5402-9806-F114B3295FCF', + ], + 'result' => [ + 'title' => 'AdvanceConfig', + 'description' => 'The result.'."\n", + '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', + ], + 'files' => [ + 'title' => '文件名列表', + 'description' => 'The files.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'An array of files.'."\n", + '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', + ], + ], + ], + ], + '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', + ], + ], + ], + ], + ], + ], + 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"}]', + 'title' => 'GetAdvanceConfig', + 'summary' => 'Queries the information about an advanced configuration.', + 'description' => '## Method'."\n" + ."\n" + .' GET'."\n" + ."\n" + .'## URI'."\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", + '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", + ], + 'GetAdvanceConfigFile' => [ + 'summary' => 'Queries the information about an advanced configuration file.', + 'path' => '/openapi/ha3/instances/{instanceId}/advanced-configs/{configName}/file', + '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-2r42ostoc01', + ], + ], + [ + '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', + ], + ], + [ + 'name' => 'fileName', + 'in' => 'query', + 'schema' => [ + 'title' => '文件名称', + 'description' => 'The name of the file'."\n", + 'type' => 'string', + 'required' => true, + 'example' => '/intervene_dict/chn_ecommerce_general.dict', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'The response parameters.'."\n", + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'title' => 'id of request', + 'description' => 'id of request'."\n", + 'type' => 'string', + 'example' => '10D5E615-69F7-5F49-B850-00169ADE513C', + ], + 'result' => [ + 'title' => '结果', + 'description' => 'The result.'."\n", + '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"}', + ], + ], + ], + ], + ], + ], + 500 => [], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"10D5E615-69F7-5F49-B850-00169ADE513C\\",\\n \\"result\\": {\\n \\"content\\": \\"{\\\\\\\\\\\\\\"url\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"http://xxxxxx.aliyuncs.com/outnet_hz/packages/xxxxx/opensearch_offline_plugins_xxxxx.tar\\\\\\\\\\\\\\"}\\"\\n }\\n}","type":"json"}]', + 'title' => 'GetAdvanceConfigFile', + 'description' => '## Method'."\n" + ."\n" + .' GET'."\n" + ."\n" + .'## URI'."\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', + ], + '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-tl32n3iu801', + ], + ], + [ + 'name' => 'configName', + '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', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'title' => 'id of request', + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => '2AE63638-5420-56DC-BF59-37D8174039A0', + ], + '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"', + ], + 'isDir' => [ + 'description' => 'Indicates whether the file is a directory. Valid values: true and false.'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + 'isTemplate' => [ + 'description' => 'Indicates whether the file is a template. Valid values: **true** and **false**.'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + 'description' => '', + ], + ], + 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" + ."\n" + .'`GET`'."\n" + ."\n" + .'## URI'."\n" + ."\n" + .'`/openapi/ha3/instances/{instanceId}/advanced-configs/{configName}/dir?dirName={dirName}`'."\n", + 'requestParamsDescription' => '## Sample requests'."\n" + ."\n" + .'`GET /openapi/ha3/instances/ose-test1/advanced-configs`'."\n", + 'responseParamsDescription' => '## Sample responses'."\n" + ."\n" + .'### Success responses'."\n" + ."\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" + .'```'."\n", + ], + 'ListAdvanceConfigs' => [ + 'path' => '/openapi/ha3/instances/{instanceId}/advanced-configs', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'abilityTreeCode' => '104702', + 'abilityTreeNodes' => [ + 'FEATUREopensearchA6GC80', + ], + ], + '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', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => 'The response parameters.'."\n", + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'title' => 'id of request', + 'description' => 'The ID of the request.', + 'type' => 'string', + 'example' => '4FB0325E-8C37-5525-96AC-0333523170A3', + ], + 'result' => [ + 'title' => 'List', + 'description' => 'The advanced configurations.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The result returned.', + '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', + ], + 'files' => [ + 'title' => '文件名列表', + 'description' => 'The files.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The information about files.', + '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', + ], + 'isDir' => [ + 'description' => 'Indicates whether the file is a directory. Valid values: true and false.'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + 'isTemplate' => [ + 'description' => 'Indicates whether the file is a template. Valid values: true and false.'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + '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', + ], + ], + ], + ], + ], + ], + ], + 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" + ."\n" + .'`GET /openapi/ha3/instances/ose-test1/advanced-configs`', + ], + 'ListSchemas' => [ + 'summary' => '通过数据源配置获取schema信息', + 'path' => '/openapi/ha3/instances/{instanceId}/schemas', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'abilityTreeCode' => '186763', + 'abilityTreeNodes' => [ + 'FEATUREopensearchVHEWK3', + ], + ], + '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.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'ha-cn-0ju2rq6610a', + ], + ], + ], + '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' => 'Object', + 'description' => 'The result.'."\n", + 'type' => 'any', + 'example' => '{}', + ], + ], + 'description' => '', + ], + ], + 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', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '159954', + 'abilityTreeNodes' => [ + 'FEATUREopensearchVHEWK3', + ], + ], + 'parameters' => [ + [ + 'name' => 'instanceId', + 'in' => 'path', + 'schema' => [ + 'description' => 'The cluster ID.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'ha-cn-0ju2rps6c08', + ], + ], + [ + 'name' => 'deployName', + 'in' => 'path', + 'schema' => [ + 'description' => 'The name of the data center.'."\n", + 'type' => 'string', + 'required' => true, + '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', + ], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', + '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", + '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", + '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', + ], + ], + 'required' => false, + ], + 'hdfs' => [ + 'description' => 'The information about the Apsara File Storage for HDFS data source.'."\n", + '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', + ], + ], + 'required' => false, + ], + 'odps' => [ + 'description' => 'The information about the MaxCompute data source.'."\n", + 'type' => 'object', + 'properties' => [ + 'partitions' => [ + 'description' => 'The partitions in the MaxCompute table.'."\n", + 'type' => 'object', + 'required' => false, + 'additionalProperties' => [ + 'type' => 'string', + 'description' => 'The partition in the MaxCompute table.'."\n", + 'example' => 'ds=20230824', + ], + ], + ], + 'required' => false, + ], + 'oss' => [ + 'description' => 'The information about the OSS data source.'."\n", + 'type' => 'object', + 'properties' => [ + 'path' => [ + 'description' => 'The path of the OSS data source.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'oss://test', + ], + ], + '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', + ], + ], + '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' => '{}', + ], + ], + 'description' => '', + ], + ], + 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', + ], + ], + '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", + ], + ], + [ + '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' => '{}', + ], + ], + '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', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [], + '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' => '{}', + ], + ], + ], + ], + 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', + 'in' => 'path', + 'schema' => [ + 'description' => 'The instance ID.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'ha-cn-2r42ostoc01', + ], + ], + [ + 'name' => 'dataSourceName', + 'in' => 'path', + 'schema' => [ + 'description' => 'The name of the data source.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'ha-cn-2r42ostoc01_people_info', + ], + ], + ], + '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', + ], + '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', + ], + ], + ], + ], + ], + ], + 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', + 'description' => '### Method'."\n" + ."\n" + .'`GET`'."\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' => [], + ], + ], + '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-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', + ], + ], + ], + ], + ], + ], + ], + 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', + ], + '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-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', + ], + ], + ], + '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', + ], + 'result' => [ + 'title' => 'List', + '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', + ], + 'hasPrimaryKeyAttribute' => [ + 'description' => 'Indicates whether the field has the primary key attribute. Valid values: **true** and **false**.'."\n", + 'type' => 'boolean', + 'example' => 'false', + ], + 'isPrimaryKeySorted' => [ + 'description' => 'Indicates whether the field can be sorted. Valid values: **true** and **false**.'."\n", + 'type' => 'boolean', + 'example' => 'false', + ], + ], + ], + 'addIndex' => [ + 'title' => '是否添加了index属性', + 'description' => 'Indicates whether the field has the index attribute. Valid values: **true** and **false**.'."\n", + 'type' => 'boolean', + 'example' => 'false', + ], + ], + ], + ], + ], + ], + ], + 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", + ], + 'ListDateSourceGenerations' => [ + 'path' => '/openapi/ha3/instances/{instanceId}/data-sources/{dataSourceName}/generations', + '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-7mz2ttxta01', + ], + ], + [ + 'name' => 'dataSourceName', + 'in' => 'path', + 'schema' => [ + 'description' => 'The name of the data source.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'ha-cn-0ju2s170b03_test_api2', + ], + ], + [ + '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' => 'domainName', + 'in' => 'query', + 'schema' => [ + 'description' => 'The data center where the data source is deployed.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'bj_vpc_domain_1', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'title' => 'id of request', + 'description' => 'id of request'."\n", + 'type' => 'string', + 'example' => '022F36C7-9FB4-5D67-BEBC-3D14B0984463', + ], + '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' => '""', + ], + ], + ], + ], + ], + 'description' => '', + ], + ], + 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" + ."\n" + .'`GET`'."\n" + ."\n" + .'### URI'."\n" + ."\n" + .'`/openapi/ha3/instances/{instanceId}/data-sources/{dataSourceName}/generations?domainName={domainName}`'."\n", + 'requestParamsDescription' => '### Sample requests'."\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', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'abilityTreeCode' => '159951', + 'abilityTreeNodes' => [ + 'FEATUREopensearchA944AC', + 'FEATUREopensearchS8X6T8', + ], + ], + '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', + ], + ], + [ + 'name' => 'dataSourceName', + 'in' => 'path', + 'schema' => [ + 'description' => 'The name of the data source.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'ha-cn-9lb34d9ee01_image_embedding', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'title' => 'id of request', + 'description' => 'requestId', + 'type' => 'string', + 'example' => '2AE63638-5420-56DC-BF59-37D8174039A0', + ], + 'result' => [ + 'title' => 'Deploy', + 'description' => 'The result.'."\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', + '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' => '{}', + ], + ], + ], + 'extend' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'saro' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'path' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'dist-dmj-job/src/main/java', + ], + 'version' => [ + 'description' => '', + 'type' => 'string', + 'example' => '0.6.0', + ], + ], + ], + 'hdfs' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'path' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'dist-dmj-job/src/main/java', + ], + ], + ], + 'odps' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'partitions' => [ + 'description' => '', + 'type' => 'object', + 'additionalProperties' => [ + 'type' => 'string', + 'example' => 'ds=20220926', + 'description' => '', + ], + ], + ], + ], + 'oss' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'path' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'oss://opensearch', + ], + ], + ], + ], + ], + 'swift' => [ + 'title' => '增量swift信息', + 'description' => 'The information about the incremental data source Swift.'."\n", + 'type' => 'object', + 'properties' => [ + 'zk' => [ + 'description' => 'zk'."\n", + 'type' => 'string', + 'example' => 'zk', + ], + 'topic' => [ + 'description' => 'The topic.'."\n", + 'type' => 'string', + 'example' => 'topic', + ], + ], + ], + ], + ], + ], + 'description' => '', + ], + ], + 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', + 'schema' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'targetFolderId' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '1', + ], + 'name' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'test', + ], + ], + 'required' => false, + ], + ], + ], + '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', + ], + ], + ], + ], + ], + ], + 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', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'abilityTreeCode' => '138808', + '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' => '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, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'title' => 'id of request', + 'description' => 'id of request', + 'type' => 'string', + 'example' => 'E7B7D598-B080-5C8E-AA35-D43EC0D5F886', + ], + 'result' => [ + 'title' => 'NodeVO', + 'description' => 'NodeVO', + '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', + ], + ], + ], + ], + ], + ], + 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', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'abilityTreeCode' => '139624', + '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' => '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, + ], + ], + ], + 'responses' => [ + 200 => [ + 'headers' => [], + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'title' => 'id of request', + 'description' => 'id of request', + 'type' => 'string', + 'example' => 'B43CD1BB-ABD7-59C5-B89A-6E5F6FE60A84', + ], + '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' => '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', + ], + ], + ], + ], + ], + ], + 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', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + '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-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', + ], + ], + ], + 'responses' => [ + 200 => [ + '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>>', + 'type' => 'object', + 'properties' => [ + 'result' => [ + 'description' => 'The result.'."\n", + 'type' => 'object', + 'additionalProperties' => [ + 'type' => 'string', + 'example' => '{}', + 'description' => 'The result.', + ], + ], + 'requestId' => [ + 'description' => 'id of request'."\n", + 'type' => 'string', + 'example' => '2AE63638-5420-56DC-BF59-37D8174039A0', + ], + ], + ], + ], + ], + ], + 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', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'abilityTreeCode' => '139115', + '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', + '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, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'title' => 'id of request', + 'description' => 'id of request', + 'type' => 'string', + 'example' => 'FE03180A-0E29-5474-8A86-33F0683294A4', + ], + 'result' => [ + 'title' => 'NodeVO', + 'description' => 'NodeVO', + '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', + ], + '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', + ], + ], + ], + ], + ], + ], + 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', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + ], + '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' => 'tableName', + 'in' => 'path', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'graph_index_summary_', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'title' => 'id of request', + 'description' => 'id of request', + 'type' => 'string', + 'example' => '022F36C7-9FB4-5D67-BEBC-3D14B0984463', + ], + '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', + ], + ], + ], + ], + ], + ], + ], + 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.', + ], + 'GetSqlInstance' => [ + 'path' => '/openapi/ha3/instances/{instanceId}/sql-studio/databases/{database}/sql-instances/{sqlInstanceId}', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'https', + 'http', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + ], + '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' => '5978', + ], + ], + [ + 'name' => 'version', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1', + 'default' => '0', + ], + ], + ], + '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' => 'InstanceVersionVO', + 'description' => 'InstanceVersionVO', + '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}', + ], + ], + ], + ], + ], + ], + 500 => [], + ], + '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', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + ], + 'parameters' => [ + [ + 'name' => 'instanceId', + 'in' => 'path', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'ha-cn-pl32rf0****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'title' => 'id of request', + 'description' => 'id of request', + 'type' => 'string', + 'example' => 'E45380E8-994A-5402-9806-F114B3295FCF', + ], + 'result' => [ + 'title' => 'NodeTreeVO', + 'description' => 'NodeTreeVO', + 'type' => 'object', + 'properties' => [ + 'databases' => [ + 'description' => '', + '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', + ], + ], + ], + ], + 'functions' => [ + 'description' => '', + 'type' => 'object', + 'additionalProperties' => [ + 'type' => 'array', + 'items' => [ + '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', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 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', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'abilityTreeCode' => '139112', + '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' => '5975', + ], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', + 'schema' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'content' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'select * from test', + ], + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'title' => 'id of request', + 'description' => 'id of request', + 'type' => 'string', + 'example' => 'E45380E8-994A-5402-9806-F114B3295FCF', + ], + 'result' => [ + 'title' => 'InstanceVersionVO', + 'description' => 'InstanceVersionVO', + '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}', + ], + ], + ], + ], + ], + ], + 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', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'abilityTreeCode' => '139114', + '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', + 'schema' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'name' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'test', + ], + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'title' => 'id of request', + 'description' => 'id of request', + 'type' => 'string', + 'example' => 'E7B7D598-B080-5C8E-AA35-D43EC0D5F886', + ], + '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', + ], + ], + ], + ], + ], + ], + 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', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'abilityTreeCode' => '139113', + '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', + '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, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'title' => 'id of request', + 'description' => 'id of request', + 'type' => 'string', + 'example' => '022F36C7-9FB4-5D67-BEBC-3D14B0984463', + ], + '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}', + ], + ], + ], + ], + ], + ], + 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', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + 'abilityTreeCode' => '138810', + 'abilityTreeNodes' => [ + 'FEATUREopensearch95VJR4', + ], + ], + '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', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'title' => 'id of request', + 'description' => 'id of request', + 'type' => 'string', + 'example' => '022F36C7-9FB4-5D67-BEBC-3D14B0984463', + ], + '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', + ], + ], + ], + ], + ], + ], + 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', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + '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, + ], + ], + ], + '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' => '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', + ], + ], + ], + ], + ], + ], + 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', + ], + ], + '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', + ], + ], + [ + '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' => '{}', + ], + ], + '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', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + ], + 'parameters' => [ + [ + 'name' => 'instanceId', + 'in' => 'path', + 'schema' => [ + 'title' => '实例ID', + 'description' => 'The instance ID.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'ha-cn-i7m2roiy504', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + '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', + ], + 'result' => [ + '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' => '" "', + ], + 'tags' => [ + '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', + ], + ], + ], + ], + 'taskNodes' => [ + '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', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 500 => [], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"CC5EC8FA-5C0D-56AF-BEF4-6FCCEABD0511\\",\\n \\"result\\": [\\n {\\n \\"groupType\\": \\"Table_Update\\",\\n \\"fsmId\\": \\"tisplus_opensearch@datasource_flow_fsm@1865410598556969-ha-cn-pl32rf0****_api2@bj_vpc_domain_1@null@MANUAL-ha-cn-pl32rf0****_api2@1649729867698@028315\\",\\n \\"name\\": \\"ha-cn-pl32rf0****_qrs\\",\\n \\"time\\": \\"1657610520\\",\\n \\"type\\": \\"mra_table_config_trace_fsm\\",\\n \\"user\\": \\"admin\\",\\n \\"status\\": \\"onlyPublished\\",\\n \\"extraAttribute\\": \\"{\\\\n\\\\t\\\\\\"consoleVersion\\\\\\": \\\\\\"\\\\\\",\\\\n\\\\t\\\\\\"domain\\\\\\": \\\\\\"hz_pre_vpc_domain_1\\\\\\",\\\\n\\\\t\\\\\\"configType\\\\\\": \\\\\\"offline\\\\\\"\\\\n}\\",\\n \\"field3\\": \\"{\\\\n\\\\t\\\\\\"ha-cn-pl32rf0****_offline_adv\\\\\\": 1,\\\\n\\\\t\\\\\\"ha-cn-pl32rf0****_offline_plugin\\\\\\": 1,\\\\n\\\\t\\\\\\"ha-cn-pl32rf0****_table_ha-cn-35t3r02iq03_test_api\\\\\\": 1,\\\\n\\\\t\\\\\\"ha-cn-pl32rf0****@ha-cn-pl32rf0****_test_api@hz_pre_vpc_domain_1@test_api@index_config\\\\\\": 1,\\\\n\\\\t\\\\\\"ha-cn-pl32rf0****_offline_dict\\\\\\": 1\\\\n}\\",\\n \\"tags\\": [\\n {\\n \\"tagLevel\\": \\"1\\",\\n \\"msg\\": \\"test-tag\\"\\n }\\n ],\\n \\"taskNodes\\": [\\n {\\n \\"name\\": \\"publish config version\\",\\n \\"index\\": 4,\\n \\"finishDate\\": \\"2024-06-17 18:40:48\\",\\n \\"status\\": \\"SUCCESS\\"\\n }\\n ]\\n }\\n ]\\n}","type":"json"}]', + 'title' => 'ListClusterTasks', + 'description' => '### Method'."\n" + ."\n" + .'```java'."\n" + .'GET'."\n" + .'```'."\n" + ."\n" + .'### URI'."\n" + ."\n" + .'```java'."\n" + .'/openapi/ha3/instances/{instanceId}/cluster-tasks'."\n" + .'```'."\n", + 'requestParamsDescription' => '### Sample requests'."\n" + ."\n" + .'```java'."\n" + .'GET /openapi/ha3/instances/{instanceId}/cluster-tasks'."\n" + .'```'."\n" + ."\n" + .''."\n", + 'responseParamsDescription' => '### Sample responses'."\n" + ."\n" + .'Success responses'."\n" + ."\n" + .'```java'."\n" + .'{'."\n" + .' "requestId": "0A6EB64B-B4C8-CF02-810F-E660812972FF",'."\n" + .' "result": ['."\n" + .' {'."\n" + .' "groupType": "table",'."\n" + .' "fsmId": "tisplus_opensearch@create_online_deploy_fsm@opensearch_pre_standard_private_20211110_2@pre_domain_1@null@null@1637215469093@127746",'."\n" + .' "name": "",'."\n" + .' "taskNodes": ['."\n" + .' {'."\n" + .' "nodeInfo": {'."\n" + .' "msg": "stopped clean fsm: []",'."\n" + .' "name": "stop clean",'."\n" + .' "index": 0,'."\n" + .' "finishDate": "2021-11-18 14:04:49",'."\n" + .' "status": "SUCCESS"'."\n" + .' }'."\n" + .' },'."\n" + .' {'."\n" + .' "nodeInfo": {'."\n" + .' "name": "prepare",'."\n" + .' "index": 1,'."\n" + .' "finishDate": "2021-11-18 14:05:09",'."\n" + .' "status": "SUCCESS"'."\n" + .' }'."\n" + .' },'."\n" + .' {'."\n" + .' "nodeInfo": {'."\n" + .' "name": "merger port",'."\n" + .' "index": 2,'."\n" + .' "finishDate": "2021-11-18 14:05:19",'."\n" + .' "status": "SUCCESS"'."\n" + .' }'."\n" + .' },'."\n" + .' {'."\n" + .' "nodeInfo": {'."\n" + .' "name": "moss create",'."\n" + .' "index": 3,'."\n" + .' "finishDate": "2021-11-18 14:05:39",'."\n" + .' "status": "SUCCESS"'."\n" + .' }'."\n" + .' },'."\n" + .' {'."\n" + .' "nodeInfo": {'."\n" + .' "name": "submit hippo",'."\n" + .' "index": 4,'."\n" + .' "finishDate": "2021-11-18 14:05:59",'."\n" + .' "status": "SUCCESS"'."\n" + .' }'."\n" + .' },'."\n" + .' {'."\n" + .' "nodeInfo": {'."\n" + .' "name": "admin started",'."\n" + .' "index": 5,'."\n" + .' "finishDate": "2021-11-18 14:16:05",'."\n" + .' "status": "SUCCESS"'."\n" + .' }'."\n" + .' },'."\n" + .' {'."\n" + .' "nodeInfo": {'."\n" + .' "name": "zone create",'."\n" + .' "index": 6,'."\n" + .' "finishDate": "2021-11-18 14:16:45",'."\n" + .' "status": "SUCCESS"'."\n" + .' }'."\n" + .' },'."\n" + .' {'."\n" + .' "nodeInfo": {'."\n" + .' "name": "switch index",'."\n" + .' "index": 13,'."\n" + .' "finishDate": "2021-11-18 14:16:55",'."\n" + .' "status": "SUCCESS"'."\n" + .' }'."\n" + .' }'."\n" + .' ],'."\n" + .' "time": "2021-11-18 14:04:29",'."\n" + .' "type": "onlineGroup",'."\n" + .' "user": "74087",'."\n" + .' "status": "success"'."\n" + .' },'."\n" + .' {'."\n" + .' "groupType": "table",'."\n" + .' "fsmId": "tisplus_opensearch@delete_biz_fsm@multi_biz_opensearch-default@null@null@default@1631777272819@926304",'."\n" + .' "name": "delete_biz_fsm",'."\n" + .' "taskNodes": ['."\n" + .' {'."\n" + .' "nodeInfo": {'."\n" + .' "msg": "stop biz create fsm success",'."\n" + .' "name": "stop fsm",'."\n" + .' "index": 0,'."\n" + .' "finishDate": "2021-09-16 15:27:53",'."\n" + .' "status": "SUCCESS"'."\n" + .' }'."\n" + .' },'."\n" + .' {'."\n" + .' "nodeInfo": {'."\n" + .' "msg": "Ha3BizConfigResource [default] not exist",'."\n" + .' "name": "delete moss",'."\n" + .' "index": 1,'."\n" + .' "finishDate": "2021-09-16 15:28:04",'."\n" + .' "status": "SUCCESS"'."\n" + .' }'."\n" + .' },'."\n" + .' {'."\n" + .' "nodeInfo": {'."\n" + .' "msg": "skip delete cause resource[name=default] not exist",'."\n" + .' "name": "delete biz resource",'."\n" + .' "index": 2,'."\n" + .' "finishDate": "2021-09-16 15:28:14",'."\n" + .' "status": "SUCCESS"'."\n" + .' }'."\n" + .' },'."\n" + .' {'."\n" + .' "nodeInfo": {'."\n" + .' "msg": "skip check cause no InnerData.BizConfigResource is null",'."\n" + .' "name": "check suez",'."\n" + .' "index": 3,'."\n" + .' "finishDate": "2021-09-16 15:28:24",'."\n" + .' "status": "SUCCESS"'."\n" + .' }'."\n" + .' },'."\n" + .' {'."\n" + .' "nodeInfo": {'."\n" + .' "name": "finished",'."\n" + .' "index": 4,'."\n" + .' "finishDate": "2021-09-16 15:28:24",'."\n" + .' "status": "SUCCESS"'."\n" + .' }'."\n" + .' }'."\n" + .' ],'."\n" + .' "time": "2021-09-16 15:27:53",'."\n" + .' "type": "delete_biz_fsm",'."\n" + .' "user": "",'."\n" + .' "status": "success"'."\n" + .' }'."\n" + .' ]'."\n" + .'```'."\n", + ], + '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' => '实例ID', + 'description' => 'The instance ID.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'ha-cn-7e22rof5304', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + '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', + ], + 'result' => [ + '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' => '""', + ], + 'tags' => [ + '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', + ], + ], + ], + ], + 'taskNodes' => [ + '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', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 500 => [], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"CC5EC8FA-5C0D-56AF-BEF4-6FCCEABD0511\\",\\n \\"result\\": [\\n {\\n \\"groupType\\": \\"Table_Update\\",\\n \\"fsmId\\": \\"tisplus_opensearch@datasource_flow_fsm@1865410598556969-ha-cn-pl32rf0****_api2@bj_vpc_domain_1@null@MANUAL-ha-cn-pl32rf0****_api2@1649729867698@028315\\",\\n \\"name\\": \\"ha-cn-pl32rf0****_qrs\\\\n\\",\\n \\"time\\": \\"1646279473\\",\\n \\"type\\": \\"mra_table_config_trace_fsm\\\\n\\",\\n \\"user\\": \\"admin\\",\\n \\"status\\": \\"onlyPublished\\",\\n \\"extraAttribute\\": \\"{\\\\n\\\\t\\\\\\"consoleVersion\\\\\\": \\\\\\"\\\\\\",\\\\n\\\\t\\\\\\"domain\\\\\\": \\\\\\"hz_pre_vpc_domain_1\\\\\\",\\\\n\\\\t\\\\\\"configType\\\\\\": \\\\\\"offline\\\\\\"\\\\n}\\",\\n \\"field3\\": \\"{\\\\n\\\\t\\\\\\"ha-cn-pl32rf0****_offline_adv\\\\\\": 1,\\\\n\\\\t\\\\\\"ha-cn-pl32rf0****_offline_plugin\\\\\\": 1,\\\\n\\\\t\\\\\\"ha-cn-pl32rf0****_table_ha-cn-35t3r02iq03_test_api\\\\\\": 1,\\\\n\\\\t\\\\\\"ha-cn-pl32rf0****@ha-cn-pl32rf0****_test_api@hz_pre_vpc_domain_1@test_api@index_config\\\\\\": 1,\\\\n\\\\t\\\\\\"ha-cn-pl32rf0****_offline_dict\\\\\\": 1\\\\n}\\\\n\\",\\n \\"tags\\": [\\n {\\n \\"tagLevel\\": \\"1\\",\\n \\"msg\\": \\"test-tag\\"\\n }\\n ],\\n \\"taskNodes\\": [\\n {\\n \\"name\\": \\"publish config version\\\\n\\",\\n \\"index\\": 4,\\n \\"finishDate\\": \\"2024-06-17 18:40:48\\\\n\\",\\n \\"status\\": \\"SUCCESS\\"\\n }\\n ]\\n }\\n ]\\n}","type":"json"}]', + 'title' => 'ListDataSourceTasks', + 'description' => '### [](#)Method'."\n" + ."\n" + .'```java'."\n" + .'GET'."\n" + .'```'."\n" + ."\n" + .'### [](#uri)URI'."\n" + ."\n" + .'```java'."\n" + .'/openapi/ha3/instances/{instanceId}/data-source-tasks'."\n" + .'```'."\n", + 'requestParamsDescription' => '### Sample requests'."\n" + ."\n" + .'```java'."\n" + .'GET /openapi/ha3/instances/{instanceId}/data-source-tasks'."\n" + .'```'."\n", + 'responseParamsDescription' => '### Sample responses'."\n" + ."\n" + .'Success responses'."\n" + ."\n" + .'```java'."\n" + .'{'."\n" + .' "requestId": "0A6EB64B-B4C8-CF02-810F-E660812972FF",'."\n" + .' "result": ['."\n" + .' {'."\n" + .' "groupType": "table",'."\n" + .' "fsmId": "tisplus_opensearch@create_online_deploy_fsm@opensearch_pre_standard_private_20211110_2@pre_domain_1@null@null@1637215469093@127746",'."\n" + .' "name": "",'."\n" + .' "taskNodes": ['."\n" + .' {'."\n" + .' "nodeInfo": {'."\n" + .' "msg": "stopped clean fsm: []",'."\n" + .' "name": "stop clean",'."\n" + .' "index": 0,'."\n" + .' "msg":"",'."\n" + .' "finishDate": "2021-11-18 14:04:49",'."\n" + .' "status": "SUCCESS"'."\n" + .' }'."\n" + .' },'."\n" + .' {'."\n" + .' "nodeInfo": {'."\n" + .' "name": "prepare",'."\n" + .' "index": 1,'."\n" + .' "finishDate": "2021-11-18 14:05:09",'."\n" + .' "status": "SUCCESS"'."\n" + .' }'."\n" + .' },'."\n" + .' {'."\n" + .' "nodeInfo": {'."\n" + .' "name": "merger port",'."\n" + .' "index": 2,'."\n" + .' "finishDate": "2021-11-18 14:05:19",'."\n" + .' "status": "SUCCESS"'."\n" + .' }'."\n" + .' },'."\n" + .' {'."\n" + .' "nodeInfo": {'."\n" + .' "name": "moss create",'."\n" + .' "index": 3,'."\n" + .' "finishDate": "2021-11-18 14:05:39",'."\n" + .' "status": "SUCCESS"'."\n" + .' }'."\n" + .' },'."\n" + .' {'."\n" + .' "nodeInfo": {'."\n" + .' "name": "submit hippo",'."\n" + .' "index": 4,'."\n" + .' "finishDate": "2021-11-18 14:05:59",'."\n" + .' "status": "SUCCESS"'."\n" + .' }'."\n" + .' },'."\n" + .' {'."\n" + .' "nodeInfo": {'."\n" + .' "name": "admin started",'."\n" + .' "index": 5,'."\n" + .' "finishDate": "2021-11-18 14:16:05",'."\n" + .' "status": "SUCCESS"'."\n" + .' }'."\n" + .' },'."\n" + .' {'."\n" + .' "nodeInfo": {'."\n" + .' "name": "zone create",'."\n" + .' "index": 6,'."\n" + .' "finishDate": "2021-11-18 14:16:45",'."\n" + .' "status": "SUCCESS"'."\n" + .' }'."\n" + .' },'."\n" + .' {'."\n" + .' "nodeInfo": {'."\n" + .' "name": "switch index",'."\n" + .' "index": 13,'."\n" + .' "finishDate": "2021-11-18 14:16:55",'."\n" + .' "status": "SUCCESS"'."\n" + .' }'."\n" + .' }'."\n" + .' ],'."\n" + .' "time": "2021-11-18 14:04:29",'."\n" + .' "type": "onlineGroup",'."\n" + .' "user": "74087",'."\n" + .' "status": "success"'."\n" + .' },'."\n" + .' {'."\n" + .' "groupType": "table",'."\n" + .' "fsmId": "tisplus_opensearch@delete_biz_fsm@multi_biz_opensearch-default@null@null@default@1631777272819@926304",'."\n" + .' "name": "delete_biz_fsm",'."\n" + .' "taskNodes": ['."\n" + .' {'."\n" + .' "nodeInfo": {'."\n" + .' "msg": "stop biz create fsm success",'."\n" + .' "name": "stop fsm",'."\n" + .' "index": 0,'."\n" + .' "finishDate": "2021-09-16 15:27:53",'."\n" + .' "status": "SUCCESS"'."\n" + .' }'."\n" + .' },'."\n" + .' {'."\n" + .' "nodeInfo": {'."\n" + .' "msg": "Ha3BizConfigResource [default] not exist",'."\n" + .' "name": "delete moss",'."\n" + .' "index": 1,'."\n" + .' "finishDate": "2021-09-16 15:28:04",'."\n" + .' "status": "SUCCESS"'."\n" + .' }'."\n" + .' },'."\n" + .' {'."\n" + .' "nodeInfo": {'."\n" + .' "msg": "skip delete cause resource[name=default] not exist",'."\n" + .' "name": "delete biz resource",'."\n" + .' "index": 2,'."\n" + .' "finishDate": "2021-09-16 15:28:14",'."\n" + .' "status": "SUCCESS"'."\n" + .' }'."\n" + .' },'."\n" + .' {'."\n" + .' "nodeInfo": {'."\n" + .' "msg": "skip check cause no InnerData.BizConfigResource is null",'."\n" + .' "name": "check suez",'."\n" + .' "index": 3,'."\n" + .' "finishDate": "2021-09-16 15:28:24",'."\n" + .' "status": "SUCCESS"'."\n" + .' }'."\n" + .' },'."\n" + .' {'."\n" + .' "nodeInfo": {'."\n" + .' "name": "finished",'."\n" + .' "index": 4,'."\n" + .' "finishDate": "2021-09-16 15:28:24",'."\n" + .' "status": "SUCCESS"'."\n" + .' }'."\n" + .' }'."\n" + .' ],'."\n" + .' "time": "2021-09-16 15:27:53",'."\n" + .' "type": "delete_biz_fsm",'."\n" + .' "user": "",'."\n" + .' "status": "success"'."\n" + .' }'."\n" + .' ]'."\n" + .'```'."\n", + ], + 'StopTask' => [ + 'summary' => 'Stops an FSM task.', + 'path' => '/openapi/ha3/instances/{instanceId}/stop-task/{fsmId}', + 'methods' => [ + 'put', + ], + 'schemes' => [ + 'http', + 'https', + ], + '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-7mz2nx41h01', + ], + ], + [ + '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-0ju2rrogr01_test_api_2@sz_vpc_domain_1@null@MANUAL-ha-cn-0ju2rrogr01_test_api_2@1657511220772@165343', + ], + ], + ], + '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', + ], + 'result' => [ + 'title' => '索引信息', + 'description' => 'The information about the index'."\n", + 'type' => 'object', + '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", + ], + 'ForceSwitch' => [ + 'summary' => 'Performs a forced switchover.', + 'path' => '/openapi/ha3/instances/{instanceId}/force-switch/{fsmId}', + 'methods' => [ + 'put', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'instanceId', + 'in' => 'path', + 'schema' => [ + 'description' => 'The instance ID.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'ha-cn-tl32m2c4u01', + ], + ], + [ + 'name' => 'fsmId', + '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', + ], + ], + ], + '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', + ], + 'result' => [ + 'title' => '索引信息', + 'description' => 'The index information.'."\n", + 'type' => 'object', + '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" + ."\n" + .'### [](#uri)URI'."\n" + ."\n" + .'```java'."\n" + .'/openapi/ha3/instances/{instanceId}/force-switch/{fsmId}'."\n" + .'```'."\n", + 'requestParamsDescription' => '### [](#)Sample requests'."\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" + ."\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](~~464322~~).', + ], + 'ListLogs' => [ + 'path' => '/openapi/ha3/instances/{instanceId}/logs', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'abilityTreeCode' => '223197', + 'abilityTreeNodes' => [ + 'FEATUREopensearch0AT3OG', + ], + ], + 'parameters' => [ + [ + 'name' => 'instanceId', + 'in' => 'path', + 'schema' => [ + 'description' => 'The instance ID.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'ha-cn-i7m2roiy504', + ], + ], + [ + 'name' => 'type', + 'in' => 'query', + 'schema' => [ + 'title' => 'select: 查询日志, push: 写入日志', + 'description' => '-push -select', + 'type' => 'string', + 'required' => false, + 'example' => 'push', + 'default' => 'select', + ], + ], + [ + 'name' => 'pageNum', + 'in' => 'query', + 'schema' => [ + 'description' => 'The number of entries per num. Default value: 1.', + 'type' => 'string', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'pageSize', + 'in' => 'query', + 'schema' => [ + 'description' => 'The number of entries per page. Default value: 10.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '10', + ], + ], + [ + 'name' => 'startTime', + 'in' => 'query', + 'schema' => [ + 'description' => 'The start time. The value is a timestamp in seconds.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '1706340600', + ], + ], + [ + 'name' => 'endTime', + 'in' => 'query', + 'schema' => [ + 'description' => 'The end tim. The value is a timestamp in seconds.', + 'type' => 'string', + 'required' => false, + 'example' => '1710432000', + ], + ], + [ + 'name' => 'query', + 'in' => 'query', + 'schema' => [ + 'description' => 'The query statement'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'status: 200 AND totalTime > 0.01', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'title' => 'id of request', + 'description' => 'id of request', + 'type' => 'string', + 'example' => '022F36C7-9FB4-5D67-BEBC-3D14B0984463', + ], + '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"}]', + ], + ], + 'totalCount' => [ + 'description' => 'The total number of entries returned'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '5', + ], + ], + ], + ], + ], + ], + 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', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'abilityTreeCode' => '114152', + 'abilityTreeNodes' => [ + 'FEATUREopensearchIQC42D', + ], + ], + 'parameters' => [ + [ + 'name' => 'instanceId', + 'in' => 'path', + 'schema' => [ + 'description' => 'The instance ID.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'ha-cn-2r42p5oi202', + 'title' => '', + ], + ], + [ + 'name' => 'type', + 'in' => 'query', + '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' => '" "', + ], + ], + [ + 'name' => 'name', + 'in' => 'query', + 'schema' => [ + 'description' => 'The name of the configuration before the modification.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'ha-cn-zvp2iv9a401_qrs', + ], + ], + [ + 'name' => 'clusterName', + 'in' => 'query', + 'schema' => [ + 'description' => 'The name of the cluster.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'vpc_sh_domain_2', + ], + ], + [ + '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.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'ha-cn-2r42ostoc01_0704', + ], + ], + [ + 'name' => 'body', + 'in' => 'body', + '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', + ], + ], + 'required' => false, + 'example' => '{\\"desc\\":\\"new version\\"}', + ], + ], + ], + 'responses' => [ + 200 => [ + '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' => 'Schema of Response'."\n", + 'title' => 'Schema of Response', + ], + ], + 500 => [], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"D39EE0F1-D7EF-5F46-B781-6BF4185308B0\\",\\n \\"result\\": {}\\n}","type":"json"}]', + 'title' => 'ModifyNodeConfig', + 'description' => '### Method'."\n" + ."\n" + .'```java'."\n" + .'PUT'."\n" + .'```'."\n" + ."\n" + .'### URI'."\n" + ."\n" + .'```java'."\n" + .'/openapi/ha3/instances/{instanceId}/node-config?type=qrs&name=test'."\n" + .'```'."\n", + 'requestParamsDescription' => '### Sample requests'."\n" + ."\n" + .'```java'."\n" + .'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" + .'```'."\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).', + ], + 'GetDeployGraph' => [ + 'summary' => 'Displays the overview of the deployment.', + 'path' => '/openapi/ha3/instances/{instanceId}/deploy-graph', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'instanceId', + 'in' => 'path', + 'schema' => [ + 'description' => 'The instance ID.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'ha-cn-7pp2pcna701', + 'title' => '', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'title' => 'id of request', + 'description' => 'Id of the request'."\n", + 'type' => 'string', + 'example' => 'E7B7D598-B080-5C8E-AA35-D43EC0D5F886', + ], + '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' => [ + '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', + ], + 'buildDeployId' => [ + 'description' => 'The ID of the offline deployment.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + 'type' => [ + 'description' => 'The type of the data source.'."\n", + 'type' => 'string', + 'example' => 'odps', + ], + ], + ], + ], + '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', + ], + '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", + ], + '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", + ], + ], + ], + ], + ], + 'example' => '{}', + ], + ], + 'description' => 'The response parameters.'."\n", + 'title' => 'Schema of Response', + ], + ], + 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" + ."\n" + .'GET'."\n" + ."\n" + .'## URI'."\n" + ."\n" + .'```java'."\n" + .'/openapi/ha3/instances/{instanceId}/deploy-graph'."\n" + .'```'."\n", + 'requestParamsDescription' => '### Sample requests'."\n" + ."\n" + .'```java'."\n" + ."\n" + .'GET /openapi/ha3/instances/{instanceId}/deploy-graph'."\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" + .' "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" + .''."\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" + .' "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" + .'```', + ], + 'GetNodeConfig' => [ + 'summary' => 'Gets the configuration information of a node.', + 'path' => '/openapi/ha3/instances/{instanceId}/node-config', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'abilityTreeCode' => '104681', + 'abilityTreeNodes' => [ + 'FEATUREopensearchIQC42D', + ], + ], + 'parameters' => [ + [ + 'name' => 'instanceId', + 'in' => 'path', + 'schema' => [ + 'description' => 'The instance ID.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'ha-cn-0ju2rewdi02', + ], + ], + [ + 'name' => 'type', + 'in' => 'query', + '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', + ], + ], + [ + 'name' => 'name', + 'in' => 'query', + 'schema' => [ + 'description' => 'The node name.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'ha-cn-30174dhoz53_qrs', + ], + ], + [ + 'name' => 'clusterName', + 'in' => 'query', + 'schema' => [ + 'description' => 'The name of the cluster'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'vpc_sh_domain_2', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => 'The response parameters.'."\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', + ], + ], + ], + ], + ], + ], + 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', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'abilityTreeCode' => '218752', + 'abilityTreeNodes' => [ + 'FEATUREopensearchSLLBIN', + ], + ], + 'parameters' => [ + [ + 'name' => 'indexName', + 'in' => 'path', + 'schema' => [ + 'description' => 'The index name.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'index_jiayi_text', + ], + ], + [ + 'name' => 'instanceId', + 'in' => 'path', + 'schema' => [ + 'description' => 'The instance ID.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'ha-cn-i7m2rpzm605', + ], + ], + ], + 'responses' => [ + 200 => [ + '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', + ], + ], + 'description' => '', + ], + ], + 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', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'abilityTreeCode' => '178009', + 'abilityTreeNodes' => [ + 'FEATUREopensearch5EAGY5', + ], + ], + 'parameters' => [ + [ + 'name' => 'instanceId', + 'in' => 'path', + 'schema' => [ + 'description' => 'The instance ID.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'ha-cn-i7m2roiy504', + ], + ], + ], + 'responses' => [ + 200 => [ + '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', + 'additionalProperties' => [ + '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', + ], + ], + 'description' => 'The results returned.'."\n", + ], + ], + ], + 'description' => '', + ], + ], + 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', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'abilityTreeCode' => '178006', + 'abilityTreeNodes' => [ + 'FEATUREopensearch0Z9KDD', + ], + ], + 'parameters' => [ + [ + 'name' => 'instanceId', + 'in' => 'path', + 'schema' => [ + 'description' => 'The instance ID.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'ha-cn-zvp2jlr2g03', + ], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', + 'schema' => [ + 'description' => 'The request body.'."\n", + 'type' => 'object', + 'required' => false, + 'additionalProperties' => [ + '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', + ], + ], + 'description' => 'The request body.'."\n", + ], + ], + ], + ], + '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' => '{}', + ], + ], + 'description' => '', + ], + ], + 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', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'abilityTreeCode' => '104657', + 'abilityTreeNodes' => [ + 'FEATUREopensearchA6GC80', + ], + ], + 'parameters' => [ + [ + 'name' => 'instanceId', + 'in' => 'path', + 'schema' => [ + 'description' => 'The instance ID.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'ha-cn-0ju2k3qer02', + ], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', + 'schema' => [ + 'description' => 'The request body.'."\n", + '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', + ], + ], + 'required' => false, + ], + 'autoLoad' => [ + 'title' => '添加完成后是否自动挂载', + 'description' => 'Specifies whether to enable automatic connection.'."\n", + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + ], + 'required' => false, + 'example' => '{}', + ], + ], + ], + 'responses' => [ + 200 => [ + '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' => '{}', + ], + ], + 'description' => 'The results returned.'."\n", + ], + ], + 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" + ."\n" + .'`POST/openapi/ha3/instances/ha3_instance_id/clusters`'."\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" + ."\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', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'instanceId', + 'in' => 'path', + 'schema' => [ + 'title' => '实例ID', + 'description' => 'The instance ID.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'ha-cn-7mz2iv7sq01', + ], + ], + [ + 'name' => 'clusterName', + 'in' => 'path', + 'schema' => [ + 'title' => '集群名称', + 'description' => 'The name of the cluster'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'bj_vpc_domain_2', + ], + ], + ], + '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' => '{}', + ], + ], + ], + ], + 500 => [], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"E45380E8-994A-5402-9806-F114B3295FCF\\",\\n \\"result\\": {}\\n}","type":"json"}]', + 'title' => 'RemoveCluster', + 'description' => '### Method'."\n" + ."\n" + .'```java'."\n" + .'DELETE'."\n" + .'```'."\n" + ."\n" + .'### URI'."\n" + ."\n" + .'```java'."\n" + .'/openapi/ha3/instances/{instanceId}/clusters/{clusterName}'."\n" + .'```'."\n", + '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", + ], + 'ModifyClusterDesc' => [ + 'summary' => 'Modifies the description of a specified cluster.', + 'path' => '/openapi/ha3/instances/{instanceId}/clusters/{clusterName}/desc', + '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-c4d2rq7nt04', + ], + ], + [ + 'name' => 'clusterName', + 'in' => 'path', + 'schema' => [ + 'description' => 'The name of the cluster'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'sz_vpc_domain_1', + ], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', + 'schema' => [ + 'description' => 'The request body.'."\n", + 'type' => 'object', + 'required' => false, + 'example' => '{}', + ], + ], + ], + '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' => 'D39EE0F1-D7EF-5F46-B781-6BF4185308B0', + ], + 'result' => [ + 'title' => 'Map', + 'description' => 'The result.'."\n", + 'type' => 'object', + 'example' => '{}', + ], + ], + ], + ], + 500 => [], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"D39EE0F1-D7EF-5F46-B781-6BF4185308B0\\",\\n \\"result\\": {}\\n}","type":"json"}]', + 'title' => 'ModifyClusterDesc', + 'description' => '### [](#)Method'."\n" + ."\n" + .'`PUT`'."\n" + ."\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" + ."\n" + .'### Sample requests'."\n" + ."\n" + .'`PUT /openapi/ha3/instances/ha3_instance_name/clusters/my_cluster_name/desc`'."\n" + ."\n" + .'```'."\n" + .'{'."\n" + .' "description":"this is descrition"'."\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", + ], + 'ModifyClusterOfflineConfig' => [ + 'summary' => 'Modifies the configuration information of a cluster.', + 'path' => '/openapi/ha3/instances/{instanceId}/cluster-offline-config', + 'methods' => [ + 'put', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'abilityTreeCode' => '104631', + 'abilityTreeNodes' => [ + 'FEATUREopensearchA6GC80', + ], + ], + 'parameters' => [ + [ + 'name' => 'instanceId', + 'in' => 'path', + 'schema' => [ + 'description' => 'The instance ID.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'ha-cn-7mz2oy0bg01', + 'title' => '', + ], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', + 'schema' => [ + 'description' => 'The request body.'."\n", + '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', + ], + 'config' => [ + 'title' => 'key:配置名称', + 'description' => 'The configuration name, which is stored as a key.'."\n", + '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', + ], + ], + 'required' => false, + 'example' => '{}', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => 'Schema of Response'."\n", + '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' => '{}', + ], + ], + 'title' => 'Schema of Response', + ], + ], + 500 => [], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"E7B7D598-B080-5C8E-AA35-D43EC0D5F886\\",\\n \\"result\\": {}\\n}","type":"json"}]', + '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" + .'### Sample requests'."\n" + ."\n" + .'`PUT /openapi/ha3/instances/ha3_instance_name/cluster-offline-config`'."\n" + ."\n" + .'```'."\n" + .'{'."\n" + .' "dataSource": "test1",'."\n" + .' "domain": "xx",'."\n" + .' "indexes": ['."\n" + .' {'."\n" + .' "name": "index1",'."\n" + .' "versionId": 1'."\n" + .' },'."\n" + .' {'."\n" + .' "name": "index2",'."\n" + .' "versionId": 1'."\n" + .' }'."\n" + .' ],'."\n" + .' "advancedConfigVersionId": 2,'."\n" + .' "triggerBuild": true,'."\n" + .' "partition": "20201010", // This parameter is required when reindexing is triggered for the odps data source.'."\n" + .' "dataSourceType": "odps", // This parameter is required. Set this parameter to odps or swift. An error message is returned if you do not set this parameter.'."\n" + .' "dataTimeSec": 1640867288 // This parameter specifies 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" + .' '."\n" + .'}'."\n" + .'```', + ], + 'ModifyClusterOnlineConfig' => [ + 'summary' => 'Modifies the online configuration of a cluster.', + 'path' => '/openapi/ha3/instances/{instanceId}/cluster-online-config', + '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' => 'body', + 'in' => 'body', + 'style' => 'json', + 'schema' => [ + 'description' => 'The request body.'."\n", + 'type' => 'object', + 'properties' => [ + 'config' => [ + 'title' => 'key:配置名称', + 'description' => 'The configuration information.'."\n", + 'type' => 'object', + 'required' => false, + 'additionalProperties' => [ + 'type' => 'integer', + 'format' => 'int32', + 'description' => 'The version number of the configuration.'."\n", + 'example' => '2', + ], + ], + 'clusters' => [ + '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" + .' ]', + ], + 'required' => false, + ], + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + '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' => '{}', + ], + ], + ], + ], + 500 => [], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"E7B7D598-B080-5C8E-AA35-D43EC0D5F886\\",\\n \\"result\\": {}\\n}","type":"json"}]', + 'title' => 'ModifyClusterOnlineConfig', + 'description' => '### Method'."\n" + ."\n" + .'`PUT`'."\n" + ."\n" + .'### URI'."\n" + ."\n" + .'`/openapi/ha3/instances/{instanceId}/cluster-online-config`'."\n", + 'requestParamsDescription' => '### Sample requests'."\n" + ."\n" + .'`PUT /openapi/ha3/instances/ha3_instance_name/cluster-online-config`'."\n" + ."\n" + .' {'."\n" + .' "advancedConfigVersionId": 2,'."\n" + .' "clusters": ['."\n" + .' "hz_pre_vpc_domain_1"'."\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", + ], + 'GetCluster' => [ + 'summary' => 'Queries the details of a cluster.', + 'path' => '/openapi/ha3/instances/{instanceId}/clusters/{clusterName}', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'abilityTreeCode' => '104163', + 'abilityTreeNodes' => [ + 'FEATUREopensearch5EAGY5', + ], + ], + 'parameters' => [ + [ + 'name' => 'instanceId', + 'in' => 'path', + 'schema' => [ + 'title' => '实例ID', + 'description' => 'The instance ID.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'ha-cn-0ju2rq6610a', + ], + ], + [ + 'name' => 'clusterName', + 'in' => 'path', + 'schema' => [ + 'title' => '集群名称', + 'description' => 'The name of the cluster'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'bj_vpc_domain_2', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'The response parameters.'."\n", + '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' => '集群列表', + 'description' => 'The clusters.'."\n", + '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", + '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', + ], + ], + ], + 'dataNode' => [ + 'description' => 'The specifications of Searcher workers.'."\n", + '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', + ], + ], + ], + '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' => [ + 'type' => 'object', + 'additionalProperties' => [ + '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", + ], + 'description' => 'The information about child configuration items.'."\n", + ], + ], + ], + ], + ], + ], + ], + 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', + 'description' => '### Method'."\n" + ."\n" + .'`GET`'."\n" + ."\n" + .'### URI'."\n" + ."\n" + .'`/openapi/ha3/instance/{instanceId}/clusters/{clusterName}`'."\n", + 'requestParamsDescription' => '### Sample requests'."\n" + ."\n" + .'`GET /openapi/ha3/instance/ha_name_example/clusters/my_cluster`'."\n", + 'responseParamsDescription' => '### Sample responses'."\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', + ], + '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-2r42ncw4102', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'The results returned.'."\n", + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'title' => 'Id of the request', + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => 'E45380E8-994A-5402-9806-F114B3295FCF', + ], + 'result' => [ + 'title' => '结果集', + 'description' => 'The result.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The runtime information of the cluster.'."\n", + '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', + ], + ], + ], + ], + ], + ], + 'dataNodes' => [ + 'title' => '数据结点信息', + 'description' => 'The information about the Searcher workers.'."\n", + '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", + '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' => '""', + ], + ], + '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', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 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', + 'description' => '### Method'."\n" + ."\n" + .'GET'."\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', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + ], + 'parameters' => [], + 'responses' => [ + 200 => [ + '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', + ], + ], + ], + ], + ], + ], + 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', + 'description' => '### Method'."\n" + ."\n" + .'GET'."\n" + ."\n" + .'### URI'."\n" + ."\n" + .'/openapi/ha3/instances/{instanceId}/cluster-names'."\n", + 'requestParamsDescription' => '### Sample requests'."\n" + ."\n" + .'```java'."\n" + .'GET /openapi/ha3/instances/ha3_instance_name/cluster-names'."\n" + .'```'."\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" + .'```'."\n", + ], + 'ListClusters' => [ + 'path' => '/openapi/ha3/instances/{instanceId}/clusters', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'abilityTreeCode' => '103715', + 'abilityTreeNodes' => [ + 'FEATUREopensearch5EAGY5', + ], + ], + 'parameters' => [ + [ + 'name' => 'instanceId', + 'in' => 'path', + 'schema' => [ + 'description' => 'The instance ID.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'ha-cn-zvp2jlr2g03', + 'title' => '', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => 'The response parameters.'."\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', + ], + ], + ], + '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' => [ + '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', + ], + 'desc' => [ + 'type' => 'string', + 'description' => 'The description of the configuration.'."\n", + 'example' => '', + ], + ], + 'description' => 'The information about child configuration items.'."\n", + ], + 'description' => 'The configuration information.'."\n", + ], + ], + ], + ], + ], + ], + 'title' => 'Schema of Response', + ], + ], + 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.', + 'description' => '### Method'."\n" + ."\n" + .'```java'."\n" + .'GET'."\n" + .'```'."\n" + ."\n" + .'### URI'."\n" + ."\n" + .'```java'."\n" + .'/openapi/ha3/instances/{instanceId}/clusters'."\n" + .'```'."\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', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'abilityTreeCode' => '223194', + 'abilityTreeNodes' => [ + 'FEATUREopensearchGTRUN8', + ], + ], + 'parameters' => [ + [ + 'name' => 'instanceId', + 'in' => 'path', + 'schema' => [ + 'description' => 'The instance ID.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'ha-cn-0ju2re****', + ], + ], + [ + 'name' => 'alias', + 'in' => 'path', + 'schema' => [ + 'description' => 'alias name', + 'type' => 'string', + 'required' => true, + 'example' => 'test', + ], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', + '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, + ], + ], + ], + 'responses' => [ + 200 => [ + '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' => '{}', + ], + ], + ], + ], + 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', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + '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****', + ], + ], + ], + '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' => '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', + ], + ], + ], + ], + ], + ], + ], + 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', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + 'abilityTreeCode' => '223196', + 'abilityTreeNodes' => [ + 'FEATUREopensearchGTRUN8', + ], + ], + 'parameters' => [ + [ + 'name' => 'instanceId', + 'in' => 'path', + 'schema' => [ + 'description' => 'The instance ID.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'ha-cn-pl32rf0****', + ], + ], + [ + 'name' => 'alias', + 'in' => 'path', + 'schema' => [ + 'description' => 'alias', + 'type' => 'string', + 'required' => true, + 'example' => 'test', + ], + ], + ], + 'responses' => [ + 200 => [ + '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' => '{}', + ], + ], + ], + ], + 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', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'abilityTreeCode' => '223193', + 'abilityTreeNodes' => [ + 'FEATUREopensearchGTRUN8', + ], + ], + 'parameters' => [ + [ + 'name' => 'instanceId', + 'in' => 'path', + 'schema' => [ + 'description' => 'The instance ID.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'ha-cn-pl32rf0****', + ], + ], + [ + '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', + 'default' => 'true', + ], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', + '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, + ], + ], + ], + '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' => 'Map', + 'description' => 'Map', + 'type' => 'object', + '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', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '218772', + 'abilityTreeNodes' => [ + 'FEATUREopensearchGTRUN8', + ], + ], + 'parameters' => [ + [ + 'name' => 'instanceId', + 'in' => 'path', + 'schema' => [ + 'description' => 'The instance ID.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'ha-cn-tl32n3iu801', + ], + ], + [ + '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', + ], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', + 'schema' => [ + 'description' => 'The request body.'."\n", + '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', + ], + 'dataSource' => [ + 'title' => '数据源配置', + 'description' => 'The configurations of the data source.'."\n", + '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', + ], + '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' => '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', + ], + ], + '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', + '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", + ], + ], + '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', + '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', + ], + '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", + '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 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", + '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", + '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', + ], + ], + 'required' => false, + ], + ], + 'required' => false, + ], + ], + 'required' => false, + ], + 'required' => false, + ], + 'scene' => [ + 'title' => '场景模版', + 'type' => 'string', + ], + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + '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' => '{}', + ], + ], + ], + ], + 500 => [], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"2AE63638-5420-56DC-BF59-37D8174039A0\\",\\n \\"result\\": {}\\n}","type":"json"}]', + 'title' => 'CreateTable', + 'requestParamsDescription' => '### [](#)Sample requests'."\n" + ."\n" + .'```java'."\n" + .'POST /openapi/ha3/instances/{instanceId}/tables'."\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" + ."\n" + .'```java'."\n" + .'{'."\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 structure](~~465311~~).'."\n", + ], + 'ModifyTable' => [ + 'summary' => 'Modifies an index table.', + 'path' => '/openapi/ha3/instances/{instanceId}/tables/{tableName}', + 'methods' => [ + 'put', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '218773', + 'abilityTreeNodes' => [ + 'FEATUREopensearchGTRUN8', + ], + ], + 'parameters' => [ + [ + 'name' => 'instanceId', + 'in' => 'path', + 'schema' => [ + 'description' => 'The instance ID.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'ha-cn-tl32n3iu801', + ], + ], + [ + 'name' => 'tableName', + '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', + ], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', + 'schema' => [ + 'description' => 'The request body.'."\n", + '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", + '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 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", + '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", + '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, + ], + ], + 'required' => false, + ], + ], + 'required' => false, + ], + 'required' => false, + ], + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + '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' => '{}', + ], + ], + ], + ], + 500 => [], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"FE03180A-0E29-5474-8A86-33F0683294A4\\",\\n \\"result\\": {}\\n}","type":"json"}]', + 'title' => 'ModifyTable', + 'requestParamsDescription' => '### [](#)Sample requests'."\n" + ."\n" + .'```java'."\n" + .'PUT /openapi/ha3/instances/{instanceId}/tables/{tableName}'."\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" + ."\n" + .'```java'."\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" + .'}'."\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', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'abilityTreeCode' => '218774', + 'abilityTreeNodes' => [ + 'FEATUREopensearchGTRUN8', + ], + ], + 'parameters' => [ + [ + 'name' => 'instanceId', + 'in' => 'path', + 'schema' => [ + 'description' => 'The instance ID.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'ha-cn-0ju2k3qer02', + ], + ], + [ + 'name' => 'tableName', + 'in' => 'path', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'test_summary', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + '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', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'description' => '', + ], + ], + 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" + ."\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', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'abilityTreeCode' => '218776', + 'abilityTreeNodes' => [ + 'FEATUREopensearchGTRUN8', + ], + ], + 'parameters' => [ + [ + 'name' => 'instanceId', + 'in' => 'path', + 'schema' => [ + 'description' => 'The instance ID.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'ha-cn-0ju2rewdi02', + ], + ], + [ + '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', + 'default' => 'true', + ], + ], + ], + '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', + ], + ], + ], + ], + ], + 'description' => '', + ], + ], + 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" + ."\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', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + 'abilityTreeCode' => '218775', + 'abilityTreeNodes' => [ + 'FEATUREopensearchGTRUN8', + ], + ], + 'parameters' => [ + [ + 'name' => 'instanceId', + 'in' => 'path', + 'schema' => [ + 'description' => 'The instance ID.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'ha-cn-7e22rgfyb01', + ], + ], + [ + 'name' => 'tableName', + 'in' => 'path', + 'schema' => [ + 'description' => 'The name of the table.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'test_summary', + ], + ], + ], + 'responses' => [ + 200 => [ + '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' => '{}', + ], + ], + 'description' => '', + ], + ], + 500 => [], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"E7B7D598-B080-5C8E-AA35-D43EC0D5F886\\",\\n \\"result\\": {}\\n}","type":"json"}]', + 'title' => 'DeleteTable', + 'requestParamsDescription' => '### [](#)Sample requests'."\n" + ."\n" + .'```java'."\n" + .'DELETE /openapi/ha3/instances/{instanceId}/tables/{tableName}'."\n" + .'```'."\n", + ], + 'Reindex' => [ + 'summary' => 'Rebuilds an index.', + 'path' => '/openapi/ha3/instances/{instanceId}/tables/{tableName}/reindex', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'abilityTreeCode' => '218777', + 'abilityTreeNodes' => [ + 'FEATUREopensearchD5N27K', + ], + ], + 'parameters' => [ + [ + 'name' => 'instanceId', + 'in' => 'path', + 'schema' => [ + 'description' => 'The instance ID.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'ha-cn-2r42ppr7901', + ], + ], + [ + 'name' => 'tableName', + 'in' => 'path', + 'schema' => [ + 'description' => 'The name of the table.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'test_summary', + ], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', + 'schema' => [ + 'description' => 'The request body.'."\n", + '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', + ], + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + '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' => '{}', + ], + ], + ], + ], + 500 => [], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"10D5E615-69F7-5F49-B850-00169ADE513C\\",\\n \\"result\\": {}\\n}","type":"json"}]', + 'title' => 'Reindex', + 'requestParamsDescription' => '### [](#)Sample requests'."\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', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'abilityTreeCode' => '218778', + 'abilityTreeNodes' => [ + 'FEATUREopensearchGTRUN8', + ], + ], + 'parameters' => [ + [ + 'name' => 'instanceId', + 'in' => 'path', + 'schema' => [ + 'description' => 'The instance ID.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'ha-cn-tl32n3iu801', + ], + ], + [ + 'name' => 'tableName', + 'in' => 'path', + 'schema' => [ + 'description' => 'The name of the table.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'test_summary', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + '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', + ], + ], + ], + ], + ], + 'description' => '', + ], + ], + 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" + ."\n" + .'```java'."\n" + .'GET /v2/instances/{instanceId}/tables/{tableName}/index_versions'."\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', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'abilityTreeCode' => '218780', + 'abilityTreeNodes' => [ + 'FEATUREopensearchGTRUN8', + ], + ], + 'parameters' => [ + [ + 'name' => 'instanceId', + 'in' => 'path', + 'schema' => [ + 'description' => 'The instance ID.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'ha-cn-pl32rf0js04', + ], + ], + [ + 'name' => 'tableName', + 'in' => 'path', + 'schema' => [ + 'description' => 'The name of the table.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'test_summary', + ], + ], + [ + 'name' => 'generationId', + 'in' => 'path', + 'schema' => [ + 'description' => 'The ID of the full index version.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '1708674867', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'title' => 'id of request', + 'description' => 'requestId', + 'type' => 'string', + 'example' => 'E7B7D598-B080-5C8E-AA35-D43EC0D5F886', + ], + 'result' => [ + 'title' => 'IndexGeneration', + 'description' => 'The result returned.'."\n", + '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', + ], + ], + ], + ], + ], + ], + 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" + ."\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', + ], + '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.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'ha-cn-2r42ppr7901', + ], + ], + [ + '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' => '{}', + ], + ], + ], + 'responses' => [ + 200 => [ + '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' => '{}', + ], + ], + 'description' => '', + ], + ], + 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', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '171180', + 'abilityTreeNodes' => [ + 'FEATUREopensearchO9FNU6', + ], + ], + 'parameters' => [ + [ + 'name' => 'instanceId', + 'in' => 'path', + 'schema' => [ + 'description' => 'The instance ID.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'ha-cn-tl32n3iu801', + ], + ], + [ + '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, + ], + ], + ], + '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' => 'Object', + 'description' => 'The result.'."\n", + 'type' => 'any', + 'example' => '{}', + ], + ], + 'description' => '', + ], + ], + 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', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '194016', + 'abilityTreeNodes' => [ + 'FEATUREopensearchYR63E7', + ], + ], + 'parameters' => [ + [ + 'name' => 'instanceId', + 'in' => 'path', + 'schema' => [ + 'description' => 'The instance ID.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'ha-cn-0ju2rps6c08', + ], + ], + [ + 'name' => 'path', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + ], + ], + [ + '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', + ], + ], + [ + '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', + ], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', + 'schema' => [ + 'description' => 'The request body.'."\n", + 'type' => 'object', + 'required' => false, + 'example' => '{}', + ], + ], + ], + 'responses' => [ + 200 => [ + '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' => '{}', + ], + ], + 'description' => '', + ], + ], + 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', + ], + '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-7mz2iv7sq01', + ], + ], + [ + 'name' => 'dataSourceName', + 'in' => 'path', + 'schema' => [ + 'description' => 'The name of the data source.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'ha-cn-2r42ostoc01_ecom_table_test', + ], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', + 'schema' => [ + 'description' => 'The request body.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The request body.'."\n", + 'type' => 'any', + 'required' => false, + 'example' => '{}', + ], + 'required' => false, + ], + ], + [ + 'name' => 'pkField', + 'in' => 'query', + 'schema' => [ + 'description' => 'The primary key field.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'id', + ], + ], + ], + 'responses' => [ + 200 => [ + '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' => '{}', + ], + ], + 'description' => '', + ], + ], + 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', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'none', + 'abilityTreeCode' => '180430', + 'abilityTreeNodes' => [ + 'FEATUREopensearch0AT3OG', + 'FEATUREopensearchJB31XH', + ], + ], + 'parameters' => [ + [ + 'name' => 'acceptLanguage', + 'in' => 'query', + 'schema' => [ + 'description' => 'The language of the response. Default value: zh-cn.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'zh-cn', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'description' => 'id of request'."\n", + 'type' => 'string', + 'example' => 'E7B7D598-B080-5C8E-AA35-D43EC0D5F886', + ], + 'result' => [ + 'description' => 'The result.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The result.'."\n", + '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', + ], + ], + ], + ], + ], + ], + ], + ], + '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', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response'."\n", + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'title' => 'Id of the request', + 'description' => 'The ID of the request'."\n", + 'type' => 'string', + 'example' => '9E5BCFAA-98B3-51D0-9188-B1BC07589337', + ], + ], + ], + ], + 500 => [], + ], + '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", + ], + 'DeleteModel' => [ + 'summary' => '删除模型', + 'path' => '/openapi/ha3/instances/{instanceId}/models/{modelName}', + 'methods' => [ + 'delete', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREopensearchGTRUN8', + ], + ], + 'parameters' => [ + [ + 'name' => 'instanceId', + 'in' => 'path', + 'schema' => [ + 'title' => '实例ID', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'ha-cn-pl32rf0****', + ], + ], + [ + 'name' => 'modelName', + 'in' => 'path', + 'schema' => [ + 'title' => '模型的名称', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'test', + ], + ], + ], + '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', + ], + ], + ], + ], + ], + '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', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREopensearchGTRUN8', + ], + ], + 'parameters' => [ + [ + 'name' => 'instanceId', + 'in' => 'path', + 'schema' => [ + 'title' => '实例ID', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'ha-cn-pl32rf0****', + ], + ], + [ + 'name' => 'modelName', + 'in' => 'path', + 'schema' => [ + 'title' => '模型名称', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'test', + ], + ], + [ + 'name' => 'dryRun', + 'in' => 'query', + 'schema' => [ + 'title' => '是否仅执行校验，默认为False。', + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'true', + ], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', + 'schema' => [ + 'description' => '', + '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', + ], + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'title' => 'Id of the request', + 'description' => 'Id of the request', + 'type' => 'string', + 'example' => 'D39EE0F1-D7EF-5F46-B781-6BF4185308B0', + ], + ], + ], + ], + ], + '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', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREopensearchGTRUN8', + ], + ], + 'parameters' => [ + [ + 'name' => 'instanceId', + 'in' => 'path', + 'schema' => [ + 'title' => '实例ID', + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'ha-cn-pl32rf0****', + ], + ], + [ + 'name' => 'modelName', + 'in' => 'path', + 'schema' => [ + 'title' => '模型的名称', + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'test', + ], + ], + [ + 'name' => 'isOnline', + 'in' => 'query', + 'schema' => [ + 'title' => '是否在线查询，为true时使用search配置，false时使用build配置', + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'true', + ], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', + 'schema' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'input' => [ + 'title' => '模型输入', + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '', + ], + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'title' => 'Id of the request', + 'description' => 'Id of the request', + 'type' => 'string', + 'example' => 'E7B7D598-B080-5C8E-AA35-D43EC0D5F886', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + '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', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREopensearchGTRUN8', + ], + ], + 'parameters' => [ + [ + 'name' => 'instanceId', + 'in' => 'path', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'ha-cn-pl32rf0****', + ], + ], + [ + 'name' => 'modelName', + 'in' => 'path', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'test', + ], + ], + ], + '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', + ], + ], + ], + ], + ], + ], + ], + '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"}]', + ], + 'ListModels' => [ + 'summary' => '通过实例ID查询指定条件下的模型列表。', + 'description' => '## 请求说明'."\n" + .'本API用于从指定实例中获取模型列表，支持通过模型名称、类型以及分页参数进行筛选。请求时需提供实例ID作为路径参数，其他筛选条件为可选的查询参数。'."\n", + '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' => '实例ID'."\n", + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'ha-cn-test', + ], + ], + [ + 'name' => 'name', + 'in' => 'query', + 'schema' => [ + 'title' => '模型名称'."\n", + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'test1', + ], + ], + [ + 'name' => 'type', + 'in' => 'query', + 'schema' => [ + 'title' => '模型类别'."\n", + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'text_embedding', + ], + ], + [ + 'name' => 'pageNumber', + 'in' => 'query', + 'schema' => [ + 'title' => '页数，默认为1'."\n", + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'pageSize', + 'in' => 'query', + 'schema' => [ + 'title' => '每页显示条数，默认为10'."\n", + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '10', + ], + ], + ], + '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', + ], + ], + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + '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', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREopensearchGTRUN8', + ], + ], + 'parameters' => [ + [ + 'name' => 'instanceId', + 'in' => 'path', + 'schema' => [ + 'title' => '实例ID', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'ha-cn-pl32rf0****', + ], + ], + [ + 'name' => 'dryRun', + 'in' => 'query', + 'schema' => [ + 'title' => '是否仅执行校验，默认为False。', + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'true', + ], + ], + [ + '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, + ], + ], + ], + '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', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + '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', + ], + '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' => '实例ID'."\n", + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'ha-cn-test', + ], + ], + [ + '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, + ], + ], + ], + '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', + ], + ], + ], + ], + ], + '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"}]', + ], + ], + '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', + ], + ], +]; |