All Products
Search
Document Center

Microservices Engine:GetServiceList

Last Updated:Aug 12, 2024

Queries the services of an application.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

  • Operation: the value that you can use in the Action element to specify the operation on a resource.
  • Access level: the access level of each operation. The levels are read, write, and list.
  • Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
    • The required resource types are displayed in bold characters.
    • If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
  • Condition Key: the condition key that is defined by the cloud service.
  • Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
OperationAccess levelResource typeCondition keyAssociated operation
mse:GetServiceListget
  • All Resources
    *
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
RegionstringNo

The ID of the region.

cn-zhangjiakou
ServiceTypestringNo

The type of the framework.

dubbo
AppIdstringYes

The ID of the application.

xxx@xxx
ServiceNamestringNo

The name of the service.

com.alibaba.xxx
IpstringNo

The IP address.

127.0.0.1
AcceptLanguagestringNo

The language of the response.

zh

Response parameters

ParameterTypeDescriptionExample
object

The data structure.

HttpStatusCodeinteger

The HTTP status code returned.

200
Messagestring

The message returned.

success
RequestIdstring

The ID of the request.

xxx-xxx-xxx
Dataarray<object>

The data entries returned.

object

The result of the request.

EdasAppNamestring

The name of the application.

test
DubboApplicationNamestring

The name of the Dubbo application.

dubbo-application
Versionstring

The version information.

1.0.0
SpringApplicationNamestring

The name of the Spring application.

spring-application
RegistryTypestring

The type of the service registry.

nacos
ServiceTypestring

The type of the service.

dubbo
ServiceNamestring

The name of the service.

com.alibaba.xxx
Methodsarray<object>

The methods.

object

The methods.

Pathsarray

The paths.

string

The path of the service.

/path
ParameterTypesarray

The data types of the parameters.

string

The data type of the parameter.

int
RequestMethodsarray

The methods.

string

The method.

sayHello
Namestring

The name of the method.

sayHello
MethodControllerstring

The controller of the method.

com.alibaba.SayHelloController
ReturnTypestring

The type of the return value.

int
Metadataobject

The metadata.

{}
Groupstring

The group.

dubbo
Codeinteger

The status code returned.

200
Successboolean

Indicates whether the request was successful.

true

Examples

Sample success responses

JSONformat

{
  "HttpStatusCode": 200,
  "Message": "success",
  "RequestId": "xxx-xxx-xxx",
  "Data": [
    {
      "EdasAppName": "test",
      "DubboApplicationName": "dubbo-application",
      "Version": "1.0.0",
      "SpringApplicationName": "spring-application",
      "RegistryType": "nacos",
      "ServiceType": "dubbo",
      "ServiceName": "com.alibaba.xxx",
      "Methods": [
        {
          "Paths": [
            "/path"
          ],
          "ParameterTypes": [
            "int"
          ],
          "RequestMethods": [
            "sayHello"
          ],
          "Name": "sayHello",
          "MethodController": "com.alibaba.SayHelloController",
          "ReturnType": "int"
        }
      ],
      "Metadata": {},
      "Group": "dubbo"
    }
  ],
  "Code": 200,
  "Success": true
}

Error codes

HTTP status codeError codeError messageDescription
400IllegalRequestInvalid request:%sInvalid request: %s
400InvalidParameterParameter error:%sRequest parameter error: %s
403NoPermissionYou are not authorized to perform this operation:%sYou do not have the permission to use this interface:%s
404NotFoundNot found:%sThe resource does not exist:%s
500InternalErrorConsole error. Try again later:%sConsole error. Try again later: %s

For a list of error codes, visit the Service error codes.