Todos los productos
Search
Centro de documentos

:DeployFile

Última actualización: Sep 04, 2026

Despliega un archivo de DataStudio en el entorno de producción. Después de llamar a la operación DeployFile, puede usar la operación GetDeployment para consultar el estado de una tarea de despliegue asíncrona según el valor del parámetro Data en la respuesta de DeployFile.

Depuración

OpenAPI Explorer calcula automáticamente el valor de la firma. Para su comodidad, se recomienda llamar a esta operación en OpenAPI Explorer. Esta herramienta genera dinámicamente código de ejemplo de la operación para diferentes SDK.

Parámetros de solicitud

Parámetro

Tipo

Obligatorio

Ejemplo

Descripción

Action

String

Sí

DeployFile

La operación que desea ejecutar. Establezca el valor en DeployFile.

ProjectId

Long

No

10000

ID del espacio de trabajo de DataWorks. Inicie sesión en la consola de DataWorks y vaya a la página Workspace para obtener este ID. Configure este parámetro o ProjectIdentifier para determinar el espacio de trabajo de DataWorks al que se aplica la operación.

ProjectIdentifier

String

No

dw_project

Nombre del espacio de trabajo de DataWorks. Inicie sesión en la consola de DataWorks y vaya a la página Workspace para obtener este nombre. Configure este parámetro o ProjectId para determinar el espacio de trabajo de DataWorks al que se aplica la operación.

FileId

Long

Sí

10000001

ID del archivo. Llame a la operación ListFiles para consultar el ID.

Configure este parámetro o NodeId.

Comment

String

No

Deploy for the first time

Descripción de la operación de despliegue.

NodeId

Long

No

2000001

ID del nodo correspondiente al archivo que desea desplegar en el sistema de programación. Configure este parámetro o FileId.

Parámetros de respuesta

Parámetro

Tipo

Ejemplo

Descripción

HttpStatusCode

Integer

200

Código de estado HTTP.

Data

Long

30000001

ID del paquete de despliegue. Este ID se usa como valor de un parámetro de solicitud específico al llamar a la operación GetDeployment para consultar los detalles de la operación de despliegue.

RequestId

String

0000-ABCD-EFG****

ID de la solicitud.

ErrorMessage

String

The connection does not exist.

Mensaje de error.

Success

Boolean

true

Indica si la solicitud fue exitosa.

ErrorCode

String

Invalid.Tenant.ConnectionNotExists

Código de error.

Ejemplos

Solicitudes de ejemplo

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

Respuestas exitosas de ejemplo

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 error

Código de estado HTTP

Código de error

Mensaje de error

Descripción

403

Forbidden.Access

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

Sin permisos.

429

Throttling.Api

The request for this resource has exceeded your available limit.

El número de solicitudes para el recurso ha excedido el límite superior.

429

Throttling.System

The DataWorks system is busy. Try again later.

El sistema de DataWorks está ocupado. Inténtelo de nuevo más tarde.

429

Throttling.User

Your request is too frequent. Try again later.

Se han enviado demasiadas solicitudes en un periodo corto. Inténtelo de nuevo más tarde.

500

InternalError.System

An internal system error occurred. Try again later.

Ocurrió un error interno. Inténtelo de nuevo más tarde.

500

InternalError.UserId.Missing

An internal system error occurred. Try again later.

Ocurrió un error interno. Inténtelo de nuevo más tarde.

Para obtener una lista de códigos de error, consulte Códigos de error del servicio.