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

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

Descrição da operação

Se você especificar apenas os parâmetros Action e RegionId sem outros parâmetros de solicitação, todos os comandos disponíveis (CommandId) que você criou manualmente serão consultados por padrão.
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 na resposta serve como o token para consultar as páginas subsequentes. Ao consultar as páginas subsequentes de forma paginada, defina NextToken com o valor obtido da 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:DescribeCommands

get

Command.

acs:ecs:{#regionId}:{#accountId}:command/*

Command.

acs:ecs:{#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. Você pode chamar DescribeRegions para consultar a lista de regiões mais recente.	cn-hangzhou
Provider	string	Não	O provedor do comando público. A lista a seguir descreve os valores válidos deste parâmetro: Se você não especificar este parâmetro, todos os comandos do Cloud Assistant que você criou manualmente serão consultados por padrão. Se você definir este parâmetro como AlibabaCloud, todos os comandos públicos fornecidos pelo Alibaba Cloud serão consultados. Se você definir este parâmetro como um provedor de comando público específico, todos os comandos públicos fornecidos pelo provedor serão consultados. Exemplos: Se você definir Provider=AlibabaCloud.ECS.GuestOS, todos os comandos públicos fornecidos por AlibabaCloud.ECS.GuestOS serão consultados. Se você definir Provider=AlibabaCloud.ECS.GuestOSDiagnose, todos os comandos públicos fornecidos por AlibabaCloud.ECS.GuestOSDiagnose serão consultados.	AlibabaCloud
CommandId	string	Não	O ID do comando.	c-hz01272yr52****
Name	string	Não	O nome do comando. Se você especificar o parâmetro Provider para consultar comandos públicos, a pesquisa aproximada é suportada por padrão. Se você não especificar o parâmetro Provider para consultar comandos privados, a pesquisa aproximada é suportada. Por exemplo, insira command* para pesquisar todos os comandos cujos nomes começam com command, insira command para pesquisar todos os comandos cujos nomes terminam com command, ou insira command* para pesquisar todos os comandos cujos nomes contêm command.	testName
Description	string	Não	A descrição do comando. Se você especificar o parâmetro Provider para consultar comandos públicos, a pesquisa aproximada é suportada por padrão. Se você não especificar o parâmetro Provider para consultar comandos privados, a pesquisa aproximada é suportada. Por exemplo, insira test* para pesquisar todos os comandos cujas descrições começam com test, insira test para pesquisar todos os comandos cujas descrições terminam com test, ou insira test* para pesquisar todos os comandos cujas descrições contêm test.	testDescription
Type	string	Não	O tipo do comando. Valores válidos: RunBatScript: script Bat que é executado em instâncias Windows. RunPowerShellScript: script PowerShell que é executado em instâncias Windows. RunShellScript: script de shell que é executado em instâncias Linux.	RunShellScript
ContentEncoding	string	Não	O modo de codificação dos campos CommandContent e Output na resposta. Valores válidos: PlainText: retorna o conteúdo e a saída originais do script. Base64: retorna o conteúdo e a saída do script codificados em Base64. Valor padrão: Base64.	PlainText
PageNumber	integer	Não	Nota Este parâmetro está prestes a ser descontinuado. Use NextToken e MaxResults para realizar operações de paginação.	1
PageSize	integer	Não	Nota Este parâmetro está prestes a ser descontinuado. Use NextToken e MaxResults para realizar operações de paginação.	10
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 este parâmetro com o valor NextToken retornado na chamada de API anterior.	AAAAAdDWBF2
Latest	boolean	Não	Especifica se deve ser consultada apenas a versão mais recente dos comandos públicos quando os resultados da consulta incluírem comandos públicos. Este parâmetro não afeta a consulta de comandos privados. true: consulta apenas a versão mais recente dos comandos públicos. false: consulta todas as versões dos comandos públicos. Valor padrão: false.	true
ResourceGroupId	string	Não	O ID do grupo de recursos ao qual o comando pertence.	rg-123******
Tag	array<object>	Não	As tags.
	object	Não	O objeto de tag.
Key	string	Não	A chave da tag do comando. 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 com esta tag não pode exceder 1.000. Se você usar várias tags para filtrar recursos, a contagem de recursos com todas as tags especificadas anexadas não pode exceder 1.000. Se a contagem de recursos exceder 1.000, chame a operação ListTagResources para consultar os recursos. A 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 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
Commands	object
Command	array<object>	O conjunto de dados do comando.
	array<object>	O objeto de comando.
Category	string	A categoria do comando público.	“”
CommandContent	string	O conteúdo do comando, transmitido em codificação Base64. Se ContentEncoding estiver definido como PlainText, o conteúdo original do script será retornado. Se ContentEncoding estiver definido como Base64, o conteúdo do script codificado em Base64 será retornado.	Y2QgL3Jvb3Q=
CommandId	string	O ID do comando.	c-hz01272yr52****
CreationTime	string	A hora em que o comando foi criado. A hora segue o padrão ISO 8601 no fuso horário UTC.	2020-11-17T06:52Z
Description	string	A descrição do comando.	testDescription
EnableParameter	boolean	Indica se os parâmetros personalizados estão ativados para o comando.	true
InvokeTimes	integer	O número de tarefas criadas usando o comando.	2
Latest	boolean	Indica se o comando público é a versão mais recente. Se vários comandos pertencerem ao mesmo Provider e tiverem o mesmo nome e categoria, esses comandos serão versões diferentes do mesmo comando. Este valor não é retornado para comandos do Cloud Assistant que você criou manualmente.	true
Launcher	string	O programa de inicialização para execução do script. O valor não pode exceder 1 KB de comprimento.	python3 -u {{ACS::ScriptFileName\|Ext(".py")}}
Name	string	O nome do comando.	testName
ParameterDefinitions	object
ParameterDefinition	array<object>	A lista de detalhes dos parâmetros personalizados.
	array<object>	O objeto de parâmetro personalizado.
DefaultValue	string	O valor padrão do parâmetro personalizado.	https://aliyun-client-assist.oss-accelerate.aliyuncs.com/linux/aliyun_assist_latest.rpm
Description	string	A descrição do parâmetro personalizado.	Caminho do pacote de instalação do agente do Cloud Assistant
ParameterName	string	O nome do parâmetro personalizado.	DownloadUrl
PatternRegex	string	A regra de expressão regular para o parâmetro personalizado.	^[a-zA-Z0-9_-]{4,32}$
PossibleValues	object
PossibleValue	array	A lista de valores possíveis para o parâmetro personalizado do tipo enumeração.
	string	O valor possível do parâmetro personalizado do tipo enumeração.	"Linux","Windows"
Required	boolean	Indica se o parâmetro personalizado é obrigatório. true: obrigatório. false: não obrigatório. Valor padrão: false.	true
ParameterNames	object
ParameterName	array	A lista de nomes de parâmetros personalizados analisados a partir do CommandContent quando o comando foi criado. O valor é retornado como uma lista. Se o recurso de parâmetro personalizado não for usado, uma lista vazia será retornada.
	string	O nome do parâmetro personalizado.	['parameter1','parameter2']
Provider	string	O provedor do comando público.	AlibabaCloud.ECS.GuestOS
ResourceGroupId	string	O ID do grupo de recursos ao qual o comando pertence.	rg-123******
Tags	object
Tag	array<object>	A lista de tags do comando.
	object	O objeto de informações de tag do comando.
TagKey	string	A chave da tag do comando.	owner
TagValue	string	O valor da tag do comando.	zhangsan
Timeout	integer	O período de tempo limite. Unidade: segundos.	3600
Type	string	O tipo do comando.	RunShellScript
Version	integer	A versão do comando público. Se vários comandos pertencerem ao mesmo Provider e tiverem o mesmo nome e categoria, esses comandos serão versões diferentes do mesmo comando. Este valor não é retornado para comandos do Cloud Assistant que você criou manualmente.	1
WorkingDir	string	O caminho de execução.	/home/
NextToken	string	O token de paginação retornado nesta chamada.	AAAAAdDWBF2
PageNumber	integer	O número da página da lista de comandos.	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.	5

Exemplos

Resposta de sucesso

JSON formato

{
  "Commands": {
    "Command": [
      {
        "Category": "“”",
        "CommandContent": "Y2QgL3Jvb3Q=",
        "CommandId": "c-hz01272yr52****",
        "CreationTime": "2020-11-17T06:52Z",
        "Description": "testDescription",
        "EnableParameter": true,
        "InvokeTimes": 2,
        "Latest": true,
        "Launcher": "python3 -u {{ACS::ScriptFileName|Ext(\".py\")}}",
        "Name": "testName",
        "ParameterDefinitions": {
          "ParameterDefinition": [
            {
              "DefaultValue": "https://aliyun-client-assist.oss-accelerate.aliyuncs.com/linux/aliyun_assist_latest.rpm",
              "Description": "Caminho do pacote de instalação do agente do Cloud Assistant",
              "ParameterName": "DownloadUrl",
              "PatternRegex": "^[a-zA-Z0-9_-]{4,32}$\u0000",
              "PossibleValues": {
                "PossibleValue": [
                  "\"Linux\",\"Windows\""
                ]
              },
              "Required": true
            }
          ]
        },
        "ParameterNames": {
          "ParameterName": [
            "['parameter1','parameter2']"
          ]
        },
        "Provider": "AlibabaCloud.ECS.GuestOS",
        "ResourceGroupId": "rg-123******",
        "Tags": {
          "Tag": [
            {
              "TagKey": "owner",
              "TagValue": "zhangsan"
            }
          ]
        },
        "Timeout": 3600,
        "Type": "RunShellScript",
        "Version": 1,
        "WorkingDir": "/home/"
      }
    ]
  },
  "NextToken": "AAAAAdDWBF2",
  "PageNumber": 1,
  "PageSize": 10,
  "RequestId": "473469C7-AA6F-4DC5-B3DB-A3DC0DE3****",
  "TotalCount": 5
}

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	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	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	Operation.Forbidden	The operation is not permitted.	A operação não é permitida.
403	InvalidParameterCharacter	The specified parameter %s contains illegal characters.
403	InvalidName.LengthLimitExceeded	The length of the parameter Name exceeds the upper limit.
403	InvalidDescription.LengthLimitExceeded	The length of the parameter Description exceeds the upper limit.
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.
404	InvalidCommandType.NotFound	The specified parameter Type does not exist.
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.