Exclui um arquivo do DataStudio. Se o arquivo tiver sido submetido, o sistema acionará um processo assíncrono para removê-lo do sistema de agendamento. Use o valor do parâmetro DeploymentId retornado para chamar a operação GetDeployment e consultar o status desse processo assíncrono.
Depuração
Parâmetros da solicitação
|
Parâmetro |
Tipo |
Obrigatório |
Exemplo |
Descrição |
|
Action |
String |
Sim |
DeleteFile |
A operação a ser executada. |
|
ProjectId |
Long |
Não |
10000 |
O ID do workspace do DataWorks. Acesse o console do DataWorks e navegue até a página Work space para obter o ID do workspace. Configure este parâmetro ou o parâmetro ProjectIdentifier para definir o workspace do DataWorks onde a operação será aplicada. |
|
ProjectIdentifier |
String |
Não |
dw_project |
O nome do workspace do DataWorks. Acesse o console do DataWorks e navegue até a página Work space para obter o nome do workspace. Configure este parâmetro ou o parâmetro ProjectId para definir o workspace do DataWorks onde a operação será aplicada. |
|
FileId |
Long |
Sim |
10000001 |
O ID do arquivo. Chame a operação ListFiles para consultar o ID do arquivo. |
Parâmetros de resposta
|
Parâmetro |
Tipo |
Exemplo |
Descrição |
|
HttpStatusCode |
Integer |
200 |
O código de status HTTP. |
|
DeploymentId |
Long |
1000000001 |
O ID do pacote de implantação usado para implantar o arquivo. Se o arquivo tiver sido submetido, o sistema acionará um processo assíncrono para excluí-lo do sistema de agendamento. Use o valor deste parâmetro para chamar a operação GetDeployment e consultar o status do processo assíncrono. Se este parâmetro estiver vazio, o arquivo já foi excluído e não é necessário consultar o status. |
|
RequestId |
String |
0000-ABCD-EFG**** |
O ID da solicitação. |
|
ErrorMessage |
String |
The connection does not exist. |
A mensagem de erro. |
|
Success |
Boolean |
true |
Indica se a solicitação foi bem-sucedida. Valores válidos:
|
|
ErrorCode |
String |
Invalid.Tenant.ConnectionNotExists |
O código de erro. |
Exemplos
Exemplos de solicitações
http(s)://[Endpoint]/?Action=DeleteFile
&ProjectId=10000
&ProjectIdentifier=dw_project
&FileId=10000001
&<Common request parameters>Exemplos de respostas de sucesso
Formato XML
HTTP/1.1 200 OK
Content-Type:application/xml
<DeleteFileResponse>
<HttpStatusCode>200</HttpStatusCode>
<DeploymentId>1000000001</DeploymentId>
<RequestId>0000-ABCD-EFG****</RequestId>
<ErrorMessage>The connection does not exist.</ErrorMessage>
<Success>true</Success>
<ErrorCode>Invalid.Tenant.ConnectionNotExists</ErrorCode>
</DeleteFileResponse>Formato JSON
HTTP/1.1 200 OK
Content-Type:application/json
{
"HttpStatusCode" : 200,
"DeploymentId" : 1000000001,
"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 máximo. |
|
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 do sistema. Tente novamente mais tarde. |
|
500 |
InternalError.UserId.Missing |
An internal system error occurred. Try again later. |
Ocorreu um erro interno do sistema. Tente novamente mais tarde. |
Para obter uma lista de códigos de erro, consulte Códigos de erro do serviço.