{"openapi":"3.1.0","info":{"title":"Apizie","version":"2.0.0","description":"One API key, one envelope, many public data sources."},"servers":[{"url":"https://zieapi.vercel.app"}],"security":[{"ApiKeyAuth":[]}],"paths":{"/v1/cloud:aliyun-searchengine/build-index":{"post":{"operationId":"cloud_aliyun_searchengine_build_index","summary":"Rebuilds an index","description":"POST /openapi/ha3/instances/{instanceId}/actions/build-index","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["instanceId"],"properties":{"instanceId":{"type":"string","description":"The ID of the instance"},"buildMode":{"type":"string","description":"The method to rebuild the index. Valid values: api and indexRecover"},"dataSourceName":{"type":"string","description":"The name of the data source"},"dataSourceType":{"type":"string","description":"The type of the data source"},"dataTimeSec":{"type":"integer","description":"The UNIX timestamp in seconds. This parameter is an integer. This parameter is required if data is pushed to the data source using an API"},"domain":{"type":"string","description":"The data center of the data source"},"generation":{"type":"integer","description":"The backfill ID"},"partition":{"type":"string","description":"Required if dataSourceType is set to odps"},"path":{"type":"string","description":"The relative path"},"tag":{"type":"string","description":"The tag of the Data Lake Formation (DLF) data source"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-searchengine/change-resource-group":{"post":{"operationId":"cloud_aliyun_searchengine_change_resource_group","summary":"Changes the resource group of an instance","description":"POST /openapi/ha3/instances/{instanceId}/actions/change-resource-group","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["instanceId"],"properties":{"instanceId":{"type":"string","description":"The instance ID"},"newResourceGroupId":{"type":"string","description":"The ID of the new resource group"},"resourceType":{"type":"string","description":"The resource type"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-searchengine/clone-sql-instance":{"post":{"operationId":"cloud_aliyun_searchengine_clone_sql_instance","summary":"Clones an SQL instance","description":"POST /openapi/ha3/instances/{instanceId}/sql-studio/databases/{database}/sql-instances/{sqlInstanceId}/actions/clone","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["instanceId","database","sqlInstanceId","name","targetFolderId"],"properties":{"instanceId":{"type":"string","description":"The instance ID"},"database":{"type":"string","description":"The database name"},"sqlInstanceId":{"type":"string","description":"The SQL instance ID"},"name":{"type":"string","description":"The name"},"targetFolderId":{"type":"integer","description":"The ID of the target folder"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-searchengine/create-alias":{"post":{"operationId":"cloud_aliyun_searchengine_create_alias","summary":"Creates an alias","description":"POST /openapi/ha3/instances/{instanceId}/aliases","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["instanceId"],"properties":{"instanceId":{"type":"string","description":"The instance ID"},"newMode":{"type":"string","description":"Specifies whether the new version of the console page is used"},"alias":{"type":"string","description":"The alias"},"index":{"type":"string","description":"The associated index"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-searchengine/create-cluster":{"post":{"operationId":"cloud_aliyun_searchengine_create_cluster","summary":"Add a cluster","description":"POST /openapi/ha3/instances/{instanceId}/clusters","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["instanceId"],"properties":{"instanceId":{"type":"string","description":"The instance ID"},"autoLoad":{"type":"string","description":"Specifies whether to automatically mount the cluster"},"dataNode":{"type":"object","description":"The details of the data node"},"description":{"type":"string","description":"The cluster description"},"name":{"type":"string","description":"The cluster name"},"queryNode":{"type":"object","description":"The details of the query node"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-searchengine/create-config-dir":{"post":{"operationId":"cloud_aliyun_searchengine_create_config_dir","summary":"Creates a file directory in an advanced configuration","description":"POST /openapi/ha3/instances/{instanceId}/advanced-configs/{configName}/dir","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["instanceId","configName"],"properties":{"instanceId":{"type":"string","description":"The instance ID"},"configName":{"type":"string","description":"The configuration name"},"dirName":{"type":"string","description":"The directory name"},"parentFullPath":{"type":"string","description":"The parent file path"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-searchengine/create-config-file":{"post":{"operationId":"cloud_aliyun_searchengine_create_config_file","summary":"Creates a file with advanced configurations","description":"POST /openapi/ha3/instances/{instanceId}/advanced-configs/{configName}/file","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["instanceId","configName"],"properties":{"instanceId":{"type":"string","description":"The instance ID"},"configName":{"type":"string","description":"The configuration name"},"fileName":{"type":"string","description":"The directory name"},"ossPath":{"type":"string","description":"The OSS storage address"},"parentFullPath":{"type":"string","description":"The parent file path"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-searchengine/create-data-source":{"post":{"operationId":"cloud_aliyun_searchengine_create_data_source","summary":"Creates a data source","description":"POST /openapi/ha3/instances/{instanceId}/data-sources","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["instanceId"],"properties":{"instanceId":{"type":"string","description":"The instance ID"},"dryRun":{"type":"string","description":"Specifies whether to perform a dry run to create the data source. A dry run only validates whether the data source is valid. Valid values:…"},"autoBuildIndex":{"type":"string","description":"Specifies whether to automatically rebuild the index"},"config":{"type":"object","description":"The configuration information"},"domain":{"type":"string","description":"The data center of the data source"},"name":{"type":"string","description":"The name of the data source"},"saroConfig":{"type":"object","description":"The saro datasource config"},"type":{"type":"string","description":"The type of the data source. Valid values: odps, oss, and swift"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-searchengine/create-folder":{"post":{"operationId":"cloud_aliyun_searchengine_create_folder","summary":"Creates a folder","description":"POST /openapi/ha3/instances/{instanceId}/sql-studio/databases/{database}/folders","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["instanceId","database","name","parent","type"],"properties":{"instanceId":{"type":"string","description":"The instance ID"},"database":{"type":"string","description":"The database name"},"name":{"type":"string","description":"The folder name"},"parent":{"type":"integer","description":"The parent category ID (required). If left empty, the default value is 1"},"type":{"type":"string","description":"table, instance, template, function"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-searchengine/create-index":{"post":{"operationId":"cloud_aliyun_searchengine_create_index","summary":"Creates an index","description":"POST /openapi/ha3/instances/{instanceId}/indexes","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["instanceId"],"properties":{"instanceId":{"type":"string","description":"The instance ID"},"buildParallelNum":{"type":"integer","description":"The concurrency for full index building"},"content":{"type":"string","description":"The index schema"},"dataSource":{"type":"string","description":"The name of the data source"},"dataSourceInfo":{"type":"object","description":"Information about the data source. This parameter is required for new versions of Vector Search Edition"},"domain":{"type":"string","description":"The data center of the data source"},"extend":{"type":"object","description":"The extended field configuration. key: The field type. Valid values: \\`vector\\` (vector field), \\`embeding\\` (field that requires…"},"mergeParallelNum":{"type":"integer","description":"The concurrency for full index merging"},"name":{"type":"string","description":"The name of the index"},"partition":{"type":"integer","description":"The number of data shards"},"dryRun":{"type":"string","description":"Specifies whether to perform a dry run. A dry run only checks whether the data source is valid. Valid values: true false"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-searchengine/create-instance":{"post":{"operationId":"cloud_aliyun_searchengine_create_instance","summary":"Creates a Wentian Engine instance","description":"POST /openapi/ha3/instances","tags":["cloud"],"parameters":[],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"chargeType":{"type":"string","description":"The billing method of the instance. Valid values: PREPAY: subscription. If you select this billing method, make sure that your account…"},"components":{"type":"array","description":"The list of specifications for the instance"},"order":{"type":"object","description":"The payment information"},"resourceGroupId":{"type":"string","description":"The ID of the resource group"},"tags":{"type":"array","description":"The list of instance tags"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-searchengine/create-model":{"post":{"operationId":"cloud_aliyun_searchengine_create_model","summary":"Creates a model","description":"POST /openapi/ha3/instances/{instanceId}/models","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["instanceId","name"],"properties":{"instanceId":{"type":"string","description":"The instance ID"},"dryRun":{"type":"string","description":"Specifies whether to perform only a dry run. The default value is false"},"content":{"type":"object","description":"The model details"},"name":{"type":"string","description":"The model name"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-searchengine/create-public-url":{"post":{"operationId":"cloud_aliyun_searchengine_create_public_url","summary":"Enables the public domain name","description":"POST /openapi/ha3/instances/{instanceId}/public-url","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["instanceId"],"properties":{"instanceId":{"type":"string","description":"The instance ID"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-searchengine/create-sql-instance":{"post":{"operationId":"cloud_aliyun_searchengine_create_sql_instance","summary":"Creates an SQL instance","description":"POST /openapi/ha3/instances/{instanceId}/sql-studio/databases/{database}/sql-instances","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["instanceId","database","name","parent"],"properties":{"instanceId":{"type":"string","description":"The instance ID"},"database":{"type":"string","description":"The database name"},"name":{"type":"string","description":"The SQL instance name"},"parent":{"type":"integer","description":"The unique identifier of the parent work item"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-searchengine/create-table":{"post":{"operationId":"cloud_aliyun_searchengine_create_table","summary":"Creates an index table","description":"POST /openapi/ha3/instances/{instanceId}/tables","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["instanceId"],"properties":{"instanceId":{"type":"string","description":"The instance ID"},"dryRun":{"type":"string","description":"Specifies whether to perform a dry run (only validates whether the data source is valid). Valid values: true: performs a dry run. false:…"},"dataProcessConfig":{"type":"array","description":"The field processing configuration"},"dataProcessorCount":{"type":"integer","description":"The number of data update resources"},"dataSource":{"type":"object","description":"The datasource config"},"fieldSchema":{"type":"object","description":"The field schema. The key is the field name"},"name":{"type":"string","description":"The index name"},"partitionCount":{"type":"integer","description":"The number of data shards"},"primaryKey":{"type":"string","description":"The primary key field"},"rawSchema":{"type":"string","description":"The raw schema. If you specify this parameter, the value is used directly as the HA3 schema structure without manual assembly"},"scene":{"type":"string","description":"The template type"},"vectorIndex":{"type":"array","description":"The index structure"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-searchengine/debug-model":{"post":{"operationId":"cloud_aliyun_searchengine_debug_model","summary":"Debugs a model","description":"POST /openapi/ha3/instances/{instanceId}/models/{modelName}/actions/debug","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["instanceId","modelName"],"properties":{"instanceId":{"type":"string","description":"The instance ID"},"modelName":{"type":"string","description":"The name of the model"},"isOnline":{"type":"string","description":"Specifies whether to perform an online query. Set this parameter to true to use the search configuration. Set this parameter to false to…"},"input":{"type":"string","description":"The input of the model"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-searchengine/delete-advance-config":{"post":{"operationId":"cloud_aliyun_searchengine_delete_advance_config","summary":"Deletes an advanced configuration","description":"DELETE /openapi/ha3/instances/{instanceId}/advanced-configs/{configName}","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["instanceId","configName"],"properties":{"instanceId":{"type":"string","description":"The instance ID"},"configName":{"type":"string","description":"The configuration name"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-searchengine/delete-alias":{"post":{"operationId":"cloud_aliyun_searchengine_delete_alias","summary":"Deletes an alias","description":"DELETE /openapi/ha3/instances/{instanceId}/aliases/{alias}","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["instanceId","alias"],"properties":{"instanceId":{"type":"string","description":"The instance ID"},"alias":{"type":"string","description":"The alias"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-searchengine/delete-config-dir":{"post":{"operationId":"cloud_aliyun_searchengine_delete_config_dir","summary":"Deletes an advanced configuration folder","description":"DELETE /openapi/ha3/instances/{instanceId}/advanced-configs/{configName}/dir","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["instanceId","configName","dirName","parentFullPath"],"properties":{"instanceId":{"type":"string","description":"The instance ID"},"configName":{"type":"string","description":"The configuration name"},"dirName":{"type":"string","description":"The folder name"},"parentFullPath":{"type":"string","description":"The path of the parent folder"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-searchengine/delete-config-file":{"post":{"operationId":"cloud_aliyun_searchengine_delete_config_file","summary":"Deletes an advanced configuration file","description":"DELETE /openapi/ha3/instances/{instanceId}/advanced-configs/{configName}/file","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["instanceId","configName","fileName","parentFullPath"],"properties":{"instanceId":{"type":"string","description":"The instance ID"},"configName":{"type":"string","description":"The configuration name"},"fileName":{"type":"string","description":"The file name"},"parentFullPath":{"type":"string","description":"The path of the parent directory"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-searchengine/delete-data-source":{"post":{"operationId":"cloud_aliyun_searchengine_delete_data_source","summary":"Deletes a specified data source","description":"DELETE /openapi/ha3/instances/{instanceId}/data-sources/{dataSourceName}","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["instanceId","dataSourceName"],"properties":{"instanceId":{"type":"string","description":"The instance ID"},"dataSourceName":{"type":"string","description":"The name of the data source"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-searchengine/delete-folder":{"post":{"operationId":"cloud_aliyun_searchengine_delete_folder","summary":"Deletes a folder","description":"DELETE /openapi/ha3/instances/{instanceId}/sql-studio/databases/{database}/folders/{folderId}","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["instanceId","database","folderId"],"properties":{"instanceId":{"type":"string","description":"The instance ID"},"database":{"type":"string","description":"The database name"},"folderId":{"type":"string","description":"The folder ID"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-searchengine/delete-index":{"post":{"operationId":"cloud_aliyun_searchengine_delete_index","summary":"Deletes an index","description":"DELETE /openapi/ha3/instances/{instanceId}/indexes/{indexName}","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["instanceId","indexName","dataSource"],"properties":{"instanceId":{"type":"string","description":"The instance ID"},"indexName":{"type":"string","description":"The index name"},"dataSource":{"type":"string","description":"The data source"},"deleteDataSource":{"type":"string","description":"Specifies whether to delete the data source"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-searchengine/delete-index-version":{"post":{"operationId":"cloud_aliyun_searchengine_delete_index_version","summary":"Deletes the version of an index","description":"DELETE /openapi/ha3/instances/{instanceId}/indexes/{indexName}/versions/{versionName}","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["instanceId","indexName","versionName"],"properties":{"instanceId":{"type":"string","description":"The instance ID"},"indexName":{"type":"string","description":"The index name"},"versionName":{"type":"string","description":"The name of the version"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-searchengine/delete-instance":{"post":{"operationId":"cloud_aliyun_searchengine_delete_instance","summary":"Deletes a specified instance","description":"DELETE /openapi/ha3/instances/{instanceId}","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["instanceId"],"properties":{"instanceId":{"type":"string","description":"The instance ID"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-searchengine/delete-model":{"post":{"operationId":"cloud_aliyun_searchengine_delete_model","summary":"Deletes a model","description":"DELETE /openapi/ha3/instances/{instanceId}/models/{modelName}","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["instanceId","modelName"],"properties":{"instanceId":{"type":"string","description":"The instance ID"},"modelName":{"type":"string","description":"The name of the model"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-searchengine/delete-public-url":{"post":{"operationId":"cloud_aliyun_searchengine_delete_public_url","summary":"Deletes a public domain name","description":"DELETE /openapi/ha3/instances/{instanceId}/public-url","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["instanceId"],"properties":{"instanceId":{"type":"string","description":"The instance ID"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-searchengine/delete-sql-instance":{"post":{"operationId":"cloud_aliyun_searchengine_delete_sql_instance","summary":"Deletes an SQL instance","description":"DELETE /openapi/ha3/instances/{instanceId}/sql-studio/databases/{database}/sql-instances/{sqlInstanceId}","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["instanceId","database","sqlInstanceId"],"properties":{"instanceId":{"type":"string","description":"The instance ID"},"database":{"type":"string","description":"The database name"},"sqlInstanceId":{"type":"string","description":"The SQL instance ID"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-searchengine/delete-table":{"post":{"operationId":"cloud_aliyun_searchengine_delete_table","summary":"Delete an index table","description":"DELETE /openapi/ha3/instances/{instanceId}/tables/{tableName}","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["instanceId","tableName"],"properties":{"instanceId":{"type":"string","description":"The instance ID"},"tableName":{"type":"string","description":"The name of the index table"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-searchengine/describe-regions":{"get":{"operationId":"cloud_aliyun_searchengine_describe_regions","summary":"Queries available regions","description":"GET /openapi/ha3/regions","tags":["cloud"],"parameters":[{"name":"acceptLanguage","in":"query","required":false,"description":"The language of the response. Default value: zh-cn","schema":{"type":"string","description":"The language of the response. Default value: zh-cn"},"example":"zh-cn"}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-searchengine/execute-sql-instance":{"post":{"operationId":"cloud_aliyun_searchengine_execute_sql_instance","summary":"Executes a SQL instance","description":"POST /openapi/ha3/instances/{instanceId}/sql-studio/databases/{database}/sql-instances/{sqlInstanceId}/actions/execution","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["instanceId","database","sqlInstanceId","content"],"properties":{"instanceId":{"type":"string","description":"The instance ID"},"database":{"type":"string","description":"The database name"},"sqlInstanceId":{"type":"string","description":"The SQL instance ID"},"combineParam":{"type":"object","description":"The combined parameters"},"content":{"type":"string","description":"The SQL content"},"domain":{"type":"string","description":"The data source server room"},"dynamicParam":{"type":"object","description":"The dynamic parameters"},"kvpair":{"type":"object","description":"The key-value struct"},"params":{"type":"object","description":"The SQL execution parameters"},"staticParam":{"type":"object","description":"The static parameters"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-searchengine/force-switch":{"post":{"operationId":"cloud_aliyun_searchengine_force_switch","summary":"Performs a forced switchover","description":"PUT /openapi/ha3/instances/{instanceId}/force-switch/{fsmId}","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["instanceId","fsmId"],"properties":{"instanceId":{"type":"string","description":"The instance ID"},"fsmId":{"type":"string","description":"The task ID"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-searchengine/get-advance-config":{"get":{"operationId":"cloud_aliyun_searchengine_get_advance_config","summary":"Queries the information about an advanced configuration","description":"GET /openapi/ha3/instances/{instanceId}/advanced-configs/{configName}","tags":["cloud"],"parameters":[{"name":"instanceId","in":"query","required":true,"description":"The instance ID","schema":{"type":"string","description":"The instance ID"}},{"name":"type","in":"query","required":false,"description":"The type of the advanced configuration. Valid values: -ONLINE: online configuration -ONLINE_CAVA: online Cava configuration…","schema":{"type":"string","description":"The type of the advanced configuration. Valid values: -ONLINE: online configuration -ONLINE_CAVA: online Cava configuration…"},"example":"ONLINE"},{"name":"configName","in":"query","required":true,"description":"The name of the advanced configuration","schema":{"type":"string","description":"The name of the advanced configuration"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-searchengine/get-advance-config-file":{"get":{"operationId":"cloud_aliyun_searchengine_get_advance_config_file","summary":"Queries the information about an advanced configuration file","description":"GET /openapi/ha3/instances/{instanceId}/advanced-configs/{configName}/file","tags":["cloud"],"parameters":[{"name":"instanceId","in":"query","required":true,"description":"The instance ID","schema":{"type":"string","description":"The instance ID"}},{"name":"configName","in":"query","required":true,"description":"The name of the advanced configuration","schema":{"type":"string","description":"The name of the advanced configuration"}},{"name":"fileName","in":"query","required":true,"description":"The name of the file","schema":{"type":"string","description":"The name of the file"},"example":"/intervene_dict/chn_ecommerce_general.dict"}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-searchengine/get-cluster":{"get":{"operationId":"cloud_aliyun_searchengine_get_cluster","summary":"Queries the details of a specific cluster","description":"GET /openapi/ha3/instances/{instanceId}/clusters/{clusterName}","tags":["cloud"],"parameters":[{"name":"instanceId","in":"query","required":true,"description":"The instance ID","schema":{"type":"string","description":"The instance ID"}},{"name":"clusterName","in":"query","required":true,"description":"The cluster name","schema":{"type":"string","description":"The cluster name"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-searchengine/get-cluster-run-time-info":{"get":{"operationId":"cloud_aliyun_searchengine_get_cluster_run_time_info","summary":"Retrieves cluster information","description":"GET /openapi/ha3/instances/{instanceId}/cluster-run-time-info","tags":["cloud"],"parameters":[{"name":"instanceId","in":"query","required":true,"description":"The instance ID","schema":{"type":"string","description":"The instance ID"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-searchengine/get-data-source":{"get":{"operationId":"cloud_aliyun_searchengine_get_data_source","summary":"Obtains a data source","description":"GET /openapi/ha3/instances/{instanceId}/data-sources/{dataSourceName}","tags":["cloud"],"parameters":[{"name":"instanceId","in":"query","required":true,"description":"The instance ID","schema":{"type":"string","description":"The instance ID"}},{"name":"dataSourceName","in":"query","required":true,"description":"The name of the data source","schema":{"type":"string","description":"The name of the data source"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-searchengine/get-data-source-deploy":{"get":{"operationId":"cloud_aliyun_searchengine_get_data_source_deploy","summary":"Retrieves data source deployment information","description":"GET /openapi/ha3/instances/{instanceId}/data-sources/{dataSourceName}/deploys/{deployName}","tags":["cloud"],"parameters":[{"name":"instanceId","in":"query","required":true,"description":"The instance ID","schema":{"type":"string","description":"The instance ID"}},{"name":"deployName","in":"query","required":true,"description":"The data center","schema":{"type":"string","description":"The data center"}},{"name":"dataSourceName","in":"query","required":true,"description":"The name of the data source","schema":{"type":"string","description":"The name of the data source"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-searchengine/get-database-schema":{"get":{"operationId":"cloud_aliyun_searchengine_get_database_schema","summary":"Retrieves the schema of a database","description":"GET /openapi/ha3/instances/{instanceId}/sql-studio/databases/{database}/tables/{tableName}/schema","tags":["cloud"],"parameters":[{"name":"instanceId","in":"query","required":true,"description":"The ID of the instance","schema":{"type":"string","description":"The ID of the instance"}},{"name":"database","in":"query","required":true,"description":"The name of the database","schema":{"type":"string","description":"The name of the database"}},{"name":"tableName","in":"query","required":true,"description":"The name of the table","schema":{"type":"string","description":"The name of the table"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-searchengine/get-deploy-graph":{"get":{"operationId":"cloud_aliyun_searchengine_get_deploy_graph","summary":"Displays the overview of the deployment","description":"GET /openapi/ha3/instances/{instanceId}/deploy-graph","tags":["cloud"],"parameters":[{"name":"instanceId","in":"query","required":true,"description":"The instance ID","schema":{"type":"string","description":"The instance ID"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-searchengine/get-file":{"get":{"operationId":"cloud_aliyun_searchengine_get_file","summary":"Retrieves the details of an index version","description":"GET /openapi/ha3/instances/{instanceId}/indexes/{indexName}/versions/{versionName}/file","tags":["cloud"],"parameters":[{"name":"instanceId","in":"query","required":true,"description":"The instance ID","schema":{"type":"string","description":"The instance ID"}},{"name":"indexName","in":"query","required":true,"description":"The index name","schema":{"type":"string","description":"The index name"}},{"name":"versionName","in":"query","required":true,"description":"The version name","schema":{"type":"string","description":"The version name"}},{"name":"fileName","in":"query","required":true,"description":"The full path of the file","schema":{"type":"string","description":"The full path of the file"},"example":"/schemas/automobile_vector_schema.json"}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-searchengine/get-index":{"get":{"operationId":"cloud_aliyun_searchengine_get_index","summary":"Retrieves the details of an index table version","description":"GET /openapi/ha3/instances/{instanceId}/indexes/{indexName}","tags":["cloud"],"parameters":[{"name":"instanceId","in":"query","required":true,"description":"The instance ID","schema":{"type":"string","description":"The instance ID"}},{"name":"indexName","in":"query","required":true,"description":"The index name","schema":{"type":"string","description":"The index name"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-searchengine/get-index-online-strategy":{"get":{"operationId":"cloud_aliyun_searchengine_get_index_online_strategy","summary":"Gets the online strategy of an index","description":"GET /openapi/ha3/instances/{instanceId}/data-sources/{dataSourceName}/deploys/{deployName}/indexes/{indexName}/online-strategy","tags":["cloud"],"parameters":[{"name":"instanceId","in":"query","required":true,"description":"The instance ID","schema":{"type":"string","description":"The instance ID"}},{"name":"dataSourceName","in":"query","required":true,"description":"The name of the data source","schema":{"type":"string","description":"The name of the data source"}},{"name":"deployName","in":"query","required":true,"description":"The name of the data center in which the data source is deployed","schema":{"type":"string","description":"The name of the data center in which the data source is deployed"}},{"name":"indexName","in":"query","required":true,"description":"The index name","schema":{"type":"string","description":"The index name"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-searchengine/get-index-version":{"get":{"operationId":"cloud_aliyun_searchengine_get_index_version","summary":"Gets the index versions to which a cluster can be rolled back","description":"GET /openapi/ha3/instances/{instanceId}/clusters/{clusterName}/index-version","tags":["cloud"],"parameters":[{"name":"instanceId","in":"query","required":true,"description":"The instance ID","schema":{"type":"string","description":"The instance ID"}},{"name":"clusterName","in":"query","required":true,"description":"The name of the cluster","schema":{"type":"string","description":"The name of the cluster"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-searchengine/get-instance":{"get":{"operationId":"cloud_aliyun_searchengine_get_instance","summary":"Retrieves the details of a specified instance by instance ID","description":"GET /openapi/ha3/instances/{instanceId}","tags":["cloud"],"parameters":[{"name":"instanceId","in":"query","required":true,"description":"The instance ID","schema":{"type":"string","description":"The instance ID"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-searchengine/get-model":{"get":{"operationId":"cloud_aliyun_searchengine_get_model","summary":"Queries the detailed configuration information of a specific model by instance ID and model name","description":"GET /openapi/ha3/instances/{instanceId}/models/{modelName}","tags":["cloud"],"parameters":[{"name":"instanceId","in":"query","required":true,"description":"The instance ID","schema":{"type":"string","description":"The instance ID"}},{"name":"modelName","in":"query","required":true,"description":"The model name","schema":{"type":"string","description":"The model name"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-searchengine/get-node-config":{"get":{"operationId":"cloud_aliyun_searchengine_get_node_config","summary":"Retrieves the configuration information of a node","description":"GET /openapi/ha3/instances/{instanceId}/node-config","tags":["cloud"],"parameters":[{"name":"instanceId","in":"query","required":true,"description":"The instance ID","schema":{"type":"string","description":"The instance ID"}},{"name":"type","in":"query","required":false,"description":"The node type. Valid values: qrs: query node search: data node index: index node cluster: cluster","schema":{"type":"string","description":"The node type. Valid values: qrs: query node search: data node index: index node cluster: cluster"},"example":"index"},{"name":"name","in":"query","required":false,"description":"The node name","schema":{"type":"string","description":"The node name"},"example":"ha-cn-30174dhoz53_qrs"},{"name":"clusterName","in":"query","required":false,"description":"The cluster name","schema":{"type":"string","description":"The cluster name"},"example":"vpc_sh_domain_2"}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-searchengine/get-sql-instance":{"get":{"operationId":"cloud_aliyun_searchengine_get_sql_instance","summary":"Retrieves SQL instance information","description":"GET /openapi/ha3/instances/{instanceId}/sql-studio/databases/{database}/sql-instances/{sqlInstanceId}","tags":["cloud"],"parameters":[{"name":"instanceId","in":"query","required":true,"description":"The instance ID","schema":{"type":"string","description":"The instance ID"}},{"name":"database","in":"query","required":true,"description":"The database name","schema":{"type":"string","description":"The database name"}},{"name":"sqlInstanceId","in":"query","required":true,"description":"The SQL instance ID","schema":{"type":"string","description":"The SQL instance ID"}},{"name":"version","in":"query","required":false,"description":"The instance version","schema":{"type":"integer","description":"The instance version"},"example":"1"}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-searchengine/get-table":{"get":{"operationId":"cloud_aliyun_searchengine_get_table","summary":"Get index table information","description":"GET /openapi/ha3/instances/{instanceId}/tables/{tableName}","tags":["cloud"],"parameters":[{"name":"instanceId","in":"query","required":true,"description":"Instance ID","schema":{"type":"string","description":"Instance ID"}},{"name":"tableName","in":"query","required":true,"description":"Index table name","schema":{"type":"string","description":"Index table name"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-searchengine/get-table-generation":{"get":{"operationId":"cloud_aliyun_searchengine_get_table_generation","summary":"Queries the status of an index version based on the ID of the full index version","description":"GET /openapi/ha3/instances/{instanceId}/tables/{tableName}/index_versions/{generationId}","tags":["cloud"],"parameters":[{"name":"instanceId","in":"query","required":true,"description":"The instance ID","schema":{"type":"string","description":"The instance ID"}},{"name":"tableName","in":"query","required":true,"description":"The name of the table","schema":{"type":"string","description":"The name of the table"}},{"name":"generationId","in":"query","required":true,"description":"The ID of the full index version","schema":{"type":"string","description":"The ID of the full index version"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-searchengine/list-advance-config-dir":{"get":{"operationId":"cloud_aliyun_searchengine_list_advance_config_dir","summary":"Retrieves the list of files in an advanced configuration directory","description":"GET /openapi/ha3/instances/{instanceId}/advanced-configs/{configName}/dir","tags":["cloud"],"parameters":[{"name":"instanceId","in":"query","required":true,"description":"The instance ID","schema":{"type":"string","description":"The instance ID"}},{"name":"configName","in":"query","required":true,"description":"The configuration name","schema":{"type":"string","description":"The configuration name"}},{"name":"dirName","in":"query","required":true,"description":"The directory name","schema":{"type":"string","description":"The directory name"},"example":"/zones/general"}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-searchengine/list-advance-configs":{"get":{"operationId":"cloud_aliyun_searchengine_list_advance_configs","summary":"Queries the list of advanced configurations","description":"GET /openapi/ha3/instances/{instanceId}/advanced-configs","tags":["cloud"],"parameters":[{"name":"instanceId","in":"query","required":true,"description":"The instance ID","schema":{"type":"string","description":"The instance ID"}},{"name":"type","in":"query","required":false,"description":"The type of the advanced configuration. Valid values: online offline (default)","schema":{"type":"string","description":"The type of the advanced configuration. Valid values: online offline (default)"},"example":"online"},{"name":"dataSourceName","in":"query","required":false,"description":"The name of the data source","schema":{"type":"string","description":"The name of the data source"},"example":"ha-cn-pl32rf0****_test_api\n"},{"name":"indexName","in":"query","required":false,"description":"The name of the index","schema":{"type":"string","description":"The name of the index"},"example":"test_api"},{"name":"newMode","in":"query","required":false,"description":"Specifies whether to use the new version of the console page","schema":{"type":"string","description":"Specifies whether to use the new version of the console page"},"example":"true"},{"name":"pageNumber","in":"query","required":false,"description":"The page number. Default value: 1","schema":{"type":"string","description":"The page number. Default value: 1"},"example":"1"},{"name":"pageSize","in":"query","required":false,"description":"The number of entries per page. Default value: 10","schema":{"type":"string","description":"The number of entries per page. Default value: 10"},"example":"10"}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-searchengine/list-aliases":{"get":{"operationId":"cloud_aliyun_searchengine_list_aliases","summary":"Lists table aliases","description":"GET /openapi/ha3/instances/{instanceId}/aliases","tags":["cloud"],"parameters":[{"name":"instanceId","in":"query","required":true,"description":"The instance ID","schema":{"type":"string","description":"The instance ID"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-searchengine/list-cluster-names":{"get":{"operationId":"cloud_aliyun_searchengine_list_cluster_names","summary":"Queries cluster names","description":"GET /openapi/ha3/cluster-names","tags":["cloud"],"parameters":[],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-searchengine/list-cluster-tasks":{"get":{"operationId":"cloud_aliyun_searchengine_list_cluster_tasks","summary":"Queries cluster tasks","description":"GET /openapi/ha3/instances/{instanceId}/cluster-tasks","tags":["cloud"],"parameters":[{"name":"instanceId","in":"query","required":true,"description":"The instance ID","schema":{"type":"string","description":"The instance ID"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-searchengine/list-clusters":{"get":{"operationId":"cloud_aliyun_searchengine_list_clusters","summary":"Queries clusters","description":"GET /openapi/ha3/instances/{instanceId}/clusters","tags":["cloud"],"parameters":[{"name":"instanceId","in":"query","required":true,"description":"The instance ID","schema":{"type":"string","description":"The instance ID"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-searchengine/list-data-source-schemas":{"get":{"operationId":"cloud_aliyun_searchengine_list_data_source_schemas","summary":"Queries the schema information about a data source","description":"GET /openapi/ha3/instances/{instanceId}/data-sources/{dataSourceName}/schemas","tags":["cloud"],"parameters":[{"name":"instanceId","in":"query","required":true,"description":"The instance ID","schema":{"type":"string","description":"The instance ID"}},{"name":"dataSourceName","in":"query","required":true,"description":"The name of the data source","schema":{"type":"string","description":"The name of the data source"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-searchengine/list-data-source-tasks":{"get":{"operationId":"cloud_aliyun_searchengine_list_data_source_tasks","summary":"Retrieves data source tasks","description":"GET /openapi/ha3/instances/{instanceId}/data-source-tasks","tags":["cloud"],"parameters":[{"name":"instanceId","in":"query","required":true,"description":"The instance ID","schema":{"type":"string","description":"The instance ID"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-searchengine/list-data-sources":{"get":{"operationId":"cloud_aliyun_searchengine_list_data_sources","summary":"Obtains the list of data sources","description":"GET /openapi/ha3/instances/{instanceId}/data-sources","tags":["cloud"],"parameters":[{"name":"instanceId","in":"query","required":true,"description":"The instance ID","schema":{"type":"string","description":"The instance ID"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-searchengine/list-databases":{"get":{"operationId":"cloud_aliyun_searchengine_list_databases","summary":"Lists the existing databases","description":"GET /openapi/ha3/instances/{instanceId}/sql-studio/databases","tags":["cloud"],"parameters":[{"name":"instanceId","in":"query","required":true,"description":"The instance ID","schema":{"type":"string","description":"The instance ID"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-searchengine/list-date-source-generations":{"get":{"operationId":"cloud_aliyun_searchengine_list_date_source_generations","summary":"Retrieves the historical data backflow information for a data source","description":"GET /openapi/ha3/instances/{instanceId}/data-sources/{dataSourceName}/generations","tags":["cloud"],"parameters":[{"name":"instanceId","in":"query","required":true,"description":"The instance ID","schema":{"type":"string","description":"The instance ID"}},{"name":"dataSourceName","in":"query","required":true,"description":"The name of the data source","schema":{"type":"string","description":"The name of the data source"}},{"name":"validStatus","in":"query","required":false,"description":"Specifies whether the status is valid. Default value: true. true: Returns generations for which tasks are completed and have not expired.…","schema":{"type":"string","description":"Specifies whether the status is valid. Default value: true. true: Returns generations for which tasks are completed and have not expired.…"},"example":"true"},{"name":"domainName","in":"query","required":true,"description":"The data center where the data source is deployed","schema":{"type":"string","description":"The data center where the data source is deployed"},"example":"bj_vpc_domain_1"}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-searchengine/list-index-recover-records":{"get":{"operationId":"cloud_aliyun_searchengine_list_index_recover_records","summary":"Retrieves data recovery records","description":"GET /openapi/ha3/instances/{instanceId}/indexes/{indexName}/actions/list-recover-records","tags":["cloud"],"parameters":[{"name":"indexName","in":"query","required":true,"description":"The index name","schema":{"type":"string","description":"The index name"}},{"name":"instanceId","in":"query","required":true,"description":"The instance ID","schema":{"type":"string","description":"The instance ID"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-searchengine/list-indexes":{"get":{"operationId":"cloud_aliyun_searchengine_list_indexes","summary":"Retrieves the list of indexes","description":"GET /openapi/ha3/instances/{instanceId}/indexes","tags":["cloud"],"parameters":[{"name":"instanceId","in":"query","required":true,"description":"The instance ID","schema":{"type":"string","description":"The instance ID"}},{"name":"newMode","in":"query","required":false,"description":"Specifies whether the new version of the console page is used","schema":{"type":"string","description":"Specifies whether the new version of the console page is used"},"example":"true"},{"name":"catalog","in":"query","required":false,"description":"The data catalog ID of the DLF data source","schema":{"type":"string","description":"The data catalog ID of the DLF data source"},"example":"clg-paimon-765e9e2d43ab4fccbf095853a661eafc"},{"name":"database","in":"query","required":false,"description":"The database of the DLF data source","schema":{"type":"string","description":"The database of the DLF data source"},"example":"dlf_test"},{"name":"table","in":"query","required":false,"description":"The data table of the DLF data source","schema":{"type":"string","description":"The data table of the DLF data source"},"example":"rag"}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-searchengine/list-instance-specs":{"get":{"operationId":"cloud_aliyun_searchengine_list_instance_specs","summary":"Gets the specifications available for a cluster","description":"GET /openapi/ha3/instances/{instanceId}/specs","tags":["cloud"],"parameters":[{"name":"instanceId","in":"query","required":true,"description":"The instance ID","schema":{"type":"string","description":"The instance ID"}},{"name":"type","in":"query","required":true,"description":"The node type. Valid values: qrs: Query Result Searcher (QRS) Worker search: Searcher Worker index: index node cluster: cluster","schema":{"type":"string","description":"The node type. Valid values: qrs: Query Result Searcher (QRS) Worker search: Searcher Worker index: index node cluster: cluster"},"example":"search"}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-searchengine/list-instances":{"get":{"operationId":"cloud_aliyun_searchengine_list_instances","summary":"Retrieves a list of instances","description":"GET /openapi/ha3/instances","tags":["cloud"],"parameters":[{"name":"pageNumber","in":"query","required":false,"description":"Specifies the page number. Default value: 1","schema":{"type":"integer","description":"Specifies the page number. Default value: 1"},"example":"1"},{"name":"pageSize","in":"query","required":false,"description":"Specifies the number of entries per page. Default value: 10. Valid values: 1 to 50","schema":{"type":"integer","description":"Specifies the number of entries per page. Default value: 10. Valid values: 1 to 50"},"example":"10"},{"name":"instanceId","in":"query","required":false,"description":"The instance ID","schema":{"type":"string","description":"The instance ID"},"example":"ha-cn-pl32rf0****"},{"name":"description","in":"query","required":false,"description":"Filters instances by description. Fuzzy matching is supported","schema":{"type":"string","description":"Filters instances by description. Fuzzy matching is supported"},"example":"searchengine instance"},{"name":"resourceGroupId","in":"query","required":false,"description":"The resource group ID","schema":{"type":"string","description":"The resource group ID"},"example":"rg-aekzgpiswzbksdi"},{"name":"edition","in":"query","required":false,"description":"The instance edition. Valid values: vector (Vector Index Edition) and engine (Recall Engine Edition)","schema":{"type":"string","description":"The instance edition. Valid values: vector (Vector Index Edition) and engine (Recall Engine Edition)"},"example":"vector"},{"name":"tags","in":"query","required":false,"description":"The tags (JSON-encoded)","schema":{"type":"string","description":"The tags (JSON-encoded)"}},{"name":"catalog","in":"query","required":false,"description":"The DLF data catalog ID","schema":{"type":"string","description":"The DLF data catalog ID"}},{"name":"database","in":"query","required":false,"description":"The DLF database name","schema":{"type":"string","description":"The DLF database name"}},{"name":"table","in":"query","required":false,"description":"The data source table name","schema":{"type":"string","description":"The data source table name"}},{"name":"dataSourceType","in":"query","required":false,"description":"The data source type","schema":{"type":"string","description":"The data source type"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-searchengine/list-logs":{"get":{"operationId":"cloud_aliyun_searchengine_list_logs","summary":"Queries the logs of an instance","description":"GET /openapi/ha3/instances/{instanceId}/logs","tags":["cloud"],"parameters":[{"name":"instanceId","in":"query","required":true,"description":"The instance ID","schema":{"type":"string","description":"The instance ID"}},{"name":"type","in":"query","required":false,"description":"The log type. Valid values: \\`select\\` (query logs) and \\`push\\` (write logs)","schema":{"type":"string","description":"The log type. Valid values: \\`select\\` (query logs) and \\`push\\` (write logs)"},"example":"push"},{"name":"pageNum","in":"query","required":false,"description":"The page number. The default value is 1","schema":{"type":"string","description":"The page number. The default value is 1"},"example":"1"},{"name":"pageSize","in":"query","required":false,"description":"The number of entries to return on each page. The default value is 10","schema":{"type":"string","description":"The number of entries to return on each page. The default value is 10"},"example":"10"},{"name":"startTime","in":"query","required":false,"description":"The start of the time range to query. This is a UNIX timestamp in seconds","schema":{"type":"string","description":"The start of the time range to query. This is a UNIX timestamp in seconds"},"example":"1706340600"},{"name":"endTime","in":"query","required":false,"description":"The end of the time range to query. This is a UNIX timestamp in seconds","schema":{"type":"string","description":"The end of the time range to query. This is a UNIX timestamp in seconds"},"example":"1710432000"},{"name":"query","in":"query","required":false,"description":"The search statement","schema":{"type":"string","description":"The search statement"},"example":"status: 200 AND totalTime > 0.01"}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-searchengine/list-models":{"get":{"operationId":"cloud_aliyun_searchengine_list_models","summary":"Queries a list of models under specified conditions by instance ID","description":"GET /openapi/ha3/instances/{instanceId}/models","tags":["cloud"],"parameters":[{"name":"instanceId","in":"query","required":true,"description":"The instance ID","schema":{"type":"string","description":"The instance ID"}},{"name":"name","in":"query","required":false,"description":"The model name","schema":{"type":"string","description":"The model name"},"example":"test1"},{"name":"type","in":"query","required":false,"description":"The model category","schema":{"type":"string","description":"The model category"},"example":"text_embedding"},{"name":"pageNumber","in":"query","required":false,"description":"The page number. Default value: 1","schema":{"type":"integer","description":"The page number. Default value: 1"},"example":"1"},{"name":"pageSize","in":"query","required":false,"description":"The number of entries per page. Default value: 10","schema":{"type":"integer","description":"The number of entries per page. Default value: 10"},"example":"10"}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-searchengine/list-online-configs":{"get":{"operationId":"cloud_aliyun_searchengine_list_online_configs","summary":"Gets details of online table configurations","description":"GET /openapi/ha3/instances/{instanceId}/node/{nodeName}/online-configs","tags":["cloud"],"parameters":[{"name":"instanceId","in":"query","required":true,"description":"The instance ID","schema":{"type":"string","description":"The instance ID"}},{"name":"nodeName","in":"query","required":true,"description":"The name of the Query Result Searcher (QRS) worker","schema":{"type":"string","description":"The name of the Query Result Searcher (QRS) worker"}},{"name":"domain","in":"query","required":true,"description":"The name of the domain","schema":{"type":"string","description":"The name of the domain"},"example":"sz_vpc_domain_1"}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-searchengine/list-pause-policys":{"get":{"operationId":"cloud_aliyun_searchengine_list_pause_policys","summary":"Queries pause policies","description":"GET /openapi/ha3/instances/{instanceId}/pause-policies","tags":["cloud"],"parameters":[{"name":"instanceId","in":"query","required":true,"description":"The instance ID","schema":{"type":"string","description":"The instance ID"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-searchengine/list-post-query-result":{"post":{"operationId":"cloud_aliyun_searchengine_list_post_query_result","summary":"Retrieves search test results for a Retrieval Engine Edition instance by sending a POST request","description":"POST /openapi/ha3/instances/{instanceId}/query","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["instanceId"],"properties":{"instanceId":{"type":"string","description":"The instance ID"},"type":{"type":"string","description":"sql: SQL query. ha3: HA3 query"},"body":{"type":"object","description":"The request structure"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-searchengine/list-query-result":{"get":{"operationId":"cloud_aliyun_searchengine_list_query_result","summary":"Gets search test results","description":"GET /openapi/ha3/instances/{instanceId}/query","tags":["cloud"],"parameters":[{"name":"instanceId","in":"query","required":true,"description":"The instance ID","schema":{"type":"string","description":"The instance ID"}},{"name":"query","in":"query","required":false,"description":"The query statement","schema":{"type":"string","description":"The query statement"},"example":"query%3D1%26%26config%3Dstart%3A0%2Chit%3A10%2Cformat%3Ajson%26%26cluster%3Dgeneral"},{"name":"sql","in":"query","required":false,"description":"The SQL statement that is executed in the query","schema":{"type":"string","description":"The SQL statement that is executed in the query"},"example":"query%3Dselect%20max(content_id)%20from%20generation"}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-searchengine/list-rest-query-result":{"post":{"operationId":"cloud_aliyun_searchengine_list_rest_query_result","summary":"Retrieves the test results of a REST search query for a Retrieval Engine Edition instance","description":"POST /openapi/ha3/instances/{instanceId}/rest-query","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["instanceId"],"properties":{"instanceId":{"type":"string","description":"The instance ID"},"indexName":{"type":"string","description":"The name of the index table"},"query":{"type":"object","description":"The REST query"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-searchengine/list-schemas":{"get":{"operationId":"cloud_aliyun_searchengine_list_schemas","summary":"Retrieves a list of schemas based on a data synchronization configuration","description":"GET /openapi/ha3/instances/{instanceId}/schemas","tags":["cloud"],"parameters":[{"name":"type","in":"query","required":true,"description":"odps, swift, saro, oss, unknown","schema":{"type":"string","description":"odps, swift, saro, oss, unknown"},"example":"odps"},{"name":"endpoint","in":"query","required":false,"description":"The endpoint of the ODPS data source","schema":{"type":"string","description":"The endpoint of the ODPS data source"},"example":"http://service.cn-hangzhou.maxcompute.aliyun-inc.com/api"},{"name":"accessKey","in":"query","required":false,"description":"The AccessKey ID of the ODPS data source","schema":{"type":"string","description":"The AccessKey ID of the ODPS data source"},"example":"L***p"},{"name":"accessSecret","in":"query","required":false,"description":"The AccessKey secret of the ODPS data source","schema":{"type":"string","description":"The AccessKey secret of the ODPS data source"},"example":"5**9a6"},{"name":"project","in":"query","required":false,"description":"The name of the ODPS data source project","schema":{"type":"string","description":"The name of the ODPS data source project"},"example":"sec_odps"},{"name":"partition","in":"query","required":false,"description":"The data partition","schema":{"type":"string","description":"The data partition"},"example":"dt=20230520"},{"name":"table","in":"query","required":false,"description":"The name of the table in the Saro or ODPS data source","schema":{"type":"string","description":"The name of the table in the Saro or ODPS data source"},"example":"item"},{"name":"namespace","in":"query","required":false,"description":"The namespace of the Saro data source","schema":{"type":"string","description":"The namespace of the Saro data source"},"example":"imm"},{"name":"instanceId","in":"query","required":true,"description":"The instance ID","schema":{"type":"string","description":"The instance ID"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-searchengine/list-table-generations":{"get":{"operationId":"cloud_aliyun_searchengine_list_table_generations","summary":"Queries a list of index versions","description":"GET /openapi/ha3/instances/{instanceId}/tables/{tableName}/index_versions","tags":["cloud"],"parameters":[{"name":"instanceId","in":"query","required":true,"description":"The instance ID","schema":{"type":"string","description":"The instance ID"}},{"name":"tableName","in":"query","required":true,"description":"The name of the table","schema":{"type":"string","description":"The name of the table"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-searchengine/list-tables":{"get":{"operationId":"cloud_aliyun_searchengine_list_tables","summary":"Queries a list of index tables","description":"GET /openapi/ha3/instances/{instanceId}/tables","tags":["cloud"],"parameters":[{"name":"instanceId","in":"query","required":true,"description":"The instance ID","schema":{"type":"string","description":"The instance ID"}},{"name":"newMode","in":"query","required":false,"description":"Specifies whether the OpenSearch Vector Search Edition instance is of the new version","schema":{"type":"string","description":"Specifies whether the OpenSearch Vector Search Edition instance is of the new version"},"example":"true"}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-searchengine/list-tag-resources":{"get":{"operationId":"cloud_aliyun_searchengine_list_tag_resources","summary":"Queries the tags attached to one or more resources","description":"GET /openapi/ha3/resource-tags","tags":["cloud"],"parameters":[{"name":"resourceType","in":"query","required":true,"description":"The resource type","schema":{"type":"string","description":"The resource type"},"example":"instance"},{"name":"resourceId","in":"query","required":false,"description":"The IDs of the resources. You can specify up to 50 resource IDs (JSON-encoded)","schema":{"type":"string","description":"The IDs of the resources. You can specify up to 50 resource IDs (JSON-encoded)"}},{"name":"tag","in":"query","required":false,"description":"A list of up to 20 tags to add (JSON-encoded)","schema":{"type":"string","description":"A list of up to 20 tags to add (JSON-encoded)"}},{"name":"nextToken","in":"query","required":false,"description":"The token that is used to retrieve the next page of results","schema":{"type":"string","description":"The token that is used to retrieve the next page of results"},"example":"600********33"}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-searchengine/list-tasks":{"get":{"operationId":"cloud_aliyun_searchengine_list_tasks","summary":"Retrieves the change history for an instance","description":"GET /openapi/ha3/instances/{instanceId}/tasks","tags":["cloud"],"parameters":[{"name":"instanceId","in":"query","required":true,"description":"The instance ID","schema":{"type":"string","description":"The instance ID"}},{"name":"start","in":"query","required":false,"description":"The start time","schema":{"type":"integer","description":"The start time"},"example":"1718846192"},{"name":"end","in":"query","required":false,"description":"The end time","schema":{"type":"integer","description":"The end time"},"example":"1718846192"}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-searchengine/list-vector-query-result":{"post":{"operationId":"cloud_aliyun_searchengine_list_vector_query_result","summary":"Retrieves the results of a vector query test in Vector Search Edition","description":"POST /openapi/ha3/instances/{instanceId}/vector-query","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["instanceId"],"properties":{"instanceId":{"type":"string","description":"The instance ID"},"path":{"type":"string","description":"The path"},"queryType":{"type":"string","description":"The query type. Valid values: vector, primary_key, and vector_text"},"vectorQueryType":{"type":"string","description":"The vector query type. Valid values: vector, image, and text"},"body":{"type":"object","description":"The request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-searchengine/modify-advance-config":{"post":{"operationId":"cloud_aliyun_searchengine_modify_advance_config","summary":"Modifies the content of HTTP and Git files","description":"PUT /openapi/ha3/instances/{instanceId}/advanced-configs/{configName}","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["instanceId","configName"],"properties":{"instanceId":{"type":"string","description":"The instance ID"},"configName":{"type":"string","description":"The configuration name"},"content":{"type":"string","description":"The configuration content. This parameter is required for HTTP and Git requests"},"contentType":{"type":"string","description":"The type of the configuration content. Valid values: FILE, GIT, HTTP, and ODPS"},"desc":{"type":"string","description":"The description of the advanced configuration"},"files":{"type":"array","description":"The list of file names"},"name":{"type":"string","description":"The configuration name"},"status":{"type":"string","description":"The configuration status. Valid values: drafting: Draft. used: In use. unused: Unused. trash: Deleting"},"updateTime":{"type":"integer","description":"The update time. The value is a UNIX timestamp in milliseconds"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-searchengine/modify-advance-config-file":{"post":{"operationId":"cloud_aliyun_searchengine_modify_advance_config_file","summary":"Modifies a dictionary","description":"PUT /openapi/ha3/instances/{instanceId}/advanced-configs/{configName}/file","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["instanceId","configName","fileName"],"properties":{"instanceId":{"type":"string","description":"The instance ID"},"configName":{"type":"string","description":"The configuration name"},"fileName":{"type":"string","description":"The file name"},"content":{"type":"string","description":"The file content"},"variables":{"type":"object","description":"The list of variables"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-searchengine/modify-alias":{"post":{"operationId":"cloud_aliyun_searchengine_modify_alias","summary":"Modifies a table alias","description":"PUT /openapi/ha3/instances/{instanceId}/aliases/{alias}","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["instanceId","alias"],"properties":{"instanceId":{"type":"string","description":"The ID of the instance"},"alias":{"type":"string","description":"The alias"},"index":{"type":"string","description":"The index to associate with the alias"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-searchengine/modify-cluster-desc":{"post":{"operationId":"cloud_aliyun_searchengine_modify_cluster_desc","summary":"Modifies the description of a specified cluster","description":"PUT /openapi/ha3/instances/{instanceId}/clusters/{clusterName}/desc","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["instanceId","clusterName"],"properties":{"instanceId":{"type":"string","description":"The instance ID"},"clusterName":{"type":"string","description":"The name of the cluster"},"body":{"type":"object","description":"The request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-searchengine/modify-cluster-offline-config":{"post":{"operationId":"cloud_aliyun_searchengine_modify_cluster_offline_config","summary":"Modifies the configuration information of a cluster","description":"PUT /openapi/ha3/instances/{instanceId}/cluster-offline-config","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["instanceId"],"properties":{"instanceId":{"type":"string","description":"The instance ID"},"buildMode":{"type":"string","description":"The reindexing method. Valid values: api: API data source. indexRecover: data recovery by using indexing"},"config":{"type":"object","description":"The configuration name, which is stored as a key"},"dataSourceName":{"type":"string","description":"The name of the data source"},"dataSourceType":{"type":"string","description":"The type of the data source. Valid values: odps: MaxCompute. swift: Swift. unKnow: unknown type"},"dataTimeSec":{"type":"integer","description":"The data timestamp, in seconds. This parameter is required when an API-pushed data source triggers a full index build"},"domain":{"type":"string","description":"The data center in which the data source is deployed"},"generation":{"type":"integer","description":"The ID of the full index version"},"partition":{"type":"string","description":"This parameter is required when index building for full data in a MaxCompute data source is triggered"},"pushMode":{"type":"string","description":"The push mode of the configuration. By default, only the configuration is pushed"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-searchengine/modify-cluster-online-config":{"post":{"operationId":"cloud_aliyun_searchengine_modify_cluster_online_config","summary":"Modifies the online configuration of a cluster","description":"PUT /openapi/ha3/instances/{instanceId}/cluster-online-config","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["instanceId"],"properties":{"instanceId":{"type":"string","description":"The instance ID"},"clusters":{"type":"array","description":"The cluster information"},"config":{"type":"object","description":"The configuration information"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-searchengine/modify-data-source-deploy":{"post":{"operationId":"cloud_aliyun_searchengine_modify_data_source_deploy","summary":"Modifies the deployment information of a data source","description":"PUT /openapi/ha3/instances/{instanceId}/data-sources/{dataSourceName}/deploys/{deployName}","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["instanceId","deployName","dataSourceName"],"properties":{"instanceId":{"type":"string","description":"The instance ID"},"deployName":{"type":"string","description":"The data center"},"dataSourceName":{"type":"string","description":"The name of the data source"},"generationId":{"type":"integer","description":"The full index version"},"dryRun":{"type":"string","description":"Specifies whether to perform a dry run (only validates whether the data source is valid). Valid values: true: performs a dry run. false:…"},"autoBuildIndex":{"type":"string","description":"Specifies whether to enable automatic full indexing"},"extend":{"type":"object","description":"The extended information"},"processor":{"type":"object","description":"The process parameters"},"storage":{"type":"object","description":"The data source information"},"swift":{"type":"object","description":"The incremental Swift information"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-searchengine/modify-file":{"post":{"operationId":"cloud_aliyun_searchengine_modify_file","summary":"Modifies a file","description":"PUT /openapi/ha3/instances/{instanceId}/indexes/{indexName}/versions/{versionName}/file","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["instanceId","indexName","versionName","fileName"],"properties":{"instanceId":{"type":"string","description":"The instance ID"},"indexName":{"type":"string","description":"The index name"},"versionName":{"type":"string","description":"The version name"},"fileName":{"type":"string","description":"The name of the file in the full path"},"content":{"type":"string","description":"The file content"},"partition":{"type":"integer","description":"The number of shards"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-searchengine/modify-index":{"post":{"operationId":"cloud_aliyun_searchengine_modify_index","summary":"Modifies an index","description":"PUT /openapi/ha3/instances/{instanceId}/indexes/{indexName}","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["instanceId","indexName"],"properties":{"instanceId":{"type":"string","description":"The instance ID"},"indexName":{"type":"string","description":"The index name"},"dryRun":{"type":"string","description":"Specifies whether to only validate the input parameters without performing the actual operation. Default value: false. Valid values: true:…"},"buildParallelNum":{"type":"integer","description":"The number of concurrent full-indexing build threads"},"cluster":{"type":"object","description":"The cluster information"},"clusterConfigName":{"type":"string","description":"The cluster.json file name"},"config":{"type":"object","description":"The offline configuration information"},"content":{"type":"string","description":"The file content"},"dataSource":{"type":"string","description":"The data source"},"dataSourceInfo":{"type":"object","description":"The data source information. This parameter is required for the new version of the Vector Search Edition"},"description":{"type":"string","description":"The description"},"domain":{"type":"string","description":"The data source deployment"},"extend":{"type":"object","description":"The extended content for field configurations. key: vector (vector field), embeding (field requiring embedding), or description (remarks…"},"mergeParallelNum":{"type":"integer","description":"The number of concurrent full-indexing merge threads"},"partition":{"type":"integer","description":"The data partition"},"pushMode":{"type":"string","description":"The push configuration mode. Default value: push configuration only"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-searchengine/modify-index-online-strategy":{"post":{"operationId":"cloud_aliyun_searchengine_modify_index_online_strategy","summary":"Modifies the online policy of an index","description":"PUT /openapi/ha3/instances/{instanceId}/data-sources/{dataSourceName}/deploys/{deployName}/indexes/{indexName}/online-strategy","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["instanceId","dataSourceName","deployName","indexName"],"properties":{"instanceId":{"type":"string","description":"The instance ID"},"dataSourceName":{"type":"string","description":"The name of the data source"},"deployName":{"type":"string","description":"The name of the data center in which the data source is deployed"},"indexName":{"type":"string","description":"The index name"},"changeRate":{"type":"integer","description":"The index change rate"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-searchengine/modify-index-partition":{"post":{"operationId":"cloud_aliyun_searchengine_modify_index_partition","summary":"Modifies the information about index partitions","description":"PUT /openapi/ha3/instances/{instanceId}/index-partition","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["instanceId"],"properties":{"instanceId":{"type":"string","description":"The instance ID"},"dataSourceName":{"type":"string","description":"The name of the data source"},"domainName":{"type":"string","description":"The data center"},"generation":{"type":"integer","description":"The primary key"},"indexInfos":{"type":"array","description":"The index information"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-searchengine/modify-index-version":{"post":{"operationId":"cloud_aliyun_searchengine_modify_index_version","summary":"Modifies the index version of a cluster (an index version rollback)","description":"PUT /openapi/ha3/instances/{instanceId}/clusters/{clusterName}/index-version","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["instanceId","clusterName"],"properties":{"instanceId":{"type":"string","description":"The instance ID"},"clusterName":{"type":"string","description":"The name of the cluster"},"body":{"type":"array","description":"The request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-searchengine/modify-model":{"post":{"operationId":"cloud_aliyun_searchengine_modify_model","summary":"Modifies the details and status of a model","description":"PUT /openapi/ha3/instances/{instanceId}/models/{modelName}","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["instanceId","modelName"],"properties":{"instanceId":{"type":"string","description":"The instance ID"},"modelName":{"type":"string","description":"The model name"},"dryRun":{"type":"string","description":"Specifies whether to perform only a check. The default value is false"},"content":{"type":"object","description":"The model details"},"status":{"type":"string","description":"The model status. ok: The model is available. forbidden: The model is unavailable"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-searchengine/modify-node-config":{"post":{"operationId":"cloud_aliyun_searchengine_modify_node_config","summary":"Modifies node configuration","description":"PUT /openapi/ha3/instances/{instanceId}/node-config","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["instanceId","type","name"],"properties":{"instanceId":{"type":"string","description":"The instance ID"},"type":{"type":"string","description":"The type of the algorithm. Valid values: pop: a popularity model. cp: a category prediction model. hot: a top search model. hint: a hint…"},"name":{"type":"string","description":"The name of the configuration before the modification"},"clusterName":{"type":"string","description":"The name of the cluster"},"dataSourceName":{"type":"string","description":"The name of the data source. Valid values: -search: search for data. -not_search: do not search for data"},"active":{"type":"string","description":"Specifies whether the index is active online"},"dataDuplicateNumber":{"type":"integer","description":"The number of data replicas"},"dataFragmentNumber":{"type":"integer","description":"The number of data shards"},"flowRatio":{"type":"integer","description":"The traffic percentage"},"minServicePercent":{"type":"integer","description":"The minimum service ratio"},"published":{"type":"string","description":"Specifies whether to mount the cluster"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-searchengine/modify-online-config":{"post":{"operationId":"cloud_aliyun_searchengine_modify_online_config","summary":"Modifies online configurations","description":"PUT /openapi/ha3/instances/{instanceId}/node/{nodeName}/online-configs/{indexName}","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["instanceId","nodeName","indexName"],"properties":{"instanceId":{"type":"string","description":"The instance ID"},"nodeName":{"type":"string","description":"The node name"},"indexName":{"type":"string","description":"The index name"},"body":{"type":"object","description":"The request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-searchengine/modify-password":{"post":{"operationId":"cloud_aliyun_searchengine_modify_password","summary":"Modifies the password of an instance","description":"PUT /openapi/ha3/instances/{instanceId}/password","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["instanceId"],"properties":{"instanceId":{"type":"string","description":"The instance ID"},"password":{"type":"string","description":"The password"},"username":{"type":"string","description":"The username"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-searchengine/modify-pause-policy":{"post":{"operationId":"cloud_aliyun_searchengine_modify_pause_policy","summary":"Modifies the pause policy","description":"PUT /openapi/ha3/instances/{instanceId}/pause-policies","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["instanceId"],"properties":{"instanceId":{"type":"string","description":"The instance ID"},"body":{"type":"object","description":"The request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-searchengine/modify-public-url-ip-list":{"post":{"operationId":"cloud_aliyun_searchengine_modify_public_url_ip_list","summary":"Modifies the public domain name whitelist","description":"PUT /openapi/ha3/instances/{instanceId}/public-url-ip-list","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["instanceId"],"properties":{"instanceId":{"type":"string","description":"The instance ID"},"body":{"type":"object","description":"The request body. Key: publicUrlAllow"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-searchengine/modify-searcher-replica":{"post":{"operationId":"cloud_aliyun_searchengine_modify_searcher_replica","summary":"Modifies the number of replicas or shards for data nodes in an instance","description":"PUT /openapi/ha3/instances/{instanceId}/replica","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["instanceId"],"properties":{"instanceId":{"type":"string","description":"The instance ID"},"partition":{"type":"integer","description":"The number of shards for a data node"},"replica":{"type":"integer","description":"The number of replicas for a data node"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-searchengine/modify-table":{"post":{"operationId":"cloud_aliyun_searchengine_modify_table","summary":"Modifies an index table","description":"PUT /openapi/ha3/instances/{instanceId}/tables/{tableName}","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["instanceId","tableName"],"properties":{"instanceId":{"type":"string","description":"The instance ID"},"tableName":{"type":"string","description":"The name of the index table"},"dryRun":{"type":"string","description":"Specifies whether to perform a dry run (only validates whether the data source is valid). Valid values: true: performs a dry run. false:…"},"dataProcessConfig":{"type":"array","description":"The field processing configuration"},"dataSource":{"type":"object","description":"The datasource config"},"fieldSchema":{"type":"object","description":"The field map collection"},"partitionCount":{"type":"integer","description":"The number of data shards"},"primaryKey":{"type":"string","description":"The primary key field"},"rawSchema":{"type":"string","description":"If rawSchema is provided, it is used directly as the HA3 schema structure without manual assembly"},"vectorIndex":{"type":"array","description":"The index structure"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-searchengine/publish-advance-config":{"post":{"operationId":"cloud_aliyun_searchengine_publish_advance_config","summary":"Publishes an advanced version","description":"POST /openapi/ha3/instances/{instanceId}/advanced-configs/{configName}/actions/publish","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["instanceId","configName"],"properties":{"instanceId":{"type":"string","description":"The instance ID"},"configName":{"type":"string","description":"The configuration name"},"desc":{"type":"string","description":"The description of the advanced configuration"},"files":{"type":"array","description":"The file information"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-searchengine/publish-index-version":{"post":{"operationId":"cloud_aliyun_searchengine_publish_index_version","summary":"Publishes a specified index version","description":"POST /openapi/ha3/instances/{instanceId}/indexes/{indexName}/actions/publish","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["instanceId","indexName"],"properties":{"instanceId":{"type":"string","description":"The instance ID"},"indexName":{"type":"string","description":"The index name"},"body":{"type":"object","description":"The request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-searchengine/push-documents":{"post":{"operationId":"cloud_aliyun_searchengine_push_documents","summary":"Pushes documents","description":"POST /openapi/ha3/instances/{instanceId}/data-sources/{dataSourceName}/actions/bulk","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["instanceId","dataSourceName"],"properties":{"instanceId":{"type":"string","description":"The instance ID"},"dataSourceName":{"type":"string","description":"The name of the data source"},"body":{"type":"array","description":"The request body parameters"},"pkField":{"type":"string","description":"The primary key field"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-searchengine/recover-index":{"post":{"operationId":"cloud_aliyun_searchengine_recover_index","summary":"Recovers data from an index","description":"POST /openapi/ha3/instances/{instanceId}/recover-index","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["instanceId"],"properties":{"instanceId":{"type":"string","description":"The instance ID"},"bucket":{"type":"string","description":"Required when exporting data to OSS. The name of the destination OSS bucket"},"buildDeployId":{"type":"integer","description":"The ID of the offline deployment for the data source. You can obtain this ID by calling the GetIndexVersion…"},"dataSourceName":{"type":"string","description":"The name of the data source"},"generation":{"type":"string","description":"The full version of the index"},"indexName":{"type":"string","description":"The name of the index"},"odpsAccessId":{"type":"string","description":"Required when exporting data to MaxCompute. The AccessKey ID used to access MaxCompute"},"odpsAccessKey":{"type":"string","description":"Required when exporting data to MaxCompute. The AccessKey secret used to access MaxCompute"},"odpsPartition":{"type":"string","description":"Optional when exporting data to MaxCompute. The destination MaxCompute partition"},"odpsProject":{"type":"string","description":"Required when exporting data to MaxCompute. The name of the destination MaxCompute project"},"odpsTable":{"type":"string","description":"Required when exporting data to MaxCompute. The name of the destination MaxCompute table"},"outPutType":{"type":"string","description":"The export type. Valid values: default (exports data to the internal HDFS for index rebuilding), oss, and odps"},"path":{"type":"string","description":"Required when exporting data to OSS. The destination path. The path must start with a forward slash (/) and contain opensearch. If the…"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-searchengine/reindex":{"post":{"operationId":"cloud_aliyun_searchengine_reindex","summary":"Rebuilds an index","description":"POST /openapi/ha3/instances/{instanceId}/tables/{tableName}/reindex","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["instanceId","tableName"],"properties":{"instanceId":{"type":"string","description":"The instance ID"},"tableName":{"type":"string","description":"The name of the index table"},"dataTimeSec":{"type":"integer","description":"The timestamp in seconds. This parameter is of the INT type. This parameter is required when the data source uses API push"},"ossDataPath":{"type":"string","description":"The OSS file path"},"partition":{"type":"string","description":"The partition. This parameter is required when the data source is ODPS"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-searchengine/remove-cluster":{"post":{"operationId":"cloud_aliyun_searchengine_remove_cluster","summary":"Deletes a cluster","description":"DELETE /openapi/ha3/instances/{instanceId}/clusters/{clusterName}","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["instanceId","clusterName"],"properties":{"instanceId":{"type":"string","description":"The instance ID"},"clusterName":{"type":"string","description":"The name of the cluster"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-searchengine/rename-folder":{"post":{"operationId":"cloud_aliyun_searchengine_rename_folder","summary":"Renames a folder","description":"PUT /openapi/ha3/instances/{instanceId}/sql-studio/databases/{database}/folders/{folderId}/name","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["instanceId","database","folderId","name"],"properties":{"instanceId":{"type":"string","description":"The instance ID"},"database":{"type":"string","description":"The database name"},"folderId":{"type":"string","description":"The folder ID"},"name":{"type":"string","description":"The folder name"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-searchengine/start-index":{"post":{"operationId":"cloud_aliyun_searchengine_start_index","summary":"Resumes an index","description":"POST /openapi/ha3/instances/{instanceId}/indexes/{indexName}/startIndex","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["instanceId","indexName"],"properties":{"instanceId":{"type":"string","description":"The instance ID"},"indexName":{"type":"string","description":"The index name"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-searchengine/stop-index":{"post":{"operationId":"cloud_aliyun_searchengine_stop_index","summary":"Stops an index","description":"POST /openapi/ha3/instances/{instanceId}/indexes/{indexName}/stopIndex","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["instanceId","indexName"],"properties":{"instanceId":{"type":"string","description":"The instance ID"},"indexName":{"type":"string","description":"The index name"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-searchengine/stop-task":{"post":{"operationId":"cloud_aliyun_searchengine_stop_task","summary":"Stops an FSM task","description":"PUT /openapi/ha3/instances/{instanceId}/stop-task/{fsmId}","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["instanceId","fsmId"],"properties":{"instanceId":{"type":"string","description":"The instance ID"},"fsmId":{"type":"string","description":"The ID of the finite state machine (FSM)"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-searchengine/tag-resources":{"post":{"operationId":"cloud_aliyun_searchengine_tag_resources","summary":"Adds or updates tags for multiple resources","description":"POST /openapi/ha3/resource-tags","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["resourceId","resourceType","tag"],"properties":{"resourceId":{"type":"array","description":"The IDs of the resources. You can specify up to 50 IDs"},"resourceType":{"type":"string","description":"The resource type"},"tag":{"type":"array","description":"The tags to add. You can specify a maximum of 20 tags"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-searchengine/untag-resources":{"post":{"operationId":"cloud_aliyun_searchengine_untag_resources","summary":"Removes tags from a batch of resources","description":"DELETE /openapi/ha3/resource-tags","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["resourceType","resourceId"],"properties":{"resourceType":{"type":"string","description":"The resource type"},"resourceId":{"type":"string","description":"The IDs of the resources. You can specify up to 50 resource IDs (JSON-encoded)"},"tagKey":{"type":"string","description":"The list of tag keys. You can include up to 20 tag keys (JSON-encoded)"},"all":{"type":"string","description":"Specifies whether to remove all tags. This parameter takes effect only when tags are empty. Valid values: `true` and `false`. Default…"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-searchengine/update-instance":{"post":{"operationId":"cloud_aliyun_searchengine_update_instance","summary":"Modifies the configuration of a specified instance","description":"PUT /openapi/ha3/instances/{instanceId}","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["instanceId"],"properties":{"instanceId":{"type":"string","description":"The instance ID"},"components":{"type":"array","description":"The list of instance specifications. You cannot update this parameter together with description"},"description":{"type":"string","description":"The instance description. You cannot update this parameter together with components or orderType"},"orderType":{"type":"string","description":"Valid values: UPGRAGE: Upgrades the instance specifications. DOWNGRADE: Downgrades the instance specifications. You cannot specify this…"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-searchengine/update-sql-instance-content":{"post":{"operationId":"cloud_aliyun_searchengine_update_sql_instance_content","summary":"Updates the content of an SQL instance","description":"PUT /openapi/ha3/instances/{instanceId}/sql-studio/databases/{database}/sql-instances/{sqlInstanceId}/content","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["instanceId","database","sqlInstanceId","content"],"properties":{"instanceId":{"type":"string","description":"The ID of the instance"},"database":{"type":"string","description":"The name of the database"},"sqlInstanceId":{"type":"string","description":"The ID of the SQL instance"},"content":{"type":"string","description":"The SQL content"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-searchengine/update-sql-instance-name":{"post":{"operationId":"cloud_aliyun_searchengine_update_sql_instance_name","summary":"Updates the name of an SQL instance","description":"PUT /openapi/ha3/instances/{instanceId}/sql-studio/databases/{database}/sql-instances/{sqlInstanceId}/name","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["instanceId","database","sqlInstanceId","name"],"properties":{"instanceId":{"type":"string","description":"The instance ID"},"database":{"type":"string","description":"The database name"},"sqlInstanceId":{"type":"string","description":"The SQL instance ID"},"name":{"type":"string","description":"The name of the SQL instance"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-searchengine/update-sql-instance-params":{"post":{"operationId":"cloud_aliyun_searchengine_update_sql_instance_params","summary":"Updates the parameters of an SQL instance","description":"PUT /openapi/ha3/instances/{instanceId}/sql-studio/databases/{database}/sql-instances/{sqlInstanceId}/params","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["instanceId","database","sqlInstanceId"],"properties":{"instanceId":{"type":"string","description":"The instance ID"},"database":{"type":"string","description":"The database name"},"sqlInstanceId":{"type":"string","description":"The SQL instance ID"},"combineParam":{"type":"object","description":"The combined parameters"},"dynamicParam":{"type":"object","description":"The dynamic parameters"},"kvpair":{"type":"object","description":"The key-value (KV) configuration of the instance"},"params":{"type":"object","description":"The parameters to modify"},"staticParam":{"type":"object","description":"The static parameters"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-searchengine/version":{"post":{"operationId":"cloud_aliyun_searchengine_version","summary":"version","description":"POST /","tags":["cloud"],"parameters":[],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}}},"components":{"securitySchemes":{"ApiKeyAuth":{"type":"apiKey","in":"header","name":"x-api-key"}},"schemas":{"RunEnvelope":{"type":"object","required":["project","data","timestamp"],"properties":{"project":{"type":"string","example":"dev-tools:hash"},"data":{},"timestamp":{"type":"string","format":"date-time"}}},"ErrorEnvelope":{"type":"object","properties":{"content":{},"message":{"type":"string"},"errors":{"type":"array","items":{}},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"}}}}}},"responses":{"Error":{"description":"Invalid key, plan gate, rate limit or upstream failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}}}}}