DescribeSendFileResults - Elastic Compute Service: Central de Documentação do Alibaba Cloud

Consulta a lista e o status dos arquivos enviados pelo Cloud Assistant.

Descrição da operação

Descrição da operação:\n- Após enviar um arquivo, o envio não é necessariamente concluído. Você deve verificar o resultado real do envio com base no valor de retorno desta operação. A saída real prevalece.\n- Você pode consultar as informações de execução do último dia. No máximo 1.000 entradas de informações de execução são retidas.\n- Ao consultar a primeira página de resultados de forma paginada, defina apenas MaxResults para limitar o número de entradas a serem retornadas. O valor NextToken retornado no resultado serve como token para consultar as páginas subsequentes. Ao consultar páginas subsequentes de forma paginada, defina NextToken com o valor obtido na resposta anterior e defina MaxResults para limitar o número de entradas a serem retornadas.

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

ecs:DescribeSendFileResults

get

Instância.

acs:ecs:{#regionId}:{#accountId}:instance/{#instanceId}

Nenhuma

Parâmetros da solicitação

Parâmetro	Tipo	Obrigatório	Descrição	Exemplo
RegionId	string	Sim	O ID da região da instância ECS. Você pode chamar DescribeRegions para consultar a lista de regiões mais recente.	cn-hangzhou
ResourceGroupId	string	Não	O ID do grupo de recursos ao qual a tarefa de envio de arquivo pertence. Após especificar este parâmetro, você também deve especificar ResourceGroupId ao enviar o arquivo. Este parâmetro permite filtrar os resultados de envio de arquivos por grupo de recursos.	rg-bp67acfmxazb4p****
InvokeId	string	Não	O ID de execução.	f-hz0jdfwd9f****
Name	string	Não	O nome do arquivo. Se você especificar este parâmetro, todos os registros de envio do arquivo com o nome especificado serão consultados.	test.txt
InstanceId	string	Não	O ID da instância. Se você especificar este parâmetro, todos os registros de envio de arquivos da instância especificada serão consultados.	i-hz0jdfwd9f****
PageNumber	integer	Não	Nota Este parâmetro está prestes a ser descontinuado. Use NextToken e MaxResults para realizar uma consulta paginada.	1
PageSize	integer	Não	Nota Este parâmetro está prestes a ser descontinuado. Use NextToken e MaxResults para realizar uma consulta paginada.	10
MaxResults	integer	Não	O número máximo de entradas por página para uma consulta paginada.\n\nValor máximo: 50.\n\nValor padrão: 10.	10
NextToken	string	Não	O token de paginação. Defina este parâmetro com o valor NextToken retornado na chamada de API anterior.	AAAAAdDWBF2
InvocationStatus	string	Não	O status geral de envio do arquivo. O status geral depende do status de execução comum de todas as instâncias de destino. Valores válidos:\n\n- Pending: O sistema está verificando ou enviando o arquivo. O status geral é Pending se o status de envio do arquivo de pelo menos uma instância for Pending.\n- Running: O arquivo está sendo enviado nas instâncias. O status geral é Running se o status de envio do arquivo de pelo menos uma instância for Running.\n- Success: O arquivo foi enviado. O status geral é Success se o status de envio do arquivo de todas as instâncias for Success.\n- Failed: Falha ao enviar o arquivo. O status geral é Failed se o status de envio do arquivo de todas as instâncias for Failed.\n- PartialFailed: O arquivo foi enviado em algumas instâncias, mas falhou em outras. O status geral é PartialFailed se o status de envio do arquivo de todas as instâncias for Success ou Failed.	Success
Tag	array<object>	Não	As tags.
	object	Não	As tags.
Key	string	Não	A chave da tag da tarefa de envio de arquivo. Valores válidos de N: 1 a 20. A chave da tag não pode ser uma string vazia.\n\nSe você usar uma única tag para filtrar recursos, a contagem de recursos com a tag especificada não pode exceder 1.000. Se você usar várias tags para filtrar recursos, a contagem de recursos que possuem todas as tags especificadas não pode exceder 1.000. Se a contagem de recursos exceder 1.000, chame a operação ListTagResources para consultar os recursos.\n\nA chave da tag pode ter até 64 caracteres e não pode começar com `aliyun` ou `acs:`. Não pode conter `http://` ou `https://`.	TestKey
Value	string	Não	O valor da tag da tarefa de envio de arquivo. Valores válidos de N: 1 a 20. O valor da tag pode ser uma string vazia.\n\nO valor da tag pode ter até 128 caracteres e não pode conter `http://` ou `https://`.	TestValue

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object
Invocations	object
Invocation	array<object>	Os registros de envio de arquivos.
	array<object>
Content	string	O conteúdo do arquivo.	#!/bin/bash echo "Current User is :" echo $(ps \| grep "$$" \| awk '{print $2}')
ContentType	string	O tipo de conteúdo do arquivo. Valores válidos:\n- PlainText: texto simples.\n- Base64: codificação Base64.	PlainText
CreationTime	string	A hora em que a tarefa de envio de arquivo foi criada. A hora é exibida no formato ISO 8601 em UTC.	2019-12-20T06:15:54Z
Description	string	A descrição.	Este é um arquivo de teste
FileGroup	string	O grupo de usuários do arquivo.	test
FileMode	string	As permissões do arquivo.	777
FileOwner	string	O proprietário do arquivo.	test
InvocationStatus	string	O status geral de envio do arquivo. O status geral depende do status de execução comum de todas as instâncias de destino. Valores válidos:\n\n- Pending: O sistema está verificando ou enviando o arquivo. O status geral é Pending se o status de envio do arquivo de pelo menos uma instância for Pending.\n- Running: O arquivo está sendo enviado nas instâncias. O status geral é Running se o status de envio do arquivo de pelo menos uma instância for Running.\n- Success: O status geral é Success se o status de envio do arquivo de todas as instâncias for Success.\n- Failed: O status geral é Failed se o status de envio do arquivo de todas as instâncias for Failed. O valor Failed é retornado se um ou mais dos seguintes status forem retornados para as instâncias:\n - Os parâmetros de arquivo especificados são inválidos e a verificação falhou (Invalid).\n - Falha ao enviar o arquivo para a instância (Aborted).\n - Falha ao criar o arquivo na instância (Failed).\n - O envio do arquivo expirou (Timeout).\n - Ocorreu uma exceção durante o envio do arquivo e a tarefa não pode continuar (Error).\n- PartialFailed: O arquivo foi enviado em algumas instâncias, mas falhou em outras. O status geral é PartialFailed se o status de envio do arquivo de todas as instâncias for Success ou Failed.	Success
InvokeId	string	O ID de execução.	f-hz0jdfwd9f****
InvokeInstances	object
InvokeInstance	array<object>	As instâncias de destino para o envio de arquivos.
	object
CreationTime	string	A hora em que a tarefa de envio de arquivo foi criada. A hora é exibida no formato ISO 8601 em UTC.	2019-12-20T06:15:54Z
ErrorCode	string	O código de erro para a falha no envio do arquivo. Valores válidos:\n\n- Empty: O arquivo foi enviado.\n- InstanceNotExists: A instância especificada não existe ou foi liberada.\n- InstanceReleased: A instância foi liberada durante o envio do arquivo.\n- InstanceNotRunning: A instância não estava no estado Running quando a tarefa de envio do arquivo foi criada.\n- AccountNotExists: A conta especificada não existe.\n- ClientNotRunning: O Cloud Assistant Agent não está em execução.\n- ClientNotResponse: O Cloud Assistant Agent não está respondendo.\n- ClientIsUpgrading: O Cloud Assistant Agent está sendo atualizado.\n- ClientNeedUpgrade: O Cloud Assistant Agent precisa ser atualizado.\n- DeliveryTimeout: O envio do arquivo expirou.\n- FileCreateFail: Falha ao criar o arquivo.\n- FileAlreadyExists: Já existe um arquivo com o mesmo nome no mesmo caminho.\n- FileContentInvalid: O conteúdo do arquivo é inválido.\n- FileNameInvalid: O nome do arquivo é inválido.\n- FilePathInvalid: O caminho do arquivo é inválido.\n- FileAuthorityInvalid: As permissões do arquivo são inválidas.\n- UserGroupNotExists: O grupo de usuários especificado para o envio do arquivo não existe.	InstanceNotExists
ErrorInfo	string	Os detalhes da falha no envio do arquivo ou da falha na execução. Valores válidos:\n\n- Empty: O arquivo foi enviado.\n- the specified instance does not exists: A instância especificada não existe ou foi liberada.\n- the specified instance has been released.: A instância foi liberada durante o envio do arquivo.\n- the instance is not running when create task: A instância não estava no estado Running quando a tarefa de envio do arquivo foi criada.\n- the specified account does not exists: A conta especificada não existe.\n- the aliyun service is not running on the instance: O Cloud Assistant Agent não está em execução.\n- the aliyun service in the instance does not response: O Cloud Assistant Agent não está respondendo.\n- the aliyun service in the instance is upgrading now: O Cloud Assistant Agent está sendo atualizado.\n- the aliyun service in the instance need upgrade: O Cloud Assistant Agent precisa ser atualizado.\n- the command delivery has been timeout: O envio do arquivo expirou.\n- the file creation is failed due to unknown error: Falha ao criar o arquivo.\n- the authority of file is invalid: As permissões do arquivo são inválidas.\n- File content is empty: O conteúdo do arquivo está vazio.\n- the content of file is invalid: O conteúdo do arquivo é inválido.\n- File already exists: Já existe um arquivo com o mesmo nome no mesmo caminho.\n- File name is invalid: O nome do arquivo é inválido.\n- File path is invalid: O caminho do arquivo é inválido.\n- Owner not exists: O usuário não existe.\n- Group not exists: O grupo de usuários não existe.\n- Mode is invalid: As configurações de permissão do arquivo são inválidas.	the instance is not running when create task
FinishTime	string	A hora em que a tarefa de envio foi concluída. A hora é exibida no formato ISO 8601 em UTC.	2019-12-20T06:15:54Z
InstanceId	string	O ID da instância.	i-uf614fhehhz****
InvocationStatus	string	O status de envio do arquivo em uma única instância. Valores válidos:\n- Pending: O sistema está verificando ou enviando o arquivo.\n- Invalid: Os parâmetros de arquivo especificados são inválidos e a verificação falhou.\n- Running: O arquivo está sendo enviado na instância.\n- Aborted: Falha ao enviar o arquivo para a instância.\n- Success: O arquivo foi enviado.\n- Failed: Falha ao criar o arquivo na instância.\n- Error: Ocorreu uma exceção durante o envio do arquivo e a tarefa não pode continuar.\n- Timeout: O envio do arquivo expirou.	Success
StartTime	string	A hora em que a tarefa de envio começou a ser executada na instância. A hora é exibida no formato ISO 8601 em UTC.	2019-12-20T06:15:54Z
UpdateTime	string	A hora em que o status da tarefa foi atualizado. A hora é exibida no formato ISO 8601 em UTC.	2019-12-20T06:15:54Z
Name	string	O nome do arquivo.	test.txt
Overwrite	string	Indica se a substituição é permitida.	false
Tags	object
Tag	array<object>	As informações de tag da tarefa de envio de arquivo.
	object	As informações de tag da tarefa de envio de arquivo.
TagKey	string	A chave da tag da tarefa de envio de arquivo.	owner
TagValue	string	O valor da tag da tarefa de envio de arquivo.	zhangsan
TargetDir	string	O caminho de destino.	/home/user
VmCount	integer	O número de instâncias de destino.	1
NextToken	string	O token de paginação retornado nesta chamada.	AAAAAdDWBF2
PageNumber	integer	O número da página dos resultados retornados.	1
PageSize	integer	O número de entradas por página.	10
RequestId	string	O ID da solicitação.	473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E
TotalCount	integer	O número total de scripts.	2

Exemplos

Resposta de sucesso

JSON formato

{
  "Invocations": {
    "Invocation": [
      {
        "Content": "#!/bin/bash  echo \"Current User is :\"  echo $(ps | grep \"$$\" | awk '{print $2}')",
        "ContentType": "PlainText",
        "CreationTime": "2019-12-20T06:15:54Z",
        "Description": "Este é um arquivo de teste",
        "FileGroup": "test",
        "FileMode": "777",
        "FileOwner": "test",
        "InvocationStatus": "Success",
        "InvokeId": "f-hz0jdfwd9f****",
        "InvokeInstances": {
          "InvokeInstance": [
            {
              "CreationTime": "2019-12-20T06:15:54Z",
              "ErrorCode": "InstanceNotExists",
              "ErrorInfo": "the instance is not running when create task",
              "FinishTime": "2019-12-20T06:15:54Z",
              "InstanceId": "i-uf614fhehhz****",
              "InvocationStatus": "Success",
              "StartTime": "2019-12-20T06:15:54Z",
              "UpdateTime": "2019-12-20T06:15:54Z"
            }
          ]
        },
        "Name": "test.txt",
        "Overwrite": "false",
        "Tags": {
          "Tag": [
            {
              "TagKey": "owner",
              "TagValue": "zhangsan"
            }
          ]
        },
        "TargetDir": "/home/user",
        "VmCount": 1
      }
    ]
  },
  "NextToken": "AAAAAdDWBF2",
  "PageNumber": 1,
  "PageSize": 10,
  "RequestId": "473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E",
  "TotalCount": 2
}

Códigos de erro

Código de status HTTP	Código de erro	Mensagem de erro	Descrição
400	RegionId.ApiNotSupported	The api is not supported in this region.	A operação de API não é suportada na região especificada. Verifique se o valor do parâmetro RegionId está correto.
400	NumberExceed.Tags	The Tags parameter number is exceed.	O número de tags excede o limite máximo. Você pode especificar até 20 tags para esta operação.
400	MissingParameter.TagKey	You must specify Tag.N.Key.	Especifique uma chave de tag.
400	Duplicate.TagKey	The Tag.N.Key contain duplicate key.	Existem chaves duplicadas nas tags. Certifique-se de que todas as chaves sejam únicas.
400	InvalidTagKey.Malformed	The specified Tag.n.Key is not valid.	O parâmetro de chave de tag especificado é inválido.
400	InvalidTagValue.Malformed	The specified Tag.n.Value is not valid.	O parâmetro de valor da tag especificado é inválido.
400	InvalidParam.PageNumber	The specified parameter is invalid.
400	InvalidParam.PageSize	The specified parameter is invalid.
400	InvalidParameter.NextToken	The specified parameter NextToken is not valid.
400	InvalidParameter.MaxResults	The specified parameter MaxResults is not valid.	O parâmetro MaxResults especificado é inválido.
500	InternalError.Dispatch	An error occurred when you dispatched the request.	Ocorreu um erro ao enviar a solicitação. Tente novamente mais tarde.
403	InvalidParameterCharacter	The specified parameter %s contains illegal characters.
403	Operation.Forbidden	The operation is not permitted.	A operação não é permitida.
404	InvalidRegionId.NotFound	The RegionId provided does not exist in our records.	O RegionId especificado não existe. Verifique se o produto está disponível nesta região.

Consulte Códigos de Erro para uma lista completa.

Notas de versão

Consulte Notas de Versão para uma lista completa.