网络
虚拟私有云 VPC
弹性公网IP EIP
弹性负载均衡 ELB
NAT网关 NAT
云专线 DC
虚拟专用网络 VPN
云连接 CC
VPC终端节点 VPCEP
企业路由器 ER
企业交换机 ESW
全球加速 GA
云原生应用网络 ANC
安全与合规
安全技术与应用
Web应用防火墙 WAF
企业主机安全 HSS
云防火墙 CFW
安全云脑 SecMaster
DDoS防护 AAD
数据加密服务 DEW
数据库安全服务 DBSS
云堡垒机 CBH
数据安全中心 DSC
云证书管理服务 CCM
认证测试中心 CTC
边缘安全 EdgeSec
应用中间件
微服务引擎 CSE
分布式消息服务Kafka版
分布式消息服务RabbitMQ版
分布式消息服务RocketMQ版
API网关 APIG
分布式缓存服务 DCS
多活高可用服务 MAS
事件网格 EG
管理与监管
统一身份认证服务 IAM
消息通知服务 SMN
云监控服务 CES
应用运维管理 AOM
应用性能管理 APM
云日志服务 LTS
云审计服务 CTS
标签管理服务 TMS
配置审计 Config
应用身份管理服务 OneAccess
资源访问管理 RAM
组织 Organizations
资源编排服务 RFS
优化顾问 OA
IAM 身份中心
云运维中心 COC
资源治理中心 RGC
解决方案
高性能计算 HPC
SAP
混合云灾备
开天工业工作台 MIW
解决方案工作台
数字化诊断治理专家服务
云生态
云商店
合作伙伴中心
华为云开发者学堂
华为云慧通差旅
开发与运维
软件开发生产线 CodeArts
需求管理 CodeArts Req
流水线 CodeArts Pipeline
代码检查 CodeArts Check
编译构建 CodeArts Build
部署 CodeArts Deploy
测试计划 CodeArts TestPlan
制品仓库 CodeArts Artifact
移动应用测试 MobileAPPTest
CodeArts IDE Online
开源镜像站 Mirrors
性能测试 CodeArts PerfTest
应用管理与运维平台 ServiceStage
云应用引擎 CAE
开源治理服务 CodeArts Governance
华为云Astro轻应用
CodeArts IDE
Astro工作流 AstroFlow
代码托管 CodeArts Repo
漏洞管理服务 CodeArts Inspector
联接 CodeArtsLink
软件建模 CodeArts Modeling
Astro企业应用 AstroPro
CodeArts 盘古助手
华为云Astro大屏应用
计算
弹性云服务器 ECS
Flexus云服务
裸金属服务器 BMS
云手机服务器 CPH
专属主机 DeH
弹性伸缩 AS
镜像服务 IMS
函数工作流 FunctionGraph
云耀云服务器(旧版)
VR云渲游平台 CVR
Huawei Cloud EulerOS
云化数据中心 CloudDC
网络
虚拟私有云 VPC
弹性公网IP EIP
弹性负载均衡 ELB
NAT网关 NAT
云专线 DC
虚拟专用网络 VPN
云连接 CC
VPC终端节点 VPCEP
企业路由器 ER
企业交换机 ESW
全球加速 GA
云原生应用网络 ANC
CDN与智能边缘
内容分发网络 CDN
智能边缘云 IEC
智能边缘平台 IEF
CloudPond云服务
安全与合规
安全技术与应用
Web应用防火墙 WAF
企业主机安全 HSS
云防火墙 CFW
安全云脑 SecMaster
DDoS防护 AAD
数据加密服务 DEW
数据库安全服务 DBSS
云堡垒机 CBH
数据安全中心 DSC
云证书管理服务 CCM
认证测试中心 CTC
边缘安全 EdgeSec
大数据
MapReduce服务 MRS
数据湖探索 DLI
表格存储服务 CloudTable
可信智能计算服务 TICS
推荐系统 RES
云搜索服务 CSS
数据可视化 DLV
数据接入服务 DIS
数据仓库服务 GaussDB(DWS)
数据治理中心 DataArts Studio
湖仓构建 LakeFormation
智能数据洞察 DataArts Insight
数智融合计算服务 DataArtsFabric
应用中间件
微服务引擎 CSE
分布式消息服务Kafka版
分布式消息服务RabbitMQ版
分布式消息服务RocketMQ版
API网关 APIG
分布式缓存服务 DCS
多活高可用服务 MAS
事件网格 EG
开天aPaaS
应用平台 AppStage
开天企业工作台 MSSE
开天集成工作台 MSSI
API中心 API Hub
云消息服务 KooMessage
交换数据空间 EDS
云地图服务 KooMap
云手机服务 KooPhone
组织成员账号 OrgID
云空间服务 KooDrive
管理与监管
统一身份认证服务 IAM
消息通知服务 SMN
云监控服务 CES
应用运维管理 AOM
应用性能管理 APM
云日志服务 LTS
云审计服务 CTS
标签管理服务 TMS
配置审计 Config
应用身份管理服务 OneAccess
资源访问管理 RAM
组织 Organizations
资源编排服务 RFS
优化顾问 OA
IAM 身份中心
云运维中心 COC
资源治理中心 RGC
区块链
区块链服务 BCS
数字资产链 DAC
华为云区块链引擎服务 HBS
解决方案
高性能计算 HPC
SAP
混合云灾备
开天工业工作台 MIW
解决方案工作台
数字化诊断治理专家服务
价格
成本优化最佳实践
专属云商业逻辑
云生态
云商店
合作伙伴中心
华为云开发者学堂
华为云慧通差旅
其他
管理控制台
消息中心
产品价格详情
系统权限
客户关联华为云合作伙伴须知
公共问题
宽限期保留期
奖励推广计划
活动
云服务信任体系能力说明
开发与运维
软件开发生产线 CodeArts
需求管理 CodeArts Req
流水线 CodeArts Pipeline
代码检查 CodeArts Check
编译构建 CodeArts Build
部署 CodeArts Deploy
测试计划 CodeArts TestPlan
制品仓库 CodeArts Artifact
移动应用测试 MobileAPPTest
CodeArts IDE Online
开源镜像站 Mirrors
性能测试 CodeArts PerfTest
应用管理与运维平台 ServiceStage
云应用引擎 CAE
开源治理服务 CodeArts Governance
华为云Astro轻应用
CodeArts IDE
Astro工作流 AstroFlow
代码托管 CodeArts Repo
漏洞管理服务 CodeArts Inspector
联接 CodeArtsLink
软件建模 CodeArts Modeling
Astro企业应用 AstroPro
CodeArts 盘古助手
华为云Astro大屏应用
存储
对象存储服务 OBS
云硬盘 EVS
云备份 CBR
高性能弹性文件服务 SFS Turbo
弹性文件服务 SFS
存储容灾服务 SDRS
云硬盘备份 VBS
云服务器备份 CSBS
数据快递服务 DES
云存储网关 CSG
专属分布式存储服务 DSS
数据工坊 DWR
地图数据 MapDS
键值存储服务 KVS
容器
云容器引擎 CCE
云容器实例 CCI
容器镜像服务 SWR
云原生服务中心 OSC
应用服务网格 ASM
华为云UCS
数据库
云数据库 RDS
数据复制服务 DRS
文档数据库服务 DDS
分布式数据库中间件 DDM
云数据库 GaussDB
云数据库 GeminiDB
数据管理服务 DAS
数据库和应用迁移 UGO
云数据库 TaurusDB
人工智能
AI开发平台ModelArts
华为HiLens
图引擎服务 GES
图像识别 Image
文字识别 OCR
自然语言处理 NLP
内容审核 Moderation
图像搜索 ImageSearch
企业级AI应用开发专业套件 ModelArts Pro
人脸识别服务 FRS
对话机器人服务 CBS
语音交互服务 SIS
人证核身服务 IVS
视频智能分析服务 VIAS
城市智能体
自动驾驶云服务 Octopus
盘古大模型 PanguLargeModels
AI科学计算服务
IoT物联网
设备接入 IoTDA
全球SIM联接 GSL
IoT数据分析 IoTA
路网数字化服务 DRIS
IoT边缘 IoTEdge
设备发放 IoTDP
企业应用
域名注册服务 Domains
云解析服务 DNS
企业门户 EWP
ICP备案
商标注册
华为云WeLink
华为云会议 Meeting
隐私保护通话 PrivateNumber
语音通话 VoiceCall
消息&短信 MSGSMS
云管理网络
SD-WAN 云服务
边缘数据中心管理 EDCM
云桌面 Workspace
应用与数据集成平台 ROMA Connect
ROMA资产中心 ROMA Exchange
政企自服务管理 ESM
视频
实时音视频 SparkRTC
视频直播 Live
视频点播 VOD
媒体处理 MPC
视频接入服务 VIS
数字内容生产线 MetaStudio
迁移
主机迁移服务 SMS
对象存储迁移服务 OMS
云数据迁移 CDM
迁移中心 MGC
专属云
专属计算集群 DCC
开发者工具
SDK开发指南
API签名指南
DevStar
华为云命令行工具服务 KooCLI
Huawei Cloud Toolkit
CodeArts API
云化转型
云架构中心
云采用框架
用户服务
账号中心
费用中心
成本中心
资源中心
企业管理
工单管理
客户运营能力
国际站常见问题
支持计划
专业服务
合作伙伴支持计划
我的凭证
华为云公共事业服务云平台
工业软件
工业数字模型驱动引擎
硬件开发工具链平台云服务
工业数据转换引擎云服务

创建端点

更新时间:2025-04-28 GMT+08:00
分享

功能介绍

创建端点。用户可使用该接口在工作空间下创建端点,输入名称、描述、类型、资源配置、cap配置等信息,返回端点信息。此接口为异步接口,配套使用接口ShowEndpoint查询端点详情,无特殊场景。

调试

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

URI

POST https://localhost.com/v1/workspaces/{workspace_id}/endpoints

表1 路径参数

参数

是否必选

参数类型

描述

workspace_id

String

  • 参数解释:工作空间ID,获取方法,请参见获取工作空间ID

  • 约束限制:不涉及。

  • 取值范围:长度为[1,36]的英文字符、数字和中划线(-)的组合。

  • 默认取值:不涉及。

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

  • 参数解释:租户Token。用于调用接口的认证。获取方法,请参见认证鉴权

  • 约束限制:不涉及。

  • 取值范围:长度不超过65534个字符。

  • 默认取值:不涉及。

表3 请求Body参数

参数

是否必选

参数类型

描述

name

String

  • 参数解释:Endpoint名称。

  • 约束限制:不涉及。

  • 取值范围:长度为[1,128]包含中文、字母、数字、下划线、中划线、半角句号(.)、空格的组合。

  • 默认取值:不涉及。

description

String

  • 参数解释:描述信息。

  • 约束限制:不涉及。

  • 取值范围:不涉及。

  • 默认取值:不涉及。

type

String

  • 参数解释:Endpoint的类型。

  • 约束限制:不涉及。

  • 取值范围

    • service:Service EP,代表一个可接收Service请求资源组;

    • ray:RayCluter on k8s的EP,代表一个Ray集群;

    • inference:推理的EP,代表一个推理函数实例;

    • job:Job EP,代表一个可接收Job请求资源组;

    • ray_service:RayService on k8s的EP,代表一个RayService。

    • sql:SQL EP,代表一个可接收SQL请求资源组。

  • 默认取值:不涉及。

reserved_resource

ReservedResource object

  • 参数解释:通用预留资源。

  • 约束限制:不涉及。

  • 取值范围:不涉及。

  • 默认取值:不涉及。

ray_resource

RayResourceInput object

  • 参数解释:创建Ray集群的资源配置。

  • 约束限制:不涉及。

  • 取值范围:不涉及。

  • 默认取值:不涉及。

cap

CapRef object

  • 参数解释:镜像包信息。

  • 约束限制:不涉及。

  • 取值范围:不涉及。

  • 默认取值:不涉及。

config

EndpointConfig object

  • 参数解释:端点的配置。

  • 约束限制:不涉及。

  • 取值范围:不涉及。

  • 默认取值:不涉及。

cache_list

Array of CacheConfig objects

  • 参数解释:分布式缓存配置。

  • 约束限制:不涉及。

  • 取值范围:不涉及。

  • 默认取值:不涉及。

表4 ReservedResource

参数

是否必选

参数类型

描述

apu

ResourceDef object

  • 参数解释:资源定义信息。

  • 约束限制:不涉及。

  • 取值范围:不涉及。

  • 默认取值:不涉及。

dpu

SqlResourceDef object

  • 参数解释:Sql资源定义信息。

  • 约束限制:不涉及。

  • 取值范围:不涉及。

  • 默认取值:不涉及。

mu

ResourceDemand object

  • 参数解释:资源需求量配置。

  • 约束限制:不涉及。

  • 取值范围:不涉及。

  • 默认取值:不涉及。

表5 ResourceDef

参数

是否必选

参数类型

描述

spec_code

String

  • 参数解释:Endpoint状态。

  • 约束限制:资源规格编码,从查询规格列表ListSpecs接口获取。

  • 取值范围:不涉及。

  • 默认取值:不涉及。

warm_up_num

Integer

  • 参数解释:预热资源量。

  • 约束限制:不涉及。

  • 取值范围:不涉及。

  • 默认取值:不涉及。

max_num

Integer

  • 参数解释:最大资源量,不填默认为预热资源量,即不使用弹性资源。

  • 约束限制:不涉及。

  • 取值范围:最小值为1,最大值为1000。

  • 默认取值:不涉及。

表6 SqlResourceDef

参数

是否必选

参数类型

描述

spec_code

String

  • 参数解释:Endpoint状态。

  • 约束限制:资源规格编码,从查询规格列表ListSpecs接口获取。

  • 取值范围:不涉及。

  • 默认取值:不涉及。

warm_up_num

Integer

  • 参数解释:预热资源量。

  • 约束限制:不涉及。

  • 取值范围:最小值为1,最大值为1000。

  • 默认取值:不涉及。

max_num

Integer

  • 参数解释:最大资源量,不填默认为预热资源量,即不使用弹性资源。

  • 约束限制:不涉及。

  • 取值范围:最小值为1,最大值为1000。

  • 默认取值:不涉及。

use_public_resource

Boolean

  • 参数解释:是否使用公共资源。

  • 约束限制:不涉及。

  • 取值范围:不涉及。

  • 默认取值:不涉及。

表7 RayResourceInput

参数

是否必选

参数类型

描述

head_node_resource

HeadNodeResourceDemand object

  • 参数解释:headNode资源需求量配置。

  • 约束限制:不涉及。

  • 取值范围:不涉及。

  • 默认取值:不涉及。

work_node_resources

Array of WorkNodeResourceDemand objects

  • 参数解释:工作节点资源配置。

  • 约束限制:不涉及。

  • 取值范围:[1,10]。

  • 默认取值:不涉及。

表8 HeadNodeResourceDemand

参数

是否必选

参数类型

描述

spec_code

String

  • 参数解释:资源规格。

  • 约束限制:不涉及。

  • 取值范围:从规格列表查询获取。

  • 默认取值:不涉及。

表9 WorkNodeResourceDemand

参数

是否必选

参数类型

描述

name

String

  • 参数解释:资源配置名称。

  • 约束限制:不涉及。

  • 取值范围:不涉及。

  • 默认取值:不涉及。

resource

ResourceDemand object

  • 参数解释:资源需求量配置。

  • 约束限制:不涉及。

  • 取值范围:不涉及。

  • 默认取值:不涉及。

表10 ResourceDemand

参数

是否必选

参数类型

描述

spec_code

String

  • 参数解释:资源规格。

  • 约束限制:不涉及。

  • 取值范围:从规格列表查询获取。

  • 默认取值:不涉及。

min

Integer

  • 参数解释:最小数。

  • 约束限制:不涉及。

  • 取值范围:最小值为0。

  • 默认取值:不涉及。

max

Integer

  • 参数解释:最大数。

  • 约束限制:不涉及。

  • 取值范围:最小值为1。

  • 默认取值:不涉及。

表11 CapRef

参数

是否必选

参数类型

描述

cap_id

String

  • 参数解释:镜像包ID。

  • 约束限制:不涉及。

  • 取值范围:长度为[32,36]的英文、数字、中划线(-)的组合。

  • 默认取值:不涉及。

version_id

String

  • 参数解释:镜像包版本ID。

  • 约束限制:不涉及。

  • 取值范围:长度为[32,36]的英文、数字、中划线(-)的组合。

  • 默认取值:不涉及。

表12 EndpointConfig

参数

是否必选

参数类型

描述

ray_service_config

RayServiceConfig object

  • 参数解释:RayService类型端点的配置。

  • 约束限制:不涉及。

  • 取值范围:不涉及。

  • 默认取值:不涉及。

表13 RayServiceConfig

参数

是否必选

参数类型

描述

ray_serve_config

RayServeConfig object

  • 参数解释:RayServe配置。

  • 约束限制:不涉及。

  • 取值范围:不涉及。

  • 默认取值:不涉及。

ray_cluster_config

RayClusterConfig object

  • 参数解释:Ray集群配置。

  • 约束限制:不涉及。

  • 取值范围:不涉及。

  • 默认取值:不涉及。

log_config

RayServiceLogConfig object

  • 参数解释:RayService日志配置。

  • 约束限制:不涉及。

  • 取值范围:不涉及。

  • 默认取值:不涉及。

data_infos

Array of DataBriefInfo objects

  • 参数解释:数据信息。

  • 约束限制:不涉及。

  • 取值范围:[0,1]。

  • 默认取值:不涉及。

表14 RayServeConfig

参数

是否必选

参数类型

描述

applications

Array of ServeApplication objects

  • 参数解释:Application。

  • 约束限制:不涉及。

  • 取值范围:[0,5]。

  • 默认取值:不涉及。

表15 ServeApplication

参数

是否必选

参数类型

描述

name

String

  • 参数解释:Application的名称。

  • 约束限制:不涉及。

  • 取值范围:长度为[1,64]的中文、字母、数字、下划线、中划线、半角句号(.)、空格的组合。

  • 默认取值:不涉及。

import_path

String

  • 参数解释:输入路径。

  • 约束限制:不涉及。

  • 取值范围:不涉及。

  • 默认取值:不涉及。

deployments

Array of Deployment objects

  • 参数解释:Deployment列表。

  • 约束限制:不涉及。

  • 取值范围:[1,5]。

  • 默认取值:不涉及。

runtime_env

ServeRuntimeEnv object

  • 参数解释:Serve的运行时环境配置。

  • 约束限制:不涉及。

  • 取值范围:可选参数有:working_dir:代码将在其中运行的工作目录。必须是远程URI,如s3或本地路径;env_vars:要设置的环境变量。

  • 默认取值:不涉及。

route_prefix

String

  • 参数解释:路由前缀。

  • 约束限制:要求在RayServe中具有唯一性,不能跟其他的Application的前缀重复

  • 取值范围:不涉及。

  • 默认取值:不涉及。

表16 Deployment

参数

是否必选

参数类型

描述

name

String

  • 参数解释:Deployment的名称。

  • 约束限制:不涉及。

  • 取值范围:长度为[1,64]的中文、字母、数字、下划线、中划线、半角句号(.)、空格的组合。

  • 默认取值:不涉及。

ray_actor_options

RayActorOptions object

  • 参数解释:RayActor配置。

  • 约束限制:不涉及。

  • 取值范围:不涉及。

  • 默认取值:不涉及。

autoscaling_config

AutoscalingConfig object

  • 参数解释:自动扩缩的配置。

  • 约束限制:不涉及。

  • 取值范围:不涉及。

  • 默认取值:不涉及。

num_replicas

Integer

  • 参数解释:副本数量。

  • 约束限制:不涉及。

  • 取值范围:[0,1000]。

  • 默认取值:不涉及。

user_config

Object

  • 参数解释:用户自定义配置。

  • 约束限制:不涉及。

  • 取值范围:不涉及。

  • 默认取值:不涉及。

max_replicas_per_node

Integer

  • 参数解释:每个节点允许的最大副本数。

  • 约束限制:不涉及。

  • 取值范围:[1,100]。

  • 默认取值:1。

max_ongoing_requests

Integer

  • 参数解释:每个副本可接受的最大并发请求数。

  • 约束限制:不涉及。

  • 取值范围:[1,100000]。

  • 默认取值:不涉及。

max_queued_requests

Integer

  • 参数解释:deployment可接受的排队的最大请求数。-1时表示无限制。

  • 约束限制:不涉及。

  • 取值范围:[-1,100000]。

  • 默认取值:不涉及。

表17 RayActorOptions

参数

是否必选

参数类型

描述

num_cpus

Double

  • 参数解释:CPU数量。

  • 约束限制:不涉及。

  • 取值范围:不涉及。

  • 默认取值:不涉及。

memory

Double

  • 参数解释:内存数量。

  • 约束限制:不涉及。

  • 取值范围:不涉及。

  • 默认取值:不涉及。

resources

String

  • 参数解释:资源配置。

  • 约束限制:不涉及。

  • 取值范围:长度[0,1024]。

  • 默认取值:不涉及。

表18 AutoscalingConfig

参数

是否必选

参数类型

描述

target_ongoing_requests

Integer

  • 参数解释:每个副本单位时间能提供的平均请求数。

  • 约束限制:不涉及。

  • 取值范围:[1,1000]。

  • 默认取值:不涉及。

min_replicas

Integer

  • 参数解释:最小副本数。

  • 约束限制:不涉及。

  • 取值范围:[0,1000]。

  • 默认取值:不涉及。

max_replicas

Integer

  • 参数解释:最大副本数。

  • 约束限制:不涉及。

  • 取值范围:[0,1000]。

  • 默认取值:不涉及。

initial_replicas

Integer

  • 参数解释:初始副本数。

  • 约束限制:不涉及。

  • 取值范围:[0,1000]。

  • 默认取值:不涉及。

upscale_delay_s

Integer

  • 参数解释:扩容之前的等待时间。

  • 约束限制:不涉及。

  • 取值范围:[0,86400]。

  • 默认取值:不涉及。

downscale_delay_s

Integer

  • 参数解释:缩容之前的等待时间。

  • 约束限制:不涉及。

  • 取值范围:[0,86400]。

  • 默认取值:不涉及。

表19 ServeRuntimeEnv

参数

是否必选

参数类型

描述

working_dir

String

  • 参数解释:代码将在其中运行的工作目录。

  • 约束限制:必须是远程URI,如s3或本地路径。

  • 取值范围:不涉及。

  • 默认取值:不涉及。

env_vars

Map<String,String>

  • 参数解释:要设置的环境变量。

  • 约束限制:不涉及。

  • 取值范围:不涉及。

  • 默认取值:不涉及。

表20 RayClusterConfig

参数

是否必选

参数类型

描述

head_group_spec

HeadGroupSpecV2 object

  • 参数解释:HeadGroup的配置。

  • 约束限制:不涉及。

  • 取值范围:不涉及。

  • 默认取值:不涉及。

worker_group_specs

Array of WorkerGroupSpecV2 objects

  • 参数解释:Worker Group的配置。

  • 约束限制:不涉及。

  • 取值范围:[1,1000]。

  • 默认取值:不涉及。

表21 HeadGroupSpecV2

参数

是否必选

参数类型

描述

limits

ResourceSpec object

  • 参数解释:资源配置。

  • 约束限制:不涉及。

  • 取值范围:不涉及。

  • 默认取值:不涉及。

requests

ResourceSpec object

  • 参数解释:资源配置。

  • 约束限制:不涉及。

  • 取值范围:不涉及。

  • 默认取值:不涉及。

表22 WorkerGroupSpecV2

参数

是否必选

参数类型

描述

name

String

  • 参数解释:名称。

  • 约束限制:不涉及。

  • 取值范围:长度[0,128]字母、数字、下划线(_)、中划线(-)的组合。

  • 默认取值:不涉及。

min_replicas

Integer

  • 参数解释:最小副本数。

  • 约束限制:不涉及。

  • 取值范围:[0,10000]。

  • 默认取值:不涉及。

max_replicas

Integer

  • 参数解释:最大副本数。

  • 约束限制:不涉及。

  • 取值范围:[1,10000]。

  • 默认取值:不涉及。

limits

ResourceSpec object

  • 参数解释:资源限制。

  • 约束限制:不涉及。

  • 取值范围:不涉及。

  • 默认取值:不涉及。

requests

ResourceSpec object

  • 参数解释:最小资源数。

  • 约束限制:不涉及。

  • 取值范围:不涉及。

  • 默认取值:不涉及。

表23 ResourceSpec

参数

是否必选

参数类型

描述

spec_code

String

  • 参数解释:资源规格。

  • 约束限制:不涉及。

  • 取值范围:从规格列表查询获取。

  • 默认取值:不涉及。

表24 RayServiceLogConfig

参数

是否必选

参数类型

描述

lts

RayServiceLogLtsConfig object

  • 参数解释:RayService日志配置。

  • 约束限制:不涉及。

  • 取值范围:不涉及。

  • 默认取值:不涉及。

表25 RayServiceLogLtsConfig

参数

是否必选

参数类型

描述

enabled

Boolean

  • 参数解释:是否开启RayService日志转储到LTS。

  • 约束限制:不涉及。

  • 取值范围:true,false。

  • 默认取值:false。

log_group_id

String

  • 参数解释:RayService日志转储到的LTS日志组id。

  • 约束限制:需要是已经存在的LTS日志组id。

  • 取值范围:不涉及。

  • 默认取值:不涉及。

log_stream_id

String

  • 参数解释:RayService日志转储到的LTS日志流id。

  • 约束限制:需要是已经存在的LTS日志流id。

  • 取值范围:不涉及。

  • 默认取值:不涉及

表26 DataBriefInfo

参数

是否必选

参数类型

描述

input_path

String

  • 参数解释:地址。

  • 约束限制:不涉及。

  • 取值范围:长度[4,1024]。

  • 默认取值:不涉及。

表27 CacheConfig

参数

是否必选

参数类型

描述

mnt_path

String

  • 参数解释:挂载路径。

  • 约束限制:不涉及。

  • 取值范围:不涉及。

  • 默认取值:不涉及。

cache_ins_id

String

  • 参数解释:分布式缓存id。

  • 约束限制:不涉及。

  • 取值范围:已创建的分布式缓存资源id。

  • 默认取值:不涉及。

响应参数

状态码:400

表28 响应Body参数

参数

参数类型

描述

error_code

String

  • 参数解释:错误码。

  • 约束限制:不涉及。

  • 取值范围:长度为[8,36]个字符。

  • 默认取值:不涉及。

error_msg

String

  • 参数解释:错误描述。

  • 约束限制:不涉及。

  • 取值范围:长度为[2,512]个字符。

  • 默认取值:不涉及。

solution_msg

String

  • 参数解释:解决方案描述。

  • 约束限制:不涉及。

  • 取值范围:长度为[0,4096]个字符。

  • 默认取值:不涉及。

状态码:401

表29 响应Body参数

参数

参数类型

描述

error_code

String

  • 参数解释:错误码。

  • 约束限制:不涉及。

  • 取值范围:长度为[8,36]个字符。

  • 默认取值:不涉及。

error_msg

String

  • 参数解释:错误描述。

  • 约束限制:不涉及。

  • 取值范围:长度为[2,512]个字符。

  • 默认取值:不涉及。

solution_msg

String

  • 参数解释:解决方案描述。

  • 约束限制:不涉及。

  • 取值范围:长度为[0,4096]个字符。

  • 默认取值:不涉及。

状态码:408

表30 响应Body参数

参数

参数类型

描述

error_code

String

  • 参数解释:错误码。

  • 约束限制:不涉及。

  • 取值范围:长度为[8,36]个字符。

  • 默认取值:不涉及。

error_msg

String

  • 参数解释:错误描述。

  • 约束限制:不涉及。

  • 取值范围:长度为[2,512]个字符。

  • 默认取值:不涉及。

solution_msg

String

  • 参数解释:解决方案描述。

  • 约束限制:不涉及。

  • 取值范围:长度为[0,4096]个字符。

  • 默认取值:不涉及。

状态码:500

表31 响应Body参数

参数

参数类型

描述

error_code

String

  • 参数解释:错误码。

  • 约束限制:不涉及。

  • 取值范围:长度为[8,36]个字符。

  • 默认取值:不涉及。

error_msg

String

  • 参数解释:错误描述。

  • 约束限制:不涉及。

  • 取值范围:长度为[2,512]个字符。

  • 默认取值:不涉及。

solution_msg

String

  • 参数解释:解决方案描述。

  • 约束限制:不涉及。

  • 取值范围:长度为[0,4096]个字符。

  • 默认取值:不涉及。

请求示例

创建端点。具体规格如样例展示。

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

{
  "name" : "endpoint1",
  "description" : "description",
  "type" : "job",
  "reserved_resource" : {
    "apu" : {
      "spec_code" : "dpu.d1x",
      "warm_up_num" : 1,
      "max_num" : 100
    },
    "dpu" : {
      "spec_code" : "dpu.d1x",
      "warm_up_num" : 4,
      "max_num" : 100
    },
    "mu" : {
      "spec_code" : "string",
      "min" : 0,
      "max" : 1
    }
  },
  "ray_resource" : {
    "head_node_resource" : {
      "spec_code" : "string"
    },
    "work_node_resources" : [ {
      "name" : "cpuGroup1",
      "resource" : {
        "spec_code" : "string",
        "min" : 0,
        "max" : 1
      }
    } ]
  },
  "cap" : {
    "cap_id" : "0b5633ba2b904511ad514346f4d23d4b",
    "version_id" : "0b5633ba2b904511ad514346f4d23d4b"
  },
  "config" : {
    "ray_service_config" : {
      "log_config" : {
        "lts" : {
          "enabled" : true,
          "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" : 1
          } ],
          "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/"
      } ]
    }
  },
  "cache_list" : [ {
    "mnt_path" : "string",
    "cache_ins_id" : "string"
  } ]
}

响应示例

状态码:202

查询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-17T01:12:24.663Z"
  },
  "runtime_env_type" : "RELEASE",
  "config" : {
    "ray_service_config" : {
      "log_config" : {
        "lts" : {
          "enabled" : true,
          "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"
}

状态码

状态码

描述

202

查询endpoint详情的响应。

400

BadRequest

401

Unauthorized

403

Forbidden

408

Request Time-out

500

InternalServerError

错误码

请参见错误码

提示

您即将访问非华为云网站,请注意账号财产安全

文档反馈

文档反馈

意见反馈

0/500

标记内容

同时提交标记内容