ListTableColumns - - Centre de documentation Alibaba Cloud

Consulte les détails des champs d'une table.

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.

dms:ListTableColumns

get

*All Resource

*

Aucune

Paramètres de requête

Paramètre	Type	Requis	Description	Exemple
Tid	integer	Non	L'identifiant du locataire. Vous pouvez appeler l'opération GetUserActiveTenant ou ListUserTenants pour obtenir l'identifiant du locataire.	3***
DbId	integer	Oui	L'identifiant d'une base de données physique : vous pouvez appeler l'opération ListDatabases ou SearchDatabase pour obtenir l'identifiant de la base de données physique.	123
TableName	string	Oui	Le nom de la table. Remarque Vous pouvez également appeler l'opération ListTables pour rechercher le nom de la table.	100g_customer
TableSchemaName	string	Non	Le nom du schéma de la table, qui n'est requis que pour les instances SQL Server.	dbo

Éléments de réponse

Élément	Type	Description	Exemple
	object
RequestId	string	L'identifiant de la requête.	0C1CB646-1DE4-4AD0-B4A4-7D47DD52E931
ErrorCode	string	Le code d'erreur renvoyé si la requête a échoué.	UnknownError
ColumnList	object
Column	array<object>	Les détails des champs de la table.
	object
ColumnId	string	The ID of the field.	12345
ColumnType	string	The data type of the field.	varchar
Description	string	The description of the field.	column desc
AutoIncrement	boolean	Indicates whether the field is an auto-increment field. Valid values: true: The field is an auto-increment field. false: The field is not an auto-increment field.	false
FunctionType	string	The type of the masking algorithm that is used for the field. Valid values: null: No masking algorithm is used. DEFAULT: A full masking algorithm is used. FIX_POS: The fixed position is masked. FIX_CHAR: The fixed characters are replaced.	NULL
DataPrecision	integer	The number of valid digits for the column.	0
DefaultValue	string	The default value of the column.	aaa
ColumnName	string	The field name.	c1
SecurityLevel	string	The security level of the field. Valid values: INNER: The field is an internal field but not sensitive. SENSITIVE: The field is sensitive. CONFIDENTIAL: The field is a confidential column.	INNER
DataScale	integer	The number of decimal places of the field data.	0
DataLength	integer	The length of the field.	32
Sensitive	boolean	Indicates whether the field is a sensitive column. Valid values: true: The field is a sensitive field. false: The field is not a sensitive field.	false
Nullable	boolean	Indicates whether the field can be empty. Valid values: true: The field can be empty. false: The field cannot be empty.	true
ErrorMessage	string	Le message d'erreur renvoyé si la requête a échoué.	UnknownError
Success	boolean	Indique si la requête a réussi. Valeurs valides : true : la requête a réussi. false : la requête a échoué.	true

Exemples

JSON format

{
  "RequestId": "0C1CB646-1DE4-4AD0-B4A4-7D47DD52E931",
  "ErrorCode": "UnknownError",
  "ColumnList": {
    "Column": [
      {
        "ColumnId": "12345",
        "ColumnType": "varchar",
        "Description": "column desc",
        "AutoIncrement": false,
        "FunctionType": "NULL",
        "DataPrecision": 0,
        "DefaultValue": "aaa",
        "ColumnName": "c1",
        "SecurityLevel": "INNER",
        "DataScale": 0,
        "DataLength": 32,
        "Sensitive": false,
        "Nullable": true
      }
    ]
  },
  "ErrorMessage": "UnknownError",
  "Success": true
}

Codes d'erreur

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

Notes de version

Consultez Notes de version pour la liste complète.