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

Obtiene una lista de aplicaciones.

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

get

*All Resource

*

Ninguna

Sintaxis de la solicitud

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

Parámetros de la solicitud

Parámetro	Tipo	Obligatorio	Descripción	Ejemplo
CurrentPage	integer	No	El número de página actual.	1
PageSize	integer	No	El número de entradas por página en una consulta paginada. Valores válidos: [0,10000].	20
AppName	string	No	El nombre de la aplicación.	demo-app
NamespaceId	string	No	El ID del espacio de nombres.	cn-beijing:demo
Tags	string	No	Los pares clave-valor de las etiquetas. Valores válidos: key: la clave de la etiqueta. La longitud debe estar en el rango de [1,128]. value: el valor de la etiqueta. La longitud debe estar en el rango de [1,128]. Las etiquetas distinguen entre mayúsculas y minúsculas. Si especifica varias etiquetas, todas las etiquetas especificadas se crean y se adjuntan al recurso. Cada clave de etiqueta en el mismo recurso solo puede tener un valor de etiqueta. Si agrega una clave de etiqueta que ya existe, el valor de etiqueta correspondiente se actualiza al nuevo valor. Las etiquetas no pueden comenzar con `aliyun` o `acs:`, y no pueden contener `http://` o `https://`.	[{"key":"key","value":"value"}]
OrderBy	string	No	El campo por el cual ordenar las aplicaciones. Valores válidos: runnings: ordena por el número actual de instancias objetivo. instances: ordena por el número objetivo de instancias objetivo.	runnings
Reverse	boolean	No	Especifica si se deben ordenar las instancias de la aplicación por estado de ejecución. Si las instancias tienen el mismo estado, se ordenan por ID de instancia. Valores válidos: true: ordena en orden ascendente. Las instancias se organizan según la secuencia de inicio. Por ejemplo, para alcanzar el estado de ejecución, una instancia debe pasar por pasos como iniciar el contenedor, descargar la imagen e inicializar la instancia. false: ordena en orden descendente. El orden ascendente de las instancias es el siguiente: Error: ocurrió un error durante el inicio de la instancia. CrashLoopBackOff: el contenedor no pudo iniciarse, encontró un error durante el inicio y volvió a encontrar un error después del reinicio. ErrImagePull: ocurrió un error al descargar la imagen del contenedor para la instancia. ImagePullBackOff: no se puede obtener la imagen del contenedor. Pending: la instancia está esperando a 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 se está ejecutando.	true
FieldType	string	No	La dimensión por la cual filtrar las aplicaciones. Valores válidos: appName: nombre de la aplicación. appIds: ID de la aplicación. slbIps: dirección IP del SLB. instanceIps: dirección IP de la instancia.	appName
FieldValue	string	No	El nombre de la aplicación, el ID de la aplicación, la dirección IP del SLB o la dirección IP de la instancia de la aplicación objetivo.	demo-app
AppSource	string	No	El tipo de aplicación de Serverless App Engine (SAE). micro_service. web. job.	micro_service
IsStateful	string	No	Especifica si la aplicación conserva el estado.
NewSaeVersion	string	No	La versión de la aplicación. Valores válidos: lite: Edición Lite std: Edición Estándar pro: Edición Profesional
ProgrammingLanguage	string	No

Elementos de la respuesta

Elemento	Tipo	Descripción	Ejemplo
	object	Los datos de la respuesta.
Message	string	La información adicional sobre el resultado de la llamada.	success
RequestId	string	El ID de la solicitud.	B4D805CA-926D-41B1-8E63-7AD0C1ED****
Data	object	La lista de aplicaciones.
CurrentPage	integer	El número de página actual.	1
TotalSize	integer	El número total de aplicaciones.	2
PageSize	integer	El tamaño de página.	20
Applications	array<object>	La lista de aplicaciones.
	array<object>	La información de la lista de aplicaciones.
AppName	string	El nombre de la aplicación.	demo-app
NamespaceId	string	El ID del espacio de nombres.	cn-beijing:demo
AppDeletingStatus	boolean	Indica si la aplicación se está eliminando. Valores válidos: true: La aplicación se está eliminando. false: La aplicación no se está eliminando.	false
AppId	string	El ID de la aplicación.	f7730764-d88f-4b9a-8d8e-cd8efbfe****
Tags	array<object>	Las etiquetas de la aplicación.
	object	La información de las etiquetas de la aplicación.
Key	string	La clave de la etiqueta.	key
Value	string	El valor de la etiqueta.	value
RunningInstances	integer	El número de instancias en ejecución.	2
Instances	integer	El número de instancias de la aplicación.	2
RegionId	string	El ID de la región.	cn-beijing
AppDescription	string	La descripción de la aplicación.	description
Cpu	integer	La CPU requerida para cada instancia, en milinúcleos. Este valor no puede ser 0. Solo se admiten las siguientes especificaciones definidas: 500 1000 2000 4000 8000 16000 32000	1000
Mem	integer	La memoria requerida para cada instancia, en MB. Este valor no puede ser 0. La memoria tiene una asignación uno a uno con la CPU. Solo se admiten las siguientes especificaciones definidas: 1024: corresponde a 500 y 1000 milinúcleos de CPU. 2048: corresponde a 500, 1000 y 2000 milinúcleos de CPU. 4096: corresponde a 1000, 2000 y 4000 milinúcleos de CPU. 8192: corresponde a 2000, 4000 y 8000 milinúcleos de CPU. 12288: corresponde a 12000 milinúcleos de CPU. 16384: corresponde a 4000, 8000 y 16000 milinúcleos de CPU. 24576: corresponde a 12000 milinúcleos de CPU. 32768: corresponde a 16000 milinúcleos de CPU. 65536: corresponde a 8000, 16000 y 32000 milinúcleos de CPU. 131072: corresponde a 32000 milinúcleos de CPU.	1024
MseEnabled	boolean	Indica si la gobernanza de microservicios de MSE está habilitada para la aplicación.	true
MseNamespaceId	string	El espacio de nombres de la gobernanza de microservicios de MSE. default: Edición gratuita sae-pro: Edición profesional sae-ent: Edición empresarial	sae-ent
BaseAppId	string	El ID de la aplicación base. Esta propiedad solo existe para las aplicaciones de despliegue canary.	xxx-xxx-xx-xxx
ProgrammingLanguage	string	El lenguaje de programación de la aplicación.	java
Children	array<object>	La lista de aplicaciones de despliegue canary para esta aplicación.
	array<object>	La información detallada.
AppName	string	El nombre de la aplicación.	app1
NamespaceId	string	El ID del espacio de nombres.	cn-beijing:demo
AppDeletingStatus	boolean	Indica si la aplicación se está eliminando.	false
AppId	string	El ID de la aplicación.	xxx-xxx-xxx-xxx
ScaleRuleEnabled	boolean	Indica si la política de escalado elástico está habilitada.	false
ScaleRuleType	string	El tipo de regla de escalado elástico.	timing
Tags	array<object>	Las etiquetas de la aplicación.
	object	Las etiquetas de la aplicación.
Key	string	La clave de la etiqueta.	key
Value	string	El valor de la etiqueta.	value
RunningInstances	integer	El número de instancias en ejecución.	2
Instances	integer	El número de instancias.	2
RegionId	string	El ID de la región.	cn-beijing
AppDescription	string	La descripción de la aplicación.	Aplicación de prueba
Cpu	integer	El tamaño de la CPU.	2000
Mem	integer	El tamaño de la memoria.	2048
MseEnabled	boolean	Indica si la gobernanza de microservicios de MSE está habilitada para la aplicación.	true
BaseAppId	string	El ID de la aplicación base.	ee99cce6-1c8e-4bfa-96c3-3e2fa9******
ProgrammingLanguage	string	El lenguaje de programación de la aplicación.	java
AppType	string	El tipo de despliegue de la aplicación.	Image
NamespaceName	string	El nombre del espacio de nombres.	demo
IsStateful	boolean	Especifica si la aplicación conserva el estado.
NewSaeVersion	string	La versión de la aplicación. Valores válidos: lite: Edición Lite std: Edición Estándar pro: Edición Profesional	pro
ResourceType	string	El tipo de recurso.
EnableIdle	string	Indica si el modo inactivo está habilitado.
ImageUrl	string	La URL de la imagen.	registry.cn-hangzhou.aliyuncs.com/sae-serverless-demo/sae-demo:microservice-java-provider-v1.0
PackageUrl	string	La URL del paquete de despliegue.	https://sae-oss-cn-hangzhou.oss-cn-hangzhou.aliyuncs.com/apps/K8S_APP_ID/1421801774382676/adf2624a-66fd-4a2b-8caa-6921da******/hello-sae.jar
AppType	string	El tipo de despliegue de la aplicación.	Image
NamespaceName	string	El nombre del espacio de nombres.	demo
IsStateful	boolean	Especifica si la aplicación conserva el estado.
NewSaeVersion	string	La versión de la aplicación. Valores válidos: lite: Edición Lite std: Edición Estándar pro: Edición Profesional	pro
EnableIdle	string	Indica si el modo inactivo está habilitado.	false
DiskSize	integer	El tamaño de almacenamiento en disco, en GB.	20
VpcId	string	El ID de la VPC.
ResourceType	string	El tipo de recurso.
Labels	object	Las etiquetas.
	string
RaspEnabled	boolean
ErrorCode	string	El código de error. Valores válidos: Si la solicitud es exitosa, no se devuelve el campo ErrorCode. Si la solicitud falla, se devuelve el campo ErrorCode. Para obtener más información, consulte la sección Códigos de error en este tema.
Code	string	El estado de la API o el código de error POP. Valores válidos: 2xx: Éxito. 3xx: Redireccionamiento. 4xx: Error de solicitud. 5xx: Error del servidor.	200
Success	boolean	Indica si se obtuvo la lista de aplicaciones. Valores válidos: true: Obtenida. false: No obtenida.	true
CurrentPage	integer	El número de página actual.	1
TotalSize	integer	El número total de aplicaciones.	2
PageSize	integer	El tamaño de página.	20

Ejemplos

Respuesta exitosa

JSON Formato

{
  "Message": "success",
  "RequestId": "B4D805CA-926D-41B1-8E63-7AD0C1ED****",
  "Data": {
    "CurrentPage": 1,
    "TotalSize": 2,
    "PageSize": 20,
    "Applications": [
      {
        "AppName": "demo-app",
        "NamespaceId": "cn-beijing:demo",
        "AppDeletingStatus": false,
        "AppId": "f7730764-d88f-4b9a-8d8e-cd8efbfe****",
        "Tags": [
          {
            "Key": "key",
            "Value": "value"
          }
        ],
        "RunningInstances": 2,
        "Instances": 2,
        "RegionId": "cn-beijing",
        "AppDescription": "description",
        "Cpu": 1000,
        "Mem": 1024,
        "MseEnabled": true,
        "MseNamespaceId": "sae-ent",
        "BaseAppId": "xxx-xxx-xx-xxx",
        "ProgrammingLanguage": "java",
        "Children": [
          {
            "AppName": "app1",
            "NamespaceId": "cn-beijing:demo",
            "AppDeletingStatus": false,
            "AppId": "xxx-xxx-xxx-xxx",
            "ScaleRuleEnabled": false,
            "ScaleRuleType": "timing",
            "Tags": [
              {
                "Key": "key",
                "Value": "value"
              }
            ],
            "RunningInstances": 2,
            "Instances": 2,
            "RegionId": "cn-beijing",
            "AppDescription": "Test application",
            "Cpu": 2000,
            "Mem": 2048,
            "MseEnabled": true,
            "BaseAppId": " ee99cce6-1c8e-4bfa-96c3-3e2fa9******",
            "ProgrammingLanguage": "java",
            "AppType": "Image",
            "NamespaceName": "demo",
            "IsStateful": false,
            "NewSaeVersion": "pro",
            "ResourceType": "",
            "EnableIdle": ""
          }
        ],
        "ImageUrl": "registry.cn-hangzhou.aliyuncs.com/sae-serverless-demo/sae-demo:microservice-java-provider-v1.0",
        "PackageUrl": "https://sae-oss-cn-hangzhou.oss-cn-hangzhou.aliyuncs.com/apps/K8S_APP_ID/1421801774382676/adf2624a-66fd-4a2b-8caa-6921da******/hello-sae.jar",
        "AppType": "Image",
        "NamespaceName": "demo",
        "IsStateful": false,
        "NewSaeVersion": "pro",
        "EnableIdle": "false",
        "DiskSize": 20,
        "VpcId": "",
        "ResourceType": "",
        "Labels": {
          "key": ""
        },
        "RaspEnabled": false
      }
    ]
  },
  "ErrorCode": "",
  "Code": "200",
  "Success": true,
  "CurrentPage": 1,
  "TotalSize": 2,
  "PageSize": 20
}

Códigos de error

Código de estado HTTP	Código de error	Mensaje de error	Descripción
400	Illegal.argument	Illegal argument

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.