查询端点详情

功能介绍

查询端点详情。用户可通过该接口查询某端点详情，输入为端点id，返回对应端点详情。此接口为同步接口，无配套使用接口和特殊场景。

调试

您可以在API Explorer中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。

URI

GET /v1/workspaces/{workspace_id}/endpoints/{endpoint_id}

请求参数

响应参数

状态码：200

查询endpoint详情的响应。

状态码：400

状态码：401

状态码：408

状态码：500

请求示例

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"
}

状态码

错误码

请参见错误码。