All Products
Search
Document Center

Enterprise Distributed Application Service:GetServiceListPage

Last Updated:Jan 08, 2024

Queries services.

Debugging

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

Debug

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
edas:ReadServiceRead
  • NameSpace
    acs:edas:{#regionId}:{#accountId}:namespace/{#NameSpaceId}
    none
none

Request syntax

POST /pop/sp/api/mseForOam/getServiceListPage

GET /pop/sp/api/mseForOam/getServiceListPage

Request parameters

ParameterTypeRequiredDescriptionExample
regionstringYes

The ID of the region.

cn-hangzhou
namespacestringNo

The namespace.

cn-hangzhou:doc-test
originstringNo

The source of the data. Valid values:

  • agent: Use this value if you use the service query feature of the latest version to pass the query result.
  • registry: Use this value if you use the service query feature of the earlier version to pass the query result.
Agent
serviceTypestringNo

The type of the service. Valid values:

  • dubbo
  • springCloud
  • hsf
  • istio
SpringCloud
searchTypestringYes

The type of the service. Valid values:

  • app: searches by application.
  • service: searches by service.
  • providerIp: searches by IP address.
App
searchValuestringNo

The keyword used for the search.

  • Set this parameter to the ID of the application if you set the searchType parameter to app.``
  • Set this parameter to the name of the service if you set the serachType parameter to service.``
  • Set this parameter to the IP address of the application if you set the searchType parameter to providerIp.
com.alibaba.edas.HelloService
sidestringNo

Specifies the provider side or the consumer side. Valid values:

  • provider
  • consumer
provider
pageintegerNo

The number of the page to return. Pages start from Page 0.

0
sizeintegerYes

The number of entries to return on each page.

10

Response parameters

ParameterTypeDescriptionExample
object

The data that is returned.

Codeinteger

The HTTP status code that is returned.

200
Messagestring

The message that is returned for the request.

success
Successboolean

Indicates whether the request is successful.

true
Dataobject

The returned data.

TotalPagesinteger

The total number of returned pages.

1
TotalElementsinteger

The total number of returned entries.

6
Sizeinteger

The number of entries returned per page.

8
Contentobject []

The data array that is returned.

EdasAppNamestring

The name of the application.

k8s-lq-cartservice
InstanceNuminteger

The number of instances.

1
Versionstring

The version number.

1.0.0
ServiceIdstring

The ID of the service.

xx
EdasAppIdstring

The ID of the application.

efbda488-7b33-432f-****-36530047****
ServiceNamestring

The name of the service.

com.alibabacloud.hipstershop.CartService
RegisterTypestring

The type of the service registry.

xx
Groupstring

The service group.

DUBBO

Examples

Sample success responses

JSONformat

{
  "Code": 200,
  "Message": "success",
  "Success": true,
  "Data": {
    "TotalPages": 1,
    "TotalElements": 6,
    "Size": 8,
    "Content": [
      {
        "EdasAppName": "k8s-lq-cartservice",
        "InstanceNum": 1,
        "Version": "1.0.0",
        "ServiceId": "xx",
        "EdasAppId": "efbda488-7b33-432f-****-36530047****",
        "ServiceName": "com.alibabacloud.hipstershop.CartService",
        "RegisterType": "xx",
        "Group": "DUBBO"
      }
    ]
  }
}

Error codes

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

Change history

Change timeSummary of changesOperation
No change history