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

Llama a la API DescribeApplicationStatus para obtener el estado de una 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:DescribeApplicationStatus

get

*All Resource

*

Ninguna

Sintaxis de la solicitud

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

Parámetros de la solicitud

Parámetro	Tipo	Obligatorio	Descripción	Ejemplo
AppId	string	Sí	El ID de la aplicación.	0099b7be-5f5b-4512-a7fc-56049ef1****

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 de respuesta. Si la llamada se realiza correctamente, se devuelve success. Si la llamada falla, se devuelve un mensaje de error.	success
TraceId	string	El ID de rastreo que se utiliza para consultar los detalles de una solicitud.	0a98a02315955564772843261e****
Data	object	Los datos de respuesta.
ArmsAdvancedEnabled	string	Indica si ARMS Advanced Edition está habilitado. Valores válidos: true: habilitado. false: deshabilitado.	false
LastChangeOrderId	string	El ID de la orden de cambio ejecutada más recientemente. Este parámetro está vacío si no se ha ejecutado ninguna orden de cambio o si la información sobre la orden de cambio ha caducado.	1ccc2339-fc19-49aa-bda0-1e7b8497****
ArmsApmInfo	string	Los metadatos de la aplicación en ARMS.	{"appId":"0099b7be-5f5b-4512-a7fc-56049ef1**","licenseKey":"d5cgdt5pu0@7303f55292a**"}
CreateTime	string	La hora en que se creó la aplicación. Este valor es una marca de tiempo UNIX.	1563373372746
CurrentStatus	string	El estado actual de la aplicación. Valores válidos: RUNNING: La aplicación se está ejecutando. STOPPED: La aplicación está detenida. UNKNOWN: El estado de la aplicación es desconocido.	RUNNING
AppId	string	El ID de la aplicación.	0099b7be-5f5b-4512-a7fc-56049ef1****
LastChangeOrderRunning	boolean	Indica si la orden de cambio más reciente se está ejecutando. Valores válidos: true false	false
RunningInstances	integer	El número de instancias en ejecución de la aplicación.	1
LastChangeOrderStatus	string	El estado de la orden de cambio más reciente. Valores válidos: READY: La orden de cambio está lista. RUNNING: La orden de cambio se está ejecutando. SUCCESS: La orden de cambio se completó correctamente. FAIL: La orden de cambio falló. ABORT: La orden de cambio se canceló. WAIT_BATCH_CONFIRM: La orden de cambio está esperando confirmación manual para el siguiente lote. AUTO_BATCH_WAIT: La orden de cambio se encuentra en estado de espera para un lote automático. SYSTEM_FAIL: Ocurrió un error del sistema. WAIT_APPROVAL: La orden de cambio está pendiente de aprobación. APPROVED: La orden de cambio está aprobada y pendiente de ejecución.	SUCCESS
SubStatus	string	El subestado de la orden de cambio. Este parámetro se utiliza para determinar si ocurre una excepción durante el proceso de lanzamiento. Valores válidos: NORMAL: El lanzamiento es normal. RUNNING_BUT_HAS_ERROR: El lanzamiento es anómalo. Por ejemplo, si ocurre un error durante un lanzamiento por fases, debe revertir manualmente el lanzamiento. En este caso, la orden de cambio no puede completarse y su estado permanece como RUNNING.	NORMAL
EnableAgent	boolean	Indica si el agente de SAE está habilitado. Valores válidos: true false	false
FileSizeLimit	integer	El límite de tamaño de archivo. Unidad: KB. Valores válidos: de 0 a 10240.	10240
ErrorCode	string	El código de error. Si la solicitud se realiza correctamente, este parámetro no se devuelve. Si la solicitud falla, este parámetro se devuelve. 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. Valores válidos: 2xx: La solicitud se realizó correctamente. 3xx: La solicitud fue redirigida. 4xx: La solicitud no era válida. 5xx: Ocurrió un error del servidor.	200
Success	boolean	Indica si se obtuvo el estado de la aplicación. Valores válidos: true false	true

Ejemplos

Respuesta exitosa

JSON Formato

{
  "RequestId": "91F93257-7A4A-4BD3-9A7E-2F6EAE6D****",
  "Message": "success",
  "TraceId": "0a98a02315955564772843261e****",
  "Data": {
    "ArmsAdvancedEnabled": "false",
    "LastChangeOrderId": "1ccc2339-fc19-49aa-bda0-1e7b8497****",
    "ArmsApmInfo": "{\"appId\":\"0099b7be-5f5b-4512-a7fc-56049ef1****\",\"licenseKey\":\"d5cgdt5pu0@7303f55292a****\"}",
    "CreateTime": "1563373372746",
    "CurrentStatus": "RUNNING",
    "AppId": "0099b7be-5f5b-4512-a7fc-56049ef1****",
    "LastChangeOrderRunning": false,
    "RunningInstances": 1,
    "LastChangeOrderStatus": "SUCCESS",
    "SubStatus": "NORMAL",
    "EnableAgent": false,
    "FileSizeLimit": 10240
  },
  "ErrorCode": "",
  "Code": "200",
  "Success": true
}

Códigos de error

Código de estado HTTP	Código de error	Mensaje de error
400	InvalidApplication.NotFound	The current application does not exist.
400	InvalidParameter.NotEmpty	You must specify the parameter %s.
404	InvalidAppId.NotFound	The specified AppId 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.