GetServiceProvidersPage - Query service providers in EDAS - Enterprise Distributed Application Service

Queries service providers with pagination.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

edas:ReadService

get

*Application

acs:edas:{#regionId}:{#accountId}:namespace/{#NameSpaceId}/application/{#AppId}

None

Request syntax

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

Request parameters

Parameter	Type	Required	Description	Example
region	string	No	Region ID.	cn-hangzhou
namespace	string	No	Namespace ID.	cn-hangzhou:doc-test
origin	string	No	Data source. Valid values: agent: queries through the latest service query feature. registry: queries through the earlier service query feature.	agent
serviceType	string	No	Service type. Valid values: dubbo: Dubbo service. springCloud: Spring Cloud service. hsf: High-speed Service Framework (HSF) service.	dubbo
appId	string	No	Application ID.	efbda488-7b33-432f-a40d-**0047**
source	string	No	Service source. Set to edas.	edas
serviceId	string	No	Service ID. Deprecated.	com.alibabacloud.hipstershop.CartService
serviceName	string	No	Service name.	com.alibabacloud.hipstershop.CartService
serviceVersion	string	No	Service version.	1.0.0
group	string	No	Service group.	DUBBO
ip	string	No	IP address of the service provider. Supports fuzzy match.	10.20.x.xx
registryType	string	No	Service registry type. Deprecated.	nacos
page	integer	No	Page number to return. Starts from 0.	0
size	integer	No	Number of entries per page.	10

Response elements

Element	Type	Description	Example
	object	Response body.
Code	integer	HTTP status code.	200
Message	string	Response message.	success
Success	boolean	Whether the request succeeded.	true
Data	object	Response data.
TotalPages	integer	Total number of pages.	1
TotalElements	integer	Total number of entries.	1
Size	integer	Entries per page.	5
Content	array<object>	List of service providers.
	object	Service provider details.
Timeout	string	Service timeout period.	1000
Ip	string	IP address of the service provider.	10.20.XX.XX
Port	string	Port number of the service provider.	12345
Iannotations	string	Annotations of the service provider.	172.178.XX.XX
SerializeType	string	Serialization type.	hessian2

Examples

Success response

JSON format

{
  "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

See Error CodesError Codes for a complete list.

Release notes

See Release NotesRelease Notes for a complete list.