GetMetaTableColumn - : Central de Documentação do Alibaba Cloud

Consulta os detalhes dos campos de uma tabela.

Depuração

O OpenAPI Explorer calcula automaticamente o valor da assinatura. Recomendamos chamar esta operação no OpenAPI Explorer para maior conveniência. A ferramenta também gera dinamicamente códigos de exemplo da operação para diferentes SDKs.

Parâmetros da solicitação

Parâmetro	Tipo	Obrigatório	Exemplo	Descrição
Action	String	Sim	GetMetaTableColumn	A operação a ser executada. Defina o valor como GetMetaTableColumn.
Tid	Long	Não	3***	O ID do locatário. Chame a operação GetUserActiveTenant para consultar esse ID.
TableGuid	String	Sim	IDB_40753****.qntest2.activity_setting	O identificador globalmente exclusivo (GUID) da tabela no Data Management (DMS). Se a tabela pertencer a um banco de dados lógico, chame a operação ListLogicTables para obter o valor deste parâmetro. Caso a tabela pertença a um banco de dados físico, utilize a operação ListTables para recuperar este valor.
RegionId	String	Não	cn-hangzhou	A região onde o DMS está ativado. Para mais informações, consulte Parâmetro RegionID.

Parâmetros de resposta

Parâmetro	Tipo	Exemplo	Descrição
RequestId	String	087DFBA1-378B-5D25-B13B-31F6409F****	O ID da solicitação.
ErrorCode	String	MissingTableGuid	O código de erro retornado.
ColumnList	Array of Column		Os detalhes dos campos da tabela.
ColumnType	String	bigint(1)	O tipo de dados do campo. Nota O tipo de dados retornado não é único. Por exemplo, pode ser bigint ou int.
AutoIncrement	Boolean	false	Indica se o campo é de incremento automático. Valores válidos: true: O campo é de incremento automático. false: O campo não é de incremento automático.
ColumnId	String	63513****	O ID do campo.
ColumnName	String	has_promotion	O nome do campo.
SecurityLevel	String	INNER	O nível de sensibilidade do campo. Valores válidos: INNER: O campo não é sensível. SENSITIVE: O campo é sensível. CONFIDENTIAL: O campo é confidencial. Nota Para mais informações, consulte Níveis de sensibilidade de campos.
PrimaryKey	String	true	Especifica se o campo é a chave primária. Valores válidos: true: O campo é a chave primária. false: O campo não é a chave primária.
Description	String	Whether discounts are provided.	A descrição do campo.
DataPrecision	Integer	19	A precisão do campo.
DataScale	Integer	0	O número de casas decimais exibidas pelo campo.
Position	Integer	1	A posição do campo na tabela.
Nullable	Boolean	false	Define se o campo aceita valores nulos. Valores válidos: true: O campo aceita valores nulos. false: O campo não aceita valores nulos.
DataLength	Long	0	O comprimento do campo.
ErrorMessage	String	TableGuid is mandatory for this action.	A mensagem de erro retornada.
Success	Boolean	true	Indica se a solicitação foi bem-sucedida. Valores válidos: true: A solicitação foi bem-sucedida. false: A solicitação falhou.

Exemplos

Exemplos de solicitações

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

Exemplos de respostas de sucesso

Formato 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>

Formato 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
}

Códigos de erro

Para obter uma lista de códigos de erro, visite o API Error Center.