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

Consulta os comandos que você criou manualmente ou os comandos públicos fornecidos pelo Alibaba Cloud.

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:DescribeCommands

get

*Command.

acs:swas-open:{#regionId}:{#accountId}:command/*

*Command.

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

Nenhuma

Parâmetros da solicitação

Parâmetro	Tipo	Obrigatório	Descrição	Exemplo
RegionId	string	Sim	O ID da região.	cn-hangzhou
CommandId	string	Não	O ID do comando.	c-sh02yh0932w****
Name	string	Não	O nome do comando. Não há suporte para correspondência aproximada.	testName
Provider	string	Sim	O provedor do comando público. Valores válidos: AlibabaCloud: consulta todos os comandos públicos fornecidos pelo Alibaba Cloud. User: consulta todos os comandos personalizados que você criou.	AlibabaCloud
Type	string	Não	O tipo de linguagem do comando. Valores válidos: RunBatScript: comando Bat para instâncias Windows. RunPowerShellScript: comando PowerShell para instâncias Windows. RunShellScript: comando Shell para instâncias Linux.	RunShellScript
PageNumber	string	Não	O número da página. Valor mínimo: 1. Valor padrão: 1.	1
PageSize	string	Não	O número de entradas por página para uma consulta paginada. Valor máximo: 50. Valor padrão: 10.	10
Tag	array<object>	Não	As tags do comando.
	object	Não	A tag.
Key	string	Não	A chave da tag do comando. A chave da tag deve ter de 1 a 64 caracteres. Valores válidos de N: 1 a 20.	TestKey
Value	string	Não	O valor da tag do comando. O valor da tag deve ter de 1 a 64 caracteres. Valores válidos de N: 1 a 20.	TestValue
ResourceGroupId	string	Não	O ID do grupo de recursos.	rg-aek2bti7cf7****

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object	Esquema da resposta.
RequestId	string	O ID da solicitação.	20758A-585D-4A41-A9B2-28DA8F4F****
TotalCount	integer	O número total de comandos.	10
PageNumber	integer	O número da página da lista de comandos.	1
PageSize	integer	O número de entradas por página.	10
Commands	array<object>	Os comandos.
	array<object>	A estrutura de informações do comando.
CommandId	string	O ID do comando.	c-gov1k1tqwi9****
Tags	array<object>	As tags do comando.
	object	A tag.
Key	string	A chave da tag do comando.	TestKey
Value	string	O valor da tag do comando.	TestValue
CreationTime	string	A hora em que o comando foi criado. A hora é exibida em UTC (Z) no formato AAAA-MM-DDThh:mm:ssZ.	2023-01-05T06:38:53Z
Name	string	O nome do comando.	testName
Provider	string	O provedor do comando.	User
Type	string	O tipo de comando.	RunShellScript
Timeout	integer	O período de tempo limite. Unidade: segundos.	60
Description	string	A descrição do comando.	testDescription
WorkingDir	string	O caminho de execução.	/home
CommandContent	string	O conteúdo do comando.	cat /etc/ssh/sshd_config
EnableParameter	boolean	Indica se os parâmetros personalizados estão ativados para o comando.	false
ParameterNames	array	A lista de nomes de parâmetros personalizados analisados a partir de CommandContent quando o comando foi criado. A lista é retornada no formato de lista. Se o recurso de parâmetro personalizado não estiver ativado, uma lista vazia será retornada.
	string	O parâmetro personalizado.	parameter1
ParameterDefinitions	array<object>	A lista de detalhes dos parâmetros personalizados.
	object	A estrutura de detalhes do parâmetro personalizado.
Required	boolean	Indica se o parâmetro personalizado é obrigatório. Valores válidos: true: Obrigatório. false: Não obrigatório. Valor padrão: false.	false
Description	string	A descrição do parâmetro personalizado.	Caminho do pacote de instalação do agente do Cloud Assistant
DefaultValue	string	O valor padrão do parâmetro personalizado.	https://aliyun-client-assist.oss-accelerate.aliyuncs.com/linux/aliyun_assist_latest.rpm
ParameterName	string	O nome do parâmetro personalizado.	DownloadUrl
PossibleValues	array	Os valores possíveis do parâmetro personalizado do tipo enumeração.
	string	O valor do parâmetro personalizado do tipo enumeração.	Linux
ResourceGroupId	string	O ID do grupo de recursos.	rg-aek2bti7cf7****

Exemplos

Resposta de sucesso

JSON formato

{
  "RequestId": "20758A-585D-4A41-A9B2-28DA8F4F****",
  "TotalCount": 10,
  "PageNumber": 1,
  "PageSize": 10,
  "Commands": [
    {
      "CommandId": "c-gov1k1tqwi9****",
      "Tags": [
        {
          "Key": "TestKey",
          "Value": "TestValue"
        }
      ],
      "CreationTime": "2023-01-05T06:38:53Z",
      "Name": "testName",
      "Provider": "User",
      "Type": "RunShellScript",
      "Timeout": 60,
      "Description": "testDescription",
      "WorkingDir": "/home",
      "CommandContent": "cat /etc/ssh/sshd_config",
      "EnableParameter": false,
      "ParameterNames": [
        "parameter1"
      ],
      "ParameterDefinitions": [
        {
          "Required": false,
          "Description": "命令助手Agent安装包路径",
          "DefaultValue": "https://aliyun-client-assist.oss-accelerate.aliyuncs.com/linux/aliyun_assist_latest.rpm",
          "ParameterName": "DownloadUrl",
          "PossibleValues": [
            "Linux"
          ]
        }
      ],
      "ResourceGroupId": "rg-aek2bti7cf7****"
    }
  ]
}

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.