DescribeServiceEndpoints - Platform For AI - Alibaba Cloud Documentation Center

Retrieves a list of service endpoints.

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.

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

eas:DescribeServiceEndpoints

get

*All Resource

*

None

Request syntax

GET /api/v2/services/{ClusterId}/{ServiceName}/endpoints HTTP/1.1

Request parameters

Parameter	Type	Required	Description	Example
ClusterId	string	No	The region ID.	cn-hangzhou
ServiceName	string	Yes	The service name. For more information, see ListServices.	service_name

Response elements

Element	Type	Description	Example
	object	The response.
RequestId	string	The request ID.	739998B5-FB39-12A3-8323-0FA340317298
Message	string	The message returned.	执行成功。
AccessToken	string	The service token.	Nzc5N2FhN**TQ0YzBmYTIyN2MxZTUxN2NkYjg4MTJmMWQxZmY1**
Endpoints	array<object>	The list of service endpoints.
	object
EndpointType	string	The connection type of the service endpoint. Valid values: DefaultGateway: The service is connected using a shared gateway. PrivateGateway: The service is connected using a dedicated gateway. Nlb: The service is attached to a Network Load Balancer (NLB) instance. Nacos: The service is attached to a Nacos instance.	Nlb
BackendId	string	The ID of the backend service. The value of this parameter varies based on the value of EndpointType: If EndpointType is DefaultGateway, this parameter is set to default. If EndpointType is PrivateGateway, this parameter is the ID of the dedicated gateway. If EndpointType is Nlb, this parameter is the ID of the NLB instance. If EndpointType is Nacos, this parameter is the ID of the Nacos instance.	nlb-5q4sp7u6oorkha****
PathType	string	The type of the endpoint. Valid values: Group: The endpoint of an audience group. Service: The endpoint of a service.	Service
IntranetEndpoints	array	The list of internal endpoints.
	string	The internal endpoint.	nlb-5q4sp7u6oor****jvv.cn-hangzhou.nlb.aliyuncs.com
InternetEndpoints	array	The list of internet-facing endpoints.
	string	The internet-facing endpoint.	null
Port	integer	The port number. This parameter is returned only when the service is attached to an NLB or Nacos instance.	9090

Examples

Success response

JSON format

{
  "RequestId": "739998B5-FB39-12A3-8323-0FA340317298",
  "Message": "执行成功。",
  "AccessToken": "Nzc5N2FhN****TQ0YzBmYTIyN2MxZTUxN2NkYjg4MTJmMWQxZmY1****",
  "Endpoints": [
    {
      "EndpointType": "Nlb",
      "BackendId": "nlb-5q4sp7u6oorkha****",
      "PathType": "Service",
      "IntranetEndpoints": [
        "nlb-5q4sp7u6oor****jvv.cn-hangzhou.nlb.aliyuncs.com"
      ],
      "InternetEndpoints": [
        "null"
      ],
      "Port": 9090
    }
  ]
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.