ListInstances - Simple Application Server - Centro de documentación de Alibaba Cloud

Consulta los detalles de una o más instancias en una región especificada.

Descripción de la operación

Consulta los detalles de una o más instancias en una región especificada, incluidos el nombre del servidor, la dirección IP pública, la dirección IP interna, la hora de creación y la hora de vencimiento.

Pruébelo ahora

Pruebe esta API en OpenAPI Explorer sin necesidad de firma manual. Las llamadas exitosas generan automáticamente código SDK acorde a sus parámetros. Descárguelo con seguridad de credenciales integrada para uso local.

Test

Autorización de RAM

La siguiente tabla describe la autorización necesaria para invocar esta API. Puede definirla en una directiva de Resource Access Management (RAM). A continuación, se detallan las columnas de la tabla:

Action: Estas acciones se utilizan en el elemento Action de las declaraciones de directivas de permisos de RAM para otorgar permisos que permitan realizar la operación.
API: La API que debe invocarse para llevar a cabo la acción.
Nivel de acceso: Nivel de acceso predefinido que se concede para cada API. Valores válidos: create, list, get, update y delete.
Tipo de recurso: Tipo de recurso que admite autorización para ejecutar la acción. Indica si la acción es compatible con permisos a nivel de recurso. El recurso especificado debe ser compatible con la acción; de lo contrario, la directiva no surtirá efecto.
- En las API con permisos a nivel de recurso, los tipos de recursos obligatorios se marcan con un asterisco (*). Especifique el Alibaba Cloud Resource Name (ARN) correspondiente en el elemento Resource de la directiva.
- Para las API sin permisos a nivel de recurso, se muestra All Resources. Utilice un asterisco (*) en el elemento Resource de la directiva.
Clave de condición: Claves de condición definidas por el servicio. Permiten un control granular y se aplican ya sea solo a acciones o a acciones asociadas con recursos específicos. Además de las claves de condición específicas del servicio, Alibaba Cloud proporciona un conjunto de common condition keys aplicables a todos los servicios compatibles con RAM.
Acción dependiente: Acciones dependientes necesarias para ejecutar la acción principal. Para completar la operación, el usuario de RAM o el rol de RAM debe contar con permisos para realizar todas las acciones dependientes.

Action

Nivel de acceso

Tipo de recurso

Clave de condición

Acción dependiente

swas-open:ListInstances

get

Instancia.

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

*Instancia.

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

Ninguna

Parámetros de la solicitud

Parámetro	Tipo	Obligatorio	Descripción	Ejemplo
RegionId	string	Sí	El ID de la región del servidor de aplicación simple.	cn-hangzhou
InstanceIds	string	No	Los ID de instancia de los servidores de aplicación simple. El valor puede ser una matriz JSON que consta de hasta 100 ID de instancia. Separe varios ID con comas (,). Nota Si especifica los parámetros InstanceIds y PublicIpAddresses, asegúrese de que los ID de instancia y las direcciones IP públicas especificados pertenezcan al mismo servidor de aplicación simple. De lo contrario, se devuelve una respuesta vacía.	["2ad1ae67295445f598017499dc**", "2ad1ae67295445f598017123dc**"]
ChargeType	string	No	El método de facturación de la instancia. Valores válidos: PrePaid: suscripción. Actualmente, solo se admite el método de facturación de suscripción. Valor predeterminado: PrePaid.	PrePaid
PublicIpAddresses	string	No	Las direcciones IP públicas de los servidores de aplicación simple. El valor puede ser una matriz JSON que consta de hasta 100 direcciones IP públicas. Separe varias direcciones IP con comas (,). Nota Si especifica los parámetros InstanceIds y PublicIpAddresses, asegúrese de que los ID de instancia y las direcciones IP públicas especificados pertenezcan al mismo servidor de aplicación simple. De lo contrario, se devuelve una respuesta vacía.	["42.1..", "42.2.."]
PageNumber	integer	No	El número de página de la lista de servidores de aplicación simple. Valor predeterminado: 1.	1
PageSize	integer	No	El número de entradas por página en una consulta paginada. Valor máximo: 100. Valor predeterminado: 10.	10
Status	string	No	El estado de la instancia. Valores válidos: Pending: La instancia se está preparando. Starting: La instancia se está iniciando. Running: La instancia está en ejecución. Stopping: La instancia se está deteniendo. Stopped: La instancia está detenida. Resetting: La instancia se está restableciendo. Upgrading: La instancia se está actualizando. Disabled: La instancia no está disponible.	Running
Tag	array<object>	No	Las etiquetas de la instancia.
	object	No	La etiqueta.
Key	string	No	La clave de la etiqueta de la instancia. La clave de la etiqueta debe tener una longitud de 1 a 64 caracteres. Valores válidos de N: 1 a 20.	TestKey
Value	string	No	El valor de la etiqueta de la instancia. El valor de la etiqueta debe tener una longitud de 1 a 64 caracteres. Valores válidos de N: 1 a 20.	TestValue
ResourceGroupId	string	No	El ID del grupo de recursos al que pertenece el servidor de aplicación simple.	rg-aek2bti7cf7****
InstanceName	string	No	El nombre del servidor de aplicación simple. Puede usar el comodín de asterisco (*) para una búsqueda aproximada.	test
PlanType	string	No	El tipo de plan. Valores válidos: NORMAL: de uso general. CAPACITY: optimizado para almacenamiento. PREVIOUS: generación anterior. MULTI_IP: varias direcciones IP públicas. INTERNATIONAL: internacional. Nota Para obtener más información, consulte Familias de instancias.	NORMAL

Elementos de la respuesta

Elemento	Tipo	Descripción	Ejemplo
	object	La información de la instancia.
Instances	array<object>	La matriz de información de servidores de aplicaciones simples.
	array<object>	La matriz de información de servidores de aplicaciones simples.
Status	string	El estado de la instancia. Valores válidos: Pending: La instancia se está preparando. Starting: La instancia se está iniciando. Running: La instancia está en ejecución. Stopping: La instancia se está deteniendo. Stopped: La instancia está detenida. Resetting: La instancia se está restableciendo. Upgrading: La instancia se está actualizando. Disabled: La instancia no está disponible.	Running
CreationTime	string	La hora de creación. La hora se muestra en UTC en el estándar ISO 8601 con el formato yyyy-MM-ddTHH:mm:ssZ.	2021-03-08T05:31:06Z
InnerIpAddress	string	La dirección IP interna.	172.26.XX.XX
ChargeType	string	El método de facturación.	PrePaid
InstanceId	string	El ID de la instancia.	2ad1ae67295445f598017499dc****
PlanId	string	El ID del plan.	swas.s2.c2m2s50b4t08
PublicIpAddress	string	La dirección IP pública.	42.1.XX.XX
RegionId	string	El ID de la región.	cn-hangzhou
ExpiredTime	string	La hora de vencimiento. La hora se muestra en UTC en el estándar ISO 8601 con el formato yyyy-MM-ddTHH:mm:ssZ.	2021-05-08T16:00:00Z
InstanceName	string	El nombre del servidor.	test-InstanceName
BusinessStatus	string	El estado del servidor. Valores válidos: Normal: Normal. Expired: Vencido. Overdue: Pago vencido.	Normal
DdosStatus	string	El estado de DDoS. Valores válidos: Normal: Normal. BlackHole: El filtrado de agujero negro está activado. Defense: El tráfico se está limpiando.	Normal
ImageId	string	El ID de la imagen.	fe9c66133a9d4688872869726b52****
DisableReason	string	El motivo por el que el recurso está deshabilitado. Valores válidos: FINANCIAL: El recurso está bloqueado debido a un pago vencido. SECURITY: El recurso está bloqueado por motivos de seguridad. EXPIRED: La instancia está vencida.	EXPIRED
Combination	boolean	Especifica si el plan es un plan combinado.	false
CombinationInstanceId	string	El ID de la instancia del plan combinado.	com-f6c9a22****45b5b8de68ad608af1ba
Uuid	string	El UUID de la instancia.	41f30524-5df7-49c9-9c6e-32****489001
ResourceSpec	object	Las especificaciones del recurso.
DiskCategory	string	La categoría del disco en la nube. Valores válidos: ESSD: ESSD de nivel de rendimiento (PL) 0. SSD: SSD estándar. CLOUD_EFFICIENCY: disco ultra.	ESSD
Cpu	integer	El número de vCPU.	2
Bandwidth	integer	El ancho de banda. Unidad: Mbit/s.	200
DiskSize	integer	El tamaño del disco en la nube. Unidad: GiB.	60
Memory	number	El tamaño de la memoria. Unidad: GiB.	2
Flow	number	La cuota de transferencia de datos. Un valor de 0 indica una instancia basada en el ancho de banda. Un valor distinto de cero indica una instancia basada en un plan de transferencia de datos.	818
Image	object	La información de la imagen.
OsType	string	El tipo de sistema operativo.	windows
ImageName	string	El nombre de la imagen.	test-custom-1686536882356
ImageVersion	string	La versión de la imagen.	V3.5
ImageType	string	El tipo de imagen. Valores válidos: system: imagen del sistema. app: imagen de aplicación. custom: imagen personalizada.	system
ImageIconUrl	string	La URL del icono de la imagen.	https://img.alicdn.com/imgextra/i3/O**1vdh9651ReKqWNMI2I_!!6000000002136**-24-24.svg
ImageContact	string	El proveedor de la imagen.	https://selfs****e.console.alibabacloud.com/ticket/createIndex
Tags	array<object>	Las etiquetas de la instancia.
	object	La etiqueta.
Key	string	La clave de la etiqueta de la instancia.	TestKey
Value	string	El valor de la etiqueta de la instancia.	TestValue
Disks	array<object>	La matriz de información de los discos en la nube del servidor de aplicaciones simple.
	array<object>	La información del disco en la nube.
CreationTime	string	La hora de creación de la instancia. La hora se muestra en UTC en el estándar ISO 8601 con el formato yyyy-MM-ddTHH:mm:ssZ.	2023-02-24T02:20:10Z
Status	string	El estado del disco en la nube. Valores válidos: ReIniting: El disco en la nube se está inicializando. Creating: El disco en la nube se está creando. In_use: El disco en la nube está en uso. Available: El disco en la nube no está adjunto. Attaching: El disco en la nube se está montando. Detaching: El disco en la nube se está desmontando.	In_use
Device	string	El nombre del dispositivo del disco en la nube en el servidor.	/dev/xvda
Size	integer	El tamaño del disco en la nube. Unidad: GiB.	50
DiskName	string	El nombre del disco en la nube.	SystemDisk
DiskChargeType	string	El método de facturación del disco en la nube.	PrePaid
DiskType	string	El tipo de disco en la nube. Valores válidos: system: disco en la nube del sistema. data: disco en la nube de datos.	system
Category	string	La categoría del disco en la nube. Valores válidos: ESSD: ESSD de nivel de rendimiento (PL) 0. SSD: SSD estándar. CLOUD_EFFICIENCY: disco ultra.	ESSD
DiskId	string	El ID del disco en la nube.	d-bp14wq0149cpp2x****
RegionId	string	El ID de la región.	cn-hangzhou
Remark	string	Las observaciones del disco en la nube.	remark
DiskTags	array<object>	La información de las etiquetas del disco en la nube.
	object	La información de la etiqueta.
Key	string	La clave de la etiqueta.	TestKey
Value	string	El valor de la etiqueta.	TestValue
ResourceGroupId	string	El ID del grupo de recursos al que pertenece el disco en la nube.	rg-aek2bti7cf7****
ResourceGroupId	string	El ID del grupo de recursos al que pertenece la instancia.	rg-aekz7jmhg5s****
NetworkAttributes	array<object>	Los atributos de red.
	object	Los atributos de red.
PublicIpAddress	string	La dirección IP pública.	116.62.XX.XX
PrivateIpAddress	string	La dirección IP privada.	72.25.XX.XX
PeakBandwidth	integer	El ancho de banda público máximo. Unidad: Mbit/s.	200
PublicIpDdosStatus	string	El estado de DDoS de la dirección IP pública.	normal
PlanType	string	El tipo de plan. Valores válidos: NORMAL: de uso general. CAPACITY: optimizado para almacenamiento. PREVIOUS: generación anterior. MULTI_IP: varias direcciones IP públicas. INTERNATIONAL: internacional. Nota Para obtener más información, consulte Familias de instancias.	NORMAL
CommodityCode	string	El código de producto de la instancia.
TotalCount	integer	El número total de instancias devueltas.	1
RequestId	string	El ID de la solicitud.	20758A-585D-4A41-A9B2-28DA8F4F****
PageSize	integer	La configuración del número de entradas por página para la paginación en una consulta paginada.	10
PageNumber	integer	El número de página de la lista de servidores de aplicaciones simples.	1

Ejemplos

Respuesta exitosa

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.alibabacloud.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 error

Código de estado HTTP	Código de error	Mensaje de error
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 error para ver la lista completa.

Notas de la versión

Consulte Notas de la versión para ver la lista completa.