ListAppServices-阿里云帮助中心

Lists microservices.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

sae:ListAppServices

list

*All Resource

*

None

Request syntax

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

Request parameters

Parameter	Type	Required	Description	Example
AppId	string	No	The application ID. Specify exactly one of the following parameters: `VpcId`, `NamespaceId`, or `AppId`.	017f39b8-dfa4-4e16-a84b-1dcee4b1****
ServiceType	string	No	The service type. Valid values: dubbo springCloud hsf k8sService	springCloud
RegistryType	string	No	The service registry type. Valid values: 0: SAE Nacos 1: self-managed service registry 2: MSE Nacos 9: SAE K8s Service	0
NacosInstanceId	string	No	The instance ID of MSE Nacos. This parameter is required if the service registry is MSE Nacos.	mse-cn-sco3r0u****
NacosNamespaceId	string	No	The namespace ID of MSE Nacos. This parameter is required if the service registry is MSE Nacos.	mse-test
PageNumber	integer	No	The page number.	1
PageSize	integer	No	The number of entries per page.	10
VpcId	string	No	The ID of the VPC. Specify exactly one of the following parameters: `VpcId`, `NamespaceId`, or `AppId`.	vpc-2ze0i263cnn311nvj****
NamespaceId	string	No	The namespace ID. Specify exactly one of the following parameters: `VpcId`, `NamespaceId`, or `AppId`.	cn-beijing:test

Response elements

Element	Type	Description	Example
	object
RequestId	string	The request ID.	91F93257-7A4A-4BD3-9A7E-2F6EAE6D****
Message	string	The response message. If the request is successful, success is returned. If the request fails, an error message is returned.	success
TraceId	string	The trace ID. You can use this ID to query the details of a call.	0a98a02315955564772843261e****
Data	array<object>	The list of services.
	array<object>	The details of a service.
ServiceName	string	The name of the service.	frontend
ServiceGroup	string	The service group.	DEFAULT_GROUP
ServiceVersion	string	The version of the service.	1.0.0
InstanceCount	string	The number of instances of the service.	1
ServiceType	string	The type of the service. Valid values: dubbo springCloud hsf k8sService	springCloud
ServiceProtocol	string	The protocol used by the service.	HTTP
ServicePorts	array	A list of ports.
	integer	The port number.	8000
ServicePortAndProtocol	object	A map of ports and protocols.
	string	A port and protocol pair.	8000:TCP
RegistryType	string	The type of the service registry. Valid values: 0: SAE Nacos 1: self-managed registry 2: MSE Nacos 9: SAE K8s Service	0
NamespaceId	string	The ID of the namespace that contains the app.	cn-beijing:test
NamespaceName	string	The name of the namespace.	Test namespace
AppId	string	The app ID.	0099b7be-5f5b-4512-a7fc-56049ef1****
AppName	string	The name of the app.	demo-app
SecurityGroupId	string	The security group ID.	sg-wz969ngg2e49q5i4****
ErrorCode	string	The error code. This parameter is returned only if the request fails. For more information, see the Error codes section. Successful requests do not return the ErrorCode field. Failed requests return the ErrorCode field. For more information, see the error code list in this topic.
Code	string	The HTTP status code or a POP error code. Valid values: 2xx: The request is successful. 3xx: The request is redirected. 4xx: The request is invalid. 5xx: A server error occurred.	200
Success	boolean	Indicates whether the call was successful. Valid values: true: The call was successful. false: The call failed.	true

Examples

Success response

JSON format

{
  "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
}

Error codes

HTTP status code	Error code	Error message	Description
400	Micro.Service.NotFound	The micro service not found {%s}.
400	InvalidParameter.Obviously	The specified parameter is invalid {%s}.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.