Help Center/ DataArts Fabric/ API Reference/ APIs/ Endpoint Management/ Querying the Endpoint List

Updated on 2025-09-15 GMT+08:00

View PDF

Querying the Endpoint List

Function

This API is used to list endpoints. You can call this API to list endpoints within a workspace. You can filter endpoints by model ID, endpoint ID, name, type, and visibility. Pagination query is supported. This API is synchronous with no accompanying APIs or specific scenarios.

URI

GET /v1/workspaces/{workspace_id}/endpoints

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
workspace_id	Yes	String	Definition: Workspace ID. For how to obtain a workspace ID, see [Obtaining a Workspace ID] (dataartsfabric_03_0022.xml). Constraints: N/A. Range: 1 to 36 characters. Only letters, digits, and hyphens (-) are allowed. Default Value: N/A.

**Table 2** Query Parameters
Parameter	Mandatory	Type	Description
offset	No	Integer	Definition: Offset where a query starts. Constraints: N/A. Range: [0, 1000000000]. Default Value: 0
limit	No	Integer	Definition: Maximum number of records returned on each page. Constraints: N/A. Range: [1, 100]. Default Value: 10.
model_id	No	String	Definition: Model ID, allowing you to search for models by their ID. Constraints: N/A. Range: [32, 36]. Only letters, digits, and hyphens (-) are allowed. For how to obtain a model ID, see [Obtaining a Model ID] (dataartsfabric_03_0024.xml). Default Value: N/A.
name	No	String	Definition: Endpoint name, allowing you to search for endpoints by their name. Constraints: N/A. Range: 1 to 128 characters. Only letters, digits, hyphens (-), and underscores (_) are allowed. Fuzzy search is supported. Default Value: N/A.
endpoint_id	No	String	Definition: Endpoint ID, allowing you to search for endpoints by their ID. For how to obtain an endpoint ID, see [Obtaining an Endpoint ID] (dataartsfabric_03_0023.xml). Constraints: N/A. Range: 32 to 36 characters. Only letters, digits, and hyphens (-) are allowed. Default Value: N/A.
type	No	Object	Definition: Endpoint type. Constraints: N/A. Range: service: Service endpoint, indicating a resource group that can receive service requests. ray: Endpoint of a Ray cluster on Kubernetes, indicating a Ray cluster. inference: Inference endpoint, indicating an inference function instance. job: Job endpoint, indicating a resource group that can receive job requests. ray_service: Endpoint of a Ray service on Kubernetes, indicating a Ray service. sql: SQL endpoint, indicating a resource group that can receive SQL requests. Default Value: N/A.
visibility	No	String	Definition: Visibility search parameter. Constraints: N/A. Range: PRIVATE: private, created by users. PUBLIC: Query all public objects, including those created by other users. ALL: All. Default Value: By default, this parameter is left blank. If left blank, the visibility of the current user is queried, including PRIVATE and PUBLIC.

Request Parameters

**Table 3** Request header parameters
Parameter	Mandatory	Type	Description
X-Auth-Token	No	String	Definition: Tenant token. It is used for API calling authentication. For how to obtain a token, see [Authentication] (dataartsfabric_03_0005.xml). Constraints: N/A. Range: Up to 65,534 characters. Default Value: N/A.

Response Parameters

Status code: 200

**Table 4** Response body parameters
Parameter	Type	Description
total	Integer	Definition: Total number of endpoints that meet the filter criteria. Constraints: N/A. Range: N/A. Default Value: N/A.
endpoints	Array of EndpointBriefInfo objects	Definition: List of brief information about endpoints that meet the filter criteria. Constraints: [0,1000].

**Table 5** EndpointBriefInfo
Parameter	Type	Description
visibility	String	Definition: Visibility. Constraints: N/A. Range: PRIVATE; PUBLIC. Default Value: PRIVATE.
id	String	Definition: Endpoint ID. Constraints: N/A. Range: 32 to 36 characters. Only letters, digits, and hyphens (-) are allowed. Default Value: N/A.
name	String	Definition: Endpoint name. Constraints: N/A. Range: 1 to 128 characters. Only letters, digits, hyphens (-), underscores (_), periods (.), and spaces are allowed. Default Value: N/A.
type	String	Definition: Endpoint type. Constraints: N/A. Range: service: Service endpoint, indicating a resource group that can receive service requests. ray: Endpoint of a Ray cluster on Kubernetes, indicating a Ray cluster. inference: Inference endpoint, indicating an inference function instance. job: Job endpoint, indicating a resource group that can receive job requests. ray_service: Endpoint of a Ray service on Kubernetes, indicating a Ray service. sql: SQL endpoint, indicating a resource group that can receive SQL requests. Default Value: N/A.
status	String	Definition: Endpoint status. Constraints: N/A. Range: CREATING: being created. RUNNING: running. CREATE_FAILED: creation failed. DELETING: being deleted. DELETED: deleted. UPDATING: being updated. UPDATE_FAILED: upgrade failed. DELETE_FAILED: creation failed. FROZEN: frozen. INACTIVE: disabled (public endpoint). TRIAL_ENDED: trial ended. Default Value: N/A.
description	String	Definition: Description. Constraints: N/A. Range: N/A. Default Value: N/A.
create_time	String	Definition: Creation time. Constraints: N/A. Range: N/A. Default Value: N/A.
update_time	String	Definition: Update time. Constraints: N/A. Range: N/A. Default Value: N/A.
owner	User object	Definition: Tenant information, including the account name, account ID, username, and user ID. Constraints: N/A.
cap	CapRef object	Definition: Image package information. Constraints: N/A.
reserved_resource	ReservedResource object	Definition: General reserved resources. Constraints: N/A. Range: N/A. Default Value: N/A.
ray_resource	RayResourceInfo object	Definition: Ray resource configuration. Constraints: N/A.
caches	Array of CacheConfig objects	Definition: Cache association information. Constraints: N/A. Range: [0, 1000]. Default Value: N/A.
error_code	String	Definition: Error code in the failure state. Constraints: N/A. Range: N/A. Default Value: N/A.
error_msg	String	Definition: Error message in the failure state. Constraints: N/A. Range: N/A. Default Value: N/A.
public_access	Boolean	Definition: Whether to enable public network access. Constraints: N/A. Range: true (enabled) or false (disabled). Default Value: N/A.

**Table 6** User
Parameter	Type	Description
domain_name	String	Definition: Account name. Constraints: N/A. Range: 0 to 64 characters. Default Value: N/A.
domain_id	String	Definition: Account ID. Constraints: N/A. Range: 1 to 36 characters. Only letters, digits, and hyphens (-) are allowed. Default Value: N/A.
user_name	String	Definition: Username. Constraints: N/A. Range: 0 to 64 characters. Default Value: N/A.
user_id	String	Definition: User ID. Constraints: N/A. Range: 1 to 36 characters. Only letters, digits, and hyphens (-) are allowed. Default Value: N/A.

**Table 7** CapRef
Parameter	Type	Description
cap_id	String	Definition: Image package ID. Constraints: N/A. Range: 32 to 36 characters. Only letters, digits, and hyphens (-) are allowed. Default Value: N/A.
version_id	String	Definition: Image package version ID. Constraints: N/A. Range: 32 to 36 characters. Only letters, digits, and hyphens (-) are allowed. Default Value: N/A.

**Table 8** ReservedResource
Parameter	Type	Description
apu	ResourceDef object	Definition: Resource definition. Constraints: N/A.
dpu	SqlResourceDef object	Definition: SQL resource definition. Constraints: N/A.
mu	ResourceDemand object	Definition: Resource requirement configuration. Constraints: N/A.

**Table 9** ResourceDef
Parameter	Type	Description
spec_code	String	Definition: Endpoint status. Constraints: Resource specification code, which is queried using the ListSpecs API. Range: N/A. Default Value: N/A.
warm_up_num	Integer	Definition: Number of resources to be warmed up. Constraints: N/A. Range: N/A. Default Value: N/A.
max_num	Integer	Definition: Maximum number of resources. If left blank, it defaults to the preheating resource amount, meaning elastic resources are not used. Constraints: N/A. Range: [1, 1000]. Default Value: N/A.

**Table 10** SqlResourceDef
Parameter	Type	Description
spec_code	String	Definition: Endpoint status. Constraints: Resource specification code, which is queried using the ListSpecs API. Range: N/A. Default Value: N/A.
warm_up_num	Integer	Definition: Number of resources to be warmed up. Constraints: N/A. Range: [1, 5000]. Default Value: N/A.
max_num	Integer	Definition: Maximum number of resources. If left unset, it defaults to the preheating resource amount, meaning elastic resources are not used. Constraints: N/A. Range: [1, 5000]. Default Value: N/A.
use_public_resource	Boolean	Definition: Whether to use public resources. Constraints: N/A. Range: N/A. Default Value: N/A.

**Table 11** ResourceDemand
Parameter	Type	Description
spec_code	String	Definition: Resource specifications. Constraints: N/A. Range: The value must be queried from the specifications list. Default Value: N/A.
min	Integer	Definition: Minimum number. Constraints: N/A. Range: The minimum value is 0. Default Value: N/A.
max	Integer	Definition: Maximum number. Constraints: N/A. Range: The minimum value is 1. Default Value: N/A.

**Table 12** RayResourceInfo
Parameter	Type	Description
head_group_spec	HeadGroupSpec object	Definition: Ray head configuration. Constraints: N/A.
worker_group_spec	Array of WorkerGroupSpec objects	Definition: Ray worker group configuration. Constraints: N/A. Range: [1, 10]. Default Value: N/A.

**Table 13** HeadGroupSpec
Parameter	Type	Description
spec_code	String	Definition: Resource specifications. Constraints: N/A. Range: The value must be queried from the specifications list. Default Value: N/A.

**Table 14** WorkerGroupSpec
Parameter	Type	Description
name	String	Definition: Name. Constraints: N/A. Range: N/A. Default Value: N/A.
spec_code	String	Definition: Resource specifications. Constraints: N/A. Range: The value must be queried from the specifications list. Default Value: N/A.
min_replicas	Integer	Definition: Minimum number of replicas. Constraints: N/A. Range: [0, 10000]. Default Value: N/A.
max_replicas	Integer	Definition: Maximum number of replicas. Constraints: N/A. Range: [1, 10000]. Default Value: N/A.

**Table 15** CacheConfig
Parameter	Type	Description
mnt_path	String	Definition: Mount path. Constraints: N/A. Range: N/A. Default Value: N/A.
cache_ins_id	String	Definition: Distributed cache ID. Constraints: N/A. Range: ID of a created distributed cache resource. Default Value: N/A.

Status code: 400

**Table 16** Response body parameters
Parameter	Type	Description
error_code	String	Definition: Error code. Constraints: N/A. Range: 8 to 36 characters. Default Value: N/A.
error_msg	String	Definition: Error message. Constraints: N/A. Range: 2 to 512 characters. Default Value: N/A.
solution_msg	String	Definition: Solution description. Constraints: N/A. Range: 0 to 4,096 characters. Default Value: N/A.

Status code: 401

**Table 17** Response body parameters
Parameter	Type	Description
error_code	String	Definition: Error code. Constraints: N/A. Range: 8 to 36 characters. Default Value: N/A.
error_msg	String	Definition: Error message. Constraints: N/A. Range: 2 to 512 characters. Default Value: N/A.
solution_msg	String	Definition: Solution description. Constraints: N/A. Range: 0 to 4,096 characters. Default Value: N/A.

Status code: 408

**Table 18** Response body parameters
Parameter	Type	Description
error_code	String	Definition: Error code. Constraints: N/A. Range: 8 to 36 characters. Default Value: N/A.
error_msg	String	Definition: Error message. Constraints: N/A. Range: 2 to 512 characters. Default Value: N/A.
solution_msg	String	Definition: Solution description. Constraints: N/A. Range: 0 to 4,096 characters. Default Value: N/A.

Status code: 500

**Table 19** Response body parameters
Parameter	Type	Description
error_code	String	Definition: Error code. Constraints: N/A. Range: 8 to 36 characters. Default Value: N/A.
error_msg	String	Definition: Error message. Constraints: N/A. Range: 2 to 512 characters. Default Value: N/A.
solution_msg	String	Definition: Solution description. Constraints: N/A. Range: 0 to 4,096 characters. Default Value: N/A.

Example Requests

GET https://{endpoint}/v1/workspaces/{workspace_id}/endpoints

Example Responses

Status code: 200

The endpoint list is queried.

{
  "total" : 1,
  "endpoints" : [ {
    "visibility" : "PRIVATE",
    "id" : "0b5633ba2b904511ad514346f4dxxxxx",
    "name" : "endpoint1",
    "type" : "job",
    "status" : "CREATING",
    "description" : "description",
    "create_time" : "2023-05-30T12:24:30.401Z",
    "update_time" : "2023-05-30T12:24:30.401Z",
    "owner" : {
      "domain_name" : "string",
      "domain_id" : "0b5633ba2b904511ad514346f4dxxxxx",
      "user_name" : "string",
      "user_id" : "0b5633ba2b904511ad514346f4xxxxx"
    },
    "cap" : {
      "cap_id" : "0b5633ba2b904511ad514346f4xxxxx",
      "version_id" : "0b5633ba2b904511ad514346f4xxxxx"
    },
    "reserved_resource" : {
      "apu" : {
        "spec_code" : "a1x",
        "warm_up_num" : 1,
        "max_num" : 100
      },
      "dpu" : {
        "spec_code" : "d1x",
        "warm_up_num" : 1,
        "max_num" : 100,
        "use_public_resource" : false
      },
      "mu" : {
        "spec_code" : "mu",
        "min" : 0,
        "max" : 1
      }
    },
    "ray_resource" : {
      "head_group_spec" : {
        "spec_code" : "string"
      },
      "worker_group_spec" : [ {
        "name" : "string",
        "spec_code" : "string",
        "min_replicas" : 10000,
        "max_replicas" : 10000
      } ]
    },
    "caches" : [ {
      "mnt_path" : "string",
      "cache_ins_id" : "string"
    } ],
    "error_code" : "string",
    "error_msg" : "string"
  } ]
}

Status code: 400

BadRequest

{
  "error_code" : "common.01000001",
  "error_msg" : "failed to read http request, please check your input, code: 400, reason: Type mismatch., cause: TypeMismatchException"
}

Status code: 401

Unauthorized

{
  "error_code" : "APIG.1002",
  "error_msg" : "Incorrect token or token resolution failed"
}

Status code: 403

Forbidden

{
  "error" : {
    "code" : "403",
    "message" : "X-Auth-Token is invalid in the request",
    "title" : "Forbidden"
  },
  "error_code" : 403,
  "error_msg" : "X-Auth-Token is invalid in the request",
  "title" : "Forbidden"
}

Status code: 408

Request Time-out

{
  "error_code" : "common.00000408",
  "error_msg" : "timeout exception occurred"
}

Status code: 500

InternalServerError

{
  "error_code" : "common.00000500",
  "error_msg" : "internal error"
}

Status Codes

Status Code	Description
200	The endpoint list is queried.
400	BadRequest
401	Unauthorized
403	Forbidden
408	Request Time-out
500	InternalServerError

Error Codes

See Error Codes.

Parent topic: Endpoint Management

Previous topic: Endpoint Management

Next topic: Creating an Endpoint

Feedback

Was this page helpful?

Helpful Not helpful

Provide feedback

Thank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.

The system is busy. Please try again later.

Which of the following issues have you encountered?

Content is inconsistent with the product UI

Unclear descriptions

Lack of examples or code

Incorrect steps

Can't find what I need

Lack of best practices

Feedback (optional)

0/500

Select at least one type of issue, and enter your comments or suggestions.

Enter a maximum of 500 characters.

Submit Cancel

For any further questions, feel free to contact us through the chatbot.

Chatbot