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

Lista los microservicios.

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

list

*All Resource

*

Ninguna

Sintaxis de la solicitud

GET /pop/v1/sam/service/listAppServices HTTP/1.1

Parámetros de la solicitud

Parámetro	Tipo	Obligatorio	Descripción	Ejemplo
AppId	string	No	El ID de la aplicación. Especifique exactamente uno de los siguientes parámetros: VpcId, NamespaceId o AppId.	017f39b8-dfa4-4e16-a84b-1dcee4b1****
ServiceType	string	No	El tipo de servicio. Valores válidos: dubbo springCloud hsf k8sService	springCloud
RegistryType	string	No	El tipo de registro de servicios. Valores válidos: 0: SAE Nacos 1: registro de servicios autogestionado 2: MSE Nacos 9: SAE K8s Service	0
NacosInstanceId	string	No	El ID de instancia de MSE Nacos. Este parámetro es obligatorio si el registro de servicios es MSE Nacos.	mse-cn-sco3r0u****
NacosNamespaceId	string	No	El ID del espacio de nombres de MSE Nacos. Este parámetro es obligatorio si el registro de servicios es MSE Nacos.	mse-test
PageNumber	integer	No	El número de página.	1
PageSize	integer	No	El número de entradas por página.	10
VpcId	string	No	El ID de la VPC. Especifique exactamente uno de los siguientes parámetros: VpcId, NamespaceId o AppId.	vpc-2ze0i263cnn311nvj****
NamespaceId	string	No	El ID del espacio de nombres. Especifique exactamente uno de los siguientes parámetros: VpcId, NamespaceId o AppId.	cn-beijing:test

Elementos de la respuesta

Elemento	Tipo	Descripción	Ejemplo
	object
RequestId	string	El ID de la solicitud.	91F93257-7A4A-4BD3-9A7E-2F6EAE6D****
Message	string	El mensaje de respuesta. Si la solicitud se realiza correctamente, se devuelve success. Si la solicitud falla, se devuelve un mensaje de error.	success
TraceId	string	El ID de rastreo. Puede usar este ID para consultar los detalles de una llamada.	0a98a02315955564772843261e****
Data	array<object>	La lista de servicios.
	array<object>	Los detalles de un servicio.
ServiceName	string	El nombre del servicio.	frontend
ServiceGroup	string	El grupo de servicios.	DEFAULT_GROUP
ServiceVersion	string	La versión del servicio.	1.0.0
InstanceCount	string	El número de instancias del servicio.	1
ServiceType	string	El tipo de servicio. Valores válidos: dubbo springCloud hsf k8sService	springCloud
ServiceProtocol	string	El protocolo que utiliza el servicio.	HTTP
ServicePorts	array	Una lista de puertos.
	integer	El número de puerto.	8000
ServicePortAndProtocol	object	Un mapa de puertos y protocolos.
	string	Un par de puerto y protocolo.	8000:TCP
RegistryType	string	El tipo de registro de servicios. Valores válidos: 0: SAE Nacos 1: registro autogestionado 2: MSE Nacos 9: SAE K8s Service	0
NamespaceId	string	El ID del espacio de nombres que contiene la aplicación.	cn-beijing:test
NamespaceName	string	El nombre del espacio de nombres.	Test namespace
AppId	string	El ID de la aplicación.	0099b7be-5f5b-4512-a7fc-56049ef1****
AppName	string	El nombre de la aplicación.	demo-app
SecurityGroupId	string	El ID del security group.	sg-wz969ngg2e49q5i4****
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. Las solicitudes exitosas no devuelven el campo ErrorCode. Las solicitudes fallidas devuelven el campo ErrorCode. Para obtener más información, consulte la lista de códigos de error en este tema.
Code	string	El código de estado HTTP o un código de error POP. Valores válidos: 2xx: La solicitud se realizó correctamente. 3xx: La solicitud se redirigió. 4xx: La solicitud no es válida. 5xx: Ocurrió un error del servidor.	200
Success	boolean	Indica si la llamada se realizó correctamente. Valores válidos: true: La llamada se realizó correctamente. false: La llamada falló.	true

Ejemplos

Respuesta exitosa

JSON Formato

{
  "RequestId": "91F93257-7A4A-4BD3-9A7E-2F6EAE6D****",
  "Message": "success",
  "TraceId": "0a98a02315955564772843261e****",
  "Data": [
    {
      "ServiceName": "frontend",
      "ServiceGroup": "DEFAULT_GROUP",
      "ServiceVersion": "1.0.0",
      "InstanceCount": "1",
      "ServiceType": "springCloud",
      "ServiceProtocol": "HTTP",
      "ServicePorts": [
        8000
      ],
      "ServicePortAndProtocol": {
        "key": "8000:TCP"
      },
      "RegistryType": "0",
      "NamespaceId": "cn-beijing:test",
      "NamespaceName": "Test namespace",
      "AppId": "0099b7be-5f5b-4512-a7fc-56049ef1****",
      "AppName": "demo-app",
      "SecurityGroupId": "sg-wz969ngg2e49q5i4****"
    }
  ],
  "ErrorCode": "",
  "Code": "200",
  "Success": true
}

Códigos de error

Código de estado HTTP	Código de error	Mensaje de error	Descripción
400	Micro.Service.NotFound	The micro service not found {%s}.
400	InvalidParameter.Obviously	The specified parameter is invalid {%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.