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

Consulta la configuración de NLB para la 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:DescribeApplicationNlbs

get

*All Resource

*

Ninguna

Sintaxis de la solicitud

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

Parámetros de la solicitud

Parámetro	Tipo	Obligatorio	Descripción	Ejemplo
AppId	string	No	El ID de la aplicación.	7171a6ca-d1cd-4928-8642-7d5cfe69****

Elementos de la respuesta

Elemento	Tipo	Descripción	Ejemplo
	object	El cuerpo de la respuesta.
RequestId	string	El ID de la solicitud.	91F93257-7A4A-4BD3-9A7E-2F6EAE6D****
Message	string	El mensaje devuelto. Un valor `success` indica que la solicitud se realizó correctamente; de lo contrario, se devuelve un código de error.	success
TraceId	string	El ID de rastreo utilizado para consultar los detalles de la solicitud.	ac1a0b2215622246421415014e****
ErrorCode	string	El código de error. Este parámetro se devuelve solo si la solicitud falla. Para obtener más información, consulte la sección Códigos de error de este tema.
Code	string	El código de estado HTTP. Valores válidos: 2xx: La solicitud se realizó correctamente. 3xx: La solicitud se redirigió. 4xx: Ocurrió un error del cliente. 5xx: Ocurrió un error del servidor.	200
Success	string	Indica si la solicitud se realizó correctamente. Valores válidos: true: La solicitud se realizó correctamente. false: La solicitud falló.	true
Data	object	Los datos devueltos en la respuesta.
Instances	object	Una colección de detalles de instancias.
	object	Los detalles de una instancia.
DnsName	string	El nombre DNS.	nlb-wb7r6dlwetvt5j****.cn-hangzhou.nlb.aliyuncs.com
Listeners	object	Una colección de detalles de listeners.
	object	Los detalles de un listener.
Protocol	string	El protocolo del listener.	TCPSSL
Port	integer	El puerto del listener.	80
Status	string	El estado del listener de NLB. Valores válidos: Creating: El listener se está creando. Configuring: El listener se está configurando. Bounded: El listener se ejecuta según lo esperado. Unbinding: El listener se está eliminando. Failed: El listener no está disponible.	Bounded
TargetPort	integer	El puerto de destino.	8080
CertIds	string	El ID del certificado de servidor.	123157******
CreatedBySae	boolean	Indica si SAE creó la instancia. Valores válidos: true: SAE creó la instancia. false: SAE reutilizó una instancia existente.	true

Ejemplos

Respuesta exitosa

JSON Formato

{
  "RequestId": "91F93257-7A4A-4BD3-9A7E-2F6EAE6D****",
  "Message": "success",
  "TraceId": "ac1a0b2215622246421415014e****",
  "ErrorCode": "",
  "Code": "200",
  "Success": "true",
  "Data": {
    "Instances": {
      "key": {
        "DnsName": "nlb-wb7r6dlwetvt5j****.cn-hangzhou.nlb.aliyuncs.com",
        "Listeners": {
          "key": {
            "Protocol": "TCPSSL",
            "Port": 80,
            "Status": "Bounded",
            "TargetPort": 8080,
            "CertIds": "123157******"
          }
        },
        "CreatedBySae": 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.
400	InvalidParameter.Obviously	The specified parameter is invalid {%s}.
400	InvalidParameter.WithMessage	The parameter is invalid {%s}: %s

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.