Todos os produtos
Search

Este produto

    :ListOrders

    Central de documentação

    :ListOrders

    Última atualização: Jul 08, 2026

    Chame a API ListOrders para obter informações sobre a lista de tickets.

    Depuração

    O OpenAPI Explorer calcula automaticamente o valor da assinatura. Recomendamos chamar esta operação no OpenAPI Explorer para facilitar o processo. Use o OpenAPI Explorer para pesquisar operações de API, chamá-las e gerar dinamicamente códigos de exemplo do SDK.

    Parâmetros da solicitação

    ParâmetroTipoObrigatórioExemploDescrição
    Action String Sim ListOrders

    A operação a ser executada. Valores válidos:ListOrders.

    Tid Long Não -1

    O ID do locatário.

    Nota Obtenha o ID do locatário no avatar localizado no canto superior direito do sistema. Para mais informações, consulteID do locatário e Locatário.
    PluginType String Não DC_COMMON

    O tipo do ticket. Valores válidos:

    • PERM_APPLY: ticket de solicitação de permissão.
    • OWNER_APPLY: ticket de solicitação de proprietário.
    • DATA_CORRECT: ticket de alteração de dados.
    • NDDL: ticket de alteração de design de esquema.
    • DATA_TRACK: ticket de rastreamento de dados.
    • TABLE_SYNC: ticket de sincronização de banco de dados e tabela.
    • DATA_EXPORT: ticket de exportação de dados.
    • SENSITIVITY: ticket de alteração de nível de sensibilidade de coluna.
    OrderResultType String Não AS_ADMIN

    O tipo de ticket a consultar. Valores válidos:

    • AS_ADMIN: todos os tickets do usuário atual.
    • AS_COMMITTER: tickets iniciados por mim.
    • AS_HANDLER: tickets pendentes de tratamento por mim.
    • AS_OWNER: tickets já tratados por mim.
    • AS_Related:
    SearchDateType String Não CREATE_TIME

    A condição temporal para consulta do ticket. Valores válidos:

    • CREATE_TIME: momento de criação do ticket.
    • MODIFY_TIME: momento da última modificação do ticket.
    StartTime String Não 2019-10-10 00:00:00

    Início do intervalo de tempo.

    EndTime String Não 2019-10-10 00:00:00

    Fim do intervalo de tempo da consulta.

    SearchContent String Não test

    Conteúdo da pesquisa.

    OrderStatus String Não ALL

    Status do ticket. Valores válidos:

    • ALL: todos os tickets.
    • FINISHED: tickets encerrados.
    • RUNNING: tickets em andamento.
    PageSize Integer Não 10

    Número de entradas retornadas por página.

    PageNumber Integer Não 1

    Número da página retornada.

    Parâmetros de resposta

    Parâmetro

    Tipo

    Exemplo

    Descrição

    ErrorCode

    String

    UnknownError

    Código do erro.

    ErrorMessage

    String

    UnknownError

    Mensagem de erro.

    Orders

    Array of Order

    Informações da lista de tickets.

    Order

    Comment

    String

    test

    Observações sobre o ticket.

    Committer

    String

    test

    Pessoa que enviou o ticket.

    CommitterId

    Long

    1

    ID de quem enviou o ticket.

    CreateTime

    String

    2019-10-10 00:00:00

    Momento de criação do ticket.

    LastModifyTime

    String

    2019-10-10 00:00:00

    Momento da última modificação do ticket.

    OrderId

    Long

    1432

    ID do ticket.

    PluginType

    String

    DC_COMMON

    Tipo do ticket.

    StatusCode

    String

    success

    Código de status do ticket.

    StatusDesc

    String

    success

    Descrição do status do ticket.

    RequestId

    String

    427688B8-ADFB-4C4E-9D45-EF5C1FD6E23D

    ID da solicitação.

    Success

    Boolean

    true

    Indica se a solicitação foi bem-sucedida.

    TotalCount

    Long

    100

    Número total de entradas retornadas.

    Exemplos

    Exemplos de solicitações

    
     http(s)://[Endpoint]/? Action=ListOrders &<common request parameters>

    Exemplos de respostas de sucesso

    Formato XML

    
     <TotalCount> 5 </TotalCount> <RequestId> 7AC17A86-9E6F-484B-AE8D-F9416986A108 </RequestId> <Orders> <Order> <StatusCode> success </StatusCode> <PluginType> dc_common </PluginType> <Committer> xxx [account] </Committer> <StatusDesc> data change successfully </StatusDesc> <LastModifyTime> 2019-11-19 13:53:05 </LastModifyTime> <CreateTime> 2019-11-19 13:52:36 </CreateTime> <OrderId> 737160 </OrderId> <Comment> test data change </Comment> <CommitterId> 104442 </CommitterId> </Order> <Order> <StatusCode> new </StatusCode> <PluginType> DC_COMMON </PluginType> <Committer> xxx [sub-account] </Committer> <StatusDesc> to be submitted for approval </StatusDesc> <LastModifyTime> 2019-10-29 20:51:37 </LastModifyTime> <CreateTime> 2019-10-29 20:51:36 </CreateTime> <OrderId> 737116 </OrderId> <Comment> test the </Comment> <CommitterId> 104442 </CommitterId> </Order> of creating a data change ticket <Order> <StatusCode> closed </StatusCode> <PluginType> DC_COMMON </PluginType> <Committer> xxx [subaccount] </Committer> <StatusDesc> ticket closed: Database-level operations still not supported </StatusDesc> <LastModifyTime> 2019-10-20 22:09:38 </LastModifyTime> <CreateTime> the test database creation </CreateTime> <OrderId> 737089 </OrderId> <Comment> <Order> </Comment> <CommitterId> 104442 </CommitterId> </Order> 2019-10-20 22:08:19 <StatusCode> new </StatusCode> <PluginType> DC_COMMON </PluginType> <Committer> xxx [sub-account] </Committer> <StatusDesc> pre-check failed </StatusDesc> <LastModifyTime> 2019-09-30 16:58:35 </LastModifyTime> <CreateTime> 16:58:34 on 2019-09-30 </CreateTime> <OrderId> 737016 </OrderId> <Comment> test </Comment> <CommitterId> 104442 </CommitterId> </Order> <Order> <StatusCode> success </StatusCode> <PluginType> dc_common </PluginType> <Committer> xxx [account] </Committer> <StatusDesc> data change successfully </StatusDesc> <LastModifyTime> 2019-08-17 14:07:54 </LastModifyTime> <CreateTime> 2019-08-17 14:07:42 </CreateTime> <OrderId> 736774 </OrderId> <Comment> test common data change </Comment> <CommitterId> 104442 </CommitterId> </Order> </Orders> <Success> true </Success>

    Formato JSON

    
     {"TotalCount": 5, "RequestId": "7AC17A86-9 E6 F-484B-AE8D-F9416986A108", "Orders": { "Order": [ { "StatusCode": "success", "PluginType": "DC_COMMON", "Committer": "xxx [sub-account]", "StatusDesc": "Data Change succeeded", "LastModifyTime": "2019-11-19 13:53:05", "CreateTime": "2019-11-19 13:52:36", " OrderId ": 737160, " Comment ": " test data change ", " CommitterId ": 104442 }, { " StatusCode ": " new ", " PluginType ": " DC_COMMON ", " Committer ": " xxx [sub-account] ", " StatusDesc ": " to be submitted for approval ", " LastModifyTime ": " 2019-10-29 20:51:37 ", " CreateTime ": " 2019-10-29 20:51:36 ", " OrderId ": 737116, "Comment": "test to create a data change ticket", "CommitterId": 104442 }, { "StatusCode": "closed", "PluginType": "DC_COMMON", "Committer": "xxx [sub-account]", "StatusDesc": "The ticket has been closed: still, database-level operations are not supported.", "LastModifyTime": "2019-10-20 22:09:38", "CreateTime": "2019-10-20 22:08:19", "OrderId": 737089, "Comment": " Test database creation ", " CommitterId ": 104442 },{" StatusCode ": " new ", " PluginType ": " DC_COMMON ", " Committer ": " xxx [subaccount] ", " StatusDesc ": " PreCheck failed ", " LastModifyTime ": " 2019-09-30 16:58:35 ", " CreateTime ": " 2019-09-30 16:58:34 ", " OrderId ": 737016, " Comment ": " test ", CommitterId ": 104442 },{" StatusCode ": " success ", " PluginType ": " DC_COMMON ", " Committer ": " xxx [sub-account] ", " StatusDesc ": " Data Change succeeded ", " LastModifyTime ": " 2019-08-17 14:07:54 ", " CreateTime ": " 2019-08-17 14:07:42 ", " OrderId ": 736774, " Comment ": " Test common data change ", " CommitterId ": 104442} ] }, "Success": true}

    Códigos de erro

    Acesse o Centro de Erros para obter mais informações sobre os códigos de erro.