DescribeApp - - Centre de documentation Alibaba Cloud

Consulte les détails d'une version spécifique d'une application OpenSearch.

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.

opensearch:DescribeApp

get

*App

acs:opensearch:{#regionId}:{#accountId}:app-groups/{#AppGroupId}

Aucune

Syntaxe de la requête

GET /v4/openapi/app-groups/{appGroupIdentity}/apps/{appId} HTTP/1.1

Paramètres de chemin

Paramètre	Type	Requis	Description	Exemple
appGroupIdentity	string	Oui	Le nom de l'application.	my_app_group_name
appId	integer	Oui	L'identifiant de la version.	110116134

Paramètres de requête

Paramètre

Type

Requis

Description

Exemple

Éléments de réponse

Élément	Type	Description	Exemple
	object	Le corps de la réponse.	{}
requestId	string	L'identifiant de la requête.	33477D76-C380-1D84-A4AD-043F52876CB1
result	object	Les informations de version.	{}
id	string	L'identifiant de la version.	100303063
isCurrent	boolean	Indique s'il s'agit de la version en ligne.	True
clusterName	string	Le nom du cluster.	-
autoSwitch	boolean	Indique si le basculement automatique est activé.	true
type	string	Le type de version. Valeurs valides : standard : Édition standard. advance : Édition avancée héritée. Ce type n'est pas pris en charge pour les nouvelles applications. enhanced : Nouvelle édition avancée.	enhanced
status	string	L'état de la version. Valeurs valides : ok : Normal. stopped : Arrêté. frozen : Gelé. initializing : La version est en cours d'initialisation. unavailable : La version n'est pas valide. data_waiting : En attente de l'initialisation des données. data_preparing : Les données sont en cours d'initialisation.	ok
realtimeShared	boolean
schema	object	Le schéma de l'application.	{}
tables	object	Le schéma de la table.	{ "primaryTable": true, "name": "main", "fields": { "id": { "name": "id", "type": "LITERAL", "primaryKey": true }, "title": { "name": "title", "type": "TEXT", "primaryKey": false }, "buy": { "name": "buy", "type": "INT", "primaryKey": false }, "cate_id": { "name": "cate_id", "type": "INT", "primaryKey": false }, "cate_name": { "name": "cate_name", "type": "LITERAL", "primaryKey": false } } }
indexes	object	Le schéma de l'index.
filterFields	array	La collection des champs d'attribut.
	string	Le champ d'attribut.	id
searchFields	object	Les champs d'index.	{ "fields": ["title"], "analyzer": "chn_standard" }
routeField	string	Le nom du champ de routage principal.	field1
routeFieldValues	array	Les valeurs chaudes du champ de routage principal.
	string	Les valeurs chaudes du champ de routage principal.	routeFieldValues
secondRouteField	string	Le nom du champ de routage secondaire. Ce paramètre prend effet uniquement lorsque routeFieldValues est configuré. Par défaut, la clé primaire de la table large est utilisée.	field2
ttlField	object	La configuration du nettoyage des documents.
name	string	Le champ de nettoyage des documents.	text1
ttl	integer	La durée de vie (en millisecondes).	1000
indexSortConfig	array<object>	La configuration de l'index inversé.
	object	La configuration de l'index inversé.
field	string	Le champ de tri.	field1
direction	string	L'ordre de tri. Valeurs valides : ASC DESC	DESC
name	string	Le nom de la table large.	test
fetchFields	array	Les champs d'affichage par défaut.	[]
	string	Les champs d'affichage par défaut.	{}
quota	object	Les informations de quota.	{}
spec	string	La spécification. Valeurs valides : opensearch.share.junior : Niveau d'entrée. opensearch.share.common : Usage général partagé. opensearch.share.compute : Optimisé pour le calcul partagé. opensearch.share.storage : Optimisé pour le stockage partagé. opensearch.private.common : Usage général dédié. opensearch.private.compute : Optimisé pour le calcul dédié. opensearch.private.storage : Optimisé pour le stockage dédié.	opensearch.share.common
qps	integer	Les requêtes de recherche par seconde (utilisé dans l'ancien modèle de facturation).	5
docSize	integer	La capacité de stockage (unité : Go).	1
computeResource	integer	La ressource de calcul (unité : LCU).	20
domain	object	Le type d'industrie. Valeurs valides : GENERAL : Usage général. ECOMMERCE : E-commerce. IT_CONTENT : Contenu informatique.	GENERAL
category	string	Le type. Valeurs valides : standard : Édition standard. advance : Édition avancée héritée. Ce type n'est pas pris en charge pour les nouvelles applications. enhanced : Nouvelle édition avancée.	-
name	string	Le nom en anglais.	test
functions	object	Les résultats de recherche.	{}
service	array	La description de chaque fonction.	[]
	string	La fonction 1.	-
qp	array	Les informations de mise en page.	[]
	string	L'information 1.	-
algo	array	La structure de l'algorithme.	[]
	string	La structure 1.	-
schemas	array<object>	Le schéma de l'application multi-table.
	array<object>	Le schéma de l'application mono-table.
tables	object	Le schéma de la table.	{ "primaryTable": true, "name": "main", "fields": { "id": { "name": "id", "type": "LITERAL", "primaryKey": true }, "title": { "name": "title", "type": "TEXT", "primaryKey": false }, "buy": { "name": "buy", "type": "INT", "primaryKey": false }, "cate_id": { "name": "cate_id", "type": "INT", "primaryKey": false }, "cate_name": { "name": "cate_name", "type": "LITERAL", "primaryKey": false } } }
indexes	object	Le schéma de l'index.
filterFields	array	La collection des champs d'attribut.
	string	Le champ d'attribut.	field1
searchFields	object	Les champs d'index.	{ "fields": ["title"], "analyzer": "chn_standard" }
routeField	string	Le nom du champ de routage principal.	field1
routeFieldValues	array	Les valeurs chaudes du champ de routage principal.
	string	Les valeurs chaudes du champ de routage principal.	routeFieldValues
secondRouteField	string	Le nom du champ de routage secondaire. Ce paramètre prend effet uniquement lorsque routeFieldValues est configuré. Par défaut, la clé primaire de la table large est utilisée.	field2
ttlField	object	La configuration du nettoyage des documents.
name	string	Le champ de temps du document.	fIeld1
ttl	integer	La durée de vie (en millisecondes).	1000
indexSortConfig	array<object>	La configuration de l'index inversé.
	object	La configuration de l'index inversé.
field	string	Le champ de tri.	fIeld1
direction	string	L'ordre de tri. Valeurs valides : ASC DESC	DESC
name	string	Le nom de la table large.	main
firstRanks	array<object>	La configuration du tri grossier.
	object	La configuration du tri grossier.
type	string	Le type d'expression. Valeurs valides : STRUCT : Expression structurée. Valeur par défaut. STRING : Formule personnalisée.	STRING
name	string	Le nom du tri grossier.	test
description	string	La description.	Description
active	boolean	Indique s'il s'agit de l'expression par défaut.	False
meta	any	Les informations de l'expression (Array ou String).	String :"random()*100+now()"； Array: [ { "attribute": "static_bm25()", "arg": "", "weight": 10 } ]
created	integer
updated	integer
secondRanks	array<object>	La configuration du tri fin.
	object	La configuration du tri fin.
meta	any	L'expression du tri fin. Vous pouvez écrire des expressions contenant des champs, des fonctionnalités de scoring et des fonctions mathématiques pour implémenter une logique de tri complexe.	"cate_id > 0 and cate_id < 1000"
name	string	Le nom du tri fin.	default
description	string	La description.	Description.
active	boolean	Indique s'il s'agit de l'expression par défaut.	False
isDefault	boolean
created	integer
updated	integer
dataSources	array<object>	La configuration de la source de données.
	array<object>	La configuration de la source de données.
tableName	string	Le nom de la table d'application.	main
type	string	Le type de source de données. Valeurs valides : rds odps opensearch polardb	rds
fields	array<object>	Les informations de mappage des champs de la table.
	object	Les informations de mappage des champs de la table.	{ "id": "id" }
plugins	object	Les plugins de traitement des données de champ. Nom du plugin (name) : JsonKeyValueExtractor MultiValueSpliter KeyValueExtractor StringCatenateExtractor HTMLTagRemover Paramètres du plugin (parameters) : JsonKeyValueExtractor MultiValueSpliter KeyValueExtractor StringCatenateExtractor HTMLTagRemover	{ "name": "JsonKeyValueExtractor", "parameters": { "key": "my_field" } }
keyField	string	La clé primaire.	id
schemaName	string	Le nom de la table large.	name
parameters	object	Les informations de la source de données.	{ "instanceId": "rds-instance-id", "dbName": "my_db", "dbTableName": "my_table", "dbUser": "my", "dbPassword": "my_passwd", "filter":"", "autoSync": true }
summaries	array<object>	La configuration du résumé des résultats de recherche.
	array<object>	La configuration du résumé des résultats de recherche.
name	string	Le nom du groupe.	default
meta	array<object>	La configuration du résumé.
	object	La configuration du résumé.
field	string	Le champ.	field1
len	integer	La longueur de l'extrait. Valeurs valides : 1 à 300.	50
element	string	La balise HTML pour la mise en surbrillance.	em
ellipsis	string	Le connecteur d'extraits.	...
snippet	string	Le nombre d'extraits. Valeurs valides : 1 à 5.	5
queryProcessors	array<object>	La configuration de la reconnaissance d'intention.
	array<object>	La configuration de la reconnaissance d'intention.
name	string	Le nom de la règle.	test
domain	string	Le type d'industrie. Valeurs valides : GENERAL : Usage général. ECOMMERCE : E-commerce. IT_CONTENT : Contenu informatique.	GENERAL
category	string	Le secteur d'activité.	""
processors	array<object>	Les fonctions incluses.
	object	Les fonctions incluses.	{ "name": "stop_word", "useSystemDictionary": true, "interventionDictionary": "my_dict", "ignoreSpace": true }
indexes	array	La portée de l'index de l'application.
	string	L'index de l'application.	default
active	boolean	Indique s'il s'agit de la règle par défaut.	False
interpretations	array<object>	Le modèle de champ LLM.	[ { "table": "table1", "fields": [ { "name": "field1", "interpretation": " title" }, { "name": "field2", "interpretation": " ID" } ] } ]
	object
prompts	array<object>	La configuration des prompts LLM.	{ "parameters" : [ { "name" : "docs", "value" : "The concatenation method for doc content. For example, the current qwen format: ' \n${doc}\n \n" } ], "messages":[ { "role" : "role_name. Whether this should be limited to system, user, or assistant, or allow custom values", "content" : "User-defined prompt content. Use ${parameter_key} to indicate dynamically replaced content. See the rules below for details" } ] }
	object	La configuration du prompt.	{ "parameters" : [ { "name" : "docs", "value" : "The concatenation method for doc content, for example, the current Qwen format: ' \n${doc}\n \n" } ], "messages":[ { "role" : "role_name. Specifies whether this value must be system, user, or assistant, or whether users can enter any value.", "content" : "The prompt content set by the user. You can use ${parameter_key} to represent content that you want to dynamically replace. For specific replacement rules, refer to the following description." } ] }
created	integer
virtualCluster	string
description	string	La description de la version.	-
switchTime	integer
cluster	object	La configuration de l'exposition des capacités.
maxTimeoutMS	integer	Le délai d'expiration du cluster, en millisecondes.	750
maxQueryClauseLength	integer	La longueur maximale d'une clause de requête.	1024
chunkModels	array<object>
	object
imageContentRecognizerModels	array<object>
	object
textEmbeddingModel	string
textSparseEmbeddingModel	string
vectorIndexConfigs	array<object>
	object
configItems	array<object>
	object
progressPercent	integer	Le pourcentage de progression de l'importation des données. Par exemple, 83 indique 83 %.	100

Exemples

JSON format

{
  "requestId": "33477D76-C380-1D84-A4AD-043F52876CB1",
  "result": {
    "id": "100303063",
    "isCurrent": true,
    "clusterName": "-",
    "autoSwitch": true,
    "type": "enhanced",
    "status": "ok",
    "realtimeShared": false,
    "schema": {
      "tables": {
        "test": "test",
        "test2": 1
      },
      "indexes": {
        "filterFields": [
          "id"
        ],
        "searchFields": {
          "test": "test",
          "test2": 1
        }
      },
      "routeField": "field1",
      "routeFieldValues": [
        "routeFieldValues"
      ],
      "secondRouteField": "field2",
      "ttlField": {
        "name": "text1",
        "ttl": 1000
      },
      "indexSortConfig": [
        {
          "field": "field1",
          "direction": "DESC"
        }
      ],
      "name": "test"
    },
    "fetchFields": [
      "{}"
    ],
    "quota": {
      "spec": "opensearch.share.common",
      "qps": 5,
      "docSize": 1,
      "computeResource": 20
    },
    "domain": {
      "category": "-",
      "name": "test",
      "functions": {
        "service": [
          "-"
        ],
        "qp": [
          "-"
        ],
        "algo": [
          "-"
        ]
      }
    },
    "schemas": [
      {
        "tables": {
          "test": "test",
          "test2": 1
        },
        "indexes": {
          "filterFields": [
            "field1"
          ],
          "searchFields": {
            "test": "test",
            "test2": 1
          }
        },
        "routeField": "field1",
        "routeFieldValues": [
          "routeFieldValues"
        ],
        "secondRouteField": "field2",
        "ttlField": {
          "name": "fIeld1",
          "ttl": 1000
        },
        "indexSortConfig": [
          {
            "field": "fIeld1",
            "direction": "DESC"
          }
        ],
        "name": "main"
      }
    ],
    "firstRanks": [
      {
        "type": "STRING",
        "name": "test",
        "description": "Description",
        "active": true,
        "meta": "String :\"random()*100+now()\"；",
        "created": 0,
        "updated": 0
      }
    ],
    "secondRanks": [
      {
        "meta": "\"cate_id > 0 and cate_id < 1000\"",
        "name": "default",
        "description": "Description",
        "active": true,
        "isDefault": false,
        "created": 0,
        "updated": 0
      }
    ],
    "dataSources": [
      {
        "tableName": "main",
        "type": "rds",
        "fields": [
          {
            "id": "id"
          }
        ],
        "plugins": {
          "test": "test",
          "test2": 1
        },
        "keyField": "id",
        "schemaName": "name",
        "parameters": {
          "test": "test",
          "test2": 1
        }
      }
    ],
    "summaries": [
      {
        "name": "default",
        "meta": [
          {
            "field": "field1",
            "len": 50,
            "element": "em",
            "ellipsis": "...",
            "snippet": "5"
          }
        ]
      }
    ],
    "queryProcessors": [
      {
        "name": "test",
        "domain": "GENERAL",
        "category": "\"\"",
        "processors": [
          {
            "test": "test",
            "test2": 1
          }
        ],
        "indexes": [
          "default"
        ],
        "active": true
      }
    ],
    "interpretations": [
      {
        "test": "test",
        "test2": 1
      }
    ],
    "prompts": [
      {
        "test": "test",
        "test2": 1
      }
    ],
    "created": 0,
    "virtualCluster": "",
    "description": "-",
    "switchTime": 0,
    "cluster": {
      "maxTimeoutMS": 750,
      "maxQueryClauseLength": 1024,
      "chunkModels": [
        {
          "test": "test",
          "test2": 1
        }
      ],
      "imageContentRecognizerModels": [
        {
          "test": "test",
          "test2": 1
        }
      ],
      "textEmbeddingModel": "",
      "textSparseEmbeddingModel": "",
      "vectorIndexConfigs": [
        {
          "test": "test",
          "test2": 1
        }
      ]
    },
    "configItems": [
      {
        "test": "test",
        "test2": 1
      }
    ],
    "progressPercent": 100
  }
}

Codes d'erreur

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

Notes de version

Consultez Notes de version pour la liste complète.