Consulta a lista de execuções e o status dos comandos do Cloud Assistant.
Descrição da operação
-
A execução de um comando não garante a execução bem-sucedida ou os resultados esperados. Verifique os resultados reais da execução na resposta da API. A saída real prevalece.
-
Você pode consultar as informações de execução dos últimos 30 dias. No máximo 10.000 registros de execução são retidos.
-
Você pode se inscrever nos eventos de status de tarefa do Cloud Assistant para obter os resultados das tarefas por meio de eventos. Isso evita consultas frequentes e melhora a eficiência.
-
Ao consultar a primeira página de forma paginada, especifique apenas MaxResults para limitar o número de entradas retornadas. O valor NextToken na resposta é usado como o token para consultar a próxima página. Ao consultar as páginas subsequentes de forma paginada, defina o parâmetro NextToken com o valor NextToken obtido da resposta anterior e especifique MaxResults para limitar o número de entradas retornadas.
-
Diferenças entre DescribeInvocations e DescribeInvocationResults:
- Quando várias instâncias são especificadas em uma única chamada RunCommand ou InvokeCommand:
DescribeInvocations retorna o status de execução da tarefa em cada instância e o status agregado da tarefa em várias instâncias.
DescribeInvocationResults retorna apenas o status de execução individual em cada instância e não inclui o status agregado em várias instâncias.
- Quando uma única instância é especificada em uma única chamada RunCommand ou InvokeCommand:
DescribeInvocations e DescribeInvocationResults têm pouca diferença e são totalmente intercambiáveis.
Para visualizar os detalhes de execução de cada execução para tarefas agendadas (periódicas) ou tarefas que são executadas automaticamente na inicialização (RepeatMode=Period, EveryReboot), você só pode usar DescribeInvocationResults para consultar registros de execução históricos (especificando IncludeHistory=true). DescribeInvocations retorna apenas o status mais recente da tarefa.
Para visualizar o conteúdo e os parâmetros de um comando, apenas DescribeInvocations retorna CommandContent.
- Quando várias instâncias são especificadas em uma única chamada RunCommand ou InvokeCommand:
Experimente agora
Testar
Autorização RAM
|
Ação |
Nível de acesso |
Tipo de recurso |
Chave de condição |
Ação dependente |
|
ecs:DescribeInvocations |
get |
Instance
Command
|
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 para a execução do comando. Se você especificar este parâmetro, poderá filtrar os resultados da execução do comando pelo ID do grupo de recursos especificado. |
rg-bp67acfmxazb4p**** |
| InvokeId |
string |
Não |
O ID de execução do comando. |
t-hz0jdfwd9f**** |
| CommandId |
string |
Não |
O ID do comando. Você pode chamar a operação DescribeCommands para consultar todos os IDs de comando disponíveis. |
c-hz0jdfwcsr**** |
| CommandName |
string |
Não |
O nome do comando. Este parâmetro não entra em vigor se o parâmetro InstanceId também for especificado. |
CommandTestName |
| CommandType |
string |
Não |
O tipo de comando. Valores válidos:
|
RunShellScript |
| Timed |
boolean |
Não |
Especifica se os comandos consultados serão executados automaticamente no futuro. Valores válidos:
Valor padrão: false. |
true |
| InvokeStatus |
string |
Não |
O status geral de execução do comando. O status geral de execução depende do status de execução combinado de uma ou mais instâncias na execução. Valores válidos:
|
Finished |
| InstanceId |
string |
Não |
O ID da instância. Se você especificar este parâmetro, o sistema consultará todos os registros de execução de comando da instância. |
i-bp1i7gg30r52z2em**** |
| ContentEncoding |
string |
Não |
O formato de codificação dos campos CommandContent e Output na resposta. Valores válidos:
Valor padrão: Base64. |
PlainText |
| IncludeOutput |
boolean |
Não |
Especifica se a saída da execução do comando deve ser retornada na resposta. Valores válidos:
Valor padrão: false. |
false |
| PageNumber |
integer |
Não |
Nota
Este parâmetro será descontinuado em breve. Recomendamos que você use NextToken e MaxResults para paginação em uma consulta paginada. |
1 |
| PageSize |
integer |
Não |
Nota
Este parâmetro será descontinuado em breve. Recomendamos que você use NextToken e MaxResults para paginação em uma consulta paginada. |
10 |
| MaxResults |
integer |
Não |
O número máximo de entradas a serem retornadas por página durante a 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 |
| RepeatMode |
string |
Não |
O modo de execução do comando. Este parâmetro não entra em vigor se o parâmetro InstanceId também for especificado. Valores válidos:
Valor padrão: vazio. Um valor vazio indica que todos os modos de execução são consultados. |
Once |
| 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. A chave da tag não pode ser uma string vazia. Se você usar uma única tag para filtrar recursos, a contagem de recursos sob esta tag não pode exceder 1.000. Se você usar várias tags para filtrar recursos, a contagem de recursos que possuem várias tags anexadas não pode 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 aliyun ou acs: e não pode conter http:// ou https://. |
TestKey |
| Value |
string |
Não |
O valor da tag da execução do comando. Valores válidos de N: 1 a 20. O valor da tag pode ser uma string vazia. O 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> |
A matriz de registros de execução de comando. |
|
|
array<object> |
A hora em que a tarefa foi criada. |
||
| CommandContent |
string |
O conteúdo do comando.
|
cnBtIC1xYSB8IGdyZXAgdnNm**** |
| CommandDescription |
string |
A descrição do comando. |
testDescription |
| CommandId |
string |
O ID do comando. |
c-hz0jdfwcsr**** |
| CommandName |
string |
O nome do comando. |
CommandTestName |
| CommandType |
string |
O tipo de comando. |
RunShellScript |
| ContainerId |
string |
O ID do contêiner. |
ab141ddfbacfe02d9dbc25966ed971536124527097398d419a6746873fea**** |
| ContainerName |
string |
O nome do contêiner. |
test-container |
| CreationTime |
string |
A hora em que a tarefa foi criada. A hora segue o padrão ISO 8601 e é exibida em UTC. |
2020-01-19T09:15:46Z |
| Frequency |
string |
O agendamento de execução do comando agendado. |
0 */20 * * * * |
| InvocationStatus |
string |
O status geral de execução do comando. O status geral de execução depende do status de execução combinado de todas as instâncias na invocação atual. Valores válidos:
Nota
O parâmetro de resposta InvokeStatus tem um significado semelhante, mas recomendamos que você verifique este parâmetro. |
Running |
| InvokeId |
string |
O ID de execução do comando. |
t-hz0jdfwd9f**** |
| InvokeInstances |
object |
||
| InvokeInstance |
array<object> |
A coleção de instâncias de destino para a execução. |
|
|
object |
O status de execução. |
||
| CreationTime |
string |
A hora em que a execução do comando começou. A hora segue o padrão ISO 8601 e é exibida em UTC. |
2019-12-20T06:15:54Z |
| 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 entrega do comando ou falha de execução. Valores válidos:
|
InstanceNotExists |
| ErrorInfo |
string |
Os detalhes da entrega do comando ou falha de execução. Valores válidos:
|
the specified instance does not exists |
| ExitCode |
integer |
O código de saída do processo do comando. Valores válidos:
|
0 |
| FinishTime |
string |
A hora em que o processo do comando foi concluído. A hora segue o padrão ISO 8601 e é exibida em UTC. |
2019-12-20T06:15:56Z |
| InstanceId |
string |
O ID da instância. |
i-bp1i7gg30r52z2em**** |
| InstanceInvokeStatus |
string |
O status de execução do comando em uma única instância. Nota
Não recomendamos que você verifique este parâmetro. Recomendamos que você verifique o parâmetro InvocationStatus. |
Finished |
| InvocationStatus |
string |
O status de execução do comando em uma única instância. Valores válidos:
|
Success |
| 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 do comando. Valores válidos:
|
Finished |
| OssOutputUri |
string |
O URI do arquivo para o qual a saída 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 |
A saída do comando.
|
OutPutTestmsg |
| 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 segue o padrão ISO 8601 e é exibida em 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 segue o padrão ISO 8601 e é exibida em UTC. |
2020-01-19T09:15:47Z |
| Timed |
boolean |
Especifica se o comando consultado será executado automaticamente no futuro. |
false |
| UpdateTime |
string |
A hora em que o status do comando foi atualizado. A hora segue o padrão ISO 8601 e é exibida em UTC. |
2020-01-19T09:15:47Z |
| InvokeStatus |
string |
O status geral de execução do comando. Nota
Não recomendamos que você verifique este parâmetro. Recomendamos que você verifique o parâmetro InvocationStatus. |
Finished |
| Launcher |
string |
O 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 entrega do OSS para a saída do comando. |
oss://testBucket/testPrefix |
| Parameters |
string |
Os parâmetros personalizados no comando. |
{} |
| RepeatMode |
string |
O modo de execução do comando. Valores válidos:
|
Once |
| Tags |
object |
||
| Tag |
array<object> |
As tags da execução do comando. |
|
|
object |
As tags 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 para interromper a tarefa, seja manualmente ou devido a um tempo limite de execução. Valores válidos:
|
ProcessTree |
| Timed |
boolean |
Especifica se o comando consultado será executado automaticamente no futuro. |
false |
| Timeout |
integer |
O período máximo de tempo limite para a execução do comando na instância ECS. Unidade: segundos. Se o comando não puder ser executado por algum motivo, ocorrerá um tempo limite. Após um tempo limite, o processo do comando é encerrado à força, o que significa que o PID do comando é cancelado. |
60 |
| Username |
string |
O nome de usuário usado para executar o comando na instância ECS. |
test |
| WorkingDir |
string |
O caminho de execução do comando. |
/home/ |
| NextToken |
string |
O token de paginação retornado pela chamada atual. |
AAAAAdDWBF2 |
| PageNumber |
integer |
O número da página do resultado da consulta. |
1 |
| PageSize |
integer |
O número de entradas por página. |
10 |
| RequestId |
string |
O ID da solicitação. |
473469C7-AA6F-4DC5-B3DB-A3DC0DE3**** |
| TotalCount |
integer |
O número total de comandos. Nota
Quando você usa os parâmetros MaxResults e NextToken para paginação, o valor TotalCount retornado não tem significado. |
1 |
Exemplos
Resposta de sucesso
JSON formato
{
"Invocations": {
"Invocation": [
{
"CommandContent": "cnBtIC1xYSB8IGdyZXAgdnNm****",
"CommandDescription": "testDescription",
"CommandId": "c-hz0jdfwcsr****",
"CommandName": "CommandTestName",
"CommandType": "RunShellScript",
"ContainerId": "ab141ddfbacfe02d9dbc25966ed971536124527097398d419a6746873fea****",
"ContainerName": "test-container",
"CreationTime": "2020-01-19T09:15:46Z",
"Frequency": "0 */20 * * * *",
"InvocationStatus": "Running",
"InvokeId": "t-hz0jdfwd9f****",
"InvokeInstances": {
"InvokeInstance": [
{
"CreationTime": "2019-12-20T06:15:54Z",
"Dropped": 0,
"ErrorCode": "InstanceNotExists",
"ErrorInfo": "the specified instance does not exists",
"ExitCode": 0,
"FinishTime": "2019-12-20T06:15:56Z",
"InstanceId": "i-bp1i7gg30r52z2em****",
"InstanceInvokeStatus": "Finished",
"InvocationStatus": "Success",
"OssOutputErrorCode": "CloudAssistant.UnsupportedInvocationStatus",
"OssOutputErrorInfo": "The invocation status does not support output delivery.",
"OssOutputStatus": "Finished",
"OssOutputUri": "oss://testBucket/testPrefix/output.txt",
"Output": "OutPutTestmsg",
"Repeats": 0,
"StartTime": "2019-12-20T06:15:55Z",
"StopTime": "2020-01-19T09:15:47Z",
"Timed": false,
"UpdateTime": "2020-01-19T09:15:47Z"
}
]
},
"InvokeStatus": "Finished",
"Launcher": "python3 -u {{ACS::ScriptFileName|Ext(\".py\")}}",
"OssOutputDelivery": "oss://testBucket/testPrefix",
"Parameters": "{}",
"RepeatMode": "Once",
"Tags": {
"Tag": [
{
"TagKey": "owner",
"TagValue": "zhangsan"
}
]
},
"TerminationMode": "ProcessTree",
"Timed": false,
"Timeout": 60,
"Username": "test",
"WorkingDir": "/home/"
}
]
},
"NextToken": "AAAAAdDWBF2",
"PageNumber": 1,
"PageSize": 10,
"RequestId": "473469C7-AA6F-4DC5-B3DB-A3DC0DE3****",
"TotalCount": 1
}
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. |
| 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.