RunCommand - Simple Application Server: Central de Documentação do Alibaba Cloud

Executa um comando em um servidor de aplicativo simples.

Descrição da operação

O Assistente de Comando é uma ferramenta automatizada de O&M projetada para servidores de aplicativo simples. Você pode executar comandos (Shell, PowerShell e Bat) em instâncias de servidor de aplicativo simples a partir do console para gerenciamento de operações, sem precisar fazer login nas instâncias.

Para usar o Assistente de Comando, as seguintes condições devem ser atendidas:

A instância do servidor de aplicativo simples deve estar no estado Running.
O Cloud Assistant Agent deve estar instalado. O Cloud Assistant Agent é instalado nas instâncias do servidor de aplicativo simples por padrão. Se você o desinstalou manualmente, reinstale-o. Para obter mais informações, consulte Instalar o Cloud Assistant Agent.

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

swas-open:RunCommand

create

*Comando.

acs:swas-open:{#regionId}:{#accountId}:{#CommandId}

Nenhuma

Parâmetros da solicitação

Parâmetro	Tipo	Obrigatório	Descrição	Exemplo
CommandContent	string	Sim	O conteúdo do comando. Observe os seguintes itens: Defina `EnableParameter=true` para ativar o recurso de parâmetro personalizado no conteúdo do comando: Defina parâmetros personalizados colocando-os entre `{{}}`. Espaços e quebras de linha antes e depois do nome do parâmetro dentro de `{{}}` são ignorados. O número de parâmetros personalizados não pode exceder 20. Os nomes dos parâmetros personalizados podem conter apenas letras (a-z, A-Z), dígitos (0-9), hifens (-) e sublinhados (_). Outros caracteres não são suportados. Os nomes dos parâmetros não diferenciam maiúsculas de minúsculas. Um único nome de parâmetro personalizado não pode exceder 64 bytes.	ifconfig -s
WorkingDir	string	Não	O caminho de execução personalizado do comando. Caminhos padrão: Instâncias Linux: O caminho de execução padrão é o diretório /root do usuário root. Instâncias Windows: O caminho de execução padrão é o diretório C:\Windows\system32.	/root
RegionId	string	Sim	O ID da região. Você pode chamar ListRegions para consultar a lista de regiões mais recente.	cn-hangzhou
Timeout	integer	Não	O período de tempo limite para a execução do comando na instância do servidor. Unidade: segundos. Quando uma tarefa de execução de comando atinge o tempo limite, o Assistente de Comando encerra forçosamente o processo da tarefa. Valores válidos: 10 a 86400 (24 horas). Valor padrão: 60.	60
Type	string	Sim	O tipo de linguagem do comando. Valores válidos: RunBatScript: Comandos Bat para instâncias Windows. RunPowerShellScript: Comandos PowerShell para instâncias Windows. RunShellScript: Comandos Shell para instâncias Linux.	RunShellScript
EnableParameter	boolean	Não	Especifica se o comando contém parâmetros personalizados. Valor padrão: false.	false
Parameters	object	Não	Os pares chave-valor de parâmetros personalizados a serem transmitidos quando o comando contém parâmetros personalizados. Por exemplo, se o conteúdo do comando for `echo {{name}}`, você pode usar o parâmetro `Parameters` para transmitir o par chave-valor `{"name":"Jack"}`. O parâmetro personalizado substitui automaticamente o valor da variável `name`, e o comando real executado é `echo Jack`. O número de parâmetros personalizados varia de 0 a 20. Observe os seguintes itens: As chaves não podem ser strings vazias e podem conter até 64 caracteres. Os valores podem ser strings vazias. O conjunto de nomes de parâmetros personalizados deve ser um subconjunto do conjunto de parâmetros definido quando o comando foi criado. Para parâmetros que não são transmitidos, você pode usar strings vazias como substitutos. Valor padrão: vazio, o que indica que este parâmetro não está definido para desativar os parâmetros personalizados.	{"name":"Jack", "accessKey":"LTAI****************"}
WorkingUser	string	Não	O usuário que você deseja usar para executar o comando na instância do servidor de aplicativo simples. Recomendamos que você use um usuário comum para executar comandos e reduzir os riscos de segurança. Valores padrão: root: Em instâncias Linux, os comandos são executados como o usuário root por padrão. system: Em instâncias Windows, os comandos são executados como o usuário system por padrão.	root
WindowsPasswordName	string	Não	O nome da senha do usuário que executa o comando em uma instância Windows. Se você deseja executar um comando como um usuário não padrão (System) em uma instância Windows, deve especificar tanto WorkingUser quanto este parâmetro. Para reduzir o risco de vazamento de senha, armazene a senha em texto simples no repositório de parâmetros do CloudOps Orchestration Service e transmita apenas o nome da senha aqui.	axtSecretPassword
InstanceId	string	Sim	O ID da instância do servidor de aplicativo simples.	ace0706b2ac4454d984295a94213****
Name	string	Sim	O nome da execução do comando.	testName

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object	Esquema da resposta.
RequestId	string	O ID da solicitação.	473469C7-AA6F-4DC5-B3DB-A3DC0DE3****
InvokeId	string	O ID de execução do comando.	t-hz02p9545t6****

Exemplos

Resposta de sucesso

JSON formato

{
  "RequestId": "473469C7-AA6F-4DC5-B3DB-A3DC0DE3****",
  "InvokeId": "t-hz02p9545t6****"
}

Códigos de erro

Consulte Códigos de Erro para uma lista completa.

Notas de versão

Consulte Notas de Versão para uma lista completa.