Queries services.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.

Request headers

This operation only uses the common request header. For more information, see Common request parameters.

Request syntax

POST|GET /pop/sp/api/mseForOam/getServiceListPage HTTP/1.1

Request parameters

Parameter Type Position Required Example Description
region String Query No cn-hangzhou

The ID of the region.

namespace String Query No cn-hangzhou:doc-test

The ID of the namespace.

origin String Query No agent

The source of the data. Valid values:

  • agent: required if you use the new service query feature to pass the query result.
  • registry: required if you use the earlier service query feature to pass the query result.
serviceType String Query No springCloud

The type of the service. Valid values:

  • dubbo
  • springCloud
  • hsf
  • istio
searchType String Query No app

The type of the service search. Valid values:

  • app: searches by application.
  • service: searches by service.
  • ip: searches by IP address.
searchValue String Query No com.aliaba.edas.HelloService

The keyword used for the search. Fuzzy searches are supported.

side String Query No provider

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

  • provider
  • consumer
page Integer Query No 1

The number of the page to return. Pages start from page 1.

size Integer Query No 10

The number of entries to return on each page.

Response parameters

Parameter Type Example Description
Code Integer 200

The returned HTTP status code.

Data Struct

The returned data.

Content Array of MseServiceResponse

The array returned.

EdasAppId String efbda488-7b33-432f-****-36530047****

The ID of the application.

EdasAppName String k8s-lq-cartservice

The name of the application.

Group String DUBBO

The service group.

InstanceNum Integer 1

The number of instances.

RegisterType String xx

The type of the registration.

ServiceId String xx

The ID of the service.

ServiceName String com.alibabacloud.hipstershop.CartService

The name of the service.

Version String 1.0.0

The version number.

Size Integer 8

The number of entries returned per page.

TotalElements Integer 6

The total number of entries returned.

TotalPages Integer 1

The total number of pages returned.

Message String success

The message returned for the request.

Success Boolean true

Indicates whether the request is successful.

Examples

Sample requests

POST /pop/sp/api/mseForOam/getServiceListPage HTTP/1.1
Common request parameters

Sample success responses

XML format

<GetServiceListPage>
  <Message>success</Message>
  <Data>
        <Size>8</Size>
        <Content>
              <Group>DUBBO</Group>
              <EdasAppId>efbda488-7b33-432f-****-36530047****</EdasAppId>
              <Version>1.0.0</Version>
              <ServiceName>com.alibabacloud.hipstershop.CartService</ServiceName>
              <EdasAppName>k8s-lq-cartservice</EdasAppName>
              <RegisterType>xx</RegisterType>
              <InstanceNum>1</InstanceNum>
              <ServiceId>xx</ServiceId>
        </Content>
        <TotalElements>6</TotalElements>
        <TotalPages>1</TotalPages>
  </Data>
  <Code>200</Code>
  <Success>true</Success>
</GetServiceListPage>

JSON format

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

Error codes

For a list of error codes, visit the API Error Center.