# 查询端点列表 - ListEndpoints #### 功能介绍 列举端点列表。用户可使用该接口列举工作空间下端点列表，支持输入模型id、端点id、名称、类型、可见性等参数过滤，支持分页查询。此接口为同步接口，无配套使用接口和特殊场景。 #### 调试 您可以在[API Explorer](https://console.huaweicloud.com/apiexplorer/#/openapi/DataArtsFabric/doc?api=ListEndpoints)中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。 #### 授权信息 账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。 - 如果使用角色与策略授权，具体权限要求请参见[权限和授权项](https://support.huaweicloud.com/api-fabric/dataartsfabric_03_0014.html)。 - 如果使用身份策略授权，需具备如下身份策略权限。 | 授权项 | 访问级别 | 资源类型（\*为必须） | 条件键 | 别名 | 依赖的授权项 | |:---|:---|:---|:---|:---|:---| | DataArtsFabric:endpoint:list | List | workspace \* | - g:ResourceTag/\ - g:EnterpriseProjectId | - | - | | DataArtsFabric:endpoint:list | List | endpoint \* | - | - | - | #### URI GET /v1/workspaces/{workspace_id}/endpoints 表1路径参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | workspace_id | 是 | String | **参数解释** ：工作空间ID，获取方法，请参见[获取工作空间ID](https://support.huaweicloud.com/api-fabric/dataartsfabric_03_0022.html)。 **约束限制**：不涉及。 **取值范围**：长度为\[1,36\]的英文字符、数字和中划线(-)的组合。 **默认取值**：不涉及。 | 表2Query参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | offset | 否 | Integer | **参数解释**：偏移量，表示从此偏移量开始查询。 **约束限制**：不涉及。 **取值范围**：\[0,1000000000\]。 **默认取值**：0。 | | limit | 否 | Integer | **参数解释**：指定每一页返回的最大条目数。 **约束限制**：不涉及。 **取值范围**：\[1,100\]。 **默认取值**：10。 | | model_id | 否 | String | **参数解释**：通过模型ID检索。 **约束限制**：不涉及。 **取值范围** ：长度为\[32,36\]的英文字符、数字和中划线(-)的组合，请参见[获取模型ID](https://support.huaweicloud.com/api-fabric/dataartsfabric_03_0024.html)。 **默认取值**：不涉及。 | | name | 否 | String | **参数解释**：Endpoint名称，通过名字搜索Endpoint的参数。 **约束限制**：不涉及。 **取值范围**：长度为\[1,128\]的中文、字母、数字、下划线(_)、中划线(-)，支持模糊查询。 **默认取值**：不涉及。 | | endpoint_id | 否 | String | **参数解释** ：通过端点ID检索Endpoint的参数。获取方法，请参见[获取端点ID](https://support.huaweicloud.com/api-fabric/dataartsfabric_03_0023.html)。 **约束限制**：不涉及。 **取值范围**：长度为\[32,36\]的英文字符、数字和中划线(-)的组合。 **默认取值**：不涉及。 | | type | 否 | Object | **参数解释**：Endpoint的类型。 **约束限制**：不涉及。 **取值范围**： - service：Service EP，代表一个可接收Service请求资源组； - ray：RayCluter on k8s的EP，代表一个Ray集群； - inference：推理的EP，代表一个推理函数实例； - job：Job EP，代表一个可接收Job请求资源组； - ray_service：RayService on k8s的EP，代表一个RayService。 - sql：SQL EP，代表一个可接收SQL请求资源组。 **默认取值**：不涉及。 | | visibility | 否 | String | **参数解释**：可见性检索的参数。 **约束限制**：不涉及。 **取值范围**： - PRIVATE：私有，用户自己创建的； - PUBLIC：公共，查询所有公共的，包括其他用户创建的； - ALL：所有的。 **默认取值**：默认为空，不填表示不限制，则查出当前用户下的，包括PRIVATE和PUBLIC，不包括其他用户创建的。 | #### 请求参数 表3请求Header参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | X-Auth-Token | 否 | String | **参数解释** ：租户Token。用于调用接口的认证。获取方法，请参见[认证鉴权](https://support.huaweicloud.com/api-fabric/dataartsfabric_03_0005.html)。 **约束限制**：不涉及。 **取值范围**：长度不超过65534个字符。 **默认取值**：不涉及。 | #### 响应参数 **状态码：200** 表4响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | total | Integer | **参数解释**：符合条件的端点总数。 **约束限制**：不涉及。 **取值范围**：不涉及。 **默认取值**：不涉及。 | | endpoints | Array of [EndpointBriefInfo] objects | **参数解释**：符合条件的Endpoint简要信息列表。 **约束限制**：\[0,1000\]。 | 表5EndpointBriefInfo | 参数 | 参数类型 | 描述 | |:---|:---|:---| | visibility | String | **参数解释**：可见性。 **约束限制**：不涉及。 **取值范围**： - PRIVATE：私有 - PUBLIC：公共 **默认取值**：PRIVATE。 | | id | String | **参数解释**：Endpoint ID。 **约束限制**：不涉及。 **取值范围**：长度为\[32,36\]的英文字符、数字和中划线(-)的组合。 **默认取值**：不涉及。 | | name | String | **参数解释**：Endpoint名称。 **约束限制**：不涉及。 **取值范围**：长度为\[1,128\]包含中文、字母、数字、下划线、中划线、半角句号（.）、空格的组合。 **默认取值**：不涉及。 | | type | String | **参数解释**：Endpoint的类型。 **约束限制**：不涉及。 **取值范围**： - service：Service EP，代表一个可接收Service请求资源组； - ray：RayCluter on k8s的EP，代表一个Ray集群； - inference：推理的EP，代表一个推理函数实例； - job：Job EP，代表一个可接收Job请求资源组； - ray_service：RayService on k8s的EP，代表一个RayService。 - sql：SQL EP，代表一个可接收SQL请求资源组。 - notebook：Notebook EP，代表一个notebook运行资源组。 **默认取值**：不涉及。 | | status | String | **参数解释**：Endpoint状态。 **约束限制**：不涉及。 **取值范围**： - CREATING：创建中； - RUNNING：运行中； - CREATE_FAILED：创建失败； - DELETING：删除中； - DELETED：已删除； - UPDATING：更新中； - UPDATE_FAILED：升级失败； - DELETE_FAILED：创建失败； - FROZEN：冻结； - INACTIVE：未开通（公共EP）； - TRIAL_ENDED：试用结束。 **默认取值**：不涉及。 | | description | String | **参数解释**：描述信息。 **约束限制**：不涉及。 **取值范围**：不涉及。 **默认取值**：不涉及。 | | create_time | String | **参数解释**：创建时间。 **约束限制**：不涉及。 **取值范围**：不涉及。 **默认取值**：不涉及。 | | update_time | String | **参数解释**：更新时间。 **约束限制**：不涉及。 **取值范围**：不涉及。 **默认取值**：不涉及。 | | owner | [User] object | **参数解释**：租户信息内容，包含账户名称、账户ID和用户名称、用户ID。 **约束限制**：不涉及。 | | cap | [CapRef] object | **参数解释**：镜像包信息。 **约束限制**：不涉及。 | | reserved_resource | [ReservedResource] object | **参数解释**：通用预留资源。 **约束限制**：不涉及。 **取值范围**：不涉及。 **默认取值**：不涉及。 | | ray_resource | [RayResourceInfo] object | **参数解释**：Ray资源配置。 **约束限制**：不涉及。 | | caches | Array of [CacheConfig] objects | **参数解释**：缓存关联信息。 **约束限制**：不涉及。 **取值范围**：\[0,1000\]。 **默认取值**：不涉及。 | | error_code | String | **参数解释**：失败状态时的错误编码。 **约束限制**：不涉及。 **取值范围**：不涉及。 **默认取值**：不涉及。 | | error_msg | String | **参数解释**：失败状态时的错误信息。 **约束限制**：不涉及。 **取值范围**：不涉及。 **默认取值**：不涉及。 | | public_access | Boolean | **参数解释**：是否开启公网访问。 **约束限制**：不涉及。 **取值范围**：开启true，关闭false。 **默认取值**：不涉及。 | 表6User | 参数 | 参数类型 | 描述 | |:---|:---|:---| | domain_name | String | **参数解释**：账户名称。 **约束限制**：不涉及。 **取值范围**：长度为\[0,64\]个字符。 **默认取值**：不涉及。 | | domain_id | String | **参数解释**：账号ID。 **约束限制**：不涉及。 **取值范围**：长度为\[1,36\]的数字、英文字符和中划线(-)的组合。 **默认取值**：不涉及。 | | user_name | String | **参数解释**：用户名称。 **约束限制**：不涉及。 **取值范围**：长度为\[0,64\]个字符。 **默认取值**：不涉及。 | | user_id | String | **参数解释**：用户ID。 **约束限制**：不涉及。 **取值范围**：长度为\[1,36\]的数字、英文字符和中划线(-)的组合。 **默认取值**：不涉及。 | 表7CapRef | 参数 | 参数类型 | 描述 | |:---|:---|:---| | cap_id | String | **参数解释**：镜像包ID。 **约束限制**：不涉及。 **取值范围**：长度为\[32,36\]的英文、数字、中划线(-)的组合。 **默认取值**：不涉及。 | | version_id | String | **参数解释**：镜像包版本ID。 **约束限制**：不涉及。 **取值范围**：长度为\[32,36\]的英文、数字、中划线(-)的组合。 **默认取值**：不涉及。 | 表8ReservedResource | 参数 | 参数类型 | 描述 | |:---|:---|:---| | apu | [ResourceDef] object | **参数解释**：资源定义信息。 **约束限制**：不涉及。 | | dpu | [SqlResourceDef] object | **参数解释**：Sql资源定义信息。 **约束限制**：不涉及。 | | mu | [ResourceDemand] object | **参数解释**：资源需求量配置。 **约束限制**：不涉及。 | 表9ResourceDef | 参数 | 参数类型 | 描述 | |:---|:---|:---| | spec_code | String | **参数解释**：Endpoint状态。 **约束限制**：资源规格编码，从查询规格列表ListSpecs接口获取。 **取值范围**：不涉及。 **默认取值**：不涉及。 | | warm_up_num | Integer | **参数解释**：预热资源量。 **约束限制**：不涉及。 **取值范围**：不涉及。 **默认取值**：不涉及。 | | max_num | Integer | **参数解释**：最大资源量，不填默认为预热资源量，即不使用弹性资源。 **约束限制**：不涉及。 **取值范围**：最小值为1，最大值为1000。 **默认取值**：不涉及。 | 表10SqlResourceDef | 参数 | 参数类型 | 描述 | |:---|:---|:---| | spec_code | String | **参数解释**：Endpoint状态。 **约束限制**：资源规格编码，从查询规格列表ListSpecs接口获取。 **取值范围**：不涉及。 **默认取值**：不涉及。 | | warm_up_num | Integer | **参数解释**：预热资源量。 **约束限制**：不涉及。 **取值范围**：最小值为1，最大值为5000。 **默认取值**：不涉及。 | | max_num | Integer | **参数解释**：最大资源量，不填默认为预热资源量，即不使用弹性资源。 **约束限制**：不涉及。 **取值范围**：最小值为1，最大值为5000。 **默认取值**：不涉及。 | | use_public_resource | Boolean | **参数解释**：是否使用公共资源。 **约束限制**：不涉及。 **取值范围**：不涉及。 **默认取值**：不涉及。 | 表11ResourceDemand | 参数 | 参数类型 | 描述 | |:---|:---|:---| | spec_code | String | **参数解释**：资源规格。 **约束限制**：不涉及。 **取值范围**：从规格列表查询获取。 **默认取值**：不涉及。 | | min | Integer | **参数解释**：最小数。 **约束限制**：不涉及。 **取值范围**：最小值为0。 **默认取值**：不涉及。 | | max | Integer | **参数解释**：最大数。 **约束限制**：不涉及。 **取值范围**：最小值为1。 **默认取值**：不涉及。 | 表12RayResourceInfo | 参数 | 参数类型 | 描述 | |:---|:---|:---| | head_group_spec | [HeadGroupSpec] object | **参数解释**：Ray Head配置。 **约束限制**：不涉及。 | | worker_group_spec | Array of [WorkerGroupSpec] objects | **参数解释**：Ray worker group配置。 **约束限制**：不涉及。 **取值范围**：\[1,10\]。 **默认取值**：不涉及。 | 表13HeadGroupSpec | 参数 | 参数类型 | 描述 | |:---|:---|:---| | spec_code | String | **参数解释**：资源规格。 **约束限制**：不涉及。 **取值范围**：从规格列表查询获取。 **默认取值**：不涉及。 | 表14WorkerGroupSpec | 参数 | 参数类型 | 描述 | |:---|:---|:---| | name | String | **参数解释**：名称。 **约束限制**：不涉及。 **取值范围**：不涉及。 **默认取值**：不涉及。 | | spec_code | String | **参数解释**：资源规格。 **约束限制**：不涉及。 **取值范围**：从规格列表查询获取。 **默认取值**：不涉及。 | | min_replicas | Integer | **参数解释**：最小副本数。 **约束限制**：不涉及。 **取值范围**：最小值为0，最大值为10000。 **默认取值**：不涉及。 | | max_replicas | Integer | **参数解释**：最大副本数。 **约束限制**：不涉及。 **取值范围**：最小值为1，最大值为10000。 **默认取值**：不涉及。 | 表15CacheConfig | 参数 | 参数类型 | 描述 | |:---|:---|:---| | mnt_path | String | **参数解释**：挂载路径。 **约束限制**：不涉及。 **取值范围**：不涉及。 **默认取值**：不涉及。 | | cache_ins_id | String | **参数解释**：分布式缓存id。 **约束限制**：不涉及。 **取值范围**：已创建的分布式缓存资源id。 **默认取值**：不涉及。 | **状态码：400** 表16响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | error_code | String | **参数解释**：错误码。 **约束限制**：不涉及。 **取值范围**：长度为\[8,36\]个字符。 **默认取值**：不涉及。 | | error_msg | String | **参数解释**：错误描述。 **约束限制**：不涉及。 **取值范围**：长度为\[2,512\]个字符。 **默认取值**：不涉及。 | | solution_msg | String | **参数解释**：解决方案描述。 **约束限制**：不涉及。 **取值范围**：长度为\[0,4096\]个字符。 **默认取值**：不涉及。 | **状态码：401** 表17响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | error_code | String | **参数解释**：错误码。 **约束限制**：不涉及。 **取值范围**：长度为\[8,36\]个字符。 **默认取值**：不涉及。 | | error_msg | String | **参数解释**：错误描述。 **约束限制**：不涉及。 **取值范围**：长度为\[2,512\]个字符。 **默认取值**：不涉及。 | | solution_msg | String | **参数解释**：解决方案描述。 **约束限制**：不涉及。 **取值范围**：长度为\[0,4096\]个字符。 **默认取值**：不涉及。 | **状态码：408** 表18响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | error_code | String | **参数解释**：错误码。 **约束限制**：不涉及。 **取值范围**：长度为\[8,36\]个字符。 **默认取值**：不涉及。 | | error_msg | String | **参数解释**：错误描述。 **约束限制**：不涉及。 **取值范围**：长度为\[2,512\]个字符。 **默认取值**：不涉及。 | | solution_msg | String | **参数解释**：解决方案描述。 **约束限制**：不涉及。 **取值范围**：长度为\[0,4096\]个字符。 **默认取值**：不涉及。 | **状态码：500** 表19响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | error_code | String | **参数解释**：错误码。 **约束限制**：不涉及。 **取值范围**：长度为\[8,36\]个字符。 **默认取值**：不涉及。 | | error_msg | String | **参数解释**：错误描述。 **约束限制**：不涉及。 **取值范围**：长度为\[2,512\]个字符。 **默认取值**：不涉及。 | | solution_msg | String | **参数解释**：解决方案描述。 **约束限制**：不涉及。 **取值范围**：长度为\[0,4096\]个字符。 **默认取值**：不涉及。 | #### 请求示例 ``` GET https://{endpoint}/v1/workspaces/{workspace_id}/endpoints ``` #### 响应示例 **状态码：200** 查询Endpoint列表的响应体。 ``` { "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" } ] } ``` **状态码：400** BadRequest ``` { "error_code" : "common.01000001", "error_msg" : "failed to read http request, please check your input, code: 400, reason: Type mismatch., cause: TypeMismatchException" } ``` **状态码：401** Unauthorized ``` { "error_code" : "APIG.1002", "error_msg" : "Incorrect token or token resolution failed" } ``` **状态码：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" } ``` **状态码：408** Request Time-out ``` { "error_code" : "common.00000408", "error_msg" : "timeout exception occurred" } ``` **状态码：500** InternalServerError ``` { "error_code" : "common.00000500", "error_msg" : "internal error" } ``` #### 状态码 | 状态码 | 描述 | |:---|:---| | 200 | 查询Endpoint列表的响应体。 | | 400 | BadRequest | | 401 | Unauthorized | | 403 | Forbidden | | 408 | Request Time-out | | 500 | InternalServerError | #### 错误码 请参见[错误码](https://support.huaweicloud.com/api-fabric/dataartsfabric_03_0028.html)。