# 查询端点详情 - ShowEndpoint #### 功能介绍 查询端点详情。用户可通过该接口查询某端点详情，输入为端点id，返回对应端点详情。此接口为同步接口，无配套使用接口和特殊场景。 #### 调试 您可以在[API Explorer](https://console.huaweicloud.com/apiexplorer/#/openapi/DataArtsFabric/doc?api=ShowEndpoint)中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。 #### 授权信息 账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。 - 如果使用角色与策略授权，具体权限要求请参见[权限和授权项](https://support.huaweicloud.com/api-fabric/dataartsfabric_03_0014.html)。 - 如果使用身份策略授权，需具备如下身份策略权限。 | 授权项 | 访问级别 | 资源类型（\*为必须） | 条件键 | 别名 | 依赖的授权项 | |:---|:---|:---|:---|:---|:---| | DataArtsFabric:endpoint:show | Read | workspace \* | - g:ResourceTag/\ - g:EnterpriseProjectId | - | - | | DataArtsFabric:endpoint:show | Read | endpoint \* | - | - | - | #### URI GET /v1/workspaces/{workspace_id}/endpoints/{endpoint_id} 表1路径参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | workspace_id | 是 | String | **参数解释** ：工作空间ID，获取方法，请参见[获取工作空间ID](https://support.huaweicloud.com/api-fabric/dataartsfabric_03_0022.html)。 **约束限制**：不涉及。 **取值范围**：长度为\[1,36\]的英文字符、数字和中划线(-)的组合。 **默认取值**：不涉及。 | | endpoint_id | 是 | String | **参数解释** ：端点ID。获取方法，请参见[获取端点ID](https://support.huaweicloud.com/api-fabric/dataartsfabric_03_0023.html)。 **约束限制**：不涉及。 **取值范围**：长度为\[1,36\]的英文字符、数字和中划线(-)的组合。 **默认取值**：不涉及。 | 表2Query参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | version | 否 | String | **参数解释**：查询Endpoint信息的版本。 **约束限制**：不涉及。 **取值范围**： - CURRENT：当前版本； - PREVIOUS：上个版本。 **默认取值**：不涉及。 | #### 请求参数 表3请求Header参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | X-Auth-Token | 否 | String | **参数解释** ：租户Token。用于调用接口的认证。获取方法，请参见[认证鉴权](https://support.huaweicloud.com/api-fabric/dataartsfabric_03_0005.html)。 **约束限制**：不涉及。 **取值范围**：长度不超过65534个字符。 **默认取值**：不涉及。 | #### 响应参数 **状态码：200** 查询endpoint详情的响应。 **状态码：400** 表4响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | error_code | String | **参数解释**：错误码。 **约束限制**：不涉及。 **取值范围**：长度为\[8,36\]个字符。 **默认取值**：不涉及。 | | error_msg | String | **参数解释**：错误描述。 **约束限制**：不涉及。 **取值范围**：长度为\[2,512\]个字符。 **默认取值**：不涉及。 | | solution_msg | String | **参数解释**：解决方案描述。 **约束限制**：不涉及。 **取值范围**：长度为\[0,4096\]个字符。 **默认取值**：不涉及。 | **状态码：401** 表5响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | error_code | String | **参数解释**：错误码。 **约束限制**：不涉及。 **取值范围**：长度为\[8,36\]个字符。 **默认取值**：不涉及。 | | error_msg | String | **参数解释**：错误描述。 **约束限制**：不涉及。 **取值范围**：长度为\[2,512\]个字符。 **默认取值**：不涉及。 | | solution_msg | String | **参数解释**：解决方案描述。 **约束限制**：不涉及。 **取值范围**：长度为\[0,4096\]个字符。 **默认取值**：不涉及。 | **状态码：408** 表6响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | error_code | String | **参数解释**：错误码。 **约束限制**：不涉及。 **取值范围**：长度为\[8,36\]个字符。 **默认取值**：不涉及。 | | error_msg | String | **参数解释**：错误描述。 **约束限制**：不涉及。 **取值范围**：长度为\[2,512\]个字符。 **默认取值**：不涉及。 | | solution_msg | String | **参数解释**：解决方案描述。 **约束限制**：不涉及。 **取值范围**：长度为\[0,4096\]个字符。 **默认取值**：不涉及。 | **状态码：500** 表7响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | error_code | String | **参数解释**：错误码。 **约束限制**：不涉及。 **取值范围**：长度为\[8,36\]个字符。 **默认取值**：不涉及。 | | error_msg | String | **参数解释**：错误描述。 **约束限制**：不涉及。 **取值范围**：长度为\[2,512\]个字符。 **默认取值**：不涉及。 | | solution_msg | String | **参数解释**：解决方案描述。 **约束限制**：不涉及。 **取值范围**：长度为\[0,4096\]个字符。 **默认取值**：不涉及。 | #### 请求示例 ``` GET https://{endpoint}/v1/workspaces/{workspace_id}/endpoints/{endpoint_id} ``` #### 响应示例 **状态码：200** 查询endpoint详情的响应。 ``` { "visibility" : "PRIVATE", "id" : "0b5633ba2b904511ad514346f4d23d4b", "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" : "0b5633ba2b904511ad514346f4d23d4b", "user_name" : "string", "user_id" : "0b5633ba2b904511ad514346f4d23d4b" }, "cap" : { "cap_id" : "0b5633ba2b904511ad514346f4d23d4b", "version_id" : "0b5633ba2b904511ad514346f4d23d4b" }, "reserved_resource" : { "apu" : { "spec_code" : "dpu.d1x", "warm_up_num" : 1, "max_num" : 100 }, "dpu" : { "spec_code" : "dpu.d1x", "warm_up_num" : 1, "max_num" : 100, "use_public_resource" : false }, "mu" : { "spec_code" : "string", "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", "urls" : [ { "name" : "string", "address" : "string", "type" : "PRIVATE", "token" : "string" } ], "business_engine_instance_ids" : [ "string" ], "tokens_quota" : { "total" : 0, "used" : 0, "expire_time" : "2025-01-17T07:24:06.877Z" }, "runtime_env_type" : "RELEASE", "config" : { "ray_service_config" : { "log_config" : { "lts" : { "enabled" : false, "log_group_id" : "string", "log_stream_id" : "string" } }, "ray_serve_config" : { "applications" : [ { "name" : "string", "import_path" : "string", "deployments" : [ { "name" : "string", "ray_actor_options" : { "num_cpus" : 0, "memory" : 0, "resources" : "string" }, "autoscaling_config" : { "target_ongoing_requests" : 1000, "max_ongoing_requests" : 1000, "min_replicas" : 1000, "max_replicas" : 1000, "initial_replicas" : 1000, "upscale_delay_s" : 86400, "downscale_delay_s" : 86400 }, "num_replicas" : 1000, "user_config" : { }, "max_replicas_per_node" : "" } ], "runtime_env" : { "working_dir" : "string", "env_vars" : { "additionalProp1" : "string", "additionalProp2" : "string", "additionalProp3" : "string" } }, "route_prefix" : "string" } ] }, "ray_cluster_config" : { "head_group_spec" : { "limits" : { "spec_code" : "string" }, "requests" : { "spec_code" : "string" } }, "worker_group_specs" : [ { "name" : "string", "min_replicas" : 10000, "max_replicas" : 10000, "limits" : { "spec_code" : "string" }, "requests" : { "spec_code" : "string" } } ] }, "data_infos" : [ { "input_path" : "OBS://bucket/dir/", "output_path" : "OBS://bucket/dir/", "env_var_name" : "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)。