ListColumns - - Centre de documentation Alibaba Cloud

Débogage

OpenAPI Explorer calcule automatiquement la valeur de signature. Nous vous recommandons d'appeler cette opération via OpenAPI Explorer, qui génère dynamiquement des exemples de code pour différents SDK.

Paramètres de requête

Parameter	Type	Required	Example	Description
Action	String	Yes	ListColumns	Opération à effectuer. Définissez la valeur sur ListColumns.
Tid	Long	Yes	3***	ID du locataire. Appelez l'opération GetUserActiveTenant pour obtenir cet ID.
TableId	String	Yes	39281****	ID de la table. Appelez l'opération ListTables pour obtenir cet ID.
Logic	Boolean	Yes	false	Indique si la base de données est logique. Valeurs valides : true : base de données logique. false : base de données physique.
RegionId	String	No	cn-hangzhou	ID de la région où Data Management (DMS) est activé. Pour plus d'informations, consultez le paramètre RegionID.

Paramètres de réponse

Parameter	Type	Example	Description
RequestId	String	0AD9AC55-5873-474A-9F33-4285806A3619	ID de la requête.
ErrorCode	String	UnknownError	Code d'erreur renvoyé.
ColumnList	Array of Column		Informations sur les colonnes renvoyées.
Column
ColumnType	String	varchar	Type de données du champ.
AutoIncrement	Boolean	false	Indique si le champ est en incrémentation automatique. Valeurs valides : true : le champ est en incrémentation automatique. false : le champ n'est pas en incrémentation automatique.
ColumnId	String	62589****	ID du champ.
DefaultValue	String	def_value	Valeur par défaut du champ.
Sensitive	Boolean	false	Indique si le champ est sensible. Valeurs valides : true : le champ est sensible. false : le champ n'est pas sensible.
ColumnName	String	name	Nom du champ.
SecurityLevel	String	INNER	Niveau de sécurité du champ. Valeurs valides : INNER : champ interne non sensible. SENSITIVE : champ sensible. CONFIDENTIAL : champ confidentiel. Remarque Pour plus d'informations, consultez Ajuster le niveau de sensibilité d'un ou plusieurs champs.
Description	String	test	Description du champ.
DataPrecision	Integer	0	Nombre de chiffres significatifs du champ.
DataScale	Integer	0	Nombre de décimales du champ.
FunctionType	String	DEFAULT	Type d'algorithme de masquage utilisé pour le champ. Valeurs valides : null : aucun algorithme de masquage. DEFAULT : masquage complet. FIX_POS : masquage de position fixe. FIX_CHAR : remplacement de caractères fixes.
Nullable	Boolean	false	Indique si le champ accepte les valeurs nulles. Valeurs valides : true : le champ accepte les valeurs nulles. false : le champ n'accepte pas les valeurs nulles.
DataLength	Long	4	Longueur du champ.
ErrorMessage	String	UnknownError	Message d'erreur renvoyé.
Success	Boolean	true	Indique si la requête a réussi. Valeurs valides : true : la requête a réussi. false : la requête a échoué.

Exemples

Exemple de requête

http(s)://dms-enterprise.aliyuncs.com/?Action=ListColumns
&Tid=3***
&TableId=39281****
&Logic=false
&<Common request parameters>

Exemples de réponses réussies

Format XML

HTTP/1.1 200 OK
Content-Type:application/xml

<ListColumnsResponse>
    <RequestId>0AD9AC55-5873-474A-9F33-4285806A3619</RequestId>
    <ColumnList>
        <ColumnId>62589****</ColumnId>
        <ColumnName>name</ColumnName>
        <Description/>
        <ColumnType>varchar(4)</ColumnType>
        <AutoIncrement>false</AutoIncrement>
        <SecurityLevel>INNER</SecurityLevel>
        <DataLength>4</DataLength>
        <Sensitive>false</Sensitive>
        <Nullable>false</Nullable>
    </ColumnList>
    <Success>true</Success>
</ListColumnsResponse>

Format JSON

HTTP/1.1 200 OK
Content-Type:application/json

{
  "RequestId" : "0AD9AC55-5873-474A-9F33-4285806A3619",
  "ColumnList" : [ {
    "ColumnId" : "62589****",
    "ColumnName" : "name",
    "Description" : "",
    "ColumnType" : "varchar(4)",
    "AutoIncrement" : false,
    "SecurityLevel" : "INNER",
    "DataLength" : 4,
    "Sensitive" : false,
    "Nullable" : false
  } ],
  "Success" : true
}

Codes d'erreur

Pour obtenir la liste des codes d'erreur, consultez le Centre d'erreurs API.