华为云用户手册

  • 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。 约束限制:不涉及。 取值范围:不涉及。 默认取值:不涉及。
  • 响应参数 状态码: 200 表7 响应Header参数 参数 参数类型 描述 X-request-id String 参数解释:请求ID,定位辅助信息。 约束限制:不可修改。 取值范围:不涉及。 默认取值:不涉及。 表8 响应Body参数 参数 参数类型 描述 total_count Integer 实例总数。 状态码: 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 参数解释:解决方案描述。 约束限制:该值不可修改。 取值范围:不涉及。 默认取值:不涉及。
  • 请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 否 String 参数解释:租户Token。获取方法,请参见认证鉴权。 约束限制:不涉及。 取值范围:不涉及。 默认取值:不涉及。 表3 请求Body参数 参数 是否必选 参数类型 描述 without_any_tag 否 Boolean 不包含任意一个标签,该字段为true时查询所有不带标签的资源,此时忽略 “tags”、“tags_any”、“not_tags”、“not_tags_any”字段。 tags 否 Array of ResourceTagParam objects 包含标签,最多包含50个key,每个key下面的value最多10个,每个key对应的value可以为空数组但结构体不能缺失。 matches 否 Array of TagMatch objects 搜索字段,key为要匹配的字段,如resource_name等。value为匹配的值。 sys_tags 否 Array of SystemTagParam objects 系统标签列表,目前只包含一个tag结构体。key下面只包含一个value。 表4 ResourceTagParam 参数 是否必选 参数类型 描述 key 是 String 参数解释:资源标签的键。 约束限制:不涉及。 取值范围:不涉及。 默认取值:不涉及。 values 否 Array of strings 参数解释:资源标签的值列表。 约束限制:不涉及。 取值范围:不涉及。 默认取值:不涉及。 表5 TagMatch 参数 是否必选 参数类型 描述 key 是 String 参数解释:键;第一期限定为resource_name,后续扩展。 约束限制:不涉及。 取值范围:resource_name。 默认取值:resource_name。 value 否 String 参数解释:资源标签的值。 约束限制:不涉及。 取值范围:不涉及。 默认取值:不涉及。 表6 SystemTagParam 参数 是否必选 参数类型 描述 key 是 String 参数解释:键。 约束限制:固定值。 取值范围:不涉及。 默认取值:不涉及。 values 是 Array of strings 系统标签的值列表。
  • 请求参数 表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 参数解释:解决方案描述。 约束限制:该值不可修改。 取值范围:不涉及。 默认取值:不涉及。
  • 请求参数 表1 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 否 String 参数解释:租户Token。获取方法,请参见认证鉴权。 约束限制:不涉及。 取值范围:不涉及。 默认取值:不涉及。 表2 请求Body参数 参数 是否必选 参数类型 描述 policy_types 否 Array of strings 参数解释:权限类型列表,使用Fabric的功能,可能需要授权一些权限策略,可以在policy_types中加入策略类型来授权权限。 约束限制:不涉及。 取值范围: FABRIC_COMMON_POLICY:基础通用服务权限策略,是委托必需的权限策略; FABRIC_SELF_POLICY:访问自身服务所需要的权限策略; FABRIC_ SMN _POLICY: 消息通知 功能相关权限策略,用来将系统通知消息转发到SMN; FABRIC_LAKEFORMATION_POLICY:LakeFormation功能相关权限策略; FABRIC_ AOM _POLICY:AOM功能相关权限策略。 FABRIC_SWR_POLICY:镜像包注册功能相关权限策略。 默认取值:不涉及。
  • 响应参数 状态码: 200 表3 响应Body参数 参数 参数类型 描述 - AnyType OK 状态码: 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 参数解释:解决方案描述。 约束限制:该值不可修改。 取值范围:不涉及。 默认取值:不涉及。
  • 响应参数 状态码: 400 表26 响应Body参数 参数 参数类型 描述 error_code String 参数解释:错误码。 约束限制:该值不可修改。 取值范围:不涉及。 默认取值:不涉及。 error_msg String 参数解释:错误描述。 约束限制:该值不可修改。 取值范围:不涉及。 默认取值:不涉及。 solution_msg String 参数解释:解决方案描述。 约束限制:该值不可修改。 取值范围:不涉及。 默认取值:不涉及。 状态码: 401 表27 响应Body参数 参数 参数类型 描述 error_code String 参数解释:错误码。 约束限制:该值不可修改。 取值范围:不涉及。 默认取值:不涉及。 error_msg String 参数解释:错误描述。 约束限制:该值不可修改。 取值范围:不涉及。 默认取值:不涉及。 solution_msg String 参数解释:解决方案描述。 约束限制:该值不可修改。 取值范围:不涉及。 默认取值:不涉及。 状态码: 408 表28 响应Body参数 参数 参数类型 描述 error_code String 参数解释:错误码。 约束限制:该值不可修改。 取值范围:不涉及。 默认取值:不涉及。 error_msg String 参数解释:错误描述。 约束限制:该值不可修改。 取值范围:不涉及。 默认取值:不涉及。 solution_msg String 参数解释:解决方案描述。 约束限制:该值不可修改。 取值范围:不涉及。 默认取值:不涉及。 状态码: 500 表29 响应Body参数 参数 参数类型 描述 error_code String 参数解释:错误码。 约束限制:该值不可修改。 取值范围:不涉及。 默认取值:不涉及。 error_msg String 参数解释:错误描述。 约束限制:该值不可修改。 取值范围:不涉及。 默认取值:不涉及。 solution_msg String 参数解释:解决方案描述。 约束限制:该值不可修改。 取值范围:不涉及。 默认取值:不涉及。
  • 请求参数 表1 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 否 String 参数解释:租户Token。获取方法,请参见认证鉴权。 约束限制:不涉及。 取值范围:不涉及。 默认取值:不涉及。 表2 请求Body参数 参数 是否必选 参数类型 描述 agreements 否 Array of TenantAgreement objects 租户协议列表。 表3 TenantAgreement 参数 是否必选 参数类型 描述 agreement_name 否 String 参数解释:协议名称。 约束限制:只能包含字母、数字、下划线和中划线,且长度为1-64个字符。 取值范围:不涉及。 默认取值:不涉及。 agreement_version 否 String 参数解释:协议版本号。 约束限制:只能包含字母和数字,且长度为1-32个字符。 取值范围:不涉及。 默认取值:不涉及。
  • 响应参数 状态码: 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 参数解释:解决方案描述。 约束限制:该值不可修改。 取值范围:不涉及。 默认取值:不涉及。 状态码: 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 参数解释:解决方案描述。 约束限制:该值不可修改。 取值范围:不涉及。 默认取值:不涉及。
  • URI DELETE https://localhost.com/v1/workspaces/{workspace_id}/models/{model_id} 表1 路径参数 参数 是否必选 参数类型 描述 workspace_id 是 String 参数解释:工作空间ID。获取方法,请参见获取工作空间ID。 约束限制:不涉及。 取值范围:不涉及。 默认取值:不涉及。 model_id 是 String 推理模型ID。获取方法,请参见获取模型ID。
  • 响应参数 状态码: 200 表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 表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 通知类型。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 参数解释:解决方案描述。 约束限制:该值不可修改。 取值范围:不涉及。 默认取值:不涉及。
  • 请求参数 表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 参数解释:消息通知主题。 约束限制:不涉及。 取值范围:不涉及。 默认取值:不涉及。
  • URI DELETE https://localhost.com/v1/agency 表1 Query参数 参数 是否必选 参数类型 描述 policy_type 否 String 参数解释:权限策略类型。 约束限制:支持模糊匹配。 取值范围: FABRIC_COMMON_POLICY:基础通用服务相关的权限策略; FABRIC_SMN_POLICY:消息通知功能相关的权限策略; FABRIC_LAKEFORMATION_POLICY:LakeFormation功能相关的权限策略; FABRIC_AOM_POLICY:AOM功能相关的权限策略; FABRIC_SELF_POLICY:访问自身服务所需要的权限策略。 FABRIC_SWR_POLICY:镜像包注册功能所需要的权限策略。 默认取值:不涉及。
  • 响应参数 状态码: 200 表3 响应Body参数 参数 参数类型 描述 - AnyType OK 状态码: 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 参数解释:解决方案描述。 约束限制:该值不可修改。 取值范围:不涉及。 默认取值:不涉及。
  • URI GET https://localhost.com/v1/base-models 表1 Query参数 参数 是否必选 参数类型 描述 offset 否 Integer 参数解释:偏移量,表示从此偏移量开始查询。 约束限制:不涉及。 取值范围:offset大于等于0。 默认取值:默认为0。 limit 否 Integer 参数解释:指定每一页返回的最大条目数。 约束限制:不涉及。 取值范围:取值范围[1,100]。 默认取值:默认为10。
  • 响应参数 状态码: 200 表3 响应Body参数 参数 参数类型 描述 total Integer 符合条件的总数。 models Array of BaseModel objects 列表信息。 表4 BaseModel 参数 参数类型 描述 base_model_type String 参数解释:基模型类型。 约束限制:不涉及。 取值范围:请从ListBaseModels列举基模型接口响应中获取。 默认取值:不涉及。 max_tokens Integer 支持的最大Token数。 num_of_mu Integer 消耗MU数量。 状态码: 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参数 参数 是否必选 参数类型 描述 messages 否 Array of ChatMessage objects 消息 max_tokens 否 Integer 要在聊天完成中生成的最大token数。 输入token和生成token的总长度受模型的上下文长度限制。 temperature 否 Double Temperature是用于调整随机程度的数字。介于0和2之间。较高的值(如0.8)将使输出更随机,而较低的值(如0.2)将使输出更集中和确定性。 top_p 否 Double 核心采样,用于控制AI模型根据累积概率考虑的标记范围。 stream 否 Boolean 是否支持流式返回。如果支持,则消息按行返回(交互式效果)。如果不支持,则消息一次性全部返回。 frequency_penalty 否 Double 参数解释:频率惩罚,控制文本中词汇的重复度,避免生成文本中某些词汇或短语出现过于频繁。正值会根据它们在文本中的现有频率惩罚新令牌,从而降低模型逐字重复同一行的可能性。 约束限制:不涉及 取值范围:[-2.0,2.0]。 默认取值:不涉及。 presence_penalty 否 Double 参数解释:存在惩罚,控制文本中话题的重复度,避免在对话或文本中反复讨论相同的主题或观点。正值会根据到目前为止它们是否出现在文本中来惩罚新令牌,从而增加模型谈论新主题的可能性。 约束限制:不涉及 取值范围:[-2.0,2.0]。 默认取值:不涉及。 n 否 Integer 要为每个输入消息生成多少个聊天完成选项。请注意,您将根据所有选项中生成的token数收取费用。将n保持为1,以最小化成本。 表4 ChatMessage 参数 是否必选 参数类型 描述 role 是 String 角色 content 是 String 消息的内容
  • URI POST https://localhost.com/v1/workspaces/{workspace_id}/services/instances/{instance_id}/invocations 表1 路径参数 参数 是否必选 参数类型 描述 workspace_id 是 String 参数解释:Workspace的ID。 约束限制:不涉及。 取值范围:不涉及。 默认取值:不涉及。 instance_id 是 String 实例的Id。获取方法,请参见获取推理实例ID。
  • 响应参数 状态码: 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 解决方案描述
  • URI GET https://localhost.com/v1/{project_id}/fabric-workspace/{workspace_id}/tags 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 参数解释:项目ID。获取方法,请参见获取项目ID。 约束限制:不涉及。 取值范围:不涉及。 默认取值:不涉及。 workspace_id 是 String 参数解释:工作空间ID。 约束限制:不涉及。 取值范围:获取方法,请参见获取工作空间ID。 默认取值:不涉及。 表2 Query参数 参数 是否必选 参数类型 描述 offset 否 Integer 参数解释:偏移量,表示从此偏移量开始查询。 约束限制:不涉及。 取值范围:offset大于等于0。 默认取值:默认为0。 limit 否 Integer 查询记录数默认为1000,limit最多为1000,不能为负数,最小值为1。
  • 响应参数 状态码: 200 表4 响应Header参数 参数 参数类型 描述 X-request-id String 参数解释:请求ID。 约束限制:不可修改。 取值范围:不涉及。 默认取值:不涉及。 表5 响应Body参数 参数 参数类型 描述 tags Array of ResourceTag objects 资源标签列表。 sys_tags Array of SystemTag objects 系统标签列表。 表6 ResourceTag 参数 参数类型 描述 key String 参数解释:键。 约束限制:不涉及。 取值范围:不涉及。 默认取值:不涉及。 value String 参数解释:值。 约束限制:不涉及。 取值范围:不涉及。 默认取值:不涉及。 表7 SystemTag 参数 参数类型 描述 key String 参数解释:键。 约束限制:固定值。 取值范围:不涉及。 默认取值:不涉及。 value String 参数解释:企业项目ID。获取方法,请参见获取企业项目ID。 约束限制:不涉及。 取值范围:不涉及。 默认取值:不涉及。 状态码: 400 表8 响应Body参数 参数 参数类型 描述 error_code String 参数解释:错误码。 约束限制:该值不可修改。 取值范围:不涉及。 默认取值:不涉及。 error_msg String 参数解释:错误描述。 约束限制:该值不可修改。 取值范围:不涉及。 默认取值:不涉及。 solution_msg String 参数解释:解决方案描述。 约束限制:该值不可修改。 取值范围:不涉及。 默认取值:不涉及。 状态码: 401 表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 参数解释:解决方案描述。 约束限制:该值不可修改。 取值范围:不涉及。 默认取值:不涉及。
  • 响应参数 状态码: 200 表3 响应Body参数 参数 参数类型 描述 configs Array of Feature objects 配置列表。 total Integer 配置项总数。 表4 Feature 参数 参数类型 描述 key String 参数解释:配置项key。 约束限制:不涉及。 取值范围:不涉及。 默认取值:不涉及。 value String 参数解释:配置项value。 约束限制:不涉及。 取值范围:不涉及。 默认取值:不涉及。 状态码: 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 参数解释:解决方案描述。 约束限制:该值不可修改。 取值范围:不涉及。 默认取值:不涉及。
  • URI GET https://localhost.com/v1/features 表1 Query参数 参数 是否必选 参数类型 描述 offset 否 Integer 参数解释:偏移量,表示从此偏移量开始查询。 约束限制:不涉及。 取值范围:offset大于等于0。 默认取值:默认为0。 limit 否 Integer 参数解释:指定每一页返回的最大条目数。 约束限制:不涉及。 取值范围:取值范围[1,100]。 默认取值:默认为10。
  • 响应参数 状态码: 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 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 解决方案描述
  • 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 符合条件的消息通知策略总数。 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 通知类型。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 参数解释:解决方案描述。 约束限制:该值不可修改。 取值范围:不涉及。 默认取值:不涉及。
共99354条