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

Notas de uso

Se você especificar apenas os parâmetros Action e RegionId, a operação consulta por padrão todos os comandos disponíveis (CommandId) criados na região indicada.

Depuração

O OpenAPI Explorer calcula automaticamente o valor da assinatura. Para sua conveniência, recomendamos chamar esta operação no OpenAPI Explorer. O OpenAPI Explorer gera dinamicamente o código de exemplo da operação para diferentes SDKs.

Parâmetros de solicitação

Parâmetro	Tipo	Obrigatório	Exemplo	Descrição
Action	String	Sim	DescribeCommands	A operação a ser executada. Defina o valor como DescribeCommands.
RegionId	String	Sim	cn-hangzhou	O ID da região do comando. Chame a operação DescribeRegions para consultar a lista mais recente de regiões.
Provider	String	Não	AlibabaCloud	O provedor do comando comum. Observe os seguintes itens: Se você não especificar este parâmetro, a operação consulta todos os comandos criados por você. Se você definir este parâmetro como `AlibabaCloud`, a operação consulta todos os comandos comuns fornecidos pela Alibaba Cloud. Se você definir este parâmetro como um provedor específico, a operação consulta todos os comandos comuns desse provedor. Exemplos: Se você definir `Provider` como AlibabaCloud.ECS.GuestOS, a operação consulta todos os comandos comuns fornecidos por `AlibabaCloud.ECS.GuestOS`. Se você definir `Provider` como AlibabaCloud.ECS.GuestOSDiagnose, a operação consulta todos os comandos comuns fornecidos por `AlibabaCloud.ECS.GuestOSDiagnose`.
CommandId	String	Não	c-hz01272yr52****	O ID do comando.
Name	String	Não	testName	O nome do comando. A busca aproximada tem suporte por padrão quando `Provider` é especificado.
Description	String	Não	testDescription	A descrição do comando comum. Este parâmetro só tem efeito e a busca aproximada só tem suporte por padrão quando `Provider` é especificado.
Type	String	Não	RunShellScript	O tipo do comando. Valores válidos: RunBatScript: comando em lote, aplicável a instâncias Windows RunPowerShellScript: comando PowerShell, aplicável a instâncias Windows RunShellScript: comando shell, aplicável a instâncias Linux
ContentEncoding	String	Não	PlainText	O modo de codificação dos valores `CommandContent` e `Output` na resposta. Valores válidos: PlainText: retorna o conteúdo original do comando e a saída do comando. Base64: retorna o conteúdo do comando e a saída codificados em Base64. Valor padrão: Base64.
PageNumber	Long	Não	1	O número da página. As páginas começam na página 1. Valor padrão: 1.
PageSize	Long	Não	10	O número de entradas por página. Valores válidos: 1 a 50. Valor padrão: 10.
Latest	Boolean	Não	true	Define se a operação deve consultar apenas a versão mais recente dos comandos comuns. Este parâmetro não afeta a consulta de comandos privados. true: consulta apenas a versão mais recente dos comandos comuns. false: consulta todas as versões dos comandos comuns. Valor padrão: false.
ResourceGroupId	String	Não	rg-123******	O ID do grupo de recursos ao qual o comando pertence.
Tag.N.Key	String	Não	TestKey	A chave da tag N do comando. Valores válidos de N: 1 a 20. A chave da tag não pode ser uma string vazia. Ao especificar uma única tag para consultar recursos, até 1.000 recursos com essa tag podem ser exibidos na resposta. Se múltiplas tags forem especificadas, até 1.000 recursos contendo todas essas tags podem ser retornados. Para consultar mais de 1.000 recursos com tags específicas, chame a operação ListTagResources. A chave da tag pode ter até 64 caracteres e não pode começar com `acs:` ou `aliyun`. Não pode conter `http://` ou `https://`.
Tag.N.Value	String	Não	TestValue	O valor da tag N do comando. Valores válidos de N: 1 a 20. O valor da tag pode ser uma string vazia. Pode ter até 128 caracteres e não pode conter `http://` ou `https://`.

Parâmetros de resposta

Parâmetro	Tipo	Exemplo	Descrição
PageSize	Long	10	O número de entradas por página.
RequestId	String	473469C7-AA6F-4DC5-B3DB-A3DC0DE3****	O ID da solicitação.
PageNumber	Long	1	O número da página.
TotalCount	Long	5	O número total de comandos.
Commands	Array of Command		Os comandos consultados.
Command
CreationTime	String	2020-11-17T06:52Z	A hora de criação do comando.
Type	String	RunShellScript	O tipo do comando.
Timeout	Long	3600	O período de tempo limite. Unidade: segundos.
InvokeTimes	Integer	2	O número de tarefas criadas usando o comando.
CommandId	String	c-hz01272yr52****	O ID do comando.
WorkingDir	String	/home/	O caminho de execução do comando.
Description	String	testDescription	A descrição do comando.
Version	Integer	1	A versão do comando comum. Se vários comandos comuns do mesmo provedor (`Provider`) pertencerem à mesma categoria e tiverem o mesmo nome, eles serão considerados versões diferentes do mesmo comando. Este parâmetro não é retornado para comandos do Cloud Assistant criados por você.
Provider	String	AlibabaCloud.ECS.GuestOS	O provedor do comando comum.
CommandContent	String	Y2QgL3Jvb3Q=	O conteúdo do comando codificado em Base64. Se ContentEncoding for definido como PlainText, o sistema retorna o conteúdo original do comando. Se ContentEncoding for definido como Base64, o sistema retorna o conteúdo do comando codificado em Base64.
Category	String	""	A categoria do comando comum.
Latest	Boolean	true	Indica se o comando comum é da versão mais recente. Se vários comandos comuns do mesmo provedor (`Provider`) pertencerem à mesma categoria e tiverem o mesmo nome, eles serão considerados versões diferentes do mesmo comando. Este parâmetro não é retornado para comandos do Cloud Assistant criados por você.
Name	String	testName	O nome do comando.
EnableParameter	Boolean	true	Indica se o recurso de parâmetro personalizado está ativado para o comando.
ResourceGroupId	String	rg-123******	O ID do grupo de recursos ao qual o comando pertence.
ParameterNames	Array of String	['parameter1','parameter2']	A lista de nomes de parâmetros personalizados extraídos do conteúdo do comando especificado durante sua criação. Se o recurso de parâmetro personalizado estiver desativado, o sistema retorna uma lista vazia.
ParameterDefinitions	Array of ParameterDefinition		Os parâmetros personalizados.
ParameterDefinition
Required	Boolean	true	Indica se o parâmetro personalizado é obrigatório. true false Valor padrão: false.
Description	String	Caminho de baixe do pacote de instalação do Cloud Assistant Agent	A descrição do parâmetro personalizado.
DefaultValue	String	https://aliyun-client-assist.oss-accelerate.aliyuncs.com/linux/aliyun_assist_latest.rpm	O valor padrão do parâmetro personalizado.
ParameterName	String	DownloadUrl	O nome do parâmetro personalizado.
PossibleValues	Array of String	"Linux","Windows"	Os valores válidos do parâmetro personalizado do tipo enumeração.
Tags	Array of Tag		As tags do comando.
Tag
TagKey	String	owner	A chave da tag do comando.
TagValue	String	zhangsan	O valor da tag do comando.

Exemplos

Exemplos de solicitações

http(s)://ecs.aliyuncs.com/?Action=DescribeCommands
&RegionId=cn-hangzhou
&CommandId=c-hz01272yr52****
&PageNumber=1
&PageSize=10
&<Common request parameters>

Exemplos de respostas de sucesso

Formato XML

HTTP/1.1 200 OK
Content-Type:application/xml

<DescribeCommandsResponse>
    <PageSize>10</PageSize>
    <RequestId>473469C7-AA6F-4DC5-B3DB-A3DC0DE3****</RequestId>
    <PageNumber>1</PageNumber>
    <TotalCount>5</TotalCount>
    <Commands>
        <CreationTime>2020-11-17T06:52Z</CreationTime>
        <Type>RunShellScript</Type>
        <Timeout>3600</Timeout>
        <InvokeTimes>2</InvokeTimes>
        <CommandId>c-hz01272yr52****</CommandId>
        <WorkingDir>/home/</WorkingDir>
        <Description>testDescription</Description>
        <Version>1</Version>
        <Provider>AlibabaCloud.ECS.GuestOS</Provider>
        <CommandContent>Y2QgL3Jvb3Q=</CommandContent>
        <Category>""</Category>
        <Latest>true</Latest>
        <Name>testName</Name>
        <EnableParameter>true</EnableParameter>
        <ParameterNames>['parameter1','parameter2']</ParameterNames>
        <ParameterDefinitions>
            <Required>true</Required>
            <Description>Download path of the Cloud Assistant Agent installation package</Description>
            <DefaultValue>https://aliyun-client-assist.oss-accelerate.aliyuncs.com/linux/aliyun_assist_latest.rpm</DefaultValue>
            <ParameterName>DownloadUrl</ParameterName>
            <PossibleValues>"Linux","Windows"</PossibleValues>
        </ParameterDefinitions>
        <Tags>
            <TagKey>owner</TagKey>
            <TagValue>zhangsan</TagValue>
        </Tags>
    </Commands>
</DescribeCommandsResponse>

Formato JSON

HTTP/1.1 200 OK
Content-Type:application/json

{
  "PageSize" : 10,
  "RequestId" : "473469C7-AA6F-4DC5-B3DB-A3DC0DE3****",
  "PageNumber" : 1,
  "TotalCount" : 5,
  "Commands" : [ {
    "CreationTime" : "2020-11-17T06:52Z",
    "Type" : "RunShellScript",
    "Timeout" : 3600,
    "InvokeTimes" : 2,
    "CommandId" : "c-hz01272yr52****",
    "WorkingDir" : "/home/",
    "Description" : "testDescription",
    "Version" : 1,
    "Provider" : "AlibabaCloud.ECS.GuestOS",
    "CommandContent" : "Y2QgL3Jvb3Q=",
    "Category" : """",
    "Latest" : true,
    "Name" : "testName",
    "EnableParameter" : true,
    "ParameterNames" : [ "['parameter1','parameter2']" ],
    "ParameterDefinitions" : [ {
      "Required" : true,
      "Description" : "Download path of the Cloud Assistant Agent installation package",
      "DefaultValue" : "https://aliyun-client-assist.oss-accelerate.aliyuncs.com/linux/aliyun_assist_latest.rpm",
      "ParameterName" : "DownloadUrl",
      "PossibleValues" : [ "\"Linux\",\"Windows\"" ]
    } ],
    "Tags" : [ {
      "TagKey" : "owner",
      "TagValue" : "zhangsan"
    } ]
  } ]
}

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 não pode ser executada na região especificada. Verifique se o valor do parâmetro RegionId é válido.
400	Duplicate.TagKey	The Tag.N.Key contain duplicate key.	A chave da tag já existe. As chaves de tag devem ser únicas.
400	InvalidTagKey.Malformed	The specified Tag.n.Key is not valid.	Valor de Tag.N.Key inválido.
400	InvalidTagValue.Malformed	The specified Tag.n.Value is not valid.	Valor de Tag.N.Value inválido.
400	MissingParameter.TagKey	You must specify Tag.N.Key.	Tag.N.Key é obrigatório.
400	InvalidParam.PageNumber	The specified parameter is invalid.	Valor de PageNumber inválido.
400	InvalidParam.PageSize	The specified parameter is invalid.	Valor de PageSize inválido.
403	Operation.Forbidden	The operation is not permitted.	A operação não é suportada.
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.	A solicitação falhou devido a uma falha temporária do servidor backend.
500	InternalError	The request processing has failed due to some unknown error.	Ocorreu um erro interno. Tente novamente mais tarde.

Para obter uma lista de códigos de erro, consulte Códigos de erro do serviço.