Todos os produtos
Search
Central de documentação

:ListDBTaskSQLJob

Última atualização: Jul 08, 2026

Chame a operação ListDBTaskSQLJob para obter uma lista de tarefas SQL.

Depuração

Execute esta operação diretamente no OpenAPI Explorer. Não é necessário calcular assinaturas. Após a execução bem-sucedida, o OpenAPI Explorer gera automaticamente exemplos de código do SDK.

Parâmetros da solicitação

Name Type Required Example Description
Action String Yes ListDBTaskSQLJob

Parâmetro obrigatório. Defina o valor como ListDBTaskSQLJob.

DBTaskGroupId Long Yes 132****

ID do grupo de tarefas SQL. Chame a operação GetStructSyncJobDetail para obter esse parâmetro.

PageNumber Long No 1

Número da página inicial.

PageSize Long No 20

Número de entradas a retornar em cada página.

Tid Long No 1***

ID do locatário.

Nota Para visualizar o ID do locatário, passe o ponteiro do mouse sobre a foto de perfil no canto superior direito do console DMS. Para mais informações, consulte Visualizar informações do locatário.
RegionId String No cn-hangzhou

Região onde o serviço DMS está ativado. Selecione a região mais próxima da sua aplicação. Para obter uma lista de valores válidos, consulte Descrição do parâmetro RegionId.

Dados retornados

Name Type Example Description
RequestId String F6C47680-8D2D-43A4-8902-F2740D71A398

ID da solicitação.

Success Boolean true

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

ErrorMessage String UnknownError

Mensagem de erro.

ErrorCode String UnknownError

Código de erro.

DBTaskSQLJobList Array of DBTaskSQLJob

Lista de tarefas SQL.

JobId Long 12****

ID da tarefa SQL.

JobType String STRUCT_SYNC

Tipo da tarefa SQL.

Comment String test

Comentário sobre a tarefa SQL.

DbSearchName String test@xxx:3306[test]

Nome de pesquisa do banco de dados.

DbId Long 43214523

ID do banco de dados.

Logic Boolean false

Indica se o banco de dados é lógico. Valores válidos:

  • true: Sim
  • false: Não
CreateTime String 2021-02-18 17:49:20

Horário de criação da tarefa.

LastExecTime String 2021-02-18 17:49:31

Última execução da tarefa.

DbTaskGroupId Long 432****

ID do grupo de tarefas SQL.

Status String SUCCESS

Status da tarefa SQL. Valores válidos:

  • INIT: A tarefa está sendo inicializada.
  • PENDING: A tarefa aguarda coleta.
  • BE_SCHEDULED: A tarefa aguarda agendamento.
  • FAIL: Falha na tarefa.
  • SUCCESS: Tarefa concluída com sucesso.
  • PAUSE: Tarefa pausada.
  • DELETE: Tarefa excluída.
  • RUNNING: Tarefa em execução.
Transactional Boolean false

Indica se a tarefa executa dentro de uma transação. Valores válidos:

  • true: Sim
  • false: Não
TotalCount Long 1

Número total de tarefas SQL.

Exemplos

Exemplo de solicitação

http(s)://dms-enterprise.aliyuncs.com/?Action=ListDBTaskSQLJob
&PageNumber=1
&PageSize=20
&Common request parameters

Exemplo de resposta

Formato XML

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

<ListDBTaskSQLJobResponse>
    <RequestId>F6C47680-8D2D-43A4-8902-F2740D71A398</RequestId>
    <Success>true</Success>
    <ErrorMessage>UnknownError</ErrorMessage>
    <ErrorCode>UnknownError</ErrorCode>
    <DBTaskSQLJobList>
        <JobType>STRUCT_SYNC</JobType>
        <Comment>test</Comment>
        <DbSearchName>test@xxx:3306[test]</DbSearchName>
        <DbId>43214523</DbId>
        <Logic>false</Logic>
        <CreateTime>2021-02-18 17:49:20</CreateTime>
        <LastExecTime>2021-02-18 17:49:31</LastExecTime>
        <Status>SUCCESS</Status>
        <Transactional>false</Transactional>
    </DBTaskSQLJobList>
    <TotalCount>1</TotalCount>
</ListDBTaskSQLJobResponse>

Formato JSON

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

{
  "RequestId" : "F6C47680-8D2D-43A4-8902-F2740D71A398",
  "Success" : true,
  "ErrorMessage" : "UnknownError",
  "ErrorCode" : "UnknownError",
  "DBTaskSQLJobList" : [ {
    "JobType" : "STRUCT_SYNC",
    "Comment" : "test",
    "DbSearchName" : "test@xxx:3306[test]",
    "DbId" : 43214523,
    "Logic" : false,
    "CreateTime" : "2021-02-18 17:49:20",
    "LastExecTime" : "2021-02-18 17:49:31",
    "Status" : "SUCCESS",
    "Transactional" : false
  } ],
  "TotalCount" : 1
}

Códigos de erro

Para obter uma lista de códigos de erro, consulte a Central de Erros.