华为云用户手册

响应参数 状态码： 200 表4 响应Body参数 参数 参数类型 描述 total Integer 符合条件的Version总数。 versions Array of ModelVersionInfo objects 列表信息。 表5 ModelVersionInfo 参数 参数类型 描述 id String 参数解释：模型版本ID。 约束限制：系统自动生成无法修改，输入不生效。 取值范围：32~36位的英文、数字、中划线(-)组合。 默认取值：不涉及。 name String 参数解释：模型版本名称。 约束限制：只能包含中文、字母、数字、下划线、中划线、半角句号（.）、空格。 取值范围：不涉及。 默认取值：不涉及。 cap_white_list Array of strings cap白名单。 description String 参数解释：描述信息。 约束限制：不涉及。 取值范围：不涉及。 默认取值：不涉及。 config ModelConfig object 模型配置。 create_time String 参数解释：创建时间。 约束限制：不涉及。 取值范围：不涉及。 默认取值：不涉及。 create_user User object 租户信息。 表6 ModelConfig 参数 参数类型 描述 llm_model_config LlmModelConfig object Llm模型配置。 表7 LlmModelConfig 参数 参数类型 描述 base_model_type String 参数解释：基模型类型。 约束限制：不涉及。 取值范围：请从ListBaseModels列举基模型接口响应中获取。 默认取值：不涉及。 model_path String 参数解释：模型文件路径。 约束限制：合法OBS路径。 取值范围：不涉及。 默认取值：不涉及。 表8 User 参数 参数类型 描述 domain_name String 参数解释：账户名称。 约束限制：不涉及。 取值范围：不涉及。 默认取值：不涉及。 domain_id String 参数解释：账号ID。 约束限制：不涉及。 取值范围：不涉及。 默认取值：不涉及。 user_name String 参数解释：用户名称。 约束限制：不涉及。 取值范围：不涉及。 默认取值：不涉及。 user_id String 参数解释：用户ID。 约束限制：不涉及。 取值范围：不涉及。 默认取值：不涉及。 状态码： 400 表9 响应Body参数 参数 参数类型 描述 error_code String 参数解释：错误码。 约束限制：该值不可修改。 取值范围：不涉及。 默认取值：不涉及。 error_msg String 参数解释：错误描述。 约束限制：该值不可修改。 取值范围：不涉及。 默认取值：不涉及。 solution_msg String 参数解释：解决方案描述。 约束限制：该值不可修改。 取值范围：不涉及。 默认取值：不涉及。 状态码： 401 表10 响应Body参数 参数 参数类型 描述 error_code String 参数解释：错误码。 约束限制：该值不可修改。 取值范围：不涉及。 默认取值：不涉及。 error_msg String 参数解释：错误描述。 约束限制：该值不可修改。 取值范围：不涉及。 默认取值：不涉及。 solution_msg String 参数解释：解决方案描述。 约束限制：该值不可修改。 取值范围：不涉及。 默认取值：不涉及。 状态码： 404 表11 响应Body参数 参数 参数类型 描述 error_code String 参数解释：错误码。 约束限制：该值不可修改。 取值范围：不涉及。 默认取值：不涉及。 error_msg String 参数解释：错误描述。 约束限制：该值不可修改。 取值范围：不涉及。 默认取值：不涉及。 solution_msg String 参数解释：解决方案描述。 约束限制：该值不可修改。 取值范围：不涉及。 默认取值：不涉及。 状态码： 408 表12 响应Body参数 参数 参数类型 描述 error_code String 参数解释：错误码。 约束限制：该值不可修改。 取值范围：不涉及。 默认取值：不涉及。 error_msg String 参数解释：错误描述。 约束限制：该值不可修改。 取值范围：不涉及。 默认取值：不涉及。 solution_msg String 参数解释：解决方案描述。 约束限制：该值不可修改。 取值范围：不涉及。 默认取值：不涉及。 状态码： 500 表13 响应Body参数 参数 参数类型 描述 error_code String 参数解释：错误码。 约束限制：该值不可修改。 取值范围：不涉及。 默认取值：不涉及。 error_msg String 参数解释：错误描述。 约束限制：该值不可修改。 取值范围：不涉及。 默认取值：不涉及。 solution_msg String 参数解释：解决方案描述。 约束限制：该值不可修改。 取值范围：不涉及。 默认取值：不涉及。

URI GET https://localhost.com/v1/workspaces/{workspace_id}/models/{model_id}/versions 表1 路径参数 参数 是否必选 参数类型 描述 workspace_id 是 String 参数解释：工作空间ID。获取方法，请参见获取工作空间ID。 约束限制：不涉及。 取值范围：不涉及。 默认取值：不涉及。 model_id 是 String 模型ID。获取方法，请参见获取模型ID。 表2 Query参数 参数 是否必选 参数类型 描述 offset 否 Integer 参数解释：偏移量，表示从此偏移量开始查询。 约束限制：不涉及。 取值范围：offset大于等于0。 默认取值：默认为0。 limit 否 Integer 参数解释：指定每一页返回的最大条目数。 约束限制：不涉及。 取值范围：取值范围[1,100]。 默认取值：默认为10。 version_id 否 String 模型版本ID。 name 否 String 模型版本名称，支持模糊查询。

响应参数 状态码： 400 表3 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述 solution_msg String 解决方案描述 状态码： 401 表4 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述 solution_msg String 解决方案描述 状态码： 404 表5 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述 solution_msg String 解决方案描述 状态码： 408 表6 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述 solution_msg String 解决方案描述 状态码： 500 表7 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述 solution_msg String 解决方案描述

URI GET https://localhost.com/v1/workspaces/{workspace_id}/services/instances/{instance_id} 表1 路径参数 参数 是否必选 参数类型 描述 workspace_id 是 String 参数解释：Workspace的ID。 约束限制：不涉及。 取值范围：不涉及。 默认取值：不涉及。 instance_id 是 String 实例的Id。获取方法，请参见获取推理实例ID。

响应参数 状态码： 400 表24 响应Body参数 参数 参数类型 描述 error_code String 参数解释：错误码。 约束限制：该值不可修改。 取值范围：不涉及。 默认取值：不涉及。 error_msg String 参数解释：错误描述。 约束限制：该值不可修改。 取值范围：不涉及。 默认取值：不涉及。 solution_msg String 参数解释：解决方案描述。 约束限制：该值不可修改。 取值范围：不涉及。 默认取值：不涉及。 状态码： 401 表25 响应Body参数 参数 参数类型 描述 error_code String 参数解释：错误码。 约束限制：该值不可修改。 取值范围：不涉及。 默认取值：不涉及。 error_msg String 参数解释：错误描述。 约束限制：该值不可修改。 取值范围：不涉及。 默认取值：不涉及。 solution_msg String 参数解释：解决方案描述。 约束限制：该值不可修改。 取值范围：不涉及。 默认取值：不涉及。 状态码： 408 表26 响应Body参数 参数 参数类型 描述 error_code String 参数解释：错误码。 约束限制：该值不可修改。 取值范围：不涉及。 默认取值：不涉及。 error_msg String 参数解释：错误描述。 约束限制：该值不可修改。 取值范围：不涉及。 默认取值：不涉及。 solution_msg String 参数解释：解决方案描述。 约束限制：该值不可修改。 取值范围：不涉及。 默认取值：不涉及。 状态码： 500 表27 响应Body参数 参数 参数类型 描述 error_code String 参数解释：错误码。 约束限制：该值不可修改。 取值范围：不涉及。 默认取值：不涉及。 error_msg String 参数解释：错误描述。 约束限制：该值不可修改。 取值范围：不涉及。 默认取值：不涉及。 solution_msg String 参数解释：解决方案描述。 约束限制：该值不可修改。 取值范围：不涉及。 默认取值：不涉及。

URI PUT https://localhost.com/v1/workspaces/{workspace_id}/endpoints/{endpoint_id} 表1 路径参数 参数 是否必选 参数类型 描述 workspace_id 是 String 参数解释：工作空间ID。 约束限制：不涉及。 取值范围：获取方法，请参见获取工作空间ID。 默认取值：不涉及。 endpoint_id 是 String 端点ID。获取方法，请参见获取端点ID。

响应参数 状态码： 200 表4 响应Body参数 参数 参数类型 描述 total Integer 参数解释：符合条件的Endpoint总数。 约束限制：不涉及。 取值范围：不涉及。 默认取值：不涉及。 endpoints Array of EndpointBriefInfo objects 符合条件的Endpoint简要信息列表。 表5 EndpointBriefInfo 参数 参数类型 描述 visibility String 参数解释：可见性。 约束限制：不涉及。 取值范围： PRIVATE：私有 PUBLIC：公共 默认取值：PRIVATE。 id String 参数解释：Endpoint ID。 约束限制：32~36位的英文、数字、中划线(-)组合。 取值范围：不涉及。 默认取值：不涉及。 name String 参数解释：Endpoint名称。 约束限制：只能包含中文、字母、数字、下划线、中划线、半角句号（.）、空格。 取值范围：不涉及。 默认取值：不涉及。 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请求资源组。 默认取值：不涉及。 status String 参数解释：Endpoint状态。 约束限制：不涉及。 取值范围： CREATING：创建中； RUNNING：运行中； CREATE_FAILED：创建失败； DELETING：删除中； DELETED：已删除； UPDATING: 更新中； UPDATE_FAILED：升级失败； DELETE_FAILED：创建失败； FROZEN：冻结； INACTIVE：未开通（公共EP）； TRIAL_ENDED：试用结束。 默认取值：不涉及。 description String 参数解释：描述信息。 约束限制：不涉及。 取值范围：不涉及。 默认取值：不涉及。 create_time String 参数解释：创建时间。 约束限制：不涉及。 取值范围：不涉及。 默认取值：不涉及。 update_time String 参数解释：更新时间。 约束限制：不涉及。 取值范围：不涉及。 默认取值：不涉及。 owner User object 租户信息。 cap CapRef object CAP信息。 reserved_resource ReservedResource object 通用预留资源。 ray_resource RayResourceInfo object Ray资源配置。 error_code String 参数解释：失败状态时的错误编码。 约束限制：不涉及。 取值范围：不涉及。 默认取值：不涉及。 error_msg String 参数解释：失败状态时的错误信息。 约束限制：不涉及。 取值范围：不涉及。 默认取值：不涉及。 表6 User 参数 参数类型 描述 domain_name String 参数解释：账户名称。 约束限制：不涉及。 取值范围：不涉及。 默认取值：不涉及。 domain_id String 参数解释：账号ID。 约束限制：不涉及。 取值范围：不涉及。 默认取值：不涉及。 user_name String 参数解释：用户名称。 约束限制：不涉及。 取值范围：不涉及。 默认取值：不涉及。 user_id String 参数解释：用户ID。 约束限制：不涉及。 取值范围：不涉及。 默认取值：不涉及。 表7 CapRef 参数 参数类型 描述 cap_id String 参数解释：CapId。 约束限制：32~36位的英文、数字、中划线(-)组合。 取值范围：不涉及。 默认取值：不涉及。 version_id String 参数解释：CapVersionId。 约束限制：32~36位的英文、数字、中划线(-)组合。 取值范围：不涉及。 默认取值：不涉及。 表8 ReservedResource 参数 参数类型 描述 apu ResourceDef object 资源定义信息。 dpu ResourceDef object 资源定义信息。 mu ResourceDemand object 资源需求量配置。 表9 ResourceDef 参数 参数类型 描述 spec_code String 参数解释：Endpoint状态。 约束限制：资源规格编码，从查询规格列表ListSpecs接口获取。 取值范围：不涉及。 默认取值：不涉及。 warm_up_num Integer 预热资源量。 max_num Integer 最大资源量，不填默认为预热资源量，即不使用弹性资源。 表10 ResourceDemand 参数 参数类型 描述 spec_code String 参数解释：资源规格。 约束限制：不涉及。 取值范围：从规格列表查询获取。 默认取值：不涉及。 min Integer 最小数。 max Integer 最大数。 表11 RayResourceInfo 参数 参数类型 描述 head_group_spec HeadGroupSpec object Ray Head配置。 worker_group_spec Array of WorkerGroupSpec objects Ray worker group配置。 表12 HeadGroupSpec 参数 参数类型 描述 spec_code String 参数解释：资源规格。 约束限制：不涉及。 取值范围：从规格列表查询获取。 默认取值：不涉及。 表13 WorkerGroupSpec 参数 参数类型 描述 name String 参数解释：名称。 约束限制：不涉及。 取值范围：不涉及。 默认取值：不涉及。 spec_code String 参数解释：资源规格。 约束限制：不涉及。 取值范围：从规格列表查询获取。 默认取值：不涉及。 min_replicas Integer 最小副本数。 max_replicas Integer 最大副本数。 状态码： 400 表14 响应Body参数 参数 参数类型 描述 error_code String 参数解释：错误码。 约束限制：该值不可修改。 取值范围：不涉及。 默认取值：不涉及。 error_msg String 参数解释：错误描述。 约束限制：该值不可修改。 取值范围：不涉及。 默认取值：不涉及。 solution_msg String 参数解释：解决方案描述。 约束限制：该值不可修改。 取值范围：不涉及。 默认取值：不涉及。 状态码： 401 表15 响应Body参数 参数 参数类型 描述 error_code String 参数解释：错误码。 约束限制：该值不可修改。 取值范围：不涉及。 默认取值：不涉及。 error_msg String 参数解释：错误描述。 约束限制：该值不可修改。 取值范围：不涉及。 默认取值：不涉及。 solution_msg String 参数解释：解决方案描述。 约束限制：该值不可修改。 取值范围：不涉及。 默认取值：不涉及。 状态码： 408 表16 响应Body参数 参数 参数类型 描述 error_code String 参数解释：错误码。 约束限制：该值不可修改。 取值范围：不涉及。 默认取值：不涉及。 error_msg String 参数解释：错误描述。 约束限制：该值不可修改。 取值范围：不涉及。 默认取值：不涉及。 solution_msg String 参数解释：解决方案描述。 约束限制：该值不可修改。 取值范围：不涉及。 默认取值：不涉及。 状态码： 500 表17 响应Body参数 参数 参数类型 描述 error_code String 参数解释：错误码。 约束限制：该值不可修改。 取值范围：不涉及。 默认取值：不涉及。 error_msg String 参数解释：错误描述。 约束限制：该值不可修改。 取值范围：不涉及。 默认取值：不涉及。 solution_msg String 参数解释：解决方案描述。 约束限制：该值不可修改。 取值范围：不涉及。 默认取值：不涉及。

URI GET https://localhost.com/v1/workspaces/{workspace_id}/endpoints 表1 路径参数 参数 是否必选 参数类型 描述 workspace_id 是 String 参数解释：工作空间ID。 约束限制：不涉及。 取值范围：获取方法，请参见获取工作空间ID。 默认取值：不涉及。 表2 Query参数 参数 是否必选 参数类型 描述 offset 否 Integer 参数解释：偏移量，表示从此偏移量开始查询。 约束限制：不涉及。 取值范围：offset大于等于0。 默认取值：默认为0。 limit 否 Integer 参数解释：指定每一页返回的最大条目数。 约束限制：不涉及。 取值范围：取值范围[1,100]。 默认取值：默认为10。 model_id 否 String 通过模型ID检索，32~36位的英文、数字、中划线(-)组合。 name 否 String 参数解释：Endpoint名称，通过名字搜索Endpoint的参数。 约束限制：不涉及。 取值范围：只能包含中文、字母、数字、下划线、中划线，支持模糊查询。 默认取值：不涉及。 endpoint_id 否 String 通过端点ID检索Endpoint的参数。获取方法，请参见获取端点ID。 type 否 Object 参数解释：Endpoint的类型。 约束限制：不涉及。 取值范围： service：Service EP，代表一个可接收Service请求资源组； ray：RayCluter on k8s的EP，代表一个Ray集群； inference：推理的EP，代表一个推理函数实例； job：Job EP，代表一个可接收Job请求资源组； ray_service：RayService on k8s的EP，代表一个RayService。 sql：SQL EP，代表一个可接收SQL请求资源组。 默认取值：不涉及。 visibility 否 String 可见性检索的参数，可选值为： PRIVATE: 私有，用户自己创建的； PUBLIC：公共，查询所有公共的，包括其他用户创建的； ALL: 所有的； 默认为空，不填表示不限制，则查出当前用户下的，包括PRIVATE和PUBLIC，不包括其他用户创建的。

响应参数 状态码： 200 表4 响应Body参数 参数 参数类型 描述 total Integer 符合条件的 消息通知 策略总数。 policies Array of MessageNotificationPolicy objects 消息通知策略列表信息。 表5 MessageNotificationPolicy 参数 参数类型 描述 id String 参数解释：消息通知策略ID。 约束限制：不涉及。 取值范围：不涉及。 默认取值：不涉及。 message_type String 参数解释：消息类型。 约束限制：不涉及。 取值范围： job：任务执行结果。 默认取值：job。 name_pattern String 参数解释：名称样式，用来匹配消息类型中所有符合该样式的消息。 约束限制：例如：message_type设置为job，name_pattern设置为ray_job*，表示匹配到所有以"ray_job"开头的job发出的消息。 取值范围：不涉及。 默认取值：不涉及。 notification_types Array of strings 通知类型。SUC CES S:成功通知；FAILED：失败通知。 topic_urn String 参数解释：消息通知主题。 约束限制：不涉及。 取值范围：不涉及。 默认取值：不涉及。 状态码： 400 表6 响应Body参数 参数 参数类型 描述 error_code String 参数解释：错误码。 约束限制：该值不可修改。 取值范围：不涉及。 默认取值：不涉及。 error_msg String 参数解释：错误描述。 约束限制：该值不可修改。 取值范围：不涉及。 默认取值：不涉及。 solution_msg String 参数解释：解决方案描述。 约束限制：该值不可修改。 取值范围：不涉及。 默认取值：不涉及。 状态码： 401 表7 响应Body参数 参数 参数类型 描述 error_code String 参数解释：错误码。 约束限制：该值不可修改。 取值范围：不涉及。 默认取值：不涉及。 error_msg String 参数解释：错误描述。 约束限制：该值不可修改。 取值范围：不涉及。 默认取值：不涉及。 solution_msg String 参数解释：解决方案描述。 约束限制：该值不可修改。 取值范围：不涉及。 默认取值：不涉及。 状态码： 404 表8 响应Body参数 参数 参数类型 描述 error_code String 参数解释：错误码。 约束限制：该值不可修改。 取值范围：不涉及。 默认取值：不涉及。 error_msg String 参数解释：错误描述。 约束限制：该值不可修改。 取值范围：不涉及。 默认取值：不涉及。 solution_msg String 参数解释：解决方案描述。 约束限制：该值不可修改。 取值范围：不涉及。 默认取值：不涉及。 状态码： 408 表9 响应Body参数 参数 参数类型 描述 error_code String 参数解释：错误码。 约束限制：该值不可修改。 取值范围：不涉及。 默认取值：不涉及。 error_msg String 参数解释：错误描述。 约束限制：该值不可修改。 取值范围：不涉及。 默认取值：不涉及。 solution_msg String 参数解释：解决方案描述。 约束限制：该值不可修改。 取值范围：不涉及。 默认取值：不涉及。 状态码： 500 表10 响应Body参数 参数 参数类型 描述 error_code String 参数解释：错误码。 约束限制：该值不可修改。 取值范围：不涉及。 默认取值：不涉及。 error_msg String 参数解释：错误描述。 约束限制：该值不可修改。 取值范围：不涉及。 默认取值：不涉及。 solution_msg String 参数解释：解决方案描述。 约束限制：该值不可修改。 取值范围：不涉及。 默认取值：不涉及。

URI GET https://localhost.com/v1/workspaces/{workspace_id}/messages 表1 路径参数 参数 是否必选 参数类型 描述 workspace_id 是 String 参数解释：工作空间ID。 约束限制：不涉及。 取值范围：获取方法，请参见获取工作空间ID。 默认取值：不涉及。 表2 Query参数 参数 是否必选 参数类型 描述 offset 否 Integer 参数解释：偏移量，表示从此偏移量开始查询。 约束限制：不涉及。 取值范围：offset大于等于0。 默认取值：默认为0。 limit 否 Integer 参数解释：指定每一页返回的最大条目数。 约束限制：不涉及。 取值范围：取值范围[1,100]。 默认取值：默认为10。 message_type 否 String 参数解释：消息类型。 约束限制：不可修改。 取值范围： job：任务执行结果消息。 默认取值：不涉及。 name_pattern 否 String 参数解释：名称样式。 约束限制：支持模糊匹配，区分大小写。 取值范围：不涉及。 默认取值：不涉及。 notify_type 否 String 参数解释：消息类型。 约束限制：不涉及。 取值范围： SUCCESS:成功通知； FAILED：失败通知。 默认取值：不涉及。

响应参数 状态码： 200 表4 响应Body参数 参数 参数类型 描述 total Integer 符合条件的总数。 models Array of ModelInfo objects 列表信息。 表5 ModelInfo 参数 参数类型 描述 visibility String 参数解释：可见性。 约束限制：不涉及。 取值范围： PRIVATE：私有 PUBLIC：公共 默认取值：PRIVATE。 id String 参数解释：模型ID。 约束限制：获取方法，请参见获取模型ID。 取值范围：32~36位的英文、数字、中划线(-)组合。 默认取值：不涉及。 name String 参数解释：一个Model的名称。 约束限制：不涉及。 取值范围：只能包含中文、字母、数字、下划线、中划线、半角句号（.）、空格。 默认取值：不涉及。 description String 参数解释：描述信息。 约束限制：不涉及。 取值范围：不涉及。 默认取值：不涉及。 type String 参数解释：模型的类型。 约束限制：不涉及。 取值范围： LLM_MODEL：大语言模型。 默认取值：不涉及。 create_time String 参数解释：创建时间。 约束限制：不涉及。 取值范围：不涉及。 默认取值：不涉及。 update_time String 参数解释：更新时间。 约束限制：不涉及。 取值范围：不涉及。 默认取值：不涉及。 current_version ModelVersionInfo object Model Version详情信息。 create_user User object 租户信息。 update_user User object 租户信息。 表6 ModelVersionInfo 参数 参数类型 描述 id String 参数解释：模型版本ID。 约束限制：系统自动生成无法修改，输入不生效。 取值范围：32~36位的英文、数字、中划线(-)组合。 默认取值：不涉及。 name String 参数解释：模型版本名称。 约束限制：只能包含中文、字母、数字、下划线、中划线、半角句号（.）、空格。 取值范围：不涉及。 默认取值：不涉及。 cap_white_list Array of strings cap白名单。 description String 参数解释：描述信息。 约束限制：不涉及。 取值范围：不涉及。 默认取值：不涉及。 config ModelConfig object 模型配置。 create_time String 参数解释：创建时间。 约束限制：不涉及。 取值范围：不涉及。 默认取值：不涉及。 create_user User object 租户信息。 表7 ModelConfig 参数 参数类型 描述 llm_model_config LlmModelConfig object Llm模型配置。 表8 LlmModelConfig 参数 参数类型 描述 base_model_type String 参数解释：基模型类型。 约束限制：不涉及。 取值范围：请从ListBaseModels列举基模型接口响应中获取。 默认取值：不涉及。 model_path String 参数解释：模型文件路径。 约束限制：合法OBS路径。 取值范围：不涉及。 默认取值：不涉及。 表9 User 参数 参数类型 描述 domain_name String 参数解释：账户名称。 约束限制：不涉及。 取值范围：不涉及。 默认取值：不涉及。 domain_id String 参数解释：账号ID。 约束限制：不涉及。 取值范围：不涉及。 默认取值：不涉及。 user_name String 参数解释：用户名称。 约束限制：不涉及。 取值范围：不涉及。 默认取值：不涉及。 user_id String 参数解释：用户ID。 约束限制：不涉及。 取值范围：不涉及。 默认取值：不涉及。 状态码： 400 表10 响应Body参数 参数 参数类型 描述 error_code String 参数解释：错误码。 约束限制：该值不可修改。 取值范围：不涉及。 默认取值：不涉及。 error_msg String 参数解释：错误描述。 约束限制：该值不可修改。 取值范围：不涉及。 默认取值：不涉及。 solution_msg String 参数解释：解决方案描述。 约束限制：该值不可修改。 取值范围：不涉及。 默认取值：不涉及。 状态码： 401 表11 响应Body参数 参数 参数类型 描述 error_code String 参数解释：错误码。 约束限制：该值不可修改。 取值范围：不涉及。 默认取值：不涉及。 error_msg String 参数解释：错误描述。 约束限制：该值不可修改。 取值范围：不涉及。 默认取值：不涉及。 solution_msg String 参数解释：解决方案描述。 约束限制：该值不可修改。 取值范围：不涉及。 默认取值：不涉及。 状态码： 404 表12 响应Body参数 参数 参数类型 描述 error_code String 参数解释：错误码。 约束限制：该值不可修改。 取值范围：不涉及。 默认取值：不涉及。 error_msg String 参数解释：错误描述。 约束限制：该值不可修改。 取值范围：不涉及。 默认取值：不涉及。 solution_msg String 参数解释：解决方案描述。 约束限制：该值不可修改。 取值范围：不涉及。 默认取值：不涉及。 状态码： 408 表13 响应Body参数 参数 参数类型 描述 error_code String 参数解释：错误码。 约束限制：该值不可修改。 取值范围：不涉及。 默认取值：不涉及。 error_msg String 参数解释：错误描述。 约束限制：该值不可修改。 取值范围：不涉及。 默认取值：不涉及。 solution_msg String 参数解释：解决方案描述。 约束限制：该值不可修改。 取值范围：不涉及。 默认取值：不涉及。 状态码： 500 表14 响应Body参数 参数 参数类型 描述 error_code String 参数解释：错误码。 约束限制：该值不可修改。 取值范围：不涉及。 默认取值：不涉及。 error_msg String 参数解释：错误描述。 约束限制：该值不可修改。 取值范围：不涉及。 默认取值：不涉及。 solution_msg String 参数解释：解决方案描述。 约束限制：该值不可修改。 取值范围：不涉及。 默认取值：不涉及。

URI GET https://localhost.com/v1/workspaces/{workspace_id}/models 表1 路径参数 参数 是否必选 参数类型 描述 workspace_id 是 String 参数解释：工作空间ID。获取方法，请参见获取工作空间ID。 约束限制：不涉及。 取值范围：不涉及。 默认取值：不涉及。 表2 Query参数 参数 是否必选 参数类型 描述 offset 否 Integer 参数解释：偏移量，表示从此偏移量开始查询。 约束限制：不涉及。 取值范围：offset大于等于0。 默认取值：默认为0。 limit 否 Integer 参数解释：指定每一页返回的最大条目数。 约束限制：不涉及。 取值范围：取值范围[1,100]。 默认取值：默认为10。 name 否 String 通过名字搜索Model，支持模糊查询。 id 否 String 通过模型ID检索，32~36位的英文、数字、中划线(-)组合。获取方法，请参见获取模型ID。 type 否 String 通过模型类型检索。 visibility 否 String 可见性检索的参数，可选值为： PRIVATE: 私有，用户自己创建的； PUBLIC：公共，查询所有公共的，包括其他用户创建的； ALL: 所有的； 默认为空，不填表示不限制，则查出当前用户下的，包括PRIVATE和PUBLIC，不包括其他用户创建的。 sort_by 否 String 指定排序字段，可选值为： CREATE_TIME：创建时间，默认值 UPDATE_TIME：更新时间 NAME: 服务名称 order_by 否 String 排序方式，可选值如下： ASC : 递增排序 DESC: 递减排序，默认值

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 否 String 参数解释：租户Token。获取方法，请参见认证鉴权。 约束限制：不涉及。 取值范围：不涉及。 默认取值：不涉及。 表3 请求Body参数 参数 是否必选 参数类型 描述 message_notification_policy_list 是 Array of CreateMessageNotificationPolicy objects 消息通知策略。 表4 CreateMessageNotificationPolicy 参数 是否必选 参数类型 描述 message_type 是 String 参数解释：消息类型。 约束限制：不涉及。 取值范围： job：任务执行结果。 默认取值：job。 name_pattern 是 String 参数解释：名称样式，用来匹配消息类型中所有符合该样式的消息。 约束限制：例如：message_type设置为job，name_pattern设置为ray_job*，表示匹配到所有以"ray_job"开头的job发出的消息。 取值范围：不涉及。 默认取值：不涉及。 notification_types 是 Array of strings 通知类型。SUCCESS:成功通知；FAILED：失败通知。 topic_urn 是 String 参数解释：消息通知主题。 约束限制：不涉及。 取值范围：不涉及。 默认取值：不涉及。

响应参数 状态码： 200 表5 响应Body参数 参数 参数类型 描述 id String 参数解释：消息通知策略ID。 约束限制：不涉及。 取值范围：不涉及。 默认取值：不涉及。 message_type String 参数解释：消息类型。 约束限制：不涉及。 取值范围： job：任务执行结果。 默认取值：job。 name_pattern String 参数解释：名称样式，用来匹配消息类型中所有符合该样式的消息。 约束限制：例如：message_type设置为job，name_pattern设置为ray_job*，表示匹配到所有以"ray_job"开头的job发出的消息。 取值范围：不涉及。 默认取值：不涉及。 notification_types Array of strings 通知类型。SUCCESS:成功通知；FAILED：失败通知。 topic_urn String 参数解释：消息通知主题。 约束限制：不涉及。 取值范围：不涉及。 默认取值：不涉及。 状态码： 400 表6 响应Body参数 参数 参数类型 描述 error_code String 参数解释：错误码。 约束限制：该值不可修改。 取值范围：不涉及。 默认取值：不涉及。 error_msg String 参数解释：错误描述。 约束限制：该值不可修改。 取值范围：不涉及。 默认取值：不涉及。 solution_msg String 参数解释：解决方案描述。 约束限制：该值不可修改。 取值范围：不涉及。 默认取值：不涉及。 状态码： 401 表7 响应Body参数 参数 参数类型 描述 error_code String 参数解释：错误码。 约束限制：该值不可修改。 取值范围：不涉及。 默认取值：不涉及。 error_msg String 参数解释：错误描述。 约束限制：该值不可修改。 取值范围：不涉及。 默认取值：不涉及。 solution_msg String 参数解释：解决方案描述。 约束限制：该值不可修改。 取值范围：不涉及。 默认取值：不涉及。 状态码： 404 表8 响应Body参数 参数 参数类型 描述 error_code String 参数解释：错误码。 约束限制：该值不可修改。 取值范围：不涉及。 默认取值：不涉及。 error_msg String 参数解释：错误描述。 约束限制：该值不可修改。 取值范围：不涉及。 默认取值：不涉及。 solution_msg String 参数解释：解决方案描述。 约束限制：该值不可修改。 取值范围：不涉及。 默认取值：不涉及。 状态码： 408 表9 响应Body参数 参数 参数类型 描述 error_code String 参数解释：错误码。 约束限制：该值不可修改。 取值范围：不涉及。 默认取值：不涉及。 error_msg String 参数解释：错误描述。 约束限制：该值不可修改。 取值范围：不涉及。 默认取值：不涉及。 solution_msg String 参数解释：解决方案描述。 约束限制：该值不可修改。 取值范围：不涉及。 默认取值：不涉及。 状态码： 500 表10 响应Body参数 参数 参数类型 描述 error_code String 参数解释：错误码。 约束限制：该值不可修改。 取值范围：不涉及。 默认取值：不涉及。 error_msg String 参数解释：错误描述。 约束限制：该值不可修改。 取值范围：不涉及。 默认取值：不涉及。 solution_msg String 参数解释：解决方案描述。 约束限制：该值不可修改。 取值范围：不涉及。 默认取值：不涉及。

URI DELETE https://localhost.com/v1/workspaces/{workspace_id}/services/instances/{instance_id} 表1 路径参数 参数 是否必选 参数类型 描述 workspace_id 是 String 参数解释：Workspace的ID。 约束限制：不涉及。 取值范围：不涉及。 默认取值：不涉及。 instance_id 是 String 实例的Id。获取方法，请参见获取推理实例ID。

响应参数 状态码： 202 表3 响应Body参数 参数 参数类型 描述 - AnyType 删除Service的响应 状态码： 400 表4 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述 solution_msg String 解决方案描述 状态码： 401 表5 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述 solution_msg String 解决方案描述 状态码： 404 表6 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述 solution_msg String 解决方案描述 状态码： 408 表7 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述 solution_msg String 解决方案描述 状态码： 500 表8 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述 solution_msg String 解决方案描述

响应参数 状态码： 200 表2 响应Body参数 参数 参数类型 描述 agreement_rules Array of AgreementRule objects 系统协议列表。 表3 AgreementRule 参数 参数类型 描述 agreement_name String 参数解释：协议名称。 约束限制：不涉及。 取值范围：不涉及。 默认取值：不涉及。 agreement_display_name String 参数解释：协议展示名称。 约束限制：不涉及。 取值范围：不涉及。 默认取值：不涉及。 agreement_version String 参数解释：协议版本。 约束限制：不涉及。 取值范围：不涉及。 默认取值：不涉及。 agreement_url String 参数解释：协议链接。 约束限制：不涉及。 取值范围：不涉及。 默认取值：不涉及。 状态码： 400 表4 响应Body参数 参数 参数类型 描述 error_code String 参数解释：错误码。 约束限制：该值不可修改。 取值范围：不涉及。 默认取值：不涉及。 error_msg String 参数解释：错误描述。 约束限制：该值不可修改。 取值范围：不涉及。 默认取值：不涉及。 solution_msg String 参数解释：解决方案描述。 约束限制：该值不可修改。 取值范围：不涉及。 默认取值：不涉及。 状态码： 401 表5 响应Body参数 参数 参数类型 描述 error_code String 参数解释：错误码。 约束限制：该值不可修改。 取值范围：不涉及。 默认取值：不涉及。 error_msg String 参数解释：错误描述。 约束限制：该值不可修改。 取值范围：不涉及。 默认取值：不涉及。 solution_msg String 参数解释：解决方案描述。 约束限制：该值不可修改。 取值范围：不涉及。 默认取值：不涉及。 状态码： 404 表6 响应Body参数 参数 参数类型 描述 error_code String 参数解释：错误码。 约束限制：该值不可修改。 取值范围：不涉及。 默认取值：不涉及。 error_msg String 参数解释：错误描述。 约束限制：该值不可修改。 取值范围：不涉及。 默认取值：不涉及。 solution_msg String 参数解释：解决方案描述。 约束限制：该值不可修改。 取值范围：不涉及。 默认取值：不涉及。 状态码： 408 表7 响应Body参数 参数 参数类型 描述 error_code String 参数解释：错误码。 约束限制：该值不可修改。 取值范围：不涉及。 默认取值：不涉及。 error_msg String 参数解释：错误描述。 约束限制：该值不可修改。 取值范围：不涉及。 默认取值：不涉及。 solution_msg String 参数解释：解决方案描述。 约束限制：该值不可修改。 取值范围：不涉及。 默认取值：不涉及。 状态码： 500 表8 响应Body参数 参数 参数类型 描述 error_code String 参数解释：错误码。 约束限制：该值不可修改。 取值范围：不涉及。 默认取值：不涉及。 error_msg String 参数解释：错误描述。 约束限制：该值不可修改。 取值范围：不涉及。 默认取值：不涉及。 solution_msg String 参数解释：解决方案描述。 约束限制：该值不可修改。 取值范围：不涉及。 默认取值：不涉及。

响应参数 状态码： 200 表3 响应Body参数 参数 参数类型 描述 session_id String session的id 状态码： 400 表4 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述 solution_msg String 解决方案描述 状态码： 401 表5 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述 solution_msg String 解决方案描述 状态码： 404 表6 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述 solution_msg String 解决方案描述 状态码： 408 表7 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述 solution_msg String 解决方案描述 状态码： 500 表8 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述 solution_msg String 解决方案描述

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 否 String 参数解释：租户Token。获取方法，请参见认证鉴权。 约束限制：不涉及。 取值范围：不涉及。 默认取值：不涉及。 表3 请求Body参数 参数 是否必选 参数类型 描述 name 是 String 参数解释：一个Model的名称。 约束限制：不涉及。 取值范围：只能包含中文、字母、数字、下划线、中划线、半角句号（.）、空格。 默认取值：不涉及。 description 否 String 参数解释：描述信息。 约束限制：不涉及。 取值范围：不涉及。 默认取值：不涉及。 type 是 String 参数解释：模型的类型。 约束限制：不涉及。 取值范围： LLM_MODEL：大语言模型。 默认取值：不涉及。 version 是 ModelVersionInput object 每个版本的详细信息。 表4 ModelVersionInput 参数 是否必选 参数类型 描述 name 是 String 参数解释：模型版本名称。 约束限制：只能包含中文、字母、数字、下划线、中划线、半角句号（.）、空格。 取值范围：不涉及。 默认取值：不涉及。 description 否 String 参数解释：描述信息。 约束限制：不涉及。 取值范围：不涉及。 默认取值：不涉及。 config 否 ModelConfig object 模型配置。 表5 ModelConfig 参数 是否必选 参数类型 描述 llm_model_config 否 LlmModelConfig object Llm模型配置。 表6 LlmModelConfig 参数 是否必选 参数类型 描述 base_model_type 是 String 参数解释：基模型类型。 约束限制：不涉及。 取值范围：请从ListBaseModels列举基模型接口响应中获取。 默认取值：不涉及。 model_path 是 String 参数解释：模型文件路径。 约束限制：合法OBS路径。 取值范围：不涉及。 默认取值：不涉及。

响应参数 状态码： 200 表7 响应Body参数 参数 参数类型 描述 id String 参数解释：模型ID。 约束限制：获取方法，请参见获取模型ID。 取值范围：32~36位的英文、数字、中划线(-)组合。 默认取值：不涉及。 version_id String 参数解释：模型版本ID。 约束限制：系统自动生成无法修改，输入不生效。 取值范围：32~36位的英文、数字、中划线(-)组合。 默认取值：不涉及。 状态码： 400 表8 响应Body参数 参数 参数类型 描述 error_code String 参数解释：错误码。 约束限制：该值不可修改。 取值范围：不涉及。 默认取值：不涉及。 error_msg String 参数解释：错误描述。 约束限制：该值不可修改。 取值范围：不涉及。 默认取值：不涉及。 solution_msg String 参数解释：解决方案描述。 约束限制：该值不可修改。 取值范围：不涉及。 默认取值：不涉及。 状态码： 401 表9 响应Body参数 参数 参数类型 描述 error_code String 参数解释：错误码。 约束限制：该值不可修改。 取值范围：不涉及。 默认取值：不涉及。 error_msg String 参数解释：错误描述。 约束限制：该值不可修改。 取值范围：不涉及。 默认取值：不涉及。 solution_msg String 参数解释：解决方案描述。 约束限制：该值不可修改。 取值范围：不涉及。 默认取值：不涉及。 状态码： 404 表10 响应Body参数 参数 参数类型 描述 error_code String 参数解释：错误码。 约束限制：该值不可修改。 取值范围：不涉及。 默认取值：不涉及。 error_msg String 参数解释：错误描述。 约束限制：该值不可修改。 取值范围：不涉及。 默认取值：不涉及。 solution_msg String 参数解释：解决方案描述。 约束限制：该值不可修改。 取值范围：不涉及。 默认取值：不涉及。 状态码： 408 表11 响应Body参数 参数 参数类型 描述 error_code String 参数解释：错误码。 约束限制：该值不可修改。 取值范围：不涉及。 默认取值：不涉及。 error_msg String 参数解释：错误描述。 约束限制：该值不可修改。 取值范围：不涉及。 默认取值：不涉及。 solution_msg String 参数解释：解决方案描述。 约束限制：该值不可修改。 取值范围：不涉及。 默认取值：不涉及。 状态码： 500 表12 响应Body参数 参数 参数类型 描述 error_code String 参数解释：错误码。 约束限制：该值不可修改。 取值范围：不涉及。 默认取值：不涉及。 error_msg String 参数解释：错误描述。 约束限制：该值不可修改。 取值范围：不涉及。 默认取值：不涉及。 solution_msg String 参数解释：解决方案描述。 约束限制：该值不可修改。 取值范围：不涉及。 默认取值：不涉及。

响应参数 状态码： 400 表4 响应Body参数 参数 参数类型 描述 error_code String 参数解释：错误码。 约束限制：该值不可修改。 取值范围：不涉及。 默认取值：不涉及。 error_msg String 参数解释：错误描述。 约束限制：该值不可修改。 取值范围：不涉及。 默认取值：不涉及。 solution_msg String 参数解释：解决方案描述。 约束限制：该值不可修改。 取值范围：不涉及。 默认取值：不涉及。 状态码： 401 表5 响应Body参数 参数 参数类型 描述 error_code String 参数解释：错误码。 约束限制：该值不可修改。 取值范围：不涉及。 默认取值：不涉及。 error_msg String 参数解释：错误描述。 约束限制：该值不可修改。 取值范围：不涉及。 默认取值：不涉及。 solution_msg String 参数解释：解决方案描述。 约束限制：该值不可修改。 取值范围：不涉及。 默认取值：不涉及。 状态码： 408 表6 响应Body参数 参数 参数类型 描述 error_code String 参数解释：错误码。 约束限制：该值不可修改。 取值范围：不涉及。 默认取值：不涉及。 error_msg String 参数解释：错误描述。 约束限制：该值不可修改。 取值范围：不涉及。 默认取值：不涉及。 solution_msg String 参数解释：解决方案描述。 约束限制：该值不可修改。 取值范围：不涉及。 默认取值：不涉及。 状态码： 500 表7 响应Body参数 参数 参数类型 描述 error_code String 参数解释：错误码。 约束限制：该值不可修改。 取值范围：不涉及。 默认取值：不涉及。 error_msg String 参数解释：错误描述。 约束限制：该值不可修改。 取值范围：不涉及。 默认取值：不涉及。 solution_msg String 参数解释：解决方案描述。 约束限制：该值不可修改。 取值范围：不涉及。 默认取值：不涉及。

URI GET https://localhost.com/v1/workspaces/{workspace_id}/endpoints/{endpoint_id} 表1 路径参数 参数 是否必选 参数类型 描述 workspace_id 是 String 参数解释：工作空间ID。 约束限制：不涉及。 取值范围：获取方法，请参见获取工作空间ID。 默认取值：不涉及。 endpoint_id 是 String 端点ID。获取方法，请参见获取端点ID。 表2 Query参数 参数 是否必选 参数类型 描述 version 否 String 参数解释：查询Endpoint信息的版本。 约束限制：不涉及。 取值范围： CURRENT：当前版本； PREVIOUS：上个版本。 默认取值：不涉及。

URI GET https://localhost.com/v1/agency 表1 Query参数 参数 是否必选 参数类型 描述 policy_type 否 String 参数解释：策略类型。 约束限制：支持模糊匹配。 取值范围： FABRIC_COMMON_POLICY：基础通用服务相关权限策略，是委托必需的权限策略； FABRIC_SELF_POLICY：访问自身服务所需要的权限策略； FABRIC_ SMN _POLICY：消息通知功能相关权限策略，用来将系统通知消息转发到SMN； FABRIC_LAKEFORMATION_POLICY：LakeFormation功能相关权限策略； FABRIC_ AOM _POLICY：AOM功能相关权限策略。 FABRIC_SWR_POLICY：镜像包注册功能相关权限策略。 默认取值：不涉及。

响应参数 状态码： 200 表3 响应Body参数 参数 参数类型 描述 agency_name String 参数解释：委托名称。 约束限制：不涉及。 取值范围：不涉及。 默认取值：不涉及。 authorized Boolean 授权与否。如果用户的服务委托权限包含系统所需要的委托权限返回true，否则返回false。 agency_policies Array of AgencyPolicy objects 委托策略列表。 表4 AgencyPolicy 参数 参数类型 描述 policy_type String 参数解释：权限类型列表；使用Fabric的功能，可能需要授权一些权限策略，可以在policy_types中加入策略类型来授权权限。 约束限制：不涉及。 取值范围： FABRIC_COMMON_POLICY：基础通用服务相关权限策略，是委托必需的权限策略； FABRIC_SELF_POLICY：访问自身服务所需要的权限策略； FABRIC_SMN_POLICY：消息通知功能相关权限策略，用来将系统通知消息转发到SMN； FABRIC_LAKEFORMATION_POLICY：LakeFormation功能相关权限策略； FABRIC_AOM_POLICY：AOM功能相关权限策略。 FABRIC_SWR_POLICY：镜像包注册功能相关权限策略。 默认取值：不涉及。 is_required Boolean 是否是必需的。 is_enable Boolean 是否已开启。 actions Array of strings 权限列表。 description String 参数解释：策略描述。 约束限制：不涉及。 取值范围：不涉及。 默认取值：不涉及。 状态码： 400 表5 响应Body参数 参数 参数类型 描述 error_code String 参数解释：错误码。 约束限制：该值不可修改。 取值范围：不涉及。 默认取值：不涉及。 error_msg String 参数解释：错误描述。 约束限制：该值不可修改。 取值范围：不涉及。 默认取值：不涉及。 solution_msg String 参数解释：解决方案描述。 约束限制：该值不可修改。 取值范围：不涉及。 默认取值：不涉及。 状态码： 401 表6 响应Body参数 参数 参数类型 描述 error_code String 参数解释：错误码。 约束限制：该值不可修改。 取值范围：不涉及。 默认取值：不涉及。 error_msg String 参数解释：错误描述。 约束限制：该值不可修改。 取值范围：不涉及。 默认取值：不涉及。 solution_msg String 参数解释：解决方案描述。 约束限制：该值不可修改。 取值范围：不涉及。 默认取值：不涉及。 状态码： 404 表7 响应Body参数 参数 参数类型 描述 error_code String 参数解释：错误码。 约束限制：该值不可修改。 取值范围：不涉及。 默认取值：不涉及。 error_msg String 参数解释：错误描述。 约束限制：该值不可修改。 取值范围：不涉及。 默认取值：不涉及。 solution_msg String 参数解释：解决方案描述。 约束限制：该值不可修改。 取值范围：不涉及。 默认取值：不涉及。 状态码： 408 表8 响应Body参数 参数 参数类型 描述 error_code String 参数解释：错误码。 约束限制：该值不可修改。 取值范围：不涉及。 默认取值：不涉及。 error_msg String 参数解释：错误描述。 约束限制：该值不可修改。 取值范围：不涉及。 默认取值：不涉及。 solution_msg String 参数解释：解决方案描述。 约束限制：该值不可修改。 取值范围：不涉及。 默认取值：不涉及。 状态码： 500 表9 响应Body参数 参数 参数类型 描述 error_code String 参数解释：错误码。 约束限制：该值不可修改。 取值范围：不涉及。 默认取值：不涉及。 error_msg String 参数解释：错误描述。 约束限制：该值不可修改。 取值范围：不涉及。 默认取值：不涉及。 solution_msg String 参数解释：解决方案描述。 约束限制：该值不可修改。 取值范围：不涉及。 默认取值：不涉及。

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 否 String 参数解释：租户Token。获取方法，请参见认证鉴权。 约束限制：不涉及。 取值范围：不涉及。 默认取值：不涉及。 表3 请求Body参数 参数 是否必选 参数类型 描述 tags 否 Array of ResourceTag objects 标签列表。 sys_tags 否 Array of SystemTag objects 系统标签列表。 表4 ResourceTag 参数 是否必选 参数类型 描述 key 是 String 参数解释：键。 约束限制：不涉及。 取值范围：不涉及。 默认取值：不涉及。 value 否 String 参数解释：值。 约束限制：不涉及。 取值范围：不涉及。 默认取值：不涉及。 表5 SystemTag 参数 是否必选 参数类型 描述 key 是 String 参数解释：键。 约束限制：固定值。 取值范围：不涉及。 默认取值：不涉及。 value 是 String 参数解释：企业项目ID。获取方法，请参见获取企业项目ID。 约束限制：不涉及。 取值范围：不涉及。 默认取值：不涉及。

响应参数 状态码： 204 表6 响应Body参数 参数 参数类型 描述 - AnyType OK 状态码： 400 表7 响应Body参数 参数 参数类型 描述 error_code String 参数解释：错误码。 约束限制：该值不可修改。 取值范围：不涉及。 默认取值：不涉及。 error_msg String 参数解释：错误描述。 约束限制：该值不可修改。 取值范围：不涉及。 默认取值：不涉及。 solution_msg String 参数解释：解决方案描述。 约束限制：该值不可修改。 取值范围：不涉及。 默认取值：不涉及。 状态码： 401 表8 响应Body参数 参数 参数类型 描述 error_code String 参数解释：错误码。 约束限制：该值不可修改。 取值范围：不涉及。 默认取值：不涉及。 error_msg String 参数解释：错误描述。 约束限制：该值不可修改。 取值范围：不涉及。 默认取值：不涉及。 solution_msg String 参数解释：解决方案描述。 约束限制：该值不可修改。 取值范围：不涉及。 默认取值：不涉及。 状态码： 404 表9 响应Body参数 参数 参数类型 描述 error_code String 参数解释：错误码。 约束限制：该值不可修改。 取值范围：不涉及。 默认取值：不涉及。 error_msg String 参数解释：错误描述。 约束限制：该值不可修改。 取值范围：不涉及。 默认取值：不涉及。 solution_msg String 参数解释：解决方案描述。 约束限制：该值不可修改。 取值范围：不涉及。 默认取值：不涉及。 状态码： 408 表10 响应Body参数 参数 参数类型 描述 error_code String 参数解释：错误码。 约束限制：该值不可修改。 取值范围：不涉及。 默认取值：不涉及。 error_msg String 参数解释：错误描述。 约束限制：该值不可修改。 取值范围：不涉及。 默认取值：不涉及。 solution_msg String 参数解释：解决方案描述。 约束限制：该值不可修改。 取值范围：不涉及。 默认取值：不涉及。 状态码： 500 表11 响应Body参数 参数 参数类型 描述 error_code String 参数解释：错误码。 约束限制：该值不可修改。 取值范围：不涉及。 默认取值：不涉及。 error_msg String 参数解释：错误描述。 约束限制：该值不可修改。 取值范围：不涉及。 默认取值：不涉及。 solution_msg String 参数解释：解决方案描述。 约束限制：该值不可修改。 取值范围：不涉及。 默认取值：不涉及。

URI POST https://localhost.com/v1/{project_id}/fabric-workspace/{workspace_id}/tags/create 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 参数解释：项目ID。获取方法，请参见获取项目ID。 约束限制：不涉及。 取值范围：不涉及。 默认取值：不涉及。 workspace_id 是 String 参数解释：工作空间ID。获取方法，请参见获取工作空间ID。 约束限制：不涉及。 取值范围：不涉及。 默认取值：不涉及。

URI GET https://localhost.com/v1/specs 表1 Query参数 参数 是否必选 参数类型 描述 spec_code 否 String 规格编码。 spec_types 否 Array of strings 通过资源规格类型检索。 offset 否 Integer 参数解释：偏移量，表示从此偏移量开始查询。 约束限制：不涉及。 取值范围：offset大于等于0。 默认取值：默认为0。 limit 否 Integer 参数解释：指定每一页返回的最大条目数。 约束限制：不涉及。 取值范围：取值范围[1,100]。 默认取值：默认为10。 scenario 否 Object 参数解释：规格使用场景。 约束限制：不涉及。 取值范围： 不填：表示不限制； COMPUTE: 用于购买Ray计算资源时配置的物理节点规格； ENDPOINT: 用于创建Endpoint时配置的资源组规格大小。 默认取值：不涉及。

响应参数 状态码： 200 表2 响应Body参数 参数 参数类型 描述 total Integer 总数。 spec_codes Array of Spec objects 规格编码列表。 表3 Spec 参数 参数类型 描述 spec_code String 参数解释：资源规格。 约束限制：不涉及。 取值范围：从规格列表查询获取。 默认取值：不涉及。 spec_type String 参数解释：资源规格类型。 约束限制：不涉及。 取值范围： APU：APU类型； DPU：DPU类型； MU：MU类型； RESOURCE_USAGE_UNIT：资源使用量类型； RAY_APU：Ray APU类型； RAY_DPU：Ray DPU类型。 RAY_CACHE：Ray缓存资源。 默认取值：不涉及。 resource_type String 参数解释：资源类型。 约束限制：不涉及。 取值范围：不涉及。 默认取值：不涉及。 stride Integer 参数解释：步长。 约束限制：不涉及。 取值范围：不涉及。 默认取值：不涉及。 unit String 参数解释：单位。 约束限制：不涉及。 取值范围：不涉及。 默认取值：不涉及。 min_stride_num Integer 资源步数，最小为10000，步长为1。输入范围还需要满足规格列表接口的步长白名单。 max_stride_num Integer 资源步数，最小为10000，步长为1。输入范围还需要满足规格列表接口的步长白名单。 usage_measure_id Integer 使用量单位标识。 usage_factor String 参数解释：使用量因子。 约束限制：不涉及。 取值范围：不涉及。 默认取值：不涉及。 stride_num_whitelist Array of integers 步数白名单，返回时，步数必须是白名单中的值。 extra_info SpecExtraInfo object 附加信息。 表4 SpecExtraInfo 参数 参数类型 描述 mu_multiple Double 参数解释：模型单元换算倍数 约束限制：不涉及。 取值范围：不涉及。 默认取值：不涉及。 mu_code String 参数解释：模型单元编码。 约束限制：不涉及。 取值范围：不涉及。 默认取值：不涉及。 状态码： 400 表5 响应Body参数 参数 参数类型 描述 error_code String 参数解释：错误码。 约束限制：该值不可修改。 取值范围：不涉及。 默认取值：不涉及。 error_msg String 参数解释：错误描述。 约束限制：该值不可修改。 取值范围：不涉及。 默认取值：不涉及。 solution_msg String 参数解释：解决方案描述。 约束限制：该值不可修改。 取值范围：不涉及。 默认取值：不涉及。 状态码： 401 表6 响应Body参数 参数 参数类型 描述 error_code String 参数解释：错误码。 约束限制：该值不可修改。 取值范围：不涉及。 默认取值：不涉及。 error_msg String 参数解释：错误描述。 约束限制：该值不可修改。 取值范围：不涉及。 默认取值：不涉及。 solution_msg String 参数解释：解决方案描述。 约束限制：该值不可修改。 取值范围：不涉及。 默认取值：不涉及。 状态码： 404 表7 响应Body参数 参数 参数类型 描述 error_code String 参数解释：错误码。 约束限制：该值不可修改。 取值范围：不涉及。 默认取值：不涉及。 error_msg String 参数解释：错误描述。 约束限制：该值不可修改。 取值范围：不涉及。 默认取值：不涉及。 solution_msg String 参数解释：解决方案描述。 约束限制：该值不可修改。 取值范围：不涉及。 默认取值：不涉及。 状态码： 408 表8 响应Body参数 参数 参数类型 描述 error_code String 参数解释：错误码。 约束限制：该值不可修改。 取值范围：不涉及。 默认取值：不涉及。 error_msg String 参数解释：错误描述。 约束限制：该值不可修改。 取值范围：不涉及。 默认取值：不涉及。 solution_msg String 参数解释：解决方案描述。 约束限制：该值不可修改。 取值范围：不涉及。 默认取值：不涉及。 状态码： 500 表9 响应Body参数 参数 参数类型 描述 error_code String 参数解释：错误码。 约束限制：该值不可修改。 取值范围：不涉及。 默认取值：不涉及。 error_msg String 参数解释：错误描述。 约束限制：该值不可修改。 取值范围：不涉及。 默认取值：不涉及。 solution_msg String 参数解释：解决方案描述。 约束限制：该值不可修改。 取值范围：不涉及。 默认取值：不涉及。

响应参数 状态码： 200 表4 响应Body参数 参数 参数类型 描述 - AnyType OK 状态码： 400 表5 响应Body参数 参数 参数类型 描述 error_code String 参数解释：错误码。 约束限制：该值不可修改。 取值范围：不涉及。 默认取值：不涉及。 error_msg String 参数解释：错误描述。 约束限制：该值不可修改。 取值范围：不涉及。 默认取值：不涉及。 solution_msg String 参数解释：解决方案描述。 约束限制：该值不可修改。 取值范围：不涉及。 默认取值：不涉及。 状态码： 401 表6 响应Body参数 参数 参数类型 描述 error_code String 参数解释：错误码。 约束限制：该值不可修改。 取值范围：不涉及。 默认取值：不涉及。 error_msg String 参数解释：错误描述。 约束限制：该值不可修改。 取值范围：不涉及。 默认取值：不涉及。 solution_msg String 参数解释：解决方案描述。 约束限制：该值不可修改。 取值范围：不涉及。 默认取值：不涉及。 状态码： 408 表7 响应Body参数 参数 参数类型 描述 error_code String 参数解释：错误码。 约束限制：该值不可修改。 取值范围：不涉及。 默认取值：不涉及。 error_msg String 参数解释：错误描述。 约束限制：该值不可修改。 取值范围：不涉及。 默认取值：不涉及。 solution_msg String 参数解释：解决方案描述。 约束限制：该值不可修改。 取值范围：不涉及。 默认取值：不涉及。 状态码： 500 表8 响应Body参数 参数 参数类型 描述 error_code String 参数解释：错误码。 约束限制：该值不可修改。 取值范围：不涉及。 默认取值：不涉及。 error_msg String 参数解释：错误描述。 约束限制：该值不可修改。 取值范围：不涉及。 默认取值：不涉及。 solution_msg String 参数解释：解决方案描述。 约束限制：该值不可修改。 取值范围：不涉及。 默认取值：不涉及。