All Products
Search
Document Center

Enterprise Distributed Application Service:GetServiceProvidersPage

Last Updated:Jan 08, 2024

Queries service providers.

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:ReadApplicationRead
  • Application
    acs:edas:{#regionId}:{#accountId}:namespace/{#NameSpaceId}/application/{#AppId}
    none
none

Request syntax

POST /pop/sp/api/mseForOam/getServiceProvidersPage

GET /pop/sp/api/mseForOam/getServiceProvidersPage

Request parameters

ParameterTypeRequiredDescriptionExample
regionstringNo

The ID of the region.

cn-hangzhou
namespacestringNo

The ID of the namespace.

cn-hangzhou:doc-test
originstringNo

The source of 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: Dubbo service
  • springCloud: Spring Cloud service
  • hsf: High-speed Service Framework (HSF) service
dubbo
appIdstringNo

The ID of the application.

efbda488-7b33-432f-a40d-****0047****
sourcestringNo

The source of the service. Set the value to edas.

edas
serviceIdstringNo

The ID of the service. This parameter is deprecated. You can ignore it.

com.alibabacloud.hipstershop.CartService
serviceNamestringNo

The name of the service.

com.alibabacloud.hipstershop.CartService
serviceVersionstringNo

The version of the service.

1.0.0
groupstringNo

The group to which the service belongs.

DUBBO
ipstringNo

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

10.20.x.xx
registryTypestringNo

The type of the service registry. This parameter is deprecated. You can ignore it.

nacos
pageintegerNo

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

0
sizeintegerNo

The number of entries to return on each page.

10

Response parameters

ParameterTypeDescriptionExample
object

The content returned.

Codeinteger

The HTTP status code that is returned.

200
Messagestring

The message returned for the request.

success
Successboolean

Indicates whether the request is successful.

true
Dataobject

The data structure.

TotalPagesinteger

The total number of returned pages.

1
TotalElementsinteger

The total number of returned entries.

1
Sizeinteger

The number of entries returned per page.

5
Contentobject []

The data array returned.

Timeoutstring

The service timeout period.

1000
Ipstring

The IP address of the service provider.

10.20.XX.XX
Portstring

The port number of the service provider.

12345
Iannotationsstring

The remarks of the service provider.

172.178.XX.XX
SerializeTypestring

The serialization type.

hessian2

Examples

Sample success responses

JSONformat

{
  "Code": 200,
  "Message": "success",
  "Success": true,
  "Data": {
    "TotalPages": 1,
    "TotalElements": 1,
    "Size": 5,
    "Content": [
      {
        "Timeout": "1000",
        "Ip": "10.20.XX.XX",
        "Port": "12345",
        "Iannotations": "172.178.XX.XX",
        "SerializeType": "hessian2"
      }
    ]
  }
}

Error codes

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