Consulta instâncias gerenciadas.
Observações de uso
Utilize um dos métodos a seguir para verificar as respostas:
Método 1: Ao chamar a operação DescribeInstances para recuperar a primeira página de resultados em uma consulta paginada, use MaxResults para especificar o número máximo de entradas retornadas na chamada. O valor retornado de NextToken é um token de paginação que você pode utilizar na próxima solicitação para obter uma nova página de resultados. Para recuperar páginas subsequentes ao chamar a operação DescribeInstances, defina NextToken com o valor retornado na chamada anterior e utilize MaxResults para limitar o número de entradas da resposta.
Método 2: Use PageSize para definir a quantidade de entradas por página e PageNumber para indicar a página a ser retornada. Adote apenas um desses métodos. Caso especifique MaxResults ou NextToken, os parâmetros de solicitação PageSize e PageNumber não terão efeito e o parâmetro de resposta TotalCount será inválido.
Depuração
Parâmetros de solicitação
|
Parâmetro |
Tipo |
Obrigatório |
Exemplo |
Descrição |
| Action | String | Sim | DescribeManagedInstances | A operação a ser executada. Defina o valor como DescribeManagedInstances. |
| RegionId | String | Sim | cn-hangzhou | O ID da região da instância gerenciada. 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), China (Hong Kong), Singapura, Japão (Tóquio), EUA (Vale do Silício) e EUA (Virgínia). Chame a operação DescribeRegions para consultar a lista mais recente de regiões. |
| OsType | String | Não | windows | O tipo de sistema operacional da instância gerenciada. Valores válidos:
|
| InstanceIp | String | Não | 192.168.**.** | O endereço IP privado ou público da instância gerenciada. |
| ActivationId | String | Não | 4ECEEE12-56F1-4FBC-9AB1-890F7494**** | O ID do código de ativação. |
| InstanceName | String | Não | my-webapp-server | O nome da instância gerenciada. |
| PageNumber | Long | Não | 1 | O número da página. As páginas começam a partir da página 1. Valor padrão: 1. |
| PageSize | Long | Não | 10 | A quantidade de entradas por página. Valores válidos: 1 a 50. Valor padrão: 10. |
| InstanceId.N | String | Não | mi-hz018jrc1o0**** | O ID da instância gerenciada N. Valores válidos de N: 1 a 50. |
| Tag.N.Key | String | Não | TestKey | A chave da tag N da instância gerenciada. 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, a resposta exibe até 1.000 recursos associados a essa tag. Se houver múltiplas tags definidas, até 1.000 recursos correspondentes aparecerão no resultado. 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 deve conter |
| Tag.N.Value | String | Não | TestValue | O valor da tag N da instância gerenciada. Valores válidos de N: 1 a 20. O valor da tag pode ser uma string vazia. O valor da tag aceita até 128 caracteres e não pode incluir |
| MaxResults | Integer | Não | 10 | O número máximo de entradas por página. Valores válidos: 1 a 50. Valor padrão: 10. |
| NextToken | String | Não | AAAAAdDWBF2**** | Token de paginação utilizado na próxima solicitação para recuperar uma nova página de resultados. Não é necessário informar este parâmetro na primeira solicitação. Nas chamadas seguintes, defina NextToken com o token obtido na consulta anterior. |
| ResourceGroupId | String | Não | rg-123****** | O ID do grupo de recursos ao qual a instância gerenciada pertence. |
Parâmetros de resposta
Parâmetro |
Tipo |
Exemplo |
Descrição |
| PageSize | Long | 10 | A quantidade de entradas por página. |
| RequestId | String | 77115469-F2C5-4ECA-94F7-FA04F2FD**** | O ID da solicitação. |
| PageNumber | Long | 1 | O número da página. |
| TotalCount | Long | 1 | O total de instâncias gerenciadas consultadas. |
| Instances | Array of Instance | As instâncias gerenciadas consultadas. |
|
| LastInvokedTime | String | 2021-01-20T09:00:40Z | Horário da última execução da tarefa do Cloud Assistant. |
| Connected | Boolean | true | Indica se a instância gerenciada está conectada. Valores válidos:
|
| InternetIp | String | 40.65.**.** | O endereço IP público da instância gerenciada. |
| Hostname | String | demo | O nome do host da instância gerenciada. |
| InstanceId | String | mi-hz018jrc1o0**** | O ID da instância gerenciada. |
| ActivationId | String | 3704F543-F768-43FA-9864-897F75B3**** | O ID do código de ativação. |
| IntranetIp | String | 10.0.**.** | O endereço IP privado da instância gerenciada. |
| AgentVersion | String | 2.2.0.102 | A versão do Cloud Assistant Agent. |
| RegistrationTime | String | 2021-01-20T08:57:56Z | Data e hora de registro da instância gerenciada. |
| InstanceName | String | webAPP-linux-01 | O nome da instância gerenciada. |
| OsType | String | Linux | O tipo de sistema operacional da instância gerenciada. |
| OsVersion | String | Linux_#38~18.04.1-Ubuntu SMP Wed Jan 6 18:26:30 UTC 2021_x86_64 | Informações sobre a versão do sistema operacional. |
| InvocationCount | Long | 1 | Quantidade de execuções de tarefas do Cloud Assistant na instância gerenciada. |
| MachineId | String | e03231b37ab14e53b5795ad625fc**** | O código da máquina da instância gerenciada. |
| Tags | Array of Tag | As tags da instância gerenciada. |
|
| TagKey | String | TestKey | A chave da tag da instância gerenciada. Valores válidos de N: 1 a 20. A chave da tag não pode ser uma string vazia. Quando uma única tag é especificada na consulta, a resposta mostra até 1.000 recursos vinculados a ela. Se várias tags forem informadas, também serão exibidos no máximo 1.000 recursos correspondentes. Para listar mais de 1.000 recursos com determinadas tags, utilize a operação ListTagResources. A chave da tag suporta até 64 caracteres e não pode conter |
| TagValue | String | TestValue | O valor da tag da instância gerenciada. Valores válidos de N: 1 a 20. O valor da tag pode ser uma string vazia. O valor da tag permite até 128 caracteres e não deve incluir |
| ResourceGroupId | String | rg-123****** | O ID do grupo de recursos ao qual a instância gerenciada pertence. |
| NextToken | String | AAAAAdDWBF2 | O token de consulta retornado na chamada. |
Exemplos
Exemplos de solicitações
https://ecs.aliyuncs.com/?Action=DescribeManagedInstances
&RegionId=cn-hangzhou
&<Common request parameters>
Exemplos de respostas de sucesso
Formato XML
HTTP/1.1 200 OK
Content-Type:application/xml
<DescribeManagedInstancesResponse>
<Instances>
<MachineId>e03231b37ab14e53b5795ad625fc****</MachineId>
<InstanceId>mi-hz018jrc1o0****</InstanceId>
<AgentVersion>2.2.0.102</AgentVersion>
<Connected>true</Connected>
<InvocationCount>1</InvocationCount>
<OsVersion>Linux_#38~18.04.1-Ubuntu SMP Wed Jan 6 18:26:30 UTC 2021_x86_64</OsVersion>
<ActivationId>3704F543-F768-43FA-9864-897F75B3****</ActivationId>
<Hostname>demo</Hostname>
<RegistrationTime>2021-01-20T08:57:56Z</RegistrationTime>
<IntranetIp>10.0.**.**</IntranetIp>
<InstanceName>webAPP-linux-01</InstanceName>
<InternetIp>40.65.**.**</InternetIp>
<OsType>Linux</OsType>
<LastInvokedTime>2021-01-20T09:00:40Z</LastInvokedTime>
</Instances>
<TotalCount>1</TotalCount>
<RequestId>77115469-F2C5-4ECA-94F7-FA04F2FDC8F4</RequestId>
<PageSize>10</PageSize>
<PageNumber>1</PageNumber>
</DescribeManagedInstancesResponse>
Formato JSON
HTTP/1.1 200 OK
Content-Type:application/json
{
"Instances" : [ {
"MachineId" : "e03231b37ab14e53b5795ad625fc****",
"InstanceId" : "mi-hz018jrc1o0****",
"AgentVersion" : "2.2.0.102",
"Connected" : true,
"InvocationCount" : 1,
"OsVersion" : "Linux_#38~18.04.1-Ubuntu SMP Wed Jan 6 18:26:30 UTC 2021_x86_64",
"ActivationId" : "3704F543-F768-43FA-9864-897F75B3****",
"Hostname" : "demo",
"RegistrationTime" : "2021-01-20T08:57:56Z",
"IntranetIp" : "10.0.**.**",
"InstanceName" : "webAPP-linux-01",
"InternetIp" : "40.65.**.**",
"OsType" : "Linux",
"LastInvokedTime" : "2021-01-20T09:00:40Z"
} ],
"TotalCount" : 1,
"RequestId" : "77115469-F2C5-4ECA-94F7-FA04F2FDC8F4",
"PageSize" : 10,
"PageNumber" : 1
}
Códigos de erro
|
HttpCode |
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 é suportada na região especificada. Verifique se o valor de RegionId é válido. |
|
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. |
|
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 |
NumberExceed.Tags |
The Tags parameter number is exceed. |
A quantidade de tags excede o limite máximo. |
|
400 |
MissingParameter.TagKey |
You must specify Tag.N.Key. |
Tag.N.Key é obrigatório. |
|
400 |
Duplicate.TagKey |
The Tag.N.Key contain duplicate key. |
A chave da tag já existe. As chaves devem ser únicas. |
|
400 |
InvalidParameter.NextToken |
The specified parameter NextToken is not valid. |
Valor de NextToken inválido. |
|
400 |
InvalidParameter.MaxResults |
The specified parameter MaxResults is not valid. |
Valor de MaxResults inválido. |
|
403 |
Operation.Forbidden |
The operation is not permitted. |
Operação não suportada. |
|
500 |
InternalError.Dispatch |
An error occurred when you dispatched the request. |
Ocorreu um erro durante o envio da solicitação. Tente novamente mais tarde. |
Para obter uma lista de códigos de erro, consulte Códigos de erro do serviço.