All Products
Search
Document Center

Serverless App Engine:ListPublishedServices

Last Updated:Mar 21, 2025

Queries a list of microservices that are published.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

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:
    • For mandatory resource types, indicate with a prefix of * .
    • 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
sae:ListPublishedServicesget
*All Resources
*
    none
none

Request syntax

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

Request parameters

ParameterTypeRequiredDescriptionExample
AppIdstringYes

The ID of the application.

b2a8a925-477a-4ed7-b825-d5e22500****

Response parameters

ParameterTypeDescriptionExample
object

The returned data.

RequestIdstring

The request ID.

91F93257-7A4A-4BD3-9A7E-2F6EAE6D****
Messagestring

The returned message. Valid values:

  • success: If the call is successful, success is returned.
  • An error code: If the call fails, an error code is returned.
success
TraceIdstring

The trace ID that is used to query the details of the request.

0a98a02315955564772843261e****
Dataarray<object>

The details of the microservices.

Dataobject
Typestring

The type of the published service.

RPC
Groupsarray

The service group that corresponds to the consumed service.

Groupstring

The service group that corresponds to the consumed service.

HSF
Versionstring

The version of the published services.

1.0.0
AppIdstring

The ID of the application.

b2a8a925-477a-4ed7-b825-d5e22500****
Group2Ipstring

The reserved parameter. This parameter does not take effect.

{}
Ipsarray

The addresses where services can be subscribed to.

Ipstring

The address where the service can be subscribed to.

10.0.0.1
Namestring

The name of the published service.

com.alibaba.nodejs.ItemService
ErrorCodestring

The error code. Valid values:

  • If the call is successful, the ErrorCode parameter is not returned.
  • If the call fails, the ErrorCode parameter is returned. For more information, see the Error codes section in this topic.
Codestring

The HTTP status code. Valid values:

  • 2xx: The call was successful.
  • 3xx: The call was redirected.
  • 4xx: The call failed.
  • 5xx: A server error occurred.
200
Successboolean

Indicates whether the list of microservices was queried. Valid values:

  • true: The list was queried.
  • false: The list failed to be queried.
true

Examples

Sample success responses

JSONformat

{
  "RequestId": "91F93257-7A4A-4BD3-9A7E-2F6EAE6D****",
  "Message": "success",
  "TraceId": "0a98a02315955564772843261e****",
  "Data": [
    {
      "Type": "RPC",
      "Groups": [
        "HSF"
      ],
      "Version": "1.0.0",
      "AppId": "b2a8a925-477a-4ed7-b825-d5e22500****",
      "Group2Ip": "{}",
      "Ips": [
        "10.0.0.1"
      ],
      "Name": "com.alibaba.nodejs.ItemService"
    }
  ],
  "ErrorCode": "",
  "Code": "200",
  "Success": true
}

Error codes

HTTP status codeError codeError message
400InvalidParameter.ObviouslyThe specified parameter is invalid {%s}.
400InvalidParameter.NotEmptyYou must specify the parameter %s.

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

Change history

Change timeSummary of changesOperation
No change history