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

Consulta os detalhes de uma ou mais instâncias de servidor de aplicativos simples em uma região especificada.

Descrição da operação

Consulta os detalhes de uma ou mais instâncias de servidor de aplicativos simples em uma região especificada, incluindo o nome do servidor, endereço IP público, endereço IP privado, hora de criação e hora de expiração.

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

get

Instance

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

*Instance

acs:swas-open:{#regionId}:{#accountId}:instance/{#InstanceId}

Nenhuma

Parâmetros da solicitação

Parâmetro	Tipo	Obrigatório	Descrição	Exemplo
RegionId	string	Sim	O ID da região dos servidores de aplicativos simples.	cn-hangzhou
InstanceIds	string	Não	Os IDs das instâncias dos servidores de aplicativos simples. O valor pode ser um array JSON composto por até 100 IDs de instância. Separe vários IDs com vírgulas (,). Nota Se você especificar tanto `InstanceIds` quanto `PublicIpAddresses`, os IDs das instâncias e os endereços IP públicos devem pertencer ao mesmo servidor de aplicativos simples. Caso contrário, um resultado vazio será retornado.	["2ad1ae67295445f598017499dc**", "2ad1ae67295445f598017123dc**"]
ChargeType	string	Não	O método de cobrança das instâncias. Valores válidos: PrePaid. Apenas o modelo de assinatura é suportado. Valor padrão: PrePaid.	PrePaid
PublicIpAddresses	string	Não	Os endereços IP públicos dos servidores de aplicativos simples. O valor pode ser um array JSON composto por até 100 endereços IP públicos. Separe vários endereços com vírgulas (,). Nota Se você especificar tanto `InstanceIds` quanto `PublicIpAddresses`, os IDs das instâncias e os endereços IP públicos devem pertencer ao mesmo servidor de aplicativos simples. Caso contrário, um resultado vazio será retornado.	["42.1..", "42.2.."]
PageNumber	integer	Não	O número da página da lista de servidores de aplicativos simples. Valor padrão: 1	1
PageSize	integer	Não	O número de entradas por página para paginação. Valor máximo: 100. Valor padrão: 10	10
Status	string	Não	O status da instância. Valores válidos: Pending: sendo preparada. Starting: iniciando. Running: em execução. Stopping: parando. Stopped: parada. Resetting: sendo redefinida. Upgrading: sendo atualizada. Disabled: indisponível.	Running
Tag	array<object>	Não	As tags das instâncias.
	object	Não	A tag.
Key	string	Não	A chave da tag da instância. 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 da instância. 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 dos servidores de aplicativos simples.	rg-aek2bti7cf7****
InstanceName	string	Não	O nome da instância do servidor de aplicativos simples. O caractere curinga (*) é suportado para correspondência difusa.	test
PlanType	string	Não	O tipo de plano. Valores válidos: NORMAL: uso geral. CAPACITY: otimizado para armazenamento. PREVIOUS: geração anterior. MULTI_IP: múltiplos endereços IP públicos. INTERNATIONAL: internacional. Nota Para mais informações, consulte Família de instâncias.	NORMAL

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object	As informações da instância.
Instances	array<object>	O array de informações do servidor de aplicativos simples.
	array<object>	O array de informações do servidor de aplicativos simples.
Status	string	O status da instância. Valores válidos: Pending: sendo preparada. Starting: iniciando. Running: em execução. Stopping: parando. Stopped: parada. Resetting: sendo redefinida. Upgrading: sendo atualizada. Disabled: indisponível.	Running
CreationTime	string	A hora de criação. O horário segue o padrão ISO 8601 no formato yyyy-MM-ddTHH:mm:ssZ. O horário é exibido em UTC+0.	2021-03-08T05:31:06Z
InnerIpAddress	string	O endereço IP privado.	172.26.XX.XX
ChargeType	string	O método de cobrança.	PrePaid
InstanceId	string	O ID da instância.	2ad1ae67295445f598017499dc****
PlanId	string	O ID do plano.	swas.s2.c2m2s50b4t08
PublicIpAddress	string	O endereço IP público.	42.1.XX.XX
RegionId	string	O ID da região.	cn-hangzhou
ExpiredTime	string	A hora de expiração. O horário segue o padrão ISO 8601 no formato yyyy-MM-ddTHH:mm:ssZ. O horário é exibido em UTC+0.	2021-05-08T16:00:00Z
InstanceName	string	O nome do servidor.	test-InstanceName
BusinessStatus	string	O status do servidor. Valores válidos: Normal: normal. Expired: expirado. Overdue: pagamento em atraso.	Normal
DdosStatus	string	O status de DDoS. Valores válidos: Normal: normal. BlackHole: status de filtragem blackhole. Defense: status de limpeza de tráfego.	Normal
ImageId	string	O ID da imagem.	fe9c66133a9d4688872869726b52****
DisableReason	string	O motivo pelo qual o recurso está desativado. Valores válidos: FINANCIAL: bloqueado devido a pagamento em atraso. SECURITY: bloqueado por motivos de segurança. EXPIRED: a instância expirou.	EXPIRED
Combination	boolean	Indica se a instância utiliza um plano combinado.	false
CombinationInstanceId	string	O ID da instância do plano combinado.	com-f6c9a22****45b5b8de68ad608af1ba
Uuid	string	O UUID da instância.	41f30524-5df7-49c9-9c6e-32****489001
ResourceSpec	object	As especificações do recurso.
DiskCategory	string	O tipo de disco. Valores válidos: ESSD: um SSD aprimorado (ESSD) no nível de desempenho (PL) 0. SSD: um SSD padrão. CLOUD_EFFICIENCY: um disco ultra.	ESSD
Cpu	integer	O número de vCPUs.	2
Bandwidth	integer	A largura de banda. Unidade: Mbit/s.	200
DiskSize	integer	O tamanho do disco. Unidade: GiB.	60
Memory	number	O tamanho da memória. Unidade: GiB.	2
Flow	number	A cota de transferência de dados. Um valor 0 indica que a instância é uma instância baseada em largura de banda. Um valor diferente de zero indica que a instância é uma instância baseada em plano de transferência de dados.	818
Image	object	As informações da imagem.
OsType	string	O tipo de sistema operacional.	windows
ImageName	string	O nome da imagem.	test-custom-1686536882356
ImageVersion	string	A versão da imagem.	V3.5
ImageType	string	O tipo de imagem. Valores válidos: system: Imagem de sistema operacional. app: Imagem de aplicativo. custom: Imagem personalizada.	system
ImageIconUrl	string	A URL do ícone da imagem.	https://img.alicdn.com/imgextra/i3/O**1vdh9651ReKqWNMI2I_!!6000000002136**-24-24.svg
ImageContact	string	O provedor da imagem.	https://selfs****e.console.aliyun.com/ticket/createIndex
Tags	array<object>	As tags das instâncias.
	object	A tag.
Key	string	A chave da tag.	TestKey
Value	string	O valor da tag.	TestValue
Disks	array<object>	O array de informações de disco do servidor de aplicativos simples.
	array<object>	As informações do disco.
CreationTime	string	A hora em que o disco foi criado. A hora segue o padrão ISO 8601 no formato yyyy-MM-ddTHH:mm:ssZ. A hora é exibida em UTC.	2023-02-24T02:20:10Z
Status	string	O status do disco. Valores válidos: ReIniting: O disco está sendo inicializado. Creating: O disco está sendo criado. In_use: O disco está em uso. Available: O disco será montado. Attaching: O disco está sendo anexado. Detaching: O disco está sendo desanexado.	In_use
Device	string	O nome do dispositivo do disco no servidor.	/dev/xvda
Size	integer	O tamanho do disco. Unidade: GiB.	50
DiskName	string	O nome do disco.	SystemDisk
DiskChargeType	string	O método de cobrança do disco.	PrePaid
DiskType	string	O tipo de disco. Valores válidos: system: Disco do sistema. data: Disco de dados.	system
Category	string	O tipo de disco. Valores válidos: ESSD: um SSD aprimorado (ESSD) no nível de desempenho (PL) 0. SSD: um SSD padrão. CLOUD_EFFICIENCY: um disco ultra.	ESSD
DiskId	string	O ID do disco.	d-bp14wq0149cpp2x****
RegionId	string	O ID da região.	cn-hangzhou
Remark	string	As observações do disco.	remark
DiskTags	array<object>	As tags do disco.
	object	As informações da tag.
Key	string	A chave da tag.	TestKey
Value	string	O valor da tag.	TestValue
ResourceGroupId	string	O ID do grupo de recursos ao qual o disco pertence.	rg-aek2bti7cf7****
ResourceGroupId	string	O ID do grupo de recursos da instância.	rg-aekz7jmhg5s****
NetworkAttributes	array<object>	As informações de rede.
	object	As informações de rede.
PublicIpAddress	string	O endereço IP público.	116.62.XX.XX
PrivateIpAddress	string	O endereço IP privado.	72.25.XX.XX
PeakBandwidth	integer	A largura de banda de pico da rede pública. Unidade: Mbit/s.	200
PublicIpDdosStatus	string	O status de proteção contra DDoS do endereço IP público.	normal
PlanType	string	O tipo de plano. Valores válidos: NORMAL: uso geral. CAPACITY: otimizado para armazenamento. PREVIOUS: geração anterior. MULTI_IP: múltiplos endereços IP públicos. INTERNATIONAL: internacional. Nota Para mais informações, consulte Família de instâncias.	NORMAL
CommodityCode	string
TotalCount	integer	O número total de instâncias retornadas.	1
RequestId	string	O ID da solicitação.	20758A-585D-4A41-A9B2-28DA8F4F****
PageSize	integer	O número de entradas por página para paginação.	10
PageNumber	integer	O número da página da lista de servidores de aplicativos simples.	1

Exemplos

Resposta de sucesso

JSON formato

{
  "Instances": [
    {
      "Status": "Running",
      "CreationTime": "2021-03-08T05:31:06Z",
      "InnerIpAddress": "172.26.XX.XX",
      "ChargeType": "PrePaid",
      "InstanceId": "2ad1ae67295445f598017499dc****",
      "PlanId": "swas.s2.c2m2s50b4t08",
      "PublicIpAddress": "42.1.XX.XX",
      "RegionId": "cn-hangzhou",
      "ExpiredTime": "2021-05-08T16:00:00Z",
      "InstanceName": "test-InstanceName",
      "BusinessStatus": "Normal",
      "DdosStatus": "Normal",
      "ImageId": "fe9c66133a9d4688872869726b52****",
      "DisableReason": "EXPIRED",
      "Combination": false,
      "CombinationInstanceId": "com-f6c9a22****45b5b8de68ad608af1ba",
      "Uuid": "41f30524-5df7-49c9-9c6e-32****489001",
      "ResourceSpec": {
        "DiskCategory": "ESSD",
        "Cpu": 2,
        "Bandwidth": 200,
        "DiskSize": 60,
        "Memory": 2,
        "Flow": 818
      },
      "Image": {
        "OsType": "windows",
        "ImageName": "test-custom-1686536882356",
        "ImageVersion": "V3.5",
        "ImageType": "system",
        "ImageIconUrl": "https://img.alicdn.com/imgextra/i3/O****1vdh9651ReKqWNMI2I_!!6000000002136****-24-24.svg",
        "ImageContact": "https://selfs****e.console.aliyun.com/ticket/createIndex"
      },
      "Tags": [
        {
          "Key": "TestKey",
          "Value": "TestValue"
        }
      ],
      "Disks": [
        {
          "CreationTime": "2023-02-24T02:20:10Z",
          "Status": "In_use",
          "Device": "/dev/xvda",
          "Size": 50,
          "DiskName": "SystemDisk",
          "DiskChargeType": "PrePaid",
          "DiskType": "system",
          "Category": "ESSD",
          "DiskId": "d-bp14wq0149cpp2x****",
          "RegionId": "cn-hangzhou",
          "Remark": "remark",
          "DiskTags": [
            {
              "Key": "TestKey",
              "Value": "TestValue"
            }
          ],
          "ResourceGroupId": "rg-aek2bti7cf7****"
        }
      ],
      "ResourceGroupId": "rg-aekz7jmhg5s****",
      "NetworkAttributes": [
        {
          "PublicIpAddress": "116.62.XX.XX",
          "PrivateIpAddress": "72.25.XX.XX",
          "PeakBandwidth": 200,
          "PublicIpDdosStatus": "normal"
        }
      ],
      "PlanType": "NORMAL",
      "CommodityCode": ""
    }
  ],
  "TotalCount": 1,
  "RequestId": "20758A-585D-4A41-A9B2-28DA8F4F****",
  "PageSize": 10,
  "PageNumber": 1
}

Códigos de erro

Código de status HTTP	Código de erro	Mensagem de erro
400	InvalidChargeType.ValueNotSupported	The specified parameter ChargeType is invalid.
400	InvalidPublicIpAddresses.ValueNotSupported	The specified parameter PublicIpAddresses is invalid.
400	InvalidPublicIpAddresses	The specified parameter PublicIpAddresses value is not valid.
500	InternalError	An error occurred while processing your request.
404	InvalidInstanceId.NotFound	The specified InstanceId 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.