GetMetaTableColumn - - Centre de documentation Alibaba Cloud

Récupère les détails des champs d'une table.

Débogage

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

Paramètres de requête

Paramètre	Type	Obligatoire	Exemple	Description
Action	String	Oui	GetMetaTableColumn	Opération à effectuer. Définissez la valeur sur GetMetaTableColumn.
Tid	Long	Non	3***	ID du locataire. Appelez l'opération GetUserActiveTenant pour récupérer l'ID du locataire.
TableGuid	String	Oui	IDB_40753****.qntest2.activity_setting	Identifiant global unique (GUID) de la table dans Data Management (DMS). Si la base de données associée à la table est une base de données logique, appelez l'opération ListLogicTables pour obtenir la valeur de ce paramètre. Si la base de données associée à la table est une base de données physique, appelez l'opération ListTables pour obtenir la valeur de ce paramètre.
RegionId	String	Non	cn-hangzhou	Région où DMS est activé. Pour plus d'informations, consultez la rubrique Paramètre RegionID.

Paramètres de réponse

Paramètre	Type	Exemple	Description
RequestId	String	087DFBA1-378B-5D25-B13B-31F6409F****	ID de la requête.
ErrorCode	String	MissingTableGuid	Code d'erreur renvoyé.
ColumnList	Array of Column		Détails des champs de la table.
ColumnType	String	bigint(1)	Type de données du champ. Remarque Le type de données renvoyé n'est pas unique. Par exemple, il peut s'agir de bigint ou de int.
AutoIncrement	Boolean	false	Indique si le champ est en incrémentation automatique. Valeurs possibles : true : le champ est en incrémentation automatique. false : le champ n'est pas en incrémentation automatique.
ColumnId	String	63513****	ID du champ.
ColumnName	String	has_promotion	Nom du champ.
SecurityLevel	String	INNER	Niveau de sensibilité du champ. Valeurs possibles : INNER : le champ n'est pas sensible. SENSITIVE : le champ est sensible. CONFIDENTIAL : le champ est confidentiel. Remarque Pour plus d'informations, consultez la rubrique Niveaux de sensibilité des champs.
PrimaryKey	String	true	Indique si le champ est la clé primaire. Valeurs possibles : true : le champ est la clé primaire. false : le champ n'est pas la clé primaire.
Description	String	Whether discounts are provided.	Description du champ.
DataPrecision	Integer	19	Précision du champ.
DataScale	Integer	0	Nombre de décimales affichées par le champ.
Position	Integer	1	Position du champ dans la table.
Nullable	Boolean	false	Indique si le champ accepte les valeurs nulles. Valeurs possibles : true : le champ accepte les valeurs nulles. false : le champ n'accepte pas les valeurs nulles.
DataLength	Long	0	Longueur du champ.
ErrorMessage	String	TableGuid is mandatory for this action.	Message d'erreur renvoyé.
Success	Boolean	true	Indique si la requête a abouti. Valeurs possibles : true : la requête a abouti. false : la requête a échoué.

Exemples

Exemple de requête

http(s)://dms-enterprise.aliyuncs.com/?Action=GetMetaTableColumn
&TableGuid=IDB_40753****.qntest2.activity_setting
&Tid=3***
&Common request parameters

Exemple de réponse réussie

Format XML

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

<GetMetaTableColumnResponse>
    <RequestId>087DFBA1-378B-5D25-B13B-31F6409F****</RequestId>
    <ColumnList>
        <ColumnId>63513****</ColumnId>
        <ColumnName>has_promotion</ColumnName>
        <Description>Whether discounts are provided</Description>
        <ColumnType>bigint(1)</ColumnType>
        <Position>1</Position>
        <AutoIncrement>false</AutoIncrement>
        <SecurityLevel>INNER</SecurityLevel>
        <DataScale>0</DataScale>
        <DataPrecision>19</DataPrecision>
        <PrimaryKey>true</PrimaryKey>
        <Nullable>false</Nullable>
    </ColumnList>
    <ColumnList>
        <ColumnId>63513****</ColumnId>
        <ColumnName>consumption_limit</ColumnName>
        <Description>Consumption amount limit</Description>
        <ColumnType>int(11)</ColumnType>
        <Position>2</Position>
        <AutoIncrement>false</AutoIncrement>
        <SecurityLevel>INNER</SecurityLevel>
        <DataScale>0</DataScale>
        <DataPrecision>10</DataPrecision>
        <PrimaryKey>false</PrimaryKey>
        <Nullable>false</Nullable>
    </ColumnList>
    <ColumnList>
        <ColumnId>63513****</ColumnId>
        <ColumnName>quota</ColumnName>
        <Description>Coupon quota</Description>
        <ColumnType>int(11)</ColumnType>
        <Position>3</Position>
        <AutoIncrement>false</AutoIncrement>
        <SecurityLevel>INNER</SecurityLevel>
        <DataScale>0</DataScale>
        <DataPrecision>10</DataPrecision>
        <PrimaryKey>false</PrimaryKey>
        <Nullable>false</Nullable>
    </ColumnList>
    <Success>true</Success>
</GetMetaTableColumnResponse>

Format JSON

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

{
  "RequestId" : "087DFBA1-378B-5D25-B13B-31F6409F****",
  "ColumnList" : [ {
    "ColumnId" : "63513****",
    "ColumnName" : "has_promotion",
    "Description" : "Whether discounts are provided",
    "ColumnType" : "bigint(1)",
    "Position" : 1,
    "AutoIncrement" : false,
    "SecurityLevel" : "INNER",
    "DataScale" : 0,
    "DataPrecision" : 19,
    "PrimaryKey" : true,
    "Nullable" : false
  }, {
    "ColumnId" : "63513****",
    "ColumnName" : "consumption_limit",
    "Description" : "Consumption amount limit",
    "ColumnType" : "int(11)",
    "Position" : 2,
    "AutoIncrement" : false,
    "SecurityLevel" : "INNER",
    "DataScale" : 0,
    "DataPrecision" : 10,
    "PrimaryKey" : false,
    "Nullable" : false
  }, {
    "ColumnId" : "63513****",
    "ColumnName" : "quota",
    "Description" : "Coupon quota",
    "ColumnType" : "int(11)",
    "Position" : 3,
    "AutoIncrement" : false,
    "SecurityLevel" : "INNER",
    "DataScale" : 0,
    "DataPrecision" : 10,
    "PrimaryKey" : false,
    "Nullable" : false
  } ],
  "Success" : true
}

Codes d'erreur

Pour obtenir la liste des codes d'erreur, visitez le Centre d'erreurs de l'API.