Consulta os resultados da execução de um ou mais comandos do Cloud Assistant, que são os resultados reais da execução nas instâncias ECS.
Descrição da operação
Descrição da operação
-
Após executar um comando, ele pode não ser executado com sucesso ou não produzir os resultados esperados. Você deve chamar esta operação para consultar de forma paginada os resultados reais da execução. A saída real prevalece.
-
Você pode consultar as informações de execução dos últimos 30 dias. Um máximo de 10.000 registros de execução pode ser retido.
-
Você pode assinar os eventos de status de tarefa do Cloud Assistant para obter os resultados das tarefas por meio de eventos. Isso evita polling frequente e melhora a eficiência.
-
Ao consultar a primeira página, você só precisa definir MaxResults para limitar o número de entradas retornadas. O valor NextToken na resposta é usado como token para consultar de forma paginada a próxima página. Ao consultar a próxima página, defina o parâmetro NextToken com o valor NextToken obtido da resposta anterior e defina MaxResults para limitar o número de entradas retornadas.
-
Diferenças entre DescribeInvocations e DescribeInvocationResults:
- Quando uma chamada RunCommand ou InvokeCommand especifica várias instâncias:
Você pode usar DescribeInvocations para obter o status de execução da tarefa em cada instância e o status agregado da tarefa em várias instâncias.
Você pode usar DescribeInvocationResults para obter apenas o status de execução individual em cada instância, que não inclui o status agregado em várias instâncias.
- Quando uma chamada RunCommand ou InvokeCommand especifica uma única instância:
Há pouca diferença entre DescribeInvocations e DescribeInvocationResults. Eles são totalmente intercambiáveis.
Quando você precisa visualizar os registros de execução de uma tarefa agendada ou de uma tarefa executada automaticamente na inicialização (RepeatMode=Period, EveryReboot), você só pode usar DescribeInvocationResults para consultar de forma paginada os registros históricos de execução (você deve especificar IncludeHistory=true). DescribeInvocations retorna apenas o status mais recente da tarefa.
Quando você precisa visualizar o conteúdo e os parâmetros do comando, apenas DescribeInvocations retorna CommandContent.
- Quando uma chamada RunCommand ou InvokeCommand especifica várias instâncias:
Experimente agora
Testar
Autorização RAM
|
Ação |
Nível de acesso |
Tipo de recurso |
Chave de condição |
Ação dependente |
|
ecs:DescribeInvocationResults |
get |
Command
Instance
|
Nenhuma | Nenhuma |
Parâmetros da solicitação
|
Parâmetro |
Tipo |
Obrigatório |
Descrição |
Exemplo |
| RegionId |
string |
Sim |
O ID da região. Você pode chamar a operação 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 execução do comando pertence. Após especificar este parâmetro, você deve especificar ResourceGroupId ao executar o comando. Isso permite filtrar os resultados de execução do comando correspondentes. |
rg-bp67acfmxazb4p**** |
| InvokeId |
string |
Não |
O ID de execução do comando. Você pode chamar a operação DescribeInvocations para consultar o InvokeId. |
t-hz0jdfwd9f**** |
| InstanceId |
string |
Não |
O ID da instância. |
i-bp1i7gg30r52z2em**** |
| CommandId |
string |
Não |
O ID do comando. |
c-hz0jdfwcsr**** |
| InvokeRecordStatus |
string |
Não |
O status de execução do comando. Valores válidos:
|
Running |
| IncludeHistory |
boolean |
Não |
Especifica se deve retornar os registros históricos de execuções de comandos agendados. Valores válidos:
Valor padrão: false. |
false |
| ContentEncoding |
string |
Não |
O formato de codificação dos campos CommandContent e Output na resposta. Valores válidos:
Valor padrão: Base64. |
PlainText |
| PageNumber |
integer |
Não |
Nota
Este parâmetro será descontinuado em breve. Recomendamos que você use NextToken e MaxResults para realizar operações de paginação. |
1 |
| PageSize |
integer |
Não |
Nota
Este parâmetro será descontinuado em breve. Recomendamos que você use NextToken e MaxResults para realizar operações de paginação. |
1 |
| MaxResults |
integer |
Não |
O número máximo de entradas por página para paginação. Valor máximo: 50. Valor padrão: 10. |
10 |
| NextToken |
string |
Não |
O token de paginação. Defina o valor como o valor NextToken retornado da chamada de API anterior. |
AAAAAdDWBF2 |
| Tag |
array<object> |
Não |
A lista de tags. |
|
|
object |
Não |
A lista de tags. |
||
| Key |
string |
Não |
A chave da tag do comando a ser executado. Valores válidos de N: 1 a 20. Se você especificar este parâmetro, ele não poderá ser uma string vazia. Se você usar uma única tag para filtrar recursos, a contagem de recursos sob a tag não poderá exceder 1.000. Se você usar várias tags para filtrar recursos, a contagem de recursos que anexaram várias tags não poderá exceder 1.000. Se a contagem de recursos exceder 1.000, você deve chamar a operação ListTagResources para consultar os recursos. A chave da tag pode ter até 64 caracteres. Não pode começar com |
TestKey |
| Value |
string |
Não |
O valor da tag da execução do comando. Valores válidos de N: 1 a 20. Este parâmetro pode ser uma string vazia. O valor da tag pode ter até 128 caracteres e não pode conter |
TestValue |
Elementos de resposta
|
Elemento |
Tipo |
Descrição |
Exemplo |
|
object |
|||
| Invocation |
object |
A coleção de resultados da execução do comando. |
|
| InvocationResults |
object |
||
| InvocationResult |
array<object> |
O conjunto de resultados da execução do comando. |
|
|
array<object> |
|||
| CommandId |
string |
O ID do comando. |
c-hz0jdfwcsr**** |
| ContainerId |
string |
O ID do contêiner. |
ab141ddfbacfe02d9dbc25966ed971536124527097398d419a6746873fea**** |
| ContainerName |
string |
O nome do contêiner. |
test-container |
| Dropped |
integer |
O comprimento do texto que é truncado e descartado quando o comprimento do texto no campo Output excede 24 KB. |
0 |
| ErrorCode |
string |
O código de erro para a falha ao entregar ou executar o comando. Valores válidos:
|
InstanceNotExists |
| ErrorInfo |
string |
Os detalhes sobre a falha ao entregar ou executar o comando. Valores válidos:
|
the specified instance does not exists |
| ExitCode |
integer |
O código de saída do comando.
|
0 |
| FinishedTime |
string |
A hora em que a execução do comando foi concluída. Se a execução do comando expirar, a hora de conclusão é calculada adicionando o valor Timeout ao valor StartTime. A hora está no formato ISO 8601 e fuso horário UTC. |
2019-12-20T06:15:56Z |
| InstanceId |
string |
O ID da instância. |
i-bp1i7gg30r52z2em**** |
| InvocationStatus |
string |
O status de execução do comando em uma única instância. Valores válidos:
|
Success |
| InvokeId |
string |
O ID de execução do comando. |
t-hz0jdfwd9f**** |
| InvokeRecordStatus |
string |
O status de execução do comando. Valores válidos:
|
Running |
| Launcher |
string |
O programa inicializador para a execução do script. O comprimento não pode exceder 1 KB. |
python3 -u {{ACS::ScriptFileName|Ext(".py")}} |
| OssOutputDelivery |
string |
A configuração de envio de dados do OSS para a saída da execução do comando. |
oss://testBucket/testPrefix |
| OssOutputErrorCode |
string |
O código de erro retornado quando a entrega falha. Este parâmetro é retornado apenas quando OssOutputStatus é Failed. Valores válidos:
|
CloudAssistant.UnsupportedInvocationStatus |
| OssOutputErrorInfo |
string |
Os detalhes do erro retornados quando a entrega falha. Este parâmetro é retornado apenas quando OssOutputStatus é Failed. |
The invocation status does not support output delivery. |
| OssOutputStatus |
string |
O status de entrega da saída da execução do comando. Valores válidos:
|
Finished |
| OssOutputUri |
string |
O URI do arquivo para o qual a saída da execução do comando é entregue no OSS. Este campo é uma string vazia quando a entrega falha ou está em andamento. |
oss://testBucket/testPrefix/output.txt |
| Output |
string |
As informações de saída após a execução do comando.
|
MTU6MzA6MDEK |
| Repeats |
integer |
O número de vezes que o comando foi executado na instância.
|
0 |
| StartTime |
string |
A hora em que o comando começou a ser executado na instância. A hora está no formato ISO 8601 e fuso horário UTC. |
2019-12-20T06:15:55Z |
| StopTime |
string |
A hora em que a operação StopInvocation foi chamada para interromper a execução do comando. A hora está no formato ISO 8601 e fuso horário UTC. |
2020-01-19T09:15:47Z |
| Tags |
object |
||
| Tag |
array<object> |
As informações de tag da execução do comando. |
|
|
object |
As informações de tag da execução do comando. |
||
| TagKey |
string |
A chave da tag da execução do comando. |
owner |
| TagValue |
string |
O valor da tag da execução do comando. |
zhangsan |
| TerminationMode |
string |
O modo usado quando a tarefa é interrompida manualmente ou interrompida devido ao tempo limite de execução. Valores válidos:
|
ProcessTree |
| Username |
string |
O nome de usuário usado para executar o comando na instância ECS. |
test |
| NextToken |
string |
O token de paginação retornado pela chamada atual. |
AAAAAdDWBF2 |
| PageNumber |
integer |
O número da página atual. |
1 |
| PageSize |
integer |
O número de linhas por página para paginação. |
1 |
| TotalCount |
integer |
O número total de comandos. Nota
Ao usar os parâmetros MaxResults e NextToken para paginação, o valor do parâmetro TotalCount retornado não tem significado. |
1 |
| RequestId |
string |
O ID da solicitação. |
473469C7-AA6F-4DC5-B3DB-A3DC0DE***** |
Exemplos
Resposta de sucesso
JSON formato
{
"Invocation": {
"InvocationResults": {
"InvocationResult": [
{
"CommandId": "c-hz0jdfwcsr****",
"ContainerId": "ab141ddfbacfe02d9dbc25966ed971536124527097398d419a6746873fea****",
"ContainerName": "test-container",
"Dropped": 0,
"ErrorCode": "InstanceNotExists",
"ErrorInfo": "the specified instance does not exists",
"ExitCode": 0,
"FinishedTime": "2019-12-20T06:15:56Z",
"InstanceId": "i-bp1i7gg30r52z2em****",
"InvocationStatus": "Success",
"InvokeId": "t-hz0jdfwd9f****",
"InvokeRecordStatus": "Running",
"Launcher": "python3 -u {{ACS::ScriptFileName|Ext(\".py\")}}",
"OssOutputDelivery": "oss://testBucket/testPrefix",
"OssOutputErrorCode": "CloudAssistant.UnsupportedInvocationStatus",
"OssOutputErrorInfo": "The invocation status does not support output delivery.",
"OssOutputStatus": "Finished",
"OssOutputUri": "oss://testBucket/testPrefix/output.txt",
"Output": "MTU6MzA6MDEK",
"Repeats": 0,
"StartTime": "2019-12-20T06:15:55Z",
"StopTime": "2020-01-19T09:15:47Z",
"Tags": {
"Tag": [
{
"TagKey": "owner",
"TagValue": "zhangsan"
}
]
},
"TerminationMode": "ProcessTree",
"Username": "test"
}
]
},
"NextToken": "AAAAAdDWBF2",
"PageNumber": 1,
"PageSize": 1,
"TotalCount": 1
},
"RequestId": "473469C7-AA6F-4DC5-B3DB-A3DC0DE*****"
}
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. | Esta 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. Esta operação suporta no máximo 20 tags. |
| 400 | Duplicate.TagKey | The Tag.N.Key contain duplicate key. | Existem chaves duplicadas nas tags. Certifique-se de que as chaves sejam exclusivas. |
| 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 está incorreto. |
| 400 | MissingParameter.TagKey | You must specify Tag.N.Key. | Especifique uma chave de tag. |
| 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. |
| 500 | ServiceUnavailable | The request has failed due to a temporary failure of the server. | |
| 500 | InternalError | The request processing has failed due to some unknown error. | |
| 403 | InvalidParameterCharacter | The specified parameter %s contains illegal characters. | |
| 403 | Operation.Forbidden | The operation is not permitted. | A operação não é permitida. |
| 403 | RequestDenied.WAFIntercepted | Request denied by WAF security protection. | A solicitação foi bloqueada pela proteção de segurança do Web Application Firewall (WAF). |
| 404 | InvalidRegionId.NotFound | The RegionId provided does not exist in our records. | O RegionId especificado não existe. Verifique se o serviço está disponível na região. |
| 404 | InvalidCommandId.NotFound | The specified commandId does not exist |
Consulte Códigos de Erro para uma lista completa.
Notas de versão
Consulte Notas de Versão para uma lista completa.