ModifyTable - - Centre de documentation Alibaba Cloud

Modifie une table d'index.

Description de l'opération

Méthode

PUT

URI

/openapi/ha3/instances/{instanceId}/tables/{tableName}

Testez maintenant

Testez cette API dans OpenAPI Explorer, sans signature manuelle. Les appels réussis génèrent automatiquement du code SDK correspondant à vos paramètres. Téléchargez-le avec une sécurité intégrée des identifiants pour une utilisation locale. Testez cette API dans OpenAPI Explorer, sans signature manuelle. Les appels réussis génèrent automatiquement du code SDK correspondant à vos paramètres. Téléchargez-le avec une sécurité intégrée des identifiants pour une utilisation locale.

Test

Autorisation RAM

Le tableau ci-dessous décrit les autorisations nécessaires pour appeler cette API. Vous pouvez les définir dans une politique Resource Access Management (RAM). Les colonnes du tableau sont détaillées ci-dessous :

Action : les actions peuvent être utilisées dans l'élément Action des instructions de politique de permissions RAM pour accorder les autorisations nécessaires à l'exécution de l'opération.
API : l'API que vous pouvez appeler pour exécuter l'action.
Niveau d'accès : le niveau d'accès prédéfini accordé pour chaque API. Valeurs valides : create, list, get, update et delete.
Type de ressource : le type de ressource qui prend en charge l'autorisation pour exécuter l'action. Il indique si l'action prend en charge les permissions au niveau de la ressource. La ressource spécifiée doit être compatible avec l'action. Sinon, la politique sera inefficace.
- Pour les API avec permissions au niveau de la ressource, les types de ressource requis sont marqués d'un astérisque (*). Spécifiez l'Alibaba Cloud Resource Name (ARN) correspondant dans l'élément Resource de la politique.
- Pour les API sans permissions au niveau de la ressource, la valeur All Resources est affichée. Utilisez un astérisque (*) dans l'élément Resource de la politique.
Clé de condition : les clés de condition définies par le service. La clé permet un contrôle granulaire, applicable aux actions seules ou aux actions associées à des ressources spécifiques. En plus des clés de condition propres au service, Alibaba Cloud fournit un ensemble de clés de condition communes applicables à tous les services pris en charge par RAM.
Action dépendante : les actions dépendantes requises pour exécuter l'action. Pour mener à bien l'opération, l'utilisateur RAM ou le rôle RAM doit disposer des permissions pour toutes les actions dépendantes.

searchengine:ModifyTable

update

*Instance.

acs:searchengine:{#regionId}:{#accountId}:instance/{#InstanceId}

Aucune

Syntaxe de la requête

PUT /openapi/ha3/instances/{instanceId}/tables/{tableName} HTTP/1.1

Paramètres de chemin

Paramètre	Type	Requis	Description	Exemple
instanceId	string	Oui	L'identifiant de l'instance.	ha-cn-pl32rf0****
tableName	string	Oui	Le nom de la table d'index.	index_hdfs

Paramètres de requête

Paramètre	Type	Requis	Description	Exemple
dryRun	boolean	Non	Indique si un test à blanc doit être effectué (valide uniquement si la source de données est valide). Valeurs valides : true : effectue un test à blanc. false : n'effectue pas de test à blanc.	true
body	object	Non	Les paramètres du corps de la requête.
partitionCount	integer	Non	Le nombre de partitions de données.	1
dataSource	object	Non	La configuration de la source de données.
dataTimeSec	integer	Non	L'horodatage pour le suivi des données incrémentielles.	1715160176
autoBuildIndex	boolean	Non	Indique si la reconstruction automatique de l'index est activée.	true
config	object	Non	La configuration de la source de données.
endpoint	string	Non	Le point de terminaison d'accès.	http://service.cn-hangzhou.maxcompute.aliyun-inc.com/api
accessKey	string	Non	L'identifiant AccessKey de la source de données ODPS.	L***p
accessSecret	string	Non	La clé secrète AccessKey de la source de données ODPS.	5**9a6
project	string	Non	Le nom du projet de la source de données ODPS.	test_project
partition	string	Non	Les informations de partition.	ds=20231220
table	string	Non	Le nom de la table de la source de données ODPS ou DLF.	behavior
ossPath	string	Non	Le chemin d'accès au fichier OSS.	/opensearch/test.txt
bucket	string	Non	Le compartiment OSS.	test_bucket
catalog	string	Non	Le nom du catalogue de la source de données DLF.	test_catalog
database	string	Non	La base de données de la source de données DLF.	opensearch_db
tag	string	Non	La balise de la source de données DLF.	test
tableFormat	string	Non	Le format de table de la source de données DLF.	paimon lance object
path	string	Non	Le chemin d'accès relatif.	/test
format	string	Non	Le type de format de fichier.	ha3 json
rawSchema	string	Non	Si rawSchema est fourni, il est utilisé directement comme structure de schéma HA3 sans assemblage manuel.	{}
primaryKey	string	Non	Le champ de clé primaire.	id
fieldSchema	object	Non	La collection de mappages de champs.
	string	Non	clé : nom du champ. valeur : type de champ.	{ "id": "INT64", "source_image": "STRING", "namespace": "INT64", "source_image_vector": "MULTI_FLOAT" }
vectorIndex	array<object>	Non	La structure d'index.
	array<object>	Non	Les détails de la structure d'index.
indexName	string	Non	Le nom de la structure d'index.	test_index
vectorField	string	Non	Le champ vectoriel.	source_image_vector
sparseIndexField	string	Non	Le champ d'index de vecteur creux.	sparse_indices
sparseValueField	string	Non	Le champ de valeur de vecteur creux.	sparse_values
dimension	string	Non	Les dimensions du vecteur.	128
vectorIndexType	string	Non	L'algorithme d'index vectoriel.	Qc
distanceType	string	Non	Le type de distance.	SquaredEuclidean
namespace	string	Non	Le champ d'espace de noms.	namespace
advanceParams	object	Non	La configuration de la structure d'index.
buildIndexParams	string	Non	Les paramètres de construction d'index.	{}
searchIndexParams	string	Non	Les paramètres de recherche d'index.	{}
minScanDocCnt	string	Non	Le nombre minimum de documents candidats pour le rappel.	20000
linearBuildThreshold	string	Non	Le seuil pour la construction linéaire.	5000
dataProcessConfig	array<object>	Non	La configuration du traitement des champs.
	array<object>	Non	Les détails de la configuration du traitement des champs.
operator	string	Non	La méthode de traitement du champ. Valeurs valides : copy : copie le champ source dans le champ de destination. vectorize : vectorise le champ source à l'aide d'un modèle et stocke le vecteur dans le champ de destination.	vectorize
dstField	string	Non	Le champ de destination.	source_image_vector
srcField	string	Non	Le champ source.	source_image
params	object	Non	Les informations de configuration du modèle.
vectorModel	string	Non	Le modèle de vectorisation.	clip
vectorModal	string	Non	Le type de données.	image
srcFieldConfig	object	Non	La source des informations de vectorisation.
ossEndpoint	string	Non	Le point de terminaison de la région OSS.	oss-cn-hangzhou-internal.aliyuncs.com
ossBucket	string	Non	Le nom du compartiment OSS.	test-bucket
uid	string	Non	L'identifiant du compte Alibaba Cloud.	1062017779051424

Exemple de requête

PUT /openapi/ha3/instances/{instanceId}/tables/{tableName}

Important Cet exemple ne répertorie que les paramètres les plus simples. Pour plus de paramètres personnalisés, consultez les paramètres de requête.

{
    "partitionCount": 1,
    "primaryKey": "id",
    "fieldSchema": {
        "id": "INT64",
        "source_image": "STRING",
        "namespace": "STRING",
        "source_image_vector": "MULTI_FLOAT"
    },
    "vectorIndex": [
        {
            "indexName": "test_index_1",
            "vectorField": "source_image_vector",
            "vectorIndexType": "HNSW",
            "dimension": "512",
            "distanceType": "InnerProduct"
        }
    ]
}

Pour plus d'informations, consultez Structure de la réponse.

Éléments de réponse

Élément	Type	Description	Exemple
	object
requestId	string	L'identifiant de la requête.	FE03180A-0E29-5474-8A86-33F0683294A4
result	object	Le résultat renvoyé.	{}

Exemples

JSON format

{
  "requestId": "FE03180A-0E29-5474-8A86-33F0683294A4",
  "result": {}
}

Codes d'erreur

Consultez Codes d'erreur pour la liste complète.

Notes de version

Consultez Notes de version pour la liste complète.