GetDatabaseSchema - - Centre de documentation Alibaba Cloud

Description de l'opération

Méthode

GET

URI

/openapi/ha3/instances/{instanceId}/sql-studio/databases/{database}/tables/{tableName}/schema

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:GetDatabaseSchema

get

*Instance

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

Aucune

Syntaxe de la requête

GET /openapi/ha3/instances/{instanceId}/sql-studio/databases/{database}/tables/{tableName}/schema HTTP/1.1

Paramètres de chemin

Paramètre	Type	Requis	Description	Exemple
instanceId	string	Oui	L'identifiant de l'instance.	ha-cn-pl32rf0****
database	string	Oui	Le nom de la base de données.	general
tableName	string	Oui	Le nom de la table.	graph_index_summary_

Paramètres de requête

Paramètre

Type

Requis

Description

Exemple

Éléments de réponse

Élément	Type	Description	Exemple
	object
requestId	string	L'identifiant de la requête.	022F36C7-9FB4-5D67-BEBC-3D14B0984463
result	array<object>	Le résultat.
	array<object>	Le résultat.
fieldName	string	Le nom du champ.	id
fieldType	string	Le type du champ.	STRING
indexName	string	Le nom de l'index.	test_tusou_v2
indexType	string	Le type de l'index.	NUMBER
fieldTypeDetail	object	Les détails du type de champ.	FT_UINT64

Exemples

JSON format

{
  "requestId": "022F36C7-9FB4-5D67-BEBC-3D14B0984463",
  "result": [
    {
      "fieldName": "id",
      "fieldType": "STRING",
      "indexName": "test_tusou_v2",
      "indexType": "NUMBER",
      "fieldTypeDetail": {
        "test": "test",
        "test2": 1
      }
    }
  ]
}

Codes d'erreur

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

Notes de version

Consultez Notes de version pour la liste complète.