Queries service providers.

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 uses only the common request header. For more information, see Common request parameters.

Request syntax

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

Request parameters

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

The ID of the region.

namespace String Query No ch-hangzhou:doc-test

The ID of the namespace.

origin String Query No agent

The data source. Valid values:

  • agent: Use this value if you use the service query feature of the new version.
  • registry: Use this value if you use the service query feature of the previous version.
serviceType String Query No dubbo

The type of the service. Valid values:

  • dubbo
  • springCloud
  • hsf
appId String Query No efbda488-7b33-432f-a40d-****0047****

The ID of the application.

source String Query No edas

The source. Set the value to edas.

serviceId String Query No com.alibabacloud.hipstershop.CartService

The ID of the service. This parameter is obsolete and you can ignore it.

serviceName String Query No com.alibabacloud.hipstershop.CartService

The name of the service.

serviceVersion String Query No 1.0.0

The version of the service.

group String Query No DUBBO

The group to which the service belongs.

ip String Query No 10.20.x.xx

The IP address of the service provider. Fuzzy queries are supported.

registryType String Query No nacos

The registry type. This parameter is obsolete and you can ignore it.

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 HTTP status code.

Data Struct

The data struct.

Content Array of Provider

The returned data array.

Ip String 10.20.x.xx

The IP address of the service provider.

Port String 12345

The port number of the service provider.

SerializeType String hessian2

The serialization type.

Timeout String 1000

The service timeout period.

Size Integer 5

The number of entries returned per page.

TotalElements Integer 1

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 call is successful.

Examples

Sample requests

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

Sample success responses

XML format

<GetServiceProvidersPage>
  <Message>success</Message>
  <Data>
        <Size>5</Size>
        <Content>
              <SerializeType>hessian2</SerializeType>
              <Timeout>1000</Timeout>
              <Port>12345</Port>
              <Ip>10.20.x.xx</Ip>
        </Content>
        <TotalElements>1</TotalElements>
        <TotalPages>1</TotalPages>
  </Data>
  <Code>200</Code>
  <Success>true</Success>
</GetServiceProvidersPage>

JSON format

{
    "Message": "success",
    "Data": {
        "Size": 5,
        "Content": {
            "SerializeType": "hessian2",
            "Timeout": 1000,
            "Port": 12345,
            "Ip": "10.20.x.xx"
        },
        "TotalElements": 1,
        "TotalPages": 1
    },
    "Code": 200,
    "Success": true
}

Error codes

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