ListDDLPublishRecords - Data Management: Central de Documentação do Alibaba Cloud

Consulta os detalhes de publicação de um ticket de design de schema.

Experimente agora

Experimente esta API no OpenAPI Explorer, sem necessidade de assinatura manual. Chamadas bem-sucedidas geram automaticamente código SDK correspondente aos seus parâmetros. Faça o download com segurança de credenciais integrada para uso local.

Testar

Autorização RAM

A tabela abaixo descreve a autorização necessária para chamar esta API. Você pode defini-la em uma política do Resource Access Management (RAM). As colunas da tabela estão detalhadas abaixo:

Ação: As ações que podem ser usadas no elemento Action das instruções de política de permissão do RAM para conceder permissões para executar a operação.
API: A API que você pode chamar para executar a ação.
Nível de acesso: O nível de acesso predefinido concedido para cada API. Valores válidos: create, list, get, update e delete.
Tipo de recurso: O tipo de recurso que suporta autorização para executar a ação. Indica se a ação suporta permissão em nível de recurso. O recurso especificado deve ser compatível com a ação. Caso contrário, a política será ineficaz.
- Para APIs com permissões em nível de recurso, os tipos de recursos obrigatórios são marcados com um asterisco (*). Especifique o Nome de Recurso Alibaba Cloud (ARN) correspondente no elemento Resource da política.
- Para APIs sem permissões em nível de recurso, é exibido como Todos os Recursos. Use um asterisco (*) no elemento Resource da política.
Chave de condição: As chaves de condição definidas pelo serviço. A chave permite controle granular, aplicando-se somente a ações ou a ações associadas a recursos específicos. Além das chaves de condição específicas do serviço, o Alibaba Cloud fornece um conjunto de chaves de condição comuns aplicáveis a todos os serviços compatíveis com RAM.
Ação dependente: As ações dependentes necessárias para executar a ação. Para concluir a ação, o usuário RAM ou a função RAM deve ter permissões para executar todas as ações dependentes.

Ação

Nível de acesso

Tipo de recurso

Chave de condição

Ação dependente

dms:ListDDLPublishRecords

list

*All Resource

*

Nenhuma

Parâmetros da solicitação

Parâmetro	Tipo	Obrigatório	Descrição	Exemplo
OrderId	integer	Sim	O ID do ticket. Nota Você pode criar um ticket de design de schema no console do Data Management (DMS). Para mais informações, consulte Design schemas. Você também pode chamar a operação CreateOrder para criar um ticket de design de schema e obter o ID do ticket.	3214325
Tid	integer	Não	O ID do tenant. Nota Para visualizar o ID do tenant, faça login no console do DMS e posicione o ponteiro sobre a foto de perfil no canto superior direito. Para mais informações, consulte Manage DMS tenants.	1

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object	O schema da resposta.
RequestId	string	O ID da solicitação.	A1549FB0-D4B8-4140-919F-17322C1072B8
Success	boolean	Indica se a solicitação foi bem-sucedida.	true
ErrorMessage	string	A mensagem de erro retornada se a solicitação falhou.	UnknownError
ErrorCode	string	O código de erro retornado se a solicitação falhou.	UnknownError
DDLPublishRecordList	array<object>	Os detalhes dos registros de publicação.
	array<object>	O registro de publicação.
AuditStatus	string	O estado de aprovação do ticket. Valores válidos: EXEMPT_PASS: O ticket é aprovado sem necessidade de aprovação. TO_AUDIT: O ticket está pendente de aprovação. CANCEL: O ticket foi cancelado. SUCCESS: O ticket foi aprovado. FAIL: O ticket não passou na aprovação.	CANCEL
AuditExpireTime	string	O horário em que a aprovação expira.	2020-12-14 20:52:38
CreatorId	integer	O ID do usuário que cria o ticket. Você pode obter o ID do usuário chamando a operação GetUser e consultando o valor do parâmetro UserId. O valor não é o ID exclusivo (UID) da conta Alibaba Cloud.	1423
Finality	boolean	Indica se a aprovação foi encerrada. Valores válidos: true: A aprovação foi encerrada. false: A aprovação não foi encerrada. Nota Vários motivos podem encerrar a aprovação. Por exemplo, você retira a solicitação ou seu ticket não é aprovado antes do horário especificado.	true
FinalityReason	string	O motivo do encerramento.	CANCEL
PublishStatus	string	O estado de publicação do ticket. Valores válidos: START: O ticket foi criado. ANALYZE: O ticket está em análise. AUDIT: O ticket está em aprovação. DISPATCH: Uma tarefa foi gerada para o ticket. SUCCESS: A tarefa foi bem-sucedida.	AUDIT
RiskLevel	string	O nível de risco da operação. Valores válidos: NONE_RISK: A operação não apresenta riscos. LOW_RISK: A operação é de baixo risco. MIDDLE_RISK: A operação é de médio risco. HIGH_RISK: A operação é de alto risco.	LOW_RISK
StatusDesc	string	A descrição do estado de publicação.	CANCEL
WorkflowInstanceId	integer	O ID do processo de aprovação.	432153
Comment	string	Observações de publicação.	Publish remarks
PublishTaskInfoList	array<object>	A lista de tarefas de publicação.
	array<object>	As informações sobre a tarefa de publicação.
DbId	integer	The ID of the database.	4325
Logic	boolean	Indicates whether the database is a logical database. Valid values: true: The database is a logical database. false: the database is not a logical database.	false
PlanTime	string	The time to publish the ticket.	2020-12-14 20:52:38
PublishStrategy	string	The publishing policy. Valid values: IMMEDIATELY: immediately publishes the ticket. REGULARLY: publishes the ticket at a scheduled time.	IMMEDIATELY
StatusDesc	string	The description of the state.	NONE
TaskJobStatus	string	The state of the task.	NONE
PublishJobList	array<object>	The list of the publishing tasks.
	object	The details of the publishing task.
ExecuteCount	integer	The number of SQL statements that are executed.	0
Scripts	string	The script for data changes.	ALTER TABLE test_toolkit_rename_table_after_rename MODIFY COLUMN gmt_modified datetime NOT NULL
TableName	string	The name of the table after the change.	test_toolkit_rename_table_after_rename
StatusDesc	string	The description of the state.	NONE
TaskJobStatus	string	The state of the publishing task. Valid values: NONE: The state of the task is unknown. SUCCESS: The task is successful. FAIL: The task fails.	NONE
DBTaskGroupId	integer	The ID of the SQL task group.	423515

Exemplos

Resposta de sucesso

JSON formato

{
  "RequestId": "A1549FB0-D4B8-4140-919F-17322C1072B8",
  "Success": true,
  "ErrorMessage": "UnknownError",
  "ErrorCode": "UnknownError",
  "DDLPublishRecordList": [
    {
      "AuditStatus": "CANCEL",
      "AuditExpireTime": "2020-12-14 20:52:38",
      "CreatorId": 1423,
      "Finality": true,
      "FinalityReason": "CANCEL",
      "PublishStatus": "AUDIT",
      "RiskLevel": "LOW_RISK",
      "StatusDesc": "CANCEL",
      "WorkflowInstanceId": 432153,
      "Comment": "Publish remarks",
      "PublishTaskInfoList": [
        {
          "DbId": 4325,
          "Logic": false,
          "PlanTime": "2020-12-14 20:52:38",
          "PublishStrategy": "IMMEDIATELY",
          "StatusDesc": "NONE",
          "TaskJobStatus": "NONE",
          "PublishJobList": [
            {
              "ExecuteCount": 0,
              "Scripts": "ALTER TABLE test_toolkit_rename_table_after_rename MODIFY COLUMN gmt_modified datetime NOT NULL",
              "TableName": "test_toolkit_rename_table_after_rename",
              "StatusDesc": "NONE",
              "TaskJobStatus": "NONE",
              "DBTaskGroupId": 423515
            }
          ]
        }
      ]
    }
  ]
}

Códigos de erro

Consulte Códigos de Erro para uma lista completa.

Notas de versão

Consulte Notas de Versão para uma lista completa.