All Products
Search
Document Center

:ListPublishedServices

Last Updated:Aug 01, 2024

Queries a list of microservices that are published.

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
sae:ListPublishedServicesget
  • All Resources
    *
    none
none

Request syntax

GET /pop/v1/sam/service/listPublishedServices

Request parameters

ParameterTypeRequiredDescriptionExample
AppIdstringYes

The ID of the request.

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

Response parameters

ParameterTypeDescriptionExample
object
RequestIdstring

The returned information. Valid values:

  • If the call is successful, success is returned.
  • If the call fails, an error code is returned.
91F93257-7A4A-4BD3-9A7E-2F6EAE6D****
Messagestring

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

success
TraceIdstring

The details of the microservices.

0a98a02315955564772843261e****
Dataarray<object>

The type of the published service.

object
Typestring

The service group that corresponds to the consumed service.

RPC
Groupsarray

The version of the published services.

string
HSF
Versionstring

The ID of the application.

1.0.0
AppIdstring

The reserved parameter. This parameter does not take effect.

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

The subscription address of the service.

{}
Ipsarray

The name of the published service.

string
10.0.0.1
Namestring

The returned 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 of this topic.
com.alibaba.nodejs.ItemService
ErrorCodestring

The HTTP status code. Valid values:

  • 2xx: indicates that the call was successful.
  • 3xx: indicates that the call was redirected.
  • 4xx: indicates that the call failed.
  • 5xx: indicates that a server error occurred.
Codestring

Indicates whether the microservice list was obtained. Valid values:

  • true: The list was obtained.
  • false: The list failed to be obtained.
200

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