DescribeApplicationInstances - Serverless App Engine - Centro de documentación de Alibaba Cloud

Obtiene una lista de instancias de aplicación.

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

sae:DescribeApplicationInstances

get

*All Resource

*

Ninguna

Sintaxis de la solicitud

GET /pop/v1/sam/app/describeApplicationInstances HTTP/1.1

Parámetros de la solicitud

Parámetro	Tipo	Obligatorio	Descripción	Ejemplo
AppId	string	Sí	El ID de la aplicación.	d700e680-aa4d-4ec1-afc2-6566b5ff****
GroupId	string	Sí	El ID del grupo de aplicaciones. Llame a la operación DescribeApplicationGroups para obtener el ID.	b2a8a925-477a-4ed7-b825-d5e22500****
CurrentPage	integer	No	El número de la página que se va a devolver.	1
PageSize	integer	No	El número de entradas que se van a devolver en cada página. Valor predeterminado: 10. El valor debe estar en el rango (0, 1000000000).	10
Reverse	boolean	No	Especifica el orden de clasificación de las instancias de aplicación. Las instancias se clasifican primero por estado de ejecución y luego por ID de instancia. Valores válidos: true: Las instancias se clasifican en orden descendente. false: Las instancias se clasifican en orden ascendente. Estados de instancia en orden ascendente: Error: Ocurrió un error durante el inicio de la instancia. CrashLoopBackOff: El contenedor no pudo iniciarse y entró en un bucle de reinicio por fallo. ErrImagePull: Ocurrió un error al extraer la imagen de contenedor para la instancia. ImagePullBackOff: El sistema intenta repetidamente extraer la imagen de contenedor sin éxito. Pending: La instancia está en espera de ser programada. Unknown: Ocurrió una excepción desconocida. Terminating: La instancia se está terminando. NotFound: No se encuentra la instancia. PodInitializing: La instancia se está inicializando. Init:0/1: La instancia se está inicializando. Running: La instancia está en ejecución.	true
InstanceId	string	No	El ID de la instancia de aplicación.	demo-faaca66c-5959-45cc-b3bf-d26093b2e9c0******
PipelineId	string	No	El ID del lote. Llame a la operación DescribeChangeOrder para obtener el ID.	85750d48-6cfc-4dbf-8ea0-840397******

Elementos de la respuesta

Elemento	Tipo	Descripción	Ejemplo
	object	Los datos devueltos.
RequestId	string	El ID de la solicitud.	91F93257-7A4A-4BD3-9A7E-2F6EAE6D****
Message	string	El mensaje devuelto para la solicitud.	success
TraceId	string	El ID de rastreo utilizado para consultar los detalles de la solicitud.	0a98a02315955564772843261e****
Data	object	La información sobre las instancias de aplicación.
CurrentPage	integer	El número de página actual.	1
TotalSize	integer	El número total de instancias.	10
PageSize	integer	El número de entradas devueltas por página.	10
Instances	array<object>	La lista de instancias de aplicación.
	array<object>	Los detalles de una instancia de aplicación.
CreateTimeStamp	integer	La hora en que comenzó la creación de la instancia. Unidad: milisegundos.	1558442609000
VSwitchId	string	El ID del vSwitch donde se despliega la instancia.	vsw-***
InstanceContainerStatus	string	El estado del contenedor de la instancia. Valores válidos: Error: Ocurrió un error durante el inicio de la instancia. CrashLoopBackOff: El contenedor no pudo iniciarse, encontró un error durante el inicio y luego falló nuevamente después de un reinicio. ErrImagePull: No se pudo extraer la imagen de contenedor de la instancia. ImagePullBackOff: No se pudo extraer la imagen de contenedor. Pending: La instancia está en espera de ser programada. Unknown: Ocurrió una excepción desconocida. Terminating: La instancia se está deteniendo. NotFound: No se encuentra la instancia. PodInitializing: La instancia se está inicializando. Init:0/1: La instancia se está inicializando. Running: La instancia está en ejecución.	Running
InstanceHealthStatus	string	El estado de la comprobación de salud de la instancia. Valores válidos: WithoutHealthCheckConfig: Las comprobaciones de salud de actividad (liveness) y preparación (readiness) no están configuradas. WithoutLivenessConfig: La comprobación de salud de actividad (liveness) no está configurada. WithoutReadinessConfig: La comprobación de salud de preparación (readiness) no está configurada. NotCheckedYet: La instancia está realizando o esperando una comprobación de salud. LivenessUnhealthy: La comprobación de salud de actividad (liveness) falló. La instancia no está saludable. ReadinessUnhealthy: La comprobación de salud de preparación (readiness) falló. La instancia no está saludable. Unhealthy: Tanto la comprobación de salud de actividad (liveness) como la de preparación (readiness) fallaron. La instancia no está saludable. Healthy: La comprobación de salud fue exitosa. La instancia está saludable.	WithoutHealthCheckConfig
InstanceContainerRestarts	integer	El número de veces que se ha reiniciado el contenedor de la instancia.	0
GroupId	string	El ID del grupo al que pertenece la instancia.	b2a8a925-477a-4ed7-b825-d5e22500****
InstanceContainerIp	string	La dirección IP interna de la instancia.	192.168.X.X
InstanceId	string	El ID de la instancia.	b2a8a925-477a-4ed7-b825-d5e22500****
ImageUrl	string	La URL de la imagen de contenedor. Nota Si despliega una aplicación mediante un paquete JAR o WAR, la imagen de contenedor generada por SAE no está disponible para descarga.	registry-vpc.cn-beijing.aliyuncs.com/sae-demo-image/cartservice:1.0
PackageVersion	string	La versión del paquete de despliegue.	1609939496200
Timestamp	integer	La marca de tiempo.	1750061980000
Eip	string	La dirección IP elástica (EIP).	8.129.XX.XXX
FinishTimeStamp	integer	La hora en que se completó la creación de la instancia. Unidad: milisegundos.	1642757283000
DebugStatus	boolean	Indica si la instancia se está depurando. Valores válidos: true: La instancia se está depurando. false: La instancia no se está depurando.	False
SidecarContainersStatus	array<object>	El estado de los contenedores sidecar.
	object	El estado de un contenedor sidecar.
ContainerId	string	El ID del contenedor sidecar.	sidecar-test-01
ContainerStatus	string	El estado del contenedor.	Running
ImageUrl	string	La URL de la imagen de contenedor.	registry.cn-beijing.aliyuncs.com/sae-dev-test/******
MainContainerStatus	string	El estado del contenedor principal.	Running
UnhealthyMessage	string	El mensaje de error de una comprobación de salud fallida en la instancia de aplicación. Este campo está vacío si la comprobación es exitosa.
TrafficStatus	string	El estado del tráfico de la instancia.
Tags	array<object>	Las etiquetas asociadas a la instancia.
	object
Key	string	La clave de la etiqueta.
Value	string	El valor de la etiqueta.
ErrorCode	string	El código de error. Valores válidos: Este parámetro no se devuelve para solicitudes exitosas. Este parámetro se devuelve para solicitudes fallidas. Para obtener más información, consulte la sección Códigos de error en este tema.
Code	string	El código de estado HTTP o el código de error POP. Valores válidos: 2xx: La solicitud fue exitosa. 3xx: La solicitud fue redirigida. 4xx: Ocurrió un error de cliente. 5xx: Ocurrió un error de servidor.	200
Success	boolean	Indica si la solicitud fue exitosa. Valores válidos: true: La solicitud fue exitosa. false: La solicitud falló.	true

Ejemplos

Respuesta exitosa

JSON Formato

{
  "RequestId": "91F93257-7A4A-4BD3-9A7E-2F6EAE6D****",
  "Message": "success",
  "TraceId": "0a98a02315955564772843261e****",
  "Data": {
    "CurrentPage": 1,
    "TotalSize": 10,
    "PageSize": 10,
    "Instances": [
      {
        "CreateTimeStamp": 1558442609000,
        "VSwitchId": "vsw-***",
        "InstanceContainerStatus": "Running",
        "InstanceHealthStatus": "WithoutHealthCheckConfig",
        "InstanceContainerRestarts": 0,
        "GroupId": "b2a8a925-477a-4ed7-b825-d5e22500****",
        "InstanceContainerIp": "192.168.X.X",
        "InstanceId": "b2a8a925-477a-4ed7-b825-d5e22500****",
        "ImageUrl": "registry-vpc.cn-beijing.aliyuncs.com/sae-demo-image/cartservice:1.0",
        "PackageVersion": "1609939496200",
        "Timestamp": 1750061980000,
        "Eip": "8.129.XX.XXX",
        "FinishTimeStamp": 1642757283000,
        "DebugStatus": true,
        "SidecarContainersStatus": [
          {
            "ContainerId": "sidecar-test-01",
            "ContainerStatus": "Running",
            "ImageUrl": "registry.cn-beijing.aliyuncs.com/sae-dev-test/******"
          }
        ],
        "MainContainerStatus": "Running",
        "UnhealthyMessage": "",
        "TrafficStatus": "",
        "Tags": [
          {
            "Key": "",
            "Value": ""
          }
        ]
      }
    ]
  },
  "ErrorCode": "",
  "Code": "200",
  "Success": true
}

Códigos de error

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.