GetDeployment - : Central de Documentação do Alibaba Cloud

Depuração

O OpenAPI Explorer calcula automaticamente o valor da assinatura. Para sua conveniência, recomendamos que você chame esta operação no OpenAPI Explorer. O OpenAPI Explorer gera dinamicamente o código de exemplo da operação para diferentes SDKs.

Parâmetros da solicitação

Parâmetro	Tipo	Obrigatório	Exemplo	Descrição
Action	String	Sim	GetDeployment	A operação a ser executada. Defina o valor como GetDeployment.
ProjectId	Long	Não	10000	O ID do workspace do DataWorks. Clique em no ícone Workspace Manage no canto superior direito da página DataStudio para acessar a página Work space e visualizar o ID do workspace.
ProjectIdentifier	String	Não	dw_project	O identificador exclusivo do workspace do DataWorks. Clique em no identificador no canto superior esquerdo da página DataStudio para alternar para outro workspace. Configure este parâmetro ou o parâmetro ProjectId para determinar o workspace do DataWorks ao qual a operação se aplica.
DeploymentId	Long	Sim	3000001	O ID do pacote de deploy. Um ID de pacote de deploy é gerado ao chamar a operação SubmitFile ou DeployFile.

Parâmetros de resposta

Parâmetro	Tipo	Exemplo	Descrição
HttpStatusCode	Integer	200	O código de status HTTP.
ErrorMessage	String	The connection does not exist.	A mensagem de erro.
RequestId	String	0000-ABCD-EFG****	O ID da solicitação.
ErrorCode	String	Invalid.Tenant.ConnectionNotExists	O código de erro.
Success	Boolean	true	Indica se a solicitação foi bem-sucedida.
Data	Object		Os dados retornados.
Deployment	Object		Os detalhes do pacote de deploy.
Status	Integer	1	O status do pacote de deploy. Valores válidos: 0, 1 e 2. O valor 0 indica que o pacote está pronto. O valor 1 indica sucesso no deploy. O valor 2 indica falha no deploy.
ErrorMessage	String	Success	A mensagem de erro retornada quando o deploy do pacote falha. Nesse caso, o valor do parâmetro Status é 2.
FromEnvironment	Integer	0	O ambiente de origem do pacote de deploy. Valores válidos: 0 e 1. O valor 0 indica o ambiente local. O valor 1 indica o ambiente de desenvolvimento.
ToEnvironment	Integer	1	O ambiente de destino do arquivo. Valores válidos: 1 e 2. O valor 1 indica o ambiente de desenvolvimento. O valor 2 indica o ambiente de produção.
CheckingStatus	Integer	7	O status de verificação de um ou mais arquivos no pacote de deploy. Se o valor do parâmetro ToEnvironment for 1, os arquivos só poderão ser implantados no ambiente de produção quando o valor do parâmetro Status for 1 e o parâmetro CheckingStatus estiver vazio. Valores válidos: 7: falha na verificação 8: verificando
CreateTime	Long	1593877765000	O momento em que o pacote de deploy foi criado. Este valor é um timestamp UNIX que representa o número de milissegundos decorridos desde 1º de janeiro de 1970, 00:00:00 UTC.
HandlerId	String	2003****	O ID da conta Alibaba Cloud usada pelo usuário que executou o pacote de deploy.
CreatorId	String	20030****	O ID da conta Alibaba Cloud usada pelo usuário que criou o pacote de deploy.
ExecuteTime	Long	1593877765000	O momento em que o pacote de deploy foi implantado. Este valor é um timestamp UNIX que representa o número de milissegundos decorridos desde 1º de janeiro de 1970, 00:00:00 UTC.
Name	String	ods_user_info_d-2020-07-04_20030****	O nome do pacote de deploy. O valor corresponde ao nome do pacote específico exibido na página Deployment Packages em Deploy.
DeployedItems	Array of DeployedItem		Os itens implantados.
FileId	Long	507642378	O ID do arquivo.
FileVersion	Long	7	A versão do arquivo.
Status	Integer	1	O status. Valores válidos: UNPUBLISHED(0): não implantado SUCCESS(1): implantado ERROR(2): falha no deploy CLONED(3): clonado DEPLOY_ERROR(4): falha no deploy CLONING(5): clonando REJECT(6): solicitação de deploy rejeitada

Exemplos

Exemplos de solicitações

http(s)://[Endpoint]/?Action=GetDeployment
&ProjectId=10000
&ProjectIdentifier=dw_project
&DeploymentId=3000001
&<Common request parameters>

Exemplos de respostas de sucesso

Formato XML

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

<GetDeploymentResponse>
    <HttpStatusCode>200</HttpStatusCode>
    <ErrorMessage>The connection does not exist.</ErrorMessage>
    <RequestId>0000-ABCD-EFG****</RequestId>
    <ErrorCode>Invalid.Tenant.ConnectionNotExists</ErrorCode>
    <Success>true</Success>
    <Data>
        <Deployment>
            <Status>1</Status>
            <ErrorMessage>Success</ErrorMessage>
            <FromEnvironment>0</FromEnvironment>
            <ToEnvironment>1</ToEnvironment>
            <CheckingStatus>7</CheckingStatus>
            <CreateTime>1593877765000</CreateTime>
            <HandlerId>2003****</HandlerId>
            <CreatorId>20030****</CreatorId>
            <ExecuteTime>1593877765000</ExecuteTime>
            <Name>ods_user_info_d-2020-07-04_20030****</Name>
        </Deployment>
        <DeployedItems>
            <FileId>507642378</FileId>
            <FileVersion>7</FileVersion>
            <Status>1</Status>
        </DeployedItems>
    </Data>
</GetDeploymentResponse>

Formato JSON

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

{
  "HttpStatusCode" : 200,
  "ErrorMessage" : "The connection does not exist.",
  "RequestId" : "0000-ABCD-EFG****",
  "ErrorCode" : "Invalid.Tenant.ConnectionNotExists",
  "Success" : true,
  "Data" : {
    "Deployment" : {
      "Status" : 1,
      "ErrorMessage": "Success",
      "FromEnvironment" : 0,
      "ToEnvironment" : 1,
      "CheckingStatus" : 7,
      "CreateTime" : 1593877765000,
      "HandlerId" : "2003****",
      "CreatorId" : "20030****",
      "ExecuteTime" : 1593877765000,
      "Name" : "ods_user_info_d-2020-07-04_20030****"
    },
    "DeployedItems" : {
      "FileId" : 507642378,
      "FileVersion" : 7,
      "Status" : 1
    }
  }
}

Códigos de erro

Código de status HTTP	Código de erro	Mensagem de erro	Descrição
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 permitido.
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.	Foram enviadas solicitações excessivas 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.