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

Consulta a lista de instâncias gerenciadas.

Descrição da operação

Ao realizar uma consulta paginada para a primeira página, você só precisa ajustar as configurações de MaxResults para limitar o número de entradas retornadas. O NextToken na resposta será usado como o token para paginar as páginas subsequentes. Ao realizar uma consulta paginada para as páginas subsequentes, defina o parâmetro NextToken com o valor de NextToken obtido da resposta anterior e ajuste as configurações de MaxResults para limitar o número de entradas 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

Nenhuma autorização necessária para esta operação. Se você encontrar problemas com esta operação, entre em contato com o suporte técnico.

Parâmetros da solicitação

Parâmetro	Tipo	Obrigatório	Descrição	Exemplo
RegionId	string	Sim	O ID da região. Regiões suportadas: China (Qingdao), China (Pequim), China (Zhangjiakou), China (Hohhot), China (Ulanqab), China (Hangzhou), China (Xangai), China (Shenzhen), China (Heyuan), China (Guangzhou), China (Chengdu), Hong Kong (China), Singapura, Japão (Tóquio), EUA (Vale do Silício) e EUA (Virgínia). Você pode chamar DescribeRegions para consultar os IDs das regiões e outras informações.	cn-hangzhou
OsType	string	Não	O tipo de sistema operacional da instância gerenciada. Valores válidos: windows linux FreeBSD	windows
InstanceIp	string	Não	O endereço IP interno ou endereço IP público da instância gerenciada.	192.168..
ActivationId	string	Não	O ID do código de ativação.	4ECEEE12-56F1-4FBC-9AB1-890F7494****
MachineId	string	Não	O valor do parâmetro MachineId especificado ao registrar a instância gerenciada. O valor pode ter até 36 caracteres. Exemplo de script de registro: `aliyun-service --register \ --RegionId=cn-hangznou \ --ActivationId=xxxxxxxxxxx \ --ActivationCode=xxxxxxxxx \ --MachineId=xxxxxx \ # Parâmetro opcional, que especifica o identificador exclusivo da máquina --ForceResue` Se os parâmetros MachineId e ForceResult forem especificados durante o registro, o Cloud Assistant gerará um ID de instância gerenciada fixo para este MachineId. Se o parâmetro MachineId não for especificado explicitamente, o Cloud Assistant gerará automaticamente um valor de MachineId com base nas informações de hardware da máquina. Recomendação: Especifique explicitamente os parâmetros MachineId e ForceResult para marcar o mapeamento entre a instância gerenciada e a máquina local.	GOG4X8312A0188
InstanceName	string	Não	O nome da instância gerenciada.	my-webapp-server
PageNumber	integer	Não	Nota Este parâmetro será descontinuado em breve. Recomendamos que você use NextToken e MaxResults para operações de paginação e consulta paginada.	1
PageSize	integer	Não	Nota Este parâmetro será descontinuado em breve. Recomendamos que você use NextToken e MaxResults para operações de paginação e consulta paginada.	10
InstanceId	array	Não	O ID da instância gerenciada. Valores válidos de N: 1 a 50.	mi-hz018jrc1o0****
	string	Não	O ID da instância gerenciada. Valores válidos de N: 1 a 50.	mi-hz018jrc1o0****
Tag	array<object>	Não	A lista de tags.
	object	Não	A lista de tags.
Key	string	Não	A chave da tag da instância gerenciada. Valores válidos de N: 1 a 20. O valor 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 aos quais você anexa várias tags não pode exceder 1.000. Se a contagem de recursos exceder 1.000, você deve usar 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 instância gerenciada. Valores válidos de N: 1 a 20. O valor pode ser uma string vazia. O valor da tag pode ter até 128 caracteres e não pode conter http:// ou https://.	TestValue
MaxResults	integer	Não	O número máximo de entradas a serem retornadas em cada página durante a paginação ou uma consulta paginada. Valor máximo: 50. Valor padrão: 10.	10
NextToken	string	Não	O token de paginação. Defina o valor como o valor de NextToken retornado da chamada de API anterior.	AAAAAdDWBF2****
ResourceGroupId	string	Não	O ID do grupo de recursos ao qual a instância gerenciada pertence.	rg-123******
Connected	string	Não	Especifica se a instância gerenciada está conectada. Valores válidos: true: A instância gerenciada está conectada. Você pode gerenciar a instância gerenciada usando o Cloud Assistant. false: A instância gerenciada não está conectada. O servidor pode estar parado ou o Agente do Cloud Assistant não está instalado corretamente.	true

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object
Instances	array<object>	A lista de instâncias gerenciadas.
	array<object>
ActivationId	string	O ID do código de ativação.	3704F543-F768-43FA-9864-897F75B3****
AgentVersion	string	O número da versão do Agente do Cloud Assistant.	2.2.0.102
Connected	boolean	Indica se a instância gerenciada está conectada. Valores válidos: true: A instância gerenciada está conectada. Você pode gerenciar a instância gerenciada usando o Cloud Assistant. false: A instância gerenciada não está conectada. O servidor pode estar parado ou o Agente do Cloud Assistant não está instalado corretamente.	true
Hostname	string	O nome do host da instância gerenciada.	demo
InstanceId	string	O ID da instância gerenciada.	mi-hz018jrc1o0****
InstanceName	string	O nome da instância gerenciada.	webAPP-linux-01
InternetIp	string	O endereço IP público da instância gerenciada.	40.65..
IntranetIp	string	O endereço IP interno da instância gerenciada.	10.0..
InvocationCount	integer	O número de tarefas do Cloud Assistant executadas na instância gerenciada.	1
LastInvokedTime	string	A hora em que a última tarefa do Cloud Assistant foi executada. A hora é exibida no formato ISO 8601 no fuso horário UTC.	2021-01-20T09:00:40Z
MachineId	string	O ID da máquina da instância gerenciada.	e03231b37ab14e53b5795ad625fc****
OsType	string	O sistema operacional da instância gerenciada.	Linux
OsVersion	string	As informações da versão do sistema operacional.	Linux_#38~18.04.1-Ubuntu SMP Wed Jan 6 18:26:30 UTC 2021_x86_64
RegistrationTime	string	A hora de registro da instância gerenciada. A hora é exibida no formato ISO 8601 no fuso horário UTC.	2021-01-20T08:57:56Z
ResourceGroupId	string	O ID do grupo de recursos ao qual a instância gerenciada pertence.	rg-123******
Tags	array<object>	A lista de tags.
	object	A lista de tags.
TagKey	string	A chave da tag da instância gerenciada. Valores válidos de N: 1 a 20. O valor 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 aos quais você anexa várias tags não pode exceder 1.000. Se a contagem de recursos exceder 1.000, você deve usar 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
TagValue	string	O valor da tag da instância gerenciada. Valores válidos de N: 1 a 20. O valor pode ser uma string vazia. O valor da tag pode ter até 128 caracteres e não pode conter http:// ou https://.	TestValue
NextToken	string	O token de paginação retornado para esta chamada.	AAAAAdDWBF2
PageNumber	integer	O número da página da lista de instâncias gerenciadas.	1
PageSize	integer	O número de entradas retornadas por página.	10
RequestId	string	O ID da solicitação.	77115469-F2C5-4ECA-94F7-FA04F2FD****
TotalCount	integer	O número total de instâncias gerenciadas consultadas. Nota Quando você usa os parâmetros MaxResults e NextToken para paginação e consulta paginada, o valor de TotalCount retornado não tem significado.	1

Exemplos

Resposta de sucesso

JSON formato

{
  "Instances": [
    {
      "ActivationId": "3704F543-F768-43FA-9864-897F75B3****",
      "AgentVersion": "2.2.0.102",
      "Connected": true,
      "Hostname": "demo",
      "InstanceId": "mi-hz018jrc1o0****",
      "InstanceName": "webAPP-linux-01",
      "InternetIp": "40.65.**.**",
      "IntranetIp": "10.0.**.**",
      "InvocationCount": 1,
      "LastInvokedTime": "2021-01-20T09:00:40Z",
      "MachineId": "e03231b37ab14e53b5795ad625fc****",
      "OsType": "Linux",
      "OsVersion": "Linux_#38~18.04.1-Ubuntu SMP Wed Jan 6 18:26:30 UTC 2021_x86_64",
      "RegistrationTime": "2021-01-20T08:57:56Z",
      "ResourceGroupId": "rg-123******",
      "Tags": [
        {
          "TagKey": "TestKey",
          "TagValue": "TestValue"
        }
      ]
    }
  ],
  "NextToken": "AAAAAdDWBF2",
  "PageNumber": 1,
  "PageSize": 10,
  "RequestId": "77115469-F2C5-4ECA-94F7-FA04F2FD****",
  "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	InvalidParam.PageNumber	The specified parameter is invalid.
400	InvalidParam.PageSize	The specified parameter is invalid.
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	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	MissingParameter.TagKey	You must specify Tag.N.Key.	Especifique a chave da tag.
400	Duplicate.TagKey	The Tag.N.Key contain duplicate key.	Existem chaves duplicadas nas tags. Certifique-se de que as chaves sejam únicas.
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.
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.

Consulte Códigos de Erro para uma lista completa.

Notas de versão

Consulte Notas de Versão para uma lista completa.