Todos os produtos
Search
Central de documentação

:DeployFile

Última atualização: Jun 27, 2026

Implanta um arquivo do DataStudio no ambiente de produção. Após chamar a operação DeployFile, use a operação GetDeployment para consultar o status da tarefa de implantação assíncrona com base no valor do parâmetro Data retornado na resposta da operação DeployFile.

Depuração

O OpenAPI Explorer calcula automaticamente o valor da assinatura. Para sua conveniência, recomendamos chamar esta operação no OpenAPI Explorer. O OpenAPI Explorer 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

DeployFile

Operação a ser executada. Defina o valor como DeployFile.

ProjectId

Long

Não

10000

ID do workspace do DataWorks. Faça login no console do DataWorks e acesse a página Workspace para obter esse ID. Configure este parâmetro ou o parâmetro ProjectIdentifier para identificar o workspace do DataWorks ao qual a operação se aplica.

ProjectIdentifier

String

Não

dw_project

Nome do workspace do DataWorks. Faça login no console do DataWorks e acesse a página Workspace para obter esse nome. Configure este parâmetro ou o parâmetro ProjectId para identificar o workspace do DataWorks ao qual a operação se aplica.

FileId

Long

Sim

10000001

ID do arquivo. Chame a operação ListFiles para consultar o ID.

Configure este parâmetro ou o parâmetro NodeId.

Comment

String

Não

Deploy for the first time

Descrição da operação de implantação.

NodeId

Long

Não

2000001

ID do nó correspondente ao arquivo a ser implantado no sistema de agendamento. Configure este parâmetro ou o parâmetro FileId.

Parâmetros de resposta

Parâmetro

Tipo

Exemplo

Descrição

HttpStatusCode

Integer

200

Código de status HTTP.

Data

Long

30000001

ID do pacote de implantação. Use esse ID como valor de um parâmetro específico da solicitação ao chamar a operação GetDeployment para consultar os detalhes da operação de implantação.

RequestId

String

0000-ABCD-EFG****

ID da solicitação.

ErrorMessage

String

The connection does not exist.

Mensagem de erro.

Success

Boolean

true

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

ErrorCode

String

Invalid.Tenant.ConnectionNotExists

Código de erro.

Exemplos

Exemplos de solicitações

http(s)://[Endpoint]/?Action=DeployFile
&ProjectId=10000
&ProjectIdentifier=dw_project
&FileId=10000001
&Comment=Deploy for the first time
&NodeId=2000001
&<Common request parameters>

Exemplos de respostas de sucesso

Formato XML

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

<DeployFileResponse>
    <HttpStatusCode>200</HttpStatusCode>
    <Data>30000001</Data>
    <RequestId>0000-ABCD-EFG****</RequestId>
    <ErrorMessage>The connection does not exist.</ErrorMessage>
    <Success>true</Success>
    <ErrorCode>Invalid.Tenant.ConnectionNotExists</ErrorCode>
</DeployFileResponse>

Formato JSON

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

{
  "HttpStatusCode" : 200,
  "Data" : 30000001,
  "RequestId" : "0000-ABCD-EFG****",
  "ErrorMessage" : "The connection does not exist.",
  "Success" : true,
  "ErrorCode" : "Invalid.Tenant.ConnectionNotExists"
}

Códigos de erro

Código de status HTTP

Código de erro

Mensagem de erro

Descrição

403

Forbidden.Access

Access is forbidden. Please first activate DataWorks Enterprise Edition or Flagship Edition.

Sem permissões.

429

Throttling.Api

The request for this resource has exceeded your available limit.

O número de solicitações para o recurso excedeu o limite superior.

429

Throttling.System

The DataWorks system is busy. Try again later.

O sistema do DataWorks está ocupado. Tente novamente mais tarde.

429

Throttling.User

Your request is too frequent. Try again later.

Muitas solicitações foram enviadas em um curto período. Tente novamente mais tarde.

500

InternalError.System

An internal system error occurred. Try again later.

Ocorreu um erro interno. Tente novamente mais tarde.

500

InternalError.UserId.Missing

An internal system error occurred. Try again later.

Ocorreu um erro interno. Tente novamente mais tarde.

Para obter uma lista de códigos de erro, consulte Códigos de erro do serviço.