
# 查询端点列表 - ListV2Endpoints
#### 功能介绍
列举工作空间下的端点列表。用户可使用该接口列举指定工作空间下的端点列表，支持输入名称、id等参数过滤，支持分页查询。此接口为同步接口。
#### 调用方法
请参见[如何调用API](https://support.huaweicloud.com/api-aidatalake/aidatalake_02_0003.html)。
#### URI
GET /v2/workspaces/{workspace_id}/endpoints
表1路径参数 
| 参数           | 是否必选 | 参数类型   | 描述                                                                                                                                                                                       |
|:---|:---|:---|:---|
| workspace_id | 是    | String | **参数解释**：工作空间ID。 **约束限制**：不涉及。 **取值范围**：长度为32\~36的英文字符、数字和中划线的组合。 **默认取值**：不涉及。 |
   
表2Query参数 
| 参数           | 是否必选 | 参数类型             | 描述                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            |
|:---|:---|:---|:---|
| engine_types | 否    | Array of strings | **参数解释**：端点引擎类型列表。 **约束限制**：不涉及。 **取值范围**： - AuraJob：AuraJob引擎。   - SparkSql：SparkSql引擎。   - SparkJob：SparkJob引擎。   - AuraJobV2：AuraJobV2引擎。   - RayCluster：RayCluster引擎。   - RayJob：RayJob引擎。    **默认取值**：不涉及。 |
| compute_id   | 否    | String           | **参数解释**：计算资源ID。 **约束限制**：不涉及。 **取值范围**：长度为32\~36的英文字符、数字和中划线的组合。 **默认取值**：不涉及。                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      |
| offset       | 否    | Integer          | **参数解释**：分页偏移量。 **约束限制**：不涉及。 **取值范围**：0\~10000。 **默认取值**：0。                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                         |
| limit        | 否    | Integer          | **参数解释**：分页大小。 **约束限制**：不涉及。 **取值范围**：1\~1000。 **默认取值**：100。                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                         |
| name         | 否    | String           | **参数解释**：端点名称，精确查询。 **约束限制**：不涉及。 **取值范围**：长度为1\~63个字符，遵循RFC 1035规范，支持小写字母、数字、中划线，必须字母开头、字母或数字结尾。 **默认取值**：不涉及。                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      |
| storage_id   | 否    | String           | **参数解释**：存储资源ID，不传则查询所有存储的操作记录。 **约束限制**：不涉及。 **取值范围**：长度为1\~64的英文字符、数字和中划线的组合。 **默认取值**：不涉及。                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
| tags         | 否    | Array of strings | **参数解释**：标签过滤条件，支持多个标签。 **约束限制**：最多10个标签。 **取值范围**：格式为 key#value1,value2，用英文逗号分隔多个值。 **默认取值**：不涉及。                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                   |
   
#### 请求参数
表3请求Header参数 
| 参数           | 是否必选 | 参数类型   | 描述                                                                                                                                                                             |
|:---|:---|:---|:---|
| X-Auth-Token | 是    | String | **参数解释**：用户Token。 **约束限制**：不涉及。 **取值范围**：长度不超过65534个字符。 **默认取值**：不涉及。 |
   
#### 响应参数
**状态码：200**
表4响应Body参数 
| 参数        | 参数类型                                                                                   | 描述                                                                   |
|:---|:---|:---|
| total     | Integer                                                                                | **参数解释**：总记录数。 **取值范围**：大于等于0的整数。 |
| endpoints | Array of [V2EndpointBriefInfo] objects | **参数解释**：端点列表。                                                       |
   
 表5V2EndpointBriefInfo 
| 参数            | 参数类型                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                               | 描述                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                |
|:---|:---|:---|
| id            | String                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                             | **参数解释**：端点ID。 **取值范围**：长度为1\~36的英文字符、数字和中划线的组合。                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                               |
| name          | String                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                             | **参数解释**：端点名称。 **取值范围**：长度为1\~63个字符，遵循RFC 1035规范，支持小写字母、数字、中划线，必须字母开头、字母或数字结尾。                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                 |
| display_name  | String                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                             | **参数解释**：端点显示名称。 **取值范围**：长度为1\~63个字符，支持小写字母、数字、中划线、汉字。                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
| description   | String                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                             | **参数解释**：资源描述信息。 **取值范围**：长度为0\~1000个字符，支持中文字符、英文字母、数字及特殊字符。                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                   |
| status        | String                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                             | **参数解释**：Endpoint状态。 **取值范围**： - CREATING：创建中。   - RUNNING：运行中。   - CREATE_FAILED：创建失败。   - DELETING：删除中。   - DELETED：已删除。   - UPDATING：更新中。   - UPDATE_FAILED：更新失败。   - DELETE_FAILED：删除失败。   - FROZEN：冻结。   - TRIAL_ENDED：试用结束。   - ON_DEMAND_FROZEN：按需冻结。    |
| engine        | One of: - [SparkJob] object   - [SparkSql] object   - [RayCluster] object   - [RayJob] object   - [AuraJob] object   - [AuraJobV2] object    | **参数解释**：引擎配置。                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    |
| capacity      | Array of [V2EndpointCapacityItem] objects                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       | **参数解释**：计算资源容量配置。                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                |
| resource_type | String                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                             | **参数解释**：资源使用模式。 **取值范围**： - RESERVED：预留资源。   - ONDEMAND：按需弹性。   - HYBRID：混合模式。                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                         |
| create_time   | String                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                             | **参数解释**：资源创建时间。 **取值范围**：ISO 8601格式，例如2025-01-10T03:37:12.000+00:00。                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          |
| update_time   | String                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                             | **参数解释**：资源更新时间。 **取值范围**：ISO 8601格式，例如2025-01-10T03:37:12.000+00:00。                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          |
| compute_id    | String                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                             | **参数解释**：计算资源ID。 **取值范围**：长度为1\~36的英文字符、数字和中划线的组合。                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                             |
| credential    | [CredentialConfig] object                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                             | **参数解释**：Endpoint级别用户委托名称，用于Endpoint的存储等配置权限认证，以及作为作业运行时的默认委托。                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    |
| creator       | [Creator] object                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                               | **参数解释**：资源所有者信息。                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                 |
| tags          | Array of [ResourceTag] objects                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                             | **参数解释**：资源标签列表。                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  |
| error         | [Error] object                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                   | **参数解释**：失败时返回的文本消息内容，包含错误码、错误描述。                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                 |
   
 表6SparkJob 
| 参数                | 参数类型                                                                             | 描述                     |
|:---|:---|:---|
| spark_config      | Map\<String,String\>                                                             | **参数解释**：Spark参数配置。    |
| scheduling_config | [SparkSchedulingConfig] object | **参数解释**：SparkJob调度配置。 |
| staging_config    | [StagingConfig] object                 | **参数解释**：临时存储配置。       |
| image             | [V2ImageBriefInfo] object           | **参数解释**：镜像配置。         |
   
 表7SparkSchedulingConfig 
| 参数                     | 参数类型    | 描述                                                                                                                                                                                                                                                                                                                                                                                                                                 |
|:---|:---|:---|
| max_concurrent_jobs    | Integer | **参数解释**：端点最大并发作业数量。 **取值范围**：1\~1000。                                                                                                                                                                                                                                                                                                                                                          |
| scheduling_policy      | String  | **参数解释**：作业调度策略，支持随机和先进先出。 **取值范围**： - RANDOM：随机。   - FIFO：先进先出。    |
| fifo_tolerance_seconds | Integer | **参数解释**：FIFO允许并发时间（秒）。 **取值范围**：0\~3600。                                                                                                                                                                                                                                                                                                                                                       |
   
 表8SparkSql 
| 参数                              | 参数类型                                                                       | 描述                                                                         |
|:---|:---|:---|
| spark_config                    | Map\<String,String\>                                                       | **参数解释**：Spark参数配置。                                                        |
| staging_config                  | [StagingConfig] object           | **参数解释**：临时存储配置。                                                           |
| cluster_config                  | [SparkClusterConfig] object | **参数解释**：集群配置。                                                             |
| max_endpoint_concurrent_queries | Integer                                                                    | **参数解释**：端点最大并发sql数量。 **取值范围**：1\~1000。 |
| image                           | [V2ImageBriefInfo] object     | **参数解释**：镜像配置。                                                             |
   
 表9StagingConfig 
| 参数  | 参数类型                                                     | 描述                |
|:---|:---|:---|
| obs | [ObsConfig] object | **参数解释**：OBS存储配置。 |
   
 表10SparkClusterConfig 
| 参数                             | 参数类型                                                                                     | 描述                                                                       |
|:---|:---|:---|
| aging_time                     | Integer                                                                                  | **参数解释**：集群老化时间（小时）。 **取值范围**：1\~12。  |
| auto_stop_config               | [AutoStopConfig] object                       | **参数解释**：集群自动停止配置。                                                       |
| driver_resource_spec           | [SparkDriverResourceSpec] object     | **参数解释**：SparkSql端点的Driver资源配置。                                          |
| executor_resource_spec         | [SparkExecutorResourceSpec] object | **参数解释**：SparkSql端点的Executor资源配置。                                        |
| min_clusters                   | Integer                                                                                  | **参数解释**：最小集群数量。 **取值范围**：小于等于20。     |
| max_clusters                   | Integer                                                                                  | **参数解释**：最大集群数量。 **取值范围**：2\~20。      |
| max_cluster_concurrent_queries | Integer                                                                                  | **参数解释**：集群最大并发SQL数量。 **取值范围**：1\~30。 |
   
 表11AutoStopConfig 
| 参数                   | 参数类型    | 描述                                                                                                                                                                                                                                                                                                                                                                                                                                  |
|:---|:---|:---|
| enabled              | Boolean | **参数解释**：自动停止集群开关。 **取值范围**： - true：开启自动停止集群。   - false：关闭自动停止集群。    |
| idle_timeout_minutes | Integer | **参数解释**：指定时间不活动后自动停止集群,单位分钟。 **取值范围**：5\~360。                                                                                                                                                                                                                                                                                                                                                   |
   
 表12SparkDriverResourceSpec 
| 参数     | 参数类型    | 描述                                                                                                   |
|:---|:---|:---|
| cpu    | Integer | **参数解释**：Spark Driver CPU，单位毫核。 **取值范围**：1000\~64000。             |
| memory | Integer | **参数解释**：Spark Driver内存大小，单位MB，1GB=1024MB。 **取值范围**：1024\~524288。 |
   
 表13SparkExecutorResourceSpec 
| 参数                   | 参数类型    | 描述                                                                                                     |
|:---|:---|:---|
| cpu                  | Integer | **参数解释**：Spark Executor CPU，单位毫核。 **取值范围**：1000\~64000。             |
| memory               | Integer | **参数解释**：Spark Executor内存大小，单位MB，1GB=1024MB。 **取值范围**：1024\~524288。 |
| min_executor_numbers | Integer | **参数解释**：Spark Executor最小数量。 **取值范围**：大于等于1。                        |
| max_executor_numbers | Integer | **参数解释**：Spark Executor最大数量。 **取值范围**：1\~1000。                      |
   
 表14RayCluster 
| 参数                    | 参数类型                                                                         | 描述                           |
|:---|:---|:---|
| cluster_config        | [RayClusterConfigV3] object   | **参数解释**：Ray集群规格。            |
| redis_config          | [RedisConfig] object                 | **参数解释**：Redis集群配置，目前仅支持DCS。 |
| storages_config       | [StoragesConfig] object           | **参数解释**：存储资源配置。             |
| image                 | [V2ImageBriefInfo] object       | **参数解释**：镜像配置。               |
| history_server_config | [HistoryServerConfig] object | **参数解释**：History Server配置。   |
   
 表15RayClusterConfigV3 
| 参数                 | 参数类型                                                                               | 描述                        |
|:---|:---|:---|
| head_group_spec    | [HeadGroupSpecV3] object               | **参数解释**：Head的配置。         |
| worker_group_specs | Array of [WorkerGroupSpecV3] objects | **参数解释**：Worker Group的配置。 |
   
 表16HeadGroupSpecV3 
| 参数       | 参数类型                                                               | 描述             |
|:---|:---|:---|
| resource | [ResourceSpecV3] object | **参数解释**：资源规格。 |
   
 表17WorkerGroupSpecV3 
| 参数           | 参数类型                                                               | 描述                                                                             |
|:---|:---|:---|
| name         | String                                                             | **参数解释**：名称。 **取值范围**：长度0\~128字母、数字、中划线的组合。 |
| min_replicas | Integer                                                            | **参数解释**：最小副本数。 **取值范围**：0\~10000。          |
| max_replicas | Integer                                                            | **参数解释**：最大副本数。 **取值范围**：1\~10000。          |
| resource     | [ResourceSpecV3] object | **参数解释**：资源规格。                                                                 |
   
 表18ResourceSpecV3 
| 参数        | 参数类型    | 描述                                                                             |
|:---|:---|:---|
| spec_code | String  | **参数解释**：规格编码。 **取值范围**：不涉及。                |
| cpu       | Integer | **参数解释**：CPU核数量，单位为毫核。 **取值范围**：0\~1000000。 |
| memory    | Integer | **参数解释**：内存大小，单位MB。 **取值范围**：0\~10000000。   |
| npu       | Double  | **参数解释**：昇腾卡数量。 **取值范围**：0\~100。            |
| gpu       | Double  | **参数解释**：GPU卡数量。 **取值范围**：0\~100。           |
   
 表19RedisConfig 
| 参数               | 参数类型   | 描述                                                                                                                                  |
|:---|:---|:---|
| username         | String | **参数解释**：账号名称。 **取值范围**：长度范围1\~64个字符。                                                            |
| dew_secret_name  | String | **参数解释**：DEW的凭据名称。存储着DCS账号的密码，格式为：凭据键为password，值为实际的密码。 **取值范围**：长度为1\~64个英文大小写字母、数字、中划线、下划线的组合。 |
| dcs_id           | String | **参数解释**：DCS实例的ID。 **取值范围**：长度为4\~1024个英文小写字母、数字、中划线的组合。                                         |
| vpcep_service_id | String | **参数解释**：VPCEP服务端ID，用于连接客户侧网络。开启GCS高可用时必填，用于通过VPCEP方式连接客户侧DCS。 **取值范围**：不涉及。                     |
   
 表20V2ImageBriefInfo 
| 参数         | 参数类型   | 描述                                                                                   |
|:---|:---|:---|
| id         | String | **参数解释**：镜像ID。 **取值范围**：长度为32\~36的英文、数字、中划线的组合。   |
| version_id | String | **参数解释**：镜像版本ID。 **取值范围**：长度为32\~36的英文、数字、中划线的组合。 |
   
 表21RayJob 
| 参数                    | 参数类型                                                                         | 描述                         |
|:---|:---|:---|
| history_server_config | [HistoryServerConfig] object | **参数解释**：History Server配置。 |
   
 表22HistoryServerConfig 
| 参数                   | 参数类型                                                     | 描述                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              |
|:---|:---|:---|
| enabled              | Boolean                                                  | **参数解释**：存储历史服务器功能的启用/禁用状态。必须将其设置为"true"才能启用该功能。 **取值范围**： - true：启用。   - false：禁用。                                                                                              |
| obs                  | [ObsConfig] object | **参数解释**：OBS存储配置。指定对象存储服务（OBS）桶，用于存储History Server收集器采集的诊断数据（例如Flow Insight收集的数据）。该服务使用指定的委托（Agency）对该桶进行读写操作。当"enabled" 为"true"时，此字段为必填项。                                                                                                                                                                                                                                                                                                                                                                                                      |
| flow_insight_enabled | Boolean                                                  | **参数解释**：Flow Insight是一项诊断与可观测性功能，它从Ray集群收集指标、日志及工作流执行数据，并通过History Server收集器将其传输至已配置的OBS存储。该功能仅在更新现有端点时生效，且必须在"enabled"设置为"true"的情况下才能启用。 **取值范围**： - true：启用。   - false：禁用。    |
   
 表23ObsConfig 
| 参数          | 参数类型   | 描述                                                                                                           |
|:---|:---|:---|
| bucket_name | String | **参数解释**：OBS桶名称。该桶的类型必须是并行文件系统。 **取值范围**：长度为3\~63个字符，支持小写字母、数字、中划线和句点的组合。 |
| agency_name | String | **参数解释**：委托名称。云服务将使用该委托操作OBS桶。 **取值范围**：不涉及。                              |
   
 表24AuraJob 
| 参数              | 参数类型                                                               | 描述               |
|:---|:---|:---|
| storages_config | [StoragesConfig] object | **参数解释**：存储资源配置。 |
   
 表25AuraJobV2 
| 参数                  | 参数类型                                                                               | 描述                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                 |
|:---|:---|:---|
| expand_cpu_resource | Boolean                                                                            | **参数解释**：开启后，通算工作组作业能够使用智算工作组空闲CPU及内存资源，该操作可能会导致智算任务因资源不足而排队。 **取值范围**： - TRUE：开启通算工作组作业使用智算工作组空闲CPU及内存资源。   - false：关闭通算工作组作业使用智算工作组空闲CPU及内存资源。    |
| worker_group_config | Array of [WorkerGroupConfig] objects | **参数解释**：工作组补充配置，和外部capacity对应。                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    |
| staging_config      | [AuraV2StagingConfig] object       | **参数解释**：计算结果集OBS存储配置。                                                                                                                                                                                                                                                                                                                                                                                                                                                                                             |
| storages_config     | [StoragesConfig] object                 | **参数解释**：存储资源配置。                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                   |
   
 表26WorkerGroupConfig 
| 参数        | 参数类型                                                                   | 描述                                                                                      |
|:---|:---|:---|
| name      | String                                                                 | **参数解释**：工作组名称。 **取值范围**：长度为1\~63个字符，支持字母、数字和中划线的组合。 |
| spec_code | String                                                                 | **参数解释**：节点规格。 **取值范围**：从规格列表查询获取。                   |
| cpu       | Integer                                                                | **参数解释**：通算CPU大小，单位毫核。 **取值范围**：大于等于0。               |
| memory    | Integer                                                                | **参数解释**：通算内存大小，单位MB。 **取值范围**：大于等于0。                |
| gpu       | Double                                                                 | **参数解释**：GPU卡数量。 **取值范围**：大于等于0。                     |
| npu       | Double                                                                 | **参数解释**：NPU卡数量。 **取值范围**：大于等于0。                     |
| image     | [ImageVersionInfo] object | **参数解释**：镜像。                                                                            |
   
 表27ImageVersionInfo 
| 参数         | 参数类型   | 描述                                                                   |
|:---|:---|:---|
| id         | String | **参数解释**：镜像版本ID。 **取值范围**：不涉及。    |
| version_id | String | **参数解释**：自定义镜像版本ID。 **取值范围**：不涉及。 |
   
 表28AuraV2StagingConfig 
| 参数  | 参数类型                                                                 | 描述                |
|:---|:---|:---|
| obs | [AuraV2ObsConfig] object | **参数解释**：OBS存储配置。 |
   
 表29AuraV2ObsConfig 
| 参数          | 参数类型   | 描述                                                                                            |
|:---|:---|:---|
| bucket_name | String | **参数解释**：OBS桶名称。 **取值范围**：长度为3\~63个字符，支持小写字母、数字、中划线和句点的组合。 |
   
 表30StoragesConfig 
| 参数    | 参数类型                                                                               | 描述               |
|:---|:---|:---|
| files | Array of [FileStorageConfig] objects | **参数解释**：文件存储配置。 |
   
 表31FileStorageConfig 
| 参数           | 参数类型   | 描述                                                                                    |
|:---|:---|:---|
| storage_id   | String | **参数解释**：存储空间ID。 **取值范围**：长度为1\~36的英文字符、数字和中划线的组合。 |
| storage_name | String | **参数解释**：存储的名称，对应PVC的名称。 **取值范围**：最小长度为1，最大长度为63。  |
| storage_path | String | **参数解释**：存储上的路径。 **取值范围**：最小长度为1，最大长度为1024。        |
| mount_path   | String | **参数解释**：挂载到容器的路径。 **取值范围**：最小长度为1，最大长度为1024。      |
   
 表32V2EndpointCapacityItem 
| 参数                    | 参数类型    | 描述                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                               |
|:---|:---|:---|
| type                  | String  | **参数解释**：资源类型。 **取值范围**： - CPU：CPU资源。   - GPU：GPU资源。   - NPU：NPU资源。    |
| maximum_capacity      | Integer | **参数解释**：资源数量。 **取值范围**：1\~10000。                                                                                                                                                                                                                                                                                                                                                                                                                                                                                             |
| minimum_capacity      | Integer | **参数解释**：最小资源数量。 **取值范围**：0\~10000，小于等于maximum_capacity。                                                                                                                                                                                                                                                                                                                                                                                                                                                                      |
| spec_code             | String  | **参数解释**：资源规格。 **取值范围**：长度为1\~64个字符。                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          |
| use_ondemand_resource | Boolean | **参数解释**：容量是否使用弹性资源。 **取值范围**： - true：使用弹性资源。   - false：不使用弹性资源。                                                                                                                                  |
   
 表33CredentialConfig 
| 参数          | 参数类型   | 描述                                                                                                                      |
|:---|:---|:---|
| agency_name | String | **参数解释**：Endpoint级别用户委托名称，用于Endpoint的存储等配置权限认证，以及作为作业运行时的默认委托。 **取值范围**：长度为1\~64个字符。 |
   
 表34Creator 
| 参数          | 参数类型   | 描述                                                                      |
|:---|:---|:---|
| domain_name | String | **参数解释**：租户名称。 **取值范围**：长度为1\~64个字符。 |
| domain_id   | String | **参数解释**：租户ID。 **取值范围**：长度为1\~64个字符。 |
| user_name   | String | **参数解释**：用户名称。 **取值范围**：长度为1\~64个字符。 |
| user_id     | String | **参数解释**：用户ID。 **取值范围**：长度为1\~64个字符。 |
   
 表35ResourceTag 
| 参数    | 参数类型   | 描述                                                                                                            |
|:---|:---|:---|
| key   | String | **参数解释**：资源标签的键。 **取值范围**：长度1\~128的多语言字母、空格、数字、下划线、点、冒号、斜杠、等号、加号、减号、@符号组合。 |
| value | String | **参数解释**：资源标签的值。 **取值范围**：长度0\~255的多语言字母、空格、数字、下划线、点、冒号、斜杠、等号、加号、减号、@符号组合。 |
   
 表36Error 
| 参数         | 参数类型   | 描述                                                                              |
|:---|:---|:---|
| error_code | String | **参数解释**：失败状态时的错误编码。 **取值范围**：长度为0\~36个字符。   |
| error_msg  | String | **参数解释**：失败状态时的错误信息。 **取值范围**：长度为0\~1024个字符。 |
   
**状态码：400**
表37响应Body参数 
| 参数           | 参数类型   | 描述                                                                        |
|:---|:---|:---|
| error_code   | String | **参数解释**：错误码。 **取值范围**：长度为8\~36个字符。    |
| error_msg    | String | **参数解释**：错误描述。 **取值范围**：长度为2\~512个字符。  |
| solution_msg | String | **参数解释**：解决方案。 **取值范围**：长度为0\~4096个字符。 |
   
**状态码：401**
表38响应Body参数 
| 参数           | 参数类型   | 描述                                                                        |
|:---|:---|:---|
| error_code   | String | **参数解释**：错误码。 **取值范围**：长度为8\~36个字符。    |
| error_msg    | String | **参数解释**：错误描述。 **取值范围**：长度为2\~512个字符。  |
| solution_msg | String | **参数解释**：解决方案。 **取值范围**：长度为0\~4096个字符。 |
   
**状态码：403**
表39响应Body参数 
| 参数           | 参数类型   | 描述                                                                        |
|:---|:---|:---|
| error_code   | String | **参数解释**：错误码。 **取值范围**：长度为8\~36个字符。    |
| error_msg    | String | **参数解释**：错误描述。 **取值范围**：长度为2\~512个字符。  |
| solution_msg | String | **参数解释**：解决方案。 **取值范围**：长度为0\~4096个字符。 |
   
**状态码：404**
表40响应Body参数 
| 参数           | 参数类型   | 描述                                                                        |
|:---|:---|:---|
| error_code   | String | **参数解释**：错误码。 **取值范围**：长度为8\~36个字符。    |
| error_msg    | String | **参数解释**：错误描述。 **取值范围**：长度为2\~512个字符。  |
| solution_msg | String | **参数解释**：解决方案。 **取值范围**：长度为0\~4096个字符。 |
   
**状态码：500**
表41响应Body参数 
| 参数           | 参数类型   | 描述                                                                        |
|:---|:---|:---|
| error_code   | String | **参数解释**：错误码。 **取值范围**：长度为8\~36个字符。    |
| error_msg    | String | **参数解释**：错误描述。 **取值范围**：长度为2\~512个字符。  |
| solution_msg | String | **参数解释**：解决方案。 **取值范围**：长度为0\~4096个字符。 |
   
#### 请求示例
查询指定工作空间下指定计算资源的端点列表，返回端点简要信息。
```
GET /v2/workspaces/{workspace_id}/endpoints?compute_id={compute_id}
```
#### 响应示例
**状态码：200**
请求成功。
- 查询指定工作空间下的端点列表，返回AuraJob类型的端点信息。
  ```
  {
    "total" : 1,
    "endpoints" : [ {
      "id" : "0b5633ba2b904511ad514346f4d23d4b",
      "name" : "endpoint-01",
      "display_name" : "endpoint-01",
      "description" : "测试端点",
      "status" : "RUNNING",
      "engine" : {
        "type" : "AuraJob"
      },
      "resource_type" : "RESERVED",
      "compute_id" : "00030bf1-4466-4c84-b32d-f601b136f03b",
      "capacity" : [ {
        "type" : "CPU",
        "maximum_capacity" : 10,
        "minimum_capacity" : 0,
        "use_ondemand_resource" : false,
        "spec_code" : "aidatalake.cpu.x86.general.1c4g"
      } ],
      "create_time" : "2025-01-10T03:37:12.000+00:00",
      "update_time" : "2025-01-10T03:37:12.000+00:00",
      "creator" : {
        "domain_name" : "test",
        "domain_id" : "0676610f3a0a4c2c80c50bea7ddf18c1",
        "user_id" : "019e19fb78887b57b2f6c4174cd5a002",
        "user_name" : "developer"
      },
      "tags" : [ {
        "key" : "test",
        "value" : "ai"
      } ]
    } ]
  }
  ```
  
- 查询指定工作空间下的端点列表，返回SparkSql和SparkJob类型的端点信息。
  ```
  {
    "total" : 2,
    "endpoints" : [ {
      "id" : "1a2b3c4d5e6f7890abcdef1234567890",
      "name" : "spark-sql-test",
      "display_name" : "spark-sql-test",
      "description" : "SparkSql测试端点",
      "status" : "RUNNING",
      "engine" : {
        "type" : "SparkSql",
        "spark_config" : { },
        "cluster_config" : {
          "aging_time" : 6,
          "auto_stop_config" : {
            "enabled" : true,
            "idle_timeout_minutes" : 10
          },
          "driver_resource_spec" : {
            "cpu" : 4000,
            "memory" : 32768
          },
          "executor_resource_spec" : {
            "cpu" : 4000,
            "memory" : 32768,
            "min_executor_numbers" : 2,
            "max_executor_numbers" : 8
          },
          "min_clusters" : 0,
          "max_clusters" : 6,
          "max_cluster_concurrent_queries" : 16
        },
        "max_endpoint_concurrent_queries" : 300
      },
      "resource_type" : "RESERVED",
      "compute_id" : "0150a336-dda9-431c-9ef1-af02ec424a5e",
      "capacity" : [ {
        "type" : "CPU",
        "maximum_capacity" : 1000,
        "minimum_capacity" : 0,
        "use_ondemand_resource" : false,
        "spec_code" : "aidatalake.cpu.x86.general.1c2g"
      } ],
      "create_time" : "2025-01-10T03:37:12.000+00:00",
      "update_time" : "2025-01-10T03:37:12.000+00:00",
      "creator" : {
        "domain_name" : "test",
        "domain_id" : "0676610f3a0a4c2c80c50bea7ddf18c1",
        "user_id" : "019e19fb78887b57b2f6c4174cd5a002",
        "user_name" : "developer"
      },
      "tags" : [ {
        "key" : "test",
        "value" : "ai"
      } ]
    }, {
      "id" : "2b3c4d5e6f7890abcdef1234567890ab",
      "name" : "spark-job-test",
      "display_name" : "spark-job-test",
      "description" : "SparkJob测试端点",
      "status" : "RUNNING",
      "engine" : {
        "type" : "SparkJob",
        "spark_config" : { },
        "scheduling_config" : {
          "max_concurrent_jobs" : 300,
          "scheduling_policy" : "RANDOM"
        }
      },
      "resource_type" : "RESERVED",
      "compute_id" : "0150a336-dda9-431c-9ef1-af02ec424a5e",
      "capacity" : [ {
        "type" : "CPU",
        "maximum_capacity" : 1000,
        "minimum_capacity" : 0,
        "use_ondemand_resource" : false,
        "spec_code" : "aidatalake.cpu.x86.general.1c2g"
      } ],
      "create_time" : "2025-01-10T03:37:12.000+00:00",
      "update_time" : "2025-01-10T03:37:12.000+00:00",
      "creator" : {
        "domain_name" : "test",
        "domain_id" : "0676610f3a0a4c2c80c50bea7ddf18c1",
        "user_id" : "019e19fb78887b57b2f6c4174cd5a002",
        "user_name" : "developer"
      },
      "tags" : [ {
        "key" : "test",
        "value" : "ai"
      } ]
    } ]
  }
  ```
  
**状态码：400**
请求参数错误。
```
{
  "error_code" : "AIDataLake.00010151",
  "error_msg" : "Parameter value is invalid.",
  "solution_msg" : "Please input valid parameter value."
}
```
**状态码：401**
未授权。
```
{
  "error_code" : "APIGW.0301",
  "error_msg" : "Incorrect IAM authentication information: decrypt token fail.",
  "solution_msg" : "Check whether the IAM authentication information is correct."
}
```
**状态码：403**
禁止访问。
```
{
  "error_code" : "AIDataLake.00010150",
  "error_msg" : "The operation is not allowed.",
  "solution_msg" : "Check whether the operation is allowed in the current status."
}
```
**状态码：404**
资源未找到。
```
{
  "error_code" : "AIDataLake.00010009",
  "error_msg" : "No resources found.",
  "solution_msg" : "Enter correct resource and project IDs."
}
```
**状态码：500**
内部服务器错误。
```
{
  "error_code" : "AIDataLake.00011001",
  "error_msg" : "Internal error.",
  "solution_msg" : "Contact technical support or try again later."
}
```
#### 状态码
| 状态码 | 描述       |
|:---|:---|
| 200 | 请求成功。    |
| 400 | 请求参数错误。  |
| 401 | 未授权。     |
| 403 | 禁止访问。    |
| 404 | 资源未找到。   |
| 500 | 内部服务器错误。 |
   
